source: trunk/gsdl/src/colservr/collectset.cpp@ 9937

/**********************************************************************
 *
 * collectset.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: collectset.cpp 9937 2005-05-24 02:21:02Z kjdon $
 *
 *********************************************************************/


#include "collectserver.h"
#include "filter.h"
#include "browsefilter.h"
#include "queryfilter.h"
#include "infodbclass.h"
#include "mgqueryfilter.h"
#include "mgppqueryfilter.h"
#include "mggdbmsource.h"
#include "lucenequeryfilter.h"
#include "lucenegdbmsource.h"

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

#include "colservrconfig.h"
#include "recptconfig.h"
#include "fileutil.h"
#include "collectset.h"

collectset::collectset (text_t &gsdlhome) {

  text_tarray collections;
  text_t      collectdir;

  // get gsdlhome (if we fail the error will be picked up later -- in
  // cgiwrapper)
  if (site_cfg_read (gsdlhome, httpdomain, httpprefix)) {
    if (!gsdlhome.empty() && directory_exists(gsdlhome)) {
      collectdir = filename_cat (gsdlhome, "collect");
      if (read_dir (collectdir, collections)) {
    
    text_tarray::const_iterator thiscol = collections.begin();
    text_tarray::const_iterator endcol = collections.end();

    while (thiscol != endcol) {
      // ignore the modelcol
      if (*thiscol == "modelcol") {
        ++thiscol;
        continue;
      }

      // read config file to see if built with mg, mgpp, or lucene
      text_t buildtype = "mg"; // mg is default
      text_tarray cfgline;
      text_t key;
      text_t filename = filename_cat(collectdir, *thiscol, "index" , "build.cfg");
      ifstream confin(filename.getcstr());

      if (confin) {
        while (read_cfg_line(confin, cfgline) >= 0) {
          if (cfgline.size() ==2 ) {
        key = cfgline[0];
        cfgline.erase(cfgline.begin());
        if (key =="buildtype") {
          buildtype = cfgline[0];
          break;
        }
          }
        }
      }
      
      confin.close();

      // this memory is created but never destroyed
      // we're also not doing any error checking to make sure we didn't
      // run out of memory
      collectserver *cserver = new collectserver();
      gdbmclass *gdbmhandler = new gdbmclass();
    
      // add a null filter
      filterclass *filter = new filterclass ();
      cserver->add_filter (filter);
      
      // add a browse filter
      browsefilterclass *browsefilter = new browsefilterclass();
      browsefilter->set_gdbmptr (gdbmhandler);
      cserver->add_filter (browsefilter);
      
      if (buildtype == "mg") {
        mgsearch = new mgsearchclass();
        
        // add a query filter
        mgqueryfilterclass *queryfilter = new mgqueryfilterclass();
        queryfilter->set_gdbmptr (gdbmhandler);
        queryfilter->set_textsearchptr (mgsearch);
        cserver->add_filter (queryfilter);
        
        // add a mg and gdbm source
        mggdbmsourceclass *mggdbmsource = new mggdbmsourceclass ();
        mggdbmsource->set_gdbmptr (gdbmhandler);
        mggdbmsource->set_textsearchptr (mgsearch);
        cserver->add_source (mggdbmsource);

      } else if (buildtype == "mgpp") {
        
        mgppsearch = new mgppsearchclass();
                
        // add a query filter
        mgppqueryfilterclass *queryfilter = new mgppqueryfilterclass();
        queryfilter->set_gdbmptr (gdbmhandler);
        queryfilter->set_textsearchptr (mgppsearch);
        cserver->add_filter (queryfilter);
        
        // add a mg and gdbm source
        mggdbmsourceclass *mggdbmsource = new mggdbmsourceclass ();
        mggdbmsource->set_gdbmptr (gdbmhandler);
        mggdbmsource->set_textsearchptr (mgppsearch);
        cserver->add_source (mggdbmsource);   
      } else if (buildtype == "lucene") {
        lucenesearch = new lucenesearchclass();
        
        // add a query filter
        lucenequeryfilterclass *queryfilter = new lucenequeryfilterclass();
        queryfilter->set_gdbmptr (gdbmhandler);
        queryfilter->set_textsearchptr (lucenesearch);
        cserver->add_filter (queryfilter);
        
        // add a lucene and gdbm source
        lucenegdbmsourceclass *lucenegdbmsource = new lucenegdbmsourceclass ();
        lucenegdbmsource->set_gdbmptr (gdbmhandler);
        lucenegdbmsource->set_textsearchptr (lucenesearch);
        cserver->add_source (lucenegdbmsource);   
  }


      // inform collection server and everything it contains about its
      // collection name
      cserver->configure ("collection", *thiscol);
      // AZIZ: added on 10/10/00
      //       the cserver object does not have a reference to gsdlhome
      cserver->configure ("gsdlhome", gsdlhome);
    
      // GRB: removed    proto.add_collectserver (cserver);
      // GRB: added to build our own cservers list
      cservers.addcollectserver (cserver);

      ++thiscol;
    }
      }
    }
  }
}

collectset::~collectset () {
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();

  while (here != end) {
    if ((*here).second.c != NULL) {
      delete (*here).second.c;
    }
    ++here;
  }
  cservers.clear();
}

bool collectset::init (ostream &logout) {
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();

  while (here != end) {
    assert ((*here).second.c != NULL);
    if ((*here).second.c != NULL) {
      const colservrconf &configinfo = (*here).second.c->get_configinfo ();

      // configure this collection server

      // note that we read build.cfg before collect.cfg so that the indexmaps
      // are available to decode defaultindex, defaultsubcollection, and
      // defaultlanguage
      if (!build_cfg_read (*((*here).second.c), configinfo.gsdlhome,
               configinfo.collection)) {
    outconvertclass text_t2ascii;
    logout << text_t2ascii 
           << "Warning: couldn't read build.cfg file for collection \"" //****
           << configinfo.collection << "\", gsdlhome=\""
           << configinfo.gsdlhome << "\"\n";
    ++here;
    continue;
      }

      if (!collect_cfg_read (*((*here).second.c), configinfo.gsdlhome,
                 configinfo.collection)) {
    outconvertclass text_t2ascii;
    logout << text_t2ascii 
           << "Warning: couldn't read collect.cfg file for collection \""
           << configinfo.collection << "\", gsdlhome=\"" 
           << configinfo.gsdlhome << "\"\n";
    ++here;
    continue;
      }

      if (!(*here).second.c->init (logout)) return false;

      (*here).second.c->configure("httpdomain",httpdomain);
      (*here).second.c->configure("httpprefix",httpprefix);
    }
    ++here;
  }

  return true;
}

collectservermapclass collectset::servers()
{ return cservers;
}


void collectset::add_all_collections(const text_t &gsdlhome) {

  text_tarray collections;
  text_t collectdir = filename_cat(gsdlhome, "collect");
  if (read_dir(collectdir, collections)) {

    text_tarray::const_iterator thiscol = collections.begin();
    text_tarray::const_iterator endcol = collections.end();

    while (thiscol != endcol) {
    
      // ignore the modelcol
      if (*thiscol == "modelcol") {
    ++thiscol;
    continue;
      }
    
      // create collection server and add to null protocol
      this->add_collection (*thiscol, gsdlhome);
    
      ++thiscol;
    }
  }
}

// add_collection sets up the collectionserver and calls
// add_collectserver
void collectset::add_collection (const text_t &collection, 
                 const text_t &gsdlhome) {

  // if an old collection server exists for this collection we should
  // delete it first
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();
  while (here != end) {
    if ((*here).second.c != NULL && (*here).first == collection) {
      delete (*here).second.c;
      cservers.erase (here);
      break;
    }
    ++here;
  }
      
  // read config file to see if built with mg, mgpp, or lucene
  // -- we can rely on the collection (and therefore the build.cfg)
  // being here since this is the null protocol - a nicer way to 
  // do this would be preferable though - Stefan.
  text_t buildtype = "mg"; // mg is default

  text_tarray cfgline;
  text_t key;
  text_t build_cfg = filename_cat(gsdlhome, "collect", collection, "index", "build.cfg");
  char *build_cfgc = build_cfg.getcstr();
  ifstream confin(build_cfgc);

  if (confin) {
    while (read_cfg_line(confin, cfgline) >= 0) {
      if (cfgline.size() == 2) {
    key = cfgline[0];
    cfgline.erase(cfgline.begin());
    if (key == "buildtype") {
      buildtype = cfgline[0];
      break;
    }
      }
    }
    confin.close();
  }
  delete []build_cfgc;

  collectserver *cserver = new collectserver();
  gdbmclass *gdbmhandler = new gdbmclass();

  // add a null filter
  filterclass *filter = new filterclass ();
  cserver->add_filter (filter);
      
  // add a browse filter
  browsefilterclass *browsefilter = new browsefilterclass();
  browsefilter->set_gdbmptr (gdbmhandler);

  cserver->add_filter (browsefilter);  
 
  if (buildtype == "mg") {
    mgsearch = new mgsearchclass();
 
    // add a query filter
    mgqueryfilterclass *queryfilter = new mgqueryfilterclass();
    queryfilter->set_gdbmptr (gdbmhandler);
    queryfilter->set_textsearchptr (mgsearch);
    cserver->add_filter (queryfilter);
    
    // add a mg and gdbm source
    mggdbmsourceclass *mggdbmsource = new mggdbmsourceclass ();
    mggdbmsource->set_gdbmptr (gdbmhandler);
    mggdbmsource->set_textsearchptr (mgsearch);
    cserver->add_source (mggdbmsource);

  } else if (buildtype == "mgpp") {
      
    mgppsearch = new mgppsearchclass();

    // add a query filter
    mgppqueryfilterclass *queryfilter = new mgppqueryfilterclass();
    queryfilter->set_gdbmptr (gdbmhandler);
    queryfilter->set_textsearchptr (mgppsearch);
    cserver->add_filter (queryfilter);
      
    // add a mg and gdbm source
    mggdbmsourceclass *mggdbmsource = new mggdbmsourceclass ();
    mggdbmsource->set_gdbmptr (gdbmhandler);
    mggdbmsource->set_textsearchptr (mgppsearch);
    cserver->add_source (mggdbmsource);

  } else if (buildtype == "lucene") {
    lucenesearch = new lucenesearchclass();

    // add a query filter
    lucenequeryfilterclass *queryfilter = new lucenequeryfilterclass();
    queryfilter->set_gdbmptr (gdbmhandler);
    queryfilter->set_textsearchptr (lucenesearch);
    cserver->add_filter (queryfilter);
      
    // add a lucene and gdbm source
    lucenegdbmsourceclass *lucenegdbmsource = new lucenegdbmsourceclass ();
    lucenegdbmsource->set_gdbmptr (gdbmhandler);
    lucenegdbmsource->set_textsearchptr (lucenesearch);
    cserver->add_source (lucenegdbmsource);
  }

  // inform collection server and everything it contains about its
  // collection name
  cserver->configure ("collection", collection);
  cserver->configure ("gsdlhome", gsdlhome);

  /* Removed from add_collection 24/11/2000; already done elsewhere in collectset.  
  // configure receptionist's collectinfo structure 
  text_tarray colinfo;
  colinfo.push_back (collection);
  colinfo.push_back (gsdlhome);
  colinfo.push_back (gdbmhome);
  */
  cservers.addcollectserver (cserver);
}

void collectset::remove_all_collections () {

  // first unload any cached mg databases
  if (mgsearch != NULL) {
    mgsearch->unload_database();
  }

  // now delete the collection server objects
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();

  while (here != end) {
    if ((*here).second.c != NULL) {
      delete (*here).second.c;
    }
    ++here;
  }
  cservers.clear();
}


// remove_collection deletes the collection server of collection.
// This only needs to be called if a collectionserver is to be
// removed while the library is running. The destructor function
// cleans up all collectservers when the program exits.
void collectset::remove_collection (const text_t &collection, ostream &logout) {

  // do nothing if no collection server exists for this collection 
  if (cservers.getcollectserver(collection) == NULL) return;

  // first unload any cached mg databases - we may need to do something
  // similar to this for mgpp and lucene too
  if (mgsearch != NULL) {
    mgsearch->unload_database();
  }

  // now delete the collection server object
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();

  while (here != end) {
    if ((*here).second.c != NULL && (*here).first == collection) {
      delete (*here).second.c;
      cservers.erase (here);
      return;
    }
    ++here;
  }
  outconvertclass text_t2ascii;
  logout << text_t2ascii << "nullproto::remove_collection: failed to remove collectserver for "
     << collection << "\n";
}

void collectset::configure(const text_t &key, const text_tarray &cfgline)
{
  if (key == "collection" || key == "collectdir") return;

  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();

  while (here != end) {
    assert ((*here).second.c != NULL);
    if ((*here).second.c != NULL) {
      if (key == "collectinfo") {
    if ((*here).first == cfgline[0]) {
      (*here).second.c->configure ("gsdlhome", cfgline[1]);
      (*here).second.c->configure ("gdbmhome", cfgline[2]);
    }
      } else {
    (*here).second.c->configure (key, cfgline);
      }
    }

    ++here;
  }
}

void collectset::getCollectionList (text_tarray &collist) 
{
  collist.erase(collist.begin(),collist.end());

  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();
  while (here != end) {
    assert ((*here).second.c != NULL);
    if ((*here).second.c != NULL) {
      collist.push_back ((*here).second.c->get_collection_name());
    }
    ++here;
  }
}

void collectset::setReceptionistServers(receptionist &recpt, text_t &gsdlhome)
{ 
  collectservermapclass::iterator here = cservers.begin();
  collectservermapclass::iterator end = cservers.end();
  while (here != end) {
    assert ((*here).second.c != NULL);

    text_tarray colinfo;
    colinfo.push_back((*here).second.c->get_collection_name());
    colinfo.push_back(gsdlhome);
    colinfo.push_back(gsdlhome);
    recpt.configure("collectinfo", colinfo);

    ++here;
  }
}