# -*- coding: utf-8 -*- # Copyright (c) 2008-2010 Erik Svensson # Licensed under the MIT license. import os, re, time import warnings import httplib, urllib2, urlparse, base64 try: import json except ImportError: import simplejson as json from transmissionrpc.constants import DEFAULT_PORT, DEFAULT_TIMEOUT from transmissionrpc.error import TransmissionError, HTTPHandlerError from transmissionrpc.utils import LOGGER, get_arguments, make_rpc_name, argument_value_convert, rpc_bool from transmissionrpc.httphandler import DefaultHTTPHandler from transmissionrpc.torrent import Torrent from transmissionrpc.session import Session def debug_httperror(error): """ Log the Transmission RPC HTTP error. """ try: data = json.loads(error.data) except ValueError: data = error.data LOGGER.debug( json.dumps( { 'response': { 'url': error.url, 'code': error.code, 'msg': error.message, 'headers': error.headers, 'data': data, } }, indent=2 ) ) """ Torrent ids Many functions in Client takes torrent id. A torrent id can either be id or hashString. When suppling multiple id's it is possible to use a list mixed with both id and hashString. Timeouts Since most methods results in HTTP requests against Transmission, it is possible to provide a argument called ``timeout``. Timeout is only effective when using Python 2.6 or later and the default timeout is 30 seconds. """ class Client(object): """ Client is the class handling the Transmission JSON-RPC client protocol. """ def __init__(self, address='localhost', port=DEFAULT_PORT, user=None, password=None, http_handler=None, timeout=None): if isinstance(timeout, (int, long, float)): self._query_timeout = float(timeout) else: self._query_timeout = DEFAULT_TIMEOUT urlo = urlparse.urlparse(address) if urlo.scheme == '': base_url = 'http://' + address + ':' + str(port) self.url = base_url + '/transmission/rpc' else: if urlo.port: self.url = urlo.scheme + '://' + urlo.hostname + ':' + str(urlo.port) + urlo.path else: self.url = urlo.scheme + '://' + urlo.hostname + urlo.path LOGGER.info('Using custom URL "' + self.url + '".') if urlo.username and urlo.password: user = urlo.username password = urlo.password elif urlo.username or urlo.password: LOGGER.warning('Either user or password missing, not using authentication.') if http_handler == None: self.http_handler = DefaultHTTPHandler() else: if hasattr(http_handler, 'set_authentication') and hasattr(http_handler, 'request'): self.http_handler = http_handler else: raise ValueError('Invalid HTTP handler.') if user and password: self.http_handler.set_authentication(self.url, user, password) elif user or password: LOGGER.warning('Either user or password missing, not using authentication.') self._sequence = 0 self.session = Session() self.session_id = 0 self.server_version = None self.protocol_version = None self.get_session() self.torrent_get_arguments = get_arguments('torrent-get' , self.rpc_version) def _get_timeout(self): """ Get current timeout for HTTP queries. """ return self._query_timeout def _set_timeout(self, value): """ Set timeout for HTTP queries. """ self._query_timeout = float(value) def _del_timeout(self): """ Reset the HTTP query timeout to the default. """ self._query_timeout = DEFAULT_TIMEOUT timeout = property(_get_timeout, _set_timeout, _del_timeout, doc="HTTP query timeout.") def _http_query(self, query, timeout=None): """ Query Transmission through HTTP. """ headers = {'x-transmission-session-id': str(self.session_id)} request_count = 0 if timeout == None: timeout = self._query_timeout while True: LOGGER.debug(json.dumps({'url': self.url, 'headers': headers, 'query': query, 'timeout': timeout}, indent=2)) try: result = self.http_handler.request(self.url, query, headers, timeout) break except HTTPHandlerError, error: if error.code == 409: LOGGER.info('Server responded with 409, trying to set session-id.') if request_count > 1: raise TransmissionError('Session ID negotiation failed.', error) if 'x-transmission-session-id' in error.headers: self.session_id = error.headers['x-transmission-session-id'] headers = {'x-transmission-session-id': str(self.session_id)} else: debug_httperror(error) raise TransmissionError('Unknown conflict.', error) else: debug_httperror(error) raise TransmissionError('Request failed.', error) request_count = request_count + 1 return result def _request(self, method, arguments=None, ids=None, require_ids=False, timeout=None): """ Send json-rpc request to Transmission using http POST """ if not isinstance(method, (str, unicode)): raise ValueError('request takes method as string') if arguments == None: arguments = {} if not isinstance(arguments, dict): raise ValueError('request takes arguments as dict') ids = self._format_ids(ids) if len(ids) > 0: arguments['ids'] = ids elif require_ids: raise ValueError('request require ids') query = json.dumps({'tag': self._sequence, 'method': method , 'arguments': arguments}) self._sequence += 1 start = time.time() http_data = self._http_query(query, timeout) elapsed = time.time() - start LOGGER.info('http request took %.3f s' % (elapsed)) try: data = json.loads(http_data) except ValueError, error: LOGGER.error('Error: ' + str(error)) LOGGER.error('Request: \"%s\"' % (query)) LOGGER.error('HTTP data: \"%s\"' % (http_data)) raise LOGGER.debug(json.dumps(data, indent=2)) if 'result' in data: if data['result'] != 'success': raise TransmissionError('Query failed with result \"%s\".' % (data['result'])) else: raise TransmissionError('Query failed without result.') results = {} if method == 'torrent-get': for item in data['arguments']['torrents']: results[item['id']] = Torrent(self, item) if self.protocol_version == 2 and 'peers' not in item: self.protocol_version = 1 elif method == 'torrent-add': item = data['arguments']['torrent-added'] results[item['id']] = Torrent(self, item) elif method == 'session-get': self._update_session(data['arguments']) elif method == 'session-stats': # older versions of T has the return data in "session-stats" if 'session-stats' in data['arguments']: self._update_session(data['arguments']['session-stats']) else: self._update_session(data['arguments']) elif method in ('port-test', 'blocklist-update'): results = data['arguments'] else: return None return results def _format_ids(self, args): """ Take things and make them valid torrent identifiers """ ids = [] if args == None: pass elif isinstance(args, (int, long)): ids.append(args) elif isinstance(args, (str, unicode)): for item in re.split(u'[ ,]+', args): if len(item) == 0: continue addition = None try: # handle index addition = [int(item)] except ValueError: pass if not addition: # handle hashes try: int(item, 16) addition = [item] except ValueError: pass if not addition: # handle index ranges i.e. 5:10 match = re.match(u'^(\d+):(\d+)$', item) if match: try: idx_from = int(match.group(1)) idx_to = int(match.group(2)) addition = range(idx_from, idx_to + 1) except ValueError: pass if not addition: raise ValueError(u'Invalid torrent id, \"%s\"' % item) ids.extend(addition) elif isinstance(args, (list)): for item in args: ids.extend(self._format_ids(item)) else: raise ValueError(u'Invalid torrent id') return ids def _update_session(self, data): """ Update session data. """ self.session.update(data) def _update_server_version(self): if self.server_version == None: version_major = 1 version_minor = 30 version_changeset = 0 version_parser = re.compile('(\d).(\d+) \((\d+)\)') if hasattr(self.session, 'version'): match = version_parser.match(self.session.version) if (match): version_major = int(match.group(1)) version_minor = int(match.group(2)) version_changeset = match.group(3) self.server_version = (version_major, version_minor, version_changeset) @property def rpc_version(self): """ Get the Transmission RPC version. Trying to deduct if the server don't have a version value. """ if self.protocol_version == None: # Ugly fix for 2.12 reporting rpc-version 10, but having new arguments if (self.server_version and (self.server_version[0] == 2 and self.server_version[1] == 12)): self.protocol_version = 11 elif hasattr(self.session, 'rpc_version'): self.protocol_version = self.session.rpc_version elif hasattr(self.session, 'version'): self.protocol_version = 3 else: self.protocol_version = 2 return self.protocol_version def _rpc_version_warning(self, version): """ Add a warning to the log if the Transmission RPC version is lower then the provided version. """ if self.rpc_version < version: LOGGER.warning('Using feature not supported by server. RPC version for server %d, feature introduced in %d.' % (self.rpc_version, version)) def add(self, data, timeout=None, **kwargs): """ Add torrent to transfers list. Takes a base64 encoded .torrent file in data. Additional arguments are: ===================== ==== ============================================================= Argument RPC Description ===================== ==== ============================================================= ``bandwidthPriority`` 8 - Priority for this transfer. ``download_dir`` 1 - The directory where the downloaded contents will be saved in. ``filename`` 1 - A filepath or URL to a torrent file or a magnet link. ``files_unwanted`` 1 - A list of file id's that shouldn't be downloaded. ``files_wanted`` 1 - A list of file id's that should be downloaded. ``metainfo`` 1 - The content of a torrent file, base64 encoded. ``paused`` 1 - If True, does not start the transfer when added. ``peer_limit`` 1 - Maximum number of peers allowed. ``priority_high`` 1 - A list of file id's that should have high priority. ``priority_low`` 1 - A list of file id's that should have low priority. ``priority_normal`` 1 - A list of file id's that should have normal priority. ===================== ==== ============================================================= """ args = {} if data: args = {'metainfo': data} elif 'metainfo' not in kwargs and 'filename' not in kwargs: raise ValueError('No torrent data or torrent uri.') for key, value in kwargs.iteritems(): argument = make_rpc_name(key) (arg, val) = argument_value_convert('torrent-add', argument, value, self.rpc_version) args[arg] = val return self._request('torrent-add', args, timeout=timeout) def add_uri(self, uri, **kwargs): """ Add torrent to transfers list. Takes a uri to a torrent, supporting all uri's supported by Transmissions torrent-add 'filename' argument. Additional arguments are: ===================== ==== ============================================================= Argument RPC Description ===================== ==== ============================================================= ``bandwidthPriority`` 8 - Priority for this transfer. ``download_dir`` 1 - The directory where the downloaded contents will be saved in. ``files_unwanted`` 1 - A list of file id's that shouldn't be downloaded. ``files_wanted`` 1 - A list of file id's that should be downloaded. ``paused`` 1 - If True, does not start the transfer when added. ``peer_limit`` 1 - Maximum number of peers allowed. ``priority_high`` 1 - A list of file id's that should have high priority. ``priority_low`` 1 - A list of file id's that should have low priority. ``priority_normal`` 1 - A list of file id's that should have normal priority. ===================== ==== ============================================================= """ if uri == None: raise ValueError('add_uri requires a URI.') # there has been some problem with T's built in torrent fetcher, # use a python one instead parseduri = urlparse.urlparse(uri) torrent_data = None if parseduri.scheme in ['file', 'ftp', 'ftps', 'http', 'https']: torrent_file = urllib2.urlopen(uri) torrent_data = base64.b64encode(torrent_file.read()) if torrent_data: return self.add(torrent_data, **kwargs) else: return self.add(None, filename=uri, **kwargs) def remove(self, ids, delete_data=False, timeout=None): """ remove torrent(s) with provided id(s). Local data is removed if delete_data is True, otherwise not. """ self._rpc_version_warning(3) self._request('torrent-remove', {'delete-local-data':rpc_bool(delete_data)}, ids, True, timeout=timeout) def start(self, ids, timeout=None): """start torrent(s) with provided id(s)""" self._request('torrent-start', {}, ids, True, timeout=timeout) def stop(self, ids, timeout=None): """stop torrent(s) with provided id(s)""" self._request('torrent-stop', {}, ids, True, timeout=timeout) def verify(self, ids, timeout=None): """verify torrent(s) with provided id(s)""" self._request('torrent-verify', {}, ids, True, timeout=timeout) def reannounce(self, ids, timeout=None): """Reannounce torrent(s) with provided id(s)""" self._rpc_version_warning(5) self._request('torrent-reannounce', {}, ids, True, timeout=timeout) def info(self, ids=None, arguments=None, timeout=None): """Get detailed information for torrent(s) with provided id(s).""" if not arguments: arguments = self.torrent_get_arguments return self._request('torrent-get', {'fields': arguments}, ids, timeout=timeout) def get_files(self, ids=None, timeout=None): """ Get list of files for provided torrent id(s). If ids is empty, information for all torrents are fetched. This function returns a dictonary for each requested torrent id holding the information about the files. :: { : { : { 'name': , 'size': , 'completed': , 'priority': , 'selected': } ... } ... } """ fields = ['id', 'name', 'hashString', 'files', 'priorities', 'wanted'] request_result = self._request('torrent-get', {'fields': fields}, ids, timeout=timeout) result = {} for tid, torrent in request_result.iteritems(): result[tid] = torrent.files() return result def set_files(self, items, timeout=None): """ Set file properties. Takes a dictonary with similar contents as the result of `get_files`. :: { : { : { 'priority': , 'selected': } ... } ... } """ if not isinstance(items, dict): raise ValueError('Invalid file description') for tid, files in items.iteritems(): if not isinstance(files, dict): continue wanted = [] unwanted = [] priority_high = [] priority_normal = [] priority_low = [] for fid, file_desc in files.iteritems(): if not isinstance(file_desc, dict): continue if 'selected' in file_desc and file_desc['selected']: wanted.append(fid) else: unwanted.append(fid) if 'priority' in file_desc: if file_desc['priority'] == 'high': priority_high.append(fid) elif file_desc['priority'] == 'normal': priority_normal.append(fid) elif file_desc['priority'] == 'low': priority_low.append(fid) self.change([tid], files_wanted = wanted , files_unwanted = unwanted , priority_high = priority_high , priority_normal = priority_normal , priority_low = priority_low, timeout=timeout) def list(self, timeout=None): """list all torrents""" fields = ['id', 'hashString', 'name', 'sizeWhenDone', 'leftUntilDone' , 'eta', 'status', 'rateUpload', 'rateDownload', 'uploadedEver' , 'downloadedEver'] return self._request('torrent-get', {'fields': fields}, timeout=timeout) def change(self, ids, timeout=None, **kwargs): """ Change torrent parameters for the torrent(s) with the supplied id's. The parameters are: ============================ ===== =============== ======================================================================================= Argument RPC Replaced by Description ============================ ===== =============== ======================================================================================= ``bandwidthPriority`` 5 - Priority for this transfer. ``downloadLimit`` 5 - Set the speed limit for download in Kib/s. ``downloadLimited`` 5 - Enable download speed limiter. ``files_unwanted`` 1 - A list of file id's that shouldn't be downloaded. ``files_wanted`` 1 - A list of file id's that should be downloaded. ``honorsSessionLimits`` 5 - Enables or disables the transfer to honour the upload limit set in the session. ``ids`` 1 - Local download location. ``peer_limit`` 1 - The peer limit for the torrents. ``priority_high`` 1 - A list of file id's that should have high priority. ``priority_low`` 1 - A list of file id's that should have normal priority. ``priority_normal`` 1 - A list of file id's that should have low priority. ``seedIdleLimit`` 10 - Seed inactivity limit in minutes. ``seedIdleMode`` 10 - Seed inactivity mode. 0 = Use session limit, 1 = Use transfer limit, 2 = Disable limit. ``seedRatioLimit`` 5 - Seeding ratio. ``seedRatioMode`` 5 - Which ratio to use. 0 = Use session limit, 1 = Use transfer limit, 2 = Disable limit. ``speed_limit_down`` 1 - 5 downloadLimit Set the speed limit for download in Kib/s. ``speed_limit_down_enabled`` 1 - 5 downloadLimited Enable download speed limiter. ``speed_limit_up`` 1 - 5 uploadLimit Set the speed limit for upload in Kib/s. ``speed_limit_up_enabled`` 1 - 5 uploadLimited Enable upload speed limiter. ``trackerAdd`` 10 - Array of string with announce URLs to add. ``trackerRemove`` 10 - Array of ids of trackers to remove. ``trackerReplace`` 10 - Array of (id, url) tuples where the announce URL should be replaced. ``uploadLimit`` 5 - Set the speed limit for upload in Kib/s. ``uploadLimited`` 5 - Enable upload speed limiter. ============================ ===== =============== ======================================================================================= .. NOTE:: transmissionrpc will try to automatically fix argument errors. """ args = {} for key, value in kwargs.iteritems(): argument = make_rpc_name(key) (arg, val) = argument_value_convert('torrent-set' , argument, value, self.rpc_version) args[arg] = val if len(args) > 0: self._request('torrent-set', args, ids, True, timeout=timeout) else: ValueError("No arguments to set") def move(self, ids, location, timeout=None): """Move torrent data to the new location.""" self._rpc_version_warning(6) args = {'location': location, 'move': True} self._request('torrent-set-location', args, ids, True, timeout=timeout) def locate(self, ids, location, timeout=None): """Locate torrent data at the location.""" self._rpc_version_warning(6) args = {'location': location, 'move': False} self._request('torrent-set-location', args, ids, True, timeout=timeout) def get_session(self, timeout=None): """Get session parameters""" self._request('session-get', timeout=timeout) self._update_server_version() return self.session def set_session(self, timeout=None, **kwargs): """ Set session parameters. The parameters are: ================================ ===== ================= ========================================================================================================================== Argument RPC Replaced by Description ================================ ===== ================= ========================================================================================================================== ``alt_speed_down`` 5 - Alternate session download speed limit (in Kib/s). ``alt_speed_enabled`` 5 - Enables alternate global download speed limiter. ``alt_speed_time_begin`` 5 - Time when alternate speeds should be enabled. Minutes after midnight. ``alt_speed_time_day`` 5 - Enables alternate speeds scheduling these days. ``alt_speed_time_enabled`` 5 - Enables alternate speeds scheduling. ``alt_speed_time_end`` 5 - Time when alternate speeds should be disabled. Minutes after midnight. ``alt_speed_up`` 5 - Alternate session upload speed limit (in Kib/s). ``blocklist_enabled`` 5 - Enables the block list ``cache_size_mb`` 10 - The maximum size of the disk cache in MB ``dht_enabled`` 6 - Enables DHT. ``download_dir`` 1 - Set the session download directory. ``encryption`` 1 - Set the session encryption mode, one of ``required``, ``preferred`` or ``tolerated``. ``idle_seeding_limit`` 10 - The default seed inactivity limit in minutes. ``idle_seeding_limit_enabled`` 10 - Enables the default seed inactivity limit ``incomplete_dir`` 7 - The path to the directory of incomplete transfer data. ``incomplete_dir_enabled`` 7 - Enables the incomplete transfer data directory. Otherwise data for incomplete transfers are stored in the download target. ``lpd_enabled`` 9 - Enables local peer discovery for public torrents. ``peer_limit`` 1 - 5 peer-limit-global Maximum number of peers ``peer_limit_global`` 5 - Maximum number of peers ``peer_limit_per_torrent`` 5 - Maximum number of peers per transfer ``peer_port`` 5 - Peer port. ``peer_port_random_on_start`` 5 - Enables randomized peer port on start of Transmission. ``pex_allowed`` 1 - 5 pex-enabled Allowing PEX in public torrents. ``pex_enabled`` 5 - Allowing PEX in public torrents. ``port`` 1 - 5 peer-port Peer port. ``port_forwarding_enabled`` 1 - Enables port forwarding. ``rename_partial_files`` 8 - Appends ".part" to incomplete files ``script_torrent_done_enabled`` 9 - Whether or not to call the "done" script. ``script_torrent_done_filename`` 9 - Filename of the script to run when the transfer is done. ``seedRatioLimit`` 5 - Seed ratio limit. 1.0 means 1:1 download and upload ratio. ``seedRatioLimited`` 5 - Enables seed ration limit. ``speed_limit_down`` 1 - Download speed limit (in Kib/s). ``speed_limit_down_enabled`` 1 - Enables download speed limiting. ``speed_limit_up`` 1 - Upload speed limit (in Kib/s). ``speed_limit_up_enabled`` 1 - Enables upload speed limiting. ``start_added_torrents`` 9 - Added torrents will be started right away. ``trash_original_torrent_files`` 9 - The .torrent file of added torrents will be deleted. ================================ ===== ================= ========================================================================================================================== .. NOTE:: transmissionrpc will try to automatically fix argument errors. """ args = {} for key, value in kwargs.iteritems(): if key == 'encryption' and value not in ['required', 'preferred', 'tolerated']: raise ValueError('Invalid encryption value') argument = make_rpc_name(key) (arg, val) = argument_value_convert('session-set' , argument, value, self.rpc_version) args[arg] = val if len(args) > 0: self._request('session-set', args, timeout=timeout) def blocklist_update(self, timeout=None): """Update block list. Returns the size of the block list.""" self._rpc_version_warning(5) result = self._request('blocklist-update', timeout=timeout) if 'blocklist-size' in result: return result['blocklist-size'] return None def port_test(self, timeout=None): """ Tests to see if your incoming peer port is accessible from the outside world. """ self._rpc_version_warning(5) result = self._request('port-test', timeout=timeout) if 'port-is-open' in result: return result['port-is-open'] return None def session_stats(self, timeout=None): """Get session statistics""" self._request('session-stats', timeout=timeout) return self.session