X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=roundup%2Fcgi_client.py;h=0e446d48c3416eba68af6f936306d1c5e1bed7cd;hb=cd355af47a60fa0ea49b4a42a376066dae1c7716;hp=7cb0ba2830ffc7674e2b68a5685f6f43cec25079;hpb=d46fae7b1b6f9da734e537ffb8743e89d50b6a63;p=roundup.git
diff --git a/roundup/cgi_client.py b/roundup/cgi_client.py
index 7cb0ba2..0e446d4 100644
--- a/roundup/cgi_client.py
+++ b/roundup/cgi_client.py
@@ -15,14 +15,14 @@
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-# $Id: cgi_client.py,v 1.67 2001-11-28 21:55:35 richard Exp $
+# $Id: cgi_client.py,v 1.103 2002-02-20 05:05:28 richard Exp $
__doc__ = """
WWW request handler (also used in the stand-alone server).
"""
import os, cgi, pprint, StringIO, urlparse, re, traceback, mimetypes
-import binascii, Cookie, time
+import binascii, Cookie, time, random
import roundupdb, htmltemplate, date, hyperdb, password
from roundup.i18n import _
@@ -44,30 +44,19 @@ class Client:
'anonymous' user exists, the user is logged in using that user (though
there is no cookie). This allows them to modify the database, and all
modifications are attributed to the 'anonymous' user.
-
-
- Customisation
- -------------
- FILTER_POSITION - one of 'top', 'bottom', 'top and bottom'
- ANONYMOUS_ACCESS - one of 'deny', 'allow'
- ANONYMOUS_REGISTER - one of 'deny', 'allow'
-
- from the roundup class:
- INSTANCE_NAME - defaults to 'Roundup issue tracker'
-
'''
- FILTER_POSITION = 'bottom' # one of 'top', 'bottom', 'top and bottom'
- ANONYMOUS_ACCESS = 'deny' # one of 'deny', 'allow'
- ANONYMOUS_REGISTER = 'deny' # one of 'deny', 'allow'
- def __init__(self, instance, request, env):
+ def __init__(self, instance, request, env, form=None):
self.instance = instance
self.request = request
self.env = env
self.path = env['PATH_INFO']
self.split_path = self.path.split('/')
- self.form = cgi.FieldStorage(environ=env)
+ if form is None:
+ self.form = cgi.FieldStorage(environ=env)
+ else:
+ self.form = form
self.headers_done = 0
try:
self.debug = int(env.get("ROUNDUP_DEBUG", 0))
@@ -91,6 +80,20 @@ class Client:
if self.debug:
self.headers_sent = headers
+ single_submit_script = '''
+
+'''
+
def pagehead(self, title, message=None):
url = self.env['SCRIPT_NAME'] + '/'
machine = self.env['SERVER_NAME']
@@ -98,62 +101,62 @@ class Client:
if port != '80': machine = machine + ':' + port
base = urlparse.urlunparse(('http', machine, url, None, None, None))
if message is not None:
- message = '
'%(cn, cn.capitalize()))
for key, value in cl.properties.items():
if value is None: value = ''
else: value = str(value)
@@ -639,12 +835,14 @@ class Client:
raise Unauthorised
def login(self, message=None, newuser_form=None, action='index'):
+ '''Display a login page.
+ '''
self.pagehead(_('Login to roundup'), message)
- self.write('''
+ self.write(_('''
Existing User Login
-
-'''%action)
- if self.user is None and self.ANONYMOUS_REGISTER == 'deny':
+''')%locals())
+ if self.user is None and self.instance.ANONYMOUS_REGISTER == 'deny':
self.write('
')
self.pagefoot()
return
values = {'realname': '', 'organisation': '', 'address': '',
- 'phone': '', 'username': '', 'password': '', 'confirm': ''}
+ 'phone': '', 'username': '', 'password': '', 'confirm': '',
+ 'action': action, 'alternate_addresses': ''}
if newuser_form is not None:
for key in newuser_form.keys():
values[key] = newuser_form[key].value
- self.write('''
+ self.write(_('''
New User Registration
marked items are optional...
-
-'''%values)
+''')%values)
self.pagefoot()
def login_action(self, message=None):
+ '''Attempt to log a user in and set the cookie
+
+ returns 0 if a page is generated as a result of this call, and
+ 1 if not (ie. the login is successful
+ '''
if not self.form.has_key('__login_name'):
- return self.login(message='Username required')
+ self.login(message=_('Username required'))
+ return 0
self.user = self.form['__login_name'].value
if self.form.has_key('__login_password'):
password = self.form['__login_password'].value
@@ -702,16 +910,44 @@ class Client:
except KeyError:
name = self.user
self.make_user_anonymous()
- return self.login(message=_('No such user "%(name)s"')%locals())
+ action = self.form['__destination_url'].value
+ self.login(message=_('No such user "%(name)s"')%locals(),
+ action=action)
+ return 0
# and that the password is correct
pw = self.db.user.get(uid, 'password')
- if password != self.db.user.get(uid, 'password'):
+ if password != pw:
self.make_user_anonymous()
- return self.login(message=_('Incorrect password'))
+ action = self.form['__destination_url'].value
+ self.login(message=_('Incorrect password'), action=action)
+ return 0
self.set_cookie(self.user, password)
- return None # make it explicit
+ return 1
+
+ def newuser_action(self, message=None):
+ '''Attempt to create a new user based on the contents of the form
+ and then set the cookie.
+
+ return 1 on successful login
+ '''
+ # re-open the database as "admin"
+ self.db = self.instance.open('admin')
+
+ # TODO: pre-check the required fields and username key property
+ cl = self.db.user
+ try:
+ props = parsePropsFromForm(self.db, cl, self.form)
+ uid = cl.create(**props)
+ except ValueError, message:
+ action = self.form['__destination_url'].value
+ self.login(message, action=action)
+ return 0
+ self.user = cl.get(uid, 'username')
+ password = cl.get(uid, 'password')
+ self.set_cookie(self.user, self.form['password'].value)
+ return 1
def set_cookie(self, user, password):
# construct the cookie
@@ -742,29 +978,11 @@ class Client:
self.header({'Set-Cookie':
'roundup_user=deleted; Max-Age=0; expires=%s; Path=%s;'%(now,
path)})
- return self.login()
-
- def newuser_action(self, message=None):
- ''' create a new user based on the contents of the form and then
- set the cookie
- '''
- # re-open the database as "admin"
- self.db.close()
- self.db = self.instance.open('admin')
-
- # TODO: pre-check the required fields and username key property
- cl = self.db.user
- try:
- props, dummy = parsePropsFromForm(self.db, cl, self.form)
- uid = cl.create(**props)
- except ValueError, message:
- return self.login(message, newuser_form=self.form)
- self.user = cl.get(uid, 'username')
- password = cl.get(uid, 'password')
- self.set_cookie(self.user, self.form['password'].value)
- return None # make the None explicit
+ self.login()
def main(self):
+ '''Wrap the database accesses so we can close the database cleanly
+ '''
# determine the uid to use
self.db = self.instance.open('admin')
cookie = Cookie.Cookie(self.env.get('HTTP_COOKIE', ''))
@@ -794,7 +1012,6 @@ class Client:
self.make_user_anonymous()
else:
self.user = user
- self.db.close()
# re-open the database for real, using the user
self.db = self.instance.open(self.user)
@@ -815,56 +1032,67 @@ class Client:
# everyone is allowed to try to log in
if action == 'login_action':
- # do the login
- ret = self.login_action()
- if ret is not None:
- return ret
+ # try to login
+ if not self.login_action():
+ return
# figure the resulting page
action = self.form['__destination_url'].value
if not action:
action = 'index'
- return self.do_action(action)
+ self.do_action(action)
+ return
# allow anonymous people to register
if action == 'newuser_action':
# if we don't have a login and anonymous people aren't allowed to
# register, then spit up the login form
- if self.ANONYMOUS_REGISTER == 'deny' and self.user is None:
+ if self.instance.ANONYMOUS_REGISTER == 'deny' and self.user is None:
if action == 'login':
- return self.login() # go to the index after login
+ self.login() # go to the index after login
else:
- return self.login(action=action)
- # add the user
- ret = self.newuser_action()
- if ret is not None:
- return ret
+ self.login(action=action)
+ return
+ # try to add the user
+ if not self.newuser_action():
+ return
# figure the resulting page
action = self.form['__destination_url'].value
if not action:
action = 'index'
- return self.do_action(action)
# no login or registration, make sure totally anonymous access is OK
- if self.ANONYMOUS_ACCESS == 'deny' and self.user is None:
+ elif self.instance.ANONYMOUS_ACCESS == 'deny' and self.user is None:
if action == 'login':
- return self.login() # go to the index after login
+ self.login() # go to the index after login
else:
- return self.login(action=action)
+ self.login(action=action)
+ return
# just a regular action
- return self.do_action(action)
+ self.do_action(action)
+
+ # commit all changes to the database
+ self.db.commit()
def do_action(self, action, dre=re.compile(r'([^\d]+)(\d+)'),
nre=re.compile(r'new(\w+)')):
+ '''Figure the user's action and do it.
+ '''
# here be the "normal" functionality
if action == 'index':
- return self.index()
+ self.index()
+ return
if action == 'list_classes':
- return self.classes()
+ self.classes()
+ return
if action == 'login':
- return self.login()
+ self.login()
+ return
if action == 'logout':
- return self.logout()
+ self.logout()
+ return
+
+ # see if we're to display an existing node
m = dre.match(action)
if m:
self.classname = m.group(1)
@@ -881,7 +1109,10 @@ class Client:
func = getattr(self, 'show%s'%self.classname)
except AttributeError:
raise NotFound
- return func()
+ func()
+ return
+
+ # see if we're to put up the new node page
m = nre.match(action)
if m:
self.classname = m.group(1)
@@ -889,16 +1120,16 @@ class Client:
func = getattr(self, 'new%s'%self.classname)
except AttributeError:
raise NotFound
- return func()
+ func()
+ return
+
+ # otherwise, display the named class
self.classname = action
try:
self.db.getclass(self.classname)
except KeyError:
raise NotFound
- return self.list()
-
- def __del__(self):
- self.db.close()
+ self.list()
class ExtendedClient(Client):
@@ -923,62 +1154,62 @@ class ExtendedClient(Client):
if port != '80': machine = machine + ':' + port
base = urlparse.urlunparse(('http', machine, url, None, None, None))
if message is not None:
- message = '
-'''%(title, style, message, title, user_name, add_links, admin_links,
- user_info))
+''')%locals())
def parsePropsFromForm(db, cl, form, nodeid=0):
'''Pull properties for the given class out of the form.
'''
props = {}
- changed = []
keys = form.keys()
num_re = re.compile('^\d+$')
for key in keys:
@@ -990,9 +1221,17 @@ def parsePropsFromForm(db, cl, form, nodeid=0):
elif isinstance(proptype, hyperdb.Password):
value = password.Password(form[key].value.strip())
elif isinstance(proptype, hyperdb.Date):
- value = date.Date(form[key].value.strip())
+ value = form[key].value.strip()
+ if value:
+ value = date.Date(form[key].value.strip())
+ else:
+ value = None
elif isinstance(proptype, hyperdb.Interval):
- value = date.Interval(form[key].value.strip())
+ value = form[key].value.strip()
+ if value:
+ value = date.Interval(form[key].value.strip())
+ else:
+ value = None
elif isinstance(proptype, hyperdb.Link):
value = form[key].value.strip()
# see if it's the "no selection" choice
@@ -1006,8 +1245,9 @@ def parsePropsFromForm(db, cl, form, nodeid=0):
try:
value = db.classes[link].lookup(value)
except KeyError:
- raise ValueError, 'property "%s": %s not a %s'%(
- key, value, link)
+ raise ValueError, _('property "%(propname)s": '
+ '%(value)s not a %(classname)s')%{'propname':key,
+ 'value': value, 'classname': link}
elif isinstance(proptype, hyperdb.Multilink):
value = form[key]
if type(value) != type([]):
@@ -1017,17 +1257,17 @@ def parsePropsFromForm(db, cl, form, nodeid=0):
link = cl.properties[key].classname
l = []
for entry in map(str, value):
+ if entry == '': continue
if not num_re.match(entry):
try:
entry = db.classes[link].lookup(entry)
except KeyError:
- raise ValueError, \
- 'property "%s": "%s" not an entry of %s'%(key,
- entry, link.capitalize())
+ raise ValueError, _('property "%(propname)s": '
+ '"%(value)s" not an entry of %(classname)s')%{
+ 'propname':key, 'value': entry, 'classname': link}
l.append(entry)
l.sort()
value = l
- props[key] = value
# get the old value
if nodeid:
@@ -1038,14 +1278,213 @@ def parsePropsFromForm(db, cl, form, nodeid=0):
# value
if not cl.properties.has_key(key): raise
- # if changed, set it
- if nodeid and value != existing:
- changed.append(key)
+ # if changed, set it
+ if value != existing:
+ props[key] = value
+ else:
props[key] = value
- return props, changed
+ return props
#
# $Log: not supported by cvs2svn $
+# Revision 1.102 2002/02/15 07:08:44 richard
+# . Alternate email addresses are now available for users. See the MIGRATION
+# file for info on how to activate the feature.
+#
+# Revision 1.101 2002/02/14 23:39:18 richard
+# . All forms now have "double-submit" protection when Javascript is enabled
+# on the client-side.
+#
+# Revision 1.100 2002/01/16 07:02:57 richard
+# . lots of date/interval related changes:
+# - more relaxed date format for input
+#
+# Revision 1.99 2002/01/16 03:02:42 richard
+# #503793 ] changing assignedto resets nosy list
+#
+# Revision 1.98 2002/01/14 02:20:14 richard
+# . changed all config accesses so they access either the instance or the
+# config attriubute on the db. This means that all config is obtained from
+# instance_config instead of the mish-mash of classes. This will make
+# switching to a ConfigParser setup easier too, I hope.
+#
+# At a minimum, this makes migration a _little_ easier (a lot easier in the
+# 0.5.0 switch, I hope!)
+#
+# Revision 1.97 2002/01/11 23:22:29 richard
+# . #502437 ] rogue reactor and unittest
+# in short, the nosy reactor was modifying the nosy list. That code had
+# been there for a long time, and I suspsect it was there because we
+# weren't generating the nosy list correctly in other places of the code.
+# We're now doing that, so the nosy-modifying code can go away from the
+# nosy reactor.
+#
+# Revision 1.96 2002/01/10 05:26:10 richard
+# missed a parsePropsFromForm in last update
+#
+# Revision 1.95 2002/01/10 03:39:45 richard
+# . fixed some problems with web editing and change detection
+#
+# Revision 1.94 2002/01/09 13:54:21 grubert
+# _add_assignedto_to_nosy did set nosy to assignedto only, no adding.
+#
+# Revision 1.93 2002/01/08 11:57:12 richard
+# crying out for real configuration handling... :(
+#
+# Revision 1.92 2002/01/08 04:12:05 richard
+# Changed message-id format to "<%s.%s.%s%s@%s>" so it complies with RFC822
+#
+# Revision 1.91 2002/01/08 04:03:47 richard
+# I mucked the intent of the code up.
+#
+# Revision 1.90 2002/01/08 03:56:55 richard
+# Oops, missed this before the beta:
+# . #495392 ] empty nosy -patch
+#
+# Revision 1.89 2002/01/07 20:24:45 richard
+# *mutter* stupid cutnpaste
+#
+# Revision 1.88 2002/01/02 02:31:38 richard
+# Sorry for the huge checkin message - I was only intending to implement #496356
+# but I found a number of places where things had been broken by transactions:
+# . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
+# for _all_ roundup-generated smtp messages to be sent to.
+# . the transaction cache had broken the roundupdb.Class set() reactors
+# . newly-created author users in the mailgw weren't being committed to the db
+#
+# Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
+# on when I found that stuff :):
+# . #496356 ] Use threading in messages
+# . detectors were being registered multiple times
+# . added tests for mailgw
+# . much better attaching of erroneous messages in the mail gateway
+#
+# Revision 1.87 2001/12/23 23:18:49 richard
+# We already had an admin-specific section of the web heading, no need to add
+# another one :)
+#
+# Revision 1.86 2001/12/20 15:43:01 rochecompaan
+# Features added:
+# . Multilink properties are now displayed as comma separated values in
+# a textbox
+# . The add user link is now only visible to the admin user
+# . Modified the mail gateway to reject submissions from unknown
+# addresses if ANONYMOUS_ACCESS is denied
+#
+# Revision 1.85 2001/12/20 06:13:24 rochecompaan
+# Bugs fixed:
+# . Exception handling in hyperdb for strings-that-look-like numbers got
+# lost somewhere
+# . Internet Explorer submits full path for filename - we now strip away
+# the path
+# Features added:
+# . Link and multilink properties are now displayed sorted in the cgi
+# interface
+#
+# Revision 1.84 2001/12/18 15:30:30 rochecompaan
+# Fixed bugs:
+# . Fixed file creation and retrieval in same transaction in anydbm
+# backend
+# . Cgi interface now renders new issue after issue creation
+# . Could not set issue status to resolved through cgi interface
+# . Mail gateway was changing status back to 'chatting' if status was
+# omitted as an argument
+#
+# Revision 1.83 2001/12/15 23:51:01 richard
+# Tested the changes and fixed a few problems:
+# . files are now attached to the issue as well as the message
+# . newuser is a real method now since we don't want to do the message/file
+# stuff for it
+# . added some documentation
+# The really big changes in the diff are a result of me moving some code
+# around to keep like methods together a bit better.
+#
+# Revision 1.82 2001/12/15 19:24:39 rochecompaan
+# . Modified cgi interface to change properties only once all changes are
+# collected, files created and messages generated.
+# . Moved generation of change note to nosyreactors.
+# . We now check for changes to "assignedto" to ensure it's added to the
+# nosy list.
+#
+# Revision 1.81 2001/12/12 23:55:00 richard
+# Fixed some problems with user editing
+#
+# Revision 1.80 2001/12/12 23:27:14 richard
+# Added a Zope frontend for roundup.
+#
+# Revision 1.79 2001/12/10 22:20:01 richard
+# Enabled transaction support in the bsddb backend. It uses the anydbm code
+# where possible, only replacing methods where the db is opened (it uses the
+# btree opener specifically.)
+# Also cleaned up some change note generation.
+# Made the backends package work with pydoc too.
+#
+# Revision 1.78 2001/12/07 05:59:27 rochecompaan
+# Fixed small bug that prevented adding issues through the web.
+#
+# Revision 1.77 2001/12/06 22:48:29 richard
+# files multilink was being nuked in post_edit_node
+#
+# Revision 1.76 2001/12/05 14:26:44 rochecompaan
+# Removed generation of change note from "sendmessage" in roundupdb.py.
+# The change note is now generated when the message is created.
+#
+# Revision 1.75 2001/12/04 01:25:08 richard
+# Added some rollbacks where we were catching exceptions that would otherwise
+# have stopped committing.
+#
+# Revision 1.74 2001/12/02 05:06:16 richard
+# . We now use weakrefs in the Classes to keep the database reference, so
+# the close() method on the database is no longer needed.
+# I bumped the minimum python requirement up to 2.1 accordingly.
+# . #487480 ] roundup-server
+# . #487476 ] INSTALL.txt
+#
+# I also cleaned up the change message / post-edit stuff in the cgi client.
+# There's now a clearly marked "TODO: append the change note" where I believe
+# the change note should be added there. The "changes" list will obviously
+# have to be modified to be a dict of the changes, or somesuch.
+#
+# More testing needed.
+#
+# Revision 1.73 2001/12/01 07:17:50 richard
+# . We now have basic transaction support! Information is only written to
+# the database when the commit() method is called. Only the anydbm
+# backend is modified in this way - neither of the bsddb backends have been.
+# The mail, admin and cgi interfaces all use commit (except the admin tool
+# doesn't have a commit command, so interactive users can't commit...)
+# . Fixed login/registration forwarding the user to the right page (or not,
+# on a failure)
+#
+# Revision 1.72 2001/11/30 20:47:58 rochecompaan
+# Links in page header are now consistent with default sort order.
+#
+# Fixed bugs:
+# - When login failed the list of issues were still rendered.
+# - User was redirected to index page and not to his destination url
+# if his first login attempt failed.
+#
+# Revision 1.71 2001/11/30 20:28:10 rochecompaan
+# Property changes are now completely traceable, whether changes are
+# made through the web or by email
+#
+# Revision 1.70 2001/11/30 00:06:29 richard
+# Converted roundup/cgi_client.py to use _()
+# Added the status file, I18N_PROGRESS.txt
+#
+# Revision 1.69 2001/11/29 23:19:51 richard
+# Removed the "This issue has been edited through the web" when a valid
+# change note is supplied.
+#
+# Revision 1.68 2001/11/29 04:57:23 richard
+# a little comment
+#
+# Revision 1.67 2001/11/28 21:55:35 richard
+# . login_action and newuser_action return values were being ignored
+# . Woohoo! Found that bloody re-login bug that was killing the mail
+# gateway.
+# (also a minor cleanup in hyperdb)
+#
# Revision 1.66 2001/11/27 03:00:50 richard
# couple of bugfixes from latest patch integration
#