Create PackageManifest classes for windows manifests

Creates PackageManifest classes for various windows manifests
and overrides the methods for detection and PackageManifest creation.

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

src/packagedcode/__init__.py

@@ -99,11 +99,11 @@
     build.BuckPackage,
     build.AutotoolsPackage,
     conda.Condayml,
-    win_pe.WindowsExecutable,
+    win_pe.WindowsExecutableManifest,
     readme.ReadmeManifest,
     build.MetadataBzl,
     msi.MsiInstallerPackage,
-    windows.MicrosoftUpdateManifestPackage,
+    windows.MicrosoftUpdateManifest,
     pubspec.PubspecYAML,
     pubspec.PubspecLock
 ]

src/packagedcode/win_pe.py

@@ -222,26 +222,8 @@ def pe_info(location):
 
 
 @attr.s()
-class WindowsExecutable(models.Package, models.PackageManifest):
-    file_patterns = ()
-    extensions = (
-        '.exe',
-        '.dll',
-        '.mui',
-        '.mun',
-        '.com',
-        '.winmd',
-        '.sys',
-        '.tlb',
-        '.exe_*',
-        '.dll_*',
-        '.mui_*',
-        '.mun_*',
-        '.com_*',
-        '.winmd_*',
-        '.sys_*',
-        '.tlb_*',
-    )
+class WindowsExecutable(models.Package):
+    
     filetypes = ('pe32', 'for ms windows',)
     mimetypes = ('application/x-dosexec',)
 
@@ -251,10 +233,6 @@ class WindowsExecutable(models.Package, models.PackageManifest):
     default_download_baseurl = None
     default_api_baseurl = None
 
-    @classmethod
-    def recognize(cls, location):
-        yield parse(location)
-
 
 def get_first(mapping, *keys):
     """
@@ -279,75 +257,100 @@ def concat(mapping, *keys):
     return '\n'.join(values)
 
 
-def parse(location):
-    """
-    Return a WindowsExecutable package from the file at `location` or None.
-    """
-    if not filetype.is_file(location):
-        return
-
-    T = contenttype.get_type(location)
-    if not T.is_winexe:
-        return
-
-    infos = pe_info(location)
-
-    version = get_first(
-        infos,
-        'Full Version',
-        'ProductVersion',
-        'FileVersion',
-        'Assembly Version',
-    )
-    release_date = get_first(infos, 'BuildDate')
-    if release_date:
-        if len(release_date) >= 10:
-            release_date = release_date[:10]
-        release_date = release_date.replace('/', '-')
-
-    name = get_first(
-        infos,
-        'ProductName',
-        'OriginalFilename',
-        'InternalName',
+@attr.s()
+class WindowsExecutableManifest(WindowsExecutable, models.PackageManifest):
+    extensions = (
+        '.exe',
+        '.dll',
+        '.mui',
+        '.mun',
+        '.com',
+        '.winmd',
+        '.sys',
+        '.tlb',
+        '.exe_*',
+        '.dll_*',
+        '.mui_*',
+        '.mun_*',
+        '.com_*',
+        '.winmd_*',
+        '.sys_*',
+        '.tlb_*',
     )
-    copyr = get_first(infos, 'LegalCopyright')
-
-    LegalCopyright = copyr,
-
-    LegalTrademarks = concat(
-        infos,
-        'LegalTrademarks',
-        'LegalTrademarks1',
-        'LegalTrademarks2',
-        'LegalTrademarks3')
+    manifest_type = 'winexe'
 
-    License = get_first(infos, 'License')
+    @classmethod
+    def is_manifest(cls, location):
+        """
+        Return True if the file at ``location`` is likely a manifest of this type.
+        """
+        T = contenttype.get_type(location)
+        return (filetype.is_file(location) and T.is_winexe)
 
-    declared_license = {}
-    if LegalCopyright or LegalTrademarks or License:
-        declared_license = dict(
-            LegalCopyright=copyr,
-            LegalTrademarks=LegalTrademarks,
-            License=License
+    @classmethod
+    def recognize(cls, location):
+        """
+        Yield one or more Package manifest objects given a file ``location`` pointing to a
+        package archive, manifest or similar.
+        """
+        infos = pe_info(location)
+
+        version = get_first(
+            infos,
+            'Full Version',
+            'ProductVersion',
+            'FileVersion',
+            'Assembly Version',
+        )
+        release_date = get_first(infos, 'BuildDate')
+        if release_date:
+            if len(release_date) >= 10:
+                release_date = release_date[:10]
+            release_date = release_date.replace('/', '-')
+
+        name = get_first(
+            infos,
+            'ProductName',
+            'OriginalFilename',
+            'InternalName',
+        )
+        copyr = get_first(infos, 'LegalCopyright')
+
+        LegalCopyright = copyr,
+
+        LegalTrademarks = concat(
+            infos,
+            'LegalTrademarks',
+            'LegalTrademarks1',
+            'LegalTrademarks2',
+            'LegalTrademarks3')
+
+        License = get_first(infos, 'License')
+
+        declared_license = {}
+        if LegalCopyright or LegalTrademarks or License:
+            declared_license = dict(
+                LegalCopyright=copyr,
+                LegalTrademarks=LegalTrademarks,
+                License=License
+            )
+
+        description = concat(infos, 'FileDescription', 'Comments')
+
+        parties = []
+        cname = get_first(infos, 'CompanyName', 'Company')
+
+        if cname:
+            parties = [Party(type=party_org, role='author', name=cname)]
+        homepage_url = get_first(infos, 'URL', 'WWW')
+
+        yield cls(
+            name=name,
+            version=version,
+            release_date=release_date,
+            copyright=copyr,
+            declared_license=declared_license,
+            description=description,
+            parties=parties,
+            homepage_url=homepage_url,
         )
-
-    description = concat(infos, 'FileDescription', 'Comments')
-
-    parties = []
-    cname = get_first(infos, 'CompanyName', 'Company')
-
-    if cname:
-        parties = [Party(type=party_org, role='author', name=cname)]
-    homepage_url = get_first(infos, 'URL', 'WWW')
-
-    return WindowsExecutable(
-        name=name,
-        version=version,
-        release_date=release_date,
-        copyright=copyr,
-        declared_license=declared_license,
-        description=description,
-        parties=parties,
-        homepage_url=homepage_url,
-    )

src/packagedcode/windows.py

@@ -11,6 +11,7 @@
 import xmltodict
 
 from packagedcode import models
+from commoncode import filetype
 
 
 # Tracing flags
@@ -34,66 +35,65 @@ def logger_debug(*args):
 
 
 @attr.s()
-class MicrosoftUpdateManifestPackage(models.Package, models.PackageManifest):
+class MicrosoftUpdatePackage(models.Package, models.PackageManifest):
     extensions = ('.mum',)
     filetypes = ('xml 1.0 document',)
     mimetypes = ('text/xml',)
 
     default_type = 'windows-update'
 
+
+@attr.s()
+class MicrosoftUpdateManifest(MicrosoftUpdatePackage, models.PackageManifest):
+
+    manifest_type = 'winupdatemanifest'
+
+    @classmethod
+    def is_manifest(cls, location):
+        """
+        Return True if the file at ``location`` is likely a manifest of this type.
+        """
+        return filetype.is_file(location) and location.endswith('.mum')
+
     @classmethod
     def recognize(cls, location):
-        yield parse(location)
-
-
-def parse_mum(location):
-    """
-    Return a dictionary of Microsoft Update Manifest (mum) metadata from a .mum
-    file at `location`. Return None if this is not a parsable mum file. Raise
-    Exceptions on errors.
-    """
-    if not location.endswith('.mum'):
-        return
-    with open(location , 'rb') as loc:
-        return xmltodict.parse(loc)
-
-
-def parse(location):
-    """
-    Return a MicrosoftUpdateManifestPackage from a .mum XML file at `location`.
-    Return None if this is not a parsable .mum file.
-    """
-    parsed = parse_mum(location)
-    if TRACE:
-        logger_debug('parsed:', parsed)
-    if not parsed:
-        return
-
-    assembly = parsed.get('assembly', {})
-    description = assembly.get('@description', '')
-    company = assembly.get('@company', '')
-    copyright = assembly.get('@copyright', '')
-    support_url = assembly.get('@supportInformation', '')
-
-    assembly_identity = assembly.get('assemblyIdentity', {})
-    name = assembly_identity.get('@name', '')
-    version = assembly_identity.get('@version', '')
-
-    parties = []
-    if company:
-        parties.append(
-            models.Party(
-                name=company,
-                type=models.party_org,
-                role='owner',
+        """
+        Yield one or more Package manifest objects given a file ``location`` pointing to a
+        package archive, manifest or similar.
+        """
+        with open(location , 'rb') as loc:
+            parsed = xmltodict.parse(loc)
+
+        if TRACE:
+            logger_debug('parsed:', parsed)
+        if not parsed:
+            return
+
+        assembly = parsed.get('assembly', {})
+        description = assembly.get('@description', '')
+        company = assembly.get('@company', '')
+        copyright = assembly.get('@copyright', '')
+        support_url = assembly.get('@supportInformation', '')
+
+        assembly_identity = assembly.get('assemblyIdentity', {})
+        name = assembly_identity.get('@name', '')
+        version = assembly_identity.get('@version', '')
+
+        parties = []
+        if company:
+            parties.append(
+                models.Party(
+                    name=company,
+                    type=models.party_org,
+                    role='owner',
+                )
             )
-        )
 
-    return MicrosoftUpdateManifestPackage(
-        name=name,
-        version=version,
-        description=description,
-        homepage_url=support_url,
-        parties=parties,
-        copyright=copyright,
-    )
+        yield cls(
+            name=name,
+            version=version,
+            description=description,
+            homepage_url=support_url,
+            parties=parties,
+            copyright=copyright,
+        )

tests/packagedcode/data/plugin/help.txt

@@ -382,13 +382,13 @@ Package: war
 
 --------------------------------------------
 Package: windows-update
-  class: packagedcode.windows:MicrosoftUpdateManifestPackage
+  class: packagedcode.windows:MicrosoftUpdateManifest
   extensions: .mum
   filetypes: xml 1.0 document
 
 --------------------------------------------
 Package: winexe
-  class: packagedcode.win_pe:WindowsExecutable
+  class: packagedcode.win_pe:WindowsExecutableManifest
   extensions: .exe, .dll, .mui, .mun, .com, .winmd, .sys, .tlb, .exe_*, .dll_*, .mui_*, .mun_*, .com_*, .winmd_*, .sys_*, .tlb_*
   filetypes: pe32, for ms windows