Changeset 1168 for branches/z3950-branch

Timestamp:

2000-05-11T13:56:34+12:00 (24 years ago)

Author:

johnmcp

Message:

added proper config file parsing for z39.50 servers, and minor changes
to pageaction (minor bug when display collections from >1 proto) and
cgiwrapper (announces which collections are z39.50 servers).

Location:

branches/z3950-branch/gsdl/src/recpt

Files:

• Makefile.in (modified) (5 diffs)
• cgiwrapper.cpp (modified) (2 diffs)
• librarymain.cpp (modified) (5 diffs)
• pageaction.cpp (modified) (2 diffs)
• parse.fl (added)
• z3950cfg.h (added)
• z3950proto.cpp (modified) (6 diffs)
• z3950proto.h (modified) (3 diffs)
• zparse.y (added)

branches/z3950-branch/gsdl/src/recpt/Makefile.in

@@ -77 +77 @@
 RECEPTHEADERS = 
 
-LIBRARYHEADERS = nullproto.h
+LIBRARYHEADERS = nullproto.h z3950proto.h
 
 HEADERS = $(COMMONHEADERS) $(RECPTHEADERS) $(LIBRARYHEADERS)
@@ -95 +95 @@
 RECPTSOURCES = recptmain.cpp
 
-LIBRARYSOURCES = nullproto.cpp librarymain.cpp
+LIBRARYSOURCES = nullproto.cpp z3950proto.cpp librarymain.cpp
 
 SOURCES = $(COMMONSOURCES) $(RECPTSOURCES) $(LIBRARYSOURCES)
@@ -109 +109 @@
         hlistbrowserclass.o datelistbrowserclass.o invbrowserclass.o \
         pagedbrowserclass.o htmlbrowserclass.o delhistoryaction.o \
-        historydb.o
+        historydb.o parse.yy.o
 
 RECPTOBJECTS = recptmain.o
 
-LIBRARYOBJECTS = nullproto.o librarymain.o
+LIBRARYOBJECTS = nullproto.o z3950proto.o librarymain.o zparse.tab.o
 
 OBJECTS = $(COMMONOBJECTS) $(RECPTOBJECTS) $(LIBRARYOBJECTS)
@@ -133 +133 @@
                   ../colservr/phrasequeryfilter.o
 
-
+# bison and flex temp files
+zparse.tab.c: zparse.y
+    bison -d zparse.y
+parse.yy.c: parse.fl
+    flex -oparse.yy.c parse.fl
+PARSE_TMPFILES= zparse.tab.o zparse.tab.c zparse.tab.h parse.yy.o parse.yy.c
 EXEC = recpt library
 
@@ -139 +144 @@
 
 distclean:
-    rm -f $(OBJECTS) $(EXEC) Makefile
+    rm -f $(OBJECTS) $(EXEC) $(PARSE_TMPFILES) Makefile
 
 clean:
-    rm -f $(OBJECTS) $(EXEC)
+    rm -f $(OBJECTS) $(EXEC) $(PARSE_TMPFILES)
 
 install:

branches/z3950-branch/gsdl/src/recpt/cgiwrapper.cpp

@@ -28 +28 @@
 /*
    $Log$
+   Revision 1.25.2.1  2000/05/11 01:56:27  johnmcp
+
+   added proper config file parsing for z39.50 servers, and minor changes
+   to pageaction (minor bug when display collections from >1 proto) and
+   cgiwrapper (announces which collections are z39.50 servers).
+
    Revision 1.25  2000/04/14 04:45:19  sjboddie
    Modified the English of the debug output slightly
@@ -483 +489 @@
   recptprotolistclass::iterator rprotolist_here = protos->begin();
   recptprotolistclass::iterator rprotolist_end = protos->end();
+
+  bool is_z3950 = false;
   while (rprotolist_here != rprotolist_end) {
-    if ((*rprotolist_here).p != NULL) {
-
-      text_tarray collist;
-      comerror_t err;
-      (*rprotolist_here).p->get_collection_list (collist, err, cerr);
-      if (err == noError) {
-    text_tarray::iterator collist_here = collist.begin();
-    text_tarray::iterator collist_end = collist.end();
-
-    while (collist_here != collist_end) {
+    if ((*rprotolist_here).p == NULL) continue;
+    else if (is_z3950==false &&
+         (*rprotolist_here).p->get_protocol_name() == "z3950proto") {
+      cout << "\nZ39.50 Servers:   (always public)\n"
+       << "---------------\n";
+      is_z3950=true;
+    }
+
+    text_tarray collist;
+    comerror_t err;
+    (*rprotolist_here).p->get_collection_list (collist, err, cerr);
+    if (err == noError) {
+      text_tarray::iterator collist_here = collist.begin();
+      text_tarray::iterator collist_end = collist.end();
+      
+      while (collist_here != collist_end) {
+    
+    cout << text_t2ascii << *collist_here;
+    
+    int spaces = (22 - (*collist_here).size());
+    if (spaces < 2) spaces = 2;
+    text_t outspaces;
+    for (int i = 0; i < spaces; i++) outspaces.push_back (' ');
+    cout << text_t2ascii << outspaces;
+    
+    ColInfoResponse_t cinfo;
+    (*rprotolist_here).p->get_collectinfo (*collist_here, cinfo, err, cerr);
+    if (err == noError && is_z3950 == false) {
+      if (cinfo.isPublic) cout << "public ";
+      else cout << "private";
       
-      cout << text_t2ascii << *collist_here;
-
-      int spaces = (22 - (*collist_here).size());
-      if (spaces < 2) spaces = 2;
-      text_t outspaces;
-      for (int i = 0; i < spaces; i++) outspaces.push_back (' ');
-      cout << text_t2ascii << outspaces;
-
-      ColInfoResponse_t cinfo;
-      (*rprotolist_here).p->get_collectinfo (*collist_here, cinfo, err, cerr);
-      if (err == noError) {
-        if (cinfo.isPublic) cout << "public ";
-        else cout << "private";
-
-        if (cinfo.buildDate > 0) cout << "   running    ";
-        else cout << "   not running";
-      }
-
-      cout << "\n";
-
-      collist_here ++;
+      if (cinfo.buildDate > 0) cout << "   running    ";
+      else cout << "   not running";
     }
+    
+    cout << "\n";
+    
+    collist_here ++;
       }
     }
+    is_z3950=false;
     rprotolist_here ++;
-  }
+  } // end of while loop
   
   cout << "------------------------------------------------------------\n";

branches/z3950-branch/gsdl/src/recpt/librarymain.cpp

@@ -28 +28 @@
 /*
    $Log$
+   Revision 1.25.2.1  2000/05/11 01:56:29  johnmcp
+
+   added proper config file parsing for z39.50 servers, and minor changes
+   to pageaction (minor bug when display collections from >1 proto) and
+   cgiwrapper (announces which collections are z39.50 servers).
+
    Revision 1.25  2000/04/14 02:52:05  sjboddie
    tidied up error messaging and set up some debugging info to be output
@@ -118 +124 @@
 #include "cgiwrapper.h"
 #include "nullproto.h"
+// z39.50 stuff - johnmcp
+#include "z3950proto.h"
 #include "collectserver.h"
 #include "filter.h"
@@ -153 +161 @@
   receptionist recpt;
   nullproto nproto;
+  z3950proto zproto;
   text_tarray collections;
+
 
   // get gsdlhome
@@ -207 +217 @@
     colinfo.push_back (gsdlhome);
     recpt.configure ("collectinfo", colinfo);
-  
+    
     nproto.add_collectserver (cserver);
     thiscol ++;
@@ -215 +225 @@
   recpt.add_protocol (&nproto);
   
+
+
+  // z39.50 stuff - johnmcp
+
+  // add the z39.50 server information. Read in the file
+  // etc/recpt/z3950.cfg for list of servers and their databases.
+  text_t z3950cfg = filename_cat (gsdlhome, "etc");
+  z3950cfg = filename_cat (z3950cfg, "recpt");
+  z3950cfg = filename_cat (z3950cfg, "z3950.cfg");
+  if (file_exists(z3950cfg)) {
+    zproto.read_config_file(z3950cfg);
+    // only add this protocol if we have any servers configured.
+    if (zproto.getServerCount()>0)
+      recpt.add_protocol (&zproto);
+  }
+
+
   // add other converters
   utf8inconvertclass utf8inconvert;

branches/z3950-branch/gsdl/src/recpt/pageaction.cpp

@@ -28 +28 @@
 /*
    $Log$
+   Revision 1.29.6.1  2000/05/11 01:56:30  johnmcp
+
+   added proper config file parsing for z39.50 servers, and minor changes
+   to pageaction (minor bug when display collections from >1 proto) and
+   cgiwrapper (announces which collections are z39.50 servers).
+
    Revision 1.29  2000/03/19 21:16:46  nzdl
    added german language interface
@@ -266 +272 @@
       collist_here ++;
     }
-    homeextra += "</tr></table></center>\n";
-    disp.setmacro ("homeextra", "home", homeextra); 
-      }
-    }
+    // disp.setmacro ("homeextra", "home", homeextra); 
+      }
+    }
+    homeextra += "</td></tr>\n<tr>\n";
     rprotolist_here ++;
   }
+  homeextra += "</tr></table></center>\n";
+  disp.setmacro ("homeextra", "home", homeextra); 
 }
 

branches/z3950-branch/gsdl/src/recpt/z3950proto.cpp

@@ -6 +6 @@
 #include "comtypes.h"
 #include <stdio.h>
+
+// config file parsing stuff
+#include "z3950cfg.h" // for reading in config files - 
+// defines "struct z3950cfg *zserver_list" as the head of the list.
+extern FILE *yyin;
+// for some reason, adding the following line screws up the linking...
+//extern int zconfigparse();
 
 /*** 
@@ -17 +24 @@
   info=NULL;
   meta["iconcollection"]="/~johnmcp/gsdl/images/zserver.png";
+  // meta["collectionextra"]="Extra collection information";
+  // meta["collectionname"]="overwritten";
+}
+void z3950_server::setMeta(const text_t &key, const text_t &value) {
+  meta[key]=value;
+}
+void z3950_server::setName(const text_t &newname) {
+  title=newname;
+  meta["collectionname"]=newname;
+  // cout << "Have set server name\n";
 }
 
@@ -34 +51 @@
 }
 
-void z3950proto::configure (const text_t &/*key*/, 
-                const text_tarray &/*cfgline*/) {
+void z3950proto::read_config_file(const text_t &filename) {
+  struct z3950cfg *here;
+  z3950_server *zserver;
+  ShortColInfo_t *tempinfo;
+
+  cerr << "attempting to read config file: " << filename.getcstr() << "\n";
+  // zconfigparse() is defined in zparse.tab.c,
+  // which is the bison output of zparse.y
+
+  yyin=fopen(filename.getcstr(),"r");
+  if (yyin==NULL) {
+    cerr << "Could not open "<<filename.getcstr()<<" for reading.\n";
+  }
+  zconfigparse();
+  // we now have the config files in the ptr zserver_list
+  if (zserver_list==NULL)
+    return; // no valid servers found in the config file - note that
+  // the parser will have already spat out any errors.
+
+  // now create z3950servers for each structure in server_list
+  here=zserver_list;
+  while (here!=NULL) {
+    zserver=new z3950_server;
+    tempinfo=new ShortColInfo_t;
+
+    tempinfo->host.setcstr(here->hostname);
+    tempinfo->port=here->port;
+    tempinfo->name.setcstr(here->dbname);
+    zserver->setInfo(tempinfo);
+    zserver->setName(here->shortname);
+    // now collection metadata.
+    zserver->setMeta("collectionname",here->longname);
+    if (here->icon!=NULL)
+      zserver->setMeta("iconcollection",here->icon);
+    if (here->smallicon!=NULL)
+      zserver->setMeta("iconcollectionsmall",here->smallicon);
+    if (0) {
+      cerr << "creating metadata:\n\tcolname is " << here->longname
+       << "\n\ticoncollection is " << here->icon
+       << "\n  and\ticoncollectionsmall is " << here->smallicon
+       << "\n";
+    }
+
+    // and about list .... later.
+
+    add_server(*zserver);
+    here=here->next;
+  }
+
+  // finally, delete all unneeded allocated memory in server_list
+
+}
+
+void z3950proto::configure (const text_t &key,
+                const text_tarray &cfgline) {
 
   // this is called for each line in the gsdlsite.cfg file
-  /*  cerr << "z3950proto::configure called:"
-      << "key is " << key.getcstr()
-      << "\n1st line is " << cfgline[0].getcstr() << endl;
-  */
+
+  if (0)
+    cerr << "z3950proto::configure called:"
+     << "key is " << key.getcstr()
+     << "\n1st line is " << cfgline[0].getcstr() << endl;
+  
 }
 
@@ -155 +227 @@
   */
 
-collectinfo.receptionist="z3950"; /* for now... this is a url,
-                    relative to .../cgi-bin   */
+  ////collectinfo.receptionist="z3950"; 
+  /* for now... this is a url,  relative to .../cgi-bin.
+     NOTE: if this is empty, it defaults to _gwcgi_?a=p&p=about&c=<colname>
+  */
 }
 
@@ -169 +243 @@
              FilterResponse_t &response,
              comerror_t &err, ostream &logout) {
-  // assume this function is only called when creating the title page,
-  // and looking for the metadata regarding icons.
+
+  // this function is called when:
+  //  *  creating the title page,(looking for iconcoll* & collectname metadata)
+  //  *  creating the about page (looking for "Title" metadata)
+  // For the title page, we should not create a connection to the target
+  // (target means the actual z39.50 server, origin means us), but
+  // for the about page and query pages, we need to get information from the
+  // origin. (eg for the about page, we will print out some info such as ID,
+  // name and version.
+
+  // cerr now goes to errout.txt in etc directory
+
   response.numDocs=0;
   response.isApprox=Approximate; // Exact | Approximate | MoreThan
@@ -181 +265 @@
      request.docSet (includes OID);
   */
-  // fill in the metadata for each of the OIDs (if it is requested)
+
+  // response.termInfo.push_back(""); ??????? (should be empty if not req.)
+
+
   if (request.filterResultOptions & FRmetadata) {
-    // request.fields // type text_tset
-    // docInfo is type ResultDocInfo_tarray
+
     ColInfoResponse_t *info = new ColInfoResponse_t;
     get_collectinfo (collection, *info, err, logout);
     // should check err returned here....
 
+    ////////// cerr << "Filter.\n";
+
     ResultDocInfo_t *docInfo=new ResultDocInfo_t;
-    
-    text_tmap::iterator it=info->collectionmeta.find("collectionname");
-    // cerr now goes to errout.txt in etc directory
-    // "(*it).first" is key, "(*it).second" is value(s).
-    if (it!=info->collectionmeta.end()) 
-      docInfo->metadata["collectionname"].values.push_back((*it).second);
-    else // needs to exist, but be empty
-      docInfo->metadata["collectionname"].values.push_back("");
-
-    it=info->collectionmeta.find("iconcollection");
-    if (it!=info->collectionmeta.end()) 
-      docInfo->metadata["iconcollection"].values.push_back((*it).second);
-    else // needs to exist, but be empty
-      docInfo->metadata["iconcollection"].values.push_back("");
-
-    it=info->collectionmeta.find("iconcollectionsmall");
-    if (it!=info->collectionmeta.end()) 
-      docInfo->metadata["iconcollectionsmall"].values.push_back((*it).second);
-    else // needs to exist, but be empty
-      docInfo->metadata["iconcollectionsmall"].values.push_back("");
-    
+
+    /* In the absence of any other information, (eg commented code),
+       assuming that if the request.fields is empty, then we should return
+       all metadata, otherwise return only the requested fields */
+
+    if (!request.fields.empty()) {
+      // loop on all the metadata fields in request.fields (type text_tset)
+      text_tset::iterator fields_here=request.fields.begin();
+      text_tset::iterator fields_end=request.fields.end();
+      text_tmap::iterator it;
+      while (fields_here!=fields_end) {
+    it=info->collectionmeta.find(*fields_here);
+    ////////// cerr << "filter: getting " << (*fields_here).getcstr();
+    if (it!=info->collectionmeta.end())
+      docInfo->metadata[*fields_here].values.push_back((*it).second);
+    else {
+      docInfo->metadata[*fields_here].values.push_back("");
+      /////// cerr << " (not found)";
+    }
+    ////////cerr << "\n";
+    fields_here++;
+      } // end of while loop
+    } // end of if (!request.fields.empty())
+    else {
+      // return all metadata for about page or query
+      text_tmap::iterator colmeta_here=info->collectionmeta.begin();
+      text_tmap::iterator colmeta_end=info->collectionmeta.end();
+      while (colmeta_here!=colmeta_end) {
+    docInfo->metadata[(*colmeta_here).first].
+      values.push_back((*colmeta_here).second);
+    /////cerr << "\t" << (*colmeta_here).first.getcstr() << "\n";
+    colmeta_here++;
+      }
+      // get data from target.
+      z3950_server_array::iterator zserver = zservers.begin();
+      z3950_server_array::iterator zend = zservers.end();
+      while (zserver != zend) {
+    if(zserver->getName()==collection) {
+      break;
+    }
+    zserver++;
+      }
+      // now have collection in zserver.
+      // check if "collectionextra" metadata is set. If it isn't, we should
+      // create connection to target to get it.
+      if (info->collectionmeta.find("collectionextra")==colmeta_end) {
+    // it doesn't exist.
+    zserver->setMeta("collectionextra","This is some extra info.");
+    docInfo->metadata["collectionextra"].values.push_back("This is extra");
+      }
+      
+    } // end of else
 
     response.docInfo.push_back(*docInfo);
-  }
-
+  } //end of  if (... & FRmetadata) ...
   err=noError;
 }

branches/z3950-branch/gsdl/src/recpt/z3950proto.h

@@ -5 +5 @@
 #include "recptproto.h"
 
-// each server can have one or more databases
-/*
-  class z3950_DB {
-  protected:
-  text_t name; // Descriptive name
-  text_t database; // name for server
-  
-  public:
-  z3950_DB();     // constructor
-  ~z3950_DB();    // deconstructor
-  const text_t getName() {return name;}                // this gets name
-  void setName(text_t newName) {name=newName;} // this sets name
-  // need to get next (for linked list)
-  };
-  
-
-  typedef  vector<z3950_DB>  z3950_DB_array;
-*/
-
-/*class z3950_DB_Array {
-  protected:
-  int count;
-  // some arraytype...
-  public:
-  z3950_DB first();
-  z3950_DB last();
-  void     add(z3950_DB *db);
-  void     remove(z3950_DB *db);
-  };
-*/
-
-
+// each "server" (ie collection) consists of a {z39.50 server + database} pair.
 class z3950_server {
  protected:
@@ -49 +18 @@
  public:
   z3950_server();
-  // z3950_DB_array getDBs();
   const text_t getName() {return title;}
-  void setName(const text_t &newname) {title=newname;}
-  //  void setHostname(const text_t &newname) {hostname=newname;}
+  void setMeta(const text_t &key, const text_t &value);
+  void setName(const text_t &newname);
   void setInfo(ShortColInfo_t *newinfo) {info=newinfo;}
   const ShortColInfo_t *getInfo() {return info;}
@@ -71 +39 @@
   virtual ~z3950proto() {}
 
+  int getServerCount() { return zserver_count;}
   /*
   void add_collectserver (collectserver *thecserver) 
         {cservers.addcollectserver(thecserver);}
   */
+  
+  void add_server(const z3950_server& zserver);
 
-  void add_server(const z3950_server& zserver);
+  void read_config_file(const text_t &filename);
 
   void configure (const text_t &key, const text_tarray &cfgline);