AlarmTool.py 8.27 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
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
##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#                    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 time
30 31
import threading

Sebastien Robin's avatar
Sebastien Robin committed
32
from AccessControl import ClassSecurityInfo
33 34
from AccessControl.SecurityManagement import getSecurityManager, \
        newSecurityManager, setSecurityManager
35
from Products.CMFActivity.ActivityTool import getCurrentNode
36
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.ERP5Type.Core.Folder import Folder
Sebastien Robin's avatar
Sebastien Robin committed
38 39 40
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from Products.ERP5 import _dtmldir
41
from Products.ERP5.mixin.timer_service import TimerServiceMixin
Sebastien Robin's avatar
Sebastien Robin committed
42
from DateTime import DateTime
43
import urllib
Sebastien Robin's avatar
Sebastien Robin committed
44

45 46
last_tic = time.time()
last_tic_lock = threading.Lock()
47
_check_upgrade = True
48

49
class AlarmTool(TimerServiceMixin, BaseTool):
Sebastien Robin's avatar
Sebastien Robin committed
50
  """
51 52
    This tool manages alarms.

Vincent Pelletier's avatar
Vincent Pelletier committed
53
    It is used as a central managment point for all alarms.
Sebastien Robin's avatar
Sebastien Robin committed
54

Vincent Pelletier's avatar
Vincent Pelletier committed
55
    Inside this tool we have a way to retrieve all reports coming
Vincent Pelletier's avatar
Vincent Pelletier committed
56
    from Alarms,...
Sebastien Robin's avatar
Sebastien Robin committed
57 58 59 60
  """
  id = 'portal_alarms'
  meta_type = 'ERP5 Alarm Tool'
  portal_type = 'Alarm Tool'
61
  title = 'Alarms'
Sebastien Robin's avatar
Sebastien Robin committed
62 63 64 65 66 67 68

  # Declarative Security
  security = ClassSecurityInfo()

  security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
  manage_overview = DTMLFile( 'explainAlarmTool', _dtmldir )

69 70
  security.declareProtected( Permissions.ManagePortal , 'manageAlarmNode' )
  manageAlarmNode = DTMLFile( 'manageAlarmNode', _dtmldir )
71 72


Sebastien Robin's avatar
Sebastien Robin committed
73
  manage_options = ( ( { 'label'   : 'Overview'
Vincent Pelletier's avatar
Vincent Pelletier committed
74 75
                       , 'action'   : 'manage_overview'
                       }
76 77
                     , { 'label'   : 'Alarm Node'
                       , 'action'   : 'manageAlarmNode'
78 79
                       }
                     ,
Vincent Pelletier's avatar
Vincent Pelletier committed
80 81 82
                     )
                     + Folder.manage_options
                   )
Sebastien Robin's avatar
Sebastien Robin committed
83

84
  _properties = ( {'id': 'interval', 'type': 'int', 'mode': 'w', }, )
85
  interval = 60 # Default interval for alarms is 60 seconds
86 87 88 89 90 91 92
  # alarmNode possible values:
  #  ''      Bootstraping. The first node to call process_timer will cause this
  #          value to be set to its node id.
  #  (other) Node id matching this value will be the alarmNode.
  # Those values were chosen for backward compatibility with sites having an
  # alarmNode set to '' but expecting alarms to be executed. Use None to
  # disable alarm processing (see setAlarmNode).
93
  alarmNode = ''
Vincent Pelletier's avatar
Vincent Pelletier committed
94

Sebastien Robin's avatar
Sebastien Robin committed
95
  # API to manage alarms
Vincent Pelletier's avatar
Vincent Pelletier committed
96 97 98 99 100 101 102
  # Aim of this API:
  #-- see all alarms stored everywhere
  #-- defines global alarms
  #-- activate an alarm
  #-- see reports
  #-- see active alarms
  #-- retrieve all alarms
Sebastien Robin's avatar
Sebastien Robin committed
103 104

  security.declareProtected(Permissions.ModifyPortalContent, 'getAlarmList')
Vincent Pelletier's avatar
Vincent Pelletier committed
105
  def getAlarmList(self, to_active = 0):
Sebastien Robin's avatar
Sebastien Robin committed
106
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
107
      We retrieve thanks to the catalog the full list of alarms
Sebastien Robin's avatar
Sebastien Robin committed
108
    """
Sebastien Robin's avatar
Sebastien Robin committed
109
    if to_active:
110
      now = DateTime()
111 112
      catalog_search = self.portal_catalog.unrestrictedSearchResults(
        portal_type = self.getPortalAlarmTypeList(),
113
        alarm_date={'query':now,'range':'ngt'}
Vincent Pelletier's avatar
Vincent Pelletier committed
114
      )
115
      # check again the alarm date in case the alarm was not yet reindexed
116 117 118 119 120 121
      alarm_list = []
      for x in catalog_search:
        alarm = x.getObject()
        alarm_date = alarm.getAlarmDate()
        if alarm_date is not None and alarm_date <= now:
          alarm_list.append(alarm)
Sebastien Robin's avatar
Sebastien Robin committed
122
    else:
123
      catalog_search = self.portal_catalog.unrestrictedSearchResults(
Vincent Pelletier's avatar
Vincent Pelletier committed
124 125
        portal_type = self.getPortalAlarmTypeList()
      )
126
      alarm_list = [x.getObject() for x in catalog_search]
Sebastien Robin's avatar
Sebastien Robin committed
127 128 129 130 131
    return alarm_list

  security.declareProtected(Permissions.ModifyPortalContent, 'tic')
  def tic(self):
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
132 133
      We will look at all alarms and see if they should be activated,
      if so then we will activate them.
Sebastien Robin's avatar
Sebastien Robin committed
134
    """
135 136 137 138 139 140 141 142 143
    security_manager = getSecurityManager()
    try:
      for alarm in self.getAlarmList(to_active=1):
        if alarm is not None:
          user = alarm.getWrappedOwner()
          newSecurityManager(self.REQUEST, user)
          if alarm.isActive() or not alarm.isEnabled():
            # do nothing if already active, or not enabled
            continue
144
          if alarm.getProperty('automatic_solve'):
145 146 147
            alarm.solve()
          else:
            alarm.activeSense()
148 149
    finally:
      setSecurityManager(security_manager)
150

151
  security.declarePrivate('process_timer')
152
  def process_timer(self, interval, tick, prev="", next=""):
153
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
154 155 156
      Call tic() every x seconds. x is defined in self.interval
      This method is called by TimerService in the interval given
      in zope.conf. The Default is every 5 seconds.
157
    """
158
    if not last_tic_lock.acquire(0):
159 160
      return
    try:
161 162 163 164 165 166
      # make sure our skin is set-up. On CMF 1.5 it's setup by acquisition,
      # but on 2.2 it's by traversal, and our site probably wasn't traversed
      # by the timerserver request, which goes into the Zope Control_Panel
      # calling it a second time is a harmless and cheap no-op.
      # both setupCurrentSkin and REQUEST are acquired from containers.
      self.setupCurrentSkin(self.REQUEST)
167 168
      # only start when we are the alarmNode
      alarmNode = self.getAlarmNode()
169
      current_node = getCurrentNode()
170 171 172 173 174
      if alarmNode == '':
        self.setAlarmNode(current_node)
        alarmNode = current_node
      if alarmNode == current_node:
        global last_tic
175 176
        now = tick.timeTime()
        if now - last_tic >= self.interval:
177
          self.tic()
178
          last_tic = now
179 180 181 182 183 184
      elif _check_upgrade and self.getServerAddress() == alarmNode:
        # BBB: check (once per run) if our node was alarm_node by address, and
        # migrate it.
        global _check_upgrade
        _check_upgrade = False
        self.setAlarmNode(current_node)
185 186
    finally:
      last_tic_lock.release()
187 188 189 190 191 192

  security.declarePublic('getAlarmNode')
  def getAlarmNode(self):
      """ Return the alarmNode """
      return self.alarmNode

193
  security.declareProtected(Permissions.ManageProperties, 'setAlarmNode')
194 195 196 197 198 199 200 201 202 203 204
  def setAlarmNode(self, alarm_node):
    """
      When alarm_node evaluates to false, set a None value:
      Its meaning is that alarm processing is disabled.
      This avoids an empty string to make the system re-enter boostrap mode.
    """
    if alarm_node:
      self.alarmNode = alarm_node
    else:
      self.alarmNode = None

205 206 207 208
  security.declarePublic('getNodeList')
  def getNodeList(self):
    return self.getPortalObject().portal_activities.getNodeList()

209
  security.declareProtected(Permissions.ManageProperties, 'manage_setAlarmNode')
210
  def manage_setAlarmNode(self, alarmNode, REQUEST=None):
211
      """ set the alarm node """
212
      if not alarmNode or self._isValidNodeName(alarmNode):
213
        self.setAlarmNode(alarmNode)
214 215 216 217 218 219 220 221 222 223 224
        if REQUEST is not None:
            REQUEST.RESPONSE.redirect(
                REQUEST.URL1 +
                '/manageAlarmNode?manage_tabs_message=' +
                urllib.quote("Distributing Node successfully changed."))
      else :
        if REQUEST is not None:
            REQUEST.RESPONSE.redirect(
                REQUEST.URL1 +
                '/manageAlarmNode?manage_tabs_message=' +
                urllib.quote("Malformed Distributing Node."))
Sebastien Robin's avatar
Sebastien Robin committed
225