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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
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
##############################################################################
#
# 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.
#
##############################################################################
import time
import threading
from AccessControl import ClassSecurityInfo
from AccessControl.SecurityManagement import newSecurityManager
from Globals import InitializeClass, DTMLFile, PersistentMapping
from Products.ERP5Type.Document.Folder import Folder
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from Products.ERP5 import _dtmldir
from DateTime import DateTime
from zLOG import LOG, INFO
try:
from Products.TimerService import getTimerService
except ImportError:
def getTimerService(self):
pass
last_tic = time.time()
last_tic_lock = threading.Lock()
class AlarmTool(BaseTool):
"""
This tool manages alarms.
It is used as a central managment point for all alarms.
Inside this tool we have a way to retrieve all reports comings
from Alarms,...
"""
id = 'portal_alarms'
meta_type = 'ERP5 Alarm Tool'
portal_type = 'Alarm Tool'
# Declarative Security
security = ClassSecurityInfo()
security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
manage_overview = DTMLFile( 'explainAlarmTool', _dtmldir )
security.declareProtected( Permissions.ManagePortal , 'manageAlarmList' )
manageAlarmList = DTMLFile( 'manageAlarmList', _dtmldir )
security.declareProtected( Permissions.ManagePortal , 'manageAlarmAdvanced' )
manageAlarmAdvanced = DTMLFile( 'manageAlarmAdvanced', _dtmldir )
manage_options = ( ( { 'label' : 'Overview'
, 'action' : 'manage_overview'
}
, { 'label' : 'All Alarms'
, 'action' : 'manageAlarmList'
}
, { 'label' : 'Advanced'
, 'action' : 'manageAlarmAdvanced'
}
,
)
+ Folder.manage_options
)
_properties = ( {'id': 'interval', 'type': 'int', 'mode': 'w', }, )
interval = 60 # Default interval for alarms is 60 seconds
# API to manage alarms
# Aim of this API:
#-- see all alarms stored everywhere
#-- defines global alarms
#-- activate an alarm
#-- see reports
#-- see active alarms
#-- retrieve all alarms
security.declareProtected(Permissions.ModifyPortalContent, 'getAlarmList')
def getAlarmList(self, to_active = 0):
"""
We retrieve thanks to the catalog the full list of alarms
"""
user = self.portal_catalog.getOwner()
newSecurityManager(self.REQUEST, user)
if to_active:
now = DateTime()
catalog_search = self.portal_catalog(
portal_type = self.getPortalAlarmTypeList(),
alarm_date={'query':now,'range':'ngt'}
)
# check again the alarm date in case the alarm was not yet reindexed
alarm_list = [x.getObject() for x in catalog_search \
if x.getObject().getAlarmDate()<=now]
else:
catalog_search = self.portal_catalog(
portal_type = self.getPortalAlarmTypeList()
)
alarm_list = [x.getObject() for x in catalog_search]
return alarm_list
security.declareProtected(Permissions.ModifyPortalContent, 'tic')
def tic(self):
"""
We will look at all alarms and see if they should be activated,
if so then we will activate them.
"""
current_date = DateTime()
for alarm in self.getAlarmList(to_active=1):
if alarm:
user = alarm.getOwner()
newSecurityManager(self.REQUEST, user)
if alarm.isActive() or not alarm.isEnabled():
# do nothing if already active, or not enabled
continue
alarm.activate().activeSense()
security.declareProtected(Permissions.ManageProperties, 'isSubscribed')
def isSubscribed(self):
"""
return True, if we are subscribed to TimerService.
Otherwise return False.
"""
service = getTimerService(self)
if not service:
LOG('AlarmTool', INFO, 'TimerService not available')
return False
path = '/'.join(self.getPhysicalPath())
if path in service.lisSubscriptions():
return True
return False
security.declareProtected(Permissions.ManageProperties, 'subscribe')
def subscribe(self):
"""
Subscribe to the global Timer Service.
"""
service = getTimerService(self)
if not service:
LOG('AlarmTool', INFO, 'TimerService not available')
return
service.subscribe(self)
return "Subscribed to Timer Service"
security.declareProtected(Permissions.ManageProperties, 'unsubscribe')
def unsubscribe(self):
"""
Unsubscribe from the global Timer Service.
"""
service = getTimerService(self)
if not service:
LOG('AlarmTool', INFO, 'TimerService not available')
return
service.unsubscribe(self)
return "Usubscribed from Timer Service"
def manage_beforeDelete(self, item, container):
self.unsubscribe()
BaseTool.inheritedAttribute('manage_beforeDelete')(self, item, container)
def manage_afterAdd(self, item, container):
self.subscribe()
BaseTool.inheritedAttribute('manage_afterAdd')(self, item, container)
security.declarePrivate('process_timer')
def process_timer(self, interval, tick, prev="", next=""):
"""
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.
"""
global last_tic
last_tic_lock.acquire(1)
try:
if tick.timeTime() - last_tic >= self.interval:
self.tic()
last_tic = tick.timeTime()
finally:
last_tic_lock.release()