source: trunk/gsdl/src/recpt/receptionist.h@ 1779

Last change on this file since 1779 was 1779, checked in by sjboddie, 23 years ago

Implemented LogDateFormat configuration option.

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 8.8 KB
Line 
1/**********************************************************************
2 *
3 * receptionist.h -- a web interface for the gsdl
4 * Copyright (C) 1999 The New Zealand Digital Library Project
5 *
6 * A component of the Greenstone digital library software
7 * from the New Zealand Digital Library Project at the
8 * University of Waikato, New Zealand.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 *
24 *********************************************************************/
25
26
27#ifndef RECEPTIONIST_H
28#define RECEPTIONIST_H
29
30#include "gsdlconf.h"
31#include "text_t.h"
32#include "cgiargs.h"
33#include "display.h"
34#include "browserclass.h"
35#include "recptproto.h"
36#include "converter.h"
37#include "cfgread.h"
38#include "action.h"
39
40// the MACROPRECEDENCE macro is used as a default. override
41// it using something like:
42//
43// macroprecedence c,l
44//
45// in your configuration file
46#ifndef MACROPRECEDENCE
47#define MACROPRECEDENCE "c,l"
48#endif
49
50
51struct collectioninfo_t {
52 void clear ();
53 collectioninfo_t () {clear();}
54
55 text_t gsdl_gsdlhome;
56 text_t gsdl_gdbmhome;
57
58 bool info_loaded;
59 ColInfoResponse_t info;
60};
61
62typedef map<text_t, collectioninfo_t, lttext_t> colinfo_tmap;
63
64enum events_t {Disabled, CollectorEvents, AllEvents};
65enum ldformat_t {LocalTime, UTCTime, Absolute};
66
67struct recptconf {
68 text_t gsdlhome;
69 text_t gdbmhome; // will equal gsdlhome if not set
70 text_t collection; // will equal "" in 'general' mode
71 text_t collectdir; // will equal gsdlhome in 'general' mode
72 colinfo_tmap collectinfo;
73 text_t httpprefix;
74 text_t httpimg; // will equal /images if not set
75 text_t gwcgi;
76 text_tset macrofiles;
77 text_t saveconf;
78 bool usecookies; // true if we want cookies set
79 bool logcgiargs; // true if we want to log cgi arguments
80
81 ldformat_t LogDateFormat;
82
83 text_t maintainer; // email address of maintainer
84 text_t MailServer; // SMTP mail server to use when sending event messages by email
85 // defaults to mail.maintainer-domain
86 events_t LogEvents;
87 events_t EmailEvents;
88 bool EmailUserEvents;
89
90 text_tmap pageparams;
91 text_t macroprecedence;
92
93 void clear ();
94 recptconf () {clear();}
95};
96
97class receptionist {
98protected:
99 recptconf configinfo;
100
101 cgiargsinfoclass argsinfo;
102 actionmapclass actions;
103 browsermapclass browsers;
104 recptprotolistclass protocols;
105 displayclass disp;
106 convertinfoclass converters;
107 ColInfoResponse_t collectinfo;
108
109 // prepare_page sets up page parameters, sets display macros
110 // and opens the page ready for output
111 virtual void prepare_page (action *a, cgiargsclass &args,
112 outconvertclass &outconvert,
113 ostream &logout);
114
115 virtual void translate_OIDs (cgiargsclass &args, recptproto *collectproto,
116 ostream &logout);
117
118 bool get_cookie (text_t &cookie, text_tmap &fcgienv);
119 bool get_cookie (text_tmap &fcgienv);
120
121 virtual void define_general_macros (cgiargsclass &args, outconvertclass &outconvert,
122 ostream &logout);
123
124 bool append_logstr (const text_t &filename, const text_t &logstr,
125 ostream &logout);
126
127public:
128 receptionist ();
129 virtual ~receptionist() {}
130
131 // add_action makes another action available to the receptionist
132 // the action remains the property of the calling code and that
133 // code should destroy the action after the recptionist has been
134 // destroyed.
135 void add_action (action *theaction);
136 actionmapclass *get_actionmap_ptr () {return &actions;}
137
138 // add_browser makes another browser available to the receptionist
139 // the browser remains the property of the calling code and that
140 // code should destroy it after the recptionist has been
141 // destroyed.
142 void add_browser (browserclass *thebrowser);
143 browsermapclass *get_browsermap_ptr () {return &browsers;}
144 void setdefaultbrowser (const text_t &browsername);
145
146 // add_protocol makes another protocol available to the receptionist
147 // without any protocols, no collections will be available. The
148 // protocols remain the property of the calling code.
149 void add_protocol (recptproto *theprotocol) {protocols.addrecptproto(theprotocol);}
150 recptprotolistclass *get_recptprotolist_ptr () {return &protocols;}
151
152 // add_converter makes another converter available to the receptionist.
153 // Converters are needed to display pages using different encodings.
154 // The converters remain the property of the calling code.
155 void add_converter (const text_t &name, inconvertclass *inconverter,
156 rzwsoutconvertclass *outconverter) {
157 converters.add_converter(name, inconverter, outconverter);}
158 convertinfoclass *get_convertinfo_ptr () {return &converters;}
159
160
161 // configure should be called for each line in the
162 // configuration files to configure the receptionist and everything
163 // it contains. The configuration should take place after everything
164 // has been added but before the initialisation.
165 virtual void configure (const text_t &key, const text_tarray &cfgline);
166 virtual void configure (const text_t &key, const text_t &value);
167 const recptconf &get_configinfo () {return configinfo;}
168 cgiargsinfoclass *get_cgiargsinfo_ptr () {return &argsinfo;}
169
170
171 // init should be called after all the actions, protocols, and
172 // converters have been added to the receptionist and after everything
173 // has been configured but before any pages are created.
174 // It returns true on success and false on failure. If false is
175 // returned getpage should not be called (without producing
176 // meaningless output), instead an error page should be
177 // produced by the calling code.
178 virtual bool init (ostream &logout);
179
180 // There are two ways to produce a page. You can either call parse_cgi_args,
181 // get_cgihead_info, and produce_content or you can just call parse_cgi_args and
182 // produce_cgi_page (which will be satisfactory in most cases). You might want to call
183 // parse_cgi_args, get_cgihead_info, and produce_content when you want to
184 // interface directly with a web server for which the standard header is inappropriate.
185
186 // parse_cgi_args parses cgi arguments into an argument class.
187 // This function should be called for each page request. It returns false
188 // if there was a major problem with the cgi arguments.
189 virtual bool parse_cgi_args (const text_t &argstr, cgiargsclass &args,
190 ostream &logout, text_tmap &fcgienv);
191
192 virtual bool log_cgi_args (cgiargsclass &args, ostream &logout, text_tmap &fcgienv);
193
194 text_t expandmacros (const text_t &astring, cgiargsclass &args,
195 ostream &logout);
196
197 // produce_cgi_page will call get_cgihead_info and
198 // produce_content in the appropriate way to output a cgi header and
199 // the page content (if needed). If a page could not be created it
200 // will return false
201 virtual bool produce_cgi_page (cgiargsclass &args, ostream &contentout,
202 ostream &logout, text_tmap &fcgienv);
203
204 // get_cgihead_info determines the cgi header information for
205 // a set of cgi arguments. If response contains location then
206 // response_data contains the redirect address. If reponse
207 // contains content then reponse_data contains the content-type.
208 // Note that images can now be produced by the receptionist.
209 virtual void get_cgihead_info (cgiargsclass &args, response_t &response,
210 text_t &response_data, ostream &logout,
211 text_tmap &fcgienv);
212
213 // produce the page content
214 virtual bool produce_content (cgiargsclass &args, ostream &contentout,
215 ostream &logout);
216
217 // returns the compressed argument ("e") corresponding to the argument
218 // list. This can be used to save preferences between sessions.
219 text_t get_compressed_arg (cgiargsclass &args, ostream &logout);
220
221 // gets collection info from cache if found or
222 // calls collection server (and updates cache)
223 // returns NULL if there's an error
224 ColInfoResponse_t *get_collectinfo_ptr (recptproto *collectproto,
225 const text_t &collection,
226 ostream &logout);
227
228
229protected:
230 // will read in all the macro files. If one is not found an
231 // error message will be written to logout and the method will
232 // return false.
233 virtual bool read_macrofiles (ostream &logout);
234
235 // check_mainargs will check all the main arguments. If a major
236 // error is found it will return false and no cgi page should
237 // be created using the arguments.
238 virtual bool check_mainargs (cgiargsclass &args, ostream &logout);
239};
240
241
242#endif
Note: See TracBrowser for help on using the repository browser.