Changed the command line syntax. This changes the API. But luckily this is a really young project without many users. ;-)
This commit is contained in:
Fabian Schlenz
parent
f7d852bd6a
commit
7ebe2f6cfd
2 changed files with 105 additions and 80 deletions
30
README.md
30
README.md
|
|
@ -23,7 +23,7 @@ wrapped in <pre> tags.
|
|||
|
||||
## Usage
|
||||
### Logging in
|
||||
Use `-l <homeserver>`. The script will try to resolve delegation via the
|
||||
Use `login`. The script will try to resolve delegation via the
|
||||
`/.well-known/matrix/server` path. If that doesn't work, you'll get an error
|
||||
message.
|
||||
|
||||
|
|
@ -33,7 +33,8 @@ file allow accessing your homeserver, you should keep it's contents secret.
|
|||
Therefore, it will be created with access mode 600.
|
||||
|
||||
```
|
||||
$ ./matrix.sh -l matrix.org
|
||||
$ ./matrix.sh login
|
||||
Address of the homeserver the account lives on: matrix.org
|
||||
Username on the server (just the local part, so e.g. 'bob'): bob
|
||||
bob's password:
|
||||
|
||||
|
|
@ -49,7 +50,7 @@ It will show all joined rooms as well as rooms you are invited to. Selecting
|
|||
one of the latter will also accept the invitation and join that room.
|
||||
|
||||
```
|
||||
$ ./matrix.sh -s
|
||||
$ ./matrix.sh select-default-room
|
||||
Getting Rooms...
|
||||
Joined rooms:
|
||||
!GCHxYlasvdh778dsOx:matrix.org - Me and my server
|
||||
|
|
@ -68,37 +69,40 @@ Saved default room to ~/.matrix.sh
|
|||
### Sending messages
|
||||
#### Sending a normal text message:
|
||||
```
|
||||
$ ./matrix.sh "Hello World"
|
||||
$ ./matrix.sh send "Hello World"
|
||||
```
|
||||
|
||||
#### Sending a text message with markup:
|
||||
```
|
||||
$ ./matrix.sh -H "This is <strong>very important</strong>."
|
||||
$ ./matrix.sh send --html "This is <strong>very important</strong>."
|
||||
```
|
||||
|
||||
#### Piping command output:
|
||||
```
|
||||
$ echo "Hello" | ./matrix.sh
|
||||
$ echo "Hello" | ./matrix.sh send
|
||||
```
|
||||
|
||||
#### Code formatting:
|
||||
You can use `-P` to send messages formatted as code. This will also escape
|
||||
You can use `--pre` to send messages formatted as code. This will also escape
|
||||
HTML tags.
|
||||
```
|
||||
$ ls -l | ./matrix.sh -P
|
||||
$ ls -l | ./matrix.sh send --pre
|
||||
```
|
||||
|
||||
#### Sending files:
|
||||
```
|
||||
$ ./matrix.sh -f upload.zip
|
||||
$ ./matrix.sh send --file=upload.zip
|
||||
```
|
||||
Additionally use `--audio`, `-image` or `--video` to send files as audio, images or
|
||||
video, respectively:
|
||||
```
|
||||
$ ./matrix.sh send --file=IMG1234.jpg --image
|
||||
```
|
||||
Use `-a`, `-i`, `-v` instead of `-f` to send files as audio, images or
|
||||
video, respectively.
|
||||
|
||||
#### Providing a room:
|
||||
You can use `-r` to provide a room_id. This supersedes the default room.
|
||||
You can use `--room=<room_id>` to provide a room_id. This supersedes the default room.
|
||||
```
|
||||
$ ./matrix.sh -r '!OEassajhhkasLULVAa:matrix.org' "Hello World"
|
||||
$ ./matrix.sh send --room_id='!OEassajhhkasLULVAa:matrix.org' "Hello World"
|
||||
```
|
||||
(Note: bash doesn't like exclamation marks in double quoted strings. So we
|
||||
use single quotes for the room id.)
|
||||
|
|
|
|||
153
matrix.sh
153
matrix.sh
|
|
@ -1,8 +1,8 @@
|
|||
#!/usr/bin/env bash
|
||||
#set -x
|
||||
shopt -s extglob
|
||||
VERSION="0.3"
|
||||
LOG="true"
|
||||
VERSION="1.0"
|
||||
LOG="false"
|
||||
|
||||
AUTHORIZATION="X-Dummy: 1"
|
||||
|
||||
|
|
@ -15,31 +15,30 @@ help() {
|
|||
version
|
||||
echo
|
||||
echo "Usage:"
|
||||
echo "$0 <options> <message>"
|
||||
echo "$0 <action> [<options>] [<message>]"
|
||||
echo
|
||||
echo "ACTIONS"
|
||||
echo " -l <server> Login to a server."
|
||||
echo " -L List rooms the matrix user joined or is invited to."
|
||||
echo " -s Select a default room."
|
||||
echo " -h This help."
|
||||
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 " help Show this help."
|
||||
echo
|
||||
echo "OPTIONS"
|
||||
echo " -r <room_id> Which room to send the message to."
|
||||
echo " -H Enable HTML tags in message."
|
||||
echo " -P Wraps the given message into <pre> and escapes all other HTML special chars."
|
||||
echo
|
||||
echo "FILES (message will be ignored)"
|
||||
echo " -f <file> Send <file>."
|
||||
echo " -a <file> Send <file> as audio."
|
||||
echo " -i <file> Send <file> as image."
|
||||
echo " -v <file> Send <file> as video."
|
||||
echo " --room=<room_id> Which room to send the message to."
|
||||
echo " --html Enable HTML tags in message."
|
||||
echo " --pre Wraps the given message into <pre> and escapes all other HTML special chars."
|
||||
echo " --file=<file> Send <file> to the room."
|
||||
echo " --image Send the file as image."
|
||||
echo " --audio Send the file as audio."
|
||||
echo " --video Send the file as video."
|
||||
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 -H."
|
||||
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() {
|
||||
curl -s --fail -H "$AUTHORIZATION" -H "User-Agent: matrix.sh/$VERSION" $*
|
||||
curl -s --fail -H "$AUTHORIZATION" -H "User-Agent: matrix.sh/$VERSION" "$@"
|
||||
}
|
||||
|
||||
die() {
|
||||
|
|
@ -63,7 +62,7 @@ query() {
|
|||
type="$3"
|
||||
log "POST $url"
|
||||
response=$( _curl -X$type -H "Content-Type: application/json" --data "$data" "${MATRIX_HOMESERVER}${url}" )
|
||||
if [ `jq -r .errcode <<<"$response"` != "null" ]; then
|
||||
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"`"
|
||||
|
|
@ -100,6 +99,7 @@ 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://}"
|
||||
identifier="`whoami`@`hostname` using matrix.sh"
|
||||
identifier=`escape "$identifier"`
|
||||
|
|
@ -165,7 +165,7 @@ _send_message() {
|
|||
send_message() {
|
||||
# Get the text. Try the last variable
|
||||
text="$1"
|
||||
[ "$text" = "-" ] || [ "$text" = "" ] && text=$(</dev/stdin)
|
||||
[ "$text" = "-" ] && text=$(</dev/stdin)
|
||||
if $PRE; then
|
||||
text="${text//</<}"
|
||||
text="${text//>/>}"
|
||||
|
|
@ -197,13 +197,12 @@ send_file() {
|
|||
fi
|
||||
filename=`basename "$FILE"`
|
||||
log "filename: $filename"
|
||||
filename=`jq -s -R . <<<"$filename"`
|
||||
content_type=`file --brief --mime-type "$FILE"`
|
||||
log "content-type: $content_type"
|
||||
upload_file "$FILE" "$content_type" "$filename"
|
||||
uri=`jq -r .content_uri <<<"$response"`
|
||||
|
||||
data="{\"body\":$filename, \"msgtype\":\"$FILETYPE\", \"filename\":$filename, \"url\":\"$uri\"}"
|
||||
data="{\"body\":`escape "$filename"`, \"msgtype\":\"$FILE_TYPE\", \"filename\":`escape "$filename"`, \"url\":\"$uri\"}"
|
||||
_send_message "$data"
|
||||
}
|
||||
|
||||
|
|
@ -211,63 +210,82 @@ send_file() {
|
|||
######## Program flow stuff
|
||||
[ -r ~/.matrix.sh ] && source ~/.matrix.sh
|
||||
|
||||
ACTION="send_message"
|
||||
ACTION="send"
|
||||
HTML="false"
|
||||
PRE="false"
|
||||
while getopts "l:shr:a:f:i:v:HPL" opt; do
|
||||
case $opt in
|
||||
l)
|
||||
ACTION="login"
|
||||
MATRIX_HOMESERVER="$OPTARG"
|
||||
FILE=""
|
||||
FILE_TYPE="m.file"
|
||||
|
||||
for i in "$@"; do
|
||||
case $i in
|
||||
# Options
|
||||
--room=*)
|
||||
MATRIX_ROOM_ID="${i#*=}"
|
||||
shift
|
||||
;;
|
||||
L)
|
||||
ACTION="list_rooms"
|
||||
;;
|
||||
s)
|
||||
ACTION="select_room"
|
||||
;;
|
||||
h)
|
||||
ACTION="help"
|
||||
;;
|
||||
H)
|
||||
--html)
|
||||
HTML="true"
|
||||
shift
|
||||
;;
|
||||
P)
|
||||
--pre)
|
||||
PRE="true"
|
||||
shift
|
||||
;;
|
||||
r)
|
||||
MATRIX_ROOM_ID="$OPTARG"
|
||||
--file=*)
|
||||
FILE="${i#*=}"
|
||||
ACTION="send"
|
||||
shift
|
||||
;;
|
||||
f)
|
||||
ACTION="send_file"
|
||||
FILETYPE="m.file"
|
||||
FILE="$OPTARG"
|
||||
--image)
|
||||
FILE_TYPE="m.image"
|
||||
shift
|
||||
;;
|
||||
v)
|
||||
ACTION="send_file"
|
||||
FILETYPE="m.video"
|
||||
FILE="$OPTARG"
|
||||
--audio)
|
||||
FILE_TYPE="m.audio"
|
||||
shift
|
||||
;;
|
||||
i)
|
||||
ACTION="send_file"
|
||||
FILETYPE="m.image"
|
||||
FILE="$OPTARG"
|
||||
--video)
|
||||
FILE_TYPE="m.video"
|
||||
shift
|
||||
;;
|
||||
a)
|
||||
ACTION="send_file"
|
||||
FILETYPE="m.audio"
|
||||
FILE="$OPTARG"
|
||||
|
||||
# Actions
|
||||
login)
|
||||
ACTION="login"
|
||||
shift
|
||||
;;
|
||||
\?)
|
||||
die "Invalid option -$OPTARG"
|
||||
list-rooms)
|
||||
ACTION="list_rooms"
|
||||
shift
|
||||
;;
|
||||
:)
|
||||
die "Option -$OPTARG requires an argument"
|
||||
select-default-room)
|
||||
ACTION="select_room"
|
||||
shift
|
||||
;;
|
||||
send-message|send)
|
||||
ACTION="send"
|
||||
shift
|
||||
;;
|
||||
help|--help|-h)
|
||||
ACTION="help"
|
||||
shift
|
||||
;;
|
||||
|
||||
--*)
|
||||
die "Unknown option $i"
|
||||
;;
|
||||
|
||||
*)
|
||||
TEXT="$i"
|
||||
shift
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
shift $((OPTIND - 1))
|
||||
if [ "$ACTION" = "" ]; then
|
||||
help
|
||||
exit 1
|
||||
fi
|
||||
|
||||
[ -z $MATRIX_HOMESERVER ] && die "No homeserver set. Use -l <homeserver> to log into an account on the given server and persist those settings."
|
||||
|
||||
|
|
@ -287,10 +305,13 @@ if [ "$ACTION" = "select_room" ]; then
|
|||
select_room
|
||||
elif [ "$ACTION" = "list_rooms" ]; then
|
||||
list_rooms
|
||||
elif [ "$ACTION" = "send_file" ]; then
|
||||
send_file
|
||||
elif [ "$ACTION" = "send_message" ]; then
|
||||
send_message "$1"
|
||||
elif [ "$ACTION" = "send" ]; then
|
||||
if [ "$FILE" = "" ]; then
|
||||
[ -z "$TEXT" ] && die "No message to send given."
|
||||
send_message "$TEXT"
|
||||
else
|
||||
send_file
|
||||
fi
|
||||
fi
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue