PlanningBox.py 132 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
3
# Copyright (c) 2005,2007 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Tomas Bernard <thomas@nexedi.com>
5
#                    Rafael Monnerat <rafael@nexedi.com>
6
#     from an original experimental script written by :
Sebastien Robin's avatar
Sebastien Robin committed
7 8 9 10 11 12 13
#                    Jonathan Loriette <john@nexedi.com>
#
# 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
Thomas Bernard's avatar
Thomas Bernard committed
14
# Service Company
Sebastien Robin's avatar
Sebastien Robin committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# 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.
#
##############################################################################
31 32 33 34 35 36 37 38 39 40

    # XXX need to decide how Constraints between task should be defined on
    # planning.
    # ideally, an external method should be called for validating all
    # constraints within the planning. (such a method sould be called from
    # anywhere in the Project module : listbox, editing form).
    # this method should return a list of all the objects' urls that does not
    # fit the constraints.


41

42
# Class monitoring access security control
43 44 45
from Products.PythonScripts.Utility import allow_class
from Globals import InitializeClass

Sebastien Robin's avatar
Sebastien Robin committed
46 47 48 49 50
from Products.Formulator.Field import ZMIField
from Products.Formulator.DummyField import fields
from DateTime import DateTime
from Products.Formulator import Widget, Validator
from Products.Formulator.Errors import FormValidationError, ValidationError
Rafael Monnerat's avatar
Rafael Monnerat committed
51
from SelectionTool import makeTreeList
52
from Selection import Selection
Sebastien Robin's avatar
Sebastien Robin committed
53 54 55
from AccessControl import ClassSecurityInfo
from zLOG import LOG
from copy import copy
Thomas Bernard's avatar
Thomas Bernard committed
56

57 58 59
class PlanningBoxError(Exception):
  pass

Sebastien Robin's avatar
Sebastien Robin committed
60
class PlanningBoxValidator(Validator.StringBaseValidator):
61 62
  """
  Class holding all methods used to validate a modified PlanningBox
Thomas Bernard's avatar
Thomas Bernard committed
63
  can be called only from an HTML rendering using wz_dragdrop script
64
  """
Romain Courteaud's avatar
Romain Courteaud committed
65
  def validate(self, field, key, REQUEST):
66 67
    """
    main method to solve validation
68 69 70 71 72 73 74 75 76 77 78 79
    - rebuild the whole planning structure but do not display it.
      this is needed to be able to get the block positions
    - apply block movements recovered from the java script
    - for each block moved, check the modification (over he primary axis in
      case task association has changed, and also over the secondary axis to
      check block movement / resizement).
      Beware : This checking part does not include constraint checking.
    - build a list with the validated blocks and also with the error blocks
      (if any).
    - return a dict of values to update objects in case no errors have been
      found. Otherwise save in the REQUEST the list of error blocks so that
      they can be displayed in a special way.
80
    """
81 82
    # init params
    value = None
83
    context = getContext(field, REQUEST)
84 85

    # recover usefull properties
Romain Courteaud's avatar
Romain Courteaud committed
86
    # XXX Incompatible with multiple planning box in the same form
Thomas Bernard's avatar
Thomas Bernard committed
87 88
    block_moved_string = REQUEST.get('block_moved','')
    block_previous_string = REQUEST.get('previous_block_moved','')
89 90 91

    ############## REBUILD STRUCTURE #################
    # build structure
92
    basic, planning = PlanningBoxWidgetInstance.render_structure(field=field,
93
                          REQUEST= REQUEST,
94
                          context=context)
95 96

    # getting coordinates script generator
97
    planning_coordinates_method = getattr(context, 'planning_coordinates')
98
    # calling script to generate coordinates
99 100
    planning_coordinates = planning_coordinates_method(basic=basic,
                                                       planning=planning)
101

Thomas Bernard's avatar
Thomas Bernard committed
102
    ########## RECOVERING BLOCK MOVED DICTS ##########
103
    #  converting string to a structure
Thomas Bernard's avatar
Thomas Bernard committed
104 105 106
    block_moved_list = self.getBlockPositionFromString(block_moved_string)
    # block_moved_list now holds a list of structure recovered from the REQUEST
    # and correspondig to the movements done before validating
Thomas Bernard's avatar
Thomas Bernard committed
107 108
    block_previous_list =\
                       self.getBlockPositionFromString(block_previous_string)
Thomas Bernard's avatar
Thomas Bernard committed
109 110 111
    # list of previous blocks moved if an error occured during previous
    # validation

Thomas Bernard's avatar
Thomas Bernard committed
112 113 114
    # updating block_moved_list using block_previous_list.
    # This is very important not to escape processing blocks that have been
    # moved during a previous validation attempt.
Thomas Bernard's avatar
Thomas Bernard committed
115 116
    if block_previous_list != [] and block_moved_list != []:
      for block_previous in block_previous_list:
Thomas Bernard's avatar
Thomas Bernard committed
117
        # checking if the block has been moved again in this validation attempt
Thomas Bernard's avatar
Thomas Bernard committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
        # if it is the case, the block must be also present in the current
        # block_moved_list
        block_found = {}
        for block_moved in block_moved_list:
          if block_moved['name'] == block_previous['name']:
            block_found = block_moved
            break
        if block_found != {}:
          # block has been moved again, updating its properties in the current
          # list to take into account its previous position. current block is
          # known as 'block_found', and the value to update is the original
          # absolute position used to get relative coordinates
          block_found['old_X'] = block_previous['old_X']
          block_found['old_Y'] = block_previous['old_Y']
        else:
Thomas Bernard's avatar
Thomas Bernard committed
133 134
          # block has not been moved again, adding old block informations to
          # the current list of block_moved
Thomas Bernard's avatar
Thomas Bernard committed
135 136 137 138 139 140 141 142 143
          block_moved_list.append(block_previous)
    elif block_previous_list != []:
      # block_moved_list is empty but not block_previous_list. This means the
      # user is trying to validate again without any change
      block_moved_list = block_previous_list
    elif block_moved_list != []:
      # block_previous_list is empty, this means this is the first validation
      # attempt. Using the block_moved_list as it is
      pass
144
    else:
Thomas Bernard's avatar
Thomas Bernard committed
145 146 147
      # the two lists are empty : nothing to validate
      return None
    # block_moved_list is updated
148 149 150

    # dict aimed to hold all informations about block
    final_block_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
151 152
    # dict holding all the activities that will need an update because at least
    # one of the blocks concerned is moved
153
    activity_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
154 155 156 157
    # list holding all the activities having one of their block not validated
    # in such a case the update process of the activity is canceled
    warning_activity_list = []
    error_block_list = []
158
    error_info_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
159

160 161 162 163 164 165 166
    ########## GETTING BLOCK INFORMATIONS ############
    # iterating each block_moved element and recovering all usefull properties
    # BEWARE : no update is done here as an activity can be composed of several
    # blocks and so we need first to check all the blocks moved
    for block_moved in block_moved_list:
      final_block = {}
      # recovering the block object from block_moved informations
Thomas Bernard's avatar
Thomas Bernard committed
167
      final_block['block_object'] = self.getBlockObject(block_moved['name'], \
168
                                                        planning.content)
169
      # recovering original activity object
Thomas Bernard's avatar
Thomas Bernard committed
170 171
      final_block['activity_origin'] = \
           final_block['block_object'].parent_activity
172
      # recovering original axis_group object
Thomas Bernard's avatar
Thomas Bernard committed
173 174
      final_block['group_origin'] = \
           final_block['activity_origin'].parent_axis_element.parent_axis_group
175
      # recovering relative block information in planning_coordinates
Thomas Bernard's avatar
Thomas Bernard committed
176 177
      final_block['block_info'] = \
           planning_coordinates['content'][block_moved['name']]
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193

      # calculating delta
      # block_moved holds coordinates recovered from drag&drop script, while
      # block_info has the relative coordinates.
      # In fact the Drag&Drop java script used to get destination coordinates
      # gives them in absolute. so using original block position to get the
      # relative position
      deltaX = block_moved['old_X'] - final_block['block_info']['margin-left']
      deltaY = block_moved['old_Y'] - final_block['block_info']['margin-top']

      # calculating new block position:
      # width and height are already in the good format
      block_moved['left'] = block_moved['new_X'] - deltaX
      block_moved['top']  = block_moved['new_Y'] - deltaY

      # abstracting axis representation (for generic processing)
194
      if planning.calendar_view == 0:
Romain Courteaud's avatar
Romain Courteaud committed
195 196
        block_moved['main_axis_position'] = block_moved['top']
        block_moved['main_axis_length'] = block_moved['height']
197
        block_moved['secondary_axis_position'] = block_moved['left']
Romain Courteaud's avatar
Romain Courteaud committed
198
        block_moved['secondary_axis_length'] = block_moved['width']
199 200 201 202 203 204
        # used afterwards to get destination group
        group_position = 'margin-top'
        group_length = 'height'
        # used afterwards to get secondary axis displacements and modifications
        axis_length = 'width'
      else:
Romain Courteaud's avatar
Romain Courteaud committed
205 206
        block_moved['main_axis_position'] = block_moved['left']
        block_moved['main_axis_length'] = block_moved['width']
207
        block_moved['secondary_axis_position'] = block_moved['top']
Romain Courteaud's avatar
Romain Courteaud committed
208
        block_moved['secondary_axis_length'] = block_moved['height']
209 210 211 212 213
        group_position = 'margin-left'
        group_length = 'width'
        axis_length = 'height'

      # calculating center of block over main axis to check block position
Thomas Bernard's avatar
Thomas Bernard committed
214 215
      block_moved['center'] = (block_moved['main_axis_length'] / 2) + \
                               block_moved['main_axis_position']
216

Thomas Bernard's avatar
Thomas Bernard committed
217 218 219
      # now that block coordinates are recovered as well as planning
      # coordinates, recovering destination group over the main axis to know
      # if the block has been moved from a group to another
220
      group_destination = self.getDestinationGroup(basic, planning,
Thomas Bernard's avatar
Thomas Bernard committed
221 222
               block_moved,planning_coordinates['main_axis'],
               group_position, group_length)
223

Romain Courteaud's avatar
Romain Courteaud committed
224
      if group_destination is None:
Thomas Bernard's avatar
Thomas Bernard committed
225 226 227 228 229
        # !! Generate an Error !!
        # block has been moved outside the content area (not in line with any
        # group of the current area).
        # adding current block to error_list
        error_block_list.append(block_moved['name'])
230
        error_info_dict[block_moved['name']] = 'out of bounds on main axis'
Thomas Bernard's avatar
Thomas Bernard committed
231 232 233
        # adding if necessary current activity to warning_list
        if final_block['activity_origin'].name not in warning_activity_list:
          warning_activity_list.append(final_block['activity_origin'].name)
234
        secondary_axis_positions = [ None , None ]
235 236 237
      else:
        # now that all informations about the main axis changes are
        # known, checking modifications over the secondary axis.
238
        secondary_axis_positions = self.getDestinationBounds(basic, planning,
239 240 241 242 243 244 245 246 247 248 249 250
                block_moved, final_block['block_object'],
                planning_coordinates, axis_length,
                destination_group = group_destination)
        if secondary_axis_positions[2] == 1 :
          # !! Generate an Error !!
          # block has been moved outside the content area (bounds do not match
          # current area limits)
          if block_moved['name'] not in error_block_list:
            error_block_list.append(block_moved['name'])
            error_info_dict[block_moved['name']] = 'out of bounds on sec axis'
            if final_block['activity_origin'].name not in warning_activity_list:
              warning_activity_list.append(final_block['activity_origin'].name)
Thomas Bernard's avatar
Thomas Bernard committed
251 252


253 254 255 256 257 258 259 260 261 262 263 264
      block_moved['secondary_axis_start'] = secondary_axis_positions[0]
      block_moved['secondary_axis_stop'] = secondary_axis_positions[1]

      final_block['block_moved'] = block_moved
      final_block['group_destination'] = group_destination

      #final_block_dict[block_moved['name']] = final_block
      try:
        activity_dict[final_block['activity_origin'].name].append(final_block)
      except KeyError:
        activity_dict[final_block['activity_origin'].name] = [final_block]

265 266

    # getting object_dict to update object properties once activities are up to
267
    # date. Activities values will be updated directly on the
268
    object_dict = self.getObjectDict(basic=basic, planning=planning)
269

270
    ############# UPDATING ACTIVITIES ################
271 272 273 274 275 276
    # if activity is composed of several blocks, then check if it is needed to
    # update activity itself depending on blocks moved. Beware this part only
    # deals with activities (i.e task object) : an object can be represented by
    # several activities (in case of calendar mode for example).
    # build a dict
    update_list = []
Thomas Bernard's avatar
Thomas Bernard committed
277 278
    errors_list = []
    # getting start & stop property names
279 280
    start_property = field.get_value('x_start_bloc')
    stop_property = field.get_value('x_stop_bloc')
Thomas Bernard's avatar
Thomas Bernard committed
281
    # getting round_script if exists
282
    round_script=getattr(context, field.get_value('round_script'), None)
283 284 285 286 287 288 289 290
    # now processing activity updates
    for activity_name in activity_dict.keys():
      # recovering list of moved blocks in the current activity
      activity_block_moved_list = activity_dict[activity_name]
      # recovering activity object from first moved block
      activity_object = activity_block_moved_list[0]['activity_origin']
      # now getting list of blocks related to the activity (moved or not)
      activity_block_list = activity_object.block_list
Thomas Bernard's avatar
Thomas Bernard committed
291
      if activity_object.name in warning_activity_list:
292
        # activity contains a block that has not been validated
Thomas Bernard's avatar
Thomas Bernard committed
293 294 295 296 297 298 299
        # The validation update process is canceled, and the error is reported
        err = ValidationError(StandardError,activity_object)
        errors_list.append(err)
        pass
      else:
        # no error : continue
        # recovering new activity bounds
Thomas Bernard's avatar
Thomas Bernard committed
300 301 302 303
        (start_value, stop_value) = \
             self.getActivityBounds(activity_object, activity_block_moved_list,
                                    activity_block_list)
        # call specific external method to round value
Romain Courteaud's avatar
Romain Courteaud committed
304
        if round_script is not None:
Thomas Bernard's avatar
Thomas Bernard committed
305 306
          start_value = round_script(start_value)
          stop_value = round_script(stop_value)
307
        # adding object name to list of objects to update
Romain Courteaud's avatar
Romain Courteaud committed
308
        if activity_object.object.getUrl() not in update_list:
309
          update_list.append(activity_object.object.getUrl())
Thomas Bernard's avatar
Thomas Bernard committed
310
        # saving updated informations in the final dict
Romain Courteaud's avatar
Romain Courteaud committed
311
        for activity_desc in object_dict[activity_object.object.getUrl()]:
312 313 314 315 316 317 318 319 320 321 322 323 324 325
          if activity_desc['activity_name'] == activity_object.name:
            activity_desc['axis_start'] = start_value
            activity_desc['axis_stop'] = stop_value

    ############### UPDATING OBJECTS #################
    # using result from updated activities to process update on objects.
    update_dict = {}
    # first building a dict with all informations for each object.
    # now processing activity updates
    for object_name in update_list:
      object_info = object_dict[object_name]
      axis_start = None
      axis_stop  = None
      for activity in object_info:
Romain Courteaud's avatar
Romain Courteaud committed
326 327
        activity_start_date = activity['axis_start']
        activity_stop_date = activity['axis_stop']
328 329 330 331
        if activity['activity_name'] == 'update':
          # case current activity is in fact 'fake' activity, just data telling
          # if can update min & max bounds according to global decision toward
          # objects.
Romain Courteaud's avatar
Romain Courteaud committed
332 333
          can_update_start = activity_start_date
          can_update_stop  = activity_stop_date
334
        else:
Romain Courteaud's avatar
Romain Courteaud committed
335 336 337 338 339
          if axis_start > activity_start_date or axis_start is None:
            axis_start = activity_start_date
          if axis_stop  < activity_stop_date  or axis_stop  is None:
            axis_stop = activity_stop_date

340
      update_dict[object_name] = {}
Romain Courteaud's avatar
Romain Courteaud committed
341
      if can_update_start and axis_start is not None:
342
        update_dict[object_name][start_property] = axis_start
Romain Courteaud's avatar
Romain Courteaud committed
343
      if can_update_stop  and axis_stop  is not None:
344
        update_dict[object_name][stop_property]  = axis_stop
Thomas Bernard's avatar
Thomas Bernard committed
345 346 347 348 349 350 351 352 353 354 355 356 357

    # testing if need to raise errors
    if len(errors_list) > 0:
      # need to raise an error
      # rebuilt position string including new values
      block_moved_string = self.setBlockPositionToString(block_moved_list)
      # save the current block_list for repositionning the blocks
      # to their final position
      REQUEST.set('previous_block_moved',block_moved_string)
      # saving blocks not validated as such as the activity they belong to to
      # apply a special treatment.
      REQUEST.set('warning_activity_list',warning_activity_list)
      REQUEST.set('error_block_list',error_block_list)
358 359 360
      REQUEST.set('error_info_dict',error_info_dict)
      # now raise error => automatically called
      # parameters are :
361
      # - list of errors
362
      # - dict with error results
Romain Courteaud's avatar
Romain Courteaud committed
363
      raise FormValidationError(errors_list, {})
Thomas Bernard's avatar
Thomas Bernard committed
364

Romain Courteaud's avatar
Romain Courteaud committed
365 366 367
    # the whole process is now finished, 
    # just need to return editor for updating data
    return PlanningBoxEditor(field.id, update_dict)
368

Thomas Bernard's avatar
Thomas Bernard committed
369 370
  def getBlockPositionFromString(self, block_string):
    """
371
    Takes a string with block data and convert it to a list of dicts
Thomas Bernard's avatar
Thomas Bernard committed
372 373 374 375 376 377
    """
    block_list = []
    if block_string != '':
      block_object_list = block_string.split('*')
      for block_object_string in block_object_list:
        block_sub_list = block_object_string.split(',')
Romain Courteaud's avatar
Romain Courteaud committed
378 379 380 381 382 383 384 385 386
        block_dict = {
          'name': block_sub_list[0],
          'old_X': float(block_sub_list[1]),
          'old_Y': float(block_sub_list[2]),
          'new_X': float(block_sub_list[3]),
          'new_Y': float(block_sub_list[4]),
          'width': float(block_sub_list[5]),
          'height': float(block_sub_list[6]),
        }
Thomas Bernard's avatar
Thomas Bernard committed
387
        block_list.append(block_dict)
Romain Courteaud's avatar
Romain Courteaud committed
388
    return block_list
Thomas Bernard's avatar
Thomas Bernard committed
389

Romain Courteaud's avatar
Romain Courteaud committed
390
  def setBlockPositionToString(self, block_list):
Thomas Bernard's avatar
Thomas Bernard committed
391
    """
Romain Courteaud's avatar
Romain Courteaud committed
392
    Takes a list of dicts updated and convert it to a string in order to save
Thomas Bernard's avatar
Thomas Bernard committed
393 394 395 396 397 398 399 400
    it in the request
    """
    block_string = ''
    if block_list != []:
      block_object_list = []
      for block_dict in block_list:
        # property position is important that's why ','.join() is not used in
        # this case
Romain Courteaud's avatar
Romain Courteaud committed
401 402
        block_sub_string = '%(name)s,%(old_X)s,%(old_Y)s,%(new_X)s,' \
                           '%(new_Y)s,%(width)s,%(height)s' % block_dict
Thomas Bernard's avatar
Thomas Bernard committed
403 404
        block_object_list.append(block_sub_string)
      block_string = '*'.join(block_object_list)
Romain Courteaud's avatar
Romain Courteaud committed
405
    return block_string
406 407 408 409 410 411 412

  def getBlockObject(self, block_name, content_list):
    """
    recover the block related to the block_name inside the content_list
    """
    for block in content_list:
      if block.name == block_name:
413
        return block 
414 415


416
  def getDestinationGroup(self, basic, planning, block_moved, axis_groups,
Thomas Bernard's avatar
Thomas Bernard committed
417
                                group_position, group_length):
418 419 420 421 422 423 424 425
    """
    recover destination group from block coordinates and main axis coordinates
    block_moved is a dict of properties.
    returns the group object itself, none if the block has no good coordinates
    """
    good_group_name = ''
    # recovering group name
    for axis_name in axis_groups.keys():
Thomas Bernard's avatar
Thomas Bernard committed
426 427 428
      if  axis_groups[axis_name][group_position] < block_moved['center'] and \
          axis_groups[axis_name][group_position] + \
          axis_groups[axis_name][group_length] > block_moved['center']:
429 430 431 432
        # the center of the block is between group min and max bounds
        # the group we are searching for is known
        good_group_name = axis_name
        break
Thomas Bernard's avatar
Thomas Bernard committed
433
    # if no group is found, this means the block is outside the bounds
434 435 436
    if good_group_name == '':
      return None
    # group name is known, searching corresponding group object
437
    for group in planning.main_axis.axis_group:
438 439 440 441 442
      if group.name == good_group_name:
        return group
    return None


443
  def getDestinationBounds(self, basic, planning, block_moved, block_object,
444 445
                                 planning_coordinates, axis_length,
                                 destination_group=None):
446 447 448 449
    """
    check the new bounds of the block over the secondary axis according to its
    new position
    """
Thomas Bernard's avatar
Thomas Bernard committed
450
    error = 0
451 452 453 454 455
    # XXX CALENDAR
    # has to be improved : for now the axis bounds are recovered globally, it
    # implies that all groups have the same bounds, which is not the case in
    # calendar mode. for that will need to add special informations about the
    # group itself to know its own bounds.
456 457 458
    # => In case of calendar mode, axis_bounds are recovered from the
    #    destination group instead of the planning itself

Thomas Bernard's avatar
Thomas Bernard committed
459
    delta_start = block_moved['secondary_axis_position'] / \
460
                  planning_coordinates['frame']['planning_content'][axis_length]
Thomas Bernard's avatar
Thomas Bernard committed
461 462
    delta_stop  = (block_moved['secondary_axis_position'] + \
                  block_moved['secondary_axis_length']) / \
463
                  planning_coordinates['frame']['planning_content'][axis_length]
464 465 466 467

    # testing different cases of invalidation
    if delta_stop < 0 or delta_start > 1 :
      # block if fully out of the bounds
Thomas Bernard's avatar
Thomas Bernard committed
468 469
      # can not validate it : returning None
      error = 1
470 471 472
    else:
      if delta_start < 0 or delta_stop > 1:
        # part of the block is inside
473 474
        # should handle support for correcting bounds : user should not be able
        # to define any data out of its group bounds.
475 476
        pass

477
    if basic.calendar_mode:
478 479 480 481 482 483
      axis_range = destination_group.secondary_axis_range
      new_start = destination_group.secondary_axis_start + \
                  delta_start * axis_range
      new_stop = destination_group.secondary_axis_start + \
                  delta_stop * axis_range
    else:
484 485
      axis_range = basic.secondary_axis_info['bound_stop'] - \
                   basic.secondary_axis_info['bound_start']
Thomas Bernard's avatar
Thomas Bernard committed
486

487
      # defining new final block bounds
488
      new_start = basic.secondary_axis_info['bound_start'] + \
489
                  delta_start * axis_range
490
      new_stop  = basic.secondary_axis_info['bound_start'] + \
491
                  delta_stop * axis_range
Thomas Bernard's avatar
Thomas Bernard committed
492 493

    return [new_start,new_stop, error]
494

Thomas Bernard's avatar
Thomas Bernard committed
495 496
  def getActivityBounds(self, activity, activity_block_moved_list,
                              activity_block_list):
497
    """
498 499 500 501
    Recompose Activity from moved blocks.
    Warning : in case of calendar view, object bounds are not recomposed : only
              bounds of each activity are calculated, not object bounds !

502 503 504 505 506 507
    takes a list with modified blocks and another one with original blocks,
    returning new startactivity_block_moved_list & stop for the activity
    BEWARE : in case an activity bound was cut off to fit planning size, the
    value will not be updated (as the block was not on the real activity bound)
    """
    # getting list moved block names
508 509
    block_moved_name_list = [x['block_moved']['name'] for x in activity_block_moved_list]
    
510 511 512 513 514 515 516 517
    for activity_block in activity_block_list:
      if activity_block.name in block_moved_name_list:
        # the block composing the activity has been moved, not taking care of
        # the original one, but only the final position (block_moved)
        for temp_block_moved in activity_block_moved_list:
          # recovering corresponding moved block
          if temp_block_moved['block_moved']['name'] == activity_block.name:
            # moved block has been found
518 519
            temp_start = temp_block_moved['block_moved']['secondary_axis_start']
            temp_stop  = temp_block_moved['block_moved']['secondary_axis_stop']
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
            break
      else:
        # the block has not been moved
        temp_start = activity_block.position_secondary.absolute_begin
        temp_stop  = activity_block.position_secondary.absolute_end
      # once the start & stop values are recovered, need to test them to check
      # if it is needed to update
      try:
        if temp_start < new_start:
          new_start = temp_start
        if temp_stop > new_stop:
          new_stop = temp_stop
      except NameError:
        # new_start is not defined because it is the first block found
        new_start = temp_start
        new_stop = temp_stop

    # new start & stop values are known
538
    # checking weither activity has been cut-off to fit the planning bounds
539 540 541 542
    #if activity.secondary_axis_begin != activity.secondary_axis_start:
    #  new_start = activity.secondary_axis_begin
    #if activity.secondary_axis_end != activity.secondary_axis_stop:
    #  new_stop  = activity.secondary_axis_end
543 544 545

    return [new_start,new_stop]

546
  def getObjectDict(self, basic, planning):
547 548 549 550 551 552
    """
    Takes all activities related to a specified object and return
    """
    # init dict
    object_dict = {}
    # get property_names
553 554
    start_property = basic.field.get_value('x_start_bloc')
    stop_property = basic.field.get_value('x_stop_bloc')
555
    # get full axis length
556 557 558
    axis_start = basic.secondary_axis_info['bound_start']
    axis_stop  = basic.secondary_axis_info['bound_stop']
    for axis_group in planning.main_axis.axis_group:
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
      for axis_element in axis_group.axis_element_list:
        for activity in axis_element.activity_list:
          # for each activity, saving its properties into a dict
          if activity.link in object_dict.keys():
            object_dict[activity.link].append(
                       { 'activity_name' : activity.name,
                         'axis_start': activity.secondary_axis_start,
                         'axis_stop' : activity.secondary_axis_stop
                       })
          else:
            # need to add object start & stop properties
            object_start = activity.object.getProperty(start_property)
            object_stop = activity.object.getProperty(stop_property)
            # check if need to update start and stop.
            # according to general specifications, this can be done only if the
            # original object is not cut to fit view bounds :min and max bounds
            if object_start < axis_start:
              bound_start = 'no'
            else:
              bound_start = 'yes'
            if object_stop > axis_stop:
              bound_stop = 'no'
            else:
              bound_stop = 'yes'
            object_dict[activity.link] = \
                       [{ 'activity_name' : 'update',
                          'axis_start' : bound_start,
                          'axis_stop'  : bound_stop
                         }]
            # adding activity properties
            object_dict[activity.link].append(
                       { 'activity_name' : activity.name,
                         'axis_start': activity.secondary_axis_start,
                         'axis_stop' : activity.secondary_axis_stop
                       })
    return object_dict

Romain Courteaud's avatar
Romain Courteaud committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
class PlanningBoxEditor:
  """
  A class holding all values required to update objects
  """
  def __init__(self, field_id, update_dict):
    self.field_id = field_id
    self.update_dict = update_dict

  def view(self):
    return self.__dict__

  def __call__(self, REQUEST):
    # XXX Planning Box does not handle FormValidationError
    pass

  def edit(self, context):
    for url, kw in self.update_dict.items():
      context.restrictedTraverse(url).edit(**kw)

allow_class(PlanningBoxEditor)

617 618 619 620 621 622
class PlanningBoxWidget(Widget.Widget):
  """
  PlanningBox main class used to run all the process in order to generate
  the structure of the Planning including all internal properties.
  Contains BasicStructure and PlanningStructure instances
  """
Romain Courteaud's avatar
Romain Courteaud committed
623 624 625 626 627 628 629 630 631 632
  property_names = Widget.Widget.property_names + \
    ['js_enabled',
     # kind of display : horizontal or vertical
     'calendar_view',
     # number of groups over the main axis
     'main_axis_groups',
     # width properties
     'size_border_width_left', 'size_planning_width', 'size_y_axis_space',
     'size_y_axis_width',
     # height properties
633
     'use_date_zoom',
Romain Courteaud's avatar
Romain Courteaud committed
634 635 636 637 638
     'size_header_height', 'size_planning_height', 'size_x_axis_space',
     'size_x_axis_height',
     # axis position
     'y_axis_position', 'x_axis_position',
     'report_root_list', 'selection_name',
639
     # Main List Method
Romain Courteaud's avatar
Romain Courteaud committed
640 641
     'portal_types', 'sort',
     'list_method',
642 643
     # Second Layer Properties
     'second_layer_list_method',
Romain Courteaud's avatar
Romain Courteaud committed
644 645 646 647 648 649 650 651 652 653 654
     # method used to get title of each line
     'title_line',
     # specific block properties
     'x_start_bloc', 'x_stop_bloc', 'y_size_block',
     # name of scripts
     'stat_method', 'split_method', 'color_script',
     'round_script', 'sec_axis_script',
     # number of delimitations over the secondary axis
     'delimiter',
     # specific methods for inserting info block
     'info_center', 'info_topleft', 'info_topright',
Romain Courteaud's avatar
Romain Courteaud committed
655 656
     'info_backleft', 'info_backright',
     'info_tooltip'
Romain Courteaud's avatar
Romain Courteaud committed
657
     ]
658 659 660

  # Planning properties (accessed through Zope Management Interface)

661
  js_enabled = fields.CheckBoxField('js_enabled',
662
      title='enable on the fly edition (based on java script)',
663 664 665
      description='define if javascript is enabled or not on the current Planning',
      default=1,
      required=1)
666

667 668 669 670 671 672
  use_date_zoom = fields.CheckBoxField('use_date_zoom',
      title='Use Date Zoom (instead use Numerical Zoom)',
      description='Use Date Zoom instead use Numerical Zoom',
      default=0,
      required=0)

673 674
  # kind of representation to render :
  # Planning or Calendar
675 676 677
  calendar_view = fields.CheckBoxField('calendar_view',
      title='calendar view (vertical view)',
      description='define if need to changes axis order. By default Y axis is'
Romain Courteaud's avatar
Romain Courteaud committed
678
                  'main axis, but to display calendar main axis must be X one.',
679
      default=0,
680 681 682 683 684 685
      required=1)

  # added especially for new Planning Structure generation
  # is used to split result in pages in a ListBox like rendering
  # (delimitation over the main axis)
  main_axis_groups = fields.IntegerField('main_axis_groups',
686
      title='groups per page on main axis',
Romain Courteaud's avatar
Romain Courteaud committed
687
      description='number of groups displayed per page on main axis',
688 689 690 691 692
      default=10,
      required=1)

  # setting header height
  size_header_height = fields.IntegerField('size_header_height',
693
      title='header height',
Romain Courteaud's avatar
Romain Courteaud committed
694
      description='height of the planning header',
695 696 697 698 699 700
      default=100,
      required=1)

  # setting left border size
  size_border_width_left = fields.IntegerField('size_border_width_left',
      title='Size border width left',
Romain Courteaud's avatar
Romain Courteaud committed
701
      description='setting left border size',
702 703 704 705 706
      default=10,
      required=1)

  # setting the width of the Planning (excl. Y axis : only the block area)
  size_planning_width = fields.IntegerField('size_planning_width',
707
      title='Planning width',
Romain Courteaud's avatar
Romain Courteaud committed
708
      description='size of the planning area, excluding axis size',
709 710 711 712 713
      default=1000,
      required=1)

  # setting the with of the Y axis
  size_y_axis_width = fields.IntegerField('size_y_axis_width',
714
      title='Y axis width',
Romain Courteaud's avatar
Romain Courteaud committed
715
      description='width of the Y axis',
716 717 718 719 720
      default=200,
      required=1)

  # setting the with of the space (between Planning and Y axis)
  size_y_axis_space = fields.IntegerField('size_y_axis_space',
721
      title='Y axis space',
Romain Courteaud's avatar
Romain Courteaud committed
722
      description='space between Y axis and PLanning content',
723 724 725 726 727
      default=10,
      required=1)

  # setting the height of the Planning (excl. X axis)
  size_planning_height = fields.IntegerField('size_planning_height',
728
      title='Planning height',
Romain Courteaud's avatar
Romain Courteaud committed
729
      description='size of the planning area, excluding axis_size',
730 731 732 733 734
      default=800,
      required=1)

  # setting the height of the X axis
  size_x_axis_height = fields.IntegerField('size_x_axis_height',
735
      title='X axis height',
Romain Courteaud's avatar
Romain Courteaud committed
736
      description='height of the X axis',
737 738 739 740 741
      default=200,
      required=1)

  # setting the height of the space (between Planning and X axis)
  size_x_axis_space = fields.IntegerField('size_x_axis_space',
742
      title='X axis space',
Romain Courteaud's avatar
Romain Courteaud committed
743
      description='space between X axis and Planning content',
744 745 746 747
      default=10,
      required=1)


748 749
  y_axis_position = fields.CheckBoxField('y_axis_position',
      title='Force Y axis to the right intead of left',
Romain Courteaud's avatar
Romain Courteaud committed
750 751 752 753 754
      description='position of Y axis over the planning content.' \
                  'If checked, the Y axis will match the right border' \
                  'of the planning, otherwise default is applied : left',
      default=0,
      required=1)
755

756 757
  x_axis_position = fields.CheckBoxField('x_axis_position',
      title='Force X axis to the bottom instead of top',
Romain Courteaud's avatar
Romain Courteaud committed
758 759 760 761
      description='position of X axis over the planning content.' \
                  'default is top, if checked then right apply',
      default=0,
      required=1)
762 763


764 765
  default = fields.TextAreaField('default',
      title='Default',
Romain Courteaud's avatar
Romain Courteaud committed
766
      description="Default value of the text in the widget.",
767 768 769 770 771
      default="",
      width=20, height=3,
      required=0)


772
  delimiter = fields.IntegerField('delimiter',
773
      title='min number of delimiters over the secondary axis',
Romain Courteaud's avatar
Romain Courteaud committed
774 775
      description="min number of delimitations over the sec axis, required",
      default=5,
776
      required=1)
777 778 779

  report_root_list = fields.ListTextAreaField('report_root_list',
      title="Report Root",
Romain Courteaud's avatar
Romain Courteaud committed
780
      description="A list of domains which define the possible root.",
781 782 783 784 785 786
      default=[],
      required=0)

  selection_name = fields.StringField('selection_name',
      title='Selection Name',
      description=("The name of the selection to store selections params"),
787 788
      default='planning_0',
      required=1)
789 790 791

  portal_types = fields.ListTextAreaField('portal_types',
      title="Portal Types",
Romain Courteaud's avatar
Romain Courteaud committed
792
      description="Portal Types of objects to list. Required.",
793 794 795 796 797
      default=[],
      required=0)

  sort = fields.ListTextAreaField('sort',
      title='Default Sort',
Romain Courteaud's avatar
Romain Courteaud committed
798
      description="The default sort keys and order",
799 800 801 802 803
      default=[],
      required=0)

  list_method = fields.MethodField('list_method',
      title='List Method',
Romain Courteaud's avatar
Romain Courteaud committed
804
      description="Method to use to list objects",
Rafael Monnerat's avatar
Rafael Monnerat committed
805
      default='',
806 807
      required=0)

808 809 810 811 812 813 814
  second_layer_list_method = fields.MethodField('second_layer_list_method',
     title='Secondary Layer List Method',
     description="Method to use to list background objects",
     default='',
     required=0)


815
  title_line = fields.StringField('title_line',
Rafael Monnerat's avatar
Rafael Monnerat committed
816
      title="Specific method which fetches the title of each line",
Romain Courteaud's avatar
Romain Courteaud committed
817
      description="Method for inserting title in line",
818 819 820 821
      default='',
      required=0)

  x_start_bloc = fields.StringField('x_start_bloc',
Rafael Monnerat's avatar
Rafael Monnerat committed
822
      title='Specific property to get start of blocks (ex. start_date)',
Romain Courteaud's avatar
Romain Courteaud committed
823 824
      description='Property for building X-Axis such as start_date ' \
                  'objects',
Thomas Bernard's avatar
Thomas Bernard committed
825
      default='start_date',
826 827 828
      required=0)

  x_stop_bloc = fields.StringField('x_stop_bloc',
Rafael Monnerat's avatar
Rafael Monnerat committed
829
      title='Specific property to get stop of blocks (ex. stop_date)',
Romain Courteaud's avatar
Romain Courteaud committed
830 831
      description='Property for building X-Axis such as stop_date ' \
                  'objects',
Thomas Bernard's avatar
Thomas Bernard committed
832
      default='stop_date',
833
      required=0)
834

835
  y_size_block = fields.StringField('y_size_block',
836
      title='Specific Method to set relative height of blocks',
Romain Courteaud's avatar
Romain Courteaud committed
837
      description='Method for building height of blocks objects',
838
      default='quantity',
839
      required=0)
840 841 842

  constraint_method = fields.StringField('constraint_method',
      title='name of constraint method between blocks',
Romain Courteaud's avatar
Romain Courteaud committed
843
      description='Constraint method between blocks objects',
844 845 846
      default='SET_DHTML',
      required=1)

847
  stat_method = fields.StringField('stat_method',
Rafael Monnerat's avatar
Rafael Monnerat committed
848
      title="Name of script generating statistics",
Romain Courteaud's avatar
Romain Courteaud committed
849
      description="script for statistics",
850 851 852
      default='',
      required=0)

853
  split_method = fields.StringField('split_method',
Rafael Monnerat's avatar
Rafael Monnerat committed
854
      title='Name of script splitting activities into blocks',
Romain Courteaud's avatar
Romain Courteaud committed
855
      description="script for splitting activities into multiple blocks",
856 857 858
      default='',
      required=0)

859
  color_script = fields.StringField('color_script',
Rafael Monnerat's avatar
Rafael Monnerat committed
860
      title='Name of script colorizing blocks',
Romain Courteaud's avatar
Romain Courteaud committed
861
      description='script for block colors object',
862 863 864
      default='',
      required=0)

Thomas Bernard's avatar
Thomas Bernard committed
865
  round_script = fields.StringField('round_script',
Romain Courteaud's avatar
Romain Courteaud committed
866 867 868
      title='Name of script rounding blocks during validation (ex. ' \
            'Planning_roundBoundToDay)',
      description='script for block bounds rounding when validating',
869
      default='',
Thomas Bernard's avatar
Thomas Bernard committed
870 871
      required=0)

872

Thomas Bernard's avatar
Thomas Bernard committed
873
  sec_axis_script = fields.StringField('sec_axis_script',
Romain Courteaud's avatar
Romain Courteaud committed
874 875 876
      title='Name of script building secondary axis (ex. ' \
            'Planning_generateAxis)',
      description='Script for building secondary axis',
877
      default='Planning_generateAxis',
878
      required=1)
Thomas Bernard's avatar
Thomas Bernard committed
879

880
  info_center = fields.StringField('info_center',
Romain Courteaud's avatar
Romain Courteaud committed
881 882 883 884
      title='Specific method of data called for inserting info in ' \
            'block center',
      description='Method for displaying info in the center of a ' \
                  'block object',
885
      default='',
886
      required=0)
887 888

  info_topright = fields.StringField('info_topright',
Romain Courteaud's avatar
Romain Courteaud committed
889 890 891 892
      title='Specific method of data called for inserting info in '\
            'block topright',
      description='Method for displaying info in the topright of a block ' \
                  'object',
893 894 895 896
      default='',
      required=0)

  info_topleft = fields.StringField('info_topleft',
Romain Courteaud's avatar
Romain Courteaud committed
897 898 899 900
      title='Specific method of data called for inserting info in ' \
            'block topleft',
      description='Method for displaying info in the topleft corner ' \
                  'of a block object',
901 902 903 904
      default='',
      required=0)

  info_backleft = fields.StringField('info_backleft',
Romain Courteaud's avatar
Romain Courteaud committed
905 906 907 908
      title='Specific method of data called for inserting info in '\
            'block backleft',
      description='Method for displaying info in the backleft of a ' \
                  'block object',
909 910 911 912
      default='',
      required=0)

  info_backright = fields.StringField('info_backright',
Romain Courteaud's avatar
Romain Courteaud committed
913 914 915 916
      title='Specific method of data called for inserting info in '
            'block backright',
      description='Method for displaying info in the backright of a ' \
                  'block object',
917 918 919
      default='',
      required=0)

Romain Courteaud's avatar
Romain Courteaud committed
920 921 922 923 924 925 926 927
  info_tooltip = fields.StringField('info_tooltip',
      title='Specific method of data called for inserting info in '
            'block tooltip',
      description='Method for displaying info as tootip of a ' \
                  'block object',
      default='',
      required=0)

928
  security_index = fields.IntegerField('security_index',
Rafael Monnerat's avatar
Rafael Monnerat committed
929
      title='Variable depending on the type of web browser :',
Romain Courteaud's avatar
Romain Courteaud committed
930 931
      description='This variable is used because the rounds of each ' \
                  'web browser seem to work differently',
932 933 934
      default=2,
      required=0)

935 936 937 938 939 940 941 942 943 944 945 946 947
  def get_javascript_list(self, field, REQUEST=None):
    """
    Returns list of javascript needed by the widget
    """
    if field.get_value('js_enabled'):
      context = getContext(field, REQUEST)
      # XXX Instead of harcoding library name
      # it should be better to call a python script, as
      # it is done on type base method.
      return ['%s/wz_dragdrop.js' % context.portal_url.getPortalPath()]
    else:
      return []

948
  def render_css(self, field, REQUEST):
949 950 951 952 953 954
    """
    first method called for rendering by PageTemplate form_view
    create the whole object based structure, and then call a special
    external PageTemplate (or DTML depending) to render the CSS code
    relative to the structure that need to be rendered
    """
955
    context = getContext(field, REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
956 957 958 959
    # build structure
    # render_structure will call all method necessary to build the entire
    # structure relative to the planning
    # creates and fill up self.basic, self.planning and self.build_error_list
960 961
    basic, planning = self.render_structure(field=field, REQUEST=REQUEST, 
                                            context=context)
Thomas Bernard's avatar
Thomas Bernard committed
962
    # getting CSS script generator
963
    planning_css_method = getattr(context, 'planning_css')
Thomas Bernard's avatar
Thomas Bernard committed
964
    # recover CSS data buy calling DTML document
965
    CSS_data = planning_css_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
966
    # saving structure inside the request for HTML render
Romain Courteaud's avatar
Romain Courteaud committed
967
    # XXX This prevent multiple planning box on the same form
968 969
    REQUEST.set('basic', basic)
    REQUEST.set('planning', planning)
970

Thomas Bernard's avatar
Thomas Bernard committed
971
    return CSS_data
972

Romain Courteaud's avatar
Romain Courteaud committed
973
  def render(self, field, key, value, REQUEST):
974
    """
975
    Method called to render the HTML code relative to the planning.
976 977 978 979 980 981 982
    for that recover the structure previouly saved in the REQUEST, and then
    call a special Page Template aimed to render
    """
    # need to test if render is HTML (to be implemented in a page template)
    # or list (to generated a PDF output or anything else).

    # recover structure
983 984
    basic = REQUEST.get('basic')
    planning = REQUEST.get('planning')
985

Thomas Bernard's avatar
Thomas Bernard committed
986
    # getting HTML rendering Page Template
987 988
    planning_html_method = getattr(getContext(field, REQUEST), 
                                   'planning_content')
Thomas Bernard's avatar
Thomas Bernard committed
989
    # recovering HTML data by calling Page Template document
990
    HTML_data = planning_html_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
991 992
    # return HTML data
    return HTML_data
993

994
  def render_structure(self, field, REQUEST, context):
Romain Courteaud's avatar
Romain Courteaud committed
995 996 997 998 999 1000 1001 1002
    """
    This method is the begining of the rendering procedure. it calls all
    methods needed to generate BasicStructure with ERP5 objects, and then
    creates the PlanningStructure before applying zoom.
    No code is generated (for example HTML code) contrary to the previous
    implementation of PlanningBox. The final rendering must be done through
    a PageTemplate parsing the PlanningStructure object.
    """
Thomas Bernard's avatar
Thomas Bernard committed
1003 1004 1005
    # XXX testing : uncoment to put selection to null => used for debugging
    #here.portal_selections.setSelectionFor(selection_name, None)
    ####### DATA DEFINITION #######
1006
    # recovering usefull planning properties
1007 1008 1009
    # getting form
    form = field.aq_parent
    list_method = field.get_value('list_method')
1010
    sec_layer_list_method = field.get_value('second_layer_list_method')
1011 1012 1013 1014
    title_line = field.get_value('title_line')
    # list of domain
    report_root_list = field.get_value('report_root_list')
    portal_types = field.get_value('portal_types')
1015
    # selection name used to store selection params
Sebastien Robin's avatar
Sebastien Robin committed
1016
    selection_name = field.get_value('selection_name')
1017
    # getting sorting keys and order (list)
Sebastien Robin's avatar
Sebastien Robin committed
1018
    sort = field.get_value('sort')
1019 1020
    # contains the list of blocks that are not validated
    # for them a special rendering is done (special colors for example)
Romain Courteaud's avatar
Romain Courteaud committed
1021 1022 1023
    list_error = REQUEST.get('list_block_error')
    if list_error is None:
      list_error = []
1024
    selection = context.portal_selections.getSelectionFor(
1025 1026 1027 1028 1029
                      selection_name, REQUEST)
    # params contained in the selection object is a dictionnary.
    # must exist as an empty dictionnary if selection is empty.
    try:
      params = selection.getParams()
Romain Courteaud's avatar
Romain Courteaud committed
1030
    except (AttributeError, KeyError):
1031
      params = {}
Romain Courteaud's avatar
Romain Courteaud committed
1032

Thomas Bernard's avatar
Thomas Bernard committed
1033
    ###### CALL CLASS METHODS TO BUILD BASIC STRUCTURE ######
1034
    # creating BasicStructure instance (and initializing its internal values)
1035 1036
    basic = BasicStructure(context=context,
                           form=form, field=field,
1037 1038 1039
                           REQUEST=REQUEST, 
                           list_method=list_method,
                           sec_layer_list_method=sec_layer_list_method,
1040 1041 1042 1043
                           selection=selection, params=params,
                           selection_name=selection_name,
                           title_line=title_line,
                           report_root_list=report_root_list,
1044
                           portal_types=portal_types, 
1045 1046
                           sort=sort,
                           list_error=list_error)
1047
    # call build method to generate BasicStructure
1048
    status = basic.build()
Thomas Bernard's avatar
Thomas Bernard committed
1049
    if status != 1:
1050
      raise PlanningBoxError, status
1051

Thomas Bernard's avatar
Thomas Bernard committed
1052
    ###### CALL CLASS METHODS TO BUILD PLANNING STRUCTURE ######
1053
    # creating PlanningStructure instance and initializing its internal values
1054
    planning = PlanningStructure()
1055
    # call build method to generate final Planning Structure
1056 1057 1058
    status = planning.build(basic_structure=basic,
                            field=field,
                            REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
1059 1060
    if status != 1:
      # in case error during planning structure generation
1061
      raise PlanningBoxError, status
1062

1063
    return basic, planning
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

# instanciating class
PlanningBoxWidgetInstance = PlanningBoxWidget()

class BasicStructure:
  """
  First Structure recovered from ERP5 objects. Does not represent in any
  way the final structure used for rendering the Planning (for that see
  PlanningStructure class). for each returned object from ERP5's request,
  create a BasicGroup and stores all object properties.
  No zoom is applied on this structure
  """

1077
  def __init__ (self, context='', form='', field='', REQUEST='', list_method='',
Romain Courteaud's avatar
Romain Courteaud committed
1078 1079
                selection=None, params = '', selection_name='',
                report_root_list='', title_line='', portal_types='',
1080
                sec_layer_list_method=None, sort=None, list_error=None):
1081 1082
    """
    Init main internal parameters
Rafael Monnerat's avatar
Rafael Monnerat committed
1083
    """
1084
    self.context = context
1085 1086 1087 1088 1089 1090 1091
    self.form = form
    self.field = field
    self.REQUEST = REQUEST
    self.sort = sort
    self.selection = selection
    self.params = params
    self.list_method = list_method
1092
    self.sec_layer_list_method = sec_layer_list_method
1093
    self.title_line = title_line
Thomas Bernard's avatar
Thomas Bernard committed
1094
    self.selection_name = selection_name
1095 1096
    self.report_root_list = report_root_list
    self.portal_types = portal_types
1097
    self.basic_group_list = []
Romain Courteaud's avatar
Romain Courteaud committed
1098 1099
    # needed to generate groups
    self.report_groups= ''
1100 1101
    self.list_error = list_error
    self.secondary_axis_occurence = []
Romain Courteaud's avatar
Romain Courteaud committed
1102 1103 1104
    # 'list' in case output is a list containing the
    # full planning structure without any selection
    self.render_format = ''
1105 1106 1107 1108 1109
    self.main_axis_info = {}
    self.secondary_axis_info = {}

  def build(self):
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1110
    Build BasicStructure from given parameters, and for that do the
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
    specified processes :
    1 - define variables
    2 - building query
    3 - generate report_tree, a special structure containing all the
        objects with their values
    4 - create report_sections
    """
    default_params ={}
    current_section = None
    #params = self.selection.getParams()

    #recovering selection if necessary
1123
    # XXX Use selection tool API
1124
    if self.selection is None:
Thomas Bernard's avatar
Thomas Bernard committed
1125 1126
      self.selection = Selection(params=default_params,
                                 default_sort_on=self.sort)
Sebastien Robin's avatar
Sebastien Robin committed
1127
    else:
1128 1129 1130 1131
      # immediately updating the default sort value
      self.selection.edit(default_sort_on=self.sort)
      self.selection.edit(sort_on=self.sort)

1132
    self.context.portal_selections.setSelectionFor(
Romain Courteaud's avatar
Romain Courteaud committed
1133 1134 1135
                                        self.selection_name,
                                        self.selection,
                                        REQUEST=self.REQUEST)
1136
    # building list of portal_types
Romain Courteaud's avatar
Romain Courteaud committed
1137
    self.filtered_portal_types = [x[0] for x in self.portal_types]
1138 1139 1140 1141 1142 1143 1144
    if len(self.filtered_portal_types) == 0:
      self.filtered_portal_types = None

    report_depth = self.REQUEST.get('report_depth',None)
    # In report tree mode, need to remember if the items have to be displayed
    is_report_opened = self.REQUEST.get('is_report_opened',\
                                    self.selection.isReportOpened())
1145
    self.selection.edit(report_opened=is_report_opened)
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
    portal_categories = getattr(self.form,'portal_categories',None)
    portal_domains = getattr(self.form,'portal_domains',None)

    ############### BUILDING QUERY ###################
    kw = self.params
    # remove selection_expression if present
    # This is necessary for now, because the actual selection expression in
    # search catalog does not take the requested columns into account. If
    # select_expression is passed, this can raise an exception, because stat
    # method sets select_expression, and this might cause duplicated column
    # names.
    if 'select_expression' in kw:
      del kw['select_expression']
1159

1160
    sec_layer_method_name = None
1161
    if getattr(self.sec_layer_list_method, 'method_name', None) is not None:
1162 1163 1164 1165
         sec_layer_method_name = self.sec_layer_list_method.method_name
         self.sec_layer_list_method = getattr( self.context,
                                          sec_layer_method_name, None)

1166
    if getattr(self.list_method, 'method_name', None) is not None:
1167 1168
      if self.list_method.method_name == 'ObjectValues':
        # list_method is available
1169
        self.list_method = self.context.objectValues
1170
        kw = copy(self.params)
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
      else:
        # building a complex query so we should not pass too many variables
        kw={}
        if self.REQUEST.form.has_key('portal_type'):
          kw['portal_type'] = self.REQUEST.form['portal_type']
        elif self.REQUEST.has_key('portal_type'):
          kw['portal_type'] = self.REQUEST['portal_type']
        elif self.filtered_portal_types is not None:
          kw['portal_type'] = self.filtered_portal_types
        elif kw.has_key('portal_type'):
          if kw['portal_type'] == '':
            del kw['portal_type']
        # remove useless matter
        for cname in self.params.keys():
Romain Courteaud's avatar
Romain Courteaud committed
1185
          if self.params[cname] != '' and self.params[cname] is not None:
1186 1187 1188
            kw[cname] = self.params[cname]
        # try to get the method through acquisition
        try:
1189
          self.list_method = getattr(self.context, self.list_method.method_name)
1190 1191 1192 1193 1194 1195
        except (AttributeError, KeyError):
          pass
    elif self.list_method in (None,''):
      # use current selection
      self.list_method = None

1196 1197
    ############## DEFINING STAT METHOD ##############
    stat_method = self.field.get_value('stat_method')
1198
    stat_method = getattr(self.context, stat_method, None)
Romain Courteaud's avatar
Romain Courteaud committed
1199
    if stat_method is None:
1200
      show_stat = 0
1201 1202
    else:
      show_stat = 1
1203

1204 1205 1206 1207 1208
    ############ BUILDING REPORT_TREE ################
    # assuming result is report tree, building it
    # When building the body, need to go through all report lines
    # each report line is a tuple of the form :
    #(selection_id, is_summary, depth, object_list, object_list_size, is_open)
1209

1210 1211 1212 1213 1214 1215
    default_selection_report_path = self.report_root_list[0][0].split('/', 1)[0]
    if (portal_categories is None or \
        portal_categories._getOb(default_selection_report_path, None) is None) \
       and (portal_domains is None or \
          portal_domains._getOb(default_selection_report_path, None) is None):
      default_selection_report_path = self.report_root_list[0][0]
1216

1217 1218 1219
    self.selection_report_path = self.selection.getReportPath(
                                  default=default_selection_report_path)

1220 1221 1222
    if self.selection_report_path in (None, ()):
      LOG("BasicStructure",0 ,"report path is empty or not valid on  %s" % \
                      self.field.absolute_url())
1223 1224 1225

    # testing report_depth value
    if report_depth is not None:
1226
      selection_report_current = ()
1227 1228
    else:
      selection_report_current = self.selection.getReportList()
1229
 
1230
    # building report_tree_list
1231
    report_tree_list = makeTreeList(here=self.context, form=self.form,
Thomas Bernard's avatar
Thomas Bernard committed
1232
                                    root_dict=None,
1233
                                    report_path=self.selection_report_path,
Thomas Bernard's avatar
Thomas Bernard committed
1234 1235 1236
                                    base_category=None, depth=0,
                                    unfolded_list=selection_report_current,
                                    selection_name=self.selection_name,
1237
                                    report_depth=report_depth,
1238
                                    list_method=self.list_method,
Rafael Monnerat's avatar
Rafael Monnerat committed
1239
                                    filtered_portal_types= \
1240
                                                self.filtered_portal_types,
1241 1242 1243
                                    is_report_opened=is_report_opened,
                                    sort_on=self.selection.sort_on,
                                    form_id=self.form.id)
1244

1245 1246 1247
    if report_tree_list == []:
      LOG("BasicStructure",0 ,"Report tree list is empty on %s" % 
                      self.field.absolute_url())
1248

1249 1250 1251 1252 1253 1254
    ########### GETTING MAIN AXIS BOUNDS #############
    # before building group_object structure, need to recover axis begin & end
    # for main to be able to generate a 'smart' structure taking into account
    # only the area that need to be rendered. This prevents from useless
    # processing
    # calculating main axis bounds
1255
    self.main_axis_info = self.getMainAxisInfo(report_tree_list)
1256 1257 1258 1259
    # applying main axis selection
    if report_tree_list != []:
      report_tree_list=report_tree_list[self.main_axis_info['bound_start']:
                                         self.main_axis_info['bound_stop']]
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274

    ########### BUILDING REPORT_GROUPS ###############
    # report_groups is another structure based on report_tree but
    # taking care of the object activities.
    # build two structures :
    # - report_groups : list of object_tree_lines composing the planning,
    #   whatever the current group depth, just listing all of them
    # - blocks_object : dict (object_tree_line.getObject()) of objects
    # (assuming objects is a list of activities).

    # first init parameters
    self.report_groups = []
    list_object = []
    self.nbr_groups=0
    object_list=[]
1275
    sec_layer_object_list=[]
1276 1277
    build_object_list = []
    build_sec_layer_object_list = []
1278 1279 1280
    self.report_activity_dict = {}
    indic_line=0
    index_line=0
1281
    blocks_object={}
1282
    select_expression = ''
1283
    self.sec_layer_uid_list = []
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
    self.selection.edit(params = kw)
    if self.list_method not in (None,''):
      # valid list_method has been found
      build_object_list = self.selection(method = self.list_method,
                    context=self.context, REQUEST=self.REQUEST)

    # Defining the Secondary Layer Object List
    if self.sec_layer_list_method not in (None,''):
      build_sec_layer_object_list = self.selection(
                      method=self.sec_layer_list_method,
                      context=self.context,
                      REQUEST=self.REQUEST)

1297
    # now iterating through report_tree_list
1298 1299 1300 1301 1302
    for object_tree_line in report_tree_list:
      # prepare query by defining selection report object
      # defining info_dict, holding all information about the current object.
      info_dict = None
      info_dict = {}
1303
      object_list = []
1304 1305 1306 1307 1308 1309
      if object_tree_line.getIsPureSummary() and show_stat:
        info_dict['stat'] = 1
        # push new select_expression
        original_select_expression = kw.get('select_expression')
        kw['select_expression'] = select_expression
        self.selection.edit(params = kw)
1310 1311
        # recovering statistics if needed
        # getting list of statistic blocks
Thomas Bernard's avatar
Thomas Bernard committed
1312 1313
        stat_list = stat_method(selection=self.selection,
                                list_method=self.list_method,
1314
                                selection_context=self.context,
Thomas Bernard's avatar
Thomas Bernard committed
1315 1316 1317
                                report_tree_list=report_tree_list,
                                object_tree_line=object_tree_line,
                                REQUEST=self.REQUEST, field=self.field)
1318

1319 1320 1321 1322
        if original_select_expression is None:
          del kw['select_expression']
        else:
          kw['select_expression'] = original_select_expression
1323
        
1324 1325 1326 1327 1328 1329 1330
        # adding current line to report_section where
        # line is pure Summary
        self.report_groups += [(object_tree_line,stat_list,info_dict)]
        self.nbr_groups += 1

      else:
        info_dict['stat'] = 0
1331
        domain_obj = object_tree_line.getObject()
1332
        sec_layer_object_list = []
1333 1334
        if self.selection_report_path == 'parent':
          object_list = [object_tree_line.getObject()]
1335 1336 1337 1338
          if sec_layer_method_name not in (None,''):
            sec_layer_object_list = getattr(domain_obj,\
                            sec_layer_method_name)()
           
1339
        # Default Values
1340
        new_object_list = []
1341
        sec_new_object_list = []
1342 1343
        if domain_obj.getPortalType() == 'Domain':
          category_obj = domain_obj.getMembershipCriterionCategory()
1344
          for bc in domain_obj.getMembershipCriterionBaseCategoryList():
1345
            if (category_obj is not None) and (bc is not None):
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
              if bc == 'parent':
                new_object_list.extend([ s_obj for s_obj in build_object_list \
                    if s_obj.getParentRelativeUrl() == category_obj])
                sec_new_object_list.extend([ s_obj for s_obj in build_sec_layer_object_list \
                    if s_obj.getParentRelativeUrl() == category_obj])
              else:
                new_object_list.extend([ s_obj for s_obj in build_object_list \
                  if s_obj._getDefaultAcquiredCategoryMembership(bc) == category_obj])
                sec_new_object_list.extend([ s_obj for s_obj in build_sec_layer_object_list \
                  if s_obj._getDefaultAcquiredCategoryMembership(bc) == category_obj])
1356

1357
          object_list = new_object_list
1358
          sec_layer_object_list = sec_new_object_list
1359

1360 1361
        # recovering exeption_uid_list
        exception_uid_list = object_tree_line.getExceptionUidList()
1362
        if exception_uid_list not in ([], None, ()) :
1363 1364 1365
          # Filter folders if parent tree :
          # build new object_list for current line
          # (list of relative elements)
1366 1367
          new_object_list = [s_obj for s_obj in object_list \
                             if s_obj.getUid() not in exception_uid_list]
1368
          sec_new_object_list = [s_obj for s_obj in sec_layer_object_list \
1369 1370 1371
                                 if s_obj.getUid() not in exception_uid_list]

          sec_layer_object_list = sec_new_object_list
1372 1373
          object_list = new_object_list

1374
        self.sec_layer_uid_list.extend([obj.getUid() for obj in sec_layer_object_list])
1375 1376 1377 1378
        # The order is important 
        sec_layer_object_list.extend(object_list)
        object_list = sec_layer_object_list

1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
        if not object_tree_line.getIsPureSummary():
          # Object is not pure summary
          if show_stat:
            # this represents the second duplicated object
            # display object content in report tree with stat
            # stats are displayed in the first object present
            self.report_groups += [(object_tree_line,object_list, info_dict)]
            self.nbr_groups += 1
        else:
          # object is pure summary !
          if len(object_list) and object_tree_line.is_open:
            # pure summary, open, and has object_list
            # case = ?!?
            self.report_groups += [(object_tree_line, object_list, info_dict)]
            self.nbr_groups += 1
          else:
1395
            if exception_uid_list not in [None, [], ()]:
1396 1397
              # case of parent tree mode (first/unique object).
              # beware object_list is not null in case folded sons exists so
Thomas Bernard's avatar
Thomas Bernard committed
1398 1399
              # do not export voluntary object_list to prevent bad
              # interpretation
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
              self.report_groups += [(object_tree_line, [], info_dict)]
              self.nbr_groups += 1
            else:
              # case of report_tree mode
              # saving information in report_groups
              self.report_groups += [(object_tree_line,object_list,info_dict)]
              self.nbr_groups += 1


    # reset to original value
    self.selection.edit(report = None)
1411
    #self.selection.edit(report_list=None) # comment to save report_list status
1412

1413 1414 1415
    # update report list if report_depth was specified
    if report_depth is not None:
      unfolded_list = []
1416 1417
      for (report_line, object_list, info_dict) in self.report_groups:
        if report_line.depth < report_depth and not info_dict['stat'] :
Thomas Bernard's avatar
Thomas Bernard committed
1418 1419 1420
          # depth of current report_line is inferior to the current
          # report_depth and current report_line is not stat line.
          # saving information
1421 1422 1423
          unfolded_list.append(report_line.getObject().getRelativeUrl())
      self.selection.edit(report_list=unfolded_list)

Thomas Bernard's avatar
Thomas Bernard committed
1424

1425
    ############## CHECKING CONSTRAINTS ##############
1426
    # XXX Constraints checking should be called here
1427 1428 1429
    # and results saved in a list (list of url corresponding to objects not
    # validated)

1430
    ############ GETTING SEC AXIS BOUNDS #############
Thomas Bernard's avatar
Thomas Bernard committed
1431 1432
    # now that our report_group structure has been cut need to get secondary
    # axis bounds to add only the blocs needed afterwards
1433 1434
    # getting secondary_axis_occurence to define begin and end secondary_axis
    # bounds (getting absolute size)
1435
    self.secondary_axis_occurence = self.getSecondaryAxisOccurence()
1436 1437 1438 1439
    # XXX changing point of view to handle axis occurences : their are now
    # handled by group, so that it is easy to recover group bounds in case the
    # current rendering is calendar mode.

1440 1441
    # now getting start & stop bounds (getting relative size to the current
    # rendering)
1442
    self.secondary_axis_info = self.getSecondaryAxisInfo()
1443 1444 1445 1446

    ####### SAVING NEW PROPERTIES INTO REQUEST #######
    if self.list_method is not None and self.render_format != 'list':
     self.selection.edit(params = self.params)
1447
     self.context.portal_selections.setSelectionFor(self.selection_name,
Thomas Bernard's avatar
Thomas Bernard committed
1448 1449
                                                 self.selection,
                                                 REQUEST = self.REQUEST)
1450 1451 1452 1453 1454 1455 1456

    ######### BUILDING GROUP_OBJECT STRUCTURE ########
    # building group_object structure using sub lines depth (in case of a
    # report tree) by doing this.
    # taking into account page bounds to generate only the structure needed
    # instanciate BasicGroup class in BasicStructure so that the structure can
    # be built
1457
    self.buildGroupStructure()
1458 1459 1460
    # everything is fine
    return 1

1461 1462
  def getSecondaryAxisOccurence(self):
    """
Thomas Bernard's avatar
Thomas Bernard committed
1463 1464 1465
    get secondary_axis occurences in order to define begin and end bounds.
    Just make a listing of all the start and stop values for all the
    report_group objects
1466 1467
    """
    secondary_axis_occurence = []
1468 1469

    # defining the objects requested for calendar mode testing
1470
    if 'parent' in self.selection_report_path :
1471 1472 1473 1474 1475 1476 1477
      calendar_mode = 0
    else:
      calendar_mode = 1 # assuming calendar_mode = 1 by default.
    calendar_range = 0  # range max on the current calendar mode. used for
                        # example while dealing with months : 31 is saved as
                        # the largest range, even if some month have only 28
                        # to 30 days
1478 1479

    # specific start & stop methods name for secondary axis
Thomas Bernard's avatar
Thomas Bernard committed
1480 1481
    start_property_id = self.field.get_value('x_start_bloc')
    stop_property_id= self.field.get_value('x_stop_bloc')
1482
    for (object_tree_group, object_list, info_dict) in self.report_groups:
1483 1484 1485 1486 1487
      # defining empty list for each kind of occurence.
      group_list = []
      item_list = []

      # recovering group_properties
Romain Courteaud's avatar
Romain Courteaud committed
1488
      if start_property_id is not None:
1489 1490 1491 1492 1493 1494 1495 1496
        group_start = \
        object_tree_group.object.getObject().getProperty(start_property_id,
                                                         None)
        if object_tree_group.object.getObject().hasProperty('start_date'):
          group_start = \
          object_tree_group.object.getObject().start_date
      else:
        group_start= None
Romain Courteaud's avatar
Romain Courteaud committed
1497
      if stop_property_id is not None:
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
        group_stop = \
        object_tree_group.object.getObject().getProperty(stop_property_id,None)
        if object_tree_group.object.getObject().hasProperty('stop_date'):
          group_stop = \
          object_tree_group.object.getObject().stop_date
      else:
        group_stop = None

      group_list = [[group_start, group_stop]]

      # no calendar mode available if group has no valid bounds.
      if None in [group_start,group_stop]:
        calendar_mode = 0
      else:
        # seems to be a valid calendar mode, checking if need to update
        # calendar_range
        if calendar_range < (group_stop - group_start):
          calendar_range = (group_stop - group_start)

      # recovering item properties
1518
      if object_list not in (None, [], {}) :
1519
        for object_request in object_list:
Romain Courteaud's avatar
Romain Courteaud committed
1520
          if start_property_id is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1521 1522
            block_begin = \
            object_request.getObject().getProperty(start_property_id,None)
1523 1524
          else:
            block_begin = None
Romain Courteaud's avatar
Romain Courteaud committed
1525
          if stop_property_id is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1526 1527
            block_stop = \
            object_request.getObject().getProperty(stop_property_id,None)
1528 1529
          else:
            block_stop = None
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
          item_list.append([block_begin,block_stop])

          # testing if current item is compliant with calendar mode
          # i.e item car be represented within the current group
          if calendar_mode and (block_stop <= group_start) and \
                               (block_begin >= group_stop):
            # invalid conditions : item outside group, so no calendar mode
            calendar_mode = 0

        # adding list of items to group_list
        group_list.extend(item_list)
1541

1542 1543 1544 1545 1546 1547
      # adding current group list to list of occurences
      secondary_axis_occurence.extend(group_list)

    # saving resulting values.
    self.calendar_mode  = calendar_mode
    self.calendar_range = calendar_range
1548
    return secondary_axis_occurence
1549

1550

1551
  def getSecondaryAxisInfo(self):
1552 1553 1554 1555 1556 1557
    """
    secondary_axis_ocurence holds couples of data (begin,end) related to
    basicActivity blocks, and axis if the instance representing the sec axis.
    it is now possible to recover begin and end value of the planning and then
    apply selection informations to get start and stop.
    """
1558
    axis_dict = {}
1559
    use_dz = self.field.get_value('use_date_zoom')
Thomas Bernard's avatar
Thomas Bernard committed
1560
    # recovering zoom properties
1561 1562
    axis_dict['zoom_start'] = int(self.params.get('zoom_start',0))
    axis_dict['zoom_level'] = float(self.params.get('zoom_level',1))
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
  
    if not use_dz:
      if len(self.secondary_axis_occurence) != 0:
        axis_dict['bound_begin'] = self.secondary_axis_occurence[0][0]
        axis_dict['bound_end'] = axis_dict['bound_begin']
        # recovering min and max bounds to get absolute bounds
        for occurence in self.secondary_axis_occurence:
          if (occurence[0] < axis_dict['bound_begin'] or \
              axis_dict['bound_begin'] is None) and occurence[0] is not None:
            axis_dict['bound_begin'] = occurence[0]
          if (occurence[1] > axis_dict['bound_end'] or  \
              axis_dict['bound_end'] is None) and occurence[1] is not None:
            axis_dict['bound_end'] = occurence[1]
1576

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 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
      else:
        axis_dict['bound_end'] = axis_dict['bound_begin'] = None

      if axis_dict['bound_end'] is None or axis_dict['bound_begin'] is None:
        # Has Nothing to show, so Force show an Empty Planning Box.
        # XXX This axis is not always a Date axe!
        axis_dict['bound_begin'] = DateTime() - 5
        axis_dict['bound_start'] = axis_dict['bound_begin']
        axis_dict['bound_end'] = DateTime() + 5
        axis_dict['bound_stop'] = axis_dict['bound_end']
        axis_dict['bound_range'] = axis_dict['bound_end'] - axis_dict['bound_begin']
        # This is to prevent that show one Block with None dates.
        if len(self.secondary_axis_occurence) == 1:
           self.secondary_axis_occurence = []
        return 1
  
      axis_dict['bound_range'] = axis_dict['bound_end'] - axis_dict['bound_begin']
      # now start and stop have the extreme values of the second axis bound.
      # this represents in fact the size of the Planning's secondary axis
  
      # can now get selection informations ( float range 0..1)
      axis_dict['bound_start'] = 0
      axis_dict['bound_stop'] = 1
      if self.selection is not None:
        # selection is not None, trying to recover previously saved values about
        # secondary axis (axis start and stop bounds)
        try:
          axis_dict['bound_start'] = self.selection.getSecondaryAxisStart()
          axis_dict['bound_stop'] = self.selection.getSecondaryAxisStop()
        except AttributeError:
          # bounds were not defined, escaping test
          pass
  
      # getting secondary axis page step
      axis_zoom_step = axis_dict['bound_range'] / axis_dict['zoom_level']
  
      # now setting bound_start
      axis_dict['bound_start'] = axis_dict['zoom_start'] * axis_zoom_step + \
                                 axis_dict['bound_begin']
      # for bound_stop just add page step
      axis_dict['bound_stop'] = axis_dict['bound_start'] + axis_zoom_step
  
      # saving current zoom values
      self.params['zoom_level'] = axis_dict['zoom_level']
      self.params['zoom_start'] = axis_dict['zoom_start']
  
    else:
      # Use dz_zoom feature
      axis_dict['zoom_begin'] = self.params.get('zoom_begin',None)
      axis_dict['zoom_end']  = self.params.get('zoom_end',None)
      if axis_dict['zoom_begin'] not in [None, '', []]:
        axis_dict['bound_start'] = DateTime(axis_dict['zoom_begin'])
      else:
        axis_dict['bound_start'] =  None #min([i[0] for i in self.secondary_axis_occurence])
      if axis_dict['zoom_end'] not in [None, '', []]:
        axis_dict['bound_stop'] = DateTime(axis_dict['zoom_end'])
      else:
        axis_dict['bound_stop'] =  None #max([i[1] for i in self.secondary_axis_occurence])
      if axis_dict['bound_start'] is None:
        validate_method = getattr(self.context, 'planning_validate_date_list', None)
        axis_dict['bound_start'], axis_dict['bound_stop'] = \
                            validate_method( DateTime(), axis_dict['zoom_level'])
  
      # For Keep compatibility
      axis_dict['zoom_begin'] = axis_dict['bound_start']
      axis_dict['zoom_end'] = axis_dict['bound_stop']
      axis_dict['bound_end'] =  axis_dict['bound_stop']
      axis_dict['bound_begin'] = axis_dict['bound_start']
      axis_dict['bound_range'] = axis_dict['bound_end'] - \
                                  axis_dict['bound_begin']
      self.params['zoom_level'] = axis_dict['zoom_level']
Thomas Bernard's avatar
Thomas Bernard committed
1648
    # everything is OK, returning 'true' flag
1649
    return axis_dict
1650

1651

1652
  def getMainAxisInfo(self, report_tree_list):
1653
    """
1654
    Getting main axis properties (total pages, current page, groups per page)
1655 1656 1657 1658 1659 1660
    and setting selection bounds (start & stop).
    beware this justs calculate the position of the first group present on the
    page (same for the last one), applying the selection is another thing in
    case of report tree (if the first element is a sub group of a report for
    example).
    """
1661 1662
    main_axis_dict = {}
    main_axis_dict['bound_axis_groups'] = self.field.get_value('main_axis_groups')
1663

1664
    # setting begin & end bounds
1665 1666 1667
    main_axis_dict['bound_begin'] = 0
    # XXX rafael: this report_tree_list should be removed from here
    main_axis_dict['bound_end'] = len(report_tree_list)
1668
    if self.render_format == 'list':
1669
      main_axis_dict['bound_start'] = 0
Rafael Monnerat's avatar
Rafael Monnerat committed
1670
      main_axis_dict['bound_stop'] = main_axis_dict['bound_end']
1671 1672 1673
      main_axis_dict['bound_page_total'] = 1
      main_axis_dict['bound_page_current'] = 1
      main_axis_dict['bound_page_groups'] = 1
1674 1675 1676 1677
    else:
      # recovering first group displayed on actual page
      try:
        # trying to recover from REQUEST
1678 1679
        main_axis_dict['bound_start'] = self.REQUEST.get('list_start')
        main_axis_dict['bound_start'] = int(main_axis_dict['bound_start'])
1680 1681
      except (AttributeError, TypeError):
        # recovering from params is case failed with REQUEST
1682 1683 1684 1685 1686 1687 1688 1689
        main_axis_dict['bound_start'] = self.params.get('list_start',0)
        if type(main_axis_dict['bound_start']) is type([]):
          main_axis_dict['bound_start'] = main_axis_dict['bound_start'][0]
        if main_axis_dict['bound_start'] is not None:
          main_axis_dict['bound_start'] = int(main_axis_dict['bound_start'])
      main_axis_dict['bound_start'] = max(main_axis_dict['bound_start'],0)

      if main_axis_dict['bound_start'] > main_axis_dict['bound_end']:
1690
        # new report_group is so small that previous if after the last element
1691
        main_axis_dict['bound_start'] = main_axis_dict['bound_end']
1692 1693

      # updating start position to fit page size.
1694 1695
      main_axis_dict['bound_start'] -= \
               (main_axis_dict['bound_start'] % main_axis_dict['bound_axis_groups'])
1696 1697

      # setting last group displayed on page
1698 1699
      main_axis_dict['bound_stop'] = min (main_axis_dict['bound_end'],
               main_axis_dict['bound_start'] + main_axis_dict['bound_axis_groups'])
1700
      # calculating total number of pages
1701 1702
      main_axis_dict['bound_page_total'] = int(max(main_axis_dict['bound_end'] - 1,0) / \
               main_axis_dict['bound_axis_groups']) + 1
1703
      # calculating current page number
1704 1705
      main_axis_dict['bound_page_current'] = int(main_axis_dict['bound_start'] / \
               main_axis_dict['bound_axis_groups']) + 1
1706
      # adjusting first group displayed on current page
1707 1708 1709 1710 1711 1712 1713
      main_axis_dict['bound_start'] = min(main_axis_dict['bound_start'], max(0,
           (main_axis_dict['bound_page_total']-1) * main_axis_dict['bound_axis_groups']))

      self.params['list_lines'] = main_axis_dict['bound_axis_groups']
      self.params['list_start'] = main_axis_dict['bound_start']

    return main_axis_dict
1714

1715 1716 1717

  def buildGroupStructure(self):
      """
1718
      This procedure builds BasicGroup instances corresponding to the
1719 1720 1721 1722
      report_group_objects returned from the ERP5 request.
      """
      position = 0
      # iterating each element
Thomas Bernard's avatar
Thomas Bernard committed
1723 1724
      for (report_group_object, object_list, property_dict) in \
           self.report_groups:
1725 1726 1727

        stat_result = {}
        stat_context = report_group_object.getObject().asContext(**stat_result)
Thomas Bernard's avatar
Thomas Bernard committed
1728 1729 1730 1731
        stat_context.domain_url = \
                     report_group_object.getObject().getRelativeUrl()
        stat_context.absolute_url = \
                     lambda x: report_group_object.getObject().absolute_url()
1732 1733 1734
        url=getattr(stat_context,'domain_url','')
        # updating position_informations
        position +=1
1735
        # recovering usefull informations, basic_structure
Rafael Monnerat's avatar
Rafael Monnerat committed
1736
        if self.title_line not in (None,''):
Romain Courteaud's avatar
Romain Courteaud committed
1737 1738
	        title_line_method = getattr(report_group_object.getObject(),
			                                self.title_line, None)
1739
        else:
Romain Courteaud's avatar
Romain Courteaud committed
1740 1741
          title_line_method = getattr(report_group_object.getObject(),
                                      'getTitle', None)
1742
        if title_line_method is not None:
Romain Courteaud's avatar
Romain Courteaud committed
1743
          title = name = title_line_method()
1744
        depth = report_group_object.getDepth()
1745 1746
        is_open = report_group_object.getIsOpen()
        is_pure_summary = report_group_object.getIsPureSummary()
1747 1748

        # creating new group_object with all the informations collected
1749 1750 1751 1752 1753 1754
        group_start = group_stop = None
        if self.calendar_mode == 1:
          # recover start and stop of current object to generate good BasicGroup
          group_start = report_group_object.getObject().start_date
          group_stop  = report_group_object.getObject().stop_date -1
          # build dict to fix BasicActivity bounds
1755 1756
          secondary_axis_bounds = { 'bound_start': group_start,
                                    'bound_stop' : group_stop }
1757 1758
        else:
          secondary_axis_bounds = self.secondary_axis_info
Rafael Monnerat's avatar
Rafael Monnerat committed
1759

Thomas Bernard's avatar
Thomas Bernard committed
1760
        child_group = BasicGroup(title=title, name=name, url=url,
Rafael Monnerat's avatar
Rafael Monnerat committed
1761 1762 1763 1764 1765 1766
                                constraints=None, depth=depth,
                                position=position, field =self.field,
                                object=report_group_object, is_open=is_open,
                                is_pure_summary=is_pure_summary,
                                secondary_axis_start = group_start,
                                secondary_axis_stop  = group_stop,
1767 1768
                                property_dict = property_dict,
                                sec_layer_uid_list=self.sec_layer_uid_list)
Thomas Bernard's avatar
Thomas Bernard committed
1769

1770
        if object_list not in [None, []]:
1771 1772
          child_group.setBasicActivities(object_list,
                                         self.list_error,
1773
                                         secondary_axis_bounds)
1774

1775
        self.basic_group_list.append(child_group)
1776
	
Thomas Bernard's avatar
Thomas Bernard committed
1777 1778
      return 1

1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790

class BasicGroup:
  """
  A BasicGroup holds informations about an ERP5Object and is stored
  exclusively in BasicStructure. for each activity that will need to be
  represented in the PlanningBox, a BasicActivity is created and added to
  the current structure (for example BasicGroup represents an employee,
  and each BasicActivity represents a task the employee has).
  *Only one BasicGroup present while in Calendar mode.
  *BasicGroup instance itself can hold other BasicGroups in case of
  ReportTree mode to handle child groups.
  """
1791
  def __init__ (self, title='', name='',url='', constraints='', depth=0,
Thomas Bernard's avatar
Thomas Bernard committed
1792
                position=0, field = None, object = None, is_open=0,
1793
                is_pure_summary=1, secondary_axis_start=None,
1794 1795
                secondary_axis_stop=None, sec_layer_uid_list=[],
                property_dict = {}):
1796 1797 1798
    self.title = title
    self.name = name
    self.url = url
1799
    self.basic_group_list = [] # used with ReportTree
1800 1801 1802 1803 1804 1805
    self.basic_activity_list = None # bloc activities
    self.constraints = constraints# global contraints applying to all group
    self.depth = depth # depth of the actual group (report_tree mode)
    self.position = position # position of current group in the selection
    self.field = field # field object itself. used for several purposes
    self.object = object # ERP5 object returned & related to the group
Thomas Bernard's avatar
Thomas Bernard committed
1806 1807 1808 1809
    self.is_open = is_open
    self.is_pure_summary = is_pure_summary
    # specific start and stop bound values specifiec to the current group and
    # used in case of calendar mode
1810 1811
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
1812 1813 1814
    # property_dict holds all information about the current axis_group
    # type of group, stat, etc.
    self.property_dict = property_dict
1815
    self.sec_layer_uid_list = sec_layer_uid_list
1816

1817
  def setBasicActivities(self, activity_list, list_error, secondary_axis_info):
1818
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1819
    Link a list of activities to the current object.
Thomas Bernard's avatar
Thomas Bernard committed
1820 1821 1822 1823 1824 1825
    *Recover group properties. Used in case activity is built from Group
     itself
    *create a BasicActivity for each activity referenced in the list if
     necessary
    *add the activity to the current group.
    *update secondary_axis_occurence
1826
    """
Thomas Bernard's avatar
Thomas Bernard committed
1827
    info = {}
Thomas Bernard's avatar
Thomas Bernard committed
1828 1829 1830
    # specific begin & stop property names for secondary axis
    object_property_begin = self.field.get_value('x_start_bloc')
    object_property_end = self.field.get_value('x_stop_bloc')
1831
    object_height_method = self.field.get_value('y_size_block')
1832 1833 1834 1835
    # specific block text_information methods
    info_center = self.field.get_value('info_center')
    info_topleft = self.field.get_value('info_topleft')
    info_topright = self.field.get_value('info_topright')
1836 1837
    info_botleft = self.field.get_value('info_backleft')
    info_botright = self.field.get_value('info_backright')
Romain Courteaud's avatar
Romain Courteaud committed
1838
    info_tooltip = self.field.get_value('info_tooltip')
1839

1840
    if activity_list not in ([],None):
1841 1842 1843
      indic=0
      # iterating each activity linked to the current group
      for activity_content in activity_list:
1844
        # interpreting results and getting begin and end values from
1845
        # previously recovered method
1846
        block_begin = block_end = height =None
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
        obj = activity_content.getObject()
        _marker = []

        try:
          block_begin = obj.getProperty(object_property_begin, _marker)
          if block_begin is _marker:
            raise AttributeError, object_property_begin
        except AttributeError:
          block_begin = getattr(obj, object_property_begin, None)

        try:
          block_end = obj.getProperty(object_property_end, _marker)
          if block_end is _marker:
            raise AttributeError, object_property_end
        except AttributeError:
          block_end = getattr(obj, object_property_end, None)
1863

1864 1865 1866
        height_method = getattr(obj, object_height_method, None)
        if height_method is not None:
          height = height_method()
Rafael Monnerat's avatar
Rafael Monnerat committed
1867

1868
        # handling case where activity bound is not defined
Romain Courteaud's avatar
Romain Courteaud committed
1869
        if block_begin is None:
1870 1871
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
1872
        if block_end is None:
1873 1874
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
Thomas Bernard's avatar
Thomas Bernard committed
1875 1876 1877 1878
        # testing if activity is visible according to the current zoom
        # selection over the secondary_axis
        if  block_begin > secondary_axis_info['bound_stop'] or \
            block_end < secondary_axis_info['bound_start']:
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
          # activity will not be displayed, stopping process
          pass
        else:
          # activity is somehow displayed. checking if need to cut its bounds
          if block_begin < secondary_axis_info['bound_start']:
            # need to cut begin bound
            block_start = secondary_axis_info['bound_start']
          else: block_start = block_begin

          if block_end > secondary_axis_info['bound_stop']:
            block_stop = secondary_axis_info['bound_stop']
          else:
            block_stop = block_end

          # defining name
1894
          name = "Activity_%s" % (str(indic))
1895 1896

          error = 'false'
1897
          current_color=''
Rafael Monnerat's avatar
Rafael Monnerat committed
1898 1899 1900 1901 1902 1903
          info = {}
          info['info_center'] = ''
          info['info_topright'] = ''
          info['info_topleft'] = ''
          info['info_botleft'] = ''
          info['info_botright'] = ''
1904

1905 1906 1907 1908 1909
          if self.property_dict['stat'] == 1:
            title = ''
            object = activity_content
            url=''
          else:
1910
            
1911 1912 1913 1914
            # getting info text from activity itself if exists
            info_center_method = getattr(activity_content,info_center,None)
            info_topright_method = getattr(activity_content,info_topright,None)
            info_topleft_method = getattr(activity_content,info_topleft,None)
1915 1916 1917
            info_botleft_method = getattr(activity_content,info_botleft,None)
            info_botright_method = \
                 getattr(activity_content,info_botright,None)
Romain Courteaud's avatar
Romain Courteaud committed
1918 1919
            info_tooltip_method = \
                 getattr(activity_content,info_tooltip,None)
1920 1921 1922
            if obj.getUid() not in self.sec_layer_uid_list:
              # if value recovered is not null, then updating
              if info_center_method is not None:
1923
                info['info_center']=str(info_center_method())
1924
              if info_topright_method is not None:
1925
                info['info_topright']=str(info_topright_method())
1926
              if info_topleft_method is not None:
1927
                info['info_topleft']=str(info_topleft_method())
1928
              if info_botleft_method is not None:
1929
                info['info_botleft'] =str(info_botleft_method())
1930
              if info_botright_method is not None:
1931
                info['info_botright']=str(info_botright_method())
1932

Romain Courteaud's avatar
Romain Courteaud committed
1933
            if info_tooltip_method is not None:
1934
              info['info_tooltip']=str(info_tooltip_method())
1935 1936

            title = info['info_center']
Thomas Bernard's avatar
Thomas Bernard committed
1937 1938
            color_script = getattr(activity_content.getObject(),
                                   self.field.get_value('color_script'),None)
1939
            # calling color script if exists to set up activity_color
Romain Courteaud's avatar
Romain Courteaud committed
1940
            if color_script  is not None:
1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
              current_color = color_script(activity_content.getObject())

            # testing if some activities have errors
            if list_error not in (None, []):
              for activity_error in list_error:
                if activity_error[0][0] == name:
                  error = 'true'
                  break

            stat_result = {}
Thomas Bernard's avatar
Thomas Bernard committed
1951 1952 1953 1954 1955 1956
            stat_context = \
                         activity_content.getObject().asContext(**stat_result)
            stat_context.domain_url = \
                         activity_content.getObject().getRelativeUrl()
            stat_context.absolute_url = \
                         lambda x: activity_content.getObject().absolute_url()
1957
            object = stat_context.getObject()
1958 1959 1960 1961 1962
            
            # check if the activity_content has some special method for URL
            # This approach is also used by ListBox, but in Planning Box
            # the parameters are not important for now. In future, can be define
            # special sublinks using this implementation.
1963 1964 1965 1966 1967 1968 1969
            #if getattr(activity_content, 'getListItemUrl', None):
            #  url = activity_content.getListItemUrl(cname_id='', 
            #      selection_index='',
            #      selection_name=self.field.get_value('selection_name'))
            #else:
            #  url = object.getUrl()
            url = object.getUrl()
1970 1971

            # XXX should define height of block here
Rafael Monnerat's avatar
Rafael Monnerat committed
1972
            #height = None
1973 1974

          # creating new activity instance
Thomas Bernard's avatar
Thomas Bernard committed
1975 1976 1977 1978 1979 1980 1981 1982
          activity = BasicActivity(title=title, name=name, object=object,
                                   url=url, absolute_begin=block_begin,
                                   absolute_end=block_end,
                                   absolute_start=block_start,
                                   absolute_stop=block_stop, height = height,
                                   color=current_color, info_dict=info,
                                   error=error,
                                   property_dict=self.property_dict)
1983

1984 1985 1986 1987 1988 1989
          # adding new activity to personal group activity list
          try:
            self.basic_activity_list.append(activity)
          except (AttributeError):
            self.basic_activity_list = []
            self.basic_activity_list.append(activity)
1990
          # incrementing indic used for differenciating activities in the same
1991 1992 1993
          # group (used for Activity naming)
          indic += 1

Sebastien Robin's avatar
Sebastien Robin committed
1994
    else:
Thomas Bernard's avatar
Thomas Bernard committed
1995 1996 1997
      # specific color script
      color_script = getattr(self.object.getObject(),
                             self.field.get_value('color_script'),None)
1998 1999
      # calling color script if exists to set up activity_color
      current_color=''
Romain Courteaud's avatar
Romain Courteaud committed
2000
      if color_script  is not None:
2001 2002
        current_color = color_script(self.object.getObject())

2003
      # getting begin and end values from previously recovered method
Romain Courteaud's avatar
Romain Courteaud committed
2004
      if object_property_begin  is not None:
Thomas Bernard's avatar
Thomas Bernard committed
2005 2006
        block_begin = \
                    self.object.getObject().getProperty(object_property_begin)
Sebastien Robin's avatar
Sebastien Robin committed
2007 2008
      else:
        block_begin = None
2009

Romain Courteaud's avatar
Romain Courteaud committed
2010
      if object_property_end is not None:
Thomas Bernard's avatar
Thomas Bernard committed
2011
        block_end = self.object.getObject().getProperty(object_property_end)
Sebastien Robin's avatar
Sebastien Robin committed
2012
      else:
2013 2014
        block_end = None

2015 2016 2017 2018
      if secondary_axis_info.has_key('bound_start') and \
               secondary_axis_info.has_key('bound_stop'):
        # testing if activity is visible according to the current zoom selection
        # over the secondary_axis
Romain Courteaud's avatar
Romain Courteaud committed
2019
        if (block_begin is None):
2020 2021
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
2022
        if block_end is None:
2023 2024
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
2025

2026 2027 2028 2029
        if  (block_begin > secondary_axis_info['bound_stop'] or \
          block_end < secondary_axis_info['bound_start']):
          # activity will not be displayed, stopping process
          pass
2030
        else:
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
          # activity is somehow displayed. checking if need to cut its bounds
          if block_begin < secondary_axis_info['bound_start']:
            # need to cut begin bound
            block_start = secondary_axis_info['bound_start']
          else: block_start = block_begin

          if block_end > secondary_axis_info['bound_stop']:
            block_stop = secondary_axis_info['bound_stop']
          else:
            block_stop = block_end

          # testing if some activities have errors
          error = 'false'
          if list_error not in (None,[]):
            for activity_error in list_error:
              if activity_error[0][0] == name:
                error = 'true'
                break

          # XXX testing constraint result here.
          # if current object url in list of error constranint urls, then
          # colorizing the block.

          # defining name
          name = "Activity_%s" % (self.object.getObject().getTitle())

          # height should be implemented here
          height = None

          # get object url, not group url
2061
          url = self.object.getObject().getUrl()
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078

          # creating new activity instance
          activity=BasicActivity(title=info['info_center'], name=name,
                                 object=self.object.object, url=url,
                                 absolute_begin=block_begin,
                                 absolute_end=block_end,
                                 absolute_start=block_start,
                                 absolute_stop=block_stop, height=height,
                                 color=current_color, info_dict=info,
                                 error=error, property_dict=self.property_dict)

          # adding new activity to personal group activity list
          try:
            self.basic_activity_list.append(activity)
          except (AttributeError):
            self.basic_activity_list = []
            self.basic_activity_list.append(activity)
2079 2080

class BasicActivity:
2081 2082 2083
  """ Represents an activity, a task, in the group it belongs to. Beware
      nothing about multitask rendering. """

Thomas Bernard's avatar
Thomas Bernard committed
2084 2085 2086 2087
  def __init__ (self, title='', name='',object = None, url='',
                absolute_begin=None, absolute_end=None, absolute_start=None,
                absolute_stop=None, height=None, constraints='', color=None,
                error='false', info_dict= None, property_dict = {}):
2088 2089
    self.title = title
    self.name = name
2090
    self.object = object
2091 2092 2093 2094 2095 2096
    self.url = url
    self.absolute_begin = absolute_begin # absolute values independant of any
                                         # hypothetic zoom
    self.absolute_end = absolute_end
    self.absolute_start = absolute_start
    self.absolute_stop = absolute_stop
2097
    self.height = height
Thomas Bernard's avatar
Thomas Bernard committed
2098
    self.constraints = constraints
2099 2100 2101
    self.color = color
    self.info_dict = info_dict
    self.error = error
2102
    self.property_dict = property_dict # dict containing specific properties
2103 2104 2105


class PlanningStructure:
Romain Courteaud's avatar
Romain Courteaud committed
2106 2107 2108 2109 2110 2111
  """
  class aimed to generate the Planning final structure, including :
  - activities with their blocs (so contains Activity structure)
  - Axis informations (contains Axis Structure).
  The zoom properties on secondary axis are applied to this structure.
  """
2112

2113
  def __init__ (self):
2114 2115 2116 2117 2118 2119
    self.main_axis = ''
    self.secondary_axis = ''
    self.content = []
    self.content_delimiters = None


Romain Courteaud's avatar
Romain Courteaud committed
2120
  def build(self, basic_structure=None, field=None, REQUEST=None):
2121 2122
    """
    main procedure for building Planning Structure
Thomas Bernard's avatar
Thomas Bernard committed
2123 2124 2125 2126 2127
    do all the necessary process to construct a full Structure compliant with
    all expectations (axis, zoom, colors, report_tree, multi_lines, etc.).
    From this final structure just need to run a PageTemplate to get an HTML
    output, or any other script to get the Planning result in the format you
    like...
2128
    """
2129
    # recovering render format ('YX' or 'XY')
2130
    self.calendar_view = field.get_value('calendar_view')
2131

2132 2133
    # declaring main axis
    self.main_axis = Axis(title='main axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2134
                          unit='', axis_order=1, axis_group=[])
2135 2136 2137

    # declaring secondary axis
    self.secondary_axis = Axis(title='sec axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2138
                               unit='', axis_order=2, axis_group=[])
2139 2140 2141

    # linking axis objects to their corresponding accessor, i.e X or Y
    # this allows the planning to be generic.
2142
    if self.calendar_view == 0:
2143 2144
      self.Y = self.main_axis
      self.X = self.secondary_axis
Sebastien Robin's avatar
Sebastien Robin committed
2145
    else:
2146 2147 2148 2149 2150 2151 2152 2153
      self.Y = self.secondary_axis
      self.X = self.main_axis

    # initializing axis properties
    self.X.name = 'axis_x'
    self.Y.name = 'axis_y'

    # recovering secondary_axis_ bounds
2154
    # Used in case of non calendar mode
Thomas Bernard's avatar
Thomas Bernard committed
2155 2156 2157 2158
    self.secondary_axis.start = \
                      basic_structure.secondary_axis_info['bound_start']
    self.secondary_axis.stop = \
                      basic_structure.secondary_axis_info['bound_stop']
2159 2160 2161 2162

    self.main_axis.size =  self.buildGroups(basic_structure=basic_structure)
    # call method to build secondary axis structure
    # need start_bound, stop_bound and number of groups to build
2163
    # used in non calendar mode
2164
    self.secondary_axis.axis_group = self.buildSecondaryAxis(basic_structure, field)
2165

2166
    # completing axisgroup informations according to their bounds
2167 2168
    self.completeAxis()

2169
    # the whole structure is almost completed : axis_groups are defined, as
Thomas Bernard's avatar
Thomas Bernard committed
2170 2171
    # axis_elements with their activities. Just need to create blocks related
    # to the activities (special process only for Calendar mode) with their
2172
    # BlockPosition
2173
    self.buildBlocs(basic_structure=basic_structure, REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
2174 2175
    # everything is fine, returning 'true' flag.
    return 1
2176

Romain Courteaud's avatar
Romain Courteaud committed
2177
  def buildSecondaryAxis(self, basic_structure, field):
2178 2179 2180
    """
    build secondary axis structure
    """
2181
    axis_group_list = []
Thomas Bernard's avatar
Thomas Bernard committed
2182
    # defining min and max delimiter number
2183
    delimiter_min_number = field.get_value('delimiter')
2184 2185 2186 2187
    if basic_structure.calendar_mode:
      axis_start = 1
      axis_stop = basic_structure.calendar_range + 1
    else:
Romain Courteaud's avatar
Romain Courteaud committed
2188 2189
      axis_stop = self.secondary_axis.stop
      axis_start = self.secondary_axis.start
2190

Thomas Bernard's avatar
Thomas Bernard committed
2191
    # calling script to get list of delimiters to implement
Thomas Bernard's avatar
Thomas Bernard committed
2192 2193
    # just need to pass start, stop, and the minimum number of delimiter
    # wanted. a structure is returned : list of delimiters, each delimiter
2194
    # defined by a dictionary
2195 2196 2197 2198 2199
    axis_script=getattr(basic_structure.context,
                        field.get_value('sec_axis_script'),None)
    if axis_script is None:
      delimiter_list = [ ]
    else:
2200 2201 2202 2203 2204
      delimiter_list = axis_script(axis_start=axis_start,
                                 axis_stop=axis_stop,
                                 delimiter_min_number=delimiter_min_number,
                                 form_id = basic_structure.form.id,
                                 selection_name = basic_structure.selection_name)
2205

Thomas Bernard's avatar
Thomas Bernard committed
2206 2207 2208
    axis_stop = int(axis_stop)
    axis_start = int(axis_start)
    axis_range = axis_stop - axis_start
2209

Thomas Bernard's avatar
Thomas Bernard committed
2210 2211 2212
    # axis_element_number is used to fix the group size
    self.secondary_axis.axis_size = axis_range
    # axis_group_number is used to differenciate groups
2213
    axis_group_number = 0
Thomas Bernard's avatar
Thomas Bernard committed
2214 2215 2216 2217
    # now iterating list of delimiters and building group list
    # group position and size informations are saved in position_secondary
    # using relative coordinates
    for delimiter in delimiter_list:
2218 2219
      link = None
      if delimiter.has_key('link'): link = delimiter['link'] 
Thomas Bernard's avatar
Thomas Bernard committed
2220
      axis_group = AxisGroup(name='Group_sec_' + str(axis_group_number),
2221
                             title=delimiter['title'], 
2222 2223
			     delimiter_type=delimiter['delimiter_type'],
			     link=link)
2224
      axis_group.tooltip = delimiter['tooltip']
Thomas Bernard's avatar
Thomas Bernard committed
2225
      axis_group.position_secondary.relative_begin = \
2226
                             int(delimiter['relative_position']) - int(axis_start)
Thomas Bernard's avatar
Thomas Bernard committed
2227 2228
      # set defaut stop bound and size
      axis_group.position_secondary.relative_end  = int(axis_stop)
Thomas Bernard's avatar
Thomas Bernard committed
2229
      axis_group.position_secondary.relative_range = \
2230
                             int(axis_stop) - int(delimiter['relative_position'])
Romain Courteaud's avatar
Romain Courteaud committed
2231 2232 2233
      # do not need to update previous delimiter informations for first
      # delimiter
      if delimiter != delimiter_list[0]:
Thomas Bernard's avatar
Thomas Bernard committed
2234 2235
        # actual delimiter info has a previous delimiter
        # update its informations
2236
        axis_group_list[-1].position_secondary.relative_end = \
Thomas Bernard's avatar
Thomas Bernard committed
2237
          axis_group.position_secondary.relative_begin
2238
        axis_group_list[-1].position_secondary.relative_range =\
Thomas Bernard's avatar
Thomas Bernard committed
2239
          axis_group.position_secondary.relative_begin - \
2240
          axis_group_list[-1].position_secondary.relative_begin
Thomas Bernard's avatar
Thomas Bernard committed
2241
      # add current axis_group to axis_group list
2242
      axis_group_list.append(axis_group)
2243 2244
      axis_group_number += 1

2245 2246
    return axis_group_list
    
Thomas Bernard's avatar
Thomas Bernard committed
2247

Rafael Monnerat's avatar
Rafael Monnerat committed
2248
  def completeAxis(self):
2249
    """
Romain Courteaud's avatar
Romain Courteaud committed
2250
    complete axis informations (and more precisely axis position objects) thanks
2251 2252 2253 2254
    to the actual planning structure
    """
    # processing main axis
    for axis_group_element in self.main_axis.axis_group:
Romain Courteaud's avatar
Romain Courteaud committed
2255 2256
      position_main = axis_group_element.position_main
      position_main.absolute_begin = (
Thomas Bernard's avatar
Thomas Bernard committed
2257 2258
              float(axis_group_element.axis_element_start - 1) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2259
      position_main.absolute_end = (
Thomas Bernard's avatar
Thomas Bernard committed
2260 2261
              float(axis_group_element.axis_element_stop) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2262
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2263 2264
              float(axis_group_element.axis_element_number) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2265 2266 2267 2268
      position_secondary = axis_group_element.position_secondary
      position_secondary.absolute_begin = 0
      position_secondary.absolute_end = 1
      position_secondary.absolute_range= 1
2269 2270

    for axis_group_element in self.secondary_axis.axis_group:
Romain Courteaud's avatar
Romain Courteaud committed
2271
      position_secondary = axis_group_element.position_secondary
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
      try:
        position_secondary.absolute_begin = (
             float(position_secondary.relative_begin) /
             self.secondary_axis.axis_size)
        position_secondary.absolute_end = (
             float(position_secondary.relative_end) /
             self.secondary_axis.axis_size)
        position_secondary.absolute_range = (
             float(position_secondary.relative_range) /
             self.secondary_axis.axis_size)
      except ZeroDivisionError:
        position_secondary.absolute_range = 1
        position_secondary.absolute_end = 1
        position_secondary.absolute_begin = 0
Romain Courteaud's avatar
Romain Courteaud committed
2286 2287 2288 2289
      position_main = axis_group_element.position_main
      position_main.absolute_begin = 0
      position_main.absolute_end = 1
      position_main.absolute_range = 1
Thomas Bernard's avatar
Thomas Bernard committed
2290

Thomas Bernard's avatar
Thomas Bernard committed
2291 2292 2293
    # returning 'true' flag at the end of the process
    return 1

Rafael Monnerat's avatar
Rafael Monnerat committed
2294
  def buildGroups(self, basic_structure=None):
2295
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
2296
    Build groups from activities saved in the structure groups.
2297 2298 2299 2300
    """
    axis_group_number = 0
    axis_element_already_present=0
    for basic_group_object in basic_structure.basic_group_list:
2301 2302 2303 2304
      if basic_structure.calendar_mode == 1:
        secondary_axis_range = basic_structure.calendar_range
      else:
        secondary_axis_range = None
Rafael Monnerat's avatar
Rafael Monnerat committed
2305
      axis_group_number += 1
Romain Courteaud's avatar
Romain Courteaud committed
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
      axis_group = AxisGroup(
                name='Group_%s' % axis_group_number,
                title=basic_group_object.title,
                object=basic_group_object.object,
                axis_group_number=axis_group_number,
                is_open=basic_group_object.is_open,
                is_pure_summary=basic_group_object.is_pure_summary,
                url = basic_group_object.url,
                depth=basic_group_object.depth,
                secondary_axis_start=basic_group_object.secondary_axis_start,
                secondary_axis_stop=basic_group_object.secondary_axis_stop,
                secondary_axis_range=secondary_axis_range,
                property_dict=basic_group_object.property_dict)
Rafael Monnerat's avatar
Rafael Monnerat committed
2319

2320
      if self.calendar_view == 0:
2321 2322
        axis_group.position_y = axis_group.position_main
        axis_group.position_x = axis_group.position_secondary
Sebastien Robin's avatar
Sebastien Robin committed
2323
      else:
2324 2325 2326 2327 2328 2329 2330
        axis_group.position_y = axis_group.position_secondary
        axis_group.position_x = axis_group.position_main
      # init absolute position over the axis
      axis_group.position_secondary.absolute_begin = 0
      axis_group.position_secondary.absolute_end= 1
      axis_group.position_secondary.absolute_range = 1
      # updating axis_group properties
Thomas Bernard's avatar
Thomas Bernard committed
2331 2332
      axis_group.fixProperties(form_id = basic_structure.form.id,
                               selection_name = basic_structure.selection_name)
2333 2334
      # updating start value
      activity_number = 0
Rafael Monnerat's avatar
Rafael Monnerat committed
2335
      axis_group.axis_element_start = axis_element_already_present + 1
Romain Courteaud's avatar
Romain Courteaud committed
2336
      if basic_group_object.basic_activity_list is not None:
2337 2338
        # need to check if activity list is not empty : possible in case zoom
        # selection is used over the secondary axis
2339 2340 2341 2342 2343 2344
        if axis_group.property_dict['stat'] == 0:
          # case group is task group. Using default method that
          # generates automatically the necessary axis elements
          for basic_activity_object in basic_group_object.basic_activity_list:
            activity_number += 1
            # create new activity in the PlanningStructure
Rafael Monnerat's avatar
Rafael Monnerat committed
2345
            activity=Activity(name='Group_%s_Activity_%s' % (
Romain Courteaud's avatar
Romain Courteaud committed
2346 2347
                                   axis_group_number,
                                   activity_number),
Thomas Bernard's avatar
Thomas Bernard committed
2348 2349 2350
                              title=basic_activity_object.title,
                              object=basic_activity_object.object,
                              color=basic_activity_object.color,
Rafael Monnerat's avatar
Rafael Monnerat committed
2351
                              height=basic_activity_object.height,
Thomas Bernard's avatar
Thomas Bernard committed
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
                              link=basic_activity_object.url,
                              secondary_axis_begin= \
                                          basic_activity_object.absolute_begin,
                              secondary_axis_end= \
                                          basic_activity_object.absolute_end,
                              secondary_axis_start= \
                                          basic_activity_object.absolute_start,
                              secondary_axis_stop= \
                                          basic_activity_object.absolute_stop,
                              primary_axis_block=self,
                              info=basic_activity_object.info_dict,
2363
                              calendar_view=self.calendar_view,
Thomas Bernard's avatar
Thomas Bernard committed
2364
                              property_dict=basic_group_object.property_dict)
2365
            # adding activity to the current group
2366 2367
            axis_group.addActivity(activity, axis_element_already_present,
                                   basic_structure)
2368 2369 2370 2371
        else:
          # case group is stat group. Using special method that prevent
          # from generating more than 1 axis element and divide tasks size if
          # necessary
Thomas Bernard's avatar
Thomas Bernard committed
2372 2373
          axis_group.addStatActivities(
               basic_activity_list=basic_group_object.basic_activity_list,
2374
               axis_group_number=axis_group_number,
Thomas Bernard's avatar
Thomas Bernard committed
2375
               axis_element_already_present=axis_element_already_present,
2376
               calendar_view=self.calendar_view, primary_axis_block=self,
Thomas Bernard's avatar
Thomas Bernard committed
2377
               property_dict=basic_group_object.property_dict)
Sebastien Robin's avatar
Sebastien Robin committed
2378
      else:
2379 2380 2381
        # basic_activity_list is empty : need to add a empty axis_element to
        # prevent bug or crash
        axis_group.axis_element_number = 1
Thomas Bernard's avatar
Thomas Bernard committed
2382
        new_axis_element=AxisElement(name='Group_%s_AxisElement_1' %
Romain Courteaud's avatar
Romain Courteaud committed
2383 2384
                                           axis_group_number,
                                 relative_number=1,
Thomas Bernard's avatar
Thomas Bernard committed
2385 2386
                                 absolute_number=axis_group.axis_element_start,
                                 parent_axis_group=axis_group)
2387 2388 2389 2390
        # add new activity to this brand new axis_element
        new_axis_element.activity_list = []
        axis_group.axis_element_list = []
        axis_group.axis_element_list.append(new_axis_element)
2391

Romain Courteaud's avatar
Romain Courteaud committed
2392 2393
      axis_group.axis_element_stop = \
          axis_element_already_present + axis_group.axis_element_number
2394 2395 2396 2397 2398 2399
      axis_element_already_present = axis_group.axis_element_stop
      try:
        self.main_axis.axis_group.append(axis_group)
      except AttributeError:
        self.main_axis.axis_group = []
        self.main_axis.axis_group.append(axis_group)
2400 2401
    if axis_element_already_present == 0:
      return 1
2402
    return axis_element_already_present
Sebastien Robin's avatar
Sebastien Robin committed
2403

2404

Romain Courteaud's avatar
Romain Courteaud committed
2405
  def buildBlocs(self, basic_structure=None, REQUEST=None):
2406 2407 2408 2409
    """
    iterate the whole planning structure to get various activities and build
    their related blocs.
    """
Thomas Bernard's avatar
Thomas Bernard committed
2410
    # recover activity and block error lists
Romain Courteaud's avatar
Romain Courteaud committed
2411 2412 2413
    warning_activity_list = REQUEST.get('warning_activity_list', [])
    error_block_list = REQUEST.get('error_block_list', [])
    error_info_dict = REQUEST.get('error_info_dict', {})
2414 2415 2416
    for axis_group_object in self.main_axis.axis_group:
      for axis_element_object in axis_group_object.axis_element_list:
        for activity in axis_element_object.activity_list:
2417
          # test if activity in warning_activity_list
2418 2419 2420 2421
          if activity.name in warning_activity_list:
            warning = 1
          else:
            warning = 0
2422 2423 2424 2425 2426 2427 2428 2429
          if basic_structure.calendar_mode == 1:
            axis_range = axis_group_object.secondary_axis_range
            axis_start = axis_group_object.secondary_axis_start
            axis_stop  = axis_group_object.secondary_axis_stop
          else:
            axis_start = basic_structure.secondary_axis_info['bound_start']
            axis_stop  = basic_structure.secondary_axis_info['bound_stop']
            axis_range = axis_stop - axis_start
2430
          activity.addBlocs(main_axis_start=0,
2431
                            height = activity.height,
2432 2433 2434 2435 2436 2437 2438 2439
                            main_axis_stop=self.main_axis.size,
                            secondary_axis_start = axis_start,
                            secondary_axis_stop  = axis_stop,
                            secondary_axis_range = axis_range,
                            planning=self, warning=warning,
                            error_block_list=error_block_list,
                            error_info_dict=error_info_dict)

2440 2441 2442
        if axis_group_object.property_dict['stat'] == 1:
          # case stat group_object, need to update block size to display
          # stats informations
2443
          axis_group_object.updateStatBlocks()
Thomas Bernard's avatar
Thomas Bernard committed
2444
    # no problem during process, returning 'true' flag
2445
    return 1
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456


class Activity:
  """
  Class representing a task in the Planning, for example an appointment or
  a duration. Can be divided in several blocs for being rendered correctly
  (contains Bloc Structure).
  Activity instance are not rendered but only their blocs. This Activity
  structure is used for rebuilding tasks from bloc positions when
  validating the Planning.
  """
Thomas Bernard's avatar
Thomas Bernard committed
2457 2458 2459 2460
  def __init__ (self,name=None, title=None, object=None, types=None,
                color=None, link=None, height=None, secondary_axis_begin=None,
                secondary_axis_end=None, secondary_axis_start=None,
                secondary_axis_stop=None, primary_axis_block=None, info=None,
Rafael Monnerat's avatar
Rafael Monnerat committed
2461
                calendar_view=0,property_dict={}):
Romain Courteaud's avatar
Romain Courteaud committed
2462 2463
    # internal activity_name
    self.name = name
Thomas Bernard's avatar
Thomas Bernard committed
2464
    self.id = self.name
Romain Courteaud's avatar
Romain Courteaud committed
2465 2466
    # displayed activity_name
    self.title = title
2467
    self.object = object
Romain Courteaud's avatar
Romain Courteaud committed
2468 2469 2470 2471 2472 2473
    # activity, activity_error, info
    self.types = types
    # color used to render all Blocs
    self.color = color
    # link to the ERP5 object
    self.link = link
2474
    self.height = height
2475
    # self.constraints = constraints
Romain Courteaud's avatar
Romain Courteaud committed
2476 2477 2478 2479 2480 2481
    # contains all the blocs used to render the activity
    self.block_list = None
    self.secondary_axis_begin = secondary_axis_begin
    self.secondary_axis_end = secondary_axis_end
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
2482 2483 2484 2485
    self.primary_axis_block = primary_axis_block
    self.block_bounds = None
    self.info = info
    self.parent_axis_element = None
Romain Courteaud's avatar
Romain Courteaud committed
2486
    self.calendar_view = calendar_view
2487
    self.property_dict = property_dict
2488

Thomas Bernard's avatar
Thomas Bernard committed
2489

Romain Courteaud's avatar
Romain Courteaud committed
2490 2491
  # XXX Still used ?
  def get_error_message(self, Error):
Thomas Bernard's avatar
Thomas Bernard committed
2492
    # need to update the error message
2493
    return 'task %s (%s)not validated' % (self.name, self.title)
Thomas Bernard's avatar
Thomas Bernard committed
2494 2495


2496 2497 2498 2499 2500 2501 2502
  def isValidPosition(self, bound_begin, bound_end):
    """
    can check if actual activity can fit within the bounds, returns :
    - 0 if not
    - 1 if partially ( need to cut the activity bounds to make it fit)
    - 2 definitely
    """
Thomas Bernard's avatar
Thomas Bernard committed
2503 2504
    if (self.secondary_axis_begin > bound_end) or \
       (self.secondary_axis_end < bound_begin):
2505
      return 0
Thomas Bernard's avatar
Thomas Bernard committed
2506 2507
    elif (self.secondary_axis_begin > bound_begin) and \
         (self.secondary_axis_end < bound_end):
2508
      return 1
2509
    else:
2510 2511
      return 2

Thomas Bernard's avatar
Thomas Bernard committed
2512
  def addBlocs(self, main_axis_start=None, main_axis_stop=None,
2513 2514
               secondary_axis_start=None, secondary_axis_stop=None,
               secondary_axis_range=None, planning=None, warning=0,
2515
               error_block_list=[], height=0, error_info_dict={}):
2516 2517 2518 2519 2520
    """
    define list of (begin & stop) values for blocs representing the actual
    activity (can have several blocs if necessary).
    """
    # recover list of bounds
Romain Courteaud's avatar
Romain Courteaud committed
2521 2522
    if self.secondary_axis_start is not None or \
        self.secondary_axis_stop is not None:
2523
      secondary_block_bounds = self.splitActivity()
Thomas Bernard's avatar
Thomas Bernard committed
2524

2525
    else:
2526
       secondary_block_bounds = \
Romain Courteaud's avatar
Romain Courteaud committed
2527
          [[secondary_axis_start, secondary_axis_stop, 1]]
2528 2529 2530

    block_number = 0
    # iterating resulting list
Romain Courteaud's avatar
Romain Courteaud committed
2531
    for (start, stop, zone) in secondary_block_bounds:
2532 2533

      block_number += 1
2534

Thomas Bernard's avatar
Thomas Bernard committed
2535
      block_name = self.name + '_Block_' + str(block_number)
2536
      # create new block instance
2537

Thomas Bernard's avatar
Thomas Bernard committed
2538 2539
      if block_name in error_block_list:
        error = 1
Romain Courteaud's avatar
Romain Courteaud committed
2540
        error_text = error_info_dict[block_name]
Thomas Bernard's avatar
Thomas Bernard committed
2541 2542
      else:
        error = 0
Romain Courteaud's avatar
Romain Courteaud committed
2543
        error_text = ''
2544

Thomas Bernard's avatar
Thomas Bernard committed
2545 2546
      # zone property is used to check if block is an active (main activity
      # block) block or a passive one (just a display block)
2547 2548 2549 2550 2551 2552 2553 2554
      if zone == 1:
        # active
        block_color = self.color
        block_link = self.link
      else:
        # passive
        block_color = '#D1E8FF'
        block_link = ''
Thomas Bernard's avatar
Thomas Bernard committed
2555 2556
      new_block = Bloc(name= block_name,color=block_color,link=block_link,
                       number = block_number,
2557
                       calendar_view=self.calendar_view, parent_activity=self,
Thomas Bernard's avatar
Thomas Bernard committed
2558 2559 2560
                       warning=warning, error=error,
                       error_text=error_text,zone=zone,
                       property_dict=self.property_dict)
2561 2562 2563 2564

      new_block.buildInfoDict(info_dict = self.info)

      # updating secondary_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2565 2566 2567
      position_secondary = new_block.position_secondary
      if self.secondary_axis_start is not None:
        position_secondary.absolute_begin = start
2568
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2569 2570 2571
        position_secondary.absolute_begin = secondary_axis_start
      if self.secondary_axis_stop is not None:
        position_secondary.absolute_end = stop
2572
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2573 2574 2575
        position_secondary.absolute_end = secondary_axis_stop
      position_secondary.absolute_range = stop - start

2576
      # updating main_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2577 2578
      position_main = new_block.position_main
      position_main.absolute_begin = \
Thomas Bernard's avatar
Thomas Bernard committed
2579
                      self.parent_axis_element.absolute_number - 1
Romain Courteaud's avatar
Romain Courteaud committed
2580
      position_main.absolute_end = \
Thomas Bernard's avatar
Thomas Bernard committed
2581
                      self.parent_axis_element.absolute_number
Romain Courteaud's avatar
Romain Courteaud committed
2582
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2583 2584
                      new_block.position_main.absolute_end -
                      new_block.position_main.absolute_begin)
2585 2586 2587

      # now absolute positions are updated, and the axis values are known
      # (as parameters), processing relative values
2588
      # => but before updating secondary_axis bounds
Romain Courteaud's avatar
Romain Courteaud committed
2589 2590
      position_secondary.relative_begin = (
          float(position_secondary.absolute_begin -
2591
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2592 2593
      position_secondary.relative_end = (
          float(position_secondary.absolute_end -
2594
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2595 2596 2597
      position_secondary.relative_range = (
          position_secondary.relative_end -
          position_secondary.relative_begin)
2598

2599
      # new coordinates are processed from the axis properties instead of the
Romain Courteaud's avatar
Romain Courteaud committed
2600 2601
      position_main.relative_begin = (
          float(position_main.absolute_begin - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2602
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2603 2604
      position_main.relative_end = (
          float(position_main.absolute_end - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2605
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2606 2607 2608
      position_main.relative_range = (
          position_main.relative_end -
          position_main.relative_begin)
2609

2610
      try:
2611
        self.block_list.append(new_block)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2612
      except AttributeError:
2613
        # in case this is the first add
2614 2615 2616
        # need to initialize the list
        self.block_list = []
        self.block_list.append(new_block)
Thomas Bernard's avatar
Thomas Bernard committed
2617

2618 2619 2620 2621 2622 2623
      try:
        planning.content.append(new_block)
      except AttributeError:
        planning.content = []
        planning.content.append(new_block)

Thomas Bernard's avatar
Thomas Bernard committed
2624 2625
    return 1

2626 2627 2628 2629 2630 2631 2632 2633 2634 2635
  def splitActivity(self):
    """
    Used for splitting an activity in multiple bloc.
    [EDIT] will not be used to split Calendar axis (by date time depending on
           the axis size), but will certainly be used afterwards in all cases
           to split activity in multiple blocs according to some external
           constraints (do not work sat & sun, or for a dayly planning do not
           work from 18P.M to 9A.M).
           will use an external script to do so.
    """
Romain Courteaud's avatar
Romain Courteaud committed
2636 2637
    # XXX Not implemented yet
    return [(self.secondary_axis_start, self.secondary_axis_stop,1)]
2638

Romain Courteaud's avatar
Romain Courteaud committed
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
    # Draft implementation
#     returned_list = []
#
#     start_date = self.secondary_axis_start
#     stop_date = self.secondary_axis_stop
#
#     temp_start = start_date
#     temp_stop  = temp_start
#
#     # defining usefull list of data
#     break_list = ['Saturday','Sunday']
#     worked_list = ['Monday','Tuesday','Wednesday','Thursday','Friday']
#
#     if temp_start.Day() in break_list:
#       # temp_start is in weekend,
#       # getting first worked day
#       while temp_start.Day() in break_list and temp_start < stop_date:
#         temp_start += 1
#       returned_list.append([temp_stop,temp_start,0])
#     else:
#       # temp_stop is in week, getting first weekend
#       while temp_stop.Day() in worked_list and temp_stop < stop_date:
#         temp_stop += 1
#       if temp_stop > stop_date:
#         temp_stop = stop_date
#
#     # testing if current activity is not too small to create blocks
#     while temp_start < stop_date:
#       returned_list.append([temp_start,temp_stop,1])
#
#       temp_start = temp_stop
#       # going to next start_date
#       while temp_start.Day() in break_list and temp_start < stop_date:
#         temp_start += 1
#
#       # adding new start date to list
#       if temp_start >= stop_date:
#         returned_list.append([temp_stop,stop_date,0])
#       elif temp_start != temp_stop:
#         returned_list.append([temp_stop,temp_start,0])
#       # next temp_start has been found
#       # now processing new temp_stop
#       temp_stop = temp_start
#       while temp_stop.Day() in worked_list and temp_stop < stop_date:
#         temp_stop += 1
#       if temp_stop > stop_date:
#         temp_stop = stop_date
#
#     # return new list
#     return returned_list
2689 2690


2691 2692 2693 2694

class Bloc:
  """
  structure that will be rendered as a bloc, a task element.
Thomas Bernard's avatar
Thomas Bernard committed
2695 2696 2697 2698
  Blocs are referenced in the Activity they belong to (logical structure), but
  are also referenced in their relative AxisElement (to be able to calculate
  the number of lines required for rendering when having multi-tasking in
  parallel).
2699 2700 2701 2702 2703
  Contains Bloc Structure for position informations.
  """

  def __init__ (self, name=None, types=None,
                color=None, info=None, link=None, number=0,
2704
                constraints=None, secondary_start=None, secondary_stop=None,
2705
                calendar_view=0, parent_activity = None, warning=0, error=0,
2706
                error_text='', zone=1, property_dict ={} ):
2707 2708 2709
    """
    creates a Bloc object
    """
Romain Courteaud's avatar
Romain Courteaud committed
2710 2711 2712 2713
    # internal name
    self.name = name
    # activity, activity_error, info
    self.types = types
2714
    self.color = color
Romain Courteaud's avatar
Romain Courteaud committed
2715 2716 2717 2718
    # dict containing text with their position
    self.info = info
    # on clic link
    self.link = link
2719 2720
    self.number = number
    self.title=''
Romain Courteaud's avatar
Romain Courteaud committed
2721 2722 2723
    # 1 = usefull area : 0 = useless one
    # XXX Bad naming, as it's not easy to understand
    self.zone = zone
2724 2725
    self.parent_activity = parent_activity
    self.constraints = constraints
Thomas Bernard's avatar
Thomas Bernard committed
2726 2727 2728 2729
    # setting warning and error flags in case parent_activity or block itself
    # have not been validated
    self.warning = warning
    self.error = error
2730
    self.error_text = error_text
2731 2732 2733 2734 2735
    # list of all the groups the bloc belongs to (reportTree)
    #self.container_axis_group = container_AxisGroup
    # integer pointing to the AxisElement containing the bloc (multitasking)
    #self.container_axis_element = container_AxisElement
    self.position_main = Position()
Thomas Bernard's avatar
Thomas Bernard committed
2736 2737
    self.position_secondary = \
          Position(absolute_begin=secondary_start,absolute_end=secondary_stop)
2738
    if calendar_view == 0:
2739 2740 2741 2742 2743 2744
      self.position_y = self.position_main
      self.position_x = self.position_secondary
    else:
      self.position_y = self.position_secondary
      self.position_x = self.position_main
    self.render_dict = None
2745
    self.property_dict = property_dict # dict containing internal properties
2746

Romain Courteaud's avatar
Romain Courteaud committed
2747
  def buildInfoDict(self, info_dict=[]):
2748
    """
Thomas Bernard's avatar
Thomas Bernard committed
2749 2750
    create Info objects to display text & images, then link them to the
    current object
2751 2752
    """
    # updating title
2753 2754 2755 2756 2757
    if self.property_dict['stat'] == 1:
      self.title = str(self.parent_activity.height)
      self.info = None
    else:
      self.info = {}
Romain Courteaud's avatar
Romain Courteaud committed
2758 2759 2760 2761 2762 2763 2764
      title_list = [
        self.buildInfo(info_dict=info_dict, area='info_topleft'),
        self.buildInfo(info_dict=info_dict, area='info_topright'),
        self.buildInfo(info_dict=info_dict, area='info_center'),
        self.buildInfo(info_dict=info_dict, area='info_botleft'),
        self.buildInfo(info_dict=info_dict, area='info_botright'),
      ]
Romain Courteaud's avatar
Romain Courteaud committed
2765 2766 2767 2768
      if info_dict.has_key('info_tooltip'):
        self.title = info_dict['info_tooltip']
      else:
        self.title = " | ".join(title_list)
2769

2770 2771 2772 2773
    if self.error != 0:
      # field has error
      # adding text_error
      self.info['info_error'] = Info(info=self.error_text, link='')
2774 2775 2776 2777 2778 2779 2780 2781 2782

  def buildInfo(self,info_dict=[],area=None):
    if area in info_dict:
      # creating new object
      info = Info(info = info_dict[area], link = self.link)
      # saving new object to block dict
      self.info[area] = info
      # recovering text information
      return info_dict[area]
Sebastien Robin's avatar
Sebastien Robin committed
2783
    else:
2784
      return ''
Sebastien Robin's avatar
Sebastien Robin committed
2785

2786 2787 2788 2789 2790 2791 2792
class Position:
  """
  gives a bloc [/or an area] informations about it's position on the X or Y
  axis. can specify position in every kind of axis : continuous or listed
  with lower and upper bound.
  """

Thomas Bernard's avatar
Thomas Bernard committed
2793 2794 2795
  def __init__ (self, absolute_begin=None, absolute_end=None,
                absolute_range=None, relative_begin=None, relative_end=None,
                relative_range=None):
2796 2797 2798
    # absolute size takes the bloc size in the original unit for the axis
    self.absolute_begin = absolute_begin
    self.absolute_end = absolute_end
Thomas Bernard's avatar
Thomas Bernard committed
2799
    self.absolute_range = absolute_range
2800
    # relative size in % of the current axis size
2801 2802
    self.relative_begin = relative_begin
    self.relative_end = relative_end
Thomas Bernard's avatar
Thomas Bernard committed
2803
    self.relative_range = relative_range
2804 2805 2806 2807


class Axis:
  """
2808
  Structure holding informations about a specified axis. Can be X or Y axis.
2809 2810 2811 2812 2813 2814
  Is aimed to handle axis with any kind of unit : continuous or listed (
  including possibly a listed ReportTree).
  Two of them are needed in a PlanningStructure to have X and Y axis.
  In case of listed axis, holds AxisGroup Structure.
  """

Thomas Bernard's avatar
Thomas Bernard committed
2815 2816
  def __init__(self, title=None, unit=None, types=None, axis_order=None,
               name=None, axis_group=None):
2817 2818 2819 2820 2821 2822
    self.title = title # axis title
    self.unit = unit # unit kind (time, nb... person, task, etc.)
    self.types = types # continuous / listed (incl. ReportTree)
    self.name = name
    self.size = 0 # value
    # axis group is a single group that contain the axis structure.
2823
    # defined to be able to use a generic and recursive method to
2824 2825
    self.axis_group = axis_group
    # specify if axis is primary or secondary.
2826
    # - if primary axis in Planning, zoom selection is applied thanks to
2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
    # a cut over the basic structure objects (based on their position and
    # their length).
    # - if secondary axis in Planning, then need to apply the second zoom
    # bounds (application will be based on two bounds : start & stop)
    self.axis_order = axis_order
    # dict containing all class properties with their values
    self.render_dict=None


class AxisGroup:
  """
  Class representing an item, that can have the following properties :
  - one or several rendered lines (multiTasking) : contains AxisElement
  structure to hold this.
  - one or several sub groups (ReportTree) : contains AxisGroup structure
  to hold sub groups elements.
  """

2845 2846
  def __init__ (self, name='', title='', object = None,
                axis_group_list=None, axis_group_number=0,
Thomas Bernard's avatar
Thomas Bernard committed
2847 2848 2849 2850
                axis_element_list=None, axis_element_number=0,
                delimiter_type=0, is_open=0, is_pure_summary=1,depth=0,
                url=None, axis_element_already_insered= 0,
                secondary_axis_start=None, secondary_axis_stop=None,
2851
                secondary_axis_range=None, link=None,
Thomas Bernard's avatar
Thomas Bernard committed
2852
                property_dict={}):
2853 2854
    self.name = name
    self.title = title
2855 2856 2857
    # link to fold or unfold report in report-tree mode and also 
    # special link on header columns
    self.link = link
2858
    self.info_title = Info(info=self.title, link=self.link, title=self.title)
Romain Courteaud's avatar
Romain Courteaud committed
2859 2860 2861 2862 2863 2864 2865
    # tooltip used when cursor pass over the group
    self.tooltip = ''
    # ZODB object used to validate modifications
    # XXX May generate conflict if an old version of object is saved
    self.object = object
    # ReportTree
    self.axis_group_list = axis_group_list
2866
    self.axis_group_number = axis_group_number
Romain Courteaud's avatar
Romain Courteaud committed
2867 2868
    # Multitasking
    self.axis_element_list = axis_element_list
2869
    self.axis_element_number = axis_element_number
2870 2871
    self.axis_element_start = None
    self.axis_element_stop = None
Thomas Bernard's avatar
Thomas Bernard committed
2872
    self.delimiter_type = delimiter_type
2873 2874
    # define the kind of separator used in graphic rendering
    # 0 for standard, 1 for bold, 2 for 2x bold
2875 2876 2877 2878 2879
    # dict containing all class properties with their values
    self.render_dict=None
    self.is_open = is_open
    self.is_pure_summary = is_pure_summary
    self.depth = depth
Romain Courteaud's avatar
Romain Courteaud committed
2880 2881
    # url to the object
    self.url = url
2882

2883 2884 2885 2886
    self.position_main = Position()
    self.position_secondary = Position()
    self.position_x = None
    self.position_y = None
2887 2888
    # secondary_axis_bounds are specified for each axis_group to handle
    # calendar view.
2889 2890
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
2891 2892 2893 2894 2895
    # secondary_axis_range is used in calendar mode to define range of the
    # largest axis. In case of month calendar, range is 31 so that even
    # tasks on febuary will be positioned over 31 days (and not 28) so that all
    # groups matches the same scale.
    self.secondary_axis_range = secondary_axis_range
2896
    self.property_dict = property_dict
2897 2898


2899
  security = ClassSecurityInfo()
Romain Courteaud's avatar
Romain Courteaud committed
2900

2901
  security.declarePublic('setTitle')
Romain Courteaud's avatar
Romain Courteaud committed
2902
  def setTitle(self, new_title=None):
2903 2904
    self.title = new_title

2905 2906 2907 2908 2909
  def fixProperties(self, form_id=None, selection_name=None):
    """
    using actual AxisGroup properties to define some special comportement that
    the axisGroup should have, especially in case of report-tree
    """
Romain Courteaud's avatar
Romain Courteaud committed
2910
    info_title = self.info_title
2911 2912
    if self.is_open:
      # current report is unfold, action 'fold'
Romain Courteaud's avatar
Romain Courteaud committed
2913
      info_title.link = 'foldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2914 2915
                              '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2916
      info_title.info = '[-] ' + str(info_title.info)
Sebastien Robin's avatar
Sebastien Robin committed
2917
    else:
2918
      # current report is fold, action 'unfold'
Romain Courteaud's avatar
Romain Courteaud committed
2919
      info_title.link = 'unfoldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2920 2921
                             '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2922
      info_title.info = '[+] ' + str(info_title.info)
2923 2924 2925

    #for i in range(self.depth):
    #  self.title = '| ' + self.title
Romain Courteaud's avatar
Romain Courteaud committed
2926
    info_title.title = info_title.info
2927

Romain Courteaud's avatar
Romain Courteaud committed
2928
    self.tooltip = info_title.info
2929

Sebastien Robin's avatar
Sebastien Robin committed
2930

2931
  def addActivity(self, activity=None, axis_element_already_insered=0,
2932
                  basic_structure=None):
2933
    """
2934
    Procedure that permits to add activity to the corresponding AxisElement in
2935
    an AxisGroup. This can create new Axis Element in the actual AxisGroup if
2936
    necessary. Permits representation of MULTITASKING
2937 2938 2939 2940
    """

    # declaring variable used to check if activity has already been added
    added = 0
Romain Courteaud's avatar
Romain Courteaud committed
2941 2942
    # XXX To much code inside the try: it's not possible to see
    # which part must not fails...
2943 2944 2945 2946 2947 2948 2949
    try:
      # iterating each axis_element of the axis_group
      for axis_element in self.axis_element_list:
        can_add = 1
        # recovering all activity properties of the actual axis_element and
        # iterating through them to check if one of them crosses the new one
        for activity_statement in axis_element.activity_list:
Thomas Bernard's avatar
Thomas Bernard committed
2950
          if activity_statement.isValidPosition(activity.secondary_axis_begin,
2951
                                      activity.secondary_axis_end) != 0:
2952 2953
            # isValidPosition returned 1 or 2, this means the activity already
            # present does prevent from adding the new activity as there is
2954
            # coverage on the current axis_element.
2955
            # stop iterating actual axis_element and try with the next one
2956 2957 2958 2959
            if activity_statement.object.getUid() not in \
                            basic_structure.sec_layer_uid_list:
              can_add = 0
              break
2960

2961 2962 2963 2964 2965 2966
        if can_add:
          # the whole activity_statements in actual axis have been succesfully
          # tested without problem.
          # can add new activity to the actual axis_element
          added = 1
          axis_element.activity_list.append(activity)
2967

2968 2969
          # updating activity properties
          activity.parent_axis_element = axis_element
2970

Thomas Bernard's avatar
Thomas Bernard committed
2971 2972
          # no need to check the next axis_elements to know if they can hold
          # the new activity as it is already added to an axis_element
2973
          break
2974

2975
      if not added:
Thomas Bernard's avatar
Thomas Bernard committed
2976 2977
        # all axis_elements of the current group have been tested and no one
        # can contain the new activity.
2978 2979
        self.axis_element_number += 1
        # Need to create a new axis_element to hold the new activity
Romain Courteaud's avatar
Romain Courteaud committed
2980
        new_axis_element=AxisElement(name='Group_%s_AxisElement_%s' % \
Thomas Bernard's avatar
Thomas Bernard committed
2981 2982 2983 2984 2985
                                          (str(self.axis_group_number),
                                           str(self.axis_element_number)),
                                     relative_number=self.axis_element_number,
                                     absolute_number=self.axis_element_number+
                                              axis_element_already_insered)
2986

2987 2988 2989
        # add new activity to this brand new axis_element
        new_axis_element.activity_list = []
        new_axis_element.activity_list.append(activity)
2990

2991 2992
        # updating activity properties
        activity.parent_axis_element = new_axis_element
2993

2994 2995 2996
        # register the axis_element to the actual group.
        self.axis_element_list.append(new_axis_element)
    except TypeError:
2997
      # in case axis_element_list is Empty (first activity to the group)
2998 2999
      # Need to create a new axis_element to hold the new activity
      self.axis_element_number += 1
Thomas Bernard's avatar
Thomas Bernard committed
3000 3001 3002 3003 3004 3005 3006 3007
      new_axis_element = AxisElement(name='Group_%s_AxisElement_1' %
                                           str(self.axis_group_number),
                                     relative_number=\
                                           self.axis_element_number,
                                     absolute_number =\
                                           axis_element_already_insered +
                                           self.axis_element_number,
                                     parent_axis_group=self)
Sebastien Robin's avatar
Sebastien Robin committed
3008

3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020
      # add new activity to this brand new axis_element
      new_axis_element.activity_list = []
      new_axis_element.activity_list.append(activity)

      # updating activity properties
      activity.parent_axis_element = new_axis_element

      # register the axis_element to the actual group.
      self.axis_element_list = []
      self.axis_element_list.append(new_axis_element)


Thomas Bernard's avatar
Thomas Bernard committed
3021
  def addStatActivities(self, basic_activity_list=None, axis_group_number=0,
3022
                        axis_element_already_present= 0, calendar_view=0,
Thomas Bernard's avatar
Thomas Bernard committed
3023
                        primary_axis_block=None, property_dict={}):
3024 3025 3026 3027 3028 3029
    """
    Permits to add stat block to the current AxisGroup. In this way use the
    single AxisElement present to fit the blocks
    """
    # first adding axis_element to the current group
    self.axis_element_number += 1
Thomas Bernard's avatar
Thomas Bernard committed
3030 3031 3032 3033 3034 3035
    new_axis_element=AxisElement(name='Group_%s_AxisElement_1' %
                                       str(self.axis_group_number),
                                 relative_number=self.axis_element_number,
                                 absolute_number=axis_element_already_present+
                                                 self.axis_element_number,
                                 parent_axis_group=self)
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045
    new_axis_element.activity_list = []

    self.axis_element_list = []
    self.axis_element_list.append(new_axis_element)

    activity_number = 0
    # add all activities to the same axis_element
    for basic_activity_object in basic_activity_list:

      # defining Activity from basic_activity_object
3046
      activity = Activity(name= 'Group_%s_Activity_%s'
Thomas Bernard's avatar
Thomas Bernard committed
3047 3048
                               %(str(axis_group_number),
                                 str(activity_number)),
3049 3050 3051 3052
                          title=basic_activity_object.title,
                          object=basic_activity_object.object,
                          color=basic_activity_object.color,
                          link=basic_activity_object.url,
Thomas Bernard's avatar
Thomas Bernard committed
3053 3054 3055 3056 3057 3058 3059 3060
                          secondary_axis_begin=\
                                 basic_activity_object.absolute_begin,
                          secondary_axis_end=\
                                 basic_activity_object.absolute_end,
                          secondary_axis_start=\
                                 basic_activity_object.absolute_start,
                          secondary_axis_stop=\
                                 basic_activity_object.absolute_stop,
3061 3062 3063
                          height=basic_activity_object.height,
                          primary_axis_block=primary_axis_block,
                          info=basic_activity_object.info_dict,
3064
                          calendar_view=calendar_view,
3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
                          property_dict = property_dict)
      activity.parent_axis_element = new_axis_element

      # append activity to current axis_element
      new_axis_element.activity_list.append(activity)

      activity_number +=1


  def updateStatBlocks(self):
    """
    called once the blocks have been defined on all activities
    if the current group is  stat group, then this method is called
    process :
      - find the largest element to display
      - update size of all other elements
    """
    # usually should get only 1 axis_element : all stats are displayed on the
    # same line.
Romain Courteaud's avatar
Romain Courteaud committed
3084 3085
    activity_list = self.axis_element_list[0].activity_list
    max_activity_height = max([0]+[x.height for x in activity_list])
3086 3087 3088

    # now max height is known, just need to adapt size of all the blocks
    # composing the activities
Romain Courteaud's avatar
Romain Courteaud committed
3089 3090 3091
    for activity in activity_list:
      height = activity.height
      if height in (0, None):
3092 3093
        relative_size = 1
      else:
Rafael Monnerat's avatar
Rafael Monnerat committed
3094
        relative_size = float(height) / float(max_activity_height)
3095 3096
      for block in activity.block_list:
        # recovering original values
Romain Courteaud's avatar
Romain Courteaud committed
3097 3098 3099 3100
        position_main = block.position_main
        block_range = position_main.relative_range
        block_begin = position_main.relative_begin
        block_end   = position_main.relative_end
3101 3102 3103 3104 3105
        # calculating values
        final_range = relative_size * block_range
        final_loss = block_range - final_range
        final_begin = block_begin + final_loss
        # saving new values
Romain Courteaud's avatar
Romain Courteaud committed
3106 3107
        position_main.relative_begin = final_begin
        position_main.relative_range = final_range
Thomas Bernard's avatar
Thomas Bernard committed
3108
    return 1
3109

3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
class AxisElement:
  """
  Represents a line in an item. In most cases, an AxisGroup element will
  hold ony one AxisElement (simple listed axis), but sometimes more
  AxisElements are required (multi, simultaneous tasking).
  AxisElement is linked with the blocs displayed in it : this is only
  usefull when doing multitasking to check if a new bloc can be added to an
  existing AxisElement or if it is needed to create a new AxisElement in
  the AxisGroup to hold it.
  """
Romain Courteaud's avatar
Romain Courteaud committed
3120 3121
  def __init__ (self, name='', relative_number=0, absolute_number=0,
                activity_list=None, parent_axis_group=None):
3122
    self.name = name
Romain Courteaud's avatar
Romain Courteaud committed
3123 3124 3125 3126
    # relative number / AxisGroup
    self.relative_number = relative_number
    # id in the current rendering
    self.absolute_number = absolute_number
3127 3128 3129 3130 3131 3132 3133 3134
    self.activity_list = activity_list
    # dict containing all class properties with their values
    self.render_dict=None
    self.parent_axis_group = parent_axis_group


class Info:
  """
Thomas Bernard's avatar
Thomas Bernard committed
3135 3136
  Class holding all informations to display an info text div inside of a block
  or AxisGroup or whatever
3137 3138 3139 3140 3141 3142 3143 3144 3145
  """
  security = ClassSecurityInfo()
  def __init__(self, info=None, link=None, title=None):
    self.info = info
    self.link = link
    self.title = title

  security.declarePublic('edit')
  def edit(self, info=None):
Romain Courteaud's avatar
Romain Courteaud committed
3146 3147 3148 3149
    """
    Special method allowing to update Info content from an external script
    """
    self.info = info
3150 3151 3152

# declaring validator instance
PlanningBoxValidatorInstance = PlanningBoxValidator()
Sebastien Robin's avatar
Sebastien Robin committed
3153

Romain Courteaud's avatar
Romain Courteaud committed
3154

Sebastien Robin's avatar
Sebastien Robin committed
3155
class PlanningBox(ZMIField):
Romain Courteaud's avatar
Romain Courteaud committed
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
  meta_type = "PlanningBox"
  widget = PlanningBoxWidgetInstance
  validator = PlanningBoxValidatorInstance
  security = ClassSecurityInfo()

  security.declareProtected('Access contents information', 'get_value')
  def get_value(self, id, render_format='html', **kw):
    """
    Surcharge get_value.
    XXX What is the purpose ?
    """
    if id == 'default' and render_format == 'list':
      return self.widget.render(self, self.generate_field_key(), None,
                                kw.get('REQUEST'),
                                render_format=render_format)
    else:
      return ZMIField.get_value(self, id, **kw)

3174 3175 3176
  def render_css(self, REQUEST=None):
    return self.widget.render_css(self, REQUEST)

3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192
# XXX Copy paste from listbox
def getContext(field, REQUEST):
  """
  Return the context of rendering this PlanningBox.
  """
  value = REQUEST.get('here')
  if value is None:
    value = getForm(field).aq_parent
  return value

# XXX Copy paste from listbox
def getForm(field):
  """Return the form which contains the PlanningBox.
  """
  return field.aq_parent

Romain Courteaud's avatar
Romain Courteaud committed
3193 3194 3195 3196 3197 3198 3199
# Allow classes in ZMI
for klass in (PlanningBoxWidget, BasicStructure, BasicGroup,
              BasicActivity, PlanningStructure, Activity,
              Bloc, Position, Axis, AxisGroup, AxisElement,
              Info):
  InitializeClass(klass)
  allow_class(klass)
3200 3201 3202 3203

# Register get_value
from Products.ERP5Form.ProxyField import registerOriginalGetValueClassAndArgument
registerOriginalGetValueClassAndArgument(PlanningBox, 'default')