3.7 KiB
Best Practices
Customizing commands.sh
To ease Updates never change bashbot.sh, all changes should be done in commands.sh .
Insert your own Bot commands in the case ... esac block in commands.sh:
case "$MESSAGE" in
'/echo') # my first own command, echo MESSAGE
send_normal_message "${CHAT[ID]}" "${MESSAGE}"
;;
################################################
# DEFAULT commands start here, do not edit below this!
'/info')
bashbot_info "${CHAT[ID]}"
;;
esac
after editing commands.sh restart Bot.
Seperate logic from command block
If your Bot command needs more than 2-3 lines of code I recommend to factor it out to a function to keep the command block small.
Place the functions in a file, e.g. mybotcommands.inc.sh and source it from bashbot.sh.
process_message is an example for a function hiding complex logic in a bash funtcion.
source mybotcommands.inc.sh
case "$MESSAGE" in
'/report') # logic for /report is done in process_message
send_normal_message "${CHAT[ID]}" "$(process_message "$MESSAGE")"
;;
################################################
# DEFAULT commands start here, do not edit below this!
'/info')
bashbot_info "${CHAT[ID]}"
;;
'/start')
send_action "${CHAT[ID]}" "typing"
bashbot_help "${CHAT[ID]}"
;;
esac
Example function process_message in file mybotcommands.inc.sh:
#!/bin/bash
#
process_message() {
local ARGS="${1#/* }" # remove command /*
local TEXT OUTPUT=""
# process every word in MESSAGE, avoid globbing from MESSAGE
set -f
for WORD in $ARGS
do
set +f
# process links
if [[ "$WORD" == "https://"* ]]; then
REPORT="$(dosomething_with_link "$WORD")"
# no link, add as text
else
TEXT="$(echo "${TEXT} $WORD")"
continue
fi
# compose result
OUTPUT="* ${REPORT} ${WORD} ${TEXT}"
TEXT=""
done
# return result, reset globbing in case we had no ARGS
set +f
echo "${OUTPUT}${TEXT}"
}
Doing it this way keeps commands.sh small and clean, while allowing complex tasks to be done in the included function.
Test your Bot with shellcheck
Shellcheck is a static linter for shell scripts providing excellent tips and hints for shell coding pittfalls. You can use it online or install it on your system. All bashbot scripts are linted by shellcheck.
Shellcheck examples:
$ shellcheck -x mybotcommands.inc.sh
Line 17:
TEXT="$(echo "${TEXT} $WORD")"
^-- SC2116: Useless echo? Instead of 'cmd $(echo foo)', just use 'cmd foo'.
As you can see my mybotcommands.inc.sh contains an useless echo command in 'TEXT=' assigment and can be replaced by TEXT="${TEXT}${WORD}"
$ shellcheck -x notify
OK
$ shellcheck -x question
OK
$ shellcheck -x commands.sh
OK
$ shellcheck -x bashbot.sh
In bashbot.sh line 123:
text="$(echo "$text" | sed 's/ mynewlinestartshere /\r\n/g')" # hack for linebreaks in startproc scripts
^-- SC2001: See if you can use ${variable//search/replace} instead.
In bashbot.sh line 490:
CONTACT[USER_ID]="$(sed -n -e '/\["result",'$PROCESS_NUMBER',"message","contact","user_id"\]/ s/.*\][ \t]"\(.*\)"$/\1/p' <"$TMP")"
^-- SC2034: CONTACT appears unused. Verify it or export it.
Here are two warnings in bashbots scripts. The first is a hint you may use shell substitions instead of sed, this is really possible and much faster! The second warning is about an unused variable, this is true because in our examples CONTACT is not used but assigned in case you want to use it :-)