Mac/BuildScript/build-installer.py

   1 #!/usr/bin/python
   2 """
   3 This script is used to build the "official unofficial" universal build on
   4 Mac OS X. It requires Mac OS X 10.4, Xcode 2.2 and the 10.4u SDK to do its
   5 work.  64-bit or four-way universal builds require at least OS X 10.5 and
   6 the 10.5 SDK.
   7
   8 Please ensure that this script keeps working with Python 2.3, to avoid
   9 bootstrap issues (/usr/bin/python is Python 2.3 on OSX 10.4)
  10
  11 Usage: see USAGE variable in the script.
  12 """
  13 import platform, os, sys, getopt, textwrap, shutil, urllib2, stat, time, pwd
  14 import grp
  15
  16 INCLUDE_TIMESTAMP = 1
  17 VERBOSE = 1
  18
  19 from plistlib import Plist
  20
  21 import MacOS
  22
  23 try:
  24     from plistlib import writePlist
  25 except ImportError:
  26     # We're run using python2.3
  27     def writePlist(plist, path):
  28         plist.write(path)
  29
  30 def shellQuote(value):
  31     """
  32     Return the string value in a form that can safely be inserted into
  33     a shell command.
  34     """
  35     return "'%s'"%(value.replace("'", "'\"'\"'"))
  36
  37 def grepValue(fn, variable):
  38     variable = variable + '='
  39     for ln in open(fn, 'r'):
  40         if ln.startswith(variable):
  41             value = ln[len(variable):].strip()
  42             return value[1:-1]
  43
  44 def getVersion():
  45     return grepValue(os.path.join(SRCDIR, 'configure'), 'PACKAGE_VERSION')
  46
  47 def getFullVersion():
  48     fn = os.path.join(SRCDIR, 'Include', 'patchlevel.h')
  49     for ln in open(fn):
  50         if 'PY_VERSION' in ln:
  51             return ln.split()[-1][1:-1]
  52
  53     raise RuntimeError, "Cannot find full version??"
  54
  55 # The directory we'll use to create the build (will be erased and recreated)
  56 WORKDIR = "/tmp/_py"
  57
  58 # The directory we'll use to store third-party sources. Set this to something
  59 # else if you don't want to re-fetch required libraries every time.
  60 DEPSRC = os.path.join(WORKDIR, 'third-party')
  61 DEPSRC = os.path.expanduser('~/Universal/other-sources')
  62
  63 # Location of the preferred SDK
  64
  65 ### There are some issues with the SDK selection below here,
  66 ### The resulting binary doesn't work on all platforms that
  67 ### it should. Always default to the 10.4u SDK until that
  68 ### isue is resolved.
  69 ###
  70 ##if int(os.uname()[2].split('.')[0]) == 8:
  71 ##    # Explicitly use the 10.4u (universal) SDK when
  72 ##    # building on 10.4, the system headers are not
  73 ##    # useable for a universal build
  74 ##    SDKPATH = "/Developer/SDKs/MacOSX10.4u.sdk"
  75 ##else:
  76 ##    SDKPATH = "/"
  77
  78 SDKPATH = "/Developer/SDKs/MacOSX10.4u.sdk"
  79
  80 universal_opts_map = { '32-bit': ('i386', 'ppc',),
  81                        '64-bit': ('x86_64', 'ppc64',),
  82                        'intel':  ('i386', 'x86_64'),
  83                        '3-way':  ('ppc', 'i386', 'x86_64'),
  84                        'all':    ('i386', 'ppc', 'x86_64', 'ppc64',) }
  85 default_target_map = {
  86         '64-bit': '10.5',
  87         '3-way': '10.5',
  88         'intel': '10.5',
  89         'all': '10.5',
  90 }
  91
  92 UNIVERSALOPTS = tuple(universal_opts_map.keys())
  93
  94 UNIVERSALARCHS = '32-bit'
  95
  96 ARCHLIST = universal_opts_map[UNIVERSALARCHS]
  97
  98 # Source directory (asume we're in Mac/BuildScript)
  99 SRCDIR = os.path.dirname(
 100         os.path.dirname(
 101             os.path.dirname(
 102                 os.path.abspath(__file__
 103         ))))
 104
 105 # $MACOSX_DEPLOYMENT_TARGET -> minimum OS X level
 106 DEPTARGET = '10.3'
 107
 108 target_cc_map = {
 109         '10.3': 'gcc-4.0',
 110         '10.4': 'gcc-4.0',
 111         '10.5': 'gcc-4.0',
 112         '10.6': 'gcc-4.2',
 113 }
 114
 115 CC = target_cc_map[DEPTARGET]
 116
 117 USAGE = textwrap.dedent("""\
 118     Usage: build_python [options]
 119
 120     Options:
 121     -? or -h:            Show this message
 122     -b DIR
 123     --build-dir=DIR:     Create build here (default: %(WORKDIR)r)
 124     --third-party=DIR:   Store third-party sources here (default: %(DEPSRC)r)
 125     --sdk-path=DIR:      Location of the SDK (default: %(SDKPATH)r)
 126     --src-dir=DIR:       Location of the Python sources (default: %(SRCDIR)r)
 127     --dep-target=10.n    OS X deployment target (default: %(DEPTARGET)r)
 128     --universal-archs=x  universal architectures (options: %(UNIVERSALOPTS)r, default: %(UNIVERSALARCHS)r)
 129 """)% globals()
 130
 131
 132 # Instructions for building libraries that are necessary for building a
 133 # batteries included python.
 134 #   [The recipes are defined here for convenience but instantiated later after
 135 #    command line options have been processed.]
 136 def library_recipes():
 137     result = []
 138
 139     if DEPTARGET < '10.5':
 140         result.extend([
 141           dict(
 142               name="Bzip2 1.0.5",
 143               url="http://www.bzip.org/1.0.5/bzip2-1.0.5.tar.gz",
 144               checksum='3c15a0c8d1d3ee1c46a1634d00617b1a',
 145               configure=None,
 146               install='make install CC=%s PREFIX=%s/usr/local/ CFLAGS="-arch %s -isysroot %s"'%(
 147                   CC,
 148                   shellQuote(os.path.join(WORKDIR, 'libraries')),
 149                   ' -arch '.join(ARCHLIST),
 150                   SDKPATH,
 151               ),
 152           ),
 153           dict(
 154               name="ZLib 1.2.3",
 155               url="http://www.gzip.org/zlib/zlib-1.2.3.tar.gz",
 156               checksum='debc62758716a169df9f62e6ab2bc634',
 157               configure=None,
 158               install='make install CC=%s prefix=%s/usr/local/ CFLAGS="-arch %s -isysroot %s"'%(
 159                   CC,
 160                   shellQuote(os.path.join(WORKDIR, 'libraries')),
 161                   ' -arch '.join(ARCHLIST),
 162                   SDKPATH,
 163               ),
 164           ),
 165           dict(
 166               # Note that GNU readline is GPL'd software
 167               name="GNU Readline 5.1.4",
 168               url="http://ftp.gnu.org/pub/gnu/readline/readline-5.1.tar.gz" ,
 169               checksum='7ee5a692db88b30ca48927a13fd60e46',
 170               patchlevel='0',
 171               patches=[
 172                   # The readline maintainers don't do actual micro releases, but
 173                   # just ship a set of patches.
 174                   'http://ftp.gnu.org/pub/gnu/readline/readline-5.1-patches/readline51-001',
 175                   'http://ftp.gnu.org/pub/gnu/readline/readline-5.1-patches/readline51-002',
 176                   'http://ftp.gnu.org/pub/gnu/readline/readline-5.1-patches/readline51-003',
 177                   'http://ftp.gnu.org/pub/gnu/readline/readline-5.1-patches/readline51-004',
 178               ]
 179           ),
 180           dict(
 181               name="SQLite 3.6.11",
 182               url="http://www.sqlite.org/sqlite-3.6.11.tar.gz",
 183               checksum='7ebb099696ab76cc6ff65dd496d17858',
 184               configure_pre=[
 185                   '--enable-threadsafe',
 186                   '--enable-tempstore',
 187                   '--enable-shared=no',
 188                   '--enable-static=yes',
 189                   '--disable-tcl',
 190               ]
 191           ),
 192           dict(
 193               name="NCurses 5.5",
 194               url="http://ftp.gnu.org/pub/gnu/ncurses/ncurses-5.5.tar.gz",
 195               checksum='e73c1ac10b4bfc46db43b2ddfd6244ef',
 196               configure_pre=[
 197                   "--without-cxx",
 198                   "--without-ada",
 199                   "--without-progs",
 200                   "--without-curses-h",
 201                   "--enable-shared",
 202                   "--with-shared",
 203                   "--datadir=/usr/share",
 204                   "--sysconfdir=/etc",
 205                   "--sharedstatedir=/usr/com",
 206                   "--with-terminfo-dirs=/usr/share/terminfo",
 207                   "--with-default-terminfo-dir=/usr/share/terminfo",
 208                   "--libdir=/Library/Frameworks/Python.framework/Versions/%s/lib"%(getVersion(),),
 209                   "--enable-termcap",
 210               ],
 211               patches=[
 212                   "ncurses-5.5.patch",
 213               ],
 214               useLDFlags=False,
 215               install='make && make install DESTDIR=%s && cd %s/usr/local/lib && ln -fs ../../../Library/Frameworks/Python.framework/Versions/%s/lib/lib* .'%(
 216                   shellQuote(os.path.join(WORKDIR, 'libraries')),
 217                   shellQuote(os.path.join(WORKDIR, 'libraries')),
 218                   getVersion(),
 219                   ),
 220           ),
 221         ])
 222
 223     result.extend([
 224       dict(
 225           name="Sleepycat DB 4.7.25",
 226           url="http://download.oracle.com/berkeley-db/db-4.7.25.tar.gz",
 227           checksum='ec2b87e833779681a0c3a814aa71359e',
 228           buildDir="build_unix",
 229           configure="../dist/configure",
 230           configure_pre=[
 231               '--includedir=/usr/local/include/db4',
 232           ]
 233       ),
 234     ])
 235
 236     return result
 237
 238
 239 # Instructions for building packages inside the .mpkg.
 240 def pkg_recipes():
 241     result = [
 242         dict(
 243             name="PythonFramework",
 244             long_name="Python Framework",
 245             source="/Library/Frameworks/Python.framework",
 246             readme="""\
 247                 This package installs Python.framework, that is the python
 248                 interpreter and the standard library. This also includes Python
 249                 wrappers for lots of Mac OS X API's.
 250             """,
 251             postflight="scripts/postflight.framework",
 252             selected='selected',
 253         ),
 254         dict(
 255             name="PythonApplications",
 256             long_name="GUI Applications",
 257             source="/Applications/Python %(VER)s",
 258             readme="""\
 259                 This package installs IDLE (an interactive Python IDE),
 260                 Python Launcher and Build Applet (create application bundles
 261                 from python scripts).
 262
 263                 It also installs a number of examples and demos.
 264                 """,
 265             required=False,
 266             selected='selected',
 267         ),
 268         dict(
 269             name="PythonUnixTools",
 270             long_name="UNIX command-line tools",
 271             source="/usr/local/bin",
 272             readme="""\
 273                 This package installs the unix tools in /usr/local/bin for
 274                 compatibility with older releases of Python. This package
 275                 is not necessary to use Python.
 276                 """,
 277             required=False,
 278             selected='unselected',
 279         ),
 280         dict(
 281             name="PythonDocumentation",
 282             long_name="Python Documentation",
 283             topdir="/Library/Frameworks/Python.framework/Versions/%(VER)s/Resources/English.lproj/Documentation",
 284             source="/pydocs",
 285             readme="""\
 286                 This package installs the python documentation at a location
 287                 that is useable for pydoc and IDLE. If you have installed Xcode
 288                 it will also install a link to the documentation in
 289                 /Developer/Documentation/Python
 290                 """,
 291             postflight="scripts/postflight.documentation",
 292             required=False,
 293             selected='selected',
 294         ),
 295         dict(
 296             name="PythonProfileChanges",
 297             long_name="Shell profile updater",
 298             readme="""\
 299                 This packages updates your shell profile to make sure that
 300                 the Python tools are found by your shell in preference of
 301                 the system provided Python tools.
 302
 303                 If you don't install this package you'll have to add
 304                 "/Library/Frameworks/Python.framework/Versions/%(VER)s/bin"
 305                 to your PATH by hand.
 306                 """,
 307             postflight="scripts/postflight.patch-profile",
 308             topdir="/Library/Frameworks/Python.framework",
 309             source="/empty-dir",
 310             required=False,
 311             selected='selected',
 312         ),
 313     ]
 314
 315     if DEPTARGET < '10.4':
 316         result.append(
 317             dict(
 318                 name="PythonSystemFixes",
 319                 long_name="Fix system Python",
 320                 readme="""\
 321                     This package updates the system python installation on
 322                     Mac OS X 10.3 to ensure that you can build new python extensions
 323                     using that copy of python after installing this version.
 324                     """,
 325                 postflight="../Tools/fixapplepython23.py",
 326                 topdir="/Library/Frameworks/Python.framework",
 327                 source="/empty-dir",
 328                 required=False,
 329                 selected='selected',
 330             )
 331         )
 332     return result
 333
 334 def fatal(msg):
 335     """
 336     A fatal error, bail out.
 337     """
 338     sys.stderr.write('FATAL: ')
 339     sys.stderr.write(msg)
 340     sys.stderr.write('\n')
 341     sys.exit(1)
 342
 343 def fileContents(fn):
 344     """
 345     Return the contents of the named file
 346     """
 347     return open(fn, 'rb').read()
 348
 349 def runCommand(commandline):
 350     """
 351     Run a command and raise RuntimeError if it fails. Output is surpressed
 352     unless the command fails.
 353     """
 354     fd = os.popen(commandline, 'r')
 355     data = fd.read()
 356     xit = fd.close()
 357     if xit is not None:
 358         sys.stdout.write(data)
 359         raise RuntimeError, "command failed: %s"%(commandline,)
 360
 361     if VERBOSE:
 362         sys.stdout.write(data); sys.stdout.flush()
 363
 364 def captureCommand(commandline):
 365     fd = os.popen(commandline, 'r')
 366     data = fd.read()
 367     xit = fd.close()
 368     if xit is not None:
 369         sys.stdout.write(data)
 370         raise RuntimeError, "command failed: %s"%(commandline,)
 371
 372     return data
 373
 374 def checkEnvironment():
 375     """
 376     Check that we're running on a supported system.
 377     """
 378
 379     if platform.system() != 'Darwin':
 380         fatal("This script should be run on a Mac OS X 10.4 (or later) system")
 381
 382     if int(platform.release().split('.')[0]) < 8:
 383         fatal("This script should be run on a Mac OS X 10.4 (or later) system")
 384
 385     if not os.path.exists(SDKPATH):
 386         fatal("Please install the latest version of Xcode and the %s SDK"%(
 387             os.path.basename(SDKPATH[:-4])))
 388
 389
 390
 391 def parseOptions(args=None):
 392     """
 393     Parse arguments and update global settings.
 394     """
 395     global WORKDIR, DEPSRC, SDKPATH, SRCDIR, DEPTARGET
 396     global UNIVERSALOPTS, UNIVERSALARCHS, ARCHLIST, CC
 397
 398     if args is None:
 399         args = sys.argv[1:]
 400
 401     try:
 402         options, args = getopt.getopt(args, '?hb',
 403                 [ 'build-dir=', 'third-party=', 'sdk-path=' , 'src-dir=',
 404                   'dep-target=', 'universal-archs=', 'help' ])
 405     except getopt.error, msg:
 406         print msg
 407         sys.exit(1)
 408
 409     if args:
 410         print "Additional arguments"
 411         sys.exit(1)
 412
 413     deptarget = None
 414     for k, v in options:
 415         if k in ('-h', '-?', '--help'):
 416             print USAGE
 417             sys.exit(0)
 418
 419         elif k in ('-d', '--build-dir'):
 420             WORKDIR=v
 421
 422         elif k in ('--third-party',):
 423             DEPSRC=v
 424
 425         elif k in ('--sdk-path',):
 426             SDKPATH=v
 427
 428         elif k in ('--src-dir',):
 429             SRCDIR=v
 430
 431         elif k in ('--dep-target', ):
 432             DEPTARGET=v
 433             deptarget=v
 434
 435         elif k in ('--universal-archs', ):
 436             if v in UNIVERSALOPTS:
 437                 UNIVERSALARCHS = v
 438                 ARCHLIST = universal_opts_map[UNIVERSALARCHS]
 439                 if deptarget is None:
 440                     # Select alternate default deployment
 441                     # target
 442                     DEPTARGET = default_target_map.get(v, '10.3')
 443             else:
 444                 raise NotImplementedError, v
 445
 446         else:
 447             raise NotImplementedError, k
 448
 449     SRCDIR=os.path.abspath(SRCDIR)
 450     WORKDIR=os.path.abspath(WORKDIR)
 451     SDKPATH=os.path.abspath(SDKPATH)
 452     DEPSRC=os.path.abspath(DEPSRC)
 453
 454     CC=target_cc_map[DEPTARGET]
 455
 456     print "Settings:"
 457     print " * Source directory:", SRCDIR
 458     print " * Build directory: ", WORKDIR
 459     print " * SDK location:    ", SDKPATH
 460     print " * Third-party source:", DEPSRC
 461     print " * Deployment target:", DEPTARGET
 462     print " * Universal architectures:", ARCHLIST
 463     print " * C compiler:", CC
 464     print ""
 465
 466
 467
 468
 469 def extractArchive(builddir, archiveName):
 470     """
 471     Extract a source archive into 'builddir'. Returns the path of the
 472     extracted archive.
 473
 474     XXX: This function assumes that archives contain a toplevel directory
 475     that is has the same name as the basename of the archive. This is
 476     save enough for anything we use.
 477     """
 478     curdir = os.getcwd()
 479     try:
 480         os.chdir(builddir)
 481         if archiveName.endswith('.tar.gz'):
 482             retval = os.path.basename(archiveName[:-7])
 483             if os.path.exists(retval):
 484                 shutil.rmtree(retval)
 485             fp = os.popen("tar zxf %s 2>&1"%(shellQuote(archiveName),), 'r')
 486
 487         elif archiveName.endswith('.tar.bz2'):
 488             retval = os.path.basename(archiveName[:-8])
 489             if os.path.exists(retval):
 490                 shutil.rmtree(retval)
 491             fp = os.popen("tar jxf %s 2>&1"%(shellQuote(archiveName),), 'r')
 492
 493         elif archiveName.endswith('.tar'):
 494             retval = os.path.basename(archiveName[:-4])
 495             if os.path.exists(retval):
 496                 shutil.rmtree(retval)
 497             fp = os.popen("tar xf %s 2>&1"%(shellQuote(archiveName),), 'r')
 498
 499         elif archiveName.endswith('.zip'):
 500             retval = os.path.basename(archiveName[:-4])
 501             if os.path.exists(retval):
 502                 shutil.rmtree(retval)
 503             fp = os.popen("unzip %s 2>&1"%(shellQuote(archiveName),), 'r')
 504
 505         data = fp.read()
 506         xit = fp.close()
 507         if xit is not None:
 508             sys.stdout.write(data)
 509             raise RuntimeError, "Cannot extract %s"%(archiveName,)
 510
 511         return os.path.join(builddir, retval)
 512
 513     finally:
 514         os.chdir(curdir)
 515
 516 KNOWNSIZES = {
 517     "http://ftp.gnu.org/pub/gnu/readline/readline-5.1.tar.gz": 7952742,
 518     "http://downloads.sleepycat.com/db-4.4.20.tar.gz": 2030276,
 519 }
 520
 521 def downloadURL(url, fname):
 522     """
 523     Download the contents of the url into the file.
 524     """
 525     try:
 526         size = os.path.getsize(fname)
 527     except OSError:
 528         pass
 529     else:
 530         if KNOWNSIZES.get(url) == size:
 531             print "Using existing file for", url
 532             return
 533     fpIn = urllib2.urlopen(url)
 534     fpOut = open(fname, 'wb')
 535     block = fpIn.read(10240)
 536     try:
 537         while block:
 538             fpOut.write(block)
 539             block = fpIn.read(10240)
 540         fpIn.close()
 541         fpOut.close()
 542     except:
 543         try:
 544             os.unlink(fname)
 545         except:
 546             pass
 547
 548 def buildRecipe(recipe, basedir, archList):
 549     """
 550     Build software using a recipe. This function does the
 551     'configure;make;make install' dance for C software, with a possibility
 552     to customize this process, basically a poor-mans DarwinPorts.
 553     """
 554     curdir = os.getcwd()
 555
 556     name = recipe['name']
 557     url = recipe['url']
 558     configure = recipe.get('configure', './configure')
 559     install = recipe.get('install', 'make && make install DESTDIR=%s'%(
 560         shellQuote(basedir)))
 561
 562     archiveName = os.path.split(url)[-1]
 563     sourceArchive = os.path.join(DEPSRC, archiveName)
 564
 565     if not os.path.exists(DEPSRC):
 566         os.mkdir(DEPSRC)
 567
 568
 569     if os.path.exists(sourceArchive):
 570         print "Using local copy of %s"%(name,)
 571
 572     else:
 573         print "Did not find local copy of %s"%(name,)
 574         print "Downloading %s"%(name,)
 575         downloadURL(url, sourceArchive)
 576         print "Archive for %s stored as %s"%(name, sourceArchive)
 577
 578     print "Extracting archive for %s"%(name,)
 579     buildDir=os.path.join(WORKDIR, '_bld')
 580     if not os.path.exists(buildDir):
 581         os.mkdir(buildDir)
 582
 583     workDir = extractArchive(buildDir, sourceArchive)
 584     os.chdir(workDir)
 585     if 'buildDir' in recipe:
 586         os.chdir(recipe['buildDir'])
 587
 588
 589     for fn in recipe.get('patches', ()):
 590         if fn.startswith('http://'):
 591             # Download the patch before applying it.
 592             path = os.path.join(DEPSRC, os.path.basename(fn))
 593             downloadURL(fn, path)
 594             fn = path
 595
 596         fn = os.path.join(curdir, fn)
 597         runCommand('patch -p%s < %s'%(recipe.get('patchlevel', 1),
 598             shellQuote(fn),))
 599
 600     if configure is not None:
 601         configure_args = [
 602             "--prefix=/usr/local",
 603             "--enable-static",
 604             "--disable-shared",
 605             #"CPP=gcc -arch %s -E"%(' -arch '.join(archList,),),
 606         ]
 607
 608         if 'configure_pre' in recipe:
 609             args = list(recipe['configure_pre'])
 610             if '--disable-static' in args:
 611                 configure_args.remove('--enable-static')
 612             if '--enable-shared' in args:
 613                 configure_args.remove('--disable-shared')
 614             configure_args.extend(args)
 615
 616         if recipe.get('useLDFlags', 1):
 617             configure_args.extend([
 618                 "CFLAGS=-arch %s -isysroot %s -I%s/usr/local/include"%(
 619                         ' -arch '.join(archList),
 620                         shellQuote(SDKPATH)[1:-1],
 621                         shellQuote(basedir)[1:-1],),
 622                 "LDFLAGS=-syslibroot,%s -L%s/usr/local/lib -arch %s"%(
 623                     shellQuote(SDKPATH)[1:-1],
 624                     shellQuote(basedir)[1:-1],
 625                     ' -arch '.join(archList)),
 626             ])
 627         else:
 628             configure_args.extend([
 629                 "CFLAGS=-arch %s -isysroot %s -I%s/usr/local/include"%(
 630                         ' -arch '.join(archList),
 631                         shellQuote(SDKPATH)[1:-1],
 632                         shellQuote(basedir)[1:-1],),
 633             ])
 634
 635         if 'configure_post' in recipe:
 636             configure_args = configure_args = list(recipe['configure_post'])
 637
 638         configure_args.insert(0, configure)
 639         configure_args = [ shellQuote(a) for a in configure_args ]
 640
 641         print "Running configure for %s"%(name,)
 642         runCommand(' '.join(configure_args) + ' 2>&1')
 643
 644     print "Running install for %s"%(name,)
 645     runCommand('{ ' + install + ' ;} 2>&1')
 646
 647     print "Done %s"%(name,)
 648     print ""
 649
 650     os.chdir(curdir)
 651
 652 def buildLibraries():
 653     """
 654     Build our dependencies into $WORKDIR/libraries/usr/local
 655     """
 656     print ""
 657     print "Building required libraries"
 658     print ""
 659     universal = os.path.join(WORKDIR, 'libraries')
 660     os.mkdir(universal)
 661     os.makedirs(os.path.join(universal, 'usr', 'local', 'lib'))
 662     os.makedirs(os.path.join(universal, 'usr', 'local', 'include'))
 663
 664     for recipe in library_recipes():
 665         buildRecipe(recipe, universal, ARCHLIST)
 666
 667
 668
 669 def buildPythonDocs():
 670     # This stores the documentation as Resources/English.lproj/Documentation
 671     # inside the framwork. pydoc and IDLE will pick it up there.
 672     print "Install python documentation"
 673     rootDir = os.path.join(WORKDIR, '_root')
 674     buildDir = os.path.join('../../Doc')
 675     docdir = os.path.join(rootDir, 'pydocs')
 676     curDir = os.getcwd()
 677     os.chdir(buildDir)
 678     runCommand('make update')
 679     runCommand('make html')
 680     os.chdir(curDir)
 681     if not os.path.exists(docdir):
 682         os.mkdir(docdir)
 683     os.rename(os.path.join(buildDir, 'build', 'html'), docdir)
 684
 685
 686 def buildPython():
 687     print "Building a universal python for %s architectures" % UNIVERSALARCHS
 688
 689     buildDir = os.path.join(WORKDIR, '_bld', 'python')
 690     rootDir = os.path.join(WORKDIR, '_root')
 691
 692     if os.path.exists(buildDir):
 693         shutil.rmtree(buildDir)
 694     if os.path.exists(rootDir):
 695         shutil.rmtree(rootDir)
 696     os.mkdir(buildDir)
 697     os.mkdir(rootDir)
 698     os.mkdir(os.path.join(rootDir, 'empty-dir'))
 699     curdir = os.getcwd()
 700     os.chdir(buildDir)
 701
 702     # Not sure if this is still needed, the original build script
 703     # claims that parts of the install assume python.exe exists.
 704     os.symlink('python', os.path.join(buildDir, 'python.exe'))
 705
 706     # Extract the version from the configure file, needed to calculate
 707     # several paths.
 708     version = getVersion()
 709
 710     # Since the extra libs are not in their installed framework location
 711     # during the build, augment the library path so that the interpreter
 712     # will find them during its extension import sanity checks.
 713     os.environ['DYLD_LIBRARY_PATH'] = os.path.join(WORKDIR,
 714                                         'libraries', 'usr', 'local', 'lib')
 715     print "Running configure..."
 716     runCommand("%s -C --enable-framework --enable-universalsdk=%s "
 717                "--with-universal-archs=%s "
 718                "LDFLAGS='-g -L%s/libraries/usr/local/lib' "
 719                "OPT='-g -O3 -I%s/libraries/usr/local/include' 2>&1"%(
 720         shellQuote(os.path.join(SRCDIR, 'configure')), shellQuote(SDKPATH),
 721         UNIVERSALARCHS,
 722         shellQuote(WORKDIR)[1:-1],
 723         shellQuote(WORKDIR)[1:-1]))
 724
 725     print "Running make"
 726     runCommand("make")
 727
 728     print "Running make frameworkinstall"
 729     runCommand("make frameworkinstall DESTDIR=%s"%(
 730         shellQuote(rootDir)))
 731
 732     print "Running make frameworkinstallextras"
 733     runCommand("make frameworkinstallextras DESTDIR=%s"%(
 734         shellQuote(rootDir)))
 735
 736     del os.environ['DYLD_LIBRARY_PATH']
 737     print "Copying required shared libraries"
 738     if os.path.exists(os.path.join(WORKDIR, 'libraries', 'Library')):
 739         runCommand("mv %s/* %s"%(
 740             shellQuote(os.path.join(
 741                 WORKDIR, 'libraries', 'Library', 'Frameworks',
 742                 'Python.framework', 'Versions', getVersion(),
 743                 'lib')),
 744             shellQuote(os.path.join(WORKDIR, '_root', 'Library', 'Frameworks',
 745                 'Python.framework', 'Versions', getVersion(),
 746                 'lib'))))
 747
 748     print "Fix file modes"
 749     frmDir = os.path.join(rootDir, 'Library', 'Frameworks', 'Python.framework')
 750     gid = grp.getgrnam('admin').gr_gid
 751
 752     for dirpath, dirnames, filenames in os.walk(frmDir):
 753         for dn in dirnames:
 754             os.chmod(os.path.join(dirpath, dn), 0775)
 755             os.chown(os.path.join(dirpath, dn), -1, gid)
 756
 757
 758         for fn in filenames:
 759             if os.path.islink(fn):
 760                 continue
 761
 762             # "chmod g+w $fn"
 763             p = os.path.join(dirpath, fn)
 764             st = os.stat(p)
 765             os.chmod(p, stat.S_IMODE(st.st_mode) | stat.S_IWGRP)
 766             os.chown(p, -1, gid)
 767
 768     # We added some directories to the search path during the configure
 769     # phase. Remove those because those directories won't be there on
 770     # the end-users system.
 771     path =os.path.join(rootDir, 'Library', 'Frameworks', 'Python.framework',
 772                 'Versions', version, 'lib', 'python%s'%(version,),
 773                 'config', 'Makefile')
 774     fp = open(path, 'r')
 775     data = fp.read()
 776     fp.close()
 777
 778     data = data.replace('-L%s/libraries/usr/local/lib'%(WORKDIR,), '')
 779     data = data.replace('-I%s/libraries/usr/local/include'%(WORKDIR,), '')
 780     fp = open(path, 'w')
 781     fp.write(data)
 782     fp.close()
 783
 784     # Add symlinks in /usr/local/bin, using relative links
 785     usr_local_bin = os.path.join(rootDir, 'usr', 'local', 'bin')
 786     to_framework = os.path.join('..', '..', '..', 'Library', 'Frameworks',
 787             'Python.framework', 'Versions', version, 'bin')
 788     if os.path.exists(usr_local_bin):
 789         shutil.rmtree(usr_local_bin)
 790     os.makedirs(usr_local_bin)
 791     for fn in os.listdir(
 792                 os.path.join(frmDir, 'Versions', version, 'bin')):
 793         os.symlink(os.path.join(to_framework, fn),
 794                    os.path.join(usr_local_bin, fn))
 795
 796     os.chdir(curdir)
 797
 798
 799
 800 def patchFile(inPath, outPath):
 801     data = fileContents(inPath)
 802     data = data.replace('$FULL_VERSION', getFullVersion())
 803     data = data.replace('$VERSION', getVersion())
 804     data = data.replace('$MACOSX_DEPLOYMENT_TARGET', ''.join((DEPTARGET, ' or later')))
 805     data = data.replace('$ARCHITECTURES', "i386, ppc")
 806     data = data.replace('$INSTALL_SIZE', installSize())
 807
 808     # This one is not handy as a template variable
 809     data = data.replace('$PYTHONFRAMEWORKINSTALLDIR', '/Library/Frameworks/Python.framework')
 810     fp = open(outPath, 'wb')
 811     fp.write(data)
 812     fp.close()
 813
 814 def patchScript(inPath, outPath):
 815     data = fileContents(inPath)
 816     data = data.replace('@PYVER@', getVersion())
 817     fp = open(outPath, 'wb')
 818     fp.write(data)
 819     fp.close()
 820     os.chmod(outPath, 0755)
 821
 822
 823
 824 def packageFromRecipe(targetDir, recipe):
 825     curdir = os.getcwd()
 826     try:
 827         # The major version (such as 2.5) is included in the package name
 828         # because having two version of python installed at the same time is
 829         # common.
 830         pkgname = '%s-%s'%(recipe['name'], getVersion())
 831         srcdir  = recipe.get('source')
 832         pkgroot = recipe.get('topdir', srcdir)
 833         postflight = recipe.get('postflight')
 834         readme = textwrap.dedent(recipe['readme'])
 835         isRequired = recipe.get('required', True)
 836
 837         print "- building package %s"%(pkgname,)
 838
 839         # Substitute some variables
 840         textvars = dict(
 841             VER=getVersion(),
 842             FULLVER=getFullVersion(),
 843         )
 844         readme = readme % textvars
 845
 846         if pkgroot is not None:
 847             pkgroot = pkgroot % textvars
 848         else:
 849             pkgroot = '/'
 850
 851         if srcdir is not None:
 852             srcdir = os.path.join(WORKDIR, '_root', srcdir[1:])
 853             srcdir = srcdir % textvars
 854
 855         if postflight is not None:
 856             postflight = os.path.abspath(postflight)
 857
 858         packageContents = os.path.join(targetDir, pkgname + '.pkg', 'Contents')
 859         os.makedirs(packageContents)
 860
 861         if srcdir is not None:
 862             os.chdir(srcdir)
 863             runCommand("pax -wf %s . 2>&1"%(shellQuote(os.path.join(packageContents, 'Archive.pax')),))
 864             runCommand("gzip -9 %s 2>&1"%(shellQuote(os.path.join(packageContents, 'Archive.pax')),))
 865             runCommand("mkbom . %s 2>&1"%(shellQuote(os.path.join(packageContents, 'Archive.bom')),))
 866
 867         fn = os.path.join(packageContents, 'PkgInfo')
 868         fp = open(fn, 'w')
 869         fp.write('pmkrpkg1')
 870         fp.close()
 871
 872         rsrcDir = os.path.join(packageContents, "Resources")
 873         os.mkdir(rsrcDir)
 874         fp = open(os.path.join(rsrcDir, 'ReadMe.txt'), 'w')
 875         fp.write(readme)
 876         fp.close()
 877
 878         if postflight is not None:
 879             patchScript(postflight, os.path.join(rsrcDir, 'postflight'))
 880
 881         vers = getFullVersion()
 882         major, minor = map(int, getVersion().split('.', 2))
 883         pl = Plist(
 884                 CFBundleGetInfoString="Python.%s %s"%(pkgname, vers,),
 885                 CFBundleIdentifier='org.python.Python.%s'%(pkgname,),
 886                 CFBundleName='Python.%s'%(pkgname,),
 887                 CFBundleShortVersionString=vers,
 888                 IFMajorVersion=major,
 889                 IFMinorVersion=minor,
 890                 IFPkgFormatVersion=0.10000000149011612,
 891                 IFPkgFlagAllowBackRev=False,
 892                 IFPkgFlagAuthorizationAction="RootAuthorization",
 893                 IFPkgFlagDefaultLocation=pkgroot,
 894                 IFPkgFlagFollowLinks=True,
 895                 IFPkgFlagInstallFat=True,
 896                 IFPkgFlagIsRequired=isRequired,
 897                 IFPkgFlagOverwritePermissions=False,
 898                 IFPkgFlagRelocatable=False,
 899                 IFPkgFlagRestartAction="NoRestart",
 900                 IFPkgFlagRootVolumeOnly=True,
 901                 IFPkgFlagUpdateInstalledLangauges=False,
 902             )
 903         writePlist(pl, os.path.join(packageContents, 'Info.plist'))
 904
 905         pl = Plist(
 906                     IFPkgDescriptionDescription=readme,
 907                     IFPkgDescriptionTitle=recipe.get('long_name', "Python.%s"%(pkgname,)),
 908                     IFPkgDescriptionVersion=vers,
 909                 )
 910         writePlist(pl, os.path.join(packageContents, 'Resources', 'Description.plist'))
 911
 912     finally:
 913         os.chdir(curdir)
 914
 915
 916 def makeMpkgPlist(path):
 917
 918     vers = getFullVersion()
 919     major, minor = map(int, getVersion().split('.', 2))
 920
 921     pl = Plist(
 922             CFBundleGetInfoString="Python %s"%(vers,),
 923             CFBundleIdentifier='org.python.Python',
 924             CFBundleName='Python',
 925             CFBundleShortVersionString=vers,
 926             IFMajorVersion=major,
 927             IFMinorVersion=minor,
 928             IFPkgFlagComponentDirectory="Contents/Packages",
 929             IFPkgFlagPackageList=[
 930                 dict(
 931                     IFPkgFlagPackageLocation='%s-%s.pkg'%(item['name'], getVersion()),
 932                     IFPkgFlagPackageSelection=item.get('selected', 'selected'),
 933                 )
 934                 for item in pkg_recipes()
 935             ],
 936             IFPkgFormatVersion=0.10000000149011612,
 937             IFPkgFlagBackgroundScaling="proportional",
 938             IFPkgFlagBackgroundAlignment="left",
 939             IFPkgFlagAuthorizationAction="RootAuthorization",
 940         )
 941
 942     writePlist(pl, path)
 943
 944
 945 def buildInstaller():
 946
 947     # Zap all compiled files
 948     for dirpath, _, filenames in os.walk(os.path.join(WORKDIR, '_root')):
 949         for fn in filenames:
 950             if fn.endswith('.pyc') or fn.endswith('.pyo'):
 951                 os.unlink(os.path.join(dirpath, fn))
 952
 953     outdir = os.path.join(WORKDIR, 'installer')
 954     if os.path.exists(outdir):
 955         shutil.rmtree(outdir)
 956     os.mkdir(outdir)
 957
 958     pkgroot = os.path.join(outdir, 'Python.mpkg', 'Contents')
 959     pkgcontents = os.path.join(pkgroot, 'Packages')
 960     os.makedirs(pkgcontents)
 961     for recipe in pkg_recipes():
 962         packageFromRecipe(pkgcontents, recipe)
 963
 964     rsrcDir = os.path.join(pkgroot, 'Resources')
 965
 966     fn = os.path.join(pkgroot, 'PkgInfo')
 967     fp = open(fn, 'w')
 968     fp.write('pmkrpkg1')
 969     fp.close()
 970
 971     os.mkdir(rsrcDir)
 972
 973     makeMpkgPlist(os.path.join(pkgroot, 'Info.plist'))
 974     pl = Plist(
 975                 IFPkgDescriptionTitle="Python",
 976                 IFPkgDescriptionVersion=getVersion(),
 977             )
 978
 979     writePlist(pl, os.path.join(pkgroot, 'Resources', 'Description.plist'))
 980     for fn in os.listdir('resources'):
 981         if fn == '.svn': continue
 982         if fn.endswith('.jpg'):
 983             shutil.copy(os.path.join('resources', fn), os.path.join(rsrcDir, fn))
 984         else:
 985             patchFile(os.path.join('resources', fn), os.path.join(rsrcDir, fn))
 986
 987     shutil.copy("../../LICENSE", os.path.join(rsrcDir, 'License.txt'))
 988
 989
 990 def installSize(clear=False, _saved=[]):
 991     if clear:
 992         del _saved[:]
 993     if not _saved:
 994         data = captureCommand("du -ks %s"%(
 995                     shellQuote(os.path.join(WORKDIR, '_root'))))
 996         _saved.append("%d"%((0.5 + (int(data.split()[0]) / 1024.0)),))
 997     return _saved[0]
 998
 999
1000 def buildDMG():
1001     """
1002     Create DMG containing the rootDir.
1003     """
1004     outdir = os.path.join(WORKDIR, 'diskimage')
1005     if os.path.exists(outdir):
1006         shutil.rmtree(outdir)
1007
1008     imagepath = os.path.join(outdir,
1009                     'python-%s-macosx%s'%(getFullVersion(),DEPTARGET))
1010     if INCLUDE_TIMESTAMP:
1011         imagepath = imagepath + '-%04d-%02d-%02d'%(time.localtime()[:3])
1012     imagepath = imagepath + '.dmg'
1013
1014     os.mkdir(outdir)
1015     volname='Python %s'%(getFullVersion())
1016     runCommand("hdiutil create -format UDRW -volname %s -srcfolder %s %s"%(
1017             shellQuote(volname),
1018             shellQuote(os.path.join(WORKDIR, 'installer')),
1019             shellQuote(imagepath + ".tmp.dmg" )))
1020
1021
1022     if not os.path.exists(os.path.join(WORKDIR, "mnt")):
1023         os.mkdir(os.path.join(WORKDIR, "mnt"))
1024     runCommand("hdiutil attach %s -mountroot %s"%(
1025         shellQuote(imagepath + ".tmp.dmg"), shellQuote(os.path.join(WORKDIR, "mnt"))))
1026
1027     # Custom icon for the DMG, shown when the DMG is mounted.
1028     shutil.copy("../Icons/Disk Image.icns",
1029             os.path.join(WORKDIR, "mnt", volname, ".VolumeIcon.icns"))
1030     runCommand("/Developer/Tools/SetFile -a C %s/"%(
1031             shellQuote(os.path.join(WORKDIR, "mnt", volname)),))
1032
1033     runCommand("hdiutil detach %s"%(shellQuote(os.path.join(WORKDIR, "mnt", volname))))
1034
1035     setIcon(imagepath + ".tmp.dmg", "../Icons/Disk Image.icns")
1036     runCommand("hdiutil convert %s -format UDZO -o %s"%(
1037             shellQuote(imagepath + ".tmp.dmg"), shellQuote(imagepath)))
1038     setIcon(imagepath, "../Icons/Disk Image.icns")
1039
1040     os.unlink(imagepath + ".tmp.dmg")
1041
1042     return imagepath
1043
1044
1045 def setIcon(filePath, icnsPath):
1046     """
1047     Set the custom icon for the specified file or directory.
1048     """
1049
1050     toolPath = os.path.join(os.path.dirname(__file__), "seticon.app/Contents/MacOS/seticon")
1051     dirPath = os.path.dirname(__file__)
1052     if not os.path.exists(toolPath) or os.stat(toolPath).st_mtime < os.stat(dirPath + '/seticon.m').st_mtime:
1053         # NOTE: The tool is created inside an .app bundle, otherwise it won't work due
1054         # to connections to the window server.
1055         if not os.path.exists('seticon.app/Contents/MacOS'):
1056             os.makedirs('seticon.app/Contents/MacOS')
1057         runCommand("cc -o %s %s/seticon.m -framework Cocoa"%(
1058             shellQuote(toolPath), shellQuote(dirPath)))
1059
1060     runCommand("%s %s %s"%(shellQuote(os.path.abspath(toolPath)), shellQuote(icnsPath),
1061         shellQuote(filePath)))
1062
1063 def main():
1064     # First parse options and check if we can perform our work
1065     parseOptions()
1066     checkEnvironment()
1067
1068     os.environ['MACOSX_DEPLOYMENT_TARGET'] = DEPTARGET
1069     os.environ['CC'] = CC
1070
1071     if os.path.exists(WORKDIR):
1072         shutil.rmtree(WORKDIR)
1073     os.mkdir(WORKDIR)
1074
1075     # Then build third-party libraries such as sleepycat DB4.
1076     buildLibraries()
1077
1078     # Now build python itself
1079     buildPython()
1080
1081     # And then build the documentation
1082     # Remove the Deployment Target from the shell
1083     # environment, it's no longer needed and
1084     # an unexpected build target can cause problems
1085     # when Sphinx and its dependencies need to
1086     # be (re-)installed.
1087     del os.environ['MACOSX_DEPLOYMENT_TARGET']
1088     buildPythonDocs()
1089
1090
1091     # Prepare the applications folder
1092     fn = os.path.join(WORKDIR, "_root", "Applications",
1093                 "Python %s"%(getVersion(),), "Update Shell Profile.command")
1094     patchScript("scripts/postflight.patch-profile",  fn)
1095
1096     folder = os.path.join(WORKDIR, "_root", "Applications", "Python %s"%(
1097         getVersion(),))
1098     os.chmod(folder, 0755)
1099     setIcon(folder, "../Icons/Python Folder.icns")
1100
1101     # Create the installer
1102     buildInstaller()
1103
1104     # And copy the readme into the directory containing the installer
1105     patchFile('resources/ReadMe.txt', os.path.join(WORKDIR, 'installer', 'ReadMe.txt'))
1106
1107     # Ditto for the license file.
1108     shutil.copy('../../LICENSE', os.path.join(WORKDIR, 'installer', 'License.txt'))
1109
1110     fp = open(os.path.join(WORKDIR, 'installer', 'Build.txt'), 'w')
1111     print >> fp, "# BUILD INFO"
1112     print >> fp, "# Date:", time.ctime()
1113     print >> fp, "# By:", pwd.getpwuid(os.getuid()).pw_gecos
1114     fp.close()
1115
1116     # And copy it to a DMG
1117     buildDMG()
1118
1119 if __name__ == "__main__":
1120     main()