NetworkSetup: fix help onleft/right, fix reload
[enigma2.git] / RecordTimer.py
index 08ea85900c90e052502eed5418256694922ebf33..dde6c4ccb1a7dfb3f74dd5ac1ad8b2be2c25fdda 100644 (file)
@@ -1,5 +1,4 @@
 import time
-import codecs
 #from time import datetime
 from Tools import Directories, Notifications
 
@@ -7,11 +6,18 @@ from Components.config import config
 import timer
 import xml.dom.minidom
 
+from enigma import eEPGCache, getBestPlayableServiceReference, \
+       eServiceReference, iRecordableService, quitMainloop
+
 from Screens.MessageBox import MessageBox
-from Screens.SubserviceSelection import SubserviceSelection
+
 import NavigationInstance
 
-from Tools.XMLTools import elementsWithTag, mergeText
+import Screens.Standby
+
+from time import localtime
+
+from Tools.XMLTools import elementsWithTag, mergeText, stringToXML
 from ServiceReference import ServiceReference
 
 # ok, for descriptions etc we have:
@@ -23,20 +29,77 @@ from ServiceReference import ServiceReference
 
 # parses an event, and gives out a (begin, end, name, duration, eit)-tuple.
 # begin and end will be corrected
-def parseEvent(ev):
-       name = ev.getEventName()
-       description = ev.getShortDescription()
+def parseEvent(ev, description = True):
+       if description:
+               name = ev.getEventName()
+               description = ev.getShortDescription()
+       else:
+               name = ""
+               description = ""
        begin = ev.getBeginTime()
        end = begin + ev.getDuration()
        eit = ev.getEventId()
-       begin -= config.recording.margin_before.value[0] * 60
-       end += config.recording.margin_after.value[0] * 60
+       begin -= config.recording.margin_before.value * 60
+       end += config.recording.margin_after.value * 60
        return (begin, end, name, description, eit)
 
+class AFTEREVENT:
+       NONE = 0
+       STANDBY = 1
+       DEEPSTANDBY = 2
+
 # please do not translate log messages
-class RecordTimerEntry(timer.TimerEntry):
-       def __init__(self, serviceref, begin, end, name, description, eit, disabled = False):
+class RecordTimerEntry(timer.TimerEntry, object):
+######### the following static methods and members are only in use when the box is in (soft) standby
+       receiveRecordEvents = False
+
+       @staticmethod
+       def shutdown():
+               quitMainloop(1)
+
+       @staticmethod
+       def staticGotRecordEvent(recservice, event):
+               if event == iRecordableService.evEnd:
+                       print "RecordTimer.staticGotRecordEvent(iRecordableService.evEnd)"
+                       recordings = NavigationInstance.instance.getRecordings()
+                       if not len(recordings): # no more recordings exist
+                               rec_time = NavigationInstance.instance.RecordTimer.getNextRecordingTime()
+                               if rec_time > 0 and (rec_time - time.time()) < 360:
+                                       print "another recording starts in", rec_time - time.time(), "seconds... do not shutdown yet"
+                               else:
+                                       print "no starting records in the next 360 seconds... immediate shutdown"
+                                       RecordTimerEntry.shutdown() # immediate shutdown
+               elif event == iRecordableService.evStart:
+                       print "RecordTimer.staticGotRecordEvent(iRecordableService.evStart)"
+
+       @staticmethod
+       def stopTryQuitMainloop():
+               print "RecordTimer.stopTryQuitMainloop"
+               NavigationInstance.instance.record_event.remove(RecordTimerEntry.staticGotRecordEvent)
+               RecordTimerEntry.receiveRecordEvents = False
+
+       @staticmethod
+       def TryQuitMainloop():
+               if not RecordTimerEntry.receiveRecordEvents:
+                       print "RecordTimer.TryQuitMainloop"
+                       NavigationInstance.instance.record_event.append(RecordTimerEntry.staticGotRecordEvent)
+                       RecordTimerEntry.receiveRecordEvents = True
+                       # send fake event.. to check if another recordings are running or
+                       # other timers start in a few seconds
+                       RecordTimerEntry.staticGotRecordEvent(None, iRecordableService.evEnd)
+                       # send normal notification for the case the user leave the standby now..
+                       Notifications.AddNotification(Screens.Standby.TryQuitMainloop, 1, onSessionOpenCallback=RecordTimerEntry.stopTryQuitMainloop)
+#################################################################
+
+       def __init__(self, serviceref, begin, end, name, description, eit, disabled = False, justplay = False, afterEvent = AFTEREVENT.NONE, checkOldTimers = False, dirname = None):
                timer.TimerEntry.__init__(self, int(begin), int(end))
+
+               if checkOldTimers == True:
+                       if self.begin < time.time() - 1209600:
+                               self.begin = int(time.time())
+               
+               if self.end < self.begin:
+                       self.end = self.begin
                
                assert isinstance(serviceref, ServiceReference)
                
@@ -47,8 +110,11 @@ class RecordTimerEntry(timer.TimerEntry):
                self.description = description
                self.disabled = disabled
                self.timer = None
-               self.record_service = None
+               self.__record_service = None
                self.start_prepare = 0
+               self.justplay = justplay
+               self.afterEvent = afterEvent
+               self.dirname = dirname
                
                self.log_entries = []
                self.resetState()
@@ -56,12 +122,7 @@ class RecordTimerEntry(timer.TimerEntry):
        def log(self, code, msg):
                self.log_entries.append((int(time.time()), code, msg))
                print "[TIMER]", msg
-       
-       def resetState(self):
-               self.state = self.StateWaiting
-               self.first_try_prepare = True
-               self.timeChanged()
-       
+
        def calculateFilename(self):
                service_name = self.service_ref.getServiceName()
                begin_date = time.strftime("%Y%m%d %H%M", time.localtime(self.begin))
@@ -75,36 +136,62 @@ class RecordTimerEntry(timer.TimerEntry):
                if self.name:
                        filename += " - " + self.name
 
-               self.Filename = Directories.getRecordingFilename(filename)
+               self.Filename = Directories.getRecordingFilename(filename, self.dirname)
                self.log(0, "Filename calculated as: '%s'" % self.Filename)
                #begin_date + " - " + service_name + description)
-       
+
        def tryPrepare(self):
-               self.calculateFilename()
-               self.record_service = NavigationInstance.instance.recordService(self.service_ref)
-               if self.record_service == None:
-                       self.log(1, "'record service' failed")
-                       return False
+               if self.justplay:
+                       return True
                else:
-                       event_id = self.eit
-                       if event_id is None:
-                               event_id = -1
-                       prep_res = self.record_service.prepare(self.Filename + ".ts", self.begin, self.end, event_id )
+                       self.calculateFilename()
+                       rec_ref = self.service_ref and self.service_ref.ref
+                       if rec_ref and rec_ref.flags & eServiceReference.isGroup:
+                               rec_ref = getBestPlayableServiceReference(rec_ref, eServiceReference())
+                               if not rec_ref:
+                                       self.log(1, "'get best playable service for group... record' failed")
+                                       return False
+                               
+                       self.record_service = rec_ref and NavigationInstance.instance.recordService(rec_ref)
+
+                       if not self.record_service:
+                               self.log(1, "'record service' failed")
+                               return False
+
+                       if self.repeated:
+                               epgcache = eEPGCache.getInstance()
+                               queryTime=self.begin+(self.end-self.begin)/2
+                               evt = epgcache.lookupEventTime(rec_ref, queryTime)
+                               if evt:
+                                       self.description = evt.getShortDescription()
+                                       event_id = evt.getEventId()
+                               else:
+                                       event_id = -1
+                       else:
+                               event_id = self.eit
+                               if event_id is None:
+                                       event_id = -1
+
+                       prep_res=self.record_service.prepare(self.Filename + ".ts", self.begin, self.end, event_id)
                        if prep_res:
                                self.log(2, "'prepare' failed: error %d" % prep_res)
+                               NavigationInstance.instance.stopRecordService(self.record_service)
                                self.record_service = None
                                return False
 
                        self.log(3, "prepare ok, writing meta information to %s" % self.Filename)
                        try:
                                f = open(self.Filename + ".ts.meta", "w")
-                               f.write(str(self.service_ref) + "\n")
+                               f.write(rec_ref.toString() + "\n")
                                f.write(self.name + "\n")
                                f.write(self.description + "\n")
                                f.write(str(self.begin) + "\n")
                                f.close()
-                       except:
+                       except IOError:
                                self.log(4, "failed to write meta information")
+                               NavigationInstance.instance.stopRecordService(self.record_service)
+                               self.record_service = None
+                               return False
                        return True
 
        def do_backoff(self):
@@ -131,11 +218,12 @@ class RecordTimerEntry(timer.TimerEntry):
                        self.log(7, "prepare failed")
                        if self.first_try_prepare:
                                self.first_try_prepare = False
-                               if config.recording.asktozap.value == 0:
+                               if not config.recording.asktozap.value:
                                        self.log(8, "asking user to zap away")
-                                       Notifications.AddNotificationWithCallback(self.failureCB, MessageBox, _("A timer failed to record!\nDisable TV and try again?\n"))
+                                       Notifications.AddNotificationWithCallback(self.failureCB, MessageBox, _("A timer failed to record!\nDisable TV and try again?\n"), timeout=20)
                                else: # zap without asking
                                        self.log(9, "zap without asking")
+                                       Notifications.AddNotification(MessageBox, _("In order to record a timer, the TV was switched to the recording service!\n"), type=MessageBox.TYPE_INFO, timeout=20)
                                        self.failureCB(True)
 
                        self.do_backoff()
@@ -143,23 +231,57 @@ class RecordTimerEntry(timer.TimerEntry):
                        self.start_prepare = time.time() + self.backoff
                        return False
                elif next_state == self.StateRunning:
-                       self.log(11, "start recording")
-                       record_res = self.record_service.start()
-                       
-                       if record_res:
-                               self.log(13, "start record returned %d" % record_res)
-                               self.do_backoff()
-                               # retry
-                               self.begin = time.time() + self.backoff
-                               return False
-                       
-                       return True
+                       # if this timer has been cancelled, just go to "end" state.
+                       if self.cancelled:
+                               return True
+
+                       if self.justplay:
+                               if Screens.Standby.inStandby:
+                                       self.log(11, "wakeup and zap")
+                                       #set service to zap after standby
+                                       Screens.Standby.inStandby.prev_running_service = self.service_ref.ref
+                                       #wakeup standby
+                                       Screens.Standby.inStandby.Power()
+                               else:
+                                       self.log(11, "zapping")
+                                       NavigationInstance.instance.playService(self.service_ref.ref)
+                               return True
+                       else:
+                               self.log(11, "start recording")
+                               record_res = self.record_service.start()
+                               
+                               if record_res:
+                                       self.log(13, "start record returned %d" % record_res)
+                                       self.do_backoff()
+                                       # retry
+                                       self.begin = time.time() + self.backoff
+                                       return False
+
+                               return True
                elif next_state == self.StateEnded:
                        self.log(12, "stop recording")
-                       self.record_service.stop()
-                       self.record_service = None
+                       if not self.justplay:
+                               NavigationInstance.instance.stopRecordService(self.record_service)
+                               self.record_service = None
+                       if self.afterEvent == AFTEREVENT.STANDBY:
+                               if not Screens.Standby.inStandby: # not already in standby
+                                       Notifications.AddNotificationWithCallback(self.sendStandbyNotification, MessageBox, _("A finished record timer wants to set your\nDreambox to standby. Do that now?"), timeout = 20)
+                       if self.afterEvent == AFTEREVENT.DEEPSTANDBY:
+                               if not Screens.Standby.inTryQuitMainloop: # not a shutdown messagebox is open
+                                       if Screens.Standby.inStandby: # not in standby
+                                               RecordTimerEntry.TryQuitMainloop() # start shutdown handling without screen
+                                       else:
+                                               Notifications.AddNotificationWithCallback(self.sendTryQuitMainloopNotification, MessageBox, _("A finished record timer wants to shut down\nyour Dreambox. Shutdown now?"), timeout = 20)
                        return True
 
+       def sendStandbyNotification(self, answer):
+               if answer:
+                       Notifications.AddNotification(Screens.Standby.Standby)
+
+       def sendTryQuitMainloopNotification(self, answer):
+               if answer:
+                       Notifications.AddNotification(Screens.Standby.TryQuitMainloop, 1)
+
        def getNextActivation(self):
                if self.state == self.StateEnded:
                        return self.end
@@ -183,24 +305,64 @@ class RecordTimerEntry(timer.TimerEntry):
                self.start_prepare = self.begin - self.prepare_time
                self.backoff = 0
                
-               if old_prepare != self.start_prepare:
+               if int(old_prepare) != int(self.start_prepare):
                        self.log(15, "record time changed, start prepare is now: %s" % time.ctime(self.start_prepare))
 
+       def gotRecordEvent(self, record, event):
+               # TODO: this is not working (never true), please fix. (comparing two swig wrapped ePtrs)
+               if self.__record_service.__deref__() != record.__deref__():
+                       return
+               self.log(16, "record event %d" % event)
+               if event == iRecordableService.evRecordWriteError:
+                       print "WRITE ERROR on recording, disk full?"
+                       # show notification. the 'id' will make sure that it will be
+                       # displayed only once, even if more timers are failing at the
+                       # same time. (which is very likely in case of disk fullness)
+                       Notifications.AddPopup(text = _("Write error while recording. Disk full?\n"), type = MessageBox.TYPE_ERROR, timeout = 0, id = "DiskFullMessage")
+                       # ok, the recording has been stopped. we need to properly note 
+                       # that in our state, with also keeping the possibility to re-try.
+                       # TODO: this has to be done.
+               elif event == iRecordableService.evStart:
+                       # maybe this should be configurable?
+                       Notifications.AddPopup(text = _("A record has been started:\n%s") % self.name, type = MessageBox.TYPE_INFO, timeout = 3)
+
+       # we have record_service as property to automatically subscribe to record service events
+       def setRecordService(self, service):
+               if self.__record_service is not None:
+                       print "[remove callback]"
+                       NavigationInstance.instance.record_event.remove(self.gotRecordEvent)
+
+               self.__record_service = service
+
+               if self.__record_service is not None:
+                       print "[add callback]"
+                       NavigationInstance.instance.record_event.append(self.gotRecordEvent)
+
+       record_service = property(lambda self: self.__record_service, setRecordService)
+
 def createTimer(xml):
        begin = int(xml.getAttribute("begin"))
        end = int(xml.getAttribute("end"))
-       serviceref = ServiceReference(str(xml.getAttribute("serviceref")))
+       serviceref = ServiceReference(xml.getAttribute("serviceref").encode("utf-8"))
        description = xml.getAttribute("description").encode("utf-8")
        repeated = xml.getAttribute("repeated").encode("utf-8")
        disabled = long(xml.getAttribute("disabled") or "0")
+       justplay = long(xml.getAttribute("justplay") or "0")
+       afterevent = str(xml.getAttribute("afterevent") or "nothing")
+       afterevent = { "nothing": AFTEREVENT.NONE, "standby": AFTEREVENT.STANDBY, "deepstandby": AFTEREVENT.DEEPSTANDBY }[afterevent]
        if xml.hasAttribute("eit") and xml.getAttribute("eit") != "None":
                eit = long(xml.getAttribute("eit"))
        else:
                eit = None
-       
+       if xml.hasAttribute("location") and xml.getAttribute("location") != "None":
+               location = str(xml.getAttribute("location")).encode("utf-8")
+       else:
+               location = None
+
+
        name = xml.getAttribute("name").encode("utf-8")
        #filename = xml.getAttribute("filename").encode("utf-8")
-       entry = RecordTimerEntry(serviceref, begin, end, name, description, eit, disabled)
+       entry = RecordTimerEntry(serviceref, begin, end, name, description, eit, disabled, justplay, afterevent, dirname = location)
        entry.repeated = int(repeated)
        
        for l in elementsWithTag(xml.childNodes, "log"):
@@ -225,21 +387,32 @@ class RecordTimer(timer.Timer):
        def isRecording(self):
                isRunning = False
                for timer in self.timer_list:
-                       if timer.isRunning():
+                       if timer.isRunning() and not timer.justplay:
                                isRunning = True
                return isRunning
        
        def loadTimer(self):
                # TODO: PATH!
-               doc = xml.dom.minidom.parse(self.Filename)
-               
+               try:
+                       doc = xml.dom.minidom.parse(self.Filename)
+               except xml.parsers.expat.ExpatError:
+                       from Tools.Notifications import AddPopup
+                       from Screens.MessageBox import MessageBox
+
+                       AddPopup(_("The timer file (timers.xml) is corrupt and could not be loaded."), type = MessageBox.TYPE_ERROR, timeout = 0, id = "TimerLoadFailed")
+
+                       print "timers.xml failed to load!"
+                       try:
+                               import os
+                               os.rename(self.Filename, self.Filename + "_old")
+                       except IOError:
+                               print "renaming broken timer failed"
+                       return
+
                root = doc.childNodes[0]
                for timer in elementsWithTag(root.childNodes, "timer"):
                        self.record(createTimer(timer))
 
-       def strToXML(self, str):
-               return str.replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;').replace("'", '&apos;'). replace('"', '&qout;')
-
        def saveTimer(self):
                #doc = xml.dom.minidom.Document()
                #root_element = doc.createElement('timers')
@@ -293,23 +466,27 @@ class RecordTimer(timer.Timer):
                        list.append('<timer')
                        list.append(' begin="' + str(int(timer.begin)) + '"')
                        list.append(' end="' + str(int(timer.end)) + '"')
-                       list.append(' serviceref="' + str(timer.service_ref) + '"')
+                       list.append(' serviceref="' + stringToXML(str(timer.service_ref)) + '"')
                        list.append(' repeated="' + str(int(timer.repeated)) + '"')
-                       list.append(' name="' + str(self.strToXML(timer.name)) + '"')
-                       list.append(' description="' + str(self.strToXML(timer.description)) + '"')
+                       list.append(' name="' + str(stringToXML(timer.name)) + '"')
+                       list.append(' description="' + str(stringToXML(timer.description)) + '"')
+                       list.append(' afterevent="' + str(stringToXML({ AFTEREVENT.NONE: "nothing", AFTEREVENT.STANDBY: "standby", AFTEREVENT.DEEPSTANDBY: "deepstandby" }[timer.afterEvent])) + '"')
                        if timer.eit is not None:
                                list.append(' eit="' + str(timer.eit) + '"')
+                       if timer.dirname is not None:
+                               list.append(' location="' + str(stringToXML(timer.dirname)) + '"')
                        list.append(' disabled="' + str(int(timer.disabled)) + '"')
+                       list.append(' justplay="' + str(int(timer.justplay)) + '"')
                        list.append('>\n')
                        
-                       for time, code, msg in timer.log_entries:
-                               list.append('<log')
-                               list.append(' code="' + str(code) + '"')
-                               list.append(' time="' + str(time) + '"')
-                               list.append('>')
-                               list.append(str(msg))
-                               list.append('</log>\n')
-
+                       if config.recording.debug.value:
+                               for time, code, msg in timer.log_entries:
+                                       list.append('<log')
+                                       list.append(' code="' + str(code) + '"')
+                                       list.append(' time="' + str(time) + '"')
+                                       list.append('>')
+                                       list.append(str(stringToXML(msg)))
+                                       list.append('</log>\n')
                        
                        list.append('</timer>\n')
 
@@ -320,11 +497,90 @@ class RecordTimer(timer.Timer):
                        file.write(x)
                file.close()
 
+       def getNextZapTime(self):
+               now = time.time()
+               for timer in self.timer_list:
+                       if not timer.justplay or timer.begin < now:
+                               continue
+                       return timer.begin
+               return -1
+
+       def getNextRecordingTime(self):
+               now = time.time()
+               for timer in self.timer_list:
+                       if timer.justplay or timer.begin < now:
+                               continue
+                       return timer.begin
+               return -1
+
        def record(self, entry):
                entry.timeChanged()
                print "[Timer] Record " + str(entry)
                entry.Timer = self
                self.addTimerEntry(entry)
+               self.saveTimer()
+               
+       def isInTimer(self, eventid, begin, duration, service):
+               time_match = 0
+               chktime = None
+               chktimecmp = None
+               chktimecmp_end = None
+               end = begin + duration
+               for x in self.timer_list:
+                       check = x.service_ref.ref.toCompareString() == str(service)
+                       if not check:
+                               sref = x.service_ref.ref
+                               parent_sid = sref.getUnsignedData(5)
+                               parent_tsid = sref.getUnsignedData(6)
+                               if parent_sid and parent_tsid: # check for subservice
+                                       sid = sref.getUnsignedData(1)
+                                       tsid = sref.getUnsignedData(2)
+                                       sref.setUnsignedData(1, parent_sid)
+                                       sref.setUnsignedData(2, parent_tsid)
+                                       sref.setUnsignedData(5, 0)
+                                       sref.setUnsignedData(6, 0)
+                                       check = x.service_ref.ref.toCompareString() == str(service)
+                                       num = 0
+                                       if check:
+                                               check = False
+                                               event = eEPGCache.getInstance().lookupEventId(sref, eventid)
+                                               num = event and event.getNumOfLinkageServices() or 0
+                                       sref.setUnsignedData(1, sid)
+                                       sref.setUnsignedData(2, tsid)
+                                       sref.setUnsignedData(5, parent_sid)
+                                       sref.setUnsignedData(6, parent_tsid)
+                                       for cnt in range(num):
+                                               subservice = event.getLinkageService(sref, cnt)
+                                               if sref.toCompareString() == subservice.toCompareString():
+                                                       check = True
+                                                       break
+                       if check:
+                               #if x.eit is not None and x.repeated == 0:
+                               #       if x.eit == eventid:
+                               #               return duration
+                               if x.repeated != 0:
+                                       if chktime is None:
+                                               chktime = localtime(begin)
+                                               chktimecmp = chktime.tm_wday * 1440 + chktime.tm_hour * 60 + chktime.tm_min
+                                               chktimecmp_end = chktimecmp + (duration / 60)
+                                       time = localtime(x.begin)
+                                       for y in range(7):
+                                               if x.repeated & (2 ** y):
+                                                       timecmp = y * 1440 + time.tm_hour * 60 + time.tm_min
+                                                       if timecmp <= chktimecmp < (timecmp + ((x.end - x.begin) / 60)):
+                                                               time_match = ((timecmp + ((x.end - x.begin) / 60)) - chktimecmp) * 60
+                                                       elif chktimecmp <= timecmp < chktimecmp_end:
+                                                               time_match = (chktimecmp_end - timecmp) * 60
+                               else: #if x.eit is None:
+                                       if begin <= x.begin <= end:
+                                               diff = end - x.begin
+                                               if time_match < diff:
+                                                       time_match = diff
+                                       elif x.begin <= begin <= x.end:
+                                               diff = x.end - begin
+                                               if time_match < diff:
+                                                       time_match = diff
+               return time_match
 
        def removeEntry(self, entry):
                print "[Timer] Remove " + str(entry)
@@ -344,6 +600,7 @@ class RecordTimer(timer.Timer):
                print "in running: ", entry in self.timer_list
                # now the timer should be in the processed_timers list. remove it from there.
                self.processed_timers.remove(entry)
+               self.saveTimer()
 
        def shutdown(self):
                self.saveTimer()