source: trunk/gsdl/src/recpt/action.cpp@ 919

/**********************************************************************
 *
 * action.cpp -- 
 * Copyright (C) 1999  The New Zealand Digital Library Project
 *
 * A component of the Greenstone digital library software
 * from the New Zealand Digital Library Project at the
 * University of Waikato, New Zealand.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * $Id: action.cpp 754 1999-11-01 21:10:57Z sjboddie $
 *
 *********************************************************************/

/*
   $Log$
   Revision 1.18  1999/11/01 21:10:57  sjboddie
   chnaged arguments passed to many functions

   Revision 1.17  1999/09/07 23:04:03  rjmcnab
   got rid of some compiler warnings

   Revision 1.16  1999/09/07 04:56:51  sjboddie
   added GPL notice

   Revision 1.15  1999/09/03 09:51:47  rjmcnab
   removed the argdefault configuration option (it should now be
   done with cgiarg)

   Revision 1.14  1999/09/02 00:22:42  rjmcnab
   Changes to get it compiling on AIX

   Revision 1.13  1999/07/30 02:24:43  sjboddie
   added collectinfo argument to some functions

   Revision 1.12  1999/07/10 22:15:30  rjmcnab
   Added function check_external_cgiargs so that actions that
   are not being called can override cgi arguments.

   Revision 1.11  1999/06/08 04:29:41  sjboddie
   added argsinfo to the call to check_cgiargs to make it easy to set
   args to their default if they're found to be screwed up

   Revision 1.10  1999/03/25 03:06:44  sjboddie

   altered receptionist slightly so it now passes *collectproto to
   define_internal_macros and define_external_macros - need it
   for browseaction

   Revision 1.9  1999/02/28 23:16:00  rjmcnab

   Fixed a compiler warning.

   Revision 1.8  1999/02/28 20:00:11  rjmcnab


   Fixed a few things.

   Revision 1.7  1999/02/25 21:58:58  rjmcnab

   Merged sources.

   Revision 1.6  1999/02/21 22:33:52  rjmcnab

   Lots of stuff :-)

   Revision 1.5  1999/02/11 01:24:04  rjmcnab

   Fixed a few compiler warnings.

   Revision 1.4  1999/02/08 01:27:59  rjmcnab

   Got the receptionist producing something using the statusaction.

   Revision 1.3  1999/02/05 10:42:41  rjmcnab

   Continued working on receptionist

   Revision 1.2  1999/02/04 10:00:53  rjmcnab

   Developed the idea of an "action" and having them define the cgi arguments
   which they need and how those cgi arguments function.

   Revision 1.1  1999/01/08 08:40:52  rjmcnab

   Moved from lib directory.

   Revision 1.1  1999/01/08 03:57:44  rjmcnab

   Initial revision

 */


#include "action.h"
#include <assert.h>


// define all the macros which are related to pages generated
// by this action
void action::define_internal_macros (displayclass &/*disp*/, cgiargsclass &/*args*/, 
                     recptprotolistclass * /*protos*/, ostream &/*logout*/) {
}

action::action () {
}

action::~action () {
}

// configure should be called once for each configuration line
// the default version does nothing
void action::configure (const text_t &/*key*/, const text_tarray &/*cfgline*/) {
}

// init should be called after all the configuration is done but
// before any other methods are called
bool action::init (ostream &/*logout*/) {
  return true;
}

// returns the "a" argument value that will specify this action
// this name should be short but does not have to be one character
// long
text_t action::get_action_name () {
  return "nzdl";
}

// check_cgiargs should be called before get_cgihead_info, 
// define_external_macros, and do_action. If an error is found
// a message will be written to logout, if the error is severe
// then the function will return false and no page content
// should be produced based on the arguments.
bool action::check_cgiargs (cgiargsinfoclass &/*argsinfo*/, cgiargsclass &/*args*/, 
                ostream &/*logout*/) {
  return true;
}

// check_external_cgiargs should be called after check_cgiargs
// for all actions. It should only be used to override some other
// normal behaviour, for example, producing a login page when
// the requested page needs authentication.
bool action::check_external_cgiargs (cgiargsinfoclass &/*argsinfo*/,
                     cgiargsclass &/*args*/,
                     outconvertclass &/*outconvert*/,
                     const text_t &/*saveconf*/,
                     ostream &/*logout*/) {
  return true;
}

// get_cgihead_info determines the cgi header information for
// a set of cgi arguments. If response contains location then
// response_data contains the redirect address. If reponse
// contains content then reponse_data contains the content-type.
// Note that images can now be produced by the receptionist.
void action::get_cgihead_info (cgiargsclass &/*args*/, recptprotolistclass * /*protos*/,
                   response_t &response, text_t &response_data, 
                   ostream &/*logout*/) {
  response = location;
  response_data = "http://www.nzdl.org";
}
  
// uses_display should return true if the receptionist should return
// true if the display class is needed to output the page content
// The default is to return true.
bool action::uses_display (cgiargsclass &/*args*/) {
  return true;
}


// define all the macros which might be used by other actions
// to produce pages. These macros should be well documented.
void action::define_external_macros (displayclass &/*disp*/, cgiargsclass &/*args*/, 
                     recptprotolistclass * /*protos*/, ostream &/*logout*/) {
}

// returns false if there was an error which prevented the action
// from outputing anything.
bool action::do_action (cgiargsclass &/*args*/, recptprotolistclass * /*protos*/, 
            browsermapclass * /*browsers*/, displayclass &/*disp*/, 
            outconvertclass &/*outconvert*/, ostream &/*textout*/, 
            ostream &/*logout*/) {
  return true;
}


bool operator==(const actionptr &x, const actionptr &y) {
  return (x.a == y.a);
}

bool operator<(const actionptr &x, const actionptr &y) {
  return (x.a < y.a);
}


// theaction remains the property of the calling code but
// should not be deleted until it is removed from this list.
void actionmapclass::addaction (action *theaction) {
  // can't add a null action
  assert (theaction != NULL);
  if (theaction == NULL) return;
  
  // can't add an action with no name
  assert (!(theaction->get_action_name()).empty());
  if ((theaction->get_action_name()).empty()) return;

  actionptr aptr;
  aptr.a = theaction;
  actionptrs[theaction->get_action_name()] = aptr;
}

// getaction will return NULL if the action could not be found
action *actionmapclass::getaction (const text_t &key) {
  // can't find an action with no name
  assert (!key.empty());
  if (key.empty()) return NULL;

  iterator here = actionptrs.find (key);
  if (here == actionptrs.end()) return NULL;
  
  return (*here).second.a;
}