tortk-example 0.0.3
A awesome Torrent Leecher!
Requires Python: >=3.6

# [Join Tortoolkit Group for DEMO](https://t.me/TorToolKit)

# TorToolkit Telegram
So basically Tortoolkit is aimed to be the most versatile torrent leecher and Youtube-DL bot for telegram. This bot is highly customizable and to customize this bot you don't need to restart the bot every time. 
The bot gets started with minimum variables and others can be set as and when needed using the /settings.

## Use master/beta branch for stable performance.
## The Alpha branch is still in testing and is meant for testers. Soon a stable of this version will come out.


## For any help join this:- [TTKDISC](https://t.me/ttkdisc)

## Whats new
- MegaDL added
- Central message update.
- Overall download and upload progress.
- Pixeldrain DL support.
- Alert on when the bot boots up.
- Mongo DB and Postgres DB both are supported.
- Mega Enable/Disable feature.
- Progress for YTDL/PYTDL. (if ENABLE_BETA_YOUTUBE_DL is True)
- ReWritten almost everything.
- Mega Limits added Direct Leech Limits added.
- Mega folder/file leech disable.
- Service Account support added along with normal rclone(can switch runtime).
- Onedrive supported natively (both personal and sharepoint)
- Mega files/folders name fixed.
- Mega files can be extracted.
- Show all mirrors at the time of leech (option in rclone settings).
- Deployment is still the same way.
- Many more features will be documented (if i remember XD)

Table of Content
- [FEATURES](#features)
- [TEST THE BOT (DEMO)](https://t.me/TorToolKit)
- [DEPLOYMENT METHODS](#deployment)
  - [Heroku](##heroku)
  - [Zeet](##zeet)
  - [VPS DEPLOYMENT USING DOCKER](#vps-deployment-docker)
  - [VPS DEPLOYMENT WITHOUT DOCKER](#vps-deployment-without-docker)


# Features
Following are some awesome features offered by this bot:-
- Using the best torrent client to deal with torrent : [qBittorrent](https://github.com/qbittorrent/qBittorrent)
- You can choose which files you want to download from the torrent.
- A glorious settings menu from you can control the bot.
- If the bot is in the group, the users have their own settings like:
  - Permanent thumbnail support.
  - Users can choose if they want a file or video.
  - Load in their own rclone config so that the torrent/direct link is uploaded to their drive. (Work in Progress)
- Extraction of ZIP, TAR, ISO, RAR wih and without password. If you chose to extarct the archive and you enter the password wrong it will prompt you to enter the password upto 3 times after that zip will be uploaded as it is.
- G Drive Index support.
- Admins can put hard limits on the max torrent size and max youtube playlist size.
- Aria2 for direct links download.
- Upload to gdrive by using RCLONE.
  - You can load multiple drives in the conf and can switch on fly using the settings.
- Sorted YTDL download menu.
- Zip and upload also available.
- Get the server status.
- InstaDL support
- Browse the settings menu and try stuff. ;)
- + above changelog.

# Deployment

## ***Heroku***
### No heroku blockings.

## ***Zeet***
According to me, this platform provides resources that are enough for a genuine user and by default prevents Abuse:
Click the logo to see the video guide to see how to deploy. The web is not yet available but soon will be available on Zeet.

[![Deploy](https://telegra.ph/file/a81a05cc874e8636ddb86.png)](https://youtu.be/WWi9JWDzXSw)

## ***VPS Deployment Docker***
ExecVarsSample.py location:- `tortoolkit/consts/ExecVarsSample.py`

### [Deploy with Docker Video](https://youtu.be/c8_TU1sPK08)

Steps:-
1. You should install docker first :- [How to Install Docker](https://docs.docker.com/engine/install/)

2. Clone the repo and edit ExecVarsSample.py 
   1. While editing Change 
      1. `API_HASH`
      2. `API_ID`
      3. `BOT_TOKEN`
      4. `ALD_USR`
      5. `BASE_URL_OF_BOT`
      6. `Uncomment the below DB_URI and comment out the above DB_URI`
      7. Also if the given procedure dosent work then set  `IS_VPS` to True and if you want to change the port when IS_VPS is true then change `SERVPORT` to your desired port number. (Note this should be used as backup)

3. After that execute these commands in root of the repo where tortoolkit folder is located.
    1. `apt install docker-compose`
    2. `docker-compose up`

4. If you edit a file like ExecVarsSample.py in future just run below commands
    1. `docker-compose build`
    2. `docker-compose up`

### ***VPS Deployment Without Docker***
### [Demo video for Deployment Without Docker](https://youtu.be/HYjG4-VfxXs)

1. Run the following commands. (Following commands can be used to setup the vps from scratch)
   
    1. `git clone https://github.com/yash-dk/TorToolkit-Telegram.git`
    2. `sudo apt update`
    3. `sudo apt install -y python3.8`
    4. `sudo apt install -y python3-venv`
    5. `python3 -m venv venv`
    6. `source venv/bin/activate`
    7. `cd TorToolkit-Telegram`
    8. `pip install -r requirements.txt`
	9. `sudo apt install -y postgresql postgresql-contrib`
	10. `apt -qq install -y curl git wget python3 python3-pip aria2 ffmpeg mediainfo unzip p7zip-full p7zip-rar`
	11. `curl https://rclone.org/install.sh | bash`
	12. `apt-get install -y software-properties-common`
	13. `apt-get -y update`
	14. `add-apt-repository -y ppa:qbittorrent-team/qbittorrent-stable`
	15. `apt install -y qbittorrent-nox`
2. After that setup the database:- Remember the 'your-pass' that you enter below
    1. `sudo -u postgres bash`
    2. `createdb tortk`
    3. `psql`
    4. `ALTER USER postgres with password 'your-pass';`
    5. `exit`
    6. `exit`

3. After that setup the Variables.

	Assuming that you are in the directory where you clonned the repo
	   
    1. `cd TorToolkit-Telegram/tortoolkit/consts`
	2. `nano ExecVarsSample.py`
    3. Change the following:-
       1.  `API_HASH`
       2.  `API_ID`
       3.  `BOT_TOKEN`
       4.  `ALD_USR`
       5.  `BASE_URL_OF_BOT`
       6.  Change `DB_URI = "dbname=tortk user=postgres password=your-pass host=127.0.0.1 port=5432"`

           Enter the password in the above string.
       7.  After that run (You can use any port for the web interface here i am using 80).
           Each time before starting the bot export the port Number

           `export PORT=80`

4. And finally run this in clonned folder.
    1. `chmod 777 start.sh`
    2. `./start.sh`

## Variables
- `IS_VPS`
    - Values :- `False`/`True`
    - Default Value :- `False`
    - Use :- Only set to True if you get errors regarding web server in VPS deployment. Only use as backup.

### ***Compulsory Vars***

- `API_HASH`
  - Values :- Valid API HASH obtained from Telegram.
  - Default Value :- `""`
  - Use :- To connect to Telegram.

- `API_ID`
  - Values :- Valid API ID obtained from Telegram.
  - Default Value :- `0`
  - Use :- To connect to Telegram.

- `BOT_TOKEN`
  - Values :- Valid BOT TOKEN Obtained from Botfather.
  - Default Value :- `""`
  - Use :- To connect to Telegram as BOT.

- `BASE_URL_OF_BOT`
  - Values :- Valid BASE URL of where the bot is deploy. Ip/domain of your bot like "http://myip" or if oy have chosen other port then 80 then "http://myip:port". No slash at the end.
  - Default Value :- `""`
  - Use :- This is used for file selection of the torrent.

- `ALD_USR`
  - Values :- It is a list of IDs of all the allowed groups and useres who can use this bot in private. 
    - To supply multiple IDs in ExecVarsSample.py seperate by comma ','. 
    - To supply multiple IDs from Environemnt variable seperate by spaces.
  - Default Value :- `[]` 
  - Use :- Users and groups with ids here can use the bot.

- `DB_URI` = 
  - Values :- Postgres database URL. Just replace your credentials from below. OR directly Paste the URI you obtained from a database hosting or somewhere else.
  - Default Value :- `dbname=tortk user=postgres password=your-pass host=127.0.0.1 port=5432`
  - Use :- Used to connect to DB. DB is used for many stuff in this bot. 

- `OWNER_ID` = 
  - Values :- Owner's ID
  - Default Value :- `0`
  - Use :- Used to restrict use of certain stuff to owner only. 
### ***Limit Vars***
- MAX_DL_LINK_SIZE - Max Directlink size in GBs. 
- MAX_MEGA_LIMIT - Max Mega Download size in GBs.
- MAX_TORRENT_SIZE - Max Torrent size in GBs.

### ***Optional Vars***

- `CENTRAL_UPDATE`
  - Values :- `True`/`False` [Can not be set from settings menu]
  - Default Value :- `True`
  - Use :- All the tasks will be updated in one single message rather than each seperate.

- `GD_INDEX_URL`
  - Values :- Base URL of the index that you are using. (Note that you should include the directory also in URL if you have set `GDRIVE_BASE_DIR`). (Dosen't matter if a slash is at the end or not)
  - Default Value :- `False`
  - Use :- Provides an addition Index link for Google Drive Upload.

- `ONEDRIVE_INDEX_URL`
  - Values :- Base URL of the index that you are using. (Note that you should include the directory also in URL if you have set `ONEDRIVE_BASE_DIR`). (Dosen't matter if a slash is at the end or not)
  - Default Value :- `False`
  - Use :- Provides an addition Index link for OneDrive Upload.

- `ONEDRIVE_BASE_FOLDER_URL`
  - Values :- Base URL of your sharepoint. (ignore if personal onedrive user)
  - Default Value :- `False`
  - Use :- Provides an link for OneDrive Upload.

- `EDIT_SLEEP_SECS`
  - Values :- Seconds to Sleep before edits. Recommended is 40. (If you are using the bot for your own you can try 10 if you get FloodWait Error in LOGS then increase the value) [Can be set from settings menu]
  - Default Value :- `40`
  - Use :- The bot will update the progress regulary after these number of seconds.

- `TG_UP_LIMIT`
  - Values :- Telegram Upload limit in bytes. (you can set max `2147483648` which is ~2GB) [Can be set from settings menu]
  - Default Value :- `1700000000`
  - Use :- The bot will use this value to automatically slice the file bigger that this size into small parts to upload to Telegram.

- `FORCE_DOCUMENTS`
  - Values :- `True`/`False` [Can be set from settings menu]
  - Default Value :- `False`
  - Use :- Should all the upload to telegram be forced as documents or not.

- `COMPLETED_STR`
  - Values :- Any character [Only 1 character] [Can be set from settings menu]
  - Default Value :- `▰`
  - Use :- Character used to denote completed progress in the progress bar. 


- `REMAINING_STR`
  - Values :- Any character [Only 1 character] [Can be set from settings menu]
  - Default Value :- `▱`
  - Use :- Character used to denote remaining progress in the progress bar. 

- `GDRIVE_BASE_DIR`
  - Values :- Rclone Base Directory to where stuff should be clonned inside your Google drive . [Cannot be configured from settings]
  - Default Value :- `"/"`
  - Use :- The bot will upload all the files to that folder in the drive.

- `ONEDRIVE_BASE_DIR`
  - Values :- Rclone Base Directory to where stuff should be clonned inside your onedrive.[Cannot be configured from settings]
  - Default Value :- `"/"`
  - Use :- The bot will upload all the files to that folder in the drive.

- `RCLONE_BASE_DIR`
  - Values :- Rclone Base Directory to where stuff should be clonned inside your drive. (does not apply to Google Drive and Onedrive) [Cannot be configured from settings]
  - Default Value :- `"/"`
  - Use :- The bot will upload all the files to that folder in the drive.

- `LEECH_ENABLED`
  - Values :- `True`/`False` [Can be set from settings under control action]
  - Default Value :- `True`
  - Use :- Upload to telegram should be enabled or not.

- `RCLONE_ENABLED`
  - Values :- `True`/`False` [Can be set from settings under control action]
  - Default Value :- `False`
  - Use :- Upload to rclone should be enabled or not.


- `DEFAULT_TIMEOUT`
  - Values :- `"leech"`/`"rclone"`
  - Default Value :- `"leech"`
  - Use :- Default destination (rclone or leech) to choose if the user fails to choose upload destination in 60 seconds.

- `RCLONE_CONFIG`
  - Values :- Path to the RCLONE.conf file [IT IS RECOMMENDED TO SET THIS FROM SETTINGS MENU]
  - Default Value :- `False`
  - Use :- Rclone file path.

- `DEF_RCLONE_DRIVE`
  - Values :- Default Rclone drive from the config file. This is the heading of a config from the file. [IT IS RECOMMENDED TO SET THIS FROM SETTINGS MENU]
  - Default Value :- `""`
  - Use :- Name of the config in the conf file to refer to.

- `MAX_YTPLAYLIST_SIZE`
  - Values :- Max size of a playlist that is allowed (Number of videos) [Can be set from settings menu]
  - Default Value :- `20` 
  - Use :- Stops the user from downloading big playlists.

- `MAX_TORRENT_SIZE`
  - Values :- Max torrent size in GBs that is allowed. [Can be set from settings menu]
  - Default Value :- `10`
  - Use :- Stops the user from downloading big torrents.

- `Mega Config`
  - MEGA_API - Mega Api get from mega.nz
  - MEGA_UNAME - Mega Username. (blank will run in anonymous mode) 
  - MEGA_PASS = Mega Password. (blank will run in anonymous mode)
  - ALLOW_MEGA_FOLDER - True to allow False to block (can be set from /settings)
  - ALLOW_MEGA_FILES - True to allow False to block (can be set from /settings)
  - MAX_MEGA_LIMIT - Limit in GB of max mega download (can be set from /settings)

- `qBittorrent Config`
  - QBIT_HOST - Host of qbittorrent.
  - QBIT_PORT - Port of qbittorrent
  - QBIT_UNAME - Username of qbittorrent
  - QBIT_PASS - Password of qbittorrent 
  - QBIT_MAX_RETRIES - Max retries to make if connection to qbittorrent fails.

- `SAS Settings`
  - ENABLE_SA_SUPPORT_FOR_GDRIVE - Set to True if you want to use this.
  - SA_FOLDER_ID - Folder name where to upload inside the SAS drive. (leave blank to upload in root).
  - SA_TD_ID - Teamdrive ID. (can be obtained from `rclone.conf` of that drive)
  - SA_ACCOUNTS_FOLDER - Name of the folder where all the json are stored. It should be in root level besides `tortoolkit` folder and `LICENSE`
  - SA_ACCOUNT_NUMBER - Dont Touch.

- `ENABLE_BETA_YOUTUBE_DL` - Set to True to enable the progress of YTDL/PYTDL.
- `ENABLE_WEB_FILES_VIEW` - Set to True to view all userdata and Downloads through web interface. Note:- Don't set to true on public bot. might compromise privacy. 

- `USER_CAP_ENABLE` : Work in progress
- `USER_CAP_LIMIT` : Work in progress

## **Rest Variables are not to be changed** 

## Commands

    leech - To Leech a torrent or download a direct link
    ytdl - Donwload YouTube Video
    pytdl - Download YouTube Playlist
    about - About the bot
    status - Status of all the downloads
    server - Get server status
    usettings - User Settings (private also)
    instadl - Instagram Post/Reel/IGTV download
    setthumb - Set the thumbnail
    clearthumb - Clear the thumbnail
    speedtest - Testing internet speed host
    settings - Settings of the bot ⚠️ Admin Only
    pauseall - Pause all torrents⚠️ Admin Only
    resumeall - Resume all torrents⚠️ Admin Only
    purge - Delete all torrents ⚠️ Admin Only
    getlogs - Get the robot logs ⚠️ Admin Only

# Credits
[Yash-DK](https://github.com/yash-dk)

[Lonami](https://github.com/LonamiWebs/Telethon/) for awesome Telethon

[All the Libraries owner](https://github.com/yash-dk/TorToolkit-Telegram/blob/master/requirements.txt)