diff --git a/bin/utils.py b/bin/utils.py index 008efd255..0ca801e1c 100644 --- a/bin/utils.py +++ b/bin/utils.py @@ -1,1141 +1,1140 @@ # -*- coding: utf-8 -*- # copyright: # Holger Schroeder # Patrick Spendrin # Ralf Habacker # Copyright Hannah von Reth # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # 1. Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE # ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. import configparser import contextlib import glob import inspect import io import os import re import shlex import stat import shutil import sys import subprocess import tempfile from pathlib import Path import Notifier.NotificationLoader from Blueprints.CraftVersion import CraftVersion from CraftCore import CraftCore from CraftDebug import deprecated from CraftOS.osutils import OsUtils from CraftSetupHelper import SetupHelper from CraftStandardDirs import CraftStandardDirs from Utils import CraftChoicePrompt def abstract(): caller = inspect.getouterframes(inspect.currentframe())[1][3] raise NotImplementedError(caller + ' must be implemented in subclass') ### unpack functions def unpackFiles(downloaddir, filenames, workdir): """unpack (multiple) files specified by 'filenames' from 'downloaddir' into 'workdir'""" for filename in filenames: if (not unpackFile(downloaddir, filename, workdir)): return False return True def unpackFile(downloaddir, filename, workdir): """unpack file specified by 'filename' from 'downloaddir' into 'workdir'""" CraftCore.log.debug(f"unpacking this file: {filename}") if not filename: return True (shortname, ext) = os.path.splitext(filename) if ext == "": CraftCore.log.warning(f"unpackFile called on invalid file extension {filename}") return True if OsUtils.isWin() and not OsUtils.supportsSymlinks(): CraftCore.log.warning("Please enable Windows 10 development mode to enable support for symlinks.\n" "This will enable faster extractions.\n" "https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development") if CraftCore.cache.findApplication("7za"): # we use tar on linux not 7z, don't use tar on windows as it skips symlinks # test it with breeze-icons if (not OsUtils.isWin() or (OsUtils.supportsSymlinks() and CraftCore.cache.getVersion("7za", versionCommand="-version") >= "16") or not re.match("(.*\.tar.*$|.*\.tgz$)", filename)): return un7zip(os.path.join(downloaddir, filename), workdir, ext) try: shutil.unpack_archive(os.path.join(downloaddir, filename), workdir) except Exception as e: CraftCore.log.error(f"Failed to unpack {filename}", exc_info=e) return False return True def un7zip(fileName, destdir, flag=None): ciMode = CraftCore.settings.getboolean("ContinuousIntegration", "Enabled", False) createDir(destdir) kw = {} progressFlags = [] type = [] resolveSymlinks = False app = CraftCore.cache.findApplication("7za") if not ciMode and CraftCore.cache.checkCommandOutputFor(app, "-bs"): progressFlags = ["-bso2", "-bsp1"] kw["stderr"] = subprocess.PIPE if flag == ".7z": # Actually this is not needed for a normal archive. # But git is an exe file renamed to 7z and we need to specify the type. # Yes it is an ugly hack. type = ["-t7z"] if re.match("(.*\.tar.*$|.*\.tgz$)", fileName): if progressFlags: if ciMode: progressFlags = [] else: # print progress to stderr progressFlags = ["-bsp2"] kw["pipeProcess"] = subprocess.Popen([app, "x", fileName, "-so"] + progressFlags, stdout = subprocess.PIPE) if OsUtils.isWin(): resolveSymlinks = True if progressFlags: progressFlags = ["-bsp0"] command = [app, "x", "-si", f"-o{destdir}", "-ttar"] + progressFlags else: tar = CraftCore.cache.findApplication("tar") command = [tar, "--directory", destdir, "-xf", "-"] else: command = [app, "x", "-r", "-y", f"-o{destdir}", fileName] + type + progressFlags # While 7zip supports symlinks cmake 3.8.0 does not support symlinks return system(command, displayProgress=True, **kw) and (not resolveSymlinks or replaceSymlinksWithCopies(destdir)) def compress(archive : str, source : str) -> bool: ciMode = CraftCore.settings.getboolean("ContinuousIntegration", "Enabled", False) def __7z(archive, source): archive = Path(archive) app = CraftCore.cache.findApplication("7za") kw = {} flags = [] if archive.suffix in {".appxsym", ".appxupload"}: flags.append("-tzip") if not ciMode and CraftCore.cache.checkCommandOutputFor(app, "-bs"): flags += ["-bso2", "-bsp1"] kw["stderr"] = subprocess.PIPE if CraftCore.compiler.isUnix: tar = CraftCore.cache.findApplication("tar") kw["pipeProcess"] = subprocess.Popen([tar, "-cf", "-", "-C", source, ".",], stdout=subprocess.PIPE) command = [app, "a", "-si", archive] + flags else: command = [app, "a", "-r", archive] + flags if isinstance(source, list): command += source elif os.path.isfile(source): command += [source] else: command += [os.path.join(source, "*")] return system(command, displayProgress=True, **kw) def __xz(archive, source): command = ["tar", "-cJf", archive, "-C"] if os.path.isfile(source): command += [source] else: command += [source, "."] return system(command) createDir(os.path.dirname(archive)) if os.path.isfile(archive): deleteFile(archive) if CraftCore.compiler.isUnix and archive.endswith(".tar.xz"): return __xz(archive, source) else: return __7z(archive, source) def system(cmd, displayProgress=False, logCommand=True, acceptableExitCodes=None, **kw): """execute cmd in a shell. All keywords are passed to Popen. stdout and stderr might be changed depending on the chosen logging options.""" return systemWithoutShell(cmd, displayProgress=displayProgress, logCommand=logCommand, acceptableExitCodes=acceptableExitCodes, **kw) def systemWithoutShell(cmd, displayProgress=False, logCommand=True, pipeProcess=None, acceptableExitCodes=None, secretCommand=False, **kw): """execute cmd. All keywords are passed to Popen. stdout and stderr might be changed depending on the chosen logging options. When the parameter "displayProgress" is True, stdout won't be logged to allow the display of progress bars.""" environment = kw.get("env", os.environ) cwd = kw.get("cwd", os.getcwd()) # if the first argument is not an absolute path replace it with the full path to the application if isinstance(cmd, list): # allow to pass other types, like ints or Path cmd = [str(x) for x in cmd] if pipeProcess: pipeProcess.args = [str(x) for x in pipeProcess.args] arg0 = cmd[0] if not "shell" in kw: kw["shell"] = False else: if not "shell" in kw: # use shell, arg0 might end up with "/usr/bin/svn" => needs shell so it can be executed kw["shell"] = True arg0 = shlex.split(cmd, posix=not CraftCore.compiler.isWindows)[0] matchQuoted = re.match("^\"(.*)\"$", arg0) if matchQuoted: CraftCore.log.warning(f"Please don't pass quoted paths to systemWithoutShell, app={arg0}") if not os.path.isfile(arg0) and not matchQuoted: app = CraftCore.cache.findApplication(arg0) else: app = arg0 if app: if isinstance(cmd, list): cmd[0] = app elif not matchQuoted: cmd = cmd.replace(arg0, f"\"{app}\"", 1) else: app = arg0 if secretCommand: CraftCore.debug.print(f"securely executing command: {app}") else: if logCommand: _logCommand = "" if pipeProcess: _logCommand = "{0} | ".format(" ".join(pipeProcess.args)) _logCommand += " ".join(cmd) if isinstance(cmd, list) else cmd CraftCore.debug.print("executing command: {0}".format(_logCommand)) if pipeProcess: CraftCore.log.debug(f"executing command: {pipeProcess.args!r} | {cmd!r}") else: CraftCore.log.debug(f"executing command: {cmd!r}") CraftCore.log.debug(f"CWD: {cwd!r}") CraftCore.log.debug(f"displayProgress={displayProgress}") CraftCore.debug.logEnv(environment) if pipeProcess: kw["stdin"] = pipeProcess.stdout if not displayProgress or CraftCore.settings.getboolean("ContinuousIntegration", "Enabled", False): stdout = kw.get('stdout', sys.stdout) kw['stderr'] = subprocess.STDOUT kw['stdout'] = subprocess.PIPE proc = subprocess.Popen(cmd, **kw) if pipeProcess: pipeProcess.stdout.close() for line in proc.stdout: if isinstance(stdout, io.TextIOWrapper): if CraftCore.debug.verbose() < 3: # don't print if we write the debug log to stdout anyhow stdout.buffer.write(line) stdout.flush() elif stdout == subprocess.DEVNULL: pass elif isinstance(stdout, io.StringIO): stdout.write(line.decode("UTF-8")) else: stdout.write(line) CraftCore.log.debug("{app}: {out}".format(app=app, out=line.rstrip())) else: proc = subprocess.Popen(cmd, **kw) if pipeProcess: pipeProcess.stdout.close() if proc.stderr: for line in proc.stderr: CraftCore.log.debug("{app}: {out}".format(app=app, out=line.rstrip())) proc.communicate() proc.wait() if acceptableExitCodes is None: ok = proc.returncode == 0 else: ok = proc.returncode in acceptableExitCodes if not ok: if not secretCommand: msg = f"Command {cmd} failed with exit code {proc.returncode}" if not CraftCore.settings.getboolean("ContinuousIntegration", "Enabled", False): CraftCore.log.debug(msg) else: CraftCore.log.info(msg) else: CraftCore.log.info(f"{app} failed with exit code {proc.returncode}") return ok def cleanDirectory(directory): CraftCore.log.debug("clean directory %s" % directory) if os.path.exists(directory): # don't delete containg directrory as it might be a symlink and replacing it with a folder # breaks the behaviour with os.scandir(directory) as scan: for f in scan: if f.is_dir(): if not OsUtils.rmDir(f.path, force=True): return False else: if not OsUtils.rm(f.path, force=True): return False else: return createDir(directory) def getVCSType(url): """ return the type of the vcs url """ if not url: return "" if isGitUrl(url): return "git" elif isSvnUrl(url): return "svn" elif url.startswith("[hg]"): return "hg" ## \todo complete more cvs access schemes elif url.find("pserver:") >= 0: return "cvs" else: return "" def isGitUrl(Url): """ this function returns true, if the Url given as parameter is a git url: it either starts with git:// or the first part before the first '|' ends with .git or if the url starts with the token [git] """ if Url.startswith('git://'): return True # split away branch and tags splitUrl = Url.split('|') if splitUrl[0].endswith(".git"): return True if Url.startswith("[git]"): return True return False def isSvnUrl(url): """ this function returns true, if the Url given as parameter is a svn url """ if url.startswith("[svn]"): return True elif url.find("://") == -1: return True elif url.find("svn:") >= 0 or url.find("https:") >= 0 or url.find("http:") >= 0: return True return False def splitVCSUrl(Url): """ this function splits up an url provided by Url into the server name, the path, a branch or tag; it will return a list with 3 strings according to the following scheme: git://servername/path.git|4.5branch|v4.5.1 will result in ['git://servername:path.git', '4.5branch', 'v4.5.1'] This also works for all other dvcs""" splitUrl = Url.split('|') if len(splitUrl) < 3: c = [x for x in splitUrl] for dummy in range(3 - len(splitUrl)): c.append('') else: c = splitUrl[0:3] return c def replaceVCSUrl(Url): """ this function should be used to replace the url of a server this comes in useful if you e.g. need to switch the server url for a push url on gitorious.org """ configfile = os.path.join(CraftStandardDirs.etcBlueprintDir(), "..", "crafthosts.conf") replacedict = dict() # FIXME handle svn/git usernames and settings with a distinct naming # todo WTF if (("General", "KDESVNUSERNAME") in CraftCore.settings and CraftCore.settings.get("General", "KDESVNUSERNAME") != "username"): replacedict["git://git.kde.org/"] = "git@git.kde.org:" if os.path.exists(configfile): config = configparser.ConfigParser() config.read(configfile) # add the default KDE stuff if the KDE username is set. for section in config.sections(): host = config.get(section, "host") replace = config.get(section, "replace") replacedict[host] = replace for host in list(replacedict.keys()): if not Url.find(host) == -1: Url = Url.replace(host, replacedict[host]) break return Url def createImportLibs(dll_name, basepath): """creating the import libraries for the other compiler(if ANSI-C libs)""" dst = os.path.join(basepath, "lib") if (not os.path.exists(dst)): os.mkdir(dst) # check whether the required binary tools exist HAVE_GENDEF = CraftCore.cache.findApplication("gendef") is not None USE_GENDEF = HAVE_GENDEF HAVE_LIB = CraftCore.cache.findApplication("lib") is not None HAVE_DLLTOOL = CraftCore.cache.findApplication("dlltool") is not None CraftCore.log.debug(f"gendef found: {HAVE_GENDEF}") CraftCore.log.debug(f"gendef used: {USE_GENDEF}") CraftCore.log.debug(f"lib found: {HAVE_LIB}") CraftCore.log.debug(f"dlltool found: {HAVE_DLLTOOL}") dllpath = os.path.join(basepath, "bin", "%s.dll" % dll_name) defpath = os.path.join(basepath, "lib", "%s.def" % dll_name) exppath = os.path.join(basepath, "lib", "%s.exp" % dll_name) imppath = os.path.join(basepath, "lib", "%s.lib" % dll_name) gccpath = os.path.join(basepath, "lib", "%s.dll.a" % dll_name) if not HAVE_GENDEF and os.path.exists(defpath): HAVE_GENDEF = True USE_GENDEF = False if not HAVE_GENDEF: CraftCore.log.warning("system does not have gendef.exe") return False if not HAVE_LIB and not os.path.isfile(imppath): CraftCore.log.warning("system does not have lib.exe (from msvc)") if not HAVE_DLLTOOL and not os.path.isfile(gccpath): CraftCore.log.warning("system does not have dlltool.exe") # create .def if USE_GENDEF: cmd = "gendef - %s -a > %s " % (dllpath, defpath) system(cmd) if (HAVE_LIB and not os.path.isfile(imppath)): # create .lib cmd = "lib /machine:x86 /def:%s /out:%s" % (defpath, imppath) system(cmd) if (HAVE_DLLTOOL and not os.path.isfile(gccpath)): # create .dll.a cmd = "dlltool -d %s -l %s -k" % (defpath, gccpath) system(cmd) if os.path.exists(defpath): os.remove(defpath) if os.path.exists(exppath): os.remove(exppath) return True def createSymlink(source, linkName, useAbsolutePath=False, targetIsDirectory=False): if not useAbsolutePath and os.path.isabs(linkName): srcPath = linkName srcPath = os.path.dirname(srcPath) source = os.path.relpath(source, srcPath) createDir(os.path.dirname(linkName)) CraftCore.log.debug(f"creating symlink: {linkName} -> {source}") try: os.symlink(source, linkName, targetIsDirectory) return True except Exception as e: CraftCore.log.warning(e) return False def createDir(path): """Recursive directory creation function. Makes all intermediate-level directories needed to contain the leaf directory""" if not os.path.lexists(path): CraftCore.log.debug(f"creating directory {path}") os.makedirs(path) return True def copyFile(src : Path, dest : Path, linkOnly=CraftCore.settings.getboolean("General", "UseHardlinks", False)): """ copy file from src to dest""" CraftCore.log.debug("copy file from %s to %s" % (src, dest)) src = Path(src) dest = Path(dest) if dest.is_dir(): dest = dest / src.name else: createDir(dest.parent) if os.path.lexists(dest): CraftCore.log.warning(f"Overriding:\t{dest} with\n\t\t{src}") if src == dest: CraftCore.log.error(f"Can't copy a file into itself {src}=={dest}") return False OsUtils.rm(dest, True) # don't link to links if linkOnly and not os.path.islink(src): try: os.link(src, dest) return True except: CraftCore.log.warning("Failed to create hardlink %s for %s" % (dest, src)) try: shutil.copy2(src, dest, follow_symlinks=False) except Exception as e: CraftCore.log.error(f"Failed to copy file:\n{src} to\n{dest}", exc_info=e) return False return True def copyDir(srcdir, destdir, linkOnly=CraftCore.settings.getboolean("General", "UseHardlinks", False), copiedFiles=None): """ copy directory from srcdir to destdir """ CraftCore.log.debug("copyDir called. srcdir: %s, destdir: %s" % (srcdir, destdir)) srcdir = Path(srcdir) if not srcdir.exists(): CraftCore.log.warning(f"copyDir called. srcdir: {srcdir} does not exists") return True destdir = Path(destdir) if not destdir.exists(): createDir(destdir) try: with os.scandir(srcdir) as scan: for entry in scan: dest = destdir / Path(entry.path).parent.relative_to(srcdir) / entry.name if entry.is_dir(): if entry.is_symlink(): # copy the symlinks without resolving them if not copyFile(entry.path, dest, linkOnly=False): return False if copiedFiles is not None: copiedFiles.append(str(dest)) else: if not copyDir(entry.path, dest, copiedFiles=copiedFiles): return False else: # symlinks to files are included in `files` if not copyFile(entry.path, dest,linkOnly=linkOnly): return False if copiedFiles is not None: copiedFiles.append(str(dest)) except Exception as e: CraftCore.log.error(f"Failed to copy dir:\n{srcdir} to\n{destdir}", exc_info=e) return False return True def globCopyDir(srcDir : str, destDir : str, pattern : [str], linkOnly=CraftCore.settings.getboolean("General", "UseHardlinks", False)) -> bool: files = [] for p in pattern: files.extend(glob.glob(os.path.join(srcDir, p), recursive=True)) for f in files: if not copyFile(f, os.path.join(destDir, os.path.relpath(f, srcDir)), linkOnly=linkOnly): return False return True def mergeTree(srcdir, destdir): """ moves directory from @p srcdir to @p destdir If a directory in @p destdir exists, just write into it """ srcdir = Path(srcdir) destdir = Path(destdir) if not createDir(destdir): return False CraftCore.log.debug(f"mergeTree called. srcdir: {srcdir}, destdir: {destdir}") if srcdir.samefile(destdir): CraftCore.log.critical(f"mergeTree called on the same directory srcdir: {srcdir}, destdir: {destdir}") return False with os.scandir(srcdir) as scan: for src in scan: dest = destdir / src.name if Path(src.path) in dest.parents: CraftCore.log.info(f"mergeTree: skipping moving of {src.path} to {dest}") continue if dest.exists(): if dest.is_dir(): if dest.is_symlink(): if dest.samefile(src): CraftCore.log.info(f"mergeTree: skipping moving of {src.path} to {dest} as a symlink with the same destination already exists") continue else: CraftCore.log.critical(f"mergeTree failed: {src.path} and {dest} are both symlinks but point to different folders") return False if src.is_symlink() and not dest.is_symlink(): CraftCore.log.critical(f"mergeTree failed: how to merge symlink {src.path} into {dest}") return False if not src.is_symlink() and dest.is_symlink(): CraftCore.log.critical(f"mergeTree failed: how to merge folder {src.path} into symlink {dest}") return False if not mergeTree(src.path, dest): return False else: CraftCore.log.critical(f"mergeTree failed: how to merge folder {src.path} into file {dest}\n" f"If this error occured during packaging, consider extending the blacklist.") return False else: if not moveFile(src.path, destdir): return False if not os.listdir(srcdir): # Cleanup (only removing empty folders) return rmtree(srcdir) else: # we move a directory in one of its sub directories assert srcdir in destdir.parents return True @deprecated("moveFile") def moveDir(srcdir, destdir): """ move directory from srcdir to destdir """ return moveFile(srcdir, destdir) def moveFile(src, dest): """move file from src to dest""" CraftCore.log.debug("move file from %s to %s" % (src, dest)) try: shutil.move(src, dest, copy_function=lambda src, dest, *kw : shutil.copy2(src, dest, *kw, follow_symlinks=False)) except Exception as e: CraftCore.log.warning(e) return False return True def rmtree(directory): """ recursively delete directory """ CraftCore.log.debug("rmtree called. directory: %s" % (directory)) try: shutil.rmtree(directory, True) # ignore errors except Exception as e: CraftCore.log.warning(e) return False return True def deleteFile(fileName): """delete file """ if not os.path.exists(fileName): return False CraftCore.log.debug("delete file %s " % (fileName)) try: os.remove(fileName) except Exception as e: CraftCore.log.warning(e) return False return True def putenv(name, value): """set environment variable""" if value is None: msg = f"unset environment variable -- unset {name}" if name in os.environ: del os.environ[name] else: msg = f"set environment variable -- set {name}={value}" os.environ[name] = value if CraftCore.settings.getboolean("CraftDebug", "PrintPutEnv", False): CraftCore.log.info(msg) else: CraftCore.log.debug(msg) return True def applyPatch(sourceDir, f, patchLevel='0'): """apply single patch""" if os.path.isdir(f): # apply a whole dir of patches for patch in os.listdir(f): if not applyPatch(sourceDir, os.path.join(f, patch), patchLevel): return False return True with tempfile.TemporaryDirectory() as tmp: # rewrite the patch, the gnu patch on Windows is only capable # to read \r\n patches tmpPatch = os.path.join(tmp, os.path.basename(f)) with open(f, "rt", encoding="utf-8") as p: patchContent = p.read() with open(tmpPatch, "wt", encoding="utf-8") as p: p.write(patchContent) cmd = ["patch", "--ignore-whitespace", "-d", sourceDir, "-p", str(patchLevel), "-i", tmpPatch] result = system(cmd) if not result: CraftCore.log.warning(f"applying {f} failed!") return result def embedManifest(executable, manifest): ''' Embed a manifest to an executable using either the free kdewin manifest if it exists in dev-utils/bin or the one provided by the Microsoft Platform SDK if it is installed' ''' if not os.path.isfile(executable) or not os.path.isfile(manifest): # We die here because this is a problem with the blueprint files CraftCore.log.critical("embedManifest %s or %s do not exist" % (executable, manifest)) CraftCore.log.debug("embedding ressource manifest %s into %s" % \ (manifest, executable)) return system(["mt", "-nologo", "-manifest", manifest, f"-outputresource:{executable};1"]) def notify(title, message, alertClass=None, log=True): if log: CraftCore.debug.step(f"{title}: {message}") backends = CraftCore.settings.get("General", "Notify", "") if CraftCore.settings.getboolean("ContinuousIntegration", "Enabled", False) or backends == "": return backends = Notifier.NotificationLoader.load(backends.split(";")) for backend in backends.values(): backend.notify(title, message, alertClass) def levenshtein(s1, s2): if len(s1) < len(s2): return levenshtein(s2, s1) if not s1: return len(s2) previous_row = range(len(s2) + 1) for i, c1 in enumerate(s1): current_row = [i + 1] for j, c2 in enumerate(s2): insertions = previous_row[ j + 1] + 1 # j+1 instead of j since previous_row and current_row are one character longer deletions = current_row[j] + 1 # than s2 substitutions = previous_row[j] + (c1 != c2) current_row.append(min(insertions, deletions, substitutions)) previous_row = current_row return previous_row[-1] def createShim(shim, target, args=None, guiApp=False, useAbsolutePath=False) -> bool: if not useAbsolutePath and os.path.isabs(target): target = os.path.relpath(target, os.path.dirname(shim)) createDir(os.path.dirname(shim)) if os.path.exists(shim): deleteFile(shim) if not args: args = [] elif isinstance(args, str): CraftCore.log.error("Please pass args as [str]") return system(f"kshimgen --create {shim} {target} -- {args}") return system(["kshimgen", "--create", shim, target , "--"] + args) def replaceSymlinksWithCopies(path, _replaceDirs=False): def resolveLink(path): while os.path.islink(path): toReplace = os.readlink(path) if not os.path.isabs(toReplace): path = os.path.join(os.path.dirname(path), toReplace) else: path = toReplace return path # symlinks to dirs are resolved after we resolved the files dirsToResolve = [] ok = True for root, _, files in os.walk(path): for svg in files: if not ok: return False path = os.path.join(root, svg) if os.path.islink(path): toReplace = resolveLink(path) if not os.path.exists(toReplace): CraftCore.log.error(f"Resolving {path} failed: {toReplace} does not exists.") continue if toReplace != path: if os.path.isdir(toReplace): if not _replaceDirs: dirsToResolve.append(path) else: os.unlink(path) ok = copyDir(toReplace, path) else: os.unlink(path) ok = copyFile(toReplace, path) while dirsToResolve: d = dirsToResolve.pop() if not os.path.exists(resolveLink(d)): CraftCore.log.warning(f"Delay replacement of {d}") dirsToResolve.append(d) continue if not replaceSymlinksWithCopies(os.path.dirname(d), _replaceDirs=True): return False return True def printProgress(percent): width, _ = shutil.get_terminal_size((80, 20)) width -= 20 # margin times = int(width / 100 * percent) sys.stdout.write( "\r[{progress}{space}]{percent}%".format(progress="#" * times, space=" " * (width - times), percent=percent)) sys.stdout.flush() class ScopedEnv(object): def __init__(self, env): self.oldEnv = {} for key, value in env.items(): self.oldEnv[key] = os.environ.get(key, None) putenv(key, value) def reset(self): for key, value in self.oldEnv.items(): putenv(key, value) def __enter__(self): return self def __exit__(self, exc_type, exc_value, trback): self.reset() def normalisePath(path): path = os.path.abspath(path) if OsUtils.isWin(): return path.replace("\\", "/") return path def configureFile(inFile : str, outFile : str, variables : dict) -> bool: CraftCore.log.debug(f"configureFile {inFile} -> {outFile}\n{variables}") configPatter = re.compile(r"@{([^{}]+)}") with open(inFile, "rt", encoding="UTF-8") as f: script = f.read() matches = configPatter.findall(script) if not matches: CraftCore.log.debug("Nothing to configure") return False while matches: for match in matches: val = variables.get(match, None) if val is None: linenUmber = 0 for line in script.split("\n"): if match in line: break linenUmber += 1 raise Exception(f"Failed to configure {inFile}: @{{{match}}} is not in variables\n" f"{linenUmber}:{line}") script = script.replace(f"@{{{match}}}", str(val)) matches = configPatter.findall(script) os.makedirs(os.path.dirname(outFile), exist_ok=True) with open(outFile, "wt", encoding="UTF-8") as f: f.write(script) return True def limitCommandLineLength(command : [str], args : [str]) -> [[str]]: # the actual limit is hard to get in python so lets just use a working random size SIZE = 1024 * 4 out = [] commandSize = sum(map(len, command)) if commandSize >= SIZE: CraftCore.log.error("Failed to compute command, command too long") return [] currentSize = commandSize tmp = [] for a in args: le = len(a) if currentSize + le >= SIZE: out.append(command + tmp) tmp = [] currentSize = commandSize tmp.append(a) currentSize += le if tmp: out.append(command + tmp) return out def sign(fileNames : [str]) -> bool: if not CraftCore.settings.getboolean("CodeSigning", "Enabled", False): return True if not CraftCore.compiler.isWindows: CraftCore.log.warning("Code signing is currently only supported on Windows") return True signTool = CraftCore.cache.findApplication("signtool", forceCache=True) if not signTool: env = SetupHelper.getMSVCEnv() signTool = CraftCore.cache.findApplication("signtool", env["PATH"], forceCache=True) if not signTool: CraftCore.log.warning("Code signing requires a VisualStudio installation") return False subjectName = CraftCore.settings.get("CodeSigning", "CommonName") command = [signTool, "sign", "/n", subjectName, "/tr", "http://timestamp.digicert.com", "/td", "SHA256", "/fd", "SHA256", "/a"] certFile = CraftCore.settings.get("CodeSigning", "Certificate", "") certProtected = CraftCore.settings.getboolean("CodeSigning", "Protected", False) kwargs = dict() if certFile: command += ["/f", certFile] if certProtected: password = CraftChoicePrompt.promptForPassword(message='Enter the password for your package signing certificate', key="WINDOWS_CODE_SIGN_CERTIFICATE_PASSWORD") command += ["/p", password] kwargs["secretCommand"] = True if True or CraftCore.debug.verbose() > 0: command += ["/v"] else: command += ["/q"] for args in limitCommandLineLength(command, fileNames): if not system(args, **kwargs): return False return True def signMacApp(appPath : str): if not CraftCore.settings.getboolean("CodeSigning", "Enabled", False): return True - developerIdApplication = CraftCore.settings.get("CodeSigning", "MacDeveloperIdApplication") + devID = CraftCore.settings.get("CodeSigning", "MacDeveloperId") unlockMacKeychain() # Recursively sign app - if not system(["codesign", "-s", developerIdApplication, "--force", "--preserve-metadata=entitlements", "--verbose=4", "--deep", appPath]): + if not system(["codesign", "-s", f"Developer ID Application: {devID}", "--force", "--preserve-metadata=entitlements", "--verbose=4", "--deep", appPath]): return False ## Verify signature if not system(["codesign", "-dv", appPath]): return False if not system(["codesign", "--verify", "-v", appPath]): return False if not system(["spctl", "-a", "-t", "exec", "-vv", appPath]): return False ## Validate that the key used for signing the binary matches the expected TeamIdentifier ## needed to pass the SocketApi through the sandbox #if not utils.system("codesign -dv %s 2>&1 | grep 'TeamIdentifier=%s'" % (self.appPath, teamIdentifierFromConfig)): #return False return True def signMacPackage(packagePath : str): if not CraftCore.settings.getboolean("CodeSigning", "Enabled", False): return True unlockMacKeychain() + devID = CraftCore.settings.get("CodeSigning", "MacDeveloperId") if packagePath.name.endswith(".dmg"): # sign dmg - developerIdApplication = CraftCore.settings.get("CodeSigning", "MacDeveloperIdApplication") - if not system(["codesign", "--force", "--sign", developerIdApplication, packagePath]): + if not system(["codesign", "--force", "--sign", f"Developer ID Application: {devID}", packagePath]): return False # verify dmg signature if not system(["spctl", "-a", "-t", "open", "--context", "context:primary-signature", packagePath]): return False else: # sign pkg - developerIdInstaller = CraftCore.settings.get("CodeSigning", "MacDeveloperIdInstaller") packagePathTmp = f"{packagePath}.sign" - if not system(["productsign", "--sign", developerIdInstaller, packagePath, packagePathTmp]): + if not system(["productsign", "--sign", f"Developer ID Installer: {devID}", packagePath, packagePathTmp]): return False os.rename(packagePathTmp, packagePath) return True def unlockMacKeychain(): password = CraftChoicePrompt.promptForPassword(message='Enter the password for your package signing certificate', key="MAC_KEYCHAIN_PASSWORD") if not system(["security", "set-key-partition-list", "-S", "apple-tool:,apple:,codesign:", "-s" ,"-k", password, os.path.expanduser("~/Library/Keychains/login.keychain")], stdout=subprocess.DEVNULL, secretCommand=True): CraftCore.log.error("Failed to unlock keychain.") return False return True def isExecuatable(fileName : Path): fileName = Path(fileName) if CraftCore.compiler.isWindows: return fileName.suffix in os.environ["PATHEXT"] return os.access(fileName, os.X_OK) def isBinary(fileName : str) -> bool: # https://en.wikipedia.org/wiki/List_of_file_signatures fileName = Path(fileName) MACH_O_64 = b"\xCF\xFA\xED\xFE" ELF = b"\x7F\x45\x4C\x46" if fileName.is_symlink() or fileName.is_dir(): return False if CraftCore.compiler.isWindows: if fileName.suffix in {".dll", ".exe"}: return True else: if CraftCore.compiler.isMacOS and ".dSYM/" in str(fileName): return False if fileName.suffix in {".so", ".dylib"}: return True elif isExecuatable(fileName): if CraftCore.compiler.isMacOS: signature = MACH_O_64 elif CraftCore.compiler.isLinux: signature = ELF else: raise Exception("Unsupported platform") with open(fileName, "rb") as f: return f.read(len(signature)) == signature return False def getLibraryDeps(path): deps = [] if CraftCore.compiler.isMacOS: # based on https://github.com/qt/qttools/blob/5.11/src/macdeployqt/shared/shared.cpp infoRe = re.compile("^\\t(.+) \\(compatibility version (\\d+\\.\\d+\\.\\d+), "+ "current version (\\d+\\.\\d+\\.\\d+)\\)$") with io.StringIO() as log: if not system(["otool", "-L", path], stdout=log, logCommand=False): return [] lines = log.getvalue().strip().split("\n") lines.pop(0)# name of the library for line in lines: match = infoRe.match(line) if match: deps.append(match[1]) return deps def regexFileFilter(filename : os.DirEntry, root : str, pattern : [re]=None) -> bool: """ return False if file does not match pattern""" # use linux style seperators relFilePath = Path(filename.path).relative_to(root).as_posix() for pattern in pattern: if pattern.search(relFilePath): CraftCore.log.debug(f"regExDirFilter: {relFilePath} matches: {pattern.pattern}") return True return False def filterDirectoryContent(root, whitelist=lambda f, root: True, blacklist=lambda g, root: False, allowBadSymlinks=False, handleAppBundleAsFile=False): """ Traverse through a directory tree and return every filename that the function whitelist returns as true and which do not match blacklist entries """ if not os.path.exists(root): return dirs = [root] while dirs: path = dirs.pop() with os.scandir(path) as scan: for filePath in scan: if not allowBadSymlinks and filePath.is_symlink(): if Path(root) not in Path(filePath.path).resolve().parents: CraftCore.log.debug(f"filterDirectoryContent: skipping {filePath.path}, it is not located under {root}") continue if filePath.is_dir(follow_symlinks=False): # handle .app folders and dsym as files if not CraftCore.compiler.isMacOS or not (filePath.name.endswith(".dSYM") or handleAppBundleAsFile and filePath.name.endswith(".app")): dirs.append(filePath.path) continue if blacklist(filePath, root=root) and not whitelist(filePath, root=root): continue elif filePath.is_dir(): yield filePath.path elif filePath.is_file(): yield filePath.path elif filePath.is_symlink(): if not allowBadSymlinks: CraftCore.log.warning(f"{filePath.path} is an invalid link ({os.readlink(filePath.path)})") continue else: yield filePath.path else: CraftCore.log.warning(f"Unhandled case: {filePath}") raise Exception(f"Unhandled case: {filePath}") @contextlib.contextmanager def makeWritable(targetPath: Path): if isinstance(targetPath, str): targetPath = Path(targetPath) originalMode = targetPath.stat().st_mode wasWritable = bool(originalMode & stat.S_IWUSR) try: # ensure it is writable if not wasWritable: targetPath.chmod(originalMode | stat.S_IWUSR) yield targetPath finally: if not wasWritable: targetPath.chmod(originalMode) def getPDBForBinary(path :str) -> str: with open(path, "rb") as f: data = f.read() pdb = data.rfind(b".pdb") if pdb: return data[data.rfind(0x00, 0, pdb) + 1:pdb + 4].decode("utf-8") return "" def installShortcut(name : str, path : str, workingDir : str, icon : str, desciption : str): if not CraftCore.compiler.isWindows: return True from shells import Powershell pwsh = Powershell() shortcutPath = Path(os.environ["APPDATA"]) / f"Microsoft/Windows/Start Menu/Programs/Craft/{name}.lnk" shortcutPath.parent.mkdir(parents=True, exist_ok=True) return pwsh.execute([os.path.join(CraftCore.standardDirs.craftBin(), "install-lnk.ps1"), "-Path", pwsh.quote(path), "-WorkingDirectory", pwsh.quote(OsUtils.toNativePath(workingDir)), "-Name", pwsh.quote(shortcutPath), "-Icon", pwsh.quote(icon), "-Description", pwsh.quote(desciption)]) def strip(fileName): """strip debugging informations from shared libraries and executables - mingw only!!! """ if CraftCore.compiler.isMSVC() or not CraftCore.compiler.isGCCLike(): CraftCore.log.warning(f"Skipping stripping of {fileName} -- either disabled or unsupported with this compiler") return True fileName = Path(fileName) isBundle = False if CraftCore.compiler.isMacOS: bundleDir = list(filter(lambda x: x.name.endswith(".framework") or x.name.endswith(".app"), fileName.parents)) if bundleDir: suffix = "" # if we are a .app in a .framework we put the smbols in the same location if len(bundleDir) > 1: suffix = f"-{'.'.join([x.name for x in reversed(bundleDir[0:-1])])}" isBundle = True symFile = Path(f"{bundleDir[-1]}{suffix}.dSYM") else: symFile = Path(f"{fileName}.dSYM") else: symFile = Path(f"{fileName}.sym") if not isBundle and symFile.exists(): return True elif (symFile / "Contents/Resources/DWARF" / fileName.name).exists(): return True if CraftCore.compiler.isMacOS: return (system(["dsymutil", fileName, "-o", symFile]) and system(["strip", "-x", "-S", fileName])) else: return (system(["objcopy", "--only-keep-debug", fileName, symFile]) and system(["strip", "--strip-debug", "--strip-unneeded", fileName]) and system(["objcopy", "--add-gnu-debuglink", symFile, fileName]))