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 File
• type FileVault
  • func NewFileVault(path, salt string) (FileVault, error)
  • 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) 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) MainHandler(w http.ResponseWriter, r *http.Request)
  • func (g *Gwi) Private(h http.HandlerFunc) http.HandlerFunc
• type Info
• type User
• type Vault

Types

type Config

type Config struct {
	Domain    string
	PagesRoot string
	Root      string
	CGIRoot   string
	CGIPrefix string
}

type File

type File struct {
	*object.File
	Size int64
}

type FileVault

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

func NewFileVault

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

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) 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) MainHandler

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

func (*Gwi) Private

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

type Info

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

type User

type User struct {
	Login string
	Pass  string
}

type Vault

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