Changeset 165 for trunk/gsdl/src/recpt/receptionist.h

Timestamp:

1999-02-22T11:33:58+13:00 (25 years ago)

Author:

rjmcnab

Message:

Lots of stuff :-)

File:

• trunk/gsdl/src/recpt/receptionist.h (modified) (3 diffs)

trunk/gsdl/src/recpt/receptionist.h

@@ -19 +19 @@
 #include "display.h"
 #include "action.h"
+#include "recptproto.h"
+#include "converter.h"
 
 #ifndef MACROPRECEDENCE
@@ -25 +27 @@
 
 
+struct recptconf {
+  text_t gsdlhome;
+  text_t collection; // will equal "" in 'general' mode
+  text_t collectdir; // will equal gsdlhome in 'general' mode
+  text_t httpimg;
+  text_t gwcgi;
+  text_tarray macrofiles;
+  text_t saveconf;
+};
+
+
 class receptionist {
+protected:
+  recptconf configinfo;
+
+  cgiargsinfoclass argsinfo;
+  actionmapclass actions;
+  recptprotolistclass protocols;
+  displayclass disp;
+  convertinfoclass converters;
+
 public:
   receptionist () {}
   virtual ~receptionist() {}
 
-  // this version of set_gsdlhome should be used if the receptionist
-  // is being run for multiple collections ("general" mode).
-  void set_gsdlhome (const text_t &thegsdlhome);
-  text_t get_gsdlhome () {return gsdlhome;}
+  // add_action makes another action available to the receptionist
+  // the action remains the property of the calling code and that
+  // code should destroy the action after the recptionist has been
+  // destroyed.
+  void add_action (action *theaction) {actions.addaction(theaction);}
+  actionmapclass *get_actionmap_ptr () {return &actions;}
 
-  // this version of set_gsdlhome should be used if the receptionist
-  // is being run for a single collection ("collection specific" mode).
-  void set_gsdlhome (const text_t &thegsdlhome, const text_t &thecollection);
-  text_t get_collection () {return collection;}
+  // add_protocol makes another protocol available to the receptionist
+  // without any protocols, no collections will be available. The
+  // protocols remain the property of the calling code.
+  void add_protocol (recptproto *theprotocol) {protocols.addrecptproto(theprotocol);}
+  recptprotolistclass *get_recptprotolist_ptr () {return &protocols;}
+  
+  // add_converter makes another converter available to the receptionist.
+  // Converters are needed to display pages using different encodings.
+  // The converters remain the property of the calling code.
+  void add_converter (const text_t &name, inconvertclass *inconverter,
+              rzwsoutconvertclass *outconverter) 
+    {converters.add_converter(name, inconverter, outconverter);}
+  convertinfoclass *get_convertinfo_ptr () {return &converters;}
 
-  // sets the http address of the images directory. This is used to
-  // speed up the access to the images which are a part of the general
-  // interface. If this is not set the interface will have to get the
-  // images via gwcgi which will be a lot slower (especially if the
-  // browser does not cache the images).
-  void set_httpimg (const text_t &thehttpimg) {httpimg=thehttpimg;}
-  text_t get_httpimg () {return httpimg;}
 
-  // sets the http address of the gateway cgi program (ie. the program
-  // that contains this receptionist).
-  void set_gwcgi (const text_t &thegwcgi) {gwcgi=thegwcgi;}
-  text_t get_gwcgi () {return gwcgi;}
+  // configure should be called for each line in the
+  // configuration files to configure the receptionist and everything
+  // it contains. The configuration should take place after everything
+  // has been added but before the initialisation.
+  void configure (const text_t &key, const text_tarray &cfgline);
+  void configure (const text_t &key, const text_t &value);
+  const recptconf &get_configinfo () {return configinfo;}
+  cgiargsinfoclass *get_cgiargsinfo_ptr () {return &argsinfo;}
+  
 
-  // set_macrofiles defines the macro files which will be read when
-  // the init function is called.
-  void set_macrofiles (const text_tarray &themacrofiles) {macrofiles=themacrofiles;}
-  text_tarray get_macrofiles () {return macrofiles;}
-
-  // set_saveconf defines what should be included in the compressed
-  // arguments. This string should consist of cgi argument names
-  // seperated by "-".
-  void set_saveconf (const text_t &thesaveconf) {saveconf=thesaveconf;}
-  text_t get_saveconf () {return saveconf;}
-
-  // add_action makes another action available to the receptionist
-  // the action becomes the property of the receptionist
-  void add_action (action *theaction) {actions.addaction(theaction);}
-
-  // configure_actions should be called for each line in the
-  // configuration files to configure the actions. The configuration
-  // should take place after all the actions have been added.
-  void configure_actions (const text_t &key, const text_tarray &cfgline);
-
-  // init should be called after setgsdhome has been called.
+  // init should be called after all the actions, protocols, and
+  // converters have been added to the receptionist and after everything
+  // has been configured but before any pages are created.
   // It returns true on success and false on failure. If false is
   // returned getpage should not be called (without producing
@@ -114 +127 @@
   text_t get_compressed_arg (const cgiargsclass &args);
 
-  // returns a pointer to the action list
-  actionmapclass *get_actionmap_ptr () {return &actions;}
-
 protected:
-  text_t gsdlhome;
-  text_t collectdir; // will equal gsdlhome in 'general' mode
-  text_t collection; // will equal "" in 'general' mode
-  text_t httpimg;
-  text_t gwcgi;
-
-  displayclass disp;
-  text_tarray macrofiles;
-
-  text_t saveconf;
-  cgiargsinfoclass argsinfo;
-  actionmapclass actions;
-
   // will read in all the macro files. If one is not found an
   // error message will be written to logout and the method will