Reworked gitFile plugin so that it does not suck anymore; Plugins can now access the global libreselery configuration object via self.getGlobals(), which is used by the gitFile plugin to identify the directory to look for files; Added file filter into gitFile plugin so that only files matching the given patterns will be blamed for information protontypes#164

Author: kikass13

libreselery/contribution_action_plugins/git_file_contribution_action.py

@@ -44,6 +44,8 @@ def initialize_(self, action):
         Returns:
         bool: True if successfully initialized
         """
+        self.fileFilters = action.applies_to
+        self.directory = self.getGlobals().directory
         return True
 
     def gather_(self, cachedContributors=[]):
@@ -99,41 +101,53 @@ def gather_(self, cachedContributors=[]):
     ##################################################################################
 
     def execGit(self):
-        cmd = [
+        fileFilterStr = " ".join(
+            [
+                "--exclude %s" % contributionTarget.target
+                for contributionTarget in self.fileFilters
+            ]
+        )
+        cmds = [
             "git",
             "ls-files",
-            "|",
-            "while read f;",
-            'do echo "%s$f";' % self.GITBLAMESEPERATOR,
-            "git blame -CCC --line-porcelain $f;",
-            "done",
+            "--directory",  ### directory to look for files
+            self.directory,
+            "--ignored",  ### only ls files matching the excluded files (via --exclude)
+            fileFilterStr,  ### string containing patterns for all files that should be searched for
         ]
-
+        cmd = " ".join(cmds)
         ps = subprocess.Popen(
-            " ".join(cmd), shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+            cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
         )
         stdout, stderr = ps.communicate()
-
-        fileContributions = {}
         if not stderr:
+            ### encode output
             encoded = stdout.decode("utf-8")
-            ### split output for each file (we added "\n" manually to seperate each file output)
-            fileblames = encoded.split(self.GITBLAMESEPERATOR)[
-                1:
-            ]  ### 0 entry is empty because reasons ... :D
-            for blame in fileblames:
-                ### seperate lines into array
-                lines = blame.split("\n")
-                filename = lines[0]
-                lines = lines[1:]
-                ### put lines through blameParser
-                fileContributorDict = self.parseBlame(lines)
-                ### filter out unwanted users, for example the one git blame adds
-                ### in case there are uncommitted changes
-                ###     "<not.committed.yet>", "Not Committed Yet"
-                if "not.committed.yet" in fileContributorDict:
-                    del fileContributorDict["not.committed.yet"]
-                fileContributions[filename] = fileContributorDict
+            fileList = encoded.split("\n")
+            ### exec git blame for each file
+            fileContributions = {}
+            for file in fileList:
+                cmd = "git blame -CCC --line-porcelain %s" % file
+                ps = subprocess.Popen(
+                    cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+                )
+                stdout, stderr = ps.communicate()
+                if not stderr:
+                    try:
+                        ### this can fail when blaming binary files for example, we skip those
+                        encoded = stdout.decode("utf-8")
+                    except UnicodeDecodeError as e:
+                        continue
+                    ### seperate lines into array
+                    lines = encoded.split("\n")
+                    ### put lines through blameParser
+                    fileContributorDict = self.parseBlame(lines)
+                    ### filter out unwanted users, for example the one git blame adds
+                    ### in case there are uncommitted changes
+                    ###     "<not.committed.yet>", "Not Committed Yet"
+                    if "not.committed.yet" in fileContributorDict:
+                        del fileContributorDict["not.committed.yet"]
+                    fileContributions[file] = fileContributorDict
         return fileContributions
 
     def processFileContributorDict(self, fcDict):

libreselery/contribution_distribution_engine.py

@@ -16,7 +16,7 @@ def _extractContributionDomains(self, config):
         ### read the config and parse usable objects for each domain configured
         domains = []
         for domainDict in config.contribution_domains:
-            domain = cdetypes.ContributionDomain(domainDict)
+            domain = cdetypes.ContributionDomain(domainDict, globalConfig=config)
             domains.append(domain)
         return domains
 

libreselery/contribution_distribution_engine_types.py

@@ -65,8 +65,9 @@ def __init__(self, d, domainRef):
 class ContributionDomain(object):
     """docstrig for ClassName"""
 
-    def __init__(self, d):
+    def __init__(self, d, globalConfig={}):
         super(ContributionDomain, self).__init__()
+        self.globalConfig = globalConfig
         self.name = next(iter(d))
         content = d.get(self.name)
         # self.__dict__.update(d.get(self.name))
@@ -78,7 +79,7 @@ def __init__(self, d):
     def initialize_(self):
         ### in case we have actions, prepare plugins
         for action in self.actions:
-            ret = action.initialize_()
+            ret = action.initialize_(globalConfig=self.globalConfig)
             if not ret:
                 raise ImportError(
                     "ContributionActionPlugin %s could not be initialized properly! [ret: %s]"
@@ -130,6 +131,8 @@ def __repr__(self):
 
 @pluginlib.Parent("action")
 class ContributionActionPlugin(object):
+    _globals_ = {}
+
     def __init__(self):
         super(ContributionActionPlugin, self).__init__()
         self.debug = False
@@ -142,9 +145,18 @@ def initialize_(self, action):
     def gather_(self, cachedContributors=[]):
         pass
 
-    def setDebug_(self, debug):
+    def setDebug(self, debug):
         self.debug = debug
 
+    def getDebug(self):
+        return self.debug
+
+    def setGlobals(self, d):
+        self._globals_ = d
+
+    def getGlobals(self):
+        return self._globals_
+
     def log(self, msg):
         if self.debug:
             print("\t[.] Plugin [%s]: '%s'" % (self._alias_, msg))
@@ -159,7 +171,8 @@ def __init__(self, d):
         applyLookupDict(ACTION_LOOKUP_TYPES, content, self)
         self.plugin = None
 
-    def initialize_(self):
+    def initialize_(self, globalConfig={}):
+        self.globalConfig = globalConfig
         pluginName = self.type.name
         ### initialize/load module & plugin
         moduleName = "%s.%s" % (ACTION_PLUGIN_MODULE_PREFIX, pluginName)
@@ -175,7 +188,10 @@ def initialize_(self):
             )()  ### plugins.<pluginlib.Parent>.<plugin_alias>
             ### dirty little debug flag set for newly instanced plugin
             ### this has to be dne in a better way but works for now
-            self.plugin.setDebug_(self.debug)
+            self.plugin.setDebug(self.debug)
+            ### provide all global configuration parameters
+            ### for this plugin
+            self.plugin.setGlobals(self.globalConfig)
             ### initialize plugin
             pluginInitSuccess = self.plugin.initialize_(self)
         return pluginInitSuccess