Fix addons

1 files changed, 242 insertions, 0 deletions

diff --git a/module/plugins/internal/Addon.py b/module/plugins/internal/Addon.py
new file mode 100644
index 000000000..f3da5272f
--- /dev/null
+++ b/module/plugins/internal/Addon.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+
+import traceback
+
+from module.plugins.internal.Plugin import Plugin
+
+
+class Expose(object):
+    """
+    Used for decoration to declare rpc services
+    """
+    def __new__(cls, f, *args, **kwargs):
+        hookManager.addRPC(f.__module__, f.func_name, f.func_doc)
+        return f
+
+
+def threaded(fn):
+
+    def run(*args, **kwargs):
+        hookManager.startThread(fn, *args, **kwargs)
+
+    return run
+
+
+class Addon(Plugin):
+    __name__    = "Addon"
+    __type__    = "hook"  #@TODO: Change to `addon` in 0.4.10
+    __version__ = "0.01"
+
+    __config__   = []  #: [("name", "type", "desc", "default")]
+    __threaded__ = []  #@TODO: Remove in 0.4.10
+
+    __description__ = """Base addon plugin"""
+    __license__     = "GPLv3"
+    __authors__     = [("Walter Purcaro", "vuolter@gmail.com")]
+
+
+    def __init__(self, core, manager):
+        super(Addon, self).__init__(core)
+
+        #: `HookManager`
+        self.manager = manager
+
+        #: Automatically register event listeners for functions, attribute will be deleted dont use it yourself
+        self.event_map = {}
+
+        #: Deprecated alternative to event_map
+        #: List of events the plugin can handle, name the functions exactly like eventname.
+        self.event_list = []  #@NOTE: dont make duplicate entries in event_map
+
+        #: Callback of periodical job task, used by HookManager
+        self.cb       = None
+        self.interval = 60
+
+        self.init()
+        self.init_events()
+
+
+    def init_events(self):
+        if self.event_map:
+            for event, funcs in self.event_map.iteritems():
+                if type(funcs) in (list, tuple):
+                    for f in funcs:
+                        self.manager.addEvent(event, getattr(self, f))
+                else:
+                    self.manager.addEvent(event, getattr(self, funcs))
+
+            #: Delete for various reasons
+            self.event_map = None
+
+        if self.event_list:
+            self.log_debug("Deprecated method `event_list`, use `event_map` instead")
+
+            for f in self.event_list:
+                self.manager.addEvent(f, getattr(self, f))
+
+            self.event_list = None
+
+
+    def init_periodical(self, delay=0, threaded=False):
+        self.cb = self.core.scheduler.addJob(max(0, delay), self._periodical, [threaded], threaded=threaded)
+
+
+    #: Deprecated method, use `init_periodical` instead
+    def initPeriodical(self, *args, **kwargs):
+        return self.init_periodical(*args, **kwargs)
+
+
+    def _periodical(self, threaded):
+        if self.interval < 0:
+            self.cb = None
+            return
+
+        try:
+            self.periodical()
+
+        except Exception, e:
+            self.log_error(_("Error executing addon: %s") % e)
+            if self.core.debug:
+                traceback.print_exc()
+
+        self.cb = self.core.scheduler.addJob(self.interval, self._periodical, [threaded], threaded=threaded)
+
+
+    def periodical(self):
+        pass
+
+
+    def __repr__(self):
+        return "<Addon %s>" % self.__name__
+
+
+    def is_activated(self):
+        """
+        Checks if addon is activated
+        """
+        return self.get_config("activated")
+
+
+    #: Deprecated method, use `is_activated` instead
+    def isActivated(self, *args, **kwargs):
+        return self.is_activated(*args, **kwargs)
+
+
+    def deactivate(self):
+        """
+        Called when addon was deactivated
+        """
+        pass
+
+
+    #: Deprecated method, use `deactivate` instead
+    def unload(self, *args, **kwargs):
+        return self.deactivate(*args, **kwargs)
+
+
+    def activate(self):
+        """
+        Called when addon was activated
+        """
+        pass
+
+
+    #: Deprecated method, use `activate` instead
+    def coreReady(self, *args, **kwargs):
+        return self.activate(*args, **kwargs)
+
+
+    def exit(self):
+        """
+        Called by core.shutdown just before pyLoad exit
+        """
+        pass
+
+
+    #: Deprecated method, use `exit` instead
+    def coreExiting(self, *args, **kwargs):
+        return self.exit(*args, **kwargs)
+
+
+    def download_preparing(self, pyfile):
+        pass
+
+
+    #: Deprecated method, use `download_preparing` instead
+    def downloadPreparing(self, *args, **kwargs):
+        return self.download_preparing(*args, **kwargs)
+
+
+    def download_finished(self, pyfile):
+        pass
+
+
+    #: Deprecated method, use `download_finished` instead
+    def downloadFinished(self, *args, **kwargs):
+        return self.download_finished(*args, **kwargs)
+
+
+    def download_failed(self, pyfile):
+        pass
+
+
+    #: Deprecated method, use `download_failed` instead
+    def downloadFailed(self, *args, **kwargs):
+        return self.download_failed(*args, **kwargs)
+
+
+    def package_finished(self, pypack):
+        pass
+
+
+    #: Deprecated method, use `package_finished` instead
+    def packageFinished(self, *args, **kwargs):
+        return self.package_finished(*args, **kwargs)
+
+
+    def before_reconnect(self, ip):
+        pass
+
+
+    #: Deprecated method, use `before_reconnect` instead
+    def beforeReconnecting(self, *args, **kwargs):
+        return self.before_reconnect(*args, **kwargs)
+
+
+    def after_reconnect(self, ip, oldip):
+        pass
+
+
+    #: Deprecated method, use `after_reconnect` instead
+    def afterReconnecting(self, ip):
+        return self.after_reconnect(ip, None)
+
+
+    def captcha_task(self, task):
+        """
+        New captcha task for the plugin, it MUST set the handler and timeout or will be ignored
+        """
+        pass
+
+
+    #: Deprecated method, use `captcha_task` instead
+    def newCaptchaTask(self, *args, **kwargs):
+        return self.captcha_task(*args, **kwargs)
+
+
+    def captcha_correct(self, task):
+        pass
+
+
+    #: Deprecated method, use `captcha_correct` instead
+    def captchaCorrect(self, *args, **kwargs):
+        return self.captcha_correct(*args, **kwargs)
+
+
+    def captcha_invalid(self, task):
+        pass
+
+
+    #: Deprecated method, use `captcha_invalid` instead
+    def captchaInvalid(self, *args, **kwargs):
+        return self.captcha_invalid(*args, **kwargs)