PlanningBox.py 133 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
Sebastien Robin's avatar
Sebastien Robin committed
3
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
4 5
#                    Tomas Bernard <thomas@nexedi.com>
#     from an original experimental script written by :
Sebastien Robin's avatar
Sebastien Robin committed
6 7 8 9 10 11 12
#                    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
13
# Service Company
Sebastien Robin's avatar
Sebastien Robin committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
30 31 32 33 34 35 36 37 38 39

    # 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.


Sebastien Robin's avatar
Sebastien Robin committed
40
import string, types, sys
41

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

Sebastien Robin's avatar
Sebastien Robin committed
47 48 49 50 51 52 53
from Form import BasicForm
from Products.Formulator.Field import ZMIField
from Products.Formulator.DummyField import fields
from Products.Formulator.MethodField import BoundMethod
from DateTime import DateTime
from Products.Formulator import Widget, Validator
from Products.Formulator.Errors import FormValidationError, ValidationError
Sebastien Robin's avatar
Sebastien Robin committed
54
from SelectionTool import makeTreeList,TreeListLine
55
from Selection import Selection
Sebastien Robin's avatar
Sebastien Robin committed
56 57 58 59 60 61 62
import OFS
from AccessControl import ClassSecurityInfo
from zLOG import LOG
from copy import copy
from Acquisition import aq_base, aq_inner, aq_parent, aq_self
from Products.Formulator.Form import BasicForm
from Products.CMFCore.utils import getToolByName
63
from Products.ERP5Type.Utils import getPath
Thomas Bernard's avatar
Thomas Bernard committed
64 65
from Products.ERP5Type.Message import Message

66 67 68
class PlanningBoxError(Exception):
  pass

Sebastien Robin's avatar
Sebastien Robin committed
69
class PlanningBoxValidator(Validator.StringBaseValidator):
70 71
  """
  Class holding all methods used to validate a modified PlanningBox
Thomas Bernard's avatar
Thomas Bernard committed
72
  can be called only from an HTML rendering using wz_dragdrop script
73
  """
Romain Courteaud's avatar
Romain Courteaud committed
74
  def validate(self, field, key, REQUEST):
75 76
    """
    main method to solve validation
77 78 79 80 81 82 83 84 85 86 87 88
    - 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.
89
    """
90 91
    # init params
    value = None
92
    context = getContext(field, REQUEST)
93 94

    # recover usefull properties
Romain Courteaud's avatar
Romain Courteaud committed
95
    # XXX Incompatible with multiple planning box in the same form
Thomas Bernard's avatar
Thomas Bernard committed
96 97
    block_moved_string = REQUEST.get('block_moved','')
    block_previous_string = REQUEST.get('previous_block_moved','')
98 99 100

    ############## REBUILD STRUCTURE #################
    # build structure
101
    basic, planning = PlanningBoxWidgetInstance.render_structure(field=field,
102
                          REQUEST= REQUEST,
103
                          context=context)
104 105

    # getting coordinates script generator
106
    planning_coordinates_method = getattr(context, 'planning_coordinates')
107
    # calling script to generate coordinates
108 109
    planning_coordinates = planning_coordinates_method(basic=basic,
                                                       planning=planning)
110

Thomas Bernard's avatar
Thomas Bernard committed
111
    ########## RECOVERING BLOCK MOVED DICTS ##########
112
    #  converting string to a structure
Thomas Bernard's avatar
Thomas Bernard committed
113 114 115
    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
116 117
    block_previous_list =\
                       self.getBlockPositionFromString(block_previous_string)
Thomas Bernard's avatar
Thomas Bernard committed
118 119 120
    # list of previous blocks moved if an error occured during previous
    # validation

Thomas Bernard's avatar
Thomas Bernard committed
121 122 123
    # 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
124 125
    if block_previous_list != [] and block_moved_list != []:
      for block_previous in block_previous_list:
Thomas Bernard's avatar
Thomas Bernard committed
126
        # checking if the block has been moved again in this validation attempt
Thomas Bernard's avatar
Thomas Bernard committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
        # 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
142 143
          # block has not been moved again, adding old block informations to
          # the current list of block_moved
Thomas Bernard's avatar
Thomas Bernard committed
144 145 146 147 148 149 150 151 152
          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
153
    else:
Thomas Bernard's avatar
Thomas Bernard committed
154 155 156
      # the two lists are empty : nothing to validate
      return None
    # block_moved_list is updated
157 158 159

    # dict aimed to hold all informations about block
    final_block_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
160 161
    # dict holding all the activities that will need an update because at least
    # one of the blocks concerned is moved
162
    activity_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
163 164 165 166
    # 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 = []
167
    error_info_dict = {}
Thomas Bernard's avatar
Thomas Bernard committed
168

169 170 171 172 173 174 175
    ########## 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
176
      final_block['block_object'] = self.getBlockObject(block_moved['name'], \
177
                                                        planning.content)
178
      # recovering original activity object
Thomas Bernard's avatar
Thomas Bernard committed
179 180
      final_block['activity_origin'] = \
           final_block['block_object'].parent_activity
181
      # recovering original axis_group object
Thomas Bernard's avatar
Thomas Bernard committed
182 183
      final_block['group_origin'] = \
           final_block['activity_origin'].parent_axis_element.parent_axis_group
184
      # recovering relative block information in planning_coordinates
Thomas Bernard's avatar
Thomas Bernard committed
185 186
      final_block['block_info'] = \
           planning_coordinates['content'][block_moved['name']]
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

      # 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)
203
      if planning.calendar_view == 0:
Romain Courteaud's avatar
Romain Courteaud committed
204 205
        block_moved['main_axis_position'] = block_moved['top']
        block_moved['main_axis_length'] = block_moved['height']
206
        block_moved['secondary_axis_position'] = block_moved['left']
Romain Courteaud's avatar
Romain Courteaud committed
207
        block_moved['secondary_axis_length'] = block_moved['width']
208 209 210 211 212 213
        # 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
214 215
        block_moved['main_axis_position'] = block_moved['left']
        block_moved['main_axis_length'] = block_moved['width']
216
        block_moved['secondary_axis_position'] = block_moved['top']
Romain Courteaud's avatar
Romain Courteaud committed
217
        block_moved['secondary_axis_length'] = block_moved['height']
218 219 220 221 222
        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
223 224
      block_moved['center'] = (block_moved['main_axis_length'] / 2) + \
                               block_moved['main_axis_position']
225

Thomas Bernard's avatar
Thomas Bernard committed
226 227 228
      # 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
229
      group_destination = self.getDestinationGroup(basic, planning,
Thomas Bernard's avatar
Thomas Bernard committed
230 231
               block_moved,planning_coordinates['main_axis'],
               group_position, group_length)
232

Romain Courteaud's avatar
Romain Courteaud committed
233
      if group_destination is None:
Thomas Bernard's avatar
Thomas Bernard committed
234 235 236 237 238
        # !! 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'])
239
        error_info_dict[block_moved['name']] = 'out of bounds on main axis'
Thomas Bernard's avatar
Thomas Bernard committed
240 241 242 243
        # 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)

244 245 246
      else:
        # now that all informations about the main axis changes are
        # known, checking modifications over the secondary axis.
247
        secondary_axis_positions = self.getDestinationBounds(basic, planning,
248 249 250 251 252 253 254 255 256 257 258 259
                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
260 261


262 263 264 265 266 267 268 269 270 271 272 273
      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]

274 275

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

279
    ############# UPDATING ACTIVITIES ################
280 281 282 283 284 285
    # 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
286 287
    errors_list = []
    # getting start & stop property names
288 289
    start_property = field.get_value('x_start_bloc')
    stop_property = field.get_value('x_stop_bloc')
Thomas Bernard's avatar
Thomas Bernard committed
290
    # getting round_script if exists
291
    round_script=getattr(context, field.get_value('round_script'), None)
292 293 294 295 296 297 298 299
    # 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
300
      if activity_object.name in warning_activity_list:
301
        # activity contains a block that has not been validated
Thomas Bernard's avatar
Thomas Bernard committed
302 303 304 305 306 307 308
        # 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
309 310 311 312
        (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
313
        if round_script is not None:
Thomas Bernard's avatar
Thomas Bernard committed
314 315
          start_value = round_script(start_value)
          stop_value = round_script(stop_value)
316
        # adding object name to list of objects to update
Romain Courteaud's avatar
Romain Courteaud committed
317
        if activity_object.object.getUrl() not in update_list:
318
          update_list.append(activity_object.object.getUrl())
Thomas Bernard's avatar
Thomas Bernard committed
319
        # saving updated informations in the final dict
Romain Courteaud's avatar
Romain Courteaud committed
320
        for activity_desc in object_dict[activity_object.object.getUrl()]:
321 322 323 324 325 326 327 328 329 330 331 332 333 334
          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
335 336
        activity_start_date = activity['axis_start']
        activity_stop_date = activity['axis_stop']
337 338 339 340
        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
341 342
          can_update_start = activity_start_date
          can_update_stop  = activity_stop_date
343
        else:
Romain Courteaud's avatar
Romain Courteaud committed
344 345 346 347 348
          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

349
      update_dict[object_name] = {}
Romain Courteaud's avatar
Romain Courteaud committed
350
      if can_update_start and axis_start is not None:
351
        update_dict[object_name][start_property] = axis_start
Romain Courteaud's avatar
Romain Courteaud committed
352
      if can_update_stop  and axis_stop  is not None:
353
        update_dict[object_name][stop_property]  = axis_stop
Thomas Bernard's avatar
Thomas Bernard committed
354 355 356 357 358 359 360 361 362 363 364 365 366

    # 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)
367 368 369
      REQUEST.set('error_info_dict',error_info_dict)
      # now raise error => automatically called
      # parameters are :
370
      # - list of errors
371
      # - dict with error results
Romain Courteaud's avatar
Romain Courteaud committed
372
      raise FormValidationError(errors_list, {})
Thomas Bernard's avatar
Thomas Bernard committed
373

Romain Courteaud's avatar
Romain Courteaud committed
374 375 376
    # the whole process is now finished, 
    # just need to return editor for updating data
    return PlanningBoxEditor(field.id, update_dict)
377

Thomas Bernard's avatar
Thomas Bernard committed
378 379
  def getBlockPositionFromString(self, block_string):
    """
380
    Takes a string with block data and convert it to a list of dicts
Thomas Bernard's avatar
Thomas Bernard committed
381 382 383 384 385 386
    """
    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
387 388 389 390 391 392 393 394 395
        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
396
        block_list.append(block_dict)
Romain Courteaud's avatar
Romain Courteaud committed
397
    return block_list
Thomas Bernard's avatar
Thomas Bernard committed
398

Romain Courteaud's avatar
Romain Courteaud committed
399
  def setBlockPositionToString(self, block_list):
Thomas Bernard's avatar
Thomas Bernard committed
400
    """
Romain Courteaud's avatar
Romain Courteaud committed
401
    Takes a list of dicts updated and convert it to a string in order to save
Thomas Bernard's avatar
Thomas Bernard committed
402 403 404 405 406 407 408 409
    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
410 411
        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
412 413
        block_object_list.append(block_sub_string)
      block_string = '*'.join(block_object_list)
Romain Courteaud's avatar
Romain Courteaud committed
414
    return block_string
415 416 417 418 419 420 421

  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:
422
        return block 
423 424


425
  def getDestinationGroup(self, basic, planning, block_moved, axis_groups,
Thomas Bernard's avatar
Thomas Bernard committed
426
                                group_position, group_length):
427 428 429 430 431 432 433 434
    """
    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
435 436 437
      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']:
438 439 440 441
        # 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
442
    # if no group is found, this means the block is outside the bounds
443 444 445
    if good_group_name == '':
      return None
    # group name is known, searching corresponding group object
446
    for group in planning.main_axis.axis_group:
447 448 449 450 451
      if group.name == good_group_name:
        return group
    return None


452
  def getDestinationBounds(self, basic, planning, block_moved, block_object,
453 454
                                 planning_coordinates, axis_length,
                                 destination_group=None):
455 456 457 458
    """
    check the new bounds of the block over the secondary axis according to its
    new position
    """
Thomas Bernard's avatar
Thomas Bernard committed
459
    error = 0
460 461 462 463 464
    # 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.
465 466 467
    # => 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
468
    delta_start = block_moved['secondary_axis_position'] / \
469
                  planning_coordinates['frame']['planning_content'][axis_length]
Thomas Bernard's avatar
Thomas Bernard committed
470 471
    delta_stop  = (block_moved['secondary_axis_position'] + \
                  block_moved['secondary_axis_length']) / \
472
                  planning_coordinates['frame']['planning_content'][axis_length]
473 474 475 476

    # 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
477 478
      # can not validate it : returning None
      error = 1
479 480 481
    else:
      if delta_start < 0 or delta_stop > 1:
        # part of the block is inside
482 483
        # should handle support for correcting bounds : user should not be able
        # to define any data out of its group bounds.
484 485
        pass

486
    if basic.calendar_mode:
487 488 489 490 491 492
      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:
493 494
      axis_range = basic.secondary_axis_info['bound_stop'] - \
                   basic.secondary_axis_info['bound_start']
Thomas Bernard's avatar
Thomas Bernard committed
495

496
      # defining new final block bounds
497
      new_start = basic.secondary_axis_info['bound_start'] + \
498
                  delta_start * axis_range
499
      new_stop  = basic.secondary_axis_info['bound_start'] + \
500
                  delta_stop * axis_range
Thomas Bernard's avatar
Thomas Bernard committed
501 502

    return [new_start,new_stop, error]
503

Thomas Bernard's avatar
Thomas Bernard committed
504 505
  def getActivityBounds(self, activity, activity_block_moved_list,
                              activity_block_list):
506
    """
507 508 509 510
    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 !

511 512 513 514 515 516
    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
517 518
    block_moved_name_list = [x['block_moved']['name'] for x in activity_block_moved_list]
    
519 520 521 522 523 524 525 526
    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
527 528
            temp_start = temp_block_moved['block_moved']['secondary_axis_start']
            temp_stop  = temp_block_moved['block_moved']['secondary_axis_stop']
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
            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
547
    # checking weither activity has been cut-off to fit the planning bounds
548 549 550 551
    #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
552 553 554

    return [new_start,new_stop]

555
  def getObjectDict(self, basic, planning):
556 557 558 559 560 561
    """
    Takes all activities related to a specified object and return
    """
    # init dict
    object_dict = {}
    # get property_names
562 563
    start_property = basic.field.get_value('x_start_bloc')
    stop_property = basic.field.get_value('x_stop_bloc')
564
    # get full axis length
565 566 567
    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:
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 596 597 598 599 600 601 602 603 604
      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
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
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)

626 627 628 629 630 631
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
632 633 634 635 636 637 638 639 640 641
  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
642
     'use_date_zoom',
Romain Courteaud's avatar
Romain Courteaud committed
643 644 645 646 647
     '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',
648
     # Main List Method
Romain Courteaud's avatar
Romain Courteaud committed
649 650
     'portal_types', 'sort',
     'list_method',
651 652
     # Second Layer Properties
     'second_layer_list_method',
Romain Courteaud's avatar
Romain Courteaud committed
653 654 655 656 657 658 659 660 661 662 663
     # 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
664 665
     'info_backleft', 'info_backright',
     'info_tooltip'
Romain Courteaud's avatar
Romain Courteaud committed
666
     ]
667 668 669

  # Planning properties (accessed through Zope Management Interface)

670
  js_enabled = fields.CheckBoxField('js_enabled',
671
      title='enable on the fly edition (based on java script)',
672 673 674
      description='define if javascript is enabled or not on the current Planning',
      default=1,
      required=1)
675

676 677 678 679 680 681
  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)

682 683
  # kind of representation to render :
  # Planning or Calendar
684 685 686
  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
687
                  'main axis, but to display calendar main axis must be X one.',
688
      default=0,
689 690 691 692 693 694
      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',
695
      title='groups per page on main axis',
Romain Courteaud's avatar
Romain Courteaud committed
696
      description='number of groups displayed per page on main axis',
697 698 699 700 701
      default=10,
      required=1)

  # setting header height
  size_header_height = fields.IntegerField('size_header_height',
702
      title='header height',
Romain Courteaud's avatar
Romain Courteaud committed
703
      description='height of the planning header',
704 705 706 707 708 709
      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
710
      description='setting left border size',
711 712 713 714 715
      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',
716
      title='Planning width',
Romain Courteaud's avatar
Romain Courteaud committed
717
      description='size of the planning area, excluding axis size',
718 719 720 721 722
      default=1000,
      required=1)

  # setting the with of the Y axis
  size_y_axis_width = fields.IntegerField('size_y_axis_width',
723
      title='Y axis width',
Romain Courteaud's avatar
Romain Courteaud committed
724
      description='width of the Y axis',
725 726 727 728 729
      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',
730
      title='Y axis space',
Romain Courteaud's avatar
Romain Courteaud committed
731
      description='space between Y axis and PLanning content',
732 733 734 735 736
      default=10,
      required=1)

  # setting the height of the Planning (excl. X axis)
  size_planning_height = fields.IntegerField('size_planning_height',
737
      title='Planning height',
Romain Courteaud's avatar
Romain Courteaud committed
738
      description='size of the planning area, excluding axis_size',
739 740 741 742 743
      default=800,
      required=1)

  # setting the height of the X axis
  size_x_axis_height = fields.IntegerField('size_x_axis_height',
744
      title='X axis height',
Romain Courteaud's avatar
Romain Courteaud committed
745
      description='height of the X axis',
746 747 748 749 750
      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',
751
      title='X axis space',
Romain Courteaud's avatar
Romain Courteaud committed
752
      description='space between X axis and Planning content',
753 754 755 756
      default=10,
      required=1)


757 758
  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
759 760 761 762 763
      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)
764

765 766
  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
767 768 769 770
      description='position of X axis over the planning content.' \
                  'default is top, if checked then right apply',
      default=0,
      required=1)
771 772


773 774
  default = fields.TextAreaField('default',
      title='Default',
Romain Courteaud's avatar
Romain Courteaud committed
775
      description="Default value of the text in the widget.",
776 777 778 779 780
      default="",
      width=20, height=3,
      required=0)


781
  delimiter = fields.IntegerField('delimiter',
782
      title='min number of delimiters over the secondary axis',
Romain Courteaud's avatar
Romain Courteaud committed
783 784
      description="min number of delimitations over the sec axis, required",
      default=5,
785
      required=1)
786 787 788

  report_root_list = fields.ListTextAreaField('report_root_list',
      title="Report Root",
Romain Courteaud's avatar
Romain Courteaud committed
789
      description="A list of domains which define the possible root.",
790 791 792 793 794 795
      default=[],
      required=0)

  selection_name = fields.StringField('selection_name',
      title='Selection Name',
      description=("The name of the selection to store selections params"),
796 797
      default='planning_0',
      required=1)
798 799 800

  portal_types = fields.ListTextAreaField('portal_types',
      title="Portal Types",
Romain Courteaud's avatar
Romain Courteaud committed
801
      description="Portal Types of objects to list. Required.",
802 803 804 805 806
      default=[],
      required=0)

  sort = fields.ListTextAreaField('sort',
      title='Default Sort',
Romain Courteaud's avatar
Romain Courteaud committed
807
      description="The default sort keys and order",
808 809 810 811 812
      default=[],
      required=0)

  list_method = fields.MethodField('list_method',
      title='List Method',
Romain Courteaud's avatar
Romain Courteaud committed
813
      description="Method to use to list objects",
Rafael Monnerat's avatar
Rafael Monnerat committed
814
      default='',
815 816
      required=0)

817 818 819 820 821 822 823
  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)


824
  title_line = fields.StringField('title_line',
Rafael Monnerat's avatar
Rafael Monnerat committed
825
      title="Specific method which fetches the title of each line",
Romain Courteaud's avatar
Romain Courteaud committed
826
      description="Method for inserting title in line",
827 828 829 830
      default='',
      required=0)

  x_start_bloc = fields.StringField('x_start_bloc',
Rafael Monnerat's avatar
Rafael Monnerat committed
831
      title='Specific property to get start of blocks (ex. start_date)',
Romain Courteaud's avatar
Romain Courteaud committed
832 833
      description='Property for building X-Axis such as start_date ' \
                  'objects',
Thomas Bernard's avatar
Thomas Bernard committed
834
      default='start_date',
835 836 837
      required=0)

  x_stop_bloc = fields.StringField('x_stop_bloc',
Rafael Monnerat's avatar
Rafael Monnerat committed
838
      title='Specific property to get stop of blocks (ex. stop_date)',
Romain Courteaud's avatar
Romain Courteaud committed
839 840
      description='Property for building X-Axis such as stop_date ' \
                  'objects',
Thomas Bernard's avatar
Thomas Bernard committed
841
      default='stop_date',
842
      required=0)
843

844
  y_size_block = fields.StringField('y_size_block',
Rafael Monnerat's avatar
Rafael Monnerat committed
845
      title='Specific property to get height of blocks (ex.quantity)',
Romain Courteaud's avatar
Romain Courteaud committed
846
      description='Method for building height of blocks objects',
847
      default='quantity',
848
      required=0)
849 850 851

  constraint_method = fields.StringField('constraint_method',
      title='name of constraint method between blocks',
Romain Courteaud's avatar
Romain Courteaud committed
852
      description='Constraint method between blocks objects',
853 854 855
      default='SET_DHTML',
      required=1)

856
  stat_method = fields.StringField('stat_method',
Rafael Monnerat's avatar
Rafael Monnerat committed
857
      title="Name of script generating statistics",
Romain Courteaud's avatar
Romain Courteaud committed
858
      description="script for statistics",
859 860 861
      default='',
      required=0)

862
  split_method = fields.StringField('split_method',
Rafael Monnerat's avatar
Rafael Monnerat committed
863
      title='Name of script splitting activities into blocks',
Romain Courteaud's avatar
Romain Courteaud committed
864
      description="script for splitting activities into multiple blocks",
865 866 867
      default='',
      required=0)

868
  color_script = fields.StringField('color_script',
Rafael Monnerat's avatar
Rafael Monnerat committed
869
      title='Name of script colorizing blocks',
Romain Courteaud's avatar
Romain Courteaud committed
870
      description='script for block colors object',
871 872 873
      default='',
      required=0)

Thomas Bernard's avatar
Thomas Bernard committed
874
  round_script = fields.StringField('round_script',
Romain Courteaud's avatar
Romain Courteaud committed
875 876 877
      title='Name of script rounding blocks during validation (ex. ' \
            'Planning_roundBoundToDay)',
      description='script for block bounds rounding when validating',
878
      default='',
Thomas Bernard's avatar
Thomas Bernard committed
879 880
      required=0)

881

Thomas Bernard's avatar
Thomas Bernard committed
882
  sec_axis_script = fields.StringField('sec_axis_script',
Romain Courteaud's avatar
Romain Courteaud committed
883 884 885
      title='Name of script building secondary axis (ex. ' \
            'Planning_generateAxis)',
      description='Script for building secondary axis',
886
      default='Planning_generateAxis',
887
      required=1)
Thomas Bernard's avatar
Thomas Bernard committed
888

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

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

  info_topleft = fields.StringField('info_topleft',
Romain Courteaud's avatar
Romain Courteaud committed
906 907 908 909
      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',
910 911 912 913
      default='',
      required=0)

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

  info_backright = fields.StringField('info_backright',
Romain Courteaud's avatar
Romain Courteaud committed
922 923 924 925
      title='Specific method of data called for inserting info in '
            'block backright',
      description='Method for displaying info in the backright of a ' \
                  'block object',
926 927 928
      default='',
      required=0)

Romain Courteaud's avatar
Romain Courteaud committed
929 930 931 932 933 934 935 936
  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)

937
  security_index = fields.IntegerField('security_index',
Rafael Monnerat's avatar
Rafael Monnerat committed
938
      title='Variable depending on the type of web browser :',
Romain Courteaud's avatar
Romain Courteaud committed
939 940
      description='This variable is used because the rounds of each ' \
                  'web browser seem to work differently',
941 942 943
      default=2,
      required=0)

944 945 946 947 948 949 950 951 952 953 954 955 956
  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 []

957
  def render_css(self, field, REQUEST):
958 959 960 961 962 963
    """
    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
    """
964
    context = getContext(field, REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
965 966 967 968
    # 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
969 970
    basic, planning = self.render_structure(field=field, REQUEST=REQUEST, 
                                            context=context)
Thomas Bernard's avatar
Thomas Bernard committed
971
    # getting CSS script generator
972
    planning_css_method = getattr(context, 'planning_css')
Thomas Bernard's avatar
Thomas Bernard committed
973
    # recover CSS data buy calling DTML document
974
    CSS_data = planning_css_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
975
    # saving structure inside the request for HTML render
Romain Courteaud's avatar
Romain Courteaud committed
976
    # XXX This prevent multiple planning box on the same form
977 978
    REQUEST.set('basic', basic)
    REQUEST.set('planning', planning)
979

Thomas Bernard's avatar
Thomas Bernard committed
980
    return CSS_data
981

Romain Courteaud's avatar
Romain Courteaud committed
982
  def render(self, field, key, value, REQUEST):
983
    """
984
    Method called to render the HTML code relative to the planning.
985 986 987 988 989 990 991
    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
992 993
    basic = REQUEST.get('basic')
    planning = REQUEST.get('planning')
994

Thomas Bernard's avatar
Thomas Bernard committed
995
    # getting HTML rendering Page Template
996 997
    planning_html_method = getattr(getContext(field, REQUEST), 
                                   'planning_content')
Thomas Bernard's avatar
Thomas Bernard committed
998
    # recovering HTML data by calling Page Template document
999
    HTML_data = planning_html_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
1000 1001
    # return HTML data
    return HTML_data
1002

1003
  def render_structure(self, field, REQUEST, context):
Romain Courteaud's avatar
Romain Courteaud committed
1004 1005 1006 1007 1008 1009 1010 1011
    """
    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
1012 1013 1014
    # XXX testing : uncoment to put selection to null => used for debugging
    #here.portal_selections.setSelectionFor(selection_name, None)
    ####### DATA DEFINITION #######
1015
    # recovering usefull planning properties
1016 1017 1018
    # getting form
    form = field.aq_parent
    list_method = field.get_value('list_method')
1019
    sec_layer_list_method = field.get_value('second_layer_list_method')
1020 1021 1022 1023
    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')
1024
    # selection name used to store selection params
Sebastien Robin's avatar
Sebastien Robin committed
1025
    selection_name = field.get_value('selection_name')
1026
    # getting sorting keys and order (list)
Sebastien Robin's avatar
Sebastien Robin committed
1027
    sort = field.get_value('sort')
1028 1029
    # 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
1030 1031 1032
    list_error = REQUEST.get('list_block_error')
    if list_error is None:
      list_error = []
1033
    selection = context.portal_selections.getSelectionFor(
1034 1035 1036 1037 1038
                      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
1039
    except (AttributeError, KeyError):
1040
      params = {}
Romain Courteaud's avatar
Romain Courteaud committed
1041

Thomas Bernard's avatar
Thomas Bernard committed
1042
    ###### CALL CLASS METHODS TO BUILD BASIC STRUCTURE ######
1043
    # creating BasicStructure instance (and initializing its internal values)
1044 1045
    basic = BasicStructure(context=context,
                           form=form, field=field,
1046 1047 1048
                           REQUEST=REQUEST, 
                           list_method=list_method,
                           sec_layer_list_method=sec_layer_list_method,
1049 1050 1051 1052
                           selection=selection, params=params,
                           selection_name=selection_name,
                           title_line=title_line,
                           report_root_list=report_root_list,
1053
                           portal_types=portal_types, 
1054 1055
                           sort=sort,
                           list_error=list_error)
1056
    # call build method to generate BasicStructure
1057
    status = basic.build()
Thomas Bernard's avatar
Thomas Bernard committed
1058
    if status != 1:
1059
      raise PlanningBoxError, status
1060

Thomas Bernard's avatar
Thomas Bernard committed
1061
    ###### CALL CLASS METHODS TO BUILD PLANNING STRUCTURE ######
1062
    # creating PlanningStructure instance and initializing its internal values
1063
    planning = PlanningStructure()
1064
    # call build method to generate final Planning Structure
1065 1066 1067
    status = planning.build(basic_structure=basic,
                            field=field,
                            REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
1068 1069
    if status != 1:
      # in case error during planning structure generation
1070
      raise PlanningBoxError, status
1071

1072
    return basic, planning
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

# 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
  """

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

  def build(self):
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1119
    Build BasicStructure from given parameters, and for that do the
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
    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
1132
    # XXX Use selection tool API
1133
    if self.selection is None:
Thomas Bernard's avatar
Thomas Bernard committed
1134 1135
      self.selection = Selection(params=default_params,
                                 default_sort_on=self.sort)
Sebastien Robin's avatar
Sebastien Robin committed
1136
    else:
1137 1138 1139 1140
      # immediately updating the default sort value
      self.selection.edit(default_sort_on=self.sort)
      self.selection.edit(sort_on=self.sort)

1141
    self.context.portal_selections.setSelectionFor(
Romain Courteaud's avatar
Romain Courteaud committed
1142 1143 1144
                                        self.selection_name,
                                        self.selection,
                                        REQUEST=self.REQUEST)
1145
    # building list of portal_types
Romain Courteaud's avatar
Romain Courteaud committed
1146
    self.filtered_portal_types = [x[0] for x in self.portal_types]
1147 1148 1149 1150 1151 1152 1153
    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())
1154
    self.selection.edit(report_opened=is_report_opened)
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
    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']
1168

1169
    sec_layer_method_name = None
1170
    if getattr(self.sec_layer_list_method, 'method_name', None) is not None:
1171 1172 1173 1174
         sec_layer_method_name = self.sec_layer_list_method.method_name
         self.sec_layer_list_method = getattr( self.context,
                                          sec_layer_method_name, None)

1175
    if getattr(self.list_method, 'method_name', None) is not None:
1176 1177
      if self.list_method.method_name == 'ObjectValues':
        # list_method is available
1178
        self.list_method = self.context.objectValues
1179
        kw = copy(self.params)
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
      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
1194
          if self.params[cname] != '' and self.params[cname] is not None:
1195 1196 1197
            kw[cname] = self.params[cname]
        # try to get the method through acquisition
        try:
1198
          self.list_method = getattr(self.context, self.list_method.method_name)
1199 1200 1201 1202 1203 1204
        except (AttributeError, KeyError):
          pass
    elif self.list_method in (None,''):
      # use current selection
      self.list_method = None

1205 1206
    ############## DEFINING STAT METHOD ##############
    stat_method = self.field.get_value('stat_method')
1207
    stat_method = getattr(self.context, stat_method, None)
Romain Courteaud's avatar
Romain Courteaud committed
1208
    if stat_method is None:
1209
      show_stat = 0
1210 1211
    else:
      show_stat = 1
1212

1213 1214 1215 1216 1217
    ############ 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)
1218

1219 1220 1221 1222 1223 1224
    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]
1225

1226 1227 1228
    self.selection_report_path = self.selection.getReportPath(
                                  default=default_selection_report_path)

1229 1230 1231
    if self.selection_report_path in (None, ()):
      LOG("BasicStructure",0 ,"report path is empty or not valid on  %s" % \
                      self.field.absolute_url())
1232 1233 1234

    # testing report_depth value
    if report_depth is not None:
1235
      selection_report_current = ()
1236 1237
    else:
      selection_report_current = self.selection.getReportList()
1238
    
1239
    # building report_tree_list
1240
    report_tree_list = makeTreeList(here=self.context, form=self.form,
Thomas Bernard's avatar
Thomas Bernard committed
1241
                                    root_dict=None,
1242
                                    report_path=self.selection_report_path,
Thomas Bernard's avatar
Thomas Bernard committed
1243 1244 1245
                                    base_category=None, depth=0,
                                    unfolded_list=selection_report_current,
                                    selection_name=self.selection_name,
1246
                                    report_depth=report_depth,
1247
                                    list_method=self.list_method,
Rafael Monnerat's avatar
Rafael Monnerat committed
1248
                                    filtered_portal_types= \
1249
                                                self.filtered_portal_types,
1250 1251 1252
                                    is_report_opened=is_report_opened,
                                    sort_on=self.selection.sort_on,
                                    form_id=self.form.id)
1253

1254 1255 1256
    if report_tree_list == []:
      LOG("BasicStructure",0 ,"Report tree list is empty on %s" % 
                      self.field.absolute_url())
1257

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
    ########### 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
    self.getMainAxisInfo(self.main_axis_info, report_tree_list)
    # 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']]
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

    ########### 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=[]
1284
    sec_layer_object_list=[]
1285 1286
    build_object_list = []
    build_sec_layer_object_list = []
1287 1288 1289
    self.report_activity_dict = {}
    indic_line=0
    index_line=0
1290
    blocks_object={}
1291
    select_expression = ''
1292
    self.sec_layer_uid_list = []
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
    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)

1306
    # now iterating through report_tree_list
1307 1308 1309 1310 1311
    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 = {}
1312
      object_list = []
1313 1314 1315 1316 1317 1318
      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)
1319 1320
        # recovering statistics if needed
        # getting list of statistic blocks
Thomas Bernard's avatar
Thomas Bernard committed
1321 1322
        stat_list = stat_method(selection=self.selection,
                                list_method=self.list_method,
1323
                                selection_context=self.context,
Thomas Bernard's avatar
Thomas Bernard committed
1324 1325 1326
                                report_tree_list=report_tree_list,
                                object_tree_line=object_tree_line,
                                REQUEST=self.REQUEST, field=self.field)
1327

1328 1329 1330 1331
        if original_select_expression is None:
          del kw['select_expression']
        else:
          kw['select_expression'] = original_select_expression
1332
        
1333 1334 1335 1336 1337 1338 1339
        # 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
1340
        domain_obj = object_tree_line.getObject()
1341
        sec_layer_object_list = []
1342 1343
        if self.selection_report_path == 'parent':
          object_list = [object_tree_line.getObject()]
1344 1345 1346 1347
          if sec_layer_method_name not in (None,''):
            sec_layer_object_list = getattr(domain_obj,\
                            sec_layer_method_name)()
           
1348
        # Default Values
1349
        new_object_list = []
1350
        sec_new_object_list = []
1351 1352
        if domain_obj.getPortalType() == 'Domain':
          category_obj = domain_obj.getMembershipCriterionCategory()
1353
          for bc in domain_obj.getMembershipCriterionBaseCategoryList():
1354
            if (category_obj is not None) and (bc is not None):
1355
              new_object_list.extend([ s_obj for s_obj in build_object_list \
1356
                   if s_obj._getDefaultAcquiredCategoryMembership(bc) == category_obj])
1357
              sec_new_object_list.extend([ s_obj for s_obj in build_sec_layer_object_list \
1358
                   if s_obj._getDefaultAcquiredCategoryMembership(bc) == category_obj])
1359

1360
          object_list = new_object_list
1361
          sec_layer_object_list = sec_new_object_list
1362

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

          sec_layer_object_list = sec_new_object_list
1375 1376
          object_list = new_object_list

1377
        self.sec_layer_uid_list.extend([obj.getUid() for obj in sec_layer_object_list])
1378 1379 1380 1381
        # The order is important 
        sec_layer_object_list.extend(object_list)
        object_list = sec_layer_object_list

1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
        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:
1398
            if exception_uid_list not in [None, [], ()]:
1399 1400
              # 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
1401 1402
              # do not export voluntary object_list to prevent bad
              # interpretation
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
              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)
1414
    #self.selection.edit(report_list=None) # comment to save report_list status
1415

1416 1417 1418
    # update report list if report_depth was specified
    if report_depth is not None:
      unfolded_list = []
1419 1420
      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
1421 1422 1423
          # depth of current report_line is inferior to the current
          # report_depth and current report_line is not stat line.
          # saving information
1424 1425 1426
          unfolded_list.append(report_line.getObject().getRelativeUrl())
      self.selection.edit(report_list=unfolded_list)

Thomas Bernard's avatar
Thomas Bernard committed
1427

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

1433
    ############ GETTING SEC AXIS BOUNDS #############
Thomas Bernard's avatar
Thomas Bernard committed
1434 1435
    # now that our report_group structure has been cut need to get secondary
    # axis bounds to add only the blocs needed afterwards
1436 1437
    # getting secondary_axis_occurence to define begin and end secondary_axis
    # bounds (getting absolute size)
1438 1439 1440 1441 1442
    self.getSecondaryAxisOccurence()
    # 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.

1443 1444
    # now getting start & stop bounds (getting relative size to the current
    # rendering)
1445
    self.getSecondaryAxisInfo(self.secondary_axis_info)
1446 1447 1448 1449

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

    ######### 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
1460
    self.buildGroupStructure()
1461 1462 1463
    # everything is fine
    return 1

1464 1465
  def getSecondaryAxisOccurence(self):
    """
Thomas Bernard's avatar
Thomas Bernard committed
1466 1467 1468
    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
1469 1470
    """
    secondary_axis_occurence = []
1471 1472

    # defining the objects requested for calendar mode testing
1473
    if 'parent' in self.selection_report_path :
1474 1475 1476 1477 1478 1479 1480
      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
1481 1482

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

      # recovering group_properties
Romain Courteaud's avatar
Romain Courteaud committed
1491
      if start_property_id is not None:
1492 1493 1494 1495 1496 1497 1498 1499
        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
1500
      if stop_property_id is not None:
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
        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
1521
      if object_list not in (None, [], {}) :
1522
        for object_request in object_list:
Romain Courteaud's avatar
Romain Courteaud committed
1523
          if start_property_id is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1524 1525
            block_begin = \
            object_request.getObject().getProperty(start_property_id,None)
1526 1527
          else:
            block_begin = None
Romain Courteaud's avatar
Romain Courteaud committed
1528
          if stop_property_id is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1529 1530
            block_stop = \
            object_request.getObject().getProperty(stop_property_id,None)
1531 1532
          else:
            block_stop = None
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
          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)
1544

1545 1546 1547 1548 1549 1550
      # 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
1551 1552
    self.secondary_axis_occurence = secondary_axis_occurence

1553 1554 1555 1556 1557 1558 1559 1560

  def getSecondaryAxisInfo(self, axis_dict):
    """
    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.
    """
1561
    use_dz = self.field.get_value('use_date_zoom')
Thomas Bernard's avatar
Thomas Bernard committed
1562
    # recovering zoom properties
1563 1564
    axis_dict['zoom_start'] = int(self.params.get('zoom_start',0))
    axis_dict['zoom_level'] = float(self.params.get('zoom_level',1))
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
  
    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]
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 1648 1649
      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
1650 1651
    # everything is OK, returning 'true' flag
    return 1
1652

1653

1654
  def getMainAxisInfo(self, axis_dict, report_tree_list):
1655
    """
1656
    Getting main axis properties (total pages, current page, groups per page)
1657 1658 1659 1660 1661 1662
    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).
    """
1663 1664
    axis_dict['bound_axis_groups'] = self.field.get_value('main_axis_groups')

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

      if axis_dict['bound_start'] > axis_dict['bound_end']:
        # new report_group is so small that previous if after the last element
        axis_dict['bound_start'] = axis_dict['bound_end']

      # updating start position to fit page size.
Thomas Bernard's avatar
Thomas Bernard committed
1694 1695
      axis_dict['bound_start'] -= \
               (axis_dict['bound_start'] % axis_dict['bound_axis_groups'])
1696 1697

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

1710 1711 1712 1713 1714
      self.params['list_lines'] = axis_dict['bound_axis_groups']
      self.params['list_start'] = axis_dict['bound_start']

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

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

        # creating new group_object with all the informations collected
1746 1747 1748 1749 1750 1751
        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
1752 1753
          secondary_axis_bounds = { 'bound_start': group_start,
                                    'bound_stop' : group_stop }
1754 1755
        else:
          secondary_axis_bounds = self.secondary_axis_info
Rafael Monnerat's avatar
Rafael Monnerat committed
1756

Thomas Bernard's avatar
Thomas Bernard committed
1757
        child_group = BasicGroup(title=title, name=name, url=url,
Rafael Monnerat's avatar
Rafael Monnerat committed
1758 1759 1760 1761 1762 1763
                                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,
1764 1765
                                property_dict = property_dict,
                                sec_layer_uid_list=self.sec_layer_uid_list)
Thomas Bernard's avatar
Thomas Bernard committed
1766

1767
        if object_list not in [None, []]:
1768 1769
          child_group.setBasicActivities(object_list,
                                         self.list_error,
1770
                                         secondary_axis_bounds)
1771

1772
        self.basic_group_list.append(child_group)
1773
	
Thomas Bernard's avatar
Thomas Bernard committed
1774 1775
      return 1

1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787

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.
  """
1788
  def __init__ (self, title='', name='',url='', constraints='', depth=0,
Thomas Bernard's avatar
Thomas Bernard committed
1789
                position=0, field = None, object = None, is_open=0,
1790
                is_pure_summary=1, secondary_axis_start=None,
1791 1792
                secondary_axis_stop=None, sec_layer_uid_list=[],
                property_dict = {}):
1793 1794 1795
    self.title = title
    self.name = name
    self.url = url
1796
    self.basic_group_list = [] # used with ReportTree
1797 1798 1799 1800 1801 1802
    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
1803 1804 1805 1806
    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
1807 1808
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
1809 1810 1811
    # property_dict holds all information about the current axis_group
    # type of group, stat, etc.
    self.property_dict = property_dict
1812
    self.sec_layer_uid_list = sec_layer_uid_list
1813

1814
  def setBasicActivities(self, activity_list, list_error, secondary_axis_info):
1815
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1816
    Link a list of activities to the current object.
Thomas Bernard's avatar
Thomas Bernard committed
1817 1818 1819 1820 1821 1822
    *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
1823
    """
Thomas Bernard's avatar
Thomas Bernard committed
1824
    info = {}
Thomas Bernard's avatar
Thomas Bernard committed
1825 1826 1827
    # 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')
1828 1829 1830 1831
    # 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')
1832 1833
    info_botleft = self.field.get_value('info_backleft')
    info_botright = self.field.get_value('info_backright')
Romain Courteaud's avatar
Romain Courteaud committed
1834
    info_tooltip = self.field.get_value('info_tooltip')
1835 1836 1837 1838
    # getting info method from activity itself if exists
    info_center_method = getattr(self.object.getObject(),info_center,None)
    info_topright_method = getattr(self.object.getObject(),info_topright,None)
    info_topleft_method = getattr(self.object.getObject(),info_topleft,None)
1839 1840 1841
    info_botleft_method = getattr(self.object.getObject(),info_botleft,None)
    info_botright_method = \
                  getattr(self.object.getObject(),info_botright,None)
Romain Courteaud's avatar
Romain Courteaud committed
1842 1843
    info_tooltip_method = \
                  getattr(self.object.getObject(), info_tooltip, None)
1844
    # if method recovered is not null, then updating
Romain Courteaud's avatar
Romain Courteaud committed
1845 1846
    # XXX Does script have to manage multiple context object ?
    if info_center_method is not None:
1847
      info['info_center'] = str(info_center_method())
Romain Courteaud's avatar
Romain Courteaud committed
1848
    if info_topright_method is not None:
1849
      info['info_topright'] = str(info_topright_method())
Romain Courteaud's avatar
Romain Courteaud committed
1850
    if info_topleft_method is not None:
1851
      info['info_topleft'] = str(info_topleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1852
    if info_botleft_method is not None:
1853
      info['info_botleft'] = str(info_botleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1854
    if info_botright_method is not None:
1855
      info['info_botright'] = str(info_botright_method())
Romain Courteaud's avatar
Romain Courteaud committed
1856 1857
    if info_tooltip_method is not None:
      info['info_tooltip'] = str(info_tooltip_method())
1858

1859
    if activity_list not in ([],None):
1860 1861 1862
      indic=0
      # iterating each activity linked to the current group
      for activity_content in activity_list:
1863
        # interpreting results and getting begin and end values from
1864
        # previously recovered method
1865
        block_begin = block_end = None
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
        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)
1882

1883
        # handling case where activity bound is not defined
Romain Courteaud's avatar
Romain Courteaud committed
1884
        if block_begin is None:
1885 1886
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
1887
        if block_end is None:
1888 1889
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
Thomas Bernard's avatar
Thomas Bernard committed
1890 1891 1892 1893
        # 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']:
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
          # 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
1909
          name = "Activity_%s" % (str(indic))
1910 1911

          error = 'false'
1912
          current_color=''
1913

1914 1915 1916 1917 1918
          if self.property_dict['stat'] == 1:
            info = {}
            info['info_center'] = ''
            info['info_topright'] = ''
            info['info_topleft'] = ''
1919 1920
            info['info_botleft'] = ''
            info['info_botright'] = ''
1921 1922 1923 1924
            title = ''
            object = activity_content
            url=''
            object_property_height = self.field.get_value('y_size_block')
Thomas Bernard's avatar
Thomas Bernard committed
1925 1926
            height = \
                 getattr(activity_content.getObject(),object_property_height)
1927 1928
          else:
            info = {}
1929 1930 1931 1932 1933 1934
            info['info_center'] = ''
            info['info_topright'] = ''
            info['info_topleft'] = ''
            info['info_botleft'] = ''
            info['info_botright'] = ''
            
1935 1936 1937 1938
            # 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)
1939 1940 1941
            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
1942 1943
            info_tooltip_method = \
                 getattr(activity_content,info_tooltip,None)
1944 1945 1946
            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:
1947
                info['info_center']=str(info_center_method())
1948
              if info_topright_method is not None:
1949
                info['info_topright']=str(info_topright_method())
1950
              if info_topleft_method is not None:
1951
                info['info_topleft']=str(info_topleft_method())
1952
              if info_botleft_method is not None:
1953
                info['info_botleft'] =str(info_botleft_method())
1954
              if info_botright_method is not None:
1955
                info['info_botright']=str(info_botright_method())
1956

Romain Courteaud's avatar
Romain Courteaud committed
1957
            if info_tooltip_method is not None:
1958
              info['info_tooltip']=str(info_tooltip_method())
1959 1960

            title = info['info_center']
Thomas Bernard's avatar
Thomas Bernard committed
1961 1962
            color_script = getattr(activity_content.getObject(),
                                   self.field.get_value('color_script'),None)
1963
            # calling color script if exists to set up activity_color
Romain Courteaud's avatar
Romain Courteaud committed
1964
            if color_script  is not None:
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
              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
1975 1976 1977 1978 1979 1980
            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()
1981
            object = stat_context.getObject()
1982 1983 1984 1985 1986
            
            # 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.
1987 1988 1989 1990 1991 1992 1993
            #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()
1994 1995 1996

            # XXX should define height of block here
            height = None
1997 1998

          # creating new activity instance
Thomas Bernard's avatar
Thomas Bernard committed
1999 2000 2001 2002 2003 2004 2005 2006
          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)
2007

2008 2009 2010 2011 2012 2013
          # 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)
2014
          # incrementing indic used for differenciating activities in the same
2015 2016 2017
          # group (used for Activity naming)
          indic += 1

Sebastien Robin's avatar
Sebastien Robin committed
2018
    else:
Thomas Bernard's avatar
Thomas Bernard committed
2019 2020 2021
      # specific color script
      color_script = getattr(self.object.getObject(),
                             self.field.get_value('color_script'),None)
2022 2023
      # calling color script if exists to set up activity_color
      current_color=''
Romain Courteaud's avatar
Romain Courteaud committed
2024
      if color_script  is not None:
2025 2026
        current_color = color_script(self.object.getObject())

2027
      # getting begin and end values from previously recovered method
Romain Courteaud's avatar
Romain Courteaud committed
2028
      if object_property_begin  is not None:
Thomas Bernard's avatar
Thomas Bernard committed
2029 2030
        block_begin = \
                    self.object.getObject().getProperty(object_property_begin)
Sebastien Robin's avatar
Sebastien Robin committed
2031 2032
      else:
        block_begin = None
2033

Romain Courteaud's avatar
Romain Courteaud committed
2034
      if object_property_end is not None:
Thomas Bernard's avatar
Thomas Bernard committed
2035
        block_end = self.object.getObject().getProperty(object_property_end)
Sebastien Robin's avatar
Sebastien Robin committed
2036
      else:
2037 2038
        block_end = None

2039 2040 2041 2042
      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
2043
        if (block_begin is None):
2044 2045
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
2046
        if block_end is None:
2047 2048
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
2049

2050 2051 2052 2053
        if  (block_begin > secondary_axis_info['bound_stop'] or \
          block_end < secondary_axis_info['bound_start']):
          # activity will not be displayed, stopping process
          pass
2054
        else:
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
          # 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
2085
          url = self.object.getObject().getUrl()
2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102

          # 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)
2103 2104

class BasicActivity:
2105 2106 2107
  """ Represents an activity, a task, in the group it belongs to. Beware
      nothing about multitask rendering. """

Thomas Bernard's avatar
Thomas Bernard committed
2108 2109 2110 2111
  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 = {}):
2112 2113
    self.title = title
    self.name = name
2114
    self.object = object
2115 2116 2117 2118 2119 2120
    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
2121
    self.height = height
Thomas Bernard's avatar
Thomas Bernard committed
2122
    self.constraints = constraints
2123 2124 2125
    self.color = color
    self.info_dict = info_dict
    self.error = error
2126
    self.property_dict = property_dict # dict containing specific properties
2127 2128 2129


class PlanningStructure:
Romain Courteaud's avatar
Romain Courteaud committed
2130 2131 2132 2133 2134 2135
  """
  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.
  """
2136

2137
  def __init__ (self):
2138 2139 2140 2141 2142 2143
    self.main_axis = ''
    self.secondary_axis = ''
    self.content = []
    self.content_delimiters = None


Romain Courteaud's avatar
Romain Courteaud committed
2144
  def build(self, basic_structure=None, field=None, REQUEST=None):
2145 2146
    """
    main procedure for building Planning Structure
Thomas Bernard's avatar
Thomas Bernard committed
2147 2148 2149 2150 2151
    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...
2152
    """
2153
    # recovering render format ('YX' or 'XY')
2154
    self.calendar_view = field.get_value('calendar_view')
2155

2156 2157
    # declaring main axis
    self.main_axis = Axis(title='main axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2158
                          unit='', axis_order=1, axis_group=[])
2159 2160 2161

    # declaring secondary axis
    self.secondary_axis = Axis(title='sec axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2162
                               unit='', axis_order=2, axis_group=[])
2163 2164 2165

    # linking axis objects to their corresponding accessor, i.e X or Y
    # this allows the planning to be generic.
2166
    if self.calendar_view == 0:
2167 2168
      self.Y = self.main_axis
      self.X = self.secondary_axis
Sebastien Robin's avatar
Sebastien Robin committed
2169
    else:
2170 2171 2172 2173 2174 2175 2176 2177
      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
2178
    # Used in case of non calendar mode
Thomas Bernard's avatar
Thomas Bernard committed
2179 2180 2181 2182
    self.secondary_axis.start = \
                      basic_structure.secondary_axis_info['bound_start']
    self.secondary_axis.stop = \
                      basic_structure.secondary_axis_info['bound_stop']
2183 2184 2185 2186

    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
2187
    # used in non calendar mode
2188 2189
    self.buildSecondaryAxis(basic_structure, field)

2190
    # completing axisgroup informations according to their bounds
2191 2192
    self.completeAxis()

2193
    # the whole structure is almost completed : axis_groups are defined, as
Thomas Bernard's avatar
Thomas Bernard committed
2194 2195
    # axis_elements with their activities. Just need to create blocks related
    # to the activities (special process only for Calendar mode) with their
2196
    # BlockPosition
2197
    self.buildBlocs(basic_structure=basic_structure, REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
2198 2199
    # everything is fine, returning 'true' flag.
    return 1
2200

Romain Courteaud's avatar
Romain Courteaud committed
2201
  def buildSecondaryAxis(self, basic_structure, field):
2202 2203 2204
    """
    build secondary axis structure
    """
Thomas Bernard's avatar
Thomas Bernard committed
2205
    # defining min and max delimiter number
2206
    delimiter_min_number = field.get_value('delimiter')
2207 2208 2209 2210
    if basic_structure.calendar_mode:
      axis_start = 1
      axis_stop = basic_structure.calendar_range + 1
    else:
Romain Courteaud's avatar
Romain Courteaud committed
2211 2212
      axis_stop = self.secondary_axis.stop
      axis_start = self.secondary_axis.start
2213

Thomas Bernard's avatar
Thomas Bernard committed
2214
    # calling script to get list of delimiters to implement
Thomas Bernard's avatar
Thomas Bernard committed
2215 2216
    # just need to pass start, stop, and the minimum number of delimiter
    # wanted. a structure is returned : list of delimiters, each delimiter
2217
    # defined by a dictionary
2218 2219 2220 2221 2222
    axis_script=getattr(basic_structure.context,
                        field.get_value('sec_axis_script'),None)
    if axis_script is None:
      delimiter_list = [ ]
    else:
2223 2224 2225 2226 2227
      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)
2228

Thomas Bernard's avatar
Thomas Bernard committed
2229 2230 2231
    axis_stop = int(axis_stop)
    axis_start = int(axis_start)
    axis_range = axis_stop - axis_start
2232

Thomas Bernard's avatar
Thomas Bernard committed
2233 2234 2235
    # 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
2236
    axis_group_number = 0
Thomas Bernard's avatar
Thomas Bernard committed
2237 2238 2239 2240
    # 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:
2241 2242
      link = None
      if delimiter.has_key('link'): link = delimiter['link'] 
Thomas Bernard's avatar
Thomas Bernard committed
2243
      axis_group = AxisGroup(name='Group_sec_' + str(axis_group_number),
2244
                             title=delimiter['title'], 
2245 2246
			     delimiter_type=delimiter['delimiter_type'],
			     link=link)
2247
      axis_group.tooltip = delimiter['tooltip']
Thomas Bernard's avatar
Thomas Bernard committed
2248
      axis_group.position_secondary.relative_begin = \
2249
                             int(delimiter['relative_position']) - int(axis_start)
Thomas Bernard's avatar
Thomas Bernard committed
2250 2251
      # set defaut stop bound and size
      axis_group.position_secondary.relative_end  = int(axis_stop)
Thomas Bernard's avatar
Thomas Bernard committed
2252
      axis_group.position_secondary.relative_range = \
2253
                             int(axis_stop) - int(delimiter['relative_position'])
Romain Courteaud's avatar
Romain Courteaud committed
2254 2255 2256
      # do not need to update previous delimiter informations for first
      # delimiter
      if delimiter != delimiter_list[0]:
Thomas Bernard's avatar
Thomas Bernard committed
2257 2258
        # actual delimiter info has a previous delimiter
        # update its informations
Thomas Bernard's avatar
Thomas Bernard committed
2259 2260 2261 2262 2263
        self.secondary_axis.axis_group[-1].position_secondary.relative_end = \
          axis_group.position_secondary.relative_begin
        self.secondary_axis.axis_group[-1].position_secondary.relative_range =\
          axis_group.position_secondary.relative_begin - \
          self.secondary_axis.axis_group[-1].position_secondary.relative_begin
Thomas Bernard's avatar
Thomas Bernard committed
2264
      # add current axis_group to axis_group list
2265 2266 2267
      self.secondary_axis.axis_group.append(axis_group)
      axis_group_number += 1

Thomas Bernard's avatar
Thomas Bernard committed
2268 2269
    return 1

Rafael Monnerat's avatar
Rafael Monnerat committed
2270
  def completeAxis(self):
2271
    """
Romain Courteaud's avatar
Romain Courteaud committed
2272
    complete axis informations (and more precisely axis position objects) thanks
2273 2274 2275 2276
    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
2277 2278
      position_main = axis_group_element.position_main
      position_main.absolute_begin = (
Thomas Bernard's avatar
Thomas Bernard committed
2279 2280
              float(axis_group_element.axis_element_start - 1) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2281
      position_main.absolute_end = (
Thomas Bernard's avatar
Thomas Bernard committed
2282 2283
              float(axis_group_element.axis_element_stop) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2284
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2285 2286
              float(axis_group_element.axis_element_number) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2287 2288 2289 2290
      position_secondary = axis_group_element.position_secondary
      position_secondary.absolute_begin = 0
      position_secondary.absolute_end = 1
      position_secondary.absolute_range= 1
2291 2292

    for axis_group_element in self.secondary_axis.axis_group:
Romain Courteaud's avatar
Romain Courteaud committed
2293
      position_secondary = axis_group_element.position_secondary
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
      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
2308 2309 2310 2311
      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
2312

Thomas Bernard's avatar
Thomas Bernard committed
2313 2314 2315
    # returning 'true' flag at the end of the process
    return 1

Rafael Monnerat's avatar
Rafael Monnerat committed
2316
  def buildGroups(self, basic_structure=None):
2317
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
2318
    Build groups from activities saved in the structure groups.
2319 2320 2321 2322
    """
    axis_group_number = 0
    axis_element_already_present=0
    for basic_group_object in basic_structure.basic_group_list:
2323 2324 2325 2326
      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
2327
      axis_group_number += 1
Romain Courteaud's avatar
Romain Courteaud committed
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
      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
2341

2342
      if self.calendar_view == 0:
2343 2344
        axis_group.position_y = axis_group.position_main
        axis_group.position_x = axis_group.position_secondary
Sebastien Robin's avatar
Sebastien Robin committed
2345
      else:
2346 2347 2348 2349 2350 2351 2352
        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
2353 2354
      axis_group.fixProperties(form_id = basic_structure.form.id,
                               selection_name = basic_structure.selection_name)
2355 2356
      # updating start value
      activity_number = 0
Rafael Monnerat's avatar
Rafael Monnerat committed
2357
      axis_group.axis_element_start = axis_element_already_present + 1
Romain Courteaud's avatar
Romain Courteaud committed
2358
      if basic_group_object.basic_activity_list is not None:
2359 2360
        # need to check if activity list is not empty : possible in case zoom
        # selection is used over the secondary axis
2361 2362 2363 2364 2365 2366
        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
2367
            activity=Activity(name='Group_%s_Activity_%s' % (
Romain Courteaud's avatar
Romain Courteaud committed
2368 2369
                                   axis_group_number,
                                   activity_number),
Thomas Bernard's avatar
Thomas Bernard committed
2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383
                              title=basic_activity_object.title,
                              object=basic_activity_object.object,
                              color=basic_activity_object.color,
                              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,
2384
                              calendar_view=self.calendar_view,
Thomas Bernard's avatar
Thomas Bernard committed
2385
                              property_dict=basic_group_object.property_dict)
2386
            # adding activity to the current group
2387 2388
            axis_group.addActivity(activity, axis_element_already_present,
                                   basic_structure)
2389 2390 2391 2392
        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
2393 2394
          axis_group.addStatActivities(
               basic_activity_list=basic_group_object.basic_activity_list,
2395
               axis_group_number=axis_group_number,
Thomas Bernard's avatar
Thomas Bernard committed
2396
               axis_element_already_present=axis_element_already_present,
2397
               calendar_view=self.calendar_view, primary_axis_block=self,
Thomas Bernard's avatar
Thomas Bernard committed
2398
               property_dict=basic_group_object.property_dict)
Sebastien Robin's avatar
Sebastien Robin committed
2399
      else:
2400 2401 2402
        # 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
2403
        new_axis_element=AxisElement(name='Group_%s_AxisElement_1' %
Romain Courteaud's avatar
Romain Courteaud committed
2404 2405
                                           axis_group_number,
                                 relative_number=1,
Thomas Bernard's avatar
Thomas Bernard committed
2406 2407
                                 absolute_number=axis_group.axis_element_start,
                                 parent_axis_group=axis_group)
2408 2409 2410 2411
        # 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)
2412

Romain Courteaud's avatar
Romain Courteaud committed
2413 2414
      axis_group.axis_element_stop = \
          axis_element_already_present + axis_group.axis_element_number
2415 2416 2417 2418 2419 2420
      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)
2421 2422
    if axis_element_already_present == 0:
      return 1
2423
    return axis_element_already_present
Sebastien Robin's avatar
Sebastien Robin committed
2424

2425

Romain Courteaud's avatar
Romain Courteaud committed
2426
  def buildBlocs(self, basic_structure=None, REQUEST=None):
2427 2428 2429 2430
    """
    iterate the whole planning structure to get various activities and build
    their related blocs.
    """
Thomas Bernard's avatar
Thomas Bernard committed
2431
    # recover activity and block error lists
Romain Courteaud's avatar
Romain Courteaud committed
2432 2433 2434
    warning_activity_list = REQUEST.get('warning_activity_list', [])
    error_block_list = REQUEST.get('error_block_list', [])
    error_info_dict = REQUEST.get('error_info_dict', {})
2435 2436 2437
    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:
2438
          # test if activity in warning_activity_list
2439 2440 2441 2442
          if activity.name in warning_activity_list:
            warning = 1
          else:
            warning = 0
2443 2444 2445 2446 2447 2448 2449 2450
          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
2451 2452 2453 2454 2455 2456 2457 2458 2459
          activity.addBlocs(main_axis_start=0,
                            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)

2460 2461 2462
        if axis_group_object.property_dict['stat'] == 1:
          # case stat group_object, need to update block size to display
          # stats informations
2463
          axis_group_object.updateStatBlocks()
Thomas Bernard's avatar
Thomas Bernard committed
2464
    # no problem during process, returning 'true' flag
2465
    return 1
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476


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
2477 2478 2479 2480
  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,
Romain Courteaud's avatar
Romain Courteaud committed
2481 2482 2483
                calendar_view=0, property_dict={}):
    # internal activity_name
    self.name = name
Thomas Bernard's avatar
Thomas Bernard committed
2484
    self.id = self.name
Romain Courteaud's avatar
Romain Courteaud committed
2485 2486
    # displayed activity_name
    self.title = title
2487
    self.object = object
Romain Courteaud's avatar
Romain Courteaud committed
2488 2489 2490 2491 2492 2493
    # activity, activity_error, info
    self.types = types
    # color used to render all Blocs
    self.color = color
    # link to the ERP5 object
    self.link = link
2494
    self.height = height
2495
    # self.constraints = constraints
Romain Courteaud's avatar
Romain Courteaud committed
2496 2497 2498 2499 2500 2501
    # 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
2502 2503 2504 2505
    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
2506
    self.calendar_view = calendar_view
2507
    self.property_dict = property_dict
2508

Thomas Bernard's avatar
Thomas Bernard committed
2509

Romain Courteaud's avatar
Romain Courteaud committed
2510 2511
  # XXX Still used ?
  def get_error_message(self, Error):
Thomas Bernard's avatar
Thomas Bernard committed
2512
    # need to update the error message
2513
    return 'task %s (%s)not validated' % (self.name, self.title)
Thomas Bernard's avatar
Thomas Bernard committed
2514 2515


2516 2517 2518 2519 2520 2521 2522
  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
2523 2524
    if (self.secondary_axis_begin > bound_end) or \
       (self.secondary_axis_end < bound_begin):
2525
      return 0
Thomas Bernard's avatar
Thomas Bernard committed
2526 2527
    elif (self.secondary_axis_begin > bound_begin) and \
         (self.secondary_axis_end < bound_end):
2528
      return 1
2529
    else:
2530 2531
      return 2

Thomas Bernard's avatar
Thomas Bernard committed
2532
  def addBlocs(self, main_axis_start=None, main_axis_stop=None,
2533 2534
               secondary_axis_start=None, secondary_axis_stop=None,
               secondary_axis_range=None, planning=None, warning=0,
Thomas Bernard's avatar
Thomas Bernard committed
2535
               error_block_list=[], error_info_dict={}):
2536 2537 2538 2539 2540
    """
    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
2541 2542
    if self.secondary_axis_start is not None or \
        self.secondary_axis_stop is not None:
2543
      secondary_block_bounds = self.splitActivity()
Thomas Bernard's avatar
Thomas Bernard committed
2544

2545
    else:
2546
       secondary_block_bounds = \
Romain Courteaud's avatar
Romain Courteaud committed
2547
          [[secondary_axis_start, secondary_axis_stop, 1]]
2548 2549 2550

    block_number = 0
    # iterating resulting list
Romain Courteaud's avatar
Romain Courteaud committed
2551
    for (start, stop, zone) in secondary_block_bounds:
2552 2553

      block_number += 1
2554

Thomas Bernard's avatar
Thomas Bernard committed
2555
      block_name = self.name + '_Block_' + str(block_number)
2556
      # create new block instance
2557

Thomas Bernard's avatar
Thomas Bernard committed
2558 2559
      if block_name in error_block_list:
        error = 1
Romain Courteaud's avatar
Romain Courteaud committed
2560
        error_text = error_info_dict[block_name]
Thomas Bernard's avatar
Thomas Bernard committed
2561 2562
      else:
        error = 0
Romain Courteaud's avatar
Romain Courteaud committed
2563
        error_text = ''
2564

Thomas Bernard's avatar
Thomas Bernard committed
2565 2566
      # zone property is used to check if block is an active (main activity
      # block) block or a passive one (just a display block)
2567 2568 2569 2570 2571 2572 2573 2574
      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
2575 2576
      new_block = Bloc(name= block_name,color=block_color,link=block_link,
                       number = block_number,
2577
                       calendar_view=self.calendar_view, parent_activity=self,
Thomas Bernard's avatar
Thomas Bernard committed
2578 2579 2580
                       warning=warning, error=error,
                       error_text=error_text,zone=zone,
                       property_dict=self.property_dict)
2581 2582 2583 2584

      new_block.buildInfoDict(info_dict = self.info)

      # updating secondary_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2585 2586 2587
      position_secondary = new_block.position_secondary
      if self.secondary_axis_start is not None:
        position_secondary.absolute_begin = start
2588
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2589 2590 2591
        position_secondary.absolute_begin = secondary_axis_start
      if self.secondary_axis_stop is not None:
        position_secondary.absolute_end = stop
2592
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2593 2594 2595
        position_secondary.absolute_end = secondary_axis_stop
      position_secondary.absolute_range = stop - start

2596
      # updating main_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2597 2598
      position_main = new_block.position_main
      position_main.absolute_begin = \
Thomas Bernard's avatar
Thomas Bernard committed
2599
                      self.parent_axis_element.absolute_number - 1
Romain Courteaud's avatar
Romain Courteaud committed
2600
      position_main.absolute_end = \
Thomas Bernard's avatar
Thomas Bernard committed
2601
                      self.parent_axis_element.absolute_number
Romain Courteaud's avatar
Romain Courteaud committed
2602
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2603 2604
                      new_block.position_main.absolute_end -
                      new_block.position_main.absolute_begin)
2605 2606 2607

      # now absolute positions are updated, and the axis values are known
      # (as parameters), processing relative values
2608
      # => but before updating secondary_axis bounds
Romain Courteaud's avatar
Romain Courteaud committed
2609 2610
      position_secondary.relative_begin = (
          float(position_secondary.absolute_begin -
2611
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2612 2613
      position_secondary.relative_end = (
          float(position_secondary.absolute_end -
2614
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2615 2616 2617
      position_secondary.relative_range = (
          position_secondary.relative_end -
          position_secondary.relative_begin)
2618

2619
      # new coordinates are processed from the axis properties instead of the
Romain Courteaud's avatar
Romain Courteaud committed
2620 2621
      position_main.relative_begin = (
          float(position_main.absolute_begin - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2622
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2623 2624
      position_main.relative_end = (
          float(position_main.absolute_end - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2625
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2626 2627 2628
      position_main.relative_range = (
          position_main.relative_end -
          position_main.relative_begin)
2629

2630
      try:
2631
        self.block_list.append(new_block)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2632
      except AttributeError:
2633
        # in case this is the first add
2634 2635 2636
        # need to initialize the list
        self.block_list = []
        self.block_list.append(new_block)
Thomas Bernard's avatar
Thomas Bernard committed
2637

2638 2639 2640 2641 2642 2643
      try:
        planning.content.append(new_block)
      except AttributeError:
        planning.content = []
        planning.content.append(new_block)

Thomas Bernard's avatar
Thomas Bernard committed
2644 2645
    return 1

2646 2647 2648 2649 2650 2651 2652 2653 2654 2655
  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
2656 2657
    # XXX Not implemented yet
    return [(self.secondary_axis_start, self.secondary_axis_stop,1)]
2658

Romain Courteaud's avatar
Romain Courteaud committed
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708
    # 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
2709 2710


2711 2712 2713 2714

class Bloc:
  """
  structure that will be rendered as a bloc, a task element.
Thomas Bernard's avatar
Thomas Bernard committed
2715 2716 2717 2718
  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).
2719 2720 2721 2722 2723
  Contains Bloc Structure for position informations.
  """

  def __init__ (self, name=None, types=None,
                color=None, info=None, link=None, number=0,
2724
                constraints=None, secondary_start=None, secondary_stop=None,
2725
                calendar_view=0, parent_activity = None, warning=0, error=0,
2726
                error_text='', zone=1, property_dict ={} ):
2727 2728 2729
    """
    creates a Bloc object
    """
Romain Courteaud's avatar
Romain Courteaud committed
2730 2731 2732 2733
    # internal name
    self.name = name
    # activity, activity_error, info
    self.types = types
2734
    self.color = color
Romain Courteaud's avatar
Romain Courteaud committed
2735 2736 2737 2738
    # dict containing text with their position
    self.info = info
    # on clic link
    self.link = link
2739 2740
    self.number = number
    self.title=''
Romain Courteaud's avatar
Romain Courteaud committed
2741 2742 2743
    # 1 = usefull area : 0 = useless one
    # XXX Bad naming, as it's not easy to understand
    self.zone = zone
2744 2745
    self.parent_activity = parent_activity
    self.constraints = constraints
Thomas Bernard's avatar
Thomas Bernard committed
2746 2747 2748 2749
    # setting warning and error flags in case parent_activity or block itself
    # have not been validated
    self.warning = warning
    self.error = error
2750
    self.error_text = error_text
2751 2752 2753 2754 2755
    # 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
2756 2757
    self.position_secondary = \
          Position(absolute_begin=secondary_start,absolute_end=secondary_stop)
2758
    if calendar_view == 0:
2759 2760 2761 2762 2763 2764
      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
2765
    self.property_dict = property_dict # dict containing internal properties
2766

Romain Courteaud's avatar
Romain Courteaud committed
2767
  def buildInfoDict(self, info_dict=[]):
2768
    """
Thomas Bernard's avatar
Thomas Bernard committed
2769 2770
    create Info objects to display text & images, then link them to the
    current object
2771 2772
    """
    # updating title
2773 2774 2775 2776 2777
    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
2778 2779 2780 2781 2782 2783 2784
      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
2785 2786 2787 2788
      if info_dict.has_key('info_tooltip'):
        self.title = info_dict['info_tooltip']
      else:
        self.title = " | ".join(title_list)
2789

2790 2791 2792 2793
    if self.error != 0:
      # field has error
      # adding text_error
      self.info['info_error'] = Info(info=self.error_text, link='')
2794 2795 2796 2797 2798 2799 2800 2801 2802

  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
2803
    else:
2804
      return ''
Sebastien Robin's avatar
Sebastien Robin committed
2805

2806 2807 2808 2809 2810 2811 2812
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
2813 2814 2815
  def __init__ (self, absolute_begin=None, absolute_end=None,
                absolute_range=None, relative_begin=None, relative_end=None,
                relative_range=None):
2816 2817 2818
    # 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
2819
    self.absolute_range = absolute_range
2820
    # relative size in % of the current axis size
2821 2822
    self.relative_begin = relative_begin
    self.relative_end = relative_end
Thomas Bernard's avatar
Thomas Bernard committed
2823
    self.relative_range = relative_range
2824 2825 2826 2827


class Axis:
  """
2828
  Structure holding informations about a specified axis. Can be X or Y axis.
2829 2830 2831 2832 2833 2834
  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
2835 2836
  def __init__(self, title=None, unit=None, types=None, axis_order=None,
               name=None, axis_group=None):
2837 2838 2839 2840 2841 2842
    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.
2843
    # defined to be able to use a generic and recursive method to
2844 2845
    self.axis_group = axis_group
    # specify if axis is primary or secondary.
2846
    # - if primary axis in Planning, zoom selection is applied thanks to
2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
    # 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.
  """

2865 2866
  def __init__ (self, name='', title='', object = None,
                axis_group_list=None, axis_group_number=0,
Thomas Bernard's avatar
Thomas Bernard committed
2867 2868 2869 2870
                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,
2871
                secondary_axis_range=None, link=None,
Thomas Bernard's avatar
Thomas Bernard committed
2872
                property_dict={}):
2873 2874
    self.name = name
    self.title = title
2875 2876 2877
    # link to fold or unfold report in report-tree mode and also 
    # special link on header columns
    self.link = link
2878
    self.info_title = Info(info=self.title, link=self.link, title=self.title)
Romain Courteaud's avatar
Romain Courteaud committed
2879 2880 2881 2882 2883 2884 2885
    # 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
2886
    self.axis_group_number = axis_group_number
Romain Courteaud's avatar
Romain Courteaud committed
2887 2888
    # Multitasking
    self.axis_element_list = axis_element_list
2889
    self.axis_element_number = axis_element_number
2890 2891
    self.axis_element_start = None
    self.axis_element_stop = None
Thomas Bernard's avatar
Thomas Bernard committed
2892
    self.delimiter_type = delimiter_type
2893 2894
    # define the kind of separator used in graphic rendering
    # 0 for standard, 1 for bold, 2 for 2x bold
2895 2896 2897 2898 2899
    # 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
2900 2901
    # url to the object
    self.url = url
2902

2903 2904 2905 2906
    self.position_main = Position()
    self.position_secondary = Position()
    self.position_x = None
    self.position_y = None
2907 2908
    # secondary_axis_bounds are specified for each axis_group to handle
    # calendar view.
2909 2910
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
2911 2912 2913 2914 2915
    # 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
2916
    self.property_dict = property_dict
2917 2918


2919
  security = ClassSecurityInfo()
Romain Courteaud's avatar
Romain Courteaud committed
2920

2921
  security.declarePublic('setTitle')
Romain Courteaud's avatar
Romain Courteaud committed
2922
  def setTitle(self, new_title=None):
2923 2924
    self.title = new_title

2925 2926 2927 2928 2929
  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
2930
    info_title = self.info_title
2931 2932
    if self.is_open:
      # current report is unfold, action 'fold'
Romain Courteaud's avatar
Romain Courteaud committed
2933
      info_title.link = 'foldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2934 2935
                              '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2936
      info_title.info = '[-] ' + str(info_title.info)
Sebastien Robin's avatar
Sebastien Robin committed
2937
    else:
2938
      # current report is fold, action 'unfold'
Romain Courteaud's avatar
Romain Courteaud committed
2939
      info_title.link = 'unfoldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2940 2941
                             '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2942
      info_title.info = '[+] ' + str(info_title.info)
2943 2944 2945

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

Romain Courteaud's avatar
Romain Courteaud committed
2948
    self.tooltip = info_title.info
2949

Sebastien Robin's avatar
Sebastien Robin committed
2950

2951
  def addActivity(self, activity=None, axis_element_already_insered=0,
2952
                  basic_structure=None):
2953
    """
2954
    Procedure that permits to add activity to the corresponding AxisElement in
2955
    an AxisGroup. This can create new Axis Element in the actual AxisGroup if
2956
    necessary. Permits representation of MULTITASKING
2957 2958 2959 2960
    """

    # declaring variable used to check if activity has already been added
    added = 0
Romain Courteaud's avatar
Romain Courteaud committed
2961 2962
    # XXX To much code inside the try: it's not possible to see
    # which part must not fails...
2963 2964 2965 2966 2967 2968 2969
    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
2970
          if activity_statement.isValidPosition(activity.secondary_axis_begin,
2971
                                      activity.secondary_axis_end) != 0:
2972 2973
            # isValidPosition returned 1 or 2, this means the activity already
            # present does prevent from adding the new activity as there is
2974
            # coverage on the current axis_element.
2975
            # stop iterating actual axis_element and try with the next one
2976 2977 2978 2979
            if activity_statement.object.getUid() not in \
                            basic_structure.sec_layer_uid_list:
              can_add = 0
              break
2980

2981 2982 2983 2984 2985 2986
        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)
2987

2988 2989
          # updating activity properties
          activity.parent_axis_element = axis_element
2990

Thomas Bernard's avatar
Thomas Bernard committed
2991 2992
          # 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
2993
          break
2994

2995
      if not added:
Thomas Bernard's avatar
Thomas Bernard committed
2996 2997
        # all axis_elements of the current group have been tested and no one
        # can contain the new activity.
2998 2999
        self.axis_element_number += 1
        # Need to create a new axis_element to hold the new activity
Romain Courteaud's avatar
Romain Courteaud committed
3000
        new_axis_element=AxisElement(name='Group_%s_AxisElement_%s' % \
Thomas Bernard's avatar
Thomas Bernard committed
3001 3002 3003 3004 3005
                                          (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)
3006

3007 3008 3009
        # add new activity to this brand new axis_element
        new_axis_element.activity_list = []
        new_axis_element.activity_list.append(activity)
3010

3011 3012
        # updating activity properties
        activity.parent_axis_element = new_axis_element
3013

3014 3015 3016
        # register the axis_element to the actual group.
        self.axis_element_list.append(new_axis_element)
    except TypeError:
3017
      # in case axis_element_list is Empty (first activity to the group)
3018 3019
      # Need to create a new axis_element to hold the new activity
      self.axis_element_number += 1
Thomas Bernard's avatar
Thomas Bernard committed
3020 3021 3022 3023 3024 3025 3026 3027
      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
3028

3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040
      # 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
3041
  def addStatActivities(self, basic_activity_list=None, axis_group_number=0,
3042
                        axis_element_already_present= 0, calendar_view=0,
Thomas Bernard's avatar
Thomas Bernard committed
3043
                        primary_axis_block=None, property_dict={}):
3044 3045 3046 3047 3048 3049
    """
    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
3050 3051 3052 3053 3054 3055
    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)
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
    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
3066
      activity = Activity(name= 'Group_%s_Activity_%s'
Thomas Bernard's avatar
Thomas Bernard committed
3067 3068
                               %(str(axis_group_number),
                                 str(activity_number)),
3069 3070 3071 3072
                          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
3073 3074 3075 3076 3077 3078 3079 3080
                          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,
3081 3082 3083
                          height=basic_activity_object.height,
                          primary_axis_block=primary_axis_block,
                          info=basic_activity_object.info_dict,
3084
                          calendar_view=calendar_view,
3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103
                          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
3104 3105
    activity_list = self.axis_element_list[0].activity_list
    max_activity_height = max([0]+[x.height for x in activity_list])
3106 3107 3108

    # now max height is known, just need to adapt size of all the blocks
    # composing the activities
Romain Courteaud's avatar
Romain Courteaud committed
3109 3110 3111
    for activity in activity_list:
      height = activity.height
      if height in (0, None):
3112 3113
        relative_size = 1
      else:
Romain Courteaud's avatar
Romain Courteaud committed
3114
        relative_size = float(height) / max_activity_height
3115 3116
      for block in activity.block_list:
        # recovering original values
Romain Courteaud's avatar
Romain Courteaud committed
3117 3118 3119 3120
        position_main = block.position_main
        block_range = position_main.relative_range
        block_begin = position_main.relative_begin
        block_end   = position_main.relative_end
3121 3122 3123 3124 3125
        # 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
3126 3127
        position_main.relative_begin = final_begin
        position_main.relative_range = final_range
Thomas Bernard's avatar
Thomas Bernard committed
3128
    return 1
3129

3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
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
3140 3141
  def __init__ (self, name='', relative_number=0, absolute_number=0,
                activity_list=None, parent_axis_group=None):
3142
    self.name = name
Romain Courteaud's avatar
Romain Courteaud committed
3143 3144 3145 3146
    # relative number / AxisGroup
    self.relative_number = relative_number
    # id in the current rendering
    self.absolute_number = absolute_number
3147 3148 3149 3150 3151 3152 3153 3154
    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
3155 3156
  Class holding all informations to display an info text div inside of a block
  or AxisGroup or whatever
3157 3158 3159 3160 3161 3162 3163 3164 3165
  """
  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
3166 3167 3168 3169
    """
    Special method allowing to update Info content from an external script
    """
    self.info = info
3170 3171 3172

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

Romain Courteaud's avatar
Romain Courteaud committed
3174

Sebastien Robin's avatar
Sebastien Robin committed
3175
class PlanningBox(ZMIField):
Romain Courteaud's avatar
Romain Courteaud committed
3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
  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)

3194 3195 3196
  def render_css(self, REQUEST=None):
    return self.widget.render_css(self, REQUEST)

3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212
# 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
3213 3214 3215 3216 3217 3218 3219
# Allow classes in ZMI
for klass in (PlanningBoxWidget, BasicStructure, BasicGroup,
              BasicActivity, PlanningStructure, Activity,
              Bloc, Position, Axis, AxisGroup, AxisElement,
              Info):
  InitializeClass(klass)
  allow_class(klass)
3220 3221 3222 3223

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