annotate roundup/backends/back_bsddb3.py @ 651:6257d4e49d2a

Ran it through pychecker, made fixes
author Richard Jones <richard@users.sourceforge.net>
date Wed, 27 Feb 2002 04:14:31 +0000
parents dce4c75bef5a
children e3d742c75ac3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
1 #
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
3 # This module is free software, and you may redistribute it and/or modify
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
4 # under the same terms as Python, so long as this copyright message and
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
5 # disclaimer are retained in their original form.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
6 #
214
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
10 # POSSIBILITY OF SUCH DAMAGE.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
11 #
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
17 #
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
18 #$Id: back_bsddb3.py,v 1.11 2002-01-14 02:20:15 richard Exp $
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
19
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
20 import bsddb3, os, marshal
270
a4241ddd22d7 Added the Password property type.
Richard Jones <richard@users.sourceforge.net>
parents: 224
diff changeset
21 from roundup import hyperdb, date, password
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
22
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
23 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
24 # Now the database
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
25 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
26 class Database(hyperdb.Database):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
27 """A database for storing records containing flexible data types."""
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
28
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
29 def __init__(self, config, journaltag=None):
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
30 """Open a hyperdatabase given a specifier to some storage.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
31
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
32 The 'storagelocator' is obtained from config.DATABASE.
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
33 The meaning of 'storagelocator' depends on the particular
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
34 implementation of the hyperdatabase. It could be a file name,
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
35 a directory path, a socket descriptor for a connection to a
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
36 database over the network, etc.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
37
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
38 The 'journaltag' is a token that will be attached to the journal
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
39 entries for any edits done on the database. If 'journaltag' is
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
40 None, the database is opened in read-only mode: the Class.create(),
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
41 Class.set(), and Class.retire() methods are disabled.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
42 """
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
43 self.config, self.journaltag = config, journaltag
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
44 self.dir = config.DATABASE
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
45 self.classes = {}
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
46
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
47 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
48 # Classes
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
49 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
50 def __getattr__(self, classname):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
51 """A convenient way of calling self.getclass(classname)."""
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
52 return self.classes[classname]
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
53
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
54 def addclass(self, cl):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
55 cn = cl.classname
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
56 if self.classes.has_key(cn):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
57 raise ValueError, cn
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
58 self.classes[cn] = cl
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
59
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
60 def getclasses(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
61 """Return a list of the names of all existing classes."""
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
62 l = self.classes.keys()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
63 l.sort()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
64 return l
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
65
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
66 def getclass(self, classname):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
67 """Get the Class object representing a particular class.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
68
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
69 If 'classname' is not a valid class name, a KeyError is raised.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
70 """
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
71 return self.classes[classname]
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
72
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
73 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
74 # Class DBs
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
75 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
76 def clear(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
77 for cn in self.classes.keys():
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
78 db = os.path.join(self.dir, 'nodes.%s'%cn)
196
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
79 bsddb3.btopen(db, 'c')
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
80 db = os.path.join(self.dir, 'journals.%s'%cn)
196
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
81 bsddb3.btopen(db, 'c')
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
82
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
83 def getclassdb(self, classname, mode='r'):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
84 ''' grab a connection to the class db that will be used for
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
85 multiple actions
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
86 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
87 path = os.path.join(os.getcwd(), self.dir, 'nodes.%s'%classname)
152
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
88 if os.path.exists(path):
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
89 return bsddb3.btopen(path, mode)
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
90 else:
196
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
91 return bsddb3.btopen(path, 'c')
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
92
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
93 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
94 # Nodes
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
95 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
96 def addnode(self, classname, nodeid, node):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
97 ''' add the specified node to its class's db
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
98 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
99 db = self.getclassdb(classname, 'c')
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
100 # now save the marshalled data
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
101 db[nodeid] = marshal.dumps(node)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
102 db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
103 setnode = addnode
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
104
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
105 def getnode(self, classname, nodeid, cldb=None):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
106 ''' add the specified node to its class's db
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
107 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
108 db = cldb or self.getclassdb(classname)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
109 if not db.has_key(nodeid):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
110 raise IndexError, nodeid
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
111 res = marshal.loads(db[nodeid])
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
112 if not cldb: db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
113 return res
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
114
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
115 def hasnode(self, classname, nodeid, cldb=None):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
116 ''' add the specified node to its class's db
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
117 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
118 db = cldb or self.getclassdb(classname)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
119 res = db.has_key(nodeid)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
120 if not cldb: db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
121 return res
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
122
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
123 def countnodes(self, classname, cldb=None):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
124 db = cldb or self.getclassdb(classname)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
125 return len(db.keys())
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
126 if not cldb: db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
127 return res
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
128
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
129 def getnodeids(self, classname, cldb=None):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
130 db = cldb or self.getclassdb(classname)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
131 res = db.keys()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
132 if not cldb: db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
133 return res
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
134
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
135 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
136 # Journal
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
137 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
138 def addjournal(self, classname, nodeid, action, params):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
139 ''' Journal the Action
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
140 'action' may be:
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
141
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
142 'create' or 'set' -- 'params' is a dictionary of property values
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
143 'link' or 'unlink' -- 'params' is (classname, nodeid, propname)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
144 'retire' -- 'params' is None
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
145 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
146 entry = (nodeid, date.Date().get_tuple(), self.journaltag, action,
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
147 params)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
148 db = bsddb3.btopen(os.path.join(self.dir, 'journals.%s'%classname), 'c')
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
149 if db.has_key(nodeid):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
150 s = db[nodeid]
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
151 l = marshal.loads(db[nodeid])
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
152 l.append(entry)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
153 else:
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
154 l = [entry]
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
155 db[nodeid] = marshal.dumps(l)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
156 db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
157
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
158 def getjournal(self, classname, nodeid):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
159 ''' get the journal for id
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
160 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
161 # attempt to open the journal - in some rare cases, the journal may
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
162 # not exist
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
163 try:
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
164 db = bsddb3.btopen(os.path.join(self.dir, 'journals.%s'%classname),
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
165 'r')
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
166 except bsddb3.error, error:
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
167 if error.args[0] != 2: raise
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
168 return []
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
169 # mor handling of bad journals
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
170 if not db.has_key(nodeid): return []
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
171 journal = marshal.loads(db[nodeid])
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
172 res = []
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
173 for entry in journal:
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
174 (nodeid, date_stamp, self.journaltag, action, params) = entry
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
175 date_obj = date.Date(date_stamp)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
176 res.append((nodeid, date_obj, self.journaltag, action, params))
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
177 db.close()
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
178 return res
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
179
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
180 def close(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
181 ''' Close the Database - we must release the circular refs so that
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
182 we can be del'ed and the underlying bsddb connections closed
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
183 cleanly.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
184 '''
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
185 self.classes = {}
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
186
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
187
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
188 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
189 # Basic transaction support
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
190 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
191 # TODO: well, write these methods (and then use them in other code)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
192 def register_action(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
193 ''' Register an action to the transaction undo log
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
194 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
195
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
196 def commit(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
197 ''' Commit the current transaction, start a new one
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
198 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
199
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
200 def rollback(self):
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
201 ''' Reverse all actions from the current transaction
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
202 '''
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
203
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
204 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
205 #$Log: not supported by cvs2svn $
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
206 #Revision 1.10 2001/11/21 02:34:18 richard
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
207 #Added a target version field to the extended issue schema
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 394
diff changeset
208 #
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
209 #Revision 1.9 2001/10/09 23:58:10 richard
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
210 #Moved the data stringification up into the hyperdb.Class class' get, set
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
211 #and create methods. This means that the data is also stringified for the
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
212 #journal call, and removes duplication of code from the backends. The
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
213 #backend code now only sees strings.
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 275
diff changeset
214 #
275
1cc866cec608 Moved the data stringification up into the hyperdb.Class class's...
Richard Jones <richard@users.sourceforge.net>
parents: 270
diff changeset
215 #Revision 1.8 2001/10/09 07:25:59 richard
1cc866cec608 Moved the data stringification up into the hyperdb.Class class's...
Richard Jones <richard@users.sourceforge.net>
parents: 270
diff changeset
216 #Added the Password property type. See "pydoc roundup.password" for
1cc866cec608 Moved the data stringification up into the hyperdb.Class class's...
Richard Jones <richard@users.sourceforge.net>
parents: 270
diff changeset
217 #implementation details. Have updated some of the documentation too.
1cc866cec608 Moved the data stringification up into the hyperdb.Class class's...
Richard Jones <richard@users.sourceforge.net>
parents: 270
diff changeset
218 #
270
a4241ddd22d7 Added the Password property type.
Richard Jones <richard@users.sourceforge.net>
parents: 224
diff changeset
219 #Revision 1.7 2001/08/12 06:32:36 richard
a4241ddd22d7 Added the Password property type.
Richard Jones <richard@users.sourceforge.net>
parents: 224
diff changeset
220 #using isinstance(blah, Foo) now instead of isFooType
a4241ddd22d7 Added the Password property type.
Richard Jones <richard@users.sourceforge.net>
parents: 224
diff changeset
221 #
224
ad2c98faec97 using isinstance(blah, Foo) now instead of isFooType
Richard Jones <richard@users.sourceforge.net>
parents: 214
diff changeset
222 #Revision 1.6 2001/08/07 00:24:42 richard
ad2c98faec97 using isinstance(blah, Foo) now instead of isFooType
Richard Jones <richard@users.sourceforge.net>
parents: 214
diff changeset
223 #stupid typo
ad2c98faec97 using isinstance(blah, Foo) now instead of isFooType
Richard Jones <richard@users.sourceforge.net>
parents: 214
diff changeset
224 #
214
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
225 #Revision 1.5 2001/08/07 00:15:51 richard
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
226 #Added the copyright/license notice to (nearly) all files at request of
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
227 #Bizar Software.
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
228 #
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
229 #Revision 1.4 2001/08/03 02:45:47 anthonybaxter
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
230 #'n' -> 'c' for create.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 196
diff changeset
231 #
196
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
232 #Revision 1.3 2001/07/30 02:36:23 richard
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
233 #Handle non-existence of db files in the other backends (code from anydbm).
6dfbc1aa0b1f 'n' -> 'c' for create.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 152
diff changeset
234 #
152
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
235 #Revision 1.2 2001/07/30 01:41:36 richard
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
236 #Makes schema changes mucho easier.
80c062af1b7d Handle non-existence of db files in the other backends (code from anydbm).
Richard Jones <richard@users.sourceforge.net>
parents: 149
diff changeset
237 #
149
fbc77ecf133b Makes schema changes mucho easier.
Richard Jones <richard@users.sourceforge.net>
parents: 64
diff changeset
238 #Revision 1.1 2001/07/24 04:26:03 anthonybaxter
fbc77ecf133b Makes schema changes mucho easier.
Richard Jones <richard@users.sourceforge.net>
parents: 64
diff changeset
239 #bsddb3 implementation. For now, it's the bsddb implementation with a "3"
fbc77ecf133b Makes schema changes mucho easier.
Richard Jones <richard@users.sourceforge.net>
parents: 64
diff changeset
240 #added in crayon.
fbc77ecf133b Makes schema changes mucho easier.
Richard Jones <richard@users.sourceforge.net>
parents: 64
diff changeset
241 #
64
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
242 #Revision 1.4 2001/07/23 08:25:33 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
243 #more handling of bad journals
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
244 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
245 #Revision 1.3 2001/07/23 08:20:44 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
246 #Moved over to using marshal in the bsddb and anydbm backends.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
247 #roundup-admin now has a "freshen" command that'll load/save all nodes (not
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
248 # retired - mod hyperdb.Class.list() so it lists retired nodes)
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
249 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
250 #Revision 1.2 2001/07/23 07:56:05 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
251 #Storing only marshallable data in the db - no nasty pickled class references.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
252 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
253 #Revision 1.1 2001/07/23 07:22:13 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
254 #*sigh* some databases have _foo.so as their underlying implementation.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
255 #This time for sure, Rocky.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
256 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
257 #Revision 1.1 2001/07/23 07:15:57 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
258 #Moved the backends into the backends package. Anydbm hasn't been tested at all.
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
259 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
260 #Revision 1.1 2001/07/23 06:23:41 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
261 #moved hyper_bsddb.py to the new backends package as bsddb.py
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
262 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
263 #Revision 1.2 2001/07/22 12:09:32 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
264 #Final commit of Grande Splite
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
265 #
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
266 #Revision 1.1 2001/07/22 11:58:35 richard
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
267 #More Grande Splite
8bce2210ef81 bsddb3 implementation.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
268 #

Roundup Issue Tracker: http://roundup-tracker.org/