Subliminal update

libs/subliminal/services/__init__.py

@@ -0,0 +1,214 @@
+# -*- coding: utf-8 -*-
+# Copyright 2011-2012 Antoine Bertin <diaoulael@gmail.com>
+#
+# This file is part of subliminal.
+#
+# subliminal is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# subliminal 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with subliminal.  If not, see <http://www.gnu.org/licenses/>.
+from ..exceptions import MissingLanguageError, DownloadFailedError
+import logging
+import os
+import requests
+import threading
+
+
+__all__ = ['ServiceBase', 'ServiceConfig']
+logger = logging.getLogger(__name__)
+
+
+class ServiceBase(object):
+    """Service base class
+
+    :param config: service configuration
+    :type config: :class:`ServiceConfig`
+
+    """
+    #: URL to the service server
+    server_url = ''
+
+    #: User Agent for any HTTP-based requests
+    user_agent = 'subliminal v0.5'
+
+    #: Whether based on an API or not
+    api_based = False
+
+    #: Timeout for web requests
+    timeout = 5
+
+    #: Lock for cache interactions
+    lock = threading.Lock()
+
+    #: Mapping to Service's language codes and subliminal's
+    languages = {}
+
+    #: Whether the mapping is reverted or not
+    reverted_languages = False
+
+    #: Accepted video classes (:class:`~subliminal.videos.Episode`, :class:`~subliminal.videos.Movie`, :class:`~subliminal.videos.UnknownVideo`)
+    videos = []
+
+    #: Whether the video has to exist or not
+    require_video = False
+
+    def __init__(self, config=None):
+        self.config = config or ServiceConfig()
+
+    def __enter__(self):
+        self.init()
+        return self
+
+    def __exit__(self, *args):
+        self.terminate()
+
+    def init(self):
+        """Initialize connection"""
+        logger.debug(u'Initializing %s' % self.__class__.__name__)
+        self.session = requests.session(timeout=10, headers={'User-Agent': self.user_agent})
+
+    def terminate(self):
+        """Terminate connection"""
+        logger.debug(u'Terminating %s' % self.__class__.__name__)
+
+    def query(self, *args):
+        """Make the actual query"""
+        pass
+
+    def list(self, video, languages):
+        """List subtitles"""
+        pass
+
+    def download(self, subtitle):
+        """Download a subtitle"""
+        self.download_file(subtitle.link, subtitle.path)
+
+    @classmethod
+    def available_languages(cls):
+        """Available languages in the Service
+
+        :return: available languages
+        :rtype: set
+
+        """
+        if not cls.reverted_languages:
+            return set(cls.languages.keys())
+        return set(cls.languages.values())
+
+    @classmethod
+    def check_validity(cls, video, languages):
+        """Check for video and languages validity in the Service
+
+        :param video: the video to check
+        :type video: :class:`~subliminal.videos.video`
+        :param set languages: languages to check
+        :rtype: bool
+
+        """
+        languages &= cls.available_languages()
+        if not languages:
+            logger.debug(u'No language available for service %s' % cls.__class__.__name__.lower())
+            return False
+        if not cls.is_valid_video(video):
+            logger.debug(u'%r is not valid for service %s' % (video, cls.__class__.__name__.lower()))
+            return False
+        return True
+
+    @classmethod
+    def is_valid_video(cls, video):
+        """Check if video is valid in the Service
+
+        :param video: the video to check
+        :type video: :class:`~subliminal.videos.Video`
+        :rtype: bool
+
+        """
+        if cls.require_video and not video.exists:
+            return False
+        if not isinstance(video, tuple(cls.videos)):
+            return False
+        return True
+
+    @classmethod
+    def is_valid_language(cls, language):
+        """Check if language is valid in the Service
+
+        :param string language: the language to check
+        :rtype: bool
+
+        """
+        if language in cls.available_languages():
+            return True
+        return False
+
+    @classmethod
+    def get_revert_language(cls, language):
+        """ISO-639-1 language code from service language code
+
+        :param string language: service language code
+        :return: ISO-639-1 language code
+        :rtype: string
+
+        """
+        if not cls.reverted_languages and language in cls.languages.values():
+            return [k for k, v in cls.languages.iteritems() if v == language][0]
+        if cls.reverted_languages and language in cls.languages.keys():
+            return cls.languages[language]
+        raise MissingLanguageError(language)
+
+    @classmethod
+    def get_language(cls, language):
+        """Service language code from ISO-639-1 language code
+
+        :param string language: ISO-639-1 language code
+        :return: service language code
+        :rtype: string
+
+        """
+        if not cls.reverted_languages and language in cls.languages.keys():
+            return cls.languages[language]
+        if cls.reverted_languages and language in cls.languages.values():
+            return [k for k, v in cls.languages.iteritems() if v == language][0]
+        raise MissingLanguageError(language)
+
+    def download_file(self, url, filepath):
+        """Attempt to download a file and remove it in case of failure
+
+        :param string url: URL to download
+        :param string filepath: destination path
+
+        """
+        logger.info(u'Downloading %s' % url)
+        try:
+            r = self.session.get(url, headers={'Referer': url, 'User-Agent': self.user_agent})
+            with open(filepath, 'wb') as f:
+                f.write(r.content)
+        except Exception as e:
+            logger.error(u'Download %s failed: %s' % (url, e))
+            if os.path.exists(filepath):
+                os.remove(filepath)
+            raise DownloadFailedError(str(e))
+        logger.debug(u'Download finished for file %s. Size: %s' % (filepath, os.path.getsize(filepath)))
+
+
+class ServiceConfig(object):
+    """Configuration for any :class:`Service`
+
+    :param bool multi: whether to download one subtitle per language or not
+    :param string cache_dir: cache directory
+
+    """
+    def __init__(self, multi=False, cache_dir=None):
+        self.multi = multi
+        self.cache_dir = cache_dir
+
+    def __repr__(self):
+        return 'ServiceConfig(%r, %s)' % (self.multi, self.cache_dir)