diff --git a/roundup/cgi_client.py b/roundup/cgi_client.py
index bdf1dfdc828b91099f31e71b9bf8e723747da4e9..aeb5fd64e50b34e9f6c7c5197b2f0899be85bdba 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.93 2002-01-08 11:57:12 richard Exp $
+# $Id: cgi_client.py,v 1.111 2002-02-25 04:32:21 richard Exp $
__doc__ = """
WWW request handler (also used in the stand-alone server).
'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, form=None):
self.instance = instance
self.env = env
self.path = env['PATH_INFO']
self.split_path = self.path.split('/')
+ self.instance_path_name = env['INSTANCE_NAME']
+ url = self.env['SCRIPT_NAME'] + '/'
+ machine = self.env['SERVER_NAME']
+ port = self.env['SERVER_PORT']
+ if port != '80': machine = machine + ':' + port
+ self.base = urlparse.urlunparse(('http', env['HTTP_HOST'], url,
+ None, None, None))
if form is None:
self.form = cgi.FieldStorage(environ=env)
if self.debug:
self.headers_sent = headers
+ global_javascript = '''
+<script language="javascript">
+submitted = false;
+function submit_once() {
+ if (submitted) {
+ alert("Your request is being processed.\\nPlease be patient.");
+ return 0;
+ }
+ submitted = true;
+ return 1;
+}
+
+function help_window(helpurl, width, height) {
+ HelpWin = window.open('%(base)s%(instance_path_name)s/' + helpurl, 'HelpWindow', 'scrollbars=yes,resizable=yes,toolbar=no,height='+height+',width='+width);
+}
+
+</script>
+'''
+
def pagehead(self, title, message=None):
- 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">%(message)s</div>')%locals()
else:
message = ''
- style = open(os.path.join(self.TEMPLATES, 'style.css')).read()
+ style = open(os.path.join(self.instance.TEMPLATES, 'style.css')).read()
user_name = self.user or ''
if self.user == 'admin':
admin_links = _(' | <a href="list_classes">Class List</a>' \
''')
else:
add_links = ''
+ global_javascript = self.global_javascript%self.__dict__
self.write(_('''<html><head>
<title>%(title)s</title>
<style type="text/css">%(style)s</style>
</head>
+%(global_javascript)s
<body bgcolor=#ffffff>
%(message)s
<table width=100%% border=0 cellspacing=0 cellpadding=2>
cn = self.classname
cl = self.db.classes[cn]
self.pagehead(_('%(instancename)s: Index of %(classname)s')%{
- 'classname': cn, 'instancename': self.INSTANCE_NAME})
+ 'classname': cn, 'instancename': self.instance.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()
- index = htmltemplate.IndexTemplate(self, self.TEMPLATES, cn)
- index.render(filterspec, filter, columns, sort, group,
- show_customization=show_customization)
+ index = htmltemplate.IndexTemplate(self, self.instance.TEMPLATES, cn)
+ try:
+ index.render(filterspec, filter, columns, sort, group,
+ show_customization=show_customization)
+ except htmltemplate.MissingTemplateError:
+ self.basicClassEditPage()
self.pagefoot()
+ def basicClassEditPage(self):
+ '''Display a basic edit page that allows simple editing of the
+ nodes of the current class
+ '''
+ if self.user != 'admin':
+ raise Unauthorised
+ w = self.write
+ cn = self.classname
+ cl = self.db.classes[cn]
+ idlessprops = cl.getprops(protected=0).keys()
+ props = ['id'] + idlessprops
+
+
+ # get the CSV module
+ try:
+ import csv
+ except ImportError:
+ w(_('Sorry, you need the csv module to use this function.<br>\n'
+ 'Get it from: <a href="http://www.object-craft.com.au/projects/csv/">http://www.object-craft.com.au/projects/csv/'))
+ return
+
+ # do the edit
+ if self.form.has_key('rows'):
+ rows = self.form['rows'].value.splitlines()
+ p = csv.parser()
+ found = {}
+ line = 0
+ for row in rows:
+ line += 1
+ values = p.parse(row)
+ # not a complete row, keep going
+ if not values: continue
+
+ # extract the nodeid
+ nodeid, values = values[0], values[1:]
+ found[nodeid] = 1
+
+ # confirm correct weight
+ if len(idlessprops) != len(values):
+ w(_('Not enough values on line %(line)s'%{'line':line}))
+ return
+
+ # extract the new values
+ d = {}
+ for name, value in zip(idlessprops, values):
+ d[name] = value.strip()
+
+ # perform the edit
+ if cl.hasnode(nodeid):
+ # edit existing
+ cl.set(nodeid, **d)
+ else:
+ # new node
+ found[cl.create(**d)] = 1
+
+ # retire the removed entries
+ for nodeid in cl.list():
+ if not found.has_key(nodeid):
+ cl.retire(nodeid)
+
+ w(_('''<p class="form-help">You may edit the contents of the
+ "%(classname)s" class using this form. The lines are full-featured
+ Comma-Separated-Value lines, so you may include commas and even
+ newlines by enclosing the values in double-quotes ("). Double
+ quotes themselves must be quoted by doubling ("").</p>
+ <p class="form-help">Remove entries by deleting their line. Add
+ new entries by appending
+ them to the table - put an X in the id column.</p>''')%{'classname':cn})
+
+ l = []
+ for name in props:
+ l.append(name)
+ w('<tt>')
+ w(', '.join(l) + '\n')
+ w('</tt>')
+
+ w('<form onSubmit="return submit_once()" method="POST">')
+ w('<textarea name="rows" cols=80 rows=15>')
+ p = csv.parser()
+ for nodeid in cl.list():
+ l = []
+ for name in props:
+ l.append(cgi.escape(str(cl.get(nodeid, name))))
+ w(p.join(l) + '\n')
+
+ w(_('</textarea><br><input type="submit" value="Save Changes"></form>'))
+
+ def classhelp(self):
+ '''Display a table of class info
+ '''
+ w = self.write
+ cn = self.form['classname'].value
+ cl = self.db.classes[cn]
+ props = self.form['properties'].value.split(',')
+
+ w('<table border=1 cellspacing=0 cellpaddin=2>')
+ w('<tr>')
+ for name in props:
+ w('<th align=left>%s</th>'%name)
+ w('</tr>')
+ for nodeid in cl.list():
+ w('<tr>')
+ for name in props:
+ value = cgi.escape(str(cl.get(nodeid, name)))
+ w('<td align="left" valign="top">%s</td>'%value)
+ w('</tr>')
+ w('</table>')
+
def shownode(self, message=None):
''' display an item
'''
# 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)
+ 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
- if changed:
+ if props:
message = _('%(changes)s edited ok')%{'changes':
- ', '.join(changed.keys())}
+ ', '.join(props.keys())}
elif self.form.has_key('__note') and self.form['__note'].value:
message = _('note added')
- elif self.form.has_key('__file'):
+ elif (self.form.has_key('__file') and
+ self.form['__file'].filename):
message = _('file added')
else:
message = _('nothing changed')
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()
if not props.has_key('assignedto'):
return
assignedto_id = props['assignedto']
- if props.has_key('nosy') and assignedto_id not in props['nosy']:
+ 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)
- else:
- props['nosy'] = [assignedto_id]
def _changenode(self, props):
''' change the node based on the contents of the form
props['messages'] = cl.get(self.nodeid, 'messages') + [message]
if files:
props['files'] = cl.get(self.nodeid, 'files') + files
+
# make the changes
cl.set(self.nodeid, **props)
''' 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
return cl.create(**props)
def _handle_message(self):
- ''' generate and edit message
+ ''' generate an edit message
'''
# handle file attachments
files = []
self.nodeid = nid
self.pagehead('%s: %s'%(self.classname.capitalize(), nid),
message)
- item = htmltemplate.ItemTemplate(self, self.TEMPLATES,
+ item = htmltemplate.ItemTemplate(self, self.instance.TEMPLATES,
self.classname)
item.render(nid)
self.pagefoot()
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)
keys = self.form.keys()
if [i for i in keys if i[0] != ':']:
try:
- props, dummy = parsePropsFromForm(self.db, cl, self.form)
+ props = parsePropsFromForm(self.db, cl, self.form)
nid = cl.create(**props)
# handle linked nodes
self._post_editnode(nid)
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.pagehead(_('New %(classname)s')%{'classname':
self.classname.capitalize()}, message)
- newitem = htmltemplate.NewItemTemplate(self, self.TEMPLATES,
+ newitem = htmltemplate.NewItemTemplate(self, self.instance.TEMPLATES,
self.classname)
newitem.render(self.form)
self.pagefoot()
num_re = re.compile('^\d+$')
if keys:
try:
- props, changed = parsePropsFromForm(self.db, user, self.form,
+ props = parsePropsFromForm(self.db, user, self.form,
self.nodeid)
set_cookie = 0
- if self.nodeid == self.getuid() and changed.has_key('password'):
+ if props.has_key('password'):
password = self.form['password'].value.strip()
- if password:
- set_cookie = password
- else:
+ if not password:
# no password was supplied - don't change it
del props['password']
- del changed['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(changed.keys())}
+ ', '.join(props.keys())}
except:
self.db.rollback()
s = StringIO.StringIO()
self.pagehead(_('User: %(user)s')%{'user': node_user}, message)
# use the template to display the item
- item = htmltemplate.ItemTemplate(self, self.TEMPLATES, 'user')
+ item = htmltemplate.ItemTemplate(self, self.instance.TEMPLATES, 'user')
item.render(self.nodeid)
self.pagefoot()
self.write('<table border=0 cellspacing=0 cellpadding=2>\n')
for cn in classnames:
cl = self.db.getclass(cn)
- self.write('<tr class="list-header"><th colspan=2 align=left>%s</th></tr>'%cn.capitalize())
+ self.write('<tr class="list-header"><th colspan=2 align=left>'
+ '<a href="%s">%s</a></th></tr>'%(cn, cn.capitalize()))
for key, value in cl.properties.items():
if value is None: value = ''
else: value = str(value)
self.write(_('''
<table>
<tr><td colspan=2 class="strong-header">Existing User Login</td></tr>
-<form action="login_action" method=POST>
+<form onSubmit="return submit_once()" 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>
<td><input type="submit" value="Log In"></td></tr>
</form>
''')%locals())
- if self.user is None and self.ANONYMOUS_REGISTER == 'deny':
+ if self.user is None and self.instance.ANONYMOUS_REGISTER == 'deny':
self.write('</table>')
self.pagefoot()
return
values = {'realname': '', 'organisation': '', 'address': '',
'phone': '', 'username': '', 'password': '', 'confirm': '',
- 'action': action}
+ 'action': action, 'alternate_addresses': ''}
if newuser_form is not None:
for key in newuser_form.keys():
values[key] = newuser_form[key].value
<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>
+<form onSubmit="return submit_once()" 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="realname" value="%(realname)s"></td></tr>
+ <td><input name="realname" value="%(realname)s" size=40></td></tr>
<tr><td align=right><em>Organisation: </em></td>
- <td><input name="organisation" value="%(organisation)s"></td></tr>
+ <td><input name="organisation" value="%(organisation)s" size=40></td></tr>
<tr><td align=right>E-Mail Address: </td>
- <td><input name="address" value="%(address)s"></td></tr>
+ <td><input name="address" value="%(address)s" size=40></td></tr>
+<tr><td align=right><em>Alternate E-mail Addresses: </em></td>
+ <td><textarea name="alternate_addresses" rows=5 cols=40>%(alternate_addresses)s</textarea></td></tr>
<tr><td align=right><em>Phone: </em></td>
<td><input name="phone" value="%(phone)s"></td></tr>
<tr><td align=right>Preferred Login name: </td>
# TODO: pre-check the required fields and username key property
cl = self.db.user
try:
- props, dummy = parsePropsFromForm(self.db, cl, self.form)
+ props = parsePropsFromForm(self.db, cl, self.form)
uid = cl.create(**props)
except ValueError, message:
action = self.form['__destination_url'].value
path)})
self.login()
-
def main(self):
'''Wrap the database accesses so we can close the database cleanly
'''
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':
self.login() # go to the index after login
else:
action = 'index'
# no login or registration, make sure totally anonymous access is OK
- elif self.ANONYMOUS_ACCESS == 'deny' and self.user is None:
+ elif self.instance.ANONYMOUS_ACCESS == 'deny' and self.user is None:
if action == 'login':
self.login() # go to the index after login
else:
if action == 'list_classes':
self.classes()
return
+ if action == 'classhelp':
+ self.classhelp()
+ return
if action == 'login':
self.login()
return
if action == 'logout':
self.logout()
return
+
+ # see if we're to display an existing node
m = dre.match(action)
if m:
self.classname = m.group(1)
raise NotFound
func()
return
+
+ # see if we're to put up the new node page
m = nre.match(action)
if m:
self.classname = m.group(1)
raise NotFound
func()
return
+
+ # otherwise, display the named class
self.classname = action
try:
self.db.getclass(self.classname)
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 = _('<div class="system-msg">%(message)s</div>')%locals()
else:
message = ''
- style = open(os.path.join(self.TEMPLATES, 'style.css')).read()
+ style = open(os.path.join(self.instance.TEMPLATES, 'style.css')).read()
user_name = self.user or ''
if self.user == 'admin':
admin_links = _(' | <a href="list_classes">Class List</a>' \
''')
else:
add_links = ''
+ global_javascript = self.global_javascript%self.__dict__
self.write(_('''<html><head>
<title>%(title)s</title>
<style type="text/css">%(style)s</style>
</head>
+%(global_javascript)s
<body bgcolor=#ffffff>
%(message)s
<table width=100%% border=0 cellspacing=0 cellpadding=2>
'''Pull properties for the given class out of the form.
'''
props = {}
- changed = {}
keys = form.keys()
num_re = re.compile('^\d+$')
for key in keys:
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
l.append(entry)
l.sort()
value = l
- props[key] = value
# get the old value
if nodeid:
# value
if not cl.properties.has_key(key): raise
- # if changed, set it
- if nodeid and value != existing:
- changed[key] = value
+ # 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.110 2002/02/21 07:19:08 richard
+# ... and label, width and height control for extra flavour!
+#
+# Revision 1.109 2002/02/21 07:08:19 richard
+# oops
+#
+# Revision 1.108 2002/02/21 07:02:54 richard
+# The correct var is "HTTP_HOST"
+#
+# Revision 1.107 2002/02/21 06:57:38 richard
+# . Added popup help for classes using the classhelp html template function.
+# - add <display call="classhelp('priority', 'id,name,description')">
+# to an item page, and it generates a link to a popup window which displays
+# the id, name and description for the priority class. The description
+# field won't exist in most installations, but it will be added to the
+# default templates.
+#
+# Revision 1.106 2002/02/21 06:23:00 richard
+# *** empty log message ***
+#
+# Revision 1.105 2002/02/20 05:52:10 richard
+# better error handling
+#
+# Revision 1.104 2002/02/20 05:45:17 richard
+# Use the csv module for generating the form entry so it's correct.
+# [also noted the sf.net feature request id in the change log]
+#
+# Revision 1.103 2002/02/20 05:05:28 richard
+# . Added simple editing for classes that don't define a templated interface.
+# - access using the admin "class list" interface
+# - limited to admin-only
+# - requires the csv module from object-craft (url given if it's missing)
+#
+# 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
#