diff --git a/src/Mod/AddonManager/addonmanager_git.py b/src/Mod/AddonManager/addonmanager_git.py
index 5cbc089291..f56f32bd4f 100644
--- a/src/Mod/AddonManager/addonmanager_git.py
+++ b/src/Mod/AddonManager/addonmanager_git.py
@@ -194,7 +194,7 @@ class GitManager:
# This only works with git 2.22 and later (June 2019)
# branch = self._synchronous_call_git(["branch", "--show-current"]).strip()
- # This is more universal:
+ # This is more universal (albeit more opaque to the reader):
branch = self._synchronous_call_git(["rev-parse", "--abbrev-ref", "HEAD"]).strip()
except GitFailed as e:
os.chdir(old_dir)
diff --git a/src/Mod/AddonManager/addonmanager_macro.py b/src/Mod/AddonManager/addonmanager_macro.py
index bb05f7ff0b..129bcd3e7e 100644
--- a/src/Mod/AddonManager/addonmanager_macro.py
+++ b/src/Mod/AddonManager/addonmanager_macro.py
@@ -21,29 +21,24 @@
# * *
# ***************************************************************************
+""" Unified handler for FreeCAD macros that can be obtained from different sources. """
+
import os
import re
import io
import codecs
import shutil
-import time
-from urllib.parse import urlparse
-from typing import Dict, Tuple, List, Union
+from html import unescape
+from typing import Dict, Tuple, List, Union, Optional
import FreeCAD
import NetworkManager
from PySide2 import QtCore
-translate = FreeCAD.Qt.translate
-
from addonmanager_utilities import remove_directory_if_empty, is_float
-try:
- from HTMLParser import HTMLParser
+translate = FreeCAD.Qt.translate
- unescape = HTMLParser().unescape
-except ImportError:
- from html import unescape
# @package AddonManager_macro
# \ingroup ADDONMANAGER
@@ -52,9 +47,10 @@ except ImportError:
# @{
-class Macro(object):
+class Macro:
"""This class provides a unified way to handle macros coming from different sources"""
+ # pylint: disable=too-many-instance-attributes
def __init__(self, name):
self.name = name
self.on_wiki = False
@@ -70,6 +66,7 @@ class Macro(object):
self.src_filename = ""
self.author = ""
self.icon = ""
+ self.icon_source = None
self.xpm = "" # Possible alternate icon data
self.other_files = []
self.parsed = False
@@ -78,7 +75,9 @@ class Macro(object):
return self.filename == other.filename
@classmethod
- def from_cache(self, cache_dict: Dict):
+ def from_cache(cls, cache_dict: Dict):
+ """Use data from the cache dictionary to create a new macro, returning a reference
+ to it."""
instance = Macro(cache_dict["name"])
for key, value in cache_dict.items():
instance.__dict__[key] = value
@@ -91,11 +90,15 @@ class Macro(object):
@property
def filename(self):
+ """The filename of this macro"""
if self.on_git:
return os.path.basename(self.src_filename)
return (self.name + ".FCMacro").replace(" ", "_")
def is_installed(self):
+ """Returns True if this macro is currently installed (that is, if it exists in the
+ user macro directory), or False if it is not. Both the exact filename, as well as
+ the filename prefixed with "Macro", are considered an installation of this macro."""
if self.on_git and not self.src_filename:
return False
return os.path.exists(
@@ -105,12 +108,15 @@ class Macro(object):
)
def fill_details_from_file(self, filename: str) -> None:
- with open(filename, errors="replace") as f:
+ """Opens the given Macro file and parses it for its metadata"""
+ with open(filename, errors="replace", encoding="utf-8") as f:
self.code = f.read()
self.fill_details_from_code(self.code)
def fill_details_from_code(self, code: str) -> None:
- # Number of parsed fields of metadata. Overrides anything set previously (the code is considered authoritative).
+ """Reads in the macro code from the given string and parses it for its metadata."""
+ # Number of parsed fields of metadata. Overrides anything set previously (the code is
+ # considered authoritative).
# For now:
# __Comment__
# __Web__
@@ -153,76 +159,39 @@ class Macro(object):
if lowercase_line.startswith(key):
_, _, after_equals = line.partition("=")
match = re.match(string_search_regex, after_equals)
+
# We do NOT support triple-quoted strings, except for the icon XPM data
+ # Most cases should be caught by this code
if match and '"""' not in after_equals:
- if type(self.__dict__[value]) == str:
- self.__dict__[value] = match.group(2)
- elif type(self.__dict__[value]) == list:
- self.__dict__[value] = [
- of.strip() for of in match.group(2).split(",")
- ]
+ self._standard_extraction(value, match.group(2))
string_search_mapping.pop(key)
break
- else:
- # Macro authors are supposed to be providing strings here, but in some
- # cases they are not doing so. If this is the "__version__" tag, try
- # to apply some special handling to accepts numbers, and "__date__"
- if key == "__version__":
- if "__date__" in after_equals.lower():
- FreeCAD.Console.PrintLog(
- translate(
- "AddonsInstaller",
- "In macro {}, string literal not found for {} element. Guessing at intent and using string from date element.",
- ).format(self.name, key)
- + "\n"
- )
- self.version = self.date
- break
- elif is_float(after_equals):
- FreeCAD.Console.PrintLog(
- translate(
- "AddonsInstaller",
- "In macro {}, string literal not found for {} element. Guessing at intent and using string representation of contents.",
- ).format(self.name, key)
- + "\n"
- )
- self.version = str(after_equals).strip()
- break
- elif key == "__icon__" or key == "__xpm__":
- # If this is an icon, it's possible that the icon was actually directly specified
- # in the file as XPM data. This data **must** be between triple double quotes in
- # order for the Addon Manager to recognize it.
- if '"""' in after_equals:
- _, _, xpm_data = after_equals.partition('"""')
- while True:
- line = f.readline()
- if not line:
- FreeCAD.Console.PrintError(
- translate(
- "AddonsInstaller",
- "Syntax error while reading {} from macro {}",
- ).format(key, self.name)
- + "\n"
- )
- break
- if '"""' in line:
- last_line, _, _ = line.partition('"""')
- xpm_data += last_line
- break
- else:
- xpm_data += line
- self.xpm = xpm_data
- break
- FreeCAD.Console.PrintError(
- translate(
- "AddonsInstaller",
- "Syntax error while reading {} from macro {}",
- ).format(key, self.name)
- + "\n"
- )
- FreeCAD.Console.PrintError(line + "\n")
- continue
+ # For cases where either there is no match, or we found a triple quote,
+ # more processing is needed
+
+ # Macro authors are supposed to be providing strings here, but in some
+ # cases they are not doing so. If this is the "__version__" tag, try
+ # to apply some special handling to accepts numbers, and "__date__"
+ if key == "__version__":
+ self._process_noncompliant_version(after_equals)
+ string_search_mapping.pop(key)
+ break
+
+ # Icon data can be actual embedded XPM data, inside a triple-quoted string
+ if key in ("__icon__", "__xpm__"):
+ self._process_icon(f, key, after_equals)
+ string_search_mapping.pop(key)
+ break
+
+ FreeCAD.Console.PrintError(
+ translate(
+ "AddonsInstaller",
+ "Syntax error while reading {} from macro {}",
+ ).format(key, self.name)
+ + "\n"
+ )
+ FreeCAD.Console.PrintError(line + "\n")
# Do some cleanup of the values:
if self.comment:
@@ -237,7 +206,56 @@ class Macro(object):
self.parsed = True
+ def _standard_extraction(self, value: str, match_group):
+ """For most macro metadata values, this extracts the required data"""
+ if isinstance(self.__dict__[value], str):
+ self.__dict__[value] = match_group
+ elif isinstance(self.__dict__[value], list):
+ self.__dict__[value] = [of.strip() for of in match_group.split(",")]
+ else:
+ FreeCAD.Console.PrintError(
+ "Internal Error: bad type in addonmanager_macro class.\n"
+ )
+
+ def _process_noncompliant_version(self, after_equals):
+ if "__date__" in after_equals.lower():
+ self.version = self.date
+ elif is_float(after_equals):
+ self.version = str(after_equals).strip()
+ else:
+ FreeCAD.Console.PrintLog(
+ f"Unrecognized value for __version__ in macro {self.name}"
+ )
+ self.version = "(Unknown)"
+
+ def _process_icon(self, f, key, after_equals):
+ # If this is an icon, it's possible that the icon was actually directly
+ # specified in the file as XPM data. This data **must** be between
+ # triple double quotes in order for the Addon Manager to recognize it.
+ if '"""' in after_equals:
+ _, _, xpm_data = after_equals.partition('"""')
+ while True:
+ line = f.readline()
+ if not line:
+ FreeCAD.Console.PrintError(
+ translate(
+ "AddonsInstaller",
+ "Syntax error while reading {} from macro {}",
+ ).format(key, self.name)
+ + "\n"
+ )
+ break
+ if '"""' in line:
+ last_line, _, _ = line.partition('"""')
+ xpm_data += last_line
+ break
+ xpm_data += line
+ self.xpm = xpm_data
+
def fill_details_from_wiki(self, url):
+ """For a given URL, download its data and attempt to get the macro's metadata out of
+ it. If the macro's code is hosted elsewhere, as specified by a "rawcodeurl" found on
+ the wiki page, that code is downloaded and used as the source."""
code = ""
p = NetworkManager.AM_NETWORK_MANAGER.blocking_get(url)
if not p:
@@ -253,36 +271,15 @@ class Macro(object):
# check if the macro page has its code hosted elsewhere, download if
# needed
if "rawcodeurl" in p:
- self.raw_code_url = re.findall('rawcodeurl.*?href="(http.*?)">', p)
- if self.raw_code_url:
- self.raw_code_url = self.raw_code_url[0]
- u2 = NetworkManager.AM_NETWORK_MANAGER.blocking_get(self.raw_code_url)
- if not u2:
- FreeCAD.Console.PrintWarning(
- translate(
- "AddonsInstaller",
- "Unable to open macro code URL {rawcodeurl}",
- ).format(self.raw_code_url)
- + "\n"
- )
- return
- code = u2.data().decode("utf8")
+ code = self._fetch_raw_code(p)
if not code:
- code = re.findall(r"(.*?)
", p.replace("\n", "--endl--"))
- if code:
- # take the biggest code block
- code = sorted(code, key=len)[-1]
- code = code.replace("--endl--", "\n")
- # Clean HTML escape codes.
- code = unescape(code)
- code = code.replace(b"\xc2\xa0".decode("utf-8"), " ")
- else:
- FreeCAD.Console.PrintWarning(
- translate(
- "AddonsInstaller", "Unable to fetch the code of this macro."
- )
- + "\n"
- )
+ code = self._read_code_from_wiki(p)
+ if not code:
+ FreeCAD.Console.PrintWarning(
+ translate("AddonsInstaller", "Unable to fetch the code of this macro.")
+ + "\n"
+ )
+ return
desc = re.findall(
r"(.*?) | ",
@@ -304,10 +301,7 @@ class Macro(object):
self.comment = re.sub("<.*?>", "", self.comment) # Strip any tags
self.url = url
if isinstance(code, list):
- flat_code = ""
- for chunk in code:
- flat_code += chunk
- code = flat_code
+ code = "".join(code)
self.code = code
self.fill_details_from_code(self.code)
if not self.icon and not self.xpm:
@@ -319,7 +313,39 @@ class Macro(object):
if not self.date:
self.date = self.parse_desc("Last modified: ")
+ def _fetch_raw_code(self, page_data) -> Optional[str]:
+ """Fetch code from the rawcodeurl specified on the wiki page."""
+ code = None
+ self.raw_code_url = re.findall('rawcodeurl.*?href="(http.*?)">', page_data)
+ if self.raw_code_url:
+ self.raw_code_url = self.raw_code_url[0]
+ u2 = NetworkManager.AM_NETWORK_MANAGER.blocking_get(self.raw_code_url)
+ if not u2:
+ FreeCAD.Console.PrintWarning(
+ translate(
+ "AddonsInstaller",
+ "Unable to open macro code URL {rawcodeurl}",
+ ).format(self.raw_code_url)
+ + "\n"
+ )
+ return None
+ code = u2.data().decode("utf8")
+ return code
+
+ def _read_code_from_wiki(self, p: str) -> Optional[str]:
+ code = re.findall(r"(.*?)
", p.replace("\n", "--endl--"))
+ if code:
+ # take the biggest code block
+ code = sorted(code, key=len)[-1]
+ code = code.replace("--endl--", "\n")
+ # Clean HTML escape codes.
+ code = unescape(code)
+ code = code.replace(b"\xc2\xa0".decode("utf-8"), " ")
+ return code
+
def clean_icon(self):
+ """Downloads the macro's icon from whatever source is specified and stores a local
+ copy, potentially updating the interal icon location to that local storage."""
if self.icon.startswith("http://") or self.icon.startswith("https://"):
FreeCAD.Console.PrintLog(
f"Attempting to fetch macro icon from {self.icon}\n"
@@ -332,6 +358,7 @@ class Macro(object):
_, _, filename = self.icon.rpartition("/")
base, _, extension = filename.rpartition(".")
if base.lower().startswith("file:"):
+ # pylint: disable=line-too-long
FreeCAD.Console.PrintMessage(
f"Cannot use specified icon for {self.name}, {self.icon} is not a direct download link\n"
)
@@ -343,17 +370,20 @@ class Macro(object):
self.icon_source = self.icon
self.icon = constructed_name
else:
+ # pylint: disable=line-too-long
FreeCAD.Console.PrintLog(
f"MACRO DEVELOPER WARNING: failed to download icon from {self.icon} for macro {self.name}\n"
)
self.icon = ""
def parse_desc(self, line_start: str) -> Union[str, None]:
+ """Get data from the wiki for the value specified by line_start."""
components = self.desc.split(">")
for component in components:
if component.startswith(line_start):
end = component.find("<")
return component[len(line_start) : end]
+ return None
def install(self, macro_dir: str) -> Tuple[bool, List[str]]:
"""Install a macro and all its related files
@@ -378,12 +408,23 @@ class Macro(object):
return False, [f"Failed to write {macro_path}"]
# Copy related files, which are supposed to be given relative to
# self.src_filename.
- base_dir = os.path.dirname(self.src_filename)
warnings = []
+ self._copy_icon_data(macro_dir, warnings)
+ success = self._copy_other_files(macro_dir, warnings)
+
+ if warnings or not success > 0:
+ return False, warnings
+
+ FreeCAD.Console.PrintLog(f"Macro {self.name} was installed successfully.\n")
+ return True, []
+
+ def _copy_icon_data(self, macro_dir, warnings):
+ """Copy any available icon data into the install directory"""
+ base_dir = os.path.dirname(self.src_filename)
if self.xpm:
xpm_file = os.path.join(base_dir, self.name + "_icon.xpm")
- with open(xpm_file, "w") as f:
+ with open(xpm_file, "w", encoding="utf-8") as f:
f.write(self.xpm)
if self.icon:
if os.path.isabs(self.icon):
@@ -397,6 +438,8 @@ class Macro(object):
elif self.icon not in self.other_files:
self.other_files.append(self.icon)
+ def _copy_other_files(self, macro_dir, warnings) -> bool:
+ """Copy any specified "other files" into the install directory"""
for other_file in self.other_files:
if not other_file:
continue
@@ -408,7 +451,8 @@ class Macro(object):
try:
os.makedirs(dst_dir)
except OSError:
- return False, [f"Failed to create {dst_dir}"]
+ warnings.append(f"Failed to create {dst_dir}")
+ return False
if os.path.isabs(other_file):
src_file = other_file
dst_file = os.path.normpath(
@@ -417,40 +461,38 @@ class Macro(object):
else:
src_file = os.path.normpath(os.path.join(base_dir, other_file))
dst_file = os.path.normpath(os.path.join(macro_dir, other_file))
- if not os.path.isfile(src_file):
- # If the file does not exist, see if we have a raw code URL to fetch from
- if self.raw_code_url:
- fetch_url = self.raw_code_url.rsplit("/", 1)[0] + "/" + other_file
- FreeCAD.Console.PrintLog(f"Attempting to fetch {fetch_url}...\n")
- p = NetworkManager.AM_NETWORK_MANAGER.blocking_get(fetch_url)
- if p:
- with open(dst_file, "wb") as f:
- f.write(p)
- else:
- FreeCAD.Console.PrintWarning(
- translate(
- "AddonsInstaller",
- "Unable to fetch macro-specified file {} from {}",
- ).format(other_file, fetch_url)
- + "\n"
- )
- else:
- warnings.append(
- translate(
- "AddonsInstaller",
- "Could not locate macro-specified file {} (should have been at {})",
- ).format(other_file, src_file)
- )
- continue
+ self._fetch_single_file(other_file, src_file, dst_file)
try:
shutil.copy(src_file, dst_file)
except IOError:
warnings.append(f"Failed to copy {src_file} to {dst_file}")
- if len(warnings) > 0:
- return False, warnings
+ return True # No fatal errors, but some files may have failed to copy
- FreeCAD.Console.PrintLog(f"Macro {self.name} was installed successfully.\n")
- return True, []
+ def _fetch_single_file(self, other_file, src_file, dst_file):
+ if not os.path.isfile(src_file):
+ # If the file does not exist, see if we have a raw code URL to fetch from
+ if self.raw_code_url:
+ fetch_url = self.raw_code_url.rsplit("/", 1)[0] + "/" + other_file
+ FreeCAD.Console.PrintLog(f"Attempting to fetch {fetch_url}...\n")
+ p = NetworkManager.AM_NETWORK_MANAGER.blocking_get(fetch_url)
+ if p:
+ with open(dst_file, "wb") as f:
+ f.write(p)
+ else:
+ FreeCAD.Console.PrintWarning(
+ translate(
+ "AddonsInstaller",
+ "Unable to fetch macro-specified file {} from {}",
+ ).format(other_file, fetch_url)
+ + "\n"
+ )
+ else:
+ warnings.append(
+ translate(
+ "AddonsInstaller",
+ "Could not locate macro-specified file {} (should have been at {})",
+ ).format(other_file, src_file)
+ )
def remove(self) -> bool:
"""Remove a macro and all its related files
@@ -462,50 +504,86 @@ class Macro(object):
# Macro not installed, nothing to do.
return True
macro_dir = FreeCAD.getUserMacroDir(True)
- macro_path = os.path.join(macro_dir, self.filename)
- macro_path_with_macro_prefix = os.path.join(macro_dir, "Macro_" + self.filename)
- if os.path.exists(macro_path):
- os.remove(macro_path)
- elif os.path.exists(macro_path_with_macro_prefix):
- os.remove(macro_path_with_macro_prefix)
+
+ try:
+ self._remove_core_macro_file(macro_dir)
+ self._remove_xpm_data(macro_dir)
+ self._remove_other_files(macro_dir)
+ except IsADirectoryError:
+ FreeCAD.Console.PrintError(
+ translate(
+ "AddonsInstaller",
+ "Tried to remove a directory when a file was expected\n",
+ )
+ )
+ return False
+ except FileNotFoundError:
+ FreeCAD.Console.PrintError(
+ translate(
+ "AddonsInstaller",
+ "Macro file could not be found, nothing to remove\n",
+ )
+ )
+ return False
+ return True
+
+ def _remove_other_files(self, macro_dir):
# Remove related files, which are supposed to be given relative to
# self.src_filename.
- if self.xpm:
- xpm_file = os.path.join(macro_dir, self.name + "_icon.xpm")
- if os.path.exists(xpm_file):
- os.remove(xpm_file)
for other_file in self.other_files:
if not other_file:
continue
- FreeCAD.Console.PrintMessage(f"{other_file}...")
+ FreeCAD.Console.PrintMessage(other_file + "...")
dst_file = os.path.join(macro_dir, other_file)
if not dst_file or not os.path.exists(dst_file):
- FreeCAD.Console.PrintMessage(f"X\n")
+ FreeCAD.Console.PrintMessage("X\n")
continue
try:
os.remove(dst_file)
remove_directory_if_empty(os.path.dirname(dst_file))
FreeCAD.Console.PrintMessage("✓\n")
- except Exception:
- FreeCAD.Console.PrintMessage(f"?\n")
+ except IsADirectoryError:
+ FreeCAD.Console.PrintMessage(" is a directory, not removed\n")
+ except FileNotFoundError:
+ FreeCAD.Console.PrintMessage(" could not be found, nothing to remove\n")
if os.path.isabs(self.icon):
dst_file = os.path.normpath(
os.path.join(macro_dir, os.path.basename(self.icon))
)
if os.path.exists(dst_file):
try:
- FreeCAD.Console.PrintMessage(f"{os.path.basename(self.icon)}...")
+ FreeCAD.Console.PrintMessage(os.path.basename(self.icon) + "...")
os.remove(dst_file)
FreeCAD.Console.PrintMessage("✓\n")
- except Exception:
- FreeCAD.Console.PrintMessage(f"?\n")
+ except IsADirectoryError:
+ FreeCAD.Console.PrintMessage(" is a directory, not removed\n")
+ except FileNotFoundError:
+ FreeCAD.Console.PrintMessage(
+ " could not be found, nothing to remove\n"
+ )
return True
+ def _remove_core_macro_file(self, macro_dir):
+ macro_path = os.path.join(macro_dir, self.filename)
+ macro_path_with_macro_prefix = os.path.join(macro_dir, "Macro_" + self.filename)
+ if os.path.exists(macro_path):
+ os.remove(macro_path)
+ elif os.path.exists(macro_path_with_macro_prefix):
+ os.remove(macro_path_with_macro_prefix)
+
+ def _remove_xpm_data(self, macro_dir):
+ if self.xpm:
+ xpm_file = os.path.join(macro_dir, self.name + "_icon.xpm")
+ if os.path.exists(xpm_file):
+ os.remove(xpm_file)
+
def parse_wiki_page_for_icon(self, page_data: str) -> None:
"""Attempt to find a url for the icon in the wiki page. Sets self.icon if found."""
- # Method 1: the text "toolbar icon" appears on the page, and provides a direct lin to an icon
+ # Method 1: the text "toolbar icon" appears on the page, and provides a direct
+ # link to an icon
+ # pylint: disable=line-too-long
# Try to get an icon from the wiki page itself:
# ToolBar Icon
icon_regex = re.compile(r'.*href="(.*?)">ToolBar Icon', re.IGNORECASE)
