Merge branch 'develop' into master

Author: gnadelwartz

README.html

@@ -392,6 +392,6 @@ <h3>Blocked by telegram?</h3>
 <p>@Gnadelwartz</p>
 <h2>That's it all guys!</h2>
 <p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p>
-<h4>$$VERSION$$ v1.40-dev-34-g1440d56</h4>
+<h4>$$VERSION$$ v1.41-0-gad1b91f</h4>
 </body>
 </html>

README.md

@@ -241,4 +241,4 @@ See `mycommnds.sh.dist` for an example.
 
 If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
 
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.41-0-gad1b91f

README.txt

@@ -318,5 +318,5 @@ That's it all guys!
 If you feel that there's something missing or if you found a bug, feel free to submit a
 pull request!
 
-$$VERSION$$ v1.40-dev-34-g1440d56
+$$VERSION$$ v1.41-0-gad1b91f
 

bashbot.sh

@@ -30,7 +30,7 @@ BOTCOMMANDS="-h  help  init  start  stop  status  suspendback  resumeback  killb
 #     8 - curl/wget missing
 #     10 - not bash!
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-26-g82a57a7
 ##################################################################
 
 # are we running in a terminal?
@@ -99,11 +99,15 @@ getConfigKey() {
 	[[ "$1" =~ ^[-${azAZo9},._]+$ ]] || return 3
 	[ -r "${BOTCONFIG}.jssh" ] && sed -n 's/\["'"$1"'"\]\t*"\(.*\)"/\1/p' "${BOTCONFIG}.jssh" | tail -n 1
 }
-# escape / remove text characters for json strings, eg. " -> \" 
-# $1 string
-# output escaped string
+# escape characters in json strings for telegram 
+# $1 string, output escaped string
 JsonEscape(){
-	sed 's/\([-"`´,§$%&/(){}#@!?*.\t]\)/\\\1/g' <<< "$1"
+	sed -E -e 's/\r//g' -e 's/([-"`´,§$%&/(){}#@!?*.\t])/\\\1/g' <<< "${1//$'\n'/\\n}"
+}
+# clean \ from escaped json string
+# $1 string, output cleaned string
+cleanEscaped(){	# remove "	all \ but  \n\u		\n or \r
+	sed -E -e 's/\\"/+/g' -e 's/\\([^nu])/\1/g' -e 's/(\r|\n)//g' <<<"$1"
 }
 # check if $1 seems a valid token
 # return true if token seems to be valid
@@ -157,7 +161,7 @@ debug_checks(){ {
 	[ -z "$(getConfigKey "botadmin")" ] && printf "%(%c)T: %s\n" -1 "Bot admin is missing! =========="
 	# call user defined debug_checks if exists
 	_exec_if_function my_debug_checks "$(_date)" "${where}" "$*"
-	} >>"${DEBUGLOG}"
+	} 2>/dev/null >>"${DEBUGLOG}"
 }
 
 # some Linux distributions (e.g. Manjaro) doesn't seem to have C locale activated by default
@@ -174,10 +178,10 @@ RUNDIR="$(dirname "$0")"
 MODULEDIR="${SCRIPTDIR}/modules"
 
 # adjust stuff for source, use return from source without source
-alias exit_source='exit'
+exit_source() { exit "$1"; }
 if [[ "${SCRIPT}" != "${REALME}" || "$1" == "source" ]]; then
 	SOURCE="yes"
-	[ -z "$1" ] && alias exit_source='printf "Exit from source ...\n";return'
+	[ -z "$1" ] && exit_source() { printf "Exit from source ...\n"; return "$1"; }
 fi
 
 # emmbeded system may claim bash but it is not
@@ -271,6 +275,7 @@ if [ -z "${BOTTOKEN}" ]; then
      [ -z "${admin}" ] && admin='?'
      printf '["botadmin"]\t"%s"\n'  "${admin}" >> "${BOTCONFIG}.jssh"
   fi
+
   # setup botacl file
   if [ ! -f "${BOTACL}" ]; then
 	printf "${GREY}Create initial ${BOTACL} file.${NN}"
@@ -279,15 +284,14 @@ if [ -z "${BOTTOKEN}" ]; then
   # check data dir file
   if [ ! -w "${DATADIR}" ]; then
 	printf "${RED}ERROR: ${DATADIR} does not exist or is not writeable!.${NN}"
-	exit_source 2
+	[ "$1" != "init" ] && exit_source 2 # skip on init
   fi
   # setup count file 
   if [ ! -f "${COUNTFILE}.jssh" ]; then
 	printf '["counted_user_chat_id"]\t"num_messages_seen"\n' >> "${COUNTFILE}.jssh"
   elif [ ! -w "${COUNTFILE}.jssh" ]; then
-	printf "${RED}ERROR: Can't write to ${COUNTFILE}!.${NN}"
+	printf "${RED}WARNING: Can't write to ${COUNTFILE}!.${NN}"
 	ls -l "${COUNTFILE}.jssh"
-	exit_source 2
   fi
   # setup blocked file 
   if [ ! -f "${BLOCKEDFILE}.jssh" ]; then
@@ -342,6 +346,7 @@ fi
 BASHBOT_RETRY=""	# retry by default
 
 URL="${BASHBOT_URL:-https://api.telegram.org/bot}${BOTTOKEN}"
+FILEURL="${URL%%/bot*}/file/bot${BOTTOKEN}"
 ME_URL=${URL}'/getMe'
 
 #################
@@ -388,16 +393,6 @@ if ! _is_function jssh_newDB; then
 	exit_source 6
 fi
 
-# $1 URL, $2 filename in DATADIR
-# outputs final filename
-download() {
-	local empty="no.file" file="${2:-${empty}}"
-	if [[ "${file}" = *"/"* ]] || [[ "${file}" = "."* ]]; then file="${empty}"; fi
-	while [ -f "${DATADIR:-.}/${file}" ] ; do file="${RANDOM}-${file}"; done
-	getJson "$1" >"${DATADIR:-.}/${file}" || return
-	printf '%s\n' "${DATADIR:-.}/${file}"
-}
-
 # $1 postfix, e.g. chatid
 # $2 prefix, back- or startbot-
 procname(){
@@ -425,19 +420,56 @@ killallproc() {
 	debug_checks "end killallproc" "$1"
 }
 
-
-# $ chat $2 msg_id $3 nolog
-declare -xr DELETE_URL=${URL}'/deleteMessage'
-delete_message() {
-	[ -z "$3" ] && log_update "Delete Message CHAT=$1 MSG_ID=$2"
-	sendJson "$1" '"message_id": '"$2"'' "${DELETE_URL}"
-}
-
-# get download url for file id, $1 file_id
+# URL path for file id, $1 file_id
+# use download_file "path" to  download file
 get_file() {
 	[ -z "$1" ] && return
 	sendJson ""  '"file_id": "'"$1"'"' "${URL}/getFile"
-	printf "%s\n" "${URL}/${UPD["result,file_path"]}"
+	printf "%s\n" "${UPD["result,file_path"]}"
+}
+# download file to DATADIR
+# $1 URL path, $2 proposed filename (may modified/ignored)
+# outputs final filename
+# keep old function name for backward compatibility
+alias download="download_file"
+download_file() {
+	local url="$1" file="${2:-$1}"
+	# old mode if full URL is given
+	if [[  "${1}" =~ ^https*:// ]]; then
+	   # random filename if not given for http
+	   if [ -z "$2" ]; then
+		: "$(mktemp -u  -p . "XXXXXXXXXX" 2>/dev/null)"
+		file="download-${_#./}"
+	  fi
+	else
+		# prefix https://api.telegram...
+		url="${FILEURL}/${url}"
+	fi
+	# filename: replace "/" with "-", use mktemp if exist
+	file="${DATADIR:-.}/${file//\//-}"
+	[ -f "${file}" ] && file="$(mktemp -p "${DATADIR:-.}" "XXXXX-${file##*/}" )"
+	getJson "${url}" >"${file}" || return
+	# output absolute file path
+	printf "%s\n" "$(cd "${file%/*}" >/dev/null 2>&1 && pwd)/${file##*/}"
+}
+# notify mycommands about errors while sending
+# $1 calling function  $2 error $3 chat $4 user $5 error message $6 ... remaining args to calling function
+# calls function based on error: bashbotError{function} basbotError{error}
+# if no specific function exist try to call bashbotProcessError
+processError(){
+	local func="$1" err="$2"
+	[[ "${err}" != "4"* ]] && return 1
+	# check for bashbotError${func} provided in mycommands
+	# shellcheck disable=SC2082
+	if _is_function "bashbotError_${func}"; then 
+		"bashbotError_${func}" "$@"
+	# check for bashbotError${err} provided in mycommands
+	elif _is_function "bashbotError_${err}"; then 
+		"bashbotError_${err}" "$@"
+	# noting found, try bashbotProcessError
+	else
+		_exec_if_function bashbotProcessError "$@"
+	fi
 }
 
 # iconv used to filter out broken utf characters, if not installed fake it
@@ -461,7 +493,7 @@ sendJson(){
 	if [ -n "${BASHBOTDEBUG}" ] ; then
 		log_update "sendJson (${DETECTED_CURL}) CHAT=${chat#*:} JSON=${2:0:100} URL=${3##*/}"
 		#									mask " and \ , remove newline from json
-		log_message "DEBUG sendJson ==========\n$("${JSONSHFILE}" -b -n  <<<"$(sed -E -e 's/\\"/+/g' -e 's/\\/\\\\/g' -e 's/(\r|\n)//g' <<<"${json}")" 2>&1)"
+		log_message "DEBUG sendJson ==========\n$("${JSONSHFILE}" -b -n  <<<"$(cleanEscaped "${json}")" 2>&1)"
 	fi
 	# chat id not a number
 	if [[ "${chat}" == *"NAN\"," ]]; then
@@ -477,6 +509,36 @@ sendJson(){
 	[ -n "${BASHBOT_EVENT_SEND[*]}" ] && event_send "send" "${@}" &
 }
 
+UPLOADDIR="${BASHBOT_UPLOAD:-${DATADIR}/upload}"
+
+# $1 chat $2 file, $3 calling function
+# return final file name or empty string on error
+checkUploadFile() {
+	local err file="$2"
+	[[ "${file}" = *'..'* || "${file}" = '.'* ]] && err=1 	# no directory traversal
+	if [[ "${file}" = '/'* ]] ; then
+		[[ ! "${file}" =~ ${FILE_REGEX} ]] && err=2	# absolute must match REGEX
+	else
+		file="${UPLOADDIR:-NOUPLOADDIR}/${file}"	# others must be in UPLOADDIR
+	fi
+	[ ! -r "${file}" ] && err=3	# and file must exits of course
+	# file path error, generate error response
+	if [ -n "${err}" ]; then
+	    BOTSENT=(); BOTSENT[OK]="false"
+	    case "${err}" in
+		1) BOTSENT[ERROR]="Path to file $2 contains to much '../' or starts with '.'";;
+		2) BOTSENT[ERROR]="Path to file $2 does not match regex: ${FILE_REGEX} ";;
+		3) if [[ "$2" == "/"* ]];then
+			BOTSENT[ERROR]="File not found: $2"
+		   else
+			BOTSENT[ERROR]="File not found: ${UPLOADDIR}/$2"
+		   fi;;
+	    esac
+	    [ -n "${BASHBOTDEBUG}" ] && log_debug "$3: CHAT=$1 FILE=$2 MSG=${BOTSENT[DESCRIPTION]}"
+	    return 1
+	fi
+}
+
 
 #
 # curl / wget specific functions

bin/any_command.sh

@@ -21,7 +21,7 @@ USAGE='any_command.sh [-h|--help] [--force|--reference] bot_command args ...'
 #        AUTHOR: KayM (gnadelwartz), [email protected]
 #       CREATED: 30.01.2021 10:24
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-7-ga9ed559
 #===============================================================================
 
 ####

bin/bashbot_init.inc.sh

@@ -5,13 +5,13 @@
 # 
 #         USAGE: source bashbot_init.inc.sh
 #
-#   DESCRIPTION: extend / overwrite bashbot initialisation 
+#   DESCRIPTION: extend / overwrite bashbot initialisation
 # 
 #	LICENSE: WTFPLv2 http://www.wtfpl.net/txt/copying/
 #        AUTHOR: KayM (gnadelwartz), [email protected]
 #       CREATED: 27.01.2021 13:42
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-3-g429c230
 #===============================================================================
 # shellcheck disable=SC2059
 
@@ -54,17 +54,23 @@ bot_init() {
 		[ -r "${addons}" ] && source "${addons}" "init" "${DEBUG}"
 	done
 	printf "Done.\n"
-	# ask for bashbot user
-	# shellcheck disable=SC2153
-	runuser="${RUNUSER}"; [ "${UID}" = "0" ] && runuser="nobody"
+	# guess bashbot from botconfig.jssh owner:group
+	[ -f "${BOTCONFIG}.jssh" ] && runuser="$(stat -c '%U' "${BOTCONFIG}.jssh"):$(stat -c '%G' "${BOTCONFIG}.jssh")"
+	# empty or ":" use user running init, nobody for root
+	if [ "${#runuser}" -lt 3 ]; then
+		# shellcheck disable=SC2153
+		runuser="${RUNUSER}"
+		[ "${UID}" = "0" ] && runuser="nobody"
+	fi
 	printf "Enter User to run bashbot [${runuser}]: "
 	read -r chown
-	[ -z "${chown}" ] && chown="${runuser}"; touser="${chown%:*}"
+	[ -z "${chown}" ] && chown="${runuser}"
+	touser="${chown%:*}"
 	# check user ...
 	if ! id "${touser}" &>/dev/null; then
 		printf "${RED}User \"${touser}\" does not exist!${NN}"
 		exit 3
-	elif [[ "${UID}" != "0" && "${touser}" != "${runuser}" ]]; then
+	elif [ "${UID}" != "0" ]; then
 		# different user but not root ...
 		printf "${ORANGE}You are not root, adjusting permissions may fail. Try \"sudo ./bashbot.sh init\"${NN}Press <CTRL+C> to stop or <Enter> to continue..." 1>&2
 		[ -n "${INTERACTIVE}" ] && read -r runuser
@@ -98,13 +104,13 @@ bot_init() {
 	fi
 	# adjust permissions
 	printf "Adjusting files and permissions for user \"${touser}\" ...\n"
+	chown -Rf "${chown}" . ./*
 	chmod 711 .
 	chmod -R o-w ./*
 	chmod -R u+w "${COUNTFILE}"* "${BLOCKEDFILE}"* "${DATADIR}" logs "${LOGDIR}/"*.log 2>/dev/null
 	chmod -R o-r,o-w "${COUNTFILE}"* "${BLOCKEDFILE}"* "${DATADIR}" "${BOTACL}" 2>/dev/null
 	# jsshDB must writeable by owner
 	find . -name '*.jssh*' -exec chmod u+w \{\} +
-	chown -Rf "${chown}" . ./*
 	printf "Done.\n"
 	# adjust values in bashbot.rc
 	if [ -w "bashbot.rc" ]; then

bin/process_update.sh

@@ -15,7 +15,7 @@ USAGE='process_update.sh [-h|--help] [debug] [<file]'
 #        AUTHOR: KayM (gnadelwartz), [email protected]
 #       CREATED: 30.01.2021 19:14
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-30-g8efbfca
 #===============================================================================
 
 ####

bin/send_dice.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+# shellcheck disable=SC1090,SC2034
+#===============================================================================
+#
+#          FILE: bin/send_dice.sh
+#
+USAGE='send_dice.sh [-h|--help] "CHAT[ID]" "emoji" [debug]'
+# 
+#   DESCRIPTION: send an animated emoji (dice) to given chat
+# 
+#       OPTIONS: CHAT[ID] - ID number of CHAT or BOTADMIN to send to yourself
+#                emoji - must be one of: “🎲”, “🎯”, “🏀”, “⚽”, or “🎰”
+#                        ":game_die:" ":dart:" ":basketball:" ":soccer:" :slot_machine:"
+#
+#                -h - display short help
+#                --help -  this help
+#
+#                Set BASHBOT_HOME to your installation directory
+#
+#	LICENSE: WTFPLv2 http://www.wtfpl.net/txt/copying/
+#        AUTHOR: KayM (gnadelwartz), [email protected]
+#       CREATED: 07.02.2021 18:45
+#
+#### $$VERSION$$ v1.45-dev-8-g069570e
+#===============================================================================
+
+####
+# parse args
+SEND="send_dice"
+
+# set bashbot environment
+source "${0%/*}/bashbot_env.inc.sh" "${3:-debug}" # $5 debug
+print_help "$1"
+
+####
+# ready, do stuff here -----
+if [ "$1" == "BOTADMIN" ]; then
+	CHAT="${BOT_ADMIN}"
+else
+	CHAT="$1"
+fi
+
+# send message in selected format
+"${SEND}" "${CHAT}" "$2"
+
+# output send message result
+print_result

commands.sh

@@ -15,7 +15,7 @@
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-9-g62b6b61
 #
 
 # bashbot locale defaults to c.UTF-8, adjust locale in mycommands.sh if needed
@@ -42,10 +42,12 @@ bashbot_help='
 *• /start*: _Start bot and get this message_.
 *• /help*: _Get this message_.
 *• /info*: _Get shorter info message about this bot_.
-*• /question*: _Start interactive chat (mycommands.dist)_.
-*• /cancel*: _Cancel any currently running interactive chat_.
 *• /kickme*: _You will be autokicked from the group_.
 *• /leavechat*: _The bot will leave the group with this command _.
+Additional commands from mycommands.dist ...
+*• /game*: _throw a die_.
+*• /question*: _Start interactive chat_.
+*• /cancel*: _Cancel any currently running interactive chat_.
 Written by Drew (@topkecleon) and KayM (@gnadelwartz).
 Get the code in my [GitHub](http://github.com/topkecleon/telegram-bot-bash)
 '

dev/all-tests.sh

@@ -5,7 +5,7 @@
 #
 # Description: run all tests, exit after failed test
 #
-#### $$VERSION$$ v1.40-0-gf9dab50
+#### $$VERSION$$ v1.45-dev-21-ge67e43d
 #############################################################
 
 #shellcheck disable=SC1090