ftp.wwiv.com/ftp.wwiv.com.zip/ftp.wwiv.com/pub/BBS/CLDRP310.ZIP/CALLDROP.DOC

Text File | 1992-09-21 | 15KB | 284 lines

                        ╒═════════════════════════╕
                        │  CALLDROP 3.10          │
                        │  By Steve Mathieson     │
                        │  ALL RIGHTS RESERVED    │
                        │  Copyright 1992         │
                        ╘═════════════════════════╛

Wot is it?
─────────
Calldrop is a util that should be placed in your batch file before you
delete your Max.log ( And maybe your Bluewave log also), what it will do is
scan the log for any users who Dropped Carrier during the day, and give you
several optional reports of the cumulative statistics for each user.

Also, Calldrop will now keep running totals of Input timeouts and will track
LEECH-Z modem usage for each user. These figures will be added into the Sysop
report that's created when CallDrop is run.

This is NOT Public Domain software! Rather it is being distributed as Freeware
( In the spirit of Maximus ), you are free to use this software, without charge.
If you are distributing this program please include all the Documentation and
sample CFG files that are included.

*Please* If you choose to use this software let me know.  This is the only
form of registration I request, as it allows me to guage whether further
development is worthwhile. Just a simple Netmail would be fine.

Quick Installation
──────────────────
Put all the included CallDrop files into the directory you want to run
CallDrop from. The MakeMsg.exe program can be placed either in the same
directory as Calldrop, or somewhere in your path statement.
Edit the Calldrop.cfg file to suit your needs, and edit your batch file(s)
so that Calldrop is run during your event schedule just before you delete
or otherwise rename/move the MAX.LOG. After Calldrop runs you may also want
to add in MECCA statements in your batch to compile the report(s) generated.

Upgrading
─────────
If you are upgrading from Version 3.00 then you will have to run
CUPDATE to update your data files. Simply put Cupdate into your Calldrop
directory, and run it. Cupdate will update the Calldrop.dat file for use
with CallDrop version 3.10. You can then safely delete the Cupdate program as
it's no longer required. Then just copy the new Calldrop executable over the
old one, edit your CFG to your liking and away you go.

Command Line Parameters
───────────────────────
There are two optional parameters that may be passed on the command line
when CallDrop is run: -KMAX Will cause CallDrop to delete your Maximus log
file(s) after it has finished, and -KBLU will cause CallDrop to delete your
BlueWave log file(s) when it's finished. Both these options are case
insensitive.

The Calldrop.cfg File
─────────────────────
The following is a list of valid Verbs that may be used in the CFG:

BBSNAME - Just put the Name of your system, and it will appear on the screen,
          when Calldrop is run, and will be placed into your Sysop report file.

SYSOP - This is your Name, use this if you don't want your own Name to appear
        in the Carrier drop report(s). Case is not important so joe sysop is
        the same as JOE SYSOP or JoE SysOp. You may specify up to 5 SYSOP verbs
        followed by names you don't want to appear in the reports. The name
        following the first SYSOP verb is used as the FROM: field in messages
        that are created. Any more than 5 are ignored. Also, names you don't
        want to appear in the reports must match exactly the name that Max
        writes to the log.

MAXLOG - This is the PATH and NAME of your Max.log files. This is where
         Calldrop gathers it's information from, and is mandatory if you
         want it to work. For Multi-line systems, You may specify up to 8
         MAXLOGs to scan, by putting 8 MAXLOG verbs followed by the path and
         filename to the log. They will all be scanned for data each time
         Calldrop is run. Extras are ignored, and NOTE: the -KMAX command line
         switch will delete ALL the logs specified when Calldrop is finished.

BLUEWAVE - This is ONLY for people who use the BlueWave Mail Door, and allow
           the G)oodbye from within the door. Put the full path and filename
           of your BlueWave log here. To use this feature, you MUST have the
           Log General Activity   '='   set to YES in bwutils. Also, Calldrop
           will not alter the logs in any way, so it's important to delete,
           rename or move the BlueWave log file before Calldrop runs again.
           The same applies to the Max.log file, Calldrop will be completely
           inaccurate otherwise. For Multi-line systems, up to 8 BLUEWAVE logs
           may be specified, extras are ignored. Also the -KBLU command line
           switch will delete ALL the BlueWave logs specified when Calldrop
           is finished.

REPORTPATH - This is the Directory where you want the Sysop Reports to be placed.
             Both the ASCII, and the MECCA (if enabled) will be created here.
             It may be worth noting here that the old ones will be overwritten
             when the new is created. The report will be called either
             SYSOP.RPT or SYSOP.MEC depending on what you specify for the
             REPORT TYPE verb.

REPORT TYPE - This verb specifies the type of file you want the SYSOP report to
              be created as. The two options are: MECCA, which will create the
              Sysop report in a colour Mecca format using the colours you
              specify with RPTCOLOUR. The second option being ASCII which will
              cause Calldrop to create a flat ASCII sysop report.

RPTSHOW - Defines the minimum # of Drops for a user to be listed in the SYSOP
          Report.. For example specifying RPTSHOW 5 will cause only users with
          5 or more Carrier drops to be shown in the SYSOP.RPT file.

MAKEMEC - Uncomment this if you want to use either the default Mecca report, or
          the Custom header. If it's commented out, no MEC's will be created
          except for a SYSOP.MEC if you use custom color. ( See RPTCOLOUR )

MECPATH - The Directory where you want the MEC file created. The MEC file will
          be placed in the directory, and named CALLDROP.MEC
          Again, the old ones will be overwritten each time Calldrop is run, so
          you can keep a fairly up to date record on-line for viewing if you
          wish.

BULLSHOW - Works the same a RPTSHOW, but controls the minimum # required for
           a user to be shown in the bulletin (MEC) files.

HEADERFILE - This verb will optionally allow you to use your own custom
             MEC file for the MEC report generated. Basically all Calldrop
             will do is copy it to the MECPATH, and append the data to the
             end. This leaves the original untouched so you can easilly run
             Calldrop in your batch file and update the report.
             ALSO - Calldrop WILL NOT add in the Name and # of Drops headings
             in to the report, I left this so you may put your own in.

QUIETMODE - If this is uncommented most screen output will be suppressed during
            CallDrop's execution. This is faster, and is advised for use during
            your batch processing.

SORTBY - This keyword allows you to specify how ( or if ) you want the output
         reports to be sorted by either: NAMES - The users names in descending
         alphabetical order, or NUMBER - the list to be in descending numeric
         order on the number of Dropes per user. IE: The user with the most
         drops to his name will be listed first. Also worth mentioning is that
         the Calldrops data file is also saved in the sorted format, so if you
         switch from Names to None for example, the list will still remain in a
         semi-sorted format, and additions will be added to the end.

RPTCOLOUR           - Most of the Colours in the Sysop report created by
Customizing Colours   Calldrop are configurable.
(Canadian Spelling)   The RPTCOLOUR verb is followed by 10 numbers seperated
                      by commas. Each number represents a colour, and the
                      order of the Numbers is VERY important. Unexpected
                      results may also occur, if the spacing between the
                      numbers is altered.

  ──────────────────────────────────────────────────────────────────────────
  Colour Values:
                1 - Black                           9 - Dark Gray
   Colours      2 - Blue         Colours 9-16      10 - LightBlue
     1-8        3 - Green            Are           11 - LightGreen
     Are        4 - Cyan           Valid for       12 - Light Cyan
  Valid For     5 - Red              Only          13 - Light Red
    Both        6 - Magenta        Foreground      14 - Light Magenta
  Foreground    7 - Brown                          15 - Yellow
     And        8 - Gray                           16 - White
  Background
  ──────────────────────────────────────────────────────────────────────────
 Explanation:
             (2)   (4)    (6)    (8)    (10)
RPTCOLOUR 16, 1, 5, 1, 10, 1, 15, 1, 11, 1
         (1)    (3)    (5)    (7)    (9)

 (1) is the Header colour            (7) - Colour for Names
 (2) - Header background             (8) - Names Bkgrnd
 (3) - Border colour                 (9) - Number of drops Colour
 (4) - Border bkgrnd                (10) - Drops Background colour
 (5) - Text Colour
 (6) - Text Bkgrnd

The first number sets the color for the Header and Title on the reports.
in the above example it's 16, which is White, and the number following
the 16 is 1, which sets the background colour to black. Also worth mentioning
is that the numbers 1-8 may be used as both Fore/Background colours, but the
remaining 8-16 are only available for the foreground. If the RPTCOLOUR Verb is
commented out, a plain ASCII SYSOP report will be generated with a RPT
extension rather than an MEC.

 ───────────────────────────────────────────────────────────────────────────
 The Following is Only Used For Automatic Message Creation
 ───────────────────────────────────────────────────────────────────────────
 If you don't want messages written, then comment out this section entirely
 ───────────────────────────────────────────────────────────────────────────

ADDRESS - Your Network Address in the format ZONE:NET/NODE.POINT

MSGPATH - The path ( and BaseName ) to your Private Comments message area.
          Only Squish is presently supported, because I see no reason why
          any Max sysops would want to use anything else :-)  But if this is
          a problem for anyone please let me know, and I'll allow *.MSG creation
          as well.
          Warning messages will be placed into this message base, addressed to
          the user in question and from you as defined with the SYSOP verb.
          ALL messages will be marked as Private.

CDCONTENT - Carrier Drops MSG content file. This is a flat text file that will
            essentially become the body of the message. Full PATH and FileName
            is required! Also worth mentioning is that if %N is found anywhere
            in this file, the %N will be replaced with the total carrier drops
            the user in the from field has accumulated.

CDTHRESHOLD <x> This is the threshold for message creation. Once a given user
                passes <x> drops, they will be issued a warning message.

TOCONTENT - This is the contents file for the Input Timeouts message. Full path
            AND filename are required. As with CDCONTENT, a %N will be replaced
            with the total INPUT TIMEOUTS for the user that the message is
            addressed to.

TOTHRESHOLD <x> The same as CDTHRESHOLD, but for Input timeouts. Once they have
                Input timeout'd <x> times, CallDrop will start writing the user
                warning messages.

LZCONTENT - Again, this is the Path and filename to the contents file for LEECH
            Z modem users. For those who don't know, Leech-Z is a protocol that
            users can use to Download files from the BBS, but it sends an abort
            code during the last few moments of the transfer. Normally this
            will fool the BBS software into thinking the user DID NOT receive
            the file and will not adjust the users Ratio/DL count. Maximus
            2.01wb and greater versions are aware of this protocol, and does
            it's best to report it.
──────────────────────────────────────────────────────────────────────────────
******* NOTE: Be careful with this, because sometimes a LEGITIMATE Download
        will be aborted, and Maximus will report it as a possible Leech-Z
        attempt. Use your discretion, if the user get's logged as having 10
        consequtive leech-Z transfers, it's probably safe to assume s/he's
        using it.
──────────────────────────────────────────────────────────────────────────────
            As with the other content files, a %N anywhere in this file, will
            be replaced with the total Leech-Z reports the user has had.

LZTHRESHOLD <x> If a user passes the value x, then CallDrop will begin sending
                out warning messages.


That'd be it :-)

My Thanks to the Beta-Testers:
( In no particular order )

                 Chris Grainger     -  1:163/518
                 Paul Venne         -  1:163/305
                 Michael Downing    -  1:112/25
                 Randy Hough        -  1:204/7
                 Stephane Seguin    -  1:163/116

Contacting the Author
─────────────────────

           The Author may be conatacted through various electronic means,

                Fidonet 1:163/319        BBS # [phone]
                IMEX   89:483/319

           I'm also generally available in the MUFFIN Maximus Support Echo.
           Netmail is preferred, and is likely the fastest means to contact
           me. If you're reporting a bug, if at all possible, please include
           your CallDrop.Dat file, CallDrop.cfg and your Max.Log snippets.

Warranty
────────
           THERE IS NONE. THIS SOFTWARE IS PROVIDED 'AS IS' WITH NO WARRANTY
           EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE
           IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
           PURPOSE. THE ENTIRE RISK AS TO QUALITY AND PERFORMANCE OF CALLDROP
           AND THE ACCURACY OF IT'S ASSOCIATED DOCUMENTATION, LIES WITH YOU.

           IN NO WAY WILL STEVE MATHIESON BE HELD RESPONSIBLE FOR THE USE OR
           MISUSE OF CALLDROP, INCLUDING BUT NOT LIMITED TO, DEFECTS, DAMAGES,
           LOST MONIES, LOST DATA, OR SPECIAL, INCIDENTAL OR CONSEQUENTIAL
           DAMAGES ARISING OUT OF THE USE, OR INABILTY TO USE CALLDROP.

Copyrights
──────────
CallDrop is Copyright 1992 by Steve Mathieson
Maximus CBCS Is Copyright By Scott J. Dudley.
Squish is a trademark of Scott Dudley.
BlueWave Mail is Copyright by Cutting Edge Computing.
MakeMsg is Copyright by Tower Enterprises and Jeff Galbraith
TheDraw is Copyright by TheSoft Programming and Ian E. Davis.