Changeset 4774

Timestamp:

2003-06-24T12:28:40+12:00 (21 years ago)

Author:

sjboddie

Message:

No longer show search page (or search form on "about" page) if a collection
doesn't have at least one searchable index. Note that this change includes
the addition of an is_searchable() function to the protocol.

Location:

trunk/gsdl

Files:

• macros/about.dm (modified) (2 diffs)
• src/colservr/collectserver.cpp (modified) (1 diff)
• src/colservr/collectserver.h (modified) (1 diff)
• src/colservr/mggdbmsource.cpp (modified) (1 diff)
• src/colservr/mggdbmsource.h (modified) (1 diff)
• src/colservr/source.cpp (modified) (1 diff)
• src/colservr/source.h (modified) (1 diff)
• src/recpt/documentaction.cpp (modified) (7 diffs)
• src/recpt/documentaction.h (modified) (1 diff)
• src/recpt/nullproto.cpp (modified) (1 diff)
• src/recpt/nullproto.h (modified) (1 diff)
• src/recpt/pageaction.cpp (modified) (3 diffs)
• src/recpt/recptproto.cpp (modified) (1 diff)
• src/recpt/recptproto.h (modified) (1 diff)

trunk/gsdl/macros/about.dm

@@ -24 +24 @@
 
 _If_("_cgiargct_" eq "0",
-     _If_("_cgiargu_" ne "1",_query:queryform_<p>_iconblankbar_),
+     _If_("_cgiargu_" ne "1",_aboutqueryform_),
      <!-- no query form for mgpp - doesn\'t work from p=about -->
     )
@@ -31 +31 @@
 <h3>_help:textsimplehelpheading_</h3>
 _help:simplehelp_
+}
+
+# _aboutqueryform_ is reset to "" in the server if the collection isn't
+# searchable
+_aboutqueryform_ {
+_query:queryform_
+<p>_iconblankbar_</p>
 }
 

trunk/gsdl/src/colservr/collectserver.cpp

@@ -310 +310 @@
 }
 
+void collectserver::is_searchable (bool &issearchable, comerror_t &err,
+                   ostream &logout) {
+
+  sourcelistclass::iterator source_here = sources.begin();
+  sourcelistclass::iterator source_end = sources.end();
+  while (source_here != source_end) {
+    assert ((*source_here).s != NULL);
+    if (((*source_here).s != NULL) &&
+    ((*source_here).s->is_searchable (issearchable, err, logout))) {
+      if (err != noError) return;
+      break;
+    }
+    source_here++;
+  }
+}
+
 
 bool operator==(const collectserverptr &x, const collectserverptr &y) {

trunk/gsdl/src/colservr/collectserver.h

@@ -127 +127 @@
                  comerror_t &err, ostream &logout);
 
+  virtual void is_searchable (bool &issearchable, comerror_t &err,
+                  ostream &logout);
+
 };
 

trunk/gsdl/src/colservr/mggdbmsource.cpp

@@ -353 +353 @@
   return true;
 }
+
+bool mggdbmsourceclass::is_searchable(bool &issearchable, comerror_t &err, ostream &logout) {
+  err = noError;
+  issearchable = false;
+
+  text_tarray fromarray;
+  indexmap.getfromarray(fromarray);
+  if (fromarray.size() == 0) {
+    return true;
+  } else if (fromarray.size() == 1) {
+    if (fromarray[0] == "dummy:text") {
+      // always return true - issearchable is false here though
+      return true;
+    }
+  }
+  issearchable = true;
+  return true;
+}

trunk/gsdl/src/colservr/mggdbmsource.h

@@ -82 +82 @@
   bool get_document (const text_t &OID, text_t &doc, 
              comerror_t &err, ostream &logout);
+  bool is_searchable(bool &issearchable, comerror_t &err, ostream &logout);
 };
 

trunk/gsdl/src/colservr/source.cpp

@@ -77 +77 @@
 }
 
+bool sourceclass::is_searchable(bool &issearchable, comerror_t &err, ostream &logout) {
+
+  // currently defaults to claiming the collection is searchable!!
+  issearchable = true;
+
+  err = noError;
+  
+  return false;
+}
 
 bool operator==(const sourceptr &x, const sourceptr &y) {

trunk/gsdl/src/colservr/source.h

@@ -58 +58 @@
   virtual bool get_document (const text_t &OID, text_t &doc, 
                  comerror_t &err, ostream &logout);
+
+  virtual bool is_searchable(bool &issearchable, comerror_t &err, ostream &logout);
 };
 

trunk/gsdl/src/recpt/documentaction.cpp

@@ -246 +246 @@
 // set_widthtspace calculates how wide the spaces in the nav bar should
 // be and sets the appropriate macro
-void documentaction::set_spacemacro (displayclass &disp, FilterResponse_t &response) {
+void documentaction::set_spacemacro (displayclass &disp, FilterResponse_t &response,
+                     bool has_search_button) {
 
   text_t width;
@@ -258 +259 @@
   twidth = width.getint();
       
-  disp.expandstring ("query", "_searchwidth_", width);
-  iwidth += width.getint();
-  
-  
+  if (has_search_button) {
+    disp.expandstring ("query", "_searchwidth_", width);
+    iwidth += width.getint();
+  } else {
+    numc -= 1;
+  }
   
   while (dochere != docend) {
@@ -283 +286 @@
 // reponse contains 1 metadata field (Title)
 void documentaction::set_navbarmacros (displayclass &disp, FilterResponse_t &response, 
-                       cgiargsclass &args) {
+                       bool has_search_button, cgiargsclass &args) {
 
   text_t topparent;
@@ -295 +298 @@
 
   navigationbar += "<nobr>\n";
-  if (args["a"] == "q") {
-    navigationbar += "_icontabsearchgreen_";
-  } else {
-    navigationbar += "_imagesearch_";
-  }
-  
-  
-  if (numc == 0) navigationbar += "_imagespacer_";
-    
+  if (has_search_button) {
+    if (args["a"] == "q") {
+      navigationbar += "_icontabsearchgreen_";
+    } else {
+      navigationbar += "_imagesearch_";
+    }
+  }
+  
+  if (has_search_button || numc == 0) navigationbar += "_imagespacer_";
+  
+  bool first = true;
   while (dochere != docend) {
+
+    if (!first) navigationbar += "_imagespacer_";
+
     text_t title = (*dochere).metadata["Title"].values[0];
 
@@ -318 +326 @@
     // if we're inside a document all the classification buttons should be enabled
     if (arg_d.empty() && ((*dochere).OID == topparent)) {
-      if (unknown) navigationbar += "_imagespacer_&nbsp;" + title + "&nbsp;";
-      else navigationbar += "_imagespacer__icontab" + title + "green_";
+      if (unknown) navigationbar += "&nbsp;" + title + "&nbsp;";
+      else navigationbar += "_icontab" + title + "green_";
     } else {
 
       // set the _httpbrowseXXX_ macro for this classification
-      if (unknown) navigationbar += "_imagespacer_&nbsp;<a href=\"_httpdocument_&cl=" + 
+      if (unknown) navigationbar += "&nbsp;<a href=\"_httpdocument_&cl=" + 
              (*dochere).OID + "\">" + title + "</a>&nbsp;";
       else {
-        navigationbar += "_imagespacer__image" + title + "_";
+        navigationbar += "_image" + title + "_";
         disp.setmacro ("httpbrowse" + title, "Global", "_httpdocument_&cl=" + (*dochere).OID);
       }
     }
     dochere ++;
+    first = false;
   }
   navigationbar += "\n</nobr>\n";
@@ -431 +440 @@
     get_children ("", collection, metadata, getParents, collectproto, response, logout);
     
+    bool has_search_button = true;
+    collectproto->is_searchable(collection, has_search_button, err, logout);
+    if (err != noError) has_search_button = true;
+
     // calculate width of spacers and set _widthtspace_ macro
-    if (args.getintarg("v") == 0) set_spacemacro (disp, response);
+    if (args.getintarg("v") == 0) set_spacemacro (disp, response, has_search_button);
 
     // set _navigationbar_ macro
-    set_navbarmacros (disp, response, args);
+    set_navbarmacros (disp, response, has_search_button, args);
    
       }
@@ -443 +456 @@
          << get_comerror_string (err);
     }
-  
-  
   }
   text_tmap::iterator usability = cinfo.format.find("Usability");

trunk/gsdl/src/recpt/documentaction.h

@@ -44 +44 @@
   void load_formatinfo (const text_tmap &colformat, int gt);
 
-  void set_spacemacro (displayclass &disp, FilterResponse_t &response);
+  void set_spacemacro (displayclass &disp, FilterResponse_t &response,
+               bool has_search_button);
 
   void set_navbarmacros (displayclass &disp, FilterResponse_t &response, 
-             cgiargsclass &args);
+             bool has_search_button, cgiargsclass &args);
 
   virtual void output_text (ResultDocInfo_t &docinfo, format_t *formatlistptr,

trunk/gsdl/src/recpt/nullproto.cpp

@@ -154 +154 @@
   else err = protocolError;
 }
+
+void nullproto::is_searchable (const text_t &collection, bool &issearchable, 
+                   comerror_t &err, ostream &logout) {
+  issearchable = false;
+  collectserver *cserver = cset->getCollectServer (collection);
+  if (cserver != NULL) cserver->is_searchable (issearchable, err, logout);
+  else err = protocolError;
+}

trunk/gsdl/src/recpt/nullproto.h

@@ -90 +90 @@
              comerror_t &err, ostream &logout);
 
+  void is_searchable (const text_t &collection, bool &issearchable, 
+              comerror_t &err, ostream &logout);
+
+
 };
 

trunk/gsdl/src/recpt/pageaction.cpp

@@ -526 +526 @@
   //                       was pressed
 
+  // _aboutqueryform_      will be set to "" if the collection isn't searchable
 
   // if page is "help"
@@ -604 +605 @@
     disp.setmacro("usabilityscript", "Global", "_usabshowscript_");
       }
-      
     }
   }
@@ -740 +740 @@
     }
     textsubcollections += "_textsubcols2_";
-    if (count > 1) 
+    if (count > 1) {
       disp.setmacro ("textsubcollections", "about", textsubcollections);
+    }
+      }
+
+      comerror_t err;
+      bool issearchable = true;
+      collectproto->is_searchable(args["c"], issearchable, err, logout);
+      if (err != noError) issearchable = true;
+      outconvertclass t;
+      if (!issearchable) {
+    disp.setmacro ("aboutqueryform", "about", "");
       }
     }

trunk/gsdl/src/recpt/recptproto.cpp

@@ -126 +126 @@
 }
 
+// sets issearchable to true if the given colection is searchable
+void recptproto::is_searchable (const text_t &/*collection*/, bool &issearchable, 
+                comerror_t &err, ostream &/*logout*/) {
+  issearchable = false; // no collections are supported by this class
+  err = noError;
+}
+
 
 

trunk/gsdl/src/recpt/recptproto.h

@@ -126 +126 @@
                  DocumentResponse_t &response,
                  comerror_t &err, ostream &logout);
+
+  virtual void is_searchable (const text_t &collection, bool &issearchable, 
+                  comerror_t &err, ostream &logout);
+
 };