ListBox.py 117 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 SelectionTool import createFolderMixInPageSelectionMethod
Yoshinori Okuji's avatar
Yoshinori Okuji committed
38
from Products.ERP5Type.Utils import getPath
39
from Products.ERP5Type.Document import newTempBase
40
from Products.CMFCore.utils import getToolByName
41
from Products.ZSQLCatalog.zsqlbrain import ZSQLBrain
42
from Products.ERP5Type.Message import Message
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
48
from Globals import InitializeClass, Acquisition, get_request
49
from Products.PythonScripts.Utility import allow_class
50
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
51

52
import md5
53
import cgi
54

55 56 57 58 59 60
# For compatibility with Python 2.3.
try:
  set
except NameError:
  from sets import Set as set

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

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

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

81 82 83 84 85 86
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):
87
    for parameter_id in ('selection', 'selection_name', 'select_columns',
88
      'reset', 'selection_index', 'list_selection_name', 'list_start',
89 90
      'list_lines', 'listbox_list_start', 'listbox_uid', 'listbox_nextPage',
      'listbox_previousPage',
91 92 93 94 95
      # 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',
      '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 171 172 173 174 175

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.

        ListBox uses the following control variables

        - sort_by -- the id to sort results

        - sort_order -- the order of sorting
    """
176 177 178 179 180
    # 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
181 182 183 184 185

    lines = fields.IntegerField('lines',
                                title='Lines',
                                description=(
        "The number of lines of this list. Required."),
186
                                default=20,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
187
                                required=1)
188
    property_names.append('lines')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
189 190 191 192 193 194 195

    columns = fields.ListTextAreaField('columns',
                                 title="Columns",
                                 description=(
        "A list of attributes names to display. Required."),
                                 default=[],
                                 required=1)
196
    property_names.append('columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
197 198 199 200 201 202 203

    all_columns = fields.ListTextAreaField('all_columns',
                                 title="More Columns",
                                 description=(
        "An optional list of attributes names to display."),
                                 default=[],
                                 required=0)
204
    property_names.append('all_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
205 206 207 208 209 210 211

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

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

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

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

237 238 239 240 241 242
    count_method = fields.MethodField('count_method',
                                 title='Count Method',
                                 description=('The method to use to count'
                                              'objects'),
                                 default='',
                                 required=0)
243
    property_names.append('count_method')
244

Jean-Paul Smets's avatar
Jean-Paul Smets committed
245 246
    stat_method = fields.MethodField('stat_method',
                                 title='Stat Method',
247
                                 description=('The method to use to stat'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
248 249 250
                                              'objects'),
                                 default='',
                                 required=0)
251
    property_names.append('stat_method')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252

253 254 255 256 257 258 259
    row_css_method = fields.MethodField('row_css_method',
                                 title='Row CSS Method',
                                 description=('The method to set the css class name of a row'),
                                 default='',
                                 required=0)
    property_names.append('row_css_method')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
260 261 262 263 264
    selection_name = fields.StringField('selection_name',
                                 title='Selection Name',
                                 description=('The name of the selection to store'
                                              'params of selection'),
                                 default='',
265
                                 required=1)
266
    property_names.append('selection_name')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
267 268 269 270 271 272 273

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

    portal_types = fields.ListTextAreaField('portal_types',
                                 title="Portal Types",
                                 description=(
        "Portal Types of objects to list. Required."),
                                 default=[],
                                 required=0)
282
    property_names.append('portal_types')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
283

284
    # XXX Do we still need this?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
285 286 287 288 289 290
    default_params = fields.ListTextAreaField('default_params',
                                 title="Default Parameters",
                                 description=(
        "Default Parameters for the List Method."),
                                 default=[],
                                 required=0)
291
    property_names.append('default_params')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
292 293 294 295

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

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

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

315 316 317 318 319 320 321 322
    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)
    property_names.append('hide_rows_on_no_search_criterion')

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

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

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

347 348 349 350 351 352 353 354
    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')

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

    domain_tree = fields.CheckBoxField('domain_tree',
                                 title='Domain Tree',
                                 description=('Selection Tree'),
367
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
368
                                 required=0)
369
    property_names.append('domain_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
370 371 372 373 374 375 376

    domain_root_list = fields.ListTextAreaField('domain_root_list',
                                 title="Domain Root",
                                 description=(
        "A list of domains which define the possible root."),
                                 default=[],
                                 required=0)
377
    property_names.append('domain_root_list')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
378 379 380 381

    report_tree = fields.CheckBoxField('report_tree',
                                 title='Report Tree',
                                 description=('Report Tree'),
382
                                 default=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383
                                 required=0)
384
    property_names.append('report_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
385 386 387 388 389 390 391

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

    list_action = fields.StringField('list_action',
                                 title='List Action',
                                 description=('The id of the object action'
397
                                              ' to display the current list'),
398
                                 default='list',
399
                                 required=0)
400
    property_names.append('list_action')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
401

402 403 404 405 406 407 408 409
    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')

410
    def render_view(self, field, value, REQUEST=None, render_format='html', key='listbox', render_prefix=None):
411
        """
412
          Render a ListBox in read-only.
413
        """
414
        if REQUEST is None: REQUEST=get_request()
415 416
        return self.render(field, key, value, REQUEST, render_format=render_format,
                           render_prefix=render_prefix)
417

418 419
    def render(self, field, key, value, REQUEST, render_format='html',
               render_prefix=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
420 421 422
        """
          This is where most things happen. This method renders a list
          of items
423

Jean-Paul Smets's avatar
Jean-Paul Smets committed
424 425 426
          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.)
427

Jean-Paul Smets's avatar
Jean-Paul Smets committed
428
          the 'list' format includes additional metainformation
429

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

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

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
438
          - etc.
439

Jean-Paul Smets's avatar
Jean-Paul Smets committed
440
          which is intended to simplify operation with a spreadsheet or a pagetemplate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441
        """
442 443
        if REQUEST is None:
          REQUEST = get_request()
444
        if render_format == 'list':
445 446
          renderer = ListBoxListRenderer(self, field, REQUEST,
                                         render_prefix=render_prefix)
447
        else:
448
          renderer = ListBoxHTMLRenderer(self, field, REQUEST, render_prefix=render_prefix)
449

450
        return renderer()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
451

452
ListBoxWidgetInstance = ListBoxWidget()
453

454 455 456
def lazyMethod(func):
  """Return a function which stores a computed value in an instance
  at the first call.
457
  """
458 459
  key = '_cache_' + str(id(func))
  def decorated(self, *args, **kw):
460
    try:
461
      return getattr(self, key)
462
    except AttributeError:
463 464
      result = func(self, *args, **kw)
      setattr(self, key, result)
465
      return result
466
  return decorated
467 468

class ListBoxRenderer:
469 470 471 472 473
  """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.
  """
474

475
  def __init__(self, widget = None, field = None, REQUEST = None, render_prefix=None, **kw):
476 477 478 479 480
    """Store the parameters for later use.
    """
    self.widget = widget
    self.field = field
    self.request = REQUEST
481
    self.render_prefix = render_prefix
Jean-Paul Smets's avatar
Jean-Paul Smets committed
482

483 484 485
  def getPhysicalPath(self):
    """
      Return the path of form we render.
486
      This function is required to be able to use ZopeProfiler product with
487 488 489 490
      listbox.
    """
    return self.field.getPhysicalPath()

491 492 493 494
  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
495

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

498 499 500
  def getContext(self):
    """Return the context of rendering this ListBox.
    """
501 502 503 504
    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
505

506
  getContext = lazyMethod(getContext)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
507

508 509 510
  def getForm(self):
    """Return the form which contains the ListBox.
    """
511
    return self.field.aq_parent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
512

513
  getForm = lazyMethod(getForm)
514

515 516 517 518
  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
519

520
  getEncoding = lazyMethod(getEncoding)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
521

522 523 524 525 526
  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
527

528
  isReset = lazyMethod(isReset)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
529

530 531 532 533
  def getFieldErrorDict(self):
    """Return a dictionary of errors.
    """
    return self.request.get('field_errors', {})
Jean-Paul Smets's avatar
Jean-Paul Smets committed
534

535
  getFieldErrorDict = lazyMethod(getFieldErrorDict)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
536

537 538
  def getUrl(self):
    """
539 540 541 542 543 544 545
      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
546

547
  getUrl = lazyMethod(getUrl)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
548

549 550 551 552 553 554
  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')
555

556 557 558 559
    # 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
560

561
    return selection_name
562

563
  getRequestedSelectionName = lazyMethod(getRequestedSelectionName)
564

565 566 567 568
  def getSelectionIndex(self):
    """Return the index of a requested selection, or None if not specified.
    """
    return self.request.get('selection_index', None)
569

570
  getSelectionIndex = lazyMethod(getSelectionIndex)
571

572 573 574 575
  def getReportDepth(self):
    """Return the depth of reports, or None if not specified.
    """
    return self.request.get('report_depth', None)
576

577
  getReportDepth = lazyMethod(getReportDepth)
578

579 580 581 582
  def getPortalObject(self):
    """Return the portal object.
    """
    return self.getContext().getPortalObject()
583

584
  getPortalObject = lazyMethod(getPortalObject)
585

586 587 588 589
  def getPortalUrlString(self):
    """Return the URL of the portal as a string.
    """
    return self.getPortalObject().portal_url()
590

591
  getPortalUrlString = lazyMethod(getPortalUrlString)
592

593 594 595 596
  def getCategoryTool(self):
    """Return the Category Tool.
    """
    return self.getPortalObject().portal_categories
597

598
  getCategoryTool = lazyMethod(getCategoryTool)
599

600 601 602 603
  def getDomainTool(self):
    """Return the Domain Tool.
    """
    return self.getPortalObject().portal_domains
604

605
  getDomainTool = lazyMethod(getDomainTool)
606

607 608 609 610
  def getCatalogTool(self):
    """Return the Catalog Tool.
    """
    return self.getPortalObject().portal_catalog
611

612
  getCatalogTool = lazyMethod(getCatalogTool)
613

614 615 616 617
  def getSelectionTool(self):
    """Return the Selection Tool.
    """
    return self.getPortalObject().portal_selections
618

619
  getSelectionTool = lazyMethod(getSelectionTool)
620

621 622 623 624 625 626 627 628
  def getPrefixedString(self, string):
    prefix = self.render_prefix
    if prefix is None:
      result = string
    else:
      result = '%s_%s' % (prefix, string)
    return result

629 630
  def getId(self):
    """Return the id of the field. Usually, "listbox".
631
       The prefix will automatically be added
632
    """
633
    return self.getPrefixedString(self.field.id)
634

635
  getId = lazyMethod(getId)
636

637 638 639 640 641 642 643
  def getUnprefixedId(self):
    """Return the id of the field. Usually, "listbox".
    """
    return self.field.id

  getUnprefixedId = lazyMethod(getUnprefixedId)

644 645 646 647
  def getTitle(self):
    """Return the title. Make sure that it is in unicode.
    """
    return unicode(self.field.get_value('title'), self.getEncoding())
648

649
  getTitle = lazyMethod(getTitle)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
650

651 652 653 654 655
  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"
656

657 658 659 660
  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
661

662
  showSearchLine = lazyMethod(showSearchLine)
663

664 665 666 667
  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
668

669
  showSelectColumn = lazyMethod(showSelectColumn)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
670

671 672 673 674 675 676 677
  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)

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
  def isHideRowsOnNoSearchCriterion(self, REQUEST={}):
    """
      Return a boolean that represents whether search rows are shown or not.
    """
    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
    # we could hide rows only if missing in request or selection search criterions
    selection_params = self.getSelection().getParams()
    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):
        # search criterion is usually input by user by UI, ignore created automated 
        # 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

702
  isHideRowsOnNoSearchCriterion = lazyMethod(isHideRowsOnNoSearchCriterion)
703

704 705
  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
706

707 708 709 710
    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
711

712
  showStat = lazyMethod(showStat)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
713

714 715 716 717
  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)
718

719
  isDomainTreeSupported = lazyMethod(isDomainTreeSupported)
720 721 722 723 724 725

  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)

726
  isReportTreeSupported = lazyMethod(isReportTreeSupported)
727 728 729 730 731 732

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

733
  isDomainTreeMode = lazyMethod(isDomainTreeMode)
734 735 736 737 738 739

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

740
  isReportTreeMode = lazyMethod(isReportTreeMode)
741 742 743 744 745 746

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

747
  getDefaultParamList = lazyMethod(getDefaultParamList)
748 749 750 751 752 753 754 755 756 757 758

  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

759
  getListMethodName = lazyMethod(getListMethodName)
760 761 762 763 764 765 766 767 768 769 770

  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

771
  getCountMethodName = lazyMethod(getCountMethodName)
772 773 774 775 776 777 778 779 780 781 782

  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

783
  getStatMethodName = lazyMethod(getStatMethodName)
784

785 786 787 788 789 790 791 792 793 794 795 796
  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)
  
797 798 799
  def getSelectionName(self):
    """Return the selection name.
    """
800
    return self.getPrefixedString(self.field.get_value('selection_name'))
801

802
  getSelectionName = lazyMethod(getSelectionName)
803 804 805 806 807 808 809

  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

810
  getMetaTypeList = lazyMethod(getMetaTypeList)
811 812 813 814 815 816 817

  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

818
  getPortalTypeList = lazyMethod(getPortalTypeList)
819 820 821 822 823 824 825

  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]

826
  getColumnList = lazyMethod(getColumnList)
827 828 829 830 831 832 833 834 835 836 837

  def getAllColumnList(self):
    """Return the all columns. Make sure that the titles are in unicode.
    """
    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

838
  getAllColumnList = lazyMethod(getAllColumnList)
839 840 841 842 843 844 845 846 847 848 849

  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

850
  getStatColumnList = lazyMethod(getStatColumnList)
851 852 853 854 855 856 857

  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 []

858 859 860 861 862 863 864
  def getUntranslatableColumnList(self):
    """Return the untranslatable columns. Make sure that it is an empty list, 
    when not defined.
    """
    untranslatable_columns = self.field.get_value('untranslatable_columns')
    return untranslatable_columns or []

865
  getUrlColumnList = lazyMethod(getUrlColumnList)
866 867 868 869 870 871

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

872
  getDefaultSortColumnList = lazyMethod(getDefaultSortColumnList)
873 874 875 876 877 878 879

  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]

880
  getDomainRootList = lazyMethod(getDomainRootList)
881 882 883 884 885 886 887

  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]

888
  getReportRootList = lazyMethod(getReportRootList)
889 890 891 892 893 894 895 896 897 898 899

  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:
      search_column_id_list = self.getCatalogTool().schema()
    return set(search_column_id_list)

900
  getSearchColumnIdSet = lazyMethod(getSearchColumnIdSet)
901 902 903 904 905 906 907 908 909 910 911

  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

912
  getSortColumnIdSet = lazyMethod(getSortColumnIdSet)
913 914 915 916 917 918 919

  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])

920
  getEditableColumnIdSet = lazyMethod(getEditableColumnIdSet)
921 922 923 924

  def getListActionUrl(self):
    """Return the URL of the list action.
    """
925 926 927 928 929 930 931
    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]
932 933 934 935
    if '?' in list_action_part_list[-1]:
      list_action_part_list.append('&reset=1')
    else:
      list_action_part_list.append('?reset=1')
936 937
    if self.request.get('ignore_layout', None):
      list_action_part_list.append('&ignore_layout:int=1')
938 939
    return ''.join(list_action_part_list)

940
  getListActionUrl = lazyMethod(getListActionUrl)
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959

  # 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:
960
      selection = Selection(params = dict(self.getDefaultParamList()), default_sort_on = self.getDefaultSortColumnList())
961
      selection = selection.__of__(selection_tool)
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
    # 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

990
  getSelection = lazyMethod(getSelection)
991 992 993 994 995 996

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

997
  getCheckedUidList = lazyMethod(getCheckedUidList)
998

999 1000 1001 1002 1003
  def getCheckedUidSet(self):
    """Return the set of checked uids.
    """
    return set(self.getCheckedUidList())

1004
  getCheckedUidSet = lazyMethod(getCheckedUidSet)
1005

1006 1007 1008 1009 1010 1011 1012
  def getSelectedColumnList(self):
    """Return the list of selected columns.
    """
    return self.getSelectionTool().getSelectionColumns(self.getSelectionName(),
                                                       columns = self.getColumnList(),
                                                       REQUEST = self.request)

1013
  getSelectedColumnList = lazyMethod(getSelectedColumnList)
1014 1015 1016 1017 1018 1019 1020 1021 1022

  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

1023
  getColumnAliasList = lazyMethod(getColumnAliasList)
1024 1025 1026 1027

  def getParamDict(self):
    """Return a dictionary of parameters.
    """
1028
    params = dict(self.getSelection().getParams())
1029 1030 1031 1032 1033 1034 1035
    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.
      params.update(self.request.form)
      for k, v in self.getDefaultParamList():
        params.setdefault(k, v)

1036 1037 1038 1039 1040
      search_prefix = 'search_%s_' % (self.getId(), )
      for k, v in params.items():
        if k.startswith(search_prefix):
          params[k[len(search_prefix):]] = v

1041 1042 1043 1044 1045
      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:
1046
          search_alias = '_'.join(search_id.split('.'))
1047
          # If the search field could not be found, try to get an "editable" field on current form.
1048 1049
          search_field = self.getEditableField(search_alias)
          if search_field is None:
1050
            continue
1051

1052
        render_dict = search_field.render_dict(search_value)
1053
        if render_dict is not None:
1054
          params[search_id] = render_dict
1055

1056 1057 1058 1059
      # Set parameters, depending on the list method.
      list_method_name = self.getListMethodName()
      meta_type_list = self.getMetaTypeList()
      portal_type_list = self.getPortalTypeList()
1060 1061 1062 1063 1064
      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)

1065
      # Remove FileUpload parameters
1066 1067 1068 1069 1070 1071
      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():
1072
              if hasattr(v1, 'read'):
1073 1074 1075
                del line[k1]
            new_list.append(line)
          params[k] = new_list
1076
        if hasattr(v, 'read'):
1077
          del params[k]
1078

1079 1080 1081
      # remove some erp5_xhtml_style specific parameters
      params.pop('saved_form_data', None)

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 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
    # 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']
1118

1119
    self.getSelection().edit(params=params)
1120 1121
    return params

1122
  getParamDict = lazyMethod(getParamDict)
1123

1124 1125 1126 1127 1128
  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()
1129
    editable_field_id = '%s_%s' % (self.getUnprefixedId(), alias)
1130 1131
    if form.has_field(editable_field_id, include_disabled=1):
      return form.get_field(editable_field_id, include_disabled=1)
1132 1133 1134 1135 1136 1137 1138 1139
    
    # if we are rendering a proxy field, also look for editable fields from the
    # template field's form.
    if self.field.has_value('form_id'):
      form = getattr(self.field, self.field.get_value('form_id'), None)
      if form and form.has_field(editable_field_id, include_disabled=1):
        return form.get_field(editable_field_id, include_disabled=1)

1140 1141
    return None

1142 1143 1144 1145 1146
  def getListMethod(self):
    """Return the list method object.
    """
    list_method_name = self.getListMethodName()

1147 1148
    if list_method_name in ('objectValues', 'contentValues'):
      list_method = ListMethodWrapper(self.getContext(), list_method_name)
1149 1150
    elif list_method_name == 'searchFolder':
      list_method = CatalogMethodWrapper(self.getContext(), list_method_name)
1151
    elif list_method_name is not None:
1152
      list_method = getattr(self.getContext(), list_method_name, None)
1153 1154 1155 1156 1157
    else:
      list_method = None

    return list_method

1158
  getListMethod = lazyMethod(getListMethod)
1159 1160 1161 1162 1163 1164 1165 1166 1167

  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
1168 1169 1170 1171
    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)
1172
    elif count_method_name is not None:
1173
      count_method = getattr(self.getContext(), count_method_name, None)
1174 1175 1176 1177 1178
    else:
      count_method = None

    return count_method

1179
  getCountMethod = lazyMethod(getCountMethod)
1180 1181 1182 1183 1184 1185 1186 1187 1188

  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
1189 1190 1191 1192
    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)
1193
    elif stat_method_name is not None:
1194
      stat_method = getattr(self.getContext(), stat_method_name, None)
1195 1196 1197 1198 1199
    else:
      stat_method = None

    return stat_method

1200
  getStatMethod = lazyMethod(getStatMethod)
1201

1202 1203 1204 1205 1206 1207
  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:
1208
      row_css_method = getattr(self.getContext(), row_css_method_name, None)
1209 1210 1211 1212
    return row_css_method

  getRowCSSMethod = lazyMethod(getRowCSSMethod)
  
1213 1214 1215
  def getDomainSelection(self):
    """Return a DomainSelection object wrapped with the context.
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1216
    portal_object = self.getPortalObject()
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
    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 :
1235
            root_dict[base_domain] = ('portal_categories', domain)
1236
          elif domain_tool is not None:
1237 1238 1239 1240
            try:
              root = domain_tool.getDomainByPath(domain, None)
            except KeyError:
              root = None
1241
            if root is not None:
1242
              root_dict[base_domain] = ('portal_domains', domain)
1243
        if root is None:
1244 1245 1246
          root = portal_object.restrictedTraverse(domain, None)
          if root is not None:
            root_dict[None] = (None, domain)
1247 1248 1249

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

1250
  getDomainSelection = lazyMethod(getDomainSelection)
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278

  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)

1279
  getStatSelectExpression = lazyMethod(getStatSelectExpression)
1280

1281 1282 1283 1284 1285 1286
  def makeReportTreeList(self, root_dict = None, report_path = None, base_category = None, depth = 0,
                         unfolded_list = (), is_report_opened = True, sort_on = (('id', 'ASC'),)):
    """Return a list of report trees.
    """
    if isinstance(report_path, str):
      report_path = report_path.split('/')
1287
    if base_category is None and len(report_path):
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
      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
1300
    category = base_category
1301
    while is_empty_level:
1302
      if not root_dict.has_key(category):
1303 1304 1305
        root = None
        if category_tool is not None:
          try:
1306
            if category == 'parent':
1307
              # parent has a special treatment
1308 1309
              root = self.getContext()
              root_dict[category] = root_dict[None] = (root, (None, root.getRelativeUrl()))
1310
            else:
1311 1312 1313
              root = category_tool[category]
              root_dict[category] = root_dict[None] = (root, ('portal_categories', root.getRelativeUrl()))
            report_path = report_path[1:]
1314 1315 1316 1317
          except KeyError:
            pass
        if root is None and domain_tool is not None:
          try:
1318 1319
            root = domain_tool[category]
            root_dict[category] = root_dict[None] = (root, ('portal_domains', root.getRelativeUrl()))
1320 1321 1322 1323
            report_path = report_path[1:]
          except KeyError:
            pass
        if root is None:
1324 1325 1326
          root = portal_object.unrestrictedTraverse(report_path, None)
          if root is not None:
            root_dict[None] = (root, (None, root.getRelativeUrl()))
1327 1328
          report_path = ()
      else:
1329 1330
        root_dict[None] = root_dict[category]
        root = root_dict[None][0]
1331 1332 1333
        report_path = report_path[1:]
      is_empty_level = (root is None or root.objectCount() == 0) and (len(report_path) != 0)
      if is_empty_level:
1334
        category = report_path[0]
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351

    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:
      obj_list = root.contentValues(sort_on = sort_on)
    else:
      obj_list = ()

    for obj in obj_list:
      new_root_dict = root_dict.copy()
1352 1353 1354 1355
      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]
1356
      selection_domain = DomainSelection(domain_dict = domain_dict)
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370

      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':
          for sub_obj in obj.contentValues(sort_on = sort_on):
            if getattr(aq_base(sub_obj), 'objectValues', None) is not None:
1371
              exception_uid_list.append(sub_obj.getUid())
1372 1373 1374

        # Summary (open)
        tree_list.append(ReportTree(obj = obj, is_pure_summary = True, depth = depth,
1375
                                    base_category = base_category,
1376
                                    is_open = True, selection_domain = selection_domain,
1377 1378 1379 1380
                                    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,
1381
                                      base_category = base_category,
1382
                                      is_open = False, selection_domain = selection_domain,
1383
                                      exception_uid_list = exception_uid_list))
1384 1385 1386 1387 1388
        # 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
1389 1390
        tree_list.extend(self.makeReportTreeList(root_dict = new_root_dict,
                                                 report_path = report_path,
1391
                                                 base_category = new_base_category,
1392 1393 1394 1395 1396 1397 1398
                                                 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,
1399
                                    base_category = base_category,
1400
                                    is_open = False, selection_domain = selection_domain,
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
                                    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"

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
  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

1424
  getSelectedDomainPath = lazyMethod(getSelectedDomainPath)
1425

1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
  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)

1441
  getSelectedReportPath = lazyMethod(getSelectedReportPath)
1442

1443 1444 1445 1446 1447 1448
  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
1449 1450 1451
    sort_dict = {}
    for sort_item in sort_list:
      sort_dict[sort_item[0]] = sort_item[1] # sort_item can be couple or a triplet
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
    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

1463
  def getSearchValueList(self, param_dict=None):
1464 1465 1466 1467 1468
    """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()
1469 1470
    if param_dict is None:
      param_dict = self.getParamDict()
1471
    value_list = []
1472
    for (sql, title), alias in zip(self.getSelectedColumnList(), self.getColumnAliasList()):
1473 1474
      if sql in search_column_id_set:
        # Get the current value and encode it in unicode.
1475
        param = param_dict.get(alias, param_dict.get(sql, u''))
1476 1477
        if isinstance(param, dict):
          param = param.get('query', u'')
1478 1479 1480 1481
        if isinstance(param, str):
          param = unicode(param, self.getEncoding())

        # Obtain a search field, if any.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1482 1483 1484
        form = self.getForm()
        if form.has_field(alias):
          search_field = form.get_field(alias)
1485 1486 1487
        else:
          search_field = None

1488
        value_list.append((sql, param, search_field))
1489 1490 1491 1492
      else:
        value_list.append((None, None, None))

    return value_list
1493
  
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
  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)
1505 1506 1507 1508 1509 1510 1511 1512 1513

    _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']
1514 1515

    # For each column, check the presense of a specific stat method. If not present,
1516
    # use getStatMethodResult defined above.
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
    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

1530 1531 1532 1533
      if stat_method_id is None:
        original_value = None
        processed_value = u''
      elif stat_method is None:
1534
        try:
1535
          original_value = getattr(getStatMethodResult()[0], alias)
1536 1537 1538 1539 1540 1541 1542
          processed_value = original_value
        except (IndexError, AttributeError, KeyError, ValueError):
          original_value = None
          processed_value = u''
      else:
        if callable(stat_method):
          try:
1543 1544
            original_value = stat_method(selection = selection,
                                         selection_name = selection.getName())
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
            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
1556

1557 1558 1559
      editable_field = self.getEditableField(alias)
      if editable_field is not None:
        processed_value = editable_field.render_view(value=original_value)
1560 1561 1562 1563 1564 1565 1566 1567

      if not isinstance(processed_value, unicode):
        processed_value = unicode(str(processed_value), self.getEncoding())

      value_list.append((original_value, processed_value))

    return value_list

1568 1569 1570 1571 1572 1573 1574 1575
  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

1576 1577 1578 1579 1580 1581 1582 1583
  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()
1584
    selection_tool = self.getSelectionTool()
1585
    report_list = selection.getReportList()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1586
    stat_select_expression = self.getStatSelectExpression()
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
    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)

1618 1619
      # Update report list if report_depth was specified. This information is used
      # to store what domains are unfolded by clicking on a depth.
1620 1621 1622 1623 1624 1625
      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
1626
        report_tree_obj = report_tree.obj
1627 1628 1629 1630

        # 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.
1631
        selection.edit(report = report_tree.selection_domain)
1632

1633 1634 1635 1636 1637 1638 1639 1640
        # 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
1641
        domain_context = report_tree_obj.getProperty('context_url', None)
1642 1643 1644 1645
        if domain_context is not None:
          domain_context = context.restrictedTraverse(domain_context)
        else:
          domain_context = context
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1646
        domain_list_method = report_tree_obj.getProperty('list_method',
1647
            list_method)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1648
        domain_stat_method = report_tree_obj.getProperty('stat_method',
1649 1650
            stat_method)

1651 1652 1653 1654 1655 1656 1657
        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.
1658
          stat_brain = selection(method=domain_stat_method, context=domain_context, REQUEST=self.request)
1659

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

1662 1663 1664 1665 1666 1667 1668
          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
1669
          stat_context = report_tree_obj.asContext(**stat_result)
1670
          # XXX yo thinks that this code below is useless, so disabled.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1671
          #absolute_url_txt = report_tree_obj.absolute_url()
1672
          #stat_context.absolute_url = lambda: absolute_url_txt
1673
          stat_context.domain_url = report_tree.domain_url
1674 1675
          report_section_list.append(ReportSection(is_summary = True, object_list = [stat_context],
                                                   object_list_len = 1, is_open = report_tree.is_open,
1676
                                                   selection_domain = report_tree.selection_domain,
1677 1678
                                                   context = stat_context, depth = report_tree.depth,
                                                   domain_title = domain_title))
1679 1680 1681 1682 1683
        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.
1684
            object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
          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:
1702
            if self.showStat():
1703 1704 1705
              report_section_list.append(ReportSection(is_summary = False, object_list = object_list,
                                                       object_list_len = object_list_len,
                                                       is_open = report_tree.is_open,
1706
                                                       selection_domain = report_tree.selection_domain,
1707
                                                       depth = report_tree.depth))
1708
          else:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1709
            stat_context = report_tree_obj.asContext()
1710 1711
            #absolute_url_txt = s[0].absolute_url()
            #stat_context.absolute_url = lambda : absolute_url_txt
1712
            stat_context.domain_url = report_tree.domain_url
1713 1714 1715 1716 1717 1718 1719
            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,
1720
                                                       selection_domain = report_tree.selection_domain,
1721 1722
                                                       context = stat_context,
                                                       depth = report_tree.depth))
1723 1724 1725 1726
              report_section_list.append(ReportSection(is_summary = False,
                                                       object_list = object_list,
                                                       object_list_len = object_list_len - 1,
                                                       is_open = True,
1727
                                                       selection_domain = report_tree.selection_domain,
1728 1729
                                                       offset = 1,
                                                       depth = report_tree.depth))
1730 1731 1732 1733
            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
1734
                                                         object_list = [report_tree_obj],
1735 1736
                                                         object_list_len = 1,
                                                         is_open = report_tree.is_open,
1737
                                                         selection_domain = report_tree.selection_domain,
1738 1739
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1740 1741 1742 1743 1744 1745
              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,
1746
                                                         selection_domain = report_tree.selection_domain,
1747 1748
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1749 1750 1751 1752 1753 1754 1755

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

1756
      domain_found = 0
1757
      if self.isDomainTreeMode():
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
        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)
1782
              domain_found = 1
1783
              break
1784
      if not domain_found:
1785 1786 1787
        domain_context = context
        domain_list_method = list_method
        domain_count_method = count_method
1788 1789 1790 1791

      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.
1792
          count = selection(method=domain_count_method, context=domain_context, REQUEST=self.request)
1793 1794 1795 1796
          object_list_len = int(count[0][0])

          # Tweak the line start.
          if start >= object_list_len:
1797
            start = max(object_list_len - 1, 0)
1798 1799 1800 1801 1802 1803
          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)
1804
          object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815
          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:
1816
          object_list = selection(method=domain_list_method, context=domain_context, REQUEST=self.request)
1817 1818 1819 1820 1821 1822
          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.
1823
        object_list = selection_tool.getSelectionValueList(selection_name,
1824
                                                                   context = context, REQUEST = self.request)
1825
        object_list_len= len(object_list)
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
        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()
1838 1839 1840 1841
    if self.isHideRowsOnNoSearchCriterion():
      report_section_list = []
    else:
      report_section_list = self.getReportSectionList()
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853
    param_dict = self.getParamDict()

    # Set the total number of objects.
    self.total_size = sum([s.object_list_len for s in report_section_list])

    # 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
1854 1855 1856
      if start >= self.total_size:
        start = max(self.total_size - 1, 0)
      start -= (start % max_lines)
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
      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 = []
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888

    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__,))
1889 1890 1891 1892 1893
        new_param_dict = param_dict.copy()
        new_param_dict['brain'] = current_section.object_list[offset]
        new_param_dict['list_index'] = index
        new_param_dict['total_size'] = self.total_size
        row_css_class_name = self.getRowCSSClassName(**new_param_dict)
1894 1895 1896 1897 1898 1899
        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,
1900
                          selection_domain = current_section.selection_domain,
1901
                          depth = current_section.depth,
1902 1903
                          domain_title = current_section.domain_title,
                          row_css_class_name = row_css_class_name)
1904 1905 1906 1907
        line_list.append(line)
    except IndexError:
      # If the report section list is empty, nothing to do.
      pass
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921

    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)

1922
class ListBoxRendererLine:
1923 1924 1925
  """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,
1926 1927
               is_open = False, selection_domain = None, depth = 0, domain_title=None, render_prefix=None,
               row_css_class_name=None):
1928 1929 1930 1931 1932 1933 1934 1935
    """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
1936
    self.selection_domain = selection_domain
1937
    self.depth = depth
1938
    self.domain_title = domain_title
1939
    self.render_prefix = render_prefix
1940 1941
    self.row_css_class_name = row_css_class_name
    
1942 1943 1944 1945 1946 1947 1948 1949 1950
  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:
1951
      return self.obj.getObject()
1952
    except AttributeError:
1953
      return self.obj
1954

1955
  getObject = lazyMethod(getObject)
1956 1957 1958 1959 1960 1961

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

1962
  getUid = lazyMethod(getUid)
1963

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1964 1965 1966 1967 1968
  def getUrl(self):
    """Return the absolute URL path of the object
    """
    return self.getBrain().getUrl()

1969
  getUrl = lazyMethod(getUrl)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1970

1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
  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', '')

1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
  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 ''

2001 2002 2003 2004 2005 2006 2007 2008
  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.
    """
2009
    return self.selection_domain
2010

2011 2012 2013 2014 2015
  def getRowCSSClassName(self):
    """Return the css class name of a row.
    """
    return self.row_css_class_name
  
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
  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
2026
    renderer = self.renderer
2027
    if self.getObject() is None:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2028
      return [(None, '')] * len(renderer.getSelectedColumnList())
2029 2030

    # Otherwise, evaluate each column.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2031
    stat_column_dict = dict(renderer.getStatColumnList())
2032 2033
    _marker = []
    value_list = []
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2034 2035
    selection = renderer.getSelection()
    param_dict = renderer.getParamDict()
2036 2037 2038 2039

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

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2040
    for (sql, title), alias in zip(renderer.getSelectedColumnList(), renderer.getColumnAliasList()):
2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
      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
2056
        elif stat_method_id is not None:
2057 2058 2059 2060 2061 2062 2063
          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:
2064 2065
                original_value = stat_method(selection = selection,
                                             selection_name = selection.getName())
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
                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.
2080
        obj = None # Only evaluate if needed
2081
        brain = self.getBrain()
2082 2083

        # Use a widget, if any.
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2084
        editable_field = renderer.getEditableField(alias)
2085
        tales = False
2086
        if editable_field is not None:
2087 2088
          tales = editable_field.tales.get('default', '')
          if tales:
2089
            if obj is None: obj = self.getObject()
2090 2091
            original_value = editable_field.__of__(obj).get_value('default',
                                                        cell=brain)
2092
            processed_value = original_value
2093

2094 2095
        # If a tales expression is not defined, get a skin, an accessor or a property.
        if not tales:
2096
          if (obj is None or brain is not obj) and getattr(aq_self(brain), alias, None) is not None:
2097 2098
            original_value = getattr(brain, alias)
            processed_value = original_value
2099 2100 2101
          else:
            obj = self.getObject()
            if obj is not None:
2102
              try:
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120
                # Get the trailing part.
                try:
                  property_id = sql[sql.rindex('.') + 1:]
                except ValueError:
                  property_id = sql
  
                try:
                  original_value = obj.getProperty(property_id, _marker)
                  if original_value is _marker:
                    raise AttributeError, property_id
                  processed_value = original_value
                except AttributeError:
                  original_value = getattr(obj, property_id, None)
                  processed_value = original_value
              except (AttributeError, KeyError, Unauthorized):
                original_value = None
                processed_value = 'Could not evaluate %s' % property_id
            else:
2121
              original_value = None
2122
              processed_value = 'Object does not exist'
2123 2124 2125 2126 2127

      # If the value is callable, evaluate it.
      if callable(original_value):
        try:
          try:
2128 2129 2130
            original_value = original_value(brain = self.getBrain(),
                                            selection = selection,
                                            selection_name = selection.getName())
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
            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''
2146
      elif not isinstance(processed_value, unicode):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2147
        processed_value = unicode(str(processed_value), renderer.getEncoding())
2148 2149 2150

      value_list.append((original_value, processed_value))

2151
    #LOG('ListBox.getValueList', 0, value_list)
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
    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
2162 2163 2164 2165 2166 2167
    renderer = self.renderer
    request = renderer.request
    editable_column_id_set = renderer.getEditableColumnIdSet()
    field_id = renderer.getId()
    form = renderer.getForm()
    error_dict = renderer.getFieldErrorDict()
2168
    brain = self.getBrain()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2169 2170 2171 2172
    encoding = renderer.getEncoding()
    url_column_dict = dict(renderer.getUrlColumnList())
    selection = renderer.getSelection()
    selection_name = renderer.getSelectionName()
2173 2174
    ignore_layout = int(request.get('ignore_layout', \
                        not request.get('is_web_mode', False) and 1 or 0))
2175
    ui_domain = 'erp5_ui'
2176 2177 2178

    html_list = []

2179 2180 2181
    # Generate page selection methods based on the Listbox id
    createFolderMixInPageSelectionMethod(field_id)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
    # 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

2195
    for (original_value, processed_value), (sql, title), alias \
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2196
      in zip(self.getValueList(), renderer.getSelectedColumnList(), renderer.getColumnAliasList()):
2197 2198 2199 2200 2201 2202 2203 2204
      # 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?
2205 2206
      editable_field = None
      if not self.isSummary():
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2207
        editable_field = renderer.getEditableField(alias)
2208

2209 2210 2211 2212 2213 2214 2215 2216 2217
      # Prepare link value - we now use it for both static and field rendering
      no_link = False
      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:
2218
          if url_method_id not in (None, ''):
2219 2220 2221 2222 2223
            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:
2224
            # If the URL Method is empty, generate no link.
2225 2226 2227 2228
            no_link = True

      if url_method is not None:
        try:
2229 2230
          url = url_method(brain = brain, selection = selection,
                           selection_name = selection.getName())
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248
        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:
2249
            url = '%s/view?selection_index=%s&amp;selection_name=%s&amp;ignore_layout:int=%s&amp;reset:int=1' % (
2250 2251 2252 2253 2254
                      # 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().
                      request.physicalPathToURL(brain.getPath()),
2255
                      self.index, selection_name, ignore_layout)
2256 2257 2258
          except AttributeError:
            pass

2259 2260
      if editable_field is not None and sql in editable_column_id_set:
        # XXX what if the object does not have uid?
2261
        key = '%s_%s' % (editable_field.getId(), self.getUid())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2262 2263 2264 2265
        widget_key = editable_field.generate_field_key(key=key)
        if has_error: # If there is any error on listbox, we should use what the user has typed
          display_value = None
        else:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2266
          validated_value_dict = request.get(field_id, None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
          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
          else:
            # 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
2277 2278 2279
          error_text = error_dict[key].error_text
          error_text = cgi.escape(error_text)
          if isinstance(error_text, str):
2280 2281 2282 2283 2284 2285 2286 2287
            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)
2288 2289 2290 2291
          error_message = u'<br />' + error_text
        else:
          error_message = u''

2292
        if getattr(brain, 'asContext', None) is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2293 2294 2295 2296 2297 2298 2299 2300
          # We needed 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 pass the line object
          # as the REQUEST. But this has side effects since it breaks
          # many possibilities. Therefore, the trick is to wrap
          # the REQUEST into the brain. In addition, the define a
          # cell property on the request itself so that forms may
          # use the 'cell' value (refer to get_value method in Form.py)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2301 2302
          cell_request = brain.asContext( REQUEST = request
                                        , form    = request.form
2303
                                        , cell    = brain
2304 2305 2306 2307 2308 2309 2310 2311 2312
                                        )
          if editable_field.get_value('enabled', REQUEST=cell_request):
            cell_html = editable_field.render( \
                              value   = display_value
                            , REQUEST = cell_request
                            , key     = key
                            )
          else:
            cell_html = ''
2313
        else:
2314
          # If the brain does not support asContext (eg. it is None), no way
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2315
          request.cell = self.getObject()
2316 2317 2318 2319 2320 2321 2322 2323
          cell_request = brain
          if editable_field.get_value('enabled', REQUEST=cell_request):
            cell_html = editable_field.render( value   = display_value
                                             , REQUEST = cell_request
                                             , key     = key
                                             )
          else:
            cell_html = ''
2324 2325 2326 2327

        if isinstance(cell_html, str):
          cell_html = unicode(cell_html, encoding)

2328 2329 2330
        if url is None:
          html = cell_html + error_message
        else:
2331
          if editable_field.get_value('editable', REQUEST=cell_request):
2332 2333 2334 2335
            html = u'%s' % cell_html
          else:
            html = u'<a href="%s">%s</a>' % (url, cell_html)
          if error_message not in ('', None):
2336
            html += u' <span class="error">%s</span>' % error_message
2337 2338 2339 2340 2341 2342
      else:
        # If not editable, show a static text with a link, if enabled.
        processed_value = cgi.escape(processed_value)
        if url is None:
          html = processed_value
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2343 2344
          # JPS-XXX - I think we should not display a URL for objects
          # which do not have the View permission
2345
          if type(url) is str:
2346
            url = unicode(url.decode('utf-8'))
2347 2348
          html = u'<a href="%s">%s</a>' % (url, processed_value)

2349
      html_list.append((html, original_value, error, editable_field, url))
2350 2351 2352

    return html_list

2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
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
2363 2364
    # XXX this is a workaround for unicodeconflictresolver.
    self.REQUEST = renderer.request
2365 2366 2367

  def __getattr__(self, name):
    return getattr(self.renderer, name)
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379

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.
    """
2380
    return int(self.getParamDict().get('list_start', 0))
2381

2382
  getLineStart = lazyMethod(getLineStart)
2383 2384 2385 2386

  def getMaxLineNumber(self):
    """Return the maximum number of lines shown in a page.
    """
2387
    list_lines = self.getParamDict().get('list_lines', None)
2388 2389
    if list_lines is not None:
      # it's possible to override max lines from selection parameters
Ivan Tyagov's avatar
Ivan Tyagov committed
2390
      return int(list_lines)
2391 2392
    return self.field.get_value('lines')

2393
  getMaxLineNumber = lazyMethod(getMaxLineNumber)
2394

2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413
  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.

    FIXME: this should only use getCheckedUidList, but Folder_deleteObjectList does not use
    the feature that checked uids are used when no list method is specified.
    """
    checked_uid_list = self.request.get('uids')
    if checked_uid_list is None:
      checked_uid_list = self.getCheckedUidList()
    if checked_uid_list is not None:
      checked_uid_list = [str(uid) for uid in checked_uid_list]
      checked_uid_list.sort()
      md5_string = md5.new(str(checked_uid_list)).hexdigest()
    else:
      md5_string = None

    return md5_string

2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
  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()

  asHTML = PageTemplateFile('www/ListBox_asHTML', globals())

  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')
2429 2430
    if method_id not in (None, ''):
      try:
2431
        return getattr(context, method_id)
2432
      except AttributeError:
2433
        return getattr(context.getPortalObject(), method_id).__of__(context)
2434
      return aq_base(getattr(self.getContext(), method_id)).__of__(context)
2435 2436 2437 2438 2439
    # Try to get a page template from acquisition context then portal object
    # and fallback on default page template.
    return getattr(self.getContext(), 'ListBox_asHTML',
           getattr(context.getPortalObject(), 'ListBox_asHTML', context.asHTML)
           ).__of__(context)
2440

2441 2442 2443 2444 2445 2446 2447
  def render(self, **kw):
    """Render the data in HTML.
    """
    # Make it sure to store the current selection, only if a list method is defined.
    list_method = self.getListMethod()
    selection = self.getSelection()
    if list_method is not None:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2448
      method_path = '%s/%s' % (getPath(self.getContext()), self.getListMethodName())
2449 2450 2451 2452
      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
2453 2454 2455
      selection.edit(method_path = method_path, list_url = list_url)
      self.getSelectionTool().setSelectionFor(self.getSelectionName(), selection, REQUEST = self.request)

2456 2457 2458 2459 2460
    pt = self.getPageTemplate()
    return pt()

allow_class(ListBoxHTMLRenderer)

2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
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()
2496
      listboxline.setSectionDepth(line.getDepth())
2497
      listboxline.setRowCSSClassName(line.getRowCSSClassName())
2498 2499
      if line.isSummary():
        listboxline.markSummaryLine()
2500 2501 2502 2503 2504 2505
        # 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)
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539
        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;', ' ')

2540
        stat_listboxline.addColumn(sql, value)
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555

      listboxline_list.append(stat_listboxline)

    return listboxline_list

class ListBoxValidator(Validator.Validator):
    property_names = Validator.Validator.property_names

    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')
2556 2557
        column_ids = [x[0] for x in columns]
        editable_column_ids = [x[0] for x in editable_columns]
2558 2559
        selection_name = field.get_value('selection_name')
        #LOG('ListBoxValidator', 0, 'field = %s, selection_name = %s' % (repr(field), repr(selection_name)))
2560
        params = here.portal_selections.getSelectionParamsFor(
2561
                                                           selection_name,
2562
                                                           REQUEST=REQUEST)
2563 2564 2565 2566 2567
        portal_url = getToolByName(here, 'portal_url')
        portal = portal_url.getPortalObject()

        result = {}
        error_result = {}
2568 2569 2570 2571
        MARKER = []
        listbox_uids = REQUEST.get('%s_uid' % field.id, MARKER)
        if listbox_uids is MARKER:
          raise KeyError, 'Field %s is not present in request object.' % (field.id, )
2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
        #LOG('ListBox.validate: REQUEST',0,REQUEST)
        errors = []
        object_list = []
        # 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
        for uid in listbox_uids:
          if str(uid).find('new') == 0:
            list_method = field.get_value('list_method')
            list_method = getattr(here, list_method.method_name)
2584
            #LOG('ListBoxValidator', 0, 'call %s' % repr(list_method))
2585
            object_list = list_method(REQUEST=REQUEST, **params)
2586 2587 2588 2589 2590 2591 2592 2593
            break
        listbox = {}
        for uid in listbox_uids:
          if str(uid).find('new') == 0:
            o = None
            for object in object_list:
              if object.getUid()==uid:
                o = object
2594 2595 2596 2597
            if o is None:
              # First case: dialog input to create new objects
              o = newTempBase(portal, uid[4:]) # Arghhh - XXX acquisition problem - use portal root
              o.uid = uid
2598
            listbox[uid[4:]] = {}
2599 2600
            # We first try to set a listbox corresponding to all things
            # we can validate, so that we can use the same list
2601 2602
            # as the one used for displaying the listbox
            for sql in editable_column_ids:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2603
              alias = sql.replace('.', '_')
2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
              if '.' in sql:
                property_id = '.'.join(sql.split('.')[1:]) # Only take trailing part
              else:
                property_id = alias
              my_field_id = '%s_%s' % (field.id, alias)
              if form.has_field( my_field_id ):
                my_field = form.get_field(my_field_id)
                key = 'field_' + my_field.id + '_%s' % o.uid
                error_result_key = my_field.id + '_%s' % o.uid
                REQUEST.cell = o
                try:
2615
                  value = my_field._validate_helper(key, REQUEST) # We need cell
2616 2617
                  # Here we set the property
                  listbox[uid[4:]][sql] = value
2618
                except ValidationError, err:
2619
                  pass
2620 2621
                except KeyError:
                  pass
2622 2623 2624 2625 2626
        # Here we generate again the object_list with listbox the listbox we
        # have just created
        if len(listbox)>0:
          list_method = field.get_value('list_method')
          list_method = getattr(here, list_method.method_name)
2627
          REQUEST.set(field.id, listbox)
2628
          object_list = list_method(REQUEST=REQUEST, **params)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2629
        for uid in listbox_uids:
2630 2631
          if str(uid).find('new') == 0:
            # First case: dialog input to create new objects
2632 2633 2634 2635 2636 2637
            #o = newTempBase(here, uid[4:]) # Arghhh - XXX acquisition problem - use portal root
            #o.uid = uid
            o = None
            for object in object_list:
              if object.getUid()==uid:
                o = object
2638 2639 2640 2641
            if o is None:
              # First case: dialog input to create new objects
              o = newTempBase(portal, uid[4:]) # Arghhh - XXX acquisition problem - use portal root
              o.uid = uid
2642
            result[uid[4:]] = {}
2643
            for sql in editable_column_ids:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2644
              alias = sql.replace('.', '_')
2645 2646 2647 2648 2649
              if '.' in sql:
                property_id = '.'.join(sql.split('.')[1:]) # Only take trailing part
              else:
                property_id = alias
              my_field_id = '%s_%s' % (field.id, alias)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2650 2651
              if form.has_field( my_field_id ):
                my_field = form.get_field(my_field_id)
2652
                REQUEST.cell = o
2653
                if my_field.get_value('editable', REQUEST=REQUEST) and field.need_validate(REQUEST):
2654 2655
                  key = 'field_%s_%s' % (my_field.id, o.uid)
                  error_result_key = '%s_%s' % (my_field.id, o.uid)
2656
                  try:
2657
                    value = my_field._validate_helper(key, REQUEST) # We need cell
2658
                    result[uid[4:]][sql] = value
2659
                  except ValidationError, err:
2660 2661 2662
                    #LOG("ListBox ValidationError",0,str(err))
                    err.field_id = error_result_key
                    errors.append(err)
2663 2664
          else:
            # Second case: modification of existing objects
2665 2666
            #try:
            if 1: #try:
2667 2668
              # We must try this
              # because sometimes, we can be provided bad uids
2669 2670
              try :
                o = here.portal_catalog.getObject(uid)
2671
              except (KeyError, NotFound, ValueError):
2672
                o = None
2673 2674 2675 2676 2677 2678
              if o is None:
                # It is possible that this object is not catalogged yet. So
                # the object must be obtained from ZODB.
                if not object_list:
                  list_method = field.get_value('list_method')
                  list_method = getattr(here, list_method.method_name)
2679
                  object_list = list_method(REQUEST=REQUEST, **params)
2680
                for object in object_list:
2681 2682 2683 2684 2685 2686 2687 2688
                  try:
                    if object.getUid() == int(uid):
                      o = object
                      break
                  except ValueError:
                    if str(object.getUid()) == uid:
                      o = object
                      break
2689
              for sql in editable_column_ids:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
2690
                alias = sql.replace('.', '_')
2691 2692 2693 2694 2695 2696 2697
                if '.' in sql:
                  property_id = '.'.join(sql.split('.')[1:]) # Only take trailing part
                else:
                  property_id = alias
                my_field_id = '%s_%s' % (field.id, alias)
                if form.has_field( my_field_id ):
                  my_field = form.get_field(my_field_id)
2698
                  REQUEST.cell = o # We need cell
2699
                  if my_field.get_value('editable', REQUEST=REQUEST) and field.need_validate(REQUEST):
2700 2701 2702
                    tales_expr = my_field.tales.get('default', "")
                    key = 'field_' + my_field.id + '_%s' % o.uid
                    error_result_key = my_field.id + '_%s' % o.uid
2703
                    try:
2704 2705 2706
                      value = my_field.validator.validate(my_field, key, REQUEST) # We need cell
                      error_result[error_result_key] = value
                      if not result.has_key(o.getUrl()):
2707
                        result[o.getUrl()] = {}
2708
                      result[o.getUrl()][sql] = value
2709
                    except ValidationError, err:
2710 2711 2712
                      #LOG("ListBox ValidationError",0,str(err))
                      err.field_id = error_result_key
                      errors.append(err)
2713 2714
            #except:
            else:
2715
              LOG("ListBox WARNING",0,"Object uid %s could not be validated" % uid)
2716
        if len(errors) > 0:
Nicolas Delaby's avatar
Nicolas Delaby committed
2717 2718
            #LOG("ListBox FormValidationError",0,str(error_result))
            #LOG("ListBox FormValidationError",0,str(errors))
2719
            raise FormValidationError(errors, error_result)
2720
        return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2721 2722 2723 2724

ListBoxValidatorInstance = ListBoxValidator()

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

2727 2728
  widget = ListBoxWidgetInstance
  validator = ListBoxValidatorInstance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2729

2730
  security = ClassSecurityInfo()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2731

2732 2733 2734 2735
  security.declareProtected('Access contents information', 'get_value')
  def get_value(self, id, **kw):
    if (id == 'default'):
      if (kw.get('render_format') in ('list', )):
2736 2737 2738 2739 2740 2741
        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.
2742 2743 2744
        field = request.get(
          'field__proxyfield_%s_%s_%s' % (self.id, self._p_oid, id),
          self)
2745 2746
        return self.widget.render(field, self.generate_field_key(), None,
                                  request,
2747 2748
                                  render_format=kw.get('render_format'),
                                  render_prefix=kw.get('render_prefix'))
2749
      else:
2750 2751 2752
        return None
    else:
      return ZMIField.get_value(self, id, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2753

2754 2755 2756
  security.declareProtected('Access contents information', 'getListMethodName')
  def getListMethodName(self):
    """Return the name of the list method. If not defined, return None.
2757 2758

       XXX - Is this method really necessary - I am not sure - JPS
2759 2760
       Why not use Formulator API instead ? -> the answer is that it is a
         MethodField, and it's method_name attribute is not available from
2761 2762
         restricted environment. It is only used in
         ERP5Site_checkNamingConventions
2763 2764 2765

      XXX also this method is not compatible with ProxyFields.
      It will go away soon.
2766 2767 2768 2769 2770 2771 2772
    """
    list_method = self.get_value('list_method')
    try:
      name = getattr(list_method, 'method_name')
    except AttributeError:
      name = list_method
    return name or None
2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783

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...
    """
2784

2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802
    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 = []
2803 2804
    self.row_css_class_name = ''
    
2805 2806
  security.declarePublic('__getitem__')
  def __getitem__(self, column_id):
2807
    return self.getColumnProperty(column_id)
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823

  #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'
    """
2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834
    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]

2835
    self.setConfigProperty('content_mode', content_mode)
2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856

  #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')
2857

2858 2859
  security.declarePublic('isStatLine')
  def isStatLine(self):
2860 2861 2862 2863
    """
      Returns 1 is this line contains no data but only stats
    """
    return self.is_stat_line
2864

2865 2866 2867 2868 2869 2870
  #security.declarePublic('View')
  def markDataLine(self):
    """
      Set content of the line to 'DataLine'
    """
    self.setListboxLineContentMode('DataLine')
2871

2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898
  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
    """
2899
    self.setConfigProperty('is_checked', is_checked)
2900 2901 2902 2903 2904 2905 2906

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

2908 2909 2910 2911 2912 2913
  #security.declarePublic('View')
  def setObjectUid(self, object_uid):
    """
      Define the uid of the object
      Default value is None
    """
2914
    self.setConfigProperty('uid', object_uid)
2915 2916 2917 2918 2919 2920 2921

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

2923 2924 2925 2926 2927 2928
  #security.declarePublic('View')
  def setSectionName(self, section_name):
    """
      Set the section name of this line
      Default value is None
    """
2929
    self.setConfigProperty('section_name', section_name)
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944

  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
    """
2945
    self.setConfigProperty('section_depth', depth)
2946

2947 2948 2949 2950 2951 2952 2953
  security.declarePublic('getSectionDepth')
  def getSectionDepth(self):
    """
      Returns the section depth of this line
      0 means no depth
    """
    return self.getConfigProperty('section_depth')
2954

2955 2956 2957 2958 2959 2960
  #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
2961

2962 2963 2964 2965 2966
  security.declarePublic('isSectionFolded')
  def isSectionFolded(self):
    """
      Returns 1 if section is in 'Folded' Mode
    """
2967 2968
    return self.is_section_folded

2969 2970 2971
  #security.declarePublic('View')
  def addColumn(self, column_id, column_value):
    """
2972
      Add a new column
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986
    """
    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):
    """
2987
      Returns a list of the property
2988 2989
      column_id_list selects the column_id returned
    """
2990

2991 2992
    if column_id_list == None:
      column_id_list = self.column_id_list
2993

2994 2995 2996 2997
    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]
2998

2999 3000
    return config_column + [self.column_dict[column_id] for column_id in column_id_list]

3001 3002 3003 3004 3005 3006 3007 3008 3009 3010
  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__

3011 3012 3013 3014 3015 3016
  security.declarePublic('getColumnItemList')
  def getColumnItemList(self, column_id_list = None ):
    """
      Returns a list of property tuple
      column_id_list selects the column_id returned
    """
3017

3018 3019
    if column_id_list == None:
      column_id_list = self.column_id_list
3020

3021 3022 3023 3024 3025 3026 3027
    """
    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]
3028

3029
    return config_column + [(column_id , self.column_dict[column_id]) for column_id in column_id_list]
3030

3031 3032 3033 3034 3035 3036 3037 3038
  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
3039

3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051
  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
  
3052 3053 3054
InitializeClass(ListBoxLine)
allow_class(ListBoxLine)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3055
# Psyco
3056
from Products.ERP5Type.PsycoWrapper import psyco
3057
#psyco.bind(ListBoxWidget.render)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3058 3059
psyco.bind(ListBoxValidator.validate)

3060 3061 3062
# Register get_value
from Products.ERP5Form.ProxyField import registerOriginalGetValueClassAndArgument
registerOriginalGetValueClassAndArgument(ListBox, 'default')