13 Commits

Author SHA1 Message Date
Adrian Zürcher
510d2df6b1 lift go mod versions 2025-10-31 08:13:48 +01:00
Adrian Zürcher
4670c93eff fix missing gin context (fixes #1) 2025-10-26 21:05:55 +01:00
Adrian Zürcher
8d8a1e3c33 change to api only handler and remove unused files, bring more structure 2025-10-26 10:38:44 +01:00
Adrian Zürcher
b6988638c0 fix minor bugs in role api 2025-10-24 17:35:32 +02:00
Adrian Zürcher
1b7218e5de change dlete role api from id to key 'role' 2025-10-24 17:10:28 +02:00
Adrian Zürcher
8285cf0384 add middleware for api 2025-10-24 16:29:37 +02:00
Adrian Zürcher
14994edcad add login for api handler 2025-10-24 16:22:17 +02:00
Adrian Zürcher
ab85632410 fix wrong handler namr 2025-10-24 16:10:19 +02:00
Adrian Zürcher
090cf0c1cc add api handler 2025-10-24 16:09:01 +02:00
Adrian Zürcher
a797700685 change db to fixed name and path is definable 2025-10-24 11:01:52 +02:00
Adrian Zürcher
d7890f747b change repo name 2025-10-24 10:51:25 +02:00
Adrian Zürcher
e469b61bb2 move handlers to root folder 2025-10-24 10:43:59 +02:00
Adrian Zürcher
42c4f1d915 move handlers to root folder 2025-10-24 10:42:31 +02:00
16 changed files with 470 additions and 731 deletions

3
.gitignore vendored
View File

@@ -1 +1,2 @@
*.log *.log
*.db

View File

@@ -21,13 +21,12 @@ It provides ready-to-use user authentication (login, refresh, logout, user info)
``` ```
AccessHandler/ AccessHandler/
├── handlers/ ├── access_handler.go # AccessHandler initialization
│ ├── access_handler.go # AccessHandler initialization ├── db_handler.go # Database handler using GORM
│ ├── db_handler.go # Database handler using GORM ├── login.go # Login, Refresh, Me, Logout handlers
│ ├── login.go # Login, Refresh, Me, Logout handlers ├── middleware.go # middleware authentification
│ ├── middleware.go # middleware authentification ├── role.go # database handling for roles
| ├── role.go # database handling for roles ├── user.go # database users for roles
| ├── user.go # database users for roles
| |
├── models/ ├── models/
│ ├── jsonResponse.go # Json responses model │ ├── jsonResponse.go # Json responses model
@@ -79,7 +78,7 @@ go get https://gitea.tecamino.com/paadi/tecamino-logger/logging
## 🔑 Authentication Constants ## 🔑 Authentication Constants
In `handlers/login.go`: In `login.go`:
```go ```go
// ----------------------------- // -----------------------------
@@ -119,7 +118,6 @@ var REFRESH_SECRET = []byte("*")
package main package main
import ( import (
"AccessHandler/handlers"
"gitea.tecamino.com/paadi/tecamino-logger/logging" "gitea.tecamino.com/paadi/tecamino-logger/logging"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"log" "log"
@@ -127,7 +125,7 @@ import (
func main() { func main() {
logger, _ := logging.NewLogger("server.log", nil) logger, _ := logging.NewLogger("server.log", nil)
accessHandler, err := handlers.NewAccessHandler("access.db", logger) accessHandler, err := NewAccessHandler("access.db", logger)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }

10
accessHandler.go Normal file
View File

@@ -0,0 +1,10 @@
package AccessHandler
import (
"gitea.tecamino.com/paadi/access-handler/handlers"
"gitea.tecamino.com/paadi/tecamino-logger/logging"
)
func NewAccessHandler(path string, logger *logging.Logger) (aH *handlers.AccessHandler, err error) {
return handlers.NewAccessHandler(path, logger)
}

View File

@@ -1,61 +1,118 @@
package accessmanager_test package AccessHandler
import ( import (
"bytes" "bytes"
"encoding/json" "encoding/json"
"io"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"os"
"testing" "testing"
"gitea.tecamino.com/paadi/AccessHandler/handlers" "gitea.tecamino.com/paadi/access-handler/models"
"gitea.tecamino.com/paadi/AccessHandler/models"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/go-playground/assert/v2" "github.com/go-playground/assert/v2"
) )
func TestAccesshandlerLogin(t *testing.T) { func TestDatabase(t *testing.T) {
dbName := "user.db"
if _, err := os.Stat(dbName); err == nil {
t.Log("remove user.db to start test with empty database")
if err := os.Remove(dbName); err != nil {
t.Fatal(err)
}
}
t.Log("start access handler test") t.Log("start access handler test")
t.Log("initialize accessHandler") t.Log("initialize accessHandler")
accessHandler, err := handlers.NewAccessHandler("test.db", nil) accessHandler, err := NewAccessHandler(".", nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
t.Log("add another user") r := gin.Default()
err = accessHandler.AddNewUser("guest", "guest@gmail.com", "passwordd1", "admin")
if err != nil { accessHandler.SetMiddlewareLogger(r)
t.Log(err)
r.POST("/users/add", accessHandler.AddUser)
r.GET("/users", accessHandler.GetUser)
r.GET("/roles", accessHandler.GetRole)
r.POST("/roles/add", accessHandler.AddRole)
type request struct {
Log string
Name string
Method string
Path string
Payload any
Cookie *http.Cookie
ignoreError bool
}
var requests []request
requests = append(requests,
request{Log: "add another user", Name: "add user", Method: "POST", Path: "/users/add", Payload: models.User{
Name: "guest",
Password: "passwordd1",
Role: "admin",
Email: "guest@gmail.com",
}, ignoreError: true},
request{Log: "Get all users", Name: "get all users", Method: "GET", Path: "/users"},
request{Log: "Get user id 1", Name: "get user id 1", Method: "GET", Path: "/users?id=1"},
request{Log: "Add new role", Name: "add new role", Method: "POST", Path: "/roles/add", Payload: models.Role{
Role: "testRole",
}, ignoreError: true},
request{Log: "Get all roles", Name: "get all roles", Method: "GET", Path: "/roles"},
request{Log: "Get all role id 1", Name: "get role id 1", Method: "GET", Path: "/roles?id=1"},
)
for _, request := range requests {
if request.Log != "" {
t.Log(request.Log)
}
var bodyReader io.Reader
if request.Payload != nil {
jsonBytes, _ := json.Marshal(request.Payload)
bodyReader = bytes.NewBuffer(jsonBytes)
}
req, _ := http.NewRequest(request.Method, request.Path, bodyReader)
if request.Cookie != nil {
req.AddCookie(request.Cookie) // attach refresh_token cookie
}
w := httptest.NewRecorder()
r.ServeHTTP(w, req)
t.Log(request.Name+" response:", w.Body.String())
if !request.ignoreError {
assert.Equal(t, http.StatusOK, w.Code)
}
} }
t.Log("get user id 1") // t.Log("get user id 1")
result, err := accessHandler.GetUserByKey("user_name", "admin", false) // result, err := accessHandler.GetUserByKey("user_name", "admin", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get all users") // t.Log("get user by key")
result, err = accessHandler.GetUserById(0) // result, err = accessHandler.GetUserByKey("password", "passwordd", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get user by key") // t.Log("get user by key and like")
result, err = accessHandler.GetUserByKey("password", "passwordd", false) // result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("get user by key and like")
result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil {
t.Fatal(err)
}
t.Log(result)
// var user_name string = "admin1" // var user_name string = "admin1"
// if len(result) > 0 { // if len(result) > 0 {
@@ -69,51 +126,51 @@ func TestAccesshandlerLogin(t *testing.T) {
// Name: user_name, // Name: user_name,
// }, "user_name", result[0].Name) // }, "user_name", result[0].Name)
// } // }
t.Log("read user again") // t.Log("read user again")
result, err = accessHandler.GetUserByKey("user_name", "a*", true) // result, err = accessHandler.GetUserByKey("user_name", "a*", true)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
// t.Log("delete user id 1") // t.Log("delete user id 1")
// err = accessHandler.DeleteUserByKey("user_name", user_name, false) // err = accessHandler.DeleteUserByKey("user_name", user_name, false)
// if err != nil { // if err != nil {
// t.Fatal(err) // t.Fatal(err)
// } // }
t.Log("read user again") // t.Log("read user again")
result, err = accessHandler.GetUserById(0) // result, err = accessHandler.GetUserById(0)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result) // t.Log(result)
t.Log("read admin permissions") // t.Log("read admin permissions")
result1, err := accessHandler.GetRoleByKey("role", "admin", false) // result1, err := accessHandler.GetRoleByKey("role", "admin", false)
if err != nil { // if err != nil {
t.Fatal(err) // t.Fatal(err)
} // }
t.Log(result1) // t.Log(result1)
} }
func TestLoginHandler(t *testing.T) { func TestLoginAndAuthorization(t *testing.T) {
gin.SetMode(gin.TestMode) gin.SetMode(gin.TestMode)
// Setup your AccessHandler and router // Setup your AccessHandler and router
aH, err := handlers.NewAccessHandler("test.db", nil) aH, err := NewAccessHandler(".", nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
r := gin.Default() r := gin.Default()
handlers.SetMiddlewareLogger(r, aH.GetLogger()) aH.SetMiddlewareLogger(r)
r.POST("/login", aH.Login) r.POST("/login", aH.Login)
r.POST("/login/refresh", aH.Refresh) r.POST("/login/refresh", aH.Refresh)
r.GET("/login/me", aH.Me) r.GET("/login/me", aH.Me)
r.GET("/logout", aH.Logout) r.GET("/logout", aH.Logout)
middleware := r.Group("", handlers.AuthMiddleware()) middleware := r.Group("", aH.AuthMiddleware())
auth := middleware.Group("/members", aH.AuthorizeRole("")) auth := middleware.Group("/members", aH.AuthorizeRole(""))
auth.GET("", func(ctx *gin.Context) { auth.GET("", func(ctx *gin.Context) {

7
go.mod
View File

@@ -1,15 +1,14 @@
module gitea.tecamino.com/paadi/AccessHandler module gitea.tecamino.com/paadi/access-handler
go 1.24.5 go 1.24.5
require ( require (
gitea.tecamino.com/paadi/dbHandler v1.0.4
gitea.tecamino.com/paadi/tecamino-logger v0.2.1 gitea.tecamino.com/paadi/tecamino-logger v0.2.1
github.com/gin-gonic/gin v1.11.0 github.com/gin-gonic/gin v1.11.0
github.com/glebarez/sqlite v1.11.0
github.com/go-playground/assert/v2 v2.2.0 github.com/go-playground/assert/v2 v2.2.0
github.com/golang-jwt/jwt/v5 v5.3.0 github.com/golang-jwt/jwt/v5 v5.3.0
golang.org/x/crypto v0.43.0 golang.org/x/crypto v0.43.0
gorm.io/gorm v1.31.0
) )
require ( require (
@@ -20,6 +19,7 @@ require (
github.com/gabriel-vasile/mimetype v1.4.8 // indirect github.com/gabriel-vasile/mimetype v1.4.8 // indirect
github.com/gin-contrib/sse v1.1.0 // indirect github.com/gin-contrib/sse v1.1.0 // indirect
github.com/glebarez/go-sqlite v1.21.2 // indirect github.com/glebarez/go-sqlite v1.21.2 // indirect
github.com/glebarez/sqlite v1.11.0 // indirect
github.com/go-playground/locales v0.14.1 // indirect github.com/go-playground/locales v0.14.1 // indirect
github.com/go-playground/universal-translator v0.18.1 // indirect github.com/go-playground/universal-translator v0.18.1 // indirect
github.com/go-playground/validator/v10 v10.27.0 // indirect github.com/go-playground/validator/v10 v10.27.0 // indirect
@@ -52,6 +52,7 @@ require (
golang.org/x/tools v0.37.0 // indirect golang.org/x/tools v0.37.0 // indirect
google.golang.org/protobuf v1.36.9 // indirect google.golang.org/protobuf v1.36.9 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gorm.io/gorm v1.31.0 // indirect
modernc.org/libc v1.22.5 // indirect modernc.org/libc v1.22.5 // indirect
modernc.org/mathutil v1.5.0 // indirect modernc.org/mathutil v1.5.0 // indirect
modernc.org/memory v1.5.0 // indirect modernc.org/memory v1.5.0 // indirect

2
go.sum
View File

@@ -1,3 +1,5 @@
gitea.tecamino.com/paadi/dbHandler v1.0.4 h1:ctnaec0GDdtw3gRQdUISVDYLJ9x+vt50VW41OemfhD4=
gitea.tecamino.com/paadi/dbHandler v1.0.4/go.mod h1:y/xn/POJg1DO++67uKvnO23lJQgh+XFQq7HZCS9Getw=
gitea.tecamino.com/paadi/tecamino-logger v0.2.1 h1:sQTBKYPdzn9mmWX2JXZBtGBvNQH7cuXIwsl4TD0aMgE= gitea.tecamino.com/paadi/tecamino-logger v0.2.1 h1:sQTBKYPdzn9mmWX2JXZBtGBvNQH7cuXIwsl4TD0aMgE=
gitea.tecamino.com/paadi/tecamino-logger v0.2.1/go.mod h1:FkzRTldUBBOd/iy2upycArDftSZ5trbsX5Ira5OzJgM= gitea.tecamino.com/paadi/tecamino-logger v0.2.1/go.mod h1:FkzRTldUBBOd/iy2upycArDftSZ5trbsX5Ira5OzJgM=
github.com/bytedance/sonic v1.14.0 h1:/OfKt8HFw0kh2rj8N0F6C/qPGRESq0BbaNZgcNXXzQQ= github.com/bytedance/sonic v1.14.0 h1:/OfKt8HFw0kh2rj8N0F6C/qPGRESq0BbaNZgcNXXzQQ=

View File

@@ -1,41 +1,43 @@
package handlers package handlers
import "gitea.tecamino.com/paadi/tecamino-logger/logging" import (
"gitea.tecamino.com/paadi/dbHandler"
"gitea.tecamino.com/paadi/tecamino-logger/logging"
)
//
// AccessHandler // AccessHandler
// //
// Description: // Description:
// AccessHandler manages access-related functionality, including
// database operations for users and roles, as well as logging.
// It encapsulates a database handler and a logger so that
// authentication and authorization operations can be performed
// consistently across the application.
// //
// AccessHandler manages access-related functionality, including
// database operations for users and roles, as well as logging.
// It encapsulates a database handler and a logger so that
// authentication and authorization operations can be performed
// consistently across the application.
type AccessHandler struct { type AccessHandler struct {
dbHandler *DBHandler // Database handler used for managing users and roles dbHandler *dbHandler.DBHandler // Database handler used for managing users and roles
logger *logging.Logger // Centralized application logger logger *logging.Logger // Centralized application logger
} }
//
// NewAccessHandler // NewAccessHandler
// //
// Description: // Description:
// Creates and initializes a new AccessHandler instance. //
// Creates and initializes a new AccessHandler instance.
// //
// Behavior: // Behavior:
// 1. If a logger is not provided (nil), it creates a new logger instance // 1. If a logger is not provided (nil), it creates a new logger instance
// that writes to "accessHandler.log". // that writes to "accessHandler.log".
// 2. Initializes the AccessHandler struct. // 2. Initializes the AccessHandler struct.
// 3. Sets up the internal DBHandler with the same logger. // 3. Sets up the internal DBAHandler with the same logger.
// 4. Automatically creates required database tables and default data: // 4. Automatically creates required database tables and default data:
// - User table // - User table
// - Default user(s) // - Default user(s)
// - Role table // - Role table
// - Default role(s) // - Default role(s)
// //
// Parameters: // Parameters:
// - dbPath: The file path or connection string for the database. // - dbPath: The file path to the database.
// - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created. // - logger: Optional pointer to a logging.Logger instance. If nil, a new one is created.
// //
// Returns: // Returns:
@@ -43,12 +45,12 @@ type AccessHandler struct {
// - err: Any error that occurs during initialization. // - err: Any error that occurs during initialization.
// //
// Example: // Example:
// handler, err := handlers.NewAccessHandler("data/app.db", appLogger)
// if err != nil {
// log.Fatal(err)
// }
// //
func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler, err error) { // handler, err := NewAccessHandler("data/app.db", appLogger)
// if err != nil {
// log.Fatal(err)
// }
func NewAccessHandler(path string, logger *logging.Logger) (aH *AccessHandler, err error) {
if logger == nil { if logger == nil {
logger, err = logging.NewLogger("accessHandler.log", nil) logger, err = logging.NewLogger("accessHandler.log", nil)
if err != nil { if err != nil {
@@ -65,7 +67,7 @@ func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler,
logger.Debug("NewAccessHandler", "initialize db handler") logger.Debug("NewAccessHandler", "initialize db handler")
// Create a new DB handler instance // Create a new DB handler instance
aH.dbHandler, err = NewDBHandler(dbPath, logger) aH.dbHandler, err = dbHandler.NewDBHandler("user", path, logger)
if err != nil { if err != nil {
aH.logger.Error("NewAccessHandler", err) aH.logger.Error("NewAccessHandler", err)
return return
@@ -105,21 +107,21 @@ func NewAccessHandler(dbPath string, logger *logging.Logger) (aH *AccessHandler,
return return
} }
//
// GetLogger // GetLogger
// //
// Description: // Description:
// Returns the logger associated with this AccessHandler instance. //
// Useful when another component or handler needs to reuse the // Returns the logger associated with this AccessHandler instance.
// same logging instance for consistent log output. // Useful when another component or handler needs to reuse the
// same logging instance for consistent log output.
// //
// Returns: // Returns:
// - *logging.Logger: The logger assigned to this AccessHandler. // - *logging.Logger: The logger assigned to this AccessHandler.
// //
// Example: // Example:
// log := accessHandler.GetLogger()
// log.Info("Some event")
// //
// log := accessHandler.GetLogger()
// log.Info("Some event")
func (aH *AccessHandler) GetLogger() *logging.Logger { func (aH *AccessHandler) GetLogger() *logging.Logger {
return aH.logger return aH.logger
} }

View File

@@ -1,300 +0,0 @@
package handlers
import (
"errors"
"fmt"
"reflect"
"strings"
"gitea.tecamino.com/paadi/tecamino-logger/logging"
"github.com/glebarez/sqlite"
"gorm.io/gorm"
)
// DBHandler
//
// Description:
//
// Wraps the GORM database connection and provides helper methods for
// common CRUD operations, as well as integrated logging for traceability.
//
// Fields:
// - db: Active GORM database connection.
// - logger: Pointer to a custom logger instance for structured logging.
type DBHandler struct {
db *gorm.DB
logger *logging.Logger
}
// NewDBHandler
//
// Description:
//
// Creates a new database handler using the specified SQLite database file.
//
// Behavior:
// 1. Opens a GORM connection to the database file at `dbPath`.
// 2. Wraps it in a `DBHandler` struct with logging support.
//
// Parameters:
// - dbPath: Path to the SQLite database file.
// - logger: Logging instance to record DB operations.
//
// Returns:
// - dH: A pointer to the initialized `DBHandler`.
// - err: Any error encountered during database connection.
func NewDBHandler(dbPath string, logger *logging.Logger) (dH *DBHandler, err error) {
dH = &DBHandler{logger: logger}
logger.Debug("NewDBHandler", "open database "+dbPath)
dH.db, err = gorm.Open(sqlite.Open(dbPath), &gorm.Config{})
return
}
// addNewTable
//
// Description:
//
// Uses GORMs `AutoMigrate` to create or update the database schema
// for the provided model type.
//
// Parameters:
// - model: Struct type representing the database table schema.
//
// Returns:
// - error: Any migration error encountered.
func (dH *DBHandler) addNewTable(model any) error {
return dH.db.AutoMigrate(&model)
}
// addNewColum
//
// Description:
//
// Inserts a new record into the database table corresponding to `model`.
//
// Parameters:
// - model: Struct instance containing values to be inserted.
//
// Returns:
// - error: Any error encountered during record creation.
func (dH *DBHandler) addNewColum(model any) error {
return dH.db.Create(model).Error
}
// getById
//
// Description:
//
// Retrieves a record (or all records) from a table by numeric ID.
//
// Behavior:
// - If `id == 0`, returns all records in the table.
// - Otherwise, fetches the record matching the given ID.
//
// Parameters:
// - model: Pointer to a slice or struct to store the result.
// - id: Numeric ID to query by.
//
// Returns:
// - error: Any query error or “not found” message.
func (dH *DBHandler) getById(model any, id uint) error {
dH.logger.Debug("getById", "find id "+fmt.Sprint(id))
if id == 0 {
return dH.db.Find(model).Error
}
err := dH.db.First(model, id).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return fmt.Errorf("no record found for id: %v", id)
} else if err != nil {
return fmt.Errorf("query failed: %w", err)
}
return nil
}
// getByKey
//
// Description:
//
// Retrieves one or more records matching a key/value pair.
//
// Behavior:
// - If `LikeSearch` is true, performs a SQL LIKE query.
// - Otherwise, performs an exact match query.
//
// Parameters:
// - model: Pointer to a slice or struct to store results.
// - key: Column name (e.g., "email").
// - value: Value to match or partially match.
// - LikeSearch: If true, replaces '*' with '%' for wildcard matching.
//
// Returns:
// - error: Any database query error.
func (dH *DBHandler) getByKey(model any, key string, value any, LikeSearch bool) error {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
dH.logger.Debug("getByKey", "find like key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" LIKE ?", value).Find(model).Error
}
dH.logger.Debug("getByKey", "find equal key "+key+" value "+fmt.Sprint(value))
return dH.db.Find(model, key+" = ?", value).Error
}
// updateValuesById
//
// Description:
//
// Updates record fields based on their unique ID.
//
// Behavior:
// 1. Confirms that `model` is a pointer to a struct.
// 2. Fetches the record by ID.
// 3. Updates all non-zero fields using `gorm.Model.Updates`.
//
// Parameters:
// - model: Pointer to struct containing new values.
// - id: Numeric ID of the record to update.
//
// Returns:
// - error: If the model is invalid or query/update fails.
func (dH *DBHandler) updateValuesById(model any, id uint) error {
dH.logger.Debug("updateValuesById", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
return errors.New("model must be a pointer to struct")
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.getById(lookUpModel, id); err != nil {
return err
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
// updateValuesByKey
//
// Description:
//
// Updates records based on a key/value match.
//
// Behavior:
// 1. Confirms model type.
// 2. Fetches the matching record(s) using `getByKey`.
// 3. Updates all non-zero fields.
//
// Parameters:
// - model: Pointer to struct containing updated values.
// - key: Column name to filter by.
// - value: Value to match.
//
// Returns:
// - error: Any query or update error.
func (dH *DBHandler) updateValuesByKey(model any, key string, value any) error {
dH.logger.Debug("updateValuesByKey", "model"+fmt.Sprint(model))
modelType := reflect.TypeOf(model)
if modelType.Kind() != reflect.Ptr {
return errors.New("model must be a pointer to struct")
}
lookUpModel := reflect.New(modelType.Elem()).Interface()
if err := dH.getByKey(lookUpModel, key, value, false); err != nil {
return err
}
return dH.db.Model(lookUpModel).Updates(model).Error
}
// deleteById
//
// Description:
//
// Deletes records by their ID(s).
//
// Behavior:
// - If the first ID == 0, all records in the table are deleted.
// - Otherwise, deletes the provided IDs.
//
// Parameters:
// - model: Model struct type representing the table.
// - id: Variadic list of IDs to delete.
//
// Returns:
// - error: Any deletion error.
func (dH *DBHandler) deleteById(model any, id ...uint) error {
if id[0] == 0 {
dH.logger.Debug("deleteById", "delete all")
return dH.db.Where("1 = 1").Delete(model).Error
}
dH.logger.Debug("deleteById", "delete ids"+fmt.Sprint(id))
if err := dH.exists(model, "id", id, false); err != nil {
return err
}
return dH.db.Delete(model, id).Error
}
// deleteByKey
//
// Description:
//
// Deletes records that match a key/value pair.
//
// Behavior:
// - Supports LIKE queries if `LikeSearch` is true.
//
// Parameters:
// - model: Model struct type representing the table.
// - key: Column name to filter by.
// - value: Value to match.
// - LikeSearch: Whether to use wildcard search.
//
// Returns:
// - error: Any deletion error.
func (dH *DBHandler) deleteByKey(model any, key string, value any, LikeSearch bool) error {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
dH.logger.Debug("deleteByKey", "delete like key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" LIKE ?", value).Delete(model).Error
}
dH.logger.Debug("deleteByKey", "delete equal key "+key+" value "+fmt.Sprint(value))
return dH.db.Where(key+" = ?", value).Delete(model).Error
}
// exists
//
// Description:
//
// Checks whether a record exists matching the specified key/value filter.
//
// Behavior:
// - Performs a `First` query on the database.
// - If `LikeSearch` is true, performs a LIKE query.
// - Returns an error if the record does not exist or query fails.
//
// Parameters:
// - model: Model struct type to search.
// - key: Column name to filter by.
// - value: Value to match.
// - LikeSearch: Whether to use wildcard search.
//
// Returns:
// - error: “no record found” or DB error.
func (dH *DBHandler) exists(model any, key string, value any, LikeSearch bool) (err error) {
if LikeSearch {
value = strings.ReplaceAll(fmt.Sprint(value), "*", "%")
key = key + " LIKE ?"
} else {
key = key + " = ?"
}
dH.logger.Debug("exists", "check if exists key "+key+" value "+fmt.Sprint(value))
err = dH.db.Where(key, value).First(model).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return fmt.Errorf("no record found for %s %v", key[:len(key)-1], value)
} else if err != nil {
return fmt.Errorf("query failed: %w", err)
}
return
}

View File

@@ -2,12 +2,11 @@ package handlers
import ( import (
"fmt" "fmt"
"log"
"net/http" "net/http"
"time" "time"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/internal/utils"
"gitea.tecamino.com/paadi/AccessHandler/utils" "gitea.tecamino.com/paadi/access-handler/models"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/golang-jwt/jwt/v5" "github.com/golang-jwt/jwt/v5"
@@ -53,7 +52,8 @@ func (aH *AccessHandler) Login(c *gin.Context) {
} }
// Fetch user record from DB // Fetch user record from DB
dbRecord, err := aH.GetUserByKey("user_name", user.Name, false) var dbRecord []models.User
err := aH.dbHandler.GetByKey(&dbRecord, "user_name", user.Name, false)
if err != nil { if err != nil {
aH.logger.Error("Login", err) aH.logger.Error("Login", err)
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err)) c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
@@ -61,7 +61,6 @@ func (aH *AccessHandler) Login(c *gin.Context) {
} }
if len(dbRecord) > 1 { if len(dbRecord) > 1 {
log.Println("multiple users found")
aH.logger.Error("Login", "more than one record found") aH.logger.Error("Login", "more than one record found")
c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("internal error")) c.JSON(http.StatusInternalServerError, models.NewJsonMessageResponse("internal error"))
return return

View File

@@ -1,11 +1,11 @@
package handlers package handlers
import ( import (
"fmt"
"log" "log"
"net/http" "net/http"
"strings" "strings"
"gitea.tecamino.com/paadi/access-handler/models"
"gitea.tecamino.com/paadi/tecamino-logger/logging" "gitea.tecamino.com/paadi/tecamino-logger/logging"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/golang-jwt/jwt/v5" "github.com/golang-jwt/jwt/v5"
@@ -27,11 +27,11 @@ import (
// //
// Usage: // Usage:
// //
// handlers.SetMiddlewareLogger(router, logger) // SetMiddlewareLogger(router, logger)
func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) { func (aH *AccessHandler) SetMiddlewareLogger(r *gin.Engine) {
// Add middleware that injects logger into context // Add middleware that injects logger into context
r.Use(func(c *gin.Context) { r.Use(func(c *gin.Context) {
c.Set("logger", logger) c.Set("logger", aH.logger)
c.Next() c.Next()
}) })
} }
@@ -55,8 +55,8 @@ func SetMiddlewareLogger(r *gin.Engine, logger *logging.Logger) {
// //
// Usage: // Usage:
// //
// r.Use(handlers.AuthMiddleware()) // r.Use(AuthMiddleware())
func AuthMiddleware() gin.HandlerFunc { func (aH *AccessHandler) AuthMiddleware() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
// Retrieve logger from Gin context // Retrieve logger from Gin context
middlewareLogger, ok := c.Get("logger") middlewareLogger, ok := c.Get("logger")
@@ -130,7 +130,8 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
} }
// Fetch roles and associated permissions from the database or store // Fetch roles and associated permissions from the database or store
roles, err := aH.GetRoleByKey("role", role, false) var roles []models.Role
err := aH.dbHandler.GetByKey(&roles, "role", role, false)
if err != nil { if err != nil {
aH.logger.Error("AuthorizeRole", err) aH.logger.Error("AuthorizeRole", err)
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"message": http.StatusInternalServerError}) c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"message": http.StatusInternalServerError})
@@ -139,8 +140,7 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
// Validate that a role was found // Validate that a role was found
if len(roles) == 0 { if len(roles) == 0 {
log.Println("not logged in") aH.logger.Error("AuthorizeRole", "not logged in")
aH.logger.Error("AuthorizeRole", "no logged in")
c.JSON(http.StatusUnauthorized, http.StatusUnauthorized) c.JSON(http.StatusUnauthorized, http.StatusUnauthorized)
return return
} else if len(roles) > 1 { } else if len(roles) > 1 {
@@ -151,7 +151,6 @@ func (aH *AccessHandler) AuthorizeRole(suffix string) gin.HandlerFunc {
// Check permissions // Check permissions
for _, permission := range roles[0].Permissions { for _, permission := range roles[0].Permissions {
fmt.Println(100, permissionPath, permission.Name)
if permission.Name == permissionPath { if permission.Name == permissionPath {
c.Next() c.Next()
return return

View File

@@ -2,50 +2,22 @@ package handlers
import ( import (
"fmt" "fmt"
"net/http"
"strconv"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/models"
"github.com/gin-gonic/gin"
) )
// AddRoleTable
//
// Description:
//
// Creates a new database table for storing role definitions if it does not already exist.
//
// Behavior:
// - Uses the DBHandler to add a table based on the `models.Role` struct.
// - Returns an error if table creation fails.
//
// Returns:
// - error: Any database error encountered.
func (aH *AccessHandler) AddRoleTable() error { func (aH *AccessHandler) AddRoleTable() error {
return aH.dbHandler.addNewTable(models.Role{}) return aH.dbHandler.AddNewTable(models.Role{})
} }
// AddDefaultRole
//
// Description:
//
// Ensures that a default administrative role exists in the database.
// If a role named "admin" is already present, it logs and skips creation.
//
// Behavior:
// 1. Checks for an existing "admin" role.
// 2. If not found, initializes default permissions using
// `models.Permissions.DefaultPermissions()`.
// 3. Creates a new role record with those permissions.
//
// Default Role:
// - Role: "admin"
// - Permissions: all default permissions defined in `models.Permissions`.
//
// Returns:
// - error: Any database or creation error encountered.
func (aH *AccessHandler) AddDefaultRole() (err error) { func (aH *AccessHandler) AddDefaultRole() (err error) {
role := "admin" role := "admin"
// Check if a role with this name already exists // Check if a role with this name already exists
if err := aH.dbHandler.exists(&models.Role{}, "role", role, false); err == nil { if err := aH.dbHandler.Exists(&models.Role{}, "role", role, false); err == nil {
// Found a role → skip creation // Found a role → skip creation
aH.logger.Debug("AddDefaultRole", "role "+role+" exists already") aH.logger.Debug("AddDefaultRole", "role "+role+" exists already")
return nil return nil
@@ -57,141 +29,142 @@ func (aH *AccessHandler) AddDefaultRole() (err error) {
permissions.DefaultPermissions() permissions.DefaultPermissions()
// Create the default admin role // Create the default admin role
aH.dbHandler.addNewColum(&models.Role{ aH.dbHandler.AddNewColum(&models.Role{
Role: role, Role: role,
Permissions: permissions, Permissions: permissions,
}) })
return return
} }
// AddNewRole func (aH *AccessHandler) AddRole(c *gin.Context) {
// var role models.Role
// Description: err := c.BindJSON(&role)
// if err != nil {
// Adds a new role with a specific set of permissions to the database. aH.logger.Error("AddRole", err)
// c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(err))
// Behavior: return
// 1. Checks whether a role with the same name already exists. }
// 2. If it does not exist, creates a new role record.
// if !role.IsValid() {
// Parameters: aH.logger.Error("AddRole", "user empty")
// - role: The role name (e.g., "manager", "viewer"). c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
// - permissions: A `models.Permissions` struct defining allowed actions. return
// }
// Returns:
// - error: If the role already exists or insertion fails.
func (aH *AccessHandler) AddNewRole(role string, permissions models.Permissions) (err error) {
// Check if a role with this name already exists // Check if a role with this name already exists
if err := aH.dbHandler.exists(&models.Role{}, "role", role, false); err == nil { if err := aH.dbHandler.Exists(&models.Role{}, "role", role.Role, false); err == nil {
// Found a role → skip creation aH.logger.Error("AddRole", fmt.Sprintf("role with name %s already exists", role.Role))
return fmt.Errorf("role with name %s already exists", role) c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse(fmt.Sprintf("role with name %s already exists", role.Role)))
} }
// Insert new role with provided permissions // Insert new role with provided permissions
aH.dbHandler.addNewColum(&models.Role{ aH.dbHandler.AddNewColum(&models.Role{
Role: role, Role: role.Role,
Permissions: permissions, Permissions: role.Permissions,
})
c.JSON(http.StatusOK, gin.H{
"message": fmt.Sprintf("role '%s' successfully added", role.Role),
}) })
return
} }
// GetRoleById func (aH *AccessHandler) GetRole(c *gin.Context) {
// var i int
// Description: var err error
// var roles []models.Role
// Retrieves a role record from the database by its numeric ID.
// role := c.Query("role")
// Parameters: id := c.Query("id")
// - id: The unique ID of the role.
// if role != "" {
// Returns: err = aH.dbHandler.GetByKey(&roles, "role", role, false)
// - roles: A slice containing the matched role (usually length 1). } else if id != "" {
// - err: Any database error encountered. i, err = strconv.Atoi(id)
func (aH *AccessHandler) GetRoleById(id uint) (roles []models.Role, err error) { if err != nil {
err = aH.dbHandler.getById(&roles, id) c.JSON(http.StatusBadRequest, gin.H{
return "message": err.Error(),
})
return
}
err = aH.dbHandler.GetById(&roles, uint(i))
} else {
err = aH.dbHandler.GetById(&roles, 0)
}
if err != nil {
aH.logger.Error("GetRole", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
c.JSON(http.StatusOK, roles)
} }
// GetRoleByKey func (aH *AccessHandler) UpdateRole(c *gin.Context) {
// var role models.Role
// Description: if err := c.BindJSON(&role); err != nil {
// aH.logger.Error("UpdateRole", err)
// Retrieves one or more roles based on a key/value query. c.JSON(http.StatusInternalServerError, nil)
// return
// Parameters: }
// - key: The column name to search by (e.g., "role"). err := aH.dbHandler.UpdateValuesById(&role, role.Id)
// - value: The value to match (e.g., "admin"). if err != nil {
// - likeSearch: Whether to use SQL LIKE for partial matches. aH.logger.Error("UpdateRole", err)
// c.JSON(http.StatusInternalServerError, nil)
// Returns: return
// - roles: A list of matched roles. }
// - err: Any database error encountered. c.JSON(http.StatusOK, models.NewJsonMessageResponse("successfully updated role '"+role.Role+"'"))
func (aH *AccessHandler) GetRoleByKey(key string, value any, likeSearch bool) (roles []models.Role, err error) {
err = aH.dbHandler.getByKey(&roles, key, value, likeSearch)
return
} }
// UpdateRoleById func (aH *AccessHandler) DeleteRole(c *gin.Context) {
// queryRole := c.Query("role")
// Description: if queryRole == "" || queryRole == "null" || queryRole == "undefined" {
// aH.logger.Error("DeleteRole", "id query missing or wrong value: "+queryRole)
// Updates a role record identified by its numeric ID. c.JSON(http.StatusInternalServerError, nil)
// return
// Parameters: }
// - id: The ID of the role to update.
// - role: A struct containing updated role data.
//
// Returns:
// - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleById(id uint, role models.Role) error {
return aH.dbHandler.updateValuesById(&role, id)
}
// UpdateRoleByKey var request struct {
// Roles []string `json:"roles"`
// Description: }
//
// Updates a role record using a column key/value lookup.
//
// Parameters:
// - role: The updated role data.
// - key: The column name to search by.
// - value: The value to match against the key column.
//
// Returns:
// - error: Any database error encountered.
func (aH *AccessHandler) UpdateRoleByKey(role models.Role, key string, value any) error {
return aH.dbHandler.updateValuesByKey(&role, key, value)
}
// DeleteRoleById err := c.BindJSON(&request)
// if err != nil {
// Description: aH.logger.Error("DeleteRole", err)
// c.JSON(http.StatusBadRequest, nil)
// Deletes a role record from the database by its numeric ID. return
// }
// Parameters:
// - id: The ID of the role to delete.
//
// Returns:
// - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteRoleById(id uint) (err error) {
return aH.dbHandler.deleteById(&models.Role{}, id)
}
// DeleteRoleByKey if len(request.Roles) == 0 {
// aH.logger.Error("DeleteRole", "no ids given to be deleted")
// Description: c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("no roles given to be deleted"))
// return
// Deletes one or more roles from the database matching a given key/value pair. }
//
// Parameters: var ownRole string
// - key: The column name used for filtering (e.g., "role").
// - value: The matching value (e.g., "admin"). for _, role := range request.Roles {
// - likeSearch: If true, performs a LIKE (partial) match. if queryRole == role {
// ownRole = role
// Returns: continue
// - error: Any database error encountered. }
func (aH *AccessHandler) DeleteRoleByKey(key string, value any, likeSearch bool) (err error) { err = aH.dbHandler.DeleteByKey(&models.Role{}, "role", role, false)
return aH.dbHandler.deleteByKey(&models.Role{}, key, value, likeSearch) if err != nil {
aH.logger.Error("DeleteRole", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
}
if ownRole != "" {
aH.logger.Error("DeleteRole", "can not delete logged in role id: "+ownRole)
c.JSON(http.StatusBadRequest, gin.H{
"message": "can not delete logged in role id: " + ownRole,
"role": ownRole,
})
return
}
c.JSON(http.StatusOK, gin.H{
"message": "role(s) deleted",
})
} }

View File

@@ -1,55 +1,27 @@
package handlers package handlers
import ( import (
"errors"
"fmt" "fmt"
"net/http"
"strconv"
"gitea.tecamino.com/paadi/AccessHandler/models" "gitea.tecamino.com/paadi/access-handler/internal/utils"
"gitea.tecamino.com/paadi/AccessHandler/utils" "gitea.tecamino.com/paadi/access-handler/models"
"github.com/gin-gonic/gin"
) )
// AddUserTable
//
// Description:
//
// Creates a new database table for storing user records if it does not already exist.
//
// Behavior:
// - Uses the DBHandler to add a table based on the `models.User` struct.
// - Returns any error encountered during table creation.
//
// Returns:
// - error: Any database error that occurs while creating the table.
func (aH *AccessHandler) AddUserTable() error { func (aH *AccessHandler) AddUserTable() error {
return aH.dbHandler.addNewTable(models.User{}) return aH.dbHandler.AddNewTable(models.User{})
} }
// AddDefaultUser
//
// Description:
//
// Ensures a default administrative user exists in the database.
// If a user with the predefined email already exists, the function logs
// a debug message and exits without making changes.
//
// Behavior:
// 1. Checks if the default user (admin) already exists by email.
// 2. If not found, creates default Quasar UI settings and adds the user.
//
// Default User:
// - Name: "admin"
// - Role: "admin"
// - Email: "zuercher@tecamino.ch"
// - Password: (empty or hashed later)
//
// Returns:
// - error: Any database or creation error encountered.
func (aH *AccessHandler) AddDefaultUser() (err error) { func (aH *AccessHandler) AddDefaultUser() (err error) {
name := "admin" name := "admin"
role := "admin" role := "admin"
email := "zuercher@tecamino.ch" email := "zuercher@tecamino.ch"
// Check if a user with this email already exists // Check if a user with this email already exists
if err := aH.dbHandler.exists(&models.User{}, "email", email, false); err == nil { if err := aH.dbHandler.Exists(&models.User{}, "email", email, false); err == nil {
aH.logger.Debug("AddDefaultUser", "user email "+email+" exists already") aH.logger.Debug("AddDefaultUser", "user email "+email+" exists already")
// Found a user → skip create // Found a user → skip create
return nil return nil
@@ -61,7 +33,7 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
settings.DefaultQuasarSettings() settings.DefaultQuasarSettings()
// Insert default admin user into the database // Insert default admin user into the database
aH.dbHandler.addNewColum(&models.User{ aH.dbHandler.AddNewColum(&models.User{
Name: name, Name: name,
Role: role, Role: role,
Email: email, Email: email,
@@ -71,148 +43,161 @@ func (aH *AccessHandler) AddDefaultUser() (err error) {
return return
} }
// AddNewUser func (aH *AccessHandler) AddUser(c *gin.Context) {
// var user models.User
// Description: err := c.BindJSON(&user)
// if err != nil {
// Adds a new user record to the database with a hashed password. aH.logger.Error("AddUser", err)
// c.JSON(http.StatusInternalServerError, models.NewJsonErrorResponse(err))
// Behavior: return
// 1. Verifies that the email does not already exist. }
// 2. Hashes the password using utils.HashPassword().
// 3. Inserts the new user record into the database. if !user.IsValid() {
// aH.logger.Error("AddUser", "user empty")
// Parameters: c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse("user empty"))
// - userName: The user's display name. return
// - email: The user's unique email address. }
// - password: The user's raw password (will be hashed).
// - role: The role assigned to the user.
//
// Returns:
// - error: If the user already exists or if hashing/insertion fails.
func (aH *AccessHandler) AddNewUser(userName, email, password, role string) (err error) {
// Check if a user with this email already exists // Check if a user with this email already exists
if err := aH.dbHandler.exists(&models.User{}, "email", email, false); err == nil { if err := aH.dbHandler.Exists(&models.User{}, "email", user.Email, false); err == nil {
// Found a user → skip create // Found a user → skip create
aH.logger.Error("AddNewUser", "user with email "+email+" already exists") aH.logger.Error("AddUser", "user with email "+user.Email+" already exists")
return fmt.Errorf("user with email %s already exists", email) c.JSON(http.StatusBadRequest, models.NewJsonMessageResponse(fmt.Sprintf("user with email %s already exists", user.Email)))
return
}
if !utils.IsValidEmail(user.Email) {
aH.logger.Error("AddUser", "not valid email address")
c.JSON(http.StatusBadRequest, models.NewJsonErrorResponse(errors.New("not valid email address")))
return
} }
// Hash the provided password before saving // Hash the provided password before saving
hash, err := utils.HashPassword(password) hash, err := utils.HashPassword(user.Password)
if err != nil { if err != nil {
return err aH.logger.Error("AddUser", err)
c.JSON(http.StatusInternalServerError, nil)
return
} }
aH.logger.Debug("AddNewUser", "add new user "+userName+" with role "+role) aH.logger.Debug("AddUser", "add default quasar user setting ")
user.Settings.DefaultQuasarSettings()
aH.logger.Debug("AddUser", "add new user "+user.Name+" with role "+user.Role)
// Insert the new user record // Insert the new user record
aH.dbHandler.addNewColum(&models.User{ aH.dbHandler.AddNewColum(&models.User{
Name: userName, Name: user.Name,
Role: role, Role: user.Role,
Email: email, Email: user.Email,
Password: hash, Password: hash,
Settings: user.Settings,
})
c.JSON(http.StatusOK, gin.H{
"message": fmt.Sprintf("user '%s' successfully added", user.Name),
}) })
return
} }
// GetUserById func (aH *AccessHandler) GetUser(c *gin.Context) {
// var i int
// Description: var err error
//
// Retrieves user(s) from the database by their unique ID. id := c.Query("id")
// if id == "undefined" || id == "null" || id == "" {
// Parameters: i = 0
// - id: The numeric user ID. } else {
// i, err = strconv.Atoi(id)
// Returns: if err != nil {
// - users: A slice containing the matched user (usually length 1). aH.logger.Error("GetUser", err)
// - err: Any database error encountered. c.JSON(http.StatusInternalServerError, nil)
func (aH *AccessHandler) GetUserById(id uint) (users []models.User, err error) { return
err = aH.dbHandler.getById(&users, id) }
return }
var users []models.User
err = aH.dbHandler.GetById(&users, uint(i))
if err != nil {
aH.logger.Error("GetUser", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
c.JSON(http.StatusOK, users)
} }
// GetUserByKey func (aH *AccessHandler) UpdateUser(c *gin.Context) {
// var user models.User
// Description: if err := c.BindJSON(&user); err != nil {
// aH.logger.Error("UpdateUser", err)
// Queries users based on a given column key and value. c.JSON(http.StatusInternalServerError, nil)
// return
// Parameters: }
// - key: The column name to search by (e.g., "email"). err := aH.dbHandler.UpdateValuesById(&user, user.Id)
// - value: The value to match. if err != nil {
// - likeSearch: If true, performs a LIKE (partial) search. aH.logger.Error("UpdateUser", err)
// c.JSON(http.StatusInternalServerError, nil)
// Returns: return
// - users: A list of users that match the search criteria. }
// - err: Any database error encountered. c.JSON(http.StatusOK, models.NewJsonMessageResponse("successfully updated user '"+user.Email+"'"))
func (aH *AccessHandler) GetUserByKey(key string, value any, likeSearch bool) (users []models.User, err error) {
err = aH.dbHandler.getByKey(&users, key, value, likeSearch)
return
} }
// UpdateUserById func (aH *AccessHandler) DeleteUser(c *gin.Context) {
// queryId := c.Query("id")
// Description:
//
// Updates an existing user record identified by its numeric ID.
//
// Parameters:
// - id: The user ID to update.
// - user: A struct containing updated field values.
//
// Returns:
// - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserById(id uint, user models.User) error {
return aH.dbHandler.updateValuesById(&user, id)
}
// UpdateUserByKey if queryId == "" || queryId == "null" || queryId == "undefined" {
// aH.logger.Error("DeleteUser", "id query missing or wrong value: "+queryId)
// Description: c.JSON(http.StatusBadRequest, gin.H{
// "message": "id query missing or wrong value: " + queryId,
// Updates a user record based on a specified column key and value. })
// return
// Parameters: }
// - user: The updated user data.
// - key: The column name used for lookup.
// - value: The value to match against the key column.
//
// Returns:
// - error: Any error encountered during the update.
func (aH *AccessHandler) UpdateUserByKey(user models.User, key string, value any) error {
return aH.dbHandler.updateValuesByKey(&user, key, value)
}
// DeleteUserById var request struct {
// Ids []int `json:"ids"`
// Description: }
//
// Deletes a user from the database using their numeric ID.
//
// Parameters:
// - id: The ID of the user to delete.
//
// Returns:
// - error: Any database error encountered during deletion.
func (aH *AccessHandler) DeleteUserById(id uint) (err error) {
return aH.dbHandler.deleteById(&models.User{}, id)
}
// DeleteUserByKey err := c.BindJSON(&request)
// if err != nil {
// Description: aH.logger.Error("DeleteUser", err)
// c.JSON(http.StatusInternalServerError, nil)
// Deletes users matching a specific key/value pair from the database. return
// }
// Parameters:
// - key: The column name to search by. if len(request.Ids) == 0 {
// - value: The value to match. aH.logger.Error("DeleteUser", "no ids given to be deleted")
// - likeSearch: Whether to use a partial match (LIKE). c.JSON(http.StatusBadRequest, gin.H{
// "message": "no ids given to be deleted",
// Returns: })
// - error: Any database error encountered during deletion. return
func (aH *AccessHandler) DeleteUserByKey(key string, value any, likeSearch bool) (err error) { }
return aH.dbHandler.deleteByKey(&models.User{}, key, value, likeSearch)
var ownId string
removeIds := make([]uint, len(request.Ids))
for i, id := range request.Ids {
if queryId == fmt.Sprint(id) {
ownId = queryId
continue
}
removeIds[i] = uint(id)
}
if ownId != "" {
aH.logger.Error("DeleteUser", "can not delete logged in member id: "+queryId)
c.JSON(http.StatusBadRequest, gin.H{
"message": "can not delete logged in member id: " + queryId,
"id": queryId,
})
return
}
err = aH.dbHandler.DeleteById(&models.User{}, removeIds...)
if err != nil {
aH.logger.Error("DeleteUser", err)
c.JSON(http.StatusInternalServerError, nil)
return
}
c.JSON(http.StatusOK, gin.H{
"message": "member(s) deleted",
})
} }

8
internal/utils/utils.go Normal file
View File

@@ -0,0 +1,8 @@
package utils
import "regexp"
func IsValidEmail(email string) bool {
re := regexp.MustCompile(`^[a-zA-Z0-9._%+\-]+@[a-zA-Z0-9.\-]+\.[a-zA-Z]{2,}$`)
return re.MatchString(email)
}

View File

@@ -5,3 +5,7 @@ type Role struct {
Role string `gorm:"column:role" json:"role"` Role string `gorm:"column:role" json:"role"`
Permissions Permissions `gorm:"type:json" json:"permissions"` Permissions Permissions `gorm:"type:json" json:"permissions"`
} }
func (r *Role) IsValid() bool {
return r.Role != ""
}

View File

@@ -4,9 +4,9 @@ type User struct {
Id uint `gorm:"primaryKey" json:"id"` Id uint `gorm:"primaryKey" json:"id"`
Name string `gorm:"column:user_name" json:"user"` Name string `gorm:"column:user_name" json:"user"`
Email string `gorm:"column:email" json:"email"` Email string `gorm:"column:email" json:"email"`
Role string `gorm:"column:role" json:"role"` Role string `gorm:"column:role" json:"role,omitempty"`
Password string `gorm:"column:password" json:"password"` Password string `gorm:"column:password" json:"password"`
Settings Settings `gorm:"type:json" json:"settings"` Settings Settings `gorm:"type:json" json:"settings,omitempty"`
} }
func (u *User) IsValid() bool { func (u *User) IsValid() bool {