ListBox.py 126 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3 4
# Copyright (c) 2002,2006 Nexedi SARL and Contributors. All Rights Reserved.
#                    Yoshinori Okuji <yo@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6
#
# WARNING: This program as such is intended to be used by professional
7
# programmers who take the whole responsibility of assessing all potential
Jean-Paul Smets's avatar
Jean-Paul Smets committed
8 9
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
10
# guarantees and support are strongly adviced to contract a Free Software
Jean-Paul Smets's avatar
Jean-Paul Smets committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

Yoshinori Okuji's avatar
Yoshinori Okuji committed
29
import sys
30
from OFS.Traversable import NotFound
31
from AccessControl import ClassSecurityInfo, Unauthorized
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33 34
from Products.Formulator.DummyField import fields
from Products.Formulator import Widget, Validator
from Products.Formulator.Field import ZMIField
35
from Products.Formulator.Errors import FormValidationError, ValidationError
36
from Selection import Selection, DomainSelection
37
from Tool.SelectionTool import createFolderMixInPageSelectionMethod
Yoshinori Okuji's avatar
Yoshinori Okuji committed
38
from Products.ERP5Type.Utils import getPath
39
from Products.ERP5Type.Utils import UpperCase
40
from Products.ERP5Type.Document import newTempBase
41
from Products.CMFCore.utils import getToolByName
42
from Products.ZSQLCatalog.zsqlbrain import ZSQLBrain
43
from Products.ERP5Type.Message import Message
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

45
from Acquisition import aq_base, aq_self, aq_inner
46
import Acquisition
Jérome Perrin's avatar
Jérome Perrin committed
47
from zLOG import LOG, WARNING
Yoshinori Okuji's avatar
Yoshinori Okuji committed
48
from ZODB.POSException import ConflictError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49

50
from Products.ERP5Type.Globals import InitializeClass, get_request
51
from Products.PythonScripts.Utility import allow_class
52
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
53
from warnings import warn
54
import cgi
55

56
DEFAULT_LISTBOX_DISPLAY_STYLE = 'table'
57 58
DEFAULT_LISTBOX_PAGE_NAVIGATION_TEMPLATE = 'ListBox_viewSliderPageNavigationRenderer'
DEFAULT_LISTBOX_PAGE_TEMPLATE = 'ListBox_asHTML'
59

60
class MethodWrapper:
61
  def __init__(self, context, method_name):
62
    self.context = context
63
    self.method_name = self.__name__ = method_name
64

65 66 67 68 69 70
  def __call__(self, *args, **kw):
    raise NotImplementedError

class ListMethodWrapper(MethodWrapper):
  """This class wraps list methods so that they behave like portal_catalog.
  """
71 72
  def __call__(self, *args, **kw):
    brain_list = []
73
    for obj in getattr(self.context, self.method_name)(*args, **kw):
74 75 76 77 78 79
      brain = ZSQLBrain(None, None).__of__(obj)
      brain.uid = obj.getUid()
      brain.path = obj.getPath()
      brain_list.append(brain)
    return brain_list

80 81 82 83 84 85
class CatalogMethodWrapper(MethodWrapper):
  """This class wraps catalog list methods so that they discard a pre-defined
     set of parameters which are part of the Selection API but not in
     SQLCatalog API.
  """
  def __call__(self, *args, **kw):
86
    for parameter_id in ('selection', 'selection_name', 'select_columns',
87
      'reset', 'selection_index', 'list_selection_name', 'list_start',
88
      'list_lines', 'listbox_list_start', 'listbox_uid', 'listbox_nextPage',
89
      'listbox_previousPage', 'listbox_page_start', 'page_start',
90 91 92 93
      # Also strip common HTML field names
      # XXX: I'm not sure if those values really belong to here
      'md5_object_uid_list', 'cancel_url', 'listbox_list_selection_name',
      'form_id', 'select_language', 'select_favorite', 'select_module',
94
      'portal_status_message', 'all_languages',
95
      'select_jump', 'select_action', 'Base_doSelect'):
96
      kw.pop(parameter_id, None)
97 98 99 100 101 102
    # Strip all entries which have an empty string as value (ie, an empty
    # field).
    # XXX: I'm not sure if this filtering really belongs to here.
    # It is probably needed at a more generic level (Forms ? Selection ?), or
    # even a more specific one (limited to HTML ?)...
    for key, value in kw.items():
103
      if value == '':
104
        kw.pop(key)
105 106
    return getattr(self.context, self.method_name)(*args, **kw)

107 108
class ReportTree:
  """This class describes a report tree.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109
  """
110
  def __init__(self, obj = None, is_pure_summary = False, depth = 0, is_open = False,
111
               selection_domain = None, exception_uid_list = None, base_category = None):
112 113 114 115
    self.obj = obj
    self.is_pure_summary = is_pure_summary
    self.depth = depth
    self.is_open = is_open
116
    self.selection_domain = selection_domain
117 118 119
    self.exception_uid_list = exception_uid_list
    if exception_uid_list is None:
      self.exception_uid_set = None
120
    else:
121
      self.exception_uid_set = set(exception_uid_list)
122
    self.base_category = base_category
Jean-Paul Smets's avatar
Jean-Paul Smets committed
123

124 125 126 127 128 129
    relative_url = obj.getRelativeUrl()
    if base_category is not None and not relative_url.startswith(base_category + '/'):
      self.domain_url = '%s/%s' % (base_category, relative_url)
    else:
      self.domain_url = relative_url

130 131
allow_class(ReportTree)

132 133 134 135
class ReportSection:
  """This class describes a report section.
  """
  def __init__(self, is_summary = False, object_list = (), object_list_len = 0,
136
               is_open = False, selection_domain = None, context = None, offset = 0,
137
               depth = 0, domain_title = None):
138 139 140 141
    self.is_summary = is_summary
    self.object_list = object_list
    self.object_list_len = object_list_len
    self.is_open = is_open
142
    self.selection_domain = selection_domain
143 144 145
    self.context = context
    self.offset = offset
    self.depth = depth
146
    self.domain_title = domain_title
Jean-Paul Smets's avatar
Jean-Paul Smets committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170

class ListBoxWidget(Widget.Widget):
    """
        ListBox widget

        The ListBox widget allows to display a collection of objects in a form.
        The ListBox widget can be used for many applications:

        1- show the content of a folder by providing a list of meta_types
           and eventually a sort order

        2- show the content of a relation by providing the name of the relation,
           a list of meta_types and eventually a sort order

        3- show the result of a search request by selecting a query and
           providing parameters for that query (and eventually a sort order)

        In all 3 cases, a parameter to hold the current start item must be
        stored somewhere, typically in a selection object.

        Parameters in case 3 should stored in a selection object which allows a per user
        per PC storage.

    """
171 172 173 174 175
    # Define Properties for ListBoxWidget.
    property_names = list(Widget.Widget.property_names)

    # Default has no meaning in ListBox.
    property_names.remove('default')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
176 177 178 179 180

    lines = fields.IntegerField('lines',
                                title='Lines',
                                description=(
        "The number of lines of this list. Required."),
181
                                default=20,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
182
                                required=1)
183
    property_names.append('lines')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184 185 186 187 188 189 190

    columns = fields.ListTextAreaField('columns',
                                 title="Columns",
                                 description=(
        "A list of attributes names to display. Required."),
                                 default=[],
                                 required=1)
191
    property_names.append('columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193 194 195 196 197 198

    all_columns = fields.ListTextAreaField('all_columns',
                                 title="More Columns",
                                 description=(
        "An optional list of attributes names to display."),
                                 default=[],
                                 required=0)
199
    property_names.append('all_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
200

201 202 203 204 205 206 207 208
    style_columns = fields.ListTextAreaField('style_columns',
                                 title="List Style Columns",
                                 description=(
        "An optional list of list style columns to display."),
                                 default=[],
                                 required=0)
    property_names.append('style_columns')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
209 210 211 212 213 214
    search_columns = fields.ListTextAreaField('search_columns',
                                 title="Searchable Columns",
                                 description=(
        "An optional list of columns to search."),
                                 default=[],
                                 required=0)
215
    property_names.append('search_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
216

217 218 219 220 221 222
    sort_columns = fields.ListTextAreaField('sort_columns',
                                 title="Sortable Columns",
                                 description=(
        "An optional list of columns to sort."),
                                 default=[],
                                 required=0)
223
    property_names.append('sort_columns')
224

Jean-Paul Smets's avatar
Jean-Paul Smets committed
225 226 227 228 229
    sort = fields.ListTextAreaField('sort',
                                 title='Default Sort',
                                 description=('The default sort keys and order'),
                                 default=[],
                                 required=0)
230
    property_names.append('sort')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
231 232 233

    list_method = fields.MethodField('list_method',
                                 title='List Method',
Jérome Perrin's avatar
Jérome Perrin committed
234
                                 description=('The method to use to list '
Jean-Paul Smets's avatar
Jean-Paul Smets committed
235 236 237
                                              'objects'),
                                 default='',
                                 required=0)
238
    property_names.append('list_method')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239

240 241
    count_method = fields.MethodField('count_method',
                                 title='Count Method',
Jérome Perrin's avatar
Jérome Perrin committed
242
                                 description=('The method to use to count '
243 244 245
                                              'objects'),
                                 default='',
                                 required=0)
246
    property_names.append('count_method')
247

Jean-Paul Smets's avatar
Jean-Paul Smets committed
248 249
    stat_method = fields.MethodField('stat_method',
                                 title='Stat Method',
Jérome Perrin's avatar
Jérome Perrin committed
250
                                 description=('The method to use to stat '
Jean-Paul Smets's avatar
Jean-Paul Smets committed
251 252 253
                                              'objects'),
                                 default='',
                                 required=0)
254
    property_names.append('stat_method')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
255

256 257
    row_css_method = fields.MethodField('row_css_method',
                                 title='Row CSS Method',
Jérome Perrin's avatar
Jérome Perrin committed
258 259
                                 description=('The method to set the css '
                                              'class name of a row'),
260 261 262 263
                                 default='',
                                 required=0)
    property_names.append('row_css_method')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
264 265
    selection_name = fields.StringField('selection_name',
                                 title='Selection Name',
Jérome Perrin's avatar
Jérome Perrin committed
266 267
                                 description=('The name of the selection to '
                                              'store selection parameters'),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
268
                                 default='',
269
                                 required=0)
270
    property_names.append('selection_name')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
271 272 273 274

    meta_types = fields.ListTextAreaField('meta_types',
                                 title="Meta Types",
                                 description=(
Jérome Perrin's avatar
Jérome Perrin committed
275
        "Meta Types of objects to list."),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
276 277
                                 default=[],
                                 required=0)
278
    property_names.append('meta_types')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
279 280 281 282

    portal_types = fields.ListTextAreaField('portal_types',
                                 title="Portal Types",
                                 description=(
Jérome Perrin's avatar
Jérome Perrin committed
283
        "Portal Types of objects to list."),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
284 285
                                 default=[],
                                 required=0)
286
    property_names.append('portal_types')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
287 288 289 290 291 292 293

    default_params = fields.ListTextAreaField('default_params',
                                 title="Default Parameters",
                                 description=(
        "Default Parameters for the List Method."),
                                 default=[],
                                 required=0)
294
    property_names.append('default_params')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295 296 297 298

    search = fields.CheckBoxField('search',
                                 title='Search Row',
                                 description=('Search Row'),
299
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
300
                                 required=0)
301
    property_names.append('search')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
302 303 304 305

    select = fields.CheckBoxField('select',
                                 title='Select Column',
                                 description=('Select Column'),
306
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
307
                                 required=0)
308
    property_names.append('select')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
309

310 311 312 313
    anchor = fields.CheckBoxField('anchor',
                                  title='Anchor Column',
                                  description=(
      'An optional anchor column which can always clickable.'),
314
                                  default=0,
315 316 317
                                  required=0)
    property_names.append('anchor')

Jérome Perrin's avatar
Jérome Perrin committed
318 319 320 321 322 323 324
    hide_rows_on_no_search_criterion = fields.CheckBoxField(
                                 'hide_rows_on_no_search_criterion',
                                 title='Hide Rows (On No Search Criterion)',
                                 description=('Hide listbox rows if no search '
                                             'criterion is provided by user'),
                                                default=0,
                                                required=0)
325 326
    property_names.append('hide_rows_on_no_search_criterion')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
327 328 329 330 331 332
    editable_columns = fields.ListTextAreaField('editable_columns',
                                 title="Editable Columns",
                                 description=(
        "An optional list of columns which can be modified."),
                                 default=[],
                                 required=0)
333
    property_names.append('editable_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
334

335 336 337 338 339 340
    stat_columns = fields.ListTextAreaField('stat_columns',
                                 title="Stat Columns",
                                 description=(
        "An optional list of columns which can be used for statistics."),
                                 default=[],
                                 required=0)
341
    property_names.append('stat_columns')
342 343 344 345 346 347 348

    url_columns = fields.ListTextAreaField('url_columns',
                                 title="URL Columns",
                                 description=(
        "An optional list of columns which can provide a custom URL."),
                                 default=[],
                                 required=0)
349
    property_names.append('url_columns')
350

351 352 353 354 355 356 357 358
    untranslatable_columns = fields.ListTextAreaField('untranslatable_columns',
                                 title="Untranslatable Columns",
                                 description=(
        "An optional list of columns titles which should not be translated."),
                                 default=[],
                                 required=0)
    property_names.append('untranslatable_columns')

359
    # XXX do we still need this?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
360 361 362
    global_attributes = fields.ListTextAreaField('global_attributes',
                                 title="Global Attributes",
                                 description=(
Jérome Perrin's avatar
Jérome Perrin committed
363 364
        "An optional list of attributes which are set by hidden fields and "
        "which are applied to each editable column."),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
365 366
                                 default=[],
                                 required=0)
367
    property_names.append('global_attributes')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
368 369 370 371

    domain_tree = fields.CheckBoxField('domain_tree',
                                 title='Domain Tree',
                                 description=('Selection Tree'),
372
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
373
                                 required=0)
374
    property_names.append('domain_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375 376 377 378 379 380 381

    domain_root_list = fields.ListTextAreaField('domain_root_list',
                                 title="Domain Root",
                                 description=(
        "A list of domains which define the possible root."),
                                 default=[],
                                 required=0)
382
    property_names.append('domain_root_list')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383 384 385 386

    report_tree = fields.CheckBoxField('report_tree',
                                 title='Report Tree',
                                 description=('Report Tree'),
387
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
388
                                 required=0)
389
    property_names.append('report_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
390 391 392 393 394 395 396

    report_root_list = fields.ListTextAreaField('report_root_list',
                                 title="Report Root",
                                 description=(
        "A list of domains which define the possible root."),
                                 default=[],
                                 required=0)
397
    property_names.append('report_root_list')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
398

399 400 401 402 403 404 405 406
    display_style_list = fields.ListTextAreaField('display_style_list',
                                title="Display style",
                                description=(
        "A list of styles which change the listbox rendering."),
                                default=[],
                                required=0)
    property_names.append('display_style_list')

407 408 409 410
    default_display_style = fields.StringField('default_display_style',
                                title="Default display style",
                                description=(
        "A default display style for listbox rendering."),
411
                                default=DEFAULT_LISTBOX_DISPLAY_STYLE,
412 413 414
                                required=0)
    property_names.append('default_display_style')

415 416 417
    global_search_column = fields.StringField('global_search_column',
                                title="Global search column",
                                description=("Global search column make query."),
418 419
                                default=None,
                                required=0)
420
    property_names.append('global_search_column')
421

422 423 424 425
    page_navigation_template = fields.StringField('page_navigation_template',
                                title="Page Navigation Template",
                                description=("Page Navigation Template used to render listbox page navigation."),
                                default=DEFAULT_LISTBOX_PAGE_NAVIGATION_TEMPLATE,
426
                                required=0)
427
    property_names.append('page_navigation_template')
428

Jean-Paul Smets's avatar
Jean-Paul Smets committed
429 430 431
    list_action = fields.StringField('list_action',
                                 title='List Action',
                                 description=('The id of the object action'
432
                                              ' to display the current list'),
433
                                 default='',
434
                                 required=0)
435
    property_names.append('list_action')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
436

437 438 439 440 441 442 443 444
    page_template = fields.StringField('page_template',
                                 title='Page Template',
                                 description=('The id of a Page Template'
                                              ' to render the ListBox'),
                                 default='',
                                 required=0)
    property_names.append('page_template')

445
    def render_view(self, field, value, REQUEST=None, render_format='html', key='listbox', render_prefix=None):
446
        """
447
          Render a ListBox in read-only.
448
        """
449
        if REQUEST is None: REQUEST=get_request()
450 451
        return self.render(field, key, value, REQUEST, render_format=render_format,
                           render_prefix=render_prefix)
452

453 454
    def render(self, field, key, value, REQUEST, render_format='html',
               render_prefix=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
455 456 457
        """
          This is where most things happen. This method renders a list
          of items
458

Jean-Paul Smets's avatar
Jean-Paul Smets committed
459 460 461
          render_format allows to produce either HTML (default)
          or produce a generic 'list' format which can be converted by page templates
          or dtml into various formats (ex. PDF, CSV, OpenOffice, etc.)
462

Jean-Paul Smets's avatar
Jean-Paul Smets committed
463
          the 'list' format includes additional metainformation
464

Jean-Paul Smets's avatar
Jean-Paul Smets committed
465
          - depth in a report tree (ex. 0, 1, 2, etc.)
466

Jean-Paul Smets's avatar
Jean-Paul Smets committed
467
          - nature of the line (ex. stat or nonstat)
468

Jean-Paul Smets's avatar
Jean-Paul Smets committed
469
          - identification of the tree (ex. relative_url)
470

Jean-Paul Smets's avatar
Jean-Paul Smets committed
471
          - uid if any (to allow future import)
472

Jean-Paul Smets's avatar
Jean-Paul Smets committed
473
          - etc.
474

Jean-Paul Smets's avatar
Jean-Paul Smets committed
475
          which is intended to simplify operation with a spreadsheet or a pagetemplate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476
        """
477 478
        if REQUEST is None:
          REQUEST = get_request()
479
        if render_format == 'list':
480 481
          renderer = ListBoxListRenderer(self, field, REQUEST,
                                         render_prefix=render_prefix)
482
        else:
483
          renderer = ListBoxHTMLRenderer(self, field, REQUEST, render_prefix=render_prefix)
484

485
        return renderer()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
486

487
ListBoxWidgetInstance = ListBoxWidget()
488

489 490 491
def lazyMethod(func):
  """Return a function which stores a computed value in an instance
  at the first call.
492
  """
493 494
  key = '_cache_' + str(id(func))
  def decorated(self, *args, **kw):
495
    try:
496
      return getattr(self, key)
497
    except AttributeError:
498 499
      result = func(self, *args, **kw)
      setattr(self, key, result)
500
      return result
501
  return decorated
502 503

class ListBoxRenderer:
504 505 506 507 508
  """This class deals with rendering of a ListBox field.

  In ListBox, rendering is not only viewing but also setting parameters in a selection
  and a request object.
  """
509

510
  def __init__(self, widget = None, field = None, REQUEST = None, render_prefix=None, **kw):
511 512 513 514 515
    """Store the parameters for later use.
    """
    self.widget = widget
    self.field = field
    self.request = REQUEST
516
    self.render_prefix = render_prefix
517
    self.displayed_column_id_list = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
518

519 520 521
  def getPhysicalPath(self):
    """
      Return the path of form we render.
522
      This function is required to be able to use ZopeProfiler product with
523 524 525 526
      listbox.
    """
    return self.field.getPhysicalPath()

527 528 529 530
  def getLineClass(self):
    """Return a class object for a line. This must be overridden.
    """
    raise NotImplementedError, "getLineClass must be overridden in a subclass"
Jean-Paul Smets's avatar
Jean-Paul Smets committed
531

532
  # Here, define many getters which cache the results for better performance.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
533

534 535 536
  def getContext(self):
    """Return the context of rendering this ListBox.
    """
537 538 539 540
    value = self.request.get('here')
    if value is None:
      value = self.getForm().aq_parent
    return value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541

542
  getContext = lazyMethod(getContext)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
543

544 545 546
  def getForm(self):
    """Return the form which contains the ListBox.
    """
547
    return self.field.aq_parent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
548

549
  getForm = lazyMethod(getForm)
550

551 552 553 554
  def getEncoding(self):
    """Retutn the encoding of strings in the fields. Default to UTF-8.
    """
    return self.getPortalObject().getProperty('management_page_charset', 'utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
555

556
  getEncoding = lazyMethod(getEncoding)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
557

558 559 560 561 562
  def isReset(self):
    """Determine if the ListBox should be reset.
    """
    reset = self.request.get('reset', 0)
    return (reset not in (0, '0'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
563

564
  isReset = lazyMethod(isReset)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
565

566 567 568 569
  def getFieldErrorDict(self):
    """Return a dictionary of errors.
    """
    return self.request.get('field_errors', {})
Jean-Paul Smets's avatar
Jean-Paul Smets committed
570

571
  getFieldErrorDict = lazyMethod(getFieldErrorDict)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
572

573 574
  def getUrl(self):
    """
575 576 577 578 579 580 581
      Return a requested URL.
      Generate the URL from context and request because self.request['URL']
      might contain a function name, which would make all redirections call
      the function - which both we don't want and will probably crash.
    """
    return '%s/%s' % (self.getContext().absolute_url(),
                      self.request.other.get('current_form_id', 'view'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
582

583
  getUrl = lazyMethod(getUrl)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
584

585 586 587 588 589 590
  def getRequestedSelectionName(self):
    """Return a selection name which may be passed by a request.
    If not present, return "default". This selection can be different from the selection
    defined in the ListBox.
    """
    selection_name = self.request.get('selection_name', 'default')
591

592 593 594 595
    # This is a workaround, as selection_name becomes a list or tuple sometimes.
    # XXX really? why?
    if not isinstance(selection_name, str):
      selection_name = selection_name[0]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
596

597
    return selection_name
598

599
  getRequestedSelectionName = lazyMethod(getRequestedSelectionName)
600

601 602 603 604
  def getSelectionIndex(self):
    """Return the index of a requested selection, or None if not specified.
    """
    return self.request.get('selection_index', None)
605

606
  getSelectionIndex = lazyMethod(getSelectionIndex)
607

608 609 610 611
  def getReportDepth(self):
    """Return the depth of reports, or None if not specified.
    """
    return self.request.get('report_depth', None)
612

613
  getReportDepth = lazyMethod(getReportDepth)
614

615 616 617 618
  def getPortalObject(self):
    """Return the portal object.
    """
    return self.getContext().getPortalObject()
619

620
  getPortalObject = lazyMethod(getPortalObject)
621

622 623 624 625
  def getPortalUrlString(self):
    """Return the URL of the portal as a string.
    """
    return self.getPortalObject().portal_url()
626

627
  getPortalUrlString = lazyMethod(getPortalUrlString)
628

629 630 631 632
  def getCategoryTool(self):
    """Return the Category Tool.
    """
    return self.getPortalObject().portal_categories
633

634
  getCategoryTool = lazyMethod(getCategoryTool)
635

636 637 638 639
  def getDomainTool(self):
    """Return the Domain Tool.
    """
    return self.getPortalObject().portal_domains
640

641
  getDomainTool = lazyMethod(getDomainTool)
642

643 644 645 646
  def getCatalogTool(self):
    """Return the Catalog Tool.
    """
    return self.getPortalObject().portal_catalog
647

648
  getCatalogTool = lazyMethod(getCatalogTool)
649

650 651 652 653
  def getSelectionTool(self):
    """Return the Selection Tool.
    """
    return self.getPortalObject().portal_selections
654

655
  getSelectionTool = lazyMethod(getSelectionTool)
656

657 658 659 660 661 662 663 664
  def getPrefixedString(self, string):
    prefix = self.render_prefix
    if prefix is None:
      result = string
    else:
      result = '%s_%s' % (prefix, string)
    return result

665 666
  def getId(self):
    """Return the id of the field. Usually, "listbox".
667
       The prefix will automatically be added
668
    """
669
    return self.getPrefixedString(self.field.id)
670

671
  getId = lazyMethod(getId)
672

673 674 675 676 677 678 679
  def getUnprefixedId(self):
    """Return the id of the field. Usually, "listbox".
    """
    return self.field.id

  getUnprefixedId = lazyMethod(getUnprefixedId)

680 681 682 683
  def getTitle(self):
    """Return the title. Make sure that it is in unicode.
    """
    return unicode(self.field.get_value('title'), self.getEncoding())
684

685
  getTitle = lazyMethod(getTitle)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
686

687 688 689 690 691
  def getMaxLineNumber(self):
    """Return the maximum number of lines shown in a page.
    This must be overridden in subclasses.
    """
    raise NotImplementedError, "getMaxLineNumber must be overridden in a subclass"
692

693 694 695 696
  def showSearchLine(self):
    """Return a boolean that represents whether a search line is displayed or not.
    """
    return self.field.get_value('search')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
697

698
  showSearchLine = lazyMethod(showSearchLine)
699

700 701 702 703
  def showSelectColumn(self):
    """Return a boolean that represents whether a select column is displayed or not.
    """
    return self.field.get_value('select')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
704

705
  showSelectColumn = lazyMethod(showSelectColumn)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
706

707 708 709 710 711 712 713
  def showAnchorColumn(self):
    """Return a boolean that represents whether a anchor column is displayed or not.
    """
    return self.field.get_value('anchor')

  showAnchorColumn = lazyMethod(showAnchorColumn)

714
  def isHideRowsOnNoSearchCriterion(self, REQUEST=None):
715 716 717
    """
      Return a boolean that represents whether search rows are shown or not.
    """
718 719
    # BBB REQUEST passed to this method is simply discarded. The parameter
    # exists only for API compatibility.
720
    REQUEST = self.request
721 722 723 724 725
    hide_rows_on_no_search_criterion = \
                            self.field.get_value('hide_rows_on_no_search_criterion')
    if not hide_rows_on_no_search_criterion:
      # we show all rows and do not care to hide anything
      return 0
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740

    # Always display lines in report mode
    if self.isReportTreeMode():
      return 0

    # In domain mode, returns lines only if a domain is selected
    if self.isDomainTreeMode():
      if self.getDomainSelection():
        return 0

    # ignore_hide_rows parameter force to display the content
    ignore_hide_rows = REQUEST.get('ignore_hide_rows', 0)
    if ignore_hide_rows:
      return 0

741 742
    # we could hide rows only if missing in request or selection search criterions
    selection_params = self.getSelection().getParams()
743 744 745 746 747 748 749 750 751 752 753 754

    # Try to get workflow state parameter, in order to always allow worklist display
    # guess all column names from catalog schema
    possible_state_list = [column_name for column_name in
         self.getPortalObject().portal_catalog.getSQLCatalog().getColumnMap() if
         column_name.endswith('state') and '.' not in column_name]
    for state_var in possible_state_list:
      workflow_state_criterion = REQUEST.get(state_var,
                                        selection_params.get(state_var, None))
      if workflow_state_criterion not in (None, ""):
        return 0

755 756 757 758 759 760 761
    listbox_searchable_column_id_list = [x[0] for x in self.getSearchValueList() \
                                           if x[0] is not None]

    for listbox_searchable_column_id in listbox_searchable_column_id_list:
      search_criterion = REQUEST.get(listbox_searchable_column_id, \
                                     selection_params.get(listbox_searchable_column_id, None))
      if search_criterion not in (None, "",) and not isinstance(search_criterion, dict):
Fabien Morin's avatar
Fabien Morin committed
762
        # search criterion is usually input by user by UI, ignore created automated
763 764 765 766 767
        # by listbox_xxx form fields selection parameters as they do not represent
        # user input but rather a developer formating definition in form
        return 0
    return 1

768
  isHideRowsOnNoSearchCriterion = lazyMethod(isHideRowsOnNoSearchCriterion)
769

770 771
  def showStat(self):
    """Return a boolean that represents whether a stat line is displayed or not.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
772

773 774 775 776
    FIXME: This is not very correct, because stat columns may define their own
    stat method independently.
    """
    return (self.getStatMethod() is not None) and (len(self.getStatColumnList()) > 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
777

778
  showStat = lazyMethod(showStat)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
779

780 781 782 783
  def isDomainTreeSupported(self):
    """Return a boolean that represents whether a domain tree is supported or not.
    """
    return (self.field.get_value('domain_tree') and len(self.getDomainRootList()) > 0)
784

785
  isDomainTreeSupported = lazyMethod(isDomainTreeSupported)
786 787 788 789 790 791

  def isReportTreeSupported(self):
    """Return a boolean that represents whether a report tree is supported or not.
    """
    return (self.field.get_value('report_tree') and len(self.getReportRootList()) > 0)

792
  isReportTreeSupported = lazyMethod(isReportTreeSupported)
793 794 795 796 797 798

  def isDomainTreeMode(self):
    """Return whether the current mode is domain tree mode or not.
    """
    return self.isDomainTreeSupported() and self.getSelection().domain_tree_mode

799
  isDomainTreeMode = lazyMethod(isDomainTreeMode)
800 801 802 803 804 805

  def isReportTreeMode(self):
    """Return whether the current mode is report tree mode or not.
    """
    return self.isReportTreeSupported() and self.getSelection().report_tree_mode

806
  isReportTreeMode = lazyMethod(isReportTreeMode)
807 808 809 810 811 812

  def getDefaultParamList(self):
    """Return the list of default parameters.
    """
    return self.field.get_value('default_params')

813
  getDefaultParamList = lazyMethod(getDefaultParamList)
814 815 816 817 818 819 820 821 822 823 824

  def getListMethodName(self):
    """Return the name of the list method. If not defined, return None.
    """
    list_method = self.field.get_value('list_method')
    try:
      name = getattr(list_method, 'method_name')
    except AttributeError:
      name = list_method
    return name or None

825
  getListMethodName = lazyMethod(getListMethodName)
826 827 828 829 830 831 832 833 834 835 836

  def getCountMethodName(self):
    """Return the name of the count method. If not defined, return None.
    """
    count_method = self.field.get_value('count_method')
    try:
      name = getattr(count_method, 'method_name')
    except AttributeError:
      name = count_method
    return name or None

837
  getCountMethodName = lazyMethod(getCountMethodName)
838 839 840 841 842 843 844 845 846 847 848

  def getStatMethodName(self):
    """Return the name of the stat method. If not defined, return None.
    """
    stat_method = self.field.get_value('stat_method')
    try:
      name = getattr(stat_method, 'method_name')
    except AttributeError:
      name = stat_method
    return name or None

849
  getStatMethodName = lazyMethod(getStatMethodName)
850

851 852 853 854 855 856 857 858 859 860 861
  def getRowCSSMethodName(self):
    """Return the name of the row CSS method. If not defined, return None.
    """
    row_css_method = self.field.get_value('row_css_method')
    try:
      name = getattr(row_css_method, 'method_name')
    except AttributeError:
      name = row_css_method
    return name or None

  getRowCSSMethodName = lazyMethod(getRowCSSMethodName)
Fabien Morin's avatar
Fabien Morin committed
862

863 864 865
  def getSelectionName(self):
    """Return the selection name.
    """
866
    return self.getPrefixedString(self.field.get_value('selection_name'))
867

868
  getSelectionName = lazyMethod(getSelectionName)
869 870 871 872 873 874 875

  def getMetaTypeList(self):
    """Return the list of meta types for filtering. Return None when empty.
    """
    meta_types = [c[0] for c in self.field.get_value('meta_types')]
    return meta_types or None

876
  getMetaTypeList = lazyMethod(getMetaTypeList)
877 878 879 880 881 882 883

  def getPortalTypeList(self):
    """Return the list of portal types for filtering. Return None when empty.
    """
    portal_types = [c[0] for c in self.field.get_value('portal_types')]
    return portal_types or None

884
  getPortalTypeList = lazyMethod(getPortalTypeList)
885 886 887 888 889 890 891

  def getColumnList(self):
    """Return the columns. Make sure that the titles are in unicode.
    """
    columns = self.field.get_value('columns')
    return [(str(c[0]), unicode(c[1], self.getEncoding())) for c in columns]

892
  getColumnList = lazyMethod(getColumnList)
893 894 895

  def getAllColumnList(self):
    """Return the all columns. Make sure that the titles are in unicode.
896
       Make sure there is no duplicates.
897 898 899 900 901 902 903 904
    """
    all_column_list = list(self.getColumnList())
    all_column_id_set = set([c[0] for c in all_column_list])
    all_column_list.extend([(str(c[0]), unicode(c[1], self.getEncoding())) \
                              for c in self.field.get_value('all_columns') \
                              if c[0] not in all_column_id_set])
    return all_column_list

905
  getAllColumnList = lazyMethod(getAllColumnList)
906

907 908
  def getStyleColumnList(self):
    """Return the style columns columns.
909
    """
910
    return self.field.get_value('style_columns')
911

912
  getStyleColumnList = lazyMethod(getStyleColumnList)
913

914 915 916 917 918 919 920 921 922 923
  def getStatColumnList(self):
    """Return the stat columns. Fall back to all the columns if empty.
    """
    stat_columns = self.field.get_value('stat_columns')
    if stat_columns:
      stat_column_list = [(str(c[0]), unicode(c[1], self.getEncoding())) for c in stat_columns]
    else:
      stat_column_list = [(c[0], c[0]) for c in self.getAllColumnList()]
    return stat_column_list

924
  getStatColumnList = lazyMethod(getStatColumnList)
925 926 927 928 929 930 931

  def getUrlColumnList(self):
    """Return the url columns. Make sure that it is an empty list, when not defined.
    """
    url_columns = self.field.get_value('url_columns')
    return url_columns or []

932
  def getUntranslatableColumnList(self):
Fabien Morin's avatar
Fabien Morin committed
933
    """Return the untranslatable columns. Make sure that it is an empty list,
934 935 936 937 938
    when not defined.
    """
    untranslatable_columns = self.field.get_value('untranslatable_columns')
    return untranslatable_columns or []

939
  getUrlColumnList = lazyMethod(getUrlColumnList)
940 941 942 943 944 945

  def getDefaultSortColumnList(self):
    """Return the default sort columns.
    """
    return self.field.get_value('sort')

946
  getDefaultSortColumnList = lazyMethod(getDefaultSortColumnList)
947 948 949 950 951 952 953

  def getDomainRootList(self):
    """Return the domain root list. Make sure that the titles are in unicode.
    """
    domain_root_list = self.field.get_value('domain_root_list')
    return [(str(c[0]), unicode(c[1], self.getEncoding())) for c in domain_root_list]

954
  getDomainRootList = lazyMethod(getDomainRootList)
955 956 957 958 959 960 961

  def getReportRootList(self):
    """Return the report root list. Make sure that the titles are in unicode.
    """
    report_root_list = self.field.get_value('report_root_list')
    return [(str(c[0]), unicode(c[1], self.getEncoding())) for c in report_root_list]

962
  getReportRootList = lazyMethod(getReportRootList)
963

964 965 966 967 968 969 970 971 972
  def getDisplayStyleList(self):
    """Return the list of avaible display style. Make sure that the 
    titles are in unicode"""
    display_style_list = self.field.get_value('display_style_list')
    return [(str(c[0]), unicode(c[1], self.getEncoding())) for c in \
                                                      display_style_list]

  getDisplayStyleList = lazyMethod(getDisplayStyleList)

973
  def getDefaultDisplayStyle(self):
974 975
    """Return the default display list style."""
    return self.field.get_value('default_display_style')
976 977 978

  getDefaultDisplayStyle = lazyMethod(getDefaultDisplayStyle)

979
  def getGlobalSearchColumn(self):
980
    """Return the full text search key."""
981
    return self.field.get_value('global_search_column')
982

983
  getGlobalSearchColumn = lazyMethod(getGlobalSearchColumn)
984

985 986 987 988 989 990 991 992 993
  # backwards compatability
  def getGlobalSearchColumnScript(self):
    warn("getGlobalSearchColumnScript() is deprecated. Do not use it!", \
         DeprecationWarning,
         stacklevel=2)
    return 'Base_doSelect'
  getFullTextSearchKey=getGlobalSearchColumn
  getFullTextSearchKeyScript=getGlobalSearchColumnScript

994 995 996
  def getPageNavigationTemplate(self):
    """Return the list box page navigation template."""
    return self.field.get_value('page_navigation_template')
997

998 999 1000
  getPageNavigationTemplate = lazyMethod(getPageNavigationTemplate)
  # backwards compatability
  getPageNavigationMode = getPageNavigationTemplate
1001

1002 1003 1004 1005 1006 1007 1008
  def getSearchColumnIdSet(self):
    """Return the set of the ids of the search columns. Fall back to the catalog schema, if not defined.
    """
    search_columns = self.field.get_value('search_columns')
    if search_columns:
      search_column_id_list = [c[0] for c in search_columns]
    else:
1009 1010 1011 1012 1013
      search_column_id_list = []
      isValidColumn = self.getCatalogTool().getSQLCatalog().isValidColumn
      for column_id, column_title in self.getAllColumnList():
        if isValidColumn(column_id):
          search_column_id_list.append(column_id)
1014 1015
    return set(search_column_id_list)

1016
  getSearchColumnIdSet = lazyMethod(getSearchColumnIdSet)
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

  def getSortColumnIdSet(self):
    """Return the set of the ids of the sort columns. Fall back to search column ids, if not defined.
    """
    sort_columns = self.field.get_value('sort_columns')
    if sort_columns:
      sort_column_id_set = set([c[0] for c in sort_columns])
    else:
      sort_column_id_set = self.getSearchColumnIdSet()
    return sort_column_id_set

1028
  getSortColumnIdSet = lazyMethod(getSortColumnIdSet)
1029 1030 1031 1032 1033 1034 1035

  def getEditableColumnIdSet(self):
    """Return the set of the ids of the editable columns.
    """
    editable_columns = self.field.get_value('editable_columns')
    return set([c[0] for c in editable_columns])

1036
  getEditableColumnIdSet = lazyMethod(getEditableColumnIdSet)
1037 1038 1039 1040

  def getListActionUrl(self):
    """Return the URL of the list action.
    """
1041 1042 1043 1044 1045 1046 1047
    list_action = self.field.get_value('list_action')
    if '/' in list_action:
      # This is a 'real' URL
      return list_action
    else:
      # This is only a method name. Let us build the URL
      list_action_part_list = [self.getContext().absolute_url(), '/', list_action]
1048 1049 1050 1051
    if '?' in list_action_part_list[-1]:
      list_action_part_list.append('&reset=1')
    else:
      list_action_part_list.append('?reset=1')
1052 1053
    if self.request.get('ignore_layout', None):
      list_action_part_list.append('&ignore_layout:int=1')
1054 1055
    return ''.join(list_action_part_list)

1056
  getListActionUrl = lazyMethod(getListActionUrl)
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

  # Whether the selection object is initialized.
  is_selection_initialized = False

  def getSelection(self):
    """FIXME: Tweak a selection and return the selection object.
    This code depends on the implementation of Selection too much.
    In the future, the API of SelectionTool should be refactored and
    ListBox should not use Selection directly.
    """
    selection_tool = self.getSelectionTool()
    selection_name = self.getSelectionName()
    selection = selection_tool.getSelectionFor(selection_name, REQUEST = self.request)

    if self.is_selection_initialized:
      return selection

    # Create a selection, if not present, with the default sort order.
    if selection is None:
1076 1077 1078 1079
      selection = Selection(selection_name,
                            params=dict(self.getDefaultParamList()),
                            default_sort_on=self.getDefaultSortColumnList(),
                           ).__of__(selection_tool)
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    # Or make sure all sort arguments are valid.
    else:
      # Reset the selection, if specified.
      if self.isReset():
        selection_tool.setSelectionToAll(selection_name)
        selection_tool.setSelectionSortOrder(selection_name, sort_on = [])

      # Modify the default sort index every time, because it may change immediately.
      selection.edit(default_sort_on = self.getDefaultSortColumnList())

      # Filter out non-sortable items.
      sort_column_id_set = self.getSortColumnIdSet()
      sort_list = [c for c in selection.sort_on if c[0] in sort_column_id_set]
      if len(selection.sort_on) != len(sort_list):
        selection.sort_on = sort_list

    if getattr(selection, 'flat_list_mode', None) is None:
      # Initialize the render mode. Choose flat list mode by default.
      selection.edit(flat_list_mode = 1, domain_tree_mode = 0, report_tree_mode = 0)

    # Remember if the items have to be displayed for report tree mode.
    is_report_opened = self.request.get('is_report_opened', selection.isReportOpened())
    selection.edit(report_opened = is_report_opened)

    self.is_selection_initialized = True

    return selection

1108
  getSelection = lazyMethod(getSelection)
1109 1110 1111 1112 1113 1114

  def getCheckedUidList(self):
    """Return the list of checked uids.
    """
    return self.getSelection().getCheckedUids()

1115
  getCheckedUidList = lazyMethod(getCheckedUidList)
1116

1117 1118 1119 1120 1121
  def getCheckedUidSet(self):
    """Return the set of checked uids.
    """
    return set(self.getCheckedUidList())

1122
  getCheckedUidSet = lazyMethod(getCheckedUidSet)
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
  
  def setDisplayedColumnIdList(self, displayed_column_id_list):
    """Set the column to be displayed.
       Impact the result of getSelectedColumnList.
       Parameter : 
       displayed_column_id_list : List of id. Exemple : ('id', 'title')
    """
    self.displayed_column_id_list = displayed_column_id_list

  def getDisplayedColumnIdList(self):
    """Return the list of displayed column id
    """
    return self.displayed_column_id_list
1136

1137 1138 1139 1140 1141 1142 1143 1144
  def getListboxDisplayStyle(self):
    """Return the current listbox display style.
    """
    request = self.request
    selection = self.getSelection()
    return request.get('list_style', \
                        selection.getParams().get('list_style', self.getDefaultDisplayStyle()))

1145 1146 1147
  def getSelectedColumnList(self):
    """Return the list of selected columns.
    """
1148
    column_list = []
1149 1150 1151
    default_listbox_display_style = self.getDefaultDisplayStyle()
    listbox_display_style = self.getListboxDisplayStyle()
    dynamic_column_list_override = (self.getDisplayedColumnIdList() != None)
1152
    list_style_column_change_required = listbox_display_style not in ('', DEFAULT_LISTBOX_DISPLAY_STYLE,)
1153 1154
    if dynamic_column_list_override:
      # dynamically setting columns is supported
1155 1156 1157 1158 1159 1160
      available_column = self.getAllColumnList()
      #Create a dict to make a easy search
      available_column_dict = dict()
      for id,title in available_column:
        available_column_dict[id] = (id,title)

1161
      # We check columns are present
1162 1163 1164 1165 1166
      for id in self.getDisplayedColumnIdList():
        if available_column_dict.has_key(id):
          column_list.append(available_column_dict[id])
        else:
          raise AttributeError, "Column %s is not avaible" % id
1167 1168 1169 1170
    elif list_style_column_change_required and not dynamic_column_list_override:
      # no dynamically setting of columns happens , still we have different than default
      # listbox list style so try to get columns from 'More columns'
      list_style_prefix = "%s_" %listbox_display_style
1171
      for column in  self.getStyleColumnList():
1172 1173
        if column[1].startswith(list_style_prefix):
          column_list.append((column[0],column[1].replace(list_style_prefix, '',)))
1174 1175
    else:
      column_list = self.getSelectionTool().getSelectionColumns(self.getSelectionName(),
1176 1177
                                                       columns = self.getColumnList(),
                                                       REQUEST = self.request)
1178
    return column_list
1179

1180
  getSelectedColumnList = lazyMethod(getSelectedColumnList)
1181 1182 1183 1184 1185 1186 1187 1188 1189

  def getColumnAliasList(self):
    """Return the list of column aliases for SQL, because SQL does not allow a symbol to contain dots.
    """
    alias_list = []
    for sql, title in self.getSelectedColumnList():
      alias_list.append(sql.replace('.', '_'))
    return alias_list

1190
  getColumnAliasList = lazyMethod(getColumnAliasList)
1191 1192 1193 1194

  def getParamDict(self):
    """Return a dictionary of parameters.
    """
1195
    params = dict(self.getSelection().getParams())
1196 1197 1198
    if self.getListMethodName():
      # Update parameters, only if list_method is defined.
      # (i.e. do not update parameters in listboxes intended to show a previously defined selection.
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
      listbox_prefix = '%s_' % self.getId()
      for k, v in self.request.form.iteritems():
        # Ignore parameters for other listboxes and selection keys.
        if 'listbox_' in k or k.endswith('selection_key'):
          continue
        elif k.startswith(listbox_prefix):
          k = k[len(listbox_prefix):]
          # <listbox_field_id>_uid is already handled in
          # ListBoxValidator.validate() and putting uid in selection
          # will limit the contents for the selection.
          if k != 'uid':
            params[k] = v
        else:
          params[k] = v
1213 1214 1215
      for k, v in self.getDefaultParamList():
        params.setdefault(k, v)

1216 1217 1218 1219 1220
      search_prefix = 'search_%s_' % (self.getId(), )
      for k, v in params.items():
        if k.startswith(search_prefix):
          params[k[len(search_prefix):]] = v

1221 1222 1223 1224 1225
      search_value_list = [x for x in self.getSearchValueList(param_dict=params) if isinstance(x[1], basestring)]
      listbox_form = self.getForm()
      listbox_id = self.getId()
      for search_id, search_value, search_field in search_value_list:
        if search_field is None:
1226
          search_alias = '_'.join(search_id.split('.'))
1227
          # If the search field could not be found, try to get an "editable" field on current form.
1228 1229
          search_field = self.getEditableField(search_alias)
          if search_field is None:
1230
            continue
1231

1232
        render_dict = search_field.render_dict(search_value)
1233
        if render_dict is not None:
1234
          params[search_id] = render_dict
1235

1236 1237 1238 1239
      # Set parameters, depending on the list method.
      list_method_name = self.getListMethodName()
      meta_type_list = self.getMetaTypeList()
      portal_type_list = self.getPortalTypeList()
1240 1241 1242 1243 1244
      if portal_type_list is not None:
        params.setdefault('portal_type', portal_type_list)
      elif meta_type_list is not None:
        params.setdefault('meta_type', meta_type_list)

1245
      # Remove FileUpload parameters
1246 1247 1248 1249 1250 1251
      for k, v in params.items():
        if k == "listbox":
          # listbox can also contain useless parameters
          new_list = []
          for line in v:
            for k1, v1 in line.items():
1252
              if hasattr(v1, 'read'):
1253 1254 1255
                del line[k1]
            new_list.append(line)
          params[k] = new_list
1256
        if hasattr(v, 'read'):
1257
          del params[k]
1258

1259 1260 1261
      # remove some erp5_xhtml_style specific parameters
      params.pop('saved_form_data', None)

1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
    # Set the columns. The idea behind this is that, instead of selecting all columns,
    # ListBox can specify only required columns, in order to reduce the data transferred
    # from a SQL Server to Zope.
    sql_column_list = []
    for (sql, title), alias in zip(self.getSelectedColumnList(), self.getColumnAliasList()):
      if sql != alias:
        sql_column_list.append('%s AS %s' % (sql, alias))
      else:
        sql_column_list.append(alias)

    # XXX why is this necessary? For compatibility?
    for sql, title in self.getAllColumnList():
      if sql in ('catalog.path', 'path'):
        alias = sql.replace('.', '_')
        if sql != alias:
          sql_column_list.append('%s AS %s' % (sql, alias))
        else:
          sql_column_list.append(alias)
        break

    params['select_columns'] = ', '.join(sql_column_list)

    # XXX Remove selection_expression if present.
    # This is necessary for now, because the actual selection expression in
    # search catalog does not take the requested columns into account. If
    # select_expression is passed, this can raise an exception, because stat
    # method sets select_expression, and this might cause duplicated column
    # names.
    #
    # In the future, this must be addressed in a clean way. selection_expression
    # should be used for search catalog, and search catalog should not use
    # catalog.* but only selection_expression. But this is a bit difficult,
    # because there is no simple way to distinguish queried columns from callable
    # objects in the current ListBox configuration.
    if 'select_expression' in params:
      del params['select_expression']
1298
    params.setdefault('limit', 1000) 
1299

1300
    self.getSelection().edit(params=params)
1301 1302
    return params

1303
  getParamDict = lazyMethod(getParamDict)
1304

1305 1306 1307 1308 1309
  def getEditableField(self, alias):
    """Get an editable field for column, using column alias.
    Return None if a field for this column does not exist.
    """
    form = self.getForm()
1310
    editable_field_id = '%s_%s' % (self.getUnprefixedId(), alias)
1311 1312 1313 1314
    field = self.field
    while form is not None:
      #Search the editable field in the form
      if form.has_field(editable_field_id, include_disabled=1):
1315
        return form.get_field(editable_field_id, include_disabled=1)
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
      elif field.meta_type == 'ProxyField':
        # if we are rendering a proxy field, also look for editable 
        # fields from the template field's form.
        field = field.getTemplateField()
        if field is None:
          form = None
        else:
          form = aq_inner(field).aq_parent
      else:
        form = None
    
1327 1328
    return None

1329 1330 1331 1332 1333
  def getListMethod(self):
    """Return the list method object.
    """
    list_method_name = self.getListMethodName()

1334 1335
    if list_method_name in ('objectValues', 'contentValues'):
      list_method = ListMethodWrapper(self.getContext(), list_method_name)
1336 1337
    elif list_method_name == 'searchFolder':
      list_method = CatalogMethodWrapper(self.getContext(), list_method_name)
1338
    elif list_method_name is not None:
1339
      list_method = getattr(self.getContext(), list_method_name, None)
1340 1341 1342 1343 1344
    else:
      list_method = None

    return list_method

1345
  getListMethod = lazyMethod(getListMethod)
1346 1347 1348 1349 1350 1351 1352 1353 1354

  def getCountMethod(self):
    """Return the count method object.
    """
    count_method_name = self.getCountMethodName()

    if count_method_name == 'objectValues':
      # Get all objects anyway in this case.
      count_method = None
1355 1356 1357 1358
    elif count_method_name == 'portal_catalog':
      count_method = CatalogMethodWrapper(self.getCatalogTool(), 'countResults')
    elif count_method_name == 'countFolder':
      count_method = CatalogMethodWrapper(self.getContext(), count_method_name)
1359
    elif count_method_name is not None:
1360
      count_method = getattr(self.getContext(), count_method_name, None)
1361 1362 1363 1364 1365
    else:
      count_method = None

    return count_method

1366
  getCountMethod = lazyMethod(getCountMethod)
1367 1368 1369 1370 1371 1372 1373 1374 1375

  def getStatMethod(self):
    """Return the stat method object.
    """
    stat_method_name = self.getStatMethodName()

    if stat_method_name == 'objectValues':
      # Nothing to do in this case.
      stat_method = None
1376 1377 1378 1379
    elif stat_method_name == 'portal_catalog':
      stat_method = CatalogMethodWrapper(self.getCatalogTool(), 'countResults')
    elif stat_method_name == 'countFolder':
      stat_method = CatalogMethodWrapper(self.getContext(), stat_method_name)
1380
    elif stat_method_name is not None:
1381
      stat_method = getattr(self.getContext(), stat_method_name, None)
1382 1383 1384 1385 1386
    else:
      stat_method = None

    return stat_method

1387
  getStatMethod = lazyMethod(getStatMethod)
1388

1389 1390 1391 1392 1393 1394
  def getRowCSSMethod(self):
    """Return the row css method object.
    """
    row_css_method_name = self.getRowCSSMethodName()
    row_css_method = None
    if row_css_method_name is not None:
1395
      row_css_method = getattr(self.getContext(), row_css_method_name, None)
1396 1397 1398
    return row_css_method

  getRowCSSMethod = lazyMethod(getRowCSSMethod)
Fabien Morin's avatar
Fabien Morin committed
1399

1400 1401 1402
  def getDomainSelection(self):
    """Return a DomainSelection object wrapped with the context.
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1403
    portal_object = self.getPortalObject()
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
    selection = self.getSelection()
    domain_list = selection.getDomainList()

    if len(domain_list) > 0:
      category_tool = self.getCategoryTool()
      domain_tool = self.getDomainTool()
      root_dict = {}

      for domain in domain_list:
        # XXX workaround for a past bug in Selection
        if not isinstance(domain, str):
          continue

        root = None
        base_domain = domain.split('/', 1)[0]
        if category_tool is not None:
          root = category_tool.restrictedTraverse(domain, None)
          if root is not None :
1422
            root_dict[base_domain] = ('portal_categories', domain)
1423
          elif domain_tool is not None:
1424 1425 1426 1427
            try:
              root = domain_tool.getDomainByPath(domain, None)
            except KeyError:
              root = None
1428
            if root is not None:
1429
              root_dict[base_domain] = ('portal_domains', domain)
1430
        if root is None:
1431 1432 1433
          root = portal_object.restrictedTraverse(domain, None)
          if root is not None:
            root_dict[None] = (None, domain)
1434 1435 1436

      return DomainSelection(domain_dict = root_dict).__of__(self.getContext())

1437
  getDomainSelection = lazyMethod(getDomainSelection)
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465

  def getStatSelectExpression(self):
    """Return a string which expresses the information retrieved by SELECT for
    the statistics.
    """
    select_expression_list = []
    if self.showStat():
      stats = self.getSelectionTool().getSelectionStats(self.getSelectionName(), REQUEST = self.request)
      stat_column_list = self.getStatColumnList()

      for index, ((sql, title), alias) in enumerate(zip(self.getSelectedColumnList(), self.getColumnAliasList())):
        # XXX This might be slow.
        for column in stat_column_list:
          if column[0] == sql:
            break
        else:
          column = None
        if (column is not None) and (column[0] == column[1]):
          try:
            if stats[index] != ' ':
              select_expression_list.append('%s(%s) AS %s' % (stats[index], sql, alias))
            else:
              select_expression_list.append("'' AS %s" % alias)
          except IndexError:
            select_expression_list.append("'' AS %s" % alias)

    return ', '.join(select_expression_list)

1466
  getStatSelectExpression = lazyMethod(getStatSelectExpression)
1467

1468
  def makeReportTreeList(self, root_dict = None, report_path = None, base_category = None, depth = 0,
1469 1470
                         unfolded_list = (), is_report_opened = True, sort_on = (('id', 'ASC'),),
                         checked_permission='View'):
1471 1472 1473 1474
    """Return a list of report trees.
    """
    if isinstance(report_path, str):
      report_path = report_path.split('/')
1475
    if base_category is None and len(report_path):
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
      base_category = report_path[0]

    category_tool = self.getCategoryTool()
    domain_tool = self.getDomainTool()
    portal_object = self.getPortalObject()
    report_depth = self.getReportDepth()

    if root_dict is None:
      root_dict = {}

    # Find the root object.
    is_empty_level = 1
1488
    category = base_category
1489
    while is_empty_level:
1490
      if not root_dict.has_key(category):
1491 1492 1493
        root = None
        if category_tool is not None:
          try:
1494
            if category == 'parent':
1495
              # parent has a special treatment
1496 1497
              root = self.getContext()
              root_dict[category] = root_dict[None] = (root, (None, root.getRelativeUrl()))
1498
            else:
1499 1500 1501
              root = category_tool[category]
              root_dict[category] = root_dict[None] = (root, ('portal_categories', root.getRelativeUrl()))
            report_path = report_path[1:]
1502 1503 1504 1505
          except KeyError:
            pass
        if root is None and domain_tool is not None:
          try:
1506 1507
            root = domain_tool[category]
            root_dict[category] = root_dict[None] = (root, ('portal_domains', root.getRelativeUrl()))
1508 1509 1510 1511
            report_path = report_path[1:]
          except KeyError:
            pass
        if root is None:
1512 1513 1514
          root = portal_object.unrestrictedTraverse(report_path, None)
          if root is not None:
            root_dict[None] = (root, (None, root.getRelativeUrl()))
1515 1516
          report_path = ()
      else:
1517 1518
        root_dict[None] = root_dict[category]
        root = root_dict[None][0]
1519 1520 1521
        report_path = report_path[1:]
      is_empty_level = (root is None or root.objectCount() == 0) and (len(report_path) != 0)
      if is_empty_level:
1522
        category = report_path[0]
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533

    tree_list = []
    if root is None: return tree_list

    # Get the list of objects in the root. Use getChildDomainValueList, if defined,
    # to generate child domains dynamically.
    getChildDomainValueList = getattr(aq_base(root), 'getChildDomainValueList', None)
    contentValues = getattr(aq_base(root), 'contentValues', None)
    if getChildDomainValueList is not None and base_category != 'parent':
      obj_list = root.getChildDomainValueList(root, depth = depth)
    elif contentValues is not None:
1534 1535
      obj_list = root.contentValues(sort_on=sort_on,
          checked_permission=checked_permission)
1536 1537 1538 1539 1540
    else:
      obj_list = ()

    for obj in obj_list:
      new_root_dict = root_dict.copy()
1541 1542 1543 1544
      new_root_dict[None] = new_root_dict[base_category] = (obj, (new_root_dict[base_category][1][0], obj.getRelativeUrl()))
      domain_dict = {}
      for k, v in new_root_dict.iteritems():
        domain_dict[k] = v[1]
1545
      selection_domain = DomainSelection(domain_dict = domain_dict)
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557

      if base_category == 'parent':
        exception_uid_list = []
      else:
        exception_uid_list = None

      #LOG('ListBox', 0, 'depth = %r, report_depth = %r, unfolded_list = %r, obj.getRelativeUrl() = %r' % (depth, report_depth, unfolded_list, obj.getRelativeUrl()))
      if (report_depth is not None and depth <= (report_depth - 1)) or obj.getRelativeUrl() in unfolded_list:
        # If the base category is parent, do not display sub-objects
        # which can be used as a part of the report tree. Otherwise,
        # sub-objects are displayed twice unnecessarily.
        if base_category == 'parent':
1558 1559
          for sub_obj in obj.contentValues(sort_on=sort_on,
                checked_permission=checked_permission):
1560
            if getattr(aq_base(sub_obj), 'objectValues', None) is not None:
1561
              exception_uid_list.append(sub_obj.getUid())
1562 1563 1564

        # Summary (open)
        tree_list.append(ReportTree(obj = obj, is_pure_summary = True, depth = depth,
1565
                                    base_category = base_category,
1566
                                    is_open = True, selection_domain = selection_domain,
1567 1568 1569 1570
                                    exception_uid_list = exception_uid_list))
        if is_report_opened:
          # List (contents, closed, must be strict selection)
          tree_list.append(ReportTree(obj = obj, is_pure_summary = False, depth = depth,
1571
                                      base_category = base_category,
1572
                                      is_open = False, selection_domain = selection_domain,
1573
                                      exception_uid_list = exception_uid_list))
1574 1575 1576 1577 1578
        # manage multiple base category
        if len(report_path) >= 1 and base_category != report_path[0]:
          new_base_category = None
        else:
          new_base_category = base_category
1579 1580
        tree_list.extend(self.makeReportTreeList(root_dict = new_root_dict,
                                                 report_path = report_path,
1581
                                                 base_category = new_base_category,
1582 1583 1584 1585 1586 1587 1588
                                                 depth = depth + 1,
                                                 unfolded_list = unfolded_list,
                                                 is_report_opened = is_report_opened,
                                                 sort_on = sort_on))
      else:
        # Summary (closed)
        tree_list.append(ReportTree(obj = obj, is_pure_summary = True, depth = depth,
1589
                                    base_category = base_category,
1590
                                    is_open = False, selection_domain = selection_domain,
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
                                    exception_uid_list = exception_uid_list))

    return tree_list

  def getLineStart(self):
    """Return where the first line should start from. Note that this is simply a requested value,
    so the real value can be different from this. For example, if the value exceeds the total number
    of lines, the start number is forced to fit into somewhere. This must be overridden in subclasses.
    """
    raise NotImplementedError, "getLineStart must be overridden in a subclass"

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
  def getSelectedDomainPath(self):
    """Return a selected domain path.
    """
    domain_path = self.getSelection().getDomainPath()
    if domain_path == ('portal_categories',):
      try:
        # Default to the first domain.
        domain_path = self.getDomainRootList()[0][0]
      except IndexError:
        domain_path = None
    return domain_path

1614
  getSelectedDomainPath = lazyMethod(getSelectedDomainPath)
1615

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
  def getSelectedReportPath(self):
    """Return a selected report path.
    """
    category_tool = self.getCategoryTool()
    domain_tool = self.getDomainTool()
    report_root_list = self.getReportRootList()
    selection = self.getSelection()

    default_selection_report_path = report_root_list[0][0].split('/', 1)[0]
    if (category_tool is None or category_tool._getOb(default_selection_report_path, None) is None) \
        and (domain_tool is None or domain_tool._getOb(default_selection_report_path, None) is None):
      default_selection_report_path = report_root_list[0][0]

    return selection.getReportPath(default = default_selection_report_path)

1631
  getSelectedReportPath = lazyMethod(getSelectedReportPath)
1632

1633 1634 1635 1636 1637 1638
  def getLabelValueList(self):
    """Return a list of values, where each value is a tuple consisting of an property id, a title and a string which
    describes the current sorting order, one of ascending, descending and None. If a value is not sortable, the id is
    set to None, otherwise to a string.
    """
    sort_list = self.getSelectionTool().getSelectionSortOrder(self.getSelectionName())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1639 1640 1641
    sort_dict = {}
    for sort_item in sort_list:
      sort_dict[sort_item[0]] = sort_item[1] # sort_item can be couple or a triplet
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
    sort_column_id_set = self.getSortColumnIdSet()

    value_list = []
    for c in self.getSelectedColumnList():
      if c[0] in sort_column_id_set:
        value_list.append((c[0], c[1], sort_dict.get(c[0])))
      else:
        value_list.append((None, c[1], None))

    return value_list

1653
  def getSearchValueList(self, param_dict=None):
1654 1655 1656 1657 1658
    """Return a list of values, where each value is a tuple consisting of an alias, a current value and a search field.
    If a column is not searchable, the alias is set to None, otherwise to a string. If a search field is not present,
    it is set to None.
    """
    search_column_id_set = self.getSearchColumnIdSet()
1659 1660
    if param_dict is None:
      param_dict = self.getParamDict()
1661

1662
    value_list = []
1663
    for (sql, title), alias in zip(self.getSelectedColumnList(), self.getColumnAliasList()):
1664 1665
      if sql in search_column_id_set:
        # Get the current value and encode it in unicode.
1666
        param = param_dict.get(alias, param_dict.get(sql, u''))
1667 1668
        if isinstance(param, dict):
          param = param.get('query', u'')
1669 1670 1671 1672
        if isinstance(param, str):
          param = unicode(param, self.getEncoding())

        # Obtain a search field, if any.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1673 1674 1675
        form = self.getForm()
        if form.has_field(alias):
          search_field = form.get_field(alias)
1676 1677 1678
        else:
          search_field = None

1679
        value_list.append((sql, param, search_field))
1680 1681 1682 1683
      else:
        value_list.append((None, None, None))

    return value_list
Fabien Morin's avatar
Fabien Morin committed
1684

1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
  def getStatValueList(self):
    """Return a list of values, where each value is a tuple consisting of an original value and a processed value.
    A processed value is always an unicode object, and it may differ from the original value, for instance,
    a processed value may describe an error, when an original value is None.
    """
    # First, get the statitics by the global stat method.
    param_dict = self.getParamDict()
    new_param_dict = param_dict.copy()
    new_param_dict['select_expression'] = self.getStatSelectExpression()
    selection = self.getSelection()
    selection.edit(params = new_param_dict)
1696 1697 1698 1699 1700 1701 1702 1703 1704

    _result = {'value':None, 'called':False}
    def getStatMethodResult():
      """Stat method must be called only when necessary"""
      if _result['called']:
        return _result['value']
      _result['value'] = selection(method = self.getStatMethod(), context = self.getContext(), REQUEST = self.request)
      _result['called'] = True
      return _result['value']
1705 1706

    # For each column, check the presense of a specific stat method. If not present,
1707
    # use getStatMethodResult defined above.
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
    value_list = []
    stat_column_dict = dict(self.getStatColumnList())
    for (sql, title), alias in zip(self.getSelectedColumnList(), self.getColumnAliasList()):
      original_value = None
      processed_value = None

      # Get a specific stat method, if any.
      stat_method_id = stat_column_dict.get(sql)
      if stat_method_id is not None and stat_method_id != sql:
        stat_method = getattr(self.getContext(), stat_method_id)
      else:
        stat_method = None

1721 1722 1723 1724
      if stat_method_id is None:
        original_value = None
        processed_value = u''
      elif stat_method is None:
1725
        try:
1726
          original_value = getattr(getStatMethodResult()[0], alias)
1727 1728 1729 1730 1731 1732 1733
          processed_value = original_value
        except (IndexError, AttributeError, KeyError, ValueError):
          original_value = None
          processed_value = u''
      else:
        if callable(stat_method):
          try:
1734 1735
            original_value = stat_method(selection = selection,
                                         selection_name = selection.getName())
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
            processed_value = original_value
          except (ConflictError, RuntimeError):
            raise
          except:
            LOG('ListBox', WARNING, 'could not call %r with %r' % (stat_method, self.getContext()),
                error = sys.exc_info())
            original_value = None
            processed_value = u''
        else:
          original_value = stat_method
          processed_value = original_value
1747

1748 1749 1750
      editable_field = self.getEditableField(alias)
      if editable_field is not None:
        processed_value = editable_field.render_view(value=original_value)
1751 1752

      if not isinstance(processed_value, unicode):
1753
        processed_value = unicode(str(processed_value), self.getEncoding(), 'replace')
1754 1755 1756 1757 1758

      value_list.append((original_value, processed_value))

    return value_list

1759 1760 1761 1762 1763 1764 1765 1766
  def getRowCSSClassName(self, **kw):
    """Return the css class name of a table row. If the method is not callable, returns None.
    """
    row_css_method = self.getRowCSSMethod()
    if callable(row_css_method):
      return row_css_method(**kw)
    return None

1767 1768 1769 1770 1771 1772 1773 1774
  def getReportSectionList(self):
    """Return a list of report sections.
    """
    param_dict = self.getParamDict()
    category_tool = self.getCategoryTool()
    domain_tool = self.getDomainTool()
    report_depth = self.getReportDepth()
    selection = self.getSelection()
1775
    selection_tool = self.getSelectionTool()
1776
    report_list = selection.getReportList()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1777
    stat_select_expression = self.getStatSelectExpression()
1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
    stat_method = self.getStatMethod()
    count_method = self.getCountMethod()
    list_method = self.getListMethod()
    context = self.getContext()
    selection_name = self.getSelectionName()
    start = self.getLineStart()
    max_lines = self.getMaxLineNumber()
    report_section_list = []

    if self.isReportTreeMode():
      # In report tree mode, there are three types of lines:
      #
      #   - summary line with statistics
      #   - summary line with the first object in a domain
      #   - object line
      #
      # These lines are compiled into report sections for convenience.

      selection_report_path = self.getSelectedReportPath()

      #LOG('ListBox', 0, 'report_depth = %r' % (report_depth,))
      if report_depth is not None:
        selection_report_current = ()
      else:
        selection_report_current = report_list

      report_tree_list = self.makeReportTreeList(report_path = selection_report_path,
                                                 unfolded_list = selection_report_current,
                                                 is_report_opened = selection.isReportOpened(),
                                                 sort_on = selection.sort_on)

1809 1810
      # Update report list if report_depth was specified. This information is used
      # to store what domains are unfolded by clicking on a depth.
1811 1812 1813 1814 1815 1816
      if report_depth is not None:
        report_list = [t.obj.getRelativeUrl() for t in report_tree_list if t.is_open]
        selection.edit(report_list = report_list)

      for report_tree in report_tree_list:
        # Prepare query by defining selection report object.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1817
        report_tree_obj = report_tree.obj
1818 1819 1820 1821

        # FIXME: this code needs optimization. The query should be delayed
        # as late as possible, because this code queries all data, even if
        # it is not displayed.
1822
        selection.edit(report = report_tree.selection_domain)
1823

1824 1825 1826 1827 1828 1829 1830 1831
        # FIXME: The following is only meant to be a temporary workaround.
        # Eventually, Selection should be rewritten to provide a more complete
        # API than just one __call__ method, and to support method_name
        # redefinition by the domain.

        # If the domain has a context_url, list_method or stat_method
        # parameters, we should use them instead of the ListBox ones when
        # looking for objects in the domain.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1832
        domain_context = report_tree_obj.getProperty('context_url', None)
1833 1834 1835 1836
        if domain_context is not None:
          domain_context = context.restrictedTraverse(domain_context)
        else:
          domain_context = context
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1837
        domain_list_method = report_tree_obj.getProperty('list_method',
1838
            list_method)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1839
        domain_stat_method = report_tree_obj.getProperty('stat_method',
1840 1841
            stat_method)

1842 1843 1844 1845 1846 1847 1848
        if report_tree.is_pure_summary and self.showStat():
          # Push a new select_expression.
          new_param_dict = param_dict.copy()
          new_param_dict['select_expression'] = stat_select_expression
          selection.edit(params = new_param_dict)

          # Query the stat.
1849
          stat_brain = selection(method=domain_stat_method, context=domain_context, REQUEST=self.request)
1850

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1851
          domain_title = report_tree_obj.getTitle()# XXX Yusei Keep original domain title before overriding
1852

1853 1854 1855 1856 1857 1858 1859
          stat_result = {}
          for index, (k, v) in enumerate(self.getSelectedColumnList()):
            try:
              stat_result[k] = str(stat_brain[0][index + 1])
            except IndexError:
              stat_result[k] = ''

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1860
          stat_context = report_tree_obj.asContext(**stat_result)
1861
          # XXX yo thinks that this code below is useless, so disabled.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1862
          #absolute_url_txt = report_tree_obj.absolute_url()
1863
          #stat_context.absolute_url = lambda: absolute_url_txt
1864
          stat_context.domain_url = report_tree.domain_url
1865 1866
          report_section_list.append(ReportSection(is_summary = True, object_list = [stat_context],
                                                   object_list_len = 1, is_open = report_tree.is_open,
1867
                                                   selection_domain = report_tree.selection_domain,
1868 1869
                                                   context = stat_context, depth = report_tree.depth,
                                                   domain_title = domain_title))
1870 1871 1872 1873 1874
        else:
          selection.edit(params = param_dict)

          if list_method is not None:
            # FIXME: this should use a count method, if present, and obtain objects, only if necessary.
1875
            object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
          else:
            # If list_method is None, use already selected values.
            object_list = self.getSelectionTool().getSelectionValueList(selection_name,
                                                                        context = context,
                                                                        REQUEST = self.request)

          if report_tree.exception_uid_set is not None:
            # Filter folders if this is a parent tree.
            new_object_list = []
            for o in object_list:
              if o.getUid() not in report_tree.exception_uid_set:
                new_object_list.append(o)
            object_list = new_object_list

          object_list_len = len(object_list)
          #LOG('ListBox', 0, 'report_tree.__dict__ = %r, object_list = %r, object_list_len = %r' % (report_tree.__dict__, object_list, object_list_len))
          if not report_tree.is_pure_summary:
1893
            if self.showStat():
1894 1895 1896
              report_section_list.append(ReportSection(is_summary = False, object_list = object_list,
                                                       object_list_len = object_list_len,
                                                       is_open = report_tree.is_open,
1897
                                                       selection_domain = report_tree.selection_domain,
1898
                                                       depth = report_tree.depth))
1899
          else:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1900
            stat_context = report_tree_obj.asContext()
1901 1902
            #absolute_url_txt = s[0].absolute_url()
            #stat_context.absolute_url = lambda : absolute_url_txt
1903
            stat_context.domain_url = report_tree.domain_url
1904 1905 1906 1907 1908 1909 1910
            if object_list_len and report_tree.is_open:
              # Display the first object at the same level as a category selector,
              # if this selector is open.
              report_section_list.append(ReportSection(is_summary = False,
                                                       object_list = [object_list[0]],
                                                       object_list_len = 1,
                                                       is_open = True,
1911
                                                       selection_domain = report_tree.selection_domain,
1912 1913
                                                       context = stat_context,
                                                       depth = report_tree.depth))
1914 1915 1916 1917
              report_section_list.append(ReportSection(is_summary = False,
                                                       object_list = object_list,
                                                       object_list_len = object_list_len - 1,
                                                       is_open = True,
1918
                                                       selection_domain = report_tree.selection_domain,
1919 1920
                                                       offset = 1,
                                                       depth = report_tree.depth))
1921 1922 1923 1924
            else:
              if report_tree.exception_uid_list is not None:
                # Display current parent domain.
                report_section_list.append(ReportSection(is_summary = False,
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1925
                                                         object_list = [report_tree_obj],
1926 1927
                                                         object_list_len = 1,
                                                         is_open = report_tree.is_open,
1928
                                                         selection_domain = report_tree.selection_domain,
1929 1930
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1931 1932 1933 1934 1935 1936
              else:
                # No data to display
                report_section_list.append(ReportSection(is_summary = False,
                                                         object_list = [None],
                                                         object_list_len = 1,
                                                         is_open = report_tree.is_open,
1937
                                                         selection_domain = report_tree.selection_domain,
1938 1939
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1940 1941 1942 1943 1944 1945 1946

      # Reset the report parameter.
      selection.edit(report = None)
    else:
      # Flat list mode or domain tree mode.
      selection.edit(params = param_dict, report = None)

1947
      domain_found = 0
1948
      if self.isDomainTreeMode():
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
        domain_selection = self.getDomainSelection()
        selection.edit(domain=domain_selection)
        if domain_selection is not None:
          for k, d in domain_selection.asDomainDict().iteritems():
            if k is not None:
              domain = domain_selection._getDomainObject(
                  context.getPortalObject(), d)
              # FIXME: The following is only meant to be a temporary
              # workaround. Eventually, Selection should be rewritten to
              # provide a more complete API than just one __call__ method, and
              # to support method_name redefinition by the domain.

              # If the domain has a context_url, list_method or count_method
              # parameters, we should use them instead of the ListBox ones
              # when looking for objects in the domain.
              domain_context = domain.getProperty('context_url', None)
              if domain_context is not None:
                domain_context = context.restrictedTraverse(domain_context)
              else:
                domain_context = context
              domain_list_method = domain.getProperty('list_method',
                  list_method)
              domain_count_method = domain.getProperty('count_method',
                  count_method)
1973
              domain_found = 1
1974
              break
1975
      if not domain_found:
1976 1977 1978
        domain_context = context
        domain_list_method = list_method
        domain_count_method = count_method
1979 1980 1981 1982

      if list_method is not None:
        if count_method is not None and not selection.invert_mode and max_lines > 0:
          # If the count method is available, get only required objects.
1983
          count = selection(method=domain_count_method, context=domain_context, REQUEST=self.request)
1984 1985 1986 1987
          object_list_len = int(count[0][0])

          # Tweak the line start.
          if start >= object_list_len:
1988
            start = max(object_list_len - 1, 0)
1989 1990 1991 1992 1993 1994
          start -= (start % max_lines)

          # Obtain only required objects.
          new_param_dict = param_dict.copy()
          new_param_dict['limit'] = (start, max_lines)
          selection.edit(params = new_param_dict)
1995
          object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
          selection.edit(params = param_dict) # XXX Necessary?

          # Add padding for convenience.
          report_section_list.append(ReportSection(is_summary = False,
                                                   object_list_len = start))
          report_section_list.append(ReportSection(is_summary = False,
                                                   object_list = object_list,
                                                   object_list_len = len(object_list)))
          report_section_list.append(ReportSection(is_summary = False,
                                                   object_list_len = object_list_len - len(object_list) - start))
        else:
2007
          object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
2008 2009 2010 2011 2012 2013
          object_list_len = len(object_list)
          report_section_list.append(ReportSection(is_summary = False,
                                                   object_list = object_list,
                                                   object_list_len = object_list_len))
      else:
        # If list_method is None, use already selected values.
2014
        object_list = selection_tool.getSelectionValueList(selection_name,
2015
                                                                   context = context, REQUEST = self.request)
2016
        object_list_len= len(object_list)
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
        report_section_list.append(ReportSection(is_summary = False,
                                                 object_list = object_list,
                                                 object_list_len = object_list_len))

    return report_section_list

  def query(self):
    """Get report sections and construct a list of lines. Note that this method has a side
    effect in the selection, and the renderer object itself.
    """
    start = self.getLineStart()
    max_lines = self.getMaxLineNumber()
2029 2030 2031 2032
    if self.isHideRowsOnNoSearchCriterion():
      report_section_list = []
    else:
      report_section_list = self.getReportSectionList()
2033 2034 2035 2036
    param_dict = self.getParamDict()

    # Set the total number of objects.
    self.total_size = sum([s.object_list_len for s in report_section_list])
2037
    limit = param_dict.get('limit')
2038
    if isinstance(limit, basestring):
2039 2040
      limit = int(limit)
    self.is_sample = self.total_size == limit
2041 2042 2043 2044 2045 2046 2047 2048

    # Calculuate the start and the end offsets, and set the page numbers.
    if max_lines == 0:
      end = self.total_size
      self.total_pages = 1
      self.current_page = 0
    else:
      self.total_pages = int(max(self.total_size - 1, 0) / max_lines) + 1
2049 2050 2051
      if start >= self.total_size:
        start = max(self.total_size - 1, 0)
      start -= (start % max_lines)
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
      self.current_page = int(start / max_lines)
      end = min(start + max_lines, self.total_size)
      param_dict['list_start'] = start
      param_dict['list_lines'] = max_lines
      selection = self.getSelection()
      selection.edit(params = param_dict)

    # Make a list of lines.
    line_class = self.getLineClass()
    line_list = []
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083

    try:
      section_index = 0
      current_section_base_index = 0
      current_section = report_section_list[0]
      current_section_size = current_section.object_list_len
      for i in range(start, end):
        # Make sure we go to the right section.
        while current_section_base_index + current_section_size <= i:
          current_section_base_index += current_section_size
          section_index += 1
          current_section = report_section_list[section_index]
          current_section_size = current_section.object_list_len

        offset = i - current_section_base_index + current_section.offset
        if current_section.is_summary:
          index = None
        elif self.isReportTreeMode():
          index = offset
        else:
          index = i
        #LOG('ListBox', 0, 'current_section.__dict__ = %r' % (current_section.__dict__,))
2084 2085
        if 'total_size' in param_dict.keys():
          param_dict.pop('total_size')
2086 2087 2088 2089 2090 2091
        row_css_class_name = self.getRowCSSClassName(
          brain=current_section.object_list[offset],
          field=self.field,
          list_index=index,
          total_size=self.total_size,
          **param_dict)
2092 2093 2094 2095 2096 2097
        line = line_class(renderer = self,
                          obj = current_section.object_list[offset],
                          index = index,
                          is_summary = current_section.is_summary,
                          context = current_section.context,
                          is_open = current_section.is_open,
2098
                          selection_domain = current_section.selection_domain,
2099
                          depth = current_section.depth,
2100 2101
                          domain_title = current_section.domain_title,
                          row_css_class_name = row_css_class_name)
2102 2103 2104 2105
        line_list.append(line)
    except IndexError:
      # If the report section list is empty, nothing to do.
      pass
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119

    return line_list

  def render(self, **kw):
    """Render the data. This must be overridden.
    """
    raise NotImplementedError, "render must be overridden in a subclass"

  def __call__(self, **kw):
    """Render the ListBox. The real rendering must be done the method "render" which should
    be defined in subclasses.
    """
    return self.render(**kw)

2120 2121 2122 2123 2124
  def getSelectionKey(self):
    selection_tool = self.getSelectionTool()
    selection_name = self.getSelectionName()
    return selection_tool.getAnonymousSelectionKey(selection_name)

2125
class ListBoxRendererLine:
2126 2127 2128
  """This class describes a line in a ListBox to assist ListBoxRenderer.
  """
  def __init__(self, renderer = None, obj = None, index = 0, is_summary = False, context = None,
2129 2130
               is_open = False, selection_domain = None, depth = 0, domain_title=None, render_prefix=None,
               row_css_class_name=None):
2131 2132 2133 2134 2135 2136 2137 2138
    """In reality, the object is a brain or a brain-like object.
    """
    self.renderer = renderer
    self.obj = obj
    self.index = index
    self.is_summary = is_summary
    self.context = context
    self.is_open = is_open
2139
    self.selection_domain = selection_domain
2140
    self.depth = depth
2141
    self.domain_title = domain_title
2142
    self.render_prefix = render_prefix
2143
    self.row_css_class_name = row_css_class_name
Fabien Morin's avatar
Fabien Morin committed
2144

2145 2146 2147 2148 2149 2150 2151 2152 2153
  def getBrain(self):
    """Return the brain. This can be identical to a real object.
    """
    return self.obj

  def getObject(self):
    """Return a real object.
    """
    try:
2154
      return self.obj.getObject()
2155
    except AttributeError:
2156
      return self.obj
2157

2158
  getObject = lazyMethod(getObject)
2159 2160 2161 2162 2163 2164

  def getUid(self):
    """Return the uid of the object.
    """
    return getattr(aq_base(self.obj), 'uid', None)

2165
  getUid = lazyMethod(getUid)
2166

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2167 2168 2169 2170 2171
  def getUrl(self):
    """Return the absolute URL path of the object
    """
    return self.getBrain().getUrl()

2172
  getUrl = lazyMethod(getUrl)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2173

2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
  def isSummary(self):
    """Return whether this line is a summary or not.
    """
    return self.is_summary

  def getContext(self):
    """Return the context of a line. This is used only for a summary line.
    """
    return self.context

  def isOpen(self):
    """Return whether this line is open or not. This is used only for a summary line.
    """
    return self.is_open

  def getDomainUrl(self):
    """Return the URL of a domain. Used only for a summary line.
    """
    return getattr(self.getContext(), 'domain_url', '')

2194 2195 2196 2197 2198 2199 2200 2201 2202 2203
  def getDomainTitle(self):
    """Return original title of domain"""
    if self.domain_title is not None:
      return self.domain_title
    else:
      context = self.getContext()
      if context is not None:
        return context.getTitleOrId() or ''
    return ''

2204 2205 2206 2207 2208 2209 2210 2211
  def getDepth(self):
    """Return the depth of a domain. Used only for a summary line.
    """
    return self.depth

  def getDomainSelection(self):
    """Return the domain selection. Used only for a summary line.
    """
2212
    return self.selection_domain
2213

2214 2215 2216 2217
  def getRowCSSClassName(self):
    """Return the css class name of a row.
    """
    return self.row_css_class_name
Fabien Morin's avatar
Fabien Morin committed
2218

2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
  def getValueList(self):
    """Return the list of values corresponding to selected columns.

    The format of a return value is [(original_value, processed_value), ...],
    where the original value means a raw result, while the processed value stands for
    a value more comprehensive for human, such as an error message.

    Every processed value is guaranteed to be encoded in unicode.
    """
    # If this is a report line without statistics, just return an empty result.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2229
    renderer = self.renderer
2230 2231
    obj = self.getObject()
    if obj is None:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2232
      return [(None, '')] * len(renderer.getSelectedColumnList())
2233 2234

    # Otherwise, evaluate each column.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2235
    stat_column_dict = dict(renderer.getStatColumnList())
2236 2237
    _marker = []
    value_list = []
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2238 2239
    selection = renderer.getSelection()
    param_dict = renderer.getParamDict()
2240 2241 2242 2243

    # Embed the selection index.
    selection.edit(index = self.index)

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2244
    for (sql, title), alias in zip(renderer.getSelectedColumnList(), renderer.getColumnAliasList()):
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
      editable_field = None
      original_value = None
      processed_value = None

      if self.isSummary():
        # Use a stat method for a summary.
        stat_method_id = stat_column_dict.get(sql)
        if stat_method_id == sql:
          stat_method_id = None

        context = self.getContext()
        if getattr(aq_base(context), alias, _marker) is not _marker and stat_method_id is None:
          # If a stat method is not specified, use the result in the context itself.
          original_value = getattr(context, alias)
          processed_value = original_value
2260
        elif stat_method_id is not None:
2261 2262 2263 2264 2265 2266 2267
          stat_method = getattr(context, stat_method_id)
          if callable(stat_method):
            try:
              new_param_dict = param_dict.copy()
              new_param_dict['closed_summary'] = not self.isOpen()
              selection.edit(params = new_param_dict, report = self.getDomainSelection())
              try:
2268 2269
                original_value = stat_method(selection = selection,
                                             selection_name = selection.getName())
2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
                processed_value = original_value
              except (ConflictError, RuntimeError):
                raise
              except:
                LOG('ListBox', WARNING, 'could not call %r with %r' % (stat_method, new_param_dict),
                    error = sys.exc_info())
                processed_value = 'Could not evaluate %s' % (stat_method_id,)
            finally:
              selection.edit(params = param_dict, report = None)
          else:
            original_value = stat_method
            processed_value = original_value
      else:
        # This is an usual line.
2284
        brain = self.getBrain()
2285 2286

        # Use a widget, if any.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2287
        editable_field = renderer.getEditableField(alias)
2288
        tales = False
2289
        if editable_field is not None:
2290 2291 2292 2293 2294 2295 2296
          # XXX we need to take care of whether the editable field is
          # a proxy field or not, because a proxy field may inherit a
          # tales expression from a template field, and the API is not
          # unified.
          get_tales = getattr(editable_field, 'get_recursive_tales',
                              editable_field.get_tales)
          tales = get_tales('default')
2297
          if tales:
2298 2299
            original_value = editable_field.__of__(obj).get_value('default',
                                                        cell=brain)
2300
            processed_value = original_value
2301

2302 2303
        # If a tales expression is not defined, get a skin, an accessor or a property.
        if not tales:
Nicolas Dumazet's avatar
Nicolas Dumazet committed
2304
          if getattr(aq_self(brain), alias, None) is not None:
2305 2306
            original_value = getattr(brain, alias)
            processed_value = original_value
2307
          else:
2308 2309
            try:
              # Get the trailing part.
2310
              try:
2311 2312 2313 2314 2315
                property_id = sql[sql.rindex('.') + 1:]
              except ValueError:
                property_id = sql

              try:
2316 2317 2318 2319 2320
                accessor_name = 'get%s' % UpperCase(property_id)
                # Make sure the object have the attribute, and this is not
                # acquired, but still get the attribute on the acquisition wrapper
                getattr(aq_base(obj), accessor_name)
                processed_value = original_value = getattr(obj, accessor_name)
2321 2322 2323 2324
              except AttributeError:
                original_value = getattr(obj, property_id, None)
                processed_value = original_value
            except (AttributeError, KeyError, Unauthorized):
2325
              original_value = None
2326
              processed_value = 'Could not evaluate %s' % property_id
2327 2328 2329 2330 2331

      # If the value is callable, evaluate it.
      if callable(original_value):
        try:
          try:
2332 2333 2334
            original_value = original_value(brain = self.getBrain(),
                                            selection = selection,
                                            selection_name = selection.getName())
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349
            processed_value = original_value
          except TypeError:
            original_value = original_value()
            processed_value = original_value
        except (ConflictError, RuntimeError):
          raise
        except:
          processed_value = 'Could not evaluate %s' % (original_value,)
          LOG('ListBox', WARNING, 'could not evaluate %r' % (original_value,),
              error = sys.exc_info())
          original_value = None

      # Process the value.
      if processed_value is None:
        processed_value = u''
2350
      elif not isinstance(processed_value, unicode):
2351
        processed_value = unicode(str(processed_value), renderer.getEncoding(), 'replace')
2352 2353 2354

      value_list.append((original_value, processed_value))

2355
    #LOG('ListBox.getValueList', 0, value_list)
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
    return value_list

class ListBoxHTMLRendererLine(ListBoxRendererLine):
  """This class is specialized to the HTML renderer.
  """
  def render(self):
    """Render the values obtained by getValueList. The result is a list of tuples,
    where each tuple consists of a piece of HTML, the original value and a boolean value which represents
    an error status. If the status is true, an error is detected.
    """
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2366 2367 2368 2369 2370 2371
    renderer = self.renderer
    request = renderer.request
    editable_column_id_set = renderer.getEditableColumnIdSet()
    field_id = renderer.getId()
    form = renderer.getForm()
    error_dict = renderer.getFieldErrorDict()
2372
    brain = self.getBrain()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2373 2374 2375 2376
    encoding = renderer.getEncoding()
    url_column_dict = dict(renderer.getUrlColumnList())
    selection = renderer.getSelection()
    selection_name = renderer.getSelectionName()
2377 2378
    ignore_layout = int(request.get('ignore_layout',
                        0 if request.get('is_web_mode') else 1))
2379
    editable_mode = int(request.get('editable_mode', 0))
2380
    ui_domain = 'erp5_ui'
2381 2382 2383 2384
    # We need a way to pass the current line object (ie. brain) to the
    # field which is being displayed. Since the render_view API did not
    # permit this, we use the 'cell' value to pass the line object.
    request.set('cell', brain)
2385 2386
    html_list = []

2387 2388 2389
    # Generate page selection methods based on the Listbox id
    createFolderMixInPageSelectionMethod(field_id)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402
    # Check is there is a validation error at the level of the listbox
    # as a whole. This will be required later to decide wherer to
    # display values from (ie. from the REQUEST or from the object)
    has_error = 0
    for key in error_dict.keys():
      for editable_id in editable_column_id_set:
        candidate_field_key = "%s_%s" % (field_id, editable_id)
        if key.startswith(candidate_field_key):
          has_error = 1
          break
      if has_error:
        break

2403
    for (original_value, processed_value), (sql, title), alias \
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2404
      in zip(self.getValueList(), renderer.getSelectedColumnList(), renderer.getColumnAliasList()):
2405 2406 2407 2408 2409 2410 2411 2412
      # By default, no error.
      error = False

      # Embed the selection index.
      selection.edit(index = self.index)

      # If a field is editable, generate an input form.
      # XXX why don't we generate an input form when a widget is not defined?
2413
      editable_field = renderer.getEditableField(alias)
2414

2415
      # Prepare link value - we now use it for both static and field rendering
2416
      no_link = self.isSummary()
2417 2418 2419 2420 2421 2422 2423
      url_method = None
      url = None

      # Find an URL method.
      if url_column_dict.has_key(sql):
        url_method_id = url_column_dict.get(sql)
        if url_method_id != sql:
2424
          if url_method_id not in (None, ''):
2425 2426 2427 2428 2429
            url_method = getattr(brain, url_method_id, None)
            if url_method is None:
              LOG('ListBox', WARNING, 'could not find the url method %s' % (url_method_id,))
              no_link = True
          else:
2430
            # If the URL Method is empty, generate no link.
2431 2432 2433 2434
            no_link = True

      if url_method is not None:
        try:
2435
          url = url_method(brain = brain, selection = selection,
2436 2437
                           selection_name = selection.getName(),
                           column_id=sql)
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
        except (ConflictError, RuntimeError):
          raise
        except:
          LOG('ListBox', WARNING, 'could not evaluate the url method %r with %r' % (url_method, brain),
              error = sys.exc_info())
      elif not no_link:
        # XXX For compatibility?
        # Check if this object provides a specific URL method.
        if getattr(brain, 'getListItemUrl', None) is not None:
          try:
            url = brain.getListItemUrl(alias, self.index, selection_name)
          except (ConflictError, RuntimeError):
            raise
          except:
            LOG('ListBox', WARNING, 'could not evaluate the url method getListItemUrl with %r' % (brain,),
                error = sys.exc_info())
        else:
          try:
2456 2457 2458 2459 2460
            # brain.absolute_url() is slow because it invokes
            # _aq_dynamic() every time to get brain.REQUEST,
            # so we call request.physicalPathToURL() directly
            # instead of brain.absolute_url().
            url = request.physicalPathToURL(brain.getPath())
2461 2462 2463
            params = []
            if ignore_layout:
              params.append('ignore_layout:int=1')
2464 2465
            if editable_mode:
              params.append('editable_mode:int=1')
2466
            if selection_name:
2467 2468 2469
              params.extend(('selection_name=%s' % selection_name,
                             'selection_index=%s' % self.index,
                             'reset:int=1'))
2470
              selection_tool = self.getObject().getPortalObject().portal_selections
2471
              if selection_tool.isAnonymous():
2472
                params.append('selection_key=%s' % selection.getAnonymousSelectionKey())
2473 2474
            if params:
              url = '%s?%s' % (url, '&amp;'.join(params))
2475 2476 2477
          except AttributeError:
            pass

2478
      if editable_field is not None:
2479
        # XXX what if the object does not have uid?
2480
        key = '%s_%s' % (editable_field.getId(), self.getUid())
2481
        if sql in editable_column_id_set:
2482
          listbox_defines_column_as_editable = True
2483 2484
          if has_error: # If there is any error on listbox, we should use what the user has typed
            display_value = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2485
          else:
2486 2487 2488 2489 2490
            validated_value_dict = request.get(field_id, None)
            if validated_value_dict is None:
              # If this is neither an error nor a validated listbox
              # we should use the original value
              display_value = original_value
2491
            else:
2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
              # If the listbox has been validated (ie. as it is the
              # case whenever a relation field displays a popup menu)
              # we have to use the value entered by the user
              display_value = None #
          if error_dict.has_key(key): # If error on current field, we should display message
            error_text = error_dict[key].error_text
            error_text = cgi.escape(error_text)
            if isinstance(error_text, str):
              error_mapping = getattr(error_dict[key], 'error_mapping', None)
              if error_mapping is not None:
                error_text = u'%s' % Message(domain=ui_domain,
                                             message=error_text,
                                             mapping=error_mapping)
              else:
                error_text = u'%s' % Message(domain=ui_domain,
                                             message=error_text)
            error_message = u'<br />' + error_text
          else:
            error_message = u''
2511
        else:
2512
          listbox_defines_column_as_editable = False
2513
          error_message = u''
2514
          display_value = original_value
2515

2516
        enabled = editable_field.get_value('enabled', REQUEST=request)
2517
        editable = editable_field.get_value('editable', REQUEST=request)
2518
        if enabled:
2519 2520
          # Field is editable only if listbox lists it in editable columns AND
          # if listbox_field is editable
2521 2522 2523 2524
          cell_html = editable_field.render(
            value=display_value,
            REQUEST=request,
            key=key,
2525 2526
            editable=(not self.isSummary()) \
              and listbox_defines_column_as_editable and editable,
2527
          )
2528 2529
          if isinstance(cell_html, str):
            cell_html = unicode(cell_html, encoding)
2530
        else:
2531
          cell_html = u''
2532

2533 2534 2535
        if url is None:
          html = cell_html + error_message
        else:
2536
          if editable:
2537 2538 2539 2540
            html = u'%s' % cell_html
          else:
            html = u'<a href="%s">%s</a>' % (url, cell_html)
          if error_message not in ('', None):
2541
            html += u' <span class="error">%s</span>' % error_message
2542 2543
      else:
        # If not editable, show a static text with a link, if enabled.
Julien Muchembled's avatar
Julien Muchembled committed
2544 2545
        html = cgi.escape(processed_value)
        if url is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2546 2547
          # JPS-XXX - I think we should not display a URL for objects
          # which do not have the View permission
Julien Muchembled's avatar
typo  
Julien Muchembled committed
2548
          if isinstance(url, str):
2549
            url = unicode(url, encoding)
Julien Muchembled's avatar
Julien Muchembled committed
2550
          html = u'<a href="%s">%s</a>' % (url, html)
2551

2552
      html_list.append((html, original_value, error, editable_field, url))
2553 2554
    return html_list

2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
allow_class(ListBoxHTMLRendererLine)

class ListBoxRendererContext(Acquisition.Explicit):
  """This class helps making a context for a Page Template,
  because Page Template requires an acquisition context.
  """
  def __init__(self, renderer):
    self.renderer = renderer
    # XXX this is a workaround for GlobalTranslationService.
    self.Localizer = renderer.getContext().Localizer
2565 2566
    # XXX this is a workaround for unicodeconflictresolver.
    self.REQUEST = renderer.request
2567 2568 2569

  def __getattr__(self, name):
    return getattr(self.renderer, name)
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581

class ListBoxHTMLRenderer(ListBoxRenderer):
  """This class implements HTML rendering for ListBox.
  """
  def getLineClass(self):
    """Return the line class.
    """
    return ListBoxHTMLRendererLine

  def getLineStart(self):
    """Return a requested start number.
    """
2582
    return int(self.getParamDict().get('list_start', 0))
2583

2584
  getLineStart = lazyMethod(getLineStart)
2585 2586 2587 2588 2589 2590

  def getMaxLineNumber(self):
    """Return the maximum number of lines shown in a page.
    """
    return self.field.get_value('lines')

2591
  getMaxLineNumber = lazyMethod(getMaxLineNumber)
2592

2593 2594 2595 2596
  def getMD5Checksum(self):
    """Generate a MD5 checksum against checked uids. This is used to confirm
    that selected values do not change between a display of a dialog and an execution.

2597 2598 2599
    FIXME: SelectionTool.getSelectionChecksum's uid_list parameter is
    deprecated, but Folder_deleteObjectList does not use the feature that
    checked uids are used when no list method is specified.
2600
    """
2601 2602 2603 2604
    return self.getSelectionTool().getSelectionChecksum(
      self.getSelectionName(),
      uid_list=self.request.get('uids'),
    )
2605

2606 2607 2608 2609 2610 2611
  def getPhysicalRoot(self):
    """Return the physical root (an Application object). This method is required for
    Page Template to make a context.
    """
    return self.getContext().getPhysicalRoot()

2612
  asHTML = PageTemplateFile('www/%s' %DEFAULT_LISTBOX_PAGE_TEMPLATE, globals())
2613 2614 2615 2616 2617 2618 2619 2620

  def getPageTemplate(self):
    """Return a Page Template to render.
    """
    context = ListBoxRendererContext(self)

    # If a specific template is specified, use it.
    method_id = self.field.get_value('page_template')
2621 2622
    if method_id not in (None, ''):
      try:
2623
        return getattr(context, method_id)
2624
      except AttributeError:
2625
        return getattr(context.getPortalObject(), method_id).__of__(context)
2626
      return aq_base(getattr(self.getContext(), method_id)).__of__(context)
2627 2628
    # Try to get a page template from acquisition context then portal object
    # and fallback on default page template.
2629
    page_template = getattr(self.getContext(), DEFAULT_LISTBOX_PAGE_TEMPLATE, None)
2630 2631
    if page_template is None:
        portal_object = context.getPortalObject()
2632
        page_template = getattr(portal_object, DEFAULT_LISTBOX_PAGE_TEMPLATE, context.asHTML)
2633
    return page_template.__of__(context)
2634

2635 2636 2637
  def render(self, **kw):
    """Render the data in HTML.
    """
2638 2639 2640
    request = self.request
    field_id = self.getId()
    
2641 2642 2643
    # Make it sure to store the current selection, only if a list method is defined.
    list_method = self.getListMethod()
    if list_method is not None:
2644
      selection = self.getSelection()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2645
      method_path = '%s/%s' % (getPath(self.getContext()), self.getListMethodName())
2646 2647 2648 2649
      list_url = '%s?selection_name=%s' % (self.getUrl(), self.getRequestedSelectionName())
      selection_index = self.getSelectionIndex()
      if selection_index is not None:
        list_url += '&selection_index=%s' % selection_index
2650
      selection.edit(method_path = method_path, list_url = list_url)
2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667
      
      # listbox search columnd are passed in format: <listbox_field_id>_<search_column>
      # this is done to allow multiple listboxes in one page with same search column names
      update_selection = False
      form_dict = request.form
      listbox_kw = selection.getParams()
      listbox_arguments_list = [x for x in form_dict.keys() if x.startswith(field_id)]
      for original_listbox_argument in listbox_arguments_list:
        listbox_argument = original_listbox_argument.replace('%s_' %field_id, '', 1)
        listbox_argument_value = form_dict.get(original_listbox_argument, None)
        if listbox_argument in list(self.getSearchColumnIdSet()) and \
           listbox_argument_value not in (None,):
          update_selection = True
          listbox_kw[listbox_argument] = listbox_argument_value
      if update_selection:
        selection.edit(listbox_kw)
      self.getSelectionTool().setSelectionFor(self.getSelectionName(), selection, REQUEST = request)
2668

2669 2670
    # do pass current form and respective field through request
    form = self.getForm()
Ivan Tyagov's avatar
Ivan Tyagov committed
2671 2672
    request.set('%s_form_id' %field_id, form.getId())
    request.set('%s_field_id' %field_id, field_id)
2673 2674 2675 2676 2677
    pt = self.getPageTemplate()
    return pt()

allow_class(ListBoxHTMLRenderer)

2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
class ListBoxListRenderer(ListBoxRenderer):
  """This class implements list rendering for ListBox.
  """
  def getLineClass(self):
    """Return the line class. For now, ListBoxListRenderer uses the generic class.
    """
    return ListBoxRendererLine

  def getLineStart(self):
    """Return always 0.
    """
    return 0

  def getMaxLineNumber(self):
    """Return always 0 (infinite).
    """
    return 0

  def render(self, **kw):
    """Render the data in a list of ListBoxLine objects.
    """
    listboxline_list = []

    # Make a title line.
    title_listboxline = ListBoxLine()
    title_listboxline.markTitleLine()
    for c in self.getSelectedColumnList():
      title_listboxline.addColumn(c[0], c[1].encode(self.getEncoding()))
    listboxline_list.append(title_listboxline)

    # Obtain the list of lines.
    checked_uid_set = set(self.getCheckedUidList())
    for line in self.query():
      listboxline = ListBoxLine()
      listboxline.markDataLine()
2713
      listboxline.setSectionDepth(line.getDepth())
2714
      listboxline.setRowCSSClassName(line.getRowCSSClassName())
2715 2716
      if line.isSummary():
        listboxline.markSummaryLine()
2717 2718 2719 2720 2721 2722
        # XXX It was line.getDepth()+1 before, but
        # it probably make no sense so I (seb) removed this
        listboxline.setSectionDepth(line.getDepth())
        # Do not get the context again, it was already computed
        # in getReportSectionList
        listboxline.setSectionName(line.domain_title)
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756
        listboxline.setSectionFolded(not line.isOpen())

      if line.getBrain() is not None:
        uid = line.getUid()
        listboxline.setObjectUid(uid)
        listboxline.checkLine(uid in checked_uid_set)

      for (original_value, processed_value), (sql, title) in zip(line.getValueList(), self.getSelectedColumnList()):
        if isinstance(original_value, unicode):
          value = original_value.encode(self.getEncoding())
        else:
          value = original_value

        if isinstance(value, str):
          value = value.replace('&nbsp;', ' ')

        listboxline.addColumn(sql, value)

      listboxline_list.append(listboxline)

    # Make a stat line, if enabled.
    if self.showStat():
      stat_listboxline = ListBoxLine()
      stat_listboxline.markStatLine()

      for (original_value, processed_value), (sql, title) in zip(self.getStatValueList(), self.getSelectedColumnList()):
        if isinstance(original_value, unicode):
          value = original_value.encode(self.getEncoding())
        else:
          value = original_value

        if isinstance(value, str):
          value = value.replace('&nbsp;', ' ')

2757
        stat_listboxline.addColumn(sql, value)
2758 2759 2760 2761 2762 2763 2764

      listboxline_list.append(stat_listboxline)

    return listboxline_list

class ListBoxValidator(Validator.Validator):
    property_names = Validator.Validator.property_names
2765 2766
    message_names = Validator.Validator.message_names + ['required_not_found']
    required_not_found = 'Input is required but no input given.'
2767 2768 2769 2770 2771 2772 2773 2774

    def validate(self, field, key, REQUEST):
        form = field.aq_parent
        # We need to know where we get the getter from
        # This is coppied from ERP5 Form
        here = getattr(form, 'aq_parent', REQUEST)
        columns = field.get_value('columns')
        editable_columns = field.get_value('editable_columns')
2775 2776
        column_ids = [x[0] for x in columns]
        editable_column_ids = [x[0] for x in editable_columns]
2777
        editable_field_dict = {}
2778 2779 2780 2781 2782
        for sql in editable_column_ids:
          alias = sql.replace('.', '_')
          editable_field_dict[alias] = ListBoxRenderer(
                                          field=field).getEditableField(alias)
          
2783 2784
        selection_name = field.get_value('selection_name')
        #LOG('ListBoxValidator', 0, 'field = %s, selection_name = %s' % (repr(field), repr(selection_name)))
2785 2786
        portal = here.getPortalObject()
        params = portal.portal_selections.getSelectionParamsFor(
2787
                                                           selection_name,
2788
                                                           REQUEST=REQUEST)
2789
        portal_url = portal.portal_url
2790 2791 2792

        result = {}
        error_result = {}
2793 2794 2795 2796 2797 2798 2799 2800 2801
        listbox_empty = REQUEST.get('%s_empty' % field.id, False)
        if listbox_empty:
          listbox_uids = []
        else:
          try:
            listbox_uids = REQUEST['%s_uid' % field.id]
          except KeyError:
            raise KeyError('Field %s is not present in request object.'
                           % field.id)
2802 2803 2804
        select = field.get_value('select')
        if select:
          selected_uid_set = set(REQUEST.get('uids', ()))
2805 2806
        #LOG('ListBox.validate: REQUEST',0,REQUEST)
        errors = []
2807
        object_list = None
2808 2809 2810 2811 2812
        # We have two things to do in the case of temp objects,
        # the first thing is to create a list with new temp objects
        # then try to validate some data, and then create again
        # the list with a listbox as parameter. Like this we
        # can use tales expression
2813 2814
        listbox = {}
        for uid in listbox_uids:
2815
          if uid[:4] == 'new_':
2816
            if object_list is None:
2817 2818
              list_method = field.get_value('list_method')
              list_method = getattr(here, list_method.method_name)
2819 2820
              #LOG('ListBoxValidator', 0, 'call %s' % repr(list_method))
              object_list = list_method(REQUEST=REQUEST, **params)
2821
            row_key = uid[4:]
2822 2823 2824 2825
            for o in object_list:
              if o.getUid() == uid:
                break
            else:
2826
              # First case: dialog input to create new objects
2827
              o = newTempBase(portal, row_key) # Arghhh - XXX acquisition problem - use portal root
2828
              o.uid = uid
2829
            listbox[row_key] = row_result = {}
2830 2831
            # We first try to set a listbox corresponding to all things
            # we can validate, so that we can use the same list
2832 2833
            # as the one used for displaying the listbox
            for sql in editable_column_ids:
2834
              editable_field = editable_field_dict.get(sql.replace('.', '_'))
2835 2836
              if editable_field is not None:
                error_result_key = '%s_%s' % (editable_field.id, o.uid)
2837
                key = 'field_' + error_result_key
2838
                REQUEST.set('cell', o)
2839
                try:
2840
                  value = editable_field._validate_helper(key, REQUEST) # We need cell
2841
                  # Here we set the property
2842
                  row_result[sql] = value
2843
                except ValidationError, err:
2844
                  pass
2845 2846
                except KeyError:
                  pass
2847 2848
        # Here we generate again the object_list with listbox the listbox we
        # have just created
2849
        if listbox:
2850 2851
          list_method = field.get_value('list_method')
          list_method = getattr(here, list_method.method_name)
2852
          REQUEST.set(field.id, listbox)
2853
          object_list = list_method(REQUEST=REQUEST, **params)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2854
        for uid in listbox_uids:
2855 2856
          row_result = {}
          if uid[:4] == 'new_':
2857
            # First case: dialog input to create new objects
2858
            row_key = uid[4:]
2859 2860 2861 2862
            for o in object_list:
              if o.getUid() == uid:
                break
            else:
2863
              o = newTempBase(portal, row_key) # Arghhh - XXX acquisition problem - use portal root
2864
              o.uid = uid
2865
            for sql in editable_column_ids:
2866
              editable_field = editable_field_dict.get(sql.replace('.', '_'))
2867
              if editable_field is not None:
2868
                REQUEST.set('cell', o)
2869 2870 2871
                editable = editable_field.get_value('editable', REQUEST=REQUEST)
                enabled = editable_field.get_value('enabled', REQUEST=REQUEST)
                if editable and enabled and field.need_validate(REQUEST):
2872
                  error_result_key = '%s_%s' % (editable_field.id, o.uid)
2873
                  key = 'field_' + error_result_key
2874
                  try:
2875 2876
                    row_result[sql] = editable_field._validate_helper(
                      key, REQUEST) # We need cell
2877
                  except ValidationError, err:
2878 2879 2880
                    #LOG("ListBox ValidationError",0,str(err))
                    err.field_id = error_result_key
                    errors.append(err)
2881 2882 2883 2884
                  except KeyError:
                    err = ValidationError('required_not_found', field)
                    err.field_id = field.id
                    errors.append(err)
2885 2886
          else:
            # Second case: modification of existing objects
2887 2888
            #try:
            if 1: #try:
2889 2890
              # We must try this
              # because sometimes, we can be provided bad uids
2891 2892
              try :
                o = here.portal_catalog.getObject(uid)
2893
              except (KeyError, NotFound, ValueError), err:
2894 2895
                # It is possible that this object is not catalogged yet. So
                # the object must be obtained from ZODB.
2896
                if object_list is None:
2897 2898
                  list_method = field.get_value('list_method')
                  list_method = getattr(here, list_method.method_name)
2899 2900 2901 2902 2903 2904 2905 2906 2907 2908
                  object_list = list_method(REQUEST=REQUEST, **params)
                for o in object_list:
                  try:
                    if o.getUid() == int(uid):
                      break
                  except ValueError:
                    if str(o.getUid()) == uid:
                      break
                else:
                  raise err
2909 2910 2911
              row_key = o.getUrl()
              for sql in editable_column_ids:
                editable_field = editable_field_dict.get(sql.replace('.', '_'))
2912
                if editable_field is not None:
2913
                  REQUEST.set('cell', o) # We need cell
2914 2915
                  if editable_field.get_value('editable', REQUEST=REQUEST) and \
                     editable_field.need_validate(REQUEST):
2916
                    error_result_key = '%s_%s' % (editable_field.id, o.uid)
2917
                    key = 'field_' + error_result_key
2918
                    try:
2919 2920
                      row_result[sql] = error_result[error_result_key] = \
                        editable_field._validate_helper(key, REQUEST)
2921
                    except ValidationError, err:
2922 2923
                      err.field_id = error_result_key
                      errors.append(err)
2924 2925 2926 2927
                    except KeyError:
                      err = ValidationError('required_not_found', field)
                      err.field_id = field.id
                      errors.append(err)
2928 2929
            #except:
            else:
2930
              LOG("ListBox WARNING",0,"Object uid %s could not be validated" % uid)
2931
          result[row_key] = row_result
2932 2933
          if select:
            row_result['listbox_selected'] = uid in selected_uid_set
2934
        if len(errors) > 0:
Nicolas Delaby's avatar
Nicolas Delaby committed
2935 2936
            #LOG("ListBox FormValidationError",0,str(error_result))
            #LOG("ListBox FormValidationError",0,str(errors))
2937
            raise FormValidationError(errors, error_result)
2938
        return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2939 2940 2941 2942

ListBoxValidatorInstance = ListBoxValidator()

class ListBox(ZMIField):
2943
  meta_type = "ListBox"
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2944

2945 2946
  widget = ListBoxWidgetInstance
  validator = ListBoxValidatorInstance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2947

2948
  security = ClassSecurityInfo()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2949

2950 2951 2952 2953
  security.declareProtected('Access contents information', 'get_value')
  def get_value(self, id, **kw):
    if (id == 'default'):
      if (kw.get('render_format') in ('list', )):
2954 2955 2956 2957 2958 2959
        request = kw.get('REQUEST', None)
        if request is None:
          request = get_request()
        # here the field can be a a proxyfield target, in this case just find
        # back the original proxy field so that renderer's calls to .get_value
        # are called on the proxyfield.
2960 2961 2962
        field = request.get(
          'field__proxyfield_%s_%s_%s' % (self.id, self._p_oid, id),
          self)
2963 2964
        return self.widget.render(field, self.generate_field_key(), None,
                                  request,
2965 2966
                                  render_format=kw.get('render_format'),
                                  render_prefix=kw.get('render_prefix'))
2967
      else:
2968 2969 2970
        return None
    else:
      return ZMIField.get_value(self, id, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2971

2972 2973 2974
  security.declareProtected('Access contents information', 'getListMethodName')
  def getListMethodName(self):
    """Return the name of the list method. If not defined, return None.
2975 2976

       XXX - Is this method really necessary - I am not sure - JPS
2977 2978
       Why not use Formulator API instead ? -> the answer is that it is a
         MethodField, and it's method_name attribute is not available from
2979 2980
         restricted environment. It is only used in
         ERP5Site_checkNamingConventions
2981 2982 2983

      XXX also this method is not compatible with ProxyFields.
      It will go away soon.
2984 2985 2986 2987 2988 2989 2990
    """
    list_method = self.get_value('list_method')
    try:
      name = getattr(list_method, 'method_name')
    except AttributeError:
      name = list_method
    return name or None
2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001

class ListBoxLine:
  meta_type = "ListBoxLine"
  security = ClassSecurityInfo()
  #security.declareObjectPublic()

  def __init__(self):
    """
      Initialize the line and set the default values
      Selected columns must be defined in parameter of listbox.render...
    """
3002

3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020
    self.is_title_line = 0
    self.is_data_line = 1
    self.is_stat_line = 0
    self.is_summary_line = 0

    self.is_section_folded = 1

    self.config_dict = {
      'is_checked' : 0,
      'uid' : None,
      'section_name' : None,
      'section_depth' : 0,
      'content_mode' : 'DataLine'
    }
    self.config_display_list = []

    self.column_dict = {}
    self.column_id_list = []
3021
    self.row_css_class_name = ''
Fabien Morin's avatar
Fabien Morin committed
3022

3023 3024
  security.declarePublic('__getitem__')
  def __getitem__(self, column_id):
3025
    return self.getColumnProperty(column_id)
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041

  #security.declarePublic('View')
  def setConfigProperty(self, config_id, config_value):
    self.config_dict[config_id] = config_value

  #security.declarePublic('View')
  def getConfigProperty(self, config_id):
    return self.config_dict[config_id]

  #security.declarePublic('View')
  def setListboxLineContentMode(self, content_mode):
    """
      Toogle the content type of the line
      content_mode can be 'TitleLine' 'StatLine' 'DataLine'
      Default value is 'DataLine'
    """
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052
    content_mode_dict = {
      'TitleLine':(1,0,0,0),
      'DataLine':(0,1,0,0),
      'StatLine':(0,0,1,0),
      'SummaryLine':(0,0,0,1)
    }
    self.is_title_line,\
    self.is_data_line,\
    self.is_stat_line,\
    self.is_summary_line = content_mode_dict[content_mode]

3053
    self.setConfigProperty('content_mode', content_mode)
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074

  #security.declarePublic('View')
  def markTitleLine(self):
    """
      Set content of the line to 'TitleLine'
    """
    self.setListboxLineContentMode('TitleLine')

  security.declarePublic('isTitleLine')
  def isTitleLine(self):
    """
      Returns 1 is this line contains no data but only title of columns
    """
    return self.is_title_line

  #security.declarePublic('View')
  def markStatLine(self):
    """
      Set content of the line to 'StatLine'
    """
    self.setListboxLineContentMode('StatLine')
3075

3076 3077
  security.declarePublic('isStatLine')
  def isStatLine(self):
3078 3079 3080 3081
    """
      Returns 1 is this line contains no data but only stats
    """
    return self.is_stat_line
3082

3083 3084 3085 3086 3087 3088
  #security.declarePublic('View')
  def markDataLine(self):
    """
      Set content of the line to 'DataLine'
    """
    self.setListboxLineContentMode('DataLine')
3089

3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116
  security.declarePublic('isDataLine')
  def isDataLine(self):
    """
      Returns 1 is this line contains data
    """
    return self.is_data_line

  #security.declarePublic('View')
  def markSummaryLine(self):
    """
      Set content of the line to 'SummaryLine'
    """
    self.setListboxLineContentMode('SummaryLine')

  security.declarePublic('isSummaryLine')
  def isSummaryLine(self):
    """
      Returns 1 is this line is a summary line
    """
    return self.is_summary_line

  #security.declarePublic('View')
  def checkLine(self, is_checked):
    """
      Set line to checked if is_checked=1
      Default value is 0
    """
3117
    self.setConfigProperty('is_checked', is_checked)
3118 3119 3120 3121 3122 3123 3124

  security.declarePublic('isLineChecked')
  def isLineChecked(self):
    """
      Returns 1 is this line is checked
    """
    return self.getConfigProperty('is_checked')
3125

3126 3127 3128 3129 3130 3131
  #security.declarePublic('View')
  def setObjectUid(self, object_uid):
    """
      Define the uid of the object
      Default value is None
    """
3132
    self.setConfigProperty('uid', object_uid)
3133 3134 3135 3136 3137 3138 3139

  security.declarePublic('getObjectUid')
  def getObjectUid(self):
    """
      Get the uid of the object related to the line
    """
    return self.getConfigProperty('uid')
3140

3141 3142 3143 3144 3145 3146
  #security.declarePublic('View')
  def setSectionName(self, section_name):
    """
      Set the section name of this line
      Default value is None
    """
3147
    self.setConfigProperty('section_name', section_name)
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162

  security.declarePublic('getSectionName')
  def getSectionName(self):
    """
      Returns the section name of this line
      Default value is None
    """
    return self.getConfigProperty('section_name')

  #security.declarePublic('View')
  def setSectionDepth(self, depth):
    """
      Set the section depth of this line
      default value is 0 and means no depth
    """
3163
    self.setConfigProperty('section_depth', depth)
3164

3165 3166 3167 3168 3169 3170 3171
  security.declarePublic('getSectionDepth')
  def getSectionDepth(self):
    """
      Returns the section depth of this line
      0 means no depth
    """
    return self.getConfigProperty('section_depth')
3172

3173 3174 3175 3176 3177 3178
  #security.declarePublic('View')
  def setSectionFolded(self, is_section_folded):
    """
      Set the section mode of this line to 'Folded' if is_section_folded=1
    """
    self.is_section_folded = is_section_folded
3179

3180 3181 3182 3183 3184
  security.declarePublic('isSectionFolded')
  def isSectionFolded(self):
    """
      Returns 1 if section is in 'Folded' Mode
    """
3185 3186
    return self.is_section_folded

3187 3188 3189
  #security.declarePublic('View')
  def addColumn(self, column_id, column_value):
    """
3190
      Add a new column
3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
    """
    self.column_dict[column_id] = column_value
    self.column_id_list.append(column_id)

  security.declarePublic('getColumnProperty')
  def getColumnProperty(self, column_id):
    """
      Returns the property of a column
    """
    return self.column_dict[column_id]

  security.declarePublic('getColumnPropertyList')
  def getColumnPropertyList(self, column_id_list = None):
    """
3205
      Returns a list of the property
3206 3207
      column_id_list selects the column_id returned
    """
3208

3209 3210
    if column_id_list == None:
      column_id_list = self.column_id_list
3211

3212 3213 3214 3215
    if self.isTitleLine():
      config_column = [None] * len(self.config_display_list)
    else:
      config_column = [self.config_dict[column_id] for column_id in self.config_display_list]
3216

3217 3218
    return config_column + [self.column_dict[column_id] for column_id in column_id_list]

3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
  security.declarePublic('getColumnPropertyTypeName')
  def getColumnPropertyTypeName(self, column_id):
    """
      Returns the type of a property of a column in
      the form of a string

      NOTE: experimental method - may change in the future
    """
    return type(self.column_dict[column_id]).__name__

3229 3230 3231 3232 3233 3234
  security.declarePublic('getColumnItemList')
  def getColumnItemList(self, column_id_list = None ):
    """
      Returns a list of property tuple
      column_id_list selects the column_id returned
    """
3235

3236 3237
    if column_id_list == None:
      column_id_list = self.column_id_list
3238

3239 3240 3241 3242 3243 3244 3245
    """
    if self.isTitleLine():
      config_column = [None] * len(self.config_display_list)
    else:
      config_column = [(config_id, self.config_dict[column_id]) for config_id in self.config_display_list]
    """
    config_column = [(config_id, self.config_dict[config_id]) for config_id in self.config_display_list]
3246

3247
    return config_column + [(column_id , self.column_dict[column_id]) for column_id in column_id_list]
3248

3249 3250 3251 3252 3253 3254 3255 3256
  security.declarePublic('setListboxLineDisplayListMode')
  def setListboxLineDisplayListMode(self, display_list):
    """
      Set the config columns displayable
      display_list can content the key of self.config_dict
      Default value of display_list is []
    """
    self.config_display_list = display_list
3257

3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
  security.declarePublic('setRowCSSClassName')
  def setRowCSSClassName(self, row_css_class_name):
    """Set the CSS class name of a row
    """
    self.row_css_class_name = row_css_class_name

  security.declarePublic('getRowCSSClassName')
  def getRowCSSClassName(self):
    """Return the CSS class name of a row
    """
    return self.row_css_class_name
Fabien Morin's avatar
Fabien Morin committed
3269

3270 3271 3272
InitializeClass(ListBoxLine)
allow_class(ListBoxLine)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3273
# Psyco
3274
from Products.ERP5Type.PsycoWrapper import psyco
3275
#psyco.bind(ListBoxWidget.render)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3276 3277
psyco.bind(ListBoxValidator.validate)

3278 3279 3280
# Register get_value
from Products.ERP5Form.ProxyField import registerOriginalGetValueClassAndArgument
registerOriginalGetValueClassAndArgument(ListBox, 'default')