pkg2zero

   1 #!/usr/bin/env python
   2 # Copyright (C) 2009, Thomas Leonard
   3 # Copyright (C) 2008, Anders F Bjorklund
   4 # See the COPYING file for details, or visit http://0install.net.
   5
   6 import sys, time
   7 from optparse import OptionParser
   8 import tempfile, shutil, os
   9 from xml.dom import minidom
  10 import gzip
  11 try:
  12         import xml.etree.cElementTree as ET # Python 2.5
  13 except ImportError:
  14         try:
  15                 import xml.etree.ElementTree as ET
  16         except ImportError:
  17                 try:
  18                         import cElementTree as ET # http://effbot.org
  19                 except ImportError:
  20                         import elementtree.ElementTree as ET
  21
  22 import subprocess
  23 try:
  24         from subprocess import check_call
  25 except ImportError:
  26         def check_call(*popenargs, **kwargs):
  27                 rc = subprocess.call(*popenargs, **kwargs)
  28                 if rc != 0: raise OSError, rc
  29
  30 from zeroinstall.injector import model, qdom, distro
  31 from zeroinstall.zerostore import unpack
  32
  33 from support import read_child, add_node, Mappings
  34
  35 manifest_algorithm = 'sha1new'
  36
  37 deb_category_to_freedesktop = {
  38         'devel' : 'Development',
  39         'web' : 'Network',
  40         'graphics' : 'Graphics',
  41         'games' : 'Game',
  42 }
  43
  44 rpm_group_to_freedesktop = {
  45         'Development/Libraries' : 'Development',
  46 }
  47
  48 valid_categories = [
  49         'AudioVideo',
  50         'Audio',
  51         'Video',
  52         'Development',
  53         'Education',
  54         'Game',
  55         'Graphics',
  56         'Network',
  57         'Office',
  58         'Settings',
  59         'System',
  60         'Utility',
  61 ]
  62
  63 # Parse command-line arguments
  64
  65 parser = OptionParser('usage: %prog [options] http://.../package.deb [target-feed.xml]\n'
  66                       '       %prog [options] http://.../package.rpm [target-feed.xml]\n'
  67                       '       %prog [options] package-name [target-feed.xml]\n'
  68                       'Publish a Debian or RPM package in a Zero Install feed.\n'
  69                       "target-feed.xml is created if it doesn't already exist.")
  70 parser.add_option("-a", "--archive-url", help="archive to use as the package contents")
  71 parser.add_option("", "--archive-extract", help="only extract files under this subdirectory")
  72 parser.add_option("", "--license", help="value for 'license' attribute")
  73 parser.add_option("-r", "--repomd-file", help="repository metadata file")
  74 parser.add_option("", "--path", help="location of packages [5/os/i386]")
  75 parser.add_option("-p", "--packages-file", help="Debian package index file")
  76 parser.add_option("-m", "--mirror", help="location of packages [http://ftp.debian.org/debian] or [http://mirror.centos.org/centos]")
  77 parser.add_option("-k", "--key", help="key to use for signing")
  78 (options, args) = parser.parse_args()
  79
  80 if len(args) < 1 or len(args) > 2:
  81         parser.print_help()
  82         sys.exit(1)
  83
  84 # Load dependency mappings
  85 mappings = Mappings()
  86
  87 class Package:
  88         name = '(unknown)'
  89         version = None
  90         arch = None
  91         category = None
  92         homepage = None
  93         buildtime = None
  94         license = None
  95
  96         def __init__(self):
  97                 self.requires = []
  98
  99 class DebRepo:
 100         def __init__(self, options):
 101                 self.packages_base_url = (options.mirror or 'http://ftp.debian.org/debian') + '/'
 102                 self.packages_file = options.packages_file or 'Packages'
 103
 104         def get_repo_metadata(self, pkg_name):
 105                 if not os.path.isfile(self.packages_file):
 106                         print >>sys.stderr, ("File '%s' not found (use -p to give its location).\n"
 107                                 "Either download one (e.g. ftp://ftp.debian.org/debian/dists/stable/main/binary-amd64/Packages.bz2),\n"
 108                                 "or specify the full URL of the .deb package to use.") % self.packages_file
 109                         sys.exit(1)
 110                 if self.packages_file.endswith('.bz2'):
 111                         import bz2
 112                         opener = bz2.BZ2File
 113                 else:
 114                         opener = file
 115                 pkg_data = "\n" + opener(self.packages_file).read()
 116                 try:
 117                         i = pkg_data.index('\nPackage: %s\n' % pkg_name)
 118                 except ValueError:
 119                         raise Exception("Package '%s' not found in Packages file '%s'." % (pkg_name, self.packages_file))
 120                 j = pkg_data.find('\n\n', i)
 121                 if j == -1:
 122                         pkg_info = pkg_data[i:]
 123                 else:
 124                         pkg_info = pkg_data[i:j]
 125                 filename = None
 126                 digest = {}
 127                 for line in pkg_info.split('\n'):
 128                         if ':' in line and not line.startswith(' '):
 129                                 key, value = line.split(':', 1)
 130                                 if key == 'Filename':
 131                                         filename = value.strip()
 132                                 elif key in ('SHA1', 'SHA256'):
 133                                         digest[key.lower()] = value.strip()
 134                 if filename is None:
 135                         raise Exception('Filename: field not found in package data:\n' + pkg_info)
 136                 pkg_url = self.packages_base_url + filename
 137
 138                 return pkg_url, digest
 139
 140         def get_package_metadata(self, pkg_file):
 141                 package = Package()
 142
 143                 details = read_child(['dpkg-deb', '--info', pkg_file])
 144
 145                 description_and_summary = details.split('\n Description: ')[1].split('\n')
 146                 package.summary = description_and_summary[0]
 147                 description = ''
 148                 for x in description_and_summary[1:]:
 149                         if not x: continue
 150                         assert x[0] == ' '
 151                         x = x[1:]
 152                         if x[0] != ' ':
 153                                 break
 154                         if x == ' .':
 155                                 description += '\n'
 156                         else:
 157                                 description += x[1:].replace('.  ', '. ') + '\n'
 158                 package.description = description.strip()
 159
 160                 for line in details.split('\n'):
 161                         if not line: continue
 162                         assert line.startswith(' ')
 163                         line = line[1:]
 164                         if ':' in line:
 165                                 key, value = line.split(':', 1)
 166                                 value = value.strip()
 167                                 if key == 'Section':
 168                                         package.category = deb_category_to_freedesktop.get(value)
 169                                         if not package.category:
 170                                                 if value != 'libs':
 171                                                         print >>sys.stderr, "Warning: no mapping for Debian category '%s'" % value
 172                                 elif key == 'Package':
 173                                         package.name = value
 174                                 elif key == 'Version':
 175                                         value = value.replace('cvs', '')
 176                                         value = value.replace('svn', '')
 177                                         if ':' in value: value = value.split(':', 1)[1]
 178                                         package.version = distro.try_cleanup_distro_version(value)
 179                                 elif key == 'Architecture':
 180                                         if '-' in value:
 181                                                 arch, value = value.split('-', 1)
 182                                         else:
 183                                                 arch = 'linux'
 184                                         if value == 'amd64':
 185                                                 value = 'x86_64'
 186                                         elif value == 'all':
 187                                                 value = '*'
 188                                         package.arch = arch.capitalize() + '-' + value
 189                                 elif key == 'Depends':
 190                                         for x in value.split(','):
 191                                                 req = mappings.process(x)
 192                                                 if req:
 193                                                         package.requires.append(req)
 194                 return package
 195
 196 class RPMRepo:
 197         def __init__(self, options):
 198                 self.packages_base_url = (options.mirror or 'http://mirror.centos.org/centos') + '/'
 199                 self.packages_base_dir = (options.path or '5/os/i386') + '/'
 200                 self.repomd_file = options.repomd_file or 'repodata/repomd.xml'
 201                 if not os.path.isfile(self.repomd_file):
 202                         print >>sys.stderr, ("File '%s' not found (use -r to give its location).\n"
 203                                 "Either download one (e.g. http://mirror.centos.org/centos/5/os/i386/repodata/repomd.xml),\n"
 204                                 "or specify the full URL of the .rpm package to use.") % self.repomd_file
 205                         sys.exit(1)
 206
 207         def get_repo_metadata(self, pkg_name):
 208                 primary_file = None
 209                 repomd = minidom.parse(self.repomd_file)
 210                 repo_top = os.path.dirname(os.path.dirname(self.repomd_file))
 211                 for data in repomd.getElementsByTagName("data"):
 212                         if data.attributes["type"].nodeValue == "primary":
 213                                 for node in data.getElementsByTagName("location"):
 214                                         primary_file = os.path.join(repo_top, node.attributes["href"].nodeValue)
 215                 location = None
 216                 primary = ET.parse(gzip.open(primary_file))
 217                 NS = "http://linux.duke.edu/metadata/common"
 218                 metadata = primary.getroot()
 219                 pkg_data = None
 220                 for package in metadata.findall("{%s}package" % NS):
 221                         if package.find("{%s}name" % NS).text == pkg_name:
 222                                 pkg_data = package
 223                                 location = pkg_data.find("{%s}location" % NS).get("href")
 224                                 break
 225                 if pkg_data is None:
 226                         raise Exception("Package '%s' not found in repodata." % pkg_name)
 227                 checksum = pkg_data.find("{%s}checksum" % NS)
 228                 digest = {}
 229                 if checksum.get("type") == "sha":
 230                         digest["sha1"] = checksum.text
 231                 if checksum.get("type") == "sha256":
 232                         digest["sha256"] = checksum.text
 233                 if location is None:
 234                         raise Exception('location tag not found in primary metadata:\n' + primary_file)
 235                 pkg_url = self.packages_base_url + self.packages_base_dir + location
 236
 237                 return pkg_url, digest
 238
 239         def get_package_metadata(self, pkg_file):
 240                 package = Package()
 241
 242                 query_format = '%{SUMMARY}\\a%{DESCRIPTION}\\a%{NAME}\\a%{VERSION}\\a%{OS}\\a%{ARCH}\\a%{URL}\\a%{GROUP}\\a%{LICENSE}\\a%{BUILDTIME}\\a[%{REQUIRES}\\n]'
 243                 headers = read_child(['rpm', '--qf', query_format, '-qp', pkg_file]).split('\a')
 244
 245                 package.summary = headers[0].strip()
 246                 package.description = headers[1].strip()
 247
 248                 package.name = headers[2]
 249                 value = headers[3]
 250                 value = value.replace('cvs', '')
 251                 value = value.replace('svn', '')
 252                 value = distro.try_cleanup_distro_version(value)
 253                 package.version = value
 254                 value = headers[4]
 255                 package.arch = value.capitalize()
 256                 value = headers[5]
 257                 if value == 'amd64':
 258                         value = 'x86_64'
 259                 if value == 'noarch':
 260                         value = '*'
 261                 package.arch += '-' + value
 262                 value = headers[6].strip()
 263                 package.page = value
 264                 category = None
 265                 value = headers[7].strip()
 266                 package.category = rpm_group_to_freedesktop.get(value)
 267                 if not category:
 268                         print >>sys.stderr, "Warning: no mapping for RPM group '%s'" % value
 269
 270                 value = headers[8].strip()
 271                 package.license = value
 272                 value = headers[9].strip()
 273                 package.buildtime = long(value)
 274                 value = headers[10].strip()
 275                 for x in value.split('\n'):
 276                         if x.startswith('rpmlib'):
 277                                 continue
 278                         req = mappings.process(x)
 279                         if req:
 280                                 package.requires.append(req)
 281                 return package
 282
 283 if args[0].endswith('.deb') or options.packages_file:
 284         repo = DebRepo(options)
 285 elif args[0].endswith('.rpm') or options.repomd_file:
 286         repo = RPMRepo(options)
 287 else:
 288         print >>sys.stderr, "Use --packages-file for Debian, or --repomd-file for RPM"
 289         sys.exit(1)
 290
 291 pkg_data = None
 292
 293 if options.archive_url:
 294         pkg_url = None
 295         pkg_file = os.path.abspath(args[0])
 296         archive_url = options.archive_url
 297         archive_file = os.path.abspath(archive_url.rsplit('/', 1)[1])
 298         digest = {}
 299         assert os.path.exists(pkg_file), ("%s doesn't exist!" % pkg_file)
 300 else:
 301         scheme = args[0].split(':', 1)[0]
 302         if scheme in ('http', 'https', 'ftp'):
 303                 archive_url = args[0]
 304                 digest = {}
 305         else:
 306                 archive_url, digest = repo.get_repo_metadata(args[0])
 307         archive_file = pkg_file = os.path.abspath(archive_url.rsplit('/', 1)[1])
 308
 309 # pkg_url, pkg_archive = .deb or .rpm with the metadata
 310 # archive_url, archive_file = .dep, .rpm or .tar.bz2 with the contents
 311 #
 312 # Often pkg == archive, but sometimes it's useful to convert packages to tarballs
 313 # so people don't need special tools to extract them.
 314
 315
 316 # Download package, if required
 317
 318 if not os.path.exists(pkg_file):
 319         print >>sys.stderr, "File '%s' not found, so downloading from %s..." % (pkg_file, pkg_url)
 320         check_call(['wget', pkg_url])
 321
 322 # Check digest, if known
 323
 324 if "sha256" in digest:
 325         import hashlib
 326         m = hashlib.new('sha256')
 327         expected_digest = digest["sha256"]
 328 elif "sha1" in digest:
 329         try:
 330                 import hashlib
 331                 m = hashlib.new('sha1')
 332         except ImportError:
 333                 import sha
 334                 m = sha.new()
 335         expected_digest = digest["sha1"]
 336 else:
 337         m = None
 338
 339 if m:
 340         m.update(file(archive_file).read())
 341         actual = m.hexdigest()
 342         if actual != expected_digest:
 343                 raise Exception("Incorrect digest on package file! Was " + actual + ", but expected " + expected_digest)
 344         else:
 345                 print "Package's digest matches value in reposistory metadata (" + actual + "). Good."
 346 else:
 347         print >>sys.stderr, "Note: no SHA-1 or SHA-256 digest known for this package, so not checking..."
 348
 349 # Extract meta-data from package
 350
 351 pkg_metadata = repo.get_package_metadata(pkg_file)
 352
 353 # Unpack package, find binaries and .desktop files, and add to cache
 354
 355 possible_mains = []
 356 icondata = None
 357 tmp = tempfile.mkdtemp(prefix = 'pkg2zero-')
 358 try:
 359         unpack_dir = tmp
 360         unpack.unpack_archive(archive_file, open(archive_file), destdir = unpack_dir, extract = options.archive_extract)
 361         if options.archive_extract:
 362                 unpack_dir = os.path.join(unpack_dir, options.archive_extract)
 363
 364         icon = None
 365         images = {}
 366         for root, dirs, files in os.walk(unpack_dir):
 367                 assert root.startswith(unpack_dir)
 368                 relative_root = root[len(unpack_dir) + 1:]
 369                 for name in files:
 370                         full = os.path.join(root, name)
 371                         f = os.path.join(relative_root, name)
 372                         print f
 373                         if f.endswith('.desktop'):
 374                                 for line in file(full):
 375                                         if line.startswith('Categories'):
 376                                                 for cat in line.split('=', 1)[1].split(';'):
 377                                                         cat = cat.strip()
 378                                                         if cat in valid_categories:
 379                                                                 category = cat
 380                                                                 break
 381                                         elif line.startswith('Icon'):
 382                                                 icon = line.split('=', 1)[1].strip()
 383                         elif f.startswith('bin/') or f.startswith('usr/bin/') or f.startswith('usr/games/'):
 384                                 if os.path.isfile(full):
 385                                         possible_mains.append(f)
 386                         elif f.endswith('.png'):
 387                                 images[f] = full
 388                                 images[os.path.basename(f)] = full
 389                                 # make sure to also map basename without the extension
 390                                 images[os.path.splitext(os.path.basename(f))[0]] = full
 391
 392         icondata = None
 393         if icon in images:
 394                 print "Using %s for icon" % os.path.basename(images[icon])
 395                 icondata = file(images[icon]).read()
 396
 397         manifest = read_child(['0store', 'manifest', unpack_dir, manifest_algorithm])
 398         digest = manifest.rsplit('\n', 2)[1]
 399         check_call(['0store', 'add', digest, unpack_dir])
 400 finally:
 401         shutil.rmtree(tmp)
 402
 403 if possible_mains:
 404         possible_mains = sorted(possible_mains, key = len)
 405         pkg_main = possible_mains[0]
 406         if len(possible_mains) > 1:
 407                 print "Warning: several possible main binaries found:"
 408                 print "- " + pkg_main + " (I chose this one)"
 409                 for x in possible_mains[1:]:
 410                         print "- " + x
 411 else:
 412         pkg_main = None
 413
 414 # Make sure we haven't added this version already...
 415
 416 if len(args) > 1:
 417         target_feed_file = args[1]
 418         target_icon_file = args[1].replace('.xml', '.png')
 419 else:
 420         target_feed_file = pkg_metadata.name + '.xml'
 421         target_icon_file = pkg_metadata.name + '.png'
 422
 423 feed_uri = None
 424 icon_uri = None
 425 if os.path.isfile(target_feed_file):
 426         dom = qdom.parse(file(target_feed_file))
 427         old_target_feed = model.ZeroInstallFeed(dom, local_path = target_feed_file)
 428         existing_impl = old_target_feed.implementations.get(digest)
 429         if existing_impl:
 430                 print >>sys.stderr, ("Feed '%s' already contains an implementation with this digest!\n%s" % (target_feed_file, existing_impl))
 431                 sys.exit(1)
 432 else:
 433         # No target, so need to pick a URI
 434         feed_uri = mappings.lookup(pkg_metadata.name)
 435         if feed_uri is None:
 436                 suggestion = mappings.get_suggestion(pkg_metadata.name)
 437                 uri = raw_input('Enter the URI for this feed [%s]: ' % suggestion).strip()
 438                 if not uri:
 439                         uri = suggestion
 440                 assert uri.startswith('http://') or uri.startswith('https://') or uri.startswith('ftp://'), uri
 441                 feed_uri = uri
 442                 mappings.add_mapping(pkg_metadata.name, uri)
 443
 444         if icondata and not os.path.isfile(target_icon_file):
 445                 file = open(target_icon_file, 'wb')
 446                 file.write(icondata)
 447                 file.close()
 448         if icon_uri is None:
 449                 suggestion = 'http://0install.net/feed_icons/' + target_icon_file
 450                 uri = raw_input('Enter the URI for this icon [%s]: ' % suggestion).strip()
 451                 if not uri:
 452                         uri = suggestion
 453                 assert uri.startswith('http://') or uri.startswith('https://') or uri.startswith('ftp://'), uri
 454                 icon_uri = uri
 455
 456 # Create a local feed with just the new version...
 457
 458 template = '''<interface xmlns="http://zero-install.sourceforge.net/2004/injector/interface">
 459 </interface>'''
 460 doc = minidom.parseString(template)
 461 root = doc.documentElement
 462
 463 add_node(root, 'name', pkg_metadata.name)
 464 add_node(root, 'summary', pkg_metadata.summary)
 465 add_node(root, 'description', pkg_metadata.description)
 466 feed_for = add_node(root, 'feed-for', '')
 467 if feed_uri:
 468         feed_for.setAttribute('interface', feed_uri)
 469 if icon_uri:
 470         icon = add_node(root, 'icon')
 471         icon.setAttribute('href', icon_uri)
 472         icon.setAttribute('type', 'image/png')
 473 if pkg_metadata.homepage:
 474         add_node(root, 'homepage', pkg_metadata.homepage)
 475 if pkg_metadata.category:
 476         add_node(root, 'category', pkg_metadata.category)
 477
 478 package = add_node(root, 'package-implementation', '')
 479 package.setAttribute('package', pkg_metadata.name)
 480
 481 group = add_node(root, 'group', '')
 482 if pkg_metadata.arch:
 483         group.setAttribute('arch', pkg_metadata.arch)
 484 else:
 485         print >>sys.stderr, "No Architecture: field in package"
 486 if pkg_metadata.license:
 487         group.setAttribute('license', pkg_metadata.license)
 488
 489 for req in pkg_metadata.requires:
 490         req_element = add_node(group, 'requires', before = '\n    ', after = '')
 491         req_element.setAttribute('interface', req.interface)
 492         binding = add_node(req_element, 'environment', before = '\n      ', after = '\n    ')
 493         binding.setAttribute('name', 'LD_LIBRARY_PATH')
 494         binding.setAttribute('insert', 'usr/lib')
 495
 496 if pkg_main:
 497         group.setAttribute('main', pkg_main)
 498         package.setAttribute('main', '/' + pkg_main)
 499
 500 impl = add_node(group, 'implementation', before = '\n    ', after = '\n  ')
 501 impl.setAttribute('id', digest)
 502 assert pkg_metadata.version
 503 impl.setAttribute('version', pkg_metadata.version)
 504
 505 if options.license:
 506         impl.setAttribute('license', options.license)
 507
 508 if pkg_metadata.buildtime:
 509         impl.setAttribute('released', time.strftime('%Y-%m-%d', time.localtime(pkg_metadata.buildtime)))
 510 else:
 511         impl.setAttribute('released', time.strftime('%Y-%m-%d'))
 512
 513 archive = add_node(impl, 'archive', before = '\n      ', after = '\n    ')
 514 archive.setAttribute('href', archive_url)
 515 archive.setAttribute('size', str(os.path.getsize(archive_file)))
 516 if options.archive_extract:
 517         archive.setAttribute('extract', options.archive_extract)
 518
 519 # Add our new version to the main feed...
 520
 521 output_stream = tempfile.NamedTemporaryFile(prefix = 'pkg2zero-')
 522 try:
 523         output_stream.write("<?xml version='1.0'?>\n")
 524         root.writexml(output_stream)
 525         output_stream.write('\n')
 526         output_stream.flush()
 527
 528         publishing_options = []
 529         if options.key:
 530                 # Note: 0publish < 0.16 requires the --xmlsign option too
 531                 publishing_options += ['--xmlsign', '--key', options.key]
 532         check_call([os.environ['PUBLISH_COMMAND']] + publishing_options + ['--local', output_stream.name, target_feed_file])
 533         print "Added version %s to %s" % (pkg_metadata.version, target_feed_file)
 534 finally:
 535         output_stream.close()