EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / distutils / command / bdist_rpm.py

"""distutils.command.bdist_rpm\r
\r
Implements the Distutils 'bdist_rpm' command (create RPM source and binary\r
distributions)."""\r
\r
__revision__ = "$Id$"\r
\r
import sys\r
import os\r
import string\r
\r
from distutils.core import Command\r
from distutils.debug import DEBUG\r
from distutils.file_util import write_file\r
from distutils.errors import (DistutilsOptionError, DistutilsPlatformError,\r
                              DistutilsFileError, DistutilsExecError)\r
from distutils import log\r
\r
class bdist_rpm (Command):\r
\r
    description = "create an RPM distribution"\r
\r
    user_options = [\r
        ('bdist-base=', None,\r
         "base directory for creating built distributions"),\r
        ('rpm-base=', None,\r
         "base directory for creating RPMs (defaults to \"rpm\" under "\r
         "--bdist-base; must be specified for RPM 2)"),\r
        ('dist-dir=', 'd',\r
         "directory to put final RPM files in "\r
         "(and .spec files if --spec-only)"),\r
        ('python=', None,\r
         "path to Python interpreter to hard-code in the .spec file "\r
         "(default: \"python\")"),\r
        ('fix-python', None,\r
         "hard-code the exact path to the current Python interpreter in "\r
         "the .spec file"),\r
        ('spec-only', None,\r
         "only regenerate spec file"),\r
        ('source-only', None,\r
         "only generate source RPM"),\r
        ('binary-only', None,\r
         "only generate binary RPM"),\r
        ('use-bzip2', None,\r
         "use bzip2 instead of gzip to create source distribution"),\r
\r
        # More meta-data: too RPM-specific to put in the setup script,\r
        # but needs to go in the .spec file -- so we make these options\r
        # to "bdist_rpm".  The idea is that packagers would put this\r
        # info in setup.cfg, although they are of course free to\r
        # supply it on the command line.\r
        ('distribution-name=', None,\r
         "name of the (Linux) distribution to which this "\r
         "RPM applies (*not* the name of the module distribution!)"),\r
        ('group=', None,\r
         "package classification [default: \"Development/Libraries\"]"),\r
        ('release=', None,\r
         "RPM release number"),\r
        ('serial=', None,\r
         "RPM serial number"),\r
        ('vendor=', None,\r
         "RPM \"vendor\" (eg. \"Joe Blow <joe@example.com>\") "\r
         "[default: maintainer or author from setup script]"),\r
        ('packager=', None,\r
         "RPM packager (eg. \"Jane Doe <jane@example.net>\")"\r
         "[default: vendor]"),\r
        ('doc-files=', None,\r
         "list of documentation files (space or comma-separated)"),\r
        ('changelog=', None,\r
         "RPM changelog"),\r
        ('icon=', None,\r
         "name of icon file"),\r
        ('provides=', None,\r
         "capabilities provided by this package"),\r
        ('requires=', None,\r
         "capabilities required by this package"),\r
        ('conflicts=', None,\r
         "capabilities which conflict with this package"),\r
        ('build-requires=', None,\r
         "capabilities required to build this package"),\r
        ('obsoletes=', None,\r
         "capabilities made obsolete by this package"),\r
        ('no-autoreq', None,\r
         "do not automatically calculate dependencies"),\r
\r
        # Actions to take when building RPM\r
        ('keep-temp', 'k',\r
         "don't clean up RPM build directory"),\r
        ('no-keep-temp', None,\r
         "clean up RPM build directory [default]"),\r
        ('use-rpm-opt-flags', None,\r
         "compile with RPM_OPT_FLAGS when building from source RPM"),\r
        ('no-rpm-opt-flags', None,\r
         "do not pass any RPM CFLAGS to compiler"),\r
        ('rpm3-mode', None,\r
         "RPM 3 compatibility mode (default)"),\r
        ('rpm2-mode', None,\r
         "RPM 2 compatibility mode"),\r
\r
        # Add the hooks necessary for specifying custom scripts\r
        ('prep-script=', None,\r
         "Specify a script for the PREP phase of RPM building"),\r
        ('build-script=', None,\r
         "Specify a script for the BUILD phase of RPM building"),\r
\r
        ('pre-install=', None,\r
         "Specify a script for the pre-INSTALL phase of RPM building"),\r
        ('install-script=', None,\r
         "Specify a script for the INSTALL phase of RPM building"),\r
        ('post-install=', None,\r
         "Specify a script for the post-INSTALL phase of RPM building"),\r
\r
        ('pre-uninstall=', None,\r
         "Specify a script for the pre-UNINSTALL phase of RPM building"),\r
        ('post-uninstall=', None,\r
         "Specify a script for the post-UNINSTALL phase of RPM building"),\r
\r
        ('clean-script=', None,\r
         "Specify a script for the CLEAN phase of RPM building"),\r
\r
        ('verify-script=', None,\r
         "Specify a script for the VERIFY phase of the RPM build"),\r
\r
        # Allow a packager to explicitly force an architecture\r
        ('force-arch=', None,\r
         "Force an architecture onto the RPM build process"),\r
\r
        ('quiet', 'q',\r
         "Run the INSTALL phase of RPM building in quiet mode"),\r
        ]\r
\r
    boolean_options = ['keep-temp', 'use-rpm-opt-flags', 'rpm3-mode',\r
                       'no-autoreq', 'quiet']\r
\r
    negative_opt = {'no-keep-temp': 'keep-temp',\r
                    'no-rpm-opt-flags': 'use-rpm-opt-flags',\r
                    'rpm2-mode': 'rpm3-mode'}\r
\r
\r
    def initialize_options (self):\r
        self.bdist_base = None\r
        self.rpm_base = None\r
        self.dist_dir = None\r
        self.python = None\r
        self.fix_python = None\r
        self.spec_only = None\r
        self.binary_only = None\r
        self.source_only = None\r
        self.use_bzip2 = None\r
\r
        self.distribution_name = None\r
        self.group = None\r
        self.release = None\r
        self.serial = None\r
        self.vendor = None\r
        self.packager = None\r
        self.doc_files = None\r
        self.changelog = None\r
        self.icon = None\r
\r
        self.prep_script = None\r
        self.build_script = None\r
        self.install_script = None\r
        self.clean_script = None\r
        self.verify_script = None\r
        self.pre_install = None\r
        self.post_install = None\r
        self.pre_uninstall = None\r
        self.post_uninstall = None\r
        self.prep = None\r
        self.provides = None\r
        self.requires = None\r
        self.conflicts = None\r
        self.build_requires = None\r
        self.obsoletes = None\r
\r
        self.keep_temp = 0\r
        self.use_rpm_opt_flags = 1\r
        self.rpm3_mode = 1\r
        self.no_autoreq = 0\r
\r
        self.force_arch = None\r
        self.quiet = 0\r
\r
    # initialize_options()\r
\r
\r
    def finalize_options (self):\r
        self.set_undefined_options('bdist', ('bdist_base', 'bdist_base'))\r
        if self.rpm_base is None:\r
            if not self.rpm3_mode:\r
                raise DistutilsOptionError, \\r
                      "you must specify --rpm-base in RPM 2 mode"\r
            self.rpm_base = os.path.join(self.bdist_base, "rpm")\r
\r
        if self.python is None:\r
            if self.fix_python:\r
                self.python = sys.executable\r
            else:\r
                self.python = "python"\r
        elif self.fix_python:\r
            raise DistutilsOptionError, \\r
                  "--python and --fix-python are mutually exclusive options"\r
\r
        if os.name != 'posix':\r
            raise DistutilsPlatformError, \\r
                  ("don't know how to create RPM "\r
                   "distributions on platform %s" % os.name)\r
        if self.binary_only and self.source_only:\r
            raise DistutilsOptionError, \\r
                  "cannot supply both '--source-only' and '--binary-only'"\r
\r
        # don't pass CFLAGS to pure python distributions\r
        if not self.distribution.has_ext_modules():\r
            self.use_rpm_opt_flags = 0\r
\r
        self.set_undefined_options('bdist', ('dist_dir', 'dist_dir'))\r
        self.finalize_package_data()\r
\r
    # finalize_options()\r
\r
    def finalize_package_data (self):\r
        self.ensure_string('group', "Development/Libraries")\r
        self.ensure_string('vendor',\r
                           "%s <%s>" % (self.distribution.get_contact(),\r
                                        self.distribution.get_contact_email()))\r
        self.ensure_string('packager')\r
        self.ensure_string_list('doc_files')\r
        if isinstance(self.doc_files, list):\r
            for readme in ('README', 'README.txt'):\r
                if os.path.exists(readme) and readme not in self.doc_files:\r
                    self.doc_files.append(readme)\r
\r
        self.ensure_string('release', "1")\r
        self.ensure_string('serial')   # should it be an int?\r
\r
        self.ensure_string('distribution_name')\r
\r
        self.ensure_string('changelog')\r
          # Format changelog correctly\r
        self.changelog = self._format_changelog(self.changelog)\r
\r
        self.ensure_filename('icon')\r
\r
        self.ensure_filename('prep_script')\r
        self.ensure_filename('build_script')\r
        self.ensure_filename('install_script')\r
        self.ensure_filename('clean_script')\r
        self.ensure_filename('verify_script')\r
        self.ensure_filename('pre_install')\r
        self.ensure_filename('post_install')\r
        self.ensure_filename('pre_uninstall')\r
        self.ensure_filename('post_uninstall')\r
\r
        # XXX don't forget we punted on summaries and descriptions -- they\r
        # should be handled here eventually!\r
\r
        # Now *this* is some meta-data that belongs in the setup script...\r
        self.ensure_string_list('provides')\r
        self.ensure_string_list('requires')\r
        self.ensure_string_list('conflicts')\r
        self.ensure_string_list('build_requires')\r
        self.ensure_string_list('obsoletes')\r
\r
        self.ensure_string('force_arch')\r
    # finalize_package_data ()\r
\r
\r
    def run (self):\r
\r
        if DEBUG:\r
            print "before _get_package_data():"\r
            print "vendor =", self.vendor\r
            print "packager =", self.packager\r
            print "doc_files =", self.doc_files\r
            print "changelog =", self.changelog\r
\r
        # make directories\r
        if self.spec_only:\r
            spec_dir = self.dist_dir\r
            self.mkpath(spec_dir)\r
        else:\r
            rpm_dir = {}\r
            for d in ('SOURCES', 'SPECS', 'BUILD', 'RPMS', 'SRPMS'):\r
                rpm_dir[d] = os.path.join(self.rpm_base, d)\r
                self.mkpath(rpm_dir[d])\r
            spec_dir = rpm_dir['SPECS']\r
\r
        # Spec file goes into 'dist_dir' if '--spec-only specified',\r
        # build/rpm.<plat> otherwise.\r
        spec_path = os.path.join(spec_dir,\r
                                 "%s.spec" % self.distribution.get_name())\r
        self.execute(write_file,\r
                     (spec_path,\r
                      self._make_spec_file()),\r
                     "writing '%s'" % spec_path)\r
\r
        if self.spec_only: # stop if requested\r
            return\r
\r
        # Make a source distribution and copy to SOURCES directory with\r
        # optional icon.\r
        saved_dist_files = self.distribution.dist_files[:]\r
        sdist = self.reinitialize_command('sdist')\r
        if self.use_bzip2:\r
            sdist.formats = ['bztar']\r
        else:\r
            sdist.formats = ['gztar']\r
        self.run_command('sdist')\r
        self.distribution.dist_files = saved_dist_files\r
\r
        source = sdist.get_archive_files()[0]\r
        source_dir = rpm_dir['SOURCES']\r
        self.copy_file(source, source_dir)\r
\r
        if self.icon:\r
            if os.path.exists(self.icon):\r
                self.copy_file(self.icon, source_dir)\r
            else:\r
                raise DistutilsFileError, \\r
                      "icon file '%s' does not exist" % self.icon\r
\r
\r
        # build package\r
        log.info("building RPMs")\r
        rpm_cmd = ['rpm']\r
        if os.path.exists('/usr/bin/rpmbuild') or \\r
           os.path.exists('/bin/rpmbuild'):\r
            rpm_cmd = ['rpmbuild']\r
\r
        if self.source_only: # what kind of RPMs?\r
            rpm_cmd.append('-bs')\r
        elif self.binary_only:\r
            rpm_cmd.append('-bb')\r
        else:\r
            rpm_cmd.append('-ba')\r
        if self.rpm3_mode:\r
            rpm_cmd.extend(['--define',\r
                             '_topdir %s' % os.path.abspath(self.rpm_base)])\r
        if not self.keep_temp:\r
            rpm_cmd.append('--clean')\r
\r
        if self.quiet:\r
            rpm_cmd.append('--quiet')\r
\r
        rpm_cmd.append(spec_path)\r
        # Determine the binary rpm names that should be built out of this spec\r
        # file\r
        # Note that some of these may not be really built (if the file\r
        # list is empty)\r
        nvr_string = "%{name}-%{version}-%{release}"\r
        src_rpm = nvr_string + ".src.rpm"\r
        non_src_rpm = "%{arch}/" + nvr_string + ".%{arch}.rpm"\r
        q_cmd = r"rpm -q --qf '%s %s\n' --specfile '%s'" % (\r
            src_rpm, non_src_rpm, spec_path)\r
\r
        out = os.popen(q_cmd)\r
        try:\r
            binary_rpms = []\r
            source_rpm = None\r
            while 1:\r
                line = out.readline()\r
                if not line:\r
                    break\r
                l = string.split(string.strip(line))\r
                assert(len(l) == 2)\r
                binary_rpms.append(l[1])\r
                # The source rpm is named after the first entry in the spec file\r
                if source_rpm is None:\r
                    source_rpm = l[0]\r
\r
            status = out.close()\r
            if status:\r
                raise DistutilsExecError("Failed to execute: %s" % repr(q_cmd))\r
\r
        finally:\r
            out.close()\r
\r
        self.spawn(rpm_cmd)\r
\r
        if not self.dry_run:\r
            if not self.binary_only:\r
                srpm = os.path.join(rpm_dir['SRPMS'], source_rpm)\r
                assert(os.path.exists(srpm))\r
                self.move_file(srpm, self.dist_dir)\r
\r
            if not self.source_only:\r
                for rpm in binary_rpms:\r
                    rpm = os.path.join(rpm_dir['RPMS'], rpm)\r
                    if os.path.exists(rpm):\r
                        self.move_file(rpm, self.dist_dir)\r
    # run()\r
\r
    def _dist_path(self, path):\r
        return os.path.join(self.dist_dir, os.path.basename(path))\r
\r
    def _make_spec_file(self):\r
        """Generate the text of an RPM spec file and return it as a\r
        list of strings (one per line).\r
        """\r
        # definitions and headers\r
        spec_file = [\r
            '%define name ' + self.distribution.get_name(),\r
            '%define version ' + self.distribution.get_version().replace('-','_'),\r
            '%define unmangled_version ' + self.distribution.get_version(),\r
            '%define release ' + self.release.replace('-','_'),\r
            '',\r
            'Summary: ' + self.distribution.get_description(),\r
            ]\r
\r
        # put locale summaries into spec file\r
        # XXX not supported for now (hard to put a dictionary\r
        # in a config file -- arg!)\r
        #for locale in self.summaries.keys():\r
        #    spec_file.append('Summary(%s): %s' % (locale,\r
        #                                          self.summaries[locale]))\r
\r
        spec_file.extend([\r
            'Name: %{name}',\r
            'Version: %{version}',\r
            'Release: %{release}',])\r
\r
        # XXX yuck! this filename is available from the "sdist" command,\r
        # but only after it has run: and we create the spec file before\r
        # running "sdist", in case of --spec-only.\r
        if self.use_bzip2:\r
            spec_file.append('Source0: %{name}-%{unmangled_version}.tar.bz2')\r
        else:\r
            spec_file.append('Source0: %{name}-%{unmangled_version}.tar.gz')\r
\r
        spec_file.extend([\r
            'License: ' + self.distribution.get_license(),\r
            'Group: ' + self.group,\r
            'BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot',\r
            'Prefix: %{_prefix}', ])\r
\r
        if not self.force_arch:\r
            # noarch if no extension modules\r
            if not self.distribution.has_ext_modules():\r
                spec_file.append('BuildArch: noarch')\r
        else:\r
            spec_file.append( 'BuildArch: %s' % self.force_arch )\r
\r
        for field in ('Vendor',\r
                      'Packager',\r
                      'Provides',\r
                      'Requires',\r
                      'Conflicts',\r
                      'Obsoletes',\r
                      ):\r
            val = getattr(self, string.lower(field))\r
            if isinstance(val, list):\r
                spec_file.append('%s: %s' % (field, string.join(val)))\r
            elif val is not None:\r
                spec_file.append('%s: %s' % (field, val))\r
\r
\r
        if self.distribution.get_url() != 'UNKNOWN':\r
            spec_file.append('Url: ' + self.distribution.get_url())\r
\r
        if self.distribution_name:\r
            spec_file.append('Distribution: ' + self.distribution_name)\r
\r
        if self.build_requires:\r
            spec_file.append('BuildRequires: ' +\r
                             string.join(self.build_requires))\r
\r
        if self.icon:\r
            spec_file.append('Icon: ' + os.path.basename(self.icon))\r
\r
        if self.no_autoreq:\r
            spec_file.append('AutoReq: 0')\r
\r
        spec_file.extend([\r
            '',\r
            '%description',\r
            self.distribution.get_long_description()\r
            ])\r
\r
        # put locale descriptions into spec file\r
        # XXX again, suppressed because config file syntax doesn't\r
        # easily support this ;-(\r
        #for locale in self.descriptions.keys():\r
        #    spec_file.extend([\r
        #        '',\r
        #        '%description -l ' + locale,\r
        #        self.descriptions[locale],\r
        #        ])\r
\r
        # rpm scripts\r
        # figure out default build script\r
        def_setup_call = "%s %s" % (self.python,os.path.basename(sys.argv[0]))\r
        def_build = "%s build" % def_setup_call\r
        if self.use_rpm_opt_flags:\r
            def_build = 'env CFLAGS="$RPM_OPT_FLAGS" ' + def_build\r
\r
        # insert contents of files\r
\r
        # XXX this is kind of misleading: user-supplied options are files\r
        # that we open and interpolate into the spec file, but the defaults\r
        # are just text that we drop in as-is.  Hmmm.\r
\r
        install_cmd = ('%s install -O1 --root=$RPM_BUILD_ROOT '\r
                       '--record=INSTALLED_FILES') % def_setup_call\r
\r
        script_options = [\r
            ('prep', 'prep_script', "%setup -n %{name}-%{unmangled_version}"),\r
            ('build', 'build_script', def_build),\r
            ('install', 'install_script', install_cmd),\r
            ('clean', 'clean_script', "rm -rf $RPM_BUILD_ROOT"),\r
            ('verifyscript', 'verify_script', None),\r
            ('pre', 'pre_install', None),\r
            ('post', 'post_install', None),\r
            ('preun', 'pre_uninstall', None),\r
            ('postun', 'post_uninstall', None),\r
        ]\r
\r
        for (rpm_opt, attr, default) in script_options:\r
            # Insert contents of file referred to, if no file is referred to\r
            # use 'default' as contents of script\r
            val = getattr(self, attr)\r
            if val or default:\r
                spec_file.extend([\r
                    '',\r
                    '%' + rpm_opt,])\r
                if val:\r
                    spec_file.extend(string.split(open(val, 'r').read(), '\n'))\r
                else:\r
                    spec_file.append(default)\r
\r
\r
        # files section\r
        spec_file.extend([\r
            '',\r
            '%files -f INSTALLED_FILES',\r
            '%defattr(-,root,root)',\r
            ])\r
\r
        if self.doc_files:\r
            spec_file.append('%doc ' + string.join(self.doc_files))\r
\r
        if self.changelog:\r
            spec_file.extend([\r
                '',\r
                '%changelog',])\r
            spec_file.extend(self.changelog)\r
\r
        return spec_file\r
\r
    # _make_spec_file ()\r
\r
    def _format_changelog(self, changelog):\r
        """Format the changelog correctly and convert it to a list of strings\r
        """\r
        if not changelog:\r
            return changelog\r
        new_changelog = []\r
        for line in string.split(string.strip(changelog), '\n'):\r
            line = string.strip(line)\r
            if line[0] == '*':\r
                new_changelog.extend(['', line])\r
            elif line[0] == '-':\r
                new_changelog.append(line)\r
            else:\r
                new_changelog.append('  ' + line)\r
\r
        # strip trailing newline inserted by first changelog entry\r
        if not new_changelog[0]:\r
            del new_changelog[0]\r
\r
        return new_changelog\r
\r
    # _format_changelog()\r
\r
# class bdist_rpm\r