Lib/distutils/command/bdist_pkgtool.py

   1 """distutils.command.bdist_pkgtool
   2
   3
   4 Author: Mark W. Alexander <slash@dotnet.net>
   5
   6 Implements the Distutils 'bdist_pkgtool' command (create Solaris pkgtool
   7 distributions)."""
   8
   9 import os, string, sys
  10 from types import *
  11 from distutils.util import get_platform
  12 from distutils.file_util import write_file
  13 from distutils.errors import *
  14 from distutils.command import bdist_packager
  15 from distutils import sysconfig
  16 from distutils import log
  17 from commands import getoutput
  18
  19 __revision__ = "$Id: bdist_pkgtool.py,v 0.3 mwa "
  20
  21 # default request script - Is also wrapped around user's request script
  22 # unless --no-autorelocate is requested. Finds the python site-packages
  23 # directory and prompts for verification
  24 DEFAULT_REQUEST="""#!/bin/sh
  25 ######################################################################
  26 #         Distutils internal package relocation support              #
  27 ######################################################################
  28
  29 PRODUCT="__DISTUTILS_NAME__"
  30
  31 trap `exit 3` 15
  32 /usr/bin/which python 2>&1 >/dev/null
  33 if [ $? -ne 0 ]; then
  34     echo "The python interpretor needs to be on your path!"
  35     echo
  36     echo "If you have more than one, make sure the first one is where"
  37     echo "you want this module installed:"
  38     exit 1
  39 fi
  40
  41 PY_DIR=`python -c "import sys;print '%s/lib/python%s' % (sys.exec_prefix,sys.version[0:3])" 2>/dev/null`
  42 PY_PKG_DIR=`python -c "import sys;print '%s/lib/python%s/site-packages' % (sys.exec_prefix,sys.version[0:3])" 2>/dev/null`
  43
  44 echo ""
  45 if [ -z "${PY_DIR}" ]; then
  46         echo "I can't seem to find the python distribution."
  47         echo "I'm assuming the default path for site-packages"
  48 else
  49         BASEDIR="${PY_PKG_DIR}"
  50         cat <<EOF
  51         Python found! The default path:
  52
  53         ${BASEDIR}
  54
  55         will install ${PRODUCT} such that all python users
  56         can import it.
  57
  58         If you just want individual access, you can install into
  59         any directory and add that directory to your \$PYTHONPATH
  60 EOF
  61 fi
  62 echo ""
  63
  64 BASEDIR=`ckpath -d ${BASEDIR} -ay \
  65         -p "Where should ${PRODUCT} be installed? [${BASEDIR}]"` || exit $?
  66
  67 ######################################################################
  68 #                user supplied request script follows                #
  69 ######################################################################
  70 """
  71 ### request script
  72
  73 # default postinstall compiles and changes ownership on the module directory
  74 # XXX The ownership change _should_ be handled by adjusting the prototype file
  75 DEFAULT_POSTINSTALL="""#!/bin/sh
  76 /usr/bin/test -d ${BASEDIR}/__DISTUTILS_NAME__
  77 if [ $? -eq 0 ]; then
  78         python -c "import compileall;compileall.compile_dir(\\"${BASEDIR}/__DISTUTILS_NAME__\\")"
  79         chown -R root:other ${BASEDIR}/__DISTUTILS_NAME__
  80 fi
  81 """
  82
  83 # default preremove deletes *.pyc and *.pyo from the module tree
  84 # This should leave the tree empty, so pkgtool will remove it.
  85 # If the user's scripts place anything else in there (e.g. config files),
  86 # pkgtool will leave the directory intact
  87 DEFAULT_PREREMOVE="""#!/bin/sh
  88
  89 /usr/bin/which python 2>&1 >/dev/null
  90 if [ $? -ne 0 ]; then
  91     echo "The python interpretor needs to be on your path!"
  92     echo
  93     echo "If you have more than one, make sure the first one is where"
  94     echo "you want this module removed from"
  95     exit 1
  96 fi
  97
  98 /usr/bin/test -d ${BASEDIR}/__DISTUTILS_NAME__
  99 if [ $? -eq 0 ]; then
 100         find ${BASEDIR}/__DISTUTILS_NAME__ -name "*.pyc" -exec rm {} \;
 101         find ${BASEDIR}/__DISTUTILS_NAME__ -name "*.pyo" -exec rm {} \;
 102 fi
 103 """
 104
 105 # default postremove removes the module directory _IF_ no files are
 106 # there (Turns out this isn't needed if the preremove does it's job
 107 # Left for posterity
 108 DEFAULT_POSTREMOVE="""#!/bin/sh
 109
 110 /usr/bin/test -d ${BASEDIR}/__DISTUTILS_NAME__
 111 if [ $? -eq 0 ]; then
 112         if [ `find ${BASEDIR}/__DISTUTILS_NAME__ ! -type d | wc -l` -eq 0 ]; then
 113         rm -rf ${BASEDIR}/__DISTUTILS_NAME__
 114         fi
 115 fi
 116 """
 117
 118 class bdist_pkgtool (bdist_packager.bdist_packager):
 119
 120     description = "create an pkgtool (Solaris) package"
 121
 122     user_options = bdist_packager.bdist_packager.user_options + [
 123         ('revision=', None,
 124          "package revision number (PSTAMP)"),
 125         ('pkg-abrev=', None,
 126          "Abbreviation (9 characters or less) of the package name"),
 127         ('compver=', None,
 128          "file containing compatible versions of this package (man compver)"),
 129         ('depend=', None,
 130          "file containing dependencies for this package (man depend)"),
 131         #('category=', None,
 132          #"Software category"),
 133         ('request=', None,
 134          "request script (Bourne shell code)"),
 135        ]
 136
 137     def initialize_options (self):
 138         # XXX Check for pkgtools on path...
 139         bdist_packager.bdist_packager.initialize_options(self)
 140         self.compver = None
 141         self.depend = None
 142         self.vendor = None
 143         self.classes = None
 144         self.request = None
 145         self.pkg_abrev = None
 146         self.revision = None
 147         # I'm not sure I should need to do this, but the setup.cfg
 148         # settings weren't showing up....
 149         options = self.distribution.get_option_dict('bdist_packager')
 150         for key in options.keys():
 151             setattr(self,key,options[key][1])
 152
 153     # initialize_options()
 154
 155
 156     def finalize_options (self):
 157         global DEFAULT_REQUEST, DEFAULT_POSTINSTALL
 158         global DEFAULT_PREREMOVE, DEFAULT_POSTREMOVE
 159         if self.pkg_dir is None:
 160             dist_dir = self.get_finalized_command('bdist').dist_dir
 161             self.pkg_dir = os.path.join(dist_dir, "pkgtool")
 162
 163         self.ensure_string('classes', None)
 164         self.ensure_string('revision', "1")
 165         self.ensure_script('request')
 166         self.ensure_script('preinstall')
 167         self.ensure_script('postinstall')
 168         self.ensure_script('preremove')
 169         self.ensure_script('postremove')
 170         self.ensure_string('vendor', None)
 171         if self.__dict__.has_key('author'):
 172             if self.__dict__.has_key('author_email'):
 173                 self.ensure_string('vendor',
 174                         "%s <%s>" % (self.author,
 175                            self.author_email))
 176             else:
 177                 self.ensure_string('vendor',
 178                      "%s" % (self.author))
 179         self.ensure_string('category', "System,application")
 180         self.ensure_script('compver')
 181         self.ensure_script('depend')
 182         bdist_packager.bdist_packager.finalize_options(self)
 183         if self.pkg_abrev is None:
 184             self.pkg_abrev=self.name
 185         if len(self.pkg_abrev)>9:
 186             raise DistutilsOptionError, \
 187             "pkg-abrev (%s) must be less than 9 characters" % self.pkg_abrev
 188         # Update default scripts with our metadata name
 189         DEFAULT_REQUEST = string.replace(DEFAULT_REQUEST,
 190             "__DISTUTILS_NAME__", self.root_package)
 191         DEFAULT_POSTINSTALL = string.replace(DEFAULT_POSTINSTALL,
 192             "__DISTUTILS_NAME__", self.root_package)
 193         DEFAULT_PREREMOVE = string.replace(DEFAULT_PREREMOVE,
 194             "__DISTUTILS_NAME__", self.root_package)
 195         DEFAULT_POSTREMOVE = string.replace(DEFAULT_POSTREMOVE,
 196             "__DISTUTILS_NAME__", self.root_package)
 197
 198     # finalize_options()
 199
 200
 201     def make_package(self,root=None):
 202         # make directories
 203         self.mkpath(self.pkg_dir)
 204         if root:
 205             pkg_dir = self.pkg_dir+"/"+root
 206             self.mkpath(pkg_dir)
 207         else:
 208             pkg_dir = self.pkg_dir
 209
 210         self.reinitialize_command('install', reinit_subcommands=1)
 211         # build package
 212         log.info('Building package')
 213         self.run_command('build')
 214         log.info('Creating pkginfo file')
 215         path = os.path.join(pkg_dir, "pkginfo")
 216         self.execute(write_file,
 217                      (path,
 218                       self._make_info_file()),
 219                      "writing '%s'" % path)
 220         # request script handling
 221         if self.request==None:
 222             self.request = self._make_request_script()
 223         if self.request!="":
 224             path = os.path.join(pkg_dir, "request")
 225             self.execute(write_file,
 226                      (path,
 227                       self.request),
 228                      "writing '%s'" % path)
 229
 230         # Create installation scripts, since compver & depend are
 231         # user created files, they work just fine as scripts
 232         self.write_script(os.path.join(pkg_dir, "postinstall"),
 233                  'postinstall',DEFAULT_POSTINSTALL)
 234         self.write_script(os.path.join(pkg_dir, "preinstall"),
 235                  'preinstall',None)
 236         self.write_script(os.path.join(pkg_dir, "preremove"),
 237                  'preremove',DEFAULT_PREREMOVE)
 238         self.write_script(os.path.join(pkg_dir, "postremove"),
 239                  'postremove',None)
 240         self.write_script(os.path.join(pkg_dir, "compver"),
 241                  'compver',None)
 242         self.write_script(os.path.join(pkg_dir, "depend"),
 243                  'depend',None)
 244
 245         log.info('Creating prototype file')
 246         path = os.path.join(pkg_dir, "prototype")
 247         self.execute(write_file,
 248                      (path,
 249                       self._make_prototype()),
 250                      "writing '%s'" % path)
 251
 252
 253         if self.control_only: # stop if requested
 254             return
 255
 256
 257         log.info('Creating package')
 258         pkg_cmd = ['pkgmk', '-o', '-f']
 259         pkg_cmd.append(path)
 260         pkg_cmd.append('-b')
 261         pkg_cmd.append(os.environ['PWD'])
 262         self.spawn(pkg_cmd)
 263         pkg_cmd = ['pkgtrans', '-s', '/var/spool/pkg']
 264         path = os.path.join(os.environ['PWD'],pkg_dir,
 265                            self.get_binary_name() + ".pkg")
 266         log.info('Transferring package to ' + pkg_dir)
 267         pkg_cmd.append(path)
 268         pkg_cmd.append(self.pkg_abrev)
 269         self.spawn(pkg_cmd)
 270         os.system("rm -rf /var/spool/pkg/%s" % self.pkg_abrev)
 271
 272
 273     def run (self):
 274         if self.subpackages:
 275             self.subpackages=string.split(self.subpackages,",")
 276             for pkg in self.subpackages:
 277                 self.make_package(pkg)
 278         else:
 279             self.make_package()
 280     # run()
 281
 282
 283     def _make_prototype(self):
 284         import pwd, grp
 285         proto_file = ["i pkginfo"]
 286         if self.request:
 287             proto_file.extend(['i request'])
 288         if self.postinstall:
 289             proto_file.extend(['i postinstall'])
 290         if self.postremove:
 291             proto_file.extend(['i postremove'])
 292         if self.preinstall:
 293             proto_file.extend(['i preinstall'])
 294         if self.preremove:
 295             proto_file.extend(['i preremove'])
 296         if self.compver:
 297             proto_file.extend(['i compver'])
 298         if self.requires:
 299             proto_file.extend(['i depend'])
 300         proto_file.extend(['!default 644 root bin'])
 301         build = self.get_finalized_command('build')
 302
 303         try:
 304             self.distribution.packages[0]
 305             file_list=string.split(
 306                 getoutput("pkgproto %s/%s=%s" % \
 307                           (build.build_lib, self.distribution.packages[0],
 308                            self.distribution.packages[0])), "\012")
 309         except:
 310             file_list=string.split(
 311             getoutput("pkgproto %s=" % (build.build_lib)),"\012")
 312         ownership="%s %s" % (pwd.getpwuid(os.getuid())[0],
 313             grp.getgrgid(os.getgid())[0])
 314         for i in range(len(file_list)):
 315             file_list[i] = string.replace(file_list[i],ownership,"root bin")
 316         proto_file.extend(file_list)
 317         return proto_file
 318
 319     def _make_request_script(self):
 320         global DEFAULT_REQUEST
 321         # A little different from other scripts, if we are to automatically
 322         # relocate to the target site-packages, we have to wrap any provided
 323         # script with the autorelocation script. If no script is provided,
 324         # The request script will simply be the autorelocate script
 325         if self.no_autorelocate==0:
 326             request=string.split(DEFAULT_REQUEST,"\012")
 327         else:
 328             log.info('Creating relocation request script')
 329         if self.request:
 330             users_request=self.get_script('request')
 331             if users_request!=None and users_request!=[]:
 332                 if self.no_autorelocate==0 and users_request[0][0:2]=="#!":
 333                     users_request.remove(users_request[0])
 334                 for i in users_request:
 335                     request.append(i)
 336
 337         if self.no_autorelocate==0:
 338             request.append("#############################################")
 339             request.append("#        finalize relocation support        #")
 340             request.append("#############################################")
 341             request.append('echo "BASEDIR=\\"${BASEDIR}\\"" >>$1')
 342         return request
 343
 344     def _make_info_file(self):
 345         """Generate the text of a pkgtool info file and return it as a
 346         list of strings (one per line).
 347         """
 348         # definitions and headers
 349         # PKG must be alphanumeric, < 9 characters
 350         info_file = [
 351             'PKG="%s"' % self.pkg_abrev,
 352             'NAME="%s"' % self.name,
 353             'VERSION="%s"' % self.version,
 354             'PSTAMP="%s"' % self.revision,
 355             ]
 356         info_file.extend(['VENDOR="%s (%s)"' % (self.distribution.maintainer, \
 357                 self.distribution.license) ])
 358         info_file.extend(['EMAIL="%s"' % self.distribution.maintainer_email ])
 359
 360         p = self.distribution.get_platforms()
 361         if p is None or p==['UNKNOWN']:
 362             archs=getoutput('uname -p')
 363         else:
 364             archs=string.join(self.distribution.get_platforms(),',')
 365         #else:
 366             #print "Assuming a sparc architecure"
 367             #archs='sparc'
 368         info_file.extend(['ARCH="%s"' % archs ])
 369
 370         if self.distribution.get_url():
 371             info_file.extend(['HOTLINE="%s"' % self.distribution.get_url() ])
 372         if self.classes:
 373             info_file.extend(['CLASSES="%s"' % self.classes ])
 374         if self.category:
 375             info_file.extend(['CATEGORY="%s"' % self.category ])
 376         site=None
 377         for i in  sys.path:
 378             if i[-13:]=="site-packages":
 379                 site=i
 380                 break
 381         if site:
 382             info_file.extend(['BASEDIR="%s"' % site ])
 383
 384         return info_file
 385
 386     # _make_info_file ()
 387
 388     def _format_changelog(self, changelog):
 389         """Format the changelog correctly and convert it to a list of strings
 390         """
 391         if not changelog:
 392             return changelog
 393         new_changelog = []
 394         for line in string.split(string.strip(changelog), '\n'):
 395             line = string.strip(line)
 396             if line[0] == '*':
 397                 new_changelog.extend(['', line])
 398             elif line[0] == '-':
 399                 new_changelog.append(line)
 400             else:
 401                 new_changelog.append('  ' + line)
 402
 403         # strip trailing newline inserted by first changelog entry
 404         if not new_changelog[0]:
 405             del new_changelog[0]
 406
 407         return new_changelog
 408
 409     # _format_changelog()
 410
 411 # class bdist_rpm