home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbsdoor / topdor14.zip / TOPDOORS.DOC < prev    next >
Text File  |  1993-04-15  |  12KB  |  263 lines
  1. ---------------------------------------------------------------------------        
  2.       TopDoors v1.4     Copyright (c) 1993 by Bryan J. Nylin
  3.                         Written and compiled in QuickBASIC v4.5
  4. ---------------------------------------------------------------------------
  5.  
  6. TopDoors v1.4 is a utility designed for TriBBS sysops to create a bulletin
  7. showing the top door programs executed on the BBS.  It is compatible with 
  8. TriBBS versions 3.3 and 4.0.
  9.  
  10. This software is SHAREWARE.  You are granted permission to distribute
  11. the TOPDOR14 archive freely, provided all the original files are kept 
  12. together, and only a nominal fee is charged.  The files in this archive 
  13. should be:
  14.  
  15.         TOPDOORS.DOC      This documentation file.
  16.         TOPDOORS.REG      Registration/order form
  17.         TOPDOORS.EXE      Executable program.
  18.         TOPDOORS.CFG      Configuration file
  19.         FILE_ID.DIZ       Program description for BBS posting.
  20.  
  21. The result of McAffee's VALIDATE program on TOPDOORS.EXE is as follows:          
  22.  
  23.                   File Name:  TOPDOORS.EXE
  24.                        Size:  72,006
  25.                        Date:  4-15-1993
  26.         File Authentication:
  27.              Check Method 1 - 22AD
  28.              Check Method 2 - 12BF
  29.  
  30. If any of these numbers do not match, you have an invalid archive that
  31. might be infected with a virus.  Delete the archive and contact the
  32. person or BBS you received it from.
  33.  
  34. This SHAREWARE program is distributed with the concept that if you find
  35. it useful and continue to use it beyond a 30-day free trial period, you
  36. must send in the $10 registration fee (discounts available when registering
  37. multiple copies and/or additional utilities at the same time).
  38.  
  39. To help you evaluate the program, no features have been left out of this 
  40. shareware release.  See the file TOPDOORS.REG for the order form.
  41.  
  42.  
  43. INSTALLATION INSTRUCTIONS:
  44. -------------------------------------------------------------------------
  45. Step 1.         Extract the files from the distribution archive into 
  46.                 your BBS utilities directory. (I use \BBS\UTIL)
  47.  
  48. Step 2.         Make your utilities directory the default (CD \BBS\UTIL)
  49.  
  50. Step 3.         Edit TOPDOORS.CFG to match your system configuration.
  51.                 Each line is documented in a section below.
  52.  
  53. Step 4.         Edit your TriBBS BETWEEN.BAT file to include TOPDOORS.
  54.                 If the directory where you've installed TOPDOORS is in
  55.                 the DOS PATH, just add one line to BETWEEN.BAT to run
  56.                 TOPDOORS from the BBS directory.  If it is not in the
  57.                 PATH, you will have to change directories in BETWEEN.BAT.
  58.                 Example:
  59.                 ---------->File starts Here<-------------
  60.                 cd\bbs\util
  61.                 TOPDOORS /L /E=999
  62.                 cd\bbs\tribbs
  63.                 ---------->File ends Here<-----------------
  64.  
  65. Step 5.         You are done!  The next time a caller logs off and 
  66.                 BETWEEN.BAT is executed, the bulletin is updated.
  67.  
  68.  
  69. CONFIGURATION FILE
  70. -------------------------------------------------------------------------
  71. The sample file TOPDOORS.CFG included in this archive looks like this:
  72.  
  73. ----------->File starts Here<-------------
  74. bbs=Jet City Connection
  75. log=C:\TRIBBS\MWORK\CALLERS.LOG
  76. dir=C:\TRIBBS
  77. max=15
  78. days=30
  79. ansi=C:\TRIBBS\DISPLAY\BULLET9.ANS
  80. ascii=C:\TRIBBS\DISPLAY\BULLET9.BBS
  81. sub=MAINK.BAT,Time Bank
  82. sub=MESST.BAT,TriMail (QWK)
  83. excl=LOGIN.BAT
  84. ---------->File ends Here<-----------------
  85.  
  86. Each line starts with a TAG and an equal sign.  These must be typed
  87. correctly in order for the TOPDOORS program to recognize them.  It is
  88. not case sensitive, however.  Each tag is explained as follows:
  89.  
  90.         bbs=    Name of the BBS you want to appear at top of bulletin.
  91.  
  92.         log=    File name of caller log to read.  TOPDOORS works on the
  93.                 entire log file and creates the bulletin from scratch 
  94.                 each time.  The date range and amount of data available
  95.                 is dependent on the size of your log file.
  96.  
  97.         dir=    The main TRIBBS directory.  This is used to find 
  98.                 \MWORK\USERS.DAT when security level switch is active.
  99.  
  100.         max=    Maximum number of lines to print in the bulletin.  A
  101.                 '10' here would indicate to only print the Top 10 doors.
  102.                 
  103.         days=   Number of days to include.  When using this, TOPDOORS
  104.                 starts from midnight of the previous day and counts
  105.                 backwards to come up with the date range.  Without this
  106.                 parameter, TOPDOORS will simply use the entire log file.
  107.  
  108.         ansi=   File name and path of the ANSI bulletin to create.
  109.  
  110.         ascii=  File name and path of the ASCII bulletin to create.
  111.  
  112.         sub=    Each of these lines indicate a SUBSTITUTION by TOPDOORS.
  113.                 This is necessary because of the way TriBBS records doors
  114.                 executed from other menus.  Instead of the name of the
  115.                 door going into the log file, the file name of the batch
  116.                 file is recorded instead.  In the example here, a Time
  117.                 Bank door was added to the Main Menu using the "K" command.
  118.                 The first parameter after 'sub=' is the door batch file
  119.                 name, the second is the description to print.  
  120.                 The door that executes is "J:\BBS\TRIBBS\MAINK.BAT" which
  121.                 needs to be translated to "Time Bank" in the bulletin.
  122.                 This results in the line:
  123.                         sub=MAINK.BAT,Time Bank
  124.                 You can have as many "sub=" lines as you need (up to 250)
  125.  
  126.         excl=   Each of these lines indicates the name of a door to be
  127.                 excluded from the bulletin output.  You can have as many
  128.                 "excl=" lines as you need (up to 250).  Many sysops use
  129.                 LOGIN.BAT, so the example shows:
  130.                         excl=LOGIN.BAT
  131.                 This will exclude the "login door" from showing up on the
  132.                 bulletins.
  133.  
  134.  
  135. COMMAND LINE PARAMETERS
  136. --------------------------------------------------------------------------
  137. Usage:  TOPDOORS [/L] [/E=nnn] [/?] [/HELP]
  138. Where:  /L        Includes local logons
  139.         /E=nnn    Excludes callers at or above security level nnn.
  140.         /DAYS=n   Number of days to include
  141.  
  142. Explanation:
  143.  
  144.         /L      Includes local logons.  By default, doors run during
  145.                 local logons are ignored and not recorded.
  146.  
  147.         /E=nnn  Excludes any caller with a security level at or above 
  148.                 'nnn'.  Useful to exclude sysop from list when calling
  149.                 from remote line and using a door.
  150.                 NOTE:  Use of the /E switch will cause program run-time
  151.                        to increase substantially because of the extra 
  152.                        time it takes to look into USERS.DAT.
  153.  
  154.       /DAYS=n   Number of days to include.  When using this, TOPDOORS
  155.                 starts from midnight of the previous day and counts
  156.                 backwards to come up with the date range.  Without this
  157.                 parameter, TOPDOORS will simply use the entire log file.
  158.  
  159.  
  160. EXAMPLE:        NEWUSERS /L /E=999 /DAYS=14
  161.                 
  162.                 Includes local logons, but excludes any users at level 999
  163.                 (or above).  Handy if there are users other than the sysop
  164.                 that log on locally (that use doors) that should be counted.
  165.                 Also keeps a sysop from being recorded when calling by modem
  166.                 and using a door.  Only includes last 14 full days.
  167.  
  168.  
  169.  
  170. DESCRIPTION OF OPERATION
  171. --------------------------------------------------------------------------
  172. TOPDOORS scans the CALLERS.LOG file.  For each caller it finds that runs
  173. a door, it records the doors that are executed (and the security level
  174. of the caller if the /E switch is used).
  175.  
  176. The number of times each door is executed is totalled along with the
  177. number of minutes used, and the first and last date the door was used.  
  178. All doors are then ranked according to the total number of times the door 
  179. was used.   The date information is used to calculate the average number 
  180. of times each day each door was used, and the average number of minutes for 
  181. each use. 
  182.  
  183. Some additional logic is also applied that needs to be explained.  The
  184. basic rule is that running a door is only counted ONCE per call, but
  185. the total number of minutes is recorded.  For instance, if somebody runs
  186. a game door for 5 minutes, exits and looks at files (or whatever), then
  187. comes back and runs it again for 7 minutes, TOPDOORS will count this
  188. door as having been used ONCE for 12 minutes.
  189.  
  190.  
  191. VERSION HISTORY 
  192. --------------------------------------------------------------------------
  193. v1.4    Released 04-15-93.
  194.         - Fixed bug relating to searching the DOS PATH.
  195.  
  196. v1.3    Released 03-16-93.
  197.         - Fixed bug where excluded doors caused all other doors in the
  198.           same session (executed after the excluded one) to be ignored.
  199.         - Now properly recognizes alias names when checking security
  200.           levels (when user logs on with alias instead of real name).
  201.  
  202. v1.2    Released 02-20-93.
  203.         - Added PATH support.  The .KEY and .CFG files can now be 
  204.           anywhere along the DOS PATH.
  205.         - Fixed problem with date routine that calculated date range
  206.           to report on.
  207.         - Traps error and displays appropriate message when log file
  208.           cannot be found.
  209.         
  210. v1.1    Released 01-26-93.
  211.         - Fixed problem when PC locked up during door and no "Returned from"
  212.           existed in the log (only counts as 1 minute usage).
  213.         - Fixed problem when top of CALLERS.LOG is not *************'s, now
  214.           skips all lines until finding the first line of asterisks.
  215.         - Added '/DAYS=' command line parameter (and 'DAYS=' tag in .CFG)
  216.         - Added shareware registration code.
  217.  
  218. v1.0    Initial release, 01-08-93.
  219.  
  220.  
  221. DISCLAIMER
  222. --------------------------------------------------------------------------
  223. This software and accompanying materials are distributed "AS IS" and 
  224. without warranty, expressed or implied.  No implied warranty exists
  225. for merchantability and/or fitness for any particular purpose.  Under 
  226. no circumstances shall anyone involved in the creation, production, or
  227. sale of this product be liable for direct, indirect, consequential, or
  228. special damages arising out of any use of this product.
  229.  
  230. Use of this software beyond the initial 30 day evaluation period is
  231. strictly prohibited.
  232.  
  233. Once this software is registered, any unauthorized distribution of your 
  234. personalized registration code and/or the registration .KEY file will 
  235. invalidate your registration key for all releases of this product, and
  236. no product support will be given.
  237.  
  238.  
  239. TECHNICAL SUPPORT
  240. --------------------------------------------------------------------------
  241.  
  242.         Support questions can be left, and latest version downloaded
  243.         from the author's BBS near Seattle, WA:
  244.  
  245.         Jet City Connection BBS, (206)839-8843, v.32bis, Fido 1:343/140
  246.  
  247.         Messages can also be addressed to Bryan Nylin at:
  248.                 
  249.                 FidoNet 1:343/140
  250.                 CompuServe 71441,1420
  251.                 
  252. ---------------------------------------------------------------------------
  253.  
  254. This SHAREWARE program is distributed with the concept that if you find
  255. it useful and continue to use it beyond a 30-day free trial period, you
  256. must send in the $10 registration fee (discounts available when registering
  257. multiple copies and/or additional utilities at the same time).
  258.  
  259. To help you evaluate the program, no features have been left out of this 
  260. shareware release.  See the file TOPDOORS.REG for the order form.
  261.  
  262. ---------------------------------------------------------------------------        
  263.