Changeset 200

Timestamp:

1999-03-11T13:12:30+13:00 (25 years ago)

Author:

rjmcnab

Message:

Started using status.dm to handle the bulky text. Made the status
action use frames and added some more information.

Location:

trunk/gsdl/src/recpt

Files:

• statusaction.cpp (modified) (10 diffs)
• statusaction.h (modified) (2 diffs)

trunk/gsdl/src/recpt/statusaction.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.8  1999/03/11 00:12:30  rjmcnab
+   Started using status.dm to handle the bulky text. Made the status
+   action use frames and added some more information.
+
    Revision 1.7  1999/03/09 21:00:47  rjmcnab
    Reorganised the statusaction, added more functions to comtypes.
@@ -46 +50 @@
 
 
-void statusaction::output_generalinfo (cgiargsclass &/*args*/, displayclass &/*disp*/, 
+void statusaction::output_frameset (cgiargsclass &/*args*/, displayclass &disp, 
+                    outconvertclass &outconvert, 
+                    ostream &textout, ostream &/*logout*/) {
+  textout << outconvert << disp << "_status:frameset_\n";
+}
+
+void statusaction::output_select (cgiargsclass &/*args*/, displayclass &disp, 
+                  outconvertclass &outconvert, 
+                  ostream &textout, ostream &/*logout*/) {
+  textout << outconvert << disp << "_status:header_(selector)\n"
+    "_status:select_\n"
+    "_status:footer_\n";
+}
+
+void statusaction::output_generalinfo (cgiargsclass &/*args*/, displayclass &disp, 
                        outconvertclass &outconvert, 
                        ostream &textout, ostream &/*logout*/) {
+  if (recpt == NULL) return;
   const recptconf &rcinfo = recpt->get_configinfo ();
   
-  textout << outconvert << "<table>\n";
-  textout << outconvert << "<tr valign=top><th>gsdlhome</th><td>\"" << rcinfo.gsdlhome
+  textout << outconvert << disp << "_status:header_(General Information)\n";
+  textout << outconvert 
+      << "<h2>General information</h2>\n"
+      << "<table>\n"
+      << "<tr valign=top><th>gsdlhome</th><td>\"" << rcinfo.gsdlhome
+      << "\"</td></tr>\n"
+      << "<tr valign=top><th>collection</th><td>\"" << rcinfo.collection
+      << "\"</td></tr>\n"
+      << "<tr valign=top><th>collectdir</th><td>\"" << rcinfo.collectdir
+      << "\"</td></tr>\n"
+      << "<tr valign=top><th>httpimg</th><td>\"" << rcinfo.httpimg
+      << "\"</td></tr>\n"
+      << "<tr valign=top><th>gwcgi</th><td>\"" << rcinfo.gwcgi
       << "\"</td></tr>\n";
-  textout << outconvert << "<tr valign=top><th>collection</th><td>\"" << rcinfo.collection
-      << "\"</td></tr>\n";
-  textout << outconvert << "<tr valign=top><th>collectdir</th><td>\"" << rcinfo.collectdir
-      << "\"</td></tr>\n";
-  textout << outconvert << "<tr valign=top><th>httpimg</th><td>\"" << rcinfo.httpimg
-      << "\"</td></tr>\n";
-  textout << outconvert << "<tr valign=top><th>gwcgi</th><td>\"" << rcinfo.gwcgi
-      << "\"</td></tr>\n";
-  
-  
+    
   // macrofiles
   textout << outconvert << "<tr valign=top><th>macrofiles</th><td>";
@@ -158 +179 @@
   }
   
-  
-  textout << outconvert 
-      << "</table>\n";
-}
-
-void statusaction::output_argumentinfo (cgiargsclass &args, displayclass &/*disp*/, 
+  textout << outconvert << disp << "</table>\n_status:footer_\n";
+}
+
+void statusaction::output_argumentinfo (cgiargsclass &args, displayclass &disp, 
                     outconvertclass &outconvert, 
                     ostream &textout, ostream &/*logout*/) {
+  if (recpt == NULL) return;
   cgiargsinfoclass *rcargsinfo = recpt->get_cgiargsinfo_ptr ();
 
+  textout << outconvert << disp << "_status:header_(Argument Information)\n";
   textout << outconvert
       << "<h2>Argument information</h2>\n"
@@ -214 +235 @@
   }
   
-  textout << outconvert 
-      << "</table>\n";
-}
-
-void statusaction::output_actioninfo (cgiargsclass &/*args*/, displayclass &/*disp*/, 
+  textout << outconvert << disp << "</table>\n_status:footer_\n";
+}
+
+void statusaction::output_actioninfo (cgiargsclass &/*args*/, displayclass &disp, 
                       outconvertclass &outconvert, 
                       ostream &textout, ostream &/*logout*/) {
+  if (recpt == NULL) return;
   actionmapclass *actions = recpt->get_actionmap_ptr();
 
+  textout << outconvert << disp << "_status:header_(Action Information)\n";
   textout << outconvert
       << "<h2>Action information</h2>\n"
@@ -258 +280 @@
   }
   
+  textout << outconvert << disp << "</table>\n_status:footer_\n";
+}
+
+void statusaction::output_protocolinfo (cgiargsclass &/*args*/, displayclass &disp, 
+                    outconvertclass &outconvert, 
+                    ostream &textout, ostream &logout) {
+  if (recpt == NULL) return;
+  const recptconf &rcinfo = recpt->get_configinfo ();
+  bool colspecific = !rcinfo.collection.empty();
+  bool unreachablecol = false;
+
+  recptprotolistclass *rprotolist = recpt->get_recptprotolist_ptr ();
+  if (rprotolist == NULL) return;
+
+  textout << outconvert << disp << "_status:header_(Protocol Information)\n";
+  textout << outconvert
+      << "<h2>Protocol information</h2>\n"
+      << "<table>\n"
+      << "<tr><th>protocol</th><th>collections</th></tr>\n";
+
+  text_t protoname;
+  recptprotolistclass::iterator rprotolist_here = rprotolist->begin();
+  recptprotolistclass::iterator rprotolist_end = rprotolist->end();
+  while (rprotolist_here != rprotolist_end) {
+    if ((*rprotolist_here).p != NULL) {
+      protoname = (*rprotolist_here).p->get_protocol_name();
+      textout << outconvert
+          << "<tr><td>"
+          << protoname
+          << "</td><td>";
+
+      text_tarray collist;
+      comerror_t err;
+      (*rprotolist_here).p->get_collection_list (collist, err, logout);
+      if (err == noError) {
+    text_tarray::iterator collist_here = collist.begin();
+    text_tarray::iterator collist_end = collist.end();
+    bool first = true;
+    while (collist_here != collist_end) {
+      if (!first) textout << outconvert << ", ";
+      first = false;
+
+      if (colspecific && *collist_here != rcinfo.collection) {
+        unreachablecol = true;
+        textout << outconvert << "\"" << *collist_here << "\"";
+      } else {
+        textout << outconvert << disp
+            << "\"<a href=\"_gwcgi_?a=status&sp=collectioninfo&pr="
+            << protoname
+            << "&c="
+            << *collist_here
+            << "\">"
+            << *collist_here 
+            << "</a>\"";
+      }
+
+      collist_here++;
+    }
+
+      } else {
+    textout << outconvert << "Error (" << get_comerror_string (err) 
+        << ") while getting collect list\n";
+      }
+
+      textout << outconvert 
+          << "</td></tr>\n";
+    }
+
+    rprotolist_here++;
+  }
+
   textout << outconvert << "</table>\n";
-}
-
-void statusaction::output_protocolinfo (cgiargsclass &/*args*/, displayclass &/*disp*/, 
-                    outconvertclass &/*outconvert*/, 
-                    ostream &/*textout*/, ostream &/*logout*/) {
-}
-
-void statusaction::output_collectioninfo (cgiargsclass &/*args*/, displayclass &/*disp*/, 
-                      outconvertclass &/*outconvert*/, 
-                      ostream &/*textout*/, ostream &/*logout*/) {
-}
-
-void statusaction::output_initlog (cgiargsclass &/*args*/, displayclass &/*disp*/,
+  if (unreachablecol) {
+    textout << outconvert 
+        << "<b>Warning:</b> the receptionist is running in collection specific\n"
+        << "mode making some of the collections unreachable.\n";
+  }
+  textout << outconvert << disp << "_status:footer_\n";
+}
+
+void statusaction::output_collectioninfo (cgiargsclass &args, displayclass &disp, 
+                      outconvertclass &outconvert, 
+                      ostream &textout, ostream &logout) {
+  if (recpt == NULL) return;
+
+  textout << outconvert << disp << "_status:header_(Collection info)\n";
+  textout << outconvert << "<h2>Collection info</h2>\n";
+
+  // get the list of protocols
+  recptprotolistclass *rprotolist = recpt->get_recptprotolist_ptr ();
+  if (rprotolist == NULL) return;
+
+  // look for the desired protocol
+  text_t &arg_pr = args["pr"];
+  text_t &arg_c = args["c"];
+  recptproto *rproto;
+  recptprotolistclass::iterator rprotolist_here = rprotolist->begin();
+  recptprotolistclass::iterator rprotolist_end = rprotolist->end();
+  while (rprotolist_here != rprotolist_end) {
+    rproto = (*rprotolist_here).p;
+    if (rproto != NULL && rproto->get_protocol_name() == arg_pr) {
+      // see if the protocol has the collection
+      bool hascollection;
+      comerror_t err;
+      rproto->has_collection (arg_c, hascollection, err, logout);
+      if (err == noError && hascollection) break;
+    }
+    rprotolist_here++;
+  }
+  
+  if (rprotolist_here == rprotolist_end) {
+    textout << outconvert << "Protocol \"" << arg_pr << "\" with collection \""
+        << arg_c << "\" was not found\n";
+
+  } else {
+    ColInfoResponse_t collectinfo;
+    comerror_t err;
+
+    rproto->get_collectinfo (arg_c, collectinfo, err, logout);
+    if (err == noError) {
+      textout << outconvert << "<table>\n"
+          << "<tr><th>collection name</th><td>\""
+          << collectinfo.shortInfo.name
+          << "\"</td></tr>\n"
+
+          << "<tr><th>host</th><td>\""
+          << collectinfo.shortInfo.host
+          << "\"</td></tr>\n"
+
+          << "<tr><th>port</th><td>\""
+          << collectinfo.shortInfo.port
+          << "\"</td></tr>\n"
+
+          << "<tr><th>is public?</th><td>\"";
+      if (collectinfo.isPublic) textout << outconvert << "true";
+      else textout << outconvert << "false";
+      textout << outconvert 
+          << "\"</td></tr>\n"
+
+          << "<tr><th>is beta?</th><td>\"";
+      if (collectinfo.isBeta) textout << outconvert << "true";
+      else textout << outconvert << "false";
+      textout << outconvert 
+          << "\"</td></tr>\n"
+
+          << "<tr><th>build date</th><td>\""
+          << collectinfo.buildDate
+          << "\"</td></tr>\n"
+
+          << "<tr><th>interface languages</th><td>";
+      text_tarray::iterator languages_here = collectinfo.languages.begin();
+      text_tarray::iterator languages_end = collectinfo.languages.end();
+      bool languages_first = true;
+      while (languages_here != languages_end) {
+    if (!languages_first) textout << outconvert << ", ";
+    languages_first = false;
+    textout << outconvert << "\"" << *languages_here << "\"";
+    languages_here++;
+      }
+      textout << outconvert 
+          << "</td></tr>\n"
+
+          << "<tr><th>number of documents</th><td>\""
+          << collectinfo.numDocs
+          << "\"</td></tr>\n"
+
+          << "<tr><th>number of words</th><td>\""
+          << collectinfo.numWords
+          << "\"</td></tr>\n"
+
+          << "<tr><th>number of bytes</th><td>\""
+          << collectinfo.numBytes
+          << "\"</td></tr>\n"
+
+          << "</table>";
+      
+    } else {
+      textout << outconvert << "Error (" << get_comerror_string (err) 
+          << ") while getting collect information\n";
+    }
+
+    textout << outconvert << "<hr>\n"
+        << "<h3>Metadata options</h3>\n";
+
+    MetadataInfoResponse_t metainfo;
+    rproto->get_metadataoptions (arg_c, metainfo, err, logout);
+    if (err == noError) {
+      textout << outconvert 
+          << "<table>\n"
+          << "<tr><th>supported fields</th><td>";
+      text_tset::iterator sup_here = metainfo.supportedFields.begin();
+      text_tset::iterator sup_end = metainfo.supportedFields.end();
+      bool sup_first = true;
+      while (sup_here != sup_end) {
+    if (!sup_first) textout << outconvert << ", ";
+    sup_first = false;
+    textout << outconvert << "\"" << *sup_here << "\"";
+    sup_here++;
+      }
+      textout << outconvert << "</td></tr>\n"
+    
+          << "<tr><th>supported languages</th><td>";
+      sup_here = metainfo.supportedLanguages.begin();
+      sup_end = metainfo.supportedLanguages.end();
+      sup_first = true;
+      while (sup_here != sup_end) {
+    if (!sup_first) textout << outconvert << ", ";
+    sup_first = false;
+    textout << outconvert << "\"" << *sup_here << "\"";
+    sup_here++;
+      }
+      textout << outconvert << "</td></tr>\n"
+          << "</table>\n";
+
+    } else {
+      textout << outconvert << "Error (" << get_comerror_string (err) 
+          << ") while getting metadata information\n";
+    }
+
+    textout << outconvert << "<hr>\n";
+
+    InfoFilterOptionsResponse_t filterinfo;
+    rproto->get_filteroptions (arg_c, filterinfo, err, logout);
+    if (err == noError) {
+      FilterDescript_tmap::iterator filter_here = 
+    filterinfo.filterOptions.begin();
+      FilterDescript_tmap::iterator filter_end = 
+    filterinfo.filterOptions.end();
+      while (filter_here != filter_end) {
+    textout << outconvert 
+        << "<h3>Filter options for \"" << (*filter_here).first << "\"</h3>\n"
+        << "<table>\n"
+        << "<tr><th>option name</th><th>type</th><th>repeatable</th>"
+        << "<th>default value</th><th>valid values</th></tr>\n";
+
+    FilterOption_tmap::iterator filteropt_here = 
+      (*filter_here).second.filterOptions.begin();
+    FilterOption_tmap::iterator filteropt_end = 
+      (*filter_here).second.filterOptions.end();
+    while (filteropt_here != filteropt_end) {
+      textout << outconvert
+          << "<tr><td>\""
+          << (*filteropt_here).second.name
+          << "\"</td>\n"
+
+          << "<td>\"";
+      text_t type_string;
+      switch ((*filteropt_here).second.type) {
+      case FilterOption_t::booleant: type_string = "boolean"; break;
+      case FilterOption_t::integert: type_string = "integer"; break;
+      case FilterOption_t::enumeratedt: type_string = "enumerated"; break;
+      case FilterOption_t::stringt: type_string = "stringt"; break;
+      }
+      textout << outconvert
+          << type_string
+          << "\"</td>\n"
+        
+          << "<td>\"";
+      text_t repeat_string;
+      switch ((*filteropt_here).second.repeatable) {
+      case FilterOption_t::onePerQuery: repeat_string = "one per query"; break;
+      case FilterOption_t::onePerTerm: repeat_string = "one per term"; break;
+      case FilterOption_t::nPerTerm: repeat_string = "n per term"; break;
+      }
+      textout << outconvert
+          << repeat_string
+          << "\"</td>\n"
+        
+          << "<td>\""
+          << (*filteropt_here).second.defaultValue
+          << "\"</td>\n"
+
+          << "<td>";
+
+      text_tarray::iterator valid_here = 
+        (*filteropt_here).second.validValues.begin();
+      text_tarray::iterator valid_end = 
+        (*filteropt_here).second.validValues.end();
+      bool valid_first = true;
+      while (valid_here != valid_end) {
+        if (!valid_first) textout << outconvert << ", ";
+        valid_first = false;
+        textout << outconvert << "\"" << *valid_here << "\"";
+        valid_here++;
+      }
+      textout << outconvert
+          << "</td></tr>\n";
+
+      filteropt_here++;
+    }
+
+    textout << outconvert
+        << "</table>\n";
+
+    filter_here++;
+      }
+
+    } else {
+      textout << outconvert << "Error (" << get_comerror_string (err) 
+          << ") while getting filter option information\n";
+    }
+  }
+  
+  textout << outconvert << disp << "_status:footer_\n";
+}
+
+void statusaction::output_initlog (cgiargsclass &/*args*/, displayclass &disp,
                    outconvertclass &outconvert, 
                    ostream &textout, ostream &/*logout*/) {
+  textout << outconvert << disp << "_status:header_(Init log)\n";
+  textout << outconvert << "<h2>Init log</h2>\n";
+
   ifstream initin (GSDL_GSDLHOME "/etc/initout.txt");
   if (initin) {
-    textout << outconvert << "<p>The initialisation error log, " GSDL_GSDLHOME "/etc/initout.txt, contains the\n";
+    textout << outconvert << "<p>The initialisation error log, "
+      GSDL_GSDLHOME "/etc/initout.txt, contains the\n";
     textout << outconvert << "following information:\n\n";
     text_t errorpage = "<p><pre>\n";
@@ -294 +613 @@
     textout << outconvert << "Couldn't read initialisation error log, " GSDL_GSDLHOME "/etc/initout.txt.\n";
   }
-}
-
-void statusaction::output_errorlog (cgiargsclass &/*args*/, displayclass &/*disp*/, 
+
+  textout << outconvert << disp << "_status:footer_\n";
+}
+
+void statusaction::output_errorlog (cgiargsclass &/*args*/, displayclass &disp, 
                     outconvertclass &outconvert, 
-                    ostream &textout, ostream &/*logout*/) {
+                    ostream &textout, ostream &logout) {
+  textout << outconvert << disp << "_status:header_(Error log)\n";
+  textout << outconvert << "<h2>Error log</h2>\n";
+  logout << flush;
+
   ifstream errin (GSDL_GSDLHOME "/etc/errout.txt");
   if (errin) {
@@ -319 +644 @@
     textout << outconvert << "Couldn't read error log, " GSDL_GSDLHOME "/etc/errout.txt.\n";
   }
-}
+
+  textout << outconvert << disp << "_status:footer_\n";
+}
+
+void statusaction::output_errorpage (outconvertclass &outconvert, 
+                     ostream &textout, ostream &/*logout*/,
+                     text_t message) {
+  textout << outconvert 
+      << "<html>\n"
+      << "<head>\n"
+      << "<title>Error</title>\n"
+      << "</head>\n"
+      << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
+      << "alink=\"#cc9900\" vlink=\"#666633\">\n"
+      << "<h2>Oops!</h2>\n" 
+      << message
+      << "\n</body>\n"
+      << "</html>\n";
+  return;
+}
+
 
 
@@ -334 +679 @@
   arg_ainfo.argdefault = "status";
   arg_ainfo.savedarginfo = cgiarginfo::must;
-
+  argsinfo.addarginfo (NULL, arg_ainfo);
+
+  // "sp" -- status page
+  arg_ainfo.shortname = "sp";
+  arg_ainfo.longname = "status page";
+  arg_ainfo.multiplechar = true;
+  arg_ainfo.defaultstatus = cgiarginfo::good;
+  arg_ainfo.argdefault = "frameset";
+  arg_ainfo.savedarginfo = cgiarginfo::can;
+  argsinfo.addarginfo (NULL, arg_ainfo);
+
+  // "pr" -- protocol
+  arg_ainfo.shortname = "pr";
+  arg_ainfo.longname = "protocol";
+  arg_ainfo.multiplechar = true;
+  arg_ainfo.defaultstatus = cgiarginfo::none;
+  arg_ainfo.argdefault = "";
+  arg_ainfo.savedarginfo = cgiarginfo::can;
   argsinfo.addarginfo (NULL, arg_ainfo);
 }
@@ -355 +717 @@
                   displayclass &disp, outconvertclass &outconvert, 
                   ostream &textout, ostream &logout) {
-  textout << outconvert << "<html>\n";
-  textout << outconvert << "<head>\n";
-  textout << outconvert << "<title>Status</title>\n";
-  textout << outconvert << "</head>\n";
-  textout << outconvert << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
-      << "alink=\"#cc9900\" vlink=\"#666633\">\n";
-
-  textout << outconvert << disp << "<img src=\"_httpimg_/gsdl.gif\"><br>\n";
-
-  if (disabled) textout << outconvert << "<h2>Status disabled</h2>\n";
+  // make sure the status function is enabled
+  if (disabled) {
+    output_errorpage (outconvert, textout, logout, 
+              "The status action is disabled. "
+              "See the documentation (what documentation!) on how "
+              "to enable it.");
+    return true;
+  }
+  
+  // make sure we know about a receptionist
+  if (recpt == NULL) {
+    output_errorpage (outconvert, textout, logout, 
+              "The status action does not contain information\n"
+              "about any receptionists. The method set_receptionist\n"
+              "was probably not called from the module which instantiated\n"
+              "this status action.\n");
+    return true;
+  }
+
+  // check to make sure status.dm was read in
+  const recptconf &rcinfo = recpt->get_configinfo ();
+  text_tarray::const_iterator macrohere = rcinfo.macrofiles.begin ();
+  text_tarray::const_iterator macroend = rcinfo.macrofiles.end ();
+  while (macrohere != macroend) {
+    if (*macrohere == "status.dm") break;
+    macrohere++;
+  }
+  if (macrohere == macroend) {
+    output_errorpage (outconvert, textout, logout, 
+              "The status.dm file was not read in. This macro file is\n" 
+              "needed to display configuration and status information.\n");
+    return true;
+  }
+
+  // output the required status page
+  text_t &arg_sp = args["sp"];
+  if (arg_sp == "frameset") output_frameset (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "select") output_select (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "generalinfo") output_generalinfo (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "argumentinfo") output_argumentinfo (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "actioninfo") output_actioninfo (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "protocolinfo") output_protocolinfo (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "collectioninfo") output_collectioninfo (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "initlog") output_initlog (args, disp, outconvert, textout, logout);
+  else if (arg_sp == "errorlog") output_errorlog (args, disp, outconvert, textout, logout);
   else {
-    textout << outconvert << "<h2>General information</h2>\n";
-    
-    if (recpt == NULL) {
-      textout << outconvert << "The status action does not contain information\n";
-      textout << outconvert << "about any receptionists. The method set_receptionist\n";
-      textout << outconvert << "was probably not called from the module which instantiated\n";
-      textout << outconvert << "this action.\n";
-
-    } else {
-      output_generalinfo (args, disp, outconvert, textout, logout);
-      textout << outconvert << "<hr>\n";
-
-      output_argumentinfo (args, disp, outconvert, textout, logout);
-      textout << outconvert << "<hr>\n";
-
-      output_actioninfo (args, disp, outconvert, textout, logout);
-      textout << outconvert << "<hr>\n";
-
-      output_initlog (args, disp, outconvert, textout, logout);
-      textout << outconvert << "<hr>\n";
-
-      output_errorlog (args, disp, outconvert, textout, logout);
-      textout << outconvert << "<hr>\n";
-    }
-  }
-  
-
-  textout << outconvert << "</body>\n";
-  textout << outconvert << "</html>\n";
+    output_errorpage (outconvert, textout, logout, 
+              "Unknown page \"" + arg_sp + "\".\n");
+  }
 
   return true;
@@ -409 +780 @@
   }
 }
+

trunk/gsdl/src/recpt/statusaction.h

@@ -25 +25 @@
   receptionist *recpt;
 
+  void output_frameset (cgiargsclass &args, displayclass &disp, 
+            outconvertclass &outconvert, 
+            ostream &textout, ostream &logout);
+  void output_select (cgiargsclass &args, displayclass &disp, 
+              outconvertclass &outconvert, 
+              ostream &textout, ostream &logout);
+
   void output_generalinfo (cgiargsclass &args, displayclass &disp, 
                outconvertclass &outconvert, 
@@ -47 +54 @@
             ostream &textout, ostream &logout);
 
+  void output_errorpage (outconvertclass &outconvert, 
+             ostream &textout, ostream &logout,
+             text_t message);
+
 public:
   statusaction ();