Files
munki/code/client/makecatalogs
T
Heig Gregorian d92127c241 Initial commit for new installer_type 'apple-update-metadata'
Using the new '--apple-update' option available in makepkginfo (and
therefore munkiimport), an admin can generate metadata pkginfo files
for Apple updates.  Supported metadata keys will modify munki's
behavior of the specified Apple update offered to the client.  Examples
would include 'force_install_after_date' and 'RestartAction'.  The
'makecatalogs' utility has also been updated to allow for this new
installer_type when creating catalogs.

NOTE: Client-side implementation is not included in this commit.  This
commit only deals with the creation of these specialized pkginfo files.
2013-02-06 13:53:43 -08:00

232 lines
8.2 KiB
Python
Executable File

#!/usr/bin/env python
# encoding: utf-8
#
# Copyright 2009-2013 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.
"""
makecatalogs
Created by Greg Neagle on 2009-03-30.
Recursively scans a directory, looking for installer item info files.
Builds a repo catalog from these files.
Assumes a pkgsinfo directory under repopath.
User calling this needs to be able to write to repo/catalogs.
"""
import sys
import os
import optparse
try:
from munkilib import FoundationPlist as plistlib
LOCAL_PREFS_SUPPORT = True
except ImportError:
try:
import FoundationPlist as plistlib
LOCAL_PREFS_SUPPORT = True
except ImportError:
# maybe we're not on an OS X machine...
print >> sys.stderr, ("WARNING: FoundationPlist is not available, "
"using plistlib instead.")
import plistlib
LOCAL_PREFS_SUPPORT = False
try:
from munkilib.munkicommon import listdir, get_version
except ImportError:
# munkilib is not available
def listdir(path):
"""OSX HFS+ string encoding safe listdir().
Args:
path: path to list contents of
Returns:
list of contents, items as str or unicode types
"""
# if os.listdir() is supplied a unicode object for the path,
# it will return unicode filenames instead of their raw fs-dependent
# version, which is decomposed utf-8 on OSX.
#
# we use this to our advantage here and have Python do the decoding
# work for us, instead of decoding each item in the output list.
#
# references:
# http://docs.python.org/howto/unicode.html#unicode-filenames
# http://developer.apple.com/library/mac/#qa/qa2001/qa1235.html
# http://lists.zerezo.com/git/msg643117.html
# http://unicode.org/reports/tr15/ section 1.2
if type(path) is str:
path = unicode(path, 'utf-8')
elif type(path) is not unicode:
path = unicode(path)
return os.listdir(path)
def get_version():
'''Placeholder if munkilib is not available'''
return 'UNKNOWN'
def makecatalogs(repopath):
'''Assembles all pkginfo files into catalogs.
Assumes a pkgsinfo directory under repopath.
User calling this needs to be able to write to the repo/catalogs
directory.'''
pkgsinfopath = os.path.join(repopath, 'pkgsinfo')
if not os.path.exists(pkgsinfopath):
print >> sys.stderr, "pkgsinfo path %s doesn't exist!" % pkgsinfopath
exit(-1)
errors = []
catalogs = {}
catalogs['all'] = []
for dirpath, dirnames, filenames in os.walk(pkgsinfopath):
for dirname in dirnames:
# don't recurse into directories that start
# with a period.
if dirname.startswith('.'):
dirnames.remove(dirname)
for name in filenames:
if name.startswith('.'):
# skip files that start with a period as well
continue
filepath = os.path.join(dirpath, name)
try:
pkginfo = plistlib.readPlist(filepath)
# don't copy admin notes to catalogs.
if pkginfo.get('notes'):
del(pkginfo['notes'])
except IOError, inst:
errors.append("IO error for %s: %s" % (filepath, inst))
continue
except Exception, inst:
errors.append("Unexpected error for %s: %s" % (filepath, inst))
continue
#simple sanity checking
installer_type = pkginfo.get('installer_type')
if not installer_type in ['nopkg', 'apple-update-metadata']:
if not 'installer_item_location' in pkginfo:
errors.append(
"WARNING: file %s is missing installer_item_location" %
filepath[len(pkgsinfopath)+1:])
continue
try:
installeritempath = os.path.join(repopath, "pkgs",
pkginfo['installer_item_location'])
except TypeError:
errors.append("WARNING: invalid installer_item_location"
" in info file %s" % filepath[len(pkgsinfopath)+1:])
continue
if not os.path.exists(installeritempath):
errors.append("WARNING: Info file %s refers to "
"missing installer item: %s" %
(filepath[len(pkgsinfopath)+1:],
pkginfo['installer_item_location']))
continue
catalogs['all'].append(pkginfo)
for catalogname in pkginfo.get("catalogs", []):
if not catalogname:
errors.append("WARNING: Info file %s has an empty "
"catalog name!" %
filepath[len(pkgsinfopath)+1:])
continue
if not catalogname in catalogs:
catalogs[catalogname] = []
catalogs[catalogname].append(pkginfo)
print "Adding %s to %s..." % \
(filepath[len(pkgsinfopath)+1:], catalogname)
if errors:
# group all errors at the end for better visibility
print
for error in errors:
print >> sys.stderr, error
# clear out old catalogs
catalogpath = os.path.join(repopath, "catalogs")
if not os.path.exists(catalogpath):
os.mkdir(catalogpath)
else:
for item in listdir(catalogpath):
itempath = os.path.join(catalogpath, item)
if os.path.isfile(itempath):
os.remove(itempath)
# write the new catalogs
for key in catalogs.keys():
catalogpath = os.path.join(repopath, "catalogs", key)
if os.path.exists(catalogpath):
print >> sys.stderr, ("WARNING: catalog %s already exists at "
"%s. Perhaps this is a non-case sensitive filesystem and you "
"have catalogs with names differing only in case?"
% (key, catalogpath))
else:
plistlib.writePlist(catalogs[key], catalogpath)
def pref(prefname):
"""Returns a preference for prefname"""
if not LOCAL_PREFS_SUPPORT:
return None
try:
_prefs = plistlib.readPlist(PREFSPATH)
except Exception:
return None
if prefname in _prefs:
return _prefs[prefname]
else:
return None
PREFSNAME = 'com.googlecode.munki.munkiimport.plist'
PREFSPATH = os.path.expanduser(os.path.join('~/Library/Preferences',
PREFSNAME))
def main():
'''Main'''
usage = "usage: %prog [options] [/path/to/repo_root]"
p = optparse.OptionParser(usage=usage)
p.add_option('--version', '-V', action='store_true',
help='Print the version of the munki tools and exit.')
options, arguments = p.parse_args()
if options.version:
print get_version()
exit(0)
repopath = None
if len(arguments) == 0:
repopath = pref('repo_path')
if not repopath:
print >> sys.stderr, "Need to specify a path to the repo root!"
exit(-1)
else:
print "Using repo path: %s" % repopath
else:
repopath = arguments[0].rstrip("/")
if not os.path.exists(repopath):
print >> sys.stderr, "Repo root path %s doesn't exist!" % repopath
exit(-1)
makecatalogs(repopath)
if __name__ == '__main__':
main()