Changeset 1762

Timestamp:

2000-12-07T18:18:21+13:00 (23 years ago)

Author:

sjboddie

Message:

Added support for the new LogEvents, EmailEvents, EmailUserEvents and
MailServer configuration options (though they haven't actually been
implemented yet).

Location:

trunk/gsdl

Files:

• bin/script/build (modified) (10 diffs)
• perllib/cpan (added)
• perllib/cpan/Mail (added)
• perllib/cpan/Mail/Sendmail.pm (added)
• src/recpt/receptionist.cpp (modified) (3 diffs)
• src/recpt/receptionist.h (modified) (2 diffs)

trunk/gsdl/bin/script/build

@@ -4 +4 @@
 # windows (build.bat is in bin\windows)
 
+# Note that this script has grown over time and now has many options for
+# use when called from within the collector. If it appears to
+# over-complicate things a little, that's why.
+
 package build;
 
+use lib qq($ENV{'GSDLHOME'}/perllib/cpan);
 use FileHandle;
 use File::Copy;
+use Mail::Sendmail;
+
 
 BEGIN {
@@ -85 +92 @@
 if (-e &util::filename_cat ($cdir, $collection, ".kill")) {
     &util::rm (&util::filename_cat ($cdir, $collection, ".kill"));
+}
+
+# get maintainer email address from main.cfg
+my $maintainer = "NULL";
+my $main_cfg = &util::filename_cat ($ENV{'GSDLHOME'}, "etc", "main.cfg");
+my $cfgdata = &cfgread::read_cfg_file ($main_cfg, "maintainer");
+if (defined $cfgdata->{'maintainer'} && $cfgdata->{'maintainer'} =~ /\w/) {
+    $maintainer = $cfgdata->{'maintainer'};
+}
+# if maintainer is "NULL" email_events should be disabled
+if ($maintainer =~ /^NULL$/i) {
+    $email_events = "";
 }
 
@@ -120 +139 @@
     print STDERR "                           archives.org\n";
     print STDERR "   -out                    Filename or handle to print output status to.\n";
-    print STDERR "                           The default is STDERR\n\n";
+    print STDERR "                           The default is STDERR\n";
+    print STDERR "   -log_events             Log important events (collection built successfully etc.)\n";
+    print STDERR "                           to event_log_file\n";
+    print STDERR "   -event_log_file file    File to append important events to (defaults to\n";
+    print STDERR "                           " . &util::filename_cat ($ENV{'GSDLHOME'}, "etc", "events.txt") . "\n";
+    print STDERR "   -email_events addr      Comma separated list of email addresses to mail details\n";
+    print STDERR "                           of important collection building events\n";
+    print STDERR "   -mail_server server     The outgoing (SMTP) mail server to be used by email_events.\n";
+    print STDERR "                           email_events will be disabled if mail_server isn't set\n";
+    print STDERR "   -event_header file      File containing a header to go on any event messages. If not\n";
+    print STDERR "                           specified build will create a generic header\n\n";
 }
 
@@ -250 +279 @@
     } else {
         # no import or archives
-        print $out "build: ERROR: The $collection collection has no import or archives data.\n";
+        my $msg = "build: ERROR: The $collection collection has no import or archives data.\n";
+        print $out $msg;
+        &log_event ($msg);
         &final_out (1) if $use_out;
         die "\n";
@@ -265 +296 @@
         my $olddir = &util::filename_cat ($collectdir, $collection);
         if (-d $newdir) {
-        print $out "build: Could not install collection as $newdir\n";
-        print $out "       already exists. Collection will remain at\n";
-        print $out "       $olddir\n";
+        my $msg = "build: Could not install collection as $newdir\n" .
+            "       already exists. Collection will remain at\n$olddir\n";
+
+        print $out $msg;
+        &log_event ($msg);
         &final_out (4) if $use_out;
         die "\n";
         }
         if (!&File::Copy::move ($olddir, $newdir)) {
-        print $out "build: Failed to install collection to $newdir\n";
-        print $out "       Collection will remain at $olddir\n";
+        my $msg = "build: Failed to install collection to $newdir\n" .
+            "       Collection will remain at $olddir\n";
+        print $out $msg;
+        &log_event ($msg);
         &final_out (5) if $use_out;
         die "\n";
@@ -280 +315 @@
     }
 
+    &log_event ("The $collection collection was built successfully\n");
     &final_out (0) if $use_out;
 }
@@ -303 +339 @@
     }
     } else {
+    my $msg = "build: ERROR: import.pl failed\n";
+    print $out "\n$msg";
+    &log_event ($msg);
     &final_out (2) if $use_out;
-    print $out "\nimport.pl failed\n";
     die "\n";
     }
@@ -329 +367 @@
     }
     } else {
+    my $msg = "build: ERROR: buildcol.pl failed\n";
+    print $out "\n$msg";
+    &log_event ($msg);
     &final_out (3) if $use_out;
-    print $out "\nbuildcol.pl failed\n";
     die "\n";
     }
@@ -387 +427 @@
     }
 }
+
+sub log_event {
+    my ($msg) = @_;
+
+    return unless ($log_events || $email_events);
+
+    # get the event header
+    my $eheader = "";
+    if ($event_header ne "" && open (HEADER, $event_header)) {
+    undef $/;
+    $eheader = HEADER;
+    $/ = "\n";
+    close HEADER;
+    } else {
+    $eheader = "[Build Event]\n";
+    $eheader .= "Date: " . scalar localtime() . "\n";
+    $eheader .= "Collection: $collection\n";
+    }
+    
+    if ($log_events) {
+    my $fail = 0;
+    # append the event to the event log file
+    if ($event_log_file eq "" || !open (LOG, ">>$event_log_file")) {
+        # log file defaults to $GSDLHOME/etc/events.txt
+        $event_log_file = &util::filename_cat ($ENV{'GSDLHOME'}, "etc", "events.txt");
+        if (!open (LOG, ">>$event_log_file")) {
+        print $out "build: ERROR: Couldn't open event log file $event_log_file\n";
+        $fail = 1;
+        }
+    }
+    if (!$fail) {
+        print LOG $eheader;
+        print LOG $msg;
+        close LOG;
+    }
+    }
+    
+    if ($email_events) {
+    # if mail_server isn't set email_events does nothing
+    if ($mail_server eq "") {
+        print $out "build: WARNING: mail_server was not set - email_events option was ignored\n";
+        return;
+    }
+    
+    my %mail = ('SMTP' => $mail_server, 
+            'To' => $email_events,
+            'From' => $maintainer,
+            'Subject' => 'Greenstone Build Event'
+            );
+    $mail{'Message'} = $eheader . $msg;
+    
+    if (!sendmail %mail) {
+        print $out "build: ERROR sending mail to $email_events\n";
+        print $out "'$Mail::Sendmail::error'\n";
+    }
+    }
+}
+
 
 sub parse_args {
@@ -402 +500 @@
              'dontinstall', \$dontinstall,
              'save_archives', \$save_archives,
-             'out/.*/STDERR', \$out)) {
+             'out/.*/STDERR', \$out,
+             'log_events', \$log_events,
+             'event_log_file/.*/', \$event_log_file,
+             'email_events/.*/', \$email_events,
+             'mail_server/.*/', \$mail_server,
+             'event_header/.*/', \$event_header)) {
     
     &print_usage();

trunk/gsdl/src/recpt/receptionist.cpp

@@ -56 +56 @@
   usecookies = false;
   logcgiargs = false;
+
+  maintainer.clear();
+  MailServer.clear();
+  LogEvents = Disabled;
+  EmailEvents = Disabled;
+  EmailUserEvents = false;
 
   // these default page parameters can always be overriden
@@ -206 +212 @@
     else if (key == "usecookies") configinfo.usecookies = (cfgline[0] == "true");
     else if (key == "logcgiargs") configinfo.logcgiargs = (cfgline[0] == "true");
+    else if (key == "maintainer") configinfo.maintainer = cfgline[0];
+    else if (key == "MailServer") configinfo.MailServer = cfgline[0];
+    else if (key == "LogEvents") {
+      if (cfgline[0] == "CollectorEvents") configinfo.LogEvents = CollectorEvents;
+      else if (cfgline[0] == "AllEvents") configinfo.LogEvents = AllEvents;
+    } 
+    else if (key == "EmailEvents") {
+      if (cfgline[0] == "CollectorEvents") configinfo.EmailEvents = CollectorEvents;
+      else if (cfgline[0] == "AllEvents") configinfo.EmailEvents = AllEvents;
+    } 
+    else if (key == "EmailUserEvents") configinfo.EmailUserEvents = (cfgline[0] == "true");
     else if (key == "pageparam") {
       if (cfgline.size() >= 2) configinfo.pageparams[cfgline[0]] = cfgline[1];
@@ -399 +416 @@
   }
 
+  // if maintainer email address is something dodgy (for now I'll define
+  // dodgy as being anything that doesn't contain '@') disable EmailEvents
+  // and EmailUserEvents
+  text_t::const_iterator maintainer_end = configinfo.maintainer.end ();
+  text_t::const_iterator maintainer_here = findchar (configinfo.maintainer.begin(),
+                             maintainer_end, '@');
+  if (maintainer_here == maintainer_end) {
+    configinfo.EmailEvents = Disabled;
+    configinfo.EmailUserEvents = Disabled;
+  } else {
+    // if MailServer isn't set it should default to mail.maintainer-domain
+    if (configinfo.MailServer.empty()) {
+      configinfo.MailServer = "mail." + substr (maintainer_here, maintainer_end);
+    }
+  }
+
   // init the actions
   actionptrmap::iterator actionhere = actions.begin ();

trunk/gsdl/src/recpt/receptionist.h

@@ -62 +62 @@
 typedef map<text_t, collectioninfo_t, lttext_t> colinfo_tmap;
 
+enum events_t {Disabled, CollectorEvents, AllEvents};
 
 struct recptconf {
@@ -77 +78 @@
   bool logcgiargs;  // true if we want to log cgi arguments
 
+  text_t maintainer; // email address of maintainer
+  text_t MailServer; // SMTP mail server to use when sending event messages by email
+                     // defaults to mail.maintainer-domain
+  events_t LogEvents;
+  events_t EmailEvents;
+  bool EmailUserEvents;
+
   text_tmap pageparams;
   text_t macroprecedence;