Changeset 31387 for main/trunk/greenstone2/runtime-src/src/colservr/browsefilter.cpp

Timestamp:

2017-02-08T18:31:18+13:00 (7 years ago)

Author:

ak19

Message:

Round 1 of commits for getting OAI deletion policy to work with GS2 (server end). The perl code writing out the OAI db and the GS3 server code implementing the deletion policy had already been completed earlier (end 2016).

File:

• main/trunk/greenstone2/runtime-src/src/colservr/browsefilter.cpp (modified) (8 diffs)

main/trunk/greenstone2/runtime-src/src/colservr/browsefilter.cpp

@@ -26 +26 @@
 #include "browsefilter.h"
 #include "fileutil.h"
+#include <assert.h>
 
 
 browsefilterclass::browsefilterclass () {
   db_ptr = NULL;
+  oaidb_ptr = NULL;
 
   // -- onePerQuery StartResults   integer
@@ -60 +62 @@
 }
 
-browsefilterclass::~browsefilterclass () {
-}
+browsefilterclass::~browsefilterclass () {}
 
 void browsefilterclass::configure (const text_t &key, const text_tarray &cfgline) {
@@ -75 +76 @@
   if (!filterclass::init(logout)) return false;
 
-  if (db_ptr == NULL) {
+  if (db_ptr == NULL || oaidb_ptr == NULL) {
     // most likely a configuration problem
     logout << text_t2ascii 
@@ -93 +94 @@
   }
 
+  oaidb_filename = resolve_oaidb_filename(oaidb_ptr->getfileextension());
+
   return true;
 }
@@ -104 +107 @@
   response.clear ();
   err = noError;
-  if (db_ptr == NULL) {
-    // most likely a configuration problem
-    logout << text_t2ascii 
-       << "configuration error: browsefilter contains a null dbclass\n\n";
-    err = configurationError;
-    return;
-  }
-
-  // open the database
-  db_ptr->setlogout(&logout);
-  if (!db_ptr->opendatabase (db_filename, DB_READER, 100, false)) {
-    // most likely a system problem (we have already checked that the database exists)
-    logout << text_t2ascii
-       << "system problem: open on database \""
-       << db_filename << "\" failed\n\n";
-    err = systemProblem;
-    return;
-  }
 
   // get the browse parameters
@@ -146 +131 @@
   }
 
+  // if we're only working on oai, open oai_db, no need to work with index_db in browsefilter.cpp
+  // (but source.cpp uses both oai-inf.db and index.db to get metadata for OAI request)
+  // If we can't open the oai-inf db, this can be because it didn't exist in older versions of GS
+  // in that case, proceed as usual, using the index db.
+  if((request.filterResultOptions & FROAI)) { // OAI request    
+    bool success = false;
+
+    if(parentnode == "oai") { // doing an OAI listidentifiers request
+
+      // open up the oai-inf db, if it exists, and return all IDs
+      // if it doesn't exist, proceed as usual
+      success = get_oaiinf_db_entries(response, err, logout); //adds any stuff in oai-inf db for the current OID to resultdoc.metadata
+
+      response.numDocs = response.docInfo.size();
+      response.isApprox = Exact;
+    }
+    if (success) return; // oai request successfully completed with oai-inf.db, no need to open index_db
+  } 
+
+  // Since we're here, it means we're not doing anything oai (or oai-inf.db did not exist/open)
+  // So we don't need to work with oai_db. Instead, work with index_db:
+
+  if (db_ptr == NULL) {
+    // most likely a configuration problem
+    logout << text_t2ascii 
+       << "configuration error: browsefilter contains a null index dbclass\n\n";
+    err = configurationError;
+    return;
+  }
+
+  // open the database
+  db_ptr->setlogout(&logout);
+  if (!db_ptr->opendatabase (db_filename, DB_READER, 100, false)) {
+    // most likely a system problem (we have already checked that the database exists)
+    logout << text_t2ascii
+       << "system problem: open on database \""
+       << db_filename << "\" failed\n\n";
+    err = systemProblem;
+    return;
+  }
+
   infodbclass info;
 
@@ -158 +184 @@
       (request.filterResultOptions & FRmetadata)) {
     if (!db_ptr->getinfo(parentnode, info)) {
-      // didn't find the node
+      // didn't find the node in index db
       logout << text_t2ascii
          << "warning: lookup for node \"" << parentnode 
@@ -308 +334 @@
   response.isApprox = Exact;
 }
+
+bool browsefilterclass::get_oaiinf_db_entries(FilterResponse_t &response, 
+                      comerror_t &err, ostream &logout) 
+{
+  outconvertclass text_t2ascii;
+  
+  //logout << text_t2ascii << "browsefilterclass::get_oaiinf_db_entries\n";   
+
+  // ONLY if we're doing any OAI stuff (FROAI will be set then) will we be here
+  // So next try to open the oai-inf db if it exists for this collection
+
+  
+  if (!file_exists(oaidb_filename)) { // if the oaidb file doesn't even exist, let's not bother with oaidb
+    
+    logout << text_t2ascii
+       << "warning: collection's oai-inf database \"" << oaidb_filename << "\" does not exist\n\n";    
+    return false;
+
+  } else { // let's try opening the oaidb file
+    oaidb_ptr->setlogout(&logout);
+    if (!oaidb_ptr->opendatabase (oaidb_filename, DB_READER, 100, false)) {
+      // most likely a system problem (we have already checked that the database exists just above)
+      logout << text_t2ascii
+         << "system problem: open on database \""
+         << oaidb_filename << "\" failed\n\n";
+      err = systemProblem;
+      return false;
+    } // now we've opened the oai-inf db file successfully
+  }
+
+  infodbclass oai_info;
+  ResultDocInfo_t resultdoc;
+
+  text_tarray keys = oaidb_ptr->getkeys();
+
+  text_tarray::iterator key_here = keys.begin();
+  text_tarray::iterator key_end = keys.end();
+  while (key_here != key_end) {    
+    
+    resultdoc.OID = (*key_here);
+   
+    if(!oaidb_ptr->getinfo(resultdoc.OID, oai_info)) {
+      logout << text_t2ascii
+         << "warning: lookup for node \"" << resultdoc.OID
+         << "\" in etc/oai-inf db failed for browsefilter.\n\n";
+    } else {
+      //logout << text_t2ascii << "@@@@ found node \"" << resultdoc.OID << "\" in etc/oai-inf db.\n\n";
+      
+      resultdoc.metadata["oaiinf.status"].isRef = false;
+      resultdoc.metadata["oaiinf.status"].values.push_back(oai_info["status"]);
+      resultdoc.metadata["oaiinf.timestamp"].isRef = false;
+      resultdoc.metadata["oaiinf.timestamp"].values.push_back(oai_info["timestamp"]);
+      resultdoc.metadata["oaiinf.datestamp"].isRef = false;
+      resultdoc.metadata["oaiinf.datestamp"].values.push_back(oai_info["datestamp"]);
+    }
+    
+    response.docInfo.push_back(resultdoc);
+    ++key_here;    
+    
+  }
+
+  // we're done with oai-inf db
+
+  oaidb_ptr->closedatabase(); // don't leave files open
+
+  return true;
+}