SelectionTool.py 68.5 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3
##############################################################################
#
4
# Copyright (c) 2002,2007 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7
#
# WARNING: This program as such is intended to be used by professional
8
# programmers who take the whole responsibility of assessing all potential
Jean-Paul Smets's avatar
Jean-Paul Smets committed
9 10
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
11
# guarantees and support are strongly adviced to contract a Free Software
Jean-Paul Smets's avatar
Jean-Paul Smets committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# 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.
#
##############################################################################

30 31
"""
  ERP5 portal_selection tool.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33 34 35 36 37
"""

from OFS.SimpleItem import SimpleItem
from Products.CMFCore.utils import UniqueObject
from Globals import InitializeClass, DTMLFile, PersistentMapping, get_request
from AccessControl import ClassSecurityInfo
38
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40
from Products.ERP5Type import Permissions as ERP5Permissions
from Products.ERP5Form import _dtmldir
41
from Selection import Selection, DomainSelection
42
from ZPublisher.HTTPRequest import FileUpload
Sebastien Robin's avatar
Sebastien Robin committed
43
import md5
44
import string, re
45
from urlparse import urlsplit, urlunsplit
46 47
from zLOG import LOG, INFO
from Acquisition import aq_base
48
from Products.ERP5Type.Message import translateString
49
import warnings
50

51

52 53
_MARKER = []

Jean-Paul Smets's avatar
Jean-Paul Smets committed
54 55 56
class SelectionError( Exception ):
    pass

57
class SelectionTool( BaseTool, UniqueObject, SimpleItem ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59 60 61 62 63 64 65
    """
      The SelectionTool object is the place holder for all
      methods and algorithms related to persistent selections
      in ERP5.
    """

    id              = 'portal_selections'
    meta_type       = 'ERP5 Selections'
66
    portal_type     = 'Selection Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67 68 69 70 71 72 73
    security = ClassSecurityInfo()

    #
    #   ZMI methods
    #
    manage_options = ( ( { 'label'      : 'Overview'
                         , 'action'     : 'manage_overview'
74 75
                         },
                         { 'label'      : 'View Selections'
76
                         , 'action'     : 'manage_viewSelections'
77 78 79
                         },
                         { 'label'      : 'Configure'
                         , 'action'     : 'manage_configure'
80
                         } ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
81 82 83

    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_overview' )
84
    manage_overview = DTMLFile( 'explainSelectionTool', _dtmldir )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
85

86
    security.declareProtected( ERP5Permissions.ManagePortal
87 88
                             , 'manage_viewSelections' )
    manage_viewSelections = DTMLFile( 'SelectionTool_manageViewSelections', _dtmldir )
89

90 91 92 93
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_configure' )
    manage_configure = DTMLFile( 'SelectionTool_configure', _dtmldir )

94 95 96 97 98 99 100 101 102 103 104
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_deleteSelection' )
    def manage_deleteSelection(self, selection_name, REQUEST=None):
      """
        Relete a specified selection
      """
      self._deleteSelectionFromContainer(selection_name)
      if REQUEST is not None:
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manage_viewSelections'))

105 106 107 108 109 110 111 112 113 114 115
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_deleteGlobalSelection' )
    def manage_deleteGlobalSelection(self, selection_name, REQUEST=None):
      """
        Relete a specified selection
      """
      self._deleteGlobalSelectionFromContainer(selection_name)
      if REQUEST is not None:
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manage_viewSelections'))

116
    # storages of SelectionTool
117 118 119 120 121 122 123 124 125 126 127
    security.declareProtected(ERP5Permissions.ManagePortal
                              , 'getStorageItemList')
    def getStorageItemList(self):
      """Return the list of available storages
      """
      #storage_item_list = [('Persistent Mapping', 'selection_data',)]
      #list of tuple may fail dtml code: zope/documenttemplate/dt_in.py +578
      storage_item_list = [['Persistent Mapping', 'selection_data']]
      memcached_plugin_list = self.portal_memcached.contentValues(portal_type='Memcached Plugin', sort_on='int_index')
      storage_item_list.extend([['/'.join((mp.getParentValue().getTitle(), mp.getTitle(),)), mp.getRelativeUrl()] for mp in memcached_plugin_list])
      return storage_item_list
128 129 130 131 132 133

    security.declareProtected( ERP5Permissions.ManagePortal, 'setStorage')
    def setStorage(self, value, RESPONSE=None):
      """
        Set the storage of Selection Tool.
      """
134
      if value in [item[1] for item in self.getStorageItemList()]:
135 136 137 138 139 140
        self.storage = value
      else:
        raise ValueError, 'Given storage type (%s) is now supported.' % (value,)
      if RESPONSE is not None:
        RESPONSE.redirect('%s/manage_configure' % (self.absolute_url()))

141
    security.declareProtected( ERP5Permissions.ManagePortal, 'getStorage')
142
    def getStorage(self, default=None):
143 144
      """return the selected storage
      """
145
      if default is None:
146
        default = self.getStorageItemList()[0][1]
147
      storage = getattr(aq_base(self), 'storage', default)
148 149 150 151 152 153 154
      if storage is not default and storage not in [item[1] for item in self.getStorageItemList()]:
        #Backward compatibility
        if storage == 'Persistent Mapping':
          storage = 'selection_data'
        elif storage == 'Memcached Tool':
          memcached_plugin_list = self.portal_memcached.contentValues(portal_type='Memcached Plugin', sort_on='int_index')
          storage = memcached_plugin_list[0].getRelativeUrl()
155 156 157
      return storage

    def isMemcachedUsed(self):
158
      return 'portal_memcached' in self.getStorage()
159

Vincent Pelletier's avatar
Vincent Pelletier committed
160 161
    def _redirectToOriginalForm(self, REQUEST=None, form_id=None, dialog_id=None,
                                query_string=None,
162
                                no_reset=False, no_report_depth=False):
Vincent Pelletier's avatar
Vincent Pelletier committed
163 164
      """Redirect to the original form or dialog, using the information given
         as parameters.
165 166
         (Actually does not redirect  in the HTTP meaning because of URL
         limitation problems.)
Vincent Pelletier's avatar
Vincent Pelletier committed
167 168 169

         DEPRECATED parameters :
         query_string is used to transmit parameters from caller to callee.
170
         If no_reset is True, replace reset parameters with noreset.
Vincent Pelletier's avatar
Vincent Pelletier committed
171 172
         If no_report_depth is True, replace report_depth parameters with
         noreport_depth.
173 174 175 176
      """
      if REQUEST is None:
        return

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
177 178 179 180 181 182 183
      form = REQUEST.form
      if no_reset and form.has_key('reset'):
        form['noreset'] = form['reset'] # Kept for compatibility - might no be used anymore
        del form['reset']
      if no_report_depth and form.has_key('report_depth'):
        form['noreport_depth'] = form['report_depth'] # Kept for compatibility - might no be used anymore
        del form['report_depth']
Vincent Pelletier's avatar
Vincent Pelletier committed
184

185
      if query_string is not None:
186 187
        warnings.warn('DEPRECATED: _redirectToOriginalForm got called with a query_string. The variables must be passed in REQUEST.form.',
                      DeprecationWarning)
188
      context = REQUEST['PARENTS'][0]
Vincent Pelletier's avatar
Vincent Pelletier committed
189
      form_id = dialog_id or REQUEST.get('dialog_id', None) or form_id or REQUEST.get('form_id', 'view')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190
      return getattr(context, form_id)()
191

192 193
    security.declareProtected(ERP5Permissions.View, 'getSelectionNameList')
    def getSelectionNameList(self, context=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196
      """
        Returns the selection names of the current user.
      """
197 198
      if self.isMemcachedUsed():
        return []
199
      return sorted(self._getSelectionNameListFromContainer())
200

201 202 203 204 205 206 207 208
    # backward compatibility
    security.declareProtected(ERP5Permissions.View, 'getSelectionNames')
    def getSelectionNames(self, context=None, REQUEST=None):
      warnings.warn("getSelectionNames() is deprecated.\n"
                    "Please use getSelectionNameList() instead.",
                    DeprecationWarning)
      return self.getSelectionNameList(context, REQUEST)

209 210 211 212 213 214 215 216
    security.declareProtected(ERP5Permissions.View, 'callSelectionFor')
    def callSelectionFor(self, selection_name, context=None, REQUEST=None):
      if context is None: context = self
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is None:
        return None
      return selection(context=context)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
217 218 219 220 221
    security.declareProtected(ERP5Permissions.View, 'getSelectionFor')
    def getSelectionFor(self, selection_name, REQUEST=None):
      """
        Returns the selection instance for a given selection_name
      """
222 223 224 225 226
      if isinstance(selection_name, (tuple, list)):
        selection_name = selection_name[0]
      selection = self._getSelectionFromContainer(selection_name)
      if selection is not None:
        return selection.__of__(self)
227

228 229 230
    def __getitem__(self, key):
        return self.getSelectionParamsFor(key)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
231 232 233 234 235
    security.declareProtected(ERP5Permissions.View, 'setSelectionFor')
    def setSelectionFor(self, selection_name, selection_object, REQUEST=None):
      """
        Sets the selection instance for a given selection_name
      """
236 237
      if selection_object != None:
        # Set the name so that this selection itself can get its own name.
238
        selection_object.edit(name=selection_name)
239

240 241
      if self.getSelectionFor(selection_name) != selection_object:
        self._setSelectionToContainer(selection_name, selection_object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
242

243 244
    security.declareProtected(ERP5Permissions.View, 'getSelectionParamsFor')
    def getSelectionParamsFor(self, selection_name, params=None, REQUEST=None):
245 246 247
      """
        Returns the params in the selection
      """
248
      if params is None: params = {}
249 250
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
251 252
        if len(selection.params) > 0:
          return selection.getParams()
253 254 255 256
        else:
          return params
      else:
        return params
257 258

    # backward compatibility
259 260
    security.declareProtected(ERP5Permissions.View, 'getSelectionParams')
    getSelectionParams = getSelectionParamsFor
261

Jean-Paul Smets's avatar
Jean-Paul Smets committed
262 263 264 265 266 267
    security.declareProtected(ERP5Permissions.View, 'setSelectionParamsFor')
    def setSelectionParamsFor(self, selection_name, params, REQUEST=None):
      """
        Sets the selection params for a given selection_name
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
268
      if selection_object is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
269 270 271 272 273
        selection_object.edit(params=params)
      else:
        selection_object = Selection(params=params)
      self.setSelectionFor(selection_name, selection_object, REQUEST)

274
    security.declareProtected(ERP5Permissions.View, 'getSelectionDomainDictFor')
275 276 277 278 279 280 281 282 283 284 285
    def getSelectionDomainDictFor(self, selection_name, REQUEST=None):
      """
        Returns the Domain dict for a given selection_name
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        try:
          return selection.getDomain().asDomainDict
        except AttributeError:
          return {}

286
    security.declareProtected(ERP5Permissions.View, 'getSelectionReportDictFor')
287 288 289 290 291 292 293 294 295 296 297
    def getSelectionReportDictFor(self, selection_name, REQUEST=None):
      """
        Returns the Report dict for a given selection_name
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        try:
          return selection.getReport().asDomainDict
        except AttributeError:
          return {}

Jean-Paul Smets's avatar
Jean-Paul Smets committed
298 299 300
    security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor')
    def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None):
      """
301
        Sets the checked uids for a given selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
302 303 304 305 306 307 308 309
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
        selection_object.edit(checked_uids=checked_uids)
      else:
        selection_object = Selection(checked_uids=checked_uids)
      self.setSelectionFor(selection_name, selection_object, REQUEST)

310
    security.declareProtected(ERP5Permissions.View, 'updateSelectionCheckedUidList')
311 312
    def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None):
      """
313 314
        Updates the unchecked uids(listbox_uids) and checked uids (uids)
        for a given selection_name
315 316 317 318 319 320 321 322
      """
      if listbox_uid is None:
        listbox_uid = []
      if uids is None:
        uids = []
      self.uncheckAll(selection_name,listbox_uid,REQUEST=REQUEST)
      self.checkAll(selection_name,uids,REQUEST=REQUEST)

323 324 325
    security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor')
    def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None):
      """
326
        Returns the checked uids for a given selection_name
327 328 329
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
330
        return selection_object.getCheckedUids()
331 332 333
      return []

    security.declareProtected(ERP5Permissions.View, 'checkAll')
334
    def checkAll(self, list_selection_name, listbox_uid=[], REQUEST=None,
335
                 query_string=None, form_id=None):
336
      """
337
        Check uids in a given listbox_uid list for a given list_selection_name
338
      """
339
      selection_object = self.getSelectionFor(list_selection_name, REQUEST)
340 341
      if selection_object:
        selection_uid_dict = {}
342
        for uid in selection_object.checked_uids:
343 344
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
345 346
          try:
            selection_uid_dict[int(uid)] = 1
347
          except ValueError:
348
            selection_uid_dict[uid] = 1
349
        self.setSelectionCheckedUidsFor(list_selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
350 351 352
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string, no_reset=True)
353 354

    security.declareProtected(ERP5Permissions.View, 'uncheckAll')
355
    def uncheckAll(self, list_selection_name, listbox_uid=[], REQUEST=None,
356
                   query_string=None, form_id=None):
357
      """
358
        Uncheck uids in a given listbox_uid list for a given list_selection_name
359
      """
360
      selection_object = self.getSelectionFor(list_selection_name, REQUEST)
361 362
      if selection_object:
        selection_uid_dict = {}
363
        for uid in selection_object.checked_uids:
364 365
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
366 367 368
          try:
            if selection_uid_dict.has_key(int(uid)): del selection_uid_dict[int(uid)]
          except ValueError:
369
            if selection_uid_dict.has_key(uid): del selection_uid_dict[uid]
370
        self.setSelectionCheckedUidsFor(list_selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
371 372 373
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string, no_reset=True)
374

Jean-Paul Smets's avatar
Jean-Paul Smets committed
375 376 377 378 379 380 381
    security.declareProtected(ERP5Permissions.View, 'getSelectionListUrlFor')
    def getSelectionListUrlFor(self, selection_name, REQUEST=None):
      """
        Returns the URL of the list mode of selection instance
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
382
        return selection.getListUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383 384
      else:
        return None
385

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
    security.declareProtected(ERP5Permissions.View, 'getSelectionInvertModeFor')
    def getSelectionInvertModeFor(self, selection_name, REQUEST=None):
      """Get the 'invert_mode' parameter of a selection.
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        return selection.isInvertMode()
      return 0

    security.declareProtected(ERP5Permissions.View, 'setSelectionInvertModeFor')
    def setSelectionInvertModeFor(self, selection_name,
                                  invert_mode, REQUEST=None):
      """Change the 'invert_mode' parameter of a selection.
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        selection.edit(invert_mode=invert_mode)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
403

404
    security.declareProtected(ERP5Permissions.View, 'getSelectionInvertModeUidListFor')
405 406 407 408 409 410 411 412
    def getSelectionInvertModeUidListFor(self, selection_name, REQUEST=None):
      """Get the 'invert_mode' parameter of a selection.
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        return selection.getInvertModeUidList()
      return 0

413 414 415 416 417 418 419 420 421
    security.declareProtected(ERP5Permissions.View, 'getSelectionIndexFor')
    def getSelectionIndexFor(self, selection_name, REQUEST=None):
      """Get the 'index' parameter of a selection.
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        return selection.getIndex()
      return None

Jean-Paul Smets's avatar
Jean-Paul Smets committed
422 423 424 425 426 427 428
    security.declareProtected(ERP5Permissions.View, 'setSelectionToIds')
    def setSelectionToIds(self, selection_name, selection_uids, REQUEST=None):
      """
        Sets the selection to a small list of uids of documents
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
429
        selection.edit(invert_mode=1, uids=selection_uids, checked_uids=selection_uids)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
430 431

    security.declareProtected(ERP5Permissions.View, 'setSelectionToAll')
432 433
    def setSelectionToAll(self, selection_name, REQUEST=None,
                          reset_domain_tree=False, reset_report_tree=False):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
434 435 436 437 438
      """
        Resets the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
439
        selection.edit(invert_mode=0, params={}, checked_uids=[], report_opened=1)
440
        if reset_domain_tree:
441
          selection.edit(domain=None, domain_path=None, domain_list=None)
442
        if reset_report_tree:
443
          selection.edit(report=None, report_path=None, report_list=None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
444 445 446 447 448 449 450 451 452 453 454

    security.declareProtected(ERP5Permissions.View, 'setSelectionSortOrder')
    def setSelectionSortOrder(self, selection_name, sort_on, REQUEST=None):
      """
        Defines the sort order of the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        selection.edit(sort_on=sort_on)

    security.declareProtected(ERP5Permissions.View, 'setSelectionQuickSortOrder')
455
    def setSelectionQuickSortOrder(self, selection_name=None, sort_on=None, REQUEST=None,
456
                                   query_string=None, form_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
457 458 459 460
      """
        Defines the sort order of the selection directly from the listbox
        In this method, sort_on is just a string that comes from url
      """
461 462
      # selection_name, sort_on and form_id params are kept only for bacward compatibilty
      # as some test call setSelectionQuickSortOrder in url with these params
Aurel's avatar
Aurel committed
463
      listbox_id = None
464 465
      if REQUEST is not None:
        form = REQUEST.form
466
      if sort_on is None:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
467
        listbox_id, sort_on = form["setSelectionQuickSortOrder"].split(".", 1)
468

469 470 471 472 473 474
      if REQUEST is not None:
        if listbox_id is not None:
            selection_name_key = "%s_list_selection_name" %listbox_id
            selection_name = form[selection_name_key]
        elif selection_name is None:
            selection_name = form['selection_name']
Aurel's avatar
Aurel committed
475
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        current_sort_on = self.getSelectionSortOrder(selection_name)
        # We must first switch from asc to desc and vice-versa if sort_order exists
        # in selection
        n = 0
        for current in current_sort_on:
          if current[0] == sort_on:
            n = 1
            if current[1] == 'ascending':
              new_sort_on = [(sort_on, 'descending')]
              break
            else:
              new_sort_on = [(sort_on,'ascending')]
              break
        # And if no one exists, we just set ascending sort
        if n == 0:
          new_sort_on = [(sort_on,'ascending')]
        selection.edit(sort_on=new_sort_on)

496
      if REQUEST is not None:
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
497 498
        if form.has_key('listbox_uid') and \
            form.has_key('uids'):
499 500 501
          self.uncheckAll(selection_name, REQUEST.get('listbox_uid'))
          self.checkAll(selection_name, REQUEST.get('uids'))

502 503
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string, no_reset=True)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
504 505 506 507 508 509 510 511

    security.declareProtected(ERP5Permissions.View, 'getSelectionSortOrder')
    def getSelectionSortOrder(self, selection_name, REQUEST=None):
      """
        Returns the sort order of the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is None: return ()
512
      return selection.sort_on
Jean-Paul Smets's avatar
Jean-Paul Smets committed
513 514 515 516 517 518 519 520 521 522

    security.declareProtected(ERP5Permissions.View, 'setSelectionColumns')
    def setSelectionColumns(self, selection_name, columns, REQUEST=None):
      """
        Defines the columns in the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      selection.edit(columns=columns)

    security.declareProtected(ERP5Permissions.View, 'getSelectionColumns')
523
    def getSelectionColumns(self, selection_name, columns=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
524
      """
525 526
        Returns the columns in the selection if not empty, otherwise
        returns the value of columns argument
Jean-Paul Smets's avatar
Jean-Paul Smets committed
527
      """
528
      if columns is None: columns = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
529 530
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
531 532
        if len(selection.columns) > 0:
          return selection.columns
533
      return columns
Jean-Paul Smets's avatar
Jean-Paul Smets committed
534 535 536 537 538 539 540 541 542 543 544


    security.declareProtected(ERP5Permissions.View, 'setSelectionStats')
    def setSelectionStats(self, selection_name, stats, REQUEST=None):
      """
        Defines the stats in the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      selection.edit(stats=stats)

    security.declareProtected(ERP5Permissions.View, 'getSelectionStats')
545
    def getSelectionStats(self, selection_name, stats=_MARKER, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
546 547 548
      """
        Returns the stats in the selection
      """
549 550 551 552
      if stats is not _MARKER:
        default_stats = stats
      else:
        default_stats = [' '] * 6
Jean-Paul Smets's avatar
Jean-Paul Smets committed
553 554
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
555
        return getattr(aq_base(selection), 'stats', default_stats)
556
      return default_stats
Jean-Paul Smets's avatar
Jean-Paul Smets committed
557 558 559 560 561 562 563 564 565 566 567


    security.declareProtected(ERP5Permissions.View, 'viewFirst')
    def viewFirst(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
      """
        Access first item in a selection
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
568
        method = self.unrestrictedTraverse(selection.method_path)
569
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
570 571 572 573
        if len(selection_list):
          o = selection_list[0]
          url = o.absolute_url()
        else:
574
          url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
575
      else:
576
        url = REQUEST.getURL()
577 578
      ignore_layout = int(REQUEST.get('ignore_layout', 0))
      url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, 0, selection_name, ignore_layout)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
579 580 581 582 583
      REQUEST.RESPONSE.redirect(url)

    security.declareProtected(ERP5Permissions.View, 'viewLast')
    def viewLast(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
      """
584
        Access last item in a selection
Jean-Paul Smets's avatar
Jean-Paul Smets committed
585 586 587 588 589
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
590
        method = self.unrestrictedTraverse(selection.method_path)
591
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
592 593 594 595 596
        if len(selection_list):
          o = selection_list[-1]
          url = o.absolute_url()
        else:
          url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
597
      else:
598
        url = REQUEST.getURL()
599 600
      ignore_layout = int(REQUEST.get('ignore_layout', 0))
      url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, -1, selection_name, ignore_layout)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
601 602 603 604 605 606 607 608 609 610 611
      REQUEST.RESPONSE.redirect(url)

    security.declareProtected(ERP5Permissions.View, 'viewNext')
    def viewNext(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
      """
        Access next item in a selection
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
612
        method = self.unrestrictedTraverse(selection.method_path)
613
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
Aurel's avatar
Aurel committed
614
        if len(selection_list):
615 616 617 618
          o = selection_list[(int(selection_index) + 1) % len(selection_list)]
          url = o.absolute_url()
        else:
          url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
619
      else:
620
        url = REQUEST.getURL()
621 622
      ignore_layout = int(REQUEST.get('ignore_layout', 0))
      url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, int(selection_index) + 1, selection_name, ignore_layout)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623 624 625 626 627 628 629 630 631 632 633
      REQUEST.RESPONSE.redirect(url)

    security.declareProtected(ERP5Permissions.View, 'viewPrevious')
    def viewPrevious(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
      """
        Access previous item in a selection
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
634
        method = self.unrestrictedTraverse(selection.method_path)
635
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
636 637 638 639 640
        if len(selection_list):
          o = selection_list[(int(selection_index) - 1) % len(selection_list)]
          url = o.absolute_url()
        else:
          url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
641
      else:
642
        url = REQUEST.getURL()
643 644
      ignore_layout = int(REQUEST.get('ignore_layout', 0))
      url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, int(selection_index) - 1, selection_name, ignore_layout)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
645 646 647 648
      REQUEST.RESPONSE.redirect(url)


    # ListBox related methods
649 650

    security.declareProtected(ERP5Permissions.View, 'firstPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
651
    def firstPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
652 653
      """
        Access the first page of a list
654 655 656
        XXX: As its complementary (lastPage) is broken, this method is
        probably not used either. If so, it should be removed along with
        lastPage.
657 658
      """
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
659 660 661
      REQUEST.form['list_start'] = 0
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
662 663

    security.declareProtected(ERP5Permissions.View, 'lastPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
664
    def lastPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
665 666
      """
        Access the last page of a list
667 668 669
        XXX: This method is broken, since "total_size" field is not
        present in the listbox rendering any longer. It should be
        removed.
670 671
      """
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
672
      selection = self.getSelectionFor(list_selection_name, REQUEST)
673 674 675 676 677 678 679 680 681 682 683 684
      if selection is not None:
        params = selection.getParams()
        # XXX This will not work if the number of lines shown in the listbox is greater
        #       than the BIG_INT constan. Such a case has low probability but is not
        #       impossible. If you are in this case, send me a mail ! -- Kev
        BIG_INT = 10000000
        last_page_start = BIG_INT
        total_lines = REQUEST.form.get('total_size', BIG_INT)
        if total_lines != BIG_INT:
          lines_per_page  = params.get('list_lines', 1)
          last_page_start = int(total_lines) - (int(total_lines) % int(lines_per_page))
        REQUEST.form['list_start'] = last_page_start
Vincent Pelletier's avatar
Vincent Pelletier committed
685 686
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
687

Jean-Paul Smets's avatar
Jean-Paul Smets committed
688
    security.declareProtected(ERP5Permissions.View, 'nextPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
689
    def nextPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
690 691 692
      """
        Access the next page of a list
      """
693
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
694
      selection = self.getSelectionFor(list_selection_name, REQUEST)
695 696
      if selection is not None:
        params = selection.getParams()
697 698 699
        lines = int(params.get('list_lines', 0))
        form = REQUEST.form
        if form.has_key('page_start'):
700 701 702 703
          try:
            list_start = (int(form.pop('page_start', 0)) - 1) * lines
          except ValueError:
            list_start = 0
704 705
        else:
          list_start = int(form.pop('list_start', 0))
706
        params['list_start'] = max(list_start + lines, 0)
707
        selection.edit(params=params)
Vincent Pelletier's avatar
Vincent Pelletier committed
708 709
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
710 711

    security.declareProtected(ERP5Permissions.View, 'previousPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
712
    def previousPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
713 714 715
      """
        Access the previous page of a list
      """
716
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
717
      selection = self.getSelectionFor(list_selection_name, REQUEST)
718 719
      if selection is not None:
        params = selection.getParams()
720 721 722
        lines = int(params.get('list_lines', 0))
        form = REQUEST.form
        if form.has_key('page_start'):
723 724 725 726
          try:
            list_start = (int(form.pop('page_start', 0)) - 1) * lines
          except ValueError:
            list_start = 0
727 728 729
        else:
          list_start = int(form.pop('list_start', 0))
        params['list_start'] = max(list_start - lines, 0)
730
        selection.edit(params=params)
Vincent Pelletier's avatar
Vincent Pelletier committed
731 732
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
733 734

    security.declareProtected(ERP5Permissions.View, 'setPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
735
    def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None):
736
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
737
         Sets the current displayed page in a selection
738
      """
739
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
740
      selection = self.getSelectionFor(list_selection_name, REQUEST)
741 742
      if selection is not None:
        params = selection.getParams()
743 744 745
        lines = int(params.get('list_lines', 0))
        form = REQUEST.form
        if form.has_key('page_start'):
746 747 748 749
          try:
            list_start = (int(form.pop('page_start', 0)) - 1) * lines
          except ValueError:
            list_start = 0
750 751
        else:
          list_start = int(form.pop('list_start', 0))
752
        params['list_start'] = max(list_start, 0)
753 754
        selection.edit(params=params)
        self.uncheckAll(list_selection_name, listbox_uid)
Vincent Pelletier's avatar
Vincent Pelletier committed
755
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST, query_string=query_string)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
756

757
    # PlanningBox related methods
758 759
    security.declareProtected(ERP5Permissions.View, 'setLanePath')
    def setLanePath(self, uids=None, REQUEST=None, form_id=None,
760
                     query_string=None):
761 762 763
      """
      Set graphic zoom level in PlanningBox
      """
764 765
      if uids is None:
        uids = []
766 767 768 769 770
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
771 772 773
        lane_path = request.form.get('lane_path', None)
        if lane_path is None:
          # If lane_path is not defined try to 
774
          # use the last one from params
775 776 777 778 779 780
          lane_path = params.get('lane_path',1)
        bound_start = request.form.get('bound_start', None)
        if bound_start is not None:
          params['bound_start'] = bound_start
        params['lane_path'] = lane_path     
        params['zoom_variation'] = 0
781
        selection.edit(params=params)
782
      if REQUEST is not None:
783 784 785
        return self._redirectToOriginalForm(REQUEST=REQUEST,
                                            form_id=form_id,
                                            query_string=query_string)
786

787 788
    security.declareProtected(ERP5Permissions.View, 'nextLanePage')
    def nextLanePage(self, uids=None, REQUEST=None, form_id=None, query_string=None):
789 790 791
      """
      Set next graphic zoom start in PlanningBox
      """
792 793
      if uids is None:
        uids = []
794 795 796 797 798
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
799
        params['bound_variation'] = 1
800
        selection.edit(params=params)
801
      if REQUEST is not None:
802 803 804
        return self._redirectToOriginalForm(REQUEST=REQUEST,
                                            form_id=form_id,
                                             query_string=query_string)
805

806 807
    security.declareProtected(ERP5Permissions.View, 'previousLanePage')
    def previousLanePage(self, uids=None, REQUEST=None, form_id=None, query_string=None):
808 809 810
      """
      Set previous graphic zoom in PlanningBox
      """
811 812
      if uids is None:
        uids = []
813 814 815 816 817
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
818
        params['bound_variation'] = -1
819 820 821 822 823
        selection.edit(params=params)
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST,
                                            form_id=form_id,
                                             query_string=query_string)
824

Jean-Paul Smets's avatar
Jean-Paul Smets committed
825
    security.declareProtected(ERP5Permissions.View, 'setDomainRoot')
826
    def setDomainRoot(self, REQUEST, form_id=None, query_string=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
827 828 829
      """
        Sets the root domain for the current selection
      """
830
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
831
      selection = self.getSelectionFor(selection_name, REQUEST)
832
      root_url = REQUEST.form.get('domain_root_url','portal_categories')
833
      selection.edit(domain_path=root_url, domain_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
834

835 836 837
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
838

839 840 841 842 843 844
    security.declareProtected(ERP5Permissions.View, 'setDomainRootFromParam')
    def setDomainRootFromParam(self, REQUEST, selection_name, domain_root):
      if REQUEST is None:
        return
      selection = self.getSelectionFor(selection_name, REQUEST)
      selection.edit(domain_path=domain_root, domain_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
845

846
    security.declareProtected(ERP5Permissions.View, 'unfoldDomain')
847
    def unfoldDomain(self, REQUEST, form_id=None, query_string=None):
848 849 850
      """
        Unfold domain for the current selection
      """
851
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
852
      selection = self.getSelectionFor(selection_name, REQUEST)
853 854
      domain_url = REQUEST.form.get('domain_url',None)
      domain_depth = REQUEST.form.get('domain_depth',0)
855 856
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
857
      if isinstance(domain_url, str):
858
        selection.edit(domain_list = domain_list + [domain_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
859

860 861 862
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
863

864
    security.declareProtected(ERP5Permissions.View, 'foldDomain')
865
    def foldDomain(self, REQUEST, form_id=None, query_string=None):
866 867 868
      """
        Fold domain for the current selection
      """
869
      selection_name = REQUEST.list_selection_name
870
      selection = self.getSelectionFor(selection_name, REQUEST)
871 872
      domain_url = REQUEST.form.get('domain_url',None)
      domain_depth = REQUEST.form.get('domain_depth',0)
873 874
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
875
      selection.edit(domain_list=[x for x in domain_list if x != domain_url])
876

877 878 879
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
880

881

Jean-Paul Smets's avatar
Jean-Paul Smets committed
882
    security.declareProtected(ERP5Permissions.View, 'setReportRoot')
883
    def setReportRoot(self, REQUEST, form_id=None, query_string=None):
884 885 886
      """
        Sets the root report for the current selection
      """
887
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
888
      selection = self.getSelectionFor(selection_name, REQUEST)
889
      root_url = REQUEST.form.get('report_root_url','portal_categories')
890
      selection.edit(report_path=root_url, report_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
891

892 893 894
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
895 896

    security.declareProtected(ERP5Permissions.View, 'unfoldReport')
897
    def unfoldReport(self, REQUEST, form_id=None, query_string=None):
898 899 900
      """
        Unfold report for the current selection
      """
901
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
902
      selection = self.getSelectionFor(selection_name, REQUEST)
903
      report_url = REQUEST.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
904
      if type(report_url) == type('a'):
905
        selection.edit(report_list=list(selection.getReportList()) + [report_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
906

907 908 909
      return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                          query_string=query_string,
                                          no_report_depth=True)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
910 911

    security.declareProtected(ERP5Permissions.View, 'foldReport')
912
    def foldReport(self, REQUEST, form_id=None, query_string=None):
913 914 915
      """
        Fold domain for the current selection
      """
916
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
917
      selection = self.getSelectionFor(selection_name, REQUEST)
918
      report_url = REQUEST.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
919
      if type(report_url) == type('a'):
920
        report_list = selection.getReportList()
921
        selection.edit(report_list=[x for x in report_list if x != report_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
922

923 924 925
      return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                          query_string=query_string,
                                          no_report_depth=True)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
926

927 928 929 930
    security.declareProtected(ERP5Permissions.View, 'getListboxDisplayMode')
    def getListboxDisplayMode(self, selection_name, REQUEST=None):
      if REQUEST is None:
        REQUEST = get_request()
931
      selection = self.getSelectionFor(selection_name, REQUEST)
932

933 934 935 936 937
      if getattr(selection, 'report_tree_mode', 0):
        return 'ReportTreeMode'
      elif getattr(selection, 'domain_tree_mode', 0):
        return 'DomainTreeMode'
      return 'FlatListMode'
938

Jean-Paul Smets's avatar
Jean-Paul Smets committed
939
    security.declareProtected(ERP5Permissions.View, 'setListboxDisplayMode')
940
    def setListboxDisplayMode(self, REQUEST, listbox_display_mode,
941 942
                              selection_name=None, redirect=0,
                              form_id=None, query_string=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
943
      """
944
        Toggle display of the listbox
Jean-Paul Smets's avatar
Jean-Paul Smets committed
945 946
      """
      request = REQUEST
947 948 949 950 951 952 953
      # XXX FIXME
      # Dirty fix: we must be able to change the display mode of a listbox
      # in form_view
      # But, form can have multiple listbox...
      # This need to be cleaned
      # Beware, this fix may break the report system...
      # and we don't have test for this
954 955
      # Possible fix: currently, display mode icon are implemented as
      # method. It could be easier to generate them as link (where we
956 957 958 959 960 961 962 963 964
      # can define explicitely parameters through the url).
      try:
        list_selection_name = request.list_selection_name
      except AttributeError:
        pass
      else:
        if list_selection_name is not None:
          selection_name = request.list_selection_name
      # Get the selection
Jean-Paul Smets's avatar
Jean-Paul Smets committed
965
      selection = self.getSelectionFor(selection_name, REQUEST)
966 967
      if selection is None:
        selection = Selection()
968
        self.setSelectionFor(selection_name, selection, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
969 970 971 972 973 974 975 976 977 978 979 980 981

      if listbox_display_mode == 'FlatListMode':
        flat_list_mode = 1
        domain_tree_mode = 0
        report_tree_mode = 0
      elif listbox_display_mode == 'DomainTreeMode':
        flat_list_mode = 0
        domain_tree_mode = 1
        report_tree_mode = 0
      elif listbox_display_mode == 'ReportTreeMode':
        flat_list_mode = 0
        domain_tree_mode = 0
        report_tree_mode = 1
982 983 984
      else:
        flat_list_mode = 0
        domain_tree_mode = 0
985
        report_tree_mode = 0
986

987 988 989
      selection.edit(flat_list_mode=flat_list_mode,
                     domain_tree_mode=domain_tree_mode,
                     report_tree_mode=report_tree_mode)
990
      # It is better to reset the query when changing the display mode.
991 992
      params = selection.getParams()
      if 'where_expression' in params: del params['where_expression']
993
      selection.edit(params=params)
994

995
      if redirect:
996 997 998
        return self._redirectToOriginalForm(REQUEST=request, form_id=form_id,
                                            query_string=query_string,
                                            no_reset=True)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
999 1000

    security.declareProtected(ERP5Permissions.View, 'setFlatListMode')
1001
    def setFlatListMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1002 1003 1004
      """
        Set display of the listbox to FlatList mode
      """
1005
      return self.setListboxDisplayMode(
1006
                       REQUEST=REQUEST, listbox_display_mode='FlatListMode',
1007
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1008 1009

    security.declareProtected(ERP5Permissions.View, 'setDomainTreeMode')
1010
    def setDomainTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1011 1012 1013
      """
         Set display of the listbox to DomainTree mode
      """
1014
      return self.setListboxDisplayMode(
1015
                       REQUEST=REQUEST, listbox_display_mode='DomainTreeMode',
1016
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1017 1018

    security.declareProtected(ERP5Permissions.View, 'setReportTreeMode')
1019
    def setReportTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1020 1021 1022
      """
        Set display of the listbox to ReportTree mode
      """
1023 1024 1025
      return self.setListboxDisplayMode(
                       REQUEST=REQUEST, listbox_display_mode='ReportTreeMode',
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1026

1027 1028 1029 1030 1031 1032
    security.declareProtected(ERP5Permissions.View, 'getSelectionSelectedValueList')
    def getSelectionSelectedValueList(self, selection_name, REQUEST=None, selection_method=None, context=None):
      """
        Get the list of values selected for 'selection_name'
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
1033 1034
      if selection is None:
        return []
1035
      return selection(method=selection_method, context=context, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1036

1037 1038 1039 1040 1041 1042
    security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedValueList')
    def getSelectionCheckedValueList(self, selection_name, REQUEST=None):
      """
        Get the list of values checked for 'selection_name'
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
1043 1044
      if selection is None:
        return []
1045
      uid_list = selection.getCheckedUids()
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
      value_list = self.portal_catalog.getObjectList(uid_list)
      return value_list

    security.declareProtected(ERP5Permissions.View, 'getSelectionValueList')
    def getSelectionValueList(self, selection_name, REQUEST=None, selection_method=None, context=None):
      """
        Get the list of values checked or selected for 'selection_name'
      """
      value_list = self.getSelectionCheckedValueList(selection_name, REQUEST=REQUEST)
      if len(value_list) == 0:
1056 1057
        value_list = self.getSelectionSelectedValueList(
                                            selection_name,
1058 1059
                                            REQUEST=REQUEST,
                                            selection_method=selection_method,
1060
                                            context=context)
1061
      return value_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1062

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1063 1064 1065
    security.declareProtected(ERP5Permissions.View, 'getSelectionUidList')
    def getSelectionUidList(self, selection_name, REQUEST=None, selection_method=None, context=None):
      """
1066
        Get the list of uids checked or selected for 'selection_name'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1067
      """
1068
      return [x.getObject().getUid() for x in self.getSelectionValueList(selection_name, REQUEST=REQUEST, selection_method=selection_method, context=context)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1069

Sebastien Robin's avatar
Sebastien Robin committed
1070 1071 1072 1073 1074
    security.declareProtected(ERP5Permissions.View, 'selectionHasChanged')
    def selectionHasChanged(self, md5_string, object_uid_list):
      """
        We want to be sure that the selection did not change
      """
1075
      # XXX To avoid the difference of the string representations of int and long,
1076
      # convert each element to a string.
1077 1078 1079 1080
      object_uid_list = [str(x) for x in object_uid_list]
      object_uid_list.sort()
      new_md5_string = md5.new(str(object_uid_list)).hexdigest()
      return md5_string != new_md5_string
Sebastien Robin's avatar
Sebastien Robin committed
1081

Sebastien Robin's avatar
Sebastien Robin committed
1082

1083
    # Related document searching
1084
    def viewSearchRelatedDocumentDialog(self, index, form_id,
1085
                                        REQUEST=None, sub_index=None, **kw):
1086
      """
1087 1088
      Returns a search related document dialog
      A set of forwarders us defined to circumvent limitations of HTML
1089
      """
Romain Courteaud's avatar
Romain Courteaud committed
1090 1091
      if sub_index != None:
        REQUEST.form['sub_index'] = sub_index
1092
      object_path = REQUEST.form['object_path']
1093
      # Find the object which needs to be updated
1094
      o = self.restrictedTraverse(object_path)
1095
      # Find the field which was clicked on
1096
      # Important to get from the object instead of self
1097
      form = getattr(o, form_id)
1098
      field = None
1099 1100
      # Search the correct field
      relation_field_found = 0
1101
      relation_index = 0
1102
      # XXX may be should support another parameter,
1103
      for field in form.get_fields(include_disabled=0):
1104 1105
        if field.get_value('editable', REQUEST=REQUEST):
          try:
1106 1107
           field.get_value('is_relation_field')
          except KeyError:
1108
            pass
1109
          else:
1110 1111 1112 1113 1114
            if index == relation_index:
              relation_field_found = 1
              break
            else:
              relation_index += 1
1115
      if not relation_field_found:
1116
        # We didn't find the field...
1117
        raise SelectionError, "SelectionTool: can not find the relation" \
1118
                              " field %s" % index
1119 1120 1121 1122
      else:
        # Field found
        field_key = field.generate_field_key()
        field_value = REQUEST.form[field_key]
1123 1124
        dialog_id = field.get_value('relation_form_id') or \
                                                   'Base_viewRelatedObjectList'
1125
        redirect_form = getattr(o, dialog_id)
1126 1127 1128 1129 1130 1131 1132 1133
        # XXX Hardcoded listbox field
        selection_name = redirect_form.listbox.get_value('selection_name')
        # Reset current selection
        self.portal_selections.setSelectionFor(selection_name, None)


        if (field.get_value('is_multi_relation_field')) and \
           (sub_index is None):
1134 1135 1136 1137
          # user click on the wheel, not on the validation button
          # we need to facilitate user search

          # first: store current field value in the selection
1138
          base_category = field.get_value('base_category')
1139

1140 1141 1142 1143 1144 1145
          property_get_related_uid_method_name = \
            "get%sUidList" % ''.join(['%s%s' % (x[0].upper(), x[1:]) \
                                      for x in base_category.split('_')])
          current_uid_list = getattr(o, property_get_related_uid_method_name)\
                               (portal_type=[x[0] for x in \
                                  field.get_value('portal_type')])
Romain Courteaud's avatar
Romain Courteaud committed
1146 1147 1148
          # Checked current uid
          kw ={}
          kw[field.get_value('catalog_index')] = field_value
1149
          self.portal_selections.setSelectionParamsFor(selection_name,
1150 1151
                                                       kw.copy())
          self.portal_selections.setSelectionCheckedUidsFor(
1152
                                             selection_name,
1153
                                             current_uid_list)
1154
          field_value = str(field_value).splitlines()
1155 1156 1157 1158 1159
          # Prevent displaying useless empty list or list with only one element
          if not field_value:
            field_value = ''
          if len(field_value) == 1:
            field_value = field_value[0]
1160 1161
          if len(field_value) > 1 and isinstance(field_value, type([])):
            field_value = ' OR '.join(field_value)
1162
          REQUEST.form[field_key] = field_value
1163
          portal_status_message = translateString("Please select one (or more) object.")
1164
        else:
1165
          portal_status_message = translateString("Please select one object.")
1166 1167


1168 1169
        # Save the current REQUEST form
        # We can't put FileUpload instances because we can't pickle them
1170 1171 1172 1173
        saved_form_data = {}
        for key, value in REQUEST.form.items():
          if not isinstance(value, FileUpload):
              saved_form_data[key] = value
1174

1175 1176
        base_category = None
        kw = {}
1177
        kw['dialog_id'] = dialog_id
1178 1179 1180 1181 1182 1183 1184 1185 1186
        kw['selection_name'] = selection_name
        kw['selection_index'] = 0 # We start on the first page
        kw['field_id'] = field.id
        parameter_list = field.get_value('parameter_list')
        if len(parameter_list) > 0:
          for k,v in parameter_list:
            kw[k] = v
        kw['reset'] = 0
        kw['base_category'] = field.get_value( 'base_category')
1187
        kw['form_id'] = form_id
1188 1189
        kw[field.get_value('catalog_index')] = field_value
        kw['portal_status_message'] = portal_status_message
1190
        kw['saved_form_data'] = saved_form_data
1191
        kw['ignore_layout'] = int(REQUEST.get('ignore_layout', 0))
1192 1193 1194
        # remove ignore_layout parameter from cancel_url otherwise we
        # will have two ignore_layout parameters after clicking cancel
        # button.
1195 1196 1197
        split_referer = list(urlsplit(REQUEST.get('HTTP_REFERER')))
        split_referer[3] = '&'.join([x for x in \
                                     split_referer[3].split('&') \
1198
                                     if not re.match('^ignore_layout[:=]', x)])
1199
        kw['cancel_url'] = urlunsplit(split_referer)
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209
        proxy_listbox_ids = field.get_value('proxy_listbox_ids')
        REQUEST.set('proxy_listbox_ids', proxy_listbox_ids)
        if len(proxy_listbox_ids) > 0:
          REQUEST.set('proxy_listbox_id', proxy_listbox_ids[0][0])
        else:
          REQUEST.set('proxy_listbox_id', \
                       "Base_viewRelatedObjectListBase/listbox")

        # Empty the selection (uid)
1210 1211
        REQUEST.form = kw # New request form
        # Define new HTTP_REFERER
Romain Courteaud's avatar
Romain Courteaud committed
1212
        REQUEST.HTTP_REFERER = '%s/%s' % (o.absolute_url(),
1213
                                          dialog_id)
1214 1215 1216 1217 1218

        # If we are called from a Web Site, we should return
        # in the context of the Web Section
        if self.getApplicableLayout() is not None:
          return getattr(o.__of__(self.getWebSectionValue()), dialog_id)(REQUEST=REQUEST)
1219
        # Return the search dialog
1220
        return getattr(o, dialog_id)(REQUEST=REQUEST)
1221

1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
    security.declarePublic('buildSQLJoinExpressionFromDomainSelection')
    def buildSQLJoinExpressionFromDomainSelection(self, selection_domain,
                                                  domain_id=None,
                                                  exclude_domain_id=None,
                                                  category_table_alias='category'):
      if isinstance(selection_domain, DomainSelection):
        warnings.warn("To pass a DomainSelection instance is deprecated.\n"
                      "Please use a domain dict instead.",
                      DeprecationWarning)
      else:
        selection_domain = DomainSelection(selection_domain).__of__(self)
1233 1234
      return selection_domain.asSQLJoinExpression(
          category_table_alias=category_table_alias)
1235 1236 1237

    security.declarePublic('buildSQLExpressionFromDomainSelection')
    def buildSQLExpressionFromDomainSelection(self, selection_domain,
1238
                                              table_map=None, domain_id=None,
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
                                              exclude_domain_id=None,
                                              strict_membership=0,
                                              join_table="catalog",
                                              join_column="uid",
                                              base_category=None,
                                              category_table_alias='category'):
      if isinstance(selection_domain, DomainSelection):
        warnings.warn("To pass a DomainSelection instance is deprecated.\n"
                      "Please use a domain dict instead.",
                      DeprecationWarning)
      else:
        selection_domain = DomainSelection(selection_domain).__of__(self)
1251 1252 1253 1254 1255 1256
      return selection_domain.asSQLExpression(
          strict_membership = strict_membership,
          join_table=join_table,
          join_column=join_column,
          base_category=base_category,
          category_table_alias = category_table_alias)
1257

1258 1259
    def _aq_dynamic(self, name):
      """
1260
        Generate viewSearchRelatedDocumentDialog0,
1261
                 viewSearchRelatedDocumentDialog1,... if necessary
1262 1263 1264
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
1265 1266 1267
        DYNAMIC_METHOD_NAME = 'viewSearchRelatedDocumentDialog'
        method_name_length = len(DYNAMIC_METHOD_NAME)

1268
        zope_security = '__roles__'
1269
        if (name[:method_name_length] == DYNAMIC_METHOD_NAME) and \
1270
           (name[-len(zope_security):] != zope_security):
1271
          method_count_string_list = name[method_name_length:].split('_')
1272 1273 1274 1275
          method_count_string = method_count_string_list[0]
          # be sure that method name is correct
          try:
            method_count = string.atoi(method_count_string)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1276
          except TypeError:
1277
            return aq_base_name
1278
          else:
1279 1280 1281
            if len(method_count_string_list) > 1:
              # be sure that method name is correct
              try:
Romain Courteaud's avatar
Romain Courteaud committed
1282
                sub_index = string.atoi(method_count_string_list[1])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1283
              except TypeError:
1284 1285
                return aq_base_name
            else:
Romain Courteaud's avatar
Romain Courteaud committed
1286
              sub_index = None
1287

1288
            # generate dynamicaly needed forwarder methods
1289
            def viewSearchRelatedDocumentDialogWrapper(self, form_id,
1290
                                                       REQUEST=None, **kw):
1291 1292 1293
              """
                viewSearchRelatedDocumentDialog Wrapper
              """
1294 1295
#               LOG('SelectionTool.viewSearchRelatedDocumentDialogWrapper, kw',
#                   0, kw)
1296
              return self.viewSearchRelatedDocumentDialog(
1297
                                   method_count, form_id,
1298
                                   REQUEST=REQUEST, sub_index=sub_index, **kw)
1299
            setattr(self.__class__, name,
1300
                    viewSearchRelatedDocumentDialogWrapper)
1301 1302

            klass = aq_base(self).__class__
1303 1304 1305 1306
            security_property_id = '%s__roles__' % (name, )
            # Declare method as public
            setattr(klass, security_property_id, None)

1307 1308 1309 1310
            return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
1311

1312 1313
    def _getUserId(self):
      return self.portal_membership.getAuthenticatedMember().getUserName()
1314 1315
      # XXX It would be good to add somthing here
      # So that 2 anonymous users do not share the same selection
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334

    def _getSelectionFromContainer(self, selection_name):
      user_id = self._getUserId()
      if user_id is None: return None
      if self.isMemcachedUsed():
        return self._getMemcachedContainer().get('%s-%s' %
                                                 (user_id, selection_name))
      else:
        return self._getPersistentContainer(user_id).get(selection_name,
                                                         None)

    def _setSelectionToContainer(self, selection_name, selection):
      user_id = self._getUserId()
      if user_id is None: return
      if self.isMemcachedUsed():
        self._getMemcachedContainer().set('%s-%s' % (user_id, selection_name), aq_base(selection))
      else:
        self._getPersistentContainer(user_id)[selection_name] = aq_base(selection)

1335 1336 1337 1338 1339 1340 1341 1342
    def _deleteSelectionFromContainer(self, selection_name):
      user_id = self._getUserId()
      if user_id is None: return None
      if self.isMemcachedUsed():
        del(self._getMemcachedContainer()['%s-%s' % (user_id, selection_name)])
      else:
        del(self._getPersistentContainer(user_id)[selection_name])

1343
    def _deleteGlobalSelectionFromContainer(self, selection_name):
1344
      if not self.isMemcachedUsed():
1345 1346 1347 1348 1349 1350
        if getattr(aq_base(self), 'selection_data', None) is not None:
          for user_id in self.selection_data.keys():
            mapping = self._getPersistentContainer(user_id)
            if mapping.has_key(selection_name):
              del(mapping[selection_name])

1351 1352 1353 1354 1355 1356 1357 1358 1359
    def _getSelectionNameListFromContainer(self):
      if self.isMemcachedUsed():
        return []
      else:
        user_id = self._getUserId()
        if user_id is None: return []
        return self._getPersistentContainer(user_id).keys()

    def _getMemcachedContainer(self):
1360
      value = getattr(aq_base(self), '_v_selection_data', None)
1361
      if value is None:
1362 1363 1364 1365
        plugin_path = self.getStorage()
        value = self.getPortalObject().\
                portal_memcached.getMemcachedDict(key_prefix='selection_tool',
                                                  plugin_path=plugin_path)
1366 1367 1368 1369
        setattr(self, '_v_selection_data', value)
      return value

    def _getPersistentContainer(self, user_id):
1370
      if getattr(aq_base(self), 'selection_data', None) is None:
1371 1372 1373 1374 1375
        self.selection_data = PersistentMapping()
      if not self.selection_data.has_key(user_id):
        self.selection_data[user_id] = SelectionPersistentMapping()
      return self.selection_data[user_id]

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1376
InitializeClass( SelectionTool )
1377

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

class SelectionPersistentMapping(PersistentMapping):
  """A conflict-free PersistentMapping.

  Like selection objects, the purpose is to only prevent restarting
  transactions.
  """
  def _p_independent(self) :
    return 1

  def _p_resolveConflict(self, oldState, savedState, newState):
    # update keys that only savedState has
    oldState = newState
    # dict returned by PersistentMapping.__getstate__ contains the data
1392
    # under '_container' key in zope 2.7 and 'data' in zope 2.8
Kazuhiko Shiozaki's avatar
typo.  
Kazuhiko Shiozaki committed
1393
    if 'data' in oldState:
1394 1395 1396
      oldState['data'].update(savedState['data'])
    else:
      oldState['_container'].update(savedState['_container'])
1397 1398 1399
    return oldState


1400 1401 1402 1403 1404 1405 1406 1407
class TreeListLine:
  def __init__(self,object,is_pure_summary,depth, is_open,select_domain_dict,exception_uid_list):
    self.object=object
    self.is_pure_summary=is_pure_summary
    self.depth=depth
    self.is_open=is_open
    self.select_domain_dict=select_domain_dict
    self.exception_uid_list=exception_uid_list
1408

1409 1410
  def getObject(self):
    return self.object
1411

1412 1413
  def getIsPureSummary(self):
    return self.is_pure_summary
1414

1415 1416
  def getDepth(self):
    return self.depth
1417

1418 1419
  def getIsOpen(self):
    return self.is_open
1420 1421

  def getSelectDomainDict(self):
1422
    return self.select_domain_dict
1423

1424 1425
  def getExceptionUidList(self):
    return self.exception_uid_list
1426

1427

1428
def makeTreeList(here, form, root_dict, report_path, base_category,
Nicolas Delaby's avatar
Nicolas Delaby committed
1429 1430 1431
                 depth, unfolded_list, form_id, selection_name,
                 report_depth, is_report_opened=1, list_method=None,
                 filtered_portal_types=[] ,sort_on = (('id', 'ASC'),)):
1432 1433 1434 1435 1436
  """
    (object, is_pure_summary, depth, is_open, select_domain_dict)

    select_domain_dict is a dictionary of  associative list of (id, domain)
  """
1437 1438
  if isinstance(report_path, str):
    report_path = report_path.split('/')
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453

  portal_categories = getattr(form, 'portal_categories', None)
  portal_domains = getattr(form, 'portal_domains', None)
  portal_object = form.portal_url.getPortalObject()
  if len(report_path):
    base_category = report_path[0]

  if root_dict is None:
    root_dict = {}

  is_empty_level = 1
  while is_empty_level:
    if not root_dict.has_key(base_category):
      root = None
      if portal_categories is not None:
1454
        if portal_categories._getOb(base_category, None) is not None:
1455 1456 1457 1458
          if base_category == 'parent':
            # parent has a special treatment
            root = root_dict[base_category] = root_dict[None] = here
            report_path = report_path[1:]
1459
          else:
1460 1461
            root = root_dict[base_category] = root_dict[None] = \
                                               portal_categories[base_category]
1462 1463
            report_path = report_path[1:]
      if root is None and portal_domains is not None:
1464 1465 1466
        if portal_domains._getOb(base_category, None) is not None:
          root = root_dict[base_category] = root_dict[None] = \
                                               portal_domains[base_category]
1467 1468 1469
          report_path = report_path[1:]
      if root is None:
        try:
1470 1471
          root = root_dict[None] = \
              portal_object.unrestrictedTraverse(report_path)
1472
        except KeyError:
1473
          LOG('SelectionTool', INFO, "Not found %s" % str(report_path))
1474 1475 1476 1477 1478
          root = None
        report_path = ()
    else:
      root = root_dict[None] = root_dict[base_category]
      report_path = report_path[1:]
1479 1480
    is_empty_level = (root is not None) and \
        (root.objectCount() == 0) and (len(report_path) != 0)
1481
    if is_empty_level:
1482
      base_category = report_path[0]
1483 1484

  tree_list = []
1485
  if root is None:
1486
    return tree_list
1487

1488
  if base_category == 'parent':
1489 1490 1491 1492 1493
    # Use searchFolder as default
    if list_method is None:
      if hasattr(aq_base(root), 'objectValues'):
        # If this is a folder, try to browse the hierarchy
        object_list = root.searchFolder(sort_on=sort_on)
1494
    else:
1495
      if filtered_portal_types not in [[],None,'']:
1496 1497
        object_list = list_method(portal_type=filtered_portal_types,
                                  sort_on=sort_on)
1498
      else:
1499
        object_list = list_method(sort_on=sort_on)
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
    for zo in object_list:
      o = zo.getObject()
      if o is not None:
        new_root_dict = root_dict.copy()
        new_root_dict[None] = new_root_dict[base_category] = o

        selection_domain = DomainSelection(domain_dict = new_root_dict)
        if (report_depth is not None and depth <= (report_depth - 1)) or \
                                          o.getRelativeUrl() in unfolded_list:
          exception_uid_list = [] # Object we do not want to display

          for sub_zo in o.searchFolder(sort_on=sort_on):
            sub_o = sub_zo.getObject()
            if sub_o is not None and hasattr(aq_base(root), 'objectValues'):
              exception_uid_list.append(sub_o.getUid())
          # Summary (open)
1516
          tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, exception_uid_list)]
1517 1518
          if is_report_opened :
            # List (contents, closed, must be strict selection)
1519 1520 1521
            tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, exception_uid_list)]

          tree_list += makeTreeList(here, form, new_root_dict, report_path,
1522
      		    base_category, depth + 1, unfolded_list, form_id,
1523
      		    selection_name, report_depth,
1524 1525 1526
      		    is_report_opened=is_report_opened, sort_on=sort_on)
        else:
          tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, ())] # Summary (closed)
1527
  else:
1528 1529 1530 1531 1532 1533
    # process to recover objects in case a generation script is used
    if hasattr(root,'getChildDomainValueList'):
      oblist = root.getChildDomainValueList(root,depth=depth)
    else:
      oblist = root.objectValues()
    for o in oblist:
1534 1535 1536 1537 1538 1539 1540
      new_root_dict = root_dict.copy()
      new_root_dict[None] = new_root_dict[base_category] = o
      selection_domain = DomainSelection(domain_dict = new_root_dict)
      if (report_depth is not None and depth <= (report_depth - 1)) or o.getRelativeUrl() in unfolded_list:
        tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, None)] # Summary (open)
        if is_report_opened :
          tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, None)] # List (contents, closed, must be strict selection)
1541 1542
        tree_list += makeTreeList(here, form, new_root_dict, report_path, base_category, depth + 1,
            unfolded_list, form_id, selection_name, report_depth,
1543 1544 1545 1546
            is_report_opened=is_report_opened, sort_on=sort_on)
      else:

        tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, None)] # Summary (closed)
1547

1548 1549
  return tree_list

1550
# Automaticaly add wrappers on Folder so it can access portal_selections.
1551
# Cannot be done in ERP5Type/Document/Folder.py because ERP5Type must not
1552
# depend on ERP5Form.
1553 1554

from Products.CMFCore.utils import getToolByName
1555
from Products.ERP5Type.Core.Folder import FolderMixIn
1556 1557
from ZPublisher.mapply import mapply

1558 1559
method_id_filter_list = [x for x in FolderMixIn.__dict__ if callable(getattr(FolderMixIn, x))]
candidate_method_id_list = [x for x in SelectionTool.__dict__ if callable(getattr(SelectionTool, x)) and not x.startswith('_') and not x.endswith('__roles__') and x not in method_id_filter_list]
1560

1561 1562 1563
# Monkey patch FolderMixIn with SelectionTool methods
#   kept here for compatibility with previous implementations
#   of Listbox HTML renderer. See bellow new implementation
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
for property_id in candidate_method_id_list:
  def portal_selection_wrapper(self, wrapper_property_id=property_id, *args, **kw):
    """
      Wrapper method for SelectionTool.
    """
    portal_selection = getToolByName(self, 'portal_selections')
    request = self.REQUEST
    method = getattr(portal_selection, wrapper_property_id)
    return mapply(method, positional=args, keyword=request,
                  context=self, bind=1)
1574
  setattr(FolderMixIn, property_id, portal_selection_wrapper)
1575 1576 1577
  security_property_id = '%s__roles__' % (property_id, )
  security_property = getattr(SelectionTool, security_property_id, None)
  if security_property is not None:
1578
    setattr(FolderMixIn, security_property_id, security_property)
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607

def createFolderMixInPageSelectionMethod(listbox_id):
  """
  This method must be called by listbox at rendering time.
  It dynamically creates methods on FolderMixIn in line
  with the naming of the listbox field. Generated method
  are able to convert request parameters in order to
  mimic the API of a listbox with ID "listbox". This
  approach was required for example to implement
  multiple multi-page listboxes in view mode. It also
  opens the way towards multiple editable listboxes in the same
  page although this is something which we can not recommend.
  """
  # Immediately return in the method already exists
  test_method_id = "%s_nextPage" % listbox_id
  if hasattr(FolderMixIn, test_method_id):
    return
  # Monkey patch FolderMixIn
  for property_id in candidate_method_id_list:
    def portal_selection_wrapper(self, wrapper_listbox_id=listbox_id,
                                       wrapper_property_id=property_id, *args, **kw):
      """
        Wrapper method for SelectionTool.
      """
      portal_selection = getToolByName(self, 'portal_selections')
      request = self.REQUEST
      selection_name_property_id = "%s_list_selection_name" % listbox_id
      listbox_uid_property_id = "%s_uid" % listbox_id
      list_start_property_id = "%s_list_start" % listbox_id
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1608
      page_start_property_id = "%s_page_start" % listbox_id
1609 1610
      # Rename request parameters
      if request.has_key(selection_name_property_id):
1611
        request.form['list_selection_name'] = request[selection_name_property_id]
1612 1613 1614 1615
      if request.has_key(listbox_uid_property_id):
        request.form['listbox_uid'] = request[listbox_uid_property_id]
      if request.has_key(list_start_property_id):
        request.form['list_start'] = request[list_start_property_id]
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1616 1617
      if request.has_key(page_start_property_id):
        request.form['page_start'] = request[page_start_property_id]
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
      # Call the wrapper
      method = getattr(portal_selection, wrapper_property_id)
      return mapply(method, positional=args, keyword=request,
                    context=self, bind=1)
    new_property_id = "%s_%s" % (listbox_id, property_id)
    setattr(FolderMixIn, new_property_id, portal_selection_wrapper)
    security_property_id = '%s__roles__' % (property_id, )
    security_property = getattr(SelectionTool, security_property_id, None)
    if security_property is not None:
      new_security_property_id = '%s__roles__' % (new_property_id, )
1628
      setattr(FolderMixIn, new_security_property_id, security_property)