Alarm.py 17.2 KB
Newer Older
1
# -*- coding: utf-8 -*-
Sebastien Robin's avatar
Sebastien Robin committed
2 3
##############################################################################
#
4
# Copyright (c) 2004,2007,2009 Nexedi SA and Contributors. All Rights Reserved.
Sebastien Robin's avatar
Sebastien Robin committed
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
#                    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.
#
##############################################################################

30
from compiler.consts import CO_VARKEYWORDS
31 32 33 34
from DateTime import DateTime
from AccessControl import ClassSecurityInfo, Unauthorized
from AccessControl.SecurityManagement import getSecurityManager, \
            setSecurityManager, newSecurityManager
Sebastien Robin's avatar
Sebastien Robin committed
35
from Products.CMFCore.utils import getToolByName
36
from Products.ERP5Type import Permissions, PropertySheet
Sebastien Robin's avatar
Sebastien Robin committed
37
from Products.ERP5Type.XMLObject import XMLObject
38
from Products.ERP5Security.ERP5UserManager import SUPER_USER
39
from Products.ERP5.mixin.periodicity import PeriodicityMixin
40 41 42 43 44

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.
45 46 47 48 49 50 51 52 53 54 55 56 57 58
  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.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
  """

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

  # 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
Sebastien Robin's avatar
Sebastien Robin committed
78
                    , PropertySheet.Configurable
79 80
                    , PropertySheet.Alarm
                    )
Sebastien Robin's avatar
Sebastien Robin committed
81

82
  security.declareProtected(Permissions.AccessContentsInformation, 'isActive')
83 84 85 86
  def isActive(self):
    """
    This method returns only True or False. 
    It simply tells if this alarm is currently
87 88 89 90
    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).
91
    """
92
    return self.hasActivity(only_valid=1)
93

94 95 96 97 98 99 100 101 102 103
  def __getTag(self, new):
    # Tag is generated from portal_ids so that it can be retrieved
    # later when creating an active process for example
    portal_ids = self.getPortalObject().portal_ids
    if new:
      id = portal_ids.generateNewId(id_generator='uid', id_group=self.getId())
    else:
      id = portal_ids.getLastLengthGeneratedId(id_group=self.getId())
    return '%s_%s' % (self.getRelativeUrl(), id)

104
  security.declareProtected(Permissions.AccessContentsInformation, 'activeSense')
105
  def activeSense(self, fixit=0, params=None):
106
    """
107 108 109 110
    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.
111

112 113
    The result of the sensing process can be obtained by invoking
    the sense method or by requesting a report.
114
    """
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    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
        # We do some inspection to keep compatibility
        # (because fixit and tag were not set previously)
138
        tag = self.__getTag(True)
139 140 141 142 143 144 145 146 147 148
        method = getattr(self, method_id)
        func_code = method.func_code
        try:
          has_kw = func_code.co_flags & CO_VARKEYWORDS
        except AttributeError:
          # XXX guess presence of *args and **kw
          name_list = func_code.co_varnames[func_code.co_argcount:]
          has_args = int(name_list and name_list[0] == 'args')
          has_kw = int(len(name_list) > has_args and
                       name_list[has_args] == 'kw')
149
        name_list = func_code.co_varnames[:func_code.co_argcount]
150
        if 'params' in name_list or has_kw:
151 152 153
          # New New API
          getattr(self.activate(tag=tag), method_id)(fixit=fixit, tag=tag, params=params)
        elif 'fixit' in name_list:
154 155 156 157 158 159
          # 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():
160
          self.activate(after_tag=tag).notify(include_active=True, params=params)
161 162 163
    finally:
      # Restore the original user.
      setSecurityManager(sm)
164

165
  security.declareProtected(Permissions.ManagePortal, 'sense')
166
  def sense(self, process=None):
167 168 169
    """
    This method returns True or False. False for no problem, True for problem.

170 171 172 173 174 175 176
    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.
177
    If it is None, it will return the status of last completed active result.
178 179 180
    """
    method_id = self.getSenseMethodId()
    if process is None:
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
      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
209
      if getattr(result, 'result', False):
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
        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.
225

226
  security.declareProtected(Permissions.AccessContentsInformation, 'report')
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  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
244
    elif not isinstance(process, basestring):
245
      process = process.getRelativeUrl()
246
    return self._renderDefaultView('report', process=process, reset=reset)
247

248
  security.declareProtected(Permissions.ManagePortal, 'solve')
249 250
  def solve(self):
    """
251 252 253
    This method tries resolve a problems detected by an Alarm
    within the sensing process. Problem resolution is
    implemented by an external script.
254

255 256
    If no external script is dehfined, activeSense is invoked 
    with fixit=1
257
    """
258 259 260 261 262
    method_id = self.getSolveMethodId()
    if method_id not in (None, ''):
      method = getattr(self.activate(), method_id)
      return method()
    return self.activeSense(fixit=1)
263

264
  security.declareProtected(Permissions.ManagePortal, 'notify')
265
  def notify(self, include_active=False, params=None):
266 267
    """
    This method is called to notify people that some alarm has
268 269 270 271
    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.
    """
272 273 274
    notification_mode = self.getAlarmNotificationMode()
    if notification_mode == 'never':
      return
Vincent Pelletier's avatar
Vincent Pelletier committed
275
    # Grab real latest result. Otherwise, we would check n-1 execution as n is
276
    # still considered running, and its result would be skipped.
277
    active_process = self.getLastActiveProcess(include_active=include_active)
278 279 280 281 282 283 284 285 286
    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,
287 288
                               sense_result=sense_result,
                               params=params)
289 290 291
      return

    if sense_result:
292 293 294
      prefix = 'ERROR'
    else:
      prefix = 'INFO'
295

296 297 298 299
    notification_tool = getToolByName(self, 'portal_notifications')
    candidate_list = self.getDestinationValueList()
    if not candidate_list:
      candidate_list = None
300
    result_list = [x for x in active_process.getResultList() if x is not None]
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    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'})

317
    notification_tool.sendMessage(recipient=candidate_list, 
318 319
                subject='[%s][%s] Alarm Notification: %s' %
                  (prefix, self.getPortalObject().getTitle(), self.getTitle()),
320
                message="""
321
Alarm Title: %s (%s)
322

323 324
Alarm Description:
%s
325

326 327 328 329
Alarm Tool Node: %s
""" % (self.getTitle(), self.getId(), self.getDescription(),
       self.getPortalObject().portal_alarms.getAlarmNode()),
                attachment_list=attachment_list)
330

331
  security.declareProtected(Permissions.ManagePortal, 'getLastActiveProcess')
332
  def getLastActiveProcess(self, include_active=False):
333 334 335 336
    """
    This returns the last active process finished. So it will
    not returns the current one
    """
337 338 339 340
    if include_active:
      limit = 1
    else:
      limit = self.isActive() and 2 or 1
341 342
    active_process_list = self.getPortalObject().portal_catalog(
      portal_type='Active Process', limit=limit,
343 344 345
      sort_on=(('creation_date', 'DESC'),
               # XXX Work around poor resolution of MySQL dates.
               ('CONVERT(`catalog`.`id`, UNSIGNED)', 'DESC')),
346 347 348 349 350 351
      causality_uid=self.getUid())
    if len(active_process_list) < limit:
      process = None
    else:
      process = active_process_list[-1].getObject()
    return process
352

353
  security.declareProtected(Permissions.ManagePortal, 
354
                            'newActiveProcess')
355
  def newActiveProcess(self, **kw):
356 357 358 359 360
    """
    We will create a new active process in order to store
    new results, then this process will be added to the list
    of processes
    """
361
    activate_kw = kw.get('activate_kw', {})
362
    activate_kw.setdefault('tag', self.__getTag(False))
363
    portal_activities = getToolByName(self,'portal_activities')
364 365
    active_process = portal_activities.newActiveProcess(start_date=DateTime(),
                                                        causality_value=self,
366
                                                        activate_kw=activate_kw,
367
                                                        **kw)
368 369
    return active_process

370
  security.declareProtected(Permissions.ModifyPortalContent, 'setNextAlarmDate')
371
  def setNextAlarmDate(self, current_date=None):
372 373 374 375 376
    """Save the next alarm date.
    """
    alarm_date = self.getAlarmDate()
    if alarm_date is not None:
      if current_date is None:
377
        # This is useful to set the current date as parameter for
378 379 380 381 382
        # 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)
383

384
  security.declareProtected(Permissions.AccessContentsInformation, 'getAlarmDate')
385
  def getAlarmDate(self):
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
    """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.
403
      result_list = self.Alarm_zGetAlarmDate(uid=self.getUid())
404
      if len(result_list) == 1:
405
        alarm_date = result_list[0].alarm_date
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
      # 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:
        alarm_date = periodicity_start_date

      # 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)

421
    return alarm_date
422 423 424 425 426 427 428 429 430

  # 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