Changeset 1168 for branches/z3950-branch/gsdl/src/recpt/z3950proto.cpp

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).

File:

• branches/z3950-branch/gsdl/src/recpt/z3950proto.cpp (modified) (6 diffs)

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;
 }