import logging from datetime import timedelta from hashlib import md5 from os import path # Import some externalized utilities to work with the Telegram types and more from . import helpers as utils from .errors import RPCError, FloodWaitError from .network import authenticator, MtProtoSender, TcpTransport from .utils import get_appropriated_part_size # For sending and receiving requests from .tl import MTProtoRequest from .tl.all_tlobjects import layer from .tl.functions import (InitConnectionRequest, InvokeWithLayerRequest) # Initial request from .tl.functions.help import GetConfigRequest from .tl.functions.auth import ImportAuthorizationRequest # Easier access for working with media from .tl.functions.upload import ( GetFileRequest, SaveBigFilePartRequest, SaveFilePartRequest) # All the types we need to work with from .tl.types import InputFile, InputFileBig class TelegramBareClient: """Bare Telegram Client with just the minimum - The reason to distinguish between a MtProtoSender and a TelegramClient itself is because the sender is just that, a sender, which should know nothing about Telegram but rather how to handle this specific connection. The TelegramClient itself should know how to initialize a proper connection to the servers, as well as other basic methods such as disconnection and reconnection. This distinction between a bare client and a full client makes it possible to create clones of the bare version (by using the same session, IP address and port) to be able to execute queries on either, without the additional cost that would involve having the methods for signing in, logging out, and such. """ # Current TelegramClient version __version__ = '0.11' # region Initialization def __init__(self, session, api_id, api_hash, proxy=None): """Initializes the Telegram client with the specified API ID and Hash. Session must always be a Session instance, and an optional proxy can also be specified to be used on the connection. """ self.session = session self.api_id = int(api_id) self.api_hash = api_hash self.proxy = proxy self._logger = logging.getLogger(__name__) # These will be set later self.dc_options = None self.sender = None # endregion # region Connecting def connect(self, exported_auth=None): """Connects to the Telegram servers, executing authentication if required. Note that authenticating to the Telegram servers is not the same as authenticating the desired user itself, which may require a call (or several) to 'sign_in' for the first time. If 'exported_auth' is not None, it will be used instead to determine the authorization key for the current session. """ transport = TcpTransport(self.session.server_address, self.session.port, proxy=self.proxy) try: if not self.session.auth_key: self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(transport) self.session.save() self.sender = MtProtoSender(transport, self.session) self.sender.connect() # Now it's time to send an InitConnectionRequest # This must always be invoked with the layer we'll be using if exported_auth is None: query = GetConfigRequest() else: query = ImportAuthorizationRequest( exported_auth.id, exported_auth.bytes) request = InitConnectionRequest( api_id=self.api_id, device_model=self.session.device_model, system_version=self.session.system_version, app_version=self.session.app_version, lang_code=self.session.lang_code, query=query) result = self.invoke( InvokeWithLayerRequest( layer=layer, query=request)) if exported_auth is not None: # TODO Don't actually need this for exported authorizations, # they're only valid on such data center. result = self.invoke(GetConfigRequest()) # We're only interested in the DC options, # although many other options are available! self.dc_options = result.dc_options return True except (RPCError, ConnectionError) as error: # Probably errors from the previous session, ignore them self.disconnect() self._logger.warning('Could not stabilise initial connection: {}' .format(error)) return False def disconnect(self): """Disconnects from the Telegram server""" if self.sender: self.sender.disconnect() self.sender = None def reconnect(self, new_dc=None): """Disconnects and connects again (effectively reconnecting). If 'new_dc' is not None, the current authorization key is removed, the DC used is switched, and a new connection is made. """ self.disconnect() if new_dc is not None: self.session.auth_key = None # Force creating new auth_key dc = self._get_dc(new_dc) self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect() # endregion # region Working with different Data Centers def _get_dc(self, dc_id): """Gets the Data Center (DC) associated to 'dc_id'""" if not self.dc_options: raise ConnectionError( 'Cannot determine the required data center IP address. ' 'Stabilise a successful initial connection first.') return next(dc for dc in self.dc_options if dc.id == dc_id) # endregion # region Invoking Telegram requests def invoke(self, request, timeout=timedelta(seconds=5), updates=None): """Invokes (sends) a MTProtoRequest and returns (receives) its result. An optional timeout can be specified to cancel the operation if no result is received within such time, or None to disable any timeout. If 'updates' is not None, all read update object will be put in such list. Otherwise, update objects will be ignored. """ if not isinstance(request, MTProtoRequest): raise ValueError('You can only invoke MtProtoRequests') if not self.sender: raise ValueError('You must be connected to invoke requests!') try: self.sender.send(request) self.sender.receive(request, timeout, updates=updates) return request.result except ConnectionResetError: self._logger.info('Server disconnected us. Reconnecting and ' 'resending request...') self.reconnect() return self.invoke(request, timeout=timeout) except FloodWaitError: self.disconnect() raise # endregion # region Uploading media def upload_file(self, file_path, part_size_kb=None, file_name=None, progress_callback=None): """Uploads the specified file_path and returns a handle (an instance of InputFile or InputFileBig, as required) which can be later used. If 'progress_callback' is not None, it should be a function that takes two parameters, (bytes_uploaded, total_bytes). Default values for the optional parameters if left as None are: part_size_kb = get_appropriated_part_size(file_size) file_name = path.basename(file_path) """ file_size = path.getsize(file_path) if not part_size_kb: part_size_kb = get_appropriated_part_size(file_size) if part_size_kb > 512: raise ValueError('The part size must be less or equal to 512KB') part_size = int(part_size_kb * 1024) if part_size % 1024 != 0: raise ValueError('The part size must be evenly divisible by 1024') # Determine whether the file is too big (over 10MB) or not # Telegram does make a distinction between smaller or larger files is_large = file_size > 10 * 1024 * 1024 part_count = (file_size + part_size - 1) // part_size file_id = utils.generate_random_long() hash_md5 = md5() with open(file_path, 'rb') as file: for part_index in range(part_count): # Read the file by in chunks of size part_size part = file.read(part_size) # The SavePartRequest is different depending on whether # the file is too large or not (over or less than 10MB) if is_large: request = SaveBigFilePartRequest(file_id, part_index, part_count, part) else: request = SaveFilePartRequest(file_id, part_index, part) result = self.invoke(request) if result: if not is_large: # No need to update the hash if it's a large file hash_md5.update(part) if progress_callback: progress_callback(file.tell(), file_size) else: raise ValueError('Failed to upload file part {}.' .format(part_index)) # Set a default file name if None was specified if not file_name: file_name = path.basename(file_path) if is_large: return InputFileBig(file_id, part_count, file_name) else: return InputFile(file_id, part_count, file_name, md5_checksum=hash_md5.hexdigest()) # endregion # region Downloading media def download_file(self, input_location, file, part_size_kb=None, file_size=None, progress_callback=None): """Downloads the given InputFileLocation to file (a stream or str). If 'progress_callback' is not None, it should be a function that takes two parameters, (bytes_downloaded, total_bytes). Note that 'total_bytes' simply equals 'file_size', and may be None. """ if not part_size_kb: if not file_size: part_size_kb = 64 # Reasonable default else: part_size_kb = get_appropriated_part_size(file_size) part_size = int(part_size_kb * 1024) if part_size % 1024 != 0: raise ValueError('The part size must be evenly divisible by 1024.') if isinstance(file, str): # Ensure that we'll be able to download the media utils.ensure_parent_dir_exists(file) f = open(file, 'wb') else: f = file try: offset_index = 0 while True: offset = offset_index * part_size result = self.invoke( GetFileRequest(input_location, offset, part_size)) offset_index += 1 # If we have received no data (0 bytes), the file is over # So there is nothing left to download and write if not result.bytes: return result.type # Return some extra information f.write(result.bytes) if progress_callback: progress_callback(f.tell(), file_size) finally: if isinstance(file, str): f.close() # endregion