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
  33 import datetime
  34 from cPickle import Unpickler, Pickler
  35 from errno import EPERM
  36
  37 from apt_inst import debExtractControl
  38 from apt_pkg import ParseSection
  39
  40 from utils import open_file, fubar, poolify
  41 from config import *
  42 from dbconn import *
  43
  44 ###############################################################################
  45
  46 __all__ = []
  47
  48 ###############################################################################
  49
  50 CHANGESFIELDS_MANDATORY = [ "distribution", "source", "architecture",
  51         "version", "maintainer", "urgency", "fingerprint", "changedby822",
  52         "changedby2047", "changedbyname", "maintainer822", "maintainer2047",
  53         "maintainername", "maintaineremail", "closes", "changes" ]
  54
  55 __all__.append('CHANGESFIELDS_MANDATORY')
  56
  57 CHANGESFIELDS_OPTIONAL = [ "changed-by", "filecontents", "format",
  58         "process-new note", "adv id", "distribution-version", "sponsoremail" ]
  59
  60 __all__.append('CHANGESFIELDS_OPTIONAL')
  61
  62 CHANGESFIELDS_FILES = [ "package", "version", "architecture", "type", "size",
  63         "md5sum", "sha1sum", "sha256sum", "component", "location id",
  64         "source package", "source version", "maintainer", "dbtype", "files id",
  65         "new", "section", "priority", "othercomponents", "pool name",
  66         "original component" ]
  67
  68 __all__.append('CHANGESFIELDS_FILES')
  69
  70 CHANGESFIELDS_DSC = [ "source", "version", "maintainer", "fingerprint",
  71         "uploaders", "bts changelog", "dm-upload-allowed" ]
  72
  73 __all__.append('CHANGESFIELDS_DSC')
  74
  75 CHANGESFIELDS_DSCFILES_MANDATORY = [ "size", "md5sum" ]
  76
  77 __all__.append('CHANGESFIELDS_DSCFILES_MANDATORY')
  78
  79 CHANGESFIELDS_DSCFILES_OPTIONAL = [ "files id" ]
  80
  81 __all__.append('CHANGESFIELDS_DSCFILES_OPTIONAL')
  82
  83 CHANGESFIELDS_ORIGFILES = [ "id", "location" ]
  84
  85 __all__.append('CHANGESFIELDS_ORIGFILES')
  86
  87 ###############################################################################
  88
  89 class Changes(object):
  90     """ Convenience wrapper to carry around all the package information """
  91
  92     def __init__(self, **kwds):
  93         self.reset()
  94
  95     def reset(self):
  96         self.changes_file = ""
  97
  98         self.changes = {}
  99         self.dsc = {}
 100         self.files = {}
 101         self.dsc_files = {}
 102         self.orig_files = {}
 103
 104     def file_summary(self):
 105         # changes["distribution"] may not exist in corner cases
 106         # (e.g. unreadable changes files)
 107         if not self.changes.has_key("distribution") or not \
 108                isinstance(self.changes["distribution"], dict):
 109             self.changes["distribution"] = {}
 110
 111         byhand = False
 112         new = False
 113         summary = ""
 114         override_summary = ""
 115
 116         for name, entry in sorted(self.files.items()):
 117             if entry.has_key("byhand"):
 118                 byhand = True
 119                 summary += name + " byhand\n"
 120
 121             elif entry.has_key("new"):
 122                 new = True
 123                 summary += "(new) %s %s %s\n" % (name, entry["priority"], entry["section"])
 124
 125                 if entry.has_key("othercomponents"):
 126                     summary += "WARNING: Already present in %s distribution.\n" % (entry["othercomponents"])
 127
 128                 if entry["type"] == "deb":
 129                     deb_fh = open_file(name)
 130                     summary += ParseSection(debExtractControl(deb_fh))["Description"] + '\n'
 131                     deb_fh.close()
 132
 133             else:
 134                 entry["pool name"] = poolify(self.changes.get("source", ""), entry["component"])
 135                 destination = entry["pool name"] + name
 136                 summary += name + "\n  to " + destination + "\n"
 137
 138                 if not entry.has_key("type"):
 139                     entry["type"] = "unknown"
 140
 141                 if entry["type"] in ["deb", "udeb", "dsc"]:
 142                     # (queue/unchecked), there we have override entries already, use them
 143                     # (process-new), there we dont have override entries, use the newly generated ones.
 144                     override_prio = entry.get("override priority", entry["priority"])
 145                     override_sect = entry.get("override section", entry["section"])
 146                     override_summary += "%s - %s %s\n" % (name, override_prio, override_sect)
 147
 148         return (byhand, new, summary, override_summary)
 149
 150     def check_override(self):
 151         """
 152         Checks override entries for validity.
 153
 154         Returns an empty string if there are no problems
 155         or the text of a warning if there are
 156         """
 157
 158         summary = ""
 159
 160         # Abandon the check if it's a non-sourceful upload
 161         if not self.changes["architecture"].has_key("source"):
 162             return summary
 163
 164         for name, entry in sorted(self.files.items()):
 165             if not entry.has_key("new") and entry["type"] == "deb":
 166                 if entry["section"] != "-":
 167                     if entry["section"].lower() != entry["override section"].lower():
 168                         summary += "%s: package says section is %s, override says %s.\n" % (name,
 169                                                                                             entry["section"],
 170                                                                                             entry["override section"])
 171
 172                 if entry["priority"] != "-":
 173                     if entry["priority"] != entry["override priority"]:
 174                         summary += "%s: package says priority is %s, override says %s.\n" % (name,
 175                                                                                              entry["priority"],
 176                                                                                              entry["override priority"])
 177
 178         return summary
 179
 180     @session_wrapper
 181     def remove_known_changes(self, session=None):
 182         session.delete(get_dbchange(self.changes_file, session))
 183
 184     def mark_missing_fields(self):
 185         """add "missing" in fields which we will require for the known_changes table"""
 186         for key in ['urgency', 'maintainer', 'fingerprint', 'changed-by' ]:
 187             if (not self.changes.has_key(key)) or (not self.changes[key]):
 188                 self.changes[key]='missing'
 189
 190     @session_wrapper
 191     def add_known_changes(self, dirpath, in_queue=None, session=None):
 192         """add "missing" in fields which we will require for the known_changes table"""
 193         cnf = Config()
 194
 195         changesfile = os.path.join(dirpath, self.changes_file)
 196         filetime = datetime.datetime.fromtimestamp(os.path.getctime(changesfile))
 197
 198         self.mark_missing_fields()
 199
 200         multivalues = {}
 201         for key in ("distribution", "architecture", "binary"):
 202             if isinstance(self.changes[key], dict):
 203                 multivalues[key] = " ".join(self.changes[key].keys())
 204             else:
 205                 multivalues[key] = self.changes[key]
 206
 207         # TODO: Use ORM
 208         session.execute(
 209             """INSERT INTO changes
 210               (changesname, in_queue, seen, source, binaries, architecture, version,
 211               distribution, urgency, maintainer, fingerprint, changedby, date)
 212               VALUES (:changesfile,:in_queue,:filetime,:source,:binary, :architecture,
 213               :version,:distribution,:urgency,:maintainer,:fingerprint,:changedby,:date)""",
 214               { 'changesfile':  self.changes_file,
 215                 'filetime':     filetime,
 216                 'in_queue':     in_queue,
 217                 'source':       self.changes["source"],
 218                 'binary':       multivalues["binary"],
 219                 'architecture': multivalues["architecture"],
 220                 'version':      self.changes["version"],
 221                 'distribution': multivalues["distribution"],
 222                 'urgency':      self.changes["urgency"],
 223                 'maintainer':   self.changes["maintainer"],
 224                 'fingerprint':  self.changes["fingerprint"],
 225                 'changedby':    self.changes["changed-by"],
 226                 'date':         self.changes["date"]} )
 227
 228         session.commit()
 229
 230         return session.query(DBChange).filter_by(changesname = self.changes_file).one()
 231
 232     def unknown_files_fields(self, name):
 233         return sorted(list( set(self.files[name].keys()) -
 234                             set(CHANGESFIELDS_FILES)))
 235
 236     def unknown_changes_fields(self):
 237         return sorted(list( set(self.changes.keys()) -
 238                             set(CHANGESFIELDS_MANDATORY + CHANGESFIELDS_OPTIONAL)))
 239
 240     def unknown_dsc_fields(self):
 241         return sorted(list( set(self.dsc.keys()) -
 242                             set(CHANGESFIELDS_DSC)))
 243
 244     def unknown_dsc_files_fields(self, name):
 245         return sorted(list( set(self.dsc_files[name].keys()) -
 246                             set(CHANGESFIELDS_DSCFILES_MANDATORY + CHANGESFIELDS_DSCFILES_OPTIONAL)))
 247
 248     def str_files(self):
 249         r = []
 250         for name, entry in self.files.items():
 251             r.append("  %s:" % (name))
 252             for i in CHANGESFIELDS_FILES:
 253                 if entry.has_key(i):
 254                     r.append("   %s: %s" % (i.capitalize(), entry[i]))
 255             xfields = self.unknown_files_fields(name)
 256             if len(xfields) > 0:
 257                 r.append("files[%s] still has following unrecognised keys: %s" % (name, ", ".join(xfields)))
 258
 259         return r
 260
 261     def str_changes(self):
 262         r = []
 263         for i in CHANGESFIELDS_MANDATORY:
 264             val = self.changes[i]
 265             if isinstance(val, list):
 266                 val = " ".join(val)
 267             elif isinstance(val, dict):
 268                 val = " ".join(val.keys())
 269             r.append('  %s: %s' % (i.capitalize(), val))
 270
 271         for i in CHANGESFIELDS_OPTIONAL:
 272             if self.changes.has_key(i):
 273                 r.append('  %s: %s' % (i.capitalize(), self.changes[i]))
 274
 275         xfields = self.unknown_changes_fields()
 276         if len(xfields) > 0:
 277             r.append("Warning: changes still has the following unrecognised fields: %s" % ", ".join(xfields))
 278
 279         return r
 280
 281     def str_dsc(self):
 282         r = []
 283         for i in CHANGESFIELDS_DSC:
 284             if self.dsc.has_key(i):
 285                 r.append('  %s: %s' % (i.capitalize(), self.dsc[i]))
 286
 287         xfields = self.unknown_dsc_fields()
 288         if len(xfields) > 0:
 289             r.append("Warning: dsc still has the following unrecognised fields: %s" % ", ".join(xfields))
 290
 291         return r
 292
 293     def str_dsc_files(self):
 294         r = []
 295         for name, entry in self.dsc_files.items():
 296             r.append("  %s:" % (name))
 297             for i in CHANGESFIELDS_DSCFILES_MANDATORY:
 298                 r.append("   %s: %s" % (i.capitalize(), entry[i]))
 299             for i in CHANGESFIELDS_DSCFILES_OPTIONAL:
 300                 if entry.has_key(i):
 301                     r.append("   %s: %s" % (i.capitalize(), entry[i]))
 302             xfields = self.unknown_dsc_files_fields(name)
 303             if len(xfields) > 0:
 304                 r.append("dsc_files[%s] still has following unrecognised keys: %s" % (name, ", ".join(xfields)))
 305
 306         return r
 307
 308     def __str__(self):
 309         r = []
 310
 311         r.append(" Changes:")
 312         r += self.str_changes()
 313
 314         r.append("")
 315
 316         r.append(" Dsc:")
 317         r += self.str_dsc()
 318
 319         r.append("")
 320
 321         r.append(" Files:")
 322         r += self.str_files()
 323
 324         r.append("")
 325
 326         r.append(" Dsc Files:")
 327         r += self.str_dsc_files()
 328
 329         return "\n".join(r)
 330
 331 __all__.append('Changes')