home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / bbs / asla_120.arc / ASLA.DOC < prev    next >
Text File  |  1989-08-22  |  21KB  |  380 lines

  1.  
  2.                      ════════════════════════════════════
  3.                      ▄█▄        ▄██▄    ███      ▄█▄     
  4.                       ▀██▄     ▀███▄    ███       ▀██▄   
  5.                       ▄▄▀██▄     ▀███▄  ███       ▄▄▀██▄ 
  6.                      ██▀  ▀██      ███  ███      ██▀  ▀██
  7.                      ██▄▄▄▄██ ▄▄▄▄████  ███▄▄▄▄▄ ██▄▄▄▄██
  8.                      ▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀
  9.                      ────────────────────────────────────
  10.  
  11.              Advanced System.Log Analyzer v1.20 for QuickBBS v2.04
  12.           Written by Gerard van der Land in Microsoft QuickBASIC 4.5
  13.       (C) Copyright 1989 Holland Computer Software. All rights reserved.
  14.  
  15.                               Released 22-Aug-89
  16.  
  17.       ■══════════════════════════════════════════════════════════════════■
  18.  
  19.                                  WHAT IS ASLA?
  20.                                 ■─────────────■
  21.  
  22. ASLA analyzes your SYSTEM.LOG, makes a statistical report in ASLA.A??, creates
  23. LASTUSER.A?? with the last 20 users on the system (with baud rate), updates the
  24. download counters like FILESCNT (Tony Bauman) for files downloaded with both
  25. FileDoor and QuickBBS, and also makes a Bulletin Board with read-counters. ASLA
  26. can be started after each user, because the program always continues analyzing
  27. where it ended the last times, which makes it very fast.
  28.  
  29.                      DISCLAIMER AND OTHER IMPORTANT STUFF
  30.                     ■────────────────────────────────────■
  31.  
  32. The following points must be considered, understood and agreed upon BEFORE you
  33. use ASLA v1.20:
  34.  
  35. ■ This documentation and the accompanying program is copyrighted material by
  36.   Gerard van der Land and Holland Computer Software.
  37.  
  38. ■ Although care has been taken to write and test a program that does what this
  39.   documentation states, the program is provided as it is, without warranty or
  40.   guarantee of any kind, either expressed or implied, as to the quality or
  41.   performance of this program, except that it will occupy disk space.
  42.  
  43. ■ The author will not be held liable to you or anyone for any direct, indirect,
  44.   incidental or consequential damages, including any lost profits, lost savings
  45.   which may result from the use or inability to use this program.
  46.   Your use of the program constitutes your agreement to this disclaimer and
  47.   your release of the author from any form of liability or litigation.
  48.  
  49. ■ I grant you a limited license to use ASLA v1.20 and encourage you to copy and
  50.   distribute it in the self-extracting archive in which it came (ASLA_120.COM)
  51.   as much as you want as long as you still abide to the conditions mentioned
  52.   here and no money or other compensation is asked or accepted.
  53.  
  54.                                HOW DOES IT WORK?
  55.                               ■─────────────────■
  56.  
  57. 1. ASLA analyzes you SYSTEM.LOG and counts the following things:
  58.  
  59. ■ Number of callers at 300, 1200, 2400 and 9600 baud, number of new users and
  60.   total number of callers.
  61.  
  62.   ASLA will put "N/A" after the baudrate that are not supported on your BBS. It
  63.   wil get this information from CONFIG.BBS.
  64.   ASLA creates LASTUSER.A?? with date, time, name and baud rate of the last 20
  65.   users in LASTUSER.A??. When the sysop logs on without "fast logon", ASLA
  66.   doesn't count that for a call at the highest baud rate, but mentions it as
  67.   "Loc." (local) in the LASTUSER.A?? files, even if the sysop called from the
  68.   outside. There's just no way to see the difference as long as Adam Hudson
  69.   doesn't put a "on-line at 0 baud" in the SYSTEM.LOG.
  70.  
  71. ■ Usage of the Xmodem (including 1k), Ymodem, Zmodem and SEAlink protocols,
  72.   total number of downloads and uploads.
  73.  
  74.   ASLA puts the full path names of the downloaded files in FILEDIFF.LOG. Later
  75.   this file will be used to update the download counters and erased. ASLA also
  76.   updates a special Download and Uploads log file, just like FileDoor does with
  77.   the name of the user after each file, but they include the PE-transfers too!
  78.  
  79. ■ Number of messages written and deleted, number of times the sysop was paged
  80.   and chatted with a user and the number of bulletins that were read.
  81.  
  82.   If you enabled the "Bulletin" keyword in ASLA.CFG, ASLA can produce a .A??
  83.   version of a Bulletin Board with 13 subjects and read-counters. Therefore it
  84.   needs the file BULLETIN.DAT. The first line of that file looks like this:
  85.  
  86.   "BULLET_","Title of the Bulletin Board comes here"
  87.  
  88.   "BULLET_" is the filename of the master file used with QuickBBS menu type 6
  89.   "Selection menu". It can be maximum 7 characters long, but I recommend NOT to
  90.   use a shorter filename, since QuickBBS will then allow the user to enter more
  91.   than one character when selecting a bulletin. The title will be centered on
  92.   top of the board. After that, 13 lines follow, which all like this:
  93.  
  94.   "A","Subject of this Bulletin Board comes here         ",8
  95.  
  96.   "A" is the character the user has to enter and also the last character of the
  97.   sub file, in this example "BULLET_A.A??". You are free to choose a character,
  98.   only "L" is not allowed, since it is used by QuickBBS to display the master
  99.   file "BULLET_.A??". The digit 8 is the number of times this Bulletin was
  100.   read. When you replace it, fist run ASLA to make sure there no more info in
  101.   SYSTEM.LOG that could update this counter, change the subject and zero the
  102.   counter. After that you can type "ASLA /BUL" to make a new Bulletin Board.
  103.  
  104. 2. After analyzing SYSTEM.LOG, the ASCII and ANSI files are created in the
  105.    QuickBBS text files directory (at least if ASLA could find the CONFIG.BBS,
  106.    otherwise in the current directory).
  107.  
  108. 3. If you enabled the "FilesCount" keyword in ASLA.CFG, then the second half
  109.    of the program starts: FILEDIFF.LOG is loaded, sorted on directory name and
  110.    truncated. After that for each directory from which a file was downloaded
  111.    (or all directories found in FLSEARCH.CTL if you used the /ALL switch):
  112.  
  113. a. FILES.BBS is loaded and FILES.$$$ created. If ASLA can't find a FILES.BBS,
  114.    then all files downloaded from that directory go back to FILEDIFF.LOG. ASLA
  115.    will re-try to update them next time until you should either make sure that
  116.    ASLA can find that FILES.BBS or change/delete FILEDIFF.LOG.
  117. b. With every line that contains a filename, the following things are done:
  118.    ■ Missing [0] will be added.
  119.    ■ Missing description "New File. Description unknown" will be added.
  120.      This text can be changed with the keyword Description in ASLA.CFG.
  121.    ■ Superfluous spaces will be removed.
  122.    ■ If you enabled the "Space" keyword in ASLA.CFG, ASLA will put a space
  123.      behind [nn], otherwise existing space(s) will be removed.
  124.    ■ The download counter will be increased if that file was downloaded.
  125.    ■ The filename will be expanded so it always fills 12 characters
  126.    ■ The description will be trimmed if it is longer than 47 characters, to
  127.      make sure that a file won't occupy more than one line when you use
  128.      QuickBBS menu type 31 "List FILES.BBS".
  129. c. FILES.BAK will be deleted if it exists.
  130. d. FILES.BBS will be renamed to FILES.BAK
  131. e. FILES.$$$ will be renamed to FILES.BBS. This file will NOT contain a
  132.    End Of File character ^Z, so you don't need to strip it.
  133.  
  134. 4. Finally ASLA will update BULLETIN.DAT and ASLA.SYS. This file contains info
  135.    to make ASLA continue next time where ended this time, which makes it
  136.    possible to run ASLA after each user instead of each 24 hours. Don't forget:
  137.       ┌──────────────────────────────────────────────────────────────────┐
  138.       │ ■ When SYSTEM.LOG is deleted, you HAVE TO delete ASLA.SYS too! ■ │
  139.       └──────────────────────────────────────────────────────────────────┘
  140.    Some checking is done which makes ASLA abort if ASLA.SYS and SYSTEM.LOG
  141.    don't match, so it can't do any harm if you forget. An other way is to use
  142.    the /KILL switch, which will make ASLA delete the SYSTEM.LOG when done (so
  143.    if you want a backup, make one BEFORE running ASLA) but keeps ASLA.SYS, so
  144.    the statistics/lastusers are over a longer period. It is up to you to delete
  145.    ASLA.SYS when the numbers are getting too high.
  146.  
  147.                                    EXAMPLES
  148.                                   ■────────■
  149.  
  150. Here are some examples of ASLA's output in FILES.BBS when the keywords
  151. "FilesCount", "Digits", "Space" and "Description" are enabled in ASLA.CFG:
  152.  
  153. I: "demo.dat" or
  154. I: "DEMO.DAT     [0]"
  155. O: "DEMO.DAT     [00] New File, Description Unknown"
  156.  
  157. I: "DEMO.DAT [124]This is a demonstration"
  158. O: "DEMO.DAT     [124] This is a demonstration"
  159.  
  160. I: "DEMO.DAT             [001]        To much spaces"
  161. O: "DEMO.DAT     [01] Exactly enough spaces" <== Artificial Intelligence :-)
  162.  
  163.                          INSTALLATION & CONFIGURATION
  164.                         ■────────────────────────────■
  165.  
  166. ■ Fill in the info in ASLA.CFG and BULLETIN.DAT with your favorite ASCII-editor
  167.   like EDLIN (ahum...). Keywords known by ASLA are: "QuickBBSPath", "BBSName",
  168.   "LastUserPages", "Bulletin", "DownloadLog", "UploadLog", "FilesCount",
  169.   "Digits", "Space" and "Description". You won't find this too hard (I hope).
  170.  
  171. ■   ===>   IMPORTANT IF YOU USED THE FILESCOUNT KEYWORD IN FILEDOOR   <===
  172.   It is impossible to detect whether a file was downloaded using FileDoor or  
  173.   using the Protocol Engine, and that's why you can only use ASLA to only the  
  174.   PE-downloads by disabling the "LogFile" keyword in FILEDOOR.CFG, but that  
  175.   will corrupt the statistical info.
  176.   The best thing is to let ASLA do everything, by disabling the "FilesCount",
  177.   "DownloadLog" and "UploadLog" keywords in FILEDOOR.CFG and enabling them in
  178.   ASLA.CFG. Make sure you enable the "Logfile SYSTEM.LOG" keyword, else ASLA
  179.   can't find out FileDoor has been doing.
  180.  
  181.   If don't have a SYSTEM.LOG at this moment or you didn't use download counters
  182.   until known, you can install ASLA now, otherwise you'll have to run it the
  183.   first time with the "FilesCount" keyword in ASLA.CFG DISABLED!
  184.  
  185. ■ If you enabled "FilesCount" in ASLA.CFG, you can start ASLA /ALL switch to
  186.   let it update FILES.BBS in all directories found in FLSEARCH.CTL. This is
  187.   handy is you are using ASLA for the first time or when you put a big number
  188.   of new files on line.
  189.  
  190. ■ Put ASLA in the batch file that runs your mailer with QuickBBS. Here is an
  191.   example for RUNFD.BAT (FrontDoor) to run ASLA after each user. Lines that
  192.   begin with | have to be inserted/added.
  193.  
  194. ■──────── RUNFD.BAT
  195.    :Start
  196. |    If "%ASLA%"=="ASLA" Goto ASLA
  197.      Cls
  198.      Echo Starting FrontDoor 1.99 with QuickBBS v2.04
  199.      Cd \Fd
  200.      FD and so on...
  201.  
  202.    :After_Quick
  203. |    SET ASLA=ASLA
  204.      If ErrorLevel and so on...
  205.      Goto Start
  206.  
  207. |  :ASLA
  208. |    Cd\QuickBBS
  209. |    ASLA
  210. |    SET ASLA=
  211. |    Goto Start
  212. ■────────
  213.  
  214.   If you don't have a mailer or you don't want ASLA to run after each user, you
  215.   can run ASLA during your daily event. You can also put ASLA with the /KILL
  216.   switch in a weekly event. (See previous page for details about this).
  217.  
  218.                              QUESTIONS AND ANSWERS
  219.                             ■─────────────────────■
  220.  
  221. Q: ASLA reports: "SYSTEM.LOG not found"
  222. A: Yep. It is kind of hard to analyze a file that doesn't not even exist! Make
  223.    sure the "QuickBBSPath" keyword in ASLA.CFG points to the right directory.
  224.  
  225. Q: ASLA reports: "ASLA.SYS and SYSTEM.LOG don't match" or "Incorrect version
  226.    number in ASLA.SYS"
  227. A: Never change anything in ASLA.SYS or SYSTEM.LOG and delete ASLA.SYS when you
  228.    delete SYSTEM.LOG, otherwise ASLA will give this error (again?)...
  229.  
  230. Q: ASLA reports: "Could not find .....\FILES.BBS, x download counters were not
  231.    updated."
  232. A: This only happens if ASLA wants to update a FILES.BBS, but can't find it.
  233.    It will sent the names of files downloaded from this directory back to
  234.    FILEDIFF.LOG and continue. You should either change/delete FILEDIFF.LOG or
  235.    make sure ASLA can find the FILES.BBS next time.
  236.  
  237. Q: ASLA reports: "Updating x download counters in yyyy\FILES.BBS, found y",
  238.    but y is less or even more than x.
  239. A: The reason that ASLA finds less than x files can be that you (re)moved a
  240.    downloaded file from that FILES.BBS before ASLA was started.
  241.    The reason that ASLA finds more than x files can be that a filename is in a
  242.    FILES.BBS more than once.
  243.  
  244. Q: ASLA puts the .A?? files in my current directory instead of the text files
  245.    directory. If I log on, LASTUSER.A?? doesn't show "Loc." behind my name.
  246. A: You have to run ASLA from the QuickBBS directory as you current directory,
  247.    otherwise it can't find CONFIG.BBS (in this case the things you mentioned
  248.    will happen), or ASLA.EXE. If ASLA.SYS doesn't exist or you typed "ASLA ?",
  249.    a build-in virus-protection will see if ASLA.EXE was changed.
  250.  
  251. Q: Why do all windows have shadow?
  252. A: Because I happen to like that! But don't panic: in the future you will be
  253.    able to create your own ugly .A?? files. :-)
  254.  
  255. Q: Which versions of QuickBBS and DOS does ASLA need?
  256. A: ASLA was written for QuickBBS v2.04. Since I don't have v2.03 anymore, I
  257.    don't know what will happen, but why would you still be using that version?
  258.    It would however still be nice if some told me his experinces with v2.03.
  259.    The checksum routine opens ASLA.EXE with READ access only to prevent anti-
  260.    virus software from saying that ASLA is actually a virus itself, and this
  261.    seems only to be supported in DOS 3.0 or higher.
  262.  
  263. Q: Can ASLA be start remotely by a (co)-sysop when he wants to update the
  264.    Bulletin Board for example?
  265. A: Yes, it can. All output is done though DOS, and can be redirected using CTTY
  266.    COMn:/GATEWAY or even ASLA >COMn.
  267.  
  268. Q: In what language was in written and is the source code available?
  269. A: Don't you know by now? ASLA was written in and compiled with Microsoft
  270.    QuickBASIC Version 4.5, but also uses four routines from the Advanced Basic
  271.    library v99. The 856 lines of source code are not available, I'm sorry!
  272.  
  273. Q: Why did you write this program anyway?
  274. A: ■ I saw some other SYSTEM.LOG analyzers and I wanted to write one too, but
  275.      then better a little better of course...
  276.    ■ My sysop, Onno Hagers, wanted to have a bulletin board with read-counters.
  277.    ■ The Protocol Engine in QuickBBS doesn't update the download counters.
  278.    ■ BOXBEL, a German lastuser-program kept the BBS busy for several minutes
  279.      when the log files were getting very big.
  280.    Well this seemed enough reason for me to write ASLA, because it combines a
  281.    lot of tasks in one fast program.
  282.  
  283. Q: ASLA reports: "Thanks for using ASLA!"
  284. A: Yeah! I really like it if you use my program, could you please tell me that
  285.    you are using it and what you think about it? In that case, thanks again!
  286.  
  287.                                ACKNOWLEDGEMENTS:
  288.                                ─────────────────
  289.  
  290. ■ Adam Hudson for writing QuickBBS v2.04, the best BBS program in the world!
  291. ■ Joaquim Homrighausen for not putting a download counter updater in his
  292.   Protocol Engine, for Xrobot and also for the free copy of FrontDoor 1.99.
  293. ■ The programmers at Microsoft for writing there unbeatable great program
  294.   QuickBASIC 4.5 and many other good software.
  295. ■ Thomas Hanklin III for writing the library Advanced Basic v99, a very useful
  296.   supplement for QuickBASIC. (Now available as ProBas).
  297. ■ Jeroen Langeveld (FIBBS) for beta testing and his financial contribution.
  298. ■ Onno Hagers (Advanced BBS) and Michiel Wiegers (Fast BBS) for beta testing  
  299.   and other help.
  300.  
  301. ╔════════════════════════════════════════════════════════════════════════════╗
  302. ║ I am not a sysop yet. If anyone is interested in sponsoring me, I'll start ║
  303. ║ my own BBS! Software is no problem, I just need some hardware and money... ║
  304. ║   ■■■>  You can contact me at Advanced BBS! (address on this page)  <■■■   ║
  305. ╚════════════════════════════════════════════════════════════════════════════╝
  306.  
  307.                             SOFTWARE/HARDWARE USED:
  308.                            ■───────────────────────■
  309.  
  310. ■ Microsoft Disk Operating System 3.30, also known as MS-DOS :-)
  311. ■ Microsoft QuickBASIC Compiler 4.5
  312. ■ WordPerfect 5.0, for writing this documentation
  313. ■ Norton Commander 2.00, WordPerfect Program Editor 4.2 and TheDraw 3.20, for
  314.   designing the output screens.
  315. ■ LASER TURBO XT-2, 10 Mhz Intel 8086, 640k RAM, 30 Mb HD, EGA, mouse
  316. ■ VENDEX HeadStart III, 12 Mhz Intel 80286, 1024k RAM, 30 Mb HD, VGA, mouse
  317.  
  318. Have fun with this program. I hope it can be useful to you. Everyone who has
  319. questions/suggestions/money/bugs for me can reach me at Advanced BBS. There you
  320. can always request the latest version using the "ASLA" as well.
  321.   ___                                                     __
  322.  /   \  _   _   _   _   __/  _  _ _   __    __/ _   _     /    _   __  __/
  323. (  --+ /_) / | __) / | / /   | / __) / /   / / /_) / |   /    __) / / / /
  324.  \__/|(_  /   (_/ /   (_/    |/ (_/ / /   (_/ (_  /     (___/(_/ / / (_/ ,
  325.  
  326. Co-Sysop Advanced BBS Holland (2:283/308) +31-08384-2605, 300/1200/2400, 24h
  327.  
  328.                                 HISTORY/FUTURE:
  329.                                ■───────────────■
  330.  
  331. Until know I spent a lot of time thinking, writing, debugging and documenting
  332. ASLA, and I will keep on doing that. So if you use this program for a period of
  333. time and find it to be of use, a financial contribution would be appreciated.
  334. (Suggested: $7, but anything from $1 to $1000000 is welcome!). You can transfer
  335. the money to giro 5.245.162 in Holland. But at least let me know if you are
  336. using ASLA and tell me what you think about it. Thanks a lot!
  337.  
  338. ┌───────────┬───────┬─────────────────────────────────────────────────────────┐
  339. │ 10-Aug-89 │ v1.00 │ First release of ASLA                                   │
  340. ├───────────┼───────┼─────────────────────────────────────────────────────────┤
  341. │ 19-Aug-89 │ v1.10 │ ■ Translated documentation in to English.               │
  342. │           │       │ ■ ASLA now checks if the DOS version is ≥ 3.0           │
  343. │           │       │ ■ /ALL will now automatically invoke the /BUL switch    │
  344. │           │       │ ■ All unimportant screen output has been removed.       │
  345. │           │       │ ■ Increased speed and reduced size of ASLA.EXE          │
  346. │           │       │ ■ Added 9600 Baud, Sysop Paged and Chatted counters.    │
  347. │           │       │ ■ ASLA can now update Download/Uploads.Log if you are   │
  348. │           │       │   not using the "FilesCount" keyword                    │
  349. │           │       │ ■ Added "N/A" to those baud rates that aren't supported │
  350. │           │       │ ■ LASTUSER.A?? now shows a * in front of new users      │
  351. │           │       │ ■ Number of digit in download counters can be fixed to  │
  352. │           │       │   1 (default), 2, 3 or 4 (that seems enough to me!)     │
  353. │           │       │ ■ Fixed bug that ASLA didn't place the text defined by  │
  354. │           │       │   the "Description" keyword but the description of the  │
  355. │           │       │   previous file after a filename that missed both it's  │
  356. │           │       │   description and download counter. Thanks to Jeroen    │
  357. │           │       │   Langeveld of FIBBS, who noticed this one...           │
  358. ├───────────┼───────┼─────────────────────────────────────────────────────────┤
  359. │ 22-Aug-89 │ v1.20 │ ■ Now you can choose the number of pages in LASTUSER    │
  360. │           │       │   in the range from 1-8.                                │
  361. │           │       │ ■ Error 9 would occur if you tried to put more than 13  │
  362. │           │       │   subjects in BULLETIN.DAT. This has been fixed.        │
  363. │           │       │ ■ ASLA will now create a MSGSPOST.A?? that shows how    │
  364. │           │       │   many messages were posted in each message board.      │
  365. │           │       │ ■ The new commandline switch /KILL deletes SYSTEM.LOG   │
  366. │           │       │   after processing but keeps ASLA.SYS                   │
  367. │           │       │ ■ Some other small changes and improvements.            │
  368. ├───────────┼───────┼─────────────────────────────────────────────────────────┤
  369. │  Future   │ v?.?? │ ■ Now you can create your own .ASC and .ANS screens and │
  370. │           │       │   let ASLA put it's info in there using variables       │
  371. │           │       │ ■ ASLA can create a TOPxx.A?? and an ALLFILES.BBS list  │
  372. │  (Under   │       │ ■ More protocols are counted (BiModem, JMODEM, etc.)    │
  373. │ Reverse)  │       │ ■ ASLA can now analyze FrontDoor's FD.LOG too. It puts  │
  374. │           │       │   the systems that (were) called in LASTUSER, and also  │
  375. │           │       │   updated the download counters for requested files.    │
  376. │           │       │ ■ Maybe you have some suggestions? Drop me a message!   │
  377. └───────────┴───────┴─────────────────────────────────────────────────────────┘
  378.  
  379. ────────────────────────────────■ End Of File ■────────────────────────────────
  380.