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