├── bot ├── helper │ ├── __init__.py │ ├── drive_utils │ │ ├── __init__.py │ │ └── gdriveTools.py │ └── telegram_helper │ │ ├── __init__.py │ │ ├── bot_commands.py │ │ ├── button_builder.py │ │ ├── bot_utils.py │ │ ├── filters.py │ │ └── message_utils.py ├── modules │ ├── __init__.py │ ├── list.py │ └── authorize.py ├── __main__.py └── __init__.py ├── start.sh ├── captain-definition ├── heroku.yml ├── .gitignore ├── requirements.txt ├── config_sample.env ├── Dockerfile ├── generate_drive_token.py ├── app.json ├── README.md └── LICENSE /bot/helper/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/modules/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /start.sh: -------------------------------------------------------------------------------- 1 | python3 -m bot -------------------------------------------------------------------------------- /bot/helper/drive_utils/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /captain-definition: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 2, 3 | "dockerfilePath": "./Dockerfile" 4 | } 5 | -------------------------------------------------------------------------------- /heroku.yml: -------------------------------------------------------------------------------- 1 | build: 2 | docker: 3 | worker: Dockerfile 4 | run: 5 | worker: bash start.sh -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | config.env 2 | *.pyc 3 | downloads/* 4 | download/* 5 | data* 6 | .vscode 7 | .idea 8 | *.json 9 | *.pickle 10 | authorized_chats.txt 11 | log.txt 12 | accounts/* -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | progress 3 | python-telegram-bot 4 | google-api-python-client 5 | google-auth-httplib2 6 | google-auth-oauthlib 7 | python-dotenv 8 | telegraph 9 | psycopg2-binary -------------------------------------------------------------------------------- /config_sample.env: -------------------------------------------------------------------------------- 1 | # REQUIRED CONFIG 2 | 3 | BOT_TOKEN = "" 4 | OWNER_ID = 5 | DRIVE_NAME = "" 6 | DRIVE_ID = "" 7 | INDEX_URL = "" 8 | 9 | # OPTIONAL CONFIG 10 | 11 | AUTHORIZED_CHATS = 12 | TELEGRAPH_TOKEN = "" 13 | DATABASE_URL = "" 14 | BOT_SOURCE_CODE = "" 15 | TELEGRAPH_CHANGES = "" 16 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/bot_commands.py: -------------------------------------------------------------------------------- 1 | class _BotCommands: 2 | def __init__(self): 3 | self.StartCommand = 'start' 4 | self.ListCommand = 'list' 5 | self.AuthorizedUsersCommand = 'users' 6 | self.AuthorizeCommand = 'auth' 7 | self.UnAuthorizeCommand = 'unauth' 8 | self.LogCommand = 'log' 9 | 10 | BotCommands = _BotCommands() 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:20.04 2 | 3 | RUN mkdir ./app 4 | RUN chmod 777 ./app 5 | WORKDIR /app 6 | 7 | ENV DEBIAN_FRONTEND=noninteractive 8 | ENV TZ=Asia/Kolkata 9 | 10 | RUN apt-get -qq update \ 11 | && apt-get install -y software-properties-common \ 12 | && apt-get -qq install -y python3 python3-pip 13 | 14 | COPY requirements.txt . 15 | RUN pip3 install --no-cache-dir -r requirements.txt 16 | 17 | COPY . . 18 | 19 | CMD ["bash","start.sh"] 20 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/button_builder.py: -------------------------------------------------------------------------------- 1 | from telegram import InlineKeyboardButton 2 | 3 | class ButtonMaker: 4 | def __init__(self): 5 | self.button = [] 6 | 7 | def buildbutton(self, key, link): 8 | self.button.append(InlineKeyboardButton(text = key, url = link)) 9 | 10 | def build_menu(self, n_cols, footer_buttons=None, header_buttons=None): 11 | menu = [self.button[i:i + n_cols] for i in range(0, len(self.button), n_cols)] 12 | if header_buttons: 13 | menu.insert(0, header_buttons) 14 | if footer_buttons: 15 | menu.append(footer_buttons) 16 | return menu 17 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/bot_utils.py: -------------------------------------------------------------------------------- 1 | def get_readable_time(seconds: int) -> str: 2 | result = '' 3 | (days, remainder) = divmod(seconds, 86400) 4 | days = int(days) 5 | if days != 0: 6 | result += f'{days}d' 7 | (hours, remainder) = divmod(remainder, 3600) 8 | hours = int(hours) 9 | if hours != 0: 10 | result += f'{hours}h' 11 | (minutes, seconds) = divmod(remainder, 60) 12 | minutes = int(minutes) 13 | if minutes != 0: 14 | result += f'{minutes}m' 15 | seconds = int(seconds) 16 | result += f'{seconds}s' 17 | return result -------------------------------------------------------------------------------- /bot/helper/telegram_helper/filters.py: -------------------------------------------------------------------------------- 1 | from telegram.ext import MessageFilter 2 | from telegram import Message 3 | from bot import AUTHORIZED_CHATS, OWNER_ID 4 | 5 | class CustomFilters: 6 | class _OwnerFilter(MessageFilter): 7 | def filter(self, message): 8 | return bool(message.from_user.id == OWNER_ID) 9 | 10 | owner_filter = _OwnerFilter() 11 | 12 | class _AuthorizedUserFilter(MessageFilter): 13 | def filter(self, message): 14 | id = message.from_user.id 15 | return bool(id in AUTHORIZED_CHATS or id == OWNER_ID) 16 | 17 | authorized_user = _AuthorizedUserFilter() 18 | 19 | class _AuthorizedChat(MessageFilter): 20 | def filter(self, message): 21 | return bool(message.chat.id in AUTHORIZED_CHATS) 22 | 23 | authorized_chat = _AuthorizedChat() 24 | -------------------------------------------------------------------------------- /generate_drive_token.py: -------------------------------------------------------------------------------- 1 | import pickle 2 | import os 3 | from google_auth_oauthlib.flow import InstalledAppFlow 4 | from google.auth.transport.requests import Request 5 | 6 | credentials = None 7 | __G_DRIVE_TOKEN_FILE = "token.pickle" 8 | __OAUTH_SCOPE = ["https://www.googleapis.com/auth/drive"] 9 | if os.path.exists(__G_DRIVE_TOKEN_FILE): 10 | with open(__G_DRIVE_TOKEN_FILE, 'rb') as f: 11 | credentials = pickle.load(f) 12 | if ( 13 | (credentials is None or not credentials.valid) 14 | and credentials 15 | and credentials.expired 16 | and credentials.refresh_token 17 | ): 18 | credentials.refresh(Request()) 19 | else: 20 | flow = InstalledAppFlow.from_client_secrets_file( 21 | 'credentials.json', __OAUTH_SCOPE) 22 | credentials = flow.run_console(port=0) 23 | 24 | # Save the credentials for the next run 25 | with open(__G_DRIVE_TOKEN_FILE, 'wb') as token: 26 | pickle.dump(credentials, token) -------------------------------------------------------------------------------- /bot/modules/list.py: -------------------------------------------------------------------------------- 1 | from telegram.ext import CommandHandler 2 | from bot.helper.drive_utils.gdriveTools import GoogleDriveHelper 3 | from bot import LOGGER, dispatcher 4 | from bot.helper.telegram_helper.message_utils import sendMessage, editMessage 5 | from bot.helper.telegram_helper.filters import CustomFilters 6 | from bot.helper.telegram_helper.bot_commands import BotCommands 7 | 8 | def list_drive(update,context): 9 | try: 10 | search = update.message.text.split(' ',maxsplit=1)[1] 11 | if "'"in search: 12 | search = search.replace("'", "\\'") 13 | except IndexError: 14 | sendMessage('send a search key along with command', context.bot, update) 15 | return 16 | 17 | reply = sendMessage('Searching...', context.bot, update) 18 | 19 | LOGGER.info(f"Searching: {search}") 20 | 21 | gdrive = GoogleDriveHelper(None) 22 | msg, button = gdrive.drive_list(search) 23 | 24 | editMessage(msg,reply,button) 25 | 26 | 27 | list_handler = CommandHandler(BotCommands.ListCommand, list_drive,filters=CustomFilters.authorized_chat | CustomFilters.authorized_user, run_async=True) 28 | dispatcher.add_handler(list_handler) 29 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/message_utils.py: -------------------------------------------------------------------------------- 1 | from telegram import InlineKeyboardMarkup 2 | from telegram.message import Message 3 | from telegram.update import Update 4 | import time 5 | from bot import LOGGER, bot 6 | from telegram.error import TimedOut, BadRequest 7 | from bot import bot 8 | from telegram import InlineKeyboardMarkup 9 | 10 | 11 | def sendMessage(text: str, bot, update: Update): 12 | try: 13 | return bot.send_message(update.message.chat_id, 14 | reply_to_message_id=update.message.message_id, 15 | text=text, parse_mode='HTMl') 16 | except Exception as e: 17 | LOGGER.error(str(e)) 18 | 19 | def sendMarkup(text: str, bot, update: Update, reply_markup: InlineKeyboardMarkup): 20 | return bot.send_message(update.message.chat_id, 21 | reply_to_message_id=update.message.message_id, 22 | text=text, reply_markup=reply_markup, allow_sending_without_reply=True, parse_mode='HTMl') 23 | 24 | 25 | def editMessage(text: str, message: Message, reply_markup=None): 26 | try: 27 | bot.edit_message_text(text=text, message_id=message.message_id, 28 | chat_id=message.chat.id,reply_markup=reply_markup, 29 | parse_mode='HTMl') 30 | except Exception as e: 31 | LOGGER.error(str(e)) 32 | 33 | def sendLogFile(bot, update: Update): 34 | with open('log.txt', 'rb') as f: 35 | bot.send_document(document=f, filename=f.name, 36 | reply_to_message_id=update.message.message_id, 37 | chat_id=update.message.chat_id) 38 | -------------------------------------------------------------------------------- /app.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Drive-X-Search-Bot", 3 | "description": "Telegram Bot Which Search Files From Our G-Drive", 4 | "logo": "https://telegra.ph/file/2360336321c95fc2ce7d4.png", 5 | "keywords": [ 6 | "telegram", 7 | "bot", 8 | "drive", 9 | "search", 10 | "python" 11 | ], 12 | "repository": "https://github.com/usmanmughalji/Drive-X-Search-Bot.git", 13 | "website": "https://github.com/usmanmughalji/Drive-X-Search-Bot/tree/master", 14 | "success_url": "https://github.com/usmanmughalji/Drive-X-Search-Bot/blob/master/README.md", 15 | "stack": "container", 16 | "env": { 17 | "AUTHORIZED_CHATS": { 18 | "description": "Fill User ID and Chat ID of you want to authorize, Seprate them with space.", 19 | "value": "", 20 | "required": false 21 | }, 22 | "BOT_TOKEN": { 23 | "description": "The telegram bot token that you get from @BotFather.", 24 | "value": "", 25 | "required": true 26 | }, 27 | "BOT_SOURCE_CODE": { 28 | "description": "Add your bot source code link here! or Leave It Blank", 29 | "value": "", 30 | "required": false 31 | }, 32 | "DRIVE_NAME": { 33 | "description": "Add Drive Folder Names, Seprate them with comma(,).", 34 | "value": "", 35 | "required": true 36 | }, 37 | "DRIVE_ID": { 38 | "description": "Add Gdrive Folder IDs, Seprate them with space.", 39 | "value": "", 40 | "required": true 41 | }, 42 | "INDEX_URL": { 43 | "description": "Add Index Links, Seprate them with space.", 44 | "value": "", 45 | "required": true 46 | }, 47 | "OWNER_ID": { 48 | "description": "The Telegram user ID (not username) of the owner of the bot.", 49 | "value": "", 50 | "required": true 51 | }, 52 | "TELEGRAPH_TOKEN": { 53 | "description": "Optional - Add your Telegraph Token.", 54 | "value": "", 55 | "required": false 56 | }, 57 | "TELEGRAPH_CHANGES": { 58 | "description": "Add any name here or your bot name for changes on telegraph page! or Leave It Blank", 59 | "value": "", 60 | "required": false 61 | } 62 | }, 63 | "addons": [ 64 | { 65 | "plan": "heroku-postgresql" 66 | } 67 | ], 68 | "formation": { 69 | "worker": { 70 | "quantity": 1, 71 | "size": "free" 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /bot/__main__.py: -------------------------------------------------------------------------------- 1 | import signal 2 | import time 3 | 4 | from telegram.ext import CommandHandler 5 | from bot import dispatcher, updater, botStartTime 6 | from bot.helper.telegram_helper.bot_commands import BotCommands 7 | from bot.helper.telegram_helper.message_utils import * 8 | from .helper.telegram_helper.filters import CustomFilters 9 | from .modules import authorize, list 10 | from telegram import InlineKeyboardMarkup 11 | from bot.helper.telegram_helper.bot_utils import get_readable_time 12 | from bot.helper.telegram_helper import button_builder 13 | 14 | def start(update, context): 15 | buttons = button_builder.ButtonMaker() 16 | buttons.buildbutton("Repo", "https://github.com/usmanmughalji/Drive-X-Search-Bot") 17 | reply_markup = InlineKeyboardMarkup(buttons.build_menu(1)) 18 | uptime = get_readable_time((time.time() - botStartTime)) 19 | LOGGER.info('UID: {} - UN: {} - MSG: {}'.format(update.message.chat.id,update.message.chat.username,update.message.text)) 20 | if CustomFilters.authorized_user(update) or CustomFilters.authorized_chat(update): 21 | if update.message.chat.type == "private": 22 | sendMessage(f"Hey I'm Alive 🙂 \n\nSince: {uptime} \n\nWelcome to Search-X Bot", context.bot, update) 23 | else: 24 | start_string = '\x1fThis Bot Can Search In All Of Your Google Drives!\x1f' 25 | 26 | sendMessage(start_string, context.bot, update) 27 | else: 28 | sendMarkup( 29 | 'Oops! not a Authorized user.\n\nPlease Deploy Your Own Drive-X-Search-Bot.', 30 | context.bot, 31 | update, 32 | reply_markup, 33 | ) 34 | 35 | botcmds = [ 36 | (f'{BotCommands.StartCommand}','Alive or Not'), 37 | (f'{BotCommands.ListCommand}','Searches files in Drive'), 38 | (f'{BotCommands.AuthorizedUsersCommand}','List of Authorize Users'), 39 | (f'{BotCommands.AuthorizeCommand}','To Auth User or Chat'), 40 | (f'{BotCommands.UnAuthorizeCommand}','To De-Auth User or Chat'), 41 | ] 42 | 43 | def log(update, context): 44 | sendLogFile(context.bot, update) 45 | 46 | def main(): 47 | bot.set_my_commands(botcmds) 48 | start_handler = CommandHandler(BotCommands.StartCommand, start, run_async=True) 49 | log_handler = CommandHandler(BotCommands.LogCommand, log, filters=CustomFilters.owner_filter, run_async=True) 50 | 51 | dispatcher.add_handler(start_handler) 52 | dispatcher.add_handler(log_handler) 53 | 54 | updater.start_polling(drop_pending_updates=True) 55 | LOGGER.info("Yeah I'm running!") 56 | signal.signal(signal.SIGINT, exit(1)) 57 | updater.idle() 58 | 59 | main() 60 | -------------------------------------------------------------------------------- /bot/modules/authorize.py: -------------------------------------------------------------------------------- 1 | from bot.helper.telegram_helper.message_utils import sendMessage 2 | from bot import AUTHORIZED_CHATS, dispatcher 3 | from telegram.ext import CommandHandler 4 | from bot.helper.telegram_helper.filters import CustomFilters 5 | from telegram import Update 6 | from bot.helper.telegram_helper.bot_commands import BotCommands 7 | 8 | def authorize(update,context): 9 | reply_message = update.message.reply_to_message 10 | message_ = update.message.text.split(' ') 11 | msg = '' 12 | with open('authorized_chats.txt', 'a') as file: 13 | if len(message_) == 2: 14 | chat_id = int(message_[1]) 15 | if chat_id not in AUTHORIZED_CHATS: 16 | file.write(f'{chat_id}\n') 17 | AUTHORIZED_CHATS.add(chat_id) 18 | msg = 'Chat authorized' 19 | else: 20 | msg = 'User already authorized' 21 | elif reply_message is None: 22 | # Trying to authorize a chat 23 | chat_id = update.effective_chat.id 24 | if chat_id not in AUTHORIZED_CHATS: 25 | file.write(f'{chat_id}\n') 26 | AUTHORIZED_CHATS.add(chat_id) 27 | msg = 'Chat authorized' 28 | else: 29 | msg = 'Already authorized chat' 30 | else: 31 | # Trying to authorize someone in specific 32 | user_id = reply_message.from_user.id 33 | if user_id not in AUTHORIZED_CHATS: 34 | file.write(f'{user_id}\n') 35 | AUTHORIZED_CHATS.add(user_id) 36 | msg = 'Person Authorized to use the bot!' 37 | else: 38 | msg = 'Person already authorized' 39 | sendMessage(msg, context.bot, update) 40 | 41 | 42 | def unauthorize(update,context): 43 | reply_message = update.message.reply_to_message 44 | message_ = update.message.text.split(' ') 45 | if len(message_) == 2: 46 | chat_id = int(message_[1]) 47 | if chat_id in AUTHORIZED_CHATS: 48 | AUTHORIZED_CHATS.remove(chat_id) 49 | msg = 'Chat unauthorized' 50 | else: 51 | msg = 'User already unauthorized' 52 | elif reply_message is None: 53 | # Trying to unauthorize a chat 54 | chat_id = update.effective_chat.id 55 | if chat_id in AUTHORIZED_CHATS: 56 | AUTHORIZED_CHATS.remove(chat_id) 57 | msg = 'Chat unauthorized' 58 | else: 59 | msg = 'Already unauthorized chat' 60 | else: 61 | # Trying to authorize someone in specific 62 | user_id = reply_message.from_user.id 63 | if user_id in AUTHORIZED_CHATS: 64 | AUTHORIZED_CHATS.remove(user_id) 65 | msg = 'Person unauthorized to use the bot!' 66 | else: 67 | msg = 'Person already unauthorized!' 68 | with open('authorized_chats.txt', 'a') as file: 69 | file.truncate(0) 70 | for i in AUTHORIZED_CHATS: 71 | file.write(f'{i}\n') 72 | sendMessage(msg, context.bot, update) 73 | 74 | 75 | def sendAuthChats(update,context): 76 | users = ''.join(f"{user}\n" for user in AUTHORIZED_CHATS) 77 | users = users if users != '' else "None" 78 | sendMessage(f'Authorized Chats are : \n{users}\n', context.bot, update) 79 | 80 | 81 | send_auth_handler = CommandHandler(command=BotCommands.AuthorizedUsersCommand, callback=sendAuthChats, 82 | filters=CustomFilters.owner_filter, run_async=True) 83 | authorize_handler = CommandHandler(command=BotCommands.AuthorizeCommand, callback=authorize, 84 | filters=CustomFilters.owner_filter, run_async=True) 85 | unauthorize_handler = CommandHandler(command=BotCommands.UnAuthorizeCommand, callback=unauthorize, 86 | filters=CustomFilters.owner_filter, run_async=True) 87 | 88 | dispatcher.add_handler(send_auth_handler) 89 | dispatcher.add_handler(authorize_handler) 90 | dispatcher.add_handler(unauthorize_handler) 91 | 92 | 93 | -------------------------------------------------------------------------------- /bot/__init__.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import time 4 | import random 5 | import string 6 | from dotenv import load_dotenv 7 | 8 | import telegram.ext as tg 9 | from telegraph import Telegraph 10 | 11 | import psycopg2 12 | from psycopg2 import Error 13 | 14 | botStartTime = time.time() 15 | if os.path.exists('log.txt'): 16 | with open('log.txt', 'r+') as f: 17 | f.truncate(0) 18 | 19 | logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', 20 | handlers=[logging.FileHandler('log.txt'), logging.StreamHandler()], 21 | level=logging.INFO) 22 | 23 | load_dotenv('config.env') 24 | 25 | def getConfig(name: str): 26 | return os.environ[name] 27 | 28 | def mktable(): 29 | try: 30 | conn = psycopg2.connect(DB_URI) 31 | cur = conn.cursor() 32 | sql = "CREATE TABLE users (uid bigint, sudo boolean DEFAULT FALSE);" 33 | cur.execute(sql) 34 | conn.commit() 35 | LOGGER.info("Table Created!") 36 | except Error as e: 37 | LOGGER.error(e) 38 | exit(1) 39 | 40 | LOGGER = logging.getLogger(__name__) 41 | 42 | BOT_TOKEN = None 43 | 44 | # Stores list of users and chats the bot is authorized to use in 45 | AUTHORIZED_CHATS = set() 46 | if os.path.exists('authorized_chats.txt'): 47 | with open('authorized_chats.txt', 'r+') as f: 48 | lines = f.readlines() 49 | for line in lines: 50 | AUTHORIZED_CHATS.add(int(line.split()[0])) 51 | try: 52 | achats = getConfig('AUTHORIZED_CHATS') 53 | achats = achats.split(" ") 54 | for chats in achats: 55 | AUTHORIZED_CHATS.add(int(chats)) 56 | except: 57 | pass 58 | 59 | try: 60 | BOT_TOKEN = getConfig('BOT_TOKEN') 61 | OWNER_ID = int(getConfig('OWNER_ID')) 62 | except KeyError as e: 63 | LOGGER.error("One or more env variables missing! Exiting now") 64 | exit(1) 65 | 66 | try: 67 | DB_URI = getConfig('DATABASE_URL') 68 | if len(DB_URI) == 0: 69 | raise KeyError 70 | except KeyError: 71 | logging.warning('Database not provided!') 72 | DB_URI = None 73 | if DB_URI is not None: 74 | try: 75 | conn = psycopg2.connect(DB_URI) 76 | cur = conn.cursor() 77 | sql = "SELECT * from users;" 78 | cur.execute(sql) 79 | rows = cur.fetchall() #returns a list ==> (uid, sudo) 80 | for row in rows: 81 | AUTHORIZED_CHATS.add(row[0]) 82 | except Error as e: 83 | if 'relation "users" does not exist' in str(e): 84 | mktable() 85 | else: 86 | LOGGER.error(e) 87 | exit(1) 88 | finally: 89 | cur.close() 90 | conn.close() 91 | 92 | try: 93 | TELEGRAPH_TOKEN = getConfig('TELEGRAPH_TOKEN') 94 | if len(TELEGRAPH_TOKEN) == 0: 95 | sname = ''.join(random.SystemRandom().choices(string.ascii_letters, k=8)) 96 | LOGGER.info("Generating TELEGRAPH_TOKEN using '" + sname + "' name") 97 | telegraph = Telegraph() 98 | telegraph.create_account(short_name=sname) 99 | telegraph_token = telegraph.get_access_token() 100 | else: 101 | LOGGER.info("Loaded TELEGRAPH_TOKEN") 102 | telegraph_token = getConfig('TELEGRAPH_TOKEN') 103 | except KeyError: 104 | LOGGER.error("Required TELEGRAPH_TOKEN") 105 | 106 | try: 107 | TELEGRAPH_CHANGES = getConfig('TELEGRAPH_CHANGES') 108 | if len(TELEGRAPH_CHANGES) == 0: 109 | TELEGRAPH_CHANGES = 'Drive-X' 110 | except KeyError: 111 | TELEGRAPH_CHANGES = 'Drive-X' 112 | 113 | try: 114 | BOT_SOURCE_CODE = getConfig('BOT_SOURCE_CODE') 115 | if len(BOT_SOURCE_CODE) == 0: 116 | BOT_SOURCE_CODE = 'https://github.com/usmanmughalji/Drive-X-Search-Bot' 117 | except KeyError: 118 | BOT_SOURCE_CODE = 'https://github.com/usmanmughalji/Drive-X-Search-Bot' 119 | 120 | for envs in ["DRIVE_NAME", "DRIVE_ID", "INDEX_URL"]: 121 | try: 122 | value = os.environ[envs] 123 | if not value: 124 | raise KeyError 125 | except KeyError: 126 | print(f"Please Fill Following Var In The config.env \n\n{envs}") 127 | exit(1) 128 | 129 | DRIVE_NAME = list(set(getConfig('DRIVE_NAME').split(","))) 130 | DRIVE_ID = list(set(getConfig('DRIVE_ID').split())) 131 | INDEX_URL = list(set(getConfig('INDEX_URL').split())) 132 | 133 | updater = tg.Updater(token=BOT_TOKEN) 134 | bot = updater.bot 135 | dispatcher = updater.dispatcher 136 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Deploy Here! 2 |

3 | 4 | # What is this repo about? 5 | This is a telegram bot written in python for searching files in Drive. 6 | 7 | # How to deploy? 8 | Deploying is pretty much straight forward and is divided into several steps as follows: 9 | ## Installing requirements 10 | 11 | - Clone this repo: 12 | ``` 13 | git clone https://github.com/usmanmughalji/Drive-X-Search-Bot.git search-bot 14 | cd search-bot 15 | ``` 16 | 17 | - Install requirements 18 | For Debian based distros 19 | ``` 20 | sudo apt install python3 21 | ``` 22 | Install Docker by following the [official Docker docs](https://docs.docker.com/engine/install/debian/), or: 23 | ``` 24 | sudo snap install docker 25 | ``` 26 | - For Arch and it's derivatives: 27 | ``` 28 | sudo pacman -S docker python 29 | ``` 30 | - Install dependencies for running setup scripts: 31 | ``` 32 | pip3 install -r requirements.txt 33 | ``` 34 | ## Generate Database 35 |
36 | Click Here For More Details 37 | 38 | - Go to https://elephantsql.com/ and create account (skip this if you already have ElephantSQL account) 39 | - Hit **Create New Instance** 40 | - Follow the further instructions in the screen 41 | - Hit **Select Region** 42 | - Hit **Review** 43 | - Hit **Create instance** 44 | - Select your database name 45 | - Copy your database url, and fill to `DATABASE_URL` in config 46 |
47 | 48 | ## Setting up config file 49 |
50 | Click Here For More Details 51 | 52 | ``` 53 | cp config_sample.env config.env 54 | ``` 55 | Fill up rest of the fields. Meaning of each fields are discussed below: 56 | 57 | ### Required Field 58 | 59 | - `BOT_TOKEN` : The telegram bot token that you get from @BotFather 60 | - `OWNER_ID` : The Telegram user ID (not username) of the owner of the bot 61 | - `DRIVE_NAME` : Add your `DRIVE_NAME` as follow, Seprate them with comma 62 | 63 | ``` 64 | Drive1,Drive2 65 | ``` 66 | 67 | - `DRIVE_ID` : Add your `DRIVE_ID` as follow, Seprate them with space 68 | 69 | ``` 70 | AE0IwdpTBX_UkhiVAP9 115YTRH84YTr1gBz190saB7UJ1djasj9J 71 | ``` 72 | 73 | - `INDEX_URL` : Add your `INDEX_URL` as follow, Seprate them with space 74 | 75 | ``` 76 | https://demo.indexurl.workers.dev/0: https://demo.indexurl.workers.dev/0:/files 77 | ``` 78 | 79 | ### Optional Field 80 | 81 | - `TELEGRAPH_TOKEN` : Adding `TELEGRAPH_TOKEN` is compelety optional 82 | 83 | - `AUTHORIZED_CHATS` : Fill user_id and chat_id (not username) of you want to authorize, Seprate them with space Examples: `-0123456789 -1122334455 6915401739` 84 | 85 | - `DATABASE_URL` : Default `DATABASE_URL` from heroku will set itself or You can create Database URL. See [Generate Database](https://github.com/usmanmughalji/Drive-X-Search-Bot#generate-database) (**NOTE**: If you use database you can save your auth id permanent using `/auth` command) 86 | 87 | - `BOT_SOURCE_CODE` : Add your bot source code link here or any link you want to add here. 88 | 89 | - `TELEGRAPH_CHANGES` : Add any name here or your bot name. 90 | 91 |
92 | 93 | ## Getting Google OAuth API credential file 94 | 95 | - Visit the [Google Cloud Console](https://console.developers.google.com/apis/credentials) 96 | - Go to the OAuth Consent tab, fill it, and save. 97 | - Go to the Credentials tab and click Create Credentials -> OAuth Client ID 98 | - Choose Desktop and Create. 99 | - Use the download button to download your credentials. 100 | - Move that file to the root of search-bot, and rename it to credentials.json 101 | - Visit [Google API page](https://console.developers.google.com/apis/library) 102 | - Search for Drive and enable it if it is disabled 103 | - Finally, run the script to generate token file (token.pickle) for Google Drive: 104 | ``` 105 | pip3 install google-api-python-client google-auth-httplib2 google-auth-oauthlib 106 | python3 generate_drive_token.py 107 | ``` 108 | ## Deploying on Server 109 | - Start docker daemon (skip if already running): 110 | ``` 111 | sudo dockerd 112 | ``` 113 | - Build Docker image: 114 | ``` 115 | sudo docker build . -t search-bot 116 | ``` 117 | - Run the image: 118 | ``` 119 | sudo docker run search-bot 120 | ``` 121 | ## Credits: 122 | 123 | - SearchX-bot - [`SVR666`](https://github.com/SVR666/SearchX-bot) 124 | - python-aria-mirror-bot - [`lzzy12`](https://github.com/lzzy12/python-aria-mirror-bot) 125 | - magneto-python-aria - [`magneto261290`](https://github.com/magneto261290/magneto-python-aria) 126 | - slam-mirrorbot - [`SlamDevs`](https://github.com/SlamDevs/slam-mirrorbot) 127 | - Gautam Kumar - [`gautamajay52`](https://github.com/gautamajay52) 128 | - Abir Hasan - [`AbirHasan2005`](https://github.com/AbirHasan2005) 129 | -------------------------------------------------------------------------------- /bot/helper/drive_utils/gdriveTools.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pickle 3 | 4 | import requests 5 | import logging 6 | 7 | from telegraph import Telegraph 8 | from google.auth.transport.requests import Request 9 | from google_auth_oauthlib.flow import InstalledAppFlow 10 | from googleapiclient.discovery import build 11 | from googleapiclient.errors import HttpError 12 | 13 | from telegram import InlineKeyboardMarkup 14 | from bot.helper.telegram_helper import button_builder 15 | from bot import DRIVE_NAME, DRIVE_ID, INDEX_URL, telegraph_token, TELEGRAPH_CHANGES, BOT_SOURCE_CODE 16 | 17 | LOGGER = logging.getLogger(__name__) 18 | logging.getLogger('googleapiclient.discovery').setLevel(logging.ERROR) 19 | 20 | SIZE_UNITS = ['B', 'KB', 'MB', 'GB', 'TB', 'PB'] 21 | TELEGRAPHLIMIT = 95 22 | 23 | class GoogleDriveHelper: 24 | def __init__(self, name=None, listener=None): 25 | self.__G_DRIVE_TOKEN_FILE = "token.pickle" 26 | # Check https://developers.google.com/drive/scopes for all available scopes 27 | self.__OAUTH_SCOPE = ['https://www.googleapis.com/auth/drive'] 28 | self.__service = self.authorize() 29 | self.telegraph_content = [] 30 | self.path = [] 31 | 32 | def get_readable_file_size(self,size_in_bytes) -> str: 33 | if size_in_bytes is None: 34 | return '0B' 35 | index = 0 36 | size_in_bytes = int(size_in_bytes) 37 | while size_in_bytes >= 1024: 38 | size_in_bytes /= 1024 39 | index += 1 40 | try: 41 | return f'{round(size_in_bytes, 2)}{SIZE_UNITS[index]}' 42 | except IndexError: 43 | return 'File too large' 44 | 45 | def authorize(self): 46 | # Get credentials 47 | credentials = None 48 | if os.path.exists(self.__G_DRIVE_TOKEN_FILE): 49 | with open(self.__G_DRIVE_TOKEN_FILE, 'rb') as f: 50 | credentials = pickle.load(f) 51 | if credentials is None or not credentials.valid: 52 | if credentials and credentials.expired and credentials.refresh_token: 53 | credentials.refresh(Request()) 54 | else: 55 | flow = InstalledAppFlow.from_client_secrets_file( 56 | 'credentials.json', self.__OAUTH_SCOPE) 57 | LOGGER.info(flow) 58 | credentials = flow.run_console(port=0) 59 | 60 | # Save the credentials for the next run 61 | with open(self.__G_DRIVE_TOKEN_FILE, 'wb') as token: 62 | pickle.dump(credentials, token) 63 | return build('drive', 'v3', credentials=credentials, cache_discovery=False) 64 | 65 | def escapes(self, str): 66 | chars = ['\\', "'", '"', r'\a', r'\b', r'\f', r'\n', r'\r', r'\t'] 67 | for char in chars: 68 | str = str.replace(char, '\\'+char) 69 | return str 70 | 71 | def drive_query(self, parent_id, fileName): 72 | fileName = self.escapes(str(fileName)) 73 | gquery = " and ".join(f"name contains '{x}'" for x in fileName.split()) 74 | query = f"'{parent_id}' in parents and ({gquery})" 75 | return ( 76 | self.__service.files() 77 | .list( 78 | supportsTeamDrives=True, 79 | includeTeamDriveItems=True, 80 | q=query, 81 | spaces='drive', 82 | pageSize=200, 83 | fields='files(id, name, mimeType, size)', 84 | orderBy='modifiedTime desc', 85 | ) 86 | .execute()["files"] 87 | ) 88 | 89 | 90 | def edit_telegraph(self): 91 | nxt_page = 1 92 | prev_page = 0 93 | for content in self.telegraph_content : 94 | if nxt_page == 1 : 95 | content += f'Next' 96 | nxt_page += 1 97 | else : 98 | if prev_page <= self.num_of_path: 99 | content += f'Prev' 100 | prev_page += 1 101 | if nxt_page < self.num_of_path: 102 | content += f' | Next' 103 | nxt_page += 1 104 | Telegraph(access_token=telegraph_token).edit_page(path = self.path[prev_page], 105 | title = TELEGRAPH_CHANGES + ' ' + 'Bot', 106 | author_name=TELEGRAPH_CHANGES + ' ' + 'Search Bot', 107 | author_url=BOT_SOURCE_CODE, 108 | html_content=content) 109 | return 110 | 111 | 112 | def drive_list(self, fileName): 113 | fileName = self.escapes(str(fileName)) 114 | msg = '' 115 | content_count = 0 116 | add_title_msg = True 117 | for INDEX, parent_id in enumerate(DRIVE_ID): 118 | response = self.drive_query(parent_id, fileName) 119 | if response: 120 | if add_title_msg: 121 | msg = f'

Search Results for : {fileName}

' 122 | add_title_msg = False 123 | msg += f"————————————
{DRIVE_NAME[INDEX]}
————————————
" 124 | for file in response: 125 | if file.get('mimeType') == "application/vnd.google-apps.folder": # Detect Whether Current Entity is a Folder or File. 126 | furl = f"https://drive.google.com/drive/folders/{file.get('id')}" 127 | msg += f"📁 {file.get('name')}
(folder)
" 128 | msg += f"Drive Link" 129 | if INDEX_URL[INDEX] is not None: 130 | url_path = requests.utils.quote(f'{file.get("name")}') 131 | url = f'{INDEX_URL[INDEX]}/{url_path}/' 132 | msg += f' | Index Link' 133 | elif file.get('mimeType') == 'application/vnd.google-apps.shortcut': 134 | msg += f"⁍{file.get('name')}" \ 135 | f" (shortcut)" 136 | # Excluded index link as indexes cant download or open these shortcuts 137 | else: 138 | furl = f"https://drive.google.com/uc?id={file.get('id')}&export=download" 139 | msg += f"📄 {file.get('name')}
({self.get_readable_file_size(file.get('size'))})
" \ 140 | f"Drive Link" 141 | if INDEX_URL[INDEX] is not None: 142 | url_path = requests.utils.quote(f'{file.get("name")}') 143 | url = f'{INDEX_URL[INDEX]}/{url_path}' 144 | msg += f' | Index Link' 145 | msg += '

' 146 | content_count += 1 147 | if content_count == TELEGRAPHLIMIT : 148 | self.telegraph_content.append(msg) 149 | msg = "" 150 | 151 | if msg != '': 152 | self.telegraph_content.append(msg) 153 | 154 | if len(self.telegraph_content) == 0: 155 | return "No Result Found ❌", None 156 | 157 | for content in self.telegraph_content : 158 | self.path.append(Telegraph(access_token=telegraph_token).create_page( 159 | title = TELEGRAPH_CHANGES + ' ' + 'Bot', 160 | author_name=TELEGRAPH_CHANGES + ' ' + 'Search Bot', 161 | author_url=BOT_SOURCE_CODE, 162 | html_content=content )['path']) 163 | 164 | self.num_of_path = len(self.path) 165 | if self.num_of_path > 1: 166 | self.edit_telegraph() 167 | 168 | msg = f"Found {content_count} results for {fileName}" 169 | buttons = button_builder.ButtonMaker() 170 | buttons.buildbutton("🔎 VIEW", f"https://telegra.ph/{self.path[0]}") 171 | 172 | return msg, InlineKeyboardMarkup(buttons.build_menu(1)) 173 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------