1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
# pylint: disable-msg=E0211
"""Single selection widget using a popup to select one item from many."""
__metaclass__ = type
import cgi
import simplejson
from z3c.ptcompat import ViewPageTemplateFile
from zope.app.form.browser.itemswidgets import (
ItemsWidgetBase,
SingleDataHelper,
)
from zope.schema.interfaces import IChoice
from canonical.launchpad.webapp import canonical_url
from lp.app.browser.stringformatter import FormattersAPI
from lp.app.browser.vocabulary import get_person_picker_entry_metadata
from lp.services.features import getFeatureFlag
from lp.services.propertycache import cachedproperty
class VocabularyPickerWidget(SingleDataHelper, ItemsWidgetBase):
"""Wrapper for the lazr-js picker/picker.js widget."""
__call__ = ViewPageTemplateFile('templates/form-picker.pt')
picker_type = 'default'
# Provide default values for the following properties in case someone
# creates a vocab picker for a person instead of using the derived
# PersonPicker.
show_assign_me_button = 'false'
show_remove_button = 'false'
assign_me_text = 'Pick me'
remove_person_text = 'Remove person'
remove_team_text = 'Remove team'
popup_name = 'popup-vocabulary-picker'
# Override inherited attributes for the form field.
displayWidth = '20'
displayMaxWidth = ''
default = ''
onKeyPress = ''
style = ''
cssClass = ''
step_title = None
# Defaults to self.vocabulary.displayname.
header = None
@cachedproperty
def matches(self):
"""Return a list of matches (as ITokenizedTerm) to whatever the
user currently has entered in the form.
"""
# Pull form value using the parent class to avoid loop
formValue = super(VocabularyPickerWidget, self)._getFormInput()
if not formValue:
return []
vocab = self.vocabulary
# Special case - if the entered value is valid, it is an object
# rather than a string (I think this is a bug somewhere)
if not isinstance(formValue, basestring):
return [vocab.getTerm(formValue)]
search_results = vocab.searchForTerms(formValue)
if search_results.count() > 25:
# If we have too many results to be useful in a list, return
# an empty list.
return []
return search_results
@cachedproperty
def formToken(self):
val = self._getFormValue()
# We have a valid object - return the corresponding token
if not isinstance(val, basestring):
return self.vocabulary.getTerm(val).token
# Just return the existing invalid token
return val
def inputField(self):
d = {
'formToken': cgi.escape(self.formToken, quote=True),
'name': self.input_id,
'displayWidth': self.displayWidth,
'displayMaxWidth': self.displayMaxWidth,
'onKeyPress': self.onKeyPress,
'style': self.style,
'cssClass': self.cssClass,
}
return """<input type="text" value="%(formToken)s" id="%(name)s"
name="%(name)s" size="%(displayWidth)s"
maxlength="%(displayMaxWidth)s"
onKeyPress="%(onKeyPress)s" style="%(style)s"
class="%(cssClass)s" />""" % d
@property
def selected_value_metadata(self):
return None
@property
def show_widget_id(self):
return 'show-widget-%s' % self.input_id.replace('.', '-')
@property
def config(self):
return dict(
picker_type=self.picker_type,
selected_value_metadata=self.selected_value_metadata,
header=self.header_text, step_title=self.step_title_text,
extra_no_results_message=self.extra_no_results_message,
assign_me_text=self.assign_me_text,
remove_person_text=self.remove_person_text,
remove_team_text=self.remove_team_text,
show_remove_button=self.show_remove_button,
show_assign_me_button=self.show_assign_me_button)
@property
def json_config(self):
return simplejson.dumps(self.config)
@property
def extra_no_results_message(self):
"""Extra message when there are no results.
Override this in subclasses.
:return: A string that will be passed to Y.Node.create()
so it needs to be contained in a single HTML element.
"""
return simplejson.dumps(None)
@property
def vocabulary_name(self):
"""The name of the field's vocabulary."""
choice = IChoice(self.context)
if choice.vocabularyName is None:
# The webservice that provides the results of the search
# must be passed in the name of the vocabulary which is looked
# up by the vocabulary registry.
raise ValueError(
"The %r.%s interface attribute doesn't have its "
"vocabulary specified as a string, so it can't be loaded "
"by the vocabulary registry."
% (choice.context, choice.__name__))
return choice.vocabularyName
@property
def header_text(self):
return simplejson.dumps(self.header or self.vocabulary.displayname)
@property
def step_title_text(self):
return simplejson.dumps(self.step_title or self.vocabulary.step_title)
@property
def input_id(self):
"""This is used to ensure the widget id contains only valid chars."""
return FormattersAPI(self.name).zope_css_id()
def chooseLink(self):
if self.nonajax_uri is None:
css = 'unseen'
else:
css = ''
return ('<span class="%s">(<a id="%s" href="%s">'
'Find…</a>)</span>') % (
css, self.show_widget_id, self.nonajax_uri or '#')
@property
def nonajax_uri(self):
"""Override in subclass to specify a non-AJAX URI for the Find link.
If None is returned, the find link will be hidden.
"""
return None
class PersonPickerWidget(VocabularyPickerWidget):
include_create_team_link = False
show_assign_me_button = 'true'
show_remove_button = 'true'
@property
def picker_type(self):
# This is a method for now so we can block the use of the new
# person picker js behind our picker_enhancments feature flag.
if bool(getFeatureFlag('disclosure.picker_enhancements.enabled')):
picker_type = 'person'
else:
picker_type = 'default'
return picker_type
@property
def selected_value_metadata(self):
val = self._getFormValue()
return get_person_picker_entry_metadata(val)
def chooseLink(self):
link = super(PersonPickerWidget, self).chooseLink()
if self.include_create_team_link:
link += ('or (<a href="/people/+newteam">'
'Create a new team…</a>)')
return link
@property
def nonajax_uri(self):
return '/people/'
class BugTrackerPickerWidget(VocabularyPickerWidget):
__call__ = ViewPageTemplateFile('templates/bugtracker-picker.pt')
link_template = """
or (<a id="create-bugtracker-link"
href="/bugs/bugtrackers/+newbugtracker"
>Register an external bug tracker…</a>)
"""
def chooseLink(self):
link = super(BugTrackerPickerWidget, self).chooseLink()
link += self.link_template
return link
@property
def nonajax_uri(self):
return '/bugs/bugtrackers/'
class SearchForUpstreamPopupWidget(VocabularyPickerWidget):
"""A SinglePopupWidget with a custom error message.
This widget is used only when searching for an upstream that is also
affected by a given bug as the page it links to includes a link which
allows the user to register the upstream if it doesn't exist.
"""
@property
def extra_no_results_message(self):
return simplejson.dumps("<strong>Didn't find the project you were "
"looking for? "
'<a href="%s/+affects-new-product">Register it</a>.</strong>'
% canonical_url(self.context.context))
|