daklib/changes.py

   1 #!/usr/bin/env python
   2 # vim:set et sw=4:
   3
   4 """
   5 Changes class for dak
   6
   7 @contact: Debian FTP Master <ftpmaster@debian.org>
   8 @copyright: 2001 - 2006 James Troup <james@nocrew.org>
   9 @copyright: 2009  Joerg Jaspert <joerg@debian.org>
  10 @copyright: 2009  Mark Hymers <mhy@debian.org>
  11 @license: GNU General Public License version 2 or later
  12 """
  13
  14 # This program is free software; you can redistribute it and/or modify
  15 # it under the terms of the GNU General Public License as published by
  16 # the Free Software Foundation; either version 2 of the License, or
  17 # (at your option) any later version.
  18
  19 # This program is distributed in the hope that it will be useful,
  20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 # GNU General Public License for more details.
  23
  24 # You should have received a copy of the GNU General Public License
  25 # along with this program; if not, write to the Free Software
  26 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  27
  28 ###############################################################################
  29
  30 import os
  31 import stat
  32 import time
  33
  34 import datetime
  35 from cPickle import Unpickler, Pickler
  36 from errno import EPERM
  37
  38 from apt_inst import debExtractControl
  39 from apt_pkg import ParseSection
  40
  41 from utils import open_file, fubar, poolify
  42 from config import *
  43 from dbconn import *
  44
  45 ###############################################################################
  46
  47 __all__ = []
  48
  49 ###############################################################################
  50
  51 CHANGESFIELDS_MANDATORY = [ "distribution", "source", "architecture",
  52         "version", "maintainer", "urgency", "fingerprint", "changedby822",
  53         "changedby2047", "changedbyname", "maintainer822", "maintainer2047",
  54         "maintainername", "maintaineremail", "closes", "changes" ]
  55
  56 __all__.append('CHANGESFIELDS_MANDATORY')
  57
  58 CHANGESFIELDS_OPTIONAL = [ "changed-by", "filecontents", "format",
  59         "process-new note", "adv id", "distribution-version", "sponsoremail" ]
  60
  61 __all__.append('CHANGESFIELDS_OPTIONAL')
  62
  63 CHANGESFIELDS_FILES = [ "package", "version", "architecture", "type", "size",
  64         "md5sum", "sha1sum", "sha256sum", "component", "location id",
  65         "source package", "source version", "maintainer", "dbtype", "files id",
  66         "new", "section", "priority", "othercomponents", "pool name",
  67         "original component" ]
  68
  69 __all__.append('CHANGESFIELDS_FILES')
  70
  71 CHANGESFIELDS_DSC = [ "source", "version", "maintainer", "fingerprint",
  72         "uploaders", "bts changelog", "dm-upload-allowed" ]
  73
  74 __all__.append('CHANGESFIELDS_DSC')
  75
  76 CHANGESFIELDS_DSCFILES_MANDATORY = [ "size", "md5sum" ]
  77
  78 __all__.append('CHANGESFIELDS_DSCFILES_MANDATORY')
  79
  80 CHANGESFIELDS_DSCFILES_OPTIONAL = [ "files id" ]
  81
  82 __all__.append('CHANGESFIELDS_DSCFILES_OPTIONAL')
  83
  84 CHANGESFIELDS_ORIGFILES = [ "id", "location" ]
  85
  86 __all__.append('CHANGESFIELDS_ORIGFILES')
  87
  88 ###############################################################################
  89
  90 class Changes(object):
  91     """ Convenience wrapper to carry around all the package information """
  92
  93     def __init__(self, **kwds):
  94         self.reset()
  95
  96     def reset(self):
  97         self.changes_file = ""
  98
  99         self.changes = {}
 100         self.dsc = {}
 101         self.files = {}
 102         self.dsc_files = {}
 103         self.orig_files = {}
 104
 105     def file_summary(self):
 106         # changes["distribution"] may not exist in corner cases
 107         # (e.g. unreadable changes files)
 108         if not self.changes.has_key("distribution") or not \
 109                isinstance(self.changes["distribution"], dict):
 110             self.changes["distribution"] = {}
 111
 112         byhand = False
 113         new = False
 114         summary = ""
 115         override_summary = ""
 116
 117         for name, entry in sorted(self.files.items()):
 118             if entry.has_key("byhand"):
 119                 byhand = True
 120                 summary += name + " byhand\n"
 121
 122             elif entry.has_key("new"):
 123                 new = True
 124                 summary += "(new) %s %s %s\n" % (name, entry["priority"], entry["section"])
 125
 126                 if entry.has_key("othercomponents"):
 127                     summary += "WARNING: Already present in %s distribution.\n" % (entry["othercomponents"])
 128
 129                 if entry["type"] == "deb":
 130                     deb_fh = open_file(name)
 131                     summary += ParseSection(debExtractControl(deb_fh))["Description"] + '\n'
 132                     deb_fh.close()
 133
 134             else:
 135                 entry["pool name"] = poolify(self.changes.get("source", ""), entry["component"])
 136                 destination = entry["pool name"] + name
 137                 summary += name + "\n  to " + destination + "\n"
 138
 139                 if not entry.has_key("type"):
 140                     entry["type"] = "unknown"
 141
 142                 if entry["type"] in ["deb", "udeb", "dsc"]:
 143                     # (queue/unchecked), there we have override entries already, use them
 144                     # (process-new), there we dont have override entries, use the newly generated ones.
 145                     override_prio = entry.get("override priority", entry["priority"])
 146                     override_sect = entry.get("override section", entry["section"])
 147                     override_summary += "%s - %s %s\n" % (name, override_prio, override_sect)
 148
 149         return (byhand, new, summary, override_summary)
 150
 151     def check_override(self):
 152         """
 153         Checks override entries for validity.
 154
 155         Returns an empty string if there are no problems
 156         or the text of a warning if there are
 157         """
 158
 159         summary = ""
 160
 161         # Abandon the check if it's a non-sourceful upload
 162         if not self.changes["architecture"].has_key("source"):
 163             return summary
 164
 165         for name, entry in sorted(self.files.items()):
 166             if not entry.has_key("new") and entry["type"] == "deb":
 167                 if entry["section"] != "-":
 168                     if entry["section"].lower() != entry["override section"].lower():
 169                         summary += "%s: package says section is %s, override says %s.\n" % (name,
 170                                                                                             entry["section"],
 171                                                                                             entry["override section"])
 172
 173                 if entry["priority"] != "-":
 174                     if entry["priority"] != entry["override priority"]:
 175                         summary += "%s: package says priority is %s, override says %s.\n" % (name,
 176                                                                                              entry["priority"],
 177                                                                                              entry["override priority"])
 178
 179         return summary
 180
 181     def remove_known_changes(self, session=None):
 182         if session is None:
 183             session = DBConn().session()
 184             privatetrans = True
 185
 186         session.delete(get_knownchange(self.changes_file, session))
 187
 188         if privatetrans:
 189             session.commit()
 190             session.close()
 191
 192     def add_known_changes(self, queue, session=None):
 193         cnf = Config()
 194
 195         if session is None:
 196             session = DBConn().session()
 197             privatetrans = True
 198
 199         dirpath = cnf["Dir::Queue::%s" % (queue) ]
 200         changesfile = os.path.join(dirpath, self.changes_file)
 201         filetime = datetime.datetime.fromtimestamp(os.path.getctime(changesfile))
 202
 203         session.execute(
 204             """INSERT INTO known_changes
 205               (changesname, seen, source, binaries, architecture, version,
 206               distribution, urgency, maintainer, fingerprint, changedby, date)
 207               VALUES (:changesfile,:filetime,:source,:binary, :architecture,
 208               :version,:distribution,:urgency,:maintainer,:fingerprint,:changedby,:date)""",
 209               { 'changesfile':changesfile,
 210                 'filetime':filetime,
 211                 'source':self.changes["source"],
 212                 'binary':self.changes["binary"],
 213                 'architecture':self.changes["architecture"],
 214                 'version':self.changes["version"],
 215                 'distribution':self.changes["distribution"],
 216                 'urgency':self.changes["urgency"],
 217                 'maintainer':self.changes["maintainer"],
 218                 'fingerprint':self.changes["fingerprint"],
 219                 'changedby':self.changes["changed-by"],
 220                 'date':self.changes["date"]} )
 221
 222         if privatetrans:
 223             session.commit()
 224             session.close()
 225
 226     def load_dot_dak(self, changesfile):
 227         """
 228         Update ourself by reading a previously created cPickle .dak dumpfile.
 229         """
 230
 231         self.changes_file = changesfile
 232         dump_filename = self.changes_file[:-8]+".dak"
 233         dump_file = open_file(dump_filename)
 234
 235         p = Unpickler(dump_file)
 236
 237         self.changes.update(p.load())
 238         self.dsc.update(p.load())
 239         self.files.update(p.load())
 240         self.dsc_files.update(p.load())
 241
 242         next_obj = p.load()
 243         if isinstance(next_obj, dict):
 244             self.orig_files.update(next_obj)
 245         else:
 246             # Auto-convert old dak files to new format supporting
 247             # multiple tarballs
 248             orig_tar_gz = None
 249             for dsc_file in self.dsc_files.keys():
 250                 if dsc_file.endswith(".orig.tar.gz"):
 251                     orig_tar_gz = dsc_file
 252             self.orig_files[orig_tar_gz] = {}
 253             if next_obj != None:
 254                 self.orig_files[orig_tar_gz]["id"] = next_obj
 255             next_obj = p.load()
 256             if next_obj != None and next_obj != "":
 257                 self.orig_files[orig_tar_gz]["location"] = next_obj
 258             if len(self.orig_files[orig_tar_gz]) == 0:
 259                 del self.orig_files[orig_tar_gz]
 260
 261         dump_file.close()
 262
 263     def sanitised_files(self):
 264         ret = {}
 265         for name, entry in self.files.items():
 266             ret[name] = {}
 267             for i in CHANGESFIELDS_FILES:
 268                 if entry.has_key(i):
 269                     ret[name][i] = entry[i]
 270
 271         return ret
 272
 273     def sanitised_changes(self):
 274         ret = {}
 275         # Mandatory changes fields
 276         for i in CHANGESFIELDS_MANDATORY:
 277             ret[i] = self.changes[i]
 278
 279         # Optional changes fields
 280         for i in CHANGESFIELDS_OPTIONAL:
 281             if self.changes.has_key(i):
 282                 ret[i] = self.changes[i]
 283
 284         return ret
 285
 286     def sanitised_dsc(self):
 287         ret = {}
 288         for i in CHANGESFIELDS_DSC:
 289             if self.dsc.has_key(i):
 290                 ret[i] = self.dsc[i]
 291
 292         return ret
 293
 294     def sanitised_dsc_files(self):
 295         ret = {}
 296         for name, entry in self.dsc_files.items():
 297             ret[name] = {}
 298             # Mandatory dsc_files fields
 299             for i in CHANGESFIELDS_DSCFILES_MANDATORY:
 300                 ret[name][i] = entry[i]
 301
 302             # Optional dsc_files fields
 303             for i in CHANGESFIELDS_DSCFILES_OPTIONAL:
 304                 if entry.has_key(i):
 305                     ret[name][i] = entry[i]
 306
 307         return ret
 308
 309     def sanitised_orig_files(self):
 310         ret = {}
 311         for name, entry in self.orig_files.items():
 312             ret[name] = {}
 313             # Optional orig_files fields
 314             for i in CHANGESFIELDS_ORIGFILES:
 315                 if entry.has_key(i):
 316                     ret[name][i] = entry[i]
 317
 318         return ret
 319
 320     def write_dot_dak(self, dest_dir):
 321         """
 322         Dump ourself into a cPickle file.
 323
 324         @type dest_dir: string
 325         @param dest_dir: Path where the dumpfile should be stored
 326
 327         @note: This could just dump the dictionaries as is, but I'd like to avoid this so
 328                there's some idea of what process-accepted & process-new use from
 329                process-unchecked. (JT)
 330
 331         """
 332
 333         dump_filename = os.path.join(dest_dir, self.changes_file[:-8] + ".dak")
 334         dump_file = open_file(dump_filename, 'w')
 335
 336         try:
 337             os.chmod(dump_filename, 0664)
 338         except OSError, e:
 339             # chmod may fail when the dumpfile is not owned by the user
 340             # invoking dak (like e.g. when NEW is processed by a member
 341             # of ftpteam)
 342             if e.errno == EPERM:
 343                 perms = stat.S_IMODE(os.stat(dump_filename)[stat.ST_MODE])
 344                 # security precaution, should never happen unless a weird
 345                 # umask is set anywhere
 346                 if perms & stat.S_IWOTH:
 347                     fubar("%s is world writable and chmod failed." % \
 348                         (dump_filename,))
 349                 # ignore the failed chmod otherwise as the file should
 350                 # already have the right privileges and is just, at worst,
 351                 # unreadable for world
 352             else:
 353                 raise
 354
 355         p = Pickler(dump_file, 1)
 356
 357         p.dump(self.sanitised_changes())
 358         p.dump(self.sanitised_dsc())
 359         p.dump(self.sanitised_files())
 360         p.dump(self.sanitised_dsc_files())
 361         p.dump(self.sanitised_orig_files())
 362
 363         dump_file.close()
 364
 365     def unknown_files_fields(self, name):
 366         return sorted(list( set(self.files[name].keys()) -
 367                             set(CHANGESFIELDS_FILES)))
 368
 369     def unknown_changes_fields(self):
 370         return sorted(list( set(self.changes.keys()) -
 371                             set(CHANGESFIELDS_MANDATORY + CHANGESFIELDS_OPTIONAL)))
 372
 373     def unknown_dsc_fields(self):
 374         return sorted(list( set(self.dsc.keys()) -
 375                             set(CHANGESFIELDS_DSC)))
 376
 377     def unknown_dsc_files_fields(self, name):
 378         return sorted(list( set(self.dsc_files[name].keys()) -
 379                             set(CHANGESFIELDS_DSCFILES_MANDATORY + CHANGESFIELDS_DSCFILES_OPTIONAL)))
 380
 381     def str_files(self):
 382         r = []
 383         for name, entry in self.files.items():
 384             r.append("  %s:" % (name))
 385             for i in CHANGESFIELDS_FILES:
 386                 if entry.has_key(i):
 387                     r.append("   %s: %s" % (i.capitalize(), entry[i]))
 388             xfields = self.unknown_files_fields(name)
 389             if len(xfields) > 0:
 390                 r.append("files[%s] still has following unrecognised keys: %s" % (name, ", ".join(xfields)))
 391
 392         return r
 393
 394     def str_changes(self):
 395         r = []
 396         for i in CHANGESFIELDS_MANDATORY:
 397             val = self.changes[i]
 398             if isinstance(val, list):
 399                 val = " ".join(val)
 400             elif isinstance(val, dict):
 401                 val = " ".join(val.keys())
 402             r.append('  %s: %s' % (i.capitalize(), val))
 403
 404         for i in CHANGESFIELDS_OPTIONAL:
 405             if self.changes.has_key(i):
 406                 r.append('  %s: %s' % (i.capitalize(), self.changes[i]))
 407
 408         xfields = self.unknown_changes_fields()
 409         if len(xfields) > 0:
 410             r.append("Warning: changes still has the following unrecognised fields: %s" % ", ".join(xfields))
 411
 412         return r
 413
 414     def str_dsc(self):
 415         r = []
 416         for i in CHANGESFIELDS_DSC:
 417             if self.dsc.has_key(i):
 418                 r.append('  %s: %s' % (i.capitalize(), self.dsc[i]))
 419
 420         xfields = self.unknown_dsc_fields()
 421         if len(xfields) > 0:
 422             r.append("Warning: dsc still has the following unrecognised fields: %s" % ", ".join(xfields))
 423
 424         return r
 425
 426     def str_dsc_files(self):
 427         r = []
 428         for name, entry in self.dsc_files.items():
 429             r.append("  %s:" % (name))
 430             for i in CHANGESFIELDS_DSCFILES_MANDATORY:
 431                 r.append("   %s: %s" % (i.capitalize(), entry[i]))
 432             for i in CHANGESFIELDS_DSCFILES_OPTIONAL:
 433                 if entry.has_key(i):
 434                     r.append("   %s: %s" % (i.capitalize(), entry[i]))
 435             xfields = self.unknown_dsc_files_fields(name)
 436             if len(xfields) > 0:
 437                 r.append("dsc_files[%s] still has following unrecognised keys: %s" % (name, ", ".join(xfields)))
 438
 439         return r
 440
 441     def __str__(self):
 442         r = []
 443
 444         r.append(" Changes:")
 445         r += self.str_changes()
 446
 447         r.append("")
 448
 449         r.append(" Dsc:")
 450         r += self.str_dsc()
 451
 452         r.append("")
 453
 454         r.append(" Files:")
 455         r += self.str_files()
 456
 457         r.append("")
 458
 459         r.append(" Dsc Files:")
 460         r += self.str_dsc_files()
 461
 462         return "\n".join(r)
 463
 464 __all__.append('Changes')