mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 09:56:30 +02:00
09bdb88822
* Fix passport decryption failing at random times Sometimes a decrypted secret was being treated as b64 and therefore got decoded even further. Fix by decoding b64 right before call to decrypt so we have better control of when not to do it * Bot api 4.1 Telegram passport 1.1 Added support for middle names. Added support for translations for documents Add errors for translations for documents Added support for requesting names in the language of the user's country of residence Replaced the payload parameter with the new parameter nonce NOTE: Scope stuff is NOT implemented, as we wanna STRONGLY encourage users to use the telegram provided SDKs anyway (and not generate telegram auth links in their bot, but rather on a server) * Minor fixes * Add hash to EncryptedPassportElement For use with PassportElementErrorUnspecified apparently
357 lines
14 KiB
Python
357 lines
14 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains the classes that represent Telegram PassportElementError."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class PassportElementError(TelegramObject):
|
|
"""Baseclass for the PassportElementError* classes.
|
|
|
|
Attributes:
|
|
source (:obj:`str`): Error source.
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error.
|
|
message (:obj:`str`): Error message
|
|
|
|
Args:
|
|
source (:obj:`str`): Error source.
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self, source, type, message, **kwargs):
|
|
# Required
|
|
self.source = str(source)
|
|
self.type = str(type)
|
|
self.message = str(message)
|
|
|
|
self._id_attrs = (self.source, self.type)
|
|
|
|
|
|
class PassportElementErrorDataField(PassportElementError):
|
|
"""
|
|
Represents an issue in one of the data fields that was provided by the user. The error is
|
|
considered resolved when the field's value changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of
|
|
"personal_details", "passport", "driver_license", "identity_card", "internal_passport",
|
|
"address".
|
|
field_name (:obj:`str`): Name of the data field which has the error.
|
|
data_hash (:obj:`str`): Base64-encoded data hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of
|
|
"personal_details", "passport", "driver_license", "identity_card", "internal_passport",
|
|
"address".
|
|
field_name (:obj:`str`): Name of the data field which has the error.
|
|
data_hash (:obj:`str`): Base64-encoded data hash.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
field_name,
|
|
data_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorDataField, self).__init__('data', type, message)
|
|
self.field_name = field_name
|
|
self.data_hash = data_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.field_name, self.data_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorFile(PassportElementError):
|
|
"""
|
|
Represents an issue with a document scan. The error is considered resolved when the file with
|
|
the document scan changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorFile, self).__init__('file', type, message)
|
|
self.file_hash = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorFiles(PassportElementError):
|
|
"""
|
|
Represents an issue with a list of scans. The error is considered resolved when the file with
|
|
the document scan changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hashes,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorFiles, self).__init__('files', type, message)
|
|
self.file_hashes = file_hashes
|
|
|
|
self._id_attrs = ((self.source, self.type, self.message) +
|
|
tuple([file_hash for file_hash in file_hashes]))
|
|
|
|
|
|
class PassportElementErrorFrontSide(PassportElementError):
|
|
"""
|
|
Represents an issue with the front side of a document. The error is considered resolved when
|
|
the file with the front side of the document changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"passport", "driver_license", "identity_card", "internal_passport".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"passport", "driver_license", "identity_card", "internal_passport".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorFrontSide, self).__init__('front_side', type, message)
|
|
self.file_hash = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorReverseSide(PassportElementError):
|
|
"""
|
|
Represents an issue with the front side of a document. The error is considered resolved when
|
|
the file with the reverse side of the document changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"passport", "driver_license", "identity_card", "internal_passport".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"driver_license", "identity_card".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorReverseSide, self).__init__('reverse_side', type, message)
|
|
self.file_hash = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorSelfie(PassportElementError):
|
|
"""
|
|
Represents an issue with the selfie with a document. The error is considered resolved when
|
|
the file with the selfie changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"passport", "driver_license", "identity_card", "internal_passport".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
"passport", "driver_license", "identity_card", "internal_passport".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorSelfie, self).__init__('selfie', type, message)
|
|
self.file_hash = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorTranslationFile(PassportElementError):
|
|
"""
|
|
Represents an issue with one of the files that constitute the translation of a document.
|
|
The error is considered resolved when the file changes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of "passport", "driver_license", "identity_card", "internal_passport",
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of "passport", "driver_license", "identity_card", "internal_passport",
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration".
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorTranslationFile, self).__init__('translation_file',
|
|
type, message)
|
|
self.file_hash = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorTranslationFiles(PassportElementError):
|
|
"""
|
|
Represents an issue with the translated version of a document. The error is considered
|
|
resolved when a file with the document translation change.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of "passport", "driver_license", "identity_card", "internal_passport",
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration"
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of "passport", "driver_license", "identity_card", "internal_passport",
|
|
"utility_bill", "bank_statement", "rental_agreement", "passport_registration",
|
|
"temporary_registration"
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
file_hashes,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorTranslationFiles, self).__init__('translation_files',
|
|
type, message)
|
|
self.file_hashes = file_hashes
|
|
|
|
self._id_attrs = ((self.source, self.type, self.message) +
|
|
tuple([file_hash for file_hash in file_hashes]))
|
|
|
|
|
|
class PassportElementErrorUnspecified(PassportElementError):
|
|
"""
|
|
Represents an issue in an unspecified place. The error is considered resolved when new
|
|
data is added.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue.
|
|
element_hash (:obj:`str`): Base64-encoded element hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue.
|
|
element_hash (:obj:`str`): Base64-encoded element hash.
|
|
message (:obj:`str`): Error message.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
element_hash,
|
|
message,
|
|
**kwargs):
|
|
# Required
|
|
super(PassportElementErrorUnspecified, self).__init__('unspecified', type, message)
|
|
self.element_hash = element_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.element_hash, self.message)
|