daklib/dbconn.py

   1 #!/usr/bin/python
   2
   3 """ DB access class
   4
   5 @contact: Debian FTPMaster <ftpmaster@debian.org>
   6 @copyright: 2000, 2001, 2002, 2003, 2004, 2006  James Troup <james@nocrew.org>
   7 @copyright: 2008-2009  Mark Hymers <mhy@debian.org>
   8 @copyright: 2009, 2010  Joerg Jaspert <joerg@debian.org>
   9 @copyright: 2009  Mike O'Connor <stew@debian.org>
  10 @license: GNU General Public License version 2 or later
  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 need a funny comment
  30 # < sgran> two peanuts were walking down a dark street
  31 # < sgran> one was a-salted
  32 #  * mhy looks up the definition of "funny"
  33
  34 ################################################################################
  35
  36 import apt_pkg
  37 import os
  38 from os.path import normpath
  39 import re
  40 import psycopg2
  41 import traceback
  42 import commands
  43 import signal
  44
  45 try:
  46     # python >= 2.6
  47     import json
  48 except:
  49     # python <= 2.5
  50     import simplejson as json
  51
  52 from datetime import datetime, timedelta
  53 from errno import ENOENT
  54 from tempfile import mkstemp, mkdtemp
  55 from subprocess import Popen, PIPE
  56 from tarfile import TarFile
  57
  58 from inspect import getargspec
  59
  60 import sqlalchemy
  61 from sqlalchemy import create_engine, Table, MetaData, Column, Integer, desc, \
  62     Text, ForeignKey
  63 from sqlalchemy.orm import sessionmaker, mapper, relation, object_session, \
  64     backref, MapperExtension, EXT_CONTINUE, object_mapper, clear_mappers
  65 from sqlalchemy import types as sqltypes
  66 from sqlalchemy.orm.collections import attribute_mapped_collection
  67 from sqlalchemy.ext.associationproxy import association_proxy
  68
  69 # Don't remove this, we re-export the exceptions to scripts which import us
  70 from sqlalchemy.exc import *
  71 from sqlalchemy.orm.exc import NoResultFound
  72
  73 # Only import Config until Queue stuff is changed to store its config
  74 # in the database
  75 from config import Config
  76 from textutils import fix_maintainer
  77 from dak_exceptions import DBUpdateError, NoSourceFieldError, FileExistsError
  78
  79 # suppress some deprecation warnings in squeeze related to sqlalchemy
  80 import warnings
  81 warnings.filterwarnings('ignore', \
  82     "The SQLAlchemy PostgreSQL dialect has been renamed from 'postgres' to 'postgresql'.*", \
  83     SADeprecationWarning)
  84 warnings.filterwarnings('ignore', \
  85     "Predicate of partial index .* ignored during reflection", \
  86     SAWarning)
  87
  88
  89 ################################################################################
  90
  91 # Patch in support for the debversion field type so that it works during
  92 # reflection
  93
  94 try:
  95     # that is for sqlalchemy 0.6
  96     UserDefinedType = sqltypes.UserDefinedType
  97 except:
  98     # this one for sqlalchemy 0.5
  99     UserDefinedType = sqltypes.TypeEngine
 100
 101 class DebVersion(UserDefinedType):
 102     def get_col_spec(self):
 103         return "DEBVERSION"
 104
 105     def bind_processor(self, dialect):
 106         return None
 107
 108     # ' = None' is needed for sqlalchemy 0.5:
 109     def result_processor(self, dialect, coltype = None):
 110         return None
 111
 112 sa_major_version = sqlalchemy.__version__[0:3]
 113 if sa_major_version in ["0.5", "0.6"]:
 114     from sqlalchemy.databases import postgres
 115     postgres.ischema_names['debversion'] = DebVersion
 116 else:
 117     raise Exception("dak only ported to SQLA versions 0.5 and 0.6.  See daklib/dbconn.py")
 118
 119 ################################################################################
 120
 121 __all__ = ['IntegrityError', 'SQLAlchemyError', 'DebVersion']
 122
 123 ################################################################################
 124
 125 def session_wrapper(fn):
 126     """
 127     Wrapper around common ".., session=None):" handling. If the wrapped
 128     function is called without passing 'session', we create a local one
 129     and destroy it when the function ends.
 130
 131     Also attaches a commit_or_flush method to the session; if we created a
 132     local session, this is a synonym for session.commit(), otherwise it is a
 133     synonym for session.flush().
 134     """
 135
 136     def wrapped(*args, **kwargs):
 137         private_transaction = False
 138
 139         # Find the session object
 140         session = kwargs.get('session')
 141
 142         if session is None:
 143             if len(args) <= len(getargspec(fn)[0]) - 1:
 144                 # No session specified as last argument or in kwargs
 145                 private_transaction = True
 146                 session = kwargs['session'] = DBConn().session()
 147             else:
 148                 # Session is last argument in args
 149                 session = args[-1]
 150                 if session is None:
 151                     args = list(args)
 152                     session = args[-1] = DBConn().session()
 153                     private_transaction = True
 154
 155         if private_transaction:
 156             session.commit_or_flush = session.commit
 157         else:
 158             session.commit_or_flush = session.flush
 159
 160         try:
 161             return fn(*args, **kwargs)
 162         finally:
 163             if private_transaction:
 164                 # We created a session; close it.
 165                 session.close()
 166
 167     wrapped.__doc__ = fn.__doc__
 168     wrapped.func_name = fn.func_name
 169
 170     return wrapped
 171
 172 __all__.append('session_wrapper')
 173
 174 ################################################################################
 175
 176 class ORMObject(object):
 177     """
 178     ORMObject is a base class for all ORM classes mapped by SQLalchemy. All
 179     derived classes must implement the properties() method.
 180     """
 181
 182     def properties(self):
 183         '''
 184         This method should be implemented by all derived classes and returns a
 185         list of the important properties. The properties 'created' and
 186         'modified' will be added automatically. A suffix '_count' should be
 187         added to properties that are lists or query objects. The most important
 188         property name should be returned as the first element in the list
 189         because it is used by repr().
 190         '''
 191         return []
 192
 193     def json(self):
 194         '''
 195         Returns a JSON representation of the object based on the properties
 196         returned from the properties() method.
 197         '''
 198         data = {}
 199         # add created and modified
 200         all_properties = self.properties() + ['created', 'modified']
 201         for property in all_properties:
 202             # check for list or query
 203             if property[-6:] == '_count':
 204                 real_property = property[:-6]
 205                 if not hasattr(self, real_property):
 206                     continue
 207                 value = getattr(self, real_property)
 208                 if hasattr(value, '__len__'):
 209                     # list
 210                     value = len(value)
 211                 elif hasattr(value, 'count'):
 212                     # query (but not during validation)
 213                     if self.in_validation:
 214                         continue
 215                     value = value.count()
 216                 else:
 217                     raise KeyError('Do not understand property %s.' % property)
 218             else:
 219                 if not hasattr(self, property):
 220                     continue
 221                 # plain object
 222                 value = getattr(self, property)
 223                 if value is None:
 224                     # skip None
 225                     continue
 226                 elif isinstance(value, ORMObject):
 227                     # use repr() for ORMObject types
 228                     value = repr(value)
 229                 else:
 230                     # we want a string for all other types because json cannot
 231                     # encode everything
 232                     value = str(value)
 233             data[property] = value
 234         return json.dumps(data)
 235
 236     def classname(self):
 237         '''
 238         Returns the name of the class.
 239         '''
 240         return type(self).__name__
 241
 242     def __repr__(self):
 243         '''
 244         Returns a short string representation of the object using the first
 245         element from the properties() method.
 246         '''
 247         primary_property = self.properties()[0]
 248         value = getattr(self, primary_property)
 249         return '<%s %s>' % (self.classname(), str(value))
 250
 251     def __str__(self):
 252         '''
 253         Returns a human readable form of the object using the properties()
 254         method.
 255         '''
 256         return '<%s %s>' % (self.classname(), self.json())
 257
 258     def not_null_constraints(self):
 259         '''
 260         Returns a list of properties that must be not NULL. Derived classes
 261         should override this method if needed.
 262         '''
 263         return []
 264
 265     validation_message = \
 266         "Validation failed because property '%s' must not be empty in object\n%s"
 267
 268     in_validation = False
 269
 270     def validate(self):
 271         '''
 272         This function validates the not NULL constraints as returned by
 273         not_null_constraints(). It raises the DBUpdateError exception if
 274         validation fails.
 275         '''
 276         for property in self.not_null_constraints():
 277             # TODO: It is a bit awkward that the mapper configuration allow
 278             # directly setting the numeric _id columns. We should get rid of it
 279             # in the long run.
 280             if hasattr(self, property + '_id') and \
 281                 getattr(self, property + '_id') is not None:
 282                 continue
 283             if not hasattr(self, property) or getattr(self, property) is None:
 284                 # str() might lead to races due to a 2nd flush
 285                 self.in_validation = True
 286                 message = self.validation_message % (property, str(self))
 287                 self.in_validation = False
 288                 raise DBUpdateError(message)
 289
 290     @classmethod
 291     @session_wrapper
 292     def get(cls, primary_key,  session = None):
 293         '''
 294         This is a support function that allows getting an object by its primary
 295         key.
 296
 297         Architecture.get(3[, session])
 298
 299         instead of the more verbose
 300
 301         session.query(Architecture).get(3)
 302         '''
 303         return session.query(cls).get(primary_key)
 304
 305     def session(self, replace = False):
 306         '''
 307         Returns the current session that is associated with the object. May
 308         return None is object is in detached state.
 309         '''
 310
 311         return object_session(self)
 312
 313     def clone(self, session = None):
 314         '''
 315         Clones the current object in a new session and returns the new clone. A
 316         fresh session is created if the optional session parameter is not
 317         provided. The function will fail if a session is provided and has
 318         unflushed changes.
 319
 320         RATIONALE: SQLAlchemy's session is not thread safe. This method clones
 321         an existing object to allow several threads to work with their own
 322         instances of an ORMObject.
 323
 324         WARNING: Only persistent (committed) objects can be cloned. Changes
 325         made to the original object that are not committed yet will get lost.
 326         The session of the new object will always be rolled back to avoid
 327         ressource leaks.
 328         '''
 329
 330         if self.session() is None:
 331             raise RuntimeError( \
 332                 'Method clone() failed for detached object:\n%s' % self)
 333         self.session().flush()
 334         mapper = object_mapper(self)
 335         primary_key = mapper.primary_key_from_instance(self)
 336         object_class = self.__class__
 337         if session is None:
 338             session = DBConn().session()
 339         elif len(session.new) + len(session.dirty) + len(session.deleted) > 0:
 340             raise RuntimeError( \
 341                 'Method clone() failed due to unflushed changes in session.')
 342         new_object = session.query(object_class).get(primary_key)
 343         session.rollback()
 344         if new_object is None:
 345             raise RuntimeError( \
 346                 'Method clone() failed for non-persistent object:\n%s' % self)
 347         return new_object
 348
 349 __all__.append('ORMObject')
 350
 351 ################################################################################
 352
 353 class Validator(MapperExtension):
 354     '''
 355     This class calls the validate() method for each instance for the
 356     'before_update' and 'before_insert' events. A global object validator is
 357     used for configuring the individual mappers.
 358     '''
 359
 360     def before_update(self, mapper, connection, instance):
 361         instance.validate()
 362         return EXT_CONTINUE
 363
 364     def before_insert(self, mapper, connection, instance):
 365         instance.validate()
 366         return EXT_CONTINUE
 367
 368 validator = Validator()
 369
 370 ################################################################################
 371
 372 class Architecture(ORMObject):
 373     def __init__(self, arch_string = None, description = None):
 374         self.arch_string = arch_string
 375         self.description = description
 376
 377     def __eq__(self, val):
 378         if isinstance(val, str):
 379             return (self.arch_string== val)
 380         # This signals to use the normal comparison operator
 381         return NotImplemented
 382
 383     def __ne__(self, val):
 384         if isinstance(val, str):
 385             return (self.arch_string != val)
 386         # This signals to use the normal comparison operator
 387         return NotImplemented
 388
 389     def properties(self):
 390         return ['arch_string', 'arch_id', 'suites_count']
 391
 392     def not_null_constraints(self):
 393         return ['arch_string']
 394
 395 __all__.append('Architecture')
 396
 397 @session_wrapper
 398 def get_architecture(architecture, session=None):
 399     """
 400     Returns database id for given C{architecture}.
 401
 402     @type architecture: string
 403     @param architecture: The name of the architecture
 404
 405     @type session: Session
 406     @param session: Optional SQLA session object (a temporary one will be
 407     generated if not supplied)
 408
 409     @rtype: Architecture
 410     @return: Architecture object for the given arch (None if not present)
 411     """
 412
 413     q = session.query(Architecture).filter_by(arch_string=architecture)
 414
 415     try:
 416         return q.one()
 417     except NoResultFound:
 418         return None
 419
 420 __all__.append('get_architecture')
 421
 422 # TODO: should be removed because the implementation is too trivial
 423 @session_wrapper
 424 def get_architecture_suites(architecture, session=None):
 425     """
 426     Returns list of Suite objects for given C{architecture} name
 427
 428     @type architecture: str
 429     @param architecture: Architecture name to search for
 430
 431     @type session: Session
 432     @param session: Optional SQL session object (a temporary one will be
 433     generated if not supplied)
 434
 435     @rtype: list
 436     @return: list of Suite objects for the given name (may be empty)
 437     """
 438
 439     return get_architecture(architecture, session).suites
 440
 441 __all__.append('get_architecture_suites')
 442
 443 ################################################################################
 444
 445 class Archive(object):
 446     def __init__(self, *args, **kwargs):
 447         pass
 448
 449     def __repr__(self):
 450         return '<Archive %s>' % self.archive_name
 451
 452 __all__.append('Archive')
 453
 454 @session_wrapper
 455 def get_archive(archive, session=None):
 456     """
 457     returns database id for given C{archive}.
 458
 459     @type archive: string
 460     @param archive: the name of the arhive
 461
 462     @type session: Session
 463     @param session: Optional SQLA session object (a temporary one will be
 464     generated if not supplied)
 465
 466     @rtype: Archive
 467     @return: Archive object for the given name (None if not present)
 468
 469     """
 470     archive = archive.lower()
 471
 472     q = session.query(Archive).filter_by(archive_name=archive)
 473
 474     try:
 475         return q.one()
 476     except NoResultFound:
 477         return None
 478
 479 __all__.append('get_archive')
 480
 481 ################################################################################
 482
 483 class BinContents(ORMObject):
 484     def __init__(self, file = None, binary = None):
 485         self.file = file
 486         self.binary = binary
 487
 488     def properties(self):
 489         return ['file', 'binary']
 490
 491 __all__.append('BinContents')
 492
 493 ################################################################################
 494
 495 def subprocess_setup():
 496     # Python installs a SIGPIPE handler by default. This is usually not what
 497     # non-Python subprocesses expect.
 498     signal.signal(signal.SIGPIPE, signal.SIG_DFL)
 499
 500 class DBBinary(ORMObject):
 501     def __init__(self, package = None, source = None, version = None, \
 502         maintainer = None, architecture = None, poolfile = None, \
 503         binarytype = 'deb'):
 504         self.package = package
 505         self.source = source
 506         self.version = version
 507         self.maintainer = maintainer
 508         self.architecture = architecture
 509         self.poolfile = poolfile
 510         self.binarytype = binarytype
 511
 512     @property
 513     def pkid(self):
 514         return self.binary_id
 515
 516     def properties(self):
 517         return ['package', 'version', 'maintainer', 'source', 'architecture', \
 518             'poolfile', 'binarytype', 'fingerprint', 'install_date', \
 519             'suites_count', 'binary_id', 'contents_count', 'extra_sources']
 520
 521     def not_null_constraints(self):
 522         return ['package', 'version', 'maintainer', 'source',  'poolfile', \
 523             'binarytype']
 524
 525     metadata = association_proxy('key', 'value')
 526
 527     def get_component_name(self):
 528         return self.poolfile.location.component.component_name
 529
 530     def scan_contents(self):
 531         '''
 532         Yields the contents of the package. Only regular files are yielded and
 533         the path names are normalized after converting them from either utf-8
 534         or iso8859-1 encoding. It yields the string ' <EMPTY PACKAGE>' if the
 535         package does not contain any regular file.
 536         '''
 537         fullpath = self.poolfile.fullpath
 538         dpkg = Popen(['dpkg-deb', '--fsys-tarfile', fullpath], stdout = PIPE,
 539             preexec_fn = subprocess_setup)
 540         tar = TarFile.open(fileobj = dpkg.stdout, mode = 'r|')
 541         for member in tar.getmembers():
 542             if not member.isdir():
 543                 name = normpath(member.name)
 544                 # enforce proper utf-8 encoding
 545                 try:
 546                     name.decode('utf-8')
 547                 except UnicodeDecodeError:
 548                     name = name.decode('iso8859-1').encode('utf-8')
 549                 yield name
 550         tar.close()
 551         dpkg.stdout.close()
 552         dpkg.wait()
 553
 554     def read_control(self):
 555         '''
 556         Reads the control information from a binary.
 557
 558         @rtype: text
 559         @return: stanza text of the control section.
 560         '''
 561         import apt_inst
 562         fullpath = self.poolfile.fullpath
 563         deb_file = open(fullpath, 'r')
 564         stanza = apt_inst.debExtractControl(deb_file)
 565         deb_file.close()
 566
 567         return stanza
 568
 569     def read_control_fields(self):
 570         '''
 571         Reads the control information from a binary and return
 572         as a dictionary.
 573
 574         @rtype: dict
 575         @return: fields of the control section as a dictionary.
 576         '''
 577         import apt_pkg
 578         stanza = self.read_control()
 579         return apt_pkg.TagSection(stanza)
 580
 581 __all__.append('DBBinary')
 582
 583 @session_wrapper
 584 def get_suites_binary_in(package, session=None):
 585     """
 586     Returns list of Suite objects which given C{package} name is in
 587
 588     @type package: str
 589     @param package: DBBinary package name to search for
 590
 591     @rtype: list
 592     @return: list of Suite objects for the given package
 593     """
 594
 595     return session.query(Suite).filter(Suite.binaries.any(DBBinary.package == package)).all()
 596
 597 __all__.append('get_suites_binary_in')
 598
 599 @session_wrapper
 600 def get_component_by_package_suite(package, suite_list, arch_list=[], session=None):
 601     '''
 602     Returns the component name of the newest binary package in suite_list or
 603     None if no package is found. The result can be optionally filtered by a list
 604     of architecture names.
 605
 606     @type package: str
 607     @param package: DBBinary package name to search for
 608
 609     @type suite_list: list of str
 610     @param suite_list: list of suite_name items
 611
 612     @type arch_list: list of str
 613     @param arch_list: optional list of arch_string items that defaults to []
 614
 615     @rtype: str or NoneType
 616     @return: name of component or None
 617     '''
 618
 619     q = session.query(DBBinary).filter_by(package = package). \
 620         join(DBBinary.suites).filter(Suite.suite_name.in_(suite_list))
 621     if len(arch_list) > 0:
 622         q = q.join(DBBinary.architecture). \
 623             filter(Architecture.arch_string.in_(arch_list))
 624     binary = q.order_by(desc(DBBinary.version)).first()
 625     if binary is None:
 626         return None
 627     else:
 628         return binary.get_component_name()
 629
 630 __all__.append('get_component_by_package_suite')
 631
 632 ################################################################################
 633
 634 class BinaryACL(object):
 635     def __init__(self, *args, **kwargs):
 636         pass
 637
 638     def __repr__(self):
 639         return '<BinaryACL %s>' % self.binary_acl_id
 640
 641 __all__.append('BinaryACL')
 642
 643 ################################################################################
 644
 645 class BinaryACLMap(object):
 646     def __init__(self, *args, **kwargs):
 647         pass
 648
 649     def __repr__(self):
 650         return '<BinaryACLMap %s>' % self.binary_acl_map_id
 651
 652 __all__.append('BinaryACLMap')
 653
 654 ################################################################################
 655
 656 MINIMAL_APT_CONF="""
 657 Dir
 658 {
 659    ArchiveDir "%(archivepath)s";
 660    OverrideDir "%(overridedir)s";
 661    CacheDir "%(cachedir)s";
 662 };
 663
 664 Default
 665 {
 666    Packages::Compress ". bzip2 gzip";
 667    Sources::Compress ". bzip2 gzip";
 668    DeLinkLimit 0;
 669    FileMode 0664;
 670 }
 671
 672 bindirectory "incoming"
 673 {
 674    Packages "Packages";
 675    Contents " ";
 676
 677    BinOverride "override.sid.all3";
 678    BinCacheDB "packages-accepted.db";
 679
 680    FileList "%(filelist)s";
 681
 682    PathPrefix "";
 683    Packages::Extensions ".deb .udeb";
 684 };
 685
 686 bindirectory "incoming/"
 687 {
 688    Sources "Sources";
 689    BinOverride "override.sid.all3";
 690    SrcOverride "override.sid.all3.src";
 691    FileList "%(filelist)s";
 692 };
 693 """
 694
 695 class BuildQueue(object):
 696     def __init__(self, *args, **kwargs):
 697         pass
 698
 699     def __repr__(self):
 700         return '<BuildQueue %s>' % self.queue_name
 701
 702     def write_metadata(self, starttime, force=False):
 703         # Do we write out metafiles?
 704         if not (force or self.generate_metadata):
 705             return
 706
 707         session = DBConn().session().object_session(self)
 708
 709         fl_fd = fl_name = ac_fd = ac_name = None
 710         tempdir = None
 711         arches = " ".join([ a.arch_string for a in session.query(Architecture).all() if a.arch_string != 'source' ])
 712         startdir = os.getcwd()
 713
 714         try:
 715             # Grab files we want to include
 716             newer = session.query(BuildQueueFile).filter_by(build_queue_id = self.queue_id).filter(BuildQueueFile.lastused + timedelta(seconds=self.stay_of_execution) > starttime).all()
 717             newer += session.query(BuildQueuePolicyFile).filter_by(build_queue_id = self.queue_id).filter(BuildQueuePolicyFile.lastused + timedelta(seconds=self.stay_of_execution) > starttime).all()
 718             # Write file list with newer files
 719             (fl_fd, fl_name) = mkstemp()
 720             for n in newer:
 721                 os.write(fl_fd, '%s\n' % n.fullpath)
 722             os.close(fl_fd)
 723
 724             cnf = Config()
 725
 726             # Write minimal apt.conf
 727             # TODO: Remove hardcoding from template
 728             (ac_fd, ac_name) = mkstemp()
 729             os.write(ac_fd, MINIMAL_APT_CONF % {'archivepath': self.path,
 730                                                 'filelist': fl_name,
 731                                                 'cachedir': cnf["Dir::Cache"],
 732                                                 'overridedir': cnf["Dir::Override"],
 733                                                 })
 734             os.close(ac_fd)
 735
 736             # Run apt-ftparchive generate
 737             os.chdir(os.path.dirname(ac_name))
 738             os.system('apt-ftparchive -qq -o APT::FTPArchive::Contents=off generate %s' % os.path.basename(ac_name))
 739
 740             # Run apt-ftparchive release
 741             # TODO: Eww - fix this
 742             bname = os.path.basename(self.path)
 743             os.chdir(self.path)
 744             os.chdir('..')
 745
 746             # We have to remove the Release file otherwise it'll be included in the
 747             # new one
 748             try:
 749                 os.unlink(os.path.join(bname, 'Release'))
 750             except OSError:
 751                 pass
 752
 753             os.system("""apt-ftparchive -qq -o APT::FTPArchive::Release::Origin="%s" -o APT::FTPArchive::Release::Label="%s" -o APT::FTPArchive::Release::Description="%s" -o APT::FTPArchive::Release::Architectures="%s" release %s > Release""" % (self.origin, self.label, self.releasedescription, arches, bname))
 754
 755             # Crude hack with open and append, but this whole section is and should be redone.
 756             if self.notautomatic:
 757                 release=open("Release", "a")
 758                 release.write("NotAutomatic: yes\n")
 759                 release.close()
 760
 761             # Sign if necessary
 762             if self.signingkey:
 763                 keyring = "--secret-keyring \"%s\"" % cnf["Dinstall::SigningKeyring"]
 764                 if cnf.has_key("Dinstall::SigningPubKeyring"):
 765                     keyring += " --keyring \"%s\"" % cnf["Dinstall::SigningPubKeyring"]
 766
 767                 os.system("gpg %s --no-options --batch --no-tty --armour --default-key %s --detach-sign -o Release.gpg Release""" % (keyring, self.signingkey))
 768
 769             # Move the files if we got this far
 770             os.rename('Release', os.path.join(bname, 'Release'))
 771             if self.signingkey:
 772                 os.rename('Release.gpg', os.path.join(bname, 'Release.gpg'))
 773
 774         # Clean up any left behind files
 775         finally:
 776             os.chdir(startdir)
 777             if fl_fd:
 778                 try:
 779                     os.close(fl_fd)
 780                 except OSError:
 781                     pass
 782
 783             if fl_name:
 784                 try:
 785                     os.unlink(fl_name)
 786                 except OSError:
 787                     pass
 788
 789             if ac_fd:
 790                 try:
 791                     os.close(ac_fd)
 792                 except OSError:
 793                     pass
 794
 795             if ac_name:
 796                 try:
 797                     os.unlink(ac_name)
 798                 except OSError:
 799                     pass
 800
 801     def clean_and_update(self, starttime, Logger, dryrun=False):
 802         """WARNING: This routine commits for you"""
 803         session = DBConn().session().object_session(self)
 804
 805         if self.generate_metadata and not dryrun:
 806             self.write_metadata(starttime)
 807
 808         # Grab files older than our execution time
 809         older = session.query(BuildQueueFile).filter_by(build_queue_id = self.queue_id).filter(BuildQueueFile.lastused + timedelta(seconds=self.stay_of_execution) <= starttime).all()
 810         older += session.query(BuildQueuePolicyFile).filter_by(build_queue_id = self.queue_id).filter(BuildQueuePolicyFile.lastused + timedelta(seconds=self.stay_of_execution) <= starttime).all()
 811
 812         for o in older:
 813             killdb = False
 814             try:
 815                 if dryrun:
 816                     Logger.log(["I: Would have removed %s from the queue" % o.fullpath])
 817                 else:
 818                     Logger.log(["I: Removing %s from the queue" % o.fullpath])
 819                     os.unlink(o.fullpath)
 820                     killdb = True
 821             except OSError as e:
 822                 # If it wasn't there, don't worry
 823                 if e.errno == ENOENT:
 824                     killdb = True
 825                 else:
 826                     # TODO: Replace with proper logging call
 827                     Logger.log(["E: Could not remove %s" % o.fullpath])
 828
 829             if killdb:
 830                 session.delete(o)
 831
 832         session.commit()
 833
 834         for f in os.listdir(self.path):
 835             if f.startswith('Packages') or f.startswith('Source') or f.startswith('Release') or f.startswith('advisory'):
 836                 continue
 837
 838             if not self.contains_filename(f):
 839                 fp = os.path.join(self.path, f)
 840                 if dryrun:
 841                     Logger.log(["I: Would remove unused link %s" % fp])
 842                 else:
 843                     Logger.log(["I: Removing unused link %s" % fp])
 844                     try:
 845                         os.unlink(fp)
 846                     except OSError:
 847                         Logger.log(["E: Failed to unlink unreferenced file %s" % r.fullpath])
 848
 849     def contains_filename(self, filename):
 850         """
 851         @rtype Boolean
 852         @returns True if filename is supposed to be in the queue; False otherwise
 853         """
 854         session = DBConn().session().object_session(self)
 855         if session.query(BuildQueueFile).filter_by(build_queue_id = self.queue_id, filename = filename).count() > 0:
 856             return True
 857         elif session.query(BuildQueuePolicyFile).filter_by(build_queue = self, filename = filename).count() > 0:
 858             return True
 859         return False
 860
 861     def add_file_from_pool(self, poolfile):
 862         """Copies a file into the pool.  Assumes that the PoolFile object is
 863         attached to the same SQLAlchemy session as the Queue object is.
 864
 865         The caller is responsible for committing after calling this function."""
 866         poolfile_basename = poolfile.filename[poolfile.filename.rindex(os.sep)+1:]
 867
 868         # Check if we have a file of this name or this ID already
 869         for f in self.queuefiles:
 870             if (f.fileid is not None and f.fileid == poolfile.file_id) or \
 871                (f.poolfile is not None and f.poolfile.filename == poolfile_basename):
 872                    # In this case, update the BuildQueueFile entry so we
 873                    # don't remove it too early
 874                    f.lastused = datetime.now()
 875                    DBConn().session().object_session(poolfile).add(f)
 876                    return f
 877
 878         # Prepare BuildQueueFile object
 879         qf = BuildQueueFile()
 880         qf.build_queue_id = self.queue_id
 881         qf.lastused = datetime.now()
 882         qf.filename = poolfile_basename
 883
 884         targetpath = poolfile.fullpath
 885         queuepath = os.path.join(self.path, poolfile_basename)
 886
 887         try:
 888             if self.copy_files:
 889                 # We need to copy instead of symlink
 890                 import utils
 891                 utils.copy(targetpath, queuepath)
 892                 # NULL in the fileid field implies a copy
 893                 qf.fileid = None
 894             else:
 895                 os.symlink(targetpath, queuepath)
 896                 qf.fileid = poolfile.file_id
 897         except FileExistsError:
 898             if not poolfile.identical_to(queuepath):
 899                 raise
 900         except OSError:
 901             return None
 902
 903         # Get the same session as the PoolFile is using and add the qf to it
 904         DBConn().session().object_session(poolfile).add(qf)
 905
 906         return qf
 907
 908     def add_changes_from_policy_queue(self, policyqueue, changes):
 909         """
 910         Copies a changes from a policy queue together with its poolfiles.
 911
 912         @type policyqueue: PolicyQueue
 913         @param policyqueue: policy queue to copy the changes from
 914
 915         @type changes: DBChange
 916         @param changes: changes to copy to this build queue
 917         """
 918         for policyqueuefile in changes.files:
 919             self.add_file_from_policy_queue(policyqueue, policyqueuefile)
 920         for poolfile in changes.poolfiles:
 921             self.add_file_from_pool(poolfile)
 922
 923     def add_file_from_policy_queue(self, policyqueue, policyqueuefile):
 924         """
 925         Copies a file from a policy queue.
 926         Assumes that the policyqueuefile is attached to the same SQLAlchemy
 927         session as the Queue object is.  The caller is responsible for
 928         committing after calling this function.
 929
 930         @type policyqueue: PolicyQueue
 931         @param policyqueue: policy queue to copy the file from
 932
 933         @type policyqueuefile: ChangePendingFile
 934         @param policyqueuefile: file to be added to the build queue
 935         """
 936         session = DBConn().session().object_session(policyqueuefile)
 937
 938         # Is the file already there?
 939         try:
 940             f = session.query(BuildQueuePolicyFile).filter_by(build_queue=self, file=policyqueuefile).one()
 941             f.lastused = datetime.now()
 942             return f
 943         except NoResultFound:
 944             pass # continue below
 945
 946         # We have to add the file.
 947         f = BuildQueuePolicyFile()
 948         f.build_queue = self
 949         f.file = policyqueuefile
 950         f.filename = policyqueuefile.filename
 951
 952         source = os.path.join(policyqueue.path, policyqueuefile.filename)
 953         target = f.fullpath
 954         try:
 955             # Always copy files from policy queues as they might move around.
 956             import utils
 957             utils.copy(source, target)
 958         except FileExistsError:
 959             if not policyqueuefile.identical_to(target):
 960                 raise
 961         except OSError:
 962             return None
 963
 964         session.add(f)
 965         return f
 966
 967 __all__.append('BuildQueue')
 968
 969 @session_wrapper
 970 def get_build_queue(queuename, session=None):
 971     """
 972     Returns BuildQueue object for given C{queue name}, creating it if it does not
 973     exist.
 974
 975     @type queuename: string
 976     @param queuename: The name of the queue
 977
 978     @type session: Session
 979     @param session: Optional SQLA session object (a temporary one will be
 980     generated if not supplied)
 981
 982     @rtype: BuildQueue
 983     @return: BuildQueue object for the given queue
 984     """
 985
 986     q = session.query(BuildQueue).filter_by(queue_name=queuename)
 987
 988     try:
 989         return q.one()
 990     except NoResultFound:
 991         return None
 992
 993 __all__.append('get_build_queue')
 994
 995 ################################################################################
 996
 997 class BuildQueueFile(object):
 998     """
 999     BuildQueueFile represents a file in a build queue coming from a pool.
1000     """
1001
1002     def __init__(self, *args, **kwargs):
1003         pass
1004
1005     def __repr__(self):
1006         return '<BuildQueueFile %s (%s)>' % (self.filename, self.build_queue_id)
1007
1008     @property
1009     def fullpath(self):
1010         return os.path.join(self.buildqueue.path, self.filename)
1011
1012
1013 __all__.append('BuildQueueFile')
1014
1015 ################################################################################
1016
1017 class BuildQueuePolicyFile(object):
1018     """
1019     BuildQueuePolicyFile represents a file in a build queue that comes from a
1020     policy queue (and not a pool).
1021     """
1022
1023     def __init__(self, *args, **kwargs):
1024         pass
1025
1026     #@property
1027     #def filename(self):
1028     #    return self.file.filename
1029
1030     @property
1031     def fullpath(self):
1032         return os.path.join(self.build_queue.path, self.filename)
1033
1034 __all__.append('BuildQueuePolicyFile')
1035
1036 ################################################################################
1037
1038 class ChangePendingBinary(object):
1039     def __init__(self, *args, **kwargs):
1040         pass
1041
1042     def __repr__(self):
1043         return '<ChangePendingBinary %s>' % self.change_pending_binary_id
1044
1045 __all__.append('ChangePendingBinary')
1046
1047 ################################################################################
1048
1049 class ChangePendingFile(object):
1050     def __init__(self, *args, **kwargs):
1051         pass
1052
1053     def __repr__(self):
1054         return '<ChangePendingFile %s>' % self.change_pending_file_id
1055
1056     def identical_to(self, filename):
1057         """
1058         compare size and hash with the given file
1059
1060         @rtype: bool
1061         @return: true if the given file has the same size and hash as this object; false otherwise
1062         """
1063         st = os.stat(filename)
1064         if self.size != st.st_size:
1065             return False
1066
1067         f = open(filename, "r")
1068         sha256sum = apt_pkg.sha256sum(f)
1069         if sha256sum != self.sha256sum:
1070             return False
1071
1072         return True
1073
1074 __all__.append('ChangePendingFile')
1075
1076 ################################################################################
1077
1078 class ChangePendingSource(object):
1079     def __init__(self, *args, **kwargs):
1080         pass
1081
1082     def __repr__(self):
1083         return '<ChangePendingSource %s>' % self.change_pending_source_id
1084
1085 __all__.append('ChangePendingSource')
1086
1087 ################################################################################
1088
1089 class Component(ORMObject):
1090     def __init__(self, component_name = None):
1091         self.component_name = component_name
1092
1093     def __eq__(self, val):
1094         if isinstance(val, str):
1095             return (self.component_name == val)
1096         # This signals to use the normal comparison operator
1097         return NotImplemented
1098
1099     def __ne__(self, val):
1100         if isinstance(val, str):
1101             return (self.component_name != val)
1102         # This signals to use the normal comparison operator
1103         return NotImplemented
1104
1105     def properties(self):
1106         return ['component_name', 'component_id', 'description', \
1107             'location_count', 'meets_dfsg', 'overrides_count']
1108
1109     def not_null_constraints(self):
1110         return ['component_name']
1111
1112
1113 __all__.append('Component')
1114
1115 @session_wrapper
1116 def get_component(component, session=None):
1117     """
1118     Returns database id for given C{component}.
1119
1120     @type component: string
1121     @param component: The name of the override type
1122
1123     @rtype: int
1124     @return: the database id for the given component
1125
1126     """
1127     component = component.lower()
1128
1129     q = session.query(Component).filter_by(component_name=component)
1130
1131     try:
1132         return q.one()
1133     except NoResultFound:
1134         return None
1135
1136 __all__.append('get_component')
1137
1138 @session_wrapper
1139 def get_component_names(session=None):
1140     """
1141     Returns list of strings of component names.
1142
1143     @rtype: list
1144     @return: list of strings of component names
1145     """
1146
1147     return [ x.component_name for x in session.query(Component).all() ]
1148
1149 __all__.append('get_component_names')
1150
1151 ################################################################################
1152
1153 class DBConfig(object):
1154     def __init__(self, *args, **kwargs):
1155         pass
1156
1157     def __repr__(self):
1158         return '<DBConfig %s>' % self.name
1159
1160 __all__.append('DBConfig')
1161
1162 ################################################################################
1163
1164 @session_wrapper
1165 def get_or_set_contents_file_id(filename, session=None):
1166     """
1167     Returns database id for given filename.
1168
1169     If no matching file is found, a row is inserted.
1170
1171     @type filename: string
1172     @param filename: The filename
1173     @type session: SQLAlchemy
1174     @param session: Optional SQL session object (a temporary one will be
1175     generated if not supplied).  If not passed, a commit will be performed at
1176     the end of the function, otherwise the caller is responsible for commiting.
1177
1178     @rtype: int
1179     @return: the database id for the given component
1180     """
1181
1182     q = session.query(ContentFilename).filter_by(filename=filename)
1183
1184     try:
1185         ret = q.one().cafilename_id
1186     except NoResultFound:
1187         cf = ContentFilename()
1188         cf.filename = filename
1189         session.add(cf)
1190         session.commit_or_flush()
1191         ret = cf.cafilename_id
1192
1193     return ret
1194
1195 __all__.append('get_or_set_contents_file_id')
1196
1197 @session_wrapper
1198 def get_contents(suite, overridetype, section=None, session=None):
1199     """
1200     Returns contents for a suite / overridetype combination, limiting
1201     to a section if not None.
1202
1203     @type suite: Suite
1204     @param suite: Suite object
1205
1206     @type overridetype: OverrideType
1207     @param overridetype: OverrideType object
1208
1209     @type section: Section
1210     @param section: Optional section object to limit results to
1211
1212     @type session: SQLAlchemy
1213     @param session: Optional SQL session object (a temporary one will be
1214     generated if not supplied)
1215
1216     @rtype: ResultsProxy
1217     @return: ResultsProxy object set up to return tuples of (filename, section,
1218     package, arch_id)
1219     """
1220
1221     # find me all of the contents for a given suite
1222     contents_q = """SELECT (p.path||'/'||n.file) AS fn,
1223                             s.section,
1224                             b.package,
1225                             b.architecture
1226                    FROM content_associations c join content_file_paths p ON (c.filepath=p.id)
1227                    JOIN content_file_names n ON (c.filename=n.id)
1228                    JOIN binaries b ON (b.id=c.binary_pkg)
1229                    JOIN override o ON (o.package=b.package)
1230                    JOIN section s ON (s.id=o.section)
1231                    WHERE o.suite = :suiteid AND o.type = :overridetypeid
1232                    AND b.type=:overridetypename"""
1233
1234     vals = {'suiteid': suite.suite_id,
1235             'overridetypeid': overridetype.overridetype_id,
1236             'overridetypename': overridetype.overridetype}
1237
1238     if section is not None:
1239         contents_q += " AND s.id = :sectionid"
1240         vals['sectionid'] = section.section_id
1241
1242     contents_q += " ORDER BY fn"
1243
1244     return session.execute(contents_q, vals)
1245
1246 __all__.append('get_contents')
1247
1248 ################################################################################
1249
1250 class ContentFilepath(object):
1251     def __init__(self, *args, **kwargs):
1252         pass
1253
1254     def __repr__(self):
1255         return '<ContentFilepath %s>' % self.filepath
1256
1257 __all__.append('ContentFilepath')
1258
1259 @session_wrapper
1260 def get_or_set_contents_path_id(filepath, session=None):
1261     """
1262     Returns database id for given path.
1263
1264     If no matching file is found, a row is inserted.
1265
1266     @type filepath: string
1267     @param filepath: The filepath
1268
1269     @type session: SQLAlchemy
1270     @param session: Optional SQL session object (a temporary one will be
1271     generated if not supplied).  If not passed, a commit will be performed at
1272     the end of the function, otherwise the caller is responsible for commiting.
1273
1274     @rtype: int
1275     @return: the database id for the given path
1276     """
1277
1278     q = session.query(ContentFilepath).filter_by(filepath=filepath)
1279
1280     try:
1281         ret = q.one().cafilepath_id
1282     except NoResultFound:
1283         cf = ContentFilepath()
1284         cf.filepath = filepath
1285         session.add(cf)
1286         session.commit_or_flush()
1287         ret = cf.cafilepath_id
1288
1289     return ret
1290
1291 __all__.append('get_or_set_contents_path_id')
1292
1293 ################################################################################
1294
1295 class ContentAssociation(object):
1296     def __init__(self, *args, **kwargs):
1297         pass
1298
1299     def __repr__(self):
1300         return '<ContentAssociation %s>' % self.ca_id
1301
1302 __all__.append('ContentAssociation')
1303
1304 def insert_content_paths(binary_id, fullpaths, session=None):
1305     """
1306     Make sure given path is associated with given binary id
1307
1308     @type binary_id: int
1309     @param binary_id: the id of the binary
1310     @type fullpaths: list
1311     @param fullpaths: the list of paths of the file being associated with the binary
1312     @type session: SQLAlchemy session
1313     @param session: Optional SQLAlchemy session.  If this is passed, the caller
1314     is responsible for ensuring a transaction has begun and committing the
1315     results or rolling back based on the result code.  If not passed, a commit
1316     will be performed at the end of the function, otherwise the caller is
1317     responsible for commiting.
1318
1319     @return: True upon success
1320     """
1321
1322     privatetrans = False
1323     if session is None:
1324         session = DBConn().session()
1325         privatetrans = True
1326
1327     try:
1328         # Insert paths
1329         def generate_path_dicts():
1330             for fullpath in fullpaths:
1331                 if fullpath.startswith( './' ):
1332                     fullpath = fullpath[2:]
1333
1334                 yield {'filename':fullpath, 'id': binary_id }
1335
1336         for d in generate_path_dicts():
1337             session.execute( "INSERT INTO bin_contents ( file, binary_id ) VALUES ( :filename, :id )",
1338                          d )
1339
1340         session.commit()
1341         if privatetrans:
1342             session.close()
1343         return True
1344
1345     except:
1346         traceback.print_exc()
1347
1348         # Only rollback if we set up the session ourself
1349         if privatetrans:
1350             session.rollback()
1351             session.close()
1352
1353         return False
1354
1355 __all__.append('insert_content_paths')
1356
1357 ################################################################################
1358
1359 class DSCFile(object):
1360     def __init__(self, *args, **kwargs):
1361         pass
1362
1363     def __repr__(self):
1364         return '<DSCFile %s>' % self.dscfile_id
1365
1366 __all__.append('DSCFile')
1367
1368 @session_wrapper
1369 def get_dscfiles(dscfile_id=None, source_id=None, poolfile_id=None, session=None):
1370     """
1371     Returns a list of DSCFiles which may be empty
1372
1373     @type dscfile_id: int (optional)
1374     @param dscfile_id: the dscfile_id of the DSCFiles to find
1375
1376     @type source_id: int (optional)
1377     @param source_id: the source id related to the DSCFiles to find
1378
1379     @type poolfile_id: int (optional)
1380     @param poolfile_id: the poolfile id related to the DSCFiles to find
1381
1382     @rtype: list
1383     @return: Possibly empty list of DSCFiles
1384     """
1385
1386     q = session.query(DSCFile)
1387
1388     if dscfile_id is not None:
1389         q = q.filter_by(dscfile_id=dscfile_id)
1390
1391     if source_id is not None:
1392         q = q.filter_by(source_id=source_id)
1393
1394     if poolfile_id is not None:
1395         q = q.filter_by(poolfile_id=poolfile_id)
1396
1397     return q.all()
1398
1399 __all__.append('get_dscfiles')
1400
1401 ################################################################################
1402
1403 class ExternalOverride(ORMObject):
1404     def __init__(self, *args, **kwargs):
1405         pass
1406
1407     def __repr__(self):
1408         return '<ExternalOverride %s = %s: %s>' % (self.package, self.key, self.value)
1409
1410 __all__.append('ExternalOverride')
1411
1412 ################################################################################
1413
1414 class PoolFile(ORMObject):
1415     def __init__(self, filename = None, location = None, filesize = -1, \
1416         md5sum = None):
1417         self.filename = filename
1418         self.location = location
1419         self.filesize = filesize
1420         self.md5sum = md5sum
1421
1422     @property
1423     def fullpath(self):
1424         return os.path.join(self.location.path, self.filename)
1425
1426     def is_valid(self, filesize = -1, md5sum = None):
1427         return self.filesize == long(filesize) and self.md5sum == md5sum
1428
1429     def properties(self):
1430         return ['filename', 'file_id', 'filesize', 'md5sum', 'sha1sum', \
1431             'sha256sum', 'location', 'source', 'binary', 'last_used']
1432
1433     def not_null_constraints(self):
1434         return ['filename', 'md5sum', 'location']
1435
1436     def identical_to(self, filename):
1437         """
1438         compare size and hash with the given file
1439
1440         @rtype: bool
1441         @return: true if the given file has the same size and hash as this object; false otherwise
1442         """
1443         st = os.stat(filename)
1444         if self.filesize != st.st_size:
1445             return False
1446
1447         f = open(filename, "r")
1448         sha256sum = apt_pkg.sha256sum(f)
1449         if sha256sum != self.sha256sum:
1450             return False
1451
1452         return True
1453
1454 __all__.append('PoolFile')
1455
1456 @session_wrapper
1457 def check_poolfile(filename, filesize, md5sum, location_id, session=None):
1458     """
1459     Returns a tuple:
1460     (ValidFileFound [boolean], PoolFile object or None)
1461
1462     @type filename: string
1463     @param filename: the filename of the file to check against the DB
1464
1465     @type filesize: int
1466     @param filesize: the size of the file to check against the DB
1467
1468     @type md5sum: string
1469     @param md5sum: the md5sum of the file to check against the DB
1470
1471     @type location_id: int
1472     @param location_id: the id of the location to look in
1473
1474     @rtype: tuple
1475     @return: Tuple of length 2.
1476                  - If valid pool file found: (C{True}, C{PoolFile object})
1477                  - If valid pool file not found:
1478                      - (C{False}, C{None}) if no file found
1479                      - (C{False}, C{PoolFile object}) if file found with size/md5sum mismatch
1480     """
1481
1482     poolfile = session.query(Location).get(location_id). \
1483         files.filter_by(filename=filename).first()
1484     valid = False
1485     if poolfile and poolfile.is_valid(filesize = filesize, md5sum = md5sum):
1486         valid = True
1487
1488     return (valid, poolfile)
1489
1490 __all__.append('check_poolfile')
1491
1492 # TODO: the implementation can trivially be inlined at the place where the
1493 # function is called
1494 @session_wrapper
1495 def get_poolfile_by_id(file_id, session=None):
1496     """
1497     Returns a PoolFile objects or None for the given id
1498
1499     @type file_id: int
1500     @param file_id: the id of the file to look for
1501
1502     @rtype: PoolFile or None
1503     @return: either the PoolFile object or None
1504     """
1505
1506     return session.query(PoolFile).get(file_id)
1507
1508 __all__.append('get_poolfile_by_id')
1509
1510 @session_wrapper
1511 def get_poolfile_like_name(filename, session=None):
1512     """
1513     Returns an array of PoolFile objects which are like the given name
1514
1515     @type filename: string
1516     @param filename: the filename of the file to check against the DB
1517
1518     @rtype: array
1519     @return: array of PoolFile objects
1520     """
1521
1522     # TODO: There must be a way of properly using bind parameters with %FOO%
1523     q = session.query(PoolFile).filter(PoolFile.filename.like('%%/%s' % filename))
1524
1525     return q.all()
1526
1527 __all__.append('get_poolfile_like_name')
1528
1529 @session_wrapper
1530 def add_poolfile(filename, datadict, location_id, session=None):
1531     """
1532     Add a new file to the pool
1533
1534     @type filename: string
1535     @param filename: filename
1536
1537     @type datadict: dict
1538     @param datadict: dict with needed data
1539
1540     @type location_id: int
1541     @param location_id: database id of the location
1542
1543     @rtype: PoolFile
1544     @return: the PoolFile object created
1545     """
1546     poolfile = PoolFile()
1547     poolfile.filename = filename
1548     poolfile.filesize = datadict["size"]
1549     poolfile.md5sum = datadict["md5sum"]
1550     poolfile.sha1sum = datadict["sha1sum"]
1551     poolfile.sha256sum = datadict["sha256sum"]
1552     poolfile.location_id = location_id
1553
1554     session.add(poolfile)
1555     # Flush to get a file id (NB: This is not a commit)
1556     session.flush()
1557
1558     return poolfile
1559
1560 __all__.append('add_poolfile')
1561
1562 ################################################################################
1563
1564 class Fingerprint(ORMObject):
1565     def __init__(self, fingerprint = None):
1566         self.fingerprint = fingerprint
1567
1568     def properties(self):
1569         return ['fingerprint', 'fingerprint_id', 'keyring', 'uid', \
1570             'binary_reject']
1571
1572     def not_null_constraints(self):
1573         return ['fingerprint']
1574
1575 __all__.append('Fingerprint')
1576
1577 @session_wrapper
1578 def get_fingerprint(fpr, session=None):
1579     """
1580     Returns Fingerprint object for given fpr.
1581
1582     @type fpr: string
1583     @param fpr: The fpr to find / add
1584
1585     @type session: SQLAlchemy
1586     @param session: Optional SQL session object (a temporary one will be
1587     generated if not supplied).
1588
1589     @rtype: Fingerprint
1590     @return: the Fingerprint object for the given fpr or None
1591     """
1592
1593     q = session.query(Fingerprint).filter_by(fingerprint=fpr)
1594
1595     try:
1596         ret = q.one()
1597     except NoResultFound:
1598         ret = None
1599
1600     return ret
1601
1602 __all__.append('get_fingerprint')
1603
1604 @session_wrapper
1605 def get_or_set_fingerprint(fpr, session=None):
1606     """
1607     Returns Fingerprint object for given fpr.
1608
1609     If no matching fpr is found, a row is inserted.
1610
1611     @type fpr: string
1612     @param fpr: The fpr to find / add
1613
1614     @type session: SQLAlchemy
1615     @param session: Optional SQL session object (a temporary one will be
1616     generated if not supplied).  If not passed, a commit will be performed at
1617     the end of the function, otherwise the caller is responsible for commiting.
1618     A flush will be performed either way.
1619
1620     @rtype: Fingerprint
1621     @return: the Fingerprint object for the given fpr
1622     """
1623
1624     q = session.query(Fingerprint).filter_by(fingerprint=fpr)
1625
1626     try:
1627         ret = q.one()
1628     except NoResultFound:
1629         fingerprint = Fingerprint()
1630         fingerprint.fingerprint = fpr
1631         session.add(fingerprint)
1632         session.commit_or_flush()
1633         ret = fingerprint
1634
1635     return ret
1636
1637 __all__.append('get_or_set_fingerprint')
1638
1639 ################################################################################
1640
1641 # Helper routine for Keyring class
1642 def get_ldap_name(entry):
1643     name = []
1644     for k in ["cn", "mn", "sn"]:
1645         ret = entry.get(k)
1646         if ret and ret[0] != "" and ret[0] != "-":
1647             name.append(ret[0])
1648     return " ".join(name)
1649
1650 ################################################################################
1651
1652 class Keyring(object):
1653     gpg_invocation = "gpg --no-default-keyring --keyring %s" +\
1654                      " --with-colons --fingerprint --fingerprint"
1655
1656     keys = {}
1657     fpr_lookup = {}
1658
1659     def __init__(self, *args, **kwargs):
1660         pass
1661
1662     def __repr__(self):
1663         return '<Keyring %s>' % self.keyring_name
1664
1665     def de_escape_gpg_str(self, txt):
1666         esclist = re.split(r'(\\x..)', txt)
1667         for x in range(1,len(esclist),2):
1668             esclist[x] = "%c" % (int(esclist[x][2:],16))
1669         return "".join(esclist)
1670
1671     def parse_address(self, uid):
1672         """parses uid and returns a tuple of real name and email address"""
1673         import email.Utils
1674         (name, address) = email.Utils.parseaddr(uid)
1675         name = re.sub(r"\s*[(].*[)]", "", name)
1676         name = self.de_escape_gpg_str(name)
1677         if name == "":
1678             name = uid
1679         return (name, address)
1680
1681     def load_keys(self, keyring):
1682         if not self.keyring_id:
1683             raise Exception('Must be initialized with database information')
1684
1685         k = os.popen(self.gpg_invocation % keyring, "r")
1686         key = None
1687         signingkey = False
1688
1689         for line in k.xreadlines():
1690             field = line.split(":")
1691             if field[0] == "pub":
1692                 key = field[4]
1693                 self.keys[key] = {}
1694                 (name, addr) = self.parse_address(field[9])
1695                 if "@" in addr:
1696                     self.keys[key]["email"] = addr
1697                     self.keys[key]["name"] = name
1698                 self.keys[key]["fingerprints"] = []
1699                 signingkey = True
1700             elif key and field[0] == "sub" and len(field) >= 12:
1701                 signingkey = ("s" in field[11])
1702             elif key and field[0] == "uid":
1703                 (name, addr) = self.parse_address(field[9])
1704                 if "email" not in self.keys[key] and "@" in addr:
1705                     self.keys[key]["email"] = addr
1706                     self.keys[key]["name"] = name
1707             elif signingkey and field[0] == "fpr":
1708                 self.keys[key]["fingerprints"].append(field[9])
1709                 self.fpr_lookup[field[9]] = key
1710
1711     def import_users_from_ldap(self, session):
1712         import ldap
1713         cnf = Config()
1714
1715         LDAPDn = cnf["Import-LDAP-Fingerprints::LDAPDn"]
1716         LDAPServer = cnf["Import-LDAP-Fingerprints::LDAPServer"]
1717
1718         l = ldap.open(LDAPServer)
1719         l.simple_bind_s("","")
1720         Attrs = l.search_s(LDAPDn, ldap.SCOPE_ONELEVEL,
1721                "(&(keyfingerprint=*)(gidnumber=%s))" % (cnf["Import-Users-From-Passwd::ValidGID"]),
1722                ["uid", "keyfingerprint", "cn", "mn", "sn"])
1723
1724         ldap_fin_uid_id = {}
1725
1726         byuid = {}
1727         byname = {}
1728
1729         for i in Attrs:
1730             entry = i[1]
1731             uid = entry["uid"][0]
1732             name = get_ldap_name(entry)
1733             fingerprints = entry["keyFingerPrint"]
1734             keyid = None
1735             for f in fingerprints:
1736                 key = self.fpr_lookup.get(f, None)
1737                 if key not in self.keys:
1738                     continue
1739                 self.keys[key]["uid"] = uid
1740
1741                 if keyid != None:
1742                     continue
1743                 keyid = get_or_set_uid(uid, session).uid_id
1744                 byuid[keyid] = (uid, name)
1745                 byname[uid] = (keyid, name)
1746
1747         return (byname, byuid)
1748
1749     def generate_users_from_keyring(self, format, session):
1750         byuid = {}
1751         byname = {}
1752         any_invalid = False
1753         for x in self.keys.keys():
1754             if "email" not in self.keys[x]:
1755                 any_invalid = True
1756                 self.keys[x]["uid"] = format % "invalid-uid"
1757             else:
1758                 uid = format % self.keys[x]["email"]
1759                 keyid = get_or_set_uid(uid, session).uid_id
1760                 byuid[keyid] = (uid, self.keys[x]["name"])
1761                 byname[uid] = (keyid, self.keys[x]["name"])
1762                 self.keys[x]["uid"] = uid
1763
1764         if any_invalid:
1765             uid = format % "invalid-uid"
1766             keyid = get_or_set_uid(uid, session).uid_id
1767             byuid[keyid] = (uid, "ungeneratable user id")
1768             byname[uid] = (keyid, "ungeneratable user id")
1769
1770         return (byname, byuid)
1771
1772 __all__.append('Keyring')
1773
1774 @session_wrapper
1775 def get_keyring(keyring, session=None):
1776     """
1777     If C{keyring} does not have an entry in the C{keyrings} table yet, return None
1778     If C{keyring} already has an entry, simply return the existing Keyring
1779
1780     @type keyring: string
1781     @param keyring: the keyring name
1782
1783     @rtype: Keyring
1784     @return: the Keyring object for this keyring
1785     """
1786
1787     q = session.query(Keyring).filter_by(keyring_name=keyring)
1788
1789     try:
1790         return q.one()
1791     except NoResultFound:
1792         return None
1793
1794 __all__.append('get_keyring')
1795
1796 @session_wrapper
1797 def get_active_keyring_paths(session=None):
1798     """
1799     @rtype: list
1800     @return: list of active keyring paths
1801     """
1802     return [ x.keyring_name for x in session.query(Keyring).filter(Keyring.active == True).order_by(desc(Keyring.priority)).all() ]
1803
1804 __all__.append('get_active_keyring_paths')
1805
1806 @session_wrapper
1807 def get_primary_keyring_path(session=None):
1808     """
1809     Get the full path to the highest priority active keyring
1810
1811     @rtype: str or None
1812     @return: path to the active keyring with the highest priority or None if no
1813              keyring is configured
1814     """
1815     keyrings = get_active_keyring_paths()
1816
1817     if len(keyrings) > 0:
1818         return keyrings[0]
1819     else:
1820         return None
1821
1822 __all__.append('get_primary_keyring_path')
1823
1824 ################################################################################
1825
1826 class KeyringACLMap(object):
1827     def __init__(self, *args, **kwargs):
1828         pass
1829
1830     def __repr__(self):
1831         return '<KeyringACLMap %s>' % self.keyring_acl_map_id
1832
1833 __all__.append('KeyringACLMap')
1834
1835 ################################################################################
1836
1837 class DBChange(object):
1838     def __init__(self, *args, **kwargs):
1839         pass
1840
1841     def __repr__(self):
1842         return '<DBChange %s>' % self.changesname
1843
1844     def clean_from_queue(self):
1845         session = DBConn().session().object_session(self)
1846
1847         # Remove changes_pool_files entries
1848         self.poolfiles = []
1849
1850         # Remove changes_pending_files references
1851         self.files = []
1852
1853         # Clear out of queue
1854         self.in_queue = None
1855         self.approved_for_id = None
1856
1857 __all__.append('DBChange')
1858
1859 @session_wrapper
1860 def get_dbchange(filename, session=None):
1861     """
1862     returns DBChange object for given C{filename}.
1863
1864     @type filename: string
1865     @param filename: the name of the file
1866
1867     @type session: Session
1868     @param session: Optional SQLA session object (a temporary one will be
1869     generated if not supplied)
1870
1871     @rtype: DBChange
1872     @return:  DBChange object for the given filename (C{None} if not present)
1873
1874     """
1875     q = session.query(DBChange).filter_by(changesname=filename)
1876
1877     try:
1878         return q.one()
1879     except NoResultFound:
1880         return None
1881
1882 __all__.append('get_dbchange')
1883
1884 ################################################################################
1885
1886 class Location(ORMObject):
1887     def __init__(self, path = None, component = None):
1888         self.path = path
1889         self.component = component
1890         # the column 'type' should go away, see comment at mapper
1891         self.archive_type = 'pool'
1892
1893     def properties(self):
1894         return ['path', 'location_id', 'archive_type', 'component', \
1895             'files_count']
1896
1897     def not_null_constraints(self):
1898         return ['path', 'archive_type']
1899
1900 __all__.append('Location')
1901
1902 @session_wrapper
1903 def get_location(location, component=None, archive=None, session=None):
1904     """
1905     Returns Location object for the given combination of location, component
1906     and archive
1907
1908     @type location: string
1909     @param location: the path of the location, e.g. I{/srv/ftp-master.debian.org/ftp/pool/}
1910
1911     @type component: string
1912     @param component: the component name (if None, no restriction applied)
1913
1914     @type archive: string
1915     @param archive: the archive name (if None, no restriction applied)
1916
1917     @rtype: Location / None
1918     @return: Either a Location object or None if one can't be found
1919     """
1920
1921     q = session.query(Location).filter_by(path=location)
1922
1923     if archive is not None:
1924         q = q.join(Archive).filter_by(archive_name=archive)
1925
1926     if component is not None:
1927         q = q.join(Component).filter_by(component_name=component)
1928
1929     try:
1930         return q.one()
1931     except NoResultFound:
1932         return None
1933
1934 __all__.append('get_location')
1935
1936 ################################################################################
1937
1938 class Maintainer(ORMObject):
1939     def __init__(self, name = None):
1940         self.name = name
1941
1942     def properties(self):
1943         return ['name', 'maintainer_id']
1944
1945     def not_null_constraints(self):
1946         return ['name']
1947
1948     def get_split_maintainer(self):
1949         if not hasattr(self, 'name') or self.name is None:
1950             return ('', '', '', '')
1951
1952         return fix_maintainer(self.name.strip())
1953
1954 __all__.append('Maintainer')
1955
1956 @session_wrapper
1957 def get_or_set_maintainer(name, session=None):
1958     """
1959     Returns Maintainer object for given maintainer name.
1960
1961     If no matching maintainer name is found, a row is inserted.
1962
1963     @type name: string
1964     @param name: The maintainer name to add
1965
1966     @type session: SQLAlchemy
1967     @param session: Optional SQL session object (a temporary one will be
1968     generated if not supplied).  If not passed, a commit will be performed at
1969     the end of the function, otherwise the caller is responsible for commiting.
1970     A flush will be performed either way.
1971
1972     @rtype: Maintainer
1973     @return: the Maintainer object for the given maintainer
1974     """
1975
1976     q = session.query(Maintainer).filter_by(name=name)
1977     try:
1978         ret = q.one()
1979     except NoResultFound:
1980         maintainer = Maintainer()
1981         maintainer.name = name
1982         session.add(maintainer)
1983         session.commit_or_flush()
1984         ret = maintainer
1985
1986     return ret
1987
1988 __all__.append('get_or_set_maintainer')
1989
1990 @session_wrapper
1991 def get_maintainer(maintainer_id, session=None):
1992     """
1993     Return the name of the maintainer behind C{maintainer_id} or None if that
1994     maintainer_id is invalid.
1995
1996     @type maintainer_id: int
1997     @param maintainer_id: the id of the maintainer
1998
1999     @rtype: Maintainer
2000     @return: the Maintainer with this C{maintainer_id}
2001     """
2002
2003     return session.query(Maintainer).get(maintainer_id)
2004
2005 __all__.append('get_maintainer')
2006
2007 ################################################################################
2008
2009 class NewComment(object):
2010     def __init__(self, *args, **kwargs):
2011         pass
2012
2013     def __repr__(self):
2014         return '''<NewComment for '%s %s' (%s)>''' % (self.package, self.version, self.comment_id)
2015
2016 __all__.append('NewComment')
2017
2018 @session_wrapper
2019 def has_new_comment(package, version, session=None):
2020     """
2021     Returns true if the given combination of C{package}, C{version} has a comment.
2022
2023     @type package: string
2024     @param package: name of the package
2025
2026     @type version: string
2027     @param version: package version
2028
2029     @type session: Session
2030     @param session: Optional SQLA session object (a temporary one will be
2031     generated if not supplied)
2032
2033     @rtype: boolean
2034     @return: true/false
2035     """
2036
2037     q = session.query(NewComment)
2038     q = q.filter_by(package=package)
2039     q = q.filter_by(version=version)
2040
2041     return bool(q.count() > 0)
2042
2043 __all__.append('has_new_comment')
2044
2045 @session_wrapper
2046 def get_new_comments(package=None, version=None, comment_id=None, session=None):
2047     """
2048     Returns (possibly empty) list of NewComment objects for the given
2049     parameters
2050
2051     @type package: string (optional)
2052     @param package: name of the package
2053
2054     @type version: string (optional)
2055     @param version: package version
2056
2057     @type comment_id: int (optional)
2058     @param comment_id: An id of a comment
2059
2060     @type session: Session
2061     @param session: Optional SQLA session object (a temporary one will be
2062     generated if not supplied)
2063
2064     @rtype: list
2065     @return: A (possibly empty) list of NewComment objects will be returned
2066     """
2067
2068     q = session.query(NewComment)
2069     if package is not None: q = q.filter_by(package=package)
2070     if version is not None: q = q.filter_by(version=version)
2071     if comment_id is not None: q = q.filter_by(comment_id=comment_id)
2072
2073     return q.all()
2074
2075 __all__.append('get_new_comments')
2076
2077 ################################################################################
2078
2079 class Override(ORMObject):
2080     def __init__(self, package = None, suite = None, component = None, overridetype = None, \
2081         section = None, priority = None):
2082         self.package = package
2083         self.suite = suite
2084         self.component = component
2085         self.overridetype = overridetype
2086         self.section = section
2087         self.priority = priority
2088
2089     def properties(self):
2090         return ['package', 'suite', 'component', 'overridetype', 'section', \
2091             'priority']
2092
2093     def not_null_constraints(self):
2094         return ['package', 'suite', 'component', 'overridetype', 'section']
2095
2096 __all__.append('Override')
2097
2098 @session_wrapper
2099 def get_override(package, suite=None, component=None, overridetype=None, session=None):
2100     """
2101     Returns Override object for the given parameters
2102
2103     @type package: string
2104     @param package: The name of the package
2105
2106     @type suite: string, list or None
2107     @param suite: The name of the suite (or suites if a list) to limit to.  If
2108                   None, don't limit.  Defaults to None.
2109
2110     @type component: string, list or None
2111     @param component: The name of the component (or components if a list) to
2112                       limit to.  If None, don't limit.  Defaults to None.
2113
2114     @type overridetype: string, list or None
2115     @param overridetype: The name of the overridetype (or overridetypes if a list) to
2116                          limit to.  If None, don't limit.  Defaults to None.
2117
2118     @type session: Session
2119     @param session: Optional SQLA session object (a temporary one will be
2120     generated if not supplied)
2121
2122     @rtype: list
2123     @return: A (possibly empty) list of Override objects will be returned
2124     """
2125
2126     q = session.query(Override)
2127     q = q.filter_by(package=package)
2128
2129     if suite is not None:
2130         if not isinstance(suite, list): suite = [suite]
2131         q = q.join(Suite).filter(Suite.suite_name.in_(suite))
2132
2133     if component is not None:
2134         if not isinstance(component, list): component = [component]
2135         q = q.join(Component).filter(Component.component_name.in_(component))
2136
2137     if overridetype is not None:
2138         if not isinstance(overridetype, list): overridetype = [overridetype]
2139         q = q.join(OverrideType).filter(OverrideType.overridetype.in_(overridetype))
2140
2141     return q.all()
2142
2143 __all__.append('get_override')
2144
2145
2146 ################################################################################
2147
2148 class OverrideType(ORMObject):
2149     def __init__(self, overridetype = None):
2150         self.overridetype = overridetype
2151
2152     def properties(self):
2153         return ['overridetype', 'overridetype_id', 'overrides_count']
2154
2155     def not_null_constraints(self):
2156         return ['overridetype']
2157
2158 __all__.append('OverrideType')
2159
2160 @session_wrapper
2161 def get_override_type(override_type, session=None):
2162     """
2163     Returns OverrideType object for given C{override type}.
2164
2165     @type override_type: string
2166     @param override_type: The name of the override type
2167
2168     @type session: Session
2169     @param session: Optional SQLA session object (a temporary one will be
2170     generated if not supplied)
2171
2172     @rtype: int
2173     @return: the database id for the given override type
2174     """
2175
2176     q = session.query(OverrideType).filter_by(overridetype=override_type)
2177
2178     try:
2179         return q.one()
2180     except NoResultFound:
2181         return None
2182
2183 __all__.append('get_override_type')
2184
2185 ################################################################################
2186
2187 class PolicyQueue(object):
2188     def __init__(self, *args, **kwargs):
2189         pass
2190
2191     def __repr__(self):
2192         return '<PolicyQueue %s>' % self.queue_name
2193
2194 __all__.append('PolicyQueue')
2195
2196 @session_wrapper
2197 def get_policy_queue(queuename, session=None):
2198     """
2199     Returns PolicyQueue object for given C{queue name}
2200
2201     @type queuename: string
2202     @param queuename: The name of the queue
2203
2204     @type session: Session
2205     @param session: Optional SQLA session object (a temporary one will be
2206     generated if not supplied)
2207
2208     @rtype: PolicyQueue
2209     @return: PolicyQueue object for the given queue
2210     """
2211
2212     q = session.query(PolicyQueue).filter_by(queue_name=queuename)
2213
2214     try:
2215         return q.one()
2216     except NoResultFound:
2217         return None
2218
2219 __all__.append('get_policy_queue')
2220
2221 @session_wrapper
2222 def get_policy_queue_from_path(pathname, session=None):
2223     """
2224     Returns PolicyQueue object for given C{path name}
2225
2226     @type queuename: string
2227     @param queuename: The path
2228
2229     @type session: Session
2230     @param session: Optional SQLA session object (a temporary one will be
2231     generated if not supplied)
2232
2233     @rtype: PolicyQueue
2234     @return: PolicyQueue object for the given queue
2235     """
2236
2237     q = session.query(PolicyQueue).filter_by(path=pathname)
2238
2239     try:
2240         return q.one()
2241     except NoResultFound:
2242         return None
2243
2244 __all__.append('get_policy_queue_from_path')
2245
2246 ################################################################################
2247
2248 class Priority(ORMObject):
2249     def __init__(self, priority = None, level = None):
2250         self.priority = priority
2251         self.level = level
2252
2253     def properties(self):
2254         return ['priority', 'priority_id', 'level', 'overrides_count']
2255
2256     def not_null_constraints(self):
2257         return ['priority', 'level']
2258
2259     def __eq__(self, val):
2260         if isinstance(val, str):
2261             return (self.priority == val)
2262         # This signals to use the normal comparison operator
2263         return NotImplemented
2264
2265     def __ne__(self, val):
2266         if isinstance(val, str):
2267             return (self.priority != val)
2268         # This signals to use the normal comparison operator
2269         return NotImplemented
2270
2271 __all__.append('Priority')
2272
2273 @session_wrapper
2274 def get_priority(priority, session=None):
2275     """
2276     Returns Priority object for given C{priority name}.
2277
2278     @type priority: string
2279     @param priority: The name of the priority
2280
2281     @type session: Session
2282     @param session: Optional SQLA session object (a temporary one will be
2283     generated if not supplied)
2284
2285     @rtype: Priority
2286     @return: Priority object for the given priority
2287     """
2288
2289     q = session.query(Priority).filter_by(priority=priority)
2290
2291     try:
2292         return q.one()
2293     except NoResultFound:
2294         return None
2295
2296 __all__.append('get_priority')
2297
2298 @session_wrapper
2299 def get_priorities(session=None):
2300     """
2301     Returns dictionary of priority names -> id mappings
2302
2303     @type session: Session
2304     @param session: Optional SQL session object (a temporary one will be
2305     generated if not supplied)
2306
2307     @rtype: dictionary
2308     @return: dictionary of priority names -> id mappings
2309     """
2310
2311     ret = {}
2312     q = session.query(Priority)
2313     for x in q.all():
2314         ret[x.priority] = x.priority_id
2315
2316     return ret
2317
2318 __all__.append('get_priorities')
2319
2320 ################################################################################
2321
2322 class Section(ORMObject):
2323     def __init__(self, section = None):
2324         self.section = section
2325
2326     def properties(self):
2327         return ['section', 'section_id', 'overrides_count']
2328
2329     def not_null_constraints(self):
2330         return ['section']
2331
2332     def __eq__(self, val):
2333         if isinstance(val, str):
2334             return (self.section == val)
2335         # This signals to use the normal comparison operator
2336         return NotImplemented
2337
2338     def __ne__(self, val):
2339         if isinstance(val, str):
2340             return (self.section != val)
2341         # This signals to use the normal comparison operator
2342         return NotImplemented
2343
2344 __all__.append('Section')
2345
2346 @session_wrapper
2347 def get_section(section, session=None):
2348     """
2349     Returns Section object for given C{section name}.
2350
2351     @type section: string
2352     @param section: The name of the section
2353
2354     @type session: Session
2355     @param session: Optional SQLA session object (a temporary one will be
2356     generated if not supplied)
2357
2358     @rtype: Section
2359     @return: Section object for the given section name
2360     """
2361
2362     q = session.query(Section).filter_by(section=section)
2363
2364     try:
2365         return q.one()
2366     except NoResultFound:
2367         return None
2368
2369 __all__.append('get_section')
2370
2371 @session_wrapper
2372 def get_sections(session=None):
2373     """
2374     Returns dictionary of section names -> id mappings
2375
2376     @type session: Session
2377     @param session: Optional SQL session object (a temporary one will be
2378     generated if not supplied)
2379
2380     @rtype: dictionary
2381     @return: dictionary of section names -> id mappings
2382     """
2383
2384     ret = {}
2385     q = session.query(Section)
2386     for x in q.all():
2387         ret[x.section] = x.section_id
2388
2389     return ret
2390
2391 __all__.append('get_sections')
2392
2393 ################################################################################
2394
2395 class SrcContents(ORMObject):
2396     def __init__(self, file = None, source = None):
2397         self.file = file
2398         self.source = source
2399
2400     def properties(self):
2401         return ['file', 'source']
2402
2403 __all__.append('SrcContents')
2404
2405 ################################################################################
2406
2407 from debian.debfile import Deb822
2408
2409 # Temporary Deb822 subclass to fix bugs with : handling; see #597249
2410 class Dak822(Deb822):
2411     def _internal_parser(self, sequence, fields=None):
2412         # The key is non-whitespace, non-colon characters before any colon.
2413         key_part = r"^(?P<key>[^: \t\n\r\f\v]+)\s*:\s*"
2414         single = re.compile(key_part + r"(?P<data>\S.*?)\s*$")
2415         multi = re.compile(key_part + r"$")
2416         multidata = re.compile(r"^\s(?P<data>.+?)\s*$")
2417
2418         wanted_field = lambda f: fields is None or f in fields
2419
2420         if isinstance(sequence, basestring):
2421             sequence = sequence.splitlines()
2422
2423         curkey = None
2424         content = ""
2425         for line in self.gpg_stripped_paragraph(sequence):
2426             m = single.match(line)
2427             if m:
2428                 if curkey:
2429                     self[curkey] = content
2430
2431                 if not wanted_field(m.group('key')):
2432                     curkey = None
2433                     continue
2434
2435                 curkey = m.group('key')
2436                 content = m.group('data')
2437                 continue
2438
2439             m = multi.match(line)
2440             if m:
2441                 if curkey:
2442                     self[curkey] = content
2443
2444                 if not wanted_field(m.group('key')):
2445                     curkey = None
2446                     continue
2447
2448                 curkey = m.group('key')
2449                 content = ""
2450                 continue
2451
2452             m = multidata.match(line)
2453             if m:
2454                 content += '\n' + line # XXX not m.group('data')?
2455                 continue
2456
2457         if curkey:
2458             self[curkey] = content
2459
2460
2461 class DBSource(ORMObject):
2462     def __init__(self, source = None, version = None, maintainer = None, \
2463         changedby = None, poolfile = None, install_date = None):
2464         self.source = source
2465         self.version = version
2466         self.maintainer = maintainer
2467         self.changedby = changedby
2468         self.poolfile = poolfile
2469         self.install_date = install_date
2470
2471     @property
2472     def pkid(self):
2473         return self.source_id
2474
2475     def properties(self):
2476         return ['source', 'source_id', 'maintainer', 'changedby', \
2477             'fingerprint', 'poolfile', 'version', 'suites_count', \
2478             'install_date', 'binaries_count', 'uploaders_count']
2479
2480     def not_null_constraints(self):
2481         return ['source', 'version', 'install_date', 'maintainer', \
2482             'changedby', 'poolfile', 'install_date']
2483
2484     def read_control_fields(self):
2485         '''
2486         Reads the control information from a dsc
2487
2488         @rtype: tuple
2489         @return: fields is the dsc information in a dictionary form
2490         '''
2491         fullpath = self.poolfile.fullpath
2492         fields = Dak822(open(self.poolfile.fullpath, 'r'))
2493         return fields
2494
2495     metadata = association_proxy('key', 'value')
2496
2497     def get_component_name(self):
2498         return self.poolfile.location.component.component_name
2499
2500     def scan_contents(self):
2501         '''
2502         Returns a set of names for non directories. The path names are
2503         normalized after converting them from either utf-8 or iso8859-1
2504         encoding.
2505         '''
2506         fullpath = self.poolfile.fullpath
2507         from daklib.contents import UnpackedSource
2508         unpacked = UnpackedSource(fullpath)
2509         fileset = set()
2510         for name in unpacked.get_all_filenames():
2511             # enforce proper utf-8 encoding
2512             try:
2513                 name.decode('utf-8')
2514             except UnicodeDecodeError:
2515                 name = name.decode('iso8859-1').encode('utf-8')
2516             fileset.add(name)
2517         return fileset
2518
2519 __all__.append('DBSource')
2520
2521 @session_wrapper
2522 def source_exists(source, source_version, suites = ["any"], session=None):
2523     """
2524     Ensure that source exists somewhere in the archive for the binary
2525     upload being processed.
2526       1. exact match     => 1.0-3
2527       2. bin-only NMU    => 1.0-3+b1 , 1.0-3.1+b1
2528
2529     @type source: string
2530     @param source: source name
2531
2532     @type source_version: string
2533     @param source_version: expected source version
2534
2535     @type suites: list
2536     @param suites: list of suites to check in, default I{any}
2537
2538     @type session: Session
2539     @param session: Optional SQLA session object (a temporary one will be
2540     generated if not supplied)
2541
2542     @rtype: int
2543     @return: returns 1 if a source with expected version is found, otherwise 0
2544
2545     """
2546
2547     cnf = Config()
2548     ret = True
2549
2550     from daklib.regexes import re_bin_only_nmu
2551     orig_source_version = re_bin_only_nmu.sub('', source_version)
2552
2553     for suite in suites:
2554         q = session.query(DBSource).filter_by(source=source). \
2555             filter(DBSource.version.in_([source_version, orig_source_version]))
2556         if suite != "any":
2557             # source must exist in 'suite' or a suite that is enhanced by 'suite'
2558             s = get_suite(suite, session)
2559             enhances_vcs = session.query(VersionCheck).filter(VersionCheck.suite==s).filter_by(check='Enhances')
2560             considered_suites = [ vc.reference for vc in enhances_vcs ]
2561             considered_suites.append(s)
2562
2563             q = q.filter(DBSource.suites.any(Suite.suite_id.in_([s.suite_id for s in considered_suites])))
2564
2565         if q.count() > 0:
2566             continue
2567
2568         # No source found so return not ok
2569         ret = False
2570
2571     return ret
2572
2573 __all__.append('source_exists')
2574
2575 @session_wrapper
2576 def get_suites_source_in(source, session=None):
2577     """
2578     Returns list of Suite objects which given C{source} name is in
2579
2580     @type source: str
2581     @param source: DBSource package name to search for
2582
2583     @rtype: list
2584     @return: list of Suite objects for the given source
2585     """
2586
2587     return session.query(Suite).filter(Suite.sources.any(source=source)).all()
2588
2589 __all__.append('get_suites_source_in')
2590
2591 @session_wrapper
2592 def get_sources_from_name(source, version=None, dm_upload_allowed=None, session=None):
2593     """
2594     Returns list of DBSource objects for given C{source} name and other parameters
2595
2596     @type source: str
2597     @param source: DBSource package name to search for
2598
2599     @type version: str or None
2600     @param version: DBSource version name to search for or None if not applicable
2601
2602     @type dm_upload_allowed: bool
2603     @param dm_upload_allowed: If None, no effect.  If True or False, only
2604     return packages with that dm_upload_allowed setting
2605
2606     @type session: Session
2607     @param session: Optional SQL session object (a temporary one will be
2608     generated if not supplied)
2609
2610     @rtype: list
2611     @return: list of DBSource objects for the given name (may be empty)
2612     """
2613
2614     q = session.query(DBSource).filter_by(source=source)
2615
2616     if version is not None:
2617         q = q.filter_by(version=version)
2618
2619     if dm_upload_allowed is not None:
2620         q = q.filter_by(dm_upload_allowed=dm_upload_allowed)
2621
2622     return q.all()
2623
2624 __all__.append('get_sources_from_name')
2625
2626 # FIXME: This function fails badly if it finds more than 1 source package and
2627 # its implementation is trivial enough to be inlined.
2628 @session_wrapper
2629 def get_source_in_suite(source, suite, session=None):
2630     """
2631     Returns a DBSource object for a combination of C{source} and C{suite}.
2632
2633       - B{source} - source package name, eg. I{mailfilter}, I{bbdb}, I{glibc}
2634       - B{suite} - a suite name, eg. I{unstable}
2635
2636     @type source: string
2637     @param source: source package name
2638
2639     @type suite: string
2640     @param suite: the suite name
2641
2642     @rtype: string
2643     @return: the version for I{source} in I{suite}
2644
2645     """
2646
2647     q = get_suite(suite, session).get_sources(source)
2648     try:
2649         return q.one()
2650     except NoResultFound:
2651         return None
2652
2653 __all__.append('get_source_in_suite')
2654
2655 @session_wrapper
2656 def import_metadata_into_db(obj, session=None):
2657     """
2658     This routine works on either DBBinary or DBSource objects and imports
2659     their metadata into the database
2660     """
2661     fields = obj.read_control_fields()
2662     for k in fields.keys():
2663         try:
2664             # Try raw ASCII
2665             val = str(fields[k])
2666         except UnicodeEncodeError:
2667             # Fall back to UTF-8
2668             try:
2669                 val = fields[k].encode('utf-8')
2670             except UnicodeEncodeError:
2671                 # Finally try iso8859-1
2672                 val = fields[k].encode('iso8859-1')
2673                 # Otherwise we allow the exception to percolate up and we cause
2674                 # a reject as someone is playing silly buggers
2675
2676         obj.metadata[get_or_set_metadatakey(k, session)] = val
2677
2678     session.commit_or_flush()
2679
2680 __all__.append('import_metadata_into_db')
2681
2682
2683 ################################################################################
2684
2685 def split_uploaders(uploaders_list):
2686     '''
2687     Split the Uploaders field into the individual uploaders and yield each of
2688     them. Beware: email addresses might contain commas.
2689     '''
2690     import re
2691     for uploader in re.sub(">[ ]*,", ">\t", uploaders_list).split("\t"):
2692         yield uploader.strip()
2693
2694 @session_wrapper
2695 def add_dsc_to_db(u, filename, session=None):
2696     entry = u.pkg.files[filename]
2697     source = DBSource()
2698     pfs = []
2699
2700     source.source = u.pkg.dsc["source"]
2701     source.version = u.pkg.dsc["version"] # NB: not files[file]["version"], that has no epoch
2702     source.maintainer_id = get_or_set_maintainer(u.pkg.dsc["maintainer"], session).maintainer_id
2703     # If Changed-By isn't available, fall back to maintainer
2704     if u.pkg.changes.has_key("changed-by"):
2705         source.changedby_id = get_or_set_maintainer(u.pkg.changes["changed-by"], session).maintainer_id
2706     else:
2707         source.changedby_id = get_or_set_maintainer(u.pkg.dsc["maintainer"], session).maintainer_id
2708     source.fingerprint_id = get_or_set_fingerprint(u.pkg.changes["fingerprint"], session).fingerprint_id
2709     source.install_date = datetime.now().date()
2710
2711     dsc_component = entry["component"]
2712     dsc_location_id = entry["location id"]
2713
2714     source.dm_upload_allowed = (u.pkg.dsc.get("dm-upload-allowed", '') == "yes")
2715
2716     # Set up a new poolfile if necessary
2717     if not entry.has_key("files id") or not entry["files id"]:
2718         filename = entry["pool name"] + filename
2719         poolfile = add_poolfile(filename, entry, dsc_location_id, session)
2720         session.flush()
2721         pfs.append(poolfile)
2722         entry["files id"] = poolfile.file_id
2723
2724     source.poolfile_id = entry["files id"]
2725     session.add(source)
2726
2727     suite_names = u.pkg.changes["distribution"].keys()
2728     source.suites = session.query(Suite). \
2729         filter(Suite.suite_name.in_(suite_names)).all()
2730
2731     # Add the source files to the DB (files and dsc_files)
2732     dscfile = DSCFile()
2733     dscfile.source_id = source.source_id
2734     dscfile.poolfile_id = entry["files id"]
2735     session.add(dscfile)
2736
2737     for dsc_file, dentry in u.pkg.dsc_files.items():
2738         df = DSCFile()
2739         df.source_id = source.source_id
2740
2741         # If the .orig tarball is already in the pool, it's
2742         # files id is stored in dsc_files by check_dsc().
2743         files_id = dentry.get("files id", None)
2744
2745         # Find the entry in the files hash
2746         # TODO: Bail out here properly
2747         dfentry = None
2748         for f, e in u.pkg.files.items():
2749             if f == dsc_file:
2750                 dfentry = e
2751                 break
2752
2753         if files_id is None:
2754             filename = dfentry["pool name"] + dsc_file
2755
2756             (found, obj) = check_poolfile(filename, dentry["size"], dentry["md5sum"], dsc_location_id)
2757             # FIXME: needs to check for -1/-2 and or handle exception
2758             if found and obj is not None:
2759                 files_id = obj.file_id
2760                 pfs.append(obj)
2761
2762             # If still not found, add it
2763             if files_id is None:
2764                 # HACK: Force sha1sum etc into dentry
2765                 dentry["sha1sum"] = dfentry["sha1sum"]
2766                 dentry["sha256sum"] = dfentry["sha256sum"]
2767                 poolfile = add_poolfile(filename, dentry, dsc_location_id, session)
2768                 pfs.append(poolfile)
2769                 files_id = poolfile.file_id
2770         else:
2771             poolfile = get_poolfile_by_id(files_id, session)
2772             if poolfile is None:
2773                 utils.fubar("INTERNAL ERROR. Found no poolfile with id %d" % files_id)
2774             pfs.append(poolfile)
2775
2776         df.poolfile_id = files_id
2777         session.add(df)
2778
2779     # Add the src_uploaders to the DB
2780     session.flush()
2781     session.refresh(source)
2782     source.uploaders = [source.maintainer]
2783     if u.pkg.dsc.has_key("uploaders"):
2784         for up in split_uploaders(u.pkg.dsc["uploaders"]):
2785             source.uploaders.append(get_or_set_maintainer(up, session))
2786
2787     session.flush()
2788
2789     return source, dsc_component, dsc_location_id, pfs
2790
2791 __all__.append('add_dsc_to_db')
2792
2793 @session_wrapper
2794 def add_deb_to_db(u, filename, session=None):
2795     """
2796     Contrary to what you might expect, this routine deals with both
2797     debs and udebs.  That info is in 'dbtype', whilst 'type' is
2798     'deb' for both of them
2799     """
2800     cnf = Config()
2801     entry = u.pkg.files[filename]
2802
2803     bin = DBBinary()
2804     bin.package = entry["package"]
2805     bin.version = entry["version"]
2806     bin.maintainer_id = get_or_set_maintainer(entry["maintainer"], session).maintainer_id
2807     bin.fingerprint_id = get_or_set_fingerprint(u.pkg.changes["fingerprint"], session).fingerprint_id
2808     bin.arch_id = get_architecture(entry["architecture"], session).arch_id
2809     bin.binarytype = entry["dbtype"]
2810
2811     # Find poolfile id
2812     filename = entry["pool name"] + filename
2813     fullpath = os.path.join(cnf["Dir::Pool"], filename)
2814     if not entry.get("location id", None):
2815         entry["location id"] = get_location(cnf["Dir::Pool"], entry["component"], session=session).location_id
2816
2817     if entry.get("files id", None):
2818         poolfile = get_poolfile_by_id(bin.poolfile_id)
2819         bin.poolfile_id = entry["files id"]
2820     else:
2821         poolfile = add_poolfile(filename, entry, entry["location id"], session)
2822         bin.poolfile_id = entry["files id"] = poolfile.file_id
2823
2824     # Find source id
2825     bin_sources = get_sources_from_name(entry["source package"], entry["source version"], session=session)
2826     if len(bin_sources) != 1:
2827         raise NoSourceFieldError, "Unable to find a unique source id for %s (%s), %s, file %s, type %s, signed by %s" % \
2828                                   (bin.package, bin.version, entry["architecture"],
2829                                    filename, bin.binarytype, u.pkg.changes["fingerprint"])
2830
2831     bin.source_id = bin_sources[0].source_id
2832
2833     if entry.has_key("built-using"):
2834         for srcname, version in entry["built-using"]:
2835             exsources = get_sources_from_name(srcname, version, session=session)
2836             if len(exsources) != 1:
2837                 raise NoSourceFieldError, "Unable to find source package (%s = %s) in Built-Using for %s (%s), %s, file %s, type %s, signed by %s" % \
2838                                           (srcname, version, bin.package, bin.version, entry["architecture"],
2839                                            filename, bin.binarytype, u.pkg.changes["fingerprint"])
2840
2841             bin.extra_sources.append(exsources[0])
2842
2843     # Add and flush object so it has an ID
2844     session.add(bin)
2845
2846     suite_names = u.pkg.changes["distribution"].keys()
2847     bin.suites = session.query(Suite). \
2848         filter(Suite.suite_name.in_(suite_names)).all()
2849
2850     session.flush()
2851
2852     # Deal with contents - disabled for now
2853     #contents = copy_temporary_contents(bin.package, bin.version, bin.architecture.arch_string, os.path.basename(filename), None, session)
2854     #if not contents:
2855     #    print "REJECT\nCould not determine contents of package %s" % bin.package
2856     #    session.rollback()
2857     #    raise MissingContents, "No contents stored for package %s, and couldn't determine contents of %s" % (bin.package, filename)
2858
2859     return bin, poolfile
2860
2861 __all__.append('add_deb_to_db')
2862
2863 ################################################################################
2864
2865 class SourceACL(object):
2866     def __init__(self, *args, **kwargs):
2867         pass
2868
2869     def __repr__(self):
2870         return '<SourceACL %s>' % self.source_acl_id
2871
2872 __all__.append('SourceACL')
2873
2874 ################################################################################
2875
2876 class SrcFormat(object):
2877     def __init__(self, *args, **kwargs):
2878         pass
2879
2880     def __repr__(self):
2881         return '<SrcFormat %s>' % (self.format_name)
2882
2883 __all__.append('SrcFormat')
2884
2885 ################################################################################
2886
2887 SUITE_FIELDS = [ ('SuiteName', 'suite_name'),
2888                  ('SuiteID', 'suite_id'),
2889                  ('Version', 'version'),
2890                  ('Origin', 'origin'),
2891                  ('Label', 'label'),
2892                  ('Description', 'description'),
2893                  ('Untouchable', 'untouchable'),
2894                  ('Announce', 'announce'),
2895                  ('Codename', 'codename'),
2896                  ('OverrideCodename', 'overridecodename'),
2897                  ('ValidTime', 'validtime'),
2898                  ('Priority', 'priority'),
2899                  ('NotAutomatic', 'notautomatic'),
2900                  ('CopyChanges', 'copychanges'),
2901                  ('OverrideSuite', 'overridesuite')]
2902
2903 # Why the heck don't we have any UNIQUE constraints in table suite?
2904 # TODO: Add UNIQUE constraints for appropriate columns.
2905 class Suite(ORMObject):
2906     def __init__(self, suite_name = None, version = None):
2907         self.suite_name = suite_name
2908         self.version = version
2909
2910     def properties(self):
2911         return ['suite_name', 'version', 'sources_count', 'binaries_count', \
2912             'overrides_count']
2913
2914     def not_null_constraints(self):
2915         return ['suite_name']
2916
2917     def __eq__(self, val):
2918         if isinstance(val, str):
2919             return (self.suite_name == val)
2920         # This signals to use the normal comparison operator
2921         return NotImplemented
2922
2923     def __ne__(self, val):
2924         if isinstance(val, str):
2925             return (self.suite_name != val)
2926         # This signals to use the normal comparison operator
2927         return NotImplemented
2928
2929     def details(self):
2930         ret = []
2931         for disp, field in SUITE_FIELDS:
2932             val = getattr(self, field, None)
2933             if val is not None:
2934                 ret.append("%s: %s" % (disp, val))
2935
2936         return "\n".join(ret)
2937
2938     def get_architectures(self, skipsrc=False, skipall=False):
2939         """
2940         Returns list of Architecture objects
2941
2942         @type skipsrc: boolean
2943         @param skipsrc: Whether to skip returning the 'source' architecture entry
2944         (Default False)
2945
2946         @type skipall: boolean
2947         @param skipall: Whether to skip returning the 'all' architecture entry
2948         (Default False)
2949
2950         @rtype: list
2951         @return: list of Architecture objects for the given name (may be empty)
2952         """
2953
2954         q = object_session(self).query(Architecture).with_parent(self)
2955         if skipsrc:
2956             q = q.filter(Architecture.arch_string != 'source')
2957         if skipall:
2958             q = q.filter(Architecture.arch_string != 'all')
2959         return q.order_by(Architecture.arch_string).all()
2960
2961     def get_sources(self, source):
2962         """
2963         Returns a query object representing DBSource that is part of C{suite}.
2964
2965           - B{source} - source package name, eg. I{mailfilter}, I{bbdb}, I{glibc}
2966
2967         @type source: string
2968         @param source: source package name
2969
2970         @rtype: sqlalchemy.orm.query.Query
2971         @return: a query of DBSource
2972
2973         """
2974
2975         session = object_session(self)
2976         return session.query(DBSource).filter_by(source = source). \
2977             with_parent(self)
2978
2979     def get_overridesuite(self):
2980         if self.overridesuite is None:
2981             return self
2982         else:
2983             return object_session(self).query(Suite).filter_by(suite_name=self.overridesuite).one()
2984
2985 __all__.append('Suite')
2986
2987 @session_wrapper
2988 def get_suite(suite, session=None):
2989     """
2990     Returns Suite object for given C{suite name}.
2991
2992     @type suite: string
2993     @param suite: The name of the suite
2994
2995     @type session: Session
2996     @param session: Optional SQLA session object (a temporary one will be
2997     generated if not supplied)
2998
2999     @rtype: Suite
3000     @return: Suite object for the requested suite name (None if not present)
3001     """
3002
3003     q = session.query(Suite).filter_by(suite_name=suite)
3004
3005     try:
3006         return q.one()
3007     except NoResultFound:
3008         return None
3009
3010 __all__.append('get_suite')
3011
3012 ################################################################################
3013
3014 @session_wrapper
3015 def get_suite_architectures(suite, skipsrc=False, skipall=False, session=None):
3016     """
3017     Returns list of Architecture objects for given C{suite} name. The list is
3018     empty if suite does not exist.
3019
3020     @type suite: str
3021     @param suite: Suite name to search for
3022
3023     @type skipsrc: boolean
3024     @param skipsrc: Whether to skip returning the 'source' architecture entry
3025     (Default False)
3026
3027     @type skipall: boolean
3028     @param skipall: Whether to skip returning the 'all' architecture entry
3029     (Default False)
3030
3031     @type session: Session
3032     @param session: Optional SQL session object (a temporary one will be
3033     generated if not supplied)
3034
3035     @rtype: list
3036     @return: list of Architecture objects for the given name (may be empty)
3037     """
3038
3039     try:
3040         return get_suite(suite, session).get_architectures(skipsrc, skipall)
3041     except AttributeError:
3042         return []
3043
3044 __all__.append('get_suite_architectures')
3045
3046 ################################################################################
3047
3048 class Uid(ORMObject):
3049     def __init__(self, uid = None, name = None):
3050         self.uid = uid
3051         self.name = name
3052
3053     def __eq__(self, val):
3054         if isinstance(val, str):
3055             return (self.uid == val)
3056         # This signals to use the normal comparison operator
3057         return NotImplemented
3058
3059     def __ne__(self, val):
3060         if isinstance(val, str):
3061             return (self.uid != val)
3062         # This signals to use the normal comparison operator
3063         return NotImplemented
3064
3065     def properties(self):
3066         return ['uid', 'name', 'fingerprint']
3067
3068     def not_null_constraints(self):
3069         return ['uid']
3070
3071 __all__.append('Uid')
3072
3073 @session_wrapper
3074 def get_or_set_uid(uidname, session=None):
3075     """
3076     Returns uid object for given uidname.
3077
3078     If no matching uidname is found, a row is inserted.
3079
3080     @type uidname: string
3081     @param uidname: The uid to add
3082
3083     @type session: SQLAlchemy
3084     @param session: Optional SQL session object (a temporary one will be
3085     generated if not supplied).  If not passed, a commit will be performed at
3086     the end of the function, otherwise the caller is responsible for commiting.
3087
3088     @rtype: Uid
3089     @return: the uid object for the given uidname
3090     """
3091
3092     q = session.query(Uid).filter_by(uid=uidname)
3093
3094     try:
3095         ret = q.one()
3096     except NoResultFound:
3097         uid = Uid()
3098         uid.uid = uidname
3099         session.add(uid)
3100         session.commit_or_flush()
3101         ret = uid
3102
3103     return ret
3104
3105 __all__.append('get_or_set_uid')
3106
3107 @session_wrapper
3108 def get_uid_from_fingerprint(fpr, session=None):
3109     q = session.query(Uid)
3110     q = q.join(Fingerprint).filter_by(fingerprint=fpr)
3111
3112     try:
3113         return q.one()
3114     except NoResultFound:
3115         return None
3116
3117 __all__.append('get_uid_from_fingerprint')
3118
3119 ################################################################################
3120
3121 class UploadBlock(object):
3122     def __init__(self, *args, **kwargs):
3123         pass
3124
3125     def __repr__(self):
3126         return '<UploadBlock %s (%s)>' % (self.source, self.upload_block_id)
3127
3128 __all__.append('UploadBlock')
3129
3130 ################################################################################
3131
3132 class MetadataKey(ORMObject):
3133     def __init__(self, key = None):
3134         self.key = key
3135
3136     def properties(self):
3137         return ['key']
3138
3139     def not_null_constraints(self):
3140         return ['key']
3141
3142 __all__.append('MetadataKey')
3143
3144 @session_wrapper
3145 def get_or_set_metadatakey(keyname, session=None):
3146     """
3147     Returns MetadataKey object for given uidname.
3148
3149     If no matching keyname is found, a row is inserted.
3150
3151     @type uidname: string
3152     @param uidname: The keyname to add
3153
3154     @type session: SQLAlchemy
3155     @param session: Optional SQL session object (a temporary one will be
3156     generated if not supplied).  If not passed, a commit will be performed at
3157     the end of the function, otherwise the caller is responsible for commiting.
3158
3159     @rtype: MetadataKey
3160     @return: the metadatakey object for the given keyname
3161     """
3162
3163     q = session.query(MetadataKey).filter_by(key=keyname)
3164
3165     try:
3166         ret = q.one()
3167     except NoResultFound:
3168         ret = MetadataKey(keyname)
3169         session.add(ret)
3170         session.commit_or_flush()
3171
3172     return ret
3173
3174 __all__.append('get_or_set_metadatakey')
3175
3176 ################################################################################
3177
3178 class BinaryMetadata(ORMObject):
3179     def __init__(self, key = None, value = None, binary = None):
3180         self.key = key
3181         self.value = value
3182         self.binary = binary
3183
3184     def properties(self):
3185         return ['binary', 'key', 'value']
3186
3187     def not_null_constraints(self):
3188         return ['value']
3189
3190 __all__.append('BinaryMetadata')
3191
3192 ################################################################################
3193
3194 class SourceMetadata(ORMObject):
3195     def __init__(self, key = None, value = None, source = None):
3196         self.key = key
3197         self.value = value
3198         self.source = source
3199
3200     def properties(self):
3201         return ['source', 'key', 'value']
3202
3203     def not_null_constraints(self):
3204         return ['value']
3205
3206 __all__.append('SourceMetadata')
3207
3208 ################################################################################
3209
3210 class VersionCheck(ORMObject):
3211     def __init__(self, *args, **kwargs):
3212         pass
3213
3214     def properties(self):
3215         #return ['suite_id', 'check', 'reference_id']
3216         return ['check']
3217
3218     def not_null_constraints(self):
3219         return ['suite', 'check', 'reference']
3220
3221 __all__.append('VersionCheck')
3222
3223 @session_wrapper
3224 def get_version_checks(suite_name, check = None, session = None):
3225     suite = get_suite(suite_name, session)
3226     if not suite:
3227         # Make sure that what we return is iterable so that list comprehensions
3228         # involving this don't cause a traceback
3229         return []
3230     q = session.query(VersionCheck).filter_by(suite=suite)
3231     if check:
3232         q = q.filter_by(check=check)
3233     return q.all()
3234
3235 __all__.append('get_version_checks')
3236
3237 ################################################################################
3238
3239 class DBConn(object):
3240     """
3241     database module init.
3242     """
3243     __shared_state = {}
3244
3245     def __init__(self, *args, **kwargs):
3246         self.__dict__ = self.__shared_state
3247
3248         if not getattr(self, 'initialised', False):
3249             self.initialised = True
3250             self.debug = kwargs.has_key('debug')
3251             self.__createconn()
3252
3253     def __setuptables(self):
3254         tables = (
3255             'architecture',
3256             'archive',
3257             'bin_associations',
3258             'bin_contents',
3259             'binaries',
3260             'binaries_metadata',
3261             'binary_acl',
3262             'binary_acl_map',
3263             'build_queue',
3264             'build_queue_files',
3265             'build_queue_policy_files',
3266             'changelogs_text',
3267             'changes',
3268             'component',
3269             'config',
3270             'changes_pending_binaries',
3271             'changes_pending_files',
3272             'changes_pending_source',
3273             'changes_pending_files_map',
3274             'changes_pending_source_files',
3275             'changes_pool_files',
3276             'dsc_files',
3277             'external_overrides',
3278             'extra_src_references',
3279             'files',
3280             'fingerprint',
3281             'keyrings',
3282             'keyring_acl_map',
3283             'location',
3284             'maintainer',
3285             'metadata_keys',
3286             'new_comments',
3287             # TODO: the maintainer column in table override should be removed.
3288             'override',
3289             'override_type',
3290             'policy_queue',
3291             'priority',
3292             'section',
3293             'source',
3294             'source_acl',
3295             'source_metadata',
3296             'src_associations',
3297             'src_contents',
3298             'src_format',
3299             'src_uploaders',
3300             'suite',
3301             'suite_architectures',
3302             'suite_build_queue_copy',
3303             'suite_src_formats',
3304             'uid',
3305             'upload_blocks',
3306             'version_check',
3307         )
3308
3309         views = (
3310             'almost_obsolete_all_associations',
3311             'almost_obsolete_src_associations',
3312             'any_associations_source',
3313             'bin_associations_binaries',
3314             'binaries_suite_arch',
3315             'binfiles_suite_component_arch',
3316             'changelogs',
3317             'file_arch_suite',
3318             'newest_all_associations',
3319             'newest_any_associations',
3320             'newest_source',
3321             'newest_src_association',
3322             'obsolete_all_associations',
3323             'obsolete_any_associations',
3324             'obsolete_any_by_all_associations',
3325             'obsolete_src_associations',
3326             'source_suite',
3327             'src_associations_bin',
3328             'src_associations_src',
3329             'suite_arch_by_name',
3330         )
3331
3332         for table_name in tables:
3333             table = Table(table_name, self.db_meta, \
3334                 autoload=True, useexisting=True)
3335             setattr(self, 'tbl_%s' % table_name, table)
3336
3337         for view_name in views:
3338             view = Table(view_name, self.db_meta, autoload=True)
3339             setattr(self, 'view_%s' % view_name, view)
3340
3341     def __setupmappers(self):
3342         mapper(Architecture, self.tbl_architecture,
3343             properties = dict(arch_id = self.tbl_architecture.c.id,
3344                suites = relation(Suite, secondary=self.tbl_suite_architectures,
3345                    order_by='suite_name',
3346                    backref=backref('architectures', order_by='arch_string'))),
3347             extension = validator)
3348
3349         mapper(Archive, self.tbl_archive,
3350                properties = dict(archive_id = self.tbl_archive.c.id,
3351                                  archive_name = self.tbl_archive.c.name))
3352
3353         mapper(BuildQueue, self.tbl_build_queue,
3354                properties = dict(queue_id = self.tbl_build_queue.c.id))
3355
3356         mapper(BuildQueueFile, self.tbl_build_queue_files,
3357                properties = dict(buildqueue = relation(BuildQueue, backref='queuefiles'),
3358                                  poolfile = relation(PoolFile, backref='buildqueueinstances')))
3359
3360         mapper(BuildQueuePolicyFile, self.tbl_build_queue_policy_files,
3361                properties = dict(
3362                 build_queue = relation(BuildQueue, backref='policy_queue_files'),
3363                 file = relation(ChangePendingFile, lazy='joined')))
3364
3365         mapper(DBBinary, self.tbl_binaries,
3366                properties = dict(binary_id = self.tbl_binaries.c.id,
3367                                  package = self.tbl_binaries.c.package,
3368                                  version = self.tbl_binaries.c.version,
3369                                  maintainer_id = self.tbl_binaries.c.maintainer,
3370                                  maintainer = relation(Maintainer),
3371                                  source_id = self.tbl_binaries.c.source,
3372                                  source = relation(DBSource, backref='binaries'),
3373                                  arch_id = self.tbl_binaries.c.architecture,
3374                                  architecture = relation(Architecture),
3375                                  poolfile_id = self.tbl_binaries.c.file,
3376                                  poolfile = relation(PoolFile, backref=backref('binary', uselist = False)),
3377                                  binarytype = self.tbl_binaries.c.type,
3378                                  fingerprint_id = self.tbl_binaries.c.sig_fpr,
3379                                  fingerprint = relation(Fingerprint),
3380                                  install_date = self.tbl_binaries.c.install_date,
3381                                  suites = relation(Suite, secondary=self.tbl_bin_associations,
3382                                      backref=backref('binaries', lazy='dynamic')),
3383                                  extra_sources = relation(DBSource, secondary=self.tbl_extra_src_references,
3384                                      backref=backref('extra_binary_references', lazy='dynamic')),
3385                                  key = relation(BinaryMetadata, cascade='all',
3386                                      collection_class=attribute_mapped_collection('key'))),
3387                 extension = validator)
3388
3389         mapper(BinaryACL, self.tbl_binary_acl,
3390                properties = dict(binary_acl_id = self.tbl_binary_acl.c.id))
3391
3392         mapper(BinaryACLMap, self.tbl_binary_acl_map,
3393                properties = dict(binary_acl_map_id = self.tbl_binary_acl_map.c.id,
3394                                  fingerprint = relation(Fingerprint, backref="binary_acl_map"),
3395                                  architecture = relation(Architecture)))
3396
3397         mapper(Component, self.tbl_component,
3398                properties = dict(component_id = self.tbl_component.c.id,
3399                                  component_name = self.tbl_component.c.name),
3400                extension = validator)
3401
3402         mapper(DBConfig, self.tbl_config,
3403                properties = dict(config_id = self.tbl_config.c.id))
3404
3405         mapper(DSCFile, self.tbl_dsc_files,
3406                properties = dict(dscfile_id = self.tbl_dsc_files.c.id,
3407                                  source_id = self.tbl_dsc_files.c.source,
3408                                  source = relation(DBSource),
3409                                  poolfile_id = self.tbl_dsc_files.c.file,
3410                                  poolfile = relation(PoolFile)))
3411
3412         mapper(ExternalOverride, self.tbl_external_overrides,
3413                 properties = dict(
3414                     suite_id = self.tbl_external_overrides.c.suite,
3415                     suite = relation(Suite),
3416                     component_id = self.tbl_external_overrides.c.component,
3417                     component = relation(Component)))
3418
3419         mapper(PoolFile, self.tbl_files,
3420                properties = dict(file_id = self.tbl_files.c.id,
3421                                  filesize = self.tbl_files.c.size,
3422                                  location_id = self.tbl_files.c.location,
3423                                  location = relation(Location,
3424                                      # using lazy='dynamic' in the back
3425                                      # reference because we have A LOT of
3426                                      # files in one location
3427                                      backref=backref('files', lazy='dynamic'))),
3428                 extension = validator)
3429
3430         mapper(Fingerprint, self.tbl_fingerprint,
3431                properties = dict(fingerprint_id = self.tbl_fingerprint.c.id,
3432                                  uid_id = self.tbl_fingerprint.c.uid,
3433                                  uid = relation(Uid),
3434                                  keyring_id = self.tbl_fingerprint.c.keyring,
3435                                  keyring = relation(Keyring),
3436                                  source_acl = relation(SourceACL),
3437                                  binary_acl = relation(BinaryACL)),
3438                extension = validator)
3439
3440         mapper(Keyring, self.tbl_keyrings,
3441                properties = dict(keyring_name = self.tbl_keyrings.c.name,
3442                                  keyring_id = self.tbl_keyrings.c.id))
3443
3444         mapper(DBChange, self.tbl_changes,
3445                properties = dict(change_id = self.tbl_changes.c.id,
3446                                  poolfiles = relation(PoolFile,
3447                                                       secondary=self.tbl_changes_pool_files,
3448                                                       backref="changeslinks"),
3449                                  seen = self.tbl_changes.c.seen,
3450                                  source = self.tbl_changes.c.source,
3451                                  binaries = self.tbl_changes.c.binaries,
3452                                  architecture = self.tbl_changes.c.architecture,
3453                                  distribution = self.tbl_changes.c.distribution,
3454                                  urgency = self.tbl_changes.c.urgency,
3455                                  maintainer = self.tbl_changes.c.maintainer,
3456                                  changedby = self.tbl_changes.c.changedby,
3457                                  date = self.tbl_changes.c.date,
3458                                  version = self.tbl_changes.c.version,
3459                                  files = relation(ChangePendingFile,
3460                                                   secondary=self.tbl_changes_pending_files_map,
3461                                                   backref="changesfile"),
3462                                  in_queue_id = self.tbl_changes.c.in_queue,
3463                                  in_queue = relation(PolicyQueue,
3464                                                      primaryjoin=(self.tbl_changes.c.in_queue==self.tbl_policy_queue.c.id)),
3465                                  approved_for_id = self.tbl_changes.c.approved_for))
3466
3467         mapper(ChangePendingBinary, self.tbl_changes_pending_binaries,
3468                properties = dict(change_pending_binary_id = self.tbl_changes_pending_binaries.c.id))
3469
3470         mapper(ChangePendingFile, self.tbl_changes_pending_files,
3471                properties = dict(change_pending_file_id = self.tbl_changes_pending_files.c.id,
3472                                  filename = self.tbl_changes_pending_files.c.filename,
3473                                  size = self.tbl_changes_pending_files.c.size,
3474                                  md5sum = self.tbl_changes_pending_files.c.md5sum,
3475                                  sha1sum = self.tbl_changes_pending_files.c.sha1sum,
3476                                  sha256sum = self.tbl_changes_pending_files.c.sha256sum))
3477
3478         mapper(ChangePendingSource, self.tbl_changes_pending_source,
3479                properties = dict(change_pending_source_id = self.tbl_changes_pending_source.c.id,
3480                                  change = relation(DBChange),
3481                                  maintainer = relation(Maintainer,
3482                                                        primaryjoin=(self.tbl_changes_pending_source.c.maintainer_id==self.tbl_maintainer.c.id)),
3483                                  changedby = relation(Maintainer,
3484                                                       primaryjoin=(self.tbl_changes_pending_source.c.changedby_id==self.tbl_maintainer.c.id)),
3485                                  fingerprint = relation(Fingerprint),
3486                                  source_files = relation(ChangePendingFile,
3487                                                          secondary=self.tbl_changes_pending_source_files,
3488                                                          backref="pending_sources")))
3489
3490
3491         mapper(KeyringACLMap, self.tbl_keyring_acl_map,
3492                properties = dict(keyring_acl_map_id = self.tbl_keyring_acl_map.c.id,
3493                                  keyring = relation(Keyring, backref="keyring_acl_map"),
3494                                  architecture = relation(Architecture)))
3495
3496         mapper(Location, self.tbl_location,
3497                properties = dict(location_id = self.tbl_location.c.id,
3498                                  component_id = self.tbl_location.c.component,
3499                                  component = relation(Component, backref='location'),
3500                                  archive_id = self.tbl_location.c.archive,
3501                                  archive = relation(Archive),
3502                                  # FIXME: the 'type' column is old cruft and
3503                                  # should be removed in the future.
3504                                  archive_type = self.tbl_location.c.type),
3505                extension = validator)
3506
3507         mapper(Maintainer, self.tbl_maintainer,
3508                properties = dict(maintainer_id = self.tbl_maintainer.c.id,
3509                    maintains_sources = relation(DBSource, backref='maintainer',
3510                        primaryjoin=(self.tbl_maintainer.c.id==self.tbl_source.c.maintainer)),
3511                    changed_sources = relation(DBSource, backref='changedby',
3512                        primaryjoin=(self.tbl_maintainer.c.id==self.tbl_source.c.changedby))),
3513                 extension = validator)
3514
3515         mapper(NewComment, self.tbl_new_comments,
3516                properties = dict(comment_id = self.tbl_new_comments.c.id))
3517
3518         mapper(Override, self.tbl_override,
3519                properties = dict(suite_id = self.tbl_override.c.suite,
3520                                  suite = relation(Suite, \
3521                                     backref=backref('overrides', lazy='dynamic')),
3522                                  package = self.tbl_override.c.package,
3523                                  component_id = self.tbl_override.c.component,
3524                                  component = relation(Component, \
3525                                     backref=backref('overrides', lazy='dynamic')),
3526                                  priority_id = self.tbl_override.c.priority,
3527                                  priority = relation(Priority, \
3528                                     backref=backref('overrides', lazy='dynamic')),
3529                                  section_id = self.tbl_override.c.section,
3530                                  section = relation(Section, \
3531                                     backref=backref('overrides', lazy='dynamic')),
3532                                  overridetype_id = self.tbl_override.c.type,
3533                                  overridetype = relation(OverrideType, \
3534                                     backref=backref('overrides', lazy='dynamic'))))
3535
3536         mapper(OverrideType, self.tbl_override_type,
3537                properties = dict(overridetype = self.tbl_override_type.c.type,
3538                                  overridetype_id = self.tbl_override_type.c.id))
3539
3540         mapper(PolicyQueue, self.tbl_policy_queue,
3541                properties = dict(policy_queue_id = self.tbl_policy_queue.c.id))
3542
3543         mapper(Priority, self.tbl_priority,
3544                properties = dict(priority_id = self.tbl_priority.c.id))
3545
3546         mapper(Section, self.tbl_section,
3547                properties = dict(section_id = self.tbl_section.c.id,
3548                                  section=self.tbl_section.c.section))
3549
3550         mapper(DBSource, self.tbl_source,
3551                properties = dict(source_id = self.tbl_source.c.id,
3552                                  version = self.tbl_source.c.version,
3553                                  maintainer_id = self.tbl_source.c.maintainer,
3554                                  poolfile_id = self.tbl_source.c.file,
3555                                  poolfile = relation(PoolFile, backref=backref('source', uselist = False)),
3556                                  fingerprint_id = self.tbl_source.c.sig_fpr,
3557                                  fingerprint = relation(Fingerprint),
3558                                  changedby_id = self.tbl_source.c.changedby,
3559                                  srcfiles = relation(DSCFile,
3560                                                      primaryjoin=(self.tbl_source.c.id==self.tbl_dsc_files.c.source)),
3561                                  suites = relation(Suite, secondary=self.tbl_src_associations,
3562                                      backref=backref('sources', lazy='dynamic')),
3563                                  uploaders = relation(Maintainer,
3564                                      secondary=self.tbl_src_uploaders),
3565                                  key = relation(SourceMetadata, cascade='all',
3566                                      collection_class=attribute_mapped_collection('key'))),
3567                extension = validator)
3568
3569         mapper(SourceACL, self.tbl_source_acl,
3570                properties = dict(source_acl_id = self.tbl_source_acl.c.id))
3571
3572         mapper(SrcFormat, self.tbl_src_format,
3573                properties = dict(src_format_id = self.tbl_src_format.c.id,
3574                                  format_name = self.tbl_src_format.c.format_name))
3575
3576         mapper(Suite, self.tbl_suite,
3577                properties = dict(suite_id = self.tbl_suite.c.id,
3578                                  policy_queue = relation(PolicyQueue),
3579                                  copy_queues = relation(BuildQueue,
3580                                      secondary=self.tbl_suite_build_queue_copy),
3581                                  srcformats = relation(SrcFormat, secondary=self.tbl_suite_src_formats,
3582                                      backref=backref('suites', lazy='dynamic'))),
3583                 extension = validator)
3584
3585         mapper(Uid, self.tbl_uid,
3586                properties = dict(uid_id = self.tbl_uid.c.id,
3587                                  fingerprint = relation(Fingerprint)),
3588                extension = validator)
3589
3590         mapper(UploadBlock, self.tbl_upload_blocks,
3591                properties = dict(upload_block_id = self.tbl_upload_blocks.c.id,
3592                                  fingerprint = relation(Fingerprint, backref="uploadblocks"),
3593                                  uid = relation(Uid, backref="uploadblocks")))
3594
3595         mapper(BinContents, self.tbl_bin_contents,
3596             properties = dict(
3597                 binary = relation(DBBinary,
3598                     backref=backref('contents', lazy='dynamic', cascade='all')),
3599                 file = self.tbl_bin_contents.c.file))
3600
3601         mapper(SrcContents, self.tbl_src_contents,
3602             properties = dict(
3603                 source = relation(DBSource,
3604                     backref=backref('contents', lazy='dynamic', cascade='all')),
3605                 file = self.tbl_src_contents.c.file))
3606
3607         mapper(MetadataKey, self.tbl_metadata_keys,
3608             properties = dict(
3609                 key_id = self.tbl_metadata_keys.c.key_id,
3610                 key = self.tbl_metadata_keys.c.key))
3611
3612         mapper(BinaryMetadata, self.tbl_binaries_metadata,
3613             properties = dict(
3614                 binary_id = self.tbl_binaries_metadata.c.bin_id,
3615                 binary = relation(DBBinary),
3616                 key_id = self.tbl_binaries_metadata.c.key_id,
3617                 key = relation(MetadataKey),
3618                 value = self.tbl_binaries_metadata.c.value))
3619
3620         mapper(SourceMetadata, self.tbl_source_metadata,
3621             properties = dict(
3622                 source_id = self.tbl_source_metadata.c.src_id,
3623                 source = relation(DBSource),
3624                 key_id = self.tbl_source_metadata.c.key_id,
3625                 key = relation(MetadataKey),
3626                 value = self.tbl_source_metadata.c.value))
3627
3628         mapper(VersionCheck, self.tbl_version_check,
3629             properties = dict(
3630                 suite_id = self.tbl_version_check.c.suite,
3631                 suite = relation(Suite, primaryjoin=self.tbl_version_check.c.suite==self.tbl_suite.c.id),
3632                 reference_id = self.tbl_version_check.c.reference,
3633                 reference = relation(Suite, primaryjoin=self.tbl_version_check.c.reference==self.tbl_suite.c.id, lazy='joined')))
3634
3635     ## Connection functions
3636     def __createconn(self):
3637         from config import Config
3638         cnf = Config()
3639         if cnf.has_key("DB::Service"):
3640             connstr = "postgresql://service=%s" % cnf["DB::Service"]
3641         elif cnf.has_key("DB::Host"):
3642             # TCP/IP
3643             connstr = "postgresql://%s" % cnf["DB::Host"]
3644             if cnf.has_key("DB::Port") and cnf["DB::Port"] != "-1":
3645                 connstr += ":%s" % cnf["DB::Port"]
3646             connstr += "/%s" % cnf["DB::Name"]
3647         else:
3648             # Unix Socket
3649             connstr = "postgresql:///%s" % cnf["DB::Name"]
3650             if cnf.has_key("DB::Port") and cnf["DB::Port"] != "-1":
3651                 connstr += "?port=%s" % cnf["DB::Port"]
3652
3653         engine_args = { 'echo': self.debug }
3654         if cnf.has_key('DB::PoolSize'):
3655             engine_args['pool_size'] = int(cnf['DB::PoolSize'])
3656         if cnf.has_key('DB::MaxOverflow'):
3657             engine_args['max_overflow'] = int(cnf['DB::MaxOverflow'])
3658         if sa_major_version == '0.6' and cnf.has_key('DB::Unicode') and \
3659             cnf['DB::Unicode'] == 'false':
3660             engine_args['use_native_unicode'] = False
3661
3662         # Monkey patch a new dialect in in order to support service= syntax
3663         import sqlalchemy.dialects.postgresql
3664         from sqlalchemy.dialects.postgresql.psycopg2 import PGDialect_psycopg2
3665         class PGDialect_psycopg2_dak(PGDialect_psycopg2):
3666             def create_connect_args(self, url):
3667                 if str(url).startswith('postgresql://service='):
3668                     # Eww
3669                     servicename = str(url)[21:]
3670                     return (['service=%s' % servicename], {})
3671                 else:
3672                     return PGDialect_psycopg2.create_connect_args(self, url)
3673
3674         sqlalchemy.dialects.postgresql.base.dialect = PGDialect_psycopg2_dak
3675
3676         try:
3677             self.db_pg   = create_engine(connstr, **engine_args)
3678             self.db_meta = MetaData()
3679             self.db_meta.bind = self.db_pg
3680             self.db_smaker = sessionmaker(bind=self.db_pg,
3681                                           autoflush=True,
3682                                           autocommit=False)
3683
3684             self.__setuptables()
3685             self.__setupmappers()
3686
3687         except OperationalError as e:
3688             import utils
3689             utils.fubar("Cannot connect to database (%s)" % str(e))
3690
3691         self.pid = os.getpid()
3692
3693     def session(self, work_mem = 0):
3694         '''
3695         Returns a new session object. If a work_mem parameter is provided a new
3696         transaction is started and the work_mem parameter is set for this
3697         transaction. The work_mem parameter is measured in MB. A default value
3698         will be used if the parameter is not set.
3699         '''
3700         # reinitialize DBConn in new processes
3701         if self.pid != os.getpid():
3702             clear_mappers()
3703             self.__createconn()
3704         session = self.db_smaker()
3705         if work_mem > 0:
3706             session.execute("SET LOCAL work_mem TO '%d MB'" % work_mem)
3707         return session
3708
3709 __all__.append('DBConn')
3710
3711