added FoundationPlist since some apps store Info.plist in binary

Author: scriptingosx

quickpkg

@@ -4,16 +4,161 @@ import argparse
 import string
 import os
 import subprocess
-import plistlib
 import tempfile
 import shutil
 import stat
 
+# includes FoundationPlist since some apps store their Info.plist
+# as binary PropertyLists
+
+# FoundationPlist:
+
+# Copyright 2009-2014 Greg Neagle.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""FoundationPlist.py -- a tool to generate and parse MacOSX .plist files.
+
+This is intended as a drop-in replacement for Python's included plistlib,
+with a few caveats:
+    - readPlist() and writePlist() operate only on a filepath,
+        not a file object.
+    - there is no support for the deprecated functions:
+        readPlistFromResource()
+        writePlistToResource()
+    - there is no support for the deprecated Plist class.
+
+The Property List (.plist) file format is a simple XML pickle supporting
+basic object types, like dictionaries, lists, numbers and strings.
+Usually the top level object is a dictionary.
+
+To write out a plist file, use the writePlist(rootObject, filepath)
+function. 'rootObject' is the top level object, 'filepath' is a
+filename.
+
+To parse a plist from a file, use the readPlist(filepath) function,
+with a file name. It returns the top level object (again, usually a
+dictionary).
+
+To work with plist data in strings, you can use readPlistFromString()
+and writePlistToString().
+"""
+
+from Foundation import NSData, \
+                       NSPropertyListSerialization, \
+                       NSPropertyListMutableContainersAndLeaves, \
+                       NSPropertyListXMLFormat_v1_0
+
+
+class FoundationPlistException(Exception):
+    '''Base error for this module'''
+    pass
+
+
+class NSPropertyListSerializationException(FoundationPlistException):
+    '''Read error for this module'''
+    pass
+
+
+class NSPropertyListWriteException(FoundationPlistException):
+    '''Write error for this module'''
+    pass
+
+
+# private functions
+def _dataToPlist(data):
+    '''low-level function that parses a data object into a propertyList object'''
+    darwin_vers = int(os.uname()[2].split('.')[0])
+    if darwin_vers > 10:
+        (plistObject, plistFormat, error) = (
+            NSPropertyListSerialization.propertyListWithData_options_format_error_(
+                data, NSPropertyListMutableContainersAndLeaves, None, None))
+    else:
+        # 10.5 doesn't support propertyListWithData:options:format:error:
+        # 10.6's PyObjC wrapper for propertyListWithData:options:format:error:
+        #        is broken
+        # so use the older NSPropertyListSerialization function
+        (plistObject, plistFormat, error) = (
+            NSPropertyListSerialization.propertyListFromData_mutabilityOption_format_errorDescription_(
+                         data, NSPropertyListMutableContainersAndLeaves, None, None))
+    if plistObject is None:
+        if error is None:
+            error = "Plist data is invalid and could not be deserialized."
+        raise NSPropertyListSerializationException(error)
+    else:
+        return plistObject
+
+
+def _plistToData(plistObject):
+    '''low-level function that creates NSData from a plist object'''
+    darwin_vers = int(os.uname()[2].split('.')[0])
+    if darwin_vers > 10:
+        (data, error) = (
+            NSPropertyListSerialization.dataWithPropertyList_format_options_error_(
+                plistObject, NSPropertyListXMLFormat_v1_0, 0, None))
+    else:
+        # use the older NSPropertyListSerialization function on 10.6 and 10.5
+        (data, error) = (
+            NSPropertyListSerialization.dataFromPropertyList_format_errorDescription_(
+                plistObject, NSPropertyListXMLFormat_v1_0, None))
+    if data is None:
+        if error is None:
+            error = "Property list invalid for format."
+        raise NSPropertyListSerializationException(error)
+    return data
+
+
+# public functions
+def readPlist(filepath):
+    '''Read a .plist file from filepath.  Return the unpacked root object
+    (which is usually a dictionary).'''
+    try:
+        data = NSData.dataWithContentsOfFile_(filepath)
+    except NSPropertyListSerializationException, error:
+        # insert filepath info into error message
+        errmsg = (u'%s in %s' % (error, filepath))
+        raise NSPropertyListSerializationException(errmsg)
+    return _dataToPlist(data)
+
+
+def readPlistFromString(aString):
+    '''Read a plist data from a string. Return the root object.'''
+    data = buffer(aString)
+    return _dataToPlist(data)
+
+
+def writePlist(plistObject, filepath):
+    '''Write 'plistObject' as a plist to filepath.'''
+    plistData = _plistToData(plistObject)
+    if plistData.writeToFile_atomically_(filepath, True):
+        return
+    else:
+        raise NSPropertyListWriteException(
+            u"Failed to write plist data to %s" % filepath)
 
-quickpkg_version = '0.3'
-supported_extensions = ['dmg', 'app', 'zip']
 
+def writePlistToString(plistObject):
+    '''Create a plist-formatted string from plistObject.'''
+    return str(_plistToData(plistObject))
+
+
+# 
 # quickpkg
+# 
+
+
+quickpkg_version = '0.4'
+supported_extensions = ['dmg', 'app', 'zip']
+
 
 # modeled after munkiimport but to build a pkg
 
@@ -69,7 +214,7 @@ def dmg_has_sla(dmgpath):
         print "error getting imageinfo! %s, %s" % (result["return_code"], result["stderr"])
         return False
     result_plist = result["stdout"]
-    imageinfo_dict = plistlib.readPlistFromString(result_plist)
+    imageinfo_dict = readPlistFromString(result_plist)
     properties = imageinfo_dict.get('Properties')
     if properties is not None:
         has_sla = properties.get('Software License Agreement', False)
@@ -83,7 +228,7 @@ def attachdmg(dmgpath):
     if info_result["return_code"] == 0:
         # parse the plist output
         (theplist, alltext) = getFirstPlist(info_result["stdout"])
-        info_dict = plistlib.readPlistFromString(theplist)
+        info_dict = readPlistFromString(theplist)
         volpaths = []
         if "images" in info_dict.keys():
             for y in info_dict["images"]:
@@ -115,7 +260,7 @@ def attachdmg(dmgpath):
     if result["return_code"] == 0:
         # parse the plist output
         (theplist, alltext) = getFirstPlist(result["stdout"])
-        resultdict = plistlib.readPlistFromString(theplist)
+        resultdict = readPlistFromString(theplist)
         volpaths = []
         for x in resultdict["system-entities"]:
             if x["potentially-mountable"]:
@@ -157,7 +302,7 @@ def appNameAndVersion(app_path):
         print "Application at path %s does not have Info.plist" % app_path
         # TODO: cleanup volumes here
         cleanup_and_exit(1)
-    info_plist = plistlib.readPlist(info_path)
+    info_plist = readPlist(info_path)
     app_name = info_plist.get("CFBundleName")
     if app_name is None:
         app_name = info_plist.get("CFBundleDisplayName")

todo.txt

@@ -1,12 +1,7 @@
 - use some preference setting to determine default package name syntax
-√ add option to add scripts (--scripts, like the scripts folder)
-√ add option to add --preinstall script
-√ add option for --postinstall script
-√ support the --ownership flag
-√ option to output pkg to a different dir than cwd
 - signature support
 - identify shell scripts and build a payload free package
-- identify mobileconfigs and build a package installer if make-profile-pkg is present
 - support for tar, gzip and bzip
 ? other possible file formats: fonts, prefpanes, Safari extensions?
 ? identify app just by name or id (could use: mdfind "kMDItemKind == 'Application' && kMDItemDisplayName == 'iTunes'")
+? identify mobileconfigs and build a package installer if make-profile-pkg is present