document.erp5.BudgetModel.py 9.73 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
##############################################################################
#
# Copyright (c) 2008 Nexedi SA and Contributors. All Rights Reserved.
#
# 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

30
from Products.ERP5Type import Permissions, PropertySheet
31
from Products.ERP5Type.Core.Predicate import Predicate
32 33 34 35 36 37 38 39 40

class BudgetModel(Predicate):
  """A model of budget, with all budget variation
  """

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.SimpleItem
41
                    , PropertySheet.CategoryCore
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
                    , PropertySheet.Folder
                    , PropertySheet.Predicate
                    , PropertySheet.SortIndex
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.Budget
                    , PropertySheet.Path
                    )

  # CMF Type Definition
  meta_type = 'ERP5 Budget Model'
  portal_type = 'Budget Model'
  add_permission = Permissions.AddPortalContent

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)
59 60 61
  
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getCellRangeForBudgetLine')
62 63 64 65 66 67 68
  def getCellRangeForBudgetLine(self, budget_line, matrixbox=0):
    """Return the cell range to use for the budget.
    """
    cell_range = []
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList(),),
              key=lambda x:x.getIntIndex()):
69
      if not budget_variation.isMemberOf('budget_variation/budget_cell'):
70 71 72
        continue
      variation_cell_range = budget_variation.getCellRangeForBudgetLine(
                               budget_line, matrixbox=matrixbox)
73 74 75
      if variation_cell_range \
          and variation_cell_range != [[]] \
          and variation_cell_range not in cell_range:
76 77 78
        cell_range.extend(variation_cell_range)
    return cell_range

79 80
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getConsumptionCellRangeForBudgetLine')
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
  def getConsumptionCellRangeForBudgetLine(self, budget_line, matrixbox=0, engaged_budget=False):
    """Return the cell range to use for the budget consumption.

    It can be different from the cell range for definition when using full
    consumption detail on budget variations.
    """
    cell_range = []
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList(),),
              key=lambda x:x.getIntIndex()):
      if not budget_variation.isMemberOf('budget_variation/budget_cell'):
        continue
      variation_cell_range = budget_variation.getConsumptionCellRangeForBudgetLine(
               budget_line, matrixbox=matrixbox, engaged_budget=engaged_budget)
      if variation_cell_range \
          and variation_cell_range != [[]] \
          and variation_cell_range not in cell_range:
        cell_range.extend(variation_cell_range)
    return cell_range

101 102
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoryQueryDict')
103
  def getInventoryQueryDict(self, budget_cell):
104
    """Returns the query dict to pass to simulation query for a budget cell
105
    """
106
    query_dict = {}
107 108 109 110 111
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
      query_dict.update(
          budget_variation.getInventoryQueryDict(budget_cell))
112 113 114 115 116 117 118

    # include dates from the budget
    budget = budget_cell.getParentValue().getParentValue()
    query_dict.setdefault('from_date', budget.getStartDateRangeMin())
    start_date_range_max = budget.getStartDateRangeMax()
    if start_date_range_max:
      query_dict.setdefault('at_date', start_date_range_max.latestTime())
119
    return query_dict
120

121 122
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoryListQueryDict')
123 124 125
  def getInventoryListQueryDict(self, budget_line):
    """Returns the query dict to pass to simulation query for a budget line
    """
126
    query_dict = {}
127 128 129
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
130 131 132 133
      variation_query_dict = budget_variation.getInventoryListQueryDict(
                                                      budget_line)
      # Merge group_by and select_list arguments.
      # Other arguments should not conflict
134 135
      if 'group_by' in query_dict and 'group_by' in variation_query_dict:
        variation_query_dict['group_by'].extend(query_dict['group_by'])
136 137 138 139
      if 'select_list' in query_dict \
          and 'select_list' in variation_query_dict:
        variation_query_dict['select_list'].extend(
            query_dict['select_list'])
140 141

      query_dict.update(variation_query_dict)
142

143 144 145 146 147 148 149 150
    # include dates from the budget
    budget = budget_line.getParentValue()
    query_dict.setdefault('from_date', budget.getStartDateRangeMin())
    start_date_range_max = budget.getStartDateRangeMax()
    if start_date_range_max:
      query_dict.setdefault('at_date', start_date_range_max.latestTime())
    return query_dict

151 152
  def _getCellKeyFromInventoryListBrain(self, brain, budget_line,
                                        cell_key_cache=None):
153 154 155 156 157 158 159
    """Compute the cell key from an inventory brain, the cell key can be used
    to retrieve the budget cell in the corresponding budget line.
    """
    cell_key = ()
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
160 161
      key = budget_variation._getCellKeyFromInventoryListBrain(
                  brain, budget_line, cell_key_cache=cell_key_cache)
162 163 164
      if key:
        cell_key += (key,)
    return cell_key
165 166 167
    
  security.declareProtected(Permissions.AccessContentsInformation,
                            'asBudgetPredicate')
168 169 170 171 172
  def asBudgetPredicate(self):
    " "
    # XXX predicate for line / cell ?

  def getBudgetConsumptionMethod(self, budget_cell):
173
    # XXX this API might disapear
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    # XXX return the method, or compute directly ?
    budget_consumption_method = None
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
      if budget_variation.getBudgetConsumptionMethod(budget_cell):
        budget_consumption_method = \
          budget_variation.getBudgetConsumptionMethod(budget_cell)
    return budget_consumption_method

  def getBudgetLineVariationRangeCategoryList(self, budget_line):
    variation_range_category_list = []
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
189 190
      if budget_variation.isMemberOf('budget_variation/budget'):
        continue
191 192 193 194 195 196 197
      variation_range = \
        budget_variation.getBudgetLineVariationRangeCategoryList(budget_line)
      if variation_range and variation_range not in\
                  variation_range_category_list:
        variation_range_category_list.extend(variation_range)
    return variation_range_category_list

198 199 200 201 202 203 204 205 206 207 208 209 210 211
  def getBudgetVariationRangeCategoryList(self, budget):
    variation_range_category_list = []
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
      if not budget_variation.isMemberOf('budget_variation/budget'):
        continue
      variation_range = \
        budget_variation.getBudgetVariationRangeCategoryList(budget)
      if variation_range and variation_range not in\
                  variation_range_category_list:
        variation_range_category_list.extend(variation_range)
    return variation_range_category_list

212 213 214 215
  def initializeBudgetLine(self, budget_line):
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
216 217 218 219 220 221 222 223 224
      if not budget_variation.isMemberOf('budget_variation/budget'):
        budget_variation.initializeBudgetLine(budget_line)

  def initializeBudget(self, budget):
    for budget_variation in sorted(self.contentValues(
              portal_type=self.getPortalBudgetVariationTypeList()),
              key=lambda x:x.getIntIndex()):
      if budget_variation.isMemberOf('budget_variation/budget'):
        budget_variation.initializeBudget(budget)
225