# Copyright (c) 2013 Chris Lucas, <chris@chrisjlucas.com> # Permission is hereby granted, free of charge, to any person obtaining # a copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, # distribute, sublicense, and/or sell copies of the Software, and to # permit persons to whom the Software is furnished to do so, subject to # the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. from . import rpc from .common import safe_repr from .rpc import Method class File(object): """Represents an individual file within a L{Torrent} instance.""" def __init__(self, _rt_obj, info_hash, index, **kwargs): self._rt_obj = _rt_obj self.info_hash = info_hash # : info hash for the torrent the file is associated with self.index = index # : The position of the file within the file list self.path = '' for k in kwargs: setattr(self, k, kwargs.get(k, None)) self.rpc_id = '{0}:f{1}'.format( self.info_hash, self.index) # : unique id to pass to rTorrent def update(self): """Refresh file data @note: All fields are stored as attributes to self. @return: None """ mc = rpc.Multicall(self) for method in filter(lambda m: m.is_retriever() and m.is_available(self._rt_obj), methods): mc.add(method, self.rpc_id) mc.call() def __repr__(self): return safe_repr('File(index={0} path="{1}")', self.index, self.path) methods = [ # RETRIEVERS Method(File, 'get_last_touched', 'f.get_last_touched', aliases=('f.last_touched',)), Method(File, 'get_range_second', 'f.get_range_second', aliases=('f.range_second',)), Method(File, 'get_size_bytes', 'f.get_size_bytes', aliases=('f.size_bytes',)), Method(File, 'get_priority', 'f.get_priority', aliases=('f.priority',)), Method(File, 'get_match_depth_next', 'f.get_match_depth_next', aliases=('f.match_depth_next',)), Method(File, 'is_resize_queued', 'f.is_resize_queued', boolean=True ), Method(File, 'get_range_first', 'f.get_range_first', aliases=('f.range_first',)), Method(File, 'get_match_depth_prev', 'f.get_match_depth_prev', aliases=('f.match_depth_prev',)), Method(File, 'get_path', 'f.get_path', aliases=('f.path',)), Method(File, 'get_completed_chunks', 'f.get_completed_chunks', aliases=('f.completed_chunks',)), Method(File, 'get_path_components', 'f.get_path_components', aliases=('f.path_components',)), Method(File, 'is_created', 'f.is_created', boolean=True ), Method(File, 'is_open', 'f.is_open', boolean=True ), Method(File, 'get_size_chunks', 'f.get_size_chunks', aliases=('f.size_chunks',)), Method(File, 'get_offset', 'f.get_offset', aliases=('f.offset',)), Method(File, 'get_frozen_path', 'f.get_frozen_path', aliases=('f.frozen_path',)), Method(File, 'get_path_depth', 'f.get_path_depth', aliases=('f.path_depth',)), Method(File, 'is_create_queued', 'f.is_create_queued', boolean=True ), # MODIFIERS ]