README.md

#

Telegram Proxy Bot

A simple BITM, for [Telegram](https://telegram.org/) acting as some kind of "proxy". Can use it as "virtual" second account for your purposes without revealing your "actual" identity.

Credits to **Groosha** for the actual version, I've simply added certain features which I thought were needed

• ChangeLog!
• Prerequisites
• How to install
• What's new ?
• How it works ?
  • Basic Functionality
  • Blocking and Unblocking Feature
  • Available and Unavailable Feature
• Notes and restrictions
• Upcoming features
• Remember
• F.A.Q.
• Contact

##ChangeLog! ####Version 1.4.1 (current):

• Major change: Added launch.sh and launch2.sh. Simply run launch.sh to run the bot the features added by me and launch2.sh to run the original proxy bot
• Fixed some small bugs.

####Version 1.4.0:

• Major change: Removed the database methode of storing values.
• Added: Reply_to_message feature. Now Admins can see what message the user replied to. Check In Reply to feature
• Fixed some small bugs.

####Version 1.3:

• Major Updated: /setblockmessage and /viewblockmessage Admins can now set a custom block message.
• Fixed some minor bugs.
• Bugs in this version: Sometimes the bot fails to reply the user

####Version 1.2:

• Major Update:
  • Added:
    • Available and Unavailable Feature
    • /setunavailablemessage feature
    • /viewblocklist feature
    • /viewnicknames feature
• Bugs in this version: No bugs as such

####Version1.1:

• Major Update: Improve the blocking functionality, admins can now block a user by /block @username/nickname
• Bugs in this version: No bugs as such

####Version1.0

• Major Update: Users can now block a user they want to by simply tapping /block<userid> and to unblock by /unblock<userid>
• Bugs in this version : The /block feature was a bit annoying (fixed in the next update)

Prerequisites

• Python 3 (works only with Python3);
• pyTelegramBotAPI library (with bot 2.0 support);
• Telegram account.
• Basic Knowledge about coding of course!
• And the ability to read the manual patiently :D

How to install

• Get your own bot's token from @BotFather;
• Find out your account's unique ID (you can use ID bot or just send message via Curl or something else and get message.chat.id from response JSON);
• Fill in the necessary variables in config.py;
• Start bot: bash launch.sh

What's new ???

• So I thought probably getting /block~number~ and /unblock~number~ after every text message was a bit annoying and it increases the number of text messages received, keeping this in mind I updated the bot. Now the admin can block a user by typing /block @username/nickname and to unblock by /unblock @username/nickname
  Details On how this works is down Under Blocking and Unblocking Feature section
• Admins can now set their status as /available or /unavailable. This means that when you will not be available bot will notify the user if he/she tries to text you by sending him your unavailable message, just like the way you have a pre-recorded message on answering machines! The bot will however forward you the message. You can set and view your unavailable message by typing /setunavailablemessage and /setunavailablemessage respectively.
• You can now view the list of users you've blocked! By typing /viewblocklist. The list will contain their @username/nickname
• You can check your status whether you're currently available or unavailable by typing /checkstatus
• /help command is also there for admins to see all the available commands
• /viewnicknames to view all the nicknames of the users along with their first names.
• /viewblockmessage and /setblockmessage to view and set the block message that the user will see once he/she is blocked
• Changed the style of storing user ids. It doesn't store the data of the users in a database anymore
• In Reply to feature. Admin can now see what message the user has force replied to

How it works

Basic Functionality

The idea of this bot is pretty simple: you just place the bot between you and the one you want to chat with. The upside is that no one will find out your unique chat id or some other info (nickname, first name or avatar, for example). They won't also know your last seen time. However, the downside is that you can't initiate chat with someone (Because you're writing from bot and bots can't start chats to prevent spam), so you'll have to ask people to write to your bot first.



Blocking and Unblocking Feature

Alright, so after spending some time with the bot I thought /block~number~ and /unblock~number~ after every text was kinda annoying, so I updated the blocking feature in the bot.

I thought that it would be probably easier and less messy if the admin can block a user based on the username.
So, now you can block any user you want based on their @username or nickname provided by you, here's how it works:

Well, the bot simply stores the data of every user it interacts with in the form of a dictionary with the key as the Username and the val or value as the message.chat.id of the user. And therefore whenever the admin blocks a user by entering the username the bot simply takes in the username and gets the corresponding chat.id out of it and stores it in the block list.

Now some of you might be wondering like what if the user doesn't have a username or what if the user changed his/her username ? Aye! we have a solution for that to but before answering that let's make a list of all the possible cases we can have.
There can be many possibilities and chances of error, I've made sure to cover all of them but who knows o_0

Okay! So here are the cases:

case 1: user has a username and is a new user for the bot
case 2: user doesnt have a username and is a new user for the bot
case 3: user changed his username but is an old user for the bot
case 4: user removed his username and is an old user for the bot
case 5: idk that's it ?

 if message.chat.id not in user_dir.values():    
  if message.chat.username == None:
     msg = bot.send_message(config.my_id, "*Uh! the user does not have a username o_0*\nCan you please suggest a name that can be used to store the data of the following user ?\n *PS: The nickname should be unique and shouldn't contain* '`@`'",parse_mode="Markdown" )
     bot.register_next_step_handler(msg, lambda m: dictionary.process_name_step(m, dict_name=user_dir, file=config.storage_userdir, val=message.chat.id, firstname=message.chat.first_name))
        
  else:
     userName = "@"+ message.chat.username
     userName = userName.lower()
     #checks whether the message.chat.id of the user is there in the block list (user_list)
     #if message.chat.id present ---> sends a message to the user that he/she is blocked
     #else forwards the message to the admin
     if userName not in user_dir:   
         dictionary.add_key_dict(config.storage_userdir, user_dir, userName, message.chat.id)     
else:
  if message.chat.username == None:
    for userName, chatid in user_dir.items():
       if chatid == message.chat.id:
           z = userName
           if '@' in z:
               msg = bot.send_message(config.my_id, "*Uh! the user does not have a username o_0*\nCan you please suggest a name that can be used to store the data of the following user ?\n *PS: The nickname should be unique and shouldn't contain* '`@`'",parse_mode="Markdown" )
               bot.register_next_step_handler(msg, lambda m: dictionary.process_name_step(m, dict_name=user_dir, file=config.storage_userdir, val=message.chat.id, firstname=message.chat.first_name))
  else:
     userName = "@"+ message.chat.username
     userName = userName.lower()
     if userName not in user_dir:   
         dictionary.add_key_dict(config.storage_userdir, user_dir, userName, message.chat.id) 

Alright so let's understand the code:

'''
 if message.chat.id not in user_dir.values() <-- here the bot checks whether the message.chat.id of the user exists in the dict or not
   if not: <--meaning it's a new user
     then it checks for the username
       if user doesnt have a username then ---> it asks the admin to give a nickname for the user to save that as key
       else it saves the username of the new user as the key and chat.id as the val
       We've successfully covere the cases 1 & 2 ^
   Now if message.chat.id is present in user_dir.values() 
   if yes: <---meaning its an old user 
      it then checks whether the username is present or not 
           if the user doesnt has a username (meaning the old user removed his/her username)
           then it cross checks in the dict whether the key of the user has '@' or not
               Now here's the tricky part: Why did I check for '@' ? Because in the case 2 we have given a nick name 
               to the user so now assume a case :
                     the new user opens the bot writes a text to the bot, the bot checks the chat.id of the user since it's not 
                     there and the user doesnt has a username it will ask the admin to give a nickname. 
                     NOW! if the user will write a text message again then since the chat.id of the user is now present in the 
                     dict() the user will be treated as an old user with the key as the nickname. So, the else part of the code 
                     will execute. Now! here we are only considering the old users and not the users who already have a nickname
                     and hence to differentiate among the two we have checked for '@' symbol in the key.
               Hence, if the user is old and doesnt have a username then it will ask the admin for the new nickname
               We have successfully covered the case 4 ^
            if the old user has a nickname then it checks whether the username is already present or not
                if not: then it saves the data of the user with the key as the new username and message.chat.id as the val
                if yes: then do nothing 
   Hence, we have covered all the possible cases
  '''

I hope this answered the questions and explained all the cases mentioned above, I know it's a bit complicated and a difficult way to code but idk i just didn't get any other idea. :P

Since we know that no one is perfect in terms of recalling the previous data, I've included the /viewnicknames feature as well. This well help you to view all the nick-names along with the respective first-name of the user to whom it was allotted.

So here are the following commands:

• /block @username/nickname <-- To block a user
  
• /unblock @username/nickname <-- To unblock a user
  
• /setblockmessage <-- To set the block text that the user will see once he/she is blocked
  
• /viewblockmessage <-- To view your own block message
• /viewnicknames <-- To view all the allotted nicknames along with the user's first-name

**Admins can even view the block list by typing** `/viewblocklist`

Screenshots:

#####Basic Blocking Functionality:

#####Setting the blocking text:

#####Viewing the Block List:


####Setting and Viewing Nicknames:


Available and Unavailable Feature

There can be at times when you as an admin are unavailable or don't temporarily have access to the bot, but you at the same time want to notify all the users about your unavailability just like the way we have on answering machines ?

"Joshua is Unavailable! Kindly leave your message after the beep.........."

Keeping this in mind here's the /unavailable and /available feature!
You can now set your status as available or unavailable

So now the admins set the status by typing:

• /available <--- To set the status as available
• /unavailable <--- to set the status as unavailable
  To check the current status simply send /checkstatus to the bot
  
  

If your status is set to unavailable then the bot will simply forward the message to the admin and notify the user about the unavailability of the admin ( by sending an unavailable message)

To set the unavailable message simply send:

• /setunavailablemessage

To view the unavailable message simply send:

• /viewunavailablemessage

####Screenshots :

Setting Unavailable Message :

Basic Feature :

Checking Status:


##In Reply To: Well as stated before/in the previous version. The admins were not able to see the text the user has force replied to, since the bot only forwards every new text and not the old ones.. So admin wouldn't know if the user has replied to a previously sent text or not. Now admins can see the previously send message to which the user replied.

###Screenshot:


Notes and restrictions

1. Message formatting (both Markdown and HTML) is disabled. You can easily add parse_mode argument to send_message function to enable it.
   example:

bot.send_message(message.chat.id, "Please click on [this](www.google.com)to search on Google",parse_mode="Markdown")

2. You(Admins) should always use "reply" function, because bot will check message_id of selected "message to reply".
3. Storage is needed to save "message_id":"user_id" key-value pairs. First, I intended to delete message_id which I've already answered, but then I decided to remove this, so you can answer any message from certain user and multiple times.
4. Supported message types in reply: text, sticker, photo, video, audio, voice, document, location.
5. To block a user simply type/block @username/nickname and to unblock a user simply type /unblock @username/nickname
6. If you dont need these features then you can simply use the original version of the bot which was made by Groosha. Open the terminal and enter bash launch2.sh
7. All the text files are mentioned in config.py except blank.txt which is used somewhere in between the code.
   ** I will not recommend you to change the name or the location of the text files. But it's up to you! **
8. This bot only works in the private chats, I've tried making it work in the groups but it didn't really worked, if you can improve this bot then do let me know! I would be glad to make this work better
9. You can use the /help command to view all the commands which you can use an admin

Upcoming Features

• I would be working on adding some more helpful features for admins and maybe for the users as well let's see :)
• Anti-Spam Feature, limiting messages sent per-second
• Broadcast feature for admins, they can broadcast a certain message to selected users they want
• idk maybe more ?? haha

Remember!

I understand, that "proxy" bots can be used to prevent spammers from being reported, so if you encounter such bots that are used to do "bad" things, feel free to report them: [email protected]

F.A.Q

1. Will this bot work in groups/supergroups/channels ?

For the time being this bot just works in private chats.

2. Can I use Emojis in my unavailable message ?

Yes! You can use ONLY emojis or text in your unavailable message, you cannot save stickers/gifs in the unavailable message

3. Will I be able to skip my school/college/job ?

Unfortunately nope :(

Contact

You can contact me via my Proxy Bot.
PS: Let me know if you need a new feature/tweak in this bot, please don't hesitate to text me :)