Access Counter Manual

WWW Homepage Access Counter and Clock!

For Unix, NT/Win95, OS/2, VAX VMS and Amiga

Official Counter Home: http://www.fccc.edu/users/muquit/

 

[Count Release 2.4]

Table of Contents:

  1. What's new (in 2.4)?
  2. Requirements
  3. Introduction
  4. Features
  5. Directory Structure (Unix)
  6. Digit styles (all platforms)
  7. How to call the program from web page? (all platforms)
  8. Counter options (all platforms)
  9. How to use other styles of digits? (all platforms)
  10. How to create an image strip? (all platforms)
  11. Examples (all platforms)
  12. Error messages (all platforms)
  13. Frequently asked questions (all platforms)
  14. Copyright (all platforms)
  15. Acknowledgment
  16. I like to hear from you
  17. How you can help
  18. ChangeLog (if you contributed, your name is there)

 

What's new (in 2.4):

Please check this section to see new feature in Count 2.4. Look at Section Features for all the features. And please look at the section ChangeLog for latest bug fixes.

Includes the Buffer Overflow security fix.
The maximum number of digits the counter can count and display can be very high. By default the maximum number of hits can be (10^80)-1, which is a very large number, that is if data is not edited by hand, practically it is impossible to overflow the counter.
Wild card can be used in the IP's in ignore host block in the config file. There is no limit for number of IP's (as long as memory is not exhausted).
Wild card can be used in the hosts/IP's in the auth block of the config file. There is no limit for number of hosts/IP's (as long as memory is not exhausted).
The counter can count with image= parameter if df= parameter is specified.
Consecutive "Reload" from the same host will not increment the counter. This feature can be turned off at compile time if desired.
"cache" and expires" parameters can be used to change the caching behavior of certain browsers.
Date in clock is Year 2000 safe. Note, you will not see full year in the counter until the year 2000 arrives.
The source distribution has VMS support now, that means, the source can be compiled on Unix, NT and VMS. VMS port is done by Phil Ottewell phil@pottsoft.demon.co.uk.
(Nov-30-1997).
Meaning of BLOCK 3 of the count.cfg file differs with that of Count 2.3. So if you're using an older config file, change the Boolean in this block.

 

Requirements:

A C compiler (ANSI or non-ANSI).
You should be familiar with Unix operating system in order to install it on Unix. I think if you know what ls command is, you qualify. If your site is configured to run CGI programs from users' space, then you will not need root access otherwise root access is needed.
You must run a web server. The web server must be capable of running CGI programs. If you run several web servers in your domain, you can install the counter in one server and allow the users at other servers to access the counter remotely.
The web server must be running on any of the Unix, NT, OS/2, VMS or Amiga Operating System.

It is reported that the Count 2.3 runs on the following platforms, hopefully 2.4 will be portable as well.

Operating System First reported by
AIX 3.2.5 robtuck@coeibm.rutgers.edu
Amiga albertv@spinnewiel.xs4all.n (ported by)
AU/X jussi.haro@tothepoint.fi
BSDI chris@technonet.com
DEC OSF1 ma_muquit@fccc.edu
DG/UX irrigacion@planet.losandes.com.ar
DomainOS 10.4.1 (on Apollo Workstns) philippe.hubaut@etud.insa-tlse.fr
FreeBSD 2.1.5 tomcat@1lo.lublin.pl
HP-UX takao.tsukiyama@tokyo.tohmatsu.co.jp
Linux ashley@photocraftlab.com
NetBSD makoto@komekome.bay.prug.or.jp
NEXTSTEP 3.3,3.2,4.0 for Mach
(Motorola,Intel)
jk@exnext.com
NT 3.51 (intel) ma_muquit@fccc.edu
NT 4.0 with IIS 2.0 srakhtar@ix.netcom.com
SunOS 4.1.x ma_muquit@fccc.edu
Solaris 2.x ma_muquit@fccc.edu
SCO yuqiao@UDel.Edu
SGI ma_muquit@fccc.edu
SINIX 5.4 (SVR4, MX500I by Siemens Richard.Bothe@mch.sni.de
ULTRIX 4.3 mbarria@ing.puc.cl
UnixWare 2/2.03 ebh@fpk.hp.com
ivanlan@tzuk-te.callware.com
VMS phil@pottsoft.demon.co.uk (ported by)
Win95 null@dent.showa-u.ac.jp
OS/2 dshields@direct.ca (2.3) [ported by)

 

Introduction:

This is a CGI program to keep record of the raw hits of a web page. It generates a GIF image of the number of hits and returns to the browser as an in-lined image. The program also has a run-time option not to show the digit images, this way the hits can be kept without displaying it. The hits can be be monitored without incrementing from a separate page as well. Almost all of the features are run-time options. This program started as a fun to play with CGI programming but due to enormous interest, feature request, input from thousands of you, it has turned in to the most configurable counter on the whole World Wide Web.

 

Features:

Does not require server-side includes.
The maximum number of digits the counter can count and display can be very high. By default the maximum number of hits can be (10^80)-1, which is a very large number, that is if data is not edited by hand, practically it is impossible to overflow the counter. (new in this release).
Wild card can be used in the IP's in ignore host block in the config file. There is no limit for number of IP's (as long as memory is not exhausted). (new in this release).
Wild card can be used in the hosts/IP's in the auth block of the config file. There is no limit for number of hosts/IP's (as long as memory is not exhausted). (new in this release).
The counter can count with image= parameter if df= parameter is specified. (new in this release).
Consecutive "Reload" from the same host will not increment the counter. This feature can be turned off at compile time if desired. (new in this release).
"cache" and expires" parameters can be used to change the caching behavior of certain browsers. (new in this release).
Date in clock is Year 2000 safe. Note, you will not see full year in the counter until the year 2000 arrives. (new in this release).
Uses image strip as well as individual digit images. Using an image strip reduces disk I/o significantly, therefore, it's faster. A program (mkstrip) is supplied to create an image strip from individual digit images.
Comma can be displayed after every 3rd digit from right.
Any one color of the image can be changed on the fly.
Uses netmasks to mask out a range of hosts in the network or the entire network.
Automatic datafile creation, strict mode, use of rgb color database can be controlled from the cfg file at run time.
Any arbitrary GIF file can be displayed. Frame and other attributes of the counter can be applied to the GIF file.
Count 2.0 is backward compatible with Count1.5's URL. One thing to note, the keyword wxh has no meaning in Count 2.0. It was used in Count 1.5 to specify digit dimensions. In Count 2.0 it is not required, because the digit dimensions are determined automatically. Therefore, you can use variable width digit images in this version.
Reasonable default for all QUERY_STRING parameters.
The same program can be used to display time or date.
The time and date of any time zone in the world can be displayed. The time can be displayed in 12 or in 24 hour format.
Supports digit images with variable width.
Counter can be displayed without incrementing (for monitoring etc.)
A literal digit string can be displayed.
A random digit string can be displayed.
The color of the digits can be negated.
The counter can be rotated (only integral of 90 degrees, 90,180,270). The default rotation is 270 degrees.
An ornamental 3D frame can be wrapped around the counter image with user defined thickness and color at run time.
The frame and transparent color can be a name (e.g. red,green,pink etc.). The color can be specified as a hex string, e.g. ffffff, ff0000 etc. as well as RGB triplets as before.
Single program for any number of users for any number of web pages.
Any color of the counter image can be made transparent at run time.
Style of digits can be specified at run time.
Authorized host names can be in the configuration file. Authorized hosts are those which can run the counter remotely. Do not confuse this with visitors from certain hosts.
IP filtering through a configuration file at run time. Any number of hosts can be ignored from counting. A netmask can be used to filter out a specific range of host in a network or to filter out the entire network. It's a good idea to ignore your own host or entire domain. Gen-conf program will let you create the configuration file interactively.
Data file locking. Data file will not get clobbered by simultaneous Count.cgi processes. NOTE, locking may not work if the counter's datafile is on a NFS partition.
Maximum number of digits can be set or counter can be displayed with exact number of digits at run time.
User will be able to specify a start-up counter value at run time. This will take effect if the data file does not exist. You will be prompted by the configuration program if you want this feature or not.
If you do not want to display the counter but like to keep the hits on your page, sh=0 can be defined in the QUERY_STRING at run time. It will write a 1x1 transparent GIF image to the browser but the counter in the data file will be incremented all right.

 

Directory Structure (Unix):

Before going to the configuration procedure, please browse through the default directory structure below. It will help you answering questions of the configuration script. You can change the name of the directories as you please, but keep the directory structure same, it will make your life much easier. You do not have to create any of these directories, they will be created for you by the Count-install program. Only thing you probably have to create are the individual datafiles (keep reading).

/usr/local/etc/Counter          <- Base Directory
    |-- Log                     <- Log Directory
    |   `-- CountX.X.log        <- Log file
    |-- conf                    <- Conf Directory
    |   `-- count.cfg           <- Configuration file
    |-- data                    <- Data Directory
    |   |-- sample.dat          <- data files
    |   |-- joe.dat
    |   |-- harry.dat
    |   `--
    |
    |-- digits                  <- Digit Directory
    |   |-- A
    |   |   `-- strip.gif       
    |   |-- B
    |   |   `-- strip.gif
    |   |-- C                   Digit sub-directories and
    |   |   `-- strip.gif       image strip of different styles
    |   |-- D
    |   |   |-- lenna.gif
    |   |   `-- strip.gif
    |   |-- E
    |   |   `-- strip.gif
    |   `--
    `-- rgb.txt                 <- color name database

Base Directory is the directory where all the sub-directories and the files related to counter reside.

Log Directory is the directory which holds the counter Log file. Counter error messages or if someone tries to access your counter remotely, warning message regarding this is written to this file.

conf directory holds the configuration file for the counter. configuration file holds information in 4 blocks. Each block resides between a left and right curly brace. This file is created by the program Gen-conf and can be hand crafted later. After creating the file, please read the comments in the file.

data directory holds all the datafiles for the counter. The datafiles stores the access counts of web pages. Each page must have a separate datafile. The datafile is specified at run-time. You will know about it later.

digits directory holds sub-directories with various styles of GIF digits. For example, A sub-directory holds the green led digits. The sub-directories have GIF digit files named zero.gif, one.gif...nine.gif. you will know about it later.

rgb.txt file is used to convert a color name (for example, cyan) to the appropriate red, green and blue color component. This file came from X consortium and supplied with the distribution. You will know about the file later.

 

Digit Styles (all platforms):

The digits used in this program can be individual GIF files or all the digits can be in a single image strip. This gives flexibility of using digits of your choice. In case of individual digit images, they are named as zero.gif, one.gif,.... nine.gif. In case of image strip, the strip is named as strip.gif. At run-time, simply the directory of the images is specified to use a different style. Therefore, a single program can display digits of various styles. Here are the supplied digit styles. I will not supply individual digit images anymore. All the styles of digits are supplied as a single image strip. Note the order of the digits (you will know about it later).

Style A A.gif (468 bytes) designed by the author
(digits/A/strip.gif)
Style B  B.gif (1505 bytes) Borrowed from HTML-access counter. (digits/B/strip.gif)
Style C  C.gif (760 bytes) designed by benjamin@pop3.oro.net
(digits/C/strip.gif)
Style D D.gif (313 bytes) designed by the author
(digits/D/strip.gif)
Style E  E.gif (261 bytes) designed by the author
(digits/E/strip.gif)

For a huge collection of GIF digits, check out the Digit Mania page.

This program will work with any digits from the Digit Mania page. To use those digits, create subdirectories say, F, G, H, foo etc. inside the digits directory and rename the images to zero.gif, one.gif..nine.gif. I suggest create an image strip out of these digits and use it instead of using individual images.

Before using these digits, please read the sections How to use other styles of digits and How to create an image strip.

 

How to call the program? (all platforms):

You can refer to the program from web page like this:

<img src="/cgi-sys/counter.cgi?df=sample.dat" align=absmiddle>

The string between ? and " is called the QUERY_STRING. Make sure there is no newlines in the <img src= line and no space in the QUERY_STRING. Here in, df=sample.dat, df means datafile and sample.dat is the counter datafile. The counter stores the hits in this file. This datafile is supplied. If you configured the counter to allow automatic datafile creation (look at count.cfg file), you can specify a datafile with df like df=count.dat. The file count.dat will be created for you if the permission to the data directory is correct.

If you configured not to allow automatic datafile creation (good thing), you have to create this file in the data directory. cd to the data directory and type:

    echo 1 > count.dat

The counter program has lots of options, you can make it work and look the way you desire. In the query string, you can use the options described in the table below. The options can be separated by a | or a &. You can use either one or combination of both. Here is an example:

<img src="/cgi-sys/counter.cgi?ft=T&frgb=gold|df=sample.dat" align=absmiddle>

The options can be in any order and not case sensitive.

Anyway, look at this Example Page you will get the picture.

 

Counter options (all platforms):

[Originally written in HTML table by Kevin]

Parameter Name Description Default
cache=B
expires=X
These parameters can be used to change the image caching behavior of certain web browsers. The Boolean value of cache hints the browser whether to cache the image or not. The integer value of expires specifies the cache expiration duration time in seconds. If you specify cache=F, the browser will be hinted to cache the image for the amount of seconds specified with expires parameter. if cache=F and expires=0, then the browser should not cache the image, that is whenever you come back to the page, the counter or clock will be refreshed. Use this feature with discretion as it may increase load on your system. The expires parameter is meaningless without cache=F, that means, if cache=T is specified, expires parameter is ignored and the counter will not generate any HTTP Expires header. This is the default behavior. The valid values for the Boolean parameter cache is Y,N,F,T 1 or 0. The valid integer range of the expires parameter is between 0 and 604800 (7 days).

Note, these parameters will work with browser supports the HTTP Expires header as specified in HTTP specification. By default, most web browsers caches the image got from the counter. That means, if someone visits your page and comes back after a while, the counter or clock does not get refreshed.

cache=T
expires=0
display=X Specifies what to display. A valid string can be specified with display= parameter to display counter, clock or date. The valid value for the string parameter X is counter, clock or date For counter, this parameter is not need as counter is the default display type. display=counter
timezone=X Display time/date of the specified timezone. The parameter timezone= is only significant with display=clock or display=date. Use this parameter if you want to display time or date of another timezone. The timezone must be specified with a negative or positive four digit offset from GMT, for example: timezone=GMT-0500 or timezone=GMT+0000 or timezone=GMT+0530. The routine to display time of various time zones are written in a generic way. Therefore, the Unix machines will not be aware of daylight saving time because of the way the routine is written. For example, if daylight saving time is on, to display time of NY, the timezone will be timezone=GMT-0500 instead of timezone=GMT-0400.

If the clock displays your local time wrong, specify your timezone with that parameter in order to display the correct time.

None.
tformat=X Time format in 12 or 24 hour. This parameter can be used to display time in 12 or 24 hour format. The valid values for the parameter X is 12 or 24. tformat=12
dformat=X Specifies date format. This parameter is only significant with display=date. The valid value for the string parameter X is any combination of MMDDYY (Month-Day-Year). For example, dformat=ddmmyy, dformat=YYMMDD. dformat=MMDDYY
istrip=B Use of image strip On/Off The Boolean value of istrip specifies whether to use image strip or not. If you specify istrip=F, the program will look for the individual digit image files in the digits/style directory. The valid values for the Boolean parameter istrip are Y, N, T, F, 1 or 0. istrip=T
ft=X Frame Thickness You can wrap the counter in an ornamental frame of X pixels thick. Use 0 for no frame. Values over 5 make a nice 3-D effect. ft=4
frgb=R;G;B
or
frgb=RRGGBB (in hex)
Frame Color Specifies the color of the frame in RGB (red/green/blue) format. Each color component, R, G, and B is specified as a value between 0 and 255. If you use ft= without a frgb= param, the default color is used.

If you specify a frgb= without a ft=, then the frame thickness defaults to 5. All the examples show ft=5. The color can be specified as hex string or a name. Do not use a # before the hex string as Netscape. For example, if you want to specify white in hex, use frgb=ffffff. You also can use a color name (e.g. frgb=blue) if the counter configured to do so (look at the cfg file). Look at the color name mapping database for some hints about color name database.

frgb=100;139;216 or
frgb=648bd8
tr=B Transparency On/Off You can specify if your counter image will have a transparent color with the Boolean B. So tr=Y means there will be a transparent color. It does not matter if the GIF files used for the digits are "transparent"; you must specify explicitly which color to make transparent. If you specify a trgb=, then you do not need to specify tr=Y. If you specify tr=Y and do not specify trgb=, then the default color black will be transparent. The valid values for B are Y, N, T, F, 1, or 0. tr=F
No Transparency
md=X Max Digits Defines maximum number of digits to display. Any value between 5 and 10 inclusive are permitted. Padding with leading zeros is automatically done for you; longer counts are truncated to the given X. md=6
Without padding
pad=B Left padding with 0s Turn padding on/off in conjunction with md= setting. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. pad=N
Without specification of a md=value

pad=Y
With specification of a md=value

dd=A Digit Directory Denotes directory of a specific styles of digits. Four styles of digits are supplied. They are kept at the directories A,B,C and D respectively. Visit the digit mania page for other styles of digits. dd=A
My green LED digits
image=gif_file Display this GIF file You can display any GIF image specified with this parameter. The location of this file is determined by the dd= parameter, that no path in the GIF file is allowed. All attributes of the counter apply to the image. Not, if you specify a datafile with df parameter and if incr is true, then counter will be incremented in the datafile. None
comma=B Display comma after every 3rd digit from right. The Boolean value of parameter comma specifies whether to display comma after every 3rd digit from right. If you use this parameter as true, the left padding with zeros will be turned off. comma=F
srgb=R;G;B
or
srgb=RRGGBB (in hex)

prgb=R;G;B
or
prgb=RRGGBB (in hex)
Change a color of the image to a target color on the fly. Any one color of the image can be changed to a different color on the fly. srgb stands for source color, that is the color to change. prgb stands for pen color, that is the target color. The values for srgb and prgb can be colon separated color components (e.g, srgb=255;0;0), a hex value (e.g. srgb=ff0000) or a color name (e.g. srgb=red). The color name can be used if you configured the counter to do so (look at the cfg file). srgb=00ff00
(0;255;0 green)

prgb=00ffff
(0;255;255 cyan)

With chcolor=T

chcolor=B Change a color of the image. This parameter is usually used to change the default green color to cyan. That is if you specify chcolor=T, and you want to change green to cyan, then you do not need to specify srgb and prgb parameters. 1x1 GIF is displayed. The valid values for the Boolean parameter B are Y, N, T, F, 1, or 0 chcolor=F
st=X Start Count This parameter is used to set the initial value of the counter to some number X. This is only valid if you decided to allow automatic datafile creation. It is a bad practice to allow automatic datafile creation, however it makes site maintaining easier. The automatic datafile creation option is specified in configuration file and can be changed at run time. Note that this parameter has no effect if the datafile already exists. If you want to change the counter value in a existing datafile, hand edit the file. The minimum value for st is 1. st=1
Count starts at 1
sh=B Show digits Used to turn display of digits on or off according to the Boolean B. When sh=T, counter will be displayed and incremented, this is the default behavior.

If sh=F no digits will show, but the counter will still increment; instead of digits a transparent 1x1 GIF is displayed. The valid values for the Boolean parameter B are Y, N, T, F, 1, or 0

sh=Y
df=data_file Datafile to store count Specifies the name of the file for storing the count in. The file must be allocated to you as was mentioned in the "Authorizations" section above. You can use df=random to display a random number.

One special use of the parameter is df=RANDOM. This returns a random number using the fractional portion of the host's time of day clock as a seed for the generator. Unlike all other WWWcounter parameters, the file name provided is case-sensitive, except for the value random. Or Random, or rANDOM, etc.

df=random
if no datafile is specified
incr=B Increment Count Makes it possible to display the current count without incrementing the count. This can be used to examine the count for reporting or other purposes without adding to the count. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. incr=T
Increment the counter
lit=X Display literal Makes it possible to display a given, predetermined string. The valid values for the string X are digits, a,p,: and - None
negate=B Negate the color Makes it possible to negate the color of the counter digits. Note that the Frame is exempted from negating. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. negate=F
Do not negate
degrees=X Rotate X degrees Makes it possible to rotate the counter image X degree. The possible values of X is 90, 180, 270 and 360. Note 360 is meaningless as the counter will come back to the original 0 degree. degrees=270
With rotate=Y and without degrees=X
rotate 270 degrees clockwise
rotate=B Rotate On/Off The Boolean value B turns on or off rotating. If you use degrees= setting, rotate is not needed. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. rotate=F
Do not rotate

 

How to use other styles of digits:

There are several sites including Digit Mania which maintains a array of collection of GIF digits which can be used with the counter. The counter program can use these digits in 2 ways.

  1. use a individual digit image for each digit, for example, zero.gif, one.gif...nine.gif. These digit images reside in the digits/style directory. If you like to use the counter for clock, 3 additional digit images are required, e.g., colon.gif, am.gif and pm.gif. If you want to use comma in your counter digits, another image is required, e.g., comma.gif. If you want to use the counter to display date, one more image is required, e.g., dash.gif. If you collect digits from external source, do not forget to rename the images to zero.gif, one.gif, two.gif, ... nine.gif, colon.gif, am.gif, pm.gif, comma.gif and dash.gif
  2. use a single image strip for digits. This is the default behavior, that is the counter program looks for a image file called strip.gif in digits/style directory by default. Using an image strip is much more efficient than using individual digits, because
    1. the size of an image strip is almost always less than the combined size of individual images.
    2. Disk i/o is significantly reduced, because only one file needs to be opened instead of many.

The section How to create an image strip describes how to create an image strip from individual digit images. If you like to use the individual digits instead, you must use the option istrip=F when you call the counter from web page, because by default istrip=T.

 

How to create an image strip:

If you have individual digit images, you can create an image strip out of them. Image strip reduces disk i/o significantly, because the counter will need to read only one image instead of many and the size of the image in most cases will be less than the combined size of the individual images.

A program called mkstrip is supplied to create the image strip from individual digit images. Another program called extdgts is supplied to extract individual GIF images from the strip.gif (made with mkstrip). extdgts is there to help you out if you need to extract the digit images for some reason.

To compile the programs, go to the utils directory and at the shell prompt, type:

    make

Before using them, copy mkstrip and extdgts somewhere in your path, otherwise you'll get error "command not found."

Now, go to the directory where all the individual digit images are and type:


mkstrip zero.gif one.gif two.gif .... nine.gif colon.gif am.gif pm.gif > strip.gif

Note, the file names are not important but the order is very important. For example, the file names may be 0x.gif, 1x.gif etc.

Create a directory say F inside the digits directory and copy or move the file strip.gif to F. You can use this strip with dd=F.

The above strip can be used for counter and clock but not date. It also can NOT be used if you want to display comma. If you want to use date and comma, you must have the image for comma and dash. For example, the strip of digit style A is created with the command:

mkstrip zero.gif one.gif ... nine.gif colon.gif am.gif pm.gif comma.gif \
    dash.gif > strip.gif

Please note the order of the images used in arguments carefully. The program mkstrip puts the necessary information in the GIF comment extension about the strip. The counter program parses the comment extension to determine the width of the individual digits in the strip. Therefore, the strip can have digit segments of variable width.

For example, the comment of the image strip of digit style A is:

15:0:15:30:45:60:75:90:105:120:135:150:165:180:195:210:225

The leftmost integer 15 indicates there are 15 individual digits in the image and the next colon separated pairs are the location of left and right side of the segment of the individual images from the leftmost edge. If you look carefully you will see that the individual segment of the strip is 15 pixel wide. The height is determined by reading the image. If you use the program mkstrip, you do not need to know anything about the comment, it will be created correctly for you. It is mentioned here because it is possible you obtained a strip from somewhere and you want to add the comment to the image.

 

Examples (all platforms) (link)

 

Error Messages:

Count will try to return an image in any event. That is, even if it fails for some reason, it will write the error messages in GIF format. The text error messages also will be written to the counter log file defined with LOG_FILE in the directory defined with LOG_DIR in the config.h file. The program Count-config asked about these if you remember.

If you see any of these images, please check the Counter log file you defined with LOG_DIR and LOG_FILE. If the program could not create the log file, it will write the error messages to stderr. In that case if you configured your httpd server to write the log to a file, the error messages will the written to this file.

 

Frequently Asked Questions:

  1. My CGI scripts don't work. What's wrong?
  2. I get errors while compiling on SGI, what's the problem?
  3. Why does the counter show "888888" all the time?
  4. The counter does not compile on UnixWare with cc, why?
  5. The counter does not compile on Solaris with cc, why?
  6. I get an error message "Could not write to counter file: x/y/sample.dat". What's the problem?
  7. What does it mean when you say "user running the web server"?
  8. The counter seems to display random number. What's the problem?
  9. I get an error message "Host foo.com is not authorized". What's the problem?
  10. What's the format of the data file?
  11. How can I reset the counter?
  12. How this program handles remote execution?
  13. What's the maximum number of hits the counter can handle?
  14. I sent you so many mails, how come you never respond?
  15. How can I turn off "Reload Ignore" feature?
  16. Is there any way to compile the counter without running the configuration scripts?
  17. Why do I have to add a line to the config file every time I add a new virtual host?
  18. The counter does not seem to increment, what's going on?
  19. How to configure the counter on virtual servers?
  20. The counter seems to reset to zero occasionally, what's going on?
  21. While compiling, I get a message sh: ar: not found, what's the problem?

1. My CGI scripts don't work. What's wrong?

Answer: Simply linking from your page to an executable program or script won't cause it to be run by the server. There are two common arrangements: either files in directories specially designated by the server administrator are executed as CGI scripts, or files with a special extension (such as .cgi) are executed as CGI scripts.

These are just two possible ways your server might be configured. Many sites don't allow users to run CGI scripts at all. Consult your web server's administrator.

Taken from WWW FAQ

2.I get errors while compiling on SGI, what's the problem?

Answer: In SGI you might get errors like:

       : libCombine.a
       : - Too many arguments
       *** Error code 1 (bu21)
       *** Error code 1 (bu21)

To make it work, in libs/combine/Makefile, remove the line

    $(RANLIB) $@ 

Or, try setting SHELL to sh, for example: setenv SHELL "/bin/sh" Thanks to avarro@CENTRCN.UMontreal.CA (12/07/95)

3. Why does the counter show "888888" all the time?


Answer: The counter is running in strict mode (look at count.cfg file). When the counter runs in strict mode, if the browser does not return the environment variable HTTP_REFERER, the counter will display the image 888888 instead of serving the counter. The environment variable HTTP_REFERER should contain the web page running the counter. Some browsers does not return this variable in <img GET method.

4. The counter does not compile on UnixWare with cc, why?

Note for UnixWare 2: Before running the configure script, set and export the environment variable CC to the string

    cc -Xc

Thanks to Ed Horch, ebh@fpk.hp.com

5. The counter does not compile on Solaris with cc, why?

If you are using Sun's stock cc on Solaris, you may get errors about identifier redeclaration. Try defining -D__STDC__=1 in Makefile, it might work. You should not have any problem if you compile with gcc or ucb cc on Solairs.

6. I get an error message "Could not write to counter file: x/y/sample.dat". What's the problem?

Answer: That means the user running the web server can not write to the datafile. The correct way to make it work is to change the owner of the datafile to the user running the web server and give read/write permission to that user only. You can only do that if you're the super user. If you are not super use, you have to give read/write permission to world. In Unix, "chmod 666 file" will do that. But this will allow anyone to edit or delete your datafile.

7. What does it mean when you say "user running the web server"?

Answer: Web servers can be configured to run the CGI program as a unique user and a group. In apache web server, the user and the group is specified with the directive User and Group in httpd.conf file respectively. I suggest create a unique user and group first. For the user, put a * in the password field in passwd file and use /bin/true as its shell. This way this user will never be able to login to the system. And all CGI programs should be owned by the user and read/write/execute permission to be given to that user only. Most of all, make sure you look at all the CGI programs in your system. CGI programs are always a security risk. But if you configured your server to execute CGI programs as a unique non-privileged user, the damage to your system will be minimal, in case security is compromised due to CGI programs.

8. The counter seems to display random number. What's the problem?

Answer: If you do not specify a datafile with df= parameter, the counter will display a random number.

9. I get an error message "Host foo.com is not authorized". What's the problem?

Answer: Find the file count.cfg. Edit it with your favorite text editor. Add the hostname in the error message at block 5. If you do not have access to the file, you have to ask the person who installed the counter.

If you are running a system with many virtual domains, you will probably want to list your IP addresses with wildcards. This prevents you from having to add an entry every time a new virtual domain is added. As of version 2.4, the referrer host will be looked up in DNS if the USE_DNS directive is defined during compilation. Look at the comments in file src/Makefile.in for instruction.

For example, if you have the class C IP address of 192.160.166.[1-254], instead of listing every virtual host in this domain you could add:

192.160.166.*

to your config file at block 5. Note that this feature will NOT work with versions prior to Count 2.4.

10. What's the format of the data file?

Answer: The counter data file is a text file. The format of this file is:

        digits:IP

     Example:
        5678765456723456787567876567856:131.349.3.10
    

The digits are the numeric ASCII characters and IP is the IP number of the last host visited the page. However, if you compiled with the flag COUNT_RELOAD= -DCOUNT_RELOAD=1 in src/Makefile, then the datafile will only have the digit part.

11. How can I reset the counter?

Answer: To reset the counter, find the file specified with df= parameter, edit it with your favorite text editor. If you do not have access to the datafile, your sysadmin has to do it for you.

12. How this program handles remote execution?

Answer: If you do not know, in most cases any CGI program can be executed remotely without visiting the page with a browser. For example, a CGI program x.cgi (say it returns an in-lined image) in foo. com can be called from foobar.com as follows:

    <img src="http://foo.com/cgi-bin/x.cgi">

That is, someone somewhere on the Internet can refer to your counter and increase the hits and you will not have a clue. You will get the false impression of many people visiting your page.

So how this program handles this? The counter program tries to get a environment variable called HTTP_REFERER for remote referrer. It is necessary to check this variable because when someone remotely refer to a CGI program to your machine, the variable REMOTE_ADDR will be the address of your machine. So checking REMOTE_ADDR will not work. Most of the modern browsers returns the env variable HTTP_REFERER. If the browser does not return the variable, counter will be served anyway. But you are not lost totally here. If you decided to ignore count for your host running httpd, the counter will be served but it will not be increased. So, I suggest ignore count for your own host. Gen-conf program is used for generating the configuration file.

Note this is a simple solution of a complex problem. Due to the architecture of the web itself, a determined evil hacker can always circumvent it.

13. What's the maximum number of hits the counter can handle?

Answer: By default compile time option, it can handle digits up to 80 character long. However, this can be easily increased by editing the MAX_DIGITS directive in count.h. Now a pop quiz, if a site gets one million hits/day, in which year the counter will overflow?

14. I sent you so many mails, how come you never respond?

Answer: I receive enormous number of mails. Please understand that no way I can answer all of the mails I receive. If the problem can be solved by reading the documentation, you won't hear from me, otherwise I try my best to respond. But often I just have too much to do and mails pile up. If you do not hear from me in 3 days, please send the mail again but please note, your question should not be "please tell me how to install the program".

15. How can I turn off "Reload Ignore" feature?

Answer: Before running sh ./configure, edit the file src/Makefile.in and uncomment the line #COUNT_RELOAD= -DCOUNT_RELOAD=1. That is, remove the # from the beginning. Then run sh ./configure and follow the steps of compiling normally. If you already ran configure, then edit the file src/Makefile instead.

16. Is there any way to compile the counter without running the configuration scripts?

Answer: You might have though about it if you're running configuration scripts each time a new version is available. It is always a good idea to run the configuration scripts before compiling the counter. However, it may not be necessary all the time unless something changes (which will be documented with the release). Compile and install the counter normally as instructed in the section Steps to compile and install. Then copy the file src/config.h to somewhere safe. Then when a new update of the counter source code is available, after extracting the source, copy the saved config.h to the src directory and run ./configure and follow the normal steps of compiling. After compilation, test it out from command line. When satisfied, copy the file src/Count.cgi to your cgi-bin directory.

17. Why do I have to add a line to the config file every time I add a new virtual host?

Answer: It's a security feature, to prevent users on other systems from using your host as a "counter server". For information on automatically recognizing new virtual hosts as they're added, see the answer to question 9. (Contributed by: Sean Reifschneider jafo@gateway.tummy.com)

18. The counter does not seem to increment, what's going on?

Answer: It's a feature in the new release. It will only increment, if the visitor's IP and the one in the datafile (last visitor) differs. It's there to handle if people press "Reload" button continuously. If you do not like it, you can turn it off at compile time. Please read the answer the Question 15.

19. How to configure the counter on virtual servers?

Answer: After running Count-config normally, edit src/config.h and change any references to directory paths in line 13,15, 16 and 17 to include the part of the path your virtual server can see. For example, if the real path is /user/mysite/local/etc/httpd/cgi-bin, while the virtual server might only access /usr/local/etc/httpd/cgi-bin.

(Contributed by: Jim Morrissey j.morrissey@videowaves.com.)

20. The counter seems to reset to zero occasionally, what's going on?

Answer: The counter program does NOT check for disk capacity. If you are out of disk space, and if a page is accessed at this time, the data file associated with this page will be reset to zero. It is a bug/feature exists in all versions of the counter. So watch the disk capacity once in a while. There will be a fix in the next release.

21: While compiling, I get a message sh: ar: not found, what's the problem?

Answer: You see this message, because the location of the program ar is not in your PATH. You need to find out the location of ar first. To do this at the shell prompt type:

       find / -name ar -print

If you are on a Solaris box, the output might look like: /usr/ccs/bin/ar . Here /usr/ccs/bin is the directory where ar is located. You need to add this location to your path. To do this, if your shell is csh or its variant, edit the file .cshrc and put a like like:

       set path = ( $path /usr/ccs/bin )

Then source the file by typing: source .cshrc
If your shell is sh, bash or a variant of sh, edit the file .profile or .bashrc and put a like like:

    PATH=$PATH:/usr/ccs/bin
    export PATH

Then source the file by typing: . .bashrc

Copyright (all platforms):

Copyright 1995-1998 by Muhammad A Muquit. Permission to use, copy, modify and distribute this program is hereby granted without fee, provided that this copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. If the program is included in a book, publication or in a software distribution media for sale, the author must be notified about it. If source is modified or enhanced and used in a public site, the source code must be made public on request and it must be clearly mentioned in the documentation what was modified.

THIS PROGRAM IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHOR Muhammad A. Muquit BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTUOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Note: This program is developed in my own time. My employer has nothing to do with it.

 

Acknowledgment:

Thanks to John Cristy for ImageMagick. I took many routines from ImageMagick for the GIF image combining library. I borrowed the font array and some code from gd library. Thanks to Tom Boutell. Thanks to Philip A. Nelson (phil@cs.wwu.edu) for writing GNU bc. I took a portion of the library to add two big numbers. Special thanks to Kevin J. Walsh. Without Kevin, the counter won't be in the current stage. Kevin did the major code overhauling in Count version 2.0. Thanks to all of you who showed interest in the counter program. I had fun writing it.

 

I like to hear from you:

If you are using this program, I like to hear from you. If you are having any problem with the program, please let me know as well. Feel free to send any suggestion. If you think that the program is cool, please consider sending me a picture postcard of the area where you live. Thanks to all of you who sent me the nice postcards. I really appreciate it.

snail-mail:
Muhammad A Muquit
Fox Chase Cancer Center
Research Computing Services (C119)
7701 Burholme Avenue
Philadelphia, PA 19111
USA

E-mail: ma_muquit@fccc.edu

Thanks.

Enjoy!

How you can help:

I volunteer my time to develop and maintain this program. Here is a list of tasks you can do to contribute to this effort:

Make this documentation better. Check for typos, grammatical mistakes and inconsistencies.
If you port it to a new platform, encapsulate the platform specific code with ifdef.
If you have some cool idea, let me know.
Report bugs.

 

ChangeLog:

If you contributed or suggested something and if your name is not here, please drop me a line and get the credit.

Count 2.4:

Count-install is changed. If you're installing as root and specify the user and group the web server run as, the install program will change the ownership and group of the datafile and the log directory to that user and group only. Before everything was owned by the user, which is not necessary.
(May-09-1998).
bigplus library was called without initializing properly. I got some reports that on certain platforms, counter increments by 1000 sometimes. This should fix it.
(Apr-26-1998).
Thanks to Robert Edmonds and Muhammad Riza cadmandu@cbn.net.id for explaining the mystery of IE 4.01 and gzip compressed files with .gz extension.
(Mar-25-1998).
Added valign=top to the options table, it looks nicer now. Suggested by m.c. schraefelmschrae@uvvm.uvic.ca.
(Jan-03-1998)
Added the FAQ about virtual servers.
(Jan-03-1998).
People running virtual hosts can list only there IP addresses instead of having to add each virtual domain name to cfg file. Can be activated the code at compile time with the flag -DUSE_DNS at src/Makefile.in. Patch sent by Sean Reifschneider, jafo@tummy.com.
(Nov-22-1997).
Count-config was not working properly. Thanks to Ashley M. Kirchner, shley@photocraftlab.com.
(Nov-22-1997).
It was reported that counter sometime leaves zero size datafiles. Now, before calling ftrucate(), check if there's anything to write. truncate only if there's something to write. Thanks to xsw@ornl.gov, Brian S. Wallace.
(Nov-21-1997).
mkstrip directory is moved from utils to utils/mkstrip.
(Nov-15-1997).
The colon digit in digit style D was not black. Thanks to Engler, Eric, englere@smtps.saia.af.mil.
(Nov-13-1997).
A bug in Count-install script showed up due to the change in source directory structure. The location of Count.cgi was hard coded at the current working directory. Thanks to Chris Bowlby 015940b@dragon.acadiau.ca.
(Nov-11-1997).
to_str in safeStrcpy() was not getting NULL terminated all the time. mhpower@mit.edu
(Nov-10-1997).
More security patches by Matt Power, mhpower@mit.edu. It was possible to overflow some static buffers used in sprintf.
(Nov-09-1997).
Changes in source code structure. The main source has been moved to src directory. A toplevel Makefile is provided.
(Nov-07-1997).
The users who are getting "Source buffer is NULL in safeStrcat()" should be fixed now. Thanks to Wincom Administrator, admin@wcis.com.
(Nov-07-1997, 11:25 PM EST)
Some security patches by Matt Power, mhpower@mit.edu. It was possible to overflow some static buffers.
(Nov-07-1997).
There were some typos in Gen-conf and parse.c. Thanks to Craig Brockmeier, craig@picasso.ppco.com.
(Nov-05-1997).
A malloc bug was in utils.c. Thanks to Steven D. Chen, steven.d.chen@boeing.com.
(Nov-05-1997).
Implementation of safeStrcat() was incorrect. patch sent by Matt Power, mhpower@mit.edu.
(Nov-03-1997).
If "image" parameter is used and no datafile is specified, ignore counting silently.
(Nov-02-1997).
"Reload Ignore" feature can be turned off at compile time by defining the directive COUNT_IGNORE in src/Makefile.
(Nov-01-1997).
If the content of the datafile was 0, IP as not getting added to the content at all.
(Oct-30-1997).
If QUERY_STRING is empty, it was not showing the proper error message. Thanks to Mark Gilmore, mark@smtek.com.
(Oct-30-1997).
Hostnames in auth block was case sensitive. Patch sent by Takeshi OKURA, okura@osa.ncs.co.jp.
(Oct-30-1997).
There was a bug in date display in 24 hr format with "tformat=24". I don't remember who reported it.
(Oct-28-1997).
Some unnecessary include headers were left in bigplus.c. Compilation was failing on FreeBSD. Thanks to Greg King ,king@c-com.net.
(Oct-25-1997)
It was possible to go up directories with dd= parameter. Thanks to Pauli Ojanpera, ojapa@japo.fi.
(Oct-21-1997)
Gen-conf was creating wrong count.cfg file about rgb.txt. Thanks to Bill O'Neill, woneill@pobox.com.
(oct-21-1997)
Makefile.in in utils directory was wrong. Thanks to Heicher, hexular@concentric.net.
(Oct-21-1997)
comma=T used to core dump on Solaris 2.5. patch sent by James Burton, jamesb@aone.com.au
(Oct-21-1997)

Count 2.3:

Buffer overflow vulnerabilities are fixed. They are very quick fix and I might have overlooked something. Please let me know. There was a bug with image= parameter related to relative path. It's fixed as well . These fixes only apply to the source distribution. The binary distributions of other platforms still have these bugs. (Oct-17-1997)

Count 2.2 (January 16, 1996):

There was a logic problem in determining AM and PM. Thanks to (stephen@txdirect.net). 01/18/96
Strict mode (detect if browser returns HTTP_REFERER) is a configurable option.
An error was in the code related to ACCESS_AUTH directive. Reported by c2dhanle@CompApp.DCU.IE

Count 2.1 (January 15, 1996):

The bug related to st parameter is fixed.
The same program an be used to display time or date.

Count 2.0 (December 27, 1995):

Configuration scripts. You should not to need to hand edit any file in order to compile and install the counter.
Reasonable defaults for all QUERY_STRING parameters. Implemented by Kevin J. Walsh
QUERY_STRING parameters can be in any order and not case sensitive. Implemented by Kevin J. Walsh
Counter can be displayed without incrementing. Implemented by Kevin J. Walsh
A literal digit string can be displayed. Implemented by Kevin J. Walsh
A random digit string can be displayed as counter. Implemented by Kevin J. Walsh
Colors can be negated, that is counter can be displayed as a negative copy.
The counter can be rotated (integral of 90 degrees, 90,180,270 degrees).
No need to specify width and height of digit images.
The frame and transparent color can be a name (e.g. red, violet etc), a hex string (e.g. ffffff, ff00ff, dddddd etc.) as well as RGB triplets (e.g. 160;255;0, 0;0;0 etc) as before. Implemented by Kevin J. Walsh
The counter can be called as simply as:
    <img src="/cgi-bin/Count.cgi?df=count.dat">
 or as complex as before. or any attribute can be set independently.       

Count 2.0b:

Log directory was not created by the Count-install script. (Thanks to robertg@zoom.com). (12/07/95).

Thanks to John Anthony Ruchak for beta testing Count 1.5.

Count 1.5 (September 11, 1995):

can be compiled with -DALLOW_FILE_CREATION option. if compiled with this option, the data file will be created if it does not exist in the directory defined with DataDir and the value defined with st in QUERY_STRING will be written to it. (suggested by John Anthony Ruchak.
Advisory data file locking. Datafile will not get messed up by simultaneous Count.cgi processes.
Error messages are converted directly from string to image. No included GIF images are needed, will be beneficial for system with low memory. I borrowed the font array and some code from gd library. Thanks to Tom Boutell
Authorized host names can be in configuration file.
The hits on the web page can be counted without displaying the digits. suggested by Andres Sepulveda.

Count 1.4 (August 27, 1995):

wigingto@umr.edu suggested to use HTTP_REFERER for checking remote access to the counter.
randerso@bite.db.uth.tmc.edu sent some code segment to account for port numbers at the end of a referrer URL.
Ornamental frame with user defined color and thickness on the fly.
maximum number of digits can be >= 5 or <= 10 (if you use md) (on the fly).
if pad=0, the exact number of digits will be displayed without left padding with zeros (on the fly).
Any color of the digits can be made transparent on the fly.
Digit style can be provided on the fly.
sdw@iadfw.net suggested to keep configuration file, data file, digits, log file in separate directories. It will fix a security hole.
datafile can be edited.

Count 1.3:

Hardcoded the base directory of the counter data files. This will fix a security hole. Thanks to carsten@group.com

 

Back Up

Last Updated: 13 May 2001
Copyright © by Esosoft Corporation 1996-2001
All Rights Reserved.
http://www.esosoft.net