dak/update_db.py

   1 #!/usr/bin/env python
   2
   3 """ Database Update Main Script
   4
   5 @contact: Debian FTP Master <ftpmaster@debian.org>
   6 # Copyright (C) 2008  Michael Casadevall <mcasadevall@debian.org>
   7 @license: GNU General Public License version 2 or later
   8 """
   9
  10 # This program is free software; you can redistribute it and/or modify
  11 # it under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 2 of the License, or
  13 # (at your option) any later version.
  14
  15 # This program is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 # GNU General Public License for more details.
  19
  20 # You should have received a copy of the GNU General Public License
  21 # along with this program; if not, write to the Free Software
  22 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23
  24 ################################################################################
  25
  26 # <Ganneff> when do you have it written?
  27 # <NCommander> Ganneff, after you make my debian account
  28 # <Ganneff> blackmail wont work
  29 # <NCommander> damn it
  30
  31 ################################################################################
  32
  33 import psycopg2
  34 import sys
  35 import fcntl
  36 import os
  37 import apt_pkg
  38 import time
  39 import errno
  40
  41 from daklib import utils
  42 from daklib.dak_exceptions import DBUpdateError
  43
  44 ################################################################################
  45
  46 Cnf = None
  47 required_database_schema = 15
  48
  49 ################################################################################
  50
  51 class UpdateDB:
  52     def usage (self, exit_code=0):
  53         print """Usage: dak update-db
  54 Updates dak's database schema to the lastest version. You should disable crontabs while this is running
  55
  56   -h, --help                show this help and exit."""
  57         sys.exit(exit_code)
  58
  59
  60 ################################################################################
  61
  62     def update_db_to_zero(self):
  63         """ This function will attempt to update a pre-zero database schema to zero """
  64
  65         # First, do the sure thing, and create the configuration table
  66         try:
  67             print "Creating configuration table ..."
  68             c = self.db.cursor()
  69             c.execute("""CREATE TABLE config (
  70                                   id SERIAL PRIMARY KEY NOT NULL,
  71                                   name TEXT UNIQUE NOT NULL,
  72                                   value TEXT
  73                                 );""")
  74             c.execute("INSERT INTO config VALUES ( nextval('config_id_seq'), 'db_revision', '0')")
  75             self.db.commit()
  76
  77         except psycopg2.ProgrammingError:
  78             self.db.rollback()
  79             print "Failed to create configuration table."
  80             print "Can the projectB user CREATE TABLE?"
  81             print ""
  82             print "Aborting update."
  83             sys.exit(-255)
  84
  85 ################################################################################
  86
  87     def get_db_rev(self):
  88         # We keep database revision info the config table
  89         # Try and access it
  90
  91         try:
  92             c = self.db.cursor()
  93             q = c.execute("SELECT value FROM config WHERE name = 'db_revision';")
  94             return c.fetchone()[0]
  95
  96         except psycopg2.ProgrammingError:
  97             # Whoops .. no config table ...
  98             self.db.rollback()
  99             print "No configuration table found, assuming dak database revision to be pre-zero"
 100             return -1
 101
 102 ################################################################################
 103
 104     def update_db(self):
 105         # Ok, try and find the configuration table
 106         print "Determining dak database revision ..."
 107
 108         try:
 109             # Build a connect string
 110             connect_str = "dbname=%s"% (Cnf["DB::Name"])
 111             if Cnf["DB::Host"] != '': connect_str += " host=%s" % (Cnf["DB::Host"])
 112             if Cnf["DB::Port"] != '-1': connect_str += " port=%d" % (int(Cnf["DB::Port"]))
 113
 114             self.db = psycopg2.connect(connect_str)
 115
 116         except:
 117             print "FATAL: Failed connect to database"
 118             pass
 119
 120         database_revision = int(self.get_db_rev())
 121
 122         if database_revision == -1:
 123             print "dak database schema predates update-db."
 124             print ""
 125             print "This script will attempt to upgrade it to the lastest, but may fail."
 126             print "Please make sure you have a database backup handy. If you don't, press Ctrl-C now!"
 127             print ""
 128             print "Continuing in five seconds ..."
 129             time.sleep(5)
 130             print ""
 131             print "Attempting to upgrade pre-zero database to zero"
 132
 133             self.update_db_to_zero()
 134             database_revision = 0
 135
 136         print "dak database schema at " + str(database_revision)
 137         print "dak version requires schema " + str(required_database_schema)
 138
 139         if database_revision == required_database_schema:
 140             print "no updates required"
 141             sys.exit(0)
 142
 143         for i in range (database_revision, required_database_schema):
 144             print "updating database schema from " + str(database_revision) + " to " + str(i+1)
 145             try:
 146                 dakdb = __import__("dakdb", globals(), locals(), ['update'+str(i+1)])
 147                 update_module = getattr(dakdb, "update"+str(i+1))
 148                 update_module.do_update(self)
 149             except DBUpdateError, e:
 150                 # Seems the update did not work.
 151                 print "Was unable to update database schema from %s to %s." % (str(database_revision), str(i+1))
 152                 print "The error message received was %s" % (e)
 153                 utils.fubar("DB Schema upgrade failed")
 154             database_revision += 1
 155
 156 ################################################################################
 157
 158     def init (self):
 159         global Cnf
 160
 161         Cnf = utils.get_conf()
 162         arguments = [('h', "help", "Update-DB::Options::Help")]
 163         for i in [ "help" ]:
 164             if not Cnf.has_key("Update-DB::Options::%s" % (i)):
 165                 Cnf["Update-DB::Options::%s" % (i)] = ""
 166
 167         arguments = apt_pkg.ParseCommandLine(Cnf, arguments, sys.argv)
 168
 169         options = Cnf.SubTree("Update-DB::Options")
 170         if options["Help"]:
 171             self.usage()
 172         elif arguments:
 173             utils.warn("dak update-db takes no arguments.")
 174             self.usage(exit_code=1)
 175
 176
 177         self.update_db()
 178
 179         try:
 180             lock_fd = os.open(Cnf["Dinstall::LockFile"], os.O_RDWR | os.O_CREAT)
 181             fcntl.lockf(lock_fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
 182         except IOError, e:
 183             if errno.errorcode[e.errno] == 'EACCES' or errno.errorcode[e.errno] == 'EAGAIN':
 184                 utils.fubar("Couldn't obtain lock; assuming another 'dak process-unchecked' is already running.")
 185
 186
 187 ################################################################################
 188
 189 if __name__ == '__main__':
 190     app = UpdateDB()
 191     app.init()
 192
 193 def main():
 194     app = UpdateDB()
 195     app.init()