✨ Add ability to disable selected checks

Author: foosel

octoprint_file_check/__init__.py

@@ -86,6 +86,13 @@ def on_event(self, event, payload):
                 self._validate_file, payload["origin"], payload["path"], file_type
             )
 
+    ##~~ SettingsPlugin API
+
+    def get_settings_defaults(self):
+        return {
+            "ignored_checks": [],
+        }
+
     ##~~ SimpleApiPlugin API
 
     def on_api_get(self, request):
@@ -128,22 +135,24 @@ def on_api_command(self, command, data):
     ##~~ TemplatePlugin API
 
     def get_template_configs(self):
-        if not self._native_grep_available:
-            return []
-
-        return [
-            dict(
-                type="wizard",
-                template="file_check_wizard_grep.jinja2",
-                custom_bindings=True,
-            ),
-            dict(
-                type="settings",
-                template="file_check_settings_grep.jinja2",
-                custom_bindings=True,
-            ),
+        templates = [
+            {
+                "type": "settings",
+                "custom_bindings": True,
+            }
         ]
 
+        if self._native_grep_available:
+            templates.append(
+                {
+                    "type": "wizard",
+                    "template": "file_check_wizard_fullcheck.jinja2",
+                    "custom_bindings": True,
+                }
+            )
+
+        return templates
+
     ##~~ WizardPlugin API
 
     def is_wizard_required(self):
@@ -222,9 +231,12 @@ def _check_all_files(self):
         with self._full_check_lock:
             path = self._settings.global_get_basefolder("uploads")
             self._logger.info(f"Running check on all files in {path} (local storage)")
+            ignored_checks = self._settings.get(["ignored_checks"])
 
             full_check_result = defaultdict(list)
             for check, params in CHECKS.items():
+                if check in ignored_checks:
+                    continue
                 self._logger.info(f"Running check {check}")
                 pattern = params["pattern"]
                 sanitized = self._sanitize_pattern(
@@ -305,8 +317,13 @@ def _validate_file(self, storage, path, file_type):
         if file_type[-1] != "gcode":
             return
 
+        ignored_checks = self._settings.get(["ignored_checks"])
+
         types = []
         for check, params in CHECKS.items():
+            if check in ignored_checks:
+                continue
+
             pattern = params["pattern"]
             if self._search_through_file(
                 path_on_disk,
@@ -392,32 +409,42 @@ def _save_to_metadata(self, storage, path, positive_checks):
     def _gather_from_local_metadata(self):
         uploads = self._settings.global_get_basefolder("uploads")
 
+        ignored_checks = self._settings.get(["ignored_checks"])
+
         result = {}
         for path in glob.glob(
             os.path.join(uploads, "**", ".metadata.json"), recursive=True
         ):
             internal_path = path[len(uploads) + 1 : -len(".metadata.json")]
-            from_metadata = self._gather_metadata_from_file(path)
+            from_metadata = self._gather_metadata_from_file(
+                path, ignored_checks=ignored_checks
+            )
             result.update(
                 {f"local:{internal_path}{k}": v for k, v in from_metadata.items()}
             )
         return result
 
-    def _gather_metadata_from_file(self, path):
+    def _gather_metadata_from_file(self, path, ignored_checks=None):
         with open(path, encoding="utf-8") as f:
             metadata = json.load(f)
 
         if not isinstance(metadata, dict):
             return {}
 
+        if ignored_checks is None:
+            ignored_checks = self._settings.get(["ignored_checks"])
+
         result = {}
         for key, value in metadata.items():
-            if (
-                "file_check" in value
-                and isinstance(value["file_check"], dict)
-                and len(value["file_check"].get("checks", []))
-            ):
-                result[key] = value["file_check"]["checks"]
+            if "file_check" in value and isinstance(value["file_check"], dict):
+                filtered = list(
+                    filter(
+                        lambda x: x not in ignored_checks,
+                        value["file_check"].get("checks", []),
+                    )
+                )
+                if len(filtered) > 0:
+                    result[key] = filtered
         return result
 
 

octoprint_file_check/static/js/file_check.js

@@ -4,8 +4,9 @@ $(function () {
 
         self.loginState = parameters[0];
         self.access = parameters[1];
-        self.printerState = parameters[2];
-        self.filesViewModel = parameters[3];
+        self.settingsViewModel = parameters[2];
+        self.printerState = parameters[3];
+        self.filesViewModel = parameters[4];
 
         self.fullCheckAvailable = ko.observable(false);
         self.checkResult = ko.observable();
@@ -18,6 +19,7 @@ $(function () {
 
         const ISSUES = {
             travel_speed: {
+                title: gettext("Travel Speed Placeholder"),
                 message: gettext(
                     "Your file still contains a place holder <code>{travel_speed}</code>. " +
                         "This is a common issue when using old start/stop GCODE code snippets in current versions of " +
@@ -27,6 +29,7 @@ $(function () {
                 )
             },
             leaked_api_key: {
+                title: gettext("Leaked API Key"),
                 message: gettext(
                     "Your file contains an API key that is not supposed to be there. " +
                         "This is caused by a bug in your slicer, and known to happen with PrusaSlicer (<= 2.1.1), " +
@@ -39,6 +42,34 @@ $(function () {
             }
         };
 
+        self.checksArray = ko.pureComputed(() => {
+            return Object.keys(ISSUES).map((key) => {
+                return {
+                    key: key,
+                    title: ISSUES[key].title,
+                    message: ISSUES[key].message,
+                    enabled: ko.pureComputed({
+                        read: () => {
+                            return !self.settingsViewModel.settings.plugins.file_check
+                                .ignored_checks()
+                                .includes(key);
+                        },
+                        write: (value) => {
+                            if (value) {
+                                self.settingsViewModel.settings.plugins.file_check.ignored_checks.remove(
+                                    key
+                                );
+                            } else {
+                                self.settingsViewModel.settings.plugins.file_check.ignored_checks.push(
+                                    key
+                                );
+                            }
+                        }
+                    })
+                };
+            });
+        });
+
         self.lastCheckTimestampText = ko.pureComputed(() => {
             return formatDate(self.lastCheckTimestamp(), {
                 placeholder: gettext("unknown")
@@ -47,9 +78,9 @@ $(function () {
 
         self.lastCheckStateText = ko.pureComputed(() => {
             if (self.lastCheckCurrent()) {
-                return gettext("Current set of checks");
+                return gettext("Up to date");
             } else {
-                return gettext("Outdated set of checks");
+                return gettext("Outdated");
             }
         });
 
@@ -308,6 +339,14 @@ $(function () {
             );
         };
 
+        self.onAfterBinding = function () {
+            self.settingsViewModel.settings.plugins.file_check.ignored_checks.subscribe(
+                () => {
+                    self.requestData();
+                }
+            );
+        };
+
         self.onUserLoggedIn = self.onUserLoggedOut = function () {
             self.requestData();
         };
@@ -318,6 +357,7 @@ $(function () {
         dependencies: [
             "loginStateViewModel",
             "accessViewModel",
+            "settingsViewModel",
             "printerStateViewModel",
             "filesViewModel"
         ],

octoprint_file_check/templates/file_check_settings.jinja2

@@ -0,0 +1,30 @@
+<fieldset>
+    <legend>{{ _("Configured checks") }}</legend>
+
+    <p>{% trans %}
+        The following checks are currently configured for your instance. You can enable or disable them as needed.
+    {% endtrans %}</p>
+
+    <form class="form-horizontal" onsubmit="return false;" data-bind="foreach: checksArray">
+        <div class="control-group">
+            <div class="controls">
+                <label class="checkbox">
+                    <input type="checkbox" data-bind="checked: $data.enabled"> <span data-bind="text: $data.title"></span>
+                </label>
+            </div>
+        </div>
+    </form>
+</fieldset>
+
+<fieldset data-bind="visible: fullCheckAvailable">
+    <legend>{{ _("Full file check") }}</legend>
+
+    <p>{% trans %}
+        The bundled File Check plugin allows checking your uploaded files for known slicer misconfigurations and related issues.
+        The plugin automatically checks all freshly uploaded files and files selected for printing, but for already uploaded
+        files you can also trigger a full file check manually. It is recommended to do this whenever new checks are added
+        to the plugin, in which case your last check will be marked as outdated below.
+    {% endtrans %}</p>
+
+    {% include "snippets/fileCheckButton.jinja2" %}
+</fieldset>