max/GoWeb
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 7 Wiki Activity

Begin refactoring structure

Browse Source
This commit is contained in:
Maximilian 2024-07-01 21:19:48 -05:00
parent 86ff949eae
commit ce85d6b77b
23 changed files with 55 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
controllers/get.go → app/controllers/get.go
View File

@ -2,7 +2,7 @@ package controllers
import (
"GoWeb/app"
"GoWeb/models"
"GoWeb/app/models"
"GoWeb/security"
"GoWeb/templating"
"net/http"
@ -10,7 +10,7 @@ import (
// Get is a wrapper struct for the App struct
type Get struct {
App *app.App
App *app.Deps
}
func (g *Get) ShowHome(w http.ResponseWriter, _ *http.Request) {

4
controllers/post.go → app/controllers/post.go
View File

@ -2,7 +2,7 @@ package controllers
import (
"GoWeb/app"
"GoWeb/models"
"GoWeb/app/models"
"log/slog"
"net/http"
"time"
@ -10,7 +10,7 @@ import (
// Post is a wrapper struct for the App struct
type Post struct {
App *app.App
App *app.Deps
}
func (p *Post) Login(w http.ResponseWriter, r *http.Request) {

0
static/css/style.css → app/frontend/static/css/style.css
View File

2
templates/base.html → app/frontend/templates/base.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<title>SiteName - {{ template "pageTitle" }}</title>
<link href="/static/css/style.css" rel="stylesheet">
<link href="/app/frontend/staticyle.css" rel="stylesheet">
</head>
<body>
{{ template "content" . }}

0
templates/pages/home.html → app/frontend/templates/pages/home.html
View File

0
templates/pages/login.html → app/frontend/templates/pages/login.html
View File

0
templates/pages/register.html → app/frontend/templates/pages/register.html
View File

4
app/app.go → app/globals.go
View File

@ -6,8 +6,8 @@ import (
"embed"
)
// App contains and supplies available configurations and connections
type App struct {
// Deps contains and supplies available configurations and connections
type Deps struct {
Config config.Configuration // Configuration file
Db *sql.DB // Database connection
Res *embed.FS // Resources from the embedded filesystem

0
middleware/csrf.go → app/middleware/csrf.go
View File

2
middleware/wrapper.go → app/middleware/wrapper.go
View File

@ -2,6 +2,8 @@ package middleware
import "net/http"
type MiddlewareFunc func(f func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request)
// 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

2
models/migrations.go → app/models/migrations.go
View File

@ -7,7 +7,7 @@ import (
)
// RunAllMigrations defines the structs that should be represented in the database
func RunAllMigrations(app *app.App) error {
func RunAllMigrations(app *app.Deps) error {
// Declare new dummy user for reflection
user := User{
Id: 1, // Id is handled automatically, but it is added here to show it will be skipped during column creation

14
models/session.go → app/models/session.go
View File

@ -31,7 +31,7 @@ const (
)
// CreateSession creates a new session for a user
func CreateSession(app *app.App, w http.ResponseWriter, userId int64, remember bool) (Session, error) {
func CreateSession(app *app.Deps, w http.ResponseWriter, userId int64, remember bool) (Session, error) {
session := Session{}
session.UserId = userId
session.AuthToken = generateAuthToken(app)
@ -62,7 +62,7 @@ func CreateSession(app *app.App, w http.ResponseWriter, userId int64, remember b
return session, nil
}
func SessionByAuthToken(app *app.App, authToken string) (Session, error) {
func SessionByAuthToken(app *app.Deps, authToken string) (Session, error) {
session := Session{}
err := app.Db.QueryRow(selectSessionByAuthToken, authToken).Scan(&session.Id, &session.UserId, &session.AuthToken, &session.RememberMe, &session.CreatedAt)
@ -74,7 +74,7 @@ func SessionByAuthToken(app *app.App, authToken string) (Session, error) {
}
// generateAuthToken generates a random 64-byte string
func generateAuthToken(app *app.App) string {
func generateAuthToken(app *app.Deps) string {
b := make([]byte, 64)
_, err := rand.Read(b)
if err != nil {
@ -85,7 +85,7 @@ func generateAuthToken(app *app.App) string {
}
// createSessionCookie creates a new session cookie
func createSessionCookie(app *app.App, w http.ResponseWriter, session Session) {
func createSessionCookie(app *app.Deps, w http.ResponseWriter, session Session) {
cookie := &http.Cookie{}
if session.RememberMe {
cookie = &http.Cookie{
@ -111,7 +111,7 @@ func createSessionCookie(app *app.App, w http.ResponseWriter, session Session) {
}
// deleteSessionCookie deletes the session cookie
func deleteSessionCookie(app *app.App, w http.ResponseWriter) {
func deleteSessionCookie(app *app.Deps, w http.ResponseWriter) {
cookie := &http.Cookie{
Name: "session",
Value: "",
@ -123,7 +123,7 @@ 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 {
func DeleteSessionByAuthToken(app *app.Deps, w http.ResponseWriter, authToken string) error {
_, err := app.Db.Exec(deleteSessionByAuthToken, authToken)
if err != nil {
slog.Error("error deleting session from database")
@ -136,7 +136,7 @@ func DeleteSessionByAuthToken(app *app.App, w http.ResponseWriter, authToken str
}
// ScheduledSessionCleanup deletes expired sessions from the database
func ScheduledSessionCleanup(app *app.App) {
func ScheduledSessionCleanup(app *app.Deps) {
// Delete sessions older than 30 days (remember me sessions)
_, err := app.Db.Exec(deleteSessionsOlderThan30Days)
if err != nil {

12
models/user.go → app/models/user.go
View File

@ -30,7 +30,7 @@ const (
)
// CurrentUser finds the currently logged-in user by session cookie
func CurrentUser(app *app.App, r *http.Request) (User, error) {
func CurrentUser(app *app.Deps, r *http.Request) (User, error) {
cookie, err := r.Cookie("session")
if err != nil {
return User{}, err
@ -45,7 +45,7 @@ func CurrentUser(app *app.App, r *http.Request) (User, error) {
}
// UserById finds a User table row in the database by id and returns a struct representing this row
func UserById(app *app.App, id int64) (User, error) {
func UserById(app *app.Deps, id int64) (User, error) {
user := User{}
err := app.Db.QueryRow(selectUserById, id).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
@ -57,7 +57,7 @@ func UserById(app *app.App, id int64) (User, error) {
}
// UserByUsername finds a User table row in the database by username and returns a struct representing this row
func UserByUsername(app *app.App, username string) (User, error) {
func UserByUsername(app *app.Deps, username string) (User, error) {
user := User{}
err := app.Db.QueryRow(selectUserByUsername, username).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
@ -69,7 +69,7 @@ func UserByUsername(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) {
func CreateUser(app *app.Deps, username string, password string, createdAt time.Time, updatedAt time.Time) (User, error) {
// Get sha256 hash of password then get bcrypt hash to store
hash256 := sha256.New()
hash256.Write([]byte(password))
@ -93,7 +93,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, remember bool) (Session, error) {
func AuthenticateUser(app *app.Deps, w http.ResponseWriter, username string, password string, remember bool) (Session, error) {
var user User
err := app.Db.QueryRow(selectUserByUsername, username).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
@ -117,7 +117,7 @@ func AuthenticateUser(app *app.App, w http.ResponseWriter, username string, pass
}
// LogoutUser deletes the session cookie and AuthToken from the database
func LogoutUser(app *app.App, w http.ResponseWriter, r *http.Request) {
func LogoutUser(app *app.Deps, w http.ResponseWriter, r *http.Request) {
cookie, err := r.Cookie("session")
if err != nil {
return

4
routes/get.go → app/routes/get.go
View File

@ -2,14 +2,14 @@ package routes
import (
"GoWeb/app"
"GoWeb/controllers"
"GoWeb/app/controllers"
"io/fs"
"log/slog"
"net/http"
)
// Get defines all project get routes
func Get(app *app.App) {
func Get(app *app.Deps) {
// Get controller struct initialize
getController := controllers.Get{
App: app,

6
routes/post.go → app/routes/post.go
View File

@ -2,13 +2,13 @@ package routes
import (
"GoWeb/app"
"GoWeb/controllers"
"GoWeb/middleware"
"GoWeb/app/controllers"
"GoWeb/app/middleware"
"net/http"
)
// Post defines all project post routes
func Post(app *app.App) {
func Post(app *app.Deps) {
// Post controller struct initialize
postController := controllers.Post{
App: app,

22
app/schedule.go → app/scheduler.go
View File

@ -6,22 +6,22 @@ import (
)
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)
EveryReboot []func(app *Deps)
EverySecond []func(app *Deps)
EveryMinute []func(app *Deps)
EveryHour []func(app *Deps)
EveryDay []func(app *Deps)
EveryWeek []func(app *Deps)
EveryMonth []func(app *Deps)
EveryYear []func(app *Deps)
}
type Task struct {
Funcs []func(app *App)
Funcs []func(app *Deps)
Interval time.Duration
}
func RunScheduledTasks(app *App, poolSize int, stop <-chan struct{}) {
func RunScheduledTasks(app *Deps, poolSize int, stop <-chan struct{}) {
for _, f := range app.ScheduledTasks.EveryReboot {
f(app)
}
@ -51,7 +51,7 @@ func RunScheduledTasks(app *App, poolSize int, stop <-chan struct{}) {
case <-ticker.C:
for _, f := range task.Funcs {
runner <- true
go func(f func(app *App)) {
go func(f func(app *Deps)) {
defer func() { <-runner }()
f(app)
}(f)

2
database/connection.go
View File

@ -9,7 +9,7 @@ import (
)
// Connect returns a new database connection
func Connect(app *app.App) *sql.DB {
func Connect(app *app.Deps) *sql.DB {
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)

6
database/migrate.go
View File

@ -11,7 +11,7 @@ import (
// Migrate given a dummy object of any type, it will create a table with the same name
// as the type and create columns with the same name as the fields of the object
func Migrate(app *app.App, anyStruct interface{}) error {
func Migrate(app *app.Deps, anyStruct interface{}) error {
valueOfStruct := reflect.ValueOf(anyStruct)
typeOfStruct := valueOfStruct.Type()
@ -41,7 +41,7 @@ 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 {
func createTable(app *app.Deps, tableName string) error {
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 {
@ -67,7 +67,7 @@ func createTable(app *app.App, tableName string) error {
}
// 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 {
func createColumn(app *app.Deps, tableName, columnName, columnType string) error {
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 {

4
env_example.json
View File

@ -12,7 +12,7 @@
"HttpPort": "8090"
},
"Template": {
"BaseTemplateName": "templates/base.html",
"ContentPath": "templates"
"BaseTemplateName": "app/frontend/templates/base.html",
"ContentPath": "app/frontend/templates"
}
}

14
main.go
View File

@ -2,10 +2,10 @@ package main
import (
"GoWeb/app"
"GoWeb/app/models"
"GoWeb/app/routes"
"GoWeb/config"
"GoWeb/database"
"GoWeb/models"
"GoWeb/routes"
"GoWeb/templating"
"context"
"embed"
@ -18,12 +18,12 @@ import (
"time"
)
//go:embed templates static
//go:embed app/frontend/templates app/frontend/static
var res embed.FS
func main() {
// Create instance of App
appLoaded := app.App{}
// Create instance of Deps
appLoaded := app.Deps{}
// Load config file to application
appLoaded.Config = config.LoadConfig()
@ -60,8 +60,8 @@ 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},
EveryReboot: []func(app *app.Deps){models.ScheduledSessionCleanup},
EveryMinute: []func(app *app.Deps){models.ScheduledSessionCleanup},
}
// Define Routes

5
middleware/groups.go
View File

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

2
restclient/client.go → rest/client.go
View File

@ -1,4 +1,4 @@
package restclient
package rest
import (
"bytes"

4
templating/templateHelper.go → templating/builder.go
View File

@ -9,9 +9,9 @@ import (
"net/http"
)
var templates = make(map[string]*template.Template) // This is only used here, does not need to be in app.App
var templates = make(map[string]*template.Template) // This is only used here, does not need to be in app.Deps
func BuildPages(app *app.App) error {
func BuildPages(app *app.Deps) error {
basePath := app.Config.Template.BaseName
baseContent, err := app.Res.ReadFile(basePath)