Add message support for attachment pastes

Signed-off-by: Bryan Frimin <bryan@getprobo.com>

Author: gearnode

CHANGELOG.md

@@ -10,6 +10,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- Add support for including a text message alongside an attachment when creating
+  a paste. Pass the message as a positional argument:
+  `privatebin create --attachment --filename example.txt "Message to send along"`.
 - Add `--proxy` flag for explicit proxy configuration (supports HTTP, HTTPS,
   and SOCKS5 schemes). Useful for routing traffic through TOR
   (e.g. `socks5://127.0.0.1:9050`).

client.go

@@ -59,6 +59,7 @@ type (
 
 	CreatePasteOptions struct {
 		AttachmentName   string
+		Message          []byte
 		Formatter        string
 		Expire           string
 		OpenDiscussion   bool
@@ -338,7 +339,7 @@ func (c *Client) CreatePaste(
 	var paste Paste
 
 	if opts.AttachmentName != "" {
-		paste = Paste{nil, data, opts.AttachmentName, ""}
+		paste = Paste{opts.Message, data, opts.AttachmentName, ""}
 	} else {
 		paste = Paste{data, nil, "", ""}
 	}

cmd/privatebin/main.go

@@ -242,9 +242,10 @@ var (
 	}
 
 	createCmd = &cobra.Command{
-		Use:          "create",
+		Use:          "create [message]",
 		Short:        "Create a paste",
 		SilenceUsage: true,
+		Args:         cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if binCfg.Host == "" {
 				return fmt.Errorf("no privatebin instance configured, please create a configuration file or use the --config flag")
@@ -272,6 +273,7 @@ var (
 
 			var (
 				attachementName string
+				message         []byte
 				data            []byte
 				err             error
 			)
@@ -301,8 +303,16 @@ var (
 				}
 			}
 
+			if len(args) > 0 {
+				if !cmd.Flags().Changed("attachment") {
+					return fmt.Errorf("positional message argument can only be used with --attachment flag")
+				}
+				message = []byte(args[0])
+			}
+
 			options := privatebin.CreatePasteOptions{
 				AttachmentName:   attachementName,
+				Message:          message,
 				Formatter:        binCfg.Formatter,
 				Expire:           binCfg.Expire,
 				OpenDiscussion:   *binCfg.OpenDiscussion,

doc/privatebin-create.1.md

@@ -12,10 +12,12 @@ section: 1
 **privatebin create** [-h | -help]  [-\-burn-after-reading] [-\-expire=\<time\>]\
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [-\-formatter=\<format\>] [-\-open-discussion]\
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [-\-password=\<password\>] [-\-gzip] [-\-attachment] \
-\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [-\-filename=\<filename\>] *STDIN*
+\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [-\-filename=\<filename\>] [message] *STDIN*
 
 # DESCRIPTION
-Create paste.
+Create paste. When used with **-\-attachment**, an optional positional
+argument can be provided to include a text message alongside the
+attachment.
 
 # OPTIONS
 **-h, -\-help**
@@ -51,6 +53,10 @@ Create a paste on the default privatebin instance:
 
     $ cat example.txt | privatebin create
 
+Create an attachment with an accompanying message:
+
+    $ privatebin create --attachment --filename example.txt "Here is the document"
+
 # SEE ALSO
 **privatebin.conf**(5)
 

doc/privatebin.1.md

@@ -30,8 +30,8 @@ instances.
 
 **-c, -\-config** \<path\>
 : The path of the configuration file. When not set, the CLI searches
-  _$HOME/.config/privatebin/config.json_, then
-  _$XDG\_CONFIG\_HOME/privatebin/config.json_, the platform-native user
+  *$HOME/.config/privatebin/config.json*, then
+  *$XDG\_CONFIG\_HOME/privatebin/config.json*, the platform-native user
   configuration directory, and finally the directories listed in
   **$XDG\_CONFIG\_DIRS** (see **privatebin.conf**(5) for details).
 
@@ -72,14 +72,14 @@ Create a paste through a SOCKS5 proxy (e.g. TOR):
 
 **XDG\_CONFIG\_HOME**
 : User-specific configuration directory. When set, the CLI searches
-  this directory for _privatebin/config.json_ (after checking
-  _$HOME/.config_). See **privatebin.conf**(5) for the full search
+  this directory for *privatebin/config.json* (after checking
+  *$HOME/.config*). See **privatebin.conf**(5) for the full search
   order.
 
 **XDG\_CONFIG\_DIRS**
 : Colon-separated list of system-wide configuration directories.
-  Defaults to _/etc/xdg_ when not set. Each directory is searched for
-  _privatebin/config.json_.
+  Defaults to */etc/xdg* when not set. Each directory is searched for
+  *privatebin/config.json*.
 
 **HTTP_PROXY**, **HTTPS_PROXY**, **ALL_PROXY**
 : When no **-\-proxy** flag is provided and no **proxy** configuration

doc/privatebin.conf.5.md

@@ -150,12 +150,12 @@ Configuration using a SOCKS5 proxy (e.g. TOR):
 The CLI searches for the configuration file in the following locations,
 in order, and uses the first one found:
 
-1. _$HOME/.config/privatebin/config.json_
-2. _$XDG\_CONFIG\_HOME/privatebin/config.json_ (if **XDG\_CONFIG\_HOME** is set)
+1. *$HOME/.config/privatebin/config.json*
+2. *$XDG\_CONFIG\_HOME/privatebin/config.json* (if **XDG\_CONFIG\_HOME** is set)
 3. The platform-native user configuration directory (as returned by
-   Go's **os.UserConfigDir**): _$HOME/.config_ on Linux,
-   _$HOME/Library/Application Support_ on macOS, _%AppData%_ on Windows
-4. Each directory in **$XDG\_CONFIG\_DIRS** (defaults to _/etc/xdg_)
+   Go's **os.UserConfigDir**): *$HOME/.config* on Linux,
+   *$HOME/Library/Application Support* on macOS, *%AppData%* on Windows
+4. Each directory in **$XDG\_CONFIG\_DIRS** (defaults to */etc/xdg*)
 
 Duplicate paths are skipped. When no **-\-config** flag is provided and
 no file is found, the CLI falls back to sensible defaults (expire: