Eggdrop Tcl Archive

Extended Description File

.
 __        __   _    ____
 \ \      / /__| |__/ ___|  ___  ___ _ __
  \ \ /\ / / _ \ '_ \___ \ / _ \/ _ \ '_ \
   \ ^  ^ /  __/ |_) |__) |  __/  __/ | | |
    \_/\_/ \___|_.__/____/ \___|\___|_| |_|
                 1.0 by Baerchen, July 2001			
                  for bseen1.4.2c & TCL 8.3
                  baerchen@germany-chat.net

IMPORTANT
**********************************************************************
Bass is in no way responsible or involved in the making of this script
whatsoever. The script contains modified portions of his
bseen1.4.2c.tcl script. If it script does not work, causes problems
or whatever, he is _not_ the appropriate person to contact (look
above for my email adress).

DESCRIPTION
**********************************************************************

WebSeen is a CGI web interface for the seen database created by Bass' 
eggdrop script bseen1.4.2c. It allows any user to query seen data
for a given user. The Tcl does so by searching the bseen database file
which is saved to disc in regular intervals.

REQUIREMENTS
**********************************************************************

- An eggdrop running bseen1.4.2c (earlier versions might work, but not
  tested)
- The webpage containing the form must be on the same server like the
  bseen database
- TCL 8.3 must be available (earlier versions might work, but not
  tested)

Nice, but not necessary (and has to be done by you):

- A very small patch of the bseen1.4.2c.tcl script.

INSTALLATION
**********************************************************************

- configure the script and create an html. In the html, include a
  form like this:

  <form method=GET action=http://yoururl/pathtocgi-bin/webseen.cgi>
  <input type=text value=NICK name=NICK size=20>
  </form>
  
  upload the page to your website.
 
(- patch the bseen script according to instructions given below)
- Upload webseen.cgi to the CGI directory of your website
- chmod it 755

CONFIGURATION
**********************************************************************

#!/usr/local/bin/tclsh8.3

In the very first line, enter the path to the tcl executable. Make
sure you _included_ the # at the beginning. Your line should look
similar to the one above.

set pathtodata "/usr/home/YourBot/bs_data.YourBot"

This is the full path to the bseen database.

set pathtocgi "../cgi-bin/gcwebseen.cgi"

This is the relative path to the cgi

set excludechannels "#foo #bar #foobar"

Any channels you want to exclude from the search? Put them here,
delimited by space

set excludeseenonbot 0

If the script should not return results about users from the partyline
set this to 0, else 1

set maxresults 25

How many results should be returned maximum ?

set htmlfont "verdana"

The generated HTML is quite simple and worth hacking it, however,
here you can adapt the used font.

PATCHING bseen1.4.2c.tcl
**********************************************************************

Originally, bseen saves its data 12 minutes past the full hour. Since
the webseen.cgi requires the database file, more accurate search 
results can be achieved if bseen saves more often. Saving the database
is invoked by this line within the bseen script:

bind time - "12 * * * *" bs_timedsave

Changing this line to

bind time - "*0 * * * *" bs_timedsave

causes bseen to save its data every 10 minutes.
Save and restart the bot (a rehash won't do, since binds survive
rehash'es)

Unneccessary to say that neither me nor Bass take responsibility for
this patch.