Use getuid(), not figure_curuserid()

- Extended getuid() to replace figure_curuserid().

- Replace all references to curuserid with calls to getuid().

- Changed the docs to point to always point to getuid() and mention the change
in upgrading.txt.

Author: Johannes Gijsbers

doc/customizing.txt

@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.96 $
+:Version: $Revision: 1.97 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1635,7 +1635,7 @@ you want access to the "user" class, for example, you would use::
   python:db.user
 
 Also, the current id of the current user is available as
-``db.curuserid``. This isn't so useful in templates (where you have
+``db.getuid()``. This isn't so useful in templates (where you have
 ``request/user``), but it can be useful in detectors or interfaces.
 
 The access results in a `hyperdb class wrapper`_.

doc/design.txt

@@ -292,9 +292,6 @@ Here is the interface provided by the hyperdatabase::
     class Database:
         """A database for storing records containing flexible data
         types.
-
-        The id of the current user is available on the database as
-        'self.curuserid'.
         """
 
         def __init__(self, config, journaltag=None):

doc/upgrading.txt

@@ -7,6 +7,16 @@ accordingly.
 
 .. contents::
 
+Migrating from 0.6 to 0.7
+=========================
+
+0.7.0 Getting the current user id
+---------------------------------
+
+Removed Database.curuserid attribute. Any code referencing this attribute should
+be replaced with a call to Database.getuid().
+
+
 Migrating from 0.5 to 0.6
 =========================
 

roundup/backends/back_anydbm.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-#$Id: back_anydbm.py,v 1.126 2003-09-06 20:01:10 jlgijsbers Exp $
+#$Id: back_anydbm.py,v 1.127 2003-09-08 20:39:18 jlgijsbers Exp $
 '''
 This module defines a backend that saves the hyperdatabase in a database
 chosen by anydbm. It is guaranteed to always be available in python
@@ -87,7 +87,6 @@ def post_init(self):
         # reindex the db if necessary
         if self.indexer.should_reindex():
             self.reindex()
-        self.figure_curuserid()
 
     def reindex(self):
         for klass in self.classes.values():
@@ -243,7 +242,7 @@ def addnode(self, classname, nodeid, node):
             # add in the "calculated" properties (dupe so we don't affect
             # calling code's node assumptions)
             node = node.copy()
-            node['creator'] = self.curuserid
+            node['creator'] = self.getuid()
             node['creation'] = node['activity'] = date.Date()
 
         self.newnodes.setdefault(classname, {})[nodeid] = 1
@@ -489,7 +488,7 @@ def getjournal(self, classname, nodeid):
                 cache_creator, cache_creation) = args
             if cache_classname == classname and cache_nodeid == nodeid:
                 if not cache_creator:
-                    cache_creator = self.curuserid
+                    cache_creator = self.getuid()
                 if not cache_creation:
                     cache_creation = date.Date()
                 res.append((cache_nodeid, cache_creation, cache_creator,
@@ -636,7 +635,7 @@ def doSaveJournal(self, classname, nodeid, action, params, creator,
         if creator:
             journaltag = creator
         else:
-            journaltag = self.curuserid
+            journaltag = self.getuid()
         if creation:
             journaldate = creation.serialise()
         else:
@@ -1056,7 +1055,7 @@ def get(self, nodeid, propname, default=_marker, cache=1):
                         # user's been retired, return admin
                         return '1'
             else:
-                return self.db.curuserid
+                return self.db.getuid()
 
         # get the property (raises KeyErorr if invalid)
         prop = self.properties[propname]

roundup/backends/back_bsddb.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-#$Id: back_bsddb.py,v 1.26 2003-05-09 01:47:50 richard Exp $
+#$Id: back_bsddb.py,v 1.27 2003-09-08 20:39:18 jlgijsbers Exp $
 '''
 This module defines a backend that saves the hyperdatabase in BSDDB.
 '''
@@ -93,7 +93,7 @@ def getjournal(self, classname, nodeid):
                 cache_creator, cache_creation) = args
             if cache_classname == classname and cache_nodeid == nodeid:
                 if not cache_creator:
-                    cache_creator = self.curuserid
+                    cache_creator = self.getuid()
                 if not cache_creation:
                     cache_creation = date.Date()
                 res.append((cache_nodeid, cache_creation, cache_creator,

roundup/backends/back_bsddb3.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-#$Id: back_bsddb3.py,v 1.19 2003-05-09 01:47:50 richard Exp $
+#$Id: back_bsddb3.py,v 1.20 2003-09-08 20:39:18 jlgijsbers Exp $
 '''
 This module defines a backend that saves the hyperdatabase in BSDDB3.
 '''
@@ -93,7 +93,7 @@ def getjournal(self, classname, nodeid):
                 cache_creator, cache_creation) = args
             if cache_classname == classname and cache_nodeid == nodeid:
                 if not cache_creator:
-                    cache_creator = self.curuserid
+                    cache_creator = self.getuid()
                 if not cache_creation:
                     cache_creation = date.Date()
                 res.append((cache_nodeid, cache_creation, cache_creator,

roundup/backends/back_metakit.py

@@ -1,4 +1,4 @@
-# $Id: back_metakit.py,v 1.49 2003-09-04 00:47:01 richard Exp $
+# $Id: back_metakit.py,v 1.50 2003-09-08 20:39:18 jlgijsbers Exp $
 '''
    Metakit backend for Roundup, originally by Gordon McMillan.
 
@@ -48,10 +48,6 @@ def Database(config, journaltag=None):
         _dbs[config.DATABASE] = db
     else:
         db.journaltag = journaltag
-        try:
-            delattr(db, 'curuserid')
-        except AttributeError:
-            pass
     return db
 
 class _Database(hyperdb.Database, roundupdb.Database):
@@ -81,21 +77,7 @@ def reindex(self):
 
     # --- defined in ping's spec
     def __getattr__(self, classname):
-        if classname == 'curuserid':
-            if self.journaltag is None:
-                return None
-
-            # try to set the curuserid from the journaltag
-            try:
-                x = int(self.classes['user'].lookup(self.journaltag))
-                self.curuserid = x
-            except KeyError:
-                if self.journaltag == 'admin':
-                    self.curuserid = x = 1
-                else:
-                    x = 0
-            return x
-        elif classname == 'transactions':
+        if classname == 'transactions':
             return self.dirty
         # fall back on the classes
         return self.getclass(classname)
@@ -154,7 +136,7 @@ def addjournal(self, tablenm, nodeid, action, params, creator=None,
         if tblid == -1:
             tblid = self.tables.append(name=tablenm)
         if creator is None:
-            creator = self.curuserid
+            creator = self.getuid()
         else:
             try:
                 creator = int(creator)
@@ -642,7 +624,7 @@ def set(self, nodeid, **propvalues):
             if not row.creation:
                 row.creation = int(time.time())
             if not row.creator:
-                row.creator = self.db.curuserid
+                row.creator = self.db.getuid()
 
         self.db.dirty = 1
         if self.do_journal:

roundup/backends/rdbms_common.py

@@ -1,4 +1,4 @@
-# $Id: rdbms_common.py,v 1.61 2003-09-06 20:01:10 jlgijsbers Exp $
+# $Id: rdbms_common.py,v 1.62 2003-09-08 20:39:18 jlgijsbers Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -145,8 +145,6 @@ def post_init(self):
         # commit
         self.conn.commit()
 
-        self.figure_curuserid()
-
     def reindex(self):
         for klass in self.classes.values():
             for nodeid in klass.list():
@@ -442,7 +440,7 @@ def addnode(self, classname, nodeid, node):
             # calling code's node assumptions)
             node = node.copy()
             node['creation'] = node['activity'] = date.Date()
-            node['creator'] = self.curuserid
+            node['creator'] = self.getuid()
 
         # default the non-multilink columns
         for col, prop in cl.properties.items():
@@ -732,7 +730,7 @@ def addjournal(self, classname, nodeid, action, params, creator=None,
         if creator:
             journaltag = creator
         else:
-            journaltag = self.curuserid
+            journaltag = self.getuid()
         if creation:
             journaldate = creation.serialise()
         else:
@@ -1198,7 +1196,7 @@ def get(self, nodeid, propname, default=_marker, cache=1):
             if d.has_key('creator'):
                 return d['creator']
             else:
-                return self.db.curuserid
+                return self.db.getuid()
 
         # get the property (raises KeyErorr if invalid)
         prop = self.properties[propname]

roundup/roundupdb.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: roundupdb.py,v 1.89 2003-09-08 09:28:28 jlgijsbers Exp $
+# $Id: roundupdb.py,v 1.90 2003-09-08 20:39:18 jlgijsbers Exp $
 
 __doc__ = """
 Extending hyperdb with types specific to issue-tracking.
@@ -35,7 +35,13 @@ class Database:
     def getuid(self):
         """Return the id of the "user" node associated with the user
         that owns this connection to the hyperdatabase."""
-        return self.user.lookup(self.journaltag)
+        if self.journaltag is None:
+            return None
+        elif self.journaltag == 'admin':
+            # admin user may not exist, but always has ID 1
+            return '1'
+        else:
+            return self.user.lookup(self.journaltag)
 
     def getUserTimezone(self):
         """Return user timezone defined in 'timezone' property of user class.
@@ -51,16 +57,6 @@ def getUserTimezone(self):
             timezone = 0
         return timezone
 
-    def figure_curuserid(self):
-        """Figure out the 'curuserid'."""
-        if self.journaltag is None:
-            self.curuserid = None
-        elif self.journaltag == 'admin':
-            # admin user may not exist, but always has ID 1
-            self.curuserid = '1'
-        else:
-            self.curuserid = self.user.lookup(self.journaltag)
-
     def confirm_registration(self, otk):
         props = self.otks.getall(otk)
         for propname, proptype in self.user.getprops().items():
@@ -77,7 +73,6 @@ def confirm_registration(self, otk):
 
         # tag new user creation with 'admin'
         self.journaltag = 'admin'
-        self.figure_curuserid()
 
         # create the new user
         cl = self.user