refactored lots of code to sub-packages

Author: dstpierre

.gitignore

@@ -1,7 +1,6 @@
-.setenv.sh
 .env
 mongodata/
-staticbackend
+cmd/staticbackend
 
 # Binaries for programs and plugins
 *.exe

Makefile

@@ -2,7 +2,7 @@ include .env
 export $(shell sed 's/=.*//' .env)
 
 build:
-	@rm -rf staticbackend && go build
+	@cd cmd && rm -rf staticbackend && go build -o staticbackend
 
 start: build
 	@./staticbackend -host localhost

account.go

@@ -1,4 +1,4 @@
-package main
+package staticbackend
 
 import (
 	"context"
@@ -112,7 +112,7 @@ func (a *accounts) create(w http.ResponseWriter, r *http.Request) {
 		break
 	}
 
-	base := middleware.BaseConfig{
+	base := internal.BaseConfig{
 		ID:        primitive.NewObjectID(),
 		SBID:      acctID,
 		Name:      dbName,

cache.go renamed to cache/cache.go

@@ -1,10 +1,12 @@
-package main
+package cache
 
 import (
 	"context"
 	"encoding/json"
 	"fmt"
 	"log"
+	"os"
+	"staticbackend/internal"
 	"time"
 
 	"github.com/go-redis/redis/v8"
@@ -18,9 +20,9 @@ type Cache struct {
 // NewCache returns an initiated Redis client
 func NewCache() *Cache {
 	rdb := redis.NewClient(&redis.Options{
-		Addr:     "localhost:6379",
-		Password: "", // no password set
-		DB:       0,  // use default DB
+		Addr:     os.Getenv("REDIS_HOST"),
+		Password: os.Getenv("REDIS_PASSWORD"),
+		DB:       0, // use default DB
 	})
 
 	return &Cache{
@@ -40,7 +42,7 @@ func (c *Cache) Set(key string, value string) error {
 	return nil
 }
 
-func (c *Cache) Subscribe(send chan Command, token, channel string, close chan bool) {
+func (c *Cache) Subscribe(send chan internal.Command, token, channel string, close chan bool) {
 	pubsub := c.Rdb.Subscribe(c.Ctx, channel)
 
 	if _, err := pubsub.Receive(c.Ctx); err != nil {
@@ -53,7 +55,7 @@ func (c *Cache) Subscribe(send chan Command, token, channel string, close chan b
 	for {
 		select {
 		case m := <-ch:
-			var msg Command
+			var msg internal.Command
 			if err := json.Unmarshal([]byte(m.Payload), &msg); err != nil {
 				log.Println("error parsing JSON message", err)
 				_ = pubsub.Close()
@@ -62,8 +64,8 @@ func (c *Cache) Subscribe(send chan Command, token, channel string, close chan b
 
 			// for non DB events we change the type to MsgTypeChanOut
 			if !msg.IsDBEvent() {
-				msg.Type = MsgTypeChanOut
-			} else if c.hasPermission(token, channel, msg.Data) == false {
+				msg.Type = internal.MsgTypeChanOut
+			} else if c.HasPermission(token, channel, msg.Data) == false {
 				continue
 			}
 			send <- msg
@@ -74,7 +76,7 @@ func (c *Cache) Subscribe(send chan Command, token, channel string, close chan b
 	}
 }
 
-func (c *Cache) Publish(msg Command) error {
+func (c *Cache) Publish(msg internal.Command) error {
 	b, err := json.Marshal(msg)
 	if err != nil {
 		return err
@@ -86,7 +88,7 @@ func (c *Cache) Publish(msg Command) error {
 	return c.Rdb.Publish(ctx, msg.Channel, string(b)).Err()
 }
 
-func (c *Cache) publishDocument(channel, typ string, v interface{}) {
+func (c *Cache) PublishDocument(channel, typ string, v interface{}) {
 	subs, err := c.Rdb.PubSubNumSub(c.Ctx, channel).Result()
 	if err != nil {
 		fmt.Println("error getting db subscribers for ", channel)
@@ -107,7 +109,7 @@ func (c *Cache) publishDocument(channel, typ string, v interface{}) {
 		return
 	}
 
-	msg := Command{
+	msg := internal.Command{
 		Channel: channel,
 		Data:    string(b),
 		Type:    typ,
@@ -118,8 +120,8 @@ func (c *Cache) publishDocument(channel, typ string, v interface{}) {
 	}
 }
 
-func (c *Cache) hasPermission(token, repo, payload string) bool {
-	me, ok := tokens[token]
+func (c *Cache) HasPermission(token, repo, payload string) bool {
+	me, ok := internal.Tokens[token]
 	if !ok {
 		return false
 	}
@@ -130,16 +132,16 @@ func (c *Cache) hasPermission(token, repo, payload string) bool {
 		return false
 	}
 
-	switch readPermission(repo) {
-	case permGroup:
-		acctID, ok := docs[fieldAccountID]
+	switch internal.ReadPermission(repo) {
+	case internal.PermGroup:
+		acctID, ok := docs[internal.FieldAccountID]
 		if !ok {
 			return false
 		}
 
 		return fmt.Sprintf("%v", acctID) == me.AccountID.Hex()
-	case permOwner:
-		owner, ok := docs[fieldOwnerID]
+	case internal.PermOwner:
+		owner, ok := docs[internal.FieldOwnerID]
 		if !ok {
 			return false
 		}

cmd/main.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	backend "staticbackend"
+)
+
+func main() {
+	backend.Start()
+}

db.go

@@ -1,18 +1,19 @@
-package main
+package staticbackend
 
 import (
 	"context"
 	"encoding/json"
 	"fmt"
 	"net/http"
 	"net/url"
-	"regexp"
 	"staticbackend/internal"
 	"staticbackend/middleware"
 	"strconv"
 	"strings"
 	"time"
 
+	"staticbackend/cache"
+
 	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/bson/primitive"
 	"go.mongodb.org/mongo-driver/mongo"
@@ -21,7 +22,7 @@ import (
 
 type Database struct {
 	client *mongo.Client
-	cache  *Cache
+	cache  *cache.Cache
 }
 
 func (database *Database) dbreq(w http.ResponseWriter, r *http.Request) {
@@ -91,7 +92,7 @@ func (database *Database) add(w http.ResponseWriter, r *http.Request) {
 	doc["id"] = doc[internal.FieldID]
 	delete(doc, internal.FieldID)
 
-	database.cache.publishDocument("db-"+col, MsgTypeDBCreated, doc)
+	database.cache.PublishDocument("db-"+col, internal.MsgTypeDBCreated, doc)
 
 	respond(w, http.StatusCreated, doc)
 }
@@ -131,10 +132,10 @@ func (database *Database) list(w http.ResponseWriter, r *http.Request) {
 
 	// if they're not root
 	if !strings.HasPrefix(col, "pub_") && auth.Role < 100 {
-		switch readPermission(col) {
-		case permGroup:
+		switch internal.ReadPermission(col) {
+		case internal.PermGroup:
 			filter = bson.M{"accountId": auth.AccountID}
-		case permOwner:
+		case internal.PermOwner:
 			filter = bson.M{internal.FieldAccountID: auth.AccountID, internal.FieldOwnerID: auth.UserID}
 		}
 	}
@@ -217,10 +218,10 @@ func (database *Database) get(w http.ResponseWriter, r *http.Request) {
 
 	// if they're not root and repo is not public
 	if !strings.HasPrefix(col, "pub_") && auth.Role < 100 {
-		switch readPermission(col) {
-		case permGroup:
+		switch internal.ReadPermission(col) {
+		case internal.PermGroup:
 			filter[internal.FieldAccountID] = auth.AccountID
-		case permOwner:
+		case internal.PermOwner:
 			filter[internal.FieldAccountID] = auth.AccountID
 			filter[internal.FieldOwnerID] = auth.UserID
 		}
@@ -321,10 +322,10 @@ func (database *Database) query(w http.ResponseWriter, r *http.Request) {
 
 	// either not a public repo or not root
 	if strings.HasPrefix(col, "pub_") == false && auth.Role < 100 {
-		switch readPermission(col) {
-		case permGroup:
+		switch internal.ReadPermission(col) {
+		case internal.PermGroup:
 			filter[internal.FieldAccountID] = auth.AccountID
-		case permOwner:
+		case internal.PermOwner:
 			filter[internal.FieldAccountID] = auth.AccountID
 			filter[internal.FieldOwnerID] = auth.UserID
 		}
@@ -439,10 +440,10 @@ func (database *Database) update(w http.ResponseWriter, r *http.Request) {
 
 	// if they are not "root", we use permission
 	if auth.Role < 100 {
-		switch writePermission(col) {
-		case permGroup:
+		switch internal.WritePermission(col) {
+		case internal.PermGroup:
 			filter[internal.FieldAccountID] = auth.AccountID
-		case permOwner:
+		case internal.PermOwner:
 			filter[internal.FieldAccountID] = auth.AccountID
 			filter[internal.FieldOwnerID] = auth.UserID
 		}
@@ -475,7 +476,7 @@ func (database *Database) update(w http.ResponseWriter, r *http.Request) {
 	result["id"] = result["_id"]
 	delete(result, internal.FieldID)
 
-	database.cache.publishDocument("db-"+col, MsgTypeDBUpdated, result)
+	database.cache.PublishDocument("db-"+col, internal.MsgTypeDBUpdated, result)
 
 	respond(w, http.StatusOK, result)
 }
@@ -505,10 +506,10 @@ func (database *Database) del(w http.ResponseWriter, r *http.Request) {
 
 	// if they're not root
 	if auth.Role < 100 {
-		switch writePermission(col) {
-		case permGroup:
+		switch internal.WritePermission(col) {
+		case internal.PermGroup:
 			filter[internal.FieldAccountID] = auth.AccountID
-		case permOwner:
+		case internal.PermOwner:
 			filter[internal.FieldAccountID] = auth.AccountID
 			filter[internal.FieldOwnerID] = auth.UserID
 
@@ -521,7 +522,7 @@ func (database *Database) del(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	database.cache.publishDocument("db-"+col, MsgTypeDBDeleted, id)
+	database.cache.PublishDocument("db-"+col, internal.MsgTypeDBDeleted, id)
 	respond(w, http.StatusOK, res.DeletedCount)
 }
 
@@ -578,77 +579,3 @@ func getPagination(u *url.URL) (page int64, size int64) {
 
 	return
 }
-
-type permissionLevel int
-
-const (
-	permOwner permissionLevel = iota
-	permGroup
-	permEveryone
-)
-
-func getPermission(col string) (owner string, group string, everyone string) {
-	// default permission
-	owner, group, everyone = "7", "4", "0"
-
-	re := regexp.MustCompile(`_\d\d\d_$`)
-	if re.MatchString(col) == false {
-		return
-	}
-
-	results := re.FindAllString(col, -1)
-	if len(results) != 1 {
-		return
-	}
-
-	perm := strings.Replace(results[0], "_", "", -1)
-
-	if len(perm) != 3 {
-		return
-	}
-
-	owner = string(perm[0])
-	group = string(perm[1])
-	everyone = string(perm[2])
-	return
-}
-
-func writePermission(col string) permissionLevel {
-	_, g, e := getPermission(col)
-
-	if canWrite(e) {
-		return permEveryone
-	}
-	if canWrite(g) {
-		return permGroup
-	}
-	return permOwner
-}
-
-func readPermission(col string) permissionLevel {
-	_, g, e := getPermission(col)
-
-	if canRead(e) {
-		return permEveryone
-	}
-	if canRead(g) {
-		return permGroup
-	}
-	return permOwner
-}
-
-func canWrite(s string) bool {
-	i, err := strconv.Atoi(s)
-	if err != nil {
-		return false
-	}
-	return uint8(i)&uint8(2) != 0
-}
-
-func canRead(s string) bool {
-	i, err := strconv.Atoi(s)
-	if err != nil {
-		fmt.Println(err)
-	}
-	return uint8(i)&uint8(4) != 0
-}

db_test.go

@@ -1,4 +1,4 @@
-package main
+package staticbackend
 
 import (
 	"bytes"

form.go

@@ -1,4 +1,4 @@
-package main
+package staticbackend
 
 import (
 	"context"