Rename type to protocol

couchpotato/core/downloaders/base.py

@@ -11,7 +11,7 @@ log = CPLog(__name__)
 
 class Downloader(Provider):
 
-    type = []
+    protocol = []
     http_time_between_calls = 0
 
     torrent_sources = [
@@ -36,16 +36,16 @@ class Downloader(Provider):
     def __init__(self):
         addEvent('download', self._download)
         addEvent('download.enabled', self._isEnabled)
-        addEvent('download.enabled_types', self.getEnabledDownloadType)
+        addEvent('download.enabled_protocols', self.getEnabledProtocol)
         addEvent('download.status', self._getAllDownloadStatus)
         addEvent('download.remove_failed', self._removeFailed)
         addEvent('download.pause', self._pause)
         addEvent('download.process_complete', self._processComplete)
 
-    def getEnabledDownloadType(self):
+    def getEnabledProtocol(self):
-        for download_type in self.type:
+        for download_protocol in self.protocol:
-            if self.isEnabled(manual = True, data = {'type': download_type}):
+            if self.isEnabled(manual = True, data = {'protocol': download_protocol}):
-                return self.type
+                return self.protocol
 
         return []
 
@@ -91,11 +91,11 @@ class Downloader(Provider):
     def processComplete(self, item, delete_files):
         return
 
-    def isCorrectType(self, item_type):
+    def isCorrectProtocol(self, item_protocol):
-        is_correct = item_type in self.type
+        is_correct = item_protocol in self.protocol
 
         if not is_correct:
-            log.debug("Downloader doesn't support this type")
+            log.debug("Downloader doesn't support this protocol")
 
         return is_correct
 
@@ -140,7 +140,7 @@ class Downloader(Provider):
         d_manual = self.conf('manual', default = False)
         return super(Downloader, self).isEnabled() and \
             ((d_manual and manual) or (d_manual is False)) and \
-            (not data or self.isCorrectType(data.get('type')))
+            (not data or self.isCorrectProtocol(data.get('protocol')))
 
     def _pause(self, item, pause = True):
         if self.isDisabled(manual = True, data = {}):

couchpotato/core/downloaders/blackhole/main.py

@@ -10,20 +10,20 @@ log = CPLog(__name__)
 
 class Blackhole(Downloader):
 
-    type = ['nzb', 'torrent', 'torrent_magnet']
+    protocol = ['nzb', 'torrent', 'torrent_magnet']
 
     def download(self, data = {}, movie = {}, filedata = None):
 
         directory = self.conf('directory')
         if not directory or not os.path.isdir(directory):
-            log.error('No directory set for blackhole %s download.', data.get('type'))
+            log.error('No directory set for blackhole %s download.', data.get('protocol'))
         else:
             try:
                 if not filedata or len(filedata) < 50:
                     try:
-                        if data.get('type') == 'torrent_magnet':
+                        if data.get('protocol') == 'torrent_magnet':
                             filedata = self.magnetToTorrent(data.get('url'))
-                            data['type'] = 'torrent'
+                            data['protocol'] = 'torrent'
                     except:
                         log.error('Failed download torrent via magnet url: %s', traceback.format_exc())
 
@@ -35,7 +35,7 @@ class Blackhole(Downloader):
 
                 try:
                     if not os.path.isfile(fullPath):
-                        log.info('Downloading %s to %s.', (data.get('type'), fullPath))
+                        log.info('Downloading %s to %s.', (data.get('protocol'), fullPath))
                         with open(fullPath, 'wb') as f:
                             f.write(filedata)
                         os.chmod(fullPath, Env.getPermission('file'))
@@ -54,20 +54,20 @@ class Blackhole(Downloader):
 
         return False
 
-    def getEnabledDownloadType(self):
+    def getEnabledProtocol(self):
         if self.conf('use_for') == 'both':
-            return super(Blackhole, self).getEnabledDownloadType()
+            return super(Blackhole, self).getEnabledProtocol()
         elif self.conf('use_for') == 'torrent':
             return ['torrent', 'torrent_magnet']
         else:
             return ['nzb']
 
     def isEnabled(self, manual, data = {}):
-        for_type = ['both']
+        for_protocol = ['both']
-        if data and 'torrent' in data.get('type'):
+        if data and 'torrent' in data.get('protocol'):
-            for_type.append('torrent')
+            for_protocol.append('torrent')
         elif data:
-            for_type.append(data.get('type'))
+            for_protocol.append(data.get('protocol'))
 
         return super(Blackhole, self).isEnabled(manual, data) and \
-            ((self.conf('use_for') in for_type))
+            ((self.conf('use_for') in for_protocol))

couchpotato/core/downloaders/nzbget/main.py

@@ -15,7 +15,7 @@ log = CPLog(__name__)
 
 class NZBGet(Downloader):
 
-    type = ['nzb']
+    protocol = ['nzb']
 
     url = 'http://%(username)s:%(password)s@%(host)s/xmlrpc'
 

couchpotato/core/downloaders/nzbvortex/main.py

@@ -19,7 +19,7 @@ log = CPLog(__name__)
 
 class NZBVortex(Downloader):
 
-    type = ['nzb']
+    protocol = ['nzb']
     api_level = None
     session_id = None
 

couchpotato/core/downloaders/pneumatic/main.py

@@ -9,7 +9,7 @@ log = CPLog(__name__)
 
 class Pneumatic(Downloader):
 
-    type = ['nzb']
+    protocol = ['nzb']
     strm_syntax = 'plugin://plugin.program.pneumatic/?mode=strm&type=add_file&nzb=%s&nzbname=%s'
 
     def download(self, data = {}, movie = {}, filedata = None):
@@ -27,7 +27,7 @@ class Pneumatic(Downloader):
 
                 try:
                     if not os.path.isfile(fullPath):
-                        log.info('Downloading %s to %s.', (data.get('type'), fullPath))
+                        log.info('Downloading %s to %s.', (data.get('protocol'), fullPath))
                         with open(fullPath, 'wb') as f:
                             f.write(filedata)
 

couchpotato/core/downloaders/sabnzbd/main.py

@@ -13,7 +13,7 @@ log = CPLog(__name__)
 
 class Sabnzbd(Downloader):
 
-    type = ['nzb']
+    protocol = ['nzb']
 
     def download(self, data = {}, movie = {}, filedata = None):
 

couchpotato/core/downloaders/synology/main.py

@@ -9,13 +9,13 @@ log = CPLog(__name__)
 
 class Synology(Downloader):
 
-    type = ['nzb', 'torrent', 'torrent_magnet']
+    protocol = ['nzb', 'torrent', 'torrent_magnet']
     log = CPLog(__name__)
 
     def download(self, data, movie, filedata = None):
 
         response = False
-        log.error('Sending "%s" (%s) to Synology.', (data['name'], data['type']))
+        log.error('Sending "%s" (%s) to Synology.', (data['name'], data['protocol']))
 
         # Load host from config and split out port.
         host = self.conf('host').split(':')
@@ -26,38 +26,38 @@ class Synology(Downloader):
         try:
             # Send request to Synology
             srpc = SynologyRPC(host[0], host[1], self.conf('username'), self.conf('password'))
-            if data['type'] == 'torrent_magnet':
+            if data['protocol'] == 'torrent_magnet':
                 log.info('Adding torrent URL %s', data['url'])
                 response = srpc.create_task(url = data['url'])
-            elif data['type'] in ['nzb', 'torrent']:
+            elif data['protocol'] in ['nzb', 'torrent']:
-                log.info('Adding %s' % data['type'])
+                log.info('Adding %s' % data['protocol'])
                 if not filedata:
-                    log.error('No %s data found' % data['type'])
+                    log.error('No %s data found' % data['protocol'])
                 else:
-                    filename = data['name'] + '.' + data['type']
+                    filename = data['name'] + '.' + data['protocol']
                     response = srpc.create_task(filename = filename, filedata = filedata)
         except Exception, err:
             log.error('Exception while adding torrent: %s', err)
         finally:
             return response
 
-    def getEnabledDownloadType(self):
+    def getEnabledProtocol(self):
         if self.conf('use_for') == 'both':
-            return super(Synology, self).getEnabledDownloadType()
+            return super(Synology, self).getEnabledProtocol()
         elif self.conf('use_for') == 'torrent':
             return ['torrent', 'torrent_magnet']
         else:
             return ['nzb']
 
     def isEnabled(self, manual, data = {}):
-        for_type = ['both']
+        for_protocol = ['both']
-        if data and 'torrent' in data.get('type'):
+        if data and 'torrent' in data.get('protocol'):
-            for_type.append('torrent')
+            for_protocol.append('torrent')
         elif data:
-            for_type.append(data.get('type'))
+            for_protocol.append(data.get('protocol'))
 
         return super(Synology, self).isEnabled(manual, data) and\
-               ((self.conf('use_for') in for_type))
+               ((self.conf('use_for') in for_protocol))
 
 class SynologyRPC(object):
 

couchpotato/core/downloaders/transmission/main.py

@@ -16,7 +16,7 @@ log = CPLog(__name__)
 
 class Transmission(Downloader):
 
-    type = ['torrent', 'torrent_magnet']
+    protocol = ['torrent', 'torrent_magnet']
     log = CPLog(__name__)
     trpc = None
 
@@ -34,12 +34,12 @@ class Transmission(Downloader):
 
     def download(self, data, movie, filedata = None):
 
-        log.info('Sending "%s" (%s) to Transmission.', (data.get('name'), data.get('type')))
+        log.info('Sending "%s" (%s) to Transmission.', (data.get('name'), data.get('protocol')))
 
         if not self.connect():
             return False
 
-        if not filedata and data.get('type') == 'torrent':
+        if not filedata and data.get('protocol') == 'torrent':
             log.error('Failed sending torrent, no data')
             return False
 
@@ -64,7 +64,7 @@ class Transmission(Downloader):
             torrent_params['seedIdleMode'] = 1
 
         # Send request to Transmission
-        if data.get('type') == 'torrent_magnet':
+        if data.get('protocol') == 'torrent_magnet':
             remote_torrent = self.trpc.add_torrent_uri(data.get('url'), arguments = params)
             torrent_params['trackerAdd'] = self.torrent_trackers
         else:

couchpotato/core/downloaders/utorrent/main.py

@@ -20,7 +20,7 @@ log = CPLog(__name__)
 
 class uTorrent(Downloader):
 
-    type = ['torrent', 'torrent_magnet']
+    protocol = ['torrent', 'torrent_magnet']
     utorrent_api = None
 
     def connect(self):
@@ -36,7 +36,7 @@ class uTorrent(Downloader):
 
     def download(self, data, movie, filedata = None):
 
-        log.debug('Sending "%s" (%s) to uTorrent.', (data.get('name'), data.get('type')))
+        log.debug('Sending "%s" (%s) to uTorrent.', (data.get('name'), data.get('protocol')))
 
         if not self.connect():
             return False
@@ -63,11 +63,11 @@ class uTorrent(Downloader):
         if self.conf('label'):
             torrent_params['label'] = self.conf('label')
 
-        if not filedata and data.get('type') == 'torrent':
+        if not filedata and data.get('protocol') == 'torrent':
             log.error('Failed sending torrent, no data')
             return False
 
-        if data.get('type') == 'torrent_magnet':
+        if data.get('protocol') == 'torrent_magnet':
             torrent_hash = re.findall('urn:btih:([\w]{32,40})', data.get('url'))[0].upper()
             torrent_params['trackers'] = '%0D%0A%0D%0A'.join(self.torrent_trackers)
         else:
@@ -88,7 +88,7 @@ class uTorrent(Downloader):
             torrent_hash = b16encode(b32decode(torrent_hash))
 
         # Send request to uTorrent
-        if data.get('type') == 'torrent_magnet':
+        if data.get('protocol') == 'torrent_magnet':
             self.utorrent_api.add_torrent_uri(data.get('url'))
         else:
             self.utorrent_api.add_torrent_file(torrent_filename, filedata)

couchpotato/core/media/_base/searcher/main.py

@@ -19,7 +19,7 @@ log = CPLog(__name__)
 class Searcher(SearcherBase):
 
     def __init__(self):
-        addEvent('searcher.get_types', self.getSearchTypes)
+        addEvent('searcher.protocols', self.getSearchProtocols)
         addEvent('searcher.contains_other_quality', self.containsOtherQuality)
         addEvent('searcher.correct_year', self.correctYear)
         addEvent('searcher.correct_name', self.correctName)
@@ -122,29 +122,29 @@ class Searcher(SearcherBase):
 
                 return True
 
-        log.info('Tried to download, but none of the "%s" downloaders are enabled or gave an error', (data.get('type', '')))
+        log.info('Tried to download, but none of the "%s" downloaders are enabled or gave an error', (data.get('protocol', '')))
 
         return False
 
-    def getSearchTypes(self):
+    def getSearchProtocols(self):
 
-        download_types = fireEvent('download.enabled_types', merge = True)
+        download_protocols = fireEvent('download.enabled_protocols', merge = True)
-        provider_types = fireEvent('provider.enabled_types', merge = True)
+        provider_protocols = fireEvent('provider.enabled_protocols', merge = True)
 
-        if download_types and len(list(set(provider_types) & set(download_types))) == 0:
+        if download_protocols and len(list(set(provider_protocols) & set(download_protocols))) == 0:
-            log.error('There aren\'t any providers enabled for your downloader (%s). Check your settings.', ','.join(download_types))
+            log.error('There aren\'t any providers enabled for your downloader (%s). Check your settings.', ','.join(download_protocols))
             return []
 
-        for useless_provider in list(set(provider_types) - set(download_types)):
+        for useless_provider in list(set(provider_protocols) - set(download_protocols)):
             log.debug('Provider for "%s" enabled, but no downloader.', useless_provider)
 
-        search_types = download_types
+        search_protocols = download_protocols
 
-        if len(search_types) == 0:
+        if len(search_protocols) == 0:
             log.error('There aren\'t any downloaders enabled. Please pick one in settings.')
             return []
 
-        return search_types
+        return search_protocols
 
     def containsOtherQuality(self, nzb, movie_year = None, preferred_quality = {}):
 

couchpotato/core/media/movie/searcher/main.py

@@ -85,7 +85,7 @@ class MovieSearcher(SearcherBase, MovieTypeBase):
         }
 
         try:
-            search_types = fireEvent('searcher.get_types', single = True)
+            search_protocols = fireEvent('searcher.protocols', single = True)
 
             for movie in movies:
                 movie_dict = movie.to_dict({
@@ -97,7 +97,7 @@ class MovieSearcher(SearcherBase, MovieTypeBase):
                 })
 
                 try:
-                    self.single(movie_dict, search_types)
+                    self.single(movie_dict, search_protocols)
                 except IndexError:
                     log.error('Forcing library update for %s, if you see this often, please report: %s', (movie_dict['library']['identifier'], traceback.format_exc()))
                     fireEvent('library.update', movie_dict['library']['identifier'], force = True)
@@ -115,12 +115,12 @@ class MovieSearcher(SearcherBase, MovieTypeBase):
 
         self.in_progress = False
 
-    def single(self, movie, search_types = None):
+    def single(self, movie, search_protocols = None):
 
         # Find out search type
         try:
-            if not search_types:
+            if not search_protocols:
-                search_types = fireEvent('searcher.get_types', single = True)
+                search_protocols = fireEvent('searcher.protocols', single = True)
         except SearchSetupError:
             return
 
@@ -168,10 +168,10 @@ class MovieSearcher(SearcherBase, MovieTypeBase):
                 quality = fireEvent('quality.single', identifier = quality_type['quality']['identifier'], single = True)
 
                 results = []
-                for search_type in search_types:
+                for search_protocol in search_protocols:
-                    type_results = fireEvent('%s.search' % search_type, movie, quality, merge = True)
+                    protocol_results = fireEvent('provider.search.%s.movie' % search_protocol, movie, quality, merge = True)
-                    if type_results:
+                    if protocol_results:
-                        results += type_results
+                        results += protocol_results
 
                 sorted_results = sorted(results, key = lambda k: k['score'], reverse = True)
                 if len(sorted_results) == 0:

couchpotato/core/providers/base.py

@@ -19,7 +19,7 @@ log = CPLog(__name__)
 
 class Provider(Plugin):
 
-    type = None # movie, nzb, torrent, subtitle, trailer
+    type = None # movie, show, subtitle, trailer, ...
     http_time_between_calls = 10 # Default timeout for url requests
 
     last_available_check = {}
@@ -79,7 +79,10 @@ class Provider(Plugin):
 
 class YarrProvider(Provider):
 
-    cat_ids = []
+    protocol = None # nzb, torrent, torrent_magnet
+
+    cat_ids = {}
+    cat_backup_id = None
 
     sizeGb = ['gb', 'gib']
     sizeMb = ['mb', 'mib']
@@ -89,14 +92,13 @@ class YarrProvider(Provider):
     last_login_check = 0
 
     def __init__(self):
-        addEvent('provider.enabled_types', self.getEnabledProviderType)
+        addEvent('provider.enabled_protocols', self.getEnabledProtocol)
         addEvent('provider.belongs_to', self.belongsTo)
-        addEvent('yarr.search', self.search)
+        addEvent('provider.search.%s.%s' % (self.protocol, self.type), self.search)
-        addEvent('%s.search' % self.type, self.search)
 
-    def getEnabledProviderType(self):
+    def getEnabledProtocol(self):
         if self.isEnabled():
-            return self.type
+            return self.protocol
         else:
             return []
 
@@ -273,6 +275,7 @@ class ResultList(list):
 
         defaults = {
             'id': 0,
+            'protocol': self.provider.protocol,
             'type': self.provider.type,
             'provider': self.provider.getName(),
             'download': self.provider.loginDownload if self.provider.urls.get('login') else self.provider.download,

couchpotato/core/providers/nzb/base.py

@@ -3,7 +3,8 @@ import time
 
 
 class NZBProvider(YarrProvider):
-    type = 'nzb'
+
+    protocol = 'nzb'
 
     def calculateAge(self, unix):
         return int(time.time() - unix) / 24 / 60 / 60

couchpotato/core/providers/torrent/base.py

@@ -7,7 +7,7 @@ log = CPLog(__name__)
 
 class TorrentProvider(YarrProvider):
 
-    type = 'torrent'
+    protocol = 'torrent'
 
     def imdbMatch(self, url, imdbId):
         if getImdb(url) == imdbId:
@@ -27,6 +27,6 @@ class TorrentProvider(YarrProvider):
 
 class TorrentMagnetProvider(TorrentProvider):
 
-    type = 'torrent_magnet'
+    protocol = 'torrent_magnet'
 
     download = None