Mercurial Repository: p/roundup/code: doc/customizing.txt comparison

comparison doc/customizing.txt @ 2017:31d920b31642

Update customization examples too, expand upgrade notice a bit.

author	Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
date	Sat, 14 Feb 2004 17:18:01 +0000
parents	2112962f5bb1
children	be047db3dd3d

comparison

equal deleted inserted replaced

-:2112962f5bb1
+:31d920b31642
 ===================
 Customising Roundup
 ===================
-:Version: $Revision: 1.114 $
+:Version: $Revision: 1.115 $
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
 .. contents::
 them to :filter.
 - Also handle the ":queryname" variable and save off the query to the
 user's query list.
-Each of the actions is implemented by a corresponding ``*actionAction*``
+Each of the actions is implemented by a corresponding ``*XxxAction*`` (where
-(where "action" is the name of the action) method on the
+"Xxx" is the name of the action) class in the ``roundup.cgi.actions`` module.
-``roundup.cgi.Client`` class, which also happens to be available in your
+These classes are registered with ``roundup.cgi.client.Client`` which also
-tracker instance as ``interfaces.Client``. So if you need to define new
+happens to be available in your tracker instance as ``interfaces.Client``. So
-actions, you may add them there (see `defining new web actions`_).
+if you need to define new actions, you may add them there (see `defining new
+web actions`_).
-Each action also has a corresponding ``*actionPermission*`` (where
-"action" is the name of the action) method which determines whether the
+Each action class also has a ``*permission*`` method which determines whether
-action is permissible given the current user. The base permission checks
+the action is permissible given the current user. The base permission checks
 are:
 **login**
 Determine whether the user has permission to log in. Base behaviour is
 to check the user has "Web Access".
 def handle(self):
 ''' Perform some action. No return value is required.
 '''
 The *self.client* attribute is an instance of your tracker ``instance.Client``
-class - thus it's mostly implemented by ``roundup.cgi.Client``. See the
+class - thus it's mostly implemented by ``roundup.cgi.client.Client``. See the
 docstring of that class for details of what it can do.
 The method will typically check the ``self.form`` variable's contents.
 It may then:
 the ``crypt`` module in your Python distribution). An example entry
 would be::
 admin:aamrgyQfDFSHw
-Each user of Roundup must still have their information stored in the
+Each user of Roundup must still have their information stored in the Roundup
-Roundup database - we just use the passwd file to check their password.
+database - we just use the passwd file to check their password. To do this, we
-To do this, we add the following code to our ``Client`` class in the
+need to override the standard ``verifyPassword`` method defined in
-tracker home ``interfaces.py`` module::
+``roundup.cgi.actions.LoginAction`` and register the new class with our
+``Client`` class in the tracker home ``interfaces.py`` module::
-def verifyPassword(self, userid, password):
-# get the user's username
+from roundup.cgi.actions import LoginAction
-username = self.db.user.get(userid, 'username')
+class ExternalPasswordLoginAction(LoginAction):
-# the passwords are stored in the "passwd.txt" file in the
+def verifyPassword(self, userid, password):
-# tracker home
+# get the user's username
-file = os.path.join(self.db.config.TRACKER_HOME, 'passwd.txt')
+username = self.db.user.get(userid, 'username')
-# see if we can find a match
+# the passwords are stored in the "passwd.txt" file in the
-for ent in [line.strip().split(':') for line in
+# tracker home
-open(file).readlines()]:
+file = os.path.join(self.db.config.TRACKER_HOME, 'passwd.txt')
-if ent[0] == username:
-return crypt.crypt(password, ent[1][:2]) == ent[1]
+# see if we can find a match
+for ent in [line.strip().split(':') for line in
-# user doesn't exist in the file
+open(file).readlines()]:
-return 0
+if ent[0] == username:
+return crypt.crypt(password, ent[1][:2]) == ent[1]
+# user doesn't exist in the file
+return 0
+class Client(client.Client):
+actions = client.Client.actions + (
+('login', ExternalPasswordLoginAction)
+)
 What this does is look through the file, line by line, looking for a
 name that matches.
 We also remove the redundant password fields from the ``user.item``
 workflow). See the example `Using a UN*X passwd file as the user database`_
 for more information about doing this.
 To authenticate off the LDAP store (rather than using the passwords in the
 roundup user database) you'd use the same python-ldap module inside an
-extension to the cgi interface. You'd do this by adding a method called
+extension to the cgi interface. You'd do this by overriding the method called
-"verifyPassword" to the Client class in your tracker's interfaces.py
+"verifyPassword" on the LoginAction class in your tracker's interfaces.py
-module. The method is implemented by default as::
+module (see `using an external password validation source`_). The method is
+implemented by default as::
 def verifyPassword(self, userid, password):
 ''' Verify the password that the user has supplied
 '''
 stored = self.db.user.get(self.userid, 'password')

Mercurial > p > roundup > code

comparison doc/customizing.txt @ 2017:31d920b31642