mirror of
https://github.com/clinton-hall/nzbToMedia.git
synced 2025-08-14 10:36:52 -07:00
Syno ds patch 1 (#1702)
* Add Syno DS parsing #1671 as per https://forum.synology.com/enu/viewtopic.php?f=38&t=92856 * add config guidance * add syno client
This commit is contained in:
Clinton Hall
GitHub
parent
0827c5bafe
commit
b793ce7933
9 changed files with 487 additions and 2 deletions
0
libs/custom/syno/__init__.py
Normal file
0
libs/custom/syno/__init__.py
Normal file
124
libs/custom/syno/auth.py
Normal file
124
libs/custom/syno/auth.py
Normal file
|
|
@ -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
|
||||
276
libs/custom/syno/downloadstation.py
Normal file
276
libs/custom/syno/downloadstation.py
Normal file
|
|
@ -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)
|
||||
Loading…
Add table
Add a link
Reference in a new issue