wabot

package module
v0.0.0-...-bf0378a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 22, 2022 License: GPL-3.0 Imports: 16 Imported by: 0

README

WhatsApp-GroupBot (OUTDATED)

With the release of WhatsApp's multi-device support this program stopped working. I may try to update it somewhere in the future!

By emulating WhatsApp Web this library allows you to easiely set up and use this highly customizable WhatsApp bot.
Since customizability is the main focus of this project, you can create as many interactions as you want. There is also a feature to save specific informations (like settings) across users within the group.

There is just one small problem
Since there can be only one instance of WhatsApp Web at a time, the bot will pause when you open another instance (e.g. in your browser tab)
The bot will reconnect after a given amount of time (defined in SetErrorTimeout()) and therefore kick you out of your other instance. Obviously, commands during this time-out won't have any effect and sadly, the only way around it, is completly denying another instance of WhatsApp Web being opened.
If you wish to do so, just set the ErrorTimeout to something like 100

I also published one of my private bots so you can get some inspiration.

Installation

Simply use:

go get github.com/Yukaru-san/WhatsApp-GroupBot

Usage

Using this bot should be pretty easy as soon as you know what you want to accomplish. Here is an example of a working program that will count the amount of times the command "/cmd" is used:

package main

import (
	"encoding/json"
	"fmt"
	"time"

	wabot "github.com/Yukaru-san/WhatsApp-GroupBot"
	"github.com/Rhymen/go-whatsapp"
)

// Settings are saved personally for each user
type Settings struct {
	CommandCounter int
}

func main() {

	// Initialize Bot
	wabot.StartBot("My Whatsapp Bot", "bot")

	// Set a custom auto-save interval
	wabot.SetAutosaveInterval(time.Minute)

	// There is a default key, but you can change it
	wabot.SetEncryptionKey([]byte("VmDTJUQrYxTztMDB"))

	// Using default Settings can prevent errors
	wabot.CreateNewSettingsOption(Settings{
		0, // CommandCounter
	})

	// Try to load savedata and convert it into your own structure
	savedata, found := wabot.GetSaveData()
	if found {
		for i := 0; i < len(savedata.BotUsers); i++ {
			tmp := &Settings{}

			data, _ := json.Marshal(savedata.BotUsers[i].Settings)
			json.Unmarshal(data, tmp)

			savedata.BotUsers[i].Settings = *tmp
		}
		wabot.UseSaveData(savedata)
	}

	// Add and handle commands however you like!
	wabot.AddTextCommand("/cmd", func(message whatsapp.TextMessage) {
		// Get the current settings from the user who sent the message
		settings := wabot.GetUserSettings(wabot.MessageToJid(message)).(Settings)

		fmt.Println(settings)

		// Count up!
		settings.CommandCounter++

		// Update the database
		wabot.ChangeUserSettings(wabot.MessageToJid(message), settings)

		// Output
		fmt.Printf("\nUser @%s has used this command %d times!\n", wabot.MessageToName(message), settings.CommandCounter)
	})

	// Don't let the program die here!
	for {
		time.Sleep(time.Minute)
	}
}

Since the savable data is fully modular, at least the savedata-loading couldn't be included within the library. Therefore it has to be done inside of your own code. As long as you keep the name "Settings" you can use this exact loading part for more-or-less any other project. Also, for any aditional information regarding the struct "whatsapp.TextMessage" refer to Rhymen's Github page - it is quite self-explanatory though. A message's text is stored in message.Text

Functions

SetSessionFilePath(string)		   // Directory to save session files in
SetUsersFilePath(string)		   // Directory to save users in
SetQRFilePath(string)			   // Directory to save qr codes in
SetErrorTimeout(time)		   	   // Timeout to reconnect on error
SetNicknameUseage(bool, msgText)	   // Allows users to choose nicknames

StartBot(string, string)                   // Initializes and starts the bot
DisplayTextMessagesInConsole(bool)         // Toggle printing new messages on / off

AddTextCommand(string, func())             // If a message starts with the given string it executes the func
AddGroupCommand(string, string, func())    // Like above, but only works in given group
SetDefaultTextHandleFunction(func())	   // Calls the given function if no command could be parsed
SetImageHandler(func())                    // Executes the given function when receiving an image  
SetStickerHandler(func())                  // Executes the given function when receiving a sticker  

WriteTextMessage(string, string)           // Writes a WhatsApp messsage to the defined Jid's owner
SendImageMessage(*os.File, string, string) // Sends the given image. Important to check imgType (e.g. "img/png")
SendStickerMessage(*os.File, string)       // Sends the given sticker. Needs to be a .webp file

SetEncryptionKey([]byte)                   // Set a 16 Byte key to encrypt your saved data

MessageToJid(whatsapp.TextMessage)         // Returns the unique ID of the message's sender
MessageToName(whatsapp.TextMessage)        // Returns the sender's name
JidToName(string)                          // Returns the name of the ID's owner
NameToJid(string)                          // Returns the corresponding Jid of the user's name

DeactivateAutoSaving()                     // Disables automatic saving
SetAutoSaveInterval(time.Duration)         // Save after every passed interval
SetErrorTimeout(time.Duration)             // Time until the program will restart after losing connection

CreateNewSettingsOption(interface)         // Standard Settings for newly added users
IsUserRegistered(string) bool              // Checks if the Jid is already registered 
AddUserByJid(string)                       // Registers the Jid's owner - if not already registered
ChangeUserSettings(string, interface)      // Updates the user's settings with the given struct
GetUserSettings(string) interface          // Returns the Jid-corresponding Settings
GetUserIndex(whatsapp.TextMessage) int     // Returns the message-owner's position in the user-slice

SaveUsersToDisk() bool                     // Returns true on successfully saving the userlist
GetSaveData() (BotUserList, bool)          // Returns the loaded savedata and true if possible (false otherwise)
UseSaveData(BotUserList)                   // Overwrites the userlist with the given one

ChangeUserSettings and GetUserSettings both call AddUserByJid if needed. You don't need to check yourself!

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddGroupCommand 

func AddGroupCommand(cmd string, groupsToWorkIn []string, functionToExecute func(whatsapp.TextMessage))

AddGroupCommand adds a command that only works on certain groups

func AddTextCommand 

func AddTextCommand(cmd string, functionToExecute func(whatsapp.TextMessage))

AddTextCommand adds a command that only works in all groups

func AddUserByJid 

func AddUserByJid(jid string)

AddUserByJid - AddUser alternative

func ChangeUserSettings 

func ChangeUserSettings(jid string, settings interface{})

ChangeUserSettings a users settings

func CreateNewSettingsOption 

func CreateNewSettingsOption(settings interface{})

CreateNewSettingsOption adds the interface to the general BotUser struct

func DeactivateAutoSaving 

func DeactivateAutoSaving()

DeactivateAutoSaving disables automatic saving

func DisplayTextMessagesInConsole 

func DisplayTextMessagesInConsole(display bool)

DisplayTextMessagesInConsole toggles visibility in console

func GetPhoneNumber 

func GetPhoneNumber() string

GetPhoneNumber returns a bots phone number

func GetUserIndex 

func GetUserIndex(message whatsapp.TextMessage) int

GetUserIndex returns a Users index within the Array

func GetUserNickname 

func GetUserNickname(jid string) string

GetUserNickname returns a users nickname

func GetUserSettings 

func GetUserSettings(jid string) interface{}

GetUserSettings returns the settings of a specific user

func IsUserRegistered 

func IsUserRegistered(jid string) bool

IsUserRegistered checks if the given jid exists in the array

func JidToGroupID 

func JidToGroupID(jid string) string

JidToGroupID returns a group's id according to the jid

func JidToGroupName 

func JidToGroupName(jid string) string

JidToGroupName returns a chat's name according to the jid (can also check groups)

func JidToName 

func JidToName(jid string) string

JidToName returns a corresponding contact or group's name.

func MessageToGroupID 

func MessageToGroupID(message whatsapp.TextMessage) string

MessageToGroupID returns the jid of a group. If the message is from outside a group it returns ""

func MessageToJid 

func MessageToJid(message whatsapp.TextMessage) string

MessageToJid find the right Jid in a message

func MessageToName 

func MessageToName(message whatsapp.TextMessage) string

MessageToName Converts and entire message to the corresponding name -> allows finding the name in groups

func NameToJid 

func NameToJid(name string) string

NameToJid returns a corresponding contact's jid. n general, you want to use MessageToJid() instead

func PrintContacList 

func PrintContacList()

PrintContacList is used for debugging

func SaveUsersToDisk 

func SaveUsersToDisk() bool

SaveUsersToDisk saves the BotUser-Slice

func SendImageMessage 

func SendImageMessage(caption string, img io.Reader, imgType string, remoteJid string)

SendImageMessage takes img type like "image/png" / If caption len is 0 there won't be a text

func SendStickerMessage 

func SendStickerMessage(img *os.File, remoteJid string)

SendStickerMessage only uses .webp files

func SetAutosaveInterval 

func SetAutosaveInterval(interval time.Duration)

SetAutosaveInterval - interval of userdata saving

func SetDefaultTextHandleFunction 

func SetDefaultTextHandleFunction(functionToExecute func(whatsapp.TextMessage))

SetDefaultTextHandleFunction calls the given function when no commands have fit

func SetEncryptionKey 

func SetEncryptionKey(key []byte) bool

SetEncryptionKey replaces the standard encryption Key

  • Key has to be 16 Byte long
  • Returns false if the key is bad

func SetErrorTimeout 

func SetErrorTimeout(timeout time.Duration)

SetErrorTimeout sets the default time to reconnect after an error caused the program to disconnect

func SetImageHandler 

func SetImageHandler(functionToExecute func(whatsapp.ImageMessage))

SetImageHandler calls the given function when receiving an img

func SetNicknameUseage 

func SetNicknameUseage(allowNicknames bool, output string)

SetNicknameUseage changes the users abbility to use nicknames (false by default) - string will be the output. "" for no output

func SetQRFilePath 

func SetQRFilePath(path string)

SetQRFilePath changes the location the users will be saved in ([folder/]filename)

func SetSessionFilePath 

func SetSessionFilePath(path string)

SetSessionFilePath changes the name a file should be saved in ([folder/]filename)

func SetStickerHandler 

func SetStickerHandler(functionToExecute func(whatsapp.StickerMessage))

SetStickerHandler calls the given function when receiving an img

func SetUserNickname 

func SetUserNickname(jid string, nickname string)

SetUserNickname sets a users nickname

func SetUsersFilePath 

func SetUsersFilePath(path string)

SetUsersFilePath changes the location the users will be saved in ([folder/]filename)

func StartBot 

func StartBot(longConnectionName, shortConnectionName string) (whatsapp.Session, *whatsapp.Conn, error)

StartBot initiates and starts the bot - Takes in the name of the group to be run in func StartBot(roomName string) (whatsapp.Session, *whatsapp.Conn) { TODO Only speficied groups

func UseContactNames 

func UseContactNames(use bool)

UseContactNames tells the bot to use names saved in contacts (or not)

func UseSaveData 

func UseSaveData(savedata BotUserList)

UseSaveData loads the given data

func WriteTextMessage 

func WriteTextMessage(text string, remoteJid string)

WriteTextMessage sends a given string as text

Types

type BotUser 

type BotUser struct {
	Contact  whatsapp.Contact
	Nickname string
	Settings interface{}
}

BotUser contains the contact and his personal settings

type BotUserList 

type BotUserList struct {
	BotUsers []*BotUser
}

BotUserList saves the BotUser-Array - easy to save&load

func GetSaveData 

func GetSaveData() (BotUserList, bool)

GetSaveData returns the stored savedata -> bool is false if there was no data

type Command 

type Command struct {
	// contains filtered or unexported fields
}

Command struct

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.