Notifications Rewrite

[mag37]

I've rewritten the new releasenotes function in the main script, to add to a new array straight away instead of just printf'ing the items. This due to some issues with different formatting of newlines and cleaner way to handle it with or without releasenotes-addition.

Hence rewritten this section in the templates (same in all templates):

[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
UpdToString=$( printf '%s\\n' "${Updates[@]}" )

Then I also rewrote most templates MessageBody - bits, this is what I fear might break some templates.

There's a branch here: notify-rewrite.

I've changed all templates to what I think will work, but I need to go through and test them all.

---

Those who run any notification addons are more then welcome to help with testing.

You need both the new dockcheck.sh and the notify_xyz.sh template of your choice.

I suggest you do it in a different directory and not overwrite your current setup.
If you're using git you can clone the branch: git clone -b notify-rewrite https://github.com/mag37/dockcheck.git in a new directory.

---

List of current notification templates (will update when tested):

✅ notify_apprise.sh
✅ notify_discord.sh
✅ notify_DSM.sh
✅ notify_generic.sh
✅ notify_gotify.sh
✅ notify_matrix.sh
✅ notify_ntfy-sh.sh
✅ notify_pushbullet.sh
✅ notify_pushover.sh
✅ notify_smtp.sh
✅ notify_telegram.sh

[mag37]

In most templates I've got it down to these:

alt1 with \n still "intact" (works good for eg. json curls)
MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"

alt2 - where newlines needs to be processed already :
MessageBody=$(printf "🐋 Containers on $FromHost with updates available: \n$UpdToString")

[mag37]

@yoyoma2
Maybe you could check out DSM/smtp? With the EOF - I'm not entirely sure how it'll handle the current variable.

If it doesnt work as is maybe it has to be rewritten to set a variable before the EOF like:
MessageBody=$(printf "🐋 Containers on $FromHost with updates available: \n$UpdToString")
and use that $MessageBody instead of the current $UpdToString

[mag37]

Other people that might be able to test:

• @silverbios - matrix
• @cerealconyogurt - gotify
• @sudo-kraken - pushover
• @arpanghosh8453 - pushbullet

[yoyoma2]

Tried it on DSM and to get the identical email as before I had to delete an extra space in the script and delete a backslash from the DSM template. Did not try the smtp template but it has the same double backslash as the DSM template.

diff --git a/dockcheck.sh b/dockcheck.sh
index 83a5998..dda9efc 100755
--- a/dockcheck.sh
+++ b/dockcheck.sh
@@ -152,7 +152,7 @@ releasenotes() {
   for update in ${GotUpdates[@]}; do
     found=false
     while read -r container url; do
-      [[ $update == $container ]] && Updates+=("$update  ->   $url") && found=true
+      [[ $update == $container ]] && Updates+=("$update  ->  $url") && found=true
     done < "$ScriptWorkDir"/urls.list
     [[ $found == false ]] && Updates+=("$update  ->  url missing") || continue
   done
diff --git a/notify_templates/notify_DSM.sh b/notify_templates/notify_DSM.sh
index 84ba7e9..38a6ea7 100644
--- a/notify_templates/notify_DSM.sh
+++ b/notify_templates/notify_DSM.sh
@@ -19,7 +19,7 @@ fi

 send_notification() {
 [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+UpdToString=$( printf '%s\n' "${Updates[@]}" )
 FromHost=$(hostname)
 CfgFile="/usr/syno/etc/synosmtp.conf"

[mag37]

Two spaces before and after the arrow, just cosmetic, I like symmetry. 😁

Me too :) I'll fix it.

If you've got time please report back how it works with the example I added above.

[yoyoma2]

The newline after the "updates available:" wasn't working and the first container was ending up on the same line. 😕 By printing directly to the variable the result is more predictable. Had to delete an empty line following the use of the $MessageBody variable as it already contains a newline at the end.

printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"

$MailPkg $SendMailTo << __EOF
From: "$SenderName" <$SenderMail>
date:$(date -R)
To: <$SendMailTo>
Subject: $SubjectTag Updates available on $FromHost
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

$MessageBody
 From $SenderName
__EOF
}

Cool blue whale BTW. Is that going to work on all platforms?

[mag37]

Ah thank you for testing that out. And using printf -v is much cleaner than using the subshell to set the variable! I've just tested all other templates (that I have access to) and that works fine, so I changed them too.

Odd that the 2nd \n was needed for the linebreak after "updates available" but good find. I'll add that change to the templates and consider them working then! Thank you for testing, it's worth a lot - I'm just doing this work when I find time.

[yoyoma2]

I was clicking back and forth between the two emails and the second \n was to get things identical (the empty line before the first container). With printf -v the first \n did successfully end the line right after "updates available:".

I'm getting useful free software so testing a little is the least I can do.

[mag37]

I was clicking back and forth between the two emails and the second \n was to get things identical (the empty line before the first container). With printf -v the first \n did successfully end the line right after "updates available:".

I'm getting useful free software so testing a little is the least I can do.

Ah so that was also cosmetic with an extra newline after the "updates available"-bit. Good to know!

Well thank you again for the feedback, really appreciated. Gonna consider some more changes then I'll merge to main asap!

[mag37]

I've now done the edits from feedback and testing to the branch.

Still have these to test:

• matrix (@silverbios)
• gotify (@cerealconyogurt)
• pushbullet (@arpanghosh8453)

I'll hope for some of the contributors to comment, otherwise I'll try to setup testing myself or push as is and modify further on if needed.

[silverbios]

From the matrix(synapse), everything works fine with your last change without issues.

this an example of a message in synapse

🐋 Containers on $HOSTNAME with updates available:
Container01
Container02

Thank you

[mag37]

Wonderful thank you for testing!

[mag37]

I spun up a gotify docker instance. Worked!

Logged in and set up a pushbullet token and tested. Worked!

So all templates are now confirmed working as advertised. I'll keep the discussion open if there's any feedback, suggestions or issues (though maybe open a issue if it's breaking).

Thank you guys!