feat: add metadata, custom description and labels

Author: adrianschubek

README.md

@@ -34,6 +34,7 @@ https://bp.adriansoftware.de
 - Secure by default. **Read-only** access
 - Extremly **fast** file serving through **nginx**
 - **README** markdown rendering support
+- add **custom description and labels** to files and folders
 - **Low memory** footprint (~10MB)
 - Light and **Darkmode**
 - Many **Themes** available
@@ -64,4 +65,10 @@ diretly embed pohpo in nginx maximum performance
 
 - when path contains a dot it triggers full reload -> turbolinks
 
+
+TODO Features:
+- add descripton,labels metadata in item use <file/folder>.dbmeta.json
+
+- replace github utpp download with npm i -g utpp
+
 -->

docs/docs/configuration/php.md docs/docs/advanced/php.mddocs/docs/configuration/php.md renamed to docs/docs/advanced/php.md

@@ -0,0 +1,36 @@
+---
+sidebar_position: -1
+---
+
+import Image from "@theme/IdealImage";
+
+# Metadata
+
+Files and folder can be enriched with metadata and displayed. Metadata is stored in a file called `<name>.dbmeta.json`, where `<name>` is the exact file/folder name, in the same folder as the file or folder. Metadata is stored in a JSON format specified below. 
+
+The `*.dbmeta.json` files are hidden from the user and cannot be viewed.
+
+<!-- This feature is enabled by default. To disable this, set the environment variable `NO_METADATA` to `true` when starting the container. -->
+
+<Image img={require("@site/static/img/metadata.png")} />
+
+```json title="/foo   bar/cool project.dbmeta.json"
+{
+  "description": "A short project description ⭐",
+  "labels": ["danger:Laravel", "primary:PHP 8", "dark:Hot 🔥"]
+}
+```
+<!-- TODO: "password": "mysecurepassword" -->
+
+#### Labels
+
+Labels always start with a style and a colon `:`, followed by the label text. The following styles are available:
+- `primary`
+- `secondary`
+- `success`
+- `danger`
+- `warning`
+- `info`
+- `light`
+- `dark`
+

docs/docs/configuration/metadata.md

@@ -2,7 +2,6 @@
 sidebar_position: 1
 ---
 # Roadmap
-- [ ] support timezones other than UTC e.g. EST
-- [ ] support relative timestamps e.g. '3 minutes ago'
+
 - [ ] File hashes
 - [ ] i18n: more languages

docs/docs/development/roadmap.md

@@ -16,6 +16,7 @@ https://bp.adriansoftware.de
 - Secure by default. **Read-only** access
 - Extremly **fast** file serving through **nginx**
 - **README** markdown rendering support
+- add **custom description and labels** to files and folders
 - **Low memory** footprint (~10MB)
 - Light and **Darkmode**
 - File **icons**

docs/docs/intro.md

@@ -211,7 +211,7 @@ const config = {
       prism: {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
-        additionalLanguages: ['php'],
+        additionalLanguages: ['php','json'],
         magicComments: [
           {
             className: 'theme-code-block-highlighted-line',

docs/docusaurus.config.js

@@ -1,6 +1,6 @@
 <?php
 
-define('VERSION', '2.2.1');
+define('VERSION', '2.3.0');
 
 define('PUBLIC_FOLDER', __DIR__ . '/public');
 
@@ -37,6 +37,7 @@ class File
   public bool $is_dir;
   public string $modified_date;
   public int $dl_count;
+  public ?object $meta;
 
   public function __toString(): string
   {
@@ -61,8 +62,8 @@ public function __toString(): string
   $sorted_files = [];
   $sorted_folders = [];
   foreach (($files = scandir($local_path)) as $file) {
-    // always skip current folder '.' or parent folder '..' if current path is root or file should be ignored
-    if ($file === '.' || $file === '..' && count($url_parts) === 0 $[if `process.env.IGNORE`]$|| $file !== '..' && fnmatch("${{`process.env.IGNORE ?? ""`}}$", $file)$[end]$) continue;
+    // always skip current folder '.' or parent folder '..' if current path is root or file should be ignored or .dbmeta.json
+    if ($file === '.' || $file === '..' && count($url_parts) === 0 $[if `process.env.IGNORE`]$|| $file !== '..' && fnmatch("${{`process.env.IGNORE ?? ""`}}$", $file)$[end]$ || str_contains($file, ".dbmeta.json")) continue;
 
     $[if `process.env.IGNORE`]$
     foreach ($url_parts as $int_path) { /* check if parent folders are hidden */
@@ -82,13 +83,20 @@ public function __toString(): string
 
     $file_modified_date = gmdate('Y-m-d\TH:i:s\Z', filemtime($local_path . '/' . $file));
 
+    // load metadata if file exists
+    $meta_file = realpath($local_path . '/' . $file . '.dbmeta.json');
+    if ($meta_file !== false) {
+      $meta = json_decode(file_get_contents($meta_file));
+    }
+
     $item = new File();
     $item->name = $file;
     $item->url = $url;
     $item->size = human_filesize($file_size);
     $item->is_dir = $is_dir;
     $item->modified_date = $file_modified_date;
     $item->dl_count =  $[if `!process.env.NO_DL_COUNT`]$!$is_dir ? $redis->get($url) :$[end]$ 0;
+    $item->meta = $meta ?? null;
     if ($is_dir) {
       array_push($sorted_folders, $item);
     } else {
@@ -120,6 +128,9 @@ public function __toString(): string
   }
   $[end]$
 
+  // skip if file is .dbmeta.json
+  if (str_contains($local_path, ".dbmeta.json")) goto skip;
+
   // increment redis view counter
   $[if `!process.env.NO_DL_COUNT`]$
   $redis = new Redis();
@@ -265,7 +276,24 @@ public function __toString(): string
                 </svg>
               </div>
             <?php } ?>
+            <span>
             <?= $file->name ?>
+            <?php 
+              if ($file->meta !== null) {
+                if ($file->meta->description !== null) {
+            ?> 
+                  <span class="text-body-secondary"><?= $file->meta->description ?></span>
+            <?php
+                }
+                foreach ($file->meta->labels as $lbl) {
+                  $l = explode(":", $lbl, 2);
+            ?>
+                  <span class="badge bg-<?= $l[0] ?>"><?= $l[1] ?></span>
+            <?php
+                }
+              }
+            ?>
+            </span>
             <?php if (!$file->is_dir) { ?>
               $[if `!process.env.NO_DL_COUNT`]$
               <span class="ms-auto d-none d-md-block border rounded-1 text-end px-1 <?= $file->dl_count === 0 ? "text-body-tertiary" : "" ?>">