├── .github └── FUNDING.yml ├── InlineBot ├── __init__.py ├── __main__.py ├── database │ ├── __init__.py │ ├── filterbase.py │ └── userbase.py ├── helper_funcs.py ├── plugins │ ├── adminplugin.py │ ├── base_commands.py │ ├── import_export.py │ ├── inline_query.py │ └── set_filters.py └── strings.py ├── LICENSE ├── Procfile ├── README.md ├── app.json ├── requirements.txt └── runtime.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: ['https://github.com/sponsors/CodeXBotz'] 4 | -------------------------------------------------------------------------------- /InlineBot/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import os 6 | 7 | API_HASH = os.environ.get("API_HASH", "") 8 | APP_ID = int(os.environ.get("APP_ID", "")) 9 | DB_URI = os.environ.get("DATABASE_URL", "") 10 | BOT_TOKEN = os.environ.get("TG_BOT_TOKEN", "") 11 | TG_BOT_WORKERS = int(os.environ.get("BOT_WORKERS", '4')) 12 | DB_NAME = os.environ.get("DATABASE_NAME", "InlineFilterBot") 13 | thumb = os.environ.get('THUMBNAIL_URL', 'https://telegra.ph/file/516ca261de9ebe7f4ffe1.jpg') 14 | OWNER_ID = int(os.environ.get('OWNER_ID')) 15 | CUSTOM_START_MESSAGE = os.environ.get('START_MESSAGE','') 16 | FILTER_COMMAND = os.environ.get('FILTER_COMMAND', 'add') 17 | DELETE_COMMAND = os.environ.get('DELETE_COMMAND', 'del') 18 | IS_PUBLIC = True if os.environ.get('IS_PUBLIC', 'True').lower() != 'false' else False 19 | try: 20 | ADMINS=[OWNER_ID] 21 | for x in (os.environ.get("ADMINS", "").split()): 22 | ADMINS.append(int(x)) 23 | except ValueError: 24 | raise Exception("Your Admins list does not contain valid integers.") 25 | 26 | #---------- ---------- ---------- ---------- 27 | 28 | import logging 29 | from logging.handlers import RotatingFileHandler 30 | 31 | LOG_FILE_NAME = "codexbotz.txt" 32 | 33 | logging.basicConfig( 34 | level=logging.INFO, 35 | format="[%(asctime)s - %(levelname)s] - %(name)s - %(message)s", 36 | datefmt='%d-%b-%y %H:%M:%S', 37 | handlers=[ 38 | RotatingFileHandler( 39 | LOG_FILE_NAME, 40 | maxBytes=50000000, 41 | backupCount=10 42 | ), 43 | logging.StreamHandler() 44 | ] 45 | ) 46 | logging.getLogger("pyrogram").setLevel(logging.WARNING) 47 | 48 | def LOGGER(name: str) -> logging.Logger: 49 | return logging.getLogger(name) 50 | 51 | #---------- ---------- ---------- ---------- 52 | from pyrogram import Client 53 | 54 | class CodeXBotz(Client): 55 | def __init__(self): 56 | super().__init__( 57 | "bot", 58 | api_hash=API_HASH, 59 | api_id=APP_ID, 60 | plugins={ 61 | "root": "InlineBot/plugins" 62 | }, 63 | workers=TG_BOT_WORKERS, 64 | bot_token=BOT_TOKEN 65 | ) 66 | self.LOGGER = LOGGER 67 | 68 | async def start(self): 69 | await super().start() 70 | bot_details = await self.get_me() 71 | self.LOGGER(__name__).info(f"@{bot_details.username} started!") 72 | self.LOGGER(__name__).info("Created by 𝘾𝙤𝙙𝙚 𝕏 𝘽𝙤𝙩𝙯\nhttps://t.me/CodeXBotz") 73 | self.bot_details = bot_details 74 | 75 | async def stop(self, *args): 76 | await super().stop() 77 | self.LOGGER(__name__).info("Bot stopped. Bye.") 78 | 79 | #---------- ---------- ---------- ---------- 80 | 81 | from pyrogram import filters 82 | from pyrogram.types import ( 83 | Message, 84 | InlineQuery, 85 | CallbackQuery, 86 | InlineKeyboardMarkup, 87 | InlineKeyboardButton, 88 | InlineQueryResultPhoto, 89 | InputTextMessageContent, 90 | InlineQueryResultArticle, 91 | InlineQueryResultCachedPhoto, 92 | InlineQueryResultCachedDocument 93 | ) 94 | 95 | def is_owner(_, __, update): 96 | try: 97 | user_id = update.from_user.id 98 | except: 99 | return False 100 | 101 | if user_id == OWNER_ID: 102 | return True 103 | else: 104 | return False 105 | 106 | def is_admin(_, __, update): 107 | try: 108 | user_id = update.from_user.id 109 | except: 110 | return False 111 | 112 | if user_id in ADMINS: 113 | return True 114 | else: 115 | return False 116 | def check_inline(_, __, update): 117 | try: 118 | user_id = update.from_user.id 119 | except: 120 | return False 121 | 122 | if IS_PUBLIC: 123 | return True 124 | elif user_id in ADMINS: 125 | return True 126 | else: 127 | return False 128 | 129 | filters.admins = filters.create(is_admin) 130 | filters.owner = filters.create(is_owner) 131 | filters.inline = filters.create(check_inline) 132 | 133 | #---------- ---------- ---------- ---------- 134 | -------------------------------------------------------------------------------- /InlineBot/__main__.py: -------------------------------------------------------------------------------- 1 | from InlineBot import CodeXBotz 2 | CodeXBotz().run() -------------------------------------------------------------------------------- /InlineBot/database/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | from .. import DB_URI, DB_NAME 3 | 4 | from .filterbase import * 5 | from .userbase import * -------------------------------------------------------------------------------- /InlineBot/database/filterbase.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import pymongo 6 | from . import DB_URI, DB_NAME 7 | 8 | dbclient = pymongo.MongoClient(DB_URI) 9 | database = dbclient[DB_NAME] 10 | 11 | filter_collection = database['filters'] 12 | 13 | async def add_filter(text, reply_text, btn, file, alert, msg_type, id): 14 | 15 | fdata = {'text': str(text)} 16 | 17 | button = str(btn) 18 | button = button.replace('pyrogram.types.InlineKeyboardButton', 'InlineKeyboardButton') 19 | found = filter_collection.find_one(fdata) 20 | if found: 21 | filter_collection.delete_one(fdata) 22 | 23 | data = {'_id': id, 'text':str(text), 'reply':str(reply_text), 'btn':str(button), 'file':str(file), 'alert':str(alert), 'type':str(msg_type)} 24 | filter_collection.insert_one(data) 25 | 26 | async def delete_filter(message, text): 27 | 28 | query = {'text':text} 29 | 30 | found = filter_collection.find_one(query) 31 | 32 | if found: 33 | filter_collection.delete_one(query) 34 | await message.reply_text( 35 | f"{text} deleted.", 36 | quote=True 37 | ) 38 | else: 39 | await message.reply_text("Couldn't find that filter!", quote=True) 40 | 41 | async def get_all_filters(): 42 | texts = [] 43 | query = filter_collection.find().sort('text', 1) 44 | try: 45 | for file in query: 46 | text = file['text'] 47 | texts.append(text) 48 | except: 49 | pass 50 | return texts 51 | 52 | async def count_filters(): 53 | count = filter_collection.find().count() 54 | return count 55 | 56 | async def del_all(message): 57 | 58 | if not await count_filters(): 59 | await message.edit_text("Nothing to Delete.!") 60 | return 61 | 62 | try: 63 | filter_collection.remove() 64 | await message.edit_text("All filters deleted.!") 65 | except: 66 | await message.edit_text(f"Couldn't remove all of your filters") 67 | return 68 | 69 | async def get_filters(text): 70 | if text == "": 71 | documents = filter_collection.find() 72 | doc_list = list(documents) 73 | doc_list.reverse() 74 | return doc_list[:50] 75 | else: 76 | regex = f"^{text}.*" 77 | query = {'text': {'$regex' : regex}} 78 | documents = filter_collection.find(query).sort('text', 1).limit(50) 79 | return documents 80 | 81 | async def get_alerts(id): 82 | document = filter_collection.find_one({'_id': id}) 83 | if not document: 84 | return False 85 | return document['alert'] 86 | 87 | async def get_data(): 88 | documents = filter_collection.find().sort('text', 1) 89 | doc_list = list(documents) 90 | return str(doc_list) 91 | 92 | async def import_data(data): 93 | filter_collection.insert_many(data) 94 | 95 | async def get_status(): 96 | filters = filter_collection.find() 97 | filters_no = 0 98 | text = 0 99 | photo = 0 100 | video = 0 101 | audio = 0 102 | document = 0 103 | animation = 0 104 | sticker = 0 105 | voice = 0 106 | videonote = 0 107 | 108 | for filter in filters: 109 | type = filter['type'] 110 | if type == 'Text': 111 | text += 1 112 | elif type == 'Photo': 113 | photo += 1 114 | elif type == 'Video': 115 | video += 1 116 | elif type == 'Audio': 117 | audio += 1 118 | elif type == 'Document': 119 | document += 1 120 | elif type == 'Animation': 121 | animation += 1 122 | elif type == 'Sticker': 123 | sticker += 1 124 | elif type == 'Voice': 125 | voice += 1 126 | elif type == 'Video Note': 127 | videonote += 1 128 | 129 | filters_no += 1 130 | 131 | user_collection = database['users'] 132 | no_users = user_collection.find().count() 133 | 134 | stats_text = f"""Statistics 135 | 136 | Total users: {no_users} 137 | Total filters: {filters_no} 138 | Text filters: {text} 139 | Photo filters: {photo} 140 | Video filters: {video} 141 | Audio filters: {audio} 142 | Document filters: {document} 143 | Animation filters: {animation} 144 | Sticker filters: {sticker} 145 | Voice filters: {voice} 146 | Video Note filters: {videonote}""" 147 | 148 | return stats_text 149 | -------------------------------------------------------------------------------- /InlineBot/database/userbase.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import pymongo 6 | from . import DB_URI, DB_NAME 7 | 8 | dbclient = pymongo.MongoClient(DB_URI) 9 | database = dbclient[DB_NAME] 10 | 11 | user_collection = database['users'] 12 | 13 | async def present_in_userbase(user_id : int): 14 | found = user_collection.find_one({'_id': user_id}) 15 | if found: 16 | return True 17 | else: 18 | return False 19 | 20 | async def add_to_userbase(user_id: int): 21 | user_collection.insert_one({'_id': user_id}) 22 | return 23 | 24 | async def get_users(): 25 | user_docs = user_collection.find() 26 | user_ids = [] 27 | for doc in user_docs: 28 | user_ids.append(doc['_id']) 29 | 30 | return user_ids 31 | 32 | async def del_from_userbase(user_id: int): 33 | user_collection.delete_one({'_id': user_id}) 34 | return -------------------------------------------------------------------------------- /InlineBot/helper_funcs.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import re 6 | import os 7 | import uuid 8 | from typing import List 9 | from telegraph import upload_file 10 | from . import InlineKeyboardButton 11 | 12 | BTN_URL_REGEX = r"(?:\[(.*)\]\((buttonurl|buttonalert):([^)]*)\))" 13 | 14 | SMART_OPEN = '“' 15 | SMART_CLOSE = '”' 16 | START_CHAR = ('\'', '"', SMART_OPEN) 17 | 18 | def split_quotes(text: str) -> List: 19 | if any(text.startswith(char) for char in START_CHAR): 20 | counter = 1 21 | while counter < len(text): 22 | if text[counter] == "\\": 23 | counter += 1 24 | elif text[counter] == text[0] or (text[0] == SMART_OPEN and text[counter] == SMART_CLOSE): 25 | break 26 | counter += 1 27 | else: 28 | return text.split(None, 1) 29 | 30 | key = remove_escapes(text[1:counter].strip()) 31 | 32 | rest = text[counter + 1:].strip() 33 | if not key: 34 | key = text[0] + text[0] 35 | return list(filter(None, [key, rest])) 36 | else: 37 | return text.split(None, 1) 38 | 39 | def replace_href(text): 40 | regex = r"(.*)\[(.*)\]\((.*)\)(.*)" 41 | matches = re.search(regex, text, re.DOTALL) 42 | if matches: 43 | text = re.sub(regex,r"\1\2\4",text) 44 | text = replace_href(text) 45 | return text 46 | 47 | def remove_md(text): 48 | lists = { 49 | '__' : ['',''], 50 | '*' : ['',''], 51 | '`' : ['',''], 52 | '_' : ['',''], 53 | '~' : ['',''] 54 | } 55 | for item, tag in lists.items(): 56 | i = 2 57 | while i: 58 | text = text.replace(item,tag[i%2],1) 59 | i +=1 60 | if not (item in text): 61 | if i%2: 62 | text = text[::-1].replace(tag[0][::-1],item[::-1],1)[::-1] 63 | text = text.replace(f"{tag[0]}{tag[1]}",f"{item}{item}") 64 | i = 0 65 | text = replace_href(text.replace('\n','\t')).replace('\t','\n') 66 | return text 67 | 68 | def generate_button(text : str, id : str): 69 | btns = [] 70 | if not text: 71 | return None 72 | matches = re.finditer(BTN_URL_REGEX, text, re.MULTILINE) 73 | if not matches: 74 | return None 75 | i = 0 76 | j = 0 77 | datalist = [] 78 | for match in matches: 79 | button_text = match.group(1) 80 | for x in ['b', 'i', 'code', 'u', 's']: 81 | button_text = button_text.replace(f'<{x}>', '').replace(f'', '') 82 | if bool(match.group(2) == 'buttonurl') & bool(' ' not in match.group(3)): 83 | if match.group(3).endswith(':same'): 84 | btnurl = match.group(3)[:-5] 85 | if i == 0: 86 | btns.append([ 87 | InlineKeyboardButton(text=button_text, url=btnurl) 88 | ]) 89 | else: 90 | btns[-1].append( 91 | InlineKeyboardButton(text=button_text, url=btnurl) 92 | ) 93 | else: 94 | btns.append([ 95 | InlineKeyboardButton(text=button_text, url=match.group(3)) 96 | ]) 97 | elif match.group(2) == 'buttonalert': 98 | if match.group(3).endswith(':same'): 99 | if len(match.group(3)[:-5]) >= 200: 100 | continue 101 | cdata = match.group(3)[:-5] 102 | datalist.append(cdata) 103 | if i == 0: 104 | btns.append([ 105 | InlineKeyboardButton(text=button_text, callback_data=f"alertmessage:{j}:{id}") 106 | ]) 107 | else: 108 | btns[-1].append( 109 | InlineKeyboardButton(text=button_text, callback_data=f"alertmessage:{j}:{id}") 110 | ) 111 | else: 112 | if len(match.group(3)) >= 200: 113 | continue 114 | datalist.append(match.group(3)) 115 | btns.append([ 116 | InlineKeyboardButton(text=button_text, callback_data=f"alertmessage:{j}:{id}") 117 | ]) 118 | j += 1 119 | i += 1 120 | new_text = re.sub(BTN_URL_REGEX, '', text, re.MULTILINE) 121 | text = remove_md(new_text) 122 | return text,btns,datalist 123 | 124 | def remove_escapes(text: str) -> str: 125 | counter = 0 126 | res = "" 127 | is_escaped = False 128 | while counter < len(text): 129 | if is_escaped: 130 | res += text[counter] 131 | is_escaped = False 132 | elif text[counter] == "\\": 133 | is_escaped = True 134 | else: 135 | res += text[counter] 136 | counter += 1 137 | return res 138 | 139 | async def upload_photo(message): 140 | msg = await message.reply_text("Please wait..") 141 | _T_LIMIT = 5242880 142 | if not (bool(message.photo) and bool(message.photo.file_size <= _T_LIMIT)): 143 | await msg.edit("Sorry this Photo is not supported..") 144 | return False 145 | dl_loc = await message.download() 146 | try: 147 | response = upload_file(dl_loc) 148 | except Exception as t_e: 149 | await msg.edit_text(t_e) 150 | link = False 151 | else: 152 | link = f'https://telegra.ph{response[0]}' 153 | await msg.delete() 154 | finally: 155 | os.remove(dl_loc) 156 | 157 | return link 158 | 159 | def make_dict(data_list : List[dict], keywords : List[str]): 160 | dict_list = [] 161 | for i in range(len(data_list)): 162 | if data_list[i]['text'] in keywords: 163 | continue 164 | 165 | new_id = str(uuid.uuid4()) 166 | old_id = data_list[i]['_id'] 167 | 168 | new_data = {'_id': new_id} 169 | new_data['text'] = data_list[i]['text'] 170 | new_data['reply'] = data_list[i]['reply'] 171 | new_data['file'] = data_list[i]['file'] 172 | new_data['alert'] = data_list[i]['alert'] 173 | new_data['type'] = data_list[i]['type'] 174 | 175 | button_text = data_list[i]['btn'] 176 | new_data['btn'] = button_text.replace(old_id, str(new_id)) 177 | 178 | dict_list.append(new_data) 179 | 180 | return dict_list 181 | -------------------------------------------------------------------------------- /InlineBot/plugins/adminplugin.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import asyncio 6 | from InlineBot import ( 7 | CodeXBotz, 8 | filters, 9 | Message, 10 | InlineKeyboardMarkup, 11 | InlineKeyboardButton 12 | ) 13 | from InlineBot.database import ( 14 | get_status, 15 | get_users, 16 | del_from_userbase 17 | ) 18 | from pyrogram.errors import ( 19 | FloodWait, 20 | PeerIdInvalid, 21 | UserIsBlocked, 22 | InputUserDeactivated 23 | ) 24 | 25 | @CodeXBotz.on_message(filters.private & filters.command('stats') & filters.admins) 26 | async def getstatus(client: CodeXBotz, message: Message): 27 | sts_msg = await message.reply('Getting Details..') 28 | stats = await get_status() 29 | await sts_msg.edit(stats) 30 | 31 | @CodeXBotz.on_message(filters.private & filters.command('broadcast') & filters.admins & filters.reply) 32 | async def broadcast(client: CodeXBotz, message: Message): 33 | broadcast_msg = message.reply_to_message 34 | broadcast_msg = await broadcast_msg.copy( 35 | chat_id = message.chat.id, 36 | reply_to_message_id = broadcast_msg.message_id 37 | ) 38 | await broadcast_msg.reply( 39 | text = 'Are you sure you want Broadcast this..', 40 | quote = True, 41 | reply_markup = InlineKeyboardMarkup( 42 | [ 43 | [ 44 | InlineKeyboardButton(text = 'Yes', callback_data = 'bdcast_cnfrm'), 45 | InlineKeyboardButton(text = 'No', callback_data = 'close') 46 | ] 47 | ] 48 | ) 49 | ) 50 | return 51 | 52 | @CodeXBotz.on_callback_query(filters.admins & filters.regex('^bdcast_cnfrm$')) 53 | async def broadcast_confrm(client: CodeXBotz, query): 54 | if not query.message.reply_to_message: 55 | await query.answer( 56 | text = 'Message not found', 57 | show_alert = True 58 | ) 59 | await query.message.delete() 60 | return 61 | 62 | message = query.message.reply_to_message 63 | user_ids = await get_users() 64 | 65 | success = 0 66 | deleted = 0 67 | blocked = 0 68 | peerid = 0 69 | 70 | await query.message.edit(text = 'Broadcasting message, Please wait', reply_markup = None) 71 | 72 | for user_id in user_ids: 73 | try: 74 | await message.copy(user_id) 75 | success += 1 76 | except FloodWait as e: 77 | await asyncio.sleep(e.x) 78 | await message.copy(user_id) 79 | success += 1 80 | except UserIsBlocked: 81 | blocked += 1 82 | except PeerIdInvalid: 83 | peerid += 1 84 | except InputUserDeactivated: 85 | deleted += 1 86 | await del_from_userbase(user_id) 87 | 88 | text = f"""Broadcast Completed 89 | 90 | Total users: {str(len(user_ids))} 91 | Blocked users: {str(blocked)} 92 | Deleted accounts: {str(deleted)} (Deleted from Database) 93 | Failed : {str(peerid)}""" 94 | 95 | await query.message.reply(text) 96 | await query.message.delete() 97 | await message.delete() -------------------------------------------------------------------------------- /InlineBot/plugins/base_commands.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | from InlineBot import CodeXBotz, ADMINS, filters, Message, InlineKeyboardButton, InlineKeyboardMarkup, CallbackQuery 6 | 7 | from InlineBot.strings import START_MESSAGE, HELP_MESSAGE, ABOUT_MESSAGE, MARKDOWN_HELP 8 | from InlineBot.database import present_in_userbase, add_to_userbase 9 | 10 | start_keyboard = [ 11 | [ 12 | InlineKeyboardButton(text = '🤔 Help', callback_data = "help"), 13 | InlineKeyboardButton(text = '🤖 About', callback_data = "about") 14 | ], 15 | [ 16 | InlineKeyboardButton(text = 'Close 🔒', callback_data = "close") 17 | ] 18 | ] 19 | 20 | start_keyboard_c = [ 21 | [ 22 | InlineKeyboardButton(text = '🤖 About', callback_data = "about"), 23 | InlineKeyboardButton(text = 'Close 🔒', callback_data = "close") 24 | ], 25 | [ 26 | InlineKeyboardButton(text = 'Search Here', switch_inline_query_current_chat = '') 27 | ] 28 | ] 29 | 30 | help_keyboard = [ 31 | [ 32 | InlineKeyboardButton(text = '✏️ Markdown Helper ✏️', callback_data = 'markdownhelper') 33 | ], 34 | [ 35 | InlineKeyboardButton(text = '🤖 About', callback_data = 'about'), 36 | InlineKeyboardButton(text = 'Close 🔒', callback_data = 'close') 37 | ] 38 | ] 39 | 40 | about_keyboard = [ 41 | [ 42 | InlineKeyboardButton(text = '🤔 Help', callback_data = 'help'), 43 | InlineKeyboardButton(text = 'Close 🔒', callback_data = 'close') 44 | ] 45 | ] 46 | 47 | about_keyboard_c = [ 48 | [ 49 | InlineKeyboardButton(text = 'Close 🔒', callback_data = 'close') 50 | ] 51 | ] 52 | 53 | markdown_keyboard = [ 54 | [ 55 | InlineKeyboardButton(text = '🔙 Back', callback_data = 'help') 56 | ] 57 | ] 58 | 59 | @CodeXBotz.on_message(filters.command('start') & filters.private) 60 | async def start_msg_admins(client: CodeXBotz, message: Message): 61 | if message.from_user.id in ADMINS: 62 | reply_markup = InlineKeyboardMarkup(start_keyboard) 63 | else: 64 | reply_markup = InlineKeyboardMarkup(start_keyboard_c) 65 | text = START_MESSAGE.format( 66 | mention = message.from_user.mention, 67 | first_name = message.from_user.first_name, 68 | last_name = message.from_user.last_name, 69 | user_id = message.from_user.id, 70 | username = '' if message.from_user.username == None else '@'+message.from_user.username 71 | ) 72 | 73 | await message.reply( 74 | text = text, 75 | quote = True, 76 | reply_markup = reply_markup, 77 | disable_web_page_preview = True 78 | ) 79 | if not await present_in_userbase(message.from_user.id): 80 | await add_to_userbase(message.from_user.id) 81 | 82 | @CodeXBotz.on_message(filters.command('help') & filters.private & filters.admins) 83 | async def help_msg(client: CodeXBotz, message: Message): 84 | await message.reply( 85 | text = HELP_MESSAGE, 86 | quote = True, 87 | reply_markup = InlineKeyboardMarkup(help_keyboard) 88 | ) 89 | 90 | @CodeXBotz.on_message(filters.command('about') & filters.private) 91 | async def about_msg(client: CodeXBotz, message: Message): 92 | user_id = message.from_user.id 93 | if user_id in ADMINS: 94 | reply_markup = InlineKeyboardMarkup(about_keyboard) 95 | else: 96 | reply_markup = InlineKeyboardMarkup(about_keyboard_c) 97 | await message.reply( 98 | text = ABOUT_MESSAGE, 99 | quote = True, 100 | reply_markup = reply_markup, 101 | disable_web_page_preview = True 102 | ) 103 | 104 | @CodeXBotz.on_callback_query(filters.regex(r'^close$')) 105 | async def close_cbb(client: CodeXBotz, query: CallbackQuery): 106 | try: 107 | await query.message.reply_to_message.delete() 108 | except: 109 | pass 110 | try: 111 | await query.message.delete() 112 | except: 113 | pass 114 | 115 | @CodeXBotz.on_callback_query(filters.regex(r'^help$') & filters.admins) 116 | async def help_cbq(client: CodeXBotz, query: CallbackQuery): 117 | await query.edit_message_text( 118 | text = HELP_MESSAGE, 119 | reply_markup = InlineKeyboardMarkup(help_keyboard) 120 | ) 121 | 122 | @CodeXBotz.on_callback_query(filters.regex('^about$')) 123 | async def about_cbq(client: CodeXBotz, query: CallbackQuery): 124 | user_id = query.from_user.id 125 | if user_id in ADMINS: 126 | reply_markup = InlineKeyboardMarkup(about_keyboard) 127 | else: 128 | reply_markup = InlineKeyboardMarkup(about_keyboard_c) 129 | await query.edit_message_text( 130 | text = ABOUT_MESSAGE, 131 | reply_markup = reply_markup, 132 | disable_web_page_preview = True 133 | ) 134 | 135 | @CodeXBotz.on_callback_query(filters.regex('^markdownhelper$') & filters.admins) 136 | async def md_helper(client: CodeXBotz, query: CallbackQuery): 137 | await query.edit_message_text( 138 | text = MARKDOWN_HELP, 139 | reply_markup = InlineKeyboardMarkup(markdown_keyboard), 140 | disable_web_page_preview = True, 141 | parse_mode = 'html' 142 | ) 143 | -------------------------------------------------------------------------------- /InlineBot/plugins/import_export.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import io 6 | import os 7 | 8 | from InlineBot import ( 9 | CodeXBotz, 10 | filters, 11 | Message 12 | ) 13 | from InlineBot.database import( 14 | get_data, 15 | count_filters, 16 | import_data, 17 | get_all_filters 18 | ) 19 | from InlineBot.helper_funcs import make_dict 20 | 21 | @CodeXBotz.on_message(filters.private & filters.command('export') & filters.admins) 22 | async def export_data(client: CodeXBotz, message: Message): 23 | sts_msg = await message.reply('Please Wait..!') 24 | 25 | if await count_filters() == 0: 26 | await sts_msg.edit('You have no filters to Export') 27 | return 28 | data = await get_data() 29 | with io.BytesIO(str.encode(data)) as keyword_file: 30 | keyword_file.name = "export_data.txt" 31 | await message.reply_document( 32 | document=keyword_file 33 | ) 34 | await sts_msg.delete() 35 | 36 | @CodeXBotz.on_message(filters.private & filters.command('import') & filters.reply & filters.owner) 37 | async def import_datas(client: CodeXBotz, message: Message): 38 | replied = message.reply_to_message 39 | if not replied.document: 40 | return 41 | elif not replied.document.file_name.endswith('.txt'): 42 | return 43 | sts_msg = await message.reply('Please Wait..!') 44 | dl_loc = await replied.download() 45 | with open(dl_loc, 'r') as f: 46 | data_text = f.read() 47 | try: 48 | os.remove(dl_loc) 49 | except: 50 | pass 51 | 52 | exst_keywords = await get_all_filters() 53 | 54 | try: 55 | data_list = make_dict(eval(data_text), exst_keywords) 56 | except Exception as e: 57 | await sts_msg.edit('Invalid File.!') 58 | return 59 | if len(data_list) == 0: 60 | await sts_msg.edit("Can't import any filters.!") 61 | return 62 | await import_data(data_list) 63 | await sts_msg.edit(f'Imported {len(data_list)} filters') 64 | -------------------------------------------------------------------------------- /InlineBot/plugins/inline_query.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import re 6 | import ast 7 | from InlineBot import ( 8 | CodeXBotz, 9 | thumb, 10 | filters, 11 | InlineQuery, 12 | CallbackQuery, 13 | InlineKeyboardMarkup, 14 | InlineKeyboardButton, 15 | InlineQueryResultPhoto, 16 | InputTextMessageContent, 17 | InlineQueryResultArticle, 18 | InlineQueryResultCachedPhoto, 19 | InlineQueryResultCachedDocument 20 | ) 21 | from InlineBot.database import ( 22 | get_alerts, 23 | get_filters 24 | ) 25 | 26 | @CodeXBotz.on_inline_query(filters.inline) 27 | async def give_filter(client: CodeXBotz, query: InlineQuery): 28 | text = query.query.lower() 29 | documents = await get_filters(text) 30 | results = [] 31 | for document in documents: 32 | reply_text = document['reply'] 33 | button = document['btn'] 34 | alert = document['alert'] 35 | fileid = document['file'] 36 | keyword = document['text'] 37 | msg_type = document['type'] 38 | 39 | if button == "[]": 40 | button = None 41 | 42 | if reply_text: 43 | reply_text = reply_text.replace("\\n", "\n").replace("\\t", "\t") 44 | 45 | if fileid == 'None': 46 | try: 47 | result = InlineQueryResultArticle( 48 | title=keyword.upper(), 49 | input_message_content=InputTextMessageContent(message_text = reply_text, disable_web_page_preview = True, 50 | parse_mode = 'html'), 51 | description='Text', 52 | thumb_url = thumb, 53 | reply_markup= None if button == None else InlineKeyboardMarkup(eval(button)) 54 | ) 55 | except: 56 | continue 57 | elif msg_type == 'Photo': 58 | try: 59 | result = InlineQueryResultPhoto( 60 | photo_url = fileid, 61 | title = keyword.upper(), 62 | description = 'Photo', 63 | parse_mode = 'html', 64 | caption = reply_text or '', 65 | reply_markup= None if button == None else InlineKeyboardMarkup(eval(button)) 66 | ) 67 | except: 68 | continue 69 | elif fileid: 70 | try: 71 | result = InlineQueryResultCachedDocument( 72 | title = keyword.upper(), 73 | file_id = fileid, 74 | caption = reply_text or "", 75 | parse_mode = 'html', 76 | description = msg_type, 77 | reply_markup= None if button == None else InlineKeyboardMarkup(eval(button)) 78 | ) 79 | except: 80 | continue 81 | else: 82 | continue 83 | 84 | results.append(result) 85 | 86 | if len(results) != 0: 87 | switch_pm_text = f"Total {len(results)} Matches" 88 | else: 89 | switch_pm_text = "No matches" 90 | 91 | await query.answer( 92 | results = results, 93 | is_personal = True, 94 | switch_pm_text = switch_pm_text, 95 | switch_pm_parameter = 'start' 96 | ) 97 | 98 | 99 | @CodeXBotz.on_callback_query(filters.regex(r"^(alertmessage):(\d):(.*)")) 100 | async def alert_msg(client: CodeXBotz, callback: CallbackQuery): 101 | regex = r"^(alertmessage):(\d):(.*)" 102 | matches = re.match(regex, callback.data) 103 | i = matches.group(2) 104 | id = matches.group(3) 105 | alerts = await get_alerts(id) 106 | 107 | if alerts: 108 | alerts = ast.literal_eval(alerts) 109 | alert = alerts[int(i)] 110 | alert = alert.replace("\\n", "\n").replace("\\t", "\t") 111 | try: 112 | await callback.answer(alert,show_alert=True) 113 | except: 114 | pass -------------------------------------------------------------------------------- /InlineBot/plugins/set_filters.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | import io 6 | import re 7 | import uuid 8 | 9 | from InlineBot import ( 10 | CodeXBotz, 11 | Message, 12 | filters, 13 | CallbackQuery, 14 | InlineKeyboardMarkup, 15 | InlineKeyboardButton 16 | ) 17 | from InlineBot.helper_funcs import ( 18 | generate_button, 19 | upload_photo, 20 | split_quotes 21 | ) 22 | from InlineBot.database import ( 23 | del_all, 24 | add_filter, 25 | delete_filter, 26 | count_filters, 27 | get_all_filters 28 | ) 29 | from InlineBot import FILTER_COMMAND, DELETE_COMMAND 30 | 31 | @CodeXBotz.on_message(filters.command(FILTER_COMMAND) & filters.admins) 32 | async def new_filter(client: CodeXBotz, message: Message): 33 | 34 | strid = str(uuid.uuid4()) 35 | args = message.text.html.split(None, 1) 36 | 37 | if len(args) < 2: 38 | await message.reply_text("Use Correct format 😐", quote=True) 39 | return 40 | 41 | extracted = split_quotes(args[1]) 42 | text = extracted[0].lower() 43 | msg_type = 'Text' 44 | 45 | if not message.reply_to_message and len(extracted) < 2: 46 | await message.reply_text("Add some content to save your filter!", quote=True) 47 | return 48 | 49 | if (len(extracted) >= 2) and not message.reply_to_message: 50 | reply_text, btn, alert = generate_button(extracted[1], strid) 51 | fileid = None 52 | if not reply_text: 53 | await message.reply_text("You cannot have buttons alone, give some text to go with it!", quote=True) 54 | return 55 | 56 | elif message.reply_to_message and message.reply_to_message.reply_markup: 57 | reply_text = "" 58 | btn = [] 59 | fileid = None 60 | alert = None 61 | msg_type = 'Text' 62 | try: 63 | rm = message.reply_to_message.reply_markup 64 | btn = rm.inline_keyboard 65 | replied = message.reply_to_message 66 | msg = replied.document or replied.video or replied.audio or replied.animation or replied.sticker or replied.voice or replied.video_note or None 67 | if msg: 68 | fileid = msg.file_id 69 | if replied.document: 70 | msg_type = 'Document' 71 | elif replied.video: 72 | msg_type = 'Video' 73 | elif replied.audio: 74 | msg_type = 'Audio' 75 | elif replied.animation: 76 | msg_type = 'Animation' 77 | elif replied.sticker: 78 | msg_type = 'Sticker' 79 | elif replied.voice: 80 | msg_type = 'Voice' 81 | elif replied.video_note: 82 | msg_type = 'Video Note' 83 | 84 | reply_text = message.reply_to_message.caption.html 85 | 86 | elif replied.photo: 87 | fileid = await upload_photo(replied) 88 | msg_type = 'Photo' 89 | if not fileid: 90 | return 91 | reply_text = message.reply_to_message.caption.html 92 | 93 | 94 | elif replied.text: 95 | reply_text = message.reply_to_message.text.html 96 | msg_type = 'Text' 97 | fileid = None 98 | else: 99 | await message.reply('Not Supported..!') 100 | return 101 | alert = None 102 | except: 103 | pass 104 | 105 | 106 | elif message.reply_to_message and message.reply_to_message.photo: 107 | try: 108 | fileid = await upload_photo(message.reply_to_message) 109 | if not fileid: 110 | return 111 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 112 | except: 113 | reply_text = "" 114 | btn = [] 115 | alert = None 116 | msg_type = 'Photo' 117 | 118 | elif message.reply_to_message and message.reply_to_message.video: 119 | try: 120 | fileid = message.reply_to_message.video.file_id 121 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 122 | except: 123 | reply_text = "" 124 | btn = [] 125 | alert = None 126 | msg_type = 'Video' 127 | 128 | elif message.reply_to_message and message.reply_to_message.audio: 129 | try: 130 | fileid = message.reply_to_message.audio.file_id 131 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 132 | except: 133 | reply_text = "" 134 | btn = [] 135 | alert = None 136 | msg_type = 'Audio' 137 | 138 | elif message.reply_to_message and message.reply_to_message.document: 139 | try: 140 | fileid = message.reply_to_message.document.file_id 141 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 142 | except: 143 | reply_text = "" 144 | btn = [] 145 | alert = None 146 | msg_type = 'Document' 147 | 148 | elif message.reply_to_message and message.reply_to_message.animation: 149 | try: 150 | fileid = message.reply_to_message.animation.file_id 151 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 152 | except: 153 | reply_text = "" 154 | btn = [] 155 | alert = None 156 | msg_type = 'Animation' 157 | 158 | elif message.reply_to_message and message.reply_to_message.sticker: 159 | try: 160 | fileid = message.reply_to_message.sticker.file_id 161 | reply_text, btn, alert = generate_button(extracted[1], strid) 162 | except: 163 | reply_text = "" 164 | btn = [] 165 | alert = None 166 | msg_type = 'Sticker' 167 | 168 | elif message.reply_to_message and message.reply_to_message.voice: 169 | try: 170 | fileid = message.reply_to_message.voice.file_id 171 | reply_text, btn, alert = generate_button(message.reply_to_message.caption.html, strid) 172 | except: 173 | reply_text = "" 174 | btn = [] 175 | alert = None 176 | msg_type = 'Voice' 177 | elif message.reply_to_message and message.reply_to_message.video_note: 178 | try: 179 | fileid = message.reply_to_message.video_note.file_id 180 | reply_text, btn, alert = generate_button(extracted[1], strid) 181 | except Exception as a: 182 | reply_text = "" 183 | btn = [] 184 | alert = None 185 | msg_type = 'Video Note' 186 | elif message.reply_to_message and message.reply_to_message.text: 187 | try: 188 | fileid = None 189 | reply_text, btn, alert = generate_button(message.reply_to_message.text.html, strid) 190 | except: 191 | reply_text = "" 192 | btn = [] 193 | alert = None 194 | else: 195 | await message.reply('Not Supported..!') 196 | return 197 | 198 | try: 199 | if fileid: 200 | if msg_type == 'Photo': 201 | await message.reply_photo( 202 | photo = fileid, 203 | caption = reply_text, 204 | reply_markup = InlineKeyboardMarkup(btn) if len(btn) != 0 else None 205 | ) 206 | else: 207 | await message.reply_cached_media( 208 | file_id = fileid, 209 | caption = reply_text, 210 | reply_markup = InlineKeyboardMarkup(btn) if len(btn) != 0 else None 211 | ) 212 | else: 213 | await message.reply( 214 | text = reply_text, 215 | disable_web_page_preview = True, 216 | reply_markup = InlineKeyboardMarkup(btn) if len(btn) != 0 else None 217 | ) 218 | except Exception as a: 219 | try: 220 | await message.reply(text = f"❌ Error\n\n{str(a)}\n\nJoin @CodeXBotzSupport for Support") 221 | except: 222 | pass 223 | return 224 | 225 | await add_filter(text, reply_text, btn, fileid, alert, msg_type, strid) 226 | reply_markup = InlineKeyboardMarkup( 227 | [ 228 | [ 229 | InlineKeyboardButton(text = 'Share filter', switch_inline_query = text), 230 | InlineKeyboardButton(text = 'Try Here', switch_inline_query_current_chat = text) 231 | ] 232 | ] 233 | ) 234 | await message.reply_text(f"{text} Added", quote = True, reply_markup = reply_markup) 235 | 236 | @CodeXBotz.on_message(filters.command(DELETE_COMMAND) & filters.admins) 237 | async def del_filter(client: CodeXBotz, message: Message): 238 | try: 239 | cmd, text = message.text.split(" ", 1) 240 | except: 241 | await message.reply_text( 242 | "Mention the filtername which you wanna delete!\n\n" 243 | f"/{DELETE_COMMAND.lower()} filtername\n\n" 244 | "Use /filters to view all available filters", 245 | quote=True 246 | ) 247 | return 248 | 249 | query = text.lower() 250 | await delete_filter(message, query) 251 | 252 | @CodeXBotz.on_message(filters.command('filters') & filters.admins) 253 | async def get_all(client: CodeXBotz, message: Message): 254 | texts = await get_all_filters() 255 | count = await count_filters() 256 | if count: 257 | filterlist = f"Bot have total {count} filters\n\n" 258 | 259 | for text in texts: 260 | keywords = f" ○ {text}\n" 261 | filterlist += keywords 262 | 263 | if len(filterlist) > 4096: 264 | with io.BytesIO(str.encode(filterlist.replace("", "").replace("","").replace('', '').replace('', ''))) as keyword_file: 265 | sts = await message.reply('Please wait..') 266 | keyword_file.name = "filters.txt" 267 | await message.reply_document( 268 | document=keyword_file 269 | ) 270 | await sts.delete() 271 | return 272 | else: 273 | filterlist = f"Bot have no filters.!" 274 | 275 | await message.reply_text( 276 | text=filterlist, 277 | quote=True 278 | ) 279 | 280 | @CodeXBotz.on_message(filters.command('delall') & filters.owner) 281 | async def delallconfirm(client, message): 282 | reply_markup = InlineKeyboardMarkup( 283 | [ 284 | [ 285 | InlineKeyboardButton('Yes', callback_data = 'delall'), 286 | InlineKeyboardButton('No', callback_data = 'delallclose') 287 | ] 288 | ] 289 | ) 290 | await message.reply_text( 291 | f"This will delete all of your filters.\nAre you sure you want do this.?", 292 | reply_markup = reply_markup, 293 | quote=True 294 | ) 295 | 296 | @CodeXBotz.on_callback_query(filters.regex("^delall$") & filters.owner) 297 | async def delall(client: CodeXBotz, query: CallbackQuery): 298 | await del_all(query.message) 299 | 300 | @CodeXBotz.on_callback_query(filters.regex("^delallclose$") & filters.owner) 301 | async def delcancel(client: CodeXBotz, query: CallbackQuery): 302 | await query.edit_message_text( 303 | text = 'Process Cancelled', 304 | reply_markup = None 305 | ) 306 | return 307 | -------------------------------------------------------------------------------- /InlineBot/strings.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) @CodeXBotz - All Rights Reserved 2 | # Licensed under GNU General Public License as published by the Free Software Foundation 3 | # Written by Shahsad Kolathur , June 2021 4 | 5 | from pyrogram import __version__ 6 | from InlineBot import ( 7 | OWNER_ID, 8 | FILTER_COMMAND, 9 | DELETE_COMMAND, 10 | CUSTOM_START_MESSAGE 11 | ) 12 | 13 | if CUSTOM_START_MESSAGE: 14 | START_MESSAGE = CUSTOM_START_MESSAGE 15 | else: 16 | START_MESSAGE = """Hello {mention}, 17 | 18 | I am an Inline Saver Bot, you can save inline filters and It can be use in any of your chats easily, Click help for more details 19 | """ 20 | 21 | HELP_MESSAGE = f"""Main Available Commands 22 | 23 | ○ /{FILTER_COMMAND.lower()} [keyword] [message or reply to message] 24 | Add an Inline filter, you can use MarkDown for formatting 25 | 26 | ○ /{DELETE_COMMAND.lower()} [keyword] 27 | Delete existing Filter 28 | 29 | ○ /filters 30 | To see the filters 31 | 32 | ○ /export 33 | Export a Backup file of filters, this can be import by others 34 | 35 | ○ /stats 36 | See the Bot's Statistics 37 | 38 | ○ /broadcast [reply to any message] 39 | Broadcast any Messages to Bot users 40 | 41 | Owner only Commands 42 | 43 | ○ /delall 44 | Delete all of the filters 45 | 46 | ○ /import [reply to an exported file] 47 | Import filters from Backup file 48 | """ 49 | 50 | ABOUT_MESSAGE = f"""ABOUT ME 51 | 52 | ○ Maintained by : This Person 53 | ○ Channel : Code 𝕏 Botz 54 | ○ Support : Code 𝕏 Botz Support 55 | ○ Source Code : Click here 56 | ○ Language : Python 3 57 | ○ Library : Pyrogram Asyncio {__version__} 58 | """ 59 | 60 | MARKDOWN_HELP = """Markdown Formatting 61 | 62 | ○ Bold Words : 63 | format: *Bold Text* 64 | show as: Bold Text 65 | 66 | ○ Italic Text 67 | format: _Italic Text_ 68 | show as: Italic Text 69 | 70 | ○ Code Words 71 | format: `Code Text` 72 | show as: Code Text 73 | 74 | ○ Under Line 75 | format: __UnderLine Text__ 76 | show as: UnderLine Text 77 | 78 | ○ StrikeThrough 79 | format: ~StrikeThrough Text~ 80 | show as: StrikeThrough Text 81 | 82 | ○ Hyper Link 83 | format: [Text](https://t.me/CodeXBotz) 84 | show as: Text 85 | 86 | ○ Buttons 87 | Url Button: 88 | [Button Text](buttonurl:https://t.me/CoddeXBotz) 89 | Alert Button: 90 | [Button Text](buttonalert:Alert Text) 91 | In Sameline: 92 | [Button Text](buttonurl:https://t.me/CodeXBotz:same) 93 | 94 | ○ Notes: 95 | Keep every Buttons in Seperate line when formating 96 | Your alert message text must be less than 200 characters, otherwise bot will ignore that button 97 | 98 | ○ Tip: You can add buttons for sticker and video note in /add command""" 99 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | worker: python -m InlineBot -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Inline-Filter-Bot 2 | 3 |

4 | 5 | 6 | 7 | 8 | 9 |
10 | 11 |    12 | 13 | 14 |    15 | 16 |
17 | 18 | 19 | 20 | 21 | 22 | 23 |

24 | 25 | A Telegram Bot for filter in Inline 26 | 27 | ### Features 28 | 29 | - Unlimited Filters 30 | - Supports all type of filters 31 | - Supports Alert Button 32 | - Using Common Markups for formatting 33 | - Import and Export feature (allows to copy filters from one inline filter bot to another) 34 | - Custom Start Message, filter adding-deleting command 35 | 36 | ## DEMO BOT 37 | 38 | 39 | ### Installation 40 | #### Deploy on Heroku 41 | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
42 | 43 | #### Deploy in your VPS 44 | ````bash 45 | git clone https://github.com/CodeXBotz/Inline-Filter-Bot 46 | cd Inline-Filter-Bot 47 | pip3 install -r requirements.txt 48 | python3 InlineBot 49 | ```` 50 | ## 51 | ### Special Commands 52 | 53 | #### Admin Commands 54 | * `/add` - add filter to bot (customisable command) 55 | * `/del` - delete filter from bot (customisable command) 56 | * `/filters` - view current filters 57 | * `/export` - export filters data as file 58 | * `/stats` - view bot statistics 59 | * `/broadcast` - broadcast any messages to bot users 60 | 61 | #### Owner Commands 62 | * `/delall` - delete all filters from bot 63 | * `/import` - import an exported file to bot 64 | * All other admin commands 65 | 66 | ### Variables 67 | 68 | * `API_HASH` Your API Hash from my.telegram.org 69 | * `API_ID` Your API ID from my.telegram.org 70 | * `TG_BOT_TOKEN` Your bot token from @BotFather 71 | * `OWNER_ID` Must enter Your Telegram Id 72 | * `ADMINS` Other Admins Telegram Id, seperate by space 73 | * `DATABASE_URL` Database URL from mongodb.com 74 | * `THUMBNAIL_URL` Optional: URL of an Image, thumbnail for Text filter 75 | * `IS_PUBLIC` Optional: Set this False if you creating this bot admins only, Default is True 76 | * `START_MESSAGE` Optional: Your Bot Start Message, you can use HTML, and fillings for formatting 77 | * `FILTER_COMMAND` Optional: Custom command for add filter 78 | * `DELETE_COMMAND` Optional: Custom command for add filter 79 | 80 | #### Fillings for START_MESSAGE 81 | * `{mention}` Mention user 82 | * `{first_name}` User First name 83 | * `{last_name}` User Last name 84 | * `{user_id}` Telegram ID of the User 85 | * `{username}` Username of the User 86 | 87 | ## Support 88 | Join Our [Telegram Group](https://www.telegram.dog/codexbotzsupport) For Support/Assistance And Our [Channel](https://www.telegram.dog/codexbotz) For Updates. 89 | 90 | Report Bugs, Give Feature Requests There.. 91 | 92 | ### Credits 93 | 94 | - Thanks to [Dan](https://github.com/delivrance) for His Awsome [Libary](https://github.com/pyrogram/pyrogram) 95 | - Thanks to [Mahesh](https://github.com/Mahesh0253) for this [Repo](https://github.com/Mahesh0253/Media-Search-bot) 96 | - Thanks to [๓คгςยร](https://github.com/prgofficial) and [ᎫᎪᏟᏦ](https://github.com/Jack-of-tg) for [Unlimited Filter Repo](https://github.com/TroJanzHEX/Unlimited-Filter-Bot) 97 | 98 | ### Licence 99 | [![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html) 100 | 101 | [INLINE-FILTER-BOT](https://github.com/CodeXBotz/Inline-Filter-Bot/) is Free Software: You can use, study share and improve it at your 102 | will. Specifically you can redistribute and/or modify it under the terms of the 103 | [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as 104 | published by the Free Software Foundation, either version 3 of the License, or 105 | (at your option) any later version. 106 | 107 | ## 108 | 109 | **Star this Repo if you Liked it ⭐⭐⭐** 110 | -------------------------------------------------------------------------------- /app.json: -------------------------------------------------------------------------------- 1 | 2 | { 3 | "name": "Telegram Inline Filter Bot", 4 | "description": "An Inline Filter Bot using Mongodb", 5 | "keywords": [ 6 | "telegram", 7 | "filter", 8 | "bot", 9 | "inline" 10 | ], 11 | "repository": "https://github.com/CodeXBotz/Inline-Filter-Bot", 12 | "logo": "https://telegra.ph/file/14d3013fda21281c54b61.jpg", 13 | "env": { 14 | "TG_BOT_TOKEN": { 15 | "description": "Your Bot token, Get it from @Botfather", 16 | "value": "" 17 | }, 18 | "OWNER_ID": { 19 | "description": "An integer of consisting of your owner ID", 20 | "value": "1250450587" 21 | }, 22 | "APP_ID":{ 23 | "description": "your app id, take it from my.telegram.org", 24 | "value": "" 25 | }, 26 | "API_HASH":{ 27 | "description": "your api hash, take it from my.telegram.org", 28 | "value": "" 29 | }, 30 | "DATABASE_URL":{ 31 | "description": "Database URL from https://cloud.mongodb.com/", 32 | "value": "" 33 | }, 34 | "IS_PUBLIC":{ 35 | "description": "Optional: set this False, if the bot is only for admins", 36 | "value": "True", 37 | "required": false 38 | }, 39 | "START_MESSAGE": { 40 | "description": "Optional: custon start message of bot, use HTML parsemode format", 41 | "value": "", 42 | "required": false 43 | }, 44 | "ADMINS": { 45 | "description": "A space separated list of user_ids of Admins, they can only create links", 46 | "value": "", 47 | "required": false 48 | }, 49 | "THUMBNAIL_URL": { 50 | "description": "Optional: URL of the Image, it used as thumbnail for text ", 51 | "value": "", 52 | "required": false 53 | }, 54 | "FILTER_COMMAND": { 55 | "description": "Optional: Command for add filter", 56 | "value": "add", 57 | "required": false 58 | }, 59 | "DELETE_COMMAND": { 60 | "description": "Optional: Command for delete filter", 61 | "value": "del", 62 | "required": false 63 | } 64 | }, 65 | "buildpacks": [ 66 | { 67 | "url": "heroku/python" 68 | } 69 | ], 70 | "formation": { 71 | "worker": { 72 | "quantity": 1, 73 | "size": "free" 74 | } 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | https://github.com/Mahesh0253/pyrogram/archive/inline.zip 2 | pymongo 3 | TgCrypto 4 | telegraph 5 | dnspython -------------------------------------------------------------------------------- /runtime.txt: -------------------------------------------------------------------------------- 1 | python-3.10.4 2 | --------------------------------------------------------------------------------