gwi

README

This project delivers various functions to be used in your server, with that you can customize all pages and paths.

Usage

The simplest way of using this project is the following example:

package main

import (
	"net/http"

	"blmayer.dev/gwi"
)

func main() {
	// init user vault
	v, err := NewFileVault("users.json", "--salt--")
	// handle error
	
	// gwi config struct
	c := gwi.Config{
		Root: "path/to/git/folder",
		PagesRoot: "path/to/html-templates",
		...
	}

	g, _ := gwi.NewFromConfig(c, v)
	// handle error

	err := http.ListenAndServe(":8080", g.Handle())
	// handle err
}

This gives you the main handlers, i.e. routes like /{user}/{repo}/{ref}/{op}/{args}, args is an optional parameter.

This makes gwi interact with the repository repo that belongs to user, so it must be found under the folder config.Root/user/repo in the server.

op makes gwi look for a template named op.html in gwi.PagesRoot folder, and execute it.

Functions

This package provides functions that you can call in your templates, letting you query the data you want in an efficient way. Currently gwi exports the following functions:

• users: func() []string
• repos: func(user string) []string
• branches: func(ref plumbing.Hash) []*plumbing.Reference
• tags: func() []*plumbing.Reference
• commits: func(ref plumbing.Hash) []*object.Commit
• commit: func(ref plumbing.Hash) *object.Commit
• tree: func(ref plumbing.Hash) []File
• file: func(ref plumbing.Hash, name string) string
• markdown: func(in string) template.HTML

Their names indicate what info they return, to see examples browse the template folder.

Variables

In addition to the functions above, gwi injects the following struct as data in all templates:

type RepoInfo struct {
	User     string
	Repo     string
	Ref      plumbing.Hash
	RefName  string
	Args     string
}

All fields are automatically populated, in special, args comes from the route part.

Examples

Users

To get a list of your users is simple:

<ul>
	{{range users}}
	<li>{{.}}</li>
	{{end}}
</ul>

File tree

To get the file tree for the current reference:

<table>
    <tr>
        <th>Mode</th>
        <th>Size</th>
        <th>Name</th>
    </tr>
    {{range tree .Ref}}
    <tr>
        <td>{{.Mode}}</td>
        <td>{{.Size}}</td>
	<td>{{.Name}}</td>
    </tr>
    {{end}}
</table>

Will print a nice list of your project files.

Commits

Using the functions commits and commit you're able to see a list of commits and check details of each one:

<table>
    <tr>
        <th>Time</th>
        <th>Author</th>
        <th>Message</th>
    </tr>
    {{range commits .Ref}}
    <tr>
        <td>{{.Author.When.String}}</td>
        <td>{{.Author.Name}}</td>
	<td>{{.Message}}</td>
    </tr>
    {{end}}
</table>

To get the list, and the following show a commit's details:

{{with commit .Ref}}

<p><b>Commited at:</b> {{.Committer.When.String}}</p>
<p><b>Author:</b> {{.Committer.Name}} ({{.Committer.Email}})</p>
<p><b>Message:</b></p>
<p>{{.Message}}</p>
{{end}}

Documentation

Index

• type Config
• type Email
• type File
• type FileMailer
• type FileVault
  • func NewFileVault(path, salt string) (FileVault, error)
  • func (f FileVault) GetUser(login string) User
  • func (f FileVault) Mix(data string) string
  • func (f FileVault) Validate(login, pass string) bool
• type Gwi
  • func NewFromConfig(config Config, vault Vault) (Gwi, error)
  • func (g Gwi) AnonymousLogin(state *smtp.ConnectionState) (smtp.Session, error)
  • func (g *Gwi) CloseThread(threadPath string) error
  • func (g Gwi) Commands() map[string]func(content, thread string) bool
  • func (g *Gwi) GitCGIHandler(w http.ResponseWriter, r *http.Request)
  • func (g *Gwi) Handle() http.Handler
  • func (g *Gwi) ListHandler(w http.ResponseWriter, r *http.Request)
  • func (g Gwi) Login(state *smtp.ConnectionState, username, password string) (smtp.Session, error)
  • func (g *Gwi) Mail(file string) (Email, error)
  • func (g *Gwi) Mails(folder string) ([]Email, error)
  • func (g *Gwi) MainHandler(w http.ResponseWriter, r *http.Request)
  • func (g *Gwi) NewMailServer() FileMailer
  • func (g Gwi) NewSession(_ *smtp.Conn) (smtp.Session, error)
  • func (g *Gwi) Private(h http.HandlerFunc) http.HandlerFunc
  • func (g *Gwi) Threads(folder string) ([]Thread, error)
• type Info
• type Mailer
• type Session
  • func (s Session) AuthPlain(username, password string) error
  • func (s Session) Data(r io.Reader) error
  • func (s Session) Logout() error
  • func (s Session) Mail(from string, opts smtp.MailOptions) error
  • func (s Session) Rcpt(to string) error
  • func (s Session) Reset()
• type Thread
• type ThreadStatus
• type User
• type Vault

Types

type Config

type Config struct {
	Domain      string
	MailAddress string
	PagesRoot   string
	Root        string
	CGIRoot     string
	CGIPrefix   string
	LogLevel    logger.Level
	// contains filtered or unexported fields
}

type Email

type Email struct {
	From        string
	To          string
	Cc          string
	Date        time.Time
	Subject     string
	Body        string
	Attachments map[string][]byte
}

type File

type File struct {
	*object.File
	Size int64
}

type FileMailer

type FileMailer struct {
	Root string
	*smtp.Server
}

type FileVault

type FileVault struct {
	Users map[string]User
	// contains filtered or unexported fields
}

func NewFileVault

func NewFileVault(path, salt string) (FileVault, error)

func (FileVault) GetUser

func (f FileVault) GetUser(login string) User

func (FileVault) Mix

func (f FileVault) Mix(data string) string

func (FileVault) Validate

func (f FileVault) Validate(login, pass string) bool

type Gwi

type Gwi struct {
	// contains filtered or unexported fields
}

func NewFromConfig

func NewFromConfig(config Config, vault Vault) (Gwi, error)

func (Gwi) AnonymousLogin

func (g Gwi) AnonymousLogin(state *smtp.ConnectionState) (smtp.Session, error)

func (*Gwi) CloseThread

func (g *Gwi) CloseThread(threadPath string) error

Close moves a thread to the closed folder

func (Gwi) Commands

func (g Gwi) Commands() map[string]func(content, thread string) bool

func (*Gwi) GitCGIHandler

func (g *Gwi) GitCGIHandler(w http.ResponseWriter, r *http.Request)

func (*Gwi) Handle

func (g *Gwi) Handle() http.Handler

func (*Gwi) ListHandler

func (g *Gwi) ListHandler(w http.ResponseWriter, r *http.Request)

func (Gwi) Login

func (g Gwi) Login(state *smtp.ConnectionState, username, password string) (smtp.Session, error)

func (*Gwi) Mail

func (g *Gwi) Mail(file string) (Email, error)

func (*Gwi) Mails

func (g *Gwi) Mails(folder string) ([]Email, error)

func (*Gwi) MainHandler

func (g *Gwi) MainHandler(w http.ResponseWriter, r *http.Request)

func (*Gwi) NewMailServer

func (g *Gwi) NewMailServer() FileMailer

func (Gwi) NewSession

func (g Gwi) NewSession(_ *smtp.Conn) (smtp.Session, error)

func (*Gwi) Private

func (g *Gwi) Private(h http.HandlerFunc) http.HandlerFunc

func (*Gwi) Threads

func (g *Gwi) Threads(folder string) ([]Thread, error)

type Info

type Info struct {
	User    string
	Repo    string
	Ref     plumbing.Hash
	RefName string
	Args    string
}

type Mailer

type Mailer interface {
	Threads(folder string) ([]Thread, error)
	Mails(folder string) ([]Email, error)
	Mail(path string) (Email, error)
	Close(thread string) error
	Commands() map[string]func(content, thread string) bool
}

type Session

type Session struct {
	// contains filtered or unexported fields
}

A Session is returned after EHLO.

func (Session) AuthPlain

func (s Session) AuthPlain(username, password string) error

func (Session) Data

func (s Session) Data(r io.Reader) error

func (Session) Logout

func (s Session) Logout() error

func (Session) Mail

func (s Session) Mail(from string, opts smtp.MailOptions) error

func (Session) Rcpt

func (s Session) Rcpt(to string) error

func (Session) Reset

func (s Session) Reset()

type Thread

type Thread struct {
	Title   string
	Creator string
	LastMod time.Time
	Lenght  int
	Status  ThreadStatus
}

type ThreadStatus

type ThreadStatus string

type User

type User struct {
	Email string
	Login string
	Pass  string
}

type Vault

type Vault interface {
	GetUser(login string) any
	Validate(login, pass string) bool
}