Changeset 1805

Timestamp:

01/09/2007 21:57:13 (16 months ago)

Author:

chris

Message:

Call the notify script whenever backup starts or finishes, but the
default script does nothing in this case. Requested by
scott <scott@…>. (merges [1804])

Location:

box/chris/general/bin/bbackupd

Files:

• BackupClientDirectoryRecord.cpp (modified) (1 diff)
• BackupDaemon.cpp (modified) (8 diffs)
• BackupDaemon.h (modified) (1 diff)
• bbackupd-config.in (modified) (5 diffs)

box/chris/general/bin/bbackupd/BackupClientDirectoryRecord.cpp

@@ -888 +888 @@
                                         // Connection errors should just be passed on to the main handler, retries
                                         // would probably just cause more problems.
-                                        // Already logged by UploadFile
+                                        rParams.GetProgressNotifier()
+                                                .NotifyFileUploadException(
+                                                        this, filename, e);
                                         throw;
                                 }

box/chris/general/bin/bbackupd/BackupDaemon.cpp

@@ -904 +904 @@
                                 DeleteUnusedRootDirEntries(clientContext);
                                                                 
+                                // Notify administrator
+                                NotifySysadmin(NotifyEvent_BackupStart);
+
                                 // Go through the records, syncing them
                                 for(std::vector<Location *>::const_iterator 
@@ -986 +989 @@
                                 // Log
                                 BOX_NOTICE("Finished scan of local files");
+
+                                // Notify administrator
+                                NotifySysadmin(NotifyEvent_BackupFinish);
 
                                 // --------------------------------------------------------------------------------------------
@@ -2216 +2222 @@
 // Function
 //              Name:    BackupDaemon::NotifySysadmin(int)
-//              Purpose: Run the script to tell the sysadmin about events which need attention.
+//              Purpose: Run the script to tell the sysadmin about events
+//                       which need attention.
 //              Created: 25/2/04
 //
@@ -2227 +2234 @@
                 "read-error", 
                 "backup-error",
+                "backup-start",
+                "backup-finish",
                 0
         };
 
+        BOX_TRACE("sizeof(sEventNames)  == " << sizeof(sEventNames));
+        BOX_TRACE("sizeof(*sEventNames) == " << sizeof(*sEventNames));
+        BOX_TRACE("NotifyEvent__MAX == " << NotifyEvent__MAX);
+        ASSERT((sizeof(sEventNames)/sizeof(*sEventNames)) == NotifyEvent__MAX + 1);
+
         BOX_TRACE("BackupDaemon::NotifySysadmin() called, event = " << 
                 sEventNames[Event]);
@@ -2235 +2249 @@
         if(Event < 0 || Event >= NotifyEvent__MAX)
         {
-                THROW_EXCEPTION(BackupStoreException, BadNotifySysadminEventCode);
+                THROW_EXCEPTION(BackupStoreException,
+                        BadNotifySysadminEventCode);
         }
 
         // Don't send lots of repeated messages
-        if(mNotificationsSent[Event])
-        {
+        if(mNotificationsSent[Event] &&
+                Event != NotifyEvent_BackupStart &&
+                Event != NotifyEvent_BackupFinish)
+        {
+                BOX_WARNING("Suppressing duplicate notification about " <<
+                        sEventNames[Event]);
                 return;
         }
@@ -2246 +2265 @@
         // Is there a notifation script?
         const Configuration &conf(GetConfiguration());
-        if(!conf.KeyExists("NotifyScript"))
+        if(!conf.KeyExists("NotifyScript") &&
+                Event != NotifyEvent_BackupStart &&
+                Event != NotifyEvent_BackupFinish)
         {
                 // Log, and then return
@@ -2256 +2277 @@
 
         // Script to run
-        std::string script(conf.GetKeyValue("NotifyScript") + ' ' + sEventNames[Event]);
+        std::string script(conf.GetKeyValue("NotifyScript") + ' ' +
+                sEventNames[Event]);
         
         // Log what we're about to do
@@ -2270 +2292 @@
         }
 
-        // Flag that this is done so the administrator isn't constantly bombarded with lots of errors
+        // Flag that this is done so the administrator isn't constantly
+        // bombarded with lots of errors
         mNotificationsSent[Event] = true;
 }

box/chris/general/bin/bbackupd/BackupDaemon.h

@@ -86 +86 @@
                 NotifyEvent_ReadError,
                 NotifyEvent_BackupError,
+                NotifyEvent_BackupStart,
+                NotifyEvent_BackupFinish,
                 NotifyEvent__MAX
                 // When adding notifications, remember to add strings to NotifySysadmin()

box/chris/general/bin/bbackupd/bbackupd-config.in

@@ -212 +212 @@
 #!/bin/sh
 
+# This script is run whenever bbackupd changes state or encounters a
+# problem which requires the system administrator to assist:
+#
+# 1) The store is full, and no more data can be uploaded.
+# 2) Some files or directories were not readable.
+# 3) A backup run starts or finishes.
+#
+# The default script emails the system administrator, except for backups
+# starting and stopping, where it does nothing.
+
 SUBJECT="BACKUP PROBLEM on host $hostname"
 SENDTO="$current_username"
 
-if [ \$1 = store-full ]
-then
-$sendmail \$SENDTO <<EOM
+if [ "\$1" = "" ]; then
+        echo "Usage: $0 <store-full|read-error|backup-error|backup-start|backup-finish>" >&2
+        exit 2
+elif [ "\$1" = store-full ]; then
+        $sendmail \$SENDTO <<EOM
 Subject: \$SUBJECT (store full)
 To: \$SENDTO
@@ -231 +243 @@
 
 EOM
-elif [ \$1 = read-error ]
-then
+elif [ "\$1" = read-error ]; then
 $sendmail \$SENDTO <<EOM
 Subject: \$SUBJECT (read errors)
@@ -245 +256 @@
 
 Check the logs on $hostname for the files and directories which caused
-these errors, and take appropraite action.
+these errors, and take appropriate action.
 
 Other files are being backed up.
 
 EOM
+elif [ "\$1" = backup-start -o "\$1" = backup-finish ]; then
+        # do nothing by default
+        true
 else
 $sendmail \$SENDTO <<EOM
@@ -288 +302 @@
 
 
-# This script is run whenever bbackupd encounters a problem which requires
-# the system administrator to assist:
+# This script is run whenever bbackupd changes state or encounters a
+# problem which requires the system administrator to assist:
+#
 # 1) The store is full, and no more data can be uploaded.
 # 2) Some files or directories were not readable.
-# The default script emails the system administrator.
+# 3) A backup run starts or finishes.
+#
+# The default script emails the system administrator, except for backups
+# starting and stopping, where it does nothing.
 
 NotifyScript = $notify_script
@@ -303 +321 @@
         print CONFIG <<__E;
 
-# The number of seconds between backup runs under normal conditions. A scan To 
-# avoid cycles of load on the server, this time is randomly adjusted by a 
-# small percentage as the daemon runs.
+# The number of seconds between backup runs under normal conditions. To avoid 
+# cycles of load on the server, this time is randomly adjusted by a small 
+# percentage as the daemon runs.
 
 UpdateStoreInterval = 3600