home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Media Share 9
/
MEDIASHARE_09.ISO
/
bbsdoor
/
topdor14.zip
/
TOPDOORS.DOC
< prev
next >
Wrap
Text File
|
1993-04-15
|
12KB
|
263 lines
---------------------------------------------------------------------------
TopDoors v1.4 Copyright (c) 1993 by Bryan J. Nylin
Written and compiled in QuickBASIC v4.5
---------------------------------------------------------------------------
TopDoors v1.4 is a utility designed for TriBBS sysops to create a bulletin
showing the top door programs executed on the BBS. It is compatible with
TriBBS versions 3.3 and 4.0.
This software is SHAREWARE. You are granted permission to distribute
the TOPDOR14 archive freely, provided all the original files are kept
together, and only a nominal fee is charged. The files in this archive
should be:
TOPDOORS.DOC This documentation file.
TOPDOORS.REG Registration/order form
TOPDOORS.EXE Executable program.
TOPDOORS.CFG Configuration file
FILE_ID.DIZ Program description for BBS posting.
The result of McAffee's VALIDATE program on TOPDOORS.EXE is as follows:
File Name: TOPDOORS.EXE
Size: 72,006
Date: 4-15-1993
File Authentication:
Check Method 1 - 22AD
Check Method 2 - 12BF
If any of these numbers do not match, you have an invalid archive that
might be infected with a virus. Delete the archive and contact the
person or BBS you received it from.
This SHAREWARE program is distributed with the concept that if you find
it useful and continue to use it beyond a 30-day free trial period, you
must send in the $10 registration fee (discounts available when registering
multiple copies and/or additional utilities at the same time).
To help you evaluate the program, no features have been left out of this
shareware release. See the file TOPDOORS.REG for the order form.
INSTALLATION INSTRUCTIONS:
-------------------------------------------------------------------------
Step 1. Extract the files from the distribution archive into
your BBS utilities directory. (I use \BBS\UTIL)
Step 2. Make your utilities directory the default (CD \BBS\UTIL)
Step 3. Edit TOPDOORS.CFG to match your system configuration.
Each line is documented in a section below.
Step 4. Edit your TriBBS BETWEEN.BAT file to include TOPDOORS.
If the directory where you've installed TOPDOORS is in
the DOS PATH, just add one line to BETWEEN.BAT to run
TOPDOORS from the BBS directory. If it is not in the
PATH, you will have to change directories in BETWEEN.BAT.
Example:
---------->File starts Here<-------------
cd\bbs\util
TOPDOORS /L /E=999
cd\bbs\tribbs
---------->File ends Here<-----------------
Step 5. You are done! The next time a caller logs off and
BETWEEN.BAT is executed, the bulletin is updated.
CONFIGURATION FILE
-------------------------------------------------------------------------
The sample file TOPDOORS.CFG included in this archive looks like this:
----------->File starts Here<-------------
bbs=Jet City Connection
log=C:\TRIBBS\MWORK\CALLERS.LOG
dir=C:\TRIBBS
max=15
days=30
ansi=C:\TRIBBS\DISPLAY\BULLET9.ANS
ascii=C:\TRIBBS\DISPLAY\BULLET9.BBS
sub=MAINK.BAT,Time Bank
sub=MESST.BAT,TriMail (QWK)
excl=LOGIN.BAT
---------->File ends Here<-----------------
Each line starts with a TAG and an equal sign. These must be typed
correctly in order for the TOPDOORS program to recognize them. It is
not case sensitive, however. Each tag is explained as follows:
bbs= Name of the BBS you want to appear at top of bulletin.
log= File name of caller log to read. TOPDOORS works on the
entire log file and creates the bulletin from scratch
each time. The date range and amount of data available
is dependent on the size of your log file.
dir= The main TRIBBS directory. This is used to find
\MWORK\USERS.DAT when security level switch is active.
max= Maximum number of lines to print in the bulletin. A
'10' here would indicate to only print the Top 10 doors.
days= Number of days to include. When using this, TOPDOORS
starts from midnight of the previous day and counts
backwards to come up with the date range. Without this
parameter, TOPDOORS will simply use the entire log file.
ansi= File name and path of the ANSI bulletin to create.
ascii= File name and path of the ASCII bulletin to create.
sub= Each of these lines indicate a SUBSTITUTION by TOPDOORS.
This is necessary because of the way TriBBS records doors
executed from other menus. Instead of the name of the
door going into the log file, the file name of the batch
file is recorded instead. In the example here, a Time
Bank door was added to the Main Menu using the "K" command.
The first parameter after 'sub=' is the door batch file
name, the second is the description to print.
The door that executes is "J:\BBS\TRIBBS\MAINK.BAT" which
needs to be translated to "Time Bank" in the bulletin.
This results in the line:
sub=MAINK.BAT,Time Bank
You can have as many "sub=" lines as you need (up to 250)
excl= Each of these lines indicates the name of a door to be
excluded from the bulletin output. You can have as many
"excl=" lines as you need (up to 250). Many sysops use
LOGIN.BAT, so the example shows:
excl=LOGIN.BAT
This will exclude the "login door" from showing up on the
bulletins.
COMMAND LINE PARAMETERS
--------------------------------------------------------------------------
Usage: TOPDOORS [/L] [/E=nnn] [/?] [/HELP]
Where: /L Includes local logons
/E=nnn Excludes callers at or above security level nnn.
/DAYS=n Number of days to include
Explanation:
/L Includes local logons. By default, doors run during
local logons are ignored and not recorded.
/E=nnn Excludes any caller with a security level at or above
'nnn'. Useful to exclude sysop from list when calling
from remote line and using a door.
NOTE: Use of the /E switch will cause program run-time
to increase substantially because of the extra
time it takes to look into USERS.DAT.
/DAYS=n Number of days to include. When using this, TOPDOORS
starts from midnight of the previous day and counts
backwards to come up with the date range. Without this
parameter, TOPDOORS will simply use the entire log file.
EXAMPLE: NEWUSERS /L /E=999 /DAYS=14
Includes local logons, but excludes any users at level 999
(or above). Handy if there are users other than the sysop
that log on locally (that use doors) that should be counted.
Also keeps a sysop from being recorded when calling by modem
and using a door. Only includes last 14 full days.
DESCRIPTION OF OPERATION
--------------------------------------------------------------------------
TOPDOORS scans the CALLERS.LOG file. For each caller it finds that runs
a door, it records the doors that are executed (and the security level
of the caller if the /E switch is used).
The number of times each door is executed is totalled along with the
number of minutes used, and the first and last date the door was used.
All doors are then ranked according to the total number of times the door
was used. The date information is used to calculate the average number
of times each day each door was used, and the average number of minutes for
each use.
Some additional logic is also applied that needs to be explained. The
basic rule is that running a door is only counted ONCE per call, but
the total number of minutes is recorded. For instance, if somebody runs
a game door for 5 minutes, exits and looks at files (or whatever), then
comes back and runs it again for 7 minutes, TOPDOORS will count this
door as having been used ONCE for 12 minutes.
VERSION HISTORY
--------------------------------------------------------------------------
v1.4 Released 04-15-93.
- Fixed bug relating to searching the DOS PATH.
v1.3 Released 03-16-93.
- Fixed bug where excluded doors caused all other doors in the
same session (executed after the excluded one) to be ignored.
- Now properly recognizes alias names when checking security
levels (when user logs on with alias instead of real name).
v1.2 Released 02-20-93.
- Added PATH support. The .KEY and .CFG files can now be
anywhere along the DOS PATH.
- Fixed problem with date routine that calculated date range
to report on.
- Traps error and displays appropriate message when log file
cannot be found.
v1.1 Released 01-26-93.
- Fixed problem when PC locked up during door and no "Returned from"
existed in the log (only counts as 1 minute usage).
- Fixed problem when top of CALLERS.LOG is not *************'s, now
skips all lines until finding the first line of asterisks.
- Added '/DAYS=' command line parameter (and 'DAYS=' tag in .CFG)
- Added shareware registration code.
v1.0 Initial release, 01-08-93.
DISCLAIMER
--------------------------------------------------------------------------
This software and accompanying materials are distributed "AS IS" and
without warranty, expressed or implied. No implied warranty exists
for merchantability and/or fitness for any particular purpose. Under
no circumstances shall anyone involved in the creation, production, or
sale of this product be liable for direct, indirect, consequential, or
special damages arising out of any use of this product.
Use of this software beyond the initial 30 day evaluation period is
strictly prohibited.
Once this software is registered, any unauthorized distribution of your
personalized registration code and/or the registration .KEY file will
invalidate your registration key for all releases of this product, and
no product support will be given.
TECHNICAL SUPPORT
--------------------------------------------------------------------------
Support questions can be left, and latest version downloaded
from the author's BBS near Seattle, WA:
Jet City Connection BBS, (206)839-8843, v.32bis, Fido 1:343/140
Messages can also be addressed to Bryan Nylin at:
FidoNet 1:343/140
CompuServe 71441,1420
---------------------------------------------------------------------------
This SHAREWARE program is distributed with the concept that if you find
it useful and continue to use it beyond a 30-day free trial period, you
must send in the $10 registration fee (discounts available when registering
multiple copies and/or additional utilities at the same time).
To help you evaluate the program, no features have been left out of this
shareware release. See the file TOPDOORS.REG for the order form.
---------------------------------------------------------------------------