octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-12-29 05:02:46 +00:00
Code Issues Projects Releases Wiki Activity
28328013c7
telegram-bot-bash/doc/6_reference.md
Kay Marquardt (Gnadelwartz) 127cc85a2a load modules before commands.sh
2021-01-20 18:20:03 +01:00

37 KiB
Raw Blame History

Home

Bashbot function reference

Send, forward, delete messages

To insert line brakes in a message or caption you can place \n in the text.

send_action

send_action shows users what your bot is currently doing.

usage: send_action "${CHAT[ID]}" "action"

"action": typing, upload_photo, record_video, upload_video, record_audio, upload_audio, upload_document, find_location.

alias: _action "action"

example:

send_action "${CHAT[ID]}" "typing"
send_action "${CHAT[ID]}" "record_audio"
send_normal_message

send_normal_message sends text only messages to the given chat.

usage: send_normal_message "${CHAT[ID]}" "message"

alias: _normal_message "message"

example:

send_normal_message "${CHAT[ID]}" "this is a text message"
send_markdownv2_message

send_markdownv2_message sends markdown v2 style messages to the given chat. Telegram supports a new Markdown V2 Style which has more formatting codes and is more robust, but incompatible with old telegram markdown style.

To send characters reserved for markdown v2 formatting, you must prefix them with \ ( e.g. \| \= \_ \*).
Hint: If a message is not sent, have a look in logs/ERROR.log

usage: send_markdownv2_message "${CHAT[ID]}" "markdown message"

example:

send_markdownv2_message "${CHAT[ID]}" "this is a markdown  message, next word is *bold*"
send_markdownv2_message "${CHAT[ID]}" "*bold* __underlined__ [text](link)"
send_markdown_message

send_markdown_message sends markdown style messages to the given chat. This is the old, legacy Telegram markdown style, retained for backward compatibility. It supports a reduced set of Markdown only

usage: send_markdown_message "${CHAT[ID]}" "markdown message"

alias: _markdown "message"

example:

send_markdown_message "${CHAT[ID]}" "this is a markdown  message, next word is *bold*"
send_markdown_message "${CHAT[ID]}" "*bold* _italic_ [text](link)"
send_html_message

send_html_message sends HTML style messages to the given chat. Telegram supports a reduced set of HTML only

usage: send_html_message "${CHAT[ID]}" "html message"

alias: _html_message "message"

example:

send_normal_message "${CHAT[ID]}" "this is a markdown  message, next word is <b>bold</b>"
send_normal_message "${CHAT[ID]}" "<b>bold</b> <i>italic><i> <em>italic>/em> <a href="link">Text</a>"
forward_message

forward_mesage forwards a message to the given chat.

usage: forward_message "chat_to" "chat_from" "${MESSAGE[ID]}"

old call: forward "${CHAT[ID]}" "$FROMCHAT" "${MESSAGE[ID]}"

alias: _forward "$FROMCHAT" "${MESSAGE[ID]}"

See also Text formatting options

delete_message

A bot can only delete messages if he is admin of a Chat, if not he can delete his own messages only.

usage: delete_message "${CHAT[ID]}" "${MESSAGE[ID]}"

See also deleteMessage limitations

send_message

send_message sends any type of message to the given chat. Type of output is steered by keywords within the message.

The main use case for send_message is to process the output of interactive chats and background jobs. For regular Bot commands I recommend using of the dedicated send_xxx_message() functions from above.

usage: send_message "${CHAT[ID]}" "message"

example: - see Usage and Advanced Usage

File, Album, Location, Venue, Keyboard

send_file

send_file can send local files, URL's or file_id's as different filex types (e.g. photo video sticker)

usage: send_file "${CHAT[ID]}" "file/URL/file_id" "caption" ["type"]

URL's must start with http:// or https:// and remote server must send an appropriate media type. A file_id must start with file_id://, all other file names are threated as local files. If Telegram accepts the file BOTSENT[FILE_ID] and BOTSENT[FILE_TYPE] are set.

Argument "type" is optional, if not given send_file detects file type by the file extension. if file/URL has no extension photo is assumed. Unknown types and extensions are send as type document

Supported file types are: photo (png jpg jpeg gif pic) audio (mp3 flac) sticker (webp) video (mp4) voice (ogg) or document.

It's recommended to use absolute path names for local files (starting with /), as relative path names are threated as relative to UPLOADDIR data-bot-bash/upload!

For security reasons the following restrictions apply to local files:

  • absolute path name must match the shell regex FILE_REGEX
  • relative path name is threated as relative to UPLOADDIR (default: data-bot-bash/upload)
  • path must not start with ./ and not contain ../

example:

# send picture from web
send_file "${CHAT[ID]}" "https://dealz.rrr.de/assets/images/rbofd-1.gif" "My Bot" "photo"
send_file "${CHAT[ID]}" "https://images-na.ssl-images-amazon.com/images/I/81DQ0FpoSNL._AC_SL1500_.jpg"

# local file recommended: absolute path
send_file "${CHAT[ID]}" "/home/user/dog.jpg" "My Dog"

# relative to UPLOADDIR: data-bot-bash/upload/dog.jpg
send_file "${CHAT[ID]}" "dog.jpg" "My Dog"

# change to personal upload dir
UPLOADDIR="/home/user/myuploaddir"
# relative to personal upload dir: /home/user/myuploaddir/dog.jpg
send_file "${CHAT[ID]}" "dog.jpg" "My Dog"
send_album

usage: send_album "${CHAT[ID]}" "URL1" "URL2" ... "URLn"

example:

send_album "$(getConfigKey "botadmin")" "http://www.rrr.de/slider/main-image1.jpg" "http://www.rrr.de/slider/main-image5.jpg"
send_location

usage: send_location "${CHAT[ID]}" "Latitude" "Longitude"

send_venue

usage: send_venue "${CHAT[ID]}" "Latitude" "Longitude" "Title" "Address" "foursquare id (optional)"

send_keyboard

Note: Since version 0.6 send_keyboard was changed to use native "JSON Array" notation as used from Telegram. Detection and emulation for old format will be removed after 1.0 release!

Example Keyboard Array definitions:

  • yes no in two rows:
    • OLD format: 'yes' 'no' (two strings)
    • NEW format: '[ "yes" ] , [ "no" ]' (two arrays with a string)
  • new layouts made easy with NEW format:
    • Yes No in one row: '[ "yes" , "no" ]'
    • Yes No plus Maybe in 2.row: '[ "yes" , "no" ] , [ "maybe" ]'
    • number pad style keyboard: '[ "1" , "2" , "3" ] , [ "4" , "5" , "6" ] , [ "7" , "8" , "9" ] , [ "0" ]'

usage: send_keyboard "chat-id" "message" "keyboard"

alias: _keyboard "message" "keyboard"

example:

send_keyboard "${CHAT[ID]}" "Say yes or no" '[ "yes" , "no" ]' # in one row
send_keyboard "${CHAT[ID]}" "Say yes or no" '[ "yes" ] , [ "no" ]' # 2 rows
send_keyboard "${CHAT[ID]}" "Enter digit" '[ "1" , "2" , "3" ] , [ "4" , "5" , "6" ] , [ "7" , "8" , "9" ] , [ "0" ]'

_keyboard_yesno  # see aliases
_keyboard_numpad
remove_keyboard

usage: remove_keybord "$CHAT[ID]" "message"

alias: _del_keyboard "message"

See also: Keyboard Markup

send_sticker

send_sticker sends a sticker using a file_id to send a sticker that exists on the Telegram servers.

usage: send_sticker "$CHAT[ID]" "file_id"

send_button

send_button sends a text message followed by a single button.

usage: send_button "$CHAT[ID]" "message" "text" "URL"

alias: _button "text" "URL"

example:

send_button "${CHAT[ID]}" "Awesome Deals!" "Visit my Shop" "https://dealz.rrr.de"
_button_row

_button_row is a helper function to create a JSON button array for use with send_inline_keyboard.

usage: _button_row "text|url" "text|url" "" "url" "" "text|url" ...

Each button is specified as a "text|url" pair separated by |, text is shown on the button and url is opened on button click. By default all buttons are displayed on one row, an empty string "" starts a new button row.
If "url" without text is given, url is shown on the button and opened on button click.

example:

# one button, same as send_button
send_inline_keyboard "${CHAT[ID]}" "Best Dealz!" "$(_button_row "Visit my Shop|https://dealz.rrr.de")"

# one button row
send_inline_keyboard "${CHAT[ID]}" "message" "$(_button_row "button 1|http://rrr.de" "button 2|http://rrr.de")"

# multiple button rows
send_inline_keyboard "${CHAT[ID]}" "message" "$(_button_row "b1|http://rrr.de" "b2|http://rrr.de" "" "b3|http://rrr.de" "b4|http://rrr.de")"
send_inline_keyboard

send_inline_keyboard send buttons given as an array of buttons in JSON format.

usage: send_inline_keyboard "CHAT[ID]" "message" "[JSON button array]"

A JSON button array has the following format, but I suggest to use _button_row to create them:

[ {"text":"text1", "url":"url1"}, ... {"text":"textN", "url":"urlN"} ],[...]

example:

# one button, same as send_button
send_inline_keyboard "${CHAT[ID]}" "Best Dealz!" '[{"text":"Visit my Shop", "url":"https://dealz.rrr.de"}]'

# one button row
send_inline_keyboard "${CHAT[ID]}" "message" '[{"text":"button 1", url"":"http://rrr.de"}, {"text":"button 2", "url":"http://rrr.de"} ]'

# multiple button rows
send_inline_keyboard "${CHAT[ID]}" "message" '[{"text":"b1", "url":"http://rrr.de"}, {"text":"b2", "url":"http://rrr.de"}], [{"text":"b3", "url":"http://rrr.de"}, "text":"b4", "url":"http://rrr.de"}]'

See also Inline keyboard markup

Edit / Replace Messages

Edit a message means replace the content of the message in place. The message stay on the same position in the chat and keep the same message id. If new message is the same than current message Telegram return error 400 with description "Bad Request: chat message is not modified"

There is no need to use the same format when replace a message, e.g. a message sent with send_normal_message can be replaced with edit_markdown_message or edit_html_message and vice versa.

To replace a message you must know the message id of the the original message. The best way to get the message id is to save the value of BOTSENT[ID] after sending the original message.

edit_normal_message

edit_normal_message replace a message with a text message in the given chat.

usage: edit_normal_message "${CHAT[ID]}" "MESSAGE-ID" "message"

example:

send_normal_message "${CHAT[ID]}" "this is a text message"
saved-id="${BOTSENT[ID]}"

edit_normal_message "${CHAT[ID]}" "${saved-id}" "this is another text"
edit_markdownv2_message

edit_markdownv2_message replace a message with a markdown v2 message in the given chat.

usage: edit_markdownv2_message "${CHAT[ID]}" "MESSAGE-ID" "message"

example:

send_normal_message "${CHAT[ID]}" "this is a text message"
saved-id="${BOTSENT[ID]}"

edit_markdownv2_message "${CHAT[ID]}" "${saved-id}" "this is __markdown__ *V2* text"
edit_markdown_message

edit_markdown_message replace a message with a markdown message in the given chat.

usage: edit_markdown_message "${CHAT[ID]}" "MESSAGE-ID" "message"

example:

send_normal_message "${CHAT[ID]}" "this is a text message"
saved-id="${BOTSENT[ID]}"

edit_markdown_message "${CHAT[ID]}" "${saved-id}" "this is *markdown* text"
edit_html_message

edit_html_message replace a message with a html message in the given chat.

usage: edit_html_message "${CHAT[ID]}" "MESSAGE-ID" "message"

example:

send_normal_message "${CHAT[ID]}" "this is a text message"
saved-id="${BOTSENT[ID]}"

edit_html_message "${CHAT[ID]}" "${saved-id}" "this is <b>html</b> text"
edit_message_caption

edit_message_caption changes the caption of a message (photo, audio, video, document) in the given chat.

usage: edit_message_caption "${CHAT[ID]}" "MESSAGE-ID" "caption"

Manage Group

To use the following functions the bot must have administrator status in the chat / group

set_chat_title

set_chat_title sets a new chat title. If new title is the same than current title Telegram return error 400 with description "Bad Request: chat title is not modified"

usage: set_chat_title "${CHAT[ID]}" "new chat title"

set_chat_description

set_chat_description sets a new description title. If new description is the same than current description Telegram return error 400 with description "Bad Request: chat description is not modified"

usage: set_chat_description "${CHAT[ID]}" "new chat description"

new_chat_invite

new_chat_invite generate a new invite link for a chat; any previously generated link is revoked. Returns the new invite link as String on success.

usage: new_chat_invite "${CHAT[ID]}"

delete_chat_photo

usage: delete_chat_photo "${CHAT[ID]}"

pin_chat_message

$1 chat, $2 message_id

pin_chat_message add a message to the list of pinned messages in a chat.

usage: pin_chat_message "${CHAT[ID]}" "message_id"

unpin_chat_message

unpin_chat_message remove a message from the list of pinned messages in a chat.

usage: unpin_chat_message "${CHAT[ID]}" "message_id"

unpinall_chat_message

unpinall_chat_message clear the list of pinned messages in a chat.

usage: unpinall_chat_message "${CHAT[ID]}"

delete_chat_stickers

delete_chat_stickers deletes a group sticker set from a supergroup.

usage: delete_chat_stickers "${CHAT[ID]}"

User Access Control

The following basic user control functions are part of the Telegram API. More advanced API functions are currently not implemented in bashbot.

kick_chat_member

If your Bot is a chat admin he can kick and ban a user.

usage: kick_chat_member "${CHAT[ID]}" "${USER[ID]}"

alias: _kick_user "${USER[ID]}"

unban_chat_member

If your Bot is a chat admin can unban a kicked user.

usage: unban_chat_member "${CHAT[ID]}" "${USER[ID]}"

alias: _unban "${USER[ID]}"

leave_chat

Your Bot will leave the chat.

usage: leave_chat "${CHAT[ID]}"

alias: _leave

if bot_is_admin ; then 
 send_markdown_message "${CHAT[ID]}" "*LEAVING CHAT...*"
 leave_chat "${CHAT[ID]}"
fi

See also kick Chat Member*

The following functions are bashbot only and not part of the Telegram API.

bot_is_admin

Return true (0) if bot is admin or creator of given chat.

usage: bot_is_admin "${CHAT[ID]}"

example:

if bot_is_admin "${CHAT[ID]}"; then 
  send_markdown_message "${CHAT[ID]}" "*I'm admin...*"
fi
user_is_botadmin

Return true (0) if user is admin of bot, user id if botadmin is read from file './botadmin'.

usage: user_is_botadmin "${USER[ID]}"

alias: _is_botadmin

example:

user_is_botadmin "${CHAT[ID]}" && send_markdown_message "${CHAT[ID]}" "You are *BOTADMIN*."
user_is_creator

Return true (0) if user is creator of given chat or chat is a private chat.

usage: user_is_creator "${CHAT[ID]}" "${USER[ID]}"

alias: _is_creator

user_is_admin

Return true (0) if user is admin or creator of given chat.

usage: user_is_admin "${CHAT[ID]}" "${USER[ID]}"

alias: _is_admin

example:

if user_is_admin "${CHAT[ID]}" ; then 
  send_markdown_message "${CHAT[ID]}" "*LEAVING CHAT...*"
  leave_chat "${CHAT[ID]}"
fi

See also Chat Member

user_is_allowed

uers_is_allowed checks if: user id botadmin, user is group admin or user is allowed to execute action.. Allowed actions are configured as User Access Control rules, see Advanced Usage

usage: user_is_allowed "${USER[ID]}" "action" "${CHAT[ID]}"

example:

if ! user_is_allowed "${USER[ID]}" "start" "${CHAT[ID]}" ; then
  send_normal_message "${CHAT[ID]}" "You are not allowed to start Bot."
fi

Inline Queries - answer direct queries to bot

Inline Queries allows users to interact with your bot directly without sending extra commands. As an answer to an inline query you can send back one or more results to the Telegram client. The Telegram client will then show the results to the user and let him select one.

answer_inline_query

answer_inline_query is provided for backward compatibility with older versions of bashbot. It send back only one response to an inline query.

usage: answer_inline_query "$i{QUERY[ID]}" "type" "type arg 1" ... "type arg n"

example: - see Advanced Usage

answer_inline_multi

anwser_inline_multi allows you to send back a list of responses. Responses must be separated by ','.

usage: answer_inline_multi "${iQUERY[ID]}" "res, res, ... res"

example:

# note the starting " and ending " !!
answer_inline_multi "${iQUERY[ID]}" "
    $(inline_query_compose "1" "photo" "https://avatars0.githubusercontent.com/u/13046303") ,
    ...
    $(inline_query_compose "n" "photo" "https://avatars1.githubusercontent.com/u/4593242")
    "
inline_query_compose

inline_query_compose composes one response element to to send back.

usage: inline_query_compose ID type args ....

	ID = unique ID for this response, 1-64 byte long
	type = type of answer, e.g. article, photo, video, location ...
	args = mandatory arguments in the order they are described in telegram documentation

Currently the following types and arguments are implemented (optional arguments in parenthesis)

	"article"|"message"	title message (parse_mode description)

	"photo"			photo_URL (thumb_URL title description caption parse_mode keyboard)
	"gif"			photo_URL (thumb_URL title caption parse_mode keyboard)
	"mpeg4_gif"		mpeg_URL (thumb_URL title caption  parse_mode keyboard)
	"video"			video_URL mime_type thumb_URL title (caption parse_mode keyboard)
	"audio"			audio_URL title (caption parse_mode keyboard)
	"voice"			voice_URL title (caption parse_mode keyboard)
	"document"		title document_URL mime_type (caption description parse_mode)

	"location"		latitude longitude title
	"venue"			latitude longitude title (address foursquare)
	"contact"		phone first (last thumb)

	"cached_photo"		file (title description caption parse_mode keyboard)
	"cached_gif"		file (title caption parse_mode keyboard)
	"cached_mpeg4_gif"	file (title caption parse_mode keyboard)
	"cached_sticker"	file (keyboard)
	"cached_document"	title file (description caption description parse_mode keyboard)
	"cached_video"		file title (description caption description parse_mode keyboard)
	"cached_voice"		file title (caption parse_mode keyboard)
	"cached_audio"		file title (caption parse_mode keyboard)

see InlineQueryResult for more information about response types and their arguments.

Background and Interactive jobs

Background functions and interactive jobs extends the bot functionality to not only react to user input. You can start scripts for interactive chats and send messages based on time or other external events.

start_proc

startproc starts a script, the output of the script is sent to the user or chat, user input will be sent back to the script. see Advanced Usage

usage: start_proc "${CHAT[ID]}" "script"

alias: startproc "script"

example:

startproc 'examples/calc.sh'
check_proc

Return true (0) if an interactive script is running in the chat.

usage: check_prog "${CHAT[ID]}"

alias: checkprog

example:

if ! check_proc "${CHAT[ID]}" ; then
  startproc "examples/calc.sh"
else
   send_normal_message "${CHAT[ID]}" "Calc already running ..."
fi
kill_proc

Kill the interactive script running in the chat

usage: kill_proc "${CHAT[ID]}"

alias: killproc

example:

if check_proc "${CHAT[ID]}" ; then
  killproc && send_message "${CHAT[ID]}" "Command canceled."
else
  send_message "${CHAT[ID]}" "Command is not running."
fi
start_back

Starts a script as a background job and attaches a job name to it. All output from a background job is sent to the associated chat.

In contrast to interactive chats, background jobs do not receive user input and can run forever. In addition you can suspend and restart running jobs, e.g. after reboot.

usage: start_back "${CHAT[ID]}" "script" "jobname"

alias: background "script" "jobname"

example:

background "examples/notify.sh" "notify"
check_back

Return true (0) if an background job is active in the given chat.

usage: check_back "${CHAT[ID]}" "jobname"

alias: checkback "jobname"

example:

if ! checkback "notify" ; then
  send_normal_message "${CHAT[ID]}" "Start notify"
  background "examples/notify.sh" "notify"
else
 send_normal_message "${CHAT[ID]}" "Process notify already running."
fi
kill_back

usage: kill_back "${CHAT[ID]}" "jobname"

alias: killback "jobname"

example:

checkback "notify"
if [ "$res" -eq 0 ] ; then
  send_normal_message "${CHAT[ID]}" "Kill notify"
  killback "notify"
else
  send_normal_message "${CHAT[ID]}" "Process notify not run."
fi
send_interactive

send_interactive is used to forward messages to interactive jobs. Usually a message is automatically forwarded from within commands.sh, but you can send messages yourself.

usage: send_interactive "${CHAT[ID]}" "message"

jsshDB

Since output generated by JSON.sh is so easy to use in bash, bashbot uses the format for a simple keys/value file store also.

fast and slow operations

jsshDB files are flat text files containing key/value pairs in the JSON.sh format. Key/value pairs appearing later in the file overwrites earlier key/value pairs, Bashbot use this behavior to implement "fast replace" file operations.

"fast functions" add a new key/value pair to the end of a file without deleting an existing one, this is fast but over time the file grows to infinity.

"slow functions" read the file, modify the key/value pairs in memory and write the whole file back, this is slower but removes duplicate keys from the file.

Fast functions:

   jssh_insertKeyDB , jssh_addKeyDB , jssh_countKeyDB

Slow functions:

   jssh_writeDB, jssh_updateDB , jssh_deleteKeyDB, jssh_clearDB

Key / Value

JsshBD use bash associative arrays to store key/value pairs in memory. Associative arrays must be created with declare -A before first use.

# create key / value array
decleare -A ARRAY

ARRAY["key"]="value"
ARRAY["key,subkey"]="value2"

For keys the following charatcsers are allowed: a-z A-Z 0-9 _ ., multiple keys must be separated by ,. Keys contaiing other characters will be discarded when written to a file.

ARRAY["abc"]="abc"         # OK
ARRAY["abx###"]="abc"      # works in bash but will not saved to file

# write to file will discard second value
jssh_writeDB "ARRAY" "file"

cat file.jssh
["abc"]      "abc"

Hint: Try tr -dc "[:alnum:],.\r\n" to strip invalid characters from key.

# strip key containing invalid characters
KEY="123abcABC,.#?(<>123ÄÖ*%&§"
OK_KEY="$(tr -dc "[:alnum:],.\r\n" <<<"${KEY}")"

# show stripped key
printf "%s\n" "${OK_KEY}"

123abcABC,.123

File naming and locking

A jssh fileDB consists of two files and must reside inside BASHBOT_ETC or BASHBOT_DATA.

  • filename.jssh is the file containing the key/value pairs in JSON.sh format.
  • filename.jssh.flock is used to provide read/write locking with flock

Path names containing .. or not located in BASHBOT_ETC or BASHBOT_DATA are refused by jsshDB functions with an error.

jsshDB functions use file locking if `flock is available, read/write operations are serialised to wait until previous operations are finished, see "man flock". To avoid deadlocks bashbot use a timeout of 10s for write and 5s for read operations.

For every jssh_...DB function a jsshj_...DB_async function exists also. In case don't want locking, use jssh_...DB_async functions.

Example: for allowed file names:

# bashbot is installed in /usr/local/telegram-bot-bash, BASHBOT_ETC is not set.
"myfile" -> /usr/local/telegram-bot-bash/myfile.jssh
"addons/myfile" -> /usr/local/telegram-bot-bash/addons/myfile.jssh
"${DATADIR}/myfile" -> /usr/local/telegram-bot-bash/data-bot-bash/myfile.jssh
"/home/someuser/myfile" -> function returns false, nothing done.
jssh_newDB

Creates new empty jsshDB file if not exist.

usage: jssh_newDB "filename"

usage: jssh_newDB_async "filename"

jssh_clearDB

Delete all contents of jsshDB file.

usage: jssh_clearDB "filename"

usage: jssh_clearDB_async "filename"

jssh_checkDB

Check if DB name respects the rules mentioned above and print to STDOUT the real/final path to DB file. Used internally by all jssh DB functions, but can also used to get the real filename for a jssh DB.

An error is returned and nothing is printed if the given filename is not valid

usage: jssh_checkDB "filename"

usage: jssh_checkDB_async "filename"

if file=$(jssh_checkDB somename); then
	echo "Final filename is ${file}"
else
	echo "Something wrong with somename"
fi

# somename = data-bot-bash/somevalues
Final filename is data-bot-bash/somevalues.jssh

# somename = /home/someuser/myfile
Something wrong with /home/someuser/myfile

# somename = data-bot-bash/../../../somevalues
Something wrong with data-bot-bash/../../../somevalues
jssh_writeDB

Write content of an ARRAY into jsshDB file. ARRAY name must be declared with declare -A ARRAY before calling writeDB. "DB" file MUST exist or nothing is written.

Note: Existing content is overwritten.

usage: jssh_writeDB "ARRAY" "filename"

usage: jssh_writeDB_async "ARRAY" "filename"

example:

# Prepare array to store values
declare -A  WRITEVALUES

WRITEVALUES["value1"]="example"
WRITEVALUES["value2"]="a value"
WRITEVALUES["whynot","subindex1"]="whynot A"
WRITEVALUES["whynot","subindex2"]="whynot B"
WRITEVALUES["whynot","subindex2","text"]="This is an example content for pseudo multidimensional bash array"

# create DB
jssh_newDB "${DATADIR:-.}/myvalues"

# write to file data-bot-bash/somevalues.jssh from array MYVALUES
jssh_writeDB "WRITEVALUES" "${DATADIR:-}/myvalues"

# show what's written
cat "${DATADIR:-}/myvalues.jssh"
["value1"]	"example"
["value2"]	"a value"
["whynot","subindex2","text"]	"This is an example content for pseudo multidimensional bash array"
["whynot","subindex2"]	"whynot B"
["whynot","subindex1"]	"whynot A"
jssh_printDB

Print content of an ARRAY to STDOUT. ARRAY name must be declared with declare -A ARRAY before calling printDB..

usage: jssh_printDB "ARRAY"

example:

# Prepare array to store values
declare -A  PRINTVALUES

# read file data-bot-bash/myvalues.jssh into array READVALUES
jssh_readDB "PRINTVALUES" "${DATADIR:-}/myvalues"

# print DB to stdout
jssh_printDB READVALUES
["value1"]	"example"
["value2"]	"a value"
["whynot","subindex2","text"]	"This is an example content for pseudo multidimensional bash array"
["whynot","subindex2"]	"whynot B"
["whynot","subindex1"]	"whynot A"```
jssh_updateDB

Update/Add content of an ARRAY into a jsshDB file. ARRAY name must be declared with declare -A ARRAY before calling updateDB. "DB" file MUST exist or nothing is written.

Note: Existing content not in ARRAY is kept in file.

usage: jssh_updateDB "ARRAY" "filename"

usage: jssh_updateDB_async "ARRAY" "filename"

example:

# continued example from writeDB
MYVALUES=()
MYVALUES["newvalue"]="this is new"

# update file data-bot-bash/somevalues.jssh from array MYVALUES
jssh_updateDB "MYVALUES" "${DATADIR:-.}/myvalues"

# show what's written
["value1"]	"value1"
["loveit"]	"value2"
["whynot"]	"value3"
["newvalue"]	"this is new"

# now writeDB
cat "$DBfile"
jssh_writeDB "MYVALUES" "${DATADIR:-.}/myvalues"

# show what's written, ups!
cat "$DBfile"
["newvalue"]	"this is new"
jssh_readDB

Read content of a file in JSON.sh format into given ARRAY. ARRAY name must be declared with declare -A ARRAY upfront,

usage: jssh_readDB "ARRAY" "filename"

usage: jssh_readDB_async "ARRAY" "filename"

Note: readDB uses concurrent / shared locking from flock so multiple processes can read from file, as long no process is writing. Maximum timeout for reading is 1s to not block readers.

example:

# Prepare array to read values
declare -A  READVALUES

# read file data-bot-bash/myvalues.jssh into array READVALUES
jssh_readDB "READVALUES" "${DATADIR:-}/myvalues"

# sinple command to output values ONLY
printf "${READVALUES[*]}"
example a value This is an example content for pseudo multidimensional bash array whynot B whynot A

# print DB to stdout
jssh_printDB READVALUES
["value1"]	"example"
["value2"]	"a value"
["whynot","subindex2","text"]	"This is an example content for pseudo multidimensional bash array"
["whynot","subindex2"]	"whynot B"
["whynot","subindex1"]	"whynot A"


# access Array
echo "${READVALUES[vaule2]}"
a value

# change / add values
READVALUES["value2"]="this is a changed value"

echo "${READVALUES[vaule2]}"
this is a changed value

READVALUES["value3"]="new value"
READVALUES[whynot,subindex3]="new subindex value"

# new output
jssh_printDB READVALUES
["value1"]	"example"
["value3"]	"new value"
["value2"]	"this is a changed value"
["whynot","subindex2","text"]	"This is an example content for pseudo multidimensional bash array"
["whynot","subindex3"]	"new subindex value"
["whynot","subindex2"]	"whynot B"
["whynot","subindex1"]	"whynot A"
jssh_insertKeyDB

Insert, update, append a key=value pair to a jsshDB file, key name is only allowed to contain '-a-zA-Z0-9,._'

usage: jssh_insertKeyDB "key" "value" "filename"

usage: jssh_insertKeyDB_asnyc "key" "value" "filename"

deprecated: jssh_insertDB was renamed in version 0.96 to jssh_insertKeyDB

Note: inserKeytDB uses also excusive write locking, but with a maximum timeout of 2s. insertKeyDB is a "fast" operation, simply adding the value to the end of the file.

example:

jssh_insertKeyDB "newkey" "an other value" "${DATADIR:-.}/myvalues"
jssh_deleteKeyDB

Deleted a key=value pair from a jsshDB file, key name is only allowed to contain '-a-zA-Z0-9,._'

usage: jssh_deleteKeyDB "key" "filename"

usage: jssh_deleteKeyDB_async "key" "filename"

example:

jssh_deleteKeyDB "delkey"" "${DATADIR:-.}/myvalues"
jssh_countKeyDB

Increase a key=value pair from a jsshDB file by 1, key name is only allowed to contain '-a-zA-Z0-9,._' If value is given key is increased by value.

Side effect: if value is given key is updated "in place" (slower) and file is cleaned up, if no value is given fast path is used and new count is added to the end of file.

usage: jssh_countKeyDB "key" "filename" ["value"]

usage: jssh_countKeyDB_async "key" "filename" ["value"]

example:

jssh_countKeyDB "usercount"" "${DATADIR:-.}/myvalues"

https://linuxhint.com/associative_array_bash/

https://linuxconfig.org/how-to-use-arrays-in-bash-script

Aliases - shortcuts for often used functions

Aliases are handy shortcuts for use in mycommands.sh only, they avoid error prone typing of "${CHAT[ID]}" "${USER[ID]}" as much as possible. Do not use them in other files e.g. bashbot.sh, modules, addons etc.

_is_botadmin

usage: _is_botadmin

alias for: user_is_botadmin "${USER[ID]}"

_is_admin

usage: _is_admin

alias for: user_is_admin "${CHAT[ID]}" "${USER[ID]}"

_is_allowed

usage: _is_allowed "what"

alias for: user_is_allowed "${USER[ID]}" "what" "${CHAT[ID]}"

_kick_user

usage: _kick_user "${USER[ID]}"

alias for: kick_chat_member "${CHAT[ID]}" "${USER[ID]}"

_unban

usage: _unban "${USER[ID]}"

alias for: unban_chat_member "${CHAT[ID]}" "${USER[ID]}"

_leave

usage: _leave

alias for: leave_chat "${CHAT[ID]}"

_message

usage: _message "message"

alias for: send_normal_message "${CHAT[ID]}" "message"

_normal_message

usage: _normal_message "message"

alias for: send_normal_message "${CHAT[ID]}" "message"

_html_message

usage: _html_message "message"

alias for: send_html_message "${CHAT[ID]}" "message"

_markdown_message

usage: _markdown_message "message"

alias for: send_markdown_message "${CHAT[ID]}" "message"

_inline_button

usage: _inline_button "${1}" "${2}"

alias for: send_inline_button "${CHAT[ID]}" "" "${1}" "${2}"

_inline_keyboard

usage: _inline_keyboard "${1}"

alias for: _inline_keyboard "${CHAT[ID]}" "" "${1}"

_keyboard_numpad

usage: _keyboard_numpad

alias for: send_keyboard "${CHAT[ID]}" "" '["1","2","3"],["4","5","6"],["7","8","9"],["-","0","."]' "yes"

_keyboard_yesno

usage: _keyboard_yesno

alias for: send_keyboard '["yes","no"]'

_del_keyboard

usage: _del_keyboard

alias for: remove_keyboard "${CHAT[ID]}" ""

Helper functions

download

Download the given URL and returns the final filename in TMPDIR. If the given filename exists,the filename is prefixed with a random number. Filename is not allowed to contain '/' or '..'.

usage: download URL filename

example:

file="$(download "https://avatars.githubusercontent.com/u/13046303" "avatar.jpg")"
echo "$file" -> ./data-bot-bash/avatar.jpg
file="$(download "https://avatars.githubusercontent.com/u/13046303" "avatar.jpg")"
echo "$file" -> ./data-bot-bash/12345-avatar.jpg
_exec_if_function

Returns true, even if the given function does not exist. Return false if function exist but returns false.

usage: _exec_if_function function

example:

_exec_if_function "answer_inline_query" "${iQUERY[ID]}" "Answer params"

# fast replacement for module functions exists check:
if _is_function "answer_inline_query"
then
	"answer_inline_query" "${iQUERY[ID]}" "Answer params"
fi
_exists

Returns true if the given function exist, can be used to check if a module is loaded.

usage _exists command

example:

_exists "curl" && _message "Command curl is not installed!"
_is_function

Returns true if the given function exist, can be used to check if a module is loaded.

usage _is_function function

example:

_is_function "background" && _message "you can run background jobs!"

Bashbot internal functions

These functions are for internal use only and must not used in your bot commands.

procname

Returns PrefixBotname_Postfix

usage: procname postfix prefix

example:

# returns botname, if already set
procname 
# returns unique identifier for everything related to chat
procname "${CHAT[ID]}"
# returns unique identifier for job, regardless of chat
procname "" "back-jobname-"
# returns unique identifier for a job related to a chat
# e.g. fifo, cmd and logfile name
procname "${CHAT[ID]}" "back-jobname-"
proclist

Returns process IDs of current bot processes containing string 'pattern' in name or argument.

usage: proclist pattern

example:

# list PIDs of all background processes
proclist "back-"
# list PIDs of all processes of a job
proclist "back-jobname-"
# list PIDs of all processes for a chat
proclist "_${CHAT[ID]}"
# list PIDs of all bot processes
proclist
killallproc

kill all current bot processes containing string 'pattern' in name or argument

usage: killallproc pattern

example:

# kill all background processes
killallproc "back-"
# kill all processes for a chat
killallproc "_${CHAT[ID]}"
# kill all bot processes, including YOURSELF!
killallproc
get_file

usage: url="$(get_file "${CHAT[ID]}" "message")"

JsonDecode

Outputs decoded string to STDOUT

usage: JsonDecode "string"

JsonGetString

Reads JSON from STDIN and Outputs found String to STDOUT

usage: JsonGetString "path","to","string"

JsonGetValue

Reads JSON from STDIN and Outputs found Value to STDOUT

usage: JsonGetValue "path","to","value"

Json2Array

Read JSON.sh style data from STDIN and assign to given ARRAY ARRAY name must be declared with declare -A ARRAY before calling

usage: Json2Array "ARRAY"

Array2Json

Output ARRAY as JSON.sh style data to STDOUT

usage: Array2Json "ARRAY"

get_chat_member_status

usage: get_chat_member_status "${CHAT[ID]}" "${USER[ID]}"

process_client

Every Message sent to your Bot is processed by this function. It parse the send JSON and assign the found Values to bash variables.

process_updates

If new updates are available, this functions gets the JSON from Telegram and dispatch it.

process_inline

Every Inline Message sent to your Bot is processed by this function. It parse the send JSON and assign the found Values to bash variables.

start_timer

Start the the every minute timer ...

event_timer

Dispatcher for BASHBOT_EVENT_TIMER

event_timer

Dispatcher for BASHBOT_EVENT_INLINE

event_timer

Dispatcher for BASHBOT_EVENT_MESSAGE and related

getBotName

The name of your bot is available as bash variable "$ME", there is no need to call this function if Bot is running.

usage: ME="$(getBotName)"

Prev Best Practice

Next Notes for Developers

$$VERSION$$ v1.31-dev-12-g85a178d