def reconnect_to_dc(self, dc_id): if self.dc_options is None or not self.dc_options: raise ConnectionError( "Cannot reconnect. Stabilise an initial connection first.") dc = next(dc for dc in self.dc_options if dc.id == dc_id) self.transport.close() self.transport = TcpTransport(dc.ip_address, dc.port) self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect(reconnect=True)
def reconnect_to_dc(self, dc_id): """Reconnects to the specified DC ID. This is automatically called after an InvalidDCError is raised""" if self.dc_options is None or not self.dc_options: raise ConnectionError("Can't reconnect. Stabilise an initial connection first.") dc = next(dc for dc in self.dc_options if dc.id == dc_id) self.transport.close() self.transport = TcpTransport(dc.ip_address, dc.port) self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect(reconnect=True)
def __init__(self, session_user_id, api_id, api_hash): if api_id is None or api_hash is None: raise PermissionError('Your API ID or Hash are invalid. Please read "Requirements" on README.md') self.api_id = api_id self.api_hash = api_hash self.session = Session.try_load_or_create_new(session_user_id) self.transport = TcpTransport(self.session.server_address, self.session.port) # These will be set later self.dc_options = None self.sender = None self.phone_code_hashes = {} # We need to be signed in before we can listen for updates self.signed_in = False
def connect(self, reconnect=False): """Connects to the Telegram servers, executing authentication if required. Note that authenticating to the Telegram servers is not the same as authenticating the app, which requires to send a code first.""" if self.transport is None: self.transport = TcpTransport(self.session.server_address, self.session.port, proxy=self.proxy) try: if not self.session.auth_key or (reconnect and self.sender is not None): self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(self.transport) self.session.save() self.sender = MtProtoSender(self.transport, self.session) # Now it's time to send an InitConnectionRequest # This must always be invoked with the layer we'll be using query = InitConnectionRequest(api_id=self.api_id, device_model=platform.node(), system_version=platform.system(), app_version=self.__version__, lang_code='en', query=GetConfigRequest()) result = self.invoke( InvokeWithLayerRequest(layer=layer, query=query)) # We're only interested in the DC options, # although many other options are available! self.dc_options = result.dc_options # We're signed in if we're authorized self.signed_in = self.is_user_authorized() return True except RPCError as error: print('Could not stabilise initial connection: {}'.format(error)) return False
def __init__(self, session, api_id, api_hash): """Initializes the Telegram client with the specified API ID and Hash. Session can either be a `str` object (the filename for the loaded/saved .session) or it can be a `Session` instance (in which case list_sessions() would probably not work). If you don't want any file to be saved, pass `None` In the later case, you are free to override the `Session` class to provide different .save() and .load() implementations to suit your needs.""" if api_id is None or api_hash is None: raise PermissionError( 'Your API ID or Hash are invalid. Please read "Requirements" on README.rst' ) self.api_id = api_id self.api_hash = api_hash # Determine what session object we have if isinstance(session, str): self.session = Session.try_load_or_create_new(session) elif isinstance(session, Session): self.session = session else: raise ValueError( 'The given session must either be a string or a Session instance.' ) self.transport = TcpTransport(self.session.server_address, self.session.port) # These will be set later self.dc_options = None self.sender = None self.phone_code_hashes = {} # We need to be signed in before we can listen for updates self.signed_in = False
def __init__(self, session, api_id, api_hash, proxy=None): if api_id is None or api_hash is None: raise PermissionError("Your API ID or Hash are invalid.") self.api_id = api_id self.api_hash = api_hash if isinstance(session, str): self.session = Session.try_load_or_create_new(session) elif isinstance(session, Session): self.session = session else: raise ValueError( "The given session must be either a string or a Session instance." ) self.transport = TcpTransport(self.session.server_address, self.session.port, proxy) self.dc_options = None self.sender = None self.phone_code_hashes = {} self.signed_in = False
def test_authenticator(): transport = TcpTransport('149.154.167.91', 443) authenticator.do_authentication(transport) transport.close()
class TelegramClient: # Current TelegramClient version __version__ = '0.6' # region Initialization def __init__(self, session_user_id, api_id, api_hash): if api_id is None or api_hash is None: raise PermissionError('Your API ID or Hash are invalid. Please read "Requirements" on README.md') self.api_id = api_id self.api_hash = api_hash self.session = Session.try_load_or_create_new(session_user_id) self.transport = TcpTransport(self.session.server_address, self.session.port) # These will be set later self.dc_options = None self.sender = None self.phone_code_hashes = {} # We need to be signed in before we can listen for updates self.signed_in = False # endregion # region Connecting def connect(self, reconnect=False): """Connects to the Telegram servers, executing authentication if required. Note that authenticating to the Telegram servers is not the same as authenticating the app, which requires to send a code first.""" try: if not self.session.auth_key or reconnect: self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(self.transport) self.session.save() self.sender = MtProtoSender(self.transport, self.session) # Now it's time to send an InitConnectionRequest # This must always be invoked with the layer we'll be using query = InitConnectionRequest(api_id=self.api_id, device_model=platform.node(), system_version=platform.system(), app_version=self.__version__, lang_code='en', query=GetConfigRequest()) result = self.invoke(InvokeWithLayerRequest(layer=layer, query=query)) # We're only interested in the DC options, # although many other options are available! self.dc_options = result.dc_options # We can now enable these (for such methods such as logout) self.sender.ack_requests_confirm = True # We're signed in if we're authorized self.signed_in = self.is_user_authorized() return True except RPCError as error: print('Could not stabilise initial connection: {}'.format(error)) return False def reconnect_to_dc(self, dc_id): """Reconnects to the specified DC ID. This is automatically called after an InvalidDCError is raised""" if self.dc_options is None or not self.dc_options: raise ConnectionError("Can't reconnect. Stabilise an initial connection first.") dc = next(dc for dc in self.dc_options if dc.id == dc_id) self.transport.close() self.transport = TcpTransport(dc.ip_address, dc.port) self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect(reconnect=True) def disconnect(self): """Disconnects from the Telegram server **and pauses all the spawned threads**""" if self.sender: self.sender.disconnect() # endregion # region Telegram requests functions def invoke(self, request, timeout=timedelta(seconds=5)): """Invokes a MTProtoRequest (sends and receives it) and returns its result. An optional timeout can be given to cancel the operation after the time delta. Timeout can be set to None for no timeout""" if not issubclass(type(request), MTProtoRequest): raise ValueError('You can only invoke MtProtoRequests') self.sender.send(request) self.sender.receive(request, timeout) return request.result # region Authorization requests def is_user_authorized(self): """Has the user been authorized yet (code request sent and confirmed)? Note that this will NOT yield the correct result if the session was revoked by another client!""" return self.session.user is not None def send_code_request(self, phone_number): """Sends a code request to the specified phone number""" request = SendCodeRequest(phone_number, self.api_id, self.api_hash) completed = False while not completed: try: result = self.invoke(request) self.phone_code_hashes[phone_number] = result.phone_code_hash completed = True except InvalidDCError as error: self.reconnect_to_dc(error.new_dc) def sign_in(self, phone_number, code): """Completes the authorization of a phone number by providing the received code""" if phone_number not in self.phone_code_hashes: raise ValueError('Please make sure you have called send_code_request first.') try: result = self.invoke(SignInRequest( phone_number, self.phone_code_hashes[phone_number], code)) except RPCError as error: if error.message.startswith('PHONE_CODE_'): print(error) return False else: raise error # Result is an Auth.Authorization TLObject self.session.user = result.user self.session.save() # Now that we're authorized, set the signed_in flag # to True so update handlers can be added self.signed_in = True return True def sign_up(self, phone_number, code, first_name, last_name=''): """Signs up to Telegram. Make sure you sent a code request first!""" result = self.invoke(SignUpRequest(phone_number=phone_number, phone_code_hash=self.phone_code_hashes[phone_number], phone_code=code, first_name=first_name, last_name=last_name)) self.session.user = result.user self.session.save() def log_out(self): """Logs out and deletes the current session. Returns True if everything went OK""" try: self.invoke(LogOutRequest()) if not self.session.delete(): return False self.session = None except: return False @staticmethod def list_sessions(): """Lists all the sessions of the users who have ever connected using this client and never logged out""" return [path.splitext(path.basename(f))[0] # splitext = split ext (not spli text!) for f in listdir('.') if f.endswith('.session')] # endregion # region Dialogs ("chats") requests def get_dialogs(self, count=10, offset_date=None, offset_id=0, offset_peer=InputPeerEmpty()): """Returns a tuple of lists ([dialogs], [entities]) with 'count' items each. The `entity` represents the user, chat or channel corresponding to that dialog""" r = self.invoke(GetDialogsRequest(offset_date=offset_date, offset_id=offset_id, offset_peer=offset_peer, limit=count)) return (r.dialogs, [self.find_user_or_chat(d.peer, r.users, r.chats) for d in r.dialogs]) # endregion # region Message requests def send_message(self, input_peer, message, markdown=False, no_web_page=False): """Sends a message to the given input peer and returns the sent message ID""" if markdown: msg, entities = parse_message_entities(message) else: msg, entities = message, [] msg_id = utils.generate_random_long() self.invoke(SendMessageRequest(peer=input_peer, message=msg, random_id=msg_id, entities=entities, no_webpage=no_web_page)) return msg_id def get_message_history(self, input_peer, limit=20, offset_date=None, offset_id=0, max_id=0, min_id=0, add_offset=0): """ Gets the message history for the specified InputPeer :param input_peer: The InputPeer from whom to retrieve the message history :param limit: Number of messages to be retrieved :param offset_date: Offset date (messages *previous* to this date will be retrieved) :param offset_id: Offset message ID (only messages *previous* to the given ID will be retrieved) :param max_id: All the messages with a higher (newer) ID or equal to this will be excluded :param min_id: All the messages with a lower (older) ID or equal to this will be excluded :param add_offset: Additional message offset (all of the specified offsets + this offset = older messages) :return: A tuple containing total message count and two more lists ([messages], [senders]). Note that the sender can be null if it was not found! """ result = self.invoke(GetHistoryRequest(input_peer, limit=limit, offset_date=offset_date, offset_id=offset_id, max_id=max_id, min_id=min_id, add_offset=add_offset)) # The result may be a messages slice (not all messages were retrieved) or # simply a messages TLObject. In the later case, no "count" attribute is specified: # the total messages count is retrieved by counting all the retrieved messages total_messages = getattr(result, 'count', len(result.messages)) # Iterate over all the messages and find the sender User users = [] for msg in result.messages: for usr in result.users: if msg.from_id == usr.id: users.append(usr) break return total_messages, result.messages, users def send_read_acknowledge(self, input_peer, messages=None, max_id=None): """Sends a "read acknowledge" (i.e., notifying the given peer that we've read their messages, also known as the "double check ✅✅"). Either a list of messages (or a single message) can be given, or the maximum message ID (until which message we want to send the read acknowledge). Returns an AffectedMessages TLObject""" if max_id is None: if not messages: raise InvalidParameterError('Either a message list or a max_id must be provided.') if isinstance(messages, list): max_id = max(msg.id for msg in messages) else: max_id = messages.id return self.invoke(ReadHistoryRequest(peer=input_peer, max_id=max_id)) # endregion # TODO Handle media downloading/uploading in a different session? # "It is recommended that large queries (upload.getFile, upload.saveFilePart) # be handled through a separate session and a separate connection" # region Uploading media requests 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 which can be later used :param file_path: The file path of the file that will be uploaded :param part_size_kb: The part size when uploading the file. None = Automatic :param file_name: The name of the uploaded file. None = Automatic :param progress_callback: A callback function which takes two parameters, uploaded size (in bytes) and total file size (in bytes) This is called every time a part is uploaded """ file_size = path.getsize(file_path) if not part_size_kb: part_size_kb = self.find_appropiate_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 # Multiply the datetime timestamp by 10^6 to get the ticks # This is high likely going to be unique file_id = int(datetime.now().timestamp() * (10 ** 6)) 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) # Invoke the file upload and increment both the part index and MD5 checksum result = self.invoke(request) if result: hash_md5.update(part) if progress_callback: progress_callback(file.tell(), file_size) else: raise ValueError('Could not 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) # After the file has been uploaded, we can return a handle pointing to it return InputFile(id=file_id, parts=part_count, name=file_name, md5_checksum=hash_md5.hexdigest()) def send_photo_file(self, input_file, input_peer, caption=''): """Sends a previously uploaded input_file (which should be a photo) to an input_peer""" self.send_media_file( InputMediaUploadedPhoto(input_file, caption), input_peer) def send_document_file(self, input_file, input_peer, caption=''): """Sends a previously uploaded input_file (which should be a document) to an input_peer""" # Determine mime-type and attributes # Take the first element by using [0] since it returns a tuple mime_type = guess_type(input_file.name)[0] attributes = [ DocumentAttributeFilename(input_file.name) # TODO If the input file is an audio, find out: # Performer and song title and add DocumentAttributeAudio ] # Ensure we have a mime type, any; but it cannot be None # «The "octet-stream" subtype is used to indicate that a body contains arbitrary binary data.» if not mime_type: mime_type = 'application/octet-stream' self.send_media_file(InputMediaUploadedDocument(file=input_file, mime_type=mime_type, attributes=attributes, caption=caption), input_peer) def send_media_file(self, input_media, input_peer): """Sends any input_media (contact, document, photo...) to an input_peer""" self.invoke(SendMediaRequest(peer=input_peer, media=input_media, random_id=utils.generate_random_long())) # endregion # region Downloading media requests def download_profile_photo(self, profile_photo, file_path, add_extension=True, download_big=True): """Downloads the profile photo for an user or a chat (including channels). Returns False if no photo was providen, or if it was Empty""" if (not profile_photo or isinstance(profile_photo, UserProfilePhotoEmpty) or isinstance(profile_photo, ChatPhotoEmpty)): return False # Photos are always compressed into a .jpg by Telegram if add_extension: file_path += '.jpg' if download_big: photo_location = profile_photo.photo_big else: photo_location = profile_photo.photo_small # Download the media with the largest size input file location self.download_file_loc(InputFileLocation(volume_id=photo_location.volume_id, local_id=photo_location.local_id, secret=photo_location.secret), file_path) return True def download_msg_media(self, message_media, file_path, add_extension=True, progress_callback=None): """Downloads the given MessageMedia (Photo, Document or Contact) into the desired file_path, optionally finding its extension automatically The progress_callback should be a callback function which takes two parameters, uploaded size (in bytes) and total file size (in bytes). This will be called every time a part is downloaded""" if type(message_media) == MessageMediaPhoto: return self.download_photo(message_media, file_path, add_extension, progress_callback) elif type(message_media) == MessageMediaDocument: return self.download_document(message_media, file_path, add_extension, progress_callback) elif type(message_media) == MessageMediaContact: return self.download_contact(message_media, file_path, add_extension) def download_photo(self, message_media_photo, file_path, add_extension=False, progress_callback=None): """Downloads MessageMediaPhoto's largest size into the desired file_path, optionally finding its extension automatically The progress_callback should be a callback function which takes two parameters, uploaded size (in bytes) and total file size (in bytes). This will be called every time a part is downloaded""" # Determine the photo and its largest size photo = message_media_photo.photo largest_size = photo.sizes[-1] file_size = largest_size.size largest_size = largest_size.location # Photos are always compressed into a .jpg by Telegram if add_extension: file_path += '.jpg' # Download the media with the largest size input file location self.download_file_loc(InputFileLocation(volume_id=largest_size.volume_id, local_id=largest_size.local_id, secret=largest_size.secret), file_path, file_size, progress_callback) return file_path def download_document(self, message_media_document, file_path=None, add_extension=True, progress_callback=None): """Downloads the given MessageMediaDocument into the desired file_path, optionally finding its extension automatically. If no file_path is given, it will try to be guessed from the document The progress_callback should be a callback function which takes two parameters, uploaded size (in bytes) and total file size (in bytes). This will be called every time a part is downloaded""" document = message_media_document.document file_size = document.size # If no file path was given, try to guess it from the attributes if file_path is None: for attr in document.attributes: if type(attr) == DocumentAttributeFilename: file_path = attr.file_name break # This attribute has higher preference elif type(attr) == DocumentAttributeAudio: file_path = '{} - {}'.format(attr.performer, attr.title) if file_path is None: print('Could not determine a filename for the document') # Guess the extension based on the mime_type if add_extension: ext = guess_extension(document.mime_type) if ext is not None: file_path += ext self.download_file_loc(InputDocumentFileLocation(id=document.id, access_hash=document.access_hash, version=document.version), file_path, file_size, progress_callback) return file_path @staticmethod def download_contact(message_media_contact, file_path, add_extension=True): """Downloads a media contact using the vCard 4.0 format""" first_name = message_media_contact.first_name last_name = message_media_contact.last_name phone_number = message_media_contact.phone_number # The only way we can save a contact in an understandable # way by phones is by using the .vCard format if add_extension: file_path += '.vcard' # Ensure that we'll be able to download the contact utils.ensure_parent_dir_exists(file_path) with open(file_path, 'w', encoding='utf-8') as file: file.write('BEGIN:VCARD\n') file.write('VERSION:4.0\n') file.write('N:{};{};;;\n'.format(first_name, last_name if last_name else '')) file.write('FN:{}\n'.format(' '.join((first_name, last_name)))) file.write('TEL;TYPE=cell;VALUE=uri:tel:+{}\n'.format(phone_number)) file.write('END:VCARD\n') return file_path def download_file_loc(self, input_location, file_path, part_size_kb=64, file_size=None, progress_callback=None): """Downloads media from the given input_file_location to the specified file_path. If a progress_callback function is given, it will be called taking two arguments (downloaded bytes count and total file size)""" if not part_size_kb: if not file_size: raise ValueError('A part size value must be provided') else: part_size_kb = self.find_appropiate_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') # Ensure that we'll be able to download the media utils.ensure_parent_dir_exists(file_path) # Start with an offset index of 0 offset_index = 0 with open(file_path, 'wb') as file: while True: # The current offset equals the offset_index multiplied by the part size 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 file.write(result.bytes) if progress_callback: progress_callback(file.tell(), file_size) # endregion # endregion # region Utilities @staticmethod def get_display_name(entity): """Gets the input peer for the given "entity" (user, chat or channel) Returns None if it was not found""" if isinstance(entity, User): if entity.last_name is not None: return '{} {}'.format(entity.first_name, entity.last_name) return entity.first_name if isinstance(entity, Chat) or isinstance(entity, Channel): return entity.title @staticmethod def get_input_peer(entity): """Gets the input peer for the given "entity" (user, chat or channel). Returns None if it was not found""" if isinstance(entity, User): return InputPeerUser(entity.id, entity.access_hash) if isinstance(entity, Chat): return InputPeerChat(entity.id) if isinstance(entity, Channel): return InputPeerChannel(entity.id, entity.access_hash) @staticmethod def find_user_or_chat(peer, users, chats): """Finds the corresponding user or chat given a peer. Returns None if it was not found""" try: if isinstance(peer, PeerUser): user = next(u for u in users if u.id == peer.user_id) return user elif isinstance(peer, PeerChat): chat = next(c for c in chats if c.id == peer.chat_id) return chat elif isinstance(peer, PeerChannel): channel = next(c for c in chats if c.id == peer.channel_id) return channel except StopIteration: return None @staticmethod def find_appropiate_part_size(file_size): if file_size <= 1048576: # 1MB return 32 if file_size <= 10485760: # 10MB return 64 if file_size <= 393216000: # 375MB return 128 if file_size <= 786432000: # 750MB return 256 if file_size <= 1572864000: # 1500MB return 512 raise ValueError('File size too large') # endregion # region Updates handling def add_update_handler(self, handler): """Adds an update handler (a function which takes a TLObject, an update, as its parameter) and listens for updates""" if not self.signed_in: raise ValueError("You cannot add update handlers until you've signed in.") self.sender.add_update_handler(handler) def remove_update_handler(self, handler): self.sender.remove_update_handler(handler)
class YolkClient: __version__ = '1.0a' def __init__(self, session, api_id, api_hash, proxy=None): if api_id is None or api_hash is None: raise PermissionError("Your API ID or Hash are invalid.") self.api_id = api_id self.api_hash = api_hash if isinstance(session, str): self.session = Session.try_load_or_create_new(session) elif isinstance(session, Session): self.session = session else: raise ValueError( "The given session must be either a string or a Session instance." ) self.transport = TcpTransport(self.session.server_address, self.session.port, proxy) self.dc_options = None self.sender = None self.phone_code_hashes = {} self.signed_in = False def connect(self, reconnect=False): try: if not self.session.auth_key or (reconnect and self.sender is not None): self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(self.transport) self.session.save() self.sender = MtProtoSender(self.transport, self.session) query = InitConnectionRequest(api_id=self.api_id, device_model=platform.node(), system_version=platform.system(), app_version=self.__version__, lang_code="en", query=GetConfigRequest()) result = self.invoke( InvokeWithLayerRequest(layer=layer, query=query)) self.dc_options = result.dc_options self.sender.ack_requests_confirm = True self.signed_in = self.is_user_authorized() return True except RPCError as error: print(f"Could not stabilise initial connection: {error}.") return False def reconnect_to_dc(self, dc_id): if self.dc_options is None or not self.dc_options: raise ConnectionError( "Cannot reconnect. Stabilise an initial connection first.") dc = next(dc for dc in self.dc_options if dc.id == dc_id) self.transport.close() self.transport = TcpTransport(dc.ip_address, dc.port) self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect(reconnect=True) def disconnect(self): if self.sender: self.sender.disconnect() self.sender = None def invoke(self, request, timeout=timedelta(seconds=5), throw_invalid_dc=False): if not issubclass(type(request), MTProtoRequest): raise ValueError("You can only invoke MtProtoRequests") try: self.sender.send(request) self.sender.receive(request, timeout) return request.result except InvalidDCError as error: if throw_invalid_dc: raise error self.reconnect_to_dc(error.new_dc) return self.invoke(request, timeout=timeout, throw_invalid_dc=True) except RPCError as e: print(f"RPC error: {e}") print("Continuing...") pass def is_user_authorized(self): return self.session.user is not None def send_code_request(self, phone_number): result = self.invoke( SendCodeRequest(phone_number, self.api_id, self.api_hash)) self.phone_code_hashes[phone_number] = result.phone_code_hash def sign_in(self, phone_number=None, code=None, password=None, bot_token=None): if phone_number and code: if phone_number not in self.phone_code_hashes: raise ValueError( "Please make sure you have called send_code_request first." ) try: result = self.invoke( SignInRequest(phone_number, self.phone_code_hashes[phone_number], code)) except RPCError as error: if error.message.startswith("PHONE_CODE_"): print(error) return False else: raise error elif password: salt = self.invoke(GetPasswordRequest()).current_salt result = self.invoke( CheckPasswordRequest(utils.get_password_hash(password, salt))) elif bot_token: result = self.invoke( ImportBotAuthorizationRequest(flags=0, api_id=self.api_id, api_hash=self.api_hash, bot_auth_token=bot_token)) else: raise ValueError( "You must provide a phone_number and a code for the first time, " "and a password only if an RPCError was raised before.") self.session.user = result.user self.session.save() self.signed_in = True return True def sign_up(self, phone_number, code, first_name, last_name=''): result = self.invoke( SignUpRequest(phone_number=phone_number, phone_code_hash=self.phone_code_hash[phone_number], phone_code=code, first_name=first_name, last_name=last_name)) self.session.user = result.user self.session.save() def log_out(self): try: self.invoke(LogOutRequest()) if not self.session.delete(): return False self.session = None except: return False def send_message(self, peer, message, no_web_page=False, PM=False, access_hash=None): msg_id = utils.generate_random_long() if not (PM is True): self.invoke( SendMessageRequest(peer=InputPeerChat(peer), message=message, random_id=msg_id, no_webpage=no_web_page)) else: if access_hash: self.invoke( SendMessageRequest(peer=InputPeerUser(peer, access_hash), message=message, random_id=msg_id, no_webpage=no_web_page)) else: print( "Access hash not provided. Could send message to InputPeerUser." ) return msg_id def resolve_username(self, username): result = self.invoke(ResolveUsernameRequest(username)) if result: return result else: return "Cannot resolve given username. Ensure provided username is valid." def get_full_user(self, ID, access_hash): result = self.invoke(GetFullUserRequest(InputUser(ID, access_hash))) if result: return result else: return "Cannot get full user. Ensure provided ID is valid." def add_update_handler(self, handler): if not self.signed_in: raise ValueError( "You cannot add update handlers until you've signed in.") self.sender.add_update_handler(handler)
class TelegramRegistrator(TelegramClient): # Current TelegramClient version __version__ = '0.10.1' # region Initialization def __init__(self, session, api_id=None, api_hash=None, proxy=None): """Initializes the Telegram client with the specified API ID and Hash. Session can either be a `str` object (the filename for the loaded/saved .session) or it can be a `Session` instance (in which case list_sessions() would probably not work). If you don't want any file to be saved, pass `None` In the later case, you are free to override the `Session` class to provide different .save() and .load() implementations to suit your needs.""" # if api_id is None or api_hash is None: # raise PermissionError( # 'Your API ID or Hash are invalid. Please read "Requirements" on README.rst') super().__init__(session, api_id, api_hash, proxy) self.api_id = api_id self.api_hash = api_hash # Determine what session object we have # TODO JsonSession until migration is complete (by v1.0) if isinstance(session, str) or session is None: self.session = JsonSession.try_load_or_create_new(session) elif isinstance(session, Session): self.session = session else: raise ValueError( 'The given session must either be a string or a Session instance.') self.transport = None self.proxy = proxy # Will be used when a TcpTransport is created self.login_success = False # Safety across multiple threads (for the updates thread) self._lock = RLock() self._logger = app_logger # Methods to be called when an update is received self._update_handlers = [] self._updates_thread_running = Event() self._updates_thread_receiving = Event() # Cache "exported" senders 'dc_id: MtProtoSender' and # their corresponding sessions not to recreate them all # the time since it's a (somewhat expensive) process. self._cached_senders = {} self._cached_sessions = {} # These will be set later self._updates_thread = None self.dc_options = None self.sender = None self.phone_code_hashes = {} def connect(self, reconnect=False, device_model=None, system_version=None, app_version=None, lang_code=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. Default values for the optional parameters if left as None are: device_model = platform.node() system_version = platform.system() app_version = TelegramClient.__version__ lang_code = 'en' """ if self.transport is None: self.transport = TcpTransport(self.session.server_address, self.session.port, proxy=self.proxy) try: if not self.session.auth_key or (reconnect and self.sender is not None): self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(self.transport) self.session.save() self.sender = MtProtoSender(self.transport, self.session) self.sender.connect() # Set the default parameters if left unspecified if not device_model: device_model = platform.node() if not system_version: system_version = platform.system() if not app_version: app_version = self.__version__ if not lang_code: lang_code = 'en' # Now it's time to send an InitConnectionRequest # This must always be invoked with the layer we'll be using query = InitConnectionRequest( api_id=self.api_id, device_model=device_model, system_version=system_version, app_version=app_version, lang_code=lang_code, query=GetConfigRequest()) result = self.invoke( InvokeWithLayerRequest( layer=layer, query=query)) # We're only interested in the DC options, # although many other options are available! self.dc_options = result.dc_options self.login_success = True return True except (RPCError, ConnectionError) as error: # Probably errors from the previous session, ignore them self._logger.warning('Could not stabilise initial connection: {}' .format(error)) return False def check_phone(self, phone_number): result = self.invoke( CheckPhoneRequest(phone_number=phone_number)) return result def sign_up(self, phone_number, code, first_name, last_name=''): """Signs up to Telegram. Make sure you sent a code request first!""" result = self.invoke( SignUpRequest( phone_number=phone_number, phone_code_hash=self.phone_code_hashes[phone_number], phone_code=code, first_name=first_name, last_name=last_name)) self.session.user = result.user self.session.save() return result def invoke(self, request, timeout=timedelta(seconds=5), throw_invalid_dc=False): """Invokes a MTProtoRequest (sends and receives it) and returns its result. An optional timeout can be given to cancel the operation after the time delta. Timeout can be set to None for no timeout. If throw_invalid_dc is True, these errors won't be caught (useful to avoid infinite recursion). This should not be set to True manually.""" if not issubclass(type(request), MTProtoRequest): raise ValueError('You can only invoke MtProtoRequests') if not self.sender: raise ValueError('You must be connected to invoke requests!') if self._updates_thread_receiving.is_set(): self.sender.cancel_receive() try: self._lock.acquire() updates = [] self.sender.send(request) self.sender.receive(request, timeout, updates=updates) for update in updates: for handler in self._update_handlers: handler(update) return request.result except InvalidDCError as error: if throw_invalid_dc: raise self._reconnect_to_dc(error.new_dc) return self.invoke(request, timeout=timeout, throw_invalid_dc=True) except ConnectionResetError: self._logger.info('Server disconnected us. Reconnecting and ' 'resending request...') self.reconnect() self.invoke(request, timeout=timeout, throw_invalid_dc=throw_invalid_dc) except FloodWaitError: self.disconnect() raise finally: self._lock.release() def reconnect(self): """Disconnects and connects again (effectively reconnecting)""" self.disconnect() self.connect() def disconnect(self): """Disconnects from the Telegram server and stops all the spawned threads""" self._set_updates_thread(running=False) if self.sender: self.sender.disconnect() self.sender = None if self.transport: self.transport.close() self.transport = None # Also disconnect all the cached senders for sender in self._cached_senders.values(): sender.disconnect() self._cached_senders.clear() self._cached_sessions.clear() def _set_updates_thread(self, running): """Sets the updates thread status (running or not)""" if running == self._updates_thread_running.is_set(): return # Different state, update the saved value and behave as required self._logger.info('Changing updates thread running status to %s', running) if running: self._updates_thread_running.set() if not self._updates_thread: self._updates_thread = Thread( name='UpdatesThread', daemon=True, target=self._updates_thread_method) self._updates_thread.start() else: self._updates_thread_running.clear() if self._updates_thread_receiving.is_set(): self.sender.cancel_receive() def _updates_thread_method(self): """This method will run until specified and listen for incoming updates""" # Set a reasonable timeout when checking for updates timeout = timedelta(minutes=1) while self._updates_thread_running.is_set(): # Always sleep a bit before each iteration to relax the CPU, # since it's possible to early 'continue' the loop to reach # the next iteration, but we still should to sleep. sleep(0.1) with self._lock: self._logger.debug('Updates thread acquired the lock') try: self._updates_thread_receiving.set() self._logger.debug('Trying to receive updates from the updates thread') result = self.sender.receive_update(timeout=timeout) self._logger.info('Received update from the updates thread') for handler in self._update_handlers: handler(result) except ConnectionResetError: self._logger.info('Server disconnected us. Reconnecting...') self.reconnect() except TimeoutError: self._logger.debug('Receiving updates timed out') except ReadCancelledError: self._logger.info('Receiving updates cancelled') except OSError: self._logger.warning('OSError on updates thread, %s logging out', 'was' if self.sender.logging_out else 'was not') if self.sender.logging_out: # This error is okay when logging out, means we got disconnected # TODO Not sure why this happens because we call disconnect()… self._set_updates_thread(running=False) else: raise self._logger.debug('Updates thread released the lock') self._updates_thread_receiving.clear() # Thread is over, so clean unset its variable self._updates_thread = None def _reconnect_to_dc(self, dc_id): """Reconnects to the specified DC ID. This is automatically called after an InvalidDCError is raised""" dc = self._get_dc(dc_id) self.transport.close() self.transport = None self.session.server_address = dc.ip_address self.session.port = dc.port self.session.save() self.connect(reconnect=True) 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) def send_code_request(self, phone_number): """Sends a code request to the specified phone number""" result = self.invoke(SendCodeRequest(phone_number, self.api_id, self.api_hash)) self.phone_code_hashes[phone_number] = result.phone_code_hash return result def run(self): # Listen for updates self.add_update_handler(self.update_handler) # Enter a while loop to chat as long as the user wants while True: # Retrieve the top dialogs dialog_count = 10 # Entities represent the user, chat or channel # corresponding to the dialog on the same index dialogs, entities = self.get_dialogs(dialog_count) i = None while i is None: print_title('Dialogs window') # Display them so the user can choose for i, entity in enumerate(entities, start=1): sprint('{}. {}'.format(i, get_display_name(entity))) # Let the user decide who they want to talk to print() print('> Who do you want to send messages to?') print('> Available commands:') print(' !q: Quits the dialogs window and exits.') print(' !l: Logs out, terminating this session.') print() i = input('Enter dialog ID or a command: ') if i == '!q': return if i == '!l': self.log_out() return try: i = int(i if i else 0) - 1 # Ensure it is inside the bounds, otherwise retry if not 0 <= i < dialog_count: i = None except ValueError: i = None # Retrieve the selected user (or chat, or channel) entity = entities[i] # Show some information print_title('Chat with "{}"'.format(get_display_name(entity))) print('Available commands:') print(' !q: Quits the current chat.') print(' !Q: Quits the current chat and exits.') print(' !h: prints the latest messages (message History).') print(' !up <path>: Uploads and sends the Photo from path.') print(' !uf <path>: Uploads and sends the File from path.') print(' !dm <msg-id>: Downloads the given message Media (if any).') print(' !dp: Downloads the current dialog Profile picture.') print() # And start a while loop to chat while True: msg = input('Enter a message: ') # Quit if msg == '!q': break elif msg == '!Q': return # History elif msg == '!h': # First retrieve the messages and some information total_count, messages, senders = self.get_message_history( entity, limit=10) # Iterate over all (in reverse order so the latest appear # the last in the console) and print them with format: # "[hh:mm] Sender: Message" for msg, sender in zip( reversed(messages), reversed(senders)): # Get the name of the sender if any if sender: name = getattr(sender, 'first_name', None) if not name: name = getattr(sender, 'title') if not name: name = '???' else: name = '???' # Format the message content if getattr(msg, 'media', None): self.found_media.add(msg) # The media may or may not have a caption caption = getattr(msg.media, 'caption', '') content = '<{}> {}'.format( type(msg.media).__name__, caption) elif hasattr(msg, 'message'): content = msg.message elif hasattr(msg, 'action'): content = str(msg.action) else: # Unknown message, simply print its class name content = type(msg).__name__ # And print it to the user sprint('[{}:{}] (ID={}) {}: {}'.format( msg.date.hour, msg.date.minute, msg.id, name, content)) # Send photo elif msg.startswith('!up '): # Slice the message to get the path self.send_photo(path=msg[len('!up '):], entity=entity) # Send file (document) elif msg.startswith('!uf '): # Slice the message to get the path self.send_document(path=msg[len('!uf '):], entity=entity) # Download media elif msg.startswith('!dm '): # Slice the message to get message ID self.download_media(msg[len('!dm '):]) # Download profile photo elif msg == '!dp': output = str('usermedia/propic_{}'.format(entity.id)) print('Downloading profile picture...') success = self.download_profile_photo(entity.photo, output) if success: print('Profile picture downloaded to {}'.format( output)) else: print('No profile picture found for this user.') # Send chat message (if any) elif msg: self.send_message( entity, msg, no_web_page=True) @staticmethod def update_handler(update_object): if type(update_object) is UpdateShortMessage: if update_object.out: sprint('You sent {} to user #{}'.format( update_object.message, update_object.user_id)) else: sprint('[User #{} sent {}]'.format( update_object.user_id, update_object.message)) elif type(update_object) is UpdateShortChatMessage: if update_object.out: sprint('You sent {} to chat #{}'.format( update_object.message, update_object.chat_id)) else: sprint('[Chat #{}, user #{} sent {}]'.format( update_object.chat_id, update_object.from_id, update_object.message)) def is_user_authorized(self): """Has the user been authorized yet (code request sent and confirmed)?""" return self.session and self.get_me() is not None
def connect(self, reconnect=False, device_model=None, system_version=None, app_version=None, lang_code=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. Default values for the optional parameters if left as None are: device_model = platform.node() system_version = platform.system() app_version = TelegramClient.__version__ lang_code = 'en' """ if self.transport is None: self.transport = TcpTransport(self.session.server_address, self.session.port, proxy=self.proxy) try: if not self.session.auth_key or (reconnect and self.sender is not None): self.session.auth_key, self.session.time_offset = \ authenticator.do_authentication(self.transport) self.session.save() self.sender = MtProtoSender(self.transport, self.session) self.sender.connect() # Set the default parameters if left unspecified if not device_model: device_model = platform.node() if not system_version: system_version = platform.system() if not app_version: app_version = self.__version__ if not lang_code: lang_code = 'en' # Now it's time to send an InitConnectionRequest # This must always be invoked with the layer we'll be using query = InitConnectionRequest( api_id=self.api_id, device_model=device_model, system_version=system_version, app_version=app_version, lang_code=lang_code, query=GetConfigRequest()) result = self.invoke( InvokeWithLayerRequest( layer=layer, query=query)) # We're only interested in the DC options, # although many other options are available! self.dc_options = result.dc_options self.login_success = True return True except (RPCError, ConnectionError) as error: # Probably errors from the previous session, ignore them self._logger.warning('Could not stabilise initial connection: {}' .format(error)) return False