/////////////////////////////////////////////////////
//                                                 //
//           P H P S i t e S e a r c h             //
//                 Version 1.7.7                   //
//                                                 //
//                 Copyright 2001                  //
//                  David Broker                   //
//                php@warpedweb.net                //
//              All Rights Reserved                //
//                                                 //
//          In using this script you               //
//           agree to the following:               //
//                                                 //
//      This script may be used and modified       //
//              freely as long as this             //
//             copyright remains intact.           //
//                                                 //
//     You may not distibute this script, or       //
//           any modifications of it.              //
//                                                 //
//   A link must be provided on the website that   //
//             uses the script to:                 //
//          http://php.warpedweb.net/              //
//                                                 //
//      Any breaches of these conditions           //
//        will result in legal action.             //
//                                                 //
//      This script is distributed with            //
//        no warranty, free of charge.             //
//                                                 //
/////////////////////////////////////////////////////

Contents:

• About
• Included Files
• Installation/Usage
• Change log

About

A site indexer and search script for small to medium sites.
The indexer goes through your site and indexes it from either meta-tags or all words into a text database.
The search script then performs searches on that database.

PHPSiteSearch2.0, which is currently under development will include multi-database support, multiple languages, and much more!

Included Files

1. readme.txt
   This file.
2. search.php
   The script that does the searching & indexing.
3. search_index.dat
   The text file where the index database will be stored.
4. exclude_words.txt
   A list of words NOT to be indexed (and, the, or).
5. exclude_files.txt
   A list of files not to be index.

Installation

1. Requirements:
   • PHP Version 4.0.2 or greater.
     This is needed because of the functions used in the script are not valid in PHP3
   • VERY basic knowledge of PHP.
     This is required to install the script. You need to edit a few lines of the script, all of which is described in detail.
2. Configure the scripts:
   Open search.php in a text editor:
   1. Set the username and passowrd.

      $user = "Bob";
      $pass = "Bill123";

   2. Full server path to files (DO NOT include trailing slashes). If using Window make sure to use double back slashes for server paths.

      EG:  $file_root = "c:\\html";
           $file_root = "/home/user/public_html";

   3. Equivilent URL of the above path (DO NOT include trailing slashes).

      EG:  $http_root = "http://127.0.0.1";

   4. Full server path to the index file:

      EG:  $index_file = "c:\\html\\search\\search_index.dat";
           $index_file = "/home/user/public_html/search/search_index.dat";

   5. Full server path to the file list of words not to index.

      EG:  $exclude_words = "c:\\html\\search\\exclude_words.txt";
           $exclude_words = "/home/user/public_html/search/exclude_words.txt";

   6. Full server path to the file list of words not to index.

      EG:  $exclude_files = "c:\\html\\search\\exclude_files.txt";
           $exclude_files = "/home/user/public_html/search/exclude_files.txt";

3. Installing the Scripts:
   • Upload the files to the server, make sure they are all in the same directory..
   • On a Unix machine you will need to set the index file to be writable by chmod-ing it to 777.
     At the command prompt navigate to the directory of the file and type:

     chmod 777 search_index.dat

   • On a Windows 9X/ME machine there are no permissions to change.
   • On a Windows NT/2000 machine the file must be writable.
4. Preparing Your Site:
   There are a number of things which you need to take note of, in order to prepare your site to be indexed by this script.
   • Meta Tag Indexing:
     • If indexing from meta tags, the keywords that are included in the data file come from the meta tags of the page.
     • Here is the HTML tags from which the keywords arise from:

       <meta name="keywords" content="keyword1, keyword2, keyword3">

     • Text files (.txt) will be full indexed.
     • Otherwise, if no meta tags are found, then that page will not be indexed.
   • Full Indexing:
     • There are a few things to note when full indexing your site.
     • When using CSS and Javascript make sure you enclose it in comments or place it in an external file, otherwise the indexer will index it.
       IE:

       <script language="Javascript">
       <!--
       Javascript inside comments!
       -->
       </script>
       

   • Search Results:
     The search engine will display the results like so:

     - Title of Page - http://www.whatever.com/
     The first few lines of the page...

     Please note the change from previous versions. Metatags are no longer used in search results.
   • Excluding Files/Words:
     • There are 2 files included in the distribution, these allow you to exclude files/words from being indexed.
     • exclude_words.txt
       This file contains a list of common words (and, the, or) which will not be indexed, you can add any words to this file that you do not want.
     • exclude_files.txt
       This contains a list of files not to be indexed.
       If you do not want the file http://www.whatever.com/page.html to be indexed, you would place this in the file "exclude_files.txt": /page.html
       If you wish to exclude every file called "page.html" that is found, simplily do add this to the "exclude_files.txt": page.html.
       You can also use Perl regular expressions to match files to exclude.
5. Indexing:
   • First open the script in your browser like so:

     http://path.to/script/search.php?index

     (Note the "?index")
     and log in using the username/password you choose.
   • The first thing you must do is index your site:
     1. Select "Create Site Index" and press submit.
     2. Choose between "Full Index" and "Meta Tag Index".
     3. If you get an error message, check the configuration of the script.
   • Now you can view your index. Select "View Index" and press submit.
     The table shows what your search_index.dat file looks like, with all the files and coresponding keywords.
   • You can also clear the index file. Select "Clear Index" and press submit.
     It will ask you to confirm before it completes this operation.
     The index is cleared automatically before re-indexing.
6. Searching:
   • Open search.php in your browser (without the "?index"), after you have indexed your site, and test it!
   • If you wish to search in another file just use this:

     <form action="search.php" method="post">
      <br><input type="text" name="query" value="Search for...">
      <br><input type="submit" value="Search">
     </form>

   That's all there is to it!
   If you find you have any troubles try to uncomment the "DEFINE("DEBUG", true); line in the configuration.
   It will give you a detailed description of your configuration and any problems.