Alarm.py 24.4 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2
##############################################################################
#
3
# Copyright (c) 2004,2007,2009 Nexedi SA 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
#                    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.
#
##############################################################################

29
import zope.interface
Sebastien Robin's avatar
Sebastien Robin committed
30
from AccessControl import ClassSecurityInfo
31
from AccessControl import Unauthorized
Sebastien Robin's avatar
Sebastien Robin committed
32
from Products.CMFCore.utils import getToolByName
33
from Products.ERP5Type import Permissions, PropertySheet
Sebastien Robin's avatar
Sebastien Robin committed
34
from Products.ERP5Type.XMLObject import XMLObject
35
from Acquisition import aq_base
Sebastien Robin's avatar
Sebastien Robin committed
36
from DateTime import DateTime
37 38
from Products.ERP5Type.Message import Message
from Products.ERP5Type.DateUtils import addToDate
39 40 41
from Products.ERP5Security.ERP5UserManager import SUPER_USER
from AccessControl.SecurityManagement import getSecurityManager, \
            setSecurityManager, newSecurityManager
Sebastien Robin's avatar
Sebastien Robin committed
42

43 44 45 46 47 48
class PeriodicityMixin:
  """
  Periodicity is a Mixin Class used to calculate date periodicity.
  """
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Sebastien Robin's avatar
Sebastien Robin committed
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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
  def _validateMinute(self, date, previous_date):
    """
    Validate if date's minute matches the periodicity definition
    """
    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):
    """
    Validate if date's hour matches the periodicity definition
    """
    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):
    """
    Validate if date's day matches the periodicity definition
    """
    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):
    """
    Validate if date's week matches the periodicity definition
    """
    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):
    """
    Validate if date's month matches the periodicity definition
    """
    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

133
  security.declareProtected(Permissions.AccessContentsInformation, 'getNextPeriodicalDate')
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
  def getNextPeriodicalDate(self, current_date, next_start_date=None):
    """
    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
    sure to never forget to start an event, even with some
    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
      have started the periodic event, then see

    XXX Better API is needed. It may defined which minimal time duration has to 
    be added in order to calculate next date.
    Ex: here, we use minute as smaller duration.
    On CalendarPeriod, day is the smaller duration.
    """
154
    periodicity_stop_date = self.getPeriodicityStopDate()
155 156
    if next_start_date is None:
      next_start_date = current_date
157 158 159 160
    if next_start_date > current_date \
          or (periodicity_stop_date is not None \
              and next_start_date >= periodicity_stop_date):
      return None
161 162
    else:
      # Make sure the old date is not too far away
163
      day_count = int(current_date - next_start_date)
164
      next_start_date = next_start_date + day_count
Sebastien Robin's avatar
Sebastien Robin committed
165

166 167 168 169 170 171 172 173 174 175 176 177
    previous_date = next_start_date
    next_start_date = addToDate(next_start_date, minute=1)
    while 1:
      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)
      if (next_start_date >= current_date \
          and validate_minute and validate_hour and validate_day \
          and validate_week and validate_month):
        break
Sebastien Robin's avatar
Sebastien Robin committed
178
      else:
179 180 181 182 183 184 185
        if not(validate_minute):
          next_start_date = addToDate(next_start_date, minute=1)
        else:
          if not(validate_hour):
            next_start_date = addToDate(next_start_date, hour=1)
          else:
            if not(validate_day and validate_week and validate_month):
186 187
              # We have to reset hours and minutes in order to make sure
              # we will start at the beginning of the next day
188
              next_start_date = DateTime(next_start_date.Date() + ' 00:00:00 %s' % next_start_date.timezone())
189 190 191 192 193 194 195 196
              next_start_date = addToDate(next_start_date, day=1)
            else:
              # Everything is right, but the date is still not bigger
              # than the current date, so we must continue
              next_start_date = addToDate(next_start_date, minute=1)
    return next_start_date

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

204
  security.declareProtected(Permissions.AccessContentsInformation, 'getWeekDayItemList')
205 206 207 208 209 210 211
  def getWeekDayItemList(self):
    """
    returns something like [('Sunday', 'Sunday'), ('Monday', 'Monday'),...]
    """
    return [(Message(domain='erp5_ui', message=x), x) \
            for x in self.getWeekDayList()]

212
  security.declareProtected(Permissions.AccessContentsInformation, 'getWeekDayItemList')
213 214 215 216 217 218 219 220
  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))]

221
  security.declareProtected(Permissions.AccessContentsInformation,'getPeriodicityWeekDayList')
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
  def getPeriodicityWeekDayList(self):
    """
    Make sure that the list of days is ordered
    """
    #LOG('getPeriodicityWeekDayList',0,'we should order')
    day_list = self._baseGetPeriodicityWeekDayList()
    new_list = []
    for day in self.getWeekDayList():
      if day_list is not None:
        if day in day_list:
          new_list += [day]
    return new_list

class Alarm(XMLObject, PeriodicityMixin):
  """
  An Alarm is in charge of checking anything (quantity of a certain
  resource on the stock, consistency of some order,....) periodically.
239 240 241 242 243 244 245 246 247 248 249 250 251 252
  This check can span over multiple activities through an active
  process.

  An Alarm is capable of displaying the last result of the check
  process which was run in background. The result can be provided
  either as a boolean value (alarm was raised or not) or 
  in the form of an HTML report which is intended to be 
  displayed in a control center. Moreover, user may be notified
  automatically of alarm failures.

  Alarm may also provide a solution if something wrong happens. This
  solution takes the form of a script which can be invoked
  by the administrator or by the user by clicking on a button
  displayed in the Alarm control center.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
  """

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

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

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Periodicity
                    , PropertySheet.Document
                    , PropertySheet.Task
                    , PropertySheet.Alarm
                    )
Sebastien Robin's avatar
Sebastien Robin committed
276

277
  security.declareProtected(Permissions.AccessContentsInformation, 'isActive')
278 279 280 281
  def isActive(self):
    """
    This method returns only True or False. 
    It simply tells if this alarm is currently
282 283 284 285
    active or not. An Alarm is said to be active whenever
    some calculation is undergoing either as part
    of the sensing process (activeSense) or as part
    of the problem resolution process (solve).
286
    """
287
    return self.hasActivity(only_valid=1)
288

289
  security.declareProtected(Permissions.AccessContentsInformation, 'activeSense')
290
  def activeSense(self, fixit=0):
291
    """
292 293 294 295
    This method launches the sensing process as activities.
    It is intended to launch a very long process made
    of many activities. It returns nothing since the results
    are collected in an active process.
296

297 298
    The result of the sensing process can be obtained by invoking
    the sense method or by requesting a report.
299
    """
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    portal_membership = self.getPortalObject().portal_membership
    if fixit or not self.getEnabled():
      checkPermission = portal_membership.checkPermission
      if not checkPermission(Permissions.ManagePortal, self):
        raise Unauthorized('fixing problems or activating a disabled alarm is not allowed')

    # Switch to the superuser temporarily, so that the behavior would not
    # change even if this method is invoked by random users.
    sm = getSecurityManager()
    newSecurityManager(None, portal_membership.getMemberById(SUPER_USER))
    try:
      # Set the next date at which this method should be invoked
      self.setNextAlarmDate()

      # Find the active sensing method and invoke it
      # as an activity so that we can benefit from
      # distribution of alarm processing as soon as possible
      method_id = self.getActiveSenseMethodId()
      if method_id not in (None, ''):
        # A tag is provided as a parameter in order to be
        # able to notify the user after all processes are ended
        # Tag is generated from portal_ids so that it can be retrieved
        # later when creating an active process for example
        # We do some inspection to keep compatibility
        # (because fixit and tag were not set previously)
        tag = str(self.portal_ids.generateNewLengthId(id_group=self.getId()))
        kw = {}
        method = getattr(self, method_id)
        name_list = method.func_code.co_varnames
        if 'fixit' in name_list or (method.func_defaults is not None
          and len(method.func_defaults) < len(name_list)):
          # New API - also if variable number of named parameters
          getattr(self.activate(tag=tag), method_id)(fixit=fixit, tag=tag)
        else:
          # Old API
          getattr(self.activate(tag=tag), method_id)()
        if self.isAlarmNotificationMode():
          self.activate(after_tag=tag).notify(include_active=True)
    finally:
      # Restore the original user.
      setSecurityManager(sm)
341

342
  security.declareProtected(Permissions.ManagePortal, 'sense')
343
  def sense(self, process=None):
344 345 346
    """
    This method returns True or False. False for no problem, True for problem.

347 348 349 350 351 352 353
    This method should respond very quickly.

    Complex alarms should use activity based calculations through
    the activeSense method.

    The process parameter can be used to retrive sense values for 
    past processes.
354
    If it is None, it will return the status of last completed active result.
355 356 357
    """
    method_id = self.getSenseMethodId()
    if process is None:
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
      process = self.getLastActiveProcess()

    # First case - simple cron style alarm
    # with no results
    if process is None and method_id in (None, ''):
      return None

    # Second case - this alarm does not use an
    # active process. This is perfectly acceptable
    # in some cases, whenever the sense calculation
    # is really fast.
    if process is None:
      method = getattr(self, method_id)
      return method()

    # Third case - this alarm uses an
    # active process and a method_id is defined
    if method_id not in (None, ''):
      method = getattr(self, method_id)
      return method(process=process)

    # Fourth case - this alarm uses an
    # active process but no method_id is defined
    for result in process.getResultList():
      # This is useful is result is returned as a Return instance
      if result.severity > result.INFO:
        return True
      # This is the default case
386
      if getattr(result, 'result', False):
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
        return True

    return False
    # This comment here is kept for historical reasons
    # There used to be a call to process.setSenseValue(value)
    # This means that each time an alarm is displayed,
    # we modify it to keep its latest sense result somewhere
    # This was bad for two reasons: first of all, it is
    # actually a caching problem, and if necesssary,
    # this caching problem should be solved by using caches.
    # Then, if caching is required, it may not only be
    # at display time and not only for sense(). So, the
    # baseline is to use caches and if necessary to develop
    # a new cache plugin which uses ZODB to store values
    # for a long time.
402 403

  security.declareProtected(Permissions.View, 'report')
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  def report(self, reset=0, process=None):
    """
    This methods produces a report (HTML) to display
    the results of the sensing process.

    The report is intended to provide a nice visualisation
    of the sensing process, of problems which may occur or
    of the fact that there was no problem. No calculation
    should be made normally at this time (or very fast calculation).
    Complex alarms should implement calculation through
    the invocation of activeSense.

    Report implementation is normally made using an
    ERP5 Form.
    """
    if process is None:
      process = self.getLastActiveProcess().getRelativeUrl()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
421
    elif not isinstance(process, basestring):
422
      process = process.getRelativeUrl()
423
    return self._renderDefaultView('report', process=process, reset=reset)
424

425
  security.declareProtected(Permissions.ManagePortal, 'solve')
426 427
  def solve(self):
    """
428 429 430
    This method tries resolve a problems detected by an Alarm
    within the sensing process. Problem resolution is
    implemented by an external script.
431

432 433
    If no external script is dehfined, activeSense is invoked 
    with fixit=1
434
    """
435 436 437 438 439
    method_id = self.getSolveMethodId()
    if method_id not in (None, ''):
      method = getattr(self.activate(), method_id)
      return method()
    return self.activeSense(fixit=1)
440

441
  security.declareProtected(Permissions.ManagePortal, 'notify')
442
  def notify(self, include_active=False):
443 444
    """
    This method is called to notify people that some alarm has
445 446 447 448
    been sensed. Notification consists of sending an email
    to the system address if nothing was defined or to 
    notify all agents defined on the alarm if specified.
    """
449 450 451
    notification_mode = self.getAlarmNotificationMode()
    if notification_mode == 'never':
      return
Vincent Pelletier's avatar
Vincent Pelletier committed
452
    # Grab real latest result. Otherwise, we would check n-1 execution as n is
453
    # still considered running, and its result would be skipped.
454
    active_process = self.getLastActiveProcess(include_active=include_active)
455 456 457 458 459 460 461 462 463 464 465 466 467
    sense_result = self.sense(process=active_process)
    if not sense_result and notification_mode != 'always':
        return

    # If a notification method is specified explicitly, call it instead of
    # using the default notification.
    method_id = self.getNotificationMethodId()
    if method_id:
      getattr(self, method_id)(process=active_process,
                               sense_result=sense_result)
      return

    if sense_result:
468 469 470
      prefix = 'ERROR'
    else:
      prefix = 'INFO'
471

472 473 474 475
    notification_tool = getToolByName(self, 'portal_notifications')
    candidate_list = self.getDestinationValueList()
    if not candidate_list:
      candidate_list = None
476
    result_list = [x for x in active_process.getResultList() if x is not None]
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    attachment_list = []
    if len(result_list):
      def sort_result_list(a, b):
        result = - cmp(a.severity, b.severity)
        if result == 0:
          result = cmp(a.summary, b.summary)
        return result
      result_list.sort(sort_result_list)
      rendered_alarm_result_list = ['%02i summary: %s\n%s\n----' %
        (int(getattr(x, 'severity', 0)), getattr(x, 'summary', ''), getattr(x, 'detail', ''))
        for x in result_list]
      rendered_alarm_result = '\n'.join(rendered_alarm_result_list)
      attachment_list.append({'name': 'alarm_result.txt',
                              'content': rendered_alarm_result,
                              'mime_type': 'text/plain'})

493
    notification_tool.sendMessage(recipient=candidate_list, 
494 495
                subject='[%s][%s] Alarm Notification: %s' %
                  (prefix, self.getPortalObject().getTitle(), self.getTitle()),
496
                message="""
497
Alarm Title: %s (%s)
498

499 500
Alarm Description:
%s
501

502 503 504 505
Alarm Tool Node: %s
""" % (self.getTitle(), self.getId(), self.getDescription(),
       self.getPortalObject().portal_alarms.getAlarmNode()),
                attachment_list=attachment_list)
506

507
  security.declareProtected(Permissions.ManagePortal, 'getLastActiveProcess')
508
  def getLastActiveProcess(self, include_active=False):
509 510 511 512
    """
    This returns the last active process finished. So it will
    not returns the current one
    """
513 514 515 516
    if include_active:
      limit = 1
    else:
      limit = self.isActive() and 2 or 1
517 518
    active_process_list = self.getPortalObject().portal_catalog(
      portal_type='Active Process', limit=limit,
519 520 521
      sort_on=(('creation_date', 'DESC'),
               # XXX Work around poor resolution of MySQL dates.
               ('CONVERT(`catalog`.`id`, UNSIGNED)', 'DESC')),
522 523 524 525 526 527
      causality_uid=self.getUid())
    if len(active_process_list) < limit:
      process = None
    else:
      process = active_process_list[-1].getObject()
    return process
528

529
  security.declareProtected(Permissions.ManagePortal, 
530
                            'newActiveProcess')
531
  def newActiveProcess(self, **kw):
532 533 534 535 536
    """
    We will create a new active process in order to store
    new results, then this process will be added to the list
    of processes
    """
537
    tag = self.portal_ids.getLastLengthGeneratedId(id_group=self.getId())
538
    activate_kw = kw.get('activate_kw', {})
539 540
    if tag is not None:
      activate_kw.setdefault('tag', str(tag))
541
    portal_activities = getToolByName(self,'portal_activities')
542 543
    active_process = portal_activities.newActiveProcess(start_date=DateTime(),
                                                        causality_value=self,
544
                                                        activate_kw=activate_kw,
545
                                                        **kw)
546 547
    return active_process

548
  security.declareProtected(Permissions.ModifyPortalContent, 'setNextAlarmDate')
549
  def setNextAlarmDate(self, current_date=None):
550 551 552 553 554 555 556 557 558 559 560
    """Save the next alarm date.
    """
    alarm_date = self.getAlarmDate()
    if alarm_date is not None:
      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()
      alarm_date = self.getNextPeriodicalDate(current_date, 
                                              next_start_date=alarm_date)
    self.Alarm_zUpdateAlarmDate(uid=self.getUid(), alarm_date=alarm_date)
561

562
  security.declareProtected(Permissions.AccessContentsInformation, 'getAlarmDate')
563
  def getAlarmDate(self):
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    """Obtain the next alarm date.
    
    Return a DateTime object which specifies when this alarm should
    be invoked at next time. The return value can be None when it should
    not be invoked automatically.

    By definition, if periodicity start date is not defined (i.e. None),
    their is no valid time range, so return None. If periodicity stop
    date is not defined (i.e. None), assume that this alarm will be
    effective forever. Otherwise, if a date exceeds the periodicity stop
    date, return None, as it is not effective any longer.
    """
    alarm_date = None
    enabled = self.getEnabled()
    periodicity_start_date = self.getPeriodicityStartDate()
    if enabled and periodicity_start_date is not None:
      # Respect what is stored in the catalog.
581
      result_list = self.Alarm_zGetAlarmDate(uid=self.getUid())
582
      if len(result_list) == 1:
583
        alarm_date = result_list[0].alarm_date
584 585 586
        # But if the catalog does not have a valid one, replace it
        # with the start date.
        if alarm_date is None or alarm_date < periodicity_start_date:
587
          alarm_date = periodicity_start_date
588 589 590 591 592 593 594 595 596 597

        # Check if it is valid.
        periodicity_stop_date = self.getPeriodicityStopDate()
        if periodicity_stop_date is not None \
              and alarm_date >= periodicity_stop_date:
          alarm_date = None
        else:
          # convert the date to the user provided timezone
          alarm_zone = periodicity_start_date.timezone()
          alarm_date = alarm_date.toZone(alarm_zone)
598
    return alarm_date
599 600 601 602 603 604 605 606 607

  # XXX there seem to be something which wants to call setters against
  # alarm_date, but alarms do not want to store a date in ZODB.
  security.declareProtected(Permissions.ModifyPortalContent, 'setAlarmDate')
  def setAlarmDate(self, *args, **kw):
    pass

  def _setAlarmDate(self, *args, **kw):
    pass