This repository has been archived on 2023-03-25. You can view files and clone it, but cannot push or open issues or pull requests.

179 lines
8.7 KiB

#!/usr/bin/env python3
Upgrade MightyScape from Inkscape Extension Dialog. Made for end users
Extension for InkScape 1.X
Author: Mario Voigt / FabLab Chemnitz
Date: 14.05.2021
Last patch: 05.11.2021
License: GNU GPL v3
- add routine to check for differences between remotes (unequal commits)
import inkex
import os
import warnings
from datetime import datetime
import git
from git import Repo #requires GitPython lib
inkex.utils.debug("Error. GitPython was not installed but is required to run the upgrade process!")
class AboutUpgradeMightyScape(inkex.EffectExtension):
def update(self, local_repo, remote, localCommitCount):
inkex.utils.debug("Chosen remote is: {}".format(remote))
localCommit = local_repo.head.commit
remote_repo = git.remote.Remote(local_repo, remote)
remoteCommit = remote_repo.fetch()[0].commit
inkex.utils.debug("Latest remote commit is: " + str(remoteCommit)[:7])
remoteCommitCount = 0
for c in remote_repo.repo.iter_commits('origin/master'):
remoteCommitCount += 1
inkex.utils.debug("Commits at remote: {}".format(remoteCommitCount))
if localCommit.hexsha != remoteCommit.hexsha:
ssh_executable = 'git'
with local_repo.git.custom_environment(GIT_SSH=ssh_executable):
#origin = local_repo.remotes.origin
#fetch_info = origin.pull() #finally pull new data
fetch_info = remote_repo.fetch()
remote_repo.pull() #finally pull new data
for info in fetch_info: #should return only one line in total
inkex.utils.debug("Updated {} to commit id {}. {} commits were pulled".format(info.ref, str(info.commit)[:7], remoteCommitCount - localCommitCount))
inkex.utils.debug("Please restart Inkscape to let the changes take effect.")
inkex.utils.debug("Nothing to do! MightyScape is already up to date!")
except git.exc.GitCommandError as e:
inkex.utils.debug("Error: ")
return False
return True
def add_arguments(self, pars):
pars.add_argument("--convert_to_git", type=inkex.Boolean, default=False, help="If you downloaded MightyScape as .zip or .tar.gz you cannot upgrade using this extension. But you can convert your downloaded directory to a .git one by enabling this option")
pars.add_argument("--recreate_remotes", type=inkex.Boolean, default=False, help="Update remotes in git config file (useful if you have an older version of MightyScape or if sth. changes)")
pars.add_argument("--stash_untracked", type=inkex.Boolean, default=False, help="Stash untracked files and continue to upgrade")
def effect(self):
global so
so = self.options
warnings.simplefilter('ignore', ResourceWarning) #suppress "enable tracemalloc to get the object allocation traceback"
#get the directory of mightyscape
extension_dir = os.path.abspath(os.path.join(os.path.abspath(os.path.dirname(__file__)), '../')) #go up to main dir /home/<user>/.config/inkscape/extensions/mightyscape-1.X/
main_dir = os.path.abspath(os.path.join(extension_dir, '../../')) #go up to main dir /home/<user>/.config/inkscape/extensions/mightyscape-1.X/
#create some statistics
totalFolders = 0
for root, folders, files in os.walk(extension_dir):
totalFolders += len(folders)
break #prevent descending into subfolders
totalInx = 0
for root, folders, files in os.walk(extension_dir):
for file in files:
if file.endswith('.inx'):
totalInx += 1
inkex.utils.debug("Locally there are {} extension folders with {} .inx files!\n".format(totalFolders, totalInx))
remotes = []
remotes.append(["", "origin"]) #main
remotes.append(["", "github"]) #copy/second remote
gitDir = os.path.join(main_dir, ".git")
if not os.path.exists(gitDir):
if so.convert_to_git is True:
local_repo = Repo.init(main_dir)
localRemotes = []
for remote in remotes:
localRemotes.append(local_repo.create_remote(remote[1], url=remote[0]))
inkex.utils.debug("MightyScape .git directory was not found. It seems you installed MightyScape the traditional way (by downloading and extracting from archive). Please install MightyScape using the git clone method if you want to use the upgrade function. More details can be found in the official README.")
local_repo = Repo(gitDir)
#drop local changed. update might fail if file changes are present
if so.stash_untracked is True:
existingRemotes = [] #check for existing remotes. if one is missing, add it (or delete and recreate)
for r in local_repo.remotes:
for remote in remotes:
if remote[1] not in existingRemotes:
local_repo.create_remote(remote[1], url=remote[0])
if so.recreate_remotes is True: #delete and then recreate
local_repo.create_remote(remote[1], url=remote[0])
#check if it is a non-empty git repository
if local_repo.bare is False:
if local_repo.is_dirty(untracked_files=True) is False:
if len(local_repo.untracked_files) > 0:
if so.stash_untracked is True:
inkex.utils.debug("There are some untracked files in your MightyScape directory. Still trying to pull recent files from git...")
localLatestCommit = local_repo.head.commit
localCommits = list(local_repo.iter_commits("origin/master", skip=0))
localCommitCount = len(localCommits)
inkex.utils.debug("Local commit id is: " + str(localLatestCommit)[:7])
inkex.utils.debug("There are {} local commits at the moment.".format(localCommitCount))
localCommits = localCommits[:10] #get only last ten commits
localCommitList = []
for localCommit in localCommits:
inkex.utils.debug("Latest {} local commits are:".format(len(localCommits)))
for i in range(0, len(localCommits)):
inkex.utils.debug("{} | {} : {}".format(
datetime.utcfromtimestamp(localCommitList[i].committed_date).strftime('%Y-%m-%d %H:%M:%S'),
#inkex.utils.debug(" - {}: {}".format(localCommitList[i].newhexsha[:7], localCommitList[i].message))
#finally run the update
success = self.update(local_repo, remotes[0][1], localCommitCount)
if success is False: #try the second remote if first failed
inkex.utils.debug("Error receiving latest remote commit from main git remote {}. Trying second remote ...".format(remotes[0][0]))
success = self.update(local_repo, remotes[1][1], localCommitCount)
if success is False: #if still false:
inkex.utils.debug("Error receiving latest remote commit from second git remote {}.\nAre you offline? Cannot continue!".format(remotes[0][0]))
inkex.utils.debug("No \".git\" directory found. Seems your MightyScape was not installed with git clone. Please see documentation on how to do that.")
if __name__ == '__main__':