├── cache.json ├── mypy.ini ├── requirements.txt ├── .gitignore ├── api_keys.py ├── README.rst ├── checkURL.py ├── textRoutes.py ├── main.py ├── log.py ├── resolveUsername.py └── LICENSE /cache.json: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /mypy.ini: -------------------------------------------------------------------------------- 1 | [mypy] 2 | ignore_missing_imports = True -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Telethon 2 | ujson 3 | aiohttp 4 | beautifulsoup4 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | venv 2 | .idea 3 | 4 | # these are files which are changed on a per instance basis, no need to track them in the repo 5 | api_keys.py 6 | log.log 7 | *.session 8 | *.session-journal 9 | cache.json -------------------------------------------------------------------------------- /api_keys.py: -------------------------------------------------------------------------------- 1 | from typing import Mapping 2 | 3 | # the allowed keys are a dict of strings, mapping keys to project names. These names are used in the stats message which 4 | # is send regularly, at least in the first days of this API. I use the 4 word "sentences" as below because they are 5 | # funny, but you can do whatever you want. This implementations means a restart of the service is necessary to add a 6 | # new key, but that's not an issue for now 7 | ALLOWED_KEYS: Mapping[str, str] = {"RationalGymsGripOverseas": "VeryCoolProject"} 8 | # these are taken from my.telegram.org, you have to get your own 9 | api_id: int = 1234 10 | api_hash: str = "Wuhu" 11 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ================= 2 | UsernameToChatAPI 3 | ================= 4 | 5 | This project aims to give telegram bot developers an easy way to get Chat objects for usernames. The documentation 6 | for the API itself lies in textRoutes. 7 | 8 | This project is very much in an early alpha phase and should not be used in production. 9 | 10 | A running instance can be found at https://usernameToChatAPI.de 11 | 12 | ===================== 13 | Run your own instance 14 | ===================== 15 | 16 | All you need to do is change the api id and hash in api_keys.py, as well as LOG_ID in the log.py file. I recommend inserting 17 | a joinchat link there. The first account you enter needs to be able to write there. 18 | You also need to change the api keys, and you could change the owner insert in textRoutes. 19 | Then install the requirements and run main :) 20 | 21 | The first time you run main, the call will ask you for a phone number. This will be the telegram account used for getting 22 | the user_id from telegram. You can add more then one account, for that, change the CLIENT constant in main.py. The more 23 | accounts you enter, the better can the server mitigate FloodWait errors. 24 | 25 | ============ 26 | Contributing 27 | ============ 28 | 29 | Thanks for thinking about this. I use black and mypy for code quality, and I adhere to the CSI standard for commenting: 30 | https://standards.mousepawmedia.com/csi.html. If you want to add something to this project, just open an issue and get 31 | the ok first, I would hate for you to waste time if I think it doesn't fit. -------------------------------------------------------------------------------- /checkURL.py: -------------------------------------------------------------------------------- 1 | from aiohttp import web 2 | from typing import TYPE_CHECKING 3 | 4 | from api_keys import ALLOWED_KEYS 5 | from resolveUsername import create_error_response 6 | 7 | if TYPE_CHECKING: 8 | from typing import Mapping, Callable, Awaitable 9 | from telethon import TelegramClient 10 | from main import Username 11 | from aiohttp import ClientSession 12 | 13 | 14 | # This is a generic url checker. It is a bit over the top for the on request this projects supports so far, but it will 15 | # make it very easy to extend it later on. 16 | async def check_url( 17 | request: web.Request, 18 | expected_parameters: list, 19 | route_to: "Callable[[web.Request, list[TelegramClient], Mapping[str, Username], ClientSession]," 20 | "Awaitable[web.Response]]", 21 | clients: "list[TelegramClient]", 22 | cache: "Mapping[str, Username]", 23 | session: "ClientSession", 24 | ) -> web.Response: 25 | # this loop goes through all the expected parameters and check if they exists in the URL. If they do not, a Bad 26 | # Request is thrown, providing the missing parameter 27 | for parameter in expected_parameters: 28 | if parameter not in request.rel_url.query: 29 | error_string = parameter + " is missing." 30 | return web.json_response( 31 | data=create_error_response(400, error_string), status=400 32 | ) 33 | # if the api_key parameter is present, this part checks if the key is present in the list of keys. If it is not, 34 | # an Unauthorized error is thrown 35 | if "api_key" in expected_parameters: 36 | if request.rel_url.query["api_key"] not in ALLOWED_KEYS: 37 | error_string = "Unauthorized" 38 | return web.json_response( 39 | data=create_error_response(401, error_string), status=401 40 | ) 41 | # now the function which is supposed to handle the request gets the request, next to the three initiated objects, 42 | # which they can not import because of circular imports 43 | return await route_to(request, clients, cache, session) 44 | -------------------------------------------------------------------------------- /textRoutes.py: -------------------------------------------------------------------------------- 1 | from aiohttp import web 2 | 3 | # these functions just return strings. It might make sense to move them to their own folder later and turn them to plain 4 | # html files. 5 | 6 | 7 | async def index(request: web.Request): 8 | owner_insert = ( 9 | "Since you discovered this text on the https://usernameToChatAPI.de URL, https://t.me/poolitzer (me \o/)" 10 | " is/am the owner of this instance. I am willing to give you a key, just PM me on Telegram, tell me how " 11 | "many requests per time you are going to do roughly and I will see how it fits in the correct project " 12 | "utilisation." 13 | ) 14 | string = ( 15 | "Hello there.\n\nYou stumbled over a running instance of the usernameToChatAPI project. The purpose of this " 16 | "API " 17 | "is to provide a way for Telegram Bots which are using the HTTP API to resolve usernames to chat objects. This " 18 | "mitigates the need for these bots to write their own interaction with the foreign MTProto API. Instead, they " 19 | "can use this API and profit from less setup and known objects. The project is Open Source and can be found at " 20 | "https://github.com/Poolitzer/usernameToChatAPI. It is licensed under GNU GPLv3.\n\nIf you are interested to " 21 | f"integrate this API in your project, amazing. You will need an api key to use this project. {owner_insert}\n\n" 22 | f"Once you have the API key, head over to {request.url.origin()}/api_doc to check out the (very small) " 23 | f"documentation for this API.\n\nThe great python-telegram-bot library has a contrib submodule, " 24 | f"which provides a " 25 | f"neat integration of this API in the library. Check it out at https://github.com/python-telegram-bot/" 26 | f"ptbcontrib/tree/main/ptbcontrib/username_to_chat_api." 27 | ) 28 | return web.Response(text=string) 29 | 30 | 31 | async def api_documentation(_: web.Request): 32 | string = ( 33 | "This document represents the whole documentation of the usernameToChatAPI.\n\nThere is currently one " 34 | "supported GET request: resolveUsername. This method takes two parameters, api_key and username. Submit them " 35 | "via an URL query string. If you want a different way of submitting these parameters, open an issue about it, " 36 | "and we will find a way. The api_key is case sensitive, the username can be passed with or without a leading @." 37 | "\n\nThe successful call will result in a json response, mimicking the getChat response from " 38 | "the telegram API for the respective types: https://core.telegram.org/bots/api#chat. Bio/description are " 39 | "passed if present as well. Photo is not passed, this wouldn't make sense.\n\nError handling is the same as " 40 | "telegram does it. Expected errors are 400, when the chat is not found or parameters are missing, 401, when " 41 | "the API key is wrong, and 429, if the API is hit with a " 42 | "flood wait error. The retry_after attribute is present in this case so you can wait that long before making " 43 | "more requests." 44 | ) 45 | return web.Response(text=string) 46 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from functools import partial 3 | 4 | from telethon import TelegramClient 5 | from aiohttp import web, ClientSession 6 | import ujson as json 7 | from typing import TypedDict, TYPE_CHECKING 8 | 9 | from checkURL import check_url 10 | from resolveUsername import endpoint 11 | from api_keys import api_id, api_hash 12 | from log import send_counter 13 | import textRoutes 14 | 15 | if TYPE_CHECKING: 16 | from typing import Mapping 17 | 18 | import logging 19 | 20 | logging.basicConfig( 21 | format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", filename="log.log" 22 | ) 23 | # this is the amounts of clients you want to initialize. The higher, the more you can migiate flood wait, because the 24 | # code will switch to the next 25 | CLIENTS = 1 26 | # x will be used to get up to client 27 | x = 0 28 | # This will be used to make requests to telegram's API. We throw the clients in a list 29 | clients: list[TelegramClient] = [] 30 | # in this loop we add the unique clients to the dict 31 | while x != CLIENTS: 32 | clients.append(TelegramClient("session_" + str(x), api_id, api_hash)) 33 | x += 1 34 | 35 | 36 | # This is the type hinted layout of the temp storage, so mypy can use this to do its type checking 37 | class Username(TypedDict): 38 | bio: str 39 | chat_id: int 40 | chat_type: str 41 | first_name: str 42 | last_name: str 43 | 44 | 45 | # the cache is just this json file. With this and scraping the telegram website, we can do less requests to the API 46 | # if the website and our temp storage are the same, we dont need to renew it with an API call 47 | cache: "Mapping[str, Username]" = json.load(open("cache.json", "rb")) 48 | 49 | 50 | # this creates a usable session. You only want to do this once in order to benefit from collection pooling 51 | async def session_creator() -> ClientSession: 52 | return ClientSession() 53 | 54 | 55 | # this saves the temp storage dict to the json file every hour. if that breaks nothing important is lost 56 | async def save() -> None: 57 | # the while loop takes care that the saving never stops :D 58 | while True: 59 | # this opens the file for writing as a file 60 | with open("cache.json", "w") as outfile: 61 | # and here it gets dumped, with the indent of 4 and sorted keys, so its nice to look at 62 | json.dump(cache, outfile, indent=4, sort_keys=True) 63 | # and here this sleeps for an hour (60 minutes * 60 seconds 64 | await asyncio.sleep(60 * 60) 65 | 66 | 67 | # this gets the event loop, in order for us to register/call functions in it 68 | loop = asyncio.get_event_loop() 69 | # first, we have to create the session, so we can pass it on later. Remember, you only want one 70 | session = loop.run_until_complete(session_creator()) 71 | 72 | # the app is the initiated web application 73 | app = web.Application() 74 | # here we add the router to each URL we want to support. every URL gets passed the check function first, which make 75 | # sure all expected parameters exists, and then makes sure the api_key is allowed, if it is present. Then it reroutes 76 | # the request to the route_to function, and passes on cache, client, and session. I wasn't able to directly 77 | # import it because of circular imports, and this is the reason I went with partial, maybe someone can improve this 78 | # later 79 | app.router.add_get( 80 | "/resolveUsername", 81 | partial( 82 | check_url, 83 | expected_parameters=["api_key", "username"], 84 | route_to=endpoint, 85 | clients=clients, 86 | cache=cache, 87 | session=session, 88 | ), 89 | ) 90 | 91 | # these two handlers are text only, they don't need the checker 92 | app.router.add_get("/", textRoutes.index) 93 | app.router.add_get("/api_doc", textRoutes.api_documentation) 94 | 95 | # the runner gets initiated 96 | runner = web.AppRunner(app) 97 | # and set up 98 | loop.run_until_complete(runner.setup()) 99 | # this defines the site which is supposed to run 100 | site = web.TCPSite(runner, host="localhost", port=1234) 101 | # and here the site gets started 102 | loop.run_until_complete(site.start()) 103 | # this connects the client to telegram 104 | for c_client in clients: 105 | c_client.start() 106 | # this task sends a log for how many calls each api key did, every now and then (an hour right now 107 | loop.create_task(send_counter(clients[0])) 108 | # the save task gets created here 109 | loop.create_task(save()) 110 | # and this is the final call which runs forever. 111 | loop.run_forever() 112 | -------------------------------------------------------------------------------- /log.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import sys 3 | import traceback 4 | 5 | from telethon import TelegramClient 6 | from aiohttp import web 7 | 8 | from api_keys import ALLOWED_KEYS 9 | 10 | # this module is used to do some (for the time being quite intense) logging to a telegram channel 11 | 12 | LOG_ID = "https://t.me/joinchat/TilGN79" 13 | 14 | 15 | async def log_call( 16 | client: TelegramClient, 17 | username="", 18 | rg_traceback="", 19 | fw_traceback="", 20 | all_clients_hit="", 21 | username_not_found="", 22 | ) -> None: 23 | # this is the base string, which will get appended based on the difference calls 24 | string_to_send = "" 25 | if rg_traceback: 26 | # this tracebacks is when the regex for the site fails in one case, which only happens when the username is 27 | # invalid, or so I hope. This is to check this, if it triggers wrongly, we have to investigate further 28 | string_to_send += ( 29 | "The excepted regex fail happened, with the username @" 30 | + username 31 | + " and the following traceback:\n```" 32 | + rg_traceback 33 | + "```" 34 | ) 35 | elif fw_traceback: 36 | # the floodwait from telegram is likely going to limit this API a bit, so it gets its own error 37 | string_to_send += ( 38 | "A FloodWait happened!!! With the username @" 39 | + username 40 | + " and the following traceback:\n```" 41 | + fw_traceback 42 | + "```" 43 | ) 44 | elif all_clients_hit: 45 | # this is returned when all clients are hit with a FloodWait simultaneously 46 | string_to_send += ( 47 | "All clients are hit with a floodwait. These are the current wait times:" 48 | + all_clients_hit 49 | ) 50 | elif username_not_found: 51 | # this happens when the api cant resolve the username 52 | string_to_send += ( 53 | "This username was resolved by the API but doesn't exist. " 54 | + username_not_found 55 | ) 56 | # this gets send to a channel 57 | await client.send_message(LOG_ID, string_to_send) 58 | 59 | 60 | # this counter is used to save how many calls are being done per API call 61 | counter = {} 62 | 63 | 64 | async def increase_counter(api_key: str, call_type: str) -> None: 65 | # here the name gets taken from the allowed keys dict 66 | name = ALLOWED_KEYS[api_key] 67 | # if its not present in the dict, add it here 68 | if name not in counter: 69 | counter[name] = {"cache": 0, "api_call": 0} 70 | # increase the counter, so it happened once more 71 | counter[name][call_type] += 1 72 | 73 | 74 | async def send_counter(client: TelegramClient) -> None: 75 | # same logic as the cache save, which means each startup gets a message from this 76 | while True: 77 | # this is the base string, on that 78 | string_to_send = "This time, the following bots used these many calls:\n\n" 79 | # we append the counter per api key 80 | for name in counter: 81 | string_to_send += f"• {name} - Cache: {counter[name]['cache']}, API calls: {counter[name]['api_call']}\n" 82 | # nice bye here 83 | string_to_send += "\nSee you again in an hour :)" 84 | # sending it 85 | await client.send_message(LOG_ID, string_to_send) 86 | # clearing the dict so we dont count twice 87 | counter.clear() 88 | # and sleeping for an hour 89 | await asyncio.sleep(60 * 60) 90 | 91 | 92 | # the purpose of this decorator function will try to send errors to telegram when they happen 93 | def exception_decorator(func): 94 | # this is an async wrap function 95 | async def wrap_func(*args, **kwargs): 96 | try: 97 | return await func(*args, **kwargs) 98 | except Exception as e: 99 | if isinstance(e, web.HTTPException): 100 | # if the error is an instance of the HTTP errors, this means I have raised them manually earlier, so 101 | # no need to panic. they have their own log calls anyway. 102 | return e 103 | # this catches every exception. now we have to get the initiated client from the params 104 | client = False 105 | for arg in args: 106 | # if the type of the unnamed args is a list and the first item in the list is a TelegramClient, 107 | # we found the client \o/ 108 | if type(arg) == list: 109 | if type(arg[0]) == TelegramClient: 110 | client = arg[0] 111 | break 112 | if not client: 113 | # if args didn't yield a client, it could be in kwargs, so we check. This requires the clients list to 114 | # always be passed as clients. If I mistype that at some place, I could break it, yay 115 | if "clients" in kwargs: 116 | client = kwargs["clients"][0] 117 | else: 118 | # if we don't have a client here, it doesn't exists, so we raise 119 | raise 120 | # traceback.format_tb returns the usual python message about an exception, but as a 121 | # list of strings rather than a single string, so we have to join them together. 122 | tb_list = traceback.format_tb(sys.exc_info()[2]) 123 | tb_string = "".join(tb_list) 124 | # now the string, telling the kind of error and where it happened 125 | string_to_send = ( 126 | f"Oh no, an unexpected error happened, but at least I can tell you about it. The name is" 127 | f" `{e.__repr__()}`, the traceback:\n```" + tb_string + "```" 128 | ) 129 | # sending it 130 | await client.send_message(LOG_ID, string_to_send) 131 | # and writing it to our logfile 132 | raise 133 | 134 | return wrap_func 135 | -------------------------------------------------------------------------------- /resolveUsername.py: -------------------------------------------------------------------------------- 1 | import html 2 | import re 3 | import traceback 4 | from typing import Generator, TypedDict, TYPE_CHECKING 5 | import sys 6 | import asyncio 7 | 8 | from aiohttp import web, web_response 9 | from bs4 import BeautifulSoup 10 | from bs4.element import Tag, NavigableString 11 | from telethon.tl.functions.channels import GetFullChannelRequest 12 | from telethon.tl.functions.users import GetFullUserRequest 13 | from telethon import errors 14 | 15 | # these calls are temporarily to monitor the behaviour of the api 16 | from log import log_call, exception_decorator, increase_counter 17 | 18 | if TYPE_CHECKING: 19 | from aiohttp import ClientSession 20 | from telethon import TelegramClient 21 | from typing import Tuple, Union, Literal, MutableMapping, Mapping 22 | 23 | from main import Username 24 | 25 | # this is a dictionary which will hold clients which are in a floodwait, so we can use other ones 26 | flood_wait: "MutableMapping[str, Union[bool, int]]" = {} 27 | 28 | # usernames which are banned on iOS devices but actual fine chats. the website might not work for them, so I hardcode 29 | # them here when I encounter them and do not try the website for them later on. I have to map the names to their chat 30 | # type because otherwise we get the type from the website 31 | COPYRIGHT_USERNAMES: "Mapping[str, str]" = {"utubebot": "private"} 32 | 33 | 34 | class RegexFailedError(Exception): 35 | # this custom error class is just used to pass the expected regex fail when an username is invalid to the higher 36 | # function. this should avoid swallowing an different IndexError 37 | pass 38 | 39 | 40 | def get_text(tag: "Tag") -> str: 41 | """ 42 | This function only replaces
tags with \n right now. If more issues with the website bio vs API bio show up, 43 | this can be used to battle them. This code is taken with much thanks from 44 | https://stackoverflow.com/a/66835172/12692773, published by Vijay Hebbar[https://github.com/vjhebbar]. 45 | """ 46 | 47 | def _get_text(tag2: Tag) -> Generator: 48 | # this iterates through all provided tags 49 | for child in tag2.children: 50 | # if the child is a Tag, it gets processed, otherwise only the text content gets yielded 51 | if type(child) is Tag: 52 | # here, br is replaced or it gets passed on to the function itself 53 | yield from ["\n"] if child.name == "br" else _get_text(child) 54 | elif type(child) is NavigableString: 55 | yield child.string 56 | 57 | # and the content gets squashed in one string 58 | return "".join(_get_text(tag)) 59 | 60 | 61 | async def website(username: str, session: "ClientSession") -> "Tuple[str, str, str]": 62 | """ 63 | This function parses the website and returns the three information which one can get from it 64 | """ 65 | # this sets together the url and "awaits" the result 66 | # Reminder: If we ever get limited from telegram to call this website, we should deal with this here 67 | async with session.get("https://t.me/" + username) as response: 68 | # the whole website is put in one string here for further processing 69 | html_string = await response.text() 70 | # the next lines take care of the biography, if it exists. I have to use BS4 to parse its content properly 71 | parsed_html = BeautifulSoup(html_string, features="html.parser") 72 | bio_div = parsed_html.body.find("div", attrs={"class": "tgme_page_description"}) 73 | if bio_div: 74 | bio = get_text(bio_div) 75 | else: 76 | bio = "" 77 | # this gets the name (set together from first_name + " " + last_name or just the title) from the chat 78 | names = html.unescape( 79 | re.findall('', html_string)[0] 80 | ) 81 | # this is used to determine the chat type. I am pretty sure I had an example where the first regex was necessary 82 | # , though I am unable to find it right now. The second one is the usual one though. 83 | result = re.findall( 84 | '
\n {2}(.*)\n
|' 85 | '
(.*)
', 86 | html_string, 87 | ) 88 | # this sets the extra variable to the result, depending on which regex triggered it 89 | # if the regex fails, the username doesn't exists, or at least I hope so. This is also closely monitored for now 90 | try: 91 | if result[0][0]: 92 | extra = result[0][0] 93 | else: 94 | extra = result[0][1] 95 | except IndexError: 96 | # this is a bit of a hacky way to tell the code later that the username is invalid 97 | raise RegexFailedError 98 | # now we can determine the type depending on the extra. its going to be the username for private chats, 99 | # the members count for channels, the members count + online members for supergroups. 100 | if extra.startswith("@"): 101 | chat_type = "private" 102 | elif "online" in extra: 103 | chat_type = "supergroup" 104 | else: 105 | chat_type = "channel" 106 | # and we return the three important information as a tuple 107 | return names, bio, chat_type 108 | 109 | 110 | # type hint for the response, same way telegram returns it. Non existing keys are dropped, that's why total is false 111 | class ResponseData(TypedDict, total=False): 112 | id: int 113 | type: str 114 | username: str 115 | first_name: str 116 | last_name: str 117 | title: str 118 | bio: str 119 | description: str 120 | 121 | 122 | # and the one from above are nested into this 123 | class ResponseDict(TypedDict): 124 | ok: bool 125 | result: ResponseData 126 | 127 | 128 | # this creates the response dict 129 | def create_response(username: str, info_dict: "Username") -> ResponseDict: 130 | # this basic construct is the same for private + channel chats, so we define it here 131 | data: ResponseDict = { 132 | "ok": True, 133 | "result": { 134 | "id": info_dict["chat_id"], 135 | "type": info_dict["chat_type"], 136 | "username": username, 137 | }, 138 | } 139 | # now the difference between private and channels. the if clauses are used to simulate how telegram builds the json, 140 | # only showing the keys which have information. 141 | if info_dict["chat_type"] == "private": 142 | data["result"]["first_name"] = info_dict["first_name"] 143 | if info_dict["last_name"]: 144 | data["result"]["last_name"] = info_dict["last_name"] 145 | if info_dict["bio"]: 146 | data["result"]["bio"] = info_dict["bio"] 147 | else: 148 | # the bot api has the prepending -100 for supergroups/channels, so we add it here 149 | data["result"]["id"] = int("-100" + str(data["result"]["id"])) 150 | data["result"]["title"] = info_dict["first_name"] 151 | if info_dict["bio"]: 152 | data["result"]["description"] = info_dict["bio"] 153 | return data 154 | 155 | 156 | def create_error_response(code, description, retry_after=None): 157 | data = { 158 | "ok": False, 159 | "error_code": code, 160 | "description": description, 161 | } 162 | if retry_after: 163 | data["retry_after"] = retry_after 164 | return data 165 | 166 | 167 | # the exception decorator will try to send a message to telegram telling me about an error here 168 | @exception_decorator 169 | async def endpoint( 170 | request: web.Request, 171 | clients: "list[TelegramClient]", 172 | cache: "MutableMapping[str, Username]", 173 | session: "ClientSession", 174 | ) -> web.Response: 175 | # this is just here so mypy is happy. It could stay as the first client, but could change later, that happens in the 176 | # for loop 177 | # this client variable will be set to the client if they aren't all hit with a flood error 178 | client: "TelegramClient" = clients[0] 179 | # from the available clients, we select one 180 | for potential_client in clients: 181 | # noinspection PyUnresolvedReferences 182 | # the above line is so PyCharm doesn't complain over a valid access. We use the filename as a unique 183 | # name for the client, which should make it easy to add more clients in the future 184 | client_name = potential_client.session.filename 185 | # this checks if the client is not in flood wait, then we select it 186 | if client_name not in flood_wait: 187 | client = potential_client 188 | break 189 | elif potential_client == clients[-1]: 190 | # this logic is True if all clients are hit by a floodwait error. Currently, this timer 191 | # is updated every second, so we are not missing time. Depending on the limits we hit and the strain this 192 | # countdown (especially with several clients) puts on our system we might need to change this. The logic 193 | # behind this is good though: The client_name is set to False if no flood, or a number if its flood 194 | # the response mimics telegrams error responses. We pass the lowest floodwait as error. 195 | return web.json_response( 196 | data=create_error_response( 197 | 429, "Telegram forces us to wait", flood_wait[min(flood_wait)] 198 | ), 199 | status=429, 200 | ) 201 | # this gets the username from the url query 202 | user_name = request.rel_url.query["username"] 203 | # if the submitted username starts with an @, it is removed here. not having it later is exactly how telegram 204 | # returns usernames, so this is fine 205 | if user_name.startswith("@"): 206 | user_name = user_name[1:] 207 | # this is set to the cached data, if it exists, so we can use it to compare it to the website 208 | known: Union[Literal[False], "Username"] = False 209 | if user_name.lower() in cache: 210 | # setting it to lower avoids issues with the case 211 | known = cache[user_name.lower()] 212 | # this check does not try to parse websites for usernames which exist but generate a wrong website. 213 | if user_name.lower() not in COPYRIGHT_USERNAMES: 214 | # this subscribes the tuple result to three unique variables 215 | try: 216 | names, bio, chat_type = await website(user_name, session=session) 217 | except RegexFailedError: 218 | # if that error is raised, this means the username is invalid (or so I hope), so we raise a BadRequest 219 | # error. 220 | # we also log this (and the traceback) to a channel so we can do close monitoring for now 221 | # traceback.format_tb returns the usual python message about an exception, but as a 222 | # list of strings rather than a single string, so we have to join them together. We use the first client 223 | # to log 224 | # because that is the one which we require to be in the log chat 225 | tb_list = traceback.format_tb(sys.exc_info()[2]) 226 | tb_string = "".join(tb_list) 227 | await log_call(clients[0], user_name, rg_traceback=tb_string) 228 | # this gives the error to the user the same way telegram does 229 | return web.json_response( 230 | data=create_error_response(400, "Bad Request: chat not found"), 231 | status=400, 232 | ) 233 | # known is set to the cached data, so if we have data here, we can use it 234 | if known: 235 | known_names = known["first_name"] 236 | # names is the result of the website. it combines first and last name from a user with a space, so we 237 | # do it here as well. for chats, we have their title set as first_name and no last_name/space issue 238 | if known["last_name"]: 239 | known_names += " " + known["last_name"] 240 | # if all three properties are the same, we assume the chat_id is as well, and use our cached values. This 241 | # could lead to an issue if only the id changes, but all other properties stay the same. This will be 242 | # closely monitored for the time being. But using the cache should avoid hitting the flood wait too much 243 | if ( 244 | names == known_names 245 | and bio == known["bio"] 246 | and chat_type == known["chat_type"] 247 | ): 248 | # this function call increases a counter for how many requests each api key did 249 | await increase_counter(request.rel_url.query["api_key"], "cache") 250 | # here we pass the cached data to the dict creation and then return the json response as response 251 | data = create_response(user_name, known) 252 | return web.json_response(data=data) 253 | else: 254 | # we set chat type from the hardcoded dict, because we need it to call the correct api method 255 | chat_type = COPYRIGHT_USERNAMES[user_name.lower()] 256 | # if we reached this part of the code, we either don't have cached values, or they are out of date, or we couldn't 257 | # use the website to verify them. So we get new 258 | # ones from telegram at this point. This is its own function because we need it to be recursive to switch clients 259 | potential_error = await get_chat_from_api( 260 | client, chat_type, user_name, clients, cache 261 | ) 262 | # a floodwait response could be returned so we check for it here 263 | if type(potential_error) == web_response.Response: 264 | # this needs to be returned to the server so we return 265 | return potential_error 266 | # this function call increases a counter for how many requests each api key did 267 | await increase_counter(request.rel_url.query["api_key"], "api_call") 268 | # here it is send to the dict creation function, and the result is given as a web response. Getting it from cache 269 | # might be a bit resource wasting, but this is python, so who cares 270 | data = create_response(user_name, cache[user_name.lower()]) 271 | return web.json_response(data=data) 272 | 273 | 274 | async def flood_runs_out(client: str) -> None: 275 | # this is the countdown to update the flood wait time. It is set to one second right now, this can be 276 | # changed/made smarter later. 277 | while flood_wait[client] >= 0: 278 | await asyncio.sleep(10) 279 | # subtracting one second from the time we have to wait because we slept one second 280 | flood_wait[client] -= 10 281 | # if wait is 0 or less, we set it to false, and then break the loop. 282 | del flood_wait[client] 283 | 284 | 285 | async def get_chat_from_api( 286 | client: "TelegramClient", 287 | chat_type: str, 288 | user_name: str, 289 | clients: "list[TelegramClient]", 290 | cache: "MutableMapping[str, Username]", 291 | ): 292 | # this whole function is recursive. It will call itself if one client reaches a FloodWaitError 293 | try: 294 | if chat_type == "private": 295 | # noinspection PyTypeChecker 296 | # the above line is so PyCharm doesn't complain about user_name being the username, telethon is totally fine 297 | # with this. We have to get the full user/chat in order to get the bio of the chat 298 | full = await client(GetFullUserRequest(user_name)) 299 | else: 300 | # noinspection PyTypeChecker 301 | # same as above, just a slightly different api call 302 | full = await client(GetFullChannelRequest(user_name)) 303 | except errors.FloodWaitError as e: 304 | # now we can check if there are other clients left we can try 305 | # since we have to do the exact same logic for the non private chat, I moved it to it's own function, see 306 | # below 307 | await flood_error(client, user_name, e, clients) 308 | # now we can check if there are more clients available to instead do the function call 309 | # how this for loop works, see above 310 | for potential_client in clients: 311 | # noinspection PyUnresolvedReferences 312 | client_name = potential_client.session.filename 313 | # this checks if the client is not in flood wait, then we select it 314 | if client_name not in flood_wait: 315 | return await get_chat_from_api( 316 | potential_client, chat_type, user_name, clients, cache 317 | ) 318 | # If we reached this part of the code, it means all clients are sadly hit with a FloodWait. We return the lowest 319 | # and go on with our life 320 | # this also resolves in a specific log call 321 | await log_call(clients[0], user_name, all_clients_hit=str(flood_wait)) 322 | return web.json_response( 323 | create_error_response(429, "Telegram forces us to wait", e.seconds), 324 | status=429, 325 | ) 326 | except ValueError as e: 327 | # the ValueError happens when the API returns that the username is unknown. This could happen with the hardcoded 328 | # values, or just with a very badly timed username change 329 | await log_call(clients[0], user_name, username_not_found=e.args[0]) 330 | # we return the bad request to the user 331 | return web.json_response( 332 | data=create_error_response(400, "Bad Request: chat not found"), 333 | status=400, 334 | ) 335 | except TypeError as e: 336 | # for some reasons, some channels show up as private chats from the website. if that happens, telegram throws 337 | # a typeerror, so we expect it, change the type and call the function again. I would really like to do something 338 | # about this, but I can't reproduce it 339 | if chat_type == "private": 340 | # it could also be a supergroup, I have no idea, I would rather say its something it isn't but still serve 341 | # the id 342 | return await get_chat_from_api( 343 | client, "channel", user_name, clients, cache 344 | ) 345 | else: 346 | # this is luckily clear 347 | return await get_chat_from_api( 348 | client, "private", user_name, clients, cache 349 | ) 350 | # and we write it to the cache. We loose capitalization of the username here, but that doesn't matter, since 351 | # they are case insensitive. We always return the username they put in the URL anyway 352 | if chat_type == "private": 353 | cache[user_name.lower()] = { 354 | "first_name": full.users[0].first_name, 355 | "last_name": full.users[0].last_name, 356 | "bio": full.full_user.about, 357 | "chat_type": chat_type, 358 | "chat_id": full.users[0].id, 359 | } 360 | # we don't have a last_name in other chats, so we set it to an empty string. Also, the return type is slightly 361 | # different 362 | else: 363 | cache[user_name.lower()] = { 364 | "first_name": full.chats[0].title, 365 | "last_name": "", 366 | "bio": full.full_chat.about, 367 | "chat_type": chat_type, 368 | "chat_id": full.chats[0].id, 369 | } 370 | 371 | 372 | async def flood_error( 373 | client: "TelegramClient", 374 | user_name: str, 375 | e: errors.FloodWaitError, 376 | clients: "list[TelegramClient]", 377 | ): 378 | # noinspection PyUnresolvedReferences 379 | # again, the above line is so PyCharm doesn't complain over a valid access. We use the filename as a unique 380 | # name for the client, which should make it easy to add more clients in the future 381 | client_name = client.session.filename 382 | # we set this to True so we don't spam telegram any more then needed 383 | flood_wait[client_name] = e.seconds 384 | # this runs the function in the background 385 | asyncio.create_task(flood_runs_out(client_name)) 386 | # and we tell our users about this. Maybe we should provide a better way to access the seconds value, I will 387 | # think about this later 388 | tb_list = traceback.format_tb(sys.exc_info()[2]) 389 | tb_string = "".join(tb_list) 390 | # we add the seconds we wait for so we can make decisions based on this 391 | tb_string += "\n\nWaiting for " + str(e.seconds) + " seconds." 392 | await log_call(clients[0], user_name, fw_traceback=tb_string) 393 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------