Changeset 150 for trunk/gsdl/src/recpt

Timestamp:

1999-02-05T23:42:50+13:00 (25 years ago)

Author:

rjmcnab

Message:

Continued working on receptionist

Location:

trunk/gsdl/src/recpt

Files:

• action.cpp (modified) (2 diffs)
• cgiargs.cpp (modified) (3 diffs)
• cgiargs.h (modified) (3 diffs)
• cgiutils.cpp (modified) (3 diffs)
• cgiwrapper.cpp (modified) (8 diffs)
• converter.cpp (added)
• converter.h (added)
• receptionist.cpp (modified) (5 diffs)
• receptionist.h (modified) (1 diff)
• recptconfinfo.cpp (deleted)
• recptconfinfo.h (deleted)

trunk/gsdl/src/recpt/action.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.3  1999/02/05 10:42:41  rjmcnab
+
+   Continued working on receptionist
+
    Revision 1.2  1999/02/04 10:00:53  rjmcnab
 
@@ -84 +88 @@
   aptr.a = theaction;
   actionptrs[theaction->get_action_name()] = aptr;
+  aptr.a = NULL; // control has passed on
 }
 

trunk/gsdl/src/recpt/cgiargs.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.4  1999/02/05 10:42:41  rjmcnab
+
+   Continued working on receptionist
+
    Revision 1.3  1999/02/04 10:00:54  rjmcnab
 
@@ -157 +161 @@
        << "\" was defined as being a single character option\n"
        << "but a multiple character default was given.\n\n";
-  }
+    return false;  // found a problem
+  }
+
+  // make sure there is no clashes in the savedarginfo
+  if ((orginfo->savedarginfo==cgiarginfo::mustnot && 
+       info.savedarginfo==cgiarginfo::must) ||
+      (orginfo->savedarginfo==cgiarginfo::must && 
+       info.savedarginfo==cgiarginfo::mustnot)) {
+    logout << text_t2ascii << "Error: it was specified that cgi argument \"" 
+       << info.shortname << "\" should be saved in the state\n"
+       << "information and that it should not be save in the state information.\n\n";
+    return false; // found a clash
+  }
+  // the only time orginfo->savedarginfo can change is when it is set
+  // to "can"
+  if (orginfo->savedarginfo == cgiarginfo::can) 
+    orginfo->savedarginfo = info.savedarginfo;
+
 
   if (orginfo->defaultstatus > info.defaultstatus) {
     return true;
   }
-
   orginfo->defaultstatus = info.defaultstatus;
   orginfo->argdefault = info.argdefault;
+
   return true;
 }
@@ -187 +208 @@
 }
 
+const cgiarginfo *cgiargsinfoclass::getarginfo (const text_t &key) const {
+  const_iterator here = argsinfo.find (key);
+  if (here == argsinfo.end()) return NULL;
+
+  return &((*here).second);
+}
+
+
+
+// utilities related to cgi arguments
+
+
+static text_t::const_iterator get_next_save_arg (text_t::const_iterator first, 
+                       text_t::const_iterator last,
+                       text_t &argname) {
+  first = getdelimitstr (first, last, '-', argname);
+  return first;
+}
+
+
+
+
+
+// check_save_conf_str checks the configuration string for
+// the saved args and makes sure it does not conflict with
+// the information about the arguments. If an error is encountered
+// it will return false and the program should not produce any
+// output.
+bool check_save_conf_str (const text_t &saveconf, 
+              const cgiargsinfoclass &argsinfo,
+              ostream &logout) {
+  outconvertclass text_t2ascii;
+
+  text_tset argsset;
+  text_t::const_iterator saveconfhere = saveconf.begin ();
+  text_t::const_iterator saveconfend = saveconf.end ();
+  text_t argname;
+  const cgiarginfo *info;
+
+  // first check to make sure all saved arguments can be saved
+  
+  while (saveconfhere != saveconfend) {
+    saveconfhere = get_next_save_arg (saveconfhere, saveconfend, argname);
+
+    if (!argname.empty()) {
+      // save the argument name for later
+      argsset.insert (argname);
+
+      // check the argument
+      info =  argsinfo.getarginfo (argname);
+      if (info == NULL) {
+    logout << text_t2ascii << "Error: the cgi argument \"" << argname 
+           << "\" is used in the configuration string for the\n"
+           << "saved arguments but does not exist as a valid argument.\n\n";
+    return false;
+      }
+      if (info->savedarginfo == cgiarginfo::mustnot) {
+    logout << text_t2ascii << "Error: the cgi argument \"" << argname
+           << "\" is used in the configuration string for the\n"
+           << "saved arguments but has been specified as an argument whose\n"
+           << "state must not be saved.\n\n";
+    return false;
+      }
+    }
+  }
+
+
+  // next check that all saved arguments that should be saved
+  // are saved
+  cgiargsinfoclass::const_iterator argsinfohere = argsinfo.begin ();
+  cgiargsinfoclass::const_iterator argsinfoend = argsinfo.end ();
+
+  while (argsinfohere != argsinfoend) {
+    if (((*argsinfohere).second.savedarginfo == cgiarginfo::must) &&
+    (argsset.find((*argsinfohere).second.shortname) == argsset.end())) {
+      logout << text_t2ascii << "Error: the cgi argument \"" 
+         << (*argsinfohere).second.shortname << "\" was specified as needing to\n"
+         << "be save but was not listed in the saved arguments.\n\n";
+      return false;
+    }
+
+    argsinfohere++;
+  }
+  
+  return true; // made it, no clashes
+}
+
+
+
+// create_save_conf_str will create a configuration string
+// based on the information in argsinfo. This method of configuration
+// is not recomended as small changes can produce large changes in
+// the resulting configuration string (for instance a totally different
+// ordering)
+text_t create_save_conf_str (const cgiargsinfoclass &argsinfo,
+                 ostream &logout);
+
+// expand_save_args will expand the saved arguments based
+// on saveconf placing the results in args if they are not
+// already defined. If it encounters an error it will return false
+// and output more information to logout.
+bool expand_save_args (const text_t &saveconf, 
+               cgiargsclass &args,
+               ostream &logout);
+
+// adds the default values for those arguments which have not
+// been specified
+void add_default_args (const cgiargsinfoclass &argsinfo,
+               cgiargsclass &args,
+               ostream &logout);
+

trunk/gsdl/src/recpt/cgiargs.h

@@ -124 +124 @@
   defaultstatus_t defaultstatus;
   text_t argdefault;   // a default value
+
+  // savedarginfo_t indicates whether the argument should be saved
+  // between pages (e.g. using the compressed argument) or not. The
+  // value of an argument can change from "can" to "mustnot" and 
+  // "can" to "must" but not "mustnot" to "must" or "must" to "mustnot".
+  enum savedarginfo_t {mustnot, can, must};
+
+  savedarginfo_t savedarginfo;
 };
 
@@ -174 +182 @@
 
   cgiarginfo *getarginfo (const text_t &key);
+  const cgiarginfo *getarginfo (const text_t &key) const;
   cgiarginfo &operator[] (const text_t &key) {return argsinfo[key];}
 };
@@ -179 +188 @@
 
 
+// utilities related to cgi arguments
+
+// check_compress_conf_str checks the configuration string for
+// the compressed args and makes sure it does not conflict with
+// the information about the arguments. If an error is encountered
+// it will return false and the program should not produce any
+// output.
+bool check_compress_conf_str (const text_t &compressconf, 
+                  const cgiargsinfoclass &argsinfo,
+                  ostream &logout);
+
+// create_compress_conf_str will create a configuration string
+// based on the information in argsinfo. This method of configuration
+// is not recomended as small changes can produce large changes in
+// the resulting configuration string (for instance a totally different
+// ordering)
+text_t create_compress_conf_str (const cgiargsinfoclass &argsinfo,
+                 ostream &logout);
+
+// expand_compress_args will expand the compressed arguments based
+// on compressconf placing the results in args if they are not
+// already defined. If it encounters an error it will return false
+// and output more information to logout.
+bool expand_compress_args (const text_t &compressconf, 
+               cgiargsclass &args,
+               ostream &logout);
+
+// adds the default values for those arguments which have not
+// been specified
+void add_default_args (const cgiargsinfoclass &argsinfo,
+               cgiargsclass &args,
+               ostream &logout);
+
+
 #endif

trunk/gsdl/src/recpt/cgiutils.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.2  1999/02/05 10:42:43  rjmcnab
+
+   Continued working on receptionist
+
    Revision 1.1  1999/01/08 08:40:56  rjmcnab
 
@@ -21 +25 @@
 
  */
-
-static char *RCSID = "$Id$";
 
 
@@ -128 +130 @@
     } else if (c == ' ') {
       // space
-      outtext.push_back("+");
+      outtext.push_back('+');
     } else {
       // everything else

trunk/gsdl/src/recpt/cgiwrapper.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.3  1999/02/05 10:42:44  rjmcnab
+
+   Continued working on receptionist
+
    Revision 1.2  1999/02/04 10:00:56  rjmcnab
 
@@ -34 +38 @@
 #include "gsdlconf.h"
 #include "cgiwrapper.h"
+#include "recptconfig.h"
 #include <stdlib.h>
+
 
 #if defined(GSDL_USE_OBJECTSPACE)
@@ -47 +53 @@
 #endif
 
-#include "cfgread.h"
-#include "fileutil.h"
-
 #ifdef USE_FASTCGI
 #include "fcgiapp.h"
@@ -108 +111 @@
 
 
-// returns true on success
-static bool site_cfg_read (receptionist &recpt, const text_t &collection,
-               const text_t &filename, int &maxrequests) {
-  text_tarray cfgline;
-  char *cstr = filename.getcstr();
-  ifstream confin (cstr);
-  delete cstr;
-
-  maxrequests = 10000;
-
-  if (confin) {
-    while (read_cfg_line(confin, cfgline) >= 0) {
-      if (cfgline.size () >= 2) {
-    if (cfgline[0] == "gsdlhome") {
-      if (collection.empty()) recpt.set_gsdlhome(cfgline[1]);
-      else recpt.set_gsdlhome(cfgline[1], collection);
-    }
-    else if (cfgline[0] == "httpimg") recpt.set_httpimg(cfgline[1]);
-    else if (cfgline[0] == "gwcgi") recpt.set_gwcgi(cfgline[1]);
-    else if (cfgline[0] == "maxrequests") {
-      maxrequests = cfgline[1].getint();
-      if (maxrequests < 1) maxrequests = 1;
-    }
-      }
-    }
-    confin.close ();
-    return true;
-  }
-  return false;
-}
-
-
-static void page_errorconfigfile (const text_t &collection) {
+static void page_errorsitecfg (const text_t &gsdlhome, const text_t &collection) {
+  outconvertclass text_t2ascii;
+
   cout << "Content-type: text/html\n\n";
 
@@ -154 +127 @@
   if (collection.empty()) {
     cout << "As this cgi script is not being run in collection specific mode,\n";
-    cout << "the file should reside at " GSDL_GSDLHOME "/etc/site.cfg.\n";
+    cout << "the file should reside at ";
+    cout << text_t2ascii << gsdlhome;
+    cout << "/etc/site.cfg.\n";
   } else {
-    char *cstr = collection.getcstr();
     cout << "As this cgi script is being run in collection specific mode,\n";
-    cout << "the file can reside in " GSDL_GSDLHOME "/collect/" << cstr 
-     << "/etc/site.cfg or " GSDL_GSDLHOME "/etc/site.cfg.\n";
-    delete cstr;
+    cout << text_t2ascii << "the file can reside in " << gsdlhome << "/collect/" 
+     << collection << "/etc/site.cfg or " << gsdlhome << "/etc/site.cfg.\n";
   }
   cout << "</body>\n";
@@ -167 +140 @@
 
 
-static void page_errorinit () {
+static void page_errormaincfg (const text_t &gsdlhome, const text_t &collection) {
+  outconvertclass text_t2ascii;
+
+  cout << "Content-type: text/html\n\n";
+
+  cout << "<html>\n";
+  cout << "<head>\n";
+  cout << "<title>Error</title>\n";
+  cout << "</head>\n";
+  cout << "<body>\n";
+  cout << "<h2>Oops!</h2>\n";
+  if (collection.empty()) {
+    cout << "The main.cfg configuration file could not be found. This file\n";
+    cout << "should contain configuration information relating to the\n";
+    cout << "setup of the interface. As this cgi script is not being run\n";
+    cout << "in collection specific mode the file should reside at\n";
+    cout << text_t2ascii << gsdlhome << "/etc/main.cfg.\n";
+  } else {
+    cout << "Neither the collect.cfg or main.cfg configuration files could\n";
+    cout << "not be found. This file should contain configuration information\n";
+    cout << "relating to the setup of the interface. As this cgi script is\n";
+    cout << "being run in collection specific mode the file should reside\n";
+    cout << "at either ";
+    cout << text_t2ascii << gsdlhome << "/collect/" << collection 
+     << "/etc/collect.cfg, " << gsdlhome << "/etc/collect.cfg or " 
+     << gsdlhome << "/etc/main.cfg.\n";
+  }
+  cout << "</body>\n";
+  cout << "</html>\n";
+}
+
+
+static void page_errorinit (const text_t &gsdlhome) {
+  outconvertclass text_t2ascii;
+
   cout << "Content-type: text/html\n\n";
 
@@ -178 +185 @@
   cout << "An error occurred during the initialisation of the Greenstone Digital\n";
   cout << "Library software. It is likely that the software has not been setup\n";
-  cout << "correctly, consult " GSDL_GSDLHOME "/etc/initout.txt for more information.\n";
+  cout << "correctly, consult ";
+  cout << text_t2ascii << gsdlhome << "/etc/initout.txt for more information.\n";
   cout << "</body>\n";
   cout << "</html>\n";
@@ -204 +212 @@
   else recpt.set_gwcgi("/cgi-bin/gw");
 
-  // read in the site configuration file. Try to find it in the 
-  // GSDLHOME/collect/collection-name/etc directory 
-  // (if this is for a particular collection), and then GSDLHOME/etc.
-  bool configfileread = false;
-  text_t filename;
-  if (!collection.empty()) {
-    filename = filename_cat (GSDL_GSDLHOME, "collect");
-    filename = filename_cat (filename, collection);
-    filename = filename_cat (filename, "etc");
-    filename = filename_cat (filename, "site.cfg");
-    configfileread = site_cfg_read (recpt, collection, filename, maxrequests);
-  }
-  if (!configfileread) {
-    filename = filename_cat (GSDL_GSDLHOME, "etc");
-    filename = filename_cat (filename, "site.cfg");
-    if (!site_cfg_read (recpt, collection, filename, maxrequests)) {
-      // couldn't find the site configuration file
-      page_errorconfigfile (collection);
-      return;
-    }
+  // read in the configuration files.
+  if (!site_cfg_read (recpt, GSDL_GSDLHOME, collection, maxrequests)) {
+    // couldn't find the site configuration file
+    page_errorsitecfg (GSDL_GSDLHOME, collection);
+    return;
+  }
+  if (!main_cfg_read (recpt, GSDL_GSDLHOME, collection)) {
+    // couldn't find the main configuration file
+    page_errormaincfg (GSDL_GSDLHOME, collection);
+    return;
   }
 
   // initialise the library software
   ofstream initout (GSDL_GSDLHOME "/etc/initout.txt");
-  if (!recpt.digest(initout)) {
+  if (!recpt.init(initout)) {
     // an error occurred during the initialisation
     initout.close();
-    page_errorinit();
+    page_errorinit(GSDL_GSDLHOME);
     return;
   }

trunk/gsdl/src/recpt/receptionist.cpp

@@ -12 +12 @@
 /*
    $Log$
+   Revision 1.4  1999/02/05 10:42:46  rjmcnab
+
+   Continued working on receptionist
+
    Revision 1.3  1999/02/04 10:00:56  rjmcnab
 
@@ -28 +32 @@
 #include "fileutil.h"
 #include <assert.h>
+#include <time.h>
 
 
@@ -78 +83 @@
 // meaningless output), instead an error page should be
 // produced by the calling code.
-bool receptionist::digest (ostream &logout) {
+bool receptionist::init (ostream &logout) {
   // redirect the error output to logout
   //  disp.setlogout (&logout);
@@ -86 +91 @@
   //  cfg_info.defaultpage = "about";
   //  cfg_info.defaultencoding = "w";
-
-  // read in the configuration files etc/collect.cfg and index/build.cfg
-  // entries in build.cfg should override those in collect.cfg
-  //  filename = filename_cat (collectdir, "etc");
-  //  filename = filename_cat (filename, "collect.cfg");
-  //  cfg_read(filename);
 
   // load up the default macro files, the collection directory
@@ -108 +107 @@
   //  }
 
-  //  srand(time(NULL));
+  srand(time(NULL));
 
   //  utf8outconvert.set_rzws(1);
   //  gboutconvert.set_rzws(1);
 
-  //  return collect_init(collection);
   return true;
 }

trunk/gsdl/src/recpt/receptionist.h

@@ -47 +47 @@
   void set_gwcgi (const text_t &thegwcgi);
 
-  // digest should be called after setgsdhome has been called.
+  // init should be called after setgsdhome has been called.
   // It returns true on success and false on failure. If false is
   // returned getpage should not be called (without producing
   // meaningless output), instead an error page should be
   // produced by the calling code.
-  bool digest (ostream &logout);
+  bool init (ostream &logout);
   
   // There are two ways to produce a page. You can either call parse_cgi_args,