Changeset 5787

Timestamp:

2003-11-05T15:06:39+13:00 (20 years ago)

Author:

davidb

Message:

Added functionality to format statements. In addition to 'parent(...):Metadata'
syntax, now supports 'sibling(...):Metadata' which retrieve multile values
of the given metadata value at that level in the doc.

Location:

trunk/gsdl/src/recpt

Files:

• formattools.cpp (modified) (22 diffs)
• formattools.h (modified) (2 diffs)

trunk/gsdl/src/recpt/formattools.cpp

@@ -32 +32 @@
 
 // a few function prototypes
-
 static text_t format_string (const text_t& collection, recptproto* collectproto,
                  ResultDocInfo_t &docinfo, displayclass &disp, 
-                 format_t *formatlistptr, text_tmap &options,
-                 ostream& logout);
+                 format_t *formatlistptr,
+                 const text_t &link, const text_t &icon, 
+                 const text_t &text, bool highlight, ostream& logout);
 
 static bool parse_action (text_t::const_iterator &here, const text_t::const_iterator &end, 
               format_t *formatlistptr, text_tset &metadata, bool &getParents);
 
-static text_t format_summary (const text_t& collection, recptproto* collectproto,
-                  ResultDocInfo_t &docinfo, displayclass &disp, 
-                  text_tmap &options, ostream& logout);
+text_t format_summary (const text_t& collection, recptproto* collectproto,
+              ResultDocInfo_t &docinfo, displayclass &disp, 
+              const text_t &text, bool highlight,
+               ostream& logout);
 
 
@@ -50 +51 @@
   metacommand = mNone;
   parentcommand = pNone;
-  parentoptions.clear();
+  functionoptions.clear();
 }
 
@@ -76 +77 @@
   DocumentContents = true;
   DocumentArrowsBottom = true; 
-  DocumentArrowsTop = false; 
   DocumentButtons.erase (DocumentButtons.begin(), DocumentButtons.end());
   //  DocumentButtons.push_back ("Expand Text");
@@ -86 +86 @@
   formatstrings.erase (formatstrings.begin(), formatstrings.end());
   DocumentUseHTML = false;
-  AllowExtendedOptions = false;
 }
 
@@ -488 +487 @@
   else if (com == "All") {
     metaoption.parentcommand = pAll;
-    metaoption.parentoptions = op;
+    metaoption.functionoptions = op;
+  }
+}
+
+
+static void get_sibling_options (text_t &instring, metadata_t &metaoption) {
+
+  assert (instring.size() > 8);
+  if (instring.size() <= 8) return;
+
+  text_t meta, com, op;
+  bool inbraces = false;
+  bool inquotes = false;
+  bool foundcolon = false;
+  text_t::const_iterator here = instring.begin()+7;
+  text_t::const_iterator end = instring.end();
+  while (here != end) {
+    if (*here == '(') inbraces = true;
+    else if (*here == ')') inbraces = false;
+    else if (*here == '\'' && !inquotes) inquotes = true;
+    else if (*here == '\'' && inquotes) inquotes = false;
+    else if (*here == ':' && !inbraces) foundcolon = true;
+    else if (foundcolon) meta.push_back (*here);
+    else if (inquotes) op.push_back (*here);
+    else com.push_back (*here);
+    here ++;
+  }
+
+  instring = meta;
+
+  if (com.empty()) {
+    metaoption.functionoptions = " ";
+  }
+  else {
+    metaoption.functionoptions = op;
   }
 }
@@ -496 +529 @@
 
   if (meta.size() > 8 && (substr(meta.begin(), meta.begin()+8) == "cgisafe:")) {
-    metaoption.metacommand = mCgiSafe;
+    metaoption.metacommand |= mCgiSafe;
     meta = substr (meta.begin()+8, meta.end());
   }
 
   if (meta.size() > 7 && (substr (meta.begin(), meta.begin()+6) == "parent")) {
+    metaoption.metacommand |= mParent;
     getParents = true;
     get_parent_options (meta, metaoption);
+  } 
+  else if (meta.size() > 8 && (substr (meta.begin(), meta.begin()+7) == "sibling")) {
+    metaoption.metacommand |= mSibling;
+    get_sibling_options (meta, metaoption);
   } 
 
@@ -541 +579 @@
     formatlistptr->command = comSummary;
 
-  else if (meta == "DocImage")
-    formatlistptr->command = comImage; 
-
-  else if (meta == "DocTOC")
-    formatlistptr->command = comTOC; 
-
-  else if (meta == "DocumentButtonDetach")
-     formatlistptr->command = comDocumentButtonDetach;
-  
-  else if (meta == "DocumentButtonHighlight")
-     formatlistptr->command = comDocumentButtonHighlight;
-  
-  else if (meta == "DocumentButtonExpandContents")
-    formatlistptr->command = comDocumentButtonExpandContents; 
-
-  else if (meta == "DocumentButtonExpandText")
-     formatlistptr->command = comDocumentButtonExpandText; 
-  
   else {
     formatlistptr->command = comMeta;
@@ -820 +840 @@
   case pNone:
     {
-      text_t classifier_metaname = docinfo.classifier_metadata_type;
-       int metaname_index 
-    = (classifier_metaname == meta.metaname) ? docinfo.classifier_metadata_offset : 0;
-      text_t metadata_item = docinfo.metadata[meta.metaname].values[metaname_index];
-      
-      if (meta.metaname == "Date")
-    return format_date (metadata_item);
-      else if (meta.metaname == "Language")
-    return iso639(metadata_item);
-      if (meta.metacommand == mCgiSafe) 
-    return cgi_safe (metadata_item);
-      else return metadata_item;
+      if (meta.metacommand & mSibling) {
+    text_t tmp;
+    bool first = true;
+
+    MetadataInfo_t& metaname_rec = docinfo.metadata[meta.metaname];
+
+    const int start_i=0;
+    const int end_i = metaname_rec.values.size()-1;
+
+    for (int i=start_i; i<=end_i; i++) {
+      if (!first) tmp += meta.functionoptions;
+      if (meta.metaname == "Date") tmp += format_date (metaname_rec.values[i]);
+      else if (meta.metaname == "Language") tmp += iso639(metaname_rec.values[i]);
+      else tmp += metaname_rec.values[i];
+      first = false;
+    }
+
+    if (meta.metacommand & mCgiSafe) return cgi_safe (tmp);
+    else return tmp;
+
+      }
+      else {
+
+    text_t classifier_metaname = docinfo.classifier_metadata_type;
+    int metaname_index 
+      = (classifier_metaname == meta.metaname) ? docinfo.classifier_metadata_offset : 0;
+    text_t metadata_item = docinfo.metadata[meta.metaname].values[metaname_index];
+    
+    if (meta.metaname == "Date")
+      return format_date (metadata_item);
+    else if (meta.metaname == "Language")
+      return iso639(metadata_item);
+    if (meta.metacommand & mCgiSafe) 
+      return cgi_safe (metadata_item);
+    else return metadata_item;
+      }
     }
+
 
   case pImmediate:
@@ -844 +889 @@
     break;
 
+
   case pTop:
     if (parent != NULL) {
@@ -850 +896 @@
       if (meta.metaname == "Date") 
     return format_date (parent->values[0]);
-      if (meta.metacommand == mCgiSafe) 
+      if (meta.metacommand & mCgiSafe) 
     return cgi_safe (parent->values[0]);
       else return parent->values[0];
@@ -859 +905 @@
     MetadataInfo_t *parent = docinfo.metadata[meta.metaname].parent;
     if (parent != NULL) {
+
       text_tarray tmparray;
       while (parent != NULL) {
@@ -869 +916 @@
       text_tarray::reverse_iterator end = tmparray.rend();
       while (here != end) {
-    if (!first) tmp += meta.parentoptions;
+    if (!first) tmp += meta.functionoptions;
     if (meta.metaname == "Date") tmp += format_date (*here);
     else tmp += *here;
@@ -875 +922 @@
     here ++;
       }
-      if (meta.metacommand == mCgiSafe) return cgi_safe (tmp);
+      if (meta.metacommand & mCgiSafe) return cgi_safe (tmp);
       else return tmp;
     }
@@ -884 +931 @@
 static text_t get_or (const text_t& collection, recptproto* collectproto,
               ResultDocInfo_t &docinfo, displayclass &disp,
-              format_t *orptr, text_tmap &options,
+              format_t *orptr,
+              const text_t &link, const text_t &icon, 
+              const text_t &text, bool highlight,
               ostream& logout) {
 
@@ -891 +940 @@
 
     tmp = format_string (collection,collectproto, docinfo, disp, orptr, 
-             options, logout);
+             link, icon, text, highlight, logout);
     if (!tmp.empty()) return tmp;
 
@@ -902 +951 @@
               ResultDocInfo_t &docinfo, displayclass &disp, 
               const decision_t &decision,
-              format_t *ifptr, format_t *elseptr,
-              text_tmap &options, ostream& logout) 
+              format_t *ifptr, format_t *elseptr, const text_t &link, 
+              const text_t &icon, const text_t &text, bool highlight,
+              ostream& logout) 
 {
 
@@ -912 +962 @@
       if (ifptr != NULL)
     return get_formatted_string (collection,collectproto, docinfo, disp, ifptr, 
-                     options, logout);
+                     link, icon, text, highlight, logout);
     }
     else {
       if (elseptr != NULL)
     return get_formatted_string (collection,collectproto, docinfo, disp, elseptr,
-                     options, logout);
+                     link, icon, text, highlight, logout);
     }
   }
@@ -935 +985 @@
       if (ifptr != NULL)
     return get_formatted_string (collection, collectproto, docinfo, disp, ifptr, 
-                     options, logout);
+                     link, icon, text, highlight, logout);
     } else {
       if (elseptr != NULL)
     return get_formatted_string (collection, collectproto, docinfo, disp, elseptr,
-                     options, logout);
+                     link, icon, text, highlight, logout);
     }
   }
@@ -958 +1008 @@
 }
 
-static text_t expand_metadata(const text_t &metavalue, const text_t& collection,
-                  recptproto* collectproto, ResultDocInfo_t &docinfo,
-                  displayclass &disp, text_tmap &options,
-                  ostream &logout) {
-      
-   if (includes_metadata(metavalue))
-      {
-     // text has embedded metadata in it => expand it
-     FilterRequest_t request;
-     FilterResponse_t response;
-
-     request.getParents = false;
-      
-     format_t *expanded_formatlistptr = new format_t();
-     parse_formatstring (metavalue, expanded_formatlistptr, 
-                 request.fields, request.getParents);
-      
-     // retrieve metadata
-     get_info(docinfo.OID, collection, request.fields, request.getParents,
-          collectproto, response, logout);
-     
-     if (!response.docInfo.empty())
-        {
-           text_t expanded_metavalue
-          = get_formatted_string(collection, collectproto, 
-                     response.docInfo[0], disp, expanded_formatlistptr, 
-                     options, logout);
-          
-           return expanded_metavalue;
-        }
-     else
-        {
-           return metavalue;
-        }
-      }
-   else
-      {
-     return metavalue;
-      }
-}
+
 
 text_t format_string (const text_t& collection, recptproto* collectproto,
               ResultDocInfo_t &docinfo, displayclass &disp, 
-              format_t *formatlistptr, text_tmap &options,
+              format_t *formatlistptr,
+              const text_t &link, const text_t &icon,
+              const text_t &text, bool highlight,
               ostream& logout) {
 
@@ -1007 +1020 @@
 
   switch (formatlistptr->command) {
-     case comText:
-    return formatlistptr->text;
-     case comLink:
-    return options["link"];
-     case comEndLink:
-    if (options["link"].empty()) return "";
-    else return "</a>";
-     case comHref:
-    return get_href(options["link"]);
-     case comIcon:
-    return options["icon"];
-     case comNum:
-    return docinfo.result_num;
-     case comRel: //if [RelatedDocuments] appears in format string, collect relation data
-    return get_related_docs(collection, collectproto, docinfo, logout);
-     case comSummary:
-    return format_summary(collection, collectproto, docinfo, disp, options, logout);
-     case comMeta:
+  case comText:
+    return formatlistptr->text;
+  case comLink:
+    return link;
+  case comEndLink:
+    if (link.empty()) return "";
+    else return "</a>";
+  case comHref:
+    return get_href(link);
+  case comIcon:
+    return icon;
+  case comNum:
+    return docinfo.result_num;
+  case comRel: //if [RelatedDocuments] appears in format string, collect relation data
+    return get_related_docs(collection, collectproto, docinfo, logout);
+  case comSummary:
+    return format_summary(collection,collectproto,docinfo,disp,text,highlight,logout);
+  case comMeta:
+
+    {
+      const text_t& metavalue =  get_meta (docinfo, formatlistptr->meta);
+
+      if (includes_metadata(metavalue))
     {
-       const text_t& metavalue =  get_meta (docinfo, formatlistptr->meta);
-       return expand_metadata(metavalue, collection, collectproto, docinfo, disp, options, logout);
+      // text has embedded metadata in it => expand it
+      FilterRequest_t request;
+      FilterResponse_t response;
+
+      request.getParents = false;
+      
+      format_t *expanded_formatlistptr = new format_t();
+      parse_formatstring (metavalue, expanded_formatlistptr, 
+                  request.fields, request.getParents);
+      
+      // retrieve metadata
+      get_info(docinfo.OID, collection, request.fields, request.getParents,
+           collectproto, response, logout);
+      
+      if (!response.docInfo.empty())
+        {
+          text_t expanded_metavalue
+        = get_formatted_string(collection, collectproto, 
+                       response.docInfo[0], disp, expanded_formatlistptr, 
+                       link, icon, highlight, logout);
+          
+          return expanded_metavalue;
+        }
+      else
+        {
+          return metavalue;
+        }
     }
-     case comDoc:
-    return options["text"];
-     case comImage:
-    return expand_metadata(options["DocImage"], collection, collectproto, docinfo, disp, options, logout);
-     case comTOC:
-    return options["DocTOC"];
-     case comDocumentButtonDetach:
-    return options["DocumentButtonDetach"];
-     case comDocumentButtonHighlight:
-    return options["DocumentButtonHighlight"];
-     case comDocumentButtonExpandContents:
-    return options["DocumentButtonExpandContents"];
-     case comDocumentButtonExpandText:
-    return options["DocumentButtonExpandText"];
-     case comHighlight:
-    if (options["highlight"] == "1") return "<b>";
-    break;
-     case comEndHighlight:
-    if (options["highlight"] == "1") return "</b>";
-    break;
-     case comIf:
-    return get_if (collection, collectproto, docinfo, disp, 
-               formatlistptr->decision, formatlistptr->ifptr, 
-               formatlistptr->elseptr, options, logout);
-     case comOr:
-    return get_or (collection,collectproto, docinfo, disp, formatlistptr->orptr, 
-               options, logout);
+      else
+    {
+      return metavalue;
+    }
+    }
+  case comDoc:
+    return text;
+  case comHighlight:
+    if (highlight) return "<b>";
+    break;
+  case comEndHighlight:
+    if (highlight) return "</b>";
+    break;
+  case comIf:
+    return get_if (collection, collectproto, docinfo, disp, 
+           formatlistptr->decision, formatlistptr->ifptr, 
+           formatlistptr->elseptr, link, icon, text, highlight,
+           logout);
+  case comOr:
+    return get_or (collection,collectproto, docinfo, disp, formatlistptr->orptr, 
+           link, icon, text, highlight, logout);
   }
   return "";
+}
+
+
+
+
+text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
+                 ResultDocInfo_t& docinfo, displayclass &disp,
+                 format_t* formatlistptr,
+                 const text_t& link, const text_t& icon, 
+                 const text_t& text, const bool highlight,
+                 ostream& logout) {
+
+  text_t ft;
+  while (formatlistptr != NULL) 
+    {
+      ft += format_string (collection, collectproto, docinfo, disp, formatlistptr, 
+               link, icon, text, highlight, logout);
+      formatlistptr = formatlistptr->nextptr;
+    }
+
+  return ft;
 }
 
 text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
                  ResultDocInfo_t &docinfo, displayclass &disp,
-                 format_t *formatlistptr, text_tmap &options,
+                 format_t *formatlistptr,
+                 const text_t &link, const text_t &icon, 
+                 const bool highlight,
                  ostream& logout) {
 
-   text_t ft;
-   while (formatlistptr != NULL) 
-      {
-     ft += format_string (collection, collectproto, docinfo, disp, formatlistptr, 
-                  options, logout);
-     formatlistptr = formatlistptr->nextptr;
-      }
-   
-   return ft;
+  text_t text = "";
+
+  return get_formatted_string(collection, collectproto, docinfo, disp, formatlistptr,
+                              link, icon, text, highlight, logout);
+}
+
+text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
+                 ResultDocInfo_t &docinfo, displayclass &disp,
+                 format_t *formatlistptr,
+                 const text_t& text,
+                 ostream& logout) {
+
+  text_t link = "<a href=\"_httpdocument_&cl=search&d=" + docinfo.OID + "\">";
+  text_t icon = "_icontext_";
+  bool highlight = false;
+
+  return get_formatted_string(collection, collectproto, docinfo, disp, formatlistptr,
+                  link, icon, text, highlight, logout);
+}
+
+text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
+                 ResultDocInfo_t &docinfo, displayclass &disp,
+                 format_t *formatlistptr,
+                 ostream& logout) {
+
+  text_t text = "";
+
+  return get_formatted_string(collection, collectproto, docinfo, disp, formatlistptr,
+                  text, logout);
 }
 
@@ -1082 +1162 @@
 
 text_t format_summary (const text_t& collection, recptproto* collectproto,
-               ResultDocInfo_t &docinfo, displayclass &disp, 
-               text_tmap &options, ostream& logout) {
+              ResultDocInfo_t &docinfo, displayclass &disp, 
+              const text_t &text, bool highlight,
+              ostream& logout) {
 
   // GRB: added code here to ensure that the cstr (and other collections)
@@ -1095 +1176 @@
 
   text_t textToSummarise, query;
-  if(options["text"].empty()) { // get document text
-     DocumentRequest_t docrequest;
-     DocumentResponse_t docresponse;
-     comerror_t err;
-     docrequest.OID = docinfo.OID;
-     collectproto->get_document (collection, docrequest, docresponse, err, logout);
-     textToSummarise = docresponse.doc;
+  if(text.empty()) { // get document text
+      DocumentRequest_t docrequest;
+      DocumentResponse_t docresponse;
+      comerror_t err;
+      docrequest.OID = docinfo.OID;
+      collectproto->get_document (collection, docrequest, docresponse, err, logout);
+      textToSummarise = docresponse.doc;
   } else // in practice, this would not happen, because text is only 
          // loaded with the [Text] command
-     textToSummarise = options["text"];
+      textToSummarise = text;
   disp.expandstring("_cgiargq_",query);
   return summarise(textToSummarise,query,80);

trunk/gsdl/src/recpt/formattools.h

@@ -39 +39 @@
 enum pcommand_t {pNone, pImmediate, pTop, pAll};
 enum dcommand_t {dMeta, dText};
-enum mcommand_t {mNone, mCgiSafe};
+enum mcommand_t {mNone=0, mCgiSafe=1, mParent=2, mSibling=4};
 
 struct metadata_t {
@@ -46 +46 @@
 
   text_t metaname;
-  mcommand_t metacommand;
+  int metacommand; // used to hold flags from mcommand_t
   pcommand_t parentcommand;
-  text_t parentoptions;
+  text_t functionoptions;
 };