1
0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-13 14:00:25 +00:00
mycorrhiza/history/operations.go

162 lines
4.0 KiB
Go

package history
// history/operations.go
// Things related to writing history.
import (
"fmt"
"os"
"path/filepath"
"sync"
"github.com/bouncepaw/mycorrhiza/user"
"github.com/bouncepaw/mycorrhiza/util"
)
// gitMutex is used for blocking git operations to avoid clashes.
var gitMutex = sync.Mutex{}
// OpType is the type a history operation has. Callers shall set appropriate optypes when creating history operations.
type OpType int
const (
// TypeNone represents an empty operation. Not to be used in practice.
TypeNone OpType = iota
// TypeEditText represents an edit of hypha text part.
TypeEditText
// TypeEditBinary represents an addition or replacement of hypha media.
TypeEditBinary
// TypeDeleteHypha represents a hypha deletion
TypeDeleteHypha
// TypeRenameHypha represents a hypha renaming
TypeRenameHypha
// TypeRemoveMedia represents media removal
TypeRemoveMedia
// TypeMarkupMigration represents a wikimind-powered automatic markup migration procedure
TypeMarkupMigration
)
// Op is an object representing a history operation.
type Op struct {
// All errors are appended here.
Errs []error
Type OpType
userMsg string
name string
email string
}
// Operation is a constructor of a history operation.
func Operation(opType OpType) *Op {
gitMutex.Lock()
hop := &Op{
Errs: []error{},
name: "anon",
email: "anon@mycorrhiza",
Type: opType,
}
return hop
}
// git operation maker helper
func (hop *Op) gitop(args ...string) *Op {
out, err := gitsh(args...)
if err != nil {
fmt.Println("out:", out.String())
hop.Errs = append(hop.Errs, err)
}
return hop
}
// withErr appends the `err` to the list of errors.
func (hop *Op) withErr(err error) *Op {
hop.Errs = append(hop.Errs, err)
return hop
}
// WithErrAbort appends the `err` to the list of errors and immediately aborts the operation.
func (hop *Op) WithErrAbort(err error) *Op {
return hop.withErr(err).Abort()
}
// WithFilesRemoved git-rm-s all passed `paths`. Paths can be rooted or not. Paths that are empty strings are ignored.
func (hop *Op) WithFilesRemoved(paths ...string) *Op {
args := []string{"rm", "--quiet", "--"}
for _, path := range paths {
if path != "" {
args = append(args, path)
}
}
return hop.gitop(args...)
}
// WithFilesRenamed git-mv-s all passed keys of `pairs` to values of `pairs`. Paths can be rooted ot not. Empty keys are ignored.
func (hop *Op) WithFilesRenamed(pairs map[string]string) *Op {
for from, to := range pairs {
if from != "" {
if err := os.MkdirAll(filepath.Dir(to), 0777); err != nil {
hop.Errs = append(hop.Errs, err)
continue
}
hop.gitop("mv", "--force", from, to)
}
}
return hop
}
// WithFiles stages all passed `paths`. Paths can be rooted or not.
func (hop *Op) WithFiles(paths ...string) *Op {
for i, path := range paths {
paths[i] = util.ShorterPath(path)
}
// 1 git operation is more effective than n operations.
return hop.gitop(append([]string{"add"}, paths...)...)
}
// Apply applies history operation by doing the commit. You do not need to call Abort afterwards.
func (hop *Op) Apply() *Op {
hop.gitop(
"commit",
"--author='"+hop.name+" <"+hop.email+">'",
"--message="+hop.userMsg,
"--no-gpg-sign",
)
gitMutex.Unlock()
return hop
}
// Abort aborts the history operation.
func (hop *Op) Abort() *Op {
gitMutex.Unlock()
return hop
}
// WithMsg sets what message will be used for the future commit. If user message exceeds one line, it is stripped down.
func (hop *Op) WithMsg(userMsg string) *Op {
for _, ch := range userMsg {
if ch == '\r' || ch == '\n' {
break
}
hop.userMsg += string(ch)
}
return hop
}
// WithUser sets a user for the commit.
func (hop *Op) WithUser(u *user.User) *Op {
if u.Group != "anon" {
hop.name = u.Name
hop.email = u.Name + "@mycorrhiza"
}
return hop
}
// HasErrors checks whether operation has errors appended.
func (hop *Op) HasErrors() bool {
return len(hop.Errs) > 0
}
// FirstErrorText extracts first error appended to the operation.
func (hop *Op) FirstErrorText() string {
return hop.Errs[0].Error()
}