PaySheetModel.py 10.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
##############################################################################
#
# Copyright (c) 2007, Nexedi SA and Contributors. All Rights Reserved.
#                    Fabien Morin <fabien@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
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo

31
from Products.ERP5Type import Permissions, PropertySheet
32
from Products.ERP5.Document.TradeCondition import TradeCondition
Fabien Morin's avatar
Fabien Morin committed
33
from Products.CMFCore.utils import getToolByName
34
from Products.ERP5Type.XMLMatrix import XMLMatrix
35
from Products.ERP5.Document.Delivery import Delivery
36
from zLOG import LOG
37

Fabien Morin's avatar
Fabien Morin committed
38 39
#XXX TODO: review naming of new methods
#XXX WARNING: current API naming may change although model should be stable.
40

41 42 43
class PaySheetModel(TradeCondition, XMLMatrix, Delivery):
  """A PaySheetModel defines calculation rules for paysheets.

Fabien Morin's avatar
Fabien Morin committed
44
    PaySheetModel are used to define calculating rules specific to a 
45 46
    date, a convention, a group of employees ...
    The class inherit from Delivery, because it contains movements.
Fabien Morin's avatar
Fabien Morin committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60
  """

  meta_type = 'ERP5 Pay Sheet Model'
  portal_type = 'Pay Sheet Model'
  isPredicate = 1

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
Fabien Morin's avatar
Fabien Morin committed
61
                    , PropertySheet.Version
Fabien Morin's avatar
Fabien Morin committed
62 63 64 65 66 67 68 69 70 71 72 73
                    , PropertySheet.DublinCore
                    , PropertySheet.Folder
                    , PropertySheet.Comment
                    , PropertySheet.Arrow
                    , PropertySheet.TradeCondition
                    , PropertySheet.Order
                    , PropertySheet.PaySheetModel
                    , PropertySheet.MappedValue
                    , PropertySheet.Amount
                    , PropertySheet.DefaultAnnotationLine
                    )

Fabien Morin's avatar
Fabien Morin committed
74
  security.declareProtected( Permissions.AccessContentsInformation, 'getCell')
Fabien Morin's avatar
Fabien Morin committed
75 76 77 78 79 80 81
  def getCell(self, *kw , **kwd):
    '''
    override of the function getCell to ba able to search a cell on the
    inheritance model
    '''
    cell = XMLMatrix.getCell(self, *kw, **kwd)
    # if cell not found, look on the inherited models
82
    if cell is None:
83 84 85 86 87 88 89 90
      if kwd.has_key('paysheet'):
        model_list = self.getInheritanceEffectiveModelTreeAsList(kwd['paysheet'])
      else:
        model_list = self.getInheritanceModelTreeAsList()
      if self in model_list:
        model_list.remove(self)
      for specialised_model in model_list:
        cell = XMLMatrix.getCell(specialised_model, *kw, **kwd)
91 92
        if cell is not None:
          return cell
Fabien Morin's avatar
Fabien Morin committed
93 94
    return cell

Fabien Morin's avatar
Fabien Morin committed
95 96
  security.declareProtected(Permissions.AccessContentsInformation,
      'getReferenceDict')
97
  def getReferenceDict(self, portal_type_list, property_list=()):
98 99
    '''Return all objects reference and id of the model wich portal_type is in
    the portal_type_list. If type does not have a reference, it's ID is used.
100 101
    If property_list is provided, only objects for which at least one of
    properties is true will be added.
Fabien Morin's avatar
Fabien Morin committed
102
    '''
103
    reference_dict = {}
Fabien Morin's avatar
Fabien Morin committed
104
    object_list = self.contentValues(portal_type=portal_type_list,
105 106
                                     sort_on='id')
    for obj in object_list:
107 108 109 110 111 112 113 114
      keep = (len(property_list) == 0)
      for property_ in property_list:
        if obj.hasProperty(property_):
          keep = 1
          break
      if keep:
        reference_dict[obj.getProperty('reference',
                                       obj.getId())] = obj.getId()
Fabien Morin's avatar
Fabien Morin committed
115 116
    return reference_dict

Fabien Morin's avatar
Fabien Morin committed
117 118 119 120
  security.declareProtected(Permissions.AccessContentsInformation,
      'getInheritanceModelTreeAsList')
  def getInheritanceModelTreeAsList(self):
    '''Return a list of models. It uses Breadth First Search. 
Fabien Morin's avatar
Fabien Morin committed
121 122 123 124
    '''
    model = self
    already_add_models = [model]
    model_list = [model]
Fabien Morin's avatar
Fabien Morin committed
125 126 127 128 129 130 131 132 133 134 135 136
    final_list = [model]
    while len(model_list) != 0:
      model = model_list.pop(0)
      specialise_list = model.getSpecialiseValueList()
      while len(specialise_list) !=0:
        child = specialise_list.pop(0)
        # this should avoid circular dependencies
        if child not in already_add_models:
          already_add_models.append(child)
          model_list.append(child)
          final_list.append(child)
    return final_list
Fabien Morin's avatar
Fabien Morin committed
137

Fabien Morin's avatar
Fabien Morin committed
138 139 140 141 142 143 144 145 146
  security.declareProtected(Permissions.AccessContentsInformation,
      'getInheritanceEffectiveModelTreeAsList')
  def getInheritanceEffectiveModelTreeAsList(self, paysheet):
    '''Return a list of effective models. It uses Breadth First Search. 
    '''
    model = self.getEffectiveModel(paysheet)
    already_add_models = [model]
    model_list = [model]
    final_list = [model]
Fabien Morin's avatar
Fabien Morin committed
147 148 149
    while len(model_list) != 0:
      model = model_list.pop(0)
      specialise_list = model.getSpecialiseValueList()
Fabien Morin's avatar
Fabien Morin committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
      while len(specialise_list) !=0:
        child = specialise_list.pop(0)
        child = child.getEffectiveModel(paysheet)
        # this should avoid circular dependencies
        if child not in already_add_models:
          already_add_models.append(child)
          model_list.append(child)
          final_list.append(child)
    return final_list

  security.declareProtected(Permissions.AccessContentsInformation,
      'getInheritanceEffectiveModelReferenceDict')
  def getInheritanceEffectiveModelReferenceDict(self, paysheet,
      portal_type_list, property_list=()):
    '''Returns a dict with the model url as key and a list of reference as
    value. Normaly, a Reference appear only one time in the final output.
    It uses Breadth First Search. 
    If property_list is not empty, documents for which all properties in
    property_list are false will be skipped.
    '''
    model_list = self.getInheritanceEffectiveModelTreeAsList(paysheet,
                                                    portal_type_list,
                                                    property_list)
    reference_list = []
    model_reference_dict = {}
    for model in model_list:
      id_list = []
      model_reference_list = model.getReferenceDict(
                           portal_type_list, property_list=property_list)
      for reference in model_reference_list.keys():
        if reference not in reference_list:
          reference_list.append(reference)
          id_list.append(model_reference_list[reference])
      if id_list != []:
        model_reference_dict[model.getRelativeUrl()]=id_list
    return model_reference_dict
Fabien Morin's avatar
Fabien Morin committed
186

Fabien Morin's avatar
Fabien Morin committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
  security.declareProtected(Permissions.AccessContentsInformation,
      'getInheritanceModelReferenceDict')
  def getInheritanceModelReferenceDict(self, portal_type_list,
      property_list=()):
    '''Returns a dict with the model url as key and a list of reference as
    value. Normaly, a Reference appear only one time in the final output.
    It uses Breadth First Search. 
    If property_list is not empty, documents for which all properties in
    property_list are false will be skipped.
    '''
    model_list = self.getInheritanceModelTreeAsList()
    reference_list = []
    model_reference_dict = {}
    for model in model_list:
      id_list = []
202 203
      model_reference_list = model.getReferenceDict(
                           portal_type_list, property_list=property_list)
Fabien Morin's avatar
Fabien Morin committed
204 205 206 207
      for reference in model_reference_list.keys():
        if reference not in reference_list:
          reference_list.append(reference)
          id_list.append(model_reference_list[reference])
208

Fabien Morin's avatar
Fabien Morin committed
209 210
      if id_list != []:
        model_reference_dict[model.getRelativeUrl()]=id_list
211

Fabien Morin's avatar
Fabien Morin committed
212
    return model_reference_dict
213

Fabien Morin's avatar
Fabien Morin committed
214 215 216 217 218 219 220 221 222 223
  security.declareProtected(Permissions.AccessContentsInformation,
      'getEffectiveModel')
  def getEffectiveModel(self, context):
    '''
    return the more appropriate model using effective_date, expiration_date 
    and version number
    '''
    reference = self.getReference()
    if not reference:
      return self
Fabien Morin's avatar
Fabien Morin committed
224

Fabien Morin's avatar
Fabien Morin committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    effective_model_list = []
    start_date = context.getStartDate()
    stop_date = context.getStopDate()
    model_object_list = [result.getObject() for result in \
        self.portal_catalog(portal_type='Pay Sheet Model',
                            reference=reference,)]
                            #sort_on=(('version','descending'),))]
    # XXX currently, version is not catalogued, so sort using python
    def sortByVersion(a, b):
      return cmp(b.getVersion(), a.getVersion())
    model_object_list.sort(sortByVersion)

    for current_model in model_object_list:
      # if there is a model with exact dates, return it
      if start_date == current_model.getEffectiveDate() and \
          stop_date == current_model.getExpirationDate():
        effective_model_list.append(current_model)
    if len(effective_model_list):
      return effective_model_list[0]

    # else, if there is model wich has effective period containing 
    # the start_date and the stop date of the paysheet, return it
    for current_model in model_object_list:
      if start_date >= current_model.getEffectiveDate() and \
          stop_date <= current_model.getExpirationDate():
        effective_model_list.append(current_model)
    if len(effective_model_list):
      return effective_model_list[0]
    # if no effective model are found (ex. because dates are None), return self
    return self

  security.declareProtected(Permissions.AccessContentsInformation,
      'getModelIneritanceEffectiveProperty')
  def getModelIneritanceEffectiveProperty(self, paysheet, property_name):
    """Get a property from an effective model
    """
    v = self.getProperty(property_name)
    if v:
      return v
    model_list = self.getInheritanceEffectiveModelTreeAsList(paysheet)
    for specialised_model in model_list:
      v = specialised_model.getProperty(property_name)
      if v:
        return v