add new after record timer event behavior "auto".. and use it as default
[enigma2.git] / RecordTimer.py
index 87aa197cfff32de1d5828b01652a2bdf301ed0d3..cac475d6ddda5682517e9875ace039110d79800c 100644 (file)
@@ -1,5 +1,4 @@
 import time
-import codecs
 #from time import datetime
 from Tools import Directories, Notifications
 
@@ -7,10 +6,15 @@ from Components.config import config
 import timer
 import xml.dom.minidom
 
-from enigma import quitMainloop
+from enigma import eEPGCache, getBestPlayableServiceReference, \
+       eServiceReference, iRecordableService, quitMainloop
 
 from Screens.MessageBox import MessageBox
+from Components.TimerSanityCheck import TimerSanityCheck
 import NavigationInstance
+
+import Screens.Standby
+
 from time import localtime
 
 from Tools.XMLTools import elementsWithTag, mergeText, stringToXML
@@ -25,25 +29,78 @@ 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
+       AUTO = 3
 
 # please do not translate log messages
-class RecordTimerEntry(timer.TimerEntry):
-       def __init__(self, serviceref, begin, end, name, description, eit, disabled = False, justplay = False, afterEvent = AFTEREVENT.NONE):
+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(default_yes = True):
+               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, default_yes = default_yes)
+#################################################################
+
+       def __init__(self, serviceref, begin, end, name, description, eit, disabled = False, justplay = False, afterEvent = AFTEREVENT.AUTO, checkOldTimers = False, dirname = None, tags = 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)
                
@@ -54,25 +111,22 @@ 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.session = None
-               
+               self.dirname = dirname
+               self.dirnameHadToFallback = False
+               self.autoincrease = False
+               self.tags = tags or []
+
                self.log_entries = []
                self.resetState()
        
        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.cancelled = False
-               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))
@@ -86,40 +140,68 @@ class RecordTimerEntry(timer.TimerEntry):
                if self.name:
                        filename += " - " + self.name
 
-               self.Filename = Directories.getRecordingFilename(filename)
+               if self.dirname and not Directories.pathExists(self.dirname):
+                       self.dirnameHadToFallback = True
+                       self.Filename = Directories.getRecordingFilename(filename, None)
+               else:
+                       self.Filename = Directories.getRecordingFilename(filename, self.dirname)
                self.log(0, "Filename calculated as: '%s'" % self.Filename)
                #begin_date + " - " + service_name + description)
-       
+
        def tryPrepare(self):
                if self.justplay:
                        return True
                else:
                        self.calculateFilename()
-                       self.record_service = NavigationInstance.instance.recordService(self.service_ref)
-                       if self.record_service == None:
+                       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)
-                                       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(self.name + "\n")
-                                       f.write(self.description + "\n")
-                                       f.write(str(self.begin) + "\n")
-                                       f.close()
-                               except IOError:
-                                       self.log(4, "failed to write meta information")
-                               return True
+
+                       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(rec_ref.toString() + "\n")
+                               f.write(self.name + "\n")
+                               f.write(self.description + "\n")
+                               f.write(str(self.begin) + "\n")
+                               f.write(' '.join(self.tags))
+                               f.close()
+                       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):
                if self.backoff == 0:
@@ -145,11 +227,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()
@@ -162,8 +245,15 @@ class RecordTimerEntry(timer.TimerEntry):
                                return True
 
                        if self.justplay:
-                               self.log(11, "zapping")
-                               NavigationInstance.instance.playService(self.service_ref.ref)
+                               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")
@@ -175,20 +265,32 @@ class RecordTimerEntry(timer.TimerEntry):
                                        # retry
                                        self.begin = time.time() + self.backoff
                                        return False
-                               
+
                                return True
                elif next_state == self.StateEnded:
                        self.log(12, "stop recording")
                        if not self.justplay:
-                               self.record_service.stop()
+                               NavigationInstance.instance.stopRecordService(self.record_service)
                                self.record_service = None
                        if self.afterEvent == AFTEREVENT.STANDBY:
-                               if self.session is not None:
-                                       self.session.open(Standby, self)
+                               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)
                        elif self.afterEvent == AFTEREVENT.DEEPSTANDBY:
-                               quitMainloop(1)
+                               if not Screens.Standby.inTryQuitMainloop: # not a shutdown messagebox is open
+                                       if Screens.Standby.inStandby: # 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
@@ -212,27 +314,76 @@ 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:
+                       text = _("A record has been started:\n%s") % self.name
+                       if self.dirnameHadToFallback:
+                               text = '\n'.join([text, _("Please note that the previously selected media could not be accessed and therefore the default directory is being used instead.")])
+
+                       # maybe this should be configurable?
+                       Notifications.AddPopup(text = text, 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]
+       afterevent = {
+               "nothing": AFTEREVENT.NONE,
+               "standby": AFTEREVENT.STANDBY,
+               "deepstandby": AFTEREVENT.DEEPSTANDBY,
+               "auto": AFTEREVENT.AUTO
+               }[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 = xml.getAttribute("location").encode("utf-8")
+       else:
+               location = None
+       if xml.hasAttribute("tags") and xml.getAttribute("tags"):
+               tags = xml.getAttribute("tags").encode("utf-8").split(' ')
+       else:
+               tags = None
+
        name = xml.getAttribute("name").encode("utf-8")
        #filename = xml.getAttribute("filename").encode("utf-8")
-       entry = RecordTimerEntry(serviceref, begin, end, name, description, eit, disabled, justplay, afterevent)
+       entry = RecordTimerEntry(serviceref, begin, end, name, description, eit, disabled, justplay, afterevent, dirname = location, tags = tags)
        entry.repeated = int(repeated)
        
        for l in elementsWithTag(xml.childNodes, "log"):
@@ -263,11 +414,33 @@ class RecordTimer(timer.Timer):
        
        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]
+
+               # put out a message when at least one timer overlaps
+               checkit = True
                for timer in elementsWithTag(root.childNodes, "timer"):
-                       self.record(createTimer(timer))
+                       newTimer = createTimer(timer)
+                       if (self.record(newTimer, True, True) is not None) and (checkit == True):
+                               from Tools.Notifications import AddPopup
+                               from Screens.MessageBox import MessageBox
+                               AddPopup(_("Timer overlap in timers.xml detected!\nPlease recheck it!"), type = MessageBox.TYPE_ERROR, timeout = 0, id = "TimerLoadFailed")
+                               checkit = False # at moment it is enough when the message is displayed one time
 
        def saveTimer(self):
                #doc = xml.dom.minidom.Document()
@@ -322,25 +495,34 @@ 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(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])) + '"')
+                       list.append(' afterevent="' + str(stringToXML({
+                               AFTEREVENT.NONE: "nothing",
+                               AFTEREVENT.STANDBY: "standby",
+                               AFTEREVENT.DEEPSTANDBY: "deepstandby",
+                               AFTEREVENT.AUTO: "auto"
+                               }[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)) + '"')
+                       if timer.tags is not None:
+                               list.append(' tags="' + str(stringToXML(' '.join(timer.tags))) + '"')
                        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')
 
@@ -351,11 +533,52 @@ class RecordTimer(timer.Timer):
                        file.write(x)
                file.close()
 
-       def record(self, entry):
+       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 isNextRecordAfterEventActionAuto(self):
+               now = time.time()
+               t = None
+               for timer in self.timer_list:
+                       if timer.justplay or timer.begin < now:
+                               continue
+                       if t is None or t.begin == timer.begin:
+                               t = timer
+                               if t.afterEvent == AFTEREVENT.AUTO:
+                                       return True
+               return False
+
+       def record(self, entry, ignoreTSC=False, dosave=True):          #wird von loadTimer mit dosave=False aufgerufen
+               timersanitycheck = TimerSanityCheck(self.timer_list,entry)
+               if not timersanitycheck.check():
+                       if ignoreTSC != True:
+                               print "timer conflict detected!"
+                               print timersanitycheck.getSimulTimerList()
+                               return timersanitycheck.getSimulTimerList()
+                       else:
+                               print "ignore timer conflict"
+               elif timersanitycheck.doubleCheck():
+                       print "ignore double timer"
                entry.timeChanged()
                print "[Timer] Record " + str(entry)
                entry.Timer = self
                self.addTimerEntry(entry)
+               if dosave:
+                       self.saveTimer()
+               return None
                
        def isInTimer(self, eventid, begin, duration, service):
                time_match = 0
@@ -364,7 +587,34 @@ class RecordTimer(timer.Timer):
                chktimecmp_end = None
                end = begin + duration
                for x in self.timer_list:
-                       if str(x.service_ref) == str(service):
+                       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
@@ -410,6 +660,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()