v0.3.4 initial release

.github/workflows/pr.yaml

@@ -7,22 +7,22 @@ on:
       - "v[0-9]+.[0-9]+.[0-9]+"
 
 jobs:
-  test_frontend:
-    name: Push release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
-      - name: Build
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          file: ./Dockerfile.playwright
-          push: false
+  #test_frontend:
+  #  name: Push release
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - name: Checkout
+  #      uses: actions/checkout@v4
+  #    - name: Set up QEMU
+  #      uses: docker/setup-qemu-action@v3.0.0
+  #    - name: Set up Docker Buildx
+  #      uses: docker/setup-buildx-action@v3.0.0
+  #    - name: Build
+  #      uses: docker/build-push-action@v6
+  #      with:
+  #        context: .
+  #        file: ./Dockerfile.playwright
+  #        push: false
   push_pr_to_registry:
     name: Push PR
     runs-on: ubuntu-latest

.github/workflows/regular-tests.yaml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-            go-version: '1.22.5'
+            go-version: '1.23.3'
       - uses: golangci/golangci-lint-action@v5
         with:
           version: v1.60
@@ -41,4 +41,11 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
       - working-directory: frontend
-        run: npm i eslint && npm run lint
+        run: npm i && npm run lint
+  test-frontend:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - working-directory: frontend
+        run: npm i && npm run test

.github/workflows/release_dev.yaml

@@ -10,7 +10,7 @@ permissions:
 
 jobs:
   push_release_to_registry:
-    name: Push dev release
+    name: Push release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -35,16 +35,16 @@ jobs:
           JSON="${{ steps.meta.outputs.tags }}"
           # Use jq to remove 'v' from the version field
           JSON=$(echo "$JSON" | sed 's/filebrowser:v/filebrowser:/')
-          echo "CLEANED_TAG=$JSON" >> $GITHUB_ENV
+          echo "cleaned_tag=$JSON" >> $GITHUB_OUTPUT
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
+          context: .
           build-args: |
             VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
             REVISION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}
-          context: .
           platforms: linux/amd64
           file: ./Dockerfile
           push: true
-          tags: ${{ env.CLEANED_TAG }}
+          tags: ${{ steps.modify-json.outputs.cleaned_tag }}
           labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -13,6 +13,7 @@ rice-box.go
 /backend/*.cov
 /backend/test_config.yaml
 /backend/srv
+/backend/http/dist
 
 .DS_Store
 node_modules

CHANGELOG.md

@@ -2,6 +2,92 @@
 
 All notable changes to this project will be documented in this file. For commit guidelines, please refer to [Standard Version](https://github.com/conventional-changelog/standard-version).
 
+## v0.3.4
+
+  **Bugfixes**:
+  - Safari right-click actions.
+  - Some small image viewer behavior
+  - Progressive webapp "install to homescreen" fix. 
+
+## v0.3.3
+
+  **New Features**
+  - Navigating remembers your previous scroll position when opening items and then navigating backwards.
+  - New Icons with larger selection of file types
+  - file "type" is shown on item info page.
+  - added optional non-root "filebrowser" user for docker image. See https://github.com/gtsteffaniak/filebrowser/issues/251
+  - File preview supports more file types:
+    - images: jpg, bmp, gif, tiff, png, svg, heic, webp
+
+  **Notes**:
+  - The file "type" is now either "directory" or a specific mimetype such as "text/xml".
+  - update safari styling
+
+  **Bugfixes**:
+  - Delete/move file/folders sometimes wouldn't work.
+  - Possible fix for context menu not showing issue. See https://github.com/gtsteffaniak/filebrowser/issues/251
+  - Fixed drag/drop not refreshing immediately to reflect changes.
+
+## v0.3.2
+
+  **New Features**
+  - Mobile search has the same features as desktop.
+
+  **Notes**:
+  - Added compression. Helpful for browsing folders with a large number of items. Considering https://github.com/gtsteffaniak/filebrowser/issues/201 resolved, although future pagination support will still come.
+  - Compressed download options limited to `.zip` and `.tar.gz`
+  - right-click context menu stays in view.
+
+  **Bugfixes**:
+  - search result links when non-default baseUrl configured
+  - frontend sort bug squashed https://github.com/gtsteffaniak/filebrowser/issues/230
+  - bug which caused "noauth" method not to work after v0.3.0 routes update
+
+## v0.3.1
+
+  **New Features**
+  - Adds Smart Indexing by default.
+
+  **Notes**:
+  - Optimized api request response times via improved caching and simplified actions.
+  - User information persists more reliably.
+  - Added [indexing doc](./docs/indexing.md) to explain the expectations around indexing and how it works.
+  - The index should also use less RAM than it did in v0.3.0.
+
+  **Bugfixes**:
+  - Tweaked sorting by name, fixes case sensitive and numeric sorting. https://github.com/gtsteffaniak/filebrowser/issues/230
+  - Fixed unnecessary authentication status checks each route change
+  - Fix create file action issue.
+  - some small javascript related issues.
+  - Fixes pretty big bug viewing raw content in v0.3.0 (utf format message)
+
+## v0.3.0
+
+  This Release focuses on the API and making it more accessible for developers to access functions without the UI.
+
+  **New Features**:
+  - You can now long-live api tokens to interact with API from the user settings page.
+    - These tokens have the same permissions as your user.
+  - Helpful swagger page for API usage.
+  - Some API's were refactored for friendlier API usage, moving some attributes to parameters and first looking for a api token, then using the stored cookie if none is found. This allows for all api requests from swagger page to work without a token.
+  - Add file size to search preview! Should have been in last release... sorry!
+
+  **Notes**:
+  - Replaced backend http framework with go standard library.
+  - Right-click Context menu can target the item that was right-clicked. To fully address https://github.com/gtsteffaniak/filebrowser/issues/214
+  - adjusted settings menu for mobile, always shows all available cards rather than grayed out cards that need to be clicked.
+  - longer and more cryptographically secure share links based on UUID rather than base64.
+
+  **Bugfixes**:
+  - Fixed ui bug with shares with password.
+  - Fixes baseurl related bugs https://github.com/gtsteffaniak/filebrowser/pull/228 Thanks @SimLV
+  - Fixed empty directory load issue.
+  - Fixed image preview cutoff on mobile.
+  - Fixed issue introduced in v0.2.10 where new files and folders were not showing up on ui
+  - Fixed preview issue where preview would not load after viewing video files.
+  - Fixed sorting issue where files were not sorted by name by default.
+  - Fixed copy file prompt issue
+
 ## v0.2.10
 
   **New Features**:
@@ -15,9 +101,9 @@ All notable changes to this project will be documented in this file. For commit
   - Fixed issue searching "smaller than" actually returned files "larger than"
 
   **Notes**:
-    - Memory usage from index is reduced by ~40%
-    - Indexing time has increased 2x due to the extra processing time required to calculate directory sizes.
-    - File size calcuations use 1024 base vs previous 1000 base (matching windows explorer)
+  - Memory usage from index is reduced by ~40%
+  - Indexing time has increased 2x due to the extra processing time required to calculate directory sizes.
+  - File size calculations use 1024 base vs previous 1000 base (matching windows explorer)
 
 ## v0.2.9
 
@@ -40,7 +126,7 @@ All notable changes to this project will be documented in this file. For commit
 
 ## v0.2.8
 
-- **Feature**: New gallary view scaling options (closes [#141](https://github.com/gtsteffaniak/filebrowser/issues/141))
+- **Feature**: New gallery view scaling options (closes [#141](https://github.com/gtsteffaniak/filebrowser/issues/141))
 - **Change**: Refactored backend files functions
 - **Change**: Improved UI response to filesystem changes
 - **Change**: Added frontend tests for deployment integrity
@@ -126,7 +212,7 @@ This change focuses on minimizing and simplifying build process.
 - The shell feature has been deprecated.
   - Custom commands can be executed within the Docker container if needed.
 - The JSON config file is no longer used.
-  - All configurations are now performed via the advanced `filebrowser.yaml`.
+  - All configurations are now performed via the advanced `config.yaml`.
   - The only allowed flag is specifying the config file.
 - Removed old code for migrating database versions.
 - Eliminated all unused `cmd` code.

Dockerfile

@@ -1,8 +1,10 @@
-FROM golang:1.22-alpine AS base
+FROM golang:1.23-alpine AS base
 ARG VERSION
 ARG REVISION
 WORKDIR /app
 COPY ./backend ./
+#RUN swag init --output swagger/docs
+RUN ln -s swagger /usr/local/go/src/
 RUN go build -ldflags="-w -s \
   -X 'github.com/gtsteffaniak/filebrowser/version.Version=${VERSION}' \
   -X 'github.com/gtsteffaniak/filebrowser/version.CommitSHA=${REVISION}'" \
@@ -18,6 +20,12 @@ RUN npm run build-docker
 FROM alpine:latest
 ENV FILEBROWSER_NO_EMBEDED="true"
 RUN apk --no-cache add ca-certificates mailcap
-COPY --from=base /app/filebrowser* ./
-COPY --from=nbuild /app/dist/ ./frontend/dist/
+WORKDIR /home/filebrowser
+RUN adduser -D -s /bin/true -u 1000 filebrowser
+USER filebrowser
+COPY --from=base --chown=filebrowser:1000 /app/filebrowser* ./
+COPY --from=nbuild --chown=filebrowser:1000 /app/dist/ ./http/dist/
+USER root
+# exposing default port for auto discovery.
+EXPOSE 80
 ENTRYPOINT [ "./filebrowser" ]

Dockerfile.playwright

@@ -1,4 +1,4 @@
-FROM golang:1.22-alpine AS base
+FROM golang:1.23-alpine AS base
 WORKDIR /app
 COPY ./backend ./
 RUN go build -ldflags="-w -s" -o filebrowser .
@@ -8,7 +8,7 @@ WORKDIR /app
 COPY ./frontend/package.json ./
 RUN npm i --maxsockets 1
 RUN npx playwright install --with-deps firefox
-COPY [ "backend/filebrowser.yaml", "./" ]
+COPY [ "backend/config.yaml", "./" ]
 COPY  ./frontend/ ./frontend
 WORKDIR /app/frontend
 RUN npm run build-docker

README.md

@@ -6,45 +6,58 @@
 </p>
 <h3 align="center">FileBrowser Quantum - A modern web-based file manager</h3>
 <p align="center">
-  <img width="800" src="https://private-user-images.githubusercontent.com/42989099/367975355-3d6f4619-4985-4ce3-952f-286510dff4f1.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjgxNTA2MjEsIm5iZiI6MTcyODE1MDMyMSwicGF0aCI6Ii80Mjk4OTA5OS8zNjc5NzUzNTUtM2Q2ZjQ2MTktNDk4NS00Y2UzLTk1MmYtMjg2NTEwZGZmNGYxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDEwMDUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQxMDA1VDE3NDUyMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTg1OGNlMWM3M2I1ZmY3MDcxMGU1ODc3N2ZkMjI5YWQ3YzEyODRmNDU0ZDkxMjJhNTU0ZGY1MDQ2YmIwOWRmMTgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.mOl0Hm70XmQEk-DPzx1FbwrpxNMDAqb-WDprs1HK-mc" title="Main Screenshot">
+  <img width="800" src="https://github.com/user-attachments/assets/e4a47229-66f8-4838-9575-dd2413596688" title="Main Screenshot">
 </p>
 
+> [!Note]
+> Starting with v0.3.3, configuration file mapping is different to support non-root user. Now, the default config file name is `config.yaml` and in docker the path is `/home/filebrowser/config.yaml` and `/home/filebrowser/<database_file>`. Please read the usage below to properly update your config to point the new config location. (open an issue for any help needed)
+
 > [!WARNING]
-> Starting with v0.2.0, *ALL* configuration is done via `filebrowser.yaml`
-> Configuration file.
-> Starting with v0.2.4 *ALL* share links need to be re-created (due to
-> security fix).
+> - There is no stable version yet. Always check release notes for bug fixes on functionality that may have been changed. If you notice any unexpected behavior -- please open an issue to have it fixed soon.
 
-FileBrowser Quantum is a fork of the filebrowser opensource project with the 
-following changes:
+FileBrowser Quantum is a fork of the file browser opensource project with the following changes:
 
-  1. [x] Efficiently indexed files
-     - Real-time search results as you type
-     - Search Works with more type filters
-     - Enhanced interactive results page.
+  1. [x] Indexes files efficiently. (See [indexing readme](./docs/indexing.md) for more info.)
+     - Real-time search results as you type!
+     - Search supports file/folder sizes and many file type filters.
+     - Enhanced interactive results that show file/folder sizes.
   2. [x] Revamped and simplified GUI navbar and sidebar menu.
      - Additional compact view mode as well as refreshed view mode
        styles.
-  3. [x] Revamped and simplified configuration via `filebrowser.yml` config file.
-  4. [x] Faster listing browsing
+     - Many graphical and user experience improvements.
+     - right-click context menu
+  3. [x] Revamped and simplified configuration via `config.yaml` config file.
+  4. [x] Better listing browsing
      - Switching view modes is instant
+     - Folder sizes are shown as well
      - Changing Sort order is instant
      - The entire directory is loaded in 1/3 the time
+  5. [x] Developer API support
+     - Ability to create long-live API Tokens.
+     - Helpful Swagger page available at `/swagger` endpoint.
+
+Notable features that this fork *does not* have (removed):
+
+ - jobs/runners are not supported yet (planned).
+ - shell commands are completely removed and will not be returned.
+ - Themes and branding are not fully supported yet (planned).
+ - see feature matrix below for more.
+ - pagination for directory items, so large directories with more than 100,000 items may be slow to load or not load at all.
 
 ## About
 
-FileBrowser Quantum provides a file managing interface within a specified directory
+FileBrowser Quantum provides a file-managing interface within a specified directory
 and can be used to upload, delete, preview, rename, and edit your files.
 It allows the creation of multiple users and each user can have its 
 directory.
 
 This repository is a fork of the original [filebrowser](https://github.com/filebrowser/filebrowser) 
 with a collection of changes that make this program work better in terms of 
-aesthetics and performance. Improved search, simplified ui 
+aesthetics and performance. Improved search, simplified UI 
 (without removing features) and more secure and up-to-date
 build are just a few examples.
 
-FileBrowser Quantum differs significantly to the original.
+FileBrowser Quantum differs significantly from the original.
 There are hundreds of thousands of lines changed and they are generally
 no longer compatible with each other. This has been intentional -- the
 focus of this fork is on a few key principles:
@@ -53,10 +66,11 @@ focus of this fork is on a few key principles:
   - Minimize external dependencies and standard library usage.
   - Of course -- adding much-needed features.
 
+For more questions, see the [Q&A Readme](./docs/questions.md)
+
 ## Look
 
-One way you can observe the improved user experience is how I changed
-the UI. The Navbar is simplified to a three-component system :
+The UI has a simple three-component navigation system :
 
   1. (Left) The slide-out action panel button
   2. (Middle) The powerful search bar.
@@ -68,10 +82,9 @@ action panel. If the action is available based on context, it will show up as
 a popup menu.
 
 <p align="center">
-  <img width="800" src="https://github.com/gtsteffaniak/filebrowser/assets/42989099/899152cf-3e69-4179-aa82-752af2df3fc6" title="Main Screenshot">
-    <img width="800" src="https://github.com/user-attachments/assets/18c02d03-5c60-4e15-9c32-3cfe058a0c49" title="Main Screenshot">
-      <img width="800" src="https://github.com/user-attachments/assets/75226dc4-9802-46f0-9e3c-e4403d3275da" title="Main Screenshot">
-
+  <img width="800" src="https://github.com/user-attachments/assets/2be7a6c5-0f95-4d9f-bc05-484ee71246d8" title="Search GIF">
+  <img width="800" src="https://github.com/user-attachments/assets/f55a6f1f-b930-4399-98b5-94da6e90527a" title="Navigation GIF">
+  <img width="800" src="https://github.com/user-attachments/assets/75226dc4-9802-46f0-9e3c-e4403d3275da" title="Main Screenshot">
 </p>
 
 ## Install
@@ -81,7 +94,13 @@ Using docker:
 1. docker run (no persistent db):
 
 ```
-docker run -it -v /path/to/folder:/srv -p 80:80 gtstef/filebrowser
+docker run -it -v /path/to/folder:/srv -v $(pwd)/config.yaml:/home/filebrowser/config.yaml -p 80:80 gtstef/filebrowser
+```
+
+or optionally, as non-root filebrowser user:
+
+```
+docker run -u filebrowser -it -v $(pwd)/config.yaml:/home/filebrowser/config.yaml -v /path/to/folder:/srv -p 80:80 gtstef/filebrowser
 ```
 
 1. docker compose:
@@ -89,29 +108,31 @@ docker run -it -v /path/to/folder:/srv -p 80:80 gtstef/filebrowser
   - with local storage
 
 ```
-version: '3.7'
 services:
   filebrowser:
     volumes:
       - '/path/to/folder:/srv' # required (for now not configurable)
-      - './database:/database'  # optional if you want db to persist - configure a path under "database" dir in config file.
-      - './filebrowser.yaml:/filebrowser.yaml' # required
+      # optional if you want db to persist - configure a path under "database" dir in config file.
+      - './database:/home/filebrowser/database'
+      - './config.yaml:/home/filebrowser/config.yaml'
     ports:
       - '80:80'
     image: gtstef/filebrowser
+    # optionally run as non-root filebrowser user
+    #user: filebrowser
     restart: always
 ```
 
   - with network share
 
 ```
-version: '3.7'
 services:
   filebrowser:
     volumes:
       - 'storage:/srv' # required (for now not configurable)
-      - './database:/database'  # optional if you want db to persist - configure a path under "database" dir in config file.
-      - './filebrowser.yaml:/filebrowser.yaml' # required
+      # optional if you want db to persist - configure a path under "database" dir in config file.
+      - './database:/home/filebrowser/database'
+      - './config.yaml:/home/filebrowser/config.yaml'
     ports:
       - '80:80'
     image: gtstef/filebrowser
@@ -121,39 +142,58 @@ volumes:
     driver_opts:
       type: cifs
       o: "username=admin,password=password,rw" # enter valid info here
-      device: "//192.168.1.100/share/"         # enter valid hinfo here
+      device: "//192.168.1.100/share/"         # enter valid info here
 
 ```
 
 Not using docker (not recommended), download your binary from releases and run with your custom config file:
 
 ```
-./filebrowser -c <filebrowser.yml or other /path/to/config.yaml>
+./filebrowser -c <config.yaml or other /path/to/config.yaml>
 ```
 
 ## Command Line Usage
 
-There are very few commands available. There are 3 actions done via command line:
+There are very few commands available. There are 3 actions done via the command line:
 
-1. Running the program, as shown on install step. Only argument used is the config file, if you choose to override default "filebrowser.yaml"
+1. Running the program, as shown in the install step. The only argument used is the config file if you choose to override the default "config.yaml"
 2. Checking the version info via `./filebrowser version`
 3. Updating the DB, which currently only supports adding users via `./filebrowser set -u username,password [-a] [-s "example/scope"]`
 
+## API Usage
+
+API tokens can be created to perform actions, access file information, and update user settings just like what can be done from the UI. You can create API tokens from the settings page via "API Management" section. This section will only show up if the user has "API" permissions, which can be granted by editing the user in user management.
+
+Regardless of whether a user has API permissions, anyone can visit the swagger page which is found at `/swagger`. This swagger page uses a short-live token (2-hour exp) that the UI uses, but allows for quick access to all the API's and their described usage and requirements:
+
+![image](https://github.com/user-attachments/assets/12abd1f6-21d3-4437-98ed-9b0da6cf2c73)
+
+When using the API outside of swagger, you will need to set the API token as a bearer token authentication type. This means the authorization header will look like `Authorization: Bearer <token>`. For example in Postman:
+
+Successful Request:
+
+<p align="center"><img width="500" alt="image" src="https://github.com/user-attachments/assets/4f18fa8a-8d87-4f40-9dc7-3d4407769b59"></p>
+
+Failed Request
+
+<p align="center"><img width="500" alt="image" src="https://github.com/user-attachments/assets/4da0deae-f93d-4d94-83b1-68806afb343a"></p>
+
+
 ## Configuration
 
 All configuration is now done via a single configuration file:
-`filebrowser.yaml`, here is an example of minimal [configuration
-file](./backend/filebrowser.yaml).
+`config.yaml`, here is an example of minimal [configuration
+file](./backend/config.yaml).
 
 View the [Configuration Help Page](./docs/configuration.md) for available
 configuration options and other help.
 
 
-## Migration from filebrowser/filebrowser
+## Migration from the original filebrowser
 
-If you currently use the original filebrowser but want to try using this. 
-I recommend you start fresh without reusing the database. If you want to 
-migrate your existing database to FileBrowser Quantum, visit the [migration 
+I would recommend that you start fresh without reusing the database. However, 
+If you want to migrate your existing database to FileBrowser Quantum, 
+visit the [migration 
 readme](./docs/migration.md)
 
 ## Comparison Chart
@@ -171,12 +211,12 @@ webdav support                | ❌ | ❌ | ✅ | ✅ | ❌ | ✅ |
 ftp support                   | ❌ | ❌ | ✅ | ✅ | ❌ | ✅ |
 Dedicated docs site?          | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ |
 Multiple sources at once      | ❌ | ❌ | ✅ | ✅ | ❌ | ✅ |
-Docker image size             | 22 MB  | 31 MB  | 240 MB (main image) | 250 MB | ❌ | > 2 GB |
+Docker image size             | 31 MB  | 31 MB  | 240 MB (main image) | 250 MB | ❌ | > 2 GB |
 Min. Memory Requirements      | 128 MB | 128 MB | 128 MB (main image) | 128 MB | ❌ | 4 GB   |
 has standalone binary         | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
 price                         | free | free | free | free tier | free tier | $99+ |
 rich media preview            | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
-upload files from the web?    | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
+upload files from the web?    | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
 Advanced Search?              | ✅ | ❌ | ❌ | configurable | ✅ | ✅ |
 Indexed Search?               | ✅ | ❌ | ❌ | configurable | ✅ | ✅ |
 Content-aware search?         | ❌ | ❌ | ❌ | configurable | ✅ | ✅ |
@@ -185,7 +225,8 @@ Multiple users                | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
 Single sign-on support        | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
 LDAP sign-on support          | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
 2FA sign-on support           | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
-Long-live API key support     | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ |
+Long-live API key support     | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
+API documentation page        | ✅ | ❌ | ✅ | ✅ | ❌ | ✅ |
 Mobile App                    | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
 open source?                  | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
 tags support                  | ❌ | ❌ | ❌ | ✅ | ❌ | ✅ |

backend/.goreleaser.yaml

@@ -24,15 +24,15 @@ builds:
         - upx {{ .Path }}  # Compress the binary with UPX
 
   # Build configuration for windows without arm
-  - id: windows
-    ldflags: *ldflags
-    main: main.go
-    binary: filebrowser
-    goos:
-      - windows
-    goarch:
-      - amd64
-      - arm64
+#  - id: windows
+#    ldflags: *ldflags
+#    main: main.go
+#    binary: filebrowser
+#    goos:
+#      - windows
+#    goarch:
+#      - amd64
+#      - arm64
 
 archives:
   - name_template: "{{.Os}}-{{.Arch}}{{if .Arm}}v{{.Arm}}{{end}}-{{ .ProjectName }}"

backend/auth/auth.go

@@ -3,13 +3,13 @@ package auth
 import (
 	"net/http"
 
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // Auther is the authentication interface.
 type Auther interface {
 	// Auth is called to authenticate a request.
-	Auth(r *http.Request, usr users.Store) (*users.User, error)
+	Auth(r *http.Request, userStore *users.Storage) (*users.User, error)
 	// LoginPage indicates if this auther needs a login page.
 	LoginPage() bool
 }

backend/auth/hook.go

@@ -9,9 +9,9 @@ import (
 	"os/exec"
 	"strings"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 type hookCred struct {
@@ -30,7 +30,7 @@ type HookAuth struct {
 }
 
 // Auth authenticates the user via a json in content body.
-func (a *HookAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
+func (a *HookAuth) Auth(r *http.Request, usr *users.Storage) (*users.User, error) {
 	var cred hookCred
 
 	if r.Body == nil {
@@ -51,7 +51,6 @@ func (a *HookAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
 	if err != nil {
 		return nil, err
 	}
-
 	switch action {
 	case "auth":
 		u, err := a.SaveUser()
@@ -187,7 +186,7 @@ func (a *HookAuth) SaveUser() (*users.User, error) {
 func (a *HookAuth) GetUser(d *users.User) *users.User {
 	// adds all permissions when user is admin
 	isAdmin := d.Perm.Admin
-	perms := settings.Permissions{
+	perms := users.Permissions{
 		Admin:    isAdmin,
 		Execute:  isAdmin || d.Perm.Execute,
 		Create:   isAdmin || d.Perm.Create,

backend/auth/json.go

@@ -7,8 +7,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 type jsonCred struct {
@@ -23,7 +23,7 @@ type JSONAuth struct {
 }
 
 // Auth authenticates the user via a json in content body.
-func (a JSONAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
+func (a JSONAuth) Auth(r *http.Request, userStore *users.Storage) (*users.User, error) {
 	config := &settings.Config
 	var cred jsonCred
 
@@ -47,8 +47,7 @@ func (a JSONAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
 			return nil, os.ErrPermission
 		}
 	}
-
-	u, err := usr.Get(config.Server.Root, cred.Username)
+	u, err := userStore.Get(config.Server.Root, cred.Username)
 	if err != nil || !users.CheckPwd(cred.Password, u.Password) {
 		return nil, os.ErrPermission
 	}

backend/auth/none.go

@@ -3,8 +3,8 @@ package auth
 import (
 	"net/http"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // MethodNoAuth is used to identify no auth.
@@ -14,7 +14,7 @@ const MethodNoAuth = "noauth"
 type NoAuth struct{}
 
 // Auth uses authenticates user 1.
-func (a NoAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
+func (a NoAuth) Auth(r *http.Request, usr *users.Storage) (*users.User, error) {
 	return usr.Get(settings.Config.Server.Root, uint(1))
 }
 

backend/auth/proxy.go

@@ -4,10 +4,10 @@ import (
 	"net/http"
 	"os"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // MethodProxyAuth is used to identify no auth.
@@ -19,7 +19,7 @@ type ProxyAuth struct {
 }
 
 // Auth authenticates the user via an HTTP header.
-func (a ProxyAuth) Auth(r *http.Request, usr users.Store) (*users.User, error) {
+func (a ProxyAuth) Auth(r *http.Request, usr *users.Storage) (*users.User, error) {
 	username := r.Header.Get(a.Header)
 	user, err := usr.Get(settings.Config.Server.Root, username)
 	if err == errors.ErrNotExist {

backend/auth/storage.go

@@ -1,7 +1,7 @@
 package auth
 
 import (
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // StorageBackend is a storage backend for auth storage.

backend/cmd/dist/.gitignore

@@ -1,4 +0,0 @@
-# Ignore everything in this directory
-*
-# Except this file
-!.gitignore

backend/cmd/root.go

@@ -1,50 +1,27 @@
 package cmd
 
 import (
-	"crypto/tls"
 	"flag"
 	"fmt"
-	"io/fs"
 	"log"
-	"net"
-	"net/http"
 	"os"
-	"os/signal"
-	"strconv"
 	"strings"
-	"syscall"
 
-	"embed"
+	"github.com/gtsteffaniak/filebrowser/backend/diskcache"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	fbhttp "github.com/gtsteffaniak/filebrowser/backend/http"
+	"github.com/gtsteffaniak/filebrowser/backend/img"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/swagger/docs"
+	"github.com/swaggo/swag"
 
-	"github.com/gtsteffaniak/filebrowser/diskcache"
-	"github.com/gtsteffaniak/filebrowser/files"
-	fbhttp "github.com/gtsteffaniak/filebrowser/http"
-	"github.com/gtsteffaniak/filebrowser/img"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
-	"github.com/gtsteffaniak/filebrowser/version"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/version"
 )
 
-//go:embed dist/*
-var assets embed.FS
-
-var (
-	nonEmbededFS = os.Getenv("FILEBROWSER_NO_EMBEDED") == "true"
-)
-
-type dirFS struct {
-	http.Dir
-}
-
-func (d dirFS) Open(name string) (fs.File, error) {
-	return d.Dir.Open(name)
-}
-
 func getStore(config string) (*storage.Storage, bool) {
 	// Use the config file (global flag)
-	log.Printf("Using Config file        : %v", config)
 	settings.Initialize(config)
 	store, hasDB, err := storage.InitializeDb(settings.Config.Server.Database)
 	if err != nil {
@@ -70,7 +47,7 @@ func StartFilebrowser() {
 	var help bool
 	// Override the default usage output to use generalUsage()
 	flag.Usage = generalUsage
-	flag.StringVar(&configPath, "c", "filebrowser.yaml", "Path to the config file.")
+	flag.StringVar(&configPath, "c", "config.yaml", "Path to the config file, default: config.yaml")
 	flag.BoolVar(&help, "h", false, "Get help about commands")
 
 	// Parse global flags (before subcommands)
@@ -90,7 +67,7 @@ func StartFilebrowser() {
 	setCmd.StringVar(&user, "u", "", "Comma-separated username and password: \"set -u <username>,<password>\"")
 	setCmd.BoolVar(&asAdmin, "a", false, "Create user as admin user, used in combination with -u")
 	setCmd.StringVar(&scope, "s", "", "Specify a user scope, otherwise default user config scope is used")
-	setCmd.StringVar(&dbConfig, "c", "filebrowser.yaml", "Path to the config file.")
+	setCmd.StringVar(&dbConfig, "c", "config.yaml", "Path to the config file, default: config.yaml")
 
 	// Parse subcommand flags only if a subcommand is specified
 	if len(os.Args) > 1 {
@@ -137,35 +114,27 @@ func StartFilebrowser() {
 		}
 	}
 	store, dbExists := getStore(configPath)
-	indexingInterval := fmt.Sprint(settings.Config.Server.IndexingInterval, " minutes")
-	if !settings.Config.Server.Indexing {
-		indexingInterval = "disabled"
-	}
 	database := fmt.Sprintf("Using existing database  : %v", settings.Config.Server.Database)
 	if !dbExists {
 		database = fmt.Sprintf("Creating new database    : %v", settings.Config.Server.Database)
 	}
 	log.Printf("Initializing FileBrowser Quantum (%v)\n", version.Version)
-	log.Println("Embeded frontend         :", !nonEmbededFS)
+	log.Printf("Using Config file        : %v", configPath)
+	log.Println("Embeded frontend         :", os.Getenv("FILEBROWSER_NO_EMBEDED") != "true")
 	log.Println(database)
 	log.Println("Sources                  :", settings.Config.Server.Root)
-	log.Print("Indexing interval        : ", indexingInterval)
 
 	serverConfig := settings.Config.Server
+	swagInfo := docs.SwaggerInfo
+	swagInfo.BasePath = serverConfig.BaseURL
+	swag.Register(docs.SwaggerInfo.InstanceName(), swagInfo)
 	// initialize indexing and schedule indexing ever n minutes (default 5)
-	go files.InitializeIndex(serverConfig.IndexingInterval, serverConfig.Indexing)
+	go files.InitializeIndex(serverConfig.Indexing)
 	if err := rootCMD(store, &serverConfig); err != nil {
 		log.Fatal("Error starting filebrowser:", err)
 	}
 }
 
-func cleanupHandler(listener net.Listener, c chan os.Signal) { //nolint:interfacer
-	sig := <-c
-	log.Printf("Caught signal %s: shutting down.", sig)
-	listener.Close()
-	os.Exit(0)
-}
-
 func rootCMD(store *storage.Storage, serverConfig *settings.Server) error {
 	if serverConfig.NumImageProcessors < 1 {
 		log.Fatal("Image resize workers count could not be < 1")
@@ -186,57 +155,7 @@ func rootCMD(store *storage.Storage, serverConfig *settings.Server) error {
 		// No-op cache if no cacheDir is specified
 		fileCache = diskcache.NewNoOp()
 	}
+	fbhttp.StartHttp(imgSvc, store, fileCache)
 
-	fbhttp.SetupEnv(store, serverConfig, fileCache)
-
-	_, err := os.Stat(serverConfig.Root)
-	utils.CheckErr(fmt.Sprint("cmd os.Stat ", serverConfig.Root), err)
-	var listener net.Listener
-	address := serverConfig.Address + ":" + strconv.Itoa(serverConfig.Port)
-	switch {
-	case serverConfig.Socket != "":
-		listener, err = net.Listen("unix", serverConfig.Socket)
-		utils.CheckErr("net.Listen", err)
-		err = os.Chmod(serverConfig.Socket, os.FileMode(0666)) // socket-perm
-		utils.CheckErr("os.Chmod", err)
-	case serverConfig.TLSKey != "" && serverConfig.TLSCert != "":
-		cer, err := tls.LoadX509KeyPair(serverConfig.TLSCert, serverConfig.TLSKey) //nolint:govet
-		utils.CheckErr("tls.LoadX509KeyPair", err)
-		listener, err = tls.Listen("tcp", address, &tls.Config{
-			MinVersion:   tls.VersionTLS12,
-			Certificates: []tls.Certificate{cer}},
-		)
-		utils.CheckErr("tls.Listen", err)
-	default:
-		listener, err = net.Listen("tcp", address)
-		utils.CheckErr("net.Listen", err)
-	}
-	sigc := make(chan os.Signal, 1)
-	signal.Notify(sigc, os.Interrupt, syscall.SIGTERM)
-	go cleanupHandler(listener, sigc)
-	if !nonEmbededFS {
-		assetsFs, err := fs.Sub(assets, "dist")
-		if err != nil {
-			log.Fatal("Could not embed frontend. Does backend/cmd/dist exist? Must be built and exist first")
-		}
-		handler, err := fbhttp.NewHandler(imgSvc, assetsFs)
-		utils.CheckErr("fbhttp.NewHandler", err)
-		defer listener.Close()
-		log.Println("Listening on", listener.Addr().String())
-		//nolint: gosec
-		if err := http.Serve(listener, handler); err != nil {
-			log.Fatalf("Could not start server on port %d: %v", serverConfig.Port, err)
-		}
-	} else {
-		assetsFs := dirFS{Dir: http.Dir("frontend/dist")}
-		handler, err := fbhttp.NewHandler(imgSvc, assetsFs)
-		utils.CheckErr("fbhttp.NewHandler", err)
-		defer listener.Close()
-		log.Println("Listening on", listener.Addr().String())
-		//nolint: gosec
-		if err := http.Serve(listener, handler); err != nil {
-			log.Fatalf("Could not start server on port %d: %v", serverConfig.Port, err)
-		}
-	}
 	return nil
 }

backend/cmd/rule_rm.go

@@ -5,10 +5,10 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {

backend/cmd/rules.go

@@ -6,11 +6,10 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {
@@ -66,7 +65,7 @@ func getUserIdentifier(flags *pflag.FlagSet) interface{} {
 	return nil
 }
 
-func printRules(rulez []rules.Rule, id interface{}) {
+func printRules(rulez []users.Rule, id interface{}) {
 
 	for id, rule := range rulez {
 		fmt.Printf("(%d) ", id)

backend/cmd/rules_add.go

@@ -5,11 +5,10 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {
@@ -32,13 +31,13 @@ var rulesAddCmd = &cobra.Command{
 			regexp.MustCompile(exp)
 		}
 
-		rule := rules.Rule{
+		rule := users.Rule{
 			Allow: allow,
 			Regex: regex,
 		}
 
 		if regex {
-			rule.Regexp = &rules.Regexp{Raw: exp}
+			rule.Regexp = &users.Regexp{Raw: exp}
 		} else {
 			rule.Path = exp
 		}

backend/cmd/rules_ls.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/gtsteffaniak/filebrowser/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
 	"github.com/spf13/cobra"
 )
 

backend/cmd/users.go

@@ -8,7 +8,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 var usersCmd = &cobra.Command{

backend/cmd/users_add.go

@@ -3,9 +3,9 @@ package cmd
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {

backend/cmd/users_export.go

@@ -1,8 +1,8 @@
 package cmd
 
 import (
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 	"github.com/spf13/cobra"
 )
 

backend/cmd/users_find.go

@@ -3,9 +3,9 @@ package cmd
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {

backend/cmd/users_import.go

@@ -8,9 +8,9 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {

backend/cmd/users_rm.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"log"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 	"github.com/spf13/cobra"
 )
 

backend/cmd/users_update.go

@@ -3,9 +3,9 @@ package cmd
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func init() {

backend/cmd/utils.go

@@ -10,8 +10,8 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 func mustGetString(flags *pflag.FlagSet, flag string) string {

backend/config.yaml

@@ -1,7 +1,7 @@
 server:
   port: 80
   baseURL:  "/"
-  root: "./srv"
+  root: "/srv"
 auth:
   method: password
   signup: false

backend/files/conditions.go

@@ -14,24 +14,85 @@ var AllFiletypeOptions = []string{
 	"archive",
 	"video",
 	"doc",
-	"dir",
 	"text",
 }
+
+// Document file extensions
 var documentTypes = []string{
-	".word",
-	".pdf",
-	".doc",
-	".docx",
-}
-var textTypes = []string{
-	".text",
-	".sh",
-	".yaml",
-	".yml",
-	".json",
-	".env",
+	// Common Document Formats
+	".doc", ".docx", // Microsoft Word
+	".pdf", // Portable Document Format
+	".odt", // OpenDocument Text
+	".rtf", // Rich Text Format
+	".conf",
+	".bash_history",
+	".gitignore",
+	".htpasswd",
+	".profile",
+	".dockerignore",
+	".editorconfig",
+
+	// Presentation Formats
+	".ppt", ".pptx", // Microsoft PowerPoint
+	".odp", // OpenDocument Presentation
+
+	// google docs
+	".gdoc",
+
+	// google sheet
+	".gsheet",
+
+	// Spreadsheet Formats
+	".xls", ".xlsx", // Microsoft Excel
+	".ods", // OpenDocument Spreadsheet
+
+	// Other Document Formats
+	".epub", // Electronic Publication
+	".mobi", // Amazon Kindle
+	".fb2",  // FictionBook
 }
 
+// Text-based file extensions
+var textTypes = []string{
+	// Common Text Formats
+	".txt",
+	".md", // Markdown
+
+	// Scripting and Programming Languages
+	".sh",        // Bash script
+	".py",        // Python
+	".js",        // JavaScript
+	".ts",        // TypeScript
+	".php",       // PHP
+	".rb",        // Ruby
+	".go",        // Go
+	".java",      // Java
+	".c", ".cpp", // C/C++
+	".cs",    // C#
+	".swift", // Swift
+
+	// Configuration Files
+	".yaml", ".yml", // YAML
+	".json", // JSON
+	".xml",  // XML
+	".ini",  // INI
+	".toml", // TOML
+	".cfg",  // Configuration file
+
+	// Other Text-Based Formats
+	".css",          // Cascading Style Sheets
+	".html", ".htm", // HyperText Markup Language
+	".sql", // SQL
+	".csv", // Comma-Separated Values
+	".tsv", // Tab-Separated Values
+	".log", // Log file
+	".bat", // Batch file
+	".ps1", // PowerShell script
+	".tex", // LaTeX
+	".bib", // BibTeX
+}
+
+// Compressed file extensions
 var compressedFile = []string{
 	".7z",
 	".rar",
@@ -39,6 +100,12 @@ var compressedFile = []string{
 	".tar",
 	".gz",
 	".xz",
+	".bz2",
+	".tgz",  // tar.gz
+	".tbz2", // tar.bz2
+	".lzma",
+	".lz4",
+	".zstd",
 }
 
 type SearchOptions struct {
@@ -48,8 +115,18 @@ type SearchOptions struct {
 	Terms       []string
 }
 
-func ParseSearch(value string) *SearchOptions {
-	opts := &SearchOptions{
+func extendedMimeTypeCheck(extension string) string {
+	if isDoc(extension) {
+		return "application/document"
+	}
+	if isText(extension) {
+		return "text/plain"
+	}
+	return "blob"
+}
+
+func ParseSearch(value string) SearchOptions {
+	opts := SearchOptions{
 		Conditions: map[string]bool{
 			"exact": strings.Contains(value, "case:exact"),
 		},
@@ -145,8 +222,6 @@ func IsMatchingType(extension string, matchType string) bool {
 	switch matchType {
 	case "doc":
 		return isDoc(extension)
-	case "pdf":
-		return extension == ".pdf"
 	case "text":
 		return isText(extension)
 	case "archive":

backend/files/conditions_test.go

@@ -22,7 +22,7 @@ func TestIsMatchingType(t *testing.T) {
 		extension    string
 		expectedType string
 	}{
-		{".pdf", "pdf"},
+		{".pdf", "doc"},
 		{".doc", "doc"},
 		{".docx", "doc"},
 		{".json", "text"},

backend/files/file.go

@@ -11,16 +11,21 @@ import (
 	"io"
 	"mime"
 	"net/http"
+
 	"os"
 	"path/filepath"
+	"sort"
+	"strconv"
 	"strings"
 	"sync"
 	"time"
 	"unicode/utf8"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/rules"
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/fileutils"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 var (
@@ -28,35 +33,30 @@ var (
 	pathMutexesMu sync.Mutex // Mutex to protect the pathMutexes map
 )
 
-type ReducedItem struct {
+type ItemInfo struct {
 	Name    string    `json:"name"`
 	Size    int64     `json:"size"`
 	ModTime time.Time `json:"modified"`
-	IsDir   bool      `json:"isDir,omitempty"`
 	Type    string    `json:"type"`
 }
 
 // FileInfo describes a file.
 // reduced item is non-recursive reduced "Items", used to pass flat items array
 type FileInfo struct {
-	Items        []*FileInfo       `json:"-"`
-	ReducedItems []ReducedItem     `json:"items,omitempty"`
-	Path         string            `json:"path,omitempty"`
-	Name         string            `json:"name"`
-	Size         int64             `json:"size"`
-	Extension    string            `json:"-"`
-	ModTime      time.Time         `json:"modified"`
-	CacheTime    time.Time         `json:"-"`
-	Mode         os.FileMode       `json:"-"`
-	IsDir        bool              `json:"isDir,omitempty"`
-	IsSymlink    bool              `json:"isSymlink,omitempty"`
-	Type         string            `json:"type"`
-	Subtitles    []string          `json:"subtitles,omitempty"`
-	Content      string            `json:"content,omitempty"`
-	Checksums    map[string]string `json:"checksums,omitempty"`
-	Token        string            `json:"token,omitempty"`
-	NumDirs      int               `json:"numDirs"`
-	NumFiles     int               `json:"numFiles"`
+	ItemInfo
+	Files   []ItemInfo `json:"files"`
+	Folders []ItemInfo `json:"folders"`
+	Path    string     `json:"path"`
+}
+
+// for efficiency, a response will be a pointer to the data
+// extra calculated fields can be added here
+type ExtendedFileInfo struct {
+	*FileInfo
+	Content   string            `json:"content,omitempty"`
+	Subtitles []string          `json:"subtitles,omitempty"`
+	Checksums map[string]string `json:"checksums,omitempty"`
+	Token     string            `json:"token,omitempty"`
 }
 
 // FileOptions are the options when getting a file info.
@@ -66,163 +66,77 @@ type FileOptions struct {
 	Modify     bool
 	Expand     bool
 	ReadHeader bool
-	Token      string
-	Checker    rules.Checker
+	Checker    users.Checker
 	Content    bool
 }
 
-// Legacy file info method, only called on non-indexed directories.
-// Once indexing completes for the first time, NewFileInfo is never called.
-func NewFileInfo(opts FileOptions) (*FileInfo, error) {
-
-	index := GetIndex(rootPath)
-	if !opts.Checker.Check(opts.Path) {
-		return nil, os.ErrPermission
-	}
-	file, err := stat(opts)
-	if err != nil {
-		return nil, err
-	}
-	if opts.Expand {
-		if file.IsDir {
-			if err = file.readListing(opts.Path, opts.Checker, opts.ReadHeader); err != nil {
-				return nil, err
-			}
-			cleanedItems := []ReducedItem{}
-			for _, item := range file.Items {
-				// This is particularly useful for root of index, while indexing hasn't finished.
-				// adds the directory sizes for directories that have been indexed already.
-				if item.IsDir {
-					adjustedPath := index.makeIndexPath(opts.Path+"/"+item.Name, true)
-					info, _ := index.GetMetadataInfo(adjustedPath)
-					item.Size = info.Size
-				}
-				cleanedItems = append(cleanedItems, ReducedItem{
-					Name:    item.Name,
-					Size:    item.Size,
-					IsDir:   item.IsDir,
-					ModTime: item.ModTime,
-					Type:    item.Type,
-				})
-			}
-
-			file.Items = nil
-			file.ReducedItems = cleanedItems
-			return file, nil
-		}
-		err = file.detectType(opts.Path, opts.Modify, opts.Content, true)
-		if err != nil {
-			return nil, err
-		}
-	}
-	return file, err
+func (f FileOptions) Components() (string, string) {
+	return filepath.Dir(f.Path), filepath.Base(f.Path)
 }
 
-func FileInfoFaster(opts FileOptions) (*FileInfo, error) {
+func FileInfoFaster(opts FileOptions) (ExtendedFileInfo, error) {
+	index := GetIndex(rootPath)
+	opts.Path = index.makeIndexPath(opts.Path)
+	response := ExtendedFileInfo{}
 	// Lock access for the specific path
 	pathMutex := getMutex(opts.Path)
 	pathMutex.Lock()
 	defer pathMutex.Unlock()
 	if !opts.Checker.Check(opts.Path) {
-		return nil, os.ErrPermission
+		return response, os.ErrPermission
 	}
-	index := GetIndex(rootPath)
-	adjustedPath := index.makeIndexPath(opts.Path, opts.IsDir)
-	if opts.IsDir {
-		info, exists := index.GetMetadataInfo(adjustedPath)
-		if exists && !opts.Content {
-			// Let's not refresh if less than a second has passed
-			if time.Since(info.CacheTime) > time.Second {
-				go RefreshFileInfo(opts) //nolint:errcheck
-			}
-			// refresh cache after
-			return &info, nil
-		}
+
+	_, isDir, err := GetRealPath(opts.Path)
+	if err != nil {
+		return response, err
+	}
+	opts.IsDir = isDir
+	// TODO : whats the best way to save trips to disk here?
+	// disabled using cache because its not clear if this is helping or hurting
+	// check if the file exists in the index
+	//info, exists := index.GetReducedMetadata(opts.Path, opts.IsDir)
+	//if exists {
+	//	err := RefreshFileInfo(opts)
+	//	if err != nil {
+	//		return info, err
+	//	}
+	//	if opts.Content {
+	//		content := ""
+	//		content, err = getContent(opts.Path)
+	//		if err != nil {
+	//			return info, err
+	//		}
+	//		info.Content = content
+	//	}
+	//	return info, nil
+	//}
+
+	err = index.RefreshFileInfo(opts)
+	if err != nil {
+		return response, err
+	}
+	info, exists := index.GetReducedMetadata(opts.Path, opts.IsDir)
+	if !exists {
+		return response, err
 	}
-	// don't bother caching content
 	if opts.Content {
-		file, err := NewFileInfo(opts)
-		return file, err
-	}
-	err := RefreshFileInfo(opts)
-	if err != nil {
-		file, err := NewFileInfo(opts)
-		return file, err
-	}
-	info, exists := index.GetMetadataInfo(adjustedPath + "/" + filepath.Base(opts.Path))
-	if !exists || info.Name == "" {
-		return NewFileInfo(opts)
-	}
-	return &info, nil
-}
-
-func RefreshFileInfo(opts FileOptions) error {
-	if !opts.Checker.Check(opts.Path) {
-		return fmt.Errorf("permission denied: %s", opts.Path)
-	}
-	index := GetIndex(rootPath)
-	adjustedPath := index.makeIndexPath(opts.Path, opts.IsDir)
-	file, err := stat(opts)
-	if err != nil {
-		return fmt.Errorf("File/folder does not exist to refresh data: %s", opts.Path)
-	}
-	_ = file.detectType(opts.Path, true, opts.Content, opts.ReadHeader)
-	if file.IsDir {
-		err := file.readListing(opts.Path, opts.Checker, opts.ReadHeader)
+		content, err := getContent(opts.Path)
 		if err != nil {
-			return fmt.Errorf("Dir info could not be read: %s", opts.Path)
+			return response, err
 		}
+		response.Content = content
 	}
-	result := index.UpdateFileMetadata(adjustedPath, *file)
-	if !result {
-		return fmt.Errorf("File/folder does not exist in metadata: %s", adjustedPath)
-	}
-	return nil
-}
-
-func stat(opts FileOptions) (*FileInfo, error) {
-	info, err := os.Lstat(opts.Path)
-	if err != nil {
-		return nil, err
-	}
-	file := &FileInfo{
-		Path:      opts.Path,
-		Name:      info.Name(),
-		ModTime:   info.ModTime(),
-		Mode:      info.Mode(),
-		Size:      info.Size(),
-		Extension: filepath.Ext(info.Name()),
-		Token:     opts.Token,
-	}
-	if info.IsDir() {
-		file.IsDir = true
-	}
-	if info.Mode()&os.ModeSymlink != 0 {
-		file.IsSymlink = true
-		targetInfo, err := os.Stat(opts.Path)
-		if err == nil {
-			file.Size = targetInfo.Size()
-			file.IsDir = targetInfo.IsDir()
-		}
-	}
-
-	return file, nil
+	response.FileInfo = info
+	return response, nil
 }
 
 // Checksum checksums a given File for a given User, using a specific
 // algorithm. The checksums data is saved on File object.
-func (i *FileInfo) Checksum(algo string) error {
-	if i.IsDir {
-		return errors.ErrIsDirectory
-	}
-
-	if i.Checksums == nil {
-		i.Checksums = map[string]string{}
-	}
-
-	reader, err := os.Open(i.Path)
+func GetChecksum(fullPath, algo string) (map[string]string, error) {
+	subs := map[string]string{}
+	reader, err := os.Open(fullPath)
 	if err != nil {
-		return err
+		return subs, err
 	}
 	defer reader.Close()
 
@@ -235,21 +149,21 @@ func (i *FileInfo) Checksum(algo string) error {
 
 	h, ok := hashFuncs[algo]
 	if !ok {
-		return errors.ErrInvalidOption
+		return subs, errors.ErrInvalidOption
 	}
 
 	_, err = io.Copy(h, reader)
 	if err != nil {
-		return err
+		return subs, err
 	}
-
-	i.Checksums[algo] = hex.EncodeToString(h.Sum(nil))
-	return nil
+	subs[algo] = hex.EncodeToString(h.Sum(nil))
+	return subs, nil
 }
 
 // RealPath gets the real path for the file, resolving symlinks if supported.
 func (i *FileInfo) RealPath() string {
-	realPath, err := filepath.EvalSymlinks(i.Path)
+	realPath, _, _ := GetRealPath(rootPath, i.Path)
+	realPath, err := filepath.EvalSymlinks(realPath)
 	if err == nil {
 		return realPath
 	}
@@ -262,16 +176,24 @@ func GetRealPath(relativePath ...string) (string, bool, error) {
 		combined = append(combined, strings.TrimPrefix(path, settings.Config.Server.Root))
 	}
 	joinedPath := filepath.Join(combined...)
+
+	isDir, _ := utils.RealPathCache.Get(joinedPath + ":isdir").(bool)
+	cached, ok := utils.RealPathCache.Get(joinedPath).(string)
+	if ok && cached != "" {
+		return cached, isDir, nil
+	}
 	// Convert relative path to absolute path
 	absolutePath, err := filepath.Abs(joinedPath)
 	if err != nil {
-		return "", false, err
-	}
-	if !Exists(absolutePath) {
-		return absolutePath, false, nil // return without error
+		return absolutePath, false, fmt.Errorf("could not get real path: %v, %s", combined, err)
 	}
 	// Resolve symlinks and get the real path
-	return resolveSymlinks(absolutePath)
+	realPath, isDir, err := resolveSymlinks(absolutePath)
+	if err == nil {
+		utils.RealPathCache.Set(joinedPath, realPath)
+		utils.RealPathCache.Set(joinedPath+":isdir", isDir)
+	}
+	return realPath, isDir, err
 }
 
 func DeleteFiles(absPath string, opts FileOptions) error {
@@ -279,8 +201,51 @@ func DeleteFiles(absPath string, opts FileOptions) error {
 	if err != nil {
 		return err
 	}
-	opts.Path = filepath.Dir(absPath)
-	err = RefreshFileInfo(opts)
+	index := GetIndex(rootPath)
+	refreshConfig := FileOptions{Path: filepath.Dir(opts.Path), IsDir: true}
+	err = index.RefreshFileInfo(refreshConfig)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func MoveResource(realsrc, realdst string, isSrcDir bool) error {
+	err := fileutils.MoveFile(realsrc, realdst)
+	if err != nil {
+		return err
+	}
+	index := GetIndex(rootPath)
+	// refresh info for source and dest
+	err = index.RefreshFileInfo(FileOptions{
+		Path:  realsrc,
+		IsDir: isSrcDir,
+	})
+	if err != nil {
+		return errors.ErrEmptyKey
+	}
+	refreshConfig := FileOptions{Path: realdst, IsDir: true}
+	if !isSrcDir {
+		refreshConfig.Path = filepath.Dir(realdst)
+	}
+	err = index.RefreshFileInfo(refreshConfig)
+	if err != nil {
+		return errors.ErrEmptyKey
+	}
+	return nil
+}
+
+func CopyResource(realsrc, realdst string, isSrcDir bool) error {
+	err := fileutils.CopyFile(realsrc, realdst)
+	if err != nil {
+		return err
+	}
+	index := GetIndex(rootPath)
+	refreshConfig := FileOptions{Path: realdst, IsDir: true}
+	if !isSrcDir {
+		refreshConfig.Path = filepath.Dir(realdst)
+	}
+	err = index.RefreshFileInfo(refreshConfig)
 	if err != nil {
 		return errors.ErrEmptyKey
 	}
@@ -288,13 +253,14 @@ func DeleteFiles(absPath string, opts FileOptions) error {
 }
 
 func WriteDirectory(opts FileOptions) error {
+	realPath, _, _ := GetRealPath(rootPath, opts.Path)
 	// Ensure the parent directories exist
-	err := os.MkdirAll(opts.Path, 0775)
+	err := os.MkdirAll(realPath, 0775)
 	if err != nil {
 		return err
 	}
-	opts.Path = filepath.Dir(opts.Path)
-	err = RefreshFileInfo(opts)
+	index := GetIndex(rootPath)
+	err = index.RefreshFileInfo(opts)
 	if err != nil {
 		return errors.ErrEmptyKey
 	}
@@ -302,13 +268,10 @@ func WriteDirectory(opts FileOptions) error {
 }
 
 func WriteFile(opts FileOptions, in io.Reader) error {
-	dst := opts.Path
+	dst, _, _ := GetRealPath(rootPath, opts.Path)
 	parentDir := filepath.Dir(dst)
-	// Split the directory from the destination path
-	dir := filepath.Dir(dst)
-
 	// Create the directory and all necessary parents
-	err := os.MkdirAll(dir, 0775)
+	err := os.MkdirAll(parentDir, 0775)
 	if err != nil {
 		return err
 	}
@@ -326,246 +289,124 @@ func WriteFile(opts FileOptions, in io.Reader) error {
 		return err
 	}
 	opts.Path = parentDir
-	err = RefreshFileInfo(opts)
-	if err != nil {
-		return errors.ErrEmptyKey
-	}
-	return nil
+	opts.IsDir = true
+	index := GetIndex(rootPath)
+	return index.RefreshFileInfo(opts)
 }
 
 // resolveSymlinks resolves symlinks in the given path
 func resolveSymlinks(path string) (string, bool, error) {
 	for {
-		// Get the file info
+		// Get the file info using os.Lstat to handle symlinks
 		info, err := os.Lstat(path)
 		if err != nil {
-			return "", false, err
+			return path, false, fmt.Errorf("could not stat path: %s, %v", path, err)
 		}
 
-		// Check if it's a symlink
+		// Check if the path is a symlink
 		if info.Mode()&os.ModeSymlink != 0 {
 			// Read the symlink target
 			target, err := os.Readlink(path)
 			if err != nil {
-				return "", false, err
+				return path, false, fmt.Errorf("could not read symlink: %s, %v", path, err)
 			}
 
-			// Resolve the target relative to the symlink's directory
+			// Resolve the symlink's target relative to its directory
+			// This ensures the resolved path is absolute and correctly calculated
 			path = filepath.Join(filepath.Dir(path), target)
 		} else {
-			// Not a symlink, so return the resolved path and check if it's a directory
-			return path, info.IsDir(), nil
+			// Not a symlink, so return the resolved path and whether it's a directory
+			isDir := info.IsDir()
+			return path, isDir, nil
 		}
 	}
 }
 
 // addContent reads and sets content based on the file type.
-func (i *FileInfo) addContent(path string) error {
-	if !i.IsDir {
-		content, err := os.ReadFile(path)
-		if err != nil {
-			return err
-		}
-		stringContent := string(content)
-		if !utf8.ValidString(stringContent) {
-			return nil
-		}
-		if stringContent == "" {
-			i.Content = "empty-file-x6OlSil"
-			return nil
-		}
-		i.Content = stringContent
+func getContent(path string) (string, error) {
+	realPath, _, err := GetRealPath(rootPath, path)
+	if err != nil {
+		return "", err
 	}
-	return nil
+
+	content, err := os.ReadFile(realPath)
+	if err != nil {
+		return "", err
+	}
+	stringContent := string(content)
+	if !utf8.ValidString(stringContent) {
+		return "", nil
+	}
+	if stringContent == "" {
+		return "empty-file-x6OlSil", nil
+	}
+	return stringContent, nil
 }
 
-// detectType detects the file type.
-func (i *FileInfo) detectType(path string, modify, saveContent, readHeader bool) error {
-	if i.IsDir {
-		return nil
-	}
-	if IsNamedPipe(i.Mode) {
-		i.Type = "blob"
-		if saveContent {
-			return i.addContent(path)
-		}
-		return nil
-	}
+// DetectType detects the MIME type of a file and updates the ItemInfo struct.
+func (i *ItemInfo) DetectType(path string, saveContent bool) {
+	name := i.Name
+	ext := filepath.Ext(name)
 
-	var buffer []byte
-	if readHeader {
-		buffer = i.readFirstBytes()
-		mimetype := mime.TypeByExtension(i.Extension)
-		if mimetype == "" {
-			http.DetectContentType(buffer)
-		}
-	}
-
-	ext := filepath.Ext(i.Name)
-	for _, fileType := range AllFiletypeOptions {
-		if IsMatchingType(ext, fileType) {
-			i.Type = fileType
-		}
-
-		switch i.Type {
-		case "text":
-			if !modify {
-				i.Type = "textImmutable"
-			}
-			if saveContent {
-				return i.addContent(path)
-			}
-		case "video":
-			parentDir := strings.TrimRight(path, i.Name)
-			i.detectSubtitles(parentDir)
-		case "doc":
-			if ext == ".pdf" {
-				i.Type = "pdf"
-				return nil
-			}
-			if saveContent {
-				return i.addContent(path)
-			}
-		}
-	}
+	// Attempt MIME detection by file extension
+	i.Type = strings.Split(mime.TypeByExtension(ext), ";")[0]
 	if i.Type == "" {
-		i.Type = "blob"
-		if saveContent {
-			return i.addContent(path)
-		}
+		i.Type = extendedMimeTypeCheck(ext)
 	}
+	if i.Type == "blob" {
+		realpath, _, _ := GetRealPath(path)
+		// Read only the first 512 bytes for efficient MIME detection
+		file, err := os.Open(realpath)
+		if err != nil {
 
-	return nil
-}
-
-// readFirstBytes reads the first bytes of the file.
-func (i *FileInfo) readFirstBytes() []byte {
-	file, err := os.Open(i.Path)
-	if err != nil {
-		i.Type = "blob"
-		return nil
-	}
-	defer file.Close()
-
-	buffer := make([]byte, 512) //nolint:gomnd
-	n, err := file.Read(buffer)
-	if err != nil && err != io.EOF {
-		i.Type = "blob"
-		return nil
-	}
-
-	return buffer[:n]
-}
-
-// detectSubtitles detects subtitles for video files.
-func (i *FileInfo) detectSubtitles(parentDir string) {
-	if i.Type != "video" {
-		return
-	}
-	i.Subtitles = []string{}
-	ext := filepath.Ext(i.Name)
-	dir, err := os.Open(parentDir)
-	if err != nil {
-		// Directory must have been deleted, remove it from the index
-		return
-	}
-	defer dir.Close() // Ensure directory handle is closed
-
-	files, err := dir.Readdir(-1)
-	if err != nil {
-		return
-	}
-
-	base := strings.TrimSuffix(i.Name, ext)
-	subtitleExts := []string{".vtt", ".txt", ".srt", ".lrc"}
-
-	for _, f := range files {
-		if f.IsDir() || !strings.HasPrefix(f.Name(), base) {
-			continue
-		}
-
-		for _, subtitleExt := range subtitleExts {
-			if strings.HasSuffix(f.Name(), subtitleExt) {
-				i.Subtitles = append(i.Subtitles, filepath.Join(parentDir, f.Name()))
-				break
-			}
-		}
-	}
-}
-
-// readListing reads the contents of a directory and fills the listing.
-func (i *FileInfo) readListing(path string, checker rules.Checker, readHeader bool) error {
-	dir, err := os.Open(i.Path)
-	if err != nil {
-		return err
-	}
-	defer dir.Close()
-
-	files, err := dir.Readdir(-1)
-	if err != nil {
-		return err
-	}
-
-	listing := &FileInfo{
-		Items:    []*FileInfo{},
-		NumDirs:  0,
-		NumFiles: 0,
-	}
-
-	for _, f := range files {
-		name := f.Name()
-		fPath := filepath.Join(i.Path, name)
-
-		if !checker.Check(fPath) {
-			continue
-		}
-
-		isSymlink, isInvalidLink := false, false
-		if IsSymlink(f.Mode()) {
-			isSymlink = true
-			info, err := os.Stat(fPath)
-			if err == nil {
-				f = info
-			} else {
-				isInvalidLink = true
-			}
-		}
-
-		file := &FileInfo{
-			Name:    name,
-			Size:    f.Size(),
-			ModTime: f.ModTime(),
-			Mode:    f.Mode(),
-		}
-		if f.IsDir() {
-			file.IsDir = true
-		}
-		if isSymlink {
-			file.IsSymlink = true
-		}
-
-		if file.IsDir {
-			listing.NumDirs++
 		} else {
-			listing.NumFiles++
-
-			if isInvalidLink {
-				file.Type = "invalid_link"
-			} else {
-				err := file.detectType(path, true, false, readHeader)
-				if err != nil {
-					return err
-				}
-			}
+			defer file.Close()
+			buffer := make([]byte, 512)
+			n, _ := file.Read(buffer) // Ignore errors from Read
+			i.Type = strings.Split(http.DetectContentType(buffer[:n]), ";")[0]
 		}
-
-		listing.Items = append(listing.Items, file)
 	}
-
-	i.Items = listing.Items
-	return nil
 }
 
+// TODO add subtitles back
+// detectSubtitles detects subtitles for video files.
+//func (i *FileInfo) detectSubtitles(path string) {
+//	if i.Type != "video" {
+//		return
+//	}
+//	parentDir := filepath.Dir(path)
+//	fileName := filepath.Base(path)
+//	i.Subtitles = []string{}
+//	ext := filepath.Ext(fileName)
+//	dir, err := os.Open(parentDir)
+//	if err != nil {
+//		// Directory must have been deleted, remove it from the index
+//		return
+//	}
+//	defer dir.Close() // Ensure directory handle is closed
+//
+//	files, err := dir.Readdir(-1)
+//	if err != nil {
+//		return
+//	}
+//
+//	base := strings.TrimSuffix(fileName, ext)
+//	subtitleExts := []string{".vtt", ".txt", ".srt", ".lrc"}
+//
+//	for _, f := range files {
+//		if f.IsDir() || !strings.HasPrefix(f.Name(), base) {
+//			continue
+//		}
+//
+//		for _, subtitleExt := range subtitleExts {
+//			if strings.HasSuffix(f.Name(), subtitleExt) {
+//				i.Subtitles = append(i.Subtitles, filepath.Join(parentDir, f.Name()))
+//				break
+//			}
+//		}
+//	}
+//}
+
 func IsNamedPipe(mode os.FileMode) bool {
 	return mode&os.ModeNamedPipe != 0
 }
@@ -597,3 +438,26 @@ func Exists(path string) bool {
 	}
 	return false
 }
+
+func (info *FileInfo) SortItems() {
+	sort.Slice(info.Folders, func(i, j int) bool {
+		// Convert strings to integers for numeric sorting if both are numeric
+		numI, errI := strconv.Atoi(info.Folders[i].Name)
+		numJ, errJ := strconv.Atoi(info.Folders[j].Name)
+		if errI == nil && errJ == nil {
+			return numI < numJ
+		}
+		// Fallback to case-insensitive lexicographical sorting
+		return strings.ToLower(info.Folders[i].Name) < strings.ToLower(info.Folders[j].Name)
+	})
+	sort.Slice(info.Files, func(i, j int) bool {
+		// Convert strings to integers for numeric sorting if both are numeric
+		numI, errI := strconv.Atoi(info.Files[i].Name)
+		numJ, errJ := strconv.Atoi(info.Files[j].Name)
+		if errI == nil && errJ == nil {
+			return numI < numJ
+		}
+		// Fallback to case-insensitive lexicographical sorting
+		return strings.ToLower(info.Files[i].Name) < strings.ToLower(info.Files[j].Name)
+	})
+}

backend/files/file_test.go

@@ -3,6 +3,7 @@ package files
 import (
 	"os"
 	"path/filepath"
+	"reflect"
 	"strings"
 	"testing"
 )
@@ -63,13 +64,105 @@ func Test_GetRealPath(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			realPath, isDir, err := GetRealPath(tt.paths...)
+			realPath, isDir, _ := GetRealPath(tt.paths...)
 			adjustedRealPath := strings.TrimPrefix(realPath, trimPrefix)
 			if tt.want.path != adjustedRealPath || tt.want.isDir != isDir {
 				t.Errorf("expected %v:%v but got: %v:%v", tt.want.path, tt.want.isDir, adjustedRealPath, isDir)
 			}
-			if err != nil {
-				t.Error("got error", err)
+		})
+	}
+}
+
+func TestSortItems(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    FileInfo
+		expected FileInfo
+	}{
+		{
+			name: "Numeric and Lexicographical Sorting",
+			input: FileInfo{
+				Folders: []ItemInfo{
+					{Name: "10"},
+					{Name: "2"},
+					{Name: "apple"},
+					{Name: "Banana"},
+				},
+				Files: []ItemInfo{
+					{Name: "File2"},
+					{Name: "File10"},
+					{Name: "File1"},
+					{Name: "banana"},
+				},
+			},
+			expected: FileInfo{
+				Folders: []ItemInfo{
+					{Name: "2"},
+					{Name: "10"},
+					{Name: "apple"},
+					{Name: "Banana"},
+				},
+				Files: []ItemInfo{
+					{Name: "banana"},
+					{Name: "File1"},
+					{Name: "File10"},
+					{Name: "File2"},
+				},
+			},
+		},
+		{
+			name: "Only Lexicographical Sorting",
+			input: FileInfo{
+				Folders: []ItemInfo{
+					{Name: "dog"},
+					{Name: "Cat"},
+					{Name: "apple"},
+				},
+				Files: []ItemInfo{
+					{Name: "Zebra"},
+					{Name: "apple"},
+					{Name: "cat"},
+				},
+			},
+			expected: FileInfo{
+				Folders: []ItemInfo{
+					{Name: "apple"},
+					{Name: "Cat"},
+					{Name: "dog"},
+				},
+				Files: []ItemInfo{
+					{Name: "apple"},
+					{Name: "cat"},
+					{Name: "Zebra"},
+				},
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			test.input.SortItems()
+
+			getNames := func(items []ItemInfo) []string {
+				names := []string{}
+				for _, folder := range items {
+					names = append(names, folder.Name)
+				}
+				return names
+			}
+
+			actualFolderNames := getNames(test.input.Folders)
+			expectedFolderNames := getNames(test.expected.Folders)
+
+			if !reflect.DeepEqual(actualFolderNames, expectedFolderNames) {
+				t.Errorf("Folders not sorted correctly.\nGot: %v\nExpected: %v", actualFolderNames, expectedFolderNames)
+			}
+
+			actualFileNames := getNames(test.input.Files)
+			expectedFileNames := getNames(test.expected.Files)
+
+			if !reflect.DeepEqual(actualFileNames, expectedFileNames) {
+				t.Errorf("Files not sorted correctly.\nGot: %v\nExpected: %v", actualFileNames, expectedFileNames)
 			}
 		})
 	}

backend/files/indexing.go

@@ -1,198 +0,0 @@
-package files
-
-import (
-	"log"
-	"os"
-	"path/filepath"
-	"strings"
-	"sync"
-	"time"
-
-	"github.com/gtsteffaniak/filebrowser/settings"
-)
-
-type Index struct {
-	Root        string
-	Directories map[string]FileInfo
-	NumDirs     int
-	NumFiles    int
-	inProgress  bool
-	LastIndexed time.Time
-	mu          sync.RWMutex
-}
-
-var (
-	rootPath     string = "/srv"
-	indexes      []*Index
-	indexesMutex sync.RWMutex
-)
-
-func InitializeIndex(intervalMinutes uint32, schedule bool) {
-	if schedule {
-		go indexingScheduler(intervalMinutes)
-	}
-}
-
-func indexingScheduler(intervalMinutes uint32) {
-	if settings.Config.Server.Root != "" {
-		rootPath = settings.Config.Server.Root
-	}
-	si := GetIndex(rootPath)
-	for {
-		startTime := time.Now()
-		// Set the indexing flag to indicate that indexing is in progress
-		si.resetCount()
-		// Perform the indexing operation
-		err := si.indexFiles(si.Root)
-		// Reset the indexing flag to indicate that indexing has finished
-		si.inProgress = false
-		// Update the LastIndexed time
-		si.LastIndexed = time.Now()
-		if err != nil {
-			log.Printf("Error during indexing: %v", err)
-		}
-		if si.NumFiles+si.NumDirs > 0 {
-			timeIndexedInSeconds := int(time.Since(startTime).Seconds())
-			log.Println("Successfully indexed files.")
-			log.Printf("Time spent indexing: %v seconds\n", timeIndexedInSeconds)
-			log.Printf("Files found: %v\n", si.NumFiles)
-			log.Printf("Directories found: %v\n", si.NumDirs)
-		}
-		// Sleep for the specified interval
-		time.Sleep(time.Duration(intervalMinutes) * time.Minute)
-	}
-}
-
-// Define a function to recursively index files and directories
-func (si *Index) indexFiles(path string) error {
-	// Ensure path is cleaned and normalized
-	adjustedPath := si.makeIndexPath(path, true)
-
-	// Open the directory
-	dir, err := os.Open(path)
-	if err != nil {
-		// If the directory can't be opened (e.g., deleted), remove it from the index
-		si.RemoveDirectory(adjustedPath)
-		return err
-	}
-	defer dir.Close()
-
-	dirInfo, err := dir.Stat()
-	if err != nil {
-		return err
-	}
-
-	// Check if the directory is already up-to-date
-	if dirInfo.ModTime().Before(si.LastIndexed) {
-		return nil
-	}
-
-	// Read directory contents
-	files, err := dir.Readdir(-1)
-	if err != nil {
-		return err
-	}
-
-	// Recursively process files and directories
-	fileInfos := []*FileInfo{}
-	var totalSize int64
-	var numDirs, numFiles int
-
-	for _, file := range files {
-		parentInfo := &FileInfo{
-			Name:    file.Name(),
-			Size:    file.Size(),
-			ModTime: file.ModTime(),
-			IsDir:   file.IsDir(),
-		}
-		childInfo, err := si.InsertInfo(path, parentInfo)
-		if err != nil {
-			// Log error, but continue processing other files
-			continue
-		}
-
-		// Accumulate directory size and items
-		totalSize += childInfo.Size
-		if childInfo.IsDir {
-			numDirs++
-		} else {
-			numFiles++
-		}
-		_ = childInfo.detectType(path, true, false, false)
-		fileInfos = append(fileInfos, childInfo)
-	}
-
-	// Create FileInfo for the current directory
-	dirFileInfo := &FileInfo{
-		Items:     fileInfos,
-		Name:      filepath.Base(path),
-		Size:      totalSize,
-		ModTime:   dirInfo.ModTime(),
-		CacheTime: time.Now(),
-		IsDir:     true,
-		NumDirs:   numDirs,
-		NumFiles:  numFiles,
-	}
-
-	// Add directory to index
-	si.mu.Lock()
-	si.Directories[adjustedPath] = *dirFileInfo
-	si.NumDirs += numDirs
-	si.NumFiles += numFiles
-	si.mu.Unlock()
-	return nil
-}
-
-// InsertInfo function to handle adding a file or directory into the index
-func (si *Index) InsertInfo(parentPath string, file *FileInfo) (*FileInfo, error) {
-	filePath := filepath.Join(parentPath, file.Name)
-
-	// Check if it's a directory and recursively index it
-	if file.IsDir {
-		// Recursively index directory
-		err := si.indexFiles(filePath)
-		if err != nil {
-			return nil, err
-		}
-
-		// Return directory info from the index
-		adjustedPath := si.makeIndexPath(filePath, true)
-		si.mu.RLock()
-		dirInfo := si.Directories[adjustedPath]
-		si.mu.RUnlock()
-		return &dirInfo, nil
-	}
-
-	// Create FileInfo for regular files
-	fileInfo := &FileInfo{
-		Path:    filePath,
-		Name:    file.Name,
-		Size:    file.Size,
-		ModTime: file.ModTime,
-		IsDir:   false,
-	}
-
-	return fileInfo, nil
-}
-
-func (si *Index) makeIndexPath(subPath string, isDir bool) string {
-	if si.Root == subPath {
-		return "/"
-	}
-	// clean path
-	subPath = strings.TrimSuffix(subPath, "/")
-	// remove index prefix
-	adjustedPath := strings.TrimPrefix(subPath, si.Root)
-	// remove trailing slash
-	adjustedPath = strings.TrimSuffix(adjustedPath, "/")
-	// add leading slash for root of index
-	if adjustedPath == "" {
-		adjustedPath = "/"
-	} else if !isDir {
-		adjustedPath = filepath.Dir(adjustedPath)
-	}
-	if !strings.HasPrefix(adjustedPath, "/") {
-		adjustedPath = "/" + adjustedPath
-	}
-	return adjustedPath
-}

backend/files/indexingFiles.go

@@ -0,0 +1,229 @@
+package files
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
+)
+
+type Index struct {
+	Root                       string
+	Directories                map[string]*FileInfo
+	NumDirs                    uint64
+	NumFiles                   uint64
+	NumDeleted                 uint64
+	FilesChangedDuringIndexing bool
+	currentSchedule            int
+	assessment                 string
+	indexingTime               int
+	LastIndexed                time.Time
+	SmartModifier              time.Duration
+	mu                         sync.RWMutex
+	scannerMu                  sync.Mutex
+}
+
+var (
+	rootPath     string = "/srv"
+	indexes      []*Index
+	indexesMutex sync.RWMutex
+)
+
+func InitializeIndex(enabled bool) {
+	if enabled {
+		time.Sleep(time.Second)
+		if settings.Config.Server.Root != "" {
+			rootPath = settings.Config.Server.Root
+		}
+		si := GetIndex(rootPath)
+		log.Println("Initializing index and assessing file system complexity")
+		si.RunIndexing("/", false)
+		go si.setupIndexingScanners()
+	}
+}
+
+// Define a function to recursively index files and directories
+func (si *Index) indexDirectory(adjustedPath string, quick, recursive bool) error {
+	realPath := strings.TrimRight(si.Root, "/") + adjustedPath
+
+	// Open the directory
+	dir, err := os.Open(realPath)
+	if err != nil {
+		si.RemoveDirectory(adjustedPath) // Remove, must have been deleted
+		return err
+	}
+	defer dir.Close()
+
+	dirInfo, err := dir.Stat()
+	if err != nil {
+		return err
+	}
+	combinedPath := adjustedPath + "/"
+	if adjustedPath == "/" {
+		combinedPath = "/"
+	}
+	// get whats currently in cache
+	si.mu.RLock()
+	cacheDirItems := []ItemInfo{}
+	modChange := true // default to true
+	cachedDir, exists := si.Directories[adjustedPath]
+	if exists && quick {
+		modChange = dirInfo.ModTime() != cachedDir.ModTime
+		cacheDirItems = cachedDir.Folders
+	}
+	si.mu.RUnlock()
+
+	// If the directory has not been modified since the last index, skip expensive readdir
+	// recursively check cached dirs for mod time changes as well
+	if !modChange && recursive {
+		for _, item := range cacheDirItems {
+			err = si.indexDirectory(combinedPath+item.Name, quick, true)
+			if err != nil {
+				fmt.Printf("error indexing directory %v : %v", combinedPath+item.Name, err)
+			}
+		}
+		return nil
+	}
+
+	if quick {
+		si.mu.Lock()
+		si.FilesChangedDuringIndexing = true
+		si.mu.Unlock()
+	}
+
+	// Read directory contents
+	files, err := dir.Readdir(-1)
+	if err != nil {
+		return err
+	}
+
+	var totalSize int64
+	fileInfos := []ItemInfo{}
+	dirInfos := []ItemInfo{}
+
+	// Process each file and directory in the current directory
+	for _, file := range files {
+		itemInfo := &ItemInfo{
+			Name:    file.Name(),
+			ModTime: file.ModTime(),
+		}
+		if file.IsDir() {
+			dirPath := combinedPath + file.Name()
+			if recursive {
+				// Recursively index the subdirectory
+				err = si.indexDirectory(dirPath, quick, recursive)
+				if err != nil {
+					log.Printf("Failed to index directory %s: %v", dirPath, err)
+					continue
+				}
+			}
+			realDirInfo, exists := si.GetMetadataInfo(dirPath, true)
+			if exists {
+				itemInfo.Size = realDirInfo.Size
+			}
+			totalSize += itemInfo.Size
+			itemInfo.Type = "directory"
+			dirInfos = append(dirInfos, *itemInfo)
+			si.NumDirs++
+		} else {
+			itemInfo.DetectType(combinedPath+file.Name(), false)
+			itemInfo.Size = file.Size()
+			fileInfos = append(fileInfos, *itemInfo)
+			totalSize += itemInfo.Size
+			si.NumFiles++
+		}
+	}
+	// Create FileInfo for the current directory
+	dirFileInfo := &FileInfo{
+		Path:    adjustedPath,
+		Files:   fileInfos,
+		Folders: dirInfos,
+	}
+	dirFileInfo.ItemInfo = ItemInfo{
+		Name:    dirInfo.Name(),
+		Type:    "directory",
+		Size:    totalSize,
+		ModTime: dirInfo.ModTime(),
+	}
+
+	dirFileInfo.SortItems()
+
+	// Update the current directory metadata in the index
+	si.UpdateMetadata(dirFileInfo)
+
+	return nil
+}
+
+func (si *Index) makeIndexPath(subPath string) string {
+	if strings.HasPrefix(subPath, "./") {
+		subPath = strings.TrimPrefix(subPath, ".")
+	}
+	if si.Root == subPath || subPath == "." {
+		return "/"
+	}
+	// clean path
+	subPath = strings.TrimSuffix(subPath, "/")
+	// remove index prefix
+	adjustedPath := strings.TrimPrefix(subPath, si.Root)
+	// remove trailing slash
+	adjustedPath = strings.TrimSuffix(adjustedPath, "/")
+	if !strings.HasPrefix(adjustedPath, "/") {
+		adjustedPath = "/" + adjustedPath
+	}
+	return adjustedPath
+}
+
+func (si *Index) recursiveUpdateDirSizes(childInfo *FileInfo, previousSize int64) {
+	parentDir := utils.GetParentDirectoryPath(childInfo.Path)
+	parentInfo, exists := si.GetMetadataInfo(parentDir, true)
+	if !exists || parentDir == "" {
+		return
+	}
+	newSize := parentInfo.Size - previousSize + childInfo.Size
+	parentInfo.Size += newSize
+	si.UpdateMetadata(parentInfo)
+	si.recursiveUpdateDirSizes(parentInfo, newSize)
+}
+
+func (si *Index) RefreshFileInfo(opts FileOptions) error {
+	refreshOptions := FileOptions{
+		Path:  opts.Path,
+		IsDir: opts.IsDir,
+	}
+
+	if !refreshOptions.IsDir {
+		refreshOptions.Path = si.makeIndexPath(filepath.Dir(refreshOptions.Path))
+		refreshOptions.IsDir = true
+	} else {
+		refreshOptions.Path = si.makeIndexPath(refreshOptions.Path)
+	}
+	err := si.indexDirectory(refreshOptions.Path, false, false)
+	if err != nil {
+		return fmt.Errorf("file/folder does not exist to refresh data: %s", refreshOptions.Path)
+	}
+	file, exists := si.GetMetadataInfo(refreshOptions.Path, true)
+	if !exists {
+		return fmt.Errorf("file/folder does not exist in metadata: %s", refreshOptions.Path)
+	}
+
+	current, firstExisted := si.GetMetadataInfo(refreshOptions.Path, true)
+	refreshParentInfo := firstExisted && current.Size != file.Size
+	//utils.PrintStructFields(*file)
+	result := si.UpdateMetadata(file)
+	if !result {
+		return fmt.Errorf("file/folder does not exist in metadata: %s", refreshOptions.Path)
+	}
+	if !exists {
+		return nil
+	}
+	if refreshParentInfo {
+		si.recursiveUpdateDirSizes(file, current.Size)
+	}
+	return nil
+}

backend/files/indexingSchedule.go

@@ -0,0 +1,117 @@
+package files
+
+import (
+	"log"
+	"time"
+
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+)
+
+// schedule in minutes
+var scanSchedule = []time.Duration{
+	5 * time.Minute, // 5 minute quick scan & 25 minutes for a full scan
+	10 * time.Minute,
+	20 * time.Minute, // [3] element is 20 minutes, reset anchor for full scan
+	40 * time.Minute,
+	1 * time.Hour,
+	2 * time.Hour,
+	3 * time.Hour,
+	4 * time.Hour, // 4 hours for quick scan & 20 hours for a full scan
+}
+
+func (si *Index) newScanner(origin string) {
+	fullScanAnchor := 3
+	fullScanCounter := 0 // every 5th scan is a full scan
+	for {
+		// Determine sleep time with modifiers
+		fullScanCounter++
+		sleepTime := scanSchedule[si.currentSchedule] + si.SmartModifier
+		if si.assessment == "simple" {
+			sleepTime = scanSchedule[si.currentSchedule] - si.SmartModifier
+		}
+		if settings.Config.Server.IndexingInterval > 0 {
+			sleepTime = time.Duration(settings.Config.Server.IndexingInterval) * time.Minute
+		}
+
+		// Log and sleep before indexing
+		log.Printf("Next scan in %v\n", sleepTime)
+		time.Sleep(sleepTime)
+
+		si.scannerMu.Lock()
+		if fullScanCounter == 5 {
+			si.RunIndexing(origin, false) // Full scan
+			fullScanCounter = 0
+		} else {
+			si.RunIndexing(origin, true) // Quick scan
+		}
+		si.scannerMu.Unlock()
+
+		// Adjust schedule based on file changes
+		if si.FilesChangedDuringIndexing {
+			// Move to at least the full-scan anchor or reduce interval
+			if si.currentSchedule > fullScanAnchor {
+				si.currentSchedule = fullScanAnchor
+			} else if si.currentSchedule > 0 {
+				si.currentSchedule--
+			}
+		} else {
+			// Increment toward the longest interval if no changes
+			if si.currentSchedule < len(scanSchedule)-1 {
+				si.currentSchedule++
+			}
+		}
+		if si.assessment == "simple" && si.currentSchedule > 3 {
+			si.currentSchedule = 3
+		}
+		// Ensure `currentSchedule` stays within bounds
+		if si.currentSchedule < 0 {
+			si.currentSchedule = 0
+		} else if si.currentSchedule >= len(scanSchedule) {
+			si.currentSchedule = len(scanSchedule) - 1
+		}
+	}
+}
+
+func (si *Index) RunIndexing(origin string, quick bool) {
+	prevNumDirs := si.NumDirs
+	prevNumFiles := si.NumFiles
+	if quick {
+		log.Println("Starting quick scan")
+	} else {
+		log.Println("Starting full scan")
+		si.NumDirs = 0
+		si.NumFiles = 0
+	}
+	startTime := time.Now()
+	si.FilesChangedDuringIndexing = false
+	// Perform the indexing operation
+	err := si.indexDirectory("/", quick, true)
+	if err != nil {
+		log.Printf("Error during indexing: %v", err)
+	}
+	// Update the LastIndexed time
+	si.LastIndexed = time.Now()
+	si.indexingTime = int(time.Since(startTime).Seconds())
+	if !quick {
+		// update smart indexing
+		if si.indexingTime < 3 || si.NumDirs < 10000 {
+			si.assessment = "simple"
+			si.SmartModifier = 4 * time.Minute
+		} else if si.indexingTime > 120 || si.NumDirs > 500000 {
+			si.assessment = "complex"
+			modifier := si.indexingTime / 10 // seconds
+			si.SmartModifier = time.Duration(modifier) * time.Minute
+		} else {
+			si.assessment = "normal"
+		}
+		log.Printf("Index assessment         : complexity=%v directories=%v files=%v \n", si.assessment, si.NumDirs, si.NumFiles)
+		if si.NumDirs != prevNumDirs || si.NumFiles != prevNumFiles {
+			si.FilesChangedDuringIndexing = true
+		}
+	}
+	log.Printf("Time Spent Indexing      : %v seconds\n", si.indexingTime)
+}
+
+func (si *Index) setupIndexingScanners() {
+	go si.newScanner("/")
+}

backend/files/indexing_test.go

@@ -2,17 +2,16 @@ package files
 
 import (
 	"encoding/json"
-	"fmt"
 	"math/rand"
 	"reflect"
 	"testing"
 	"time"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 )
 
 func BenchmarkFillIndex(b *testing.B) {
-	InitializeIndex(5, false)
+	InitializeIndex(false)
 	si := GetIndex(settings.Config.Server.Root)
 	b.ResetTimer()
 	b.ReportAllocs()
@@ -23,67 +22,26 @@ func BenchmarkFillIndex(b *testing.B) {
 
 func (si *Index) createMockData(numDirs, numFilesPerDir int) {
 	for i := 0; i < numDirs; i++ {
-		dirName := generateRandomPath(rand.Intn(3) + 1)
-		files := []*FileInfo{} // Slice of FileInfo
+		dirPath := generateRandomPath(rand.Intn(3) + 1)
+		files := []ItemInfo{} // Slice of FileInfo
 
 		// Simulating files and directories with FileInfo
 		for j := 0; j < numFilesPerDir; j++ {
-			newFile := &FileInfo{
+			newFile := ItemInfo{
 				Name:    "file-" + getRandomTerm() + getRandomExtension(),
-				IsDir:   false,
 				Size:    rand.Int63n(1000),                                          // Random size
 				ModTime: time.Now().Add(-time.Duration(rand.Intn(100)) * time.Hour), // Random mod time
+				Type:    "blob",
 			}
 			files = append(files, newFile)
 		}
-
-		// Simulate inserting files into index
-		for _, file := range files {
-			_, err := si.InsertInfo(dirName, file)
-			if err != nil {
-				fmt.Println("Error inserting file:", err)
-			}
+		dirInfo := &FileInfo{
+			Path:  dirPath,
+			Files: files,
 		}
-	}
-}
 
-func generateRandomPath(levels int) string {
-	rand.New(rand.NewSource(time.Now().UnixNano()))
-	dirName := "srv"
-	for i := 0; i < levels; i++ {
-		dirName += "/" + getRandomTerm()
+		si.UpdateMetadata(dirInfo)
 	}
-	return dirName
-}
-
-func getRandomTerm() string {
-	wordbank := []string{
-		"hi", "test", "other", "name",
-		"cool", "things", "more", "items",
-	}
-	rand.New(rand.NewSource(time.Now().UnixNano()))
-
-	index := rand.Intn(len(wordbank))
-	return wordbank[index]
-}
-
-func getRandomExtension() string {
-	wordbank := []string{
-		".txt", ".mp3", ".mov", ".doc",
-		".mp4", ".bak", ".zip", ".jpg",
-	}
-	rand.New(rand.NewSource(time.Now().UnixNano()))
-	index := rand.Intn(len(wordbank))
-	return wordbank[index]
-}
-
-func generateRandomSearchTerms(numTerms int) []string {
-	// Generate random search terms
-	searchTerms := make([]string, numTerms)
-	for i := 0; i < numTerms; i++ {
-		searchTerms[i] = getRandomTerm()
-	}
-	return searchTerms
 }
 
 // JSONBytesEqual compares the JSON in two byte slices.
@@ -114,36 +72,30 @@ func TestGetIndex(t *testing.T) {
 	}
 }
 
-func TestInitializeIndex(t *testing.T) {
-	type args struct {
-		intervalMinutes uint32
-	}
+func TestMakeIndexPath(t *testing.T) {
 	tests := []struct {
-		name string
-		args args
+		name     string
+		subPath  string
+		expected string
 	}{
-		// TODO: Add test cases.
+		{"Root path returns slash", "/", "/"},
+		{"Dot-prefixed returns slash", ".", "/"},
+		{"Double-dot prefix ignored", "./", "/"},
+		{"Dot prefix followed by text", "./test", "/test"},
+		{"Dot prefix followed by text", ".test", "/.test"},
+		{"Hidden file at root", "/.test", "/.test"},
+		{"Trailing slash removed", "/test/", "/test"},
+		{"Subpath without root prefix", "/other/test", "/other/test"},
+		{"Complex nested paths", "/nested/path", "/nested/path"},
 	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			InitializeIndex(tt.args.intervalMinutes, false)
-		})
-	}
-}
 
-func Test_indexingScheduler(t *testing.T) {
-	type args struct {
-		intervalMinutes uint32
-	}
-	tests := []struct {
-		name string
-		args args
-	}{
-		// TODO: Add test cases.
-	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			indexingScheduler(tt.args.intervalMinutes)
+			si := &Index{Root: "/"}
+			result := si.makeIndexPath(tt.subPath)
+			if result != tt.expected {
+				t.Errorf("makeIndexPath(%q) = %q; want %q", tt.name, result, tt.expected)
+			}
 		})
 	}
 }

backend/files/mockIndexing.go

@@ -0,0 +1,71 @@
+package files
+
+import (
+	"time"
+
+	"math/rand"
+)
+
+func CreateMockData(numDirs, numFilesPerDir int) FileInfo {
+	dir := FileInfo{}
+	dir.Path = "/here/is/your/mock/dir"
+	for i := 0; i < numDirs; i++ {
+		newFile := ItemInfo{
+			Name:    "file-" + getRandomTerm() + getRandomExtension(),
+			Size:    rand.Int63n(1000),                                          // Random size
+			ModTime: time.Now().Add(-time.Duration(rand.Intn(100)) * time.Hour), // Random mod time
+			Type:    "blob",
+		}
+		dir.Folders = append(dir.Folders, newFile)
+	}
+	// Simulating files and directories with FileInfo
+	for j := 0; j < numFilesPerDir; j++ {
+		newFile := ItemInfo{
+			Name:    "file-" + getRandomTerm() + getRandomExtension(),
+			Size:    rand.Int63n(1000),                                          // Random size
+			ModTime: time.Now().Add(-time.Duration(rand.Intn(100)) * time.Hour), // Random mod time
+			Type:    "blob",
+		}
+		dir.Files = append(dir.Files, newFile)
+	}
+	return dir
+}
+
+func generateRandomPath(levels int) string {
+	rand.New(rand.NewSource(time.Now().UnixNano()))
+	dirName := "srv"
+	for i := 0; i < levels; i++ {
+		dirName += "/" + getRandomTerm()
+	}
+	return dirName
+}
+
+func getRandomTerm() string {
+	wordbank := []string{
+		"hi", "test", "other", "name",
+		"cool", "things", "more", "items",
+	}
+	rand.New(rand.NewSource(time.Now().UnixNano()))
+
+	index := rand.Intn(len(wordbank))
+	return wordbank[index]
+}
+
+func getRandomExtension() string {
+	wordbank := []string{
+		".txt", ".mp3", ".mov", ".doc",
+		".mp4", ".bak", ".zip", ".jpg",
+	}
+	rand.New(rand.NewSource(time.Now().UnixNano()))
+	index := rand.Intn(len(wordbank))
+	return wordbank[index]
+}
+
+func generateRandomSearchTerms(numTerms int) []string {
+	// Generate random search terms
+	searchTerms := make([]string, numTerms)
+	for i := 0; i < numTerms; i++ {
+		searchTerms[i] = getRandomTerm()
+	}
+	return searchTerms
+}

backend/files/search.go

@@ -1,12 +1,12 @@
 package files
 
 import (
-	"math/rand"
 	"path/filepath"
 	"sort"
 	"strings"
 	"sync"
-	"time"
+
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 var (
@@ -14,123 +14,120 @@ var (
 	maxSearchResults  = 100
 )
 
-func (si *Index) Search(search string, scope string, sourceSession string) ([]string, map[string]map[string]bool) {
+type SearchResult struct {
+	Path string `json:"path"`
+	Type string `json:"type"`
+	Size int64  `json:"size"`
+}
+
+func (si *Index) Search(search string, scope string, sourceSession string) []SearchResult {
 	// Remove slashes
-	scope = strings.TrimLeft(scope, "/")
-	scope = strings.TrimRight(scope, "/")
-	runningHash := generateRandomHash(4)
+	scope = si.makeIndexPath(scope)
+	runningHash := utils.GenerateRandomHash(4)
 	sessionInProgress.Store(sourceSession, runningHash) // Store the value in the sync.Map
 	searchOptions := ParseSearch(search)
-	fileListTypes := make(map[string]map[string]bool)
-	matching := []string{}
+	results := make(map[string]SearchResult, 0)
 	count := 0
+	var directories []string
+	cachedDirs, ok := utils.SearchResultsCache.Get(si.Root + scope).([]string)
+	if ok {
+		directories = cachedDirs
+	} else {
+		directories = si.getDirsInScope(scope)
+		utils.SearchResultsCache.Set(si.Root+scope, directories)
+	}
 	for _, searchTerm := range searchOptions.Terms {
 		if searchTerm == "" {
 			continue
 		}
+		if count > maxSearchResults {
+			break
+		}
 		si.mu.Lock()
-		for dirName, dir := range si.Directories {
-			isDir := true
-			files := []string{}
-			for _, item := range dir.Items {
-				if !item.IsDir {
-					files = append(files, item.Name)
-				}
-			}
-			value, found := sessionInProgress.Load(sourceSession)
-			if !found || value != runningHash {
-				si.mu.Unlock()
-				return []string{}, map[string]map[string]bool{}
+		for _, dirName := range directories {
+			scopedPath := strings.TrimPrefix(strings.TrimPrefix(dirName, scope), "/") + "/"
+			si.mu.Unlock()
+			dir, found := si.GetReducedMetadata(dirName, true)
+			si.mu.Lock()
+			if !found {
+				continue
 			}
 			if count > maxSearchResults {
 				break
 			}
-			pathName := scopedPathNameFilter(dirName, scope, isDir)
-			if pathName == "" {
-				continue // path not matched
+			reducedDir := ItemInfo{
+				Name: filepath.Base(dirName),
+				Type: "directory",
+				Size: dir.Size,
 			}
-			fileTypes := map[string]bool{}
-			si.mu.Unlock()
-			matches, fileType := si.containsSearchTerm(dirName, searchTerm, *searchOptions, isDir, fileTypes)
-			si.mu.Lock()
+			matches := reducedDir.containsSearchTerm(searchTerm, searchOptions)
 			if matches {
-				fileListTypes[pathName] = fileType
-				matching = append(matching, pathName)
+				results[scopedPath] = SearchResult{Path: scopedPath, Type: "directory", Size: dir.Size}
 				count++
 			}
-			isDir = false
-			for _, file := range files {
-				if file == "" {
-					continue
+			// search files first
+			for _, item := range dir.Files {
+				fullPath := dirName + "/" + item.Name
+				scopedPath := strings.TrimPrefix(strings.TrimPrefix(fullPath, scope), "/")
+				if item.Type == "directory" {
+					scopedPath += "/"
 				}
 				value, found := sessionInProgress.Load(sourceSession)
 				if !found || value != runningHash {
-					return []string{}, map[string]map[string]bool{}
+					si.mu.Unlock()
+					return []SearchResult{}
 				}
-
 				if count > maxSearchResults {
 					break
 				}
-				fullName := strings.TrimLeft(pathName+file, "/")
-				fileTypes := map[string]bool{}
-				si.mu.Unlock()
-				matches, fileType := si.containsSearchTerm(fullName, searchTerm, *searchOptions, isDir, fileTypes)
-				si.mu.Lock()
-				if !matches {
-					continue
+				matches := item.containsSearchTerm(searchTerm, searchOptions)
+				if matches {
+					results[scopedPath] = SearchResult{Path: scopedPath, Type: item.Type, Size: item.Size}
+					count++
 				}
-				fileListTypes[fullName] = fileType
-				matching = append(matching, fullName)
-				count++
 			}
 		}
 		si.mu.Unlock()
 	}
+
+	// Sort keys based on the number of elements in the path after splitting by "/"
+	sortedKeys := make([]SearchResult, 0, len(results))
+	for _, v := range results {
+		sortedKeys = append(sortedKeys, v)
+	}
 	// Sort the strings based on the number of elements after splitting by "/"
-	sort.Slice(matching, func(i, j int) bool {
-		parts1 := strings.Split(matching[i], "/")
-		parts2 := strings.Split(matching[j], "/")
+	sort.Slice(sortedKeys, func(i, j int) bool {
+		parts1 := strings.Split(sortedKeys[i].Path, "/")
+		parts2 := strings.Split(sortedKeys[j].Path, "/")
 		return len(parts1) < len(parts2)
 	})
-	return matching, fileListTypes
+	return sortedKeys
 }
 
-func scopedPathNameFilter(pathName string, scope string, isDir bool) string {
-	pathName = strings.TrimLeft(pathName, "/")
-	pathName = strings.TrimRight(pathName, "/")
-	if strings.HasPrefix(pathName, scope) || scope == "" {
-		pathName = strings.TrimPrefix(pathName, scope)
-		pathName = strings.TrimLeft(pathName, "/")
-		if isDir {
-			pathName = pathName + "/"
-		}
-	} else {
-		pathName = "" // return not matched
-	}
-	return pathName
-}
+// returns true if the file name contains the search term
+// returns file type if the file name contains the search term
+// returns size of file/dir if the file name contains the search term
+func (fi ItemInfo) containsSearchTerm(searchTerm string, options SearchOptions) bool {
 
-func (si *Index) containsSearchTerm(pathName string, searchTerm string, options SearchOptions, isDir bool, fileTypes map[string]bool) (bool, map[string]bool) {
+	fileTypes := map[string]bool{}
 	largerThan := int64(options.LargerThan) * 1024 * 1024
 	smallerThan := int64(options.SmallerThan) * 1024 * 1024
 	conditions := options.Conditions
-	fileName := filepath.Base(pathName)
-	adjustedPath := si.makeIndexPath(pathName, isDir)
+	lowerFileName := strings.ToLower(fi.Name)
 
 	// Convert to lowercase if not exact match
 	if !conditions["exact"] {
-		fileName = strings.ToLower(fileName)
 		searchTerm = strings.ToLower(searchTerm)
 	}
 
 	// Check if the file name contains the search term
-	if !strings.Contains(fileName, searchTerm) {
-		return false, map[string]bool{}
+	if !strings.Contains(lowerFileName, searchTerm) {
+		return false
 	}
 
 	// Initialize file size and fileTypes map
 	var fileSize int64
-	extension := filepath.Ext(fileName)
+	extension := filepath.Ext(lowerFileName)
 
 	// Collect file types
 	for _, k := range AllFiletypeOptions {
@@ -138,31 +135,9 @@ func (si *Index) containsSearchTerm(pathName string, searchTerm string, options
 			fileTypes[k] = true
 		}
 	}
+	isDir := fi.Type == "directory"
 	fileTypes["dir"] = isDir
-	// Get file info if needed for size-related conditions
-	if largerThan > 0 || smallerThan > 0 {
-		fileInfo, exists := si.GetMetadataInfo(adjustedPath)
-		if !exists {
-			return false, fileTypes
-		} else if !isDir {
-			// Look for specific file in ReducedItems
-			for _, item := range fileInfo.ReducedItems {
-				lower := strings.ToLower(item.Name)
-				if strings.Contains(lower, searchTerm) {
-					if item.Size == 0 {
-						return false, fileTypes
-					}
-					fileSize = item.Size
-					break
-				}
-			}
-		} else {
-			fileSize = fileInfo.Size
-		}
-		if fileSize == 0 {
-			return false, fileTypes
-		}
-	}
+	fileSize = fi.Size
 
 	// Evaluate all conditions
 	for t, v := range conditions {
@@ -173,33 +148,35 @@ func (si *Index) containsSearchTerm(pathName string, searchTerm string, options
 		case "larger":
 			if largerThan > 0 {
 				if fileSize <= largerThan {
-					return false, fileTypes
+					return false
 				}
 			}
 		case "smaller":
 			if smallerThan > 0 {
 				if fileSize >= smallerThan {
-					return false, fileTypes
+					return false
 				}
 			}
 		default:
 			// Handle other file type conditions
 			notMatchType := v != fileTypes[t]
 			if notMatchType {
-				return false, fileTypes
+				return false
 			}
 		}
 	}
 
-	return true, fileTypes
+	return true
 }
 
-func generateRandomHash(length int) string {
-	const charset = "abcdefghijklmnopqrstuvwxyz0123456789"
-	rand.New(rand.NewSource(time.Now().UnixNano()))
-	result := make([]byte, length)
-	for i := range result {
-		result[i] = charset[rand.Intn(len(charset))]
+func (si *Index) getDirsInScope(scope string) []string {
+	newList := []string{}
+	si.mu.Lock()
+	defer si.mu.Unlock()
+	for k := range si.Directories {
+		if strings.HasPrefix(k, scope) || scope == "" {
+			newList = append(newList, k)
+		}
 	}
-	return string(result)
+	return newList
 }

backend/files/search_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func BenchmarkSearchAllIndexes(b *testing.B) {
-	InitializeIndex(5, false)
+	InitializeIndex(false)
 	si := GetIndex(rootPath)
 
 	si.createMockData(50, 3) // 50 dirs, 3 files per dir
@@ -29,25 +29,25 @@ func BenchmarkSearchAllIndexes(b *testing.B) {
 func TestParseSearch(t *testing.T) {
 	tests := []struct {
 		input string
-		want  *SearchOptions
+		want  SearchOptions
 	}{
 		{
 			input: "my test search",
-			want: &SearchOptions{
+			want: SearchOptions{
 				Conditions: map[string]bool{"exact": false},
 				Terms:      []string{"my test search"},
 			},
 		},
 		{
 			input: "case:exact my|test|search",
-			want: &SearchOptions{
+			want: SearchOptions{
 				Conditions: map[string]bool{"exact": true},
 				Terms:      []string{"my", "test", "search"},
 			},
 		},
 		{
 			input: "type:largerThan=100 type:smallerThan=1000 test",
-			want: &SearchOptions{
+			want: SearchOptions{
 				Conditions:  map[string]bool{"exact": false, "larger": true, "smaller": true},
 				Terms:       []string{"test"},
 				LargerThan:  100,
@@ -56,7 +56,7 @@ func TestParseSearch(t *testing.T) {
 		},
 		{
 			input: "type:audio thisfile",
-			want: &SearchOptions{
+			want: SearchOptions{
 				Conditions: map[string]bool{"exact": false, "audio": true},
 				Terms:      []string{"thisfile"},
 			},
@@ -74,7 +74,7 @@ func TestParseSearch(t *testing.T) {
 }
 
 func TestSearchWhileIndexing(t *testing.T) {
-	InitializeIndex(5, false)
+	InitializeIndex(false)
 	si := GetIndex(rootPath)
 
 	searchTerms := generateRandomSearchTerms(10)
@@ -88,24 +88,30 @@ func TestSearchWhileIndexing(t *testing.T) {
 
 func TestSearchIndexes(t *testing.T) {
 	index := Index{
-		Directories: map[string]FileInfo{
-			"test":      {Items: []*FileInfo{{Name: "audio1.wav"}}},
-			"test/path": {Items: []*FileInfo{{Name: "file.txt"}}},
-			"new/test": {Items: []*FileInfo{
-				{Name: "audio.wav"},
-				{Name: "video.mp4"},
-				{Name: "video.MP4"},
+		Directories: map[string]*FileInfo{
+			"/test":      {Files: []ItemInfo{{Name: "audio1.wav", Type: "audio"}}},
+			"/test/path": {Files: []ItemInfo{{Name: "file.txt", Type: "text"}}},
+			"/new/test": {Files: []ItemInfo{
+				{Name: "audio.wav", Type: "audio"},
+				{Name: "video.mp4", Type: "video"},
+				{Name: "video.MP4", Type: "video"},
 			}},
-			"new/test/path": {Items: []*FileInfo{{Name: "archive.zip"}}},
-			"/firstDir": {Items: []*FileInfo{
-				{Name: "archive.zip", Size: 100},
-				{Name: "thisIsDir", IsDir: true, Size: 2 * 1024 * 1024},
-			}},
-			"/firstDir/thisIsDir": {
-				Items: []*FileInfo{
-					{Name: "hi.txt"},
+			"/new/test/path": {Files: []ItemInfo{{Name: "archive.zip", Type: "archive"}}},
+			"/firstDir": {
+				Files: []ItemInfo{
+					{Name: "archive.zip", Size: 100, Type: "archive"},
+				},
+				Folders: []ItemInfo{
+					{Name: "thisIsDir", Type: "directory", Size: 2 * 1024 * 1024},
+				},
+			},
+			"/firstDir/thisIsDir": {
+				Files: []ItemInfo{
+					{Name: "hi.txt", Type: "text"},
+				},
+				ItemInfo: ItemInfo{
+					Size: 2 * 1024 * 1024,
 				},
-				Size: 2 * 1024 * 1024,
 			},
 		},
 	}
@@ -113,112 +119,106 @@ func TestSearchIndexes(t *testing.T) {
 	tests := []struct {
 		search         string
 		scope          string
-		expectedResult []string
-		expectedTypes  map[string]map[string]bool
+		expectedResult []SearchResult
 	}{
 		{
-			search:         "audio",
-			scope:          "/new/",
-			expectedResult: []string{"test/audio.wav"},
-			expectedTypes: map[string]map[string]bool{
-				"test/audio.wav": {"audio": true, "dir": false},
+			search: "audio",
+			scope:  "/new/",
+			expectedResult: []SearchResult{
+				{
+					Path: "test/audio.wav",
+					Type: "audio",
+					Size: 0,
+				},
 			},
 		},
 		{
-			search:         "test",
-			scope:          "/",
-			expectedResult: []string{"test/", "new/test/"},
-			expectedTypes: map[string]map[string]bool{
-				"test/":     {"dir": true},
-				"new/test/": {"dir": true},
+			search: "test",
+			scope:  "/",
+			expectedResult: []SearchResult{
+				{
+					Path: "test/",
+					Type: "directory",
+					Size: 0,
+				},
+				{
+					Path: "new/test/",
+					Type: "directory",
+					Size: 0,
+				},
 			},
 		},
 		{
-			search:         "archive",
-			scope:          "/",
-			expectedResult: []string{"firstDir/archive.zip", "new/test/path/archive.zip"},
-			expectedTypes: map[string]map[string]bool{
-				"new/test/path/archive.zip": {"archive": true, "dir": false},
-				"firstDir/archive.zip":      {"archive": true, "dir": false},
+			search: "archive",
+			scope:  "/",
+			expectedResult: []SearchResult{
+				{
+					Path: "firstDir/archive.zip",
+					Type: "archive",
+					Size: 100,
+				},
+				{
+					Path: "new/test/path/archive.zip",
+					Type: "archive",
+					Size: 0,
+				},
 			},
 		},
 		{
-			search:         "arch",
-			scope:          "/firstDir",
-			expectedResult: []string{"archive.zip"},
-			expectedTypes: map[string]map[string]bool{
-				"archive.zip": {"archive": true, "dir": false},
+			search: "arch",
+			scope:  "/firstDir",
+			expectedResult: []SearchResult{
+				{
+					Path: "archive.zip",
+					Type: "archive",
+					Size: 100,
+				},
 			},
 		},
 		{
-			search:         "isdir",
-			scope:          "/",
-			expectedResult: []string{"firstDir/thisIsDir/"},
-			expectedTypes: map[string]map[string]bool{
-				"firstDir/thisIsDir/": {"dir": true},
+			search: "isdir",
+			scope:  "/",
+			expectedResult: []SearchResult{
+				{
+					Path: "firstDir/thisIsDir/",
+					Type: "directory",
+					Size: 2097152,
+				},
 			},
 		},
 		{
-			search:         "dir type:largerThan=1",
-			scope:          "/",
-			expectedResult: []string{"firstDir/thisIsDir/"},
-			expectedTypes: map[string]map[string]bool{
-				"firstDir/thisIsDir/": {"dir": true},
+			search: "IsDir type:largerThan=1",
+			scope:  "/",
+			expectedResult: []SearchResult{
+				{
+					Path: "firstDir/thisIsDir/",
+					Type: "directory",
+					Size: 2097152,
+				},
 			},
 		},
 		{
 			search: "video",
 			scope:  "/",
-			expectedResult: []string{
-				"new/test/video.mp4",
-				"new/test/video.MP4",
-			},
-			expectedTypes: map[string]map[string]bool{
-				"new/test/video.MP4": {"video": true, "dir": false},
-				"new/test/video.mp4": {"video": true, "dir": false},
+			expectedResult: []SearchResult{
+				{
+					Path: "new/test/video.MP4",
+					Type: "video",
+					Size: 0,
+				},
+				{
+					Path: "new/test/video.mp4",
+					Type: "video",
+					Size: 0,
+				},
 			},
 		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.search, func(t *testing.T) {
-			actualResult, actualTypes := index.Search(tt.search, tt.scope, "")
-			assert.Equal(t, tt.expectedResult, actualResult)
-			assert.Equal(t, tt.expectedTypes, actualTypes)
-		})
-	}
-}
-
-func Test_scopedPathNameFilter(t *testing.T) {
-	tests := []struct {
-		name string
-		args struct {
-			pathName string
-			scope    string
-			isDir    bool // Assuming isDir should be included in args
-		}
-		want string
-	}{
-		{
-			name: "scope test",
-			args: struct {
-				pathName string
-				scope    string
-				isDir    bool
-			}{
-				pathName: "/",
-				scope:    "/",
-				isDir:    false,
-			},
-			want: "", // Update this with the expected result
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if got := scopedPathNameFilter(tt.args.pathName, tt.args.scope, tt.args.isDir); got != tt.want {
-				t.Errorf("scopedPathNameFilter() = %v, want %v", got, tt.want)
-			}
+			result := index.Search(tt.search, tt.scope, "")
+			assert.ElementsMatch(t, tt.expectedResult, result)
 		})
 	}
 }

backend/files/sync.go

@@ -1,102 +1,71 @@
 package files
 
 import (
-	"log"
-	"time"
+	"path/filepath"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 )
 
 // UpdateFileMetadata updates the FileInfo for the specified directory in the index.
-func (si *Index) UpdateFileMetadata(adjustedPath string, info FileInfo) bool {
+func (si *Index) UpdateMetadata(info *FileInfo) bool {
 	si.mu.Lock()
 	defer si.mu.Unlock()
-	dir, exists := si.Directories[adjustedPath]
-	if !exists {
-		si.Directories[adjustedPath] = FileInfo{}
-	}
-	return si.SetFileMetadata(adjustedPath, dir)
-}
-
-// SetFileMetadata sets the FileInfo for the specified directory in the index.
-// internal use only
-func (si *Index) SetFileMetadata(adjustedPath string, info FileInfo) bool {
-	_, exists := si.Directories[adjustedPath]
-	if !exists {
-		return false
-	}
-	info.CacheTime = time.Now()
-	si.Directories[adjustedPath] = info
+	si.Directories[info.Path] = info
 	return true
 }
 
 // GetMetadataInfo retrieves the FileInfo from the specified directory in the index.
-func (si *Index) GetMetadataInfo(adjustedPath string) (FileInfo, bool) {
-	si.mu.RLock()
-	dir, exists := si.Directories[adjustedPath]
-	si.mu.RUnlock()
-	if !exists {
-		return dir, exists
-	}
-	// remove recursive items, we only want this directories direct files
-	cleanedItems := []ReducedItem{}
-	for _, item := range dir.Items {
-		cleanedItems = append(cleanedItems, ReducedItem{
-			Name:    item.Name,
-			Size:    item.Size,
-			IsDir:   item.IsDir,
-			ModTime: item.ModTime,
-			Type:    item.Type,
-		})
-	}
-	dir.Items = nil
-	dir.ReducedItems = cleanedItems
-	realPath, _, _ := GetRealPath(adjustedPath)
-	dir.Path = realPath
-	return dir, exists
-}
-
-// SetDirectoryInfo sets the directory information in the index.
-func (si *Index) SetDirectoryInfo(adjustedPath string, dir FileInfo) {
+func (si *Index) GetReducedMetadata(target string, isDir bool) (*FileInfo, bool) {
 	si.mu.Lock()
-	si.Directories[adjustedPath] = dir
-	si.mu.Unlock()
+	defer si.mu.Unlock()
+	checkDir := si.makeIndexPath(target)
+	if !isDir {
+		checkDir = si.makeIndexPath(filepath.Dir(target))
+	}
+	dir, exists := si.Directories[checkDir]
+	if !exists {
+		return nil, false
+	}
+
+	if isDir {
+		return dir, true
+	}
+	// handle file
+	if checkDir == "/" {
+		checkDir = ""
+	}
+	baseName := filepath.Base(target)
+	for _, item := range dir.Files {
+		if item.Name == baseName {
+			return &FileInfo{
+				Path:     checkDir + "/" + item.Name,
+				ItemInfo: item,
+			}, true
+		}
+	}
+	return nil, false
+
 }
 
-// SetDirectoryInfo sets the directory information in the index.
-func (si *Index) GetDirectoryInfo(adjustedPath string) (FileInfo, bool) {
+// GetMetadataInfo retrieves the FileInfo from the specified directory in the index.
+func (si *Index) GetMetadataInfo(target string, isDir bool) (*FileInfo, bool) {
 	si.mu.RLock()
-	dir, exists := si.Directories[adjustedPath]
-	si.mu.RUnlock()
+	defer si.mu.RUnlock()
+	checkDir := si.makeIndexPath(target)
+	if !isDir {
+		checkDir = si.makeIndexPath(filepath.Dir(target))
+	}
+	dir, exists := si.Directories[checkDir]
 	return dir, exists
 }
 
 func (si *Index) RemoveDirectory(path string) {
 	si.mu.Lock()
 	defer si.mu.Unlock()
+	si.NumDeleted++
 	delete(si.Directories, path)
 }
 
-func (si *Index) UpdateCount(given string) {
-	si.mu.Lock()
-	defer si.mu.Unlock()
-	if given == "files" {
-		si.NumFiles++
-	} else if given == "dirs" {
-		si.NumDirs++
-	} else {
-		log.Println("could not update unknown type: ", given)
-	}
-}
-
-func (si *Index) resetCount() {
-	si.mu.Lock()
-	defer si.mu.Unlock()
-	si.NumDirs = 0
-	si.NumFiles = 0
-	si.inProgress = true
-}
-
 func GetIndex(root string) *Index {
 	for _, index := range indexes {
 		if index.Root == root {
@@ -108,11 +77,11 @@ func GetIndex(root string) *Index {
 	}
 	newIndex := &Index{
 		Root:        rootPath,
-		Directories: map[string]FileInfo{},
+		Directories: map[string]*FileInfo{},
 		NumDirs:     0,
 		NumFiles:    0,
-		inProgress:  false,
 	}
+	newIndex.Directories["/"] = &FileInfo{}
 	indexesMutex.Lock()
 	indexes = append(indexes, newIndex)
 	indexesMutex.Unlock()

backend/files/sync_test.go

@@ -32,9 +32,9 @@ func TestGetFileMetadataSize(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			fileInfo, _ := testIndex.GetMetadataInfo(tt.adjustedPath)
+			fileInfo, _ := testIndex.GetReducedMetadata(tt.adjustedPath, true)
 			// Iterate over fileInfo.Items to look for expectedName
-			for _, item := range fileInfo.ReducedItems {
+			for _, item := range fileInfo.Files {
 				// Assert the existence and the name
 				if item.Name == tt.expectedName {
 					assert.Equal(t, tt.expectedSize, item.Size)
@@ -53,28 +53,29 @@ func TestGetFileMetadata(t *testing.T) {
 		adjustedPath   string
 		expectedName   string
 		expectedExists bool
+		isDir          bool
 	}{
 		{
 			name:           "testpath exists",
-			adjustedPath:   "/testpath",
+			adjustedPath:   "/testpath/testfile.txt",
 			expectedName:   "testfile.txt",
 			expectedExists: true,
 		},
 		{
 			name:           "testpath not exists",
-			adjustedPath:   "/testpath",
+			adjustedPath:   "/testpath/nonexistent.txt",
 			expectedName:   "nonexistent.txt",
 			expectedExists: false,
 		},
 		{
 			name:           "File exists in /anotherpath",
-			adjustedPath:   "/anotherpath",
+			adjustedPath:   "/anotherpath/afile.txt",
 			expectedName:   "afile.txt",
 			expectedExists: true,
 		},
 		{
 			name:           "File does not exist in /anotherpath",
-			adjustedPath:   "/anotherpath",
+			adjustedPath:   "/anotherpath/nonexistentfile.txt",
 			expectedName:   "nonexistentfile.txt",
 			expectedExists: false,
 		},
@@ -83,20 +84,33 @@ func TestGetFileMetadata(t *testing.T) {
 			adjustedPath:   "/nonexistentpath",
 			expectedName:   "",
 			expectedExists: false,
+			isDir:          true,
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			fileInfo, _ := testIndex.GetMetadataInfo(tt.adjustedPath)
+			fileInfo, exists := testIndex.GetReducedMetadata(tt.adjustedPath, tt.isDir)
+			if !exists {
+				found := false
+				assert.Equal(t, tt.expectedExists, found)
+				return
+			}
 			found := false
-			// Iterate over fileInfo.Items to look for expectedName
-			for _, item := range fileInfo.ReducedItems {
-				// Assert the existence and the name
-				if item.Name == tt.expectedName {
+			if tt.isDir {
+				// Iterate over fileInfo.Items to look for expectedName
+				for _, item := range fileInfo.Files {
+					// Assert the existence and the name
+					if item.Name == tt.expectedName {
+						found = true
+						break
+					}
+				}
+			} else {
+				if fileInfo.Name == tt.expectedName {
 					found = true
-					break
 				}
 			}
+
 			assert.Equal(t, tt.expectedExists, found)
 		})
 	}
@@ -104,42 +118,40 @@ func TestGetFileMetadata(t *testing.T) {
 
 // Test for UpdateFileMetadata
 func TestUpdateFileMetadata(t *testing.T) {
-	index := &Index{
-		Directories: map[string]FileInfo{
-			"/testpath": {
-				Path:  "/testpath",
-				Name:  "testpath",
-				IsDir: true,
-				ReducedItems: []ReducedItem{
-					{Name: "testfile.txt"},
-					{Name: "anotherfile.txt"},
-				},
-			},
+	info := &FileInfo{
+		Path: "/testpath",
+		Files: []ItemInfo{
+			{Name: "testfile.txt"},
+			{Name: "anotherfile.txt"},
 		},
 	}
 
-	info := FileInfo{Name: "testfile.txt"}
+	index := &Index{
+		Directories: map[string]*FileInfo{
+			"/testpath": info,
+		},
+	}
 
-	success := index.UpdateFileMetadata("/testpath", info)
+	success := index.UpdateMetadata(info)
 	if !success {
 		t.Fatalf("expected UpdateFileMetadata to succeed")
 	}
 
-	dir, exists := index.Directories["/testpath"]
-	if !exists || dir.ReducedItems[0].Name != "testfile.txt" {
-		t.Fatalf("expected testfile.txt to be updated in the directory metadata")
+	fileInfo, exists := index.GetReducedMetadata("/testpath/testfile.txt", false)
+	if !exists || fileInfo.Name != "testfile.txt" {
+		t.Fatalf("expected testfile.txt to be updated in the directory metadata:%v %v", exists, info.Name)
 	}
 }
 
 // Test for GetDirMetadata
 func TestGetDirMetadata(t *testing.T) {
 	t.Parallel()
-	_, exists := testIndex.GetMetadataInfo("/testpath")
+	_, exists := testIndex.GetReducedMetadata("/testpath", true)
 	if !exists {
 		t.Fatalf("expected GetDirMetadata to return initialized metadata map")
 	}
 
-	_, exists = testIndex.GetMetadataInfo("/nonexistent")
+	_, exists = testIndex.GetReducedMetadata("/nonexistent", true)
 	if exists {
 		t.Fatalf("expected GetDirMetadata to return false for nonexistent directory")
 	}
@@ -148,51 +160,41 @@ func TestGetDirMetadata(t *testing.T) {
 // Test for SetDirectoryInfo
 func TestSetDirectoryInfo(t *testing.T) {
 	index := &Index{
-		Directories: map[string]FileInfo{
+		Directories: map[string]*FileInfo{
 			"/testpath": {
-				Path:  "/testpath",
-				Name:  "testpath",
-				IsDir: true,
-				Items: []*FileInfo{
+				Path: "/testpath",
+				ItemInfo: ItemInfo{
+					Name: "testpath",
+					Type: "directory",
+				},
+				Files: []ItemInfo{
 					{Name: "testfile.txt"},
 					{Name: "anotherfile.txt"},
 				},
 			},
 		},
 	}
-	dir := FileInfo{
-		Path:  "/newPath",
-		Name:  "newPath",
-		IsDir: true,
-		Items: []*FileInfo{
+	dir := &FileInfo{
+		Path: "/newPath",
+		ItemInfo: ItemInfo{
+			Name: "newPath",
+			Type: "directory",
+		},
+		Files: []ItemInfo{
 			{Name: "testfile.txt"},
 		},
 	}
-	index.SetDirectoryInfo("/newPath", dir)
+	index.UpdateMetadata(dir)
 	storedDir, exists := index.Directories["/newPath"]
-	if !exists || storedDir.Items[0].Name != "testfile.txt" {
+	if !exists || storedDir.Files[0].Name != "testfile.txt" {
 		t.Fatalf("expected SetDirectoryInfo to store directory info correctly")
 	}
 }
 
-// Test for GetDirectoryInfo
-func TestGetDirectoryInfo(t *testing.T) {
-	t.Parallel()
-	dir, exists := testIndex.GetDirectoryInfo("/testpath")
-	if !exists || dir.Items[0].Name != "testfile.txt" {
-		t.Fatalf("expected GetDirectoryInfo to return correct directory info")
-	}
-
-	_, exists = testIndex.GetDirectoryInfo("/nonexistent")
-	if exists {
-		t.Fatalf("expected GetDirectoryInfo to return false for nonexistent directory")
-	}
-}
-
 // Test for RemoveDirectory
 func TestRemoveDirectory(t *testing.T) {
 	index := &Index{
-		Directories: map[string]FileInfo{
+		Directories: map[string]*FileInfo{
 			"/testpath": {},
 		},
 	}
@@ -203,59 +205,35 @@ func TestRemoveDirectory(t *testing.T) {
 	}
 }
 
-// Test for UpdateCount
-func TestUpdateCount(t *testing.T) {
-	index := &Index{}
-	index.UpdateCount("files")
-	if index.NumFiles != 1 {
-		t.Fatalf("expected NumFiles to be 1 after UpdateCount('files')")
-	}
-	if index.NumFiles != 1 {
-		t.Fatalf("expected NumFiles to be 1 after UpdateCount('files')")
-	}
-	index.UpdateCount("dirs")
-	if index.NumDirs != 1 {
-		t.Fatalf("expected NumDirs to be 1 after UpdateCount('dirs')")
-	}
-	index.UpdateCount("unknown")
-	// Just ensure it does not panic or update any counters
-	if index.NumFiles != 1 || index.NumDirs != 1 {
-		t.Fatalf("expected counts to remain unchanged for unknown type")
-	}
-	index.resetCount()
-	if index.NumFiles != 0 || index.NumDirs != 0 || !index.inProgress {
-		t.Fatalf("expected resetCount to reset counts and set inProgress to true")
-	}
-}
-
 func init() {
 	testIndex = Index{
-		Root:       "/",
-		NumFiles:   10,
-		NumDirs:    5,
-		inProgress: false,
-		Directories: map[string]FileInfo{
+		Root:     "/",
+		NumFiles: 10,
+		NumDirs:  5,
+		Directories: map[string]*FileInfo{
 			"/testpath": {
-				Path:     "/testpath",
-				Name:     "testpath",
-				IsDir:    true,
-				NumDirs:  1,
-				NumFiles: 2,
-				Items: []*FileInfo{
+				Path: "/testpath",
+				ItemInfo: ItemInfo{
+					Name: "testpath",
+					Type: "directory",
+				},
+				Files: []ItemInfo{
 					{Name: "testfile.txt", Size: 100},
 					{Name: "anotherfile.txt", Size: 100},
 				},
 			},
 			"/anotherpath": {
-				Path:     "/anotherpath",
-				Name:     "anotherpath",
-				IsDir:    true,
-				NumDirs:  1,
-				NumFiles: 1,
-				Items: []*FileInfo{
-					{Name: "directory", IsDir: true, Size: 100},
+				Path: "/anotherpath",
+				ItemInfo: ItemInfo{
+					Name: "anotherpath",
+					Type: "directory",
+				},
+				Files: []ItemInfo{
 					{Name: "afile.txt", Size: 100},
 				},
+				Folders: []ItemInfo{
+					{Name: "directory", Type: "directory", Size: 100},
+				},
 			},
 		},
 	}

backend/fileutils/copy.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Copy copies a file or folder from one place to another.
-func Copy(src, dst string) error {
+func CopyHelper(src, dst string) error {
 	src = filepath.Clean(src)
 	if src == "" {
 		return os.ErrNotExist

backend/frontend/dist

@@ -1 +0,0 @@
-../../frontend/dist

backend/frontend/package-lock.json

@@ -1,6 +0,0 @@
-{
-  "name": "frontend",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {}
-}

backend/go.mod

@@ -1,4 +1,4 @@
-module github.com/gtsteffaniak/filebrowser
+module github.com/gtsteffaniak/filebrowser/backend
 
 go 1.22.5
 
@@ -7,50 +7,46 @@ require (
 	github.com/disintegration/imaging v1.6.2
 	github.com/dsoprea/go-exif/v3 v3.0.1
 	github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568
-	github.com/goccy/go-yaml v1.12.0
-	github.com/golang-jwt/jwt/v4 v4.5.0
+	github.com/gabriel-vasile/mimetype v1.4.7
+	github.com/goccy/go-yaml v1.15.7
+	github.com/golang-jwt/jwt/v4 v4.5.1
 	github.com/google/go-cmp v0.6.0
-	github.com/gorilla/mux v1.8.1
-	github.com/marusama/semaphore/v2 v2.5.0
-	github.com/mholt/archiver/v3 v3.5.1
 	github.com/shirou/gopsutil/v3 v3.24.5
 	github.com/spf13/afero v1.11.0
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.9.0
-	github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce
-	golang.org/x/crypto v0.26.0
-	golang.org/x/image v0.19.0
-	golang.org/x/text v0.17.0
+	github.com/swaggo/http-swagger v1.3.4
+	github.com/swaggo/swag v1.16.4
+	golang.org/x/crypto v0.30.0
+	golang.org/x/image v0.23.0
+	golang.org/x/text v0.21.0
 )
 
 require (
-	github.com/andybalholm/brotli v1.1.0 // indirect
+	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
 	github.com/dsoprea/go-logging v0.0.0-20200710184922-b02d349568dd // indirect
 	github.com/dsoprea/go-utility/v2 v2.0.0-20221003172846-a3e1774ef349 // indirect
-	github.com/fatih/color v1.17.0 // indirect
 	github.com/go-errors/errors v1.5.1 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonreference v0.21.0 // indirect
+	github.com/go-openapi/spec v0.21.0 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/golang/geo v0.0.0-20230421003525-6adc56603217 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/klauspost/compress v1.17.9 // indirect
-	github.com/klauspost/pgzip v1.2.6 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/nwaples/rardecode v1.1.3 // indirect
-	github.com/pierrec/lz4/v4 v4.1.21 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
-	github.com/ulikunitz/xz v0.5.12 // indirect
-	github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
+	github.com/swaggo/files v1.0.1 // indirect
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
 	go.etcd.io/bbolt v1.3.11 // indirect
-	golang.org/x/net v0.28.0 // indirect
-	golang.org/x/sys v0.24.0 // indirect
-	golang.org/x/xerrors v0.0.0-20240716161551-93cc26a95ae9 // indirect
+	golang.org/x/net v0.32.0 // indirect
+	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/tools v0.28.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

backend/go.sum

@@ -1,10 +1,9 @@
 github.com/DataDog/zstd v1.4.1 h1:3oxKN3wbHibqx897utPC2LTQU4J+IHWWJO+glkAkpFM=
 github.com/DataDog/zstd v1.4.1/go.mod h1:1jcaCB/ufaK+sKp1NBhlGmpz41jOoPQ35bpF36t7BBo=
+github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc=
+github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE=
 github.com/Sereal/Sereal v0.0.0-20190618215532-0b8ac451a863 h1:BRrxwOZBolJN4gIwvZMJY1tzqBvQgpaZiQRuIDD40jM=
 github.com/Sereal/Sereal v0.0.0-20190618215532-0b8ac451a863/go.mod h1:D0JMgToj/WdxCgd30Kc1UcA9E+WdZoJqeVOuYW7iTBM=
-github.com/andybalholm/brotli v1.0.1/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y=
-github.com/andybalholm/brotli v1.1.0 h1:eLKJA0d02Lf0mVpIDgYnqXcUn0GqVmEFny3VuID1U3M=
-github.com/andybalholm/brotli v1.1.0/go.mod h1:sms7XGricyQI9K10gOSf56VKKWS4oLer58Q+mhRPtnY=
 github.com/asdine/storm/v3 v3.2.1 h1:I5AqhkPK6nBZ/qJXySdI7ot5BlXSZ7qvDY1zAn5ZJac=
 github.com/asdine/storm/v3 v3.2.1/go.mod h1:LEpXwGt4pIqrE/XcTvCnZHT5MgZCV6Ub9q7yQzOFWr0=
 github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
@@ -12,9 +11,6 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c=
 github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4=
-github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 h1:iFaUwBSo5Svw6L7HYpRu/0lE3e0BaElwnNO1qkNQxBY=
-github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5/go.mod h1:qssHWj60/X5sZFNxpG4HBPDHVqxNm4DfnCKgrbZOT+s=
-github.com/dsnet/golib v0.0.0-20171103203638-1ea166775780/go.mod h1:Lj+Z9rebOhdfkVLjJ8T6VcRQv3SXugXy999NBtR9aFY=
 github.com/dsoprea/go-exif/v2 v2.0.0-20200321225314-640175a69fe4/go.mod h1:Lm2lMM2zx8p4a34ZemkaUV95AnMl4ZvLbCUbwOvLC2E=
 github.com/dsoprea/go-exif/v3 v3.0.0-20200717053412-08f1b6708903/go.mod h1:0nsO1ce0mh5czxGeLo4+OCZ/C6Eo6ZlMWsz7rH/Gxv8=
 github.com/dsoprea/go-exif/v3 v3.0.0-20210625224831-a6301f85c82b/go.mod h1:cg5SNYKHMmzxsr9X6ZeLh/nfBRHHp5PngtEPcujONtk=
@@ -32,10 +28,10 @@ github.com/dsoprea/go-utility/v2 v2.0.0-20221003142440-7a1927d49d9d/go.mod h1:LV
 github.com/dsoprea/go-utility/v2 v2.0.0-20221003160719-7bc88537c05e/go.mod h1:VZ7cB0pTjm1ADBWhJUOHESu4ZYy9JN+ZPqjfiW09EPU=
 github.com/dsoprea/go-utility/v2 v2.0.0-20221003172846-a3e1774ef349 h1:DilThiXje0z+3UQ5YjYiSRRzVdtamFpvBQXKwMglWqw=
 github.com/dsoprea/go-utility/v2 v2.0.0-20221003172846-a3e1774ef349/go.mod h1:4GC5sXji84i/p+irqghpPFZBF8tRN/Q7+700G0/DLe8=
-github.com/fatih/color v1.17.0 h1:GlRw1BRJxkpqUCBKzKOw098ed57fEsKeNjpTe3cSjK4=
-github.com/fatih/color v1.17.0/go.mod h1:YZ7TlrGPkiz6ku9fK3TLD/pl3CpsiFyu8N92HLgmosI=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 h1:BHsljHzVlRcyQhjrss6TZTdY2VfCqZPbv5k3iBFa2ZQ=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
+github.com/gabriel-vasile/mimetype v1.4.7 h1:SKFKl7kD0RiPdbht0s7hFtjl489WcQ1VyPW8ZzUMYCA=
+github.com/gabriel-vasile/mimetype v1.4.7/go.mod h1:GDlAgAyIRT27BhFl53XNAFtfjzOkLaF35JdEG0P7LtU=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
 github.com/go-errors/errors v1.0.2/go.mod h1:psDX2osz5VnTOnFWbDeWwS7yejl+uV3FEWEp4lssFEs=
 github.com/go-errors/errors v1.1.1/go.mod h1:psDX2osz5VnTOnFWbDeWwS7yejl+uV3FEWEp4lssFEs=
@@ -45,16 +41,18 @@ github.com/go-errors/errors v1.5.1/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3Bop
 github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
 github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE=
 github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78=
-github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q=
-github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8=
-github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no=
-github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA=
-github.com/go-playground/validator/v10 v10.4.1 h1:pH2c5ADXtd66mxoE0Zm9SUhxE20r7aM3F26W0hOn+GE=
-github.com/go-playground/validator/v10 v10.4.1/go.mod h1:nlOn6nFhuKACm19sB/8EGNn9GlaMV7XkbRSipzJ0Ii4=
-github.com/goccy/go-yaml v1.12.0 h1:/1WHjnMsI1dlIBQutrvSMGZRQufVO3asrHfTwfACoPM=
-github.com/goccy/go-yaml v1.12.0/go.mod h1:wKnAMd44+9JAAnGQpWVEgBzGt3YuTaQ4uXoHvE4m7WU=
-github.com/golang-jwt/jwt/v4 v4.5.0 h1:7cYmW1XlMY7h7ii7UhUyChSgS5wUJEnm9uZVTGqOWzg=
-github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0=
+github.com/go-openapi/jsonpointer v0.21.0 h1:YgdVicSA9vH5RiHs9TZW5oyafXZFc6+2Vc1rr/O9oNQ=
+github.com/go-openapi/jsonpointer v0.21.0/go.mod h1:IUyH9l/+uyhIYQ/PXVA41Rexl+kOkAPDdXEYns6fzUY=
+github.com/go-openapi/jsonreference v0.21.0 h1:Rs+Y7hSXT83Jacb7kFyjn4ijOuVGSvOdF2+tg1TRrwQ=
+github.com/go-openapi/jsonreference v0.21.0/go.mod h1:LmZmgsrTkVg9LG4EaHeY8cBDslNPMo06cago5JNLkm4=
+github.com/go-openapi/spec v0.21.0 h1:LTVzPc3p/RzRnkQqLRndbAzjY0d0BCL72A6j3CdL9ZY=
+github.com/go-openapi/spec v0.21.0/go.mod h1:78u6VdPw81XU44qEWGhtr982gJ5BWg2c0I5XwVMotYk=
+github.com/go-openapi/swag v0.23.0 h1:vsEVJDUo2hPJ2tu0/Xc+4noaxyEffXNIs3cOULZ+GrE=
+github.com/go-openapi/swag v0.23.0/go.mod h1:esZ8ITTYEsH1V2trKHjAN8Ai7xHb8RV+YSZ577vPjgQ=
+github.com/goccy/go-yaml v1.15.7 h1:L7XuKpd/A66X4w/dlk08lVfiIADdy79a1AzRoIefC98=
+github.com/goccy/go-yaml v1.15.7/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
+github.com/golang-jwt/jwt/v4 v4.5.1 h1:JdqV9zKUdtaa9gdPlywC3aeoEsR681PlKC+4F5gQgeo=
+github.com/golang-jwt/jwt/v4 v4.5.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0=
 github.com/golang/geo v0.0.0-20190916061304-5b978397cfec/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI=
 github.com/golang/geo v0.0.0-20200319012246-673a6f80352d/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI=
 github.com/golang/geo v0.0.0-20210211234256-740aa86cb551/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI=
@@ -65,52 +63,31 @@ github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5y
 github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
 github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
 github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
-github.com/golang/snappy v0.0.2/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM=
 github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
-github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
-github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
 github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
-github.com/klauspost/compress v1.4.1/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
-github.com/klauspost/compress v1.11.4/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs=
-github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
-github.com/klauspost/compress v1.17.9/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
-github.com/klauspost/cpuid v1.2.0/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek=
-github.com/klauspost/pgzip v1.2.5/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
-github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
-github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
-github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
+github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
+github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
-github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
-github.com/marusama/semaphore/v2 v2.5.0 h1:o/1QJD9DBYOWRnDhPwDVAXQn6mQYD0gZaS1Tpx6DJGM=
-github.com/marusama/semaphore/v2 v2.5.0/go.mod h1:z9nMiNUekt/LTpTUQdpp+4sJeYqUGpwMHfW0Z8V8fnQ=
-github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
-github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
-github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
-github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mholt/archiver/v3 v3.5.1 h1:rDjOBX9JSF5BvoJGvjqK479aL70qh9DIpZCl+k7Clwo=
-github.com/mholt/archiver/v3 v3.5.1/go.mod h1:e3dqJ7H78uzsRSEACH1joayhuSyhnonssnDhppzS1L4=
-github.com/nwaples/rardecode v1.1.0/go.mod h1:5DzqNKiOdpKKBH87u8VlvAnPZMXcGRhxWkRpHbbfGS0=
-github.com/nwaples/rardecode v1.1.3 h1:cWCaZwfM5H7nAD6PyEdcVnczzV8i/JtotnyW/dD9lEc=
-github.com/nwaples/rardecode v1.1.3/go.mod h1:5DzqNKiOdpKKBH87u8VlvAnPZMXcGRhxWkRpHbbfGS0=
-github.com/pierrec/lz4/v4 v4.1.2/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
-github.com/pierrec/lz4/v4 v4.1.21 h1:yOVMLb6qSIDP67pl/5F7RepeKYu/VmTyEXvuMI5d9mQ=
-github.com/pierrec/lz4/v4 v4.1.21/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
+github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 h1:o4JXh1EVt9k/+g42oCprj/FisM4qX9L3sZB3upGN2ZU=
 github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55/go.mod h1:OmDBASR4679mdNQnz2pUhc2G8CO2JrUAVFDRBDP/hJE=
+github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
+github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/shirou/gopsutil/v3 v3.24.5 h1:i0t8kL+kQTvpAYToeuiVk3TgDeKOFioZO3Ztz/iZ9pI=
 github.com/shirou/gopsutil/v3 v3.24.5/go.mod h1:bsoOS1aStSs9ErQ1WWfxllSeS1K5D+U30r2NfcubMVk=
@@ -123,70 +100,88 @@ github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce h1:fb190+cK2Xz/dvi9Hv8eCYJYvIGUTN2/KLq1pT6CjEc=
-github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce/go.mod h1:o8v6yHRoik09Xen7gje4m9ERNah1d1PPsVq1VEx9vE4=
-github.com/ulikunitz/xz v0.5.8/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
-github.com/ulikunitz/xz v0.5.9/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
-github.com/ulikunitz/xz v0.5.12 h1:37Nm15o69RwBkXM0J6A5OlE67RZTfzUxTj8fB3dfcsc=
-github.com/ulikunitz/xz v0.5.12/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
+github.com/swaggo/files v1.0.1 h1:J1bVJ4XHZNq0I46UU90611i9/YzdrF7x92oX1ig5IdE=
+github.com/swaggo/files v1.0.1/go.mod h1:0qXmMNH6sXNf+73t65aKeB+ApmgxdnkQzVTAj2uaMUg=
+github.com/swaggo/http-swagger v1.3.4 h1:q7t/XLx0n15H1Q9/tk3Y9L4n210XzJF5WtnDX64a5ww=
+github.com/swaggo/http-swagger v1.3.4/go.mod h1:9dAh0unqMBAlbp1uE2Uc2mQTxNMU/ha4UbucIg1MFkQ=
+github.com/swaggo/swag v1.16.4 h1:clWJtd9LStiG3VeijiCfOVODP6VpHtKdQy9ELFG3s1A=
+github.com/swaggo/swag v1.16.4/go.mod h1:VBsHJRsDvfYvqoiMKnsdwhNV9LEMHgEDZcyVYX0sxPg=
 github.com/vmihailenco/msgpack v4.0.4+incompatible h1:dSLoQfGFAo3F6OoNhwUmLwVgaUXK79GlxNBwueZn0xI=
 github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk=
-github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 h1:nIPpBwaJSVYIxUFsDv3M8ofmx9yWTog9BfvIu0q41lo=
-github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8/go.mod h1:HUYIGzjTL3rfEspMxjDjgmT5uz5wzYJKVo23qUhYTos=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
 github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
 go.etcd.io/bbolt v1.3.4/go.mod h1:G5EMThwa9y8QZGBClrRx5EY+Yw9kAhnjy3bSjsnlVTQ=
 go.etcd.io/bbolt v1.3.11 h1:yGEzV1wPz2yVCLsD8ZAiGHhHVlczyC9d1rP43/VCRJ0=
 go.etcd.io/bbolt v1.3.11/go.mod h1:dksAq7YMXoljX0xu6VF5DMZGbhYYoLUalEiSySYAS4I=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.26.0 h1:RrRspgV4mU+YwB4FYnuBoKsUapNIL5cohGAmSH3azsw=
-golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.30.0 h1:RwoQn3GkWiMkzlX562cLB7OxWvjH1L8xutO2WoJcRoY=
+golang.org/x/crypto v0.30.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
 golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
-golang.org/x/image v0.19.0 h1:D9FX4QWkLfkeqaC62SonffIIuYdOk/UE2XKUBgRIBIQ=
-golang.org/x/image v0.19.0/go.mod h1:y0zrRqlQRWQ5PXaYCOMLTW2fpsxZ8Qh9I/ohnInJEys=
+golang.org/x/image v0.23.0 h1:HseQ7c2OpPKTPVzNjG5fwJsOTCiiwS4QdsYi5XU6H68=
+golang.org/x/image v0.23.0/go.mod h1:wJJBTdLfCCf3tiHa1fNxpZmUI4mmoZvwMCPP0ddoNKY=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
+golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20191105084925-a882066a44e0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200320220750-118fecf932d8/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200501053045-e0ff5e5a1de5/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
 golang.org/x/net v0.0.0-20200513185701-a91f0712d120/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
-golang.org/x/net v0.28.0 h1:a9JDOJc5GMUJ0+UDqmLT86WiEy7iWyIhz8gz8E4e5hE=
-golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
-golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
-golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI=
+golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
+golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201204225414-ed752295db88/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220928140112-f11e5e49a4ec/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg=
-golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
+golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
-golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc=
-golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
+golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20240716161551-93cc26a95ae9 h1:LLhsEBxRTBLuKlQxFBYUOU8xyFgXv6cOTp2HASDlsDk=
-golang.org/x/xerrors v0.0.0-20240716161551-93cc26a95ae9/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/tools v0.28.0 h1:WuB6qZ4RPCQo5aP3WdKZS7i595EdWqWR8vqJTlwTVK8=
+golang.org/x/tools v0.28.0/go.mod h1:dcIOrVd3mfQKTgrDVQHqCPMWy6lnhfhtX3hLXYVLfRw=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
 google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
 google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
 google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
 google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=

backend/http/api.go

@@ -0,0 +1,121 @@
+package http
+
+import (
+	"fmt"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+)
+
+func createApiKeyHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	name := r.URL.Query().Get("name")
+	durationStr := r.URL.Query().Get("days")
+	permissionsStr := r.URL.Query().Get("permissions")
+
+	if name == "" {
+		return http.StatusInternalServerError, fmt.Errorf("api name must be valid")
+	}
+	if durationStr == "" {
+		return http.StatusInternalServerError, fmt.Errorf("api duration must be valid")
+	}
+	if permissionsStr == "" {
+		return http.StatusInternalServerError, fmt.Errorf("api permissions must be valid")
+	}
+	// Parse permissions from the query parameter
+	permissions := users.Permissions{
+		Api:      strings.Contains(permissionsStr, "api") && d.user.Perm.Api,
+		Admin:    strings.Contains(permissionsStr, "admin") && d.user.Perm.Admin,
+		Execute:  strings.Contains(permissionsStr, "execute") && d.user.Perm.Execute,
+		Create:   strings.Contains(permissionsStr, "create") && d.user.Perm.Create,
+		Rename:   strings.Contains(permissionsStr, "rename") && d.user.Perm.Rename,
+		Modify:   strings.Contains(permissionsStr, "modify") && d.user.Perm.Modify,
+		Delete:   strings.Contains(permissionsStr, "delete") && d.user.Perm.Delete,
+		Share:    strings.Contains(permissionsStr, "share") && d.user.Perm.Share,
+		Download: strings.Contains(permissionsStr, "download") && d.user.Perm.Download,
+	}
+
+	// Convert the duration string to an int64
+	durationInt, err := strconv.ParseInt(durationStr, 10, 64) // Base 10 and bit size of 64
+	if err != nil {
+		return http.StatusBadRequest, fmt.Errorf("invalid duration value: %w", err)
+	}
+
+	// Here we assume the duration is in seconds; convert to time.Duration
+	duration := time.Duration(durationInt) * time.Hour * 24
+
+	// get request body like:
+	token, err := makeSignedTokenAPI(d.user, name, duration, permissions)
+	if err != nil {
+		if strings.Contains(err.Error(), "key already exists with same name") {
+			return http.StatusConflict, err
+		}
+		return http.StatusInternalServerError, err
+	}
+	response := HttpResponse{
+		Message: "here is your token!",
+		Token:   token.Key,
+	}
+	return renderJSON(w, r, response)
+}
+
+func deleteApiKeyHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	name := r.URL.Query().Get("name")
+
+	keyInfo, ok := d.user.ApiKeys[name]
+	if !ok {
+		return http.StatusNotFound, fmt.Errorf("api key not found")
+	}
+	// Perform the user update
+	err := store.Users.DeleteApiKey(d.user.ID, name)
+	if err != nil {
+		return http.StatusNotFound, err
+	}
+
+	revokeAPIKey(keyInfo.Key) // add to blacklist
+	response := HttpResponse{
+		Message: "successfully deleted api key from user",
+	}
+	return renderJSON(w, r, response)
+}
+
+type AuthTokenMin struct {
+	Key         string            `json:"key"`
+	Name        string            `json:"name"`
+	Created     int64             `json:"created"`
+	Expires     int64             `json:"expires"`
+	Permissions users.Permissions `json:"Permissions"`
+}
+
+func listApiKeysHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	key := r.URL.Query().Get("key")
+
+	if key != "" {
+		keyInfo, ok := d.user.ApiKeys[key]
+		if !ok {
+			return http.StatusNotFound, fmt.Errorf("api key not found")
+		}
+		modifiedKey := AuthTokenMin{
+			Key:         keyInfo.Key,
+			Name:        key,
+			Created:     keyInfo.Created,
+			Expires:     keyInfo.Expires,
+			Permissions: keyInfo.Permissions,
+		}
+		return renderJSON(w, r, modifiedKey)
+	}
+
+	modifiedList := map[string]AuthTokenMin{}
+	for key, value := range d.user.ApiKeys {
+		modifiedList[key] = AuthTokenMin{
+			Key:         value.Key,
+			Created:     value.Created,
+			Expires:     value.Expires,
+			Permissions: value.Permissions,
+		}
+	}
+
+	return renderJSON(w, r, modifiedList)
+}

backend/http/auth.go

@@ -2,103 +2,95 @@ package http
 
 import (
 	"encoding/json"
+	libError "errors"
+	"fmt"
 	"log"
 	"net/http"
+	"net/url"
 	"os"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/golang-jwt/jwt/v4"
 	"github.com/golang-jwt/jwt/v4/request"
+	"golang.org/x/crypto/bcrypt"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
-type authToken struct {
-	User users.User `json:"user"`
-	jwt.RegisteredClaims
-}
+var (
+	revokedApiKeyList map[string]bool
+	revokeMu          sync.Mutex
+)
 
-type extractor []string
+// first checks for cookie
+// then checks for header Authorization as Bearer token
+// then checks for query parameter
+func extractToken(r *http.Request) (string, error) {
+	hasToken := false
+	tokenObj, err := r.Cookie("auth")
+	if err == nil {
+		hasToken = true
+		token := tokenObj.Value
+		// Checks if the token isn't empty and if it contains two dots.
+		// The former prevents incompatibility with URLs that previously
+		// used basic auth.
+		if token != "" && strings.Count(token, ".") == 2 {
+			return token, nil
+		}
+	}
 
-func (e extractor) ExtractToken(r *http.Request) (string, error) {
-	token, _ := request.HeaderExtractor{"X-Auth"}.ExtractToken(r)
-
-	// Checks if the token isn't empty and if it contains two dots.
-	// The former prevents incompatibility with URLs that previously
-	// used basic auth.
-	if token != "" && strings.Count(token, ".") == 2 {
-		return token, nil
+	// Check for Authorization header
+	authHeader := r.Header.Get("Authorization")
+	if authHeader != "" {
+		hasToken = true
+		// Split the header to get "Bearer {token}"
+		parts := strings.Split(authHeader, " ")
+		if len(parts) == 2 && parts[0] == "Bearer" {
+			token := parts[1]
+			return token, nil
+		}
 	}
 
 	auth := r.URL.Query().Get("auth")
-	if auth != "" && strings.Count(auth, ".") == 2 {
-		return auth, nil
+	if auth != "" {
+		hasToken = true
+		if strings.Count(auth, ".") == 2 {
+			return auth, nil
+		}
 	}
 
-	if r.Method == http.MethodGet {
-		cookie, _ := r.Cookie("auth")
-		if cookie != nil && strings.Count(cookie.Value, ".") == 2 {
-			return cookie.Value, nil
-		}
+	if hasToken {
+		return "", fmt.Errorf("invalid token provided")
 	}
 
 	return "", request.ErrNoTokenInRequest
 }
 
-func withUser(fn handleFunc) handleFunc {
-	return func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		keyFunc := func(token *jwt.Token) (interface{}, error) {
-			return d.settings.Auth.Key, nil
-		}
-
-		var tk authToken
-		token, err := request.ParseFromRequest(r, &extractor{}, keyFunc, request.WithClaims(&tk))
-
-		if err != nil || !token.Valid {
-			return http.StatusUnauthorized, nil
-		}
-
-		expired := !tk.VerifyExpiresAt(time.Now().Add(time.Hour), true)
-		updated := tk.IssuedAt != nil && tk.IssuedAt.Unix() < d.store.Users.LastUpdate(tk.User.ID)
-
-		if expired || updated {
-			w.Header().Add("X-Renew-Token", "true")
-		}
-
-		d.user, err = d.store.Users.Get(d.server.Root, tk.User.ID)
-		if err != nil {
-			return http.StatusInternalServerError, err
-		}
-		return fn(w, r, d)
-	}
-}
-
-func withAdmin(fn handleFunc) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if !d.user.Perm.Admin {
-			return http.StatusForbidden, nil
-		}
-
-		return fn(w, r, d)
-	})
-}
-
-var loginHandler = func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	auther, err := d.store.Auth.Get(d.settings.Auth.Method)
+func loginHandler(w http.ResponseWriter, r *http.Request) {
+	// Get the authentication method from the settings
+	auther, err := store.Auth.Get(config.Auth.Method)
 	if err != nil {
-		return http.StatusInternalServerError, err
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
 	}
-
-	user, err := auther.Auth(r, d.store.Users)
+	// Authenticate the user based on the request
+	user, err := auther.Auth(r, store.Users)
 	if err == os.ErrPermission {
-		return http.StatusForbidden, nil
+		http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden)
+		return
 	} else if err != nil {
-		return http.StatusInternalServerError, err
-	} else {
-		return printToken(w, r, d, user)
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
+	}
+	status, err := printToken(w, r, user) // Pass the data object
+	if err != nil {
+		http.Error(w, http.StatusText(status), status)
 	}
 }
 
@@ -107,73 +99,141 @@ type signupBody struct {
 	Password string `json:"password"`
 }
 
-var signupHandler = func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+func signupHandler(w http.ResponseWriter, r *http.Request) {
 	if !settings.Config.Auth.Signup {
-		return http.StatusMethodNotAllowed, nil
+		http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed)
+		return
 	}
 
 	if r.Body == nil {
-		return http.StatusBadRequest, nil
+		http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
+		return
 	}
 
 	info := &signupBody{}
 	err := json.NewDecoder(r.Body).Decode(info)
 	if err != nil {
-		return http.StatusBadRequest, err
+		http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
+		return
 	}
 
 	if info.Password == "" || info.Username == "" {
-		return http.StatusBadRequest, nil
+		http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
+		return
 	}
 
-	user := users.ApplyDefaults(users.User{})
+	user := settings.ApplyUserDefaults(users.User{})
 	user.Username = info.Username
 	user.Password = info.Password
 
-	userHome, err := d.settings.MakeUserDir(user.Username, user.Scope, d.server.Root)
+	userHome, err := config.MakeUserDir(user.Username, user.Scope, config.Server.Root)
 	if err != nil {
 		log.Printf("create user: failed to mkdir user home dir: [%s]", userHome)
-		return http.StatusInternalServerError, err
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
 	}
 	user.Scope = userHome
 	log.Printf("new user: %s, home dir: [%s].", user.Username, userHome)
-	err = d.store.Users.Save(&user)
+	err = store.Users.Save(&user)
 	if err == errors.ErrExist {
-		return http.StatusConflict, err
+		http.Error(w, http.StatusText(http.StatusConflict), http.StatusConflict)
+		return
 	} else if err != nil {
-		return http.StatusInternalServerError, err
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
 	}
-
-	return http.StatusOK, nil
 }
 
-var renewHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	return printToken(w, r, d, d.user)
-})
+func renewHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// check if x-auth header is present and token is
+	return printToken(w, r, d.user)
+}
 
-func printToken(w http.ResponseWriter, _ *http.Request, d *data, user *users.User) (int, error) {
-	duration, err := time.ParseDuration(settings.Config.Auth.TokenExpirationTime)
-	if err != nil {
-		duration = time.Hour * 2
-	}
-	claims := &authToken{
-		User: *user,
-		RegisteredClaims: jwt.RegisteredClaims{
-			IssuedAt:  jwt.NewNumericDate(time.Now()),
-			ExpiresAt: jwt.NewNumericDate(time.Now().Add(duration)),
-			Issuer:    "File Browser",
-		},
-	}
-
-	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
-	signed, err := token.SignedString(d.settings.Auth.Key)
+func printToken(w http.ResponseWriter, _ *http.Request, user *users.User) (int, error) {
+	signed, err := makeSignedTokenAPI(user, "WEB_TOKEN_"+utils.GenerateRandomHash(4), time.Hour*2, user.Perm)
 	if err != nil {
+		if strings.Contains(err.Error(), "key already exists with same name") {
+			return http.StatusConflict, err
+		}
 		return http.StatusInternalServerError, err
 	}
-
 	w.Header().Set("Content-Type", "text/plain")
-	if _, err := w.Write([]byte(signed)); err != nil {
+	if _, err := w.Write([]byte(signed.Key)); err != nil {
 		return http.StatusInternalServerError, err
 	}
 	return 0, nil
 }
+
+func isRevokedApiKey(key string) bool {
+	_, exists := revokedApiKeyList[key]
+	return exists
+}
+
+func revokeAPIKey(key string) {
+	revokeMu.Lock()
+	delete(revokedApiKeyList, key)
+	revokeMu.Unlock()
+}
+
+func makeSignedTokenAPI(user *users.User, name string, duration time.Duration, perms users.Permissions) (users.AuthToken, error) {
+	_, ok := user.ApiKeys[name]
+	if ok {
+		return users.AuthToken{}, fmt.Errorf("key already exists with same name %v ", name)
+	}
+	now := time.Now()
+	expires := now.Add(duration)
+	claim := users.AuthToken{
+		Permissions: perms,
+		Created:     now.Unix(),
+		Expires:     expires.Unix(),
+		Name:        name,
+		BelongsTo:   user.ID,
+		RegisteredClaims: jwt.RegisteredClaims{
+			IssuedAt:  jwt.NewNumericDate(now),
+			ExpiresAt: jwt.NewNumericDate(expires),
+			Issuer:    "FileBrowser Quantum",
+		},
+	}
+	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claim)
+	tokenString, err := token.SignedString(config.Auth.Key)
+	if err != nil {
+		return claim, err
+	}
+	claim.Key = tokenString
+	if strings.HasPrefix(name, "WEB_TOKEN") {
+		// don't add to api tokens, its a short lived web token
+		return claim, err
+	}
+	// Perform the user update
+	err = store.Users.AddApiKey(user.ID, name, claim)
+	if err != nil {
+		return claim, err
+	}
+	return claim, err
+}
+
+func authenticateShareRequest(r *http.Request, l *share.Link) (int, error) {
+	if l.PasswordHash == "" {
+		return 200, nil
+	}
+
+	if r.URL.Query().Get("token") == l.Token {
+		return 200, nil
+	}
+
+	password := r.Header.Get("X-SHARE-PASSWORD")
+	password, err := url.QueryUnescape(password)
+	if err != nil {
+		return http.StatusUnauthorized, err
+	}
+	if password == "" {
+		return http.StatusUnauthorized, nil
+	}
+	if err := bcrypt.CompareHashAndPassword([]byte(l.PasswordHash), []byte(password)); err != nil {
+		if libError.Is(err, bcrypt.ErrMismatchedHashAndPassword) {
+			return http.StatusUnauthorized, nil
+		}
+		return 401, err
+	}
+	return 200, nil
+}

backend/http/data.go

@@ -1,75 +0,0 @@
-package http
-
-import (
-	"log"
-	"net/http"
-	"strconv"
-
-	"github.com/tomasen/realip"
-
-	"github.com/gtsteffaniak/filebrowser/runner"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
-)
-
-type handleFunc func(w http.ResponseWriter, r *http.Request, d *data) (int, error)
-
-type data struct {
-	*runner.Runner
-	settings *settings.Settings
-	server   *settings.Server
-	store    *storage.Storage
-	user     *users.User
-	raw      interface{}
-}
-
-// Check implements rules.Checker.
-func (d *data) Check(path string) bool {
-
-	allow := true
-	for _, rule := range d.settings.Rules {
-		if rule.Matches(path) {
-			allow = rule.Allow
-		}
-	}
-	for _, rule := range d.user.Rules {
-		if rule.Matches(path) {
-			allow = rule.Allow
-		}
-	}
-
-	return allow
-}
-
-func handle(fn handleFunc, prefix string, store *storage.Storage, server *settings.Server) http.Handler {
-	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		w.Header().Set("Cache-Control", "no-cache, no-store, must-revalidate")
-
-		settings, err := store.Settings.Get()
-		if err != nil {
-			log.Fatalf("ERROR: couldn't get settings: %v\n", err)
-			return
-		}
-
-		status, err := fn(w, r, &data{
-			Runner:   &runner.Runner{Enabled: server.EnableExec, Settings: settings},
-			store:    store,
-			settings: settings,
-			server:   server,
-		})
-
-		if status >= 400 || err != nil {
-			clientIP := realip.FromRequest(r)
-			log.Printf("%s: %v %s %v", r.URL.Path, status, clientIP, err)
-		}
-
-		if status != 0 {
-			txt := http.StatusText(status)
-			http.Error(w, strconv.Itoa(status)+" "+txt, status)
-			return
-		}
-	})
-
-	return stripPrefix(prefix, handler)
-}

backend/http/embed/.gitignore

@@ -0,0 +1 @@
+*

backend/http/http.go

@@ -1,85 +0,0 @@
-package http
-
-import (
-	"io/fs"
-	"net/http"
-
-	"github.com/gorilla/mux"
-
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-)
-
-type modifyRequest struct {
-	What  string   `json:"what"`  // Answer to: what data type?
-	Which []string `json:"which"` // Answer to: which fields?
-}
-
-var (
-	store     *storage.Storage
-	server    *settings.Server
-	fileCache FileCache
-)
-
-func SetupEnv(storage *storage.Storage, s *settings.Server, cache FileCache) {
-	store = storage
-	server = s
-	fileCache = cache
-}
-
-func NewHandler(
-	imgSvc ImgService,
-	assetsFs fs.FS,
-) (http.Handler, error) {
-	server.Clean()
-
-	r := mux.NewRouter()
-	r.Use(func(next http.Handler) http.Handler {
-		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			w.Header().Set("Content-Security-Policy", `default-src 'self'; style-src 'unsafe-inline';`)
-			next.ServeHTTP(w, r)
-		})
-	})
-	index, static := getStaticHandlers(store, server, assetsFs)
-	// NOTE: This fixes the issue where it would redirect if people did not put a
-	// trailing slash in the end. I hate this decision since this allows some awful
-	// URLs https://www.gorillatoolkit.org/pkg/mux#Router.SkipClean
-	r = r.SkipClean(true)
-	monkey := func(fn handleFunc, prefix string) http.Handler {
-		return handle(fn, prefix, store, server)
-	}
-	r.HandleFunc("/health", healthHandler)
-	r.PathPrefix("/static").Handler(static)
-	r.NotFoundHandler = index
-	api := r.PathPrefix("/api").Subrouter()
-	api.Handle("/login", monkey(loginHandler, ""))
-	api.Handle("/signup", monkey(signupHandler, ""))
-	api.Handle("/renew", monkey(renewHandler, ""))
-	users := api.PathPrefix("/users").Subrouter()
-	users.Handle("", monkey(usersGetHandler, "")).Methods("GET")
-	users.Handle("", monkey(userPostHandler, "")).Methods("POST")
-	users.Handle("/{id:[0-9]+}", monkey(userPutHandler, "")).Methods("PUT")
-	users.Handle("/{id:[0-9]+}", monkey(userGetHandler, "")).Methods("GET")
-	users.Handle("/{id:[0-9]+}", monkey(userDeleteHandler, "")).Methods("DELETE")
-	api.PathPrefix("/resources").Handler(monkey(resourceGetHandler, "/api/resources")).Methods("GET")
-	api.PathPrefix("/resources").Handler(monkey(resourceDeleteHandler(fileCache), "/api/resources")).Methods("DELETE")
-	api.PathPrefix("/resources").Handler(monkey(resourcePostHandler(fileCache), "/api/resources")).Methods("POST")
-	api.PathPrefix("/resources").Handler(monkey(resourcePutHandler, "/api/resources")).Methods("PUT")
-	api.PathPrefix("/resources").Handler(monkey(resourcePatchHandler(fileCache), "/api/resources")).Methods("PATCH")
-	api.PathPrefix("/usage").Handler(monkey(diskUsage, "/api/usage")).Methods("GET")
-	api.Path("/shares").Handler(monkey(shareListHandler, "/api/shares")).Methods("GET")
-	api.PathPrefix("/share").Handler(monkey(shareGetsHandler, "/api/share")).Methods("GET")
-	api.PathPrefix("/share").Handler(monkey(sharePostHandler, "/api/share")).Methods("POST")
-	api.PathPrefix("/share").Handler(monkey(shareDeleteHandler, "/api/share")).Methods("DELETE")
-	api.Handle("/settings", monkey(settingsGetHandler, "")).Methods("GET")
-	api.Handle("/settings", monkey(settingsPutHandler, "")).Methods("PUT")
-	api.PathPrefix("/raw").Handler(monkey(rawHandler, "/api/raw")).Methods("GET")
-	api.PathPrefix("/preview/{size}/{path:.*}").
-		Handler(monkey(previewHandler(imgSvc, fileCache, server.EnableThumbnails, server.ResizePreview), "/api/preview")).Methods("GET")
-	api.PathPrefix("/search").Handler(monkey(searchHandler, "/api/search")).Methods("GET")
-	public := api.PathPrefix("/public").Subrouter()
-	public.Handle("/publicUser", monkey(publicUserGetHandler, "")).Methods("GET")
-	public.PathPrefix("/dl").Handler(monkey(publicDlHandler, "/api/public/dl/")).Methods("GET")
-	public.PathPrefix("/share").Handler(monkey(publicShareHandler, "/api/public/share/")).Methods("GET")
-	return stripPrefix(server.BaseURL, r), nil
-}

backend/http/middleware.go

@@ -0,0 +1,329 @@
+package http
+
+import (
+	"compress/gzip"
+	"encoding/json"
+	"fmt"
+	"log"
+	"net/http"
+	"path/filepath"
+	"strings"
+	"time"
+
+	"github.com/golang-jwt/jwt/v4"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/runner"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+)
+
+type requestContext struct {
+	user *users.User
+	*runner.Runner
+	raw interface{}
+}
+
+type HttpResponse struct {
+	Status  int    `json:"status,omitempty"`
+	Message string `json:"message,omitempty"`
+	Token   string `json:"token,omitempty"`
+}
+
+var FileInfoFasterFunc = files.FileInfoFaster
+
+// Updated handleFunc to match the new signature
+type handleFunc func(w http.ResponseWriter, r *http.Request, data *requestContext) (int, error)
+
+// Middleware to handle file requests by hash and pass it to the handler
+func withHashFileHelper(fn handleFunc) handleFunc {
+	return func(w http.ResponseWriter, r *http.Request, data *requestContext) (int, error) {
+		path := r.URL.Query().Get("path")
+		hash := r.URL.Query().Get("hash")
+		data.user = &users.PublicUser
+
+		// Get the file link by hash
+		link, err := store.Share.GetByHash(hash)
+		if err != nil {
+			return http.StatusNotFound, fmt.Errorf("share not found")
+		}
+		// Authenticate the share request if needed
+		var status int
+		if link.Hash != "" {
+			status, err = authenticateShareRequest(r, link)
+			if err != nil || status != http.StatusOK {
+				return status, fmt.Errorf("could not authenticate share request")
+			}
+		}
+		// Retrieve the user (using the public user by default)
+		user := &users.PublicUser
+
+		// Get file information with options
+		file, err := FileInfoFasterFunc(files.FileOptions{
+			Path:       filepath.Join(user.Scope, link.Path+"/"+path),
+			Modify:     user.Perm.Modify,
+			Expand:     true,
+			ReadHeader: config.Server.TypeDetectionByHeader,
+			Checker:    user, // Call your checker function here
+		})
+		file.Token = link.Token
+		if err != nil {
+			return errToStatus(err), fmt.Errorf("error fetching share from server")
+		}
+
+		// Set the file info in the `data` object
+		data.raw = file
+
+		// Call the next handler with the data
+		return fn(w, r, data)
+	}
+}
+
+// Middleware to ensure the user is an admin
+func withAdminHelper(fn handleFunc) handleFunc {
+	return withUserHelper(func(w http.ResponseWriter, r *http.Request, data *requestContext) (int, error) {
+		// Ensure the user has admin permissions
+		if !data.user.Perm.Admin {
+			return http.StatusForbidden, nil
+		}
+
+		// Proceed to the actual handler if the user is admin
+		return fn(w, r, data)
+	})
+}
+
+// Middleware to retrieve and authenticate user
+func withUserHelper(fn handleFunc) handleFunc {
+	return func(w http.ResponseWriter, r *http.Request, data *requestContext) (int, error) {
+		if settings.Config.Auth.Method == "noauth" {
+			var err error
+			// Retrieve the user from the store and store it in the context
+			data.user, err = store.Users.Get(config.Server.Root, "admin")
+			if err != nil {
+				return http.StatusInternalServerError, err
+			}
+			return fn(w, r, data)
+		}
+		keyFunc := func(token *jwt.Token) (interface{}, error) {
+			return config.Auth.Key, nil
+		}
+		tokenString, err := extractToken(r)
+		if err != nil {
+			return http.StatusUnauthorized, err
+		}
+
+		var tk users.AuthToken
+		token, err := jwt.ParseWithClaims(tokenString, &tk, keyFunc)
+		if err != nil {
+			return http.StatusUnauthorized, fmt.Errorf("error processing token, %v", err)
+		}
+		if !token.Valid {
+			return http.StatusUnauthorized, fmt.Errorf("invalid token")
+		}
+		if isRevokedApiKey(tk.Key) || tk.Expires < time.Now().Unix() {
+			return http.StatusUnauthorized, fmt.Errorf("token expired or revoked")
+		}
+		// Check if the token is about to expire and send a header to renew it
+		if tk.Expires < time.Now().Add(time.Hour).Unix() {
+			w.Header().Add("X-Renew-Token", "true")
+		}
+		// Retrieve the user from the store and store it in the context
+		data.user, err = store.Users.Get(config.Server.Root, tk.BelongsTo)
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+		// Call the handler function, passing in the context
+		return fn(w, r, data)
+	}
+}
+
+// Middleware to ensure the user is either the requested user or an admin
+func withSelfOrAdminHelper(fn handleFunc) handleFunc {
+	return withUserHelper(func(w http.ResponseWriter, r *http.Request, data *requestContext) (int, error) {
+		// Check if the current user is the same as the requested user or if they are an admin
+		if !data.user.Perm.Admin {
+			return http.StatusForbidden, nil
+		}
+		// Call the actual handler function with the updated context
+		return fn(w, r, data)
+	})
+}
+
+func wrapHandler(fn handleFunc) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		data := &requestContext{
+			Runner: &runner.Runner{Enabled: config.Server.EnableExec, Settings: config},
+		}
+
+		// Call the actual handler function and get status code and error
+		status, err := fn(w, r, data)
+
+		// Handle the error case if there is one
+		if err != nil {
+			// Create an error response in JSON format
+			response := &HttpResponse{
+				Status:  status, // Use the status code from the middleware
+				Message: err.Error(),
+			}
+
+			// Set the content type to JSON and status code
+			w.Header().Set("Content-Type", "application/json; charset=utf-8")
+			w.WriteHeader(status)
+
+			// Marshal the error response to JSON
+			errorBytes, marshalErr := json.Marshal(response)
+			if marshalErr != nil {
+				log.Printf("Error marshalling error response: %v", marshalErr)
+				http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+				return
+			}
+
+			// Write the JSON error response
+			if _, writeErr := w.Write(errorBytes); writeErr != nil {
+				log.Printf("Error writing error response: %v", writeErr)
+			}
+			return
+		}
+
+		// No error, proceed to write status if non-zero
+		if status != 0 {
+			w.WriteHeader(status)
+		}
+	}
+}
+
+func withPermShareHelper(fn handleFunc) handleFunc {
+	return withUserHelper(func(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+		if !d.user.Perm.Share {
+			return http.StatusForbidden, nil
+		}
+		return fn(w, r, d)
+	})
+}
+
+func withPermShare(fn handleFunc) http.HandlerFunc {
+	return wrapHandler(withPermShareHelper(fn))
+}
+
+// Example of wrapping specific middleware functions for use with http.HandleFunc
+func withHashFile(fn handleFunc) http.HandlerFunc {
+	return wrapHandler(withHashFileHelper(fn))
+}
+
+func withAdmin(fn handleFunc) http.HandlerFunc {
+	return wrapHandler(withAdminHelper(fn))
+}
+
+func withUser(fn handleFunc) http.HandlerFunc {
+	return wrapHandler(withUserHelper(fn))
+}
+
+func withSelfOrAdmin(fn handleFunc) http.HandlerFunc {
+	return wrapHandler(withSelfOrAdminHelper(fn))
+}
+
+func muxWithMiddleware(mux *http.ServeMux) *http.ServeMux {
+	wrappedMux := http.NewServeMux()
+	wrappedMux.Handle("/", LoggingMiddleware(mux))
+	return wrappedMux
+}
+
+// ResponseWriterWrapper wraps the standard http.ResponseWriter to capture the status code
+type ResponseWriterWrapper struct {
+	http.ResponseWriter
+	StatusCode  int
+	wroteHeader bool
+	PayloadSize int
+}
+
+// WriteHeader captures the status code and ensures it's only written once
+func (w *ResponseWriterWrapper) WriteHeader(statusCode int) {
+	if !w.wroteHeader { // Prevent WriteHeader from being called multiple times
+		if statusCode == 0 {
+			statusCode = http.StatusInternalServerError
+		}
+		w.StatusCode = statusCode
+		w.ResponseWriter.WriteHeader(statusCode)
+		w.wroteHeader = true
+	}
+}
+
+// Write is the method to write the response body and ensure WriteHeader is called
+func (w *ResponseWriterWrapper) Write(b []byte) (int, error) {
+	if !w.wroteHeader { // Default to 200 if WriteHeader wasn't called explicitly
+		w.WriteHeader(http.StatusOK)
+	}
+	return w.ResponseWriter.Write(b)
+}
+
+// LoggingMiddleware logs each request and its status code.
+func LoggingMiddleware(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+
+		start := time.Now()
+
+		// Wrap the ResponseWriter to capture the status code.
+		wrappedWriter := &ResponseWriterWrapper{ResponseWriter: w, StatusCode: http.StatusOK}
+
+		// Call the next handler.
+		next.ServeHTTP(wrappedWriter, r)
+
+		// Determine the color based on the status code.
+		color := "\033[32m" // Default green color
+		if wrappedWriter.StatusCode >= 300 && wrappedWriter.StatusCode < 500 {
+			color = "\033[33m" // Yellow for client errors (4xx)
+		} else if wrappedWriter.StatusCode >= 500 {
+			color = "\033[31m" // Red for server errors (5xx)
+		}
+
+		// Capture the full URL path including the query parameters.
+		fullURL := r.URL.Path
+		if r.URL.RawQuery != "" {
+			fullURL += "?" + r.URL.RawQuery
+		}
+
+		// Log the request, status code, and response size.
+		log.Printf("%s%-7s | %3d | %-15s | %-12s | \"%s\"%s",
+			color,
+			r.Method,
+			wrappedWriter.StatusCode, // Captured status code
+			r.RemoteAddr,
+			time.Since(start).String(),
+			fullURL,
+			"\033[0m", // Reset color
+		)
+	})
+}
+
+func renderJSON(w http.ResponseWriter, r *http.Request, data interface{}) (int, error) {
+	marsh, err := json.Marshal(data)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+	// Calculate size in KB
+	payloadSizeKB := len(marsh) / 1024
+	// Check if the client accepts gzip encoding and hasn't explicitly disabled it
+	if acceptsGzip(r) && payloadSizeKB > 10 {
+		// Enable gzip compression
+		w.Header().Set("Content-Type", "application/json; charset=utf-8")
+		w.Header().Set("Content-Encoding", "gzip")
+		gz := gzip.NewWriter(w)
+		defer gz.Close()
+
+		if _, err := gz.Write(marsh); err != nil {
+			return http.StatusInternalServerError, err
+		}
+	} else {
+		// Normal response without compression
+		w.Header().Set("Content-Type", "application/json; charset=utf-8")
+		if _, err := w.Write(marsh); err != nil {
+			return http.StatusInternalServerError, err
+		}
+	}
+
+	return 0, nil
+}
+
+func acceptsGzip(r *http.Request) bool {
+	ae := r.Header.Get("Accept-Encoding")
+	return ae != "" && strings.Contains(ae, "gzip")
+}

backend/http/middleware_test.go

@@ -0,0 +1,271 @@
+package http
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/asdine/storm/v3"
+	"github.com/gtsteffaniak/filebrowser/backend/diskcache"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/img"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/storage/bolt"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
+)
+
+func setupTestEnv(t *testing.T) {
+	dbPath := filepath.Join(t.TempDir(), "db")
+	db, err := storm.Open(dbPath)
+	if err != nil {
+		t.Fatal(err)
+	}
+	authStore, userStore, shareStore, settingsStore, err := bolt.NewStorage(db)
+	if err != nil {
+		t.Fatal(err)
+	}
+	store = &storage.Storage{
+		Auth:     authStore,
+		Users:    userStore,
+		Share:    shareStore,
+		Settings: settingsStore,
+	}
+	fileCache = diskcache.NewNoOp() // mocked
+	imgSvc = img.New(1)             // mocked
+	config = &settings.Config       // mocked
+	mockFileInfoFaster(t)           // Mock FileInfoFasterFunc for this test
+}
+
+func mockFileInfoFaster(t *testing.T) {
+	// Backup the original function
+	originalFileInfoFaster := FileInfoFasterFunc
+	// Defer restoration of the original function
+	t.Cleanup(func() { FileInfoFasterFunc = originalFileInfoFaster })
+
+	// Mock the function to skip execution
+	FileInfoFasterFunc = func(opts files.FileOptions) (files.ExtendedFileInfo, error) {
+		return files.ExtendedFileInfo{
+			FileInfo: &files.FileInfo{
+				Path: opts.Path,
+				ItemInfo: files.ItemInfo{
+					Name: "mocked_file",
+					Size: 12345,
+				},
+			},
+		}, nil
+	}
+}
+
+func TestWithAdminHelper(t *testing.T) {
+	setupTestEnv(t)
+	// Mock a user who has admin permissions
+	adminUser := &users.User{
+		ID:       1,
+		Username: "admin",
+		Perm:     users.Permissions{Admin: true}, // Ensure the user is an admin
+	}
+	nonAdminUser := &users.User{
+		ID:       2,
+		Username: "non-admin",
+		Perm:     users.Permissions{Admin: false}, // Non-admin user
+	}
+	// Save the users to the mock database
+	if err := store.Users.Save(adminUser); err != nil {
+		t.Fatal("failed to save admin user:", err)
+	}
+	if err := store.Users.Save(nonAdminUser); err != nil {
+		t.Fatal("failed to save non-admin user:", err)
+	}
+	// Test cases for different scenarios
+	testCases := []struct {
+		name               string
+		expectedStatusCode int
+		user               *users.User
+	}{
+		{
+			name:               "Admin access allowed",
+			expectedStatusCode: http.StatusOK, // Admin should be able to access
+			user:               adminUser,
+		},
+		{
+			name:               "Non-admin access forbidden",
+			expectedStatusCode: http.StatusForbidden, // Non-admin should be forbidden
+			user:               nonAdminUser,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Mock the context with the current user
+			data := &requestContext{
+				user: tc.user,
+			}
+			token, err := makeSignedTokenAPI(tc.user, "WEB_TOKEN_"+utils.GenerateRandomHash(4), time.Hour*2, tc.user.Perm)
+			if err != nil {
+				t.Fatalf("Error making token for request: %v", err)
+			}
+
+			// Wrap the usersGetHandler with the middleware
+			handler := withAdminHelper(mockHandler)
+
+			// Create a response recorder to capture the handler's output
+			recorder := httptest.NewRecorder()
+			// Create the request and apply the token as a cookie
+			req, err := http.NewRequest(http.MethodGet, "/users", http.NoBody)
+			if err != nil {
+				t.Fatalf("Error creating request: %v", err)
+			}
+			req.AddCookie(&http.Cookie{
+				Name:  "auth",
+				Value: token.Key,
+			})
+
+			// Call the handler with the test request and mock context
+			status, err := handler(recorder, req, data)
+			if err != nil {
+				t.Fatalf("unexpected error: %v", err)
+			}
+
+			// Verify the status code
+			if status != tc.expectedStatusCode {
+				t.Errorf("\"%v\" expected status code %d, got %d", tc.name, tc.expectedStatusCode, status)
+			}
+		})
+	}
+}
+
+func TestPublicShareHandlerAuthentication(t *testing.T) {
+	setupTestEnv(t)
+
+	const passwordBcrypt = "$2y$10$TFAmdCbyd/mEZDe5fUeZJu.MaJQXRTwdqb/IQV.eTn6dWrF58gCSe" // bcrypt hashed password
+
+	testCases := []struct {
+		name               string
+		share              *share.Link
+		token              string
+		password           string
+		extraHeaders       map[string]string
+		expectedStatusCode int
+	}{
+		{
+			name: "Public share, no auth required",
+			share: &share.Link{
+				Hash: "public_hash",
+			},
+			expectedStatusCode: 0, // zero means 200 on helpers
+		},
+		{
+			name: "Private share, no auth provided",
+			share: &share.Link{
+				Hash:         "private_hash",
+				UserID:       1,
+				PasswordHash: passwordBcrypt,
+				Token:        "123",
+			},
+			expectedStatusCode: http.StatusUnauthorized,
+		},
+		{
+			name: "Private share, valid token",
+			share: &share.Link{
+				Hash:         "token_hash",
+				UserID:       1,
+				PasswordHash: passwordBcrypt,
+				Token:        "123",
+			},
+			token:              "123",
+			expectedStatusCode: 0, // zero means 200 on helpers
+		},
+		{
+			name: "Private share, invalid password",
+			share: &share.Link{
+				Hash:         "pw_hash",
+				UserID:       1,
+				PasswordHash: passwordBcrypt,
+				Token:        "123",
+			},
+			extraHeaders: map[string]string{
+				"X-SHARE-PASSWORD": "wrong-password",
+			},
+			expectedStatusCode: http.StatusUnauthorized,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Save the share in the mock store
+			if err := store.Share.Save(tc.share); err != nil {
+				t.Fatal("failed to save share:", err)
+			}
+
+			// Create a response recorder to capture handler output
+			recorder := httptest.NewRecorder()
+
+			// Wrap the handler with authentication middleware
+			handler := withHashFileHelper(publicShareHandler)
+			if err := store.Settings.Save(&settings.Settings{
+				Auth: settings.Auth{
+					Key: []byte("key"),
+				},
+			}); err != nil {
+				t.Fatalf("failed to save settings: %v", err)
+			}
+
+			// Prepare the request with query parameters and optional headers
+			req := newTestRequest(t, tc.share.Hash, tc.token, tc.password, tc.extraHeaders)
+
+			// Serve the request
+			status, _ := handler(recorder, req, &requestContext{})
+
+			// Check if the response matches the expected status code
+			if status != tc.expectedStatusCode {
+				t.Errorf("expected status code %d, got %d", tc.expectedStatusCode, status)
+			}
+		})
+	}
+}
+
+// Helper function to create a new HTTP request with optional parameters
+func newTestRequest(t *testing.T, hash, token, password string, headers map[string]string) *http.Request {
+	req := newHTTPRequest(t, hash, func(r *http.Request) {
+		// Set query parameters based on provided values
+		q := r.URL.Query()
+		q.Set("path", "/")
+		q.Set("hash", hash)
+		if token != "" {
+			q.Set("token", token)
+		}
+		if password != "" {
+			q.Set("password", password)
+		}
+		r.URL.RawQuery = q.Encode()
+
+		// Set any extra headers if provided
+		for key, value := range headers {
+			r.Header.Set(key, value)
+		}
+	})
+	return req
+}
+
+func mockHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	return http.StatusOK, nil // mock response
+}
+
+// Modify newHTTPRequest to accept the hash and use it in the URL path.
+func newHTTPRequest(t *testing.T, hash string, requestModifiers ...func(*http.Request)) *http.Request {
+	t.Helper()
+	url := "/public/share/" + hash + "/" // Dynamically include the hash in the URL path
+	r, err := http.NewRequest(http.MethodGet, url, http.NoBody)
+	if err != nil {
+		t.Fatalf("failed to create request: %v", err)
+	}
+	for _, modify := range requestModifiers {
+		modify(r)
+	}
+	return r
+}

backend/http/preview.go

@@ -1,4 +1,3 @@
-//go:generate go-enum --sql --marshal --names --file $GOFILE
 package http
 
 import (
@@ -8,21 +7,13 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"path/filepath"
+	"strings"
 
-	"github.com/gorilla/mux"
-
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/img"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/img"
 )
 
-/*
-ENUM(
-thumb
-big
-)
-*/
-type PreviewSize int
-
 type ImgService interface {
 	FormatFromExtension(ext string) (img.Format, error)
 	Resize(ctx context.Context, in io.Reader, width, height int, out io.Writer, options ...img.Option) error
@@ -34,83 +25,89 @@ type FileCache interface {
 	Delete(ctx context.Context, key string) error
 }
 
-func previewHandler(imgSvc ImgService, fileCache FileCache, enableThumbnails, resizePreview bool) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+// previewHandler handles the preview request for images.
+// @Summary Get image preview
+// @Description Returns a preview image based on the requested path and size.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param path query string true "File path of the image to preview"
+// @Param size query string false "Preview size ('small' or 'large'). Default is based on server config."
+// @Success 200 {file} file "Preview image content"
+// @Failure 202 {object} map[string]string "Download permissions required"
+// @Failure 400 {object} map[string]string "Invalid request path"
+// @Failure 404 {object} map[string]string "File not found"
+// @Failure 415 {object} map[string]string "Unsupported file type for preview"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/preview [get]
+func previewHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	path := r.URL.Query().Get("path")
+	previewSize := r.URL.Query().Get("size")
+	if previewSize != "small" {
+		previewSize = "large"
+	}
+
+	if path == "" {
+		return http.StatusBadRequest, fmt.Errorf("invalid request path")
+	}
+	response, err := files.FileInfoFaster(files.FileOptions{
+		Path:       filepath.Join(d.user.Scope, path),
+		Modify:     d.user.Perm.Modify,
+		Expand:     true,
+		ReadHeader: config.Server.TypeDetectionByHeader,
+		Checker:    d.user,
+	})
+	fileInfo := response.FileInfo
+	if err != nil {
+		return errToStatus(err), err
+	}
+	if fileInfo.Type == "directory" {
+		return http.StatusBadRequest, fmt.Errorf("can't create preview for directory")
+	}
+	setContentDisposition(w, r, fileInfo.Name)
+	if !strings.HasPrefix(fileInfo.Type, "image") {
+		return http.StatusNotImplemented, fmt.Errorf("can't create preview for %s type", fileInfo.Type)
+	}
+
+	if (previewSize == "large" && !config.Server.ResizePreview) ||
+		(previewSize == "small" && !config.Server.EnableThumbnails) {
 		if !d.user.Perm.Download {
 			return http.StatusAccepted, nil
 		}
-		vars := mux.Vars(r)
-
-		previewSize, err := ParsePreviewSize(vars["size"])
-		if err != nil {
-			return http.StatusBadRequest, err
-		}
-
-		file, err := files.FileInfoFaster(files.FileOptions{
-			Path:       "/" + vars["path"],
-			Modify:     d.user.Perm.Modify,
-			Expand:     true,
-			ReadHeader: d.server.TypeDetectionByHeader,
-			Checker:    d,
-		})
-
-		if err != nil {
-			return errToStatus(err), err
-		}
-		setContentDisposition(w, r, file)
-
-		switch file.Type {
-		case "image":
-			return handleImagePreview(w, r, imgSvc, fileCache, file, previewSize, enableThumbnails, resizePreview)
-		default:
-			return http.StatusNotImplemented, fmt.Errorf("can't create preview for %s type", file.Type)
-		}
-	})
-}
-
-func handleImagePreview(
-	w http.ResponseWriter,
-	r *http.Request,
-	imgSvc ImgService,
-	fileCache FileCache,
-	file *files.FileInfo,
-	previewSize PreviewSize,
-	enableThumbnails, resizePreview bool,
-) (int, error) {
-	if (previewSize == PreviewSizeBig && !resizePreview) ||
-		(previewSize == PreviewSizeThumb && !enableThumbnails) {
-		return rawFileHandler(w, r, file)
+		return rawFileHandler(w, r, fileInfo)
 	}
-	format, err := imgSvc.FormatFromExtension(file.Extension)
+
+	format, err := imgSvc.FormatFromExtension(filepath.Ext(fileInfo.Name))
 	// Unsupported extensions directly return the raw data
 	if err == img.ErrUnsupportedFormat || format == img.FormatGif {
-		return rawFileHandler(w, r, file)
+		if !d.user.Perm.Download {
+			return http.StatusAccepted, nil
+		}
+		return rawFileHandler(w, r, fileInfo)
 	}
 	if err != nil {
 		return errToStatus(err), err
 	}
-
-	cacheKey := previewCacheKey(file, previewSize)
+	cacheKey := previewCacheKey(fileInfo, previewSize)
 	resizedImage, ok, err := fileCache.Load(r.Context(), cacheKey)
 	if err != nil {
 		return errToStatus(err), err
 	}
+
 	if !ok {
-		resizedImage, err = createPreview(imgSvc, fileCache, file, previewSize)
+		resizedImage, err = createPreview(imgSvc, fileCache, fileInfo, previewSize)
 		if err != nil {
 			return errToStatus(err), err
 		}
 	}
-
 	w.Header().Set("Cache-Control", "private")
-	http.ServeContent(w, r, file.Name, file.ModTime, bytes.NewReader(resizedImage))
+	http.ServeContent(w, r, fileInfo.RealPath(), fileInfo.ModTime, bytes.NewReader(resizedImage))
 
 	return 0, nil
 }
 
-func createPreview(imgSvc ImgService, fileCache FileCache,
-	file *files.FileInfo, previewSize PreviewSize) ([]byte, error) {
-	fd, err := os.Open(file.Path)
+func createPreview(imgSvc ImgService, fileCache FileCache, file *files.FileInfo, previewSize string) ([]byte, error) {
+	fd, err := os.Open(file.RealPath())
 	if err != nil {
 		return nil, err
 	}
@@ -123,11 +120,11 @@ func createPreview(imgSvc ImgService, fileCache FileCache,
 	)
 
 	switch {
-	case previewSize == PreviewSizeBig:
+	case previewSize == "large":
 		width = 1080
 		height = 1080
 		options = append(options, img.WithMode(img.ResizeModeFit), img.WithQuality(img.QualityMedium))
-	case previewSize == PreviewSizeThumb:
+	case previewSize == "small":
 		width = 256
 		height = 256
 		options = append(options, img.WithMode(img.ResizeModeFill), img.WithQuality(img.QualityLow), img.WithFormat(img.FormatJpeg))
@@ -150,6 +147,22 @@ func createPreview(imgSvc ImgService, fileCache FileCache,
 	return buf.Bytes(), nil
 }
 
-func previewCacheKey(f *files.FileInfo, previewSize PreviewSize) string {
+// Generates a cache key for the preview image
+func previewCacheKey(f *files.FileInfo, previewSize string) string {
 	return fmt.Sprintf("%x%x%x", f.RealPath(), f.ModTime.Unix(), previewSize)
 }
+
+func rawFileHandler(w http.ResponseWriter, r *http.Request, file *files.FileInfo) (int, error) {
+	realPath, _, _ := files.GetRealPath(file.Path)
+	fd, err := os.Open(realPath)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+	defer fd.Close()
+
+	setContentDisposition(w, r, file.Name)
+
+	w.Header().Set("Cache-Control", "private")
+	http.ServeContent(w, r, file.Name, file.ModTime, fd)
+	return 0, nil
+}

backend/http/preview_enum.go

@@ -1,100 +0,0 @@
-// Code generated by go-enum
-// DO NOT EDIT!
-
-package http
-
-import (
-	"database/sql/driver"
-	"fmt"
-	"strings"
-)
-
-const (
-	// PreviewSizeThumb is a PreviewSize of type Thumb
-	PreviewSizeThumb PreviewSize = iota
-	// PreviewSizeBig is a PreviewSize of type Big
-	PreviewSizeBig
-)
-
-const _PreviewSizeName = "thumbbig"
-
-var _PreviewSizeNames = []string{
-	_PreviewSizeName[0:5],
-	_PreviewSizeName[5:8],
-}
-
-// PreviewSizeNames returns a list of possible string values of PreviewSize.
-func PreviewSizeNames() []string {
-	tmp := make([]string, len(_PreviewSizeNames))
-	copy(tmp, _PreviewSizeNames)
-	return tmp
-}
-
-var _PreviewSizeMap = map[PreviewSize]string{
-	0: _PreviewSizeName[0:5],
-	1: _PreviewSizeName[5:8],
-}
-
-// String implements the Stringer interface.
-func (x PreviewSize) String() string {
-	if str, ok := _PreviewSizeMap[x]; ok {
-		return str
-	}
-	return fmt.Sprintf("PreviewSize(%d)", x)
-}
-
-var _PreviewSizeValue = map[string]PreviewSize{
-	_PreviewSizeName[0:5]: 0,
-	_PreviewSizeName[5:8]: 1,
-}
-
-// ParsePreviewSize attempts to convert a string to a PreviewSize
-func ParsePreviewSize(name string) (PreviewSize, error) {
-	if x, ok := _PreviewSizeValue[name]; ok {
-		return x, nil
-	}
-	return PreviewSize(0), fmt.Errorf("%s is not a valid PreviewSize, try [%s]", name, strings.Join(_PreviewSizeNames, ", "))
-}
-
-// MarshalText implements the text marshaller method
-func (x PreviewSize) MarshalText() ([]byte, error) {
-	return []byte(x.String()), nil
-}
-
-// UnmarshalText implements the text unmarshaller method
-func (x *PreviewSize) UnmarshalText(text []byte) error {
-	name := string(text)
-	tmp, err := ParsePreviewSize(name)
-	if err != nil {
-		return err
-	}
-	*x = tmp
-	return nil
-}
-
-// Scan implements the Scanner interface.
-func (x *PreviewSize) Scan(value interface{}) error {
-	var name string
-
-	switch v := value.(type) {
-	case string:
-		name = v
-	case []byte:
-		name = string(v)
-	case nil:
-		*x = PreviewSize(0)
-		return nil
-	}
-
-	tmp, err := ParsePreviewSize(name)
-	if err != nil {
-		return err
-	}
-	*x = tmp
-	return nil
-}
-
-// Value implements the driver Valuer interface.
-func (x PreviewSize) Value() (driver.Value, error) {
-	return x.String(), nil
-}

backend/http/public.go

@@ -1,124 +1,67 @@
 package http
 
 import (
-	"errors"
+	"encoding/json"
 	"fmt"
 	"net/http"
-	"net/url"
-	"path"
 	"strings"
 
-	"golang.org/x/crypto/bcrypt"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/share"
-	"github.com/gtsteffaniak/filebrowser/users"
+	_ "github.com/gtsteffaniak/filebrowser/backend/swagger/docs"
 )
 
-var withHashFile = func(fn handleFunc) handleFunc {
-	return func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		id, path := ifPathWithName(r)
-		link, err := d.store.Share.GetByHash(id)
-		if err != nil {
-			return errToStatus(err), err
-		}
-		if link.Hash != "" {
-			var status int
-			status, err = authenticateShareRequest(r, link)
-			if err != nil || status != 0 {
-				return status, err
-			}
-		}
-		d.user = &users.PublicUser
-		realPath, isDir, err := files.GetRealPath(d.user.Scope, link.Path, path)
-		if err != nil {
-			return http.StatusNotFound, err
-		}
-		file, err := files.FileInfoFaster(files.FileOptions{
-			Path:       realPath,
-			IsDir:      isDir,
-			Modify:     d.user.Perm.Modify,
-			Expand:     true,
-			ReadHeader: d.server.TypeDetectionByHeader,
-			Checker:    d,
-			Token:      link.Token,
-		})
-		if err != nil {
-			return errToStatus(err), err
-		}
-		d.raw = file
-		return fn(w, r, d)
-	}
-}
-
-func ifPathWithName(r *http.Request) (id, filePath string) {
-	pathElements := strings.Split(r.URL.Path, "/")
-	id = pathElements[0]
-	allButFirst := path.Join(pathElements[1:]...)
-	return id, allButFirst
-}
-
-var publicShareHandler = withHashFile(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	file, ok := d.raw.(*files.FileInfo)
+func publicShareHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	file, ok := d.raw.(files.ExtendedFileInfo)
 	if !ok {
 		return http.StatusInternalServerError, fmt.Errorf("failed to assert type *files.FileInfo")
 	}
-
 	file.Path = strings.TrimPrefix(file.Path, settings.Config.Server.Root)
-	if file.IsDir {
-		return renderJSON(w, r, file)
-	}
-
 	return renderJSON(w, r, file)
-})
+}
 
-var publicUserGetHandler = func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+func publicUserGetHandler(w http.ResponseWriter, r *http.Request) {
 	// Call the actual handler logic here (e.g., renderJSON, etc.)
 	// You may need to replace `fn` with the actual handler logic.
-	return renderJSON(w, r, users.PublicUser)
-}
-
-var publicDlHandler = withHashFile(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	file, ok := d.raw.(*files.FileInfo)
-	if !ok {
-		return http.StatusInternalServerError, fmt.Errorf("failed to assert type *files.FileInfo")
-	}
-
-	if !file.IsDir {
-		return rawFileHandler(w, r, file)
-	}
-
-	return rawDirHandler(w, r, d, file)
-})
-
-func authenticateShareRequest(r *http.Request, l *share.Link) (int, error) {
-	if l.PasswordHash == "" {
-		return 0, nil
-	}
-
-	if r.URL.Query().Get("token") == l.Token {
-		return 0, nil
-	}
-
-	password := r.Header.Get("X-SHARE-PASSWORD")
-	password, err := url.QueryUnescape(password)
+	status, err := renderJSON(w, r, users.PublicUser)
 	if err != nil {
-		return 0, err
+		http.Error(w, http.StatusText(status), status)
 	}
-	if password == "" {
-		return http.StatusUnauthorized, nil
-	}
-	if err := bcrypt.CompareHashAndPassword([]byte(l.PasswordHash), []byte(password)); err != nil {
-		if errors.Is(err, bcrypt.ErrMismatchedHashAndPassword) {
-			return http.StatusUnauthorized, nil
-		}
-		return 0, err
-	}
-	return 0, nil
+
 }
 
-func healthHandler(w http.ResponseWriter, _ *http.Request) {
-	w.WriteHeader(http.StatusOK)
-	_, _ = w.Write([]byte(`{"status":"OK"}`))
+func publicDlHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	file, ok := d.raw.(files.ExtendedFileInfo)
+	if !ok {
+		return http.StatusInternalServerError, fmt.Errorf("failed to assert type files.FileInfo")
+	}
+	if d.user == nil {
+		return http.StatusUnauthorized, fmt.Errorf("failed to get user")
+	}
+
+	if file.Type == "directory" {
+		return rawFilesHandler(w, r, d, []string{file.Path})
+	}
+
+	return rawFileHandler(w, r, file.FileInfo)
+}
+
+// health godoc
+// @Summary Health Check
+// @Schemes
+// @Description Returns the health status of the API.
+// @Tags Health
+// @Accept json
+// @Produce json
+// @Success 200 {object} HttpResponse "successful health check response"
+// @Router /health [get]
+func healthHandler(w http.ResponseWriter, r *http.Request) {
+	w.Header().Set("Content-Type", "application/json")
+	response := HttpResponse{Message: "ok"}    // Create response with status "ok"
+	err := json.NewEncoder(w).Encode(response) // Encode the response into JSON
+	if err != nil {
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+	}
 }

backend/http/public_test.go

@@ -1,137 +0,0 @@
-package http
-
-import (
-	"fmt"
-	"net/http"
-	"net/http/httptest"
-	"path/filepath"
-	"testing"
-
-	"github.com/asdine/storm/v3"
-
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/share"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/storage/bolt"
-	"github.com/gtsteffaniak/filebrowser/users"
-)
-
-func TestPublicShareHandlerAuthentication(t *testing.T) {
-	t.Parallel()
-
-	const passwordBcrypt = "$2y$10$TFAmdCbyd/mEZDe5fUeZJu.MaJQXRTwdqb/IQV.eTn6dWrF58gCSe" //nolint:gosec
-	testCases := map[string]struct {
-		share              *share.Link
-		req                *http.Request
-		expectedStatusCode int
-	}{
-		"Public share, no auth required": {
-			share:              &share.Link{Hash: "h"},
-			req:                newHTTPRequest(t),
-			expectedStatusCode: 200,
-		},
-		"Private share, no auth provided, 401": {
-			share:              &share.Link{Hash: "h", UserID: 1, PasswordHash: passwordBcrypt, Token: "123"},
-			req:                newHTTPRequest(t),
-			expectedStatusCode: 401,
-		},
-		"Private share, authentication via token": {
-			share:              &share.Link{Hash: "h", UserID: 1, PasswordHash: passwordBcrypt, Token: "123"},
-			req:                newHTTPRequest(t, func(r *http.Request) { r.URL.RawQuery = "token=123" }),
-			expectedStatusCode: 200,
-		},
-		"Private share, authentication via invalid token, 401": {
-			share:              &share.Link{Hash: "h", UserID: 1, PasswordHash: passwordBcrypt, Token: "123"},
-			req:                newHTTPRequest(t, func(r *http.Request) { r.URL.RawQuery = "token=1234" }),
-			expectedStatusCode: 401,
-		},
-		"Private share, authentication via password": {
-			share:              &share.Link{Hash: "h", UserID: 1, PasswordHash: passwordBcrypt, Token: "123"},
-			req:                newHTTPRequest(t, func(r *http.Request) { r.Header.Set("X-SHARE-PASSWORD", "password") }),
-			expectedStatusCode: 200,
-		},
-		"Private share, authentication via invalid password, 401": {
-			share:              &share.Link{Hash: "h", UserID: 1, PasswordHash: passwordBcrypt, Token: "123"},
-			req:                newHTTPRequest(t, func(r *http.Request) { r.Header.Set("X-SHARE-PASSWORD", "wrong-password") }),
-			expectedStatusCode: 401,
-		},
-	}
-
-	for name, tc := range testCases {
-		for handlerName, handler := range map[string]handleFunc{"public share handler": publicShareHandler, "public dl handler": publicDlHandler} {
-			name, tc, handlerName, handler := name, tc, handlerName, handler
-			t.Run(fmt.Sprintf("%s: %s", handlerName, name), func(t *testing.T) {
-				t.Parallel()
-
-				dbPath := filepath.Join(t.TempDir(), "db")
-				db, err := storm.Open(dbPath)
-				if err != nil {
-					t.Fatalf("failed to open db: %v", err)
-				}
-
-				t.Cleanup(func() {
-					if err := db.Close(); err != nil { //nolint:govet
-						t.Errorf("failed to close db: %v", err)
-					}
-				})
-				authStore, userStore, shareStore, settingsStore, err := bolt.NewStorage(db)
-				storage := &storage.Storage{
-					Auth:     authStore,
-					Users:    userStore,
-					Share:    shareStore,
-					Settings: settingsStore,
-				}
-				if err != nil {
-					t.Fatalf("failed to get storage: %v", err)
-				}
-				if err := storage.Share.Save(tc.share); err != nil {
-					t.Fatalf("failed to save share: %v", err)
-				}
-				if err := storage.Settings.Save(&settings.Settings{
-					Auth: settings.Auth{
-						Key: []byte("key"),
-					},
-				}); err != nil {
-					t.Fatalf("failed to save settings: %v", err)
-				}
-
-				storage.Users = &customFSUser{
-					Store: storage.Users,
-				}
-
-				recorder := httptest.NewRecorder()
-				handler := handle(handler, "", storage, &settings.Server{})
-				handler.ServeHTTP(recorder, tc.req)
-				result := recorder.Result()
-				defer result.Body.Close()
-				if result.StatusCode != tc.expectedStatusCode {
-					t.Errorf("expected status code %d, got status code %d", tc.expectedStatusCode, result.StatusCode)
-				}
-			})
-		}
-	}
-}
-
-func newHTTPRequest(t *testing.T, requestModifiers ...func(*http.Request)) *http.Request {
-	t.Helper()
-	r, err := http.NewRequest(http.MethodGet, "h", http.NoBody)
-	if err != nil {
-		t.Fatalf("failed to construct request: %v", err)
-	}
-	for _, modify := range requestModifiers {
-		modify(r)
-	}
-	return r
-}
-
-type customFSUser struct {
-	users.Store
-}
-
-func (cu *customFSUser) Get(baseScope string, id interface{}) (*users.User, error) {
-	user, err := cu.Store.Get(baseScope, id)
-	if err != nil {
-		return nil, err
-	}
-	return user, nil
-}

backend/http/raw.go

@@ -1,216 +1,232 @@
 package http
 
 import (
+	"archive/tar"
+	"archive/zip"
+	"compress/gzip"
 	"errors"
+	"fmt"
+	"io"
 	"log"
 	"net/http"
 	"net/url"
 	"os"
-	gopath "path"
 	"path/filepath"
 	"strings"
 
-	"github.com/mholt/archiver/v3"
-
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/fileutils"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
 )
 
-func slashClean(name string) string {
-	if name == "" || name[0] != '/' {
-		name = "/" + name
-	}
-	return gopath.Clean(name)
-}
-
-func parseQueryFiles(r *http.Request, f *files.FileInfo, _ *users.User) ([]string, error) {
-	var fileSlice []string
-	names := strings.Split(r.URL.Query().Get("files"), ",")
-
-	if len(names) == 0 {
-		fileSlice = append(fileSlice, f.Path)
-	} else {
-		for _, name := range names {
-			name, err := url.QueryUnescape(strings.Replace(name, "+", "%2B", -1)) //nolint:govet
-			if err != nil {
-				return nil, err
-			}
-
-			name = slashClean(name)
-			fileSlice = append(fileSlice, filepath.Join(f.Path, name))
-		}
-	}
-
-	return fileSlice, nil
-}
-
-// nolint: goconst,nolintlint
-func parseQueryAlgorithm(r *http.Request) (string, archiver.Writer, error) {
-	// TODO: use enum
-	switch r.URL.Query().Get("algo") {
-	case "zip", "true", "":
-		return ".zip", archiver.NewZip(), nil
-	case "tar":
-		return ".tar", archiver.NewTar(), nil
-	case "targz":
-		return ".tar.gz", archiver.NewTarGz(), nil
-	case "tarbz2":
-		return ".tar.bz2", archiver.NewTarBz2(), nil
-	case "tarxz":
-		return ".tar.xz", archiver.NewTarXz(), nil
-	case "tarlz4":
-		return ".tar.lz4", archiver.NewTarLz4(), nil
-	case "tarsz":
-		return ".tar.sz", archiver.NewTarSz(), nil
-	default:
-		return "", nil, errors.New("format not implemented")
-	}
-}
-
-func setContentDisposition(w http.ResponseWriter, r *http.Request, file *files.FileInfo) {
+func setContentDisposition(w http.ResponseWriter, r *http.Request, fileName string) {
 	if r.URL.Query().Get("inline") == "true" {
 		w.Header().Set("Content-Disposition", "inline")
 	} else {
 		// As per RFC6266 section 4.3
-		w.Header().Set("Content-Disposition", "attachment; filename*=utf-8''"+url.PathEscape(file.Name))
+		w.Header().Set("Content-Disposition", "attachment; filename*=utf-8''"+url.PathEscape(fileName))
 	}
 }
 
-var rawHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+// rawHandler serves the raw content of a file, multiple files, or directory in various formats.
+// @Summary Get raw content of a file, multiple files, or directory
+// @Description Returns the raw content of a file, multiple files, or a directory. Supports downloading files as archives in various formats.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param files query string true "Comma-separated list of specific files within the directory (required)"
+// @Param inline query bool false "If true, sets 'Content-Disposition' to 'inline'. Otherwise, defaults to 'attachment'."
+// @Param algo query string false "Compression algorithm for archiving multiple files or directories. Options: 'zip' and 'tar.gz'. Default is 'zip'."
+// @Success 200 {file} file "Raw file or directory content, or archive for multiple files"
+// @Failure 202 {object} map[string]string "Download permissions required"
+// @Failure 400 {object} map[string]string "Invalid request path"
+// @Failure 404 {object} map[string]string "File or directory not found"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/raw [get]
+func rawHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	if !d.user.Perm.Download {
 		return http.StatusAccepted, nil
 	}
-	realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
+	encodedFiles := r.URL.Query().Get("files")
+	// Decode the URL-encoded path
+	files, err := url.QueryUnescape(encodedFiles)
 	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-	file, err := files.FileInfoFaster(files.FileOptions{
-		Path:       realPath,
-		IsDir:      isDir,
-		Modify:     d.user.Perm.Modify,
-		Expand:     false,
-		ReadHeader: d.server.TypeDetectionByHeader,
-		Checker:    d,
-	})
-	if err != nil {
-		return errToStatus(err), err
-	}
-	if files.IsNamedPipe(file.Mode) {
-		setContentDisposition(w, r, file)
-		return 0, nil
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
 	}
+	return rawFilesHandler(w, r, d, strings.Split(files, ","))
+}
 
-	if !file.IsDir {
-		return rawFileHandler(w, r, file)
-	}
-
-	return rawDirHandler(w, r, d, file)
-})
-
-func addFile(ar archiver.Writer, d *data, path, commonPath string) error {
-	if !d.Check(path) {
+func addFile(path string, d *requestContext, tarWriter *tar.Writer, zipWriter *zip.Writer) error {
+	realPath, _, _ := files.GetRealPath(d.user.Scope, path)
+	if !d.user.Check(realPath) {
 		return nil
 	}
-	info, err := os.Stat(path)
+	info, err := os.Stat(realPath)
 	if err != nil {
 		return err
 	}
 
-	if !info.IsDir() && !info.Mode().IsRegular() {
-		return nil
+	if info.IsDir() {
+		// Walk through directory contents
+		return filepath.Walk(realPath, func(filePath string, fileInfo os.FileInfo, err error) error {
+			if err != nil {
+				return err
+			}
+			relPath, err := filepath.Rel(filepath.Dir(realPath), filePath) // Relative path including base dir
+			if err != nil {
+				return err
+			}
+			if fileInfo.IsDir() {
+				if tarWriter != nil {
+					header := &tar.Header{
+						Name:     relPath + "/",
+						Mode:     0755,
+						Typeflag: tar.TypeDir,
+						ModTime:  fileInfo.ModTime(),
+					}
+					return tarWriter.WriteHeader(header)
+				}
+				if zipWriter != nil {
+					_, err := zipWriter.Create(relPath + "/")
+					return err
+				}
+				return nil
+			}
+			return addSingleFile(filePath, relPath, zipWriter, tarWriter)
+		})
 	}
 
-	file, err := os.Open(path)
+	// Add a single file if it's not a directory
+	return addSingleFile(realPath, filepath.Base(realPath), zipWriter, tarWriter)
+}
+
+func addSingleFile(realPath, archivePath string, zipWriter *zip.Writer, tarWriter *tar.Writer) error {
+	file, err := os.Open(realPath)
 	if err != nil {
 		return err
 	}
 	defer file.Close()
 
-	if path != commonPath {
-		filename := strings.TrimPrefix(path, commonPath)
-		filename = strings.TrimPrefix(filename, string(filepath.Separator))
-		err = ar.Write(archiver.File{
-			FileInfo: archiver.FileInfo{
-				FileInfo:   info,
-				CustomName: filename,
-			},
-			ReadCloser: file,
-		})
-		if err != nil {
-			return err
-		}
+	info, err := os.Stat(realPath)
+	if err != nil {
+		return err
 	}
 
-	if info.IsDir() {
-		names, err := file.Readdirnames(0)
+	if tarWriter != nil {
+		header, err := tar.FileInfoHeader(info, realPath)
 		if err != nil {
 			return err
 		}
+		header.Name = archivePath
+		if err = tarWriter.WriteHeader(header); err != nil {
+			return err
+		}
+		_, err = io.Copy(tarWriter, file)
+		return err
+	}
 
-		for _, name := range names {
-			fPath := filepath.Join(path, name)
-			err = addFile(ar, d, fPath, commonPath)
-			if err != nil {
-				log.Printf("Failed to archive %s: %v", fPath, err)
-			}
+	if zipWriter != nil {
+		header, err := zip.FileInfoHeader(info)
+		if err != nil {
+			return err
+		}
+		header.Name = archivePath
+		writer, err := zipWriter.CreateHeader(header)
+		if err != nil {
+			return err
+		}
+		_, err = io.Copy(writer, file)
+		return err
+	}
+
+	return nil
+}
+
+func rawFilesHandler(w http.ResponseWriter, r *http.Request, d *requestContext, fileList []string) (int, error) {
+	filePath := fileList[0]
+	fileName := filepath.Base(filePath)
+	realPath, isDir, err := files.GetRealPath(d.user.Scope, filePath)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+	if len(fileList) == 1 && !isDir {
+		fd, err2 := os.Open(realPath)
+		if err2 != nil {
+			return http.StatusInternalServerError, err
+		}
+		defer fd.Close()
+
+		// Get file information
+		fileInfo, err3 := fd.Stat()
+		if err3 != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		// Set headers and serve the file
+		setContentDisposition(w, r, fileName)
+		w.Header().Set("Cache-Control", "private")
+
+		// Serve the content
+		http.ServeContent(w, r, fileName, fileInfo.ModTime(), fd)
+		return 0, nil
+	}
+
+	algo := r.URL.Query().Get("algo")
+	var extension string
+	switch algo {
+	case "zip", "true", "":
+		extension = ".zip"
+	case "tar.gz":
+		extension = ".tar.gz"
+	default:
+		return http.StatusInternalServerError, errors.New("format not implemented")
+	}
+
+	baseDirName := filepath.Base(filepath.Dir(realPath))
+	if baseDirName == "" || baseDirName == "/" {
+		baseDirName = "download"
+	}
+	downloadFileName := url.PathEscape(baseDirName + "." + algo)
+	w.Header().Set("Content-Disposition", "attachment; filename*=utf-8''"+downloadFileName)
+	// Create the archive and stream it directly to the response
+	if extension == ".zip" {
+		err = createZip(w, d, fileList...)
+	} else {
+		err = createTarGz(w, d, fileList...)
+	}
+
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	return 0, nil
+}
+
+func createZip(w io.Writer, d *requestContext, filenames ...string) error {
+	zipWriter := zip.NewWriter(w)
+	defer zipWriter.Close()
+
+	for _, fname := range filenames {
+		err := addFile(fname, d, nil, zipWriter)
+		if err != nil {
+			log.Printf("Failed to add %s to ZIP: %v", fname, err)
 		}
 	}
 
 	return nil
 }
 
-func rawDirHandler(w http.ResponseWriter, r *http.Request, d *data, file *files.FileInfo) (int, error) {
-	filenames, err := parseQueryFiles(r, file, d.user)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
+func createTarGz(w io.Writer, d *requestContext, filenames ...string) error {
+	gzWriter := gzip.NewWriter(w)
+	defer gzWriter.Close()
 
-	extension, ar, err := parseQueryAlgorithm(r)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-
-	err = ar.Create(w)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-	defer ar.Close()
-
-	commonDir := fileutils.CommonPrefix(filepath.Separator, filenames...)
-
-	name := filepath.Base(commonDir)
-	if name == "." || name == "" || name == string(filepath.Separator) {
-		name = file.Name
-	}
-	// Prefix used to distinguish a filelist generated
-	// archive from the full directory archive
-	if len(filenames) > 1 {
-		name = "_" + name
-	}
-	name += extension
-	w.Header().Set("Content-Disposition", "attachment; filename*=utf-8''"+url.PathEscape(name))
+	tarWriter := tar.NewWriter(gzWriter)
+	defer tarWriter.Close()
 
 	for _, fname := range filenames {
-		err = addFile(ar, d, fname, commonDir)
+		err := addFile(fname, d, tarWriter, nil)
 		if err != nil {
-			log.Printf("Failed to archive %s: %v", fname, err)
+			log.Printf("Failed to add %s to TAR.GZ: %v", fname, err)
 		}
 	}
 
-	return 0, nil
-}
-
-func rawFileHandler(w http.ResponseWriter, r *http.Request, file *files.FileInfo) (int, error) {
-	fd, err := os.Open(file.Path)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-	defer fd.Close()
-
-	setContentDisposition(w, r, file)
-
-	w.Header().Set("Cache-Control", "private")
-	http.ServeContent(w, r, file.Name, file.ModTime, fd)
-	return 0, nil
+	return nil
 }

backend/http/resource.go

@@ -8,138 +8,90 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/shirou/gopsutil/v3/disk"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/fileutils"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
-var resourceGetHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
+// resourceGetHandler retrieves information about a resource.
+// @Summary Get resource information
+// @Description Returns metadata and optionally file contents for a specified resource path.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param path query string true "Path to the resource"
+// @Param source query string false "Name for the desired source, default is used if not provided"
+// @Param content query string false "Include file content if true"
+// @Param checksum query string false "Optional checksum validation"
+// @Success 200 {object} files.FileInfo "Resource metadata"
+// @Failure 404 {object} map[string]string "Resource not found"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/resources [get]
+func resourceGetHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// TODO source := r.URL.Query().Get("source")
+	encodedPath := r.URL.Query().Get("path")
+	// Decode the URL-encoded path
+	path, err := url.QueryUnescape(encodedPath)
 	if err != nil {
-		return http.StatusNotFound, err
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
 	}
-	file, err := files.FileInfoFaster(files.FileOptions{
-		Path:       realPath,
-		IsDir:      isDir,
+	fileInfo, err := files.FileInfoFaster(files.FileOptions{
+		Path:       filepath.Join(d.user.Scope, path),
 		Modify:     d.user.Perm.Modify,
 		Expand:     true,
-		ReadHeader: d.server.TypeDetectionByHeader,
-		Checker:    d,
+		ReadHeader: config.Server.TypeDetectionByHeader,
+		Checker:    d.user,
 		Content:    r.URL.Query().Get("content") == "true",
 	})
 	if err != nil {
 		return errToStatus(err), err
 	}
-	if !file.IsDir {
-		if checksum := r.URL.Query().Get("checksum"); checksum != "" {
-			err := file.Checksum(checksum)
-			if err == errors.ErrInvalidOption {
-				return http.StatusBadRequest, nil
-			} else if err != nil {
-				return http.StatusInternalServerError, err
-			}
-		}
+	if fileInfo.Type == "directory" {
+		return renderJSON(w, r, fileInfo)
 	}
-	return renderJSON(w, r, file)
-})
+	if algo := r.URL.Query().Get("checksum"); algo != "" {
+		checksums, err := files.GetChecksum(fileInfo.Path, algo)
+		if err == errors.ErrInvalidOption {
+			return http.StatusBadRequest, nil
+		} else if err != nil {
+			return http.StatusInternalServerError, err
+		}
+		fileInfo.Checksums = checksums
+	}
+	return renderJSON(w, r, fileInfo)
 
-func resourceDeleteHandler(fileCache FileCache) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if r.URL.Path == "/" || !d.user.Perm.Delete {
-			return http.StatusForbidden, nil
-		}
-		realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
-		if err != nil {
-			return http.StatusNotFound, err
-		}
-		fileOpts := files.FileOptions{
-			Path:       realPath,
-			IsDir:      isDir,
-			Modify:     d.user.Perm.Modify,
-			Expand:     false,
-			ReadHeader: d.server.TypeDetectionByHeader,
-			Checker:    d,
-		}
-		file, err := files.FileInfoFaster(fileOpts)
-		if err != nil {
-			return errToStatus(err), err
-		}
-
-		// delete thumbnails
-		err = delThumbs(r.Context(), fileCache, file)
-		if err != nil {
-			return errToStatus(err), err
-		}
-
-		err = files.DeleteFiles(realPath, fileOpts)
-		if err != nil {
-			return errToStatus(err), err
-		}
-		return http.StatusOK, nil
-	})
 }
 
-func resourcePostHandler(fileCache FileCache) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if !d.user.Perm.Create || !d.Check(r.URL.Path) {
-			return http.StatusForbidden, nil
-		}
-		realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
-		if err != nil {
-			return http.StatusNotFound, err
-		}
-		fileOpts := files.FileOptions{
-			Path:       realPath,
-			IsDir:      isDir,
-			Modify:     d.user.Perm.Modify,
-			Expand:     false,
-			ReadHeader: d.server.TypeDetectionByHeader,
-			Checker:    d,
-		}
-		// Directories creation on POST.
-		if strings.HasSuffix(r.URL.Path, "/") {
-			err = files.WriteDirectory(fileOpts) // Assign to the existing `err` variable
-			if err != nil {
-				return errToStatus(err), err
-			}
-			return http.StatusOK, nil
-		}
-		file, err := files.FileInfoFaster(fileOpts)
-		if err == nil {
-			if r.URL.Query().Get("override") != "true" {
-				return http.StatusConflict, nil
-			}
-
-			// Permission for overwriting the file
-			if !d.user.Perm.Modify {
-				return http.StatusForbidden, nil
-			}
-
-			err = delThumbs(r.Context(), fileCache, file)
-			if err != nil {
-				return errToStatus(err), err
-			}
-		}
-		err = files.WriteFile(fileOpts, r.Body)
-		return errToStatus(err), err
-	})
-}
-
-var resourcePutHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	if !d.user.Perm.Modify || !d.Check(r.URL.Path) {
+// resourceDeleteHandler deletes a resource at a specified path.
+// @Summary Delete a resource
+// @Description Deletes a resource located at the specified path.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param path query string true "Path to the resource"
+// @Param source query string false "Name for the desired source, default is used if not provided"
+// @Success 200 "Resource deleted successfully"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 404 {object} map[string]string "Resource not found"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/resources [delete]
+func resourceDeleteHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// TODO source := r.URL.Query().Get("source")
+	encodedPath := r.URL.Query().Get("path")
+	// Decode the URL-encoded path
+	path, err := url.QueryUnescape(encodedPath)
+	if err != nil {
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
+	}
+	if path == "/" || !d.user.Perm.Delete {
 		return http.StatusForbidden, nil
 	}
-
-	// Only allow PUT for files.
-	if strings.HasSuffix(r.URL.Path, "/") {
-		return http.StatusMethodNotAllowed, nil
-	}
-
-	realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
+	realPath, isDir, err := files.GetRealPath(d.user.Scope, path)
 	if err != nil {
 		return http.StatusNotFound, err
 	}
@@ -148,49 +100,202 @@ var resourcePutHandler = withUser(func(w http.ResponseWriter, r *http.Request, d
 		IsDir:      isDir,
 		Modify:     d.user.Perm.Modify,
 		Expand:     false,
-		ReadHeader: d.server.TypeDetectionByHeader,
-		Checker:    d,
+		ReadHeader: config.Server.TypeDetectionByHeader,
+		Checker:    d.user,
+	}
+	fileInfo, err := files.FileInfoFaster(fileOpts)
+	if err != nil {
+		return errToStatus(err), err
 	}
-	err = files.WriteFile(fileOpts, r.Body)
-	return errToStatus(err), err
-})
 
-// TODO fix and verify this function still works in tests
-func resourcePatchHandler(fileCache FileCache) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		src := r.URL.Path
-		dst := r.URL.Query().Get("destination")
-		action := r.URL.Query().Get("action")
-		dst, err := url.QueryUnescape(dst)
-		if !d.Check(src) || !d.Check(dst) {
-			return http.StatusForbidden, nil
-		}
+	// delete thumbnails
+	err = delThumbs(r.Context(), fileCache, fileInfo.FileInfo)
+	if err != nil {
+		return errToStatus(err), err
+	}
+
+	err = files.DeleteFiles(realPath, fileOpts)
+	if err != nil {
+		return errToStatus(err), err
+	}
+	return http.StatusOK, nil
+
+}
+
+// resourcePostHandler creates or uploads a new resource.
+// @Summary Create or upload a resource
+// @Description Creates a new resource or uploads a file at the specified path. Supports file uploads and directory creation.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param path query string true "Path to the resource"
+// @Param source query string false "Name for the desired source, default is used if not provided"
+// @Param override query bool false "Override existing file if true"
+// @Success 200 "Resource created successfully"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 404 {object} map[string]string "Resource not found"
+// @Failure 409 {object} map[string]string "Conflict - Resource already exists"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/resources [post]
+func resourcePostHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// TODO source := r.URL.Query().Get("source")
+	encodedPath := r.URL.Query().Get("path")
+	// Decode the URL-encoded path
+	path, err := url.QueryUnescape(encodedPath)
+	if err != nil {
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
+	}
+	if !d.user.Perm.Create || !d.user.Check(path) {
+		return http.StatusForbidden, nil
+	}
+	fileOpts := files.FileOptions{
+		Path:    filepath.Join(d.user.Scope, path),
+		Modify:  d.user.Perm.Modify,
+		Expand:  false,
+		Checker: d.user,
+	}
+	// Directories creation on POST.
+	if strings.HasSuffix(path, "/") {
+		err = files.WriteDirectory(fileOpts)
 		if err != nil {
 			return errToStatus(err), err
 		}
-		if dst == "/" || src == "/" {
-			return http.StatusForbidden, nil
+		return http.StatusOK, nil
+	}
+	fileInfo, err := files.FileInfoFaster(fileOpts)
+	if err == nil {
+		if r.URL.Query().Get("override") != "true" {
+			return http.StatusConflict, nil
 		}
-		override := r.URL.Query().Get("override") == "true"
-		rename := r.URL.Query().Get("rename") == "true"
-		if !override && !rename {
-			if _, err = os.Stat(dst); err == nil {
-				return http.StatusConflict, nil
-			}
-		}
-		if rename {
-			dst = addVersionSuffix(dst)
-		}
-		// Permission for overwriting the file
-		if override && !d.user.Perm.Modify {
-			return http.StatusForbidden, nil
-		}
-		err = d.RunHook(func() error {
-			return patchAction(r.Context(), action, src, dst, d, fileCache)
-		}, action, src, dst, d.user)
 
+		// Permission for overwriting the file
+		if !d.user.Perm.Modify {
+			return http.StatusForbidden, nil
+		}
+
+		err = delThumbs(r.Context(), fileCache, fileInfo.FileInfo)
+		if err != nil {
+			return errToStatus(err), err
+		}
+	}
+	err = files.WriteFile(fileOpts, r.Body)
+	if err != nil {
 		return errToStatus(err), err
-	})
+
+	}
+	return http.StatusOK, nil
+}
+
+// resourcePutHandler updates an existing file resource.
+// @Summary Update a file resource
+// @Description Updates an existing file at the specified path.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param path query string true "Path to the resource"
+// @Param source query string false "Name for the desired source, default is used if not provided"
+// @Success 200 "Resource updated successfully"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 404 {object} map[string]string "Resource not found"
+// @Failure 405 {object} map[string]string "Method not allowed"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/resources [put]
+func resourcePutHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// TODO source := r.URL.Query().Get("source")
+	// TODO source := r.URL.Query().Get("source")
+	encodedPath := r.URL.Query().Get("path")
+	// Decode the URL-encoded path
+	path, err := url.QueryUnescape(encodedPath)
+	if err != nil {
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
+	}
+	if !d.user.Perm.Modify || !d.user.Check(path) {
+		return http.StatusForbidden, nil
+	}
+
+	// Only allow PUT for files.
+	if strings.HasSuffix(path, "/") {
+		return http.StatusMethodNotAllowed, nil
+	}
+
+	realPath, isDir, err := files.GetRealPath(d.user.Scope, path)
+	if err != nil {
+		return http.StatusNotFound, err
+	}
+	fileOpts := files.FileOptions{
+		Path:       realPath,
+		IsDir:      isDir,
+		Modify:     d.user.Perm.Modify,
+		Expand:     false,
+		ReadHeader: config.Server.TypeDetectionByHeader,
+		Checker:    d.user,
+	}
+	err = files.WriteFile(fileOpts, r.Body)
+	return errToStatus(err), err
+}
+
+// resourcePatchHandler performs a patch operation (e.g., move, rename) on a resource.
+// @Summary Patch resource (move/rename)
+// @Description Moves or renames a resource to a new destination.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param from query string true "Path from resource"
+// @Param destination query string true "Destination path for the resource"
+// @Param action query string true "Action to perform (copy, rename)"
+// @Param overwrite query bool false "Overwrite if destination exists"
+// @Param rename query bool false "Rename if destination exists"
+// @Success 200 "Resource moved/renamed successfully"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 404 {object} map[string]string "Resource not found"
+// @Failure 409 {object} map[string]string "Conflict - Destination exists"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/resources [patch]
+func resourcePatchHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	// TODO source := r.URL.Query().Get("source")
+	action := r.URL.Query().Get("action")
+	encodedFrom := r.URL.Query().Get("from")
+	// Decode the URL-encoded path
+	src, err := url.QueryUnescape(encodedFrom)
+	if err != nil {
+		return http.StatusBadRequest, fmt.Errorf("invalid path encoding: %v", err)
+	}
+	dst := r.URL.Query().Get("destination")
+	dst, err = url.QueryUnescape(dst)
+	if err != nil {
+		return errToStatus(err), err
+	}
+	if !d.user.Check(src) || !d.user.Check(dst) {
+		return http.StatusForbidden, nil
+	}
+	if dst == "/" || src == "/" {
+		return http.StatusForbidden, nil
+	}
+
+	// check target dir exists
+	parentDir, _, err := files.GetRealPath(d.user.Scope, filepath.Dir(dst))
+	if err != nil {
+		return http.StatusNotFound, err
+	}
+	realDest := parentDir + "/" + filepath.Base(dst)
+	realSrc, isSrcDir, err := files.GetRealPath(d.user.Scope, src)
+	if err != nil {
+		return http.StatusNotFound, err
+	}
+	overwrite := r.URL.Query().Get("overwrite") == "true"
+	rename := r.URL.Query().Get("rename") == "true"
+	if rename {
+		realDest = addVersionSuffix(realDest)
+	}
+	// Permission for overwriting the file
+	if overwrite && !d.user.Perm.Modify {
+		return http.StatusForbidden, nil
+	}
+	err = d.RunHook(func() error {
+		return patchAction(r.Context(), action, realSrc, realDest, d, fileCache, isSrcDir)
+	}, action, realSrc, realDest, d.user)
+
+	return errToStatus(err), err
 }
 
 func addVersionSuffix(source string) string {
@@ -210,58 +315,43 @@ func addVersionSuffix(source string) string {
 }
 
 func delThumbs(ctx context.Context, fileCache FileCache, file *files.FileInfo) error {
-	for _, previewSizeName := range PreviewSizeNames() {
-		size, _ := ParsePreviewSize(previewSizeName)
-		if err := fileCache.Delete(ctx, previewCacheKey(file, size)); err != nil {
-			return err
-		}
+	if err := fileCache.Delete(ctx, previewCacheKey(file, "small")); err != nil {
+		return err
 	}
-
 	return nil
 }
 
-func patchAction(ctx context.Context, action, src, dst string, d *data, fileCache FileCache) error {
+func patchAction(ctx context.Context, action, src, dst string, d *requestContext, fileCache FileCache, isSrcDir bool) error {
 	switch action {
-	// TODO: use enum
 	case "copy":
 		if !d.user.Perm.Create {
 			return errors.ErrPermissionDenied
 		}
+		err := files.CopyResource(src, dst, isSrcDir)
+		return err
+	case "rename", "move":
 
-		return fileutils.Copy(src, dst)
-	case "rename":
 		if !d.user.Perm.Rename {
 			return errors.ErrPermissionDenied
 		}
-		src = path.Clean("/" + src)
-		dst = path.Clean("/" + dst)
-		realDest, _, err := files.GetRealPath(d.user.Scope, dst)
-		if err != nil {
-			return err
-		}
-		realSrc, isDir, err := files.GetRealPath(d.user.Scope, src)
-		if err != nil {
-			return err
-		}
-		file, err := files.FileInfoFaster(files.FileOptions{
-			Path:       realSrc,
-			IsDir:      isDir,
+		fileInfo, err := files.FileInfoFaster(files.FileOptions{
+			Path:       src,
+			IsDir:      isSrcDir,
 			Modify:     d.user.Perm.Modify,
 			Expand:     false,
 			ReadHeader: false,
-			Checker:    d,
+			Checker:    d.user,
 		})
 		if err != nil {
 			return err
 		}
 
 		// delete thumbnails
-		err = delThumbs(ctx, fileCache, file)
+		err = delThumbs(ctx, fileCache, fileInfo.FileInfo)
 		if err != nil {
 			return err
 		}
-
-		return fileutils.MoveFile(realSrc, realDest)
+		return files.MoveResource(src, dst, isSrcDir)
 	default:
 		return fmt.Errorf("unsupported action %s: %w", action, errors.ErrInvalidRequestParams)
 	}
@@ -272,35 +362,65 @@ type DiskUsageResponse struct {
 	Used  uint64 `json:"used"`
 }
 
-var diskUsage = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	realPath, isDir, err := files.GetRealPath(d.user.Scope, r.URL.Path)
-	if err != nil {
-		return http.StatusNotFound, err
+// diskUsage returns the disk usage information for a given directory.
+// @Summary Get disk usage
+// @Description Returns the total and used disk space for a specified directory.
+// @Tags Resources
+// @Accept json
+// @Produce json
+// @Param source query string false "Name for the desired source, default is used if not provided"
+// @Success 200 {object} DiskUsageResponse "Disk usage details"
+// @Failure 404 {object} map[string]string "Directory not found"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/usage [get]
+func diskUsage(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	source := r.URL.Query().Get("source")
+	if source == "" {
+		source = "/"
 	}
-	file, err := files.FileInfoFaster(files.FileOptions{
-		Path:       realPath,
-		IsDir:      isDir,
-		Modify:     d.user.Perm.Modify,
-		Expand:     false,
-		ReadHeader: false,
-		Checker:    d,
-	})
+
+	value, ok := utils.DiskUsageCache.Get(source).(DiskUsageResponse)
+	if ok {
+		return renderJSON(w, r, &value)
+	}
+
+	fPath, isDir, err := files.GetRealPath(d.user.Scope, source)
 	if err != nil {
 		return errToStatus(err), err
 	}
-	fPath := file.RealPath()
-	if !file.IsDir {
-		return renderJSON(w, r, &DiskUsageResponse{
-			Total: 0,
-			Used:  0,
-		})
+	if !isDir {
+		return http.StatusNotFound, fmt.Errorf("not a directory: %s", source)
 	}
 	usage, err := disk.UsageWithContext(r.Context(), fPath)
 	if err != nil {
 		return errToStatus(err), err
 	}
-	return renderJSON(w, r, &DiskUsageResponse{
+	latestUsage := DiskUsageResponse{
 		Total: usage.Total,
 		Used:  usage.Used,
-	})
-})
+	}
+	utils.DiskUsageCache.Set(source, latestUsage)
+	return renderJSON(w, r, &latestUsage)
+}
+
+func inspectIndex(w http.ResponseWriter, r *http.Request) {
+	encodedPath := r.URL.Query().Get("path")
+	// Decode the URL-encoded path
+	path, _ := url.QueryUnescape(encodedPath)
+	isDir := r.URL.Query().Get("isDir") == "true"
+	index := files.GetIndex(config.Server.Root)
+	info, _ := index.GetReducedMetadata(path, isDir)
+	renderJSON(w, r, info) // nolint:errcheck
+}
+
+func mockData(w http.ResponseWriter, r *http.Request) {
+	d := r.URL.Query().Get("numDirs")
+	f := r.URL.Query().Get("numFiles")
+	NumDirs, err := strconv.Atoi(d)
+	numFiles, err2 := strconv.Atoi(f)
+	if err != nil || err2 != nil {
+		return
+	}
+	mockDir := files.CreateMockData(NumDirs, numFiles)
+	renderJSON(w, r, mockDir) // nolint:errcheck
+}

backend/http/router.go

@@ -0,0 +1,187 @@
+package http
+
+import (
+	"crypto/tls"
+	"embed"
+	"fmt"
+	"io/fs"
+	"log"
+	"net/http"
+	"os"
+	"text/template"
+
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/version"
+
+	httpSwagger "github.com/swaggo/http-swagger" // http-swagger middleware
+)
+
+// Embed the files in the frontend/dist directory
+//
+//go:embed embed/*
+var assets embed.FS
+
+// Boolean flag to determine whether to use the embedded FS or not
+var embeddedFS = os.Getenv("FILEBROWSER_NO_EMBEDED") != "true"
+
+// Custom dirFS to handle both embedded and non-embedded file systems
+type dirFS struct {
+	http.Dir
+}
+
+// Implement the Open method for dirFS, which wraps http.Dir
+func (d dirFS) Open(name string) (fs.File, error) {
+	return d.Dir.Open(name)
+}
+
+var (
+	store     *storage.Storage
+	config    *settings.Settings
+	fileCache FileCache
+	imgSvc    ImgService
+	assetFs   fs.FS
+)
+
+func StartHttp(Service ImgService, storage *storage.Storage, cache FileCache) {
+
+	store = storage
+	fileCache = cache
+	imgSvc = Service
+	config = &settings.Config
+
+	var err error
+
+	if embeddedFS {
+		// Embedded mode: Serve files from the embedded assets
+		assetFs, err = fs.Sub(assets, "embed")
+		if err != nil {
+			log.Fatal("Could not embed frontend. Does dist exist?")
+		}
+	} else {
+		assetFs = dirFS{Dir: http.Dir("http/dist")}
+	}
+
+	templateRenderer = &TemplateRenderer{
+		templates: template.Must(template.ParseFS(assetFs, "public/index.html")),
+	}
+
+	router := http.NewServeMux()
+	// API group routing
+	api := http.NewServeMux()
+
+	// User routes
+	api.HandleFunc("GET /users", withUser(userGetHandler))
+	api.HandleFunc("POST /users", withSelfOrAdmin(usersPostHandler))
+	api.HandleFunc("PUT /users", withUser(userPutHandler))
+	api.HandleFunc("DELETE /users", withSelfOrAdmin(userDeleteHandler))
+
+	// Auth routes
+	api.HandleFunc("POST /auth/login", loginHandler)
+	api.HandleFunc("GET /auth/signup", signupHandler)
+	api.HandleFunc("POST /auth/renew", withUser(renewHandler))
+	api.HandleFunc("PUT /auth/token", withUser(createApiKeyHandler))
+	api.HandleFunc("GET /auth/token", withUser(createApiKeyHandler))
+	api.HandleFunc("DELETE /auth/token", withUser(deleteApiKeyHandler))
+	api.HandleFunc("GET /auth/tokens", withUser(listApiKeysHandler))
+
+	// Resources routes
+	api.HandleFunc("GET /resources", withUser(resourceGetHandler))
+	api.HandleFunc("DELETE /resources", withUser(resourceDeleteHandler))
+	api.HandleFunc("POST /resources", withUser(resourcePostHandler))
+	api.HandleFunc("PUT /resources", withUser(resourcePutHandler))
+	api.HandleFunc("PATCH /resources", withUser(resourcePatchHandler))
+	api.HandleFunc("GET /usage", withUser(diskUsage))
+	api.HandleFunc("GET /raw", withUser(rawHandler))
+	api.HandleFunc("GET /preview", withUser(previewHandler))
+	if version.Version == "testing" || version.Version == "untracked" {
+		api.HandleFunc("GET /inspectIndex", inspectIndex)
+		api.HandleFunc("GET /mockData", mockData)
+	}
+
+	// Share routes
+	api.HandleFunc("GET /shares", withPermShare(shareListHandler))
+	api.HandleFunc("GET /share", withPermShare(shareGetsHandler))
+	api.HandleFunc("POST /share", withPermShare(sharePostHandler))
+	api.HandleFunc("DELETE /share", withPermShare(shareDeleteHandler))
+
+	// Public routes
+	api.HandleFunc("GET /public/publicUser", publicUserGetHandler)
+	api.HandleFunc("GET /public/dl", withHashFile(publicDlHandler))
+	api.HandleFunc("GET /public/share", withHashFile(publicShareHandler))
+
+	// Settings routes
+	api.HandleFunc("GET /settings", withAdmin(settingsGetHandler))
+	api.HandleFunc("PUT /settings", withAdmin(settingsPutHandler))
+
+	api.HandleFunc("GET /search", withUser(searchHandler))
+	apiPath := config.Server.BaseURL + "api"
+	router.Handle(apiPath+"/", http.StripPrefix(apiPath, api))
+
+	// Static and index file handlers
+	router.HandleFunc(fmt.Sprintf("GET %vstatic/", config.Server.BaseURL), staticFilesHandler)
+	router.HandleFunc(config.Server.BaseURL, indexHandler)
+
+	// health
+	router.HandleFunc(fmt.Sprintf("GET %vhealth", config.Server.BaseURL), healthHandler)
+
+	// Swagger
+	router.Handle(fmt.Sprintf("%vswagger/", config.Server.BaseURL),
+		httpSwagger.Handler(
+			httpSwagger.URL(config.Server.BaseURL+"swagger/doc.json"), //The url pointing to API definition
+			httpSwagger.DeepLinking(true),
+			httpSwagger.DocExpansion("none"),
+			httpSwagger.DomID("swagger-ui"),
+		),
+	)
+
+	var scheme string
+	port := ""
+
+	// Determine whether to use HTTPS (TLS) or HTTP
+	if config.Server.TLSCert != "" && config.Server.TLSKey != "" {
+		// Load the TLS certificate and key
+		cer, err := tls.LoadX509KeyPair(config.Server.TLSCert, config.Server.TLSKey)
+		if err != nil {
+			log.Fatalf("could not load certificate: %v", err)
+		}
+
+		// Create a custom TLS listener
+		tlsConfig := &tls.Config{
+			MinVersion:   tls.VersionTLS12,
+			Certificates: []tls.Certificate{cer},
+		}
+
+		// Set HTTPS scheme and default port for TLS
+		scheme = "https"
+
+		// Listen on TCP and wrap with TLS
+		listener, err := tls.Listen("tcp", fmt.Sprintf(":%v", config.Server.Port), tlsConfig)
+		if err != nil {
+			log.Fatalf("could not start TLS server: %v", err)
+		}
+		if config.Server.Port != 443 {
+			port = fmt.Sprintf(":%d", config.Server.Port)
+		}
+		// Build the full URL with host and port
+		fullURL := fmt.Sprintf("%s://localhost%s%s", scheme, port, config.Server.BaseURL)
+		log.Printf("Running at               : %s", fullURL)
+		err = http.Serve(listener, muxWithMiddleware(router))
+		if err != nil {
+			log.Fatalf("could not start server: %v", err)
+		}
+	} else {
+		// Set HTTP scheme and the default port for HTTP
+		scheme = "http"
+		if config.Server.Port != 80 {
+			port = fmt.Sprintf(":%d", config.Server.Port)
+		}
+		// Build the full URL with host and port
+		fullURL := fmt.Sprintf("%s://localhost%s%s", scheme, port, config.Server.BaseURL)
+		log.Printf("Running at               : %s", fullURL)
+		err := http.ListenAndServe(fmt.Sprintf(":%v", config.Server.Port), muxWithMiddleware(router))
+		if err != nil {
+			log.Fatalf("could not start server: %v", err)
+		}
+	}
+}

backend/http/search.go

@@ -4,33 +4,67 @@ import (
 	"net/http"
 	"strings"
 
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 )
 
-var searchHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	response := []map[string]interface{}{}
+// searchHandler handles search requests for files based on the provided query.
+//
+// This endpoint processes a search query, retrieves relevant file paths, and
+// returns a JSON response with the search results. The search is performed
+// against the file index, which is built from the root directory specified in
+// the server's configuration. The results are filtered based on the user's scope.
+//
+// The handler expects the following headers in the request:
+// - SessionId: A unique identifier for the user's session.
+// - UserScope: The scope of the user, which influences the search context.
+//
+// The request URL should include a query parameter named `query` that specifies
+// the search terms to use. The response will include an array of searchResponse objects
+// containing the path, type, and dir status.
+//
+// Example request:
+//
+//	GET api/search?query=myfile
+//
+// Example response:
+// [
+//
+//	{
+//	    "path": "/path/to/myfile.txt",
+//	    "type": "text"
+//	},
+//	{
+//	    "path": "/path/to/mydir/",
+//	    "type": "directory"
+//	}
+//
+// ]
+//
+// @Summary Search Files
+// @Description Searches for files matching the provided query. Returns file paths and metadata based on the user's session and scope.
+// @Tags Search
+// @Accept json
+// @Produce json
+// @Param query query string true "Search query"
+// @Param scope query string false "path within user scope to search, for example '/first/second' to search within the second directory only"
+// @Param SessionId header string false "User session ID, add unique value to prevent collisions"
+// @Success 200 {array} files.SearchResult "List of search results"
+// @Failure 400 {object} map[string]string "Bad Request"
+// @Router /api/search [get]
+func searchHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	query := r.URL.Query().Get("query")
+	searchScope := strings.TrimPrefix(r.URL.Query().Get("scope"), ".")
+	searchScope = strings.TrimPrefix(searchScope, "/")
 	// Retrieve the User-Agent and X-Auth headers from the request
 	sessionId := r.Header.Get("SessionId")
-	userScope := r.Header.Get("UserScope")
 	index := files.GetIndex(settings.Config.Server.Root)
-	combinedScope := strings.TrimPrefix(userScope+r.URL.Path, ".")
-	results, fileTypes := index.Search(query, combinedScope, sessionId)
-	for _, path := range results {
-		responseObj := map[string]interface{}{
-			"path": path,
-			"dir":  true,
-		}
-		if _, ok := fileTypes[path]; ok {
-			responseObj["dir"] = false
-			for filterType, value := range fileTypes[path] {
-				if value {
-					responseObj[filterType] = value
-				}
-			}
-		}
-		response = append(response, responseObj)
-	}
+	userScope := strings.TrimPrefix(d.user.Scope, ".")
+	combinedScope := strings.TrimPrefix(userScope+"/"+searchScope, "/")
+
+	// Perform the search using the provided query and user scope
+	response := index.Search(query, combinedScope, sessionId)
+	// Set the Content-Type header to application/json
+	w.Header().Set("Content-Type", "application/json")
 	return renderJSON(w, r, response)
-})
+}

backend/http/settings.go

@@ -4,8 +4,8 @@ import (
 	"encoding/json"
 	"net/http"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 type settingsData struct {
@@ -13,37 +13,56 @@ type settingsData struct {
 	CreateUserDir    bool                  `json:"createUserDir"`
 	UserHomeBasePath string                `json:"userHomeBasePath"`
 	Defaults         settings.UserDefaults `json:"defaults"`
-	Rules            []rules.Rule          `json:"rules"`
+	Rules            []users.Rule          `json:"rules"`
 	Frontend         settings.Frontend     `json:"frontend"`
 	Commands         map[string][]string   `json:"commands"`
 }
 
-var settingsGetHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+// settingsGetHandler retrieves the current system settings.
+// @Summary Get system settings
+// @Description Returns the current configuration settings for signup, user directories, rules, frontend, and commands.
+// @Tags Settings
+// @Accept json
+// @Produce json
+// @Success 200 {object} settingsData "System settings data"
+// @Router /api/settings [get]
+func settingsGetHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	data := &settingsData{
-		Signup:           d.settings.Auth.Signup,
-		CreateUserDir:    d.settings.Server.CreateUserDir,
-		UserHomeBasePath: d.settings.Server.UserHomeBasePath,
-		Defaults:         d.settings.UserDefaults,
-		Rules:            d.settings.Rules,
-		Frontend:         d.settings.Frontend,
+		Signup:           config.Auth.Signup,
+		CreateUserDir:    config.Server.CreateUserDir,
+		UserHomeBasePath: config.Server.UserHomeBasePath,
+		Defaults:         config.UserDefaults,
+		Rules:            config.Rules,
+		Frontend:         config.Frontend,
 	}
 
 	return renderJSON(w, r, data)
-})
+}
 
-var settingsPutHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+// settingsPutHandler updates the system settings.
+// @Summary Update system settings
+// @Description Updates the system configuration settings for signup, user directories, rules, frontend, and commands.
+// @Tags Settings
+// @Accept json
+// @Produce json
+// @Param body body settingsData true "Settings data to update"
+// @Success 200 "Settings updated successfully"
+// @Failure 400 {object} map[string]string "Bad request - failed to decode body"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/settings [put]
+func settingsPutHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	req := &settingsData{}
 	err := json.NewDecoder(r.Body).Decode(req)
 	if err != nil {
 		return http.StatusBadRequest, err
 	}
 
-	d.settings.Server.CreateUserDir = req.CreateUserDir
-	d.settings.Server.UserHomeBasePath = req.UserHomeBasePath
-	d.settings.UserDefaults = req.Defaults
-	d.settings.Rules = req.Rules
-	d.settings.Frontend = req.Frontend
-	d.settings.Auth.Signup = req.Signup
-	err = d.store.Settings.Save(d.settings)
+	config.Server.CreateUserDir = req.CreateUserDir
+	config.Server.UserHomeBasePath = req.UserHomeBasePath
+	config.UserDefaults = req.Defaults
+	config.Rules = req.Rules
+	config.Frontend = req.Frontend
+	config.Auth.Signup = req.Signup
+	err = store.Settings.Save(config)
 	return errToStatus(err), err
-})
+}

backend/http/share.go

@@ -8,33 +8,32 @@ import (
 	"net/http"
 	"sort"
 	"strconv"
-	"strings"
 	"time"
 
 	"golang.org/x/crypto/bcrypt"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/share"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
 )
 
-func withPermShare(fn handleFunc) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if !d.user.Perm.Share {
-			return http.StatusForbidden, nil
-		}
-		return fn(w, r, d)
-	})
-}
-
-var shareListHandler = withPermShare(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+// shareListHandler returns a list of all share links.
+// @Summary List share links
+// @Description Returns a list of share links for the current user, or all links if the user is an admin.
+// @Tags Shares
+// @Accept json
+// @Produce json
+// @Success 200 {array} share.Link "List of share links"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/shares [get]
+func shareListHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	var (
 		s   []*share.Link
 		err error
 	)
 	if d.user.Perm.Admin {
-		s, err = d.store.Share.All()
+		s, err = store.Share.All()
 	} else {
-		s, err = d.store.Share.FindByUserID(d.user.ID)
+		s, err = store.Share.FindByUserID(d.user.ID)
 	}
 	if err == errors.ErrNotExist {
 		return renderJSON(w, r, []*share.Link{})
@@ -51,39 +50,68 @@ var shareListHandler = withPermShare(func(w http.ResponseWriter, r *http.Request
 		return s[i].Expire < s[j].Expire
 	})
 	return renderJSON(w, r, s)
-})
+}
 
-var shareGetsHandler = withPermShare(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	s, err := d.store.Share.Gets(r.URL.Path, d.user.ID)
+// shareGetsHandler retrieves share links for a specific resource path.
+// @Summary Get share links by path
+// @Description Retrieves all share links associated with a specific resource path for the current user.
+// @Tags Shares
+// @Accept json
+// @Produce json
+// @Param path query string true "Resource path for which to retrieve share links"
+// @Success 200 {array} share.Link "List of share links for the specified path"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/share [get]
+func shareGetsHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	path := r.URL.Query().Get("path")
+	s, err := store.Share.Gets(path, d.user.ID)
 	if err == errors.ErrNotExist {
 		return renderJSON(w, r, []*share.Link{})
 	}
-
 	if err != nil {
-		return http.StatusInternalServerError, err
+		return http.StatusInternalServerError, fmt.Errorf("error getting share info from server")
 	}
-
 	return renderJSON(w, r, s)
-})
+}
 
-var shareDeleteHandler = withPermShare(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	hash := strings.TrimSuffix(r.URL.Path, "/")
-	hash = strings.TrimPrefix(hash, "/")
+// shareDeleteHandler deletes a specific share link by its hash.
+// @Summary Delete a share link
+// @Description Deletes a share link specified by its hash.
+// @Tags Shares
+// @Accept json
+// @Produce json
+// @Param hash path string true "Hash of the share link to delete"
+// @Success 200 "Share link deleted successfully"
+// @Failure 400 {object} map[string]string "Bad request - missing or invalid hash"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/shares/{hash} [delete]
+func shareDeleteHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	hash := r.URL.Query().Get("hash")
 
 	if hash == "" {
 		return http.StatusBadRequest, nil
 	}
 
-	err := d.store.Share.Delete(hash)
+	err := store.Share.Delete(hash)
 	if err != nil {
 		return errToStatus(err), err
 	}
 
 	return errToStatus(err), err
-})
-
-var sharePostHandler = withPermShare(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
+}
 
+// sharePostHandler creates a new share link.
+// @Summary Create a share link
+// @Description Creates a new share link with an optional expiration time and password protection.
+// @Tags Shares
+// @Accept json
+// @Produce json
+// @Param body body share.CreateBody true "Share link creation parameters"
+// @Success 200 {object} share.Link "Created share link"
+// @Failure 400 {object} map[string]string "Bad request - failed to decode body"
+// @Failure 500 {object} map[string]string "Internal server error"
+// @Router /api/shares [post]
+func sharePostHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
 	var s *share.Link
 	var body share.CreateBody
 	if r.Body != nil {
@@ -93,14 +121,11 @@ var sharePostHandler = withPermShare(func(w http.ResponseWriter, r *http.Request
 		defer r.Body.Close()
 	}
 
-	bytes := make([]byte, 6) //nolint:gomnd
-	_, err := rand.Read(bytes)
+	secure_hash, err := generateShortUUID()
 	if err != nil {
 		return http.StatusInternalServerError, err
 	}
 
-	str := base64.URLEncoding.EncodeToString(bytes)
-
 	var expire int64 = 0
 
 	if body.Expires != "" {
@@ -139,32 +164,47 @@ var sharePostHandler = withPermShare(func(w http.ResponseWriter, r *http.Request
 		token = base64.URLEncoding.EncodeToString(tokenBuffer)
 		stringHash = string(hash)
 	}
+	path := r.URL.Query().Get("path")
 	s = &share.Link{
-		Path:         strings.TrimSuffix(r.URL.Path, "/"),
-		Hash:         str,
+		Path:         path,
+		Hash:         secure_hash,
 		Expire:       expire,
 		UserID:       d.user.ID,
 		PasswordHash: stringHash,
 		Token:        token,
 	}
 
-	if err := d.store.Share.Save(s); err != nil {
+	if err := store.Share.Save(s); err != nil {
 		return http.StatusInternalServerError, err
 	}
 
 	return renderJSON(w, r, s)
-})
+}
 
 func getSharePasswordHash(body share.CreateBody) (data []byte, statuscode int, err error) {
-
 	if body.Password == "" {
 		return nil, 0, nil
 	}
 
 	hash, err := bcrypt.GenerateFromPassword([]byte(body.Password), bcrypt.DefaultCost)
 	if err != nil {
-		return nil, http.StatusInternalServerError, fmt.Errorf("failed to hash password: %w", err)
+		return nil, http.StatusInternalServerError, fmt.Errorf("failed to hash password")
 	}
 
 	return hash, 0, nil
 }
+
+func generateShortUUID() (string, error) {
+	// Generate 16 random bytes (128 bits of entropy)
+	bytes := make([]byte, 16)
+	_, err := rand.Read(bytes)
+	if err != nil {
+		return "", err
+	}
+
+	// Encode the bytes to a URL-safe base64 string
+	uuid := base64.RawURLEncoding.EncodeToString(bytes)
+
+	// Trim the length to 22 characters for a shorter ID
+	return uuid[:22], nil
+}

backend/http/static.go

@@ -7,48 +7,65 @@ import (
 	"log"
 	"net/http"
 	"os"
-	"path"
 	"path/filepath"
 	"strings"
 	"text/template"
 
-	"github.com/gtsteffaniak/filebrowser/auth"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/version"
+	"github.com/gtsteffaniak/filebrowser/backend/auth"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/version"
 )
 
-func handleWithStaticData(w http.ResponseWriter, _ *http.Request, d *data, fSys fs.FS, file, contentType string) (int, error) {
+var templateRenderer *TemplateRenderer
+
+type TemplateRenderer struct {
+	templates *template.Template
+}
+
+// Render renders a template document with headers and data
+func (t *TemplateRenderer) Render(w http.ResponseWriter, name string, data interface{}) error {
+	// Set headers
+	w.Header().Set("Cache-Control", "no-cache, private, max-age=0")
+	w.Header().Set("Pragma", "no-cache")
+	w.Header().Set("X-Accel-Expires", "0")
+	w.Header().Set("Transfer-Encoding", "identity")
+	// Execute the template with the provided data
+	return t.templates.ExecuteTemplate(w, name, data)
+}
+
+func handleWithStaticData(w http.ResponseWriter, r *http.Request, file, contentType string) {
 	w.Header().Set("Content-Type", contentType)
 
-	auther, err := d.store.Auth.Get(d.settings.Auth.Method)
+	auther, err := store.Auth.Get(config.Auth.Method)
 	if err != nil {
-		return http.StatusInternalServerError, err
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
 	}
 
 	data := map[string]interface{}{
-		"Name":                  d.settings.Frontend.Name,
-		"DisableExternal":       d.settings.Frontend.DisableExternal,
-		"DisableUsedPercentage": d.settings.Frontend.DisableUsedPercentage,
+		"Name":                  config.Frontend.Name,
+		"DisableExternal":       config.Frontend.DisableExternal,
+		"DisableUsedPercentage": config.Frontend.DisableUsedPercentage,
 		"darkMode":              settings.Config.UserDefaults.DarkMode,
-		"Color":                 d.settings.Frontend.Color,
-		"BaseURL":               d.server.BaseURL,
+		"Color":                 config.Frontend.Color,
+		"BaseURL":               config.Server.BaseURL,
 		"Version":               version.Version,
 		"CommitSHA":             version.CommitSHA,
-		"StaticURL":             path.Join(d.server.BaseURL, "/static"),
+		"StaticURL":             config.Server.BaseURL + "static",
 		"Signup":                settings.Config.Auth.Signup,
-		"NoAuth":                d.settings.Auth.Method == "noauth",
-		"AuthMethod":            d.settings.Auth.Method,
+		"NoAuth":                config.Auth.Method == "noauth",
+		"AuthMethod":            config.Auth.Method,
 		"LoginPage":             auther.LoginPage(),
 		"CSS":                   false,
 		"ReCaptcha":             false,
-		"EnableThumbs":          d.server.EnableThumbnails,
-		"ResizePreview":         d.server.ResizePreview,
-		"EnableExec":            d.server.EnableExec,
+		"EnableThumbs":          config.Server.EnableThumbnails,
+		"ResizePreview":         config.Server.ResizePreview,
+		"EnableExec":            config.Server.EnableExec,
+		"ReCaptchaHost":         config.Auth.Recaptcha.Host,
 	}
 
-	if d.settings.Frontend.Files != "" {
-		fPath := filepath.Join(d.settings.Frontend.Files, "custom.css")
+	if config.Frontend.Files != "" {
+		fPath := filepath.Join(config.Frontend.Files, "custom.css")
 		_, err := os.Stat(fPath) //nolint:govet
 
 		if err != nil && !os.IsNotExist(err) {
@@ -60,15 +77,17 @@ func handleWithStaticData(w http.ResponseWriter, _ *http.Request, d *data, fSys
 		}
 	}
 
-	if d.settings.Auth.Method == "password" {
-		raw, err := d.store.Auth.Get(d.settings.Auth.Method) //nolint:govet
+	if config.Auth.Method == "password" {
+		raw, err := store.Auth.Get(config.Auth.Method) //nolint:govet
 		if err != nil {
-			return http.StatusInternalServerError, err
+			http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+			return
 		}
 
 		auther, ok := raw.(*auth.JSONAuth)
 		if !ok {
-			return http.StatusInternalServerError, fmt.Errorf("failed to assert type *auth.JSONAuth")
+			http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+			return
 		}
 
 		if auther.ReCaptcha != nil {
@@ -80,77 +99,47 @@ func handleWithStaticData(w http.ResponseWriter, _ *http.Request, d *data, fSys
 
 	b, err := json.Marshal(data)
 	if err != nil {
-		return http.StatusInternalServerError, err
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
 	}
 
-	data["Json"] = strings.ReplaceAll(string(b), `'`, `\'`)
+	data["globalVars"] = strings.ReplaceAll(string(b), `'`, `\'`)
 
-	fileContents, err := fs.ReadFile(fSys, file)
-	if err != nil {
-		if err == os.ErrNotExist {
-			return http.StatusNotFound, err
-		}
-		return http.StatusInternalServerError, err
+	// Render the template with global variables
+	if err := templateRenderer.Render(w, file, data); err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}
-	index := template.Must(template.New("index").Delims("[{[", "]}]").Parse(string(fileContents)))
-	err = index.Execute(w, data)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-
-	return 0, nil
 }
 
-func getStaticHandlers(store *storage.Storage, server *settings.Server, assetsFs fs.FS) (index, static http.Handler) {
-	index = handle(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if r.Method != http.MethodGet {
-			return http.StatusNotFound, nil
-		}
-
-		w.Header().Set("x-xss-protection", "1; mode=block")
-		return handleWithStaticData(w, r, d, assetsFs, "public/index.html", "text/html; charset=utf-8")
-	}, "", store, server)
-
-	static = handle(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		if r.Method != http.MethodGet {
-			return http.StatusNotFound, nil
-		}
-
-		const maxAge = 86400 // 1 day
-		w.Header().Set("Cache-Control", fmt.Sprintf("public, max-age=%v", maxAge))
-
-		if d.settings.Frontend.Files != "" {
-			if strings.HasPrefix(r.URL.Path, "img/") {
-				fPath := filepath.Join(d.settings.Frontend.Files, r.URL.Path)
-				if _, err := os.Stat(fPath); err == nil {
-					http.ServeFile(w, r, fPath)
-					return 0, nil
-				}
-			} else if r.URL.Path == "custom.css" && d.settings.Frontend.Files != "" {
-				http.ServeFile(w, r, filepath.Join(d.settings.Frontend.Files, "custom.css"))
-				return 0, nil
-			}
-		}
-
-		if !strings.HasSuffix(r.URL.Path, ".js") {
-			http.FileServer(http.FS(assetsFs)).ServeHTTP(w, r)
-			return 0, nil
-		}
-
-		fileContents, err := fs.ReadFile(assetsFs, r.URL.Path+".gz")
-		if err != nil {
-			return http.StatusNotFound, err
-		}
-
-		w.Header().Set("Content-Encoding", "gzip")
+func staticFilesHandler(w http.ResponseWriter, r *http.Request) {
+	const maxAge = 86400 // 1 day
+	w.Header().Set("Cache-Control", fmt.Sprintf("public, max-age=%v", maxAge))
+	w.Header().Set("Content-Security-Policy", `default-src 'self'; style-src 'unsafe-inline';`)
+	// Remove "/static/" from the request path
+	adjustedPath := strings.TrimPrefix(r.URL.Path, fmt.Sprintf("%vstatic/", config.Server.BaseURL))
+	adjustedCompressed := adjustedPath + ".gz"
+	if strings.HasSuffix(adjustedPath, ".js") {
 		w.Header().Set("Content-Type", "application/javascript; charset=utf-8") // Set the correct MIME type for JavaScript files
-
-		if _, err := w.Write(fileContents); err != nil {
-			return http.StatusInternalServerError, err
+	}
+	// Check if the gzipped version of the file exists
+	fileContents, err := fs.ReadFile(assetFs, adjustedCompressed)
+	if err == nil {
+		w.Header().Set("Content-Encoding", "gzip") // Let the browser know the file is compressed
+		status, err := w.Write(fileContents)       // Write the gzipped file content to the response
+		if err != nil {
+			http.Error(w, http.StatusText(status), status)
 		}
-
-		return 0, nil
-	}, "/static/", store, server)
-
-	return index, static
+	} else {
+		// Otherwise, serve the regular file
+		http.StripPrefix(fmt.Sprintf("%vstatic/", config.Server.BaseURL), http.FileServer(http.FS(assetFs))).ServeHTTP(w, r)
+	}
+}
+
+func indexHandler(w http.ResponseWriter, r *http.Request) {
+	if r.Method != http.MethodGet {
+		http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
+		return
+	}
+	handleWithStaticData(w, r, "index.html", "text/html")
+
 }

backend/http/users.go

@@ -2,19 +2,20 @@ package http
 
 import (
 	"encoding/json"
+	"fmt"
+	"io"
 	"net/http"
 	"reflect"
 	"sort"
 	"strconv"
 
-	"github.com/gorilla/mux"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/storage"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/storage"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 var (
@@ -26,102 +27,153 @@ type Sorting struct {
 	By  string `json:"by"`
 	Asc bool   `json:"asc"`
 }
-type modifyUserRequest struct {
-	modifyRequest
-	Data *users.User `json:"data"`
+type UserRequest struct {
+	What  string      `json:"what"`
+	Which []string    `json:"which"`
+	Data  *users.User `json:"data"`
 }
 
-func getUserID(r *http.Request) (uint, error) {
-	vars := mux.Vars(r)
-	i, err := strconv.ParseUint(vars["id"], 10, 0)
-	if err != nil {
-		return 0, err
-	}
-	return uint(i), err
-}
+// userGetHandler retrieves a user by ID.
+// @Summary Retrieve a user by ID
+// @Description Returns a user's details based on their ID.
+// @Tags Users
+// @Accept json
+// @Produce json
+// @Param id path int true "User ID" or "self"
+// @Success 200 {object} users.User "User details"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 404 {object} map[string]string "Not Found"
+// @Failure 500 {object} map[string]string "Internal Server Error"
+// @Router /api/users/{id} [get]
+func userGetHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	givenUserIdString := r.URL.Query().Get("id")
 
-func getUser(_ http.ResponseWriter, r *http.Request) (*modifyUserRequest, error) {
-	if r.Body == nil {
-		return nil, errors.ErrEmptyRequest
-	}
+	// since api self is used to validate a logged in user
+	w.Header().Add("X-Renew-Token", "false")
 
-	req := &modifyUserRequest{}
-	err := json.NewDecoder(r.Body).Decode(req)
-	if err != nil {
-		return nil, err
-	}
-
-	if req.What != "user" {
-		return nil, errors.ErrInvalidDataType
-	}
-
-	return req, nil
-}
-
-func withSelfOrAdmin(fn handleFunc) handleFunc {
-	return withUser(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-		id, err := getUserID(r)
+	var givenUserId uint
+	if givenUserIdString == "self" {
+		givenUserId = d.user.ID
+	} else if givenUserIdString == "" {
+		if !d.user.Perm.Admin {
+			return http.StatusForbidden, nil
+		}
+		users, err := store.Users.Gets(config.Server.Root)
 		if err != nil {
 			return http.StatusInternalServerError, err
 		}
-		if d.user.ID != id && !d.user.Perm.Admin {
-			return http.StatusForbidden, nil
+
+		for _, u := range users {
+			u.Password = ""
+		}
+		for _, u := range users {
+			u.ApiKeys = nil
 		}
 
-		d.raw = id
-		return fn(w, r, d)
-	})
-}
+		sort.Slice(users, func(i, j int) bool {
+			return users[i].ID < users[j].ID
+		})
 
-var usersGetHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	users, err := d.store.Users.Gets(d.server.Root)
-	if err != nil {
-		return http.StatusInternalServerError, err
+		return renderJSON(w, r, users)
+	} else {
+		num, _ := strconv.ParseUint(givenUserIdString, 10, 32)
+		givenUserId = uint(num)
 	}
 
-	for _, u := range users {
-		u.Password = ""
+	if givenUserId != d.user.ID && !d.user.Perm.Admin {
+		return http.StatusForbidden, nil
 	}
 
-	sort.Slice(users, func(i, j int) bool {
-		return users[i].ID < users[j].ID
-	})
-
-	return renderJSON(w, r, users)
-})
-
-var userGetHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	u, err := d.store.Users.Get(d.server.Root, d.raw.(uint))
+	// Fetch the user details
+	u, err := store.Users.Get(config.Server.Root, givenUserId)
 	if err == errors.ErrNotExist {
 		return http.StatusNotFound, err
 	}
-
 	if err != nil {
 		return http.StatusInternalServerError, err
 	}
 
+	// Remove the password from the response if the user is not an admin
 	u.Password = ""
+	u.ApiKeys = nil
 	if !d.user.Perm.Admin {
 		u.Scope = ""
 	}
-	return renderJSON(w, r, u)
-})
 
-var userDeleteHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	err := d.store.Users.Delete(d.raw.(uint))
+	return renderJSON(w, r, u)
+}
+
+// userDeleteHandler deletes a user by ID.
+// @Summary Delete a user by ID
+// @Description Deletes a user identified by their ID.
+// @Tags Users
+// @Accept json
+// @Produce json
+// @Param id path int true "User ID"
+// @Success 200 "User deleted successfully"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 500 {object} map[string]string "Internal Server Error"
+// @Router /api/users/{id} [delete]
+func userDeleteHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	givenUserIdString := r.URL.Query().Get("id")
+	num, _ := strconv.ParseUint(givenUserIdString, 10, 32)
+	givenUserId := uint(num)
+
+	if givenUserId == d.user.ID {
+		return http.StatusForbidden, fmt.Errorf("cannot delete your own user")
+	}
+
+	if !d.user.Perm.Admin {
+		return http.StatusForbidden, fmt.Errorf("cannot delete users without admin permissions")
+	}
+
+	if givenUserId == 1 {
+		return http.StatusForbidden, fmt.Errorf("cannot delete the default admin user")
+	}
+
+	// Delete the user
+	err := store.Users.Delete(givenUserId)
 	if err != nil {
 		return errToStatus(err), err
 	}
-
 	return http.StatusOK, nil
-})
+}
 
-var userPostHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	req, err := getUser(w, r)
+// usersPostHandler creates a new user.
+// @Summary Create a new user
+// @Description Adds a new user to the system.
+// @Tags Users
+// @Accept json
+// @Produce json
+// @Param data body users.User true "User data to create a new user"
+// @Success 201 {object} users.User "Created user"
+// @Failure 400 {object} map[string]string "Bad Request"
+// @Failure 500 {object} map[string]string "Internal Server Error"
+// @Router /api/users [post]
+func usersPostHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	if !d.user.Perm.Admin {
+		return http.StatusForbidden, nil
+	}
+
+	// Validate the user's scope
+	_, _, err := files.GetRealPath(config.Server.Root, d.user.Scope)
 	if err != nil {
 		return http.StatusBadRequest, err
 	}
 
+	// Read the JSON body
+	body, err := io.ReadAll(r.Body)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+	defer r.Body.Close()
+
+	// Parse the JSON into the UserRequest struct
+	var req UserRequest
+	if err = json.Unmarshal(body, &req); err != nil {
+		return http.StatusBadRequest, err
+	}
+
 	if len(req.Which) != 0 {
 		return http.StatusBadRequest, nil
 	}
@@ -137,22 +189,50 @@ var userPostHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *
 
 	w.Header().Set("Location", "/settings/users/"+strconv.FormatUint(uint64(req.Data.ID), 10))
 	return http.StatusCreated, nil
-})
+}
 
-var userPutHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
-	req, err := getUser(w, r)
+// userPutHandler updates an existing user's details.
+// @Summary Update a user's details
+// @Description Updates the details of a user identified by ID.
+// @Tags Users
+// @Accept json
+// @Produce json
+// @Param id path int true "User ID"
+// @Param data body users.User true "User data to update"
+// @Success 200 {object} users.User "Updated user details"
+// @Failure 400 {object} map[string]string "Bad Request"
+// @Failure 403 {object} map[string]string "Forbidden"
+// @Failure 500 {object} map[string]string "Internal Server Error"
+// @Router /api/users/{id} [put]
+func userPutHandler(w http.ResponseWriter, r *http.Request, d *requestContext) (int, error) {
+	givenUserIdString := r.URL.Query().Get("id")
+	num, _ := strconv.ParseUint(givenUserIdString, 10, 32)
+	givenUserId := uint(num)
+
+	if givenUserId != d.user.ID && !d.user.Perm.Admin {
+		return http.StatusForbidden, nil
+	}
+
+	// Validate the user's scope
+	_, _, err := files.GetRealPath(config.Server.Root, d.user.Scope)
 	if err != nil {
 		return http.StatusBadRequest, err
 	}
 
-	if req.Data.ID != d.raw.(uint) {
-		return http.StatusBadRequest, nil
-	}
-	_, _, err = files.GetRealPath(d.server.Root, req.Data.Scope)
+	// Read the JSON body
+	body, err := io.ReadAll(r.Body)
 	if err != nil {
-		return http.StatusBadRequest, nil
+		return http.StatusInternalServerError, err
+	}
+	defer r.Body.Close()
+
+	// Parse the JSON into the UserRequest struct
+	var req UserRequest
+	if err = json.Unmarshal(body, &req); err != nil {
+		return http.StatusBadRequest, err
 	}
 
+	// If `Which` is not specified, default to updating all fields
 	if len(req.Which) == 0 || req.Which[0] == "all" {
 		req.Which = []string{}
 		v := reflect.ValueOf(req.Data)
@@ -160,6 +240,8 @@ var userPutHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request
 			v = v.Elem()
 		}
 		t := v.Type()
+
+		// Dynamically populate fields to update
 		for i := 0; i < t.NumField(); i++ {
 			field := t.Field(i)
 			if field.Name == "Password" && req.Data.Password != "" {
@@ -170,10 +252,13 @@ var userPutHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request
 		}
 	}
 
-	for k, v := range req.Which {
-		v = cases.Title(language.English, cases.NoLower).String(v)
-		req.Which[k] = v
-		if v == "Password" {
+	// Process the fields to update
+	for _, field := range req.Which {
+		// Title case field names
+		field = cases.Title(language.English, cases.NoLower).String(field)
+
+		// Handle password update
+		if field == "Password" {
 			if !d.user.Perm.Admin && d.user.LockPassword {
 				return http.StatusForbidden, nil
 			}
@@ -183,16 +268,20 @@ var userPutHandler = withSelfOrAdmin(func(w http.ResponseWriter, r *http.Request
 			}
 		}
 
-		for _, f := range NonModifiableFieldsForNonAdmin {
-			if !d.user.Perm.Admin && v == f {
+		// Prevent non-admins from modifying certain fields
+		for _, restrictedField := range NonModifiableFieldsForNonAdmin {
+			if !d.user.Perm.Admin && field == restrictedField {
 				return http.StatusForbidden, nil
 			}
 		}
 	}
-	err = d.store.Users.Update(req.Data, req.Which...)
+	// Perform the user update
+	err = store.Users.Update(req.Data, req.Which...)
 	if err != nil {
 		return http.StatusInternalServerError, err
 	}
 
-	return http.StatusOK, nil
-})
+	// Return the updated user (with the password hidden) as JSON response
+	req.Data.Password = ""
+	return renderJSON(w, r, req.Data)
+}

backend/http/utils.go

@@ -1,30 +1,13 @@
 package http
 
 import (
-	"encoding/json"
 	"errors"
 	"net/http"
-	"net/url"
 	"os"
-	"strings"
 
-	libErrors "github.com/gtsteffaniak/filebrowser/errors"
+	libErrors "github.com/gtsteffaniak/filebrowser/backend/errors"
 )
 
-func renderJSON(w http.ResponseWriter, _ *http.Request, data interface{}) (int, error) {
-	marsh, err := json.Marshal(data)
-	if err != nil {
-		return http.StatusInternalServerError, err
-	}
-
-	w.Header().Set("Content-Type", "application/json; charset=utf-8")
-	if _, err := w.Write(marsh); err != nil {
-		return http.StatusInternalServerError, err
-	}
-
-	return 0, nil
-}
-
 func errToStatus(err error) int {
 	switch {
 	case err == nil:
@@ -45,23 +28,3 @@ func errToStatus(err error) int {
 		return http.StatusInternalServerError
 	}
 }
-
-// This is an addaptation if http.StripPrefix in which we don't
-// return 404 if the page doesn't have the needed prefix.
-func stripPrefix(prefix string, h http.Handler) http.Handler {
-	if prefix == "" || prefix == "/" {
-		return h
-	}
-
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		p := strings.TrimPrefix(r.URL.Path, prefix)
-		rp := strings.TrimPrefix(r.URL.RawPath, prefix)
-		r2 := new(http.Request)
-		*r2 = *r
-		r2.URL = new(url.URL)
-		*r2.URL = *r.URL
-		r2.URL.Path = p
-		r2.URL.RawPath = rp
-		h.ServeHTTP(w, r2)
-	})
-}

backend/img/service.go

@@ -11,7 +11,6 @@ import (
 
 	"github.com/disintegration/imaging"
 	"github.com/dsoprea/go-exif/v3"
-	"github.com/marusama/semaphore/v2"
 
 	exifcommon "github.com/dsoprea/go-exif/v3/common"
 )
@@ -21,12 +20,32 @@ var ErrUnsupportedFormat = errors.New("unsupported image format")
 
 // Service
 type Service struct {
-	sem semaphore.Semaphore
+	sem chan struct{}
 }
 
+// New initializes the service with a specified number of workers (concurrency limit).
 func New(workers int) *Service {
 	return &Service{
-		sem: semaphore.New(workers),
+		sem: make(chan struct{}, workers), // Buffered channel to limit concurrency.
+	}
+}
+
+// acquire blocks until a worker is available or the context is canceled.
+func (s *Service) acquire(ctx context.Context) error {
+	select {
+	case s.sem <- struct{}{}: // Reserve a worker.
+		return nil
+	case <-ctx.Done(): // Context canceled or deadline exceeded.
+		return ctx.Err()
+	}
+}
+
+// release frees up a worker slot.
+func (s *Service) release() {
+	select {
+	case <-s.sem: // Free a worker slot.
+	default:
+		// Shouldn't happen, but guard against releasing more than acquired.
 	}
 }
 
@@ -136,10 +155,10 @@ func WithQuality(quality Quality) Option {
 }
 
 func (s *Service) Resize(ctx context.Context, in io.Reader, width, height int, out io.Writer, options ...Option) error {
-	if err := s.sem.Acquire(ctx, 1); err != nil {
+	if err := s.acquire(ctx); err != nil {
 		return err
 	}
-	defer s.sem.Release(1)
+	defer s.release()
 
 	format, wrappedReader, err := s.detectFormat(in)
 	if err != nil {
@@ -242,3 +261,22 @@ func getEmbeddedThumbnail(in io.Reader) ([]byte, io.Reader, error) {
 	thm, err := ifd.Thumbnail()
 	return thm, wrappedReader, err
 }
+
+// CreateThumbnail takes raw image data and creates a thumbnail image.
+func CreateThumbnail(rawData io.Reader, width, height int) (image.Image, error) {
+	// Decode the raw image to get an image.Image.
+	img, _, err := image.Decode(rawData)
+	if err != nil {
+		return nil, fmt.Errorf("failed to decode image: %w", err)
+	}
+
+	// Resize the image to create a thumbnail using the specified dimensions.
+	thumb := imaging.Fit(img, width, height, imaging.Lanczos)
+
+	// Optionally, convert the thumbnail to grayscale if needed.
+	// Uncomment the line below if you want the result to be grayscale.
+	// thumb = imaging.Grayscale(thumb)
+
+	// Return the resized thumbnail image.
+	return thumb, nil
+}

backend/main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/gtsteffaniak/filebrowser/cmd"
+	"github.com/gtsteffaniak/filebrowser/backend/cmd"
 )
 
 func main() {

backend/rules/rules_test.go

@@ -1,23 +0,0 @@
-package rules
-
-import "testing"
-
-func TestMatchHidden(t *testing.T) {
-	cases := map[string]bool{
-		"/":                   false,
-		"/src":                false,
-		"/src/":               false,
-		"/.circleci":          true,
-		"/a/b/c/.docker.json": true,
-		".docker.json":        true,
-		"Dockerfile":          false,
-		"/Dockerfile":         false,
-	}
-
-	for path, want := range cases {
-		got := MatchHidden(path)
-		if got != want {
-			t.Errorf("MatchHidden(%s)=%v; want %v", path, got, want)
-		}
-	}
-}

backend/runner/parser.go

@@ -3,7 +3,7 @@ package runner
 import (
 	"os/exec"
 
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 )
 
 // ParseCommand parses the command taking in account if the current

backend/runner/runner.go

@@ -7,9 +7,9 @@ import (
 	"os/exec"
 	"strings"
 
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // Runner is a commands runner.

backend/settings/config.go

@@ -4,8 +4,10 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/goccy/go-yaml"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 var Config Settings
@@ -28,6 +30,12 @@ func Initialize(configFile string) {
 		log.Fatalf("ERROR: Configured Root Path does not exist! %v", err)
 	}
 	Config.Server.Root = realRoot
+	baseurl := strings.Trim(Config.Server.BaseURL, "/")
+	if baseurl == "" {
+		Config.Server.BaseURL = "/"
+	} else {
+		Config.Server.BaseURL = "/" + baseurl + "/"
+	}
 }
 
 func loadConfigFile(configFile string) []byte {
@@ -58,7 +66,6 @@ func setDefaults() Settings {
 			EnableThumbnails:   true,
 			ResizePreview:      false,
 			EnableExec:         false,
-			IndexingInterval:   5,
 			Port:               80,
 			NumImageProcessors: 4,
 			BaseURL:            "",
@@ -86,7 +93,7 @@ func setDefaults() Settings {
 			DisableSettings: false,
 			ViewMode:        "normal",
 			Locale:          "en",
-			Permissions: Permissions{
+			Permissions: users.Permissions{
 				Create:   false,
 				Rename:   false,
 				Modify:   false,
@@ -94,6 +101,7 @@ func setDefaults() Settings {
 				Share:    false,
 				Download: false,
 				Admin:    false,
+				Api:      false,
 			},
 		},
 	}

backend/settings/dir_test.go

@@ -3,7 +3,7 @@ package settings
 import (
 	"testing"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 func TestSettings_MakeUserDir(t *testing.T) {
@@ -15,7 +15,7 @@ func TestSettings_MakeUserDir(t *testing.T) {
 		Shell            []string
 		AdminUsername    string
 		AdminPassword    string
-		Rules            []rules.Rule
+		Rules            []users.Rule
 		Server           Server
 		Auth             Auth
 		Frontend         Frontend

backend/settings/settings.go

@@ -2,9 +2,8 @@ package settings
 
 import (
 	"crypto/rand"
-	"strings"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 const DefaultUsersHomeBasePath = "/users"
@@ -12,18 +11,6 @@ const DefaultUsersHomeBasePath = "/users"
 // AuthMethod describes an authentication method.
 type AuthMethod string
 
-// Settings contain the main settings of the application.
-// GetRules implements rules.Provider.
-func (s *Settings) GetRules() []rules.Rule {
-	return s.Rules
-}
-
-// Server specific settings
-// Clean cleans any variables that might need cleaning.
-func (s *Server) Clean() {
-	s.BaseURL = strings.TrimSuffix(s.BaseURL, "/")
-}
-
 // GenerateKey generates a key of 512 bits.
 func GenerateKey() ([]byte, error) {
 	b := make([]byte, 64) //nolint:gomnd
@@ -40,8 +27,8 @@ func GetSettingsConfig(nameType string, Value string) string {
 	return nameType + Value
 }
 
-func AdminPerms() Permissions {
-	return Permissions{
+func AdminPerms() users.Permissions {
+	return users.Permissions{
 		Create:   true,
 		Rename:   true,
 		Modify:   true,
@@ -49,5 +36,23 @@ func AdminPerms() Permissions {
 		Share:    true,
 		Download: true,
 		Admin:    true,
+		Api:      true,
 	}
 }
+
+// Apply applies the default options to a user.
+func ApplyUserDefaults(u users.User) users.User {
+	u.StickySidebar = Config.UserDefaults.StickySidebar
+	u.DisableSettings = Config.UserDefaults.DisableSettings
+	u.DarkMode = Config.UserDefaults.DarkMode
+	u.Scope = Config.UserDefaults.Scope
+	u.Locale = Config.UserDefaults.Locale
+	u.ViewMode = Config.UserDefaults.ViewMode
+	u.SingleClick = Config.UserDefaults.SingleClick
+	u.Perm = Config.UserDefaults.Perm
+	u.Sorting = Config.UserDefaults.Sorting
+	u.Commands = Config.UserDefaults.Commands
+	u.HideDotfiles = Config.UserDefaults.HideDotfiles
+	u.DateFormat = Config.UserDefaults.DateFormat
+	return u
+}

backend/settings/storage.go

@@ -1,8 +1,8 @@
 package settings
 
 import (
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/rules"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // StorageBackend is a settings storage backend.
@@ -62,7 +62,7 @@ func (s *Storage) Save(set *Settings) error {
 	}
 
 	if set.Rules == nil {
-		set.Rules = []rules.Rule{}
+		set.Rules = []users.Rule{}
 	}
 
 	if set.Commands == nil {
@@ -94,6 +94,5 @@ func (s *Storage) GetServer() (*Server, error) {
 
 // SaveServer wraps StorageBackend.SaveServer and adds some verification.
 func (s *Storage) SaveServer(ser *Server) error {
-	ser.Clean()
 	return s.back.SaveServer(ser)
 }

backend/settings/structs.go

@@ -1,13 +1,13 @@
 package settings
 
 import (
-	"github.com/gtsteffaniak/filebrowser/rules"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 type Settings struct {
 	Commands     map[string][]string `json:"commands"`
 	Shell        []string            `json:"shell"`
-	Rules        []rules.Rule        `json:"rules"`
+	Rules        []users.Rule        `json:"rules"`
 	Server       Server              `json:"server"`
 	Auth         Auth                `json:"auth"`
 	Frontend     Frontend            `json:"frontend"`
@@ -76,25 +76,14 @@ type UserDefaults struct {
 	ViewMode        string       `json:"viewMode"`
 	GallerySize     int          `json:"gallerySize"`
 	SingleClick     bool         `json:"singleClick"`
-	Rules           []rules.Rule `json:"rules"`
+	Rules           []users.Rule `json:"rules"`
 	Sorting         struct {
 		By  string `json:"by"`
 		Asc bool   `json:"asc"`
 	} `json:"sorting"`
-	Perm         Permissions `json:"perm"`
-	Permissions  Permissions `json:"permissions"`
-	Commands     []string    `json:"commands,omitempty"`
-	HideDotfiles bool        `json:"hideDotfiles"`
-	DateFormat   bool        `json:"dateFormat"`
-}
-
-type Permissions struct {
-	Admin    bool `json:"admin"`
-	Execute  bool `json:"execute"`
-	Create   bool `json:"create"`
-	Rename   bool `json:"rename"`
-	Modify   bool `json:"modify"`
-	Delete   bool `json:"delete"`
-	Share    bool `json:"share"`
-	Download bool `json:"download"`
+	Perm         users.Permissions `json:"perm"`
+	Permissions  users.Permissions `json:"permissions"`
+	Commands     []string          `json:"commands,omitempty"`
+	HideDotfiles bool              `json:"hideDotfiles"`
+	DateFormat   bool              `json:"dateFormat"`
 }

backend/share/storage.go

@@ -3,7 +3,7 @@ package share
 import (
 	"time"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
 )
 
 // StorageBackend is the interface to implement for a share storage.

backend/storage/bolt/auth.go

@@ -2,8 +2,8 @@ package bolt
 
 import (
 	"github.com/asdine/storm/v3"
-	"github.com/gtsteffaniak/filebrowser/auth"
-	"github.com/gtsteffaniak/filebrowser/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/auth"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
 )
 
 type authBackend struct {

backend/storage/bolt/bolt.go

@@ -3,10 +3,10 @@ package bolt
 import (
 	"github.com/asdine/storm/v3"
 
-	"github.com/gtsteffaniak/filebrowser/auth"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/share"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/auth"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
 )
 
 // NewStorage creates a storage.Storage based on Bolt DB.

backend/storage/bolt/config.go

@@ -2,7 +2,7 @@ package bolt
 
 import (
 	"github.com/asdine/storm/v3"
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
 )
 
 type settingsBackend struct {

backend/storage/bolt/share.go

@@ -4,8 +4,8 @@ import (
 	"github.com/asdine/storm/v3"
 	"github.com/asdine/storm/v3/q"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/share"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
 )
 
 type shareBackend struct {

backend/storage/bolt/users.go

@@ -6,8 +6,9 @@ import (
 
 	"github.com/asdine/storm/v3"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/users"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 type usersBackend struct {
@@ -55,14 +56,24 @@ func (st usersBackend) Update(user *users.User, fields ...string) error {
 	if len(fields) == 0 {
 		return st.Save(user)
 	}
+
+	val := reflect.ValueOf(user).Elem()
+
 	for _, field := range fields {
-		userField := reflect.ValueOf(user).Elem().FieldByName(field)
+		// Capitalize the first letter (you can adjust this based on your field naming convention)
+		correctedField := utils.CapitalizeFirst(field)
+
+		userField := val.FieldByName(correctedField)
 		if !userField.IsValid() {
 			return fmt.Errorf("invalid field: %s", field)
 		}
+		if !userField.CanSet() {
+			return fmt.Errorf("cannot update unexported field: %s", field)
+		}
+
 		val := userField.Interface()
-		if err := st.db.UpdateField(user, field, val); err != nil {
-			return fmt.Errorf("Error updating user field: %s, error: %v", field, err.Error())
+		if err := st.db.UpdateField(user, correctedField, val); err != nil {
+			return fmt.Errorf("Error updating user field: %s, error: %v", correctedField, err.Error())
 		}
 	}
 	return nil

backend/storage/bolt/utils.go

@@ -3,7 +3,7 @@ package bolt
 import (
 	"github.com/asdine/storm/v3"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
 )
 
 func get(db *storm.DB, name string, to interface{}) error {

backend/storage/storage.go

@@ -7,20 +7,20 @@ import (
 	"path/filepath"
 
 	"github.com/asdine/storm/v3"
-	"github.com/gtsteffaniak/filebrowser/auth"
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/files"
-	"github.com/gtsteffaniak/filebrowser/settings"
-	"github.com/gtsteffaniak/filebrowser/share"
-	"github.com/gtsteffaniak/filebrowser/storage/bolt"
-	"github.com/gtsteffaniak/filebrowser/users"
-	"github.com/gtsteffaniak/filebrowser/utils"
+	"github.com/gtsteffaniak/filebrowser/backend/auth"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
+	"github.com/gtsteffaniak/filebrowser/backend/files"
+	"github.com/gtsteffaniak/filebrowser/backend/settings"
+	"github.com/gtsteffaniak/filebrowser/backend/share"
+	"github.com/gtsteffaniak/filebrowser/backend/storage/bolt"
+	"github.com/gtsteffaniak/filebrowser/backend/users"
+	"github.com/gtsteffaniak/filebrowser/backend/utils"
 )
 
 // Storage is a storage powered by a Backend which makes the necessary
 // verifications when fetching and saving data to ensure consistency.
 type Storage struct {
-	Users    users.Store
+	Users    *users.Storage
 	Share    *share.Storage
 	Auth     *auth.Storage
 	Settings *settings.Storage
@@ -92,7 +92,7 @@ func quickSetup(store *Storage) {
 	utils.CheckErr("store.Settings.Save", err)
 	err = store.Settings.SaveServer(&settings.Config.Server)
 	utils.CheckErr("store.Settings.SaveServer", err)
-	user := users.ApplyDefaults(users.User{})
+	user := settings.ApplyUserDefaults(users.User{})
 	user.Username = settings.Config.Auth.AdminUsername
 	user.Password = settings.Config.Auth.AdminPassword
 	user.Perm.Admin = true
@@ -111,7 +111,7 @@ func CreateUser(userInfo users.User, asAdmin bool) error {
 	if userInfo.Username == "" || userInfo.Password == "" {
 		return errors.ErrInvalidRequestParams
 	}
-	newUser := users.ApplyDefaults(userInfo)
+	newUser := settings.ApplyUserDefaults(userInfo)
 	if asAdmin {
 		newUser.Perm = settings.AdminPerms()
 	}

backend/users/rules.go

@@ -1,4 +1,4 @@
-package rules
+package users
 
 import (
 	"path/filepath"
@@ -11,6 +11,18 @@ type Checker interface {
 	Check(path string) bool
 }
 
+// Check implements rules.Checker.
+func (user *User) Check(path string) bool {
+	allow := true
+	for _, rule := range user.Rules {
+		if rule.Matches(path) {
+			allow = rule.Allow
+		}
+	}
+
+	return allow
+}
+
 // Rule is a allow/disallow rule.
 type Rule struct {
 	Regex  bool    `json:"regex"`

backend/users/storage.go

@@ -4,8 +4,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/gtsteffaniak/filebrowser/errors"
-	"github.com/gtsteffaniak/filebrowser/rules"
+	"github.com/gtsteffaniak/filebrowser/backend/errors"
 )
 
 // StorageBackend is the interface to implement for a users storage.
@@ -26,7 +25,9 @@ type Store interface {
 	Save(user *User) error
 	Delete(id interface{}) error
 	LastUpdate(id uint) int64
-	AddRule(username string, rule rules.Rule) error
+	AddApiKey(username uint, name string, key AuthToken) error
+	DeleteApiKey(username uint, name string) error
+	AddRule(username string, rule Rule) error
 	DeleteRule(username string, ruleID string) error
 }
 
@@ -79,7 +80,7 @@ func (s *Storage) Update(user *User, fields ...string) error {
 }
 
 // AddRule adds a rule to the user's rules list and updates the user in the database.
-func (s *Storage) AddRule(userID string, rule rules.Rule) error {
+func (s *Storage) AddRule(userID string, rule Rule) error {
 	user, err := s.Get("", userID)
 	if err != nil {
 		return err
@@ -95,6 +96,42 @@ func (s *Storage) AddRule(userID string, rule rules.Rule) error {
 	return nil
 }
 
+func (s *Storage) AddApiKey(userID uint, name string, key AuthToken) error {
+	user, err := s.Get("", userID)
+	if err != nil {
+		return err
+	}
+	// Initialize the ApiKeys map if it is nil
+	if user.ApiKeys == nil {
+		user.ApiKeys = make(map[string]AuthToken)
+	}
+	user.ApiKeys[name] = key
+	err = s.Update(user, "ApiKeys")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (s *Storage) DeleteApiKey(userID uint, name string) error {
+	user, err := s.Get("", userID)
+	if err != nil {
+		return err
+	}
+	// Initialize the ApiKeys map if it is nil
+	if user.ApiKeys == nil {
+		user.ApiKeys = make(map[string]AuthToken)
+	}
+	delete(user.ApiKeys, name)
+	err = s.Update(user, "ApiKeys")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 // DeleteRule deletes a rule specified by ID from the user's rules list and updates the user in the database.
 func (s *Storage) DeleteRule(userID string, ruleID string) error {
 	user, err := s.Get("", userID)
@@ -103,7 +140,7 @@ func (s *Storage) DeleteRule(userID string, ruleID string) error {
 	}
 
 	// Find and remove the rule with the specified ID
-	var updatedRules []rules.Rule
+	var updatedRules []Rule
 	for _, r := range user.Rules {
 		if r.Id != ruleID {
 			updatedRules = append(updatedRules, r)

backend/users/users.go

@@ -3,10 +3,31 @@ package users
 import (
 	"regexp"
 
-	"github.com/gtsteffaniak/filebrowser/rules"
-	"github.com/gtsteffaniak/filebrowser/settings"
+	"github.com/golang-jwt/jwt/v4"
 )
 
+type AuthToken struct {
+	Key                  string      `json:"key"`
+	Name                 string      `json:"name"`
+	Created              int64       `json:"createdAt"`
+	Expires              int64       `json:"expiresAt"`
+	BelongsTo            uint        `json:"belongsTo"`
+	Permissions          Permissions `json:"Permissions"`
+	jwt.RegisteredClaims `json:"-"`
+}
+
+type Permissions struct {
+	Api      bool `json:"api"`
+	Admin    bool `json:"admin"`
+	Execute  bool `json:"execute"`
+	Create   bool `json:"create"`
+	Rename   bool `json:"rename"`
+	Modify   bool `json:"modify"`
+	Delete   bool `json:"delete"`
+	Share    bool `json:"share"`
+	Download bool `json:"download"`
+}
+
 // SortingSettings represents the sorting settings.
 type Sorting struct {
 	By  string `json:"by"`
@@ -20,16 +41,17 @@ type User struct {
 	DisableSettings bool                 `json:"disableSettings"`
 	ID              uint                 `storm:"id,increment" json:"id"`
 	Username        string               `storm:"unique" json:"username"`
-	Password        string               `json:"password"`
+	Password        string               `json:"password,omitempty"`
 	Scope           string               `json:"scope"`
 	Locale          string               `json:"locale"`
 	LockPassword    bool                 `json:"lockPassword"`
 	ViewMode        string               `json:"viewMode"`
 	SingleClick     bool                 `json:"singleClick"`
-	Perm            settings.Permissions `json:"perm"`
-	Commands        []string             `json:"commands"`
 	Sorting         Sorting              `json:"sorting"`
-	Rules           []rules.Rule         `json:"rules"`
+	Perm            Permissions          `json:"perm"`
+	Commands        []string             `json:"commands"`
+	Rules           []Rule               `json:"rules"`
+	ApiKeys         map[string]AuthToken `json:"apiKeys,omitempty"`
 	HideDotfiles    bool                 `json:"hideDotfiles"`
 	DateFormat      bool                 `json:"dateFormat"`
 	GallerySize     int                  `json:"gallerySize"`
@@ -41,19 +63,20 @@ var PublicUser = User{
 	Scope:        "./",
 	ViewMode:     "normal",
 	LockPassword: true,
-	Perm: settings.Permissions{
+	Perm: Permissions{
 		Create:   false,
 		Rename:   false,
 		Modify:   false,
 		Delete:   false,
-		Share:    true,
+		Share:    false,
 		Download: true,
 		Admin:    false,
+		Api:      false,
 	},
 }
 
 // GetRules implements rules.Provider.
-func (u *User) GetRules() []rules.Rule {
+func (u *User) GetRules() []Rule {
 	return u.Rules
 }
 
@@ -71,20 +94,3 @@ func (u *User) CanExecute(command string) bool {
 
 	return false
 }
-
-// Apply applies the default options to a user.
-func ApplyDefaults(u User) User {
-	u.StickySidebar = settings.Config.UserDefaults.StickySidebar
-	u.DisableSettings = settings.Config.UserDefaults.DisableSettings
-	u.DarkMode = settings.Config.UserDefaults.DarkMode
-	u.Scope = settings.Config.UserDefaults.Scope
-	u.Locale = settings.Config.UserDefaults.Locale
-	u.ViewMode = settings.Config.UserDefaults.ViewMode
-	u.SingleClick = settings.Config.UserDefaults.SingleClick
-	u.Perm = settings.Config.UserDefaults.Perm
-	u.Sorting = settings.Config.UserDefaults.Sorting
-	u.Commands = settings.Config.UserDefaults.Commands
-	u.HideDotfiles = settings.Config.UserDefaults.HideDotfiles
-	u.DateFormat = settings.Config.UserDefaults.DateFormat
-	return u
-}

backend/utils/cache.go

@@ -0,0 +1,80 @@
+package utils
+
+import (
+	"sync"
+	"time"
+)
+
+var (
+	DiskUsageCache     = newCache(30*time.Second, 24*time.Hour)
+	RealPathCache      = newCache(48*time.Hour, 72*time.Hour)
+	SearchResultsCache = newCache(15*time.Second, time.Hour)
+)
+
+func newCache(expires time.Duration, cleanup time.Duration) *KeyCache {
+	newCache := KeyCache{
+		data:         make(map[string]cachedValue),
+		expiresAfter: expires, // default
+	}
+	go newCache.cleanupExpiredJob(cleanup)
+	return &newCache
+}
+
+type KeyCache struct {
+	data         map[string]cachedValue
+	mu           sync.RWMutex
+	expiresAfter time.Duration
+}
+
+type cachedValue struct {
+	value     interface{}
+	expiresAt time.Time
+}
+
+func (c *KeyCache) Set(key string, value interface{}) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	c.data[key] = cachedValue{
+		value:     value,
+		expiresAt: time.Now().Add(c.expiresAfter),
+	}
+}
+
+func (c *KeyCache) SetWithExp(key string, value interface{}, exp time.Duration) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	c.data[key] = cachedValue{
+		value:     value,
+		expiresAt: time.Now().Add(exp),
+	}
+}
+
+func (c *KeyCache) Get(key string) interface{} {
+	c.mu.RLock()
+	defer c.mu.RUnlock()
+	cached, ok := c.data[key]
+	if !ok || time.Now().After(cached.expiresAt) {
+		return nil
+	}
+	return cached.value
+}
+
+func (c *KeyCache) cleanupExpired() {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	now := time.Now()
+	for key, cached := range c.data {
+		if now.After(cached.expiresAt) {
+			delete(c.data, key)
+		}
+	}
+}
+
+// should automatically run for all cache types as part of init.
+func (c *KeyCache) cleanupExpiredJob(frequency time.Duration) {
+	ticker := time.NewTicker(frequency)
+	defer ticker.Stop()
+	for range ticker.C {
+		c.cleanupExpired()
+	}
+}

backend/utils/main.go

@@ -1,9 +1,13 @@
 package utils
 
 import (
+	"crypto/rand"
+	"fmt"
 	"log"
-
-	"github.com/gtsteffaniak/filebrowser/settings"
+	math "math/rand"
+	"reflect"
+	"strings"
+	"time"
 )
 
 func CheckErr(source string, err error) {
@@ -13,7 +17,70 @@ func CheckErr(source string, err error) {
 }
 
 func GenerateKey() []byte {
-	k, err := settings.GenerateKey()
-	CheckErr("generateKey", err)
-	return k
+	b := make([]byte, 64)
+	_, err := rand.Read(b)
+	if err != nil {
+		return nil
+	}
+	return b
+}
+
+// CapitalizeFirst returns the input string with the first letter capitalized.
+func CapitalizeFirst(s string) string {
+	if len(s) == 0 {
+		return s // Return the empty string as is
+	}
+	return strings.ToUpper(string(s[0])) + s[1:]
+}
+
+func GenerateRandomHash(length int) string {
+	const charset = "abcdefghijklmnopqrstuvwxyz0123456789"
+	math.New(math.NewSource(time.Now().UnixNano()))
+	result := make([]byte, length)
+	for i := range result {
+		result[i] = charset[math.Intn(len(charset))]
+	}
+	return string(result)
+}
+
+func PrintStructFields(v interface{}) {
+	val := reflect.ValueOf(v)
+	typ := reflect.TypeOf(v)
+
+	// Ensure the input is a struct
+	if val.Kind() != reflect.Struct {
+		fmt.Println("Provided value is not a struct")
+		return
+	}
+
+	// Iterate over the fields of the struct
+	for i := 0; i < val.NumField(); i++ {
+		field := val.Field(i)
+		fieldType := typ.Field(i)
+
+		// Convert field value to string, if possible
+		fieldValue := fmt.Sprintf("%v", field.Interface())
+
+		// Limit to 50 characters
+		if len(fieldValue) > 100 {
+			fieldValue = fieldValue[:100] + "..."
+		}
+
+		fmt.Printf("Field: %s, %s\n", fieldType.Name, fieldValue)
+	}
+}
+
+func GetParentDirectoryPath(path string) string {
+	if path == "/" || path == "" {
+		return ""
+	}
+	path = strings.TrimSuffix(path, "/") // Remove trailing slash if any
+	lastSlash := strings.LastIndex(path, "/")
+	if lastSlash == -1 {
+		return "" // No parent directory for a relative path without slashes
+	}
+	if lastSlash == 0 {
+		return "/" // If the last slash is the first character, return root
+	}
+	return path[:lastSlash]
 }

backend/utils/main_test.go

@@ -0,0 +1,59 @@
+package utils
+
+import (
+	"testing"
+)
+
+func TestGetParentDirectoryPath(t *testing.T) {
+	tests := []struct {
+		input          string
+		expectedOutput string
+	}{
+		{input: "/", expectedOutput: ""},                                              // Root directory
+		{input: "/subfolder", expectedOutput: "/"},                                    // Single subfolder
+		{input: "/sub/sub/", expectedOutput: "/sub"},                                  // Nested subfolder with trailing slash
+		{input: "/subfolder/", expectedOutput: "/"},                                   // Relative path with trailing slash
+		{input: "", expectedOutput: ""},                                               // Empty string treated as root
+		{input: "/sub/subfolder", expectedOutput: "/sub"},                             // Double slash in path
+		{input: "/sub/subfolder/deep/nested/", expectedOutput: "/sub/subfolder/deep"}, // Double slash in path
+	}
+
+	for _, test := range tests {
+		t.Run(test.input, func(t *testing.T) {
+			actualOutput := GetParentDirectoryPath(test.input)
+			if actualOutput != test.expectedOutput {
+				t.Errorf("\n\tinput %q\n\texpected %q\n\tgot %q",
+					test.input, test.expectedOutput, actualOutput)
+			}
+		})
+	}
+}
+
+func TestCapitalizeFirst(t *testing.T) {
+	tests := []struct {
+		input          string
+		expectedOutput string
+	}{
+		{input: "", expectedOutput: ""},                               // Empty string
+		{input: "a", expectedOutput: "A"},                             // Single lowercase letter
+		{input: "A", expectedOutput: "A"},                             // Single uppercase letter
+		{input: "hello", expectedOutput: "Hello"},                     // All lowercase
+		{input: "Hello", expectedOutput: "Hello"},                     // Already capitalized
+		{input: "123hello", expectedOutput: "123hello"},               // Non-alphabetic first character
+		{input: "hELLO", expectedOutput: "HELLO"},                     // Mixed case
+		{input: " hello", expectedOutput: " hello"},                   // Leading space, no capitalization
+		{input: "hello world", expectedOutput: "Hello world"},         // Phrase with spaces
+		{input: " hello world", expectedOutput: " hello world"},       // Phrase with leading space
+		{input: "123 hello world", expectedOutput: "123 hello world"}, // Numbers before text
+	}
+
+	for _, test := range tests {
+		t.Run(test.input, func(t *testing.T) {
+			actualOutput := CapitalizeFirst(test.input)
+			if actualOutput != test.expectedOutput {
+				t.Errorf("\n\tinput %q\n\texpected %q\n\tgot %q",
+					test.input, test.expectedOutput, actualOutput)
+			}
+		})
+	}
+}

docs/configuration.md

@@ -10,7 +10,6 @@ Here is an expanded config file which includes all possible configurations:
 server:
   CreateUserDir: false
   UserHomeBasePath: ""
-  indexingInterval: 5
   indexing: true
   numImageProcessors: 4
   socket: ""
@@ -71,7 +70,6 @@ Here are the defaults if nothing is set:
 server:
   enableThumbnails: true
   enableExec: false
-  indexingInterval: 5
   port: 80
   numImageProcessors: 4
   baseURL: ""
@@ -109,7 +107,7 @@ userDefaults:
 
 ### Server configuration settings
 
-- `indexingInterval`: This is the time in minutes the system waits before checking for filesystem changes. Default: `5`
+- `indexingInterval`: This optional paramter disables smart indexing and specifies a time in minutes the system waits before checking for filesystem changes. See [indexing readme](indexing.md) for more information.
 
 - `indexing`: This enables or disables indexing. (Note: search will not work without indexing) Default: `true`
 
@@ -220,6 +218,7 @@ userDefaults:
 
   - `download`: This boolean value determines whether download permissions are granted.
 
+  - `api`: Ability to create and manage API keys.
 
 - `hideDotfiles`: This boolean value determines whether dotfiles are hidden. (`true` or `false`)
 

docs/contributing.md

@@ -1,2 +1,13 @@
 # Contributing Guide
 
+If you would like to contribute, please open a pull request against main or the latest `dev_` branch thats currently in progress.
+
+A PR is required to have:
+
+1. A clear description about why it was opened
+2. A short title that best describes the issue.
+3. Test evidence for anything that is not self evident or covered by unit tests.
+
+Unit tests should be updated to pass before merging. So, the best way to handle this is to create a fork and test your changes there, then merge to this repo. You can also create a draft pull request if it is not fully ready.
+
+Please don't hesitate to open an issue for any ideas you have, but cannot contribute directly for whatever reason.