Merge branch 'master' into toml_config

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

README.md

@@ -12,10 +12,13 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 - Routing/controllers
 - Templating
 - Simple database migration system
+- Built in REST client
 - CSRF protection
+- Middleware
 - Minimal user login/registration + sessions
 - Config file handling
-- Entire website compiles into a single binary (~10mb) (excluding env.json)
+- Scheduled tasks
+- Entire website compiles into a single binary (~10mb) (excluding env.toml)
 - Minimal dependencies (just standard library, postgres driver, and experimental package for bcrypt)
 
 <hr>
@@ -36,10 +39,13 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 ## How to use 🤔
 
 1. Clone
-2. Run `go get` to install dependencies
+2. Delete the git folder, so you can start tracking in your own repo
-3. Copy env_example.json to env.json and fill in the values
+3. Run `go get` to install dependencies
-4. Run `go run main.go` to start the server
+4. Copy env_example.toml to env.toml and fill in the values
-5. Start building your app!
+5. Run `go run main.go` to start the server
+6. Rename the occurences of "GoWeb" to your app name
+7. Start building your app!
+8. When you see useful changes to GoWeb you'd like in your project copy them over
 
 ## How to contribute 👨‍💻
 
@@ -56,4 +62,4 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 - You and you alone are responsible for the security and everything else regarding your application.
 - It is not required, but I ask that when you use this project you give me credit by linking to this repository.
 - I also ask that when releasing self-hosted or other end-user applications that you release it under
-  the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) license. This too is not required, but I would appreciate it.
+  the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) license. This too is not required, but I would appreciate it.

app/app.go

@@ -8,7 +8,8 @@ import (
 
 // App contains and supplies available configurations and connections
 type App struct {
-	Config config.Configuration // Configuration file
+	Config         config.Configuration // Configuration file
-	Db     *sql.DB              // Database connection
+	Db             *sql.DB              // Database connection
-	Res    *embed.FS            // Resources from the embedded filesystem
+	Res            *embed.FS            // Resources from the embedded filesystem
+	ScheduledTasks Scheduled            // Scheduled contains a struct of all scheduled functions
 }

app/schedule.go

@@ -0,0 +1,71 @@
+package app
+
+import (
+	"sync"
+	"time"
+)
+
+type Scheduled struct {
+	EveryReboot []func(app *App)
+	EverySecond []func(app *App)
+	EveryMinute []func(app *App)
+	EveryHour   []func(app *App)
+	EveryDay    []func(app *App)
+	EveryWeek   []func(app *App)
+	EveryMonth  []func(app *App)
+	EveryYear   []func(app *App)
+}
+
+type Task struct {
+	Interval time.Duration
+	Funcs    []func(app *App)
+}
+
+func RunScheduledTasks(app *App, poolSize int, stop <-chan struct{}) {
+	for _, f := range app.ScheduledTasks.EveryReboot {
+		f(app)
+	}
+
+	tasks := []Task{
+		{Interval: time.Second, Funcs: app.ScheduledTasks.EverySecond},
+		{Interval: time.Minute, Funcs: app.ScheduledTasks.EveryMinute},
+		{Interval: time.Hour, Funcs: app.ScheduledTasks.EveryHour},
+		{Interval: 24 * time.Hour, Funcs: app.ScheduledTasks.EveryDay},
+		{Interval: 7 * 24 * time.Hour, Funcs: app.ScheduledTasks.EveryWeek},
+		{Interval: 30 * 24 * time.Hour, Funcs: app.ScheduledTasks.EveryMonth},
+		{Interval: 365 * 24 * time.Hour, Funcs: app.ScheduledTasks.EveryYear},
+	}
+
+	var wg sync.WaitGroup
+	runners := make([]chan bool, len(tasks))
+	for i, task := range tasks {
+		runner := make(chan bool, poolSize)
+		runners[i] = runner
+		wg.Add(1)
+		go func(task Task, runner chan bool) {
+			defer wg.Done()
+			ticker := time.NewTicker(task.Interval)
+			defer ticker.Stop()
+			for {
+				select {
+				case <-ticker.C:
+					for _, f := range task.Funcs {
+						runner <- true
+						go func(f func(app *App)) {
+							defer func() { <-runner }()
+							f(app)
+						}(f)
+					}
+				case <-stop:
+					return
+				}
+			}
+		}(task, runner)
+	}
+
+	wg.Wait()
+
+	for _, runner := range runners {
+		close(runner)
+	}
+}

config/config.go

@@ -1,54 +1,44 @@
 package config
 
 import (
-	"encoding/json"
 	"flag"
-	"log"
+	"github.com/BurntSushi/toml"
 	"os"
 )
 
 type Configuration struct {
 	Db struct {
-		Ip          string `json:"DbIp"`
+		Ip          string `toml:"DbIp"`
-		Port        string `json:"DbPort"`
+		Port        string `toml:"DbPort"`
-		Name        string `json:"DbName"`
+		Name        string `toml:"DbName"`
-		User        string `json:"DbUser"`
+		User        string `toml:"DbUser"`
-		Password    string `json:"DbPassword"`
+		Password    string `toml:"DbPassword"`
-		AutoMigrate bool   `json:"DbAutoMigrate"`
+		AutoMigrate bool   `toml:"DbAutoMigrate"`
 	}
 
 	Listen struct {
-		Ip   string `json:"HttpIp"`
+		Ip   string `toml:"HttpIp"`
-		Port string `json:"HttpPort"`
+		Port string `toml:"HttpPort"`
 	}
 
 	Template struct {
-		BaseName string `json:"BaseTemplateName"`
+		BaseName string `toml:"BaseTemplateName"`
 	}
 }
 
 // LoadConfig loads and returns a configuration struct
 func LoadConfig() Configuration {
-	c := flag.String("c", "env.json", "Path to the json configuration file")
+	c := flag.String("c", "env.toml", "Path to the toml configuration file")
 	flag.Parse()
-	file, err := os.Open(*c)
+	file, err := os.ReadFile(*c)
 	if err != nil {
-		log.Fatal("Unable to open JSON config file: ", err)
+		panic("Unable to read TOML config file: " + err.Error())
 	}
 
-	defer func(file *os.File) {
+	var Config Configuration
-		err := file.Close()
+	_, err = toml.Decode(string(file), &Config)
-		if err != nil {
-			log.Fatal("Unable to close JSON config file: ", err)
-		}
-	}(file)
-
-	// Decode json config file to Configuration struct named config
-	decoder := json.NewDecoder(file)
-	Config := Configuration{}
-	err = decoder.Decode(&Config)
 	if err != nil {
-		log.Fatal("Unable to decode JSON config file: ", err)
+		panic("Unable to decode TOML config file: " + err.Error())
 	}
 
 	return Config

controllers/get.go

@@ -0,0 +1,65 @@
+package controllers
+
+import (
+	"GoWeb/app"
+	"GoWeb/models"
+	"GoWeb/security"
+	"GoWeb/templating"
+	"net/http"
+)
+
+// Get is a wrapper struct for the App struct
+type Get struct {
+	App *app.App
+}
+
+func (g *Get) ShowHome(w http.ResponseWriter, _ *http.Request) {
+	type dataStruct struct {
+		Test string
+	}
+
+	data := dataStruct{
+		Test: "Hello World!",
+	}
+
+	templating.RenderTemplate(g.App, w, "templates/pages/home.html", data)
+}
+
+func (g *Get) ShowRegister(w http.ResponseWriter, r *http.Request) {
+	type dataStruct struct {
+		CsrfToken string
+	}
+
+	CsrfToken, err := security.GenerateCsrfToken(w, r)
+	if err != nil {
+		return
+	}
+
+	data := dataStruct{
+		CsrfToken: CsrfToken,
+	}
+
+	templating.RenderTemplate(g.App, w, "templates/pages/register.html", data)
+}
+
+func (g *Get) ShowLogin(w http.ResponseWriter, r *http.Request) {
+	type dataStruct struct {
+		CsrfToken string
+	}
+
+	CsrfToken, err := security.GenerateCsrfToken(w, r)
+	if err != nil {
+		return
+	}
+
+	data := dataStruct{
+		CsrfToken: CsrfToken,
+	}
+
+	templating.RenderTemplate(g.App, w, "templates/pages/login.html", data)
+}
+
+func (g *Get) Logout(w http.ResponseWriter, r *http.Request) {
+	models.LogoutUser(g.App, w, r)
+	http.Redirect(w, r, "/", http.StatusFound)
+}

controllers/getController.go

@@ -1,67 +0,0 @@
-package controllers
-
-import (
-	"GoWeb/app"
-	"GoWeb/models"
-	"GoWeb/security"
-	"GoWeb/templating"
-	"net/http"
-)
-
-// GetController is a wrapper struct for the App struct
-type GetController struct {
-	App *app.App
-}
-
-func (getController *GetController) ShowHome(w http.ResponseWriter, _ *http.Request) {
-	type dataStruct struct {
-		Test string
-	}
-
-	data := dataStruct{
-		Test: "Hello World!",
-	}
-
-	templating.RenderTemplate(getController.App, w, "templates/pages/home.html", data)
-}
-
-func (getController *GetController) ShowRegister(w http.ResponseWriter, r *http.Request) {
-	type dataStruct struct {
-		CsrfToken string
-	}
-
-	// Create csrf token
-	CsrfToken, err := security.GenerateCsrfToken(w, r)
-	if err != nil {
-		return
-	}
-
-	data := dataStruct{
-		CsrfToken: CsrfToken,
-	}
-
-	templating.RenderTemplate(getController.App, w, "templates/pages/register.html", data)
-}
-
-func (getController *GetController) ShowLogin(w http.ResponseWriter, r *http.Request) {
-	type dataStruct struct {
-		CsrfToken string
-	}
-
-	// Create csrf token
-	CsrfToken, err := security.GenerateCsrfToken(w, r)
-	if err != nil {
-		return
-	}
-
-	data := dataStruct{
-		CsrfToken: CsrfToken,
-	}
-
-	templating.RenderTemplate(getController.App, w, "templates/pages/login.html", data)
-}
-
-func (getController *GetController) Logout(w http.ResponseWriter, r *http.Request) {
-	models.LogoutUser(getController.App, w, r)
-	http.Redirect(w, r, "/", http.StatusFound)
-}

controllers/post.go

@@ -0,0 +1,52 @@
+package controllers
+
+import (
+	"GoWeb/app"
+	"GoWeb/models"
+	"log/slog"
+	"net/http"
+	"time"
+)
+
+// Post is a wrapper struct for the App struct
+type Post struct {
+	App *app.App
+}
+
+func (p *Post) Login(w http.ResponseWriter, r *http.Request) {
+	username := r.FormValue("username")
+	password := r.FormValue("password")
+	remember := r.FormValue("remember") == "on"
+
+	if username == "" || password == "" {
+		http.Redirect(w, r, "/login", http.StatusUnauthorized)
+	}
+
+	_, err := models.AuthenticateUser(p.App, w, username, password, remember)
+	if err != nil {
+		http.Redirect(w, r, "/login", http.StatusUnauthorized)
+		return
+	}
+
+	http.Redirect(w, r, "/", http.StatusFound)
+}
+
+func (p *Post) Register(w http.ResponseWriter, r *http.Request) {
+	username := r.FormValue("username")
+	password := r.FormValue("password")
+	createdAt := time.Now()
+	updatedAt := time.Now()
+
+	if username == "" || password == "" {
+		http.Redirect(w, r, "/register", http.StatusUnauthorized)
+	}
+
+	_, err := models.CreateUser(p.App, username, password, createdAt, updatedAt)
+	if err != nil {
+		// TODO: if err == bcrypt.ErrPasswordTooLong display error to user, this will require a flash message system with cookies
+		slog.Error("error creating user: " + err.Error())
+		http.Redirect(w, r, "/register", http.StatusInternalServerError)
+	}
+
+	http.Redirect(w, r, "/login", http.StatusFound)
+}

controllers/postController.go

@@ -1,70 +0,0 @@
-package controllers
-
-import (
-	"GoWeb/app"
-	"GoWeb/models"
-	"GoWeb/security"
-	"log"
-	"net/http"
-	"time"
-)
-
-// PostController is a wrapper struct for the App struct
-type PostController struct {
-	App *app.App
-}
-
-func (postController *PostController) Login(w http.ResponseWriter, r *http.Request) {
-	// Validate csrf token
-	_, err := security.VerifyCsrfToken(r)
-	if err != nil {
-		log.Println("Error verifying csrf token")
-		return
-	}
-
-	username := r.FormValue("username")
-	password := r.FormValue("password")
-
-	if username == "" || password == "" {
-		log.Println("Tried to login user with empty username or password")
-		http.Redirect(w, r, "/login", http.StatusFound)
-	}
-
-	_, err = models.AuthenticateUser(postController.App, w, username, password)
-	if err != nil {
-		log.Println("Error authenticating user")
-		log.Println(err)
-		http.Redirect(w, r, "/login", http.StatusFound)
-		return
-	}
-
-	http.Redirect(w, r, "/", http.StatusFound)
-}
-
-func (postController *PostController) Register(w http.ResponseWriter, r *http.Request) {
-	// Validate csrf token
-	_, err := security.VerifyCsrfToken(r)
-	if err != nil {
-		log.Println("Error verifying csrf token")
-		return
-	}
-
-	username := r.FormValue("username")
-	password := r.FormValue("password")
-	createdAt := time.Now()
-	updatedAt := time.Now()
-
-	if username == "" || password == "" {
-		log.Println("Tried to create user with empty username or password")
-		http.Redirect(w, r, "/register", http.StatusFound)
-	}
-
-	_, err = models.CreateUser(postController.App, username, password, createdAt, updatedAt)
-	if err != nil {
-		log.Println("Error creating user")
-		log.Println(err)
-		return
-	}
-
-	http.Redirect(w, r, "/login", http.StatusFound)
-}

database/connection.go

@@ -5,29 +5,26 @@ import (
 	"database/sql"
 	"fmt"
 	_ "github.com/lib/pq"
-	"log"
+	"log/slog"
 )
 
-// ConnectDB returns a new database connection
+// Connect returns a new database connection
-func ConnectDB(app *app.App) *sql.DB {
+func Connect(app *app.App) *sql.DB {
-	// Set connection parameters from config
 	postgresConfig := fmt.Sprintf("host=%s port=%s user=%s "+
 		"password=%s dbname=%s sslmode=disable",
 		app.Config.Db.Ip, app.Config.Db.Port, app.Config.Db.User, app.Config.Db.Password, app.Config.Db.Name)
 
-	// Create connection
 	db, err := sql.Open("postgres", postgresConfig)
 	if err != nil {
 		panic(err)
 	}
 
-	// Test connection
 	err = db.Ping()
 	if err != nil {
 		panic(err)
 	}
 
-	log.Println("Connected to database successfully on " + app.Config.Db.Ip + ":" + app.Config.Db.Port + " using database " + app.Config.Db.Name)
+	slog.Info("connected to database successfully on " + app.Config.Db.Ip + ":" + app.Config.Db.Port + " using database " + app.Config.Db.Name)
 
 	return db
 }

database/migrate.go

@@ -5,7 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"github.com/lib/pq"
-	"log"
+	"log/slog"
 	"reflect"
 )
 
@@ -36,48 +36,46 @@ func Migrate(app *app.App, anyStruct interface{}) error {
 
 // createTable creates a table with the given name if it doesn't exist, it is assumed that id will be the primary key
 func createTable(app *app.App, tableName string) error {
-	// Check to see if the table already exists
 	var tableExists bool
 	err := app.Db.QueryRow("SELECT EXISTS (SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace WHERE c.relname ~ $1 AND pg_catalog.pg_table_is_visible(c.oid))", "^"+tableName+"$").Scan(&tableExists)
 	if err != nil {
-		log.Println("Error checking if table exists: " + tableName)
+		slog.Error("error checking if table exists: " + tableName)
 		return err
 	}
 
 	if tableExists {
-		log.Println("Table already exists: " + tableName)
+		slog.Info("table already exists: " + tableName)
 		return nil
 	} else {
 		sanitizedTableQuery := fmt.Sprintf("CREATE TABLE IF NOT EXISTS \"%s\" (\"Id\" serial primary key)", tableName)
 
 		_, err := app.Db.Query(sanitizedTableQuery)
 		if err != nil {
-			log.Println("Error creating table: " + tableName)
+			slog.Error("error creating table: " + tableName)
 			return err
 		}
 
-		log.Println("Table created successfully: " + tableName)
+		slog.Info("table created successfully: " + tableName)
 		return nil
 	}
 }
 
 // createColumn creates a column with the given name and type if it doesn't exist
 func createColumn(app *app.App, tableName, columnName, columnType string) error {
-	// Check to see if the column already exists
 	var columnExists bool
 	err := app.Db.QueryRow("SELECT EXISTS (SELECT 1 FROM information_schema.columns WHERE table_name = $1 AND column_name = $2)", tableName, columnName).Scan(&columnExists)
 	if err != nil {
-		log.Println("Error checking if column exists: " + columnName + " in table: " + tableName)
+		slog.Error("error checking if column exists: " + columnName + " in table: " + tableName)
 		return err
 	}
 
 	if columnExists {
-		log.Println("Column already exists: " + columnName + " in table: " + tableName)
+		slog.Info("column already exists: " + columnName + " in table: " + tableName)
 		return nil
 	} else {
 		postgresType, err := getPostgresType(columnType)
 		if err != nil {
-			log.Println("Error creating column: " + columnName + " in table: " + tableName + " with type: " + postgresType)
+			slog.Error("error creating column: " + columnName + " in table: " + tableName + " with type: " + postgresType)
 			return err
 		}
 
@@ -86,11 +84,11 @@ func createColumn(app *app.App, tableName, columnName, columnType string) error
 
 		_, err = app.Db.Query(query)
 		if err != nil {
-			log.Println("Error creating column: " + columnName + " in table: " + tableName + " with type: " + postgresType)
+			slog.Error("error creating column: " + columnName + " in table: " + tableName + " with type: " + postgresType)
 			return err
 		}
 
-		log.Println("Column created successfully:", columnName)
+		slog.Info("column created successfully:", columnName)
 
 		return nil
 	}

env_example.json

@@ -1,17 +0,0 @@
-{
-  "Db": {
-    "DbIp": "127.0.0.1",
-    "DbPort": "5432",
-    "DbName": "database",
-    "DbUser": "user",
-    "DbPassword": "password",
-    "DbAutoMigrate": true
-  },
-  "Listen": {
-    "HttpIp": "127.0.0.1",
-    "HttpPort": "8090"
-  },
-  "Template": {
-    "BaseTemplateName": "templates/base.html"
-  }
-}

env_example.toml

@@ -0,0 +1,14 @@
+[Db]
+DbIp = "127.0.0.1"
+DbPort = "5432"
+DbName = "test"
+DbUser = "postgres"
+DbPassword = "postgres"
+DbAutoMigrate = true
+
+[Listen]
+HttpIp = "127.0.0.1"
+HttpPort = "8090"
+
+[Template]
+BaseTemplateName = "templates/base.html"

go.mod

@@ -1,8 +1,10 @@
 module GoWeb
 
-go 1.20
+go 1.21
 
 require (
-	github.com/lib/pq v1.10.7
+	github.com/lib/pq v1.10.9
-	golang.org/x/crypto v0.7.0
+	golang.org/x/crypto v0.13.0
 )
+
+require github.com/BurntSushi/toml v1.3.2

go.sum

@@ -1,4 +1,6 @@
-github.com/lib/pq v1.10.7 h1:p7ZhMD+KsSRozJr34udlUrhboJwWAgCg34+/ZZNvZZw=
+github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
-github.com/lib/pq v1.10.7/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
-golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
+github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
-golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
+github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
+golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=

main.go

@@ -8,7 +8,8 @@ import (
 	"GoWeb/routes"
 	"context"
 	"embed"
-	"log"
+	"errors"
+	"log/slog"
 	"net/http"
 	"os"
 	"os/signal"
@@ -33,48 +34,62 @@ func main() {
 	if _, err := os.Stat("logs"); os.IsNotExist(err) {
 		err := os.Mkdir("logs", 0755)
 		if err != nil {
-			log.Println("Failed to create log directory")
+			panic("failed to create log directory: " + err.Error())
-			log.Println(err)
-			return
 		}
 	}
 
 	// Create log file and set output
-	file, err := os.OpenFile("logs/"+time.Now().Format("2006-01-02")+".log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+	file, err := os.OpenFile("logs/"+time.Now().Format("2006-01-02")+".log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
-	log.SetOutput(file)
+	if err != nil {
+		panic("error creating log file: " + err.Error())
+	}
+
+	logger := slog.New(slog.NewTextHandler(file, nil))
+	slog.SetDefault(logger) // Set structured logger globally
 
 	// Connect to database and run migrations
-	appLoaded.Db = database.ConnectDB(&appLoaded)
+	appLoaded.Db = database.Connect(&appLoaded)
 	if appLoaded.Config.Db.AutoMigrate {
 		err = models.RunAllMigrations(&appLoaded)
 		if err != nil {
-			log.Println(err)
+			slog.Error("error running migrations: " + err.Error())
-			return
+			os.Exit(1)
 		}
 	}
 
+	// Assign and run scheduled tasks
+	appLoaded.ScheduledTasks = app.Scheduled{
+		EveryReboot: []func(app *app.App){models.ScheduledSessionCleanup},
+		EveryMinute: []func(app *app.App){models.ScheduledSessionCleanup},
+	}
+
 	// Define Routes
-	routes.GetRoutes(&appLoaded)
+	routes.Get(&appLoaded)
-	routes.PostRoutes(&appLoaded)
+	routes.Post(&appLoaded)
 
 	// Start server
 	server := &http.Server{Addr: appLoaded.Config.Listen.Ip + ":" + appLoaded.Config.Listen.Port}
 	go func() {
-		log.Println("Starting server and listening on " + appLoaded.Config.Listen.Ip + ":" + appLoaded.Config.Listen.Port)
+		slog.Info("starting server and listening on " + appLoaded.Config.Listen.Ip + ":" + appLoaded.Config.Listen.Port)
 		err := server.ListenAndServe()
-		if err != nil && err != http.ErrServerClosed {
+		if err != nil && !errors.Is(err, http.ErrServerClosed) {
-			log.Fatalf("Could not listen on %s: %v\n", appLoaded.Config.Listen.Ip+":"+appLoaded.Config.Listen.Port, err)
+			slog.Error("could not listen on %s: %v\n", appLoaded.Config.Listen.Ip+":"+appLoaded.Config.Listen.Port, err)
+			os.Exit(1)
 		}
 	}()
 
 	// Wait for interrupt signal and shut down the server
 	interrupt := make(chan os.Signal, 1)
 	signal.Notify(interrupt, os.Interrupt, syscall.SIGTERM)
+	stop := make(chan struct{})
+	go app.RunScheduledTasks(&appLoaded, 100, stop)
+
 	<-interrupt
-	log.Println("Interrupt signal received. Shutting down server...")
+	slog.Info("interrupt signal received. Shutting down server...")
 
 	err = server.Shutdown(context.Background())
 	if err != nil {
-		log.Fatalf("Could not gracefully shutdown the server: %v\n", err)
+		slog.Error("could not gracefully shutdown the server: %v\n", err)
+		os.Exit(1)
 	}
 }

middleware/csrf.go

@@ -0,0 +1,21 @@
+package middleware
+
+import (
+	"GoWeb/security"
+	"log/slog"
+	"net/http"
+)
+
+// Csrf validates the CSRF token and returns the handler function if it succeeded
+func Csrf(f func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		_, err := security.VerifyCsrfToken(r)
+		if err != nil {
+			slog.Info("error verifying csrf token")
+			http.Error(w, "Forbidden", http.StatusForbidden)
+			return
+		}
+
+		f(w, r)
+	}
+}

middleware/groups.go

@@ -0,0 +1,5 @@
+package middleware
+
+import "net/http"
+
+type MiddlewareFunc func(f func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request)

middleware/wrapper.go

@@ -0,0 +1,14 @@
+package middleware
+
+import "net/http"
+
+// ProcessGroup is a wrapper function for the http.HandleFunc function
+// that takes the function you want to execute (f) and the middleware you want
+// to execute (m) this should be used when processing multiple groups of middleware at a time
+func ProcessGroup(f func(w http.ResponseWriter, r *http.Request), m []MiddlewareFunc) func(w http.ResponseWriter, r *http.Request) {
+	for _, middleware := range m {
+		_ = middleware(f)
+	}
+
+	return f
+}

models/migrations.go

@@ -22,10 +22,11 @@ func RunAllMigrations(app *app.App) error {
 	}
 
 	session := Session{
-		Id:        1,
+		Id:         1,
-		UserId:    1,
+		UserId:     1,
-		AuthToken: "migrate",
+		AuthToken:  "migrate",
-		CreatedAt: time.Now(),
+		RememberMe: false,
+		CreatedAt:  time.Now(),
 	}
 	err = database.Migrate(app, session)
 	if err != nil {

models/session.go

@@ -4,55 +4,57 @@ import (
 	"GoWeb/app"
 	"crypto/rand"
 	"encoding/hex"
-	"log"
+	"log/slog"
 	"net/http"
 	"time"
 )
 
 type Session struct {
-	Id        int64
+	Id         int64
-	UserId    int64
+	UserId     int64
-	AuthToken string
+	AuthToken  string
-	CreatedAt time.Time
+	RememberMe bool
+	CreatedAt  time.Time
 }
 
-const sessionColumnsNoId = "\"UserId\", \"AuthToken\", \"CreatedAt\""
+const sessionColumnsNoId = "\"UserId\", \"AuthToken\",\"RememberMe\", \"CreatedAt\""
 const sessionColumns = "\"Id\", " + sessionColumnsNoId
 const sessionTable = "public.\"Session\""
 
 const (
-	selectSessionByAuthToken = "SELECT " + sessionColumns + " FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
+	selectSessionByAuthToken      = "SELECT " + sessionColumns + " FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
-	selectAuthTokenIfExists  = "SELECT EXISTS(SELECT 1 FROM " + sessionTable + " WHERE \"AuthToken\" = $1)"
+	selectAuthTokenIfExists       = "SELECT EXISTS(SELECT 1 FROM " + sessionTable + " WHERE \"AuthToken\" = $1)"
-	insertSession            = "INSERT INTO " + sessionTable + " (" + sessionColumnsNoId + ") VALUES ($1, $2, $3) RETURNING \"Id\""
+	insertSession                 = "INSERT INTO " + sessionTable + " (" + sessionColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
-	deleteSessionByAuthToken = "DELETE FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
+	deleteSessionByAuthToken      = "DELETE FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
+	deleteSessionsOlderThan30Days = "DELETE FROM " + sessionTable + " WHERE \"CreatedAt\" < NOW() - INTERVAL '30 days'"
+	deleteSessionsOlderThan6Hours = "DELETE FROM " + sessionTable + " WHERE \"CreatedAt\" < NOW() - INTERVAL '6 hours' AND \"RememberMe\" = false"
 )
 
 // CreateSession creates a new session for a user
-func CreateSession(app *app.App, w http.ResponseWriter, userId int64) (Session, error) {
+func CreateSession(app *app.App, w http.ResponseWriter, userId int64, remember bool) (Session, error) {
 	session := Session{}
 	session.UserId = userId
 	session.AuthToken = generateAuthToken(app)
+	session.RememberMe = remember
 	session.CreatedAt = time.Now()
 
 	// If the AuthToken column for any user matches the token, set existingAuthToken to true
 	var existingAuthToken bool
 	err := app.Db.QueryRow(selectAuthTokenIfExists, session.AuthToken).Scan(&existingAuthToken)
 	if err != nil {
-		log.Println("Error checking for existing auth token")
+		slog.Error("error checking for existing auth token" + err.Error())
-		log.Println(err)
 		return Session{}, err
 	}
 
 	// If duplicate token found, recursively call function until unique token is generated
-	if existingAuthToken == true {
+	if existingAuthToken {
-		log.Println("Duplicate token found in sessions table, generating new token...")
+		slog.Warn("duplicate token found in sessions table, generating new token...")
-		return CreateSession(app, w, userId)
+		return CreateSession(app, w, userId, remember)
 	}
 
-	// Insert session into database
+	err = app.Db.QueryRow(insertSession, session.UserId, session.AuthToken, session.RememberMe, session.CreatedAt).Scan(&session.Id)
-	err = app.Db.QueryRow(insertSession, session.UserId, session.AuthToken, session.CreatedAt).Scan(&session.Id)
 	if err != nil {
-		log.Println("Error inserting session into database")
+		slog.Error("error inserting session into database")
 		return Session{}, err
 	}
 
@@ -60,28 +62,49 @@ func CreateSession(app *app.App, w http.ResponseWriter, userId int64) (Session,
 	return session, nil
 }
 
-// Generates a random 64-byte string
+func GetSessionByAuthToken(app *app.App, authToken string) (Session, error) {
+	session := Session{}
+
+	err := app.Db.QueryRow(selectSessionByAuthToken, authToken).Scan(&session.Id, &session.UserId, &session.AuthToken, &session.RememberMe, &session.CreatedAt)
+	if err != nil {
+		return Session{}, err
+	}
+
+	return session, nil
+}
+
+// generateAuthToken generates a random 64-byte string
 func generateAuthToken(app *app.App) string {
-	// Generate random bytes
 	b := make([]byte, 64)
 	_, err := rand.Read(b)
 	if err != nil {
-		log.Println("Error generating random bytes")
+		slog.Error("error generating random bytes for auth token")
 	}
 
-	// Convert random bytes to hex string
 	return hex.EncodeToString(b)
 }
 
 // createSessionCookie creates a new session cookie
 func createSessionCookie(app *app.App, w http.ResponseWriter, session Session) {
-	cookie := &http.Cookie{
+	cookie := &http.Cookie{}
-		Name:     "session",
+	if session.RememberMe {
-		Value:    session.AuthToken,
+		cookie = &http.Cookie{
-		Path:     "/",
+			Name:     "session",
-		MaxAge:   86400,
+			Value:    session.AuthToken,
-		HttpOnly: true,
+			Path:     "/",
-		Secure:   true,
+			MaxAge:   2592000 * 1000, // 30 days in ms
+			HttpOnly: true,
+			Secure:   true,
+		}
+	} else {
+		cookie = &http.Cookie{
+			Name:     "session",
+			Value:    session.AuthToken,
+			Path:     "/",
+			MaxAge:   21600 * 1000, // 6 hours in ms
+			HttpOnly: true,
+			Secure:   true,
+		}
 	}
 
 	http.SetCookie(w, cookie)
@@ -101,10 +124,9 @@ func deleteSessionCookie(app *app.App, w http.ResponseWriter) {
 
 // DeleteSessionByAuthToken deletes a session from the database by AuthToken
 func DeleteSessionByAuthToken(app *app.App, w http.ResponseWriter, authToken string) error {
-	// Delete session from database
 	_, err := app.Db.Exec(deleteSessionByAuthToken, authToken)
 	if err != nil {
-		log.Println("Error deleting session from database")
+		slog.Error("error deleting session from database")
 		return err
 	}
 
@@ -112,3 +134,20 @@ func DeleteSessionByAuthToken(app *app.App, w http.ResponseWriter, authToken str
 
 	return nil
 }
+
+// ScheduledSessionCleanup deletes expired sessions from the database
+func ScheduledSessionCleanup(app *app.App) {
+	// Delete sessions older than 30 days (remember me sessions)
+	_, err := app.Db.Exec(deleteSessionsOlderThan30Days)
+	if err != nil {
+		slog.Error("error deleting 30 day expired sessions from database" + err.Error())
+	}
+
+	// Delete sessions older than 6 hours
+	_, err = app.Db.Exec(deleteSessionsOlderThan6Hours)
+	if err != nil {
+		slog.Error("error deleting 6 hour expired sessions from database" + err.Error())
+	}
+
+	slog.Info("deleted expired sessions from database")
+}

models/user.go

@@ -2,9 +2,8 @@ package models
 
 import (
 	"GoWeb/app"
-	"log"
+	"log/slog"
 	"net/http"
-	"strconv"
 	"time"
 
 	"golang.org/x/crypto/bcrypt"
@@ -23,40 +22,32 @@ const userColumns = "\"Id\", " + userColumnsNoId
 const userTable = "public.\"User\""
 
 const (
-	selectSessionIdByAuthToken = "SELECT \"Id\" FROM public.\"Session\" WHERE \"AuthToken\" = $1"
+	selectUserById       = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Id\" = $1"
-	selectUserById             = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Id\" = $1"
+	selectUserByUsername = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Username\" = $1"
-	selectUserByUsername       = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Username\" = $1"
+	insertUser           = "INSERT INTO " + userTable + " (" + userColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
-	insertUser                 = "INSERT INTO " + userTable + " (" + userColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
 )
 
 // GetCurrentUser finds the currently logged-in user by session cookie
 func GetCurrentUser(app *app.App, r *http.Request) (User, error) {
 	cookie, err := r.Cookie("session")
 	if err != nil {
-		log.Println("Error getting session cookie")
 		return User{}, err
 	}
 
-	var userId int64
+	session, err := GetSessionByAuthToken(app, cookie.Value)
-
-	// Query row by AuthToken
-	err = app.Db.QueryRow(selectSessionIdByAuthToken, cookie.Value).Scan(&userId)
 	if err != nil {
-		log.Println("Error querying session row with session: " + cookie.Value)
 		return User{}, err
 	}
 
-	return GetUserById(app, userId)
+	return GetUserById(app, session.UserId)
 }
 
 // GetUserById finds a User table row in the database by id and returns a struct representing this row
 func GetUserById(app *app.App, id int64) (User, error) {
 	user := User{}
 
-	// Query row by id
 	err := app.Db.QueryRow(selectUserById, id).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
 	if err != nil {
-		log.Println("Get user error (user not found) for user id:" + strconv.FormatInt(id, 10))
 		return User{}, err
 	}
 
@@ -67,10 +58,8 @@ func GetUserById(app *app.App, id int64) (User, error) {
 func GetUserByUsername(app *app.App, username string) (User, error) {
 	user := User{}
 
-	// Query row by username
 	err := app.Db.QueryRow(selectUserByUsername, username).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
 	if err != nil {
-		log.Println("Get user error (user not found) for user:" + username)
 		return User{}, err
 	}
 
@@ -79,10 +68,9 @@ func GetUserByUsername(app *app.App, username string) (User, error) {
 
 // CreateUser creates a User table row in the database
 func CreateUser(app *app.App, username string, password string, createdAt time.Time, updatedAt time.Time) (User, error) {
-	// Hash password
 	hash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
 	if err != nil {
-		log.Println("Error hashing password when creating user")
+		slog.Error("error hashing password: " + err.Error())
 		return User{}, err
 	}
 
@@ -90,7 +78,7 @@ func CreateUser(app *app.App, username string, password string, createdAt time.T
 
 	err = app.Db.QueryRow(insertUser, username, string(hash), createdAt, updatedAt).Scan(&lastInsertId)
 	if err != nil {
-		log.Println("Error creating user row")
+		slog.Error("error creating user row: " + err.Error())
 		return User{}, err
 	}
 
@@ -98,49 +86,33 @@ func CreateUser(app *app.App, username string, password string, createdAt time.T
 }
 
 // AuthenticateUser validates the password for the specified user
-func AuthenticateUser(app *app.App, w http.ResponseWriter, username string, password string) (Session, error) {
+func AuthenticateUser(app *app.App, w http.ResponseWriter, username string, password string, remember bool) (Session, error) {
 	var user User
 
-	// Query row by username
 	err := app.Db.QueryRow(selectUserByUsername, username).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
 	if err != nil {
-		log.Println("Authentication error (user not found) for user:" + username)
+		slog.Info("user not found: " + username)
 		return Session{}, err
 	}
 
-	// Validate password
 	err = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(password))
 	if err != nil { // Failed to validate password, doesn't match
-		log.Println("Authentication error (incorrect password) for user:" + username)
+		slog.Info("incorrect password:" + username)
 		return Session{}, err
 	} else {
-		return CreateSession(app, w, user.Id)
+		return CreateSession(app, w, user.Id, remember)
 	}
 }
 
 // LogoutUser deletes the session cookie and AuthToken from the database
 func LogoutUser(app *app.App, w http.ResponseWriter, r *http.Request) {
-	// Get cookie from request
 	cookie, err := r.Cookie("session")
 	if err != nil {
-		log.Println("Error getting cookie from request")
 		return
 	}
 
-	// Set token to empty string
 	err = DeleteSessionByAuthToken(app, w, cookie.Value)
 	if err != nil {
-		log.Println("Error deleting session by AuthToken")
 		return
 	}
-
-	// Delete cookie
-	cookie = &http.Cookie{
-		Name:   "session",
-		Value:  "",
-		Path:   "/",
-		MaxAge: -1,
-	}
-
-	http.SetCookie(w, cookie)
 }

restclient/client.go

@@ -0,0 +1,65 @@
+package restclient
+
+import (
+	"bytes"
+	"encoding/json"
+	"mime/multipart"
+	"net/http"
+)
+
+// SendRequest sends an HTTP request to a URL and includes the specified headers and body.
+// A body can be nil for GET requests, a map[string]string for multipart/form-data requests,
+// or a struct for JSON requests
+func SendRequest(url string, method string, headers map[string]string, body interface{}) (http.Response, error) {
+	var reqBody *bytes.Buffer
+	var contentType string
+
+	switch v := body.(type) {
+	case nil:
+		reqBody = bytes.NewBuffer([]byte(""))
+	case map[string]string:
+		reqBody = &bytes.Buffer{}
+		writer := multipart.NewWriter(reqBody)
+		for key, value := range v {
+			err := writer.WriteField(key, value)
+			if err != nil {
+				return http.Response{}, err
+			}
+		}
+
+		err := writer.Close()
+		if err != nil {
+			return http.Response{}, err
+		}
+
+		contentType = writer.FormDataContentType()
+	default:
+		jsonBody, err := json.Marshal(body)
+		if err != nil {
+			return http.Response{}, err
+		}
+		reqBody = bytes.NewBuffer(jsonBody)
+		contentType = "application/json"
+	}
+
+	req, err := http.NewRequest(method, url, reqBody)
+	if err != nil {
+		return http.Response{}, err
+	}
+
+	if contentType != "" {
+		req.Header.Set("Content-Type", contentType)
+	}
+
+	for key, value := range headers {
+		req.Header.Add(key, value)
+	}
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	if err != nil {
+		return http.Response{}, err
+	}
+
+	return *resp, nil
+}

routes/get.go

@@ -4,26 +4,26 @@ import (
 	"GoWeb/app"
 	"GoWeb/controllers"
 	"io/fs"
-	"log"
+	"log/slog"
 	"net/http"
 )
 
-// GetRoutes defines all project get routes
+// Get defines all project get routes
-func GetRoutes(app *app.App) {
+func Get(app *app.App) {
 	// Get controller struct initialize
-	getController := controllers.GetController{
+	getController := controllers.Get{
 		App: app,
 	}
 
 	// Serve static files
 	staticFS, err := fs.Sub(app.Res, "static")
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		return
 	}
 	staticHandler := http.FileServer(http.FS(staticFS))
 	http.Handle("/static/", http.StripPrefix("/static/", staticHandler))
-	log.Println("Serving static files from embedded file system /static")
+	slog.Info("serving static files from embedded file system /static")
 
 	// Pages
 	http.HandleFunc("/", getController.ShowHome)

routes/post.go

@@ -0,0 +1,20 @@
+package routes
+
+import (
+	"GoWeb/app"
+	"GoWeb/controllers"
+	"GoWeb/middleware"
+	"net/http"
+)
+
+// Post defines all project post routes
+func Post(app *app.App) {
+	// Post controller struct initialize
+	postController := controllers.Post{
+		App: app,
+	}
+
+	// User authentication
+	http.HandleFunc("/register-handle", middleware.Csrf(postController.Register))
+	http.HandleFunc("/login-handle", middleware.Csrf(postController.Login))
+}

routes/postRoutes.go

@@ -1,19 +0,0 @@
-package routes
-
-import (
-	"GoWeb/app"
-	"GoWeb/controllers"
-	"net/http"
-)
-
-// PostRoutes defines all project post routes
-func PostRoutes(app *app.App) {
-	// Post controller struct initialize
-	postController := controllers.PostController{
-		App: app,
-	}
-
-	// User authentication
-	http.HandleFunc("/register-handle", postController.Register)
-	http.HandleFunc("/login-handle", postController.Login)
-}

security/csrf.go

@@ -3,19 +3,17 @@ package security
 import (
 	"crypto/rand"
 	"encoding/hex"
-	"log"
+	"log/slog"
 	"math"
 	"net/http"
 )
 
 // GenerateCsrfToken generates a csrf token and assigns it to a cookie for double submit cookie csrf protection
 func GenerateCsrfToken(w http.ResponseWriter, _ *http.Request) (string, error) {
-	// Generate random 64 character string (alpha-numeric)
 	buff := make([]byte, int(math.Ceil(float64(64)/2)))
 	_, err := rand.Read(buff)
 	if err != nil {
-		log.Println("Error creating random buffer for csrf token value")
+		slog.Error("error creating random buffer for csrf token value" + err.Error())
-		log.Println(err)
 		return "", err
 	}
 	str := hex.EncodeToString(buff)
@@ -39,8 +37,7 @@ func GenerateCsrfToken(w http.ResponseWriter, _ *http.Request) (string, error) {
 func VerifyCsrfToken(r *http.Request) (bool, error) {
 	cookie, err := r.Cookie("csrf_token")
 	if err != nil {
-		log.Println("Error getting csrf_token cookie")
+		slog.Info("unable to get csrf_token cookie" + err.Error())
-		log.Println(err)
 		return false, err
 	}
 

templates/pages/login.html

@@ -10,6 +10,8 @@
         <input id="username" name="username" type="text" placeholder="John"><br><br>
         <label for="password">Password:</label><br>
         <input id="password" name="password" type="password"><br><br>
+        <label for="remember">Remember Me:</label>
+        <input id="remember" type="checkbox" name="remember"><br><br>
         <input type="submit" value="Submit">
     </form>
 </div>

templating/templateHelper.go

@@ -3,7 +3,7 @@ package templating
 import (
 	"GoWeb/app"
 	"html/template"
-	"log"
+	"log/slog"
 	"net/http"
 )
 
@@ -13,35 +13,35 @@ func RenderTemplate(app *app.App, w http.ResponseWriter, contentPath string, dat
 
 	templateContent, err := app.Res.ReadFile(templatePath)
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		http.Error(w, err.Error(), 500)
 		return
 	}
 
 	t, err := template.New(templatePath).Parse(string(templateContent))
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		http.Error(w, err.Error(), 500)
 		return
 	}
 
 	content, err := app.Res.ReadFile(contentPath)
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		http.Error(w, err.Error(), 500)
 		return
 	}
 
 	t, err = t.Parse(string(content))
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		http.Error(w, err.Error(), 500)
 		return
 	}
 
 	err = t.Execute(w, data)
 	if err != nil {
-		log.Println(err)
+		slog.Error(err.Error())
 		http.Error(w, err.Error(), 500)
 		return
 	}