HandyKit v2.1  

 Online
 Index page
 HowTo

HandyKIT packages

 HandyCGI.pm
 HandyList.pm
 HandyMail.pm
 HandyTemplate.pm
 HandyTextDB.pm
 SiteBag.pm

Other packages

 HandySQL.pm
 HandyLog.pm
 HandyCrypt.pm

NAME

SiteBag is a package that gives your site such basics as:

  • Local Banner Network
  • Statistics
  • Links
  • Feedback Form
  • Poller
  • Newsletter list control


SYNOPSIS

Just embed in your code by calling &SB_load_template instead of HandyTemplate's &load_template function. Here's example:

&cgi_start(); 
&SB_load_template('some_template.html');
&cgi_finish();

The whole of your site should be set of templates. And you will get there required functionality instantly!


CONFIGURATION

config.pm

We encourage you to store all your project configuration data in config module inside of hash %cfg. You, of course, can alter config.pm so it will load configs from .txt files also. But please, don't do it directly from modules. However, if you dislike this approach feel free to modify code a little.

actfile

Stands for action log filename. In this file we store all IP's that accessed site, and actions that they was performing. Needed, for example, to prevent double votes in poller.

maxactsize

Maximal size of action log file. If size grows more than specified here, some entries gets expired. One entry is around 30 bytes. The recommended size is 300kb.

adsfile

File has format as describen in HandyTextDB and contains information about advertisement (links and banners). Table rows has following information:

ID is unique ID of banner or link. Can be only digits.

URL is URL that will be jumped on click. "http://.." required.

FAKEURL is an URL that is displayed in status bar of browser.

IMAGEURL is an URL of image, that corresponds to this link/banner.

FLAG is a set of bits. If bit 0 is set, then this is a banner, not a link. If bit 1 is set then this link does not exists (bit reserved for future uses).

BLOCK is a name of banner/link blocks (banners are rotated in banner blocks, links are aggregated into link blocks - here's the main difference).

RATIO should be understood differently. If applied to links, then link with lower ratio will go before link of greater ratio in links block. If applied to banners, then banner with greater ratio will be shown more than others in block. RATIO is a number.

HTMLCODE is an optional HTML code that should be inserted, instead of auto-generated one.

STARTED is a value of perl runtime time() when last reset was made.

VIEWS is an accumulated number of views of this advertisement.

CLICKS is an accumulated number of clicks to this banner/link.

NAME is the name of the link or banner. Use a-z letters and digits.

countersfile

File has format as describen in HandyTextDB and contains information about hits for a pages of your site. Table rows has following information:

TEMPLATE is the name of requested template file.

STARTED a is value of perl runtime time() when last reset was made.

HITS is the total number of hits made to this page.

HOSTS is the total number of NEW UNIQUE HOSTS that come to this page.

INS is the total number of NEW UNIQUE INS from other web sites to this one.

OUTS is the total number of OUTS via advertisement links.

pollersfile

File has format as describen in HandyTextDB and contains information about pollers. Table rows has following information:

NAME QUESTION STARTED VOTES A1 V1 A2 V2 A3 V3 ....

NAME is the system unique name of poller. Should contain only a-z letters and digits.

QUESTION is the question that poller asks.

STARTED is a value of perl runtime time() when last reset was made.

VOTES is the total number of votes since last reset.

Ai is the i-th answer proposition.

Vi is the number of votes for i-th answer.

urlsubstfile

File has format as describen in HandyTextDB and contains information about referrer substitution. Table rows has following information:

REGEXP is the regular expression that is used in substitution, e.g. '.*altavista.*'

RHS is the right side of substitution, e.g. AltaVista

Use this to group well-known referrers to make statistics lighter and clearer.

This is used widely:

$ENV{'HTTP_REFERER'} =~ s/$lhs/$rhs/gis;

Where $lhs and $rhs are taken from the urlsubstfile.

This is often need to hide some "secret referrers" like

http://www.some.com/script.cgi?random=12341234;page=index
is translated to
http://www.some.com/script.cgi?page=index

referersfile

REFERER is the name of referrer after substitutions of referring URL using patterns from urlsubstfile.

REFERERID is a generated unique integer referrer ID.

STARTED is a value of perl runtime time() when last reset was made.

INS is the number of unique hosts that come to us from this referrer.

newsletterfile

File in human-readable format that contains email and full names of subscribers to newsletter.

default_fullname

The default fullname, that is used, if site user has not supplied fullname with email.

emailfrom

Email, that will appear in from address, when notification mails are sent.

formdumpfile

File where information from feedback forms will be saved.

formdumpemail

Additional email address where information from feedback forms will be sent.



TOP
© 2000 || Perl4YOU.com E-mail: info@perl4you.com