1 from __future__ import nested_scopes
3 """Implements the API used in the HTML templating for the web interface.
4 """
6 todo = """
7 - Most methods should have a "default" arg to supply a value
8 when none appears in the hyperdb or request.
9 - Multilink property additions: change_note and new_upload
10 - Add class.find() too
11 - NumberHTMLProperty should support numeric operations
12 - LinkHTMLProperty should handle comparisons to strings (cf. linked name)
13 - HTMLRequest.default(self, sort, group, filter, columns, **filterspec):
14 '''Set the request's view arguments to the given values when no
15 values are found in the CGI environment.
16 '''
17 - have menu() methods accept filtering arguments
18 """
20 __docformat__ = 'restructuredtext'
23 import sys, cgi, urllib, os, re, os.path, time, errno, mimetypes, csv
24 import calendar, textwrap
26 from roundup import hyperdb, date, support
27 from roundup import i18n
28 from roundup.i18n import _
30 try:
31 import cPickle as pickle
32 except ImportError:
33 import pickle
34 try:
35 import cStringIO as StringIO
36 except ImportError:
37 import StringIO
38 try:
39 from StructuredText.StructuredText import HTML as StructuredText
40 except ImportError:
41 try: # older version
42 import StructuredText
43 except ImportError:
44 StructuredText = None
45 try:
46 from docutils.core import publish_parts as ReStructuredText
47 except ImportError:
48 ReStructuredText = None
50 # bring in the templating support
51 from roundup.cgi.PageTemplates import PageTemplate, GlobalTranslationService
52 from roundup.cgi.PageTemplates.Expressions import getEngine
53 from roundup.cgi.TAL import TALInterpreter
54 from roundup.cgi import TranslationService, ZTUtils
56 ### i18n services
57 # this global translation service is not thread-safe.
58 # it is left here for backward compatibility
59 # until all Web UI translations are done via client.translator object
60 translationService = TranslationService.get_translation()
61 GlobalTranslationService.setGlobalTranslationService(translationService)
63 ### templating
65 class NoTemplate(Exception):
66 pass
68 class Unauthorised(Exception):
69 def __init__(self, action, klass, translator=None):
70 self.action = action
71 self.klass = klass
72 if translator:
73 self._ = translator.gettext
74 else:
75 self._ = TranslationService.get_translation().gettext
76 def __str__(self):
77 return self._('You are not allowed to %(action)s '
78 'items of class %(class)s') % {
79 'action': self.action, 'class': self.klass}
81 def find_template(dir, name, view):
82 """ Find a template in the nominated dir
83 """
84 # find the source
85 if view:
86 filename = '%s.%s'%(name, view)
87 else:
88 filename = name
90 # try old-style
91 src = os.path.join(dir, filename)
92 if os.path.exists(src):
93 return (src, filename)
95 # try with a .html or .xml extension (new-style)
96 for extension in '.html', '.xml':
97 f = filename + extension
98 src = os.path.join(dir, f)
99 if os.path.exists(src):
100 return (src, f)
102 # no view == no generic template is possible
103 if not view:
104 raise NoTemplate, 'Template file "%s" doesn\'t exist'%name
106 # try for a _generic template
107 generic = '_generic.%s'%view
108 src = os.path.join(dir, generic)
109 if os.path.exists(src):
110 return (src, generic)
112 # finally, try _generic.html
113 generic = generic + '.html'
114 src = os.path.join(dir, generic)
115 if os.path.exists(src):
116 return (src, generic)
118 raise NoTemplate('No template file exists for templating "%s" '
119 'with template "%s" (neither "%s" nor "%s")'%(name, view,
120 filename, generic))
122 class Templates:
123 templates = {}
125 def __init__(self, dir):
126 self.dir = dir
128 def precompileTemplates(self):
129 """ Go through a directory and precompile all the templates therein
130 """
131 for filename in os.listdir(self.dir):
132 # skip subdirs
133 if os.path.isdir(filename):
134 continue
136 # skip files without ".html" or ".xml" extension - .css, .js etc.
137 for extension in '.html', '.xml':
138 if filename.endswith(extension):
139 break
140 else:
141 continue
143 # remove extension
144 filename = filename[:-len(extension)]
146 # load the template
147 if '.' in filename:
148 name, extension = filename.split('.', 1)
149 self.get(name, extension)
150 else:
151 self.get(filename, None)
153 def get(self, name, extension=None):
154 """ Interface to get a template, possibly loading a compiled template.
156 "name" and "extension" indicate the template we're after, which in
157 most cases will be "name.extension". If "extension" is None, then
158 we look for a template just called "name" with no extension.
160 If the file "name.extension" doesn't exist, we look for
161 "_generic.extension" as a fallback.
162 """
163 # default the name to "home"
164 if name is None:
165 name = 'home'
166 elif extension is None and '.' in name:
167 # split name
168 name, extension = name.split('.')
170 # find the source
171 src, filename = find_template(self.dir, name, extension)
173 # has it changed?
174 try:
175 stime = os.stat(src)[os.path.stat.ST_MTIME]
176 except os.error, error:
177 if error.errno != errno.ENOENT:
178 raise
180 if self.templates.has_key(src) and \
181 stime <= self.templates[src].mtime:
182 # compiled template is up to date
183 return self.templates[src]
185 # compile the template
186 pt = RoundupPageTemplate()
187 # use pt_edit so we can pass the content_type guess too
188 content_type = mimetypes.guess_type(filename)[0] or 'text/html'
189 pt.pt_edit(open(src).read(), content_type)
190 pt.id = filename
191 pt.mtime = stime
192 # Add it to the cache. We cannot do this until the template
193 # is fully initialized, as we could otherwise have a race
194 # condition when running with multiple threads:
195 #
196 # 1. Thread A notices the template is not in the cache,
197 # adds it, but has not yet set "mtime".
198 #
199 # 2. Thread B notices the template is in the cache, checks
200 # "mtime" (above) and crashes.
201 #
202 # Since Python dictionary access is atomic, as long as we
203 # insert "pt" only after it is fully initialized, we avoid
204 # this race condition. It's possible that two separate
205 # threads will both do the work of initializing the template,
206 # but the risk of wasted work is offset by avoiding a lock.
207 self.templates[src] = pt
208 return pt
210 def __getitem__(self, name):
211 name, extension = os.path.splitext(name)
212 if extension:
213 extension = extension[1:]
214 try:
215 return self.get(name, extension)
216 except NoTemplate, message:
217 raise KeyError, message
219 def context(client, template=None, classname=None, request=None):
220 """Return the rendering context dictionary
222 The dictionary includes following symbols:
224 *context*
225 this is one of three things:
227 1. None - we're viewing a "home" page
228 2. The current class of item being displayed. This is an HTMLClass
229 instance.
230 3. The current item from the database, if we're viewing a specific
231 item, as an HTMLItem instance.
233 *request*
234 Includes information about the current request, including:
236 - the url
237 - the current index information (``filterspec``, ``filter`` args,
238 ``properties``, etc) parsed out of the form.
239 - methods for easy filterspec link generation
240 - *user*, the current user node as an HTMLItem instance
241 - *form*, the current CGI form information as a FieldStorage
243 *config*
244 The current tracker config.
246 *db*
247 The current database, used to access arbitrary database items.
249 *utils*
250 This is a special class that has its base in the TemplatingUtils
251 class in this file. If the tracker interfaces module defines a
252 TemplatingUtils class then it is mixed in, overriding the methods
253 in the base class.
255 *templates*
256 Access to all the tracker templates by name.
257 Used mainly in *use-macro* commands.
259 *template*
260 Current rendering template.
262 *true*
263 Logical True value.
265 *false*
266 Logical False value.
268 *i18n*
269 Internationalization service, providing string translation
270 methods ``gettext`` and ``ngettext``.
272 """
273 # construct the TemplatingUtils class
274 utils = TemplatingUtils
275 if (hasattr(client.instance, 'interfaces') and
276 hasattr(client.instance.interfaces, 'TemplatingUtils')):
277 class utils(client.instance.interfaces.TemplatingUtils, utils):
278 pass
280 # if template, classname and/or request are not passed explicitely,
281 # compute form client
282 if template is None:
283 template = client.template
284 if classname is None:
285 classname = client.classname
286 if request is None:
287 request = HTMLRequest(client)
289 c = {
290 'context': None,
291 'options': {},
292 'nothing': None,
293 'request': request,
294 'db': HTMLDatabase(client),
295 'config': client.instance.config,
296 'tracker': client.instance,
297 'utils': utils(client),
298 'templates': client.instance.templates,
299 'template': template,
300 'true': 1,
301 'false': 0,
302 'i18n': client.translator
303 }
304 # add in the item if there is one
305 if client.nodeid:
306 c['context'] = HTMLItem(client, classname, client.nodeid,
307 anonymous=1)
308 elif client.db.classes.has_key(classname):
309 c['context'] = HTMLClass(client, classname, anonymous=1)
310 return c
312 class RoundupPageTemplate(PageTemplate.PageTemplate):
313 """A Roundup-specific PageTemplate.
315 Interrogate the client to set up Roundup-specific template variables
316 to be available. See 'context' function for the list of variables.
318 """
320 # 06-jun-2004 [als] i am not sure if this method is used yet
321 def getContext(self, client, classname, request):
322 return context(client, self, classname, request)
324 def render(self, client, classname, request, **options):
325 """Render this Page Template"""
327 if not self._v_cooked:
328 self._cook()
330 __traceback_supplement__ = (PageTemplate.PageTemplateTracebackSupplement, self)
332 if self._v_errors:
333 raise PageTemplate.PTRuntimeError, \
334 'Page Template %s has errors.'%self.id
336 # figure the context
337 c = context(client, self, classname, request)
338 c.update({'options': options})
340 # and go
341 output = StringIO.StringIO()
342 TALInterpreter.TALInterpreter(self._v_program, self.macros,
343 getEngine().getContext(c), output, tal=1, strictinsert=0)()
344 return output.getvalue()
346 def __repr__(self):
347 return '<Roundup PageTemplate %r>'%self.id
349 class HTMLDatabase:
350 """ Return HTMLClasses for valid class fetches
351 """
352 def __init__(self, client):
353 self._client = client
354 self._ = client._
355 self._db = client.db
357 # we want config to be exposed
358 self.config = client.db.config
360 def __getitem__(self, item, desre=re.compile(r'(?P<cl>[a-zA-Z_]+)(?P<id>[-\d]+)')):
361 # check to see if we're actually accessing an item
362 m = desre.match(item)
363 if m:
364 cl = m.group('cl')
365 self._client.db.getclass(cl)
366 return HTMLItem(self._client, cl, m.group('id'))
367 else:
368 self._client.db.getclass(item)
369 return HTMLClass(self._client, item)
371 def __getattr__(self, attr):
372 try:
373 return self[attr]
374 except KeyError:
375 raise AttributeError, attr
377 def classes(self):
378 l = self._client.db.classes.keys()
379 l.sort()
380 m = []
381 for item in l:
382 m.append(HTMLClass(self._client, item))
383 return m
385 num_re = re.compile('^-?\d+$')
387 def lookupIds(db, prop, ids, fail_ok=0, num_re=num_re, do_lookup=True):
388 """ "fail_ok" should be specified if we wish to pass through bad values
389 (most likely form values that we wish to represent back to the user)
390 "do_lookup" is there for preventing lookup by key-value (if we
391 know that the value passed *is* an id)
392 """
393 cl = db.getclass(prop.classname)
394 l = []
395 for entry in ids:
396 if do_lookup:
397 try:
398 item = cl.lookup(entry)
399 except (TypeError, KeyError):
400 pass
401 else:
402 l.append(item)
403 continue
404 # if fail_ok, ignore lookup error
405 # otherwise entry must be existing object id rather than key value
406 if fail_ok or num_re.match(entry):
407 l.append(entry)
408 return l
410 def lookupKeys(linkcl, key, ids, num_re=num_re):
411 """ Look up the "key" values for "ids" list - though some may already
412 be key values, not ids.
413 """
414 l = []
415 for entry in ids:
416 if num_re.match(entry):
417 label = linkcl.get(entry, key)
418 # fall back to designator if label is None
419 if label is None: label = '%s%s'%(linkcl.classname, entry)
420 l.append(label)
421 else:
422 l.append(entry)
423 return l
425 def _set_input_default_args(dic):
426 # 'text' is the default value anyway --
427 # but for CSS usage it should be present
428 dic.setdefault('type', 'text')
429 # useful e.g for HTML LABELs:
430 if not dic.has_key('id'):
431 try:
432 if dic['text'] in ('radio', 'checkbox'):
433 dic['id'] = '%(name)s-%(value)s' % dic
434 else:
435 dic['id'] = dic['name']
436 except KeyError:
437 pass
439 def cgi_escape_attrs(**attrs):
440 return ' '.join(['%s="%s"'%(k,cgi.escape(str(v), True))
441 for k,v in attrs.items()])
443 def input_html4(**attrs):
444 """Generate an 'input' (html4) element with given attributes"""
445 _set_input_default_args(attrs)
446 return '<input %s>'%cgi_escape_attrs(**attrs)
448 def input_xhtml(**attrs):
449 """Generate an 'input' (xhtml) element with given attributes"""
450 _set_input_default_args(attrs)
451 return '<input %s/>'%cgi_escape_attrs(**attrs)
453 class HTMLInputMixin:
454 """ requires a _client property """
455 def __init__(self):
456 html_version = 'html4'
457 if hasattr(self._client.instance.config, 'HTML_VERSION'):
458 html_version = self._client.instance.config.HTML_VERSION
459 if html_version == 'xhtml':
460 self.input = input_xhtml
461 else:
462 self.input = input_html4
463 # self._context is used for translations.
464 # will be initialized by the first call to .gettext()
465 self._context = None
467 def gettext(self, msgid):
468 """Return the localized translation of msgid"""
469 if self._context is None:
470 self._context = context(self._client)
471 return self._client.translator.translate(domain="roundup",
472 msgid=msgid, context=self._context)
474 _ = gettext
476 class HTMLPermissions:
478 def view_check(self):
479 """ Raise the Unauthorised exception if the user's not permitted to
480 view this class.
481 """
482 if not self.is_view_ok():
483 raise Unauthorised("view", self._classname,
484 translator=self._client.translator)
486 def edit_check(self):
487 """ Raise the Unauthorised exception if the user's not permitted to
488 edit items of this class.
489 """
490 if not self.is_edit_ok():
491 raise Unauthorised("edit", self._classname,
492 translator=self._client.translator)
494 def retire_check(self):
495 """ Raise the Unauthorised exception if the user's not permitted to
496 retire items of this class.
497 """
498 if not self.is_retire_ok():
499 raise Unauthorised("retire", self._classname,
500 translator=self._client.translator)
503 class HTMLClass(HTMLInputMixin, HTMLPermissions):
504 """ Accesses through a class (either through *class* or *db.<classname>*)
505 """
506 def __init__(self, client, classname, anonymous=0):
507 self._client = client
508 self._ = client._
509 self._db = client.db
510 self._anonymous = anonymous
512 # we want classname to be exposed, but _classname gives a
513 # consistent API for extending Class/Item
514 self._classname = self.classname = classname
515 self._klass = self._db.getclass(self.classname)
516 self._props = self._klass.getprops()
518 HTMLInputMixin.__init__(self)
520 def is_edit_ok(self):
521 """ Is the user allowed to Create the current class?
522 """
523 perm = self._db.security.hasPermission
524 return perm('Web Access', self._client.userid) and perm('Create',
525 self._client.userid, self._classname)
527 def is_retire_ok(self):
528 """ Is the user allowed to retire items of the current class?
529 """
530 perm = self._db.security.hasPermission
531 return perm('Web Access', self._client.userid) and perm('Retire',
532 self._client.userid, self._classname)
534 def is_view_ok(self):
535 """ Is the user allowed to View the current class?
536 """
537 perm = self._db.security.hasPermission
538 return perm('Web Access', self._client.userid) and perm('View',
539 self._client.userid, self._classname)
541 def is_only_view_ok(self):
542 """ Is the user only allowed to View (ie. not Create) the current class?
543 """
544 return self.is_view_ok() and not self.is_edit_ok()
546 def __repr__(self):
547 return '<HTMLClass(0x%x) %s>'%(id(self), self.classname)
549 def __getitem__(self, item):
550 """ return an HTMLProperty instance
551 """
553 # we don't exist
554 if item == 'id':
555 return None
557 # get the property
558 try:
559 prop = self._props[item]
560 except KeyError:
561 raise KeyError, 'No such property "%s" on %s'%(item, self.classname)
563 # look up the correct HTMLProperty class
564 form = self._client.form
565 for klass, htmlklass in propclasses:
566 if not isinstance(prop, klass):
567 continue
568 if isinstance(prop, hyperdb.Multilink):
569 value = []
570 else:
571 value = None
572 return htmlklass(self._client, self._classname, None, prop, item,
573 value, self._anonymous)
575 # no good
576 raise KeyError, item
578 def __getattr__(self, attr):
579 """ convenience access """
580 try:
581 return self[attr]
582 except KeyError:
583 raise AttributeError, attr
585 def designator(self):
586 """ Return this class' designator (classname) """
587 return self._classname
589 def getItem(self, itemid, num_re=num_re):
590 """ Get an item of this class by its item id.
591 """
592 # make sure we're looking at an itemid
593 if not isinstance(itemid, type(1)) and not num_re.match(itemid):
594 itemid = self._klass.lookup(itemid)
596 return HTMLItem(self._client, self.classname, itemid)
598 def properties(self, sort=1):
599 """ Return HTMLProperty for all of this class' properties.
600 """
601 l = []
602 for name, prop in self._props.items():
603 for klass, htmlklass in propclasses:
604 if isinstance(prop, hyperdb.Multilink):
605 value = []
606 else:
607 value = None
608 if isinstance(prop, klass):
609 l.append(htmlklass(self._client, self._classname, '',
610 prop, name, value, self._anonymous))
611 if sort:
612 l.sort(lambda a,b:cmp(a._name, b._name))
613 return l
615 def list(self, sort_on=None):
616 """ List all items in this class.
617 """
618 # get the list and sort it nicely
619 l = self._klass.list()
620 sortfunc = make_sort_function(self._db, self._classname, sort_on)
621 l.sort(sortfunc)
623 # check perms
624 check = self._client.db.security.hasPermission
625 userid = self._client.userid
626 if not check('Web Access', userid):
627 return []
629 l = [HTMLItem(self._client, self._classname, id) for id in l
630 if check('View', userid, self._classname, itemid=id)]
632 return l
634 def csv(self):
635 """ Return the items of this class as a chunk of CSV text.
636 """
637 props = self.propnames()
638 s = StringIO.StringIO()
639 writer = csv.writer(s)
640 writer.writerow(props)
641 check = self._client.db.security.hasPermission
642 userid = self._client.userid
643 if not check('Web Access', userid):
644 return ''
645 for nodeid in self._klass.list():
646 l = []
647 for name in props:
648 # check permission to view this property on this item
649 if not check('View', userid, itemid=nodeid,
650 classname=self._klass.classname, property=name):
651 raise Unauthorised('view', self._klass.classname,
652 translator=self._client.translator)
653 value = self._klass.get(nodeid, name)
654 if value is None:
655 l.append('')
656 elif isinstance(value, type([])):
657 l.append(':'.join(map(str, value)))
658 else:
659 l.append(str(self._klass.get(nodeid, name)))
660 writer.writerow(l)
661 return s.getvalue()
663 def propnames(self):
664 """ Return the list of the names of the properties of this class.
665 """
666 idlessprops = self._klass.getprops(protected=0).keys()
667 idlessprops.sort()
668 return ['id'] + idlessprops
670 def filter(self, request=None, filterspec={}, sort=[], group=[]):
671 """ Return a list of items from this class, filtered and sorted
672 by the current requested filterspec/filter/sort/group args
674 "request" takes precedence over the other three arguments.
675 """
676 if request is not None:
677 filterspec = request.filterspec
678 sort = request.sort
679 group = request.group
681 check = self._db.security.hasPermission
682 userid = self._client.userid
683 if not check('Web Access', userid):
684 return []
686 l = [HTMLItem(self._client, self.classname, id)
687 for id in self._klass.filter(None, filterspec, sort, group)
688 if check('View', userid, self.classname, itemid=id)]
689 return l
691 def classhelp(self, properties=None, label=''"(list)", width='500',
692 height='400', property='', form='itemSynopsis',
693 pagesize=50, inputtype="checkbox", sort=None, filter=None):
694 """Pop up a javascript window with class help
696 This generates a link to a popup window which displays the
697 properties indicated by "properties" of the class named by
698 "classname". The "properties" should be a comma-separated list
699 (eg. 'id,name,description'). Properties defaults to all the
700 properties of a class (excluding id, creator, created and
701 activity).
703 You may optionally override the label displayed, the width,
704 the height, the number of items per page and the field on which
705 the list is sorted (defaults to username if in the displayed
706 properties).
708 With the "filter" arg it is possible to specify a filter for
709 which items are supposed to be displayed. It has to be of
710 the format "<field>=<values>;<field>=<values>;...".
712 The popup window will be resizable and scrollable.
714 If the "property" arg is given, it's passed through to the
715 javascript help_window function.
717 You can use inputtype="radio" to display a radio box instead
718 of the default checkbox (useful for entering Link-properties)
720 If the "form" arg is given, it's passed through to the
721 javascript help_window function. - it's the name of the form
722 the "property" belongs to.
723 """
724 if properties is None:
725 properties = self._klass.getprops(protected=0).keys()
726 properties.sort()
727 properties = ','.join(properties)
728 if sort is None:
729 if 'username' in properties.split( ',' ):
730 sort = 'username'
731 else:
732 sort = self._klass.orderprop()
733 sort = '&@sort=' + sort
734 if property:
735 property = '&property=%s'%property
736 if form:
737 form = '&form=%s'%form
738 if inputtype:
739 type= '&type=%s'%inputtype
740 if filter:
741 filterprops = filter.split(';')
742 filtervalues = []
743 names = []
744 for x in filterprops:
745 (name, values) = x.split('=')
746 names.append(name)
747 filtervalues.append('&%s=%s' % (name, urllib.quote(values)))
748 filter = '&@filter=%s%s' % (','.join(names), ''.join(filtervalues))
749 else:
750 filter = ''
751 help_url = "%s?@startwith=0&@template=help&"\
752 "properties=%s%s%s%s%s&@pagesize=%s%s" % \
753 (self.classname, properties, property, form, type,
754 sort, pagesize, filter)
755 onclick = "javascript:help_window('%s', '%s', '%s');return false;" % \
756 (help_url, width, height)
757 return '<a class="classhelp" href="%s" onclick="%s">%s</a>' % \
758 (help_url, onclick, self._(label))
760 def submit(self, label=''"Submit New Entry", action="new"):
761 """ Generate a submit button (and action hidden element)
763 Generate nothing if we're not editable.
764 """
765 if not self.is_edit_ok():
766 return ''
768 return self.input(type="hidden", name="@action", value=action) + \
769 '\n' + \
770 self.input(type="submit", name="submit_button", value=self._(label))
772 def history(self):
773 if not self.is_view_ok():
774 return self._('[hidden]')
775 return self._('New node - no history')
777 def renderWith(self, name, **kwargs):
778 """ Render this class with the given template.
779 """
780 # create a new request and override the specified args
781 req = HTMLRequest(self._client)
782 req.classname = self.classname
783 req.update(kwargs)
785 # new template, using the specified classname and request
786 pt = self._client.instance.templates.get(self.classname, name)
788 # use our fabricated request
789 args = {
790 'ok_message': self._client.ok_message,
791 'error_message': self._client.error_message
792 }
793 return pt.render(self._client, self.classname, req, **args)
795 class _HTMLItem(HTMLInputMixin, HTMLPermissions):
796 """ Accesses through an *item*
797 """
798 def __init__(self, client, classname, nodeid, anonymous=0):
799 self._client = client
800 self._db = client.db
801 self._classname = classname
802 self._nodeid = nodeid
803 self._klass = self._db.getclass(classname)
804 self._props = self._klass.getprops()
806 # do we prefix the form items with the item's identification?
807 self._anonymous = anonymous
809 HTMLInputMixin.__init__(self)
811 def is_edit_ok(self):
812 """ Is the user allowed to Edit this item?
813 """
814 perm = self._db.security.hasPermission
815 return perm('Web Access', self._client.userid) and perm('Edit',
816 self._client.userid, self._classname, itemid=self._nodeid)
818 def is_retire_ok(self):
819 """ Is the user allowed to Reture this item?
820 """
821 perm = self._db.security.hasPermission
822 return perm('Web Access', self._client.userid) and perm('Retire',
823 self._client.userid, self._classname, itemid=self._nodeid)
825 def is_view_ok(self):
826 """ Is the user allowed to View this item?
827 """
828 perm = self._db.security.hasPermission
829 if perm('Web Access', self._client.userid) and perm('View',
830 self._client.userid, self._classname, itemid=self._nodeid):
831 return 1
832 return self.is_edit_ok()
834 def is_only_view_ok(self):
835 """ Is the user only allowed to View (ie. not Edit) this item?
836 """
837 return self.is_view_ok() and not self.is_edit_ok()
839 def __repr__(self):
840 return '<HTMLItem(0x%x) %s %s>'%(id(self), self._classname,
841 self._nodeid)
843 def __getitem__(self, item):
844 """ return an HTMLProperty instance
845 this now can handle transitive lookups where item is of the
846 form x.y.z
847 """
848 if item == 'id':
849 return self._nodeid
851 items = item.split('.', 1)
852 has_rest = len(items) > 1
854 # get the property
855 prop = self._props[items[0]]
857 if has_rest and not isinstance(prop, (hyperdb.Link, hyperdb.Multilink)):
858 raise KeyError, item
860 # get the value, handling missing values
861 value = None
862 if int(self._nodeid) > 0:
863 value = self._klass.get(self._nodeid, items[0], None)
864 if value is None:
865 if isinstance(prop, hyperdb.Multilink):
866 value = []
868 # look up the correct HTMLProperty class
869 htmlprop = None
870 for klass, htmlklass in propclasses:
871 if isinstance(prop, klass):
872 htmlprop = htmlklass(self._client, self._classname,
873 self._nodeid, prop, items[0], value, self._anonymous)
874 if htmlprop is not None:
875 if has_rest:
876 if isinstance(htmlprop, MultilinkHTMLProperty):
877 return [h[items[1]] for h in htmlprop]
878 return htmlprop[items[1]]
879 return htmlprop
881 raise KeyError, item
883 def __getattr__(self, attr):
884 """ convenience access to properties """
885 try:
886 return self[attr]
887 except KeyError:
888 raise AttributeError, attr
890 def designator(self):
891 """Return this item's designator (classname + id)."""
892 return '%s%s'%(self._classname, self._nodeid)
894 def is_retired(self):
895 """Is this item retired?"""
896 return self._klass.is_retired(self._nodeid)
898 def submit(self, label=''"Submit Changes", action="edit"):
899 """Generate a submit button.
901 Also sneak in the lastactivity and action hidden elements.
902 """
903 return self.input(type="hidden", name="@lastactivity",
904 value=self.activity.local(0)) + '\n' + \
905 self.input(type="hidden", name="@action", value=action) + '\n' + \
906 self.input(type="submit", name="submit_button", value=self._(label))
908 def journal(self, direction='descending'):
909 """ Return a list of HTMLJournalEntry instances.
910 """
911 # XXX do this
912 return []
914 def history(self, direction='descending', dre=re.compile('^\d+$'),
915 limit=None):
916 if not self.is_view_ok():
917 return self._('[hidden]')
919 # pre-load the history with the current state
920 current = {}
921 for prop_n in self._props.keys():
922 prop = self[prop_n]
923 if not isinstance(prop, HTMLProperty):
924 continue
925 current[prop_n] = prop.plain(escape=1)
926 # make link if hrefable
927 if (self._props.has_key(prop_n) and
928 isinstance(self._props[prop_n], hyperdb.Link)):
929 classname = self._props[prop_n].classname
930 try:
931 template = find_template(self._db.config.TEMPLATES,
932 classname, 'item')
933 if template[1].startswith('_generic'):
934 raise NoTemplate, 'not really...'
935 except NoTemplate:
936 pass
937 else:
938 id = self._klass.get(self._nodeid, prop_n, None)
939 current[prop_n] = '<a href="%s%s">%s</a>'%(
940 classname, id, current[prop_n])
942 # get the journal, sort and reverse
943 history = self._klass.history(self._nodeid)
944 history.sort()
945 history.reverse()
947 # restrict the volume
948 if limit:
949 history = history[:limit]
951 timezone = self._db.getUserTimezone()
952 l = []
953 comments = {}
954 for id, evt_date, user, action, args in history:
955 date_s = str(evt_date.local(timezone)).replace("."," ")
956 arg_s = ''
957 if action == 'link' and type(args) == type(()):
958 if len(args) == 3:
959 linkcl, linkid, key = args
960 arg_s += '<a href="%s%s">%s%s %s</a>'%(linkcl, linkid,
961 linkcl, linkid, key)
962 else:
963 arg_s = str(args)
965 elif action == 'unlink' and type(args) == type(()):
966 if len(args) == 3:
967 linkcl, linkid, key = args
968 arg_s += '<a href="%s%s">%s%s %s</a>'%(linkcl, linkid,
969 linkcl, linkid, key)
970 else:
971 arg_s = str(args)
973 elif type(args) == type({}):
974 cell = []
975 for k in args.keys():
976 # try to get the relevant property and treat it
977 # specially
978 try:
979 prop = self._props[k]
980 except KeyError:
981 prop = None
982 if prop is None:
983 # property no longer exists
984 comments['no_exist'] = self._(
985 "<em>The indicated property no longer exists</em>")
986 cell.append(self._('<em>%s: %s</em>\n')
987 % (self._(k), str(args[k])))
988 continue
990 if args[k] and (isinstance(prop, hyperdb.Multilink) or
991 isinstance(prop, hyperdb.Link)):
992 # figure what the link class is
993 classname = prop.classname
994 try:
995 linkcl = self._db.getclass(classname)
996 except KeyError:
997 labelprop = None
998 comments[classname] = self._(
999 "The linked class %(classname)s no longer exists"
1000 ) % locals()
1001 labelprop = linkcl.labelprop(1)
1002 try:
1003 template = find_template(self._db.config.TEMPLATES,
1004 classname, 'item')
1005 if template[1].startswith('_generic'):
1006 raise NoTemplate, 'not really...'
1007 hrefable = 1
1008 except NoTemplate:
1009 hrefable = 0
1011 if isinstance(prop, hyperdb.Multilink) and args[k]:
1012 ml = []
1013 for linkid in args[k]:
1014 if isinstance(linkid, type(())):
1015 sublabel = linkid[0] + ' '
1016 linkids = linkid[1]
1017 else:
1018 sublabel = ''
1019 linkids = [linkid]
1020 subml = []
1021 for linkid in linkids:
1022 label = classname + linkid
1023 # if we have a label property, try to use it
1024 # TODO: test for node existence even when
1025 # there's no labelprop!
1026 try:
1027 if labelprop is not None and \
1028 labelprop != 'id':
1029 label = linkcl.get(linkid, labelprop)
1030 label = cgi.escape(label)
1031 except IndexError:
1032 comments['no_link'] = self._(
1033 "<strike>The linked node"
1034 " no longer exists</strike>")
1035 subml.append('<strike>%s</strike>'%label)
1036 else:
1037 if hrefable:
1038 subml.append('<a href="%s%s">%s</a>'%(
1039 classname, linkid, label))
1040 elif label is None:
1041 subml.append('%s%s'%(classname,
1042 linkid))
1043 else:
1044 subml.append(label)
1045 ml.append(sublabel + ', '.join(subml))
1046 cell.append('%s:\n %s'%(self._(k), ', '.join(ml)))
1047 elif isinstance(prop, hyperdb.Link) and args[k]:
1048 label = classname + args[k]
1049 # if we have a label property, try to use it
1050 # TODO: test for node existence even when
1051 # there's no labelprop!
1052 if labelprop is not None and labelprop != 'id':
1053 try:
1054 label = cgi.escape(linkcl.get(args[k],
1055 labelprop))
1056 except IndexError:
1057 comments['no_link'] = self._(
1058 "<strike>The linked node"
1059 " no longer exists</strike>")
1060 cell.append(' <strike>%s</strike>,\n'%label)
1061 # "flag" this is done .... euwww
1062 label = None
1063 if label is not None:
1064 if hrefable:
1065 old = '<a href="%s%s">%s</a>'%(classname,
1066 args[k], label)
1067 else:
1068 old = label;
1069 cell.append('%s: %s' % (self._(k), old))
1070 if current.has_key(k):
1071 cell[-1] += ' -> %s'%current[k]
1072 current[k] = old
1074 elif isinstance(prop, hyperdb.Date) and args[k]:
1075 if args[k] is None:
1076 d = ''
1077 else:
1078 d = date.Date(args[k],
1079 translator=self._client).local(timezone)
1080 cell.append('%s: %s'%(self._(k), str(d)))
1081 if current.has_key(k):
1082 cell[-1] += ' -> %s' % current[k]
1083 current[k] = str(d)
1085 elif isinstance(prop, hyperdb.Interval) and args[k]:
1086 val = str(date.Interval(args[k],
1087 translator=self._client))
1088 cell.append('%s: %s'%(self._(k), val))
1089 if current.has_key(k):
1090 cell[-1] += ' -> %s'%current[k]
1091 current[k] = val
1093 elif isinstance(prop, hyperdb.String) and args[k]:
1094 val = cgi.escape(args[k])
1095 cell.append('%s: %s'%(self._(k), val))
1096 if current.has_key(k):
1097 cell[-1] += ' -> %s'%current[k]
1098 current[k] = val
1100 elif isinstance(prop, hyperdb.Boolean) and args[k] is not None:
1101 val = args[k] and ''"Yes" or ''"No"
1102 cell.append('%s: %s'%(self._(k), val))
1103 if current.has_key(k):
1104 cell[-1] += ' -> %s'%current[k]
1105 current[k] = val
1107 elif not args[k]:
1108 if current.has_key(k):
1109 cell.append('%s: %s'%(self._(k), current[k]))
1110 current[k] = '(no value)'
1111 else:
1112 cell.append(self._('%s: (no value)')%self._(k))
1114 else:
1115 cell.append('%s: %s'%(self._(k), str(args[k])))
1116 if current.has_key(k):
1117 cell[-1] += ' -> %s'%current[k]
1118 current[k] = str(args[k])
1120 arg_s = '<br />'.join(cell)
1121 else:
1122 # unkown event!!
1123 comments['unknown'] = self._(
1124 "<strong><em>This event is not handled"
1125 " by the history display!</em></strong>")
1126 arg_s = '<strong><em>' + str(args) + '</em></strong>'
1127 date_s = date_s.replace(' ', ' ')
1128 # if the user's an itemid, figure the username (older journals
1129 # have the username)
1130 if dre.match(user):
1131 user = self._db.user.get(user, 'username')
1132 l.append('<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>'%(
1133 date_s, user, self._(action), arg_s))
1134 if comments:
1135 l.append(self._(
1136 '<tr><td colspan=4><strong>Note:</strong></td></tr>'))
1137 for entry in comments.values():
1138 l.append('<tr><td colspan=4>%s</td></tr>'%entry)
1140 if direction == 'ascending':
1141 l.reverse()
1143 l[0:0] = ['<table class="history">'
1144 '<tr><th colspan="4" class="header">',
1145 self._('History'),
1146 '</th></tr><tr>',
1147 self._('<th>Date</th>'),
1148 self._('<th>User</th>'),
1149 self._('<th>Action</th>'),
1150 self._('<th>Args</th>'),
1151 '</tr>']
1152 l.append('</table>')
1153 return '\n'.join(l)
1155 def renderQueryForm(self):
1156 """ Render this item, which is a query, as a search form.
1157 """
1158 # create a new request and override the specified args
1159 req = HTMLRequest(self._client)
1160 req.classname = self._klass.get(self._nodeid, 'klass')
1161 name = self._klass.get(self._nodeid, 'name')
1162 req.updateFromURL(self._klass.get(self._nodeid, 'url') +
1163 '&@queryname=%s'%urllib.quote(name))
1165 # new template, using the specified classname and request
1166 pt = self._client.instance.templates.get(req.classname, 'search')
1167 # The context for a search page should be the class, not any
1168 # node.
1169 self._client.nodeid = None
1171 # use our fabricated request
1172 return pt.render(self._client, req.classname, req)
1174 def download_url(self):
1175 """ Assume that this item is a FileClass and that it has a name
1176 and content. Construct a URL for the download of the content.
1177 """
1178 name = self._klass.get(self._nodeid, 'name')
1179 url = '%s%s/%s'%(self._classname, self._nodeid, name)
1180 return urllib.quote(url)
1182 def copy_url(self, exclude=("messages", "files")):
1183 """Construct a URL for creating a copy of this item
1185 "exclude" is an optional list of properties that should
1186 not be copied to the new object. By default, this list
1187 includes "messages" and "files" properties. Note that
1188 "id" property cannot be copied.
1190 """
1191 exclude = ("id", "activity", "actor", "creation", "creator") \
1192 + tuple(exclude)
1193 query = {
1194 "@template": "item",
1195 "@note": self._("Copy of %(class)s %(id)s") % {
1196 "class": self._(self._classname), "id": self._nodeid},
1197 }
1198 for name in self._props.keys():
1199 if name not in exclude:
1200 query[name] = self[name].plain()
1201 return self._classname + "?" + "&".join(
1202 ["%s=%s" % (key, urllib.quote(value))
1203 for key, value in query.items()])
1205 class _HTMLUser(_HTMLItem):
1206 """Add ability to check for permissions on users.
1207 """
1208 _marker = []
1209 def hasPermission(self, permission, classname=_marker,
1210 property=None, itemid=None):
1211 """Determine if the user has the Permission.
1213 The class being tested defaults to the template's class, but may
1214 be overidden for this test by suppling an alternate classname.
1215 """
1216 if classname is self._marker:
1217 classname = self._client.classname
1218 return self._db.security.hasPermission(permission,
1219 self._nodeid, classname, property, itemid)
1221 def hasRole(self, *rolenames):
1222 """Determine whether the user has any role in rolenames."""
1223 return self._db.user.has_role(self._nodeid, *rolenames)
1225 def HTMLItem(client, classname, nodeid, anonymous=0):
1226 if classname == 'user':
1227 return _HTMLUser(client, classname, nodeid, anonymous)
1228 else:
1229 return _HTMLItem(client, classname, nodeid, anonymous)
1231 class HTMLProperty(HTMLInputMixin, HTMLPermissions):
1232 """ String, Number, Date, Interval HTMLProperty
1234 Has useful attributes:
1236 _name the name of the property
1237 _value the value of the property if any
1239 A wrapper object which may be stringified for the plain() behaviour.
1240 """
1241 def __init__(self, client, classname, nodeid, prop, name, value,
1242 anonymous=0):
1243 self._client = client
1244 self._db = client.db
1245 self._ = client._
1246 self._classname = classname
1247 self._nodeid = nodeid
1248 self._prop = prop
1249 self._value = value
1250 self._anonymous = anonymous
1251 self._name = name
1252 if not anonymous:
1253 if nodeid:
1254 self._formname = '%s%s@%s'%(classname, nodeid, name)
1255 else:
1256 # This case occurs when creating a property for a
1257 # non-anonymous class.
1258 self._formname = '%s@%s'%(classname, name)
1259 else:
1260 self._formname = name
1262 # If no value is already present for this property, see if one
1263 # is specified in the current form.
1264 form = self._client.form
1265 if not self._value and form.has_key(self._formname):
1266 if isinstance(prop, hyperdb.Multilink):
1267 value = lookupIds(self._db, prop,
1268 handleListCGIValue(form[self._formname]),
1269 fail_ok=1)
1270 elif isinstance(prop, hyperdb.Link):
1271 value = form.getfirst(self._formname).strip()
1272 if value:
1273 value = lookupIds(self._db, prop, [value],
1274 fail_ok=1)[0]
1275 else:
1276 value = None
1277 else:
1278 value = form.getfirst(self._formname).strip() or None
1279 self._value = value
1281 HTMLInputMixin.__init__(self)
1283 def __repr__(self):
1284 return '<HTMLProperty(0x%x) %s %r %r>'%(id(self), self._formname,
1285 self._prop, self._value)
1286 def __str__(self):
1287 return self.plain()
1288 def __cmp__(self, other):
1289 if isinstance(other, HTMLProperty):
1290 return cmp(self._value, other._value)
1291 return cmp(self._value, other)
1293 def __nonzero__(self):
1294 return not not self._value
1296 def isset(self):
1297 """Is my _value not None?"""
1298 return self._value is not None
1300 def is_edit_ok(self):
1301 """Should the user be allowed to use an edit form field for this
1302 property. Check "Create" for new items, or "Edit" for existing
1303 ones.
1304 """
1305 perm = self._db.security.hasPermission
1306 userid = self._client.userid
1307 if self._nodeid:
1308 if not perm('Web Access', userid):
1309 return False
1310 return perm('Edit', userid, self._classname, self._name,
1311 self._nodeid)
1312 return perm('Create', userid, self._classname, self._name) or \
1313 perm('Register', userid, self._classname, self._name)
1315 def is_view_ok(self):
1316 """ Is the user allowed to View the current class?
1317 """
1318 perm = self._db.security.hasPermission
1319 if perm('Web Access', self._client.userid) and perm('View',
1320 self._client.userid, self._classname, self._name, self._nodeid):
1321 return 1
1322 return self.is_edit_ok()
1324 class StringHTMLProperty(HTMLProperty):
1325 hyper_re = re.compile(r'''(
1326 (?P<url>
1327 (
1328 (ht|f)tp(s?):// # protocol
1329 ([\w]+(:\w+)?@)? # username/password
1330 ([\w\-]+) # hostname
1331 ((\.[\w-]+)+)? # .domain.etc
1332 | # ... or ...
1333 ([\w]+(:\w+)?@)? # username/password
1334 www\. # "www."
1335 ([\w\-]+\.)+ # hostname
1336 [\w]{2,5} # TLD
1337 )
1338 (:[\d]{1,5})? # port
1339 (/[\w\-$.+!*(),;:@&=?/~\\#%]*)? # path etc.
1340 )|
1341 (?P<email>[-+=%/\w\.]+@[\w\.\-]+)|
1342 (?P<item>(?P<class>[A-Za-z_]+)(\s*)(?P<id>\d+))
1343 )''', re.X | re.I)
1344 protocol_re = re.compile('^(ht|f)tp(s?)://', re.I)
1346 def _hyper_repl_item(self,match,replacement):
1347 item = match.group('item')
1348 cls = match.group('class').lower()
1349 id = match.group('id')
1350 try:
1351 # make sure cls is a valid tracker classname
1352 cl = self._db.getclass(cls)
1353 if not cl.hasnode(id):
1354 return item
1355 return replacement % locals()
1356 except KeyError:
1357 return item
1359 def _hyper_repl(self, match):
1360 if match.group('url'):
1361 u = s = match.group('url')
1362 if not self.protocol_re.search(s):
1363 u = 'http://' + s
1364 if s.endswith('>'):
1365 # catch an escaped ">" at the end of the URL
1366 u = s = s[:-4]
1367 e = '>'
1368 elif s.count('(') != s.count(')'):
1369 # don't include extraneous ')' in the link
1370 pos = s.rfind(')')
1371 e = s[pos:]
1372 u = s = s[:pos]
1373 else:
1374 e = ''
1375 return '<a href="%s">%s</a>%s' % (u, s, e)
1376 elif match.group('email'):
1377 s = match.group('email')
1378 return '<a href="mailto:%s">%s</a>' % (s, s)
1379 elif len(match.group('id')) < 10:
1380 return self._hyper_repl_item(match,
1381 '<a href="%(cls)s%(id)s">%(item)s</a>')
1382 else:
1383 # just return the matched text
1384 return match.group(0)
1386 def _hyper_repl_rst(self, match):
1387 if match.group('url'):
1388 s = match.group('url')
1389 return '`%s <%s>`_'%(s, s)
1390 elif match.group('email'):
1391 s = match.group('email')
1392 return '`%s <mailto:%s>`_'%(s, s)
1393 elif len(match.group('id')) < 10:
1394 return self._hyper_repl_item(match,'`%(item)s <%(cls)s%(id)s>`_')
1395 else:
1396 # just return the matched text
1397 return match.group(0)
1399 def hyperlinked(self):
1400 """ Render a "hyperlinked" version of the text """
1401 return self.plain(hyperlink=1)
1403 def plain(self, escape=0, hyperlink=0):
1404 """Render a "plain" representation of the property
1406 - "escape" turns on/off HTML quoting
1407 - "hyperlink" turns on/off in-text hyperlinking of URLs, email
1408 addresses and designators
1409 """
1410 if not self.is_view_ok():
1411 return self._('[hidden]')
1413 if self._value is None:
1414 return ''
1415 if escape:
1416 s = cgi.escape(str(self._value))
1417 else:
1418 s = str(self._value)
1419 if hyperlink:
1420 # no, we *must* escape this text
1421 if not escape:
1422 s = cgi.escape(s)
1423 s = self.hyper_re.sub(self._hyper_repl, s)
1424 return s
1426 def wrapped(self, escape=1, hyperlink=1):
1427 """Render a "wrapped" representation of the property.
1429 We wrap long lines at 80 columns on the nearest whitespace. Lines
1430 with no whitespace are not broken to force wrapping.
1432 Note that unlike plain() we default wrapped() to have the escaping
1433 and hyperlinking turned on since that's the most common usage.
1435 - "escape" turns on/off HTML quoting
1436 - "hyperlink" turns on/off in-text hyperlinking of URLs, email
1437 addresses and designators
1438 """
1439 if not self.is_view_ok():
1440 return self._('[hidden]')
1442 if self._value is None:
1443 return ''
1444 s = support.wrap(str(self._value), width=80)
1445 if escape:
1446 s = cgi.escape(s)
1447 if hyperlink:
1448 # no, we *must* escape this text
1449 if not escape:
1450 s = cgi.escape(s)
1451 s = self.hyper_re.sub(self._hyper_repl, s)
1452 return s
1454 def stext(self, escape=0, hyperlink=1):
1455 """ Render the value of the property as StructuredText.
1457 This requires the StructureText module to be installed separately.
1458 """
1459 if not self.is_view_ok():
1460 return self._('[hidden]')
1462 s = self.plain(escape=escape, hyperlink=hyperlink)
1463 if not StructuredText:
1464 return s
1465 return StructuredText(s,level=1,header=0)
1467 def rst(self, hyperlink=1):
1468 """ Render the value of the property as ReStructuredText.
1470 This requires docutils to be installed separately.
1471 """
1472 if not self.is_view_ok():
1473 return self._('[hidden]')
1475 if not ReStructuredText:
1476 return self.plain(escape=0, hyperlink=hyperlink)
1477 s = self.plain(escape=0, hyperlink=0)
1478 if hyperlink:
1479 s = self.hyper_re.sub(self._hyper_repl_rst, s)
1480 return ReStructuredText(s, writer_name="html")["html_body"].encode("utf-8",
1481 "replace")
1483 def field(self, **kwargs):
1484 """ Render the property as a field in HTML.
1486 If not editable, just display the value via plain().
1487 """
1488 if not self.is_edit_ok():
1489 return self.plain(escape=1)
1491 value = self._value
1492 if value is None:
1493 value = ''
1495 kwargs.setdefault("size", 30)
1496 kwargs.update({"name": self._formname, "value": value})
1497 return self.input(**kwargs)
1499 def multiline(self, escape=0, rows=5, cols=40, **kwargs):
1500 """ Render a multiline form edit field for the property.
1502 If not editable, just display the plain() value in a <pre> tag.
1503 """
1504 if not self.is_edit_ok():
1505 return '<pre>%s</pre>'%self.plain()
1507 if self._value is None:
1508 value = ''
1509 else:
1510 value = cgi.escape(str(self._value))
1512 value = '"'.join(value.split('"'))
1513 name = self._formname
1514 passthrough_args = cgi_escape_attrs(**kwargs)
1515 return ('<textarea %(passthrough_args)s name="%(name)s" id="%(name)s"'
1516 ' rows="%(rows)s" cols="%(cols)s">'
1517 '%(value)s</textarea>') % locals()
1519 def email(self, escape=1):
1520 """ Render the value of the property as an obscured email address
1521 """
1522 if not self.is_view_ok():
1523 return self._('[hidden]')
1525 if self._value is None:
1526 value = ''
1527 else:
1528 value = str(self._value)
1529 split = value.split('@')
1530 if len(split) == 2:
1531 name, domain = split
1532 domain = ' '.join(domain.split('.')[:-1])
1533 name = name.replace('.', ' ')
1534 value = '%s at %s ...'%(name, domain)
1535 else:
1536 value = value.replace('.', ' ')
1537 if escape:
1538 value = cgi.escape(value)
1539 return value
1541 class PasswordHTMLProperty(HTMLProperty):
1542 def plain(self, escape=0):
1543 """ Render a "plain" representation of the property
1544 """
1545 if not self.is_view_ok():
1546 return self._('[hidden]')
1548 if self._value is None:
1549 return ''
1550 return self._('*encrypted*')
1552 def field(self, size=30, **kwargs):
1553 """ Render a form edit field for the property.
1555 If not editable, just display the value via plain().
1556 """
1557 if not self.is_edit_ok():
1558 return self.plain(escape=1)
1560 return self.input(type="password", name=self._formname, size=size,
1561 **kwargs)
1563 def confirm(self, size=30):
1564 """ Render a second form edit field for the property, used for
1565 confirmation that the user typed the password correctly. Generates
1566 a field with name "@confirm@name".
1568 If not editable, display nothing.
1569 """
1570 if not self.is_edit_ok():
1571 return ''
1573 return self.input(type="password",
1574 name="@confirm@%s"%self._formname,
1575 id="%s-confirm"%self._formname,
1576 size=size)
1578 class NumberHTMLProperty(HTMLProperty):
1579 def plain(self, escape=0):
1580 """ Render a "plain" representation of the property
1581 """
1582 if not self.is_view_ok():
1583 return self._('[hidden]')
1585 if self._value is None:
1586 return ''
1588 return str(self._value)
1590 def field(self, size=30, **kwargs):
1591 """ Render a form edit field for the property.
1593 If not editable, just display the value via plain().
1594 """
1595 if not self.is_edit_ok():
1596 return self.plain(escape=1)
1598 value = self._value
1599 if value is None:
1600 value = ''
1602 return self.input(name=self._formname, value=value, size=size,
1603 **kwargs)
1605 def __int__(self):
1606 """ Return an int of me
1607 """
1608 return int(self._value)
1610 def __float__(self):
1611 """ Return a float of me
1612 """
1613 return float(self._value)
1616 class BooleanHTMLProperty(HTMLProperty):
1617 def plain(self, escape=0):
1618 """ Render a "plain" representation of the property
1619 """
1620 if not self.is_view_ok():
1621 return self._('[hidden]')
1623 if self._value is None:
1624 return ''
1625 return self._value and self._("Yes") or self._("No")
1627 def field(self, **kwargs):
1628 """ Render a form edit field for the property
1630 If not editable, just display the value via plain().
1631 """
1632 if not self.is_edit_ok():
1633 return self.plain(escape=1)
1635 value = self._value
1636 if isinstance(value, str) or isinstance(value, unicode):
1637 value = value.strip().lower() in ('checked', 'yes', 'true',
1638 'on', '1')
1640 checked = value and "checked" or ""
1641 if value:
1642 s = self.input(type="radio", name=self._formname, value="yes",
1643 checked="checked", **kwargs)
1644 s += self._('Yes')
1645 s +=self.input(type="radio", name=self._formname, value="no",
1646 **kwargs)
1647 s += self._('No')
1648 else:
1649 s = self.input(type="radio", name=self._formname, value="yes",
1650 **kwargs)
1651 s += self._('Yes')
1652 s +=self.input(type="radio", name=self._formname, value="no",
1653 checked="checked", **kwargs)
1654 s += self._('No')
1655 return s
1657 class DateHTMLProperty(HTMLProperty):
1659 _marker = []
1661 def __init__(self, client, classname, nodeid, prop, name, value,
1662 anonymous=0, offset=None):
1663 HTMLProperty.__init__(self, client, classname, nodeid, prop, name,
1664 value, anonymous=anonymous)
1665 if self._value and not (isinstance(self._value, str) or
1666 isinstance(self._value, unicode)):
1667 self._value.setTranslator(self._client.translator)
1668 self._offset = offset
1669 if self._offset is None :
1670 self._offset = self._prop.offset (self._db)
1672 def plain(self, escape=0):
1673 """ Render a "plain" representation of the property
1674 """
1675 if not self.is_view_ok():
1676 return self._('[hidden]')
1678 if self._value is None:
1679 return ''
1680 if self._offset is None:
1681 offset = self._db.getUserTimezone()
1682 else:
1683 offset = self._offset
1684 return str(self._value.local(offset))
1686 def now(self, str_interval=None):
1687 """ Return the current time.
1689 This is useful for defaulting a new value. Returns a
1690 DateHTMLProperty.
1691 """
1692 if not self.is_view_ok():
1693 return self._('[hidden]')
1695 ret = date.Date('.', translator=self._client)
1697 if isinstance(str_interval, basestring):
1698 sign = 1
1699 if str_interval[0] == '-':
1700 sign = -1
1701 str_interval = str_interval[1:]
1702 interval = date.Interval(str_interval, translator=self._client)
1703 if sign > 0:
1704 ret = ret + interval
1705 else:
1706 ret = ret - interval
1708 return DateHTMLProperty(self._client, self._classname, self._nodeid,
1709 self._prop, self._formname, ret)
1711 def field(self, size=30, default=None, format=_marker, popcal=True,
1712 **kwargs):
1713 """Render a form edit field for the property
1715 If not editable, just display the value via plain().
1717 If "popcal" then include the Javascript calendar editor.
1718 Default=yes.
1720 The format string is a standard python strftime format string.
1721 """
1722 if not self.is_edit_ok():
1723 if format is self._marker:
1724 return self.plain(escape=1)
1725 else:
1726 return self.pretty(format)
1728 value = self._value
1730 if value is None:
1731 if default is None:
1732 raw_value = None
1733 else:
1734 if isinstance(default, basestring):
1735 raw_value = date.Date(default, translator=self._client)
1736 elif isinstance(default, date.Date):
1737 raw_value = default
1738 elif isinstance(default, DateHTMLProperty):
1739 raw_value = default._value
1740 else:
1741 raise ValueError, self._('default value for '
1742 'DateHTMLProperty must be either DateHTMLProperty '
1743 'or string date representation.')
1744 elif isinstance(value, str) or isinstance(value, unicode):
1745 # most likely erroneous input to be passed back to user
1746 if isinstance(value, unicode): value = value.encode('utf8')
1747 return self.input(name=self._formname, value=value, size=size,
1748 **kwargs)
1749 else:
1750 raw_value = value
1752 if raw_value is None:
1753 value = ''
1754 elif isinstance(raw_value, str) or isinstance(raw_value, unicode):
1755 if format is self._marker:
1756 value = raw_value
1757 else:
1758 value = date.Date(raw_value).pretty(format)
1759 else:
1760 if self._offset is None :
1761 offset = self._db.getUserTimezone()
1762 else :
1763 offset = self._offset
1764 value = raw_value.local(offset)
1765 if format is not self._marker:
1766 value = value.pretty(format)
1768 s = self.input(name=self._formname, value=value, size=size,
1769 **kwargs)
1770 if popcal:
1771 s += self.popcal()
1772 return s
1774 def reldate(self, pretty=1):
1775 """ Render the interval between the date and now.
1777 If the "pretty" flag is true, then make the display pretty.
1778 """
1779 if not self.is_view_ok():
1780 return self._('[hidden]')
1782 if not self._value:
1783 return ''
1785 # figure the interval
1786 interval = self._value - date.Date('.', translator=self._client)
1787 if pretty:
1788 return interval.pretty()
1789 return str(interval)
1791 def pretty(self, format=_marker):
1792 """ Render the date in a pretty format (eg. month names, spaces).
1794 The format string is a standard python strftime format string.
1795 Note that if the day is zero, and appears at the start of the
1796 string, then it'll be stripped from the output. This is handy
1797 for the situation when a date only specifies a month and a year.
1798 """
1799 if not self.is_view_ok():
1800 return self._('[hidden]')
1802 if self._offset is None:
1803 offset = self._db.getUserTimezone()
1804 else:
1805 offset = self._offset
1807 if not self._value:
1808 return ''
1809 elif format is not self._marker:
1810 return self._value.local(offset).pretty(format)
1811 else:
1812 return self._value.local(offset).pretty()
1814 def local(self, offset):
1815 """ Return the date/time as a local (timezone offset) date/time.
1816 """
1817 if not self.is_view_ok():
1818 return self._('[hidden]')
1820 return DateHTMLProperty(self._client, self._classname, self._nodeid,
1821 self._prop, self._formname, self._value, offset=offset)
1823 def popcal(self, width=300, height=200, label="(cal)",
1824 form="itemSynopsis"):
1825 """Generate a link to a calendar pop-up window.
1827 item: HTMLProperty e.g.: context.deadline
1828 """
1829 if self.isset():
1830 date = "&date=%s"%self._value
1831 else :
1832 date = ""
1833 return ('<a class="classhelp" href="javascript:help_window('
1834 "'%s?@template=calendar&property=%s&form=%s%s', %d, %d)"
1835 '">%s</a>'%(self._classname, self._name, form, date, width,
1836 height, label))
1838 class IntervalHTMLProperty(HTMLProperty):
1839 def __init__(self, client, classname, nodeid, prop, name, value,
1840 anonymous=0):
1841 HTMLProperty.__init__(self, client, classname, nodeid, prop,
1842 name, value, anonymous)
1843 if self._value and not isinstance(self._value, (str, unicode)):
1844 self._value.setTranslator(self._client.translator)
1846 def plain(self, escape=0):
1847 """ Render a "plain" representation of the property
1848 """
1849 if not self.is_view_ok():
1850 return self._('[hidden]')
1852 if self._value is None:
1853 return ''
1854 return str(self._value)
1856 def pretty(self):
1857 """ Render the interval in a pretty format (eg. "yesterday")
1858 """
1859 if not self.is_view_ok():
1860 return self._('[hidden]')
1862 return self._value.pretty()
1864 def field(self, size=30, **kwargs):
1865 """ Render a form edit field for the property
1867 If not editable, just display the value via plain().
1868 """
1869 if not self.is_edit_ok():
1870 return self.plain(escape=1)
1872 value = self._value
1873 if value is None:
1874 value = ''
1876 return self.input(name=self._formname, value=value, size=size,
1877 **kwargs)
1879 class LinkHTMLProperty(HTMLProperty):
1880 """ Link HTMLProperty
1881 Include the above as well as being able to access the class
1882 information. Stringifying the object itself results in the value
1883 from the item being displayed. Accessing attributes of this object
1884 result in the appropriate entry from the class being queried for the
1885 property accessed (so item/assignedto/name would look up the user
1886 entry identified by the assignedto property on item, and then the
1887 name property of that user)
1888 """
1889 def __init__(self, *args, **kw):
1890 HTMLProperty.__init__(self, *args, **kw)
1891 # if we're representing a form value, then the -1 from the form really
1892 # should be a None
1893 if str(self._value) == '-1':
1894 self._value = None
1896 def __getattr__(self, attr):
1897 """ return a new HTMLItem """
1898 if not self._value:
1899 # handle a special page templates lookup
1900 if attr == '__render_with_namespace__':
1901 def nothing(*args, **kw):
1902 return ''
1903 return nothing
1904 msg = self._('Attempt to look up %(attr)s on a missing value')
1905 return MissingValue(msg%locals())
1906 i = HTMLItem(self._client, self._prop.classname, self._value)
1907 return getattr(i, attr)
1909 def plain(self, escape=0):
1910 """ Render a "plain" representation of the property
1911 """
1912 if not self.is_view_ok():
1913 return self._('[hidden]')
1915 if self._value is None:
1916 return ''
1917 linkcl = self._db.classes[self._prop.classname]
1918 k = linkcl.labelprop(1)
1919 if num_re.match(self._value):
1920 try:
1921 value = str(linkcl.get(self._value, k))
1922 except IndexError:
1923 value = self._value
1924 else :
1925 value = self._value
1926 if escape:
1927 value = cgi.escape(value)
1928 return value
1930 def field(self, showid=0, size=None, **kwargs):
1931 """ Render a form edit field for the property
1933 If not editable, just display the value via plain().
1934 """
1935 if not self.is_edit_ok():
1936 return self.plain(escape=1)
1938 # edit field
1939 linkcl = self._db.getclass(self._prop.classname)
1940 if self._value is None:
1941 value = ''
1942 else:
1943 k = linkcl.getkey()
1944 if k and num_re.match(self._value):
1945 value = linkcl.get(self._value, k)
1946 else:
1947 value = self._value
1948 return self.input(name=self._formname, value=value, size=size,
1949 **kwargs)
1951 def menu(self, size=None, height=None, showid=0, additional=[], value=None,
1952 sort_on=None, html_kwargs = {}, **conditions):
1953 """ Render a form select list for this property
1955 "size" is used to limit the length of the list labels
1956 "height" is used to set the <select> tag's "size" attribute
1957 "showid" includes the item ids in the list labels
1958 "value" specifies which item is pre-selected
1959 "additional" lists properties which should be included in the
1960 label
1961 "sort_on" indicates the property to sort the list on as
1962 (direction, property) where direction is '+' or '-'. A
1963 single string with the direction prepended may be used.
1964 For example: ('-', 'order'), '+name'.
1966 The remaining keyword arguments are used as conditions for
1967 filtering the items in the list - they're passed as the
1968 "filterspec" argument to a Class.filter() call.
1970 If not editable, just display the value via plain().
1971 """
1972 if not self.is_edit_ok():
1973 return self.plain(escape=1)
1975 # Since None indicates the default, we need another way to
1976 # indicate "no selection". We use -1 for this purpose, as
1977 # that is the value we use when submitting a form without the
1978 # value set.
1979 if value is None:
1980 value = self._value
1981 elif value == '-1':
1982 value = None
1984 linkcl = self._db.getclass(self._prop.classname)
1985 l = ['<select %s>'%cgi_escape_attrs(name = self._formname,
1986 **html_kwargs)]
1987 k = linkcl.labelprop(1)
1988 s = ''
1989 if value is None:
1990 s = 'selected="selected" '
1991 l.append(self._('<option %svalue="-1">- no selection -</option>')%s)
1993 if sort_on is not None:
1994 if not isinstance(sort_on, tuple):
1995 if sort_on[0] in '+-':
1996 sort_on = (sort_on[0], sort_on[1:])
1997 else:
1998 sort_on = ('+', sort_on)
1999 else:
2000 sort_on = ('+', linkcl.orderprop())
2002 options = [opt
2003 for opt in linkcl.filter(None, conditions, sort_on, (None, None))
2004 if self._db.security.hasPermission("View", self._client.userid,
2005 linkcl.classname, itemid=opt)]
2007 # make sure we list the current value if it's retired
2008 if value and value not in options:
2009 options.insert(0, value)
2011 if additional:
2012 additional_fns = []
2013 props = linkcl.getprops()
2014 for propname in additional:
2015 prop = props[propname]
2016 if isinstance(prop, hyperdb.Link):
2017 cl = self._db.getclass(prop.classname)
2018 labelprop = cl.labelprop()
2019 fn = lambda optionid: cl.get(linkcl.get(optionid,
2020 propname),
2021 labelprop)
2022 else:
2023 fn = lambda optionid: linkcl.get(optionid, propname)
2024 additional_fns.append(fn)
2026 for optionid in options:
2027 # get the option value, and if it's None use an empty string
2028 option = linkcl.get(optionid, k) or ''
2030 # figure if this option is selected
2031 s = ''
2032 if value in [optionid, option]:
2033 s = 'selected="selected" '
2035 # figure the label
2036 if showid:
2037 lab = '%s%s: %s'%(self._prop.classname, optionid, option)
2038 elif not option:
2039 lab = '%s%s'%(self._prop.classname, optionid)
2040 else:
2041 lab = option
2043 # truncate if it's too long
2044 if size is not None and len(lab) > size:
2045 lab = lab[:size-3] + '...'
2046 if additional:
2047 m = []
2048 for fn in additional_fns:
2049 m.append(str(fn(optionid)))
2050 lab = lab + ' (%s)'%', '.join(m)
2052 # and generate
2053 lab = cgi.escape(self._(lab))
2054 l.append('<option %svalue="%s">%s</option>'%(s, optionid, lab))
2055 l.append('</select>')
2056 return '\n'.join(l)
2057 # def checklist(self, ...)
2061 class MultilinkHTMLProperty(HTMLProperty):
2062 """ Multilink HTMLProperty
2064 Also be iterable, returning a wrapper object like the Link case for
2065 each entry in the multilink.
2066 """
2067 def __init__(self, *args, **kwargs):
2068 HTMLProperty.__init__(self, *args, **kwargs)
2069 if self._value:
2070 display_value = lookupIds(self._db, self._prop, self._value,
2071 fail_ok=1, do_lookup=False)
2072 sortfun = make_sort_function(self._db, self._prop.classname)
2073 # sorting fails if the value contains
2074 # items not yet stored in the database
2075 # ignore these errors to preserve user input
2076 try:
2077 display_value.sort(sortfun)
2078 except:
2079 pass
2080 self._value = display_value
2082 def __len__(self):
2083 """ length of the multilink """
2084 return len(self._value)
2086 def __getattr__(self, attr):
2087 """ no extended attribute accesses make sense here """
2088 raise AttributeError, attr
2090 def viewableGenerator(self, values):
2091 """Used to iterate over only the View'able items in a class."""
2092 check = self._db.security.hasPermission
2093 userid = self._client.userid
2094 classname = self._prop.classname
2095 if check('Web Access', userid):
2096 for value in values:
2097 if check('View', userid, classname, itemid=value):
2098 yield HTMLItem(self._client, classname, value)
2100 def __iter__(self):
2101 """ iterate and return a new HTMLItem
2102 """
2103 return self.viewableGenerator(self._value)
2105 def reverse(self):
2106 """ return the list in reverse order
2107 """
2108 l = self._value[:]
2109 l.reverse()
2110 return self.viewableGenerator(l)
2112 def sorted(self, property):
2113 """ Return this multilink sorted by the given property """
2114 value = list(self.__iter__())
2115 value.sort(lambda a,b:cmp(a[property], b[property]))
2116 return value
2118 def __contains__(self, value):
2119 """ Support the "in" operator. We have to make sure the passed-in
2120 value is a string first, not a HTMLProperty.
2121 """
2122 return str(value) in self._value
2124 def isset(self):
2125 """Is my _value not []?"""
2126 return self._value != []
2128 def plain(self, escape=0):
2129 """ Render a "plain" representation of the property
2130 """
2131 if not self.is_view_ok():
2132 return self._('[hidden]')
2134 linkcl = self._db.classes[self._prop.classname]
2135 k = linkcl.labelprop(1)
2136 labels = []
2137 for v in self._value:
2138 if num_re.match(v):
2139 try:
2140 label = linkcl.get(v, k)
2141 except IndexError:
2142 label = None
2143 # fall back to designator if label is None
2144 if label is None: label = '%s%s'%(self._prop.classname, k)
2145 else:
2146 label = v
2147 labels.append(label)
2148 value = ', '.join(labels)
2149 if escape:
2150 value = cgi.escape(value)
2151 return value
2153 def field(self, size=30, showid=0, **kwargs):
2154 """ Render a form edit field for the property
2156 If not editable, just display the value via plain().
2157 """
2158 if not self.is_edit_ok():
2159 return self.plain(escape=1)
2161 linkcl = self._db.getclass(self._prop.classname)
2163 if 'value' not in kwargs:
2164 value = self._value[:]
2165 # map the id to the label property
2166 if not linkcl.getkey():
2167 showid=1
2168 if not showid:
2169 k = linkcl.labelprop(1)
2170 value = lookupKeys(linkcl, k, value)
2171 value = ','.join(value)
2172 kwargs["value"] = value
2174 return self.input(name=self._formname, size=size, **kwargs)
2176 def menu(self, size=None, height=None, showid=0, additional=[],
2177 value=None, sort_on=None, html_kwargs = {}, **conditions):
2178 """ Render a form <select> list for this property.
2180 "size" is used to limit the length of the list labels
2181 "height" is used to set the <select> tag's "size" attribute
2182 "showid" includes the item ids in the list labels
2183 "additional" lists properties which should be included in the
2184 label
2185 "value" specifies which item is pre-selected
2186 "sort_on" indicates the property to sort the list on as
2187 (direction, property) where direction is '+' or '-'. A
2188 single string with the direction prepended may be used.
2189 For example: ('-', 'order'), '+name'.
2191 The remaining keyword arguments are used as conditions for
2192 filtering the items in the list - they're passed as the
2193 "filterspec" argument to a Class.filter() call.
2195 If not editable, just display the value via plain().
2196 """
2197 if not self.is_edit_ok():
2198 return self.plain(escape=1)
2200 if value is None:
2201 value = self._value
2203 linkcl = self._db.getclass(self._prop.classname)
2205 if sort_on is not None:
2206 if not isinstance(sort_on, tuple):
2207 if sort_on[0] in '+-':
2208 sort_on = (sort_on[0], sort_on[1:])
2209 else:
2210 sort_on = ('+', sort_on)
2211 else:
2212 sort_on = ('+', linkcl.orderprop())
2214 options = [opt
2215 for opt in linkcl.filter(None, conditions, sort_on)
2216 if self._db.security.hasPermission("View", self._client.userid,
2217 linkcl.classname, itemid=opt)]
2219 # make sure we list the current values if they're retired
2220 for val in value:
2221 if val not in options:
2222 options.insert(0, val)
2224 if not height:
2225 height = len(options)
2226 if value:
2227 # The "no selection" option.
2228 height += 1
2229 height = min(height, 7)
2230 l = ['<select multiple %s>'%cgi_escape_attrs(name = self._formname,
2231 size = height,
2232 **html_kwargs)]
2233 k = linkcl.labelprop(1)
2235 if value:
2236 l.append('<option value="%s">- no selection -</option>'
2237 % ','.join(['-' + v for v in value]))
2239 if additional:
2240 additional_fns = []
2241 props = linkcl.getprops()
2242 for propname in additional:
2243 prop = props[propname]
2244 if isinstance(prop, hyperdb.Link):
2245 cl = self._db.getclass(prop.classname)
2246 labelprop = cl.labelprop()
2247 fn = lambda optionid: cl.get(linkcl.get(optionid,
2248 propname),
2249 labelprop)
2250 else:
2251 fn = lambda optionid: linkcl.get(optionid, propname)
2252 additional_fns.append(fn)
2254 for optionid in options:
2255 # get the option value, and if it's None use an empty string
2256 option = linkcl.get(optionid, k) or ''
2258 # figure if this option is selected
2259 s = ''
2260 if optionid in value or option in value:
2261 s = 'selected="selected" '
2263 # figure the label
2264 if showid:
2265 lab = '%s%s: %s'%(self._prop.classname, optionid, option)
2266 else:
2267 lab = option
2268 # truncate if it's too long
2269 if size is not None and len(lab) > size:
2270 lab = lab[:size-3] + '...'
2271 if additional:
2272 m = []
2273 for fn in additional_fns:
2274 m.append(str(fn(optionid)))
2275 lab = lab + ' (%s)'%', '.join(m)
2277 # and generate
2278 lab = cgi.escape(self._(lab))
2279 l.append('<option %svalue="%s">%s</option>'%(s, optionid,
2280 lab))
2281 l.append('</select>')
2282 return '\n'.join(l)
2284 # set the propclasses for HTMLItem
2285 propclasses = (
2286 (hyperdb.String, StringHTMLProperty),
2287 (hyperdb.Number, NumberHTMLProperty),
2288 (hyperdb.Boolean, BooleanHTMLProperty),
2289 (hyperdb.Date, DateHTMLProperty),
2290 (hyperdb.Interval, IntervalHTMLProperty),
2291 (hyperdb.Password, PasswordHTMLProperty),
2292 (hyperdb.Link, LinkHTMLProperty),
2293 (hyperdb.Multilink, MultilinkHTMLProperty),
2294 )
2296 def make_sort_function(db, classname, sort_on=None):
2297 """Make a sort function for a given class
2298 """
2299 linkcl = db.getclass(classname)
2300 if sort_on is None:
2301 sort_on = linkcl.orderprop()
2302 def sortfunc(a, b):
2303 return cmp(linkcl.get(a, sort_on), linkcl.get(b, sort_on))
2304 return sortfunc
2306 def handleListCGIValue(value):
2307 """ Value is either a single item or a list of items. Each item has a
2308 .value that we're actually interested in.
2309 """
2310 if isinstance(value, type([])):
2311 return [value.value for value in value]
2312 else:
2313 value = value.value.strip()
2314 if not value:
2315 return []
2316 return [v.strip() for v in value.split(',')]
2318 class HTMLRequest(HTMLInputMixin):
2319 """The *request*, holding the CGI form and environment.
2321 - "form" the CGI form as a cgi.FieldStorage
2322 - "env" the CGI environment variables
2323 - "base" the base URL for this instance
2324 - "user" a HTMLItem instance for this user
2325 - "language" as determined by the browser or config
2326 - "classname" the current classname (possibly None)
2327 - "template" the current template (suffix, also possibly None)
2329 Index args:
2331 - "columns" dictionary of the columns to display in an index page
2332 - "show" a convenience access to columns - request/show/colname will
2333 be true if the columns should be displayed, false otherwise
2334 - "sort" index sort column (direction, column name)
2335 - "group" index grouping property (direction, column name)
2336 - "filter" properties to filter the index on
2337 - "filterspec" values to filter the index on
2338 - "search_text" text to perform a full-text search on for an index
2339 """
2340 def __repr__(self):
2341 return '<HTMLRequest %r>'%self.__dict__
2343 def __init__(self, client):
2344 # _client is needed by HTMLInputMixin
2345 self._client = self.client = client
2347 # easier access vars
2348 self.form = client.form
2349 self.env = client.env
2350 self.base = client.base
2351 self.user = HTMLItem(client, 'user', client.userid)
2352 self.language = client.language
2354 # store the current class name and action
2355 self.classname = client.classname
2356 self.nodeid = client.nodeid
2357 self.template = client.template
2359 # the special char to use for special vars
2360 self.special_char = '@'
2362 HTMLInputMixin.__init__(self)
2364 self._post_init()
2366 def current_url(self):
2367 url = self.base
2368 if self.classname:
2369 url += self.classname
2370 if self.nodeid:
2371 url += self.nodeid
2372 args = {}
2373 if self.template:
2374 args['@template'] = self.template
2375 return self.indexargs_url(url, args)
2377 def _parse_sort(self, var, name):
2378 """ Parse sort/group options. Append to var
2379 """
2380 fields = []
2381 dirs = []
2382 for special in '@:':
2383 idx = 0
2384 key = '%s%s%d'%(special, name, idx)
2385 while key in self.form:
2386 self.special_char = special
2387 fields.append(self.form.getfirst(key))
2388 dirkey = '%s%sdir%d'%(special, name, idx)
2389 if dirkey in self.form:
2390 dirs.append(self.form.getfirst(dirkey))
2391 else:
2392 dirs.append(None)
2393 idx += 1
2394 key = '%s%s%d'%(special, name, idx)
2395 # backward compatible (and query) URL format
2396 key = special + name
2397 dirkey = key + 'dir'
2398 if key in self.form and not fields:
2399 fields = handleListCGIValue(self.form[key])
2400 if dirkey in self.form:
2401 dirs.append(self.form.getfirst(dirkey))
2402 if fields: # only try other special char if nothing found
2403 break
2404 for f, d in map(None, fields, dirs):
2405 if f.startswith('-'):
2406 var.append(('-', f[1:]))
2407 elif d:
2408 var.append(('-', f))
2409 else:
2410 var.append(('+', f))
2412 def _post_init(self):
2413 """ Set attributes based on self.form
2414 """
2415 # extract the index display information from the form
2416 self.columns = []
2417 for name in ':columns @columns'.split():
2418 if self.form.has_key(name):
2419 self.special_char = name[0]
2420 self.columns = handleListCGIValue(self.form[name])
2421 break
2422 self.show = support.TruthDict(self.columns)
2424 # sorting and grouping
2425 self.sort = []
2426 self.group = []
2427 self._parse_sort(self.sort, 'sort')
2428 self._parse_sort(self.group, 'group')
2430 # filtering
2431 self.filter = []
2432 for name in ':filter @filter'.split():
2433 if self.form.has_key(name):
2434 self.special_char = name[0]
2435 self.filter = handleListCGIValue(self.form[name])
2437 self.filterspec = {}
2438 db = self.client.db
2439 if self.classname is not None:
2440 cls = db.getclass (self.classname)
2441 for name in self.filter:
2442 if not self.form.has_key(name):
2443 continue
2444 prop = cls.get_transitive_prop (name)
2445 fv = self.form[name]
2446 if (isinstance(prop, hyperdb.Link) or
2447 isinstance(prop, hyperdb.Multilink)):
2448 self.filterspec[name] = lookupIds(db, prop,
2449 handleListCGIValue(fv))
2450 else:
2451 if isinstance(fv, type([])):
2452 self.filterspec[name] = [v.value for v in fv]
2453 elif name == 'id':
2454 # special case "id" property
2455 self.filterspec[name] = handleListCGIValue(fv)
2456 else:
2457 self.filterspec[name] = fv.value
2459 # full-text search argument
2460 self.search_text = None
2461 for name in ':search_text @search_text'.split():
2462 if self.form.has_key(name):
2463 self.special_char = name[0]
2464 self.search_text = self.form.getfirst(name)
2466 # pagination - size and start index
2467 # figure batch args
2468 self.pagesize = 50
2469 for name in ':pagesize @pagesize'.split():
2470 if self.form.has_key(name):
2471 self.special_char = name[0]
2472 try:
2473 self.pagesize = int(self.form.getfirst(name))
2474 except ValueError:
2475 # not an integer - ignore
2476 pass
2478 self.startwith = 0
2479 for name in ':startwith @startwith'.split():
2480 if self.form.has_key(name):
2481 self.special_char = name[0]
2482 try:
2483 self.startwith = int(self.form.getfirst(name))
2484 except ValueError:
2485 # not an integer - ignore
2486 pass
2488 # dispname
2489 if self.form.has_key('@dispname'):
2490 self.dispname = self.form.getfirst('@dispname')
2491 else:
2492 self.dispname = None
2494 def updateFromURL(self, url):
2495 """ Parse the URL for query args, and update my attributes using the
2496 values.
2497 """
2498 env = {'QUERY_STRING': url}
2499 self.form = cgi.FieldStorage(environ=env)
2501 self._post_init()
2503 def update(self, kwargs):
2504 """ Update my attributes using the keyword args
2505 """
2506 self.__dict__.update(kwargs)
2507 if kwargs.has_key('columns'):
2508 self.show = support.TruthDict(self.columns)
2510 def description(self):
2511 """ Return a description of the request - handle for the page title.
2512 """
2513 s = [self.client.db.config.TRACKER_NAME]
2514 if self.classname:
2515 if self.client.nodeid:
2516 s.append('- %s%s'%(self.classname, self.client.nodeid))
2517 else:
2518 if self.template == 'item':
2519 s.append('- new %s'%self.classname)
2520 elif self.template == 'index':
2521 s.append('- %s index'%self.classname)
2522 else:
2523 s.append('- %s %s'%(self.classname, self.template))
2524 else:
2525 s.append('- home')
2526 return ' '.join(s)
2528 def __str__(self):
2529 d = {}
2530 d.update(self.__dict__)
2531 f = ''
2532 for k in self.form.keys():
2533 f += '\n %r=%r'%(k,handleListCGIValue(self.form[k]))
2534 d['form'] = f
2535 e = ''
2536 for k,v in self.env.items():
2537 e += '\n %r=%r'%(k, v)
2538 d['env'] = e
2539 return """
2540 form: %(form)s
2541 base: %(base)r
2542 classname: %(classname)r
2543 template: %(template)r
2544 columns: %(columns)r
2545 sort: %(sort)r
2546 group: %(group)r
2547 filter: %(filter)r
2548 search_text: %(search_text)r
2549 pagesize: %(pagesize)r
2550 startwith: %(startwith)r
2551 env: %(env)s
2552 """%d
2554 def indexargs_form(self, columns=1, sort=1, group=1, filter=1,
2555 filterspec=1, search_text=1):
2556 """ return the current index args as form elements """
2557 l = []
2558 sc = self.special_char
2559 def add(k, v):
2560 l.append(self.input(type="hidden", name=k, value=v))
2561 if columns and self.columns:
2562 add(sc+'columns', ','.join(self.columns))
2563 if sort:
2564 val = []
2565 for dir, attr in self.sort:
2566 if dir == '-':
2567 val.append('-'+attr)
2568 else:
2569 val.append(attr)
2570 add(sc+'sort', ','.join (val))
2571 if group:
2572 val = []
2573 for dir, attr in self.group:
2574 if dir == '-':
2575 val.append('-'+attr)
2576 else:
2577 val.append(attr)
2578 add(sc+'group', ','.join (val))
2579 if filter and self.filter:
2580 add(sc+'filter', ','.join(self.filter))
2581 if self.classname and filterspec:
2582 cls = self.client.db.getclass(self.classname)
2583 for k,v in self.filterspec.items():
2584 if type(v) == type([]):
2585 if isinstance(cls.get_transitive_prop(k), hyperdb.String):
2586 add(k, ' '.join(v))
2587 else:
2588 add(k, ','.join(v))
2589 else:
2590 add(k, v)
2591 if search_text and self.search_text:
2592 add(sc+'search_text', self.search_text)
2593 add(sc+'pagesize', self.pagesize)
2594 add(sc+'startwith', self.startwith)
2595 return '\n'.join(l)
2597 def indexargs_url(self, url, args):
2598 """ Embed the current index args in a URL
2599 """
2600 q = urllib.quote
2601 sc = self.special_char
2602 l = ['%s=%s'%(k,v) for k,v in args.items()]
2604 # pull out the special values (prefixed by @ or :)
2605 specials = {}
2606 for key in args.keys():
2607 if key[0] in '@:':
2608 specials[key[1:]] = args[key]
2610 # ok, now handle the specials we received in the request
2611 if self.columns and not specials.has_key('columns'):
2612 l.append(sc+'columns=%s'%(','.join(self.columns)))
2613 if self.sort and not specials.has_key('sort'):
2614 val = []
2615 for dir, attr in self.sort:
2616 if dir == '-':
2617 val.append('-'+attr)
2618 else:
2619 val.append(attr)
2620 l.append(sc+'sort=%s'%(','.join(val)))
2621 if self.group and not specials.has_key('group'):
2622 val = []
2623 for dir, attr in self.group:
2624 if dir == '-':
2625 val.append('-'+attr)
2626 else:
2627 val.append(attr)
2628 l.append(sc+'group=%s'%(','.join(val)))
2629 if self.filter and not specials.has_key('filter'):
2630 l.append(sc+'filter=%s'%(','.join(self.filter)))
2631 if self.search_text and not specials.has_key('search_text'):
2632 l.append(sc+'search_text=%s'%q(self.search_text))
2633 if not specials.has_key('pagesize'):
2634 l.append(sc+'pagesize=%s'%self.pagesize)
2635 if not specials.has_key('startwith'):
2636 l.append(sc+'startwith=%s'%self.startwith)
2638 # finally, the remainder of the filter args in the request
2639 if self.classname and self.filterspec:
2640 cls = self.client.db.getclass(self.classname)
2641 for k,v in self.filterspec.items():
2642 if not args.has_key(k):
2643 if type(v) == type([]):
2644 prop = cls.get_transitive_prop(k)
2645 if k != 'id' and isinstance(prop, hyperdb.String):
2646 l.append('%s=%s'%(k, '%20'.join([q(i) for i in v])))
2647 else:
2648 l.append('%s=%s'%(k, ','.join([q(i) for i in v])))
2649 else:
2650 l.append('%s=%s'%(k, q(v)))
2651 return '%s?%s'%(url, '&'.join(l))
2652 indexargs_href = indexargs_url
2654 def base_javascript(self):
2655 return """
2656 <script type="text/javascript">
2657 submitted = false;
2658 function submit_once() {
2659 if (submitted) {
2660 alert("Your request is being processed.\\nPlease be patient.");
2661 event.returnValue = 0; // work-around for IE
2662 return 0;
2663 }
2664 submitted = true;
2665 return 1;
2666 }
2668 function help_window(helpurl, width, height) {
2669 HelpWin = window.open('%s' + helpurl, 'RoundupHelpWindow', 'scrollbars=yes,resizable=yes,toolbar=no,height='+height+',width='+width);
2670 }
2671 </script>
2672 """%self.base
2674 def batch(self):
2675 """ Return a batch object for results from the "current search"
2676 """
2677 check = self._client.db.security.hasPermission
2678 userid = self._client.userid
2679 if not check('Web Access', userid):
2680 return Batch(self.client, [], self.pagesize, self.startwith,
2681 classname=self.classname)
2683 filterspec = self.filterspec
2684 sort = self.sort
2685 group = self.group
2687 # get the list of ids we're batching over
2688 klass = self.client.db.getclass(self.classname)
2689 if self.search_text:
2690 matches = self.client.db.indexer.search(
2691 [w.upper().encode("utf-8", "replace") for w in re.findall(
2692 r'(?u)\b\w{2,25}\b',
2693 unicode(self.search_text, "utf-8", "replace")
2694 )], klass)
2695 else:
2696 matches = None
2698 # filter for visibility
2699 l = [id for id in klass.filter(matches, filterspec, sort, group)
2700 if check('View', userid, self.classname, itemid=id)]
2702 # return the batch object, using IDs only
2703 return Batch(self.client, l, self.pagesize, self.startwith,
2704 classname=self.classname)
2706 # extend the standard ZTUtils Batch object to remove dependency on
2707 # Acquisition and add a couple of useful methods
2708 class Batch(ZTUtils.Batch):
2709 """ Use me to turn a list of items, or item ids of a given class, into a
2710 series of batches.
2712 ========= ========================================================
2713 Parameter Usage
2714 ========= ========================================================
2715 sequence a list of HTMLItems or item ids
2716 classname if sequence is a list of ids, this is the class of item
2717 size how big to make the sequence.
2718 start where to start (0-indexed) in the sequence.
2719 end where to end (0-indexed) in the sequence.
2720 orphan if the next batch would contain less items than this
2721 value, then it is combined with this batch
2722 overlap the number of items shared between adjacent batches
2723 ========= ========================================================
2725 Attributes: Note that the "start" attribute, unlike the
2726 argument, is a 1-based index (I know, lame). "first" is the
2727 0-based index. "length" is the actual number of elements in
2728 the batch.
2730 "sequence_length" is the length of the original, unbatched, sequence.
2731 """
2732 def __init__(self, client, sequence, size, start, end=0, orphan=0,
2733 overlap=0, classname=None):
2734 self.client = client
2735 self.last_index = self.last_item = None
2736 self.current_item = None
2737 self.classname = classname
2738 self.sequence_length = len(sequence)
2739 ZTUtils.Batch.__init__(self, sequence, size, start, end, orphan,
2740 overlap)
2742 # overwrite so we can late-instantiate the HTMLItem instance
2743 def __getitem__(self, index):
2744 if index < 0:
2745 if index + self.end < self.first: raise IndexError, index
2746 return self._sequence[index + self.end]
2748 if index >= self.length:
2749 raise IndexError, index
2751 # move the last_item along - but only if the fetched index changes
2752 # (for some reason, index 0 is fetched twice)
2753 if index != self.last_index:
2754 self.last_item = self.current_item
2755 self.last_index = index
2757 item = self._sequence[index + self.first]
2758 if self.classname:
2759 # map the item ids to instances
2760 item = HTMLItem(self.client, self.classname, item)
2761 self.current_item = item
2762 return item
2764 def propchanged(self, *properties):
2765 """ Detect if one of the properties marked as being a group
2766 property changed in the last iteration fetch
2767 """
2768 # we poke directly at the _value here since MissingValue can screw
2769 # us up and cause Nones to compare strangely
2770 if self.last_item is None:
2771 return 1
2772 for property in properties:
2773 if property == 'id' or isinstance (self.last_item[property], list):
2774 if (str(self.last_item[property]) !=
2775 str(self.current_item[property])):
2776 return 1
2777 else:
2778 if (self.last_item[property]._value !=
2779 self.current_item[property]._value):
2780 return 1
2781 return 0
2783 # override these 'cos we don't have access to acquisition
2784 def previous(self):
2785 if self.start == 1:
2786 return None
2787 return Batch(self.client, self._sequence, self._size,
2788 self.first - self._size + self.overlap, 0, self.orphan,
2789 self.overlap)
2791 def next(self):
2792 try:
2793 self._sequence[self.end]
2794 except IndexError:
2795 return None
2796 return Batch(self.client, self._sequence, self._size,
2797 self.end - self.overlap, 0, self.orphan, self.overlap)
2799 class TemplatingUtils:
2800 """ Utilities for templating
2801 """
2802 def __init__(self, client):
2803 self.client = client
2804 def Batch(self, sequence, size, start, end=0, orphan=0, overlap=0):
2805 return Batch(self.client, sequence, size, start, end, orphan,
2806 overlap)
2808 def url_quote(self, url):
2809 """URL-quote the supplied text."""
2810 return urllib.quote(url)
2812 def html_quote(self, html):
2813 """HTML-quote the supplied text."""
2814 return cgi.escape(html)
2816 def __getattr__(self, name):
2817 """Try the tracker's templating_utils."""
2818 if not hasattr(self.client.instance, 'templating_utils'):
2819 # backwards-compatibility
2820 raise AttributeError, name
2821 if not self.client.instance.templating_utils.has_key(name):
2822 raise AttributeError, name
2823 return self.client.instance.templating_utils[name]
2825 def html_calendar(self, request):
2826 """Generate a HTML calendar.
2828 `request` the roundup.request object
2829 - @template : name of the template
2830 - form : name of the form to store back the date
2831 - property : name of the property of the form to store
2832 back the date
2833 - date : current date
2834 - display : when browsing, specifies year and month
2836 html will simply be a table.
2837 """
2838 tz = request.client.db.getUserTimezone()
2839 current_date = date.Date(".").local(tz)
2840 date_str = request.form.getfirst("date", current_date)
2841 display = request.form.getfirst("display", date_str)
2842 template = request.form.getfirst("@template", "calendar")
2843 form = request.form.getfirst("form")
2844 property = request.form.getfirst("property")
2845 curr_date = date.Date(date_str) # to highlight
2846 display = date.Date(display) # to show
2847 day = display.day
2849 # for navigation
2850 date_prev_month = display + date.Interval("-1m")
2851 date_next_month = display + date.Interval("+1m")
2852 date_prev_year = display + date.Interval("-1y")
2853 date_next_year = display + date.Interval("+1y")
2855 res = []
2857 base_link = "%s?@template=%s&property=%s&form=%s&date=%s" % \
2858 (request.classname, template, property, form, curr_date)
2860 # navigation
2861 # month
2862 res.append('<table class="calendar"><tr><td>')
2863 res.append(' <table width="100%" class="calendar_nav"><tr>')
2864 link = "&display=%s"%date_prev_month
2865 res.append(' <td><a href="%s&display=%s"><</a></td>'%(base_link,
2866 date_prev_month))
2867 res.append(' <td>%s</td>'%calendar.month_name[display.month])
2868 res.append(' <td><a href="%s&display=%s">></a></td>'%(base_link,
2869 date_next_month))
2870 # spacer
2871 res.append(' <td width="100%"></td>')
2872 # year
2873 res.append(' <td><a href="%s&display=%s"><</a></td>'%(base_link,
2874 date_prev_year))
2875 res.append(' <td>%s</td>'%display.year)
2876 res.append(' <td><a href="%s&display=%s">></a></td>'%(base_link,
2877 date_next_year))
2878 res.append(' </tr></table>')
2879 res.append(' </td></tr>')
2881 # the calendar
2882 res.append(' <tr><td><table class="calendar_display">')
2883 res.append(' <tr class="weekdays">')
2884 for day in calendar.weekheader(3).split():
2885 res.append(' <td>%s</td>'%day)
2886 res.append(' </tr>')
2887 for week in calendar.monthcalendar(display.year, display.month):
2888 res.append(' <tr>')
2889 for day in week:
2890 link = "javascript:form[field].value = '%d-%02d-%02d'; " \
2891 "window.close ();"%(display.year, display.month, day)
2892 if (day == curr_date.day and display.month == curr_date.month
2893 and display.year == curr_date.year):
2894 # highlight
2895 style = "today"
2896 else :
2897 style = ""
2898 if day:
2899 res.append(' <td class="%s"><a href="%s">%s</a></td>'%(
2900 style, link, day))
2901 else :
2902 res.append(' <td></td>')
2903 res.append(' </tr>')
2904 res.append('</table></td></tr></table>')
2905 return "\n".join(res)
2907 class MissingValue:
2908 def __init__(self, description, **kwargs):
2909 self.__description = description
2910 for key, value in kwargs.items():
2911 self.__dict__[key] = value
2913 def __call__(self, *args, **kwargs): return MissingValue(self.__description)
2914 def __getattr__(self, name):
2915 # This allows assignments which assume all intermediate steps are Null
2916 # objects if they don't exist yet.
2917 #
2918 # For example (with just 'client' defined):
2919 #
2920 # client.db.config.TRACKER_WEB = 'BASE/'
2921 self.__dict__[name] = MissingValue(self.__description)
2922 return getattr(self, name)
2924 def __getitem__(self, key): return self
2925 def __nonzero__(self): return 0
2926 def __str__(self): return '[%s]'%self.__description
2927 def __repr__(self): return '<MissingValue 0x%x "%s">'%(id(self),
2928 self.__description)
2929 def gettext(self, str): return str
2930 _ = gettext
2932 # vim: set et sts=4 sw=4 :