')
+ for name in props:
+ value = cgi.escape(str(cl.get(nodeid, name)))
+ w('
%s
'%value)
+ w('
')
+ w('
')
+
def shownode(self, message=None):
''' display an item
'''
@@ -297,15 +429,27 @@ class Client:
# 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)
- cl.set(self.nodeid, **props)
- self._post_editnode(self.nodeid, changed)
+ props = parsePropsFromForm(self.db, cl, self.form, self.nodeid)
+ # make changes to the node
+ self._changenode(props)
+ # handle linked nodes
+ self._post_editnode(self.nodeid)
# and some nice feedback for the user
- message = '%s edited ok'%', '.join(changed)
+ if props:
+ message = _('%(changes)s edited ok')%{'changes':
+ ', '.join(props.keys())}
+ elif self.form.has_key('__note') and self.form['__note'].value:
+ message = _('note added')
+ elif (self.form.has_key('__file') and
+ self.form['__file'].filename):
+ message = _('file added')
+ else:
+ message = _('nothing changed')
except:
+ self.db.rollback()
s = StringIO.StringIO()
traceback.print_exc(None, s)
message = '
%s
'%cgi.escape(s.getvalue())
@@ -319,86 +463,168 @@ class Client:
nodeid = self.nodeid
# use the template to display the item
- item = htmltemplate.ItemTemplate(self, self.TEMPLATES, self.classname)
+ item = htmltemplate.ItemTemplate(self, self.instance.TEMPLATES,
+ self.classname)
item.render(nodeid)
self.pagefoot()
showissue = shownode
showmsg = shownode
- def showuser(self, message=None):
- '''Display a user page for editing. Make sure the user is allowed
- to edit this node, and also check for password changes.
+ def _add_assignedto_to_nosy(self, props):
+ ''' add the assignedto value from the props to the nosy list
'''
- 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
+ if not props.has_key('assignedto'):
+ return
+ assignedto_id = props['assignedto']
+ if not props.has_key('nosy'):
+ # load current nosy
+ if self.nodeid:
+ cl = self.db.classes[self.classname]
+ l = cl.get(self.nodeid, 'nosy')
+ if assignedto_id in l:
+ return
+ props['nosy'] = l
+ else:
+ props['nosy'] = []
+ if assignedto_id not in props['nosy']:
+ props['nosy'].append(assignedto_id)
- #
- # 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)
- if self.nodeid == self.getuid() and 'password' in changed:
- set_cookie = self.form['password'].value.strip()
- else:
- set_cookie = 0
- user.set(self.nodeid, **props)
- self._post_editnode(self.nodeid, changed)
- # and some feedback for the user
- message = '%s edited ok'%', '.join(changed)
- except:
- s = StringIO.StringIO()
- traceback.print_exc(None, s)
- message = '
%s
'%cgi.escape(s.getvalue())
+ def _changenode(self, props):
+ ''' change the node based on the contents of the form
+ '''
+ cl = self.db.classes[self.classname]
+ # set status to chatting if 'unread' or 'resolved'
+ 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')
+ current_status = cl.get(self.nodeid, 'status')
+ if props.has_key('status'):
+ new_status = props['status']
+ else:
+ # apparently there's a chance that some browsers don't
+ # send status...
+ new_status = current_status
+ except KeyError:
+ pass
else:
- set_cookie = 0
-
- # fix the cookie if the password has changed
- if set_cookie:
- self.set_cookie(self.user, set_cookie)
+ if new_status == unread_id or (new_status == resolved_id
+ and current_status == resolved_id):
+ props['status'] = chatting_id
- #
- # now the display
- #
- self.pagehead('User: %s'%node_user, message)
+ self._add_assignedto_to_nosy(props)
- # use the template to display the item
- item = htmltemplate.ItemTemplate(self, self.TEMPLATES, 'user')
- item.render(self.nodeid)
- self.pagefoot()
+ # create the message
+ message, files = self._handle_message()
+ if message:
+ props['messages'] = cl.get(self.nodeid, 'messages') + [message]
+ if files:
+ props['files'] = cl.get(self.nodeid, 'files') + files
- 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})
- self.write(cl.get(nodeid, 'content'))
+ # make the changes
+ cl.set(self.nodeid, **props)
def _createnode(self):
''' create a node based on the contents of the form
'''
cl = self.db.classes[self.classname]
- props, dummy = parsePropsFromForm(self.db, cl, self.form)
+ props = 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
+
+ self._add_assignedto_to_nosy(props)
+
+ # check for messages and files
+ message, files = self._handle_message()
+ if message:
+ props['messages'] = [message]
+ if files:
+ props['files'] = files
+ # create the node and return it's id
return cl.create(**props)
- def _post_editnode(self, nid, changes=None):
- ''' do the linking and message sending part of the node creation
+ def _handle_message(self):
+ ''' generate an edit message
+ '''
+ # handle file attachments
+ files = []
+ if self.form.has_key('__file'):
+ file = self.form['__file']
+ if file.filename:
+ filename = file.filename.split('\\')[-1]
+ mime_type = mimetypes.guess_type(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=filename, content=file.file.read()))
+
+ # we don't want to do a message if none of the following is true...
+ cn = self.classname
+ cl = self.db.classes[self.classname]
+ props = cl.getprops()
+ note = None
+ # in a nutshell, don't do anything if there's no note or there's no
+ # NOSY
+ if self.form.has_key('__note'):
+ note = self.form['__note'].value
+ if not props.has_key('messages'):
+ return None, files
+ if not isinstance(props['messages'], hyperdb.Multilink):
+ return None, files
+ if not props['messages'].classname == 'msg':
+ return None, files
+ if not (self.form.has_key('nosy') or note):
+ return None, files
+
+ # handle the note
+ if note:
+ if '\n' in note:
+ summary = re.split(r'\n\r?', note)[0]
+ else:
+ summary = note
+ m = ['%s\n'%note]
+ elif not files:
+ # don't generate a useless message
+ return None, files
+
+ # handle the messageid
+ # TODO: handle inreplyto
+ messageid = "<%s.%s.%s@%s>"%(time.time(), random.random(),
+ self.classname, self.instance.MAIL_DOMAIN)
+
+ # now create the message, attaching the files
+ content = '\n'.join(m)
+ message_id = self.db.msg.create(author=self.getuid(),
+ recipients=[], date=date.Date('.'), summary=summary,
+ content=content, files=files, messageid=messageid)
+
+ # update the messages property
+ return message_id, files
+
+ def _post_editnode(self, nid):
+ '''Do the linking part of the node creation.
+
+ If a form element has :link or :multilink appended to it, its
+ value specifies a node designator and the property on that node
+ to add _this_ node to as a link or multilink.
+
+ This is typically used on, eg. the file upload page to indicated
+ which issue to link the file to.
+
+ TODO: I suspect that this and newfile will go away now that
+ there's the ability to upload a file using the issue __file form
+ element!
'''
cn = self.classname
cl = self.db.classes[cn]
@@ -424,66 +650,6 @@ class Client:
link = self.db.classes[link]
link.set(nodeid, **{property: nid})
- # generate an edit message
- # don't bother if there's no messages or nosy list
- 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]
- 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)
-
def newnode(self, message=None):
''' Add a new node to the database.
@@ -515,23 +681,69 @@ class Client:
props = {}
try:
nid = self._createnode()
+ # 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}
+
+ # render the newly created issue
+ self.db.commit()
+ self.nodeid = nid
+ self.pagehead('%s: %s'%(self.classname.capitalize(), nid),
+ message)
+ item = htmltemplate.ItemTemplate(self, self.instance.TEMPLATES,
+ self.classname)
+ item.render(nid)
+ self.pagefoot()
+ return
except:
+ self.db.rollback()
s = StringIO.StringIO()
traceback.print_exc(None, s)
message = '
%s
'%cgi.escape(s.getvalue())
- self.pagehead('New %s'%self.classname.capitalize(), message)
+ self.pagehead(_('New %(classname)s')%{'classname':
+ self.classname.capitalize()}, message)
# call the template
- newitem = htmltemplate.NewItemTemplate(self, self.TEMPLATES,
+ newitem = htmltemplate.NewItemTemplate(self, self.instance.TEMPLATES,
self.classname)
newitem.render(self.form)
self.pagefoot()
newissue = newnode
- newuser = newnode
+
+ def newuser(self, message=None):
+ ''' Add a new user to the database.
+
+ Don't do any of the message or file handling, just create the node.
+ '''
+ cn = self.classname
+ cl = self.db.classes[cn]
+
+ # possibly perform a create
+ keys = self.form.keys()
+ if [i for i in keys if i[0] != ':']:
+ try:
+ props = parsePropsFromForm(self.db, cl, self.form)
+ nid = cl.create(**props)
+ # handle linked nodes
+ self._post_editnode(nid)
+ # and some nice feedback for the user
+ message = _('%(classname)s created ok')%{'classname': cn}
+ except:
+ self.db.rollback()
+ s = StringIO.StringIO()
+ traceback.print_exc(None, s)
+ message = '
%s
'%cgi.escape(s.getvalue())
+ self.pagehead(_('New %(classname)s')%{'classname':
+ self.classname.capitalize()}, message)
+
+ # call the template
+ newitem = htmltemplate.NewItemTemplate(self, self.instance.TEMPLATES,
+ self.classname)
+ newitem.render(self.form)
+
+ self.pagefoot()
def newfile(self, message=None):
''' Add a new file to the database.
@@ -547,35 +759,111 @@ class Client:
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 = '
%s
'%cgi.escape(s.getvalue())
- self.pagehead('New %s'%self.classname.capitalize(), message)
- newitem = htmltemplate.NewItemTemplate(self, self.TEMPLATES,
+ self.pagehead(_('New %(classname)s')%{'classname':
+ self.classname.capitalize()}, message)
+ newitem = htmltemplate.NewItemTemplate(self, self.instance.TEMPLATES,
self.classname)
newitem.render(self.form)
self.pagefoot()
+ def showuser(self, message=None):
+ '''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 == '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 = parsePropsFromForm(self.db, user, self.form,
+ self.nodeid)
+ set_cookie = 0
+ if props.has_key('password'):
+ password = self.form['password'].value.strip()
+ if not password:
+ # no password was supplied - don't change it
+ del props['password']
+ elif self.nodeid == self.getuid():
+ # this is the logged-in user's password
+ set_cookie = password
+ user.set(self.nodeid, **props)
+ # and some feedback for the user
+ message = _('%(changes)s edited ok')%{'changes':
+ ', '.join(props.keys())}
+ except:
+ self.db.rollback()
+ s = StringIO.StringIO()
+ traceback.print_exc(None, s)
+ message = '
%s
'%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.instance.TEMPLATES, 'user')
+ item.render(self.nodeid)
+ self.pagefoot()
+
+ def showfile(self):
+ ''' display a file
+ '''
+ nodeid = self.nodeid
+ cl = self.db.file
+ 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 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('
\n')
for cn in classnames:
cl = self.db.getclass(cn)
- self.write('
'%(cn, cn.capitalize()))
for key, value in cl.properties.items():
if value is None: value = ''
else: value = str(value)
@@ -586,12 +874,15 @@ class Client:
else:
raise Unauthorised
- def login(self, message=None, newuser_form=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(_('''
Existing User Login
-
-''')
- 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
@@ -649,16 +950,44 @@ class Client:
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 self.index()
+ 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
@@ -689,31 +1018,11 @@ class Client:
self.header({'Set-Cookie':
'roundup_user=deleted; Max-Age=0; expires=%s; Path=%s;'%(now,
path)})
- return self.login()
+ self.login()
- def newuser_action(self, message=None):
- ''' create a new user based on the contents of the form and then
- set the cookie
+ def main(self):
+ '''Wrap the database accesses so we can close the database cleanly
'''
- # 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 self.index()
-
- def main(self, dre=re.compile(r'([^\d]+)(\d+)'),
- nre=re.compile(r'new(\w+)')):
-
# determine the uid to use
self.db = self.instance.open('admin')
cookie = Cookie.Cookie(self.env.get('HTTP_COOKIE', ''))
@@ -743,13 +1052,14 @@ 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)
# 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'):
action = 'index'
else:
@@ -762,29 +1072,70 @@ class Client:
# everyone is allowed to try to log in
if action == 'login_action':
- return self.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:
- return self.login()
- return self.newuser_action()
+ if self.instance.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.instance.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
- # make sure totally anonymous access is OK
- if self.ANONYMOUS_ACCESS == 'deny' and self.user is None:
- return self.login()
+ # 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':
- return self.index()
+ self.index()
+ return
if action == 'list_classes':
- return self.classes()
+ self.classes()
+ return
+ if action == 'classhelp':
+ self.classhelp()
+ 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)
@@ -801,7 +1152,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)
@@ -809,7 +1163,10 @@ 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)
@@ -817,9 +1174,6 @@ class Client:
raise NotFound
self.list()
- def __del__(self):
- self.db.close()
-
class ExtendedClient(Client):
'''Includes pages and page heading information that relate to the
@@ -837,67 +1191,63 @@ class ExtendedClient(Client):
default_index_filterspec = {'status': ['1', '2', '3', '4', '5', '6', '7']}
def pagehead(self, title, message=None):
- url = self.env['SCRIPT_NAME'] + '/' #self.env.get('PATH_INFO', '/')
- 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 = '