source: gsdl/trunk/src/recpt/statusaction.cpp@ 15589

Last change on this file since 15589 was 15589, checked in by mdewsnip, 13 years ago

(Adding new DB support) Replacing almost all "gdbmhome" with "dbhome".

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 38.3 KB
Line 
1/**********************************************************************
2 *
3 * statusaction.cpp --
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#include "gsdl_modules_cfg.h"
27#ifdef GSDL_USE_STATUS_ACTION
28
29// following line required to get fstream.filedesc() on darwin (Mac OS X)
30#define _STREAM_COMPAT 1
31
32#include "statusaction.h"
33#include "fileutil.h"
34#include "htmlutils.h"
35#include "gsdltools.h"
36#include <assert.h>
37#include <stdio.h>
38#include <fcntl.h> // for open() stuff
39
40void statusaction::output_frameset (cgiargsclass &/*args*/, displayclass &disp,
41 outconvertclass &outconvert,
42 ostream &textout, ostream &/*logout*/) {
43 textout << outconvert << disp << "_status:frameset_\n";
44}
45
46void statusaction::output_select (cgiargsclass &/*args*/, displayclass &disp,
47 outconvertclass &outconvert,
48 ostream &textout, ostream &/*logout*/) {
49 textout << outconvert << disp << "_status:header_(selector)\n"
50 "_status:select_\n"
51 "_status:footer_\n";
52}
53
54void statusaction::output_welcome (cgiargsclass &args, recptprotolistclass *protos,
55 displayclass &disp, outconvertclass &outconvert,
56 ostream &textout, ostream &logout) {
57
58 if (recpt == NULL) return;
59
60 textout << outconvert << disp
61 << "_status:infoheader_(_titlewelcome_)\n"
62 << "_status:welcome_"
63 << "<table>\n"
64 << "<th align=left>abbrev.</th><th align=left>collection</th>"
65 << "<th align=left>public?</th><th align=left>running?</th></tr>\n";
66
67 recptprotolistclass::iterator rprotolist_here = protos->begin();
68 recptprotolistclass::iterator rprotolist_end = protos->end();
69 while (rprotolist_here != rprotolist_end) {
70 if ((*rprotolist_here).p != NULL) {
71 comerror_t err;
72 text_t protoname = (*rprotolist_here).p->get_protocol_name(err);
73 text_tarray collist;
74 (*rprotolist_here).p->get_collection_list (collist, err, logout);
75 if (err == noError) {
76 text_tarray::iterator collist_here = collist.begin();
77 text_tarray::iterator collist_end = collist.end();
78
79 while (collist_here != collist_end) {
80
81 textout << outconvert << disp
82 << "<tr><td><a href=\"_gwcgi_?_optsite_e=_compressedoptions_&a=status&p=collectioninfo&pr="
83 << protoname
84 << "&c="
85 << *collist_here
86 << "\">"
87 << *collist_here
88 << "</a></td>";
89
90 ColInfoResponse_t *cinfo = recpt->get_collectinfo_ptr ((*rprotolist_here).p, *collist_here, logout);
91 if (cinfo != NULL) {
92 text_t collname = cinfo->get_collectionmeta("collectionname", args["l"]);
93 if (collname.empty()) {
94 collname = *collist_here;
95 }
96
97 textout << "<td>";
98 if (cinfo->buildDate > 0)
99 textout << outconvert << disp
100 << "<a href=\"_httppagex_(about)&c=" << *collist_here
101 << "\" target=\\_top>";
102
103 textout << outconvert << disp << collname;
104
105 if (cinfo->buildDate > 0) textout << "</a>";
106
107 textout << "</td>";
108
109 if (cinfo->isPublic) textout << "<td>yes</td>";
110 else textout << "<td>no</td>";
111
112 if (cinfo->buildDate > 0)
113 textout << outconvert << "<td>yes</td>";
114 else
115 textout << "<td>no</td>";
116
117 } else {
118 textout << "<td></td><td></td><td></td>";
119 }
120
121 textout << "</tr>\n";
122 ++collist_here;
123 }
124 }
125 }
126 ++rprotolist_here;
127 }
128
129 textout << "</table>\n";
130 textout << outconvert << disp << "_status:infofooter_\n";
131}
132
133void statusaction::output_generalinfo (cgiargsclass &/*args*/, displayclass &disp,
134 outconvertclass &outconvert,
135 ostream &textout, ostream &/*logout*/) {
136 if (recpt == NULL) return;
137 const recptconf &rcinfo = recpt->get_configinfo ();
138
139 textout << outconvert << disp << "_status:infoheader_(General Information)\n";
140 textout << outconvert
141 << "<h2>General information</h2>\n"
142 << "<table>\n"
143 << "<tr valign=top><th>gsdlhome</th><td>\"" << rcinfo.gsdlhome
144 << "\"</td></tr>\n"
145 << "<tr valign=top><th>collection</th><td>\"" << rcinfo.collection
146 << "\"</td></tr>\n"
147 << "<tr valign=top><th>collectdir</th><td>\"" << rcinfo.collectdir
148 << "\"</td></tr>\n"
149 << "<tr valign=top><th>httpprefix</th><td>\"" << rcinfo.httpprefix
150 << "\"</td></tr>\n"
151 << "<tr valign=top><th>httpimg</th><td>\"" << rcinfo.httpimg
152 << "\"</td></tr>\n"
153 << "<tr valign=top><th>gwcgi</th><td>\"" << rcinfo.gwcgi
154 << "\"</td></tr>\n";
155
156 // macrofiles
157 textout << outconvert << "<tr valign=top><th>macrofiles</th><td>";
158 text_tset::const_iterator macrohere = rcinfo.macrofiles.begin ();
159 text_tset::const_iterator macroend = rcinfo.macrofiles.end ();
160 bool macrofirst = true;
161 while (macrohere != macroend) {
162 if (!macrofirst) textout << outconvert << ", ";
163 macrofirst = false;
164 textout << outconvert << "\"" << *macrohere << "\"";
165 ++macrohere;
166 }
167 textout << outconvert << "</td></tr>\n";
168
169 // saveconf
170 textout << outconvert << "<tr valign=top><th>saveconf</th><td>\"" << rcinfo.saveconf
171 << "\"</td></tr>\n";
172
173 // usecookies
174 textout << outconvert << "<tr valign=top><th>usecookies</th><td>\"";
175 if (rcinfo.usecookies) textout << outconvert << "true";
176 else textout << outconvert << "false";
177 textout << outconvert << "\"</td></tr>\n";
178
179 // logcgiargs
180 textout << outconvert << "<tr valign=top><th>logcgiargs</th><td>\"";
181 if (rcinfo.logcgiargs) textout << outconvert << "true";
182 else textout << outconvert << "false";
183 textout << outconvert << "\"</td></tr>\n";
184
185 // pageparams
186 textout << outconvert << "<tr valign=top><th>pageparams</th><td>";
187 text_tmap::const_iterator params_here = rcinfo.pageparams.begin();
188 text_tmap::const_iterator params_end = rcinfo.pageparams.end();
189 bool params_first = true;
190 while (params_here != params_end) {
191 if (!params_first) textout << outconvert << ", ";
192 params_first = false;
193 textout << outconvert << "\"" << (*params_here).first << "\" != \""
194 << (*params_here).second << "\"";
195
196 ++params_here;
197 }
198 textout << outconvert << "</td></tr>\n";
199
200 // macroprecedence
201 textout << outconvert << "<tr valign=top><th>macroprecedence</th><td>\"" << rcinfo.macroprecedence
202 << "\"</td></tr>\n";
203
204 // arguments
205 cgiargsinfoclass *rcargsinfo = recpt->get_cgiargsinfo_ptr ();
206 if (rcargsinfo != NULL) {
207 textout << outconvert << "<tr valign=top><th>arguments</th><td>";
208
209 cgiargsinfoclass::const_iterator argsinfohere = rcargsinfo->begin ();
210 cgiargsinfoclass::const_iterator argsinfoend = rcargsinfo->end ();
211 bool argsinfofirst = true;
212 while (argsinfohere != argsinfoend) {
213 if (!argsinfofirst) textout << outconvert << ", ";
214 argsinfofirst = false;
215 textout << outconvert << "\"" << (*argsinfohere).second.shortname << "\"";
216 ++argsinfohere;
217 }
218
219 textout << outconvert << "</td></tr>\n";
220 }
221
222 // actions
223 actionmapclass *actions = recpt->get_actionmap_ptr();
224 if (actions != NULL) {
225 textout << outconvert << "<tr valign=top><th>actions</th><td>";
226
227 actionptrmap::iterator actionshere = actions->begin ();
228 actionptrmap::iterator actionsend = actions->end ();
229 bool actionsfirst = true;
230 while (actionshere != actionsend) {
231 if (!actionsfirst) textout << outconvert << ", ";
232 actionsfirst = false;
233 assert ((*actionshere).second.a != NULL);
234 if ((*actionshere).second.a != NULL) {
235 textout << outconvert << "\"" << (*actionshere).second.a->get_action_name() << "\"";
236 }
237 ++actionshere;
238 }
239
240 textout << outconvert << "</td></tr>\n";
241 }
242
243 // browsers
244 browsermapclass *browsers = recpt->get_browsermap_ptr();
245 if (browsers != NULL) {
246 textout << outconvert << "<tr valign=top><th>browsers</th><td>";
247
248 browserptrmap::iterator browsershere = browsers->begin ();
249 browserptrmap::iterator browsersend = browsers->end ();
250 bool browsersfirst = true;
251 while (browsershere != browsersend) {
252 if (!browsersfirst) textout << outconvert << ", ";
253 browsersfirst = false;
254 assert ((*browsershere).second.b != NULL);
255 if ((*browsershere).second.b != NULL) {
256 textout << outconvert << "\"" << (*browsershere).second.b->get_browser_name() << "\"";
257 }
258 ++browsershere;
259 }
260
261 textout << outconvert << "</td></tr>\n";
262 }
263
264 // protocols
265 recptprotolistclass *protocols = recpt->get_recptprotolist_ptr ();
266 if (protocols != NULL) {
267 textout << outconvert << "<tr valign=top><th>protocols</th><td>";
268
269 recptprotolistclass::iterator protohere = protocols->begin ();
270 recptprotolistclass::iterator protoend = protocols->end ();
271 bool protofirst = true;
272 while (protohere != protoend) {
273 comerror_t err;
274 if (!protofirst) textout << outconvert << ", ";
275 protofirst = false;
276 if ((*protohere).p != NULL) {
277 textout << outconvert << "\"" << (*protohere).p->get_protocol_name(err) << "\"";
278 }
279 ++protohere;
280 }
281
282 textout << outconvert << "</td></tr>\n";
283 }
284
285 // converters
286 convertinfoclass *converters = recpt->get_convertinfo_ptr ();
287 if (converters != NULL) {
288 textout << outconvert << "<tr valign=top><th>converters</th><td>";
289
290 convertinfoclass::iterator converthere = converters->begin ();
291 convertinfoclass::iterator convertend = converters->end ();
292 bool convertfirst = true;
293 while (converthere != convertend) {
294 if (!convertfirst) textout << outconvert << ", ";
295 convertfirst = false;
296 textout << outconvert << "\"" << (*converthere).second.name << "\"";
297 ++converthere;
298 }
299
300 textout << outconvert << "</td></tr>\n";
301 }
302
303 textout << outconvert << disp << "</table>\n_status:infofooter_\n";
304}
305
306void statusaction::output_argumentinfo (cgiargsclass &args, displayclass &disp,
307 outconvertclass &outconvert,
308 ostream &textout, ostream &/*logout*/) {
309 if (recpt == NULL) return;
310 cgiargsinfoclass *rcargsinfo = recpt->get_cgiargsinfo_ptr ();
311 if (rcargsinfo == NULL) return;
312
313 textout << outconvert << disp << "_status:infoheader_(Argument Information)\n";
314 textout << outconvert
315 << "<h2>Argument information</h2>\n"
316 << "<table>";
317
318 // argument information
319 textout << outconvert << "<tr valign=top><th>short name</th><th>long name</th>"
320 << "<th>multiple char?</th>"
321 << "<th>multiple value?</th>"
322 << "<th>default</th><th>default status</th><th>saved args</th>"
323 << "<th>current value</th></tr>\n";
324
325
326 cgiargsinfoclass::const_iterator argsinfohere = rcargsinfo->begin();
327 cgiargsinfoclass::const_iterator argsinfoend = rcargsinfo->end();
328 text_t *arg_value;
329 while (argsinfohere != argsinfoend) {
330 const cgiarginfo &ainfo = (*argsinfohere).second;
331 textout << outconvert
332 << "<tr valign=top><td>" << ainfo.shortname << "</td>\n";
333
334 textout << outconvert << "<td>" << ainfo.longname << "</td>\n";
335 if (ainfo.multiplechar) textout << outconvert << "<td>yes</td>\n";
336 else textout << outconvert << "<td>no</td>\n";
337 if (ainfo.multiplevalue) textout << outconvert << "<td>yes</td>\n";
338 else textout << outconvert << "<td>no</td>\n";
339 textout << outconvert << "<td>" << ainfo.argdefault << "</td>\n";
340 switch (ainfo.defaultstatus) {
341 case cgiarginfo::none: textout << outconvert << "<td>none</td>\n"; break;
342 case cgiarginfo::weak: textout << outconvert << "<td>weak</td>\n"; break;
343 case cgiarginfo::good: textout << outconvert << "<td>good</td>\n"; break;
344 case cgiarginfo::config: textout << outconvert << "<td>config</td>\n"; break;
345 case cgiarginfo::imperative: textout << outconvert << "<td>imperative</td>\n"; break;
346 }
347 switch (ainfo.savedarginfo) {
348 case cgiarginfo::mustnot: textout << outconvert << "<td>mustnot</td>\n"; break;
349 case cgiarginfo::can: textout << outconvert << "<td>can</td>\n"; break;
350 case cgiarginfo::must: textout << outconvert << "<td>must</td>\n"; break;
351 }
352
353 arg_value = args.getarg (ainfo.shortname);
354 if (arg_value == NULL) textout << outconvert << "<td></td></tr>\n";
355 else textout << outconvert << "<td>\"" << *arg_value << "\"</td></tr>\n";
356
357 ++argsinfohere;
358 }
359
360 textout << outconvert << disp << "</table>\n_status:infofooter_\n";
361}
362
363void statusaction::output_actioninfo (cgiargsclass &/*args*/, displayclass &disp,
364 outconvertclass &outconvert,
365 ostream &textout, ostream &/*logout*/) {
366 if (recpt == NULL) return;
367 actionmapclass *actions = recpt->get_actionmap_ptr();
368
369 textout << outconvert << disp << "_status:infoheader_(Action Information)\n";
370 textout << outconvert
371 << "<h2>Action information</h2>\n"
372 << "<table>";
373
374 // action information
375 if (actions != NULL) {
376 textout << outconvert
377 << "<tr><th>action name</th><th>cgi arguments</th></tr>\n";
378
379 actionptrmap::iterator actionshere = actions->begin ();
380 actionptrmap::iterator actionsend = actions->end ();
381 while (actionshere != actionsend) {
382 assert ((*actionshere).second.a != NULL);
383 if ((*actionshere).second.a != NULL) {
384 textout << outconvert
385 << "<tr><td>" << (*actionshere).second.a->get_action_name()
386 << "</td><td>";
387
388 cgiargsinfoclass *argsinfo = (*actionshere).second.a->getargsinfo();
389 cgiargsinfoclass::const_iterator argsinfohere = argsinfo->begin ();
390 cgiargsinfoclass::const_iterator argsinfoend = argsinfo->end ();
391 bool aifirst = true;
392 while (argsinfohere != argsinfoend) {
393 if (!aifirst) textout << outconvert << ", ";
394 aifirst = false;
395 textout << outconvert << (*argsinfohere).second.shortname;
396 ++argsinfohere;
397 }
398
399 textout << outconvert << "</td></tr>\n";
400 }
401 ++actionshere;
402 }
403 }
404
405 textout << outconvert << disp << "</table>\n_status:infofooter_\n";
406}
407
408void statusaction::output_browserinfo (cgiargsclass &/*args*/, displayclass &disp,
409 outconvertclass &outconvert,
410 ostream &textout, ostream &/*logout*/) {
411 if (recpt == NULL) return;
412 browsermapclass *browsers = recpt->get_browsermap_ptr();
413
414 textout << outconvert << disp << "_status:infoheader_(Browser Information)\n";
415 textout << outconvert
416 << "<h2>Browser information</h2>\n"
417 << "<table>";
418
419 // browser information
420 if (browsers != NULL) {
421 textout << outconvert
422 << "<tr><th>browser name</th><th>default formatstring</th></tr>\n";
423
424 browserptrmap::iterator browsershere = browsers->begin ();
425 browserptrmap::iterator browsersend = browsers->end ();
426 while (browsershere != browsersend) {
427 assert ((*browsershere).second.b != NULL);
428 if ((*browsershere).second.b != NULL) {
429 textout << outconvert
430 << "<tr><td>" << (*browsershere).second.b->get_browser_name()
431 << "</td><td>" << html_safe ((*browsershere).second.b->get_default_formatstring())
432 << "</td></tr>\n";
433 }
434 ++browsershere;
435 }
436 }
437
438 textout << outconvert << disp << "</table>\n_status:infofooter_\n";
439}
440
441void statusaction::output_protocolinfo (cgiargsclass &/*args*/, displayclass &disp,
442 outconvertclass &outconvert,
443 ostream &textout, ostream &logout) {
444 if (recpt == NULL) return;
445 const recptconf &rcinfo = recpt->get_configinfo ();
446 bool colspecific = !rcinfo.collection.empty();
447 bool unreachablecol = false;
448
449 recptprotolistclass *rprotolist = recpt->get_recptprotolist_ptr ();
450 if (rprotolist == NULL) return;
451
452 textout << outconvert << disp << "_status:infoheader_(Protocol Information)\n";
453 textout << outconvert
454 << "<h2>Protocol information</h2>\n"
455 << "<table>\n"
456 << "<tr><th>protocol</th><th>collections</th></tr>\n";
457
458 text_t protoname;
459 recptprotolistclass::iterator rprotolist_here = rprotolist->begin();
460 recptprotolistclass::iterator rprotolist_end = rprotolist->end();
461 while (rprotolist_here != rprotolist_end) {
462 if ((*rprotolist_here).p != NULL) {
463 comerror_t err;
464 protoname = (*rprotolist_here).p->get_protocol_name(err);
465 textout << outconvert
466 << "<tr><td>"
467 << protoname
468 << "</td><td>";
469
470 text_tarray collist;
471 (*rprotolist_here).p->get_collection_list (collist, err, logout);
472 if (err == noError) {
473 text_tarray::iterator collist_here = collist.begin();
474 text_tarray::iterator collist_end = collist.end();
475 bool first = true;
476 while (collist_here != collist_end) {
477 if (!first) textout << outconvert << ", ";
478 first = false;
479
480 if (colspecific && *collist_here != rcinfo.collection) {
481 unreachablecol = true;
482 textout << outconvert << "\"" << *collist_here << "\"";
483 } else {
484 textout << outconvert << disp
485 << "\"<a href=\"_gwcgi_?e=_compressedoptions_&a=status&p=collectioninfo&pr="
486 << protoname
487 << "&c="
488 << *collist_here
489 << "\">"
490 << *collist_here
491 << "</a>\"";
492 }
493
494 ++collist_here;
495 }
496
497 } else {
498 textout << outconvert << "Error (" << get_comerror_string (err)
499 << ") while getting collect list\n";
500 }
501
502 textout << outconvert
503 << "</td></tr>\n";
504 }
505
506 ++rprotolist_here;
507 }
508
509 textout << outconvert << "</table>\n";
510 if (unreachablecol) {
511 textout << outconvert
512 << "<b>Warning:</b> the receptionist is running in collection specific\n"
513 << "mode making some of the collections unreachable.\n";
514 }
515 textout << outconvert << disp << "_status:infofooter_\n";
516}
517
518void statusaction::output_collectioninfo (cgiargsclass &args, displayclass &disp,
519 outconvertclass &outconvert,
520 ostream &textout, ostream &logout) {
521 if (recpt == NULL) return;
522
523 textout << outconvert << disp << "_status:infoheader_(Collection info)\n";
524 textout << outconvert << "<h2>Collection info</h2>\n";
525
526 // get the list of protocols
527 recptprotolistclass *rprotolist = recpt->get_recptprotolist_ptr ();
528 if (rprotolist == NULL) return;
529
530 // look for the desired protocol
531 text_t &arg_pr = args["pr"];
532 text_t &arg_c = args["c"];
533 recptproto *rproto = NULL;
534 recptprotolistclass::iterator rprotolist_here = rprotolist->begin();
535 recptprotolistclass::iterator rprotolist_end = rprotolist->end();
536 while (rprotolist_here != rprotolist_end) {
537 rproto = (*rprotolist_here).p;
538 comerror_t err;
539 if (rproto != NULL && rproto->get_protocol_name(err) == arg_pr) {
540 // see if the protocol has the collection
541 bool hascollection;
542 rproto->has_collection (arg_c, hascollection, err, logout);
543 if (err == noError && hascollection) break;
544 }
545 ++rprotolist_here;
546 }
547
548 if (rprotolist_here == rprotolist_end) {
549 textout << outconvert << "Protocol \"" << arg_pr << "\" with collection \""
550 << arg_c << "\" was not found\n";
551
552 } else {
553 // rproto can't be NULL to get here
554 ColInfoResponse_t *collectinfo = recpt->get_collectinfo_ptr (rproto, arg_c, logout);
555 if (collectinfo != NULL) {
556 textout << outconvert << "<table>\n"
557 << "<tr><th>collection name</th><td>\""
558 << collectinfo->shortInfo.name
559 << "\"</td></tr>\n"
560
561 << "<tr><th>host</th><td>\""
562 << collectinfo->shortInfo.host
563 << "\"</td></tr>\n"
564
565 << "<tr><th>port</th><td>\""
566 << collectinfo->shortInfo.port
567 << "\"</td></tr>\n"
568
569 << "<tr><th>is public?</th><td>";
570 if (collectinfo->isPublic) textout << outconvert << "true";
571 else textout << outconvert << "false";
572 textout << outconvert
573 << "</td></tr>\n"
574
575 << "<tr><th>is beta?</th><td>";
576 if (collectinfo->isBeta) textout << outconvert << "true";
577 else textout << outconvert << "false";
578 textout << outconvert
579 << "</td></tr>\n"
580
581 << "<tr><th>build date</th><td>\""
582 << collectinfo->buildDate
583 << "\"</td></tr>\n"
584
585 << "<tr><th>interface languages</th><td>";
586 text_tarray::iterator languages_here = collectinfo->languages.begin();
587 text_tarray::iterator languages_end = collectinfo->languages.end();
588 bool languages_first = true;
589 while (languages_here != languages_end) {
590 if (!languages_first) textout << outconvert << ", ";
591 languages_first = false;
592 textout << outconvert << "\"" << *languages_here << "\"";
593 ++languages_here;
594 }
595
596 textout << "<tr><th valign=top>collection metadata</th><td><table>\n";
597 collectionmeta_map::iterator meta_here = collectinfo->collectionmeta.begin();
598 collectionmeta_map::iterator meta_end = collectinfo->collectionmeta.end();
599
600 while (meta_here != meta_end) {
601 textout << outconvert << "<tr><td valign=top>" << (*meta_here).first
602 << "</td><td><table>" ;
603 text_tmap lang_map = (*meta_here).second;
604 text_tmap::iterator lang_here = lang_map.begin();
605 text_tmap::iterator lang_end = lang_map.end();
606 while (lang_here != lang_end) {
607 textout << outconvert << "<tr><td>" << (*lang_here).first
608 << "</td><td>" << (*lang_here).second << "</td></tr>\n";
609
610 ++lang_here;
611 }
612 textout << outconvert << "</table></td></tr>\n";
613 ++meta_here;
614 }
615 textout << "</table></td></tr>\n";
616
617 textout << "<tr><th valign=top>format info</th><td><table>\n";
618 text_tmap::iterator format_here = collectinfo->format.begin();
619 text_tmap::iterator format_end = collectinfo->format.end();
620 while (format_here != format_end) {
621 textout << outconvert << "<tr><td valign=top>" << (*format_here).first
622 << "</td><td>" << html_safe((*format_here).second) << "</td></tr>\n";
623 ++format_here;
624 }
625 textout << "</table></td></tr>\n";
626
627 textout << "<tr><th valign=top>building info</th><td><table>\n";
628 text_tmap::iterator building_here = collectinfo->building.begin();
629 text_tmap::iterator building_end = collectinfo->building.end();
630 while (building_here != building_end) {
631 textout << outconvert << "<tr><td>" << (*building_here).first
632 << "</td><td>" << (*building_here).second << "</td></tr>\n";
633 ++building_here;
634 }
635 textout << "</table></td></tr>\n";
636
637 textout << outconvert
638 << "</td></tr>\n"
639
640 << "<tr><th>number of documents</th><td>\""
641 << collectinfo->numDocs
642 << "\"</td></tr>\n"
643
644 << "<tr><th>number of sections</th><td>\""
645 << collectinfo->numSections
646 << "\"</td></tr>\n"
647
648 << "<tr><th>number of words</th><td>\""
649 << collectinfo->numWords
650 << "\"</td></tr>\n"
651
652 << "<tr><th>number of bytes</th><td>\""
653 << collectinfo->numBytes
654 << "\"</td></tr>\n"
655
656 << "<tr><th>preferred receptionist</th><td>\""
657 << collectinfo->receptionist
658 << "\"</td></tr>\n"
659
660 << "</table>";
661
662 } else {
663 textout << "ERROR (statusaction::output_collectioninfo): while getting collect information\n";
664 }
665
666
667 InfoFiltersResponse_t filterinfo;
668 InfoFilterOptionsRequest_t filteroptions_request;
669 InfoFilterOptionsResponse_t filteroptions;
670 comerror_t err;
671 rproto->get_filterinfo (arg_c, filterinfo, err, logout);
672 if (err == noError) {
673 text_tset::iterator filternames_here = filterinfo.filterNames.begin();
674 text_tset::iterator filternames_end = filterinfo.filterNames.end();
675 while (filternames_here != filternames_end) {
676 textout << outconvert
677 << "<hr>\n"
678 << "<h3>Filter options for \"" << (*filternames_here) << "\"</h3>\n"
679 << "<table>\n"
680 << "<tr><th>option name</th><th>type</th><th>repeatable</th>"
681 << "<th>default value</th><th>valid values</th></tr>\n";
682
683 filteroptions_request.clear();
684 filteroptions_request.filterName = *filternames_here;
685 rproto->get_filteroptions (arg_c, filteroptions_request,
686 filteroptions, err, logout);
687 if (err == noError) {
688 FilterOption_tmap::iterator filteropt_here =
689 filteroptions.filterOptions.begin();
690 FilterOption_tmap::iterator filteropt_end =
691 filteroptions.filterOptions.end();
692 while (filteropt_here != filteropt_end) {
693 textout << outconvert
694 << "<tr><td>\""
695 << (*filteropt_here).second.name
696 << "\"</td>\n"
697
698 << "<td>";
699 text_t type_string;
700 switch ((*filteropt_here).second.type) {
701 case FilterOption_t::booleant: type_string = "boolean"; break;
702 case FilterOption_t::integert: type_string = "integer"; break;
703 case FilterOption_t::enumeratedt: type_string = "enumerated"; break;
704 case FilterOption_t::stringt: type_string = "string"; break;
705 }
706 textout << outconvert
707 << type_string
708 << "</td>\n"
709
710 << "<td>";
711 text_t repeat_string;
712 switch ((*filteropt_here).second.repeatable) {
713 case FilterOption_t::onePerQuery: repeat_string = "one per query"; break;
714 case FilterOption_t::onePerTerm: repeat_string = "one per term"; break;
715 case FilterOption_t::nPerTerm: repeat_string = "n per term"; break;
716 }
717 textout << outconvert
718 << repeat_string
719 << "</td>\n"
720
721 << "<td>\""
722 << (*filteropt_here).second.defaultValue
723 << "\"</td>\n"
724
725 << "<td>";
726
727 text_tarray::iterator valid_here =
728 (*filteropt_here).second.validValues.begin();
729 text_tarray::iterator valid_end =
730 (*filteropt_here).second.validValues.end();
731 bool valid_first = true;
732 while (valid_here != valid_end) {
733 if (!valid_first) textout << outconvert << ", ";
734 valid_first = false;
735 textout << outconvert << "\"" << *valid_here << "\"";
736 ++valid_here;
737 }
738 textout << outconvert
739 << "</td></tr>\n";
740
741 ++filteropt_here;
742 }
743
744 textout << outconvert
745 << "</table>\n";
746
747 } else {
748 textout << outconvert << "Error (" << get_comerror_string (err)
749 << ") while getting filter option information\n";
750 }
751
752 ++filternames_here;
753 }
754
755 } else {
756 textout << outconvert << "Error (" << get_comerror_string (err)
757 << ") while getting filter information\n";
758 }
759 }
760
761 textout << outconvert << disp << "_status:infofooter_\n";
762}
763
764void statusaction::output_usagelog (cgiargsclass &/*args*/, displayclass &disp,
765 outconvertclass &outconvert,
766 ostream &textout, ostream &/*logout*/) {
767
768 // output last 100 lines of usage.txt
769
770 text_t logfilename = filename_cat (gsdlhome, "etc", "usage.txt");
771
772 textout << outconvert << disp << "_status:infoheader_(Usage log)\n";
773 textout << outconvert << "<h2>Usage log</h2>\n";
774
775 textout << outconvert << "<p>The usage log, "
776 << logfilename << ", contains the\n"
777 << "following information:\n"
778 << "<p>(note that if this file is more than 100 lines long only the last 100 lines will\n"
779 << "be displayed on this page)\n\n"
780 << "<pre>\n";
781
782 // note that we're expecting lines to be no more than 1500 characters on
783 // average - should fix this file_tail() thing sometime
784 textout << outconvert << file_tail (logfilename, 100, 1500);
785
786 textout << outconvert << disp << "</pre>\n"
787 << "_status:infofooter_\n";
788}
789
790void statusaction::output_errorlog (cgiargsclass &/*args*/, displayclass &disp,
791 outconvertclass &outconvert,
792 ostream &textout, ostream &logout) {
793
794 text_t errfilename = filename_cat (gsdlhome, "etc", "error.txt");
795 char *cerrfilename = errfilename.getcstr();
796 if (cerrfilename == NULL) return;
797
798 textout << outconvert << disp << "_status:infoheader_(Error log)\n";
799 textout << outconvert << "<h2>Error log</h2>\n";
800 logout << flush;
801
802#ifdef GSDL_USE_IOS_H
803 ifstream errin (cerrfilename, ios::in | ios::nocreate);
804#else
805 ifstream errin (cerrfilename, ios::in);
806#endif
807
808 delete []cerrfilename;
809 if (errin) {
810 textout << outconvert << "<p>The error log, "
811 << errfilename << ", contains the\n";
812 textout << outconvert << "following information:\n\n";
813 text_t errorpage = "<p><pre>\n";
814
815 char c;
816 errin.get(c);
817 while (!errin.eof ()) {
818 errorpage.push_back(c);
819 errin.get(c);
820 }
821
822 errorpage += "</pre>\n";
823 errin.close();
824 textout << outconvert << errorpage;
825
826 } else {
827 textout << outconvert << "Couldn't read error log, "
828 << errfilename << ".\n";
829 }
830
831 textout << outconvert << disp << "_status:infofooter_\n";
832}
833
834void statusaction::output_gsdlsite (cgiargsclass &/*args*/, displayclass &disp,
835 outconvertclass &outconvert,
836 ostream &textout, ostream &logout) {
837
838 textout << outconvert << disp << "_status:infoheader_(gsdlsite.cfg)\n";
839 textout << outconvert << "<h2>gsdlsite.cfg</h2>\n";
840 logout << flush;
841
842#ifdef GSDL_LOCAL_LIBRARY
843 text_t gsdlsite_cfg = filename_cat (gsdlhome, "gsdlsite.cfg");
844#else
845 text_t gsdlsite_cfg = "gsdlsite.cfg";
846#endif
847
848 char *gsdlsite_cfgc = gsdlsite_cfg.getcstr();
849#ifdef GSDL_USE_IOS_H
850 ifstream gsdlsitein (gsdlsite_cfgc, ios::in | ios::nocreate);
851#else
852 ifstream gsdlsitein (gsdlsite_cfgc, ios::in);
853#endif
854
855 delete []gsdlsite_cfgc;
856
857 if (gsdlsitein) {
858 textout << "<p>The gsdlsite.cfg configuration file contains the\n"
859 << "following information:\n\n";
860 text_t gsdlsite = "<p><pre>\n";
861
862 char c;
863 gsdlsitein.get(c);
864 while (!gsdlsitein.eof ()) {
865 gsdlsite.push_back(c);
866 gsdlsitein.get(c);
867 }
868
869 gsdlsite += "</pre>\n";
870 gsdlsitein.close();
871 textout << outconvert << gsdlsite;
872
873 } else {
874 textout << "Couldn't read gsdlsite.cfg configuration file\n";
875 }
876
877 textout << outconvert << disp << "_status:infofooter_\n";
878}
879
880void statusaction::output_maincfg (cgiargsclass &/*args*/, displayclass &disp,
881 outconvertclass &outconvert,
882 ostream &textout, ostream &/*logout*/) {
883
884 text_t maincfgfile = filename_cat (dbhome, "etc", "main.cfg");
885
886 textout << outconvert << disp << "_status:infoheader_(main.cfg)\n"
887 << "<h2>main.cfg</h2>\n"
888 << "<p>The main configuration file, "
889 << dm_safe(maincfgfile) << ", contains the following information:<br>\n\n"
890 << "(Note that only users belonging to the \"administrator\" group "
891 << "may edit this file)<br>\n"
892 << "_status:maincfg_<br>\n"
893 << "_status:infofooter_\n";
894}
895
896void statusaction::change_maincfg (cgiargsclass &args, displayclass &disp,
897 outconvertclass &outconvert,
898 ostream &textout, ostream &logout) {
899
900 // write out the contents of the cfgfile argument to main.cfg
901 text_t cfgfile = filename_cat(gsdlhome, "etc", "main.cfg");
902 char *cfgfilec = cfgfile.getcstr();
903
904 int fd=open(cfgfilec, O_WRONLY | O_CREAT | O_TRUNC
905#if defined(__WIN32__)
906 | O_BINARY
907#endif
908 );
909
910 if (fd != -1) {
911
912 int lock_val = 1;
913 GSDL_LOCK_FILE (fd);
914 if (lock_val != 0) {
915 logout << "statusaction::change_maincfg: Error: Couldn't lock file " << cfgfilec << "\n";
916 textout << outconvert << disp << "_status:changemaincfgfail_";
917 close (fd);
918 } else {
919 outconvertclass text_t2ascii;
920 text_t2ascii.setinput(&args["cfgfile"]);
921 size_t buffersize=args["cfgfile"].size();
922 char *buffer=new char[buffersize];
923 size_t num_chars;
924 convertclass::status_t status;
925 text_t2ascii.convert(buffer, buffersize, num_chars, status);
926 // ignore status - assume it is "finished" as buffer is big enough
927 write(fd, buffer, num_chars);
928 GSDL_UNLOCK_FILE (fd);
929 delete []buffer;
930 close (fd);
931 textout << outconvert << disp << "_status:changemaincfgsuccess_";
932 }
933 } else {
934 logout << "statusaction::change_maincfg: Error: Couldn't open file " << cfgfilec << "for writing\n";
935 textout << outconvert << disp << "_status:changemaincfgfail_";
936 }
937 delete []cfgfilec;
938}
939
940void statusaction::output_errorpage (outconvertclass &outconvert,
941 ostream &textout, ostream &/*logout*/,
942 text_t message) {
943 textout << outconvert
944 << "<html>\n"
945 << "<head>\n"
946 << "<title>Error</title>\n"
947 << "</head>\n"
948 << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
949 << "alink=\"#cc9900\" vlink=\"#666633\">\n"
950 << "<h2>Oops!</h2>\n"
951 << message
952 << "\n</body>\n"
953 << "</html>\n";
954 return;
955}
956
957
958
959statusaction::statusaction () {
960 disabled = true;
961 recpt = NULL;
962
963 // this action uses cgi variable "a"
964 cgiarginfo arg_ainfo;
965 arg_ainfo.shortname = "a";
966 arg_ainfo.longname = "action";
967 arg_ainfo.multiplechar = true;
968 arg_ainfo.defaultstatus = cgiarginfo::weak;
969 arg_ainfo.argdefault = "status";
970 arg_ainfo.savedarginfo = cgiarginfo::must;
971 argsinfo.addarginfo (NULL, arg_ainfo);
972
973 // "p" -- status page
974 arg_ainfo.shortname = "p";
975 arg_ainfo.longname = "page";
976 arg_ainfo.multiplechar = true;
977 arg_ainfo.defaultstatus = cgiarginfo::weak;
978 arg_ainfo.argdefault = "frameset";
979 arg_ainfo.savedarginfo = cgiarginfo::must;
980 argsinfo.addarginfo (NULL, arg_ainfo);
981
982 // "pr" -- protocol
983 arg_ainfo.shortname = "pr";
984 arg_ainfo.longname = "protocol";
985 arg_ainfo.multiplechar = true;
986 arg_ainfo.defaultstatus = cgiarginfo::none;
987 arg_ainfo.argdefault = g_EmptyText;
988 arg_ainfo.savedarginfo = cgiarginfo::can;
989 argsinfo.addarginfo (NULL, arg_ainfo);
990
991 arg_ainfo.shortname = "cfgfile";
992 arg_ainfo.longname = "configuration file contents";
993 arg_ainfo.multiplechar = true;
994 arg_ainfo.defaultstatus = cgiarginfo::weak;
995 arg_ainfo.argdefault = g_EmptyText;
996 arg_ainfo.savedarginfo = cgiarginfo::mustnot;
997 argsinfo.addarginfo (NULL, arg_ainfo);
998}
999
1000statusaction::~statusaction () {
1001}
1002
1003bool statusaction::check_cgiargs (cgiargsinfoclass &/*argsinfo*/, cgiargsclass &args,
1004 recptprotolistclass * /*protos*/, ostream &/*logout*/) {
1005
1006 // only users belonging to the "administrator" group may edit
1007 // the main.cfg file
1008 if (args["p"] == "maincfg" || args["p"] == "changemaincfg") {
1009 args["uan"] = "1";
1010 args["ug"] = "administrator";
1011 }
1012 return true;
1013}
1014
1015void statusaction::get_cgihead_info (cgiargsclass &/*args*/, recptprotolistclass * /*protos*/,
1016 response_t &response, text_t &response_data,
1017 ostream &/*logout*/) {
1018 response = content;
1019 response_data = "text/html";
1020}
1021
1022
1023void statusaction::define_internal_macros (displayclass &disp, cgiargsclass &args,
1024 recptprotolistclass * /*protos*/, ostream &logout) {
1025
1026 // define_internal_macros sets the following macros:
1027 // _maincfgfile_ the contents of the main.cfg configuration file
1028
1029 // _versionnnum_ greenstone version number (hard-coded)
1030
1031 disp.setmacro("versionnum", "status", GSDL_VERSION);
1032
1033 if (args["p"] == "maincfg") {
1034
1035 // read in main.cfg
1036 text_t maincfg = filename_cat(gsdlhome, "etc", "main.cfg");
1037 char *maincfgc = maincfg.getcstr();
1038
1039#ifdef GSDL_USE_IOS_H
1040 ifstream cfg_ifs (maincfgc, ios::in | ios::nocreate);
1041#else
1042 ifstream cfg_ifs (maincfgc, ios::in);
1043#endif
1044
1045 if (cfg_ifs) {
1046 text_t cfgtext;
1047 char c;
1048 cfg_ifs.get(c);
1049 while (!cfg_ifs.eof ()) {
1050 cfgtext.push_back(c);
1051 cfg_ifs.get(c);
1052 }
1053 cfg_ifs.close();
1054
1055 // define it as a macro
1056 disp.setmacro("maincfgfile", "status", dm_safe(cfgtext));
1057
1058 } else {
1059 logout << "statusaction::define_internal_macros: couldn't open configuration file ("
1060 << maincfgc << ") for reading\n";
1061 disp.setmacro("maincfgfile", "status", g_EmptyText);
1062 }
1063 delete []maincfgc;
1064 }
1065}
1066
1067bool statusaction::do_action (cgiargsclass &args, recptprotolistclass *protos,
1068 browsermapclass * /*browsers*/, displayclass &disp,
1069 outconvertclass &outconvert, ostream &textout,
1070 ostream &logout) {
1071 // make sure the status function is enabled
1072 if (disabled) {
1073 textout << outconvert
1074 << "<html>\n"
1075 << "<head>\n"
1076 << "<title>Status disabled</title>\n"
1077 << "</head>\n"
1078 << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
1079 << "alink=\"#cc9900\" vlink=\"#666633\">\n"
1080 << "<h2>Facility disabled</h2>\n"
1081 << "Sorry, the Maintenance and Administration facility is currently disabled\n"
1082 << "\n</body>\n"
1083 << "</html>\n";
1084 return true;
1085 }
1086
1087 // make sure we know about a receptionist
1088 if (recpt == NULL) {
1089 output_errorpage (outconvert, textout, logout,
1090 "The status action does not contain information\n"
1091 "about any receptionists. The method set_receptionist\n"
1092 "was probably not called from the module which instantiated\n"
1093 "this status action.\n");
1094 return true;
1095 }
1096
1097 // check to make sure status.dm was read in
1098 const recptconf &rcinfo = recpt->get_configinfo ();
1099 text_tset::const_iterator macrohere = rcinfo.macrofiles.begin ();
1100 text_tset::const_iterator macroend = rcinfo.macrofiles.end ();
1101 while (macrohere != macroend) {
1102 if (*macrohere == "status.dm") break;
1103 ++macrohere;
1104 }
1105 if (macrohere == macroend) {
1106 output_errorpage (outconvert, textout, logout,
1107 "The status.dm file was not read in. This macro file is\n"
1108 "needed to display configuration and status information.\n");
1109 return true;
1110 }
1111
1112 // output the required status page
1113 text_t &arg_p = args["p"];
1114 if (arg_p == "frameset") output_frameset (args, disp, outconvert, textout, logout);
1115 else if (arg_p == "select") output_select (args, disp, outconvert, textout, logout);
1116 else if (arg_p == "welcome") output_welcome (args, protos, disp, outconvert, textout, logout);
1117 else if (arg_p == "generalinfo") output_generalinfo (args, disp, outconvert, textout, logout);
1118 else if (arg_p == "argumentinfo") output_argumentinfo (args, disp, outconvert, textout, logout);
1119 else if (arg_p == "actioninfo") output_actioninfo (args, disp, outconvert, textout, logout);
1120 else if (arg_p == "browserinfo") output_browserinfo (args, disp, outconvert, textout, logout);
1121 else if (arg_p == "protocolinfo") output_protocolinfo (args, disp, outconvert, textout, logout);
1122 else if (arg_p == "collectioninfo") output_collectioninfo (args, disp, outconvert, textout, logout);
1123 else if (arg_p == "usagelog") output_usagelog (args, disp, outconvert, textout, logout);
1124 else if (arg_p == "errorlog") output_errorlog (args, disp, outconvert, textout, logout);
1125 else if (arg_p == "gsdlsite") output_gsdlsite (args, disp, outconvert, textout, logout);
1126 else if (arg_p == "maincfg") output_maincfg (args, disp, outconvert, textout, logout);
1127 else if (arg_p == "changemaincfg") change_maincfg (args, disp, outconvert, textout, logout);
1128 else {
1129 output_errorpage (outconvert, textout, logout,
1130 "Unknown page \"" + arg_p + "\".\n");
1131 }
1132
1133 return true;
1134}
1135
1136void statusaction::configure (const text_t &key, const text_tarray &cfgline) {
1137 if ((key == "status") && (cfgline.size() == 1) &&
1138 (cfgline[0] == "true" || cfgline[0] == "on" || cfgline[0] == "enabled")) {
1139 disabled = false;
1140 } else {
1141 // call the parent class to deal with the things which
1142 // are not dealt with here
1143 action::configure (key, cfgline);
1144 }
1145}
1146
1147#endif //GSDL_USE_STATUS_ACTION
Note: See TracBrowser for help on using the repository browser.