installSeed.py

#!/usr/bin/env python

#
# Script (installSeed.py) to get the latest seed package.
#
# Version 5.3 - Copyright (c) 2017-2018 by Dr. Pike R. Alpha (PikeRAlpha@yahoo.com)
#
# Updates:
#		   - comments added
#		   - target directory check added (Pike R. Alpha, August 2017)
#		   - filesize check added
#		   - renamed script
#		   - don't try to remove the .dist file if it isn't there.
#		   - copy InstallESDDmg.pkg to /Applications/Install macOS High Sierra Beta.app/Content/SharedSupport/InstallESD.dmg
#		   - set environment variable.
#		   - use sudo and path for productbuild.
#		   - internationalisation (i18n) support added (downloads the right dictionary).
#		   - initial refactoring done.
#		   - minor cleanups.
#		   - version number error fixed.
#		   - graceful exit with instructions to install pip/request module.
#		   - use urllib2 instead of requests (thanks to Per Olofsson aka MagerValp).
#		   - more refactoring work done.
#		   - improved output of macOS name and version.
#		   - swap line order (error in v2.3).
#		   - eliminated two global variables and fixed some whitespace errors.
#		   - improved output of downloads and streamlined use of arguments.
#		   - multithreaded package downloads.
#		   - undone the renaming of getPackages() from Brian's tree.
#		   - now showing a list of the queued downloads, and when they are finished.
#		   - show seed BuildID/Key and ask the user for consent before continuing.
#		   - checks added for user input.
#		   - copyright notice in output of script added.
#		   - minor cleanups.
#		   - whitespace, output (formatting) and indentation fixes.
#		   - initial support for seed updates and downloads of a single packet.
#		   - command line arguments added.
#		   - buildID checks added.
#		   - show confirmation text based on the current/seed buildID's.
#		   - unpack option -u [path] support added for downloaded files.
#		   - script will now stop/abort when Ctrl+C is pressed.
#		   - check for Beta seed added to copyFiles()
#		   - option -m added to select a target macOS version.
#		   - error handling for urllib2.urlopen() added.
#		   - fixed two typos.
#		   - white space only changes.
#		   - fixed NSLocale incompatibility issues (verified with El Capitan).
#		   - license added.
#		   - shebang line changed.
#		   - fall back to en_US if selectLanguage fails.
#		   - run pkgutil without sudo.
#		   - add the regular update CatalogURL.
#		   - read SystemVersion.plist from target volume.
#		   - read seed enrolment plist from target volume.
#		   - renamed targetPath to sourcePath.
#		   - removed two print statements (reducing the output).
#		   - improved text output where it counts.
#		   - show a list with available packages, if there's more than one.
#		   - fixed index error in getPackages.
#		   - catch invalid selection in getPackages.
#		   - added (initial/untested) support to install updates.
#		   - fix for the installation and upgrade errors (hopefully).
#		   - APFS conversion check added.
#		   - code styling improvements (now using double quotes for text).
#		   - renamed getBuildID() to getBuildAndVersion().
#		   - moved APFS confirmation to confirmAPFSConversion().
#		   - renamed variable unpackPackage to unpackFolder.
#		   - improved feedback for package expansion (think -u packagename).
#		   - additional code styling improvements (use single quotes for arguments).
#		   - SIP check implemented for startOSInstall().
#		   - select installation type (GUI/silent) based on SIP configuration.
#		   - check CSR configuration for Sierra and High Sierra only.
#		   - code improvements.
#		   - uncommented two lines that made v4.4 a failure.
#		   - catch languageCode not being defined.
#		   - check path of plists and fall back to root volume when it is missing.
#		   - fix index error.
#		   - show product selection only when there are more than one.
#		   - check (for) seed enrolment program added.
#		   - show buildID and not a part of the filename.
#		   - fix script execution from efiver.py
#		   - update key and targetPath in getPackages().
#		   - save files in the directory with the selected key.
#		   - skip partition selection if there is only one.
#
# License:
#		   -  BSD 3-Clause License
#
# Copyright (c) 2017-2018 by Dr. Pike R. Alpha, All Rights Reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the name(s) of its
#   contributor(s) may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

import os
import sys
import glob
import plistlib
import subprocess
import urllib2
import platform
import getopt
import signal
import objc

from os.path import basename
from Foundation import NSLocale, NSBundle, NSClassFromString
from multiprocessing import Pool
from xml.etree import ElementTree
from numbers import Number
from subprocess import Popen, PIPE
from ctypes import CDLL, c_uint, byref
from datetime import datetime

VERSION = "5.3"
DISKUTIL = "/usr/sbin/diskutil"
IATOOL = "Contents/MacOS/InstallAssistant"
STARTOSINSTALL = "Contents/Resources/startosinstall"

os.environ['__OS_INSTALL'] = "1"

SeedingBundle = NSBundle.bundleWithPath_('/System/Library/PrivateFrameworks/Seeding.framework')

functions = [
			 ('_stringForSeedProgram_', '@I'),
			 ('_setSeedProgramPref', '@I'),
			 ('_setCatalogForSeedProgram', '@I'),
			 ('_setHelpFeedbackMenuEnabled', '@I'),
			 ('_setSeedOptOutUIDisabled', '@I'),
			 ('_createFeedbackAssistantSymlink','@'),
			 ]

objc.loadBundleFunctions(SeedingBundle, globals(), functions)

#
# Setup seed program data.
#
seedProgramData = {
 "DeveloperSeed":"index-10.13seed-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
 "PublicSeed":"index-10.13beta-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
 "CustomerSeed":"index-10.13customerseed-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
 "Regular":"index-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog"
}

#
# International Components for Unicode (http://www.localeplanet.com/icu/)
#
icuData = {
 "el":"el",			#Greek
 "vi":"vi",			#English (U.S. Virgin Islands)
 "ca":"cs",			#Aghem (Cameroon)
 "ar":"ar",			#Arabic
 "cs":"cs",			#Czech
 "id":"id",			#Indonesian
 "ru":"ru",			#Russian
 "no":"no",			#Norwegian
 "tr":"tr",			#Turkish
 "th":"th",			#Thai
 "he":"he",			#Hebrew
 "pt":"pt",			#Portuguese
 "pl":"pl",			#Polish
 "uk":"uk",			#Ukrainian
 "hr":"hr",			#Croatian
 "hu":"hu",			#Hungarian
 "hi":"hi",			#Hindi
 "fi":"fi",			#Finnish
 "da":"da",			#Danish
 "ro":"rp",			#Romanian
 "ko":"ko",			#Korean
 "sv":"sv",			#Swedish
 "sk":"sk",			#Slovak
 "ms":"ms",			#Malay
 "en":"English",	#English
 "ja":"Japanese",	#Japanese
 "nl":"Dutch",		#Dutch
 "fr":"French",		#French
 "it":"Italian",	#Italian
 "de":"German",		#German
 "es":"Spanish",	#Spanish
 "es_419":"es_419",	#Latin American Spanish
 "zh_TW":"zh_TW",	#Chinese (Traditional, Taiwan)
 "zh_CN":"zh_CN",	#Chinese (Simplified, China, Hong Kong, Macau and Singapore)
 "pt":"pt",			#Portuguese (Angola, Brazil, Guinea-Bissau and Mozambique)
 "pt_PT":"pt_PT"	#Portuguese (Portugal)
}

#
# The target directory.
#
tmpDirectory="tmp"

#
# Name of target installer package.
#
installerPackage="installer.pkg"

def enrollInSeedProgram(targetVolume, targetProductVersion):
	print "\n[ 1 ] Customer Seed"
	print "[ 2 ] Developer Seed"
	print "[ 3 ] Public Beta Seed\n"
	
	while True:
		try:
			program = int(raw_input("Select program: "))
			if program < 1 or program > 3:
				sys.stdout.write("\033[F\033[K")
			else:
				break;
		except:
			sys.stdout.write("\033[F\033[K")

	seedProgramManager = NSClassFromString('SDSeedProgramManager')
	seedProgram = seedProgramManager._stringForSeedProgram_(program)
	print "Seeding: Enrolling in seed program: %s" % seedProgram
	seedProgramManager._setSeedProgramPref_(program)
		
	if seedProgramManager._setCatalogForSeedProgram_(program) != 0:
		seedProgramManager._setHelpFeedbackMenuEnabled_((program | 2) == 3)
		seedProgramManager._setSeedOptOutUIDisabled_(0)
			
		if ((program | 2) == 3):
			seedProgramManager._createFeedbackAssistantSymlink()

	if targetProductVersion == '10.9':
		plist = getPath(targetVolume, "Library/Application Support/App Store/.SeedEnrollment.plist")
	else:
		plist = getPath(targetVolume, "Users/Shared/.SeedEnrollment.plist")

	plistlib.writePlist(dict(SeedProgram=seedProgram), plist)


def getOSVersion():
	version = platform.mac_ver()
	return float('.'.join(version[0].split('.')[:2]))


def getOSNameByOSVersion(version):
	switcher = {
	10.0:	"Cheetah",
	10.1:	"Puma",
	10.2:	"Jaguar",
	10.3: 	"Panther",
	10.4:	"Tiger",
	10.5:	"Leopard",
	10.6:	"Snow Leopard",
	10.7:	"Lion",
	10.8:	"Mountain Lion",
	10.9:	"Mavericks",
	10.10:	"Yosemite",
	10.11:	"El Capitan",
	10.12:	"Sierra",
	10.13:	"High Sierra"
	}
	return switcher.get(version, "Unknown")


def getICUName(id):
	return icuData.get(id, icuData['en'])


def selectLanguage(macOSVersion):
	if macOSVersion > 10.11:
		locale = NSLocale.currentLocale()
		languageCode = NSLocale.languageCode(locale)
		id = languageCode
		countryCode = NSLocale.countryCode(locale)
		localeIdentifier = NSLocale.localeIdentifier(locale)
	else:
		cmd = ["defaults", 'read', '.GlobalPreferences', 'AppleLocale']
		proc = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
		output, err = proc.communicate()

		if proc.returncode:
			id = "en"
			localeIdentifier = "en_US"
			languageCode = id
		else:
			localeIdentifier = output
			id = languageCode = output.split('_')[0]
	#
	# Special cases for Apple's SU.
	#
	if languageCode == "pt" and localeIdentifier == "pt_PT":
		id = localeIdentifier
	elif languageCode == "es" and localeIdentifier == "es_419":
		id = localeIdentifier
	elif languageCode == "zh":
		if localeIdentifier == "zh_TW":
			id = localeIdentifier
		else:
			id = "zh_CN"

	return getICUName(id)


def getTargetVolume():
	index = 0
	targetVolumes = glob.glob("/Volumes/*")

	if len(targetVolumes) == 1:
		volumeNumber = 0
	else:
		print "\nAvailable target volumes:\n"

		for volume in targetVolumes:
			print "[ %i ] %s" % (index, basename(volume))
			index+=1

		print ''

		while True:
			try:
				volumeNumber = int(raw_input("Select a target volume: "))
				if volumeNumber > (index-1):
					sys.stdout.write("\033[F\033[K")
				else:
					break;
			except:
				sys.stdout.write("\033[F\033[K")

	return targetVolumes[int(volumeNumber)]


def getPath(targetVolume, targetPath):
	filePath = os.path.join(targetVolume, targetPath)

	if os.path.exists(filePath):
		return filePath

	return os.path.join("/", targetPath)


def downloadDistributionFile(url, targetPath):
	try:
		req = urllib2.urlopen(url)
	except urllib2.URLError:
		print >> sys.stderr("\nERROR: opening of (%s) failed. Aborting ...\n" % url)

	filename = basename(url)
	filesize = req.info().getheader('Content-Length')
	distributionFile = os.path.join(targetPath, filename)

	if os.path.exists(distributionFile):
		os.remove(distributionFile)

	with open(distributionFile, 'w') as file:
		while True:
			chunk = req.read(1024)
			if not chunk:
				break
			file.write(chunk)

	return distributionFile


def getSystemVersionPlist(targetVolume, target):
	systemVersionPlist = plistlib.readPlist(getPath(targetVolume, "System/Library/CoreServices/SystemVersion.plist"))
	
	if target == None:
		return systemVersionPlist
	else:
		try:
			return systemVersionPlist[target]
		except IOError:
			return 'None'


def getSeedProgram(targetVolume):
	version = getOSVersion()
	name = getOSNameByOSVersion(version)
	systemVersionPlist = getSystemVersionPlist(targetVolume, None)
	currentBuildID = systemVersionPlist['ProductBuildVersion']
	print "Currently running on macOS %s %s Build (%s) " % (name, version, currentBuildID)
	targetProductVersion = systemVersionPlist['ProductVersion']

	try:
		if targetProductVersion == '10.9':
			seedEnrollmentPlist = plistlib.readPlist(getPath(targetVolume, "Library/Application Support/App Store/.SeedEnrollment.plist"))
		else:
			seedEnrollmentPlist = plistlib.readPlist(getPath(targetVolume, "Users/Shared/.SeedEnrollment.plist"))
	except IOError:
		return (None, targetProductVersion)

	seedProgram = seedEnrollmentPlist['SeedProgram']
	print 'Seed Program Enrolment: ' + seedProgram
	return (seedProgram, targetProductVersion)


def getCatalogData(targetVolume):
	seedProgram, targetProductVersion = getSeedProgram(targetVolume)

	if seedProgram == None:
		print "\nERROR: No .SeedEnrollment.plist found. Initialising ..."
		enrollInSeedProgram(targetVolume, targetProductVersion)
		seedProgram, targetProductVersion = getSeedProgram(targetVolume)

	catalog = seedProgramData.get(seedProgram, seedProgramData['Regular'])
	catalogURL = "https://swscan.apple.com/content/catalogs/others/" + catalog
	try:
		catalogReq = urllib2.urlopen(catalogURL)
	except URLError:
		print >> sys.stderr, ("\nERROR: opening of (%s) failed. Aborting ...\n" % url)
		sys.exit(-1)

	return catalogReq.read()


def getProduct(productType, macOSVersion, targetVolume, targetPackageName):
	packageData = []
	catalogData = getCatalogData(targetVolume)
	root = plistlib.readPlistFromString(catalogData)
	products = root['Products']
	if targetPackageName == "*":
		print "Searching for macOS: %s" % macOSVersion
	else:
		print "Searching for: %s for macOS %s" % (targetPackageName, macOSVersion)

	if productType == "install":
		for key in products:
			if 'ExtendedMetaInfo' in products[key]:
				extendedMetaInfo = products[key]['ExtendedMetaInfo']

				if 'InstallAssistantPackageIdentifiers' in extendedMetaInfo:
					IAPackageIDs = extendedMetaInfo['InstallAssistantPackageIdentifiers']

					if IAPackageIDs['InstallInfo'] == 'com.apple.plist.InstallInfo' and IAPackageIDs['OSInstall'] == 'com.apple.mpkg.OSInstall':
						packageData.extend([key, products[key]])
	elif productType == "update":
		for key in products:
			if 'ExtendedMetaInfo' in products[key]:
				extendedMetaInfo = products[key]['ExtendedMetaInfo']
				if 'ProductType' in extendedMetaInfo:
					if extendedMetaInfo['ProductType'] == 'macOS' and extendedMetaInfo['ProductVersion'] == macOSVersion:
						packageData.extend([key, products[key]])

	return packageData


def downloadFiles(argumentData):
	url = argumentData[0]
	targetFilename = argumentData[1]
	try:
		fileReq = urllib2.urlopen(url)
	except:
		print >> sys.stderr, ("\nERROR: opening of (%s) failed. Aborting ...\n" % url)
		sys.exit(-1)

	filename = basename(url)
	filesize = argumentData[2]

	with open(targetFilename, 'wb') as file:
		while True:
			chunk = fileReq.read(4096)
			if not chunk:
				print "Download of %s finished" % filename
				break
			file.write(chunk)


def isBetaSeed(distributionFile):
	tree = ElementTree.parse(distributionFile)
	root = tree.getroot()
	localization = root.find('localization')

	if not localization == None:
		localization_iter = localization.iter()
	
		for element in localization_iter:
			if element.tag == 'strings':
				strings = element.text.split(';')[0]
				break

		if 'beta' in strings.lower():
			return True

	return False


def getBuildAndVersion(distributionFile, targetPackageName, unpackFolder):
	build  = 0
	version = 0
	tree = ElementTree.parse(distributionFile)
	root = tree.getroot()
	auxinfo = root.find('auxinfo')

	if not auxinfo == None:
		auxinfo_iter = auxinfo.iter()

		for element in auxinfo_iter:
			if element.tag == 'key' and element.text == 'BUILD':
				try:
					build = auxinfo_iter.next().text
				except StopIteration:
					pass
			elif element.tag == 'key' and element.text == 'VERSION':
				try:
					version = auxinfo_iter.next().text
				except StopIteration:
					pass
		return (version, build)
	else:
		for element in root.findall('pkg-ref'):
			id = element.get('id')
			parts = id.split('.')

			if targetPackageName == "FirmwareUpdate.pkg" and unpackFolder != "":
				if parts[-1] == "FirmwareUpdate":
					build = parts[-1]
					return (version, build)
			elif len(parts) > 4:
				build = parts[-1]
				return (version, build)

	return ('Unknown', 'Unknown')


def confirmWithText(confirmationText, shouldAbort):
	while True:
		confirm = raw_input(confirmationText).lower()
		if confirm in ('n', 'y'):
			if confirm == 'n':
				if shouldAbort:
					print "Aborting ...\n"
					sys.exit(0)
				else:
					return False
			elif confirm == 'y':
				return True
		else:
			sys.stdout.write("\033[F\033[K")
	return False


def confirmAPFSConversion(targetVolume):
	# Ask for confirmation, aborts if answered with no.
	if confirmWithText("\nDo you want to install now [y/n] ? ", True):
		isSolidState, partitionType = getDiskInfoByVolume(targetVolume)
		# Ask for confirmation on flash media with a HFS partition.
		if isSolidState and partitionType == "HFS":
			if confirmWithText("Do you want to convert the target volume to APFS [y/n] ? ", False):
				if confirmWithText("Are you absolutely sure [y/n] ? ", False):
					return 'YES'
	return 'NO'


def expandPackage(packageName, targetFolder):
	if os.path.isdir(targetFolder):
		print "\nError: Given target path already exists!"
		print "       Please remove it or use a different path!\n\nAborting ...\n"
		sys.exit(17)
	print "Expanding %s to %s" %(basename(packageName), targetFolder)
	subprocess.call(['pkgutil', '--expand', packageName, targetFolder])
	sys.exit(0)


def getPackages(productType, macOSVersion, targetPackageName, targetVolume, unpackFolder, askForConfirmation, languageSelector):
	if targetVolume == '':
		targetVolume = getTargetVolume()

	data = getProduct(productType, macOSVersion, targetVolume, targetPackageName)

	if data == None:
		print >> sys.stderr, ("\nERROR: target macOS version (%s) not found. Aborting ..." % macOSVersion)
		print >> sys.stderr, ("       - you may need to use the -m <version> argument\n")
		sys.exit(1)

	list = []
	buildIDs = []
	item = 0
	index = 0
	indent = ' - '
	selectorText = ''
	currentBuildID = getSystemVersionPlist(targetVolume, 'ProductBuildVersion')
	packageCount = (len(data)/2)

	while(index < (packageCount*2)):
		key = data[index]
		product = data[index+1]
		index+=2
		targetPath = os.path.join(targetVolume, tmpDirectory, key)

		if not os.path.isdir(targetPath):
			os.makedirs(targetPath)

		distributions = product['Distributions']

		if distributions[languageSelector]:
			distributionURL = distributions.get(languageSelector)
			distributionFile = downloadDistributionFile(distributionURL, targetPath)

		seedVersion, seedBuildID = getBuildAndVersion(distributionFile, targetPackageName, unpackFolder)

		if productType == 'update' and seedVersion == 0:
			seedVersion = macOSVersion

		if seedVersion >= macOSVersion:
			buildIDs.append(seedBuildID)
		else:
			continue

		item+=1

		if packageCount > 1:
			selectorText = "[ %s ] " % item
			indent = '      - '

		print "\n%sFound update for macOS %s (%s) with key: %s" % (selectorText, seedVersion, seedBuildID, key)

		if currentBuildID == seedBuildID:
			print "%swarning: seed build version is the same as macOS on this Mac!" % indent
		elif currentBuildID > seedBuildID:
			print "%swarning: seed build version is older than macOS on this Mac!" % indent
		elif currentBuildID < seedBuildID:
			print "%sseed build version is newer than macOS on this Mac (Ok)" % indent

	if len(buildIDs) == 0:
		print >> sys.stderr, ("\nERROR: target macOS version (%s) not found. Aborting ..." % macOSVersion)
		print >> sys.stderr, ("       - you may need to use the -m <version> argument\n")
		sys.exit(1)

	print ''
	while True:
		if item > 1:
			selection = raw_input("Select package to install [1-%s] " % packageCount)

			if selection.isdigit():
				number = int(selection)
				if number > 0 and number <= packageCount:
					number-=1
					break
				else:
					sys.stdout.write("\033[F\033[K")
			else:
				sys.stdout.write("\033[F\033[K")
		else:
			number = 0
			break

	seedBuildID = buildIDs[number]

	if currentBuildID == seedBuildID:
		confirmationText = "\nAre you sure that you want to continue [y/n] ? "
	elif currentBuildID > seedBuildID:
		confirmationText = "\nAre you absolutely sure that you want to continue [y/n] ? "
	elif currentBuildID < seedBuildID:
		confirmationText = "\nDo you want to continue [y/n] ? "

	if askForConfirmation == True:
		confirmWithText(confirmationText, True)

	# update key / use key from the selected item.
	key = data[(number*2)]
	# update targetPath / use path from the selected item.
	targetPath = os.path.join(targetVolume, tmpDirectory, key)
	product = data[((number*2)+1)]
	packages = product['Packages']

	for package in packages:
		url = package.get('URL')
		filename = basename(url)
		targetFilename = os.path.join(targetPath, filename)

		if filename == targetPackageName or targetPackageName == "*":
			filesize = package.get('Size')
			args = [url, targetFilename, filesize]
			list.append(args)

			if not targetPackageName == "*":
				break;

	if not len(list) == 0:
		print "\nQueued Download(s):"
		for array in list:
			print "%s [%s bytes]" % (basename(array[1]), array[2])
		print ''
		p = Pool()
		p.map(downloadFiles, list)
		p.close()
	else:
		if targetPackageName != "*":
			print "\nWarning: target package > %s < not found!" % targetPackageName

	if not unpackFolder == '':
		expandPackage(targetFilename, unpackFolder)
	
	return (key, distributionFile, targetVolume)


def getDiskInfoByVolume(targetVolume):
	isSolidState = False
	partitionType = "HFS"
	#
	# diskutil info[rmation] /Volumes/<volumename>
	#
	cmd = [DISKUTIL]
	cmd.extend(['information', targetVolume])
	proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
	output, err = proc.communicate()
	
	if proc.returncode:
		print "ERROR: diskutil information %s failed." % (targetVolume, output)
	else:
		lines = output.splitlines()
		for line in lines:
			# skip empty lines
			if line.rstrip():
				# strip leading whitespace
				strippedLine = line.lstrip()
				# check for Type (Bundle):
				if strippedLine.startswith("Type"):
					# spit line into two
					data = strippedLine.split(':')
					# strip leading whitespace and check for 'APFS'
					if data[1].lstrip() == 'apfs':
						partitionType = "APFS"
				elif strippedLine.startswith("Solid State"):
					isSolidState = True
	return (isSolidState, partitionType)


def copyFiles(distributionFile, key, targetVolume, applicationPath):
	sourcePath = os.path.join(targetVolume, tmpDirectory, key)
	sharedSupportPath = os.path.join(applicationPath, "Contents/SharedSupport")

	if os.path.isdir(sharedSupportPath):
		#
		# Yes we do, but did copy_dmg (a script inside RecoveryHDMetaDmg.pkg) copy the files that Install macOS 10.13 (Beta).app needs?
		#
		if not os.path.exists(sharedSupportPath + "/AppleDiagnostics.dmg"):
			#
			# Without this step we end up with installer.pkg as InstallDMG.dmg and InstallInfo.plist
			#
			print "\nCopying: InstallESDDmg.pkg to the target location ..."
			sourceFile = os.path.join(sourcePath, "InstallESDDmg.pkg")
			subprocess.call(['sudo', 'cp', sourceFile, sharedSupportPath + "/InstallESD.dmg"])
			#
			# Without this step we end up without AppleDiagnostics.[dmg/chunklist].
			#
			print "Copying: AppleDiagnostics.dmg to the target location ..."
			sourceFile = os.path.join(sourcePath, "AppleDiagnostics.dmg")
			subprocess.call(['sudo', 'cp', sourceFile, sharedSupportPath])
			print "Copying: AppleDiagnostics.chunklist to the target location ..."
			sourceFile = os.path.join(sourcePath, "AppleDiagnostics.chunklist")
			subprocess.call(['sudo', 'cp', sourceFile, sharedSupportPath])
			#
			# Without this step we end up without BaseSystem.[dmg/chunklist].
			#
			print "Copying: BaseSystem.dmg to the target location ..."
			sourceFile = os.path.join(sourcePath, "BaseSystem.dmg")
			subprocess.call(['sudo', 'cp', sourceFile, sharedSupportPath])
			print "Copying: BaseSystem.chunklist to the target location ..."
			sourceFile = os.path.join(sourcePath, "BaseSystem.chunklist")
			subprocess.call(['sudo', 'cp', sourceFile, sharedSupportPath])


def runInstaller(installerPkg, targetVolume):
	print "\nRunning installer ..."
	subprocess.call(['sudo', '/usr/sbin/installer', '-pkg', installerPkg, '-target', targetVolume])


def installPackage(distributionFile, key, targetVolume):
	targetPath = os.path.join(targetVolume, tmpDirectory, key)
	installerPkg = os.path.join(targetPath, installerPackage)
	print "\nCreating installer.pkg ..."
	subprocess.call(['sudo', 'productbuild', '--distribution', distributionFile, '--package-path', targetPath, installerPkg])

	if os.path.exists(installerPkg):
		runInstaller(installerPkg, targetVolume)


def getActiveCSRConfig():
	libSystem = CDLL('/usr/lib/system/libsystem_kernel.dylib')
	i = c_uint(0)
	if libSystem.csr_get_active_config(byref(i)) == 0:
		return i.value
	return -1


def launchStartOSInstall(targetVolume, applicationPath):
	#
	# startosinstall --volume / --applicationpath '/Applications/Install\ macOS\ High\ Sierra.app --agreetolicense --rebootdelay 30 --converttoapfs NO --nointeraction
	#
	conversionState = confirmAPFSConversion(targetVolume)
	cmd = [os.path.join(applicationPath, STARTOSINSTALL)]
	cmd.extend(['--applicationpath', applicationPath])
	cmd.extend(['--agreetolicense'])
	cmd.extend(['--rebootdelay', '30'])
	if os.path.ismount(targetVolume):
		cmd.extend(['--volume', targetVolume])
	cmd.extend(['--converttoapfs', conversionState])
	#cmd.extend(['--nointeraction'])
	try:
		retcode = subprocess.call(cmd)
	except OSError, error:
		print >> sys.stderr, ("ERROR: launch of startosinstall failed with %s." % error)


def launchGUIInstall(applicationPath):
	cmd = ['/usr/bin/open']
	cmd.extend(['-a', os.path.join(applicationPath, IATOOL)])
	try:
		subprocess.call(cmd)
		sys.exit(0)
	except OSError, error:
		print >> sys.stderr, ("ERROR: launch of InstallAssistant failed with %s." % error)


def startOSInstall(targetVolume, applicationPath, macOSVersion):
	if macOSVersion >= 10.11 and macOSVersion < 10.12:
		launchStartOSInstall(targetVolume, applicationPath)
	elif macOSVersion >= 10.12:
		csrConfigValue = getActiveCSRConfig()
		print "System Integrity Protection status: %0x" % csrConfigValue
		if csrConfigValue and (csrConfigValue & 320) != 0:
			launchStartOSInstall(targetVolume, applicationPath)
		else:
			print "Selecting GUI installation, enforced by SIP configuration ..."
			launchGUIInstall(applicationPath)
	else:
		launchGUIInstall(applicationPath)


def showUsage(error, arg):
	if  error == True and not arg == '':
		print "Error: invalid argument '%s' used\n" % arg
	else:
		print "Error: invalid argument(s) used\n"
	print "Supported arguments:\n"
	print "installSeed.py -a update"
	print "installSeed.py -a update -f <packagename>"
	print "installSeed.py -a update -f <packagename> -t <volume>"
	print "installSeed.py -a update -f <packagename> -t <volume> -u [target path]"
	print "installSeed.py -a update -f <packagename> -t <volume> -c [0/1] (0 skips confirmation)\n"
	print "installSeed.py -a update -f <packagename> -t <volume> -c [0/1] (0 skips confirmation) -m [10.13.x]\n"
	print "installSeed.py -a install"
	print "installSeed.py -a install -f <packagename>"
	print "installSeed.py -a install -f <packagename> -t <volume>"
	print "installSeed.py -a install -f <packagename> -t <volume> -u [target path]"
	print "installSeed.py -a install -f <packagename> -t <volume> -c [0/1] (0 skips confirmation)\n"
	print "installSeed.py -a install -f <packagename> -t <volume> -c [0/1] (0 skips confirmation) -m [10.13.x]\n"
	sys.exit(2)


def main(argv):
	sys.stdout.write("\x1b[2J\x1b[H")
	YEAR = datetime.now().year
	print "----------------------------------------------------------------"
	print "installSeed.py v%s Copyright (c) 2017-%s by Dr. Pike R. Alpha" % (VERSION, YEAR)
	print "----------------------------------------------------------------"
	action = 'install'
	target = '*'
	volume = ''
	confirm = True;
	unpackFolder = ''
	macOSVersion = getOSVersion()
	languageSelector = selectLanguage(macOSVersion)
	targetOSVersion = '10.13.3'

	try:
		opts, args = getopt.getopt(argv,"h:a:f:t:c:u:m:",["help","action","file","target","confirmation","unpack","mac"])
	except getopt.GetoptError as error:
		print str(error)
		showUsage(True, '')

	for opt, arg in opts:
		if opt in ('-h', '--help'):
			showUsage(False, '')
		elif opt in ('-a', '-action'):
			if arg in ('update', 'install'):
				action = arg
			else:
				showUsage(True, arg)
		elif opt == '-f':
			target = arg
		elif opt == '-c':
			confirm = arg
		elif opt == '-t':
			volume = arg
		elif opt == '-u':
			if target != '*':
				unpackFolder = arg
			else:
				showUsage(True, arg)
		elif opt == '-m':
			targetOSVersion = arg
		else:
			showUsage(True, arg)

	key, distributionFile, targetVolume = getPackages(action, targetOSVersion, target, volume, unpackFolder, confirm, languageSelector)

 	if key == "":
 		print "Error: Aborting ..."
 	elif target == "*":
		betaTag = ""
			
		if isBetaSeed(distributionFile):
			betaTag = " Beta"
			
		applicationPath = os.path.join(targetVolume, "Applications/Install macOS High Sierra" + betaTag + ".app")

		if action == "install" and target == "*":
			installPackage(distributionFile, key, targetVolume)
			copyFiles(distributionFile, key, targetVolume, applicationPath)
			startOSInstall(targetVolume, applicationPath, macOSVersion)
		elif action == "update":
			if confirmWithText("\nDo you want to upgrade now ? ", True):
				installPackage(distributionFile, key, targetVolume)


if __name__ == "__main__":
	# Allows installSeed.py to exit quickly when pressing Ctrl+C.
	signal.signal(signal.SIGINT, signal.SIG_DFL)
	main(sys.argv[1:])