File:  [LON-CAPA] / loncom / interface / lonsearchcat.pm
Revision 1.77: download - view: text, annotated - select for diffs
Mon Mar 26 21:24:12 2001 UTC (23 years, 2 months ago) by harris41
Branches: MAIN
CVS tags: HEAD
beginning to implement showing of custom metadata fields..
just a little more parsing.. -Scott

    1: # The LearningOnline Network
    2: # Search Catalog
    3: #
    4: # 03/08/2001 Scott Harrison
    5: # Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001
    6: # Scott Harrison: 03/20/2001
    7: #
    8: # Functions
    9: #
   10: # handler(server reference) : interacts with the Apache server layer
   11: #                             (for /adm/searchcat URLs)
   12: # simpletextfield(name,value) : returns HTML formatted string for simple text
   13: #                               field
   14: # simplecheckbox(name,value) : returns HTML formatted string for simple
   15: #                              checkbox
   16: # searchphrasefield(title,name,value) : returns HTML formatted string for
   17: #                                       a search expression phrase field
   18: # dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
   19: #                                                          formatted string
   20: #                                                          for a calendar date
   21: # selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
   22: #                                             a selection box field
   23: # advancedsearch(server reference, environment reference) : perform a complex
   24: #                                  multi-field logical query
   25: # filled(field) : determines whether a given field has been filled
   26: # basicsearch(server reference, environment reference) : perform a simple
   27: #                               single-field logical query
   28: # output_blank_field_error(server reference) : outputs a message saying that
   29: #                                              more fields need to be filled in
   30: # output_results(output mode,
   31: #                server reference, 
   32: #                environment reference,
   33: #                reply list reference) : outputs results from search
   34: # build_SQL_query(field name, logic) : builds a SQL query string from a
   35: #                                      logical expression with AND/OR keywords
   36: # recursive_SQL_query_build(field name, reverse notation expression) : 
   37: #                 builds a SQL query string from a reverse notation expression
   38: #                 logical expression with AND/OR keywords
   39: 
   40: package Apache::lonsearchcat;
   41: 
   42: use strict;
   43: use Apache::Constants qw(:common);
   44: use Apache::lonnet();
   45: use Apache::File();
   46: use CGI qw(:standard);
   47: use Text::Query;
   48: 
   49: my %language;
   50: my $scrout;
   51: my %metadatafields;
   52: my %cprtag;
   53: my %mimetag;
   54: my $closebutton;
   55: my $basicviewselect=<<END;
   56: <select name='basicviewselect'>
   57: <option value='Detailed Citation View'>Detailed Citation View</option>
   58: <option value='Summary View'>Summary View</option>
   59: <option value='Fielded Format'>Fielded Format</option>
   60: <option value='XML/SGML'>XML/SGML</option>
   61: </select>
   62: END
   63: my $advancedviewselect=<<END;
   64: <select name='advancedviewselect'>
   65: <option value='Detailed Citation View'>Detailed Citation View</option>
   66: <option value='Summary View'>Summary View</option>
   67: <option value='Fielded Format'>Fielded Format</option>
   68: <option value='XML/SGML'>XML/SGML</option>
   69: </select>
   70: END
   71: 
   72: sub handler {
   73:     my $r = shift;
   74: 
   75: # -------------------------------------- see if called from an interactive mode
   76:     map {
   77:        my ($name, $value) = split(/=/,$_);
   78:        $value =~ tr/+/ /;
   79:        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
   80:        if ($name eq 'catalogmode') {
   81: 	   $ENV{'form.'.$name}=$value;
   82:        }
   83:     } (split(/&/,$ENV{'QUERY_STRING'}));
   84: 
   85:     $r->content_type('text/html');
   86:     $r->send_http_header;
   87:     return OK if $r->header_only;
   88: 
   89:     %metadatafields=();
   90: 
   91:     my $hidden='';
   92:     $hidden=<<END if $ENV{'form.catalogmode'} eq 'interactive';
   93: <input type='hidden' name='catalogmode' value='interactive'>
   94: END
   95: 
   96:     $closebutton=<<END if $ENV{'form.catalogmode'} eq 'interactive';
   97: <input type="button" name="close" value='CLOSE' onClick="self.close()">
   98: END
   99: 
  100: # ------------------------------------------------ First, check out environment
  101:     $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
  102: 
  103: # --------------------------------- Compute various listings of metadata values
  104:     
  105:     %language=();
  106:     $language{'any'}='Any language';
  107:     {
  108: 	my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');
  109: 	map {
  110: 	    $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
  111: 	    $language{$1}=$2;
  112: 	} <$fh>;
  113:     }
  114: 
  115:     %cprtag=();
  116:     $cprtag{'any'}='Any copyright/distribution';
  117:     {
  118: 	my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');
  119: 	map {
  120: 	    $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
  121: 	    $cprtag{$1}=$2;
  122: 	} <$fh>;
  123:     }
  124: 
  125:     %mimetag=();
  126:     $mimetag{'any'}='Any type';
  127:     {
  128: 	my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');
  129: 	map {
  130: 	    $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;
  131: 	    $mimetag{$1}=".$1 $3";
  132: 	} <$fh>;
  133:     }
  134: 
  135:     if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
  136: 	return &basicsearch($r,\%ENV);
  137:     }
  138:     elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
  139: 	return &advancedsearch($r,\%ENV);
  140:     }
  141: 
  142:     $scrout=''; # building a part of screen output
  143:     $scrout.=&searchphrasefield('Limit by title','title',
  144: 			$ENV{'form.title'});
  145: 
  146:     $scrout.=&searchphrasefield('Limit by author','author',
  147: 			$ENV{'form.author'});
  148: 
  149:     $scrout.=&searchphrasefield('Limit by subject','subject',
  150: 			$ENV{'form.subject'});
  151: 
  152:     $scrout.=&searchphrasefield('Limit by keywords','keywords',
  153: 			$ENV{'form.keywords'});
  154: 
  155:     $scrout.=&searchphrasefield('Limit by URL','url',
  156: 			$ENV{'form.url'});
  157: 
  158:     $scrout.=&searchphrasefield('Limit by version','version',
  159: 			$ENV{'form.version'});
  160: 
  161:     $scrout.=&searchphrasefield('Limit by notes','notes',
  162: 			$ENV{'form.notes'});
  163: 
  164:     $scrout.=&searchphrasefield('Limit by abstract','abstract',
  165: 			$ENV{'form.abstract'});
  166: 
  167:     $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});
  168:     $scrout.=&selectbox('Limit by MIME type','mime',
  169: 			$ENV{'form.mime'},%mimetag);
  170: 
  171:     $ENV{'form.language'}='any' unless length($ENV{'form.language'});
  172: 
  173:     $scrout.=&selectbox('Limit by language','language',
  174: 			$ENV{'form.language'},%language);
  175:     
  176: 
  177: # ------------------------------------------------ Compute date selection boxes
  178:     $scrout.=<<CREATIONDATESTART;
  179: <p>
  180: <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>
  181: </font>
  182: <br>
  183: between:
  184: CREATIONDATESTART
  185:     $scrout.=&dateboxes('creationdatestart',1,1,1976,
  186: 			$ENV{'form.creationdatestart_month'},
  187: 			$ENV{'form.creationdatestart_day'},
  188: 			$ENV{'form.creationdatestart_year'},
  189: 			);
  190:     $scrout.=<<CREATIONDATEEND;
  191: and:
  192: CREATIONDATEEND
  193:     $scrout.=&dateboxes('creationdateend',12,31,2051,
  194: 			$ENV{'form.creationdateend_month'},
  195: 			$ENV{'form.creationdateend_day'},
  196: 			$ENV{'form.creationdateend_year'},
  197: 			);
  198:     $scrout.="</p>";
  199: 
  200:     $scrout.=<<LASTREVISIONDATESTART;
  201: <p>
  202: <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:
  203: </b></font>
  204: <br>between:
  205: LASTREVISIONDATESTART
  206:     $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
  207: 			$ENV{'form.lastrevisiondatestart_month'},
  208: 			$ENV{'form.lastrevisiondatestart_day'},
  209: 			$ENV{'form.lastrevisiondatestart_year'},
  210: 			);
  211:     $scrout.=<<LASTREVISIONDATEEND;
  212: and:
  213: LASTREVISIONDATEEND
  214:     $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,
  215: 			$ENV{'form.lastrevisiondateend_month'},
  216: 			$ENV{'form.lastrevisiondateend_day'},
  217: 			$ENV{'form.lastrevisiondateend_year'},
  218: 			);
  219:     $scrout.='</p>';
  220: 
  221:     $scrout.=&searchphrasefield('Limit by publisher/owner','owner',
  222: 				$ENV{'form.owner'});
  223: #			$metadatafields{'owner'});
  224: 
  225:     $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
  226:     $scrout.=&selectbox('Limit by copyright/distribution','copyright',
  227: 			$ENV{'form.copyright'},%cprtag);
  228: 
  229: # ------------------------------------------- Compute customized metadata field
  230:     $scrout.=<<CUSTOMMETADATA;
  231: <p>
  232: <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>
  233: </font>
  234: For resource-specific metadata, enter in an expression in the form of 
  235: <i>key</i>=<i>value</i> separated by operators such as AND or OR.<br>
  236: <b>Example:</b> grandmother=75 OR grandfather=85
  237: <br>
  238: CUSTOMMETADATA
  239: $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
  240: $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
  241: 
  242:     $scrout.=<<CUSTOMSHOW;
  243: <p>
  244: <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
  245: </font>
  246: Enter in a space-separated list of special metadata fields to show
  247: in a fielded listing for each record result.
  248: <br>
  249: CUSTOMSHOW
  250: $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
  251: $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
  252: 
  253: # ---------------------------------------------------------------- Print screen
  254:     $r->print(<<ENDDOCUMENT);
  255: <html>
  256: <head>
  257: <title>The LearningOnline Network with CAPA</title>
  258: </head>
  259: <body bgcolor="#FFFFFF">
  260: <img align=right src=/adm/lonIcons/lonlogos.gif>
  261: <h1>Search Catalog</h1>
  262: <form method="post" action="/adm/searchcat">
  263: $hidden
  264: <hr>
  265: <h3>Basic Search</h3>
  266: <p>
  267: Enter terms or phrases separated by search operators
  268: such as AND or OR then press SEARCH below.  Terms should be specific
  269: to the title, author, subject, notes, or abstract information associated
  270: with a resource.
  271: <br>
  272: ENDDOCUMENT
  273:     $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'}));
  274:     $r->print(' ');
  275:     $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'}));
  276:     $r->print('<font color="#800000">Title only</font> ');
  277:     $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'}));
  278:     $r->print(<<ENDDOCUMENT);
  279: <font color="#800000">Search historic archives</font>
  280: <br>
  281: <input type="submit" name="basicsubmit" value='SEARCH' />
  282: <input type="reset" name="reset" value='RESET' />
  283: $closebutton
  284: $basicviewselect
  285: </p>
  286: <hr>
  287: <h3>Advanced Search</h3>
  288: $scrout
  289: <p>
  290: <input type="submit" name="advancedsubmit" value='SEARCH' />
  291: <input type="reset" name="reset" value='RESET' />
  292: $closebutton
  293: $advancedviewselect
  294: </p>
  295: </form>
  296: </body>
  297: </html>
  298: ENDDOCUMENT
  299:     return OK;
  300: } 
  301: 
  302: # --------------------------------------------------------- Various form fields
  303: 
  304: sub simpletextfield {
  305:     my ($name,$value)=@_;
  306:     return '<input type=text name=\''.$name.
  307: 	   '\' size=20 value=\''.$value.'\' />';
  308: }
  309: 
  310: sub simplecheckbox {
  311:     my ($name,$value)=@_;
  312:     my $checked='';
  313:     $checked="CHECKED" if $value eq 'on';
  314:     return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';
  315: }
  316: 
  317: sub searchphrasefield {
  318:     my ($title,$name,$value)=@_;
  319:     my $instruction=<<END;
  320: Enter terms or phrases separated by search operators such
  321: as AND or OR.
  322: END
  323:     my $uctitle=uc($title);
  324:     return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".
  325: 	   "</FONT> $instruction<br>".
  326:            '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';
  327: }
  328: 
  329: sub dateboxes {
  330:     my ($name,$defaultmonth,$defaultday,$defaultyear,
  331: 	$currentmonth,$currentday,$currentyear)=@_;
  332:     ($defaultmonth,$defaultday,$defaultyear)=('','','');
  333:     my $month=<<END;
  334: <select name="${name}_month">
  335: <option value='$defaultmonth'> </option>
  336: <option value="1">January</option>
  337: <option value="2">February</option>
  338: <option value="3">March</option>
  339: <option value="4">April</option>
  340: <option value="5">May</option>
  341: <option value="6">June</option>
  342: <option value="7">July</option>
  343: <option value="8">August</option>
  344: <option value="9">September</option>
  345: <option value="10">October</option>
  346: <option value="11">November</option>
  347: <option value="12">December</option>
  348: </select>
  349: END
  350:     $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
  351:     my $day=<<END;
  352: <select name="${name}_day">
  353: <option value='$defaultday'> </option>
  354: <option value="1">1</option>
  355: <option value="2">2</option>
  356: <option value="3">3</option>
  357: <option value="4">4</option>
  358: <option value="5">5</option>
  359: <option value="6">6</option>
  360: <option value="7">7</option>
  361: <option value="8">8</option>
  362: <option value="9">9</option>
  363: <option value="10">10</option>
  364: <option value="11">11</option>
  365: <option value="12">12</option>
  366: <option value="13">13</option>
  367: <option value="14">14</option>
  368: <option value="15">15</option>
  369: <option value="16">16</option>
  370: <option value="17">17</option>
  371: <option value="18">18</option>
  372: <option value="19">19</option>
  373: <option value="20">20</option>
  374: <option value="21">21</option>
  375: <option value="22">22</option>
  376: <option value="23">23</option>
  377: <option value="24">24</option>
  378: <option value="25">25</option>
  379: <option value="26">26</option>
  380: <option value="27">27</option>
  381: <option value="28">28</option>
  382: <option value="29">29</option>
  383: <option value="30">30</option>
  384: <option value="31">31</option>
  385: </select>
  386: END
  387:     $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);
  388:     my $year=<<END;
  389: <select name="${name}_year">
  390: <option value='$defaultyear'> </option>
  391: <option value="1976">1976</option>
  392: <option value="1977">1977</option>
  393: <option value="1978">1978</option>
  394: <option value="1979">1979</option>
  395: <option value="1980">1980</option>
  396: <option value="1981">1981</option>
  397: <option value="1982">1982</option>
  398: <option value="1983">1983</option>
  399: <option value="1984">1984</option>
  400: <option value="1985">1985</option>
  401: <option value="1986">1986</option>
  402: <option value="1987">1987</option>
  403: <option value="1988">1988</option>
  404: <option value="1989">1989</option>
  405: <option value="1990">1990</option>
  406: <option value="1991">1991</option>
  407: <option value="1992">1992</option>
  408: <option value="1993">1993</option>
  409: <option value="1994">1994</option>
  410: <option value="1995">1995</option>
  411: <option value="1996">1996</option>
  412: <option value="1997">1997</option>
  413: <option value="1998">1998</option>
  414: <option value="1999">1999</option>
  415: <option value="2000">2000</option>
  416: <option value="2001">2001</option>
  417: <option value="2002">2002</option>
  418: <option value="2003">2003</option>
  419: <option value="2004">2004</option>
  420: <option value="2005">2005</option>
  421: <option value="2006">2006</option>
  422: <option value="2007">2007</option>
  423: <option value="2008">2008</option>
  424: <option value="2009">2009</option>
  425: <option value="2010">2010</option>
  426: <option value="2011">2011</option>
  427: <option value="2012">2012</option>
  428: <option value="2013">2013</option>
  429: <option value="2014">2014</option>
  430: <option value="2015">2015</option>
  431: <option value="2016">2016</option>
  432: <option value="2017">2017</option>
  433: <option value="2018">2018</option>
  434: <option value="2019">2019</option>
  435: <option value="2020">2020</option>
  436: <option value="2021">2021</option>
  437: <option value="2022">2022</option>
  438: <option value="2023">2023</option>
  439: <option value="2024">2024</option>
  440: <option value="2025">2025</option>
  441: <option value="2026">2026</option>
  442: <option value="2027">2027</option>
  443: <option value="2028">2028</option>
  444: <option value="2029">2029</option>
  445: <option value="2030">2030</option>
  446: <option value="2031">2031</option>
  447: <option value="2032">2032</option>
  448: <option value="2033">2033</option>
  449: <option value="2034">2034</option>
  450: <option value="2035">2035</option>
  451: <option value="2036">2036</option>
  452: <option value="2037">2037</option>
  453: <option value="2038">2038</option>
  454: <option value="2039">2039</option>
  455: <option value="2040">2040</option>
  456: <option value="2041">2041</option>
  457: <option value="2042">2042</option>
  458: <option value="2043">2043</option>
  459: <option value="2044">2044</option>
  460: <option value="2045">2045</option>
  461: <option value="2046">2046</option>
  462: <option value="2047">2047</option>
  463: <option value="2048">2048</option>
  464: <option value="2049">2049</option>
  465: <option value="2050">2050</option>
  466: <option value="2051">2051</option>
  467: </select>
  468: END
  469:     $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);
  470:     return "$month$day$year";
  471: }
  472: 
  473: sub selectbox {
  474:     my ($title,$name,$value,%options)=@_;
  475:     my $uctitle=uc($title);
  476:     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
  477: 	"</b></font><br>".'<select name="'.$name.'">';
  478:     map {
  479:         $selout.='<option value=\''.$_.'\'';
  480:         if ($_ eq $value) { $selout.=' selected'; }
  481:         $selout.='>'.$options{$_}.'</option>';
  482:     } sort keys %options;
  483:     return $selout.'</select>';
  484: }
  485: 
  486: # ----------------------------------------------- Performing an advanced search
  487: sub advancedsearch {
  488:     my ($r,$envhash)=@_;
  489:     my %ENV=%{$envhash};
  490: 
  491:     my $fillflag=0;
  492:     # Clean up fields for safety
  493:     for my $field ('title','author','subject','keywords','url','version',
  494: 		   'creationdatestart_month','creationdatestart_day',
  495: 		   'creationdatestart_year','creationdateend_month',
  496: 		   'creationdateend_day','creationdateend_year',
  497: 		   'lastrevisiondatestart_month','lastrevisiondatestart_day',
  498: 		   'lastrevisiondatestart_year','lastrevisiondateend_month',
  499: 		   'lastrevisiondateend_day','lastrevisiondateend_year',
  500: 		   'notes','abstract','mime','language','owner',
  501: 		   'custommetadata','customshow') {
  502: 	$ENV{"form.$field"}=~s/[^\w\s\(\)\=\-\"\']//g;
  503:     }
  504:     for my $field ('title','author','subject','keywords','url','version',
  505: 		   'notes','abstract','mime','language','owner',
  506: 		   'custommetadata') {
  507: 	if (&filled($ENV{"form.$field"})) {
  508: 	    $fillflag++;
  509: 	}
  510:     }
  511: 
  512:     unless ($fillflag) {
  513: 	&output_blank_field_error($r);
  514: 	return OK;
  515:     }
  516: 
  517:     my $query='';
  518: 
  519:     my @queries;
  520:     # Go through logical expression AND/OR/NOT phrase fields.
  521: 
  522:     foreach my $field ('title','author','subject','notes','abstract','url',
  523: 		       'keywords','version','owner') {
  524: 	if ($ENV{'form.'.$field}) {
  525: 	    push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
  526: 	}
  527:     }
  528:     if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
  529: 	push @queries,"(language like \"\%$ENV{'form.language'}\%\")";
  530:     }
  531:     if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
  532: 	push @queries,"(mime like \"\%$ENV{'form.mime'}\%\")";
  533:     }
  534:     if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
  535: 	push @queries,"(copyright like \"\%$ENV{'form.copyright'}\%\")";
  536:     }
  537:     my $datequery=&build_date_queries(
  538: 			$ENV{'form.creationdatestart_month'},
  539: 			$ENV{'form.creationdatestart_day'},
  540: 			$ENV{'form.creationdatestart_year'},
  541: 			$ENV{'form.creationdateend_month'},
  542: 			$ENV{'form.creationdateend_day'},
  543: 			$ENV{'form.creationdateend_year'},
  544: 			$ENV{'form.lastrevisiondatestart_month'},
  545: 			$ENV{'form.lastrevisiondatestart_day'},
  546: 			$ENV{'form.lastrevisiondatestart_year'},
  547: 			$ENV{'form.lastrevisiondateend_month'},
  548: 			$ENV{'form.lastrevisiondateend_day'},
  549: 			$ENV{'form.lastrevisiondateend_year'},
  550: 			);
  551:     if ($datequery=~/^Incorrect/) {
  552: 	&output_date_error($r,$datequery);
  553: 	return OK;
  554:     }
  555:     elsif ($datequery) {
  556: 	push @queries,$datequery;
  557:     }
  558:     my $customquery='';
  559:     if ($ENV{'form.custommetadata'}) {
  560: 	$customquery=&build_custommetadata_query('custommetadata',
  561: 				      $ENV{'form.custommetadata'});
  562:     }
  563:     if (@queries) {
  564: 	$query=join(" AND ",@queries);
  565: 	$query="select * from metadata where $query";
  566: 	my $reply='';
  567: 	unless ($customquery) {
  568: 	    $reply=&Apache::lonnet::metadata_query($query);
  569: 	}
  570: 	else {
  571: 	    $reply=&Apache::lonnet::metadata_query($query,$customquery);
  572: 	}
  573: 	&output_results('Advanced',$r,$envhash,$customquery,$reply);
  574:     }
  575:     else {
  576: 	&output_results('Advanced',$r,$envhash,$query);
  577:     }
  578:     return OK;
  579: }
  580: 
  581: # ---------------------------------------------------- see if a field is filled
  582: sub filled {
  583:     my ($field)=@_;
  584:     if ($field=~/\S/) {
  585: 	return 1;
  586:     }
  587:     else {
  588: 	return 0;
  589:     }
  590: }
  591: 
  592: # --------------------------------------------------- Performing a basic search
  593: sub basicsearch {
  594:     my ($r,$envhash)=@_;
  595:     my %ENV=%{$envhash};
  596: 
  597:     # Clean up fields for safety
  598:     for my $field ('basicexp') {
  599: 	$ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
  600:     }
  601: 
  602:     unless (&filled($ENV{'form.basicexp'})) {
  603: 	&output_blank_field_error($r);
  604: 	return OK;
  605:     }
  606: 
  607:     my $query='';
  608:     my $concatarg=join(',"    ",',
  609: 		       ('title', 'author', 'subject', 'notes', 'abstract'));
  610: 
  611:     $query="select * from metadata where concat($concatarg) like '\%$ENV{'form.basicexp'}\%'";
  612:     my $reply=&Apache::lonnet::metadata_query($query);
  613:     &output_results('Basic',$r,$envhash,$query,$reply);
  614:     return OK;
  615: }
  616: 
  617: # ---------------- Message to output when there are not enough fields filled in
  618: sub output_blank_field_error {
  619:     my ($r)=@_;
  620:     # make query information persistent to allow for subsequent revision
  621:     my $persistent=&make_persistent();
  622: 
  623:     $r->print(<<BEGINNING);
  624: <html>
  625: <head>
  626: <title>The LearningOnline Network with CAPA</title>
  627: BEGINNING
  628:     $r->print(<<RESULTS);
  629: </head>
  630: <body bgcolor="#ffffff">
  631: <img align=right src=/adm/lonIcons/lonlogos.gif>
  632: <h1>Search Catalog</h1>
  633: <form method="post" action="/adm/searchcat">
  634: $persistent
  635: <input type='button' value='Revise search request'
  636: onClick='this.form.submit();'>
  637: $closebutton
  638: <hr>
  639: <h3>Helpful Message</h3>
  640: <p>
  641: Incorrect search query due to blank entry fields.
  642: You need to fill in the relevant
  643: fields on the search page in order for a query to be
  644: processed.
  645: </p>
  646: </body>
  647: </html>
  648: RESULTS
  649: }
  650: 
  651: # ----------------------------- format and output results based on a reply list
  652: sub output_results {
  653:     my ($mode,$r,$envhash,$query,@replylist)=@_;
  654:     my %ENV=%{$envhash};
  655:     my $compiledresult='';
  656: 
  657:     foreach my $reply (@replylist) {
  658: 
  659: 	my @results;
  660: 
  661: 	my $replyfile='';
  662: 	$reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting
  663: 	$replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
  664: 	$reply=~/(.*?)\_/;
  665: 	my $hostname=$1;
  666: 	sleep 3; # temporary fix, need to check for completion and status
  667: 	{
  668: 	    while (1) {
  669: 		last if -e $replyfile;
  670: 		sleep 1;
  671: 	    }
  672: 	    # QUESTION: how should I handle this error condition..
  673: 	    # I'm sure there is syntax elsewhere I can use..
  674: 	    my $fh=Apache::File->new($replyfile) or
  675: 		($r->print('file cannot be opened') and return OK);
  676: 	    @results=<$fh>;
  677: 	}
  678: 
  679: 	my $customshow='';
  680: 	my $extrashow='';
  681: 	if ($ENV{'form.customshow'}) {
  682: 	    $customshow=$ENV{'form.customshow'};
  683: 	    $customshow=~s/[^\w\s]//g;
  684: 	    my @fields=map {"<font color=\"#008000\">$_:</font>"} 
  685: 	                   split(/\s+/,$customshow);
  686: 	    $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
  687: 	}
  688: 	foreach my $result (@results) {
  689: 	    my @fields=map
  690: 	                   {&Apache::lonnet::unescape($_)}
  691: 	                   (split(/\,/,$result));
  692: 	    my ($title,$author,$subject,$url,$keywords,$version,
  693: 		$notes,$abstract,$mime,$lang,
  694: 		$creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
  695: 	    my $shortabstract=$abstract;
  696: 	    $shortabstract=substr($abstract,0,200) if length($abstract)>200;
  697: 	    $fields[7]=$shortabstract;
  698: 	    $compiledresult.=<<END;
  699: <p>
  700: END
  701:             $compiledresult.=<<END if $ENV{'form.catalogmode'} eq 'interactive';
  702: <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
  703: onClick="javascript:select_data('$title','$url')">
  704: </font>
  705: <br>
  706: END
  707:             my $httphost=$ENV{'HTTP_HOST'};
  708: 
  709: 	    my $viewselect;
  710: 	    if ($mode eq 'Basic') {
  711: 		$viewselect=$ENV{'form.basicviewselect'};
  712: 	    }
  713: 	    elsif ($mode eq 'Advanced') {
  714: 		$viewselect=$ENV{'form.advancedviewselect'};
  715: 	    }
  716: 
  717:             if ($viewselect eq 'Detailed Citation View') {
  718: 		$compiledresult.=&detailed_citation_view(@fields,
  719: 							 $hostname,$httphost,
  720: 							 $extrashow);
  721: 	    }
  722:             elsif ($viewselect eq 'Summary View') {
  723: 		$compiledresult.=&summary_view(@fields,$hostname,$httphost,
  724: 					       $extrashow);
  725: 	    }
  726:             elsif ($viewselect eq 'Fielded Format') {
  727: 		$compiledresult.=&fielded_format_view(@fields,$hostname,
  728: 						      $httphost,$extrashow);
  729: 	    }
  730:             elsif ($viewselect eq 'XML/SGML') {
  731: 		$compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,
  732: 						$extrashow);
  733: 	    }
  734: 
  735:         }
  736: 
  737: 	unless ($compiledresult) {
  738: 	    $compiledresult="There were no results that matched your query";
  739: 	}
  740: 
  741: 	# make query information persistent to allow for subsequent revision
  742: 	my $persistent=&make_persistent();
  743: 
  744: 	$r->print(<<BEGINNING);
  745: <html>
  746: <head>
  747: <title>The LearningOnline Network with CAPA</title>
  748: BEGINNING
  749:         $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'interactive';
  750: <script>
  751:     function select_data(title,url) {
  752: 	changeTitle(title);
  753: 	changeURL(url);
  754:     }
  755:     function changeTitle(val) {
  756: 	if (opener.inf.document.forms.resinfo.elements.t) {
  757: 	    opener.inf.document.forms.resinfo.elements.t.value=val;
  758: 	}
  759:     }
  760:     function changeURL(val) {
  761: 	if (opener.inf.document.forms.resinfo.elements.u) {
  762: 	    opener.inf.document.forms.resinfo.elements.u.value=val;
  763: 	}
  764:     }
  765: </script>
  766: SCRIPT
  767:         $r->print(<<RESULTS);
  768: </head>
  769: <body bgcolor="#ffffff">
  770: <img align=right src=/adm/lonIcons/lonlogos.gif>
  771: <h1>Search Catalog</h1>
  772: <form method="post" action="/adm/searchcat">
  773: <input type='button' value='Revise search request'
  774: onClick='this.form.submit();'>
  775: $closebutton
  776: $persistent
  777: <hr>
  778: <h3>Search Query</h3>
  779: RESULTS
  780:     if ($mode eq 'Basic') {
  781: 	$r->print(<<RESULTS);
  782: <p>
  783: <b>Basic search:</b> $ENV{'form.basicexp'}
  784: </p>
  785: RESULTS
  786:     }
  787:     elsif ($mode eq 'Advanced') {
  788: 	$r->print(<<RESULTS);
  789: <p>
  790: <b>Advanced search</b>
  791: $query
  792: </p>
  793: RESULTS
  794:     }
  795: 	$r->print(<<RESULTS);
  796: <h3>Search Results</h3>
  797: $compiledresult
  798: </body>
  799: </html>
  800: RESULTS
  801:     }
  802: }
  803: 
  804: # ------------------------------------------------------------- build_SQL_query
  805: sub build_SQL_query {
  806:     my ($field_name,$logic_statement)=@_;
  807:     my $q=new Text::Query('abc',
  808: 			  -parse => 'Text::Query::ParseAdvanced',
  809: 			  -build => 'Text::Query::Build');
  810:     $q->prepare($logic_statement);
  811:     my $matchexp=${$q}{'matchexp'}; chomp $matchexp;
  812:     my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);
  813:     return $sql_query;
  814: }
  815: 
  816: # ------------------------------------------------- build custom metadata query
  817: sub build_custommetadata_query {
  818:     my ($field_name,$logic_statement)=@_;
  819:     my $q=new Text::Query('abc',
  820: 			  -parse => 'Text::Query::ParseAdvanced',
  821: 			  -build => 'Text::Query::BuildAdvancedString');
  822:     $q->prepare($logic_statement);
  823:     my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
  824:     # quick fix to change literal into xml tag-matching
  825:     # will eventually have to write a separate builder module
  826:     my $oldmatchexp=$matchexp;
  827:     $matchexp=~s/(\w+)\\\=(\w+)/\\\<$1\\\>\[\^\\\<\]\*$2\[\^\\\<\]\*\\\<\\\/$1\\\>/g;
  828:     return $matchexp;
  829: }
  830: 
  831: # - Recursively parse a reverse notation expression into a SQL query expression
  832: sub recursive_SQL_query_build {
  833:     my ($dkey,$pattern)=@_;
  834:     my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
  835:     return $pattern unless @matches;
  836:     foreach my $match (@matches) {
  837: 	$match=~/\[ (\w+)\s(.*) \]/;
  838: 	my ($key,$value)=($1,$2);
  839: 	my $replacement='';
  840: 	if ($key eq 'literal') {
  841: 	    $replacement="($dkey like \"\%$value\%\")";
  842: 	}
  843: 	elsif ($key eq 'and') {
  844: 	    $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  845: 	    $replacement="($1 AND $2)";
  846: 	}
  847: 	elsif ($key eq 'or') {
  848: 	    $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
  849: 	    $replacement="($1 OR $2)";
  850: 	}
  851: 	substr($pattern,
  852: 	       index($pattern,$match),
  853: 	       length($match),
  854: 	       $replacement
  855: 	       );
  856:     }
  857:     &recursive_SQL_query_build($dkey,$pattern);
  858: }
  859: 
  860: # ------------------------------------------------------ Detailed Citation View
  861: sub detailed_citation_view {
  862:     my ($title,$author,$subject,$url,$keywords,$version,
  863: 	$notes,$shortabstract,$mime,$lang,
  864: 	$creationdate,$lastrevisiondate,$owner,$copyright,
  865: 	$hostname,$httphost,$extrashow)=@_;
  866:     my $result=<<END;
  867: <i>$owner</i>, last revised $lastrevisiondate
  868: <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>
  869: <h3>$author</h3>
  870: </p>
  871: <p>
  872: <b>Subject:</b> $subject<br>
  873: <b>Keyword(s):</b> $keywords<br>
  874: <b>Notes:</b> $notes<br>
  875: <b>MIME Type:</b> $mimetag{$mime}<br>
  876: <b>Language:</b> $language{$lang}<br>
  877: <b>Copyright/Distribution:</b> $cprtag{$copyright}<br>
  878: $extrashow
  879: $shortabstract
  880: </p>
  881: END
  882:     return $result;
  883: }
  884: 
  885: # ---------------------------------------------------------------- Summary View
  886: sub summary_view {
  887:     my ($title,$author,$subject,$url,$keywords,$version,
  888: 	$notes,$shortabstract,$mime,$lang,
  889: 	$creationdate,$lastrevisiondate,$owner,$copyright,
  890: 	$hostname,$httphost,$extrashow)=@_;
  891:     my $result=<<END;
  892: <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />
  893: $title<br />
  894: $owner -- $lastrevisiondate<br />
  895: $cprtag{$copyright}<br />
  896: $extrashow
  897: </p>
  898: END
  899:     return $result;
  900: }
  901: 
  902: # -------------------------------------------------------------- Fielded Format
  903: sub fielded_format_view {
  904:     my ($title,$author,$subject,$url,$keywords,$version,
  905: 	$notes,$shortabstract,$mime,$lang,
  906: 	$creationdate,$lastrevisiondate,$owner,$copyright,
  907: 	$hostname,$httphost,$extrashow)=@_;
  908:     my $result=<<END;
  909: <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>
  910: <br />
  911: <b>Title:</b> $title<br />
  912: <b>Author(s):</b> $author<br />
  913: <b>Subject:</b> $subject<br />
  914: <b>Keyword(s):</b> $keywords<br />
  915: <b>Notes:</b> $notes<br />
  916: <b>MIME Type:</b> $mimetag{$mime}<br />
  917: <b>Language:</b> $language{$lang}<br />
  918: <b>Creation Date:</b> $creationdate<br />
  919: <b>Last Revision Date:</b> $lastrevisiondate<br />
  920: <b>Publisher/Owner:</b> $owner<br />
  921: <b>Copyright/Distribution:</b> $cprtag{$copyright}<br />
  922: <b>Repository Location:</b> $hostname<br />
  923: <b>Abstract:</b> $shortabstract<br />
  924: $extrashow
  925: </p>
  926: END
  927:     return $result;
  928: }
  929: 
  930: # -------------------------------------------------------------------- XML/SGML
  931: sub xml_sgml_view {
  932:     my ($title,$author,$subject,$url,$keywords,$version,
  933: 	$notes,$shortabstract,$mime,$lang,
  934: 	$creationdate,$lastrevisiondate,$owner,$copyright,
  935: 	$hostname,$httphost,$extrashow)=@_;
  936:     my $result=<<END;
  937: <pre>
  938: &lt;LonCapaResource&gt;
  939: &lt;url&gt;$url&lt;/url&gt;
  940: &lt;title&gt;$title&lt;/title&gt;
  941: &lt;author&gt;$author&lt;/author&gt;
  942: &lt;subject&gt;$subject&lt;/subject&gt;
  943: &lt;keywords&gt;$keywords&lt;/keywords&gt;
  944: &lt;notes&gt;$notes&lt;/notes&gt;
  945: &lt;mimeInfo&gt;
  946: &lt;mime&gt;$mime&lt;/mime&gt;
  947: &lt;mimetag&gt;$mimetag{$mime}&lt;/mimetag&gt;
  948: &lt;/mimeInfo&gt;
  949: &lt;languageInfo&gt;
  950: &lt;language&gt;$lang&lt;/language&gt;
  951: &lt;languagetag&gt;$language{$lang}&lt;/languagetag&gt;
  952: &lt;/languageInfo&gt;
  953: &lt;creationdate&gt;$creationdate&lt;/creationdate&gt;
  954: &lt;lastrevisiondate&gt;$lastrevisiondate&lt;/lastrevisiondate&gt;
  955: &lt;owner&gt;$owner&lt;/owner&gt;
  956: &lt;copyrightInfo&gt;
  957: &lt;copyright&gt;$copyright&lt;/copyright&gt;
  958: &lt;copyrighttag&gt;$cprtag{$copyright}&lt;/copyrighttag&gt;
  959: &lt;/copyrightInfo&gt;
  960: &lt;repositoryLocation&gt;$hostname&lt;/repositoryLocation&gt;
  961: &lt;shortabstract&gt;$shortabstract&lt;/shortabstract&gt;
  962: &lt;/LonCapaResource&gt;
  963: </pre>
  964: $extrashow
  965: END
  966:     return $result;
  967: }
  968: 
  969: sub build_date_queries {
  970:     my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
  971: 	$lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
  972:     my @queries;
  973:     if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {
  974: 	unless ($cmonth1 and $cday1 and $cyear1 and
  975: 		$cmonth2 and $cday2 and $cyear2) {
  976: 	    return "Incorrect entry for the creation date.  You must specify ".
  977: 		   "a starting month, day, and year and an ending month, ".
  978: 		   "day, and year.";
  979: 	}
  980: 	my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);
  981: 	$cnumeric1+=0;
  982: 	my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);
  983: 	$cnumeric2+=0;
  984: 	if ($cnumeric1>$cnumeric2) {
  985: 	    return "Incorrect entry for the creation date.  The starting ".
  986: 		   "date must occur before the ending date.";
  987: 	}
  988: 	my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".
  989: 	           "$cyear2-$cmonth2-$cday2 23:59:59')";
  990: 	push @queries,$cquery;
  991:     }
  992:     if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {
  993: 	unless ($lmonth1 and $lday1 and $lyear1 and
  994: 		$lmonth2 and $lday2 and $lyear2) {
  995: 	    return "Incorrect entry for the last revision date.  You must ".
  996: 		   "specify a starting month, day, and year and an ending ".
  997: 		   "month, day, and year.";
  998: 	}
  999: 	my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);
 1000: 	$lnumeric1+=0;
 1001: 	my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);
 1002: 	$lnumeric2+=0;
 1003: 	if ($lnumeric1>$lnumeric2) {
 1004: 	    return "Incorrect entry for the last revision date.  The ".
 1005: 		   "starting date must occur before the ending date.";
 1006: 	}
 1007: 	my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".
 1008: 	           "$lyear2-$lmonth2-$lday2 23:59:59')";
 1009: 	push @queries,$lquery;
 1010:     }
 1011:     if (@queries) {
 1012: 	return join(" AND ",@queries);
 1013:     }
 1014:     return '';
 1015: }
 1016: 
 1017: sub output_date_error {
 1018:     my ($r,$message)=@_;
 1019:     # make query information persistent to allow for subsequent revision
 1020:     my $persistent=&make_persistent();
 1021: 
 1022:     $r->print(<<BEGINNING);
 1023: <html>
 1024: <head>
 1025: <title>The LearningOnline Network with CAPA</title>
 1026: BEGINNING
 1027:     $r->print(<<RESULTS);
 1028: </head>
 1029: <body bgcolor="#ffffff">
 1030: <img align=right src=/adm/lonIcons/lonlogos.gif>
 1031: <h1>Search Catalog</h1>
 1032: <form method="post" action="/adm/searchcat">
 1033: $persistent
 1034: <input type='button' value='Revise search request'
 1035: onClick='this.form.submit();'>
 1036: $closebutton
 1037: <hr>
 1038: <h3>Helpful Message</h3>
 1039: <p>
 1040: $message
 1041: </p>
 1042: </body>
 1043: </html>
 1044: RESULTS
 1045: }
 1046: 
 1047: sub make_persistent {
 1048:     my $persistent='';
 1049:     
 1050:     map {
 1051: 	if (/^form\./ && !/submit/) {
 1052: 	    my $name=$_;
 1053: 	    my $key=$name;
 1054: 	    $ENV{$key}=~s/\'//g; # do not mess with html field syntax
 1055: 	    $name=~s/^form\.//;
 1056: 	    $persistent.=<<END;
 1057: <input type='hidden' name='$name' value='$ENV{$key}' />
 1058: END
 1059:         }
 1060:     } (keys %ENV);
 1061:     return $persistent;
 1062: }
 1063: 1;
 1064: __END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>