SelectionTool.py 68.8 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002,2007 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@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.
#
##############################################################################

29 30
"""
  ERP5 portal_selection tool.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
"""

33
from OFS.Traversable import NotFound
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36
from OFS.SimpleItem import SimpleItem
from Products.CMFCore.utils import UniqueObject
from Globals import InitializeClass, DTMLFile, PersistentMapping, get_request
37
from ZTUtils import make_query
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from AccessControl import ClassSecurityInfo
39
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41
from Products.ERP5Type import Permissions as ERP5Permissions
from Products.ERP5Form import _dtmldir
42
from Selection import Selection, DomainSelection
43
from ZPublisher.HTTPRequest import FileUpload
Sebastien Robin's avatar
Sebastien Robin committed
44 45
from email.MIMEBase import MIMEBase
from email import Encoders
Sebastien Robin's avatar
Sebastien Robin committed
46
from copy import copy
47
from DateTime import DateTime
Sebastien Robin's avatar
Sebastien Robin committed
48
import md5
Sebastien Robin's avatar
Sebastien Robin committed
49 50 51
import pickle
import hmac
import random
52
import re
53
import string
54
from zLOG import LOG, WARNING, INFO
55
from Acquisition import Implicit, aq_base
56
from Products.ERP5Type.Message import Message
57
import warnings
58

59 60
_MARKER = []

Jean-Paul Smets's avatar
Jean-Paul Smets committed
61 62 63
class SelectionError( Exception ):
    pass

64
class SelectionTool( BaseTool, UniqueObject, SimpleItem ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65 66 67 68 69 70 71 72
    """
      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'
73
    portal_type     = 'Selection Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76 77 78 79 80
    security = ClassSecurityInfo()

    #
    #   ZMI methods
    #
    manage_options = ( ( { 'label'      : 'Overview'
                         , 'action'     : 'manage_overview'
81 82 83
                         },
                         { 'label'      : 'View Selections'
                         , 'action'     : 'manage_view_selections'
84 85 86
                         },
                         { 'label'      : 'Configure'
                         , 'action'     : 'manage_configure'
87
                         } ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
88 89 90

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

93 94 95
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_view_selections' )
    manage_view_selections = DTMLFile( 'SelectionTool_manageViewSelections', _dtmldir )
96

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_configure' )
    manage_configure = DTMLFile( 'SelectionTool_configure', _dtmldir )

    # storages of SelectionTool
    storage_list = ('Persistent Mapping', 'Memcached Tool')

    security.declareProtected( ERP5Permissions.ManagePortal, 'setStorage')
    def setStorage(self, value, RESPONSE=None):
      """
        Set the storage of Selection Tool.
      """
      if value in self.storage_list:
        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()))

    def getStorage(self, default=None):
      if default is None:
        default = self.storage_list[0]
119
      storage = getattr(aq_base(self), 'storage', default)
120
      if storage is not default and storage not in self.storage_list:
Jérome Perrin's avatar
Jérome Perrin committed
121
        storage = self.storage_list[0]
122 123 124 125 126
      return storage

    def isMemcachedUsed(self):
      return self.getStorage() == 'Memcached Tool'
      
Vincent Pelletier's avatar
Vincent Pelletier committed
127 128
    def _redirectToOriginalForm(self, REQUEST=None, form_id=None, dialog_id=None,
                                query_string=None,
129
                                no_reset=False, no_report_depth=False):
Vincent Pelletier's avatar
Vincent Pelletier committed
130 131
      """Redirect to the original form or dialog, using the information given
         as parameters.
132 133
         (Actually does not redirect  in the HTTP meaning because of URL
         limitation problems.)
Vincent Pelletier's avatar
Vincent Pelletier committed
134 135 136

         DEPRECATED parameters :
         query_string is used to transmit parameters from caller to callee.
137
         If no_reset is True, replace reset parameters with noreset.
Vincent Pelletier's avatar
Vincent Pelletier committed
138 139
         If no_report_depth is True, replace report_depth parameters with
         noreport_depth.
140 141 142 143
      """
      if REQUEST is None:
        return

144 145 146 147 148 149
      if no_reset and REQUEST.form.has_key('reset'):
        REQUEST.form['noreset'] = REQUEST.form['reset'] # Kept for compatibility - might no be used anymore
        del REQUEST.form['reset']
      if no_report_depth and REQUEST.form.has_key('report_depth'):
        REQUEST.form['noreport_depth'] = REQUEST.form['report_depth'] # Kept for compatibility - might no be used anymore
        del REQUEST.form['report_depth']
Vincent Pelletier's avatar
Vincent Pelletier committed
150

151
      if query_string is not None:
152 153
        warnings.warn('DEPRECATED: _redirectToOriginalForm got called with a query_string. The variables must be passed in REQUEST.form.',
                      DeprecationWarning)
154
      context = REQUEST['PARENTS'][0]
Vincent Pelletier's avatar
Vincent Pelletier committed
155
      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
156
      return getattr(context, form_id)()
157

158 159
    security.declareProtected(ERP5Permissions.View, 'getSelectionNameList')
    def getSelectionNameList(self, context=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160 161 162
      """
        Returns the selection names of the current user.
      """
163 164
      if self.isMemcachedUsed():
        return []
165
      return self._getSelectionNameListFromContainer()
166

167 168 169 170 171 172 173 174
    # 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)

175 176 177 178 179 180 181 182
    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
183 184 185 186 187
    security.declareProtected(ERP5Permissions.View, 'getSelectionFor')
    def getSelectionFor(self, selection_name, REQUEST=None):
      """
        Returns the selection instance for a given selection_name
      """
188 189 190 191 192
      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)
193

194 195 196
    def __getitem__(self, key):
        return self.getSelectionParamsFor(key)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
197 198 199 200 201
    security.declareProtected(ERP5Permissions.View, 'setSelectionFor')
    def setSelectionFor(self, selection_name, selection_object, REQUEST=None):
      """
        Sets the selection instance for a given selection_name
      """
202 203 204
      if selection_object != None:
        # Set the name so that this selection itself can get its own name.
        selection_object.edit(name = selection_name)
205

206 207
      if self.getSelectionFor(selection_name) != selection_object:
        self._setSelectionToContainer(selection_name, selection_object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
208

209 210
    security.declareProtected(ERP5Permissions.View, 'getSelectionParamsFor')
    def getSelectionParamsFor(self, selection_name, params=None, REQUEST=None):
211 212 213
      """
        Returns the params in the selection
      """
214
      if params is None: params = {}
215 216
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
217 218
        if len(selection.params) > 0:
          return selection.getParams()
219 220 221 222
        else:
          return params
      else:
        return params
223 224

    # backward compatibility
225 226
    security.declareProtected(ERP5Permissions.View, 'getSelectionParams')
    getSelectionParams = getSelectionParamsFor
227

Jean-Paul Smets's avatar
Jean-Paul Smets committed
228 229 230 231 232 233
    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)
234
      if selection_object is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
235 236 237 238 239
        selection_object.edit(params=params)
      else:
        selection_object = Selection(params=params)
      self.setSelectionFor(selection_name, selection_object, REQUEST)

240
    security.declareProtected(ERP5Permissions.View, 'getSelectionDomainDictFor')
241 242 243 244 245 246 247 248 249 250 251
    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 {}

252
    security.declareProtected(ERP5Permissions.View, 'getSelectionReportDictFor')
253 254 255 256 257 258 259 260 261 262 263
    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
264 265 266
    security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor')
    def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None):
      """
267
        Sets the checked uids for a given selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
268 269 270 271 272 273 274 275
      """
      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)

276
    security.declareProtected(ERP5Permissions.View, 'updateSelectionCheckedUidList')
277 278
    def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None):
      """
279 280
        Updates the unchecked uids(listbox_uids) and checked uids (uids)
        for a given selection_name
281 282 283 284 285 286 287 288
      """
      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)

289 290 291
    security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor')
    def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None):
      """
292
        Returns the checked uids for a given selection_name
293 294 295
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
296
        #return selection_object.selection_checked_uids
297
        return selection_object.getCheckedUids()
298 299 300
      return []

    security.declareProtected(ERP5Permissions.View, 'checkAll')
301 302
    def checkAll(self, selection_name, listbox_uid=[], REQUEST=None,
                 query_string=None, form_id=None):
303
      """
304
        Check uids in a given listbox_uid list for a given selection_name
305 306 307 308
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
        selection_uid_dict = {}
309
        for uid in selection_object.checked_uids:
310 311
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
312 313
          try:
            selection_uid_dict[int(uid)] = 1
314
          except ValueError:
315
            selection_uid_dict[uid] = 1
316
        self.setSelectionCheckedUidsFor(selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
317 318 319
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string, no_reset=True)
320 321

    security.declareProtected(ERP5Permissions.View, 'uncheckAll')
322 323
    def uncheckAll(self, selection_name, listbox_uid=[], REQUEST=None,
                   query_string=None, form_id=None):
324
      """
325
        Uncheck uids in a given listbox_uid list for a given selection_name
326 327 328 329
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
        selection_uid_dict = {}
330
        for uid in selection_object.checked_uids:
331 332
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
333 334 335
          try:
            if selection_uid_dict.has_key(int(uid)): del selection_uid_dict[int(uid)]
          except ValueError:
336
            if selection_uid_dict.has_key(uid): del selection_uid_dict[uid]
337
        self.setSelectionCheckedUidsFor(selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
338 339 340
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string, no_reset=True)
341

Jean-Paul Smets's avatar
Jean-Paul Smets committed
342 343 344 345 346 347 348
    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:
349
        return selection.getListUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
350 351
      else:
        return None
352

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
    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
370

371
    security.declareProtected(ERP5Permissions.View, 'getSelectionInvertModeUidListFor')
372 373 374 375 376 377 378 379
    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

380 381 382 383 384 385 386 387 388
    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
389 390 391 392 393 394 395
    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:
396
        selection.edit(invert_mode=1, uids=selection_uids, checked_uids=selection_uids)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
397 398

    security.declareProtected(ERP5Permissions.View, 'setSelectionToAll')
399 400
    def setSelectionToAll(self, selection_name, REQUEST=None,
                          reset_domain_tree=False, reset_report_tree=False):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
401 402 403 404 405
      """
        Resets the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
406
        selection.edit(invert_mode=0, params={}, checked_uids=[], report_opened=1)
407
        if reset_domain_tree:
408
          selection.edit(domain=None, domain_path=None, domain_list=None)
409
        if reset_report_tree:
410
          selection.edit(report=None, report_path=None, report_list=None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
411 412 413 414 415 416 417 418 419 420 421

    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')
422 423
    def setSelectionQuickSortOrder(self, selection_name, sort_on, REQUEST=None,
                                   query_string=None, form_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
      """
        Defines the sort order of the selection directly from the listbox
        In this method, sort_on is just a string that comes from url
      """
      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)

448 449 450
      if REQUEST is not None:
        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
451 452 453 454 455 456 457 458

    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 ()
459
      return selection.sort_on
Jean-Paul Smets's avatar
Jean-Paul Smets committed
460 461 462 463 464 465 466 467 468 469

    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')
470
    def getSelectionColumns(self, selection_name, columns=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
471
      """
472 473
        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
474
      """
475
      if columns is None: columns = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476 477
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
478 479
        if len(selection.columns) > 0:
          return selection.columns
480
      return columns
Jean-Paul Smets's avatar
Jean-Paul Smets committed
481 482 483 484 485 486 487 488 489 490 491


    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')
492
    def getSelectionStats(self, selection_name, stats=_MARKER, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
493 494 495
      """
        Returns the stats in the selection
      """
496 497 498 499
      if stats is not _MARKER:
        default_stats = stats
      else:
        default_stats = [' '] * 6
Jean-Paul Smets's avatar
Jean-Paul Smets committed
500 501
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
502
        return getattr(aq_base(selection), 'stats', default_stats)
503
      return default_stats
Jean-Paul Smets's avatar
Jean-Paul Smets committed
504 505 506 507 508 509 510 511 512 513 514


    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:
515
        method = self.unrestrictedTraverse(selection.method_path)
516
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
517 518 519 520 521
        if len(selection_list):
          o = selection_list[0]
          url = o.absolute_url()
        else:
          url = REQUEST.getURL()  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
522
      else:
523
        url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
524 525 526 527 528 529
      url = '%s/%s?selection_index=%s&selection_name=%s' % (url, form_id, 0, selection_name)
      REQUEST.RESPONSE.redirect(url)

    security.declareProtected(ERP5Permissions.View, 'viewLast')
    def viewLast(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
      """
530
        Access last item in a selection
Jean-Paul Smets's avatar
Jean-Paul Smets committed
531 532 533 534 535
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
536
        method = self.unrestrictedTraverse(selection.method_path)
537
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
538 539 540 541 542
        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
543
      else:
544
        url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
545 546 547 548 549 550 551 552 553 554 555 556
      url = '%s/%s?selection_index=%s&selection_name=%s' % (url, form_id, -1, selection_name)
      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:
557
        method = self.unrestrictedTraverse(selection.method_path)
558
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
Aurel's avatar
Aurel committed
559
        if len(selection_list):
560 561 562 563
          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
564
      else:
565
        url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
566 567 568 569 570 571 572 573 574 575 576 577
      url = '%s/%s?selection_index=%s&selection_name=%s' % (url, form_id, int(selection_index) + 1, selection_name)
      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:
578
        method = self.unrestrictedTraverse(selection.method_path)
579
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
580 581 582 583 584
        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
585
      else:
586
        url = REQUEST.getURL()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
587 588 589 590 591
      url = '%s/%s?selection_index=%s&selection_name=%s' % (url, form_id, int(selection_index) - 1, selection_name)
      REQUEST.RESPONSE.redirect(url)


    # ListBox related methods
592 593

    security.declareProtected(ERP5Permissions.View, 'firstPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
594
    def firstPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
595 596 597 598
      """
        Access the first page of a list
      """
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
599 600 601 602
      selection = self.getSelectionFor(list_selection_name, REQUEST)
      REQUEST.form['list_start'] = 0
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
603 604

    security.declareProtected(ERP5Permissions.View, 'lastPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
605
    def lastPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
606 607 608 609
      """
        Access the last page of a list
      """
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
610
      selection = self.getSelectionFor(list_selection_name, REQUEST)
611 612 613 614 615 616
      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
Vincent Pelletier's avatar
Vincent Pelletier committed
617
      total_lines = REQUEST.form.get('total_size', BIG_INT)
618 619 620
      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))
Vincent Pelletier's avatar
Vincent Pelletier committed
621 622 623
      REQUEST.form['list_start'] = last_page_start
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
624

Jean-Paul Smets's avatar
Jean-Paul Smets committed
625
    security.declareProtected(ERP5Permissions.View, 'nextPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
626
    def nextPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
627 628 629
      """
        Access the next page of a list
      """
630
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
631
      selection = self.getSelectionFor(list_selection_name, REQUEST)
632
      params = selection.getParams()
Vincent Pelletier's avatar
Vincent Pelletier committed
633
      lines = params.get('list_lines', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
634
      start = params.get('list_start', 0)
Vincent Pelletier's avatar
Vincent Pelletier committed
635 636 637
      REQUEST.form['list_start'] = int(start) + int(lines)
      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
638 639

    security.declareProtected(ERP5Permissions.View, 'previousPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
640
    def previousPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
641 642 643
      """
        Access the previous page of a list
      """
644
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
645
      selection = self.getSelectionFor(list_selection_name, REQUEST)
646
      params = selection.getParams()
Vincent Pelletier's avatar
Vincent Pelletier committed
647
      lines = params.get('list_lines', 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
648
      start = params.get('list_start', 0)
Vincent Pelletier's avatar
Vincent Pelletier committed
649 650 651
      REQUEST.form['list_start'] = max(int(start) - int(lines), 0)
      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
652 653

    security.declareProtected(ERP5Permissions.View, 'setPage')
Vincent Pelletier's avatar
Vincent Pelletier committed
654
    def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None):
655
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
656
         Sets the current displayed page in a selection
657
      """
658
      if uids is None: uids = []
Vincent Pelletier's avatar
Vincent Pelletier committed
659 660 661 662 663 664
      selection = self.getSelectionFor(list_selection_name, REQUEST)
      params = selection.getParams()
      params['list_start'] = REQUEST.form.get('list_start', 0)
      selection.edit(params=params)
      self.uncheckAll(list_selection_name, listbox_uid)
      return self.checkAll(list_selection_name, uids, REQUEST=REQUEST, query_string=query_string)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
665

666 667
    # PlanningBox related methods
    security.declareProtected(ERP5Permissions.View, 'setZoomLevel')
668 669
    def setZoomLevel(self, uids=None, REQUEST=None, form_id=None,
                     query_string=None):
670 671 672
      """
      Set graphic zoom level in PlanningBox
      """
673 674
      if uids is None:
        uids = []
675 676 677 678 679
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
680 681 682 683 684 685 686
        zoom_level = request.form.get('zoom_level', None)
        if zoom_level is None:
          # If zoom_level is not defined try to 
          # use the last one from params
          zoom_level =  params.get('zoom_level', 1)

        # for keep compatibility with the old zoom        
687 688 689
        zoom_start = request.form.get('zoom_start',0)
        if zoom_level <= zoom_start:
          zoom_start = max(int(float(zoom_level)),1) - 1
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
          params['zoom_start'] = zoom_start   

        # XXX URL currently pass string parameter and not int
        # This is a dirty fix!
        # It should be fixed by cleaning the date zoom level
        # in a generic way
        zoom_level = int(zoom_level)
        zoom_begin = request.form.get('zoom_begin', None)
        #zoom_end = request.form.get('zoom_end', None)
        zoom_date_start = request.form.get('zoom_date_start', None)
        if zoom_date_start is not None:
          zoom_begin = zoom_date_start
        if zoom_begin is None:
          zoom_begin = params.get('zoom_begin', None)
        params['zoom_level'] = zoom_level
        # Calculating New zoom Dates Range.
        validate_method = getattr(self, 'planning_validate_date_list', None)
        date_range = validate_method(zoom_begin,zoom_level)
        params['from_date'] = params['zoom_begin'] = date_range[0]
        params['to_date'] = params['zoom_end'] = date_range[1]
        selection.edit(params=params)
711
      if REQUEST is not None:
712 713 714
        return self._redirectToOriginalForm(REQUEST=REQUEST,
                                            form_id=form_id,
                                            query_string=query_string)
715

716
    security.declareProtected(ERP5Permissions.View, 'setZoom')
717
    def setZoom(self, uids=None, REQUEST=None, form_id=None, query_string=None):
718 719
      """
      Set graphic zoom in PlanningBox
720
      """
721
      if uids is None: uids = []
722
      request = REQUEST
723 724 725 726
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
727
        zoom_start = request.form.get('zoom_start',0)
728
        params['zoom_start'] = zoom_start
729
        selection.edit(params= params)
730
      if REQUEST is not None:
731 732
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                           query_string=query_string)
733 734

    security.declareProtected(ERP5Permissions.View, 'nextZoom')
735
    def nextZoom(self, uids=None, REQUEST=None, form_id=None, query_string=None):
736 737 738
      """
      Set next graphic zoom start in PlanningBox
      """
739 740
      if uids is None:
        uids = []
741 742 743 744 745
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
746 747 748 749 750
        zoom_level =  params.get('zoom_level', 1)
        zoom_variation = + 1
        zoom_begin = request.form.get('zoom_begin', None)
        
        # for keep the compatibility
751
        zoom_start = params.get('zoom_start',0)
752
        params['zoom_start'] = int(zoom_start) + 1
753 754 755 756 757 758 759 760

        if zoom_begin is None:
          zoom_begin = params.get('zoom_begin', None)
        validate_method = getattr(self, 'planning_validate_date_list', None)
        date_range = validate_method(zoom_begin,zoom_level,zoom_variation)
        params['zoom_begin'] = params['from_date'] = date_range[0]
        params['zoom_end'] = params['to_date'] = date_range[1]
        selection.edit(params=params)
761
      if REQUEST is not None:
762 763 764
        return self._redirectToOriginalForm(REQUEST=REQUEST,
                                            form_id=form_id,
                                             query_string=query_string)
765 766

    security.declareProtected(ERP5Permissions.View, 'previousZoom')
767
    def previousZoom(self, uids=None, REQUEST=None, form_id=None, query_string=None):
768 769 770
      """
      Set previous graphic zoom in PlanningBox
      """
771 772
      if uids is None:
        uids = []
773 774 775 776 777
      request = REQUEST
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
778 779 780 781 782
        zoom_level =  params.get('zoom_level', 1)
        zoom_variation = -1
        zoom_begin = request.form.get('zoom_begin', None)

        # for keep the compatibility
783
        zoom_start = params.get('zoom_start',0)
784
        params['zoom_start'] = int(zoom_start) - 1
785

786 787 788 789 790 791 792 793 794 795 796 797
        if zoom_begin is None:
          zoom_begin = params.get('zoom_begin', None)
        validate_method = getattr(self, 'planning_validate_date_list', None)
        date_range = validate_method(zoom_begin,zoom_level,zoom_variation)
        params['zoom_begin'] = params['from_date'] = date_range[0]
        params['zoom_end'] = params['to_date'] = date_range[1]
        selection.edit(params=params)
      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
798
    security.declareProtected(ERP5Permissions.View, 'setDomainRoot')
799
    def setDomainRoot(self, REQUEST, form_id=None, query_string=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
800 801 802
      """
        Sets the root domain for the current selection
      """
803
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
804
      selection = self.getSelectionFor(selection_name, REQUEST)
805
      root_url = REQUEST.form.get('domain_root_url','portal_categories')
806
      selection.edit(domain_path=root_url, domain_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
807

808 809 810
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
811

812 813 814 815 816 817
    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
818

819
    security.declareProtected(ERP5Permissions.View, 'unfoldDomain')
820
    def unfoldDomain(self, REQUEST, form_id=None, query_string=None):
821 822 823
      """
        Unfold domain for the current selection
      """
824
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
825
      selection = self.getSelectionFor(selection_name, REQUEST)
826 827
      domain_url = REQUEST.form.get('domain_url',None)
      domain_depth = REQUEST.form.get('domain_depth',0)
828 829
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
830
      if isinstance(domain_url, str):
831
        selection.edit(domain_list = domain_list + [domain_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
832

833 834 835
      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
836

837
    security.declareProtected(ERP5Permissions.View, 'foldDomain')
838
    def foldDomain(self, REQUEST, form_id=None, query_string=None):
839 840 841
      """
        Fold domain for the current selection
      """
842
      selection_name = REQUEST.list_selection_name
843
      selection = self.getSelectionFor(selection_name, REQUEST)
844 845
      domain_url = REQUEST.form.get('domain_url',None)
      domain_depth = REQUEST.form.get('domain_depth',0)
846 847
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
848
      selection.edit(domain_list=[x for x in domain_list if x != domain_url])
849

850 851 852
      if REQUEST is not None:
        return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
                                            query_string=query_string)
853

854

Jean-Paul Smets's avatar
Jean-Paul Smets committed
855
    security.declareProtected(ERP5Permissions.View, 'setReportRoot')
856
    def setReportRoot(self, REQUEST, form_id=None, query_string=None):
857 858 859
      """
        Sets the root report for the current selection
      """
860
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
861
      selection = self.getSelectionFor(selection_name, REQUEST)
862
      root_url = REQUEST.form.get('report_root_url','portal_categories')
863
      selection.edit(report_path=root_url, report_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
864

865 866 867
      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
868 869

    security.declareProtected(ERP5Permissions.View, 'unfoldReport')
870
    def unfoldReport(self, REQUEST, form_id=None, query_string=None):
871 872 873
      """
        Unfold report for the current selection
      """
874
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
875
      selection = self.getSelectionFor(selection_name, REQUEST)
876
      report_url = REQUEST.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
877
      if type(report_url) == type('a'):
878
        selection.edit(report_list=list(selection.getReportList()) + [report_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
879

880 881 882
      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
883 884

    security.declareProtected(ERP5Permissions.View, 'foldReport')
885
    def foldReport(self, REQUEST, form_id=None, query_string=None):
886 887 888
      """
        Fold domain for the current selection
      """
889
      selection_name = REQUEST.list_selection_name
Jean-Paul Smets's avatar
Jean-Paul Smets committed
890
      selection = self.getSelectionFor(selection_name, REQUEST)
891
      report_url = REQUEST.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
892
      if type(report_url) == type('a'):
893
        report_list = selection.getReportList()
894
        selection.edit(report_list=[x for x in report_list if x != report_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
895

896 897 898
      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
899

900 901 902 903
    security.declareProtected(ERP5Permissions.View, 'getListboxDisplayMode')
    def getListboxDisplayMode(self, selection_name, REQUEST=None):
      if REQUEST is None:
        REQUEST = get_request()
904
      selection = self.getSelectionFor(selection_name, REQUEST)
905

906 907 908 909 910
      if getattr(selection, 'report_tree_mode', 0):
        return 'ReportTreeMode'
      elif getattr(selection, 'domain_tree_mode', 0):
        return 'DomainTreeMode'
      return 'FlatListMode'
911

Jean-Paul Smets's avatar
Jean-Paul Smets committed
912
    security.declareProtected(ERP5Permissions.View, 'setListboxDisplayMode')
913
    def setListboxDisplayMode(self, REQUEST, listbox_display_mode,
914 915
                              selection_name=None, redirect=0,
                              form_id=None, query_string=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
916
      """
917
        Toggle display of the listbox
Jean-Paul Smets's avatar
Jean-Paul Smets committed
918 919
      """
      request = REQUEST
920 921 922 923 924 925 926
      # 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
927 928
      # Possible fix: currently, display mode icon are implemented as
      # method. It could be easier to generate them as link (where we
929 930 931 932 933 934 935 936 937
      # 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
938
      selection = self.getSelectionFor(selection_name, REQUEST)
939 940
      if selection is None:
        selection = Selection()
941
        self.setSelectionFor(selection_name, selection, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
942 943 944 945 946 947 948 949 950 951 952 953 954

      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
955 956 957
      else:
        flat_list_mode = 0
        domain_tree_mode = 0
958
        report_tree_mode = 0
959

960 961 962
      selection.edit(flat_list_mode=flat_list_mode,
                     domain_tree_mode=domain_tree_mode,
                     report_tree_mode=report_tree_mode)
963
      # It is better to reset the query when changing the display mode.
964 965
      params = selection.getParams()
      if 'where_expression' in params: del params['where_expression']
966 967
      selection.edit(params = params)

968
      if redirect:
969 970 971
        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
972 973

    security.declareProtected(ERP5Permissions.View, 'setFlatListMode')
974
    def setFlatListMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
975 976 977
      """
        Set display of the listbox to FlatList mode
      """
978
      return self.setListboxDisplayMode(
979
                       REQUEST=REQUEST, listbox_display_mode='FlatListMode',
980
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
981 982

    security.declareProtected(ERP5Permissions.View, 'setDomainTreeMode')
983
    def setDomainTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
984 985 986
      """
         Set display of the listbox to DomainTree mode
      """
987
      return self.setListboxDisplayMode(
988
                       REQUEST=REQUEST, listbox_display_mode='DomainTreeMode',
989
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
990 991

    security.declareProtected(ERP5Permissions.View, 'setReportTreeMode')
992
    def setReportTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
993 994 995
      """
        Set display of the listbox to ReportTree mode
      """
996 997 998
      return self.setListboxDisplayMode(
                       REQUEST=REQUEST, listbox_display_mode='ReportTreeMode',
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
999

1000 1001 1002 1003 1004 1005
    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)
1006 1007
      if selection is None:
        return []
1008
      return selection(method=selection_method, context=context, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1009

1010 1011 1012 1013 1014 1015
    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)
1016 1017
      if selection is None:
        return []
1018
      uid_list = selection.getCheckedUids()
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
      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:
1029 1030
        value_list = self.getSelectionSelectedValueList(
                                            selection_name,
1031 1032
                                            REQUEST=REQUEST,
                                            selection_method=selection_method,
1033
                                            context=context)
1034
      return value_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1035

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1036 1037 1038 1039 1040
    security.declareProtected(ERP5Permissions.View, 'getSelectionUidList')
    def getSelectionUidList(self, selection_name, REQUEST=None, selection_method=None, context=None):
      """
        Get the list of values checked or selected for 'selection_name'
      """
1041
      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
1042

Sebastien Robin's avatar
Sebastien Robin committed
1043 1044 1045 1046 1047
    security.declareProtected(ERP5Permissions.View, 'selectionHasChanged')
    def selectionHasChanged(self, md5_string, object_uid_list):
      """
        We want to be sure that the selection did not change
      """
1048
      # XXX To avoid the difference of the string representations of int and long,
1049
      # convert each element to a string.
1050 1051 1052 1053
      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
1054

1055 1056
    security.declareProtected(ERP5Permissions.View, 'getPickle')
    def getPickle(self,**kw):
Sebastien Robin's avatar
Sebastien Robin committed
1057 1058
      """
      we give many keywords and we will get the corresponding
1059
      pickle string
Sebastien Robin's avatar
Sebastien Robin committed
1060
      """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1061
      #LOG('getPickle kw',0,kw)
1062 1063 1064
      # XXX Remove DateTime, This is really bad, only use for zope 2.6
      # XXX This has to be removed as quickly as possible
      for k,v in kw.items():
Sebastien Robin's avatar
Sebastien Robin committed
1065
        if isinstance(v,DateTime):
1066 1067
          del kw[k]
      # XXX End of the part to remove
1068
      #LOG('SelectionTool.getPickle, kw',0,kw)
Sebastien Robin's avatar
Sebastien Robin committed
1069 1070 1071 1072 1073 1074
      pickle_string = pickle.dumps(kw)
      msg = MIMEBase('application','octet-stream')
      msg.set_payload(pickle_string)
      Encoders.encode_base64(msg)
      pickle_string = msg.get_payload()
      pickle_string = pickle_string.replace('\n','@@@')
1075 1076 1077 1078 1079 1080 1081 1082
      return pickle_string

    security.declareProtected(ERP5Permissions.View, 'getPickleAndSignature')
    def getPickleAndSignature(self,**kw):
      """
      we give many keywords and we will get the corresponding
      pickle string and signature
      """
1083
      cookie_password = self._getCookiePassword()
1084
      pickle_string = self.getPickle(**kw)
Sebastien Robin's avatar
Sebastien Robin committed
1085 1086 1087
      signature = hmac.new(cookie_password,pickle_string).hexdigest()
      return (pickle_string,signature)

1088 1089 1090
    security.declareProtected(ERP5Permissions.View, 'getObjectFromPickle')
    def getObjectFromPickle(self,pickle_string):
      """
1091
      get object from a pickle string
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
      """
      object = None
      pickle_string = pickle_string.replace('@@@','\n')
      msg = MIMEBase('application','octet-stream')
      Encoders.encode_base64(msg)
      msg.set_payload(pickle_string)
      pickle_string = msg.get_payload(decode=1)
      object = pickle.loads(pickle_string)
      return object

Sebastien Robin's avatar
Sebastien Robin committed
1102 1103 1104
    security.declareProtected(ERP5Permissions.View, 'getObjectFromPickleAndSignature')
    def getObjectFromPickleAndSignature(self,pickle_string,signature):
      """
1105
      get object from a pickle string only when a signature maches
Sebastien Robin's avatar
Sebastien Robin committed
1106 1107 1108 1109 1110
      """
      cookie_password = self._getCookiePassword()
      object = None
      new_signature = hmac.new(cookie_password,pickle_string).hexdigest()
      if new_signature==signature:
1111
        object = self.getObjectFromPickle(pickle_string)
Sebastien Robin's avatar
Sebastien Robin committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
      return object

    security.declarePrivate('_getCookiePassword')
    def _getCookiePassword(self):
      """
      get the password used for encryption
      """
      cookie_password = getattr(self,'cookie_password',None)
      if cookie_password is None:
        cookie_password = str(random.randrange(1,2147483600))
        self.cookie_password = cookie_password
      return cookie_password

1125
    security.declareProtected(ERP5Permissions.View, 'setCookieInfo')
Sebastien Robin's avatar
Sebastien Robin committed
1126 1127
    def setCookieInfo(self,request,cookie_name,**kw):
      """
1128
      register info directly in cookie
Sebastien Robin's avatar
Sebastien Robin committed
1129 1130 1131 1132 1133 1134 1135
      """
      cookie_name = cookie_name + '_cookie'
      (pickle_string,signature) = self.getPickleAndSignature(**kw)
      request.RESPONSE.setCookie(cookie_name,pickle_string,max_age=15*60)
      signature_cookie_name = cookie_name + '_signature'
      request.RESPONSE.setCookie(signature_cookie_name,signature,max_age=15*60)

1136
    security.declareProtected(ERP5Permissions.View, 'getCookieInfo')
Sebastien Robin's avatar
Sebastien Robin committed
1137 1138
    def getCookieInfo(self,request,cookie_name):
      """
1139
      get info directly from cookie
Sebastien Robin's avatar
Sebastien Robin committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
      """
      cookie_name = cookie_name + '_cookie'
      object = None
      if getattr(request,cookie_name,None) is not None:
        pickle_string = request.get(cookie_name)
        signature_cookie_name = cookie_name + '_signature'
        signature = request.get(signature_cookie_name)
        object = self.getObjectFromPickleAndSignature(pickle_string,signature)
      if object is None:
        object = {}
      return object

1152
    # Related document searching
1153
    def viewSearchRelatedDocumentDialog(self, index, form_id,
1154
                                        REQUEST=None, sub_index=None, **kw):
1155
      """
1156 1157
      Returns a search related document dialog
      A set of forwarders us defined to circumvent limitations of HTML
1158
      """
Romain Courteaud's avatar
Romain Courteaud committed
1159 1160
      if sub_index != None:
        REQUEST.form['sub_index'] = sub_index
1161
      object_path = REQUEST.form['object_path']
1162
      # Find the object which needs to be updated
1163
      o = self.restrictedTraverse(object_path)
1164
      # Find the field which was clicked on
1165
      # Important to get from the object instead of self
1166
      form = getattr(o, form_id)
1167
      field = None
1168 1169
      # Search the correct field
      relation_field_found = 0
1170
      relation_index = 0
1171
      # XXX may be should support another parameter,
1172
      for field in form.get_fields(include_disabled=0):
1173 1174
        if field.get_value('editable', REQUEST=REQUEST):
          try:
1175 1176
           field.get_value('is_relation_field')
          except KeyError:
1177
            pass
1178
          else:
1179 1180 1181 1182 1183
            if index == relation_index:
              relation_field_found = 1
              break
            else:
              relation_index += 1
1184
      if not relation_field_found:
1185
        # We didn't find the field...
1186
        raise SelectionError, "SelectionTool: can not find the relation" \
1187
                              " field %s" % index
1188 1189 1190 1191 1192
      else:
        # Field found
        field_key = field.generate_field_key()
        field_value = REQUEST.form[field_key]
        # XXX Hardcoded form name
1193 1194
        dialog_id = 'Base_viewRelatedObjectList'
        redirect_form = getattr(o, dialog_id)
1195 1196 1197 1198 1199 1200 1201 1202
        # 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):
1203 1204 1205 1206
          # user click on the wheel, not on the validation button
          # we need to facilitate user search

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

1209 1210 1211 1212 1213 1214
          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
1215 1216 1217
          # Checked current uid
          kw ={}
          kw[field.get_value('catalog_index')] = field_value
1218
          self.portal_selections.setSelectionParamsFor(selection_name,
1219 1220
                                                       kw.copy())
          self.portal_selections.setSelectionCheckedUidsFor(
1221
                                             selection_name,
1222
                                             current_uid_list)
1223 1224 1225 1226 1227 1228 1229 1230
          field_value = str(field_value).splitlines()
          REQUEST.form[field_key] = field_value
          portal_status_message = Message(
                          domain='erp5_ui',
                          message="Please select one (or more) object.")
        else:
          portal_status_message = Message(domain='erp5_ui',
                                          message="Please select one object.")
1231 1232


1233 1234 1235 1236 1237 1238
        # Save the current REQUEST form
        # We can't put FileUpload instances because we can't pickle them
        pickle_kw = {}
        for key in REQUEST.form.keys():
          if not isinstance(REQUEST.form[key],FileUpload):
            pickle_kw[key] = REQUEST.form[key]
1239
        form_pickle, form_signature = self.getPickleAndSignature(**pickle_kw)
1240

1241 1242
        base_category = None
        kw = {}
1243
        kw['dialog_id'] = dialog_id
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
        kw['selection_name'] = selection_name
        kw['selection_index'] = 0 # We start on the first page
        kw['field_id'] = field.id
        kw['portal_type'] = [x[0] for x in field.get_value('portal_type')]
        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')
        kw['cancel_url'] = REQUEST.get('HTTP_REFERER')
1255
        kw['form_id'] = form_id
1256 1257
        kw[field.get_value('catalog_index')] = field_value
        kw['portal_status_message'] = portal_status_message
1258
        kw['form_pickle'] = form_pickle
1259 1260 1261 1262 1263
        kw['form_signature'] = form_signature

         # Empty the selection (uid)
        REQUEST.form = kw # New request form
        # Define new HTTP_REFERER
Romain Courteaud's avatar
Romain Courteaud committed
1264
        REQUEST.HTTP_REFERER = '%s/%s' % (o.absolute_url(),
1265
                                          dialog_id)
1266 1267 1268 1269 1270

        # 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)
1271
        # Return the search dialog
1272
        return getattr(o, dialog_id)(REQUEST=REQUEST)
1273

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
    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)
1285 1286
      return selection_domain.asSQLJoinExpression(
          category_table_alias=category_table_alias)
1287 1288 1289

    security.declarePublic('buildSQLExpressionFromDomainSelection')
    def buildSQLExpressionFromDomainSelection(self, selection_domain,
1290
                                              table_map=None, domain_id=None,
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
                                              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)
1303 1304 1305 1306 1307 1308
      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)
1309

1310 1311
    def _aq_dynamic(self, name):
      """
1312
        Generate viewSearchRelatedDocumentDialog0,
1313
                 viewSearchRelatedDocumentDialog1,... if necessary
1314 1315 1316
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
1317 1318 1319
        DYNAMIC_METHOD_NAME = 'viewSearchRelatedDocumentDialog'
        method_name_length = len(DYNAMIC_METHOD_NAME)

1320
        zope_security = '__roles__'
1321
        if (name[:method_name_length] == DYNAMIC_METHOD_NAME) and \
1322
           (name[-len(zope_security):] != zope_security):
1323
          method_count_string_list = name[method_name_length:].split('_')
1324 1325 1326 1327
          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
1328
          except TypeError:
1329
            return aq_base_name
1330
          else:
1331 1332 1333
            if len(method_count_string_list) > 1:
              # be sure that method name is correct
              try:
Romain Courteaud's avatar
Romain Courteaud committed
1334
                sub_index = string.atoi(method_count_string_list[1])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1335
              except TypeError:
1336 1337
                return aq_base_name
            else:
Romain Courteaud's avatar
Romain Courteaud committed
1338
              sub_index = None
1339

1340
            # generate dynamicaly needed forwarder methods
1341
            def viewSearchRelatedDocumentDialogWrapper(self, form_id,
1342
                                                       REQUEST=None, **kw):
1343 1344 1345
              """
                viewSearchRelatedDocumentDialog Wrapper
              """
1346 1347
#               LOG('SelectionTool.viewSearchRelatedDocumentDialogWrapper, kw',
#                   0, kw)
1348
              return self.viewSearchRelatedDocumentDialog(
1349
                                   method_count, form_id,
1350
                                   REQUEST=REQUEST, sub_index=sub_index, **kw)
1351
            setattr(self.__class__, name,
1352
                    viewSearchRelatedDocumentDialogWrapper)
1353 1354

            klass = aq_base(self).__class__
1355 1356 1357 1358
            security_property_id = '%s__roles__' % (name, )
            # Declare method as public
            setattr(klass, security_property_id, None)

1359 1360 1361 1362
            return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
1363

1364 1365
    def _getUserId(self):
      return self.portal_membership.getAuthenticatedMember().getUserName()
1366 1367
      # XXX It would be good to add somthing here
      # So that 2 anonymous users do not share the same selection
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408

    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)

    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):
      value = getattr(self, '_v_selection_data', None)
      if value is None:
        value = self.getPortalObject().portal_memcached.getMemcachedDict(key_prefix='selection_tool')
        setattr(self, '_v_selection_data', value)
      return value

    def _getPersistentContainer(self, user_id):
      if getattr(self, 'selection_data', None) is None:
        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
1409
InitializeClass( SelectionTool )
1410

1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424

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
1425 1426 1427 1428 1429
    # under '_container' key in zope 2.7 and 'data' in zope 2.8
    if 'data' in state:
      oldState['data'].update(savedState['data'])
    else:
      oldState['_container'].update(savedState['_container'])
1430 1431 1432
    return oldState


1433 1434 1435 1436 1437 1438 1439 1440
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
1441

1442 1443
  def getObject(self):
    return self.object
1444

1445 1446
  def getIsPureSummary(self):
    return self.is_pure_summary
1447

1448 1449
  def getDepth(self):
    return self.depth
1450

1451 1452
  def getIsOpen(self):
    return self.is_open
1453 1454

  def getSelectDomainDict(self):
1455
    return self.select_domain_dict
1456

1457 1458
  def getExceptionUidList(self):
    return self.exception_uid_list
1459

1460

1461 1462
def makeTreeList(here, form, root_dict, report_path, base_category,
		  depth, unfolded_list, form_id, selection_name,
1463
		  report_depth, is_report_opened=1, list_method=None,
1464
		  filtered_portal_types=[] ,sort_on = (('id', 'ASC'),)):
1465 1466 1467 1468 1469
  """
    (object, is_pure_summary, depth, is_open, select_domain_dict)

    select_domain_dict is a dictionary of  associative list of (id, domain)
  """
1470 1471
  if isinstance(report_path, str):
    report_path = report_path.split('/')
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

  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:
1487
        if portal_categories._getOb(base_category, None) is not None:
1488 1489 1490 1491
          if base_category == 'parent':
            # parent has a special treatment
            root = root_dict[base_category] = root_dict[None] = here
            report_path = report_path[1:]
1492
          else:
1493 1494
            root = root_dict[base_category] = root_dict[None] = \
                                               portal_categories[base_category]
1495 1496
            report_path = report_path[1:]
      if root is None and portal_domains is not None:
1497 1498 1499
        if portal_domains._getOb(base_category, None) is not None:
          root = root_dict[base_category] = root_dict[None] = \
                                               portal_domains[base_category]
1500 1501 1502
          report_path = report_path[1:]
      if root is None:
        try:
1503 1504
          root = root_dict[None] = \
              portal_object.unrestrictedTraverse(report_path)
1505
        except KeyError:
1506
          LOG('SelectionTool', INFO, "Not found %s" % str(report_path))
1507 1508 1509 1510 1511
          root = None
        report_path = ()
    else:
      root = root_dict[None] = root_dict[base_category]
      report_path = report_path[1:]
1512 1513 1514 1515
    is_empty_level = (root is not None) and \
        (root.objectCount() == 0) and (len(report_path) != 0)
    if is_empty_level: 
      base_category = report_path[0]
1516 1517

  tree_list = []
1518 1519
  if root is None: 
    return tree_list
1520

1521
  if base_category == 'parent':
1522 1523 1524 1525 1526
    # 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)
1527 1528
    else: 
      if filtered_portal_types not in [[],None,'']:
1529 1530
        object_list = list_method(portal_type=filtered_portal_types,
                                  sort_on=sort_on)
1531
      else:
1532
        object_list = list_method(sort_on=sort_on)
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
    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)
1549
          tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, exception_uid_list)]
1550 1551
          if is_report_opened :
            # List (contents, closed, must be strict selection)
1552 1553 1554
            tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, exception_uid_list)]

          tree_list += makeTreeList(here, form, new_root_dict, report_path,
1555
      		    base_category, depth + 1, unfolded_list, form_id, 
1556
      		    selection_name, report_depth,
1557 1558 1559
      		    is_report_opened=is_report_opened, sort_on=sort_on)
        else:
          tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, ())] # Summary (closed)
1560
  else:
1561 1562 1563 1564 1565 1566
    # 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:
1567 1568 1569 1570 1571 1572 1573
      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)
1574 1575
        tree_list += makeTreeList(here, form, new_root_dict, report_path, base_category, depth + 1,
            unfolded_list, form_id, selection_name, report_depth,
1576 1577 1578 1579
            is_report_opened=is_report_opened, sort_on=sort_on)
      else:

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

1581 1582
  return tree_list

1583
# Automaticaly add wrappers on Folder so it can access portal_selections.
1584
# Cannot be done in ERP5Type/Document/Folder.py because ERP5Type must not
1585
# depend on ERP5Form.
1586 1587

from Products.CMFCore.utils import getToolByName
1588
from Products.ERP5Type.Core.Folder import FolderMixIn
1589 1590
from ZPublisher.mapply import mapply

1591 1592
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]
1593

1594 1595 1596
# Monkey patch FolderMixIn with SelectionTool methods
#   kept here for compatibility with previous implementations
#   of Listbox HTML renderer. See bellow new implementation
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
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)
1607
  setattr(FolderMixIn, property_id, portal_selection_wrapper)
1608 1609 1610
  security_property_id = '%s__roles__' % (property_id, )
  security_property = getattr(SelectionTool, security_property_id, None)
  if security_property is not None:
1611
    setattr(FolderMixIn, security_property_id, security_property)
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 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 1653 1654 1655 1656 1657

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
      # Rename request parameters
      if request.has_key(selection_name_property_id):
        request.form['list_selection_name'] = request[selection_name_property_id]
      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]
      # 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, )
1658
      setattr(FolderMixIn, new_security_property_id, security_property)