SystemPlugins/CrashlogAutoSubmit/plugin.py: - don't start crashlogmailer on firstrun.
[enigma2.git] / lib / python / Plugins / SystemPlugins / CrashlogAutoSubmit / plugin.py
index aa63222274b953cb7b284240c56bbc665900b914..e58f19a01388b4078837f758200702b7ec82c328 100755 (executable)
@@ -1,10 +1,15 @@
 from Plugins.Plugin import PluginDescriptor
-from Components.config import config, getConfigListEntry, ConfigSubsection, ConfigText, ConfigSelection
+from Components.config import config, getConfigListEntry, ConfigSubsection, ConfigText, ConfigSelection, ConfigYesNo,ConfigText
 from Components.ConfigList import ConfigListScreen
 from Components.ActionMap import ActionMap
 from Components.Label import Label
-from Screens.ChoiceBox import ChoiceBox
+from Components.Pixmap import Pixmap
 from Screens.Screen import Screen
+from Screens.VirtualKeyBoard import VirtualKeyBoard
+from Screens.ChoiceBox import ChoiceBox
+from Screens.MessageBox import MessageBox
+from enigma import ePoint
+
 import os
 from twisted.mail import smtp, relaymanager
 
@@ -13,16 +18,27 @@ config.plugins.crashlogautosubmit.sendmail = ConfigSelection(default = "send", c
        ("send", _("Always ask before sending")), ("send_always", _("Don't ask, just send")), ("send_never", _("Disable crashlog reporting"))])
 config.plugins.crashlogautosubmit.sendlog = ConfigSelection(default = "rename", choices = [
        ("delete", _("Delete crashlogs")), ("rename", _("Rename crashlogs"))])
+config.plugins.crashlogautosubmit.attachemail = ConfigYesNo(default = False)
+config.plugins.crashlogautosubmit.email = ConfigText(default = "myemail@home.com", fixed_size = False)
+config.plugins.crashlogautosubmit.name = ConfigText(default = "Dreambox User", fixed_size = False)
 
 
 class CrashlogAutoSubmitConfiguration(Screen, ConfigListScreen):
+
+       oldMailEntryValue = config.plugins.crashlogautosubmit.sendmail.value
+
        skin = """
-               <screen name="CrashlogAutoSubmitConfiguration" position="80,80" size="560,400" title="CrashlogAutoSubmitConfiguration..." >
+               <screen name="CrashlogAutoSubmitConfiguration" position="80,80" size="560,400" title="CrashlogAutoSubmit settings..." >
                        <widget name="config" zPosition="2" position="5,5" size="550,360" scrollbarMode="showOnDemand" transparent="1" />
-                       <ePixmap pixmap="skin_default/buttons/red.png" position="0,370" zPosition="2" size="140,40" transparent="1" alphatest="on" />
-                       <widget name="closetext" position="0,370" zPosition="10" size="140,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
-                       <ePixmap pixmap="skin_default/buttons/green.png" position="140,370" zPosition="2" size="140,40" transparent="1" alphatest="on" />
-                       <widget name="installtext" position="140,370" zPosition="10" size="140,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
+                       <ePixmap pixmap="skin_default/div-h.png" position="0,300" zPosition="10" size="560,2" transparent="1" alphatest="on" />
+                       <widget name="status" position="10,300" zPosition="10" size="540,50" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
+                       <ePixmap pixmap="skin_default/buttons/red.png" position="0,360" zPosition="2" size="140,40" transparent="1" alphatest="on" />
+                       <widget name="closetext" position="0,360" zPosition="10" size="140,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
+                       <ePixmap pixmap="skin_default/buttons/green.png" position="140,360" zPosition="2" size="140,40" transparent="1" alphatest="on" />
+                       <widget name="installtext" position="140,360" zPosition="10" size="140,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
+                       <widget name="VKeyButton" pixmap="skin_default/buttons/button_yellow.png" position="285,370" zPosition="2" size="15,16" transparent="1" alphatest="on" />
+                       <widget name="VKeyIcon" pixmap="skin_default/vkey_icon.png" position="300,355" zPosition="10" size="60,48" transparent="1" alphatest="on" />
+                       <widget name="HelpWindow" position="175,250" zPosition="1" size="1,1" transparent="1" />
                </screen>"""
 
        def __init__(self, session):
@@ -30,28 +46,44 @@ class CrashlogAutoSubmitConfiguration(Screen, ConfigListScreen):
                self.session = session
                self.MailEntry = None
                self.LogEntry = None
+               self.addEmailEntry = None
+               self.EmailEntry = None
+               self.NameEntry = None
+               self.msgCrashlogMailer = False
 
-               self["shortcuts"] = ActionMap(["ShortcutActions", "WizardActions" ],
+               self["shortcuts"] = ActionMap(["ShortcutActions", "SetupActions" ],
                {
                        "ok": self.keySave,
-                       "back": self.keyCancel,
+                       "cancel": self.keyCancel,
                        "red": self.keyCancel,
                        "green": self.keySave,
+               }, -2)
+
+               self["VirtualKB"] = ActionMap(["ColorActions" ],
+               {
+                       "yellow": self.KeyYellow,
                }, -1)
 
                self.list = []
                ConfigListScreen.__init__(self, self.list,session = self.session)
                self.createSetup()
 
+               self["VKeyButton"] = Pixmap()
+               self["VKeyIcon"] = Pixmap()
                self["closetext"] = Label(_("Close"))
                self["installtext"] = Label(_("Save"))
+               self["HelpWindow"] = Label()
+               self["status"] = Label()
+
+               self["VKeyButton"].hide()
+               self["VKeyIcon"].hide()
+               self["VirtualKB"].setEnabled(False)
                self.onShown.append(self.setWindowTitle)
+               self.onClose.append(self.msgCrashlogNotifier)
 
-       def setWindowTitle(self):
-               self.setTitle(_("CrashlogAutoSubmitConfiguration"))
 
-       def exit(self):
-               self.close(False, self.session)
+       def setWindowTitle(self):
+               self.setTitle(_("CrashlogAutoSubmit settings..."))
 
        def keyLeft(self):
                ConfigListScreen.keyLeft(self)
@@ -61,53 +93,158 @@ class CrashlogAutoSubmitConfiguration(Screen, ConfigListScreen):
                ConfigListScreen.keyRight(self)
                self.newConfig()
 
+       def KeyYellow(self):
+                       if self["config"].getCurrent() == self.EmailEntry:
+                               self.session.openWithCallback(self.EmailCallback, VirtualKeyBoard, title = (_("Please enter your email address here:")), text = config.plugins.crashlogautosubmit.email.value)
+                       if self["config"].getCurrent() == self.NameEntry:
+                               self.session.openWithCallback(self.NameCallback, VirtualKeyBoard, title = (_("Please enter your name here (optional):")), text = config.plugins.crashlogautosubmit.name.value)
+
+       def EmailCallback(self, callback = None):
+               if callback is not None and len(callback):
+                       config.plugins.crashlogautosubmit.email.setValue(callback)
+                       self["config"].invalidate(self.EmailEntry)
+
+       def NameCallback(self, callback = None):
+               if callback is not None and len(callback):
+                       config.plugins.crashlogautosubmit.name.setValue(callback)
+                       self["config"].invalidate(self.NameEntry)
+
        def createSetup(self):
                self.list = []
-               self.MailEntry = getConfigListEntry(_("How to handle found crashlogs:"), config.plugins.crashlogautosubmit.sendmail)
-               self.LogEntry = getConfigListEntry(_("What to do with sent crashlogs:"), config.plugins.crashlogautosubmit.sendlog)
-               self.list.append(self.MailEntry)
+               self.MailEntry = getConfigListEntry(_("How to handle found crashlogs?"), config.plugins.crashlogautosubmit.sendmail)
+               self.LogEntry = getConfigListEntry(_("What to do with submitted crashlogs?"), config.plugins.crashlogautosubmit.sendlog)
+               self.addEmailEntry = getConfigListEntry(_("Include your email and name (optional) in the mail?"), config.plugins.crashlogautosubmit.attachemail)
+               self.EmailEntry = getConfigListEntry(_("Your email address:"), config.plugins.crashlogautosubmit.email)
+               self.NameEntry = getConfigListEntry(_("Your name (optional):"), config.plugins.crashlogautosubmit.name)
+               self.list.append( self.MailEntry )
                if config.plugins.crashlogautosubmit.sendmail.value is not "send_never":
-                       self.list.append(self.LogEntry )
+                       self.list.append( self.LogEntry )
+                       self.list.append( self.addEmailEntry )
+                       if config.plugins.crashlogautosubmit.attachemail.value is True:
+                               self.list.append( self.EmailEntry )
+                               self.list.append( self.NameEntry )
+
                self["config"].list = self.list
                self["config"].l.setList(self.list)
+               if not self.selectionChanged in self["config"].onSelectionChanged:
+                       self["config"].onSelectionChanged.append(self.selectionChanged)
+
+               if not self.sendmailChanged in config.plugins.crashlogautosubmit.sendmail.notifiers:
+                       config.plugins.crashlogautosubmit.sendmail.notifiers.append(self.sendmailChanged)
+
+       def sendmailChanged(self, configElement):
+               if configElement.value != CrashlogAutoSubmitConfiguration.oldMailEntryValue:
+                       self.msgCrashlogMailer = True
+               else:
+                       self.msgCrashlogMailer = False
 
        def newConfig(self):
                if self["config"].getCurrent() == self.MailEntry:
                        self.createSetup()
+               if self["config"].getCurrent() == self.addEmailEntry:
+                       self.createSetup()
 
-       def keyCancel(self):
-               print "cancel"
+       def selectionChanged(self):
+               current = self["config"].getCurrent()
+               if current == self.MailEntry:
+                       self["status"].setText(_("Decide what should be done when crashlogs are found."))
+                       self.disableVKeyIcon()
+               elif current == self.LogEntry:
+                       self["status"].setText(_("Decide what should happen to the crashlogs after submission."))
+                       self.disableVKeyIcon()
+               elif current == self.addEmailEntry:
+                       self["status"].setText(_("Do you want to submit your email address and name so that we can contact you if needed?"))
+                       self.disableVKeyIcon()
+               elif current == self.EmailEntry:
+                       self["status"].setText(_("Enter your email address so that we can contact you if needed."))
+                       self.enableVKeyIcon()
+                       self.showKeypad()
+               elif current == self.NameEntry:
+                       self["status"].setText(_("Optionally enter your name if you want to."))
+                       self.enableVKeyIcon()
+                       self.showKeypad()
+
+       def enableVKeyIcon(self):
+               self["VKeyButton"].show()
+               self["VKeyIcon"].show()
+               self["VirtualKB"].setEnabled(True)
+
+       def showKeypad(self):
+               current = self["config"].getCurrent()
+               helpwindowpos = self["HelpWindow"].getPosition()
+               if hasattr(current[1], 'help_window'):
+                       if current[1].help_window.instance is not None:
+                               current[1].help_window.instance.show()
+                               current[1].help_window.instance.move(ePoint(helpwindowpos[0],helpwindowpos[1]))
+
+       def disableVKeyIcon(self):
+               self["VKeyButton"].hide()
+               self["VKeyIcon"].hide()
+               self["VirtualKB"].setEnabled(False)
+
+       def hideKeypad(self):
+               current = self["config"].getCurrent()
+               if hasattr(current[1], 'help_window'):
+                       if current[1].help_window.instance is not None:
+                               current[1].help_window.instance.hide()
+
+       def cancelConfirm(self, result):
+               if not result:
+                       self.showKeypad()
+                       return
                for x in self["config"].list:
                        x[1].cancel()
-               self.close(False, self.session)
+               self.close()
+
+       def keyCancel(self):
+               print "cancel"
+               if self["config"].isChanged():
+                       self.hideKeypad()
+                       self.session.openWithCallback(self.cancelConfirm, MessageBox, _("Really close without saving settings?"))
+               else:
+                       self.close()
 
        def keySave(self):
                print "saving"
-               config.plugins.crashlogautosubmit.sendmail.save()
-               config.plugins.crashlogautosubmit.sendlog.save()
-               for x in self["config"].list:
-                       x[1].save()
-               config.plugins.crashlogautosubmit.save()
-               config.plugins.save()
-               self.close(True, self.session)
+               CrashlogAutoSubmitConfiguration.oldMailEntryValue = config.plugins.crashlogautosubmit.sendmail.value
+               ConfigListScreen.keySave(self)
+
+       def msgCrashlogNotifier(self):
+               if self.msgCrashlogMailer is True:
+                       try:
+                               callCrashMailer(True, self.session)
+                       except AttributeError:
+                               print "error, not restarting crashlogmailer"
 
 
 def mxServerFound(mxServer,session):
        print "[CrashlogAutoSubmit] - mxServerFound -->", mxServer
+       attachments = []
+       crashLogFilelist = []
        mailFrom = "enigma2@crashlog.dream-multimedia-tv.de"
        mailTo = "enigma2@crashlog.dream-multimedia-tv.de"
        subject = "Automatically generated crashlogmail"
-       mailtext = "\nHello\n\nHere are some crashlogs i found for you.\n\n"
-       mailfooter = "This is an automatically generated email.  You cant answer!!!"
+       mailtext = "\nHello\n\nHere are some crashlogs i found for you.\n"
+       mailfooter = "\n\nThis is an automatically generated email from the CrashlogAutoSubmit plugin.\n\n\nHave a nice day.\n"
+       if  str(config.plugins.crashlogautosubmit.email.value) == "myemail@home.com":
+               user_email = ""
+       else:
+               user_email = "\nUser supplied email address: " + str(config.plugins.crashlogautosubmit.email.value)
+       if str(config.plugins.crashlogautosubmit.name.value) ==  "Dreambox User":
+               user_name = ""
+       else:
+               user_name = "\n\nOptional supplied name: " + str(config.plugins.crashlogautosubmit.name.value)
        headers = { 'from': 'CrashlogAutoSubmitter <enigma2@crashlog.dream-multimedia-tv.de>', 'to': 'dream-multimedia-crashlogs <enigma2@crashlog.dream-multimedia-tv.de>', 'subject' : str(subject) }
-       mailData = mailtext + mailfooter
-       attachments = [] #(filename, mimetype, attachment as string)
-       crashLogFilelist = []
+       mailData = mailtext + user_email + user_name + mailfooter
+       if config.plugins.crashlogautosubmit.attachemail.value is True:
+               if  str(config.plugins.crashlogautosubmit.email.value) != "myemail@home.com":
+                       headers["reply-to"] = str(config.plugins.crashlogautosubmit.email.value)
 
        list = (
                (_("Yes"), "send"),
-               (_("Yes, and don't ask again."), "send_always"),
-               (_("No, send them never."), "send_never")
+               (_("Yes, and don't ask again"), "send_always"),
+               (_("No, not now"), "send_not"),
+               (_("No, send them never"), "send_never")
        )
 
        def handleError(error):
@@ -156,6 +293,9 @@ def mxServerFound(mxServer,session):
                        config.plugins.crashlogautosubmit.save()
                        config.plugins.save()
                        config.save()
+               elif answer == "send_not":
+                       print "[CrashlogAutoSubmit] - not sending crashlogs for this time."
+
 
        for crashlog in os.listdir('/media/hdd'):
                if crashlog.startswith("enigma2_crash_") and crashlog.endswith(".log"):
@@ -167,6 +307,8 @@ def mxServerFound(mxServer,session):
                        session.openWithCallback(handleAnswer, ChoiceBox, title=_("Crashlogs found!\nSend them to Dream Multimedia ?"), list = list)
                elif config.plugins.crashlogautosubmit.sendmail.value == "send_always":
                        send_mail()
+       else:
+               print "[CrashlogAutoSubmit] - no crashlogs found."
 
 
 def getMailExchange(host):
@@ -186,7 +328,16 @@ def startMailer(session):
                print "[CrashlogAutoSubmit] - not starting CrashlogAutoSubmit"
                return False
 
-       getMailExchange('crashlog.dream-multimedia-tv.de').addCallback(mxServerFound,session)
+       if not config.misc.firstrun.value:
+               getMailExchange('crashlog.dream-multimedia-tv.de').addCallback(mxServerFound,session)
+
+
+def callCrashMailer(result,session):
+       if result is True:
+               print "[CrashlogAutoSubmit] - config changed"
+               startMailer(session)
+       else:
+               print "[CrashlogAutoSubmit] - config not changed"
 
 
 def autostart(reason, **kwargs):
@@ -197,19 +348,19 @@ def autostart(reason, **kwargs):
                except ImportError, e:
                        print "[CrashlogAutoSubmit] Twisted-mail not available, not starting CrashlogAutoSubmitter", e
 
+
 def openconfig(session, **kwargs):
-       session.openWithCallback(configCB, CrashlogAutoSubmitConfiguration)
+       session.open(CrashlogAutoSubmitConfiguration)
 
-def configCB(result, session):
-       if result is True:
-               print "[CrashlogAutoSubmit] - config changed"
-               startMailer(session)
-       else:
-               print "[CrashlogAutoSubmit] - config not changed"
+
+def selSetup(menuid, **kwargs):
+       if menuid != "system":
+               return [ ]
+
+       return [(_("Crashlog settings") + "...", openconfig, "crashlog_config", 70)]
 
 
 def Plugins(**kwargs):
        return [PluginDescriptor(where = [PluginDescriptor.WHERE_SESSIONSTART, PluginDescriptor.WHERE_AUTOSTART], fnc = autostart),
-               PluginDescriptor(name=_("CrashlogAutoSubmit"), description=_("Configuration for the CrashlogAutoSubmitter"),
-                                                       where=[PluginDescriptor.WHERE_PLUGINMENU], fnc=openconfig)]
+               PluginDescriptor(name=_("CrashlogAutoSubmit"), description=_("CrashlogAutoSubmit settings"),where=PluginDescriptor.WHERE_MENU, fnc=selSetup)]