Changeset 1778

Timestamp:

2000-12-08T17:00:35+13:00 (23 years ago)

Author:

sjboddie

Message:

Implemented the new MailServer, LogEvents, EmailEvents and EmailUserEvents
configuration options.

Location:

trunk/gsdl

Files:

• bin/script/build (modified) (5 diffs)
• lib/gsdltimes.cpp (modified) (3 diffs)
• lib/gsdltimes.h (modified) (1 diff)
• perllib/cpan/Mail/Sendmail.pm (modified) (2 diffs)
• src/recpt/collectoraction.cpp (modified) (9 diffs)
• src/recpt/collectoraction.h (modified) (1 diff)
• src/recpt/receptionist.cpp (modified) (2 diffs)

trunk/gsdl/bin/script/build

@@ -1 @@
-#!/usr/bin/perl
+#!/usr/bin/perl -w
+
+###########################################################################
+#
+# build --
+# A component of the Greenstone digital library software
+# from the New Zealand Digital Library Project at the 
+# University of Waikato, New Zealand.
+#
+# Copyright (C) 2000 New Zealand Digital Library Project
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+###########################################################################
 
 # This perl script may be called directly or by running build.bat on
@@ -10 +35 @@
 package build;
 
-use lib qq($ENV{'GSDLHOME'}/perllib/cpan);
 use FileHandle;
 use File::Copy;
-use Mail::Sendmail;
-
 
 BEGIN {
@@ -28 +50 @@
 }
 
+use lib qq($ENV{'GSDLHOME'}/perllib/cpan);
+use Mail::Sendmail;
 use parsargv;
 use util;
@@ -434 +458 @@
 
     # get the event header
-    my $eheader = "";
+    my $eheader = "[Build Event]\n";
+    $eheader .= "Date: " . scalar localtime() . "\n";
     if ($event_header ne "" && open (HEADER, $event_header)) {
     undef $/;
-    $eheader = HEADER;
+    $eheader .= <HEADER>;
     $/ = "\n";
     close HEADER;
     } else {
-    $eheader = "[Build Event]\n";
-    $eheader .= "Date: " . scalar localtime() . "\n";
     $eheader .= "Collection: $collection\n";
+    $eheader .= "GSDLHOME: $ENV{'GSDLHOME'}\n";
+    $eheader .= "Build Location: $collectdir\n";
     }
     
@@ -460 +485 @@
         print LOG $eheader;
         print LOG $msg;
+        print LOG "\n";
         close LOG;
     }

trunk/gsdl/lib/gsdltimes.cpp

@@ -26 +26 @@
 #include "gsdltimes.h"
 
-
+// returns a string of the form "YYYY/MM/DD hh:mm:ss" (expressed in
+// Coordinated Universal Time (UTC))
 // returns "" if an error occurs
 text_t time2text (time_t time) {
@@ -63 +64 @@
 }
 
+// takes a string like that returned by time2text and returns corresponding time_t
 // returns -1 if an error occurs
 time_t text2time (const text_t &timestr) {
@@ -114 +116 @@
   return mktime (&timetm);
 }
+
+// returns current date and time formatted like "Thu Dec 7 23:43:38 2000"
+// if ltime is true return value will be expressed in local time, otherwise
+// it'll be Coordinated Universal Time (UTC)
+// returns "" if an error occurs
+text_t get_date (bool ltime) {
+
+  char *timestr;
+  tm *tm_ptr = NULL;
+  time_t t = time(NULL);
+  if (ltime) tm_ptr = localtime (&t);
+  else tm_ptr = gmtime (&t);
+  if (tm_ptr == NULL) return "";
+
+  strftime (timestr, 128, "%a %b %e %T %Y", tm_ptr);
+  text_t ret = timestr;
+  return ret;
+}

trunk/gsdl/lib/gsdltimes.h

@@ -39 +39 @@
 time_t text2time (const text_t &timestr);
 
+
+// returns formatted date in local or UTC time
+// returns "" if an error occurs
+text_t get_date (bool ltime);
+
 #endif

trunk/gsdl/perllib/cpan/Mail/Sendmail.pm

@@ -18 +18 @@
 %mailcfg = (
     # List of SMTP servers:
-    'smtp'    => [ qw( localhost ) ],
-    #'smtp'    => [ qw( mail.mydomain.com ) ], # example
+    'smtp'    => [],
 
     'from'    => '', # default sender e-mail, used when no From header in mail
@@ -164 +163 @@
 
     $smtp = $mail{'Smtp'} || $mail{'Server'} || $default_smtp_server;
-    unshift @{$mailcfg{'smtp'}}, $smtp if ($smtp and $mailcfg{'smtp'}->[0] ne $smtp);
+#    unshift @{$mailcfg{'smtp'}}, $smtp if ($smtp and $mailcfg{'smtp'}->[0] ne $smtp);
+    unshift @{$mailcfg{'smtp'}}, $smtp if $smtp; # Change here to avoid undefined value
+                                                 # with our empty mailcfg{'smtp'} - Stefan
 
     # delete non-header keys, so we don't send them later as mail headers

trunk/gsdl/src/recpt/collectoraction.cpp

@@ -35 +35 @@
 #include "cfgread.h"
 #include "gsdltools.h"
+#include "gsdltimes.h"
 #include "nullproto.h"
 
@@ -1020 +1021 @@
     
     } else {
+
+      const recptconf &rcinfo = recpt->get_configinfo ();
+      bool emailuserevents = rcinfo.EmailUserEvents;
+
+      // get collection maintainer email from collect.cfg before we
+      // delete it
+      text_t colmaintainer;
+      text_t cfgfile = filename_cat(gsdlhome, "collect", collection, "etc", "collect.cfg");
+      char *cfgfilec = cfgfile.getcstr();
+      ifstream cfg_in (cfgfilec);
+      delete cfgfilec;
+      if (cfg_in) {
+    text_tarray cfgline;
+    while (read_cfg_line(cfg_in, cfgline) >= 0) {
+      if (cfgline.size () == 2 && cfgline[0] == "maintainer") {
+        colmaintainer = cfgline[1];
+        break;
+      }
+    }
+    cfg_in.close();
+      }
+      if (colmaintainer.empty()) {
+    logout << outconvert 
+           << "collectoraction::do_action WARNING: Collection being deleted (" 
+           << collection << ") has no maintainer address. EmailUserEvents "
+           << "disabled\n";
+    emailuserevents = false;
+      }
+      
       // first we need to free up the collection's collection server
       // we must do this for the local library (and I guess when using
@@ -1026 +1056 @@
       remove_colservr (collection, logout);
 
+      
       char *collectionc = collection.getcstr();
       int rv = gsdl_call_perl ("delcol.pl", "-f", collectionc, NULL);
@@ -1034 +1065 @@
       } else {
     message = "delsuccess";
+      }
+
+      // log the event
+      if (rcinfo.LogEvents == CollectorEvents || rcinfo.LogEvents == AllEvents) {
+    
+    text_t eventlog = filename_cat (gsdlhome, "etc", "events.txt");
+    char *eventlogt = eventlog.getcstr();
+    ofstream eventl (eventlogt, ios::app);
+    delete eventlogt;
+
+    if (eventl) {
+      eventl << outconvert << "[Collector Event]\n"
+         << "Date: " << get_date (true) << "\n"
+         << "Greenstone Username: " << args["un"] << "\n"
+         << "Collection: " << collection << "\n"
+         << "Collection Maintainer: " << colmaintainer << "\n"
+         << "GSDLHOME: " << gsdlhome << "\n";
+
+      if (message == "delsuccess") {
+        eventl << outconvert 
+           << "The " << collection << " collection was successfully deleted\n\n";
+      } else {
+        eventl << outconvert 
+           << "Attempt to delete the " << collection << " collection failed\n\n";
+      }
+      eventl.close();
+
+    } else {
+      logout << outconvert << "collectoraction::do_action ERROR: Couldn't open "
+         << "event log file " << eventlog << " for appending during collection "
+         << "deletion. LogEvents disabled\n";
+    }
+      }
+      
+      if (rcinfo.EmailEvents == CollectorEvents || rcinfo.EmailEvents == AllEvents || emailuserevents) {
+    // use sendmail.pl perl script to send email events
+    text_t tmpmailfile = filename_cat (gsdlhome, "tmp", args["bc1tmp"], "event.txt");
+    char *tmpmailfilec = tmpmailfile.getcstr();
+    ofstream tmpfile (tmpmailfilec);
+    if (tmpfile) {
+      tmpfile << outconvert << "[Collector Event]\n"
+              << "Date: " << get_date (true) << "\n"
+          << "Greenstone Username: " << args["un"] << "\n"
+          << "Collection: " << collection << "\n"
+          << "Collection Maintainer: " << colmaintainer << "\n"
+          << "GSDLHOME: " << gsdlhome << "\n";
+      if (message == "delsuccess") {
+        tmpfile << outconvert 
+            << "The " << collection << " collection was successfully deleted\n\n";
+      } else {
+        tmpfile << outconvert 
+            << "Attempt to delete the " << collection << " collection failed\n\n";
+      }
+      tmpfile.close();
+      text_t to;
+      if (rcinfo.EmailEvents == CollectorEvents || rcinfo.EmailEvents == AllEvents) to += rcinfo.maintainer;
+      if (emailuserevents) {
+        if (!to.empty()) to.push_back (',');
+        to += colmaintainer;
+      }
+      char *to_c = to.getcstr();
+      char *from_c = rcinfo.maintainer.getcstr();
+      char *smtp_c = rcinfo.MailServer.getcstr();
+      gsdl_call_perl ("sendmail.pl", "-to", to_c, "-from", from_c, "-smtp", smtp_c, 
+              "-subject", "Greenstone Collector Event", "-msgfile", tmpmailfilec, NULL);
+      delete (to_c);
+      delete (from_c);
+      delete (smtp_c);
+      
+    } else {
+      logout << outconvert << "collectoraction::do_action ERROR: Couldn't open "
+         << "temporary event log file " << tmpmailfile << " during collection "
+         << "deletion. EmailEvents and EmailUserEvents disabled\n";
+    }
+    delete (tmpmailfilec);
       }
     }
@@ -1251 +1357 @@
 void collectoraction::gsdl_build (cgiargsclass &args, ostream &logout) {
 
+  outconvertclass text_t2ascii;
+
   text_t tmpdir = filename_cat (gsdlhome, "tmp", args["bc1tmp"]);
   if (!directory_exists (tmpdir)) {
@@ -1283 +1391 @@
   }
 
+  const recptconf &rcinfo = recpt->get_configinfo ();
+
+  // create the event header file if LogEvents, EmailEvents or
+  // EmailUserEvents options are turned on.
+  bool logevents = 
+    (rcinfo.LogEvents == CollectorEvents || rcinfo.LogEvents == AllEvents || 
+     rcinfo.EmailEvents == CollectorEvents || rcinfo.EmailEvents == AllEvents ||
+     rcinfo.EmailUserEvents);
+  text_t ehead_file = filename_cat (tmpdir, "ehead.txt");
+  if (logevents) {
+    if (!create_event_header_file (ehead_file, args, logout)) {
+      logevents = false;
+    }
+  }
+    
   // set up build options
   text_t options = "-remove_import -out \"";
@@ -1301 +1424 @@
   if (!args["bc1inputdir4"].empty())
     options += " -download \"" + args["bc1inputdir4"] + "\"";
+
+  if (logevents) {
+    if (rcinfo.LogEvents == CollectorEvents || rcinfo.LogEvents == AllEvents) 
+      options += " -log_events";
+    if (rcinfo.EmailEvents == CollectorEvents || rcinfo.EmailEvents == AllEvents) {
+      options += " -mail_server " + rcinfo.MailServer;
+      options += " -email_events " + rcinfo.maintainer;
+      if (rcinfo.EmailUserEvents) options += "," + args["bc1contactemail"];
+    } else if (rcinfo.EmailUserEvents) {
+      options += " -mail_server " + rcinfo.MailServer;
+      options += " -email_events " + args["bc1contactemail"];
+    }
+    options += " -event_header " + ehead_file;
+  }
+
   text_t optionfile = filename_cat (tmpdir, "build.opt");
   char *optionfilec = optionfile.getcstr();
@@ -1309 +1447 @@
     return;
   }
-  outconvertclass text_t2ascii;
   ofile_out << text_t2ascii << options << "\n";
   ofile_out.close();
@@ -1437 +1574 @@
   logout << "collectoraction::create_colserver: no valid nullproto found\n";
 }
+
+bool collectoraction::create_event_header_file (const text_t &filename, cgiargsclass &args, 
+                        ostream &logout) {
+
+  outconvertclass text_t2ascii;
+  char *filenamec = filename.getcstr();
+  ofstream eheadfile (filenamec);
+  delete filenamec;
+
+  if (eheadfile) {
+    eheadfile << text_t2ascii << get_event_header (args);
+    eheadfile.close();
+    return true;
+  }
+   
+  logout << text_t2ascii << "collectoraction::create_event_header ERROR: Couldn't create "
+     << "Event Header file " << filename << ". Event logging disabled\n";
+  return false;
+}
+
+text_t collectoraction::get_event_header (cgiargsclass &args) {
+  text_t header = "Greenstone Username: " + args["un"] + "\n";
+  header += "Collection: " + args["bc1dirname"] + "\n";
+  header += "Collection Creator: " + args["bc1contactemail"] + "\n";
+  header += "GSDLHOME: " + gsdlhome + "\n";
+  header += "Build Location: " + get_collectdir(args) + "\n";
+
+  return header;
+}

trunk/gsdl/src/recpt/collectoraction.h

@@ -83 +83 @@
   void remove_colservr (const text_t &collection, ostream &logout);
 
+  bool create_event_header_file (const text_t &filename, cgiargsclass &args, 
+                 ostream &logout);
+
+  text_t get_event_header (cgiargsclass &args);
+
 public:
   collectoraction ();

trunk/gsdl/src/recpt/receptionist.cpp

@@ -418 +418 @@
   // if maintainer email address is something dodgy (for now I'll define
   // dodgy as being anything that doesn't contain '@') disable EmailEvents
-  // and EmailUserEvents
+  // and EmailUserEvents (we don't strictly need to disable EmailUserEvents
+  // in this case but we will as it seems likely that MailServer will also
+  // be screwed up if maintainer is).
   text_t::const_iterator maintainer_end = configinfo.maintainer.end ();
   text_t::const_iterator maintainer_here = findchar (configinfo.maintainer.begin(),
@@ -428 +430 @@
     // if MailServer isn't set it should default to mail.maintainer-domain
     if (configinfo.MailServer.empty()) {
-      configinfo.MailServer = "mail." + substr (maintainer_here, maintainer_end);
+      configinfo.MailServer = "mail." + substr (maintainer_here+1, maintainer_end);
     }
   }