├── drive_folder ├── bot ├── helper │ ├── __init__.py │ ├── drive_utils │ │ ├── __init__.py │ │ └── gdriveTools.py │ └── telegram_helper │ │ ├── __init__.py │ │ ├── bot_commands.py │ │ ├── button_builder.py │ │ ├── filters.py │ │ └── message_utils.py ├── modules │ ├── __init__.py │ ├── list.py │ └── authorize.py ├── __main__.py └── __init__.py ├── heroku.yml ├── captain-definition ├── start.sh ├── .gitignore ├── requirements.txt ├── Dockerfile ├── telegraph_token.py ├── config_sample.env ├── generate_drive_token.py ├── app.json ├── driveid.py ├── .github └── workflows │ └── codeql-analysis.yml ├── README.md └── LICENSE /drive_folder: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/helper/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/modules/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/helper/drive_utils/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /heroku.yml: -------------------------------------------------------------------------------- 1 | build: 2 | docker: 3 | worker: Dockerfile 4 | -------------------------------------------------------------------------------- /captain-definition: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 2, 3 | "dockerfilePath": "./Dockerfile" 4 | } 5 | -------------------------------------------------------------------------------- /start.sh: -------------------------------------------------------------------------------- 1 | wget $CRED_URL -O credentials.json && wget $TOKEN_URL -O token.pickle && wget $DRIVE_FILE -O drive_folder && python3 -m bot 2 | -------------------------------------------------------------------------------- /.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 | python-telegram-bot==12.6.1 3 | google-api-python-client>=1.7.11,<1.7.20 4 | google-auth-httplib2>=0.0.3,<0.1.0 5 | google-auth-oauthlib>=0.4.1,<0.10.0 6 | python-dotenv>=0.10 7 | telegraph -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ghcr.io/devilld/py-dev 2 | 3 | WORKDIR /BOT 4 | 5 | RUN chmod -R 777 /BOT 6 | 7 | COPY requirements.txt . 8 | RUN pip3 install --no-cache-dir -r requirements.txt 9 | 10 | COPY . . 11 | 12 | CMD ["bash","start.sh"] 13 | -------------------------------------------------------------------------------- /telegraph_token.py: -------------------------------------------------------------------------------- 1 | from telegraph import Telegraph 2 | 3 | telegraph = Telegraph() 4 | telegraph.create_account(short_name=input("Enter a username for your Telegra.ph : ")) 5 | 6 | print(f"Your Telegra.ph token ==> {telegraph.get_access_token()}") -------------------------------------------------------------------------------- /config_sample.env: -------------------------------------------------------------------------------- 1 | #Remove this line before deploying 2 | _____REMOVE_THIS_LINE_____=True 3 | 4 | # ENTER BOT TOKEN (Get your BOT_TOKEN by talking to @botfather) 5 | BOT_TOKEN = "" 6 | OWNER_ID = 7 | TELEGRAPH_TOKEN = "420dffda0cc030ce6eb582c7287e179f166e8c69ebecfd63238b543763d0" # You can change it by your own 8 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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/filters.py: -------------------------------------------------------------------------------- 1 | from telegram.ext import BaseFilter 2 | from telegram import Message 3 | from bot import AUTHORIZED_CHATS, OWNER_ID 4 | 5 | class CustomFilters: 6 | class _OwnerFilter(BaseFilter): 7 | def filter(self, message): 8 | return bool(message.from_user.id == OWNER_ID) 9 | 10 | owner_filter = _OwnerFilter() 11 | 12 | class _AuthorizedUserFilter(BaseFilter): 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(BaseFilter): 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 credentials is None or not credentials.valid: 13 | if credentials and credentials.expired and credentials.refresh_token: 14 | credentials.refresh(Request()) 15 | else: 16 | flow = InstalledAppFlow.from_client_secrets_file( 17 | 'credentials.json', __OAUTH_SCOPE) 18 | credentials = flow.run_console(port=0) 19 | 20 | # Save the credentials for the next run 21 | with open(__G_DRIVE_TOKEN_FILE, 'wb') as token: 22 | pickle.dump(credentials, token) -------------------------------------------------------------------------------- /bot/modules/list.py: -------------------------------------------------------------------------------- 1 | from telegram.ext import CommandHandler, run_async 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 | @run_async 9 | def list_drive(update,context): 10 | try: 11 | search = update.message.text.split(' ',maxsplit=1)[1] 12 | except IndexError: 13 | sendMessage('send a search key along with command', context.bot, update) 14 | return 15 | 16 | reply = sendMessage('Searching...', context.bot, update) 17 | 18 | LOGGER.info(f"Searching: {search}") 19 | 20 | gdrive = GoogleDriveHelper(None) 21 | msg, button = gdrive.drive_list(search) 22 | 23 | editMessage(msg,reply,button) 24 | 25 | 26 | list_handler = CommandHandler(BotCommands.ListCommand, list_drive,filters=CustomFilters.authorized_chat | CustomFilters.authorized_user) 27 | dispatcher.add_handler(list_handler) 28 | -------------------------------------------------------------------------------- /bot/helper/telegram_helper/message_utils.py: -------------------------------------------------------------------------------- 1 | from telegram.message import Message 2 | from telegram.update import Update 3 | import time 4 | from bot import LOGGER, bot 5 | from telegram.error import TimedOut, BadRequest 6 | from bot import bot 7 | from telegram import InlineKeyboardMarkup 8 | 9 | 10 | def sendMessage(text: str, bot, update: Update): 11 | try: 12 | return bot.send_message(update.message.chat_id, 13 | reply_to_message_id=update.message.message_id, 14 | text=text, parse_mode='HTMl') 15 | except Exception as e: 16 | LOGGER.error(str(e)) 17 | 18 | def editMessage(text: str, message: Message, reply_markup=None): 19 | try: 20 | bot.edit_message_text(text=text, message_id=message.message_id, 21 | chat_id=message.chat.id,reply_markup=reply_markup, 22 | parse_mode='HTMl') 23 | except Exception as e: 24 | LOGGER.error(str(e)) 25 | 26 | def sendLogFile(bot, update: Update): 27 | with open('log.txt', 'rb') as f: 28 | bot.send_document(document=f, filename=f.name, 29 | reply_to_message_id=update.message.message_id, 30 | chat_id=update.message.chat_id) 31 | -------------------------------------------------------------------------------- /app.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Drive Search Bot", 3 | "description": "Search file inside the google drive", 4 | "logo": "https://i.ibb.co/m6V57dy/ds.jpg", 5 | "keywords": [ 6 | "telegram", 7 | "bot", 8 | "aria", 9 | "python" 10 | ], 11 | "repository": "https://github.com/devillD/Drive-Search-Bot.git", 12 | "website": "https://github.com/devillD/Drive-Search-Bot/tree/master", 13 | "success_url": "https://github.com/devillD/Drive-Search-Bot/tree/master/README.md", 14 | "stack": "container", 15 | "env": { 16 | "BOT_TOKEN": { 17 | "description": "The telegram bot token that you get from @BotFather.", 18 | "required": true 19 | }, 20 | "OWNER_ID": { 21 | "description": "The Telegram user ID (not username) of the owner of the bot.", 22 | "required": true 23 | }, 24 | "TELEGRAPH_TOKEN": { 25 | "description": "Generate using python3 generate_telegraph_token.py.", 26 | "required": true 27 | }, 28 | "CRED_URL": { 29 | "description": "Credentials.json file direct url", 30 | "required": true 31 | }, 32 | "TOKEN_URL": { 33 | "description": "token.pickle file direct url", 34 | "required": true 35 | }, 36 | "DRIVE_FILE": { 37 | "description": "drive_folder file direct url", 38 | "required": true 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /bot/__main__.py: -------------------------------------------------------------------------------- 1 | from telegram.ext import CommandHandler, run_async 2 | from bot import dispatcher, updater, botStartTime 3 | from bot.helper.telegram_helper.bot_commands import BotCommands 4 | from bot.helper.telegram_helper.message_utils import * 5 | from .helper.telegram_helper.filters import CustomFilters 6 | from .modules import authorize, list 7 | from telegram import ParseMode, BotCommand 8 | 9 | @run_async 10 | def start(update, context): 11 | LOGGER.info('UID: {} - UN: {} - MSG: {}'.format(update.message.chat.id,update.message.chat.username,update.message.text)) 12 | if update.message.chat.type == "private" : 13 | sendMessage(f"Hey {update.message.chat.first_name}. Welcome to LoaderX Bot", context.bot, update) 14 | else : 15 | sendMessage("Am alive :)", context.bot, update) 16 | 17 | @run_async 18 | def log(update, context): 19 | sendLogFile(context.bot, update) 20 | 21 | botcmnd = [ 22 | BotCommand(f'{BotCommands.ListCommand}', ' 🔎 Search on team drive✨'), 23 | BotCommand(f'{BotCommands.LogCommand}','📄 Get Logs [owner only]'), 24 | 25 | ] 26 | 27 | def main(): 28 | 29 | start_handler = CommandHandler(BotCommands.StartCommand, start, filters=CustomFilters.authorized_chat | CustomFilters.authorized_user) 30 | log_handler = CommandHandler(BotCommands.LogCommand, log, filters=CustomFilters.owner_filter) 31 | 32 | dispatcher.add_handler(start_handler) 33 | dispatcher.add_handler(log_handler) 34 | 35 | bot.set_my_commands(botcmnd) 36 | 37 | updater.start_polling() 38 | LOGGER.info("Yeah am running!") 39 | updater.idle() 40 | 41 | main() 42 | -------------------------------------------------------------------------------- /driveid.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | print("\n\n"\ 4 | " Bot is not able to search in subfolder so if you likes to search\n"\ 5 | " in a specific folder then u can add that folder id to search\n\n" 6 | " drive/folder NAME --> anything that u likes\n"\ 7 | " drive/folder ID --> drive id or folder id of folders in which u likes to search\n"\ 8 | " drive/folder INDEX URL --> enter index url. If its a folder then open your index site\n" \ 9 | " goto the respective folder and copy the url from address bar\n") 10 | msg = '' 11 | if os.path.exists('drive_folder'): 12 | with open('drive_folder', 'r+') as f: 13 | lines = f.read() 14 | if not re.match(r'^\s*$', lines): 15 | print(lines) 16 | print("\n\n"\ 17 | " DO YOU WISH TO KEEP THE ABOVE DETAILS THAT YOU PREVIOUSLY ADDED???? ENTER (y/n)\n"\ 18 | " IF NOTHING SHOWS ENTER n") 19 | while (1): 20 | choice = input() 21 | if choice == 'y' or choice == 'Y': 22 | msg = f'{lines}' 23 | break 24 | elif choice == 'n' or choice == 'N': 25 | break 26 | else: 27 | print("\n\n DO YOU WISH TO KEEP THE ABOVE DETAILS ???? y/n <=== this is option ..... OPEN YOUR EYES & READ...") 28 | num = int(input(" How Many Drive/Folder You Likes To Add : ")) 29 | count = 1 30 | while count <= num : 31 | print(f"\n > DRIVE/FOLDER - {count}\n") 32 | name = input(" Enter Drive/Folder NAME (anything) : ") 33 | id = input(" Enter Drive/Folder ID : ") 34 | index = input(" Enter Drive/Folder INDEX URL (optional) : ") 35 | if not name or not id: 36 | print("\n\n ERROR : Dont leave the name/id without filling.") 37 | exit(1) 38 | name=name.replace(" ", "_") 39 | if index: 40 | if index[-1] == "/": 41 | index = index[:-1] 42 | else: 43 | index = '' 44 | count+=1 45 | msg += f"{name} {id} {index}\n" 46 | with open('drive_folder', 'w') as file: 47 | file.truncate(0) 48 | file.write(msg) 49 | print("\n\n Done!") -------------------------------------------------------------------------------- /bot/__init__.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import time 4 | 5 | import telegram.ext as tg 6 | from dotenv import load_dotenv 7 | 8 | from telegraph import Telegraph 9 | 10 | botStartTime = time.time() 11 | if os.path.exists('log.txt'): 12 | with open('log.txt', 'r+') as f: 13 | f.truncate(0) 14 | 15 | logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', 16 | handlers=[logging.FileHandler('log.txt'), logging.StreamHandler()], 17 | level=logging.INFO) 18 | 19 | load_dotenv('config.env') 20 | 21 | def getConfig(name: str): 22 | return os.environ[name] 23 | 24 | LOGGER = logging.getLogger(__name__) 25 | 26 | try: 27 | if bool(getConfig('_____REMOVE_THIS_LINE_____')): 28 | logging.error('The README.md file there to be read! Exiting now!') 29 | exit() 30 | except KeyError: 31 | pass 32 | 33 | BOT_TOKEN = None 34 | 35 | AUTHORIZED_CHATS = set() 36 | 37 | AUTHORIZED_CHATS = set() 38 | if os.path.exists('authorized_chats.txt'): 39 | with open('authorized_chats.txt', 'r+') as f: 40 | lines = f.readlines() 41 | for line in lines: 42 | AUTHORIZED_CHATS.add(int(line.split()[0])) 43 | 44 | try: 45 | BOT_TOKEN = getConfig('BOT_TOKEN') 46 | OWNER_ID = int(getConfig('OWNER_ID')) 47 | telegraph_token = getConfig('TELEGRAPH_TOKEN') 48 | except KeyError as e: 49 | LOGGER.error("One or more env variables missing! Exiting now") 50 | exit(1) 51 | 52 | DRIVE_NAME = [] 53 | DRIVE_ID = [] 54 | INDEX_URL = [] 55 | 56 | if os.path.exists('drive_folder'): 57 | with open('drive_folder', 'r+') as f: 58 | lines = f.readlines() 59 | for line in lines: 60 | temp = line.strip().split() 61 | DRIVE_NAME.append(temp[0].replace("_", " ")) 62 | DRIVE_ID.append(temp[1]) 63 | try: 64 | INDEX_URL.append(temp[2]) 65 | except IndexError as e: 66 | INDEX_URL.append(None) 67 | 68 | if DRIVE_ID : 69 | pass 70 | else : 71 | LOGGER.error("The README.md file there to be read! Exiting now!") 72 | exit(1) 73 | 74 | telegra_ph = Telegraph(access_token=telegraph_token) 75 | 76 | updater = tg.Updater(token=BOT_TOKEN,use_context=True) 77 | bot = updater.bot 78 | dispatcher = updater.dispatcher 79 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | # 7 | # ******** NOTE ******** 8 | # We have attempted to detect the languages in your repository. Please check 9 | # the `language` matrix defined below to confirm you have the correct set of 10 | # supported CodeQL languages. 11 | # 12 | name: "CodeQL" 13 | 14 | on: 15 | push: 16 | branches: [ master ] 17 | pull_request: 18 | # The branches below must be a subset of the branches above 19 | branches: [ master ] 20 | schedule: 21 | - cron: '21 16 * * 2' 22 | 23 | jobs: 24 | analyze: 25 | name: Analyze 26 | runs-on: ubuntu-latest 27 | permissions: 28 | actions: read 29 | contents: read 30 | security-events: write 31 | 32 | strategy: 33 | fail-fast: false 34 | matrix: 35 | language: [ 'python' ] 36 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] 37 | # Learn more about CodeQL language support at https://git.io/codeql-language-support 38 | 39 | steps: 40 | - name: Checkout repository 41 | uses: actions/checkout@v2 42 | 43 | # Initializes the CodeQL tools for scanning. 44 | - name: Initialize CodeQL 45 | uses: github/codeql-action/init@v1 46 | with: 47 | languages: ${{ matrix.language }} 48 | # If you wish to specify custom queries, you can do so here or in a config file. 49 | # By default, queries listed here will override any specified in a config file. 50 | # Prefix the list here with "+" to use these queries and those in the config file. 51 | # queries: ./path/to/local/query, your-org/your-repo/queries@main 52 | 53 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 54 | # If this step fails, then you should remove it and run the build manually (see below) 55 | - name: Autobuild 56 | uses: github/codeql-action/autobuild@v1 57 | 58 | # ℹ️ Command-line programs to run using the OS shell. 59 | # 📚 https://git.io/JvXDl 60 | 61 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 62 | # and modify them (or add more) to build your code if your project 63 | # uses a compiled language 64 | 65 | #- run: | 66 | # make bootstrap 67 | # make release 68 | 69 | - name: Perform CodeQL Analysis 70 | uses: github/codeql-action/analyze@v1 71 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Deploying on Heroku 2 | ### Auto 3 | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/devillD/Drive-Search-Bot.git) 4 | 5 | # What is this repo about? 6 | This is a telegram bot writen in python for searching files in Drive. 7 | 8 | # How to deploy? 9 | 10 | - Clone this repo: 11 | ``` 12 | git clone https://github.com/svr666/search-bot search-bot/ 13 | cd search-bot 14 | ``` 15 | 16 | ### Install requirements 17 | 18 | - For Debian based distros 19 | ``` 20 | sudo apt install python3 21 | sudo snap install docker 22 | ``` 23 | - For Arch and it's derivatives: 24 | ``` 25 | sudo pacman -S docker python 26 | ``` 27 | 28 | ## Setting up config file 29 | ``` 30 | cp config_sample.env config.env 31 | ``` 32 | - Remove the first line saying: 33 | ``` 34 | _____REMOVE_THIS_LINE_____=True 35 | ``` 36 | Fill up rest of the fields. Meaning of each fields are discussed below: 37 | - **BOT_TOKEN** : The telegram bot token that you get from @BotFather 38 | - **OWNER_ID** : The Telegram user ID (not username) of the owner of the bot 39 | - **TELEGRAPH_TOKEN** : The token generated by running: 40 | ``` 41 | python3 telegraph_token.py 42 | ``` 43 | 44 | ## Setting up drive_folder file 45 | 46 | - The bot is unable to search in sub-directories, but you can specify directories in which you wanna search. 47 | - Add drive/folder name(anything that u likes), drive id/folder id & index url(optional) corresponding to each id. 48 | - If you are adding a folder id and you wish to use index url, then add index url corresponding to that folder. 49 | 50 | - Run driveid.py and follow the screen. 51 | ``` 52 | python3 driveid.py 53 | ``` 54 | 55 | ## Getting Google OAuth API credential file 56 | 57 | - Visit the [Google Cloud Console](https://console.developers.google.com/apis/credentials) 58 | - Go to the OAuth Consent tab, fill it, and save. 59 | - Go to the Credentials tab and click Create Credentials -> OAuth Client ID 60 | - Choose Desktop and Create. 61 | - Use the download button to download your credentials. 62 | - Move that file to the root of search-bot, and rename it to credentials.json 63 | - Visit [Google API page](https://console.developers.google.com/apis/library) 64 | - Search for Drive and enable it if it is disabled 65 | - Finally, run the script to generate token file (token.pickle) for Google Drive: 66 | ``` 67 | pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib 68 | python3 generate_drive_token.py 69 | ``` 70 | 71 | ### Menual - Install [Heroku cli](https://devcenter.heroku.com/articles/heroku-cli) 72 | - Login into your heroku account with command: 73 | ``` 74 | heroku login 75 | ``` 76 | - Create a new heroku app: 77 | ``` 78 | heroku create appname 79 | ``` 80 | - Select This App in your Heroku-cli: 81 | ``` 82 | heroku git:remote -a appname 83 | ``` 84 | - Change Dyno Stack to a Docker Container: 85 | ``` 86 | heroku stack:set container 87 | ``` 88 | - Add Private Credentials and Config Stuff: 89 | ``` 90 | git add -f credentials.json token.pickle config.env heroku.yml 91 | ``` 92 | - Commit new changes: 93 | ``` 94 | git commit -m "Added Creds." 95 | ``` 96 | - Push Code to Heroku: 97 | ``` 98 | git push heroku master --force 99 | ``` 100 | - Restart Worker by these commands: 101 | ``` 102 | heroku ps:scale worker=0 103 | ``` 104 | ``` 105 | heroku ps:scale worker=1 106 | ``` 107 | Heroku-Note: Doing authorizations ( /authorize command ) through telegram wont be permanent as heroku uses ephemeral filesystem. They will be reset on each dyno boot. As a workaround you can: 108 | - Make a file authorized_chats.txt and write the user names and chat_id of you want to authorize, each separated by new line 109 | - Then force add authorized_chats.txt to git and push it to heroku 110 | ``` 111 | git add authorized_chats.txt -f 112 | git commit -asm "Added hardcoded authorized_chats.txt" 113 | git push heroku heroku:master 114 | ``` 115 | 116 | ## Deploying on Server 117 | - Start docker daemon (skip if already running): 118 | ``` 119 | sudo dockerd 120 | ``` 121 | - Build Docker image: 122 | ``` 123 | sudo docker build . -t search-bot 124 | ``` 125 | - Run the image: 126 | ``` 127 | sudo docker run search-bot 128 | ``` 129 | # Credits : 130 | 131 | - python-aria-mirror-bot - [lzzy12](https://github.com/lzzy12/python-aria-mirror-bot) 132 | -------------------------------------------------------------------------------- /bot/modules/authorize.py: -------------------------------------------------------------------------------- 1 | from bot.helper.telegram_helper.message_utils import sendMessage 2 | from telegram.ext import run_async 3 | from bot import AUTHORIZED_CHATS, dispatcher 4 | from telegram.ext import CommandHandler 5 | from bot.helper.telegram_helper.filters import CustomFilters 6 | from telegram import Update 7 | from bot.helper.telegram_helper.bot_commands import BotCommands 8 | 9 | @run_async 10 | def authorize(update,context): 11 | reply_message = update.message.reply_to_message 12 | message_ = update.message.text.split(' ') 13 | msg = '' 14 | with open('authorized_chats.txt', 'a') as file: 15 | if len(message_) == 2: 16 | chat_id = int(message_[1]) 17 | if chat_id not in AUTHORIZED_CHATS: 18 | file.write(f'{chat_id}\n') 19 | AUTHORIZED_CHATS.add(chat_id) 20 | msg = 'Chat authorized' 21 | else: 22 | msg = 'User already authorized' 23 | else: 24 | if reply_message is None: 25 | # Trying to authorize a chat 26 | chat_id = update.effective_chat.id 27 | if chat_id not in AUTHORIZED_CHATS: 28 | file.write(f'{chat_id}\n') 29 | AUTHORIZED_CHATS.add(chat_id) 30 | msg = 'Chat authorized' 31 | else: 32 | msg = 'Already authorized chat' 33 | else: 34 | # Trying to authorize someone in specific 35 | user_id = reply_message.from_user.id 36 | if user_id not in AUTHORIZED_CHATS: 37 | file.write(f'{user_id}\n') 38 | AUTHORIZED_CHATS.add(user_id) 39 | msg = 'Person Authorized to use the bot!' 40 | else: 41 | msg = 'Person already authorized' 42 | sendMessage(msg, context.bot, update) 43 | 44 | 45 | @run_async 46 | def unauthorize(update,context): 47 | reply_message = update.message.reply_to_message 48 | message_ = update.message.text.split(' ') 49 | if len(message_) == 2: 50 | chat_id = int(message_[1]) 51 | if chat_id in AUTHORIZED_CHATS: 52 | AUTHORIZED_CHATS.remove(chat_id) 53 | msg = 'Chat unauthorized' 54 | else: 55 | msg = 'User already unauthorized' 56 | else: 57 | if reply_message is None: 58 | # Trying to unauthorize a chat 59 | chat_id = update.effective_chat.id 60 | if chat_id in AUTHORIZED_CHATS: 61 | AUTHORIZED_CHATS.remove(chat_id) 62 | msg = 'Chat unauthorized' 63 | else: 64 | msg = 'Already unauthorized chat' 65 | else: 66 | # Trying to authorize someone in specific 67 | user_id = reply_message.from_user.id 68 | if user_id in AUTHORIZED_CHATS: 69 | AUTHORIZED_CHATS.remove(user_id) 70 | msg = 'Person unauthorized to use the bot!' 71 | else: 72 | msg = 'Person already unauthorized!' 73 | with open('authorized_chats.txt', 'a') as file: 74 | file.truncate(0) 75 | for i in AUTHORIZED_CHATS: 76 | file.write(f'{i}\n') 77 | sendMessage(msg, context.bot, update) 78 | 79 | 80 | @run_async 81 | def sendAuthChats(update,context): 82 | users = '' 83 | for user in AUTHORIZED_CHATS : 84 | users += f"{user}\n" 85 | users = users if users != '' else "None" 86 | sendMessage(f'Authorized Chats are : \n{users}\n', context.bot, update) 87 | 88 | 89 | send_auth_handler = CommandHandler(command=BotCommands.AuthorizedUsersCommand, callback=sendAuthChats, 90 | filters=CustomFilters.owner_filter) 91 | authorize_handler = CommandHandler(command=BotCommands.AuthorizeCommand, callback=authorize, 92 | filters=CustomFilters.owner_filter) 93 | unauthorize_handler = CommandHandler(command=BotCommands.UnAuthorizeCommand, callback=unauthorize, 94 | filters=CustomFilters.owner_filter) 95 | 96 | dispatcher.add_handler(send_auth_handler) 97 | dispatcher.add_handler(authorize_handler) 98 | dispatcher.add_handler(unauthorize_handler) 99 | 100 | 101 | -------------------------------------------------------------------------------- /bot/helper/drive_utils/gdriveTools.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pickle 3 | 4 | import requests 5 | import logging 6 | 7 | from google.auth.transport.requests import Request 8 | from google_auth_oauthlib.flow import InstalledAppFlow 9 | from googleapiclient.discovery import build 10 | from googleapiclient.errors import HttpError 11 | 12 | from telegram import InlineKeyboardMarkup 13 | from bot.helper.telegram_helper import button_builder 14 | from bot import DRIVE_NAME, DRIVE_ID, INDEX_URL, telegra_ph 15 | 16 | LOGGER = logging.getLogger(__name__) 17 | logging.getLogger('googleapiclient.discovery').setLevel(logging.ERROR) 18 | 19 | SIZE_UNITS = ['B', 'KB', 'MB', 'GB', 'TB', 'PB'] 20 | TELEGRAPHLIMIT = 95 21 | 22 | class GoogleDriveHelper: 23 | def __init__(self, name=None, listener=None): 24 | self.__G_DRIVE_TOKEN_FILE = "token.pickle" 25 | # Check https://developers.google.com/drive/scopes for all available scopes 26 | self.__OAUTH_SCOPE = ['https://www.googleapis.com/auth/drive'] 27 | self.__service = self.authorize() 28 | self.telegraph_content = [] 29 | self.path = [] 30 | 31 | def get_readable_file_size(self,size_in_bytes) -> str: 32 | if size_in_bytes is None: 33 | return '0B' 34 | index = 0 35 | size_in_bytes = int(size_in_bytes) 36 | while size_in_bytes >= 1024: 37 | size_in_bytes /= 1024 38 | index += 1 39 | try: 40 | return f'{round(size_in_bytes, 2)}{SIZE_UNITS[index]}' 41 | except IndexError: 42 | return 'File too large' 43 | 44 | def authorize(self): 45 | # Get credentials 46 | credentials = None 47 | if os.path.exists(self.__G_DRIVE_TOKEN_FILE): 48 | with open(self.__G_DRIVE_TOKEN_FILE, 'rb') as f: 49 | credentials = pickle.load(f) 50 | if credentials is None or not credentials.valid: 51 | if credentials and credentials.expired and credentials.refresh_token: 52 | credentials.refresh(Request()) 53 | else: 54 | flow = InstalledAppFlow.from_client_secrets_file( 55 | 'credentials.json', self.__OAUTH_SCOPE) 56 | LOGGER.info(flow) 57 | credentials = flow.run_console(port=0) 58 | 59 | # Save the credentials for the next run 60 | with open(self.__G_DRIVE_TOKEN_FILE, 'wb') as token: 61 | pickle.dump(credentials, token) 62 | return build('drive', 'v3', credentials=credentials, cache_discovery=False) 63 | 64 | def drive_query(self, parent_id, fileName): 65 | query = f"'{parent_id}' in parents and (name contains '{fileName}')" 66 | response = self.__service.files().list(supportsTeamDrives=True, 67 | includeTeamDriveItems=True, 68 | q=query, 69 | spaces='drive', 70 | pageSize=200, 71 | fields='files(id, name, mimeType, size)', 72 | orderBy='modifiedTime desc').execute()["files"] 73 | return response 74 | 75 | def edit_telegraph(self): 76 | nxt_page = 1 77 | prev_page = 0 78 | for content in self.telegraph_content : 79 | if nxt_page == 1 : 80 | content += f'Next' 81 | nxt_page += 1 82 | else : 83 | if prev_page <= self.num_of_path: 84 | content += f'Prev' 85 | prev_page += 1 86 | if nxt_page < self.num_of_path: 87 | content += f' | Next' 88 | nxt_page += 1 89 | telegra_ph.edit_page(path = self.path[prev_page], 90 | title = 'LoaderX', 91 | html_content=content) 92 | return 93 | 94 | def drive_list(self, fileName): 95 | msg = '' 96 | INDEX = -1 97 | content_count = 0 98 | add_title_msg = True 99 | for parent_id in DRIVE_ID : 100 | response = self.drive_query(parent_id, fileName) 101 | INDEX += 1 102 | if response: 103 | if add_title_msg == True: 104 | msg = f'

Search Results for : {fileName}


@LoaderXbot #ProjektX

' 105 | add_title_msg = False 106 | msg += f"╾────────────╼
{DRIVE_NAME[INDEX]}
╾────────────╼
" 107 | for file in response: 108 | if file.get('mimeType') == "application/vnd.google-apps.folder": # Detect Whether Current Entity is a Folder or File. 109 | msg += f"📁{file.get('name')} (folder)
" \ 110 | f"Drive Link" 111 | if INDEX_URL[INDEX] is not None: 112 | url_path = requests.utils.quote(f'{file.get("name")}') 113 | url = f'{INDEX_URL[INDEX]}/{url_path}/' 114 | msg += f' | Index Link' 115 | else: 116 | msg += f"📄{file.get('name')} ({self.get_readable_file_size(file.get('size'))})
" \ 117 | f"Drive Link" 118 | if INDEX_URL[INDEX] is not None: 119 | url_path = requests.utils.quote(f'{file.get("name")}') 120 | url = f'{INDEX_URL[INDEX]}/{url_path}' 121 | msg += f' | Index Link' 122 | msg += '

' 123 | content_count += 1 124 | if content_count == TELEGRAPHLIMIT : 125 | self.telegraph_content.append(msg) 126 | msg = "" 127 | content_count = 0 128 | 129 | if msg != '': 130 | self.telegraph_content.append(msg) 131 | 132 | if len(self.telegraph_content) == 0: 133 | return "No Result Found :(", None 134 | 135 | for content in self.telegraph_content : 136 | self.path.append(telegra_ph.create_page(title = 'LoaderX', 137 | html_content=content )['path']) 138 | 139 | self.num_of_path = len(self.path) 140 | if self.num_of_path > 1: 141 | self.edit_telegraph() 142 | 143 | msg = f" Search Results For {fileName} 👇 " 144 | buttons = button_builder.ButtonMaker() 145 | buttons.buildbutton("CLICK HERE", f"https://telegra.ph/{self.path[0]}") 146 | 147 | return msg, InlineKeyboardMarkup(buttons.build_menu(1)) 148 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------