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 separated 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                     ('Changelogs',  'changelog_url'),
 144                   )
 145
 146         # A "Sub" Release file has slightly different fields
 147         subattribs = ( ('Archive',  'suite_name'),
 148                        ('Origin',   'origin'),
 149                        ('Label',    'label'),
 150                        ('Version',  'version') )
 151
 152         # Boolean stuff. If we find it true in database, write out "yes" into the release file
 153         boolattrs = ( ('NotAutomatic',         'notautomatic'),
 154                       ('ButAutomaticUpgrades', 'butautomaticupgrades') )
 155
 156         cnf = Config()
 157
 158         suite_suffix = cnf.find("Dinstall::SuiteSuffix", "")
 159
 160         outfile = os.path.join(suite.archive.path, 'dists', suite.suite_name, suite_suffix, "Release")
 161         out = open(outfile + ".new", "w")
 162
 163         for key, dbfield in attribs:
 164             # Hack to skip NULL Version fields as we used to do this
 165             # We should probably just always ignore anything which is None
 166             if key in ("Version", "Changelogs") and getattr(suite, dbfield) is None:
 167                 continue
 168
 169             out.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 170
 171         out.write("Date: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()))))
 172
 173         if suite.validtime:
 174             validtime=float(suite.validtime)
 175             out.write("Valid-Until: %s\n" % (time.strftime("%a, %d %b %Y %H:%M:%S UTC", time.gmtime(time.time()+validtime))))
 176
 177         for key, dbfield in boolattrs:
 178             if getattr(suite, dbfield, False):
 179                 out.write("%s: yes\n" % (key))
 180
 181         out.write("Architectures: %s\n" % (" ".join([a.arch_string for a in architectures])))
 182
 183         components = [ c.component_name for c in suite.components ]
 184
 185         out.write("Components: %s\n" % (" ".join(components)))
 186
 187         # For exact compatibility with old g-r, write out Description here instead
 188         # of with the rest of the DB fields above
 189         if getattr(suite, 'description') is not None:
 190             out.write("Description: %s\n" % suite.description)
 191
 192         for comp in components:
 193             for dirpath, dirnames, filenames in os.walk(os.path.join(suite.archive.path, "dists", suite.suite_name, suite_suffix, comp), topdown=True):
 194                 if not re_gensubrelease.match(dirpath):
 195                     continue
 196
 197                 subfile = os.path.join(dirpath, "Release")
 198                 subrel = open(subfile + '.new', "w")
 199
 200                 for key, dbfield in subattribs:
 201                     if getattr(suite, dbfield) is not None:
 202                         subrel.write("%s: %s\n" % (key, getattr(suite, dbfield)))
 203
 204                 for key, dbfield in boolattrs:
 205                     if getattr(suite, dbfield, False):
 206                         subrel.write("%s: yes\n" % (key))
 207
 208                 subrel.write("Component: %s%s\n" % (suite_suffix, comp))
 209
 210                 # Urgh, but until we have all the suite/component/arch stuff in the DB,
 211                 # this'll have to do
 212                 arch = os.path.split(dirpath)[-1]
 213                 if arch.startswith('binary-'):
 214                     arch = arch[7:]
 215
 216                 subrel.write("Architecture: %s\n" % (arch))
 217                 subrel.close()
 218
 219                 os.rename(subfile + '.new', subfile)
 220
 221         # Now that we have done the groundwork, we want to get off and add the files with
 222         # their checksums to the main Release file
 223         oldcwd = os.getcwd()
 224
 225         os.chdir(os.path.join(suite.archive.path, "dists", suite.suite_name, suite_suffix))
 226
 227         hashfuncs = dict(zip([x.upper().replace('UM', 'um') for x in suite.checksums],
 228                              [getattr(apt_pkg, "%s" % (x)) for x in [x.replace("sum", "") + "sum" for x in suite.checksums]]))
 229
 230         fileinfo = {}
 231
 232         uncompnotseen = {}
 233
 234         for dirpath, dirnames, filenames in os.walk(".", followlinks=True, topdown=True):
 235             for entry in filenames:
 236                 # Skip things we don't want to include
 237                 if not re_includeinrelease.match(entry):
 238                     continue
 239
 240                 if dirpath == '.' and entry in ["Release", "Release.gpg", "InRelease"]:
 241                     continue
 242
 243                 filename = os.path.join(dirpath.lstrip('./'), entry)
 244                 fileinfo[filename] = {}
 245                 contents = open(filename, 'r').read()
 246
 247                 # If we find a file for which we have a compressed version and
 248                 # haven't yet seen the uncompressed one, store the possibility
 249                 # for future use
 250                 if entry.endswith(".gz") and filename[:-3] not in uncompnotseen:
 251                     uncompnotseen[filename[:-3]] = (gzip.GzipFile, filename)
 252                 elif entry.endswith(".bz2") and filename[:-4] not in uncompnotseen:
 253                     uncompnotseen[filename[:-4]] = (bz2.BZ2File, filename)
 254                 elif entry.endswith(".xz") and filename[:-3] not in uncompnotseen:
 255                     uncompnotseen[filename[:-3]] = (XzFile, filename)
 256
 257                 fileinfo[filename]['len'] = len(contents)
 258
 259                 for hf, func in hashfuncs.items():
 260                     fileinfo[filename][hf] = func(contents)
 261
 262         for filename, comp in uncompnotseen.items():
 263             # If we've already seen the uncompressed file, we don't
 264             # need to do anything again
 265             if filename in fileinfo:
 266                 continue
 267
 268             fileinfo[filename] = {}
 269
 270             # File handler is comp[0], filename of compressed file is comp[1]
 271             contents = comp[0](comp[1], 'r').read()
 272
 273             fileinfo[filename]['len'] = len(contents)
 274
 275             for hf, func in hashfuncs.items():
 276                 fileinfo[filename][hf] = func(contents)
 277
 278
 279         for h in sorted(hashfuncs.keys()):
 280             out.write('%s:\n' % h)
 281             for filename in sorted(fileinfo.keys()):
 282                 out.write(" %s %8d %s\n" % (fileinfo[filename][h], fileinfo[filename]['len'], filename))
 283
 284         out.close()
 285         os.rename(outfile + '.new', outfile)
 286
 287         sign_release_dir(suite, os.path.dirname(outfile))
 288
 289         os.chdir(oldcwd)
 290
 291         return
 292
 293
 294 def main ():
 295     global Logger
 296
 297     cnf = Config()
 298
 299     for i in ["Help", "Suite", "Force", "Quiet"]:
 300         if not cnf.has_key("Generate-Releases::Options::%s" % (i)):
 301             cnf["Generate-Releases::Options::%s" % (i)] = ""
 302
 303     Arguments = [('h',"help","Generate-Releases::Options::Help"),
 304                  ('a','archive','Generate-Releases::Options::Archive','HasArg'),
 305                  ('s',"suite","Generate-Releases::Options::Suite"),
 306                  ('f',"force","Generate-Releases::Options::Force"),
 307                  ('q',"quiet","Generate-Releases::Options::Quiet"),
 308                  ('o','option','','ArbItem')]
 309
 310     suite_names = apt_pkg.parse_commandline(cnf.Cnf, Arguments, sys.argv)
 311     Options = cnf.subtree("Generate-Releases::Options")
 312
 313     if Options["Help"]:
 314         usage()
 315
 316     Logger = daklog.Logger('generate-releases')
 317     pool = DakProcessPool()
 318
 319     session = DBConn().session()
 320
 321     if Options["Suite"]:
 322         suites = []
 323         for s in suite_names:
 324             suite = get_suite(s.lower(), session)
 325             if suite:
 326                 suites.append(suite)
 327             else:
 328                 print "cannot find suite %s" % s
 329                 Logger.log(['cannot find suite %s' % s])
 330     else:
 331         query = session.query(Suite).filter(Suite.untouchable == False)
 332         if 'Archive' in Options:
 333             query = query.join(Suite.archive).filter(Archive.archive_name==Options['Archive'])
 334         suites = query.all()
 335
 336     broken=[]
 337
 338     for s in suites:
 339         # Setup a multiprocessing Pool. As many workers as we have CPU cores.
 340         if s.untouchable and not Options["Force"]:
 341             print "Skipping %s (untouchable)" % s.suite_name
 342             continue
 343
 344         if not Options["Quiet"]:
 345             print "Processing %s" % s.suite_name
 346         Logger.log(['Processing release file for Suite: %s' % (s.suite_name)])
 347         pool.apply_async(generate_helper, (s.suite_id, ))
 348
 349     # No more work will be added to our pool, close it and then wait for all to finish
 350     pool.close()
 351     pool.join()
 352
 353     retcode = pool.overall_status()
 354
 355     if retcode > 0:
 356         # TODO: CENTRAL FUNCTION FOR THIS / IMPROVE LOGGING
 357         Logger.log(['Release file generation broken: %s' % (','.join([str(x[1]) for x in pool.results]))])
 358
 359     Logger.close()
 360
 361     sys.exit(retcode)
 362
 363 def generate_helper(suite_id):
 364     '''
 365     This function is called in a new subprocess.
 366     '''
 367     session = DBConn().session()
 368     suite = Suite.get(suite_id, session)
 369
 370     # We allow the process handler to catch and deal with any exceptions
 371     rw = ReleaseWriter(suite)
 372     rw.generate_release_files()
 373
 374     return (PROC_STATUS_SUCCESS, 'Release file written for %s' % suite.suite_name)
 375
 376 #######################################################################################
 377
 378 if __name__ == '__main__':
 379     main()