Merge pull request #2068 from malkavi/patch-2

PushOver hook

1 files changed, 124 insertions, 0 deletions

diff --git a/module/plugins/hooks/PushOver.py b/module/plugins/hooks/PushOver.py
new file mode 100644
index 000000000..66c709a3c
--- /dev/null
+++ b/module/plugins/hooks/PushOver.py
@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+
+import time
+
+from module.plugins.internal.Addon import Addon, Expose
+
+
+class PushOver(Addon):
+    __name__    = "PushOver"
+    __type__    = "hook"
+    __version__ = "0.01"
+    __status__  = "testing"
+
+    __config__ = [("activated"      , "bool", "Activated"                                , False),
+				  ("tokenkey"       , "str" , "API Token/Key"                            , ""   ),
+				  ("userkey"        , "str" , "User key"                                 , ""   ),
+                  ("notifycaptcha"  , "bool", "Notify captcha request"                   , True ),
+                  ("notifypackage"  , "bool", "Notify package finished"                  , True ),
+                  ("notifyprocessed", "bool", "Notify packages processed"                , True ),
+                  ("notifyupdate"   , "bool", "Notify plugin updates"                    , True ),
+                  ("notifyexit"     , "bool", "Notify pyLoad shutdown"                   , True ),
+                  ("sendtimewait"   , "int" , "Timewait in seconds between notifications", 5    ),
+                  ("sendpermin"     , "int" , "Max notifications per minute"             , 12   ),
+                  ("ignoreclient"   , "bool", "Send notifications if client is connected", False)]
+
+    __description__ = """Send push notifications to your Phone (using PushOver / based on AndroidPhoneNotify)"""
+    __license__     = "GPLv3"
+    __authors__     = [("Malkavi" , "")]
+
+
+    def init(self):
+        self.event_map = {'allDownloadsProcessed': "all_downloads_processed",
+                          'plugin_updated'       : "plugin_updated"         }
+
+        self.last_notify   = 0
+        self.notifications = 0
+
+
+    def plugin_updated(self, type_plugins):
+        if not self.get_config('notifyupdate'):
+            return
+
+        self.notify(_("Plugins updated"), str(type_plugins))
+
+
+    def activate(self):
+        self.keytoken = self.get_config('tokenkey')
+        self.keyuser = self.get_config('userkey')
+
+
+    def exit(self):
+        if not self.get_config('notifyexit'):
+            return
+
+        if self.pyload.do_restart:
+            self.notify(_("Restarting pyLoad"))
+        else:
+            self.notify(_("Exiting pyLoad"))
+
+
+    def captcha_task(self, task):
+        if not self.get_config('notifycaptcha'):
+            return
+
+        self.notify(_("Captcha"), _("New request waiting user input"))
+
+
+    def package_finished(self, pypack):
+        if self.get_config('notifypackage'):
+            self.notify(_("Package finished"), pypack.name)
+
+
+    def all_downloads_processed(self):
+        if not self.get_config('notifyprocessed'):
+            return
+
+        if any(True for pdata in self.pyload.api.getQueue() if pdata.linksdone < pdata.linkstotal):
+            self.notify(_("Package failed"), _("One or more packages was not completed successfully"))
+        else:
+            self.notify(_("All packages finished"))
+
+
+    @Expose
+    def notify(self,
+               event,
+               msg=None,
+               keytoken=None,
+			   keyuser=None):
+
+        keytoken = keytoken or self.keytoken
+        if not keytoken:
+            return
+
+        keyuser = keyuser or self.keyuser
+        if not keyuser:
+            return
+			
+        if not msg:
+            msg = event
+			
+        if self.pyload.isClientConnected() and not self.get_config('ignoreclient'):
+            return
+
+        elapsed_time = time.time() - self.last_notify
+
+        if elapsed_time < self.get_config("sendtimewait"):
+            return
+
+        if elapsed_time > 60:
+            self.notifications = 0
+
+        elif self.notifications >= self.get_config("sendpermin"):
+            return
+
+        self.load("https://api.pushover.net/1/messages.json",
+               post={'token'	: keytoken,
+                    'user'     : keyuser,
+                    'title'      : event,
+                    'message': msg})
+
+        self.last_notify    = time.time()
+        self.notifications += 1
+
+        return True