1 #
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
3 # This module is free software, and you may redistribute it and/or modify
4 # under the same terms as Python, so long as this copyright message and
5 # disclaimer are retained in their original form.
6 #
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
10 # POSSIBILITY OF SUCH DAMAGE.
11 #
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 #
18 #$Id: back_bsddb.py,v 1.14 2002-01-22 07:21:13 richard Exp $
19 '''
20 This module defines a backend that saves the hyperdatabase in BSDDB.
21 '''
23 import bsddb, os, marshal
24 from roundup import hyperdb, date, password
26 # these classes are so similar, we just use the anydbm methods
27 import back_anydbm
29 #
30 # Now the database
31 #
32 class Database(back_anydbm.Database):
33 """A database for storing records containing flexible data types."""
34 #
35 # Class DBs
36 #
37 def clear(self):
38 for cn in self.classes.keys():
39 db = os.path.join(self.dir, 'nodes.%s'%cn)
40 bsddb.btopen(db, 'n')
41 db = os.path.join(self.dir, 'journals.%s'%cn)
42 bsddb.btopen(db, 'n')
44 def getclassdb(self, classname, mode='r'):
45 ''' grab a connection to the class db that will be used for
46 multiple actions
47 '''
48 path = os.path.join(os.getcwd(), self.dir, 'nodes.%s'%classname)
49 if os.path.exists(path):
50 return bsddb.btopen(path, mode)
51 else:
52 return bsddb.btopen(path, 'n')
54 def _opendb(self, name, mode):
55 '''Low-level database opener that gets around anydbm/dbm
56 eccentricities.
57 '''
58 if hyperdb.DEBUG:
59 print self, '_opendb', (self, name, mode)
60 # determine which DB wrote the class file
61 path = os.path.join(os.getcwd(), self.dir, name)
62 if not os.path.exists(path):
63 if hyperdb.DEBUG:
64 print "_opendb bsddb.open(%r, 'n')"%path
65 return bsddb.btopen(path, 'n')
67 # open the database with the correct module
68 if hyperdb.DEBUG:
69 print "_opendb bsddb.open(%r, %r)"%(path, mode)
70 return bsddb.btopen(path, mode)
72 #
73 # Journal
74 #
75 def getjournal(self, classname, nodeid):
76 ''' get the journal for id
77 '''
78 # attempt to open the journal - in some rare cases, the journal may
79 # not exist
80 try:
81 db = bsddb.btopen(os.path.join(self.dir, 'journals.%s'%classname),
82 'r')
83 except bsddb.error, error:
84 if error.args[0] != 2: raise
85 return []
86 # mor handling of bad journals
87 if not db.has_key(nodeid): return []
88 journal = marshal.loads(db[nodeid])
89 res = []
90 for entry in journal:
91 (nodeid, date_stamp, self.journaltag, action, params) = entry
92 date_obj = date.Date(date_stamp)
93 res.append((nodeid, date_obj, self.journaltag, action, params))
94 db.close()
95 return res
97 def _doSaveJournal(self, classname, nodeid, action, params):
98 entry = (nodeid, date.Date().get_tuple(), self.journaltag, action,
99 params)
100 db = bsddb.btopen(os.path.join(self.dir, 'journals.%s'%classname), 'c')
101 if db.has_key(nodeid):
102 s = db[nodeid]
103 l = marshal.loads(db[nodeid])
104 l.append(entry)
105 else:
106 l = [entry]
107 db[nodeid] = marshal.dumps(l)
108 db.close()
110 #
111 #$Log: not supported by cvs2svn $
112 #Revision 1.13 2001/12/10 22:20:01 richard
113 #Enabled transaction support in the bsddb backend. It uses the anydbm code
114 #where possible, only replacing methods where the db is opened (it uses the
115 #btree opener specifically.)
116 #Also cleaned up some change note generation.
117 #Made the backends package work with pydoc too.
118 #
119 #Revision 1.12 2001/11/21 02:34:18 richard
120 #Added a target version field to the extended issue schema
121 #
122 #Revision 1.11 2001/10/09 23:58:10 richard
123 #Moved the data stringification up into the hyperdb.Class class' get, set
124 #and create methods. This means that the data is also stringified for the
125 #journal call, and removes duplication of code from the backends. The
126 #backend code now only sees strings.
127 #
128 #Revision 1.10 2001/10/09 07:25:59 richard
129 #Added the Password property type. See "pydoc roundup.password" for
130 #implementation details. Have updated some of the documentation too.
131 #
132 #Revision 1.9 2001/08/12 06:32:36 richard
133 #using isinstance(blah, Foo) now instead of isFooType
134 #
135 #Revision 1.8 2001/08/07 00:24:42 richard
136 #stupid typo
137 #
138 #Revision 1.7 2001/08/07 00:15:51 richard
139 #Added the copyright/license notice to (nearly) all files at request of
140 #Bizar Software.
141 #
142 #Revision 1.6 2001/07/30 02:36:23 richard
143 #Handle non-existence of db files in the other backends (code from anydbm).
144 #
145 #Revision 1.5 2001/07/30 01:41:36 richard
146 #Makes schema changes mucho easier.
147 #
148 #Revision 1.4 2001/07/23 08:25:33 richard
149 #more handling of bad journals
150 #
151 #Revision 1.3 2001/07/23 08:20:44 richard
152 #Moved over to using marshal in the bsddb and anydbm backends.
153 #roundup-admin now has a "freshen" command that'll load/save all nodes (not
154 # retired - mod hyperdb.Class.list() so it lists retired nodes)
155 #
156 #Revision 1.2 2001/07/23 07:56:05 richard
157 #Storing only marshallable data in the db - no nasty pickled class references.
158 #
159 #Revision 1.1 2001/07/23 07:22:13 richard
160 #*sigh* some databases have _foo.so as their underlying implementation.
161 #This time for sure, Rocky.
162 #
163 #Revision 1.1 2001/07/23 07:15:57 richard
164 #Moved the backends into the backends package. Anydbm hasn't been tested at all.
165 #
166 #Revision 1.1 2001/07/23 06:23:41 richard
167 #moved hyper_bsddb.py to the new backends package as bsddb.py
168 #
169 #Revision 1.2 2001/07/22 12:09:32 richard
170 #Final commit of Grande Splite
171 #
172 #Revision 1.1 2001/07/22 11:58:35 richard
173 #More Grande Splite
174 #