RatingsHandler Installation

Version 1.0

1. You can print this out and refer to it as needed.

Unzip the files to a location of your choice. After unzipping you should have the following directories and files. Directories are in bold. Files are not bolded.

CGI
  | -- Data
  | -- Inc
  |      | -- MIME
  |      |        |-- Lite.pm
  |      | -- Net
  |      |        |-- Cmd.pm
  |      |        |-- Config.pm
  |      |        |-- SMTP.pm
  | -- admin.cgi
  | -- RatingsHandler.cgi
  | -- Readme.txt
  | -- subs_global.cgi
  | -- subs_imagesize.cgi
  | -- subs_lwp.cgi
  | -- subs_main.cgi
  | -- vars_main.cgi

NONCGI
  | -- blank.gif
  | -- dot.gif
  | -- popup_01.gif
  | -- popup_02.gif
  | -- popup_03.gif
  | -- popup_04.gif
  | -- popup_05.gif
  | -- popup_06.gif
  | -- popup_07.gif
  | -- popup_08.gif
  | -- rated_1.gif
  | -- rated_10.gif
  | -- rated_10_over.gif
  | -- rated_1_over.gif
  | -- rated_2.gif
  | -- rated_2_over.gif
  | -- rated_3.gif
  | -- rated_3_over.gif
  | -- rated_4.gif
  | -- rated_4_over.gif
  | -- rated_5.gif
  | -- rated_5_over.gif
  | -- rated_6.gif
  | -- rated_6_over.gif
  | -- rated_7.gif
  | -- rated_7_over.gif
  | -- rated_8.gif
  | -- rated_8_over.gif
  | -- rated_9.gif
  | -- rated_9_over.gif
  | -- RatingsHandler.gif
  | -- scale.gif
  | -- template.htm
  | -- template_popup.htm

For UNIX servers. You may need to set the location of your Perl in the scripts. The default location set for Perl in the script is:

#!/usr/local/bin/perl

If this path is correct for your server, you can skip to the next section.

The Perl location is the first line of the following files:

RatingsHandler.cgi
admin.cgi

If your server allows you to run Perl scripts with the cgi extension or you have other Perl scripts on your server that use the extension cgi, you can skip this step. Most server will allow cgi extensions. 

If your server only allows pl extensions to be ran, at this point you must rename all the cgi files to pl files.

Example:

admin.pl
RatingsHandler.pl
subs_global.pl
subs_imagesize.pl
subs_lwp.pl
subs_main.pl
vars_main.pl

Once you have renamed each of these files, you must edit the following files and indicate in them that you are using the pl extension:

RatingsHandler.pl
admin.pl

To edit them, open each files in a text editor. Find the line that says:

$cgiext = 'cgi';

This line must be changed so that it reads:

$cgiext = 'pl';

Once you have edited each file and saved them, you are ready to go using the pl extension.

1. Login to your ftp server. This can be done using any FTP client such as CuteFTP.
    
2. Create a directory called RatingsHandler on your server in which the script will run.  This most likely will be located as a subdirectory of your  cgi-bin directory.
   
   Example:
   http://www.domain.com/cgi-bin/RatingsHandler 
     
3. Using your ftp client, change to the directory which you created in step 2 above.
    
4. Upload all files and directories from the zip file CGI directory into the directory that you just created created on your server.
   Note: You'll need to create a directory structure that matches the one in the zip file.
   
   Once done you will have a directory and file structure such as:
   
   cgi-bin/RatingsHandler
      | -- Data
      | -- Inc
      |      | -- MIME
      |      |        |-- Lite.pm
      |      | -- Net
      |      |        |-- Cmd.pm
      |      |        |-- Config.pm
      |      |        |-- SMTP.pm
      | -- admin.cgi
      | -- RatingsHandler.cgi
      | -- Readme.txt
      | -- subs_global.cgi
      | -- subs_imagesize.cgi
      | -- subs_lwp.cgi
      | -- subs_main.cgi
      | -- vars_main.cgi
    
5. When uploading the .cgi files, you should be sure to use ASCII mode transfer.

1. This step is not a must at this moment. It can be done at any point down the line.
    
   The template (template.htm) and popup template (template_popup.htm) files are used to make your script look as though it is part of your site.
    
   For details on template files, click here.
     
   Note: When editing the template files, you must always include the $REPLACE variable.  This is to indicate where the script should insert the HTML which is generates.

1. Login to your ftp server once again.  You may still be logged in from before.
    
2. Create a directory called RatingsHandler under the root directory (main directory for your website) for your website.
   
   Example: http://www.domain.com/RatingsHandler
    
3. Using your ftp client, change to the directory that you created above in step 2.
    
4. Upload the files from the zip file's NONCGI directory to the next directory you just create on your server.
    
5. Your directory will look like this:
    
   /RatingsHandler
     | -- blank.gif
     | -- dot.gif
     | -- popup_01.gif
     | -- popup_02.gif
     | -- popup_03.gif
     | -- popup_04.gif
     | -- popup_05.gif
     | -- popup_06.gif
     | -- popup_07.gif
     | -- popup_08.gif
     | -- rated_1.gif
     | -- rated_10.gif
     | -- rated_10_over.gif
     | -- rated_1_over.gif
     | -- rated_2.gif
     | -- rated_2_over.gif
     | -- rated_3.gif
     | -- rated_3_over.gif
     | -- rated_4.gif
     | -- rated_4_over.gif
     | -- rated_5.gif
     | -- rated_5_over.gif
     | -- rated_6.gif
     | -- rated_6_over.gif
     | -- rated_7.gif
     | -- rated_7_over.gif
     | -- rated_8.gif
     | -- rated_8_over.gif
     | -- rated_9.gif
     | -- rated_9_over.gif
     | -- RatingsHandler.gif
     | -- scale.gif
     | -- template.htm
     | -- template_popup.htm

If NT server, you will want to give the IUSR_XXX (Internet Guest Account) account CHANGE (RWXD) (RWXD) permissions for both the cgi-bin RatingsHandler directory and the non cgi-bin RatingHandler directory which are:

http://www.domain.com/cgi-bin/RatingsHandler
http://www.domain.com/RatingsHandler

When setting change permissions, you will want to have NT propagate (apply) those permission to all files under the directories as well.

Note: You may need to ask your system administrator to set the permissions for you.

1. Set CHMOD 755 on the cgi-bin/RatingsHandler directory. Most likely this was:
    
   http://www.domain.com/cgi-bin/RatingsHandler/
    
2. Set CHMOD 755 on ALL .cgi files (.pl if you changed them) that exist in the cgi-bin/RatingsHandler Directory shown above.
      
3. Set CHMOD 666 on the file vars_main.cgi.
    
4. Set CHMOD 777 on the Data directory.
    
5. Set CHMOD 777 for the non cgi-bin RatingsHandler directory that exist at:
    
   http://www.domain.com/RatingHandler/

1. Point your browser to admin.cgi file which you uploaded. Most likely this is:
    
   http://www.domain.com/cgi-bin/RatingsHandler/admin.cgi
     
   where domain is your domain.
     
2. You will now be presented a login screen.
     
   Leave the ID and Password blank and click the login button.
     
3. Once logged in you will be taken to the Script Settings Screen.
     
4. Here you will define all of your script settings.
     
5. Once this is done,  you will click the submit button to submit the changes you just made. 

Note: This is the admin screen you will be using at all times for admin purposes.

At this point you should define your categories.
 
You can use the navigation at the top of the admin screens to get to the Categories section.

At this point, your setup is done.

You should now put RatingsHandler to a test to ensure everything is setup properly.

You main RatingsHandler script is the RatingsHandler.cgi file.  You will call it such as:

http://www.domain.com/cgi-bin/RatingsHandler/RatingsHandler.cgi

where domain is your domain.