dak/generate_releases.py

   1 #!/usr/bin/env python
   2
   3 """
   4 Create all the Release files
   5
   6 @contact: Debian FTPMaster <ftpmaster@debian.org>
   7 @copyright: 2011  Joerg Jaspert <joerg@debian.org>
   8 @copyright: 2011  Mark Hymers <mhy@debian.org>
   9 @license: GNU General Public License version 2 or later
  10
  11 """
  12
  13 # This program is free software; you can redistribute it and/or modify
  14 # it under the terms of the GNU General Public License as published by
  15 # the Free Software Foundation; either version 2 of the License, or
  16 # (at your option) any later version.
  17
  18 # This program is distributed in the hope that it will be useful,
  19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 # GNU General Public License for more details.
  22
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26
  27 ################################################################################
  28
  29 # <mhy> I wish they wouldnt leave biscuits out, thats just tempting. Damnit.
  30
  31 ################################################################################
  32
  33 import sys
  34 import os
  35 import os.path
  36 import stat
  37 import time
  38 import gzip
  39 import bz2
  40 import apt_pkg
  41 import subprocess
  42 from tempfile import mkstemp, mkdtemp
  43 import commands
  44 from sqlalchemy.orm import object_session
  45
  46 from daklib import utils, daklog
  47 from daklib.regexes import re_gensubrelease, re_includeinrelease
  48 from daklib.dak_exceptions import *
  49 from daklib.dbconn import *
  50 from daklib.config import Config
  51 from daklib.dakmultiprocessing import DakProcessPool, PROC_STATUS_SUCCESS
  52 import daklib.daksubprocess
  53
  54 ################################################################################
  55 Logger = None                  #: Our logging object
  56
  57 ################################################################################
  58
  59 def usage (exit_code=0):
  60     """ Usage information"""
  61
  62     print """Usage: dak generate-releases [OPTIONS]
  63 Generate the Release files
  64
  65   -a, --archive=ARCHIVE      process suites in ARCHIVE
  66   -s, --suite=SUITE(s)       process this suite
  67                              Default: All suites not marked 'untouchable'
  68   -f, --force                Allow processing of untouchable suites
  69                              CAREFUL: Only to be used at (point) release time!
  70   -h, --help                 show this help and exit
  71   -q, --quiet                Don't output progress
  72
  73 SUITE can be a space seperated list, e.g.
  74    --suite=unstable testing
  75   """
  76     sys.exit(exit_code)
  77
  78 ########################################################################
  79
  80 def sign_release_dir(suite, dirname):
  81     cnf = Config()
  82
  83     if cnf.has_key("Dinstall::SigningKeyring"):
  84         keyring = "--secret-keyring \"%s\"" % cnf["Dinstall::SigningKeyring"]
  85         if cnf.has_key("Dinstall::SigningPubKeyring"):
  86             keyring += " --keyring \"%s\"" % cnf["Dinstall::SigningPubKeyring"]
  87
  88         arguments = "--no-options --batch --no-tty --armour --personal-digest-preferences=SHA256"
  89
  90         relname = os.path.join(dirname, 'Release')
  91
  92         dest = os.path.join(dirname, 'Release.gpg')
  93         if os.path.exists(dest):
  94             os.unlink(dest)
  95
  96         inlinedest = os.path.join(dirname, 'InRelease')
  97         if os.path.exists(inlinedest):
  98             os.unlink(inlinedest)
  99
 100         defkeyid=""
 101         for keyid in suite.signingkeys or []:
 102             defkeyid += "--local-user %s " % keyid
 103
 104         os.system("gpg %s %s %s --detach-sign <%s >>%s" %
 105                   (keyring, defkeyid, arguments, relname, dest))
 106         os.system("gpg %s %s %s --clearsign <%s >>%s" %
 107                   (keyring, defkeyid, arguments, relname, inlinedest))
 108
 109 class XzFile(object):
 110     def __init__(self, filename, mode='r'):
 111         self.filename = filename
 112     def read(self):
 113         cmd = ("xz", "-d")
 114         with open(self.filename, 'r') as stdin:
 115             process = daklib.daksubprocess.Popen(cmd, stdin=stdin, stdout=subprocess.PIPE)
 116             (stdout, stderr) = process.communicate()
 117             return stdout
 118
 119 class ReleaseWriter(object):
 120     def __init__(self, suite):
 121         self.suite = suite
 122
 123     def generate_release_files(self):
 124         """
 125         Generate Release files for the given suite
 126
 127         @type suite: string
 128         @param suite: Suite name
 129         """
 130
 131         suite = self.suite
 132         session = object_session(suite)
 133
 134         architectures = get_suite_architectures(suite.suite_name, skipall=True, skipsrc=True, session=session)
 135
 136         # Attribs contains a tuple of field names and the database names to use to
 137         # fill them in
 138         attribs = ( ('Origin',      'origin'),
 139                     ('Label',       'label'),
 140                     ('Suite',       'release_suite_output'),
 141                     ('Version',     'version'),
 142                     ('Codename',    'codename') )
 143
 144         # A "Sub" Release file has slightly different fields
 145         subattribs = ( ('Archive',  'suite_name'),
 146                        ('Origin',   'origin'),
 147                        ('Label',    'label'),
 148                        ('Version',  'version') )
 149
 150         # Boolean stuff. If we find it true in database, write out "yes" into the release file
 151         boolattrs = ( ('NotAutomatic',         'notautomatic'),
 152                       ('ButAutomaticUpgrades', 'butautomaticupgrades') )
 153
 154         cnf = Config()
 155
 156         suite_suffix = cnf.find("Dinstall::SuiteSuffix", "")
 157
 158         outfile = os.path.join(suite.archive.path, 'dists', suite.suite_name, suite_suffix, "Release")
 159         out = open(outfile + ".new", "w")
 160
 161         for key, dbfield in attribs:
 162             # Hack to skip NULL Version fields as we used to do this
 163             # We should probably just always ignore anything which is None
 164             if key == "Version" and getattr(suite, dbfield) is None:
 165                 continue
 166
 167             out.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 168
 169         out.write("Date: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()))))
 170
 171         if suite.validtime:
 172             validtime=float(suite.validtime)
 173             out.write("Valid-Until: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()+validtime))))
 174
 175         for key, dbfield in boolattrs:
 176             if getattr(suite, dbfield, False):
 177                 out.write("%s: yes\n" % (key))
 178
 179         out.write("Architectures: %s\n" % (" ".join([a.arch_string for a in architectures])))
 180
 181         components = [ c.component_name for c in suite.components ]
 182
 183         out.write("Components: %s\n" % (" ".join(components)))
 184
 185         # For exact compatibility with old g-r, write out Description here instead
 186         # of with the rest of the DB fields above
 187         if getattr(suite, 'description') is not None:
 188             out.write("Description: %s\n" % suite.description)
 189
 190         for comp in components:
 191             for dirpath, dirnames, filenames in os.walk(os.path.join(suite.archive.path, "dists", suite.suite_name, suite_suffix, comp), topdown=True):
 192                 if not re_gensubrelease.match(dirpath):
 193                     continue
 194
 195                 subfile = os.path.join(dirpath, "Release")
 196                 subrel = open(subfile + '.new', "w")
 197
 198                 for key, dbfield in subattribs:
 199                     if getattr(suite, dbfield) is not None:
 200                         subrel.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 201
 202                 for key, dbfield in boolattrs:
 203                     if getattr(suite, dbfield, False):
 204                         subrel.write("%s: yes\n" % (key))
 205
 206                 subrel.write("Component: %s%s\n" % (suite_suffix, comp))
 207
 208                 # Urgh, but until we have all the suite/component/arch stuff in the DB,
 209                 # this'll have to do
 210                 arch = os.path.split(dirpath)[-1]
 211                 if arch.startswith('binary-'):
 212                     arch = arch[7:]
 213
 214                 subrel.write("Architecture: %s\n" % (arch))
 215                 subrel.close()
 216
 217                 os.rename(subfile + '.new', subfile)
 218
 219         # Now that we have done the groundwork, we want to get off and add the files with
 220         # their checksums to the main Release file
 221         oldcwd = os.getcwd()
 222
 223         os.chdir(os.path.join(suite.archive.path, "dists", suite.suite_name, suite_suffix))
 224
 225         hashfuncs = { 'MD5Sum' : apt_pkg.md5sum,
 226                       'SHA1' : apt_pkg.sha1sum,
 227                       'SHA256' : apt_pkg.sha256sum }
 228
 229         fileinfo = {}
 230
 231         uncompnotseen = {}
 232
 233         for dirpath, dirnames, filenames in os.walk(".", followlinks=True, topdown=True):
 234             for entry in filenames:
 235                 # Skip things we don't want to include
 236                 if not re_includeinrelease.match(entry):
 237                     continue
 238
 239                 if dirpath == '.' and entry in ["Release", "Release.gpg", "InRelease"]:
 240                     continue
 241
 242                 filename = os.path.join(dirpath.lstrip('./'), entry)
 243                 fileinfo[filename] = {}
 244                 contents = open(filename, 'r').read()
 245
 246                 # If we find a file for which we have a compressed version and
 247                 # haven't yet seen the uncompressed one, store the possibility
 248                 # for future use
 249                 if entry.endswith(".gz") and entry[:-3] not in uncompnotseen.keys():
 250                     uncompnotseen[filename[:-3]] = (gzip.GzipFile, filename)
 251                 elif entry.endswith(".bz2") and entry[:-4] not in uncompnotseen.keys():
 252                     uncompnotseen[filename[:-4]] = (bz2.BZ2File, filename)
 253                 elif entry.endswith(".xz") and entry[:-3] not in uncompnotseen.keys():
 254                     uncompnotseen[filename[:-3]] = (XzFile, filename)
 255
 256                 fileinfo[filename]['len'] = len(contents)
 257
 258                 for hf, func in hashfuncs.items():
 259                     fileinfo[filename][hf] = func(contents)
 260
 261         for filename, comp in uncompnotseen.items():
 262             # If we've already seen the uncompressed file, we don't
 263             # need to do anything again
 264             if filename in fileinfo.keys():
 265                 continue
 266
 267             # Skip uncompressed Contents files as they're huge, take ages to
 268             # checksum and we checksum the compressed ones anyways
 269             if os.path.basename(filename).startswith("Contents"):
 270                 continue
 271
 272             fileinfo[filename] = {}
 273
 274             # File handler is comp[0], filename of compressed file is comp[1]
 275             contents = comp[0](comp[1], 'r').read()
 276
 277             fileinfo[filename]['len'] = len(contents)
 278
 279             for hf, func in hashfuncs.items():
 280                 fileinfo[filename][hf] = func(contents)
 281
 282
 283         for h in sorted(hashfuncs.keys()):
 284             out.write('%s:\n' % h)
 285             for filename in sorted(fileinfo.keys()):
 286                 out.write(" %s %8d %s\n" % (fileinfo[filename][h], fileinfo[filename]['len'], filename))
 287
 288         out.close()
 289         os.rename(outfile + '.new', outfile)
 290
 291         sign_release_dir(suite, os.path.dirname(outfile))
 292
 293         os.chdir(oldcwd)
 294
 295         return
 296
 297
 298 def main ():
 299     global Logger
 300
 301     cnf = Config()
 302
 303     for i in ["Help", "Suite", "Force", "Quiet"]:
 304         if not cnf.has_key("Generate-Releases::Options::%s" % (i)):
 305             cnf["Generate-Releases::Options::%s" % (i)] = ""
 306
 307     Arguments = [('h',"help","Generate-Releases::Options::Help"),
 308                  ('a','archive','Generate-Releases::Options::Archive','HasArg'),
 309                  ('s',"suite","Generate-Releases::Options::Suite"),
 310                  ('f',"force","Generate-Releases::Options::Force"),
 311                  ('q',"quiet","Generate-Releases::Options::Quiet"),
 312                  ('o','option','','ArbItem')]
 313
 314     suite_names = apt_pkg.parse_commandline(cnf.Cnf, Arguments, sys.argv)
 315     Options = cnf.subtree("Generate-Releases::Options")
 316
 317     if Options["Help"]:
 318         usage()
 319
 320     Logger = daklog.Logger('generate-releases')
 321     pool = DakProcessPool()
 322
 323     session = DBConn().session()
 324
 325     if Options["Suite"]:
 326         suites = []
 327         for s in suite_names:
 328             suite = get_suite(s.lower(), session)
 329             if suite:
 330                 suites.append(suite)
 331             else:
 332                 print "cannot find suite %s" % s
 333                 Logger.log(['cannot find suite %s' % s])
 334     else:
 335         query = session.query(Suite).filter(Suite.untouchable == False)
 336         if 'Archive' in Options:
 337             query = query.join(Suite.archive).filter(Archive.archive_name==Options['Archive'])
 338         suites = query.all()
 339
 340     broken=[]
 341
 342     for s in suites:
 343         # Setup a multiprocessing Pool. As many workers as we have CPU cores.
 344         if s.untouchable and not Options["Force"]:
 345             print "Skipping %s (untouchable)" % s.suite_name
 346             continue
 347
 348         if not Options["Quiet"]:
 349             print "Processing %s" % s.suite_name
 350         Logger.log(['Processing release file for Suite: %s' % (s.suite_name)])
 351         pool.apply_async(generate_helper, (s.suite_id, ))
 352
 353     # No more work will be added to our pool, close it and then wait for all to finish
 354     pool.close()
 355     pool.join()
 356
 357     retcode = pool.overall_status()
 358
 359     if retcode > 0:
 360         # TODO: CENTRAL FUNCTION FOR THIS / IMPROVE LOGGING
 361         Logger.log(['Release file generation broken: %s' % (','.join([str(x[1]) for x in pool.results]))])
 362
 363     Logger.close()
 364
 365     sys.exit(retcode)
 366
 367 def generate_helper(suite_id):
 368     '''
 369     This function is called in a new subprocess.
 370     '''
 371     session = DBConn().session()
 372     suite = Suite.get(suite_id, session)
 373
 374     # We allow the process handler to catch and deal with any exceptions
 375     rw = ReleaseWriter(suite)
 376     rw.generate_release_files()
 377
 378     return (PROC_STATUS_SUCCESS, 'Release file written for %s' % suite.suite_name)
 379
 380 #######################################################################################
 381
 382 if __name__ == '__main__':
 383     main()