^?!:#@><*|\"\\'&%"), "Invalid name"
+ return "Invalid name", errors.New("Invalid new name. Names cannot contain characters ^?!:#@><*|\"\\'&%")
}
- return nil, ""
+ return "", nil
}
// RenameHypha renames hypha from old name `hyphaName` to `newName` and makes a history record about that. If `recursive` is `true`, its subhyphae will be renamed the same way.
-func RenameHypha(h *hyphae.Hypha, newHypha *hyphae.Hypha, recursive bool, u *user.User) (hop *history.HistoryOp, errtitle string) {
+func RenameHypha(h *hyphae.Hypha, newHypha *hyphae.Hypha, recursive bool, u *user.User) (hop *history.Op, errtitle string) {
newHypha.Lock()
defer newHypha.Unlock()
hop = history.Operation(history.TypeRenameHypha)
- if err, errtitle := CanRename(u, h); errtitle != "" {
+ if errtitle, err := CanRename(u, h); errtitle != "" {
hop.WithErrAbort(err)
return hop, errtitle
}
- if err, errtitle := canRenameThisToThat(h, newHypha, u); errtitle != "" {
+ if errtitle, err := canRenameThisToThat(h, newHypha, u); errtitle != "" {
hop.WithErrAbort(err)
return hop, errtitle
}
diff --git a/shroom/unattach.go b/shroom/unattach.go
index 60f31e6..4514e9b 100644
--- a/shroom/unattach.go
+++ b/shroom/unattach.go
@@ -1,7 +1,6 @@
package shroom
import (
- "errors"
"fmt"
"github.com/bouncepaw/mycorrhiza/history"
@@ -10,10 +9,10 @@ import (
)
// UnattachHypha unattaches hypha and makes a history record about that.
-func UnattachHypha(u *user.User, h *hyphae.Hypha) (hop *history.HistoryOp, errtitle string) {
+func UnattachHypha(u *user.User, h *hyphae.Hypha) (hop *history.Op, errtitle string) {
hop = history.Operation(history.TypeUnattachHypha)
- if err, errtitle := CanUnattach(u, h); errtitle != "" {
+ if errtitle, err := CanUnattach(u, h); errtitle != "" {
hop.WithErrAbort(err)
return hop, errtitle
}
@@ -27,7 +26,7 @@ func UnattachHypha(u *user.User, h *hyphae.Hypha) (hop *history.HistoryOp, errti
if len(hop.Errs) > 0 {
rejectUnattachLog(h, u, "fail")
// FIXME: something may be wrong here
- return hop.WithErrAbort(errors.New(fmt.Sprintf("Could not unattach this hypha due to internal server errors: %v", hop.Errs))), "Error"
+ return hop.WithErrAbort(fmt.Errorf("Could not unattach this hypha due to internal server errors: %v", hop.Errs)), "Error"
}
if h.BinaryPath != "" {
diff --git a/shroom/upload.go b/shroom/upload.go
index ecdff81..ed8b4f5 100644
--- a/shroom/upload.go
+++ b/shroom/upload.go
@@ -18,7 +18,8 @@ import (
"github.com/bouncepaw/mycorrhiza/user"
)
-func UploadText(h *hyphae.Hypha, data []byte, message string, u *user.User) (hop *history.HistoryOp, errtitle string) {
+// UploadText edits a hypha' text part and makes a history record about that.
+func UploadText(h *hyphae.Hypha, data []byte, message string, u *user.User) (hop *history.Op, errtitle string) {
hop = history.Operation(history.TypeEditText)
var action string
if h.Exists {
@@ -33,7 +34,7 @@ func UploadText(h *hyphae.Hypha, data []byte, message string, u *user.User) (hop
hop.WithMsg(fmt.Sprintf("%s ā%sā: %s", action, h.Name, message))
}
- if err, errtitle := CanEdit(u, h); err != nil {
+ if errtitle, err := CanEdit(u, h); err != nil {
return hop.WithErrAbort(err), errtitle
}
if len(bytes.TrimSpace(data)) == 0 && h.BinaryPath == "" {
@@ -43,7 +44,8 @@ func UploadText(h *hyphae.Hypha, data []byte, message string, u *user.User) (hop
return uploadHelp(h, hop, ".myco", data, u)
}
-func UploadBinary(h *hyphae.Hypha, mime string, file multipart.File, u *user.User) (*history.HistoryOp, string) {
+// UploadBinary edits a hypha' attachment and makes a history record about that.
+func UploadBinary(h *hyphae.Hypha, mime string, file multipart.File, u *user.User) (*history.Op, string) {
var (
hop = history.Operation(history.TypeEditBinary).WithMsg(fmt.Sprintf("Upload attachment for ā%sā with type ā%sā", h.Name, mime))
data, err = io.ReadAll(file)
@@ -52,7 +54,7 @@ func UploadBinary(h *hyphae.Hypha, mime string, file multipart.File, u *user.Use
if err != nil {
return hop.WithErrAbort(err), err.Error()
}
- if err, errtitle := CanAttach(u, h); err != nil {
+ if errtitle, err := CanAttach(u, h); err != nil {
return hop.WithErrAbort(err), errtitle
}
if len(data) == 0 {
@@ -63,7 +65,7 @@ func UploadBinary(h *hyphae.Hypha, mime string, file multipart.File, u *user.Use
}
// uploadHelp is a helper function for UploadText and UploadBinary
-func uploadHelp(h *hyphae.Hypha, hop *history.HistoryOp, ext string, data []byte, u *user.User) (*history.HistoryOp, string) {
+func uploadHelp(h *hyphae.Hypha, hop *history.Op, ext string, data []byte, u *user.User) (*history.Op, string) {
var (
fullPath = filepath.Join(files.HyphaeDir(), h.Name+ext)
originalFullPath = &h.TextPath
diff --git a/shroom/view.go b/shroom/view.go
index 486c479..1bd22db 100644
--- a/shroom/view.go
+++ b/shroom/view.go
@@ -21,6 +21,7 @@ func FetchTextPart(h *hyphae.Hypha) (string, error) {
return string(text), nil
}
+// SetHeaderLinks initializes header links by reading the configured hypha, if there is any, or resorting to default values.
func SetHeaderLinks() {
if userLinksHypha := hyphae.ByName(cfg.HeaderLinksHypha); !userLinksHypha.Exists {
cfg.SetDefaultHeaderLinks()
diff --git a/tree/tree.go b/tree/tree.go
index f5b2ce5..244d808 100644
--- a/tree/tree.go
+++ b/tree/tree.go
@@ -137,14 +137,14 @@ func figureOutChildren(hyphaName string, subhyphaePool map[string]bool, exists b
nestLevel = strings.Count(hyphaName, "/")
adopted = make([]child, 0)
)
- for subhyphaName, _ := range subhyphaePool {
+ for subhyphaName := range subhyphaePool {
subnestLevel := strings.Count(subhyphaName, "/")
if subnestLevel-1 == nestLevel && path.Dir(subhyphaName) == hyphaName {
delete(subhyphaePool, subhyphaName)
adopted = append(adopted, figureOutChildren(subhyphaName, subhyphaePool, true))
}
}
- for descName, _ := range subhyphaePool {
+ for descName := range subhyphaePool {
if strings.HasPrefix(descName, hyphaName) {
var (
rawSubPath = strings.TrimPrefix(descName, hyphaName)[1:]
diff --git a/user/files.go b/user/files.go
index 8b97bb0..2f98207 100644
--- a/user/files.go
+++ b/user/files.go
@@ -76,6 +76,7 @@ func readTokensToUsers() {
log.Println("Found", len(tmp), "active sessions")
}
+// SaveUserDatabase stores current user credentials into JSON file by configured path.
func SaveUserDatabase() error {
return dumpUserCredentials()
}
diff --git a/user/net.go b/user/net.go
index 48b70f1..b439cb9 100644
--- a/user/net.go
+++ b/user/net.go
@@ -27,7 +27,7 @@ func FromRequest(rq *http.Request) *User {
if err != nil {
return EmptyUser()
}
- return UserByToken(cookie.Value)
+ return ByToken(cookie.Value)
}
// LogoutFromRequest logs the user in `rq` out and rewrites the cookie in `w`.
@@ -108,9 +108,9 @@ func AddSession(username string) (string, error) {
}
// A handy cookie constructor
-func cookie(name_suffix, val string, t time.Time) *http.Cookie {
+func cookie(nameSuffix, val string, t time.Time) *http.Cookie {
return &http.Cookie{
- Name: "mycorrhiza_" + name_suffix,
+ Name: "mycorrhiza_" + nameSuffix,
Value: val,
Expires: t,
Path: "/",
diff --git a/user/user.go b/user/user.go
index 966916e..e0522bd 100644
--- a/user/user.go
+++ b/user/user.go
@@ -9,7 +9,7 @@ import (
"golang.org/x/crypto/bcrypt"
)
-// User is a user.
+// User is a user (duh).
type User struct {
// Name is a username. It must follow hypha naming rules.
Name string `json:"name"`
@@ -59,6 +59,7 @@ var groupRight = map[string]int{
"admin": 4,
}
+// ValidGroup checks whether provided user group name exists.
func ValidGroup(group string) bool {
for _, grp := range groups {
if grp == group {
@@ -68,10 +69,12 @@ func ValidGroup(group string) bool {
return false
}
+// ValidSource checks whether provided user source name exists.
func ValidSource(source string) bool {
return source == "local" || source == "telegram"
}
+// EmptyUser constructs an anonymous user.
func EmptyUser() *User {
return &User{
Name: "anon",
@@ -81,6 +84,7 @@ func EmptyUser() *User {
}
}
+// CanProceed checks whether user has rights to visit the provided path (and perform an action).
func (user *User) CanProceed(route string) bool {
if !cfg.UseAuth {
return true
diff --git a/user/users.go b/user/users.go
index 6daa301..07fe2a9 100644
--- a/user/users.go
+++ b/user/users.go
@@ -5,6 +5,7 @@ import "sync"
var users sync.Map
var tokens sync.Map
+// YieldUsers creates a channel which iterates existing users.
func YieldUsers() chan *User {
ch := make(chan *User)
go func(ch chan *User) {
@@ -17,6 +18,7 @@ func YieldUsers() chan *User {
return ch
}
+// ListUsersWithGroup returns a slice with users of desired group.
func ListUsersWithGroup(group string) []string {
filtered := []string{}
for u := range YieldUsers() {
@@ -27,6 +29,7 @@ func ListUsersWithGroup(group string) []string {
return filtered
}
+// Count returns total users count
func Count() (i uint64) {
users.Range(func(k, v interface{}) bool {
i++
@@ -35,24 +38,29 @@ func Count() (i uint64) {
return i
}
+// HasUsername checks whether the desired user exists
func HasUsername(username string) bool {
_, has := users.Load(username)
return has
}
+// CredentialsOK checks whether a correct user-password pair is provided
func CredentialsOK(username, password string) bool {
- return UserByName(username).isCorrectPassword(password)
+ return ByName(username).isCorrectPassword(password)
}
-func UserByToken(token string) *User {
+// ByToken finds a user by provided session token
+func ByToken(token string) *User {
+ // TODO: Needs more session data -- chekoopa
if usernameUntyped, ok := tokens.Load(token); ok {
username := usernameUntyped.(string)
- return UserByName(username)
+ return ByName(username)
}
return EmptyUser()
}
-func UserByName(username string) *User {
+// ByName finds a user by one's username
+func ByName(username string) *User {
if userUntyped, ok := users.Load(username); ok {
user := userUntyped.(*User)
return user
@@ -60,6 +68,7 @@ func UserByName(username string) *User {
return EmptyUser()
}
+// DeleteUser removes a user by one's name and saves user database.
func DeleteUser(name string) error {
user, loaded := users.LoadAndDelete(name)
if loaded {
diff --git a/util/util.go b/util/util.go
index 8e39b12..121e2da 100644
--- a/util/util.go
+++ b/util/util.go
@@ -111,6 +111,7 @@ type FormData struct {
fields map[string]string
}
+// NewFormData constructs empty form data instance.
func NewFormData() FormData {
return FormData{
err: nil,
@@ -118,6 +119,7 @@ func NewFormData() FormData {
}
}
+// FormDataFromRequest extracts a form data from request, using a set of keys.
func FormDataFromRequest(r *http.Request, keys []string) FormData {
formData := NewFormData()
for _, key := range keys {
@@ -126,10 +128,12 @@ func FormDataFromRequest(r *http.Request, keys []string) FormData {
return formData
}
+// HasError is true if there is indeed an error.
func (f FormData) HasError() bool {
return f.err != nil
}
+// Error returns an error text or empty string, if there are no errors in form data.
func (f FormData) Error() string {
if f.err == nil {
return ""
@@ -137,15 +141,18 @@ func (f FormData) Error() string {
return f.err.Error()
}
+// WithError puts an error into form data and returns itself.
func (f FormData) WithError(err error) FormData {
f.err = err
return f
}
+// Get accesses form data with a key
func (f FormData) Get(key string) string {
return f.fields[key]
}
+// Put writes a form value for provided key
func (f FormData) Put(key, value string) {
f.fields[key] = value
}
diff --git a/web/admin.go b/web/admin.go
index 5f84dac..876bbf6 100644
--- a/web/admin.go
+++ b/web/admin.go
@@ -79,7 +79,7 @@ func handlerAdminUsers(w http.ResponseWriter, rq *http.Request) {
func handlerAdminUserEdit(w http.ResponseWriter, rq *http.Request) {
vars := mux.Vars(rq)
- u := user.UserByName(vars["username"])
+ u := user.ByName(vars["username"])
if u == nil {
util.HTTP404Page(w, "404 page not found")
return
@@ -121,7 +121,7 @@ func handlerAdminUserEdit(w http.ResponseWriter, rq *http.Request) {
func handlerAdminUserDelete(w http.ResponseWriter, rq *http.Request) {
vars := mux.Vars(rq)
- u := user.UserByName(vars["username"])
+ u := user.ByName(vars["username"])
if u == nil {
util.HTTP404Page(w, "404 page not found")
return
diff --git a/web/auth.go b/web/auth.go
index 9cbe5d2..8b15ea0 100644
--- a/web/auth.go
+++ b/web/auth.go
@@ -143,7 +143,7 @@ func handlerTelegramLogin(w http.ResponseWriter, rq *http.Request) {
false,
)
)
- if user.HasUsername(username) && user.UserByName(username).Source == "telegram" {
+ if user.HasUsername(username) && user.ByName(username).Source == "telegram" {
// Problems is something we put blankets on.
err = nil
}
diff --git a/web/history.go b/web/history.go
index d6ae80e..595d19f 100644
--- a/web/history.go
+++ b/web/history.go
@@ -36,7 +36,7 @@ func handlerHistory(w http.ResponseWriter, rq *http.Request) {
// History can be found for files that do not exist anymore.
revs, err := history.Revisions(hyphaName)
if err == nil {
- list = history.HistoryWithRevisions(hyphaName, revs)
+ list = history.WithRevisions(hyphaName, revs)
}
log.Println("Found", len(revs), "revisions for", hyphaName)
diff --git a/web/mutators.go b/web/mutators.go
index f72091e..bbfb0cb 100644
--- a/web/mutators.go
+++ b/web/mutators.go
@@ -35,7 +35,7 @@ func initMutators(r *mux.Router) {
func factoryHandlerAsker(
actionPath string,
- asker func(*user.User, *hyphae.Hypha) (error, string),
+ asker func(*user.User, *hyphae.Hypha) (string, error),
succTitleKey string,
succPageTemplate func(*http.Request, string, bool) string,
) func(http.ResponseWriter, *http.Request) {
@@ -47,7 +47,7 @@ func factoryHandlerAsker(
u = user.FromRequest(rq)
lc = l18n.FromRequest(rq)
)
- if err, errtitle := asker(u, h); err != nil {
+ if errtitle, err := asker(u, h); err != nil {
httpErr(
w,
lc,
@@ -90,7 +90,7 @@ var handlerRenameAsk = factoryHandlerAsker(
func factoryHandlerConfirmer(
actionPath string,
- confirmer func(*hyphae.Hypha, *user.User, *http.Request) (*history.HistoryOp, string),
+ confirmer func(*hyphae.Hypha, *user.User, *http.Request) (*history.Op, string),
) func(http.ResponseWriter, *http.Request) {
return func(w http.ResponseWriter, rq *http.Request) {
util.PrepareRq(rq)
@@ -112,14 +112,14 @@ func factoryHandlerConfirmer(
var handlerUnattachConfirm = factoryHandlerConfirmer(
"unattach-confirm",
- func(h *hyphae.Hypha, u *user.User, _ *http.Request) (*history.HistoryOp, string) {
+ func(h *hyphae.Hypha, u *user.User, _ *http.Request) (*history.Op, string) {
return shroom.UnattachHypha(u, h)
},
)
var handlerDeleteConfirm = factoryHandlerConfirmer(
"delete-confirm",
- func(h *hyphae.Hypha, u *user.User, _ *http.Request) (*history.HistoryOp, string) {
+ func(h *hyphae.Hypha, u *user.User, _ *http.Request) (*history.Op, string) {
return shroom.DeleteHypha(u, h)
},
)
@@ -158,7 +158,7 @@ func handlerEdit(w http.ResponseWriter, rq *http.Request) {
u = user.FromRequest(rq)
lc = l18n.FromRequest(rq)
)
- if err, errtitle := shroom.CanEdit(u, h); err != nil {
+ if errtitle, err := shroom.CanEdit(u, h); err != nil {
httpErr(w, lc, http.StatusInternalServerError, hyphaName,
errtitle,
err.Error())
@@ -196,7 +196,7 @@ func handlerUploadText(w http.ResponseWriter, rq *http.Request) {
message = rq.PostFormValue("message")
u = user.FromRequest(rq)
lc = l18n.FromRequest(rq)
- hop *history.HistoryOp
+ hop *history.Op
errtitle string
)
@@ -247,7 +247,7 @@ func handlerUploadBinary(w http.ResponseWriter, rq *http.Request) {
lc.Get("ui.error"),
err.Error())
}
- if err, errtitle := shroom.CanAttach(u, h); err != nil {
+ if errtitle, err := shroom.CanAttach(u, h); err != nil {
httpErr(w, lc, http.StatusInternalServerError, hyphaName,
errtitle,
err.Error())
diff --git a/web/readers.go b/web/readers.go
index 047fa24..68edb05 100644
--- a/web/readers.go
+++ b/web/readers.go
@@ -55,10 +55,10 @@ func handlerAttachment(w http.ResponseWriter, rq *http.Request) {
func handlerPrimitiveDiff(w http.ResponseWriter, rq *http.Request) {
util.PrepareRq(rq)
var (
- shorterUrl = strings.TrimPrefix(rq.URL.Path, "/primitive-diff/")
- firstSlashIndex = strings.IndexRune(shorterUrl, '/')
- revHash = shorterUrl[:firstSlashIndex]
- hyphaName = util.CanonicalName(shorterUrl[firstSlashIndex+1:])
+ shorterURL = strings.TrimPrefix(rq.URL.Path, "/primitive-diff/")
+ firstSlashIndex = strings.IndexRune(shorterURL, '/')
+ revHash = shorterURL[:firstSlashIndex]
+ hyphaName = util.CanonicalName(shorterURL[firstSlashIndex+1:])
h = hyphae.ByName(hyphaName)
u = user.FromRequest(rq)
lc = l18n.FromRequest(rq)
@@ -77,10 +77,10 @@ func handlerPrimitiveDiff(w http.ResponseWriter, rq *http.Request) {
func handlerRevisionText(w http.ResponseWriter, rq *http.Request) {
util.PrepareRq(rq)
var (
- shorterUrl = strings.TrimPrefix(rq.URL.Path, "/rev-text/")
- firstSlashIndex = strings.IndexRune(shorterUrl, '/')
- revHash = shorterUrl[:firstSlashIndex]
- hyphaName = util.CanonicalName(shorterUrl[firstSlashIndex+1:])
+ shorterURL = strings.TrimPrefix(rq.URL.Path, "/rev-text/")
+ firstSlashIndex = strings.IndexRune(shorterURL, '/')
+ revHash = shorterURL[:firstSlashIndex]
+ hyphaName = util.CanonicalName(shorterURL[firstSlashIndex+1:])
h = hyphae.ByName(hyphaName)
textContents, err = history.FileAtRevision(h.TextPartPath(), revHash)
)
@@ -101,10 +101,10 @@ func handlerRevision(w http.ResponseWriter, rq *http.Request) {
util.PrepareRq(rq)
var (
lc = l18n.FromRequest(rq)
- shorterUrl = strings.TrimPrefix(rq.URL.Path, "/rev/")
- firstSlashIndex = strings.IndexRune(shorterUrl, '/')
- revHash = shorterUrl[:firstSlashIndex]
- hyphaName = util.CanonicalName(shorterUrl[firstSlashIndex+1:])
+ shorterURL = strings.TrimPrefix(rq.URL.Path, "/rev/")
+ firstSlashIndex = strings.IndexRune(shorterURL, '/')
+ revHash = shorterURL[:firstSlashIndex]
+ hyphaName = util.CanonicalName(shorterURL[firstSlashIndex+1:])
h = hyphae.ByName(hyphaName)
contents = fmt.Sprintf(`%s
`, lc.Get("ui.revision_no_text")) textContents, err = history.FileAtRevision(h.TextPartPath(), revHash) diff --git a/web/web.go b/web/web.go index 5e985fe..d19a0c5 100644 --- a/web/web.go +++ b/web/web.go @@ -74,6 +74,7 @@ func handlerRobotsTxt(w http.ResponseWriter, rq *http.Request) { file.Close() } +// Handler initializes func Handler() http.Handler { router := mux.NewRouter() router.Use(func(next http.Handler) http.Handler {