diff --git a/autoProcessMedia.cfg.spec b/autoProcessMedia.cfg.spec index 7af48e01..bcd6b528 100644 --- a/autoProcessMedia.cfg.spec +++ b/autoProcessMedia.cfg.spec @@ -355,7 +355,7 @@ default_downloadDirectory = [Torrent] - ###### clientAgent - Supported clients: utorrent, transmission, deluge, rtorrent, vuze, qbittorrent, other + ###### clientAgent - Supported clients: utorrent, transmission, deluge, rtorrent, vuze, qbittorrent, synods, other clientAgent = other ###### useLink - Set to hard for physical links, sym for symbolic links, move to move, move-sym to move and link back, and no to not use links (copy) useLink = hard @@ -386,6 +386,11 @@ qBittorrentPort = 8080 qBittorrentUSR = your username qBittorrentPWD = your password + ###### Synology Download Station (You must edit this if you're using TorrentToMedia.py with Synology DS) + synoHost = localhost + synoPort = 9091 + synoUSR = your username + synoPWD = your password ###### ADVANCED USE - ONLY EDIT IF YOU KNOW WHAT YOU'RE DOING ###### deleteOriginal = 0 chmodDirectory = 0 diff --git a/core/__init__.py b/core/__init__.py index 8cdcfeee..7198ab94 100644 --- a/core/__init__.py +++ b/core/__init__.py @@ -178,6 +178,11 @@ TRANSMISSION_PORT = None TRANSMISSION_USER = None TRANSMISSION_PASSWORD = None +SYNO_HOST = None +SYNO_PORT = None +SYNO_USER = None +SYNO_PASSWORD = None + DELUGE_HOST = None DELUGE_PORT = None DELUGE_USER = None diff --git a/core/plugins/downloaders/torrent/configuration.py b/core/plugins/downloaders/torrent/configuration.py index dd8e8ffa..e89c883f 100644 --- a/core/plugins/downloaders/torrent/configuration.py +++ b/core/plugins/downloaders/torrent/configuration.py @@ -11,7 +11,7 @@ from core.plugins.downloaders.torrent.utils import create_torrent_class def configure_torrents(config): torrent_config = config['Torrent'] - core.TORRENT_CLIENT_AGENT = torrent_config['clientAgent'] # utorrent | deluge | transmission | rtorrent | vuze | qbittorrent |other + core.TORRENT_CLIENT_AGENT = torrent_config['clientAgent'] # utorrent | deluge | transmission | rtorrent | vuze | qbittorrent | synods | other core.OUTPUT_DIRECTORY = torrent_config['outputDirectory'] # /abs/path/to/complete/ core.TORRENT_DEFAULT_DIRECTORY = torrent_config['default_downloadDirectory'] @@ -25,6 +25,7 @@ def configure_torrents(config): configure_transmission(torrent_config) configure_deluge(torrent_config) configure_qbittorrent(torrent_config) + configure_syno(torrent_config) def configure_torrent_linking(config): @@ -69,6 +70,13 @@ def configure_transmission(config): core.TRANSMISSION_PASSWORD = config['TransmissionPWD'] # mysecretpwr +def configure_syno(config): + core.SYNO_HOST = config['synoHost'] # localhost + core.SYNO_PORT = int(config['synoPort']) + core.SYNO_USER = config['synoUSR'] # mysecretusr + core.SYNO_PASSWORD = config['synoPWD'] # mysecretpwr + + def configure_deluge(config): core.DELUGE_HOST = config['DelugeHost'] # localhost core.DELUGE_PORT = int(config['DelugePort']) # 8084 diff --git a/core/plugins/downloaders/torrent/synology.py b/core/plugins/downloaders/torrent/synology.py new file mode 100644 index 00000000..68860629 --- /dev/null +++ b/core/plugins/downloaders/torrent/synology.py @@ -0,0 +1,27 @@ +from __future__ import ( + absolute_import, + division, + print_function, + unicode_literals, +) + +from syno.downloadstation import DownloadStation + +import core +from core import logger + + +def configure_client(): + agent = 'synology' + host = core.SYNO_HOST + port = core.SYNO_PORT + user = core.SYNO_USER + password = core.SYNO_PASSWORD + + logger.debug('Connecting to {0}: http://{1}:{2}'.format(agent, host, port)) + try: + client = DownloadStation(host, port, user, password) + except Exception: + logger.error('Failed to connect to synology') + else: + return client diff --git a/core/plugins/downloaders/torrent/utils.py b/core/plugins/downloaders/torrent/utils.py index 0d2896d7..f1a3cba1 100644 --- a/core/plugins/downloaders/torrent/utils.py +++ b/core/plugins/downloaders/torrent/utils.py @@ -14,12 +14,14 @@ from .deluge import configure_client as deluge_client from .qbittorrent import configure_client as qbittorrent_client from .transmission import configure_client as transmission_client from .utorrent import configure_client as utorrent_client +from .synology import configure_client as synology_client torrent_clients = { 'deluge': deluge_client, 'qbittorrent': qbittorrent_client, 'transmission': transmission_client, 'utorrent': utorrent_client, + 'synods': synology_client, } @@ -39,6 +41,8 @@ def pause_torrent(client_agent, input_hash, input_id, input_name): core.TORRENT_CLASS.stop(input_hash) if client_agent == 'transmission' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.stop_torrent(input_id) + if client_agent == 'synods' and core.TORRENT_CLASS != '': + core.TORRENT_CLASS.pause_task(input_id) if client_agent == 'deluge' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.core.pause_torrent([input_id]) if client_agent == 'qbittorrent' and core.TORRENT_CLASS != '': @@ -57,6 +61,8 @@ def resume_torrent(client_agent, input_hash, input_id, input_name): core.TORRENT_CLASS.start(input_hash) if client_agent == 'transmission' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.start_torrent(input_id) + if client_agent == 'synods' and core.TORRENT_CLASS != '': + core.TORRENT_CLASS.resume_task(input_id) if client_agent == 'deluge' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.core.resume_torrent([input_id]) if client_agent == 'qbittorrent' and core.TORRENT_CLASS != '': @@ -75,6 +81,8 @@ def remove_torrent(client_agent, input_hash, input_id, input_name): core.TORRENT_CLASS.remove(input_hash) if client_agent == 'transmission' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.remove_torrent(input_id, True) + if client_agent == 'synods' and core.TORRENT_CLASS != '': + core.TORRENT_CLASS.delete_task(input_id) if client_agent == 'deluge' and core.TORRENT_CLASS != '': core.TORRENT_CLASS.core.remove_torrent(input_id, True) if client_agent == 'qbittorrent' and core.TORRENT_CLASS != '': diff --git a/core/utils/parsers.py b/core/utils/parsers.py index eff4b3e9..2fc5f070 100644 --- a/core/utils/parsers.py +++ b/core/utils/parsers.py @@ -8,6 +8,7 @@ from __future__ import ( import os import core +from core import logger def parse_other(args): @@ -81,6 +82,36 @@ def parse_transmission(args): return input_directory, input_name, input_category, input_hash, input_id +def parse_synods(args): + # Synology/Transmission usage: call TorrenToMedia.py (%TR_TORRENT_DIR% %TR_TORRENT_NAME% is passed on as environmental variables) + input_directory = '' + input_id = '' + input_category = '' + input_name = os.getenv('TR_TORRENT_NAME') + input_hash = os.getenv('TR_TORRENT_HASH') + if not input_name: # No info passed. Assume manual download. + return input_directory, input_name, input_category, input_hash, input_id + input_id = 'dbid_'.format(os.getenv('TR_TORRENT_ID')) + #res = core.TORRENT_CLASS.tasks_list(additional_param='detail') + res = core.TORRENT_CLASS.tasks_info(input_id, additional_param='detail') + logger.debug('result from syno {0}'.format(res)) + if res['success']: + try: + tasks = res['data']['tasks'] + task = [ task for task in tasks if task['id'] == input_id ][0] + input_id = task['id'] + input_directory = task['additional']['detail']['destination'] + except: + logger.error('unable to find download details in Synology DS') + #Syno paths appear to be relative. Let's test to see if the returned path exists, and if not append to /volume1/ + if not os.path.isdir(input_directory): + for root in ['/volume1/', '/volume2/', '/volume3/', '/volume4/']: + if os.path.isdir(os.path.join(root, input_directory)): + input_directory = os.path.join(root, input_directory) + break + return input_directory, input_name, input_category, input_hash, input_id + + def parse_vuze(args): # vuze usage: C:\full\path\to\nzbToMedia\TorrentToMedia.py '%D%N%L%I%K%F' try: @@ -159,6 +190,7 @@ def parse_args(client_agent, args): 'transmission': parse_transmission, 'qbittorrent': parse_qbittorrent, 'vuze': parse_vuze, + 'synods': parse_synods, } try: diff --git a/libs/custom/syno/__init__.py b/libs/custom/syno/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/libs/custom/syno/auth.py b/libs/custom/syno/auth.py new file mode 100644 index 00000000..ef8d2f8e --- /dev/null +++ b/libs/custom/syno/auth.py @@ -0,0 +1,124 @@ +import requests + + +class Authentication: + def __init__(self, ip_address, port, username, password): + self._ip_address = ip_address + self._port = port + self._username = username + self._password = password + self._sid = None + self._session_expire = True + self._base_url = 'http://%s:%s/webapi/' % (self._ip_address, self._port) + + self.full_api_list = {} + self.app_api_list = {} + + def login(self, application): + login_api = 'auth.cgi?api=SYNO.API.Auth' + param = {'version': '2', 'method': 'login', 'account': self._username, + 'passwd': self._password, 'session': application, 'format': 'cookie'} + + if not self._session_expire: + if self._sid is not None: + self._session_expire = False + return 'User already logged' + else: + session_request = requests.get(self._base_url + login_api, param) + self._sid = session_request.json()['data']['sid'] + self._session_expire = False + return 'User logging... New session started!' + + def logout(self, application): + logout_api = 'auth.cgi?api=SYNO.API.Auth' + param = {'version': '2', 'method': 'logout', 'session': application} + + response = requests.get(self._base_url + logout_api, param) + if response.json()['success'] is True: + self._session_expire = True + self._sid = None + return 'Logged out' + else: + self._session_expire = True + self._sid = None + return 'No valid session is open' + + def get_api_list(self, app=None): + query_path = 'query.cgi?api=SYNO.API.Info' + list_query = {'version': '1', 'method': 'query', 'query': 'all'} + + response = requests.get(self._base_url + query_path, list_query).json() + + if app is not None: + for key in response['data']: + if app.lower() in key.lower(): + self.app_api_list[key] = response['data'][key] + else: + self.full_api_list = response['data'] + + return + + def show_api_name_list(self): + prev_key = '' + for key in self.full_api_list: + if key != prev_key: + print(key) + prev_key = key + return + + def show_json_response_type(self): + for key in self.full_api_list: + for sub_key in self.full_api_list[key]: + if sub_key == 'requestFormat': + if self.full_api_list[key]['requestFormat'] == 'JSON': + print(key + ' Returns JSON data') + return + + def search_by_app(self, app): + print_check = 0 + for key in self.full_api_list: + if app.lower() in key.lower(): + print(key) + print_check += 1 + continue + if print_check == 0: + print('Not Found') + return + + def request_data(self, api_name, api_path, req_param, method=None, response_json=True): # 'post' or 'get' + + # Convert all booleen in string in lowercase because Synology API is waiting for "true" or "false" + for k,v in req_param.items(): + if isinstance(v, bool): + req_param[k] = str(v).lower() + + if method is None: + method = 'get' + + req_param['_sid'] = self._sid + + if method is 'get': + url = ('%s%s' % (self._base_url, api_path)) + '?api=' + api_name + response = requests.get(url, req_param) + + if response_json is True: + return response.json() + else: + return response + + elif method is 'post': + url = ('%s%s' % (self._base_url, api_path)) + '?api=' + api_name + response = requests.post(url, req_param) + + if response_json is True: + return response.json() + else: + return response + + @property + def sid(self): + return self._sid + + @property + def base_url(self): + return self._base_url \ No newline at end of file diff --git a/libs/custom/syno/downloadstation.py b/libs/custom/syno/downloadstation.py new file mode 100644 index 00000000..b7021368 --- /dev/null +++ b/libs/custom/syno/downloadstation.py @@ -0,0 +1,276 @@ +from . import auth as syn + + +class DownloadStation: + + def __init__(self, ip_address, port, username, password): + + self.session = syn.Authentication(ip_address, port, username, password) + self._bt_search_id = '' + self._bt_search_id_list = [] + self.session.login('DownloadStation') + self.session.get_api_list('DownloadStation') + + self.request_data = self.session.request_data + self.download_list = self.session.app_api_list + self._sid = self.session.sid + self.base_url = self.session.base_url + + print('You are now logged in!') + + def logout(self): + self.session.logout('DownloadStation') + + def get_info(self): + api_name = 'SYNO.DownloadStation.Info' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'getinfo'} + + return self.request_data(api_name, api_path, req_param) + + def get_config(self): + api_name = 'SYNO.DownloadStation.Info' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'getconfig'} + + return self.request_data(api_name, api_path, req_param) + + def set_server_config(self, bt_max_download=None, bt_max_upload=None, emule_max_download=None, + emule_max_upload=None, nzb_max_download=None, http_max_download=None, ftp_max_download=None, + emule_enabled=None, unzip_service_enabled=None, default_destination=None, + emule_default_destination=None): + + api_name = 'SYNO.DownloadStation.Info' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'setserverconfig'} + + for key, val in locals().items(): + if key not in ['self', 'api_name', 'info', 'api_path', 'req_param']: + if val is not None: + req_param[str(key)] = val + + return self.request_data(api_name, api_path, req_param) + + def schedule_info(self): + api_name = 'SYNO.DownloadStation.Schedule' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'getconfig'} + + return self.request_data(api_name, api_path, req_param) + + def schedule_set_config(self, enabled=False, emule_enabled=False): + api_name = 'SYNO.DownloadStation.Schedule' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'setconfig', 'enabled': str(enabled).lower(), + 'emule_enabled': str(emule_enabled).lower()} + + if type(enabled) is not bool or type(emule_enabled) is not bool: + return 'Please set enabled to True or False' + + return self.request_data(api_name, api_path, req_param) + + def tasks_list(self, additional_param=None): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'list', 'additional': additional_param} + + if additional_param is None: + additional_param = ['detail', 'transfer', 'file', 'tracker', 'peer'] + + if type(additional_param) is list: + req_param['additional'] = ",".join(additional_param) + + return self.request_data(api_name, api_path, req_param) + + def tasks_info(self, task_id, additional_param=None): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + req_param = {'version': info['maxVersion'], 'method': 'getinfo', 'id': task_id, 'additional': additional_param} + + if additional_param is None: + additional_param = ['detail', 'transfer', 'file', 'tracker', 'peer'] + + if type(additional_param) is list: + req_param['additional'] = ",".join(additional_param) + + if type(task_id) is list: + req_param['id'] = ",".join(task_id) + + return self.request_data(api_name, api_path, req_param) + + def delete_task(self, task_id, force=False): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'delete', 'id': task_id, + 'force_complete': str(force).lower()} + + if type(task_id) is list: + param['id'] = ",".join(task_id) + + return self.request_data(api_name, api_path, param) + + def pause_task(self, task_id): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'pause', 'id': task_id} + + if type(task_id) is list: + param['id'] = ",".join(task_id) + + return self.request_data(api_name, api_path, param) + + def resume_task(self, task_id): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'resume', 'id': task_id} + + if type(task_id) is list: + param['id'] = ",".join(task_id) + + return self.request_data(api_name, api_path, param) + + def edit_task(self, task_id, destination='sharedfolder'): + api_name = 'SYNO.DownloadStation.Task' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'edit', 'id': task_id, 'destination': destination} + + if type(task_id) is list: + param['id'] = ",".join(task_id) + + return self.request_data(api_name, api_path, param) + + def get_statistic_info(self): + api_name = 'SYNO.DownloadStation.Statistic' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'getinfo'} + + return self.request_data(api_name, api_path, param) + + def get_rss_info_list(self, offset=None, limit=None): + api_name = 'SYNO.DownloadStation.RSS.Site' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'list'} + + if offset is not None: + param['offset'] = offset + if limit is not None: + param['limit'] = limit + + return self.request_data(api_name, api_path, param) + + def refresh_rss_site(self, rss_id=None): + api_name = 'SYNO.DownloadStation.RSS.Site' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'refresh', 'id': rss_id} + + if rss_id is None: + return 'Enter a valid ID check if you have any with get_rss_list()' + elif type(rss_id) is list: + rss_id = ','.join(rss_id) + param['id'] = rss_id + + return self.request_data(api_name, api_path, param) + + def rss_feed_list(self, rss_id=None, offset=None, limit=None): + api_name = 'SYNO.DownloadStation.RSS.Feed' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'list', 'id': rss_id} + + if rss_id is None: + return 'Enter a valid ID check if you have any with get_rss_list()' + elif type(rss_id) is list: + rss_id = ','.join(rss_id) + param['id'] = rss_id + + if offset is not None: + param['offset'] = offset + if limit is not None: + param['limit'] = limit + + return self.request_data(api_name, api_path, param) + + def start_bt_search(self, keyword=None, module='all'): + api_name = 'SYNO.DownloadStation.BTSearch' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'start'} + + if keyword is None: + return 'Did you enter a keyword to search?' + else: + param['keyword'] = keyword + + param['module'] = module + + self._bt_search_id = self.request_data(api_name, api_path, param)['data']['taskid'] + + self._bt_search_id_list.append(self._bt_search_id) + + return 'You can now check the status of request with get_bt_search_results(), your id is: ' + self._bt_search_id + + def get_bt_search_results(self, taskid=None, offset=None, limit=None, sort_by=None, sort_direction=None, + filter_category=None, filter_title=None): + api_name = 'SYNO.DownloadStation.BTSearch' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'list', 'taskid': taskid} + + for key, val in locals().items(): + if key not in ['self', 'api_name', 'info', 'api_path', 'param', 'taskid']: + if val is not None: + param[str(key)] = val + + if taskid is None: + return 'Enter a valid taskid, you can choose one of ' + str(self._bt_search_id_list) + elif type(taskid) is list: + param['taskid'] = ','.join(taskid) + + return self.request_data(api_name, api_path, param) + + def get_bt_search_category(self): + api_name = 'SYNO.DownloadStation.BTSearch' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'get'} + + return self.request_data(api_name, api_path, param) + + def clean_bt_search(self, taskid=None): + api_name = 'SYNO.DownloadStation.BTSearch' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'clean', 'taskid': taskid} + + if taskid is None: + return 'Enter a valid taskid, you can choose one of ' + str(self._bt_search_id_list) + elif type(taskid) is list: + param['taskid'] = ','.join(taskid) + for item in taskid: + self._bt_search_id_list.remove(item) + else: + self._bt_search_id_list.remove(taskid) + + return self.request_data(api_name, api_path, param) + + def get_bt_module(self): + api_name = 'SYNO.DownloadStation.BTSearch' + info = self.download_list[api_name] + api_path = info['path'] + param = {'version': info['maxVersion'], 'method': 'getModule'} + + return self.request_data(api_name, api_path, param)