ba69518c36
Update formatting in compliance with pep8 with the following exceptions: * truncate to 120 characters in line * prefer double quotes `"` to single quotes `'` in strings
195 lines
7.4 KiB
Python
195 lines
7.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
#***************************************************************************
|
|
#* *
|
|
#* Copyright (c) 2018 Gaël Écorchard <galou_breizh@yahoo.fr> *
|
|
#* *
|
|
#* This program is free software; you can redistribute it and/or modify *
|
|
#* it under the terms of the GNU Lesser General Public License (LGPL) *
|
|
#* as published by the Free Software Foundation; either version 2 of *
|
|
#* the License, or (at your option) any later version. *
|
|
#* for detail see the LICENCE text file. *
|
|
#* *
|
|
#* This program is distributed in the hope that it will be useful, *
|
|
#* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
#* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
#* GNU Library General Public License for more details. *
|
|
#* *
|
|
#* You should have received a copy of the GNU Library General Public *
|
|
#* License along with this program; if not, write to the Free Software *
|
|
#* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
#* USA *
|
|
#* *
|
|
#***************************************************************************
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
from PySide import QtCore, QtGui
|
|
|
|
import FreeCAD
|
|
import FreeCADGui
|
|
|
|
from addonmanager_utilities import translate
|
|
from addonmanager_utilities import urlopen
|
|
|
|
try:
|
|
from HTMLParser import HTMLParser
|
|
unescape = HTMLParser().unescape
|
|
except ImportError:
|
|
from html import unescape
|
|
|
|
try:
|
|
import StringIO as io
|
|
_stringio = io.StringIO
|
|
except ImportError: # StringIO is not available with python3
|
|
import io
|
|
_stringio = io.BytesIO
|
|
|
|
have_git = False
|
|
try:
|
|
import git
|
|
have_git = True
|
|
except ImportError:
|
|
pass
|
|
|
|
have_zip = False
|
|
try:
|
|
import zipfile
|
|
have_zip = True
|
|
except ImportError:
|
|
pass
|
|
|
|
# @package AddonManager_macro
|
|
# \ingroup ADDONMANAGER
|
|
# \brief Unified handler for FreeCAD macros that can be obtained from different sources
|
|
# @{
|
|
|
|
|
|
class Macro(object):
|
|
"""This class provides a unified way to handle macros coming from different sources"""
|
|
|
|
def __init__(self, name):
|
|
self.name = name
|
|
self.on_wiki = False
|
|
self.on_git = False
|
|
self.desc = ""
|
|
self.code = ""
|
|
self.url = ""
|
|
self.version = ""
|
|
self.src_filename = ""
|
|
self.other_files = []
|
|
self.parsed = False
|
|
|
|
def __eq__(self, other):
|
|
return self.filename == other.filename
|
|
|
|
@property
|
|
def filename(self):
|
|
if self.on_git:
|
|
return os.path.basename(self.src_filename)
|
|
return (self.name + ".FCMacro").replace(" ", "_")
|
|
|
|
def is_installed(self):
|
|
if self.on_git and not self.src_filename:
|
|
return False
|
|
return (os.path.exists(os.path.join(FreeCAD.getUserMacroDir(True), self.filename))
|
|
or os.path.exists(os.path.join(FreeCAD.getUserMacroDir(True), "Macro_" + self.filename)))
|
|
|
|
def fill_details_from_file(self, filename):
|
|
with open(filename) as f:
|
|
# Number of parsed fields of metadata. For now, __Comment__,
|
|
# __Web__, __Version__, __Files__.
|
|
number_of_required_fields = 4
|
|
re_desc = re.compile(r"^__Comment__\s*=\s*(['\"])(.*)\1")
|
|
re_url = re.compile(r"^__Web__\s*=\s*(['\"])(.*)\1")
|
|
re_version = re.compile(r"^__Version__\s*=\s*(['\"])(.*)\1")
|
|
re_files = re.compile(r"^__Files__\s*=\s*(['\"])(.*)\1")
|
|
for line in f.readlines():
|
|
match = re.match(re_desc, line)
|
|
if match:
|
|
self.desc = match.group(2)
|
|
number_of_required_fields -= 1
|
|
match = re.match(re_url, line)
|
|
if match:
|
|
self.url = match.group(2)
|
|
number_of_required_fields -= 1
|
|
match = re.match(re_version, line)
|
|
if match:
|
|
self.version = match.group(2)
|
|
number_of_required_fields -= 1
|
|
match = re.match(re_files, line)
|
|
if match:
|
|
self.other_files = [of.strip() for of in match.group(2).split(",")]
|
|
number_of_required_fields -= 1
|
|
if number_of_required_fields <= 0:
|
|
break
|
|
f.seek(0)
|
|
self.code = f.read()
|
|
self.parsed = True
|
|
|
|
def fill_details_from_wiki(self, url):
|
|
code = ""
|
|
u = urlopen(url)
|
|
if u is None:
|
|
print("AddonManager: Debug: connection is lost (proxy setting changed?)", url)
|
|
return
|
|
p = u.read()
|
|
if sys.version_info.major >= 3 and isinstance(p, bytes):
|
|
p = p.decode("utf-8")
|
|
u.close()
|
|
# check if the macro page has its code hosted elsewhere, download if needed
|
|
if "rawcodeurl" in p:
|
|
rawcodeurl = re.findall("rawcodeurl.*?href=\"(http.*?)\">", p)
|
|
if rawcodeurl:
|
|
rawcodeurl = rawcodeurl[0]
|
|
u2 = urlopen(rawcodeurl)
|
|
if u2 is None:
|
|
print("AddonManager: Debug: unable to open URL", rawcodeurl)
|
|
return
|
|
# code = u2.read()
|
|
# github is slow to respond... We need to use this trick below
|
|
response = ""
|
|
block = 8192
|
|
# expected = int(u2.headers["content-length"])
|
|
while True:
|
|
# print("expected:", expected, "got:", len(response))
|
|
data = u2.read(block)
|
|
if not data:
|
|
break
|
|
if sys.version_info.major >= 3 and isinstance(data, bytes):
|
|
data = data.decode("utf-8")
|
|
response += data
|
|
if response:
|
|
code = response
|
|
u2.close()
|
|
if not code:
|
|
code = re.findall(r"<pre>(.*?)</pre>", p.replace("\n", "--endl--"))
|
|
if code:
|
|
# code = code[0]
|
|
# take the biggest code block
|
|
code = sorted(code, key=len)[-1]
|
|
code = code.replace("--endl--", "\n")
|
|
else:
|
|
FreeCAD.Console.PrintWarning(translate("AddonsInstaller", "Unable to fetch the code of this macro."))
|
|
# Clean HTML escape codes.
|
|
if sys.version_info.major < 3:
|
|
code = code.decode("utf8")
|
|
code = unescape(code)
|
|
code = code.replace(b"\xc2\xa0".decode("utf-8"), " ")
|
|
if sys.version_info.major < 3:
|
|
code = code.encode("utf8")
|
|
desc = re.findall(r"<td class=\"ctEven left macro-description\">(.*?)</td>", p.replace("\n", " "))
|
|
if desc:
|
|
desc = desc[0]
|
|
else:
|
|
FreeCAD.Console.PrintWarning(translate("AddonsInstaller",
|
|
"Unable to retrieve a description for this macro."))
|
|
desc = "No description available"
|
|
self.desc = desc
|
|
self.url = url
|
|
self.code = code
|
|
self.parsed = True
|
|
|
|
# @}
|