✨ Add dedicated file check permission

Author: foosel

octoprint_file_check/__init__.py

@@ -15,6 +15,7 @@
 import octoprint.plugin
 import sarge
 from flask_babel import gettext
+from octoprint.access import ADMIN_GROUP, USER_GROUP
 from octoprint.filemanager import get_file_type
 
 CHECKS = {
@@ -107,7 +108,7 @@ def on_event(self, event, payload):
     ##~~ SimpleApiPlugin API
 
     def on_api_get(self, request):
-        if not octoprint.access.permissions.Permissions.FILES_DOWNLOAD.can():
+        if not octoprint.access.permissions.Permissions.PLUGIN_FILE_CHECK_RUN.can():
             return flask.make_response("Insufficient rights", 403)
 
         response = {
@@ -121,7 +122,7 @@ def get_api_commands(self):
 
     def on_api_command(self, command, data):
         if command == "check_all":
-            if not octoprint.access.permissions.Permissions.FILES_DOWNLOAD.can():
+            if not octoprint.access.permissions.Permissions.PLUGIN_FILE_CHECK_RUN.can():
                 return flask.make_response("Insufficient rights", 403)
 
             self._start_full_check()
@@ -130,6 +131,19 @@ def on_api_command(self, command, data):
                 headers={"Location": flask.url_for("index") + "api/plugin/file_check"},
             )
 
+    ##~~ Additional permissions hook
+
+    def get_additional_permissions(self):
+        return [
+            {
+                "key": "RUN",
+                "name": "Run File Check",
+                "description": gettext("Allows to run File Check and view the results."),
+                "default_groups": [USER_GROUP, ADMIN_GROUP],
+                "roles": ["run"],
+            }
+        ]
+
     ##~~ SoftwareUpdate hook
 
     def get_update_information(self):
@@ -322,5 +336,6 @@ def _trigger_check_update(self):
 
 __plugin_implementation__ = FileCheckPlugin()
 __plugin_hooks__ = {
-    "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
+    "octoprint.access.permissions": __plugin_implementation__.get_additional_permissions,
+    "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information,
 }

octoprint_file_check/static/js/file_check.js

@@ -37,7 +37,11 @@ $(function () {
         };
 
         self.requestData = function () {
-            if (!self.loginState.hasPermission(self.access.permissions.FILES_DOWNLOAD))
+            if (
+                !self.loginState.hasPermission(
+                    self.access.permissions.PLUGIN_FILE_CHECK_RUN
+                )
+            )
                 return $.Deferred().reject();
             return OctoPrint.plugins.file_check.get().done(self.fromResponse);
         };
@@ -58,7 +62,11 @@ $(function () {
         };
 
         self.checkAll = function () {
-            if (!self.loginState.hasPermission(self.access.permissions.FILES_DOWNLOAD))
+            if (
+                !self.loginState.hasPermission(
+                    self.access.permissions.PLUGIN_FILE_CHECK_RUN
+                )
+            )
                 return;
 
             showConfirmationDialog({
@@ -90,12 +98,18 @@ $(function () {
             return (
                 self.checkResult() &&
                 self.checkResult()[key] &&
-                self.loginState.hasPermission(self.access.permissions.FILES_DOWNLOAD)
+                self.loginState.hasPermission(
+                    self.access.permissions.PLUGIN_FILE_CHECK_RUN
+                )
             );
         };
 
         self.showCheckResult = function (storage, file) {
-            if (!self.loginState.hasPermission(self.access.permissions.FILES_DOWNLOAD))
+            if (
+                !self.loginState.hasPermission(
+                    self.access.permissions.PLUGIN_FILE_CHECK_RUN
+                )
+            )
                 return;
 
             if (_.isPlainObject(storage)) {
@@ -150,7 +164,11 @@ $(function () {
         self.onDataUpdaterPluginMessage = function (plugin, data) {
             if (plugin !== "file_check") return;
 
-            if (!self.loginState.hasPermission(self.access.permissions.FILES_DOWNLOAD))
+            if (
+                !self.loginState.hasPermission(
+                    self.access.permissions.PLUGIN_FILE_CHECK_RUN
+                )
+            )
                 return;
 
             switch (data["action"]) {
@@ -231,7 +249,7 @@ $(function () {
                     class: "filecheck-trigger accordion-heading-button btn-group",
                     attr: {
                         "data-bind":
-                            "visible: $root.fileCheckViewModel.fullCheckAvailable() && $root.loginState.hasPermission($root.access.permissions.FILES_DOWNLOAD)"
+                            "visible: $root.fileCheckViewModel.fullCheckAvailable() && $root.loginState.hasPermission($root.access.permissions.PLUGIN_FILE_CHECK_RUN)"
                     }
                 }).append(
                     $("<a/>", {
@@ -256,7 +274,7 @@ $(function () {
 
             const regex = /<div class="uploaded">/;
             const template =
-                "<div class='filecheck_result' data-bind='visible: $root.fileCheckViewModel.hasCheckResult($data) && $root.loginState.hasPermission($root.access.permissions.FILES_DOWNLOAD)'><small>" +
+                "<div class='filecheck_result' data-bind='visible: $root.fileCheckViewModel.hasCheckResult($data) && $root.loginState.hasPermission($root.access.permissions.PLUGIN_FILE_CHECK_RUN)'><small>" +
                 "<a href='javascript:void(0)' class='text-error' style='text-decoration: underline' data-bind='click: function() { $root.fileCheckViewModel.showCheckResult($data) }'>" +
                 "<i class='fas fa-exclamation-circle'></i> " +
                 gettext("File Check detected issues with this file!") +
@@ -272,7 +290,7 @@ $(function () {
                 $("<small/>", {
                     attr: {
                         "data-bind":
-                            "visible: $root.fileCheckViewModel.hasCheckResult($root.filepath()) && $root.loginState.hasPermission($root.access.permissions.FILES_DOWNLOAD)"
+                            "visible: $root.fileCheckViewModel.hasCheckResult($root.filepath()) && $root.loginState.hasPermission($root.access.permissions.PLUGIN_FILE_CHECK_RUN)"
                     }
                 })
                     .append(