From 5499be89203a18ca61a21cfc7266cf0f4ebe6547 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Thu, 15 Dec 2011 23:18:21 +0100
Subject: refractoring

---
 module/plugins/Base.py | 116 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 116 insertions(+)
 create mode 100644 module/plugins/Base.py

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
new file mode 100644
index 000000000..98573ea63
--- /dev/null
+++ b/module/plugins/Base.py
@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+"""
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License,
+    or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+    See the GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, see <http://www.gnu.org/licenses/>.
+
+    @author: RaNaN
+"""
+
+class Base(object):
+    """
+    The Base plugin class with all shared methods and every possible attribute for plugin definition.
+    """
+    __version__ = "0.4"
+    #: Regexp pattern which will be matched for download plugins
+    __pattern__ = r""
+    #: Flat config definition
+    __config__ = tuple()
+    #: Short description, one liner
+    __description__ = ""
+    #: More detailed text
+    __long_description__ = """"""
+    #: List of needed modules
+    __dependencies__ = tuple()
+    #: Tags to categorize the plugin
+    __tags__ = tuple()
+    #: Base64 encoded .png icon
+    __icon__ = ""
+    #: Alternative, link to png icon
+    __icon_url__ = ""
+    #: Url with general information/support/discussion
+    __url__ = ""
+    __author_name__ = tuple()
+    __author_mail__ = tuple()
+
+
+    def __init__(self, core):
+        self.__name__ = self.__class__.__name__
+
+        #: Core instance
+        self.core = core
+        #: logging instance
+        self.log = core.log
+        #: core config
+        self.config = core.config
+
+    #log functions
+    def logInfo(self, *args):
+        self.log.info("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+
+    def logWarning(self, *args):
+        self.log.warning("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+
+    def logError(self, *args):
+        self.log.error("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+
+    def logDebug(self, *args):
+        self.log.debug("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+
+
+    def setConf(self, option, value):
+        """ see `setConfig` """
+        self.core.config.setPlugin(self.__name__, option, value)
+
+    def setConfig(self, option, value):
+        """ Set config value for current plugin
+
+        :param option:
+        :param value:
+        :return:
+        """
+        self.setConf(option, value)
+
+    def getConf(self, option):
+        """ see `getConfig` """
+        return self.core.config.getPlugin(self.__name__, option)
+
+    def getConfig(self, option):
+        """ Returns config value for current plugin
+
+        :param option:
+        :return:
+        """
+        return self.getConf(option)
+
+    def setStorage(self, key, value):
+        """ Saves a value persistently to the database """
+        self.core.db.setStorage(self.__name__, key, value)
+
+    def store(self, key, value):
+        """ same as `setStorage` """
+        self.core.db.setStorage(self.__name__, key, value)
+
+    def getStorage(self, key=None, default=None):
+        """ Retrieves saved value or dict of all saved entries if key is None """
+        if key is not None:
+            return self.core.db.getStorage(self.__name__, key) or default
+        return self.core.db.getStorage(self.__name__, key)
+
+    def retrieve(self, *args, **kwargs):
+        """ same as `getStorage` """
+        return self.getStorage(*args, **kwargs)
+
+    def delStorage(self, key):
+        """ Delete entry in db """
+        self.core.db.delStorage(self.__name__, key)
-- 
cgit v1.2.3


From 4e918edba6c3808b095eab1bad137a2a8cab970d Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sat, 17 Dec 2011 21:53:57 +0100
Subject: updated plugin api and plugin manager

---
 module/plugins/Base.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 98573ea63..b166ebae8 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -17,11 +17,16 @@
     @author: RaNaN
 """
 
+# TODO: config format definition
+#       more attributes if needed
+#       get rid of catpcha & container plugins ?! (move to crypter & internals)
+#       adapt old plugins as needed
+
 class Base(object):
     """
     The Base plugin class with all shared methods and every possible attribute for plugin definition.
     """
-    __version__ = "0.4"
+    __version__ = "0.1"
     #: Regexp pattern which will be matched for download plugins
     __pattern__ = r""
     #: Flat config definition
-- 
cgit v1.2.3


From 6eae782f13953dd0ba2bbe1b582cf33fd4d7d90a Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Mon, 19 Dec 2011 23:10:49 +0100
Subject: configparser v2, warning CONFIG will be DELETED.

---
 module/plugins/Base.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index b166ebae8..5a78fddc3 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -75,7 +75,7 @@ class Base(object):
 
     def setConf(self, option, value):
         """ see `setConfig` """
-        self.core.config.setPlugin(self.__name__, option, value)
+        self.core.config.set(self.__name__, option, value)
 
     def setConfig(self, option, value):
         """ Set config value for current plugin
@@ -88,7 +88,7 @@ class Base(object):
 
     def getConf(self, option):
         """ see `getConfig` """
-        return self.core.config.getPlugin(self.__name__, option)
+        return self.core.config.get(self.__name__, option)
 
     def getConfig(self, option):
         """ Returns config value for current plugin
-- 
cgit v1.2.3


From 958bf611f5d9d117f19f824990ec6fd6b537e967 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Thu, 22 Dec 2011 23:45:38 +0100
Subject: accountmanager v2, delete your accounts.conf and re-enter them in
 pyload, new nice debug functions, try core.shell() and core.breakpoint()

---
 module/plugins/Base.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 5a78fddc3..36df7e423 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -17,6 +17,8 @@
     @author: RaNaN
 """
 
+import sys
+
 # TODO: config format definition
 #       more attributes if needed
 #       get rid of catpcha & container plugins ?! (move to crypter & internals)
@@ -119,3 +121,11 @@ class Base(object):
     def delStorage(self, key):
         """ Delete entry in db """
         self.core.db.delStorage(self.__name__, key)
+
+    def shell(self):
+        """ open ipython shell """
+        if self.core.debug:
+            from IPython import embed
+            #noinspection PyUnresolvedReferences
+            sys.stdout = sys._stdout
+            embed()
-- 
cgit v1.2.3


From d35c003cc53d4723d1dfe0d81eeb9bea78cee594 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sat, 31 Dec 2011 16:01:24 +0100
Subject: new crypter plugin API, now decrypting possible for now.

---
 module/plugins/Base.py | 101 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 90 insertions(+), 11 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 36df7e423..b2338a01f 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -18,12 +18,19 @@
 """
 
 import sys
+from module.utils.fs import exists, makedirs, join
 
-# TODO: config format definition
+# TODO
 #       more attributes if needed
 #       get rid of catpcha & container plugins ?! (move to crypter & internals)
 #       adapt old plugins as needed
 
+class Fail(Exception):
+    """ raised when failed """
+
+class Retry(Exception):
+    """ raised when start again from beginning """
+
 class Base(object):
     """
     The Base plugin class with all shared methods and every possible attribute for plugin definition.
@@ -31,7 +38,8 @@ class Base(object):
     __version__ = "0.1"
     #: Regexp pattern which will be matched for download plugins
     __pattern__ = r""
-    #: Flat config definition
+    #: Config definition: list of  (name, type, verbose_name, default_value) or
+    #: (name, type, verbose_name, short_description, default_value)
     __config__ = tuple()
     #: Short description, one liner
     __description__ = ""
@@ -41,7 +49,7 @@ class Base(object):
     __dependencies__ = tuple()
     #: Tags to categorize the plugin
     __tags__ = tuple()
-    #: Base64 encoded .png icon
+    #: Base64 encoded .png icon, please don't use sizes above ~3KB
     __icon__ = ""
     #: Alternative, link to png icon
     __icon_url__ = ""
@@ -62,18 +70,25 @@ class Base(object):
         self.config = core.config
 
     #log functions
-    def logInfo(self, *args):
-        self.log.info("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+    def logInfo(self, *args, **kwargs):
+        self._log("info", *args, **kwargs)
+
+    def logWarning(self, *args, **kwargs):
+        self._log("warning", *args, **kwargs)
 
-    def logWarning(self, *args):
-        self.log.warning("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+    def logError(self, *args, **kwargs):
+        self._log("error", *args, **kwargs)
 
-    def logError(self, *args):
-        self.log.error("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+    def logDebug(self, *args, **kwargs):
+        self._log("debug", *args, **kwargs)
 
-    def logDebug(self, *args):
-        self.log.debug("%s: %s" % (self.__name__, " | ".join([a if isinstance(a, basestring) else str(a) for a in args])))
+    def _log(self, level, *args, **kwargs):
+        if "sep" in kwargs:
+            sep = "%s" % kwargs["sep"]
+        else:
+            sep = " | "
 
+        getattr(self.log, level)("%s: %s" % (self.__name__, sep.join([a if isinstance(a, basestring) else str(a) for a in args])))
 
     def setConf(self, option, value):
         """ see `setConfig` """
@@ -129,3 +144,67 @@ class Base(object):
             #noinspection PyUnresolvedReferences
             sys.stdout = sys._stdout
             embed()
+
+    def load(self, url, get={}, post={}, ref=True, cookies=True, just_header=False, decode=False):
+        """Load content at url and returns it
+
+        :param url:
+        :param get:
+        :param post:
+        :param ref:
+        :param cookies:
+        :param just_header: if True only the header will be retrieved and returned as dict
+        :param decode: Wether to decode the output according to http header, should be True in most cases
+        :return: Loaded content
+        """
+        if not hasattr(self, "req"): raise Exception("Plugin type does not have Request attribute.")
+
+        if type(url) == unicode: url = str(url)
+
+        res = self.req.load(url, get, post, ref, cookies, just_header, decode=decode)
+
+        if self.core.debug:
+            from inspect import currentframe
+
+            frame = currentframe()
+            if not exists(join("tmp", self.__name__)):
+                makedirs(join("tmp", self.__name__))
+
+            f = open(
+                join("tmp", self.__name__, "%s_line%s.dump.html" % (frame.f_back.f_code.co_name, frame.f_back.f_lineno))
+                , "wb")
+            del frame # delete the frame or it wont be cleaned
+
+            try:
+                tmp = res.encode("utf8")
+            except:
+                tmp = res
+
+            f.write(tmp)
+            f.close()
+
+        if just_header:
+            #parse header
+            header = {"code": self.req.code}
+            for line in res.splitlines():
+                line = line.strip()
+                if not line or ":" not in line: continue
+
+                key, none, value = line.partition(":")
+                key = key.lower().strip()
+                value = value.strip()
+
+                if key in header:
+                    if type(header[key]) == list:
+                        header[key].append(value)
+                    else:
+                        header[key] = [header[key], value]
+                else:
+                    header[key] = value
+            res = header
+
+        return res
+
+    def fail(self, reason):
+        """ fail and give reason """
+        raise Fail(reason)
\ No newline at end of file
-- 
cgit v1.2.3


From 4a3a81b63cd85cc3dcd9669868a2079da65838a2 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Tue, 3 Jan 2012 20:41:23 +0100
Subject: fixes for old style decrypter

---
 module/plugins/Base.py | 17 ++++++-----------
 1 file changed, 6 insertions(+), 11 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index b2338a01f..0ad0d5caa 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -90,18 +90,13 @@ class Base(object):
 
         getattr(self.log, level)("%s: %s" % (self.__name__, sep.join([a if isinstance(a, basestring) else str(a) for a in args])))
 
-    def setConf(self, option, value):
-        """ see `setConfig` """
-        self.core.config.set(self.__name__, option, value)
-
     def setConfig(self, option, value):
         """ Set config value for current plugin
 
         :param option:
         :param value:
-        :return:
         """
-        self.setConf(option, value)
+        self.core.config.set(self.__name__, option, value)
 
     def getConf(self, option):
         """ see `getConfig` """
@@ -148,11 +143,11 @@ class Base(object):
     def load(self, url, get={}, post={}, ref=True, cookies=True, just_header=False, decode=False):
         """Load content at url and returns it
 
-        :param url:
-        :param get:
-        :param post:
-        :param ref:
-        :param cookies:
+        :param url: url as string
+        :param get: GET as dict
+        :param post: POST as dict
+        :param ref: Set HTTP_REFERER header
+        :param cookies: use saved cookies
         :param just_header: if True only the header will be retrieved and returned as dict
         :param decode: Wether to decode the output according to http header, should be True in most cases
         :return: Loaded content
-- 
cgit v1.2.3


From 18466eb7f8f3cd4ca9a0824074d2ff454939fce6 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Wed, 4 Jan 2012 17:23:13 +0100
Subject: some fixes

---
 module/plugins/Base.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 0ad0d5caa..1477356ea 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -40,7 +40,7 @@ class Base(object):
     __pattern__ = r""
     #: Config definition: list of  (name, type, verbose_name, default_value) or
     #: (name, type, verbose_name, short_description, default_value)
-    __config__ = tuple()
+    __config__ = list()
     #: Short description, one liner
     __description__ = ""
     #: More detailed text
@@ -68,9 +68,17 @@ class Base(object):
         self.log = core.log
         #: core config
         self.config = core.config
+        #: :class:`EventManager`
+        self.evm = core.eventManager
+        #: :class:`InteractionManager`
+        self.im = core.interActionManager
 
-    #log functions
     def logInfo(self, *args, **kwargs):
+        """ Print args to log at specific level
+
+        :param args: Arbitary object which should be logged
+        :param kwargs: sep=(how to seperate arguments), default = " | "
+        """
         self._log("info", *args, **kwargs)
 
     def logWarning(self, *args, **kwargs):
-- 
cgit v1.2.3


From 828cc89cc9b7a2ecacf98fc73928d988e15f0b98 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sat, 14 Jan 2012 15:49:08 +0100
Subject: captcha and attachments for plugin tester

---
 module/plugins/Base.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 1477356ea..53840ee18 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -36,7 +36,7 @@ class Base(object):
     The Base plugin class with all shared methods and every possible attribute for plugin definition.
     """
     __version__ = "0.1"
-    #: Regexp pattern which will be matched for download plugins
+    #: Regexp pattern which will be matched for download/crypter plugins
     __pattern__ = r""
     #: Config definition: list of  (name, type, verbose_name, default_value) or
     #: (name, type, verbose_name, short_description, default_value)
@@ -55,6 +55,11 @@ class Base(object):
     __icon_url__ = ""
     #: Url with general information/support/discussion
     __url__ = ""
+    #: Url to term of content, user is accepting these when using the plugin
+    __toc_url__ = ""
+    #: Url to service (to buy premium) for accounts
+    __ref_url__ = ""
+
     __author_name__ = tuple()
     __author_mail__ = tuple()
 
@@ -153,7 +158,7 @@ class Base(object):
 
         :param url: url as string
         :param get: GET as dict
-        :param post: POST as dict
+        :param post: POST as dict, list or string
         :param ref: Set HTTP_REFERER header
         :param cookies: use saved cookies
         :param just_header: if True only the header will be retrieved and returned as dict
-- 
cgit v1.2.3


From 995b6ace8598f22fe8b21b67c587797baa6f7f21 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Mon, 16 Jan 2012 18:31:59 +0100
Subject: correct utf8 conversion for urls

---
 module/plugins/Base.py | 2 --
 1 file changed, 2 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 53840ee18..48a3707b1 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -167,8 +167,6 @@ class Base(object):
         """
         if not hasattr(self, "req"): raise Exception("Plugin type does not have Request attribute.")
 
-        if type(url) == unicode: url = str(url)
-
         res = self.req.load(url, get, post, ref, cookies, just_header, decode=decode)
 
         if self.core.debug:
-- 
cgit v1.2.3


From 056ff14eb0250cb0da4eae4b980e11525589cf65 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sun, 22 Jan 2012 17:49:35 +0100
Subject: encoding fixes

---
 module/plugins/Base.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 48a3707b1..34074095e 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -18,6 +18,7 @@
 """
 
 import sys
+from module.utils import decode
 from module.utils.fs import exists, makedirs, join
 
 # TODO
@@ -101,7 +102,17 @@ class Base(object):
         else:
             sep = " | "
 
-        getattr(self.log, level)("%s: %s" % (self.__name__, sep.join([a if isinstance(a, basestring) else str(a) for a in args])))
+
+        strings = []
+        for obj in args:
+            if type(obj) == unicode:
+                strings.append(obj)
+            elif type(obj) == str:
+                strings.append(decode(obj))
+            else:
+                strings.append(str(obj))
+
+        getattr(self.log, level)("%s: %s" % (self.__name__, sep.join(strings)))
 
     def setConfig(self, option, value):
         """ Set config value for current plugin
-- 
cgit v1.2.3


From d7eef2c28eae2e43e3ade4441810ecc0cdea6fd7 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sun, 5 Feb 2012 21:21:36 +0100
Subject: option for internal plugins

---
 module/plugins/Base.py | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 34074095e..29ff3a723 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -39,6 +39,8 @@ class Base(object):
     __version__ = "0.1"
     #: Regexp pattern which will be matched for download/crypter plugins
     __pattern__ = r""
+    #: Internal Hook plugin which is always loaded
+    __internal__ = False
     #: Config definition: list of  (name, type, verbose_name, default_value) or
     #: (name, type, verbose_name, short_description, default_value)
     __config__ = list()
-- 
cgit v1.2.3


From 4df2b77fdf42046fe19bd371be7c7255986b5980 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Tue, 6 Mar 2012 13:36:39 +0100
Subject: renamed hooks to addons, new filemanager and database, many new api
 methods you will loose ALL your LINKS, webinterface will NOT work

---
 module/plugins/Base.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 29ff3a723..b846bbd60 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -39,7 +39,7 @@ class Base(object):
     __version__ = "0.1"
     #: Regexp pattern which will be matched for download/crypter plugins
     __pattern__ = r""
-    #: Internal Hook plugin which is always loaded
+    #: Internal addon plugin which is always loaded
     __internal__ = False
     #: Config definition: list of  (name, type, verbose_name, default_value) or
     #: (name, type, verbose_name, short_description, default_value)
@@ -50,7 +50,9 @@ class Base(object):
     __long_description__ = """"""
     #: List of needed modules
     __dependencies__ = tuple()
-    #: Tags to categorize the plugin
+    #: Used to assign a category to addon plugins
+    __category__ = ""
+    #: Tags to categorize the plugin, see documentation for further info
     __tags__ = tuple()
     #: Base64 encoded .png icon, please don't use sizes above ~3KB
     __icon__ = ""
@@ -79,7 +81,7 @@ class Base(object):
         #: :class:`EventManager`
         self.evm = core.eventManager
         #: :class:`InteractionManager`
-        self.im = core.interActionManager
+        self.im = core.interactionManager
 
     def logInfo(self, *args, **kwargs):
         """ Print args to log at specific level
@@ -104,7 +106,6 @@ class Base(object):
         else:
             sep = " | "
 
-
         strings = []
         for obj in args:
             if type(obj) == unicode:
-- 
cgit v1.2.3


From 50d4df8b4d48b855bd18e9922355b7f3f2b4da4e Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Tue, 20 Mar 2012 14:57:45 +0100
Subject: captcha decrypting for all plugin types, new interaction manager

---
 module/plugins/Base.py | 118 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 107 insertions(+), 11 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index b846bbd60..61fa211f4 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -18,8 +18,11 @@
 """
 
 import sys
+from time import time, sleep
+from random import randint
+
 from module.utils import decode
-from module.utils.fs import exists, makedirs, join
+from module.utils.fs import exists, makedirs, join, remove
 
 # TODO
 #       more attributes if needed
@@ -32,6 +35,9 @@ class Fail(Exception):
 class Retry(Exception):
     """ raised when start again from beginning """
 
+class Abort(Exception):
+    """ raised when aborted """
+
 class Base(object):
     """
     The Base plugin class with all shared methods and every possible attribute for plugin definition.
@@ -83,6 +89,9 @@ class Base(object):
         #: :class:`InteractionManager`
         self.im = core.interactionManager
 
+        #: last interaction task
+        self.task = None
+
     def logInfo(self, *args, **kwargs):
         """ Print args to log at specific level
 
@@ -118,11 +127,7 @@ class Base(object):
         getattr(self.log, level)("%s: %s" % (self.__name__, sep.join(strings)))
 
     def setConfig(self, option, value):
-        """ Set config value for current plugin
-
-        :param option:
-        :param value:
-        """
+        """ Set config value for current plugin """
         self.core.config.set(self.__name__, option, value)
 
     def getConf(self, option):
@@ -130,11 +135,7 @@ class Base(object):
         return self.core.config.get(self.__name__, option)
 
     def getConfig(self, option):
-        """ Returns config value for current plugin
-
-        :param option:
-        :return:
-        """
+        """ Returns config value for current plugin """
         return self.getConf(option)
 
     def setStorage(self, key, value):
@@ -167,6 +168,14 @@ class Base(object):
             sys.stdout = sys._stdout
             embed()
 
+    def abort(self):
+        """ Check if plugin is in an abort state, is overwritten by subtypes"""
+        return False
+
+    def checkAbort(self):
+        """  Will be overwriten to determine if control flow should be aborted """
+        if self.abort: raise Abort()
+
     def load(self, url, get={}, post={}, ref=True, cookies=True, just_header=False, decode=False):
         """Load content at url and returns it
 
@@ -180,6 +189,7 @@ class Base(object):
         :return: Loaded content
         """
         if not hasattr(self, "req"): raise Exception("Plugin type does not have Request attribute.")
+        self.checkAbort()
 
         res = self.req.load(url, get, post, ref, cookies, just_header, decode=decode)
 
@@ -225,6 +235,92 @@ class Base(object):
 
         return res
 
+    def invalidTask(self):
+        if self.task:
+            self.task.invalid()
+
+    def invalidCaptcha(self):
+        self.logDebug("Deprecated method .invalidCaptcha, use .invalidTask")
+        self.invalidTask()
+
+    def correctTask(self):
+        if self.task:
+            self.task.correct()
+
+    def correctCaptcha(self):
+        self.logDebug("Deprecated method .correctCaptcha, use .correctTask")
+        self.correctTask()
+
+    def decryptCaptcha(self, url, get={}, post={}, cookies=False, forceUser=False, imgtype='jpg',
+                       result_type='textual'):
+        """ Loads a captcha and decrypts it with ocr, plugin, user input
+
+        :param url: url of captcha image
+        :param get: get part for request
+        :param post: post part for request
+        :param cookies: True if cookies should be enabled
+        :param forceUser: if True, ocr is not used
+        :param imgtype: Type of the Image
+        :param result_type: 'textual' if text is written on the captcha\
+        or 'positional' for captcha where the user have to click\
+        on a specific region on the captcha
+
+        :return: result of decrypting
+        """
+
+        img = self.load(url, get=get, post=post, cookies=cookies)
+
+        id = ("%.2f" % time())[-6:].replace(".", "")
+        temp_file = open(join("tmp", "tmpCaptcha_%s_%s.%s" % (self.__name__, id, imgtype)), "wb")
+        temp_file.write(img)
+        temp_file.close()
+
+        name = "%sOCR" % self.__name__
+        has_plugin = name in self.core.pluginManager.getPlugins("internal")
+
+        if self.core.captcha:
+            OCR = self.core.pluginManager.loadClass("internal", name)
+        else:
+            OCR = None
+
+        if OCR and not forceUser:
+            sleep(randint(3000, 5000) / 1000.0)
+            self.checkAbort()
+
+            ocr = OCR()
+            result = ocr.get_captcha(temp_file.name)
+        else:
+            task = self.im.newCaptchaTask(img, imgtype, temp_file.name, result_type)
+            self.task = task
+            self.im.handleTask(task)
+
+            while task.isWaiting():
+                if self.abort():
+                    self.im.removeTask(task)
+                    raise Abort()
+                sleep(1)
+
+            #TODO
+            self.im.removeTask(task)
+
+            if task.error and has_plugin: #ignore default error message since the user could use OCR
+                self.fail(_("Pil and tesseract not installed and no Client connected for captcha decrypting"))
+            elif task.error:
+                self.fail(task.error)
+            elif not task.result:
+                self.fail(_("No captcha result obtained in appropiate time by any of the plugins."))
+
+            result = task.result
+            self.log.debug("Received captcha result: %s" % str(result))
+
+        if not self.core.debug:
+            try:
+                remove(temp_file.name)
+            except:
+                pass
+
+        return result
+
     def fail(self, reason):
         """ fail and give reason """
         raise Fail(reason)
\ No newline at end of file
-- 
cgit v1.2.3


From b40b32ee05f611323a7827fad2a25fa0a28dcb24 Mon Sep 17 00:00:00 2001
From: X3n0m0rph59 <X3n0m0rph59@googlemail.com>
Date: Sun, 22 Apr 2012 19:56:17 +0200
Subject: a huge pile of spelling fixes

---
 module/plugins/Base.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 61fa211f4..4649a2b08 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -95,8 +95,8 @@ class Base(object):
     def logInfo(self, *args, **kwargs):
         """ Print args to log at specific level
 
-        :param args: Arbitary object which should be logged
-        :param kwargs: sep=(how to seperate arguments), default = " | "
+        :param args: Arbitrary object which should be logged
+        :param kwargs: sep=(how to separate arguments), default = " | "
         """
         self._log("info", *args, **kwargs)
 
@@ -173,7 +173,7 @@ class Base(object):
         return False
 
     def checkAbort(self):
-        """  Will be overwriten to determine if control flow should be aborted """
+        """  Will be overwritten to determine if control flow should be aborted """
         if self.abort: raise Abort()
 
     def load(self, url, get={}, post={}, ref=True, cookies=True, just_header=False, decode=False):
@@ -185,7 +185,7 @@ class Base(object):
         :param ref: Set HTTP_REFERER header
         :param cookies: use saved cookies
         :param just_header: if True only the header will be retrieved and returned as dict
-        :param decode: Wether to decode the output according to http header, should be True in most cases
+        :param decode: Whether to decode the output according to http header, should be True in most cases
         :return: Loaded content
         """
         if not hasattr(self, "req"): raise Exception("Plugin type does not have Request attribute.")
@@ -308,7 +308,7 @@ class Base(object):
             elif task.error:
                 self.fail(task.error)
             elif not task.result:
-                self.fail(_("No captcha result obtained in appropiate time by any of the plugins."))
+                self.fail(_("No captcha result obtained in appropriate time by any of the plugins."))
 
             result = task.result
             self.log.debug("Received captcha result: %s" % str(result))
-- 
cgit v1.2.3


From e8eaa91da9e1236d8009df0d79bebe023de8933f Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Sun, 6 May 2012 13:04:15 +0200
Subject: little documentation update

---
 module/plugins/Base.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 4649a2b08..905744c9e 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -300,7 +300,7 @@ class Base(object):
                     raise Abort()
                 sleep(1)
 
-            #TODO
+            #TODO task handling
             self.im.removeTask(task)
 
             if task.error and has_plugin: #ignore default error message since the user could use OCR
-- 
cgit v1.2.3


From 122d9e78da3b41858411b097100246fde628e0a8 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Thu, 9 Aug 2012 21:31:53 +0200
Subject: refined draft

---
 module/plugins/Base.py | 1 +
 1 file changed, 1 insertion(+)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 905744c9e..c97c42328 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -50,6 +50,7 @@ class Base(object):
     #: Config definition: list of  (name, type, verbose_name, default_value) or
     #: (name, type, verbose_name, short_description, default_value)
     __config__ = list()
+    __label__ = "" #TODO: default should be name, makes long_desc obsolete?
     #: Short description, one liner
     __description__ = ""
     #: More detailed text
-- 
cgit v1.2.3


From 54bc92b4c5e0b3543a313f497cbc2276403c5980 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Mon, 10 Sep 2012 11:49:35 +0200
Subject: changed config + progress api

---
 module/plugins/Base.py | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index c97c42328..9f6499985 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -47,14 +47,13 @@ class Base(object):
     __pattern__ = r""
     #: Internal addon plugin which is always loaded
     __internal__ = False
-    #: Config definition: list of  (name, type, verbose_name, default_value) or
-    #: (name, type, verbose_name, short_description, default_value)
+    #: Config definition: list of  (name, type, label, default_value) or
+    #: (name, type, label, short_description, default_value)
     __config__ = list()
-    __label__ = "" #TODO: default should be name, makes long_desc obsolete?
     #: Short description, one liner
-    __description__ = ""
+    __label__ = ""
     #: More detailed text
-    __long_description__ = """"""
+    __description__ = """"""
     #: List of needed modules
     __dependencies__ = tuple()
     #: Used to assign a category to addon plugins
@@ -76,7 +75,7 @@ class Base(object):
     __author_mail__ = tuple()
 
 
-    def __init__(self, core):
+    def __init__(self, core, user=None):
         self.__name__ = self.__class__.__name__
 
         #: Core instance
@@ -89,6 +88,8 @@ class Base(object):
         self.evm = core.eventManager
         #: :class:`InteractionManager`
         self.im = core.interactionManager
+        #: :class:`User`, user related to this plugin
+        self.user = user
 
         #: last interaction task
         self.task = None
-- 
cgit v1.2.3


From 1a55cb6a2eb8784253410b2e93510b5bcebf7f41 Mon Sep 17 00:00:00 2001
From: RaNaN <Mast3rRaNaN@hotmail.de>
Date: Mon, 10 Sep 2012 15:12:55 +0200
Subject: userApi for plugins

---
 module/plugins/Base.py | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'module/plugins/Base.py')

diff --git a/module/plugins/Base.py b/module/plugins/Base.py
index 9f6499985..2b9e12653 100644
--- a/module/plugins/Base.py
+++ b/module/plugins/Base.py
@@ -88,8 +88,18 @@ class Base(object):
         self.evm = core.eventManager
         #: :class:`InteractionManager`
         self.im = core.interactionManager
-        #: :class:`User`, user related to this plugin
-        self.user = user
+        if user:
+            #: :class:`Api`, user api when user is set
+            self.api = self.core.api.withUserContext(user)
+            if self.api:
+                #: :class:`User`, user related to this plugin
+                self.user = self.api.user
+            else:
+                self.api = self.core.api
+                self.user = None
+        else:
+            self.api = self.core.api
+            self.user = None
 
         #: last interaction task
         self.task = None
@@ -176,7 +186,7 @@ class Base(object):
 
     def checkAbort(self):
         """  Will be overwritten to determine if control flow should be aborted """
-        if self.abort: raise Abort()
+        if self.abort(): raise Abort()
 
     def load(self, url, get={}, post={}, ref=True, cookies=True, just_header=False, decode=False):
         """Load content at url and returns it
-- 
cgit v1.2.3