/**********************************************************************
 *
 * authenaction.h -- authenticating users
 * Copyright (C) 1999  DigiLib Systems Limited, New Zealand
 *
 * 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.
 *
 *********************************************************************/

#include "gsdl_modules_cfg.h"
#ifdef GSDL_USE_AUTHEN_ACTION

#ifndef AUTHENACTION_H
#define AUTHENACTION_H

#include "gsdlconf.h"
#include "action.h"
#include "text_t.h"
#include "userdb.h"
#include "receptionist.h"


// note: you need to tell this action about the receptionist
// using set_receptionist

class authenaction : public action {
protected:
  userdbclass *user_database;
  keydbclass *key_database;
  int keydecay;

  receptionist *recpt;
  
public:
  authenaction ();
  virtual ~authenaction () {}

  void set_userdb(userdbclass *udb) {user_database = udb;}

  void set_keydb (keydbclass *kdb) {key_database = kdb;}

  void set_receptionist (receptionist *therecpt) {recpt=therecpt;}
  
  void configure (const text_t &key, const text_tarray &cfgline);

  bool init (ostream &logout);
  
  text_t get_action_name () {return "a";}
  
  bool check_cgiargs (cgiargsinfoclass &argsinfo, cgiargsclass &args, 
		      recptprotolistclass *protos, ostream &logout);

  bool check_external_cgiargs (cgiargsinfoclass &argsinfo,
			       cgiargsclass &args,
			       outconvertclass &outconvert,
			       const text_t &saveconf,
			       ostream &logout);

  void get_cgihead_info (cgiargsclass &args, recptprotolistclass *protos,
			 response_t &response, text_t &response_data, 
			 ostream &logout);
  
  void define_internal_macros (displayclass &disp, cgiargsclass &args, 
			       recptprotolistclass *protos, ostream &logout);
  
  bool do_action (cgiargsclass &args, recptprotolistclass *protos, 
		  browsermapclass *browsers, displayclass &disp, 
		  outconvertclass &outconvert, ostream &textout, 
		  ostream &logout);
};

#endif //!AUTHENACTION_H
#endif //GSDL_USE_AUTHEN_ACTION
