Merge branch 'CommitBrief' into next

... now that we have it on loading global functions.

README.md

@@ -57,11 +57,12 @@ temporarily.
 
 #### Prerequisite configuration
 
-Starting with RouterOS 7.17 the
+The
 [device-mode ↗️](https://help.mikrotik.com/docs/spaces/ROS/pages/93749258/Device-mode)
-has been extended to give more fine-grained control over what features are
-available. You need to enable `scheduler` and `fetch` at least, specific
-scripts may require additional features.
+is a mechanism to lock down a device for security reasons, it gives
+fine-grained control over what features are available. You need to enable
+`scheduler` and `fetch` at least, specific scripts may require additional
+features.
 
 ### Hardware
 

accesslist-duplicates.capsman.rsc

@@ -32,5 +32,5 @@
     :set ($Seen->$Mac) 1;
   }
 } do={
-  :global ExitError; $ExitError false [ :jobname ] $Err;
+  :global ExitOnError; $ExitOnError [ :jobname ] $Err;
 }

accesslist-duplicates.local.rsc

@@ -32,5 +32,5 @@
     :set ($Seen->$Mac) 1;
   }
 } do={
-  :global ExitError; $ExitError false [ :jobname ] $Err;
+  :global ExitOnError; $ExitOnError [ :jobname ] $Err;
 }

accesslist-duplicates.template.rsc

@@ -41,5 +41,5 @@
     :set ($Seen->$Mac) 1;
   }
 } do={
-  :global ExitError; $ExitError false [ :jobname ] $Err;
+  :global ExitOnError; $ExitOnError [ :jobname ] $Err;
 }

accesslist-duplicates.wifi.rsc

@@ -32,5 +32,5 @@
     :set ($Seen->$Mac) 1;
   }
 } do={
-  :global ExitError; $ExitError false [ :jobname ] $Err;
+  :global ExitOnError; $ExitOnError [ :jobname ] $Err;
 }

global-functions.rsc

@@ -30,12 +30,14 @@
 :global CharacterReplace;
 :global CleanFilePath;
 :global CleanName;
+:global CommitBrief;
 :global DeviceInfo;
 :global Dos2Unix;
 :global DownloadPackage;
 :global EitherOr;
 :global EscapeForRegEx;
 :global ExitError;
+:global ExitOnError;
 :global FetchHuge;
 :global FetchUserAgentStr;
 :global FileExists;
@@ -319,13 +321,24 @@
   :return $Return;
 }
 
-# get readable device info
-:set DeviceInfo do={
+# return a brief commit description
+:set CommitBrief do={
   :global CommitId;
   :global CommitInfo;
+
+  :if ($CommitId = "unknown") do={
+    :return "unknown";
+  }
+
+  :return ($CommitInfo . "/" . [ :pick $CommitId 0 8 ]);
+}
+
+# get readable device info
+:set DeviceInfo do={
   :global ExpectedConfigVersion;
   :global Identity;
 
+  :global CommitBrief;
   :global IfThenElse;
   :global FormatLine;
 
@@ -366,8 +379,7 @@
         $RouterBoard->"current-firmware" != $RouterBoard->"upgrade-firmware") \
       ([ $FormatLine "    Firmware" ($RouterBoard->"current-firmware") ] . "\n") ] . \
     "RouterOS-Scripts:\n" . \
-    [ $IfThenElse ($CommitId != "unknown") \
-      ([ $FormatLine "    Commit" ($CommitInfo . "/" . [ :pick $CommitId 0 8 ]) ] . "\n") ] . \
+    [ $FormatLine "    Commit" [ $CommitBrief ] ] . "\n" . \
     [ $FormatLine "    Version" $ExpectedConfigVersion ]);
 }
 
@@ -473,20 +485,30 @@
   :return $Return;
 }
 
-# simple macro to print error message on unintentional error
+# wrapper for $ExitOnError with additional parameter
 :set ExitError do={
   :local ExitOK [ :tostr $1 ];
   :local Name   [ :tostr $2 ];
   :local Error  [ :tostr $3 ];
 
+  :global ExitOnError;
+
+  :if ($ExitOK = "false") do={
+    $ExitOnError $Name $Error;
+  }
+}
+
+# simple macro to print error message on unintentional error
+:set ExitOnError do={
+  :local Name   [ :tostr $1 ];
+  :local Error  [ :tostr $2 ];
+
   :global IfThenElse;
   :global LogPrint;
 
-  :if ($ExitOK = "false") do={
-    $LogPrint error $Name ([ $IfThenElse ([ :pick $Name 0 1 ] = "\$") \
-        "Function" "Script" ] . " '" . $Name . "' exited with error" . \
-        [ $IfThenElse (!($Error ~ "^(|true|false)\$")) (": " . $Error) "." ]);
-  }
+  $LogPrint error $Name ([ $IfThenElse ([ :pick $Name 0 1 ] = "\$") \
+      "Function" "Script" ] . " '" . $Name . "' exited with error" . \
+      [ $IfThenElse (!($Error ~ "^(|true|false)\$")) (": " . $Error) "." ]);
 }
 
 # fetch huge data to file, read in chunks
@@ -550,16 +572,13 @@
 :set FetchUserAgentStr do={
   :local Caller [ :tostr $1 ];
 
-  :global CommitId;
-  :global CommitInfo;
-
+  :global CommitBrief;
   :global IfThenElse;
 
   :local Resource [ /system/resource/get ];
 
   :return ("User-Agent: Mikrotik/" . $Resource->"version" . " " . $Resource->"architecture-name" . \
-    " " . $Caller . "/Fetch (https://rsc.eworm.de/" . [ $IfThenElse ($CommitId != "unknown") \
-    ("; " . $CommitInfo . "/" . [ :pick $CommitId 0 8 ]) ] . ")");
+    " " . $Caller . "/Fetch (https://rsc.eworm.de/; " . [ $CommitBrief ] . ")");
 }
 
 # check for existence of file, optionally with type
@@ -1024,7 +1043,6 @@
 
 # return an IPv6 netmask for CIDR
 :set NetMask6 do={
-  :local FuncName $0;
   :local CIDR [ :tostr $1 ];
 
   :global IfThenElse;
@@ -1241,7 +1259,6 @@
   :local NewComment [ :tostr   $2 ];
 
   :global CommitId;
-  :global CommitInfo;
   :global ExpectedConfigVersion;
   :global GlobalConfigReady;
   :global GlobalFunctionsReady;
@@ -1417,10 +1434,6 @@
     }
   }
 
-  :if ($CommitId != "unknown" && $CommitIdBefore != $CommitId) do={
-    $LogPrint info $0 ("Updated to commit: " . $CommitInfo . "/" . [ :pick $CommitId 0 8 ]);
-  }
-
   :if ($ExpectedConfigVersionBefore > $ExpectedConfigVersion) do={
     $LogPrint warning $0 ("The configuration version decreased from " . \
       $ExpectedConfigVersionBefore . " to " . $ExpectedConfigVersion . \
@@ -1517,7 +1530,7 @@
     :set GlobalConfigMigration;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # lock script against multiple invocation
@@ -1663,7 +1676,7 @@
 
   $SendNotification2 ({ origin=$0; subject=$1; message=$2; link=$3; silent=$4 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via NotificationFunctions - expects one array argument
@@ -1921,18 +1934,20 @@
 }
 
 # add (and fix) global scripts scheduler
-:local OnEvent "/system/script { run global-config; run global-functions; }";
-:if ([ :len [ /system/scheduler/find where name="global-scripts" ] ] = 0) do={
-  /system/scheduler/add name="global-scripts" start-time=startup;
-}
-:if ([ /system/scheduler/get "global-scripts" on-event ] != $OnEvent) do={
-  /system/scheduler/set "global-scripts" on-event=$OnEvent;
+/system/scheduler {
+  :local OnEvent "/system/script { run global-config; run global-functions; }";
+  :if ([ :len [ find where name="global-scripts" ] ] = 0) do={
+    add name="global-scripts" start-time=startup;
+  }
+  set on-event=$OnEvent [ find where name="global-scripts" on-event!=$OnEvent ];
+  enable [ find where name="global-scripts" disabled ];
 }
 
 # Log success
 :local Resource [ /system/resource/get ];
-$LogPrintOnce info $ScriptName ("Loaded on " . $Resource->"board-name" . \
-  " with RouterOS " . $Resource->"version" . ".");
+$LogPrintOnce info $ScriptName ("Loaded " . \
+    [ $IfThenElse ($CommitId != "unknown") ([ $CommitBrief ] . " ") ] . \
+    "on " . $Resource->"board-name" . " with RouterOS " . $Resource->"version" . ".");
 
 # signal we are ready
 :set GlobalFunctionsReady true;

mod/bridge-port-to.rsc

@@ -66,5 +66,5 @@
     /interface/ethernet/enable $InterfaceReEnable;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }

mod/bridge-port-vlan.rsc

@@ -75,5 +75,5 @@
     /interface/ethernet/enable $InterfaceReEnable;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }

mod/inspectvar.rsc

@@ -17,7 +17,7 @@
 
   :put [ :tocrlf [ $InspectVarReturn $1 ] ];
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # inspect variable and return formatted string

mod/ipcalc.rsc

@@ -28,7 +28,7 @@
     [ $FormatLine "HostMax" ($Values->"hostmax") ] . "\n" . \
     [ $FormatLine "Broadcast" ($Values->"broadcast") ]) ];
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # calculate and return netmask, network, min host, max host and broadcast

mod/notification-email.rsc

@@ -146,7 +146,7 @@
   /system/scheduler/set interval=(($SchedVal->"run-count") . "m") \
       comment="Waiting for retry..." $Scheduler;
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # generate filter for log-forward
@@ -274,7 +274,7 @@
 
   $SendEMail2 ({ origin=$0; subject=$1; message=$2; link=$3 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via e-mail - expects one array argument

mod/notification-gotify.rsc

@@ -54,7 +54,7 @@
     :set GotifyQueue;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via Gotify - expects one array argument
@@ -126,7 +126,7 @@
 
   $SendGotify2 ({ origin=$0; subject=$1; message=$2; link=$3; silent=$4 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via Gotify - expects one array argument

mod/notification-matrix.rsc

@@ -59,7 +59,7 @@
     :set MatrixQueue;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via Matrix - expects one array argument
@@ -172,7 +172,7 @@
 
   $SendMatrix2 ({ origin=$0; subject=$1; message=$2; link=$3 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via Matrix - expects one array argument

mod/notification-ntfy.rsc

@@ -53,7 +53,7 @@
     :set NtfyQueue;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via ntfy - expects one array argument
@@ -148,7 +148,7 @@
 
   $SendNtfy2 ({ origin=$0; subject=$1; message=$2; link=$3; silent=$4 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via ntfy - expects one array argument

mod/notification-telegram.rsc

@@ -62,7 +62,7 @@
     :set TelegramQueue;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # get the chat id
@@ -101,7 +101,7 @@
     $LogPrint info $0 ("The thread id is: " . ($Message->"message_thread_id"));
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } } 
 
 # send notification via telegram - expects one array argument
@@ -237,7 +237,7 @@
 
   $SendTelegram2 ({ origin=$0; subject=$1; message=$2; link=$3; silent=$4 });
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # send notification via telegram - expects one array argument

mod/scriptrunonce.rsc

@@ -52,5 +52,5 @@
     :return true;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }

mod/ssh-keys-import.rsc

@@ -68,7 +68,7 @@
     :return false;
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }
 
 # import keys from a file
@@ -110,5 +110,5 @@
     }
   }
 } do={
-  :global ExitError; $ExitError false $0 $Err;
+  :global ExitOnError; $ExitOnError $0 $Err;
 } }

mode-button.rsc

@@ -82,7 +82,7 @@
         $LogPrint info $FuncName ("No action defined for " . $Count . " mode-button presses.");
       }
     } do={
-      :global ExitError; $ExitError false $0 $Err;
+      :global ExitOnError; $ExitOnError $0 $Err;
     } }
     /system/scheduler/add name="_ModeButtonScheduler" \
         on-event=":global ModeButtonScheduler; \$ModeButtonScheduler;" interval=3s;
@@ -91,5 +91,5 @@
     /system/scheduler/set $Scheduler start-time=[ /system/clock/get time ];
   }
 } do={
-  :global ExitError; $ExitError false [ :jobname ] $Err;
+  :global ExitOnError; $ExitOnError [ :jobname ] $Err;
 }