71285a6cb0e01056be52285ff25b9006b7b83362
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: hyperdb.py,v 1.78 2002-07-21 03:26:37 richard Exp $
20 __doc__ = """
21 Hyperdatabase implementation, especially field types.
22 """
24 # standard python modules
25 import sys, os, time, re
27 # roundup modules
28 import date, password
30 # configure up the DEBUG and TRACE captures
31 class Sink:
32 def write(self, content):
33 pass
34 DEBUG = os.environ.get('HYPERDBDEBUG', '')
35 if DEBUG and __debug__:
36 if DEBUG == 'stdout':
37 DEBUG = sys.stdout
38 else:
39 DEBUG = open(DEBUG, 'a')
40 else:
41 DEBUG = Sink()
42 TRACE = os.environ.get('HYPERDBTRACE', '')
43 if TRACE and __debug__:
44 if TRACE == 'stdout':
45 TRACE = sys.stdout
46 else:
47 TRACE = open(TRACE, 'w')
48 else:
49 TRACE = Sink()
50 def traceMark():
51 print >>TRACE, '**MARK', time.ctime()
52 del Sink
54 #
55 # Types
56 #
57 class String:
58 """An object designating a String property."""
59 def __init__(self, indexme='no'):
60 self.indexme = indexme == 'yes'
61 def __repr__(self):
62 ' more useful for dumps '
63 return '<%s>'%self.__class__
65 class Password:
66 """An object designating a Password property."""
67 def __repr__(self):
68 ' more useful for dumps '
69 return '<%s>'%self.__class__
71 class Date:
72 """An object designating a Date property."""
73 def __repr__(self):
74 ' more useful for dumps '
75 return '<%s>'%self.__class__
77 class Interval:
78 """An object designating an Interval property."""
79 def __repr__(self):
80 ' more useful for dumps '
81 return '<%s>'%self.__class__
83 class Link:
84 """An object designating a Link property that links to a
85 node in a specified class."""
86 def __init__(self, classname, do_journal='no'):
87 ''' Default is to not journal link and unlink events
88 '''
89 self.classname = classname
90 self.do_journal = do_journal == 'yes'
91 def __repr__(self):
92 ' more useful for dumps '
93 return '<%s to "%s">'%(self.__class__, self.classname)
95 class Multilink:
96 """An object designating a Multilink property that links
97 to nodes in a specified class.
99 "classname" indicates the class to link to
101 "do_journal" indicates whether the linked-to nodes should have
102 'link' and 'unlink' events placed in their journal
103 """
104 def __init__(self, classname, do_journal='no'):
105 ''' Default is to not journal link and unlink events
106 '''
107 self.classname = classname
108 self.do_journal = do_journal == 'yes'
109 def __repr__(self):
110 ' more useful for dumps '
111 return '<%s to "%s">'%(self.__class__, self.classname)
113 class Boolean:
114 """An object designating a boolean property"""
115 def __repr__(self):
116 'more useful for dumps'
117 return '<%s>' % self.__class__
119 class Number:
120 """An object designating a numeric property"""
121 def __repr__(self):
122 'more useful for dumps'
123 return '<%s>' % self.__class__
124 #
125 # Support for splitting designators
126 #
127 class DesignatorError(ValueError):
128 pass
129 def splitDesignator(designator, dre=re.compile(r'([^\d]+)(\d+)')):
130 ''' Take a foo123 and return ('foo', 123)
131 '''
132 m = dre.match(designator)
133 if m is None:
134 raise DesignatorError, '"%s" not a node designator'%designator
135 return m.group(1), m.group(2)
137 #
138 # the base Database class
139 #
140 class DatabaseError(ValueError):
141 '''Error to be raised when there is some problem in the database code
142 '''
143 pass
144 class Database:
145 '''A database for storing records containing flexible data types.
147 This class defines a hyperdatabase storage layer, which the Classes use to
148 store their data.
151 Transactions
152 ------------
153 The Database should support transactions through the commit() and
154 rollback() methods. All other Database methods should be transaction-aware,
155 using data from the current transaction before looking up the database.
157 An implementation must provide an override for the get() method so that the
158 in-database value is returned in preference to the in-transaction value.
159 This is necessary to determine if any values have changed during a
160 transaction.
163 Implementation
164 --------------
166 All methods except __repr__ and getnode must be implemented by a
167 concrete backend Class.
169 '''
171 # flag to set on retired entries
172 RETIRED_FLAG = '__hyperdb_retired'
174 # XXX deviates from spec: storagelocator is obtained from the config
175 def __init__(self, config, journaltag=None):
176 """Open a hyperdatabase given a specifier to some storage.
178 The 'storagelocator' is obtained from config.DATABASE.
179 The meaning of 'storagelocator' depends on the particular
180 implementation of the hyperdatabase. It could be a file name,
181 a directory path, a socket descriptor for a connection to a
182 database over the network, etc.
184 The 'journaltag' is a token that will be attached to the journal
185 entries for any edits done on the database. If 'journaltag' is
186 None, the database is opened in read-only mode: the Class.create(),
187 Class.set(), and Class.retire() methods are disabled.
188 """
189 raise NotImplementedError
191 def post_init(self):
192 """Called once the schema initialisation has finished."""
193 raise NotImplementedError
195 def __getattr__(self, classname):
196 """A convenient way of calling self.getclass(classname)."""
197 raise NotImplementedError
199 def addclass(self, cl):
200 '''Add a Class to the hyperdatabase.
201 '''
202 raise NotImplementedError
204 def getclasses(self):
205 """Return a list of the names of all existing classes."""
206 raise NotImplementedError
208 def getclass(self, classname):
209 """Get the Class object representing a particular class.
211 If 'classname' is not a valid class name, a KeyError is raised.
212 """
213 raise NotImplementedError
215 def clear(self):
216 '''Delete all database contents.
217 '''
218 raise NotImplementedError
220 def getclassdb(self, classname, mode='r'):
221 '''Obtain a connection to the class db that will be used for
222 multiple actions.
223 '''
224 raise NotImplementedError
226 def addnode(self, classname, nodeid, node):
227 '''Add the specified node to its class's db.
228 '''
229 raise NotImplementedError
231 def serialise(self, classname, node):
232 '''Copy the node contents, converting non-marshallable data into
233 marshallable data.
234 '''
235 return node
237 def setnode(self, classname, nodeid, node):
238 '''Change the specified node.
239 '''
240 raise NotImplementedError
242 def unserialise(self, classname, node):
243 '''Decode the marshalled node data
244 '''
245 return node
247 def getnode(self, classname, nodeid, db=None, cache=1):
248 '''Get a node from the database.
249 '''
250 raise NotImplementedError
252 def hasnode(self, classname, nodeid, db=None):
253 '''Determine if the database has a given node.
254 '''
255 raise NotImplementedError
257 def countnodes(self, classname, db=None):
258 '''Count the number of nodes that exist for a particular Class.
259 '''
260 raise NotImplementedError
262 def getnodeids(self, classname, db=None):
263 '''Retrieve all the ids of the nodes for a particular Class.
264 '''
265 raise NotImplementedError
267 def storefile(self, classname, nodeid, property, content):
268 '''Store the content of the file in the database.
270 The property may be None, in which case the filename does not
271 indicate which property is being saved.
272 '''
273 raise NotImplementedError
275 def getfile(self, classname, nodeid, property):
276 '''Store the content of the file in the database.
277 '''
278 raise NotImplementedError
280 def addjournal(self, classname, nodeid, action, params):
281 ''' Journal the Action
282 'action' may be:
284 'create' or 'set' -- 'params' is a dictionary of property values
285 'link' or 'unlink' -- 'params' is (classname, nodeid, propname)
286 'retire' -- 'params' is None
287 '''
288 raise NotImplementedError
290 def getjournal(self, classname, nodeid):
291 ''' get the journal for id
292 '''
293 raise NotImplementedError
295 def pack(self, pack_before):
296 ''' pack the database
297 '''
298 raise NotImplementedError
300 def commit(self):
301 ''' Commit the current transactions.
303 Save all data changed since the database was opened or since the
304 last commit() or rollback().
305 '''
306 raise NotImplementedError
308 def rollback(self):
309 ''' Reverse all actions from the current transaction.
311 Undo all the changes made since the database was opened or the last
312 commit() or rollback() was performed.
313 '''
314 raise NotImplementedError
316 #
317 # The base Class class
318 #
319 class Class:
320 """ The handle to a particular class of nodes in a hyperdatabase.
322 All methods except __repr__ and getnode must be implemented by a
323 concrete backend Class.
324 """
326 def __init__(self, db, classname, **properties):
327 """Create a new class with a given name and property specification.
329 'classname' must not collide with the name of an existing class,
330 or a ValueError is raised. The keyword arguments in 'properties'
331 must map names to property objects, or a TypeError is raised.
332 """
333 raise NotImplementedError
335 def __repr__(self):
336 '''Slightly more useful representation
337 '''
338 return '<hypderdb.Class "%s">'%self.classname
340 # Editing nodes:
342 def create(self, **propvalues):
343 """Create a new node of this class and return its id.
345 The keyword arguments in 'propvalues' map property names to values.
347 The values of arguments must be acceptable for the types of their
348 corresponding properties or a TypeError is raised.
350 If this class has a key property, it must be present and its value
351 must not collide with other key strings or a ValueError is raised.
353 Any other properties on this class that are missing from the
354 'propvalues' dictionary are set to None.
356 If an id in a link or multilink property does not refer to a valid
357 node, an IndexError is raised.
358 """
359 raise NotImplementedError
361 _marker = []
362 def get(self, nodeid, propname, default=_marker, cache=1):
363 """Get the value of a property on an existing node of this class.
365 'nodeid' must be the id of an existing node of this class or an
366 IndexError is raised. 'propname' must be the name of a property
367 of this class or a KeyError is raised.
369 'cache' indicates whether the transaction cache should be queried
370 for the node. If the node has been modified and you need to
371 determine what its values prior to modification are, you need to
372 set cache=0.
373 """
374 raise NotImplementedError
376 # XXX not in spec
377 def getnode(self, nodeid, cache=1):
378 ''' Return a convenience wrapper for the node.
380 'nodeid' must be the id of an existing node of this class or an
381 IndexError is raised.
383 'cache' indicates whether the transaction cache should be queried
384 for the node. If the node has been modified and you need to
385 determine what its values prior to modification are, you need to
386 set cache=0.
387 '''
388 return Node(self, nodeid, cache=cache)
390 def set(self, nodeid, **propvalues):
391 """Modify a property on an existing node of this class.
393 'nodeid' must be the id of an existing node of this class or an
394 IndexError is raised.
396 Each key in 'propvalues' must be the name of a property of this
397 class or a KeyError is raised.
399 All values in 'propvalues' must be acceptable types for their
400 corresponding properties or a TypeError is raised.
402 If the value of the key property is set, it must not collide with
403 other key strings or a ValueError is raised.
405 If the value of a Link or Multilink property contains an invalid
406 node id, a ValueError is raised.
407 """
408 raise NotImplementedError
410 def retire(self, nodeid):
411 """Retire a node.
413 The properties on the node remain available from the get() method,
414 and the node's id is never reused.
416 Retired nodes are not returned by the find(), list(), or lookup()
417 methods, and other nodes may reuse the values of their key properties.
418 """
419 raise NotImplementedError
421 def destroy(self, nodeid):
422 """Destroy a node.
424 WARNING: this method should never be used except in extremely rare
425 situations where there could never be links to the node being
426 deleted
427 WARNING: use retire() instead
428 WARNING: the properties of this node will not be available ever again
429 WARNING: really, use retire() instead
431 Well, I think that's enough warnings. This method exists mostly to
432 support the session storage of the cgi interface.
434 The node is completely removed from the hyperdb, including all journal
435 entries. It will no longer be available, and will generally break code
436 if there are any references to the node.
437 """
439 def history(self, nodeid):
440 """Retrieve the journal of edits on a particular node.
442 'nodeid' must be the id of an existing node of this class or an
443 IndexError is raised.
445 The returned list contains tuples of the form
447 (date, tag, action, params)
449 'date' is a Timestamp object specifying the time of the change and
450 'tag' is the journaltag specified when the database was opened.
451 """
452 raise NotImplementedError
454 # Locating nodes:
455 def hasnode(self, nodeid):
456 '''Determine if the given nodeid actually exists
457 '''
458 raise NotImplementedError
460 def setkey(self, propname):
461 """Select a String property of this class to be the key property.
463 'propname' must be the name of a String property of this class or
464 None, or a TypeError is raised. The values of the key property on
465 all existing nodes must be unique or a ValueError is raised.
466 """
467 raise NotImplementedError
469 def getkey(self):
470 """Return the name of the key property for this class or None."""
471 raise NotImplementedError
473 def labelprop(self, default_to_id=0):
474 ''' Return the property name for a label for the given node.
476 This method attempts to generate a consistent label for the node.
477 It tries the following in order:
478 1. key property
479 2. "name" property
480 3. "title" property
481 4. first property from the sorted property name list
482 '''
483 raise NotImplementedError
485 def lookup(self, keyvalue):
486 """Locate a particular node by its key property and return its id.
488 If this class has no key property, a TypeError is raised. If the
489 'keyvalue' matches one of the values for the key property among
490 the nodes in this class, the matching node's id is returned;
491 otherwise a KeyError is raised.
492 """
493 raise NotImplementedError
495 # XXX: change from spec - allows multiple props to match
496 def find(self, **propspec):
497 """Get the ids of nodes in this class which link to the given nodes.
499 'propspec' consists of keyword args propname={nodeid:1,}
500 'propname' must be the name of a property in this class, or a
501 KeyError is raised. That property must be a Link or Multilink
502 property, or a TypeError is raised.
504 Any node in this class whose 'propname' property links to any of the
505 nodeids will be returned. Used by the full text indexing, which knows
506 that "foo" occurs in msg1, msg3 and file7, so we have hits on these
507 issues:
509 db.issue.find(messages={'1':1,'3':1}, files={'7':1})
510 """
511 raise NotImplementedError
513 # XXX not in spec
514 def filter(self, search_matches, filterspec, sort, group,
515 num_re = re.compile('^\d+$')):
516 ''' Return a list of the ids of the active nodes in this class that
517 match the 'filter' spec, sorted by the group spec and then the
518 sort spec
519 '''
520 raise NotImplementedError
522 def count(self):
523 """Get the number of nodes in this class.
525 If the returned integer is 'numnodes', the ids of all the nodes
526 in this class run from 1 to numnodes, and numnodes+1 will be the
527 id of the next node to be created in this class.
528 """
529 raise NotImplementedError
531 # Manipulating properties:
532 def getprops(self, protected=1):
533 """Return a dictionary mapping property names to property objects.
534 If the "protected" flag is true, we include protected properties -
535 those which may not be modified.
536 """
537 raise NotImplementedError
539 def addprop(self, **properties):
540 """Add properties to this class.
542 The keyword arguments in 'properties' must map names to property
543 objects, or a TypeError is raised. None of the keys in 'properties'
544 may collide with the names of existing properties, or a ValueError
545 is raised before any properties have been added.
546 """
547 raise NotImplementedError
549 def index(self, nodeid):
550 '''Add (or refresh) the node to search indexes
551 '''
552 raise NotImplementedError
554 # XXX not in spec
555 class Node:
556 ''' A convenience wrapper for the given node
557 '''
558 def __init__(self, cl, nodeid, cache=1):
559 self.__dict__['cl'] = cl
560 self.__dict__['nodeid'] = nodeid
561 self.__dict__['cache'] = cache
562 def keys(self, protected=1):
563 return self.cl.getprops(protected=protected).keys()
564 def values(self, protected=1):
565 l = []
566 for name in self.cl.getprops(protected=protected).keys():
567 l.append(self.cl.get(self.nodeid, name, cache=self.cache))
568 return l
569 def items(self, protected=1):
570 l = []
571 for name in self.cl.getprops(protected=protected).keys():
572 l.append((name, self.cl.get(self.nodeid, name, cache=self.cache)))
573 return l
574 def has_key(self, name):
575 return self.cl.getprops().has_key(name)
576 def __getattr__(self, name):
577 if self.__dict__.has_key(name):
578 return self.__dict__[name]
579 try:
580 return self.cl.get(self.nodeid, name, cache=self.cache)
581 except KeyError, value:
582 # we trap this but re-raise it as AttributeError - all other
583 # exceptions should pass through untrapped
584 pass
585 # nope, no such attribute
586 raise AttributeError, str(value)
587 def __getitem__(self, name):
588 return self.cl.get(self.nodeid, name, cache=self.cache)
589 def __setattr__(self, name, value):
590 try:
591 return self.cl.set(self.nodeid, **{name: value})
592 except KeyError, value:
593 raise AttributeError, str(value)
594 def __setitem__(self, name, value):
595 self.cl.set(self.nodeid, **{name: value})
596 def history(self):
597 return self.cl.history(self.nodeid)
598 def retire(self):
599 return self.cl.retire(self.nodeid)
602 def Choice(name, db, *options):
603 '''Quick helper to create a simple class with choices
604 '''
605 cl = Class(db, name, name=String(), order=String())
606 for i in range(len(options)):
607 cl.create(name=options[i], order=i)
608 return hyperdb.Link(name)
610 #
611 # $Log: not supported by cvs2svn $
612 # Revision 1.77 2002/07/18 11:27:47 richard
613 # ws
614 #
615 # Revision 1.76 2002/07/18 11:17:30 gmcm
616 # Add Number and Boolean types to hyperdb.
617 # Add conversion cases to web, mail & admin interfaces.
618 # Add storage/serialization cases to back_anydbm & back_metakit.
619 #
620 # Revision 1.75 2002/07/14 02:05:53 richard
621 # . all storage-specific code (ie. backend) is now implemented by the backends
622 #
623 # Revision 1.74 2002/07/10 00:24:10 richard
624 # braino
625 #
626 # Revision 1.73 2002/07/10 00:19:48 richard
627 # Added explicit closing of backend database handles.
628 #
629 # Revision 1.72 2002/07/09 21:53:38 gmcm
630 # Optimize Class.find so that the propspec can contain a set of ids to match.
631 # This is used by indexer.search so it can do just one find for all the index matches.
632 # This was already confusing code, but for common terms (lots of index matches),
633 # it is enormously faster.
634 #
635 # Revision 1.71 2002/07/09 03:02:52 richard
636 # More indexer work:
637 # - all String properties may now be indexed too. Currently there's a bit of
638 # "issue" specific code in the actual searching which needs to be
639 # addressed. In a nutshell:
640 # + pass 'indexme="yes"' as a String() property initialisation arg, eg:
641 # file = FileClass(db, "file", name=String(), type=String(),
642 # comment=String(indexme="yes"))
643 # + the comment will then be indexed and be searchable, with the results
644 # related back to the issue that the file is linked to
645 # - as a result of this work, the FileClass has a default MIME type that may
646 # be overridden in a subclass, or by the use of a "type" property as is
647 # done in the default templates.
648 # - the regeneration of the indexes (if necessary) is done once the schema is
649 # set up in the dbinit.
650 #
651 # Revision 1.70 2002/06/27 12:06:20 gmcm
652 # Improve an error message.
653 #
654 # Revision 1.69 2002/06/17 23:15:29 richard
655 # Can debug to stdout now
656 #
657 # Revision 1.68 2002/06/11 06:52:03 richard
658 # . #564271 ] find() and new properties
659 #
660 # Revision 1.67 2002/06/11 05:02:37 richard
661 # . #565979 ] code error in hyperdb.Class.find
662 #
663 # Revision 1.66 2002/05/25 07:16:24 rochecompaan
664 # Merged search_indexing-branch with HEAD
665 #
666 # Revision 1.65 2002/05/22 04:12:05 richard
667 # . applied patch #558876 ] cgi client customization
668 # ... with significant additions and modifications ;)
669 # - extended handling of ML assignedto to all places it's handled
670 # - added more NotFound info
671 #
672 # Revision 1.64 2002/05/15 06:21:21 richard
673 # . node caching now works, and gives a small boost in performance
674 #
675 # As a part of this, I cleaned up the DEBUG output and implemented TRACE
676 # output (HYPERDBTRACE='file to trace to') with checkpoints at the start of
677 # CGI requests. Run roundup with python -O to skip all the DEBUG/TRACE stuff
678 # (using if __debug__ which is compiled out with -O)
679 #
680 # Revision 1.63 2002/04/15 23:25:15 richard
681 # . node ids are now generated from a lockable store - no more race conditions
682 #
683 # We're using the portalocker code by Jonathan Feinberg that was contributed
684 # to the ASPN Python cookbook. This gives us locking across Unix and Windows.
685 #
686 # Revision 1.62 2002/04/03 07:05:50 richard
687 # d'oh! killed retirement of nodes :(
688 # all better now...
689 #
690 # Revision 1.61 2002/04/03 06:11:51 richard
691 # Fix for old databases that contain properties that don't exist any more.
692 #
693 # Revision 1.60 2002/04/03 05:54:31 richard
694 # Fixed serialisation problem by moving the serialisation step out of the
695 # hyperdb.Class (get, set) into the hyperdb.Database.
696 #
697 # Also fixed htmltemplate after the showid changes I made yesterday.
698 #
699 # Unit tests for all of the above written.
700 #
701 # Revision 1.59.2.2 2002/04/20 13:23:33 rochecompaan
702 # We now have a separate search page for nodes. Search links for
703 # different classes can be customized in instance_config similar to
704 # index links.
705 #
706 # Revision 1.59.2.1 2002/04/19 19:54:42 rochecompaan
707 # cgi_client.py
708 # removed search link for the time being
709 # moved rendering of matches to htmltemplate
710 # hyperdb.py
711 # filtering of nodes on full text search incorporated in filter method
712 # roundupdb.py
713 # added paramater to call of filter method
714 # roundup_indexer.py
715 # added search method to RoundupIndexer class
716 #
717 # Revision 1.59 2002/03/12 22:52:26 richard
718 # more pychecker warnings removed
719 #
720 # Revision 1.58 2002/02/27 03:23:16 richard
721 # Ran it through pychecker, made fixes
722 #
723 # Revision 1.57 2002/02/20 05:23:24 richard
724 # Didn't accomodate new values for new properties
725 #
726 # Revision 1.56 2002/02/20 05:05:28 richard
727 # . Added simple editing for classes that don't define a templated interface.
728 # - access using the admin "class list" interface
729 # - limited to admin-only
730 # - requires the csv module from object-craft (url given if it's missing)
731 #
732 # Revision 1.55 2002/02/15 07:27:12 richard
733 # Oops, precedences around the way w0rng.
734 #
735 # Revision 1.54 2002/02/15 07:08:44 richard
736 # . Alternate email addresses are now available for users. See the MIGRATION
737 # file for info on how to activate the feature.
738 #
739 # Revision 1.53 2002/01/22 07:21:13 richard
740 # . fixed back_bsddb so it passed the journal tests
741 #
742 # ... it didn't seem happy using the back_anydbm _open method, which is odd.
743 # Yet another occurrance of whichdb not being able to recognise older bsddb
744 # databases. Yadda yadda. Made the HYPERDBDEBUG stuff more sane in the
745 # process.
746 #
747 # Revision 1.52 2002/01/21 16:33:19 rochecompaan
748 # You can now use the roundup-admin tool to pack the database
749 #
750 # Revision 1.51 2002/01/21 03:01:29 richard
751 # brief docco on the do_journal argument
752 #
753 # Revision 1.50 2002/01/19 13:16:04 rochecompaan
754 # Journal entries for link and multilink properties can now be switched on
755 # or off.
756 #
757 # Revision 1.49 2002/01/16 07:02:57 richard
758 # . lots of date/interval related changes:
759 # - more relaxed date format for input
760 #
761 # Revision 1.48 2002/01/14 06:32:34 richard
762 # . #502951 ] adding new properties to old database
763 #
764 # Revision 1.47 2002/01/14 02:20:15 richard
765 # . changed all config accesses so they access either the instance or the
766 # config attriubute on the db. This means that all config is obtained from
767 # instance_config instead of the mish-mash of classes. This will make
768 # switching to a ConfigParser setup easier too, I hope.
769 #
770 # At a minimum, this makes migration a _little_ easier (a lot easier in the
771 # 0.5.0 switch, I hope!)
772 #
773 # Revision 1.46 2002/01/07 10:42:23 richard
774 # oops
775 #
776 # Revision 1.45 2002/01/02 04:18:17 richard
777 # hyperdb docstrings
778 #
779 # Revision 1.44 2002/01/02 02:31:38 richard
780 # Sorry for the huge checkin message - I was only intending to implement #496356
781 # but I found a number of places where things had been broken by transactions:
782 # . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
783 # for _all_ roundup-generated smtp messages to be sent to.
784 # . the transaction cache had broken the roundupdb.Class set() reactors
785 # . newly-created author users in the mailgw weren't being committed to the db
786 #
787 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
788 # on when I found that stuff :):
789 # . #496356 ] Use threading in messages
790 # . detectors were being registered multiple times
791 # . added tests for mailgw
792 # . much better attaching of erroneous messages in the mail gateway
793 #
794 # Revision 1.43 2001/12/20 06:13:24 rochecompaan
795 # Bugs fixed:
796 # . Exception handling in hyperdb for strings-that-look-like numbers got
797 # lost somewhere
798 # . Internet Explorer submits full path for filename - we now strip away
799 # the path
800 # Features added:
801 # . Link and multilink properties are now displayed sorted in the cgi
802 # interface
803 #
804 # Revision 1.42 2001/12/16 10:53:37 richard
805 # take a copy of the node dict so that the subsequent set
806 # operation doesn't modify the oldvalues structure
807 #
808 # Revision 1.41 2001/12/15 23:47:47 richard
809 # Cleaned up some bare except statements
810 #
811 # Revision 1.40 2001/12/14 23:42:57 richard
812 # yuck, a gdbm instance tests false :(
813 # I've left the debugging code in - it should be removed one day if we're ever
814 # _really_ anal about performace :)
815 #
816 # Revision 1.39 2001/12/02 05:06:16 richard
817 # . We now use weakrefs in the Classes to keep the database reference, so
818 # the close() method on the database is no longer needed.
819 # I bumped the minimum python requirement up to 2.1 accordingly.
820 # . #487480 ] roundup-server
821 # . #487476 ] INSTALL.txt
822 #
823 # I also cleaned up the change message / post-edit stuff in the cgi client.
824 # There's now a clearly marked "TODO: append the change note" where I believe
825 # the change note should be added there. The "changes" list will obviously
826 # have to be modified to be a dict of the changes, or somesuch.
827 #
828 # More testing needed.
829 #
830 # Revision 1.38 2001/12/01 07:17:50 richard
831 # . We now have basic transaction support! Information is only written to
832 # the database when the commit() method is called. Only the anydbm
833 # backend is modified in this way - neither of the bsddb backends have been.
834 # The mail, admin and cgi interfaces all use commit (except the admin tool
835 # doesn't have a commit command, so interactive users can't commit...)
836 # . Fixed login/registration forwarding the user to the right page (or not,
837 # on a failure)
838 #
839 # Revision 1.37 2001/11/28 21:55:35 richard
840 # . login_action and newuser_action return values were being ignored
841 # . Woohoo! Found that bloody re-login bug that was killing the mail
842 # gateway.
843 # (also a minor cleanup in hyperdb)
844 #
845 # Revision 1.36 2001/11/27 03:16:09 richard
846 # Another place that wasn't handling missing properties.
847 #
848 # Revision 1.35 2001/11/22 15:46:42 jhermann
849 # Added module docstrings to all modules.
850 #
851 # Revision 1.34 2001/11/21 04:04:43 richard
852 # *sigh* more missing value handling
853 #
854 # Revision 1.33 2001/11/21 03:40:54 richard
855 # more new property handling
856 #
857 # Revision 1.32 2001/11/21 03:11:28 richard
858 # Better handling of new properties.
859 #
860 # Revision 1.31 2001/11/12 22:01:06 richard
861 # Fixed issues with nosy reaction and author copies.
862 #
863 # Revision 1.30 2001/11/09 10:11:08 richard
864 # . roundup-admin now handles all hyperdb exceptions
865 #
866 # Revision 1.29 2001/10/27 00:17:41 richard
867 # Made Class.stringFind() do caseless matching.
868 #
869 # Revision 1.28 2001/10/21 04:44:50 richard
870 # bug #473124: UI inconsistency with Link fields.
871 # This also prompted me to fix a fairly long-standing usability issue -
872 # that of being able to turn off certain filters.
873 #
874 # Revision 1.27 2001/10/20 23:44:27 richard
875 # Hyperdatabase sorts strings-that-look-like-numbers as numbers now.
876 #
877 # Revision 1.26 2001/10/16 03:48:01 richard
878 # admin tool now complains if a "find" is attempted with a non-link property.
879 #
880 # Revision 1.25 2001/10/11 00:17:51 richard
881 # Reverted a change in hyperdb so the default value for missing property
882 # values in a create() is None and not '' (the empty string.) This obviously
883 # breaks CSV import/export - the string 'None' will be created in an
884 # export/import operation.
885 #
886 # Revision 1.24 2001/10/10 03:54:57 richard
887 # Added database importing and exporting through CSV files.
888 # Uses the csv module from object-craft for exporting if it's available.
889 # Requires the csv module for importing.
890 #
891 # Revision 1.23 2001/10/09 23:58:10 richard
892 # Moved the data stringification up into the hyperdb.Class class' get, set
893 # and create methods. This means that the data is also stringified for the
894 # journal call, and removes duplication of code from the backends. The
895 # backend code now only sees strings.
896 #
897 # Revision 1.22 2001/10/09 07:25:59 richard
898 # Added the Password property type. See "pydoc roundup.password" for
899 # implementation details. Have updated some of the documentation too.
900 #
901 # Revision 1.21 2001/10/05 02:23:24 richard
902 # . roundup-admin create now prompts for property info if none is supplied
903 # on the command-line.
904 # . hyperdb Class getprops() method may now return only the mutable
905 # properties.
906 # . Login now uses cookies, which makes it a whole lot more flexible. We can
907 # now support anonymous user access (read-only, unless there's an
908 # "anonymous" user, in which case write access is permitted). Login
909 # handling has been moved into cgi_client.Client.main()
910 # . The "extended" schema is now the default in roundup init.
911 # . The schemas have had their page headings modified to cope with the new
912 # login handling. Existing installations should copy the interfaces.py
913 # file from the roundup lib directory to their instance home.
914 # . Incorrectly had a Bizar Software copyright on the cgitb.py module from
915 # Ping - has been removed.
916 # . Fixed a whole bunch of places in the CGI interface where we should have
917 # been returning Not Found instead of throwing an exception.
918 # . Fixed a deviation from the spec: trying to modify the 'id' property of
919 # an item now throws an exception.
920 #
921 # Revision 1.20 2001/10/04 02:12:42 richard
922 # Added nicer command-line item adding: passing no arguments will enter an
923 # interactive more which asks for each property in turn. While I was at it, I
924 # fixed an implementation problem WRT the spec - I wasn't raising a
925 # ValueError if the key property was missing from a create(). Also added a
926 # protected=boolean argument to getprops() so we can list only the mutable
927 # properties (defaults to yes, which lists the immutables).
928 #
929 # Revision 1.19 2001/08/29 04:47:18 richard
930 # Fixed CGI client change messages so they actually include the properties
931 # changed (again).
932 #
933 # Revision 1.18 2001/08/16 07:34:59 richard
934 # better CGI text searching - but hidden filter fields are disappearing...
935 #
936 # Revision 1.17 2001/08/16 06:59:58 richard
937 # all searches use re now - and they're all case insensitive
938 #
939 # Revision 1.16 2001/08/15 23:43:18 richard
940 # Fixed some isFooTypes that I missed.
941 # Refactored some code in the CGI code.
942 #
943 # Revision 1.15 2001/08/12 06:32:36 richard
944 # using isinstance(blah, Foo) now instead of isFooType
945 #
946 # Revision 1.14 2001/08/07 00:24:42 richard
947 # stupid typo
948 #
949 # Revision 1.13 2001/08/07 00:15:51 richard
950 # Added the copyright/license notice to (nearly) all files at request of
951 # Bizar Software.
952 #
953 # Revision 1.12 2001/08/02 06:38:17 richard
954 # Roundupdb now appends "mailing list" information to its messages which
955 # include the e-mail address and web interface address. Templates may
956 # override this in their db classes to include specific information (support
957 # instructions, etc).
958 #
959 # Revision 1.11 2001/08/01 04:24:21 richard
960 # mailgw was assuming certain properties existed on the issues being created.
961 #
962 # Revision 1.10 2001/07/30 02:38:31 richard
963 # get() now has a default arg - for migration only.
964 #
965 # Revision 1.9 2001/07/29 09:28:23 richard
966 # Fixed sorting by clicking on column headings.
967 #
968 # Revision 1.8 2001/07/29 08:27:40 richard
969 # Fixed handling of passed-in values in form elements (ie. during a
970 # drill-down)
971 #
972 # Revision 1.7 2001/07/29 07:01:39 richard
973 # Added vim command to all source so that we don't get no steenkin' tabs :)
974 #
975 # Revision 1.6 2001/07/29 05:36:14 richard
976 # Cleanup of the link label generation.
977 #
978 # Revision 1.5 2001/07/29 04:05:37 richard
979 # Added the fabricated property "id".
980 #
981 # Revision 1.4 2001/07/27 06:25:35 richard
982 # Fixed some of the exceptions so they're the right type.
983 # Removed the str()-ification of node ids so we don't mask oopsy errors any
984 # more.
985 #
986 # Revision 1.3 2001/07/27 05:17:14 richard
987 # just some comments
988 #
989 # Revision 1.2 2001/07/22 12:09:32 richard
990 # Final commit of Grande Splite
991 #
992 # Revision 1.1 2001/07/22 11:58:35 richard
993 # More Grande Splite
994 #
995 #
996 # vim: set filetype=python ts=4 sw=4 et si