introduce mod/notification-ntfy...change-109

... for sending notifications via Ntfy (https://ntfy.sh/).

TODO: use proper formatting once supported in Android app:
https://github.com/binwiederhier/ntfy/issues/889

1 files changed, 129 insertions, 0 deletions

diff --git a/mod/notification-ntfy.rsc b/mod/notification-ntfy.rsc
new file mode 100644
index 0000000..a94e1be
--- /dev/null
+++ b/mod/notification-ntfy.rsc
@@ -0,0 +1,129 @@
+#!rsc by RouterOS
+# RouterOS script: mod/notification-ntfy
+# Copyright (c) 2013-2023 Christian Hesse <mail@eworm.de>
+# https://git.eworm.de/cgit/routeros-scripts/about/COPYING.md
+#
+# send notifications via Ntfy (ntfy.sh)
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/mod/notification-ntfy.md
+
+:global FlushNtfyQueue;
+:global NotificationFunctions;
+:global PurgeNtfyQueue;
+:global SendNtfy;
+:global SendNtfy2;
+
+# flush ntfy queue
+:set FlushNtfyQueue do={
+  :global NtfyQueue;
+  :global NtfyMessageIDs;
+
+  :global IsFullyConnected;
+  :global LogPrintExit2;
+
+  :if ([ $IsFullyConnected ] = false) do={
+    $LogPrintExit2 debug $0 ("System is not fully connected, not flushing.") false;
+    :return false;
+  }
+
+  :local AllDone true;
+  :local QueueLen [ :len $NtfyQueue ];
+
+  :if ([ :len [ /system/scheduler/find where name=$0 ] ] > 0 && $QueueLen = 0) do={
+    $LogPrintExit2 warning $0 ("Flushing Ntfy messages from scheduler, but queue is empty.") false;
+  }
+
+  :foreach Id,Message in=$NtfyQueue do={
+    :if ([ :typeof $Message ] = "array" ) do={
+      :do {
+        /tool/fetch check-certificate=yes-without-crl output=none http-method=post \
+          ($Message->"url") http-header-field=($Message->"headers") http-data=($Message->"text") as-value;
+        :set ($NtfyQueue->$Id);
+      } on-error={
+        $LogPrintExit2 debug $0 ("Sending queued Ntfy message failed.") false;
+        :set AllDone false;
+      }
+    }
+  }
+
+  :if ($AllDone = true && $QueueLen = [ :len $NtfyQueue ]) do={
+    /system/scheduler/remove [ find where name=$0 ];
+    :set NtfyQueue;
+  }
+}
+
+# send notification via ntfy - expects one array argument
+:set ($NotificationFunctions->"ntfy") do={
+  :local Notification $1;
+
+  :global Identity;
+  :global IdentityExtra;
+  :global NtfyQueue;
+  :global NtfyServer;
+  :global NtfyServerOverride;
+  :global NtfyTopic;
+  :global NtfyTopicOverride;
+
+  :global EitherOr;
+  :global IfThenElse;
+  :global LogPrintExit2;
+  :global SymbolForNotification;
+  :global UrlEncode;
+
+  :local Server [ $EitherOr ($NtfyServerOverride->($Notification->"origin")) $NtfyServer ];
+  :local Topic [ $EitherOr ($NtfyTopicOverride->($Notification->"origin")) $NtfyTopic ];
+
+  :if ([ :len $Topic ] = 0) do={
+    :return false;
+  }
+
+  :local Url ("https://" . $NtfyServer . "/" . [ $UrlEncode $NtfyTopic ]);
+  :local Headers ({ ("Priority: " . [ $IfThenElse ($Notification->"silent") "low" "default" ]); \
+    ("Title: " . "[" . $IdentityExtra . $Identity . "] " . ($Notification->"subject")) });
+  :local Text (($Notification->"message") . "\n");
+  :if ([ :len ($Notification->"link") ] > 0) do={
+    :set Text ($Text . "\n" . [ $SymbolForNotification "link" ] . ($Notification->"link"));
+  }
+
+  :do {
+    /tool/fetch check-certificate=yes-without-crl output=none http-method=post \
+      $Url http-header-field=$Headers http-data=$Text as-value;
+  } on-error={
+    $LogPrintExit2 info $0 ("Failed sending ntfy notification! Queuing...") false;
+
+    :if ([ :typeof $NtfyQueue ] = "nothing") do={
+      :set NtfyQueue ({});
+    }
+    :set Text ($Text . "\n" . [ $SymbolForNotification "alarm-clock" ] . \
+      "This message was queued since " . [ /system/clock/get date ] . " " . \
+      [ /system/clock/get time ] . " and may be obsolete.");
+    :set ($NtfyQueue->[ :len $NtfyQueue ]) { url=$Url; headers=$Headers; text=$Text };
+    :if ([ :len [ /system/scheduler/find where name="\$FlushNtfyQueue" ] ] = 0) do={
+      /system/scheduler/add name="\$FlushNtfyQueue" interval=1m start-time=startup \
+        on-event=(":global FlushNtfyQueue; \$FlushNtfyQueue;");
+    }
+  }
+}
+
+# purge the Ntfy queue
+:set PurgeNtfyQueue do={
+  :global NtfyQueue;
+
+  /system/scheduler/remove [ find where name="\$FlushNtfyQueue" ];
+  :set NtfyQueue;
+}
+
+# send notification via ntfy - expects at least two string arguments
+:set SendNtfy do={
+  :global SendNtfy2;
+
+  $SendNtfy2 ({ subject=$1; message=$2; link=$3; silent=$4 });
+}
+
+# send notification via ntfy - expects one array argument
+:set SendNtfy2 do={
+  :local Notification $1;
+
+  :global NotificationFunctions;
+
+  ($NotificationFunctions->"ntfy") ("\$NotificationFunctions->\"ntfy\"") $Notification;
+}