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.config import Config
  43 from daklib.dak_exceptions import DBUpdateError
  44
  45 ################################################################################
  46
  47 Cnf = None
  48 required_database_schema = 34
  49
  50 ################################################################################
  51
  52 class UpdateDB:
  53     def usage (self, exit_code=0):
  54         print """Usage: dak update-db
  55 Updates dak's database schema to the lastest version. You should disable crontabs while this is running
  56
  57   -h, --help                show this help and exit."""
  58         sys.exit(exit_code)
  59
  60
  61 ################################################################################
  62
  63     def update_db_to_zero(self):
  64         """ This function will attempt to update a pre-zero database schema to zero """
  65
  66         # First, do the sure thing, and create the configuration table
  67         try:
  68             print "Creating configuration table ..."
  69             c = self.db.cursor()
  70             c.execute("""CREATE TABLE config (
  71                                   id SERIAL PRIMARY KEY NOT NULL,
  72                                   name TEXT UNIQUE NOT NULL,
  73                                   value TEXT
  74                                 );""")
  75             c.execute("INSERT INTO config VALUES ( nextval('config_id_seq'), 'db_revision', '0')")
  76             self.db.commit()
  77
  78         except psycopg2.ProgrammingError:
  79             self.db.rollback()
  80             print "Failed to create configuration table."
  81             print "Can the projectB user CREATE TABLE?"
  82             print ""
  83             print "Aborting update."
  84             sys.exit(-255)
  85
  86 ################################################################################
  87
  88     def get_db_rev(self):
  89         # We keep database revision info the config table
  90         # Try and access it
  91
  92         try:
  93             c = self.db.cursor()
  94             q = c.execute("SELECT value FROM config WHERE name = 'db_revision';")
  95             return c.fetchone()[0]
  96
  97         except psycopg2.ProgrammingError:
  98             # Whoops .. no config table ...
  99             self.db.rollback()
 100             print "No configuration table found, assuming dak database revision to be pre-zero"
 101             return -1
 102
 103 ################################################################################
 104
 105     def update_db(self):
 106         # Ok, try and find the configuration table
 107         print "Determining dak database revision ..."
 108         cnf = Config()
 109
 110         try:
 111             # Build a connect string
 112             connect_str = "dbname=%s"% (cnf["DB::Name"])
 113             if cnf["DB::Host"] != '': connect_str += " host=%s" % (cnf["DB::Host"])
 114             if cnf["DB::Port"] != '-1': connect_str += " port=%d" % (int(cnf["DB::Port"]))
 115
 116             self.db = psycopg2.connect(connect_str)
 117
 118         except:
 119             print "FATAL: Failed connect to database"
 120             pass
 121
 122         database_revision = int(self.get_db_rev())
 123
 124         if database_revision == -1:
 125             print "dak database schema predates update-db."
 126             print ""
 127             print "This script will attempt to upgrade it to the lastest, but may fail."
 128             print "Please make sure you have a database backup handy. If you don't, press Ctrl-C now!"
 129             print ""
 130             print "Continuing in five seconds ..."
 131             time.sleep(5)
 132             print ""
 133             print "Attempting to upgrade pre-zero database to zero"
 134
 135             self.update_db_to_zero()
 136             database_revision = 0
 137
 138         print "dak database schema at %d" % database_revision
 139         print "dak version requires schema %d"  % required_database_schema
 140
 141         if database_revision == required_database_schema:
 142             print "no updates required"
 143             sys.exit(0)
 144
 145         for i in range (database_revision, required_database_schema):
 146             print "updating database schema from %d to %d" % (database_revision, i+1)
 147             try:
 148                 dakdb = __import__("dakdb", globals(), locals(), ['update'+str(i+1)])
 149                 update_module = getattr(dakdb, "update"+str(i+1))
 150                 update_module.do_update(self)
 151             except DBUpdateError, e:
 152                 # Seems the update did not work.
 153                 print "Was unable to update database schema from %d to %d." % (database_revision, i+1)
 154                 print "The error message received was %s" % (e)
 155                 utils.fubar("DB Schema upgrade failed")
 156             database_revision += 1
 157
 158 ################################################################################
 159
 160     def init (self):
 161         cnf = Config()
 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.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         try:
 177             lock_fd = os.open(cnf["Dinstall::LockFile"], os.O_RDWR | os.O_CREAT)
 178             fcntl.lockf(lock_fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
 179         except IOError, e:
 180             if errno.errorcode[e.errno] == 'EACCES' or errno.errorcode[e.errno] == 'EAGAIN':
 181                 utils.fubar("Couldn't obtain lock; assuming another 'dak process-unchecked' is already running.")
 182
 183         self.update_db()
 184
 185
 186 ################################################################################
 187
 188 if __name__ == '__main__':
 189     app = UpdateDB()
 190     app.init()
 191
 192 def main():
 193     app = UpdateDB()
 194     app.init()