mirror of
https://github.com/octoleo/telegram-bot-bash.git
synced 2025-02-02 18:38:24 +00:00
Merge pull request #156 from dcoomber/develop
Documentation and variable name updates
This commit is contained in:
Kay Marquardt
GitHub
commit
5a3e68370d
@ -29,7 +29,7 @@
|
||||
# BASHBOT_EVENT_LOCATION location or venue received
|
||||
# BASHBOT_EVENT_FILE file received
|
||||
#
|
||||
# BAHSBOT_EVENT_TIMER this event is a bit special as it fires every Minute
|
||||
# BASHBOT_EVENT_TIMER this event is a bit special as it fires every Minute
|
||||
# and has 3 meanings: oneshot, every time, every X minutes.
|
||||
#
|
||||
# all global variables and functions can be used in registered functions.
|
||||
|
||||
@ -17,14 +17,13 @@
|
||||
|
||||
# save default values
|
||||
TERM="" # disable bashbot clear and color output
|
||||
runas="nobody"
|
||||
runcmd="echo Dry run:" # not activated until you edit lines below
|
||||
|
||||
#######################
|
||||
# Configuration Section
|
||||
|
||||
# edit the next line to fit the user you want to run bashbot, e.g. nobody:
|
||||
# runas="nobody"
|
||||
runas="nobody"
|
||||
|
||||
# uncomment one of the following lines to fit your system
|
||||
# runcmd="su $runas -s /bin/bash -c " # runasuser with *su*
|
||||
@ -81,4 +80,3 @@ case "$1" in
|
||||
;;
|
||||
esac
|
||||
exit $RETVAL
|
||||
|
||||
|
||||
44
bashbot.sh
44
bashbot.sh
@ -21,7 +21,7 @@
|
||||
# - 4 unknown command
|
||||
# - 5 cannot connect to telegram bot
|
||||
# - 6 mandatory module not found
|
||||
# - 6 can't get bottoken
|
||||
# - 7 can't get bottoken
|
||||
# - 10 not bash!
|
||||
# shellcheck disable=SC2140,SC2031,SC2120,SC1091
|
||||
|
||||
@ -143,7 +143,7 @@ fi
|
||||
ADDONDIR="${BASHBOT_ETC:-.}/addons"
|
||||
RUNUSER="${USER}" # USER is overwritten by bashbot array :-(, save original
|
||||
|
||||
# OK everything setup, lest start
|
||||
# OK everything setup, lets start
|
||||
if [[ -z "${SOURCE}" && -z "$BASHBOT_HOME" ]] && ! cd "${RUNDIR}" ; then
|
||||
echo -e "${RED}ERROR: Can't change to ${RUNDIR} ...${NC}"
|
||||
exit 1
|
||||
@ -190,7 +190,7 @@ if [ -z "${BOTTOKEN}" ]; then
|
||||
[ -n "${token}" ] && printf '["bottoken"]\t"%s"\n' "${token}" >> "${BOTCONFIG}.jssh"
|
||||
fi
|
||||
|
||||
# no boteadmin, setup botadmin
|
||||
# no botadmin, setup botadmin
|
||||
if [ -z "$(getConfigKey "botadmin")" ]; then
|
||||
# convert old admin
|
||||
if [ -r "${BOTADMIN}" ]; then
|
||||
@ -268,12 +268,12 @@ fi
|
||||
if ! check_token "${BOTTOKEN}"; then
|
||||
echo -e "${ORANGE}Warning: your bottoken may incorrect. it should have the following format:${NC}"
|
||||
echo -e "${GREY}123456789${RED}:${GREY}Aa-Zz_0Aa-Zz_1Aa-Zz_2Aa-Zz_3Aa-Zz_4${ORANGE} => ${NC}\c"
|
||||
echo -e "${GREY}8-10 digits${RED}:${GREY}35 alnum characters + '_-'${NC}"
|
||||
echo -e "${GREY}8-10 digits${RED}:${GREY}35 alphanumeric characters + '_-'${NC}"
|
||||
echo -e "${ORANGE}Your current token is: '${GREY}^$(cat -ve <<<"${BOTTOKEN//:/${RED}:${GREY}}")${ORANGE}'${NC}"
|
||||
[[ ! "${BOTTOKEN}" =~ ^[0-9]{8,10}: ]] &&\
|
||||
echo -e "${ORANGE}Possible problem in the digits part, len is $(($(wc -c <<<"${BOTTOKEN%:*}")-1))${NC}"
|
||||
[[ ! "${BOTTOKEN}" =~ :[a-zA-Z0-9_-]{35}$ ]] &&\
|
||||
echo -e "${ORANGE}Posilbe problem in the charatcers part, len is $(($(wc -c <<<"${BOTTOKEN#*:}")-1))${NC}"
|
||||
echo -e "${ORANGE}Possible problem in the characters part, len is $(($(wc -c <<<"${BOTTOKEN#*:}")-1))${NC}"
|
||||
fi
|
||||
|
||||
|
||||
@ -300,7 +300,7 @@ export res CAPTION
|
||||
|
||||
|
||||
##################
|
||||
# read commamds file if we are not sourced
|
||||
# read commands file if we are not sourced
|
||||
COMMANDS="${BASHBOT_ETC:-.}/commands.sh"
|
||||
if [ -z "${SOURCE}" ]; then
|
||||
if [ ! -f "${COMMANDS}" ] || [ ! -r "${COMMANDS}" ]; then
|
||||
@ -350,14 +350,14 @@ procname(){
|
||||
printf '%s\n' "$2${ME}_$1"
|
||||
}
|
||||
|
||||
# $1 string to search for proramm incl. parameters
|
||||
# returns a list of PIDs of all current bot proceeses matching $1
|
||||
# $1 string to search for programme incl. parameters
|
||||
# returns a list of PIDs of all current bot processes matching $1
|
||||
proclist() {
|
||||
# shellcheck disable=SC2009
|
||||
ps -fu "${UID}" | grep -F "$1" | grep -v ' grep'| grep -F "${ME}" | sed 's/\s\+/\t/g' | cut -f 2
|
||||
}
|
||||
|
||||
# $1 string to search for proramm to kill
|
||||
# $1 string to search for programme to kill
|
||||
killallproc() {
|
||||
local procid; procid="$(proclist "$1")"
|
||||
if [ -n "${procid}" ] ; then
|
||||
@ -372,7 +372,7 @@ killallproc() {
|
||||
}
|
||||
|
||||
|
||||
# $ chat $2 mesgid $3 nolog
|
||||
# $ chat $2 msg_id $3 nolog
|
||||
declare -xr DELETE_URL=$URL'/deleteMessage'
|
||||
delete_message() {
|
||||
[ -z "$3" ] && printf "%s: Delete Message CHAT=%s MSG_ID=%s\n" "$(date)" "${1}" "${2}" >>"${UPDATELOG}"
|
||||
@ -509,7 +509,7 @@ sendJsonResult(){
|
||||
[ -n "${BASHBOT_RETRY}${BASHBOT_WGET}" ] && return
|
||||
|
||||
# OK, we can retry sendJson, let's see what's failed
|
||||
# throttled, telegram say we send to much messages
|
||||
# throttled, telegram say we send too many messages
|
||||
if [ -n "${BOTSENT[RETRY]}" ]; then
|
||||
BASHBOT_RETRY="$(( ++BOTSENT[RETRY] ))"
|
||||
printf "Retry %s in %s seconds ...\n" "${2}" "${BASHBOT_RETRY}"
|
||||
@ -608,7 +608,7 @@ process_client() {
|
||||
# log message on debug
|
||||
[[ -n "${debug}" ]] && printf "\n%s: New Message ==========\n%s\n" "$(date)" "$UPDATE" >>"${LOGDIR}/MESSAGE.log"
|
||||
|
||||
# check for uers / groups to ignore
|
||||
# check for users / groups to ignore
|
||||
jssh_updateArray_async "BASHBOTBLOCKED" "${BLOCKEDFILE}"
|
||||
[ -n "${USER[ID]}" ] && [[ -n "${BASHBOTBLOCKED[${USER[ID]}]}" || -n "${BASHBOTBLOCKED[${CHAT[ID]}]}" ]] && return
|
||||
|
||||
@ -903,7 +903,7 @@ process_message() {
|
||||
[ -z "${MESSAGE[0]}" ] && [ -n "${SERVICE[PINNED]}" ] &&\
|
||||
MESSAGE[0]="/_new_pinned_message ${USER[ID]} ${PINNED[ID]} ${PINNED[MESSAGE]}"
|
||||
fi
|
||||
# set SSERVICE to yes if a service message was received
|
||||
# set SERVICE to yes if a service message was received
|
||||
[[ "${SERVICE[*]}" =~ ^[[:blank:]]*$ ]] || SERVICE[0]="yes"
|
||||
|
||||
# split message in command and args
|
||||
@ -964,7 +964,7 @@ start_bot() {
|
||||
sleep "$(_round_float "${nextsleep}e-3" "1")"
|
||||
# get next update
|
||||
UPDATE="$(getJson "$UPD_URL$OFFSET" "nolog" 2>/dev/null | "${JSONSHFILE}" -s -b -n 2>/dev/null | iconv -f utf-8 -t utf-8 -c)"
|
||||
# did we ge an responsn0r
|
||||
# did we get an response?
|
||||
if [ -n "${UPDATE}" ]; then
|
||||
# we got something, do processing
|
||||
[ "${OFFSET}" = "-999" ] && [ "${nextsleep}" -gt "$((maxsleep*2))" ] &&\
|
||||
@ -981,7 +981,7 @@ start_bot() {
|
||||
process_updates "${DEBUGMSG}"
|
||||
fi
|
||||
else
|
||||
# ups, something bad happened, wait maxsleep*10
|
||||
# oops, something bad happened, wait maxsleep*10
|
||||
(( nextsleep=nextsleep*2 , nextsleep= nextsleep>maxsleep*10 ?maxsleep*10:nextsleep ))
|
||||
[ "${OFFSET}" = "-999" ] &&\
|
||||
log_error "Repeated timeout/broken/no connection on telegram update, sleep $(_round_float "${nextsleep}e-3")s"
|
||||
@ -1081,11 +1081,11 @@ if [ -z "${SOURCE}" ]; then
|
||||
##############
|
||||
# internal options only for use from bashbot and developers
|
||||
case "${1}" in
|
||||
# update botname botname when starting only
|
||||
# update botname when starting only
|
||||
"botname"|"start"*)
|
||||
ME="$(getBotName)"
|
||||
if [ -n "${ME}" ]; then
|
||||
# ok we have a connection an got botname, save it
|
||||
# ok we have a connection and got botname, save it
|
||||
[ -n "${CLEAR}" ] && echo -e "${GREY}Bottoken is valid ...${NC}"
|
||||
jssh_updateKeyDB "botname" "${ME}" "${BOTCONFIG}"
|
||||
rm -f "${BOTCONFIG}.jssh.flock"
|
||||
@ -1127,7 +1127,7 @@ if [ -z "${SOURCE}" ]; then
|
||||
debug_checks "end init" "$@"
|
||||
exit
|
||||
;;
|
||||
# print usage sats
|
||||
# print usage stats
|
||||
"count") echo -e "${RED}Command ${GREY}count${RED} is deprecated, use ${GREY}stats{$RED}instead.${NC}";&
|
||||
"stats")
|
||||
ME="$(getConfigKey "botname")"
|
||||
@ -1163,7 +1163,7 @@ if [ -z "${SOURCE}" ]; then
|
||||
debug_checks "end $1" "$@"
|
||||
exit
|
||||
;;
|
||||
# sedn message to all users
|
||||
# send message to all users
|
||||
'broadcast')
|
||||
ME="$(getConfigKey "botname")"
|
||||
declare -A SENDALL
|
||||
@ -1184,7 +1184,7 @@ if [ -z "${SOURCE}" ]; then
|
||||
debug_checks "end $1" "$@"
|
||||
exit
|
||||
;;
|
||||
# does what is says
|
||||
# does what it says
|
||||
"status")
|
||||
ME="$(getConfigKey "botname")"
|
||||
SESSION="${ME:-_bot}-startbot"
|
||||
@ -1199,7 +1199,7 @@ if [ -z "${SOURCE}" ]; then
|
||||
debug_checks "end status" "$@"
|
||||
;;
|
||||
|
||||
# start bot as background jod and check if bot is running
|
||||
# start bot as background job and check if bot is running
|
||||
"start")
|
||||
# shellcheck disable=SC2086
|
||||
SESSION="${ME:-_bot}-startbot"
|
||||
@ -1257,6 +1257,6 @@ if [ -z "${SOURCE}" ]; then
|
||||
# warn if root
|
||||
if [[ "${UID}" -eq "0" ]] ; then
|
||||
echo -e "\\n${ORANGE}WARNING: ${SCRIPT} was started as ROOT (UID 0)!${NC}"
|
||||
echo -e "${ORANGE}You are at HIGH RISK when running a Telegram BOT with root privilegs!${NC}"
|
||||
echo -e "${ORANGE}You are at HIGH RISK when running a Telegram BOT with root privileges!${NC}"
|
||||
fi
|
||||
fi # end source
|
||||
|
||||
2
db.json
2
db.json
@ -14,7 +14,7 @@
|
||||
"ok":
|
||||
{
|
||||
"ok":true,
|
||||
"description":"Ttest for ok"
|
||||
"description":"Test for ok"
|
||||
} ,
|
||||
"getMe":
|
||||
{
|
||||
|
||||
@ -107,8 +107,8 @@ by sourcing it:
|
||||
|
||||
*usage:* . bashbot.sh source
|
||||
|
||||
Before sourcing 'bahsbot.sh' for interactive and script use, you should export and set BASHBOT_HOME to bashbots installation dir,
|
||||
e.g. '/usr/local/telegram-bot-bash'. see [Bashbot Environemt](#Bashbot-environment)
|
||||
Before sourcing 'bashbot.sh' for interactive and script use, you should export and set BASHBOT_HOME to bashbots installation dir,
|
||||
e.g. '/usr/local/telegram-bot-bash'. see [Bashbot Environment](#Bashbot-environment)
|
||||
|
||||
**Note:** *If you don't set BASHBOT_HOME bashbot will use the actual directory as NEW home directory
|
||||
which means it will create all needed files and ask for bot token and botadmin if you are not in the real bot home!*
|
||||
|
||||
@ -15,7 +15,7 @@ To start with a clean/minimal bot copy ```mycommands.sh.clean``` to ```mycommand
|
||||
the message strings and place commands in the```case ... esac``` block of the function mycommands():
|
||||
```bash
|
||||
# file: mycommands.sh
|
||||
# your additional bahsbot commands
|
||||
# your additional bashbot commands
|
||||
|
||||
# uncomment the following lines to overwrite info and help messages
|
||||
bashbot_info='This is *MY* variant of _bashbot_, the Telegram bot written entirely in bash.
|
||||
|
||||
@ -281,7 +281,7 @@ fi
|
||||
*See also [Chat Member](https://core.telegram.org/bots/api/#chatmember)*
|
||||
|
||||
##### user_is_allowed
|
||||
Bahsbot supports User Access Control, see [Advanced Usage](3_advanced.md)
|
||||
Bashbot supports User Access Control, see [Advanced Usage](3_advanced.md)
|
||||
|
||||
*usage:* user_is_allowed "${USER[ID]}" "what" "${CHAT[ID]}"
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
## Notes for bashbot developers
|
||||
This section is about help and best practices for new bashbot developers. The main focus on is creating new versions of bashbot, modules and addons, not on develop your individual bot. Nevertheless the information provided here should help your bot development also.
|
||||
|
||||
If you want to provide fixes or new features [fork bashbot on githup](https://help.github.com/en/articles/fork-a-repo) and provide changes as [pull request on github](https://help.github.com/en/articles/creating-a-pull-request).
|
||||
If you want to provide fixes or new features [fork bashbot on github](https://help.github.com/en/articles/fork-a-repo) and provide changes as [pull request on github](https://help.github.com/en/articles/creating-a-pull-request).
|
||||
|
||||
### Debugging Bashbot
|
||||
Usually all bashbot output is discarded.
|
||||
@ -31,13 +31,13 @@ you can the change the level of verbosity of the debug argument:
|
||||
to keep 'bashbot.sh' small, while extending functionality. In addition not every function is needed by all bots, so you can
|
||||
disable modules, e.g. by rename the respective module file to 'module.sh.off'.
|
||||
|
||||
Modules must use only functions provided by 'bahsbot.sh' or the module itself and should not depend on other modules or addons.
|
||||
Modules must use only functions provided by 'bashbot.sh' or the module itself and should not depend on other modules or addons.
|
||||
The only mandatory module is 'module/sendMessage.sh'.
|
||||
|
||||
If a not mandatory module is used in 'bashbot.sh' or 'commands.sh', the use of ```_is_function``` or
|
||||
```_execute_if_function``` is mandatory to catch absence of the module.
|
||||
|
||||
**Addons** resides in ```addons/*.sh.dist``` and are not endabled by default. To activate an addon rename it to end with '.sh', e.g. by
|
||||
**Addons** resides in ```addons/*.sh.dist``` and are not enabled by default. To activate an addon rename it to end with '.sh', e.g. by
|
||||
```cp addons/example.sh.dist addons/example.sh```.
|
||||
|
||||
Addons must register themself to BASHBOT_EVENTS at startup, e.g. to call a function every time a message is received.
|
||||
@ -115,7 +115,7 @@ To avoid wrong use of EVENT_SEND, e.g. fork bomb, event processing is suspended
|
||||
*Example:*
|
||||
```bash
|
||||
# register callback:
|
||||
BAHSBOT_EVENT_SEND["example_log","1"]="example_log"
|
||||
BASHBOT_EVENT_SEND["example_log","1"]="example_log"
|
||||
EXAMPLE_LOG="${BASHBOT_ETC:-.}/addons/${EXAMPLE_ME}.log"
|
||||
|
||||
# Note: do not call any send message functions from EVENT_SEND!
|
||||
@ -130,7 +130,7 @@ example_log(){
|
||||
|
||||
Important: Bashbot timer tick is disabled by default and must be enabled by setting BASHBOT_START_TIMER to any value not zero.
|
||||
|
||||
* BAHSBOT_EVENT_TIMER executed every minute and can be used in 3 variants: oneshot, once a minute, every X minutes.
|
||||
* BASHBOT_EVENT_TIMER executed every minute and can be used in 3 variants: oneshot, once a minute, every X minutes.
|
||||
|
||||
Registering to BASHBOT_EVENT_TIMER works similar as for message events, but you must add a timing argument to the name.
|
||||
EVENT_TIMER is triggered every 60s and waits until the current running command is finished, so it's not exactly every
|
||||
@ -139,7 +139,7 @@ minute, but once a minute.
|
||||
Every time EVENT_TIMER is triggered the variable "EVENT_TIMER" is increased. each callback is executed if ```EVENT_TIMER % time``` is '0' (true).
|
||||
This means if you register an every 5 minutes callback first execution may < 5 Minutes, all subsequent executions are once every 5. Minute.
|
||||
|
||||
*usage:* BAHSBOT_EVENT_TIMER[ "name" , "time" ], where time is:
|
||||
*usage:* BASHBOT_EVENT_TIMER[ "name" , "time" ], where time is:
|
||||
|
||||
* 0 ignored
|
||||
* 1 execute once every minute
|
||||
@ -151,7 +151,7 @@ Note: If you want exact "in x minutes" use "EVENT_TIMER plus x" as time: ```-(EV
|
||||
*Example:*
|
||||
```bash
|
||||
# register callback:
|
||||
BAHSBOT_EVENT_TIMER["example_every","1"]="example_everymin"
|
||||
BASHBOT_EVENT_TIMER["example_every","1"]="example_everymin"
|
||||
|
||||
# function called every minute
|
||||
example_everymin() {
|
||||
@ -160,13 +160,13 @@ example_everymin() {
|
||||
}
|
||||
|
||||
# register other callback:
|
||||
BAHSBOT_EVENT_TIMER["example_every5","5"]="example_every5min"
|
||||
BASHBOT_EVENT_TIMER["example_every5","5"]="example_every5min"
|
||||
|
||||
# execute once on the next 10 minutes since start "event"
|
||||
BAHSBOT_EVENT_TIMER["example_10min","-10"]="example_in10min"
|
||||
BASHBOT_EVENT_TIMER["example_10min","-10"]="example_in10min"
|
||||
|
||||
# once in exact 10 minutes
|
||||
BAHSBOT_EVENT_TIMER["example_10min","$(( (EVENT_TIMER+10) * -1 ))"]="example_in10min"
|
||||
BASHBOT_EVENT_TIMER["example_10min","$(( (EVENT_TIMER+10) * -1 ))"]="example_in10min"
|
||||
|
||||
```
|
||||
|
||||
@ -297,7 +297,7 @@ To create a new test run ```test/ADD-test-new.sh``` and answer the questions, it
|
||||
Each test consists of a script script named after ```p-name-test.sh``` *(where p is test pass 'a-z' and name the name
|
||||
of your test)* and an optional dir ```p-name-test/``` *(script name minus '.sh')* for additional files.
|
||||
|
||||
Tests with no dependency to other tests will run in pass 'a', tests which need an initialized bahsbot environment must run in pass 'd' or later.
|
||||
Tests with no dependency to other tests will run in pass 'a', tests which need an initialized bashbot environment must run in pass 'd' or later.
|
||||
A temporary test environment is created when 'ALL-tests.sh' starts and deleted after all tests are finished.
|
||||
|
||||
The file ```ALL-tests.inc.sh``` must be included from all tests and provide the test environment as shell variables:
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
# copy to mycommands.sh and add all your commands an functions here ...
|
||||
export res
|
||||
|
||||
# your additional bahsbot commands ...
|
||||
# your additional bashbot commands ...
|
||||
mycommands() {
|
||||
|
||||
case "$MESSAGE" in
|
||||
|
||||
@ -24,6 +24,7 @@ unset IFS
|
||||
# discard STDIN for background jobs!
|
||||
cat >/dev/null &
|
||||
|
||||
# shellcheck source=examples/background-scripts/mycommands.sh
|
||||
source "./mycommands.sh"
|
||||
|
||||
# check if $1 is a number
|
||||
|
||||
@ -24,6 +24,8 @@ cat >/dev/null &
|
||||
|
||||
# watch for new files created by a trusted program
|
||||
WATCHDIR="/my_trusted/dir_to_watch"
|
||||
|
||||
# shellcheck source=examples/background-scripts/mycommands.sh
|
||||
source "./mycommands.sh"
|
||||
|
||||
# test your script and the remove ...
|
||||
@ -39,4 +41,3 @@ loop_callback() {
|
||||
}
|
||||
|
||||
watch_dir_loop "$WATCHDIR"
|
||||
|
||||
|
||||
@ -19,11 +19,13 @@ export 'LANGUAGE=C.UTF-8'
|
||||
unset IFS
|
||||
# set -f # if you are paranoid use set -f to disable globbing
|
||||
|
||||
# discard STDIN for background jobs!
|
||||
# shellcheck source=examples/background-scripts/mycommands.sh
|
||||
cat >/dev/null &
|
||||
|
||||
# watch for new logfiles
|
||||
WATCHDIR="/var/log"
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
source "./mycommands.sh"
|
||||
|
||||
# test your script and the remove ...
|
||||
|
||||
@ -23,8 +23,8 @@ if true; then
|
||||
else
|
||||
# alternative linux like locations
|
||||
BINDIR="/usr/local/bin"
|
||||
ETC="/etc/bahsbot"
|
||||
VAR="/var/bahsbot"
|
||||
ETC="/etc/bashbot"
|
||||
VAR="/var/bashbot"
|
||||
export BASHBOT_JSONSH="/usr/local/bin/JSON.sh"
|
||||
|
||||
fi
|
||||
|
||||
@ -206,7 +206,7 @@ else
|
||||
my_startup
|
||||
fi
|
||||
|
||||
# your additional bahsbot commands
|
||||
# your additional bashbot commands
|
||||
# NOTE: command can have @botname attached, you must add * in case tests...
|
||||
mycommands() {
|
||||
# a service Message was received
|
||||
|
||||
@ -32,7 +32,7 @@ bashbot_help='*Available commands*:
|
||||
'
|
||||
|
||||
|
||||
# your additional bahsbot commands
|
||||
# your additional bashbot commands
|
||||
# NOTE: command can have @botname attached, you must add * in case tests...
|
||||
mycommands() {
|
||||
local msg=""
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user