matrix.sh

#!/usr/bin/env bash
#set -x

# Needed for the strip-HTML-from-string-Regexp-like stuff.
shopt -s extglob
VERSION="1.4"
LOG="true"
SAVEIFS=$IFS
IFS=$(echo -en "\n\b")

AUTHORIZATION="X-Dummy: 1"

version() {
        cat <<VERSION_EOF
matrix.sh $VERSION
created by Fabian Schlenz
improved with contributions by Martin Goellnitz, Martin Winkler, johncoffee, and Cédric Barreteau
VERSION_EOF
}

help() {
        version
        echo
        echo "Usage:"
        echo "$0 <action> [<options>] [<message>]"
        echo
        echo "ACTIONS"
        echo "  --login                [*] Login to a server."
        echo "  --list-rooms               List rooms the matrix user joined or is invited to."
        echo "  --select-default-room  [*] Select a default room."
        echo "  --join-room            [*] Joins a room."
        echo "  --leave-room           [*] Leaves a room."
        echo "  --invite-user          [*] Invites a user to a room."
        echo "  --change-name          [*] Changes the display name of the matrix user."
        echo "  --send                     Send a message. [DEFAULT]"
        echo "  --help                     Show this help."
        echo
        echo "OPTIONS"
        echo "  --token=<token>            Access token to use. Only useful if you don't want to use --login."
        echo "  --homeserver=<url>         Homeserver address to use. Only useful if you don't want to use --login. Must start with \"https\". Must not have a trailing slash."
        echo "  --room=<room_id>           Which room to send the message to."
        echo "  --notice                   Send a notice instead of a message."
        echo "  --html                     Enable HTML tags in message."
        echo "  --pre                      Wraps the given message into <pre> and escapes all other HTML special chars."
        echo "  --toroom                   Sends the message to the whole room, is user has permition to do so (@room is automatically added to the beggining of the message, as well as the entire room mention)"
        echo "  --file=<file>              Send <file> to the room.  If <message> is provided, the file is uploaded with that name."
        echo "  --image                    Send the file as image. If <message> is provided, it's used as a caption"
        echo "  --audio                    Send the file as audio. If <message> is provided, it's used as a caption"
        echo "  --video                    Send the file as video. If <message> is provided, it's used as a caption"
        echo "  --identifier=<ident>       Custom identifier for this device. Default is '`whoami`@`hostname` using matrix.sh'."
        echo
        echo "Actions marked with [*] are done interactively."
        echo
        echo "If <message> is \"-\", stdin is used."
        echo "See https://matrix.org/docs/spec/client_server/latest.html#m-room-message-msgtypes for a list of valid HTML tags for use with --html."
        echo
}

_curl() {
        #log "AUTH $AUTHORIZATION"
        #log "VER $VERSION"
        curl -s -H "$AUTHORIZATION" -H "User-Agent: matrix.sh/$VERSION" "$@"
}

die() {
        >&2 echo "$1"
        exit 1
}

log() {
        "$LOG" && echo "$1"
}

get() {
        url="$1"
        shift
        log "GET $url"
        response=$(_curl "$@" "${MATRIX_HOMESERVER}${url}")
        log "RESPONSE $response"
}

query() {
        url="$1"
        data="$2"
        type="$3"
        log ">>>>> $type $url"
        log ">>>>> $data"
        response=$( _curl -X"$type" -H "Content-Type: application/json" --data "$data" "${MATRIX_HOMESERVER}${url}" )
        echo $response
        if [ ! $(jq -r .errcode <<<"$response") == "null" ]; then
                echo
                >&2 echo "An error occurred. The matrix server responded with:"
                >&2 echo "$(jq -r .errcode <<<"$response"): $(jq -r .error <<<"$response")"
                >&2 echo "Following request was sent to ${url}:"
                >&2 jq . <<<"$data"
                exit 1
        fi
}

post() {
        query "$1" "$2" "POST"
}

put() {
        query "$1" "$2" "PUT"
}

upload_file() {
        file="$1"
        content_type="$2"
        filename="$3"
        echo "Uploading $file ... named as $filename with content_type as $content_type"
        response=$( _curl -XPOST -H "Content-Type: $content_type" --data-binary "@$file"  "${MATRIX_HOMESERVER}/_matrix/media/r0/upload?filename=${filename}" )
}

escape() {
        local multil=
        [ $(echo "$1" | wc -l) -gt 1 ] && multil="-s"
        jq $multil -R . <<<"$1"
}

############## Check for dependencies
hash jq >/dev/null 2>&1 || die "jq is required, but not installed."
hash curl >/dev/null 2>&1 || die "curl is required, but not installed."

############## Logic
login() {
        read -p "Address of the homeserver the account lives on: " MATRIX_HOMESERVER
        MATRIX_HOMESERVER="https://${MATRIX_HOMESERVER#https://}"
        MATRIX_HOMESERVER="${MATRIX_HOMESERVER%/}" # Strip trailing slash
        ident=`escape "$IDENTIFIER"`
        log "Trying homeserver: $MATRIX_HOMESERVER"
        if ! get "/_matrix/client/versions" --fail ; then
                if ! get "/.well-known/matrix/server" --fail ; then
                        die "$MATRIX_HOMESERVER does not appear to be a matrix homeserver. Trying /.well-known/matrix/server failed. Please ask your homeserver's administrator for the correct address of the homeserver."
                fi
                MATRIX_HOMESERVER=`jq -r '.["m.server"]' <<<"$response"`
                MATRIX_HOMESERVER="https://${MATRIX_HOMESERVER#https://}"
                log "Delegated to home server $MATRIX_HOMESERVER."
                if ! get "/_matrix/client/versions"; then
                        die "Delegation led us to $MATRIX_HOMESERVER, but it does not appear to be a matrix homeserver. Please ask your homeserver's administrator for the correct address of the server."
                fi
        fi

        read -p "Username on the server (just the local part, so e.g. 'bob'): " username
        read -sp "${username}'s password: " password
        echo
        post "/_matrix/client/r0/login" "{\"type\":\"m.login.password\", \"identifier\":{\"type\":\"m.id.user\",\"user\":\"${username}\"},\"password\":\"${password}\",\"initial_device_display_name\":$ident}"

        data="MATRIX_TOKEN=\"`jq -r .access_token <<<"$response"`\"\nMATRIX_HOMESERVER=\"${MATRIX_HOMESERVER%/}\"\nMATRIX_USER=\"`jq -r .user_id <<<"$response"`\"\n"
        echo -e "$data" > ~/.matrix.sh
        chmod 600 ~/.matrix.sh
        source ~/.matrix.sh

        echo
        echo "Success. Access token saved to ~/.matrix.sh."
        echo "You should now use $0 --select-default-room to select a default room."
}

list_rooms() {
        echo "Getting Rooms..."
        get '/_matrix/client/r0/sync'

        local rooms=$(jq -r '.rooms.join | (to_entries[] | "  \(.key) - \(((.value.state.events + .value.timeline.events)[] | select(.type=="m.room.name") | .content.name) // "<Unnamed>")") // "  NONE"' <<<"$response" 2>/dev/null)
        if [ -z "$rooms" ]; then
                echo "I have not joined any rooms yet"
        else
                echo "Joined rooms:"
                echo "$rooms"
        fi
        local roomsInv=$(jq -r '.rooms.invite | (to_entries[] | "  \(.key) - \((.value.invite_state.events[] | select(.type=="m.room.name") | .content.name) // "Unnamed")") // "  NONE"' <<<"$response" 2>/dev/null)
        echo
        if [ -z "$roomsInv" ]; then
                echo "I'm not invited into any rooms"
        else
                echo "Rooms I'm invited to:"
                echo "$roomsInv"
        fi
}

select_room() {
        list_rooms
        echo "Which room do you want to use?"
        read -p "Enter the room_id (the thing at the beginning of the line): " room

        # The chosen could be a room we are only invited to. So we send a join command.
        # If we already are a member of this room, nothing will happen.
        post "/_matrix/client/r0/rooms/$room/join"

        echo -e "MATRIX_ROOM_ID=\"$room\"\n" >> ~/.matrix.sh
        echo
        echo "Saved default room to ~/.matrix.sh"
}

join_room() {
        read -p "Enter the ID or address of the room you want me to join: " room
        post "/_matrix/client/r0/rooms/$room/join"
        echo "Success."
}

leave_room() {
        list_rooms
        read -p "Enter the ID of the room you want me to leave: " room
        [ "$room" = "$MATRIX_ROOM_ID" ] && die "It appears you are trying to leave the room that is currently set as default room. I'm sorry Dave, but I can't allow you to do that."
        post "/_matrix/client/r0/rooms/$room/leave"
        echo "Success."
}

invite_user() {
        read -p "Enter the user ID you want to invite: " user
        post "/_matrix/client/r0/rooms/$MATRIX_ROOM_ID/invite" "{\"user_id\":\"$user\"}"
        echo "Success."
}

change_name() {
        echo "Changing my name."
        get "/_matrix/client/r0/account/whoami"
        user_id=`jq -r ".user_id" <<< "$response"`
        get "/_matrix/client/r0/profile/$user_id/displayname"
        echo "Old name: `jq -r ".displayname" <<< "$response"`"
        read -p "New name: " name
        put "/_matrix/client/r0/profile/$user_id/displayname" "{\"displayname\": `escape "$name"`}"
}

_send_message() {
        data="$1"
        txn=`date +%s%N`
        put "/_matrix/client/v3/rooms/$MATRIX_ROOM_ID/send/m.room.message/$txn" "$data"
}

send_message() {
        # Get the text. Try the last variable
        echo "Sending message..."
        text="$1"
        [ "$text" = "-" ] && text=$(</dev/stdin)
        if $TOROOM; then
            text="@room $text"
        fi
        if $PRE; then
                text="${text//</&lt;}"
                text="${text//>/&gt;}"
                text="<pre>$text</pre>"
                HTML="true"
        fi

        text=`escape "$text"`

        if $HTML; then
                clean_body="${text//<+([a-zA-Z0-9\"\'= \/])>/}"
                clean_body=`escape "$clean_body"`
                if $TOROOM; then
                    data="{\"body\": $clean_body, \"m.mentions\": {\"room\": true}, \"msgtype\":\"$MESSAGE_TYPE\",\"formatted_body\":$text,\"format\":\"org.matrix.custom.html\"}"
                else
                    data="{\"body\": $clean_body, \"msgtype\":\"$MESSAGE_TYPE\",\"formatted_body\":$text,\"format\":\"org.matrix.custom.html\"}"
                fi
        else
                if $TOROOM; then
                    data="{\"body\": $text, \"m.mentions\": {\"room\": true}, \"msgtype\":\"m.text\"}"
                else
                    data="{\"body\": $text, \"msgtype\":\"m.text\"}"
                fi
        fi
        _send_message "$data"
}

send_file() {
        echo "Sending file... $FILE"
        echo "Text is... $TEXT"
        [ ! -e "$FILE" ] && die "File $FILE does not exist."

        # Query max filesize from server
        get "/_matrix/media/r0/config"
        max_size=$(jq -r ".[\"m.upload.size\"]" <<<"$response")
        # Cross platform check (https://en.wikipedia.org/wiki/Uname)
        case "$(uname -s)" in
          Darwin*) # OSX
            size=$(stat -f%z "$FILE");;
          *)
            size=$(stat --printf="%s" "$FILE");;
        esac
        if (( size > max_size )); then
                die "File is too big. Size is $size, max_size is $max_size."
        fi
        filename=$(basename "$FILE")
        extension="${filename##*.}"
        log "filename: $filename $extension"
        content_type=$(file --brief --mime-type "$FILE")
        original_content_type=$content_type
        is_animated="false"

        #Thumbnails
        if [[ $FILE_TYPE == "m.image" ]]; then
                #blurhash=$(/usr/local/bin/blurhash_encoder 4 3 "$FILE")
                if [[ $extension == "gif" ]]; then
                        log "GIF"
                        imgwidth=$(identify -format "%w" "$FILE"[0])
                        imgheight=$(identify -format "%h" "$FILE"[0])
                        log "$imgwidth x $imgheight"

                        #Thumbnails
                        tmbwidth=800                                                            #Desired thumbnail width
                        tmbheight=$(( (imgheight * tmbwidth) / imgwidth ))
                        tmbsize=$(( (tmbwidth * size) / imgwidth ))                             #Height is calculated to keep proportion
                        curdir=$(pwd)                                                           #Save current dir.
                        tmbname="thumb-${filename}.png"                                         #Generate a thumbname from the filename
                        tmb_content_type='image/png'                                            #Thumbnail content type

                        # Get the total number of frames in the GIF
                        TOTAL_FRAMES=$(identify -format "%n\n" "$FILE" | head -n 1)
                        # Calculate the target frame index
                        FRAME_INDEX=$(echo "$TOTAL_FRAMES * 10 / 100" | bc) #10 for 10% of the GIF
                        FRAME_INDEX=${FRAME_INDEX%.*}  # Ensure it's an integer
                        # Ensure FRAME_INDEX is within bounds
                        if [ "$FRAME_INDEX" -ge "$TOTAL_FRAMES" ]; then
                          FRAME_INDEX=$((TOTAL_FRAMES - 1))
                        fi
                        # Extract the frame
                        convert "$FILE"["$FRAME_INDEX"] -quality 90 -coalesce /tmp/$tmbname

                        #Calculate the blurhash for it
                        blurhash=$(/usr/local/bin/blurhash_encoder 8 8 /tmp/$tmbname)

                        log "Uploading thumbnail... blurhash is $blurhash, content type is $tmb_content_type"
                        upload_file "/tmp/$tmbname" "$tmb_content_type" "$tmbname"
                        tmburi=$(jq -r .content_uri <<<"$response")
                        filename=$(basename "$FILE")
                        #log "$FILE has been thumbnailed to $tmbwidth X $tmbheight, and named as $tmbname"
                        #log "Response was: $response"
                        #log "$FILE will be uploaded as $filename, it has $imgwidth X $imgheight"
                        is_animated="true"
                else
                        log "NOT GIF"
                        imgwidth=$(identify -format "%w" "$FILE")
                        imgheight=$(identify -format "%h" "$FILE")
                        log "$imgwidth x $imgheight"
                        tmbwidth=300
                        tmbheight=$(( (imgheight * tmbwidth) / imgwidth ))
                        tmbsize=$(( (tmbwidth * size) / imgwidth ))
                        curdir=$(pwd)
                        #cd /tmp
                        tmbname="thumb-${filename}"                                                                                                             #Generate a thumbname from the filename
                        convert $FILE -thumbnail $tmbwidth\x$tmbheight -quality 70 /tmp/$tmbname                                                                #Convert the file to a thumb
                        blurhash=$(/usr/local/bin/blurhash_encoder 8 8 /tmp/$tmbname)                                                                           #Generate blurhash from thumb
                        tmb_content_type=$content_type
                        log "Content Type: $tmb_content_type"
                        log "Uploading thumbnail... blurhash is $blurhash, content type is $tmb_content_type"
                        upload_file "/tmp/$tmbname" "$tmb_content_type" "$tmbname"
                        tmburi=$(jq -r .content_uri <<<"$response")
                        filename=$(basename "$FILE")
                        log "$FILE has been thumbnailed to $tmbwidth X $tmbheight, and named as $tmbname"
                        log "Response was: $response"
                        log "$FILE will be uploaded as $filename, it has $imgwidth X $imgheight"

                fi
        fi

        if [[ $FILE_TYPE == "m.video" ]] ; then
                #get video info
                vidwidth=$(ffprobe -v error -select_streams v:0 -show_entries stream=width -of csv=p=0 "$FILE")
                vidheight=$(ffprobe -v error -select_streams v:0 -show_entries stream=height -of csv=p=0 "$FILE")
                ovidduration=$(ffprobe -v error -select_streams v:0 -show_entries stream=duration -of csv=p=0 "$FILE")
                echo "Duration:"
                echo $ovidduration

                vidduration=$(echo "$ovidduration * 1000" | bc)
                vidduration="${vidduration%.*}" #milliseconds, only integers
                echo "Final:"
                echo $vidduration

                #calculate thumbnail info
                tmbwidth=200
                tmbheight=$(( (vidheight * tmbwidth) / vidwidth ))
                tmbsize=$(( (tmbwidth * size) / vidwidth ))
                curdir=$(pwd)
                tmbname="thumb-${filename}.jpg"
                #extract frame for thumbnail
                tmbduration=$(echo "$ovidduration / 10" | bc ) #10% point of the movie
                tmbduration="${tmbduration%.*}" #seconds, only integers
                echo "Thumbnail point"
                echo $tmbduration
                echo ffmpeg -ss $tmbduration -i "$FILE" -vframes 1 -q:v 2 /tmp/${tmbname}
                ffmpeg -ss $tmbduration -i "$FILE" -vframes 1 -q:v 2 /tmp/${tmbname}
                #get the blurhash from the thumbnail
                blurhash=$(/usr/local/bin/blurhash_encoder 8 8 /tmp/$tmbname)
                #upload it
                log "Uploading thumbnail... blurhash is $blurhash"
                upload_file "/tmp/$tmbname" "image\/jpeg" "$tmbname"
                tmburi=$(jq -r .content_uri <<<"$response")
                filename=$(basename "$FILE")
        fi

        log "content-type: $original_content_type"
        log "filename: $filename"
        upload_file "$FILE" "$original_content_type" "$filename"
        uri=$(jq -r .content_uri <<<"$response")

        #Default data
        if [ "$TEXT" = "" ]; then
                data="{\"body\":$(escape "$filename"), \"msgtype\":\"$FILE_TYPE\", \"url\":\"$uri\", \"info\":{\"mimetype\":\"$content_type\", \"size\":$size}}"
        else
                data="{\"body\":\"$TEXT\", \"msgtype\":\"$FILE_TYPE\", \"url\":\"$uri\", \"info\":{\"mimetype\":\"$content_type\", \"size\":$size}}"
        fi

        #If it's a image...
        if [[ $FILE_TYPE == "m.image" ]]; then
                if [ "$TEXT" = "" ]; then
                        data="{\"info\":{\"mimetype\":\"$content_type\", \"org.matrix.msc4230.is_animated\": $is_animated, \"thumbnail_info\":{\"w\":$tmbwidth, \"h\":$tmbheight, \"mimetype\":\"$tmb_content_type\", \"size\":$tmbsize }, \"size\":$size, \"w\":$imgwidth, \"h\":$imgheight, \"xyz.amorgan.blurhash\":\"$blurhash\", \"thumbnail_url\":\"$tmburi\"}, \"body\":$(escape "$filename"), \"msgtype\":\"$FILE_TYPE\", \"filename\":$(escape "$filename"), \"url\":\"$uri\"}"
                        rm "/tmp/$tmbname"
                else
                        data="{\"info\":{\"mimetype\":\"$content_type\", \"org.matrix.msc4230.is_animated\": $is_animated, \"thumbnail_info\":{\"w\":$tmbwidth, \"h\":$tmbheight, \"mimetype\":\"$tmb_content_type\", \"size\":$tmbsize }, \"size\":$size, \"w\":$imgwidth, \"h\":$imgheight, \"xyz.amorgan.blurhash\":\"$blurhash\", \"thumbnail_url\":\"$tmburi\"}, \"body\":\"$TEXT\", \"msgtype\":\"$FILE_TYPE\", \"filename\":$(escape "$filename"), \"url\":\"$uri\"}"
                        rm "/tmp/$tmbname"
                fi
        fi

        #If it's a video...
        if [[ $FILE_TYPE == "m.video" ]]; then
                                                                    if [ "$TEXT" = "" ]; then
                data="{\"info\":{\"mimetype\":\"$content_type\", \"thumbnail_info\":{\"w\":$tmbwidth, \"h\":$tmbheight, \"mimetype\":\"image\/jpeg\", \"size\":$tmbsize }, \"size\":$size, \"w\":$vidwidth, \"h\":$vidheight, \"xyz.amorgan.blurhash\":\"$blurhash\", \"thumbnail_url\":\"$tmburi\"}, \"body\":$(escape "$filename"), \"msgtype\":\"$FILE_TYPE\", \"filename\":$(escape "$filename"), \"url\":\"$uri\"}"
                rm "/tmp/$tmbname"
                                                                                                else
                data="{\"info\":{\"mimetype\":\"$content_type\", \"thumbnail_info\":{\"w\":$tmbwidth, \"h\":$tmbheight, \"mimetype\":\"image\/jpeg\", \"size\":$tmbsize }, \"size\":$size, \"w\":$vidwidth, \"h\":$vidheight, \"xyz.amorgan.blurhash\":\"$blurhash\", \"thumbnail_url\":\"$tmburi\"}, \"body\":\"$TEXT\", \"msgtype\":\"$FILE_TYPE\", \"filename\":$(escape "$filename"), \"url\":\"$uri\"}"
                rm "/tmp/$tmbname"
                                                                                                fi
        fi

        #Send it.
        echo $data
        _send_message "$data"
}


######## Program flow stuff
[ -r ~/.matrix.sh ] && . ~/.matrix.sh

ACTION="send"
HTML="false"
PRE="false"
TOROOM="false"
FILE=""
FILE_TYPE="m.file"
MESSAGE_TYPE="m.text"
IDENTIFIER="`whoami`@`hostname` using matrix.sh"

for i in "$@"; do
        case $i in
                # Options
                --toroom)
                        TOROOM="true"
                        shift
                        ;;
                --token=*)
                        MATRIX_TOKEN="${i#*=}"
                        shift
                        ;;
                --room=*)
                        MATRIX_ROOM_ID="${i#*=}"
                        shift
                        ;;
                --homeserver=*)
                        MATRIX_HOMESERVER="${i#*=}"
                        shift
                        ;;
                --html)
                        HTML="true"
                        shift
                        ;;
                --pre)
                        PRE="true"
                        shift
                        ;;
                --notice)
                        MESSAGE_TYPE="m.notice"
                        shift
                        ;;
                --file=*)
                        FILE="${i#*=}"
                        ACTION="send"
                        shift
                        ;;
                --image)
                        FILE_TYPE="m.image"
                        shift
                        ;;
                --audio)
                        FILE_TYPE="m.audio"
                        shift
                        ;;
                --video)
                        FILE_TYPE="m.video"
                        shift
                        ;;
                --identifier=*)
                        IDENTIFIER="${i#*=}"
                        shift
                        ;;

                # Actions
                --login)
                        ACTION="login"
                        shift
                        ;;
                --list-rooms)
                        ACTION="list_rooms"
                        shift
                        ;;
                --select-default-room)
                        ACTION="select_room"
                        shift
                        ;;
                --join-room)
                        ACTION="join_room"
                        shift
                        ;;
                --leave-room)
                        ACTION="leave_room"
                        shift
                        ;;
                --invite-user)
                        ACTION="invite_user"
                        shift
                        ;;
                --send-message|--send)
                        ACTION="send"
                        shift
                        ;;
                --change-name)
                        ACTION="change_name"
                        shift
                        ;;
                --help|-h)
                        ACTION="help"
                        shift
                        ;;

                --*)
                        die "Unknown option $i"
                        ;;

                *)
                        TEXT="$i"
                        shift
                        ;;
        esac
done

if [ -z "$ACTION" ]; then
        help
        exit 1
fi

if [ "$ACTION" = "login" ]; then
        login
        # Do not exit here. We want select_room to run as well.
elif [ "$ACTION" = "help" ]; then
        help
        exit 1
fi

[ -z $MATRIX_HOMESERVER ] && die "No homeserver set. Use '$0 --login' to log into an account on a homeserver and persist those settings."

[ -z $MATRIX_TOKEN ] && die "No matrix token set. Use '$0 --login' to login."

AUTHORIZATION="Authorization: Bearer $MATRIX_TOKEN"

case "$ACTION" in
  "select_room")
    $ACTION;;
  "list_rooms")
    $ACTION;;
  "join_room")
    $ACTION;;
  "leave_room")
    $ACTION;;
  "invite_user")
    $ACTION;;
  "change_name")
    $ACTION;;
  "send")
    if [ "$FILE" = "" ]; then
      [ -z "$TEXT" ] && die "No message to send."
      send_message "$TEXT"
    else
      send_file "$TEXT"
    fi
    ;;
esac