source: trunk/gsdl/src/recpt/pageaction.cpp@ 542

/**********************************************************************
 *
 * pageaction.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: pageaction.cpp 542 1999-09-07 23:08:09Z rjmcnab $
 *
 *********************************************************************/

/*
   $Log$
   Revision 1.14  1999/09/07 23:08:09  rjmcnab
   Removed some compiler warnings

   Revision 1.13  1999/09/07 04:56:57  sjboddie
   added GPL notice

   Revision 1.12  1999/09/02 00:26:43  rjmcnab
   made the p cgi argument always saved in the compressed arguments

   Revision 1.11  1999/08/25 04:48:43  sjboddie
   changes to the home and about pages

   Revision 1.10  1999/08/11 23:29:43  sjboddie
   added support for html classifier (i.e. the hp argument)

   Revision 1.9  1999/08/03 03:29:47  sjboddie
   added ability to set receptionist from collect.cfg

   Revision 1.8  1999/07/30 02:24:44  sjboddie
   added collectinfo argument to some functions

   Revision 1.7  1999/06/24 05:12:24  sjboddie
   lots of small changes

   Revision 1.6  1999/06/10 00:39:16  sjboddie
   navigation bar is no longer written out for every page (it should
   be included in the _content_ macro of pages wanting to display it).

   Revision 1.5  1999/06/08 04:29:35  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.4  1999/02/28 20:00:14  rjmcnab


   Fixed a few things.

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

   Merged sources.

   Revision 1.2  1999/02/21 22:33:54  rjmcnab

   Lots of stuff :-)

   Revision 1.1  1999/02/12 02:40:17  sjboddie

   Added page action

 */

#include "OIDtools.h"
#include "pageaction.h"
#include "receptionist.h"
#include <time.h>

pageaction::pageaction () {

  recpt = NULL;

  // this action uses cgi variables "a", "p", and "hp"
  cgiarginfo arg_ainfo;
  arg_ainfo.shortname = "a";
  arg_ainfo.longname = "action";
  arg_ainfo.multiplechar = true;
  arg_ainfo.defaultstatus = cgiarginfo::weak;
  arg_ainfo.argdefault = "p";
  arg_ainfo.savedarginfo = cgiarginfo::must;
  argsinfo.addarginfo (NULL, arg_ainfo);

  arg_ainfo.shortname = "p";
  arg_ainfo.longname = "page";
  arg_ainfo.multiplechar = true;
  arg_ainfo.defaultstatus = cgiarginfo::weak;
  arg_ainfo.argdefault = "about";
  arg_ainfo.savedarginfo = cgiarginfo::must;
  argsinfo.addarginfo (NULL, arg_ainfo);

  arg_ainfo.shortname = "hp";
  arg_ainfo.longname = "html page";
  arg_ainfo.multiplechar = true;
  arg_ainfo.defaultstatus = cgiarginfo::weak;
  arg_ainfo.argdefault = "";
  arg_ainfo.savedarginfo = cgiarginfo::mustnot;
  argsinfo.addarginfo (NULL, arg_ainfo);
}

pageaction::~pageaction () {
}

bool pageaction::check_cgiargs (cgiargsinfoclass &/*argsinfo*/, cgiargsclass &/*args*/, 
                ostream &/*logout*/) {
  // don't want to check anything yet.
  return true;
}

void pageaction::get_cgihead_info (cgiargsclass &/*args*/, response_t &response,
                   text_t &response_data, ostream &/*logout*/) {
  response = content;
  response_data = "text/html";
}


// define all the macros which might be used by other actions
// to produce pages. 
void pageaction::define_external_macros (const ColInfoResponse_t &/*collectinfo*/, displayclass &/*disp*/, 
                     cgiargsclass &/*args*/, recptproto * /*collectproto*/, 
                     ostream &/*logout*/) {
}


void pageaction::define_internal_macros (const ColInfoResponse_t &collectinfo, displayclass &disp, 
                     cgiargsclass &args, recptproto *collectproto, 
                     ostream &logout) {

  // define_internal_macros sets the following macros:

  // if page is "home"
  // _homeextra_           this is the list of available collections and collection info
  //                       to be displayed on the home page


  // if page is "about"
  // _numdocs_             the number of documents in the collection

  // _builddate_           the date last built

  // _textbrowseoptions_   the 'how to find information' text in the about and help pages

  // _numbrowseoptions_    the number of browsing options 


  // if page is "help"
  // _textbrowseoptions_   the 'how to find information' text in the about and help pages

  // _numbrowseoptions_    the number of browsing options 

  
  text_t &arg_p = args["p"];

  if (arg_p == "home") {
    // make sure we know about a receptionist
    if (recpt == NULL) {
      logout << "The page action does not contain information\n"
         << "about any receptionists. The method set_receptionist\n"
         << "was probably not called from the module which instantiated\n"
         << "this page action.\n";
      return;
    }

    unsigned long current_time = time(NULL);
    text_t homeextra;

    recptprotolistclass *rprotolist = recpt->get_recptprotolist_ptr ();
    if (rprotolist == NULL) return;

    recptprotolistclass::iterator rprotolist_here = rprotolist->begin();
    recptprotolistclass::iterator rprotolist_end = rprotolist->end();
    while (rprotolist_here != rprotolist_end) {
      if ((*rprotolist_here).p != NULL) {
    text_tarray collist;
    comerror_t err;
    (*rprotolist_here).p->get_collection_list (collist, err, logout);
    if (err == noError) {
      text_tarray::iterator collist_here = collist.begin();
      text_tarray::iterator collist_end = collist.end();

      homeextra += "<dl>\n";

      FilterResponse_t response;
      text_tarray metadata;
      metadata.push_back ("collectionname");

      while (collist_here != collist_end) {
        text_t collectionname = *collist_here;
        if (get_info ("collection", *collist_here, metadata, false, (*rprotolist_here).p, response, logout))
          collectionname = response.docInfo[0].metadata[0].values[0];
        
        ColInfoResponse_t cinfo;
        (*rprotolist_here).p->get_collectinfo (*collist_here, cinfo, err, logout);
        if (err == noError) {
          text_t link = "<a href=\"_gwcgi_?a=p&p=about&c=" + *collist_here + "\">";
          if (!cinfo.receptionist.empty()) 
        link = "<a href=\"" + cinfo.receptionist + "?a=p&p=about&c=" + *collist_here + "\">";
          
          homeextra += "<dt>" + link + collectionname + "</a></dt>\n";
          homeextra += "<dd>";
          if (cinfo.numDocs != 0) homeextra += text_t(cinfo.numDocs) + "_documents_";
          if (cinfo.numWords != 0) homeextra += text_t(cinfo.numWords) + "_words_";
          unsigned long last_update = (current_time - cinfo.buildDate) / 86400;
          homeextra += "_lastupdate_ " + text_t(last_update) + " _ago_</dd>\n";
        }
        collist_here ++;
      }
      homeextra += "</dl>\n";
      disp.setmacro ("homeextra", "home", homeextra); 
    }
      }
      rprotolist_here ++;
    }
  } else if (arg_p == "about") {
    disp.setmacro ("numdocs", "about", collectinfo.numDocs);
    unsigned long current_time = time(NULL);
    unsigned long builddate = (current_time - collectinfo.buildDate) / 86400;
    disp.setmacro ("builddate", "about", builddate);
  }

  if (arg_p == "about" || arg_p == "help") {

    // _textbrowseoptions_ and _numbrowseoptions_

    FilterResponse_t response;
    text_tarray metadata;
    metadata.push_back ("Title");
    bool getParents = false;
    get_children ("", args["c"], metadata, getParents, collectproto, response, logout);

    disp.setmacro ("numbrowseoptions", "help", response.docInfo.size()+1);

    ResultDocInfo_tarray::const_iterator here = response.docInfo.begin();
    ResultDocInfo_tarray::const_iterator end = response.docInfo.end();

    // we're assuming that we've always got a search button
    text_t shorttext = "<ul><li>_textSearchshort_\n";
    text_t longtext = "_textSearchlong_";

    while (here != end) {
      const text_t &title = (*here).metadata[0].values[0];
      shorttext += "<li>_text" + title + "short_\n";
      longtext += "_text" + title + "long_";
      here ++;
    }
    shorttext += "</ul>\n";
    disp.setmacro ("textbrowseoptions", "help", shorttext + longtext);
  }
}

bool pageaction::do_action (cgiargsclass &args, const ColInfoResponse_t &/*collectinfo*/, 
                recptproto * /*collectproto*/, displayclass &disp, 
                outconvertclass &outconvert, ostream &textout, 
                ostream &/*logout*/) {

  text_t &arg_p = args["p"];

  textout << outconvert << disp << ("_" + arg_p + ":header_\n")
      << ("_" + arg_p + ":content_\n")
      << ("_" + arg_p + ":footer_\n");

  return true;
}