SelectionTool.py 49 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 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 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# 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
ERP 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 39 40
from AccessControl import ClassSecurityInfo
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 44
from email.MIMEBase import MIMEBase
from email import Encoders
Sebastien Robin's avatar
Sebastien Robin committed
45
from copy import copy
46
from DateTime import DateTime
Sebastien Robin's avatar
Sebastien Robin committed
47
import md5
Sebastien Robin's avatar
Sebastien Robin committed
48 49 50
import pickle
import hmac
import random
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51

52
import string
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53
from zLOG import LOG
54
from Acquisition import Implicit, aq_base
55
from Products.ERP5Type.Message import Message
56

Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
class SelectionError( Exception ):
    pass

class SelectionTool( UniqueObject, SimpleItem ):
    """
      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'

    security = ClassSecurityInfo()

    #
    #   ZMI methods
    #
    manage_options = ( ( { 'label'      : 'Overview'
                         , 'action'     : 'manage_overview'
77 78 79 80
                         },
                         { 'label'      : 'View Selections'
                         , 'action'     : 'manage_view_selections'
                         } ))
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 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    security.declareProtected( ERP5Permissions.ManagePortal
                             , 'manage_view_selections' )
    manage_view_selections = DTMLFile( 'SelectionTool_manageViewSelections', _dtmldir )
    
    security.declareProtected(ERP5Permissions.View, 'getSelectionNames')
    def getSelectionNames(self, context=None, REQUEST=None):
      if context is None: context = self
      if not REQUEST:
        REQUEST = get_request()
        if hasattr(self, 'selection_data'):
          user_id = self.portal_membership.getAuthenticatedMember().getUserName()
        if user_id is not None and self.selection_data.has_key(user_id):
          return self.selection_data[user_id].keys()
      return ()

101 102 103 104 105 106 107 108
    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
109 110 111 112 113 114 115
    security.declareProtected(ERP5Permissions.View, 'getSelectionFor')
    def getSelectionFor(self, selection_name, REQUEST=None):
      """
        Returns the selection instance for a given selection_name
      """
      if not REQUEST:
        REQUEST = get_request()
116
        
117 118 119 120 121 122
      if not hasattr(self, 'selection_data'):
        self.selection_data = PersistentMapping()
      user_id = self.portal_membership.getAuthenticatedMember().getUserName()
      if user_id is not None:
        if not self.selection_data.has_key(user_id):
          self.selection_data[user_id] = PersistentMapping()
123 124
        if type(selection_name) is type(()) or type(selection_name) is type([]) :
          selection_name = selection_name[0]
125 126
        return self.selection_data[user_id].get(selection_name, None)
      else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127
        return None
128

Jean-Paul Smets's avatar
Jean-Paul Smets committed
129 130 131 132 133
    security.declareProtected(ERP5Permissions.View, 'setSelectionFor')
    def setSelectionFor(self, selection_name, selection_object, REQUEST=None):
      """
        Sets the selection instance for a given selection_name
      """
134 135 136
      if selection_object != None:
        # Set the name so that this selection itself can get its own name.
        selection_object.edit(name = selection_name)
137

Jean-Paul Smets's avatar
Jean-Paul Smets committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
      if not REQUEST:
        REQUEST = get_request()
      # New system: store directly - bypass session
      if 0:
        user_id = self.portal_membership.getAuthenticatedMember().getUserName()
        if user_id is not None:
          self.selection_data.set((user_id, selection_name), selection_object)
        return

      # Another method: local dict
      if 0:
        if not hasattr(self, 'selection_data'):
          self.selection_data = PersistentMapping()
        user_id = self.portal_membership.getAuthenticatedMember().getUserName()
        if user_id is not None:
          self.selection_data[(user_id, selection_name)] = selection_object
        return

      # Another method: local dict but 2 stage to prevent user conflict
      if 1:
        if not hasattr(self, 'selection_data'):
          self.selection_data = PersistentMapping()
        user_id = self.portal_membership.getAuthenticatedMember().getUserName()
        if user_id is not None:
          if not self.selection_data.has_key(user_id):
            self.selection_data[user_id] = PersistentMapping()
          self.selection_data[user_id][selection_name] = selection_object
        return

      #try: CAUSES PROBLEMS WHY ??
      if 1:
        session = REQUEST.SESSION
        selection_name = selection_name + '_selection_object'
        session[selection_name] = selection_object
      #except:
      #  LOG('WARNING ERP5Form SelectionTool',0,'Could not set Selection')

175 176
    security.declareProtected(ERP5Permissions.View, 'getSelectionParamsFor')
    def getSelectionParamsFor(self, selection_name, params=None, REQUEST=None):
177 178 179
      """
        Returns the params in the selection
      """
180
      if params is None: params = {}
181 182
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
183 184
        if len(selection.params) > 0:
          return selection.getParams()
185 186 187 188
        else:
          return params
      else:
        return params
189 190 191 192 193
    
    # backward compatibility 
    security.declareProtected(ERP5Permissions.View, 'getSelectionParams')
    getSelectionParams = getSelectionParamsFor
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    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)
      if selection_object:
        selection_object.edit(params=params)
      else:
        selection_object = Selection(params=params)
      self.setSelectionFor(selection_name, selection_object, REQUEST)

    security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor')
    def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None):
      """
        Sets the selection params for a given selection_name
      """
      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)

218 219 220 221 222 223 224 225 226 227 228
    def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None):
      """
        Sets the selection params for a given selection_name
      """
      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)

229 230 231 232 233 234 235
    security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor')
    def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None):
      """
        Sets the selection params for a given selection_name
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
236
        #return selection_object.selection_checked_uids
237
        return selection_object.getCheckedUids()
238 239 240
      return []

    security.declareProtected(ERP5Permissions.View, 'checkAll')
241
    def checkAll(self, selection_name, listbox_uid=[], REQUEST=None):
242 243 244 245 246 247
      """
        Sets the selection params for a given selection_name
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
        selection_uid_dict = {}
248
        for uid in selection_object.checked_uids:
249 250
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
251 252
          try:
            selection_uid_dict[int(uid)] = 1
253
          except ValueError:
254
            pass # this can happen in report
255 256 257 258 259 260 261 262 263
        self.setSelectionCheckedUidsFor(selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
      request = REQUEST
      if request:
        referer = request['HTTP_REFERER']
        referer = referer.replace('reset=', 'noreset=')
        referer = referer.replace('reset:int=', 'noreset:int=')
        return request.RESPONSE.redirect(referer)

    security.declareProtected(ERP5Permissions.View, 'uncheckAll')
264
    def uncheckAll(self, selection_name, listbox_uid=[], REQUEST=None):
265 266 267 268 269 270
      """
        Sets the selection params for a given selection_name
      """
      selection_object = self.getSelectionFor(selection_name, REQUEST)
      if selection_object:
        selection_uid_dict = {}
271
        for uid in selection_object.checked_uids:
272 273
          selection_uid_dict[uid] = 1
        for uid in listbox_uid:
274 275 276
          try:
            if selection_uid_dict.has_key(int(uid)): del selection_uid_dict[int(uid)]
          except ValueError:
277
            pass # This happens in report mode
278 279 280 281 282 283 284 285
        self.setSelectionCheckedUidsFor(selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
      request = REQUEST
      if request:
        referer = request['HTTP_REFERER']
        referer = referer.replace('reset=', 'noreset=')
        referer = referer.replace('reset:int=', 'noreset:int=')
        return request.RESPONSE.redirect(referer)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
286 287 288 289 290 291 292
    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:
293
        return selection.getListUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
294 295 296 297 298 299 300 301 302 303
      else:
        return None

    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:
304
        selection.edit(invert_mode=1, uids=selection_uids, checked_uids=selection_uids)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
305 306 307 308 309 310 311 312

    security.declareProtected(ERP5Permissions.View, 'setSelectionToAll')
    def setSelectionToAll(self, selection_name, REQUEST=None):
      """
        Resets the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
313
        selection.edit(invert_mode=0, params={}, checked_uids=[])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352

    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')
    def setSelectionQuickSortOrder(self, selection_name, sort_on, REQUEST=None):
      """
        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)

      request = REQUEST
      referer = request['HTTP_REFERER']
      referer = referer.replace('reset=', 'noreset=')
353
      referer = referer.replace('reset:int=', 'noreset:int=')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
354 355 356 357 358 359 360 361 362
      return request.RESPONSE.redirect(referer)

    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 ()
363
      return selection.sort_on
Jean-Paul Smets's avatar
Jean-Paul Smets committed
364 365 366 367 368 369 370 371 372 373

    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')
374
    def getSelectionColumns(self, selection_name, columns=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375 376 377
      """
        Returns the columns in the selection
      """
378
      if columns is None: columns = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
379 380
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
381 382
        if len(selection.columns) > 0:
          return selection.columns
383
      return columns
Jean-Paul Smets's avatar
Jean-Paul Smets committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401


    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')
    def getSelectionStats(self, selection_name, stats=[' ',' ',' ',' ',' ',' '], REQUEST=None):
      """
        Returns the stats in the selection
      """
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        try:
402
          return selection.stats
Yoshinori Okuji's avatar
Yoshinori Okuji committed
403
        except AttributeError:
404
          return stats # That is really bad programming XXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
405 406 407 408 409 410 411 412 413 414 415 416 417
      else:
        return stats


    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:
418
        method = self.unrestrictedTraverse(selection.method_path)
419 420
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
        o = selection_list[0]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
        url = o.absolute_url()
      else:
        url = REQUEST.url
      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):
      """
        Access first item in a selection
      """
      if not REQUEST:
        REQUEST = get_request()
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection:
436
        method = self.unrestrictedTraverse(selection.method_path)
437 438
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
        o = selection_list[-1]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
        url = o.absolute_url()
      else:
        url = REQUEST.url
      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:
454
        method = self.unrestrictedTraverse(selection.method_path)
455 456
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
        o = selection_list[(int(selection_index) + 1) % len(selection_list)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
        url = o.absolute_url()
      else:
        url = REQUEST.url
      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:
472
        method = self.unrestrictedTraverse(selection.method_path)
473 474
        selection_list = selection(method = method, context=self, REQUEST=REQUEST)
        o = selection_list[(int(selection_index) - 1) % len(selection_list)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
475 476 477 478 479 480 481 482 483
        url = o.absolute_url()
      else:
        url = REQUEST.url
      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
    security.declareProtected(ERP5Permissions.View, 'nextPage')
484
    def nextPage(self, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
485 486 487
      """
        Access the next page of a list
      """
488
      if uids is None: uids = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
489
      request = REQUEST
490
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
491 492
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
493
      params = selection.getParams()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
494 495 496 497 498
      lines = params.get('list_lines',0)
      start = params.get('list_start', 0)
      params['list_start'] = int(start) + int(lines)
      selection.edit(params= params)

499 500
      self.uncheckAll(selection_name, listbox_uid)
      return self.checkAll(selection_name, uids, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
501 502

    security.declareProtected(ERP5Permissions.View, 'previousPage')
503
    def previousPage(self, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
504 505 506
      """
        Access the previous page of a list
      """
507
      if uids is None: uids = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
508
      request = REQUEST
509
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
510 511
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
512
      params = selection.getParams()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
513 514 515
      lines = params.get('list_lines',0)
      start = params.get('list_start', 0)
      params['list_start'] = max(int(start) - int(lines), 0)
516
      selection.edit(params= selection.params)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
517

518 519
      self.uncheckAll(selection_name, listbox_uid)
      return self.checkAll(selection_name, uids, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
520 521

    security.declareProtected(ERP5Permissions.View, 'setPage')
522
    def setPage(self, listbox_uid, uids=None, REQUEST=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
523 524 525
      """
        Access the previous page of a list
      """
526
      if uids is None: uids = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
527
      request = REQUEST
528
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
529
      selection_name = request.list_selection_name
530 531

      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
532 533
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
534
        params = selection.getParams()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
535 536 537 538
        lines = params.get('list_lines',0)
        start = request.form.get('list_start',0)

        params['list_start'] = start
539
        selection.edit(params= selection.params)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
540

541 542
      self.uncheckAll(selection_name, listbox_uid)
      return self.checkAll(selection_name, uids, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
543

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    
    security.declareProtected(ERP5Permissions.View, 'setZoom')
    
    def setZoom(self, uids=None, REQUEST=None):
      """
      Set graphic zoom in PlanningBox
      """  
      if uids is None: uids = []
      request = REQUEST  
      zoom=request.get('zoom')
      selection_name=request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
      if selection is not None:
        params = selection.getParams()
        params['zoom'] = zoom
        selection.edit(params= params)
      referer = request['HTTP_REFERER']
      referer = referer.replace('reset=', 'noreset=')
      referer = referer.replace('reset:int=', 'noreset:int=')
      return request.RESPONSE.redirect(referer) 
    
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
566 567 568 569 570 571
    security.declareProtected(ERP5Permissions.View, 'setDomainRoot')
    def setDomainRoot(self, REQUEST):
      """
        Sets the root domain for the current selection
      """
      request = REQUEST
572
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
573 574 575
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
      root_url = request.form.get('domain_root_url','portal_categories')
576
      selection.edit(domain_path=root_url, domain_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
577 578 579

      return request.RESPONSE.redirect(request['HTTP_REFERER'])

580 581
    security.declareProtected(ERP5Permissions.View, 'unfoldDomain')
    def unfoldDomain(self, REQUEST):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
582 583 584 585
      """
        Sets the root domain for the current selection
      """
      request = REQUEST
586
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
587 588
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
589 590 591 592 593 594
      domain_url = request.form.get('domain_url',None)
      domain_depth = request.form.get('domain_depth',0)
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
      if type(domain_url) == type('a'):
        selection.edit(domain_list = domain_list + [domain_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
595 596 597

      return request.RESPONSE.redirect(request['HTTP_REFERER'])

598 599 600 601 602 603
    security.declareProtected(ERP5Permissions.View, 'foldDomain')
    def foldDomain(self, REQUEST):
      """
        Sets the root domain for the current selection
      """
      request = REQUEST
604
      #form_id = request.form_id
605 606 607 608 609 610 611 612 613 614
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
      domain_url = request.form.get('domain_url',None)
      domain_depth = request.form.get('domain_depth',0)
      domain_list = list(selection.getDomainList())
      domain_list = domain_list[0:min(domain_depth, len(domain_list))]
      selection.edit(domain_list=filter(lambda x:x != domain_url, domain_list))

      return request.RESPONSE.redirect(request['HTTP_REFERER'])

615

Jean-Paul Smets's avatar
Jean-Paul Smets committed
616 617 618 619 620 621
    security.declareProtected(ERP5Permissions.View, 'setReportRoot')
    def setReportRoot(self, REQUEST):
      """
        Sets the root domain for the current selection
      """
      request = REQUEST
622
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623 624 625
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
      root_url = request.form.get('report_root_url','portal_categories')
626
      selection.edit(report_path=root_url, report_list=())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
627 628 629 630 631 632 633 634

      return request.RESPONSE.redirect(request['HTTP_REFERER'])


    security.declareProtected(ERP5Permissions.View, 'unfoldReport')
    def unfoldReport(self, REQUEST):
      """
        Sets the root domain for the current selection
635

636
        report_list is a list of relative_url of category, domain, etc.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
637 638
      """
      request = REQUEST
639
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
640 641
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
642
      report_url = request.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
643
      if type(report_url) == type('a'):
644
        selection.edit(report_list=list(selection.getReportList()) + [report_url])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
645

646
      referer = request['HTTP_REFERER']
647
      referer = referer.replace('report_depth:int=', 'noreport_depth:int=')
648
      return request.RESPONSE.redirect(referer)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
649 650 651 652 653 654 655

    security.declareProtected(ERP5Permissions.View, 'foldReport')
    def foldReport(self, REQUEST):
      """
        Sets the root domain for the current selection
      """
      request = REQUEST
656
      #form_id = request.form_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
657 658
      selection_name = request.list_selection_name
      selection = self.getSelectionFor(selection_name, REQUEST)
659
      report_url = request.form.get('report_url',None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
660
      if type(report_url) == type('a'):
661 662
        report_list = selection.getReportList()
        selection.edit(report_list=filter(lambda x:x != report_url, report_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
663

664
      referer = request['HTTP_REFERER']
665
      referer = referer.replace('report_depth:int=', 'noreport_depth:int=')
666
      return request.RESPONSE.redirect(referer)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
667

668 669 670 671
    security.declareProtected(ERP5Permissions.View, 'getListboxDisplayMode')
    def getListboxDisplayMode(self, selection_name, REQUEST=None):
      if REQUEST is None:
        REQUEST = get_request()
672
      selection = self.getSelectionFor(selection_name, REQUEST)
673
    
674 675 676 677 678
      if getattr(selection, 'report_tree_mode', 0):
        return 'ReportTreeMode'
      elif getattr(selection, 'domain_tree_mode', 0):
        return 'DomainTreeMode'
      return 'FlatListMode'
679
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
680
    security.declareProtected(ERP5Permissions.View, 'setListboxDisplayMode')
681 682
    def setListboxDisplayMode(self, REQUEST, listbox_display_mode, 
                              selection_name=None, redirect=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
683 684 685 686
      """
        Toogle display of the listbox
      """
      request = REQUEST
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
      # 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
      # Possible fix: currently, display mode icon are implemented as 
      # method. It could be easier to generate them as link (where we 
      # 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
705
      selection = self.getSelectionFor(selection_name, REQUEST)
706 707
      if selection is None:
        selection = Selection()
708
        self.setSelectionFor(selection_name, selection, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
709 710 711 712 713 714 715 716 717 718 719 720 721

      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
722 723 724 725 726
      else:
        flat_list_mode = 0
        domain_tree_mode = 0
        report_tree_mode = 0      
        
727 728 729
      selection.edit(flat_list_mode=flat_list_mode,
                     domain_tree_mode=domain_tree_mode,
                     report_tree_mode=report_tree_mode)
730
      # It is better to reset the query when changing the display mode.
731 732
      params = selection.getParams()
      if 'where_expression' in params: del params['where_expression']
733 734
      selection.edit(params = params)

735 736 737 738 739 740 741
      if redirect:
        referer = request['HTTP_REFERER']
        referer = referer.replace('noreset=', 'reset=')
        referer = referer.replace('noreset:int=', 'reset:int=')
        referer = referer.replace('reset=', 'noreset=')
        referer = referer.replace('reset:int=', 'noreset:int=')
        return request.RESPONSE.redirect(referer)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
742 743

    security.declareProtected(ERP5Permissions.View, 'setFlatListMode')
744
    def setFlatListMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
745 746 747
      """
        Set display of the listbox to FlatList mode
      """
748 749 750
      return self.setListboxDisplayMode(
                       REQUEST=REQUEST, listbox_display_mode='FlatListMode', 
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
751 752

    security.declareProtected(ERP5Permissions.View, 'setDomainTreeMode')
753
    def setDomainTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
754 755 756
      """
         Set display of the listbox to DomainTree mode
      """
757 758 759
      return self.setListboxDisplayMode(
                       REQUEST=REQUEST, listbox_display_mode='DomainTreeMode', 
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
760 761

    security.declareProtected(ERP5Permissions.View, 'setReportTreeMode')
762
    def setReportTreeMode(self, REQUEST, selection_name=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
763 764 765
      """
        Set display of the listbox to ReportTree mode
      """
766 767 768
      return self.setListboxDisplayMode(
                       REQUEST=REQUEST, listbox_display_mode='ReportTreeMode',
                       selection_name=selection_name, redirect=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
769

770 771 772 773 774 775
    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)
776 777
      if selection is None:
        return []
778
      return selection(method=selection_method, context=context, REQUEST=REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
779

780 781 782 783 784 785
    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)
786 787
      if selection is None:
        return []
788
      uid_list = selection.getCheckedUids()
789 790 791 792 793 794 795 796 797 798
      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:
799 800 801 802 803
        value_list = self.getSelectionSelectedValueList(
                                            selection_name,
                                            REQUEST=REQUEST, 
                                            selection_method=selection_method, 
                                            context=context)
804
      return value_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
805

Jean-Paul Smets's avatar
Jean-Paul Smets committed
806 807 808 809 810 811 812
    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'
      """
      return map(lambda x:x.getObject().getUid(), self.getSelectionValueList(selection_name, REQUEST=REQUEST, selection_method=selection_method, context=context))

Sebastien Robin's avatar
Sebastien Robin committed
813 814 815 816 817
    security.declareProtected(ERP5Permissions.View, 'selectionHasChanged')
    def selectionHasChanged(self, md5_string, object_uid_list):
      """
        We want to be sure that the selection did not change
      """
818 819 820 821 822 823
      # XXX To avoid the difference of the string representations of int and long,
      # convert each element to a string. 
      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
824

825 826
    security.declareProtected(ERP5Permissions.View, 'getPickle')
    def getPickle(self,**kw):
Sebastien Robin's avatar
Sebastien Robin committed
827 828 829 830
      """
      we give many keywords and we will get the corresponding
      pickle string and signature
      """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
831
      #LOG('getPickle kw',0,kw)
832 833 834
      # 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
835
        if isinstance(v,DateTime):
836 837
          del kw[k]
      # XXX End of the part to remove
838
      #LOG('SelectionTool.getPickle, kw',0,kw)
Sebastien Robin's avatar
Sebastien Robin committed
839 840 841 842 843 844
      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','@@@')
845 846 847 848 849 850 851 852
      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
      """
853
      cookie_password = self._getCookiePassword()
854
      pickle_string = self.getPickle(**kw)
Sebastien Robin's avatar
Sebastien Robin committed
855 856 857
      signature = hmac.new(cookie_password,pickle_string).hexdigest()
      return (pickle_string,signature)

858 859 860 861 862 863 864 865 866 867 868 869 870 871
    security.declareProtected(ERP5Permissions.View, 'getObjectFromPickle')
    def getObjectFromPickle(self,pickle_string):
      """
      we give a pickle string and a signature
      """
      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
872 873 874 875 876 877 878 879 880
    security.declareProtected(ERP5Permissions.View, 'getObjectFromPickleAndSignature')
    def getObjectFromPickleAndSignature(self,pickle_string,signature):
      """
      we give a pickle string and a signature
      """
      cookie_password = self._getCookiePassword()
      object = None
      new_signature = hmac.new(cookie_password,pickle_string).hexdigest()
      if new_signature==signature:
881
        object = self.getObjectFromPickle(pickle_string)
Sebastien Robin's avatar
Sebastien Robin committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
      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

    security.declareProtected(ERP5Permissions.View, 'registerCookieInfo')
    def setCookieInfo(self,request,cookie_name,**kw):
      """
      regiter info directly in cookie
      """
      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)

    security.declareProtected(ERP5Permissions.View, 'registerCookieInfo')
    def getCookieInfo(self,request,cookie_name):
      """
      regiter info directly in cookie
      """
      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

922
    # Related document searching
923
    def viewSearchRelatedDocumentDialog(self, index, form_id, REQUEST=None,
924
                                        sub_index=None, **kw):
925
      """
926 927
      Returns a search related document dialog
      A set of forwarders us defined to circumvent limitations of HTML
928
      """
Romain Courteaud's avatar
Romain Courteaud committed
929 930
      if sub_index != None:
        REQUEST.form['sub_index'] = sub_index
931
      # Find the object which needs to be updated
932
      object_uid = REQUEST.get('object_uid', None)
933
      object_path = REQUEST.get('object_path', None)
934
      if object_uid is not None:
935 936
        try :
          o = self.portal_catalog.getObject(object_uid)
937
        except (NotFound, KeyError), err :
938
          o = None
939 940 941
      if o is None:
        # we first try to reindex the object, thanks to the object_path
        if object_path is not None:
942
          o = self.getPortalObject().restrictedTraverse(object_path)
943
        if o is not None:
944
          # XXX
945
          o.immediateReindexObject()
946
          object_uid = o.getUid()
947
        else:
948 949 950
          raise SelectionError, \
                "Sorrry, Error, the calling object was not catalogued. " \
                "Do not know how to do ?"
951
      # Find the field which was clicked on
952
      # Important to get from the object instead of self
953
      form = getattr(o, form_id)
954
      field = None
955 956
      # Search the correct field
      relation_field_found = 0
957
      relation_index = 0
958
      # XXX may be should support another parameter,
959
      for field in form.get_fields(include_disabled=0):
960 961
        if field.get_value('editable', REQUEST=REQUEST):
          try:
962 963
           field.get_value('is_relation_field')
          except KeyError:
964
            pass
965
          else:
966 967 968 969 970
            if index == relation_index:
              relation_field_found = 1
              break
            else:
              relation_index += 1
971
      if not relation_field_found:
972
        # We didn't find the field...
973
        raise SelectionError, "SelectionTool: can not find the relation" \
974
                              " field %s" % index
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
      else:
        # Field found
        field_key = field.generate_field_key()
        field_value = REQUEST.form[field_key]
        # XXX Hardcoded form name
        redirect_form_id = 'Base_viewRelatedObjectList'
        redirect_form = getattr(o, redirect_form_id)
        # 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):
990 991 992 993
          # user click on the wheel, not on the validation button
          # we need to facilitate user search

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

996 997 998
          property_get_related_uid_method_name = \
            "get%sUidList" % ''.join(['%s%s' % (x[0].upper(), x[1:]) \
                                      for x in base_category.split('_')])
999
          
1000 1001 1002
          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
1003 1004 1005
          # Checked current uid
          kw ={}
          kw[field.get_value('catalog_index')] = field_value
1006 1007 1008 1009 1010
          self.portal_selections.setSelectionParamsFor(selection_name, 
                                                       kw.copy())
          self.portal_selections.setSelectionCheckedUidsFor(
                                             selection_name, 
                                             current_uid_list)
1011 1012 1013 1014 1015 1016 1017 1018
          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.")
1019 1020


1021 1022 1023 1024 1025 1026
        # 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]
1027
        form_pickle, form_signature = self.getPickleAndSignature(**pickle_kw)
1028

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
        base_category = None
        kw = {}
        kw['object_uid'] = object_uid
        kw['form_id'] = redirect_form_id
        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')
        kw['previous_form_id'] = form_id
        kw[field.get_value('catalog_index')] = field_value
        kw['portal_status_message'] = portal_status_message
1047 1048 1049 1050 1051 1052 1053 1054 1055
        kw['form_pickle'] = form_pickle   
        kw['form_signature'] = form_signature

         # Empty the selection (uid)
        REQUEST.form = kw # New request form
        # Define new HTTP_REFERER
        REQUEST.HTTP_REFERER = '%s/Base_viewRelatedObjectList' % o.absolute_url()
        # Return the search dialog
        return getattr(o, redirect_form_id)(REQUEST=REQUEST)
1056

1057 1058
    def _aq_dynamic(self, name):
      """
1059 1060
        Generate viewSearchRelatedDocumentDialog0, 
                 viewSearchRelatedDocumentDialog1,... if necessary
1061 1062 1063
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
1064 1065 1066
        DYNAMIC_METHOD_NAME = 'viewSearchRelatedDocumentDialog'
        method_name_length = len(DYNAMIC_METHOD_NAME)

1067
        zope_security = '__roles__'
1068
        if (name[:method_name_length] == DYNAMIC_METHOD_NAME) and \
1069
           (name[-len(zope_security):] != zope_security):
1070
          method_count_string_list = name[method_name_length:].split('_')
1071 1072 1073 1074
          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
1075
          except TypeError:
1076
            return aq_base_name
1077
          else:
1078 1079 1080
            if len(method_count_string_list) > 1:
              # be sure that method name is correct
              try:
Romain Courteaud's avatar
Romain Courteaud committed
1081
                sub_index = string.atoi(method_count_string_list[1])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1082
              except TypeError:
1083 1084
                return aq_base_name
            else:
Romain Courteaud's avatar
Romain Courteaud committed
1085
              sub_index = None
1086 1087
            
            # generate dynamicaly needed forwarder methods
1088 1089
            def viewSearchRelatedDocumentDialogWrapper(self, form_id, 
                                                       REQUEST=None, **kw):
1090 1091 1092
              """
                viewSearchRelatedDocumentDialog Wrapper
              """
1093 1094
              LOG('SelectionTool.viewSearchRelatedDocumentDialogWrapper, kw', 
                  0, kw)
1095
              return self.viewSearchRelatedDocumentDialog(
1096 1097 1098 1099
                                   method_count, form_id, 
                                   REQUEST=REQUEST, sub_index=sub_index, **kw)
            setattr(self.__class__, name, 
                    viewSearchRelatedDocumentDialogWrapper)
1100 1101 1102 1103 1104 1105 1106

            klass = aq_base(self).__class__
            if hasattr(klass, 'security'):
              from Products.ERP5Type import Permissions as ERP5Permissions
              klass.security.declareProtected(ERP5Permissions.View, name)
            else:
              # XXX security declaration always failed....
1107 1108
              LOG('WARNING ERP5Form SelectionTool, security not defined on',
                  0, klass.__name__)
1109 1110 1111 1112
            return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
1113

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1114
InitializeClass( SelectionTool )
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232

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
  def getObject(self):
    return self.object
    
  def getIsPureSummary(self):
    return self.is_pure_summary
    
  def getDepth(self):
    return self.depth
    
  def getIsOpen(self):
    return self.is_open
  
  def getSelectDomainDict(self): 
    return self.select_domain_dict
    
  def getExceptionUidList(self):
    return self.exception_uid_list
  

def makeTreeList(here, form, root_dict, report_path, base_category, depth, unfolded_list, form_id, selection_name, report_depth, is_report_opened=1, sort_on = (('id', 'ASC'),)):
  """
    (object, is_pure_summary, depth, is_open, select_domain_dict)

    select_domain_dict is a dictionary of  associative list of (id, domain)
  """
  if type(report_path) is type('a'): report_path = report_path.split('/')

  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:
        if base_category in portal_categories.objectIds():
          if base_category == 'parent':
            # parent has a special treatment
            root = root_dict[base_category] = root_dict[None] = here
            report_path = report_path[1:]
          else:          
            root = root_dict[base_category] = root_dict[None] = portal_categories[base_category]
            report_path = report_path[1:]
      if root is None and portal_domains is not None:
        if base_category in portal_domains.objectIds():
          root = root_dict[base_category] = root_dict[None] = portal_domains[base_category]
          report_path = report_path[1:]
      if root is None:
        try:
          root = root_dict[None] = portal_object.unrestrictedTraverse(report_path)
        except KeyError:
          root = None
        report_path = ()
    else:
      root = root_dict[None] = root_dict[base_category]
      report_path = report_path[1:]
    is_empty_level = (root.objectCount() == 0) and (len(report_path) != 0)
    if is_empty_level: base_category = report_path[0]

  tree_list = []
  if root is None: return tree_list

  if base_category == 'parent':
    if hasattr(aq_base(root), 'objectValues'):
      # If this is a folder, try to browse the hierarchy
      for zo in root.searchFolder(sort_on=sort_on):
        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())          
            tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, exception_uid_list)] # Summary (open)
            if is_report_opened :
              tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, exception_uid_list)] # List (contents, closed, must be strict selection)
            tree_list += makeTreeList(here, form, new_root_dict, report_path, base_category, depth + 1, unfolded_list, form_id, selection_name, report_depth, is_report_opened=is_report_opened, sort_on=sort_on)
          else:
            tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, ())] # Summary (closed)
  else:
    for o in root.objectValues():
      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)
        tree_list += makeTreeList(here, form, new_root_dict, report_path, base_category, depth + 1, 
            unfolded_list, form_id, selection_name, report_depth, 
            is_report_opened=is_report_opened, sort_on=sort_on)
      else:

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