11 Commits
Author SHA1 Message Date
schn33fuchs 5101c0ff4d Sam did styling 2026-06-08 12:52:54 +02:00
schn33fuchs 2a53c7372d Archive style 2026-06-07 20:43:12 +02:00
schn33fuchs 75f3ef392e Mobile fix
The CSG logo shrinks when on mobile screens
2026-06-07 12:11:49 +02:00
schn33fuchs 159202a7af Sidebar improvement
It now works on mobile
2026-06-07 12:11:32 +02:00
schn33fuchs 8fd35f3e82 Documentation 2026-06-07 11:56:16 +02:00
schn33fuchs 177e959bbd Center 2026-06-06 18:53:44 +02:00
schn33fuchs 3d68064b33 Resize 2026-06-06 18:50:56 +02:00
schn33fuchs 52ca6ec96f Home button
now has an svg
2026-06-06 18:48:14 +02:00
schn33fuchs 7f3913dcfb Post merge fix 2026-06-06 18:44:40 +02:00
schn33fuchs 31e98c0936 Merge branch 'ticket_background' 2026-06-06 18:36:31 +02:00
TheDiluTek 2a15f77f4f so ein bisschen buttons und links und non admin user tests 2026-06-06 18:13:40 +02:00
24 changed files with 1011 additions and 243 deletions
+63
View File
@@ -0,0 +1,63 @@
# Ticketsystem
A ticket system with backend and frontend components.
## Components
- **[Backend](../backend/index.html)** - The server-side API and business logic
- **[Frontend](../frontend/index.html)** - The client-side user interface
## Usage
### Prerequisite
#### IMPORTANT
Before compiling the programm you have to install the rust toolchain.
For a guide to do this, visit: <https://rust-lang.org/tools/install/>
A instance of a postgresql has to be accessible to the backend. Place the connection details in a .env file into the variable `DATABASE_URL`
To setup the tables you either can create them manually by following the sheme specified in `backend/migrations` or apply them with sqlx
To install sqlx run `cargo install sqlx` and then in the `backend` directory run `sqlx migrate run` to create the tables
### Environment
The .env file has to be in the root directory of the project or in the same directory as the executable
Keys:
`DATABASE_URL`: Specifying the url and connection details for the database
`TOKEN_SECRET`: The JWT token secret, can theoretically be anything but is more secure when generated with a tool, e.g: <https://jwtsecrets.com/>
`ORIGIN`: The origin of the frontend, used for CORS rules
`BACKEND_PORT`: The port which the backend should use to run on
### Backend
The backend can either be run via `cargo run --release` or `cargo build --release` using the correct target architecture, e.g. 'x86_64-unknown-linux-gnu',
the executable will be placed in the `target/release` directory and can then be run via any method
### Frontend
The HTML code for the frontend can be generated by using `trunk build`. The resulting files will end up in the `frontend/dist` directory and can be served over any webserver supporting wasm
#### NOTE
To install trunk run `cargo install trunk`
#### IMPORTANT
Requests from the frontend to /api/* have to be proxied to the Backend
Example with nginx and frontend running at localhost:8000 and backend at localhost:9000 :
```nginx
location /api/ {
proxy_pass http://localhost:9000/api;
}
```
## Usage of AI
Github Copilot CLI was used with the model Claude Haiku 4.5 to generate most of the documentation
Google Antigravity generated the Sequence Diagrams
### Prompt
Generate comments for cargo doc describing the indivilual components and create links to relevant structs, functions etc.
Generate a sequence diagramm in @[README.md] behind the class diagramms
### Output
The comments with `///` or `//!`
I've gone over it and modified it to my needs and opinions
The general structure sequence diagrams above. I've modified and fixed any errors and discrepancys
+379 -2
View File
@@ -4,5 +4,382 @@ A ticket system with backend and frontend components.
## Components ## Components
- **[Backend](../backend/index.html)** - The server-side API and business logic - **[Backend]** - The server-side API and business logic
- **[Frontend](../frontend/index.html)** - The client-side user interface - **[Frontend]** - The client-side user interface
## Usage
### Prerequisite
> [!IMPORTANT]
> Before compiling the programm you have to install the rust toolchain.
> For a guide to do this, visit: <https://rust-lang.org/tools/install/>
A instance of a postgresql has to be accessible to the backend. Place the connection details in a .env file into the variable `DATABASE_URL`
To setup the tables you either can create them manually by following the sheme specified in `backend/migrations` or apply them with sqlx
To install sqlx run `cargo install sqlx` and then in the `backend` directory run `sqlx migrate run` to create the tables
### Environment
The .env file has to be in the root directory of the project or in the same directory as the executable
Keys:
`DATABASE_URL`: Specifying the url and connection details for the database
`TOKEN_SECRET`: The JWT token secret, can theoretically be anything but is more secure when generated with a tool, e.g: <https://jwtsecrets.com/>
`ORIGIN`: The origin of the frontend, used for CORS rules
`BACKEND_PORT`: The port which the backend should use to run on
### Backend
The backend can either be run via `cargo run --release` or `cargo build --release` using the correct target architecture, e.g. 'x86_64-unknown-linux-gnu',
the executable will be placed in the `target/release` directory and can then be run via any method
### Frontend
The HTML code for the frontend can be generated by using `trunk build`. The resulting files will end up in the `frontend/dist` directory and can be served over any webserver supporting wasm
> [!NOTE]
> To install trunk run `cargo install trunk`
> [!IMPORTANT]
> Requests from the frontend to /api/* have to be proxied to the Backend
> Example with nginx and frontend running at localhost:8000 and backend at localhost:9000 :
> ```nginx
> location /api/ {
> proxy_pass http://localhost:9000/api;
> }
> ```
## Diagrams
### Class Diagramm
#### Backend
```mermaid
classDiagram
class Error {
+status: &'static str
+message: String
}
class TicketResponse {
+id: i32
+category: String
+betreff: String
+description: String
+room: i16
+status: String
+date: chrono::DateTime~chrono::Utc~
+user_id: i16
+user_first_name: String
+user_last_name: String
}
class User {
+id: i16
+last_name: String
+first_name: String
+username: String
+is_admin: bool
+pwd: String
}
class TicketCreateScheme {
+category: String
+betreff: String
+description: String
+room: i16
}
class TicketUpdateScheme {
+status: String
}
class UserUpdateScheme {
+id: i16
+first_name: String
+last_name: String
+username: String
+make_admin: bool
+new_pwd: String
}
class UserCreateScheme {
+first_name: String
+last_name: String
+username: String
+is_admin: bool
+pwd: String
}
class LoginScheme {
+username: String
+pwd: String
}
class FilteredUser {
+id: i16
+first_name: String
+last_name: String
+username: String
+is_admin: bool
}
class Claims {
+sub: String
+issued: usize
+expires: usize
}
class AppState {
-db: PgPool
-env: Env
}
class Env {
+db_url: String
+token_secret: String
+origin: String
+backend_port: String
+load() Env
}
AppState --> Env
Env ..> Env
```
#### Frontend
```mermaid
classDiagram
class TicketCreateScheme {
+category: String
+betreff: String
+description: String
+room: i16
}
class TicketUpdateScheme {
+status: String
}
class Ticket {
+id: i32
+category: String
+betreff: String
+description: String
+room: i16
+status: String
+date: chrono::DateTime~chrono::Utc~
+user_id: i16
+user_first_name: String
+user_last_name: String
}
class TicketProps {
+id: i32
}
class ActiveUser {
+id: Option~i16~
+is_admin: bool
}
class ApiError {
-message: String
-_status: String
}
class SidebarExpandState {
+ticket_open: bool
+users_open: bool
}
class Default {
+default() Self
}
class SidebarState {
+expand: SidebarExpandState
+set_tickets_open: Callback~bool~
+toggle_tickets: Callback~()~
+set_users_open: Callback~bool~
+toggle_users: Callback~()~
+new(expand:SidebarExpandState, set_tickets_open:Callback~bool~, toggle_tickets:Callback~()~, set_users_open:Callback~bool~, toggle_users:Callback~()~) Self
}
class SidebarProps {
+children: Children
}
class TicketPartial {
-date: DateTime~Utc~
-room: i16
-user_id: i16
}
class UserPartial {
-id: i16
-first_name: String
-last_name: String
}
class RoomTotalsProps {
-tickets: Vec~TicketPartial~
}
class UserTotalProps {
-users: Vec~UserPartial~
-tickets: Vec~TicketPartial~
}
class AdminSetupScheme {
+first_name: String
+last_name: String
+username: String
+pwd: String
}
class UserCreateScheme {
+first_name: String
+last_name: String
+username: String
+is_admin: bool
+pwd: String
}
class LoginScheme {
+username: String
+pwd: String
}
class UserUpdateScheme {
+id: i16
+first_name: String
+last_name: String
+username: String
+make_admin: bool
+new_pwd: String
}
class FilteredUser {
+id: i16
+first_name: String
+last_name: String
+username: String
+is_admin: bool
}
class UserProps {
+id: i16
}
class ApiError {
-message: String
-_status: String
}
class AuthState {
+is_authenticated: Option~bool~
+is_admin: Option~bool~
}
class ProtectedRouteProps {
+children: Children
+admin_page: bool
}
class SidebarShellProps {
+children: Children
}
class SidebarComponentProps {
+is_open: bool
+on_close: Callback~()~
}
class AdminCheckWrapperProps {
+children: Children
}
SidebarState --> SidebarExpandState
RoomTotalsProps --> TicketPartial
UserTotalProps --> UserPartial
UserTotalProps --> TicketPartial
SidebarShellProps ..> SidebarComponentProps
```
### Sequence Diagrams
#### 1. System Initialization & Administrator Setup
```mermaid
sequenceDiagram
autonumber
actor Admin as Initial Administrator
participant FE as Frontend (Yew)
participant BE as Backend (Axum)
participant DB@{"type": "database", "alias": "Database"}
Note over Admin, DB: System Initialization Flow
FE->>BE: GET /api/check-admin
BE->>DB: SELECT COUNT(*) FROM users WHERE is_admin = true
DB-->>BE: 0 (No admin found)
BE-->>FE: HTTP 200 OK {"exists": false}
FE-->>Admin: Render Admin Setup Page
Admin->>FE: Input username, password, first/last name
FE->>BE: POST /api/setup-admin {username, pwd, ...}
Note over BE: Hash password using Argon2
BE->>DB: INSERT INTO users (username, pwd, is_admin, ...)
DB-->>BE: Success
BE-->>FE: HTTP 200 OK {"status": "success"}
FE-->>Admin: Redirect to Login Page
```
#### 2. User Authentication Flow (Login)
```mermaid
sequenceDiagram
autonumber
actor User
participant FE as Frontend (Yew)
participant BE as Backend (Axum)
participant DB as Database@{"type": "database"}
Note over User, DB: Authentication & Cookie Session Setup
User->>FE: Enter username & password
FE->>BE: POST /api/login {username, pwd}
BE->>DB: SELECT * FROM users WHERE username = $1
DB-->>BE: Return user record with password hash
Note over BE: Verify password using Argon2
alt Password Valid
Note over BE: Generate JWT token containing claims (sub: user_id)
Note over BE: Build HttpOnly, Secure, Lax cookie 'token'
BE-->>FE: HTTP 200 OK {"status": "success", "token": "...", "user": {...}}
Note over BE,FE: Header: Set-Cookie: token=...#59; Path=/#59; HttpOnly#59; SameSite=Lax
Note over FE: Save auth state to global context
FE-->>User: Redirect to Dashboard / Home
else Password Invalid
BE-->>FE: HTTP 400 Bad Request {"status": "error", "message": "Invalid password"}
FE-->>User: Display error message
end
```
#### 3. Ticket Lifecycle Flow
```mermaid
sequenceDiagram
autonumber
actor User as Authenticated User
actor Admin as Administrator
participant FE as Frontend (Yew)
participant BE as Backend (Axum)
participant DB as Database@{"type": "database"}
Note over User, DB: Ticket Creation Flow (Protected Route)
User->>FE: Fill out ticket form & submit
FE->>BE: POST /api/tickets/create {category, betreff, description, room} (Includes 'token' cookie)
Note over BE: validate_token middleware decodes & verifies JWT
BE->>DB: INSERT INTO tickets (category, description, betreff, room, user_id)
DB-->>BE: Success
BE-->>FE: HTTP 200 OK {"status": "success"}
FE-->>User: Clear form & display success notification
Note over Admin, DB: Ticket Review & Resolution (Admin Only Route)
Admin->>FE: View Ticket Board
FE->>BE: GET /api/tickets (Includes 'token' cookie)
Note over BE: validate_token middleware checks JWT
BE->>DB: SELECT tickets JOIN users ...
DB-->>BE: Return list of tickets
BE-->>FE: HTTP 200 OK [tickets]
FE-->>Admin: Render Ticket List
Admin->>FE: Click "Resolve" on ticket
FE->>BE: PATCH /api/tickets/{id} {"status": "Resolved"} (Includes 'token' cookie)
Note over BE: validate_admin middleware verifies token & checks is_admin = true
BE->>DB: UPDATE tickets SET status = $1 WHERE id = $2
DB-->>BE: Success
BE-->>FE: HTTP 200 OK {"status": "success"}
FE-->>Admin: Update ticket status in UI
Note over Admin, DB: Ticket Archiving Flow (Admin Only Route)
Admin->>FE: Open Archived Tickets page
FE->>BE: GET /api/tickets/archive (Includes 'token' cookie)
Note over BE: validate_admin middleware verifies token & admin role
BE->>DB: SELECT * FROM tickets WHERE status = 'Archived'
DB-->>BE: Return archived tickets
BE-->>FE: HTTP 200 OK [Archived Tickets]
FE-->>Admin: Render historical archive board
```
## Usage of AI
Github Copilot CLI was used with the model Claude Haiku 4.5 to generate most of the documentation
Google Antigravity generated the Sequence Diagrams
### Prompt
Generate comments for cargo doc describing the indivilual components and create links to relevant structs, functions etc.
Generate a sequence diagramm in @[README.md] behind the class diagramms
### Output
The comments with `///` or `//!`
I've gone over it and modified it to my needs and opinions
The general structure sequence diagrams above. I've modified and fixed any errors and discrepancys
+7 -6
View File
@@ -6,8 +6,8 @@ use crate::models::Claims;
/// Error response for JWT token operations. /// Error response for JWT token operations.
/// ///
/// Returned when token encoding or decoding fails. Used in error responses /// Returned when token encoding or decoding fails via `encode_token` or `decode_token`.
/// for invalid or expired tokens. /// Used in error responses for invalid or expired [`Claims`] tokens.
/// ///
/// # Fields /// # Fields
/// - `status`: HTTP status text (e.g., "error") /// - `status`: HTTP status text (e.g., "error")
@@ -22,7 +22,7 @@ pub struct Error {
/// ///
/// This function creates a new JWT with the provided user ID as the subject, /// This function creates a new JWT with the provided user ID as the subject,
/// sets the issued-at and expiration times (60 minutes from now), and signs it /// sets the issued-at and expiration times (60 minutes from now), and signs it
/// using the given encoding key. /// using the given encoding key. The resulting token is a serialized [`Claims`].
/// ///
/// # Arguments /// # Arguments
/// - `header`: The JWT header, specifying the algorithm (e.g., HS256). /// - `header`: The JWT header, specifying the algorithm (e.g., HS256).
@@ -30,7 +30,7 @@ pub struct Error {
/// - `key`: The `EncodingKey` used to sign the JWT. /// - `key`: The `EncodingKey` used to sign the JWT.
/// ///
/// # Returns /// # Returns
/// A `String` representing the encoded JWT. /// A `String` representing the encoded JWT containing [`Claims`].
/// ///
/// # Panics /// # Panics
/// Panics if the token encoding fails for any reason (e.g., invalid key). /// Panics if the token encoding fails for any reason (e.g., invalid key).
@@ -50,14 +50,15 @@ pub fn encode_token(header: &Header, id: String, key: &EncodingKey) -> String {
/// ///
/// This function attempts to decode a JWT string, validate its signature and claims /// This function attempts to decode a JWT string, validate its signature and claims
/// using the provided decoding key. It specifically ignores expiration (`validate_exp`) /// using the provided decoding key. It specifically ignores expiration (`validate_exp`)
/// and "not before" (`validate_nbf`) claims during validation. /// and "not before" (`validate_nbf`) claims during validation. Returns the extracted [`Claims`]
/// on success.
/// ///
/// # Arguments /// # Arguments
/// - `token`: The JWT string to decode. /// - `token`: The JWT string to decode.
/// - `key`: The `DecodingKey` used to verify the JWT's signature. /// - `key`: The `DecodingKey` used to verify the JWT's signature.
/// ///
/// # Returns /// # Returns
/// - `Ok(Claims)`: If the token is successfully decoded and verified, returns the extracted `Claims`. /// - `Ok(Claims)`: If the token is successfully decoded and verified, returns the extracted [`Claims`].
/// - `Err((StatusCode, Json<Error>))`: If the token is invalid, expired, or cannot be decoded, /// - `Err((StatusCode, Json<Error>))`: If the token is invalid, expired, or cannot be decoded,
/// returns an `UNAUTHORIZED` status code along with a JSON error message. /// returns an `UNAUTHORIZED` status code along with a JSON error message.
pub fn decode_token(token: String, key: &DecodingKey) -> Result<Claims, (StatusCode, Json<Error>)> { pub fn decode_token(token: String, key: &DecodingKey) -> Result<Claims, (StatusCode, Json<Error>)> {
+8 -6
View File
@@ -17,9 +17,10 @@ use crate::{AppState, cookie::jwt::decode_token, handlers::auth::filter_user, mo
/// Axum middleware to validate a JWT token present in cookies or Authorization header. /// Axum middleware to validate a JWT token present in cookies or Authorization header.
/// ///
/// This function extracts a JWT from the request (either from the `token` cookie or /// This function extracts a JWT from the request (either from the `token` cookie or
/// the `Authorization: Bearer` header), decodes and validates it. If valid, it fetches /// the `Authorization: Bearer` header), decodes and validates it using [`decode_token`](`crate::cookie::jwt::decode_token`)).
/// the corresponding user from the database and inserts a `FilteredUser` into the /// If valid, it fetches the corresponding [`User`] from the database and inserts a
/// request extensions for subsequent handlers to use. /// [`FilteredUser`](crate::models::FilteredUser)
/// (converted via [`filter_user`](`crate::handlers::auth::filter_user`)) into the request extensions for subsequent handlers to use.
/// ///
/// If the token is missing, invalid, or the user is not found, it returns an /// If the token is missing, invalid, or the user is not found, it returns an
/// appropriate error response (401 Unauthorized). /// appropriate error response (401 Unauthorized).
@@ -110,9 +111,10 @@ pub async fn validate_token(
/// Axum middleware to validate JWT token and ensure the authenticated user has admin privileges. /// Axum middleware to validate JWT token and ensure the authenticated user has admin privileges.
/// ///
/// This middleware first performs all checks of `validate_token`: extracting, decoding, /// This middleware first performs all checks of [`validate_token`]: extracting, decoding,
/// and validating the JWT, and fetching the associated user from the database. /// and validating the JWT via [`decode_token`](`crate::cookie::jwt::decode_token`), and fetching the associated [`User`] from the database.
/// Additionally, it verifies that the fetched user has `is_admin` set to `true`. /// Additionally, it verifies that the fetched user has `is_admin` set to `true`. Returns a [`FilteredUser`](crate::models::FilteredUser)
/// (converted via [`filter_user`](`crate::handlers::auth::filter_user`)) in the request extensions if both authentication and admin status are valid.
/// ///
/// If the user is not authenticated or not an administrator, it returns an /// If the user is not authenticated or not an administrator, it returns an
/// appropriate error response (401 Unauthorized or 403 Forbidden). /// appropriate error response (401 Unauthorized or 403 Forbidden).
+14 -5
View File
@@ -1,12 +1,13 @@
/// Environment configuration for the application. /// Environment configuration for the application.
/// ///
/// Loads required configuration from environment variables at startup. /// Loads required configuration from environment variables at startup.
/// All variables must be present or the application will panic. /// All variables must be present or the application will panic during [`Env::load`].
/// Used by [`AppState`](crate::AppState) for configuring JWT signing and CORS.
/// ///
/// # Fields /// # Fields
/// - `db_url`: PostgreSQL database connection URL. /// - `db_url`: PostgreSQL database connection URL
/// - `token_secret`: Secret key used to sign and verify JWT tokens. /// - `token_secret`: Secret key used to sign and verify [`Claims`](crate::models::Claims) in JWT tokens
/// - `origin`: Frontend origin URL for CORS policy. /// - `origin`: Frontend origin URL for CORS policy configuration
/// ///
/// # Required Environment Variables /// # Required Environment Variables
/// - `DATABASE_URL`: PostgreSQL connection string (e.g., `postgresql://user:pass@localhost/dbname`) /// - `DATABASE_URL`: PostgreSQL connection string (e.g., `postgresql://user:pass@localhost/dbname`)
@@ -25,12 +26,20 @@ pub struct Env {
impl Env { impl Env {
/// Loads environment configuration from system environment variables. /// Loads environment configuration from system environment variables.
/// ///
/// Panics if any required variable is missing. /// Reads `DATABASE_URL`, `TOKEN_SECRET`, and `ORIGIN` from the environment and returns
/// a configured [`Env`] instance. Used during server initialization in the `main` function.
///
/// # Panics
/// If any required variable is missing (DATABASE_URL, TOKEN_SECRET, or ORIGIN).
/// ///
/// # Example /// # Example
/// ```ignore /// ```ignore
/// let env = Env::load(); /// let env = Env::load();
/// // Environment must have DATABASE_URL, TOKEN_SECRET, and ORIGIN set /// // Environment must have DATABASE_URL, TOKEN_SECRET, and ORIGIN set
/// let app_state = AppState {
/// db: pool,
/// env,
/// };
/// ``` /// ```
pub fn load() -> Env { pub fn load() -> Env {
let db_url = std::env::var("DATABASE_URL").expect("DATABASE_URL must be set"); let db_url = std::env::var("DATABASE_URL").expect("DATABASE_URL must be set");
+52 -55
View File
@@ -22,11 +22,12 @@ use crate::{
/// Registers a new user in the system. /// Registers a new user in the system.
/// ///
/// Creates a new user account with the provided credentials. The password is hashed using Argon2 /// Creates a new [`User`] account with the provided [`UserCreateScheme`] credentials.
/// before being stored. Only administrators can create new users. /// The password is hashed using Argon2 before being stored. Only administrators can create new users.
/// ///
/// # Arguments /// # Arguments
/// - `request`: User creation details including first/last name, username, admin flag, and password /// - `State(data)`: Application state containing [`AppState`] for database access
/// - `request`: [`UserCreateScheme`] containing user details including first/last name, username, admin flag, and password
/// ///
/// # Returns /// # Returns
/// - `200 OK` on successful user creation /// - `200 OK` on successful user creation
@@ -34,12 +35,7 @@ use crate::{
/// - `500 Internal Server Error` if database insertion fails /// - `500 Internal Server Error` if database insertion fails
/// ///
/// # Password Hashing /// # Password Hashing
/// Uses Argon2 with a cryptographically secure random salt: /// Uses Argon2 with a cryptographically secure random salt.
/// ```ignore
/// let argon = Argon2::default();
/// let salt = SaltString::generate(&mut OsRng);
/// let hashed_pwd = argon.hash_password(password.as_bytes(), &salt)?;
/// ```
pub async fn create_user( pub async fn create_user(
State(data): State<Arc<AppState>>, State(data): State<Arc<AppState>>,
Json(request): Json<UserCreateScheme>, Json(request): Json<UserCreateScheme>,
@@ -106,27 +102,23 @@ pub async fn create_user(
/// Authenticates a user and creates a JWT token for session management. /// Authenticates a user and creates a JWT token for session management.
/// ///
/// Verifies the provided username and password against stored credentials using Argon2 verification. /// Verifies the provided username and password against stored credentials using Argon2 verification.
/// On successful authentication, generates a JWT token and sets it as an HTTP-only cookie. /// On successful authentication, generates and encodes a [`Claims`](crate::models::Claims) token via [`encode_token`](`crate::cookie::jwt::encode_token`) and sets it as an HTTP-only cookie.
/// The token is valid for 1 hour. /// The token is valid for 1 hour.
/// ///
/// # Arguments /// # Arguments
/// - `request`: Login credentials (username, password) /// - `State(data)`: Application state containing [`AppState`] for database access
/// - `request`: [`LoginScheme`] containing login credentials (username, password)
/// ///
/// # Returns /// # Returns
/// - `200 OK` with JSON containing token and filtered user info /// - `200 OK` with JSON containing token and filtered [`FilteredUser`] info
/// - `400 Bad Request` if username not found or password invalid /// - `400 Bad Request` if username not found or password invalid
/// - `500 Internal Server Error` if database query fails /// - `500 Internal Server Error` if database query fails
/// ///
/// # Security Features /// # Security Features
/// - HTTP-only cookie prevents JavaScript access /// - HTTP-only cookie prevents JavaScript access
/// - SameSite=Lax protects against CSRF attacks /// - SameSite=Lax protects against CSRF attacks
/// - Password verification uses Argon2: /// - Password verification uses Argon2 with stored [`User`] hash
/// ```ignore /// - JWT token includes user ID and expiration timestamp via [`Claims`](crate::models::Claims) encoded by [`encode_token`](`crate::cookie::jwt::encode_token`)
/// let valid_pwd = Argon2::default()
/// .verify_password(&request.pwd.as_bytes(), &pwd_hash.unwrap())
/// .is_ok();
/// ```
/// - JWT token includes user ID and expiration timestamp
/// ///
/// # Example Response /// # Example Response
/// ```json /// ```json
@@ -195,7 +187,7 @@ pub async fn login(
/// ///
/// Sets the authentication cookie to expire immediately (max_age = -1 hour) which causes /// Sets the authentication cookie to expire immediately (max_age = -1 hour) which causes
/// the browser to discard it. This effectively logs the user out without requiring server-side /// the browser to discard it. This effectively logs the user out without requiring server-side
/// session invalidation. /// session invalidation. The cookie no longer contains a valid [`Claims`](crate::models::Claims) token.
/// ///
/// # Returns /// # Returns
/// Always returns `200 OK` with success message and an expired cookie header /// Always returns `200 OK` with success message and an expired cookie header
@@ -227,11 +219,11 @@ pub async fn logout() -> Result<impl IntoResponse, (StatusCode, Json<serde_json:
/// Retrieves the currently authenticated user's information. /// Retrieves the currently authenticated user's information.
/// ///
/// Uses the user data embedded in the JWT token (via middleware). /// Uses the [`FilteredUser`] data embedded in the JWT token (via middleware).
/// Useful for frontends to display logged-in user info or verify authentication. /// Useful for frontends to display logged-in user info or verify authentication.
/// ///
/// # Returns /// # Returns
/// - `200 OK` with user data (excluding password) /// - `200 OK` with [`FilteredUser`] data (excluding password)
/// - Automatically returns `401 Unauthorized` if not authenticated (middleware) /// - Automatically returns `401 Unauthorized` if not authenticated (middleware)
/// ///
/// # Example Response /// # Example Response
@@ -264,11 +256,12 @@ pub async fn get_current_user(
/// Deletes a user account from the system. /// Deletes a user account from the system.
/// ///
/// Only admins can delete users. The user account and all associated data is removed. /// Only admins can delete users (enforced by middleware). The [`User`] account and all associated data is removed.
/// Note: Tickets created by deleted users will have NULL user_id references. /// Note: Tickets created by deleted users will have NULL user_id references.
/// ///
/// # Arguments /// # Arguments
/// - `id`: User ID to delete /// - `Path(id)`: [`User`] ID to delete, extracted from URL path
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Returns /// # Returns
/// - `204 No Content` on successful deletion /// - `204 No Content` on successful deletion
@@ -302,11 +295,14 @@ pub async fn delete_user(
/// Retrieves all users in the system. /// Retrieves all users in the system.
/// ///
/// Only admins can call this endpoint. Returns all users sorted alphabetically by last name. /// Only admins can call this endpoint (enforced by middleware). Returns all [`User`] records converted to [`FilteredUser`]
/// Password hashes are not included in the response. /// and sorted alphabetically by last name. Password hashes are not included in the response.
///
/// # Arguments
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Returns /// # Returns
/// - `200 OK` with array of FilteredUser objects /// - `200 OK` with array of [`FilteredUser`] objects
/// - `500 Internal Server Error` if database query fails /// - `500 Internal Server Error` if database query fails
/// ///
/// # Example Response /// # Example Response
@@ -352,15 +348,15 @@ pub async fn get_users(
/// Retrieves a single user's details by their ID. /// Retrieves a single user's details by their ID.
/// ///
/// This endpoint allows fetching a specific user's information. It returns a `FilteredUser` /// This endpoint allows fetching a specific [`User`]'s information. It returns a [`FilteredUser`]
/// object, ensuring sensitive data like password hashes are not exposed. /// object (converted via [`filter_user`]), ensuring sensitive data like password hashes are not exposed.
/// ///
/// # Arguments /// # Arguments
/// - `Path(id)`: The ID of the user to retrieve, extracted from the URL path. /// - `Path(id)`: The ID of the [`User`] to retrieve, extracted from the URL path.
/// - `State(data)`: Application state containing `AppState` for database access. /// - `State(data)`: Application state containing [`AppState`] for database access.
/// ///
/// # Returns /// # Returns
/// - `200 OK` with a `FilteredUser` JSON object if the user is found. /// - `200 OK` with a [`FilteredUser`] JSON object if the user is found.
/// - `404 Not Found` if a user with the given ID does not exist. /// - `404 Not Found` if a user with the given ID does not exist.
/// - `500 Internal Server Error` if a database query error occurs. /// - `500 Internal Server Error` if a database query error occurs.
/// ///
@@ -396,23 +392,24 @@ pub async fn get_user_by_id(
/// Updates an existing user's information. /// Updates an existing user's information.
/// ///
/// This endpoint allows administrators to modify a user's `first_name`, `last_name`, /// This endpoint allows administrators to modify a [`User`]'s `first_name`, `last_name`,
/// `username`, `is_admin` status, and optionally their password. If `new_pwd` in the /// `username`, `is_admin` status, and optionally their password. If `new_pwd` in the
/// request body is an empty string, the user's password remains unchanged. /// request body is an empty string, the user's password remains unchanged.
/// ///
/// # Arguments /// # Arguments
/// - `Path(id)`: The ID of the user to update, extracted from the URL path. /// - `Path(id)`: The ID of the [`User`] to update, extracted from the URL path.
/// - `State(data)`: Application state containing `AppState` for database access. /// - `State(data)`: Application state containing [`AppState`] for database access.
/// - `Json(body)`: `UserUpdateScheme` containing the fields to update. /// - `Json(body)`: [`UserUpdateScheme`] containing the fields to update.
/// ///
/// # Returns /// # Returns
/// - `200 OK` with the `FilteredUser` object of the updated user. /// - `200 OK` with the [`FilteredUser`] object of the updated user (converted via [`filter_user`]).
/// - `404 Not Found` if a user with the given ID does not exist. /// - `404 Not Found` if a user with the given ID does not exist.
/// - `500 Internal Server Error` if a database query or password hashing error occurs. /// - `500 Internal Server Error` if a database query or password hashing error occurs.
/// ///
/// # Security Note /// # Security Note
/// - Passwords are hashed using Argon2 before storage. /// - Passwords are hashed using Argon2 before storage.
/// - This endpoint typically requires admin privileges (enforced by middleware). /// - This endpoint requires admin privileges (enforced by middleware via
/// [`validate_admin`](crate::cookie::validation::validate_admin)).
pub async fn update_user( pub async fn update_user(
Path(id): Path<i16>, Path(id): Path<i16>,
State(data): State<Arc<AppState>>, State(data): State<Arc<AppState>>,
@@ -482,7 +479,10 @@ pub async fn update_user(
/// Checks if any administrator user exists in the system. /// Checks if any administrator user exists in the system.
/// ///
/// This endpoint is used during initialization to determine if the setup page should be displayed. /// This endpoint is used during initialization to determine if the setup page should be displayed.
/// It counts all users with `is_admin = true` in the database. /// It counts all [`User`] records with `is_admin = true` in the database.
///
/// # Arguments
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Returns /// # Returns
/// - `200 OK` with JSON: `{"has_admin": bool}` - Whether at least one admin exists /// - `200 OK` with JSON: `{"has_admin": bool}` - Whether at least one admin exists
@@ -512,28 +512,24 @@ pub async fn check_admin_exists(
/// Creates the initial administrator account for a fresh system. /// Creates the initial administrator account for a fresh system.
/// ///
/// This function handles the one-time setup of the first admin user. It checks that no admin exists /// This function handles the one-time setup of the first admin [`User`]. It checks that no admin exists
/// before allowing creation. This endpoint is only functional when the system has no administrators. /// before allowing creation via database count. This endpoint is only functional when the system has no administrators.
/// Once created, subsequent admin registrations must go through the normal `create_user` endpoint /// Once created, subsequent admin registrations must go through the normal `create_user` endpoint
/// with proper authorization. /// with proper authorization.
/// ///
/// # Arguments /// # Arguments
/// - `request`: User creation details (first_name, last_name, username, password) /// - `State(data)`: Application state containing [`AppState`] for database access
/// - `request`: [`UserCreateScheme`] containing user creation details (first_name, last_name, username, password)
/// ///
/// # Returns /// # Returns
/// - `200 OK` with success message if admin account created /// - `200 OK` with success message if admin account created
/// - `400 Bad Request` if: /// - `400 Bad Request` if:
/// - Admin already exists /// - Admin already exists (checked via admin count)
/// - Username or password is empty /// - Username or password is empty
/// - `500 Internal Server Error` if database insertion fails /// - `500 Internal Server Error` if database insertion fails
/// ///
/// # Security Note /// # Security Note
/// The password is hashed using Argon2 with a random salt before storage: /// The password is hashed using Argon2 with a random salt before storage.
/// ```ignore
/// let argon = Argon2::default();
/// let salt = SaltString::generate(&mut OsRng);
/// let hashed_pwd = argon.hash_password(request.pwd.as_bytes(), &salt)?;
/// ```
pub async fn setup_initial_admin( pub async fn setup_initial_admin(
State(data): State<Arc<AppState>>, State(data): State<Arc<AppState>>,
Json(request): Json<UserCreateScheme>, Json(request): Json<UserCreateScheme>,
@@ -598,17 +594,18 @@ pub async fn setup_initial_admin(
} }
} }
/// Converts a User with sensitive data into a FilteredUser safe for API responses. /// Converts a [`User`] with sensitive data into a [`FilteredUser`] safe for API responses.
/// ///
/// This function removes password hashes and other sensitive information before /// This function removes password hashes and other sensitive information before
/// returning user data to clients. Always use this helper instead of directly /// returning [`User`] data to clients. Always use this helper instead of directly
/// serializing User objects. /// serializing [`User`] objects.
/// Used by all authentication endpoints to ensure passwords are never exposed.
/// ///
/// # Arguments /// # Arguments
/// - `user`: Reference to the internal User struct containing password hash /// - `user`: Reference to the internal [`User`] struct containing password hash
/// ///
/// # Returns /// # Returns
/// FilteredUser with only safe-to-share information: /// [`FilteredUser`] with only safe-to-share information:
/// - `id`: User ID /// - `id`: User ID
/// - `first_name`, `last_name`: User name /// - `first_name`, `last_name`: User name
/// - `username`: Login username /// - `username`: Login username
@@ -621,7 +618,7 @@ pub async fn setup_initial_admin(
/// # Example /// # Example
/// ```ignore /// ```ignore
/// let user = get_user_from_db(1).await?; /// let user = get_user_from_db(1).await?;
/// let safe_user = filter_user(&user); /// let safe_user = filter_user(&user); // Convert User to FilteredUser
/// // safe_user can be safely serialized and sent to client /// // safe_user can be safely serialized and sent to client
/// ``` /// ```
pub fn filter_user(user: &User) -> FilteredUser { pub fn filter_user(user: &User) -> FilteredUser {
+25 -16
View File
@@ -16,12 +16,14 @@ use crate::{
/// Creates a new support ticket. /// Creates a new support ticket.
/// ///
/// Associates the ticket with the authenticated user and sets the current timestamp. /// Associates the ticket with the authenticated [`FilteredUser`] and sets the current timestamp.
/// Converts the [`TicketCreateScheme`] request into a database record.
/// Tickets are automatically created with "open" status. /// Tickets are automatically created with "open" status.
/// ///
/// # Arguments /// # Arguments
/// - `user`: Authenticated user (extracted from JWT token) /// - `Extension(user)`: Authenticated [`FilteredUser`] (extracted from JWT token via middleware)
/// - `body`: Ticket details (category, subject, description, room) /// - `State(data)`: Application state containing [`AppState`] for database access
/// - `Json(body)`: [`TicketCreateScheme`] containing ticket details (category, subject, description, room)
/// ///
/// # Returns /// # Returns
/// - `200 OK` on successful creation /// - `200 OK` on successful creation
@@ -60,10 +62,11 @@ pub async fn create_ticket(
/// Deletes a ticket by ID. /// Deletes a ticket by ID.
/// ///
/// Only admins can delete tickets. Marks the ticket as deleted or removes from database. /// Only admins can delete tickets (enforced by middleware). Removes the [`TicketResponse`] and associated data from the database.
/// ///
/// # Arguments /// # Arguments
/// - `id`: Ticket ID to delete /// - `Path(id)`: Ticket ID to delete, extracted from URL path
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Returns /// # Returns
/// - `204 No Content` on successful deletion /// - `204 No Content` on successful deletion
@@ -97,15 +100,18 @@ pub async fn delete_ticket(
/// Retrieves all non-archived tickets. /// Retrieves all non-archived tickets.
/// ///
/// Returns a list of all active tickets with user information denormalized for easier rendering. /// Returns a list of all active [`TicketResponse`] objects with user information denormalized for easier rendering.
/// Tickets are ordered by creation date (newest first). /// Tickets are ordered by creation date (newest first). Joins with [`User`](crate::models::User) table to include creator information.
///
/// # Arguments
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Filtering /// # Filtering
/// - Excludes tickets with status "Archived" /// - Excludes tickets with status "Archived"
/// - Uses LEFT JOIN to include creator information /// - Uses LEFT JOIN to include creator information from [`User`](crate::models::User)
/// ///
/// # Returns /// # Returns
/// - `200 OK` with array of TicketResponse objects /// - `200 OK` with array of [`TicketResponse`] objects
/// - `500 Internal Server Error` if database query fails /// - `500 Internal Server Error` if database query fails
/// ///
/// # Example Response /// # Example Response
@@ -169,12 +175,14 @@ pub async fn get_tickets(
/// Retrieves a specific ticket by ID. /// Retrieves a specific ticket by ID.
/// ///
/// Includes full ticket details and denormalized user information (creator name). /// Includes full ticket details and denormalized user information (creator name).
/// Returns a [`TicketResponse`] with all metadata by joining with [`User`](crate::models::User) table.
/// ///
/// # Arguments /// # Arguments
/// - `id`: Ticket ID to retrieve /// - `Path(id)`: Ticket ID to retrieve, extracted from URL path
/// - `State(data)`: Application state containing [`AppState`] for database access
/// ///
/// # Returns /// # Returns
/// - `200 OK` with TicketResponse object /// - `200 OK` with [`TicketResponse`] object
/// - `404 Not Found` if ticket doesn't exist /// - `404 Not Found` if ticket doesn't exist
/// - `500 Internal Server Error` if database error occurs /// - `500 Internal Server Error` if database error occurs
/// ///
@@ -242,15 +250,16 @@ pub async fn get_ticket_by_id(
/// Updates a ticket's status. /// Updates a ticket's status.
/// ///
/// Only admins can update ticket status. This is typically used to transition tickets /// Only admins can update ticket status (enforced by middleware). Applies [`TicketUpdateScheme`] to modify the [`TicketResponse`].
/// through their lifecycle (open → in_progress → resolved → archived). /// This is typically used to transition tickets through their lifecycle (open → in_progress → resolved → archived).
/// ///
/// # Arguments /// # Arguments
/// - `id`: Ticket ID to update /// - `Path(id)`: Ticket ID to update, extracted from URL path
/// - `body`: Update payload containing new status /// - `State(data)`: Application state containing [`AppState`] for database access
/// - `Json(body)`: [`TicketUpdateScheme`] update payload containing new status
/// ///
/// # Returns /// # Returns
/// - `200 OK` with updated TicketResponse /// - `200 OK` with updated [`TicketResponse`]
/// - `500 Internal Server Error` if ticket not found or database error /// - `500 Internal Server Error` if ticket not found or database error
/// ///
/// # Typical Status Flow /// # Typical Status Flow
+11 -6
View File
@@ -25,11 +25,12 @@ use crate::env::Env;
/// Shared application state passed to all route handlers. /// Shared application state passed to all route handlers.
/// ///
/// Contains the database connection pool and environment configuration. /// Contains the database connection pool and environment configuration.
/// This is wrapped in Arc for thread-safe sharing across async tasks. /// This is wrapped in Arc for thread-safe sharing across async tasks and cloned into each route
/// via `with_state`.
/// ///
/// # Fields /// # Fields
/// - `db`: PostgreSQL connection pool for database access /// - `db`: PostgreSQL connection pool for database access (via `sqlx::PgPool`)
/// - `env`: Configuration loaded from environment variables /// - `env`: [`Env`] configuration loaded from environment variables
pub struct AppState { pub struct AppState {
db: PgPool, db: PgPool,
env: Env, env: Env,
@@ -39,15 +40,19 @@ pub struct AppState {
/// ///
/// Initializes the server by: /// Initializes the server by:
/// 1. Loading environment variables from `.env` file /// 1. Loading environment variables from `.env` file
/// 2. Establishing database connection pool /// 2. Establishing database connection pool to PostgreSQL
/// 3. Configuring CORS policy for cross-origin requests /// 3. Configuring CORS policy for cross-origin requests
/// 4. Starting HTTP server on port 8001 /// 4. Creating the router with [`create_router`] containing all endpoints
/// 5. Starting HTTP server on port 8001
/// ///
/// # Server Configuration /// # Server Configuration
/// - Binds to `0.0.0.0:8001` (all network interfaces) /// - Binds to `0.0.0.0:8001` (all network interfaces)
/// - Allows: GET, POST, PATCH, DELETE methods /// - Allows: GET, POST, PATCH, DELETE methods
/// - Allows credentials and custom headers /// - Allows credentials and custom headers
/// - CORS origin configured from environment /// - CORS origin configured from [`Env`]
///
/// # State Setup
/// Creates shared [`AppState`] wrapped in `Arc` and passes to all routes
/// ///
/// # Panics /// # Panics
/// - If environment loading fails /// - If environment loading fails
+12 -11
View File
@@ -3,6 +3,7 @@ use serde::{Deserialize, Serialize};
/// API response for a ticket with user information. /// API response for a ticket with user information.
/// ///
/// Returned by ticket endpoints. Includes denormalized user data for easier frontend rendering. /// Returned by ticket endpoints. Includes denormalized user data for easier frontend rendering.
/// Created via [`TicketCreateScheme`].
/// ///
/// # Fields /// # Fields
/// - `id`: Unique ticket identifier /// - `id`: Unique ticket identifier
@@ -12,7 +13,7 @@ use serde::{Deserialize, Serialize};
/// - `room`: Room number associated with the issue /// - `room`: Room number associated with the issue
/// - `status`: Current ticket status (e.g., "open", "in_progress", "resolved") /// - `status`: Current ticket status (e.g., "open", "in_progress", "resolved")
/// - `date`: When the ticket was created (UTC timestamp) /// - `date`: When the ticket was created (UTC timestamp)
/// - `user_id`: ID of the user who created the ticket /// - `user_id`: ID of the user who created the ticket (references [`User`])
/// - `user_first_name`, `user_last_name`: User's name (denormalized for convenience) /// - `user_first_name`, `user_last_name`: User's name (denormalized for convenience)
/// ///
/// # Example /// # Example
@@ -47,7 +48,7 @@ pub struct TicketResponse {
/// Complete user record from the database. /// Complete user record from the database.
/// ///
/// Contains all user information including the password hash. /// Contains all user information including the password hash.
/// This should NEVER be sent directly to clients - always use `FilteredUser` instead. /// This should NEVER be sent directly to clients - always use [`FilteredUser`] instead.
/// ///
/// # Fields /// # Fields
/// - `id`: Unique user identifier /// - `id`: Unique user identifier
@@ -58,7 +59,7 @@ pub struct TicketResponse {
/// ///
/// # Security Note /// # Security Note
/// The `pwd` field contains the password hash and should never be included in API responses. /// The `pwd` field contains the password hash and should never be included in API responses.
/// Use `filter_user()` to convert to `FilteredUser` for responses. /// Use [`filter_user()`](`crate::handlers::auth::filter_user`) to convert to [`FilteredUser`] for responses.
#[derive(Deserialize, Serialize, PartialEq, Debug, Clone, sqlx::FromRow)] #[derive(Deserialize, Serialize, PartialEq, Debug, Clone, sqlx::FromRow)]
pub struct User { pub struct User {
pub id: i16, pub id: i16,
@@ -72,7 +73,7 @@ pub struct User {
/// Payload for creating a new ticket. /// Payload for creating a new ticket.
/// ///
/// Sent to `/api/tickets/create`. The backend automatically associates it with the /// Sent to `/api/tickets/create`. The backend automatically associates it with the
/// authenticated user and sets the creation timestamp. /// authenticated user and sets the creation timestamp. Converted to [`TicketResponse`] for the response.
/// ///
/// # Fields /// # Fields
/// - `category`: Ticket category/type /// - `category`: Ticket category/type
@@ -89,7 +90,7 @@ pub struct TicketCreateScheme {
/// Payload for updating a ticket. /// Payload for updating a ticket.
/// ///
/// Sent to `PATCH /api/tickets/{id}`. Currently only allows status updates. /// Sent to `PATCH /api/tickets/{id}`. Allows updating the ticket [`TicketResponse::status`].
/// Only admins can update tickets. /// Only admins can update tickets.
/// ///
/// # Fields /// # Fields
@@ -102,10 +103,10 @@ pub struct TicketUpdateScheme {
/// Payload for updating user information. /// Payload for updating user information.
/// ///
/// Sent to `PATCH /api/users/{id}`. Allows updating profile and admin status. /// Sent to `PATCH /api/users/{id}`. Allows updating profile and admin status.
/// Only admins can update users. Empty password field means no password change. /// Only admins can update [`User`] records. Empty password field means no password change.
/// ///
/// # Fields /// # Fields
/// - `id`: User ID to update /// - `id`: [`User`] ID to update
/// - `first_name`, `last_name`: Updated user name /// - `first_name`, `last_name`: Updated user name
/// - `username`: Updated login username /// - `username`: Updated login username
/// - `make_admin`: New admin privilege status /// - `make_admin`: New admin privilege status
@@ -123,7 +124,7 @@ pub struct UserUpdateScheme {
/// Payload for creating a new user account. /// Payload for creating a new user account.
/// ///
/// Used in both admin registration (`/api/register`) and initial setup (`/api/setup-admin`). /// Used in both admin registration (`/api/register`) and initial setup (`/api/setup-admin`).
/// The password is hashed server-side before storage using Argon2. /// The password is hashed server-side before storage using Argon2. Converted to [`User`] for storage.
/// ///
/// # Fields /// # Fields
/// - `first_name`: User's first name /// - `first_name`: User's first name
@@ -155,7 +156,7 @@ pub struct LoginScheme {
/// User information sent to clients, excluding password hashes. /// User information sent to clients, excluding password hashes.
/// ///
/// This is the safe version of User data that gets returned in API responses. /// This is the safe version of [`User`] data that gets returned in API responses.
/// It never includes the password hash or JWT claims. Always use this for responses /// It never includes the password hash or JWT claims. Always use this for responses
/// to prevent leaking sensitive data. /// to prevent leaking sensitive data.
#[derive(Debug, Clone, Serialize)] #[derive(Debug, Clone, Serialize)]
@@ -170,10 +171,10 @@ pub struct FilteredUser {
/// JWT token claims embedded in the session token. /// JWT token claims embedded in the session token.
/// ///
/// Contains user identification and token validity information. /// Contains user identification and token validity information.
/// Generated during login and verified by middleware on protected routes. /// Generated during login via `encode_token` and verified via `decode_token`.
/// ///
/// # Fields /// # Fields
/// - `sub`: Subject - the user ID as a string /// - `sub`: Subject - the user ID as a string (references [`User`])
/// - `issued`: Unix timestamp when token was created /// - `issued`: Unix timestamp when token was created
/// - `expires`: Unix timestamp when token expires (currently 1 hour from creation) /// - `expires`: Unix timestamp when token expires (currently 1 hour from creation)
/// ///
+17 -16
View File
@@ -19,30 +19,31 @@ use crate::{
/// Creates the complete router with all API endpoints. /// Creates the complete router with all API endpoints.
/// ///
/// The router is organized in layers for proper middleware application: /// The router is organized in layers for proper middleware application. Uses [`AppState`]
/// for shared application context across all routes.
/// ///
/// ## Route Layers (from most to least restricted): /// ## Route Layers (from most to least restricted):
/// ///
/// ### Admin-Only Routes (requires admin privilege + valid token) /// ### Admin-Only Routes (requires admin privilege + valid token)
/// - `GET /api/tickets/{id}` - Get specific ticket details /// - `GET /api/tickets/{id}` - Get specific ticket details (via `get_ticket_by_id`)
/// - `DELETE /api/tickets/{id}` - Delete a ticket /// - `DELETE /api/tickets/{id}` - Delete a ticket (via `delete_ticket`)
/// - `PATCH /api/tickets/{id}` - Update ticket status /// - `PATCH /api/tickets/{id}` - Update ticket status (via `edit_ticket`)
/// - `POST /api/register` - Create a new user /// - `POST /api/register` - Create a new user (via `create_user`)
/// - `GET /api/users` - List all users /// - `GET /api/users` - List all users (via `get_users`)
/// - `GET /api/users/{id}` - Get user details /// - `GET /api/users/{id}` - Get user details (via `get_user_by_id`)
/// - `DELETE /api/users/{id}` - Delete a user /// - `DELETE /api/users/{id}` - Delete a user (via `delete_user`)
/// - `PATCH /api/users/{id}` - Update user details /// - `PATCH /api/users/{id}` - Update user details (via `update_user`)
/// ///
/// ### Protected Routes (requires valid token) /// ### Protected Routes (requires valid token)
/// - `GET /api/tickets` - List all tickets /// - `GET /api/tickets` - List all tickets (via `get_tickets`)
/// - `POST /api/tickets/create` - Create a new ticket /// - `POST /api/tickets/create` - Create a new ticket (via `create_ticket`)
/// - `GET /api/logout` - Logout user /// - `GET /api/logout` - Logout user (via `logout`)
/// - `GET /api/users/current` - Get current authenticated user /// - `GET /api/users/current` - Get current authenticated user (via `get_current_user`)
/// ///
/// ### Public Routes (no authentication required) /// ### Public Routes (no authentication required)
/// - `POST /api/login` - User login /// - `POST /api/login` - User login (via `login`)
/// - `GET /api/check-admin` - Check if admin exists (for setup detection) /// - `GET /api/check-admin` - Check if admin exists (via `check_admin_exists`)
/// - `POST /api/setup-admin` - Create initial admin account (only if no admin exists) /// - `POST /api/setup-admin` - Create initial admin account (via `setup_initial_admin`)
/// ///
/// # Middleware Stack /// # Middleware Stack
/// - Admin routes have `validate_admin` middleware /// - Admin routes have `validate_admin` middleware
+5 -5
View File
@@ -33,14 +33,14 @@ pub struct ProtectedRouteProps {
/// A component that protects routes by enforcing authentication and optional administrator privileges. /// A component that protects routes by enforcing authentication and optional administrator privileges.
/// ///
/// This component fetches the current user's authentication and admin status from the /// This component uses the backend's validation middleware by fetching the current user's authentication
/// `/api/users/current` endpoint upon mounting. Based on the `AuthState` and the /// and admin status from the `/api/users/current` endpoint (which requires a valid JWT token).
/// `admin_page` property, it either renders its children or redirects the user. /// Based on the [`AuthState`] and the `admin_page` property, it either renders its children or redirects the user.
/// ///
/// # Behavior /// # Behavior
/// - **Initial Load**: Displays "Loading..." while checking authentication status. /// - **Initial Load**: Displays "Loading..." while checking authentication status via the backend.
/// - **Not Authenticated**: Redirects to the login page (`crate::Route::Login`). /// - **Not Authenticated**: Redirects to the login page (`crate::Route::Login`).
/// - **Authenticated**: /// - **Authenticated** (valid JWT token from backend):
/// - If `admin_page` is `true`: /// - If `admin_page` is `true`:
/// - If the user is an administrator (`is_admin: Some(true)`), it renders `children`. /// - If the user is an administrator (`is_admin: Some(true)`), it renders `children`.
/// - If the user is not an administrator (`is_admin: Some(false)`), it redirects to /// - If the user is not an administrator (`is_admin: Some(false)`), it redirects to
+75 -28
View File
@@ -10,7 +10,9 @@ use yew_router::prelude::*;
/// Defines the application's various routes and their corresponding paths. /// Defines the application's various routes and their corresponding paths.
/// ///
/// This enum is used by `yew-router` to map URLs to specific components, /// This enum is used by `yew-router` to map URLs to specific components,
/// enabling navigation within the single-page application. /// enabling navigation within the single-page application. Each route is protected
/// by [`ProtectedRoute`] middleware where appropriate to enforce authentication and authorization.
/// See [`switch`] for the routing logic.
#[derive(Clone, PartialEq, Routable)] #[derive(Clone, PartialEq, Routable)]
enum Route { enum Route {
/// The application's home page. /// The application's home page.
@@ -65,10 +67,17 @@ pub struct SidebarShellProps {
/// A shell component that provides a consistent layout with a sidebar and a main content area. /// A shell component that provides a consistent layout with a sidebar and a main content area.
/// ///
/// This component is designed to wrap page-specific content, ensuring that the sidebar /// This component is designed to wrap page-specific content, ensuring that the sidebar
/// is always present for navigation. /// is always present for navigation. Integrates with [`crate::pages::sidebar::Sidebar`] for navigation.
///
/// # Mobile Support
/// On mobile displays, the sidebar is hidden by default and can be toggled:
/// - **Menu Toggle Button**: Renders a floating menu button to slide the sidebar open.
/// - **Dark Mode Toggle**: Floating button to change theme.
/// - **Overlay Backdrop**: Dims the screen when the sidebar is open. Clicking it closes the sidebar.
/// - **Auto-Close on Navigation**: Automatically closes the sidebar when navigating to a new route.
/// ///
/// # Components /// # Components
/// - [`sidebar::Sidebar`]: The navigation sidebar component. /// - [`crate::pages::sidebar::Sidebar`]: The navigation sidebar component, accepting mobile open state.
/// - Main content area: Renders the `children` passed to this component. /// - Main content area: Renders the `children` passed to this component.
/// ///
/// # Example /// # Example
@@ -81,9 +90,46 @@ pub struct SidebarShellProps {
/// ``` /// ```
#[component(SidebarShell)] #[component(SidebarShell)]
fn sidebar_shell(props: &SidebarShellProps) -> Html { fn sidebar_shell(props: &SidebarShellProps) -> Html {
let route = use_route::<Route>();
let mobile_sidebar_open = use_state(|| false);
// Close mobile sidebar automatically on any route transition
{
let mobile_sidebar_open = mobile_sidebar_open.clone();
use_effect_with(route, move |_| {
mobile_sidebar_open.set(false);
|| ()
});
}
let on_open = {
let mobile_sidebar_open = mobile_sidebar_open.clone();
Callback::from(move |_: MouseEvent| mobile_sidebar_open.set(true))
};
let on_close = {
let mobile_sidebar_open = mobile_sidebar_open.clone();
Callback::from(move |_: ()| mobile_sidebar_open.set(false))
};
let on_close_click = {
let on_close = on_close.clone();
Callback::from(move |_: MouseEvent| on_close.emit(()))
};
html! { html! {
<div class="layout"> <div class="layout">
<sidebar::Sidebar/> <button class="mobile-menu-toggle" onclick={on_open}>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<line x1="4" x2="20" y1="12" y2="12"/>
<line x1="4" x2="20" y1="6" y2="6"/>
<line x1="4" x2="20" y1="18" y2="18"/>
</svg>
</button>
<div class={if *mobile_sidebar_open { "sidebar-overlay open" } else { "sidebar-overlay" }} onclick={on_close_click}></div>
<sidebar::Sidebar is_open={*mobile_sidebar_open} on_close={on_close} />
<main class="content"> <main class="content">
{ for props.children.iter() } { for props.children.iter() }
</main> </main>
@@ -91,6 +137,7 @@ fn sidebar_shell(props: &SidebarShellProps) -> Html {
} }
} }
/// Props for the AdminCheckWrapper component. /// Props for the AdminCheckWrapper component.
#[derive(Properties, PartialEq)] #[derive(Properties, PartialEq)]
pub struct AdminCheckWrapperProps { pub struct AdminCheckWrapperProps {
@@ -101,11 +148,11 @@ pub struct AdminCheckWrapperProps {
/// ///
/// This component is used to gate access to pages that should only be accessible before /// This component is used to gate access to pages that should only be accessible before
/// system initialization (e.g., login page). It performs an asynchronous check to the /// system initialization (e.g., login page). It performs an asynchronous check to the
/// `/api/check-admin` endpoint to determine system state. /// backend's `/api/check-admin` endpoint (via `crate::handlers::auth::check_admin_exists`) to determine system state.
/// ///
/// # Behavior /// # Behavior
/// - **Loading**: Displays "Loading..." while checking admin status /// - **Loading**: Displays "Loading..." while checking admin status from the backend
/// - **No Admin**: Automatically redirects to `/setup` page to initialize /// - **No Admin**: Automatically redirects to [`Route::Setup`] page for initialization
/// - **Admin Exists**: Renders the wrapped children (e.g., login page) /// - **Admin Exists**: Renders the wrapped children (e.g., login page)
/// ///
/// # Example Usage /// # Example Usage
@@ -115,19 +162,9 @@ pub struct AdminCheckWrapperProps {
/// </AdminCheckWrapper> /// </AdminCheckWrapper>
/// ``` /// ```
/// ///
/// # Implementation Detail /// # Backend Integration
/// The check happens in `use_effect_with` on component mount: /// The check queries the backend's `/api/check-admin` endpoint which returns `{"has_admin": bool}`.
/// ```ignore /// This allows the frontend to determine if initial admin setup is required.
/// spawn_local(async move {
/// match Request::get("/api/check-admin").send().await {
/// Ok(resp) if resp.status() == 200 => {
/// let has_admin = data["has_admin"].as_bool().unwrap_or(false);
/// admin_exists.set(Some(has_admin));
/// }
/// _ => admin_exists.set(Some(false))
/// }
/// });
/// ```
#[component(AdminCheckWrapper)] #[component(AdminCheckWrapper)]
fn admin_check_wrapper(props: &AdminCheckWrapperProps) -> Html { fn admin_check_wrapper(props: &AdminCheckWrapperProps) -> Html {
let admin_exists = use_state(|| None::<bool>); let admin_exists = use_state(|| None::<bool>);
@@ -166,18 +203,24 @@ fn admin_check_wrapper(props: &AdminCheckWrapperProps) -> Html {
/// The main routing logic for the application. /// The main routing logic for the application.
/// ///
/// This function takes a `Route` enum variant and returns the corresponding HTML /// This function takes a [`Route`] enum variant and returns the corresponding HTML
/// content to be rendered. It acts as a central dispatcher for the application's /// content to be rendered. It acts as a central dispatcher for the application's
/// navigation. /// navigation and authentication flow.
/// ///
/// Many routes are wrapped in a [`ProtectedRoute`] to enforce authentication /// Most routes are wrapped in [`ProtectedRoute`] to enforce authentication
/// and authorization, and in a [`SidebarShell`] to maintain consistent layout. /// and authorization based on the `admin_page` flag, and in [`SidebarShell`] to maintain consistent layout.
/// Login and Setup routes use [`AdminCheckWrapper`] instead to handle pre-authentication states.
/// ///
/// # Arguments /// # Arguments
/// - `route`: The [`Route`] enum variant representing the current URL path. /// - `route`: The [`Route`] enum variant representing the current URL path.
/// ///
/// # Returns /// # Returns
/// An `Html` component that should be rendered for the given route. /// An `Html` component that should be rendered for the given route.
///
/// # Route Protection
/// - **Admin-required routes** (`admin_page={true}`): Require both authentication and admin privileges
/// - **Public routes** (`admin_page={false}`): Require only authentication
/// - **Pre-auth routes** (`AdminCheckWrapper`): Used before admin creation or login
fn switch(route: Route) -> Html { fn switch(route: Route) -> Html {
match route { match route {
Route::Home => html! { Route::Home => html! {
@@ -259,12 +302,16 @@ fn switch(route: Route) -> Html {
/// The root component of the Yew application. /// The root component of the Yew application.
/// ///
/// This component sets up the application's routing using `yew-router`'s /// This component sets up the application's routing using `yew-router`'s
/// [`BrowserRouter`] and [`Switch`] components. All other application content /// `BrowserRouter` and `Switch` components. All other application content
/// is rendered based on the current route. /// is rendered based on the current [`Route`] matched by the `switch` function.
///
/// Uses [`switch`] as the routing dispatcher to handle all route-specific rendering,
/// which applies appropriate middleware like [`ProtectedRoute`] and [`AdminCheckWrapper`].
/// ///
/// # Structure /// # Structure
/// - [`BrowserRouter`]: Enables client-side routing. /// - `BrowserRouter`: Enables client-side routing.
/// - [`Switch`]: Renders components based on the matched [`Route`]. /// - `Switch`: Renders components based on the matched [`Route`].
/// - `switch` function: Determines which component to render for each route.
#[component(App)] #[component(App)]
pub fn app() -> Html { pub fn app() -> Html {
html! { html! {
+23
View File
@@ -3,6 +3,29 @@ use wasm_bindgen_futures::spawn_local;
use yew::prelude::*; use yew::prelude::*;
use yew_router::prelude::*; use yew_router::prelude::*;
/// Removes surrounding double quotes from a string.
///
/// This macro takes an expression that evaluates to a string and returns a new `String`
/// with any leading or trailing double quotes removed. It's useful for cleaning up
/// string data that might be inadvertently wrapped in quotes, such as JSON string values.
///
/// # Arguments
///
/// * `$str`: An expression that can be converted into a string slice (`&str`).
///
/// # Examples
///
/// ```rust
/// use your_crate::dequote; // Assuming `dequote` is re-exported or in scope
///
/// let quoted_string = "\"hello world\"";
/// let dequoted_string = dequote!(quoted_string);
/// assert_eq!(dequoted_string, "hello world");
///
/// let already_clean = "no quotes";
/// let dequoted_clean = dequote!(already_clean);
/// assert_eq!(dequoted_clean, "no quotes");
/// ```
macro_rules! dequote { macro_rules! dequote {
($str:expr) => { ($str:expr) => {
$str.trim_matches('"').to_string() $str.trim_matches('"').to_string()
+1 -1
View File
@@ -29,7 +29,7 @@ pub struct AdminSetupScheme {
/// a form to create the first admin user. Key functionality: /// a form to create the first admin user. Key functionality:
/// ///
/// - **Admin Check**: On mount, verifies if an admin already exists by calling `/api/check-admin`. /// - **Admin Check**: On mount, verifies if an admin already exists by calling `/api/check-admin`.
/// If an admin is found, the user is redirected to the login page (`crate::Route::Login`). /// If an admin is found, the user is redirected to the login page ([`crate::Route::Login`]).
/// - **Form Fields**: Collects `first_name`, `last_name`, `username`, `password`, and `confirm_password`. /// - **Form Fields**: Collects `first_name`, `last_name`, `username`, `password`, and `confirm_password`.
/// - **Form Validation**: /// - **Form Validation**:
/// - Ensures password fields are not empty. /// - Ensures password fields are not empty.
+72 -16
View File
@@ -7,6 +7,11 @@ use wasm_bindgen_futures::spawn_local;
use yew::prelude::*; use yew::prelude::*;
use yew_router::prelude::*; use yew_router::prelude::*;
/// The key used to store and retrieve the sidebar's expansion state in `LocalStorage`.
///
/// This constant ensures consistency when accessing the stored state across different
/// parts of the application. The value associated with this key in `LocalStorage`
/// will be a serialized [`SidebarExpandState`] object.
const STORAGE_KEY: &str = "sidebar_state"; const STORAGE_KEY: &str = "sidebar_state";
/// Represents the expansion state of collapsible menus within the sidebar. /// Represents the expansion state of collapsible menus within the sidebar.
@@ -128,7 +133,7 @@ pub fn sidebar_state_provider(props: &SidebarProps) -> Html {
Callback::from(move |v: bool| { Callback::from(move |v: bool| {
state.set(SidebarExpandState { state.set(SidebarExpandState {
ticket_open: v, ticket_open: v,
users_open: (*state).users_open, users_open: state.users_open,
}) })
}) })
}; };
@@ -136,10 +141,10 @@ pub fn sidebar_state_provider(props: &SidebarProps) -> Html {
let toggle_tickets = { let toggle_tickets = {
let state = state.clone(); let state = state.clone();
Callback::from(move |_| { Callback::from(move |_| {
let current = (*state).ticket_open; let current = state.ticket_open;
state.set(SidebarExpandState { state.set(SidebarExpandState {
ticket_open: !current, ticket_open: !current,
users_open: (*state).users_open, users_open: state.users_open,
}); });
}) })
}; };
@@ -148,7 +153,7 @@ pub fn sidebar_state_provider(props: &SidebarProps) -> Html {
let state = state.clone(); let state = state.clone();
Callback::from(move |v: bool| { Callback::from(move |v: bool| {
state.set(SidebarExpandState { state.set(SidebarExpandState {
ticket_open: (*state).ticket_open, ticket_open: state.ticket_open,
users_open: v, users_open: v,
}) })
}) })
@@ -157,9 +162,9 @@ pub fn sidebar_state_provider(props: &SidebarProps) -> Html {
let toggle_users = { let toggle_users = {
let state = state.clone(); let state = state.clone();
Callback::from(move |_| { Callback::from(move |_| {
let current = (*state).users_open; let current = state.users_open;
state.set(SidebarExpandState { state.set(SidebarExpandState {
ticket_open: (*state).ticket_open, ticket_open: state.ticket_open,
users_open: !current, users_open: !current,
}); });
}) })
@@ -314,6 +319,11 @@ pub fn users_menu() -> Html {
/// and administrative status. It fetches the current user's details via `/api/users/current` /// and administrative status. It fetches the current user's details via `/api/users/current`
/// to determine what menu items to display. /// to determine what menu items to display.
/// ///
/// # Mobile Support
/// On small screens:
/// - Slides into view from the left when `props.is_open` is `true`.
/// - Renders a close button (`✕`) in the header that emits `props.on_close`.
///
/// # Structure /// # Structure
/// - Wraps its content in a [`SidebarStateProvider`] to allow nested menus to manage their state. /// - Wraps its content in a [`SidebarStateProvider`] to allow nested menus to manage their state.
/// - Contains a navigation (`<nav>`) element with an unordered list (`<ul>`) of menu items. /// - Contains a navigation (`<nav>`) element with an unordered list (`<ul>`) of menu items.
@@ -332,8 +342,22 @@ pub fn users_menu() -> Html {
/// # Logout Functionality /// # Logout Functionality
/// The "Logout" button sends a GET request to `/api/logout`, clears the user's session, /// The "Logout" button sends a GET request to `/api/logout`, clears the user's session,
/// and then redirects the user to the login page (`crate::Route::Login`). /// and then redirects the user to the login page (`crate::Route::Login`).
/// Properties for the [`Sidebar`] component.
///
/// These properties enable managing and controlling the responsive mobile sidebar
/// layout and its visibility settings.
#[derive(Properties, PartialEq)]
pub struct SidebarComponentProps {
/// A boolean flag indicating whether the mobile sidebar is currently slid open (`true`) or hidden (`false`).
#[prop_or_default]
pub is_open: bool,
/// A callback emitted when the user requests to close/hide the mobile sidebar.
#[prop_or_default]
pub on_close: Callback<()>,
}
#[component(Sidebar)] #[component(Sidebar)]
pub fn sidebar() -> Html { pub fn sidebar(props: &SidebarComponentProps) -> Html {
let is_admin = use_state(|| None::<bool>); let is_admin = use_state(|| None::<bool>);
let navigator = use_navigator().expect("Sidebar must be used within a Router"); let navigator = use_navigator().expect("Sidebar must be used within a Router");
@@ -374,34 +398,65 @@ pub fn sidebar() -> Html {
}; };
match *is_admin { match *is_admin {
None => html! { <div class="sidebar-loading">{ "Loading..." }</div> }, None => html! { <div class="sidebar-loading">{ "Lade..." }</div> },
// Non-admin: render a condensed user sidebar (no diagnostics, limited links) // Non-admin: render a condensed user sidebar (no diagnostics, limited links)
Some(false) => html! { Some(false) => {
let on_close = props.on_close.clone();
html! {
<SidebarStateProvider> <SidebarStateProvider>
<nav class="sidebar user"> <nav class={if props.is_open { "sidebar user open" } else { "sidebar user" }}>
<ul> <ul>
<Link<crate::Route> to={crate::Route::Home}>{ "󰟒" }</Link<crate::Route>> <li class="sidebar-header">
<Link<crate::Route> to={crate::Route::Home} classes="home">
<svg xmlns="http://www.w3.org/2000/svg" class="home-svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<path d="m3 9 9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"/>
<polyline points="9 22 9 12 15 12 15 22"/>
</svg>
</Link<crate::Route>>
<button class="sidebar-close" onclick={move |_| on_close.emit(())}>
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<line x1="18" y1="6" x2="6" y2="18"/>
<line x1="6" y1="6" x2="18" y2="18"/>
</svg>
</button>
</li>
<TicketMenu/> <TicketMenu/>
<li class="logout-item"> <li class="logout-item">
<button <button
class="logout-button" class="logout-button"
onclick={on_logout.clone()} onclick={on_logout.clone()}
> >
{ "Logout" } { "Abmelden" }
</button> </button>
</li> </li>
</ul> </ul>
</nav> </nav>
</SidebarStateProvider> </SidebarStateProvider>
}
}, },
// Admin: full sidebar wrapped in provider so submenu state persists // Admin: full sidebar wrapped in provider so submenu state persists
Some(true) => html! { Some(true) => {
let on_close = props.on_close.clone();
html! {
<SidebarStateProvider> <SidebarStateProvider>
<nav class="sidebar admin"> <nav class={if props.is_open { "sidebar admin open" } else { "sidebar admin" }}>
<ul> <ul>
<Link<crate::Route> to={crate::Route::Home}>{ "󰟒" }</Link<crate::Route>> <li class="sidebar-header">
<Link<crate::Route> to={crate::Route::Home} classes="home">
<svg xmlns="http://www.w3.org/2000/svg" class="home-svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<path d="m3 9 9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"/>
<polyline points="9 22 9 12 15 12 15 22"/>
</svg>
</Link<crate::Route>>
<button class="sidebar-close" onclick={move |_| on_close.emit(())}>
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<line x1="18" y1="6" x2="6" y2="18"/>
<line x1="6" y1="6" x2="18" y2="18"/>
</svg>
</button>
</li>
<TicketMenu/> <TicketMenu/>
<UsersMenu/> <UsersMenu/>
<Link<crate::Route> to={crate::Route::Diagnostics}>{ "Statistiken" }</Link<crate::Route>> <Link<crate::Route> to={crate::Route::Diagnostics}>{ "Statistiken" }</Link<crate::Route>>
@@ -411,12 +466,13 @@ pub fn sidebar() -> Html {
class="logout-button" class="logout-button"
onclick={on_logout.clone()} onclick={on_logout.clone()}
> >
{ "Logout" } { "Abmelden" }
</button> </button>
</li> </li>
</ul> </ul>
</nav> </nav>
</SidebarStateProvider> </SidebarStateProvider>
}
}, },
} }
} }
+3 -3
View File
@@ -313,7 +313,7 @@ pub fn submit_ticket_component() -> Html {
{ {
if !room_valid { if !room_valid {
html! { html! {
<p style="color: red;">{ "Ungültiger oder nicht erlaubter Raum (z. B. 101, K12, D5)" }</p> <p class="warning" >{ "Ungültiger / nicht erlaubter Raum (z. B. 101, K12, D5)" }</p>
} }
} else { } else {
html! {} html! {}
@@ -807,9 +807,9 @@ pub fn archived_tickets_component() -> Html {
html! { <p>{ format!("Error: {}", e) }</p> } html! { <p>{ format!("Error: {}", e) }</p> }
} else { } else {
html! { html! {
<ul> <ul class="postits">
{ for tickets.iter().filter(|t| t.status == "Archived" && (user.is_admin || if let Some(uid) = user.id { t.user_id == uid } else { false })).map(|t| html! { { for tickets.iter().filter(|t| t.status == "Archived" && (user.is_admin || if let Some(uid) = user.id { t.user_id == uid } else { false })).map(|t| html! {
<div> <div class="listbox">
<li key={t.id.to_string()}> <li key={t.id.to_string()}>
<Link<crate::Route> to={crate::Route::TicketById{id: t.id}}><h3>{ format!("{} - #{}", t.betreff, t.id) }</h3></Link<crate::Route>> <Link<crate::Route> to={crate::Route::TicketById{id: t.id}}><h3>{ format!("{} - #{}", t.betreff, t.id) }</h3></Link<crate::Route>>
<p>{ &t.description }</p> <p>{ &t.description }</p>
+9 -1
View File
@@ -102,6 +102,14 @@ pub struct UserProps {
pub id: i16, pub id: i16,
} }
/// Represents an error response from the API.
///
/// This struct is used to deserialize error messages received from the backend API.
/// It typically contains a human-readable message and an internal status code.
///
/// # Fields
/// - `message`: A `String` containing a description of the error.
/// - `_status`: An internal status code or message, often ignored in frontend display.
#[derive(Deserialize, Debug)] #[derive(Deserialize, Debug)]
struct ApiError { struct ApiError {
message: String, message: String,
@@ -425,7 +433,7 @@ pub fn all_users_component() -> Html {
html! { <p>{ format!("Error: {}", e) }</p> } html! { <p>{ format!("Error: {}", e) }</p> }
} else { } else {
html! { html! {
<ul class="posti8s"> <ul class="postits">
{ for users.iter().map(|t| html! { { for users.iter().map(|t| html! {
<li key={t.id.to_string()} class="listbox"> <li key={t.id.to_string()} class="listbox">
<Link<crate::Route> to={crate::Route::UserByID{id: t.id}}><h3>{ format!("{} {}- #{}", t.first_name, t.last_name, t.id) }</h3></Link<crate::Route>> <Link<crate::Route> to={crate::Route::UserByID{id: t.id}}><h3>{ format!("{} {}- #{}", t.first_name, t.last_name, t.id) }</h3></Link<crate::Route>>
+10 -9
View File
@@ -28,7 +28,7 @@ struct TicketPartial {
/// for calculating and visualizing ticket distribution per room. /// for calculating and visualizing ticket distribution per room.
/// ///
/// # Fields /// # Fields
/// - `tickets`: A vector of `TicketPartial` containing ticket data relevant for room totals. /// - `tickets`: A vector of [`TicketPartial`] containing ticket data relevant for room totals.
#[derive(Properties, PartialEq)] #[derive(Properties, PartialEq)]
struct RoomTotalsProps { struct RoomTotalsProps {
tickets: Vec<TicketPartial>, tickets: Vec<TicketPartial>,
@@ -64,7 +64,7 @@ fn weekday_index(dt: &DateTime<Utc>) -> usize {
/// the total count of tickets submitted on that day. /// the total count of tickets submitted on that day.
/// ///
/// # Arguments /// # Arguments
/// - `tickets`: A slice of `TicketPartial` items to count. /// - `tickets`: A slice of [`TicketPartial`] items to count.
/// ///
/// # Returns /// # Returns
/// An array `[usize; 7]` with ticket counts for each weekday. /// An array `[usize; 7]` with ticket counts for each weekday.
@@ -78,12 +78,12 @@ fn count_by_weekday(tickets: &[TicketPartial]) -> [usize; 7] {
/// Calculates the occurrences of each weekday within the date range covered by the tickets. /// Calculates the occurrences of each weekday within the date range covered by the tickets.
/// ///
/// This function determines the minimum and maximum dates from the provided `TicketPartial` /// This function determines the minimum and maximum dates from the provided [`TicketPartial`]
/// slice and then counts how many times each weekday occurs within that inclusive date range. /// slice and then counts how many times each weekday occurs within that inclusive date range.
/// This is useful for normalizing ticket counts against the number of available days for each weekday. /// This is useful for normalizing ticket counts against the number of available days for each weekday.
/// ///
/// # Arguments /// # Arguments
/// - `partials`: A slice of `TicketPartial` items defining the date range. /// - `partials`: A slice of [`TicketPartial`] items defining the date range.
/// ///
/// # Returns /// # Returns
/// An array `[usize; 7]` where each element represents the number of times a /// An array `[usize; 7]` where each element represents the number of times a
@@ -132,7 +132,8 @@ fn day_counts(partials: &[TicketPartial]) -> [usize; 7] {
/// Converts a numerical room representation back into a human-readable string format. /// Converts a numerical room representation back into a human-readable string format.
/// ///
/// This function is the inverse of the room parsing logic in `SubmitTicket` component. /// This function is the inverse of the room parsing logic in
/// [`SubmitTicket`](`crate::pages::ticket::SubmitTicket`) component.
/// It converts negative numbers back to "K" prefixed rooms, numbers >= 1000 back to "D" prefixed rooms, /// It converts negative numbers back to "K" prefixed rooms, numbers >= 1000 back to "D" prefixed rooms,
/// and other numbers to their string representation. /// and other numbers to their string representation.
/// ///
@@ -303,12 +304,12 @@ pub fn ticket_count_component() -> Html {
/// ///
/// # State /// # State
/// Uses `use_state` hooks to manage: /// Uses `use_state` hooks to manage:
/// - `tickets`: A vector of `TicketPartial` for statistical analysis. /// - `tickets`: A vector of [`TicketPartial`] for statistical analysis.
/// - `error`: Any error message from API calls. /// - `error`: Any error message from API calls.
/// - `loading`: A boolean indicating if data is being fetched. /// - `loading`: A boolean indicating if data is being fetched.
/// ///
/// # Functionality /// # Functionality
/// - Fetches all tickets (as `TicketPartial`) from `/api/tickets`. /// - Fetches all tickets (as [`TicketPartial`]) from `/api/tickets`.
/// - Calculates: /// - Calculates:
/// - `counts`: Number of tickets submitted on each weekday. /// - `counts`: Number of tickets submitted on each weekday.
/// - `occ`: Number of occurrences of each weekday in the ticket date range. /// - `occ`: Number of occurrences of each weekday in the ticket date range.
@@ -421,7 +422,7 @@ pub fn submit_stats_component() -> Html {
/// A component that displays the total number of tickets per room. /// A component that displays the total number of tickets per room.
/// ///
/// This component takes a list of `TicketPartial` items and calculates the /// This component takes a list of [`TicketPartial`] items and calculates the
/// total number of tickets for each room. It then displays these totals /// total number of tickets for each room. It then displays these totals
/// in a sorted list with a bar chart visualization. /// in a sorted list with a bar chart visualization.
/// ///
@@ -433,7 +434,7 @@ pub fn submit_stats_component() -> Html {
/// - **Sorts Results**: Displays rooms sorted by ticket count in descending order. /// - **Sorts Results**: Displays rooms sorted by ticket count in descending order.
/// - **Visualizes Data**: Renders a bar chart where the width of each bar is /// - **Visualizes Data**: Renders a bar chart where the width of each bar is
/// proportional to the ticket count for that room, relative to the room with the maximum tickets. /// proportional to the ticket count for that room, relative to the room with the maximum tickets.
/// - **Room Formatting**: Uses the `parse_room` function to display room numbers /// - **Room Formatting**: Uses the [`parse_room`] function to display room numbers
/// in a human-readable format. /// in a human-readable format.
/// ///
/// # Example /// # Example
+12 -1
View File
@@ -1,3 +1,4 @@
:root{
$color-bg: #ffffff; $color-bg: #ffffff;
$color-sidebar: #570000; $color-sidebar: #570000;
$color-accent: #2563eb; $color-accent: #2563eb;
@@ -5,4 +6,14 @@ $color-muted: #6b7280;
$spacing-sm: 8px; $spacing-sm: 8px;
$spacing-md: 16px; $spacing-md: 16px;
$border-radius: 6px; $border-radius: 6px;
$rundbgbackgroundcolor: #a0a0a0; $rundbgbackgroundcolor: #a0a0a0
}
@media (prefers-color-scheme: dark) {
:root {
$color-bg: #000000;
$color-sidebar: #f3ff73;
}
}
+10
View File
@@ -10,8 +10,18 @@
justify-content: center; justify-content: center;
padding: 0; padding: 0;
@media (max-width: 768px) {
max-width: 60px;
img {
width: 100%;
height: auto;
}
}
img { img {
width: auto; width: auto;
height: auto; height: auto;
} }
} }
+130 -14
View File
@@ -4,31 +4,30 @@
.sidebar { .sidebar {
width: 260px; width: 260px;
background: $color-sidebar; background: $color-sidebar;
color: #fffefe; color: #fff;
min-height: 100%; min-height: 100%;
padding: $spacing-md; padding: $spacing-md;
display: flex; display: flex;
flex-direction: column; flex-direction: column;
ul { list-style: none; margin: 0; padding: 0; display: flex; flex-direction: column; gap: $spacing-sm; flex: 1; } ul { list-style: none; margin: 0; padding: 0; display: flex; flex-direction: column; gap: $spacing-sm; flex: 1; }
a, .menu-toggle { a, .menu-toggle {
color: #ffffff; color: #fff;
text-decoration: none; text-decoration: none;
display: block; display: block;
padding: 8px 12px; padding: 8px 12px;
border-radius: 4px; border-radius: $border-radius;
&:hover { background: rgba(158, 45, 1, 0.842); } transition: background 0.2s ease-in-out;
&:hover { background: rgba(255,255,255,0.1); }
} }
.menu-toggle { background: #ff5a316c; border: none; text-align: left; width: 100%; cursor: pointer; } .menu-toggle { background: transparent; border: none; text-align: left; width: 100%; cursor: pointer; }
.submenu { .submenu {
margin-left: 8px; margin-left: 8px;
background: rgba(255,255,255,0.02); background: rgba(255,255,255,0.05);
border-radius: 4px; border-radius: $border-radius;
padding: 6px; padding: 6px;
li { padding: 4px 0; } li { padding: 4px 0; }
} }
@@ -40,18 +39,135 @@
} }
.logout-button { .logout-button {
background: rgba(255, 93, 43, 0.527); background: rgba(255, 255, 255, 0.1);
color: #ffffff; color: #fff;
border: 1px solid rgba(255, 255, 255, 0.801); border: 1px solid rgba(255, 255, 255, 0.2);
padding: 8px 12px; padding: 8px 12px;
border-radius: 4px; border-radius: 4px;
width: 100%; width: 100%;
cursor: pointer; cursor: pointer;
text-align: left; text-align: left;
&:hover { background: rgba(255,255,255,0.15); } }
&:active { background: rgba(255,255,255,0.2); }
.sidebar-header {
display: flex;
align-items: center;
justify-content: space-between;
width: 100%;
margin-bottom: $spacing-md;
.home {
flex-grow: 1;
display: flex;
justify-content: center;
@media (max-width: 768px) {
padding-left: 36px;
}
}
.sidebar-close {
display: none;
background: transparent;
border: none;
color: #fff;
cursor: pointer;
padding: 8px;
border-radius: 50%;
align-items: center;
justify-content: center;
transition: background 0.2s ease-in-out;
margin-bottom: 0;
&:hover {
background: rgba(255, 255, 255, 0.1);
}
svg {
width: 20px;
height: 20px;
stroke: #fff;
}
@media (max-width: 768px) {
display: flex;
}
}
}
.home-svg {
width: 24px;
height: 24px;
vertical-align: middle;
margin-right: 8px;
} }
&.user { width: 220px; background: darken($color-sidebar, 6%); } &.user { width: 220px; background: darken($color-sidebar, 6%); }
} }
// Floating mobile menu toggle button
.mobile-menu-toggle {
display: none;
@media (max-width: 768px) {
display: flex;
position: fixed;
top: 1rem;
left: 1rem;
z-index: 998;
width: 48px;
height: 48px;
border-radius: 50%;
border: 1px solid rgba(128, 128, 128, 0.2);
background-color: var(--color-container);
color: var(--color-text);
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
cursor: pointer;
align-items: center;
justify-content: center;
padding: 0;
transition: all 0.2s ease-in-out;
svg {
width: 24px;
height: 24px;
stroke: var(--color-text);
transition: stroke 0.2s ease-in-out;
}
&:hover {
transform: translateY(-1px);
box-shadow: 0 6px 16px rgba(0, 0, 0, 0.2);
background-color: var(--color-bg);
}
&:active {
transform: translateY(0);
}
}
}
// Overlay backdrop that dims the screen and allows dismissals on mobile
.sidebar-overlay {
display: none;
@media (max-width: 768px) {
display: block;
position: fixed;
top: 0;
left: 0;
width: 100vw;
height: 100vh;
background: rgba(0, 0, 0, 0.4);
backdrop-filter: blur(4px);
z-index: 999;
opacity: 0;
pointer-events: none;
transition: opacity 0.3s ease-in-out;
&.open {
opacity: 1;
pointer-events: auto;
}
}
}
@@ -16,6 +16,7 @@
.listbox { .listbox {
max-width: auto; max-width: auto;
margin:0 0; margin:0 0;
background-color: #90ff82;
background-color: $rundbgbackgroundcolor; background-color: $rundbgbackgroundcolor;
padding-bottom: 96px; padding-bottom: 96px;
color: white; color: white;
@@ -51,4 +52,8 @@
display: grid; display: grid;
grid-template-columns: auto auto auto; grid-template-columns: auto auto auto;
gap: 8px; gap: 8px;
margin-top: 96px;
}
.warning {
color: #570000;
} }
+30 -4
View File
@@ -8,6 +8,20 @@
@use "components/home"; @use "components/home";
@use "components/icon"; @use "components/icon";
:root {
--color-bg: #ffffff;
--color-container: #ffffff;
--color-text: #111827;
}
@media (prefers-color-scheme: dark) {
:root {
--color-bg: #121212;
--color-container: #333333;
--color-text: #e2e2e2;
}
}
body { body {
background: variables.$color-bg; background: variables.$color-bg;
font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial; font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial;
@@ -27,7 +41,10 @@ body {
.sidebar { .sidebar {
width: 260px; width: 260px;
flex-shrink: 0; flex-shrink: 0;
height: 100%; position: fixed;
left: 0;
top: 0;
height: 100vh;
overflow-y: auto; overflow-y: auto;
box-sizing: border-box; box-sizing: border-box;
} }
@@ -35,6 +52,7 @@ body {
.content { .content {
flex: 1; flex: 1;
min-width: 0; min-width: 0;
margin-left: 260px;
height: 100%; height: 100%;
overflow-y: auto; overflow-y: auto;
padding: variables.$spacing-md; padding: variables.$spacing-md;
@@ -46,8 +64,8 @@ body {
position: fixed; position: fixed;
top: 0; top: 0;
bottom: 0; bottom: 0;
left: -100%; left: -260px;
transition: left .2s; transition: left .3s ease-in-out;
z-index: 1000; z-index: 1000;
height: 100%; height: 100%;
box-sizing: border-box; box-sizing: border-box;
@@ -80,7 +98,7 @@ body {
box-sizing: border-box; box-sizing: border-box;
} }
input, select, button { input, select, button, a {
width: 100%; width: 100%;
box-sizing: border-box; box-sizing: border-box;
padding: 16px; padding: 16px;
@@ -98,6 +116,12 @@ body {
margin: 16px 0; margin: 16px 0;
} }
a {
color: #000000;
text-align: center;
border-style: dashed;
}
&.login { &.login {
margin-top: 96px; margin-top: 96px;
} }
@@ -107,3 +131,5 @@ body {
width: 100%; width: 100%;
box-sizing: border-box; box-sizing: border-box;
} }
+1 -1
View File
@@ -1 +1 @@
#![doc = include_str!("../README.md")] #![doc = include_str!("../README.cargo.md")]