PhilippMundhenk · pedropombeiro · Oct 6, 2024 · Oct 1, 2024
diff --git a/.github/workflows/publishBranchesPRs.yml b/.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

diff --git a/.github/workflows/publishMaster.yml b/.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

diff --git a/.github/workflows/publishTags.yml b/.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

diff --git a/.github/workflows/superLinter.yml b/.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
diff --git a/.hadolint.yml b/.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>`
diff --git a/.yamllint.yml b/.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
diff --git a/Dockerfile b/Dockerfile
@@ -34,8 +34,8 @@ RUN wget --progress=dot:giga https://download.brother.com/welcome/dlf006652/brsc
   dpkg -i /tmp/brscan-skey-0.3.1-2.amd64.deb && \
   rm /tmp/brscan-skey-0.3.1-2.amd64.deb
 
-ADD files/runScanner.sh /opt/brother/runScanner.sh
-ADD files/brscan-skey.config /opt/brother/scanner/brscan-skey/brscan-skey.config
+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 cp /etc/lighttpd/conf-available/05-auth.conf /etc/lighttpd/conf-enabled/

diff --git a/html/active.php b/html/active.php
@@ -1,30 +1,30 @@
 <?php
 
 function isProcessRunning($processName) {
-        // Execute the pgrep command
-        $command = "pgrep $processName";
-        exec($command, $output, $status);
-    
-        // Check if pgrep returned a status of 0, which means the process was found
-        if ($status === 0) {
-            // Process is running
-            return true;
-        } else {
-            // Process is not running
-            return false;
-        }
+    // Execute the pgrep command
+    $command = "pgrep $processName";
+    exec($command, $output, $status);
+
+    // Check if pgrep returned a status of 0, which means the process was found
+    if ($status === 0) {
+        // Process is running
+        return true;
+    } else {
+        // Process is not running
+        return false;
+    }
     }
-    
+
 // Check if the scanimage, sleep, and curl processes are running
 $result = array(
-        'scan' => isProcessRunning('scanimage'),
-        'waiting' => isProcessRunning('sleep'),
-        'ocr' => isProcessRunning('curl')
+    'scan' => isProcessRunning('scanimage'),
+    'waiting' => isProcessRunning('sleep'),
+    'ocr' => isProcessRunning('curl')
 );
 
 
 // Output the result as JSON
 header('Content-Type: application/json; charset=utf-8');
 echo json_encode($result);
 
-?>
+?>
diff --git a/html/download.php b/html/download.php
@@ -1,23 +1,25 @@
 <?php
+
 if ($_SERVER['REQUEST_METHOD'] == 'GET') {
-        if(array_key_exists("file", $_GET)) {
-                $file = $_GET["file"];
-                if(str_contains($file, "..") || str_contains($file, "/")) {
-                        header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
-                        die("Error: Dont't be evil!");
-                }
-                $filename="/scans/".$file;
-                if(file_exists($filename)) {
-                        header("Content-type:application/pdf");
-                        header("Content-Disposition:attachment;filename=\"$file\"");
-                        readfile($filename);
-                } else {
-                        header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
-                        die("Error: File does not exist!");
-                }
+    if(array_key_exists("file", $_GET)) {
+        $file = $_GET["file"];
+        if(str_contains($file, "..") || str_contains($file, "/")) {
+            header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
+            die("Error: Dont't be evil!");
+        }
+        $filename="/scans/".$file;
+        if(file_exists($filename)) {
+            header("Content-type:application/pdf");
+            header("Content-Disposition:attachment;filename=\"$file\"");
+            readfile($filename);
         } else {
-                header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
-                die("Error: No file provided!");
+            header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
+            die("Error: File does not exist!");
         }
+    } else {
+        header($_SERVER["SERVER_PROTOCOL"] . " 400 OK");
+        die("Error: No file provided!");
+    }
 }
-?>
+
+?>
diff --git a/html/index.php b/html/index.php
@@ -1,5 +1,5 @@
-<?php 
-include 'config.php'; 
+<?php
+include 'config.php';
 
 if (isset($RENAME_GUI_SCANTOFILE) && $RENAME_GUI_SCANTOFILE) {
     $button_file = $RENAME_GUI_SCANTOFILE;
@@ -36,7 +36,7 @@
     <link rel="icon" href="favicon.ico">
     <link rel="stylesheet" href="/assets/bootstrap.5.1.3/bootstrap.min.css ">
     <link rel="stylesheet" href="/assets/fontawesome.5.15.4/css/all.min.css">
-    
+
     <style>
         /* prevent persistent highlight after click to scan */
         .trigger-scan:focus, .trigger-scan:active:focus {
@@ -64,38 +64,34 @@ class="far fa-smile fa-fw fa-10x"></i></span>
                     <h1 class="   text-light mb-2 mt-5"><strong><?php echo($MODEL); ?></strong> </h1>
                     <p class="lead  text-light mb-5" id="status-text">Ready to scan</p>
 
-                    <?php 
-                if (!isset($DISABLE_GUI_SCANTOFILE) || $DISABLE_GUI_SCANTOFILE != true) {
-                    echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="file">'.$button_file.'</a></p>');
-                }
-                if (!isset($DISABLE_GUI_SCANTOEMAIL) || $DISABLE_GUI_SCANTOEMAIL != true) {
-                    echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="email">'.$button_email.'</a></p>');
-                }
-                if (!isset($DISABLE_GUI_SCANTOIMAGE) || $DISABLE_GUI_SCANTOIMAGE != true) {
-                    echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="image">'.$button_image.'</a></p>');
-                }
-                if (!isset($DISABLE_GUI_SCANTOOCR) || $DISABLE_GUI_SCANTOOCR != true) {
-                    echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="ocr">'.$button_ocr.'</a></p>');
-                }
-            ?>
+                    <?php
+                        if (!isset($DISABLE_GUI_SCANTOFILE) || $DISABLE_GUI_SCANTOFILE != true) {
+                            echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="file">'.$button_file.'</a></p>');
+                        }
+                        if (!isset($DISABLE_GUI_SCANTOEMAIL) || $DISABLE_GUI_SCANTOEMAIL != true) {
+                            echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="email">'.$button_email.'</a></p>');
+                        }
+                        if (!isset($DISABLE_GUI_SCANTOIMAGE) || $DISABLE_GUI_SCANTOIMAGE != true) {
+                            echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="image">'.$button_image.'</a></p>');
+                        }
+                        if (!isset($DISABLE_GUI_SCANTOOCR) || $DISABLE_GUI_SCANTOOCR != true) {
+                            echo('<p><a href="#" class="btn btn-outline-light btn-lg d-block trigger-scan" data-trigger="ocr">'.$button_ocr.'</a></p>');
+                        }
+                    ?>
                 </div>
             </div>
         </div>
     </section>
 
 
     <div class="offcanvas offcanvas-start" tabindex="-1" id="offcanvasFiles" aria-labelledby="offcanvasFilesLabel">
-	
+
         <div class="offcanvas-header">
             <h5 class="offcanvas-title" id="offcanvasFilesLabel">Last scanned</h5>
             <button type="button" class="btn-close text-reset" data-bs-dismiss="offcanvas" aria-label="Close"></button>
         </div>
         <div class="offcanvas-body m-0 p-0" id="offcanvasContent">
 
-
-
-
-
         </div>
     </div>
 
@@ -169,19 +165,19 @@ function set_state(state) {
 
 
                     let state = 'idle';
-                    
+
 
                     if (data.ocr && data.waiting && !data.scan) {
                         state = 'ocr';
-                    } else if (data.scan && data.waiting) {
+                    } elseif (data.scan && data.waiting) {
                         state = 'scan';
-                    } else if (data.scan) {
+                    } elseif (data.scan) {
                         state = 'scan';
-                    } else if (data.ocr && !data.scan) {
+                    } elseif (data.ocr && !data.scan) {
                         state = 'ocr';
-                    } else if (!data.ocr && !data.scan && data.waiting) {
+                    } elseif (!data.ocr && !data.scan && data.waiting) {
                         state = 'waiting';
-                    } else if (!data.ocr && !data.scan && !data.waiting) {
+                    } elseif (!data.ocr && !data.scan && !data.waiting) {
                         state = 'idle';
                     }
                     set_state(state);
@@ -192,14 +188,14 @@ function set_state(state) {
             /**
              * Event handler for the click event on the element with ID 'triggerFiles'.
              * Prevents the default action and performs an AJAX GET request to '/list.php'.
-             * 
+             *
              * On successful response:
              * - Populates the Offcanvas element with ID 'offcanvasContent' with the response content.
              * - Displays the Offcanvas element with ID 'offcanvasFiles'.
-             * 
+             *
              * On error:
              * - Logs an error message to the console.
-             * 
+             *
              * @param {Event} e - The click event object.
              */
             $('#triggerFiles').on('click', function(e) {
@@ -225,7 +221,6 @@ function set_state(state) {
         });
     </script>
 
-
 </body>
 
-</html>
+</html>
diff --git a/html/list.php b/html/list.php
@@ -3,6 +3,7 @@
 <div class="list-group list-group-flush border-bottom scrollarea">
 
 <?php
+
 // Directory path
 $directory = '/scans';
 
@@ -43,12 +44,12 @@
     <div class="col-12 mb-1 small"><?php echo number_format($attributes['size']); ?> Bytes</div>
   </a>
 <?php
-
 }
+
 ?>
 
 
-  
+
 </div>
 </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ @@
     <div class="list-group list-group-flush border-bottom scrollarea">
     <?php
     // Directory path
     $directory = '/scans';
@@ Expand Down Expand Up / @@ -43,12 +44,12 @@ @@
         <div class="col-12 mb-1 small"><?php echo number_format($attributes['size']); ?> Bytes</div>
       </a>
     <?php
     }
     ?>
     </div>
     </div>
@@ Expand Down @@