3 new features: --mime, --media-upload and --media-download

Author: 8go

Cargo.lock

@@ -2,7 +2,7 @@
 
 [package]
 name = "matrix-commander"
-version = "0.1.18"
+version = "0.1.19"
 edition = "2021"
 description = "simple but convenient CLI-based Matrix client app for sending and receiving"
 documentation = "https://docs.rs/matrix-commander"
@@ -35,6 +35,7 @@ atty = "0.2"
 mime = "0.3"
 mime_guess = "2.0"
 update-informer = "0.5"
+json = "0.12.4"
 
 
 [dev-dependencies]

Cargo.toml

@@ -133,7 +133,14 @@ Options:
           verbosity will be very high. Verbosity only affects the debug
           information. So, if '--debug' is not used then '--verbose' will be
           ignored
-  -c, --credentials <PATH TO FILE>
+      --plain
+          Disable encryption for a specific action. By default encryption is
+          turned on wherever possible. E.g. rooms created will be created by
+          default with encryption enabled. To turn encryption off for a
+          specific action use --plain. Currently --plain is supported by
+          --room-create and --room-dm-create. See also --room-enable-encryption
+          which sort of does the opossite for rooms
+  -c, --credentials <PATH_TO_FILE>
           Path to a file containing credentials. At login (--login),
           information about homeserver, user, room id, etc. will be written to
           a credentials file. By default, this file is "credentials.json". On
@@ -142,7 +149,7 @@ Options:
           room. If this option is provided, the provided path to a file will be
           used as credentials file instead of the default one [default:
           /home/user/.local/share/matrix-commander-rs/credentials.json]
-  -s, --store <PATH TO DIRECTORY>
+  -s, --store <PATH_TO_DIRECTORY>
           Path to a directory to be used as "store" for encrypted messaging.
           Since encryption is always enabled, a store is always needed. If this
           option is provided, the provided directory name will be used as
@@ -151,7 +158,7 @@ Options:
           same device. The store directory can be shared between multiple
           different devices and users [default:
           /home/user/.local/share/matrix-commander-rs/sledstore/]
-      --login <LOGIN METHOD>
+      --login <LOGIN_METHOD>
           Login to and authenticate with the Matrix homeserver. This requires
           exactly one argument, the login method. Currently two choices are
           offered: 'password' and 'SSO'. Provide one of these methods. If you
@@ -173,7 +180,7 @@ Options:
           browser. So, don't use SSO on headless homeservers where there is no
           browser installed or accessible [default: none] [possible values:
           none, password, access-token, sso]
-      --verify <VERIFICATION METHOD>
+      --verify <VERIFICATION_METHOD>
           Perform verification. By default, no verification is performed.
           Verification is currently only offered via Emojis. Hence, specify
           '--verify emoji'. If verification is desired, run this program in the
@@ -295,17 +302,20 @@ Options:
           of text formatted in MarkDown language. '--code' allows sending of
           text as a Code block
   -r, --room [<ROOM>...]
-          Optionally specify one or multiple rooms by room ids. '--room' is
-          used by various options like '--message', '--file', some variants of
-          '--listen', '--delete-device', etc. If no '--room' is provided the
-          default room from the credentials file will be used. If a room is
-          provided in the '--room' argument, then it will be used instead of
-          the one from the credentials file. The user must have access to the
-          specified room in order to send messages to it or listen on the room.
-          Messages cannot be sent to arbitrary rooms. When specifying the room
-          id some shells require the exclamation mark to be escaped with a
-          backslash. Not all listen operations allow setting a room. Read more
-          under the --listen options and similar
+          Optionally specify one or multiple rooms via room ids or room
+          aliases. '--room' is used by various options like '--message',
+          '--file', some variants of '--listen', '--delete-device', etc. The
+          default room is provided in the credentials file (specified at
+          --login with --room-default). If a room (or multiple ones) is (or
+          are) provided in the --room arguments, then it (or they) will be used
+          instead of the one from the credentials file. The user must have
+          access to the specified room in order to send messages there or
+          listen on the room. Messages cannot be sent to arbitrary rooms. When
+          specifying the room id some shells require the exclamation mark to be
+          escaped with a backslash. Not all listen operations allow setting a
+          room. Read more under the --listen options and similar. Most actions
+          also support room aliases or local canonical short aliases instead of
+          room ids. Using a room id is always faster than using a room alias
   -f, --file [<FILE>...]
           Send one or multiple files (e.g. PDF, DOC, MP4). First files are
           sent, then text messages are sent. If you want to feed a file into
@@ -316,7 +326,8 @@ Options:
           indirectly a MIME type to the piped data. E.g. if you pipe in a PNG
           file, you might want to specify additionally '--file-name image.png'.
           As such, the label 'image' will be given to the data and the MIME
-          type 'png' will be attached to it
+          type 'png' will be attached to it. Furthermore, '-' can only be used
+          once
       --notice
           There are 3 message types for '--message'. Text, Notice, and Emote.
           By default, if no command line options are specified, 'Text' will be
@@ -329,7 +340,7 @@ Options:
           used. Use '--notice' or '--emote' to set the type to Notice or Emote
           respectively. '--notice' allows sending of text as a notice.
           '--emote' allows sending of text as an emote
-      --sync <SYNC TYPE>
+      --sync <SYNC_TYPE>
           This option decides on whether the program synchronizes the state
           with the server before a 'send' action. Currently two choices are
           offered: 'full' and 'off'. Provide one of these choices. The default
@@ -339,7 +350,7 @@ Options:
           before a 'send'. If you have chosen 'off', synchronization will be
           skipped entirely before the 'send' which will improve performance [default:
           full] [possible values: off, full]
-  -l, --listen <LISTEN TYPE>
+  -l, --listen <LISTEN_TYPE>
           The '--listen' option takes one argument. There are several choices:
           'never', 'once', 'forever', 'tail', and 'all'. By default, --listen
           is set to 'never'. So, by default no listening will be done. Set it
@@ -378,7 +389,7 @@ Options:
       --whoami
           Print the user id used by "matrix-commander-rs" (itself). One can get
           this information also by looking at the credentials file
-  -o, --output <OUTPUT FORMAT>
+  -o, --output <OUTPUT_FORMAT>
           This option decides on how the output is presented. Currently offered
           choices are: 'text', 'json', 'json-max', and 'json-spec'. Provide one
           of these choices. The default is 'text'. If you want to use the
@@ -636,6 +647,41 @@ Options:
           Get the profile of itself, i.e. of the 'matrix-commander-rs' user
           account. This is getting both display name and avatar MXC URI in a
           call
+      --media-upload [<FILE>...]
+          Upload one or multiple files (e.g. PDF, DOC, MP4) to the homeserver
+          content repository. If you want to feed a file for upload into
+          "matrix-commander-rs" via a pipe, via stdin, then specify the special
+          character '-' as stdin indicator. See description of '--message' to
+          see how the stdin indicator '-' is handled. Use --mime to optionally
+          specify the MIME type of the file. If you give N arguments to
+          --media-upload, you can give N arguments to --mime. See --mime. If
+          you pipe a file into stdin, the MIME type cannot be guessed. It is
+          hence more recommended that you specify a MIME type via '--mime' when
+          using '-'. Furthermore, '-' can only be used once. Upon being stored
+          in the homeserver's content repository, the data is assigned a Matrix
+          MXC URI. For each file uploaded successfully, a single line with the
+          MXC URI will be printed
+      --media-download [<MXC_URI>...]
+          Download one or multiple files from the homeserver content
+          repository. You must provide one or multiple Matrix URIs (MXCs) which
+          are strings like this 'mxc://example.com/SomeStrangeUriKey'. If found
+          they will be downloaded, decrypted, and stored in local files. If
+          file names are specified with --file-name the downloads will be saved
+          with these file names. If --file-name is not specified, then the file
+          name 'mxc-<mxc-id>' will be used. If a file name in --file-name
+          contains the placeholder __mxc_id__, it will be replaced with the
+          mxc-id. If a file name is specified as empty string in --file-name,
+          then also the name 'mxc-<mxc-id>' will be used. Do not confuse
+          --media-download with --download-media. See --download-media
+      --mime [<MIME_TYPE>...]
+          Specify the Mime type of certain input files. Specify '' if the Mime
+          type should be guessed based on the filename. If input is from stdin
+          (i.e. '-' and piped into 'matrix-commander-rs') then Mime type cannot
+          be guessed. If not specified, and no filename available for guessing
+          it will default to 'application/octet-stream'. Some example mime
+          types are: 'image/jpeg', 'image/png', 'image/gif', 'text/plain', and
+          'application/pdf'. For a full list see
+          'https://docs.rs/mime/latest/mime/#constants'
   -h, --help
           Print help information (use `--help` for more detail)
 ```

README.md

@@ -1 +1 @@
-0.1.18
+0.1.19