roundup/backends/back_bsddb.py

   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.13 2001-12-10 22:20:01 richard Exp $
  19 '''
  20 This module defines a backend that saves the hyperdatabase in BSDDB.
  21 '''
  22
  23 import bsddb, os, marshal
  24 from roundup import hyperdb, date, password
  25
  26 # these classes are so similar, we just use the anydbm methods
  27 import back_anydbm
  28
  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')
  43
  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')
  53
  54     #
  55     # Journal
  56     #
  57     def getjournal(self, classname, nodeid):
  58         ''' get the journal for id
  59         '''
  60         # attempt to open the journal - in some rare cases, the journal may
  61         # not exist
  62         try:
  63             db = bsddb.btopen(os.path.join(self.dir, 'journals.%s'%classname),
  64                 'r')
  65         except bsddb.error, error:
  66             if error.args[0] != 2: raise
  67             return []
  68         # mor handling of bad journals
  69         if not db.has_key(nodeid): return []
  70         journal = marshal.loads(db[nodeid])
  71         res = []
  72         for entry in journal:
  73             (nodeid, date_stamp, self.journaltag, action, params) = entry
  74             date_obj = date.Date(date_stamp)
  75             res.append((nodeid, date_obj, self.journaltag, action, params))
  76         db.close()
  77         return res
  78
  79     def _doSaveJournal(self, classname, nodeid, action, params):
  80         entry = (nodeid, date.Date().get_tuple(), self.journaltag, action,
  81             params)
  82         db = bsddb.btopen(os.path.join(self.dir, 'journals.%s'%classname), 'c')
  83         if db.has_key(nodeid):
  84             s = db[nodeid]
  85             l = marshal.loads(db[nodeid])
  86             l.append(entry)
  87         else:
  88             l = [entry]
  89         db[nodeid] = marshal.dumps(l)
  90         db.close()
  91
  92 #
  93 #$Log: not supported by cvs2svn $
  94 #Revision 1.12  2001/11/21 02:34:18  richard
  95 #Added a target version field to the extended issue schema
  96 #
  97 #Revision 1.11  2001/10/09 23:58:10  richard
  98 #Moved the data stringification up into the hyperdb.Class class' get, set
  99 #and create methods. This means that the data is also stringified for the
 100 #journal call, and removes duplication of code from the backends. The
 101 #backend code now only sees strings.
 102 #
 103 #Revision 1.10  2001/10/09 07:25:59  richard
 104 #Added the Password property type. See "pydoc roundup.password" for
 105 #implementation details. Have updated some of the documentation too.
 106 #
 107 #Revision 1.9  2001/08/12 06:32:36  richard
 108 #using isinstance(blah, Foo) now instead of isFooType
 109 #
 110 #Revision 1.8  2001/08/07 00:24:42  richard
 111 #stupid typo
 112 #
 113 #Revision 1.7  2001/08/07 00:15:51  richard
 114 #Added the copyright/license notice to (nearly) all files at request of
 115 #Bizar Software.
 116 #
 117 #Revision 1.6  2001/07/30 02:36:23  richard
 118 #Handle non-existence of db files in the other backends (code from anydbm).
 119 #
 120 #Revision 1.5  2001/07/30 01:41:36  richard
 121 #Makes schema changes mucho easier.
 122 #
 123 #Revision 1.4  2001/07/23 08:25:33  richard
 124 #more handling of bad journals
 125 #
 126 #Revision 1.3  2001/07/23 08:20:44  richard
 127 #Moved over to using marshal in the bsddb and anydbm backends.
 128 #roundup-admin now has a "freshen" command that'll load/save all nodes (not
 129 # retired - mod hyperdb.Class.list() so it lists retired nodes)
 130 #
 131 #Revision 1.2  2001/07/23 07:56:05  richard
 132 #Storing only marshallable data in the db - no nasty pickled class references.
 133 #
 134 #Revision 1.1  2001/07/23 07:22:13  richard
 135 #*sigh* some databases have _foo.so as their underlying implementation.
 136 #This time for sure, Rocky.
 137 #
 138 #Revision 1.1  2001/07/23 07:15:57  richard
 139 #Moved the backends into the backends package. Anydbm hasn't been tested at all.
 140 #
 141 #Revision 1.1  2001/07/23 06:23:41  richard
 142 #moved hyper_bsddb.py to the new backends package as bsddb.py
 143 #
 144 #Revision 1.2  2001/07/22 12:09:32  richard
 145 #Final commit of Grande Splite
 146 #
 147 #Revision 1.1  2001/07/22 11:58:35  richard
 148 #More Grande Splite
 149 #