Python & web interface rewrites

.github/workflows/publishBranchesPRs.yml

@@ -5,7 +5,7 @@ name: PR - Create and publish a Docker image
 on:
   pull_request:
   #push:
-  #  branches: 
+  #  branches:
   #    - '*'
   #    - '!master'
 
@@ -22,10 +22,10 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
@@ -36,7 +36,7 @@ jobs:
       # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
       - name: Extract branch name
         shell: bash
-        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> "$GITHUB_OUTPUT"
         id: extract_branch
       - name: Extract metadata (tags, labels) for Docker
         id: meta

.github/workflows/publishMaster.yml

@@ -4,7 +4,7 @@ name: Master - Create and publish a Docker image
 # Configures this workflow to run every time a change is pushed to the branch called `master`.
 on:
   push:
-    branches: ['master']
+    branches: ["master"]
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -19,10 +19,10 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1

.github/workflows/publishTags.yml

@@ -4,8 +4,8 @@ name: Tags - Create and publish a Docker image
 # Build when a tag is created
 on:
   push:
-    tags:        
-      - '**'
+    tags:
+      - "**"
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -20,10 +20,10 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1

.github/workflows/superLinter.yml

@@ -0,0 +1,47 @@
+---
+# This workflow executes several linters on changed files based on languages used in your code base whenever
+# you push a code or open a pull request.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/github/super-linter
+name: Lint Code Base
+
+on: # yamllint disable-line rule:truthy
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v7
+        env:
+          DISABLE_ERRORS: true
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_CHECKOV: false
+          VALIDATE_EDITORCONFIG: false
+          VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN: false
+          VALIDATE_PYTHON: true
+          VALIDATE_PYTHON_PYLINT: false
+          VALIDATE_YAML: false
+          VALIDATE_YAML_PRETTIER: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LINTER_RULES_PATH: /
+          DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yml
+          MARKDOWN_CONFIG_FILE: .markdown-lint.yml
+          YAML_CONFIG_FILE: .yamllint.yml

.hadolint.yml

@@ -0,0 +1,3 @@
+ignored:
+  - DL3008  # Pin versions in apt get install. Instead of `apt-get install <package>` use `apt-get install <package>=<version>`
+  - DL3018  # Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`

.yamllint.yml

@@ -0,0 +1,11 @@
+extends: default
+
+rules:
+  document-start: disable
+  line-length:
+    max: 180
+    level: warning
+  comments:
+    # Changed this to stop a mess between linters from Prettier (vscode) to yamllint
+    # - https://github.com/prettier/prettier/pull/10926
+    min-spaces-from-content: 1

Dockerfile

@@ -1,14 +1,12 @@
-FROM python:slim-bullseye
+FROM python:slim-bookworm
 
 RUN <<EOF
 apt-get update && \
 apt-get -y --no-install-recommends install \
-  bc \
   curl \
   ghostscript \
   graphicsmagick \
   iproute2 \
-  jq \
   lighttpd \
   netbase \
   netpbm \
@@ -27,6 +25,7 @@ apt-get -y --no-install-recommends install \
   x11-common && \
 apt-get -y clean && \
 rm -rf /var/lib/apt/lists/* && \
+pip install --no-cache-dir requests==2.32.3 && \
 wget https://download.brother.com/welcome/dlf105200/brscan4-0.4.11-1.amd64.deb --progress=dot:giga -O /tmp/brscan4.deb && \
 wget https://download.brother.com/welcome/dlf006652/brscan-skey-0.3.2-0.amd64.deb --progress=dot:giga -O /tmp/brscan-skey.deb && \
 dpkg -i --force-all /tmp/brscan4.deb && \
@@ -35,6 +34,7 @@ rm -f /tmp/brscan4.deb /tmp/brscan-skey.deb
 EOF
 
 COPY files/runScanner.sh /opt/brother/runScanner.sh
+COPY files/brscan-skey.config /opt/brother/scanner/brscan-skey/brscan-skey.config
 COPY script /opt/brother/scanner/brscan-skey/script
 
 RUN <<EOF
@@ -44,13 +44,13 @@ cp /etc/lighttpd/conf-available/10-fastcgi.conf /etc/lighttpd/conf-enabled/ && \
 mkdir -p /var/run/lighttpd && \
 touch /var/run/lighttpd/php-fastcgi.socket && \
 chown -R www-data /var/run/lighttpd && \
-echo 'www-data ALL=(NAS) NOPASSWD:ALL' >> /etc/sudoers
+echo 'www-data ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
 EOF
 
+
 ENV NAME="Scanner"
 ENV MODEL="MFC-L2700DW"
 ENV IPADDRESS="192.168.1.123"
-ENV USERNAME="NAS"
 ENV REMOVE_BLANK_THRESHOLD="0.3"
 
 # Only set these variables in the compose file, if inotify needs to be triggered (e.g., for Synology Drive):
@@ -71,13 +71,12 @@ ENV TELEGRAM_CHATID=""
 # Make sure this ends in a slash.
 ENV FTP_PATH="/scans/"
 
-#ADD files/gui/index.php /var/www/html
-#ADD files/gui/main.css /var/www/html
-#ADD files/api/scan.php /var/www/html
-#ADD files/api/active.php /var/www/html
-#ADD files/api/list.php /var/www/html
-#ADD files/api/download.php /var/www/html
-COPY html /var/www/html
+EXPOSE 54925
+EXPOSE 54921
+EXPOSE 80
+
+# Copy the web files to the web directory
+COPY www /var/www
 RUN chown -R www-data /var/www/
 
 #directory for scans:

README.md

@@ -123,6 +123,7 @@ You can configure the tool via environment variables:
 | USE_JPEG_COMPRESSION | optional | use JPEG compression when creating PDFs |
 | TELEGRAM_TOKEN | optional | If TELEGRAM_TOKEN and TELEGRAM_CHATID are set, then this sends notification |
 | TELEGRAM_CHATID | optional | If TELEGRAM_TOKEN and TELEGRAM_CHATID are set, then this sends notification |
+| ALLOW_GUI_FILEOPERATIONS | optional | true/false. Let you delete and rename files in files list  |
 
 ### FTPS upload
 
@@ -203,9 +204,8 @@ Thus, make sure to wait for your scan to complete, before pressing another butto
 #### API
 
 The GUI uses a minimal "API" at the backend, which you can also use from other tooling (e.g., Home Assistant or a control panel near your printer).
-To scan, simply call `http://<ContainerIP>:<Port>/scan.php?target=<file|email|image|OCR>`
-Also check out the endpoints `list.php`, `download.php`, `active.php`.
-Maybe one day an OpenAPI Spec will be included.
+To scan, simply call `http://<ContainerIP>:<Port>/api/scanner/scanto/<file|email|image|OCR>`
+Also check out the  swagger file in the doc directory to see all available endpoints.
 
 ## Full Docker Compose Example