Flatten structure

Related to #13

1 files changed, 176 insertions, 0 deletions

diff --git a/types.go b/types.go
new file mode 100644
index 0000000..28651b3
--- /dev/null
+++ b/types.go
@@ -0,0 +1,176 @@
+// Copyright Nicolas Paul (2023)
+//
+// * Nicolas Paul
+//
+// This software is a computer program whose purpose is to allow the hosting
+// and sharing of Go modules using a personal domain.
+//
+// This software is governed by the CeCILL license under French law and
+// abiding by the rules of distribution of free software.  You can  use,
+// modify and/ or redistribute the software under the terms of the CeCILL
+// license as circulated by CEA, CNRS and INRIA at the following URL
+// "http://www.cecill.info".
+//
+// As a counterpart to the access to the source code and  rights to copy,
+// modify and redistribute granted by the license, users are provided only
+// with a limited warranty  and the software's author,  the holder of the
+// economic rights,  and the successive licensors  have only  limited
+// liability.
+//
+// In this respect, the user's attention is drawn to the risks associated
+// with loading,  using,  modifying and/or developing or reproducing the
+// software by the user in light of its specific status of free software,
+// that may mean  that it is complicated to manipulate,  and  that  also
+// therefore means  that it is reserved for developers  and  experienced
+// professionals having in-depth computer knowledge. Users are therefore
+// encouraged to load and test the software's suitability as regards their
+// requirements in conditions enabling the security of their systems and/or
+// data to be ensured and,  more generally, to use and operate it in the
+// same conditions as regards security.
+//
+// The fact that you are presently reading this means that you have had
+// knowledge of the CeCILL license and that you accept its terms.
+
+// Data structure representaton of the configuration
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path"
+	"strings"
+	"sync"
+)
+
+// Index is the global registry of Go modules.
+type Index struct {
+	Domain  string
+	Modules map[string]*Module
+	// internal
+	lock sync.Mutex
+}
+
+// AddModule adds a module to the index.
+func (i *Index) AddModule(n string, m *Module) {
+	i.lock.Lock()
+	defer i.lock.Unlock()
+	i.Modules[n] = m
+}
+
+// GetModule returns a module from the index.
+func (i *Index) GetModule(n string) *Module {
+	i.lock.Lock()
+	defer i.lock.Unlock()
+	return i.Modules[n]
+}
+
+// RemoveModule removes a module from the index.
+func (i *Index) RemoveModule(n string) {
+	i.lock.Lock()
+	defer i.lock.Unlock()
+	delete(i.Modules, n)
+}
+
+// CheckModule checks if a module is in the index.
+func (i *Index) CheckModule(n string) bool {
+	i.lock.Lock()
+	defer i.lock.Unlock()
+	_, ok := i.Modules[n]
+	return ok
+}
+
+// GenerateFile generates the index file.
+func (i *Index) GenerateFile(out string) error {
+	i.lock.Lock()
+	defer i.lock.Unlock()
+
+	f := path.Join(out, "index.html")
+
+	// Create the file.
+	fd, err := os.Create(f)
+	if err != nil {
+		return err
+	}
+	defer func(fd *os.File) {
+		err := fd.Close()
+		if err != nil {
+			panic(err)
+		}
+	}(fd)
+
+	// Execute the template and write the output to the file.
+	if err := ExecIndex(fd,
+		"https://pkg.go.dev", 2); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// Vcs is an enum for version control systems supported by the standard Go
+// toolchain.
+//
+// See https://pkg.go.dev/cmd/go#hdr-Module_configuration_for_non_public_modules
+type Vcs string
+
+// Vcs enum.
+const (
+	VcsBazaar     Vcs = "bzr"
+	VcsFossil     Vcs = "fossil"
+	VcsGit        Vcs = "git"
+	VcsMercurial  Vcs = "hg"
+	VcsSubversion Vcs = "svn"
+)
+
+// Module represents a Go module to index.
+type Module struct {
+	Path string // module path (without domain)
+	Vcs  Vcs    // vcs system
+	Repo string // repository's home
+	Dir  string // url template
+	File string // url template
+
+	// internal
+	mu sync.Mutex
+}
+
+// GenerateFile generates the index file.
+func (m *Module) GenerateFile(out string, domain string) error {
+	m.mu.Lock()
+	p := m.Path
+	v := m.Vcs
+	r := m.Repo
+	d := m.Dir
+	f := m.File
+	m.mu.Unlock()
+
+	outf := path.Join(out, p+".html")
+
+	// Create the file.
+	if strings.Contains(p, "/") {
+		if err := os.MkdirAll(path.Dir(outf), 0755); err != nil {
+			return err
+		}
+	}
+
+	fd, err := os.Create(outf)
+	if err != nil {
+		return err
+	}
+	defer func(fd *os.File) {
+		err := fd.Close()
+		if err != nil {
+			panic(err)
+		}
+	}(fd)
+
+	// Execute the template and write the output to the file.
+	if err := ExecModule(fd,
+		fmt.Sprintf("%s/%s", domain, p), string(v), r,
+		d, f); err != nil {
+		return err
+	}
+
+	return nil
+}