Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Gotify notification #58

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions snapraid-runner.conf.example
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ to =
; maximum email size in KiB
maxsize = 500

[gotify]
; when to send a gotify notification, comma-separated list of [success, error]
sendon = success,error
; url of the gotify server without trailing slash
url = https://gotify.server.com
; Gotify token
token =


[smtp]
host =
; leave empty for default port
Expand All @@ -42,3 +51,7 @@ enabled = false
plan = 12
; minimum block age (in days) for scrubbing. Only used with percentage plans
older-than = 10

[sync]
; set to true to force sync files with zero size
force-zero = false
33 changes: 30 additions & 3 deletions snapraid-runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import threading
import time
import traceback
import requests
from collections import Counter, defaultdict
from io import StringIO

Expand Down Expand Up @@ -41,7 +42,9 @@ def snapraid_command(command, args={}, *, allow_statuscodes=[]):
arguments = ["--conf", config["snapraid"]["config"],
"--quiet"]
for (k, v) in args.items():
arguments.extend(["--" + k, str(v)])
arguments.append("--" + k)
if v != '':
arguments.append(str(v))
p = subprocess.Popen(
[config["snapraid"]["executable"], command] + arguments,
stdout=subprocess.PIPE,
Expand All @@ -64,6 +67,21 @@ def snapraid_command(command, args={}, *, allow_statuscodes=[]):
else:
raise subprocess.CalledProcessError(ret, "snapraid " + command)

def send_gotify(success):

if success:
requests.post("{}/message?token={}".format(config["gotify"]["url"], config["gotify"]["token"]), json={
"message": "Success",
"priority": 2,
"title": "SnapRAID"
})
else:
requests.post("{}/message?token={}".format(config["gotify"]["url"], config["gotify"]["token"]), json={
"message": "Failed",
"priority": 2,
"title": "SnapRAID"
})


def send_email(success):
import smtplib
Expand Down Expand Up @@ -122,6 +140,11 @@ def finish(is_success):
send_email(is_success)
except Exception:
logging.exception("Failed to send email")
if ("error", "success")[is_success] in config["gotify"]["sendon"]:
try:
send_gotify(is_success)
except Exception:
logging.exception("Failed to send gotify notification")
if is_success:
logging.info("Run finished successfully")
else:
Expand All @@ -133,7 +156,7 @@ def load_config(args):
global config
parser = configparser.RawConfigParser()
parser.read(args.conf)
sections = ["snapraid", "logging", "email", "smtp", "scrub"]
sections = ["snapraid", "logging", "email", "gotify", "smtp", "scrub", "sync"]
config = dict((x, defaultdict(lambda: "")) for x in sections)
for section in parser.sections():
for (k, v) in parser.items(section):
Expand All @@ -154,6 +177,7 @@ def load_config(args):
config["scrub"]["enabled"] = (config["scrub"]["enabled"].lower() == "true")
config["email"]["short"] = (config["email"]["short"].lower() == "true")
config["snapraid"]["touch"] = (config["snapraid"]["touch"].lower() == "true")
config["sync"]["force-zero"] = (config["sync"]["force-zero"].lower() == "true")

# Migration
if config["scrub"]["percentage"]:
Expand Down Expand Up @@ -281,8 +305,11 @@ def run():
logging.info("No changes detected, no sync required")
else:
logging.info("Running sync...")
sync_args: dict[str, str] = {}
if config["sync"]["force-zero"]:
sync_args["force-zero"] = ""
try:
snapraid_command("sync")
snapraid_command("sync", sync_args)
except subprocess.CalledProcessError as e:
logging.error(e)
finish(False)
Expand Down