distrib/scripts/create-archive.py

   1 #!/usr/bin/env python
   2
   3 import glob
   4 import optparse
   5 import os
   6 import re
   7 import shutil
   8 import string
   9 import sys
  10 import tempfile
  11 import types
  12
  13
  14 ## CONSTANTS
  15
  16 scriptDir = os.path.join(sys.path[0])
  17 rootDir = os.path.abspath(os.path.join(scriptDir, "..", ".."))
  18 contribDir = os.path.join("contrib", "src")
  19
  20 dirsToCopy = ["art", "build", "debian", "demos", "distrib/mac", "docs", "include", "interface", "lib",
  21                 "locale", "samples", "src", "tests", "utils"]
  22
  23 dirsToIgnore = [".svn", "CVS", ".git"]
  24 excludeExtensions = [".rej", ".orig", ".mine", ".tmp"]
  25
  26 option_dict = {
  27             "compression"   : ("gzip", "Compression to use. Values are: gzip, bzip, zip, all (default: gzip)"),
  28             "docs"          : ("html", "Doc formats to build. Comma separated. Values are: none, html (default: html)"),
  29             "name"          : ("wxWidgets", "Name given to the tarball created (default: wxWidgets)"),
  30             "postfix"       : ("", "String appended to the version to indicate a special release (default: none)"),
  31             "wxpython"      : (False, "Produce wxPython source tarball (name defaults to wxPython-src)")
  32             }
  33
  34 mswProjectFiles = [ ".vcproj", ".sln", ".dsp", ".dsw", ".vc", ".bat"]
  35 nativeLineEndingFiles = [".cpp", ".h", ".c", ".txt"]
  36
  37
  38
  39 ## PARSE OPTIONS
  40
  41 usage="""usage: %prog [options] <output directory>\n
  42 Create a wxWidgets archive and store it in <output directory>.
  43 The output directory must be an absolute, existing path.
  44 Type %prog --help for options.
  45 """
  46
  47 parser = optparse.OptionParser(usage, version="%prog 1.0")
  48
  49 for opt in option_dict:
  50     default = option_dict[opt][0]
  51
  52     action = "store"
  53     if type(default) == types.BooleanType:
  54         action = "store_true"
  55     parser.add_option("--" + opt, default=default, action=action, dest=opt, help=option_dict[opt][1])
  56
  57 options, arguments = parser.parse_args()
  58
  59 if len(arguments) < 1 or not os.path.exists(arguments[0]) or not os.path.isabs(arguments[0]):
  60     parser.print_usage()
  61     sys.exit(1)
  62
  63 destDir = arguments[0]
  64 if not os.path.exists(destDir):
  65     os.makedirs(destDir)
  66
  67 wxVersion = None
  68 VERSION_FILE = os.path.join(rootDir, 'include/wx/version.h')
  69
  70
  71 ## HELPER FUNCTIONS
  72
  73 def makeDOSLineEndings(dir, extensions):
  74     fileList = []
  75     for root, subFolders, files in os.walk(dir):
  76         for file in files:
  77             if os.path.splitext(file)[1] in extensions:
  78                 os.system("unix2dos %s" % os.path.join(root, file))
  79
  80 def getVersion(includeSubrelease=False):
  81     """Returns wxWidgets version as a tuple: (major,minor,release)."""
  82
  83     wxVersion = None
  84     major = None
  85     minor = None
  86     release = None
  87     subrelease = None
  88     if wxVersion == None:
  89         f = open(VERSION_FILE, 'rt')
  90         lines = f.readlines()
  91         f.close()
  92         major = minor = release = None
  93         for l in lines:
  94             if not l.startswith('#define'): continue
  95             splitline = l.strip().split()
  96             if splitline[0] != '#define': continue
  97             if len(splitline) < 3: continue
  98             name = splitline[1]
  99             value = splitline[2]
 100             if value == None: continue
 101             if name == 'wxMAJOR_VERSION': major = int(value)
 102             if name == 'wxMINOR_VERSION': minor = int(value)
 103             if name == 'wxRELEASE_NUMBER': release = int(value)
 104             if name == 'wxSUBRELEASE_NUMBER': subrelease = int(value)
 105             if major != None and minor != None and release != None:
 106                 if not includeSubrelease or subrelease != None:
 107                     break
 108
 109         if includeSubrelease:
 110             wxVersion = (major, minor, release, subrelease)
 111         else:
 112             wxVersion = (major, minor, release)
 113     return wxVersion
 114
 115 def allFilesRecursive(dir):
 116     fileList = []
 117     for root, subFolders, files in os.walk(dir):
 118         shouldCopy = True
 119         for ignoreDir in dirsToIgnore:
 120             if ignoreDir in root:
 121                 shouldCopy = False
 122
 123         if shouldCopy:
 124             for file in files:
 125                 path = os.path.join(root,file)
 126                 for exclude in excludeExtensions:
 127                     if not os.path.splitext(file)[1] in excludeExtensions:
 128                         fileList.append(os.path.join(root,file))
 129     return fileList
 130
 131
 132 ## MAKE THE RELEASE!
 133
 134 str_version = "%d.%d.%d" % getVersion()
 135 archive_name = options.name
 136
 137 if options.wxpython:
 138     dirsToCopy.append("wxPython")
 139     archive_name = "wxPython-src"
 140     str_version = "%d.%d.%d.%d" % getVersion(includeSubrelease=True)
 141     options.docs = "none"
 142
 143 if options.postfix != "":
 144     str_version += "-" + options.postfix
 145
 146 full_name = archive_name + "-" + str_version
 147
 148 copyDir = tempfile.mkdtemp()
 149 wxCopyDir = os.path.join(copyDir, full_name)
 150
 151 os.makedirs(wxCopyDir)
 152
 153 os.chdir(rootDir)
 154 fileList = []
 155 rootFiles = glob.glob("*")
 156 for afile in rootFiles:
 157     if os.path.isfile(os.path.abspath(afile)):
 158         fileList.append(afile)
 159
 160 for dir in dirsToCopy:
 161     print "Determining files to copy from %s..." % dir
 162     fileList.extend(allFilesRecursive(dir))
 163
 164 print "Copying files to the temporary folder %s..." % copyDir
 165 for afile in fileList:
 166     destFile = os.path.join(wxCopyDir, afile)
 167     dirName = os.path.dirname(destFile)
 168     if not os.path.exists(dirName):
 169         os.makedirs(dirName)
 170     shutil.copy(os.path.join(rootDir, afile), destFile)
 171
 172 # copy include/wx/msw/setup0.h -> include/wx/msw/setup.h
 173 mswSetup0 = os.path.join(wxCopyDir, "include","wx","msw","setup0.h")
 174 shutil.copy(mswSetup0, mswSetup0.replace("setup0.h", "setup.h")),
 175
 176 all = options.compression == "all"
 177
 178 # make sure they have the DOS line endings everywhere
 179 print "Setting MSW Project files to use DOS line endings..."
 180 makeDOSLineEndings(wxCopyDir, mswProjectFiles)
 181
 182 if all or options.compression == "gzip":
 183     print "Creating gzip archive..."
 184     os.chdir(copyDir)
 185     os.system("tar -czvf %s/%s.tar.gz %s" % (destDir, full_name, "*"))
 186     os.chdir(rootDir)
 187
 188 if all or options.compression == "bzip":
 189     print "Creating bzip archive..."
 190     os.chdir(copyDir)
 191     os.system("tar -cjvf %s/%s.tar.bz2 %s" % (destDir, full_name, "*"))
 192     os.chdir(rootDir)
 193
 194 if all or options.compression == "zip":
 195     os.chdir(copyDir)
 196     print "Setting DOS line endings on source and text files..."
 197     makeDOSLineEndings(copyDir, nativeLineEndingFiles)
 198     print "Creating zip archive..."
 199     os.system("zip -9 -r %s/%s.zip %s" % (destDir, full_name, "*"))
 200     os.chdir(rootDir)
 201
 202 shutil.rmtree(copyDir)
 203
 204 # build any docs packages:
 205 doc_formats = string.split(options.docs, ",")
 206 doxy_dir = "docs/doxygen"
 207 output_dir = doxy_dir + "/out"
 208 for format in doc_formats:
 209     if not format == "none":
 210         os.system("%s/regen.sh %s" % (doxy_dir, format))
 211         os.chdir(output_dir)
 212         docs_full_name = "%s-%s" % (full_name, format.upper())
 213         os.rename(format, docs_full_name)
 214         os.system("zip -9 -r %s/%s.zip %s" % (destDir, docs_full_name, "*"))
 215
 216 os.chdir(rootDir)
 217 if os.path.exists(output_dir):
 218     shutil.rmtree(output_dir)