move genericcomicreader to tools

weboob/tools/capabilities/gallery/genericcomicreader/backend.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2010-2011 Noé Rubinstein
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+from __future__ import with_statement
+
+import re
+
+from weboob.capabilities.gallery import ICapGallery, BaseGallery, BaseImage
+from weboob.tools.backend import BaseBackend
+from weboob.tools.browser import BaseBrowser, BasePage
+
+__all__ = ['GenericComicReaderBackend']
+
+class DisplayPage(BasePage):
+    def get_page(self, gallery):
+        src = self.document.xpath(self.browser.params['img_src_xpath'])[0]
+
+        return BaseImage(src,
+                gallery=gallery,
+                url=src)
+
+    def page_list(self):
+        return self.document.xpath(self.browser.params['page_list_xpath'])
+
+
+class GenericComicReaderBrowser(BaseBrowser):
+    def __init__(self, browser_params, *args, **kwargs):
+        self.params = browser_params
+        BaseBrowser.__init__(self, *args, **kwargs)
+
+    def iter_gallery_images(self, gallery):
+        self.location(gallery.url)
+        assert self.is_on_page(DisplayPage)
+
+        for p in self.page.page_list():
+            self.location(self.params['page_to_location'] % p)
+            assert self.is_on_page(DisplayPage)
+            yield self.page.get_page(gallery)
+
+    def fill_image(self, image, fields):
+        if 'data' in fields:
+            image.data = self.readurl(image.url)
+
+
+class GenericComicReaderBackend(BaseBackend, ICapGallery):
+    NAME = 'genericcomicreader'
+    MAINTAINER = 'Noé Rubinstein'
+    EMAIL = 'noe.rubinstein@gmail.com'
+    VERSION = '0.9'
+    DESCRIPTION = 'Generic comic reader backend; subclasses implement specific sites'
+    LICENSE = 'AGPLv3+'
+    BROWSER = GenericComicReaderBrowser
+
+    def create_default_browser(self):
+        b = self.create_browser(self.BROWSER_PARAMS)
+        b.PAGES = self.PAGES
+        return b
+
+    def iter_gallery_images(self, gallery):
+        with self.browser:
+            return self.browser.iter_gallery_images(gallery)
+
+    def get_gallery(self, _id):
+        match = re.match(r'^%s$' % self.URL_REGEXP, _id)
+        if match:
+            _id = match.group(1)
+        else:
+            match = re.match(r'^%s$' % self.ID_REGEXP, _id)
+            if match:
+                _id = match.group(0)
+            else:
+                return None
+        
+        
+        gallery = BaseGallery(_id, url=(self.ID_TO_URL % _id))
+        with self.browser:
+            return gallery
+
+    def fill_gallery(self, gallery, fields):
+        gallery.title = gallery.id
+
+    def fill_image(self, image, fields):
+        with self.browser:
+            self.browser.fill_image(image, fields)
+
+    OBJECTS = {
+            BaseGallery: fill_gallery,
+            BaseImage: fill_image }
+