ListBox.py 125 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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41
from Products.CMFCore.utils import _checkPermission
42
from Products.ZSQLCatalog.zsqlbrain import ZSQLBrain
43
from Products.ERP5Type.Message import Message
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

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

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

53
import md5
54
import cgi
55
import types
56

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


64 65 66 67
class ObjectValuesWrapper:
  """This class wraps objectValues so that objectValues behaves like portal_catalog.
  """
  method_name = __name__ = 'objectValues'
68

69 70
  def __init__(self, context):
    self.context = context
71

72 73 74 75 76 77 78 79 80
  def __call__(self, *args, **kw):
    brain_list = []
    for obj in self.context.objectValues(*args, **kw):
      brain = ZSQLBrain(None, None).__of__(obj)
      brain.uid = obj.getUid()
      brain.path = obj.getPath()
      brain_list.append(brain)
    return brain_list

81 82
class ReportTree:
  """This class describes a report tree.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
83
  """
84
  def __init__(self, obj = None, is_pure_summary = False, depth = 0, is_open = False,
85
               selection_domain = None, exception_uid_list = None, base_category = None):
86 87 88 89
    self.obj = obj
    self.is_pure_summary = is_pure_summary
    self.depth = depth
    self.is_open = is_open
90
    self.selection_domain = selection_domain
91 92 93
    self.exception_uid_list = exception_uid_list
    if exception_uid_list is None:
      self.exception_uid_set = None
94
    else:
95
      self.exception_uid_set = set(exception_uid_list)
96
    self.base_category = base_category
Jean-Paul Smets's avatar
Jean-Paul Smets committed
97

98 99 100 101 102 103
    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

104 105
allow_class(ReportTree)

106 107 108 109
class ReportSection:
  """This class describes a report section.
  """
  def __init__(self, is_summary = False, object_list = (), object_list_len = 0,
110
               is_open = False, selection_domain = None, context = None, offset = 0,
111 112 113 114 115
               depth = 0):
    self.is_summary = is_summary
    self.object_list = object_list
    self.object_list_len = object_list_len
    self.is_open = is_open
116
    self.selection_domain = selection_domain
117 118 119
    self.context = context
    self.offset = offset
    self.depth = depth
Jean-Paul Smets's avatar
Jean-Paul Smets committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

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
    """
149 150 151 152 153
    # 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
154 155 156 157 158

    lines = fields.IntegerField('lines',
                                title='Lines',
                                description=(
        "The number of lines of this list. Required."),
159
                                default=20,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160
                                required=1)
161
    property_names.append('lines')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
162 163 164 165 166 167 168

    columns = fields.ListTextAreaField('columns',
                                 title="Columns",
                                 description=(
        "A list of attributes names to display. Required."),
                                 default=[],
                                 required=1)
169
    property_names.append('columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
170 171 172 173 174 175 176

    all_columns = fields.ListTextAreaField('all_columns',
                                 title="More Columns",
                                 description=(
        "An optional list of attributes names to display."),
                                 default=[],
                                 required=0)
177
    property_names.append('all_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178 179 180 181 182 183 184

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

187 188 189 190 191 192
    sort_columns = fields.ListTextAreaField('sort_columns',
                                 title="Sortable Columns",
                                 description=(
        "An optional list of columns to sort."),
                                 default=[],
                                 required=0)
193
    property_names.append('sort_columns')
194

Jean-Paul Smets's avatar
Jean-Paul Smets committed
195 196 197 198 199
    sort = fields.ListTextAreaField('sort',
                                 title='Default Sort',
                                 description=('The default sort keys and order'),
                                 default=[],
                                 required=0)
200
    property_names.append('sort')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201 202 203 204 205 206 207

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

210 211 212 213 214 215
    count_method = fields.MethodField('count_method',
                                 title='Count Method',
                                 description=('The method to use to count'
                                              'objects'),
                                 default='',
                                 required=0)
216
    property_names.append('count_method')
217

Jean-Paul Smets's avatar
Jean-Paul Smets committed
218 219
    stat_method = fields.MethodField('stat_method',
                                 title='Stat Method',
220
                                 description=('The method to use to stat'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
221 222 223
                                              'objects'),
                                 default='',
                                 required=0)
224
    property_names.append('stat_method')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
225 226 227 228 229 230 231

    selection_name = fields.StringField('selection_name',
                                 title='Selection Name',
                                 description=('The name of the selection to store'
                                              'params of selection'),
                                 default='',
                                 required=0)
232
    property_names.append('selection_name')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
233 234 235 236 237 238 239

    meta_types = fields.ListTextAreaField('meta_types',
                                 title="Meta Types",
                                 description=(
        "Meta Types of objects to list. Required."),
                                 default=[],
                                 required=0)
240
    property_names.append('meta_types')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
241 242 243 244 245 246 247

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

250
    # XXX Do we still need this?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
251 252 253 254 255 256
    default_params = fields.ListTextAreaField('default_params',
                                 title="Default Parameters",
                                 description=(
        "Default Parameters for the List Method."),
                                 default=[],
                                 required=0)
257
    property_names.append('default_params')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259 260 261 262 263

    search = fields.CheckBoxField('search',
                                 title='Search Row',
                                 description=('Search Row'),
                                 default='',
                                 required=0)
264
    property_names.append('search')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
265 266 267 268 269 270

    select = fields.CheckBoxField('select',
                                 title='Select Column',
                                 description=('Select Column'),
                                 default='',
                                 required=0)
271
    property_names.append('select')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272 273 274 275 276 277 278

    editable_columns = fields.ListTextAreaField('editable_columns',
                                 title="Editable Columns",
                                 description=(
        "An optional list of columns which can be modified."),
                                 default=[],
                                 required=0)
279
    property_names.append('editable_columns')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
280

281 282 283 284 285 286
    stat_columns = fields.ListTextAreaField('stat_columns',
                                 title="Stat Columns",
                                 description=(
        "An optional list of columns which can be used for statistics."),
                                 default=[],
                                 required=0)
287
    property_names.append('stat_columns')
288 289 290 291 292 293 294

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

297
    # XXX do we still need this?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
298 299 300 301 302 303
    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)
304
    property_names.append('global_attributes')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
305 306 307 308 309 310

    domain_tree = fields.CheckBoxField('domain_tree',
                                 title='Domain Tree',
                                 description=('Selection Tree'),
                                 default='',
                                 required=0)
311
    property_names.append('domain_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
312 313 314 315 316 317 318

    domain_root_list = fields.ListTextAreaField('domain_root_list',
                                 title="Domain Root",
                                 description=(
        "A list of domains which define the possible root."),
                                 default=[],
                                 required=0)
319
    property_names.append('domain_root_list')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
320 321 322 323 324 325

    report_tree = fields.CheckBoxField('report_tree',
                                 title='Report Tree',
                                 description=('Report Tree'),
                                 default='',
                                 required=0)
326
    property_names.append('report_tree')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
327 328 329 330 331 332 333

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

    list_action = fields.StringField('list_action',
                                 title='List Action',
                                 description=('The id of the object action'
339
                                              ' to display the current list'),
340
                                 default='list',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
341
                                 required=1)
342
    property_names.append('list_action')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
343

344 345 346 347 348 349 350 351
    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')

352 353
    def render_view(self, field, value, REQUEST=None, render_format='html', key='listbox'):
        """
354
          Render a ListBox in read-only.
355
        """
356
        if REQUEST is None: REQUEST=get_request()
357 358
        return self.render(field, key, value, REQUEST, render_format=render_format)

359
    def render(self, field, key, value, REQUEST, render_format='html'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
360 361 362
        """
          This is where most things happen. This method renders a list
          of items
363

Jean-Paul Smets's avatar
Jean-Paul Smets committed
364 365 366
          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.)
367

Jean-Paul Smets's avatar
Jean-Paul Smets committed
368
          the 'list' format includes additional metainformation
369

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

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

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
378
          - etc.
379

Jean-Paul Smets's avatar
Jean-Paul Smets committed
380
          which is intended to simplify operation with a spreadsheet or a pagetemplate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
381
        """
382 383
        if REQUEST is None:
          REQUEST = get_request()
384 385
        if render_format == 'list':
          renderer = ListBoxListRenderer(self, field, REQUEST)
386
        else:
387
          renderer = ListBoxHTMLRenderer(self, field, REQUEST)
388

389
        return renderer()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
390

391
ListBoxWidgetInstance = ListBoxWidget()
392

393
class VolatileCachingMethod:
394 395 396 397 398 399 400 401 402 403
  """This class caches the result of a callable object, and behaves like a method.
     Unlike ERP5Type's CachingMethod, this cache is volatile, namely, the cached
     data is removed immediately when an object which stores the cached data is deleted.
     Naturally, the object (self) should not be a persistent object.
  """
  def __init__(self, callable_object):
    """Generate the key for the cache.
    """
    self.method = callable_object
    self.key = '_cache_' + str(id(callable_object))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
404

405 406
  def __call__(self, instance):
    """Call the callable object passed to __init__, if the result is not cached.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
407

408 409 410 411 412 413 414 415 416 417
    For now, this does not take any extra argument, because it is not necessary
    at the moment.
    """
    try:
      return getattr(instance, self.key)
    except AttributeError:
      result = self.method(instance)
      setattr(instance, self.key, result)
      return result

418 419 420 421 422 423 424 425 426 427 428
class InstanceMethod:
  """This class makes it possible to pass an instance object implicitly to a method.
  """
  def __init__(self, instance, method):
    self.instance = instance
    self.method = method

  def __call__(self):
    return self.method(self.instance)

class ListBoxRenderer:
429 430 431 432 433
  """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.
  """
434

435 436 437 438 439 440
  def __init__(self, widget = None, field = None, REQUEST = None, **kw):
    """Store the parameters for later use.
    """
    self.widget = widget
    self.field = field
    self.request = REQUEST
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441

442 443 444 445 446 447 448
    # Because it is not easy to pass an instance object implicitly to a method
    # with no side effect, tweak VolatileCachingMethod objects here for this instance.
    for k in dir(self):
      v = getattr(self, k)
      if isinstance(v, VolatileCachingMethod):
        setattr(self, k, InstanceMethod(self, v))

449 450 451 452 453 454 455 456
  def getPhysicalPath(self):
    """
      Return the path of form we render.
      This function is required to be able to use ZopeProfiler product with 
      listbox.
    """
    return self.field.getPhysicalPath()

457 458 459 460
  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
461

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

464 465 466
  def getContext(self):
    """Return the context of rendering this ListBox.
    """
467 468 469 470
    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
471

472
  getContext = VolatileCachingMethod(getContext)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
473

474 475 476
  def getForm(self):
    """Return the form which contains the ListBox.
    """
477
    return self.field.aq_parent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
478

479
  getForm = VolatileCachingMethod(getForm)
480

481 482 483 484
  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
485

486
  getEncoding = VolatileCachingMethod(getEncoding)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
487

488 489 490 491 492
  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
493

494
  isReset = VolatileCachingMethod(isReset)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
495

496 497 498 499
  def getFieldErrorDict(self):
    """Return a dictionary of errors.
    """
    return self.request.get('field_errors', {})
Jean-Paul Smets's avatar
Jean-Paul Smets committed
500

501
  getFieldErrorDict = VolatileCachingMethod(getFieldErrorDict)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
502

503 504
  def getUrl(self):
    """
505 506 507 508 509 510 511
      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
512

513
  getUrl = VolatileCachingMethod(getUrl)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
514

515 516 517 518 519 520
  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')
521

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

527
    return selection_name
528

529
  getRequestedSelectionName = VolatileCachingMethod(getRequestedSelectionName)
530

531 532 533 534
  def getSelectionIndex(self):
    """Return the index of a requested selection, or None if not specified.
    """
    return self.request.get('selection_index', None)
535

536
  getSelectionIndex = VolatileCachingMethod(getSelectionIndex)
537

538 539 540 541
  def getReportDepth(self):
    """Return the depth of reports, or None if not specified.
    """
    return self.request.get('report_depth', None)
542

543
  getReportDepth = VolatileCachingMethod(getReportDepth)
544

545 546 547 548
  def getPortalObject(self):
    """Return the portal object.
    """
    return self.getContext().getPortalObject()
549

550
  getPortalObject = VolatileCachingMethod(getPortalObject)
551

552 553 554 555
  def getPortalUrlString(self):
    """Return the URL of the portal as a string.
    """
    return self.getPortalObject().portal_url()
556

557
  getPortalUrlString = VolatileCachingMethod(getPortalUrlString)
558

559 560 561 562
  def getCategoryTool(self):
    """Return the Category Tool.
    """
    return self.getPortalObject().portal_categories
563

564
  getCategoryTool = VolatileCachingMethod(getCategoryTool)
565

566 567 568 569
  def getDomainTool(self):
    """Return the Domain Tool.
    """
    return self.getPortalObject().portal_domains
570

571
  getDomainTool = VolatileCachingMethod(getDomainTool)
572

573 574 575 576
  def getCatalogTool(self):
    """Return the Catalog Tool.
    """
    return self.getPortalObject().portal_catalog
577

578
  getCatalogTool = VolatileCachingMethod(getCatalogTool)
579

580 581 582 583
  def getSelectionTool(self):
    """Return the Selection Tool.
    """
    return self.getPortalObject().portal_selections
584

585
  getSelectionTool = VolatileCachingMethod(getSelectionTool)
586

587 588 589 590
  def getId(self):
    """Return the id of the field. Usually, "listbox".
    """
    return self.field.id
591

592
  getId = VolatileCachingMethod(getId)
593

594 595 596 597
  def getTitle(self):
    """Return the title. Make sure that it is in unicode.
    """
    return unicode(self.field.get_value('title'), self.getEncoding())
598

599
  getTitle = VolatileCachingMethod(getTitle)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
600

601 602 603 604 605
  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"
606

607 608 609 610
  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
611

612
  showSearchLine = VolatileCachingMethod(showSearchLine)
613

614 615 616 617
  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
618

619
  showSelectColumn = VolatileCachingMethod(showSelectColumn)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
620

621 622
  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
623

624 625 626 627
    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
628

629
  showStat = VolatileCachingMethod(showStat)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
630

631 632 633 634
  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)
635

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
  isDomainTreeSupported = VolatileCachingMethod(isDomainTreeSupported)

  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)

  isReportTreeSupported = VolatileCachingMethod(isReportTreeSupported)

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

  isDomainTreeMode = VolatileCachingMethod(isDomainTreeMode)

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

  isReportTreeMode = VolatileCachingMethod(isReportTreeMode)

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

  getDefaultParamList = VolatileCachingMethod(getDefaultParamList)

  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

  getListMethodName = VolatileCachingMethod(getListMethodName)

  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

  getCountMethodName = VolatileCachingMethod(getCountMethodName)

  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

  getStatMethodName = VolatileCachingMethod(getStatMethodName)

  def getSelectionName(self):
    """Return the selection name.
    """
    return self.field.get_value('selection_name')

  getSelectionName = VolatileCachingMethod(getSelectionName)

  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

  getMetaTypeList = VolatileCachingMethod(getMetaTypeList)

  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

  getPortalTypeList = VolatileCachingMethod(getPortalTypeList)

  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]

  getColumnList = VolatileCachingMethod(getColumnList)

  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

  getAllColumnList = VolatileCachingMethod(getAllColumnList)

  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

  getStatColumnList = VolatileCachingMethod(getStatColumnList)

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

  getUrlColumnList = VolatileCachingMethod(getUrlColumnList)

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

  getDefaultSortColumnList = VolatileCachingMethod(getDefaultSortColumnList)

  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]

  getDomainRootList = VolatileCachingMethod(getDomainRootList)

  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]

  getReportRootList = VolatileCachingMethod(getReportRootList)

  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)

  getSearchColumnIdSet = VolatileCachingMethod(getSearchColumnIdSet)

  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

  getSortColumnIdSet = VolatileCachingMethod(getSortColumnIdSet)

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

  getEditableColumnIdSet = VolatileCachingMethod(getEditableColumnIdSet)

  def getListActionUrl(self):
    """Return the URL of the list action.
    """
823
    list_action_part_list = [self.getContext().absolute_url(), '/', self.field.get_value('list_action')]
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
    if '?' in list_action_part_list[-1]:
      list_action_part_list.append('&reset=1')
    else:
      list_action_part_list.append('?reset=1')
    return ''.join(list_action_part_list)

  getListActionUrl = VolatileCachingMethod(getListActionUrl)

  # 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:
      selection = Selection(params = self.getDefaultParamList(), default_sort_on = self.getDefaultSortColumnList())
851
      selection = selection.__of__(selection_tool)
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
    # 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

  getSelection = VolatileCachingMethod(getSelection)

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

  getCheckedUidList = VolatileCachingMethod(getCheckedUidList)

889 890 891 892 893 894 895
  def getCheckedUidSet(self):
    """Return the set of checked uids.
    """
    return set(self.getCheckedUidList())

  getCheckedUidSet = VolatileCachingMethod(getCheckedUidSet)

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  def getSelectedColumnList(self):
    """Return the list of selected columns.
    """
    return self.getSelectionTool().getSelectionColumns(self.getSelectionName(),
                                                       columns = self.getColumnList(),
                                                       REQUEST = self.request)

  getSelectedColumnList = VolatileCachingMethod(getSelectedColumnList)

  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

  getColumnAliasList = VolatileCachingMethod(getColumnAliasList)

  def getParamDict(self):
    """Return a dictionary of parameters.
    """
    params = self.getSelection().getParams()
    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)

926 927 928 929 930
      search_prefix = 'search_%s_' % (self.getId(), )
      for k, v in params.items():
        if k.startswith(search_prefix):
          params[k[len(search_prefix):]] = v

931 932 933 934 935
      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:
936
          search_alias = '_'.join(search_id.split('.'))
937
          # If the search field could not be found, try to get an "editable" field on current form.
938
          editable_field_id = '%s_%s' % (listbox_id, search_alias)
939 940 941 942 943 944 945 946
          if listbox_form.has_field(editable_field_id):
            search_field = listbox_form.get_field(editable_field_id)
          else:
            continue
        render_dict = getattr(search_field.widget, 'render_dict', None)
        if render_dict is not None:
          params[search_id] = render_dict(search_field, search_value)

947 948 949 950 951 952 953 954 955 956 957
      # Set parameters, depending on the list method.
      list_method_name = self.getListMethodName()
      meta_type_list = self.getMetaTypeList()
      portal_type_list = self.getPortalTypeList()
      if list_method_name == 'objectValues':
        if meta_type_list is not None:
          params.setdefault('spec', meta_type_list)
      else:
        if portal_type_list is not None:
          params.setdefault('portal_type', portal_type_list)
        elif meta_type_list is not None:
958
          params.setdefault('meta_type', meta_type_list)
959

960
        # Remove useless parameters as FileUpload
961
        for k, v in params.items():
962 963 964 965 966 967 968 969
          if k == "listbox":
            # listbox can also contain useless parameters
            new_list = []
            for line in v:
              for k1, v1 in line.items():
                if v1 in (None, '') or hasattr(v1, 'read'):
                  del line[k1]
              new_list.append(line)
970
            params[k] = new_list
971
          if v in (None, '') or hasattr(v, 'read'):
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
            del params[k]

    # 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']
    return params

  getParamDict = VolatileCachingMethod(getParamDict)

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
  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()
    editable_field_id = '%s_%s' % (self.getId(), alias)
    if form.has_field(editable_field_id):
      return form.get_field(editable_field_id)
    return None

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
  def getListMethod(self):
    """Return the list method object.
    """
    list_method_name = self.getListMethodName()

    if list_method_name == 'objectValues':
      list_method = ObjectValuesWrapper(self.getContext())
    elif list_method_name is not None:
      try:
        list_method = getattr(self.getContext(), list_method_name)
      except AttributeError, KeyError:
        list_method = None
    else:
      list_method = None

    return list_method

  getListMethod = VolatileCachingMethod(getListMethod)

  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
    if count_method_name == 'portal_catalog':
      count_method = self.getCatalogTool().countResults
    elif count_method_name is not None:
      try:
        count_method = getattr(self.getContext(), count_method_name)
      except AttributeError, KeyError:
        count_method = None
    else:
      count_method = None

    return count_method

  getCountMethod = VolatileCachingMethod(getCountMethod)

  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
    if stat_method_name == 'portal_catalog':
      stat_method = self.getCatalogTool().countResults
    elif stat_method_name is not None:
      try:
        stat_method = getattr(self.getContext(), stat_method_name)
      except AttributeError, KeyError:
        stat_method = None
    else:
      stat_method = None

    return stat_method

  getStatMethod = VolatileCachingMethod(getStatMethod)

  def getDomainSelection(self):
    """Return a DomainSelection object wrapped with the context.
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1090
    portal_object = self.getPortalObject()
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
    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 :
1109
            root_dict[base_domain] = ('portal_categories', domain)
1110
          elif domain_tool is not None:
1111
            root = domain_tool.getDomainByPath(domain, None)
1112
            if root is not None:
1113
              root_dict[base_domain] = ('portal_domains', domain)
1114
        if root is None:
1115 1116 1117
          root = portal_object.restrictedTraverse(domain, None)
          if root is not None:
            root_dict[None] = (None, domain)
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

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

  getDomainSelection = VolatileCachingMethod(getDomainSelection)

  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)

1150 1151
  getStatSelectExpression = VolatileCachingMethod(getStatSelectExpression)

1152 1153 1154 1155 1156 1157
  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('/')
1158
    if base_category is None and len(report_path):
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
      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
1171
    category = base_category
1172
    while is_empty_level:
1173
      if not root_dict.has_key(category):
1174 1175 1176
        root = None
        if category_tool is not None:
          try:
1177
            if category == 'parent':
1178
              # parent has a special treatment
1179 1180
              root = self.getContext()
              root_dict[category] = root_dict[None] = (root, (None, root.getRelativeUrl()))
1181
            else:
1182 1183 1184
              root = category_tool[category]
              root_dict[category] = root_dict[None] = (root, ('portal_categories', root.getRelativeUrl()))
            report_path = report_path[1:]
1185 1186 1187 1188
          except KeyError:
            pass
        if root is None and domain_tool is not None:
          try:
1189 1190
            root = domain_tool[category]
            root_dict[category] = root_dict[None] = (root, ('portal_domains', root.getRelativeUrl()))
1191 1192 1193 1194
            report_path = report_path[1:]
          except KeyError:
            pass
        if root is None:
1195 1196 1197
          root = portal_object.unrestrictedTraverse(report_path, None)
          if root is not None:
            root_dict[None] = (root, (None, root.getRelativeUrl()))
1198 1199
          report_path = ()
      else:
1200 1201
        root_dict[None] = root_dict[category]
        root = root_dict[None][0]
1202 1203 1204
        report_path = report_path[1:]
      is_empty_level = (root is None or root.objectCount() == 0) and (len(report_path) != 0)
      if is_empty_level:
1205
        category = report_path[0]
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222

    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()
1223 1224 1225 1226
      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]
1227
      selection_domain = DomainSelection(domain_dict = domain_dict)
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241

      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:
1242
              exception_uid_list.append(sub_obj.getUid())
1243 1244 1245

        # Summary (open)
        tree_list.append(ReportTree(obj = obj, is_pure_summary = True, depth = depth,
1246
                                    base_category = base_category,
1247
                                    is_open = True, selection_domain = selection_domain,
1248 1249 1250 1251
                                    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,
1252
                                      base_category = base_category,
1253
                                      is_open = False, selection_domain = selection_domain,
1254
                                      exception_uid_list = exception_uid_list))
1255 1256 1257 1258 1259
        # 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
1260 1261
        tree_list.extend(self.makeReportTreeList(root_dict = new_root_dict,
                                                 report_path = report_path,
1262
                                                 base_category = new_base_category,
1263 1264 1265 1266 1267 1268 1269
                                                 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,
1270
                                    base_category = base_category,
1271
                                    is_open = False, selection_domain = selection_domain,
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
                                    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"

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
  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

  getSelectedDomainPath = VolatileCachingMethod(getSelectedDomainPath)

1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
  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)

  getSelectedReportPath = VolatileCachingMethod(getSelectedReportPath)

1314 1315 1316 1317 1318 1319
  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
1320 1321 1322
    sort_dict = {}
    for sort_item in sort_list:
      sort_dict[sort_item[0]] = sort_item[1] # sort_item can be couple or a triplet
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
    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

1334
  def getSearchValueList(self, param_dict=None):
1335 1336 1337 1338 1339
    """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()
1340 1341
    if param_dict is None:
      param_dict = self.getParamDict()
1342
    value_list = []
1343
    for (sql, title), alias in zip(self.getSelectedColumnList(), self.getColumnAliasList()):
1344 1345
      if sql in search_column_id_set:
        # Get the current value and encode it in unicode.
1346
        param = param_dict.get(alias, param_dict.get(sql, u''))
1347 1348
        if isinstance(param, dict):
          param = param.get('query', u'')
1349 1350 1351 1352
        if isinstance(param, str):
          param = unicode(param, self.getEncoding())

        # Obtain a search field, if any.
1353 1354
        if self.getForm().has_field(alias):
          search_field = self.getForm().get_field(alias)
1355 1356 1357
        else:
          search_field = None

1358
        value_list.append((sql, param, search_field))
1359 1360 1361 1362 1363
      else:
        value_list.append((None, None, None))

    return value_list

1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
  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)
    result = selection(method = self.getStatMethod(), context = self.getContext(), REQUEST = self.request)

    # For each column, check the presense of a specific stat method. If not present,
    # use the result obtained above.
    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

1392 1393 1394 1395
      if stat_method_id is None:
        original_value = None
        processed_value = u''
      elif stat_method is None:
1396 1397 1398 1399 1400 1401 1402 1403 1404
        try:
          original_value = getattr(result[0], alias)
          processed_value = original_value
        except (IndexError, AttributeError, KeyError, ValueError):
          original_value = None
          processed_value = u''
      else:
        if callable(stat_method):
          try:
1405 1406
            original_value = stat_method(selection = selection,
                                         selection_name = selection.getName())
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
            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
1418 1419 1420 1421
      
      editable_field = self.getEditableField(alias)
      if editable_field is not None:
        processed_value = editable_field.render_view(value=original_value)
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437

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

      value_list.append((original_value, processed_value))

    return value_list

  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()
1438
    selection_tool = self.getSelectionTool()
1439
    report_list = selection.getReportList()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1440
    stat_select_expression = self.getStatSelectExpression()
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
    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)

1472 1473
      # Update report list if report_depth was specified. This information is used
      # to store what domains are unfolded by clicking on a depth.
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
      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.

        # 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.
1484
        selection.edit(report = report_tree.selection_domain)
1485 1486 1487 1488 1489 1490 1491 1492

        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.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1493
          stat_brain = selection(method = stat_method, context = context, REQUEST = self.request)
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505

          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] = ''

          stat_context = report_tree.obj.asContext(**stat_result)
          # XXX yo thinks that this code below is useless, so disabled.
          #absolute_url_txt = report_tree.obj.absolute_url()
          #stat_context.absolute_url = lambda: absolute_url_txt
1506
          stat_context.domain_url = report_tree.domain_url
1507 1508
          report_section_list.append(ReportSection(is_summary = True, object_list = [stat_context],
                                                   object_list_len = 1, is_open = report_tree.is_open,
1509
                                                   selection_domain = report_tree.selection_domain,
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
                                                   context = stat_context, depth = report_tree.depth))
        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.
            object_list = selection(method = list_method, context = context, REQUEST = self.request)
          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:
1534
            if self.showStat():
1535 1536 1537
              report_section_list.append(ReportSection(is_summary = False, object_list = object_list,
                                                       object_list_len = object_list_len,
                                                       is_open = report_tree.is_open,
1538
                                                       selection_domain = report_tree.selection_domain,
1539
                                                       depth = report_tree.depth))
1540 1541 1542 1543
          else:
            stat_context = report_tree.obj.asContext()
            #absolute_url_txt = s[0].absolute_url()
            #stat_context.absolute_url = lambda : absolute_url_txt
1544
            stat_context.domain_url = report_tree.domain_url
1545 1546 1547 1548 1549 1550 1551
            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,
1552
                                                       selection_domain = report_tree.selection_domain,
1553 1554
                                                       context = stat_context,
                                                       depth = report_tree.depth))
1555 1556 1557 1558
              report_section_list.append(ReportSection(is_summary = False,
                                                       object_list = object_list,
                                                       object_list_len = object_list_len - 1,
                                                       is_open = True,
1559
                                                       selection_domain = report_tree.selection_domain,
1560 1561
                                                       offset = 1,
                                                       depth = report_tree.depth))
1562 1563 1564 1565 1566 1567 1568
            else:
              if report_tree.exception_uid_list is not None:
                # Display current parent domain.
                report_section_list.append(ReportSection(is_summary = False,
                                                         object_list = [report_tree.obj],
                                                         object_list_len = 1,
                                                         is_open = report_tree.is_open,
1569
                                                         selection_domain = report_tree.selection_domain,
1570 1571
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1572 1573 1574 1575 1576 1577
              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,
1578
                                                         selection_domain = report_tree.selection_domain,
1579 1580
                                                         context = stat_context,
                                                         depth = report_tree.depth))
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598

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

      if self.isDomainTreeMode():
        selection.edit(domain = self.getDomainSelection())

      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.
          count = selection(method = count_method, context = context, REQUEST = self.request)
          object_list_len = int(count[0][0])

          # Tweak the line start.
          if start >= object_list_len:
1599
            start = max(object_list_len - 1, 0)
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
          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)
          object_list = selection(method = list_method, context = context, REQUEST = self.request)
          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:
          object_list = selection(method = list_method, context = context, REQUEST = self.request)
          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.
1625
        object_list = selection_tool.getSelectionValueList(selection_name,
1626
                                                                   context = context, REQUEST = self.request)
1627
        object_list_len= len(object_list)
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
        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()
    report_section_list = self.getReportSectionList()
    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
1653 1654 1655
      if start >= self.total_size:
        start = max(self.total_size - 1, 0)
      start -= (start % max_lines)
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
      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 = []
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690

    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__,))
        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,
1691
                          selection_domain = current_section.selection_domain,
1692 1693 1694 1695 1696
                          depth = current_section.depth)
        line_list.append(line)
    except IndexError:
      # If the report section list is empty, nothing to do.
      pass
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710

    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)

1711
class ListBoxRendererLine:
1712 1713 1714
  """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,
1715
               is_open = False, selection_domain = None, depth = 0):
1716 1717 1718 1719 1720 1721 1722 1723
    """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
1724
    self.selection_domain = selection_domain
1725 1726
    self.depth = depth

1727 1728 1729 1730 1731 1732 1733
    # Because it is not easy to pass an instance object implicitly to a method
    # with no side effect, tweak VolatileCachingMethod objects here for this instance.
    for k in dir(self):
      v = getattr(self, k)
      if isinstance(v, VolatileCachingMethod):
        setattr(self, k, InstanceMethod(self, v))

1734 1735 1736 1737 1738 1739 1740 1741 1742
  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:
1743
      return self.obj.getObject()
1744
    except AttributeError:
1745
      return self.obj
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755

  getObject = VolatileCachingMethod(getObject)

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

  getUid = VolatileCachingMethod(getUid)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1756 1757 1758 1759 1760 1761 1762
  def getUrl(self):
    """Return the absolute URL path of the object
    """
    return self.getBrain().getUrl()

  getUrl = VolatileCachingMethod(getUrl)

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
  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', '')

  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.
    """
1791
    return self.selection_domain
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810

  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.
    if self.getObject() is None:
      return [(None, '')] * len(self.renderer.getSelectedColumnList())

    # Otherwise, evaluate each column.
    stat_column_dict = dict(self.renderer.getStatColumnList())
    _marker = []
    value_list = []
    selection = self.renderer.getSelection()
1811
    param_dict = self.renderer.getParamDict()
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839

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

    for (sql, title), alias in zip(self.renderer.getSelectedColumnList(), self.renderer.getColumnAliasList()):
      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
        else:
          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:
1840 1841
                original_value = stat_method(selection = selection,
                                             selection_name = selection.getName())
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
                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.
1856
        obj = self.getObject()
1857
        brain = self.getBrain()
1858 1859

        # Use a widget, if any.
1860
        editable_field = self.renderer.getEditableField(alias)
1861
        tales = False
1862
        if editable_field is not None:
1863 1864
          tales = editable_field.tales.get('default', '')
          if tales:
1865 1866
            original_value = editable_field.__of__(obj).get_value('default',
                                                        cell=brain)
1867
            processed_value = original_value
1868
        
1869 1870
        # If a tales expression is not defined, get a skin, an accessor or a property.
        if not tales:
1871 1872 1873 1874
          if hasattr(aq_self(brain), alias):
            original_value = getattr(brain, alias)
            processed_value = original_value
          elif obj is not None:
1875 1876 1877 1878 1879 1880 1881
            try:
              # Get the trailing part.
              try:
                property_id = sql[sql.rindex('.') + 1:]
              except ValueError:
                property_id = sql

1882 1883 1884 1885 1886 1887 1888 1889
              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
1890
            except (AttributeError, KeyError, Unauthorized):
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
              original_value = None
              processed_value = 'Could not evaluate %s' % property_id
          else:
            original_value = None
            processed_value = 'Object does not exist'

      # If the value is callable, evaluate it.
      if callable(original_value):
        try:
          try:
1901 1902 1903
            original_value = original_value(brain = self.getBrain(),
                                            selection = selection,
                                            selection_name = selection.getName())
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
            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''
1919
      elif not isinstance(processed_value, unicode):
1920 1921 1922 1923
        processed_value = unicode(str(processed_value), self.renderer.getEncoding())

      value_list.append((original_value, processed_value))

1924
    #LOG('ListBox.getValueList', 0, value_list)
1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
    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.
    """
    editable_column_id_set = self.renderer.getEditableColumnIdSet()
    field_id = self.renderer.getId()
    form = self.renderer.getForm()
    error_dict = self.renderer.getFieldErrorDict()
    brain = self.getBrain()
    encoding = self.renderer.getEncoding()
    url_column_dict = dict(self.renderer.getUrlColumnList())
    selection = self.renderer.getSelection()
    selection_name = self.renderer.getSelectionName()
1944
    ignore_layout = int(self.renderer.request.get('ignore_layout', 0))
1945
    ui_domain = 'erp5_ui'
1946 1947 1948

    html_list = []

1949 1950 1951
    # Generate page selection methods based on the Listbox id
    createFolderMixInPageSelectionMethod(field_id)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
    # 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

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
    for (original_value, processed_value), (sql, title), alias \
      in zip(self.getValueList(), self.renderer.getSelectedColumnList(), self.renderer.getColumnAliasList()):
      # 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?
1975 1976 1977
      editable_field = None
      if not self.isSummary():
        editable_field = self.renderer.getEditableField(alias)
1978

1979 1980 1981 1982 1983 1984 1985 1986 1987
      # 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:
1988
          if url_method_id not in (None, ''):
1989 1990 1991 1992 1993
            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:
1994
            # If the URL Method is empty, generate no link.
1995 1996 1997 1998
            no_link = True

      if url_method is not None:
        try:
1999 2000
          url = url_method(brain = brain, selection = selection,
                           selection_name = selection.getName())
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018
        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:
2019 2020 2021
            url = '%s/view?selection_index=%s&amp;selection_name=%s&amp;ignore_layout:int=%s&amp;reset:int=1' % (
                      brain.absolute_url(),
                      self.index, selection_name, ignore_layout)
2022 2023 2024
          except AttributeError:
            pass

2025 2026
      if editable_field is not None and sql in editable_column_id_set:
        # XXX what if the object does not have uid?
2027
        key = '%s_%s' % (editable_field.getId(), self.getUid())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
        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:
          validated_value_dict = self.renderer.request.get(field_id, None)
          if validated_value_dict is None:
            # If this is neither an error nor a validated listbox
            # we should use the original value
            display_value = original_value
          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
2043 2044 2045
          error_text = error_dict[key].error_text
          error_text = cgi.escape(error_text)
          if isinstance(error_text, str):
2046 2047
            error_text = u'%s' % Message(domain=ui_domain, 
                                         message=error_text)
2048 2049 2050 2051
          error_message = u'<br />' + error_text
        else:
          error_message = u''

2052
        if getattr(brain, 'asContext', None) is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2053 2054 2055 2056 2057 2058 2059 2060
          # 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)
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
          cell_request = brain.asContext( REQUEST = self.renderer.request
                                        , form    = self.renderer.request.form
                                        , cell    = self.getObject()
                                        )
          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 = ''
2073
        else:
2074
          # If the brain does not support asContext (eg. it is None), no way
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2075
          self.renderer.request.cell = self.getObject()
2076 2077 2078 2079 2080 2081 2082 2083
          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 = ''
2084 2085 2086 2087

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

2088 2089 2090
        if url is None:
          html = cell_html + error_message
        else:
2091
          if editable_field.get_value('editable', REQUEST=cell_request):
2092 2093 2094 2095
            html = u'%s' % cell_html
          else:
            html = u'<a href="%s">%s</a>' % (url, cell_html)
          if error_message not in ('', None):
2096
            html += u' <span class="error">%s</span>' % error_message
2097 2098 2099 2100 2101 2102
      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
2103 2104
          # JPS-XXX - I think we should not display a URL for objects
          # which do not have the View permission
2105 2106
          html = u'<a href="%s">%s</a>' % (url, processed_value)

2107
      html_list.append((html, original_value, error, editable_field))
2108 2109 2110

    return html_list

2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
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

  def __getattr__(self, name):
    return getattr(self.renderer, name)
2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138

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.
    """
    try:
      start = self.request.get('list_start')
      start = int(start)
2139
    except (TypeError, KeyError):
2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
      param_dict = self.getParamDict()
      start = param_dict.get('list_start', 0)
      if isinstance(start, list):
        start = start[0]
      start = int(start)
    start = max(start, 0)

    return start

  getLineStart = VolatileCachingMethod(getLineStart)

  def getMaxLineNumber(self):
    """Return the maximum number of lines shown in a page.
    """
2154 2155 2156
    list_lines =self.getParamDict().get('list_lines', None)
    if list_lines is not None:
      # it's possible to override max lines from selection parameters
Ivan Tyagov's avatar
Ivan Tyagov committed
2157
      return int(list_lines)
2158 2159 2160 2161
    return self.field.get_value('lines')

  getMaxLineNumber = VolatileCachingMethod(getMaxLineNumber)

2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
  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

2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
  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')
2196 2197
    if method_id not in (None, ''):
      try:
2198
        return getattr(context, method_id)
2199
      except AttributeError:
2200
        return getattr(context.getPortalObject(), method_id).__of__(context)
2201
      return aq_base(getattr(self.getContext(), method_id)).__of__(context)
2202 2203 2204 2205 2206
    # 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)
2207

2208 2209 2210 2211 2212 2213 2214 2215
  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:
      method_path = getPath(self.getContext()) + '/' + self.getListMethodName()
2216 2217 2218 2219
      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
2220 2221 2222
      selection.edit(method_path = method_path, list_url = list_url)
      self.getSelectionTool().setSelectionFor(self.getSelectionName(), selection, REQUEST = self.request)

2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
    pt = self.getPageTemplate()
    return pt()

  def original_render(self, **kw):
    """This is just a reference. Not used any longer.
    """
    # 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:
      method_path = getPath(self.getContext()) + '/' + self.getListMethodName()
      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
      selection.edit(method_path = method_path, list_url = list_url)
      self.getSelectionTool().setSelectionFor(self.getSelectionName(), selection, REQUEST = self.request)

2241 2242 2243 2244 2245 2246 2247
    # Obtain the list of lines.
    line_list = self.query()

    # Start rendering.
    # FIXME: This part should be replaced with Page Templates.
    html_list = []
    ui_domain = 'erp5_ui'
2248
    context_domain = 'erp5_content'
2249 2250 2251 2252 2253 2254 2255
    param_dict = self.getParamDict()

    # Prepare format parameters.
    format_dict = dict(portal_url_string = self.getPortalUrlString(),
                       list_action = self.getListActionUrl(),
                       selection_name = self.getSelectionName(),
                       field_id = self.getId(),
2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
                       field_title = unicode(Message(domain = ui_domain, message = self.getTitle())),
                       record_number = unicode(Message(domain = ui_domain, message = '${number} record(s)',
                                                       mapping = dict(number = str(self.total_size)))),
                       item_number = unicode(Message(domain = ui_domain, message = '${number} item(s) selected',
                                                     mapping = dict(number = str(len(self.getCheckedUidList()))))),
                       flat_list_title = unicode(Message(domain = ui_domain, message = 'Flat List')),
                       report_tree_title = unicode(Message(domain = ui_domain, message = 'Report Tree')),
                       domain_tree_title = unicode(Message(domain = ui_domain, message = 'Domain Tree')),
                       change_page_title = unicode(Message(domain = ui_domain, message = 'Change Page')),
                       previous_page_title = unicode(Message(domain = ui_domain, message = 'Previous Page')),
                       next_page_title = unicode(Message(domain = ui_domain, message = 'Next Page')),
                       check_all_title = unicode(Message(domain = ui_domain, message = 'Check All')),
                       uncheck_all_title = unicode(Message(domain = ui_domain, message = 'Uncheck All')),
                       ascending_display_title = unicode(Message(domain = ui_domain, message = 'Ascending Display')),
                       descending_display_title = unicode(Message(domain = ui_domain, message = 'Descending Display')),
                       action_title = unicode(Message(domain = ui_domain, message = 'Action')),
2272 2273 2274 2275 2276 2277 2278 2279 2280
                       context_url = self.getContext().getUrl())

    # This is the start of HTML. Embed a selection name.
    html_list.append("""\
<!-- ListBox %(field_id)s starts here. -->
<input type="hidden" name="list_selection_name" value="%(selection_name)s" />
""" % format_dict)

    # If the MD5 checksum is valid, embed it.
2281
    md5_string = self.getMD5Checksum()
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
    if md5_string is not None:
      html_list.append("""
<input type="hidden" name="md5_object_uid_list" value="%s" />
""" % md5_string)

    # Create a domain tree selector. Note that this creates one more table, so
    # the table must be terminated at the end.
    if self.isDomainTreeMode():
      html_list.append("""\
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
   <td valign="top">
    <select name="domain_root_url" onChange="submitAction(this.form, '%(context_url)s/portal_selections/setDomainRoot')">
""" % format_dict)

2297
      selected_domain_path = self.getSelectedDomainPath()
2298 2299 2300 2301 2302 2303 2304 2305
      for c in self.getDomainRootList():
        if c[0] == selected_domain_path:
          selected = 'selected'
        else:
          selected = ''

        html_list.append("""\
     <option %s value="%s">%s</option>
2306
""" % (selected, c[0], unicode(Message(domain = ui_domain, message = c[1]))))
2307 2308 2309 2310 2311 2312

      html_list.append("""\
    </select>
    <table id="%(field_id)s_domain_tree_table" cellpadding="0" border="0">
""" % format_dict)

2313
      # Render a domain tree.
2314
      try:
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
        report_tree_list = self.makeReportTreeList(report_path = selected_domain_path,
                                                   unfolded_list = selection.getDomainList(),
                                                   is_report_opened = False)

        total_depth = max([report_tree.depth for report_tree in report_tree_list] + [-1])
        for report_tree in report_tree_list:
          html_list.append("""\
     <tr>
""")
          html_list.append("""\
      <td width="16" nowrap>&nbsp;</td>
""" * report_tree.depth)

          relative_url = report_tree.obj.getRelativeUrl()
          if report_tree.base_category is not None and not relative_url.startswith(report_tree.base_category + '/'):
            domain_url = '%s/%s' % (report_tree.base_category, relative_url)
          else:
            domain_url = relative_url

          if report_tree.is_open:
            method_id = 'foldDomain'
2336
            content = u'-&nbsp;<b>%s</b>' % unicode(report_tree.obj.getTranslatedTitleOrId())
2337 2338
          else:
            method_id = 'unfoldDomain'
2339
            content = u'+&nbsp;%s' % unicode(report_tree.obj.getTranslatedTitleOrId())
2340 2341 2342 2343 2344 2345 2346 2347

          html_list.append("""\
      <td nowrap valign="top" align="left" colspan="%d">
       <a href="portal_selections/%s?domain_url=%s&form_id=%s&list_selection_name=%s&domain_depth:int=%d">%s</a>
      </td>
     </tr>
""" % (total_depth - report_tree.depth + 1, method_id, domain_url, self.getForm().id, self.getSelectionName(),
       report_tree.depth, content))
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
      except KeyError:
        pass

      html_list.append("""\
    </table>
   </td>
   <td valign="top">
""")

    # Create the title line.
    html_list.append("""
<div class="ListSummary">
 <table border="0" cellpadding="0" cellspacing="0">
  <tr height="10">
   <td height="10"><img src="%(portal_url_string)s/images/Left.png" border="0"/></td>
   <td class="Top" colspan="2" height="10">
    <img src="%(portal_url_string)s/images/spacer.png" width="5" height="10" border="0"
      alt="spacer"/></td>
   <td class="Top" colspan="3" height="10">
    <img src="%(portal_url_string)s/images/spacer.png" width="5" height="10" border="0"
      alt="spacer"/>
   </td>
  </tr>
  <tr id="%(field_id)s_title_line">
   <td class="Left" width="17">
    <img src="%(portal_url_string)s/images/spacer.png" width="5" height="5" border="0"
        alt="spacer"/>
   </td>
   <td valign="middle" nowrap>
""" % format_dict)

    # Embed icons for flat list mode, report tree mode and domain tree mode, only if applicable.
    if self.isReportTreeSupported() or self.isDomainTreeSupported():
      html_list.append("""
    <input type="image" src="%(portal_url_string)s/images/text_block.png" id="%(field_id)s_flat_list_mode"
      title="%(flat_list_title)s" name="portal_selections/setFlatListMode:method" value="1" border="0" alt="img" />
""" % format_dict)

    if self.isReportTreeSupported():
      html_list.append("""
    <input type="image" src="%(portal_url_string)s/images/view_tree.png" id="%(field_id)s_report_tree_mode"
      title="%(report_tree_title)s" name="portal_selections/setReportTreeMode:method" value="1" border="0" alt="img" />
""" % format_dict)

    if self.isDomainTreeSupported():
      html_list.append("""
    <input type="image" src="%(portal_url_string)s/images/view_choose.png" id="%(field_id)s_domain_tree_mode"
      title="%(domain_tree_title)s" name="portal_selections/setDomainTreeMode:method" value="1" border="0" alt="img" />
""" % format_dict)

    # Add information about simple statistics.
    html_list.append("""
   </td>
   <td width="100%%" valign="middle">&nbsp; <a id="listbox_title" href="%(list_action)s">%(field_title)s</a>:
        <span id="listbox_record_number">%(record_number)s</span>
        - <span id="listbox_item_number">%(item_number)s</span>
   </td>
   <td nowrap valign="middle" align="center">
""" % format_dict)

    # Embed a previous page button, only if applicable.
    if self.current_page > 0:
      html_list.append("""
    <input id="%(field_id)s_previous_page" type="image" src="%(portal_url_string)s/images/1leftarrowv.png"
      title="%(previous_page_title)s" name="portal_selections/previousPage:method" border="0" />
""" % format_dict)

    # Make page selectors.
    html_list.append("""
   </td>
   <td nowrap valign="middle" align="center">
    <select id="%(field_id)s_page_selection" name="list_start" title="%(change_page_title)s" size="1"
      onChange="submitAction(this.form, '%(context_url)s/portal_selections/setPage')">
""" % format_dict)

    for p in xrange(0, self.total_pages):
      if p == self.current_page:
        selected = 'selected'
      else:
        selected = ''

      html_list.append("""\
      <option %s value="%d">%s</option>
""" % (selected, p * self.getMaxLineNumber(),
2432 2433
       unicode(Message(domain = ui_domain, message = '${page} of ${total_pages}',
                       mapping = dict(page = p + 1, total_pages = self.total_pages)))))
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 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

    html_list.append("""\
    </select>
   </td>
   <td nowrap valign="middle" align="center">
""")

    # Embed a next page button, only if applicable.
    if self.current_page < self.total_pages - 1:
      html_list.append("""\
    <input id="%(field_id)s_next_page" type="image" src="%(portal_url_string)s/images/1rightarrowv.png"
      title="%(next_page_title)s" name="portal_selections/nextPage:method" border="0" />
""" % format_dict)

    # Create the label line.
    html_list.append("""\
   </td>
  </tr>
 </table>
</div>
<!-- List Content -->
<div class="ListContent">
 <table cellpadding="0" cellspacing="0" border="0">
  <tr id="%(field_id)s_label_line">
""" % format_dict)

    # Make a report tree selection, if applicable.
    if self.isReportTreeMode():
      html_list.append("""\
   <td class="Data" width="50" align="left" valign="middle">
    <select name="report_root_url" onChange="submitAction(this.form, '%(context_url)s/portal_selections/setReportRoot')">
""" % format_dict)

      for c in self.getReportRootList():
        if c[0] == self.getSelectedReportPath():
          selected = 'selected'
        else:
          selected = ''

        html_list.append("""\
     <option %s value="%s">%s</option>
""" % (selected, c[0], c[1]))

      html_list.append("""\
    </select>
   </td>
""")

    # Show check and uncheck icons, if applicable.
    if self.showSelectColumn():
      html_list.append("""\
   <td class="Data" width="50" align="center" valign="middle">
    <input id="%(field_id)s_check_all" type="image" name="portal_selections/checkAll:method" value="1"
      src="%(portal_url_string)s/images/checkall.png" border="0" alt="Check All" title="%(check_all_title)s" />\
&nbsp;<input id="%(field_id)s_uncheck_all" type="image" name="portal_selections/uncheckAll:method" value="1"
      src="%(portal_url_string)s/images/decheckall.png" border="0" alt="Uncheck All" title="%(uncheck_all_title)s" />
   </td>
""" % format_dict)

    # Show labels with quick sort links when appropriate.
2494
    for sql, title, sort_order in self.getLabelValueList():
2495 2496 2497
      html_list.append("""\
   <td class="Data">\
""")
2498
      if sql is not None:
2499
        html_list.append("""\
2500 2501
<a href="portal_selections/setSelectionQuickSortOrder?selection_name=%s&amp;sort_on=%s&amp;form_id=%s">%s</a>\
""" % (self.getSelectionName(), sql, self.getForm().id, unicode(Message(domain = ui_domain, message = title))))
2502

2503 2504
        if sort_order == 'ascending':
          html_list.append("""\
2505 2506
 <img src="%(portal_url_string)s/images/1bottomarrow.png" alt="Ascending Display" title="%(ascending_display_title)s" />\
""" % format_dict)
2507 2508
        elif sort_order == 'descending':
          html_list.append("""\
2509 2510 2511
 <img src="%(portal_url_string)s/images/1toparrow.png" alt="Descending Display" title="%(descending_display_title)s" />\
""" % format_dict)
      else:
2512
        html_list.append('%s' % (unicode(Message(domain = ui_domain, message = title),)))
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 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554

      html_list.append("""\
   </td>
""")

    html_list.append("""\
  </tr>
""")

    # Make the search line, if enabled. Or, make a report depth selector only in report tree mode.
    if self.showSearchLine() or self.isReportTreeMode():
      if self.showSearchLine():
        html_list.append("""\
  <tr id="%(field_id)s_search_line">
""" % format_dict)
      else:
        html_list.append("""\
  <tr id="%(field_id)s_report_depth_line">
""" % format_dict)

      # Make a report depth selector, if applicable.
      if self.isReportTreeMode():
        if self.showSearchLine():
          colspan = 1
        else:
          colspan = len(self.getSelectedColumnList()) + self.showSelectColumn() + 1

        html_list.append("""\
   <td class="Data" width="50" align="left" valign="middle" colspan="%d">\
""" % colspan)

        # XXX isn't it better to make this configurable?
        for i in xrange(0, 6):
          html_list.append("""\
&nbsp;<a href="%s?selection_name=%s&selection_index=%s&report_depth:int=%d">%d</a>\
""" % (self.getUrl(), self.getRequestedSelectionName(), self.getSelectionIndex(), i, i))

        is_report_opened = self.getSelection().isReportOpened()
        html_list.append("""\
&nbsp;-&nbsp;<a href="%s?selection_name=%s&selection_index=%s&is_report_opened:int=%d">%s</a>\
""" % (self.getUrl(), self.getRequestedSelectionName(), self.getSelectionIndex(),
       not is_report_opened,
2555
       unicode(Message(domain = ui_domain, message = is_report_opened and 'Hide' or 'Show'))))
2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570

        html_list.append("""\
   </td>
""")

      # Put a select icon, if enabled.
      if self.showSelectColumn() and self.showSearchLine():
        html_list.append("""\
   <td class="Data" width="50" align="center" valign="middle">
     <input id="%(field_id)s_select" type="image" src="%(portal_url_string)s/images/exec16.png" title="%(action_title)s" alt="Action" name="Base_doSelect:method" />
   </td>
""" % format_dict)

      # Add search fields.
      if self.showSearchLine():
2571
        for alias, param, search_field in self.getSearchValueList():
2572 2573 2574 2575
          html_list.append("""\
   <td class="DataB">
""")

2576
          if alias is not None:
2577
            # Render the search field by a widget, if any.
2578
            if search_field is not None:
2579 2580
              search_field_html = search_field.render(value = param, key = alias)
            else:
2581
              search_field_html = """<input name="%s" size="8" value="%s" />""" % (alias, cgi.escape(param))
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598

            # FIXME: The font size should be defined in the CSS.
            html_list.append("""\
    <font size="-3">%s</font>
""" % search_field_html)

          html_list.append("""\
   </td>
""")

      # Terminate the search line.
      html_list.append("""\
  </tr>
""")

    # Add data lines.
    selection = self.getSelection()
2599
    checked_uid_set = self.getCheckedUidSet()
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623

    for i, line in enumerate(line_list):
      # Change the appearance of each line for visibility.
      if (i % 2) == 0:
        tr_css = 'DataA'
      else:
        tr_css = 'DataB'

      # For now, use the same class name for td as well.
      td_css = tr_css

      html_list.append("""\
  <tr id="%s_data_line_%d" class="%s">
""" % (self.getId(), i, tr_css))

      # Embed the uid of the object.
      html_list.append("""\
   <input type="hidden" value="%s" name="%s_uid:list" />
""" % (line.getUid() or '', self.getId()))

      # Show a report section column in report tree mode.
      if self.isReportTreeMode():
        # Get the title or the id of the context.
        if line.getContext() is not None:
2624
          section_name = unicode(Message(domain = context_domain, message = line.getContext().getTitleOrId()))
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
        else:
          section_name = ''

        # Select the prefix for the section name.
        if len(section_name):
          if line.isOpen():
            section_char = '- '
          else:
            section_char = '+ '
        else:
          section_char = ''

        if line.isOpen():
          method_id = 'foldReport'
        else:
          method_id = 'unfoldReport'

        domain_url = line.getDomainUrl()

        html_list.append("""\
   <td class="%s" align="left" valign="middle">
     <a href="portal_selections/%s?report_url=%s&form_id=%s&list_selection_name=%s">%s%s%s</a>
   </td>
""" % (td_css, method_id, domain_url, self.getForm().id, self.getSelectionName(),
       '&nbsp;&nbsp;' * line.getDepth(), section_char, section_name))

      # Show a select column, if enabled.
      if self.showSelectColumn():
        html_list.append("""\
   <td class="%s" width="50" align="center" valign="middle">
""" % td_css)

        if not line.isSummary() and line.getObject() is not None:
          if line.getUid() in checked_uid_set:
            selected = 'checked'
          else:
            selected = ''

          html_list.append("""\
     <input type="checkbox" %s value="%s" id="%s_cb_%s" name="uids:list" />
""" % (selected, line.getUid(), self.getId(), line.getUid()))
        else:
          html_list.append('&nbsp;')

        html_list.append("""\
   </td>
""")

      # Add data columns.
      for html, original_value, error in line.render():
        # Depending on the type of the original value, determine an alignment.
        # FIXME: should use a CSS class instead of "align".
        if isinstance(original_value, (float, int, long)):
          td_align = 'right'
        else:
          td_align = 'left'

        if error:
          td_css = td_css + 'Error'

        html_list.append("""\
   <td class="%s" align="%s">%s</td>
""" % (td_css, td_align, html))

      # Terminate the line.
      html_list.append("""\
  </tr>
""")

    # Show a stat line, if enabled.
    if self.showStat():
      html_list.append("""\
  <tr id="%(field_id)s_stat_line">
""" % format_dict)

      if self.isReportTreeMode():
        html_list.append("""\
   <td class="Data">&nbsp;</td>
""")

      if self.showSelectColumn():
        html_list.append("""\
   <td class="Data">&nbsp;</td>
""")

      for original_value, processed_value in self.getStatValueList():
        # XXX Determine the alignment.
        if isinstance(original_value, (float, int, long)):
          td_align = 'right'
        else:
          td_align = 'left'

        processed_value = cgi.escape(processed_value)

        html_list.append("""\
   <td class="Data" align="%s">%s</td>
""" % (td_align, processed_value))

      html_list.append("""\
  </tr>
""")

    html_list.append("""\
 </table>
</div>
""")

    # In domain tree mode, an extra table is used, so terminate the table here.
    if self.isDomainTreeMode():
      html_list.append("""\
   </td>
  </tr>
 </table>
""")

    html_list.append("""\
<!-- ListBox %(field_id)s ends here. -->
""" % format_dict)

    return ''.join(html_list)

2746 2747
allow_class(ListBoxHTMLRenderer)

2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782
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()
2783
      listboxline.setSectionDepth(line.getDepth())
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828

      if line.isSummary():
        listboxline.markSummaryLine()
        # XXX What is this "+ 1"?
        listboxline.setSectionDepth(line.getDepth() + 1)
        context = line.getContext()
        if context is not None:
          section_name = context.getTitleOrId() or None
        else:
          section_name = None
        listboxline.setSectionName(section_name)
        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;', ' ')

2829
        stat_listboxline.addColumn(sql, value)
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844

      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')
2845 2846
        column_ids = [x[0] for x in columns]
        editable_column_ids = [x[0] for x in editable_columns]
2847 2848
        selection_name = field.get_value('selection_name')
        #LOG('ListBoxValidator', 0, 'field = %s, selection_name = %s' % (repr(field), repr(selection_name)))
2849 2850 2851
        params = here.portal_selections.getSelectionParamsFor(
                                                           selection_name, 
                                                           REQUEST=REQUEST)
2852 2853 2854 2855 2856 2857
        portal_url = getToolByName(here, 'portal_url')
        portal = portal_url.getPortalObject()


        result = {}
        error_result = {}
2858 2859 2860 2861
        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, )
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
        #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)
2874
            #LOG('ListBoxValidator', 0, 'call %s' % repr(list_method))
2875
            object_list = list_method(REQUEST=REQUEST, **params)
2876 2877 2878 2879 2880 2881 2882 2883
            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
2884 2885 2886 2887
            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
2888
            listbox[uid[4:]] = {}
2889 2890
            # We first try to set a listbox corresponding to all things
            # we can validate, so that we can use the same list
2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907
            # as the one used for displaying the listbox
            for sql in editable_column_ids:
              alias = '_'.join(sql.split('.'))
              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:
                  value = my_field.validator.validate(my_field, key, REQUEST) # We need cell
                  # Here we set the property
                  listbox[uid[4:]][sql] = value
2908
                except ValidationError, err:
2909
                  pass
2910 2911
                except KeyError:
                  pass
2912 2913 2914 2915 2916
        # 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)
2917
          REQUEST.set(field.id, listbox)
2918
          object_list = list_method(REQUEST=REQUEST,**params)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2919
        for uid in listbox_uids:
2920 2921
          if str(uid).find('new') == 0:
            # First case: dialog input to create new objects
2922 2923 2924 2925 2926 2927
            #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
2928 2929 2930 2931
            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
2932
            result[uid[4:]] = {}
2933 2934 2935 2936 2937 2938 2939
            for sql in editable_column_ids:
              alias = '_'.join(sql.split('.'))
              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
2940 2941
              if form.has_field( my_field_id ):
                my_field = form.get_field(my_field_id)
2942 2943
                REQUEST.cell = o
                if my_field.get_value('editable',REQUEST=REQUEST) and field.need_validate(REQUEST):
2944 2945
                  key = 'field_%s_%s' % (my_field.id, o.uid)
                  error_result_key = '%s_%s' % (my_field.id, o.uid)
2946 2947 2948
                  try:
                    value = my_field.validator.validate(my_field, key, REQUEST) # We need cell
                    result[uid[4:]][sql] = value
2949
                  except ValidationError, err:
2950 2951 2952
                    #LOG("ListBox ValidationError",0,str(err))
                    err.field_id = error_result_key
                    errors.append(err)
2953 2954
          else:
            # Second case: modification of existing objects
2955 2956
            #try:
            if 1: #try:
2957 2958
              # We must try this
              # because sometimes, we can be provided bad uids
2959 2960
              try :
                o = here.portal_catalog.getObject(uid)
2961
              except (KeyError, NotFound, ValueError):
2962
                o = None
2963 2964 2965 2966 2967 2968 2969 2970
              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)
                  object_list = list_method(REQUEST=REQUEST,**params)
                for object in object_list:
2971 2972 2973 2974 2975 2976 2977 2978
                  try:
                    if object.getUid() == int(uid):
                      o = object
                      break
                  except ValueError:
                    if str(object.getUid()) == uid:
                      o = object
                      break
2979 2980 2981 2982 2983 2984 2985 2986 2987
              for sql in editable_column_ids:
                alias = '_'.join(sql.split('.'))
                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)
2988 2989
                  REQUEST.cell = o # We need cell
                  if my_field.get_value('editable',REQUEST=REQUEST) and field.need_validate(REQUEST):
2990 2991 2992
                    tales_expr = my_field.tales.get('default', "")
                    key = 'field_' + my_field.id + '_%s' % o.uid
                    error_result_key = my_field.id + '_%s' % o.uid
2993
                    try:
2994 2995 2996
                      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()):
2997
                        result[o.getUrl()] = {}
2998
                      result[o.getUrl()][sql] = value
2999
                    except ValidationError, err:
3000 3001 3002
                      #LOG("ListBox ValidationError",0,str(err))
                      err.field_id = error_result_key
                      errors.append(err)
3003 3004
            #except:
            else:
3005
              LOG("ListBox WARNING",0,"Object uid %s could not be validated" % uid)
3006
        if len(errors) > 0:
3007 3008
            LOG("ListBox FormValidationError",0,str(error_result))
            LOG("ListBox FormValidationError",0,str(errors))
3009
            raise FormValidationError(errors, error_result)
3010
        return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3011 3012 3013 3014

ListBoxValidatorInstance = ListBoxValidator()

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

3017 3018
  widget = ListBoxWidgetInstance
  validator = ListBoxValidatorInstance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3019

3020
  security = ClassSecurityInfo()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3021

3022 3023 3024 3025
  security.declareProtected('Access contents information', 'get_value')
  def get_value(self, id, **kw):
    if (id == 'default'):
      if (kw.get('render_format') in ('list', )):
3026 3027 3028 3029 3030 3031 3032 3033 3034
        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.
        field = request.get('field__proxyfield_%s_%s' % (self.id, id), self)
        return self.widget.render(field, self.generate_field_key(), None,
                                  request,
3035
                                  render_format=kw.get('render_format'))
3036
      else:
3037 3038 3039
        return None
    else:
      return ZMIField.get_value(self, id, **kw)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
3040

3041 3042 3043
  security.declareProtected('Access contents information', 'getListMethodName')
  def getListMethodName(self):
    """Return the name of the list method. If not defined, return None.
3044 3045

       XXX - Is this method really necessary - I am not sure - JPS
3046 3047
       Why not use Formulator API instead ? -> the answer is that it is a
         MethodField, and it's method_name attribute is not available from
3048 3049
         restricted environment. It is only used in
         ERP5Site_checkNamingConventions
3050 3051 3052

      XXX also this method is not compatible with ProxyFields.
      It will go away soon.
3053 3054 3055 3056 3057 3058 3059
    """
    list_method = self.get_value('list_method')
    try:
      name = getattr(list_method, 'method_name')
    except AttributeError:
      name = list_method
    return name or None
3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071


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

3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090
    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 = []
3091

3092 3093
  security.declarePublic('__getitem__')
  def __getitem__(self, column_id):
3094
    return self.getColumnProperty(column_id)
3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110

  #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'
    """
3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121
    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]

3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143
    self.setConfigProperty('content_mode',content_mode)

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

3145 3146
  security.declarePublic('isStatLine')
  def isStatLine(self):
3147 3148 3149 3150
    """
      Returns 1 is this line contains no data but only stats
    """
    return self.is_stat_line
3151

3152 3153 3154 3155 3156 3157
  #security.declarePublic('View')
  def markDataLine(self):
    """
      Set content of the line to 'DataLine'
    """
    self.setListboxLineContentMode('DataLine')
3158

3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
  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
    """
    self.setConfigProperty('is_checked',is_checked)

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

3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
  #security.declarePublic('View')
  def setObjectUid(self, object_uid):
    """
      Define the uid of the object
      Default value is None
    """
    self.setConfigProperty('uid',object_uid)

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

3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232
  #security.declarePublic('View')
  def setSectionName(self, section_name):
    """
      Set the section name of this line
      Default value is None
    """
    self.setConfigProperty('section_name',section_name)

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

3234 3235 3236 3237 3238 3239 3240
  security.declarePublic('getSectionDepth')
  def getSectionDepth(self):
    """
      Returns the section depth of this line
      0 means no depth
    """
    return self.getConfigProperty('section_depth')
3241

3242 3243 3244 3245 3246 3247
  #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
3248 3249


3250 3251 3252 3253 3254
  security.declarePublic('isSectionFolded')
  def isSectionFolded(self):
    """
      Returns 1 if section is in 'Folded' Mode
    """
3255 3256
    return self.is_section_folded

3257 3258 3259
  #security.declarePublic('View')
  def addColumn(self, column_id, column_value):
    """
3260
      Add a new column
3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275
    """
    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):
    """
3276
      Returns a list of the property
3277 3278
      column_id_list selects the column_id returned
    """
3279

3280 3281
    if column_id_list == None:
      column_id_list = self.column_id_list
3282

3283 3284 3285 3286
    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]
3287 3288


3289 3290 3291 3292 3293 3294 3295 3296
    return config_column + [self.column_dict[column_id] for column_id in column_id_list]

  security.declarePublic('getColumnItemList')
  def getColumnItemList(self, column_id_list = None ):
    """
      Returns a list of property tuple
      column_id_list selects the column_id returned
    """
3297

3298 3299
    if column_id_list == None:
      column_id_list = self.column_id_list
3300

3301 3302 3303 3304 3305 3306 3307
    """
    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]
3308

3309
    return config_column + [(column_id , self.column_dict[column_id]) for column_id in column_id_list]
3310

3311 3312 3313 3314 3315 3316 3317 3318
  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
3319

3320 3321 3322
InitializeClass(ListBoxLine)
allow_class(ListBoxLine)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
3323
# Psyco
3324
from Products.ERP5Type.PsycoWrapper import psyco
3325
#psyco.bind(ListBoxWidget.render)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3326 3327
psyco.bind(ListBoxValidator.validate)

3328 3329 3330
# Register get_value
from Products.ERP5Form.ProxyField import registerOriginalGetValueClassAndArgument
registerOriginalGetValueClassAndArgument(ListBox, 'default')