Issue 3967 - Properly handle non-existing file-mappings

packager.py

 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 # Note: These are the base functions common to all packagers, the actual
 # packagers are implemented in packagerGecko and packagerChrome.
 
 import sys
 import os
 import re
@@ skipping 73 matching lines @@
         self.includedFiles = includedFiles
         self.ignoredFiles = ignoredFiles
         self.process = process
 
     def __setitem__(self, key, value):
         if self.process:
             value = self.process(key, value)
         dict.__setitem__(self, key, value)
 
     def isIncluded(self, relpath):
+        return relpath.split('/')[0] in self.includedFiles
+
+    def is_ignored(self, relpath):
         parts = relpath.split('/')
-        if not parts[0] in self.includedFiles:
-            return False
-        for part in parts:
-            if part in self.ignoredFiles:
-                return False
-        return True
+        return any([part in self.ignoredFiles for part in parts])

[Sebastian Noack, 2017/07/17 14:02:32]

Nit: The brackets in order to generate a temporary list are unnecessary here.
If omitted, a generator will be created and passed to any() instead, but the
result will be the same. However, a generator will use less memory if the
sequence is getting large. But more importantly the syntax is more concise,
and therefore improves readability, slightly, IMO.

[tlucas, 2017/07/17 14:56:16]

Acknowledged.

 
     def read(self, path, relpath='', skip=()):
         if os.path.isdir(path):
             for file in os.listdir(path):
                 name = relpath + ('/' if relpath != '' else '') + file
-                if name not in skip and self.isIncluded(name):
+                if (name not in skip
+                        and self.isIncluded(name) and not self.is_ignored(name)):
                     self.read(os.path.join(path, file), name, skip)
         else:
             with open(path, 'rb') as file:
                 if relpath in self:
                     print >>sys.stderr, 'Warning: File %s defined multiple times' % relpath
                 self[relpath] = file.read()
 
     def readMappedFiles(self, mappings):
         for item in mappings:
             target, source = item
 
-            # Make sure the file is inside an included directory
-            if '/' in target and not self.isIncluded(target):
+            if '/' in target and self.is_ignored(target):
                 continue
+
             parts = source.split('/')
             path = os.path.join(os.path.dirname(item.source), *parts)
             if os.path.exists(path):
                 self.read(path, target)
             else:
                 print >>sys.stderr, "Warning: Mapped file %s doesn't exist" % source
 
     def preprocess(self, filenames, params={}):
         import jinja2
         env = jinja2.Environment()
 
         for filename in filenames:
             env.autoescape = os.path.splitext(filename)[1].lower() in ('.html', '.xml')
             template = env.from_string(self[filename].decode('utf-8'))
             self[filename] = template.render(params).encode('utf-8')
 
     def zip(self, outFile, sortKey=None, compression=zipfile.ZIP_DEFLATED):
         with zipfile.ZipFile(outFile, 'w', compression) as zf:
             for name in sorted(self, key=sortKey):
                 zf.writestr(name, self[name])
 
     def zipToString(self, sortKey=None):
         buffer = StringIO()
         self.zip(buffer, sortKey=sortKey)
         return buffer.getvalue()