It has been 3 months since the last development update, as I was pretty busy with other projects and making video tutorials for this one and also I was looking for a big update change (Commit3) for the update blog. I have included the previous two commits too as those commit happened after the previous development update.
https://github.com/adsau59/supbot
Commit1
Commit2
Commit3
Supbot API is a Whatsapp Group Chatbot API, Showcase video.
Whatsapp is the most used messenger platform, but the lack of bot support made it very tedious to perform some operations that other platform with bot support performs easily.
Supbot API uses Selenium to automate Whatsapp Web to read and collect data, runs business logic and perform different actions defined by the developer, it provides various features to developers to create their own features and add it inside Whatsapp itself.
Supbot is made using
Bot taps the wrong chat if it shifts up or down due to new messages in other group
Cause?
- the webview of chatgroup list item was cached which swapped when a listitem shifts up and down to different group during execution.
Fix?
- find the webview everytime it is needed (removed cached webview for chatgroup listitem)
CheckerThread crashes when a group without Strings.groupTitlePrefix(";;") gets a message
Cause?
- Group title name was split by
Strings.groupTitlePrefix(";;") and the 2nd item in the array is checked as the groupid, if the group doesnt have groupTitlePrefix it would give IndexOutOfBoundExeptionFix?
- After splitting, check if the list have more than 2 elements, before using the 2nd item, to search for groupid
Bot crashes when a message with just an emojie is sent
Cause?
- CheckerThread crashes when it tries to find text in the Bubble when there is none.
Fix?
- Added exception handling when bubble doesn't contain any text.
Blob in ScheduleDatase gets currupted when UpdateSchedule was used
Cause?
- object name was being saved instead of bytes of serialized object
Fix?
- Store Serialized schedule object in the blob as bytes instead of its name.
Whatsapp Web keeps on updating from time to time, which breaks the bot, hence XPaths have to be updated when it changes.
Updated XPaths include:
Added way to tag people with phone number
Why?
- Supbot reads the phone number of client to create unique id, which is then used to refer them too
- As people usually don't recognize the person using their phone number, it wasn't a good design to refer them using their phone number
- So, tagging could be used to refer the client in text
How?
- To use this feature,
SendMessageAction.tagPhoneNumbers()should be used whenSendMessageActionis created to enable this feature,tagPhoneNumbers()takes a regex pattern string as a parameter so that it can be used to recognize if any phone number is there in the text.- when a phone number is found, it is converted into a tag, by placing
@symbol before the number andUP+ENTERkeystrokes after the number, to convert it into a tag.- This feature is kept as an experimental feature as it hasn't been tested much.
Added way to send arguments with space using quotes in ConsoleCommands
Why?
- There was a need to pass arguments with space like phone number in
+xx xxxxx xxxxxformat in the console.How?
- Regex patter matcher was used to find quotes, and the part inside the quotes was taken as a single parameter, and the parts outside the quotes were taken as multiple parameters separated with spaces.
Created ScheduleTaskInitializer
Why?
ScheduleTaskInitializerhelps convert arguments (array of strings) into ScheduleTask object.- It is used by
ScheduleCreateCCto create schedules using console commands, rather than inside code manually.How?
- First, class object of the class derived from the
ScheduleTaskclass has to be added into theScheduleTaskInitializer.scheduleTasksList.- Then when a
ScheduleTaskobject is needed,ScheduleTaskInitalizer.getSceduleTask()method is called with the string arguments.- First argument is the name of the class, which is then used to get its constructor and the data types of the parameter in it.
- Then each of the string from 2nd one is parsed into the respected data type.
- Converting primitives like int, float, bool, etc.. is pretty straight forward, its just have to be parsed from string to their respective types, but parsing custom classes like ChatGroup requires it to have
public static Object castFromString(String s);method in it which is then used to convert the string into its object.- then these objects are used to create the ScheduleTask which is then returned in an
outobject along withScheduleTaskinitalizer.Responseenum which contains the response (whether it was success or which error it encountered)
Created ScheduleCreateCC console command
Why?
ScheduleCreateCCinitializes schedule using Console Command,- In previous version, it was needed to initialize a Schedule for the first time, after which it is stored in the database and loaded automatically when executed next time.
- So the initialization code had to be manually written and executed once, then deleted as that part of code is no longer needed.
- This made developing Schedule very tedious, hence a way was needed to initialize schedule using console commands
How?
ScheduleCreateCCextendsConsoleCommandwhich enables it to execute a block of code when a command is entered along with its arguments.- The string arguments are parsed into the datatypes needed to create a Schedule,
ScheduleTaskInitalizeris used to converted array of string arguments intoScheduleTaskobject which is needed to create a Schedule.
Created ScheduleDBDeleteCC console command
Why?
- Once a Schedule is created, it is serialized and stored in the database in case the bot shut downs and is executed again,
- But when the
ScheduleTaskclass is changed, the serialized schedule object no longer can be loaded.- Hence a quick way was needed to delete the target schedule from the database
How?
ScheduleDBDeleteCCextendsConsoleCommandwhich enables it to execute a block of code when a command is entered along with its arguments.- The command takes 1 arugment which is the name of the schedule it is saved by, then it calls
Bot.getScheduleManager().dbDelete(name)which callsScheduleDatabase.DeleteSchedule(name)
Made Schedule.nextSchedule() method public
Why?
- When a Schedule is missed,
ScheduleTask.taskMissed()method is ran, which is defined by the developer using the API.- It is upon that developer to re schedule the task if it is missed, which become very tedious to do if they just want to re schedule it with respect to current time.
Changed name of RemoteActionCall to StringActionInitializer
Why?
RemoteActionCallclass name didn't had the correct intuition of the content of the class, soStringActionInitializername was better fitting for it.
Made ScheduleManager.notifyUpdate() public
Why?
- It was required for the developers using the API to update the database once they changed some variable in schedule or schedule task.
- Hence, making
notifyUpdate()method public, made it possible to do so.
Development for Supbot API has finished (Since 3 months), but as developers using the API request new features or some bad design in the bot is noticed, I will try my best to add/change it in the bot.
You can contribute this project by,
If you have any problems or you want to contact me for feature ideas or want to collaborate in development you can contact me on DefineX Community discord server
