1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>SWISH-Enhanced: search.cgi -- Example Perl program for searching with Swish-e and SWISH::API </title>
<link href="./style.css" rel=stylesheet type="text/css" title="refstyle">
</head>
<body>
<h1 class="banner">
<a href="http://swish-e.org"><img border=0 src="images/swish.gif" alt="Swish-E Logo"></a><br>
<img src="images/swishbanner1.gif"><br>
<img src="images/dotrule1.gif"><br>
search.cgi -- Example Perl program for searching with Swish-e and SWISH::API
</h1>
<hr>
<p>
<div class="navbar">
<a href="./swish.html">Prev</a> |
<a href="./index.html">Contents</a> |
<a href="./spider.html">Next</a>
</div>
<p>
<div class="toc">
<A NAME="toc"></A>
<P><B>Table of Contents:</B></P>
<UL>
<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
<LI><A HREF="#REQUIREMENTS">REQUIREMENTS</A>
<LI><A HREF="#OVERVIEW">OVERVIEW</A>
<LI><A HREF="#INSTALLATION_EXAMPLE">INSTALLATION EXAMPLE</A>
<LI><A HREF="#Using_with_SpeedyCGI">Using with SpeedyCGI</A>
<LI><A HREF="#Using_with_MOD_PERL">Using with MOD_PERL</A>
<LI><A HREF="#SUPPORT">SUPPORT</A>
<LI><A HREF="#AUTHOR">AUTHOR</A>
<LI><A HREF="#LICENSE">LICENSE</A>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
</UL>
</div>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<P>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
This is a very simple program that shows how to use the SWISH::API module
in a CGI script or mod_perl handler using Template-Toolkit to generate
output. This program is intended for programmers that want to create a
custom search script.
<P>
Unlike <EM>swish.cgi</EM> this script does not have many features, and provides no external
configuration (with the execption of a few config options under mod_perl).
So don't ask why it doesn't do something. The point is that this script is
used as a starting point that YOU customize.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="REQUIREMENTS">REQUIREMENTS</A></H1>
<P>
You must have swish-e and the SWISH::API module installed. See the README
and INSTALL documents in the swish-e distribution. As of this writing
SWISH::API is part of the swish-e distribution, but in the future may be
provided as a separate package (provided on the CPAN). In either case
SWISH::API is a separate installation procedure from installing swish-e.
The Storable module is also required if using mod_perl.
<P>
This program does require that some modules are installed from CPAN. You
will need Template-Toolkit and HTML::FillInForm (which depends on
HTML::Parser). How those are installed depends on your computer's packaging
system.
<P>
You will need a web server, obviously. The discussion below assumes Apache
is used. If you are using MS IIS take note that IIS works differently in a
number of ways.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="OVERVIEW">OVERVIEW</A></H1>
<P>
The <EM>search.cgi</EM> script and related templates are installed when swish-e is installed.
<EM>search.cgi</EM> is installed in $prefix/lib/swish-e/ and templates are installed in
$prefix/share/swish-e/templates/. <CODE>$prefix</CODE> is /usr/local by
default but can be changed when running the swish-e <EM>configure</EM> script. Upon installation <EM>search.cgi</EM> is updated with correct paths to your perl binary and
<P>
When running as a CGI script <EM>search.cgi</EM> is copied or symlinked to the location of your CGI scripts (or any
directory that allows CGI scripts). By default, the <EM>search.cgi</EM> script looks for the index <EM>index.swish-e</EM> in the current directory (that's what the web server considers the current
directory). On Apache running mod-cgi that's the same place as the script.
On IIS it's not. If your index is elsewhere you will need to modify the
script.
<P>
The script works by parsing the query, calling SWISH::API to run the actual
search, then calls Template-Toolkit to generate the ouput.
<P>
The script calls the <EM>search.tt</EM> template. This template generates the query form and the search results.
The <EM>search.tt</EM> template uses a Template-Toolkit "WRAPPER" function to wrap the
search form and results in your site's design. This design is in the <EM>page_layout</EM> template. The idea is if you use Template-Toolkit to manage your entire
site then your entire site would be formatted by the same <EM>page_layout</EM> template. The <EM>page_layout</EM> template calls two other templates <EM>common_header</EM> and <EM>common_footer</EM> to generate a common header and footer for the site. Those are just
demonstrating Template-Toolkit's features.
<P>
The <EM>page_layout</EM> page only defines the basic structure of the site. The true design of the
site is managed by style sheets. <EM>style.css</EM> defines the basic layout and <EM>markup.css</EM> sets fonts and colors.
<P>
Note: these style sheets are included directly in the output of the CGI
script. In production the style sheets would be stored as separate style
sheet files and imported by the browser instead of directly included in the
search results page.
<P>
See the section MOD_PERL below for more on templates.
<P>
Highlighting of search terms is provided by the SWISH::PhraseHighlight
module. That is a very slow module, so you may wish to disable it if you
expect a lot of traffic.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="INSTALLATION_EXAMPLE">INSTALLATION EXAMPLE</A></H1>
<P>
Enough talking, sometimes it's nice to see a complete example. Below
swish-e is installed in the default location (/usr/local). The
"$" is a normal user prompt, where "#" is a root
prompt. Use ./configure --prefix to install in another location (e.g. if
you do not have root access).
<P>
Download and install swish-e
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ wget -q <A HREF="http://swish-e.org/Download/latest.tar.gz">http://swish-e.org/Download/latest.tar.gz</A>
$ tar zxf latest.tar.gz
$ cd swish-e-2.x.x
$ (./configure && make) >/dev/null
$ make check
$ su
# make install
# exit</pre>
</td>
</tr>
</table>
<P>
Install SWISH::API
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ cd perl
$ perl Makefile.PL && make && make test
$ su
# make install
$ exit</pre>
</td>
</tr>
</table>
<P>
Install requried Perl modules. You can install via RPMs, Debs or directly
from the CPAN or by using the CPAN shell.
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> # su
# perl -MCPAN -e 'install Template'
# perl -MCPAN -e 'install HTML::FillInForm'
# exit</pre>
</td>
</tr>
</table>
<P>
Now setup the script in someplace that allows CGI scripts.
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ cd $HOME/apache
$ ln -s /usr/local/lib/swish-e/search.cgi .
$ cat .htaccess
deny from all
<files search.cgi>
allow from all
SetHandler cgi-script
Options +ExecCGI
</files></pre>
</td>
</tr>
</table>
<P>
Create an index
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ cat swish.config
IndexOnly .htm .html
DefaultContents HTML*
StoreDescription HTML* <body>
metanames swishtitle swishdocpath</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ swish-e -c swish.config -i /usr/share/doc/apache-doc/manual</pre>
</td>
</tr>
</table>
<P>
Test the index and the CGI script:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ swish-e -w apache -m1 | grep hits
# Number of hits: 152</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ lynx -dump <A HREF="http://localhost/apache/search.cgi?query=apache">http://localhost/apache/search.cgi?query=apache</A> | grep hits
Showing page 1 (1 - 10 of 152 hits) [3]Next
'hits' => 152,</pre>
</td>
</tr>
</table>
<P>
Now, the above isn't very helpful because the Apache documentation indexed
is not in the web space. You would likely index content available on your
web site.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Using_with_SpeedyCGI">Using with SpeedyCGI</A></H1>
<P>
Perl CGI script must be compiled for each request. SpeedyCGI is a tool to
speed up scripts by running them persistently. To run <EM>search.cgi</EM> with SpeedyCGI install the program (you can Google, right?) and then change
the first line of <EM>search.cgi</EM>
to run the <EM>speedy</EM> program.
<P>
For example:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> #!/usr/bin/speedy -w</pre>
</td>
</tr>
</table>
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Using_with_MOD_PERL">Using with MOD_PERL</A></H1>
<P>
This script can be run directly as a mod_perl handler, and the same code
can be used to run multiple sites by using separate Location directives and
passing in a "site id." The script caches in memory different
configurations based on this site id.
<P>
Below is a complete httpd.conf file. It requires an Apache httpd that has
mod_perl compiled in statically. It runs mod_perl on a high port (port
5000) listening to all interfaces.
<P>
For testing I put this config file in a directory along with <EM>search.cgi</EM>, but that's just done to make the example simple (i.e. so I don't have to
show any absolute paths). Normally the httpd.conf and the swish.cgi
"module" would be in separate locations.
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> # httpd.conf -- test file for search.cgi as mod_perl handler</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <ifModule mod_so.c>
LoadModule mime_module /usr/lib/apache/1.3/mod_mime.so
</IfModule></pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> ErrorLog swish_error_log
PidFile swish_httpd.pid</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> Listen *:5000</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <perl>
push @PerlSetVar, [
index => Apache->server_root_relative( 'index.swish-e'),
];
$DocumentRoot = Apache->server_root_relative;
require "search.cgi";
</perl></pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> NameVirtualHost *:5000
<VirtualHost *:5000></pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> ServerName localhost</pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <Location /search>
SetHandler perl-script
PerlHandler SwishAPISearch
</Location></pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <Location /othersite>
SetHandler perl-script
PerlHandler SwishAPISearch
# Define this site
PerlSetVar site_id othersite
PerlSetVar title "Some other Site"
</Location></pre>
</td>
</tr>
</table>
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> </VirtualHost></pre>
</td>
</tr>
</table>
<P>
The server is started using this command:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ /usr/sbin/apache-perl -d $(pwd) -f $(pwd)/httpd.conf</pre>
</td>
</tr>
</table>
<P>
which says to use the current directory as the ServerRoot. (See comments
below.) Stop the server like:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> $ kill `cat swish_httpd.pid`</pre>
</td>
</tr>
</table>
<P>
Then access either:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <A HREF="http://localhost:5000/search">http://localhost:5000/search</A>
<A HREF="http://localhost:5000/othersite">http://localhost:5000/othersite</A></pre>
</td>
</tr>
</table>
<P>
A few Notes:
<P>
I like test configurations to not care where things are located. Thus, the
above httpd.conf does a few tricks in the "Perl Section" shown.
<P>
First, mod_perl, unlike CGI, doesn't set the working directory. So, the
index file name must be absolute. This is accomplished by a PerlSetVar
entry building the index file name from the ServerRoot.
<P>
Second, the DocumentRoot is set to the same as the ServerRoot. The
DocumentRoot needs to be set so search.cgi can figure out the path to the
script (for creating next and previous links).
<P>
Third, the script is loaded by a <CODE>require</CODE> statement. This works only because the current directory "." is
in Perl's <CODE>@INC</CODE> path at Apache start up time and
<EM>search.cgi</EM> is also in the current directory. Normally, set PERL5LIB on server startup
or use a "use lib" line in your startup.pl file to point to the
location of search.cgi.
<P>
The "PerlSetVar" lines pass config information into the script.
Note that they can be set globally or specific to a given Location.
<P>
The following config options are currently available:
<DL>
<P><DT><STRONG><A NAME="item_site_id">site_id</A></STRONG><DD>
<P>
The site_id options allow caching of configurations on a per-site basis.
It's overkill in this example, but normally you might have expensive
configuration processes that you might want to do only once. But, since
there is caching by this id it's a good id to set a site_id if using more
than one Location directive.
<P><DT><STRONG><A NAME="item_index">index</A></STRONG><DD>
<P>
This specifies the index file to use. The index file needs to be absolute
as discussed above. Example:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> PerlSetVar index /usr/share/swish/site.index</pre>
</td>
</tr>
</table>
<P><DT><STRONG><A NAME="item_title">title</A></STRONG><DD>
<P>
This options sets the title that's passed into the template.
<P><DT><STRONG><A NAME="item_template">template</A></STRONG><DD>
<P>
Sets the file name of the template use to generate the form. This might be
useful if you want an "advanced" form, for example.
<P><DT><STRONG><A NAME="item_template_path">template_path</A></STRONG><DD>
<P>
This can be used to update the path where templates are searched. Useful if
you wish to override templates.
<P><DT><STRONG><A NAME="item_page_size">page_size</A></STRONG><DD>
<P>
This allow changing the default number of results shown per page.
</DL>
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="SUPPORT">SUPPORT</A></H1>
<P>
Not much support is provided. But what support is provided is ONLY provided
via the Swish-e discussion list.
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> <A HREF="http://swish-e.org/">http://swish-e.org/</A></pre>
</td>
</tr>
</table>
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="AUTHOR">AUTHOR</A></H1>
<P>
Bill Moseley
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="LICENSE">LICENSE</A></H1>
<P>
Copyright 2003, 2004 Bill Moseley. All rights reserved.
<P>
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
SWISH::API, Template, HTML::FillInForm
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<p>
<div class="navbar">
<a href="./swish.html">Prev</a> |
<a href="./index.html">Contents</a> |
<a href="./spider.html">Next</a>
</div>
<p>
<P ALIGN="CENTER">
<IMG ALT="" WIDTH="470" HEIGHT="10" SRC="images/dotrule1.gif"></P>
<P ALIGN="CENTER">
<div class="footer">
<BR>SWISH-E is distributed with <B>no warranty</B> under the terms of the
<A HREF="http://www.fsf.org/copyleft/gpl.html">GNU Public License</A>,<BR>
Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA<BR>
Public questions may be posted to
the <A HREF="http://swish-e.org/Discussion/">SWISH-E Discussion</A>.
</div>
</body>
</html>
|
