add ability to stop currently running repeated timer when disabling it
[enigma2.git] / timer.py
1 from bisect import insort
2 from time import strftime, time, localtime, gmtime, mktime
3 from calendar import timegm
4 from enigma import eTimer
5
6 class TimerEntry:
7         StateWaiting  = 0
8         StatePrepared = 1
9         StateRunning  = 2
10         StateEnded    = 3
11         
12         def __init__(self, begin, end):
13                 self.begin = begin
14                 self.prepare_time = 20
15                 self.end = end
16                 self.state = 0
17                 self.resetRepeated()
18                 self.backoff = 0
19                 
20                 self.disabled = False
21                 
22         def resetRepeated(self):
23                 self.repeated = int(0)
24
25         def setRepeated(self, day):
26                 self.repeated |= (2 ** day)
27                 print "Repeated: " + str(self.repeated)
28                 
29         def isRunning(self):
30                 return self.state == self.StateRunning
31                 
32         # update self.begin and self.end according to the self.repeated-flags
33         def processRepeated(self, findRunningEvent = True):
34                 print "ProcessRepeated"
35                 if (self.repeated != 0):
36                         now = int(time()) + 1
37
38                         #to avoid problems with daylight saving, we need to calculate with localtime, in struct_time representation
39                         localbegin = localtime(self.begin)
40                         localend = localtime(self.end)
41                         localnow = localtime(now)
42
43                         print strftime("%c", localbegin)
44                         print strftime("%c", localend)
45
46                         day = []
47                         flags = self.repeated
48                         for x in range(0, 7):
49                                 if (flags & 1 == 1):
50                                         day.append(0)
51                                         print "Day: " + str(x)
52                                 else:
53                                         day.append(1)
54                                 flags = flags >> 1
55
56                         print strftime("%c", localnow)
57
58                         while ((day[localbegin.tm_wday] != 0) or ((day[localbegin.tm_wday] == 0) and ((findRunningEvent and localend < localnow) or ((not findRunningEvent) and localbegin < localnow)))):
59                                 print "localbegin:", strftime("%c", localbegin)
60                                 print "localend:", strftime("%c", localend)
61                                 #add one day to the struct_time, we have to convert using gmt functions, because the daylight saving flag might change after we add our 86400 seconds
62                                 localbegin = gmtime(timegm(localbegin) + 86400)
63                                 localend = gmtime(timegm(localend) + 86400)
64
65                         #we now have a struct_time representation of begin and end in localtime, but we have to calculate back to (gmt) seconds since epoch
66                         self.begin = int(mktime(localbegin))
67                         self.end = int(mktime(localend)) + 1
68
69                         print "ProcessRepeated result"
70                         print strftime("%c", localtime(self.begin))
71                         print strftime("%c", localtime(self.end))
72
73                         self.timeChanged()
74
75         def __lt__(self, o):
76                 return self.getNextActivation() < o.getNextActivation()
77         
78         # must be overridden
79         def activate(self):
80                 pass
81                 
82         # can be overridden
83         def timeChanged(self):
84                 pass
85
86         # check if a timer entry must be skipped
87         def shouldSkip(self):
88                 return self.end <= time() and self.state == TimerEntry.StateWaiting
89
90         def abort(self):
91                 self.end = time()
92                 
93                 # in case timer has not yet started, but gets aborted (so it's preparing),
94                 # set begin to now.
95                 if self.begin > self.end:
96                         self.begin = self.end
97
98                 self.cancelled = True
99         
100         # must be overridden!
101         def getNextActivation():
102                 pass
103
104         def disable(self):
105                 self.disabled = True
106         
107         def enable(self):
108                 self.disabled = False
109
110 class Timer:
111         # the time between "polls". We do this because
112         # we want to account for time jumps etc.
113         # of course if they occur <100s before starting,
114         # it's not good. thus, you have to repoll when
115         # you change the time.
116         #
117         # this is just in case. We don't want the timer 
118         # hanging. we use this "edge-triggered-polling-scheme"
119         # anyway, so why don't make it a bit more fool-proof?
120         MaxWaitTime = 100
121
122         def __init__(self):
123                 self.timer_list = [ ]
124                 self.processed_timers = [ ]
125                 
126                 self.timer = eTimer()
127                 self.timer.timeout.get().append(self.calcNextActivation)
128                 self.lastActivation = time()
129                 
130                 self.calcNextActivation()
131                 self.on_state_change = [ ]
132         
133         def stateChanged(self, entry):
134                 for f in self.on_state_change:
135                         f(entry)
136                         
137         def getNextRecordingTime(self):
138                 if len(self.timer_list) > 0:
139                         return self.timer_list[0].begin
140                 return -1
141                         
142         def cleanup(self):
143                 self.processed_timers = [entry for entry in self.processed_timers if entry.disabled]
144         
145         def addTimerEntry(self, entry, noRecalc=0):
146                 entry.processRepeated()
147
148                 # when the timer has not yet started, and is already passed,
149                 # don't go trough waiting/running/end-states, but sort it
150                 # right into the processedTimers.
151                 if entry.shouldSkip() or entry.state == TimerEntry.StateEnded or (entry.state == TimerEntry.StateWaiting and entry.disabled):
152                         print "already passed, skipping"
153                         print "shouldSkip:", entry.shouldSkip()
154                         print "state == ended", entry.state == TimerEntry.StateEnded
155                         print "waiting && disabled:", (entry.state == TimerEntry.StateWaiting and entry.disabled)
156                         insort(self.processed_timers, entry)
157                         entry.state = TimerEntry.StateEnded
158                 else:
159                         insort(self.timer_list, entry)
160                         if not noRecalc:
161                                 self.calcNextActivation()
162         
163         def setNextActivation(self, when):
164                 delay = int((when - time()) * 1000)
165                 print "[timer.py] next activation: %d (in %d ms)" % (when, delay)
166                 
167                 self.timer.start(delay, 1)
168                 self.next = when
169
170         def calcNextActivation(self):
171                 if self.lastActivation > time():
172                         print "[timer.py] timewarp - re-evaluating all processed timers."
173                         tl = self.processed_timers
174                         self.processed_timers = [ ]
175                         for x in tl:
176                                 # simulate a "waiting" state to give them a chance to re-occure
177                                 x.resetState()
178                                 self.addTimerEntry(x, noRecalc=1)
179                 
180                 self.processActivation()
181                 self.lastActivation = time()
182         
183                 min = int(time()) + self.MaxWaitTime
184                 
185                 # calculate next activation point
186                 if len(self.timer_list):
187                         w = self.timer_list[0].getNextActivation()
188                         if w < min:
189                                 min = w
190                 
191                 self.setNextActivation(min)
192         
193         def timeChanged(self, timer):
194                 print "time changed"
195                 timer.timeChanged()
196                 if timer.state == TimerEntry.StateEnded:
197                         self.processed_timers.remove(timer)
198                 else:
199                         self.timer_list.remove(timer)
200
201                 # give the timer a chance to re-enqueue
202                 if timer.state == TimerEntry.StateEnded:
203                         timer.state = TimerEntry.StateWaiting
204                 self.addTimerEntry(timer)
205         
206         def doActivate(self, w):
207                 self.timer_list.remove(w)
208                 
209                 # when activating a timer which has already passed,
210                 # simply abort the timer. don't run trough all the stages.
211                 if w.shouldSkip():
212                         w.state = TimerEntry.StateEnded
213                 else:
214                         # when active returns true, this means "accepted".
215                         # otherwise, the current state is kept.
216                         # the timer entry itself will fix up the delay then.
217                         if w.activate():
218                                 w.state += 1
219
220                 # did this timer reached the last state?
221                 if w.state < TimerEntry.StateEnded:
222                         # no, sort it into active list
223                         insort(self.timer_list, w)
224                 else:
225                         # yes. Process repeated, and re-add.
226                         if w.repeated:
227                                 w.processRepeated()
228                                 w.state = TimerEntry.StateWaiting
229                                 self.addTimerEntry(w)
230                         else:
231                                 insort(self.processed_timers, w)
232                 
233                 self.stateChanged(w)
234
235         def processActivation(self):
236                 print "It's now ", strftime("%c", localtime(time()))
237                 t = int(time()) + 1
238                 
239                 # we keep on processing the first entry until it goes into the future.
240                 while len(self.timer_list) and self.timer_list[0].getNextActivation() < t:
241                         self.doActivate(self.timer_list[0])