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