mirror of
https://github.com/binwiederhier/ntfy.git
synced 2024-12-15 17:50:55 +00:00
314 lines
12 KiB
Go
314 lines
12 KiB
Go
package cmd
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"github.com/urfave/cli/v2"
|
|
"heckel.io/ntfy/v2/client"
|
|
"heckel.io/ntfy/v2/log"
|
|
"heckel.io/ntfy/v2/util"
|
|
"io"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
func init() {
|
|
commands = append(commands, cmdPublish)
|
|
}
|
|
|
|
var flagsPublish = append(
|
|
append([]cli.Flag{}, flagsDefault...),
|
|
&cli.StringFlag{Name: "config", Aliases: []string{"c"}, EnvVars: []string{"NTFY_CONFIG"}, Usage: "client config file"},
|
|
&cli.StringFlag{Name: "title", Aliases: []string{"t"}, EnvVars: []string{"NTFY_TITLE"}, Usage: "message title"},
|
|
&cli.StringFlag{Name: "message", Aliases: []string{"m"}, EnvVars: []string{"NTFY_MESSAGE"}, Usage: "message body"},
|
|
&cli.StringFlag{Name: "priority", Aliases: []string{"p"}, EnvVars: []string{"NTFY_PRIORITY"}, Usage: "priority of the message (1=min, 2=low, 3=default, 4=high, 5=max)"},
|
|
&cli.StringFlag{Name: "tags", Aliases: []string{"tag", "T"}, EnvVars: []string{"NTFY_TAGS"}, Usage: "comma separated list of tags and emojis"},
|
|
&cli.StringFlag{Name: "delay", Aliases: []string{"at", "in", "D"}, EnvVars: []string{"NTFY_DELAY"}, Usage: "delay/schedule message"},
|
|
&cli.StringFlag{Name: "click", Aliases: []string{"U"}, EnvVars: []string{"NTFY_CLICK"}, Usage: "URL to open when notification is clicked"},
|
|
&cli.StringFlag{Name: "icon", Aliases: []string{"i"}, EnvVars: []string{"NTFY_ICON"}, Usage: "URL to use as notification icon"},
|
|
&cli.StringFlag{Name: "actions", Aliases: []string{"A"}, EnvVars: []string{"NTFY_ACTIONS"}, Usage: "actions JSON array or simple definition"},
|
|
&cli.StringFlag{Name: "attach", Aliases: []string{"a"}, EnvVars: []string{"NTFY_ATTACH"}, Usage: "URL to send as an external attachment"},
|
|
&cli.BoolFlag{Name: "markdown", Aliases: []string{"md"}, EnvVars: []string{"NTFY_MARKDOWN"}, Usage: "Message is formatted as Markdown"},
|
|
&cli.StringFlag{Name: "filename", Aliases: []string{"name", "n"}, EnvVars: []string{"NTFY_FILENAME"}, Usage: "filename for the attachment"},
|
|
&cli.StringFlag{Name: "file", Aliases: []string{"f"}, EnvVars: []string{"NTFY_FILE"}, Usage: "file to upload as an attachment"},
|
|
&cli.StringFlag{Name: "email", Aliases: []string{"mail", "e"}, EnvVars: []string{"NTFY_EMAIL"}, Usage: "also send to e-mail address"},
|
|
&cli.StringFlag{Name: "user", Aliases: []string{"u"}, EnvVars: []string{"NTFY_USER"}, Usage: "username[:password] used to auth against the server"},
|
|
&cli.StringFlag{Name: "token", Aliases: []string{"k"}, EnvVars: []string{"NTFY_TOKEN"}, Usage: "access token used to auth against the server"},
|
|
&cli.IntFlag{Name: "wait-pid", Aliases: []string{"wait_pid", "pid"}, EnvVars: []string{"NTFY_WAIT_PID"}, Usage: "wait until PID exits before publishing"},
|
|
&cli.BoolFlag{Name: "wait-cmd", Aliases: []string{"wait_cmd", "cmd", "done"}, EnvVars: []string{"NTFY_WAIT_CMD"}, Usage: "run command and wait until it finishes before publishing"},
|
|
&cli.BoolFlag{Name: "no-cache", Aliases: []string{"no_cache", "C"}, EnvVars: []string{"NTFY_NO_CACHE"}, Usage: "do not cache message server-side"},
|
|
&cli.BoolFlag{Name: "no-firebase", Aliases: []string{"no_firebase", "F"}, EnvVars: []string{"NTFY_NO_FIREBASE"}, Usage: "do not forward message to Firebase"},
|
|
&cli.BoolFlag{Name: "quiet", Aliases: []string{"q"}, EnvVars: []string{"NTFY_QUIET"}, Usage: "do not print message"},
|
|
)
|
|
|
|
var cmdPublish = &cli.Command{
|
|
Name: "publish",
|
|
Aliases: []string{"pub", "send", "trigger"},
|
|
Usage: "Send message via a ntfy server",
|
|
UsageText: `ntfy publish [OPTIONS..] TOPIC [MESSAGE...]
|
|
ntfy publish [OPTIONS..] --wait-cmd COMMAND...
|
|
NTFY_TOPIC=.. ntfy publish [OPTIONS..] [MESSAGE...]`,
|
|
Action: execPublish,
|
|
Category: categoryClient,
|
|
Flags: flagsPublish,
|
|
Before: initLogFunc,
|
|
Description: `Publish a message to a ntfy server.
|
|
|
|
Examples:
|
|
ntfy publish mytopic This is my message # Send simple message
|
|
ntfy send myserver.com/mytopic "This is my message" # Send message to different default host
|
|
ntfy pub -p high backups "Backups failed" # Send high priority message
|
|
ntfy pub --tags=warning,skull backups "Backups failed" # Add tags/emojis to message
|
|
ntfy pub --delay=10s delayed_topic Laterzz # Delay message by 10s
|
|
ntfy pub --at=8:30am delayed_topic Laterzz # Send message at 8:30am
|
|
ntfy pub -e phil@example.com alerts 'App is down!' # Also send email to phil@example.com
|
|
ntfy pub --click="https://reddit.com" redd 'New msg' # Opens Reddit when notification is clicked
|
|
ntfy pub --icon="http://some.tld/icon.png" 'Icon!' # Send notification with custom icon
|
|
ntfy pub --attach="http://some.tld/file.zip" files # Send ZIP archive from URL as attachment
|
|
ntfy pub --file=flower.jpg flowers 'Nice!' # Send image.jpg as attachment
|
|
ntfy pub -u phil:mypass secret Psst # Publish with username/password
|
|
ntfy pub --wait-pid 1234 mytopic # Wait for process 1234 to exit before publishing
|
|
ntfy pub --wait-cmd mytopic rsync -av ./ /tmp/a # Run command and publish after it completes
|
|
NTFY_USER=phil:mypass ntfy pub secret Psst # Use env variables to set username/password
|
|
NTFY_TOPIC=mytopic ntfy pub "some message" # Use NTFY_TOPIC variable as topic
|
|
cat flower.jpg | ntfy pub --file=- flowers 'Nice!' # Same as above, send image.jpg as attachment
|
|
ntfy trigger mywebhook # Sending without message, useful for webhooks
|
|
|
|
Please also check out the docs on publishing messages. Especially for the --tags and --delay options,
|
|
it has incredibly useful information: https://ntfy.sh/docs/publish/.
|
|
|
|
` + clientCommandDescriptionSuffix,
|
|
}
|
|
|
|
func execPublish(c *cli.Context) error {
|
|
conf, err := loadConfig(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
title := c.String("title")
|
|
priority := c.String("priority")
|
|
tags := c.String("tags")
|
|
delay := c.String("delay")
|
|
click := c.String("click")
|
|
icon := c.String("icon")
|
|
actions := c.String("actions")
|
|
attach := c.String("attach")
|
|
markdown := c.Bool("markdown")
|
|
filename := c.String("filename")
|
|
file := c.String("file")
|
|
email := c.String("email")
|
|
user := c.String("user")
|
|
token := c.String("token")
|
|
noCache := c.Bool("no-cache")
|
|
noFirebase := c.Bool("no-firebase")
|
|
quiet := c.Bool("quiet")
|
|
pid := c.Int("wait-pid")
|
|
|
|
// Checks
|
|
if user != "" && token != "" {
|
|
return errors.New("cannot set both --user and --token")
|
|
}
|
|
|
|
// Do the things
|
|
topic, message, command, err := parseTopicMessageCommand(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
var options []client.PublishOption
|
|
if title != "" {
|
|
options = append(options, client.WithTitle(title))
|
|
}
|
|
if priority != "" {
|
|
options = append(options, client.WithPriority(priority))
|
|
}
|
|
if tags != "" {
|
|
options = append(options, client.WithTagsList(tags))
|
|
}
|
|
if delay != "" {
|
|
options = append(options, client.WithDelay(delay))
|
|
}
|
|
if click != "" {
|
|
options = append(options, client.WithClick(click))
|
|
}
|
|
if icon != "" {
|
|
options = append(options, client.WithIcon(icon))
|
|
}
|
|
if actions != "" {
|
|
options = append(options, client.WithActions(strings.ReplaceAll(actions, "\n", " ")))
|
|
}
|
|
if attach != "" {
|
|
options = append(options, client.WithAttach(attach))
|
|
}
|
|
if markdown {
|
|
options = append(options, client.WithMarkdown())
|
|
}
|
|
if filename != "" {
|
|
options = append(options, client.WithFilename(filename))
|
|
}
|
|
if email != "" {
|
|
options = append(options, client.WithEmail(email))
|
|
}
|
|
if noCache {
|
|
options = append(options, client.WithNoCache())
|
|
}
|
|
if noFirebase {
|
|
options = append(options, client.WithNoFirebase())
|
|
}
|
|
if token != "" {
|
|
options = append(options, client.WithBearerAuth(token))
|
|
} else if user != "" {
|
|
var pass string
|
|
parts := strings.SplitN(user, ":", 2)
|
|
if len(parts) == 2 {
|
|
user = parts[0]
|
|
pass = parts[1]
|
|
} else {
|
|
fmt.Fprint(c.App.ErrWriter, "Enter Password: ")
|
|
p, err := util.ReadPassword(c.App.Reader)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
pass = string(p)
|
|
fmt.Fprintf(c.App.ErrWriter, "\r%s\r", strings.Repeat(" ", 20))
|
|
}
|
|
options = append(options, client.WithBasicAuth(user, pass))
|
|
} else if conf.DefaultToken != "" {
|
|
options = append(options, client.WithBearerAuth(conf.DefaultToken))
|
|
} else if conf.DefaultUser != "" && conf.DefaultPassword != nil {
|
|
options = append(options, client.WithBasicAuth(conf.DefaultUser, *conf.DefaultPassword))
|
|
}
|
|
if pid > 0 {
|
|
newMessage, err := waitForProcess(pid)
|
|
if err != nil {
|
|
return err
|
|
} else if message == "" {
|
|
message = newMessage
|
|
}
|
|
} else if len(command) > 0 {
|
|
newMessage, err := runAndWaitForCommand(command)
|
|
if err != nil {
|
|
return err
|
|
} else if message == "" {
|
|
message = newMessage
|
|
}
|
|
}
|
|
var body io.Reader
|
|
if file == "" {
|
|
body = strings.NewReader(message)
|
|
} else {
|
|
if message != "" {
|
|
options = append(options, client.WithMessage(message))
|
|
}
|
|
if file == "-" {
|
|
if filename == "" {
|
|
options = append(options, client.WithFilename("stdin"))
|
|
}
|
|
body = c.App.Reader
|
|
} else {
|
|
if filename == "" {
|
|
options = append(options, client.WithFilename(filepath.Base(file)))
|
|
}
|
|
body, err = os.Open(file)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
cl := client.New(conf)
|
|
m, err := cl.PublishReader(topic, body, options...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !quiet {
|
|
fmt.Fprintln(c.App.Writer, strings.TrimSpace(m.Raw))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// parseTopicMessageCommand reads the topic and the remaining arguments from the context.
|
|
|
|
// There are a few cases to consider:
|
|
//
|
|
// ntfy publish <topic> [<message>]
|
|
// ntfy publish --wait-cmd <topic> <command>
|
|
// NTFY_TOPIC=.. ntfy publish [<message>]
|
|
// NTFY_TOPIC=.. ntfy publish --wait-cmd <command>
|
|
func parseTopicMessageCommand(c *cli.Context) (topic string, message string, command []string, err error) {
|
|
var args []string
|
|
topic, args, err = parseTopicAndArgs(c)
|
|
if err != nil {
|
|
return
|
|
}
|
|
if c.Bool("wait-cmd") {
|
|
if len(args) == 0 {
|
|
err = errors.New("must specify command when --wait-cmd is passed, type 'ntfy publish --help' for help")
|
|
return
|
|
}
|
|
command = args
|
|
} else {
|
|
message = strings.Join(args, " ")
|
|
}
|
|
if c.String("message") != "" {
|
|
message = c.String("message")
|
|
}
|
|
return
|
|
}
|
|
|
|
func parseTopicAndArgs(c *cli.Context) (topic string, args []string, err error) {
|
|
envTopic := os.Getenv("NTFY_TOPIC")
|
|
if envTopic != "" {
|
|
topic = envTopic
|
|
return topic, remainingArgs(c, 0), nil
|
|
}
|
|
if c.NArg() < 1 {
|
|
return "", nil, errors.New("must specify topic, type 'ntfy publish --help' for help")
|
|
}
|
|
return c.Args().Get(0), remainingArgs(c, 1), nil
|
|
}
|
|
|
|
func remainingArgs(c *cli.Context, fromIndex int) []string {
|
|
if c.NArg() > fromIndex {
|
|
return c.Args().Slice()[fromIndex:]
|
|
}
|
|
return []string{}
|
|
}
|
|
|
|
func waitForProcess(pid int) (message string, err error) {
|
|
if !processExists(pid) {
|
|
return "", fmt.Errorf("process with PID %d not running", pid)
|
|
}
|
|
start := time.Now()
|
|
log.Debug("Waiting for process with PID %d to exit", pid)
|
|
for processExists(pid) {
|
|
time.Sleep(500 * time.Millisecond)
|
|
}
|
|
runtime := time.Since(start).Round(time.Millisecond)
|
|
log.Debug("Process with PID %d exited after %s", pid, runtime)
|
|
return fmt.Sprintf("Process with PID %d exited after %s", pid, runtime), nil
|
|
}
|
|
|
|
func runAndWaitForCommand(command []string) (message string, err error) {
|
|
prettyCmd := util.QuoteCommand(command)
|
|
log.Debug("Running command: %s", prettyCmd)
|
|
start := time.Now()
|
|
cmd := exec.Command(command[0], command[1:]...)
|
|
if log.IsTrace() {
|
|
cmd.Stdout = os.Stdout
|
|
cmd.Stderr = os.Stderr
|
|
}
|
|
err = cmd.Run()
|
|
runtime := time.Since(start).Round(time.Millisecond)
|
|
if err != nil {
|
|
if exitError, ok := err.(*exec.ExitError); ok {
|
|
log.Debug("Command failed after %s (exit code %d): %s", runtime, exitError.ExitCode(), prettyCmd)
|
|
return fmt.Sprintf("Command failed after %s (exit code %d): %s", runtime, exitError.ExitCode(), prettyCmd), nil
|
|
}
|
|
// Hard fail when command does not exist or could not be properly launched
|
|
return "", fmt.Errorf("command failed: %s, error: %s", prettyCmd, err.Error())
|
|
}
|
|
log.Debug("Command succeeded after %s: %s", runtime, prettyCmd)
|
|
return fmt.Sprintf("Command succeeded after %s: %s", runtime, prettyCmd), nil
|
|
}
|