# $Id: modern.cf,v 1.2 2002/07/30 by Harald Weinreich <harald@weinreichs.de>
#
# Definitions for '{nph-}search.cgi' configuration.
#
# A hash (#) in the first column denotes a comment and is not processed
# even inside a definition.  Hashes not in the first column are left as-is.
#
# Variable substitution occurs on these definitions.  If you want
# a dollar-sign ($) to occur in the output, escape it with backslash (\).
# Other metacharacters (quotes, asterisks, etc) probably don't need to be
# escaped.  Printf-like special characters are allowed: \n \t \r etc.
#
# The ending newline is chopped off from each definiton.  So
#
#   <FooBar>
#   abcxyz
#   </FooBar>
#
# becomes "abcxyz".  You may have blank lines in between the beginning
# and ending tags, or use the newline character \n.
#

#
# CGI defaults.
#
# In this section you can give default values for any attribute that would
# normally be passed in from the CGI query form.  The following attributes
# are currently available:
#
# brokerqueryconfig : Name of a broker specific configuration file
# lifetime          : Maximum lifetime of a query (see also <Lifetime> section)
# caseflag          : Whether the query is casesensitive ["on" or "off"]
# wordflag          : Match on word boundaries ["on" or "off"]
# opaqueflag        : Show matched lines ["on" or "off"]
# descflag          : Return object description ["on" or "off"]
# noregexflag       : Don't do regular expressions ["on" or "off"]
# maxresultflag     : Maximum number of results to return
# maxobjflag        : Maximum number of objects to return
# maxlineflag       : Maximum number of matched lines
# weightflag        : show weight of hit
# csumflag          : show link to indexing data
# errorflag         : Number of spelling errors (therefore it's not really a flag!)
# broker            : Name of broker
# host              : Name of broker host
# attribute         : Space sperated list of attributes to return
# sort              : Sort options ["by-rank"]
# hp_url            : Url of search page

# These defaults mimic the values on the provided query-glimpse-modern.html form.
<Default>
caseflag      : on
wordflag      : on
opaqueflag    : on
descflag      : on
noregexflag   : off
weightflag    : off
csumflag      : off
errorflag     : 0
maxobjflag    : 500
maxlineflag   : 30
maxresultflag : 3000
perpageflag   : 10
sort          : by-rank
charset       : ISO-8859-1
attribute     : headings type file-size
#attribute     : headings type file-size last-modification-time
</Default>

# 'GLOBAL' VARIABLES: are defined globally within the {nph-}search.cgi program,
#                     but not necessarily set at all times.
#
# $query	the user query string
# $html_query	the user query string, special HTML characters escaped
# $bquery	the query string sent to the broker
# $host		the broker hostname
# $port		the broker port
# $hp_url	the URL of the broker query (home) page
# $maxresult	the maximum number of matched lines the broker will return
# $nobjects	a running count of the number of objects returned
# $nopaquelines a running count of the number of opaque (matched) lines
# $filterhint   a (HTML)-Text with a verbal description of the current broker filter
#
# definitions here can be output in other definitions.  Each definition
# here is placed into the %CFG associative array.  For example,
# to print out the Timeout defined below, write $CFG{'Timeout'}.
#

# The URL to the Harvest Project home page.
#
<HarvestUrl>
http://harvest.sourceforge.net/
</HarvestUrl>

# The amount of time to wait for the broker results.
# Can use aritmetic # here also, eg: 5*60
#
# We use a conservative 5 minutes here.
#
<Timeout>
300
</Timeout>

# InitFunction can be some perl code which gets eval'd before they
# query is sent.  Use this for any special hackings.
#
<InitFunction>
$cs_urlX = $csumflag ? 'Y' : undef;
</InitFunction>

# The MIME content type of the query results.  Should be "text/html"
# if we are going to return HTML tags.
#
<ContentType>
text/html
</ContentType>


##############################################################################
# RESULT SECTION
#
# The output of '{nph-}search.cgi' consists of the following tags:
#
#    ResultHeader
#    CreateNavBars
#    ResultSetBegin
#    ( Errors from 'broker' )
#    foreach object {
#        PrintObject
#    }
#    ResultSetEnd
#    EndBrokerResults
#    ( TruncateWarning )
#    ResultTrailer
#
#
##############################################################################

# First output for the HTML containing the results.  Should probably include
# <TITLE> tag and the user query.
#
<ResultHeader>
<HEAD>
<TITLE>Zoekresultaten voor: $html_query</TITLE>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<style><!--
dt { margin-left:1px; }
dd { margin-left:40px; }
// --></style>
</HEAD>
<BODY bgcolor=white>
<H2>Zoekresultaten voor: <font color="#800000">$html_query</font></H2>
$filterhint
</ResultHeader>

# Final HTML section for the output.  Should probably contain a pointer
# to the broker home-page ($hp_url) and a pointer to the Harvest
# home page.
#
<ResultTrailer>
</BODY>
</HTML>

</ResultTrailer>

# Calculations to obtain $navigationBar
# Original code by Javier Masa Marin <masa@rediris.es>
#
<CreateNavBars>
if ($totalPages > 0)
{
  # elements before and after current page in navigation bar
  local($navPart) = 5;

  $prevPage = "";
  $prevPage = "\n\n<a href=\"".&create_link($page-1)."\">&lt;= Prev</a> &middot;" if ($page > 1);

  $nextPage = "";
  $nextPage = "&middot; <a class=\"navBar\" href=\"".&create_link($page+1)."\">Next =&gt;</a>" if ($page < $totalPages);

  $pageList = "";

  local($startP) = ($page <= $navPart) ? 1 : $page - $navPart;
  for ($i = $startP; $i < $page; $i++)
  { $pageList .= "<a href=\"".&create_link($i)."\">$i</a>\n"; }

  $pageList .= "<b><font color=\"#800000\" size=+1>$page</font></b>\n";

  local($endP) = ($page + $navPart >= $totalPages) ? $totalPages : $page + $navPart;
  for ($i = $page+1; $i <= $endP; $i++)
  { $pageList .= "\n<a href=\"".&create_link($i)."\">$i</a>\n"; }

  $navigationBar = "\n$prevPage\n $pageList\n $nextPage" if ($totalPages > 1);
}
</CreateNavBars>

# Output just before beginning the loop over objects returned by the broker.
#
<ResultSetBegin>
<form method="GET" action="/Harvest/cgi-bin/search.cgi">\n
<table border="0" cellspacing=0 cellpadding=4 width="100%">
<tr bgcolor="#E0E0E0">
  <td align=left width="20%" nowrap>
    $totnumber objecten gevonden
  </td>
  <td align=center width="60%">
    $navigationBar
  </td>
  <td align=right width="20%">
    Pagina: $page/$totalPages
  </td>
</tr>
<tr>
<td align=middle colspan=3>
 <input type=hidden name=broker value="$broker">
 <input type=hidden name=hp_url value="$hp_url">
 <input type=hidden name=caseflag value="$RQ{'caseflag'}">
 <input type=hidden name=wordflag value="$RQ{'wordflag'}">
# <input type=hidden name=opaqueflag value="$RQ{'opaqueflag'}">
# <input type=hidden name=descflag value="$RQ{'descflag'}">
# <input type=hidden name=maxresultflag value="$RQ{'maxresultflag'}">
# <input type=hidden name=maxobjflag value="$RQ{'maxobjflag'}">
# <input type=hidden name=maxlineflag value="$RQ{'maxlineflag'}">
 <input type=hidden name=weightflag value="$RQ{'weightflag'}">
 <input type=hidden name=attribute value="@atts">
<a href="$hp_url">Nieuwe zoekopdracht:</a> <input type=text name=query value='$RQ{'query'}'> <input type=submit>
</td></tr>
</form>
</table>

<DL>\n
</ResultSetBegin>

# output just after ending the loop over objects returned by the broker
#
<ResultSetEnd>
</DL>
<form method="GET" action="/Harvest/cgi-bin/search.cgi">
<table border="0" width="100%" bgcolor="#E0E0E0">
<tr>
 <td align="left" width="20%" nowrap>
  <input type=hidden name=broker value="$broker">
  <input type=hidden name=hp_url value="$hp_url">
  <input type=hidden name=caseflag value="$RQ{'caseflag'}">
  <input type=hidden name=wordflag value="$RQ{'wordflag'}">
#  <input type=hidden name=opaqueflag value="$RQ{'opaqueflag'}">
#  <input type=hidden name=descflag value="$RQ{'descflag'}">
#  <input type=hidden name=maxresultflag value="$RQ{'maxresultflag'}">
#  <input type=hidden name=maxobjflag value="$RQ{'maxobjflag'}">
#  <input type=hidden name=maxlineflag value="$RQ{'maxlineflag'}">
  <input type=hidden name=weightflag value="$RQ{'weightflag'}">
  <input type=hidden name=attribute value="@atts">
  <a href="$hp_url">Zoekopdracht:</a> <input type=text name=query size=15 value='$RQ{'query'}'> <input type=submit value="Go">
 </td>
 <td align="center" width="60%">
  $navigationBar
 </td>
  <td align="right" width="20%"><a href="$CFG{'HarvestUrl'}"><img alt="Powered by Harvest" border="0" src="$harvestIcon"></a></td>
</table>
</form>

</ResultSetEnd>

# EndBrokerResults is printed when the broker results end normally.
#
<EndBrokerResults>
#\n<STRONG>$msg</STRONG><BR>\n
</EndBrokerResults>

# FailBrokerResults is printed when the broker results end in error
#
<FailBrokerResults>
\n<STRONG>$msg</STRONG><BR>\n
</FailBrokerResults>


# PER-OBJECT DEFINITIONS
# ======================
#
# VARIABLES:
#
#    $url         Object url: http://www.cia.gov:3333/Spies/KGB/secret.html
#    $A           URL Access: http
#    $H           URL Host  : www.cia.gov:3333
#    $P           URL Path  : /Spies/KGB/secret.html
#    $D           URL Dir   : /Spies/KGB/
#    $F           URL File  : secret.html
#    $cs_url      URL to the SOIF object in the broker databse
#    $cs_[ahp]    elements of $cs_url as above with $url
#    $desc        Description attribute of the matched object
#    $opaque      A matched line (or all matched lines in obj-at-a-time mode)
#    $usermsg     A user message
#    $attributes  Requested attributes
#    $objectType  Type of object if not HTML
#    $objectSize  Size of object
#    $objectDate  Last modification date of object
#
<PrintObject>
<DT>$objectnum <A HREF="$url">$description</A>
&nbsp;&nbsp;<FONT size=-1 color=#606060>$objectType</FONT>
&nbsp;&nbsp;<FONT size=-1 color=#606060>$objectSize</FONT>
&nbsp;$objectWeight
<DD>$attributes
<DD>$opaque
<?$cs_urlX>
<DD>
<B>Geindexeerde data:</B>
<A HREF="$cs_a://$cs_h/Harvest/cgi-bin/displaySOIF.cgi?object=$cs_p&query=$html_query">geformatteerd</A>
&middot;
<A HREF="$cs_a://$cs_h/Harvest/cgi-bin/displaySOIF.cgi?object=$cs_p&style=plain">tekst</A>
</?$cs_urlX>
<DD><FONT size=-1 color=#006000>$url</font>
&nbsp;<FONT size=-1 color=#606060>$objectUpdate</FONT>
<BR>
<BR>
</PrintObject>

# This definition is eval'd for each opaque (i.e. matched) line retruned by
# the broker.  It is intended to be used to remove SOIF attributes
# and the 'Matched line' string from the output.
# The results of these operations are stored in $opaque.
#
<MatchedLineSub>
#1. Completely remove lines with @FILE
s/^(.*)\@FILE(.*)$/ /;
#2. Remove "Matched line #"
s/^(.*)\# (.*)$/$2/;
#3. Remove "{12}:" etc.
s/^(.*)\}:(.*)$/$2/;
#4. Remove leading and trailing whitespaces
s/^\s+//;
s/\s+$//;
#5. Limit length to 10 words per matched line.
s/^(((\s*)(\S*)){10}).*$/$1/;
#6. show 4 matched lines, set maximum length and avoid double matched lines.
if ($opaquePerObjectCount>4 || length($_)>120 || $lastOpaqueObject eq $_ ) {
   $_ = "";                     #no output
} else {
   $lastOpaqueObject=$_;
   $opaquePerObjectCount++;
   s/(.*)/... $1/;              #OK, add dots.
}
#highlight search words.
for ($i=0; $i<=$#searchwords; $i++) {
   s/(\b$searchwords[$i]\b)/<font color=#800000>$1<\/font>/ig;
}
</MatchedLineSub>

# PerObjectFunction is eval'd before every object is printed out.
#
<PerObjectFunction>
# init output variables
$objectType="";
$objectSize="";
$objectUpdate="";
$objectWeight = "";

$opaquePerObjectCount = 1;
$lastOpaqueObject     = "";

# create description
$description = "<I>Bestand:</I>&nbsp;&nbsp;$F";
$description = $desc if (length($desc) > 5);

# highlight search words.
for ($i=0; $i<=$#searchwords; $i++) {
   s/(\b$searchwords[$i]\b)/<b>$1<\/b>/ig;
}

# Create the HTML code to print the weight balls
if ($maxWeight > 0 && $weightflag)
{
  $nWeight = int($weight * 5 / $maxWeight);
  for ($idxWeight = 1; $idxWeight <= $nWeight; $idxWeight++)
       { $objectWeight .= "<img alt=\"*\" src=\"$weightIcon\">"; }
#  $objectWeight = "<font size=-1 color=#606060>".int($weight * 100 / $maxWeight)."%</font>";
}
# format matched lines
if ($opaque ne '') {
   $opaque = "<strong>gevonden:</strong> $opaque..."
}
</PerObjectFunction>

# PerAttributeFunction is eval'd before the Attributes are printed out.
#
<PerAttributeFunction>
# Remove all empty lines
$val =~ s/^(\s*)//mg;

# Now prepare the object's type and size to display at the description.
if ($att eq "type") {                           ## show file type
   $objectType = "[".$val."]" if !($val =~ /HTML|HTTP-Query/);
   $att="";                                     # avoid <FormatAttribute>
} elsif ($att eq "file-size") {                 ## calculate file size
   $val = int($val/1024);
   $objectSize = $val." KByte" if ($val > 150); # more than 150 KByte
   $val = int($val/10.24);
   $objectSize = ($val/100)." MByte" if ($val > 100); # more than one meg
   $att="";
} elsif ($att eq "last-modification-time") {    ## calculate last modification date
   local(@date,@months,$month,$minute,$year);
   @date = localtime($val);
   @months = ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');
   $month = $months[$date[4]];
   $minute = $date[1];
   $minute = "0$minute" if $minute < 10;
   $year = $date[5]+1900;
   $objectUpdate = "$date[3]-$month-$year"; # $date[2]:$minute";
   $att="";
} else {                                        ## other attributes
   # insert commas to separate headings
   $val =~ s/\n(.)/, $1/mg;
   # If more than 120 Characters, display only the first 120 plus "..."
   $val =~ s/^((.|\n){120})(.|\n)*/$1.../;
   #highlight search words.
   for ($i=0; $i<=$#searchwords; $i++) {
      $val =~ s/(\b$searchwords[$i]\b)/<font color=#800000>$1<\/font>/ig;
   }
}
</PerAttributeFunction>

# Format Requested Attributes.  Before this is eval'd, $att and $val
# should be set.
#
<FormatAttribute>
<STRONG>$att:</STRONG> $val<BR>
</FormatAttribute>


# ======================================================================
# ERROR, STATUS and WARNING functions
# ======================================================================

# The message printed to the browser and logged to the HTTP server log
# when the processes is killed.  If the Timeout time is reached, the
# process dies from SIGALRM.  The short name of the offending signal
# is placed in $sig.
#
<sigdie>
Killed by SIG$sig...\n
</sigdie>

# How to format the object number.  Use a printf format specification
# to left/right justify, or whatever.  Do not include quotes around
# the format string.
#
<ObjectNumPrintf>
%2d.
</ObjectNumPrintf>

# A warning message printed only when the broker might have truncated
# the result set.  Only printed if the number of matched lines equals
# the 'maxresultflag' or the number of returned objects equals the
# 'maxobjflag' value of the query.html form.
#
<TruncateWarning>
<P><STRONG>WAARSCHUWING: De zoekresultaten zijn ingekort bij $nopaquelines
gevonden regels en er zijn $nreturned objecten gevonden.</STRONG><P>\n
</TruncateWarning>

# A warning message printed only when the broker returned 0 results.
#
<EmptySetWarning>
<H2>Uw zoekopdracht <font color="#800000">$html_query</font> heeft geen overeenkomstige documenten opgeleverd.</H2>
#<P>Your query either <em>did not match</em> any information in this Broker, or you <em>may</em> have specified a query that is not supported by this Broker's search subsystem.
<P>
Suggesties:
<UL>
<LI>Controleer de spelling van alle woorden
<LI>Probeer andere, minder of meer algemene sleutelwoorden
<LI>Selecteer de "Naar deel van woord zoeken" op de zoekpagina om binnen woorden te zoeken.
<LI>Sta "spelfouten" toe op de zoekpagina.
</UL>
Bekijkt U alstublieft de
<A HREF="/Harvest/brokers/queryhelp.html">helppagina over het formuleren van zoekopdrachten</A>
voor meer informatie.<P>\n
</EmptySetWarning>

# Error Message returned if there is no query string sent.
#
<NoQuery>
<H2>Geen zoekopdracht ingevuld.</H2>
Vul a.u.b. een of meerdere sleutelwoorden in.<BR><BR>\n
</NoQuery>

# Message returned if the broker sends back a
#      111 - Broker is too heavily loaded
# reply.
#
<BrokerLoad>
</pre><P>
Onze excuses, de zoekmachine op <STRONG>$host, poort $port</STRONG> is op het moment
te druk om uw zoekopdracht te verwerken.<P>
Probeert u het later nog eens.<P>
</BrokerLoad>

# Error message if broker is not available.
#
<BrokerDown>
<H2>Zoekmachine tijdelijk niet beschikbaar</H2>
Onze excuses, de zoekmachine op <STRONG>$host, poort $port</STRONG> is niet beschikbaar.<P>
Probeert u het later nog eens.<P>\n
</BrokerDown>

# Message returned if the broker sends back a
#      111 - PARSE ERROR
# reply.
#
<ParseError>
</pre>
<H2>Uw zoekopdracht <font color="#800000">$html_query</font> bevat geen geldige syntax.</H2>
<P>Bekijkt U alstublieft de
<A HREF="/Harvest/brokers/queryhelp.html">helppagina over het formuleren van zoekopdrachten</A>
voor meer informatie over goede syntax.
<P>
Veel gemaakte fouten in de syntax zijn onder andere:
<UL>
<LI>
<STRONG>Het niet gebruiken van aanhalingstekens bij zinnen of reguliere expressies.</STRONG>.<BR>
Bijvoorbeeld, de <em>zin</em>:
<CODE>resource discovery</CODE> zou 
<CODE>"resource discovery"</CODE> moeten zijn.
De <em>reguliere expressie</em>:
<CODE>res.* disc.*</CODE> zou
<CODE>"res.* disc.*"</CODE> moeten zijn.
Een <em>enkele punt</em> (``<CODE>.</CODE>'')
in een sleutelwoord moet ook omgeven zijn in aanhalingstekens. (b.v. <CODE>"3.0"</CODE>).
<LI>
<STRONG>Missende punctuatie</STRONG>.<BR>
Gestructureerde zoekopdrachten vereisen een dubbelen punt en optioneel haakjes.  Bijvoorbeeld,
<CODE>Type:PostScript</CODE> of, <CODE>(Type : PostScript)</CODE>
</UL>\n
</ParseError>