Merge pull request #25 from Josef-MrBeam/stable

Stable pre release

Author: JFSolution

.gitattributes

@@ -0,0 +1 @@
+octoprint_mrbeam/_version.py export-subst

.gitignore

@@ -40,3 +40,4 @@ venv/
 tests/rsc/camera/debug/[^R]*
 tests/rsc/camera/out.jpg
 tests/logs/*.txt
+*pytest-logs.txt

MANIFEST.in

@@ -1,5 +1,8 @@
 include README.md
+include versioneer.py
+include octoprint_mrbeam/_version.py
 graft octoprint_mrbeam/templates
 graft octoprint_mrbeam/static
 graft octoprint_mrbeam/state
 graft octoprint_mrbeam/translations
+graft octoprint_mrbeam/scripts

octoprint_mrbeam/__init__.py

@@ -4,6 +4,7 @@
 import __builtin__
 import copy
 import json
+import operator
 import os
 import platform
 import pprint
@@ -13,7 +14,9 @@
 import datetime
 import collections
 import logging
+import unicodedata
 from subprocess import check_output
+import pkg_resources
 
 import octoprint.plugin
 import requests
@@ -31,9 +34,18 @@
 from octoprint.settings import settings
 from octoprint.events import Events as OctoPrintEvents
 
+from octoprint_mrbeam.rest_handler.update_handler import UpdateRestHandlerMixin
+from octoprint_mrbeam.util.connectivity_checker import ConnectivityChecker
+
 IS_X86 = platform.machine() == "x86_64"
+from ._version import get_versions
+
+__version__ = get_versions()["version"]
+if isinstance(__version__, unicode):
+    __version__ = unicodedata.normalize('NFKD', __version__).encode('ascii', 'ignore')
+
+del get_versions
 
-from octoprint_mrbeam.__version import __version__
 from octoprint_mrbeam.iobeam.iobeam_handler import ioBeamHandler, IoBeamEvents
 from octoprint_mrbeam.iobeam.onebutton_handler import oneButtonHandler
 from octoprint_mrbeam.iobeam.interlock_handler import interLockHandler
@@ -43,6 +55,7 @@
 from octoprint_mrbeam.iobeam.hw_malfunction_handler import hwMalfunctionHandler
 from octoprint_mrbeam.iobeam.laserhead_handler import laserheadHandler
 from octoprint_mrbeam.iobeam.compressor_handler import compressor_handler
+from octoprint_mrbeam.jinja.filter_loader import FilterLoader
 from octoprint_mrbeam.user_notification_system import user_notification_system
 from octoprint_mrbeam.analytics.analytics_handler import analyticsHandler
 from octoprint_mrbeam.analytics.usage_handler import usageHandler
@@ -53,6 +66,10 @@
 from octoprint_mrbeam.mrb_logger import init_mrb_logger, mrb_logger
 from octoprint_mrbeam.migrate import migrate
 from octoprint_mrbeam.os_health_care import os_health_care
+from octoprint_mrbeam.rest_handler.docs_handler import DocsRestHandlerMixin
+from octoprint_mrbeam.services.settings_service import SettingsService
+from octoprint_mrbeam.services.burger_menu_service import BurgerMenuService
+from octoprint_mrbeam.services.document_service import DocumentService
 from octoprint_mrbeam.wizard_config import WizardConfig
 from octoprint_mrbeam.printing.profile import (
     laserCutterProfileManager,
@@ -64,10 +81,8 @@
     get_update_information,
     switch_software_channel,
     software_channels_available,
-    SW_UPDATE_TIER_PROD,
-    SW_UPDATE_TIER_BETA,
-    SW_UPDATE_TIER_DEV,
     BEAMOS_LEGACY_DATE,
+    SWUpdateTier,
 )
 from octoprint_mrbeam.support import check_support_mode, check_calibration_tool_mode
 from octoprint_mrbeam.cli import get_cli_commands
@@ -91,6 +106,7 @@
 from octoprint_mrbeam.util.uptime import get_uptime, get_uptime_human_readable
 from octoprint_mrbeam.util import get_thread
 from octoprint_mrbeam import camera
+from octoprint_mrbeam.util.version_comparator import compare_pep440_versions
 
 # this is a easy&simple way to access the plugin and all injections everywhere within the plugin
 __builtin__._mrbeam_plugin_implementation = None
@@ -110,6 +126,8 @@ class MrBeamPlugin(
     octoprint.plugin.SlicerPlugin,
     octoprint.plugin.ShutdownPlugin,
     octoprint.plugin.EnvironmentDetectionPlugin,
+    UpdateRestHandlerMixin,
+    DocsRestHandlerMixin,
 ):
     # CONSTANTS
     ENV_PROD = "PROD"
@@ -144,6 +162,7 @@ class MrBeamPlugin(
     TIME_NTP_SYNC_CHECK_INTERVAL_FAST = 10.0
     TIME_NTP_SYNC_CHECK_INTERVAL_SLOW = 120.0
 
+
     def __init__(self):
         self.mrbeam_plugin_initialized = False
         self._shutting_down = False
@@ -164,6 +183,7 @@ def __init__(self):
         self._serial_num = None
         self._mac_addrs = dict()
         self._model_id = None
+        self._explicit_update_check = False
         self._grbl_version = None
         self._device_series = self._device_info.get_series()
         self.called_hosts = []
@@ -186,6 +206,9 @@ def __init__(self):
         # MrBeam Events needs to be registered in OctoPrint in order to be send to the frontend later on
         MrBeamEvents.register_with_octoprint()
 
+        # Jinja custom filters need to be loaded already on instance creation
+        FilterLoader.load_custom_jinja_filters()
+
     # inside initialize() OctoPrint is already loaded, not assured during __init__()!
     def initialize(self):
         self._plugin_version = __version__
@@ -243,10 +266,10 @@ def initialize(self):
         self.led_event_listener.set_fps(self._settings.get(["leds", "fps"]))
         # start iobeam socket only once other handlers are already initialized so that we can handle info message
         self.iobeam = ioBeamHandler(self)
-        self.temperature_manager = temperatureManager(self)
         self.dust_manager = dustManager(self)
         self.hw_malfunction_handler = hwMalfunctionHandler(self)
         self.laserhead_handler = laserheadHandler(self)
+        self.temperature_manager = temperatureManager(self)
         self.compressor_handler = compressor_handler(self)
         self.wizard_config = WizardConfig(self)
         self.job_time_estimation = JobTimeEstimation(self)
@@ -256,6 +279,10 @@ def initialize(self):
         self.mrbeam_plugin_initialized = True
         self.fire_event(MrBeamEvents.MRB_PLUGIN_INITIALIZED)
 
+        # move octoprints connectivity checker to a new var so we can use our abstraction
+        self._octoprint_connectivity_checker = self._connectivity_checker
+        self._connectivity_checker = ConnectivityChecker(self)
+
         self._do_initial_log()
 
     def _init_frontend_logger(self):
@@ -368,7 +395,7 @@ def get_settings_defaults(self):
                 terminalMaxLines=2000,
                 env=self.ENV_PROD,
                 load_gremlins=False,
-                software_tier=SW_UPDATE_TIER_PROD,
+                software_tier=SWUpdateTier.STABLE.value,
                 iobeam_disable_warnings=False,  # for development on non-MrBeam devices
                 suppress_migrations=False,  # for development on non-MrBeam devices
                 support_mode=False,
@@ -454,7 +481,9 @@ def on_settings_load(self):
             dev=dict(
                 env=self.get_env(),
                 software_tier=self._settings.get(["dev", "software_tier"]),
-                software_tiers_available=software_channels_available(self),
+                software_tiers_available=[
+                    channel for channel in software_channels_available(self)
+                ],
                 terminalMaxLines=self._settings.get(["dev", "terminalMaxLines"]),
             ),
             gcode_nextgen=dict(
@@ -694,7 +723,7 @@ def get_assets(self):
                 "css/hopscotch.min.css",
                 "css/wizard.css",
                 "css/tab_messages.css",
-                "css/software_update.css"
+                "css/software_update.css",
             ],
             less=["less/mrbeam.less"],
         )
@@ -718,6 +747,16 @@ def calibration_tool_mode(self):
         self._fixEmptyUserManager()
         return ret
 
+    @property
+    def explicit_update_check(self):
+        return self._explicit_update_check
+
+    def set_explicit_update_check(self):
+        self._explicit_update_check = True
+
+    def clear_explicit_update_check(self):
+        self._explicit_update_check = False
+
     ##~~ UiPlugin mixin
 
     def will_handle_ui(self, request):
@@ -791,7 +830,7 @@ def on_ui_render(self, now, request, render_kwargs):
                 now=now,
                 init_ts_ms=time.time() * 1000,
                 language=language,
-                beamosVersionNumber=self._plugin_version,
+                mrBeamPluginVersionNumber=self._plugin_version,
                 beamosVersionBranch=self._branch,
                 beamosVersionDisplayVersion=display_version_string,
                 beamosVersionImage=self._octopi_info,
@@ -818,6 +857,10 @@ def on_ui_render(self, now, request, render_kwargs):
                 terminalEnabled=self._settings.get(["terminal"]) or self.support_mode,
                 lasersafety_confirmation_dialog_version=self.LASERSAFETY_CONFIRMATION_DIALOG_VERSION,
                 lasersafety_confirmation_dialog_language=language,
+                settings_model=SettingsService(self._logger, DocumentService(self._logger)).get_template_settings_model(
+                    self.get_model_id()),
+                burger_menu_model=BurgerMenuService(self._logger, DocumentService(self._logger)).get_burger_menu_model(
+                    self.get_model_id()),
             )
         )
         r = make_response(render_template("mrbeam_ui_index.jinja2", **render_kwargs))
@@ -1257,6 +1300,16 @@ def generate_backlash_compenation_pattern_gcode(self, data):
             res = dict(calibration_pattern=destFile, target=FileDestinations.LOCAL)
             return jsonify(res)
 
+    # simpleApiCommand: compare_pep440_versions;
+    def handle_pep440_comparison_result(self, data):
+        try:
+            result = compare_pep440_versions(data['v1'], data['v2'], data['operator'])
+            return make_response(json.dumps(result), 200)
+        except KeyError as e:
+            self._logger.error("Key is missing in data: %s", e)
+            return make_response(json.dumps(None), 500)
+
+
     # ~~ helpers
 
     # helper method to write data to user settings
@@ -1323,7 +1376,7 @@ def calibration_wrapper(self):
             locales=dict(),
             supportedExtensions=[],
             # beamOS version
-            beamosVersionNumber=self._plugin_version,
+            mrBeamPluginVersionNumber=self._plugin_version,
             beamosVersionBranch=self._branch,
             beamosVersionDisplayVersion=display_version_string,
             beamosVersionImage=self._octopi_info,
@@ -1889,6 +1942,7 @@ def get_api_commands(self):
             camera_stop_lens_calibration=[],
             generate_calibration_markers_svg=[],
             cancel_final_extraction=[],
+            compare_pep440_versions=[]
         )
 
     def on_api_command(self, command, data):
@@ -2016,6 +2070,8 @@ def on_api_command(self, command, data):
             )  # TODO move this func to other file
         elif command == "cancel_final_extraction":
             self.dust_manager.set_user_abort_final_extraction()
+        elif command == "compare_pep440_versions":
+            return self.handle_pep440_comparison_result(data)
 
         return NO_CONTENT
 
@@ -2957,10 +3013,10 @@ def __calc_time_ntp_offset(self, log_out_of_sync=False):
                 timer.start()
 
     def is_beta_channel(self):
-        return self._settings.get(["dev", "software_tier"]) == SW_UPDATE_TIER_BETA
+        return self._settings.get(["dev", "software_tier"]) == SWUpdateTier.BETA.value
 
     def is_develop_channel(self):
-        return self._settings.get(["dev", "software_tier"]) == SW_UPDATE_TIER_DEV
+        return self._settings.get(["dev", "software_tier"]) == SWUpdateTier.DEV.value
 
     def _get_mac_addresses(self):
         if not self._mac_addrs: