Mercurial > p > roundup > code

annotate roundup/cgi/templating.py @ 5987:ea3485c67f94

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sort accept keys to make p2 and p3 ordering the same Sort keys of self.__accepted_content_type. Keys returned in different orders in python2/3. Sorting makes testing easier.
author John Rouillard <rouilj@ieee.org>
date Tue, 26 Nov 2019 20:47:34 -0500
parents fe334430ca07
children 39b8bc511ed7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
1 """Implements the API used in the HTML templating for the web interface.
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2 """
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
3
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
4 todo = """
4749
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
5 - Document parameters to Template.render() method
4727
5033c2ad80a7 templating: Rename LoaderBase.get() to LoaderBase.load() for clarity
anatoly techtonik <techtonik@gmail.com>
parents: 4724
diff changeset
6 - Add tests for Loader.load() method
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
7 - Most methods should have a "default" arg to supply a value
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
8 when none appears in the hyperdb or request.
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
9 - Multilink property additions: change_note and new_upload
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
10 - Add class.find() too
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
11 - NumberHTMLProperty should support numeric operations
2324
da4444e593f4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2320
diff changeset
12 - LinkHTMLProperty should handle comparisons to strings (cf. linked name)
2411
7ff0a0306877 another TODO
Richard Jones <richard@users.sourceforge.net>
parents: 2396
diff changeset
13 - HTMLRequest.default(self, sort, group, filter, columns, **filterspec):
3843
97d9368ed485 Yet another emacs syntax highlighting workaround.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3842
diff changeset
14 '''Set the request's view arguments to the given values when no
2411
7ff0a0306877 another TODO
Richard Jones <richard@users.sourceforge.net>
parents: 2396
diff changeset
15 values are found in the CGI environment.
3843
97d9368ed485 Yet another emacs syntax highlighting workaround.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3842
diff changeset
16 '''
2664
8348373b4361 another TODO
Richard Jones <richard@users.sourceforge.net>
parents: 2651
diff changeset
17 - have menu() methods accept filtering arguments
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
18 """
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
19
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
20 __docformat__ = 'restructuredtext'
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
21
1931
f1e5e5115c29 Always sort MultilinkHTMLProperty in the correct order...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1917
diff changeset
22
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
23 import base64, cgi, re, os.path, mimetypes, csv, string
5043
ac0c117cd24c Remove wrap and associated functions from roundup.support
John Kristensen <john@jerrykan.com>
parents: 5006
diff changeset
24 import calendar
ac0c117cd24c Remove wrap and associated functions from roundup.support
John Kristensen <john@jerrykan.com>
parents: 5006
diff changeset
25 import textwrap
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
26 import time, hashlib
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
5837
883c9e90b403 Fix problem with cgi.escape being depricated a different way. This way
John Rouillard <rouilj@ieee.org>
parents: 5809
diff changeset
28 from roundup.anypy.html import html_escape
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
29
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
30 from roundup.anypy import urllib_
3188
7faae85e1e33 merge from branch
Richard Jones <richard@users.sourceforge.net>
parents: 3183
diff changeset
31 from roundup import hyperdb, date, support
2377
a53f87f2488a StaticTranslationService moved here out of the code originating from Zope;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2347
diff changeset
32 from roundup import i18n
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 from roundup.i18n import _
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
34 from roundup.anypy.strings import is_us, b2s, s2b, us2s, s2u, u2s, StringIO
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35
5388
d26921b851c3 Python 3 preparation: make relative imports explicit.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5381
diff changeset
36 from .KeywordsExpr import render_keywords_expression_editor
4466
f1fe6fd0aa61 Multilinks can be filtered by combining elements with AND, OR and NOT now.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4463
diff changeset
37
5973
fe334430ca07 issue2550919 - Anti-bot signup using 4 second delay
John Rouillard <rouilj@ieee.org>
parents: 5947
diff changeset
38 from roundup.cgi.timestamp import pack_timestamp
fe334430ca07 issue2550919 - Anti-bot signup using 4 second delay
John Rouillard <rouilj@ieee.org>
parents: 5947
diff changeset
39
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
40 import roundup.anypy.random_ as random_
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
41 try:
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
42 import cPickle as pickle
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
43 except ImportError:
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
44 import pickle
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
45 try:
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
46 from StructuredText.StructuredText import HTML as StructuredText
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 except ImportError:
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
48 try: # older version
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
49 import StructuredText
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
50 except ImportError:
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
51 StructuredText = None
3862
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
52 try:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
53 from docutils.core import publish_parts as ReStructuredText
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
54 except ImportError:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
55 ReStructuredText = None
5399
dccae35caa59 Python 3 preparation: update map() calls as needed.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5395
diff changeset
56 try:
dccae35caa59 Python 3 preparation: update map() calls as needed.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5395
diff changeset
57 from itertools import zip_longest
dccae35caa59 Python 3 preparation: update map() calls as needed.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5395
diff changeset
58 except ImportError:
dccae35caa59 Python 3 preparation: update map() calls as needed.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5395
diff changeset
59 from itertools import izip_longest as zip_longest
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1041
diff changeset
61 # bring in the templating support
2558
cf52ad6788c8 TranslationService definitions moved to separate module;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2547
diff changeset
62 from roundup.cgi import TranslationService, ZTUtils
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63
2377
a53f87f2488a StaticTranslationService moved here out of the code originating from Zope;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2347
diff changeset
64 ### i18n services
2558
cf52ad6788c8 TranslationService definitions moved to separate module;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2547
diff changeset
65 # this global translation service is not thread-safe.
cf52ad6788c8 TranslationService definitions moved to separate module;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2547
diff changeset
66 # it is left here for backward compatibility
cf52ad6788c8 TranslationService definitions moved to separate module;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2547
diff changeset
67 # until all Web UI translations are done via client.translator object
cf52ad6788c8 TranslationService definitions moved to separate module;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2547
diff changeset
68 translationService = TranslationService.get_translation()
2377
a53f87f2488a StaticTranslationService moved here out of the code originating from Zope;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2347
diff changeset
69
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
70 def anti_csrf_nonce(client, lifetime=None):
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
71 ''' Create a nonce for defending against CSRF attack.
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
72
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
73 Then it stores the nonce, the session id for the user
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
74 and the user id in the one time key database for use
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
75 by the csrf validator that runs in the client::inner_main
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
76 module/function.
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
77 '''
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
78 otks=client.db.getOTKManager()
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
79 key = b2s(base64.b32encode(random_.token_bytes(40)))
5202
47bd81998ddc My testing was with dbm backends which do an automatic commit on the
John Rouillard <rouilj@ieee.org>
parents: 5201
diff changeset
80
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
81 while otks.exists(key):
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
82 key = b2s(base64.b32encode(random_.token_bytes(40)))
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
83
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
84 # lifetime is in minutes.
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
85 if lifetime is None:
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
86 lifetime = client.db.config['WEB_CSRF_TOKEN_LIFETIME']
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
87
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
88 # offset to time.time is calculated as:
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
89 # default lifetime is 1 week after __timestamp.
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
90 # That's the cleanup period hardcoded in otk.clean().
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
91 # If a user wants a 10 minute lifetime calculate
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
92 # 10 minutes newer than 1 week ago.
5211
f4b6a2a3e605 Fix expiration dates and expire csrf tokens properly
John Rouillard <rouilj@ieee.org>
parents: 5202
diff changeset
93 # lifetime - 10080 (number of minutes in a week)
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
94 # convert to seconds and add (possible negative number)
5211
f4b6a2a3e605 Fix expiration dates and expire csrf tokens properly
John Rouillard <rouilj@ieee.org>
parents: 5202
diff changeset
95 # to current time (time.time()).
f4b6a2a3e605 Fix expiration dates and expire csrf tokens properly
John Rouillard <rouilj@ieee.org>
parents: 5202
diff changeset
96 ts = time.time() + ((lifetime - 10080) * 60)
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
97 otks.set(key, uid=client.db.getuid(),
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
98 sid=client.session_api._sid,
5211
f4b6a2a3e605 Fix expiration dates and expire csrf tokens properly
John Rouillard <rouilj@ieee.org>
parents: 5202
diff changeset
99 __timestamp=ts )
5319
62de601bdf6f Fix commits although a Reject exception is raised
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5264
diff changeset
100 otks.commit()
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
101 return key
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
102
2377
a53f87f2488a StaticTranslationService moved here out of the code originating from Zope;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2347
diff changeset
103 ### templating
a53f87f2488a StaticTranslationService moved here out of the code originating from Zope;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2347
diff changeset
104
5264
32f95ec6bd8e Python 2 and 3 support. Convert Exception into BaseException in core code.
John Rouillard <rouilj@ieee.org>
parents: 5248
diff changeset
105 class NoTemplate(BaseException):
1068
665730c27d29 nicer template absence error
Richard Jones <richard@users.sourceforge.net>
parents: 1067
diff changeset
106 pass
665730c27d29 nicer template absence error
Richard Jones <richard@users.sourceforge.net>
parents: 1067
diff changeset
107
5264
32f95ec6bd8e Python 2 and 3 support. Convert Exception into BaseException in core code.
John Rouillard <rouilj@ieee.org>
parents: 5248
diff changeset
108 class Unauthorised(BaseException):
2466
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
109 def __init__(self, action, klass, translator=None):
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
110 self.action = action
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
111 self.klass = klass
2466
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
112 if translator:
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
113 self._ = translator.gettext
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
114 else:
2561
0dd3dca6bd01 always use translation service set in the tracker client instance;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2558
diff changeset
115 self._ = TranslationService.get_translation().gettext
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
116 def __str__(self):
2466
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
117 return self._('You are not allowed to %(action)s '
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
118 'items of class %(class)s') % {
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
119 'action': self.action, 'class': self.klass}
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
120
4747
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
121
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
122 # --- Template Loader API
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
123
4719
05fe39f1d823 API break, bumping version to 1.15.0, renamed TemplatesBase to
anatoly techtonik <techtonik@gmail.com>
parents: 4696
diff changeset
124 class LoaderBase:
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
125 """ Base for engine-specific template Loader class."""
4743
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
126 def __init__(self, dir):
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
127 # loaders are given the template directory as a first argument
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
128 pass
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
129
4748
e339583eae8e templating: rename precompileTemplates to precompile
anatoly techtonik <techtonik@gmail.com>
parents: 4747
diff changeset
130 def precompile(self):
e339583eae8e templating: rename precompileTemplates to precompile
anatoly techtonik <techtonik@gmail.com>
parents: 4747
diff changeset
131 """ This method may be called when tracker is loaded to precompile
e339583eae8e templating: rename precompileTemplates to precompile
anatoly techtonik <techtonik@gmail.com>
parents: 4747
diff changeset
132 templates that support this ability.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
133 """
4749
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
134 pass
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
135
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
136 def load(self, tplname):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
137 """ Load template and return template object with render() method.
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
138
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
139 "tplname" is a template name. For filesystem loaders it is a
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
140 filename without extensions, typically in the "classname.view"
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
141 format.
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
142 """
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
143 raise NotImplementedError
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
144
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
145 def check(self, name):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
146 """ Check if template with the given name exists. Should return
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
147 false if template can not be found.
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
148 """
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
149 raise NotImplementedError
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
150
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
151 class TALLoaderBase(LoaderBase):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
152 """ Common methods for the legacy TAL loaders."""
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
153
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
154 def __init__(self, dir):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
155 self.dir = dir
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
156
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
157 def _find(self, name):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
158 """ Find template, return full path and filename of the
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
159 template if it is found, None otherwise."""
5145
d22eb1d40d0e issue2550701, issue2550891 deal with path traversal issue in TAL based template finding code. Use standard method.
John Rouillard <rouilj@ieee.org>
parents: 5112
diff changeset
160 realsrc = os.path.realpath(self.dir)
4749
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
161 for extension in ['', '.html', '.xml']:
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
162 f = name + extension
5145
d22eb1d40d0e issue2550701, issue2550891 deal with path traversal issue in TAL based template finding code. Use standard method.
John Rouillard <rouilj@ieee.org>
parents: 5112
diff changeset
163 src = os.path.join(realsrc, f)
d22eb1d40d0e issue2550701, issue2550891 deal with path traversal issue in TAL based template finding code. Use standard method.
John Rouillard <rouilj@ieee.org>
parents: 5112
diff changeset
164 realpath = os.path.realpath(src)
5423
58057ea53779 Python 3 preparation: avoid string.find.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
165 if not realpath.startswith(realsrc):
5145
d22eb1d40d0e issue2550701, issue2550891 deal with path traversal issue in TAL based template finding code. Use standard method.
John Rouillard <rouilj@ieee.org>
parents: 5112
diff changeset
166 return # will raise invalid template
4749
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
167 if os.path.exists(src):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
168 return (src, f)
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
169
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
170 def check(self, name):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
171 return bool(self._find(name))
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
172
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
173 def precompile(self):
0421390b3094 templating: Move common TAL methods to TALLoaderBase class
anatoly techtonik <techtonik@gmail.com>
parents: 4748
diff changeset
174 """ Precompile templates in load directory by loading them """
1204
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
175 for filename in os.listdir(self.dir):
2854
6acc315570eb Templates.precompileTemplates: skip files without ".html" extension
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2827
diff changeset
176 # skip subdirs
6acc315570eb Templates.precompileTemplates: skip files without ".html" extension
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2827
diff changeset
177 if os.path.isdir(filename):
6acc315570eb Templates.precompileTemplates: skip files without ".html" extension
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2827
diff changeset
178 continue
2961
Richard Jones <richard@users.sourceforge.net>
parents: 2959
diff changeset
179
2959
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
180 # skip files without ".html" or ".xml" extension - .css, .js etc.
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
181 for extension in '.html', '.xml':
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
182 if filename.endswith(extension):
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
183 break
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
184 else:
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
185 continue
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
186
2961
Richard Jones <richard@users.sourceforge.net>
parents: 2959
diff changeset
187 # remove extension
2959
fa5410ae581d allow use of XML templates again
Richard Jones <richard@users.sourceforge.net>
parents: 2956
diff changeset
188 filename = filename[:-len(extension)]
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
189 self.load(filename)
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
190
1204
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
191 def __getitem__(self, name):
4724
98b727b6f7f8 Self-focument API in templating.py loader class
anatoly techtonik <techtonik@gmail.com>
parents: 4721
diff changeset
192 """Special method to access templates by loader['name']"""
1204
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
193 try:
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
194 return self.load(name)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5232
diff changeset
195 except NoTemplate as message:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
196 raise KeyError(message)
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
197
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
198 class MultiLoader(LoaderBase):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
199 def __init__(self):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
200 self.loaders = []
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
201
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
202 def add_loader(self, loader):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
203 self.loaders.append(loader)
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
204
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
205 def check(self, name):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
206 for l in self.loaders:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
207 if l.check(name):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
208 return True
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
209
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
210 def load(self, name):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
211 for l in self.loaders:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
212 if l.check(name):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
213 return l.load(name)
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
214
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
215 def __getitem__(self, name):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
216 """Needed for TAL templates compatibility"""
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
217 # [ ] document root and helper templates
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
218 try:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
219 return self.load(name)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5232
diff changeset
220 except NoTemplate as message:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
221 raise KeyError(message)
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
222
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
223
4743
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
224 class TemplateBase:
2d6959f1d2df templating: proof of concept for Jinja2 support. Select 'jinja2'
anatoly techtonik <techtonik@gmail.com>
parents: 4742
diff changeset
225 content_type = 'text/html'
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
226
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
227
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
228 def get_loader(dir, template_engine):
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
229
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
230 # Support for multiple engines using fallback mechanizm
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
231 # meaning that if first engine can't find template, we
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
232 # use the second
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
233
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
234 engines = template_engine.split(',')
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
235 engines = [x.strip() for x in engines]
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
236 ml = MultiLoader()
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
237
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
238 for engine_name in engines:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
239 if engine_name == 'chameleon':
5388
d26921b851c3 Python 3 preparation: make relative imports explicit.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5381
diff changeset
240 from .engine_chameleon import Loader
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
241 elif engine_name == 'jinja2':
5388
d26921b851c3 Python 3 preparation: make relative imports explicit.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5381
diff changeset
242 from .engine_jinja2 import Jinja2Loader as Loader
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
243 elif engine_name == 'zopetal':
5388
d26921b851c3 Python 3 preparation: make relative imports explicit.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5381
diff changeset
244 from .engine_zopetal import Loader
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
245 else:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
246 raise Exception('Unknown template engine "%s"' % engine_name)
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
247 ml.add_loader(Loader(dir))
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
248
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
249 if len(engines) == 1:
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
250 return ml.loaders[0]
4747
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
251 else:
4750
12b029655c05 Templating proof of concept to use multiple engines simultaneously,
anatoly techtonik <techtonik@gmail.com>
parents: 4749
diff changeset
252 return ml
4587
a2eb4fb3e6d8 New Chameleon templating engine, engine is now configurable.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4584
diff changeset
253
4747
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
254 # --/ Template Loader API
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
255
955860a18e12 templating: Raise exception if configured template engine is unknown
anatoly techtonik <techtonik@gmail.com>
parents: 4743
diff changeset
256
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
257 def context(client, template=None, classname=None, request=None):
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
258 """Return the rendering context dictionary
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
259
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
260 The dictionary includes following symbols:
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
261
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
262 *context*
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
263 this is one of three things:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
264
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
265 1. None - we're viewing a "home" page
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
266 2. The current class of item being displayed. This is an HTMLClass
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
267 instance.
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
268 3. The current item from the database, if we're viewing a specific
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
269 item, as an HTMLItem instance.
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
270
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
271 *request*
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
272 Includes information about the current request, including:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
273
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
274 - the url
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
275 - the current index information (``filterspec``, ``filter`` args,
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
276 ``properties``, etc) parsed out of the form.
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
277 - methods for easy filterspec link generation
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
278 - *user*, the current user node as an HTMLItem instance
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
279 - *form*, the current CGI form information as a FieldStorage
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
280
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
281 *config*
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
282 The current tracker config.
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
283
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
284 *db*
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
285 The current database, used to access arbitrary database items.
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
286
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
287 *utils*
4584
760483ce731e Fix override of TemplatingUtils in instance.py.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4577
diff changeset
288 This is an instance of client.instance.TemplatingUtils, which is
760483ce731e Fix override of TemplatingUtils in instance.py.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4577
diff changeset
289 optionally defined in the tracker interfaces module and defaults to
760483ce731e Fix override of TemplatingUtils in instance.py.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4577
diff changeset
290 TemplatingUtils class in this file.
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
291
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
292 *templates*
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
293 Access to all the tracker templates by name.
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
294 Used mainly in *use-macro* commands.
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
295
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
296 *template*
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
297 Current rendering template.
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
298
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
299 *true*
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
300 Logical True value.
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
301
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
302 *false*
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
303 Logical False value.
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
304
2562
1f4791438b65 add 'i18n' to the rendering context dictionary description
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2561
diff changeset
305 *i18n*
1f4791438b65 add 'i18n' to the rendering context dictionary description
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2561
diff changeset
306 Internationalization service, providing string translation
1f4791438b65 add 'i18n' to the rendering context dictionary description
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2561
diff changeset
307 methods ``gettext`` and ``ngettext``.
1f4791438b65 add 'i18n' to the rendering context dictionary description
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2561
diff changeset
308
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
309 """
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
310
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
311 # if template, classname and/or request are not passed explicitely,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
312 # compute form client
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
313 if template is None:
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
314 template = client.template
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
315 if classname is None:
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
316 classname = client.classname
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
317 if request is None:
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
318 request = HTMLRequest(client)
1270
c3424abf7f77 added ability to implement new templating utility methods
Richard Jones <richard@users.sourceforge.net>
parents: 1263
diff changeset
319
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
320 c = {
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
321 'context': None,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
322 'options': {},
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
323 'nothing': None,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
324 'request': request,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
325 'db': HTMLDatabase(client),
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
326 'config': client.instance.config,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
327 'tracker': client.instance,
4584
760483ce731e Fix override of TemplatingUtils in instance.py.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4577
diff changeset
328 'utils': client.instance.TemplatingUtils(client),
2854
6acc315570eb Templates.precompileTemplates: skip files without ".html" extension
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2827
diff changeset
329 'templates': client.instance.templates,
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
330 'template': template,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
331 'true': 1,
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
332 'false': 0,
2538
09b0fc5b1716 make client.translator available to templates as 'i18n'
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2524
diff changeset
333 'i18n': client.translator
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
334 }
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
335 # add in the item if there is one
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
336 if client.nodeid:
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
337 c['context'] = HTMLItem(client, classname, client.nodeid,
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
338 anonymous=1)
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
339 elif classname in client.db.classes:
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
340 c['context'] = HTMLClass(client, classname, anonymous=1)
2390
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
341 return c
0778421414c3 added module function context()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2389
diff changeset
342
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
343 class HTMLDatabase:
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
344 """ Return HTMLClasses for valid class fetches
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
345 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
346 def __init__(self, client):
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
347 self._client = client
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
348 self._ = client._
1513
455f79a2981f add access to real db through HTML db
Richard Jones <richard@users.sourceforge.net>
parents: 1510
diff changeset
349 self._db = client.db
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
350
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
351 # we want config to be exposed
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
352 self.config = client.db.config
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
353
4055
de832c486f86 Fix designator regular expression in HTMLDatabase.__getitem__.
Stefan Seefeld <stefan@seefeld.name>
parents: 4054
diff changeset
354 def __getitem__(self, item, desre=re.compile(r'(?P<cl>[a-zA-Z_]+)(?P<id>[-\d]+)')):
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
355 # check to see if we're actually accessing an item
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
356 m = desre.match(item)
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
357 if m:
2157
e976fa0640b3 db/userN wasn't returning HTMLUser
Richard Jones <richard@users.sourceforge.net>
parents: 2154
diff changeset
358 cl = m.group('cl')
e976fa0640b3 db/userN wasn't returning HTMLUser
Richard Jones <richard@users.sourceforge.net>
parents: 2154
diff changeset
359 self._client.db.getclass(cl)
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
360 return HTMLItem(self._client, cl, m.group('id'))
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
361 else:
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
362 self._client.db.getclass(item)
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
363 return HTMLClass(self._client, item)
1134
16874c9b86ad generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1133
diff changeset
364
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
365 def __getattr__(self, attr):
1030
f5216dbced55 translate bad class lookup error meaningfully
Richard Jones <richard@users.sourceforge.net>
parents: 1028
diff changeset
366 try:
1134
16874c9b86ad generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1133
diff changeset
367 return self[attr]
1030
f5216dbced55 translate bad class lookup error meaningfully
Richard Jones <richard@users.sourceforge.net>
parents: 1028
diff changeset
368 except KeyError:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
369 raise AttributeError(attr)
1134
16874c9b86ad generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1133
diff changeset
370
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
371 def classes(self):
5395
23b8e6067f7c Python 3 preparation: update calls to dict methods.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5388
diff changeset
372 l = sorted(self._client.db.classes.keys())
2118
917826e3fb54 In the classes method of HTMLDatabase, the variable 'm' was undefined.
Brian Kelley <wc2so1@users.sourceforge.net>
parents: 2116
diff changeset
373 m = []
2031
bcb21e5722b8 fix permission handling around rego
Richard Jones <richard@users.sourceforge.net>
parents: 2025
diff changeset
374 for item in l:
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
375 m.append(HTMLClass(self._client, item))
2118
917826e3fb54 In the classes method of HTMLDatabase, the variable 'm' was undefined.
Brian Kelley <wc2so1@users.sourceforge.net>
parents: 2116
diff changeset
376 return m
1104
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
377
5809
936275dfe1fa Try to fix:
John Rouillard <rouilj@ieee.org>
parents: 5800
diff changeset
378 num_re = re.compile(r'^-?\d+$')
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
379
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
380 def lookupIds(db, prop, ids, fail_ok=0, num_re=num_re, do_lookup=True):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
381 """ "fail_ok" should be specified if we wish to pass through bad values
2049
5a5f66e6b0e1 forward-port of fix from maint-0-6
Richard Jones <richard@users.sourceforge.net>
parents: 2037
diff changeset
382 (most likely form values that we wish to represent back to the user)
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
383 "do_lookup" is there for preventing lookup by key-value (if we
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
384 know that the value passed *is* an id)
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
385 """
1104
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
386 cl = db.getclass(prop.classname)
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
387 l = []
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
388 for entry in ids:
5927
a2a7860502fa Fix lookupIds for try_id_parsing off
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5907
diff changeset
389 # Do not look up numeric IDs if try_id_parsing
a2a7860502fa Fix lookupIds for try_id_parsing off
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5907
diff changeset
390 if prop.try_id_parsing and num_re.match(entry):
5876
716d50585c8d Fix Link/Multilink searching
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5837
diff changeset
391 l.append(entry)
716d50585c8d Fix Link/Multilink searching
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5837
diff changeset
392 continue
3861
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
393 if do_lookup:
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
394 try:
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
395 item = cl.lookup(entry)
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
396 except (TypeError, KeyError):
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
397 pass
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
398 else:
d4ac8954ce5c Update on recent fix, better version suggested by alexander smishlajev
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3860
diff changeset
399 l.append(item)
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
400 continue
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
401 # if fail_ok, ignore lookup error
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
402 # otherwise entry must be existing object id rather than key value
5876
716d50585c8d Fix Link/Multilink searching
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5837
diff changeset
403 if fail_ok:
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
404 l.append(entry)
1104
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
405 return l
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
406
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
407 def lookupKeys(linkcl, key, ids, num_re=num_re):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
408 """ Look up the "key" values for "ids" list - though some may already
2083
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
409 be key values, not ids.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
410 """
2083
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
411 l = []
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
412 for entry in ids:
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
413 if num_re.match(entry):
5051
b69c5e763295 issue2550748: Crash when creating new issues with non-existing multilink values (in classic template). Applied patch provided by user. (John Rouillard)
John Rouillard <rouilj@ieee.org>
parents: 5043
diff changeset
414 try:
5193
cfd6d1f2caa1 Fix incorrect indentation using tabs
John Kristensen <john@jerrykan.com>
parents: 5192
diff changeset
415 label = linkcl.get(entry, key)
cfd6d1f2caa1 Fix incorrect indentation using tabs
John Kristensen <john@jerrykan.com>
parents: 5192
diff changeset
416 except IndexError:
cfd6d1f2caa1 Fix incorrect indentation using tabs
John Kristensen <john@jerrykan.com>
parents: 5192
diff changeset
417 # fall back to id if illegal (avoid template crash)
5051
b69c5e763295 issue2550748: Crash when creating new issues with non-existing multilink values (in classic template). Applied patch provided by user. (John Rouillard)
John Rouillard <rouilj@ieee.org>
parents: 5043
diff changeset
418 label = entry
3401
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
419 # fall back to designator if label is None
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
420 if label is None: label = '%s%s'%(linkcl.classname, entry)
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
421 l.append(label)
2083
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
422 else:
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
423 l.append(entry)
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
424 return l
a94eacad51c8 handle bad multilink input at item creation time better [SF#917834]
Richard Jones <richard@users.sourceforge.net>
parents: 2056
diff changeset
425
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
426 def _set_input_default_args(dic):
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
427 # 'text' is the default value anyway --
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
428 # but for CSS usage it should be present
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
429 dic.setdefault('type', 'text')
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
430 # useful e.g for HTML LABELs:
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
431 if 'id' not in dic:
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
432 try:
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
433 if dic['text'] in ('radio', 'checkbox'):
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
434 dic['id'] = '%(name)s-%(value)s' % dic
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
435 else:
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
436 dic['id'] = dic['name']
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
437 except KeyError:
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
438 pass
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
439
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
440 def cgi_escape_attrs(**attrs):
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
441 return ' '.join(['%s="%s"'%(k,html_escape(str(v), True))
5485
b0359a7c5b6d create input elements with attributes in a defined (sorted) order
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5461
diff changeset
442 for k,v in sorted(attrs.items())])
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
443
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
444 def input_html4(**attrs):
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
445 """Generate an 'input' (html4) element with given attributes"""
3909
e89bcb28f683 indexargs_url force ids to int
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3905
diff changeset
446 _set_input_default_args(attrs)
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
447 return '<input %s>'%cgi_escape_attrs(**attrs)
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
448
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
449 def input_xhtml(**attrs):
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
450 """Generate an 'input' (xhtml) element with given attributes"""
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
451 _set_input_default_args(attrs)
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
452 return '<input %s/>'%cgi_escape_attrs(**attrs)
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
453
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
454 class HTMLInputMixin(object):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
455 """ requires a _client property """
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
456 def __init__(self):
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
457 html_version = 'html4'
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
458 if hasattr(self._client.instance.config, 'HTML_VERSION'):
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
459 html_version = self._client.instance.config.HTML_VERSION
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
460 if html_version == 'xhtml':
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
461 self.input = input_xhtml
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
462 else:
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
463 self.input = input_html4
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
464 # self._context is used for translations.
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
465 # will be initialized by the first call to .gettext()
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
466 self._context = None
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
467
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
468 def gettext(self, msgid):
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
469 """Return the localized translation of msgid"""
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
470 if self._context is None:
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
471 self._context = context(self._client)
2561
0dd3dca6bd01 always use translation service set in the tracker client instance;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2558
diff changeset
472 return self._client.translator.translate(domain="roundup",
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
473 msgid=msgid, context=self._context)
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
474
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
475 _ = gettext
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
476
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
477 class HTMLPermissions(object):
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
478
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
479 def view_check(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
480 """ Raise the Unauthorised exception if the user's not permitted to
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
481 view this class.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
482 """
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
483 if not self.is_view_ok():
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
484 raise Unauthorised("view", self._classname,
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
485 translator=self._client.translator)
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
486
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
487 def edit_check(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
488 """ Raise the Unauthorised exception if the user's not permitted to
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
489 edit items of this class.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
490 """
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
491 if not self.is_edit_ok():
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
492 raise Unauthorised("edit", self._classname,
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
493 translator=self._client.translator)
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
494
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
495 def retire_check(self):
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
496 """ Raise the Unauthorised exception if the user's not permitted to
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
497 retire items of this class.
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
498 """
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
499 if not self.is_retire_ok():
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
500 raise Unauthorised("retire", self._classname,
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
501 translator=self._client.translator)
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
502
2983
9614a101b68f Stuff from the train ride this morning:
Richard Jones <richard@users.sourceforge.net>
parents: 2962
diff changeset
503
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
504 class HTMLClass(HTMLInputMixin, HTMLPermissions):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
505 """ Accesses through a class (either through *class* or *db.<classname>*)
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
506 """
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
507 def __init__(self, client, classname, anonymous=0):
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
508 self._client = client
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
509 self._ = client._
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
510 self._db = client.db
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
511 self._anonymous = anonymous
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
512
1136
7e193bbda38e added generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1134
diff changeset
513 # we want classname to be exposed, but _classname gives a
7e193bbda38e added generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1134
diff changeset
514 # consistent API for extending Class/Item
7e193bbda38e added generic item editing
Richard Jones <richard@users.sourceforge.net>
parents: 1134
diff changeset
515 self._classname = self.classname = classname
1204
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
516 self._klass = self._db.getclass(self.classname)
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
517 self._props = self._klass.getprops()
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
518
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
519 HTMLInputMixin.__init__(self)
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
520
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
521 def is_edit_ok(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
522 """ Is the user allowed to Create the current class?
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
523 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
524 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
525 return perm('Web Access', self._client.userid) and perm('Create',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
526 self._client.userid, self._classname)
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
527
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
528 def is_retire_ok(self):
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
529 """ Is the user allowed to retire items of the current class?
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
530 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
531 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
532 return perm('Web Access', self._client.userid) and perm('Retire',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
533 self._client.userid, self._classname)
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
534
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
535 def is_view_ok(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
536 """ Is the user allowed to View the current class?
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
537 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
538 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
539 return perm('Web Access', self._client.userid) and perm('View',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
540 self._client.userid, self._classname)
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
541
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
542 def is_only_view_ok(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
543 """ Is the user only allowed to View (ie. not Create) the current class?
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
544 """
2651
17bab083c8a0 Couple of fixes - make the interface just be is_edit_ok...
Richard Jones <richard@users.sourceforge.net>
parents: 2649
diff changeset
545 return self.is_view_ok() and not self.is_edit_ok()
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
546
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
547 def __repr__(self):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
548 return '<HTMLClass(0x%x) %s>'%(id(self), self.classname)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
549
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
550 def __getitem__(self, item):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
551 """ return an HTMLProperty instance
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
552 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
553
1073
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
554 # we don't exist
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
555 if item == 'id':
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
556 return None
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
557
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
558 # get the property
2056
ba1d54edc53f nicer invalid property error in HTML templating
Richard Jones <richard@users.sourceforge.net>
parents: 2049
diff changeset
559 try:
ba1d54edc53f nicer invalid property error in HTML templating
Richard Jones <richard@users.sourceforge.net>
parents: 2049
diff changeset
560 prop = self._props[item]
ba1d54edc53f nicer invalid property error in HTML templating
Richard Jones <richard@users.sourceforge.net>
parents: 2049
diff changeset
561 except KeyError:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
562 raise KeyError('No such property "%s" on %s'%(item, self.classname))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
563
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
564 # look up the correct HTMLProperty class
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
565 for klass, htmlklass in propclasses:
1104
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
566 if not isinstance(prop, klass):
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
567 continue
4481
9bbf3758c16a Allow default value declaration in DB schema.
Stefan Seefeld <stefan@seefeld.name>
parents: 4466
diff changeset
568 value = prop.get_default_value()
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3770
diff changeset
569 return htmlklass(self._client, self._classname, None, prop, item,
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
570 value, self._anonymous)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
571
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
572 # no good
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
573 raise KeyError(item)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
574
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
575 def __getattr__(self, attr):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
576 """ convenience access """
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
577 try:
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
578 return self[attr]
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
579 except KeyError:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
580 raise AttributeError(attr)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
581
1743
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
582 def designator(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
583 """ Return this class' designator (classname) """
1743
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
584 return self._classname
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
585
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
586 def getItem(self, itemid, num_re=num_re):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
587 """ Get an item of this class by its item id.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
588 """
1200
0a7bd082b94a usability improvements in API
Richard Jones <richard@users.sourceforge.net>
parents: 1183
diff changeset
589 # make sure we're looking at an itemid
2010
1b11ffd8015e forward-porting of fixed edit action / parsePropsFromForm...
Richard Jones <richard@users.sourceforge.net>
parents: 2005
diff changeset
590 if not isinstance(itemid, type(1)) and not num_re.match(itemid):
1200
0a7bd082b94a usability improvements in API
Richard Jones <richard@users.sourceforge.net>
parents: 1183
diff changeset
591 itemid = self._klass.lookup(itemid)
0a7bd082b94a usability improvements in API
Richard Jones <richard@users.sourceforge.net>
parents: 1183
diff changeset
592
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
593 return HTMLItem(self._client, self.classname, itemid)
1200
0a7bd082b94a usability improvements in API
Richard Jones <richard@users.sourceforge.net>
parents: 1183
diff changeset
594
5222
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
595 def properties(self, sort=1, cansearch=True):
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
596 """ Return HTMLProperty for allowed class' properties.
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
597
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
598 To return all properties call it with cansearch=False
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
599 and it will return properties the user is unable to
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
600 search.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
601 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
602 l = []
5222
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
603 canSearch=self._db.security.hasSearchPermission
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
604 userid=self._client.userid
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
605 for name, prop in self._props.items():
5222
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
606 if cansearch and \
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
607 not canSearch(userid, self._classname, name):
9bf221cebef3 Make properties method return only properties the user can search.
John Rouillard <rouilj@ieee.org>
parents: 5221
diff changeset
608 continue
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
609 for klass, htmlklass in propclasses:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
610 if isinstance(prop, klass):
4481
9bbf3758c16a Allow default value declaration in DB schema.
Stefan Seefeld <stefan@seefeld.name>
parents: 4466
diff changeset
611 value = prop.get_default_value()
1450
7a9db3f9022a ... and a classname
Richard Jones <richard@users.sourceforge.net>
parents: 1449
diff changeset
612 l.append(htmlklass(self._client, self._classname, '',
4481
9bbf3758c16a Allow default value declaration in DB schema.
Stefan Seefeld <stefan@seefeld.name>
parents: 4466
diff changeset
613 prop, name, value, self._anonymous))
1633
ac5f7e5a11e5 sort HTMLClass.properties results by name (feature [SF#724738])
Richard Jones <richard@users.sourceforge.net>
parents: 1631
diff changeset
614 if sort:
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
615 l.sort(key=lambda a:a._name)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
616 return l
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
617
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
618 def list(self, sort_on=None):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
619 """ List all items in this class.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
620 """
1155
5cf0a6b6e787 *cough* sort list results *cough*
Richard Jones <richard@users.sourceforge.net>
parents: 1151
diff changeset
621 # get the list and sort it nicely
5cf0a6b6e787 *cough* sort list results *cough*
Richard Jones <richard@users.sourceforge.net>
parents: 1151
diff changeset
622 l = self._klass.list()
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
623 keyfunc = make_key_function(self._db, self._classname, sort_on)
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
624 l.sort(key=keyfunc)
1155
5cf0a6b6e787 *cough* sort list results *cough*
Richard Jones <richard@users.sourceforge.net>
parents: 1151
diff changeset
625
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
626 # check perms
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
627 check = self._client.db.security.hasPermission
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
628 userid = self._client.userid
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
629 if not check('Web Access', userid):
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
630 return []
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
631
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
632 l = [HTMLItem(self._client, self._classname, id) for id in l
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
633 if check('View', userid, self._classname, itemid=id)]
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
634
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
635 return l
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
636
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
637 def csv(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
638 """ Return the items of this class as a chunk of CSV text.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
639 """
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
640 props = self.propnames()
5418
55f09ca366c4 Python 3 preparation: StringIO.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5416
diff changeset
641 s = StringIO()
3179
88dbe6b3d891 merge removal of rcsv
Richard Jones <richard@users.sourceforge.net>
parents: 3169
diff changeset
642 writer = csv.writer(s)
1767
fdaa0b751355 python2.3 CSV support, also missing thankyou in index.txt :)
Richard Jones <richard@users.sourceforge.net>
parents: 1743
diff changeset
643 writer.writerow(props)
4090
6f698aef2ad4 fix missed hole in the CSV editing - could still view items in the generic index editor
Richard Jones <richard@users.sourceforge.net>
parents: 4088
diff changeset
644 check = self._client.db.security.hasPermission
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
645 userid = self._client.userid
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
646 if not check('Web Access', userid):
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
647 return ''
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
648 for nodeid in self._klass.list():
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
649 l = []
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
650 for name in props:
4090
6f698aef2ad4 fix missed hole in the CSV editing - could still view items in the generic index editor
Richard Jones <richard@users.sourceforge.net>
parents: 4088
diff changeset
651 # check permission to view this property on this item
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
652 if not check('View', userid, itemid=nodeid,
4090
6f698aef2ad4 fix missed hole in the CSV editing - could still view items in the generic index editor
Richard Jones <richard@users.sourceforge.net>
parents: 4088
diff changeset
653 classname=self._klass.classname, property=name):
6f698aef2ad4 fix missed hole in the CSV editing - could still view items in the generic index editor
Richard Jones <richard@users.sourceforge.net>
parents: 4088
diff changeset
654 raise Unauthorised('view', self._klass.classname,
6f698aef2ad4 fix missed hole in the CSV editing - could still view items in the generic index editor
Richard Jones <richard@users.sourceforge.net>
parents: 4088
diff changeset
655 translator=self._client.translator)
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
656 value = self._klass.get(nodeid, name)
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
657 if value is None:
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
658 l.append('')
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
659 elif isinstance(value, type([])):
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
660 l.append(':'.join(map(str, value)))
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
661 else:
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
662 l.append(str(self._klass.get(nodeid, name)))
1767
fdaa0b751355 python2.3 CSV support, also missing thankyou in index.txt :)
Richard Jones <richard@users.sourceforge.net>
parents: 1743
diff changeset
663 writer.writerow(l)
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
664 return s.getvalue()
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
665
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
666 def propnames(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
667 """ Return the list of the names of the properties of this class.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
668 """
5395
23b8e6067f7c Python 3 preparation: update calls to dict methods.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5388
diff changeset
669 idlessprops = sorted(self._klass.getprops(protected=0).keys())
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
670 return ['id'] + idlessprops
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
671
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
672 def filter(self, request=None, filterspec={}, sort=[], group=[]):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
673 """ Return a list of items from this class, filtered and sorted
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
674 by the current requested filterspec/filter/sort/group args
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
675
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
676 "request" takes precedence over the other three arguments.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
677 """
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
678 security = self._db.security
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
679 userid = self._client.userid
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
680 if request is not None:
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
681 # for a request we asume it has already been
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
682 # security-filtered
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
683 filterspec = request.filterspec
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
684 sort = request.sort
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
685 group = request.group
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
686 else:
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
687 cn = self.classname
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
688 filterspec = security.filterFilterspec(userid, cn, filterspec)
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
689 sort = security.filterSortspec(userid, cn, sort)
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
690 group = security.filterSortspec(userid, cn, group)
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
691
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
692 check = security.hasPermission
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
693 if not check('Web Access', userid):
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
694 return []
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
695
3198
0b7990f54778 fixed broken csv import in roundup.admin module
Richard Jones <richard@users.sourceforge.net>
parents: 3194
diff changeset
696 l = [HTMLItem(self._client, self.classname, id)
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
697 for id in self._klass.filter(None, filterspec, sort, group)
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
698 if check('View', userid, self.classname, itemid=id)]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
699 return l
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
700
2458
c18a7d4259e3 translate labels hardcoded in HTMLClass and HTMLItem
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2411
diff changeset
701 def classhelp(self, properties=None, label=''"(list)", width='500',
4945
55aef7ab35a8 Increase default height of classhelp windows from 400 to 600.
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4928
diff changeset
702 height='600', property='', form='itemSynopsis',
4783
365deccf7347 issue2550807 enhance classhelp method with ability to set html properties
John Rouillard <rouilj@ieee.org>
parents: 4750
diff changeset
703 pagesize=50, inputtype="checkbox", html_kwargs={},
5336
5a81a097a394 Allow grouping of classhelp items
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5325
diff changeset
704 group='', sort=None, filter=None):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
705 """Pop up a javascript window with class help
2761
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
706
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
707 This generates a link to a popup window which displays the
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
708 properties indicated by "properties" of the class named by
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
709 "classname". The "properties" should be a comma-separated list
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
710 (eg. 'id,name,description'). Properties defaults to all the
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
711 properties of a class (excluding id, creator, created and
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
712 activity).
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
713
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
714 You may optionally override the label displayed, the width,
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
715 the height, the number of items per page and the field on which
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
716 the list is sorted (defaults to username if in the displayed
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
717 properties).
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
718
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
719 With the "filter" arg it is possible to specify a filter for
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
720 which items are supposed to be displayed. It has to be of
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
721 the format "<field>=<values>;<field>=<values>;...".
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
722
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
723 The popup window will be resizable and scrollable.
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
724
2761
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
725 If the "property" arg is given, it's passed through to the
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
726 javascript help_window function.
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
727
3472
522b11d5ba8d classhelp works with Link properties now [SF#1410290]
Richard Jones <richard@users.sourceforge.net>
parents: 3470
diff changeset
728 You can use inputtype="radio" to display a radio box instead
522b11d5ba8d classhelp works with Link properties now [SF#1410290]
Richard Jones <richard@users.sourceforge.net>
parents: 3470
diff changeset
729 of the default checkbox (useful for entering Link-properties)
1551
9b9917b7719b added an additional argument to help_window to allow comms back to form
Richard Jones <richard@users.sourceforge.net>
parents: 1543
diff changeset
730
2827
43e3a7ac1190 fix HTMLClass.is_view_ok: permission to create new items
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2761
diff changeset
731 If the "form" arg is given, it's passed through to the
2761
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
732 javascript help_window function. - it's the name of the form
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
733 the "property" belongs to.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
734 """
1113
a95428868bf4 Added the missing keyword/topic interface to classic template (blush)
Richard Jones <richard@users.sourceforge.net>
parents: 1104
diff changeset
735 if properties is None:
5395
23b8e6067f7c Python 3 preparation: update calls to dict methods.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5388
diff changeset
736 properties = sorted(self._klass.getprops(protected=0).keys())
1113
a95428868bf4 Added the missing keyword/topic interface to classic template (blush)
Richard Jones <richard@users.sourceforge.net>
parents: 1104
diff changeset
737 properties = ','.join(properties)
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
738 if sort is None:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
739 if 'username' in properties.split( ',' ):
3610
1dbaa664be28 sorting of entries in classhelp popup [SF#1449000]
Richard Jones <richard@users.sourceforge.net>
parents: 3594
diff changeset
740 sort = 'username'
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
741 else:
4032
a73bac81eda2 Fix issue2550500
Stefan Seefeld <stefan@seefeld.name>
parents: 4010
diff changeset
742 sort = self._klass.orderprop()
3610
1dbaa664be28 sorting of entries in classhelp popup [SF#1449000]
Richard Jones <richard@users.sourceforge.net>
parents: 3594
diff changeset
743 sort = '&amp;@sort=' + sort
5336
5a81a097a394 Allow grouping of classhelp items
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5325
diff changeset
744 if group :
5a81a097a394 Allow grouping of classhelp items
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5325
diff changeset
745 group = '&amp;@group=' + group
1551
9b9917b7719b added an additional argument to help_window to allow comms back to form
Richard Jones <richard@users.sourceforge.net>
parents: 1543
diff changeset
746 if property:
1853
389c4d44c73c Replace '&' with '&amp;' in the URLs generated by classhelp(), to validate.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1824
diff changeset
747 property = '&amp;property=%s'%property
2761
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
748 if form:
10a49678ebf2 allow listing popup to be used in query forms (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 2673
diff changeset
749 form = '&amp;form=%s'%form
3472
522b11d5ba8d classhelp works with Link properties now [SF#1410290]
Richard Jones <richard@users.sourceforge.net>
parents: 3470
diff changeset
750 if inputtype:
522b11d5ba8d classhelp works with Link properties now [SF#1410290]
Richard Jones <richard@users.sourceforge.net>
parents: 3470
diff changeset
751 type= '&amp;type=%s'%inputtype
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
752 if filter:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
753 filterprops = filter.split(';')
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
754 filtervalues = []
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
755 names = []
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
756 for x in filterprops:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
757 (name, values) = x.split('=')
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
758 names.append(name)
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
759 filtervalues.append('&amp;%s=%s' % (name, urllib_.quote(values)))
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
760 filter = '&amp;@filter=%s%s' % (','.join(names), ''.join(filtervalues))
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
761 else:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
762 filter = ''
3169
d8d1ebd80930 fallback for (list) popups if javascript disabled (patch [SF#1101626])
Richard Jones <richard@users.sourceforge.net>
parents: 3164
diff changeset
763 help_url = "%s?@startwith=0&amp;@template=help&amp;"\
5336
5a81a097a394 Allow grouping of classhelp items
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5325
diff changeset
764 "properties=%s%s%s%s%s%s&amp;@pagesize=%s%s" % \
3582
026adc5f1e13 fix "Adding a new constrained field to the classic schema" example in docs
Richard Jones <richard@users.sourceforge.net>
parents: 3573
diff changeset
765 (self.classname, properties, property, form, type,
5336
5a81a097a394 Allow grouping of classhelp items
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5325
diff changeset
766 group, sort, pagesize, filter)
3169
d8d1ebd80930 fallback for (list) popups if javascript disabled (patch [SF#1101626])
Richard Jones <richard@users.sourceforge.net>
parents: 3164
diff changeset
767 onclick = "javascript:help_window('%s', '%s', '%s');return false;" % \
d8d1ebd80930 fallback for (list) popups if javascript disabled (patch [SF#1101626])
Richard Jones <richard@users.sourceforge.net>
parents: 3164
diff changeset
768 (help_url, width, height)
4783
365deccf7347 issue2550807 enhance classhelp method with ability to set html properties
John Rouillard <rouilj@ieee.org>
parents: 4750
diff changeset
769 return '<a class="classhelp" href="%s" onclick="%s" %s>%s</a>' % \
365deccf7347 issue2550807 enhance classhelp method with ability to set html properties
John Rouillard <rouilj@ieee.org>
parents: 4750
diff changeset
770 (help_url, onclick, cgi_escape_attrs(**html_kwargs),
365deccf7347 issue2550807 enhance classhelp method with ability to set html properties
John Rouillard <rouilj@ieee.org>
parents: 4750
diff changeset
771 self._(label))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
772
3857
54c10d188b8b allow customisation of the edit action for the submit button
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3856
diff changeset
773 def submit(self, label=''"Submit New Entry", action="new"):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
774 """ Generate a submit button (and action hidden element)
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
775
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
776 Generate nothing if we're not editable.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
777 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
778 if not self.is_edit_ok():
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
779 return ''
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
780
5907
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
781 return \
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
782 self.input(type="submit", name="submit_button",
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
783 value=self._(label)) + \
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
784 '\n' + \
5907
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
785 self.input(type="hidden", name="@csrf",
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
786 value=anti_csrf_nonce(self._client)) + \
2983
9614a101b68f Stuff from the train ride this morning:
Richard Jones <richard@users.sourceforge.net>
parents: 2962
diff changeset
787 '\n' + \
5907
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
788 self.input(type="hidden", name="@action", value=action)
999
8d54c0f3198e Fixed history and its nihilism. Added convenience method for submit buttons
Richard Jones <richard@users.sourceforge.net>
parents: 985
diff changeset
789
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
790 def history(self):
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
791 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
792 return self._('[hidden]')
2466
7b248ea0a2e5 add translation to Unauthorised exception; mark missed text for translation
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2458
diff changeset
793 return self._('New node - no history')
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
794
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
795 def renderWith(self, name, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
796 """ Render this class with the given template.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
797 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
798 # create a new request and override the specified args
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
799 req = HTMLRequest(self._client)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
800 req.classname = self.classname
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
801 req.update(kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
802
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
803 # new template, using the specified classname and request
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
804 # [ ] this code is too similar to client.renderContext()
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
805 tplname = self._client.selectTemplate(self.classname, name)
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
806 pt = self._client.instance.templates.load(tplname)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
807
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
808 # use our fabricated request
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
809 args = {
4880
ca692423e401 Different approach to fix XSS in issue2550817
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4879
diff changeset
810 'ok_message': self._client._ok_message,
ca692423e401 Different approach to fix XSS in issue2550817
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4879
diff changeset
811 'error_message': self._client._error_message
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
812 }
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
813 return pt.render(self._client, self.classname, req, **args)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
814
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
815 class _HTMLItem(HTMLInputMixin, HTMLPermissions):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
816 """ Accesses through an *item*
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
817 """
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
818 def __init__(self, client, classname, nodeid, anonymous=0):
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
819 self._client = client
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
820 self._db = client.db
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
821 self._classname = classname
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
822 self._nodeid = nodeid
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
823 self._klass = self._db.getclass(classname)
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
824 self._props = self._klass.getprops()
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
825
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
826 # do we prefix the form items with the item's identification?
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
827 self._anonymous = anonymous
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
828
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
829 HTMLInputMixin.__init__(self)
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
830
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
831 def is_edit_ok(self):
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
832 """ Is the user allowed to Edit this item?
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
833 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
834 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
835 return perm('Web Access', self._client.userid) and perm('Edit',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
836 self._client.userid, self._classname, itemid=self._nodeid)
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
837
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
838 def is_retire_ok(self):
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
839 """ Is the user allowed to Reture this item?
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
840 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
841 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
842 return perm('Web Access', self._client.userid) and perm('Retire',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
843 self._client.userid, self._classname, itemid=self._nodeid)
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
844
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
845 def is_view_ok(self):
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
846 """ Is the user allowed to View this item?
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
847 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
848 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
849 if perm('Web Access', self._client.userid) and perm('View',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
850 self._client.userid, self._classname, itemid=self._nodeid):
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
851 return 1
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
852 return self.is_edit_ok()
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
853
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
854 def is_only_view_ok(self):
4088
34434785f308 Plug a number of security holes:
Richard Jones <richard@users.sourceforge.net>
parents: 4058
diff changeset
855 """ Is the user only allowed to View (ie. not Edit) this item?
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
856 """
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
857 return self.is_view_ok() and not self.is_edit_ok()
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
858
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
859 def __repr__(self):
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
860 return '<HTMLItem(0x%x) %s %s>'%(id(self), self._classname,
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
861 self._nodeid)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
862
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
863 def __getitem__(self, item):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
864 """ return an HTMLProperty instance
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
865 this now can handle transitive lookups where item is of the
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
866 form x.y.z
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
867 """
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
868 if item == 'id':
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
869 return self._nodeid
1073
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
870
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
871 items = item.split('.', 1)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
872 has_rest = len(items) > 1
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
873
1073
cf30c6cdca02 More documentation.
Richard Jones <richard@users.sourceforge.net>
parents: 1068
diff changeset
874 # get the property
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
875 prop = self._props[items[0]]
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
876
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
877 if has_rest and not isinstance(prop, (hyperdb.Link, hyperdb.Multilink)):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
878 raise KeyError(item)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
879
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
880 # get the value, handling missing values
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
881 value = None
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
882 if int(self._nodeid) > 0:
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
883 value = self._klass.get(self._nodeid, items[0], None)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
884 if value is None:
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
885 if isinstance(prop, hyperdb.Multilink):
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
886 value = []
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
887
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
888 # look up the correct HTMLProperty class
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
889 htmlprop = None
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
890 for klass, htmlklass in propclasses:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
891 if isinstance(prop, klass):
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
892 htmlprop = htmlklass(self._client, self._classname,
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
893 self._nodeid, prop, items[0], value, self._anonymous)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
894 if htmlprop is not None:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
895 if has_rest:
3699
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
896 if isinstance(htmlprop, MultilinkHTMLProperty):
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
897 return [h[items[1]] for h in htmlprop]
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
898 return htmlprop[items[1]]
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
899 return htmlprop
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
900
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
901 raise KeyError(item)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
902
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
903 def __getattr__(self, attr):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
904 """ convenience access to properties """
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
905 try:
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
906 return self[attr]
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
907 except KeyError:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
908 raise AttributeError(attr)
1743
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
909
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
910 def designator(self):
2014
366d3bbce982 Simple version of collision detection...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2010
diff changeset
911 """Return this item's designator (classname + id)."""
1743
f166cd4fd392 add action attribute to issue.item form action tag
Richard Jones <richard@users.sourceforge.net>
parents: 1739
diff changeset
912 return '%s%s'%(self._classname, self._nodeid)
2136
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2118
diff changeset
913
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2118
diff changeset
914 def is_retired(self):
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2118
diff changeset
915 """Is this item retired?"""
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2118
diff changeset
916 return self._klass.is_retired(self._nodeid)
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
917
3856
b38bb4ca3fc0 allow customisation of the edit action for the submit button
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3845
diff changeset
918 def submit(self, label=''"Submit Changes", action="edit"):
2014
366d3bbce982 Simple version of collision detection...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2010
diff changeset
919 """Generate a submit button.
366d3bbce982 Simple version of collision detection...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2010
diff changeset
920
366d3bbce982 Simple version of collision detection...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2010
diff changeset
921 Also sneak in the lastactivity and action hidden elements.
366d3bbce982 Simple version of collision detection...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2010
diff changeset
922 """
5907
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
923 return \
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
924 self.input(type="submit", name="submit_button",
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
925 value=self._(label)) + \
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
926 '\n' + \
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
927 self.input(type="hidden", name="@lastactivity",
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
928 value=self.activity.local(0)) + \
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
929 '\n' + \
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
930 self.input(type="hidden", name="@csrf",
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
931 value=anti_csrf_nonce(self._client)) + \
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
932 '\n' + \
5907
fe96015445e9 Reorder html entities generated by submit button
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5903
diff changeset
933 self.input(type="hidden", name="@action", value=action)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
934
1103
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
935 def journal(self, direction='descending'):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
936 """ Return a list of HTMLJournalEntry instances.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
937 """
1103
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
938 # XXX do this
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
939 return []
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
940
5809
936275dfe1fa Try to fix:
John Rouillard <rouilj@ieee.org>
parents: 5800
diff changeset
941 def history(self, direction='descending', dre=re.compile(r'^\d+$'),
5112
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
942 limit=None, showall=False ):
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
943 """Create an html view of the journal for the item.
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
944
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
945 Display property changes for all properties that does not have quiet set.
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
946 If showall=True then all properties regardless of quiet setting will be
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
947 shown.
8901cc4ef0e0 - issue1714899: Feature Request: Optional Change Note. Added a new
John Rouillard <rouilj@ieee.org>
parents: 5095
diff changeset
948 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
949 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
950 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
951
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
952 # get the journal, sort and reverse
5232
462b0f76fce8 issue2550864 - Potential information leakage via journal/history
John Rouillard <rouilj@ieee.org>
parents: 5222
diff changeset
953 history = self._klass.history(self._nodeid, skipquiet=(not showall))
5448
754be676ccc8 set key for history sort to avoid sorting history args (could be a dict)
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5440
diff changeset
954 history.sort(key=lambda a: a[:3])
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
955 history.reverse()
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
956
4233
01ef28bffcbd don't show entire history by default
Richard Jones <richard@users.sourceforge.net>
parents: 4146
diff changeset
957 # restrict the volume
01ef28bffcbd don't show entire history by default
Richard Jones <richard@users.sourceforge.net>
parents: 4146
diff changeset
958 if limit:
01ef28bffcbd don't show entire history by default
Richard Jones <richard@users.sourceforge.net>
parents: 4146
diff changeset
959 history = history[:limit]
01ef28bffcbd don't show entire history by default
Richard Jones <richard@users.sourceforge.net>
parents: 4146
diff changeset
960
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1394
diff changeset
961 timezone = self._db.getUserTimezone()
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
962 l = []
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
963 current = {}
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
964 comments = {}
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
965 for id, evt_date, user, action, args in history:
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1394
diff changeset
966 date_s = str(evt_date.local(timezone)).replace("."," ")
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
967 arg_s = ''
5232
462b0f76fce8 issue2550864 - Potential information leakage via journal/history
John Rouillard <rouilj@ieee.org>
parents: 5222
diff changeset
968 if action in ['link', 'unlink'] and type(args) == type(()):
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
969 if len(args) == 3:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
970 linkcl, linkid, key = args
5684
97e2125e064c When we generate links from URL's in messages, we add rel="nofollow"
John Rouillard <rouilj@ieee.org>
parents: 5548
diff changeset
971 arg_s += '<a rel="nofollow noopener" href="%s%s">%s%s %s</a>'%(linkcl, linkid,
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
972 linkcl, linkid, key)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
973 else:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
974 arg_s = str(args)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
975 elif type(args) == type({}):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
976 cell = []
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
977 for k in args.keys():
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
978 # try to get the relevant property and treat it
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
979 # specially
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
980 try:
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
981 prop = self._props[k]
999
8d54c0f3198e Fixed history and its nihilism. Added convenience method for submit buttons
Richard Jones <richard@users.sourceforge.net>
parents: 985
diff changeset
982 except KeyError:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
983 prop = None
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
984 if prop is None:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
985 # property no longer exists
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
986 comments['no_exist'] = self._(
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
987 "<em>The indicated property no longer exists</em>")
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
988 cell.append(self._('<em>%s: %s</em>\n')
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
989 % (self._(k), str(args[k])))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
990 continue
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
991
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
992 # load the current state for the property (if we
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
993 # haven't already)
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
994 if k not in current:
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
995 val = self[k]
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
996 if not isinstance(val, HTMLProperty):
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
997 current[k] = None
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
998 else:
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
999 current[k] = val.plain(escape=1)
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1000 # make link if hrefable
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1001 if (isinstance(prop, hyperdb.Link)):
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1002 classname = prop.classname
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1003 try:
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1004 template = self._client.selectTemplate(classname, 'item')
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1005 if template.startswith('_generic.'):
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1006 raise NoTemplate('not really...')
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1007 except NoTemplate:
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1008 pass
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1009 else:
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1010 linkid = self._klass.get(self._nodeid, k, None)
5684
97e2125e064c When we generate links from URL's in messages, we add rel="nofollow"
John Rouillard <rouilj@ieee.org>
parents: 5548
diff changeset
1011 current[k] = '<a rel="nofollow noopener" href="%s%s">%s</a>'%(
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1012 classname, linkid, current[k])
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1013
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1014 if args[k] and (isinstance(prop, hyperdb.Multilink) or
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1015 isinstance(prop, hyperdb.Link)):
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1016 # figure what the link class is
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1017 classname = prop.classname
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1018 try:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1019 linkcl = self._db.getclass(classname)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1020 except KeyError:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1021 labelprop = None
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
1022 comments[classname] = self._(
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1023 "The linked class %(classname)s no longer exists"
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1024 ) % locals()
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1025 labelprop = linkcl.labelprop(1)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1026 try:
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1027 template = self._client.selectTemplate(classname,
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1028 'item')
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1029 if template.startswith('_generic.'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
1030 raise NoTemplate('not really...')
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1031 hrefable = 1
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1032 except NoTemplate:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1033 hrefable = 0
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1034
5232
462b0f76fce8 issue2550864 - Potential information leakage via journal/history
John Rouillard <rouilj@ieee.org>
parents: 5222
diff changeset
1035 if isinstance(prop, hyperdb.Multilink) and args[k]:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1036 ml = []
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1037 for linkid in args[k]:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1038 if isinstance(linkid, type(())):
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1039 sublabel = linkid[0] + ' '
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1040 linkids = linkid[1]
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1041 else:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1042 sublabel = ''
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1043 linkids = [linkid]
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1044 subml = []
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1045 for linkid in linkids:
5325
7c7f3faa5e10 Check for None linkid in history
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5319
diff changeset
1046 # We're seeing things like
7c7f3faa5e10 Check for None linkid in history
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5319
diff changeset
1047 # {'nosy':['38', '113', None, '82']} in the wild
7c7f3faa5e10 Check for None linkid in history
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5319
diff changeset
1048 if linkid is None :
7c7f3faa5e10 Check for None linkid in history
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5319
diff changeset
1049 continue
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1050 label = classname + linkid
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1051 # if we have a label property, try to use it
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1052 # TODO: test for node existence even when
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1053 # there's no labelprop!
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1054 try:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1055 if labelprop is not None and \
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1056 labelprop != 'id':
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1057 label = linkcl.get(linkid, labelprop)
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1058 label = html_escape(label)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1059 except IndexError:
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
1060 comments['no_link'] = self._(
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1061 "<strike>The linked node"
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1062 " no longer exists</strike>")
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1063 subml.append('<strike>%s</strike>'%label)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1064 else:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1065 if hrefable:
5684
97e2125e064c When we generate links from URL's in messages, we add rel="nofollow"
John Rouillard <rouilj@ieee.org>
parents: 5548
diff changeset
1066 subml.append('<a rel="nofollow noopener" '
5325
7c7f3faa5e10 Check for None linkid in history
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5319
diff changeset
1067 'href="%s%s">%s</a>'%(
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1068 classname, linkid, label))
3401
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
1069 elif label is None:
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
1070 subml.append('%s%s'%(classname,
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
1071 linkid))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1072 else:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1073 subml.append(label)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1074 ml.append(sublabel + ', '.join(subml))
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1075 cell.append('%s:\n %s'%(self._(k), ', '.join(ml)))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1076 elif isinstance(prop, hyperdb.Link) and args[k]:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1077 label = classname + args[k]
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1078 # if we have a label property, try to use it
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1079 # TODO: test for node existence even when
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1080 # there's no labelprop!
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1081 if labelprop is not None and labelprop != 'id':
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1082 try:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1083 label = html_escape(linkcl.get(args[k],
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1084 labelprop))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1085 except IndexError:
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
1086 comments['no_link'] = self._(
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1087 "<strike>The linked node"
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1088 " no longer exists</strike>")
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1089 cell.append(' <strike>%s</strike>,\n'%label)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1090 # "flag" this is done .... euwww
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1091 label = None
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1092 if label is not None:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1093 if hrefable:
5684
97e2125e064c When we generate links from URL's in messages, we add rel="nofollow"
John Rouillard <rouilj@ieee.org>
parents: 5548
diff changeset
1094 old = '<a ref="nofollow noopener" href="%s%s">%s</a>'%(classname,
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1095 args[k], label)
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1096 else:
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1097 old = label;
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1098 cell.append('%s: %s' % (self._(k), old))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1099 if k in current and current[k] is not None:
1364
1d1ee96e8956 applied patch for nicer history display (feature [SF#638280])
Richard Jones <richard@users.sourceforge.net>
parents: 1357
diff changeset
1100 cell[-1] += ' -> %s'%current[k]
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1101 current[k] = old
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1102
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1103 elif isinstance(prop, hyperdb.Date) and args[k]:
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1104 if args[k] is None:
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1105 d = ''
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1106 else:
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1107 d = date.Date(args[k],
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1108 translator=self._client).local(timezone)
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1109 cell.append('%s: %s'%(self._(k), str(d)))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1110 if k in current and current[k] is not None:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1111 cell[-1] += ' -> %s' % current[k]
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1112 current[k] = str(d)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1113
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1114 elif isinstance(prop, hyperdb.Interval) and args[k]:
2524
736115d374f2 use client instance to translate Date and Interval objects
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2520
diff changeset
1115 val = str(date.Interval(args[k],
736115d374f2 use client instance to translate Date and Interval objects
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2520
diff changeset
1116 translator=self._client))
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1117 cell.append('%s: %s'%(self._(k), val))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1118 if k in current and current[k] is not None:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1119 cell[-1] += ' -> %s'%current[k]
2170
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1120 current[k] = val
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1121
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1122 elif isinstance(prop, hyperdb.String) and args[k]:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1123 val = html_escape(args[k])
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1124 cell.append('%s: %s'%(self._(k), val))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1125 if k in current and current[k] is not None:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1126 cell[-1] += ' -> %s'%current[k]
2170
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1127 current[k] = val
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1128
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1129 elif isinstance(prop, hyperdb.Boolean) and args[k] is not None:
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1130 val = args[k] and ''"Yes" or ''"No"
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1131 cell.append('%s: %s'%(self._(k), val))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1132 if k in current and current[k] is not None:
2170
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1133 cell[-1] += ' -> %s'%current[k]
0def552122af handle Boolean values in history HTML display
Richard Jones <richard@users.sourceforge.net>
parents: 2157
diff changeset
1134 current[k] = val
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1135
4483
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1136 elif isinstance(prop, hyperdb.Password) and args[k] is not None:
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1137 val = args[k].dummystr()
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1138 cell.append('%s: %s'%(self._(k), val))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1139 if k in current and current[k] is not None:
4483
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1140 cell[-1] += ' -> %s'%current[k]
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1141 current[k] = val
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1142
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1143 elif not args[k]:
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1144 if k in current and current[k] is not None:
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1145 cell.append('%s: %s'%(self._(k), current[k]))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1146 current[k] = '(no value)'
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1147 else:
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1148 cell.append(self._('%s: (no value)')%self._(k))
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1149
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1150 else:
2547
9b9c8fb52732 translate action names and property names in the history list
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2538
diff changeset
1151 cell.append('%s: %s'%(self._(k), str(args[k])))
5492
6b0c542642be blobfiles now always stores/returns bytes
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1152 if k in current and current[k] is not None:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1153 cell[-1] += ' -> %s'%current[k]
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1154 current[k] = str(args[k])
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1155
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1156 arg_s = '<br />'.join(cell)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1157 else:
5947
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1158 if action in ( 'retired', 'restored' ):
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1159 # args = None for these actions
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1160 pass
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1161 else:
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1162 # unknown event!!
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1163 comments['unknown'] = self._(
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1164 "<strong><em>This event %s is not handled"
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1165 " by the history display!</em></strong>"%action)
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1166 arg_s = '<strong><em>' + str(args) + '</em></strong>'
33914dd1160f Retired and Restored were unhandled by history.
John Rouillard <rouilj@ieee.org>
parents: 5927
diff changeset
1167
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1168 date_s = date_s.replace(' ', '&nbsp;')
1258
de0f879f995d fixed history to display username instead of userid
Richard Jones <richard@users.sourceforge.net>
parents: 1254
diff changeset
1169 # if the user's an itemid, figure the username (older journals
de0f879f995d fixed history to display username instead of userid
Richard Jones <richard@users.sourceforge.net>
parents: 1254
diff changeset
1170 # have the username)
de0f879f995d fixed history to display username instead of userid
Richard Jones <richard@users.sourceforge.net>
parents: 1254
diff changeset
1171 if dre.match(user):
de0f879f995d fixed history to display username instead of userid
Richard Jones <richard@users.sourceforge.net>
parents: 1254
diff changeset
1172 user = self._db.user.get(user, 'username')
1074
954ad22eb7d9 more doc, more cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1073
diff changeset
1173 l.append('<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>'%(
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1174 date_s, html_escape(user), self._(action), arg_s))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1175 if comments:
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
1176 l.append(self._(
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
1177 '<tr><td colspan=4><strong>Note:</strong></td></tr>'))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1178 for entry in comments.values():
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1179 l.append('<tr><td colspan=4>%s</td></tr>'%entry)
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1180
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1181 if direction == 'ascending':
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1182 l.reverse()
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1183
4696
57a64e591a00 Use bootstrap classes for displaying tables; bug.item is almost table free and uses bootstrap form classes and markup
Pradip Caulagi <caulagi@gmail.com>
parents: 4651
diff changeset
1184 l[0:0] = ['<table class="history table table-condensed table-striped">'
2614
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1185 '<tr><th colspan="4" class="header">',
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1186 self._('History'),
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1187 '</th></tr><tr>',
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1188 self._('<th>Date</th>'),
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1189 self._('<th>User</th>'),
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1190 self._('<th>Action</th>'),
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1191 self._('<th>Args</th>'),
c64ea31a569b merge from HEAD, with some additional code re-arranging
Richard Jones <richard@users.sourceforge.net>
parents: 2591
diff changeset
1192 '</tr>']
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1193 l.append('</table>')
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1194 return '\n'.join(l)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1195
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1196 def renderQueryForm(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1197 """ Render this item, which is a query, as a search form.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1198 """
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1199 # create a new request and override the specified args
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1200 req = HTMLRequest(self._client)
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1201 req.classname = self._klass.get(self._nodeid, 'klass')
1284
899c6ced2abe include queryname in query template render ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1272
diff changeset
1202 name = self._klass.get(self._nodeid, 'name')
899c6ced2abe include queryname in query template render ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1272
diff changeset
1203 req.updateFromURL(self._klass.get(self._nodeid, 'url') +
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
1204 '&@queryname=%s'%urllib_.quote(name))
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1205
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1206 # new template, using the specified classname and request
4740
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1207 # [ ] the custom logic for search page doesn't belong to
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1208 # generic templating module (techtonik)
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1209 tplname = self._client.selectTemplate(req.classname, 'search')
fe9568a6cbd6 Untangle template selection logic from template loading functionality.
anatoly techtonik <techtonik@gmail.com>
parents: 4737
diff changeset
1210 pt = self._client.instance.templates.load(tplname)
4057
885069b5f328 Fix context for query form to be a class.
Stefan Seefeld <stefan@seefeld.name>
parents: 4056
diff changeset
1211 # The context for a search page should be the class, not any
885069b5f328 Fix context for query form to be a class.
Stefan Seefeld <stefan@seefeld.name>
parents: 4056
diff changeset
1212 # node.
885069b5f328 Fix context for query form to be a class.
Stefan Seefeld <stefan@seefeld.name>
parents: 4056
diff changeset
1213 self._client.nodeid = None
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
1214
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1215 # use our fabricated request
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1216 return pt.render(self._client, req.classname, req)
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
1217
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1218 def download_url(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1219 """ Assume that this item is a FileClass and that it has a name
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1220 and content. Construct a URL for the download of the content.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1221 """
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1222 name = self._klass.get(self._nodeid, 'name')
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1223 url = '%s%s/%s'%(self._classname, self._nodeid, name)
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
1224 return urllib_.quote(url)
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1225
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1226 def copy_url(self, exclude=("messages", "files")):
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1227 """Construct a URL for creating a copy of this item
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1228
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1229 "exclude" is an optional list of properties that should
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1230 not be copied to the new object. By default, this list
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1231 includes "messages" and "files" properties. Note that
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1232 "id" property cannot be copied.
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1233
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1234 """
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1235 exclude = ("id", "activity", "actor", "creation", "creator") \
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1236 + tuple(exclude)
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1237 query = {
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1238 "@template": "item",
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1239 "@note": self._("Copy of %(class)s %(id)s") % {
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1240 "class": self._(self._classname), "id": self._nodeid},
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1241 }
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1242 for name in self._props.keys():
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1243 if name not in exclude:
4839
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1244 prop = self._props[name]
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1245 if not isinstance(prop, hyperdb.Multilink):
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1246 query[name] = self[name].plain()
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1247 else:
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1248 query[name] = ",".join(self._klass.get(self._nodeid, name))
c317147fd891 Fix copy_url to properly support properties that are mutlilinks.
John Rouillard <rouilj@ieee.org>
parents: 4804
diff changeset
1249
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1250 return self._classname + "?" + "&".join(
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
1251 ["%s=%s" % (key, urllib_.quote(value))
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1252 for key, value in query.items()])
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1253
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1254 class _HTMLUser(_HTMLItem):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1255 """Add ability to check for permissions on users.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1256 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1257 _marker = []
2991
b9a55628a78d more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2983
diff changeset
1258 def hasPermission(self, permission, classname=_marker,
b9a55628a78d more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2983
diff changeset
1259 property=None, itemid=None):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1260 """Determine if the user has the Permission.
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1261
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1262 The class being tested defaults to the template's class, but may
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1263 be overidden for this test by suppling an alternate classname.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1264 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1265 if classname is self._marker:
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1266 classname = self._client.classname
3535
75dc225613cc fix security check for hasPermission(Permission, None)
Richard Jones <richard@users.sourceforge.net>
parents: 3509
diff changeset
1267 return self._db.security.hasPermission(permission,
3357
5c8822d10fdc fix invocation of hasPermission from templating code [SF#1224172]
Richard Jones <richard@users.sourceforge.net>
parents: 3354
diff changeset
1268 self._nodeid, classname, property, itemid)
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1269
4306
966592263fb8 Clean up all the places where role processing occurs.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4288
diff changeset
1270 def hasRole(self, *rolenames):
966592263fb8 Clean up all the places where role processing occurs.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4288
diff changeset
1271 """Determine whether the user has any role in rolenames."""
966592263fb8 Clean up all the places where role processing occurs.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4288
diff changeset
1272 return self._db.user.has_role(self._nodeid, *rolenames)
3535
75dc225613cc fix security check for hasPermission(Permission, None)
Richard Jones <richard@users.sourceforge.net>
parents: 3509
diff changeset
1273
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1274 def HTMLItem(client, classname, nodeid, anonymous=0):
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1275 if classname == 'user':
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1276 return _HTMLUser(client, classname, nodeid, anonymous)
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1277 else:
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1278 return _HTMLItem(client, classname, nodeid, anonymous)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1279
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1280 class HTMLProperty(HTMLInputMixin, HTMLPermissions):
5067
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1281 """ String, Integer, Number, Date, Interval HTMLProperty
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1282
1123
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
1283 Has useful attributes:
1080
24c9e81fce85 bugfix, added some doc
Richard Jones <richard@users.sourceforge.net>
parents: 1079
diff changeset
1284
24c9e81fce85 bugfix, added some doc
Richard Jones <richard@users.sourceforge.net>
parents: 1079
diff changeset
1285 _name the name of the property
24c9e81fce85 bugfix, added some doc
Richard Jones <richard@users.sourceforge.net>
parents: 1079
diff changeset
1286 _value the value of the property if any
24c9e81fce85 bugfix, added some doc
Richard Jones <richard@users.sourceforge.net>
parents: 1079
diff changeset
1287
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1288 A wrapper object which may be stringified for the plain() behaviour.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1289 """
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1290 def __init__(self, client, classname, nodeid, prop, name, value,
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1291 anonymous=0):
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1292 self._client = client
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1293 self._db = client.db
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1294 self._ = client._
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1295 self._classname = classname
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1296 self._nodeid = nodeid
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1297 self._prop = prop
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1298 self._value = value
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1299 self._anonymous = anonymous
1468
f57759a5ee1a Better form name mangling, doesn't confuse other things like generic editing.
Richard Jones <richard@users.sourceforge.net>
parents: 1467
diff changeset
1300 self._name = name
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1301 if not anonymous:
4286
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1302 if nodeid:
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1303 self._formname = '%s%s@%s'%(classname, nodeid, name)
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1304 else:
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1305 # This case occurs when creating a property for a
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1306 # non-anonymous class.
f364978e6e3f Do not create bogus non-anonymous objects.
Stefan Seefeld <stefan@seefeld.name>
parents: 4268
diff changeset
1307 self._formname = '%s@%s'%(classname, name)
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
1308 else:
1468
f57759a5ee1a Better form name mangling, doesn't confuse other things like generic editing.
Richard Jones <richard@users.sourceforge.net>
parents: 1467
diff changeset
1309 self._formname = name
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
1310
4056
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1311 # If no value is already present for this property, see if one
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1312 # is specified in the current form.
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1313 form = self._client.form
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
1314 try:
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1315 is_in = self._formname in form
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
1316 except TypeError:
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
1317 is_in = False
5166
232c74973a56 issue1408570: fix that form values are lost
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5156
diff changeset
1318 if is_in and (not self._value or self._client.form_wins):
4056
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1319 if isinstance(prop, hyperdb.Multilink):
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1320 value = lookupIds(self._db, prop,
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1321 handleListCGIValue(form[self._formname]),
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1322 fail_ok=1)
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1323 elif isinstance(prop, hyperdb.Link):
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1324 value = form.getfirst(self._formname).strip()
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1325 if value:
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1326 value = lookupIds(self._db, prop, [value],
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1327 fail_ok=1)[0]
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1328 else:
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1329 value = None
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1330 else:
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1331 value = form.getfirst(self._formname).strip() or None
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1332 self._value = value
a82b17500b22 Fix issue2550512
Stefan Seefeld <stefan@seefeld.name>
parents: 4055
diff changeset
1333
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
1334 HTMLInputMixin.__init__(self)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1335
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1336 def __repr__(self):
4463
1bd86e82422b Make HTMLProperty report actual classname in repr().
Stefan Seefeld <stefan@seefeld.name>
parents: 4437
diff changeset
1337 classname = self.__class__.__name__
1bd86e82422b Make HTMLProperty report actual classname in repr().
Stefan Seefeld <stefan@seefeld.name>
parents: 4437
diff changeset
1338 return '<%s(0x%x) %s %r %r>'%(classname, id(self), self._formname,
1bd86e82422b Make HTMLProperty report actual classname in repr().
Stefan Seefeld <stefan@seefeld.name>
parents: 4437
diff changeset
1339 self._prop, self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1340 def __str__(self):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1341 return self.plain()
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1342 def __lt__(self, other):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1343 if isinstance(other, HTMLProperty):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1344 return self._value < other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1345 return self._value < other
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1346 def __le__(self, other):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1347 if isinstance(other, HTMLProperty):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1348 return self._value <= other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1349 return self._value <= other
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1350 def __eq__(self, other):
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1351 if isinstance(other, HTMLProperty):
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1352 return self._value == other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1353 return self._value == other
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1354 def __ne__(self, other):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1355 if isinstance(other, HTMLProperty):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1356 return self._value != other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1357 return self._value != other
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1358 def __gt__(self, other):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1359 if isinstance(other, HTMLProperty):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1360 return self._value > other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1361 return self._value > other
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1362 def __ge__(self, other):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1363 if isinstance(other, HTMLProperty):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1364 return self._value >= other._value
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
1365 return self._value >= other
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1366
5404
3757449e00c4 Python 3 preparation: use __bool__ instead of __nonzero__.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5402
diff changeset
1367 def __bool__(self):
2347
fbbda3b1816d implement __nonzero__ for HTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 2327
diff changeset
1368 return not not self._value
5404
3757449e00c4 Python 3 preparation: use __bool__ instead of __nonzero__.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5402
diff changeset
1369 # Python 2 compatibility:
3757449e00c4 Python 3 preparation: use __bool__ instead of __nonzero__.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5402
diff changeset
1370 __nonzero__ = __bool__
2347
fbbda3b1816d implement __nonzero__ for HTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 2327
diff changeset
1371
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1372 def isset(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1373 """Is my _value not None?"""
2289
6d16b967f89d HTML templating isset() inverted [SF#951779]
Richard Jones <richard@users.sourceforge.net>
parents: 2262
diff changeset
1374 return self._value is not None
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
1375
2002
b046b65e51db if you're going to enforce class-level permissions...
Richard Jones <richard@users.sourceforge.net>
parents: 1983
diff changeset
1376 def is_edit_ok(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1377 """Should the user be allowed to use an edit form field for this
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1378 property. Check "Create" for new items, or "Edit" for existing
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1379 ones.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1380 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1381 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1382 userid = self._client.userid
2002
b046b65e51db if you're going to enforce class-level permissions...
Richard Jones <richard@users.sourceforge.net>
parents: 1983
diff changeset
1383 if self._nodeid:
4329
58b7ba47af87 fixes to make registration work again
Richard Jones <richard@users.sourceforge.net>
parents: 4328
diff changeset
1384 if not perm('Web Access', userid):
58b7ba47af87 fixes to make registration work again
Richard Jones <richard@users.sourceforge.net>
parents: 4328
diff changeset
1385 return False
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1386 return perm('Edit', userid, self._classname, self._name,
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1387 self._nodeid)
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1388 return perm('Create', userid, self._classname, self._name) or \
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1389 perm('Register', userid, self._classname, self._name)
2002
b046b65e51db if you're going to enforce class-level permissions...
Richard Jones <richard@users.sourceforge.net>
parents: 1983
diff changeset
1390
b046b65e51db if you're going to enforce class-level permissions...
Richard Jones <richard@users.sourceforge.net>
parents: 1983
diff changeset
1391 def is_view_ok(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1392 """ Is the user allowed to View the current class?
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1393 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1394 perm = self._db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1395 if perm('Web Access', self._client.userid) and perm('View',
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1396 self._client.userid, self._classname, self._name, self._nodeid):
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1397 return 1
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
1398 return self.is_edit_ok()
2002
b046b65e51db if you're going to enforce class-level permissions...
Richard Jones <richard@users.sourceforge.net>
parents: 1983
diff changeset
1399
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1400 class StringHTMLProperty(HTMLProperty):
3991
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1401 hyper_re = re.compile(r'''(
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1402 (?P<url>
4009
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1403 (
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1404 (ht|f)tp(s?):// # protocol
4010
797eacd945af add tests for and fix alex's examples
Richard Jones <richard@users.sourceforge.net>
parents: 4009
diff changeset
1405 ([\w]+(:\w+)?@)? # username/password
797eacd945af add tests for and fix alex's examples
Richard Jones <richard@users.sourceforge.net>
parents: 4009
diff changeset
1406 ([\w\-]+) # hostname
797eacd945af add tests for and fix alex's examples
Richard Jones <richard@users.sourceforge.net>
parents: 4009
diff changeset
1407 ((\.[\w-]+)+)? # .domain.etc
4009
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1408 | # ... or ...
4010
797eacd945af add tests for and fix alex's examples
Richard Jones <richard@users.sourceforge.net>
parents: 4009
diff changeset
1409 ([\w]+(:\w+)?@)? # username/password
4009
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1410 www\. # "www."
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1411 ([\w\-]+\.)+ # hostname
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1412 [\w]{2,5} # TLD
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1413 )
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1414 (:[\d]{1,5})? # port
e335ce40d6c8 Make URL matching code less matchy
Richard Jones <richard@users.sourceforge.net>
parents: 3991
diff changeset
1415 (/[\w\-$.+!*(),;:@&=?/~\\#%]*)? # path etc.
3991
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1416 )|
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1417 (?P<email>[-+=%/\w\.]+@[\w\.\-]+)|
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1418 (?P<item>(?P<class>[A-Za-z_]+)(\s*)(?P<id>\d+))
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1419 )''', re.X | re.I)
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1420 protocol_re = re.compile('^(ht|f)tp(s?)://', re.I)
13161539e5bd improved URL matching
Richard Jones <richard@users.sourceforge.net>
parents: 3972
diff changeset
1421
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1422
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1423
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1424 def _hyper_repl(self, match):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1425 if match.group('url'):
5684
97e2125e064c When we generate links from URL's in messages, we add rel="nofollow"
John Rouillard <rouilj@ieee.org>
parents: 5548
diff changeset
1426 return self._hyper_repl_url(match, '<a href="%s" rel="nofollow noopener">%s</a>%s')
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1427 elif match.group('email'):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1428 return self._hyper_repl_email(match, '<a href="mailto:%s">%s</a>')
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1429 elif len(match.group('id')) < 10:
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1430 return self._hyper_repl_item(match,
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1431 '<a href="%(cls)s%(id)s">%(item)s</a>')
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1432 else:
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1433 # just return the matched text
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1434 return match.group(0)
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1435
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1436 def _hyper_repl_url(self, match, replacement):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1437 u = s = match.group('url')
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1438 if not self.protocol_re.search(s):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1439 u = 'http://' + s
4413
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1440 end = ''
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1441 if '&gt;' in s:
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1442 # catch an escaped ">" in the URL
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1443 pos = s.find('&gt;')
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1444 end = s[pos:]
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1445 u = s = s[:pos]
4647
11b6601629d7 #2550759: Trailing punctuation is no longer included when URLs are converted to links.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 4587
diff changeset
1446 if s.endswith(tuple('.,;:!')):
11b6601629d7 #2550759: Trailing punctuation is no longer included when URLs are converted to links.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 4587
diff changeset
1447 # don't include trailing punctuation
11b6601629d7 #2550759: Trailing punctuation is no longer included when URLs are converted to links.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 4587
diff changeset
1448 end = s[-1:] + end
11b6601629d7 #2550759: Trailing punctuation is no longer included when URLs are converted to links.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 4587
diff changeset
1449 u = s = s[:-1]
4413
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1450 if ')' in s and s.count('(') != s.count(')'):
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1451 # don't include extraneous ')' in the link
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1452 pos = s.rfind(')')
4413
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1453 end = s[pos:] + end
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1454 u = s = s[:pos]
4413
66603a9051f9 improve handling of '&gt;' when URLs are converted to links
Richard Jones <richard@users.sourceforge.net>
parents: 4396
diff changeset
1455 return replacement % (u, s, end)
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1456
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1457 def _hyper_repl_email(self, match, replacement):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1458 s = match.group('email')
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1459 return replacement % (s, s)
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1460
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
1461 def _hyper_repl_item(self, match, replacement):
3862
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1462 item = match.group('item')
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1463 cls = match.group('class').lower()
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1464 id = match.group('id')
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1465 try:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1466 # make sure cls is a valid tracker classname
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1467 cl = self._db.getclass(cls)
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1468 if not cl.hasnode(id):
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1469 return item
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1470 return replacement % locals()
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1471 except KeyError:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1472 return item
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1473
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1474
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1475 def _hyper_repl_rst(self, match):
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1476 if match.group('url'):
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1477 s = match.group('url')
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1478 return '`%s <%s>`_'%(s, s)
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1479 elif match.group('email'):
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1480 s = match.group('email')
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1481 return '`%s <mailto:%s>`_'%(s, s)
4288
ce684080e968 issue2550549: Some bugs issue classifiers were causing database lookup errors
Richard Jones <richard@users.sourceforge.net>
parents: 4286
diff changeset
1482 elif len(match.group('id')) < 10:
ce684080e968 issue2550549: Some bugs issue classifiers were causing database lookup errors
Richard Jones <richard@users.sourceforge.net>
parents: 4286
diff changeset
1483 return self._hyper_repl_item(match,'`%(item)s <%(cls)s%(id)s>`_')
3862
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1484 else:
4288
ce684080e968 issue2550549: Some bugs issue classifiers were causing database lookup errors
Richard Jones <richard@users.sourceforge.net>
parents: 4286
diff changeset
1485 # just return the matched text
ce684080e968 issue2550549: Some bugs issue classifiers were causing database lookup errors
Richard Jones <richard@users.sourceforge.net>
parents: 4286
diff changeset
1486 return match.group(0)
1336
6a54b51b1784 hyperlinking of special message text
Richard Jones <richard@users.sourceforge.net>
parents: 1332
diff changeset
1487
5156
882fa4d9bead issue2550795: @dispname query args in page.html search links
John Rouillard <rouilj@ieee.org>
parents: 5146
diff changeset
1488 def url_quote(self):
882fa4d9bead issue2550795: @dispname query args in page.html search links
John Rouillard <rouilj@ieee.org>
parents: 5146
diff changeset
1489 """ Return the string in plain format but escaped for use in a url """
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
1490 return urllib_.quote(self.plain())
5156
882fa4d9bead issue2550795: @dispname query args in page.html search links
John Rouillard <rouilj@ieee.org>
parents: 5146
diff changeset
1491
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1492 def hyperlinked(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1493 """ Render a "hyperlinked" version of the text """
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1494 return self.plain(hyperlink=1)
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1495
1374
8e4c3e8de96f fix StringHTMLProperty hyperlinking
Richard Jones <richard@users.sourceforge.net>
parents: 1370
diff changeset
1496 def plain(self, escape=0, hyperlink=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1497 """Render a "plain" representation of the property
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
1498
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
1499 - "escape" turns on/off HTML quoting
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
1500 - "hyperlink" turns on/off in-text hyperlinking of URLs, email
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
1501 addresses and designators
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1502 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1503 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1504 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1505
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1506 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1507 return ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1508 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1509 s = html_escape(str(self._value))
1336
6a54b51b1784 hyperlinking of special message text
Richard Jones <richard@users.sourceforge.net>
parents: 1332
diff changeset
1510 else:
1374
8e4c3e8de96f fix StringHTMLProperty hyperlinking
Richard Jones <richard@users.sourceforge.net>
parents: 1370
diff changeset
1511 s = str(self._value)
1336
6a54b51b1784 hyperlinking of special message text
Richard Jones <richard@users.sourceforge.net>
parents: 1332
diff changeset
1512 if hyperlink:
1773
5f15fb95180c various cosmetic fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1771
diff changeset
1513 # no, we *must* escape this text
1374
8e4c3e8de96f fix StringHTMLProperty hyperlinking
Richard Jones <richard@users.sourceforge.net>
parents: 1370
diff changeset
1514 if not escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1515 s = html_escape(s)
1394
d5314bfab0c0 fix incorrect hyperlinking markup
Richard Jones <richard@users.sourceforge.net>
parents: 1374
diff changeset
1516 s = self.hyper_re.sub(self._hyper_repl, s)
1336
6a54b51b1784 hyperlinking of special message text
Richard Jones <richard@users.sourceforge.net>
parents: 1332
diff changeset
1517 return s
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1518
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1519 def wrapped(self, escape=1, hyperlink=1):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1520 """Render a "wrapped" representation of the property.
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1521
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1522 We wrap long lines at 80 columns on the nearest whitespace. Lines
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1523 with no whitespace are not broken to force wrapping.
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1524
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1525 Note that unlike plain() we default wrapped() to have the escaping
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1526 and hyperlinking turned on since that's the most common usage.
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1527
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1528 - "escape" turns on/off HTML quoting
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1529 - "hyperlink" turns on/off in-text hyperlinking of URLs, email
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1530 addresses and designators
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1531 """
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1532 if not self.is_view_ok():
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1533 return self._('[hidden]')
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1534
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1535 if self._value is None:
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1536 return ''
5043
ac0c117cd24c Remove wrap and associated functions from roundup.support
John Kristensen <john@jerrykan.com>
parents: 5006
diff changeset
1537 s = '\n'.join(textwrap.wrap(str(self._value), 80))
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1538 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1539 s = html_escape(s)
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1540 if hyperlink:
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1541 # no, we *must* escape this text
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1542 if not escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1543 s = html_escape(s)
3644
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1544 s = self.hyper_re.sub(self._hyper_repl, s)
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1545 return s
f35ece8f8ff7 added StringHTMLProperty wrapped() method to wrap long lines in issue display
Richard Jones <richard@users.sourceforge.net>
parents: 3635
diff changeset
1546
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1547 def stext(self, escape=0, hyperlink=1):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1548 """ Render the value of the property as StructuredText.
1123
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
1549
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
1550 This requires the StructureText module to be installed separately.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1551 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1552 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1553 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1554
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1555 s = self.plain(escape=escape, hyperlink=hyperlink)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1556 if not StructuredText:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1557 return s
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1558 return StructuredText(s,level=1,header=0)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1559
3862
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1560 def rst(self, hyperlink=1):
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1561 """ Render the value of the property as ReStructuredText.
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1562
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1563 This requires docutils to be installed separately.
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1564 """
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1565 if not self.is_view_ok():
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1566 return self._('[hidden]')
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1567
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1568 if not ReStructuredText:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1569 return self.plain(escape=0, hyperlink=hyperlink)
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1570 s = self.plain(escape=0, hyperlink=0)
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1571 if hyperlink:
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1572 s = self.hyper_re.sub(self._hyper_repl_rst, s)
4097
1daf9f921cc9 Serve the correct ReST part in String.rst().
Stefan Seefeld <stefan@seefeld.name>
parents: 4090
diff changeset
1573 return ReStructuredText(s, writer_name="html")["html_body"].encode("utf-8",
3862
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1574 "replace")
b052820e86bf Add a rst method to StringHTMLProperty...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3861
diff changeset
1575
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1576 def field(self, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1577 """ Render the property as a field in HTML.
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1578
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1579 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1580 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1581 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1582 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1583
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
1584 value = self._value
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
1585 if value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1586 value = ''
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1587
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1588 kwargs.setdefault("size", 30)
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1589 kwargs.update({"name": self._formname, "value": value})
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1590 return self.input(**kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1591
3905
6733a7cce7f4 multiline pass through extra keywords args
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3903
diff changeset
1592 def multiline(self, escape=0, rows=5, cols=40, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1593 """ Render a multiline form edit field for the property.
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1594
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1595 If not editable, just display the plain() value in a <pre> tag.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1596 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1597 if not self.is_edit_ok():
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1598 return '<pre>%s</pre>'%self.plain()
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1599
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1600 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1601 value = ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1602 else:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1603 value = html_escape(str(self._value))
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1604
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1605 value = '&quot;'.join(value.split('"'))
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1606 name = self._formname
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1607 passthrough_args = cgi_escape_attrs(**kwargs)
3905
6733a7cce7f4 multiline pass through extra keywords args
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3903
diff changeset
1608 return ('<textarea %(passthrough_args)s name="%(name)s" id="%(name)s"'
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1609 ' rows="%(rows)s" cols="%(cols)s">'
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1610 '%(value)s</textarea>') % locals()
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1611
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1612 def email(self, escape=1):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1613 """ Render the value of the property as an obscured email address
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1614 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1615 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1616 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1617
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1618 if self._value is None:
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1619 value = ''
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1620 else:
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1621 value = str(self._value)
3573
d7bab396c228 email obfuscation code in html templating is more robust
Richard Jones <richard@users.sourceforge.net>
parents: 3565
diff changeset
1622 split = value.split('@')
d7bab396c228 email obfuscation code in html templating is more robust
Richard Jones <richard@users.sourceforge.net>
parents: 3565
diff changeset
1623 if len(split) == 2:
d7bab396c228 email obfuscation code in html templating is more robust
Richard Jones <richard@users.sourceforge.net>
parents: 3565
diff changeset
1624 name, domain = split
1133
36ec30d286ea Cleaned up CHANGES/TODO
Richard Jones <richard@users.sourceforge.net>
parents: 1124
diff changeset
1625 domain = ' '.join(domain.split('.')[:-1])
36ec30d286ea Cleaned up CHANGES/TODO
Richard Jones <richard@users.sourceforge.net>
parents: 1124
diff changeset
1626 name = name.replace('.', ' ')
36ec30d286ea Cleaned up CHANGES/TODO
Richard Jones <richard@users.sourceforge.net>
parents: 1124
diff changeset
1627 value = '%s at %s ...'%(name, domain)
36ec30d286ea Cleaned up CHANGES/TODO
Richard Jones <richard@users.sourceforge.net>
parents: 1124
diff changeset
1628 else:
36ec30d286ea Cleaned up CHANGES/TODO
Richard Jones <richard@users.sourceforge.net>
parents: 1124
diff changeset
1629 value = value.replace('.', ' ')
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1630 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1631 value = html_escape(value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1632 return value
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1633
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1634 class PasswordHTMLProperty(HTMLProperty):
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1635 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1636 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1637 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1638 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1639 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1640
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1641 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1642 return ''
5182
dc657fbbc790 - issue2550933 - Fix Traceback in cgi/templating.py when a string is
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
1643 try:
dc657fbbc790 - issue2550933 - Fix Traceback in cgi/templating.py when a string is
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
1644 value = self._value.dummystr()
dc657fbbc790 - issue2550933 - Fix Traceback in cgi/templating.py when a string is
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
1645 except AttributeError:
dc657fbbc790 - issue2550933 - Fix Traceback in cgi/templating.py when a string is
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
1646 value = self._('[hidden]')
4483
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1647 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
1648 value = html_escape(value)
4483
22bc0426e348 Second patch from issue2550688 -- with some changes:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4481
diff changeset
1649 return value
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1650
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1651 def field(self, size=30, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1652 """ Render a form edit field for the property.
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1653
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1654 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1655 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1656 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1657 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1658
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1659 return self.input(type="password", name=self._formname, size=size,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1660 **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1661
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1662 def confirm(self, size=30):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1663 """ Render a second form edit field for the property, used for
1144
db13f46cb5f9 password edit now has a confirmation field
Richard Jones <richard@users.sourceforge.net>
parents: 1136
diff changeset
1664 confirmation that the user typed the password correctly. Generates
1911
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1857
diff changeset
1665 a field with name "@confirm@name".
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1666
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1667 If not editable, display nothing.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1668 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1669 if not self.is_edit_ok():
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1670 return ''
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1671
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1672 return self.input(type="password",
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1673 name="@confirm@%s"%self._formname,
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1674 id="%s-confirm"%self._formname,
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1675 size=size)
1144
db13f46cb5f9 password edit now has a confirmation field
Richard Jones <richard@users.sourceforge.net>
parents: 1136
diff changeset
1676
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1677 class NumberHTMLProperty(HTMLProperty):
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1678 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1679 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1680 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1681 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1682 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1683
2884
6d6fdd1daf92 NumberHTMLProperty should return "" not "None" if not set
Richard Jones <richard@users.sourceforge.net>
parents: 2883
diff changeset
1684 if self._value is None:
6d6fdd1daf92 NumberHTMLProperty should return "" not "None" if not set
Richard Jones <richard@users.sourceforge.net>
parents: 2883
diff changeset
1685 return ''
6d6fdd1daf92 NumberHTMLProperty should return "" not "None" if not set
Richard Jones <richard@users.sourceforge.net>
parents: 2883
diff changeset
1686
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1687 return str(self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1688
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1689 def field(self, size=30, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1690 """ Render a form edit field for the property.
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1691
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1692 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1693 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1694 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1695 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1696
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
1697 value = self._value
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
1698 if value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1699 value = ''
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
1700
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1701 return self.input(name=self._formname, value=value, size=size,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1702 **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1703
1518
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1704 def __int__(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1705 """ Return an int of me
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1706 """
1518
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1707 return int(self._value)
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1708
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1709 def __float__(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1710 """ Return a float of me
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1711 """
1518
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1712 return float(self._value)
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1713
5067
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1714 class IntegerHTMLProperty(HTMLProperty):
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1715 def plain(self, escape=0):
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1716 """ Render a "plain" representation of the property
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1717 """
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1718 if not self.is_view_ok():
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1719 return self._('[hidden]')
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1720
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1721 if self._value is None:
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1722 return ''
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1723
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1724 return str(self._value)
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1725
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1726 def field(self, size=30, **kwargs):
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1727 """ Render a form edit field for the property.
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1728
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1729 If not editable, just display the value via plain().
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1730 """
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1731 if not self.is_edit_ok():
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1732 return self.plain(escape=1)
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1733
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1734 value = self._value
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1735 if value is None:
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1736 value = ''
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1737
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1738 return self.input(name=self._formname, value=value, size=size,
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1739 **kwargs)
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1740
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1741 def __int__(self):
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1742 """ Return an int of me
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1743 """
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1744 return int(self._value)
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
1745
1518
bb843662b708 basic numeric support for NumberHTMLProperty
Richard Jones <richard@users.sourceforge.net>
parents: 1513
diff changeset
1746
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1747 class BooleanHTMLProperty(HTMLProperty):
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1748 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1749 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1750 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1751 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1752 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1753
1289
257f0ab00d50 bugfix in boolean templating
Richard Jones <richard@users.sourceforge.net>
parents: 1284
diff changeset
1754 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1755 return ''
3354
201dbcf63a30 use translation for boolean property rendering [SF#1225152]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3338
diff changeset
1756 return self._value and self._("Yes") or self._("No")
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1757
4784
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1758 def field(self, labelfirst=False, y_label=None, n_label=None,
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1759 u_label=None, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1760 """ Render a form edit field for the property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1761
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1762 If not editable, just display the value via plain().
4784
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1763
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1764 In addition to being able to set arbitrary html properties
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1765 using prop=val arguments, the thre arguments:
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1766
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1767 y_label, n_label, u_label let you control the labels
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1768 associated with the yes, no (and optionally unknown/empty)
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1769 values.
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1770
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1771 Also the labels can be placed before the radiobuttons by setting
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1772 labelfirst=True.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1773 """
2113
30aeb17e5b04 Boolean HTML templating was broken
Richard Jones <richard@users.sourceforge.net>
parents: 2106
diff changeset
1774 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1775 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1776
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1777 value = self._value
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
1778 if is_us(value):
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1779 value = value.strip().lower() in ('checked', 'yes', 'true',
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1780 'on', '1')
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1781
4784
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1782 if ( not y_label ):
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1783 y_label = '<label class="rblabel" for="%s_%s">'%(self._formname, 'yes')
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1784 y_label += self._('Yes')
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1785 y_label += '</label>'
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1786
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1787 if ( not n_label ):
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1788 n_label = '<label class="rblabel" for="%s_%s">'%(self._formname, 'no')
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1789 n_label += self._('No')
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1790 n_label += '</label>'
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1791
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1792 checked = value and "checked" or ""
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1793 if value:
4784
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1794 y_rb = self.input(type="radio", name=self._formname, value="yes",
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1795 checked="checked", id="%s_%s"%(self._formname, 'yes'), **kwargs)
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1796
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1797 n_rb =self.input(type="radio", name=self._formname, value="no",
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1798 id="%s_%s"%(self._formname, 'no'), **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1799 else:
4784
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1800 y_rb = self.input(type="radio", name=self._formname, value="yes",
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1801 id="%s_%s"%(self._formname, 'yes'), **kwargs)
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1802
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1803 n_rb = self.input(type="radio", name=self._formname, value="no",
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1804 checked="checked", id="%s_%s"%(self._formname, 'no'), **kwargs)
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1805
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1806 if ( u_label ):
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1807 if (u_label is True): # it was set via u_label=True
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1808 u_label = '' # make it empty but a string not boolean
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1809 u_rb = self.input(type="radio", name=self._formname, value="",
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1810 id="%s_%s"%(self._formname, 'unk'), **kwargs)
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1811 else:
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1812 # don't generate a trivalue radiobutton.
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1813 u_label = ''
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1814 u_rb=''
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1815
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1816 if ( labelfirst ):
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1817 s = u_label + u_rb + y_label + y_rb + n_label + n_rb
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1818 else:
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1819 s = u_label + u_rb +y_rb + y_label + n_rb + n_label
888676704342 issue2550808 BooleanHTMLProperty::field method html needs to be more
John Rouillard <rouilj@ieee.org>
parents: 4783
diff changeset
1820
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1821 return s
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1822
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1823 class DateHTMLProperty(HTMLProperty):
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1824
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1825 _marker = []
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1826
2314
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1827 def __init__(self, client, classname, nodeid, prop, name, value,
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1828 anonymous=0, offset=None):
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1829 HTMLProperty.__init__(self, client, classname, nodeid, prop, name,
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1830 value, anonymous=anonymous)
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
1831 if self._value and not is_us(self._value):
2561
0dd3dca6bd01 always use translation service set in the tracker client instance;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2558
diff changeset
1832 self._value.setTranslator(self._client.translator)
2314
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1833 self._offset = offset
3383
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1834 if self._offset is None :
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1835 self._offset = self._prop.offset (self._db)
2314
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1836
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1837 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1838 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1839 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1840 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1841 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1842
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1843 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1844 return ''
2314
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1845 if self._offset is None:
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1846 offset = self._db.getUserTimezone()
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1847 else:
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1848 offset = self._offset
4842
1e4c45a4254b Allow using plain() on unsaved dates in HTML forms
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4839
diff changeset
1849 try:
1e4c45a4254b Allow using plain() on unsaved dates in HTML forms
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4839
diff changeset
1850 return str(self._value.local(offset))
1e4c45a4254b Allow using plain() on unsaved dates in HTML forms
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4839
diff changeset
1851 except AttributeError:
1e4c45a4254b Allow using plain() on unsaved dates in HTML forms
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4839
diff changeset
1852 # not a date value, e.g. from unsaved form data
1e4c45a4254b Allow using plain() on unsaved dates in HTML forms
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4839
diff changeset
1853 return str(self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1854
2580
e90d63c7eceb fixed DateHTMLProperty for invalid date entry [SF#986538]
Richard Jones <richard@users.sourceforge.net>
parents: 2574
diff changeset
1855 def now(self, str_interval=None):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1856 """ Return the current time.
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
1857
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
1858 This is useful for defaulting a new value. Returns a
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
1859 DateHTMLProperty.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1860 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1861 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1862 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1863
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1864 ret = date.Date('.', translator=self._client)
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1865
5438
e2382945d302 Python 3 preparation: avoid basestring.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5423
diff changeset
1866 if is_us(str_interval):
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1867 sign = 1
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1868 if str_interval[0] == '-':
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1869 sign = -1
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1870 str_interval = str_interval[1:]
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1871 interval = date.Interval(str_interval, translator=self._client)
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1872 if sign > 0:
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1873 ret = ret + interval
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1874 else:
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1875 ret = ret - interval
2520
0914d72bb15b fix single string split into three separate MsgIDs
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2471
diff changeset
1876
2037
35ed1560ba2b missed one
Richard Jones <richard@users.sourceforge.net>
parents: 2036
diff changeset
1877 return DateHTMLProperty(self._client, self._classname, self._nodeid,
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1878 self._prop, self._formname, ret)
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
1879
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1880 def field(self, size=30, default=None, format=_marker, popcal=True,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1881 **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1882 """Render a form edit field for the property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1883
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1884 If not editable, just display the value via plain().
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1885
3649
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1886 If "popcal" then include the Javascript calendar editor.
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1887 Default=yes.
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1888
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1889 The format string is a standard python strftime format string.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1890 """
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1891 if not self.is_edit_ok():
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1892 if format is self._marker:
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
1893 return self.plain(escape=1)
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1894 else:
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1895 return self.pretty(format)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1896
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1897 value = self._value
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1898
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1899 if value is None:
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1900 if default is None:
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1901 raw_value = None
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1902 else:
5438
e2382945d302 Python 3 preparation: avoid basestring.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5423
diff changeset
1903 if is_us(default):
3832
bbc977e1cd2c Fix handling of defaults for date fields
Richard Jones <richard@users.sourceforge.net>
parents: 3785
diff changeset
1904 raw_value = date.Date(default, translator=self._client)
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1905 elif isinstance(default, date.Date):
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1906 raw_value = default
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1907 elif isinstance(default, DateHTMLProperty):
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
1908 raw_value = default._value
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1909 else:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
1910 raise ValueError(self._('default value for '
2520
0914d72bb15b fix single string split into three separate MsgIDs
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2471
diff changeset
1911 'DateHTMLProperty must be either DateHTMLProperty '
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
1912 'or string date representation.'))
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
1913 elif is_us(value):
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1914 # most likely erroneous input to be passed back to user
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
1915 value = us2s(value)
4927
c120f747e0b4 In case of an error, date fields would lose the calendar help, fixed.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4880
diff changeset
1916 s = self.input(name=self._formname, value=value, size=size,
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1917 **kwargs)
4927
c120f747e0b4 In case of an error, date fields would lose the calendar help, fixed.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4880
diff changeset
1918 if popcal:
c120f747e0b4 In case of an error, date fields would lose the calendar help, fixed.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4880
diff changeset
1919 s += self.popcal()
c120f747e0b4 In case of an error, date fields would lose the calendar help, fixed.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4880
diff changeset
1920 return s
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1921 else:
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
1922 raw_value = value
2471
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1923
31cd032291c5 new templating features
Richard Jones <richard@users.sourceforge.net>
parents: 2466
diff changeset
1924 if raw_value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1925 value = ''
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
1926 elif is_us(raw_value):
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1927 if format is self._marker:
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1928 value = raw_value
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1929 else:
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1930 value = date.Date(raw_value).pretty(format)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1931 else:
3383
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1932 if self._offset is None :
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1933 offset = self._db.getUserTimezone()
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1934 else :
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1935 offset = self._offset
c1c67c62b699 applied patch [SF#236087]
Richard Jones <richard@users.sourceforge.net>
parents: 3369
diff changeset
1936 value = raw_value.local(offset)
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1937 if format is not self._marker:
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1938 value = value.pretty(format)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1939
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1940 s = self.input(name=self._formname, value=value, size=size,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
1941 **kwargs)
3649
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1942 if popcal:
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1943 s += self.popcal()
12633662ff63 include the popcal in Date field editing and search fields by default
Richard Jones <richard@users.sourceforge.net>
parents: 3644
diff changeset
1944 return s
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1945
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1946 def reldate(self, pretty=1):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1947 """ Render the interval between the date and now.
1124
1fc1f92c5f31 more doc, bugfix in Batch
Richard Jones <richard@users.sourceforge.net>
parents: 1123
diff changeset
1948
1fc1f92c5f31 more doc, bugfix in Batch
Richard Jones <richard@users.sourceforge.net>
parents: 1123
diff changeset
1949 If the "pretty" flag is true, then make the display pretty.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1950 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1951 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1952 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1953
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1954 if not self._value:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1955 return ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1956
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1957 # figure the interval
2524
736115d374f2 use client instance to translate Date and Interval objects
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2520
diff changeset
1958 interval = self._value - date.Date('.', translator=self._client)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1959 if pretty:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1960 return interval.pretty()
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1961 return str(interval)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1962
1453
b72f422d1e5e better handling of format param
Richard Jones <richard@users.sourceforge.net>
parents: 1451
diff changeset
1963 def pretty(self, format=_marker):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1964 """ Render the date in a pretty format (eg. month names, spaces).
1272
cae50587fb96 expose the Date.pretty method to templating
Richard Jones <richard@users.sourceforge.net>
parents: 1270
diff changeset
1965
cae50587fb96 expose the Date.pretty method to templating
Richard Jones <richard@users.sourceforge.net>
parents: 1270
diff changeset
1966 The format string is a standard python strftime format string.
cae50587fb96 expose the Date.pretty method to templating
Richard Jones <richard@users.sourceforge.net>
parents: 1270
diff changeset
1967 Note that if the day is zero, and appears at the start of the
cae50587fb96 expose the Date.pretty method to templating
Richard Jones <richard@users.sourceforge.net>
parents: 1270
diff changeset
1968 string, then it'll be stripped from the output. This is handy
3479
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1969 for the situation when a date only specifies a month and a year.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1970 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1971 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1972 return self._('[hidden]')
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1973
3479
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1974 if self._offset is None:
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1975 offset = self._db.getUserTimezone()
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1976 else:
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1977 offset = self._offset
3509
dcaa366b2cc8 fix StructuredText import;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3505
diff changeset
1978
2956
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1979 if not self._value:
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1980 return ''
4511fd6c5dbf format parameter for DateHTMLProperty.field() (based on patch [SF#1072834])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2884
diff changeset
1981 elif format is not self._marker:
3479
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1982 return self._value.local(offset).pretty(format)
1453
b72f422d1e5e better handling of format param
Richard Jones <richard@users.sourceforge.net>
parents: 1451
diff changeset
1983 else:
3479
86d6131847e8 timezone now applied to date for pretty-format [SF#1406861]
Richard Jones <richard@users.sourceforge.net>
parents: 3472
diff changeset
1984 return self._value.local(offset).pretty()
1272
cae50587fb96 expose the Date.pretty method to templating
Richard Jones <richard@users.sourceforge.net>
parents: 1270
diff changeset
1985
1320
3758a5af985f Lots of little fixes in this update:
Richard Jones <richard@users.sourceforge.net>
parents: 1289
diff changeset
1986 def local(self, offset):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1987 """ Return the date/time as a local (timezone offset) date/time.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
1988 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
1989 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
1990 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
1991
2036
bc5ff0519b8b fixed bug in args to new DateHTMLProperty in the local() method [SF#901444]
Richard Jones <richard@users.sourceforge.net>
parents: 2031
diff changeset
1992 return DateHTMLProperty(self._client, self._classname, self._nodeid,
2314
7c8d2e9a0566 fix DateHTMLProperty so local() can override user timezone [SF#953678]
Richard Jones <richard@users.sourceforge.net>
parents: 2289
diff changeset
1993 self._prop, self._formname, self._value, offset=offset)
1320
3758a5af985f Lots of little fixes in this update:
Richard Jones <richard@users.sourceforge.net>
parents: 1289
diff changeset
1994
3710
2862cb0d9be4 default attributes for input fields:
Tobias Herp <tobias-herp@users.sourceforge.net>
parents: 3702
diff changeset
1995 def popcal(self, width=300, height=200, label="(cal)",
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
1996 form="itemSynopsis"):
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
1997 """Generate a link to a calendar pop-up window.
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
1998
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
1999 item: HTMLProperty e.g.: context.deadline
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2000 """
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2001 if self.isset():
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2002 date = "&date=%s"%self._value
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2003 else :
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2004 date = ""
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2005 return ('<a class="classhelp" href="javascript:help_window('
4052
f8ba421ee4b0 Quote ampersands in URLs.
Stefan Seefeld <stefan@seefeld.name>
parents: 4051
diff changeset
2006 "'%s?@template=calendar&amp;property=%s&amp;form=%s%s', %d, %d)"
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2007 '">%s</a>'%(self._classname, self._name, form, date, width,
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2008 height, label))
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
2009
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2010 class IntervalHTMLProperty(HTMLProperty):
2389
2ff93cee9c63 StaticTranslationService got methods gettext() and ngettext()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2377
diff changeset
2011 def __init__(self, client, classname, nodeid, prop, name, value,
2ff93cee9c63 StaticTranslationService got methods gettext() and ngettext()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2377
diff changeset
2012 anonymous=0):
2ff93cee9c63 StaticTranslationService got methods gettext() and ngettext()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2377
diff changeset
2013 HTMLProperty.__init__(self, client, classname, nodeid, prop,
2ff93cee9c63 StaticTranslationService got methods gettext() and ngettext()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2377
diff changeset
2014 name, value, anonymous)
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
2015 if self._value and not is_us(self._value):
2561
0dd3dca6bd01 always use translation service set in the tracker client instance;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2558
diff changeset
2016 self._value.setTranslator(self._client.translator)
2389
2ff93cee9c63 StaticTranslationService got methods gettext() and ngettext()...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2377
diff changeset
2017
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2018 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2019 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2020 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
2021 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2022 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2023
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2024 if self._value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2025 return ''
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2026 return str(self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2027
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2028 def pretty(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2029 """ Render the interval in a pretty format (eg. "yesterday")
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2030 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
2031 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2032 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2033
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2034 return self._value.pretty()
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2035
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2036 def field(self, size=30, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2037 """ Render a form edit field for the property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2038
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2039 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2040 """
3040
14322134dcef fix permissions checks in cgi templating [SF#1082755]
Richard Jones <richard@users.sourceforge.net>
parents: 3006
diff changeset
2041 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2042 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2043
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2044 value = self._value
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2045 if value is None:
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2046 value = ''
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2047
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2048 return self.input(name=self._formname, value=value, size=size,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2049 **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2050
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2051 class LinkHTMLProperty(HTMLProperty):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2052 """ Link HTMLProperty
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2053 Include the above as well as being able to access the class
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2054 information. Stringifying the object itself results in the value
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2055 from the item being displayed. Accessing attributes of this object
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2056 result in the appropriate entry from the class being queried for the
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2057 property accessed (so item/assignedto/name would look up the user
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2058 entry identified by the assignedto property on item, and then the
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2059 name property of that user)
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2060 """
1447
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
2061 def __init__(self, *args, **kw):
6118d4498db3 added "foo@" prefix to all but "context" form variable names
Richard Jones <richard@users.sourceforge.net>
parents: 1441
diff changeset
2062 HTMLProperty.__init__(self, *args, **kw)
1323
80eef084069a Fix to handle bad form submissions, Links and the magic -1 form value.
Richard Jones <richard@users.sourceforge.net>
parents: 1322
diff changeset
2063 # if we're representing a form value, then the -1 from the form really
80eef084069a Fix to handle bad form submissions, Links and the magic -1 form value.
Richard Jones <richard@users.sourceforge.net>
parents: 1322
diff changeset
2064 # should be a None
80eef084069a Fix to handle bad form submissions, Links and the magic -1 form value.
Richard Jones <richard@users.sourceforge.net>
parents: 1322
diff changeset
2065 if str(self._value) == '-1':
80eef084069a Fix to handle bad form submissions, Links and the magic -1 form value.
Richard Jones <richard@users.sourceforge.net>
parents: 1322
diff changeset
2066 self._value = None
80eef084069a Fix to handle bad form submissions, Links and the magic -1 form value.
Richard Jones <richard@users.sourceforge.net>
parents: 1322
diff changeset
2067
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2068 def __getattr__(self, attr):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2069 """ return a new HTMLItem """
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2070 if not self._value:
3394
5c7ff95fecad work around pagetemplate oddity
Richard Jones <richard@users.sourceforge.net>
parents: 3383
diff changeset
2071 # handle a special page templates lookup
5c7ff95fecad work around pagetemplate oddity
Richard Jones <richard@users.sourceforge.net>
parents: 3383
diff changeset
2072 if attr == '__render_with_namespace__':
5c7ff95fecad work around pagetemplate oddity
Richard Jones <richard@users.sourceforge.net>
parents: 3383
diff changeset
2073 def nothing(*args, **kw):
5c7ff95fecad work around pagetemplate oddity
Richard Jones <richard@users.sourceforge.net>
parents: 3383
diff changeset
2074 return ''
5c7ff95fecad work around pagetemplate oddity
Richard Jones <richard@users.sourceforge.net>
parents: 3383
diff changeset
2075 return nothing
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2076 msg = self._('Attempt to look up %(attr)s on a missing value')
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2077 return MissingValue(msg%locals())
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
2078 i = HTMLItem(self._client, self._prop.classname, self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2079 return getattr(i, attr)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2080
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2081 def __getitem__(self, item):
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2082 """Explicitly define __getitem__ -- this used to work earlier
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2083 due to __getattr__ returning the __getitem__ of HTMLItem -- this
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2084 lookup doesn't work for new-style classes.
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2085 """
4879
302c967d710c HTML* classes for cgi: handle MissingValue case
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4878
diff changeset
2086 if not self._value:
302c967d710c HTML* classes for cgi: handle MissingValue case
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4878
diff changeset
2087 msg = self._('Attempt to look up %(item)s on a missing value')
302c967d710c HTML* classes for cgi: handle MissingValue case
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4878
diff changeset
2088 return MissingValue(msg%locals())
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2089 i = HTMLItem(self._client, self._prop.classname, self._value)
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2090 return i[item]
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
2091
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2092 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2093 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2094 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
2095 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2096 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2097
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2098 if self._value is None:
1099
7362dc1f0226 Made "creator" property a String like it should be (we can't lookup()
Richard Jones <richard@users.sourceforge.net>
parents: 1097
diff changeset
2099 return ''
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2100 linkcl = self._db.classes[self._prop.classname]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2101 k = linkcl.labelprop(1)
3936
63d58cc1394a make LinkHTMLProperty handle non-existing keys (patch [SF#1815895])
Richard Jones <richard@users.sourceforge.net>
parents: 3909
diff changeset
2102 if num_re.match(self._value):
4058
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2103 try:
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2104 value = str(linkcl.get(self._value, k))
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2105 except IndexError:
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2106 value = self._value
3936
63d58cc1394a make LinkHTMLProperty handle non-existing keys (patch [SF#1815895])
Richard Jones <richard@users.sourceforge.net>
parents: 3909
diff changeset
2107 else :
63d58cc1394a make LinkHTMLProperty handle non-existing keys (patch [SF#1815895])
Richard Jones <richard@users.sourceforge.net>
parents: 3909
diff changeset
2108 value = self._value
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2109 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
2110 value = html_escape(value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2111 return value
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2112
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2113 def field(self, showid=0, size=None, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2114 """ Render a form edit field for the property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2115
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2116 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2117 """
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2118 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2119 return self.plain(escape=1)
1322
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2120
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2121 # edit field
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2122 linkcl = self._db.getclass(self._prop.classname)
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2123 if self._value is None:
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2124 value = ''
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2125 else:
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2126 k = linkcl.getkey()
4958
9b1302f9fb11 Fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4945
diff changeset
2127 idparse = self._prop.try_id_parsing
4959
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2128 if k and num_re.match(self._value):
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2129 try :
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2130 value = linkcl.get(self._value, k)
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2131 except IndexError :
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2132 if idparse :
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2133 raise
177b77302262 Another fix for 'try_id_parsing'
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4958
diff changeset
2134 value = ''
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2135 else:
2116
1ef1b050b785 fix Link HTML field()
Richard Jones <richard@users.sourceforge.net>
parents: 2113
diff changeset
2136 value = self._value
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2137 return self.input(name=self._formname, value=value, size=size,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2138 **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2139
3470
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2140 def menu(self, size=None, height=None, showid=0, additional=[], value=None,
5181
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2141 sort_on=None, html_kwargs={}, translate=True, showdef=None, **conditions):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2142 """ Render a form select list for this property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2143
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2144 "size" is used to limit the length of the list labels
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2145 "height" is used to set the <select> tag's "size" attribute
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2146 "showid" includes the item ids in the list labels
3470
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2147 "value" specifies which item is pre-selected
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2148 "additional" lists properties which should be included in the
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2149 label
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2150 "sort_on" indicates the property to sort the list on as
3361
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2151 (direction, property) where direction is '+' or '-'. A
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2152 single string with the direction prepended may be used.
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2153 For example: ('-', 'order'), '+name'.
4537
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2154 "html_kwargs" specified additional html args for the
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2155 generated html <select>
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2156 "translate" indicates if we should do translation of labels
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2157 using gettext -- this is often desired (e.g. for status
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2158 labels) but sometimes not.
5181
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2159 "showdef" marks the default value with the string passed
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2160 as the showdef argument. It is appended to the selected
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2161 value so the user can reset the menu to the original value.
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2162 Note that the marker may be removed if the length of
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2163 the option label and the marker exceed the size.
3270
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2164
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2165 The remaining keyword arguments are used as conditions for
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2166 filtering the items in the list - they're passed as the
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2167 "filterspec" argument to a Class.filter() call.
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2168
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2169 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2170 """
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2171 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2172 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2173
4043
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2174 # Since None indicates the default, we need another way to
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2175 # indicate "no selection". We use -1 for this purpose, as
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2176 # that is the value we use when submitting a form without the
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2177 # value set.
3470
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2178 if value is None:
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2179 value = self._value
4043
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2180 elif value == '-1':
32965347a663 Allow 'no value' to be selected in LinkHTMLProperty.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4042
diff changeset
2181 value = None
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2182
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2183 linkcl = self._db.getclass(self._prop.classname)
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2184 l = ['<select %s>'%cgi_escape_attrs(name = self._formname,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2185 **html_kwargs)]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2186 k = linkcl.labelprop(1)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2187 s = ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2188 if value is None:
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
2189 s = 'selected="selected" '
2396
39cdddd313ca HTMLInputMixin provides translation interface for all its hiers...
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2390
diff changeset
2190 l.append(self._('<option %svalue="-1">- no selection -</option>')%s)
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2191
3361
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2192 if sort_on is not None:
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2193 if not isinstance(sort_on, tuple):
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2194 if sort_on[0] in '+-':
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2195 sort_on = (sort_on[0], sort_on[1:])
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2196 else:
64cc03598c8a fixed templating menu() sort_on handling [SF#1221936]
Richard Jones <richard@users.sourceforge.net>
parents: 3357
diff changeset
2197 sort_on = ('+', sort_on)
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
2198 else:
4032
a73bac81eda2 Fix issue2550500
Stefan Seefeld <stefan@seefeld.name>
parents: 4010
diff changeset
2199 sort_on = ('+', linkcl.orderprop())
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2200
3565
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2201 options = [opt
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2202 for opt in linkcl.filter(None, conditions, sort_on, (None, None))
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2203 if self._db.security.hasPermission("View", self._client.userid,
3594
b5b6a6f7743a fix bug in menu() permission filter [SF#1444440]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3584
diff changeset
2204 linkcl.classname, itemid=opt)]
1322
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2205
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2206 # make sure we list the current value if it's retired
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
2207 if value and value not in options:
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
2208 options.insert(0, value)
1322
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2209
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2210 if additional:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2211 additional_fns = []
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2212 props = linkcl.getprops()
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2213 for propname in additional:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2214 prop = props[propname]
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2215 if isinstance(prop, hyperdb.Link):
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2216 cl = self._db.getclass(prop.classname)
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2217 labelprop = cl.labelprop()
5062
2ac11cc397eb Fix arguments to 'menu cgi method
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5061
diff changeset
2218 fn = lambda optionid, cl=cl, linkcl=linkcl, \
4847
843886af0ea1 Reformat previous change (3e36a3bc0335) to 80 chars
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4846
diff changeset
2219 propname=propname, labelprop=labelprop: \
843886af0ea1 Reformat previous change (3e36a3bc0335) to 80 chars
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4846
diff changeset
2220 cl.get(linkcl.get(optionid, propname), labelprop)
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2221 else:
5062
2ac11cc397eb Fix arguments to 'menu cgi method
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5061
diff changeset
2222 fn = lambda optionid, linkcl=linkcl, propname=propname: \
4847
843886af0ea1 Reformat previous change (3e36a3bc0335) to 80 chars
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4846
diff changeset
2223 linkcl.get(optionid, propname)
4846
3e36a3bc0335 issue2550822: Fix showing more than one additional property in class menu
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4842
diff changeset
2224 additional_fns.append(fn)
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2225
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2226 for optionid in options:
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2227 # get the option value, and if it's None use an empty string
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2228 option = linkcl.get(optionid, k) or ''
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2229
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2230 # figure if this option is selected
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2231 s = ''
5181
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2232 # record the marker for the selected item if requested
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2233 selected_mark=''
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2234
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2235 if value in [optionid, option]:
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
2236 s = 'selected="selected" '
5181
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2237 if ( showdef ):
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2238 selected_mark = showdef
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2239
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2240 # figure the label
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2241 if showid:
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2242 lab = '%s%s: %s'%(self._prop.classname, optionid, option)
3151
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
2243 elif not option:
6feac4fcf883 Various bug fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 3127
diff changeset
2244 lab = '%s%s'%(self._prop.classname, optionid)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2245 else:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2246 lab = option
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2247
5181
496f30da72f8 Add a new argument "showdef" to the template function menu(). When set
John Rouillard <rouilj@ieee.org>
parents: 5180
diff changeset
2248 lab = lab + selected_mark
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2249 # truncate if it's too long
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2250 if size is not None and len(lab) > size:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2251 lab = lab[:size-3] + '...'
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2252 if additional:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2253 m = []
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2254 for fn in additional_fns:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2255 m.append(str(fn(optionid)))
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2256 lab = lab + ' (%s)'%', '.join(m)
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2257
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2258 # and generate
4537
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2259 tr = str
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2260 if translate:
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2261 tr = self._
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
2262 lab = html_escape(tr(lab))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2263 l.append('<option %svalue="%s">%s</option>'%(s, optionid, lab))
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2264 l.append('</select>')
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2265 return '\n'.join(l)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2266 # def checklist(self, ...)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2267
3194
f887e55edc94 replaced MutlilinkIterator with multilinkGenerator (thanks Bob Ippolito)
Richard Jones <richard@users.sourceforge.net>
parents: 3188
diff changeset
2268
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2269
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2270 class MultilinkHTMLProperty(HTMLProperty):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2271 """ Multilink HTMLProperty
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2272
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2273 Also be iterable, returning a wrapper object like the Link case for
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2274 each entry in the multilink.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2275 """
1931
f1e5e5115c29 Always sort MultilinkHTMLProperty in the correct order...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1917
diff changeset
2276 def __init__(self, *args, **kwargs):
f1e5e5115c29 Always sort MultilinkHTMLProperty in the correct order...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1917
diff changeset
2277 HTMLProperty.__init__(self, *args, **kwargs)
f1e5e5115c29 Always sort MultilinkHTMLProperty in the correct order...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1917
diff changeset
2278 if self._value:
3270
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2279 display_value = lookupIds(self._db, self._prop, self._value,
3860
c672b15ddae6 - fix id-lookup in case we already *know* that the value is an id (in
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3857
diff changeset
2280 fail_ok=1, do_lookup=False)
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2281 keyfun = make_key_function(self._db, self._prop.classname)
3270
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2282 # sorting fails if the value contains
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2283 # items not yet stored in the database
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2284 # ignore these errors to preserve user input
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2285 try:
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2286 display_value.sort(key=keyfun)
3270
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2287 except:
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2288 pass
3271
572bbe7fa236 typo in recent fix
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3270
diff changeset
2289 self._value = display_value
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
2290
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2291 def __len__(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2292 """ length of the multilink """
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2293 return len(self._value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2294
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2295 def __getattr__(self, attr):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2296 """ no extended attribute accesses make sense here """
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
2297 raise AttributeError(attr)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2298
3200
d2b1a946fdf4 change ZTUtils Iterator to always iter() its sequence argument
Richard Jones <richard@users.sourceforge.net>
parents: 3198
diff changeset
2299 def viewableGenerator(self, values):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2300 """Used to iterate over only the View'able items in a class."""
3198
0b7990f54778 fixed broken csv import in roundup.admin module
Richard Jones <richard@users.sourceforge.net>
parents: 3194
diff changeset
2301 check = self._db.security.hasPermission
0b7990f54778 fixed broken csv import in roundup.admin module
Richard Jones <richard@users.sourceforge.net>
parents: 3194
diff changeset
2302 userid = self._client.userid
0b7990f54778 fixed broken csv import in roundup.admin module
Richard Jones <richard@users.sourceforge.net>
parents: 3194
diff changeset
2303 classname = self._prop.classname
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2304 if check('Web Access', userid):
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2305 for value in values:
5221
24945480d24c Iterate over multilink items if they labelprop is accessible to the
John Rouillard <rouilj@ieee.org>
parents: 5217
diff changeset
2306 if check('View', userid, classname,
24945480d24c Iterate over multilink items if they labelprop is accessible to the
John Rouillard <rouilj@ieee.org>
parents: 5217
diff changeset
2307 itemid=value,
24945480d24c Iterate over multilink items if they labelprop is accessible to the
John Rouillard <rouilj@ieee.org>
parents: 5217
diff changeset
2308 property=self._db.getclass(classname).labelprop(default_to_id=1)):
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2309 yield HTMLItem(self._client, classname, value)
3198
0b7990f54778 fixed broken csv import in roundup.admin module
Richard Jones <richard@users.sourceforge.net>
parents: 3194
diff changeset
2310
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2311 def __iter__(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2312 """ iterate and return a new HTMLItem
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2313 """
3200
d2b1a946fdf4 change ZTUtils Iterator to always iter() its sequence argument
Richard Jones <richard@users.sourceforge.net>
parents: 3198
diff changeset
2314 return self.viewableGenerator(self._value)
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2315
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2316 def reverse(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2317 """ return the list in reverse order
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2318 """
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2319 l = self._value[:]
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2320 l.reverse()
3200
d2b1a946fdf4 change ZTUtils Iterator to always iter() its sequence argument
Richard Jones <richard@users.sourceforge.net>
parents: 3198
diff changeset
2321 return self.viewableGenerator(l)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2322
5903
c3728772c594 Add reverse option to hyperdb property wrapper by David Sowder
John Rouillard <rouilj@ieee.org>
parents: 5876
diff changeset
2323 def sorted(self, property, reverse=False):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2324 """ Return this multilink sorted by the given property """
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2325 value = list(self.__iter__())
5903
c3728772c594 Add reverse option to hyperdb property wrapper by David Sowder
John Rouillard <rouilj@ieee.org>
parents: 5876
diff changeset
2326 value.sort(key=lambda a:a[property], reverse=reverse)
2883
1ca5ebe9b16a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2880
diff changeset
2327 return value
1ca5ebe9b16a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2880
diff changeset
2328
1103
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
2329 def __contains__(self, value):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2330 """ Support the "in" operator. We have to make sure the passed-in
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2331 value is a string first, not a HTMLProperty.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2332 """
1325
2e5a9fc7abd5 allow StringHTMLProperty in MultilinkHTMLProperty test to work
Richard Jones <richard@users.sourceforge.net>
parents: 1323
diff changeset
2333 return str(value) in self._value
1103
db787cef1385 handled some XXXs
Richard Jones <richard@users.sourceforge.net>
parents: 1099
diff changeset
2334
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
2335 def isset(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2336 """Is my _value not []?"""
2289
6d16b967f89d HTML templating isset() inverted [SF#951779]
Richard Jones <richard@users.sourceforge.net>
parents: 2262
diff changeset
2337 return self._value != []
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
2338
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2339 def plain(self, escape=0):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2340 """ Render a "plain" representation of the property
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2341 """
3117
460eb0209a9e Permissions improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 3104
diff changeset
2342 if not self.is_view_ok():
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
2343 return self._('[hidden]')
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2344
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2345 linkcl = self._db.classes[self._prop.classname]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2346 k = linkcl.labelprop(1)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2347 labels = []
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2348 for v in self._value:
4058
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2349 if num_re.match(v):
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2350 try:
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2351 label = linkcl.get(v, k)
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2352 except IndexError:
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2353 label = None
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2354 # fall back to designator if label is None
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2355 if label is None: label = '%s%s'%(self._prop.classname, k)
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2356 else:
3057092623e1 Robustify (Multi)linkHTMLProperty.plain.
Stefan Seefeld <stefan@seefeld.name>
parents: 4057
diff changeset
2357 label = v
3401
62e4032cb280 merge from maint-0-8
Richard Jones <richard@users.sourceforge.net>
parents: 3394
diff changeset
2358 labels.append(label)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2359 value = ', '.join(labels)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2360 if escape:
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
2361 value = html_escape(value)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2362 return value
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2363
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2364 def field(self, size=30, showid=0, **kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2365 """ Render a form edit field for the property
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2366
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2367 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2368 """
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2369 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2370 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2371
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2372 linkcl = self._db.getclass(self._prop.classname)
4339
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2373
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2374 if 'value' not in kwargs:
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2375 value = self._value[:]
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2376 # map the id to the label property
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2377 if not linkcl.getkey():
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2378 showid=1
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2379 if not showid:
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2380 k = linkcl.labelprop(1)
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2381 value = lookupKeys(linkcl, k, value)
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2382 value = ','.join(value)
4356
05a65559d873 undo regression in 1.4.12: Multilink edit fields lose their values
Richard Jones <richard@users.sourceforge.net>
parents: 4339
diff changeset
2383 kwargs["value"] = value
4339
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2384
663664c4e626 Allow value to be specified to multilink form element templating
Richard Jones <richard@users.sourceforge.net>
parents: 4333
diff changeset
2385 return self.input(name=self._formname, size=size, **kwargs)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2386
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2387 def menu(self, size=None, height=None, showid=0, additional=[],
4537
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2388 value=None, sort_on=None, html_kwargs={}, translate=True,
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2389 **conditions):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2390 """ Render a form <select> list for this property.
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2391
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2392 "size" is used to limit the length of the list labels
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2393 "height" is used to set the <select> tag's "size" attribute
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2394 "showid" includes the item ids in the list labels
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2395 "additional" lists properties which should be included in the
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2396 label
3470
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2397 "value" specifies which item is pre-selected
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2398 "sort_on" indicates the property to sort the list on as
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2399 (direction, property) where direction is '+' or '-'. A
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2400 single string with the direction prepended may be used.
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2401 For example: ('-', 'order'), '+name'.
3270
e4607e12d030 ignore sorting errors in MultilinkHTMLProperty instantiation [SF#1177602]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3253
diff changeset
2402
3127
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2403 The remaining keyword arguments are used as conditions for
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2404 filtering the items in the list - they're passed as the
021b131bd816 doc fixes, one more fix to the permissions-in-listings fix
Richard Jones <richard@users.sourceforge.net>
parents: 3126
diff changeset
2405 "filterspec" argument to a Class.filter() call.
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2406
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2407 If not editable, just display the value via plain().
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2408 """
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2409 if not self.is_edit_ok():
3971
ff3a8b7d1819 security fixes
Richard Jones <richard@users.sourceforge.net>
parents: 3968
diff changeset
2410 return self.plain(escape=1)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2411
3470
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2412 if value is None:
fd32170475f5 allow preselection of values in templating menu()s (patch [SF#1396085])
Richard Jones <richard@users.sourceforge.net>
parents: 3461
diff changeset
2413 value = self._value
5548
fea11d05110e Avoid errors from selecting "no selection" on multilink (issue2550722).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5492
diff changeset
2414 # When rendering from form contents, 'value' may contain
fea11d05110e Avoid errors from selecting "no selection" on multilink (issue2550722).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5492
diff changeset
2415 # elements starting '-' from '- no selection -' having been
fea11d05110e Avoid errors from selecting "no selection" on multilink (issue2550722).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5492
diff changeset
2416 # selected on a previous form submission.
fea11d05110e Avoid errors from selecting "no selection" on multilink (issue2550722).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5492
diff changeset
2417 value = [v for v in value if not v.startswith('-')]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2418
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2419 linkcl = self._db.getclass(self._prop.classname)
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2420
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2421 if sort_on is not None:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2422 if not isinstance(sort_on, tuple):
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2423 if sort_on[0] in '+-':
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2424 sort_on = (sort_on[0], sort_on[1:])
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2425 else:
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2426 sort_on = ('+', sort_on)
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2427 else:
4032
a73bac81eda2 Fix issue2550500
Stefan Seefeld <stefan@seefeld.name>
parents: 4010
diff changeset
2428 sort_on = ('+', linkcl.orderprop())
3363
7bc1e9c42a26 allow specification of pagesize, sorting and filtering in "classhelp" popups
Richard Jones <richard@users.sourceforge.net>
parents: 3361
diff changeset
2429
3565
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2430 options = [opt
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2431 for opt in linkcl.filter(None, conditions, sort_on)
32343bfc3da0 add permission filter to menu() implementations [SF#1431188]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3562
diff changeset
2432 if self._db.security.hasPermission("View", self._client.userid,
3594
b5b6a6f7743a fix bug in menu() permission filter [SF#1444440]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3584
diff changeset
2433 linkcl.classname, itemid=opt)]
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2434
4042
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2435 # make sure we list the current values if they're retired
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2436 for val in value:
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2437 if val not in options:
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2438 options.insert(0, val)
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2439
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2440 if not height:
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2441 height = len(options)
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2442 if value:
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2443 # The "no selection" option.
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2444 height += 1
8831882170fc Fix height calculation for Multilink.menu()
Stefan Seefeld <stefan@seefeld.name>
parents: 4040
diff changeset
2445 height = min(height, 7)
4267
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2446 l = ['<select multiple %s>'%cgi_escape_attrs(name = self._formname,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2447 size = height,
c5f52c2c9e36 Provide ability to specify arbitrary HTML attributes.
Stefan Seefeld <stefan@seefeld.name>
parents: 4233
diff changeset
2448 **html_kwargs)]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2449 k = linkcl.labelprop(1)
1322
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2450
4054
6070bc4935fa Provide a a "no selection" option; cleanup.
Stefan Seefeld <stefan@seefeld.name>
parents: 4053
diff changeset
2451 if value:
6070bc4935fa Provide a a "no selection" option; cleanup.
Stefan Seefeld <stefan@seefeld.name>
parents: 4053
diff changeset
2452 l.append('<option value="%s">- no selection -</option>'
6070bc4935fa Provide a a "no selection" option; cleanup.
Stefan Seefeld <stefan@seefeld.name>
parents: 4053
diff changeset
2453 % ','.join(['-' + v for v in value]))
1322
c0546b95aad1 finished off handling of retired flag in filter() [SF#635260]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
2454
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2455 if additional:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2456 additional_fns = []
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2457 props = linkcl.getprops()
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2458 for propname in additional:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2459 prop = props[propname]
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2460 if isinstance(prop, hyperdb.Link):
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2461 cl = self._db.getclass(prop.classname)
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2462 labelprop = cl.labelprop()
5062
2ac11cc397eb Fix arguments to 'menu cgi method
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5061
diff changeset
2463 fn = lambda optionid, cl=cl, linkcl=linkcl, \
4848
e8ae54db8b95 Fix issue2550822 (3e36a3bc0335 and 843886af0ea1) for multilinks, too
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4847
diff changeset
2464 propname=propname, labelprop=labelprop: \
e8ae54db8b95 Fix issue2550822 (3e36a3bc0335 and 843886af0ea1) for multilinks, too
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4847
diff changeset
2465 cl.get(linkcl.get(optionid, propname), labelprop)
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2466 else:
5062
2ac11cc397eb Fix arguments to 'menu cgi method
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5061
diff changeset
2467 fn = lambda optionid, linkcl=linkcl, propname=propname: \
4848
e8ae54db8b95 Fix issue2550822 (3e36a3bc0335 and 843886af0ea1) for multilinks, too
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4847
diff changeset
2468 linkcl.get(optionid, propname)
e8ae54db8b95 Fix issue2550822 (3e36a3bc0335 and 843886af0ea1) for multilinks, too
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4847
diff changeset
2469 additional_fns.append(fn)
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2470
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2471 for optionid in options:
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2472 # get the option value, and if it's None use an empty string
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2473 option = linkcl.get(optionid, k) or ''
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2474
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2475 # figure if this option is selected
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2476 s = ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2477 if optionid in value or option in value:
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
2478 s = 'selected="selected" '
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2479
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2480 # figure the label
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2481 if showid:
1079
04b44df7af1d removed some property name clashes
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
2482 lab = '%s%s: %s'%(self._prop.classname, optionid, option)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2483 else:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2484 lab = option
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2485 # truncate if it's too long
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2486 if size is not None and len(lab) > size:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2487 lab = lab[:size-3] + '...'
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2488 if additional:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2489 m = []
4053
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2490 for fn in additional_fns:
f2030089dac6 Extend "additional" parameter to work with (multi)links.
Stefan Seefeld <stefan@seefeld.name>
parents: 4052
diff changeset
2491 m.append(str(fn(optionid)))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2492 lab = lab + ' (%s)'%', '.join(m)
1169
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2493
7b448a2425fd bugfix to (multi)link menu() label generation
Richard Jones <richard@users.sourceforge.net>
parents: 1163
diff changeset
2494 # and generate
4537
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2495 tr = str
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2496 if translate:
61cd652da1cd Allow to turn off translation of generated html options in menu method...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4524
diff changeset
2497 tr = self._
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
2498 lab = html_escape(tr(lab))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2499 l.append('<option %svalue="%s">%s</option>'%(s, optionid,
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2500 lab))
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2501 l.append('</select>')
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2502 return '\n'.join(l)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2503
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2504
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2505 # set the propclasses for HTMLItem
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2506 propclasses = [
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2507 (hyperdb.String, StringHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2508 (hyperdb.Number, NumberHTMLProperty),
5067
e424987d294a Add support for an integer type to join the existing number type.
John Rouillard <rouilj@ieee.org>
parents: 5062
diff changeset
2509 (hyperdb.Integer, IntegerHTMLProperty),
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2510 (hyperdb.Boolean, BooleanHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2511 (hyperdb.Date, DateHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2512 (hyperdb.Interval, IntervalHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2513 (hyperdb.Password, PasswordHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2514 (hyperdb.Link, LinkHTMLProperty),
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2515 (hyperdb.Multilink, MultilinkHTMLProperty),
4396
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2516 ]
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2517
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2518 def register_propclass(prop, cls):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2519 for index,propclass in enumerate(propclasses):
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2520 p, c = propclass
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2521 if prop == p:
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2522 propclasses[index] = (prop, cls)
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2523 break
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2524 else:
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2525 propclasses.append((prop, cls))
172489ea9e07 allow trackers to override the classes used to render properties...
Richard Jones <richard@users.sourceforge.net>
parents: 4391
diff changeset
2526
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2527
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2528 def make_key_function(db, classname, sort_on=None):
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2529 """Make a sort key function for a given class.
4417
cc36be59ebd8 make sort more robust
Richard Jones <richard@users.sourceforge.net>
parents: 4413
diff changeset
2530
cc36be59ebd8 make sort more robust
Richard Jones <richard@users.sourceforge.net>
parents: 4413
diff changeset
2531 The list being sorted may contain mixed ids and labels.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2532 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2533 linkcl = db.getclass(classname)
1983
75437090134e implement built-in permission checks for rendered fields...
Richard Jones <richard@users.sourceforge.net>
parents: 1956
diff changeset
2534 if sort_on is None:
4032
a73bac81eda2 Fix issue2550500
Stefan Seefeld <stefan@seefeld.name>
parents: 4010
diff changeset
2535 sort_on = linkcl.orderprop()
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2536 def keyfunc(a):
4417
cc36be59ebd8 make sort more robust
Richard Jones <richard@users.sourceforge.net>
parents: 4413
diff changeset
2537 if num_re.match(a):
cc36be59ebd8 make sort more robust
Richard Jones <richard@users.sourceforge.net>
parents: 4413
diff changeset
2538 a = linkcl.get(a, sort_on)
5414
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2539 return a
3fa026621f69 Python 3 preparation: comparisons.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5404
diff changeset
2540 return keyfunc
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2541
1202
01a143f9382e *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1201
diff changeset
2542 def handleListCGIValue(value):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2543 """ Value is either a single item or a list of items. Each item has a
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2544 .value that we're actually interested in.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2545 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2546 if isinstance(value, type([])):
1202
01a143f9382e *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1201
diff changeset
2547 return [value.value for value in value]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2548 else:
1104
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
2549 value = value.value.strip()
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
2550 if not value:
d759c3cb1f06 Remeber values in edit/new submission error pages.
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
2551 return []
3972
eee76dd4a09f 'Make a Copy' failed with more than one person in nosy list [SF#1906147]
Richard Jones <richard@users.sourceforge.net>
parents: 3971
diff changeset
2552 return [v.strip() for v in value.split(',')]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2553
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
2554 class HTMLRequest(HTMLInputMixin):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2555 """The *request*, holding the CGI form and environment.
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2556
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2557 - "form" the CGI form as a cgi.FieldStorage
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2558 - "env" the CGI environment variables
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2559 - "base" the base URL for this instance
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
2560 - "user" a HTMLItem instance for this user
3968
5857cd1a0db9 add language to the "request" template var
Richard Jones <richard@users.sourceforge.net>
parents: 3936
diff changeset
2561 - "language" as determined by the browser or config
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2562 - "classname" the current classname (possibly None)
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2563 - "template" the current template (suffix, also possibly None)
1004
5f12d3259f31 logout works better now
Richard Jones <richard@users.sourceforge.net>
parents: 1003
diff changeset
2564
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2565 Index args:
1004
5f12d3259f31 logout works better now
Richard Jones <richard@users.sourceforge.net>
parents: 1003
diff changeset
2566
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2567 - "columns" dictionary of the columns to display in an index page
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2568 - "show" a convenience access to columns - request/show/colname will
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2569 be true if the columns should be displayed, false otherwise
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2570 - "sort" index sort column (direction, column name)
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2571 - "group" index grouping property (direction, column name)
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2572 - "filter" properties to filter the index on
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2573 - "filterspec" values to filter the index on
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2002
diff changeset
2574 - "search_text" text to perform a full-text search on for an index
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2575 """
3505
b294cc477f2c ZRoundup works again [SF#1263842]
Richard Jones <richard@users.sourceforge.net>
parents: 3479
diff changeset
2576 def __repr__(self):
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3710
diff changeset
2577 return '<HTMLRequest %r>'%self.__dict__
3505
b294cc477f2c ZRoundup works again [SF#1263842]
Richard Jones <richard@users.sourceforge.net>
parents: 3479
diff changeset
2578
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2579 def __init__(self, client):
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
2580 # _client is needed by HTMLInputMixin
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
2581 self._client = self.client = client
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2582
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2583 # easier access vars
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2584 self.form = client.form
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2585 self.env = client.env
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2586 self.base = client.base
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
2587 self.user = HTMLItem(client, 'user', client.userid)
3968
5857cd1a0db9 add language to the "request" template var
Richard Jones <richard@users.sourceforge.net>
parents: 3936
diff changeset
2588 self.language = client.language
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2589
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2590 # store the current class name and action
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2591 self.classname = client.classname
3584
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2592 self.nodeid = client.nodeid
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
2593 self.template = client.template
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2594
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2595 # the special char to use for special vars
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2596 self.special_char = '@'
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2597
1956
1e2cccf6b53b give access to the input() method all over the place
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
2598 HTMLInputMixin.__init__(self)
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1932
diff changeset
2599
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2600 self._post_init()
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2601
3584
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2602 def current_url(self):
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2603 url = self.base
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2604 if self.classname:
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2605 url += self.classname
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2606 if self.nodeid:
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2607 url += self.nodeid
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2608 args = {}
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2609 if self.template:
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2610 args['@template'] = self.template
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2611 return self.indexargs_url(url, args)
35b35a152b40 fix "clear this message" [SF#1429367]
Richard Jones <richard@users.sourceforge.net>
parents: 3582
diff changeset
2612
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2613 def _parse_sort(self, var, name):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2614 """ Parse sort/group options. Append to var
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2615 """
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2616 fields = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2617 dirs = []
3698
c2d232b377d5 optimize parsing of sort/group options according to suggestion...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3696
diff changeset
2618 for special in '@:':
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2619 idx = 0
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2620 key = '%s%s%d'%(special, name, idx)
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2621 while self._form_has_key(key):
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2622 self.special_char = special
4040
b6a2251394dd Make cgi.templating more fault-tolerant towards invalid requests.
Stefan Seefeld <stefan@seefeld.name>
parents: 4032
diff changeset
2623 fields.append(self.form.getfirst(key))
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2624 dirkey = '%s%sdir%d'%(special, name, idx)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2625 if dirkey in self.form:
4040
b6a2251394dd Make cgi.templating more fault-tolerant towards invalid requests.
Stefan Seefeld <stefan@seefeld.name>
parents: 4032
diff changeset
2626 dirs.append(self.form.getfirst(dirkey))
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2627 else:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2628 dirs.append(None)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2629 idx += 1
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2630 key = '%s%s%d'%(special, name, idx)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2631 # backward compatible (and query) URL format
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2632 key = special + name
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2633 dirkey = key + 'dir'
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2634 if self._form_has_key(key) and not fields:
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2635 fields = handleListCGIValue(self.form[key])
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2636 if dirkey in self.form:
4040
b6a2251394dd Make cgi.templating more fault-tolerant towards invalid requests.
Stefan Seefeld <stefan@seefeld.name>
parents: 4032
diff changeset
2637 dirs.append(self.form.getfirst(dirkey))
3698
c2d232b377d5 optimize parsing of sort/group options according to suggestion...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3696
diff changeset
2638 if fields: # only try other special char if nothing found
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2639 break
5095
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2640
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2641 # sometimes requests come in without a class
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2642 # chances are they won't have any filter params,
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2643 # in that case anyway but...
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2644 if self.classname:
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2645 cls = self.client.db.getclass(self.classname)
5399
dccae35caa59 Python 3 preparation: update map() calls as needed.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5395
diff changeset
2646 for f, d in zip_longest(fields, dirs):
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2647 if f.startswith('-'):
5094
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2648 dir, propname = '-', f[1:]
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2649 elif d:
5094
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2650 dir, propname = '-', f
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2651 else:
5094
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2652 dir, propname = '+', f
5095
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2653 # if no classname, just append the propname unchecked.
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2654 # this may be valid for some actions that bypass classes.
d3ba0b254dbb The patch to implement:
John Rouillard <rouilj@ieee.org>
parents: 5094
diff changeset
2655 if self.classname and cls.get_transitive_prop(propname) is None:
5094
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2656 self.client.add_error_message("Unknown %s property %s"%(name, propname))
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2657 else:
92d33d3125a0 Validate properties specified for sorting and grouping in index
John Rouillard <rouilj@ieee.org>
parents: 5087
diff changeset
2658 var.append((dir, propname))
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2659
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2660 def _form_has_key(self, name):
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2661 try:
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2662 return name in self.form
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2663 except TypeError:
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2664 pass
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2665 return False
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2666
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2667 def _post_init(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2668 """ Set attributes based on self.form
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2669 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2670 # extract the index display information from the form
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2671 self.columns = []
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
2672 for name in ':columns @columns'.split():
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2673 if self._form_has_key(name):
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2674 self.special_char = name[0]
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2675 self.columns = handleListCGIValue(self.form[name])
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2676 break
2983
9614a101b68f Stuff from the train ride this morning:
Richard Jones <richard@users.sourceforge.net>
parents: 2962
diff changeset
2677 self.show = support.TruthDict(self.columns)
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2678 security = self._client.db.security
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2679 userid = self._client.userid
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2680
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2681 # sorting and grouping
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2682 self.sort = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2683 self.group = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2684 self._parse_sort(self.sort, 'sort')
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2685 self._parse_sort(self.group, 'group')
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2686 self.sort = security.filterSortspec(userid, self.classname, self.sort)
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2687 self.group = security.filterSortspec(userid, self.classname, self.group)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2688
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2689 # filtering
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2690 self.filter = []
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
2691 for name in ':filter @filter'.split():
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2692 if self._form_has_key(name):
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2693 self.special_char = name[0]
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2694 self.filter = handleListCGIValue(self.form[name])
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2695
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2696 self.filterspec = {}
1200
0a7bd082b94a usability improvements in API
Richard Jones <richard@users.sourceforge.net>
parents: 1183
diff changeset
2697 db = self.client.db
1003
f89b8d32291b Hack hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 1002
diff changeset
2698 if self.classname is not None:
3635
53987aa153d2 Transitive-property support.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3610
diff changeset
2699 cls = db.getclass (self.classname)
1003
f89b8d32291b Hack hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 1002
diff changeset
2700 for name in self.filter:
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2701 if not self._form_has_key(name):
1631
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2702 continue
3635
53987aa153d2 Transitive-property support.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3610
diff changeset
2703 prop = cls.get_transitive_prop (name)
1631
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2704 fv = self.form[name]
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2705 if (isinstance(prop, hyperdb.Link) or
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2706 isinstance(prop, hyperdb.Multilink)):
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2707 self.filterspec[name] = lookupIds(db, prop,
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2708 handleListCGIValue(fv))
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2709 else:
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2710 if isinstance(fv, type([])):
8a908bbad1ef A couple of form value handling changes:
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
2711 self.filterspec[name] = [v.value for v in fv]
3461
fb82ab9461b0 fix comma-separated ID filter spec in web requests [SF#1396278]
Richard Jones <richard@users.sourceforge.net>
parents: 3401
diff changeset
2712 elif name == 'id':
fb82ab9461b0 fix comma-separated ID filter spec in web requests [SF#1396278]
Richard Jones <richard@users.sourceforge.net>
parents: 3401
diff changeset
2713 # special case "id" property
fb82ab9461b0 fix comma-separated ID filter spec in web requests [SF#1396278]
Richard Jones <richard@users.sourceforge.net>
parents: 3401
diff changeset
2714 self.filterspec[name] = handleListCGIValue(fv)
1003
f89b8d32291b Hack hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 1002
diff changeset
2715 else:
f89b8d32291b Hack hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 1002
diff changeset
2716 self.filterspec[name] = fv.value
4437
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2717 self.filterspec = security.filterFilterspec(userid, self.classname,
261c9f913ff7 - Add explicit "Search" permissions, see Security Fix below.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4417
diff changeset
2718 self.filterspec)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2719
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2720 # full-text search argument
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2721 self.search_text = None
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
2722 for name in ':search_text @search_text'.split():
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2723 if self._form_has_key(name):
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2724 self.special_char = name[0]
4040
b6a2251394dd Make cgi.templating more fault-tolerant towards invalid requests.
Stefan Seefeld <stefan@seefeld.name>
parents: 4032
diff changeset
2725 self.search_text = self.form.getfirst(name)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2726
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2727 # pagination - size and start index
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2728 # figure batch args
3158
cf824afdb76b *cough* nothing to see here
Richard Jones <richard@users.sourceforge.net>
parents: 3157
diff changeset
2729 self.pagesize = 50
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
2730 for name in ':pagesize @pagesize'.split():
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2731 if self._form_has_key(name):
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2732 self.special_char = name[0]
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2733 try:
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2734 self.pagesize = int(self.form.getfirst(name))
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2735 except ValueError:
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2736 # not an integer - ignore
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2737 pass
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2738
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2739 self.startwith = 0
1436
2f6647cf5345 bugger, dropping support for "+" special char
Richard Jones <richard@users.sourceforge.net>
parents: 1421
diff changeset
2740 for name in ':startwith @startwith'.split():
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2741 if self._form_has_key(name):
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2742 self.special_char = name[0]
4115
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2743 try:
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2744 self.startwith = int(self.form.getfirst(name))
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2745 except ValueError:
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2746 # not an integer - ignore
d61066deae67 handle bogus pagination values (issue 2550530)
Richard Jones <richard@users.sourceforge.net>
parents: 4112
diff changeset
2747 pass
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2748
3549
f6719836e521 allow dispname to be passed to renderWith [SF#1424587]
Richard Jones <richard@users.sourceforge.net>
parents: 3535
diff changeset
2749 # dispname
4804
bc4144417861 More fixes for form TypeError
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4791
diff changeset
2750 if self._form_has_key('@dispname'):
4040
b6a2251394dd Make cgi.templating more fault-tolerant towards invalid requests.
Stefan Seefeld <stefan@seefeld.name>
parents: 4032
diff changeset
2751 self.dispname = self.form.getfirst('@dispname')
3689
c28d94070403 fix: HTMLRequest.dispname must be string,
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3665
diff changeset
2752 else:
c28d94070403 fix: HTMLRequest.dispname must be string,
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3665
diff changeset
2753 self.dispname = None
3549
f6719836e521 allow dispname to be passed to renderWith [SF#1424587]
Richard Jones <richard@users.sourceforge.net>
parents: 3535
diff changeset
2754
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2755 def updateFromURL(self, url):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2756 """ Parse the URL for query args, and update my attributes using the
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2757 values.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2758 """
1693
7218be26cf85 attempt to fix query editing
Richard Jones <richard@users.sourceforge.net>
parents: 1633
diff changeset
2759 env = {'QUERY_STRING': url}
7218be26cf85 attempt to fix query editing
Richard Jones <richard@users.sourceforge.net>
parents: 1633
diff changeset
2760 self.form = cgi.FieldStorage(environ=env)
7218be26cf85 attempt to fix query editing
Richard Jones <richard@users.sourceforge.net>
parents: 1633
diff changeset
2761
1097
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2762 self._post_init()
98f3d41f41d9 query "editing" now working, minus filling the form in with the query params
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
2763
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2764 def update(self, kwargs):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2765 """ Update my attributes using the keyword args
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2766 """
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2767 self.__dict__.update(kwargs)
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2768 if 'columns' in kwargs:
2983
9614a101b68f Stuff from the train ride this morning:
Richard Jones <richard@users.sourceforge.net>
parents: 2962
diff changeset
2769 self.show = support.TruthDict(self.columns)
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2770
1061
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2771 def description(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2772 """ Return a description of the request - handle for the page title.
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2773 """
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1080
diff changeset
2774 s = [self.client.db.config.TRACKER_NAME]
1061
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2775 if self.classname:
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2776 if self.client.nodeid:
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2777 s.append('- %s%s'%(self.classname, self.client.nodeid))
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2778 else:
1123
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2779 if self.template == 'item':
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2780 s.append('- new %s'%self.classname)
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2781 elif self.template == 'index':
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2782 s.append('- %s index'%self.classname)
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2783 else:
644d3075c2df more documentation, fixed bug in request/description
Richard Jones <richard@users.sourceforge.net>
parents: 1122
diff changeset
2784 s.append('- %s %s'%(self.classname, self.template))
1061
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2785 else:
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2786 s.append('- home')
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2787 return ' '.join(s)
7f9b942128a3 nicer page title
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
2788
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2789 def __str__(self):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2790 d = {}
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2791 d.update(self.__dict__)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2792 f = ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2793 for k in self.form.keys():
1202
01a143f9382e *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1201
diff changeset
2794 f += '\n %r=%r'%(k,handleListCGIValue(self.form[k]))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2795 d['form'] = f
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2796 e = ''
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2797 for k,v in self.env.items():
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2798 e += '\n %r=%r'%(k, v)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2799 d['env'] = e
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2800 return """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2801 form: %(form)s
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2802 base: %(base)r
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2803 classname: %(classname)r
1041
c28603c9f831 Class help and generic class editing done.
Richard Jones <richard@users.sourceforge.net>
parents: 1030
diff changeset
2804 template: %(template)r
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2805 columns: %(columns)r
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2806 sort: %(sort)r
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2807 group: %(group)r
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2808 filter: %(filter)r
1016
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2809 search_text: %(search_text)r
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2810 pagesize: %(pagesize)r
d6c13142e7b9 Keep a cache of compiled PageTemplates.
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
2811 startwith: %(startwith)r
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2812 env: %(env)s
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2813 """%d
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2814
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2815 def indexargs_form(self, columns=1, sort=1, group=1, filter=1,
5082
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2816 filterspec=1, search_text=1, exclude=[]):
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2817 """ return the current index args as form elements
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2818
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2819 This routine generates an html form with hidden elements.
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2820 If you want to have visible form elements in your tal/jinja
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2821 generated templates use the exclude aray to list the names for
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2822 these elements. This wll prevent the function from creating
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2823 these elements in its output.
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2824 """
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2825 l = []
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2826 sc = self.special_char
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2827 def add(k, v):
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2828 l.append(self.input(type="hidden", name=k, value=v))
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2829 if columns and self.columns:
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2830 add(sc+'columns', ','.join(self.columns))
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2831 if sort:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2832 val = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2833 for dir, attr in self.sort:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2834 if dir == '-':
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2835 val.append('-'+attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2836 else:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2837 val.append(attr)
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2838 add(sc+'sort', ','.join (val))
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2839 if group:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2840 val = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2841 for dir, attr in self.group:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2842 if dir == '-':
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2843 val.append('-'+attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2844 else:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2845 val.append(attr)
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2846 add(sc+'group', ','.join (val))
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2847 if filter and self.filter:
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2848 add(sc+'filter', ','.join(self.filter))
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2849 if self.classname and filterspec:
4051
047402c4ec9b Handle transitive properties.
Stefan Seefeld <stefan@seefeld.name>
parents: 4043
diff changeset
2850 cls = self.client.db.getclass(self.classname)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2851 for k,v in self.filterspec.items():
5082
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2852 if k in exclude:
c1f1465d5303 issue2550683 Allow indexargs_form filter variable exclusion.
John Rouillard <rouilj@ieee.org>
parents: 5067
diff changeset
2853 continue
1353
013ae8c6c8b1 display of saved queries is now performed correctly
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1342
diff changeset
2854 if type(v) == type([]):
5184
a40ea636a2ad Issue2550934 - templating.py-indexargs_form() returns id's as space separated list not comma separated
John Rouillard <rouilj@ieee.org>
parents: 5183
diff changeset
2855 # id's are stored as strings but should be treated
a40ea636a2ad Issue2550934 - templating.py-indexargs_form() returns id's as space separated list not comma separated
John Rouillard <rouilj@ieee.org>
parents: 5183
diff changeset
2856 # as integers in lists.
a40ea636a2ad Issue2550934 - templating.py-indexargs_form() returns id's as space separated list not comma separated
John Rouillard <rouilj@ieee.org>
parents: 5183
diff changeset
2857 if (isinstance(cls.get_transitive_prop(k), hyperdb.String)
a40ea636a2ad Issue2550934 - templating.py-indexargs_form() returns id's as space separated list not comma separated
John Rouillard <rouilj@ieee.org>
parents: 5183
diff changeset
2858 and k != 'id'):
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2859 add(k, ' '.join(v))
3049
393f6ab17c07 handle spaces in String index params in batching [SF#1054224]
Richard Jones <richard@users.sourceforge.net>
parents: 3040
diff changeset
2860 else:
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2861 add(k, ','.join(v))
1353
013ae8c6c8b1 display of saved queries is now performed correctly
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1342
diff changeset
2862 else:
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2863 add(k, v)
3159
b2fc512f145d allow suppression of search_text in indexargs_form [SF#1101548]
Richard Jones <richard@users.sourceforge.net>
parents: 3158
diff changeset
2864 if search_text and self.search_text:
3782
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2865 add(sc+'search_text', self.search_text)
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2866 add(sc+'pagesize', self.pagesize)
51c07c04d258 clean up input field generation and quoting of values [SF#1615616]
Richard Jones <richard@users.sourceforge.net>
parents: 3779
diff changeset
2867 add(sc+'startwith', self.startwith)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2868 return '\n'.join(l)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2869
1124
1fc1f92c5f31 more doc, bugfix in Batch
Richard Jones <richard@users.sourceforge.net>
parents: 1123
diff changeset
2870 def indexargs_url(self, url, args):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2871 """ Embed the current index args in a URL
5192
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2872
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2873 If the value of an arg (in args dict) is None,
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2874 the argument is excluded from the url. If you want
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2875 an empty value use an empty string '' as the value.
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2876 Use this in templates to conditionally
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2877 include an arg if it is set to a value. E.G.
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2878 {..., '@queryname': request.dispname or None, ...}
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2879 will include @queryname in the url if there is a
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2880 dispname otherwise the parameter will be omitted
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2881 from the url.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2882 """
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
2883 q = urllib_.quote
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2884 sc = self.special_char
5438
e2382945d302 Python 3 preparation: avoid basestring.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5423
diff changeset
2885 l = ['%s=%s'%(k,is_us(v) and q(v) or v)
5192
302e3a1a7190 Three sets of changes:
rouilj@uland
parents: 5191
diff changeset
2886 for k,v in args.items() if v != None ]
1467
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2887 # pull out the special values (prefixed by @ or :)
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2888 specials = {}
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2889 for key in args.keys():
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2890 if key[0] in '@:':
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2891 specials[key[1:]] = args[key]
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2892
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2893 # ok, now handle the specials we received in the request
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2894 if self.columns and 'columns' not in specials:
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2895 l.append(sc+'columns=%s'%(','.join(self.columns)))
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2896 if self.sort and 'sort' not in specials:
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2897 val = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2898 for dir, attr in self.sort:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2899 if dir == '-':
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2900 val.append('-'+attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2901 else:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2902 val.append(attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2903 l.append(sc+'sort=%s'%(','.join(val)))
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2904 if self.group and 'group' not in specials:
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2905 val = []
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2906 for dir, attr in self.group:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2907 if dir == '-':
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2908 val.append('-'+attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2909 else:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2910 val.append(attr)
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
2911 l.append(sc+'group=%s'%(','.join(val)))
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2912 if self.filter and 'filter' not in specials:
1421
90bb11eb40dc oops, forgot the templating :)
Richard Jones <richard@users.sourceforge.net>
parents: 1417
diff changeset
2913 l.append(sc+'filter=%s'%(','.join(self.filter)))
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2914 if self.search_text and 'search_text' not in specials:
3104
97aec6907e69 merge from 0.7
Richard Jones <richard@users.sourceforge.net>
parents: 3068
diff changeset
2915 l.append(sc+'search_text=%s'%q(self.search_text))
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2916 if 'pagesize' not in specials:
1467
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2917 l.append(sc+'pagesize=%s'%self.pagesize)
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2918 if 'startwith' not in specials:
1467
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2919 l.append(sc+'startwith=%s'%self.startwith)
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2920
378081f066cc registration is now a two-step process with confirmation from the
Richard Jones <richard@users.sourceforge.net>
parents: 1463
diff changeset
2921 # finally, the remainder of the filter args in the request
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2922 if self.classname and self.filterspec:
3635
53987aa153d2 Transitive-property support.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3610
diff changeset
2923 cls = self.client.db.getclass(self.classname)
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2924 for k,v in self.filterspec.items():
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
2925 if k not in args:
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2926 if type(v) == type([]):
3635
53987aa153d2 Transitive-property support.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3610
diff changeset
2927 prop = cls.get_transitive_prop(k)
3909
e89bcb28f683 indexargs_url force ids to int
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3905
diff changeset
2928 if k != 'id' and isinstance(prop, hyperdb.String):
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2929 l.append('%s=%s'%(k, '%20'.join([q(i) for i in v])))
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2930 else:
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2931 l.append('%s=%s'%(k, ','.join([q(i) for i in v])))
3049
393f6ab17c07 handle spaces in String index params in batching [SF#1054224]
Richard Jones <richard@users.sourceforge.net>
parents: 3040
diff changeset
2932 else:
3068
c4e76c84f43d another fix to indexargs
Richard Jones <richard@users.sourceforge.net>
parents: 3060
diff changeset
2933 l.append('%s=%s'%(k, q(v)))
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2934 return '%s?%s'%(url, '&'.join(l))
1124
1fc1f92c5f31 more doc, bugfix in Batch
Richard Jones <richard@users.sourceforge.net>
parents: 1123
diff changeset
2935 indexargs_href = indexargs_url
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2936
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2937 def base_javascript(self):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2938 return """
5217
17b213eab274 Add nonce to embedded script references.
John Rouillard <rouilj@ieee.org>
parents: 5211
diff changeset
2939 <script nonce="%s" type="text/javascript">
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2940 submitted = false;
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2941 function submit_once() {
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2942 if (submitted) {
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2943 alert("Your request is being processed.\\nPlease be patient.");
5172
fac171f0f27b Fix submit_once Javascript function
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5166
diff changeset
2944 return false;
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2945 }
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2946 submitted = true;
5172
fac171f0f27b Fix submit_once Javascript function
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5166
diff changeset
2947 return true;
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2948 }
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2949
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2950 function help_window(helpurl, width, height) {
1204
b862bbf2067a Replaced the content() callback ickiness with Page Template macro usage
Richard Jones <richard@users.sourceforge.net>
parents: 1202
diff changeset
2951 HelpWin = window.open('%s' + helpurl, 'RoundupHelpWindow', 'scrollbars=yes,resizable=yes,toolbar=no,height='+height+',width='+width);
5006
bb97f61e1b73 Help-Window now gets focus
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4959
diff changeset
2952 HelpWin.focus ()
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2953 }
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2954 </script>
5217
17b213eab274 Add nonce to embedded script references.
John Rouillard <rouilj@ieee.org>
parents: 5211
diff changeset
2955 """%(self._client.client_nonce,self.base)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2956
4524
68bbefb72825 Allow HTMLRequest.batch to filter on other permissions than "View"...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4483
diff changeset
2957 def batch(self, permission='View'):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2958 """ Return a batch object for results from the "current search"
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2959 """
4328
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2960 check = self._client.db.security.hasPermission
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2961 userid = self._client.userid
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2962 if not check('Web Access', userid):
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2963 return Batch(self.client, [], self.pagesize, self.startwith,
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2964 classname=self.classname)
3d224f7fb364 add web access check all over templating
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
2965
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2966 filterspec = self.filterspec
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2967 sort = self.sort
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2968 group = self.group
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2969
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2970 # get the list of ids we're batching over
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2971 klass = self.client.db.getclass(self.classname)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2972 if self.search_text:
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2973 matches = self.client.db.indexer.search(
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
2974 [u2s(w.upper()) for w in re.findall(
3332
c8cdfa100a9b use unicode for index searches [SF#1195739]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3292
diff changeset
2975 r'(?u)\b\w{2,25}\b',
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5414
diff changeset
2976 s2u(self.search_text, "replace")
3332
c8cdfa100a9b use unicode for index searches [SF#1195739]
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3292
diff changeset
2977 )], klass)
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2978 else:
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
2979 matches = None
3126
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2980
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2981 # filter for visibility
a2889d22db4a the cgi templating code now checks item-level
Richard Jones <richard@users.sourceforge.net>
parents: 3117
diff changeset
2982 l = [id for id in klass.filter(matches, filterspec, sort, group)
4524
68bbefb72825 Allow HTMLRequest.batch to filter on other permissions than "View"...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4483
diff changeset
2983 if check(permission, userid, self.classname, itemid=id)]
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2984
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
2985 # return the batch object, using IDs only
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
2986 return Batch(self.client, l, self.pagesize, self.startwith,
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
2987 classname=self.classname)
1004
5f12d3259f31 logout works better now
Richard Jones <richard@users.sourceforge.net>
parents: 1003
diff changeset
2988
5f12d3259f31 logout works better now
Richard Jones <richard@users.sourceforge.net>
parents: 1003
diff changeset
2989 # extend the standard ZTUtils Batch object to remove dependency on
5f12d3259f31 logout works better now
Richard Jones <richard@users.sourceforge.net>
parents: 1003
diff changeset
2990 # Acquisition and add a couple of useful methods
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2991 class Batch(ZTUtils.Batch):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
2992 """ Use me to turn a list of items, or item ids of a given class, into a
1122
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
2993 series of batches.
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
2994
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
2995 ========= ========================================================
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
2996 Parameter Usage
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
2997 ========= ========================================================
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
2998 sequence a list of HTMLItems or item ids
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
2999 classname if sequence is a list of ids, this is the class of item
1122
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3000 size how big to make the sequence.
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3001 start where to start (0-indexed) in the sequence.
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3002 end where to end (0-indexed) in the sequence.
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3003 orphan if the next batch would contain less items than this
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3004 value, then it is combined with this batch
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3005 overlap the number of items shared between adjacent batches
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3006 ========= ========================================================
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3007
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3008 Attributes: Note that the "start" attribute, unlike the
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3009 argument, is a 1-based index (I know, lame). "first" is the
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3010 0-based index. "length" is the actual number of elements in
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3011 the batch.
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3012
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3013 "sequence_length" is the length of the original, unbatched, sequence.
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3014 """
1122
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3015 def __init__(self, client, sequence, size, start, end=0, orphan=0,
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3016 overlap=0, classname=None):
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3017 self.client = client
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3018 self.last_index = self.last_item = None
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3019 self.current_item = None
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3020 self.classname = classname
1124
1fc1f92c5f31 more doc, bugfix in Batch
Richard Jones <richard@users.sourceforge.net>
parents: 1123
diff changeset
3021 self.sequence_length = len(sequence)
1122
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3022 ZTUtils.Batch.__init__(self, sequence, size, start, end, orphan,
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3023 overlap)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3024
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3025 # overwrite so we can late-instantiate the HTMLItem instance
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3026 def __getitem__(self, index):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3027 if index < 0:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
3028 if index + self.end < self.first: raise IndexError(index)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3029 return self._sequence[index + self.end]
2327
36ae1b14aaab remove excessive spaces in the translatable strings;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2324
diff changeset
3030
1120
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3031 if index >= self.length:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
3032 raise IndexError(index)
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3033
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3034 # move the last_item along - but only if the fetched index changes
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3035 # (for some reason, index 0 is fetched twice)
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3036 if index != self.last_index:
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3037 self.last_item = self.current_item
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3038 self.last_index = index
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3039
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3040 item = self._sequence[index + self.first]
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3041 if self.classname:
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3042 # map the item ids to instances
2649
1df7d4a41da4 Buncha stuff (sorry about the large checkin):
Richard Jones <richard@users.sourceforge.net>
parents: 2640
diff changeset
3043 item = HTMLItem(self.client, self.classname, item)
1182
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3044 self.current_item = item
cb35cf3db0e0 don't create instances that aren't used
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
3045 return item
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3046
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
3047 def propchanged(self, *properties):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3048 """ Detect if one of the properties marked as being a group
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
3049 property changed in the last iteration fetch
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3050 """
3369
18f1631c9b85 sort/group by missing values correctly [SF#1198623]
Richard Jones <richard@users.sourceforge.net>
parents: 3363
diff changeset
3051 # we poke directly at the _value here since MissingValue can screw
18f1631c9b85 sort/group by missing values correctly [SF#1198623]
Richard Jones <richard@users.sourceforge.net>
parents: 3363
diff changeset
3052 # us up and cause Nones to compare strangely
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
3053 if self.last_item is None:
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
3054 return 1
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3689
diff changeset
3055 for property in properties:
4875
cdec6ed210d0 Fix batch.propchanged for transitive id properties (would result in a
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4864
diff changeset
3056 if property == 'id' or property.endswith ('.id')\
cdec6ed210d0 Fix batch.propchanged for transitive id properties (would result in a
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4864
diff changeset
3057 or isinstance (self.last_item[property], list):
3700
9cc2566cc7d9 This isn't really nice, but now grouping by transitive multilinks works.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3699
diff changeset
3058 if (str(self.last_item[property]) !=
9cc2566cc7d9 This isn't really nice, but now grouping by transitive multilinks works.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3699
diff changeset
3059 str(self.current_item[property])):
3699
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
3060 return 1
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
3061 else:
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
3062 if (self.last_item[property]._value !=
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
3063 self.current_item[property]._value):
976191d749fb grouping by ID and grouping by transitive multilinks didn't work correctly.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3698
diff changeset
3064 return 1
1002
1798d2fa9fec Hack hack...
Richard Jones <richard@users.sourceforge.net>
parents: 999
diff changeset
3065 return 0
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3066
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3067 # override these 'cos we don't have access to acquisition
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3068 def previous(self):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3069 if self.start == 1:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3070 return None
5087
39af8a0f3446 Applied patch attached to issue2550723. Problem in index page
John Rouillard <rouilj@ieee.org>
parents: 5082
diff changeset
3071 return Batch(self.client, self._sequence, self.size,
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3072 self.first - self._size + self.overlap, 0, self.orphan,
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3073 self.overlap)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3074
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3075 def next(self):
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3076 try:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3077 self._sequence[self.end]
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3078 except IndexError:
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3079 return None
5087
39af8a0f3446 Applied patch attached to issue2550723. Problem in index page
John Rouillard <rouilj@ieee.org>
parents: 5082
diff changeset
3080 return Batch(self.client, self._sequence, self.size,
985
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3081 self.end - self.overlap, 0, self.orphan, self.overlap)
55ab0c5b49f9 New CGI interface support
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3082
1120
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3083 class TemplatingUtils:
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3084 """ Utilities for templating
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3085 """
1120
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3086 def __init__(self, client):
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3087 self.client = client
1122
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3088 def Batch(self, sequence, size, start, end=0, orphan=0, overlap=0):
ddbc5d1ad94f more batching cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1120
diff changeset
3089 return Batch(self.client, sequence, size, start, end, orphan,
1120
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3090 overlap)
c26471971d18 Exposed the Batch mechanism through the top-level "utils" variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1113
diff changeset
3091
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
3092 def anti_csrf_nonce(self, lifetime=None):
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5485
diff changeset
3093 return anti_csrf_nonce(self.client, lifetime=lifetime)
5201
a9ace22e0a2f issue 2550690 - Adding anti-csrf measures to roundup following
John Rouillard <rouilj@ieee.org>
parents: 5193
diff changeset
3094
5973
fe334430ca07 issue2550919 - Anti-bot signup using 4 second delay
John Rouillard <rouilj@ieee.org>
parents: 5947
diff changeset
3095 def timestamp(self):
fe334430ca07 issue2550919 - Anti-bot signup using 4 second delay
John Rouillard <rouilj@ieee.org>
parents: 5947
diff changeset
3096 return pack_timestamp()
fe334430ca07 issue2550919 - Anti-bot signup using 4 second delay
John Rouillard <rouilj@ieee.org>
parents: 5947
diff changeset
3097
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
3098 def url_quote(self, url):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3099 """URL-quote the supplied text."""
5402
88dbacd11cd1 Python 3 preparation: update urllib / urllib2 / urlparse imports.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5399
diff changeset
3100 return urllib_.quote(url)
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
3101
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
3102 def html_quote(self, html):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3103 """HTML-quote the supplied text."""
5800
1a835db41674 Call cgi.escape only on python 2. Replace with html.escapeif it can be
John Rouillard <rouilj@ieee.org>
parents: 5684
diff changeset
3104 return html_escape(html)
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2170
diff changeset
3105
2640
b01eca163779 The "type" parameter is supposed to be optional
Richard Jones <richard@users.sourceforge.net>
parents: 2637
diff changeset
3106 def __getattr__(self, name):
3842
310e315624b1 Change ''' into """ to work around bug in Emacs' syntax highlighting code.
Erik Forsberg <forsberg@users.sourceforge.net>
parents: 3832
diff changeset
3107 """Try the tracker's templating_utils."""
2640
b01eca163779 The "type" parameter is supposed to be optional
Richard Jones <richard@users.sourceforge.net>
parents: 2637
diff changeset
3108 if not hasattr(self.client.instance, 'templating_utils'):
b01eca163779 The "type" parameter is supposed to be optional
Richard Jones <richard@users.sourceforge.net>
parents: 2637
diff changeset
3109 # backwards-compatibility
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
3110 raise AttributeError(name)
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
3111 if name not in self.client.instance.templating_utils:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
3112 raise AttributeError(name)
3006
50b0f8e98247 fix API for templating utils extensions - remove "utils" arg
Richard Jones <richard@users.sourceforge.net>
parents: 2994
diff changeset
3113 return self.client.instance.templating_utils[name]
2640
b01eca163779 The "type" parameter is supposed to be optional
Richard Jones <richard@users.sourceforge.net>
parents: 2637
diff changeset
3114
4466
f1fe6fd0aa61 Multilinks can be filtered by combining elements with AND, OR and NOT now.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4463
diff changeset
3115 def keywords_expressions(self, request):
f1fe6fd0aa61 Multilinks can be filtered by combining elements with AND, OR and NOT now.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4463
diff changeset
3116 return render_keywords_expression_editor(request)
f1fe6fd0aa61 Multilinks can be filtered by combining elements with AND, OR and NOT now.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4463
diff changeset
3117
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3118 def html_calendar(self, request):
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3119 """Generate a HTML calendar.
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3120
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3121 `request` the roundup.request object
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3122 - @template : name of the template
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3123 - form : name of the form to store back the date
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3124 - property : name of the property of the form to store
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3125 back the date
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3126 - date : current date
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3127 - display : when browsing, specifies year and month
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3128
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3129 html will simply be a table.
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3130 """
4333
0693f1ff2571 fix typo
Richard Jones <richard@users.sourceforge.net>
parents: 4331
diff changeset
3131 tz = request.client.db.getUserTimezone()
4331
7327b102920f Display 'today' in the account user's timezone, thanks David Wolever
Richard Jones <richard@users.sourceforge.net>
parents: 4329
diff changeset
3132 current_date = date.Date(".").local(tz)
7327b102920f Display 'today' in the account user's timezone, thanks David Wolever
Richard Jones <richard@users.sourceforge.net>
parents: 4329
diff changeset
3133 date_str = request.form.getfirst("date", current_date)
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3134 display = request.form.getfirst("display", date_str)
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3135 template = request.form.getfirst("@template", "calendar")
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3136 form = request.form.getfirst("form")
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3137 property = request.form.getfirst("property")
5191
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3138 curr_date = ""
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3139 try:
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3140 # date_str and display can be set to an invalid value
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3141 # if user submits a value like "d4" and gets an edit error.
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3142 # If either or both invalid just ignore that we can't parse it
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3143 # and assign them to today.
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3144 curr_date = date.Date(date_str) # to highlight
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3145 display = date.Date(display) # to show
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3146 except ValueError:
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3147 # we couldn't parse the date
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3148 # just let the calendar display
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3149 curr_date = current_date
fe52cab8f5b5 issue2550932 - html_calendar produces templating errors for bad date strings
John Rouillard <rouilj@ieee.org>
parents: 5190
diff changeset
3150 display = current_date
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3151 day = display.day
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3152
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3153 # for navigation
4651
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3154 try:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3155 date_prev_month = display + date.Interval("-1m")
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3156 except ValueError:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3157 date_prev_month = None
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3158 try:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3159 date_next_month = display + date.Interval("+1m")
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3160 except ValueError:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3161 date_next_month = None
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3162 try:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3163 date_prev_year = display + date.Interval("-1y")
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3164 except ValueError:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3165 date_prev_year = None
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3166 try:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3167 date_next_year = display + date.Interval("+1y")
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3168 except ValueError:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3169 date_next_year = None
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3170
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3171 res = []
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3172
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3173 base_link = "%s?@template=%s&property=%s&form=%s&date=%s" % \
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3174 (request.classname, template, property, form, curr_date)
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3175
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3176 # navigation
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3177 # month
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3178 res.append('<table class="calendar"><tr><td>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3179 res.append(' <table width="100%" class="calendar_nav"><tr>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3180 link = "&display=%s"%date_prev_month
4651
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3181 if date_prev_month:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3182 res.append(' <td><a href="%s&display=%s">&lt;</a></td>'
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3183 % (base_link, date_prev_month))
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3184 else:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3185 res.append(' <td></td>')
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3186 res.append(' <td>%s</td>'%calendar.month_name[display.month])
4651
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3187 if date_next_month:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3188 res.append(' <td><a href="%s&display=%s">&gt;</a></td>'
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3189 % (base_link, date_next_month))
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3190 else:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3191 res.append(' <td></td>')
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3192 # spacer
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3193 res.append(' <td width="100%"></td>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3194 # year
4651
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3195 if date_prev_year:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3196 res.append(' <td><a href="%s&display=%s">&lt;</a></td>'
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3197 % (base_link, date_prev_year))
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3198 else:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3199 res.append(' <td></td>')
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3200 res.append(' <td>%s</td>'%display.year)
4651
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3201 if date_next_year:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3202 res.append(' <td><a href="%s&display=%s">&gt;</a></td>'
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3203 % (base_link, date_next_year))
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3204 else:
beb8d43f4d9d issue2550765: Don't show links in calendar that will fail. Found and fixed by Cédric Krier.
Bernhard Reiter <bernhard@intevation.de>
parents: 4647
diff changeset
3205 res.append(' <td></td>')
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3206 res.append(' </tr></table>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3207 res.append(' </td></tr>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3208
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3209 # the calendar
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3210 res.append(' <tr><td><table class="calendar_display">')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3211 res.append(' <tr class="weekdays">')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3212 for day in calendar.weekheader(3).split():
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3213 res.append(' <td>%s</td>'%day)
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3214 res.append(' </tr>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3215 for week in calendar.monthcalendar(display.year, display.month):
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3216 res.append(' <tr>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3217 for day in week:
5180
f95650727b1c got the indent wrong in the last change for templating.py
John Rouillard <rouilj@ieee.org>
parents: 5179
diff changeset
3218 link = "javascript:form[field].value = '%d-%02d-%02d'; " \
f95650727b1c got the indent wrong in the last change for templating.py
John Rouillard <rouilj@ieee.org>
parents: 5179
diff changeset
3219 "if ('createEvent' in document) { var evt = document.createEvent('HTMLEvents'); evt.initEvent('change', true, true); form[field].dispatchEvent(evt); } else { form[field].fireEvent('onchange'); }" \
f95650727b1c got the indent wrong in the last change for templating.py
John Rouillard <rouilj@ieee.org>
parents: 5179
diff changeset
3220 "window.close ();"%(display.year, display.month, day)
3292
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3221 if (day == curr_date.day and display.month == curr_date.month
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3222 and display.year == curr_date.year):
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3223 # highlight
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3224 style = "today"
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3225 else :
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3226 style = ""
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3227 if day:
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3228 res.append(' <td class="%s"><a href="%s">%s</a></td>'%(
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3229 style, link, day))
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3230 else :
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3231 res.append(' <td></td>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3232 res.append(' </tr>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3233 res.append('</table></td></tr></table>')
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3234 return "\n".join(res)
8c7b522dc934 added date selection popup windows (thanks Marcus Priesch)
Richard Jones <richard@users.sourceforge.net>
parents: 3280
diff changeset
3235
4878
f6e76a03b502 HTML* classes for cgi are now all new-style
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4875
diff changeset
3236 class MissingValue(object):
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3237 def __init__(self, description, **kwargs):
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3238 self.__description = description
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3239 for key, value in kwargs.items():
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3240 self.__dict__[key] = value
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3241
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3242 def __call__(self, *args, **kwargs): return MissingValue(self.__description)
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3243 def __getattr__(self, name):
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3244 # This allows assignments which assume all intermediate steps are Null
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3245 # objects if they don't exist yet.
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3246 #
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3247 # For example (with just 'client' defined):
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3248 #
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3249 # client.db.config.TRACKER_WEB = 'BASE/'
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3250 self.__dict__[name] = MissingValue(self.__description)
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3251 return getattr(self, name)
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3252
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3253 def __getitem__(self, key): return self
5457
a35d4cc8cd1a fix MissingValue / MockNull to return False on __bool__ and add a
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5448
diff changeset
3254 def __bool__(self): return False
5404
3757449e00c4 Python 3 preparation: use __bool__ instead of __nonzero__.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5402
diff changeset
3255 # Python 2 compatibility:
3757449e00c4 Python 3 preparation: use __bool__ instead of __nonzero__.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5402
diff changeset
3256 __nonzero__ = __bool__
5457
a35d4cc8cd1a fix MissingValue / MockNull to return False on __bool__ and add a
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5448
diff changeset
3257 def __contains__(self, key): return False
5461
ad8031290639 Python 3 compatibility for missing / mock value
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5457
diff changeset
3258 def __eq__(self, rhs): return False
ad8031290639 Python 3 compatibility for missing / mock value
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5457
diff changeset
3259 def __ne__(self, rhs): return False
3164
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3260 def __str__(self): return '[%s]'%self.__description
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3261 def __repr__(self): return '<MissingValue 0x%x "%s">'%(id(self),
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3262 self.__description)
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3263 def gettext(self, str): return str
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3264 _ = gettext
24476db8872f nicer error looking up values of None (response to [SF#1108697])
Richard Jones <richard@users.sourceforge.net>
parents: 3159
diff changeset
3265
2561
0dd3dca6bd01 always use translation service set in the tracker client instance;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2558
diff changeset
3266 # vim: set et sts=4 sw=4 :
Roundup Issue Tracker: http://roundup-tracker.org/