PlanningBox.py 130 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 101 102

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

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

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

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

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

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

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

Thomas Bernard's avatar
Thomas Bernard committed
232 233 234
      # 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
235
      group_destination = self.getDestinationGroup(basic, planning,
Thomas Bernard's avatar
Thomas Bernard committed
236 237
               block_moved,planning_coordinates['main_axis'],
               group_position, group_length)
238

Romain Courteaud's avatar
Romain Courteaud committed
239
      if group_destination is None:
Thomas Bernard's avatar
Thomas Bernard committed
240 241 242 243 244
        # !! 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'])
245
        error_info_dict[block_moved['name']] = 'out of bounds on main axis'
Thomas Bernard's avatar
Thomas Bernard committed
246 247 248 249
        # 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)

250 251 252
      else:
        # now that all informations about the main axis changes are
        # known, checking modifications over the secondary axis.
253
        secondary_axis_positions = self.getDestinationBounds(basic, planning,
254 255 256 257 258 259 260 261 262 263 264 265
                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
266 267


268 269 270 271 272 273 274 275 276 277 278 279
      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]

280 281 282

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

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

360
      update_dict[object_name] = {}
Romain Courteaud's avatar
Romain Courteaud committed
361
      if can_update_start and axis_start is not None:
362
        update_dict[object_name][start_property] = axis_start
Romain Courteaud's avatar
Romain Courteaud committed
363
      if can_update_stop  and axis_stop  is not None:
364
        update_dict[object_name][stop_property]  = axis_stop
Thomas Bernard's avatar
Thomas Bernard committed
365 366 367 368 369 370 371 372 373 374 375 376 377

    # 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)
378 379 380 381 382
      REQUEST.set('error_info_dict',error_info_dict)
      # now raise error => automatically called
      # parameters are :
      # -list of errors
      # - dict with error results
Romain Courteaud's avatar
Romain Courteaud committed
383
      raise FormValidationError(errors_list, {})
Thomas Bernard's avatar
Thomas Bernard committed
384

Romain Courteaud's avatar
Romain Courteaud committed
385 386 387
    # the whole process is now finished, 
    # just need to return editor for updating data
    return PlanningBoxEditor(field.id, update_dict)
388

Thomas Bernard's avatar
Thomas Bernard committed
389 390
  def getBlockPositionFromString(self, block_string):
    """
391
    Takes a string with block data and convert it to a list of dicts
Thomas Bernard's avatar
Thomas Bernard committed
392 393 394 395 396 397
    """
    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
398 399 400 401 402 403 404 405 406
        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
407
        block_list.append(block_dict)
Romain Courteaud's avatar
Romain Courteaud committed
408
    return block_list
Thomas Bernard's avatar
Thomas Bernard committed
409

Romain Courteaud's avatar
Romain Courteaud committed
410
  def setBlockPositionToString(self, block_list):
Thomas Bernard's avatar
Thomas Bernard committed
411
    """
Romain Courteaud's avatar
Romain Courteaud committed
412
    Takes a list of dicts updated and convert it to a string in order to save
Thomas Bernard's avatar
Thomas Bernard committed
413 414 415 416 417 418 419 420
    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
421 422
        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
423 424
        block_object_list.append(block_sub_string)
      block_string = '*'.join(block_object_list)
Romain Courteaud's avatar
Romain Courteaud committed
425
    return block_string
426 427 428 429 430 431 432

  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:
433
        return block 
434 435


436
  def getDestinationGroup(self, basic, planning, block_moved, axis_groups,
Thomas Bernard's avatar
Thomas Bernard committed
437
                                group_position, group_length):
438 439 440 441 442 443 444 445
    """
    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
446 447 448
      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']:
449 450 451 452
        # 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
453
    # if no group is found, this means the block is outside the bounds
454 455 456
    if good_group_name == '':
      return None
    # group name is known, searching corresponding group object
457
    for group in planning.main_axis.axis_group:
458 459 460 461 462
      if group.name == good_group_name:
        return group
    return None


463
  def getDestinationBounds(self, basic, planning, block_moved, block_object,
464 465
                                 planning_coordinates, axis_length,
                                 destination_group=None):
466 467 468 469
    """
    check the new bounds of the block over the secondary axis according to its
    new position
    """
Thomas Bernard's avatar
Thomas Bernard committed
470
    error = 0
471 472 473 474 475
    # 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.
476 477 478
    # => 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
479
    delta_start = block_moved['secondary_axis_position'] / \
480
                  planning_coordinates['frame']['planning_content'][axis_length]
Thomas Bernard's avatar
Thomas Bernard committed
481 482
    delta_stop  = (block_moved['secondary_axis_position'] + \
                  block_moved['secondary_axis_length']) / \
483
                  planning_coordinates['frame']['planning_content'][axis_length]
484 485 486 487

    # 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
488 489
      # can not validate it : returning None
      error = 1
490 491 492
    else:
      if delta_start < 0 or delta_stop > 1:
        # part of the block is inside
493 494
        # should handle support for correcting bounds : user should not be able
        # to define any data out of its group bounds.
495 496
        pass

497
    if basic.calendar_mode:
498 499 500 501 502 503
      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:
504 505
      axis_range = basic.secondary_axis_info['bound_stop'] - \
                   basic.secondary_axis_info['bound_start']
Thomas Bernard's avatar
Thomas Bernard committed
506

507
      # defining new final block bounds
508
      new_start = basic.secondary_axis_info['bound_start'] + \
509
                  delta_start * axis_range
510
      new_stop  = basic.secondary_axis_info['bound_start'] + \
511
                  delta_stop * axis_range
Thomas Bernard's avatar
Thomas Bernard committed
512 513

    return [new_start,new_stop, error]
514

Thomas Bernard's avatar
Thomas Bernard committed
515 516
  def getActivityBounds(self, activity, activity_block_moved_list,
                              activity_block_list):
517
    """
518 519 520 521
    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 !

522 523 524 525 526 527
    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
528 529
    block_moved_name_list = [x['block_moved']['name'] for x in activity_block_moved_list]
    
530 531 532 533 534 535 536 537
    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
538 539
            temp_start = temp_block_moved['block_moved']['secondary_axis_start']
            temp_stop  = temp_block_moved['block_moved']['secondary_axis_stop']
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
            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
558
    # checking weither activity has been cut-off to fit the planning bounds
559 560 561 562
    #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
563 564 565

    return [new_start,new_stop]

566
  def getObjectDict(self, basic, planning):
567 568 569 570 571 572
    """
    Takes all activities related to a specified object and return
    """
    # init dict
    object_dict = {}
    # get property_names
573 574
    start_property = basic.field.get_value('x_start_bloc')
    stop_property = basic.field.get_value('x_stop_bloc')
575
    # get full axis length
576 577 578
    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:
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 605 606 607 608 609 610 611 612 613 614 615
      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
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
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)

637 638 639 640 641 642
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
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
  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
     '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',
     'portal_types', 'sort',
     'list_method',
     # 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',
     'info_backleft', 'info_backright'
     ]
673 674 675

  # Planning properties (accessed through Zope Management Interface)

676 677 678
  # kind of representation to render :
  # Planning or Calendar
  js_enabled = fields.CheckBoxField('js_enabled',
679
      title='enable on the fly edition (based on java script)',
680 681 682
      description='define if javascript is enabled or not on the current Planning',
      default=1,
      required=1)
683 684 685

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

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

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

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

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


759 760
  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
761 762 763 764 765
      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)
766

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


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


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

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

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

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

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

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

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

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

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

839
  y_size_block = fields.StringField('y_size_block',
Rafael Monnerat's avatar
Rafael Monnerat committed
840
      title='Specific property to get height of blocks (ex.quantity)',
Romain Courteaud's avatar
Romain Courteaud committed
841
      description='Method for building height of blocks objects',
842
      default='quantity',
843
      required=0)
844 845 846

  constraint_method = fields.StringField('constraint_method',
      title='name of constraint method between blocks',
Romain Courteaud's avatar
Romain Courteaud committed
847
      description='Constraint method between blocks objects',
848 849 850
      default='SET_DHTML',
      required=1)

851
  stat_method = fields.StringField('stat_method',
Rafael Monnerat's avatar
Rafael Monnerat committed
852
      title="Name of script generating statistics",
Romain Courteaud's avatar
Romain Courteaud committed
853
      description="script for statistics",
854 855 856
      default='',
      required=0)

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

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

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

876

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

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

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

  info_topleft = fields.StringField('info_topleft',
Romain Courteaud's avatar
Romain Courteaud committed
901 902 903 904
      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',
905 906 907 908
      default='',
      required=0)

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

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

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

931
  def render_css(self, field, REQUEST):
932 933 934 935 936 937
    """
    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
    """
938
    context = getContext(field, REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
939 940 941 942
    # 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
943 944
    basic, planning = self.render_structure(field=field, REQUEST=REQUEST, 
                                            context=context)
Thomas Bernard's avatar
Thomas Bernard committed
945
    # getting CSS script generator
946
    planning_css_method = getattr(context, 'planning_css')
Thomas Bernard's avatar
Thomas Bernard committed
947
    # recover CSS data buy calling DTML document
948
    CSS_data = planning_css_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
949
    # saving structure inside the request for HTML render
Romain Courteaud's avatar
Romain Courteaud committed
950
    # XXX This prevent multiple planning box on the same form
951 952
    REQUEST.set('basic', basic)
    REQUEST.set('planning', planning)
953

Thomas Bernard's avatar
Thomas Bernard committed
954
    return CSS_data
955

Romain Courteaud's avatar
Romain Courteaud committed
956
  def render(self, field, key, value, REQUEST):
957
    """
958
    Method called to render the HTML code relative to the planning.
959 960 961 962 963 964 965
    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
966 967
    basic = REQUEST.get('basic')
    planning = REQUEST.get('planning')
968

Thomas Bernard's avatar
Thomas Bernard committed
969
    # getting HTML rendering Page Template
970 971
    planning_html_method = getattr(getContext(field, REQUEST), 
                                   'planning_content')
Thomas Bernard's avatar
Thomas Bernard committed
972
    # recovering HTML data by calling Page Template document
973
    HTML_data = planning_html_method(basic=basic, planning=planning)
Thomas Bernard's avatar
Thomas Bernard committed
974 975
    # return HTML data
    return HTML_data
976

977
  def render_structure(self, field, REQUEST, context):
Romain Courteaud's avatar
Romain Courteaud committed
978 979 980 981 982 983 984 985
    """
    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
986 987 988
    # XXX testing : uncoment to put selection to null => used for debugging
    #here.portal_selections.setSelectionFor(selection_name, None)
    ####### DATA DEFINITION #######
989
    # recovering usefull planning properties
990 991 992 993 994 995 996
    # getting form
    form = field.aq_parent
    list_method = field.get_value('list_method')
    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')
997
    # selection name used to store selection params
Sebastien Robin's avatar
Sebastien Robin committed
998
    selection_name = field.get_value('selection_name')
999
    # getting sorting keys and order (list)
Sebastien Robin's avatar
Sebastien Robin committed
1000
    sort = field.get_value('sort')
1001 1002
    # 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
1003 1004 1005
    list_error = REQUEST.get('list_block_error')
    if list_error is None:
      list_error = []
1006
    selection = context.portal_selections.getSelectionFor(
1007 1008 1009 1010 1011
                      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
1012
    except (AttributeError, KeyError):
1013
      params = {}
Romain Courteaud's avatar
Romain Courteaud committed
1014

Thomas Bernard's avatar
Thomas Bernard committed
1015
    ###### CALL CLASS METHODS TO BUILD BASIC STRUCTURE ######
1016
    # creating BasicStructure instance (and initializing its internal values)
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
    basic = BasicStructure(context=context,
                           form=form, field=field,
                           REQUEST=REQUEST, list_method=list_method,
                           selection=selection, params=params,
                           selection_name=selection_name,
                           title_line=title_line,
                           report_root_list=report_root_list,
                           portal_types=portal_types,
                           sort=sort,
                           list_error=list_error)
1027
    # call build method to generate BasicStructure
1028
    status = basic.build()
Thomas Bernard's avatar
Thomas Bernard committed
1029
    if status != 1:
1030
      raise PlanningBoxError, status
1031

Thomas Bernard's avatar
Thomas Bernard committed
1032
    ###### CALL CLASS METHODS TO BUILD PLANNING STRUCTURE ######
1033
    # creating PlanningStructure instance and initializing its internal values
1034
    planning = PlanningStructure()
1035
    # call build method to generate final Planning Structure
1036 1037 1038
    status = planning.build(basic_structure=basic,
                            field=field,
                            REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
1039 1040
    if status != 1:
      # in case error during planning structure generation
1041
      raise PlanningBoxError, status
1042

1043
    return basic, planning
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

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

1057
  def __init__ (self, context='', form='', field='', REQUEST='', list_method='',
Romain Courteaud's avatar
Romain Courteaud committed
1058 1059 1060
                selection=None, params = '', selection_name='',
                report_root_list='', title_line='', portal_types='',
                sort=None, list_error=None):
1061 1062
    """
    Init main internal parameters
Rafael Monnerat's avatar
Rafael Monnerat committed
1063
    """
1064
    self.context = context
1065 1066 1067 1068 1069 1070 1071
    self.form = form
    self.field = field
    self.REQUEST = REQUEST
    self.sort = sort
    self.selection = selection
    self.params = params
    self.list_method = list_method
1072
    self.title_line = title_line
Thomas Bernard's avatar
Thomas Bernard committed
1073
    self.selection_name = selection_name
1074 1075 1076
    self.report_root_list = report_root_list
    self.portal_types = portal_types
    self.basic_group_list = None
Romain Courteaud's avatar
Romain Courteaud committed
1077 1078
    # needed to generate groups
    self.report_groups= ''
1079 1080
    self.list_error = list_error
    self.secondary_axis_occurence = []
Romain Courteaud's avatar
Romain Courteaud committed
1081 1082 1083
    # 'list' in case output is a list containing the
    # full planning structure without any selection
    self.render_format = ''
1084 1085 1086 1087 1088
    self.main_axis_info = {}
    self.secondary_axis_info = {}

  def build(self):
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1089
    Build BasicStructure from given parameters, and for that do the
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    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
Romain Courteaud's avatar
Romain Courteaud committed
1102
    # XXX Use seclection tool API
1103
    if self.selection is None:
Thomas Bernard's avatar
Thomas Bernard committed
1104 1105
      self.selection = Selection(params=default_params,
                                 default_sort_on=self.sort)
Sebastien Robin's avatar
Sebastien Robin committed
1106
    else:
1107 1108 1109 1110
      # immediately updating the default sort value
      self.selection.edit(default_sort_on=self.sort)
      self.selection.edit(sort_on=self.sort)

1111
    self.context.portal_selections.setSelectionFor(
Romain Courteaud's avatar
Romain Courteaud committed
1112 1113 1114
                                        self.selection_name,
                                        self.selection,
                                        REQUEST=self.REQUEST)
1115 1116

    # building list of portal_types
Romain Courteaud's avatar
Romain Courteaud committed
1117
    self.filtered_portal_types = [x[0] for x in self.portal_types]
1118 1119 1120 1121 1122 1123 1124
    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())
1125
    self.selection.edit(report_opened=is_report_opened)
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
    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']
    if hasattr(self.list_method, 'method_name'):
      if self.list_method.method_name == 'ObjectValues':
        # list_method is available
1144
        self.list_method = self.context.objectValues
1145
        kw = copy(self.params)
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
      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
1160
          if self.params[cname] != '' and self.params[cname] is not None:
1161 1162 1163
            kw[cname] = self.params[cname]
        # try to get the method through acquisition
        try:
1164
          self.list_method = getattr(self.context, self.list_method.method_name)
1165 1166 1167 1168 1169 1170
        except (AttributeError, KeyError):
          pass
    elif self.list_method in (None,''):
      # use current selection
      self.list_method = None

1171 1172 1173 1174
    ##################################################
    ############## DEFINING STAT METHOD ##############
    ##################################################
    stat_method = self.field.get_value('stat_method')
1175
    stat_method = getattr(self.context, stat_method, None)
Romain Courteaud's avatar
Romain Courteaud committed
1176
    if stat_method is None:
1177
      show_stat = 0
1178 1179
    else:
      show_stat = 1
1180

1181 1182 1183 1184 1185 1186 1187
    ##################################################
    ############ 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)
1188

1189 1190 1191 1192 1193
    try:
      default_selection_report_path = self.report_root_list[0][0].split('/')[0]
    except (IndexError):
      message = 'report path is empty or not valid, please check selection\
                 report path in Planning properties'
1194
      return [(Message(domain='erp5_ui', message=message,mapping=None))]
1195 1196
    if (default_selection_report_path in portal_categories.objectIds()) or \
      (portal_domains is not None and default_selection_report_path in \
1197
       portal_domains.objectIds()):
1198 1199 1200
      pass
    else:
      default_selection_root_path = self.report_root_list[0][0]
1201
    self.selection_report_path = self.selection.getReportPath(default = \
1202
     (default_selection_report_path,))
1203 1204

    if self.selection_report_path in (None,()):
1205
      message = 'report path is empty or not valid'
1206
      return [(Message(domain='erp5_ui', message=message,mapping=None))]
1207 1208 1209

    # testing report_depth value
    if report_depth is not None:
1210
      selection_report_current = ()
1211 1212
    else:
      selection_report_current = self.selection.getReportList()
1213

1214
    # building report_tree_list
1215
    report_tree_list = makeTreeList(here=self.context, form=self.form,
Thomas Bernard's avatar
Thomas Bernard committed
1216
                                    root_dict=None,
1217
                                    report_path=self.selection_report_path,
Thomas Bernard's avatar
Thomas Bernard committed
1218 1219 1220
                                    base_category=None, depth=0,
                                    unfolded_list=selection_report_current,
                                    selection_name=self.selection_name,
1221
                                    report_depth=report_depth,
1222
                                    list_method=self.list_method,
Rafael Monnerat's avatar
Rafael Monnerat committed
1223
                                    filtered_portal_types= \
1224
                                                self.filtered_portal_types,
1225 1226 1227
                                    is_report_opened=is_report_opened,
                                    sort_on=self.selection.sort_on,
                                    form_id=self.form.id)
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

    ##################################################
    ########### 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=[]
    self.report_activity_dict = {}
    indic_line=0
    index_line=0
1248
    blocks_object={}
1249 1250
    select_expression = ''

1251
    # now iterating through report_tree_list
Romain Courteaud's avatar
Romain Courteaud committed
1252
#     LOG('PlanningBox, build', 0, 'report_tree_list %s' % len(report_tree_list))
1253
    for object_tree_line in report_tree_list:
Romain Courteaud's avatar
Romain Courteaud committed
1254
#       LOG('PlanningBox, build', 0, 'object_tree_line %s' % str(object_tree_line))
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
      # prepare query by defining selection report object
      # defining info_dict, holding all information about the current object.
      info_dict = None
      info_dict = {}

      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)
1268 1269
        # recovering statistics if needed
        # getting list of statistic blocks
Thomas Bernard's avatar
Thomas Bernard committed
1270 1271
        stat_list = stat_method(selection=self.selection,
                                list_method=self.list_method,
1272
                                selection_context=self.context,
Thomas Bernard's avatar
Thomas Bernard committed
1273 1274 1275
                                report_tree_list=report_tree_list,
                                object_tree_line=object_tree_line,
                                REQUEST=self.REQUEST, field=self.field)
1276

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
        if original_select_expression is None:
          del kw['select_expression']
        else:
          kw['select_expression'] = original_select_expression

        # 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

        # processing all cases
        self.selection.edit(params = kw)
1292

1293 1294 1295 1296 1297 1298
        # recovering object list
        if self.list_method not in (None,''):
          # valid list_method has been found
          self.selection.edit(exception_uid_list= \
             object_tree_line.getExceptionUidList())
          object_list = self.selection(method = self.list_method,
1299
                        context=self.context, REQUEST=self.REQUEST)
1300 1301
        else:
          # no list_method found
1302 1303 1304 1305
          # XXX seems to be buggy :
          #object_list = self.here.portal_selections.getSelectionValueList(
          #  self.selection_name, context=self.here, REQUEST=self.REQUEST)
          message = 'No list method found, please check planningBox properties'
1306
          return [(Message(domain='erp5_ui', message=message,mapping=None))]
1307 1308 1309

        # recovering exeption_uid_list
        exception_uid_list = object_tree_line.getExceptionUidList()
1310 1311 1312
        # XXX filter the object to the right domain.
        # Can be improved in future.
        domain_obj = object_tree_line.getObject()
1313
        new_object_list = []
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
        if domain_obj.getPortalType() == 'Domain':
          category_obj = domain_obj.getMembershipCriterionCategory()
          membership_base_category = domain_obj.getMembershipCriterionBaseCategory()
          if (category_obj is not None) and (membership_base_category is not None):
            category_value = (membership_base_category + '/' +category_obj.getRelativeUrl())
            for selected_object in object_list:
              if category_value in selected_object.getCategoriesList():
                 new_object_list.append(selected_object)
            object_list = new_object_list


        if exception_uid_list not in ([],None) :
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
          # Filter folders if parent tree :
          # build new object_list for current line
          # (list of relative elements)
          new_object_list = []
          for selected_object in object_list:
            if selected_object.getUid() not in exception_uid_list:
              new_object_list.append(selected_object)
          object_list = new_object_list

        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:
            # do nothing
            # case of parent tree unfolded (second object and no stats)
            pass
        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:
            if exception_uid_list is not None:
              # 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
1359 1360
              # do not export voluntary object_list to prevent bad
              # interpretation
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
              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)
1372
    #self.selection.edit(report_list=None) # comment to save report_list status
1373

1374 1375 1376
    # update report list if report_depth was specified
    if report_depth is not None:
      unfolded_list = []
1377 1378
      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
1379 1380 1381
          # depth of current report_line is inferior to the current
          # report_depth and current report_line is not stat line.
          # saving information
1382 1383 1384
          unfolded_list.append(report_line.getObject().getRelativeUrl())
      self.selection.edit(report_list=unfolded_list)

Thomas Bernard's avatar
Thomas Bernard committed
1385

1386 1387 1388 1389 1390 1391 1392
    ##################################################
    ############## CHECKING CONSTRAINTS ##############
    ##################################################
    # XXX Constraints checking chould be called here
    # and results saved in a list (list of url corresponding to objects not
    # validated)

1393 1394 1395 1396 1397
    ##################################################
    ########### 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
Thomas Bernard's avatar
Thomas Bernard committed
1398 1399
    # only the area that need to be rendered. This prevents from useless
    # processing
1400 1401 1402
    # calculating main axis bounds
    self.getMainAxisInfo(self.main_axis_info)
    # applying main axis selection
1403
    if self.report_groups != []:
Thomas Bernard's avatar
Thomas Bernard committed
1404 1405
      self.report_groups=self.report_groups[self.main_axis_info['bound_start']:
                                            self.main_axis_info['bound_stop']]
1406
    else:
Thomas Bernard's avatar
Thomas Bernard committed
1407
      # ERROR : self.report_groups = []
1408
      # no group is available so the Y and X axis will be empty...
1409
      message= 'selection method returned empty list of objects : please check\
Thomas Bernard's avatar
Thomas Bernard committed
1410
                your list_method and report_root'
1411
      return [(Message(domain='erp5_ui', message=message,mapping=None))]
1412 1413 1414 1415 1416


    ##################################################
    ############ GETTING SEC AXIS BOUNDS #############
    ##################################################
Thomas Bernard's avatar
Thomas Bernard committed
1417 1418
    # now that our report_group structure has been cut need to get secondary
    # axis bounds to add only the blocs needed afterwards
1419 1420
    # getting secondary_axis_occurence to define begin and end secondary_axis
    # bounds (getting absolute size)
1421 1422 1423 1424 1425
    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.

1426 1427
    # now getting start & stop bounds (getting relative size to the current
    # rendering)
Thomas Bernard's avatar
Thomas Bernard committed
1428 1429 1430 1431 1432
    status = self.getSecondaryAxisInfo(self.secondary_axis_info)
    if status != 1:
      # ERROR
      # Found error while setting secondary axis bounds
      return status
1433 1434 1435 1436 1437 1438

    ##################################################
    ####### SAVING NEW PROPERTIES INTO REQUEST #######
    ##################################################
    if self.list_method is not None and self.render_format != 'list':
     self.selection.edit(params = self.params)
1439
     self.context.portal_selections.setSelectionFor(self.selection_name,
Thomas Bernard's avatar
Thomas Bernard committed
1440 1441
                                                 self.selection,
                                                 REQUEST = self.REQUEST)
1442 1443 1444 1445 1446 1447 1448 1449 1450

    ##################################################
    ######### 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
Thomas Bernard's avatar
Thomas Bernard committed
1451 1452 1453 1454 1455
    status = self.buildGroupStructure()
    if status != 1:
      # ERROR
      # Found errors while setting group structure
      return status
1456 1457 1458
    # everything is fine
    return 1

1459 1460
  def getSecondaryAxisOccurence(self):
    """
Thomas Bernard's avatar
Thomas Bernard committed
1461 1462 1463
    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
1464 1465
    """
    secondary_axis_occurence = []
1466 1467

    # defining the objects requested for calendar mode testing
1468
    if 'parent' in self.selection_report_path :
1469 1470 1471 1472 1473 1474 1475
      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
1476 1477

    # specific start & stop methods name for secondary axis
Thomas Bernard's avatar
Thomas Bernard committed
1478 1479
    start_property_id = self.field.get_value('x_start_bloc')
    stop_property_id= self.field.get_value('x_stop_bloc')
1480
    for (object_tree_group, object_list, info_dict) in self.report_groups:
1481

1482 1483 1484 1485 1486 1487 1488
      # defining empty list for each kind of occurence.
      group_list = None
      group_list = []
      item_list = None
      item_list = []

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

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
    self.secondary_axis_occurence =  secondary_axis_occurence
1551 1552 1553 1554 1555 1556 1557 1558

  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.
    """
Thomas Bernard's avatar
Thomas Bernard committed
1559
    # recovering zoom properties
1560 1561 1562 1563 1564 1565 1566
    axis_dict['zoom_start'] = int(self.params.get('zoom_start',0))
    axis_dict['zoom_level'] = float(self.params.get('zoom_level',1))

    # recovering min and max bounds to get absolute bounds
    axis_dict['bound_begin'] = self.secondary_axis_occurence[0][0]
    axis_dict['bound_end'] = axis_dict['bound_begin']
    for occurence in self.secondary_axis_occurence:
Thomas Bernard's avatar
Thomas Bernard committed
1567
      if (occurence[0] < axis_dict['bound_begin'] or \
Romain Courteaud's avatar
Romain Courteaud committed
1568
          axis_dict['bound_begin'] is None) and occurence[0] is not None:
1569
        axis_dict['bound_begin'] = occurence[0]
Thomas Bernard's avatar
Thomas Bernard committed
1570
      if (occurence[1] > axis_dict['bound_end'] or  \
Romain Courteaud's avatar
Romain Courteaud committed
1571
          axis_dict['bound_end'] is None) and occurence[1] is not None:
1572
        axis_dict['bound_end'] = occurence[1]
1573

Romain Courteaud's avatar
Romain Courteaud committed
1574
    if axis_dict['bound_end']is None or axis_dict['bound_begin'] is None:
Thomas Bernard's avatar
Thomas Bernard committed
1575
      # ERROR
1576
      # no bounds over the secondary axis have been defined
1577
      # can append if bad property has been selected
Thomas Bernard's avatar
Thomas Bernard committed
1578 1579 1580
      message = 'can not find secondary axis bounds for planning view :\
      No object has good start & stop properties, please check your objects \
      and their corresponding properties'
1581 1582
      #axis_dict['bound_begin'] = 0
      #axis_dict['bound_end'] = 1
1583
      return [(Message(domain='erp5_ui', message=message,mapping=None))]
1584

Rafael Monnerat's avatar
Rafael Monnerat committed
1585
    axis_dict['bound_range'] = axis_dict['bound_end'] - axis_dict['bound_begin']
1586
    # now start and stop have the extreme values of the second axis bound.
Thomas Bernard's avatar
Thomas Bernard committed
1587
    # this represents in fact the size of the Planning's secondary axis
1588

Thomas Bernard's avatar
Thomas Bernard committed
1589
    # can now get selection informations ( float range 0..1)
1590 1591
    axis_dict['bound_start'] = 0
    axis_dict['bound_stop'] = 1
Romain Courteaud's avatar
Romain Courteaud committed
1592
    if self.selection is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1593 1594
      # selection is not None, trying to recover previously saved values about
      # secondary axis (axis start and stop bounds)
1595 1596 1597
      try:
        axis_dict['bound_start'] = self.selection.getSecondaryAxisStart()
        axis_dict['bound_stop'] = self.selection.getSecondaryAxisStop()
Thomas Bernard's avatar
Thomas Bernard committed
1598 1599
      except AttributeError:
        # bounds were not defined, escaping test
1600 1601 1602 1603 1604 1605
        pass

    # getting secondary axis page step
    axis_zoom_step = axis_dict['bound_range'] / axis_dict['zoom_level']

    # now setting bound_start
Thomas Bernard's avatar
Thomas Bernard committed
1606 1607
    axis_dict['bound_start'] = axis_dict['zoom_start'] * axis_zoom_step + \
                               axis_dict['bound_begin']
1608 1609 1610 1611 1612 1613 1614
    # 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']

Thomas Bernard's avatar
Thomas Bernard committed
1615 1616
    # everything is OK, returning 'true' flag
    return 1
1617 1618 1619

  def getMainAxisInfo(self, axis_dict):
    """
1620
    Getting main axis properties (total pages, current page, groups per page)
1621 1622 1623 1624 1625 1626
    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).
    """
1627
    axis_dict['bound_axis_groups'] = self.field.get_value('main_axis_groups')
Romain Courteaud's avatar
Romain Courteaud committed
1628
    if axis_dict['bound_axis_groups'] is None:
1629
      #XXX raise exception : no group nb/page defined
1630 1631
      pass

1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
    # setting begin & end bounds
    axis_dict['bound_begin'] = 0
    axis_dict['bound_end'] = len(self.report_groups)
    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]
        axis_dict['bound_start'] = int(axis_dict['bound_start'])
      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
1660 1661
      axis_dict['bound_start'] -= \
               (axis_dict['bound_start'] % axis_dict['bound_axis_groups'])
1662 1663

      # setting last group displayed on page
Thomas Bernard's avatar
Thomas Bernard committed
1664 1665
      axis_dict['bound_stop'] = min (axis_dict['bound_end'],
               axis_dict['bound_start'] + axis_dict['bound_axis_groups'])
1666
      # calculating total number of pages
Thomas Bernard's avatar
Thomas Bernard committed
1667 1668
      axis_dict['bound_page_total'] = int(max(axis_dict['bound_end'] - 1,0) / \
               axis_dict['bound_axis_groups']) + 1
1669
      # calculating current page number
Thomas Bernard's avatar
Thomas Bernard committed
1670 1671
      axis_dict['bound_page_current'] = int(axis_dict['bound_start'] / \
               axis_dict['bound_axis_groups']) + 1
1672
      # adjusting first group displayed on current page
Thomas Bernard's avatar
Thomas Bernard committed
1673 1674
      axis_dict['bound_start'] = min(axis_dict['bound_start'], max(0,
           (axis_dict['bound_page_total']-1) * axis_dict['bound_axis_groups']))
1675

1676 1677 1678 1679 1680
      self.params['list_lines'] = axis_dict['bound_axis_groups']
      self.params['list_start'] = axis_dict['bound_start']

  def buildGroupStructure(self):
      """
1681
      This procedure builds BasicGroup instances corresponding to the
1682 1683 1684 1685
      report_group_objects returned from the ERP5 request.
      """
      position = 0
      # iterating each element
Thomas Bernard's avatar
Thomas Bernard committed
1686 1687
      for (report_group_object, object_list, property_dict) in \
           self.report_groups:
1688 1689 1690

        stat_result = {}
        stat_context = report_group_object.getObject().asContext(**stat_result)
Thomas Bernard's avatar
Thomas Bernard committed
1691 1692 1693 1694
        stat_context.domain_url = \
                     report_group_object.getObject().getRelativeUrl()
        stat_context.absolute_url = \
                     lambda x: report_group_object.getObject().absolute_url()
1695 1696 1697
        url=getattr(stat_context,'domain_url','')
        # updating position_informations
        position +=1
1698
        # recovering usefull informations, basic_structure
Rafael Monnerat's avatar
Rafael Monnerat committed
1699
        if self.title_line not in (None,''):
Romain Courteaud's avatar
Romain Courteaud committed
1700 1701
	        title_line_method = getattr(report_group_object.getObject(),
			                                self.title_line, None)
1702
        else:
Romain Courteaud's avatar
Romain Courteaud committed
1703 1704
          title_line_method = getattr(report_group_object.getObject(),
                                      'getTitle', None)
1705
        if title_line_method is not None:
Romain Courteaud's avatar
Romain Courteaud committed
1706
          title = name = title_line_method()
1707
        depth = report_group_object.getDepth()
1708 1709
        is_open = report_group_object.getIsOpen()
        is_pure_summary = report_group_object.getIsPureSummary()
1710 1711

        # creating new group_object with all the informations collected
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
        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
          secondary_axis_bounds = {}
          secondary_axis_bounds['bound_start'] = group_start
          secondary_axis_bounds['bound_stop']  = group_stop
        else:
          secondary_axis_bounds = self.secondary_axis_info
Rafael Monnerat's avatar
Rafael Monnerat committed
1723

Thomas Bernard's avatar
Thomas Bernard committed
1724
        child_group = BasicGroup(title=title, name=name, url=url,
Rafael Monnerat's avatar
Rafael Monnerat committed
1725 1726 1727 1728 1729 1730 1731
                                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,
                                property_dict = property_dict)
Thomas Bernard's avatar
Thomas Bernard committed
1732

1733
        if object_list not in [None, []]:
Thomas Bernard's avatar
Thomas Bernard committed
1734
          child_group.setBasicActivities(object_list,self.list_error,
1735
                                         secondary_axis_bounds)
1736 1737 1738 1739 1740 1741

        try:
          self.basic_group_list.append(child_group)
        except (AttributeError):
          self.basic_group_list = []
          self.basic_group_list.append(child_group)
1742
	
Thomas Bernard's avatar
Thomas Bernard committed
1743 1744
      return 1

1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757

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

1758
  def __init__ (self, title='', name='',url='', constraints='', depth=0,
Thomas Bernard's avatar
Thomas Bernard committed
1759
                position=0, field = None, object = None, is_open=0,
1760
                is_pure_summary=1, secondary_axis_start=None,
1761
                secondary_axis_stop=None, property_dict = {}):
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
    self.title = title
    self.name = name
    self.url = url
    self.basic_group_list = None # used with ReportTree
    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
1772 1773 1774 1775
    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
1776 1777
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
1778 1779 1780 1781
    # property_dict holds all information about the current axis_group
    # type of group, stat, etc.
    self.property_dict = property_dict

1782 1783 1784

  def setBasicActivities(self,activity_list, list_error,secondary_axis_info):
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
1785
    Link a list of activities to the current object.
Thomas Bernard's avatar
Thomas Bernard committed
1786 1787 1788 1789 1790 1791
    *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
1792
    """
Thomas Bernard's avatar
Thomas Bernard committed
1793
    info = {}
Thomas Bernard's avatar
Thomas Bernard committed
1794 1795 1796
    # 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')
1797 1798 1799 1800
    # 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')
1801 1802
    info_botleft = self.field.get_value('info_backleft')
    info_botright = self.field.get_value('info_backright')
1803 1804 1805 1806
    # 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)
1807 1808 1809
    info_botleft_method = getattr(self.object.getObject(),info_botleft,None)
    info_botright_method = \
                  getattr(self.object.getObject(),info_botright,None)
1810
    # if method recovered is not null, then updating
Romain Courteaud's avatar
Romain Courteaud committed
1811 1812
    # XXX Does script have to manage multiple context object ?
    if info_center_method is not None:
1813
      info['info_center'] = str(info_center_method())
Romain Courteaud's avatar
Romain Courteaud committed
1814
    if info_topright_method is not None:
1815
      info['info_topright'] = str(info_topright_method())
Romain Courteaud's avatar
Romain Courteaud committed
1816
    if info_topleft_method is not None:
1817
      info['info_topleft'] = str(info_topleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1818
    if info_botleft_method is not None:
1819
      info['info_botleft'] = str(info_botleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1820
    if info_botright_method is not None:
1821
      info['info_botright'] = str(info_botright_method())
1822

1823
    if activity_list not in ([],None):
1824 1825 1826
      indic=0
      # iterating each activity linked to the current group
      for activity_content in activity_list:
1827
        # interpreting results and getting begin and end values from
1828
        # previously recovered method
1829 1830
        block_begin = None
        block_end = None
Romain Courteaud's avatar
Romain Courteaud committed
1831
        if object_property_begin  is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1832 1833
          block_begin = \
                 getattr(activity_content.getObject(),object_property_begin)
1834 1835
        else:
          block_begin = None
1836

Romain Courteaud's avatar
Romain Courteaud committed
1837
        if object_property_end is not None:
1838
          block_end = getattr(activity_content.getObject(),object_property_end)
1839 1840 1841
        else:
          block_end = None

1842
        # handling case where activity bound is not defined
Romain Courteaud's avatar
Romain Courteaud committed
1843
        if block_begin is None:
1844 1845
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
1846
        if block_end is None:
1847 1848
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
Thomas Bernard's avatar
Thomas Bernard committed
1849 1850 1851 1852
        # 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']:
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
          # 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
1868
          name = "Activity_%s" % (str(indic))
1869 1870

          error = 'false'
1871
          current_color=''
1872

1873 1874 1875 1876 1877 1878
          if self.property_dict['stat'] == 1:
            info = None
            info = {}
            info['info_center'] = ''
            info['info_topright'] = ''
            info['info_topleft'] = ''
1879 1880
            info['info_botleft'] = ''
            info['info_botright'] = ''
1881 1882 1883 1884
            title = ''
            object = activity_content
            url=''
            object_property_height = self.field.get_value('y_size_block')
Thomas Bernard's avatar
Thomas Bernard committed
1885 1886
            height = \
                 getattr(activity_content.getObject(),object_property_height)
1887 1888 1889 1890 1891 1892 1893
          else:
            info = None
            info = {}
            # 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)
1894 1895 1896
            info_botleft_method = getattr(activity_content,info_botleft,None)
            info_botright_method = \
                 getattr(activity_content,info_botright,None)
1897

1898
            # if value recovered is not null, then updating
Romain Courteaud's avatar
Romain Courteaud committed
1899
            if info_center_method is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1900
               info['info_center']=str(info_center_method())
Romain Courteaud's avatar
Romain Courteaud committed
1901
            if info_topright_method is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1902
               info['info_topright']=str(info_topright_method())
Romain Courteaud's avatar
Romain Courteaud committed
1903
            if info_topleft_method is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1904
               info['info_topleft']=str(info_topleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1905
            if info_botleft_method is not None:
1906
               info['info_botleft'] =str(info_botleft_method())
Romain Courteaud's avatar
Romain Courteaud committed
1907
            if info_botright_method is not None:
1908
               info['info_botright']=str(info_botright_method())
1909 1910

            title = info['info_center']
Thomas Bernard's avatar
Thomas Bernard committed
1911 1912
            color_script = getattr(activity_content.getObject(),
                                   self.field.get_value('color_script'),None)
1913
            # calling color script if exists to set up activity_color
Romain Courteaud's avatar
Romain Courteaud committed
1914
            if color_script  is not None:
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
              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
1925 1926 1927 1928 1929 1930
            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()
1931
            object = stat_context.getObject()
1932
            url = object.getUrl()
1933 1934 1935

            # XXX should define height of block here
            height = None
1936 1937

          # creating new activity instance
Thomas Bernard's avatar
Thomas Bernard committed
1938 1939 1940 1941 1942 1943 1944 1945
          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)
1946 1947 1948 1949 1950 1951 1952 1953


          # 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)
1954
          # incrementing indic used for differenciating activities in the same
1955 1956 1957
          # group (used for Activity naming)
          indic += 1

Sebastien Robin's avatar
Sebastien Robin committed
1958
    else:
Thomas Bernard's avatar
Thomas Bernard committed
1959 1960 1961
      # specific color script
      color_script = getattr(self.object.getObject(),
                             self.field.get_value('color_script'),None)
1962 1963
      # calling color script if exists to set up activity_color
      current_color=''
Romain Courteaud's avatar
Romain Courteaud committed
1964
      if color_script  is not None:
1965 1966
        current_color = color_script(self.object.getObject())

1967
      # getting begin and end values from previously recovered method
Romain Courteaud's avatar
Romain Courteaud committed
1968
      if object_property_begin  is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1969 1970
        block_begin = \
                    self.object.getObject().getProperty(object_property_begin)
Sebastien Robin's avatar
Sebastien Robin committed
1971 1972
      else:
        block_begin = None
1973

Romain Courteaud's avatar
Romain Courteaud committed
1974
      if object_property_end is not None:
Thomas Bernard's avatar
Thomas Bernard committed
1975
        block_end = self.object.getObject().getProperty(object_property_end)
Sebastien Robin's avatar
Sebastien Robin committed
1976
      else:
1977 1978
        block_end = None

1979 1980 1981 1982
      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
1983
        if (block_begin is None):
1984 1985
          block_begin = secondary_axis_info['bound_start']
          current_color='#E4CCE1'
Romain Courteaud's avatar
Romain Courteaud committed
1986
        if block_end is None:
1987 1988
          block_end = secondary_axis_info['bound_stop']
          current_color='#E4CCE1'
1989

1990 1991 1992 1993
        if  (block_begin > secondary_axis_info['bound_stop'] or \
          block_end < secondary_axis_info['bound_start']):
          # activity will not be displayed, stopping process
          pass
1994
        else:
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
          # 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
          url = self.object.getObject().getUrl()

          # 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)
2043 2044 2045 2046 2047

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

Thomas Bernard's avatar
Thomas Bernard committed
2048 2049 2050 2051
  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 = {}):
2052 2053
    self.title = title
    self.name = name
2054
    self.object = object
2055 2056 2057 2058 2059 2060
    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
2061
    self.height = height
Thomas Bernard's avatar
Thomas Bernard committed
2062
    self.constraints = constraints
2063 2064 2065
    self.color = color
    self.info_dict = info_dict
    self.error = error
2066
    self.property_dict = property_dict # dict containing specific properties
2067 2068 2069


class PlanningStructure:
Romain Courteaud's avatar
Romain Courteaud committed
2070 2071 2072 2073 2074 2075
  """
  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.
  """
2076

2077
  def __init__ (self):
2078 2079 2080 2081 2082 2083
    self.main_axis = ''
    self.secondary_axis = ''
    self.content = []
    self.content_delimiters = None


Romain Courteaud's avatar
Romain Courteaud committed
2084
  def build(self, basic_structure=None, field=None, REQUEST=None):
2085 2086
    """
    main procedure for building Planning Structure
Thomas Bernard's avatar
Thomas Bernard committed
2087 2088 2089 2090 2091
    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...
2092
    """
2093
    # recovering render format ('YX' or 'XY')
2094
    self.calendar_view = field.get_value('calendar_view')
2095

2096 2097
    # declaring main axis
    self.main_axis = Axis(title='main axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2098
                          unit='', axis_order=1, axis_group=[])
2099 2100 2101

    # declaring secondary axis
    self.secondary_axis = Axis(title='sec axis', name='axis',
Romain Courteaud's avatar
Romain Courteaud committed
2102
                               unit='', axis_order=2, axis_group=[])
2103 2104 2105

    # linking axis objects to their corresponding accessor, i.e X or Y
    # this allows the planning to be generic.
2106
    if self.calendar_view == 0:
2107 2108
      self.Y = self.main_axis
      self.X = self.secondary_axis
Sebastien Robin's avatar
Sebastien Robin committed
2109
    else:
2110 2111 2112 2113 2114 2115 2116 2117
      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
2118
    # Used in case of non calendar mode
Thomas Bernard's avatar
Thomas Bernard committed
2119 2120 2121 2122
    self.secondary_axis.start = \
                      basic_structure.secondary_axis_info['bound_start']
    self.secondary_axis.stop = \
                      basic_structure.secondary_axis_info['bound_stop']
2123 2124 2125 2126

    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
2127
    # used in non calendar mode
Romain Courteaud's avatar
Romain Courteaud committed
2128
    status = self.buildSecondaryAxis(basic_structure, field)
Thomas Bernard's avatar
Thomas Bernard committed
2129
    if status != 1:
Romain Courteaud's avatar
Romain Courteaud committed
2130
      # XXX Hidding error is not a good solution generally
Thomas Bernard's avatar
Thomas Bernard committed
2131 2132
      # ERROR while building secondary axis
      return status
2133
    # completing axisgroup informations according to their bounds
Thomas Bernard's avatar
Thomas Bernard committed
2134 2135 2136 2137
    status = self.completeAxis()
    if status != 1:
      # ERROR while completing axis
      return status
2138
    # the whole structure is almost completed : axis_groups are defined, as
Thomas Bernard's avatar
Thomas Bernard committed
2139 2140
    # axis_elements with their activities. Just need to create blocks related
    # to the activities (special process only for Calendar mode) with their
2141
    # BlockPosition
Romain Courteaud's avatar
Romain Courteaud committed
2142
    status = self.buildBlocs(basic_structure=basic_structure, REQUEST=REQUEST)
Thomas Bernard's avatar
Thomas Bernard committed
2143 2144 2145 2146 2147
    if status != 1:
      # ERROR while building blocks
      return status
    # everything is fine, returning 'true' flag.
    return 1
2148

Romain Courteaud's avatar
Romain Courteaud committed
2149
  def buildSecondaryAxis(self, basic_structure, field):
2150 2151 2152
    """
    build secondary axis structure
    """
Thomas Bernard's avatar
Thomas Bernard committed
2153
    # defining min and max delimiter number
Romain Courteaud's avatar
Romain Courteaud committed
2154
    # XXX Isn't field enough ?
Thomas Bernard's avatar
Thomas Bernard committed
2155
    delimiter_min_number = basic_structure.field.get_value('delimiter')
2156 2157 2158 2159
    if basic_structure.calendar_mode:
      axis_start = 1
      axis_stop = basic_structure.calendar_range + 1
    else:
Romain Courteaud's avatar
Romain Courteaud committed
2160 2161
      axis_stop = self.secondary_axis.stop
      axis_start = self.secondary_axis.start
2162

Romain Courteaud's avatar
Romain Courteaud committed
2163
    # XXX Isn't field enough ?
2164
    axis_script=getattr(basic_structure.context,
Romain Courteaud's avatar
Romain Courteaud committed
2165 2166
                        basic_structure.field.get_value('sec_axis_script'),None)
    if axis_script is None:
Thomas Bernard's avatar
Thomas Bernard committed
2167
      # ERROR
Romain Courteaud's avatar
Romain Courteaud committed
2168
      # XXX Shouldn't planning box failed in this case, because of bad config ?
Thomas Bernard's avatar
Thomas Bernard committed
2169 2170
      message = 'unable to find secondary axis generation script : "%s" does \
             not exist' % basic_structure.field.get_value('sec_axis_script')
2171
      return [(Message(domain='erp5_ui', message=message, mapping=None))]
Thomas Bernard's avatar
Thomas Bernard committed
2172

Thomas Bernard's avatar
Thomas Bernard committed
2173
    # calling script to get list of delimiters to implement
Thomas Bernard's avatar
Thomas Bernard committed
2174 2175 2176 2177
    # just need to pass start, stop, and the minimum number of delimiter
    # wanted. a structure is returned : list of delimiters, each delimiter
    # defined by a list [ relative position, title, tooltip , delimiter_type]
    try:
Romain Courteaud's avatar
Romain Courteaud committed
2178
      delimiter_list = axis_script(axis_start, axis_stop, delimiter_min_number)
Thomas Bernard's avatar
Thomas Bernard committed
2179
    except (ArithmeticError, LookupError, AttributeError, TypeError):
Romain Courteaud's avatar
Romain Courteaud committed
2180 2181
      # XXX Seems that too many error are catched
      # XXX Shouldn't planning box failed in this case, because of bad config ?
Thomas Bernard's avatar
Thomas Bernard committed
2182 2183
      message =  'error raised in secondary axis generation script : please \
             check "%s"'% basic_structure.field.get_value('sec_axis_script')
2184
      return [(Message(domain='erp5_ui', message=message,mapping=None))]
2185

Thomas Bernard's avatar
Thomas Bernard committed
2186 2187 2188
    axis_stop = int(axis_stop)
    axis_start = int(axis_start)
    axis_range = axis_stop - axis_start
2189

Thomas Bernard's avatar
Thomas Bernard committed
2190 2191 2192
    # 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
2193
    axis_group_number = 0
Thomas Bernard's avatar
Thomas Bernard committed
2194 2195 2196 2197
    # 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:
Thomas Bernard's avatar
Thomas Bernard committed
2198
      axis_group = AxisGroup(name='Group_sec_' + str(axis_group_number),
2199 2200 2201
                             title=delimiter['title'], 
			     delimiter_type=delimiter['delimiter_type'])
      axis_group.tooltip = delimiter['tooltip']
Thomas Bernard's avatar
Thomas Bernard committed
2202
      axis_group.position_secondary.relative_begin = \
2203
                             int(delimiter['relative_position']) - int(axis_start)
Thomas Bernard's avatar
Thomas Bernard committed
2204 2205
      # set defaut stop bound and size
      axis_group.position_secondary.relative_end  = int(axis_stop)
Thomas Bernard's avatar
Thomas Bernard committed
2206
      axis_group.position_secondary.relative_range = \
2207
                             int(axis_stop) - int(delimiter['relative_position'])
Romain Courteaud's avatar
Romain Courteaud committed
2208 2209 2210
      # do not need to update previous delimiter informations for first
      # delimiter
      if delimiter != delimiter_list[0]:
Thomas Bernard's avatar
Thomas Bernard committed
2211 2212
        # actual delimiter info has a previous delimiter
        # update its informations
Thomas Bernard's avatar
Thomas Bernard committed
2213 2214 2215 2216 2217
        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
2218
      # add current axis_group to axis_group list
2219 2220 2221
      self.secondary_axis.axis_group.append(axis_group)
      axis_group_number += 1

Thomas Bernard's avatar
Thomas Bernard committed
2222 2223
    return 1

Rafael Monnerat's avatar
Rafael Monnerat committed
2224
  def completeAxis(self):
2225
    """
Romain Courteaud's avatar
Romain Courteaud committed
2226
    complete axis informations (and more precisely axis position objects) thanks
2227 2228 2229 2230 2231
    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
2232 2233
      position_main = axis_group_element.position_main
      position_main.absolute_begin = (
Thomas Bernard's avatar
Thomas Bernard committed
2234 2235
              float(axis_group_element.axis_element_start - 1) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2236
      position_main.absolute_end = (
Thomas Bernard's avatar
Thomas Bernard committed
2237 2238
              float(axis_group_element.axis_element_stop) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2239
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2240 2241
              float(axis_group_element.axis_element_number) /
              float(self.main_axis.size))
Romain Courteaud's avatar
Romain Courteaud committed
2242 2243 2244 2245
      position_secondary = axis_group_element.position_secondary
      position_secondary.absolute_begin = 0
      position_secondary.absolute_end = 1
      position_secondary.absolute_range= 1
2246

Thomas Bernard's avatar
Thomas Bernard committed
2247

2248
    for axis_group_element in self.secondary_axis.axis_group:
Romain Courteaud's avatar
Romain Courteaud committed
2249 2250 2251
      position_secondary = axis_group_element.position_secondary
      position_secondary.absolute_begin = (
           float(position_secondary.relative_begin) /
Thomas Bernard's avatar
Thomas Bernard committed
2252
           self.secondary_axis.axis_size)
Romain Courteaud's avatar
Romain Courteaud committed
2253 2254
      position_secondary.absolute_end = (
           float(position_secondary.relative_end) /
Thomas Bernard's avatar
Thomas Bernard committed
2255
           self.secondary_axis.axis_size)
Romain Courteaud's avatar
Romain Courteaud committed
2256 2257
      position_secondary.absolute_range = (
           float(position_secondary.relative_range) /
Thomas Bernard's avatar
Thomas Bernard committed
2258
           self.secondary_axis.axis_size)
Romain Courteaud's avatar
Romain Courteaud committed
2259 2260 2261 2262
      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
2263

Thomas Bernard's avatar
Thomas Bernard committed
2264 2265 2266
    # returning 'true' flag at the end of the process
    return 1

Rafael Monnerat's avatar
Rafael Monnerat committed
2267
  def buildGroups(self, basic_structure=None):
2268
    """
Rafael Monnerat's avatar
Rafael Monnerat committed
2269
    Build groups from activities saved in the structure groups.
2270 2271 2272 2273
    """
    axis_group_number = 0
    axis_element_already_present=0
    for basic_group_object in basic_structure.basic_group_list:
2274 2275 2276 2277
      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
2278
      axis_group_number += 1
Romain Courteaud's avatar
Romain Courteaud committed
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
      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
2292

2293
      if self.calendar_view == 0:
2294 2295
        axis_group.position_y = axis_group.position_main
        axis_group.position_x = axis_group.position_secondary
Sebastien Robin's avatar
Sebastien Robin committed
2296
      else:
2297 2298 2299 2300 2301 2302 2303
        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
2304 2305
      axis_group.fixProperties(form_id = basic_structure.form.id,
                               selection_name = basic_structure.selection_name)
2306 2307
      # updating start value
      activity_number = 0
Rafael Monnerat's avatar
Rafael Monnerat committed
2308
      axis_group.axis_element_start = axis_element_already_present + 1
Romain Courteaud's avatar
Romain Courteaud committed
2309
      if basic_group_object.basic_activity_list is not None:
2310 2311
        # need to check if activity list is not empty : possible in case zoom
        # selection is used over the secondary axis
2312 2313 2314 2315 2316 2317
        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
2318
            activity=Activity(name='Group_%s_Activity_%s' % (
Romain Courteaud's avatar
Romain Courteaud committed
2319 2320
                                   axis_group_number,
                                   activity_number),
Thomas Bernard's avatar
Thomas Bernard committed
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334
                              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,
2335
                              calendar_view=self.calendar_view,
Thomas Bernard's avatar
Thomas Bernard committed
2336
                              property_dict=basic_group_object.property_dict)
2337 2338 2339 2340 2341 2342
            # adding activity to the current group
            axis_group.addActivity(activity,axis_element_already_present)
        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
2343 2344
          axis_group.addStatActivities(
               basic_activity_list=basic_group_object.basic_activity_list,
2345
               axis_group_number=axis_group_number,
Thomas Bernard's avatar
Thomas Bernard committed
2346
               axis_element_already_present=axis_element_already_present,
2347
               calendar_view=self.calendar_view, primary_axis_block=self,
Thomas Bernard's avatar
Thomas Bernard committed
2348
               property_dict=basic_group_object.property_dict)
Sebastien Robin's avatar
Sebastien Robin committed
2349
      else:
2350 2351 2352
        # 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
2353
        new_axis_element=AxisElement(name='Group_%s_AxisElement_1' %
Romain Courteaud's avatar
Romain Courteaud committed
2354 2355
                                           axis_group_number,
                                 relative_number=1,
Thomas Bernard's avatar
Thomas Bernard committed
2356 2357
                                 absolute_number=axis_group.axis_element_start,
                                 parent_axis_group=axis_group)
2358 2359 2360 2361
        # 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)
2362

Romain Courteaud's avatar
Romain Courteaud committed
2363 2364
      axis_group.axis_element_stop = \
          axis_element_already_present + axis_group.axis_element_number
2365 2366 2367 2368 2369 2370 2371
      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)
    return axis_element_already_present
Sebastien Robin's avatar
Sebastien Robin committed
2372

2373

Romain Courteaud's avatar
Romain Courteaud committed
2374
  def buildBlocs(self, basic_structure=None, REQUEST=None):
2375 2376 2377 2378
    """
    iterate the whole planning structure to get various activities and build
    their related blocs.
    """
Thomas Bernard's avatar
Thomas Bernard committed
2379
    # recover activity and block error lists
Romain Courteaud's avatar
Romain Courteaud committed
2380 2381 2382
    warning_activity_list = REQUEST.get('warning_activity_list', [])
    error_block_list = REQUEST.get('error_block_list', [])
    error_info_dict = REQUEST.get('error_info_dict', {})
2383 2384 2385
    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:
2386
          # test if activity in warning_activity_list
2387 2388 2389 2390
          if activity.name in warning_activity_list:
            warning = 1
          else:
            warning = 0
2391 2392 2393 2394 2395 2396 2397 2398
          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
Thomas Bernard's avatar
Thomas Bernard committed
2399 2400
          status = activity.addBlocs(main_axis_start=0,
                                main_axis_stop=self.main_axis.size,
2401 2402 2403
                                secondary_axis_start = axis_start,
                                secondary_axis_stop  = axis_stop,
                                secondary_axis_range = axis_range,
Thomas Bernard's avatar
Thomas Bernard committed
2404 2405 2406
                                planning=self, warning=warning,
                                error_block_list=error_block_list,
                                error_info_dict=error_info_dict)
Romain Courteaud's avatar
Romain Courteaud committed
2407 2408
          if status != 1: 
            return status
2409 2410 2411
        if axis_group_object.property_dict['stat'] == 1:
          # case stat group_object, need to update block size to display
          # stats informations
Thomas Bernard's avatar
Thomas Bernard committed
2412
          status = axis_group_object.updateStatBlocks()
Romain Courteaud's avatar
Romain Courteaud committed
2413 2414
          if status != 1: 
            return status
Thomas Bernard's avatar
Thomas Bernard committed
2415
    # no problem during process, returning 'true' flag
2416
    return 1
2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427


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
2428 2429 2430 2431
  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
2432 2433 2434
                calendar_view=0, property_dict={}):
    # internal activity_name
    self.name = name
Thomas Bernard's avatar
Thomas Bernard committed
2435
    self.id = self.name
Romain Courteaud's avatar
Romain Courteaud committed
2436 2437
    # displayed activity_name
    self.title = title
2438
    self.object = object
Romain Courteaud's avatar
Romain Courteaud committed
2439 2440 2441 2442 2443 2444
    # activity, activity_error, info
    self.types = types
    # color used to render all Blocs
    self.color = color
    # link to the ERP5 object
    self.link = link
2445
    self.height = height
2446
    # self.constraints = constraints
Romain Courteaud's avatar
Romain Courteaud committed
2447 2448 2449 2450 2451 2452
    # 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
2453 2454 2455 2456
    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
2457
    self.calendar_view = calendar_view
2458
    self.property_dict = property_dict
2459

Thomas Bernard's avatar
Thomas Bernard committed
2460

Romain Courteaud's avatar
Romain Courteaud committed
2461 2462
  # XXX Still used ?
  def get_error_message(self, Error):
Thomas Bernard's avatar
Thomas Bernard committed
2463
    # need to update the error message
2464
    return 'task %s (%s)not validated' % (self.name, self.title)
Thomas Bernard's avatar
Thomas Bernard committed
2465 2466


2467 2468 2469 2470 2471 2472 2473
  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
2474 2475
    if (self.secondary_axis_begin > bound_end) or \
       (self.secondary_axis_end < bound_begin):
2476
      return 0
Thomas Bernard's avatar
Thomas Bernard committed
2477 2478
    elif (self.secondary_axis_begin > bound_begin) and \
         (self.secondary_axis_end < bound_end):
2479
      return 1
2480
    else:
2481 2482
      return 2

Thomas Bernard's avatar
Thomas Bernard committed
2483
  def addBlocs(self, main_axis_start=None, main_axis_stop=None,
2484 2485
               secondary_axis_start=None, secondary_axis_stop=None,
               secondary_axis_range=None, planning=None, warning=0,
Thomas Bernard's avatar
Thomas Bernard committed
2486
               error_block_list=[], error_info_dict={}):
2487 2488 2489 2490 2491
    """
    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
2492 2493
    if self.secondary_axis_start is not None or \
        self.secondary_axis_stop is not None:
2494
      secondary_block_bounds = self.splitActivity()
Thomas Bernard's avatar
Thomas Bernard committed
2495

2496
    else:
2497
       secondary_block_bounds = \
Romain Courteaud's avatar
Romain Courteaud committed
2498
          [[secondary_axis_start, secondary_axis_stop, 1]]
2499 2500 2501

    block_number = 0
    # iterating resulting list
Romain Courteaud's avatar
Romain Courteaud committed
2502
    for (start, stop, zone) in secondary_block_bounds:
2503 2504

      block_number += 1
2505

Thomas Bernard's avatar
Thomas Bernard committed
2506
      block_name = self.name + '_Block_' + str(block_number)
2507
      # create new block instance
2508

Thomas Bernard's avatar
Thomas Bernard committed
2509 2510
      if block_name in error_block_list:
        error = 1
Romain Courteaud's avatar
Romain Courteaud committed
2511
        error_text = error_info_dict[block_name]
Thomas Bernard's avatar
Thomas Bernard committed
2512 2513
      else:
        error = 0
Romain Courteaud's avatar
Romain Courteaud committed
2514
        error_text = ''
2515

Thomas Bernard's avatar
Thomas Bernard committed
2516 2517
      # zone property is used to check if block is an active (main activity
      # block) block or a passive one (just a display block)
2518 2519 2520 2521 2522 2523 2524 2525
      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
2526 2527
      new_block = Bloc(name= block_name,color=block_color,link=block_link,
                       number = block_number,
2528
                       calendar_view=self.calendar_view, parent_activity=self,
Thomas Bernard's avatar
Thomas Bernard committed
2529 2530 2531
                       warning=warning, error=error,
                       error_text=error_text,zone=zone,
                       property_dict=self.property_dict)
2532 2533 2534 2535

      new_block.buildInfoDict(info_dict = self.info)

      # updating secondary_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2536 2537 2538
      position_secondary = new_block.position_secondary
      if self.secondary_axis_start is not None:
        position_secondary.absolute_begin = start
2539
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2540 2541 2542
        position_secondary.absolute_begin = secondary_axis_start
      if self.secondary_axis_stop is not None:
        position_secondary.absolute_end = stop
2543
      else:
Romain Courteaud's avatar
Romain Courteaud committed
2544 2545 2546
        position_secondary.absolute_end = secondary_axis_stop
      position_secondary.absolute_range = stop - start

2547
      # updating main_axis block position
Romain Courteaud's avatar
Romain Courteaud committed
2548 2549
      position_main = new_block.position_main
      position_main.absolute_begin = \
Thomas Bernard's avatar
Thomas Bernard committed
2550
                      self.parent_axis_element.absolute_number - 1
Romain Courteaud's avatar
Romain Courteaud committed
2551
      position_main.absolute_end = \
Thomas Bernard's avatar
Thomas Bernard committed
2552
                      self.parent_axis_element.absolute_number
Romain Courteaud's avatar
Romain Courteaud committed
2553
      position_main.absolute_range = (
Thomas Bernard's avatar
Thomas Bernard committed
2554 2555
                      new_block.position_main.absolute_end -
                      new_block.position_main.absolute_begin)
2556 2557 2558

      # now absolute positions are updated, and the axis values are known
      # (as parameters), processing relative values
2559
      # => but before updating secondary_axis bounds
Romain Courteaud's avatar
Romain Courteaud committed
2560 2561
      position_secondary.relative_begin = (
          float(position_secondary.absolute_begin -
2562
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2563 2564
      position_secondary.relative_end = (
          float(position_secondary.absolute_end -
2565
          secondary_axis_start) / float(secondary_axis_range))
Romain Courteaud's avatar
Romain Courteaud committed
2566 2567 2568
      position_secondary.relative_range = (
          position_secondary.relative_end -
          position_secondary.relative_begin)
2569

2570
      # new coordinates are processed from the axis properties instead of the
Romain Courteaud's avatar
Romain Courteaud committed
2571 2572
      position_main.relative_begin = (
          float(position_main.absolute_begin - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2573
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2574 2575
      position_main.relative_end = (
          float(position_main.absolute_end - main_axis_start) /
Thomas Bernard's avatar
Thomas Bernard committed
2576
          float(main_axis_stop - main_axis_start))
Romain Courteaud's avatar
Romain Courteaud committed
2577 2578 2579
      position_main.relative_range = (
          position_main.relative_end -
          position_main.relative_begin)
2580

2581
      try:
2582
        self.block_list.append(new_block)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2583
      except AttributeError:
2584
        # in case this is the first add
2585 2586 2587
        # need to initialize the list
        self.block_list = []
        self.block_list.append(new_block)
Thomas Bernard's avatar
Thomas Bernard committed
2588

2589 2590 2591 2592 2593 2594
      try:
        planning.content.append(new_block)
      except AttributeError:
        planning.content = []
        planning.content.append(new_block)

Thomas Bernard's avatar
Thomas Bernard committed
2595 2596
    return 1

2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
  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
2607 2608
    # XXX Not implemented yet
    return [(self.secondary_axis_start, self.secondary_axis_stop,1)]
2609

Romain Courteaud's avatar
Romain Courteaud committed
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
    # 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
2660 2661


2662 2663 2664 2665

class Bloc:
  """
  structure that will be rendered as a bloc, a task element.
Thomas Bernard's avatar
Thomas Bernard committed
2666 2667 2668 2669
  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).
2670 2671 2672 2673 2674
  Contains Bloc Structure for position informations.
  """

  def __init__ (self, name=None, types=None,
                color=None, info=None, link=None, number=0,
2675
                constraints=None, secondary_start=None, secondary_stop=None,
2676
                calendar_view=0, parent_activity = None, warning=0, error=0,
2677
                error_text='', zone=1, property_dict ={} ):
2678 2679 2680
    """
    creates a Bloc object
    """
Romain Courteaud's avatar
Romain Courteaud committed
2681 2682 2683 2684
    # internal name
    self.name = name
    # activity, activity_error, info
    self.types = types
2685
    self.color = color
Romain Courteaud's avatar
Romain Courteaud committed
2686 2687 2688 2689
    # dict containing text with their position
    self.info = info
    # on clic link
    self.link = link
2690 2691
    self.number = number
    self.title=''
Romain Courteaud's avatar
Romain Courteaud committed
2692 2693 2694
    # 1 = usefull area : 0 = useless one
    # XXX Bad naming, as it's not easy to understand
    self.zone = zone
2695 2696
    self.parent_activity = parent_activity
    self.constraints = constraints
Thomas Bernard's avatar
Thomas Bernard committed
2697 2698 2699 2700
    # setting warning and error flags in case parent_activity or block itself
    # have not been validated
    self.warning = warning
    self.error = error
2701
    self.error_text = error_text
2702 2703 2704 2705 2706
    # 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
2707 2708
    self.position_secondary = \
          Position(absolute_begin=secondary_start,absolute_end=secondary_stop)
2709
    if calendar_view == 0:
2710 2711 2712 2713 2714 2715
      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
2716
    self.property_dict = property_dict # dict containing internal properties
2717

Romain Courteaud's avatar
Romain Courteaud committed
2718
  def buildInfoDict(self, info_dict=[]):
2719
    """
Thomas Bernard's avatar
Thomas Bernard committed
2720 2721
    create Info objects to display text & images, then link them to the
    current object
2722 2723
    """
    # updating title
2724 2725 2726 2727 2728
    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
2729 2730 2731 2732 2733 2734 2735
      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'),
      ]
2736 2737
      self.title = " | ".join(title_list)

2738 2739 2740 2741
    if self.error != 0:
      # field has error
      # adding text_error
      self.info['info_error'] = Info(info=self.error_text, link='')
2742 2743 2744 2745 2746 2747 2748 2749 2750

  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
2751
    else:
2752
      return ''
Sebastien Robin's avatar
Sebastien Robin committed
2753

2754 2755 2756 2757 2758 2759 2760
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
2761 2762 2763
  def __init__ (self, absolute_begin=None, absolute_end=None,
                absolute_range=None, relative_begin=None, relative_end=None,
                relative_range=None):
2764 2765 2766
    # 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
2767
    self.absolute_range = absolute_range
2768
    # relative size in % of the current axis size
2769 2770
    self.relative_begin = relative_begin
    self.relative_end = relative_end
Thomas Bernard's avatar
Thomas Bernard committed
2771
    self.relative_range = relative_range
2772 2773 2774 2775


class Axis:
  """
2776
  Structure holding informations about a specified axis. Can be X or Y axis.
2777 2778 2779 2780 2781 2782
  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
2783 2784
  def __init__(self, title=None, unit=None, types=None, axis_order=None,
               name=None, axis_group=None):
2785 2786 2787 2788 2789 2790
    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.
2791
    # defined to be able to use a generic and recursive method to
2792 2793
    self.axis_group = axis_group
    # specify if axis is primary or secondary.
2794
    # - if primary axis in Planning, zoom selection is applied thanks to
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
    # 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.
  """

2813 2814
  def __init__ (self, name='', title='', object = None,
                axis_group_list=None, axis_group_number=0,
Thomas Bernard's avatar
Thomas Bernard committed
2815 2816 2817 2818
                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,
2819
                secondary_axis_range=None,
Thomas Bernard's avatar
Thomas Bernard committed
2820
                property_dict={}):
2821 2822
    self.name = name
    self.title = title
Romain Courteaud's avatar
Romain Courteaud committed
2823 2824
    # link to fold or unfold report in report-tree mode
    self.link = None
2825
    self.info_title = Info(info=self.title, link=self.link, title=self.title)
Romain Courteaud's avatar
Romain Courteaud committed
2826 2827 2828 2829 2830 2831 2832
    # 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
2833
    self.axis_group_number = axis_group_number
Romain Courteaud's avatar
Romain Courteaud committed
2834 2835
    # Multitasking
    self.axis_element_list = axis_element_list
2836
    self.axis_element_number = axis_element_number
2837 2838
    self.axis_element_start = None
    self.axis_element_stop = None
Thomas Bernard's avatar
Thomas Bernard committed
2839
    self.delimiter_type = delimiter_type
2840 2841
    # define the kind of separator used in graphic rendering
    # 0 for standard, 1 for bold, 2 for 2x bold
2842 2843 2844 2845 2846
    # 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
2847 2848
    # url to the object
    self.url = url
2849

2850 2851 2852 2853
    self.position_main = Position()
    self.position_secondary = Position()
    self.position_x = None
    self.position_y = None
2854 2855
    # secondary_axis_bounds are specified for each axis_group to handle
    # calendar view.
2856 2857
    self.secondary_axis_start = secondary_axis_start
    self.secondary_axis_stop = secondary_axis_stop
2858 2859 2860 2861 2862
    # 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
2863
    self.property_dict = property_dict
2864 2865


2866
  security = ClassSecurityInfo()
Romain Courteaud's avatar
Romain Courteaud committed
2867

2868
  security.declarePublic('setTitle')
Romain Courteaud's avatar
Romain Courteaud committed
2869
  def setTitle(self, new_title=None):
2870 2871
    self.title = new_title

2872 2873 2874 2875 2876
  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
2877
    info_title = self.info_title
2878 2879
    if self.is_open:
      # current report is unfold, action 'fold'
Romain Courteaud's avatar
Romain Courteaud committed
2880
      info_title.link = 'foldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2881 2882
                              '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2883
      info_title.info = '[-] ' + str(info_title.info)
Sebastien Robin's avatar
Sebastien Robin committed
2884
    else:
2885
      # current report is fold, action 'unfold'
Romain Courteaud's avatar
Romain Courteaud committed
2886
      info_title.link = 'unfoldReport?report_url=' + \
Thomas Bernard's avatar
Thomas Bernard committed
2887 2888
                             '%s&form_id=%s&list_selection_name=%s' %(
                              self.url, form_id, selection_name)
Romain Courteaud's avatar
Romain Courteaud committed
2889
      info_title.info = '[+] ' + str(info_title.info)
2890 2891 2892

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

Romain Courteaud's avatar
Romain Courteaud committed
2895
    self.tooltip = info_title.info
2896

Sebastien Robin's avatar
Sebastien Robin committed
2897

2898 2899
  def addActivity(self, activity=None, axis_element_already_insered= 0):
    """
2900
    Procedure that permits to add activity to the corresponding AxisElement in
2901
    an AxisGroup. This can create new Axis Element in the actual AxisGroup if
2902
    necessary. Permits representation of MULTITASKING
2903 2904 2905 2906
    """

    # declaring variable used to check if activity has already been added
    added = 0
Romain Courteaud's avatar
Romain Courteaud committed
2907 2908
    # XXX To much code inside the try: it's not possible to see
    # which part must not fails...
2909 2910 2911 2912 2913 2914 2915
    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:
2916

Thomas Bernard's avatar
Thomas Bernard committed
2917 2918
          if activity_statement.isValidPosition(activity.secondary_axis_begin,
                                             activity.secondary_axis_end) != 0:
2919 2920
            # isValidPosition returned 1 or 2, this means the activity already
            # present does prevent from adding the new activity as there is
2921
            # coverage on the current axis_element.
2922 2923 2924
            # stop iterating actual axis_element and try with the next one
            can_add = 0
            break
2925

2926 2927 2928 2929 2930 2931
        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)
2932

2933 2934
          # updating activity properties
          activity.parent_axis_element = axis_element
2935

Thomas Bernard's avatar
Thomas Bernard committed
2936 2937
          # 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
2938
          break
2939

2940
      if not added:
Thomas Bernard's avatar
Thomas Bernard committed
2941 2942
        # all axis_elements of the current group have been tested and no one
        # can contain the new activity.
2943 2944
        self.axis_element_number += 1
        # Need to create a new axis_element to hold the new activity
Romain Courteaud's avatar
Romain Courteaud committed
2945
        new_axis_element=AxisElement(name='Group_%s_AxisElement_%s' % \
Thomas Bernard's avatar
Thomas Bernard committed
2946 2947 2948 2949 2950
                                          (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)
2951

2952 2953 2954
        # add new activity to this brand new axis_element
        new_axis_element.activity_list = []
        new_axis_element.activity_list.append(activity)
2955

2956 2957
        # updating activity properties
        activity.parent_axis_element = new_axis_element
2958

2959 2960 2961
        # register the axis_element to the actual group.
        self.axis_element_list.append(new_axis_element)
    except TypeError:
2962
      # in case axis_element_list is Empty (first activity to the group)
2963 2964
      # Need to create a new axis_element to hold the new activity
      self.axis_element_number += 1
Thomas Bernard's avatar
Thomas Bernard committed
2965 2966 2967 2968 2969 2970 2971 2972
      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
2973

2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
      # 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
2986
  def addStatActivities(self, basic_activity_list=None, axis_group_number=0,
2987
                        axis_element_already_present= 0, calendar_view=0,
Thomas Bernard's avatar
Thomas Bernard committed
2988
                        primary_axis_block=None, property_dict={}):
2989 2990 2991 2992 2993 2994
    """
    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
2995 2996 2997 2998 2999 3000
    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)
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010
    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
3011
      activity = Activity(name= 'Group_%s_Activity_%s'
Thomas Bernard's avatar
Thomas Bernard committed
3012 3013
                               %(str(axis_group_number),
                                 str(activity_number)),
3014 3015 3016 3017
                          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
3018 3019 3020 3021 3022 3023 3024 3025
                          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,
3026 3027 3028
                          height=basic_activity_object.height,
                          primary_axis_block=primary_axis_block,
                          info=basic_activity_object.info_dict,
3029
                          calendar_view=calendar_view,
3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048
                          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
3049 3050
    activity_list = self.axis_element_list[0].activity_list
    max_activity_height = max([0]+[x.height for x in activity_list])
3051 3052 3053

    # now max height is known, just need to adapt size of all the blocks
    # composing the activities
Romain Courteaud's avatar
Romain Courteaud committed
3054 3055 3056
    for activity in activity_list:
      height = activity.height
      if height in (0, None):
3057 3058
        relative_size = 1
      else:
Romain Courteaud's avatar
Romain Courteaud committed
3059
        relative_size = float(height) / max_activity_height
3060 3061
      for block in activity.block_list:
        # recovering original values
Romain Courteaud's avatar
Romain Courteaud committed
3062 3063 3064 3065
        position_main = block.position_main
        block_range = position_main.relative_range
        block_begin = position_main.relative_begin
        block_end   = position_main.relative_end
3066 3067 3068 3069 3070
        # 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
3071 3072
        position_main.relative_begin = final_begin
        position_main.relative_range = final_range
Thomas Bernard's avatar
Thomas Bernard committed
3073
    return 1
3074

3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
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
3085 3086
  def __init__ (self, name='', relative_number=0, absolute_number=0,
                activity_list=None, parent_axis_group=None):
3087
    self.name = name
Romain Courteaud's avatar
Romain Courteaud committed
3088 3089 3090 3091
    # relative number / AxisGroup
    self.relative_number = relative_number
    # id in the current rendering
    self.absolute_number = absolute_number
3092 3093 3094 3095 3096 3097 3098 3099
    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
3100 3101
  Class holding all informations to display an info text div inside of a block
  or AxisGroup or whatever
3102 3103 3104 3105 3106 3107 3108 3109 3110
  """
  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
3111 3112 3113 3114
    """
    Special method allowing to update Info content from an external script
    """
    self.info = info
3115 3116 3117

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

Romain Courteaud's avatar
Romain Courteaud committed
3119

Sebastien Robin's avatar
Sebastien Robin committed
3120
class PlanningBox(ZMIField):
Romain Courteaud's avatar
Romain Courteaud committed
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138
  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)

3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
  def render_css(self, REQUEST=None):
    return self.widget.render_css(self, REQUEST)

  def get_javascript_list(self, REQUEST=None):
    """
    Returns list of javascript needed by the field
    """
    if self.get_value('js_enabled'):
      context = getContext(self, 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 []
Romain Courteaud's avatar
Romain Courteaud committed
3154

3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170
# 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
3171 3172 3173 3174 3175 3176 3177
# Allow classes in ZMI
for klass in (PlanningBoxWidget, BasicStructure, BasicGroup,
              BasicActivity, PlanningStructure, Activity,
              Bloc, Position, Axis, AxisGroup, AxisElement,
              Info):
  InitializeClass(klass)
  allow_class(klass)