CategoryDivergenceTester.py 5.26 KB
Newer Older
1
# -*- coding: utf-8 -*-
2 3
#############################################################################
#
4
# Copyright (c) 2006-2008 Nexedi SA and Contributors. All Rights Reserved.
5 6 7
#                    Rafael Monnerat <rafael@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
8
# programmers who take the whole responsibility of assessing all potential
9 10
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
11
# guarantees and support are strongly adviced to contract a Free Software
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# 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.
#
##############################################################################

30
import zope.interface
31 32
from AccessControl import ClassSecurityInfo

33
from Products.ERP5Type.DivergenceMessage import DivergenceMessage
34
from Products.ERP5Type import Permissions, PropertySheet, interfaces
35
from Products.ERP5Legacy.Document.PropertyDivergenceTester import \
36 37
                                               PropertyDivergenceTester

38
class CategoryDivergenceTester(PropertyDivergenceTester):
39
  """
40
  The purpose of this divergence tester is to check the
41 42 43
  consistency between delivery movement and simulation movement
  for some specific categories.
  """
Yusei Tahara's avatar
Yusei Tahara committed
44
  meta_type = 'ERP5 Category Divergence Tester'
45 46
  portal_type = 'Category Divergence Tester'
  add_permission = Permissions.AddPortalContent
47

48 49 50 51 52
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Declarative interfaces
53
  zope.interface.implements( interfaces.IDivergenceTester, )
54 55

  # Declarative properties
56 57 58 59 60 61 62
  property_sheets = (   PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.DivergenceTester
                      , PropertySheet.SolverSelection
                     )
63

64 65 66 67 68 69 70
  def explain(self, simulation_movement):
    """
    This method returns a list of messages that contains
    the divergence of the Delivery Line.
    """
    divergence_message_list = []
    tested_property = self.getTestedPropertyList()
71

72
    delivery_mvt = simulation_movement.getDeliveryValue()
73 74
    delivery_mvt_getProperty = delivery_mvt.getProperty
    simulation_movement_getProperty = simulation_movement.getMappedProperty
75 76
    for tested_property_id, tested_property_title in \
                                  self._splitStringList(tested_property):
77 78 79 80
      if not tested_property_id.endswith('_list'):
        list_prop = '%s_list' % tested_property_id
      else:
        list_prop = tested_property_id
81
      message = None
82 83
      delivery_mvt_category_list = delivery_mvt_getProperty(list_prop)
      simulation_category_list = simulation_movement_getProperty(list_prop)
84

85 86 87
      # XXX Don't we need to check the order too ?
      delivery_mvt_category_list.sort()
      simulation_category_list.sort()
88 89

      if delivery_mvt_category_list != simulation_category_list:
90 91
        delivery_mvt_category_title_list = []
        for mvt_category in delivery_mvt_category_list:
92
          category_value = delivery_mvt.resolveCategory(mvt_category)
93 94 95 96 97
          if category_value is not None:
            if category_value.getPortalType() == 'Category':
              delivery_mvt_category_title_list.append(category_value.getTranslatedTitle())
            else:
              delivery_mvt_category_title_list.append(category_value.getTitle())
98

99 100 101
        simulation_category_title_list = []
        for mvt_category in simulation_category_list:
          category_value = delivery_mvt.resolveCategory(mvt_category)
102 103 104 105 106
          if category_value is not None:
            if category_value.getPortalType() == 'Category':
              simulation_category_title_list.append(category_value.getTranslatedTitle())
            else:
              simulation_category_title_list.append(category_value.getTitle())
107

108 109
        message = DivergenceMessage(
                     divergence_scope='category',
110
                     object_relative_url=delivery_mvt.getRelativeUrl(),
111
                     simulation_movement=simulation_movement,
112 113 114 115
                     decision_value=delivery_mvt_category_list,
                     prevision_value=simulation_category_list,
                     decision_title=', '.join(delivery_mvt_category_title_list),
                     prevision_title=', '.join(simulation_category_title_list),
116
                     tested_property=tested_property_id,
117
                     message=tested_property_title,
118 119
        )

120 121
        divergence_message_list.append(message)

122
    return divergence_message_list