![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/cgi_client.py b/roundup/cgi_client.py
index 3f7b4ccc7c0592fd127be12fc644241e50b938f7..59b587b33aff973c225554a5cf5761a9796485bf 100644 (file)
--- a/roundup/cgi_client.py
+++ b/roundup/cgi_client.py
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-# $Id: cgi_client.py,v 1.37 2001-10-21 07:26:35 richard Exp $
+# $Id: cgi_client.py,v 1.80 2001-12-12 23:27:14 richard Exp $
+
+__doc__ = """
+WWW request handler (also used in the stand-alone server).
+"""
import os, cgi, pprint, StringIO, urlparse, re, traceback, mimetypes
-import base64, Cookie, time
+import binascii, Cookie, time
import roundupdb, htmltemplate, date, hyperdb, password
+from roundup.i18n import _
class Unauthorised(ValueError):
pass
'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, out, env):
+ def __init__(self, instance, request, env, form=None):
self.instance = instance
- self.out = out
+ self.request = request
self.env = env
self.path = env['PATH_INFO']
self.split_path = self.path.split('/')
+ if form is None:
+ self.form = cgi.FieldStorage(environ=env)
+ else:
+ self.form = form
self.headers_done = 0
- self.form = cgi.FieldStorage(environ=env)
- self.headers_done = 0
- self.debug = 0
+ try:
+ self.debug = int(env.get("ROUNDUP_DEBUG", 0))
+ except ValueError:
+ # someone gave us a non-int debug level, turn it off
+ self.debug = 0
def getuid(self):
return self.db.user.lookup(self.user)
def header(self, headers={'Content-Type':'text/html'}):
+ '''Put up the appropriate header.
+ '''
if not headers.has_key('Content-Type'):
headers['Content-Type'] = 'text/html'
+ self.request.send_response(200)
for entry in headers.items():
- self.out.write('%s: %s\n'%entry)
- self.out.write('\n')
+ self.request.send_header(*entry)
+ self.request.end_headers()
self.headers_done = 1
+ if self.debug:
+ self.headers_sent = headers
def pagehead(self, title, message=None):
- url = self.env['SCRIPT_NAME'] + '/' #self.env.get('PATH_INFO', '/')
+ url = self.env['SCRIPT_NAME'] + '/'
machine = self.env['SERVER_NAME']
port = self.env['SERVER_PORT']
if port != '80': machine = machine + ':' + port
base = urlparse.urlunparse(('http', machine, url, None, None, None))
if message is not None:
- message = '<div class="system-msg">%s</div>'%message
+ message = _('<div class="system-msg">%(message)s</div>')%locals()
else:
message = ''
style = open(os.path.join(self.TEMPLATES, 'style.css')).read()
- if self.user is not None:
+ user_name = self.user or ''
+ if self.user == 'admin':
+ admin_links = _(' | <a href="list_classes">Class List</a>' \
+ ' | <a href="user">User List</a>')
+ else:
+ admin_links = ''
+ if self.user not in (None, 'anonymous'):
userid = self.db.user.lookup(self.user)
- user_info = '(login: <a href="user%s">%s</a>)'%(userid, self.user)
+ user_info = _('''
+<a href="issue?assignedto=%(userid)s&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:filter=status,assignedto&:sort=-activity&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">My Issues</a> |
+<a href="user%(userid)s">My Details</a> | <a href="logout">Logout</a>
+''')%locals()
+ else:
+ user_info = _('<a href="login">Login</a>')
+ if self.user is not None:
+ add_links = _('''
+| Add
+<a href="newissue">Issue</a>,
+<a href="newuser">User</a>
+''')
else:
- user_info = ''
- self.write('''<html><head>
-<title>%s</title>
-<style type="text/css">%s</style>
+ add_links = ''
+ self.write(_('''<html><head>
+<title>%(title)s</title>
+<style type="text/css">%(style)s</style>
</head>
<body bgcolor=#ffffff>
-%s
+%(message)s
<table width=100%% border=0 cellspacing=0 cellpadding=2>
-<tr class="location-bar"><td><big><strong>%s</strong></big> %s</td></tr>
+<tr class="location-bar"><td><big><strong>%(title)s</strong></big></td>
+<td align=right valign=bottom>%(user_name)s</td></tr>
+<tr class="location-bar">
+<td align=left>All
+<a href="issue?status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=-activity&:filter=status&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">Issues</a>
+| Unassigned
+<a href="issue?assignedto=-1&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=-activity&:filter=status,assignedto&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">Issues</a>
+%(add_links)s
+%(admin_links)s</td>
+<td align=right>%(user_info)s</td>
</table>
-'''%(title, style, message, title, user_info))
+''')%locals())
def pagefoot(self):
if self.debug:
- self.write('<hr><small><dl>')
- self.write('<dt><b>Path</b></dt>')
+ self.write(_('<hr><small><dl><dt><b>Path</b></dt>'))
self.write('<dd>%s</dd>'%(', '.join(map(repr, self.split_path))))
keys = self.form.keys()
keys.sort()
if keys:
- self.write('<dt><b>Form entries</b></dt>')
+ self.write(_('<dt><b>Form entries</b></dt>'))
for k in self.form.keys():
- v = str(self.form[k].value)
- self.write('<dd><em>%s</em>:%s</dd>'%(k, cgi.escape(v)))
+ v = self.form.getvalue(k, "<empty>")
+ if type(v) is type([]):
+ # Multiple username fields specified
+ v = "|".join(v)
+ self.write('<dd><em>%s</em>=%s</dd>'%(k, cgi.escape(v)))
+ keys = self.headers_sent.keys()
+ keys.sort()
+ self.write(_('<dt><b>Sent these HTTP headers</b></dt>'))
+ for k in keys:
+ v = self.headers_sent[k]
+ self.write('<dd><em>%s</em>=%s</dd>'%(k, cgi.escape(v)))
keys = self.env.keys()
keys.sort()
- self.write('<dt><b>CGI environment</b></dt>')
+ self.write(_('<dt><b>CGI environment</b></dt>'))
for k in keys:
v = self.env[k]
- self.write('<dd><em>%s</em>:%s</dd>'%(k, cgi.escape(v)))
+ self.write('<dd><em>%s</em>=%s</dd>'%(k, cgi.escape(v)))
self.write('</dl></small>')
self.write('</body></html>')
def write(self, content):
if not self.headers_done:
self.header()
- self.out.write(content)
+ self.request.wfile.write(content)
def index_arg(self, arg):
''' handle the args to index - they might be a list from the form
'''
cn = self.classname
- self.pagehead('Index of %s'%cn)
+ cl = self.db.classes[cn]
+ self.pagehead(_('%(instancename)s: Index of %(classname)s')%{
+ 'classname': cn, 'instancename': self.INSTANCE_NAME})
if sort is None: sort = self.index_arg(':sort')
if group is None: group = self.index_arg(':group')
if filter is None: filter = self.index_arg(':filter')
if show_customization is None:
show_customization = self.customization_widget()
- htmltemplate.index(self, self.TEMPLATES, self.db, cn, filterspec,
- filter, columns, sort, group,
+ index = htmltemplate.IndexTemplate(self, self.TEMPLATES, cn)
+ index.render(filterspec, filter, columns, sort, group,
show_customization=show_customization)
self.pagefoot()
# possibly perform an edit
keys = self.form.keys()
num_re = re.compile('^\d+$')
- if keys:
+ # don't try to set properties if the user has just logged in
+ if keys and not self.form.has_key('__login_name'):
try:
props, changed = parsePropsFromForm(self.db, cl, self.form,
self.nodeid)
+
+ # set status to chatting if 'unread' or 'resolved'
+ if not changed.has_key('status'):
+ try:
+ # determine the id of 'unread','resolved' and 'chatting'
+ unread_id = self.db.status.lookup('unread')
+ resolved_id = self.db.status.lookup('resolved')
+ chatting_id = self.db.status.lookup('chatting')
+ except KeyError:
+ pass
+ else:
+ if (not props.has_key('status') or
+ props['status'] == unread_id or
+ props['status'] == resolved_id):
+ props['status'] = chatting_id
+ changed['status'] = chatting_id
+
+ # get the change note
+ change_note = cl.generateChangeNote(self.nodeid, changed)
+
+ # make the changes
cl.set(self.nodeid, **props)
- self._post_editnode(self.nodeid, changed)
+
+ # handle linked nodes and change message generation
+ self._post_editnode(self.nodeid, change_note)
+
# and some nice feedback for the user
- message = '%s edited ok'%', '.join(changed)
+ if changed:
+ message = _('%(changes)s edited ok')%{'changes':
+ ', '.join(changed.keys())}
+ elif self.form.has_key('__note') and self.form['__note'].value:
+ message = _('note added')
+ else:
+ message = _('nothing changed')
except:
+ self.db.rollback()
s = StringIO.StringIO()
traceback.print_exc(None, s)
message = '<pre>%s</pre>'%cgi.escape(s.getvalue())
nodeid = self.nodeid
# use the template to display the item
- htmltemplate.item(self, self.TEMPLATES, self.db, self.classname, nodeid)
+ item = htmltemplate.ItemTemplate(self, self.TEMPLATES, self.classname)
+ item.render(nodeid)
+
self.pagefoot()
showissue = shownode
showmsg = shownode
def showuser(self, message=None):
- ''' display an item
+ '''Display a user page for editing. Make sure the user is allowed
+ to edit this node, and also check for password changes.
'''
- if self.user in ('admin', self.db.user.get(self.nodeid, 'username')):
- self.shownode(message)
- else:
+ if self.user == 'anonymous':
+ raise Unauthorised
+
+ user = self.db.user
+
+ # get the username of the node being edited
+ node_user = user.get(self.nodeid, 'username')
+
+ if self.user not in ('admin', node_user):
raise Unauthorised
+ #
+ # perform any editing
+ #
+ keys = self.form.keys()
+ num_re = re.compile('^\d+$')
+ if keys:
+ try:
+ props, changed = parsePropsFromForm(self.db, user, self.form,
+ self.nodeid)
+ set_cookie = 0
+ if self.nodeid == self.getuid() and 'password' in changed:
+ password = self.form['password'].value.strip()
+ if password:
+ set_cookie = password
+ else:
+ del props['password']
+ del changed[changed.index('password')]
+ user.set(self.nodeid, **props)
+ self._post_editnode(self.nodeid)
+ # and some feedback for the user
+ message = _('%(changes)s edited ok')%{'changes':
+ ', '.join(changed.keys())}
+ except:
+ self.db.rollback()
+ s = StringIO.StringIO()
+ traceback.print_exc(None, s)
+ message = '<pre>%s</pre>'%cgi.escape(s.getvalue())
+ else:
+ set_cookie = 0
+
+ # fix the cookie if the password has changed
+ if set_cookie:
+ self.set_cookie(self.user, set_cookie)
+
+ #
+ # now the display
+ #
+ self.pagehead(_('User: %(user)s')%{'user': node_user}, message)
+
+ # use the template to display the item
+ item = htmltemplate.ItemTemplate(self, self.TEMPLATES, 'user')
+ item.render(self.nodeid)
+ self.pagefoot()
+
def showfile(self):
''' display a file
'''
nodeid = self.nodeid
cl = self.db.file
- type = cl.get(nodeid, 'type')
- if type == 'message/rfc822':
- type = 'text/plain'
- self.header(headers={'Content-Type': type})
+ mime_type = cl.get(nodeid, 'type')
+ if mime_type == 'message/rfc822':
+ mime_type = 'text/plain'
+ self.header(headers={'Content-Type': mime_type})
self.write(cl.get(nodeid, 'content'))
def _createnode(self):
'''
cl = self.db.classes[self.classname]
props, dummy = parsePropsFromForm(self.db, cl, self.form)
+
+ # set status to 'unread' if not specified - a status of '- no
+ # selection -' doesn't make sense
+ if not props.has_key('status'):
+ try:
+ unread_id = self.db.status.lookup('unread')
+ except KeyError:
+ pass
+ else:
+ props['status'] = unread_id
return cl.create(**props)
- def _post_editnode(self, nid, changes=None):
+ def _post_editnode(self, nid, change_note=''):
''' do the linking and message sending part of the node creation
'''
cn = self.classname
link = self.db.classes[link]
link.set(nodeid, **{property: nid})
+ # handle file attachments
+ files = cl.get(nid, 'files')
+ if self.form.has_key('__file'):
+ file = self.form['__file']
+ if file.filename:
+ mime_type = mimetypes.guess_type(file.filename)[0]
+ if not mime_type:
+ mime_type = "application/octet-stream"
+ # create the new file entry
+ files.append(self.db.file.create(type=mime_type,
+ name=file.filename, content=file.file.read()))
+ # and save the reference
+ cl.set(nid, files=files)
+
+ #
# generate an edit message
- # don't bother if there's no messages or nosy list
+ #
+
+ # we don't want to do a message if none of the following is true...
props = cl.getprops()
note = None
if self.form.has_key('__note'):
- note = self.form['__note']
- note = note.value
- send = len(cl.get(nid, 'nosy', [])) or note
- if (send and props.has_key('messages') and
- isinstance(props['messages'], hyperdb.Multilink) and
- props['messages'].classname == 'msg'):
-
- # handle the note
- if note:
- if '\n' in note:
- summary = re.split(r'\n\r?', note)[0]
- else:
- summary = note
- m = ['%s\n'%note]
+ note = self.form['__note'].value
+ if not props.has_key('messages'):
+ return
+ if not isinstance(props['messages'], hyperdb.Multilink):
+ return
+ if not props['messages'].classname == 'msg':
+ return
+ if not (len(cl.get(nid, 'nosy', [])) or note):
+ return
+
+ # handle the note
+ if note:
+ if '\n' in note:
+ summary = re.split(r'\n\r?', note)[0]
else:
- summary = 'This %s has been edited through the web.\n'%cn
- m = [summary]
-
- first = 1
- for name, prop in props.items():
- if changes is not None and name not in changes: continue
- if first:
- m.append('\n-------')
- first = 0
- value = cl.get(nid, name, None)
- if isinstance(prop, hyperdb.Link):
- link = self.db.classes[prop.classname]
- key = link.labelprop(default_to_id=1)
- if value is not None and key:
- value = link.get(value, key)
- else:
- value = '-'
- elif isinstance(prop, hyperdb.Multilink):
- if value is None: value = []
- l = []
- link = self.db.classes[prop.classname]
- key = link.labelprop(default_to_id=1)
- for entry in value:
- if key:
- l.append(link.get(entry, key))
- else:
- l.append(entry)
- value = ', '.join(l)
- m.append('%s: %s'%(name, value))
-
- # now create the message
- content = '\n'.join(m)
- message_id = self.db.msg.create(author=self.getuid(),
- recipients=[], date=date.Date('.'), summary=summary,
- content=content)
- messages = cl.get(nid, 'messages')
- messages.append(message_id)
- props = {'messages': messages}
- cl.set(nid, **props)
+ summary = note
+ m = ['%s\n'%note]
+ else:
+ summary = _('This %(classname)s has been edited through'
+ ' the web.\n')%{'classname': cn}
+ m = [summary]
+
+ # append the change note
+ if change_note:
+ m.append(change_note)
+
+ # now create the message
+ content = '\n'.join(m)
+ message_id = self.db.msg.create(author=self.getuid(),
+ recipients=[], date=date.Date('.'), summary=summary,
+ content=content, files=files)
+
+ # update the messages property
+ messages = cl.get(nid, 'messages')
+ messages.append(message_id)
+ cl.set(nid, messages=messages, files=files)
def newnode(self, message=None):
''' Add a new node to the database.
props = {}
try:
nid = self._createnode()
+ # handle linked nodes and change message generation
self._post_editnode(nid)
# and some nice feedback for the user
- message = '%s created ok'%cn
+ message = _('%(classname)s created ok')%{'classname': cn}
except:
+ self.db.rollback()
s = StringIO.StringIO()
traceback.print_exc(None, s)
message = '<pre>%s</pre>'%cgi.escape(s.getvalue())
- self.pagehead('New %s'%self.classname.capitalize(), message)
- htmltemplate.newitem(self, self.TEMPLATES, self.db, self.classname,
- self.form)
+ self.pagehead(_('New %(classname)s')%{'classname':
+ self.classname.capitalize()}, message)
+
+ # call the template
+ newitem = htmltemplate.NewItemTemplate(self, self.TEMPLATES,
+ self.classname)
+ newitem.render(self.form)
+
self.pagefoot()
newissue = newnode
newuser = newnode
if [i for i in keys if i[0] != ':']:
try:
file = self.form['content']
- type = mimetypes.guess_type(file.filename)[0]
- if not type:
- type = "application/octet-stream"
- self._post_editnode(cl.create(content=file.file.read(),
- type=type, name=file.filename))
+ mime_type = mimetypes.guess_type(file.filename)[0]
+ if not mime_type:
+ mime_type = "application/octet-stream"
+ # save the file
+ nid = cl.create(content=file.file.read(), type=mime_type,
+ name=file.filename)
+ # handle linked nodes
+ self._post_editnode(nid)
# and some nice feedback for the user
- message = '%s created ok'%cn
+ message = _('%(classname)s created ok')%{'classname': cn}
except:
+ self.db.rollback()
s = StringIO.StringIO()
traceback.print_exc(None, s)
message = '<pre>%s</pre>'%cgi.escape(s.getvalue())
- self.pagehead('New %s'%self.classname.capitalize(), message)
- htmltemplate.newitem(self, self.TEMPLATES, self.db, self.classname,
- self.form)
+ self.pagehead(_('New %(classname)s')%{'classname':
+ self.classname.capitalize()}, message)
+ newitem = htmltemplate.NewItemTemplate(self, self.TEMPLATES,
+ self.classname)
+ newitem.render(self.form)
self.pagefoot()
def classes(self, message=None):
''' display a list of all the classes in the database
'''
if self.user == 'admin':
- self.pagehead('Table of classes', message)
+ self.pagehead(_('Table of classes'), message)
classnames = self.db.classes.keys()
classnames.sort()
self.write('<table border=0 cellspacing=0 cellpadding=2>\n')
else:
raise Unauthorised
- def login(self, message=None):
- self.pagehead('Login to roundup', message)
- self.write('''
+ def login(self, message=None, newuser_form=None, action='index'):
+ '''Display a login page.
+ '''
+ self.pagehead(_('Login to roundup'), message)
+ self.write(_('''
<table>
<tr><td colspan=2 class="strong-header">Existing User Login</td></tr>
<form action="login_action" method=POST>
+<input type="hidden" name="__destination_url" value="%(action)s">
<tr><td align=right>Login name: </td>
<td><input name="__login_name"></td></tr>
<tr><td align=right>Password: </td>
<tr><td></td>
<td><input type="submit" value="Log In"></td></tr>
</form>
-
+''')%locals())
+ if self.user is None and self.ANONYMOUS_REGISTER == 'deny':
+ self.write('</table>')
+ self.pagefoot()
+ return
+ values = {'realname': '', 'organisation': '', 'address': '',
+ 'phone': '', 'username': '', 'password': '', 'confirm': '',
+ 'action': action}
+ if newuser_form is not None:
+ for key in newuser_form.keys():
+ values[key] = newuser_form[key].value
+ self.write(_('''
<p>
<tr><td colspan=2 class="strong-header">New User Registration</td></tr>
<tr><td colspan=2><em>marked items</em> are optional...</td></tr>
<form action="newuser_action" method=POST>
+<input type="hidden" name="__destination_url" value="%(action)s">
<tr><td align=right><em>Name: </em></td>
- <td><input name="__newuser_realname"></td></tr>
+ <td><input name="realname" value="%(realname)s"></td></tr>
<tr><td align=right><em>Organisation: </em></td>
- <td><input name="__newuser_organisation"></td></tr>
+ <td><input name="organisation" value="%(organisation)s"></td></tr>
<tr><td align=right>E-Mail Address: </td>
- <td><input name="__newuser_address"></td></tr>
+ <td><input name="address" value="%(address)s"></td></tr>
<tr><td align=right><em>Phone: </em></td>
- <td><input name="__newuser_phone"></td></tr>
+ <td><input name="phone" value="%(phone)s"></td></tr>
<tr><td align=right>Preferred Login name: </td>
- <td><input name="__newuser_username"></td></tr>
+ <td><input name="username" value="%(username)s"></td></tr>
<tr><td align=right>Password: </td>
- <td><input type="password" name="__newuser_password"></td></tr>
+ <td><input type="password" name="password" value="%(password)s"></td></tr>
<tr><td align=right>Password Again: </td>
- <td><input type="password" name="__newuser_confirm"></td></tr>
+ <td><input type="password" name="confirm" value="%(confirm)s"></td></tr>
<tr><td></td>
<td><input type="submit" value="Register"></td></tr>
</form>
</table>
-''')
+''')%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
except KeyError:
name = self.user
self.make_user_anonymous()
- return self.login(message='No such user "%s"'%name)
+ 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 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, dummy = 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
- uid = self.db.user.lookup(self.user)
- user = base64.encodestring('%s:%s'%(self.user, password))[:-1]
- path = '/'.join((self.env['SCRIPT_NAME'], self.env['INSTANCE_NAME'],
- ''))
- self.header({'Set-Cookie': 'roundup_user=%s; Path=%s;'%(user, path)})
- return self.index()
+ user = binascii.b2a_base64('%s:%s'%(user, password)).strip()
+ if user[-1] == '=':
+ if user[-2] == '=':
+ user = user[:-2]
+ else:
+ user = user[:-1]
+ expire = Cookie._getdate(86400*365)
+ path = '/'.join((self.env['SCRIPT_NAME'], self.env['INSTANCE_NAME']))
+ self.header({'Set-Cookie': 'roundup_user=%s; expires=%s; Path=%s;' % (
+ user, expire, path)})
def make_user_anonymous(self):
# make us anonymous if we can
def logout(self, message=None):
self.make_user_anonymous()
# construct the logout cookie
- path = '/'.join((self.env['SCRIPT_NAME'], self.env['INSTANCE_NAME'],
- ''))
now = Cookie._getdate()
+ path = '/'.join((self.env['SCRIPT_NAME'], self.env['INSTANCE_NAME']))
self.header({'Set-Cookie':
- 'roundup_user=deleted; Max-Age=0; expires=%s; Path=%s;'%(now, path)})
- return self.index()
+ 'roundup_user=deleted; Max-Age=0; expires=%s; Path=%s;'%(now,
+ path)})
+ self.login()
- def newuser_action(self, message=None):
- ''' create a new user based on the contents of the form and then
- set the cookie
- '''
- # TODO: pre-check the required fields and username key property
- cl = self.db.classes['user']
- props, dummy = parsePropsFromForm(self.db, cl, self.form)
- uid = cl.create(**props)
- self.user = self.db.user.get(uid, 'username')
- password = self.db.user.get(uid, 'password')
- # construct the cookie
- uid = self.db.user.lookup(self.user)
- user = base64.encodestring('%s:%s'%(self.user, password))[:-1]
- path = '/'.join((self.env['SCRIPT_NAME'], self.env['INSTANCE_NAME'],
- ''))
- self.header({'Set-Cookie': 'roundup_user=%s; Path=%s;'%(user, path)})
- return self.index()
-
- def main(self, dre=re.compile(r'([^\d]+)(\d+)'),
- nre=re.compile(r'new(\w+)')):
+ 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', ''))
if (cookie.has_key('roundup_user') and
cookie['roundup_user'].value != 'deleted'):
cookie = cookie['roundup_user'].value
- user, password = base64.decodestring(cookie).split(':')
+ if len(cookie)%4:
+ cookie = cookie + '='*(4-len(cookie)%4)
+ try:
+ user, password = binascii.a2b_base64(cookie).split(':')
+ except (TypeError, binascii.Error, binascii.Incomplete):
+ # damaged cookie!
+ user, password = 'anonymous', ''
+
# make sure the user exists
try:
uid = self.db.user.lookup(user)
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)
# now figure which function to call
path = self.split_path
+
+ # default action to index if the path has no information in it
if not path or path[0] in ('', 'index'):
- self.index()
- elif not path:
- raise 'ValueError', 'Path not understood'
+ action = 'index'
+ else:
+ action = path[0]
- #
# Everthing ignores path[1:]
- #
- # The file download link generator actually relies on this - it
- # appends the name of the file to the URL so the download file name
- # is correct, but doesn't actually use it.
- action = path[0]
+ # - The file download link generator actually relies on this - it
+ # appends the name of the file to the URL so the download file name
+ # is correct, but doesn't actually use it.
+
+ # everyone is allowed to try to log in
+ if action == 'login_action':
+ # try to login
+ if not self.login_action():
+ return
+ # figure the resulting page
+ action = self.form['__destination_url'].value
+ if not action:
+ action = 'index'
+ 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 action == 'login':
+ self.login() # go to the index after login
+ else:
+ 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'
+
+ # no login or registration, make sure totally anonymous access is OK
+ elif self.ANONYMOUS_ACCESS == 'deny' and self.user is None:
+ if action == 'login':
+ self.login() # go to the index after login
+ else:
+ self.login(action=action)
+ return
+
+ # just a regular 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':
+ self.index()
+ return
if action == 'list_classes':
self.classes()
return
if action == 'login':
self.login()
return
- if action == 'login_action':
- self.login_action()
- return
- if action == 'newuser_action':
- self.newuser_action()
- return
if action == 'logout':
self.logout()
return
raise NotFound
self.list()
- def __del__(self):
- self.db.close()
-
class ExtendedClient(Client):
'''Includes pages and page heading information that relate to the
if port != '80': machine = machine + ':' + port
base = urlparse.urlunparse(('http', machine, url, None, None, None))
if message is not None:
- message = '<div class="system-msg">%s</div>'%message
+ message = _('<div class="system-msg">%(message)s</div>')%locals()
else:
message = ''
style = open(os.path.join(self.TEMPLATES, 'style.css')).read()
user_name = self.user or ''
if self.user == 'admin':
- admin_links = ' | <a href="list_classes">Class List</a>'
+ admin_links = _(' | <a href="list_classes">Class List</a>' \
+ ' | <a href="user">User List</a>')
else:
admin_links = ''
if self.user not in (None, 'anonymous'):
userid = self.db.user.lookup(self.user)
- user_info = '''
-<a href="issue?assignedto=%s&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:filter=status,assignedto&:sort=activity&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">My Issues</a> |
-<a href="support?assignedto=%s&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:filter=status,assignedto&:sort=activity&:columns=id,activity,status,title,assignedto&:group=customername&show_customization=1">My Support</a> |
-<a href="user%s">My Details</a> | <a href="logout">Logout</a>
-'''%(userid, userid, userid)
+ user_info = _('''
+<a href="issue?assignedto=%(userid)s&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:filter=status,assignedto&:sort=-activity&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">My Issues</a> |
+<a href="support?assignedto=%(userid)s&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:filter=status,assignedto&:sort=-activity&:columns=id,activity,status,title,assignedto&:group=customername&show_customization=1">My Support</a> |
+<a href="user%(userid)s">My Details</a> | <a href="logout">Logout</a>
+''')%locals()
else:
- user_info = '<a href="login">Login</a>'
+ user_info = _('<a href="login">Login</a>')
if self.user is not None:
- add_links = '''
+ add_links = _('''
| Add
<a href="newissue">Issue</a>,
<a href="newsupport">Support</a>,
<a href="newuser">User</a>
-'''
+''')
else:
add_links = ''
- self.write('''<html><head>
-<title>%s</title>
-<style type="text/css">%s</style>
+ self.write(_('''<html><head>
+<title>%(title)s</title>
+<style type="text/css">%(style)s</style>
</head>
<body bgcolor=#ffffff>
-%s
+%(message)s
<table width=100%% border=0 cellspacing=0 cellpadding=2>
-<tr class="location-bar"><td><big><strong>%s</strong></big></td>
-<td align=right valign=bottom>%s</td></tr>
+<tr class="location-bar"><td><big><strong>%(title)s</strong></big></td>
+<td align=right valign=bottom>%(user_name)s</td></tr>
<tr class="location-bar">
<td align=left>All
<a href="issue?status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=activity&:filter=status&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">Issues</a>,
<a href="support?status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=activity&:filter=status&:columns=id,activity,status,title,assignedto&:group=customername&show_customization=1">Support</a>
| Unassigned
-<a href="issue?assignedto=-1&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=activity&:filter=status,assignedto&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">Issues</a>,
-<a href="support?assignedto=-1&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=activity&:filter=status,assignedto&:columns=id,activity,status,title,assignedto&:group=customername&show_customization=1">Support</a>
-%s
-%s</td>
-<td align=right>%s</td>
+<a href="issue?assignedto=-1&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=-activity&:filter=status,assignedto&:columns=id,activity,status,title,assignedto&:group=priority&show_customization=1">Issues</a>,
+<a href="support?assignedto=-1&status=-1,unread,deferred,chatting,need-eg,in-progress,testing,done-cbb&:sort=-activity&:filter=status,assignedto&:columns=id,activity,status,title,assignedto&:group=customername&show_customization=1">Support</a>
+%(add_links)s
+%(admin_links)s</td>
+<td align=right>%(user_info)s</td>
</table>
-'''%(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 = []
+ changed = {}
keys = form.keys()
num_re = re.compile('^\d+$')
for key in keys:
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([]):
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:
+ try:
+ existing = cl.get(nodeid, key)
+ except KeyError:
+ # this might be a new property for which there is no existing
+ # value
+ if not cl.properties.has_key(key): raise
+
# if changed, set it
- if nodeid and value != cl.get(nodeid, key):
- changed.append(key)
+ if nodeid and value != existing:
+ changed[key] = value
props[key] = value
return props, changed
#
# $Log: not supported by cvs2svn $
+# 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
+#
+# Revision 1.65 2001/11/26 23:00:53 richard
+# This config stuff is getting to be a real mess...
+#
+# Revision 1.64 2001/11/26 22:56:35 richard
+# typo
+#
+# Revision 1.63 2001/11/26 22:55:56 richard
+# Feature:
+# . Added INSTANCE_NAME to configuration - used in web and email to identify
+# the instance.
+# . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
+# signature info in e-mails.
+# . Some more flexibility in the mail gateway and more error handling.
+# . Login now takes you to the page you back to the were denied access to.
+#
+# Fixed:
+# . Lots of bugs, thanks Roché and others on the devel mailing list!
+#
+# Revision 1.62 2001/11/24 00:45:42 jhermann
+# typeof() instead of type(): avoid clash with database field(?) "type"
+#
+# Fixes this traceback:
+#
+# Traceback (most recent call last):
+# File "roundup\cgi_client.py", line 535, in newnode
+# self._post_editnode(nid)
+# File "roundup\cgi_client.py", line 415, in _post_editnode
+# if type(value) != type([]): value = [value]
+# UnboundLocalError: local variable 'type' referenced before assignment
+#
+# Revision 1.61 2001/11/22 15:46:42 jhermann
+# Added module docstrings to all modules.
+#
+# Revision 1.60 2001/11/21 22:57:28 jhermann
+# Added dummy hooks for I18N and some preliminary (test) markup of
+# translatable messages
+#
+# Revision 1.59 2001/11/21 03:21:13 richard
+# oops
+#
+# Revision 1.58 2001/11/21 03:11:28 richard
+# Better handling of new properties.
+#
+# Revision 1.57 2001/11/15 10:24:27 richard
+# handle the case where there is no file attached
+#
+# Revision 1.56 2001/11/14 21:35:21 richard
+# . users may attach files to issues (and support in ext) through the web now
+#
+# Revision 1.55 2001/11/07 02:34:06 jhermann
+# Handling of damaged login cookies
+#
+# Revision 1.54 2001/11/07 01:16:12 richard
+# Remove the '=' padding from cookie value so quoting isn't an issue.
+#
+# Revision 1.53 2001/11/06 23:22:05 jhermann
+# More IE fixes: it does not like quotes around cookie values; in the
+# hope this does not break anything for other browser; if it does, we
+# need to check HTTP_USER_AGENT
+#
+# Revision 1.52 2001/11/06 23:11:22 jhermann
+# Fixed debug output in page footer; added expiry date to the login cookie
+# (expires 1 year in the future) to prevent probs with certain versions
+# of IE
+#
+# Revision 1.51 2001/11/06 22:00:34 jhermann
+# Get debug level from ROUNDUP_DEBUG env var
+#
+# Revision 1.50 2001/11/05 23:45:40 richard
+# Fixed newuser_action so it sets the cookie with the unencrypted password.
+# Also made it present nicer error messages (not tracebacks).
+#
+# Revision 1.49 2001/11/04 03:07:12 richard
+# Fixed various cookie-related bugs:
+# . bug #477685 ] base64.decodestring breaks
+# . bug #477837 ] lynx does not like the cookie
+# . bug #477892 ] Password edit doesn't fix login cookie
+# Also closed a security hole - a logged-in user could edit another user's
+# details.
+#
+# Revision 1.48 2001/11/03 01:30:18 richard
+# Oops. uses pagefoot now.
+#
+# Revision 1.47 2001/11/03 01:29:28 richard
+# Login page didn't have all close tags.
+#
+# Revision 1.46 2001/11/03 01:26:55 richard
+# possibly fix truncated base64'ed user:pass
+#
+# Revision 1.45 2001/11/01 22:04:37 richard
+# Started work on supporting a pop3-fetching server
+# Fixed bugs:
+# . bug #477104 ] HTML tag error in roundup-server
+# . bug #477107 ] HTTP header problem
+#
+# Revision 1.44 2001/10/28 23:03:08 richard
+# Added more useful header to the classic schema.
+#
+# Revision 1.43 2001/10/24 00:01:42 richard
+# More fixes to lockout logic.
+#
+# Revision 1.42 2001/10/23 23:56:03 richard
+# HTML typo
+#
+# Revision 1.41 2001/10/23 23:52:35 richard
+# Fixed lock-out logic, thanks Roch'e for pointing out the problems.
+#
+# Revision 1.40 2001/10/23 23:06:39 richard
+# Some cleanup.
+#
+# Revision 1.39 2001/10/23 01:00:18 richard
+# Re-enabled login and registration access after lopping them off via
+# disabling access for anonymous users.
+# Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
+# a couple of bugs while I was there. Probably introduced a couple, but
+# things seem to work OK at the moment.
+#
+# Revision 1.38 2001/10/22 03:25:01 richard
+# Added configuration for:
+# . anonymous user access and registration (deny/allow)
+# . filter "widget" location on index page (top, bottom, both)
+# Updated some documentation.
+#
+# Revision 1.37 2001/10/21 07:26:35 richard
+# feature #473127: Filenames. I modified the file.index and htmltemplate
+# source so that the filename is used in the link and the creation
+# information is displayed.
+#
# Revision 1.36 2001/10/21 04:44:50 richard
# bug #473124: UI inconsistency with Link fields.
# This also prompted me to fix a fairly long-standing usability issue -