Merge branch 'master' into file_uploads

.gitattributes

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

README.md

@@ -15,6 +15,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 - CSRF protection
 - Minimal user login/registration + sessions
 - Config file handling
+- Scheduled tasks
 - Entire website compiles into a single binary (~10mb) (excluding env.json)
 - Minimal dependencies (just standard library, postgres driver, and experimental package for bcrypt)
 

app/app.go

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

app/schedule.go

@@ -0,0 +1,75 @@
+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{}) {
+	// Run every time the server starts
+	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},
+	}
+
+	// Set up task runners
+	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)
+	}
+
+	// Wait for all goroutines to finish
+	wg.Wait()
+
+	// Close channels
+	for _, runner := range runners {
+		close(runner)
+	}
+}

config/config.go

@@ -25,6 +25,11 @@ type Configuration struct {
 	Template struct {
 		BaseName string `json:"BaseTemplateName"`
 	}
+
+	Upload struct {
+		BaseName string `json:"UploadDirectoryName"`
+		MaxSize  int64  `json:"MaxUploadSize"`
+	}
 }
 
 // LoadConfig loads and returns a configuration struct

controllers/getController.go

@@ -61,6 +61,13 @@ func (getController *GetController) ShowLogin(w http.ResponseWriter, r *http.Req
 	templating.RenderTemplate(getController.App, w, "templates/pages/login.html", data)
 }
 
+func (getController *GetController) ShowFile(w http.ResponseWriter, r *http.Request) {
+	// GET /uploads?name=file.jpg
+	// will serve file.jpg
+	name := r.URL.Query().Get("name")
+	http.ServeFile(w, r, getController.App.Config.Upload.BaseName+name)
+}
+
 func (getController *GetController) Logout(w http.ResponseWriter, r *http.Request) {
 	models.LogoutUser(getController.App, w, r)
 	http.Redirect(w, r, "/", http.StatusFound)

controllers/postController.go

@@ -4,8 +4,11 @@ import (
 	"GoWeb/app"
 	"GoWeb/models"
 	"GoWeb/security"
+	"io"
 	"log"
+	"mime/multipart"
 	"net/http"
+	"os"
 	"time"
 )
 
@@ -24,13 +27,14 @@ func (postController *PostController) Login(w http.ResponseWriter, r *http.Reque
 
 	username := r.FormValue("username")
 	password := r.FormValue("password")
+	remember := r.FormValue("remember") == "on"
 
 	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)
+	_, err = models.AuthenticateUser(postController.App, w, username, password, remember)
 	if err != nil {
 		log.Println("Error authenticating user")
 		log.Println(err)
@@ -68,3 +72,60 @@ func (postController *PostController) Register(w http.ResponseWriter, r *http.Re
 
 	http.Redirect(w, r, "/login", http.StatusFound)
 }
+
+func (postController *PostController) FileUpload(w http.ResponseWriter, r *http.Request) {
+	max := postController.App.Config.Upload.MaxSize
+	err := r.ParseMultipartForm(max)
+	if err != nil {
+		return
+	}
+
+	// FormFile returns the first file for the given key `file`
+	// it also returns the FileHeader, so we can get the Filename,
+	// the Header and the size of the file
+	file, handler, err := r.FormFile("file")
+	if err != nil {
+		log.Println("Error Retrieving the File")
+		log.Println(err)
+		return
+	}
+	defer func(file multipart.File) {
+		err := file.Close()
+		if err != nil {
+			log.Println(err)
+		}
+	}(file)
+
+	if handler.Size > max {
+		log.Println("User tried uploading a file which is too large.")
+		http.Redirect(w, r, "/", http.StatusRequestHeaderFieldsTooLarge)
+		return
+	}
+
+	// Create a temporary file within upload directory
+	tempFile, err := os.Create(postController.App.Config.Upload.BaseName + handler.Filename)
+	if err != nil {
+		log.Println(err)
+		http.Redirect(w, r, "/", http.StatusNotAcceptable)
+	}
+	defer func(tempFile *os.File) {
+		err := tempFile.Close()
+		if err != nil {
+			log.Println(err)
+		}
+	}(tempFile)
+
+	// read all the contents of our uploaded file into a
+	// byte array
+	fileBytes, err := io.ReadAll(file)
+	if err != nil {
+		log.Println(err)
+	}
+
+	_, err = tempFile.Write(fileBytes)
+	if err != nil {
+		log.Println(err)
+	}
+
+	http.Redirect(w, r, "/", http.StatusFound)
+}

env_example.json

@@ -13,5 +13,9 @@
   },
   "Template": {
     "BaseTemplateName": "templates/base.html"
+  },
+  "Upload": {
+      "UploadDirectoryName": "goweb-uploads/",
+      "MaxUploadSize": 10485760
   }
-}
+}

go.mod

@@ -3,6 +3,6 @@ module GoWeb
 go 1.20
 
 require (
-	github.com/lib/pq v1.10.7
-	golang.org/x/crypto v0.7.0
+	github.com/lib/pq v1.10.9
+	golang.org/x/crypto v0.8.0
 )

go.sum

@@ -1,4 +1,4 @@
-github.com/lib/pq v1.10.7 h1:p7ZhMD+KsSRozJr34udlUrhboJwWAgCg34+/ZZNvZZw=
-github.com/lib/pq v1.10.7/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
-golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
-golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
+github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
+github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+golang.org/x/crypto v0.8.0 h1:pd9TJtTueMTVQXzk8E2XESSMQDj/U7OUu0PqJqPXQjQ=
+golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE=

main.go

@@ -8,6 +8,7 @@ import (
 	"GoWeb/routes"
 	"context"
 	"embed"
+	"errors"
 	"log"
 	"net/http"
 	"os"
@@ -43,6 +44,14 @@ func main() {
 	file, err := os.OpenFile("logs/"+time.Now().Format("2006-01-02")+".log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
 	log.SetOutput(file)
 
+	// Create upload directory if it doesn't exist
+	uploadPath := appLoaded.Config.Upload.BaseName
+	if _, err := os.Stat(uploadPath); errors.Is(err, os.ErrNotExist) {
+		if err := os.MkdirAll(uploadPath, os.ModePerm); err != nil {
+			log.Fatal(err)
+		}
+	}
+
 	// Connect to database and run migrations
 	appLoaded.Db = database.ConnectDB(&appLoaded)
 	if appLoaded.Config.Db.AutoMigrate {
@@ -53,6 +62,12 @@ func main() {
 		}
 	}
 
+	// 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.PostRoutes(&appLoaded)
@@ -70,6 +85,9 @@ func main() {
 	// 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...")
 

models/migrations.go

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

models/session.go

@@ -10,28 +10,32 @@ import (
 )
 
 type Session struct {
-	Id        int64
-	UserId    int64
-	AuthToken string
-	CreatedAt time.Time
+	Id         int64
+	UserId     int64
+	AuthToken  string
+	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"
-	selectAuthTokenIfExists  = "SELECT EXISTS(SELECT 1 FROM " + sessionTable + " WHERE \"AuthToken\" = $1)"
-	insertSession            = "INSERT INTO " + sessionTable + " (" + sessionColumnsNoId + ") VALUES ($1, $2, $3) RETURNING \"Id\""
-	deleteSessionByAuthToken = "DELETE FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
+	selectSessionByAuthToken      = "SELECT " + sessionColumns + " FROM " + sessionTable + " WHERE \"AuthToken\" = $1"
+	selectAuthTokenIfExists       = "SELECT EXISTS(SELECT 1 FROM " + sessionTable + " WHERE \"AuthToken\" = $1)"
+	insertSession                 = "INSERT INTO " + sessionTable + " (" + sessionColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
+	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
@@ -46,11 +50,11 @@ func CreateSession(app *app.App, w http.ResponseWriter, userId int64) (Session,
 	// If duplicate token found, recursively call function until unique token is generated
 	if existingAuthToken == true {
 		log.Println("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.CreatedAt).Scan(&session.Id)
+	err = app.Db.QueryRow(insertSession, session.UserId, session.AuthToken, session.RememberMe, session.CreatedAt).Scan(&session.Id)
 	if err != nil {
 		log.Println("Error inserting session into database")
 		return Session{}, err
@@ -60,6 +64,18 @@ func CreateSession(app *app.App, w http.ResponseWriter, userId int64) (Session,
 	return session, nil
 }
 
+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 {
+		log.Println("Error getting session by auth token")
+		return Session{}, err
+	}
+
+	return session, nil
+}
+
 // Generates a random 64-byte string
 func generateAuthToken(app *app.App) string {
 	// Generate random bytes
@@ -75,13 +91,25 @@ func generateAuthToken(app *app.App) string {
 
 // createSessionCookie creates a new session cookie
 func createSessionCookie(app *app.App, w http.ResponseWriter, session Session) {
-	cookie := &http.Cookie{
-		Name:     "session",
-		Value:    session.AuthToken,
-		Path:     "/",
-		MaxAge:   86400,
-		HttpOnly: true,
-		Secure:   true,
+	cookie := &http.Cookie{}
+	if session.RememberMe {
+		cookie = &http.Cookie{
+			Name:     "session",
+			Value:    session.AuthToken,
+			Path:     "/",
+			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)
@@ -112,3 +140,22 @@ 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 {
+		log.Println("Error deleting 30 day expired sessions from database")
+		log.Println(err)
+	}
+
+	// Delete sessions older than 6 hours
+	_, err = app.Db.Exec(deleteSessionsOlderThan6Hours)
+	if err != nil {
+		log.Println("Error deleting 6 hour expired sessions from database")
+		log.Println(err)
+	}
+
+	log.Println("Deleted expired sessions from database")
+}

models/user.go

@@ -23,10 +23,9 @@ 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"
-	selectUserByUsername       = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Username\" = $1"
-	insertUser                 = "INSERT INTO " + userTable + " (" + userColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
+	selectUserById       = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Id\" = $1"
+	selectUserByUsername = "SELECT " + userColumns + " FROM " + userTable + " WHERE \"Username\" = $1"
+	insertUser           = "INSERT INTO " + userTable + " (" + userColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
 )
 
 // GetCurrentUser finds the currently logged-in user by session cookie
@@ -37,16 +36,13 @@ func GetCurrentUser(app *app.App, r *http.Request) (User, error) {
 		return User{}, err
 	}
 
-	var userId int64
-
-	// Query row by AuthToken
-	err = app.Db.QueryRow(selectSessionIdByAuthToken, cookie.Value).Scan(&userId)
+	session, err := GetSessionByAuthToken(app, cookie.Value)
 	if err != nil {
-		log.Println("Error querying session row with session: " + cookie.Value)
+		log.Println("Error getting session by auth token")
 		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
@@ -98,7 +94,7 @@ 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
@@ -114,7 +110,7 @@ func AuthenticateUser(app *app.App, w http.ResponseWriter, username string, pass
 		log.Println("Authentication error (incorrect password) for user:" + username)
 		return Session{}, err
 	} else {
-		return CreateSession(app, w, user.Id)
+		return CreateSession(app, w, user.Id, remember)
 	}
 }
 
@@ -133,14 +129,4 @@ func LogoutUser(app *app.App, w http.ResponseWriter, r *http.Request) {
 		log.Println("Error deleting session by AuthToken")
 		return
 	}
-
-	// Delete cookie
-	cookie = &http.Cookie{
-		Name:   "session",
-		Value:  "",
-		Path:   "/",
-		MaxAge: -1,
-	}
-
-	http.SetCookie(w, cookie)
 }

routes/getRoutes.go

@@ -30,4 +30,7 @@ func GetRoutes(app *app.App) {
 	http.HandleFunc("/login", getController.ShowLogin)
 	http.HandleFunc("/register", getController.ShowRegister)
 	http.HandleFunc("/logout", getController.Logout)
+
+	// Files
+	http.HandleFunc("/uploads", getController.ShowFile)
 }

routes/postRoutes.go

@@ -16,4 +16,5 @@ func PostRoutes(app *app.App) {
 	// User authentication
 	http.HandleFunc("/register-handle", postController.Register)
 	http.HandleFunc("/login-handle", postController.Login)
+	http.HandleFunc("/upload-handle", postController.FileUpload)
 }

templates/pages/home.html

@@ -1,5 +1,25 @@
 {{ define "pageTitle" }}Home{{ end }}
 
+{{ define "file-upload" }}
+<form
+	enctype="multipart/form-data"
+	action="/upload-handle"
+	method="post"
+	>
+	<input type="file" accept="*/*" name="file" />
+	<input type="submit" value="upload" />
+</form>
+{{ end }}
+
 {{ define "content" }}
 {{ .Test }}
-{{ end }}
+
+<!-- Uncomment below to demo file upload system -->
+
+<!-- {{ template "file-upload" . }} -->
+<!-- <p>Upload an image called test.jpg to test the file upload system</p> -->
+<!-- <img src="/uploads?name=test.jpg" alt=""> -->
+{{ end }}
+
+{{ define "content" }}
+{{ end }}

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>