Periodicity.py 11.2 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
3
# Copyright (c) 2006 Nexedi SARL and Contributors. All Rights Reserved.
Sebastien Robin's avatar
Sebastien Robin committed
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 31 32 33 34 35
#                    Sebastien Robin <seb@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
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Base import Base
from Acquisition import aq_base, aq_parent, aq_inner, aq_acquire
from Products.CMFCore.utils import getToolByName
from DateTime import DateTime
36
from Products.ERP5Type.DateUtils import addToDate
37
from Products.ERP5Type.Message import Message
Sebastien Robin's avatar
Sebastien Robin committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

from zLOG import LOG

class Periodicity(Base):
    """
    An Alarm is in charge of checking anything (quantity of a certain
    resource on the stock, consistency of some order,....) periodically.

    It should also provide a solution if something wrong happens.

    Some information should be displayed to the user, and also notifications.
    """

    # CMF Type Definition
    meta_type = 'ERP5 Periodicity'
    portal_type = 'Periodicity'
    add_permission = Permissions.AddPortalContent
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
60
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Sebastien Robin's avatar
Sebastien Robin committed
61 62 63 64 65 66 67

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.DublinCore
                      , PropertySheet.Periodicity
                      )

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    def validateMinute(self, date, previous_date):
      periodicity_minute_frequency = self.getPeriodicityMinuteFrequency()
      periodicity_minute_list = self.getPeriodicityMinuteList()
      if (periodicity_minute_frequency is None) and \
         (periodicity_minute_list in ([], None, ())):
        # in this case, we may want to have an periodicity every hour 
        # based on the start date
        # without defining anything about minutes periodicity, 
        # so we compare with minutes with the one defined 
        # in the previous alarm date
        return (date.minute() == previous_date.minute())
      if periodicity_minute_frequency not in ('', None):
        return (date.minute() % periodicity_minute_frequency) == 0
      elif len(periodicity_minute_list) > 0:
        return date.minute() in periodicity_minute_list

    def validateHour(self, date):
      periodicity_hour_frequency = self.getPeriodicityHourFrequency()
      periodicity_hour_list = self.getPeriodicityHourList()
      if (periodicity_hour_frequency is None) and \
         (periodicity_hour_list in ([], None, ())):
        return 1
      if periodicity_hour_frequency not in ('', None):
        return (date.hour() % periodicity_hour_frequency) == 0
      elif len(periodicity_hour_list) > 0:
        return date.hour() in periodicity_hour_list

    def validateDay(self, date):
      periodicity_day_frequency = self.getPeriodicityDayFrequency()
      periodicity_month_day_list = self.getPeriodicityMonthDayList()
      if (periodicity_day_frequency is None) and \
         (periodicity_month_day_list in ([], None, ())):
        return 1
      if periodicity_day_frequency not in ('', None):
        return (date.day() % periodicity_day_frequency) == 0
      elif len(periodicity_month_day_list) > 0:
        return date.day() in periodicity_month_day_list

    def validateWeek(self, date):
      periodicity_week_frequency = self.getPeriodicityWeekFrequency()
      periodicity_week_day_list = self.getPeriodicityWeekDayList()
      periodicity_week_list = self.getPeriodicityWeekList()
      if (periodicity_week_frequency is None) and \
         (periodicity_week_day_list in ([], None, ())) and \
         (periodicity_week_list is None):
        return 1
      if periodicity_week_frequency not in ('', None):
        if not((date.week() % periodicity_week_frequency) == 0):
          return 0
      if periodicity_week_day_list not in (None, (), []):
        if not (date.Day() in periodicity_week_day_list):
          return 0
      if periodicity_week_list not in (None, (), []):
        if not (date.week() in periodicity_week_list):
          return 0
      return 1

    def validateMonth(self, date):
      periodicity_month_frequency = self.getPeriodicityMonthFrequency()
      periodicity_month_list = self.getPeriodicityMonthList()
      if (periodicity_month_frequency is None) and \
         (periodicity_month_list in ([], None, ())):
        return 1
      if periodicity_month_frequency not in ('', None):
        return (date.month() % periodicity_month_frequency) == 0
      elif len(periodicity_month_list) > 0:
        return date.month() in periodicity_month_list

    def getNextAlarmDate(self, current_date, next_start_date=None):
Sebastien Robin's avatar
Sebastien Robin committed
137 138 139 140 141
      """
      Get the next date where this periodic event should start.

      We have to take into account the start date, because
      sometimes an event may be started by hand. We must be
142
      sure to never forget to start an event, even with some
Sebastien Robin's avatar
Sebastien Robin committed
143 144 145 146 147 148
      delays.

      Here are some rules :
      - if the periodicity start date is in the past and we never starts
        this periodic event, then return the periodicity start date.
      - if the periodicity start date is in the past but we already
Aurel's avatar
Aurel committed
149
        have started the periodic event, then see
Sebastien Robin's avatar
Sebastien Robin committed
150
      """
151 152
      if next_start_date is None:
        next_start_date = current_date
153
      if next_start_date > current_date:
154
        return
155 156 157 158
      else:
        # Make sure the old date is not too far away
        nb_days = int(current_date-next_start_date)
        next_start_date = next_start_date + nb_days
159

Aurel's avatar
Aurel committed
160
      previous_date = next_start_date
161
      next_start_date = addToDate(next_start_date, minute=1)
162
      while 1:
163 164 165 166 167
        validate_minute = self.validateMinute(next_start_date, previous_date)
        validate_hour = self.validateHour(next_start_date)
        validate_day = self.validateDay(next_start_date)
        validate_week = self.validateWeek(next_start_date)
        validate_month = self.validateMonth(next_start_date)
168 169 170 171 172 173
        if (next_start_date >= current_date \
            and validate_minute and validate_hour and validate_day \
            and validate_week and validate_month):
          break
        else:
          if not(validate_minute):
174
            next_start_date = addToDate(next_start_date, minute=1)
175 176
          else:
            if not(validate_hour):
177
              next_start_date = addToDate(next_start_date, hour=1)
178 179
            else:
              if not(validate_day and validate_week and validate_month):
180
                next_start_date = addToDate(next_start_date, day=1)
181 182 183
              else:
                # Everything is right, but the date is still not bigger
                # than the current date, so we must continue
184 185
                next_start_date = addToDate(next_start_date, minute=1)
      return next_start_date
186

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    security.declareProtected(Permissions.View, 'setNextAlarmDate')
    def setNextAlarmDate(self, current_date=None):
      """
      Save the next alarm date
      """
      if self.getPeriodicityStartDate() is None:
        return
      next_start_date = self.getAlarmDate()
      if current_date is None:
        # This is usefull to set the current date as parameter for
        # unit testing, by default it should be now
        current_date = DateTime()

      next_start_date = self.getNextAlarmDate(current_date, 
                                              next_start_date=next_start_date)
      if next_start_date is not None:
        self.Alarm_zUpdateAlarmDate(uid=self.getUid(), 
                                    alarm_date=next_start_date)
205

206
    security.declareProtected(Permissions.View, 'getAlarmDate')
207 208 209 210
    def getAlarmDate(self):
      """
      returns something like ['Sunday','Monday',...]
      """
211 212 213 214 215 216 217 218 219 220
      #alarm_date = self._baseGetAlarmDate()
      #if alarm_date is None:
      #  alarm_date = self.getPeriodicityStartDate()
      alarm_date=None
      result_list = self.Alarm_zGetAlarmDate(uid=self.getUid())
      if len(result_list)==1:
        alarm_date = result_list[0].alarm_date
        periodicity_start_date = self.getPeriodicityStartDate()
        if alarm_date < periodicity_start_date:
          alarm_date = periodicity_start_date
221
      return alarm_date
Sebastien Robin's avatar
Sebastien Robin committed
222 223 224 225 226 227 228 229 230

    # XXX May be we should create a Date class for following methods ???
    security.declareProtected(Permissions.View, 'getWeekDayList')
    def getWeekDayList(self):
      """
      returns something like ['Sunday','Monday',...]
      """
      return DateTime._days

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    security.declareProtected(Permissions.View, 'getWeekDayItemList')
    def getWeekDayItemList(self):
      """
      returns something like [('Sunday', 'Sunday'), ('Monday', 'Monday'),...]
      """
      return [(Message(domain='erp5_ui', message=x), x) \
              for x in self.getWeekDayList()]

    security.declareProtected(Permissions.View, 'getWeekDayItemList')
    def getMonthItemList(self):
      """
      returns something like [('January', 1), ('February', 2),...]
      """
      # DateTime._months return '' as first item
      return [(Message(domain='erp5_ui', message=DateTime._months[i]), i) \
              for i in range(1, len(DateTime._months))]

Sebastien Robin's avatar
Sebastien Robin committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
    # XXX This look like to not works, so override the getter
#    security.declarePrivate('_setPeriodicityWeekDayList')
#    def _setPeriodicityWeekDayList(self,value):
#      """
#      Make sure that the list of days is ordered
#      """
#      LOG('_setPeriodicityWeekDayList',0,'we should order')
#      day_list = self._baseGetPeriodicityWeekDayList()
#      new_list = []
#      for day in self.getWeekDayList():
#        if day in value:
#          new_list += [day]
#      self._baseSetPeriodicityWeekDayList(new_list)

    security.declareProtected(Permissions.View,'getPeriodicityWeekDayList')
    def getPeriodicityWeekDayList(self):
      """
      Make sure that the list of days is ordered
      """
Aurel's avatar
Aurel committed
267
      #LOG('getPeriodicityWeekDayList',0,'we should order')
Sebastien Robin's avatar
Sebastien Robin committed
268 269 270
      day_list = self._baseGetPeriodicityWeekDayList()
      new_list = []
      for day in self.getWeekDayList():
271 272 273
        if day_list is not None:
          if day in day_list:
            new_list += [day]
Sebastien Robin's avatar
Sebastien Robin committed
274
      return new_list