├── .idx ├── .gitignore └── dev.nix ├── .env.sample ├── requirements.txt ├── config.ini ├── mfinder ├── __main__.py ├── db │ ├── db_support.py │ ├── ban_sql.py │ ├── broadcast_sql.py │ ├── filters_sql.py │ ├── files_sql.py │ └── settings_sql.py ├── plugins │ ├── live_index.py │ ├── broadcast.py │ ├── user_settings.py │ ├── commands.py │ ├── index.py │ ├── admin_settings.py │ └── serve.py ├── __init__.py └── utils │ ├── util_support.py │ ├── constants.py │ └── helpers.py ├── sample_const.py ├── README.md ├── .gitignore └── LICENSE /.idx/.gitignore: -------------------------------------------------------------------------------- 1 | 2 | gc/ 3 | -------------------------------------------------------------------------------- /.env.sample: -------------------------------------------------------------------------------- 1 | APP_ID = "" 2 | API_HASH = "" 3 | BOT_TOKEN = "" 4 | DB_URL = "postgresql://username:password@localhost:5432/dbname" #change username, password and dbname 5 | OWNER_ID = "20516707" 6 | ADMINS = 20516707 12345 7 | DB_CHANNELS = "-1001995218840 -10019421412" 8 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | APScheduler==3.10.4 2 | greenlet==3.0.3 3 | psutil==5.9.8 4 | psycopg2-binary==2.9.9 5 | pyaes==1.6.1 6 | pymediainfo==6.1.0 7 | pyrotgfork==2.1.30 8 | PySocks==1.7.1 9 | python-dotenv==1.0.1 10 | pytz==2024.1 11 | six==1.16.0 12 | SQLAlchemy==2.0.30 13 | TgCrypto==1.2.5 14 | typing_extensions==4.11.0 15 | tzlocal==5.2 16 | uvloop==0.19.0 17 | -------------------------------------------------------------------------------- /config.ini: -------------------------------------------------------------------------------- 1 | [loggers] 2 | keys=root,Logger 3 | 4 | [handlers] 5 | keys=consoleHandler, file_handler 6 | 7 | [formatters] 8 | keys=Formatter 9 | 10 | [logger_root] 11 | level=INFO 12 | handlers=consoleHandler, file_handler 13 | 14 | [logger_Logger] 15 | level=INFO 16 | handlers=consoleHandler, file_handler 17 | qualname=Logger 18 | propagate=0 19 | 20 | [handler_consoleHandler] 21 | class=StreamHandler 22 | level=INFO 23 | formatter=Formatter 24 | args=(sys.stdout,) 25 | 26 | [handler_file_handler] 27 | class=FileHandler 28 | level=INFO 29 | formatter=Formatter 30 | args=('logs.txt','w',) 31 | 32 | [formatter_Formatter] 33 | format= [%(asctime)s][%(name)s][%(module)s][%(lineno)d][%(levelname)s] -> %(message)s 34 | datefmt= %d/%m/%Y %H:%M:%S -------------------------------------------------------------------------------- /mfinder/__main__.py: -------------------------------------------------------------------------------- 1 | import uvloop 2 | from pyrogram import Client, idle, __version__ 3 | from pyrogram.raw.all import layer 4 | from mfinder import APP_ID, API_HASH, BOT_TOKEN 5 | 6 | uvloop.install() 7 | 8 | 9 | async def main(): 10 | plugins = dict(root="mfinder/plugins") 11 | app = Client( 12 | name="mfinder", 13 | api_id=APP_ID, 14 | api_hash=API_HASH, 15 | bot_token=BOT_TOKEN, 16 | plugins=plugins, 17 | ) 18 | async with app: 19 | me = await app.get_me() 20 | print( 21 | f"{me.first_name} - @{me.username} - Pyrogram v{__version__} (Layer {layer}) - Started..." 22 | ) 23 | await idle() 24 | print(f"{me.first_name} - @{me.username} - Stopped !!!") 25 | 26 | uvloop.run(main()) 27 | -------------------------------------------------------------------------------- /mfinder/db/db_support.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from pyrogram.errors import FloodWait 3 | from pyrogram import enums 4 | from mfinder import LOGGER 5 | from mfinder.db.broadcast_sql import query_msg, del_user 6 | 7 | 8 | 9 | async def users_info(bot): 10 | users = 0 11 | blocked = 0 12 | identity = await query_msg() 13 | for user in identity: 14 | user_id = int(user[0]) 15 | name = bool() 16 | try: 17 | name = await bot.send_chat_action(user_id, enums.ChatAction.TYPING) 18 | except FloodWait as e: 19 | await asyncio.sleep(e.value) 20 | except Exception: 21 | pass 22 | if bool(name): 23 | users += 1 24 | else: 25 | await del_user(user_id) 26 | LOGGER.info("Deleted user id %s from broadcast list", user_id) 27 | blocked += 1 28 | return users, blocked -------------------------------------------------------------------------------- /mfinder/plugins/live_index.py: -------------------------------------------------------------------------------- 1 | from pyrogram import Client, filters 2 | from mfinder import DB_CHANNELS, LOGGER 3 | from mfinder.db.files_sql import save_file 4 | from mfinder.utils.helpers import edit_caption 5 | 6 | media_filter = filters.document | filters.video | filters.audio 7 | 8 | 9 | @Client.on_message(filters.chat(DB_CHANNELS) & media_filter) 10 | async def live_index(bot, message): 11 | try: 12 | for file_type in ("document", "video", "audio"): 13 | media = getattr(message, file_type, None) 14 | 15 | if not media: 16 | break 17 | file_name = media.file_name 18 | file_name = edit_caption(file_name) 19 | media.file_type = file_type 20 | # media.caption = message.caption if message.caption else file_name 21 | media.caption = file_name 22 | await save_file(media) 23 | 24 | except Exception as e: 25 | LOGGER.warning("Error occurred while saving file: %s", str(e)) 26 | -------------------------------------------------------------------------------- /.idx/dev.nix: -------------------------------------------------------------------------------- 1 | 2 | # To learn more about how to use Nix to configure your environment 3 | # see: https://developers.google.com/idx/guides/customize-idx-env 4 | { pkgs, ... }: { 5 | # Which nixpkgs channel to use. 6 | channel = "stable-23.11"; # or "unstable" 7 | # Use https://search.nixos.org/packages to find packages 8 | packages = [ pkgs.python3 ]; 9 | idx = { 10 | # Search for the extensions you want on https://open-vsx.org/ and use "publisher.id" 11 | extensions = [ "ms-python.python" ]; 12 | workspace = { 13 | # Runs when a workspace is first created with this `dev.nix` file 14 | onCreate = { 15 | install = 16 | "python -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt"; 17 | }; 18 | # To run something each time the environment is rebuilt, use the `onStart` hook 19 | }; 20 | # Enable previews and customize configuration 21 | previews = { 22 | enable = false; 23 | previews = [{ 24 | command = [ "./devserver.sh" ]; 25 | env = { PORT = "$PORT"; }; 26 | id = "web"; 27 | manager = "web"; 28 | }]; 29 | }; 30 | }; 31 | } 32 | -------------------------------------------------------------------------------- /mfinder/__init__.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | import logging 4 | import logging.config 5 | from dotenv import load_dotenv 6 | 7 | 8 | load_dotenv() 9 | 10 | 11 | id_pattern = re.compile(r"^.\d+$") 12 | 13 | # vars 14 | APP_ID = os.environ.get("APP_ID", "") 15 | API_HASH = os.environ.get("API_HASH", "") 16 | BOT_TOKEN = os.environ.get("BOT_TOKEN", "") 17 | DB_URL = os.environ.get("DB_URL", "") 18 | OWNER_ID = int(os.environ.get("OWNER_ID", "")) 19 | ADMINS = [ 20 | int(user) if id_pattern.search(user) else user 21 | for user in os.environ.get("ADMINS", "").split() 22 | ] + [OWNER_ID] 23 | DB_CHANNELS = [ 24 | int(ch) if id_pattern.search(ch) else ch 25 | for ch in os.environ.get("DB_CHANNELS", "").split() 26 | ] 27 | 28 | try: 29 | import const 30 | except Exception: 31 | import sample_const as const 32 | 33 | START_MSG = const.START_MSG 34 | START_KB = const.START_KB 35 | HELP_MSG = const.HELP_MSG 36 | HELP_KB = const.HELP_KB 37 | 38 | 39 | # logging Conf 40 | logging.config.fileConfig(fname="config.ini", disable_existing_loggers=False) 41 | LOGGER = logging.getLogger(__name__) 42 | logging.getLogger("pyrogram").setLevel(logging.WARNING) 43 | -------------------------------------------------------------------------------- /mfinder/utils/util_support.py: -------------------------------------------------------------------------------- 1 | import psycopg2 2 | from mfinder import ADMINS, DB_URL 3 | 4 | 5 | def is_admin(user_id): 6 | return user_id in ADMINS 7 | 8 | 9 | def humanbytes(B): 10 | 'Return the given bytes as a human-friendly KB, MB, GB, or TB string' 11 | B = float(B) 12 | KB = float(1024) 13 | MB = float(KB ** 2) # 1,048,576 14 | GB = float(KB ** 3) # 1,073,741,824 15 | TB = float(KB ** 4) # 1,099,511,627,776 16 | 17 | if B < KB: 18 | return f'{B} {"Bytes" if 0 == B > 1 else "Byte"}' 19 | elif KB <= B < MB: 20 | return f'{B/KB:.2f} KB' 21 | elif MB <= B < GB: 22 | return f'{B/MB:.2f} MB' 23 | elif GB <= B < TB: 24 | return f'{B/GB:.2f} GB' 25 | elif TB <= B: 26 | return f'{B/TB:.2f} TB' 27 | 28 | 29 | def get_db_size(): 30 | conn = psycopg2.connect(DB_URL) 31 | cursor = conn.cursor() 32 | query = "SELECT pg_database_size(current_database()) / (1024.0 * 1024.0)::numeric;" 33 | cursor.execute(query) 34 | database_size_mb = cursor.fetchone()[0] 35 | database_size_mb = float( 36 | database_size_mb) if database_size_mb is not None else 0.0 37 | db_size = round(database_size_mb, 2) 38 | cursor.close() 39 | conn.close() 40 | return db_size -------------------------------------------------------------------------------- /mfinder/db/ban_sql.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from sqlalchemy import create_engine 3 | from sqlalchemy import Column, BigInteger 4 | from sqlalchemy.ext.declarative import declarative_base 5 | from sqlalchemy.orm import sessionmaker, scoped_session 6 | from sqlalchemy.orm.exc import NoResultFound 7 | from sqlalchemy.pool import StaticPool 8 | from mfinder import DB_URL 9 | 10 | 11 | BASE = declarative_base() 12 | 13 | 14 | class BanList(BASE): 15 | __tablename__ = "banlist" 16 | user_id = Column(BigInteger, primary_key=True) 17 | 18 | 19 | def __init__(self, user_id): 20 | self.user_id = user_id 21 | 22 | 23 | 24 | def start() -> scoped_session: 25 | engine = create_engine(DB_URL, client_encoding="utf8", poolclass=StaticPool) 26 | BASE.metadata.bind = engine 27 | BASE.metadata.create_all(engine) 28 | return scoped_session(sessionmaker(bind=engine, autoflush=False)) 29 | 30 | 31 | SESSION = start() 32 | INSERTION_LOCK = threading.RLock() 33 | 34 | 35 | async def ban_user(user_id): 36 | with INSERTION_LOCK: 37 | try: 38 | usr = SESSION.query(BanList).filter_by(user_id=user_id).one() 39 | except NoResultFound: 40 | usr = BanList(user_id=user_id) 41 | SESSION.add(usr) 42 | SESSION.commit() 43 | return True 44 | 45 | 46 | async def is_banned(user_id): 47 | with INSERTION_LOCK: 48 | try: 49 | usr = SESSION.query(BanList).filter_by(user_id=user_id).one() 50 | return usr.user_id 51 | except NoResultFound: 52 | return False 53 | 54 | 55 | async def unban_user(user_id): 56 | with INSERTION_LOCK: 57 | try: 58 | usr = SESSION.query(BanList).filter_by(user_id=user_id).one() 59 | SESSION.delete(usr) 60 | SESSION.commit() 61 | return True 62 | except NoResultFound: 63 | return False 64 | -------------------------------------------------------------------------------- /mfinder/db/broadcast_sql.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from sqlalchemy import create_engine 3 | from sqlalchemy import Column, TEXT, BigInteger 4 | from sqlalchemy.ext.declarative import declarative_base 5 | from sqlalchemy.orm import sessionmaker, scoped_session 6 | from sqlalchemy.orm.exc import NoResultFound 7 | from sqlalchemy.pool import StaticPool 8 | from mfinder import DB_URL 9 | 10 | 11 | BASE = declarative_base() 12 | 13 | 14 | class Broadcast(BASE): 15 | __tablename__ = "broadcast" 16 | user_id = Column(BigInteger, primary_key=True) 17 | user_name = Column(TEXT) 18 | 19 | def __init__(self, user_id, user_name): 20 | self.user_id = user_id 21 | self.user_name = user_name 22 | 23 | 24 | def start() -> scoped_session: 25 | engine = create_engine(DB_URL, client_encoding="utf8", poolclass=StaticPool) 26 | BASE.metadata.bind = engine 27 | BASE.metadata.create_all(engine) 28 | return scoped_session(sessionmaker(bind=engine, autoflush=False)) 29 | 30 | 31 | SESSION = start() 32 | INSERTION_LOCK = threading.RLock() 33 | 34 | 35 | async def add_user(user_id, user_name): 36 | with INSERTION_LOCK: 37 | try: 38 | usr = SESSION.query(Broadcast).filter_by(user_id=user_id).one() 39 | except NoResultFound: 40 | usr = Broadcast(user_id=user_id, user_name=user_name) 41 | SESSION.add(usr) 42 | SESSION.commit() 43 | 44 | 45 | async def is_user(user_id): 46 | with INSERTION_LOCK: 47 | try: 48 | usr = SESSION.query(Broadcast).filter_by(user_id=user_id).one() 49 | return usr.user_id 50 | except NoResultFound: 51 | return False 52 | 53 | 54 | async def query_msg(): 55 | try: 56 | query = SESSION.query(Broadcast.user_id).order_by(Broadcast.user_id) 57 | return query.all() 58 | finally: 59 | SESSION.close() 60 | 61 | 62 | async def del_user(user_id): 63 | with INSERTION_LOCK: 64 | try: 65 | usr = SESSION.query(Broadcast).filter_by(user_id=user_id).one() 66 | SESSION.delete(usr) 67 | SESSION.commit() 68 | except NoResultFound: 69 | pass 70 | -------------------------------------------------------------------------------- /mfinder/db/filters_sql.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from sqlalchemy import create_engine 3 | from sqlalchemy import Column, TEXT 4 | from sqlalchemy.ext.declarative import declarative_base 5 | from sqlalchemy.orm import sessionmaker, scoped_session 6 | from sqlalchemy.orm.exc import NoResultFound 7 | from sqlalchemy.pool import StaticPool 8 | from mfinder import DB_URL 9 | 10 | 11 | BASE = declarative_base() 12 | 13 | 14 | class Filters(BASE): 15 | __tablename__ = "filters" 16 | filters = Column(TEXT, primary_key=True) 17 | message = Column(TEXT) 18 | 19 | def __init__(self, filters, message): 20 | self.filters = filters 21 | self.message = message 22 | 23 | 24 | def start() -> scoped_session: 25 | engine = create_engine(DB_URL, client_encoding="utf8", poolclass=StaticPool) 26 | BASE.metadata.bind = engine 27 | BASE.metadata.create_all(engine) 28 | return scoped_session(sessionmaker(bind=engine, autoflush=False)) 29 | 30 | 31 | SESSION = start() 32 | INSERTION_LOCK = threading.RLock() 33 | 34 | 35 | async def add_filter(filters, message): 36 | with INSERTION_LOCK: 37 | try: 38 | fltr = SESSION.query(Filters).filter(Filters.filters.ilike(filters)).one() 39 | except NoResultFound: 40 | fltr = Filters(filters=filters, message=message) 41 | SESSION.add(fltr) 42 | SESSION.commit() 43 | return True 44 | 45 | 46 | async def is_filter(filters): 47 | with INSERTION_LOCK: 48 | try: 49 | fltr = SESSION.query(Filters).filter(Filters.filters.ilike(filters)).one() 50 | return fltr 51 | except NoResultFound: 52 | return False 53 | 54 | 55 | async def rem_filter(filters): 56 | with INSERTION_LOCK: 57 | try: 58 | fltr = SESSION.query(Filters).filter(Filters.filters.ilike(filters)).one() 59 | SESSION.delete(fltr) 60 | SESSION.commit() 61 | return True 62 | except NoResultFound: 63 | return False 64 | 65 | 66 | async def list_filters(): 67 | try: 68 | fltrs = SESSION.query(Filters.filters).all() 69 | return [fltr[0] for fltr in fltrs] 70 | except NoResultFound: 71 | return False 72 | finally: 73 | SESSION.close() 74 | -------------------------------------------------------------------------------- /sample_const.py: -------------------------------------------------------------------------------- 1 | # Do not edit this file, copy this file & rename it to const.py. Any format error will result in not getting start or help message. 2 | 3 | from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton 4 | 5 | 6 | #use the same format for name & user_id placeholders 7 | START_MSG = """ 8 | Hi **[{}](tg://user?id={})**, I am a media finder bot which finds media from my database channel. Just send query to find the media. 9 | Send /help for more. 10 | """ 11 | 12 | HELP_MSG = """ 13 | **You can find the bot commands here.** 14 | **User Commands:-** 15 | /help - __Show this help message__ 16 | /settings - __Toggle settings of Precise Mode and Button Mode__ 17 | `Precise Mode:` 18 | - __If Enabled, bot will match the word & return results with only the exact match__ 19 | - __If Disabled, bot will match the word & return all the results containing the word__ 20 | `Result Mode:` 21 | - __If Button, bot will return results in button format__ 22 | - __If List, bot will return results in list format__ 23 | - __If HyperLink, bot will return results in hyperlink format__ 24 | 25 | **Admin Commands:-** 26 | /logs - __Get logs as a file__ 27 | /server - __Get server stats__ 28 | /restart - __Restart the bot__ 29 | /stats - __Get bot user stats__ 30 | /broadcast - __Reply to a message to send that to all bot users__ 31 | /index - __Start indexing a database channel (bot must be admin of the channel if that is provate channel)__ 32 | __You can just forward the message from database channel for starting indexing, no need to use the /index command__ 33 | /delete - __Reply to a file to delete it from database__ 34 | /autodelete - __Set file auto delete time in seconds__ 35 | /repairmode - __Enable or disable repair mode - If on, bot will not send any files__ 36 | /customcaption - __Set custom caption for files__ 37 | /adminsettings - __Get current admin settings__ 38 | /ban - __Ban a user from bot__ - `/ban user_id` 39 | /unban - __Unban a user from bot__ - `/unban user_id` 40 | /addfilter - __Add a text filter__ - `/addfilter filter message` __or__ `/addfilter "filter multiple words" message` __(If a filter is there, bot will send the filter rather than file)__ 41 | /delfilter - __Delete a text filter__ - `/delfilter filter` 42 | /listfilters - __List all filters currently added in the bot__ 43 | /forcesub - __Set force subscribe channel__ - `/forcesub channel_id` __Bot must be admin of that channel (Bot will create a new invite link for that channel)__ 44 | /checklink - __Check invite link for force subscribe channel__ 45 | /total - __Get count of total files in DB__ 46 | """ 47 | 48 | 49 | START_KB = InlineKeyboardMarkup( 50 | [ 51 | [ 52 | InlineKeyboardButton("🆘 Help", callback_data="help_cb"), 53 | InlineKeyboardButton( 54 | "👨‍💻 Source Code", url="https://github.com/EL-Coders/mediafinder" 55 | ), 56 | ] 57 | ] 58 | ) 59 | 60 | HELP_KB = InlineKeyboardMarkup( 61 | [ 62 | [ 63 | InlineKeyboardButton("🔙 Back", callback_data="back_m"), 64 | ], 65 | ] 66 | ) 67 | -------------------------------------------------------------------------------- /mfinder/plugins/broadcast.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import time 3 | import datetime 4 | from pyrogram.types import Message 5 | from pyrogram import Client, filters 6 | from pyrogram.errors import FloodWait 7 | from mfinder import LOGGER 8 | from mfinder.db.db_support import users_info 9 | from mfinder.db.broadcast_sql import query_msg 10 | from mfinder import ADMINS, OWNER_ID 11 | 12 | 13 | @Client.on_message( 14 | filters.private & filters.command("stats") & filters.user(ADMINS) 15 | ) 16 | async def get_subscribers_count(bot: Client, message: Message): 17 | wait_msg = "__Calculating, please wait...__" 18 | msg = await message.reply_text(wait_msg) 19 | active, blocked = await users_info(bot) 20 | stats_msg = f"**Stats**\nSubscribers: `{active}`\nBlocked / Deleted: `{blocked}`" 21 | await msg.edit(stats_msg) 22 | 23 | 24 | @Client.on_message( 25 | filters.private & filters.command("broadcast") & filters.user(OWNER_ID) 26 | ) 27 | async def send_text(bot, message: Message): 28 | user_id = message.from_user.id 29 | if "broadcast" in message.text and message.reply_to_message is not None: 30 | start_time = time.time() 31 | await message.reply_text("Starting broadcast, content below...") 32 | await bot.copy_message( 33 | chat_id=user_id, 34 | from_chat_id=message.chat.id, 35 | message_id=message.reply_to_message_id, 36 | # caption=message.reply_to_message.caption, 37 | reply_markup=message.reply_to_message.reply_markup, 38 | ) 39 | query = await query_msg() 40 | success = 0 41 | failed = 0 42 | for row in query: 43 | chat_id = int(row[0]) 44 | br_msg = bool() 45 | try: 46 | br_msg = await bot.copy_message( 47 | chat_id=chat_id, 48 | from_chat_id=message.chat.id, 49 | message_id=message.reply_to_message_id, 50 | # caption=message.reply_to_message.caption, 51 | reply_markup=message.reply_to_message.reply_markup, 52 | ) 53 | LOGGER.info("Broadcast sent to %s", chat_id) 54 | except FloodWait as e: 55 | LOGGER.warning("Floodwait while broadcasting, sleeping for %s", e.value) 56 | await asyncio.sleep(e.value) 57 | except Exception: 58 | pass 59 | 60 | if bool(br_msg): 61 | success += 1 62 | else: 63 | failed += 1 64 | time_taken = datetime.timedelta(seconds=int(time.time() - start_time)) 65 | await message.reply_text( 66 | f"**Broadcast Completed**\nSent to: `{success}`\nBlocked / Deleted: `{failed}`\nCompleted in `{time_taken}` HH:MM:SS" 67 | ) 68 | 69 | else: 70 | reply_error = ( 71 | "`Use this command as a reply to any telegram message without any spaces.`" 72 | ) 73 | msg = await message.reply_text(reply_error, message.id) 74 | await asyncio.sleep(8) 75 | await msg.delete() 76 | -------------------------------------------------------------------------------- /mfinder/utils/constants.py: -------------------------------------------------------------------------------- 1 | from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton 2 | 3 | 4 | START_KB = InlineKeyboardMarkup( 5 | [ 6 | [ 7 | InlineKeyboardButton("🆘 Help", callback_data="help_cb"), 8 | InlineKeyboardButton( 9 | "👨‍💻 Source Code", url="https://github.com/EL-Coders/mediafinder" 10 | ), 11 | ] 12 | ] 13 | ) 14 | 15 | HELP_KB = InlineKeyboardMarkup( 16 | [ 17 | [ 18 | InlineKeyboardButton("🔙 Back", callback_data="back_m"), 19 | ], 20 | ] 21 | ) 22 | 23 | 24 | STARTMSG = "Hi **[{}](tg://user?id={})**, I am a media finder bot which finds media from my database channel. Just send query to find the media.\nSend /help for more or you can toggle your settings by sending /settings." 25 | 26 | 27 | HELPMSG = """ 28 | **You can find the bot commands here.** 29 | **User Commands:-** 30 | /help - __Show this help message__ 31 | /settings - __Toggle settings of Precise Mode and Button Mode__ 32 | `Precise Mode:` 33 | - __If Enabled, bot will match the word & return results with only the exact match__ 34 | - __If Disabled, bot will match the word & return all the results containing the word__ 35 | `Result Mode:` 36 | - __If Button, bot will return results in button format__ 37 | - __If List, bot will return results in list format__ 38 | - __If HyperLink, bot will return results in hyperlink format__ 39 | 40 | **Admin Commands:-** 41 | /logs - __Get logs as a file__ 42 | /server - __Get server stats__ 43 | /restart - __Restart the bot__ 44 | /stats - __Get bot user stats__ 45 | /broadcast - __Reply to a message to send that to all bot users__ 46 | /index - __Start indexing a database channel (bot must be admin of the channel if that is provate channel)__ 47 | __You can just forward the message from database channel for starting indexing, no need to use the /index command__ 48 | /delete - __Reply to a file to delete it from database__ 49 | /autodelete - __Set file auto delete time in seconds__ 50 | /repairmode - __Enable or disable repair mode - If on, bot will not send any files__ 51 | /customcaption - __Set custom caption for files__ 52 | /adminsettings - __Get current admin settings__ 53 | /ban - __Ban a user from bot__ - `/ban user_id` 54 | /unban - __Unban a user from bot__ - `/unban user_id` 55 | /addfilter - __Add a text filter__ - `/addfilter filter message` __or__ `/addfilter "filter multiple words" message` __(If a filter is there, bot will send the filter rather than file)__ 56 | /delfilter - __Delete a text filter__ - `/delfilter filter` 57 | /listfilters - __List all filters currently added in the bot__ 58 | /forcesub - __Set force subscribe channel__ - `/forcesub channel_id` __Bot must be admin of that channel (Bot will create a new invite link for that channel)__ 59 | /checklink - __Check invite link for force subscribe channel__ 60 | /total - __Get count of total files in DB__ 61 | """ 62 | 63 | SET_MSG = """ 64 | **Below are your current settings:** 65 | `Info` 66 | **Precise Mode:** 67 | - __If Enabled, bot will match the word & return results with only the exact match__ 68 | - __If Disabled, bot will match the word & return all the results containing the word__ 69 | **Result Mode:** 70 | - __If HyperLink, bot will return results in hyperlink format__ 71 | - __If Button, bot will return results in button format__ 72 | - __If List, bot will return results in list format__ 73 | 74 | 75 | __You can toggle with right side buttons__:-""" 76 | -------------------------------------------------------------------------------- /mfinder/utils/helpers.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | import base64 3 | from struct import pack 4 | from pyrogram import raw 5 | from pyrogram.file_id import FileId, FileType, PHOTO_TYPES, DOCUMENT_TYPES 6 | 7 | 8 | def get_input_file_from_file_id( 9 | file_id: str, 10 | expected_file_type: FileType = None, 11 | ) -> Union["raw.types.InputPhoto", "raw.types.InputDocument"]: 12 | try: 13 | decoded = FileId.decode(file_id) 14 | except Exception: 15 | raise ValueError( 16 | f'Failed to decode "{file_id}". The value does not represent an existing local file, ' 17 | f"HTTP URL, or valid file id." 18 | ) 19 | 20 | file_type = decoded.file_type 21 | 22 | if expected_file_type is not None and file_type != expected_file_type: 23 | raise ValueError( 24 | f'Expected: "{expected_file_type}", got "{file_type}" file_id instead' 25 | ) 26 | 27 | if file_type in (FileType.THUMBNAIL, FileType.CHAT_PHOTO): 28 | raise ValueError(f"This file_id can only be used for download: {file_id}") 29 | 30 | if file_type in PHOTO_TYPES: 31 | return raw.types.InputPhoto( 32 | id=decoded.media_id, 33 | access_hash=decoded.access_hash, 34 | file_reference=decoded.file_reference, 35 | ) 36 | 37 | if file_type in DOCUMENT_TYPES: 38 | return raw.types.InputDocument( 39 | id=decoded.media_id, 40 | access_hash=decoded.access_hash, 41 | file_reference=decoded.file_reference, 42 | ) 43 | 44 | raise ValueError(f"Unknown file id: {file_id}") 45 | 46 | 47 | def encode_file_id(s: bytes) -> str: 48 | r = b"" 49 | n = 0 50 | 51 | for i in s + bytes([22]) + bytes([4]): 52 | if i == 0: 53 | n += 1 54 | else: 55 | if n: 56 | r += b"\x00" + bytes([n]) 57 | n = 0 58 | 59 | r += bytes([i]) 60 | 61 | return base64.urlsafe_b64encode(r).decode().rstrip("=") 62 | 63 | 64 | def encode_file_ref(file_ref: bytes) -> str: 65 | return base64.urlsafe_b64encode(file_ref).decode().rstrip("=") 66 | 67 | 68 | def unpack_new_file_id(new_file_id): 69 | """Return file_id, file_ref""" 70 | decoded = FileId.decode(new_file_id) 71 | file_id = encode_file_id( 72 | pack( 73 | "{e}" 47 | ) 48 | 49 | 50 | @Client.on_callback_query(filters.regex(r"^index -?\d+ \d+")) 51 | async def index(bot, query): 52 | user_id = query.from_user.id 53 | chat_id, last_msg_id = map(int, query.data.split()[1:]) 54 | 55 | await query.message.delete() 56 | msg = await bot.send_message(user_id, "Processing Index...⏳") 57 | total_files = 0 58 | async with lock: 59 | try: 60 | total = last_msg_id + 1 61 | current = 2 62 | counter = 0 63 | while True: 64 | try: 65 | message = await bot.get_messages( 66 | chat_id=chat_id, message_ids=current, replies=0 67 | ) 68 | except FloodWait as e: 69 | LOGGER.warning("FloodWait while indexing, Error: %s", str(e)) 70 | await asyncio.sleep(e.value) 71 | except Exception as e: 72 | LOGGER.warning("Error occurred while fetching message: %s", str(e)) 73 | try: 74 | for file_type in ("document", "video", "audio"): 75 | media = getattr(message, file_type, None) 76 | if not media: 77 | break 78 | file_name = media.file_name 79 | file_name = edit_caption(file_name) 80 | media.file_type = file_type 81 | media.caption = file_name 82 | await save_file(media) 83 | total_files += 1 84 | except Exception as e: 85 | LOGGER.warning("Error occurred while saving file: %s", str(e)) 86 | 87 | current += 1 88 | counter += 1 89 | if counter == 50: 90 | try: 91 | await msg.edit( 92 | f"Total messages fetched: {current}\nTotal messages saved: {total_files}" 93 | ) 94 | except FloodWait as e: 95 | LOGGER.warning( 96 | "FloodWait while indexing, sleeping for: %s", str(e.value) 97 | ) 98 | await asyncio.sleep(e.value) 99 | counter -= 50 100 | if current == total: 101 | break 102 | 103 | except Exception as e: 104 | LOGGER.exception(e) 105 | await msg.edit(f"Error: {e}") 106 | else: 107 | await msg.edit(f"Total {total_files} Saved To DataBase!") 108 | 109 | 110 | @Client.on_message(filters.command(["index"]) & filters.user(ADMINS)) 111 | async def index_comm(bot, update): 112 | await update.reply( 113 | "Now please forward the last message of the channel you want to index & follow the steps. Bot must be admin of the channel if the channel is private." 114 | ) 115 | 116 | 117 | @Client.on_message(filters.command(["delete"]) & filters.user(ADMINS)) 118 | async def delete_files(bot, message): 119 | if not message.reply_to_message: 120 | await message.reply("Please reply to a file to delete") 121 | org_msg = message.reply_to_message 122 | try: 123 | for file_type in ("document", "video", "audio"): 124 | media = getattr(org_msg, file_type, None) 125 | if not media: 126 | break 127 | del_file = await delete_file(media) 128 | if del_file == "Not Found": 129 | await message.reply(f"`{media.file_name}` not found in database") 130 | elif del_file == True: 131 | await message.reply(f"`{media.file_name}` deleted from database") 132 | else: 133 | await message.reply( 134 | f"Error occurred while deleting `{media.file_name}`, please check logs for more info" 135 | ) 136 | except Exception as e: 137 | LOGGER.warning("Error occurred while deleting file: %s", str(e)) 138 | 139 | 140 | @Client.on_callback_query(filters.regex(r"^can-index$")) 141 | async def cancel_index(bot, query): 142 | await query.message.delete() 143 | -------------------------------------------------------------------------------- /mfinder/db/files_sql.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from sqlalchemy import create_engine, or_, func, and_ 3 | from sqlalchemy import Column, TEXT, Numeric 4 | from sqlalchemy.ext.declarative import declarative_base 5 | from sqlalchemy.orm import sessionmaker, scoped_session 6 | from sqlalchemy.orm.exc import NoResultFound 7 | from sqlalchemy.pool import StaticPool 8 | from mfinder import DB_URL, LOGGER 9 | from mfinder.utils.helpers import unpack_new_file_id 10 | 11 | 12 | BASE = declarative_base() 13 | 14 | 15 | class Files(BASE): 16 | __tablename__ = "files" 17 | file_name = Column(TEXT, primary_key=True) 18 | file_id = Column(TEXT) 19 | file_ref = Column(TEXT) 20 | file_size = Column(Numeric) 21 | file_type = Column(TEXT) 22 | mime_type = Column(TEXT) 23 | caption = Column(TEXT) 24 | 25 | def __init__( 26 | self, file_name, file_id, file_ref, file_size, file_type, mime_type, caption 27 | ): 28 | self.file_name = file_name 29 | self.file_id = file_id 30 | self.file_ref = file_ref 31 | self.file_size = file_size 32 | self.file_type = file_type 33 | self.mime_type = mime_type 34 | self.caption = caption 35 | 36 | 37 | def start() -> scoped_session: 38 | engine = create_engine(DB_URL, client_encoding="utf8", poolclass=StaticPool) 39 | BASE.metadata.bind = engine 40 | BASE.metadata.create_all(engine) 41 | return scoped_session(sessionmaker(bind=engine, autoflush=False)) 42 | 43 | 44 | SESSION = start() 45 | INSERTION_LOCK = threading.RLock() 46 | 47 | 48 | async def save_file(media): 49 | file_id, file_ref = unpack_new_file_id(media.file_id) 50 | with INSERTION_LOCK: 51 | try: 52 | file = SESSION.query(Files).filter_by(file_id=file_id).one() 53 | LOGGER.warning("%s is already saved in the database", media.file_name) 54 | except NoResultFound: 55 | try: 56 | file = SESSION.query(Files).filter_by(file_name=media.file_name).one() 57 | LOGGER.warning("%s is already saved in the database", media.file_name) 58 | except NoResultFound: 59 | file = Files( 60 | file_name=media.file_name, 61 | file_id=file_id, 62 | file_ref=file_ref, 63 | file_size=media.file_size, 64 | file_type=media.file_type, 65 | mime_type=media.mime_type, 66 | caption=media.caption if media.caption else None, 67 | ) 68 | LOGGER.info("%s is saved in database", media.file_name) 69 | SESSION.add(file) 70 | SESSION.commit() 71 | return True 72 | except Exception as e: 73 | LOGGER.warning( 74 | "Error occurred while saving file in database: %s", str(e) 75 | ) 76 | SESSION.rollback() 77 | return False 78 | except Exception as e: 79 | LOGGER.warning("Error occurred while saving file in database: %s", str(e)) 80 | SESSION.rollback() 81 | return False 82 | 83 | 84 | async def get_filter_results(query, page=1, per_page=10): 85 | try: 86 | with INSERTION_LOCK: 87 | offset = (page - 1) * per_page 88 | search = query.split() 89 | conditions = [] 90 | for word in search: 91 | conditions.append( 92 | or_( 93 | Files.file_name.ilike(f"%{word}%"), 94 | Files.caption.ilike(f"%{word}%"), 95 | ) 96 | ) 97 | combined_condition = and_(*conditions) 98 | files_query = ( 99 | SESSION.query(Files) 100 | .filter(combined_condition) 101 | .order_by(Files.file_name) 102 | ) 103 | total_count = files_query.count() 104 | files = files_query.offset(offset).limit(per_page).all() 105 | return files, total_count 106 | except Exception as e: 107 | LOGGER.warning("Error occurred while retrieving filter results: %s", str(e)) 108 | return [], 0 109 | 110 | 111 | async def get_precise_filter_results(query, page=1, per_page=10): 112 | try: 113 | with INSERTION_LOCK: 114 | offset = (page - 1) * per_page 115 | search = query.split() 116 | conditions = [] 117 | for word in search: 118 | conditions.append( 119 | or_( 120 | func.concat(" ", Files.file_name, " ").ilike(f"% {word} %"), 121 | func.concat(" ", Files.caption, " ").ilike(f"% {word} %"), 122 | ) 123 | ) 124 | combined_condition = and_(*conditions) 125 | files_query = ( 126 | SESSION.query(Files) 127 | .filter(combined_condition) 128 | .order_by(Files.file_name) 129 | ) 130 | total_count = files_query.count() 131 | files = files_query.offset(offset).limit(per_page).all() 132 | return files, total_count 133 | except Exception as e: 134 | LOGGER.warning("Error occurred while retrieving filter results: %s", str(e)) 135 | return [], 0 136 | 137 | 138 | async def get_file_details(file_id): 139 | try: 140 | with INSERTION_LOCK: 141 | file_details = SESSION.query(Files).filter_by(file_id=file_id).all() 142 | return file_details 143 | except Exception as e: 144 | LOGGER.warning("Error occurred while retrieving file details: %s", str(e)) 145 | return [] 146 | 147 | 148 | async def delete_file(media): 149 | file_id, file_ref = unpack_new_file_id(media.file_id) 150 | try: 151 | with INSERTION_LOCK: 152 | file = SESSION.query(Files).filter_by(file_id=file_id).first() 153 | if file: 154 | SESSION.delete(file) 155 | SESSION.commit() 156 | return True 157 | return "Not Found" 158 | LOGGER.warning("File to delete not found: %s", str(file_id)) 159 | except Exception as e: 160 | LOGGER.warning("Error occurred while deleting file: %s", str(e)) 161 | SESSION.rollback() 162 | return False 163 | 164 | async def count_files(): 165 | try: 166 | with INSERTION_LOCK: 167 | total_count = SESSION.query(Files).count() 168 | return total_count 169 | except Exception as e: 170 | LOGGER.warning("Error occurred while counting files: %s", str(e)) 171 | return 0 -------------------------------------------------------------------------------- /mfinder/db/settings_sql.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from sqlalchemy import create_engine 3 | from sqlalchemy import Column, TEXT, Boolean, Numeric, BigInteger 4 | from sqlalchemy.ext.declarative import declarative_base 5 | from sqlalchemy.orm import sessionmaker, scoped_session 6 | from sqlalchemy.pool import StaticPool 7 | from sqlalchemy.orm.exc import NoResultFound 8 | from mfinder import DB_URL, LOGGER 9 | 10 | 11 | BASE = declarative_base() 12 | 13 | 14 | class AdminSettings(BASE): 15 | __tablename__ = "admin_settings" 16 | setting_name = Column(TEXT, primary_key=True) 17 | auto_delete = Column(Numeric) 18 | custom_caption = Column(TEXT) 19 | fsub_channel = Column(Numeric) 20 | channel_link = Column(TEXT) 21 | caption_uname = Column(TEXT) 22 | repair_mode = Column(Boolean) 23 | 24 | def __init__(self, setting_name="default"): 25 | self.setting_name = setting_name 26 | self.auto_delete = 0 27 | self.custom_caption = None 28 | self.fsub_channel = None 29 | self.channel_link = None 30 | self.caption_uname = None 31 | self.repair_mode = False 32 | 33 | 34 | class Settings(BASE): 35 | __tablename__ = "settings" 36 | user_id = Column(BigInteger, primary_key=True) 37 | precise_mode = Column(Boolean) 38 | button_mode = Column(Boolean) 39 | link_mode = Column(Boolean) 40 | list_mode = Column(Boolean) 41 | 42 | def __init__(self, user_id, precise_mode, button_mode, link_mode, list_mode): 43 | self.user_id = user_id 44 | self.precise_mode = precise_mode 45 | self.button_mode = button_mode 46 | self.link_mode = link_mode 47 | self.list_mode = list_mode 48 | 49 | 50 | def start() -> scoped_session: 51 | engine = create_engine(DB_URL, client_encoding="utf8", poolclass=StaticPool) 52 | BASE.metadata.bind = engine 53 | BASE.metadata.create_all(engine) 54 | return scoped_session(sessionmaker(bind=engine, autoflush=False)) 55 | 56 | 57 | SESSION = start() 58 | INSERTION_LOCK = threading.RLock() 59 | 60 | 61 | async def get_search_settings(user_id): 62 | try: 63 | with INSERTION_LOCK: 64 | settings = SESSION.query(Settings).filter_by(user_id=user_id).first() 65 | return settings 66 | except Exception as e: 67 | LOGGER.warning("Error getting search settings: %s ", str(e)) 68 | return None 69 | 70 | 71 | async def change_search_settings(user_id, precise_mode=None, button_mode=None, link_mode=None, list_mode=None): 72 | try: 73 | with INSERTION_LOCK: 74 | settings = SESSION.query(Settings).filter_by(user_id=user_id).first() 75 | if settings: 76 | if precise_mode is not None: 77 | settings.precise_mode = precise_mode 78 | if button_mode is not None: 79 | settings.button_mode = button_mode 80 | if link_mode is not None: 81 | settings.link_mode = link_mode 82 | if list_mode is not None: 83 | settings.list_mode = list_mode 84 | else: 85 | new_settings = Settings( 86 | user_id=user_id, precise_mode=precise_mode, button_mode=button_mode, link_mode=link_mode, list_mode=list_mode 87 | ) 88 | SESSION.add(new_settings) 89 | SESSION.commit() 90 | return True 91 | except Exception as e: 92 | LOGGER.warning("Error changing search settings: %s ", str(e)) 93 | 94 | 95 | async def set_repair_mode(repair_mode): 96 | try: 97 | with INSERTION_LOCK: 98 | session = SESSION() 99 | admin_setting = session.query(AdminSettings).first() 100 | if not admin_setting: 101 | admin_setting = AdminSettings(setting_name="default") 102 | session.add(admin_setting) 103 | session.commit() 104 | 105 | admin_setting.repair_mode = repair_mode 106 | session.commit() 107 | 108 | except Exception as e: 109 | LOGGER.warning("Error setting repair mode: %s ", str(e)) 110 | 111 | 112 | async def set_auto_delete(dur): 113 | try: 114 | with INSERTION_LOCK: 115 | session = SESSION() 116 | admin_setting = session.query(AdminSettings).first() 117 | if not admin_setting: 118 | admin_setting = AdminSettings(setting_name="default") 119 | session.add(admin_setting) 120 | session.commit() 121 | 122 | admin_setting.auto_delete = dur 123 | session.commit() 124 | 125 | except Exception as e: 126 | LOGGER.warning("Error setting auto delete: %s ", str(e)) 127 | 128 | 129 | async def get_admin_settings(): 130 | try: 131 | with INSERTION_LOCK: 132 | session = SESSION() 133 | admin_setting = session.query(AdminSettings).first() 134 | if not admin_setting: 135 | admin_setting = AdminSettings(setting_name="default") 136 | session.add(admin_setting) 137 | session.commit() 138 | 139 | return admin_setting 140 | except Exception as e: 141 | LOGGER.warning("Error getting admin settings: %s", str(e)) 142 | 143 | 144 | async def set_custom_caption(caption): 145 | try: 146 | with INSERTION_LOCK: 147 | session = SESSION() 148 | admin_setting = session.query(AdminSettings).first() 149 | if not admin_setting: 150 | admin_setting = AdminSettings(setting_name="default") 151 | session.add(admin_setting) 152 | session.commit() 153 | 154 | admin_setting.custom_caption = caption 155 | session.commit() 156 | 157 | except Exception as e: 158 | LOGGER.warning("Error setting custom caption: %s ", str(e)) 159 | 160 | 161 | async def set_force_sub(channel): 162 | try: 163 | with INSERTION_LOCK: 164 | session = SESSION() 165 | admin_setting = session.query(AdminSettings).first() 166 | if not admin_setting: 167 | admin_setting = AdminSettings(setting_name="default") 168 | session.add(admin_setting) 169 | session.commit() 170 | 171 | admin_setting.fsub_channel = channel 172 | session.commit() 173 | 174 | except Exception as e: 175 | LOGGER.warning("Error setting Force Sub channel: %s ", str(e)) 176 | 177 | 178 | async def set_channel_link(link): 179 | try: 180 | with INSERTION_LOCK: 181 | session = SESSION() 182 | admin_setting = session.query(AdminSettings).first() 183 | if not admin_setting: 184 | admin_setting = AdminSettings(setting_name="default") 185 | session.add(admin_setting) 186 | session.commit() 187 | 188 | admin_setting.channel_link = link 189 | session.commit() 190 | 191 | except Exception as e: 192 | LOGGER.warning("Error adding Force Sub channel link: %s ", str(e)) 193 | 194 | 195 | async def get_channel(): 196 | try: 197 | channel = SESSION.query(AdminSettings.fsub_channel).first() 198 | if channel: 199 | return channel[0] 200 | return False 201 | except NoResultFound: 202 | return False 203 | finally: 204 | SESSION.close() 205 | 206 | async def get_link(): 207 | try: 208 | link = SESSION.query(AdminSettings.channel_link).first() 209 | if link: 210 | return link[0] 211 | return False 212 | except NoResultFound: 213 | return False 214 | finally: 215 | SESSION.close() 216 | 217 | async def set_username(username): 218 | try: 219 | with INSERTION_LOCK: 220 | session = SESSION() 221 | admin_setting = session.query(AdminSettings).first() 222 | if not admin_setting: 223 | admin_setting = AdminSettings(setting_name="default") 224 | session.add(admin_setting) 225 | session.commit() 226 | 227 | admin_setting.caption_uname = username 228 | session.commit() 229 | 230 | except Exception as e: 231 | LOGGER.warning("Error adding username: %s ", str(e)) 232 | -------------------------------------------------------------------------------- /mfinder/plugins/admin_settings.py: -------------------------------------------------------------------------------- 1 | import shlex 2 | from pyrogram import Client, filters 3 | from mfinder.db.settings_sql import ( 4 | get_admin_settings, 5 | set_repair_mode, 6 | set_auto_delete, 7 | set_custom_caption, 8 | set_force_sub, 9 | set_channel_link, 10 | get_link, 11 | set_username, 12 | ) 13 | from mfinder.db.ban_sql import is_banned, ban_user, unban_user 14 | from mfinder.db.filters_sql import add_filter, rem_filter, list_filters 15 | from mfinder.db.files_sql import count_files 16 | from mfinder import ADMINS, DB_CHANNELS 17 | 18 | 19 | @Client.on_message(filters.command(["autodelete"]) & filters.user(ADMINS)) 20 | async def auto_delete_(bot, update): 21 | data = update.text.split() 22 | if len(data) == 2: 23 | dur = data[-1] 24 | if dur.lower() == "off": 25 | dur = 0 26 | 27 | await set_auto_delete(int(dur)) 28 | 29 | if dur: 30 | await update.reply_text(f"File auto delete set to `{dur}` seconds") 31 | else: 32 | await update.reply_text("File auto delete disabled") 33 | 34 | else: 35 | await update.reply_text("Please send in proper format `/autodelete seconds`") 36 | 37 | 38 | @Client.on_message(filters.command(["repairmode"]) & filters.user(ADMINS)) 39 | async def repair_mode_(bot, update): 40 | data = update.text.split() 41 | if len(data) == 2: 42 | toggle = data[-1] 43 | if toggle.lower() == "off": 44 | mode = False 45 | elif toggle.lower() == "on": 46 | mode = True 47 | else: 48 | await update.reply_text( 49 | "Please send in proper format `/repairmode `" 50 | ) 51 | return 52 | 53 | await set_repair_mode(mode) 54 | await update.reply_text(f"Repair mode set to `{toggle.upper()}`") 55 | 56 | else: 57 | await update.reply_text("Please send in proper format `/repairmode on/off`") 58 | return 59 | 60 | 61 | @Client.on_message(filters.command(["customcaption"]) & filters.user(ADMINS)) 62 | async def custom_caption_(bot, update): 63 | data = update.text.split() 64 | caption = " ".join(data[1:]) 65 | if len(data) >= 2: 66 | if caption.lower() == "off": 67 | caption = None 68 | 69 | await set_custom_caption(caption) 70 | 71 | if caption: 72 | await update.reply_text(f"Custom caption set to `{caption}`") 73 | else: 74 | await update.reply_text("Custom caption disabled") 75 | 76 | else: 77 | await update.reply_text( 78 | "Please send in proper format `/customcaption caption/off`" 79 | ) 80 | return 81 | 82 | 83 | @Client.on_message(filters.command(["adminsettings"])) 84 | async def admin_settings_(bot, update): 85 | user_id = update.from_user.id 86 | admin_settings = await get_admin_settings() 87 | auto_delete = admin_settings.auto_delete 88 | custom_caption = admin_settings.custom_caption 89 | fsub_channel = admin_settings.fsub_channel 90 | caption_uname = admin_settings.caption_uname 91 | invite_link = admin_settings.channel_link 92 | repair_mode = admin_settings.repair_mode 93 | 94 | admins = "" 95 | dbchannel = "" 96 | for admin in ADMINS: 97 | admins += "\n" + "`" + str(admin) + "`" 98 | for channel in DB_CHANNELS: 99 | dbchannel += "\n" + "`" + str(channel) + "`" 100 | 101 | if auto_delete: 102 | auto_delete = f"{auto_delete} seconds" 103 | else: 104 | auto_delete = "Disabled" 105 | 106 | if not custom_caption: 107 | custom_caption = "Disabled" 108 | 109 | if not fsub_channel: 110 | fsub_channel = "Disabled" 111 | 112 | if not caption_uname: 113 | caption_uname = "Disabled" 114 | 115 | if not invite_link: 116 | invite_link = "Disabled" 117 | 118 | if repair_mode: 119 | repair_mode = "Enabled" 120 | else: 121 | repair_mode = "Disabled" 122 | 123 | await bot.send_message( 124 | chat_id=user_id, 125 | text=f"**Below are your current settings.**\n\n**Repair Mode:** `{repair_mode}`\n**Auto Delete:** `{auto_delete}`\n**Custom Caption:** `{custom_caption}`\n**Force Sub:** `{fsub_channel}`\n**Caption Username:** `{caption_uname}`\n**Channel Link:** `{invite_link}`\n**Admins:** {admins} \n**DB Channels:** {dbchannel}", 126 | ) 127 | 128 | 129 | @Client.on_message(filters.command(["ban"]) & filters.user(ADMINS)) 130 | async def banuser(bot, update): 131 | data = update.text.split() 132 | if len(data) == 2: 133 | user_id = data[-1] 134 | banned = await is_banned(int(user_id)) 135 | if not banned: 136 | await ban_user(int(user_id)) 137 | await update.reply_text(f"User {user_id} banned") 138 | else: 139 | await update.reply_text(f"User {user_id} is already banned") 140 | 141 | else: 142 | await update.reply_text("Please send in proper format `/ban user_id`") 143 | 144 | 145 | @Client.on_message(filters.command(["unban"]) & filters.user(ADMINS)) 146 | async def unbanuser(bot, update): 147 | data = update.text.split() 148 | if len(data) == 2: 149 | user_id = data[-1] 150 | banned = await is_banned(int(user_id)) 151 | if banned: 152 | await unban_user(int(user_id)) 153 | await update.reply_text(f"User {user_id} unbanned") 154 | else: 155 | await update.reply_text(f"User {user_id} is not in ban list") 156 | else: 157 | await update.reply_text("Please send in proper format `/unban user_id`") 158 | 159 | 160 | @Client.on_message(filters.command(["addfilter"]) & filters.user(ADMINS)) 161 | async def addfilter(bot, update): 162 | data = shlex.split(update.text) 163 | if len(data) >= 3: 164 | fltr = data[1].strip('"').lower() 165 | message = " ".join(data[2:]) 166 | add = await add_filter(fltr, message) 167 | if add: 168 | await update.reply_text(f"Filter `{fltr}` added") 169 | else: 170 | await update.reply_text(f"Filter `{fltr}` already exists") 171 | else: 172 | await update.reply_text( 173 | "Please send in proper format `/addfilter filter message`" 174 | ) 175 | 176 | 177 | @Client.on_message(filters.command(["delfilter"]) & filters.user(ADMINS)) 178 | async def delfilter(bot, update): 179 | data = update.text.split() 180 | if len(data) >= 2: 181 | fltr = " ".join(data[1:]) 182 | rem = await rem_filter(fltr) 183 | if rem: 184 | await update.reply_text(f"Filter `{fltr}` removed") 185 | else: 186 | await update.reply_text(f"Filter `{fltr}` not found") 187 | else: 188 | await update.reply_text("Please send in proper format `/delfilter filter`") 189 | 190 | 191 | @Client.on_message(filters.command(["listfilters"]) & filters.user(ADMINS)) 192 | async def list_filter(bot, update): 193 | fltr = await list_filters() 194 | fltr_msg = "" 195 | if fltr: 196 | for fltrs in fltr: 197 | fltr_msg += "\n" + "`" + fltrs + "`" 198 | await update.reply_text(f"**Available Filters:** {fltr_msg}") 199 | else: 200 | await update.reply_text("No filters found") 201 | 202 | 203 | @Client.on_message(filters.command(["forcesub"]) & filters.user(ADMINS)) 204 | async def force_sub(bot, update): 205 | data = update.text.split() 206 | if len(data) == 2: 207 | channel = data[-1] 208 | if channel.lower() == "off": 209 | channel = 0 210 | 211 | if channel: 212 | try: 213 | link = await bot.create_chat_invite_link(channel) 214 | await set_channel_link(link.invite_link) 215 | except Exception as e: 216 | await update.reply_text( 217 | f" Error while creating channel invite link: {str(e)}" 218 | ) 219 | return 220 | 221 | await set_force_sub(int(channel)) 222 | await update.reply_text(f"Force Subscription channel set to `{channel}`") 223 | else: 224 | await set_channel_link(None) 225 | await update.reply_text("Force Subscription disabled") 226 | 227 | else: 228 | await update.reply_text( 229 | "Please send in proper format `/forcesub channel_id/off`" 230 | ) 231 | 232 | 233 | @Client.on_message(filters.command(["checklink"]) & filters.user(ADMINS)) 234 | async def testlink(bot, update): 235 | link = await get_link() 236 | if link: 237 | await update.reply_text(f"Invite link for force subscription channel: {link}") 238 | else: 239 | await update.reply_text( 240 | "Force Subscription is disabled, please enable it first" 241 | ) 242 | 243 | 244 | @Client.on_message(filters.command(["setusername"]) & filters.user(ADMINS)) 245 | async def caption_username(bot, update): 246 | data = update.text.split() 247 | if len(data) == 2: 248 | username = data[-1] 249 | if username.lower() == "off": 250 | username = 0 251 | elif username.startswith("@"): 252 | username = username 253 | else: 254 | await update.reply_text("This is not a username, please check.") 255 | return 256 | 257 | await set_username(username) 258 | 259 | if username: 260 | await update.reply_text(f"File caption username set to `{username}`") 261 | else: 262 | await update.reply_text("File caption username disabled") 263 | 264 | else: 265 | await update.reply_text( 266 | "Please send in proper format `/setusername username/off`" 267 | ) 268 | 269 | 270 | @Client.on_message(filters.command(["total"]) & filters.user(ADMINS)) 271 | async def count_f(bot, update): 272 | count = await count_files() 273 | await update.reply_text(f"**Total no. of files in DB:** `{count}`") 274 | -------------------------------------------------------------------------------- /mfinder/plugins/serve.py: -------------------------------------------------------------------------------- 1 | import re 2 | import asyncio 3 | from pyrogram import Client, filters 4 | from pyrogram.types import ( 5 | InlineKeyboardButton, 6 | InlineKeyboardMarkup, 7 | Message, 8 | CallbackQuery, 9 | LinkPreviewOptions, 10 | ) 11 | from pyrogram.enums import ParseMode, ChatMemberStatus 12 | from pyrogram.errors import UserNotParticipant 13 | from pyrogram.errors.exceptions.bad_request_400 import MessageNotModified 14 | from mfinder.db.files_sql import ( 15 | get_filter_results, 16 | get_file_details, 17 | get_precise_filter_results, 18 | ) 19 | from mfinder.db.settings_sql import ( 20 | get_search_settings, 21 | get_admin_settings, 22 | get_link, 23 | get_channel, 24 | ) 25 | from mfinder.db.ban_sql import is_banned 26 | from mfinder.db.filters_sql import is_filter 27 | from mfinder import LOGGER 28 | 29 | 30 | @Client.on_message( 31 | ~filters.regex(r"^\/") & filters.text & filters.private & filters.incoming 32 | ) 33 | async def filter_(bot, message): 34 | user_id = message.from_user.id 35 | 36 | if re.findall("((^\/|^,|^!|^\.|^[\U0001F600-\U000E007F]).*)", message.text): 37 | return 38 | 39 | if await is_banned(user_id): 40 | await message.reply_text("You are banned. You can't use this bot.", quote=True) 41 | return 42 | 43 | force_sub = await get_channel() 44 | if force_sub: 45 | try: 46 | user = await bot.get_chat_member(int(force_sub), user_id) 47 | if user.status == ChatMemberStatus.BANNED: 48 | await message.reply_text("Sorry, you are Banned to use me.", quote=True) 49 | return 50 | except UserNotParticipant: 51 | link = await get_link() 52 | await message.reply_text( 53 | text="**Please join my Update Channel to use this Bot!**", 54 | reply_markup=InlineKeyboardMarkup( 55 | [[InlineKeyboardButton("🤖 Join Channel", url=link)]] 56 | ), 57 | parse_mode=ParseMode.MARKDOWN, 58 | quote=True, 59 | ) 60 | return 61 | except Exception as e: 62 | LOGGER.warning(e) 63 | await message.reply_text( 64 | text="Something went wrong, please contact my support group", 65 | quote=True, 66 | ) 67 | return 68 | 69 | admin_settings = await get_admin_settings() 70 | if admin_settings: 71 | if admin_settings.repair_mode: 72 | return 73 | 74 | fltr = await is_filter(message.text) 75 | if fltr: 76 | await message.reply_text( 77 | text=fltr.message, 78 | quote=True, 79 | ) 80 | return 81 | 82 | if 2 < len(message.text) < 100: 83 | search = message.text 84 | page_no = 1 85 | me = bot.me 86 | username = me.username 87 | result, btn = await get_result(search, page_no, user_id, username) 88 | 89 | if result: 90 | if btn: 91 | await message.reply_text( 92 | f"{result}", 93 | reply_markup=InlineKeyboardMarkup(btn), 94 | link_preview_options=LinkPreviewOptions(is_disabled=True), 95 | quote=True, 96 | ) 97 | else: 98 | await message.reply_text( 99 | f"{result}", 100 | link_preview_options=LinkPreviewOptions(is_disabled=True), 101 | quote=True, 102 | ) 103 | else: 104 | await message.reply_text( 105 | text="No results found.\nOr retry with the correct spelling 🤐", 106 | quote=True, 107 | ) 108 | 109 | 110 | @Client.on_callback_query(filters.regex(r"^(nxt_pg|prev_pg) \d+ \d+ .+$")) 111 | async def pages(bot, query): 112 | user_id = query.from_user.id 113 | org_user_id, page_no, search = query.data.split(maxsplit=3)[1:] 114 | org_user_id = int(org_user_id) 115 | page_no = int(page_no) 116 | me = bot.me 117 | username = me.username 118 | 119 | result, btn = await get_result(search, page_no, user_id, username) 120 | 121 | if result: 122 | try: 123 | if btn: 124 | await query.message.edit( 125 | f"{result}", 126 | reply_markup=InlineKeyboardMarkup(btn), 127 | link_preview_options=LinkPreviewOptions(is_disabled=True), 128 | ) 129 | else: 130 | await query.message.edit( 131 | f"{result}", 132 | link_preview_options=LinkPreviewOptions(is_disabled=True), 133 | ) 134 | except MessageNotModified: 135 | pass 136 | else: 137 | await query.message.reply_text( 138 | text="No results found.\nOr retry with the correct spelling 🤐", 139 | quote=True, 140 | ) 141 | 142 | 143 | async def get_result(search, page_no, user_id, username): 144 | search_settings = await get_search_settings(user_id) 145 | if search_settings: 146 | if search_settings.precise_mode: 147 | files, count = await get_precise_filter_results(query=search, page=page_no) 148 | precise_search = "Enabled" 149 | else: 150 | files, count = await get_filter_results(query=search, page=page_no) 151 | precise_search = "Disabled" 152 | else: 153 | files, count = await get_filter_results(query=search, page=page_no) 154 | precise_search = "Disabled" 155 | 156 | if search_settings: 157 | if search_settings.button_mode: 158 | button_mode = "ON" 159 | else: 160 | button_mode = "OFF" 161 | else: 162 | button_mode = "OFF" 163 | 164 | if search_settings: 165 | if search_settings.link_mode: 166 | link_mode = "ON" 167 | else: 168 | link_mode = "OFF" 169 | else: 170 | link_mode = "OFF" 171 | 172 | if button_mode == "ON" and link_mode == "OFF": 173 | search_md = "Button" 174 | elif button_mode == "OFF" and link_mode == "ON": 175 | search_md = "HyperLink" 176 | else: 177 | search_md = "List Button" 178 | 179 | if files: 180 | btn = [] 181 | index = (page_no - 1) * 10 182 | crnt_pg = index // 10 + 1 183 | tot_pg = (count + 10 - 1) // 10 184 | btn_count = 0 185 | result = f"**Search Query:** `{search}`\n**Total Results:** `{count}`\n**Page:** `{crnt_pg}/{tot_pg}`\n**Precise Search: **`{precise_search}`\n**Result Mode:** `{search_md}`\n" 186 | page = page_no 187 | for file in files: 188 | if button_mode == "ON": 189 | file_id = file.file_id 190 | filename = f"[{get_size(file.file_size)}]{file.file_name}" 191 | btn_kb = InlineKeyboardButton( 192 | text=f"{filename}", callback_data=f"file {file_id}" 193 | ) 194 | btn.append([btn_kb]) 195 | elif link_mode == "ON": 196 | index += 1 197 | btn_count += 1 198 | file_id = file.file_id 199 | filename = f"**{index}.** [{file.file_name}](https://t.me/{username}/?start={file_id}) - `[{get_size(file.file_size)}]`" 200 | result += "\n" + filename 201 | else: 202 | index += 1 203 | btn_count += 1 204 | file_id = file.file_id 205 | filename = ( 206 | f"**{index}.** `{file.file_name}` - `[{get_size(file.file_size)}]`" 207 | ) 208 | result += "\n" + filename 209 | 210 | btn_kb = InlineKeyboardButton( 211 | text=f"{index}", callback_data=f"file {file_id}" 212 | ) 213 | 214 | if btn_count == 1 or btn_count == 6: 215 | btn.append([btn_kb]) 216 | elif 6 > btn_count > 1: 217 | btn[0].append(btn_kb) 218 | else: 219 | btn[1].append(btn_kb) 220 | 221 | nxt_kb = InlineKeyboardButton( 222 | text="Next >>", 223 | callback_data=f"nxt_pg {user_id} {page + 1} {search}", 224 | ) 225 | prev_kb = InlineKeyboardButton( 226 | text="<< Previous", 227 | callback_data=f"prev_pg {user_id} {page - 1} {search}", 228 | ) 229 | 230 | kb = [] 231 | if crnt_pg == 1 and tot_pg > 1: 232 | kb = [nxt_kb] 233 | elif crnt_pg > 1 and crnt_pg < tot_pg: 234 | kb = [prev_kb, nxt_kb] 235 | elif tot_pg > 1: 236 | kb = [prev_kb] 237 | 238 | if kb: 239 | btn.append(kb) 240 | 241 | if button_mode and link_mode == "OFF": 242 | result = ( 243 | result 244 | + "\n\n" 245 | + "🔻 __Tap on below corresponding file number to download.__ 🔻" 246 | ) 247 | elif link_mode == "ON": 248 | result = result + "\n\n" + " __Tap on file name & then start to download.__" 249 | 250 | return result, btn 251 | 252 | return None, None 253 | 254 | 255 | @Client.on_callback_query(filters.regex(r"^file (.+)$")) 256 | async def get_files(bot, query): 257 | user_id = query.from_user.id 258 | if isinstance(query, CallbackQuery): 259 | file_id = query.data.split()[1] 260 | await query.answer("Sending file...", cache_time=60) 261 | cbq = True 262 | elif isinstance(query, Message): 263 | file_id = query.text.split()[1] 264 | cbq = False 265 | filedetails = await get_file_details(file_id) 266 | admin_settings = await get_admin_settings() 267 | for files in filedetails: 268 | f_caption = files.caption 269 | if admin_settings.custom_caption: 270 | f_caption = admin_settings.custom_caption 271 | elif f_caption is None: 272 | f_caption = f"{files.file_name}" 273 | 274 | f_caption = "`" + f_caption + "`" 275 | 276 | if admin_settings.caption_uname: 277 | f_caption = f_caption + "\n" + admin_settings.caption_uname 278 | 279 | if cbq: 280 | msg = await query.message.reply_cached_media( 281 | file_id=file_id, 282 | caption=f_caption, 283 | parse_mode=ParseMode.MARKDOWN, 284 | quote=True, 285 | ) 286 | else: 287 | msg = await query.reply_cached_media( 288 | file_id=file_id, 289 | caption=f_caption, 290 | parse_mode=ParseMode.MARKDOWN, 291 | quote=True, 292 | ) 293 | 294 | if admin_settings.auto_delete: 295 | delay_dur = admin_settings.auto_delete 296 | delay = delay_dur / 60 if delay_dur > 60 else delay_dur 297 | delay = round(delay, 2) 298 | minsec = str(delay) + " mins" if delay_dur > 60 else str(delay) + " secs" 299 | disc = await bot.send_message( 300 | user_id, 301 | f"Please save the file to your saved messages, it will be deleted in {minsec}", 302 | ) 303 | await asyncio.sleep(delay_dur) 304 | await disc.delete() 305 | await msg.delete() 306 | await bot.send_message(user_id, "File has been deleted") 307 | 308 | 309 | def get_size(size): 310 | units = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB"] 311 | size = float(size) 312 | i = 0 313 | while size >= 1024.0 and i < len(units): 314 | i += 1 315 | size /= 1024.0 316 | return f"{size:.2f} {units[i]}" 317 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------