From b4d7dcd6841bbd5abf0737e3dd899a99b6dddd21 Mon Sep 17 00:00:00 2001 From: Teja Date: Wed, 2 Mar 2022 16:56:48 +0100 Subject: [PATCH 01/15] SW-889 Text elements error message, though the text elements are empty (#1422) - removes empty text elements by checking the rendering dimensions --- octoprint_mrbeam/static/js/working_area.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/octoprint_mrbeam/static/js/working_area.js b/octoprint_mrbeam/static/js/working_area.js index 0caecdbb7..07b192375 100644 --- a/octoprint_mrbeam/static/js/working_area.js +++ b/octoprint_mrbeam/static/js/working_area.js @@ -939,6 +939,14 @@ $(function () { newSvg.unref(true); + // remove non-visible text elements (no text, TODO: just whitespace) + const textElements = newSvg.selectAll("text"); + textElements.forEach((t) => { + const bb = t.getBBox(); + if (bb.width === 0 || bb.height === 0) { + t.remove(); + } + }); // handle texts var hasText = newSvg.selectAll("text,tspan"); if (hasText && hasText.length > 0) { From 5df70820ffb973da96359938b364041c5541dd0b Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Wed, 30 Mar 2022 14:39:25 +0200 Subject: [PATCH 02/15] SW-527 Mr beam tag based updates (#1448) * SW-827 add docs endpoint to serve the documents comming from MrBeamDoc (#1415) * SW-653 mr beam to use update config from cloud (#1389) * SW-994 added versioneer (#1442) * SW-653 fixed offline config to not show mrbeamdoc (#1443) * SW-649 create update script for mrbeam plugin (#1438) * SW-1171 include alpha releases of the dependencies Co-authored-by: Josef-mrbeam Co-authored-by: Yelko-mrbeam <92720803+Yelko-mrbeam@users.noreply.github.com> --- .gitattributes | 1 + .gitignore | 1 + MANIFEST.in | 3 + octoprint_mrbeam/__init__.py | 42 +- octoprint_mrbeam/__version.py | 1 - octoprint_mrbeam/_version.py | 520 +++++ .../analytics/analytics_handler.py | 2 +- octoprint_mrbeam/dependencies.txt | 4 + octoprint_mrbeam/jinja/__init__.py | 0 octoprint_mrbeam/jinja/filter/__init__.py | 0 octoprint_mrbeam/jinja/filter/sort_filters.py | 9 + octoprint_mrbeam/jinja/filter_loader.py | 12 + octoprint_mrbeam/migrate.py | 20 +- octoprint_mrbeam/migration/Mig002.py | 74 + octoprint_mrbeam/migration/__init__.py | 5 + octoprint_mrbeam/migration/migration_base.py | 26 +- octoprint_mrbeam/model/__init__.py | 0 octoprint_mrbeam/model/burger_menu_model.py | 10 + octoprint_mrbeam/model/document_model.py | 35 + octoprint_mrbeam/model/settings_model.py | 20 + octoprint_mrbeam/rest_handler/__init__.py | 0 octoprint_mrbeam/rest_handler/docs_handler.py | 33 + .../rest_handler/update_handler.py | 16 + octoprint_mrbeam/scripts/update_script.py | 480 +++++ octoprint_mrbeam/services/__init__.py | 0 .../services/burger_menu_service.py | 39 + octoprint_mrbeam/services/document_service.py | 57 + octoprint_mrbeam/services/settings_service.py | 35 + .../software_update_information.py | 762 ++++--- octoprint_mrbeam/static/css/mrbeam.css | 7 + .../static/js/software_channel_selector.js | 26 +- .../static/js/user_notification_viewmodel.js | 24 + .../templates/mrbeam_ui_index.jinja2 | 10 +- .../templates/settings/about_settings.jinja2 | 38 +- octoprint_mrbeam/util/connectivity_checker.py | 48 + octoprint_mrbeam/util/github_api.py | 58 + octoprint_mrbeam/util/pip_util.py | 40 + octoprint_mrbeam/util/string_util.py | 11 + pytest.ini | 2 +- setup.cfg | 15 + setup.py | 9 +- tests/__init__.py | 0 tests/logger/__init__.py | 0 tests/logger/test_logger.py | 33 + tests/migrations/test-migration-Mig001.py | 32 +- tests/migrations/test-migration-Mig002.py | 29 + tests/rest_handler/__init__.py | 0 tests/rest_handler/test_docs_handler.py | 45 + tests/services/__init__.py | 0 tests/services/test_burger_menu_service.py | 54 + tests/services/test_settings_service.py | 57 + tests/softwareupdate/__init__.py | 0 tests/softwareupdate/mock_config.json | 156 ++ .../target_find_my_mr_beam_config.json | 62 + .../softwareupdate/target_mrbeam_config.json | 113 + .../target_netconnectd_config.json | 84 + .../target_octoprint_config.json | 142 ++ tests/softwareupdate/test_cloud_config.py | 574 ++++++ tests/softwareupdate/test_dependencies.py | 16 + tests/util/__init__.py | 0 tests/util/test_string_util.py | 44 + versioneer.py | 1822 +++++++++++++++++ 62 files changed, 5411 insertions(+), 347 deletions(-) create mode 100644 .gitattributes delete mode 100644 octoprint_mrbeam/__version.py create mode 100644 octoprint_mrbeam/_version.py create mode 100644 octoprint_mrbeam/dependencies.txt create mode 100644 octoprint_mrbeam/jinja/__init__.py create mode 100644 octoprint_mrbeam/jinja/filter/__init__.py create mode 100644 octoprint_mrbeam/jinja/filter/sort_filters.py create mode 100644 octoprint_mrbeam/jinja/filter_loader.py create mode 100644 octoprint_mrbeam/migration/Mig002.py create mode 100644 octoprint_mrbeam/model/__init__.py create mode 100644 octoprint_mrbeam/model/burger_menu_model.py create mode 100644 octoprint_mrbeam/model/document_model.py create mode 100644 octoprint_mrbeam/model/settings_model.py create mode 100644 octoprint_mrbeam/rest_handler/__init__.py create mode 100644 octoprint_mrbeam/rest_handler/docs_handler.py create mode 100644 octoprint_mrbeam/rest_handler/update_handler.py create mode 100644 octoprint_mrbeam/scripts/update_script.py create mode 100644 octoprint_mrbeam/services/__init__.py create mode 100644 octoprint_mrbeam/services/burger_menu_service.py create mode 100644 octoprint_mrbeam/services/document_service.py create mode 100644 octoprint_mrbeam/services/settings_service.py create mode 100644 octoprint_mrbeam/util/connectivity_checker.py create mode 100644 octoprint_mrbeam/util/github_api.py create mode 100644 octoprint_mrbeam/util/string_util.py create mode 100644 setup.cfg create mode 100644 tests/__init__.py create mode 100644 tests/logger/__init__.py create mode 100644 tests/logger/test_logger.py create mode 100644 tests/migrations/test-migration-Mig002.py create mode 100644 tests/rest_handler/__init__.py create mode 100644 tests/rest_handler/test_docs_handler.py create mode 100644 tests/services/__init__.py create mode 100644 tests/services/test_burger_menu_service.py create mode 100644 tests/services/test_settings_service.py create mode 100644 tests/softwareupdate/__init__.py create mode 100644 tests/softwareupdate/mock_config.json create mode 100644 tests/softwareupdate/target_find_my_mr_beam_config.json create mode 100644 tests/softwareupdate/target_mrbeam_config.json create mode 100644 tests/softwareupdate/target_netconnectd_config.json create mode 100644 tests/softwareupdate/target_octoprint_config.json create mode 100644 tests/softwareupdate/test_cloud_config.py create mode 100644 tests/softwareupdate/test_dependencies.py create mode 100644 tests/util/__init__.py create mode 100644 tests/util/test_string_util.py create mode 100644 versioneer.py diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..78ea7a385 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +octoprint_mrbeam/_version.py export-subst diff --git a/.gitignore b/.gitignore index ec9a7632a..bcd0a2ad6 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,4 @@ venv/ tests/rsc/camera/debug/[^R]* tests/rsc/camera/out.jpg tests/logs/*.txt +*pytest-logs.txt diff --git a/MANIFEST.in b/MANIFEST.in index de6e71d88..f9b0e618c 100644 --- a/MANIFEST.in +++ b/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 diff --git a/octoprint_mrbeam/__init__.py b/octoprint_mrbeam/__init__.py index bfd1c1562..b0ae5321d 100644 --- a/octoprint_mrbeam/__init__.py +++ b/octoprint_mrbeam/__init__.py @@ -31,9 +31,15 @@ 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"] +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 +49,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 +60,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 +75,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 @@ -110,6 +119,8 @@ class MrBeamPlugin( octoprint.plugin.SlicerPlugin, octoprint.plugin.ShutdownPlugin, octoprint.plugin.EnvironmentDetectionPlugin, + UpdateRestHandlerMixin, + DocsRestHandlerMixin, ): # CONSTANTS ENV_PROD = "PROD" @@ -186,6 +197,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__ @@ -256,6 +270,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 +386,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 +472,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 +714,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"], ) @@ -818,6 +838,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)) @@ -2957,10 +2981,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 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 def _get_mac_addresses(self): if not self._mac_addrs: diff --git a/octoprint_mrbeam/__version.py b/octoprint_mrbeam/__version.py deleted file mode 100644 index b2385cb40..000000000 --- a/octoprint_mrbeam/__version.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.10.3" diff --git a/octoprint_mrbeam/_version.py b/octoprint_mrbeam/_version.py new file mode 100644 index 000000000..84f4bd3b2 --- /dev/null +++ b/octoprint_mrbeam/_version.py @@ -0,0 +1,520 @@ + +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "$Format:%d$" + git_full = "$Format:%H$" + git_date = "$Format:%ci$" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "pep440-post" + cfg.tag_prefix = "v" + cfg.parentdir_prefix = "" + cfg.versionfile_source = "octoprint_mrbeam/_version.py" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} diff --git a/octoprint_mrbeam/analytics/analytics_handler.py b/octoprint_mrbeam/analytics/analytics_handler.py index 2ddffaf21..58801694b 100644 --- a/octoprint_mrbeam/analytics/analytics_handler.py +++ b/octoprint_mrbeam/analytics/analytics_handler.py @@ -36,7 +36,7 @@ def analyticsHandler(plugin): class AnalyticsHandler(object): QUEUE_MAXSIZE = 1000 - ANALYTICS_LOG_VERSION = 21 # bumped in 0.10.0 - added the laser head model to analytics and added triggerData to session_expired event + ANALYTICS_LOG_VERSION = 22 # bumped for SW-653 - added frontend event update_info_call_failure to see when this backend call fails def __init__(self, plugin): self._plugin = plugin diff --git a/octoprint_mrbeam/dependencies.txt b/octoprint_mrbeam/dependencies.txt new file mode 100644 index 000000000..ec8ffd62e --- /dev/null +++ b/octoprint_mrbeam/dependencies.txt @@ -0,0 +1,4 @@ +iobeam==1.0.0a0 +mrb-hw-info==1.0.0a0 +mrbeam-ledstrips==1.0.0a0 +mrbeamdoc==1.0.0a0 \ No newline at end of file diff --git a/octoprint_mrbeam/jinja/__init__.py b/octoprint_mrbeam/jinja/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/octoprint_mrbeam/jinja/filter/__init__.py b/octoprint_mrbeam/jinja/filter/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/octoprint_mrbeam/jinja/filter/sort_filters.py b/octoprint_mrbeam/jinja/filter/sort_filters.py new file mode 100644 index 000000000..bffeb8388 --- /dev/null +++ b/octoprint_mrbeam/jinja/filter/sort_filters.py @@ -0,0 +1,9 @@ +def sort_enum(list, attribute=None): + def find_value_for(value): + enum = value + if attribute: + for attr in attribute.split('.'): + enum = getattr(enum, attr) + return enum.value + + return sorted(list, key=lambda element: find_value_for(element)) diff --git a/octoprint_mrbeam/jinja/filter_loader.py b/octoprint_mrbeam/jinja/filter_loader.py new file mode 100644 index 000000000..62a2a8983 --- /dev/null +++ b/octoprint_mrbeam/jinja/filter_loader.py @@ -0,0 +1,12 @@ +import jinja2 + +from octoprint_mrbeam.jinja.filter.sort_filters import sort_enum + + +class FilterLoader: + def __init__(self): + pass + + @staticmethod + def load_custom_jinja_filters(): + jinja2.filters.FILTERS['sort_enum'] = sort_enum diff --git a/octoprint_mrbeam/migrate.py b/octoprint_mrbeam/migrate.py index 893090034..3739a173f 100644 --- a/octoprint_mrbeam/migrate.py +++ b/octoprint_mrbeam/migrate.py @@ -6,19 +6,21 @@ from datetime import datetime from distutils.version import LooseVersion, StrictVersion -from octoprint_mrbeam import IS_X86 +from enum import Enum + +from octoprint_mrbeam import IS_X86, __version__ from octoprint_mrbeam.software_update_information import BEAMOS_LEGACY_DATE from octoprint_mrbeam.mrb_logger import mrb_logger from octoprint_mrbeam.util.cmd_exec import exec_cmd, exec_cmd_output from octoprint_mrbeam.util import logExceptions from octoprint_mrbeam.printing.profile import laserCutterProfileManager from octoprint_mrbeam.printing.comm_acc2 import MachineCom -from octoprint_mrbeam.__version import __version__ from octoprint_mrbeam.materials import materials from octoprint_mrbeam.migration import ( MIGRATION_STATE, MigrationBaseClass, list_of_migrations, + MIGRATION_RESTART, ) @@ -75,6 +77,7 @@ def __init__(self, plugin): ) beamos_tier, self.beamos_date = self.plugin._device_info.get_beamos_version() self.beamos_version = self.plugin._device_info.get_beamos_version_number() + self._restart = MIGRATION_RESTART.NONE def run(self): try: @@ -336,6 +339,8 @@ def _run_migration(self): # if migration sucessfull append to executed successfull if migration.state == MIGRATION_STATE.migration_done: migration_executed[migration.id] = True + if migration.restart: + self.restart = migration.restart else: # mark migration as failed and skipp the following ones migration_executed[migration.id] = False @@ -343,6 +348,8 @@ def _run_migration(self): with open(migrations_json_file_path, "w") as f: f.write(json.dumps(migration_executed)) + + MigrationBaseClass.execute_restart(self.restart) except IOError: self._logger.error("migration execution file IO error") except MigrationException as e: @@ -404,6 +411,15 @@ def save_current_version(self): ) # force needed to save it if it wasn't there self.plugin._settings.save() + @property + def restart(self): + return self._restart + + @restart.setter + def restart(self, value): + if self._restart == 0 or value < self._restart: + self._restart = value + ########################################################## ##### general stuff ##### ########################################################## diff --git a/octoprint_mrbeam/migration/Mig002.py b/octoprint_mrbeam/migration/Mig002.py new file mode 100644 index 000000000..f6c28ba08 --- /dev/null +++ b/octoprint_mrbeam/migration/Mig002.py @@ -0,0 +1,74 @@ +from octoprint_mrbeam.migration.migration_base import ( + MigrationBaseClass, + MIGRATION_RESTART, +) + + +class Mig002EnableOnlineCheck(MigrationBaseClass): + """ + Migration for beamos versions 0.0.0 up to 0.18.2 to enable online check + """ + + BEAMOS_VERSION_LOW = "0.0.0" + BEAMOS_VERSION_HIGH = "0.18.2" + + def __init__(self, plugin): + """ + initalization of the migration 002 + + Args: + plugin: Mr Beam Plugin + """ + super(Mig002EnableOnlineCheck, self).__init__( + plugin, restart=MIGRATION_RESTART.OCTOPRINT + ) + + @property + def id(self): + """ + return the id of the migration + + Returns: + string: id of the migration + """ + return "002" + + def _run(self): + """ + migration steps executet during migration + + Returns: + None + """ + self._logger.debug("change config to enable online check") + self.plugin._settings.global_set( + ["server", "onlineCheck", "enabled"], + True, + ) + self.plugin._settings.global_set( + ["server", "onlineCheck", "host"], + "find.mr-beam.org", + ) + self.plugin._settings.global_set( + ["server", "onlineCheck", "port"], + "80", + ) + self.plugin._settings.save() + + super(Mig002EnableOnlineCheck, self)._run() + + def _rollback(self): + """ + rollback steps executet during rollback + + Returns: + None + """ + # self._logger.debug("disable online check") + self.plugin._settings.global_set( + ["server", "onlineCheck", "enabled"], + False, + ) + self.plugin._settings.save() + + super(Mig002EnableOnlineCheck, self)._rollback() diff --git a/octoprint_mrbeam/migration/__init__.py b/octoprint_mrbeam/migration/__init__.py index e5e8ae40a..4f28b8484 100644 --- a/octoprint_mrbeam/migration/__init__.py +++ b/octoprint_mrbeam/migration/__init__.py @@ -16,11 +16,16 @@ from octoprint_mrbeam.migration.migration_base import ( MigrationException as MigrationException, ) +from octoprint_mrbeam.migration.migration_base import ( + MIGRATION_RESTART as MIGRATION_RESTART, +) # this is for internal use from octoprint_mrbeam.migration.Mig001 import Mig001NetconnectdDisableLogDebugLevel +from octoprint_mrbeam.migration.Mig002 import Mig002EnableOnlineCheck # To add migrations they have to be added to this list till we automate it list_of_migrations = [ Mig001NetconnectdDisableLogDebugLevel, + Mig002EnableOnlineCheck, ] diff --git a/octoprint_mrbeam/migration/migration_base.py b/octoprint_mrbeam/migration/migration_base.py index 2c67272fe..c86fd5c87 100644 --- a/octoprint_mrbeam/migration/migration_base.py +++ b/octoprint_mrbeam/migration/migration_base.py @@ -24,6 +24,12 @@ class MIGRATION_STATE(enumerate): rollback_error = -2 +class MIGRATION_RESTART(enumerate): + NONE = 0 + DEVICE = 1 + OCTOPRINT = 2 + + class MigrationException(Exception): """ Exception that could occure during migration @@ -46,7 +52,7 @@ class MigrationBaseClass: # highest beamos version that should run the migration BEAMOS_VERSION_HIGH = None - def __init__(self, plugin): + def __init__(self, plugin, restart=MIGRATION_RESTART.NONE): """ initalization of the class @@ -58,6 +64,7 @@ def __init__(self, plugin): self._logger = mrb_logger( "octoprint.plugins.mrbeam.migrate." + self.__class__.__name__ ) + self.restart = restart @property @abstractmethod @@ -207,3 +214,20 @@ def exec_cmd(self, command): """ if not exec_cmd(command): raise MigrationException("error during migration for cmd:", command) + + @staticmethod + def execute_restart(restart): + logger = mrb_logger("octoprint.plugins.mrbeam.migrate.restart") + if restart: + if restart == MIGRATION_RESTART.OCTOPRINT: + logger.info("restart octoprint after migration") + exec_cmd("sudo systemctl restart octoprint.service") + elif restart == MIGRATION_RESTART.DEVICE: + logger.info("restart device after migration") + exec_cmd("sudo reboot now") + else: + logger.info( + "restart after migration choosen but unknown type: {}".format( + restart + ) + ) diff --git a/octoprint_mrbeam/model/__init__.py b/octoprint_mrbeam/model/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/octoprint_mrbeam/model/burger_menu_model.py b/octoprint_mrbeam/model/burger_menu_model.py new file mode 100644 index 000000000..762b7afb1 --- /dev/null +++ b/octoprint_mrbeam/model/burger_menu_model.py @@ -0,0 +1,10 @@ + +class BurgerMenuModel: + """ + Data object containing information to be displayed under the burger menu to be used on the jinja2 templates + """ + def __init__(self): + self.documents = set() + + def add_document(self, document): + self.documents.add(document) diff --git a/octoprint_mrbeam/model/document_model.py b/octoprint_mrbeam/model/document_model.py new file mode 100644 index 000000000..a91e47170 --- /dev/null +++ b/octoprint_mrbeam/model/document_model.py @@ -0,0 +1,35 @@ +class DocumentModel: + """ + Data object containing information documents to be used on the jinja2 templates + """ + def __init__(self, title, document_links): + self.title = title + self.document_links = document_links + + def __repr__(self): + return 'Document(title=%s, document_links=%s)' % ( + self.title, ','.join([repr(document_link) for document_link in self.document_links])) + + +class DocumentSimpleModel: + """ + Data object containing a simplified version of the information about documents to be used on the jinja2 templates + """ + def __init__(self, title, document_link): + self.title = title + self.document_link = document_link + + def __repr__(self): + return 'Document(title=%s, document_link=%s)' % (self.title, repr(self.document_link)) + + +class DocumentLinkModel: + """ + Data object containing information to be able to display a link to a document on the jinja2 templates + """ + def __init__(self, language, url): + self.language = language + self.url = url + + def __repr__(self): + return 'DocumentLink(language=%s, url=%s)' % (self.language, self.url) diff --git a/octoprint_mrbeam/model/settings_model.py b/octoprint_mrbeam/model/settings_model.py new file mode 100644 index 000000000..9dacbd38b --- /dev/null +++ b/octoprint_mrbeam/model/settings_model.py @@ -0,0 +1,20 @@ +class SettingsModel: + """ + Data object containing information about the settings to be used on the jinja2 templates + """ + def __init__(self): + self.about = None + + def __repr__(self): + return 'SettingsModel(about=%s)' % (repr(self.about)) + + +class AboutModel: + """ + Data object containing information corresponding to the about section to be used on the jinja2 templates + """ + def __init__(self, support_documents=[]): + self.support_documents = support_documents + + def __repr__(self): + return 'About(support_documents=%s)' % (','.join([repr(document) for document in self.support_documents])) diff --git a/octoprint_mrbeam/rest_handler/__init__.py b/octoprint_mrbeam/rest_handler/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/octoprint_mrbeam/rest_handler/docs_handler.py b/octoprint_mrbeam/rest_handler/docs_handler.py new file mode 100644 index 000000000..51008b297 --- /dev/null +++ b/octoprint_mrbeam/rest_handler/docs_handler.py @@ -0,0 +1,33 @@ +import octoprint.plugin +from flask import abort, send_file +from octoprint_mrbeamdoc.exception.mrbeam_doc_not_found import MrBeamDocNotFoundException +from octoprint_mrbeamdoc.utils.mrbeam_doc_utils import MrBeamDocUtils + + +class DocsRestHandlerMixin: + """ + This class contains all the rest handlers and endpoints related to handle docs + """ + + @octoprint.plugin.BlueprintPlugin.route( + "/docs///.", methods=["GET"]) + def get_doc(self, model, doctype, language, extension): + self._logger.debug( + 'Request to Model: %(model)s Doctype: %(doctype)s Language: %(language)s Extension:%(extension)s', + {'model': model, 'doctype': doctype, 'language': language, 'extension': extension}) + + mrbeam_model_found = MrBeamDocUtils.get_mrbeam_model_enum_for(model) + supported_language_found = MrBeamDocUtils.get_supported_language_enum_for(language) + mrbeam_doctype_found = MrBeamDocUtils.get_mrbeamdoc_type_enum_for(doctype) + + if mrbeam_model_found is None or supported_language_found is None or mrbeam_doctype_found is None: + abort(404) + + try: + mrbeamdoc = MrBeamDocUtils.get_mrbeamdoc_for(mrbeam_doctype_found, mrbeam_model_found, + supported_language_found, extension=extension) + except MrBeamDocNotFoundException as e: + self._logger.warn(e) + abort(404) + + return send_file(mrbeamdoc.get_file_reference(), attachment_filename=mrbeamdoc.get_file_name_with_extension()) diff --git a/octoprint_mrbeam/rest_handler/update_handler.py b/octoprint_mrbeam/rest_handler/update_handler.py new file mode 100644 index 000000000..3f8b27f82 --- /dev/null +++ b/octoprint_mrbeam/rest_handler/update_handler.py @@ -0,0 +1,16 @@ +from octoprint.server import NO_CONTENT + +import octoprint.plugin + +from octoprint_mrbeam.software_update_information import reload_update_info + + +class UpdateRestHandlerMixin: + """ + This class contains all the rest handlers and endpoints related to software update + """ + + @octoprint.plugin.BlueprintPlugin.route("/info/update", methods=["POST"]) + def update_update_informations(self): + reload_update_info(self) + return NO_CONTENT diff --git a/octoprint_mrbeam/scripts/update_script.py b/octoprint_mrbeam/scripts/update_script.py new file mode 100644 index 000000000..e03410fcf --- /dev/null +++ b/octoprint_mrbeam/scripts/update_script.py @@ -0,0 +1,480 @@ +from __future__ import absolute_import, division, print_function + +import json +import os +import re +import shutil +import subprocess +import sys +from io import BytesIO + +import zipfile +import requests +import argparse + +from octoprint.plugins.softwareupdate import exceptions + +from octoprint.settings import _default_basedir +from octoprint_mrbeam.mrb_logger import mrb_logger + +from octoprint_mrbeam.util.pip_util import get_version_of_pip_module, get_pip_caller +from requests.adapters import HTTPAdapter +from urllib3 import Retry +from urllib3.exceptions import MaxRetryError, ConnectionError + +_logger = mrb_logger("octoprint.plugins.mrbeam.softwareupdate.updatescript") + + +UPDATE_CONFIG_NAME = "mrbeam" +REPO_NAME = "MrBeamPlugin" +MAIN_SRC_FOLDER_NAME = "octoprint_mrbeam" +PLUGIN_NAME = "Mr_Beam" +DEFAULT_OPRINT_VENV = "/home/pi/oprint/bin/pip" +PIP_WHEEL_TEMP_FOLDER = "/tmp/wheelhouse" + + +def _parse_arguments(): + boolean_trues = ["true", "yes", "1"] + + parser = argparse.ArgumentParser(prog=__file__) + + parser.add_argument( + "--git", + action="store", + type=str, + dest="git_executable", + help="Specify git executable to use", + ) + parser.add_argument( + "--python", + action="store", + type=str, + dest="python_executable", + help="Specify python executable to use", + ) + parser.add_argument( + "--force", + action="store", + type=lambda x: x in boolean_trues, + dest="force", + default=False, + help="Set this to true to force the update to only the specified version (nothing newer, nothing older)", + ) + parser.add_argument( + "--sudo", action="store_true", dest="sudo", help="Install with sudo" + ) + parser.add_argument( + "--user", + action="store_true", + dest="user", + help="Install to the user site directory instead of the general site directory", + ) + parser.add_argument( + "--branch", + action="store", + type=str, + dest="branch", + default=None, + help="Specify the branch to make sure is checked out", + ) + parser.add_argument( + "--call", + action="store", + type=lambda x: x in boolean_trues, + dest="call", + default=False, + help="Calls the update methode", + ) + parser.add_argument( + "--archive", + action="store", + type=str, + dest="archive", + default=None, + help="Path of target zip file on local system", + ) + parser.add_argument( + "folder", + type=str, + help="Specify the base folder of the OctoPrint installation to update", + ) + parser.add_argument( + "target", type=str, help="Specify the commit or tag to which to update" + ) + + args = parser.parse_args() + + return args + + +def get_dependencies(path): + """ + return the dependencies saved in the + + Args: + path: path to the dependencies.txt file + + Returns: + list of dependencie dict [{"name", "version"}] + """ + dependencies_path = os.path.join(path, "dependencies.txt") + dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)(.=)+((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)" + """ + Example: + input: iobeam==0.7.15 + mrb-hw-info==0.0.25 + mrbeam-ledstrips==0.2.2-alpha.2 + output: [[iobeam][==][0.7.15]] + [[mrb-hw-info][==][0.0.25]] + [[mrbeam-ledstrips][==][0.2.2-alpha.2]] + """ + try: + with open(dependencies_path, "r") as f: + dependencies_content = f.read() + dependencies = re.findall(dependencies_pattern, dependencies_content) + dependencies = [{"name": dep[0], "version": dep[2]} for dep in dependencies] + except IOError: + raise RuntimeError("Could not load dependencies") + return dependencies + + +def get_update_info(): + """ + returns the update info saved in the update_info.json file + """ + update_info_path = os.path.join(_default_basedir("OctoPrint"), "update_info.json") + try: + with open(update_info_path, "r") as f: + update_info = json.load(f) + except IOError: + raise RuntimeError("Could not load update info") + except ValueError as e: + raise RuntimeError("update info not valid json - {}".format(e)) + return update_info + + +def build_wheels(build_queue): + """ + build the wheels of the packages in the queue + + Args: + build_queue: dict of venvs with a list of packages to build the wheels + + Returns: + None + + """ + try: + if not os.path.isdir(PIP_WHEEL_TEMP_FOLDER): + os.mkdir(PIP_WHEEL_TEMP_FOLDER) + except OSError as e: + raise RuntimeError("can't create wheel tmp folder {} - {}".format(PIP_WHEEL_TEMP_FOLDER, e)) + + for venv, packages in build_queue.items(): + tmp_folder = os.path.join(PIP_WHEEL_TEMP_FOLDER, re.search(r"\w+((?=\/venv)|(?=\/bin))", venv).group(0)) + if os.path.isdir(tmp_folder): + try: + os.system("sudo rm -r {}".format(tmp_folder)) + except Exception as e: + raise RuntimeError("can't delete pip wheel temp folder {} - {}".format(tmp_folder, e)) + + pip_args = [ + "wheel", + "--no-python-version-warning", + "--disable-pip-version-check", + "--wheel-dir={}".format(tmp_folder), # Build wheels into , where the default is the current working directory. + "--no-dependencies", # Don't install package dependencies. + ] + for package in packages: + if package.get("archive"): + pip_args.append(package.get("archive")) + else: + raise RuntimeError("Archive not found for package {}".format(package)) + + returncode, exec_stdout, exec_stderr = get_pip_caller(venv, _logger).execute( + *pip_args + ) + if returncode != 0: + raise exceptions.UpdateError( + "Error while executing pip wheel", (exec_stdout, exec_stderr) + ) + + +def install_wheels(install_queue): + """ + installs the wheels in the given venv of the queue + + Args: + install_queue: dict of venvs with a list of packages to install + + Returns: + None + """ + if not isinstance(install_queue, dict): + raise RuntimeError("install queue is not a dict") + + for venv, packages in install_queue.items(): + tmp_folder = os.path.join(PIP_WHEEL_TEMP_FOLDER, re.search(r"\w+((?=\/venv)|(?=\/bin))", venv).group(0)) + pip_args = [ + "install", + "--no-python-version-warning", + "--disable-pip-version-check", + "--upgrade", # Upgrade all specified packages to the newest available version. The handling of dependencies depends on the upgrade-strategy used. + "--no-index", # Ignore package index (only looking at --find-links URLs instead). + "--find-links={}".format(tmp_folder), # If a URL or path to an html file, then parse for links to archives such as sdist (.tar.gz) or wheel (.whl) files. If a local path or file:// URL that's a directory, then look for archives in the directory listing. Links to VCS project URLs are not supported. + "--no-dependencies", # Don't install package dependencies. + ] + for package in packages: + pip_args.append( + "{package}".format( + package=package["name"] + ) + ) + + returncode, exec_stdout, exec_stderr = get_pip_caller(venv, _logger).execute( + *pip_args + ) + if returncode != 0: + raise exceptions.UpdateError( + "Error while executing pip install", (exec_stdout, exec_stderr) + ) + + +def build_queue(update_info, dependencies, plugin_archive): + """ + build the queue of packages to install + + Args: + update_info: a dict of informations how to update the packages + dependencies: a list dicts of dependencies [{"name", "version"}] + plugin_archive: path to archive of the plugin + + Returns: + install_queue: dict of venvs with a list of package dicts {"": [{"name", "archive", "target"}] + """ + install_queue = {} + + install_queue.setdefault( + update_info.get(UPDATE_CONFIG_NAME).get("pip_command", DEFAULT_OPRINT_VENV), [] + ).append( + { + "name": PLUGIN_NAME, + "archive": plugin_archive, + "target": '', + } + ) + print("dependencies - {}".format(dependencies)) + if dependencies: + for dependency in dependencies: + plugin_config = update_info.get(UPDATE_CONFIG_NAME) + plugin_dependencies_config = plugin_config.get("dependencies") + dependency_config = plugin_dependencies_config.get(dependency["name"]) + + # fail if requirements file contains dependencies but cloud config not + if dependency_config == None: + raise RuntimeError( + "no update info for dependency {}".format(dependency["name"]) + ) + if dependency_config.get("pip"): + archive = dependency_config["pip"].format( + repo=dependency_config["repo"], + user=dependency_config["user"], + target_version="v{version}".format(version=dependency["version"]), + ) + else: + raise RuntimeError( + "pip not configured for {}".format(dependency["name"]) + ) + + version = get_version_of_pip_module( + dependency["name"], + dependency_config.get("pip_command", DEFAULT_OPRINT_VENV), + ) + if version != dependency["version"]: + install_queue.setdefault( + dependency_config.get("pip_command", DEFAULT_OPRINT_VENV), [] + ).append( + { + "name": dependency["name"], + "archive": archive, + "target": dependency["version"], + } + ) + else: + print( + "skip dependency {} as the target version {} is already installed".format( + dependency["name"], dependency["version"] + ) + ) + return install_queue + + +def run_update(): + """ + collects the dependencies and the update info, builds the wheels and installs them in the correct venv + """ + + args = _parse_arguments() + + # get dependencies + dependencies = get_dependencies(args.folder) + + # get update config of dependencies + update_info = get_update_info() + + install_queue = build_queue( + update_info, dependencies, args.archive + ) + + print("install_queue", install_queue) + if install_queue is not None: + build_wheels(install_queue) + install_wheels(install_queue) + + +def retryget(url, retrys=3, backoff_factor=0.3): + """ + retrys the get times + + Args: + url: url to access + retrys: number of retrys + backoff_factor: factor for time between retrys + + Returns: + response + """ + try: + s = requests.Session() + retry = Retry(connect=retrys, backoff_factor=backoff_factor) + adapter = HTTPAdapter(max_retries=retry) + s.mount("https://", adapter) + s.keep_alive = False + + response = s.request("GET", url) + return response + except MaxRetryError: + raise RuntimeError("timeout while trying to get {}".format(url)) + except ConnectionError: + raise RuntimeError("connection error while trying to get {}".format(url)) + + +def loadPluginTarget(archive, folder): + """ + download the archive of the Plugin and copy dependencies and update script in the working directory + + Args: + archive: path of the archive to download and unzip + folder: working directory + + Returns: + zip_file_path - path of the downloaded zip file + """ + + # download target repo zip + req = retryget(archive) + filename = archive.split("/")[-1] + zip_file_path = os.path.join(folder, filename) + try: + with open(zip_file_path, "wb") as output_file: + output_file.write(req.content) + except IOError: + raise RuntimeError( + "Could not save the zip file to the working directory {}".format(folder) + ) + + # unzip repo + plugin_extracted_path = os.path.join(folder, UPDATE_CONFIG_NAME) + plugin_extracted_path_folder = os.path.join( + plugin_extracted_path, + "{repo_name}-{target}".format( + repo_name=REPO_NAME, target=re.sub(r"^v", "", filename.split(".zip")[0]) + ), + ) + try: + plugin_zipfile = zipfile.ZipFile(BytesIO(req.content)) + plugin_zipfile.extractall(plugin_extracted_path) + plugin_zipfile.close() + except (zipfile.BadZipfile, zipfile.LargeZipFile) as e: + raise RuntimeError("Could not unzip plugin repo - error: {}".format(e)) + + # copy new dependencies to working directory + try: + shutil.copy2( + os.path.join( + plugin_extracted_path_folder, MAIN_SRC_FOLDER_NAME, "dependencies.txt" + ), + os.path.join(folder, "dependencies.txt"), + ) + except IOError: + raise RuntimeError("Could not copy dependencies to working directory") + + # copy new update script to working directory + try: + shutil.copy2( + os.path.join( + plugin_extracted_path_folder, + MAIN_SRC_FOLDER_NAME, + "scripts/update_script.py", + ), + os.path.join(folder, "update_script.py"), + ) + except IOError: + raise RuntimeError("Could not copy update_script to working directory") + + return zip_file_path + + +def main(): + """ + loads the dependencies.txt and the update_script of the given target and executes the new update_script + + Args: + target: target of the Mr Beam Plugin to update to + call: if true executet the update itselfe + """ + + args = _parse_arguments() + if args.call: + if args.archive is None: + raise RuntimeError( + "Could not run update archive is missing" + ) + run_update() + else: + + folder = args.folder + + import os + + if not os.access(folder, os.W_OK): + raise RuntimeError("Could not update, base folder is not writable") + + update_info = get_update_info() + archive = loadPluginTarget( + update_info.get(UPDATE_CONFIG_NAME) + .get("pip") + .format(target_version=args.target), + folder, + ) + + # call new update script with args + sys.argv = [ + "--call=true", + "--archive={}".format(archive) + ] + sys.argv[1:] + try: + result = subprocess.call( + [sys.executable, os.path.join(folder, "update_script.py")] + sys.argv, + stderr=subprocess.STDOUT, + ) + except subprocess.CalledProcessError as e: + print(e.output) + raise RuntimeError("error code %s", (e.returncode, e.output)) + + if result != 0: + raise RuntimeError("Error Could not update returncode - {}".format(result)) + + +if __name__ == "__main__": + main() diff --git a/octoprint_mrbeam/services/__init__.py b/octoprint_mrbeam/services/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/octoprint_mrbeam/services/burger_menu_service.py b/octoprint_mrbeam/services/burger_menu_service.py new file mode 100644 index 000000000..7cd0b9672 --- /dev/null +++ b/octoprint_mrbeam/services/burger_menu_service.py @@ -0,0 +1,39 @@ +from flask_babel import get_locale +from octoprint_mrbeamdoc.enum.supported_languages import SupportedLanguage +from octoprint_mrbeamdoc.utils.mrbeam_doc_utils import MrBeamDocUtils + +from octoprint_mrbeam.model.burger_menu_model import BurgerMenuModel + + +class BurgerMenuService: + """ + In this class we gather all the service layer calculations needed regarding the burger menu + """ + + def __init__(self, logger, document_service): + self._logger = logger + self._document_service = document_service + + def get_burger_menu_model(self, mrbeam_model): + """ + mrbeam_model String: Name of the running mrbeam_model + + Return BurgerMenuModel containing all the burger menu related information for this specific mrbeam_model + """ + mrbeam_model_found = MrBeamDocUtils.get_mrbeam_model_enum_for(mrbeam_model) + if mrbeam_model_found is None: + self._logger.error('MrBeamModel not identified %s', mrbeam_model) + return BurgerMenuModel() + + language_found = MrBeamDocUtils.get_supported_language_enum_for(get_locale().language) + if language_found is None: + language_found = SupportedLanguage.ENGLISH + + burger_model = BurgerMenuModel() + definitions = MrBeamDocUtils.get_mrbeam_definitions_for(mrbeam_model_found) + for definition in definitions: + language_found = language_found if definition.is_language_supported( + language_found) else SupportedLanguage.ENGLISH + document_simple = self._document_service.get_document_simple_for(definition, language_found) + burger_model.add_document(document_simple) + return burger_model diff --git a/octoprint_mrbeam/services/document_service.py b/octoprint_mrbeam/services/document_service.py new file mode 100644 index 000000000..be334ba56 --- /dev/null +++ b/octoprint_mrbeam/services/document_service.py @@ -0,0 +1,57 @@ +from flask_babel import get_locale, gettext + +from octoprint_mrbeam.model.document_model import DocumentLinkModel, DocumentModel, DocumentSimpleModel +from octoprint_mrbeam.util import string_util + + +class DocumentService: + """ + In this class we gather all the service layer calculations needed regarding documents + """ + + def __init__(self, logger): + self._logger = logger + + def get_documents_for(self, definition): + """ + Get document information corresponding to a definition + + definition MrBeamDocDefinition: definition of the document + + return DocumentModel corresponding to the requested params + """ + document_links = [DocumentLinkModel(language, self._get_url_for_definition_language(definition, language)) for + language in definition.supported_languages] + title_translated = self._get_title_translated(definition) + return DocumentModel(title_translated, document_links) + + def get_document_simple_for(self, definition, language): + """ + Get a simplified version of the document corresponding to a definition and language + + definition MrBeamDocDefinition: definition of the document + language SupportedLanguage: language of the document + + return DocumentSimpleModel corresponding to the requested params + """ + document_link = DocumentLinkModel(language, self._get_url_for_definition_language(definition, language)) + title_translated = self._get_title_translated(definition) + return DocumentSimpleModel(title_translated, document_link) + + def _get_title_translated(self, definition): + title_key = string_util.separate_camelcase_words(definition.mrbeamdoc_type.value) + title_translated = gettext(title_key) + if get_locale() is not None and get_locale().language != 'en' and title_key == title_translated: + self._logger.error( + 'No key found for title_key=%(title_key)s title_translated=%(title_translated)s' % { + 'title_key': title_key, + 'title_translated': title_translated}) + return title_translated + + @staticmethod + def _get_url_for_definition_language(definition, language, extension='pdf'): + return '/plugin/mrbeam/docs/%(mrbeam_model)s/%(language)s/%(mrbeam_type)s.%(extension)s' % { + 'mrbeam_model': definition.mrbeam_model.value, + 'language': language.value, + 'mrbeam_type': definition.mrbeamdoc_type.value, + 'extension': extension} diff --git a/octoprint_mrbeam/services/settings_service.py b/octoprint_mrbeam/services/settings_service.py new file mode 100644 index 000000000..8235992f5 --- /dev/null +++ b/octoprint_mrbeam/services/settings_service.py @@ -0,0 +1,35 @@ +from octoprint_mrbeamdoc.utils.mrbeam_doc_utils import MrBeamDocUtils + +from octoprint_mrbeam.model.settings_model import SettingsModel, AboutModel + + +class SettingsService: + """ + In this class we gather all the service layer calculations needed regarding settings + """ + + def __init__(self, logger, document_service): + self._logger = logger + self._document_service = document_service + + def get_template_settings_model(self, mrbeam_model): + """ + mrbeam_model String: Name of the running mrbeam_model + + Return SettingsModel containing all the information and settings available for this specific mrbeam_model + """ + mrbeam_model_found = MrBeamDocUtils.get_mrbeam_model_enum_for(mrbeam_model) + if mrbeam_model_found is None: + self._logger.error('MrBeamModel not identified %s', mrbeam_model) + return self._empty_settings_model() + + definitions = MrBeamDocUtils.get_mrbeam_definitions_for(mrbeam_model_found) + settings_model = SettingsModel() + settings_model.about = AboutModel( + support_documents=[self._document_service.get_documents_for(definition) for definition in definitions]) + return settings_model + + def _empty_settings_model(self): + settings_model = SettingsModel() + settings_model.about = AboutModel() + return settings_model diff --git a/octoprint_mrbeam/software_update_information.py b/octoprint_mrbeam/software_update_information.py index f2114cb44..963a9cfa4 100644 --- a/octoprint_mrbeam/software_update_information.py +++ b/octoprint_mrbeam/software_update_information.py @@ -1,27 +1,44 @@ -from datetime import datetime, date -import os, sys +import base64 +import copy +import json +import os +from datetime import date +from datetime import datetime +from enum import Enum + +import semantic_version +import yaml +from octoprint.plugins.softwareupdate import exceptions as softwareupdate_exceptions +from requests import ConnectionError +from requests.adapters import HTTPAdapter, MaxRetryError +from semantic_version import Spec +from urllib3 import Retry -from octoprint.util import dict_merge -from octoprint_mrbeam import IS_X86 from octoprint_mrbeam.mrb_logger import mrb_logger -from octoprint_mrbeam.util import logExceptions +from octoprint_mrbeam.util import dict_merge, logExceptions +from octoprint_mrbeam.util.github_api import get_file_of_repo_for_tag from util.pip_util import get_version_of_pip_module -SW_UPDATE_TIER_PROD = "PROD" -SW_UPDATE_TIER_BETA = "BETA" -SW_UPDATE_TIER_ALPHA = "ALPHA" -SW_UPDATE_TIER_DEV = "DEV" -DEFAULT_REPO_BRANCH_ID = { - SW_UPDATE_TIER_PROD: "stable", - SW_UPDATE_TIER_BETA: "beta", - SW_UPDATE_TIER_ALPHA: "alpha", - SW_UPDATE_TIER_DEV: "develop", -} +class SWUpdateTier(Enum): + STABLE = "PROD" + BETA = "BETA" + ALPHA = "ALPHA" + DEV = "DEV" + -# add to the display name to modules that should be shown at the top of the list -SORT_UP_PREFIX = " " +SW_UPDATE_TIERS_DEV = [SWUpdateTier.ALPHA.value, SWUpdateTier.DEV.value] +SW_UPDATE_TIERS_PROD = [SWUpdateTier.STABLE.value, SWUpdateTier.BETA.value] +SW_UPDATE_TIERS = SW_UPDATE_TIERS_DEV + SW_UPDATE_TIERS_PROD +DEFAULT_REPO_BRANCH_ID = { + SWUpdateTier.STABLE.value: "stable", + SWUpdateTier.BETA.value: "beta", + SWUpdateTier.ALPHA.value: "alpha", + SWUpdateTier.DEV.value: "develop", +} +MAJOR_VERSION_CLOUD_CONFIG = 0 +SW_UPDATE_INFO_FILE_NAME = "update_info.json" _logger = mrb_logger("octoprint.plugins.mrbeam.software_update_information") @@ -32,308 +49,489 @@ GLOBAL_PIP_COMMAND = ( "sudo {}".format(GLOBAL_PIP_BIN) if os.path.isfile(GLOBAL_PIP_BIN) else None ) -# GLOBAL_PIP_COMMAND = "sudo {} -m pip".format(GLOBAL_PY_BIN) if os.path.isfile(GLOBAL_PY_BIN) else None # --disable-pip-version-check -# VENV_PIP_COMMAND = ("%s -m pip --disable-pip-version-check" % VENV_PY_BIN).split(' ') if os.path.isfile(VENV_PY_BIN) else None + BEAMOS_LEGACY_DATE = date(2018, 1, 12) +def get_tag_of_github_repo(repo): + """ + return the latest tag of a github repository + Args: + repo: repository name + + Returns: + latest tag of the given majorversion + """ + import requests + import json + + try: + url = "https://api.github.com/repos/mrbeam/{repo}/tags".format(repo=repo) + headers = { + "Accept": "application/json", + } + + s = requests.Session() + retry = Retry(connect=3, backoff_factor=0.3) + adapter = HTTPAdapter(max_retries=retry) + s.mount("https://", adapter) + s.keep_alive = False + + response = s.request("GET", url, headers=headers, timeout=3) + response.raise_for_status() # This will throw an exception if status is 4xx or 5xx + if response: + json_data = json.loads(response.text) + versionlist = [ + semantic_version.Version(version.get("name")[1:]) + for version in json_data + ] + majorversion = Spec( + "<{}.0.0".format(str(MAJOR_VERSION_CLOUD_CONFIG + 1)) + ) # simpleSpec("0.*.*") + return "v{}".format(majorversion.select(versionlist)) + else: + _logger.warning( + "no valid response for the tag of the update_config file {}".format( + response + ) + ) + return None + except MaxRetryError: + _logger.warning("timeout while trying to get the tag of the update_config file") + return None + except requests.HTTPError as e: + _logger.warning("server error {}".format(e)) + return None + except ConnectionError: + _logger.warning( + "connection error while trying to get the tag of the update_config file" + ) + return None + + def get_update_information(plugin): - result = dict() - - tier = plugin._settings.get(["dev", "software_tier"]) - beamos_tier, beamos_date = plugin._device_info.get_beamos_version() - _logger.info("SoftwareUpdate using tier: %s", tier) - - # The increased number of separate virtualenv for iobeam, netconnectd, ledstrips - # will increase the "discovery time" to find those package versions. - # "map-reduce" method can decrease lookup time by processing them in parallel - res = dict( - reduce( - dict_merge, - [ - _set_info_mrbeam_plugin(plugin, tier, beamos_date), - _set_info_mrbeamdoc(plugin, tier), - _set_info_netconnectd_plugin(plugin, tier, beamos_date), - _set_info_findmymrbeam(plugin, tier), - _set_info_mrbeamledstrips(plugin, tier, beamos_date), - _set_info_netconnectd_daemon(plugin, tier, beamos_date), - _set_info_iobeam(plugin, tier, beamos_date), - _set_info_mrb_hw_info(plugin, tier, beamos_date), - _config_octoprint(plugin, tier), - ], + """ + Gets called from the octoprint.plugin.softwareupdate.check_config Hook from Octoprint + Starts a thread to look online for a new config file + sets the config for the Octoprint Softwareupdate Plugin with the data from the config file + Args: + plugin: Mr Beam Plugin + + Returns: + the config for the Octoprint embedded softwareupdate Plugin + """ + try: + tier = plugin._settings.get(["dev", "software_tier"]) + beamos_tier, beamos_date = plugin._device_info.get_beamos_version() + _logger.info( + "SoftwareUpdate using tier: {tier} {beamos_date}".format( + tier=tier, beamos_date=beamos_date + ) ) - ) - for pack, updt_info in res.items(): - _logger.debug( - "{} targets branch {} using pip {}".format( - pack, - updt_info.get("branch"), - updt_info.get("pip_command", "~/oprint/bin/pip"), + + if plugin._connectivity_checker.check_immediately(): + config_tag = get_tag_of_github_repo("beamos_config") + # if plugin._connectivity_checker.check_immediately(): # check if device online + if config_tag: + cloud_config = yaml.safe_load( + get_file_of_repo_for_tag( + repo="beamos_config", + file="docs/sw-update-conf.json", + tag=config_tag, + ) + ) + if cloud_config: + return _set_info_from_cloud_config( + plugin, tier, beamos_date, cloud_config + ) + else: + _logger.warn("no internet connection") + + user_notification_system = plugin.user_notification_system + user_notification_system.show_notifications( + user_notification_system.get_notification( + notification_id="missing_updateinformation_info", replay=False ) ) - return res + + # mark update config as dirty + sw_update_plugin = plugin._plugin_manager.get_plugin_info( + "softwareupdate" + ).implementation + _clear_version_cache(sw_update_plugin) + except Exception as e: + _logger.exception(e) + + return _set_info_from_cloud_config( + plugin, + tier, + beamos_date, + { + "default": {}, + "modules": { + "mrbeam": { + "name": " MrBeam Plugin", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, + "netconnectd": { + "name": "OctoPrint-Netconnectd Plugin", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, + "findmymrbeam": { + "name": "OctoPrint-FindMyMrBeam", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, + }, + }, + ) + + +def _clear_version_cache(sw_update_plugin): + sw_update_plugin._version_cache = dict() + sw_update_plugin._version_cache_dirty = True def software_channels_available(plugin): - ret = [SW_UPDATE_TIER_PROD, SW_UPDATE_TIER_BETA] + """ + return the available software channels + Args: + plugin: Mr Beam Plugin + + Returns: + list of available software channels + """ + ret = copy.deepcopy(SW_UPDATE_TIERS_PROD) if plugin.is_dev_env(): # fmt: off - ret.extend([SW_UPDATE_TIER_ALPHA, SW_UPDATE_TIER_DEV,]) + ret += SW_UPDATE_TIERS_DEV # fmt: on return ret -@logExceptions def switch_software_channel(plugin, channel): + """ + Switches the Softwarechannel and triggers the reload of the config + Args: + plugin: Mr Beam Plugin + channel: the channel where to switch to + + Returns: + None + """ old_channel = plugin._settings.get(["dev", "software_tier"]) if channel in software_channels_available(plugin) and channel != old_channel: - _logger.info("Switching software channel to: %s", channel) + _logger.info("Switching software channel to: {channel}".format(channel=channel)) plugin._settings.set(["dev", "software_tier"], channel) - # fmt: off - sw_update_plugin = plugin._plugin_manager.get_plugin_info("softwareupdate").implementation - # fmt: on - sw_update_plugin._refresh_configured_checks = True - sw_update_plugin._version_cache = dict() - sw_update_plugin._version_cache_dirty = True - plugin.analytics_handler.add_software_channel_switch_event(old_channel, channel) + reload_update_info(plugin) -def _config_octoprint(plugin, tier): - prerelease_channel = None - type = "github_release" - if tier in [SW_UPDATE_TIER_ALPHA, SW_UPDATE_TIER_BETA]: - prerelease_channel = "mrbeam2-{tier}" +def reload_update_info(plugin): + """ + clears the version cache and refires the get_update_info hook + Args: + plugin: Mr Beam Plugin - elif tier in [SW_UPDATE_TIER_DEV]: - type = "github_commit" - - return _get_octo_plugin_description( - "octoprint", - tier, - plugin, - type=type, - displayName="OctoPrint", - prerelease=(tier in [SW_UPDATE_TIER_ALPHA, SW_UPDATE_TIER_BETA]), - prerelease_channel=prerelease_channel, - restart="octoprint", - pip="https://github.com/mrbeam/OctoPrint/archive/{target_version}.zip", - ) + Returns: + None + """ + _logger.debug("Reload update info") + # fmt: off + sw_update_plugin = plugin._plugin_manager.get_plugin_info("softwareupdate").implementation + # fmt: on + sw_update_plugin._refresh_configured_checks = True + _clear_version_cache(sw_update_plugin) -def _set_info_mrbeam_plugin(plugin, tier, beamos_date): - branch = "mrbeam2-{tier}" - return _get_octo_plugin_description( - "mrbeam", - tier, - plugin, - displayName=SORT_UP_PREFIX + "MrBeam Plugin", - branch=branch, - branch_default=branch, - repo="MrBeamPlugin", - pip="https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", - restart="octoprint", - ) - - -def _set_info_mrbeamdoc(plugin, tier): - return _get_octo_plugin_description( - "mrbeamdoc", - tier, - plugin, - displayName="Mr Beam Documentation", - repo="MrBeamDoc", - pip="https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip", - restart="octoprint", - ) - - -def _set_info_netconnectd_plugin(plugin, tier, beamos_date): - branch = "mrbeam2-{tier}" - return _get_octo_plugin_description( - "netconnectd", - tier, - plugin, - displayName="OctoPrint-Netconnectd Plugin", - branch=branch, - branch_default=branch, - repo="OctoPrint-Netconnectd", - pip="https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", - restart="octoprint", - ) +@logExceptions +def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): + """ + loads update info from the update_info.json file + the override order: default_settings->module_settings->tier_settings->beamos_settings + and if there are update_settings set in the config.yaml they will replace all of the module + the json file should look like: + { + "default": {} + "modules": { + : { + , + :{}, + "beamos_date": { + : {} + } + } + "dependencies: {} + } + } + Args: + plugin: Mr Beam Plugin + tier: the software tier which should be used + beamos_date: the image creation date of the running beamos + cloud_config: the update config from the cloud + + Returns: + software update information or None + """ + if cloud_config: + sw_update_config = dict() + _logger.debug("update_info {}".format(cloud_config)) + defaultsettings = cloud_config.get("default", None) + modules = cloud_config["modules"] + + try: + for module_id, module in modules.items(): + if tier in SW_UPDATE_TIERS: + sw_update_config[module_id] = {} + + module = dict_merge(defaultsettings, module) + + sw_update_config[module_id] = _generate_config_of_module( + module_id, module, defaultsettings, tier, beamos_date, plugin + ) + except softwareupdate_exceptions.ConfigurationInvalid as e: + _logger.exception("ConfigurationInvalid {}".format(e)) + user_notification_system = plugin.user_notification_system + user_notification_system.show_notifications( + user_notification_system.get_notification( + notification_id="update_fetching_information_err", + err_msg=["E-1003"], + replay=False, + ) + ) -def _set_info_findmymrbeam(plugin, tier): - return _get_octo_plugin_description( - "findmymrbeam", - tier, - plugin, - displayName="OctoPrint-FindMyMrBeam", - repo="OctoPrint-FindMyMrBeam", - pip="https://github.com/mrbeam/OctoPrint-FindMyMrBeam/archive/{target_version}.zip", - restart="octoprint", - ) + _logger.debug("sw_update_config {}".format(sw_update_config)) + sw_update_file_path = os.path.join( + plugin._settings.getBaseFolder("base"), SW_UPDATE_INFO_FILE_NAME + ) + try: + with open(sw_update_file_path, "w") as f: + f.write(json.dumps(sw_update_config)) + except (IOError, TypeError): + plugin._logger.error("can't create update info file") + user_notification_system = plugin.user_notification_system + user_notification_system.show_notifications( + user_notification_system.get_notification( + notification_id="write_error_update_info_file_err", replay=False + ) + ) + return None -def _set_info_mrbeamledstrips(plugin, tier, beamos_date): - if beamos_date > BEAMOS_LEGACY_DATE: - pip_command = "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + return sw_update_config else: - pip_command = GLOBAL_PIP_COMMAND - return _get_package_description_with_version( - "mrbeam-ledstrips", - tier, - package_name="mrbeam-ledstrips", - pip_command=pip_command, - displayName="MrBeam LED Strips", - repo="MrBeamLedStrips", - pip="https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", - ) + return None -def _set_info_netconnectd_daemon(plugin, tier, beamos_date): - if beamos_date > BEAMOS_LEGACY_DATE: - branch = "master" - pip_command = "sudo /usr/local/netconnectd/venv/bin/pip" - else: - branch = "mrbeam2-stable" - pip_command = GLOBAL_PIP_COMMAND - package_name = "netconnectd" - # get_package_description does not search for package version. - version = get_version_of_pip_module(package_name, pip_command) - # get_package_description does not force "develop" branch. - return _get_package_description( - module_id="netconnectd-daemon", - tier=tier, - package_name=package_name, - displayName="Netconnectd Daemon", - displayVersion=version, - repo="netconnectd_mrbeam", - branch=branch, - branch_default=branch, - pip="https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", - pip_command=pip_command, - ) +def _generate_config_of_module( + module_id, input_moduleconfig, defaultsettings, tier, beamos_date, plugin +): + """ + generates the config of a software module + Args: + module_id: the id of the software module + input_moduleconfig: moduleconfig + defaultsettings: default settings + tier: software tier + beamos_date: date of the beamos + plugin: Mr Beam Plugin + + Returns: + software update informations for the module + """ + if tier in SW_UPDATE_TIERS: + # merge default settings and input is master + input_moduleconfig = dict_merge(defaultsettings, input_moduleconfig) + + # get update info for tier branch + tierversion = _get_tier_by_id(tier) + + if tierversion in input_moduleconfig: + input_moduleconfig = dict_merge( + input_moduleconfig, input_moduleconfig[tierversion] + ) # set tier config from default settings + + # have to be after the default config from file + + input_moduleconfig = dict_merge( + input_moduleconfig, + _generate_config_of_beamos(input_moduleconfig, beamos_date, tierversion), + ) + if "branch" in input_moduleconfig and "{tier}" in input_moduleconfig["branch"]: + input_moduleconfig["branch"] = input_moduleconfig["branch"].format( + tier=_get_tier_by_id(tier) + ) -def _set_info_iobeam(plugin, tier, beamos_date): - if beamos_date > BEAMOS_LEGACY_DATE: - pip_command = "sudo /usr/local/iobeam/venv/bin/pip" - else: - pip_command = GLOBAL_PIP_COMMAND - return _get_package_description_with_version( - module_id="iobeam", - tier=tier, - package_name="iobeam", - pip_command=pip_command, - displayName="iobeam", - type="bitbucket_commit", - repo="iobeam", - api_user="MrBeamDev", - api_password="v2T5pFkmdgDqbFBJAqrt", - pip="git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", - ) + if "update_script" in input_moduleconfig: + if "update_script_relative_path" not in input_moduleconfig: + raise softwareupdate_exceptions.ConfigurationInvalid( + "update_script_relative_path is missing in update config for {}".format( + module_id + ) + ) + try: + if not os.path.isdir(input_moduleconfig["update_folder"]): + os.makedirs(input_moduleconfig["update_folder"]) + except (IOError, OSError) as e: + _logger.error( + "could not create folder {} e:{}".format( + input_moduleconfig["update_folder"], e + ) + ) + user_notification_system = plugin.user_notification_system + user_notification_system.show_notifications( + user_notification_system.get_notification( + notification_id="update_fetching_information_err", + err_msg=["E-1002"], + replay=False, + ) + ) + update_script_path = os.path.join( + plugin._basefolder, input_moduleconfig["update_script_relative_path"] + ) + input_moduleconfig["update_script"] = input_moduleconfig[ + "update_script" + ].format(update_script=update_script_path) + current_version = _get_curent_version(input_moduleconfig, module_id, plugin) -def _set_info_mrb_hw_info(plugin, tier, beamos_date): - if beamos_date > BEAMOS_LEGACY_DATE: - pip_command = "sudo /usr/local/iobeam/venv/bin/pip" - else: - pip_command = GLOBAL_PIP_COMMAND - return _get_package_description_with_version( - module_id="mrb_hw_info", - tier=tier, - package_name="mrb-hw-info", - pip_command=pip_command, - displayName="mrb_hw_info", - type="bitbucket_commit", - repo="mrb_hw_info", - api_user="MrBeamDev", - api_password="v2T5pFkmdgDqbFBJAqrt", - pip="git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", - ) + if module_id != "octoprint": + _logger.debug( + "{module_id} current version: {current_version}".format( + module_id=module_id, current_version=current_version + ) + ) + input_moduleconfig["displayVersion"] = ( + current_version if current_version else "-" + ) + if "name" in input_moduleconfig: + input_moduleconfig["displayName"] = input_moduleconfig["name"] + + input_moduleconfig = _clean_update_config(input_moduleconfig) + + if "dependencies" in input_moduleconfig: + for dependencie_name, dependencie_config in input_moduleconfig[ + "dependencies" + ].items(): + input_moduleconfig["dependencies"][ + dependencie_name + ] = _generate_config_of_module( + dependencie_name, + dependencie_config, + {}, + tier, + beamos_date, + plugin, + ) + return input_moduleconfig + + +def _get_curent_version(input_moduleconfig, module_id, plugin): + """ + returns the version of the given module + Args: + input_moduleconfig: module to get the version for + module_id: id of the module + plugin: Mr Beam Plugin + + Returns: + version of the module or None + """ + # get version number + current_version = None + if ( + "global_pip_command" in input_moduleconfig + and "pip_command" not in input_moduleconfig + ): + input_moduleconfig["pip_command"] = GLOBAL_PIP_COMMAND + if "pip_command" in input_moduleconfig: + # get version number of pip modules + pip_command = input_moduleconfig["pip_command"] + # if global_pip_command is set module is installed outside of our virtualenv therefor we can't use default pip command. + # /usr/local/lib/python2.7/dist-packages must be writable for pi user otherwise OctoPrint won't accept this as a valid pip command + # pip_command = GLOBAL_PIP_COMMAND + package_name = ( + input_moduleconfig["package_name"] + if "package_name" in input_moduleconfig + else module_id + ) + current_version_global_pip = get_version_of_pip_module( + package_name, pip_command + ) + if current_version_global_pip is not None: + current_version = current_version_global_pip -@logExceptions -def _get_octo_plugin_description(module_id, tier, plugin, **kwargs): - """Additionally get the version from plugin manager (doesn't it do that by default??)""" - # Commented pluginInfo -> If the module is not installed, then it Should be. - pluginInfo = plugin._plugin_manager.get_plugin_info(module_id) - if pluginInfo is None: - display_version = None else: - display_version = pluginInfo.version - if tier == SW_UPDATE_TIER_DEV: - # Fix: the develop branches are not formatted as "mrbeam2-{tier}" - _b = DEFAULT_REPO_BRANCH_ID[SW_UPDATE_TIER_DEV] - kwargs.update(branch=_b, branch_default=_b) - return _get_package_description( - module_id=module_id, tier=tier, displayVersion=display_version, **kwargs - ) - - -@logExceptions -def _get_package_description_with_version( - module_id, tier, package_name, pip_command, **kwargs -): - """Additionally get the version diplayed through pip_command""" - if tier == SW_UPDATE_TIER_DEV: - # Fix: the develop branches are not formatted as "mrbeam2-{tier}" - _b = DEFAULT_REPO_BRANCH_ID[SW_UPDATE_TIER_DEV] - kwargs.update(branch=_b, branch_default=_b) - - version = get_version_of_pip_module(package_name, pip_command) - if version: - kwargs.update(dict(displayVersion=version)) - - return _get_package_description( - module_id=module_id, tier=tier, pip_command=pip_command, **kwargs - ) - - -def _get_package_description( - module_id, - tier, - displayName=None, - type="github_commit", - user="mrbeam", - branch="mrbeam2-{tier}", - branch_default="mrbeam2-{tier}", - restart="environment", - prerelease_channel=None, - **kwargs -): - """Shorthand to create repo details for octoprint software update plugin to handle.""" - displayName = displayName or module_id - if "{tier}" in branch: - branch = branch.format(tier=get_tier_by_id(tier)) - if "{tier}" in branch_default: - branch_default = branch_default.format(tier=get_tier_by_id(tier)) - if prerelease_channel and "{tier}" in prerelease_channel: - kwargs.update(prerelease_channel=prerelease_channel.format(tier=get_tier_by_id(tier))) - if tier in (SW_UPDATE_TIER_DEV, SW_UPDATE_TIER_ALPHA): - # adds pip upgrade flag in the develop tier so it will do a upgrade even without a version bump - kwargs.update(pip_upgrade_flag=True) - update_info = dict( - tier=tier, - displayName=displayName, - user=user, - type=type, - branch=branch, - branch_default=branch_default, - restart=restart, - **kwargs - ) - return {module_id: update_info} - - -def get_tier_by_id(tier): + # get versionnumber of octoprint plugin + pluginInfo = plugin._plugin_manager.get_plugin_info(module_id) + if pluginInfo is not None: + current_version = pluginInfo.version + return current_version + + +def _generate_config_of_beamos(moduleconfig, beamos_date, tierversion): + """ + generates the config for the given beamos_date of the tierversion + Args: + moduleconfig: update config of the module + beamos_date: date of the beamos + tierversion: software tier + + Returns: + beamos config of the tierversion + """ + if "beamos_date" not in moduleconfig: + return {} + + beamos_date_config = {} + prev_beamos_date_entry = datetime.strptime("2000-01-01", "%Y-%m-%d").date() + for date, beamos_config in moduleconfig["beamos_date"].items(): + if ( + beamos_date >= datetime.strptime(date, "%Y-%m-%d").date() + and prev_beamos_date_entry < beamos_date + ): + prev_beamos_date_entry = datetime.strptime(date, "%Y-%m-%d").date() + if tierversion in beamos_config: + beamos_config_module_tier = beamos_config[tierversion] + beamos_config = dict_merge( + beamos_config, beamos_config_module_tier + ) # override tier config from tiers set in config_file + beamos_date_config = dict_merge(beamos_date_config, beamos_config) + return beamos_date_config + + +def _clean_update_config(update_config): + """ + removes working parameters from the given config + Args: + update_config: update config information + + Returns: + cleaned version of the update config + """ + pop_list = ["alpha", "beta", "stable", "develop", "beamos_date", "name"] + for key in set(update_config).intersection(pop_list): + del update_config[key] + return update_config + + +def _get_tier_by_id(tier): + """ + returns the tier name with the given id + Args: + tier: id of the software tier + + Returns: + softwaretier name + """ return DEFAULT_REPO_BRANCH_ID.get(tier, tier) - - -def _is_override_in_settings(plugin, module_id): - settings_path = ["plugins", "softwareupdate", "checks", module_id, "override"] - is_override = plugin._settings.global_get(settings_path) - if is_override: - _logger.info("Module %s has overriding config in settings!", module_id) - return True - return False diff --git a/octoprint_mrbeam/static/css/mrbeam.css b/octoprint_mrbeam/static/css/mrbeam.css index a077bfb62..30224dc15 100644 --- a/octoprint_mrbeam/static/css/mrbeam.css +++ b/octoprint_mrbeam/static/css/mrbeam.css @@ -2647,6 +2647,13 @@ input.search-query, bottom: 0; } +/* +hides the force update buttons + */ +#settings_plugin_softwareupdate_scroll_wrapper div:nth-of-type(4) { + display:none; +} + /* * === FRESHDESK FEEDBACK WIDGET === */ diff --git a/octoprint_mrbeam/static/js/software_channel_selector.js b/octoprint_mrbeam/static/js/software_channel_selector.js index a50aa95e0..6b5d48fc9 100644 --- a/octoprint_mrbeam/static/js/software_channel_selector.js +++ b/octoprint_mrbeam/static/js/software_channel_selector.js @@ -6,6 +6,7 @@ $(function () { self.loginState = params[0]; self.settings = params[1]; self.softwareUpdate = params[2]; + self.analytics = params[3]; self.selector = ko.observable("PROD"); self.available_channels = ko.observableArray([]); @@ -91,6 +92,16 @@ $(function () { self.softwareUpdate.performCheck(true, false, true); }; + // get the hook when softwareUpdate perform the Updatecheck to force the update on the normal button + self.performCheck_copy = self.softwareUpdate.performCheck; + self.softwareUpdate.performCheck= function(showIfNothingNew, force, ignoreSeen) { + self.reload_update_info(); + if (force !== undefined) { + force = true; //only forces the update check if it was disabled ("check for update" button press) + } + self.performCheck_copy(showIfNothingNew, force, ignoreSeen); + }; + /** * This one wraps all content of the #settings_plugin_softwareupdate elem into a div * which makes the whole page scrollable. it's a bit tricky/dirty because the content comes from OP. @@ -116,18 +127,31 @@ $(function () { ); button.addClass("sticky-footer"); }; + self.reload_update_info = function(){ + OctoPrint.post("plugin/mrbeam/info/update") + .done(function (response) { + }) + .fail(function (error) { + console.error("Unable to reload update info."); + self.analytics.send_fontend_event("update_info_call_failure", {error_message: error}) + console.error("test"); + }); + } } + let DOM_ELEMENT_TO_BIND_TO = "software_channel_selector"; + // view model class, parameters for constructor, container to bind to OCTOPRINT_VIEWMODELS.push([ SoftwareChannelSelector, // e.g. loginStateViewModel, settingsViewModel, ... - ["loginStateViewModel", "settingsViewModel", "softwareUpdateViewModel"], + ["loginStateViewModel", "settingsViewModel", "softwareUpdateViewModel", "analyticsViewModel"], // e.g. #settings_plugin_mrbeam, #tab_plugin_mrbeam, ... [document.getElementById(DOM_ELEMENT_TO_BIND_TO)], ]); }); + diff --git a/octoprint_mrbeam/static/js/user_notification_viewmodel.js b/octoprint_mrbeam/static/js/user_notification_viewmodel.js index 8fbb03626..002dd9dc5 100644 --- a/octoprint_mrbeam/static/js/user_notification_viewmodel.js +++ b/octoprint_mrbeam/static/js/user_notification_viewmodel.js @@ -51,6 +51,30 @@ $(function () { type: "info", hide: true, }, + missing_updateinformation_info: { + title: gettext("No update information"), + text: gettext( + "No information about available updates could be retrieved, please try again later. Errorcode: E-1000" + ), + type: "info", + hide: false, + }, + write_error_update_info_file_err: { + title: gettext("Error during fetching update information"), + text: gettext( + "There was a error during fetching the update information Errorcode: E-1001" + ), + type: "error", + hide: false, + }, + update_fetching_information_err: { + title: gettext("Error during fetching update information"), + text: gettext( + "There was a error during fetching the update information, please try again later." + ), + type: "error", + hide: false, + }, err_cam_conn_err: { title: gettext("Camera Error"), text: gettext( diff --git a/octoprint_mrbeam/templates/mrbeam_ui_index.jinja2 b/octoprint_mrbeam/templates/mrbeam_ui_index.jinja2 index 2adb0a603..e44708596 100644 --- a/octoprint_mrbeam/templates/mrbeam_ui_index.jinja2 +++ b/octoprint_mrbeam/templates/mrbeam_ui_index.jinja2 @@ -98,13 +98,9 @@ {{ _('Exit Fullscreen') }}
  • - {% if model in ["MRBEAM2", "MRBEAM2_DC_R1"] %} -
  • {{ _('Quickstart Guide') }}
    • -
  • {{ _('User Manual') }}
    • - {% else %} -
  • {{ _('Quickstart Guide') }}
    • -
  • {{ _('User Manual') }}
    • - {% endif %} + {% for document in burger_menu_model.documents %} +
  • {{ document.title }}
    • + {% endfor %}
  • {{ _('Support') }}
  • diff --git a/octoprint_mrbeam/templates/settings/about_settings.jinja2 b/octoprint_mrbeam/templates/settings/about_settings.jinja2 index b31a05071..3abda45c0 100644 --- a/octoprint_mrbeam/templates/settings/about_settings.jinja2 +++ b/octoprint_mrbeam/templates/settings/about_settings.jinja2 @@ -67,35 +67,15 @@
    {{ _('Documentation, Support and Privacy') }}
      -
      {{ _('Quickstart Guide') }}: - {% if model in ["MRBEAM2", "MRBEAM2_DC_R1"] %} - en | - de | - {% else %} - en | - de | - {% endif %} - {{ _('get the latest versions') }} {{ _('online') }} -
      -
      {{ _('User Manual') }}: - {% if model in ["MRBEAM2", "MRBEAM2_DC_R1"] %} - en | - de | - es | - fr | - it | - fi | - {% else %} - en | - de | - es | - fr | - it | - nl | - fi | - {% endif %} - {{ _('get the latest versions') }} {{ _('online') }} -
      + {% for document in settings_model.about.support_documents %} +
      + {{ document.title }} + {% for link in document.document_links | sort_enum(attribute='language') %} + {{ link.language.value }} | + {% endfor %} + {{ _('get the latest versions') }} {{ _('online') }} +
      + {% endfor %}
      {{ _('Online Support Portal') }}: mr-beam.org/support
      {{ _('Privacy Policies') }}: diff --git a/octoprint_mrbeam/util/connectivity_checker.py b/octoprint_mrbeam/util/connectivity_checker.py new file mode 100644 index 000000000..8e4ab5a7b --- /dev/null +++ b/octoprint_mrbeam/util/connectivity_checker.py @@ -0,0 +1,48 @@ +import threading +import logging + + +class ConnectivityChecker(object): + """Abstraction of Octoprints connectivity checker 'util/__init__.py #1300'""" + + def __init__(self, plugin): + self._check_worker = None + self._check_mutex = threading.RLock() + self._plugin = plugin + + self._logger = logging.getLogger( + "octoprint.plugins." + __name__ + ".connectivity_checker" + ) + + @property + def online(self): + """ + + Args: + + Returns: + boolean: is the device connected to the internet, returns None if the octoprint checker is disabled + + """ + with self._check_mutex: + # if the octoprint connectivity checker is disabled return None instead of true + if self._plugin._octoprint_connectivity_checker.enabled: + # returns the value of the octoprint connectifity checker, this value returns true if the octoprint onlinechecker is disabled + return self._plugin._octoprint_connectivity_checker.online + else: + return None + + def check_immediately(self): + """ + checks immediatley for a internet connection and don't wait for the interval + + Args: + + Returns: + boolean: is the device connected to the internet + + """ + with self._check_mutex: + # calls the octoprint check_immediately methode to run the checker immediately + self._plugin._octoprint_connectivity_checker.check_immediately() + return self.online diff --git a/octoprint_mrbeam/util/github_api.py b/octoprint_mrbeam/util/github_api.py new file mode 100644 index 000000000..cf277b509 --- /dev/null +++ b/octoprint_mrbeam/util/github_api.py @@ -0,0 +1,58 @@ +""" +This util contains all the necessary methods to communicate with the github api +""" +import base64 + +from requests.adapters import HTTPAdapter, MaxRetryError +from requests import ConnectionError +from urllib3 import Retry + +from octoprint_mrbeam.mrb_logger import mrb_logger +import requests +import json + +_logger = mrb_logger("octoprint.plugins.mrbeam.util.github_api") + + +def get_file_of_repo_for_tag(file, repo, tag): + """ + return the content of the of the repo for the given tag/branch/hash + + Args: + file: file + tag: tag/branch/hash + repo: github repository + + Returns: + content of file + """ + try: + url = "https://api.github.com/repos/mrbeam/{repo}/contents/{file}?ref={tag}".format( + repo=repo, file=file, tag=tag + ) + + headers = { + "Accept": "application/json", + } + + s = requests.Session() + retry = Retry(connect=3, backoff_factor=0.3) + adapter = HTTPAdapter(max_retries=retry) + s.mount("https://", adapter) + s.keep_alive = False + + response = s.request("GET", url, headers=headers) + except MaxRetryError: + _logger.warning("timeout while trying to get the file") + return None + except ConnectionError: + _logger.warning("connection error while trying to get the file") + return None + + if response: + json_data = json.loads(response.text) + content = base64.b64decode(json_data["content"]) + return content + else: + _logger.warning("no valid response for the file - {}".format(response)) + return None diff --git a/octoprint_mrbeam/util/pip_util.py b/octoprint_mrbeam/util/pip_util.py index 491a0a265..d6a65818c 100644 --- a/octoprint_mrbeam/util/pip_util.py +++ b/octoprint_mrbeam/util/pip_util.py @@ -1,3 +1,5 @@ +from octoprint.plugins.softwareupdate.updaters.pip import _get_pip_caller +from octoprint.util.pip import PipCaller from octoprint_mrbeam.mrb_logger import mrb_logger from cmd_exec import exec_cmd_output @@ -62,3 +64,41 @@ def get_version_of_pip_module(pip_name, pip_command=None, disable_pip_ver_check= break _logger.debug("%s==%s", pip_name, version) return version + + +def get_pip_caller(venv, _logger=None): + """ + gets the pip caller of the givenv venv + + Args: + venv: path to venv + _logger: logger to log call, stdout and stderr of the pip caller + + Returns: + PipCaller of the venv + """ + pip_caller = _get_pip_caller(command=venv) + if not isinstance(pip_caller, PipCaller): + raise RuntimeError("Can't run pip", None) + + def _log_call(*lines): + _log(lines, prefix=" ", stream="call") + + def _log_stdout(*lines): + _log(lines, prefix=">", stream="stdout") + + def _log_stderr(*lines): + _log(lines, prefix="!", stream="stderr") + + def _log(lines, prefix=None, stream=None, strip=True): + if strip: + lines = map(lambda x: x.strip(), lines) + for line in lines: + print(u"{} {}".format(prefix, line)) + + if _logger is not None: + pip_caller.on_log_call = _log_call + pip_caller.on_log_stdout = _log_stdout + pip_caller.on_log_stderr = _log_stderr + + return pip_caller diff --git a/octoprint_mrbeam/util/string_util.py b/octoprint_mrbeam/util/string_util.py new file mode 100644 index 000000000..757790dcc --- /dev/null +++ b/octoprint_mrbeam/util/string_util.py @@ -0,0 +1,11 @@ +import re + + +def separate_camelcase_words(string, separator=' '): + if string is None: + return '' + return remove_extra_spaces(re.sub(r"(\w)([A-Z])", r"\1" + separator + r"\2", string)) + + +def remove_extra_spaces(string): + return re.sub(' +', ' ', string).strip() diff --git a/pytest.ini b/pytest.ini index 5410868eb..4a0c61b46 100644 --- a/pytest.ini +++ b/pytest.ini @@ -8,7 +8,7 @@ log_cli = True log_cli_format = %(asctime)s %(levelname)s %(message)s log_cli_level = DEBUG log_date_format = %H:%M:%S -log_file = tests/logs/pytest-logs.txt +log_file = pytest-logs.txt log_file_date_format = %Y-%m-%d %H:%M:%S log_file_format = %(asctime)s %(levelname)s %(message)s log_file_level = INFO diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 000000000..9042a9b78 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,15 @@ + +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[metadata] +description-file = README.md + +[versioneer] +VCS = git +style = pep440-post +versionfile_source = octoprint_mrbeam/_version.py +versionfile_build = octoprint_mrbeam/_version.py +tag_prefix = v +parentdir_prefix = diff --git a/setup.py b/setup.py index 86ea6791a..4d751c8ee 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,5 @@ # coding=utf-8 - - -execfile("octoprint_mrbeam/__version.py") +import versioneer ######################################################################################################################## ### Do not forget to adjust the following variables to your own plugin. @@ -17,7 +15,7 @@ plugin_name = "Mr_Beam" # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module -plugin_version = __version__ +plugin_version = versioneer.get_version() # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin # module @@ -48,6 +46,8 @@ "pillow", "lxml", "numpy", + "pyyaml", + "enum34", picamera, ] @@ -106,6 +106,7 @@ package=plugin_package, name=plugin_name, version=plugin_version, + cmdclass=versioneer.get_cmdclass(), description=plugin_description, author=plugin_author, mail=plugin_author_email, diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/logger/__init__.py b/tests/logger/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/logger/test_logger.py b/tests/logger/test_logger.py new file mode 100644 index 000000000..815b0bb29 --- /dev/null +++ b/tests/logger/test_logger.py @@ -0,0 +1,33 @@ +class LoggerMock: + def __init__(self): + pass + + def comm(self, msg, *args, **kwargs): + pass + + def debug(self, msg, *args, **kwargs): + pass + + def info(self, msg, *args, **kwargs): + pass + + def warn(self, msg, *args, **kwargs): + pass + + def warning(self, msg, *args, **kwargs): + pass + + def error(self, msg, *args, **kwargs): + pass + + def exception(self, msg, *args, **kwargs): + pass + + def critical(self, msg, *args, **kwargs): + pass + + def setLevel(self, *args, **kwargs): + pass + + def log(self, level, msg, *args, **kwargs): + pass diff --git a/tests/migrations/test-migration-Mig001.py b/tests/migrations/test-migration-Mig001.py index d85a2e407..00f6f8b8e 100644 --- a/tests/migrations/test-migration-Mig001.py +++ b/tests/migrations/test-migration-Mig001.py @@ -6,23 +6,37 @@ class TestMigrationMig001(unittest.TestCase): """ Testclass for the migration Mig001 """ + def setUp(self): self.m001 = Mig001NetconnectdDisableLogDebugLevel(None) def test_beamos_versions(self): # beamos versions where the migration should not run - self.assertFalse(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.14.0")) - self.assertFalse(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.2")) + self.assertFalse( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.14.0") + ) + self.assertFalse( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.2") + ) # beamos versions where the migration should run - self.assertTrue(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.0")) - self.assertTrue(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.1")) + self.assertTrue( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.0") + ) + self.assertTrue( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0.18.1") + ) # not matching pattern strings - self.assertFalse(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, None)) - self.assertFalse(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "14.0")) - self.assertFalse(self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0")) + self.assertFalse( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, None) + ) + self.assertFalse( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "14.0") + ) + self.assertFalse( + self.m001.shouldrun(Mig001NetconnectdDisableLogDebugLevel, "0") + ) def test_migration_id(self): - self.assertEqual(self.m001.id, '001') - + self.assertEqual(self.m001.id, "001") diff --git a/tests/migrations/test-migration-Mig002.py b/tests/migrations/test-migration-Mig002.py new file mode 100644 index 000000000..56475ed48 --- /dev/null +++ b/tests/migrations/test-migration-Mig002.py @@ -0,0 +1,29 @@ +from octoprint_mrbeam.migration.Mig002 import Mig002EnableOnlineCheck +import unittest + + +class TestMigrationMig002(unittest.TestCase): + """ + Testclass for the migration Mig001 + """ + + def setUp(self): + self.m002 = Mig002EnableOnlineCheck(None) + + def test_beamos_versions(self): + # beamos versions where the migration should not run + self.assertFalse(self.m002.shouldrun(Mig002EnableOnlineCheck, "0.18.3")) + + # beamos versions where the migration should run + self.assertTrue(self.m002.shouldrun(Mig002EnableOnlineCheck, "0.14.0")) + self.assertTrue(self.m002.shouldrun(Mig002EnableOnlineCheck, "0.18.0")) + self.assertTrue(self.m002.shouldrun(Mig002EnableOnlineCheck, "0.18.1")) + self.assertTrue(self.m002.shouldrun(Mig002EnableOnlineCheck, "0.18.2")) + + # not matching pattern strings + self.assertFalse(self.m002.shouldrun(Mig002EnableOnlineCheck, None)) + self.assertFalse(self.m002.shouldrun(Mig002EnableOnlineCheck, "14.0")) + self.assertFalse(self.m002.shouldrun(Mig002EnableOnlineCheck, "0")) + + def test_migration_id(self): + self.assertEqual(self.m002.id, "002") diff --git a/tests/rest_handler/__init__.py b/tests/rest_handler/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/rest_handler/test_docs_handler.py b/tests/rest_handler/test_docs_handler.py new file mode 100644 index 000000000..c98df51bd --- /dev/null +++ b/tests/rest_handler/test_docs_handler.py @@ -0,0 +1,45 @@ +from unittest import TestCase + +from mock import patch, MagicMock +from octoprint_mrbeamdoc.enum.mrbeam_doctype import MrBeamDocType +from octoprint_mrbeamdoc.enum.mrbeam_model import MrBeamModel +from octoprint_mrbeamdoc.enum.supported_languages import SupportedLanguage +from werkzeug.exceptions import NotFound + +from octoprint_mrbeam import DocsRestHandlerMixin +from tests.logger.test_logger import LoggerMock + + +class TestDocsRestHandlerMixin(TestCase): + def setUp(self): + super(TestDocsRestHandlerMixin, self).setUp() + self.docs_handler = DocsRestHandlerMixin() + self.docs_handler._logger = LoggerMock() + + def test_unknown_model__then_returns_not_found(self): + self.assertRaises(NotFound, self.docs_handler.get_doc, + 'unknown', + MrBeamDocType.QUICKSTART_GUIDE.value, + SupportedLanguage.ENGLISH.value, + 'pdf') + + def test_unknown_type__then_returns_not_found(self): + self.assertRaises(NotFound, self.docs_handler.get_doc, + MrBeamModel.MRBEAM2.value, + 'unknown', + SupportedLanguage.ENGLISH.value, + 'pdf') + + def test_unsupported_language__then_returns_not_found(self): + self.assertRaises(NotFound, self.docs_handler.get_doc, + MrBeamModel.MRBEAM2.value, + MrBeamDocType.QUICKSTART_GUIDE.value, + 'unsupported', + 'pdf') + + @patch('octoprint_mrbeam.rest_handler.docs_handler.send_file') + def test_existing_file_request__then_send_file_is_called(self, send_file_mock): + send_file_mock.return_value = MagicMock(status_code=200, response='') + doc = self.docs_handler.get_doc(MrBeamModel.MRBEAM2.value, MrBeamDocType.QUICKSTART_GUIDE.value, + SupportedLanguage.ENGLISH.value, 'pdf') + send_file_mock.assert_called_once() diff --git a/tests/services/__init__.py b/tests/services/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/services/test_burger_menu_service.py b/tests/services/test_burger_menu_service.py new file mode 100644 index 000000000..3551d5306 --- /dev/null +++ b/tests/services/test_burger_menu_service.py @@ -0,0 +1,54 @@ +from unittest import TestCase + +from mock import patch, MagicMock +from octoprint_mrbeamdoc.enum.mrbeam_doctype import MrBeamDocType +from octoprint_mrbeamdoc.enum.mrbeam_model import MrBeamModel +from octoprint_mrbeamdoc.enum.supported_languages import SupportedLanguage +from octoprint_mrbeamdoc.model.mrbeam_doc_definition import MrBeamDocDefinition + +from octoprint_mrbeam.services.document_service import DocumentService +from octoprint_mrbeam.services.burger_menu_service import BurgerMenuService +from tests.logger.test_logger import LoggerMock + + +class TestBurgerMenuService(TestCase): + + def setUp(self): + super(TestBurgerMenuService, self).setUp() + logger = LoggerMock() + self._burger_menu_service = BurgerMenuService(logger, DocumentService(logger)) + + def test_get_burger_menu_model__with_none__should_return_empty_burger_menu_model(self): + burger_menu_model = self._burger_menu_service.get_burger_menu_model(None) + self.assertIs(len(burger_menu_model.documents), 0) + + @patch('octoprint_mrbeam.services.burger_menu_service.get_locale') + def test_get_burger_menu_model__with_unsupported_language__should_return_default_to_english(self, get_locale_mock): + get_locale_mock.return_value = MagicMock(language='ch') + burger_menu_model = self._burger_menu_service.get_burger_menu_model(MrBeamModel.MRBEAM2.value) + self.assertIsNot(len(burger_menu_model.documents), 0) + for document in burger_menu_model.documents: + self.assertEquals(document.document_link.language, SupportedLanguage.ENGLISH) + + @patch('octoprint_mrbeam.services.burger_menu_service.MrBeamDocUtils.get_mrbeam_definitions_for') + @patch('octoprint_mrbeam.services.burger_menu_service.get_locale') + def test_get_burger_menu_model__with_language_not_valid_for_definition__should_fallback_to_english(self, + get_locale_mock, + get_mrbeam_definitions_for_mock): + get_locale_mock.return_value = MagicMock(language='de') + MOCK_DEFINITION = MrBeamDocDefinition(MrBeamDocType.QUICKSTART_GUIDE, MrBeamModel.MRBEAM2, + [SupportedLanguage.ENGLISH]) + get_mrbeam_definitions_for_mock.return_value = [MOCK_DEFINITION] + burger_menu_model = self._burger_menu_service.get_burger_menu_model(MrBeamModel.MRBEAM2.value) + self.assertIsNot(len(burger_menu_model.documents), 0) + for document in burger_menu_model.documents: + self.assertEquals(document.document_link.language, SupportedLanguage.ENGLISH) + + @patch('octoprint_mrbeam.services.burger_menu_service.get_locale') + def test_get_burger_menu_model__with_supported_language__should_return_documents_in_that_language(self, + get_locale_mock): + get_locale_mock.return_value = MagicMock(language='de') + burger_menu_model = self._burger_menu_service.get_burger_menu_model(MrBeamModel.MRBEAM2.value) + self.assertIsNot(len(burger_menu_model.documents), 0) + for document in burger_menu_model.documents: + self.assertEquals(document.document_link.language, SupportedLanguage.GERMAN) diff --git a/tests/services/test_settings_service.py b/tests/services/test_settings_service.py new file mode 100644 index 000000000..0a63bdef2 --- /dev/null +++ b/tests/services/test_settings_service.py @@ -0,0 +1,57 @@ +from unittest import TestCase + +from octoprint_mrbeamdoc.enum.mrbeam_model import MrBeamModel + +from octoprint_mrbeam import DocumentService +from octoprint_mrbeam.services.settings_service import SettingsService +from tests.logger.test_logger import LoggerMock + + +class TestSettingsService(TestCase): + def setUp(self): + super(TestSettingsService, self).setUp() + logger = LoggerMock() + self._settings_service = SettingsService(logger, DocumentService(logger)) + + def test_get_template_settings_model_with_none__then_return_settings_empty_object(self): + settings_model = self._settings_service.get_template_settings_model(None) + self._validate_empty_settings_model(settings_model) + + def test_get_template_settings_model_with_unknown__then_return_settings_empty_object(self): + settings_model = self._settings_service.get_template_settings_model('unknown') + self._validate_empty_settings_model(settings_model) + + def test_get_template_settings_model_with_mrbeam2__then_return_settings_with_about_and_nonempty_documents(self): + settings_model = self._settings_service.get_template_settings_model(MrBeamModel.MRBEAM2.value) + self._validate_settings_model(settings_model) + + def test_get_template_settings_model_with_dreamcut__then_return_settings_with_about_and_nonempty_documents(self): + settings_model = self._settings_service.get_template_settings_model(MrBeamModel.DREAMCUT_S.value) + self._validate_settings_model(settings_model) + + def _validate_empty_settings_model(self, settings_model): + self.assertIsNotNone(settings_model) + self.assertIsNotNone(settings_model.about) + self.assertIsNotNone(settings_model.about.support_documents) + self.assertEquals(settings_model.about.support_documents, []) + + def _validate_settings_model(self, settings_model): + self.assertIsNotNone(settings_model) + self.assertIsNotNone(settings_model.about) + documents = settings_model.about.support_documents + self.assertIsNotNone(documents) + for document in documents: + self.assertIsNotNone(document) + self.assertIsNotNone(document.title) + for document_link in document.document_links: + self.assertIsNotNone(document_link) + self.assertIsNotNone(document_link.language) + self.assertIsNotNone(document_link.language.name) + self.assertNotEquals(document_link.language.name, '') + self.assertNotEquals(document_link.language.name, ' ') + self.assertIsNotNone(document_link.language.value) + self.assertNotEquals(document_link.language.value, '') + self.assertNotEquals(document_link.language.value, ' ') + self.assertIsNotNone(document_link.url) + self.assertNotEquals(document_link.url, '') + self.assertNotEquals(document_link.url, ' ') diff --git a/tests/softwareupdate/__init__.py b/tests/softwareupdate/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/softwareupdate/mock_config.json b/tests/softwareupdate/mock_config.json new file mode 100644 index 000000000..826132cf9 --- /dev/null +++ b/tests/softwareupdate/mock_config.json @@ -0,0 +1,156 @@ +{ + "default": { + "type": "github_commit", + "user": "mrbeam", + "release_compare": "unequal", + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release" + }, + "restart": "environment", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + }, + "modules": { + "octoprint": { + "type": "github_release", + "develop": { + "type": "github_commit" + } + }, + "mrbeam": { + "name": " MrBeam Plugin", + "repo": "MrBeamPlugin", + "restart": "environment", + "pip": "https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", + "develop": { + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "alpha": { + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "dependencies": { + "mrbeam-ledstrips": { + "repo": "MrBeamLedStrips", + "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", + "global_pip_command": true, + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + } + } + }, + "iobeam": { + "repo": "iobeam", + "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", + "global_pip_command": true, + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + }, + "mrb-hw-info": { + "repo": "mrb_hw_info", + "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", + "global_pip_command": true, + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + }, + "mrbeamdoc": { + "repo": "MrBeamDoc", + "pip": "https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip" + } + } + }, + "netconnectd": { + "name": "OctoPrint-Netconnectd Plugin", + "repo": "OctoPrint-Netconnectd", + "pip": "https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", + "restart": "environment", + "dependencies": { + "netconnectd": { + "repo": "netconnectd_mrbeam", + "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", + "global_pip_command": true, + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + } + } + } + }, + "develop": { + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "alpha": { + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + } + }, + "findmymrbeam": { + "name": "OctoPrint-FindMyMrBeam", + "repo": "OctoPrint-FindMyMrBeam", + "pip": "https://github.com/mrbeam/OctoPrint-FindMyMrBeam/archive/{target_version}.zip", + "restart": "octoprint" + } + } +} \ No newline at end of file diff --git a/tests/softwareupdate/target_find_my_mr_beam_config.json b/tests/softwareupdate/target_find_my_mr_beam_config.json new file mode 100644 index 000000000..8bc386195 --- /dev/null +++ b/tests/softwareupdate/target_find_my_mr_beam_config.json @@ -0,0 +1,62 @@ +{ + "displayName": "OctoPrint-FindMyMrBeam", + "repo": "OctoPrint-FindMyMrBeam", + "displayVersion": "dummy", + "pip": "https://github.com/mrbeam/OctoPrint-FindMyMrBeam/archive/{target_version}.zip", + "type": "github_commit", + "restart": "octoprint", + "user": "mrbeam", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ], + "release_compare": "unequal", + "tiers": { + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha", + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release", + } + } +} \ No newline at end of file diff --git a/tests/softwareupdate/target_mrbeam_config.json b/tests/softwareupdate/target_mrbeam_config.json new file mode 100644 index 000000000..108f9fa3b --- /dev/null +++ b/tests/softwareupdate/target_mrbeam_config.json @@ -0,0 +1,113 @@ +{ + "displayName": " MrBeam Plugin", + "repo": "MrBeamPlugin", + "restart": "environment", + "pip": "https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", + "type": "github_commit", + "user": "mrbeam", + "dependencies": { + "mrbeam-ledstrips": { + "repo": "MrBeamLedStrips", + "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + } + } + }, + "iobeam": { + "repo": "iobeam", + "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + }, + "mrb-hw-info": { + "repo": "mrb_hw_info", + "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + }, + "mrbeamdoc": { + "pip": "https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip", + "repo": "MrBeamDoc", + "displayVersion": "dummy" + } + }, + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ], + "release_compare": "unequal", + "tiers": { + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha", + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release", + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + } + }, + "displayVersion": "dummy" +} \ No newline at end of file diff --git a/tests/softwareupdate/target_netconnectd_config.json b/tests/softwareupdate/target_netconnectd_config.json new file mode 100644 index 000000000..349d4de7b --- /dev/null +++ b/tests/softwareupdate/target_netconnectd_config.json @@ -0,0 +1,84 @@ +{ + "displayVersion": "dummy", + "displayName": "OctoPrint-Netconnectd Plugin", + "user": "mrbeam", + "repo": "OctoPrint-Netconnectd", + "pip": "https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", + "restart": "environment", + "type": "github_commit", + "dependencies": { + "netconnectd": { + "displayVersion": "-", + "repo": "netconnectd_mrbeam", + "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", + "global_pip_command": true, + "pip_command": "sudo /usr/local/bin/pip", + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip", + } + } + } + }, + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ], + "release_compare": "unequal", + "tiers": { + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha", + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/../octoprint_netconnectd/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release", + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/../octoprint_netconnectd/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + } + } +} \ No newline at end of file diff --git a/tests/softwareupdate/target_octoprint_config.json b/tests/softwareupdate/target_octoprint_config.json new file mode 100644 index 000000000..2f982a437 --- /dev/null +++ b/tests/softwareupdate/target_octoprint_config.json @@ -0,0 +1,142 @@ +{ + "develop": { + "type": "github_commit", + "restart": "environment", + "user": "mrbeam", + "branch": "alpha", + "branch_default": "alpha", + "release_compare": "unequal", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + }, + "beta": { + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true, + "restart": "environment", + "user": "mrbeam", + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "release_compare": "unequal", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + }, + "alpha": { + "type": "github_release", + "prerelease_channel": "alpha", + "prerelease": true, + "restart": "environment", + "user": "mrbeam", + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "release_compare": "unequal", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + }, + "stable": { + "type": "github_commit", + "restart": "environment", + "user": "mrbeam", + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "release_compare": "unequal", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + } +} \ No newline at end of file diff --git a/tests/softwareupdate/test_cloud_config.py b/tests/softwareupdate/test_cloud_config.py new file mode 100644 index 000000000..3b263f070 --- /dev/null +++ b/tests/softwareupdate/test_cloud_config.py @@ -0,0 +1,574 @@ +# coding=utf-8 +from __future__ import absolute_import, division, print_function + +import base64 +import json +import os +import unittest +from os.path import dirname, realpath + +import requests +import requests_mock +from copy import deepcopy +from datetime import date, datetime +from mock import mock_open +from mock import patch +from octoprint.events import EventManager +import yaml + +from octoprint_mrbeam import ( + deviceInfo, + IS_X86, + mrb_logger, + user_notification_system, + MrBeamPlugin, +) +from octoprint_mrbeam.software_update_information import ( + _get_tier_by_id, + get_update_information, + SW_UPDATE_INFO_FILE_NAME, + SW_UPDATE_TIERS, +) +from octoprint_mrbeam.user_notification_system import UserNotificationSystem +from octoprint_mrbeam.util import dict_merge +from octoprint_mrbeam.util.device_info import DeviceInfo + +TMP_BASE_FOLDER_PATH = "/tmp/cloud_config_test/" + + +class SettingsDummy(object): + tier = None + + def getBaseFolder(self, args, **kwargs): + return TMP_BASE_FOLDER_PATH + + def get(self, list): + return self.tier + + def set(self, tier): + self.tier = tier + + def settings(self, init=False, basedir=None, configfile=None): + return None + + +class DummyConnectivityChecker: + online = True + + def check_immediately(self): + return self.online + + +class PluginInfoDummy: + _refresh_configured_checks = None + _version_cache = None + _version_cache_dirty = None + + +class PluginManagerDummy: + version = "dummy" + implementation = PluginInfoDummy() + + def send_plugin_message(self, *args): + return True + + def get_plugin_info(self, module_id): + return self + + +class MrBeamPluginDummy(MrBeamPlugin): + _settings = SettingsDummy() + _plugin_manager = PluginManagerDummy() + _device_info = deviceInfo(use_dummy_values=IS_X86) + _connectivity_checker = DummyConnectivityChecker() + _plugin_version = "dummy" + _event_bus = EventManager() + _basefolder = "octoprint_mrbeam" + + @patch("octoprint.settings.settings") + def __init__(self, settings_mock): + settings_mock.return_value = None + self._logger = mrb_logger("test.Plugindummy") + self.user_notification_system = user_notification_system(self) + + +class SoftwareupdateConfigTestCase(unittest.TestCase): + _softwareupdate_handler = None + plugin = None + + def setUp(self): + self.plugin = MrBeamPluginDummy() + with open( + os.path.join(dirname(realpath(__file__)), "target_octoprint_config.json") + ) as json_file: + self.target_octoprint_config = yaml.safe_load(json_file) + with open( + os.path.join( + dirname(realpath(__file__)), "target_find_my_mr_beam_config.json" + ) + ) as json_file: + self.target_find_my_mr_beam_config = yaml.safe_load(json_file) + with open( + os.path.join(dirname(realpath(__file__)), "target_netconnectd_config.json") + ) as json_file: + self.target_netconnectd_config = yaml.safe_load(json_file) + with open( + os.path.join(dirname(realpath(__file__)), "target_mrbeam_config.json") + ) as json_file: + self.target_mrbeam_config = yaml.safe_load(json_file) + with open( + os.path.join(dirname(realpath(__file__)), "mock_config.json") + ) as json_file: + self.mock_config = yaml.safe_load(json_file) + + @patch.object( + UserNotificationSystem, + "show_notifications", + ) + @patch.object( + UserNotificationSystem, + "get_notification", + ) + def test_server_not_reachable(self, show_notifications_mock, get_notification_mock): + """ + Testcase to test what happens if the server is not reachable + + Args: + show_notifications_mock: mock of the notifications system show methode + get_notification_mock: mock of the notifications system get methode + + Returns: + None + """ + with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: + get_notification_mock.return_value = None + plugin = self.plugin + + with requests_mock.Mocker() as rm: + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/tags", + json={"test": "test"}, + status_code=404, + ) + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=vNone", + status_code=404, + ) + update_config = get_update_information(plugin) + assert update_config == { + "findmymrbeam": { + "displayName": "OctoPrint-FindMyMrBeam", + "displayVersion": "dummy", + "pip": "", + "repo": "", + "type": "github_commit", + "user": "", + }, + "mrbeam": { + "displayName": " MrBeam Plugin", + "displayVersion": "dummy", + "pip": "", + "repo": "", + "type": "github_commit", + "user": "", + }, + "netconnectd": { + "displayName": "OctoPrint-Netconnectd Plugin", + "displayVersion": "dummy", + "pip": "", + "repo": "", + "type": "github_commit", + "user": "", + }, + } + show_notifications_mock.assert_called_with( + notification_id="missing_updateinformation_info", replay=False + ) + show_notifications_mock.assert_called_once() + + @patch.object(DeviceInfo, "get_beamos_version") + def test_cloud_config_buster_online(self, device_info_mock): + """ + Testcase to test the buster config with the online available cloud config + + Args: + device_info_mock: mocks the device info to change the image date + + Returns: + None + """ + self.maxDiff = None + self.check_if_githubapi_rate_limit_exceeded() + self.maxDiff = None + beamos_date_buster = date(2021, 6, 11) + device_info_mock.return_value = "PROD", beamos_date_buster + plugin = self.plugin + with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: + # test for all tiers + for tier in SW_UPDATE_TIERS: + self.plugin._settings.set(tier) + update_config = get_update_information(plugin) + print("config {}".format(update_config)) + self.assertEquals( + update_config["octoprint"], + self.target_octoprint_config[_get_tier_by_id(tier)], + ) + self.validate_mrbeam_module_config( + update_config["mrbeam"], _get_tier_by_id(tier), beamos_date_buster + ) + self.validate_findmymrbeam_module_config( + update_config["findmymrbeam"], + _get_tier_by_id(tier), + beamos_date_buster, + ) + self.validate_netconnect_module_config( + update_config["netconnectd"], + _get_tier_by_id(tier), + beamos_date_buster, + ) + + @patch.object(DeviceInfo, "get_beamos_version") + def test_cloud_confg_legacy_online(self, device_info_mock): + """ + Testcase to test the leagcy image config with the online available cloud config + + Args: + device_info_mock: mocks the device info to change the image date + + Returns: + None + """ + self.check_if_githubapi_rate_limit_exceeded() + self.maxDiff = None + beamos_date_legacy = date(2018, 1, 12) + device_info_mock.return_value = "PROD", beamos_date_legacy + with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: + plugin = self.plugin + + # test for all tiers + for tier in SW_UPDATE_TIERS: + self.plugin._settings.set(tier) + update_config = get_update_information(plugin) + print("config {}".format(update_config)) + self.assertEquals( + update_config["octoprint"], + self.target_octoprint_config[_get_tier_by_id(tier)], + ) + self.validate_mrbeam_module_config( + update_config["mrbeam"], _get_tier_by_id(tier), beamos_date_legacy + ) + self.validate_findmymrbeam_module_config( + update_config["findmymrbeam"], + _get_tier_by_id(tier), + beamos_date_legacy, + ) + self.validate_netconnect_module_config( + update_config["netconnectd"], + _get_tier_by_id(tier), + beamos_date_legacy, + ) + + @patch.object(DeviceInfo, "get_beamos_version") + def test_cloud_confg_buster_mock(self, device_info_mock): + """ + tests the update info with a mocked server response + + Args: + device_info_mock: mocks the device info to change the image date + + Returns: + None + """ + beamos_date_buster = date(2021, 6, 11) + device_info_mock.return_value = "PROD", beamos_date_buster + with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: + with requests_mock.Mocker() as rm: + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/tags", + status_code=200, + json=[ + { + "name": "v0.0.2-mock", + } + ], + ) + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + status_code=200, + json={ + "content": base64.urlsafe_b64encode( + json.dumps(self.mock_config) + ) + }, + ) + plugin = self.plugin + + # test for all tiers + for tier in SW_UPDATE_TIERS: + self.plugin._settings.set(tier) + update_config = get_update_information(plugin) + self.maxDiff = None + self.assertEquals( + update_config["octoprint"], + self.target_octoprint_config[_get_tier_by_id(tier)], + ) + self.validate_mrbeam_module_config( + update_config["mrbeam"], + _get_tier_by_id(tier), + beamos_date_buster, + ) + self.validate_findmymrbeam_module_config( + update_config["findmymrbeam"], + _get_tier_by_id(tier), + beamos_date_buster, + ) + self.validate_netconnect_module_config( + update_config["netconnectd"], + _get_tier_by_id(tier), + beamos_date_buster, + ) + mock_file.assert_called_with( + TMP_BASE_FOLDER_PATH + SW_UPDATE_INFO_FILE_NAME, "w" + ) + + @patch.object(DeviceInfo, "get_beamos_version") + def test_cloud_confg_legacy_mock(self, device_info_mock): + """ + tests the updateinfo hook for the legacy image + + Args: + device_info_mock: mocks the device info to change the image date + + Returns: + None + """ + beamos_date_legacy = date(2018, 1, 12) + device_info_mock.return_value = "PROD", beamos_date_legacy + with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: + with requests_mock.Mocker() as rm: + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/tags", + status_code=200, + json=[ + { + "name": "v0.0.2-mock", + } + ], + ) + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + status_code=200, + json={ + "content": base64.urlsafe_b64encode( + json.dumps(self.mock_config) + ) + }, + ) + plugin = self.plugin + + # test for all tiers + for tier in SW_UPDATE_TIERS: + self.plugin._settings.set(tier) + update_config = get_update_information(plugin) + + print("config {}".format(update_config)) + self.assertEquals( + update_config["octoprint"], + self.target_octoprint_config[_get_tier_by_id(tier)], + ) + self.validate_mrbeam_module_config( + update_config["mrbeam"], + _get_tier_by_id(tier), + beamos_date_legacy, + ) + self.validate_findmymrbeam_module_config( + update_config["findmymrbeam"], + _get_tier_by_id(tier), + beamos_date_legacy, + ) + self.validate_netconnect_module_config( + update_config["netconnectd"], + _get_tier_by_id(tier), + beamos_date_legacy, + ) + mock_file.assert_called_with( + TMP_BASE_FOLDER_PATH + SW_UPDATE_INFO_FILE_NAME, "w" + ) + + @patch.object( + UserNotificationSystem, + "show_notifications", + ) + @patch.object( + UserNotificationSystem, + "get_notification", + ) + def test_cloud_confg_fileerror( + self, + user_notification_system_show_mock, + user_notification_system_get_mock, + ): + """ + Tests the update information hook with a fileerror + + Args: + user_notification_system_show_mock: mock of the notification system show methode + user_notification_system_get_mock: mock of the notification system get methode + + Returns: + None + """ + user_notification_system_get_mock.return_value = None + with requests_mock.Mocker() as rm: + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/tags", + status_code=200, + json=[ + { + "name": "v0.0.2-mock", + } + ], + ) + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + status_code=200, + json={ + "content": base64.urlsafe_b64encode(json.dumps(self.mock_config)) + }, + ) + plugin = self.plugin + + update_config = get_update_information(plugin) + + self.assertIsNone(update_config) + user_notification_system_show_mock.assert_called_with( + notification_id="write_error_update_info_file_err", replay=False + ) + user_notification_system_show_mock.assert_called_once() + + def validate_mrbeam_module_config(self, update_config, tier, beamos_date): + """ + validates the config of the mrbeam software module + + Args: + update_config: update config + tier: software tier + beamos_date: date of the beamos image + + Returns: + None + """ + self.validate_module_config( + update_config, tier, self.target_mrbeam_config, beamos_date + ) + + def validate_findmymrbeam_module_config(self, update_config, tier, beamos_date): + """ + validates the config of a the findmymrbeam software module + + Args: + update_config: update config + tier: software tier + beamos_date: date of the beamos image + + Returns: + None + """ + self.validate_module_config( + update_config, tier, self.target_find_my_mr_beam_config, beamos_date + ) + + def validate_netconnect_module_config(self, update_config, tier, beamos_date): + """ + validates the config of a the netconnectd software module + + Args: + update_config: update config + tier: software tier + beamos_date: date of the beamos image + + Returns: + None + """ + self.validate_module_config( + update_config, tier, self.target_netconnectd_config, beamos_date + ) + + def _set_beamos_config(self, config, beamos_date=None): + """ + generates the updateinformation for a given beamos image date + + Args: + config: update config + beamos_date: beamos image date + + Returns: + updateinformation for the given beamos image date + """ + if "beamos_date" in config: + for date, beamos_config in config["beamos_date"].items(): + if beamos_date >= datetime.strptime(date, "%Y-%m-%d").date(): + config = dict_merge(config, beamos_config) + config.pop("beamos_date") + return config + + def _set_tier_config(self, config, tier): + """ + generates the updateinformation for a given software tier + + Args: + config: update config + tier: software tier to use + + Returns: + updateinformation for the given tier + """ + if "tiers" in config: + config = dict_merge(config, config["tiers"][tier]) + config.pop("tiers") + return config + + def validate_module_config( + self, update_config, tier, target_module_config, beamos_date + ): + """ + validates the updateinfromation fot the given software module + + Args: + update_config: update config + tier: software tier + target_module_config: software module to validate + beamos_date: beamos image date + + Returns: + None + """ + copy_target_config = deepcopy(target_module_config) + self._set_beamos_config(copy_target_config, beamos_date) + if "dependencies" in copy_target_config: + for dependencie_name, dependencie_config in copy_target_config[ + "dependencies" + ].items(): + dependencie_config = self._set_beamos_config( + dependencie_config, beamos_date + ) + dependencie_config = self._set_tier_config(dependencie_config, tier) + copy_target_config["dependencies"][ + dependencie_name + ] = dependencie_config + + copy_target_config = self._set_tier_config(copy_target_config, tier) + + self.assertEquals(update_config, copy_target_config) + + def check_if_githubapi_rate_limit_exceeded(self): + """ + checks if the githubapi rate limit is exeeded + Returns: + None + """ + r = requests.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json" + ) + # check if rate limit exceeded + r.raise_for_status() diff --git a/tests/softwareupdate/test_dependencies.py b/tests/softwareupdate/test_dependencies.py new file mode 100644 index 000000000..a696fe02d --- /dev/null +++ b/tests/softwareupdate/test_dependencies.py @@ -0,0 +1,16 @@ +import os +import re +import unittest + + +class TestUpdateScript(unittest.TestCase): + def test_dependencies_file(self): + dependencies_path = os.path.join( + os.path.dirname(os.path.abspath(__file__)), + "../../octoprint_mrbeam/dependencies.txt", + ) + dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)==((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)" + with open(dependencies_path, "r") as f: + lines = f.readlines() + for line in lines: + self.assertRegexpMatches(line, dependencies_pattern) diff --git a/tests/util/__init__.py b/tests/util/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/util/test_string_util.py b/tests/util/test_string_util.py new file mode 100644 index 000000000..e0ce781a2 --- /dev/null +++ b/tests/util/test_string_util.py @@ -0,0 +1,44 @@ +from unittest import TestCase + +from octoprint_mrbeamdoc.enum.mrbeam_doctype import MrBeamDocType + +from octoprint_mrbeam.util import string_util + + +class TestStringUtils(TestCase): + def test_extra_space_at_the_end__then_removed(self): + self.assertEquals(string_util.separate_camelcase_words('Test '), 'Test') + + def test_extra_space_at_the_beginning__then_removed(self): + self.assertEquals(string_util.separate_camelcase_words(' Test'), 'Test') + + def test_extra_space_at_the_middle__then_removed(self): + self.assertEquals(string_util.separate_camelcase_words('Test Test Test'), 'Test Test Test') + + def test_no_camelcase__then_only_removed_extra_space(self): + self.assertEquals(string_util.separate_camelcase_words('Test Test Test', separator=','), 'Test Test Test') + + def test_camelcase_and_extra_space__then_separate_and_removed_extra_space(self): + self.assertEquals(string_util.separate_camelcase_words('Test TestTest', separator=','), 'Test Test,Test') + + def test_uppercase_word__then_first_char_separated_and_next_chars_in_groups_of_2(self): + self.assertEquals(string_util.separate_camelcase_words('TESTTEST', separator=','), 'T,ES,TT,ES,T') + + def test_lowercase_word__then_unchanged(self): + self.assertEquals(string_util.separate_camelcase_words('testtest', separator=','), 'testtest') + + def test_separation_of_2_words(self): + self.assertEquals(string_util.separate_camelcase_words('TestTest'), 'Test Test') + + def test_separation_of_3_words(self): + self.assertEquals(string_util.separate_camelcase_words('TestTestTest'), 'Test Test Test') + + def test_custom_separator(self): + self.assertEquals(string_util.separate_camelcase_words('AtestBtestCtest', separator=','), 'Atest,Btest,Ctest') + + def test_separate_mrbeamdoc_type_usermanual_right_format_for_translation(self): + self.assertEquals(string_util.separate_camelcase_words(MrBeamDocType.USER_MANUAL.value), 'User Manual') + + def test_separate_mrbeamdoc_type_quickstart_right_format_for_translation(self): + self.assertEquals(string_util.separate_camelcase_words(MrBeamDocType.QUICKSTART_GUIDE.value), + 'Quickstart Guide') diff --git a/versioneer.py b/versioneer.py new file mode 100644 index 000000000..64fea1c89 --- /dev/null +++ b/versioneer.py @@ -0,0 +1,1822 @@ + +# Version: 0.18 + +"""The Versioneer - like a rocketeer, but for versions. + +The Versioneer +============== + +* like a rocketeer, but for versions! +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy +* [![Latest Version] +(https://pypip.in/version/versioneer/badge.svg?style=flat) +](https://pypi.python.org/pypi/versioneer/) +* [![Build Status] +(https://travis-ci.org/warner/python-versioneer.png?branch=master) +](https://travis-ci.org/warner/python-versioneer) + +This is a tool for managing a recorded version number in distutils-based +python projects. The goal is to remove the tedious and error-prone "update +the embedded version string" step from your release process. Making a new +release should be as easy as recording a new tag in your version-control +system, and maybe making new tarballs. + + +## Quick Install + +* `pip install versioneer` to somewhere to your $PATH +* add a `[versioneer]` section to your setup.cfg (see below) +* run `versioneer install` in your source tree, commit the results + +## Version Identifiers + +Source trees come from a variety of places: + +* a version-control system checkout (mostly used by developers) +* a nightly tarball, produced by build automation +* a snapshot tarball, produced by a web-based VCS browser, like github's + "tarball from tag" feature +* a release tarball, produced by "setup.py sdist", distributed through PyPI + +Within each source tree, the version identifier (either a string or a number, +this tool is format-agnostic) can come from a variety of places: + +* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows + about recent "tags" and an absolute revision-id +* the name of the directory into which the tarball was unpacked +* an expanded VCS keyword ($Id$, etc) +* a `_version.py` created by some earlier build step + +For released software, the version identifier is closely related to a VCS +tag. Some projects use tag names that include more than just the version +string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool +needs to strip the tag prefix to extract the version identifier. For +unreleased software (between tags), the version identifier should provide +enough information to help developers recreate the same tree, while also +giving them an idea of roughly how old the tree is (after version 1.2, before +version 1.3). Many VCS systems can report a description that captures this, +for example `git describe --tags --dirty --always` reports things like +"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the +0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has +uncommitted changes. + +The version identifier is used for multiple purposes: + +* to allow the module to self-identify its version: `myproject.__version__` +* to choose a name and prefix for a 'setup.py sdist' tarball + +## Theory of Operation + +Versioneer works by adding a special `_version.py` file into your source +tree, where your `__init__.py` can import it. This `_version.py` knows how to +dynamically ask the VCS tool for version information at import time. + +`_version.py` also contains `$Revision$` markers, and the installation +process marks `_version.py` to have this marker rewritten with a tag name +during the `git archive` command. As a result, generated tarballs will +contain enough information to get the proper version. + +To allow `setup.py` to compute a version too, a `versioneer.py` is added to +the top level of your source tree, next to `setup.py` and the `setup.cfg` +that configures it. This overrides several distutils/setuptools commands to +compute the version when invoked, and changes `setup.py build` and `setup.py +sdist` to replace `_version.py` with a small static file that contains just +the generated version data. + +## Installation + +See [INSTALL.md](./INSTALL.md) for detailed installation instructions. + +## Version-String Flavors + +Code which uses Versioneer can learn about its version string at runtime by +importing `_version` from your main `__init__.py` file and running the +`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can +import the top-level `versioneer.py` and run `get_versions()`. + +Both functions return a dictionary with different flavors of version +information: + +* `['version']`: A condensed version string, rendered using the selected + style. This is the most commonly used value for the project's version + string. The default "pep440" style yields strings like `0.11`, + `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section + below for alternative styles. + +* `['full-revisionid']`: detailed revision identifier. For Git, this is the + full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". + +* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the + commit date in ISO 8601 format. This will be None if the date is not + available. + +* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that + this is only accurate if run in a VCS checkout, otherwise it is likely to + be False or None + +* `['error']`: if the version string could not be computed, this will be set + to a string describing the problem, otherwise it will be None. It may be + useful to throw an exception in setup.py if this is set, to avoid e.g. + creating tarballs with a version string of "unknown". + +Some variants are more useful than others. Including `full-revisionid` in a +bug report should allow developers to reconstruct the exact code being tested +(or indicate the presence of local changes that should be shared with the +developers). `version` is suitable for display in an "about" box or a CLI +`--version` output: it can be easily compared against release notes and lists +of bugs fixed in various releases. + +The installer adds the following text to your `__init__.py` to place a basic +version in `YOURPROJECT.__version__`: + + from ._version import get_versions + __version__ = get_versions()['version'] + del get_versions + +## Styles + +The setup.cfg `style=` configuration controls how the VCS information is +rendered into a version string. + +The default style, "pep440", produces a PEP440-compliant string, equal to the +un-prefixed tag name for actual releases, and containing an additional "local +version" section with more detail for in-between builds. For Git, this is +TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags +--dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the +tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and +that this commit is two revisions ("+2") beyond the "0.11" tag. For released +software (exactly equal to a known tag), the identifier will only contain the +stripped tag, e.g. "0.11". + +Other styles are available. See [details.md](details.md) in the Versioneer +source tree for descriptions. + +## Debugging + +Versioneer tries to avoid fatal errors: if something goes wrong, it will tend +to return a version of "0+unknown". To investigate the problem, run `setup.py +version`, which will run the version-lookup code in a verbose mode, and will +display the full contents of `get_versions()` (including the `error` string, +which may help identify what went wrong). + +## Known Limitations + +Some situations are known to cause problems for Versioneer. This details the +most significant ones. More can be found on Github +[issues page](https://github.com/warner/python-versioneer/issues). + +### Subprojects + +Versioneer has limited support for source trees in which `setup.py` is not in +the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are +two common reasons why `setup.py` might not be in the root: + +* Source trees which contain multiple subprojects, such as + [Buildbot](https://github.com/buildbot/buildbot), which contains both + "master" and "slave" subprojects, each with their own `setup.py`, + `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI + distributions (and upload multiple independently-installable tarballs). +* Source trees whose main purpose is to contain a C library, but which also + provide bindings to Python (and perhaps other langauges) in subdirectories. + +Versioneer will look for `.git` in parent directories, and most operations +should get the right version string. However `pip` and `setuptools` have bugs +and implementation details which frequently cause `pip install .` from a +subproject directory to fail to find a correct version string (so it usually +defaults to `0+unknown`). + +`pip install --editable .` should work correctly. `setup.py install` might +work too. + +Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in +some later version. + +[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking +this issue. The discussion in +[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the +issue from the Versioneer side in more detail. +[pip PR#3176](https://github.com/pypa/pip/pull/3176) and +[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve +pip to let Versioneer work correctly. + +Versioneer-0.16 and earlier only looked for a `.git` directory next to the +`setup.cfg`, so subprojects were completely unsupported with those releases. + +### Editable installs with setuptools <= 18.5 + +`setup.py develop` and `pip install --editable .` allow you to install a +project into a virtualenv once, then continue editing the source code (and +test) without re-installing after every change. + +"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a +convenient way to specify executable scripts that should be installed along +with the python package. + +These both work as expected when using modern setuptools. When using +setuptools-18.5 or earlier, however, certain operations will cause +`pkg_resources.DistributionNotFound` errors when running the entrypoint +script, which must be resolved by re-installing the package. This happens +when the install happens with one version, then the egg_info data is +regenerated while a different version is checked out. Many setup.py commands +cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into +a different virtualenv), so this can be surprising. + +[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes +this one, but upgrading to a newer version of setuptools should probably +resolve it. + +### Unicode version strings + +While Versioneer works (and is continually tested) with both Python 2 and +Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. +Newer releases probably generate unicode version strings on py2. It's not +clear that this is wrong, but it may be surprising for applications when then +write these strings to a network connection or include them in bytes-oriented +APIs like cryptographic checksums. + +[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates +this question. + + +## Updating Versioneer + +To upgrade your project to a new release of Versioneer, do the following: + +* install the new Versioneer (`pip install -U versioneer` or equivalent) +* edit `setup.cfg`, if necessary, to include any new configuration settings + indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. +* re-run `versioneer install` in your source tree, to replace + `SRC/_version.py` +* commit any changed files + +## Future Directions + +This tool is designed to make it easily extended to other version-control +systems: all VCS-specific components are in separate directories like +src/git/ . The top-level `versioneer.py` script is assembled from these +components by running make-versioneer.py . In the future, make-versioneer.py +will take a VCS name as an argument, and will construct a version of +`versioneer.py` that is specific to the given VCS. It might also take the +configuration arguments that are currently provided manually during +installation by editing setup.py . Alternatively, it might go the other +direction and include code from all supported VCS systems, reducing the +number of intermediate scripts. + + +## License + +To make Versioneer easier to embed, all its code is dedicated to the public +domain. The `_version.py` that it creates is also in the public domain. +Specifically, both are released under the Creative Commons "Public Domain +Dedication" license (CC0-1.0), as described in +https://creativecommons.org/publicdomain/zero/1.0/ . + +""" + +from __future__ import print_function +try: + import configparser +except ImportError: + import ConfigParser as configparser +import errno +import json +import os +import re +import subprocess +import sys + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_root(): + """Get the project root directory. + + We require that all commands are run from the project root, i.e. the + directory that contains setup.py, setup.cfg, and versioneer.py . + """ + root = os.path.realpath(os.path.abspath(os.getcwd())) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + # allow 'python path/to/setup.py COMMAND' + root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + err = ("Versioneer was unable to run the project root directory. " + "Versioneer requires setup.py to be executed from " + "its immediate directory (like 'python setup.py COMMAND'), " + "or in a way that lets it use sys.argv[0] to find the root " + "(like 'python path/to/setup.py COMMAND').") + raise VersioneerBadRootError(err) + try: + # Certain runtime workflows (setup.py install/develop in a setuptools + # tree) execute all dependencies in a single python process, so + # "versioneer" may be imported multiple times, and python's shared + # module-import table will cache the first one. So we can't use + # os.path.dirname(__file__), as that will find whichever + # versioneer.py was first imported, even in later projects. + me = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(me)[0]) + vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) + if me_dir != vsr_dir: + print("Warning: build in %s is using versioneer.py from %s" + % (os.path.dirname(me), versioneer_py)) + except NameError: + pass + return root + + +def get_config_from_root(root): + """Read the project setup.cfg file to determine Versioneer config.""" + # This might raise EnvironmentError (if setup.cfg is missing), or + # configparser.NoSectionError (if it lacks a [versioneer] section), or + # configparser.NoOptionError (if it lacks "VCS="). See the docstring at + # the top of versioneer.py for instructions on writing your setup.cfg . + setup_cfg = os.path.join(root, "setup.cfg") + parser = configparser.SafeConfigParser() + with open(setup_cfg, "r") as f: + parser.readfp(f) + VCS = parser.get("versioneer", "VCS") # mandatory + + def get(parser, name): + if parser.has_option("versioneer", name): + return parser.get("versioneer", name) + return None + cfg = VersioneerConfig() + cfg.VCS = VCS + cfg.style = get(parser, "style") or "" + cfg.versionfile_source = get(parser, "versionfile_source") + cfg.versionfile_build = get(parser, "versionfile_build") + cfg.tag_prefix = get(parser, "tag_prefix") + if cfg.tag_prefix in ("''", '""'): + cfg.tag_prefix = "" + cfg.parentdir_prefix = get(parser, "parentdir_prefix") + cfg.verbose = get(parser, "verbose") + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +# these dictionaries contain VCS-specific tools +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +LONG_VERSION_PY['git'] = ''' +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" + git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "%(STYLE)s" + cfg.tag_prefix = "%(TAG_PREFIX)s" + cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" + cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %%s" %% dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %%s" %% (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% dispcmd) + print("stdout was %%s" %% stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %%s but none started with prefix %%s" %% + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %%d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%%s', no digits" %% ",".join(refs - tags)) + if verbose: + print("likely tags: %%s" %% ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %%s not under git control" %% root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%%s*" %% tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%%s'" + %% describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%%s' doesn't start with prefix '%%s'" + print(fmt %% (full_tag, tag_prefix)) + pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" + %% (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%%d" %% pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%%d" %% pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%%s'" %% style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} +''' + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def do_vcs_install(manifest_in, versionfile_source, ipy): + """Git-specific installation logic for Versioneer. + + For Git, this means creating/changing .gitattributes to mark _version.py + for export-subst keyword substitution. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + files = [manifest_in, versionfile_source] + if ipy: + files.append(ipy) + try: + me = __file__ + if me.endswith(".pyc") or me.endswith(".pyo"): + me = os.path.splitext(me)[0] + ".py" + versioneer_file = os.path.relpath(me) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + files.append(".gitattributes") + run_command(GITS, ["add", "--"] + files) + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.18) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +import json + +version_json = ''' +%s +''' # END VERSION_JSON + + +def get_versions(): + return json.loads(version_json) +""" + + +def versions_from_file(filename): + """Try to determine the version from _version.py if present.""" + try: + with open(filename) as f: + contents = f.read() + except EnvironmentError: + raise NotThisMethod("unable to read _version.py") + mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + raise NotThisMethod("no version_json in _version.py") + return json.loads(mo.group(1)) + + +def write_to_version_file(filename, versions): + """Write the given version number to the given _version.py file.""" + os.unlink(filename) + contents = json.dumps(versions, sort_keys=True, + indent=1, separators=(",", ": ")) + with open(filename, "w") as f: + f.write(SHORT_VERSION_PY % contents) + + print("set %s to '%s'" % (filename, versions["version"])) + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +class VersioneerBadRootError(Exception): + """The project root directory is unknown or missing key files.""" + + +def get_versions(verbose=False): + """Get the project version from whatever source is available. + + Returns dict with two keys: 'version' and 'full'. + """ + if "versioneer" in sys.modules: + # see the discussion in cmdclass.py:get_cmdclass() + del sys.modules["versioneer"] + + root = get_root() + cfg = get_config_from_root(root) + + assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" + handlers = HANDLERS.get(cfg.VCS) + assert handlers, "unrecognized VCS '%s'" % cfg.VCS + verbose = verbose or cfg.verbose + assert cfg.versionfile_source is not None, \ + "please set versioneer.versionfile_source" + assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" + + versionfile_abs = os.path.join(root, cfg.versionfile_source) + + # extract version from first of: _version.py, VCS command (e.g. 'git + # describe'), parentdir. This is meant to work for developers using a + # source checkout, for users of a tarball created by 'setup.py sdist', + # and for users of a tarball/zipball created by 'git archive' or github's + # download-from-tag feature or the equivalent in other VCSes. + + get_keywords_f = handlers.get("get_keywords") + from_keywords_f = handlers.get("keywords") + if get_keywords_f and from_keywords_f: + try: + keywords = get_keywords_f(versionfile_abs) + ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) + if verbose: + print("got version from expanded keyword %s" % ver) + return ver + except NotThisMethod: + pass + + try: + ver = versions_from_file(versionfile_abs) + if verbose: + print("got version from file %s %s" % (versionfile_abs, ver)) + return ver + except NotThisMethod: + pass + + from_vcs_f = handlers.get("pieces_from_vcs") + if from_vcs_f: + try: + pieces = from_vcs_f(cfg.tag_prefix, root, verbose) + ver = render(pieces, cfg.style) + if verbose: + print("got version from VCS %s" % ver) + return ver + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + if verbose: + print("got version from parentdir %s" % ver) + return ver + except NotThisMethod: + pass + + if verbose: + print("unable to compute version") + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, "error": "unable to compute version", + "date": None} + + +def get_version(): + """Get the short version string for this project.""" + return get_versions()["version"] + + +def get_cmdclass(): + """Get the custom setuptools/distutils subclasses used by Versioneer.""" + if "versioneer" in sys.modules: + del sys.modules["versioneer"] + # this fixes the "python setup.py develop" case (also 'install' and + # 'easy_install .'), in which subdependencies of the main project are + # built (using setup.py bdist_egg) in the same python process. Assume + # a main project A and a dependency B, which use different versions + # of Versioneer. A's setup.py imports A's Versioneer, leaving it in + # sys.modules by the time B's setup.py is executed, causing B to run + # with the wrong versioneer. Setuptools wraps the sub-dep builds in a + # sandbox that restores sys.modules to it's pre-build state, so the + # parent is protected against the child's "import versioneer". By + # removing ourselves from sys.modules here, before the child build + # happens, we protect the child from the parent's versioneer too. + # Also see https://github.com/warner/python-versioneer/issues/52 + + cmds = {} + + # we add "version" to both distutils and setuptools + from distutils.core import Command + + class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + vers = get_versions(verbose=True) + print("Version: %s" % vers["version"]) + print(" full-revisionid: %s" % vers.get("full-revisionid")) + print(" dirty: %s" % vers.get("dirty")) + print(" date: %s" % vers.get("date")) + if vers["error"]: + print(" error: %s" % vers["error"]) + cmds["version"] = cmd_version + + # we override "build_py" in both distutils and setuptools + # + # most invocation pathways end up running build_py: + # distutils/build -> build_py + # distutils/install -> distutils/build ->.. + # setuptools/bdist_wheel -> distutils/install ->.. + # setuptools/bdist_egg -> distutils/install_lib -> build_py + # setuptools/install -> bdist_egg ->.. + # setuptools/develop -> ? + # pip install: + # copies source tree to a tempdir before running egg_info/etc + # if .git isn't copied too, 'git describe' will fail + # then does setup.py bdist_wheel, or sometimes setup.py install + # setup.py egg_info -> ? + + # we override different "build_py" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.build_py import build_py as _build_py + else: + from distutils.command.build_py import build_py as _build_py + + class cmd_build_py(_build_py): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + _build_py.run(self) + # now locate _version.py in the new build/ directory and replace + # it with an updated value + if cfg.versionfile_build: + target_versionfile = os.path.join(self.build_lib, + cfg.versionfile_build) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + cmds["build_py"] = cmd_build_py + + if "cx_Freeze" in sys.modules: # cx_freeze enabled? + from cx_Freeze.dist import build_exe as _build_exe + # nczeczulin reports that py2exe won't like the pep440-style string + # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. + # setup(console=[{ + # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION + # "product_version": versioneer.get_version(), + # ... + + class cmd_build_exe(_build_exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _build_exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["build_exe"] = cmd_build_exe + del cmds["build_py"] + + if 'py2exe' in sys.modules: # py2exe enabled? + try: + from py2exe.distutils_buildexe import py2exe as _py2exe # py3 + except ImportError: + from py2exe.build_exe import py2exe as _py2exe # py2 + + class cmd_py2exe(_py2exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _py2exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["py2exe"] = cmd_py2exe + + # we override different "sdist" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.sdist import sdist as _sdist + else: + from distutils.command.sdist import sdist as _sdist + + class cmd_sdist(_sdist): + def run(self): + versions = get_versions() + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old + # version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + root = get_root() + cfg = get_config_from_root(root) + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory + # (remembering that it may be a hardlink) and replace it with an + # updated value + target_versionfile = os.path.join(base_dir, cfg.versionfile_source) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, + self._versioneer_generated_versions) + cmds["sdist"] = cmd_sdist + + return cmds + + +CONFIG_ERROR = """ +setup.cfg is missing the necessary Versioneer configuration. You need +a section like: + + [versioneer] + VCS = git + style = pep440 + versionfile_source = src/myproject/_version.py + versionfile_build = myproject/_version.py + tag_prefix = + parentdir_prefix = myproject- + +You will also need to edit your setup.py to use the results: + + import versioneer + setup(version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), ...) + +Please read the docstring in ./versioneer.py for configuration instructions, +edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. +""" + +SAMPLE_CONFIG = """ +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[versioneer] +#VCS = git +#style = pep440 +#versionfile_source = +#versionfile_build = +#tag_prefix = +#parentdir_prefix = + +""" + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + + +def do_setup(): + """Main VCS-independent setup function for installing Versioneer.""" + root = get_root() + try: + cfg = get_config_from_root(root) + except (EnvironmentError, configparser.NoSectionError, + configparser.NoOptionError) as e: + if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + print("Adding sample versioneer config to setup.cfg", + file=sys.stderr) + with open(os.path.join(root, "setup.cfg"), "a") as f: + f.write(SAMPLE_CONFIG) + print(CONFIG_ERROR, file=sys.stderr) + return 1 + + print(" creating %s" % cfg.versionfile_source) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + + ipy = os.path.join(os.path.dirname(cfg.versionfile_source), + "__init__.py") + if os.path.exists(ipy): + try: + with open(ipy, "r") as f: + old = f.read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + with open(ipy, "a") as f: + f.write(INIT_PY_SNIPPET) + else: + print(" %s unmodified" % ipy) + else: + print(" %s doesn't exist, ok" % ipy) + ipy = None + + # Make sure both the top-level "versioneer.py" and versionfile_source + # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so + # they'll be copied into source distributions. Pip won't be able to + # install the package without this. + manifest_in = os.path.join(root, "MANIFEST.in") + simple_includes = set() + try: + with open(manifest_in, "r") as f: + for line in f: + if line.startswith("include "): + for include in line.split()[1:]: + simple_includes.add(include) + except EnvironmentError: + pass + # That doesn't cover everything MANIFEST.in can do + # (http://docs.python.org/2/distutils/sourcedist.html#commands), so + # it might give some false negatives. Appending redundant 'include' + # lines is safe, though. + if "versioneer.py" not in simple_includes: + print(" appending 'versioneer.py' to MANIFEST.in") + with open(manifest_in, "a") as f: + f.write("include versioneer.py\n") + else: + print(" 'versioneer.py' already in MANIFEST.in") + if cfg.versionfile_source not in simple_includes: + print(" appending versionfile_source ('%s') to MANIFEST.in" % + cfg.versionfile_source) + with open(manifest_in, "a") as f: + f.write("include %s\n" % cfg.versionfile_source) + else: + print(" versionfile_source already in MANIFEST.in") + + # Make VCS-specific changes. For git, this means creating/changing + # .gitattributes to mark _version.py for export-subst keyword + # substitution. + do_vcs_install(manifest_in, cfg.versionfile_source, ipy) + return 0 + + +def scan_setup_py(): + """Validate the contents of setup.py against Versioneer's expectations.""" + found = set() + setters = False + errors = 0 + with open("setup.py", "r") as f: + for line in f.readlines(): + if "import versioneer" in line: + found.add("import") + if "versioneer.get_cmdclass()" in line: + found.add("cmdclass") + if "versioneer.get_version()" in line: + found.add("get_version") + if "versioneer.VCS" in line: + setters = True + if "versioneer.versionfile_source" in line: + setters = True + if len(found) != 3: + print("") + print("Your setup.py appears to be missing some important items") + print("(but I might be wrong). Please make sure it has something") + print("roughly like the following:") + print("") + print(" import versioneer") + print(" setup( version=versioneer.get_version(),") + print(" cmdclass=versioneer.get_cmdclass(), ...)") + print("") + errors += 1 + if setters: + print("You should remove lines like 'versioneer.VCS = ' and") + print("'versioneer.versionfile_source = ' . This configuration") + print("now lives in setup.cfg, and should be removed from setup.py") + print("") + errors += 1 + return errors + + +if __name__ == "__main__": + cmd = sys.argv[1] + if cmd == "setup": + errors = do_setup() + errors += scan_setup_py() + if errors: + sys.exit(1) From 976c8dc8abd499573367f755dc76de23deb22165 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Thu, 31 Mar 2022 11:44:34 +0200 Subject: [PATCH 03/15] SW-1182 remove repo and user form dependency archive format (#1451) * Remove repo and user form dependency archive format * change regex of dependencies versions to match PEP-440 --- octoprint_mrbeam/scripts/update_script.py | 4 +--- tests/softwareupdate/test_dependencies.py | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/octoprint_mrbeam/scripts/update_script.py b/octoprint_mrbeam/scripts/update_script.py index e03410fcf..883c80e4e 100644 --- a/octoprint_mrbeam/scripts/update_script.py +++ b/octoprint_mrbeam/scripts/update_script.py @@ -118,7 +118,7 @@ def get_dependencies(path): list of dependencie dict [{"name", "version"}] """ dependencies_path = os.path.join(path, "dependencies.txt") - dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)(.=)+((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)" + dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)(.=)+(([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?)" """ Example: input: iobeam==0.7.15 @@ -277,8 +277,6 @@ def build_queue(update_info, dependencies, plugin_archive): ) if dependency_config.get("pip"): archive = dependency_config["pip"].format( - repo=dependency_config["repo"], - user=dependency_config["user"], target_version="v{version}".format(version=dependency["version"]), ) else: diff --git a/tests/softwareupdate/test_dependencies.py b/tests/softwareupdate/test_dependencies.py index a696fe02d..f51ee4ff8 100644 --- a/tests/softwareupdate/test_dependencies.py +++ b/tests/softwareupdate/test_dependencies.py @@ -9,7 +9,7 @@ def test_dependencies_file(self): os.path.dirname(os.path.abspath(__file__)), "../../octoprint_mrbeam/dependencies.txt", ) - dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)==((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)" + dependencies_pattern = r"([a-z]+(?:[_-][a-z]+)*)==(([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$)" # $ ad the end needed so we see if there is a leftover at the end with open(dependencies_path, "r") as f: lines = f.readlines() for line in lines: From 341ae095b01de86eadfa7e68facdcacc1d22e9b6 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Tue, 5 Apr 2022 11:58:33 +0200 Subject: [PATCH 04/15] SW-1146 Beta Release (#1454) Fixed: - Frontend Analytics were not sent to the backend if Analytics is enabled. - The Version of Octoprint was not added to Analytics if Analytics is enabled. - Other minor bug fixes and improvements. --- octoprint_mrbeam/__init__.py | 2 +- octoprint_mrbeam/__version.py | 2 +- octoprint_mrbeam/analytics/timer_handler.py | 46 ++++---- octoprint_mrbeam/iobeam/iobeam_handler.py | 1 + octoprint_mrbeam/iobeam/laserhead_handler.py | 104 +++++++++++++++++- .../iobeam/temperature_manager.py | 38 ++++--- octoprint_mrbeam/printing/profiles/default.py | 2 +- .../profiles/laserhead/laserhead_id_0.yaml | 1 + .../profiles/laserhead/laserhead_id_1.yaml | 1 + .../img/MrBeam_Sicherheitshinweise_DE.png | Bin 11203 -> 45669 bytes octoprint_mrbeam/static/js/analytics.js | 2 +- .../templates/homing_overlay.jinja2 | 2 +- .../translations/de/LC_MESSAGES/messages.mo | Bin 126788 -> 126811 bytes .../translations/de/LC_MESSAGES/messages.po | 81 +++++++------- setup.py | 1 + translations/messages.pot | 76 ++++++------- 16 files changed, 241 insertions(+), 118 deletions(-) create mode 100644 octoprint_mrbeam/profiles/laserhead/laserhead_id_0.yaml create mode 100644 octoprint_mrbeam/profiles/laserhead/laserhead_id_1.yaml diff --git a/octoprint_mrbeam/__init__.py b/octoprint_mrbeam/__init__.py index bfd1c1562..4d2aa7a41 100644 --- a/octoprint_mrbeam/__init__.py +++ b/octoprint_mrbeam/__init__.py @@ -243,10 +243,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) diff --git a/octoprint_mrbeam/__version.py b/octoprint_mrbeam/__version.py index b2385cb40..828b5be06 100644 --- a/octoprint_mrbeam/__version.py +++ b/octoprint_mrbeam/__version.py @@ -1 +1 @@ -__version__ = "0.10.3" +__version__ = "0.10.4-beta" diff --git a/octoprint_mrbeam/analytics/timer_handler.py b/octoprint_mrbeam/analytics/timer_handler.py index 95f29d586..7b3e6f959 100644 --- a/octoprint_mrbeam/analytics/timer_handler.py +++ b/octoprint_mrbeam/analytics/timer_handler.py @@ -1,4 +1,5 @@ # coding=utf-8 +import re import netifaces import requests @@ -215,7 +216,7 @@ def _software_versions(self): it made sens when we did a filesystem checksum calculation... _software_versions_and_checksums() """ sw_versions = self._get_software_versions() - self._logger.debug("_software_versions: %s", sw_versions) + self._logger.debug("Software Version info: \n{}".format(sw_versions)) self._plugin.analytics_handler.add_software_versions(sw_versions) def _software_versions_and_checksums(self): @@ -279,31 +280,38 @@ def _software_versions_and_checksums(self): def _get_software_versions(self): result = dict() - configured_checks = None + software_info = None + try: - pluginInfo = self._plugin._plugin_manager.get_plugin_info("softwareupdate") - if pluginInfo is not None: - impl = pluginInfo.implementation - configured_checks = impl._configured_checks - else: - self._logger.error( - "_get_software_versions() Can't get pluginInfo.implementation" - ) + plugin_info = self._plugin._plugin_manager.get_plugin_info("softwareupdate") + impl = plugin_info.implementation + # using the method get_current_versions() is OK as it is threadsafe + software_info, _, _ = impl.get_current_versions() + self._logger.debug("Software_info: \n {}".format(software_info)) except Exception as e: self._logger.exception( - "Exception while reading configured_checks from softwareupdate plugin. " + "Exception while reading software_info from softwareupdate plugin. Error:{} ".format(e) ) + return result - if configured_checks is None: + if isinstance(software_info, dict) is False: self._logger.warn( - "_get_software_versions() Can't read software version from softwareupdate plugin." + "get_current_versions() Can't read software version from softwareupdate plugin." + ) + return result + + # Reaching this section means we are OK so far + for name, info in software_info.iteritems(): + commit_hash = info["information"]["local"].get("name", None) + if commit_hash is not None: + # regex: "Commit 89nhfbffnf7f8fbfgfndhf" --> "89nhfbffnf7f8fbfgfndhf" + regex_match = re.match(r"Commit (\S+)", commit_hash) + if regex_match is not None: + commit_hash = regex_match.group(1) + result[name] = dict( + version=info.get("displayVersion", None), + commit_hash=commit_hash, ) - else: - for name, config in configured_checks.iteritems(): - result[name] = dict( - version=config.get("displayVersion", None), - commit_hash=config.get("current", None), - ) return result def _num_files(self): diff --git a/octoprint_mrbeam/iobeam/iobeam_handler.py b/octoprint_mrbeam/iobeam/iobeam_handler.py index f9ccad34b..8a219a657 100644 --- a/octoprint_mrbeam/iobeam/iobeam_handler.py +++ b/octoprint_mrbeam/iobeam/iobeam_handler.py @@ -62,6 +62,7 @@ class IoBeamValueEvents(object): FAN_FACTOR_RESPONSE = "iobeam.fan.factor.response" COMPRESSOR_STATIC = "iobeam.compressor.static" COMPRESSOR_DYNAMIC = "iobeam.compressor.dynamic" + LASERHEAD_CHANGED = "iobeam.laserhead.changed" class IoBeamHandler(object): diff --git a/octoprint_mrbeam/iobeam/laserhead_handler.py b/octoprint_mrbeam/iobeam/laserhead_handler.py index 19605b567..77a429ba1 100644 --- a/octoprint_mrbeam/iobeam/laserhead_handler.py +++ b/octoprint_mrbeam/iobeam/laserhead_handler.py @@ -3,6 +3,9 @@ import re from octoprint_mrbeam.mrb_logger import mrb_logger from octoprint_mrbeam.mrbeam_events import MrBeamEvents +from octoprint_mrbeam.iobeam.iobeam_handler import IoBeamValueEvents + +LASERHEAD_MAX_TEMP_FALLBACK = 55.0 # singleton _instance = None @@ -30,6 +33,7 @@ def __init__(self, plugin): self._settings = plugin._settings self._event_bus = plugin._event_bus self._plugin_version = plugin.get_plugin_version() + self._iobeam = None self._lh_cache = {} self._last_used_lh_serial = None @@ -74,6 +78,7 @@ def _on_mrbeam_plugin_initialized(self, event, payload): _ = event _ = payload self._analytics_handler = self._plugin.analytics_handler + self._iobeam = self._plugin.iobeam def _get_lh_model(self, lh_data): try: @@ -92,19 +97,25 @@ def _get_lh_model(self, lh_data): ) def set_current_used_lh_data(self, lh_data): + laser_head_model_changed = False + try: if self._valid_lh_data(lh_data): self._current_used_lh_serial = lh_data["main"]["serial"] self._current_used_lh_model_id = self._get_lh_model(lh_data) self._current_used_lh_model = self._LASERHEAD_MODEL_STRING_MAP[str(self._current_used_lh_model_id)] # fmt: off + if(self._current_used_lh_model_id != self._last_used_lh_model_id) \ + and self._current_used_lh_model_id is not None: + laser_head_model_changed = True + if (self._current_used_lh_serial != self._last_used_lh_serial) and self._last_used_lh_model_id is not None: # fmt: on if self._current_used_lh_model_id == 1: self._settings.set_boolean(["laserheadChanged"], True) self._settings.save() self._logger.info( - "Laserhead changed: s/n:%s model:%s -> s/n:%s model:%s", + "laserhead_handler: Laserhead changed: s/n:%s model:%s -> s/n:%s model:%s", self._last_used_lh_serial, self._last_used_lh_model_id, self._current_used_lh_serial, @@ -124,6 +135,21 @@ def set_current_used_lh_data(self, lh_data): ), ) + if laser_head_model_changed: + # Now all the information about the new laser head should be present Thus we can fire this event + self._logger.info( + "laserhead_handler: Laserhead Model changed: s/n:%s model:%s -> s/n:%s model:%s", + self._last_used_lh_serial, + self._last_used_lh_model_id, + self._current_used_lh_serial, + self._current_used_lh_model_id, + ) + # Fire the event + self._iobeam._call_callback( + IoBeamValueEvents.LASERHEAD_CHANGED, + "Laserhead Model changed", + ) + # BACKWARD_COMPATIBILITY: This is for detecting mrb_hw_info v0.0.20 # This part of the code should never by reached, if reached then this means an update for mrb_hw_info did # fail TODO Remove this part of the code later @@ -407,3 +433,79 @@ def _write_laser_heads_file(self, laser_heads_file=None): self._logger.info("Writing to file: {} ..is successful!".format(laser_heads_file)) except IOError as e: self._logger.error("Can't open file: {} , Due to error: {}: ".format(laser_heads_file, e)) + + @property + def current_laserhead_max_temperature(self): + """ + Return the current laser head max temperature + + Returns: + float: Laser head max temp + + """ + current_laserhead_properties = self._load_current_laserhead_properties() + + # Handle the exceptions + if((isinstance(current_laserhead_properties, dict) is False) or + ("max_temperature" not in current_laserhead_properties) or + (isinstance(current_laserhead_properties["max_temperature"], float) is False)): + # Apply fallback + self._logger.debug("Current laserhead properties: {}".format(current_laserhead_properties)) + self._logger.exception( + "Current Laserhead Max temp couldn't be retrieved, fallback to the temperature value of: {}".format( + self.default_laserhead_max_temperature)) + return self.default_laserhead_max_temperature + # Reaching here means, everything looks good + self._logger.debug("Current Laserhead Max temp:{}".format(current_laserhead_properties["max_temperature"])) + return current_laserhead_properties["max_temperature"] + + @property + def default_laserhead_max_temperature(self): + """ + Default max temperature for laser head. to be used by other modules at init time + + Returns: + float: Laser head default max temp + """ + + return LASERHEAD_MAX_TEMP_FALLBACK + + def _load_current_laserhead_properties(self): + """ + Loads the current detected laser head related properties and return them + + Returns: + dict: current laser head properties, None: otherwise + + """ + # 1. get the ID of the current laser head + laserhead_id = self.get_current_used_lh_model_id() + + # 2. Load the corresponding yaml file and return it's content + lh_properties_file_path = os.path.join(self._plugin._basefolder, + "profiles", "laserhead", "laserhead_id_{}.yaml".format(laserhead_id)) + if not os.path.isfile(lh_properties_file_path): + self._logger.exception( + "properties file for current laser head ID: {} doesn't exist or path is invalid. Path: {}".format( + laserhead_id, lh_properties_file_path)) + return None + + self._logger.debug( + "properties file for current laser head ID: {} exists. Path:{}".format( + laserhead_id, lh_properties_file_path) ) + try: + with open(lh_properties_file_path) as lh_properties_yaml_file: + self._logger.debug( + "properties file for current laser head ID: {} opened successfully".format( + laserhead_id)) + return yaml.safe_load(lh_properties_yaml_file) + except (IOError, yaml.YAMLError) as e: + self._logger.exception( + "Exception: {} while Opening or loading the properties file for current laser head. Path: {}".format( + e, lh_properties_file_path)) + return None + + + + + diff --git a/octoprint_mrbeam/iobeam/temperature_manager.py b/octoprint_mrbeam/iobeam/temperature_manager.py index b97ba16c8..d2161d4b5 100644 --- a/octoprint_mrbeam/iobeam/temperature_manager.py +++ b/octoprint_mrbeam/iobeam/temperature_manager.py @@ -28,11 +28,7 @@ def __init__(self, plugin): self._event_bus = plugin._event_bus self.temperature = None self.temperature_ts = 0 - self.temperature_max = ( - plugin.laserCutterProfileManager.get_current_or_default()["laser"][ - "max_temperature" - ] - ) + self.temperature_max = plugin.laserhead_handler.current_laserhead_max_temperature self.hysteresis_temperature = ( plugin.laserCutterProfileManager.get_current_or_default()["laser"][ "hysteresis_temperature" @@ -55,7 +51,7 @@ def __init__(self, plugin): self.dev_mode = plugin._settings.get_boolean(["dev", "iobeam_disable_warnings"]) - msg = "TemperatureManager initialized. temperature_max: {max}, {key}: {value}".format( + msg = "TemperatureManager: initialized. temperature_max: {max}, {key}: {value}".format( max=self.temperature_max, key="cooling_duration" if self.mode_time_based @@ -74,14 +70,16 @@ def _on_mrbeam_plugin_initialized(self, event, payload): self._iobeam = self._plugin.iobeam self._analytics_handler = self._plugin.analytics_handler self._one_button_handler = self._plugin.onebutton_handler - + self._subscribe() self._start_temp_timer() - self._subscribe() + def _subscribe(self): self._iobeam.subscribe(IoBeamValueEvents.LASER_TEMP, self.handle_temp) + self._iobeam.subscribe(IoBeamValueEvents.LASERHEAD_CHANGED, self.reset) + self._event_bus.subscribe(OctoPrintEvents.PRINT_DONE, self.onEvent) self._event_bus.subscribe(OctoPrintEvents.PRINT_FAILED, self.onEvent) self._event_bus.subscribe(OctoPrintEvents.PRINT_CANCELLED, self.onEvent) @@ -90,12 +88,9 @@ def _subscribe(self): def shutdown(self): self._shutting_down = True - def reset(self): - self.temperature_max = ( - self._plugin.laserCutterProfileManager.get_current_or_default()["laser"][ - "max_temperature" - ] - ) + def reset(self, kwargs): + self._logger.info("TemperatureManager: Reset trigger Received : {}".format(kwargs.get("event", None))) + self.temperature_max = self._plugin.laserhead_handler.current_laserhead_max_temperature self.hysteresis_temperature = ( self._plugin.laserCutterProfileManager.get_current_or_default()["laser"][ "hysteresis_temperature" @@ -109,7 +104,19 @@ def reset(self): self.mode_time_based = self.cooling_duration > 0 self.is_cooling_since = 0 + msg = "TemperatureManager: Reset Done. temperature_max: {max}, {key}: {value}".format( + max=self.temperature_max, + key="cooling_duration" + if self.mode_time_based + else "hysteresis_temperature", + value=self.cooling_duration + if self.mode_time_based + else self.hysteresis_temperature, + ) + self._logger.info(msg) + def onEvent(self, event, payload): + self._logger.debug("TemperatureManager: Event received: {}".format(event)) if event == IoBeamValueEvents.LASER_TEMP: self.handle_temp(payload) elif event in ( @@ -117,7 +124,8 @@ def onEvent(self, event, payload): OctoPrintEvents.PRINT_FAILED, OctoPrintEvents.PRINT_CANCELLED, ): - self.reset() + + self.reset({"event": event}) elif event == OctoPrintEvents.SHUTDOWN: self.shutdown() diff --git a/octoprint_mrbeam/printing/profiles/default.py b/octoprint_mrbeam/printing/profiles/default.py index 3ea2e553d..377ff76f0 100644 --- a/octoprint_mrbeam/printing/profiles/default.py +++ b/octoprint_mrbeam/printing/profiles/default.py @@ -18,7 +18,7 @@ # if set to onebutton, MR Beam 2 One Button to start laser is activated. start_method="onebutton", laser=dict( - max_temperature=55.0, + max_temperature=55.0, # deprecated, moved to iobeam.laserhead_handler in SW-1077 hysteresis_temperature=48.0, cooling_duration=25, # if set to positive values: enables time based cooling resuming rather that per hysteresis_temperature intensity_factor=13, # to get from 100% intesity to GCODE-intensity of 1300 diff --git a/octoprint_mrbeam/profiles/laserhead/laserhead_id_0.yaml b/octoprint_mrbeam/profiles/laserhead/laserhead_id_0.yaml new file mode 100644 index 000000000..b7a88868b --- /dev/null +++ b/octoprint_mrbeam/profiles/laserhead/laserhead_id_0.yaml @@ -0,0 +1 @@ +max_temperature: 55.0 diff --git a/octoprint_mrbeam/profiles/laserhead/laserhead_id_1.yaml b/octoprint_mrbeam/profiles/laserhead/laserhead_id_1.yaml new file mode 100644 index 000000000..5f653cd69 --- /dev/null +++ b/octoprint_mrbeam/profiles/laserhead/laserhead_id_1.yaml @@ -0,0 +1 @@ +max_temperature: 59.0 diff --git a/octoprint_mrbeam/static/img/MrBeam_Sicherheitshinweise_DE.png b/octoprint_mrbeam/static/img/MrBeam_Sicherheitshinweise_DE.png index 42e9961b9ac0eb9824042b0619b85f5dbfa9a0f4..a1deadae33a0ceaf4103ce916dd7978e8cf751c0 100644 GIT binary patch literal 45669 zcmeFZXIN9)*Do4nBU@>9RGOlKNR{4E5do1VO-evI1R>PWK~X`ZDF`T4q_-d?v`|z8 zM5HJs5C|Y0Lg+ORI5R=r?(_c7Iq$h2?)`G}-~(A}t~p1aWBkTkhG?oQ(H}Z<2m*o7 zt0>>N1A+XN41rJu{kX-yKZ;YZcACf z9r(>G;pSHSo(@i6Gz20e@9AV_VQ=Mj*4)a*&QX?Q9$m+A*3MFvLtj))P|Zof%GOTV z+r>)TTV2P(+ulObl0#nZtc<4=n83lx&FrkF!+l3rDNk7r%DhtGZ}MdUj*)GZQb1+` zo@P!0SNH|VTu}yETKpd8FV8f`WTP)!>$P)?WWIvqEiI(1;VuqlfMq)eGaD-b zCr2BOv%du?r2xMVcL56n>V*HiuA-oz=>oU5yAN)--ch=KRz*=k?24qA7@rXT6$-g( zYEmkWu5M!&MeTRH#y>%QGtiup*HS&-dAmcxQ<4_1~OKQG(; z2YLLrR{r_ChpiQu^nYU|d#k&`t=&A#T&%9y0NMRF>`>r;MZT*U;(t&4e@~fvRQ)I7 z|7ExT&xrpi8Vg%9M;j{;Y6UpR>3CuZB#&1Yy3OWy@kIL}AHVrkQeS6h^jiG8_fgcme;-yE zOEhbie0ss%g3O#k}^<&&MXcS%$F2<4NC;GlfE z)c^ncWC{GgFQ4zz`QG!IJkJ!#%Rk1d)SY2%)nXGt`51I=OnqI0@7r354>3q z$h)Kqxhjt!Uqc6^>40l-;F<>HYRa!`_rNt9aP2na>h79FPSRHeCZ)byx~uRVJ*_AR z1jbdhG^=g}A)+gFgCGxT=RVz$=I*N7gx9V6sA)=@(5zS(as#Q=9BKixRPduG||*|*h}|KB~9q*(m+-`T@?uFrfACaReb}w zGmr;Q?t65pOZC<{8%^B9(A2G85p*cXWq?ezu^-DxTInlzbzm-=wZoKh@eRWKbK84X z6je4WIaeQ}28E zA9~IP{idEm5PPw(lM(>}qk+6Zbg3Wsfd9oC`R+a~X~aJ_iG%ooSe4&nzpPj3E*AwJ z19WzD+}R`e`!NLs^-v2SS)}wQOJ8@NL%HEuKqO}jf37m&`WZQp^bT-B&xfLdXiCGl zmM7c+gVRfa*vdCQB~kEdcJE5gB;^X-=jYI@Zn89OZF5*553pL&&}IG{vb?fdXn#&k z^!bb&cBBXT`8{ZQ@Hx)+^!Y!@B#uM<_{lRtO@2!H`;du^+=)LX@?O{bS|-I0q@Tnu z08~$2ZhG{bG!?L%IHsSx(S4+->yPF4jN$jRLKGGKGsEe>P!@kquu_A0t?`7y_nv`# zuXbeXCYxL5IQ37_kYp`whW8|~H^z&tIH9R9nrtV(6FF!2%?@u#V6>ijmJ=CgEtrz_GBke{pi$y@3#yeAvOZ$X-16rjfd|G#WIeV(F? z|7_cxKiJMdP=DH1FnYe`mm`s-SwmQg$q}fvARG8^YdMEDnSJr6Wn|^yhA3wKdx-zq z*=$zyA4W&)^P6{{&`$lw45j)Wy`ebH?}yY8Lq5j`KBjMvo4R~ZokB+ zL`(5b(8D;W6Y?#-_SB}xZgt}u=Lm4AN^_DCYW^`136gyl0W*|S{3!% zf3tNCy>Hs}6j0l54-A?m*4CQ=d%32dx)(K07c)O*p!ri^)yR1t=6?yyv4Q3BV9=iy zW%JqbDYgi`a|iu!UaH;ejzOEZ*`Tx9uPK2QJ09*rHs!fBx?DmcXxGesI(OT1R8p!|>d--yNcVNx%FmnhDqx z6t1_FX~9$M{o(f3bmEP1S9S876gQrIo&?VX%wk4ev%i|(D!F9-!o?Qf3nCsBgjE^F z6*LQUg-qnVg&Qegk|(RM?#N^h9fC`wTkFy-ZUuzm z0p*;eq4$(%TgQ26E*a z=d|_$Z_un8_ZMz{Di5kmM9psarMC!bjd#aj<(KOZ(eDK-*1}PDvRDpkYa^Bo&;zQy ztASW6Uk1S~((9ii05Kpypt2AK)~{xZu_*MgQN)RbXZg1J3%$44xqrD$QrlzT7PyYt zdNrsvTGxw7{#ECjTZ`EPO+9mWIZ&Oh`^h_>Co9EKstORe!pD6>{d2=ci}fwe_cFFQ z-Xf?r(fWBJkT`B1U443Djob#mrt}p`nA1XU%cjod;c|^tZ)r-`J!MYX-)c z%bK0kl4ZWWYIWIvvTSc6;D6KZvhK=22U^mA*lgBpR%31$R~M2T)A%e=Ekzsqz=ECH zZm*>lHIc9m)4Ka7_M?uOln-|~?!!V&vy)7o0FT#_e(C=DOZ=$5=v1L;$+JLgNT0U1 z4w*=4=po9)xAdjE?|s-Y(G}`aKiM(M?RPHmz}x{N!a#5i2t-{B4FcM8&kD|fO%TWo zYD51Rd%D8NmJ-^Tl~Fu3@1>oorJ)z4+`iPjLCE_1p}jmQR4X7Z>MRawpU zQwPI@n9qN5=dG=m9QrPqbV*h63sk&N2|4e}$_8}X6@h7;#MxW14sIi8$vgQ~Lf0~w z;d_9O$6Luu_V5z;(6<+Fi-V$W85^fEA?K^vDUY?yax2;+3Ui>5{Ymlp;}Dc~yL39D zGQfTERcjrSv3YE`wBNDe>TGDF>Ckt3RSjA1Q6?r-^au80JT(gcg83*}8X%_n`ujXn zB$6bpm*-vP>t3GcB?-CD>DAYwYh~Sk@w9wTyC$C!OGAjdsgB=&BAx|D(x+T_ck%s#OPMx zWs1m5FwR+TL6!sd?+C2BIzj46t^OF~fC}LY@g;{1RvJ^jg1t_jH4U*G(BdA~?dU&$ z_1@mhTIdlN=AeG!kV-=~G`I_y1{ET!7x!_ss`zW}O5>ZlF2{F-2<$^_&SaNkErW|c z*NHR)P#F{**<8pA<047<+?saLb+qV^Hnk@24qfW9^W(|pS#dx3$9*Tq&-&<*$wj#8 z-62n$bPmnNTEVlJgHI+3F@p&I1~KE+zIHrRqvV@3Y1QlXG4#NffmTsLDGxt%i8zIp zK#&*|K9lpL1jmOUJnqv(m+^n7mcDJ82j%KP;m7gPbygG(!6wBB6Q305F(^wkEd;JY zkzOIz-R8(ln0#iKJN+!(l zi$)>TltQ)9l`RE=b&6Q7F<1@0dc6!JDX^^Mc2$j{0i;t%-Et082`-nojyD<^qzF1_ zc4E^$7Cwv|#y?6&JhJ&In53K|lZwqJ1F%q{YRMoz>9>uAh(%{Q&D2#gu=lp?Ec2U+b<1Z*Y`VK#@{4vh!H%9cexq5Ddg4 zOH2`^Us^Hy9h0_V$9s9#xmR{p`JCZ3n>-%{_<^o|xU>4*uW9N=4y@{ulSyE`)im9X zY&KRb_fR}{c9I5ntBr?_uHW3VmT}(DzHuL+l7SoF&K2UPM$$nTB^v^6mOFO!s*aKp zEsYVur60-_^w*?)L3QyO<+)LJE27GaBXxmPZhi200il`RCqr$HE$L)cZ&v3)1!N|a z2w<<2b@x*pU?!^qc;YytENXR4vVglKl$uL#dI@eru_cf{yu-#IFJ-V;3gkg+Zz5{D zkOTPsCp9PXDYlQMzT$H$q(r`TN29VEnSW3i&D%&$yg+87zQ=L#cD_AwGB|6p!D#ymdA73cg=EU}c>r6!_rILKPz5nukLef0L`9 zY`@a!;fLsCU9^c~@H6pc+JY;Yh%Wvn23237%j?~1?vuELO3Rr11|_KpIRmKNEB94w_?96_^Vp3wt8ubIX+0B;_P63g2c$XmxZ$ zx4$k$_m7}KjAbB~yJ?6=!|tp}$lSC$7}AIk$i1aJ9;tyusbt$e0xjO}t-3y+{PtIh zgL2NhTd0Doj(Y_-jN9@QQfGLfQH9k-BkCOUT=)XXaf@6l0xQ+eU8<%X%r%MUipH(B zlptylTXTtWdSh@FNf3Kur+#HBxQ|I98S^Kfy+M$&5v)l>nb61+2DOqYSgXo7p{>$U z)+*tjX(M@e#A%@;@~`TS8C1-|Fg^GN`I_N<9&>GX_e#qM4Bzn&c=S=`SDQNCYJ{q? z3MVuz*7|tzEFRe1-WcGYRBydVCYoKyPFOk2#Adg>K*373jJ#D*WJWDzi4lkw7knao zipm2hju5X=S4s~gO{v-NCFjr&^B1XdT*y$+6m1`Aq5g@Rec|T-dP8CO_#^c=-Cc$Oa(>yT!kz=2`_LE$PbG76 zmEei{xFn?->rpxIM_~;s@0g#o1fl;|#T0>|=S$pFCK?jF7chUJs6fiG?`o(5;cN1B z!U4pr_o|&RM?j`bmR>}6y!p9x{8EKm9qCt(tiQy|}h_3CxUl(+C*~)J3yx z##|$(Qmz!(OaVdCPo1>73fDDl4X^C@8DoDvw0i(QVPB0bIL~qljSnT)TOjICP@}~v zx#+6R8pe_WXT^Wfx-SR1m@!u6wPjUXZ~YGwwCX^Vi7id5PjRbB!}K#`j0a>CG!Q-p zl(5gO0J@&mQa_~_fi&DIhV+_B5;)%~7s@EUV^En;qYH<3b<1mw}Qoq-w`|HON(h ztD&hQs>RWRTH`g?w1II_@FmALT}Yg)<>}Uz4f8cGZEMLO^%PN1nUX7Ea={&eSzVds zPRd?s=tkmv1eRH6?&U$(10w$^$$^J0YpY3XO{<>%f=>)v9o5Mokps&gyiwg5ZK+Z% ziEHZfZkqFU02V>siYdx{Bx70r2DY78?sxLFh}DA@SHXYl$MH>d1jueE6wOFNY@M@N z3z;8RnGkK0AEI}v_@e)r%38zVumZv=hZT)){Zo&i+GZ)V#})ITcs4@19N7Z0{viH2 z?p`h~ah}i?Tnr?#hdQ92AQ9C_*3Q%d_$Nwar{_}HOVD7+j z24WUzL-Q|tcf1A)I_CTT5)GwXBx81z=mo5fiN_nxEl}YzLU|_U#yU0%u7>Aw9Nk`h>rC?86XEVKlmRUjk&qGWmzEU}@6Y!CApuX;4kK9H zDCY1#Liw7!e}(jKDed!<|5HK=h^zlH6l7NL?1O!oH_*$}H-@?wy!53Z@2^wr8Q|DI z;bc3{o2EUPW9$HQ5H%ZU-FeMzA!@%q) zZF#D0_dW=8LlpoC9s8Hpwrtx-8=U5XXUGu$^BT~q0Q0rX74i$5R946X?F%9nPc$Nk zlwM`>XSdqsBnp}P+q*9Yk)i)qH4nqYC)o%G(Nc)i`j&Et*;$@4fb+kKn+U@0dsRN9 zbcmidJykahK=n;?5BBX^rBA)PddBeLLCBPLA)bm%f$Y+j^0e7QkM`w^i2YNK`}LCB@VM1jkUAgSDv>Ici%Qf5b`Fn8rj~Z zu0VUL6H+zs<+1~$V?Yx;Be+o)_EPwyGEd$ZML4CX2ekr%nuI)_{g8NO7}tMnn*EJB zw%1hq|Li{gHRvTBhTMDjrePn1&eyf%aJPCA6@(8taRBmuk$9J&BLsN>{=T{Z^wPx# zxeD4d4YZIcX|&I=LMn)@qo_FKfqyw#d{GLF({rVQOnLmgW&h``vVY$~NdPTjj=|Q4 z{O8xfkr)*ZtYOj#$kn=j=ulpgIwRz8^@xLmQ8L$dION*cJ}$&&E1Wf-T7TA2;HfGl{)|3p3$9k zW}Y0JFF<-2An(w3u-Gt@bpp-q#xDKt!$C#}ouJL^YA{LK2~!Bm3ZR0_BJ<0{RC#uY zUsCxnqh~R>Zch7DrNUZ?9c?gZ<)?A%qNft+OUxxXV% z33zmGuzo+*c2go4AiOMtWd}h%2c$*WbN6yf3h+tkDN))|6cm$!K2nl0%2x`KNa@Cq zpIa_Kki`&C@J${9S^3*OYp}Ct2i${t(eGD#0l2tbOD~{~54HAmzFL!X0Jy zq|qh~ot;rxcmL(>u-z3jla$Y?lq#={^ZNQ!DRmYSqelKaUo~Z_O?bNJ5xXucE_4;MFw2+-?&TqTi(yU1{uUIG&j~gt^nP- zOaV85&Kw`+;$oD-ccxSLZ~a}qF1`IT?xNez)8xJ`#XZ%Ow}6s*9-W}4-?KU;0(Q84sBg+` z(Ep3AuWZFYl|9B(-gk0Qo&Dxy7ykxqVAgafo` z`Hbg$vFE|g4$8{5j@lH!))OY}je_d&@z|Q8s!M?}HAThY9wZmVg2VB1&PjTNkD+zO zFO&$^CEJ(Yn`}%uK~6JD-|unDZdObj=PN9b`@pL~LS-OQ`AI7|UwGU3IYmoyzM$md zB(^??BT(KYdZ>iuBOUsNjdn)eNW?+ILu3?r&sUL$ZD!?9O1~_^Y_*+dZXa$y&e*`& z6@s?(2vjc(C@~beZmSVZxSZeFe#qHU*pfz zR8=G9jfo2DUiO6Zx4fQBt9me|RA73e8dhcD6@zbG8QDUG9jZP3L{BP8giSq+thKPr z%2@3@_{8<=oP}v}X=^D~)_3i*Y*u8o*CTA~kMszf#q4;uPwjfxi+ASulY#fpss`W(!z#pQ%{1-tkbsAyciq5eU;FKVA2PkJa%+h zmD^}Y_NQyTjxuH<#!tp-@W`4e!dAH7Qe*ftE1R#zbLId?oeY4bl!b^ z-uc2ZDbJ?hzApOSqs5psL>|35=OdTqU9lYKy&*!QM!(1X#dKq8_k&r-F37M1u(;O3izu5-!_2rLt?g`br}jOWhvQv-o-JkOac^FH*kTE-v zVom3>)v&}3V;bN+{ra}itweu|H5sBhV7J68r244qWpT9ubm~%-FspAgHp%OKZ*U>976h$O?329HP1oVc)kzz@xUA#% ztK=RRDio`+zy|I6o!kEj!7S!YesKky@e`Vx6I3y7`kn=%Obs!u8UyycIB_-FMl~)G zHibht{FGpd5$P@lp2Gf&$D2z#S0o2FgzN3qWvO^tv;7Fc0>6Xy?6hFf2t9u}>DA4P z5#OlKspNy8iis=QA(CS3y7}eInc6t|n)T=G6D^#kOR)`h*X5lQQBahsC1=6ahhyj7 zI~gdXQrF5?)|xtf&K!9rJ><9?VwyE^t?wR=h-8y4uie$ikXwo42|`LE{oOyt4*6$C zef2(C=;Dal8l$goz7pWL^zc1eJweD%-H`C{%7uR4i8A82a>NC;?X>w*c6>!n3w9`b zLw^f(lIsm+Dn1buky9DkF|T0F7#+Ovou*I81W{^%G-r<{HH_Qw}JD#j*Wxksyp zAKuW(gl@lCwXO_ z(hAnZVc}d{Q(-|_?Yik)vdhSjU;5IlVt1N{eWGF>wn3}d@_PIVF1fnfms4$FQQ%3lUMqqvk`V&L!xuxzv4n8y6 zFUq?3p>3uK`3K|!GX0&8g(f2wss0hdlGkF@P0aGL2VIk-&d4o~Np_*w+J^te?6 zZ@C8g`sj&Q-+HDMkW$_vhfJce4c9(ijsEK!5hNZ@^4G1~RQAeQIz zTSQ7NO6;^9b}AmZHH4F3VW(GXpNkG#-?2qL+Wq2JZ-)vM@3YoHGYRDzko8AS%RqJv zjr-fAsBvuBA~Hq#sPvch6a$a2Nvm$Z?k;`_d1iO7TUOH&qyg2VV zw?11TMSn{I3T8f#izqCZI*1C5tiQN!H0U;B>&pg5pth#9V|pGIipYDG*6JBaEUv(g zITyDMz}AcGnM+I$XjLzC6yddPj)-qHQpJEA!pJ6f*x{WcVXjGEh{g8^$|srZdV4uK zI+cCijKZ0+zm%v%^->qif;OSif0pSLv~6p0Fm#amFDpU$$<3+q*7O4=q1m zvAvUcq$?={9o)J8S8N7CSS@Wyqnx4qnchtl?WcpPqgUtTha_2$ zhQrU3VDmK~Jyvh$}N!iFbeZvZYQq{N_zu}vQ1t}8<0Gu9b2N>6rj2B0y zx@lE;lQ)MMP5c%VyZG-K<5R9XN;!+j3TQE)Xfv4Duh19Lj9?#u?B?etUQ)F59fl8V zSu~aRs=pt~ej)TxYdXT?cH7BQq;sb%IkRciQK;=IghigIrxu@ zS8h%`YAsRwlru*4K~^lOI@D#7kISSYJwDk&(ChtuPSlp>Oa#haPr#Zrj+aqy8K;zK zfZ;zpPm6;^hu8?@Hdd~trCRBrSKfR%$*h*B(-<|bDh|t6UK?oWMr$yKv^?eFNkHX7 zv5EDSk3DLvqPc@&p@cOrdlJi|HI_>JMyYCSlP>*;xnpYLC{OBk{fRLBb7!V`VIK3R z&rkc@stI(FaE_mRjsC6y3Vi-jF9RYaHrC z*s*ijHG_Y6STANXYg%{Mth^xl<>OJtqZM;l)GFg6rkdr?-{Q1m#ro1%^nZsT1<$Q=#{{X86Nf$MD|mB$KjH)X#P+8r#`rI?>vroCs%pQ0 zF?a84Zu`jVlJ{vc1Sa@5^nF{Oa%?2o>nN;J{7(_R#ah!d9SN{GA@ga<^ACzQ#-F7I z_^mq)OEc`b?5D`BzAMLuB{;nf=p-;Od$tS_!`fB3SqqQOM1KIp@{4VPG4SiXr@OD_lB zkNU1I7HV{WP0q)%c|>t>b=SMk!Zd;mmw!&gG=|E{GfIS+HWT+cm4ly`@E zKXPZ1^`HBk1uwuMD?y6uX&?XLI7u7ATewtp!O>cC%&?7}Is(Rzz zOoI)7cHM@!c-QJQKqnpLtyZRRjqBJlvE#1eT4_VRZ@$s)E_?K>v-o=gAgq-uoUL?p z1Ju%{06r4Rx%s_Wz3kvNrZc9lI@kOApoNd4uz#21=zN`TgxtE1Kptn!GO3(BlF?q) zrS0?W%d4;ZgEacG%9f+oPjB@zXPp`*hXknr%f7bJt!fm)b10xxr~v!qJl(}(ay*HO z5^*h&r%2_or?2gd&;3~N-oU&Iw(wy00W}{cIZ2JMv)p|1;DxO17kT*cwdAhK0iT;S z3#QezWvwld8r!` zE37o()Mo0Yt-3h|cdkE7c{h3YQaQjYBG zwx@Ws;TSp^mL2y#eiWmu3kDm~v?ZyK6ZBDIXjjrki;O9sLV@N|!t~!cNdlrktF*yN zoWV*x#ui#rvRv5bwJnQGEqEix;`Bl4fVH=VlX7=kt(k9&$R0)wjwq(~C*5b4YHbcx znw8oqJKalY+b&Cg&_vd_5)WjOO>&Y%h0pTzd*gp*+O_>;LpFKY{Z~D zmyJbjol4&mWqAA0x95*<@a?QMatq(R&@R`2W{*x_QxNxFZ+7%MT;0*_kGDRir5vc0 z-i<`ksB-ow+qHjD%>y~>T^oX;YLDGEe4)r7Vw*3aOMcNWP9GQ>l7kspera=s^Zcy= zQLG(NqHgo*MYg*esm-U~HuLsp_}7}HOtQ(8wdk$3eq1Z$FP!Is-S%93z}h(K_()3K z-nKo9ZswaumAk-0f(ICwB1LAwemC*Lbod+9UtyS64USPA)M7c8L(hoE+ z5g=~#xjwEq{XT{bRI3mx`F zKNdTl;Noi1<)~ZKCqU_-CwTai1~iXHjhWQ0Sg1b)kP3Ix(14~#$SMZ90{UC+gM*r( zXM@cibtFV`M$-*sbkEi2@r|&;2;6t6 ztnp3!wYK^zEagoDX$bbJ+;fjLkZggpMq(#Ex2K$bcHW{{5UPo~)Zbi?Uc^DIvGr{f zwSUtICJ)*Qp0Q15I%5PQyc+p1$t*wUVuT%I2il15U!PypIN1EzsX}TIT3E1Qu42T`se^{<%N4E0}@LTGkxv$vD;e`&_@ z0nZUG4Lw7+NNYA?G4&I(cHZ9?3LgtU^AO}LOdp4Viu&dm<4cuFxh}sZPQSFG)=52kdGhW= z7DnQkjybVPeeJ2|*b}_(i<6spNawDCy)c`V!`Zz;do5=*DEeASO<95b**Imb!_}pY z#)uoFfbu>!4&)BYyp}J>f2Y;gz>eOYehEMsjMF&hF9R@-FX>_|XrCGyb~g^M@pt8F z%g)Zt=(E;~$KXZ<#osyt?Hj}$QO(DrEB%(9$MTvSZ}+Gp%)n*fD2W1;wO_fjzM%M)vW+BpvutBgVz2JN0b$YA2y zXvv$QcG*t0uv>kms$G2^HF%Gu4{hthx4{BqD!(67da1Vs!4|21*)ck-aL=z;QTF{J z-nR(W#H?AE{>Y4PrBeGX;}~!v8{}S}w*(3sxeu9|N|stWL-nJsy>iDO!?jrjy-G}l z?3KGB?J6w|Y`XbbG<;!m5h`|G+XF8$x8}aHGo>KxWrOUx%_sQ)1Et6O)0Ngfay9Py zwRagvWhM1oRO>W;W0eCXK4+6d`zudNx&US*!Yb=ehEqMo#vWJhgre0hFsd{jRDIjf zeLz1>-D|194V8e1eVOS%L5aHBL@q<`pe1*?x2g~ht@}EAAj7#|k9po9AK=1l`EI4& z@;ytiU)LW|i&?L&8LVLtXw3R(VnXWBVd0=1iOW|>;yg`{PsI8yA{)_x5o~K^*nA?o z#;SVyMWwEA{`ojXLcB>BtbF23XX3nQQ3N;2lM*>_=W$+<5hp z?03C|*X6zf6T+^h4#4bA9(O+d2(6yykplubF$6!8=Cz)5Ik+2+ouDIgVy~Ab0 z_YT$>f6E8Gd$}tG^s$}_*4sl))Y1C2%L~9*cgFTTJ|8B)R)jxZaI4+)DAxl!4#OU= z;IP&u^GX=g{C>3n+hb&R0q-u-N|1EhWbrC<^b`7oTO#kXI~ zPZO!t2zI|$m)F1gvECFenFc5GO6>861nt^a0m>p3mA@!mhZl@K42F8e!x$#{Y?&mRa zVr$X2X{unWmk}xtFGQ9$lt_D}6!jc(8a>GB)x)n|=smG7Jd3B$z)$C)>6{Lj$!z>^;~c=G zk=I?m+MTdd1@Ce=$f(~Tj&fbD^YfqTr2~+ZhL{0KMlSp`?U-=6nk&TldOTXM-M>$Y z$OI?RSFaa?7l`I&n`x*$aJeS({l8aUlB_AmmdhQQaR~PCN zk&ERu9qdx7+kX0uUB<9-w5ySqGepl_nebg|<#SgSHjq!G^~tN+eM|XNP1oh+)JH3O z;zOehcsg4ul0Z&Z!lXO;S)=r6ii|-BxB{9TjO=;om|EK0!(}1s#r!7r-?-qXb_UPK zWJ_&1h|6`B1O(SO$jG5y<*)cPXwfU60XUo0#vW2{O2~y0%bG8SCSW#_RR|_tRZ%7o zS@o0g{Lk-&I6JHZSR^=FjrNE9pwK}2Q_yQ(TC#{)IUnzwUucX{#XNMXtbf?xUD4mO zns*p!J-}JLF(rNTy5E}W&tn^8o$i+pu)f4Ek({itgzeft^x?_K*XW0?jLH5{UnOjA z26yqxt)0|YjZD{AZZiJmln&`D+dwr!0!EImK{#JgfG^ zg>_c>@}t(E#b-^trz>q+7B~9upaGINrD=Tho;u1%)cy4O`$kpHk)*1ktJd)smWPuX zN0Xjwr6*L3r}uH{alb{>`6I8O?T%d&jrORib+N5qJ!w^BOez1tu@L00vd7aDsXDnc zvHt0>_8j5Nzs?^zS?*bIb5~-U<-t-EJ}qoNWZqfO*O=$y1@ z{={c!Q<~s~%;Q|52cP+Xx>fDib!_egWMb5%mf`0+0ba_#$@$o7K zl&q)Y`~;wc{qnx~QML0TUN0A?X*1~-`0Jc5IBe}jCdz>wJ~tDn+{(BICfRjso3-Aq zd0MU3#gw3#RkJm>8iO*>*!dCrV+{HEH5rMBo68}Lm6S7bMYf}k`ktTVy1(2?!z0|v zCdu_f@FQET)1*^gt@R|pmOg&?YlMZ*j_J^(GyxrW>*74oKljo|L1i5K6|CjPHKqDZ z|B136`pNONQ-K;m0i-T9)a&a3TfT9~RgL8Q$KPqKHsI@YS!%`8u%KuH$@_QL^S$!@ z)+Y5n8{XG1F1E#$SSBgfz5Y-<67P=ZGg+xoy4*Z$#F7m4%Gn3rINUpQ!7#;vVIQhc zbnO?{NY4tcoc{Ff_26pv)@6I-H_r)>TQ!Z|Ic&yNC(=j_g4f>3Dcl(9gaX%WpG?16 zN11ADc$>e)SP4_arxTnU==-8C^4q{0{J&-wGp+L3kev)0aQ-qyJ{$qUgiGXjA^`4U zV&e4XWl(F4P3^3kvxNG}6z0FkY1H0%DDshh%6k9hcogOI(LYD6{yd}fucKDK8o?Ar z0xSpKIi;9a{6@$YGMXjF0@fJ6Q{fQv*M5OFs zpDne|p(AxhcIrR}Y>u=IDmoX~Lk*nqP`iLW9SHyn@7t4eRyK4Q^e;$m2(Pi@mz09d zBje5*M+|aDmoT!>ib^hgm#v>iSI2K}k8PfJe&o}BN`+wy)KhLFkdMKfTjcQR>$9AOfu}@t_>TtnD2PVz63cvhgAxGXkQ;ob*T(B4!0tT{6pb z2y|nuUG^N{ZS7xY_VN2Z$KYe+mk_<)Hp4hCX>(!j^2!-ic{I5Y9te2eJFvAGxvpcl z?h0Vtx3r{bwz@Aro?Qq&GmG2`kbbJj#IM8{t0Iv*DFB+O+0UIHv8-0|J;S8jE&E}_ zQY*K~@7ycbV%PZnZ+VJ>JC49#E1~dl;H_A4%&EZQ+^$FJ_&5T5h`b0{es~ie($XgqmpL-IbD6 zX}W;*>jWaF{4TLFRqhUYNS$r1Fqzrg!iqF$TIyAQfnumNau-Bx#+&ap9m<8qN+lL0 zm!ndOlMTQ6-K)*2&Fwl4iW}VbgTZ_lS_vJB1usg7>c!Hw6BoDgqej$W>1j=*m z?F@(mU(*q$HH9uir_Y0$Zv~usGE|!f=x6?Q|^=#mjz;aT( zN21iyL!MkU*gDw3n%Y<^*DAizw4bqCZFfp+Hx_hRRzZ!@$v+Oaxr0vMZkKy!vL9b) z6dmj2xftcQjh(?|g&VtmwXHbBUR!nM$&U;ly!7UpLU>XDdJp)mCfcB3h{`>&vjtj;St-}(pB#(ix_>&?u~(y4h0>vfW%s9kOxF;EE`Br% zeoJfmP;)oBMBOA(Lr{H-<|$|{*)yVoZXK;PSWlEY>M!{<2eFIL@RLt%8s~_-L+y`Gr?(B_6is<9j${*&UwPA_#3@k=c|CX|$|_AQa?_!5@y6_5O4rD+_IzD+ z{4Cc?6>x}X?0$vGD1p39M3##XD*^nq^3;$*B1~88X_cZ ziCj1mk^2ad&-6`Qm6=MkY3@po2%8J&txdmGM(kiP7)H)P*;9WDAj>Ou2HkWIK6ytP zGyCeMVEyhXswZ)YJJmPv-Y5D%m}A+sQDa2E_cmcmlpW^uO7orCBzl^7EI?ke@3uWO z36Wjqu6fDv7=J4`$;kbE`1Ru1`q!E5BX8>)uiG{CA1{dXGvf5qxc)r?d`GmYqWtscr}-YQ)6xqZ&eYh{T!1 z^7{>PBc+F4-qoIR7F%6Pu;g^=JeXF1o6BHU`{YU|i%X|s75{s%VsI?!tr`sTr8o(X z>(nsDNVKWN-o8OacZayT#nT7s}p1!HAGgcYO zEFG|X;FxNU!SSX80pJLL3Sp$C7=V0?7NCV&qO&ghs+Wit<98OBkGxsF5T+JK0F|abE zHX>8>E$KVc#R711=0#XxCXdNVKR98)055dNk`LvHI0Fui*6!LmWVVjQkUOwGlq1Kf zKF~(qa>um@?0ChuQdbxzb?MOcp`iofH=!6D?3|H0dPhBdWC(V|#6io#I@M4Amys#2tb ziVD&N0Vx3$5D2}64#xtB2q;KzBGQ|b&_a@BMlH z@Y^OP*?Xpe)|9RqwVdcMvtXK{E)bcd$+gpFX|U22SS zkYL+Bqt{=E^`3YZoKq%|8`j%GG*%LOG78w4b_i*2IYODoYBW;U=(eBqo{hk>&7?+d z{JfWo32;PfB>;b%OBz8uI2KYJ3*5$T9nAWPaiHQPXDZZC>nY6@t!)B8-OTAa@xim< z_J&ls2z^UjYPa-+qO%C~TBoOlqTE1av@$2YuPV>}3bA3!@2$`N$>pudrstK$0=uU> zt?dXlw25U6*V}I{r#|;$qs@-w zc58^lz19ZKIA>UlG|-NO*@~N^C6L8Swu^~%qufo12>hD}kLDmn&JY<|;|CbW5z452 zh;r2ujL=ZkYK67*@#eXEVl>eVHkwYd9I(bkQdW}|IQH9{XM8|?tnooz`y}0SBU*MQ%dqP!#S8TEB z{5418g7$Ze$1l6GpV3wq$jwf3s;0gD{8i{`1nx2D zU)j4l9v+I62+nu@N4;Q^W_7r&4!)C z8rC@!*P4s7s=(i|nBsqc;cT~A?e|(Vs|b!{eH}S*?KY>=cDUR(WV>O7i6nlb81i4f zMp5@hK<9kDPwKlqTuDPb{4jmtKBs`^%crqUmvAb!UMIP?F3> zEd`%i>g!=CHp_9Li4`-szr=$qp1RTM2T$78!J{G1CtO?-QS~uVp;eLOSoB)EL+0uS z99@)gzF{ZdnAi(g&~wre(~Cgx0l@EP@?O_?Y~T_;7uH|=naYJ_~b;Hd`LsQ4j&WRq%WQ^Z77d|$}|77yJncCVgH zD`2*g>&nrz>EI6+m7P@brA=sx4IlrOB#}&GpF+g0KD~twp#7xpspO6<9-O3A4oLZ( zJ#ZsM_}g(|Yqp3}rn9S|?stO@L$csxNSGIc`3mCB9=y?$HV9mk%K^-XJCanVSO>mf zINO+_JUi#NgD15yDOS<)lTkdMQ2UM+Mlp*HvvL6VHE9H~RTa4ry^QdbXL@un(ktT& z24<3nwnm-SoX&+%5^AdUCNu+YZx_2q({My>d@8{u&#KO*URL~sa9TBU``f1N0mk++ zmK83FPh~ctlFfeQq=YDv!IW0aYbFgL`cHTC%4|9|4I=p2lzW8H$M^=5x48Q2X=n=_9h;X1Cuf}Oi)}_>0!4?$|uP%u{OMuHNOXjE~2TRu`l^ zz|a`<^`37_h55L2>(#-gLRy{9`6#NC(%{vW1y&XM3-a-%z#hR{0d*4?q#<)Mj7lwO zD7(Jd@uQtk9jJ?U`&AJtQhJ2@wP2-?Qv{agN<-?e8k(l+%QSLy+8EX3qg-R+_>pt$ z2_ceI&W+=b@wiZpn$PtdV!s@v-m2Po5%!2)A^w`;87Mm>b~8sif~NimXR|tHyshIE zOOe@k!{{LnPr2#FoNNyE#pantxv7VkoBD?rvYO1boqIo7p|^p3h8E&0*$8?$)Bnmw zZTZLvj~yJ6e8V91t8K8b>dwY%kdT2N6^%2`T=N`ei&~fO3@BZEXdDAfNawBZeD0Om zq>x(w_CkhJLzUx{Ce|-#f9pEd(lVlkB03QgT}zxLAjkVR5D9bpHR7U)2PMPGo~RR$xZ*5<|jCCn0_mV6ke=rUM_U(s{~)%w?tHg^4^n+XY5BG;HyMo>n#}{^GUy3 z8)N(ocoJUQ9t9#K0xGU9gz4oW8Rgb@QQutY(Temc@-kA9JY|u02`a<6mHn&ClJ|L~ zTobO+b{vI_*T^rS(y3X9OD+olFHi4f;5rm#3?`CqGsm))NV}Gf1a!>A%Vu24H%7Xv zO)vU4i-_^+nA83hO^BlCO`z5$%EZNI31DzX{QLz!zOo*G=gI@5EYS|x77XIUd9qbd zi+_9n2e>+F2WesMMhMnkHJVK_&tds*eQkT73f-0C?J8-WX5R3`3vc9BYYZOr1;rQ5HD_L(xZ+XJ{$WeVL+tT(C(z407l zrzJ6#4eTUJg{t(g7gm=AbPSyyqGRv?n!!w=ba;Ha@P{YY8di;>tkMx~z1Q^X9*5b9 zZNpQPxgmUfrgyNha_jK~@Hp{4KVytjIP5v!dTqRK21N3P=F3%i7Xby=;qectOxfBA z23LS_Pj#mG0wK9+^f+8`Iipi3J8eR#)n>B0A9hxi!;gVM@Grv-<8YklrCD(cemAGB z548a;5BOr3sZRQA)iy@&N1o=Y1p!pN`P0jA!>6&lK`}a5>MXu5puVbu=^tm}=1xPE z=2Af%(9&wqf1};uo!4t_xHT1cDI*LHySAA>>^O8T`|@mJZnSmNa=*rDG%TGDbi4KR zokMt#J*)b|5ZsNPA@p17Cd?&%#3f5ilV}mzHdGU_0}A5Vxa8q5$BC+4HTI0+a$W69++k2?Z4r2=rtRcG=p3U_s=J-HE| zWq#l1Ez@PA4A}16uB}6U7~RnCK2oFvLwD^9OJmXe2#?*3_kDi9w8DxvZ@m}flGacR z^1tq>>M5I!z;pOHyb=A(`7Ds281 zt-xQM-irqg&FtZ~Z1IIjZ;=}-roKT#R^^(4qXKHuZJcK=ajAeE6qY+3&a&Sj@8(3#*Idd$^mwMW} zCP!62TNIq+(9+ir?6U0R8(Zqj-mH6k`HZ3mGOw%gU@Adkf)`j>tioWqpqO(zjj74- z3ThB3X?8zr{g$C=Mh8uT)ZLZ{YssHw$K|uyN9^k!419hHi|W0rp6lx)qKD6kL594! zIS>n^@crI&Z--J4taZQXaa4Y}oxFeZ@0~>e;Ih%HB$3)$?_%~_ZaiH7c`vIT-GV)# z$y94r6>UrM?MXsxBSLMYAGt1Oy^m30_9VW*T{H&(QtEW*y8+ELNL-ut8}1f|R#kHH zH|QvxR(4yj!R4@uTU>Tz_Fgt-pGUSC{bh5)z_E5Isd`%4O<8zrx=@aN+Z8`_6+`@P zRSQuZJg;TATj3oJg0H+>cUIG0j}V%;^R`(xXk%}bnDw?(=4LhIICLC}U+3vKvKHDT zj5ft>LYPj1o*b7BkvIbuwwwpCWeIgD(oR@g(a0a6K{IrGKY#?2_z{F8T57k#fiCRu z#A|A#;d&ijy;kz!??2Wl&YdsSw#%A%QO4z&SOhnu6t<<@$ zsk$zhbeZ?0{YAMC0NeOXtn1B+M(>$Q4W5aF1!gZEX2P+g;sk+ne0F6|KXX6w*j)>g zP278BPn~>b;L@Dr!=EVutiyDv+HolDrQ40w4auRh0Z?xeQ1qm3+?mH(H15=}qs626 zx>AVDLA)Lo;kkR=hdGsI9d}kqR9b0zt|F8d1T7gt~U98k!8lArNs`zen<1Vm0ghK zsSc^-67a)<HjrIuhWM8B=P4Xf%(q&2BP1bS;eB6jbjxqZ>pC! zZn9Z3qF5+T!>#eVXrQxI6IY9O8nKab6>7`LgHm4Qu39n!_41w|(}rd|P+3I3m55fa z$EeoXJtjwYH{5FvMS3mvl z*ZnRk{Ha9zZ*8S}YZI+GJbEv0Kq9tsIyYDU<`gSZQF2Kw;92gC=fl#&F1s2cJ%%(g zX?ID}g4sc&xypo??=xI^R1tO*g7%ef348cY=6$vmcWL5<)rpOy%0!LERK%B+eHT@B z*2R^G?`c-rY=Y621wY+rE9>81a%NFAT;d->|8s}EGu&k~k-pWy>frvGBRj$`l%bX; znXMNJ9PEbge%BJLZ#l+`_xQz|w-{((g1W;yoTUlW+j%t+?%zu{CY{NN!voAKh_diM z8iB!b1sx*?Si=vufK>h2?Y6UtsFfU)Uqv?X1^$SZ$x}%pawlHenOGoC|{`2j-y8nM&y72rdR5 z#z<9V<+|ihW=m?{h)sO1)gmB+-X$iRe!-eJP0Vn`wN(I?WW43ZCchfyoFzg%QpOIk zwqV0*J>vraYB5{JPV33q5sDhGW=)KURyS)U5tL=XQjKO}@ZS6W!_=B-50HGkU%tW! zLyO<-2Yv_lp_G*?CD9)~k|bN|b1Ak-vtz(sy+SEyDBCN$N3VQZ+m-Fh2}*iu0sW7C z8;hW^85#9;IL45+`a*$AHH|Cr@NHqU-5xb2*}=_@!P*gZ)NMjds^7WOZSxD(S(+h^ zC&38;43WiJr?nwDJF*r@kDgtc86gikLJh+mjC4c-=EuIS54)G+Aew1R5`aKQC7s5)zOb~Xz^n+??^*Wrn-McJASw(Pm`i92&W zzEYHjP9%g3jqvFyAAX6{#Q3$diXn@A-_MuS*NL!^l9hi?@y2;X?ETH+J>hX3gP zeI8=|rF#syU7{O{E1)dhd#3)zTKtJnpLE(L@>p3ba}F}>VIIQI7HTHI(ef$&Q;R-~WzzfspmI^+r?0 z3uJ_>Za$N4_=Vhy673K48D$C)Xp0R26Un_7=qoJ@rDxDB2p{{0pF0vPK-!Ws+{Jgc z-kB|3(raFxS^Te}aLaXqAJ>D&pq^iip?R1S$=s*sJ$M&@!NK<>>$-slLLc*+n^Ntq zXfH%}xJrSvcd;q~<0)F9Qzo|!3SZc4UK^FjFA8_+tZtJm11shf1KRj@H0k%f=lkid;qCtM@CNbz z+^>^U_S;vJn6fZw_&|`$a98I;qB&9MIontYF+S+b9{cff)cDsuJyAaPk!Z+WBU8U} zQqHCCl*ZoC_jd`m<7g7X{?0`_#L#YJcu(Jw2=d+nb?Lue)!w8h2O1ErL~^>V4e${X4y6(yQHt?};@emL(>Nigkp{&HH1FLRXh08M`f zvKSt)CoODJ2Cl%x4^A*M>u(8dpQ}HR_ro9b#AX5_37wL?>iUFm)gc`QxrEWff=kv7 z#S0?c;%;IfcXs;qD7GTSoaYMTk-)|ssF;Q5albrOKPc_~0No_DXSEiWP>mfbzqPVd zc-j+!X|yURt!H}p^nbV{nFBT1`lE7$vFKikhyj2&*rrNH8>6ZHJ+a{8I3KyCGJ$_q~8yd+D7;cIh-JsfhO zqeANg&vtq;Dd&UwDwb9e(~cZmwkdo2?{;NWB6j+J~4a?3(mCMbHF z)Yo?bp@Q_NE88TXmR_o)A%qH{{8gQVW&S#~a5i3pP!rW)wYSwa0=Ih!{uZX#T8sbt zqW==&0Zp5fi)Bib%-Hm>5|Y6K({*L&##MK1X5nZA;YF$zgcJIWCS5=rlY!kQT(SQ94>UT;KvXd6=-C29E&0%Tu z$hhljvb}WKJp%nloRjtXH#o$^4E2OGx zV#Nl37dF?EM(eqnkCpH3#B~{$nD_CmITK)yN1>_e`!i7dGTm9IC8gAfEovA*UHD#f^h~PYR>QdX z;l3`oVFQP3rzZ@{ELR1KPc~}1-63>P{w*U+A@?k$2`!|Vt_a(cJzh4tGpkYD(0CRdG5q1|By5nt)p|S+r zIXZIe1(lU#(>eM0;5TtSj=?JoEf#UxH?hlDo2;zt;Wz`ruOLu}X<}qBS?AaZaQy%*5Pd;a4HpISw7!Ew_NW>&eL99x~ELKY{Wv^AaI(nv_wB` zl3@&IUvNylUy!tGt*!nq36+m*hxt`FPHnH+6&J@#`r+#R`A`a;PaR|OJLkW$H0aq} z`ksR_KjiQ5O5c0O4A`=QB1a_@=qCbba7TjTJW7^+#m&fVw$PmnE(1)#0~rxd;5cLH zvCR8-kEJ~8xMC)vq_U~sNceTaS(Hi?X(DNO9N8RFvO>B&#GaTTjZ^ zPRhG&EdV#fDjIdMG?P$JEFzu)3jfoX!P%^eY0#0KMhD2M+C5(orE3NsAK+tbDDf51 zQ*%T$PjGJt(^K*TtgaOaET;11hgLC=?=+>N?34?BA*xGAGC(N2=BFXt%yMAODeUvD zV3*q*T?-sL7I8HJ2ckOp*+=@fW2H?=H9#G{=&7D;k+{hF1eCj?74nmao)i$T`|^iTt!9Mbwbm&0jPV zG7xr4k3)Bt*LNyqMQO301(ot};@D8?$#P8JFd*m_(*E7IUBzs!FUJsT-Y z=x7N0TiYyBgTRNlVdA#C`4M5SYRR0`Z#BDQd))3o#jm4+y!FzlxH!qu`K@RR9ydbY z)qO|hX5&h){SQt@4gtLO^uB`57-!1KYtp)XpHb$V!|we{AhZh{s{ntDvEwK4QSLYT zA7703!XP8olfQ;Dsea~Ghj8==UAr~t-E%~dLWriZrx)x#MH`#EH&;!?-~XoeEw#N| z^a3f{%n4@8Y}qu%#pZs}p+Zd{O#Z zH{geg!!8}^sNu3LuPPe-pQ4eC?b%^p&9_xbAC1g3VpY9IFHOCzdvj_=)=kFl@iotg zXP3{e0de~KLs9(Gx6W@SH82tLEGjg~9L2%mqJau&fy&lwY(jx+pYgh!P9>mP53S@G z=LD-zwBF6Q)On?`_q(_W_j`Q9InADGR;;E{O`a~LQ;z1&xUd1$T$8M?gvz{Me<7Wd+npqpTj{;ze*z0AC2n zRW}-(o#g8QaQiTk$<03NHaGCznMJ~F?}E`t0Ze zzyC4;P79Y~e5A5;D|~Mas7kg10eQF!Ud)OvQ;}7BzjzDs`w7<~8%edO@3@Q^)|zvu zZVWo%zCm_83`+Hnnk0`rgRE6f4sEWpgNFJ#yM2NhzT3Aiq|V+GjUZ9b1!Pdcd61x+ zmkng^OlWpN?2bsHU1xTmA4R4~F8viMbLAD0*6{wYBTn}qU=*ScOVuK34oEuf$)_m_ zc9nIH2GXUczpABKy8f+Sl~KypZ;7MOYkS}Pfe&l`6B&p~{QYI+q>h(J z?VYyq7w#)mZ*T_$PmK%eG>I!%>R)mPCm|3$e^uR&HkwJ@e{YeI9UAxf?irv1sW5Pv z_LOHaLJNU)u_<($I@_Cs2XfBwHmCPdio#>eml2P4&bRm*%j}_SaNq5SaYHeNYMs=P z{>92U!o_3sv}~ni#3hSN36&u^x1IQx`yU^Ae6j~oWAW2HfNz#k`rtaXrT%y%!p`@D z4I&~vwl~|v-Ip@Y=pLe4g;T_K*#j8r^^6a|`()%Xk!BODp=gH8CEHGvf>|Gw%vU97 z_&>Ox+MjP2F_8#vbiG9qmzB#lRHCZ%uHPcXI%Hn*kA$6_D4d%K)%vP;p2zfBSO%$^ z%KvN!`P+-~&k6lUJO1s?_#68qgN`KP;QvPhNX(WR#*l}Nn48M|yeFQ};j_6V7@AP> zX*$OsPI7ZmcDWhsDfYHwEJ#sNb=>~E53%h~m1m_h_d2XU%u`I<5^Glz4@-le13==y z30;Qd4+72n$KIjF>0hgq5g*jv?+|%!hx0oT^%jW=q(A};*fB@aQSO$4dn8J+?edV( zVCmnG(_h@GTcN&6^arTVYjMPHJS?y~b72QO=BVa(zy>jPj%)FKW~QJOeOUezj=yTjh)5jFH|2h{vBL$aeAQwv!fa%-Jimk^m> z6Km>TL`Udemp9&0Ppvw#zZ6ey-SNkT-wHT+at*Dw_w5%u=MQN=jQPx$-O^=N2T zfR+no|1dFwTv7ga_K30sFmU48VRqRWIEB=X715$T;;o3P1obh1sml@CnyN#lJYJ)< zrr^wt?0JyykxqUzNEq_q$8?0h8fN@POUa6aO15*Bcj;5JG4{29vqHfD)VlhS_D&$A zTUVzKf)KL|w!pydm`5NH22Jcoyeq&dZ~dN#^0 zSCJ5W$IsMYmP0_(S4_peFWCiBl1+($RWXU|2L_u~wb=EyhUGbBJw;=X?_DY1O&e^e z5}O_1%;jS%gQZqEyp!4s5HHeAtc8}?{z|kXCCGS3D1*B|&QxrvzP;MS`e*_?E^3!v zsnRqqf(?eXlhemv0OjMWhyJ}r-6Zd`$BGU$+{{S zjo5)!(*Y%3wIM$NwYYF=eTha}d60|QjU7uG$w)5NaW!{JO-7%rk+zX=6^b>_#2wi_ zK9vtxl~cFDnW6#klL78v;65?Vk9&!yrX6H!`CGoUiCTrM?ZZR8S6-R&TfU6~%NUnl zX?J2*`oFSLR2}D5qZz^aDmf5BRgw~+<_7dnmD%eX#)3<{v995Iz zU*#(gF>&e5KJnfQ8hP|Ig5~--Kl<7z--A0NMrgs4bfO?FPa?|r9B16y08W1l^6r-x zj@f_pOuvw|h&b=sL-MyNTIh|KkFPxFC;p{f&w`Uq6nye>2Mwd{6GC3zf2~13Xs^D@ zTubxd&e$<&&uaOS9~L8>mctD9J*K8Eh-i#2yhM>dkT~mbk5NA24 zq-}0(0&Dx2M&*$uJ^IQP=XhQ2+Qr2CgDz9=lfZsqFLy*+hbL4`j6~@w%}BSTK z!2Sf-l7e{0ZXXIetYx2<^gAvaIVZZ~h^heeUJn@bTzRfg&TRhT`rb49H*GYAgFEAT zM4r>GAWV|I6{WjT(684(n=YTAd+pV@pLy3jo3*(mW2YmoR)xVndhx1VohA4)pDxS(#lO;(F|n{ zO5OJO@*v2!ulU{hOU7OqjemRk(`G%@xk?T^)j99GJUaT@1|k)^BL#BNm0(;E-vT}o zAZd!WQTThAO$mpXEkKP#+@GbhA+pe^h;^2MT?}@+PcSTHX?<+nOxpMSb8-L=^}32o zR6F!Cd2%apJ9-VnAfbs%!2Euuf4vLqmd~4YQj96mhUFGS zOwa8`ackN#H?(s$)5V$UdHRG!U5lvT`*DW{@H2UUF|UX z4E!|KjXQyYa);I|gA>0k2?mxt%(hp`t~@94qgBf+6xCt3P#D*ak=um})(Rr{A_ zg*D4;=S&mSvP{zHMi7ZvFT5LA41lMAea=p|nU=13o$(`I4ysAy%Grlm;TBnWSE33h z7u3;!^B^g|09xz}3?XxFs=I?+^87LeTdgayc3JkhR*j^9Hb~y@c+}2=$0=0NdvvFQ zKyeps@$6c=E#GX;VDDsDm(L>D!r7D?>kwj2vk23>fZJV_V|GH=PLQtGlZvmh2MoYK z!_)Mw}e>EGx`CBWE>4PKt={X4*snaP%N@ zK|0&(RJ*us*8LN@322K9y2h*=x~4B(2PEE#XzqbTDyB(HmQLZgq|}G#9mK~H9HDs7 zMO^@&OX$(|w#toVHh(*uZ@UFXdXJtbT^!n8e_uEUT9(ON*G;#3<|nGSqxsA>_Zs-U zh}w4q3RE^bZmjVr#g2y6W#xGG`3AvEF3xa5{z~cV~So(Pdv# z8cpSy1vJ{TrV=av5N9csxLRkqnb?+wS~BqQcGF!Z312QZcaTzXsb_ZAxB_r2u+bI1 zw~^^|0qd;p;Qi-j-E&98{7{FWkrAUlAJ;w@G&(Hi(B@{G$b{v68z{vJnU!P|=*JJUq zO0KW$0T%T8;Pp;`nzG*7`OE9gb?-7K(Ii~`sd%;G(12|p35)i&Bcmp92tts2*PE{z zQ^A)5etCK>rLu`nSK^Hv{* zKvWyM=VObX;bIx;UENN+p|BIav`Ht=@C?f!v&(&v9>M(WbZT-buMk26;=Ox*s=_$m{k4DK=RrhjVR}8B`VUf}xj&o{Wh`vv~0*SC!hu__dw8 zDt(pYe?;1`?9c(;4F*LmF0-+JZ*^Mx@umzE6}Ic8M%f5D*54N4dzWP#m)tU>P|mpg zF76yS#0CKcEU)uBe*eP^i?5eeM~sYJZo}?7WjVSEYw&3FDt!thp@`41f_+=UjY4Jd zP(6x{QArTZ{h6v1f8@AiBD1&ILK<3~!yvBP$1vin|n9?j|O zNlFDPnNvt3xonz5AHHQn73#-e16A#Wm3UihI1l%<{k)}Wp<_&@@-!q`SW=hj zT^w|O0cmgES(%uEMcp$jGj&;4rRg`;?@0u=L&KQ!h30O-P;T2?b8yH+Xh=n&h*2p| zzpJa(G&OL?dmX-Bx+VgMu>vdXK{Mb>hi>EO0MKf866?`Ygfo5$j*v3ZE~LWu;+R!n z)3E+%m5QQ3z6kb6YbpxJfsG>UQIu%Bq7=bYxbvxx&Ob!3^U0(go>)YjGT)CLKM)UOHc-!kZ0|}!N*v`Vi-q}+Cs7Ewv3leZ-k-0d zeY-+H%+H-zZ(C`o*s7LqIb|-r3%c5^PQK;z7{4C9fr0(DRFs5`*iW}t32h#-&(!yT zzX!iX+9jpqbf>%_iF zg4$PHsm8jwqxi71tFY@1UXNz7>cYxmT&hl-qzXe{4lWrJDVTj_@H0v-wL5ovvCBaz z=`@W|xEG4nJYD`-saaVoPr0a7>UyPMisLBp6?DLD0-pa#K`s zibr!^FSPw|PF}+&Q3VhDctO%qV(VaWJjnL#yZFjaCs4)V+j_hC*S7f*CQBIGf<*m0o?_%&k9R%Mw-nv+<* zce#n^*0eD$WDY>{`0Ew%F2tWDu!OItA!5s=qux4p%?NiJZC!5BEbb0nonaXnd*Po< z`6PtvRO-<_d;79D(&xTjlCJA|0BfBU*g2?JZ(U6FLz?be)aY?6^uOIuX=HC36UulJ zQ{tJn)pU1jb~ZCk4YNsM8hc|hhNipfY6~i--4?r=tg>)9-Tk>maEw5p0#U0S+>j#1 zr>t|msZO)ErJ??ahj=@R(6@yQsf z=+uF>D^`y%FNxOS-=COYrM0|O%c}-J)=e%z95kHj$8E$nE&w8K9%9!Y)@%K&h zF0ls$+Mb-dWf#+155pz^Uv013IJxHpa2{avOFxrTr z@etscUz6sgpQ?S!SGEf}1Mi=&z0Uwl-a+N$;o6}xW^3n_&PQhgKPmr5x*m#hq4FmNqPFO~LYe zy^Fud9`*c2=c~r|4W zNHmz1t%@2rQp7;l(y60`|S^{X;b~n*oE-gBXfp^xI(+8*22j_p7Q&F-V z;qb#{N0&)&Zu8|HwR)Yu!Jw^`DwScolUH^2&3so^v2u!B(@=SJ9q5>(xWZYdP9SO_ zvJVugY!j&d&Zj3F?!4cUncA18*^|xgzrT}4? zANj^xP@PUt)q3hF&+2$WLN)hqmIZeunslEr8U~T+Y9)?$2KWnei?!O?Ox&BwZ}iIw zyl|C9B-d(#NC~mIM^8yGNMdHjEtMByB4G}(o7cr~KdKU70%i-qJhT_M`)(tN$v}CJ z@3Cv-<$$VHw85KfUi3D|kbMSqqd*=(9q#pmPi*&5joiHW-cO4RyAi*@h)zylUU-ko zX`x?k$lFyoh?}%SM(_k@+PykN%^;q0^u6>yv%zeE-aG*N;6BZO<+S|14!NKPcuh_) ziPRhT;A0_&uv69OFU`vpS$%WRU>Z&Rh}JG-*MoGpcT4wzedeIz26f}sC>BiMJkzJm zgSiH8Raw|a%~{=uGmHKOq~4PRG(pIs+DG-o?sAmMA~^o167t!uxyok_Nto=ud?o6n zJogqHsKCIX*D*U(c(gzI9=jB;sl`^K@LBLC=@5#zzxg3b>HNd`l&BjWdQ^nDb4F^s0R;P&Pp#DlP@! zj&$G*x0mMy*TarIm{R=MS%^q$Q<^x0(=-}V=X*E$YN7R%!N!@j5e2t(?N) z%6j0@z7mz7oV`ivx^g7)J2lB1uqK(NsN1a<)ca-o>w%}K&i!4awCzxG56nTz+VvW1 zO$lG>?}&ytW^Wd>WGGM4Qr>>aHsm@3R-9I67QA!3KINhh`tje@5T^2DFg!N#&T?Hu z|HwNkViJd2y@nUGBC0o1 z{u64qZJU<5AhHh9)neA0nNufmA})jGNqd1|pV$_7w?K{H z-0PMNAN4na#+BegaT=GK)(L!N~p|36#VpoRp+uA+yVE&d+u zu*=6~Vspb`K@x!mrv1#%9dbKXGDhzZ>h+YjG(vdK1KO%I{|oSvtaxdL+;yA^PNsZ6 zl@D4IYccb}mSQy!75Y0>mwtoi3ZlgY(@?1Vm| z`1t;>LZ(vQrfQu#WW8>|Otpi4}n-6!F~eTi`#Rmp|o@-*u1QU9jx zZ}+J`9lri&k~Rg}VnmN-Cy(3+Y~6swKB0KLSDxd5+{mPp_1=_ObE0^hxESQQ|Bf^b zUnw#Wj}v(J{VJhx*x%BtZTpIZGE--95xA7Hbdf7`ymv7jNuq1XEHRjSoibdQVxNN<(Z}WkattHPDO>w#V;38<9dr!aOvt;FDbRj#58DaWr^sf0)ft_Z`7xJi17 z!hBt33W{_v?!k^8{6~w_v+lgp%On&ILGhymX-z>vg`GI6MYu!$LvNWD_nP$Qf7iwD z70&?CQJyXm1A4Ny=B6p4~rCsIrg zlKTOE>m4PvPNeuK*RR`plHxIR-81Y`u{uOyWu;@qOYVCki=z1Fme!w+mE^VczX!`P znf#sPhY23Cf1nK{c`f?WHtt8a`hSZ}DxCeFrG$c_^-pWFKTF2P>^}{rVck}N35NnM z=_g<`m`K%t7*89Df3}`3cD4y0`Sa2LJ|R>{@!v7I#(LntlW@@a(;}0?%;Jwd6I|$j z$G?}9kK_iJ|NaaoVJYlTdZT>HZdMkOuVM<3Fp1nf3oN zD*p|}IbDkXj(;ynzdL!t(*$!a0xyuv`P~1^KdC_{#lOd-8G{G(|Mc46pnvrHYH0zpD!wrtO|ZYej(Bb=^UJ(=j%uYT4V9emxYP$bHlYf%&W59; zi^(a_`Ut(>U`)*aj3-85;cyK83%Ne}n^N>=JAzuM2IiLAOztY}+--mOJ@P17OJiaj zphs}3*tXnvor8?^0xg(lVj(<9SCaK3=Hdss8PV=U6HjZ5wntk?tmjJ}&BDR54+}~C zIL+{+R_)J>!Cb@6$aR4xgnse@X^AJ*T7z(5xhRKt`37pkThPJra)FILF}Z0lv(4^Z zJt&6nKg(Trn9qJ4K!0kpgI}(ira2qM7+juRy@kqsSQ*Nd973)RlQuR?)=L_zwF>(W zH?JZia$|b^Gd03-VfL}$grdG4?pav0`BCeZoK>du)Hc;!uoTN0<+AVI+Pn8J@u2tz zXxw{sB}{cbocH^Ou3RVYm(;VZhU;Yj?lfF%wZ|GwQ9ldk`mh_h;;*lBJZ>V=p{I5( z>4{ZfOqjZqK)97$RdDj$|F|wXO$>AGKkU)>@8uj0`BZ{deH0H5}Th?FZo{2?B zKUek#0+(PodFbI0V)`4+EvhJ|=kR>h2ZweC2A~eIr?l)2;f;jgZ!83`J2UHlqVCP) z4}9qD=8cfbL}dyn1(&|-${Ad4y54$kIDIg~QX^w>JM&g9=q5$9Bl2Zo@_q*u+AnYu zvk7bYkZ)SdS3)Ott1wk?IdZoC_FbJL)4sJ!%n*9ZpSknz`OGHLo3`a>u5ZyDl_flj zvU!O^Yf4ke5uWjf7FidNxt6~}kQ`&+h>eEz%gi&Nxsyf2z9O}aZv-(@>Ni`mt!TDQ z3?1)3hMq-dkg2m|4o0&!renL2H2L|lN6|4GNA4={d;fQ$uuioMxe|2HEhQb=RcV7B z*%lGIDlHy|?!<9dXtL<_|zW-yYIVny#WA7vVXKNC^u%_SYE z@ILj+a;yFO?W-T{EzIr2q9WK^Oo`JTQ~mw|P15reME@l+WIy%p4lJ*JY4E^Eyghfnkg z7D5{z?Rq--8i(xPnxd2mS`!GwmotAD=MzFhVA#OIi{yLYrb%W$o_vclSx_!oQ+m)a z6OlKpv-2Qr4(sAL+A$uV`^ljoWPDz>nEiy6W}-*t_{5LT18i~bOE2e&J&VwO_6)Dv z_riEwl7EjE{q)Hwv2Z=S3FZfycUSu~X(+6pWW+5TIg=G|kTjr(sNj(8K8W@yci{Ow`=)#4sZ`}cTR4Emy7#AHbdQ&#Y6}@0E@Is`T zA|Mw>2SW$ULR2j8^X^nnJg@%ww!FsOuTE5)yGhJP52V%JMKm0BMC z>NA|Hdjf5X)F*4WJmX)gC<&^0w15YbPHGZtQe`I1vAA>s>`&HzXFRj+Gjn#!91t-M z?|siJ(B$;~T!_(9IJI&UV*LI@5Ix=_9TCA^g+=z@$2z;!G0(Gjn_vC;^bfD8aP&u0 z4EAG~0N$#UDmaJB=yVZE5wogsMcO!e+xKh!n?l(LdreMlXTtKysCre>*^@UoUQx6~ zCYw(8?(l>g+-L|tY9q}UY$&jEou(_|dY|;fJ1?k6{rq?9?VR6uC~Q- zWC!MQ=5hYNMXHcJ$2b{Jpt4J6V3?`nKmPksC-05W*&983`EDg$X|frvcG?cjotLJljp0$e1m?$DCVFQ*HPdHP zi`PmsC!^1#Zf@kYkZ+$|dwo(qEpiiKG zb|LejC*qgY?gPy*5|>R@;#ZXtLOMd7t^;P3^r6#9s0@;`!1g`1GW6TSOaKr8~Y z@v41QVcpAP9v^*tZ_je$B`)r!ds}VWbr$DvERVgs*zs(66TZ#6kI?T@CjZoDAXgE& zJ*9>5Xt^7X36hsC{%#ipl`x!avo=!;qBJ$D-crzDRMRIyhifS8WG5BX+^5->Mcpu)i*5MKL>Nx?dCR~ubNPe4zr*k$*y-uYnOrp~ z>G6ag2dn;#qO5Nzi9Yy*3p3FHa;@0$(#^q;Ek5hg1U>8O@J;`TZhB6{qml9F7dP43lB zPGylj!$|Eix(~v`&p0_0col(1FZ-vx2|4(LFXhIW@H>0G*K|-W#$G_TEcs6u*!_DR zu=69LNCq_xM?RqjU6r_tZKn2gC${VOEW6R-I`i(r5CG2B`Lr0gm3HOOu6Uo(#tck}E+DnX#ltbR0}-Ob&+eY7_$9=3H|UG3DS6Ct zG!)*M%wN^*kT4zGt`eG>eO$Iv|NRr{t~lA4Gka*OJPomtpiDZqS@EK6iK@*Zg`K(% zlS+N~DR**&C-oT>C&~}E{N!xU|JB~L$3va2ab?xnO**ZZI!GynhS|{Oawv+;WnE{| z#E@!?Oh#d52vh0Ex}@y7-=%%FJ{L3`+48@_dMU{`+cA1(EuHNlDjEDtQr3WBdos6e+00N! zl+R33^CtV1dJMkLG#I1!b3zx=ZobJcw(tq5EA4?0yUSTzV0)1Un1!%>65sG!ACRU_ zx)J#giFr|BC=HkAlY8m%M->Wwhv592-_WGeSK#WK9E79kC*VWJPqOrWgt<)|5&0?z z-*&}cpv0xvg`#fnDvRbd#Si5ysvRxZ!F18O;5hd2EF%PWitTD$a_r8%nW`N{!d>_a z%mOJKLKVW&*H$!tgz#SkNP9C?PS37y3CpOIx3_~C&X824@uCeQp?3q5UwtHw?Va!5 z{K7vupz(yZi*WSwV8X|@u@?HcMJSNzW^&!rV~{wr&=7 z)lZ%Sy-(flkc)$`g_>RUfU96Qz?(wSxryQ<@TA&m4y zxx%A7WGE!crtXPWx%H(P`HpTqchqHVZa1u=tpe%jdh3~Rw-wsQ<%${YeQs%f_2LW{ zQ&ip*62RLdVMw6=%+wizlFZCYQ*i~uY?3cEh`H_L{1dLib-$?Ohk=aA@!3x`3ksk% z&3fcS2f(h7sc((e_5QtA=V6cotNk%%hBh>~<%G5}qi5Zt&8}2p6x;BVqw~v7EM@X< zV+J$f@>vPpcmy^QyJ+ibUr9s?x!Or;xjnf68}2LlGQM9g{aj?_W`KZhH-Eb&!vG`! z1zR<8y0-WvUuaj7Yz7JC#F)Gs0qPhD+XbBnpQGY>g$Da{?g(qBIANEr@gq`=b1d+R zYq46}t87=)xsA`*r&-;qHxGfMEfZJ+#I~r!)nSS4Xrt(cSGS`Di3ubnZSeL(W%zj~PlDtn&Cqhkx2N=eLq z#$*`4mp^$V={6rWO7Oc>S<*|mkqM0|i8?U?WM$|I^7Gf(q|C#IW;|)UjvWe_mg=IJ zvJkfV)YB&Ne)7mAk+|<=f9Zg%hJ|S!qL=>hUsjR{f*d^yoCH#)epJ@03`7h4=RS;C z2)Qa5sio&Q*Iv@$F@#C~GUEP#xF!axGn8%Cf78(zYV<0Jq-$KqN(%VzsZFse>{ycq ze{oKMHRwyqm+uH7d&|}7@L$amd3uV(IOFf$EO}vTJM_qg72>B@kO>lJT*g?BTSt4m zHh`Utx$73bK|E5#pJ+S(e#v{D5G?aSJdT!-4R-dc*Fn8bgugAxNq-2mmzN=C-Tn zV_5jb;WPUm%M<dqn!7RyWRt#f9kZ*9w1v<&*E%1ZqiSBYdi8C; zZd;I(iWAEz?rDNn*Hp!xn3Kd6-4XG^m+*MGQf=|}2mhU2?=#(#v@g2-T2|Q6R=J|~ zQ1!Jv?c-n>v!iA%2GtUSPXA8CXbQUNKkm`U>5ZyN7K75MV8#H;z@nt?qn&bLH(iwF z7e@?&cy9xFZuFH}$F2nyH_=@^dK*$PG^20}5gb5<;^7A*X@iRZE)o{5Ld7|(kt}6_ zoMcHP4$c4F>G(^?4j#RQ^546|GHblr#Zt3q^4&bl!QHc*nKuvM(yhzt?*jR& z8LxmB5rs%k5CK%A+*?X2wIjcVRdU;ciFueh+9=2l6=1d8MYa#uNb{|6Tm^FMYutwB zsejc3oERT8=o=Eu^c!5!FMkx-M8EJ zSU#qX>1yP=&+vdRIF`UnOCp?xS}?A{ODIqh6ku5MvaHTl`_L6^7UDwKn##cP#au`-DI;FC*ll*1yqg*hF)XZX zmqcEK6%=0qAXTx)tErU_>)>G*0hCl-l+f8CF$A1%WK8E9qZCW?n`$@-7$ zT`f0HpjkRFnn>jY{Z_pe~$1HnN7us*~ew3&$qcBu5v~h%_)JJ&c+bIO-JN9HVZE|gmfF0 zYw~@pL1u8KaMykSi%Ll#a9Z#+!j)S1II?t4pRW<7auan?PGkZyXEk{Tv}f>|USWt0 zc=@uwD0&IJP-!vP!WLuc5H#1}Q`y#lq~JPp4bizO2RJjgq}8$Kn`Og&9zPQBYOi^X zuA!)AP%xa9@6_Ta3udAdhIwT;%|7i0?uuZBK+8#ecPCmgS9RWN;Ft;LeyFRxndriA zh_dHU9Uv))2?jO;DkZs2hvznQ{W$Fj3X5if$8y#fiZKBs=ouW(5fyNWvw*ApgVm;` zQ-aZ)svM7$Y{Ia?{Xr#My2DYy=Vt{U?5dJ3Y^p48*Abz-YvNQ=7h4futzH2l_{UFK zXyuU%6%S})4?ij&ZPURBxo1i00+CuI7Yn}w?=P<3m9b>^g_j;DGVq-1CH?9C>Q6yR z&C9PzXNA#4YHzxT=%urNu=kN!j6A;hQ*<6?!KEbBf%(JRm;6{E+eBne1tl+LChr#y z8#}%S6SGFj@9l9WHF&gA?s@M-vvNiEG^`AeJ7SqGxV<{Bi5OutJiaCJ%lLhPdNIn0Q25#}ZJdQb}V4@Yq5^ z1h91AdHQ1sq-URC;y6Ah`KwI{+I`^`m=J?Ce`0d$p$S z>^%O1jKs053LHzgtNHSO`u*18PkSU>ivL&8?mXc^k=Y>!eeMw_5r@Wy{BG((`Evi0 zY6@7CbzA~ezEz&!i%9i9CRi!$2Nqpc)`b2=Q2HX7|5=6mtA;0WJZrkxpEWh==q5?L z1svD9@&$Mci5ru8w$aynO|^rJ2~aNcF#SS1l(f`VUs$hQj5Neu;s)fTI#st8O2!#= z7V1|>JxJ6ppg}_CC+_4Y_tkfV;XpnD8te&Sl_&YEo74aiQcq!Efc}|sMX9IHx(31b zvzX{g5Ch6c1?JLFu>gTWn)$8H7A;$;0%p4F1-fRQ{mBfSE>ghUGiQIY!fQM=3f7#+wQ&UJD9^EPMJOZ&h)Y^xApgU|qzIyV6v{ z*LN}Qk&x8VNW=Jw?c8^yG5DKO5)I1a)G87h#IQMtYMx(1YYLtt2EWcJnL`);xXqF@ zz1inKjy2{B`hU?~0()h(MMpuYcyHbg(Qh?=t9j0q^^H9ek&!r^}m9$pAfp zpP0mRv^<`jWZe%<*;K&N=xPj+?QAqa`A4(D61X%j)+&bhaP*`ittsx~23az#rCNG| z1Ezpi!paN8Tf1=&6h&L*BE`uDunrNZk_UPZ14Z&ySoqHLXE#V3o(cmO6|=zhu&cp3 zi~PPK#-go%J$MXU5b)bDFbCWR7l(mkRJGos&+0oBQ$S~Bi*S(?nAN z-An)q4)PJ=Dkii^`q2fSsl&Dzy3U#+?~7mRo3Y8i0dj?S>I zBxI5VvZX7EjEv-V_C}?4h{U&n<0w+MVWSGE!f@cE9Y~T#_>0rZaDlP%2T10j^g#*Q z#d%)IbOopj6Q3JOe;u#<@0}oKsrbA&UbbOciOr9#QUjbZ^c8X1bDZ|2c;*B`jdXv~ zOVM~f4ziM$^RokkE$zUjankpJe~jB!7)kBGQRB}Na2d^$wzS!M7FJbVzekFYoR4F;6xz~ zQJvCd@&xCkP)#x}_OSUiy^MrBV_tQxel}#S-V2BzkBw;y;V0 zrPz0-%P8LS0PUkay|M?2dF%2raL|Ij!iS$sc=8q*+7=o|t#0sZ>j*UA!&_u5HZA;( zEZoREk7)^dp^YcHYDHw?Y`ax1bfdiM->PeSdT*$^@jG~73yW{}T)216{)V`mb=f<_ zgPks336*#@b!`GvCFMW5D9sekOCTV9DO?x&hlA%*S3Yauy+xcLr1>6^tV~aiNCycy z^E^)!G&ur!Ht5)aCwn}TIMg*9*9O}QM=2$`Bpb4EKAi%<=_oe^{5e38_@RxGKcQ66 z@D6Nh<1-&MjTffcQL0y?B|10#CEJ2GY*_7e5oB-%2$wB)@Q~-k{ zrk)gsr(WobTi;)*NOcD4AmRn=PwbOr-{=_*1P~MV!(Z2=IstTi; zah9*|>O*cPBeO>e&{Bf}wQ&TylmKEkZer*pJ(G|14m1><_@O`@h9BifbtW_GdLA3F zcCoe6mGl&Zvifm6*d9vONn$mc9t`h<2F&a9<4q8R*cOrh6i*7VhNikdNL3*!@G|6S zzL_%>%8I9hP4LL02)3etB6&=I@e>N3i;tinuU~y+hcG{aY*Zu{Qu6iXMHY5b_P&IB zDwhwl8$*&**q4X+4sIvxx#gm*39_JP?Kyai*h#kFXVBwb&U6TSZM&(|F8WC zL{+EOqWWHEEy}PTd7Uxa>1DO@A*Th*ZtYFlfd>bi^;h-(a?9_>knJ)Vfocz3y?#2ol6P=UZn;LE#)rtY8z zS-%@K0O_0Ar}+U*78L&Jop|pP$&Q1nHP4CC2HZYDRsp#Qd0~=&Oo~&ywH}3Dj8She zKf#~4L-fWX-)XD1?^W>UzqlGBJ^`u_CpDl(IB%vov1!G%;=yCRuqK+~+jt)YPW17# z5W)DxAb0s>@^F7!0EU<5zGZSD2Q*FM{a3^UPas&w{`CA*pq9*xazreK)jI+(76~Ql z$mC>|GTG*(XOB?Ww{XhvsgsU7anS##$XU)feb{bhUG76Wv-I z=V07wI813;F-c#G57ZWC8nXH7cYOGA{Gu`Kr)`oPlQ&9%@Yt$uxTR2^=zi|wUBP8< zqmOz9;Too-ZUttL?Cj0(`_Fl4m(9M;4}3z>u5aYrI-LKgjHho)LkcfH9J>@*vMERN zfWbRm+zsCA^;*4Uyy%DY(MN$XQk-?anKPL*1`Hr9Irp?rN)$J%>O+4i3si@6cJW-C zg&pJW-G070lI4UMFFKcp(!|4 zL}D7%db80kiJ9oBJwsVOb*9LO7MonTpdE9?-x!5oiNlT|#&)rXDGPleBRBKc-GK)A z@pa;iJ)M)(?aQjLjMJf07l432q_n|?2S54!ctcVYtp@;5j^{vrz>Z~L;gJx@o3Mu<=sQSz<*3GeF? zh+k^Q3&1NpeT&u7vE=0{eGFYEm@;(aaNdJg`tzj zRj~zAn5d_Auc4y_R$qMgDzfHMBAcv$7nsoHz4(~-*U9Fd-JhEOM2d6Z1ajuKwF;+U zY|O5mYBW_SaOqc*XsWRuTWS8$JEtu_z${w;21WQ`(a06`&_R&_$jr#f<3Zd&ULx73 zQPHhL!D~oShwVE4g{-5tXD5oK36>p_SpQg7d}R@(#f~s)x&3&C@D}ec7H%bl7uXUatU%1l`=CEDjePkvC}QC{ z9fO4nD23|~F-7=LUknkIpR52mtkcniK^!9grGhj|AyR=bC~^cUPdk>}vx=0a<;o+d zSB#~AL{BV7ejHBYQ8oExHjUX2Qpay^2OsK1ntrBF?8Nhd6R*W}NU(f8iV+m64~a&) zf~7cUmR+p)lP3}fJH9C{g!!a^M+s{KMkc+vT`xuy6elu87y~L>1U1Jo z$;mqO))|Z(nB}(ra)SWjI1jtsBAGlc$u^CfTc;y9nxG+m<1v&uf}sK(~p0J(}vEi$lzZU?>iamxbGDu)Nj>b(}Y&VJ25E%Y58TjUT|FB zF%)y>+fR;@UyF^gvB==}KUoKnb+7K-_}IG-H&}C?N%VG(3OROu=C@HqrlA_FHEI0h z=|`hA+w2E-cJ_vHSEp3}=>Pg!adCx7@^(Im_ZXJ(6R^X%9t3k+nd z0;H?L)mYv0iJ76mwRaTPQ!%^$3V1_rsn!}V=Z@Q7YZeX4Qx2<5im+~yvlT?&IURoY z^XvSM2{L(+8!tNy6U7y!e!ON0xmTQzNn+*Ziou&2 zEetbM`^s^a3|OV}BR;8`Yi2~dF>Zw7^e#X6%kBsviNY^Cx5k2HgY2)bw%7AI2&UHj zATj;_vAUYVdz^~ar zGN8{{`u4uWo<}%UDPfL6b@&0G{Y86}Gm5jP2RH9>-0YkDFZ)=L{Im3)a1_8jbk5q^ zW@3x5Zgw8E3$7$IX==_Pv6JBUABhfKc&iVzTqVu7t>Tp+oJPl)%U;2aeGa{Sp0e#f zxFE+YF6(T@&iKDCa9m9Fo3hKRl<6`H(zxu zh5t^A8Uj~QUB~~At^3dY+`s@*&or0M0sFdpql8)4E&^-suFK>b*f9v}srT2fjF4Q9 znq!eDSfZjh=rT%j@(TiS}k%Gzr3q z*RY{qQ(@-Uk-?{rKRyYS5o%0SsLe!`X8z7|AuXjWxkM;2D_=_#gsLeV2r`#xS#q{M z=9XdMgCD`30*O*dZ@cMxMQwH!4&g!Vcr}_)s34x^r8LTQ0aB#2>-&rsM-bJLMBeU1 zahZYbtTK?U3^#`*^jw0v{%jm+pc_NVIql{a$5?At!Pg{xIY=2B#MzN%Cp0))dce6AVVcPdsC|4LSxf8l)8dq1OxFDoEf~sCa zVCSbHJT|<{=4|$lT4On@a`G2{cBMvY5E@+XfkSxF2g%646zk+>9H;RNgC`7Jc})~s zrAHm)OJmL;zZ4L3Zsf8d5nx1gZL@@P#@Eo*ngNFfFtL89jfAuF2x6#UPfvj4`fTzc;Lz0kP35MU_%Kf#H9 z6FXo2$xCqhyFO-4E5W!FZnFV-I_rE~t{k4K!!zTE-j_5Us8uLXDvU`bp=9#d%EJO#B_B!hrupgcTz13vD`2gR-|XlR`6iXuKFr6RU)LaIcC?zm z{H?_l7mY1S^9fAd#P}3MinmI+ng$(kxb7D`8BRX@aB$%0Z~<{d$b9R4VvwK*p*liO zeB2kL-9zwQhOg>X965CVb1^x@Q|jVXI%0P@AEWLrxKJ&9vC+2_Op9zEf_WYwq`*n? zUIEFw9%xA$w0=S24y1Oi7vI3n4$Tm7_suWzR7EJa8Ogx*&6$h{tJ(&QwIvdgvhTl1 z4_hMu7W+dFl}rv^*t?^>`=bH$zSw3za9to1Osf55xNB$cH?Qc}zr;a3_FEn-J7%r< zSDbmC5zB;ZPmVxV=hY{ivjwu~%Azj^MtR;0!PqrDU`qiXB@l#LnK^ND^d1~K@&Mkt z7ou3ZDN4v=wP)KP8Im}U6#$VXPwhRa1k>rwd-3H7%5^BtXE7!$^og{0o&Yq@3*eic z^X1RXSWZJ$X)nXTonaoP6OQco(Gf-JLrH?3s46W+v>xwo^WOc>zI_Q=qA36N4-Y8p z75~k&JJWxOl9OO@a6I7#crX+=em!x*^=^!iYA3iB!xosb0>bwElIO^~JjbhU zUkkdX;L~2g^LXxH*i+PmJ{GdudT3`K-3yrr&Tb7ke*Egzi5Foz{$EP}UnUW=__OfV zrhoThCsC4kX|7#`Hfwvf-b}fsDt8YB>9IY-n)rHl(A{UF`N>zscE8m_(3)MGkM!z& za0v}8%_Qp7c%VBe=22ptH7sj0jP1VeK-;h5a!%@Hq`$AR$Z@rh!-%toC_EoBw^voC zbxK3$&TzM-Zn{(|+}?DQo5lirh9Mo{l>0s%hNVVN8>19(gkCl8~ghjrGdEZL_-h0;jQ^i%5!HFcCuk~j+b9G6} zWS;$SAVYjf0zcPr2%_Qzx)aZpx_z(l_0R8hbgenHu{b9{yV|DaM|~{_{ucLj+TM9C z(mN=h-QtUU9r(azlRwIUTDLI4(S?Vp(~_vi*1h!1*y9<_ z*WTIWeGarAz95o+39#AnA2qF>7;~O=H1L5m*bhfB<|x1h58eaoM8Jmv46$P0deT0z z^arMT#I#dhL~BN?8p<<)Fr87&r)mklzuQ)mjmAOW5X{m9<*k!sqyP`|vjBGh!lqe? zQ=e}+6SMQgy)i;)Im*JthR5WJSsW8eREMzQ)Q7@^;ayEgbR9pFOg~{rKiWZVxq!m! zv6+rp_pJPihK^oTHv4*16XYS>Bs`cSuq-tvF0wK}^llcS#%T&eh79yd;`a539sPe5~@_7@Ptgd_zT{elR*8P_Qh-sI9#N9XKyB0 zSTP0Pz;Qd*fmWkEvVN|Lxt9whyaxB>h@y9N$bv9}U}t>Z9O;=5?}$G>`>UcaPhU2V zv^OfDdCT4&)^l>i>6It5gS%r?x0Z@;|6_O5Ba(HpvS{oQe;#sd4|!X4m95P2vp-TIyD0lV?av>@w_FOn|IzD61 zH)NIMUVLm`-jc~?^jnSd*lStg1#)t`)8DZQrBL^uL<%_qC$5z}N*u4|IrO)6Eb;~~ z{?dkn{_zMjgN|j3wI-cL`WCFKu*xMS?xa9gkDq}pS;raTN6}YZK7ChnfSrLS?I|4| zb~n7w8>;uc_|spxkX3o4ziQ*TDNR;L3w^W!O6yrU+IKj-1WbY6l*EPnimXh#`z|Z7 zXoTm4O;^LDb>sSLCt*%|9;r*nT0j=xZ)#mE$thzV3^jIr)&6t!* zN?IuWv5koX3hiWQw}m(~;Eg0T^2Pou;0m5Fmz~^T;*56r58Jf8WFt%PoBFc)m*!>%+-m8aRl( zxf8?6hUZmjJl4sreB5J>#1af^y6*8L8KC zUiFwP`ng@uJpte(PwVY}-h51K&{gS`l>m`wUe-S3*kPi91laLk%|G6tD&!ZxvY8C= z&sEK)#vqJcXQ)$8zp5CvrmJwHe#WY+>+_#yMW2U`o^3(CRd@U;EED; z$Fpj;xxx>*4i5z$McWfnGzd0Im+XB$)pL5oewv?-zNGFrR4tvqFfEyd(RbTJEqZXm z!TCTg>u~6}s)Ro3uq6YTm|MxZ#drCyw;oHsS;Sf>)k74VR33rl52qID^ zqhGcVbDwl$e|(2bfazL%2Cd}?t!$SMe$Uelv)&+Y@q}W#chYk|NK$ht5mS4lm(&z~ z=IuxvJb6l{N<=mq8L4h>@~j3(jjXtM(fZm~ZMjCL$X@H33sfhC^H`^B+NR@~!5h~% zcxSrGDIW;C9^~DMJ4On@s|s-wx2Fl{%1HQY@9OnB%x<~`Cd|GE|HS1>_>*ne@D{ii z<~vRne)Yfc{?!8wJ74}(rnNP*F|Sh~eSP3uR(8_%l#w%Eo_tK=Q7wI6?Y}_-55gwN zxm$t;C+DUT8NaiO&+Y=W2ev&FEU(i-jv`La&j@(jhb)3@5>T&{bP=k)mFUy_?nL^X z(o#OhABdwH`$3-mY7%l60%?SgkHa#Q==N5Jg_(WZy2GTOG}C#GK>Q56ko0Ff$fL!} z#Em)V7E{KGp4C8CpJ>@bygNdNu$X#^Ci*e4y8b?b>MQAj<2ukLd{D_#AYTffukWgZ z=ehCGkBdQhLikZ%`H8yTYPspi?Z7DbL%ucr>*{R&;}*}!vbq9AJq&pMhQR)Y15D*v zMCW&7Qq1y?q_IUykQYVj5at%e%|I_x6i6-3(B%uMlN$Osw&u(8`|o40oAOMLn?JzX zQ_K2dcv2~(SDtEm&$2e~D%SVOEz1Z-Pqc#Xk^m5O)v=A+2IUfAqIb#btb4az0Ep?8 z%u`cY64Y@!;%;YuBC#Yx{iLS;> z%5M@23#Y+Z0b0H2L}%=hLDKG@mi6La3pC5wYSYo*-<*T)dc1LDXDnXL)>5GNObp+(6vy^qE9K*4kZ zVFHaEf2SM5nnqLQ0=^xtC7-%${gKa&?vB+hBNJidhPedcgc0U3{vN*hp0MF!@tw-r?z~KR~>Mmx1w{ z+sl%y=8FI+*&&fPuxQID>_=ldB7g9J@CUT5#rrqdUT3(x=`x-VXTf^V_(-Fwp^6M^99{Vc zBI-T9Pf0V;!koZ~KL<}V4et&Jo)OYSP3EQE_Bb|r)NI|Irs_4mzTICs zTK14u2UgMnj{gP40}<@9X(#!vnBfgSFh*odVnP7_TMp|QU8jbWZsB#cv7%^`BEI=?&PR1 zI4J9Dr>n2SNFFo%Om8lNE+miQR9(PYmyqmcS`i;to*-Su=rLu8H+l-?7aiIUq{uVB zZl~TXHks)|wfXCw5Qs1A=L*6vdpG4;7r5XaBZAy)9%yCy@xe(;A7$uM&^^B+{UAhrNW#O6;Hmq{){g!EhKsWsC96M zFJC}TgX=h1tB~LFw8hXKbL`>bP)_-v8q@1 z8sR%cd?(_ulH)gZ-I3;ui7W-oc9t>~tDTvhl{vo~XcB<+w*n{eL^<$11i*8-reenf zT$6?=%e7E%uUqXQat+q02-5+NN*^#dw4eQnPna$Hu^a`8PC z8h_moGeH-gK8=zT;*C#v$~UGYoL=Rj-f{gUy5iyq!-`b(;+wEQlkN+;DytEXECYpZ zwj*0fjXxoMEWUilqk5Rc7%<;<2Z?<0EP{O68=XtGjvJ!Oy=**Z2>f_+-7<(vJ{8x4 zj%2|eF8!6Wxn^%*Pvh3BN1Jgiq^U?l;54}4^~}ZT^npU0F!NhFoR zDv-JriOaR{Bl2lH(2zKK2=IzakvK;DLa&^f{cUo&^I{q~tn}8M&nSR$kfH1kGEK%4 zF@L7aX)f=^=*{x@uZ}=-&zxMrYWLT~x@X8|X;0(lKFD2&PE$67<_uOUeK(?>FAU@m zxw@=jO2siUw*{{JWWc%h?I4Hb(V2I2=6fNC5CS$x}wgz)AJ(18)#}xB|l#%d*g_`xgxKDY_C;Fm-J{dyhdTC&BQf# zQpWapB<)Q*diyX@|Cg)QX}0~ci0V^Mw4XCxd@)uw8gmx`@D9><@L_m z+1|63pIYBlyLMieU-_5FgQ>?)H+~610_F=PYJ zMjS8#Pnm&o4KCMrieq*77<^8MUPWS@EpO-}r5df5Md|V}yrJ_U-%0Kbk+S~eA}bRK zyQs4K*%WwwFKYnFEq!< ztHBfJl=?l^TI9#%SApK}pYpGd#!(}m4n}VU(5CcU0bN8^fW*Y*4GqQFz%Snr*8DYW zbNMq)t_ce@?Ye?p!5B1+-L6}pqhwCrp-)%Zdt|<*U4!_1H!U`k7{~KIk>_}FX68YK zSIcKWAse=aX7Kuj{jvusC8WNF%6{VXI<$h)ziv6r#|d2ul!`7pkUXabUIX12a{^;> zW&-Gs#Mzpl(sA$>xE0bzx9w$)i?QU}*CaS!E`K66VQKRXYw|E8fHwYa?=(qQmMJEY zB&cf*P`ahfuTQsvgvY_|t+01EEY=06O;GMa0W;uYI#_K+Z(v+UgdFU)C zriNGX{rVHUqO?nGxxVPV&uc?z*Ee^I+U1e9N|@?kiaazYPGtxEk1}SoOs{gU5viR4 zJ*)Zn{ycj=HEq0~PBj^s!ReX@)@pWlK$V@3hoPRE#CzoElg}GeeWt+Ls)lFrtuu-f zYIBonpyRg#$B>-H<;A#+wO6VTRwHiNfR>dy<#dB+M3!`O$ZHM!t3oSz+~4|kF`Q0V zAdNfuJ#DvSJE-)v7PrkJd^;tm?5F>%#QMK#uK$XTtiE|n$>(j9m*;W#t$%J2*5

      {{ _('Make sure your Mr Beam is empty.') }}
      - {{ _('Then do a homing cycle so that your Mr Beam knows its current position.') }}
      + {{ _('Then run a homing cycle so your Mr Beam can detect the position of the laser head.') }}
      diff --git a/octoprint_mrbeam/translations/de/LC_MESSAGES/messages.mo b/octoprint_mrbeam/translations/de/LC_MESSAGES/messages.mo index 9cff154eb5d2429ccec3fd803e37a1ced641ead8..1663ff525b97c495a25cefdbaf2978ed24a89f15 100644 GIT binary patch delta 9804 zcmXxpcR-d^|Htuj;a=p(k*VB-3l|`ca)9Op_r}x|1qDekQ4=d~7579*O-0R-=#!hr zjb>$Kj?y$MN9Ld$X^wLBOP}}WKG*NB*E!cbXnG+vWM!T**qEAbQ51<`*PGaNJV2|mLhe0w_Zm}}LdJc2!%{3teXU#Hf&tX`U`6~1r{Duj zz;O?Z8HSf}Fh>1lOcHKF9k1}WF@13&zJ}*eBmCk+V?MwxUJAu2T*KOU4+~=DN5&Mx zs;CBrVhX;7opB@1!p9hf>5uJ*>_pvHh+$KM%U~(2hc&SU7Q#d4H5qs(;M4jbzI?k7%MOZx7>REf9(|1#x`8n4R!w#^v6{gh+FVQ-fvD) z&=BXLhQ7cvV@hL5Ov4}?jVo{hmVRy7R6_<} zK8(jUyx$~JP|LRBd_0Jqu(O}z>v0w;8y;W=Hp%ChckvhoV7vT|Zv=;79qO}DQ@IB# z;Wbo4odS-Tid#`r(y*Xo=J0;gj)I2t3~G-4K?PIQLXIyRrlTHs5)~W&hxsvIVaHU! z!l+;jM26JNLcL%WHpJ~%1b@e}cn>wwg^D=F`vQg16!hR%(1XEP0;5sE7lV3XENbY6 zq8>0DHF9H6Lp}xdq6MzY-Qyp-?m*4`r>N&%F5-Ai7YaAs15JwB9<*|e!2+Bg;hKty z+B8&y7N8ok7}bE)?(r?C`*Kh(+>5pFJSr#)7PIF&7V|p31*1C$Gy>zW3VKlwUWw|_ zMpTP)Q0bNHdc-|{26g{0s36NjKfLW8zw6c?p`P;;73BH6#q9&jp>GOM4+wUThoR=O zIcl!Epn@s^)xfE!24$c|APdXjM)&*y_xusmbI+ija{<*5@853W87dYEm9Rll9!pZM ziyHC>)PsAY9xxpBz;rB!vr$972KC?#sD^Dv#mE8FlpS}^pF%p|HRmYkfqAHOdWLF9 z6@S~Kdf1tIQ*4g2u%2Vg5e#FDAHCq1-5d`t?bxLl)zGLib_xcd_LxB!iT|R`H-FJF z1C;;WC=BGlR&0welyyux_C}@MIn>Y=EN2^51{+ZiLOt*e)JQDDez*oJ<1-A$O646B zk6rO?+=U9lnk<_ec)v-epry6^OOE+Yb)1Y56&>HU`WX(PUi)Pm&GRva`gV-QqLr+@ zP(k+*Du~yj)`QPcG4vy*{Fr*Q>=$SU`xy&K>l~5&^EyFZHFJC8dR4}{R0fgL_C7p zjOqv4bexJ!sn5rk@EEG6d8nR0MdkfVuQ=u#Y>EoL0zo!di=rA57)1W7M_oCf^ov2| z`#?;_L{ysnglgDT)X?24y|VIPr?xDV^Jfy9+e$?y%ZE& zU!tP^du)tXP(xg?x_v+|Y({+$dT<45h!0{Eevf)ir5ZLkgRvL&L8$cHh3eo5R4kl9 zHN^WH1>N`rJy@`&y`To_1+Sql?1VLN5Gv?qU<*8r!T4gZ9mxn(^tVOb7w7s8>cz8A zBbtSbfY)SG&<#1LAwPx7u|+M%w>Mls9j{Z{F+FfOYGL{l^&mEO-_#Vtom5MqHm|QS z2!B8|@ChpDg6cZvb&SWl%Kr@%A~ME(#_OYEB!X<~|E`ehsQ;n^D&tLdDDv zs5HLh+9<@1=v-7bZNb)f47*~iE8*0R0E3FC;xT901ERk0bj*Os38gsw+%@}f9ebIV_c14 z*sg&M$~4qUxC`~7ho~VBXlOeSg<1!?;43%`ci^msSD=J-CxOEk9+dLKt|d?hMoN=4X)jKk{Gr=eEB&8W@p z3+#j!yc8Nxs1<1!mVxN&2_|xUB*x-7_k6P!_Qp0?f}UrhR>0LQSrMu4M?Lt_>vp8t zw6ZbK({&(fAsUWKd+#y|%JXbgH1BuoC(+k))Ck={Z9@L7?F&cYo7Cr^dUgx7Jv(h| z@I|6FsSc=xXC11epP)wMS0q-vrchh^l^Tlb`A}3AB%`8uBGO4S2i3q6?d%j?!S&St zMs*;oy0c%ie{C`ksnS)BhJ*Xi& zh`vq7t>>Y7ejjyzXa_swucCV13YE6es3rbg)aErCEAf8wH3fMMHRN#}ZQ3QHhI}q+ zPq>GQ;^0npWICa)?~BT!AsCLMQG3M(JcoIxkvY`a@%=cB>0&>44x=}j6IHv~1DU87 zKEN#O)6M!94yC@JyZzL9j9P%U^{}5@7cq)@o1V5o^D&tEQq)L(ftBz$YH7ZKO5;a8 z$$t%5L6TTK^G8zK)W?d{hxfL5KNS@VIjG~GVmzM1b=abhovJ+4RNcg?co!9PWn&!U z!DyV1NvPfNpBS%WI#B4=*SZ3=BHlo?^e^m-es9<*>5o&Xzl-`Za{AersEiw^*TU&| z8Wn8)`rDyjh}zC;4RFj1jK|J+$4f!GR`WOQ()$3lG}amDnEiMOx8d?ZHby$eIwqI; zaa@Tr2Rr5%)*NDA^cTKIeNLQXW@C|f$M+YLMW`%!ipnnkp^mwVUJr%E6!H&qOeQWz z1xrYR{hIw6mB&GecGGwd+fhG(?Xm1|JM?d&F9^}Y@zJO$TZDS?YE(At#2%Q7WD)Cs zk{!xgsD-30>Vp0_3%6l+Z2Fdc;5<|sE<3%3R9gOqnqxD7#_;Jc`W>Y7`Bf=Sc| zkF>kvx2X3$!dlAve<{3yHQ%-;(ovhxO!QzDDt!*1UVIMY@HfsVOH{++QE7Sz*{{qI)QVSVj6L24mCv0} z&+Cu1Fdj8^8K|kfiXHKZTW>p-{MQ21f2_Un7;0|MxL!t$#2pOh#m+nSx`yN2AEl`6 zv^T1ODX2~99aONL#Ynt}nySiawqZ4}F7@tda zC;SrC<1+8s2EXDOf;!#|6+<0R*Y`ukz(x$jvhUgVH1<*$$brSEA$y1#vcUHp^EHk} z1!c1dHqCmt#-OHb0M@`UI38D^dR~E!DJTO_n^-t%!Fm-NV^2JT-Z>QNQHY&rcc}~v zp#B*)!^>D3t4y++OEhXECZMi6ikiZkI2!v-wrTk-j-qbT?T^w_)YOheH9Q@O39ngB zL36hq{ctZ1!(7zVRGs4Z{xCTa)w6r3V0w(cm29d_D-YJ^cob?cc@K5{N2nOeMoq~+ zEQUw1u=4*b1*Op?RJ!<0vq4rE)x%P#Aq+#MRU_0&*BaHMUN{*CV}H!UYWVteyIv$< z7wW4}3)`RA5L?ZlgS_9QQD}=lpc+zXrrn()QA5256_l4z>p+WHj+ur7P*Zaa70o4Q z+s!Eg6%&V1Bk>0+C`-=aezGV4^}J?t$$!n!ati8+|2#YNFJl$z>8K%FgX-}PY>i)_ zt}i^_j#OEEPQ421MO8BFLR1%Ze|uC%Vo(iRhZ>>d8RWkT_c@@2qrw6^w}GgbXpCA) zBT;kK6Ey{cQ2CsUdciolp`yYNH&2G!8Pi|zRo)cN;OQ<{N_m92OLy%#Cy zhV@JAi*ryzdH_4&37n2Ef9RN{xEA%|=1Xlbc0f&00($U$)F!kN6*GHLS#cDrV~u4t zn>r&?>@__o=mGsuJs*i0((zas7of6Yt6Tpb)uX$pn8~-?j$m=@PQ3#5#w0w0pQG+y zl4V!KeW?1k_`34{9tABF4OZ9{uPJIo#-SQA)vaftUc3>%!d&c&=__rTT|_n5S!JU; z03)flL5tHaY{d?T}4CwQL&d!y*%P z<0e$kcB1C)OVlQG6jSh5R0q0lu)pnkqoREwYMt1N4e)1FaQbhwn^nA*!VV66h^w)~ zf9(H$ZsSDiT|couEKZ?%Jbshi8-7Nu2O*ms-+xHwqUzJP*aavLCsPmFYX6R~9y?Jl zxy><~@J-Z6dW&thzeM6tyHXB*f;X@uF4|#(>Ix2{9+l&m^SB*9!@2*p5AL$lj@SxZ z$njm6r0aLtEZB)dsQ-=1lD@lr+2A$rP{`oGTHK8d_Shl%1E)}Lwby=_9Kkl!pWt$g z+-Fy?^QfM$+ix50mutVMwqPR1{SVml<526vS=3YoA0!t1$iEN@t2of)kiFp?>Z`Z) zXEqB~;XBmJd~SdF%tpRV%xP4%^f_!ta4EK>ejPu=kT2~|yCbMdcVM@_$>~_Z;snJ4LxBuor|dJdVXtH z#(}7HBMFs;X{cXLGtgU=!afQo@Dk3$&EMIfZ+6mtXncmtINtu0{YiEeCs0rR-cHGF zY)?J>v}3m7d#G%wbH;u%HbdXij%vtw)TTG%4Ee7If53r(81jStF*+YL*VWHDzW)!r zg<2U8VnsaZ)^A}Q>i?ov$XY+z^`bs1{W{_pOvST!1C<4bezMp5|4ja;aiHAKHcB&4 zd3qAxWC{wLv!Bax=WTSkYKiTG9!zlSGg0fwGEB!DoP>?N z7wymPy*Qi$oqnLe1fI)aUsl)X+Bg)qXukpwhM_>iT)O4p(9a zY<1Z&gK$1ZqxUX_TnbIE@ZV^Bj2@hN)&31J4K6d zC-rO$#sRvkHsHG5j$5OqpdTuT zGEuRy3KjL+QB#nM8krO5!5^_WK1NMlfg8G?{PXt}m`l_Hs-qqdhPvT()PuU9Uf9bU!j}!H(x2#CKZlafZ9vte`g9+uqSE+Qc({c=bDZMsn0`= z)FRaNE3g*kqO#?8)ctjD*$vnFW$Dn8-mq1-sQH}?nYxc5X6B@ z)B|>7ARa=s{EB=0HmX4nQ9aIg$DS{Zy05ZpbyQ4*U_I=E>gY7oeJgMfZYn}Sd0yhr z%;@IFoP0UuBDNG~jB~zZ`vMn;JjLlMo*pm($_e zsahq%>xPGU!WuOR533zoe|PW;&iKtsoCD6FC2Mn?$l$odcu&{=e?nY*s;8rFPf8g% YG}VLg$;t7_o}}31762z!$%cDw!8Wn29D7C3- zsnG{TTcxT+tApB7PZe!xJ@3!&+`nGu+;Q%?=X}5C++T9(a>4&zF1Wo|pxfCPv*C&{ zz3~rhjL}z(iNZ`QjHmIgW6TAdOa1sYWBOzF>-N4Km_WVA4SPHtTT(xR^|-IhO=B8R zZ+Xj@_Lz$8@Z(#?H8~UlZX2@_SD`LwamSbun2CSkeXNFe?;0}{OXV5U4acI72YiMd zsNej}m|zUMXFJ{pf1w_S{V?i(#!SUEI0&o%?iy2w!pz_84fC)F^`%~YEe28Ff)()# zoPjrRI40dUW*DBwA=vy6V-j&S>Ui-7#`M84_zIpzjd0m7hH*R@Ggd8#-DaXHlgl&g6eP~hOZP>!&(@D1#uughwkeXG_;d( z6t2O~vCQAb#Nbb;8^RtN(-WIu4b1l3hk;DNPhS16Cw2;a{}|Jj>!MKi&&3kB2&>{+ zEX(uFQ3@L3i>RUh8%tyUe~lTBftZfjI2j8*wH=v-Td4nln)^46;~$A{P$OE-l0gjo7hcF16KI8aDus_zN zJ_R+ETd)#dKy~yX&cxjOj(=I9{Mj%G)!^)X0rM4f%M~gJyYVdB@-J+<=<<-KciY7j|6pDuo}t11}b_Z_vmy8uN30 zi05!r)Fz`kGz-;{H&Go}>>Xc=x^E-ufm<;Izd{A&WAA*+qORj#FxnNhBannuxF8+X z@IurZtwi;BBPzXicpmW1pFmB`*Qg-7i23jr@A$7?{SK;~-%vsRr%OQ%7A@vY0jhy2 zsN*$IbJ-9z*KJTiH2~GY38?F4qDEi=mcfWF*GE8IuL!V^@G z6f5qSXYmEpkcXif?u2R}7S&(|md7cmAzy-Ocm=9s>rpYX6E$Urz4OPA7jVsK3Tp5o zDxL15I#Q;DeWPmFg?a;QhA!53j5&azjPae4j@ircDy1E}6r(!Yyo{ZK7}Orq16$zl zsPhfWI%a_KKZ-&u2Xaw){!BT?Ovg@G2T!Ah_A#nsg~~hTB@9G0_$q27=3_rxf|c<; zhGD7a921XiaWrm51z}~D&5b6|7HD9VuUp{MQ?` zt!Cdm8kO(eF&PJ<((DUV$G$@i-DS_~*q{16d>x~!J7zuZMm?}!u)Ti}zDPY0HImCw z*|F87py2ul6>OIhh*{C7jg&puXs-03bZE#k>9@KlF-gq-= zYLB2|;RLE9?j;JkF%NzC*t?)oE&G7_s0&+RP3(aRx;HQqKf~HsxV9b1FjVw6LEYEK zb0q4)E^0&-I%W?P zKy6<8u^OI4bubSVbb<98(+c}yJ>~xj3e7oi3e{i{Ru=_RInKLllpS;&G@4FUDZZ!3KB) z>*9S+U#N|NXw+OUL4RXc6w80m!Kkh^~g8bK9Hhjr3Td_4x!QWAH zmG-g?&OKO<`Vmw|?xE85DfV#qfN5mw175LnAMcrl-*eqmR4fc^Y}bWp=%b$7nEVf- zaMU~TD{6=eHgU`+SP?b17f=mdL3Qj2vVz7Q2N1)AHABw-Ee6HzPR z8q{X@Ax7gFmqIv&pcZyv>5h7{0hoaCI2ccR=R+gyjg7H5Z=Q)-0T;JqMWntR)$pBG zcBC4&wlUDbvpZ@bibbWpJD-9Uk{nbtZ};j)(f{VC5xRofgaX>w2M)u5)Tg4}>?hRr z{16p<;ce|E6^UASmZ4sB6>3DjL1M)aU&8IEbia-bl>aq4+UV_t8u}%uHU3>xT5d$8 z;TF`8?Lz;iW#bG4$Z*Y)aRi_@Rsk5v${` zsGuv-+c7?Df%9*Kn*afe+6!uVPIM6P=H&9Ds)mX=TjOTDWW(~42 z(sHn4_ESHMD{=A=$DG2-arQwsaT4{ZLmhq*8}ly?#X0ddOMXLTSHSCzxq@yv3X3WH zg$prjm~E)~aQij8AN8>rm|!=J(b$gq5p0h|M%bZ$4gEogK8`1#rfd!>Jr|?0VH3WF zJCH1LP5wkXltHM4qzUSRZa4?mVGK4HX&ao58uIz5O(@5!e~C)VOQ<=1fJrzr$&TQC zRJPp_$lgncQ8bG|2u`gSb4NPk%8KTCZi7*pwee2szawyb9xE2okphG<8i3$ zNI?bf9MprBVj*1V9p8XT-#zH+#4i-IKi|fN7?5Vu@g-Ep`l8Zw53*mG1E>}6NxD7W zc#O^GR;c#6VTkTSP2Eh?)P9GZG0&?v8B6|a0qQo^-gpQ#w)%Gj zP!4KJwqa2`h=r8@rzj|m&Y{xfk^cmLRztmEfmwD4YoOAq4r--)1r@9vaT@l*{&*3C z@#Wcey%>P6QeT8x*sfv(Hp=7$dA>=e5QQgE9Vzu6yE}!WhI$SvD9@wTfrvSdnT0W^ zskwlP=KOEk%_$5O6Z=pj@iQtY^UvjevZySoz0kMFf6Y-A1-(hYJUjHyVioEcs3BW| zdgBe)20uhy{|_o1i_CY-Q!ImeP?;>d5WRr9zZvR9qEQ`Nh8m&6S>(S8*EyhuiZ8Hp zTOJh?bx})cIBL#1pr)V)Dxc#}4@g37+i#$PE7Pm5!c){YqwXJjr)1$hofR+JSshxdB?Y-R>s3P7N4SmZ|oxLe>`*0$MJ10 z1@-JJRL{Rhb>t6JzW$3EnTl`guT}i19(8;wY9v;m9Dr5 zsH`}MHL%hr!i{8CSV=RL@mj?v5@kAABDH@2x>*^y2@^oLs03o4V4X_pc*=c zdh>HQ5`Vx?vEyp{nO}5qNZdy>i+l9)n>4Vf_A^V*b)n_bxay|z(_oR z&GBE<6gA7W4Yxzpd!n*s5Gr;OQNcVBSK&fbN5a=xTcbueW*zyTpF%7LWIU>&L{viQ3C7Hq;e>bFo?(q*qd8(cGzLKX*>;$E!%p&g>1aR&89`|O9w z0c=Y>50_*3M|K7K3iam8KDHfygsQLIZ@;XZ1GYXGV>o^gHC3fQAr|tHe}NR<5$WD4@|WsXN*vK^X&i^Y$W=yn^#XottZoQ zI_BV1^tnISpWSP41P5NaZ0oC0J&pL$=JRyakRC?O;ThED`A?{!t^AYydaj8|+Yr?C z<1iOzV<)WpvttHf26jaE0)_n)s{g`&qw#0-Ve%FGH=OzSBK3V(3vXf&mcHtkBiIl# z@d0XzCjV-qJ_~D8kGf{3XcQ{{SD-rLT=##7xF(u{=58WBgVRxSoQXqmEmp@uH|%y? z4>bjCP(d^a_25iY)W3t8f_12o`2c-*2#ev*sHw}tqT2r-`3ubDP1`_8R09=JH`GBj z)Cl#!R^It8s0YSkO&o!0I2*g;a@2kIuqytI+N3JovI|hC)PFD zAP1^(ViKx>Rj4_857m)V-tqIO4*iIF<2&B@$KLq@dG`L2sF(=E`WT6N(G=8uvv3f; zU6_LM{9)e0j?GRvW>@*>Hkvl#o2k7dJj` zWV|me#g{&OaJp}N%9vDNbZU*{A!(zUw2B{`opAbg@!f`53AE4bZ>Y`XTp{xB@Q?(Dy79IB**&( fC#H{yAIX!tdUyL0\n" "Language-Team: \n" "Language: de\n" @@ -254,11 +254,11 @@ msgstr "Mehr Disk-Speicherplatz frei machen" msgid "Cut " msgstr "Schneiden " -#: octoprint_mrbeam/static/js/design_store.js:236 +#: octoprint_mrbeam/static/js/design_store.js:239 msgid "Could not download design" msgstr "Konnte das Design nicht herunterladen" -#: octoprint_mrbeam/static/js/design_store.js:237 +#: octoprint_mrbeam/static/js/design_store.js:240 msgid "The purchased design could not be downloaded. Please download again." msgstr "" "Das gekaufte Design konnte nicht heruntergeladen werden. Bitte versuche es " @@ -831,42 +831,42 @@ msgstr "" msgid "Please confirm to proceed." msgstr "Bitte bestätige, um fortzufahren." -#: octoprint_mrbeam/static/js/mrbeam.js:273 +#: octoprint_mrbeam/static/js/mrbeam.js:190 #: octoprint_mrbeam/static/js/wizard_acl.js:177 #: octoprint_mrbeam/templates/wizard/wizard_acl.jinja2:23 msgid "Invalid e-mail address" msgstr "Ungültige E-Mail-Adresse" -#: octoprint_mrbeam/static/js/mrbeam.js:335 +#: octoprint_mrbeam/static/js/mrbeam.js:252 #: octoprint_mrbeam/templates/loginscreen_viewmodel.jinja2:20 #: octoprint_mrbeam/templates/loginscreen_viewmodel.jinja2:22 #: octoprint_mrbeam/templates/wizard/wizard_acl.jinja2:21 msgid "E-mail address" msgstr "E-Mail-Adresse" -#: octoprint_mrbeam/static/js/mrbeam.js:500 -#: octoprint_mrbeam/static/js/mrbeam.js:514 -#: octoprint_mrbeam/static/js/mrbeam.js:525 +#: octoprint_mrbeam/static/js/mrbeam.js:417 +#: octoprint_mrbeam/static/js/mrbeam.js:431 +#: octoprint_mrbeam/static/js/mrbeam.js:442 msgid "Session expired" msgstr "Sitzung abgelaufen" -#: octoprint_mrbeam/static/js/mrbeam.js:501 +#: octoprint_mrbeam/static/js/mrbeam.js:418 msgid "Trying to do a re-login..." msgstr "Ich versuche, mich neu anzumelden..." -#: octoprint_mrbeam/static/js/mrbeam.js:515 +#: octoprint_mrbeam/static/js/mrbeam.js:432 msgid "Re-login successful.
      Please repeat the last action." msgstr "Re-login erfolgreich.
      Bitte wiederhole die letzte Aktion." -#: octoprint_mrbeam/static/js/mrbeam.js:526 +#: octoprint_mrbeam/static/js/mrbeam.js:443 msgid "Please login again." msgstr "Bitte logge dich erneut ein." -#: octoprint_mrbeam/static/js/mrbeam.js:583 +#: octoprint_mrbeam/static/js/mrbeam.js:500 msgid "Browser not supported." msgstr "Browser wird nicht unterstützt." -#: octoprint_mrbeam/static/js/mrbeam.js:585 +#: octoprint_mrbeam/static/js/mrbeam.js:502 #, python-format msgid "" "Mr Beam makes use of latest web technologies which might not be fully " @@ -877,11 +877,11 @@ msgstr "" "vollständig unterstützt werden.%(br)sBitte verwende die neueste Version von " "%(open)sGoogle Chrome%(close)s für Mr Beam." -#: octoprint_mrbeam/static/js/mrbeam.js:607 +#: octoprint_mrbeam/static/js/mrbeam.js:524 msgid "Beta user: Please consider enabling Mr Beam analytics!" msgstr "Beta-Nutzer: Bitte aktiviere Mr Beam Analytics!" -#: octoprint_mrbeam/static/js/mrbeam.js:611 +#: octoprint_mrbeam/static/js/mrbeam.js:528 #, python-format msgid "" "As you are currently in our Beta channel, you would help us tremendously " @@ -1450,11 +1450,11 @@ msgstr "Stern" msgid "Heart" msgstr "Herz" -#: octoprint_mrbeam/static/js/working_area.js:1342 +#: octoprint_mrbeam/static/js/working_area.js:1356 msgid "Limited split result." msgstr "Nur teilweise zerteiltes Ergebnis." -#: octoprint_mrbeam/static/js/working_area.js:1343 +#: octoprint_mrbeam/static/js/working_area.js:1357 msgid "" "Splitting this design would result in too many parts. Here are " "${split_result.length} parts. You can split the last one again if necessary." @@ -1463,27 +1463,27 @@ msgstr "" "${split_result.length} Teile. Du kannst den letzten Teil bei Bedarf noch " "einmal zerteilen." -#: octoprint_mrbeam/static/js/working_area.js:1354 +#: octoprint_mrbeam/static/js/working_area.js:1368 msgid "No different line colors found." msgstr "Keine unterschiedlichen Linienfarben gefunden." -#: octoprint_mrbeam/static/js/working_area.js:1357 +#: octoprint_mrbeam/static/js/working_area.js:1371 msgid "No non-intersecting shapes found." msgstr "Keine nicht-überlappenden Formen gefunden." -#: octoprint_mrbeam/static/js/working_area.js:1364 +#: octoprint_mrbeam/static/js/working_area.js:1378 msgid "Looks like a single path." msgstr "Sieht nach einem einzigen Pfad aus." -#: octoprint_mrbeam/static/js/working_area.js:1367 +#: octoprint_mrbeam/static/js/working_area.js:1381 msgid "Element not splittable with this method." msgstr "Element is nicht zerteilbar mit dieser Methode." -#: octoprint_mrbeam/static/js/working_area.js:1369 +#: octoprint_mrbeam/static/js/working_area.js:1383 msgid "Can't split this design." msgstr "Dieses Design kann nicht zerteilt werden." -#: octoprint_mrbeam/static/js/working_area.js:1909 +#: octoprint_mrbeam/static/js/working_area.js:1923 #, python-format msgid "" "The SVG file contains unsupported elements: '%(elemName)s' These elements " @@ -1492,12 +1492,12 @@ msgstr "" "Die SVG-Datei enthält nicht unterstützte Elemente: %(elemName)s' Diese " "Elemente wurden entfernt." -#: octoprint_mrbeam/static/js/working_area.js:1917 +#: octoprint_mrbeam/static/js/working_area.js:1931 #, python-format msgid "Unsupported elements in SVG: '%(elemName)s'" msgstr "Nicht unterstützte Elemente in SVG: '%(elemName)s'" -#: octoprint_mrbeam/static/js/working_area.js:1930 +#: octoprint_mrbeam/static/js/working_area.js:1944 #, python-format msgid "" "The SVG file contains text elements.%(br)sIf you want to laser just their " @@ -1508,11 +1508,11 @@ msgstr "" "willst,%(br)skonvertiere sie in Pfade.%(br)sAnsonsten werden sie mit Füllung " "graviert." -#: octoprint_mrbeam/static/js/working_area.js:1937 +#: octoprint_mrbeam/static/js/working_area.js:1951 msgid "Text elements found" msgstr "Textelemente gefunden" -#: octoprint_mrbeam/static/js/working_area.js:1950 +#: octoprint_mrbeam/static/js/working_area.js:1964 msgid "" "The SVG file contained style elements with online references. Since online " "references are not supported, we removed them. The image might look a bit " @@ -1522,11 +1522,11 @@ msgstr "" "Referenzen nicht unterstützt werden, haben wir sie entfernt. Das Bild könnte " "jetzt etwas anders aussehen." -#: octoprint_mrbeam/static/js/working_area.js:1955 +#: octoprint_mrbeam/static/js/working_area.js:1969 msgid "Style elements removed" msgstr "Style-Elemente entfernt" -#: octoprint_mrbeam/static/js/working_area.js:1969 +#: octoprint_mrbeam/static/js/working_area.js:1983 msgid "" "The selected design file can not be handled. Please make sure it is a valid " "design file." @@ -1534,25 +1534,25 @@ msgstr "" "Die ausgewählte Design-Datei kann nicht bearbeitet werden. Bitte stelle " "sicher, dass es sich um eine gültige Design-Datei handelt." -#: octoprint_mrbeam/static/js/working_area.js:1975 +#: octoprint_mrbeam/static/js/working_area.js:1989 msgid "File error." msgstr "Dateifehler." -#: octoprint_mrbeam/static/js/working_area.js:1989 +#: octoprint_mrbeam/static/js/working_area.js:2003 msgid "The selected design file does not have any content." msgstr "Die ausgewählte Design-Datei hat keinen Inhalt." -#: octoprint_mrbeam/static/js/working_area.js:1995 +#: octoprint_mrbeam/static/js/working_area.js:2009 msgid "Empty File." msgstr "Leere Datei." -#: octoprint_mrbeam/static/js/working_area.js:2009 +#: octoprint_mrbeam/static/js/working_area.js:2023 msgid "An unknown error occurred while processing this design file." msgstr "" "Ein bekannter Fehler ist während der Verarbeitung dieser Designdatei " "aufgetreten." -#: octoprint_mrbeam/static/js/working_area.js:2017 +#: octoprint_mrbeam/static/js/working_area.js:2031 msgid "" "Please try reloading this browser window and try again. If this error " "remains, contact the Mr Beam Support Team. Make sure you provide the error " @@ -1566,8 +1566,8 @@ msgstr "" #: octoprint_mrbeam/static/js/calibration/calibration.js:120 #: octoprint_mrbeam/static/js/calibration/corner_calibration.js:124 #: octoprint_mrbeam/static/js/calibration/corner_calibration.js:367 -#: octoprint_mrbeam/static/js/working_area.js:2024 -#: octoprint_mrbeam/static/js/working_area.js:2029 +#: octoprint_mrbeam/static/js/working_area.js:2038 +#: octoprint_mrbeam/static/js/working_area.js:2043 msgid "Error" msgstr "Fehler" @@ -2476,10 +2476,11 @@ msgstr "Stelle sicher, dass Dein Mr Beam leer ist." #: octoprint_mrbeam/templates/homing_overlay.jinja2:51 msgid "" -"Then do a homing cycle so that your Mr Beam knows its current position." +"Then run a homing cycle so your Mr Beam can detect the position of the " +"laser head." msgstr "" -"Führe dann einen Homing-Zyklus durch, damit Dein Mr Beam seine aktuelle " -"Position kennt." +"Führe dann einen Homing-Zyklus durch, damit Dein Mr Beam die Position " +"des Laserkopfs erkennen kann." #: octoprint_mrbeam/templates/homing_overlay.jinja2:54 msgid "Homing Cycle" diff --git a/setup.py b/setup.py index 86ea6791a..5a658bc58 100644 --- a/setup.py +++ b/setup.py @@ -77,6 +77,7 @@ "package_data": { "octoprint_mrbeam": [ "profiles/*.yaml", + "profiles/laserhead/*.yaml", "files/grbl/*.hex", "files/migrate/*", "files/migrate_logrotate/*", diff --git a/translations/messages.pot b/translations/messages.pot index 8893a0c9a..62cb6cf24 100644 --- a/translations/messages.pot +++ b/translations/messages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PROJECT VERSION\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2022-01-24 11:40+0100\n" +"POT-Creation-Date: 2022-03-31 16:25+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -213,11 +213,11 @@ msgstr "" msgid "Cut " msgstr "" -#: octoprint_mrbeam/static/js/design_store.js:236 +#: octoprint_mrbeam/static/js/design_store.js:239 msgid "Could not download design" msgstr "" -#: octoprint_mrbeam/static/js/design_store.js:237 +#: octoprint_mrbeam/static/js/design_store.js:240 msgid "The purchased design could not be downloaded. Please download again." msgstr "" @@ -712,42 +712,42 @@ msgstr "" msgid "Please confirm to proceed." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:273 +#: octoprint_mrbeam/static/js/mrbeam.js:190 #: octoprint_mrbeam/static/js/wizard_acl.js:177 #: octoprint_mrbeam/templates/wizard/wizard_acl.jinja2:23 msgid "Invalid e-mail address" msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:335 +#: octoprint_mrbeam/static/js/mrbeam.js:252 #: octoprint_mrbeam/templates/loginscreen_viewmodel.jinja2:20 #: octoprint_mrbeam/templates/loginscreen_viewmodel.jinja2:22 #: octoprint_mrbeam/templates/wizard/wizard_acl.jinja2:21 msgid "E-mail address" msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:500 -#: octoprint_mrbeam/static/js/mrbeam.js:514 -#: octoprint_mrbeam/static/js/mrbeam.js:525 +#: octoprint_mrbeam/static/js/mrbeam.js:417 +#: octoprint_mrbeam/static/js/mrbeam.js:431 +#: octoprint_mrbeam/static/js/mrbeam.js:442 msgid "Session expired" msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:501 +#: octoprint_mrbeam/static/js/mrbeam.js:418 msgid "Trying to do a re-login..." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:515 +#: octoprint_mrbeam/static/js/mrbeam.js:432 msgid "Re-login successful.
      Please repeat the last action." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:526 +#: octoprint_mrbeam/static/js/mrbeam.js:443 msgid "Please login again." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:583 +#: octoprint_mrbeam/static/js/mrbeam.js:500 msgid "Browser not supported." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:585 +#: octoprint_mrbeam/static/js/mrbeam.js:502 #, python-format msgid "" "Mr Beam makes use of latest web technologies which might not be fully " @@ -755,11 +755,11 @@ msgid "" "of%(br)s%(open)sGoogle Chrome%(close)s for Mr Beam." msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:607 +#: octoprint_mrbeam/static/js/mrbeam.js:524 msgid "Beta user: Please consider enabling Mr Beam analytics!" msgstr "" -#: octoprint_mrbeam/static/js/mrbeam.js:611 +#: octoprint_mrbeam/static/js/mrbeam.js:528 #, python-format msgid "" "As you are currently in our Beta channel, you would help us tremendously " @@ -1255,50 +1255,50 @@ msgstr "" msgid "Heart" msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1342 +#: octoprint_mrbeam/static/js/working_area.js:1356 msgid "Limited split result." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1343 +#: octoprint_mrbeam/static/js/working_area.js:1357 msgid "" "Splitting this design would result in too many parts. Here are " "${split_result.length} parts. You can split the last one again if " "necessary." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1354 +#: octoprint_mrbeam/static/js/working_area.js:1368 msgid "No different line colors found." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1357 +#: octoprint_mrbeam/static/js/working_area.js:1371 msgid "No non-intersecting shapes found." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1364 +#: octoprint_mrbeam/static/js/working_area.js:1378 msgid "Looks like a single path." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1367 +#: octoprint_mrbeam/static/js/working_area.js:1381 msgid "Element not splittable with this method." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1369 +#: octoprint_mrbeam/static/js/working_area.js:1383 msgid "Can't split this design." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1909 +#: octoprint_mrbeam/static/js/working_area.js:1923 #, python-format msgid "" "The SVG file contains unsupported elements: '%(elemName)s' These elements" " got removed." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1917 +#: octoprint_mrbeam/static/js/working_area.js:1931 #, python-format msgid "Unsupported elements in SVG: '%(elemName)s'" msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1930 +#: octoprint_mrbeam/static/js/working_area.js:1944 #, python-format msgid "" "The SVG file contains text elements.%(br)sIf you want to laser just their" @@ -1306,44 +1306,44 @@ msgid "" " engraved with infill." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1937 +#: octoprint_mrbeam/static/js/working_area.js:1951 msgid "Text elements found" msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1950 +#: octoprint_mrbeam/static/js/working_area.js:1964 msgid "" "The SVG file contained style elements with online references. Since " "online references are not supported, we removed them. The image might " "look a bit different now." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1955 +#: octoprint_mrbeam/static/js/working_area.js:1969 msgid "Style elements removed" msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1969 +#: octoprint_mrbeam/static/js/working_area.js:1983 msgid "" "The selected design file can not be handled. Please make sure it is a " "valid design file." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1975 +#: octoprint_mrbeam/static/js/working_area.js:1989 msgid "File error." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1989 +#: octoprint_mrbeam/static/js/working_area.js:2003 msgid "The selected design file does not have any content." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:1995 +#: octoprint_mrbeam/static/js/working_area.js:2009 msgid "Empty File." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:2009 +#: octoprint_mrbeam/static/js/working_area.js:2023 msgid "An unknown error occurred while processing this design file." msgstr "" -#: octoprint_mrbeam/static/js/working_area.js:2017 +#: octoprint_mrbeam/static/js/working_area.js:2031 msgid "" "Please try reloading this browser window and try again. If this error " "remains, contact the Mr Beam Support Team. Make sure you provide the " @@ -1354,8 +1354,8 @@ msgstr "" #: octoprint_mrbeam/static/js/calibration/calibration.js:120 #: octoprint_mrbeam/static/js/calibration/corner_calibration.js:124 #: octoprint_mrbeam/static/js/calibration/corner_calibration.js:367 -#: octoprint_mrbeam/static/js/working_area.js:2024 -#: octoprint_mrbeam/static/js/working_area.js:2029 +#: octoprint_mrbeam/static/js/working_area.js:2038 +#: octoprint_mrbeam/static/js/working_area.js:2043 msgid "Error" msgstr "" @@ -2132,8 +2132,8 @@ msgstr "" #: octoprint_mrbeam/templates/homing_overlay.jinja2:51 msgid "" -"Then do a homing cycle so that your Mr Beam knows its current " -"position." +"Then run a homing cycle so your Mr Beam can detect the position of " +"the laser head." msgstr "" #: octoprint_mrbeam/templates/homing_overlay.jinja2:54 From 2f213aa2233413f6b7ba8d3ce423ff24c85c2f35 Mon Sep 17 00:00:00 2001 From: Ahmed Salem <85931758+ahmed-mrbeam@users.noreply.github.com> Date: Tue, 12 Apr 2022 15:58:53 +0200 Subject: [PATCH 05/15] SW-1162 Modify the "userData" sent to design store by sanitizing the mr beam plugin verison to PEP440 (#1457) * Added a new regexp to extract base version * Added console log to show the detected version --- octoprint_mrbeam/static/js/design_store.js | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/octoprint_mrbeam/static/js/design_store.js b/octoprint_mrbeam/static/js/design_store.js index 07c9aea18..53b671bf5 100644 --- a/octoprint_mrbeam/static/js/design_store.js +++ b/octoprint_mrbeam/static/js/design_store.js @@ -126,14 +126,21 @@ $(function () { $("#design_store_iframe").show(); $("#design_store_offline_placeholder").hide(); + // TODO: remove the following Version sanitization once the version + // comparative methods support "pep440" versioning (SW-1047) + // Regex to extract the base version from a version string + // 0.10.2-alpha --> 0.10.2 (SemVer) + // 0.11.78a0 --> 0.11.78 (PEP440) + // 0+unknown --> 0 (No version info) + let regexp = /([0-9]+(?:\.[0-9]+)*)/g; + let mrbeamPluginVersion = BEAMOS_VERSION.match(regexp)[0]; + console.log("Design store: Mr Beam Plugin Version: " + mrbeamPluginVersion ); + let userData = { email: self.getEmail(), serial: MRBEAM_SERIAL, user_token: self.getAuthToken(), - // TODO: remove the following sanitization (SW-1046) once the version - // comparative methods support "-hotfix..." verisoning (SW-1047) - // Remove any versioning characters after "-" like "-hotfix" - version: BEAMOS_VERSION.split("-")[0], + version: mrbeamPluginVersion, language: MRBEAM_LANGUAGE, last_uploaded: self.getLastUploadedDate(), }; From e9c89b3e7b2b636d775ec3ff6a3d5565e4ef3f84 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Tue, 19 Apr 2022 09:18:28 +0200 Subject: [PATCH 06/15] SW-1224 support legacy image for new update mechanism (#1458) * refactor beamos_date to beamos_version * refactor config generation to use beamos_version instead of beamos_date change the testcases to do the same * add comparison option to the update config for a beamos version * change packaging version to pkg_resources as this is already on our devices * fix dependency version for archive removed python-version-warning as this is incompatible to the legacy image --- octoprint_mrbeam/scripts/update_script.py | 20 ++- .../software_update_information.py | 152 +++++++++++++----- tests/softwareupdate/mock_config.json | 50 ++++-- .../target_find_my_mr_beam_config.json | 5 +- .../softwareupdate/target_mrbeam_config.json | 24 +-- .../target_mrbeam_config_legacy.json | 99 ++++++++++++ .../target_netconnectd_config.json | 10 +- .../target_netconnectd_config_legacy.json | 81 ++++++++++ .../target_octoprint_config.json | 16 +- tests/softwareupdate/test_cloud_config.py | 149 +++++++++-------- tests/softwareupdate/test_comparison.py | 137 ++++++++++++++++ 11 files changed, 572 insertions(+), 171 deletions(-) create mode 100644 tests/softwareupdate/target_mrbeam_config_legacy.json create mode 100644 tests/softwareupdate/target_netconnectd_config_legacy.json create mode 100644 tests/softwareupdate/test_comparison.py diff --git a/octoprint_mrbeam/scripts/update_script.py b/octoprint_mrbeam/scripts/update_script.py index 883c80e4e..290e6ee8b 100644 --- a/octoprint_mrbeam/scripts/update_script.py +++ b/octoprint_mrbeam/scripts/update_script.py @@ -180,7 +180,6 @@ def build_wheels(build_queue): pip_args = [ "wheel", - "--no-python-version-warning", "--disable-pip-version-check", "--wheel-dir={}".format(tmp_folder), # Build wheels into , where the default is the current working directory. "--no-dependencies", # Don't install package dependencies. @@ -217,7 +216,6 @@ def install_wheels(install_queue): tmp_folder = os.path.join(PIP_WHEEL_TEMP_FOLDER, re.search(r"\w+((?=\/venv)|(?=\/bin))", venv).group(0)) pip_args = [ "install", - "--no-python-version-warning", "--disable-pip-version-check", "--upgrade", # Upgrade all specified packages to the newest available version. The handling of dependencies depends on the upgrade-strategy used. "--no-index", # Ignore package index (only looking at --find-links URLs instead). @@ -275,33 +273,41 @@ def build_queue(update_info, dependencies, plugin_archive): raise RuntimeError( "no update info for dependency {}".format(dependency["name"]) ) + + # override the dependency version from the dependencies files with the one from the cloud config + if dependency_config.get("version"): + version_needed = dependency_config.get("version") + else: + version_needed = dependency.get("version") + if dependency_config.get("pip"): archive = dependency_config["pip"].format( - target_version="v{version}".format(version=dependency["version"]), + target_version="v{version}".format(version=version_needed), ) else: raise RuntimeError( "pip not configured for {}".format(dependency["name"]) ) - version = get_version_of_pip_module( + installed_version = get_version_of_pip_module( dependency["name"], dependency_config.get("pip_command", DEFAULT_OPRINT_VENV), ) - if version != dependency["version"]: + + if installed_version != version_needed: install_queue.setdefault( dependency_config.get("pip_command", DEFAULT_OPRINT_VENV), [] ).append( { "name": dependency["name"], "archive": archive, - "target": dependency["version"], + "target": version_needed, } ) else: print( "skip dependency {} as the target version {} is already installed".format( - dependency["name"], dependency["version"] + dependency["name"], version_needed ) ) return install_queue diff --git a/octoprint_mrbeam/software_update_information.py b/octoprint_mrbeam/software_update_information.py index 963a9cfa4..d497269b0 100644 --- a/octoprint_mrbeam/software_update_information.py +++ b/octoprint_mrbeam/software_update_information.py @@ -1,9 +1,10 @@ -import base64 import copy import json +import operator import os from datetime import date -from datetime import datetime + +import pkg_resources from enum import Enum import semantic_version @@ -37,7 +38,7 @@ class SWUpdateTier(Enum): SWUpdateTier.ALPHA.value: "alpha", SWUpdateTier.DEV.value: "develop", } -MAJOR_VERSION_CLOUD_CONFIG = 0 +MAJOR_VERSION_CLOUD_CONFIG = 1 SW_UPDATE_INFO_FILE_NAME = "update_info.json" _logger = mrb_logger("octoprint.plugins.mrbeam.software_update_information") @@ -50,7 +51,8 @@ class SWUpdateTier(Enum): "sudo {}".format(GLOBAL_PIP_BIN) if os.path.isfile(GLOBAL_PIP_BIN) else None ) -BEAMOS_LEGACY_DATE = date(2018, 1, 12) +BEAMOS_LEGACY_VERSION = "0.14.0" +BEAMOS_LEGACY_DATE = date(2018, 1, 12) # still used in the migrations def get_tag_of_github_repo(repo): @@ -122,10 +124,10 @@ def get_update_information(plugin): """ try: tier = plugin._settings.get(["dev", "software_tier"]) - beamos_tier, beamos_date = plugin._device_info.get_beamos_version() + beamos_version = plugin._device_info.get_beamos_version_number() _logger.info( - "SoftwareUpdate using tier: {tier} {beamos_date}".format( - tier=tier, beamos_date=beamos_date + "SoftwareUpdate using tier: {tier} {beamos_version}".format( + tier=tier, beamos_version=beamos_version ) ) @@ -142,7 +144,7 @@ def get_update_information(plugin): ) if cloud_config: return _set_info_from_cloud_config( - plugin, tier, beamos_date, cloud_config + plugin, tier, beamos_version, cloud_config ) else: _logger.warn("no internet connection") @@ -165,7 +167,7 @@ def get_update_information(plugin): return _set_info_from_cloud_config( plugin, tier, - beamos_date, + beamos_version, { "default": {}, "modules": { @@ -253,7 +255,7 @@ def reload_update_info(plugin): @logExceptions -def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): +def _set_info_from_cloud_config(plugin, tier, beamos_version, cloud_config): """ loads update info from the update_info.json file the override order: default_settings->module_settings->tier_settings->beamos_settings @@ -265,8 +267,8 @@ def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): : { , :{}, - "beamos_date": { - : {} + "beamos_version": { + "X.X.X": {} # only supports major minor patch } } "dependencies: {} @@ -275,7 +277,7 @@ def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): Args: plugin: Mr Beam Plugin tier: the software tier which should be used - beamos_date: the image creation date of the running beamos + beamos_version: the version of the running beamos cloud_config: the update config from the cloud Returns: @@ -295,7 +297,7 @@ def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): module = dict_merge(defaultsettings, module) sw_update_config[module_id] = _generate_config_of_module( - module_id, module, defaultsettings, tier, beamos_date, plugin + module_id, module, defaultsettings, tier, beamos_version, plugin ) except softwareupdate_exceptions.ConfigurationInvalid as e: _logger.exception("ConfigurationInvalid {}".format(e)) @@ -332,7 +334,7 @@ def _set_info_from_cloud_config(plugin, tier, beamos_date, cloud_config): def _generate_config_of_module( - module_id, input_moduleconfig, defaultsettings, tier, beamos_date, plugin + module_id, input_moduleconfig, defaultsettings, tier, beamos_version, plugin ): """ generates the config of a software module @@ -341,7 +343,7 @@ def _generate_config_of_module( input_moduleconfig: moduleconfig defaultsettings: default settings tier: software tier - beamos_date: date of the beamos + beamos_version: version of the beamos plugin: Mr Beam Plugin Returns: @@ -363,7 +365,7 @@ def _generate_config_of_module( input_moduleconfig = dict_merge( input_moduleconfig, - _generate_config_of_beamos(input_moduleconfig, beamos_date, tierversion), + _generate_config_of_beamos(input_moduleconfig, beamos_version, tierversion), ) if "branch" in input_moduleconfig and "{tier}" in input_moduleconfig["branch"]: @@ -429,7 +431,7 @@ def _generate_config_of_module( dependencie_config, {}, tier, - beamos_date, + beamos_version, plugin, ) return input_moduleconfig @@ -438,10 +440,11 @@ def _generate_config_of_module( def _get_curent_version(input_moduleconfig, module_id, plugin): """ returns the version of the given module + Args: - input_moduleconfig: module to get the version for - module_id: id of the module - plugin: Mr Beam Plugin + input_moduleconfig (dict): module to get the version for + module_id (str): id of the module + plugin (:obj:`OctoPrint Plugin`): Mr Beam Plugin Returns: version of the module or None @@ -479,35 +482,96 @@ def _get_curent_version(input_moduleconfig, module_id, plugin): return current_version -def _generate_config_of_beamos(moduleconfig, beamos_date, tierversion): +class VersionComperator: + """ + Version Comperator class to compare two versions with the compare method + """ + + def __init__(self, identifier, priority, compare): + self.identifier = identifier + self.priority = priority + self.compare = compare + + @staticmethod + def get_comperator(comparision_string, comparision_options): + """ + returns the comperator of the given list of VersionComperator with the matching identifier + + Args: + comparision_string (str): identifier to search for + comparision_options (list): list of VersionComperator objects + + Returns: + object: matching VersionComperator object + """ + for item in comparision_options: + if item.identifier == comparision_string: + return item + + +def _generate_config_of_beamos(moduleconfig, beamos_version, tierversion): """ - generates the config for the given beamos_date of the tierversion + generates the config for the given beamos_version of the tierversion + Args: - moduleconfig: update config of the module - beamos_date: date of the beamos - tierversion: software tier + moduleconfig (dict): update config of the module + beamos_version (str): version of the beamos + tierversion (str): software tier Returns: - beamos config of the tierversion + dict: beamos config of the tierversion """ - if "beamos_date" not in moduleconfig: + if "beamos_version" not in moduleconfig: + _logger.debug("no beamos_version set in moduleconfig") return {} - beamos_date_config = {} - prev_beamos_date_entry = datetime.strptime("2000-01-01", "%Y-%m-%d").date() - for date, beamos_config in moduleconfig["beamos_date"].items(): - if ( - beamos_date >= datetime.strptime(date, "%Y-%m-%d").date() - and prev_beamos_date_entry < beamos_date - ): - prev_beamos_date_entry = datetime.strptime(date, "%Y-%m-%d").date() - if tierversion in beamos_config: - beamos_config_module_tier = beamos_config[tierversion] - beamos_config = dict_merge( - beamos_config, beamos_config_module_tier - ) # override tier config from tiers set in config_file - beamos_date_config = dict_merge(beamos_date_config, beamos_config) - return beamos_date_config + config_for_beamos_versions = moduleconfig.get("beamos_version") + + comparision_options = [ + VersionComperator("__eq__", 5, operator.eq), + VersionComperator("__le__", 4, operator.le), + VersionComperator("__lt__", 3, operator.lt), + VersionComperator("__ge__", 2, operator.ge), + VersionComperator("__gt__", 1, operator.gt), + ] + + sorted_config_for_beamos_versions = sorted( + config_for_beamos_versions.items(), + key=lambda com: VersionComperator.get_comperator( + com[0], comparision_options + ).priority, + ) + + config_for_beamos = get_config_for_version( + beamos_version, sorted_config_for_beamos_versions, comparision_options + ) + + if tierversion in config_for_beamos: + beamos_config_module_tier = config_for_beamos.get(tierversion) + config_for_beamos = dict_merge( + config_for_beamos, beamos_config_module_tier + ) # override tier config from tiers set in config_file + + return config_for_beamos + + +def get_config_for_version(target_version, config, comparision_options): + config_to_be_updated = {} + for comperator, version_config_items in config: + # sort the version config items by the version + sorted_version_config_items = sorted( + version_config_items.items(), + key=lambda version_config_tuple: pkg_resources.parse_version( + version_config_tuple[0] + ), + ) + + for check_version, version_config in sorted_version_config_items: + if VersionComperator.get_comperator( + comperator, comparision_options + ).compare(target_version, check_version): + config_to_be_updated = dict_merge(config_to_be_updated, version_config) + return config_to_be_updated def _clean_update_config(update_config): @@ -519,7 +583,7 @@ def _clean_update_config(update_config): Returns: cleaned version of the update config """ - pop_list = ["alpha", "beta", "stable", "develop", "beamos_date", "name"] + pop_list = ["alpha", "beta", "stable", "develop", "beamos_version", "name"] for key in set(update_config).intersection(pop_list): del update_config[key] return update_config diff --git a/tests/softwareupdate/mock_config.json b/tests/softwareupdate/mock_config.json index 826132cf9..4b2dca3b0 100644 --- a/tests/softwareupdate/mock_config.json +++ b/tests/softwareupdate/mock_config.json @@ -2,7 +2,8 @@ "default": { "type": "github_commit", "user": "mrbeam", - "release_compare": "unequal", + "release_compare": "python_unequal", + "force_base": false, "stable": { "branch": "mrbeam2-stable", "branch_default": "mrbeam2-stable", @@ -59,7 +60,13 @@ "octoprint": { "type": "github_release", "develop": { - "type": "github_commit" + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha" + }, + "alpha": { + "branch": "alpha", + "branch_default": "alpha" } }, "mrbeam": { @@ -84,9 +91,11 @@ "repo": "MrBeamLedStrips", "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", "global_pip_command": true, - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + } } } }, @@ -94,9 +103,11 @@ "repo": "iobeam", "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", "global_pip_command": true, - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } } } }, @@ -104,9 +115,11 @@ "repo": "mrb_hw_info", "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", "global_pip_command": true, - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } } } }, @@ -126,11 +139,18 @@ "repo": "netconnectd_mrbeam", "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", "global_pip_command": true, - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + } + }, + "__le__": { + "0.14.0": { + "version": "0.0.1" + } + } } - } } }, "develop": { diff --git a/tests/softwareupdate/target_find_my_mr_beam_config.json b/tests/softwareupdate/target_find_my_mr_beam_config.json index 8bc386195..176ab2fbf 100644 --- a/tests/softwareupdate/target_find_my_mr_beam_config.json +++ b/tests/softwareupdate/target_find_my_mr_beam_config.json @@ -32,7 +32,8 @@ ] } ], - "release_compare": "unequal", + "force_base": false, + "release_compare": "python_unequal", "tiers": { "stable": { "branch": "mrbeam2-stable", @@ -49,7 +50,7 @@ "develop": { "type": "github_commit", "branch": "alpha", - "branch_default": "alpha", + "branch_default": "alpha" }, "alpha": { "branch": "mrbeam2-alpha", diff --git a/tests/softwareupdate/target_mrbeam_config.json b/tests/softwareupdate/target_mrbeam_config.json index 108f9fa3b..2151804bb 100644 --- a/tests/softwareupdate/target_mrbeam_config.json +++ b/tests/softwareupdate/target_mrbeam_config.json @@ -5,42 +5,28 @@ "pip": "https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", "type": "github_commit", "user": "mrbeam", + "force_base": false, "dependencies": { "mrbeam-ledstrips": { "repo": "MrBeamLedStrips", "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", "global_pip_command": true, "displayVersion": "-", - "pip_command": "sudo /usr/local/bin/pip", - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" - } - } + "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" }, "iobeam": { "repo": "iobeam", "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", "global_pip_command": true, "displayVersion": "-", - "pip_command": "sudo /usr/local/bin/pip", - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" - } - } + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" }, "mrb-hw-info": { "repo": "mrb_hw_info", "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", "global_pip_command": true, "displayVersion": "-", - "pip_command": "sudo /usr/local/bin/pip", - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" - } - } + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" }, "mrbeamdoc": { "pip": "https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip", @@ -74,7 +60,7 @@ ] } ], - "release_compare": "unequal", + "release_compare": "python_unequal", "tiers": { "stable": { "branch": "mrbeam2-stable", diff --git a/tests/softwareupdate/target_mrbeam_config_legacy.json b/tests/softwareupdate/target_mrbeam_config_legacy.json new file mode 100644 index 000000000..0d685098e --- /dev/null +++ b/tests/softwareupdate/target_mrbeam_config_legacy.json @@ -0,0 +1,99 @@ +{ + "displayName": " MrBeam Plugin", + "repo": "MrBeamPlugin", + "restart": "environment", + "pip": "https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", + "type": "github_commit", + "user": "mrbeam", + "force_base": false, + "dependencies": { + "mrbeam-ledstrips": { + "repo": "MrBeamLedStrips", + "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + }, + "iobeam": { + "repo": "iobeam", + "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + }, + "mrb-hw-info": { + "repo": "mrb_hw_info", + "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", + "global_pip_command": true, + "displayVersion": "-", + "pip_command": "sudo /usr/local/bin/pip", + }, + "mrbeamdoc": { + "pip": "https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip", + "repo": "MrBeamDoc", + "displayVersion": "dummy" + } + }, + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ], + "release_compare": "python_unequal", + "tiers": { + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha", + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release", + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script_relative_path": "scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + } + }, + "displayVersion": "dummy" +} \ No newline at end of file diff --git a/tests/softwareupdate/target_netconnectd_config.json b/tests/softwareupdate/target_netconnectd_config.json index 349d4de7b..e910f3fc8 100644 --- a/tests/softwareupdate/target_netconnectd_config.json +++ b/tests/softwareupdate/target_netconnectd_config.json @@ -6,18 +6,14 @@ "pip": "https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", "restart": "environment", "type": "github_commit", + "force_base": false, "dependencies": { "netconnectd": { "displayVersion": "-", "repo": "netconnectd_mrbeam", "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", "global_pip_command": true, - "pip_command": "sudo /usr/local/bin/pip", - "beamos_date": { - "2021-06-11": { - "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip", - } - } + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" } }, "stable_branch": { @@ -46,7 +42,7 @@ ] } ], - "release_compare": "unequal", + "release_compare": "python_unequal", "tiers": { "stable": { "branch": "mrbeam2-stable", diff --git a/tests/softwareupdate/target_netconnectd_config_legacy.json b/tests/softwareupdate/target_netconnectd_config_legacy.json new file mode 100644 index 000000000..49542b738 --- /dev/null +++ b/tests/softwareupdate/target_netconnectd_config_legacy.json @@ -0,0 +1,81 @@ +{ + "displayVersion": "dummy", + "displayName": "OctoPrint-Netconnectd Plugin", + "user": "mrbeam", + "repo": "OctoPrint-Netconnectd", + "pip": "https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", + "restart": "environment", + "type": "github_commit", + "force_base": false, + "dependencies": { + "netconnectd": { + "displayVersion": "-", + "repo": "netconnectd_mrbeam", + "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", + "global_pip_command": true, + "pip_command": "sudo /usr/local/bin/pip", + "version": "0.0.1" + } + }, + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ], + "release_compare": "python_unequal", + "tiers": { + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha", + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/../octoprint_netconnectd/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release", + "update_folder": "/tmp/octoprint/netconnectd", + "update_script_relative_path": "../octoprint_netconnectd/scripts/update_script.py", + "update_script": "{python} 'octoprint_mrbeam/../octoprint_netconnectd/scripts/update_script.py' --branch={branch} --force={force} '{folder}' {target}", + "methode": "update_script" + } + } +} \ No newline at end of file diff --git a/tests/softwareupdate/target_octoprint_config.json b/tests/softwareupdate/target_octoprint_config.json index 2f982a437..4c4b33380 100644 --- a/tests/softwareupdate/target_octoprint_config.json +++ b/tests/softwareupdate/target_octoprint_config.json @@ -5,7 +5,8 @@ "user": "mrbeam", "branch": "alpha", "branch_default": "alpha", - "release_compare": "unequal", + "force_base": false, + "release_compare": "python_unequal", "stable_branch": { "branch": "stable", "name": "stable", @@ -41,7 +42,8 @@ "user": "mrbeam", "branch": "mrbeam2-beta", "branch_default": "mrbeam2-beta", - "release_compare": "unequal", + "force_base": false, + "release_compare": "python_unequal", "stable_branch": { "branch": "stable", "name": "stable", @@ -75,9 +77,10 @@ "prerelease": true, "restart": "environment", "user": "mrbeam", - "branch": "mrbeam2-alpha", - "branch_default": "mrbeam2-alpha", - "release_compare": "unequal", + "branch": "alpha", + "branch_default": "alpha", + "force_base": false, + "release_compare": "python_unequal", "stable_branch": { "branch": "stable", "name": "stable", @@ -111,7 +114,8 @@ "user": "mrbeam", "branch": "mrbeam2-stable", "branch_default": "mrbeam2-stable", - "release_compare": "unequal", + "force_base": false, + "release_compare": "python_unequal", "stable_branch": { "branch": "stable", "name": "stable", diff --git a/tests/softwareupdate/test_cloud_config.py b/tests/softwareupdate/test_cloud_config.py index 3b263f070..df95526fc 100644 --- a/tests/softwareupdate/test_cloud_config.py +++ b/tests/softwareupdate/test_cloud_config.py @@ -10,10 +10,10 @@ import requests import requests_mock from copy import deepcopy -from datetime import date, datetime from mock import mock_open from mock import patch from octoprint.events import EventManager +from packaging import version import yaml from octoprint_mrbeam import ( @@ -98,6 +98,7 @@ class SoftwareupdateConfigTestCase(unittest.TestCase): def setUp(self): self.plugin = MrBeamPluginDummy() + self.mock_major_tag_version = 1 with open( os.path.join(dirname(realpath(__file__)), "target_octoprint_config.json") ) as json_file: @@ -112,10 +113,22 @@ def setUp(self): os.path.join(dirname(realpath(__file__)), "target_netconnectd_config.json") ) as json_file: self.target_netconnectd_config = yaml.safe_load(json_file) + with open( + os.path.join( + dirname(realpath(__file__)), "target_netconnectd_config_legacy.json" + ) + ) as json_file: + self.target_netconnectd_config_legacy = yaml.safe_load(json_file) with open( os.path.join(dirname(realpath(__file__)), "target_mrbeam_config.json") ) as json_file: self.target_mrbeam_config = yaml.safe_load(json_file) + with open( + os.path.join( + dirname(realpath(__file__)), "target_mrbeam_config_legacy.json" + ) + ) as json_file: + self.target_mrbeam_config_legacy = yaml.safe_load(json_file) with open( os.path.join(dirname(realpath(__file__)), "mock_config.json") ) as json_file: @@ -186,13 +199,13 @@ def test_server_not_reachable(self, show_notifications_mock, get_notification_mo ) show_notifications_mock.assert_called_once() - @patch.object(DeviceInfo, "get_beamos_version") + @patch.object(DeviceInfo, "get_beamos_version_number") def test_cloud_config_buster_online(self, device_info_mock): """ Testcase to test the buster config with the online available cloud config Args: - device_info_mock: mocks the device info to change the image date + device_info_mock: mocks the device info to change the image version Returns: None @@ -200,8 +213,8 @@ def test_cloud_config_buster_online(self, device_info_mock): self.maxDiff = None self.check_if_githubapi_rate_limit_exceeded() self.maxDiff = None - beamos_date_buster = date(2021, 6, 11) - device_info_mock.return_value = "PROD", beamos_date_buster + beamos_version_buster = "0.18.0" + device_info_mock.return_value = beamos_version_buster plugin = self.plugin with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: # test for all tiers @@ -214,34 +227,36 @@ def test_cloud_config_buster_online(self, device_info_mock): self.target_octoprint_config[_get_tier_by_id(tier)], ) self.validate_mrbeam_module_config( - update_config["mrbeam"], _get_tier_by_id(tier), beamos_date_buster + update_config["mrbeam"], + _get_tier_by_id(tier), + beamos_version_buster, ) self.validate_findmymrbeam_module_config( update_config["findmymrbeam"], _get_tier_by_id(tier), - beamos_date_buster, + beamos_version_buster, ) self.validate_netconnect_module_config( update_config["netconnectd"], _get_tier_by_id(tier), - beamos_date_buster, + beamos_version_buster, ) - @patch.object(DeviceInfo, "get_beamos_version") + @patch.object(DeviceInfo, "get_beamos_version_number") def test_cloud_confg_legacy_online(self, device_info_mock): """ Testcase to test the leagcy image config with the online available cloud config Args: - device_info_mock: mocks the device info to change the image date + device_info_mock: mocks the device info to change the image version Returns: None """ self.check_if_githubapi_rate_limit_exceeded() self.maxDiff = None - beamos_date_legacy = date(2018, 1, 12) - device_info_mock.return_value = "PROD", beamos_date_legacy + beamos_version_legacy = "0.14.0" + device_info_mock.return_value = beamos_version_legacy with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: plugin = self.plugin @@ -255,32 +270,34 @@ def test_cloud_confg_legacy_online(self, device_info_mock): self.target_octoprint_config[_get_tier_by_id(tier)], ) self.validate_mrbeam_module_config( - update_config["mrbeam"], _get_tier_by_id(tier), beamos_date_legacy + update_config["mrbeam"], + _get_tier_by_id(tier), + beamos_version_legacy, ) self.validate_findmymrbeam_module_config( update_config["findmymrbeam"], _get_tier_by_id(tier), - beamos_date_legacy, + beamos_version_legacy, ) self.validate_netconnect_module_config( update_config["netconnectd"], _get_tier_by_id(tier), - beamos_date_legacy, + beamos_version_legacy, ) - @patch.object(DeviceInfo, "get_beamos_version") + @patch.object(DeviceInfo, "get_beamos_version_number") def test_cloud_confg_buster_mock(self, device_info_mock): """ tests the update info with a mocked server response Args: - device_info_mock: mocks the device info to change the image date + device_info_mock: mocks the device info to change the image version Returns: None """ - beamos_date_buster = date(2021, 6, 11) - device_info_mock.return_value = "PROD", beamos_date_buster + beamos_version_buster = "0.18.0" + device_info_mock.return_value = beamos_version_buster with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: with requests_mock.Mocker() as rm: rm.get( @@ -288,12 +305,14 @@ def test_cloud_confg_buster_mock(self, device_info_mock): status_code=200, json=[ { - "name": "v0.0.2-mock", + "name": "v{}.0.2-mock".format(self.mock_major_tag_version), } ], ) rm.get( - "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v{}.0.2-mock".format( + self.mock_major_tag_version + ), status_code=200, json={ "content": base64.urlsafe_b64encode( @@ -315,35 +334,35 @@ def test_cloud_confg_buster_mock(self, device_info_mock): self.validate_mrbeam_module_config( update_config["mrbeam"], _get_tier_by_id(tier), - beamos_date_buster, + beamos_version_buster, ) self.validate_findmymrbeam_module_config( update_config["findmymrbeam"], _get_tier_by_id(tier), - beamos_date_buster, + beamos_version_buster, ) self.validate_netconnect_module_config( update_config["netconnectd"], _get_tier_by_id(tier), - beamos_date_buster, + beamos_version_buster, ) mock_file.assert_called_with( TMP_BASE_FOLDER_PATH + SW_UPDATE_INFO_FILE_NAME, "w" ) - @patch.object(DeviceInfo, "get_beamos_version") + @patch.object(DeviceInfo, "get_beamos_version_number") def test_cloud_confg_legacy_mock(self, device_info_mock): """ tests the updateinfo hook for the legacy image Args: - device_info_mock: mocks the device info to change the image date + device_info_mock: mocks the device info to change the image version Returns: None """ - beamos_date_legacy = date(2018, 1, 12) - device_info_mock.return_value = "PROD", beamos_date_legacy + beamos_version_legacy = "0.14.0" + device_info_mock.return_value = beamos_version_legacy with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: with requests_mock.Mocker() as rm: rm.get( @@ -351,12 +370,14 @@ def test_cloud_confg_legacy_mock(self, device_info_mock): status_code=200, json=[ { - "name": "v0.0.2-mock", + "name": "v{}.0.2-mock".format(self.mock_major_tag_version), } ], ) rm.get( - "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v{}.0.2-mock".format( + self.mock_major_tag_version + ), status_code=200, json={ "content": base64.urlsafe_b64encode( @@ -372,6 +393,7 @@ def test_cloud_confg_legacy_mock(self, device_info_mock): update_config = get_update_information(plugin) print("config {}".format(update_config)) + self.maxDiff = None self.assertEquals( update_config["octoprint"], self.target_octoprint_config[_get_tier_by_id(tier)], @@ -379,17 +401,17 @@ def test_cloud_confg_legacy_mock(self, device_info_mock): self.validate_mrbeam_module_config( update_config["mrbeam"], _get_tier_by_id(tier), - beamos_date_legacy, + beamos_version_legacy, ) self.validate_findmymrbeam_module_config( update_config["findmymrbeam"], _get_tier_by_id(tier), - beamos_date_legacy, + beamos_version_legacy, ) self.validate_netconnect_module_config( update_config["netconnectd"], _get_tier_by_id(tier), - beamos_date_legacy, + beamos_version_legacy, ) mock_file.assert_called_with( TMP_BASE_FOLDER_PATH + SW_UPDATE_INFO_FILE_NAME, "w" @@ -425,12 +447,14 @@ def test_cloud_confg_fileerror( status_code=200, json=[ { - "name": "v0.0.2-mock", + "name": "v{}.0.2-mock".format(self.mock_major_tag_version), } ], ) rm.get( - "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v0.0.2-mock", + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v{}.0.2-mock".format( + self.mock_major_tag_version + ), status_code=200, json={ "content": base64.urlsafe_b64encode(json.dumps(self.mock_config)) @@ -446,71 +470,58 @@ def test_cloud_confg_fileerror( ) user_notification_system_show_mock.assert_called_once() - def validate_mrbeam_module_config(self, update_config, tier, beamos_date): + def validate_mrbeam_module_config(self, update_config, tier, beamos_version): """ validates the config of the mrbeam software module Args: update_config: update config tier: software tier - beamos_date: date of the beamos image + beamos_version: version of the beamos image Returns: None """ - self.validate_module_config( - update_config, tier, self.target_mrbeam_config, beamos_date - ) + if beamos_version >= "0.18.0": + target_config = self.target_mrbeam_config + else: + target_config = self.target_mrbeam_config_legacy + self.validate_module_config(update_config, tier, target_config, beamos_version) - def validate_findmymrbeam_module_config(self, update_config, tier, beamos_date): + def validate_findmymrbeam_module_config(self, update_config, tier, beamos_version): """ validates the config of a the findmymrbeam software module Args: update_config: update config tier: software tier - beamos_date: date of the beamos image + beamos_version: version of the beamos image Returns: None """ self.validate_module_config( - update_config, tier, self.target_find_my_mr_beam_config, beamos_date + update_config, tier, self.target_find_my_mr_beam_config, beamos_version ) - def validate_netconnect_module_config(self, update_config, tier, beamos_date): + def validate_netconnect_module_config(self, update_config, tier, beamos_version): """ validates the config of a the netconnectd software module Args: update_config: update config tier: software tier - beamos_date: date of the beamos image + beamos_version: version of the beamos image Returns: None """ - self.validate_module_config( - update_config, tier, self.target_netconnectd_config, beamos_date - ) - - def _set_beamos_config(self, config, beamos_date=None): - """ - generates the updateinformation for a given beamos image date - - Args: - config: update config - beamos_date: beamos image date + if beamos_version >= "0.18.0": + target_config = self.target_netconnectd_config + else: + target_config = self.target_netconnectd_config_legacy - Returns: - updateinformation for the given beamos image date - """ - if "beamos_date" in config: - for date, beamos_config in config["beamos_date"].items(): - if beamos_date >= datetime.strptime(date, "%Y-%m-%d").date(): - config = dict_merge(config, beamos_config) - config.pop("beamos_date") - return config + self.validate_module_config(update_config, tier, target_config, beamos_version) def _set_tier_config(self, config, tier): """ @@ -529,7 +540,7 @@ def _set_tier_config(self, config, tier): return config def validate_module_config( - self, update_config, tier, target_module_config, beamos_date + self, update_config, tier, target_module_config, beamos_version ): """ validates the updateinfromation fot the given software module @@ -538,20 +549,16 @@ def validate_module_config( update_config: update config tier: software tier target_module_config: software module to validate - beamos_date: beamos image date + beamos_version: beamos image version Returns: None """ copy_target_config = deepcopy(target_module_config) - self._set_beamos_config(copy_target_config, beamos_date) if "dependencies" in copy_target_config: for dependencie_name, dependencie_config in copy_target_config[ "dependencies" ].items(): - dependencie_config = self._set_beamos_config( - dependencie_config, beamos_date - ) dependencie_config = self._set_tier_config(dependencie_config, tier) copy_target_config["dependencies"][ dependencie_name diff --git a/tests/softwareupdate/test_comparison.py b/tests/softwareupdate/test_comparison.py new file mode 100644 index 000000000..e4799c8ee --- /dev/null +++ b/tests/softwareupdate/test_comparison.py @@ -0,0 +1,137 @@ +import operator +import unittest + +import pkg_resources + +from octoprint_mrbeam.software_update_information import ( + VersionComperator, + _generate_config_of_beamos, + get_config_for_version, +) + + +def bla(comp1, comparision_options): + return VersionComperator.get_comperator(comp1, comparision_options).priority + + +class VersionCaomparisionTestCase(unittest.TestCase): + def setUp(self): + self.le_element = {"__le__": {"0.17.0": {"value": 3}}} + self.ge_element = { + "__ge__": { + "0.18.0": {"value": 2}, + "0.14.0": {"value": 1}, + "0.18.1": {"value": 5}, + "1.0.0": {"value": 6}, + } + } + self.eq_element = {"__eq__": {"0.16.5": {"value": 4}}} + self.config = {} + self.config.update(self.ge_element) + self.config.update(self.le_element) + self.config.update(self.eq_element) + self.comparision_options = [ + VersionComperator("__eq__", 5, operator.eq), + VersionComperator("__le__", 4, operator.le), + VersionComperator("__lt__", 3, operator.lt), + VersionComperator("__ge__", 2, operator.ge), + VersionComperator("__gt__", 1, operator.gt), + ] + + def test_sorted(self): + print(self.config) + config = sorted( + self.config, + cmp=lambda comp1, comp2: cmp( + bla(comp1, self.comparision_options), + bla(comp2, self.comparision_options), + ), + ) + self.assertEquals(config, ["__ge__", "__le__", "__eq__"]), + + def test_compare(self): + config = sorted( + self.config.items(), + key=lambda com: VersionComperator.get_comperator( + com[0], self.comparision_options + ).priority, + ) + print(config) + + self.assertEquals( + 2, + get_config_for_version("0.18.0", config, self.comparision_options).get( + "value" + ), + ) + self.assertEquals( + 1, + get_config_for_version("0.17.1", config, self.comparision_options).get( + "value" + ), + ) + self.assertEquals( + 3, + get_config_for_version("0.16.8", config, self.comparision_options).get( + "value" + ), + ) + self.assertEquals( + 4, + get_config_for_version("0.16.5", config, self.comparision_options).get( + "value" + ), + ) + self.assertEquals( + 5, + get_config_for_version("0.18.2", config, self.comparision_options).get( + "value" + ), + ) + self.assertEquals( + 6, + get_config_for_version("1.0.0", config, self.comparision_options).get( + "value" + ), + ) + # only support major minor patch so far + # self.assertEquals( + # 1, + # get_config_for_version("0.17.5.pre0", config, self.comparision_options).get( + # "value" + # ), + # ) + # self.assertEquals( + # 1, + # get_config_for_version("0.18.0a0", config, self.comparision_options).get( + # "value" + # ), + # ) + + def test_generate_config_of_beamos(self): + config = { + "repo": "netconnectd_mrbeam", + "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", + "global_pip_command": True, + "beamos_date": { + "2021-06-11": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + } + }, + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + } + }, + "__le__": {"0.14.0": {"version": "0.0.1"}}, + }, + } + + self.assertEquals( + _generate_config_of_beamos(config, "0.14.0", "stable").get("version"), + "0.0.1", + ) + self.assertEquals( + _generate_config_of_beamos(config, "0.18.0", "stable").get("version"), None + ) From 7531b2491266f5010f3861e0665e49e61df18c2a Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Wed, 27 Apr 2022 11:44:06 +0200 Subject: [PATCH 07/15] SW-1237 develop tier wont install commit based version(#1466) * Added force reinstall option in update script to be able to update from a version to a commit --- octoprint_mrbeam/scripts/update_script.py | 1 + 1 file changed, 1 insertion(+) diff --git a/octoprint_mrbeam/scripts/update_script.py b/octoprint_mrbeam/scripts/update_script.py index 290e6ee8b..ec6844950 100644 --- a/octoprint_mrbeam/scripts/update_script.py +++ b/octoprint_mrbeam/scripts/update_script.py @@ -218,6 +218,7 @@ def install_wheels(install_queue): "install", "--disable-pip-version-check", "--upgrade", # Upgrade all specified packages to the newest available version. The handling of dependencies depends on the upgrade-strategy used. + "--force-reinstall", # Reinstall all packages even if they are already up-to-date. "--no-index", # Ignore package index (only looking at --find-links URLs instead). "--find-links={}".format(tmp_folder), # If a URL or path to an html file, then parse for links to archives such as sdist (.tar.gz) or wheel (.whl) files. If a local path or file:// URL that's a directory, then look for archives in the directory listing. Links to VCS project URLs are not supported. "--no-dependencies", # Don't install package dependencies. From 3f257e894a8223cb50f32642a11074a638b5e416 Mon Sep 17 00:00:00 2001 From: Ahmed Salem <85931758+ahmed-mrbeam@users.noreply.github.com> Date: Wed, 27 Apr 2022 11:46:14 +0200 Subject: [PATCH 08/15] SW-1208-mr-beam-plugin-will-break-if-cam-last-session-yaml-contains-null-chars (#1459) * Refactored the method load_camera_settings to handle a corrupt last_session.yaml file properly * Added more exception handling * Created constants for used paths to files --- octoprint_mrbeam/iobeam/lid_handler.py | 80 ++++++++++++++++---------- 1 file changed, 50 insertions(+), 30 deletions(-) diff --git a/octoprint_mrbeam/iobeam/lid_handler.py b/octoprint_mrbeam/iobeam/lid_handler.py index 7dc39369f..a0270b2f6 100644 --- a/octoprint_mrbeam/iobeam/lid_handler.py +++ b/octoprint_mrbeam/iobeam/lid_handler.py @@ -63,7 +63,8 @@ SIMILAR_PICS_BEFORE_REFRESH = 20 MAX_PIC_THREAD_RETRIES = 2 - +CAMERA_SETTINGS_LAST_SESSION_YAML = "/home/pi/.octoprint/cam/last_session.yaml" +CAMERA_SETTINGS_FALLBACK_JSON = "/home/pi/.octoprint/cam/last_markers.json" from octoprint_mrbeam.iobeam.iobeam_handler import IoBeamEvents from octoprint.events import Events as OctoPrintEvents @@ -1317,39 +1318,58 @@ def _createFolder_if_not_existing(self, filename): makedirs(folder) self._logger.debug("Created folder '%s' for camera images.", folder) - def load_camera_settings(self, path="/home/pi/.octoprint/cam/last_session.yaml"): + def load_camera_settings(self, path=CAMERA_SETTINGS_LAST_SESSION_YAML): """ - Loads the settings saved from the last session. - The file is located by default at .octoprint/cam/pic_settings.yaml + Loads and returns the camera settings. + + Args: + path (str): path to the camera settings Yaml to load from + + Returns: + (list): ["calibMarkers", "shutter_speed"] + """ - backup = "/home/pi/.octoprint/cam/last_markers.json" - if os.path.isfile(path): - _path = path - else: - self._logger.info( - "last_session.yaml does not exist, using legacy backup (last_markers.json)" + + # To Be used in case the default file not there or invalid + backup_path = CAMERA_SETTINGS_FALLBACK_JSON + camera_settings = [] + + # 1. Load from default + try: + with open(path) as f: + settings = yaml.safe_load(f) + for k in ["calibMarkers", "shutter_speed"]: + camera_settings.append(settings.get(k, None)) + self._logger.debug("lid_handler: Default camera settings loaded from file: {}".format(path)) + return camera_settings + except(IOError, OSError, yaml.YAMLError, yaml.reader.ReaderError, AttributeError) as e: + if os.path.isfile(path): + # An extra step to insure a smooth experience moving forward + os.remove(path) + self._logger.warn( + "lid_handler: File: {} does not exist or invalid, Will try to use legacy backup_path...: {}".format( + path, backup_path) ) - _path = backup + + # 2. Load from Backup try: - ret = [] - with open(_path) as f: - settings = yaml.load(f) or {} - if _path == backup: - # No shutter speed info - settings = {k: v[-1] for k, v in settings.items()} - ret = [settings, None] - else: - for k in ["calibMarkers", "shutter_speed"]: - ret.append(settings.get(k, None)) - return ret - except (IOError, OSError) as e: - self._logger.warning("New or Legacy marker memory not found.") - return [None] * 2 + with open(backup_path) as f: + settings = yaml.safe_load(f) + # No shutter speed info present in this file + settings = {k: v[-1] for k, v in settings.items()} + camera_settings = [settings, None] + self._logger.debug("lid_handler: Fallback camera settings loaded from file: {}".format(backup_path)) + return camera_settings + except(IOError, OSError, yaml.YAMLError, yaml.reader.ReaderError, AttributeError) as e: + self._logger.exception( + "lid_handler: File: {} does not exist or invalid, Camera Settings Load failed".format(backup_path) + ) + return [None, None] # @logme(True) def save_camera_settings( self, - path="/home/pi/.octoprint/cam/last_session.yaml", + path=CAMERA_SETTINGS_LAST_SESSION_YAML, markers=None, shutter_speed=None, ): @@ -1371,10 +1391,10 @@ def save_camera_settings( settings = {} try: with open(path) as f: - settings = yaml.load(f) - except (OSError, IOError) as e: + settings = yaml.safe_load(f) + except (OSError, IOError, yaml.YAMLError, yaml.reader.ReaderError, AttributeError) as e: self._logger.warning( - "file %s does not exist or could not be read. Overwriting..." % path + "lid_handler: file %s does not exist or could not be read. Overwriting..." % path ) settings = dict_merge( @@ -1389,7 +1409,7 @@ def save_camera_settings( try: with open(path, "w") as f: f.write(yaml.dump(settings)) - except (OSError, IOError) as e: + except (OSError, IOError, yaml.YAMLError) as e: self._logger.error(e) except TypeError as e: self._logger.warning( From 973c1119e7f67ab6ffd26b02477f82f2e72921b8 Mon Sep 17 00:00:00 2001 From: khaledsherkawi <54568489+khaledsherkawi@users.noreply.github.com> Date: Thu, 28 Apr 2022 10:37:40 +0200 Subject: [PATCH 09/15] SW-1155 g code files created via pixel based images sv gs engrave some parts more than once (#1475) * Complete removal of other raster cluster content than the current. * Enlargement only on text elements. Authored-by: Teja --- octoprint_mrbeam/static/js/render_fills.js | 40 ++++++++++++++-------- octoprint_mrbeam/static/js/snap_helpers.js | 15 ++++++++ octoprint_mrbeam/static/js/working_area.js | 25 +++++++++----- 3 files changed, 56 insertions(+), 24 deletions(-) diff --git a/octoprint_mrbeam/static/js/render_fills.js b/octoprint_mrbeam/static/js/render_fills.js index 2fd2f944b..919a25d64 100644 --- a/octoprint_mrbeam/static/js/render_fills.js +++ b/octoprint_mrbeam/static/js/render_fills.js @@ -127,10 +127,12 @@ Snap.plugin(function (Snap, Element, Paper, global) { let rasterEl = marked[i]; let bbox; try { - bbox = rasterEl.get_total_bbox(); - } - catch(error) { - console.warn(`Getting bounding box for ${rasterEl} failed.`, error); + bbox = rasterEl.get_total_bbox(); + } catch (error) { + console.warn( + `Getting bounding box for ${rasterEl} failed.`, + error + ); continue; } // find overlaps @@ -172,13 +174,14 @@ Snap.plugin(function (Snap, Element, Paper, global) { rasterEl.addClass(`rasterCluster${c}`) ); let tmpSvg = svg.clone(); - tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).forEach((element) => { - let elementToBeRemoved = tmpSvg.select('#' + element.attr('id')); - let elementsToBeExcluded = ["text", "tspan"] - if (elementToBeRemoved && !elementsToBeExcluded.includes(elementToBeRemoved.type)) { - elementToBeRemoved.remove(); - } - }); + tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).remove(); + // tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).forEach((element) => { + // let elementToBeRemoved = tmpSvg.select('#' + element.attr('id')); + // let elementsToBeExcluded = ["text", "tspan"] + // if (elementToBeRemoved && !elementsToBeExcluded.includes(elementToBeRemoved.type)) { + // elementToBeRemoved.remove(); + // } + // }); // Fix IDs of filter references, those are not cloned correct (probably because reference is in style="..." definition) tmpSvg.fixIds("defs filter[mb\\:id]", "mb:id"); // namespace attribute selectors syntax: [ns\\:attrname] // DON'T fix IDs of textPath references, they're cloned correct. @@ -335,10 +338,17 @@ Snap.plugin(function (Snap, Element, Paper, global) { // ); } - // TODO only enlarge on images and fonts - // Quick fix: in some browsers the bbox is too tight, so we just add an extra 10% to all the sides, making the height and width 20% larger in total - const enlargement_x = 0.4; // percentage of the width added to each side - const enlargement_y = 0.4; // percentage of the height added to each side + // only enlarge on fonts, images not necessary. + const doEnlargeBBox = + elem.selectAll("text").filter((e) => { + const bb = e.getBBox(); + // this filter is required, as every quick text creates an empty text element (for switching between curved and straight text) + return bb.width > 0 && bb.height > 0; + }).length > 0; + + // Quick fix: in some browsers the bbox is too tight, so we just add an extra margin to all the sides, making the height and width larger in total + const enlargement_x = doEnlargeBBox ? 0.4 : 0; // percentage of the width added to each side + const enlargement_y = doEnlargeBBox ? 0.4 : 0; // percentage of the height added to each side const x1 = Math.max(0, bbox.x - bbox.width * enlargement_x); const x2 = Math.min(wMM, bbox.x2 + bbox.width * enlargement_x); const w = x2 - x1; diff --git a/octoprint_mrbeam/static/js/snap_helpers.js b/octoprint_mrbeam/static/js/snap_helpers.js index dea6f94b4..99aec5265 100644 --- a/octoprint_mrbeam/static/js/snap_helpers.js +++ b/octoprint_mrbeam/static/js/snap_helpers.js @@ -66,4 +66,19 @@ Snap.plugin(function (Snap, Element, Paper, global) { const bb = el.getBBox(); return Snap.path.getBBoxWithTransformation(bb, mat); }; + + /** + * filter method for Snap Set like we know it from Array + * @param f function which decides wether to keep or discard set elements + * @returns {Set} a new Snap set + */ + Snap.Set.prototype.filter = function (f) { + const s = new Snap.Set(); + this.forEach((e) => { + if (f(e)) { + s.push(e); + } + }); + return s; + }; }); diff --git a/octoprint_mrbeam/static/js/working_area.js b/octoprint_mrbeam/static/js/working_area.js index 0caecdbb7..f5e872914 100644 --- a/octoprint_mrbeam/static/js/working_area.js +++ b/octoprint_mrbeam/static/js/working_area.js @@ -1193,16 +1193,23 @@ $(function () { if (generator.generator === "inkscape") { let isOldInkscapeVersion = NaN; try { - isOldInkscapeVersion= window.compareVersions( - // 1.1.2 (1:1.1+202202050950+0a00cf5339) -> 1.1 - generator.version.split('.').slice(0,2).join('.'), - "0.91" - ) <= 0; - } catch(e) { + isOldInkscapeVersion = + window.compareVersions( + // 1.1.2 (1:1.1+202202050950+0a00cf5339) -> 1.1 + generator.version + .split(".") + .slice(0, 2) + .join("."), + "0.91" + ) <= 0; + } catch (e) { let payload = { error: e.message, }; - self._sendAnalytics("inkscape_version_comparison_error", payload); + self._sendAnalytics( + "inkscape_version_comparison_error", + payload + ); console.log("inkscape_version_comparison_error: ", e); // In case the comparison fails, we assume the version to be above 0.91 // This assumption (the scaling) does not have a major impact as it has @@ -1707,7 +1714,7 @@ $(function () { } else if ( event.target.classList.contains("unit_percent") ) { - const newWidth = + let newWidth = ((currentWidth / Math.abs(currentSx)) * value) / 100.0; if (Math.abs(newWidth) < 0.1) @@ -1751,7 +1758,7 @@ $(function () { } else if ( event.target.classList.contains("unit_percent") ) { - const newHeight = + let newHeight = ((currentHeight / Math.abs(currentSy)) * value) / 100.0; if (Math.abs(newHeight) < 0.1) From f64e4bb59e7a8eef3aefcd305be44aa22a79ec76 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Thu, 28 Apr 2022 16:27:57 +0200 Subject: [PATCH 10/15] SW-1223 don't show the update failed info message on boot (#1463) * add user clicked update flag * redirect softwareupdateplugin check for update to our endpoint if the user clicked on it * refactor fallback update config for offline * remove not needed debug output * refactored the notifications to use a function to follow DRY * extended logging to include errorcodes * added testcase for E-1003 error message --- octoprint_mrbeam/__init__.py | 11 ++ .../rest_handler/update_handler.py | 12 +- .../software_update_information.py | 135 +++++++------- .../static/js/software_channel_selector.js | 15 +- .../mock_config_relative_path_missing.json | 172 ++++++++++++++++++ tests/softwareupdate/test_cloud_config.py | 95 ++++++---- 6 files changed, 332 insertions(+), 108 deletions(-) create mode 100644 tests/softwareupdate/mock_config_relative_path_missing.json diff --git a/octoprint_mrbeam/__init__.py b/octoprint_mrbeam/__init__.py index b0ae5321d..f22d00e69 100644 --- a/octoprint_mrbeam/__init__.py +++ b/octoprint_mrbeam/__init__.py @@ -175,6 +175,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 = [] @@ -738,6 +739,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): diff --git a/octoprint_mrbeam/rest_handler/update_handler.py b/octoprint_mrbeam/rest_handler/update_handler.py index 3f8b27f82..d3d32fc9e 100644 --- a/octoprint_mrbeam/rest_handler/update_handler.py +++ b/octoprint_mrbeam/rest_handler/update_handler.py @@ -1,4 +1,4 @@ -from octoprint.server import NO_CONTENT +from flask import request import octoprint.plugin @@ -12,5 +12,11 @@ class UpdateRestHandlerMixin: @octoprint.plugin.BlueprintPlugin.route("/info/update", methods=["POST"]) def update_update_informations(self): - reload_update_info(self) - return NO_CONTENT + clicked_by_user = False + if hasattr(request, "json") and request.json: + data = request.json + clicked_by_user = data.get("user", False) + reload_update_info(self, clicked_by_user) + return self._plugin_manager.get_plugin_info( + "softwareupdate" + ).implementation.check_for_update() diff --git a/octoprint_mrbeam/software_update_information.py b/octoprint_mrbeam/software_update_information.py index d497269b0..ca4e9d00d 100644 --- a/octoprint_mrbeam/software_update_information.py +++ b/octoprint_mrbeam/software_update_information.py @@ -54,6 +54,34 @@ class SWUpdateTier(Enum): BEAMOS_LEGACY_VERSION = "0.14.0" BEAMOS_LEGACY_DATE = date(2018, 1, 12) # still used in the migrations +FALLBACK_UPDATE_CONFIG = { + "mrbeam": { + "name": " MrBeam Plugin", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, + "netconnectd": { + "name": "OctoPrint-Netconnectd Plugin", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, + "findmymrbeam": { + "name": "OctoPrint-FindMyMrBeam", + "type": "github_commit", + "user": "", + "repo": "", + "pip": "", + }, +} + + +class UpdateFetchingInformationException(Exception): + pass + def get_tag_of_github_repo(repo): """ @@ -149,12 +177,9 @@ def get_update_information(plugin): else: _logger.warn("no internet connection") - user_notification_system = plugin.user_notification_system - user_notification_system.show_notifications( - user_notification_system.get_notification( - notification_id="missing_updateinformation_info", replay=False - ) - ) + _logger.error("No information about available updates could be retrieved E-1000 explicit check:{}".format( + plugin.explicit_update_check)) + software_update_notify(plugin, notification_id="missing_updateinformation_info") # mark update config as dirty sw_update_plugin = plugin._plugin_manager.get_plugin_info( @@ -168,32 +193,7 @@ def get_update_information(plugin): plugin, tier, beamos_version, - { - "default": {}, - "modules": { - "mrbeam": { - "name": " MrBeam Plugin", - "type": "github_commit", - "user": "", - "repo": "", - "pip": "", - }, - "netconnectd": { - "name": "OctoPrint-Netconnectd Plugin", - "type": "github_commit", - "user": "", - "repo": "", - "pip": "", - }, - "findmymrbeam": { - "name": "OctoPrint-FindMyMrBeam", - "type": "github_commit", - "user": "", - "repo": "", - "pip": "", - }, - }, - }, + {}, ) @@ -229,6 +229,7 @@ def switch_software_channel(plugin, channel): Returns: None """ + _logger.debug("switch_software_channel") old_channel = plugin._settings.get(["dev", "software_tier"]) if channel in software_channels_available(plugin) and channel != old_channel: _logger.info("Switching software channel to: {channel}".format(channel=channel)) @@ -236,7 +237,7 @@ def switch_software_channel(plugin, channel): reload_update_info(plugin) -def reload_update_info(plugin): +def reload_update_info(plugin, clicked_by_user=False): """ clears the version cache and refires the get_update_info hook Args: @@ -245,6 +246,9 @@ def reload_update_info(plugin): Returns: None """ + if clicked_by_user: + plugin.set_explicit_update_check() + _logger.debug("Reload update info") # fmt: off @@ -300,15 +304,16 @@ def _set_info_from_cloud_config(plugin, tier, beamos_version, cloud_config): module_id, module, defaultsettings, tier, beamos_version, plugin ) except softwareupdate_exceptions.ConfigurationInvalid as e: - _logger.exception("ConfigurationInvalid {}".format(e)) - user_notification_system = plugin.user_notification_system - user_notification_system.show_notifications( - user_notification_system.get_notification( - notification_id="update_fetching_information_err", - err_msg=["E-1003"], - replay=False, - ) - ) + _logger.exception( + "ConfigurationInvalid {}, will use fallback dummy instead E-1003 explicit check:{}".format(e, + plugin.explicit_update_check)) + sw_update_config = FALLBACK_UPDATE_CONFIG + software_update_notify(plugin, notification_id="update_fetching_information_err", err_msg=["E-1003"]) + except UpdateFetchingInformationException as e: + _logger.exception( + "UpdateFetchingInformationException {}, will use fallback dummy instead - explicit check:{}".format(e, + plugin.explicit_update_check)) + sw_update_config = FALLBACK_UPDATE_CONFIG _logger.debug("sw_update_config {}".format(sw_update_config)) @@ -319,18 +324,27 @@ def _set_info_from_cloud_config(plugin, tier, beamos_version, cloud_config): with open(sw_update_file_path, "w") as f: f.write(json.dumps(sw_update_config)) except (IOError, TypeError): - plugin._logger.error("can't create update info file") - user_notification_system = plugin.user_notification_system - user_notification_system.show_notifications( - user_notification_system.get_notification( - notification_id="write_error_update_info_file_err", replay=False - ) - ) - return None + _logger.exception( + "can't create update info file, will use fallback dummy instead E-1001 explicit check:{}".format( + plugin.explicit_update_check)) + sw_update_config = FALLBACK_UPDATE_CONFIG + software_update_notify(plugin, notification_id="write_error_update_info_file_err") - return sw_update_config else: - return None + sw_update_config = FALLBACK_UPDATE_CONFIG + + plugin.clear_explicit_update_check() + return sw_update_config + + +def software_update_notify(plugin, notification_id, err_msg=[]): + if plugin.explicit_update_check: + user_notification_system = plugin.user_notification_system + user_notification_system.show_notifications( + user_notification_system.get_notification( + notification_id=notification_id, replay=False, err_msg=err_msg + ) + ) def _generate_config_of_module( @@ -384,19 +398,10 @@ def _generate_config_of_module( if not os.path.isdir(input_moduleconfig["update_folder"]): os.makedirs(input_moduleconfig["update_folder"]) except (IOError, OSError) as e: - _logger.error( - "could not create folder {} e:{}".format( - input_moduleconfig["update_folder"], e - ) - ) - user_notification_system = plugin.user_notification_system - user_notification_system.show_notifications( - user_notification_system.get_notification( - notification_id="update_fetching_information_err", - err_msg=["E-1002"], - replay=False, - ) - ) + software_update_notify(plugin, notification_id="update_fetching_information_err", err_msg=["E-1002"]) + raise UpdateFetchingInformationException("could not create folder {} E-1002 e:{}".format( + input_moduleconfig["update_folder"], e + )) update_script_path = os.path.join( plugin._basefolder, input_moduleconfig["update_script_relative_path"] ) diff --git a/octoprint_mrbeam/static/js/software_channel_selector.js b/octoprint_mrbeam/static/js/software_channel_selector.js index 6b5d48fc9..327ff1713 100644 --- a/octoprint_mrbeam/static/js/software_channel_selector.js +++ b/octoprint_mrbeam/static/js/software_channel_selector.js @@ -95,11 +95,12 @@ $(function () { // get the hook when softwareUpdate perform the Updatecheck to force the update on the normal button self.performCheck_copy = self.softwareUpdate.performCheck; self.softwareUpdate.performCheck= function(showIfNothingNew, force, ignoreSeen) { - self.reload_update_info(); if (force !== undefined) { force = true; //only forces the update check if it was disabled ("check for update" button press) + self.reload_update_info(showIfNothingNew, force, ignoreSeen, true); //if use clicked update forward to our reload endpoint + }else { + self.performCheck_copy(showIfNothingNew, force, ignoreSeen); } - self.performCheck_copy(showIfNothingNew, force, ignoreSeen); }; /** @@ -127,14 +128,18 @@ $(function () { ); button.addClass("sticky-footer"); }; - self.reload_update_info = function(){ - OctoPrint.post("plugin/mrbeam/info/update") + self.reload_update_info = function(showIfNothingNew, force, ignoreSeen, user_clicked=false){ + self.softwareUpdate.checking(true); + OctoPrint.postJson("plugin/mrbeam/info/update", {user:user_clicked}) .done(function (response) { + self.fromCheckResponse(response, ignoreSeen, showIfNothingNew); }) .fail(function (error) { console.error("Unable to reload update info."); self.analytics.send_fontend_event("update_info_call_failure", {error_message: error}) - console.error("test"); + }) + .always(function(){ + self.softwareUpdate.checking(false); }); } } diff --git a/tests/softwareupdate/mock_config_relative_path_missing.json b/tests/softwareupdate/mock_config_relative_path_missing.json new file mode 100644 index 000000000..84443d2ae --- /dev/null +++ b/tests/softwareupdate/mock_config_relative_path_missing.json @@ -0,0 +1,172 @@ +{ + "default": { + "type": "github_commit", + "user": "mrbeam", + "release_compare": "python_unequal", + "force_base": false, + "stable": { + "branch": "mrbeam2-stable", + "branch_default": "mrbeam2-stable", + "type": "github_commit" + }, + "beta": { + "branch": "mrbeam2-beta", + "branch_default": "mrbeam2-beta", + "type": "github_commit", + "prerelease_channel": "beta", + "prerelease": true + }, + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha" + }, + "alpha": { + "branch": "mrbeam2-alpha", + "branch_default": "mrbeam2-alpha", + "prerelease_channel": "alpha", + "prerelease": true, + "type": "github_release" + }, + "restart": "environment", + "stable_branch": { + "branch": "stable", + "name": "stable", + "commitish": [ + "stable" + ] + }, + "prerelease_branches": [ + { + "name": "alpha", + "branch": "alpha", + "commitish": [ + "alpha", + "beta", + "stable" + ] + }, + { + "name": "beta", + "branch": "beta", + "commitish": [ + "beta", + "stable" + ] + } + ] + }, + "modules": { + "octoprint": { + "type": "github_release", + "develop": { + "type": "github_commit", + "branch": "alpha", + "branch_default": "alpha" + }, + "alpha": { + "branch": "alpha", + "branch_default": "alpha" + } + }, + "mrbeam": { + "name": " MrBeam Plugin", + "repo": "MrBeamPlugin", + "restart": "environment", + "pip": "https://github.com/mrbeam/MrBeamPlugin/archive/{target_version}.zip", + "develop": { + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "alpha": { + "update_folder": "/tmp/octoprint/mrbeamplugin", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "dependencies": { + "mrbeam-ledstrips": { + "repo": "MrBeamLedStrips", + "pip": "https://github.com/mrbeam/MrBeamLedStrips/archive/{target_version}.zip", + "global_pip_command": true, + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/mrbeam_ledstrips/venv/bin/pip" + } + } + } + }, + "iobeam": { + "repo": "iobeam", + "pip": "git+ssh://git@bitbucket.org/mrbeam/iobeam.git@{target_version}", + "global_pip_command": true, + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + } + }, + "mrb-hw-info": { + "repo": "mrb_hw_info", + "pip": "git+ssh://git@bitbucket.org/mrbeam/mrb_hw_info.git@{target_version}", + "global_pip_command": true, + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/iobeam/venv/bin/pip" + } + } + } + }, + "mrbeamdoc": { + "repo": "MrBeamDoc", + "pip": "https://github.com/mrbeam/MrBeamDoc/archive/{target_version}.zip" + } + } + }, + "netconnectd": { + "name": "OctoPrint-Netconnectd Plugin", + "repo": "OctoPrint-Netconnectd", + "pip": "https://github.com/mrbeam/OctoPrint-Netconnectd/archive/{target_version}.zip", + "restart": "environment", + "dependencies": { + "netconnectd": { + "repo": "netconnectd_mrbeam", + "pip": "https://github.com/mrbeam/netconnectd_mrbeam/archive/{target_version}.zip", + "global_pip_command": true, + "beamos_version": { + "__ge__": { + "0.18.0": { + "pip_command": "sudo /usr/local/netconnectd/venv/bin/pip" + } + }, + "__le__": { + "0.14.0": { + "version": "0.0.1" + } + } + } + } + }, + "develop": { + "update_folder": "/tmp/octoprint/netconnectd", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + }, + "alpha": { + "update_folder": "/tmp/octoprint/netconnectd", + "update_script": "{{python}} '{update_script}' --branch={{branch}} --force={{force}} '{{folder}}' {{target}}", + "methode": "update_script" + } + }, + "findmymrbeam": { + "name": "OctoPrint-FindMyMrBeam", + "repo": "OctoPrint-FindMyMrBeam", + "pip": "https://github.com/mrbeam/OctoPrint-FindMyMrBeam/archive/{target_version}.zip", + "restart": "octoprint" + } + } +} \ No newline at end of file diff --git a/tests/softwareupdate/test_cloud_config.py b/tests/softwareupdate/test_cloud_config.py index df95526fc..807d16a98 100644 --- a/tests/softwareupdate/test_cloud_config.py +++ b/tests/softwareupdate/test_cloud_config.py @@ -28,6 +28,7 @@ get_update_information, SW_UPDATE_INFO_FILE_NAME, SW_UPDATE_TIERS, + FALLBACK_UPDATE_CONFIG, ) from octoprint_mrbeam.user_notification_system import UserNotificationSystem from octoprint_mrbeam.util import dict_merge @@ -133,6 +134,10 @@ def setUp(self): os.path.join(dirname(realpath(__file__)), "mock_config.json") ) as json_file: self.mock_config = yaml.safe_load(json_file) + with open( + os.path.join(dirname(realpath(__file__)), "mock_config_relative_path_missing.json") + ) as json_file: + self.mock_config_relative_path_missing = yaml.safe_load(json_file) @patch.object( UserNotificationSystem, @@ -153,52 +158,71 @@ def test_server_not_reachable(self, show_notifications_mock, get_notification_mo Returns: None """ + get_notification_mock.return_value = None + plugin = self.plugin + plugin.set_explicit_update_check() + + with requests_mock.Mocker() as rm: + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/tags", + json={"test": "test"}, + status_code=404, + ) + rm.get( + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=vNone", + status_code=404, + ) + update_config = get_update_information(plugin) + assert update_config == FALLBACK_UPDATE_CONFIG + show_notifications_mock.assert_called_with( + err_msg=[], notification_id="missing_updateinformation_info", replay=False + ) + show_notifications_mock.assert_called_once() + + + @patch.object( + UserNotificationSystem, + "show_notifications", + ) + @patch.object( + UserNotificationSystem, + "get_notification", + ) + def test_update_script_relative_path_message(self, show_notifications_mock, get_notification_mock): with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: get_notification_mock.return_value = None - plugin = self.plugin - with requests_mock.Mocker() as rm: + plugin = self.plugin + plugin.set_explicit_update_check() rm.get( "https://api.github.com/repos/mrbeam/beamos_config/tags", - json={"test": "test"}, - status_code=404, + status_code=200, + json=[ + { + "name": "v{}.0.2-mock".format(self.mock_major_tag_version), + } + ], ) rm.get( - "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=vNone", - status_code=404, + "https://api.github.com/repos/mrbeam/beamos_config/contents/docs/sw-update-conf.json?ref=v{}.0.2-mock".format( + self.mock_major_tag_version + ), + status_code=200, + json={ + "content": base64.urlsafe_b64encode( + json.dumps(self.mock_config_relative_path_missing) + ) + }, ) update_config = get_update_information(plugin) - assert update_config == { - "findmymrbeam": { - "displayName": "OctoPrint-FindMyMrBeam", - "displayVersion": "dummy", - "pip": "", - "repo": "", - "type": "github_commit", - "user": "", - }, - "mrbeam": { - "displayName": " MrBeam Plugin", - "displayVersion": "dummy", - "pip": "", - "repo": "", - "type": "github_commit", - "user": "", - }, - "netconnectd": { - "displayName": "OctoPrint-Netconnectd Plugin", - "displayVersion": "dummy", - "pip": "", - "repo": "", - "type": "github_commit", - "user": "", - }, - } + assert update_config == FALLBACK_UPDATE_CONFIG + show_notifications_mock.assert_called_with( - notification_id="missing_updateinformation_info", replay=False + err_msg=["E-1003"], notification_id="update_fetching_information_err", replay=False ) show_notifications_mock.assert_called_once() + @patch.object(DeviceInfo, "get_beamos_version_number") def test_cloud_config_buster_online(self, device_info_mock): """ @@ -461,12 +485,13 @@ def test_cloud_confg_fileerror( }, ) plugin = self.plugin + plugin.set_explicit_update_check() update_config = get_update_information(plugin) - self.assertIsNone(update_config) + self.assertEquals(update_config, FALLBACK_UPDATE_CONFIG) user_notification_system_show_mock.assert_called_with( - notification_id="write_error_update_info_file_err", replay=False + err_msg=[], notification_id="write_error_update_info_file_err", replay=False ) user_notification_system_show_mock.assert_called_once() From f3233c09d178629843699d512d5c816b9b73a0ea Mon Sep 17 00:00:00 2001 From: Josef-MrBeam Date: Thu, 28 Apr 2022 16:43:00 +0200 Subject: [PATCH 11/15] fix merge conflict --- octoprint_mrbeam/__version.py | 1 - 1 file changed, 1 deletion(-) delete mode 100644 octoprint_mrbeam/__version.py diff --git a/octoprint_mrbeam/__version.py b/octoprint_mrbeam/__version.py deleted file mode 100644 index 828b5be06..000000000 --- a/octoprint_mrbeam/__version.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.10.4-beta" From d34b77bc01f61f2bc2d76dec34b1e5f247c73ff2 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam <81746291+Josef-MrBeam@users.noreply.github.com> Date: Thu, 28 Apr 2022 17:20:15 +0200 Subject: [PATCH 12/15] SW-1223 fix bug that the update spinner won't stop and a error message logged in the frontend (#1477) --- octoprint_mrbeam/static/js/software_channel_selector.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/octoprint_mrbeam/static/js/software_channel_selector.js b/octoprint_mrbeam/static/js/software_channel_selector.js index 327ff1713..166a07146 100644 --- a/octoprint_mrbeam/static/js/software_channel_selector.js +++ b/octoprint_mrbeam/static/js/software_channel_selector.js @@ -132,7 +132,7 @@ $(function () { self.softwareUpdate.checking(true); OctoPrint.postJson("plugin/mrbeam/info/update", {user:user_clicked}) .done(function (response) { - self.fromCheckResponse(response, ignoreSeen, showIfNothingNew); + self.softwareUpdate.fromCheckResponse(response, ignoreSeen, showIfNothingNew); }) .fail(function (error) { console.error("Unable to reload update info."); From 679a2616bbf67d26e916e61e4b36275b1de795ad Mon Sep 17 00:00:00 2001 From: khaledsherkawi Date: Tue, 10 May 2022 12:11:06 +0200 Subject: [PATCH 13/15] Revert "SW-1155 g code files created via pixel based images sv gs engrave some parts more than once (#1475)" This reverts commit 973c1119e7f67ab6ffd26b02477f82f2e72921b8. --- octoprint_mrbeam/static/js/render_fills.js | 40 ++++++++-------------- octoprint_mrbeam/static/js/snap_helpers.js | 15 -------- octoprint_mrbeam/static/js/working_area.js | 25 +++++--------- 3 files changed, 24 insertions(+), 56 deletions(-) diff --git a/octoprint_mrbeam/static/js/render_fills.js b/octoprint_mrbeam/static/js/render_fills.js index 919a25d64..2fd2f944b 100644 --- a/octoprint_mrbeam/static/js/render_fills.js +++ b/octoprint_mrbeam/static/js/render_fills.js @@ -127,12 +127,10 @@ Snap.plugin(function (Snap, Element, Paper, global) { let rasterEl = marked[i]; let bbox; try { - bbox = rasterEl.get_total_bbox(); - } catch (error) { - console.warn( - `Getting bounding box for ${rasterEl} failed.`, - error - ); + bbox = rasterEl.get_total_bbox(); + } + catch(error) { + console.warn(`Getting bounding box for ${rasterEl} failed.`, error); continue; } // find overlaps @@ -174,14 +172,13 @@ Snap.plugin(function (Snap, Element, Paper, global) { rasterEl.addClass(`rasterCluster${c}`) ); let tmpSvg = svg.clone(); - tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).remove(); - // tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).forEach((element) => { - // let elementToBeRemoved = tmpSvg.select('#' + element.attr('id')); - // let elementsToBeExcluded = ["text", "tspan"] - // if (elementToBeRemoved && !elementsToBeExcluded.includes(elementToBeRemoved.type)) { - // elementToBeRemoved.remove(); - // } - // }); + tmpSvg.selectAll(`.toRaster:not(.rasterCluster${c})`).forEach((element) => { + let elementToBeRemoved = tmpSvg.select('#' + element.attr('id')); + let elementsToBeExcluded = ["text", "tspan"] + if (elementToBeRemoved && !elementsToBeExcluded.includes(elementToBeRemoved.type)) { + elementToBeRemoved.remove(); + } + }); // Fix IDs of filter references, those are not cloned correct (probably because reference is in style="..." definition) tmpSvg.fixIds("defs filter[mb\\:id]", "mb:id"); // namespace attribute selectors syntax: [ns\\:attrname] // DON'T fix IDs of textPath references, they're cloned correct. @@ -338,17 +335,10 @@ Snap.plugin(function (Snap, Element, Paper, global) { // ); } - // only enlarge on fonts, images not necessary. - const doEnlargeBBox = - elem.selectAll("text").filter((e) => { - const bb = e.getBBox(); - // this filter is required, as every quick text creates an empty text element (for switching between curved and straight text) - return bb.width > 0 && bb.height > 0; - }).length > 0; - - // Quick fix: in some browsers the bbox is too tight, so we just add an extra margin to all the sides, making the height and width larger in total - const enlargement_x = doEnlargeBBox ? 0.4 : 0; // percentage of the width added to each side - const enlargement_y = doEnlargeBBox ? 0.4 : 0; // percentage of the height added to each side + // TODO only enlarge on images and fonts + // Quick fix: in some browsers the bbox is too tight, so we just add an extra 10% to all the sides, making the height and width 20% larger in total + const enlargement_x = 0.4; // percentage of the width added to each side + const enlargement_y = 0.4; // percentage of the height added to each side const x1 = Math.max(0, bbox.x - bbox.width * enlargement_x); const x2 = Math.min(wMM, bbox.x2 + bbox.width * enlargement_x); const w = x2 - x1; diff --git a/octoprint_mrbeam/static/js/snap_helpers.js b/octoprint_mrbeam/static/js/snap_helpers.js index 99aec5265..dea6f94b4 100644 --- a/octoprint_mrbeam/static/js/snap_helpers.js +++ b/octoprint_mrbeam/static/js/snap_helpers.js @@ -66,19 +66,4 @@ Snap.plugin(function (Snap, Element, Paper, global) { const bb = el.getBBox(); return Snap.path.getBBoxWithTransformation(bb, mat); }; - - /** - * filter method for Snap Set like we know it from Array - * @param f function which decides wether to keep or discard set elements - * @returns {Set} a new Snap set - */ - Snap.Set.prototype.filter = function (f) { - const s = new Snap.Set(); - this.forEach((e) => { - if (f(e)) { - s.push(e); - } - }); - return s; - }; }); diff --git a/octoprint_mrbeam/static/js/working_area.js b/octoprint_mrbeam/static/js/working_area.js index 5aab39df8..07b192375 100644 --- a/octoprint_mrbeam/static/js/working_area.js +++ b/octoprint_mrbeam/static/js/working_area.js @@ -1201,23 +1201,16 @@ $(function () { if (generator.generator === "inkscape") { let isOldInkscapeVersion = NaN; try { - isOldInkscapeVersion = - window.compareVersions( - // 1.1.2 (1:1.1+202202050950+0a00cf5339) -> 1.1 - generator.version - .split(".") - .slice(0, 2) - .join("."), - "0.91" - ) <= 0; - } catch (e) { + isOldInkscapeVersion= window.compareVersions( + // 1.1.2 (1:1.1+202202050950+0a00cf5339) -> 1.1 + generator.version.split('.').slice(0,2).join('.'), + "0.91" + ) <= 0; + } catch(e) { let payload = { error: e.message, }; - self._sendAnalytics( - "inkscape_version_comparison_error", - payload - ); + self._sendAnalytics("inkscape_version_comparison_error", payload); console.log("inkscape_version_comparison_error: ", e); // In case the comparison fails, we assume the version to be above 0.91 // This assumption (the scaling) does not have a major impact as it has @@ -1722,7 +1715,7 @@ $(function () { } else if ( event.target.classList.contains("unit_percent") ) { - let newWidth = + const newWidth = ((currentWidth / Math.abs(currentSx)) * value) / 100.0; if (Math.abs(newWidth) < 0.1) @@ -1766,7 +1759,7 @@ $(function () { } else if ( event.target.classList.contains("unit_percent") ) { - let newHeight = + const newHeight = ((currentHeight / Math.abs(currentSy)) * value) / 100.0; if (Math.abs(newHeight) < 0.1) From d8552316b11b1884d7e3fd326680bc27b31dcfb4 Mon Sep 17 00:00:00 2001 From: Josef-MrBeam Date: Tue, 10 May 2022 17:11:31 +0200 Subject: [PATCH 14/15] SW-1273 include stable release version numbers in dependencies --- octoprint_mrbeam/dependencies.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/octoprint_mrbeam/dependencies.txt b/octoprint_mrbeam/dependencies.txt index ec8ffd62e..e5e372fbb 100644 --- a/octoprint_mrbeam/dependencies.txt +++ b/octoprint_mrbeam/dependencies.txt @@ -1,4 +1,4 @@ -iobeam==1.0.0a0 -mrb-hw-info==1.0.0a0 -mrbeam-ledstrips==1.0.0a0 -mrbeamdoc==1.0.0a0 \ No newline at end of file +iobeam==1.0.0 +mrb-hw-info==1.0.0 +mrbeam-ledstrips==1.0.0 +mrbeamdoc==1.0.0 \ No newline at end of file From afc5a983d86538770141562fc3c91fa96f8a262c Mon Sep 17 00:00:00 2001 From: Josef-MrBeam Date: Tue, 3 May 2022 09:02:24 +0200 Subject: [PATCH 15/15] prepare for github release patcher plugin --- octoprint_mrbeam/software_update_information.py | 5 +++-- octoprint_mrbeam/util/__init__.py | 1 + octoprint_mrbeam/util/github_api.py | 8 ++++---- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/octoprint_mrbeam/software_update_information.py b/octoprint_mrbeam/software_update_information.py index ca4e9d00d..d2a844ab9 100644 --- a/octoprint_mrbeam/software_update_information.py +++ b/octoprint_mrbeam/software_update_information.py @@ -17,7 +17,7 @@ from octoprint_mrbeam.mrb_logger import mrb_logger from octoprint_mrbeam.util import dict_merge, logExceptions -from octoprint_mrbeam.util.github_api import get_file_of_repo_for_tag +from octoprint_mrbeam.util.github_api import get_file_of_repo_for_tag, REPO_URL from util.pip_util import get_version_of_pip_module @@ -96,7 +96,8 @@ def get_tag_of_github_repo(repo): import json try: - url = "https://api.github.com/repos/mrbeam/{repo}/tags".format(repo=repo) + url = "{repo_url}/tags".format(repo_url=REPO_URL.format(repo=repo)) + headers = { "Accept": "application/json", } diff --git a/octoprint_mrbeam/util/__init__.py b/octoprint_mrbeam/util/__init__.py index 6ce0eb721..1750974ff 100644 --- a/octoprint_mrbeam/util/__init__.py +++ b/octoprint_mrbeam/util/__init__.py @@ -10,6 +10,7 @@ import threading from .log import logExceptions, logtime, logme +from . import github_api if sys.version_info >= (3,): _basestring = str diff --git a/octoprint_mrbeam/util/github_api.py b/octoprint_mrbeam/util/github_api.py index cf277b509..5267647e1 100644 --- a/octoprint_mrbeam/util/github_api.py +++ b/octoprint_mrbeam/util/github_api.py @@ -12,7 +12,7 @@ import json _logger = mrb_logger("octoprint.plugins.mrbeam.util.github_api") - +REPO_URL = "https://api.github.com/repos/mrbeam/{repo}" def get_file_of_repo_for_tag(file, repo, tag): """ @@ -27,8 +27,8 @@ def get_file_of_repo_for_tag(file, repo, tag): content of file """ try: - url = "https://api.github.com/repos/mrbeam/{repo}/contents/{file}?ref={tag}".format( - repo=repo, file=file, tag=tag + url = "{repo_url}/contents/{file}?ref={tag}".format( + repo_url=REPO_URL.format(repo=repo), file=file, tag=tag ) headers = { @@ -46,7 +46,7 @@ def get_file_of_repo_for_tag(file, repo, tag): _logger.warning("timeout while trying to get the file") return None except ConnectionError: - _logger.warning("connection error while trying to get the file") + _logger.warning("connection error while trying to get the file {}".format(url)) return None if response: