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 from tempfile import mkstemp, mkdtemp
  42 import commands
  43 from sqlalchemy.orm import object_session
  44
  45 from daklib import utils, daklog
  46 from daklib.regexes import re_gensubrelease, re_includeinrelease
  47 from daklib.dak_exceptions import *
  48 from daklib.dbconn import *
  49 from daklib.config import Config
  50 from daklib.dakmultiprocessing import DakProcessPool, PROC_STATUS_SUCCESS
  51
  52 ################################################################################
  53 Logger = None                  #: Our logging object
  54
  55 ################################################################################
  56
  57 def usage (exit_code=0):
  58     """ Usage information"""
  59
  60     print """Usage: dak generate-releases [OPTIONS]
  61 Generate the Release files
  62
  63   -s, --suite=SUITE(s)       process this suite
  64                              Default: All suites not marked 'untouchable'
  65   -f, --force                Allow processing of untouchable suites
  66                              CAREFUL: Only to be used at (point) release time!
  67   -h, --help                 show this help and exit
  68
  69 SUITE can be a space seperated list, e.g.
  70    --suite=unstable testing
  71   """
  72     sys.exit(exit_code)
  73
  74 ########################################################################
  75
  76 def sign_release_dir(suite, dirname):
  77     cnf = Config()
  78
  79     if cnf.has_key("Dinstall::SigningKeyring"):
  80         keyring = "--secret-keyring \"%s\"" % cnf["Dinstall::SigningKeyring"]
  81         if cnf.has_key("Dinstall::SigningPubKeyring"):
  82             keyring += " --keyring \"%s\"" % cnf["Dinstall::SigningPubKeyring"]
  83
  84         arguments = "--no-options --batch --no-tty --armour"
  85
  86         relname = os.path.join(dirname, 'Release')
  87
  88         dest = os.path.join(dirname, 'Release.gpg')
  89         if os.path.exists(dest):
  90             os.unlink(dest)
  91
  92         inlinedest = os.path.join(dirname, 'InRelease')
  93         if os.path.exists(inlinedest):
  94             os.unlink(inlinedest)
  95
  96         # We can only use one key for inline signing so use the first one in
  97         # the array for consistency
  98         firstkey = True
  99
 100         for keyid in suite.signingkeys:
 101             defkeyid = "--default-key %s" % keyid
 102
 103             os.system("gpg %s %s %s --detach-sign <%s >>%s" %
 104                     (keyring, defkeyid, arguments, relname, dest))
 105
 106             if firstkey:
 107                 os.system("gpg %s %s %s --clearsign <%s >>%s" %
 108                         (keyring, defkeyid, arguments, relname, inlinedest))
 109                 firstkey = False
 110
 111 class ReleaseWriter(object):
 112     def __init__(self, suite):
 113         self.suite = suite
 114
 115     def generate_release_files(self):
 116         """
 117         Generate Release files for the given suite
 118
 119         @type suite: string
 120         @param suite: Suite name
 121         """
 122
 123         suite = self.suite
 124         session = object_session(suite)
 125
 126         architectures = get_suite_architectures(suite.suite_name, skipall=True, skipsrc=True, session=session)
 127
 128         # Attribs contains a tuple of field names and the database names to use to
 129         # fill them in
 130         attribs = ( ('Origin',      'origin'),
 131                     ('Label',       'label'),
 132                     ('Suite',       'suite_name'),
 133                     ('Version',     'version'),
 134                     ('Codename',    'codename') )
 135
 136         # A "Sub" Release file has slightly different fields
 137         subattribs = ( ('Archive',  'suite_name'),
 138                        ('Origin',   'origin'),
 139                        ('Label',    'label'),
 140                        ('Version',  'version') )
 141
 142         # Boolean stuff. If we find it true in database, write out "yes" into the release file
 143         boolattrs = ( ('NotAutomatic',         'notautomatic'),
 144                       ('ButAutomaticUpgrades', 'butautomaticupgrades') )
 145
 146         cnf = Config()
 147
 148         suite_suffix = "%s" % (cnf.Find("Dinstall::SuiteSuffix"))
 149
 150         outfile = os.path.join(cnf["Dir::Root"], 'dists', "%s/%s" % (suite.suite_name, suite_suffix), "Release")
 151         out = open(outfile + ".new", "w")
 152
 153         for key, dbfield in attribs:
 154             if getattr(suite, dbfield) is not None:
 155                 out.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 156
 157         out.write("Date: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()))))
 158
 159         if suite.validtime:
 160             validtime=float(suite.validtime)
 161             out.write("Valid-Until: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()+validtime))))
 162
 163         for key, dbfield in boolattrs:
 164             if getattr(suite, dbfield, False):
 165                 out.write("%s: yes\n" % (key))
 166
 167         out.write("Architectures: %s\n" % (" ".join([a.arch_string for a in architectures])))
 168
 169         ## FIXME: Components need to be adjusted to whatever will be in the db
 170         ## Needs putting in the DB
 171         components = ['main', 'contrib', 'non-free']
 172
 173         out.write("Components: %s\n" % ( " ".join(map(lambda x: "%s%s" % (suite_suffix, x), components ))))
 174
 175         # For exact compatibility with old g-r, write out Description here instead
 176         # of with the rest of the DB fields above
 177         if getattr(suite, 'description') is not None:
 178             out.write("Description: %s\n" % suite.description)
 179
 180         for comp in components:
 181             for dirpath, dirnames, filenames in os.walk("%sdists/%s/%s%s" % (cnf["Dir::Root"], suite.suite_name, suite_suffix, comp), topdown=True):
 182                 if not re_gensubrelease.match(dirpath):
 183                     continue
 184
 185                 subfile = os.path.join(dirpath, "Release")
 186                 subrel = open(subfile + '.new', "w")
 187
 188                 for key, dbfield in subattribs:
 189                     if getattr(suite, dbfield) is not None:
 190                         subrel.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 191
 192                 for key, dbfield in boolattrs:
 193                     if getattr(suite, dbfield, False):
 194                         subrel.write("%s: yes\n" % (key))
 195
 196                 subrel.write("Component: %s%s\n" % (suite_suffix, comp))
 197
 198                 # Urgh, but until we have all the suite/component/arch stuff in the DB,
 199                 # this'll have to do
 200                 arch = os.path.split(dirpath)[-1]
 201                 if arch.startswith('binary-'):
 202                     arch = arch[7:]
 203
 204                 subrel.write("Architecture: %s\n" % (arch))
 205                 subrel.close()
 206
 207                 os.rename(subfile + '.new', subfile)
 208
 209         # Now that we have done the groundwork, we want to get off and add the files with
 210         # their checksums to the main Release file
 211         oldcwd = os.getcwd()
 212
 213         os.chdir("%sdists/%s/%s" % (cnf["Dir::Root"], suite.suite_name, suite_suffix))
 214
 215         hashfuncs = { 'MD5Sum' : apt_pkg.md5sum,
 216                       'SHA1' : apt_pkg.sha1sum,
 217                       'SHA256' : apt_pkg.sha256sum }
 218
 219         fileinfo = {}
 220
 221         uncompnotseen = {}
 222
 223         for dirpath, dirnames, filenames in os.walk(".", followlinks=True, topdown=True):
 224             for entry in filenames:
 225                 # Skip things we don't want to include
 226                 if not re_includeinrelease.match(entry):
 227                     continue
 228
 229                 if dirpath == '.' and entry in ["Release", "Release.gpg", "InRelease"]:
 230                     continue
 231
 232                 filename = os.path.join(dirpath.lstrip('./'), entry)
 233                 fileinfo[filename] = {}
 234                 contents = open(filename, 'r').read()
 235
 236                 # If we find a file for which we have a compressed version and
 237                 # haven't yet seen the uncompressed one, store the possibility
 238                 # for future use
 239                 if entry.endswith(".gz") and entry[:-3] not in uncompnotseen.keys():
 240                     uncompnotseen[filename[:-3]] = (gzip.GzipFile, filename)
 241                 elif entry.endswith(".bz2") and entry[:-4] not in uncompnotseen.keys():
 242                     uncompnotseen[filename[:-4]] = (bz2.BZ2File, filename)
 243
 244                 fileinfo[filename]['len'] = len(contents)
 245
 246                 for hf, func in hashfuncs.items():
 247                     fileinfo[filename][hf] = func(contents)
 248
 249         for filename, comp in uncompnotseen.items():
 250             # If we've already seen the uncompressed file, we don't
 251             # need to do anything again
 252             if filename in fileinfo.keys():
 253                 continue
 254
 255             # Skip uncompressed Contents files as they're huge, take ages to
 256             # checksum and we checksum the compressed ones anyways
 257             if os.path.basename(filename).startswith("Contents"):
 258                 continue
 259
 260             fileinfo[filename] = {}
 261
 262             # File handler is comp[0], filename of compressed file is comp[1]
 263             contents = comp[0](comp[1], 'r').read()
 264
 265             fileinfo[filename]['len'] = len(contents)
 266
 267             for hf, func in hashfuncs.items():
 268                 fileinfo[filename][hf] = func(contents)
 269
 270
 271         for h in sorted(hashfuncs.keys()):
 272             out.write('%s:\n' % h)
 273             for filename in sorted(fileinfo.keys()):
 274                 out.write(" %s %8d %s\n" % (fileinfo[filename][h], fileinfo[filename]['len'], filename))
 275
 276         out.close()
 277         os.rename(outfile + '.new', outfile)
 278
 279         sign_release_dir(suite, os.path.dirname(outfile))
 280
 281         os.chdir(oldcwd)
 282
 283         return
 284
 285
 286 def main ():
 287     global Logger
 288
 289     cnf = Config()
 290
 291     for i in ["Help", "Suite", "Force"]:
 292         if not cnf.has_key("Generate-Releases::Options::%s" % (i)):
 293             cnf["Generate-Releases::Options::%s" % (i)] = ""
 294
 295     Arguments = [('h',"help","Generate-Releases::Options::Help"),
 296                  ('s',"suite","Generate-Releases::Options::Suite"),
 297                  ('f',"force","Generate-Releases::Options::Force")]
 298
 299     suite_names = apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
 300     Options = cnf.SubTree("Generate-Releases::Options")
 301
 302     if Options["Help"]:
 303         usage()
 304
 305     Logger = daklog.Logger(cnf, 'generate-releases')
 306
 307     session = DBConn().session()
 308
 309     if Options["Suite"]:
 310         suites = []
 311         for s in suite_names:
 312             suite = get_suite(s.lower(), session)
 313             if suite:
 314                 suites.append(suite)
 315             else:
 316                 print "cannot find suite %s" % s
 317                 Logger.log(['cannot find suite %s' % s])
 318     else:
 319         suites = session.query(Suite).filter(Suite.untouchable == False).all()
 320
 321     broken=[]
 322
 323     pool = DakProcessPool()
 324
 325     for s in suites:
 326         # Setup a multiprocessing Pool. As many workers as we have CPU cores.
 327         if s.untouchable and not Options["Force"]:
 328             print "Skipping %s (untouchable)" % s.suite_name
 329             continue
 330
 331         print "Processing %s" % s.suite_name
 332         Logger.log(['Processing release file for Suite: %s' % (s.suite_name)])
 333         pool.apply_async(generate_helper, (s.suite_id, ), callback=get_result)
 334
 335     # No more work will be added to our pool, close it and then wait for all to finish
 336     pool.close()
 337     pool.join()
 338
 339     retcode = p.overall_status()
 340
 341     if retcode > 0:
 342         Logger.log(['Release file generation broken: %s' % (p.results)])
 343
 344     Logger.close()
 345
 346     sys.exit(retcode)
 347
 348 def generate_helper(suite_id):
 349     '''
 350     This function is called in a new subprocess.
 351     '''
 352     session = DBConn().session()
 353     suite = Suite.get(suite_id, session)
 354
 355     # We allow the process handler to catch and deal with any exceptions
 356     rw = ReleaseWriter(suite)
 357     rw.generate_release_files()
 358
 359     return (PROC_STATUS_SUCCESS, 'Release file written for %s' % suite.suite_name)
 360
 361 #######################################################################################
 362
 363 if __name__ == '__main__':
 364     main()