Merge pull request #131 from Ente/plugin-perms

bryan-ente · web-flow · commit 40f2cdb2c722 · 2025-12-01T21:35:38.000+01:00
v8.4.2: user-based permissions for plugins
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v8.4.2
+
+* Added user based permissions for plugin views.
+* Updated plugins to use new permission system.
+
 ## v8.4.1
 
 **This update requires DB migration** - see `README.md` section `Database`
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-8.4.1
+8.4.2
diff --git a/api/v1/class/plugins/PluginBuilder.plugins.arbeit.inc.php b/api/v1/class/plugins/PluginBuilder.plugins.arbeit.inc.php
diff --git a/api/v1/class/plugins/docs/Plugins.md b/api/v1/class/plugins/docs/Plugins.md
@@ -44,6 +44,17 @@ These are optional values you can add, which might make things easier:
 - `build.instructions`: Allows you to add parameters to change the behaviour of the PluginBuilder.
   - `required`: An array containing relative paths to the required files, they will then get included within the archive (PHAR)
 - `nav_links`: If your plugin has a front-end, please specify this attribute. It is stored in key-value pairs, e.g. "Send Message": "views/send-message.php" - Views have to be always in the `/views` folder within your plugin folder
+- `nav_permissions`: Key-value pairs to restrict certain navigation links to certian permissions. E.g.:
+
+    ```yaml
+
+    nav_links:
+      Admin View: views/admin.php
+      User View: views/user.php
+    nav_permissions:
+      Admin View: 1
+      User View: 0
+    ```
 
 ### Permissions
 
diff --git a/api/v1/class/plugins/plugins/codeclock/plugin.yml b/api/v1/class/plugins/plugins/codeclock/plugin.yml
@@ -12,4 +12,7 @@ custom.values:
   license: "LIC"
 nav_links:
   View PIN: views/index.php
-  Admin View: views/admin.php
+  Admin View: views/admin.php
+nav_permissions:
+  View PIN: 0
+  Admin View: 1
diff --git a/api/v1/class/plugins/plugins/exportmanager/plugin.yml b/api/v1/class/plugins/plugins/exportmanager/plugin.yml
@@ -11,4 +11,6 @@ enabled: false
 custom.values:
   license: "LIC"
 nav_links:
-  Open ExportManager: views/redirect.php
+  Open ExportManager: views/redirect.php
+nav_permissions:
+  Open ExportManager: 1
diff --git a/api/v1/class/plugins/plugins/nfcclock/plugin.yml b/api/v1/class/plugins/plugins/nfcclock/plugin.yml
@@ -9,7 +9,10 @@ api: 0.1
 permissions: none
 enabled: true
 custom.values:
-    license: LIC
+  license: LIC
 nav_links:
-    'Open NFCClock': views/open.php
-    'Open About Page': views/index.php
+  'Open NFCClock': views/open.php
+  'Open About Page': views/index.php
+nav_permissions:
+  'Open NFCClock': 0
+  'Open About Page': 0
diff --git a/api/v1/class/plugins/plugins/nfclogin/plugin.yml b/api/v1/class/plugins/plugins/nfclogin/plugin.yml
@@ -9,6 +9,8 @@ api: 0.1
 permissions: none
 enabled: true
 custom.values:
-    license: LIC
+  license: LIC
 nav_links:
-    'Manage Cards': views/cards.php
+  'Manage Cards': views/cards.php
+nav_permissions:
+  'Manage Cards': 1
diff --git a/api/v1/class/plugins/plugins/pluginmanager/plugin.yml b/api/v1/class/plugins/plugins/pluginmanager/plugin.yml
@@ -11,4 +11,6 @@ enabled: true
 custom.values:
   license: "LIC"
 nav_links:
-  Open PluginManager: views/redirect.php
+  Open PluginManager: views/redirect.php
+nav_permissions:
+  Open PluginManager: 1
diff --git a/api/v1/class/plugins/plugins/qrclock/plugin.yml b/api/v1/class/plugins/plugins/qrclock/plugin.yml
@@ -11,4 +11,6 @@ enabled: false
 custom.values: 
   license: "LIC"
 nav_links:
-  Generate QR code: views/index.php
+  Generate QR code: views/index.php
+nav_permissions:
+  Generate QR code: 0
diff --git a/api/v1/class/plugins/plugins/userdetail/plugin.yml b/api/v1/class/plugins/plugins/userdetail/plugin.yml
@@ -11,4 +11,6 @@ enabled: true
 custom.values:
   license: "LIC"
 nav_links:
-  Open Userdetail: views/overview.php
+  Open Userdetail: views/overview.php
+nav_permissions:
+  Open Userdetail: 1
diff --git a/api/v1/class/plugins/plugins/utility/plugin.yml b/api/v1/class/plugins/plugins/utility/plugin.yml
@@ -12,3 +12,5 @@ custom.values:
     license: LIC
 nav_links:
     'Open Utility Plugin': views/overview.php
+nav_permissions:
+  'Open Utility Plugin': 1
diff --git a/assets/gui/standard_nav.php b/assets/gui/standard_nav.php
@@ -21,6 +21,9 @@
     <a href="http://<?= $base_url ?>/suite/worktime/all.php"><?= $lang["own_worktime"]; ?></a>
     <a href="http://<?= $base_url ?>/suite/notifications/all.php"><?= $lang["notifications"]; ?></a>
     <a href="http://<?= $base_url ?>/suite/projects/overview.php"><?= $lang["projects"] ?></a>
+    <?php if($ini["plugins"]["plugins"] == "true") : ?>
+      <a href="http://<?= $base_url ?>/suite/plugins/index.php" target="_blank"><?= $lang["a_plugins"]; ?></a>
+    <?php endif; ?>
 
     <?php if (@$user->is_Admin($user->get_user(@$_SESSION["username"]))) : 
         $v = file_get_contents($_SERVER["DOCUMENT_ROOT"] . "/VERSION"); ?>
@@ -29,9 +32,6 @@
         <a href="http://<?= $base_url ?>/suite/admin/worktime/sick/all.php"><?= $lang["a_sickness"]; ?></a>
         <a href="http://<?= $base_url ?>/suite/admin/worktime/vacation/all.php"><?= $lang["a_vacation"]; ?></a>
         <a href="http://<?= $base_url ?>/suite/admin/projects/admin.php"><?= $lang["a_projects"]; ?></a>
-        <?php if($ini["plugins"]["plugins"] == "true") : ?>
-        <a href="http://<?= $base_url ?>/suite/plugins/index.php" target="_blank"><?= $lang["a_plugins"]; ?></a>
-        <?php endif; ?>
         <span class="nav-version">ADMIN | <?= htmlspecialchars($v); ?></span>
     <?php endif; ?>
   </div>
diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
   "description": "TimeTrack is a PHP-written time recording tool for small businesses",
   "type": "software",
   "license": "GNU GPL",
-  "version": "8.4.1",
+  "version": "8.4.2",
   "authors": [
     {
       "name": "Bryan Boehnke-Avan",
