home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / TELEGARD / MGSUD151.ZIP / MGSUDEL.DOC next >
Encoding:
Text File  |  1992-03-07  |  13.5 KB  |  326 lines
  1.  
  2.  
  3.                                 MGSUDEL
  4.                       ============================
  5.                       Version 1.51 - March 7, 1992
  6.  
  7.  
  8.                    Telegard User File Delete Utility
  9.                    for Telegard 2.7 systems ONLY!!
  10.                                 ===         ======
  11.  
  12.                WARNING!!  WARNING!!  WARNING!! WARNING!!
  13.  Use of this utility on 2.5i/k systems will DESTROY your USER.LST file.
  14. For 2.5i/k systems please obtain MGSUD100.ZIP and use that program instead!
  15.  
  16.  
  17.                           Mt. Glacier Software
  18.                  Copyright (c) 1992 by Michael G. Smith
  19.                           All rights reserved.
  20.  
  21.  
  22.  
  23.             Latest version and Support available on my bbs:
  24.  
  25.                            The Twilight Zone
  26.      Telegard Connecticut State Center Support Site (ex-, I guess)
  27.                              (203)688-0675
  28.  
  29.                            FidoNet  1:142/550
  30.                            USTGNET 85:861/101
  31.                  1200/2400/14.4K/V.32 HST Dual Standard
  32.               (FREQ magic name MGSUDEL for latest version)
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                 Purpose
  68.                                 =======
  69.  
  70.     This utility program deletes users from your USER.LST  file that haven't
  71.     called your system in a set amount of time.  Currently, the criteria for
  72.     deletion is fixed (see below).
  73.  
  74.  
  75.                                 Warranty
  76.                                 ========
  77.  
  78.     This product is provided "as is" without warranty of any kind. The entire
  79.     risk as to the results and  performance of the program is assumed by you.
  80.     Furthermore, the  author does  not warrant, guarantee, or  make any  other
  81.     representations regarding  the use of,  or the  results of the use of the
  82.     program,  and you  rely on the  program and  results  solely at  your own
  83.     risk.  The author  cannot and  will not accept  responsibility for system
  84.     damage, loss of profit, or any other special, consequential or incidental
  85.     damages  resulting  from  the  use  or  inability  to  use this  product.
  86.  
  87.                                Copyright
  88.                                =========
  89.  
  90.     MGSUDEL is Copyright (c) 1992 Mt. Glacier Software by Michael G. Smith.
  91.     It is distributed as Freeware.  You are encouraged to use  this utility
  92.     free of  charge.  Any comments/feedback/suggestions would be gladly
  93.     accepted (see Support section below).
  94.  
  95.                               Distribution
  96.                               ============
  97.  
  98.     You are encouraged to distribute MGSUDEL provided that all files contained
  99.     in the archive  are distributed  in their original  and unmodified state.
  100.     No fee is to be charged above a normal minimal distribution fee.
  101.  
  102.  
  103.                               Description
  104.                               ===========
  105.  
  106.     MGSUDEL is a little utility program I wrote to clean up my own USER.LST
  107.     file.  I was approaching 1000 users, and an analysis showed that many of
  108.     the users had called only once(!), or two to three times.  Other users
  109.     had not called in over a year.
  110.  
  111.     Other "delete" programs are available, but none fit my particular need.
  112.     And I felt like doing a little coding <grin>. In its present state, the
  113.     criteria for deleting a user from the file is fixed and rather arbitrary
  114.     (remember it was to fit *my* particular needs).
  115.  
  116.     Users are deleted as follows:
  117.  
  118.        - Users not logged on in over 365 days.
  119.        - Users who have called <= 3 times, and haven't logged on in 90 days.
  120.        - Users who have called <= 1 time,  and haven't logged on in 30 days.
  121.        - Users with the AC flag "Protection from Deletion" set will NOT be
  122.          deleted.
  123.        - Users who are "Locked Out" will NOT be deleted.
  124.        - Users who are already "Deleted" will NOT be RE-deleted.
  125.  
  126.     MGSUDEL by default creates a complete LOG file of its activities.  This
  127.     file is appended for each execution of the utility allowing you to track
  128.     activity over time.  The LOG file is named MGSUDEL.LOG and is placed in
  129.     the Telegard main directory.  It may be suppressed by using the "NOLOG"
  130.     execution parameter (see below).  Note: The utility also displays
  131.     informative console messages about processing activity and totals.
  132.  
  133.     MGSUDEL by default does not create a backup of the original USER.LST file.
  134.     During processing, it creates a copy of the USER.LST file, flagging users
  135.     as deleted as they meet the qualifications.  At completion, the original
  136.     USER.LST is deleted and the copy is renamed to USER.LST.  If desired, the
  137.     original USER.LST file can be retained as USER.BAK by specifying the
  138.     "BACKUP" execution parameter (see below).  IMPORTANT NOTE: Regardless of
  139.     which whether "BACKUP" is specified, there must be at least enough free
  140.     disk space available to create a duplicate of the original USER.LST file!
  141.  
  142.     MGSUDEL also allows a non-update Estimate Mode processing run.  This mode
  143.     of execution does NOT update the USER.LST file. It creates an output file
  144.     named MGSUDEL.EST that will contain the LOG file entries showing users
  145.     that would be deleted.  It is a good way to see just what will happen
  146.     when you run it "for real".  Highly recommended the FIRST time you run
  147.     this utility, to allow you to examine who will deleted and perhaps set
  148.     the Protection from Deletion flag for any you wish to not be deleted.
  149.  
  150.  
  151.                             Important Notes
  152.                             ===============
  153.  
  154.     MGSUDEL does not adjust the NAMES.LST file which is a problem as deleted
  155.     users will still be able to logon by name.  I strongly recommend you run
  156.     Martin Pollard's utility program NAMEFIX to cleanup the NAMES.LST file.
  157.     This utility is available in the current archive containing the 2.5p+
  158.     code, or from my bbs, or many other Telegard support boards.
  159.  
  160.     MGSUDEL does not delete any mail or voting records for users it deletes.
  161.     I recommend you run Martin Pollard's utility DELEMAIL to delete orphaned
  162.     mail.  Again, this utility is included with the TG 2.5p+ archive currently,
  163.     or can be acquired from my bbs or many other Telegard support boards.  The
  164.     problem of old voting records (in VOTING.DAT) is just that - a problem.  I
  165.     do not know of a utility (currently) that will cleanup this file.
  166.  
  167.  
  168.                                  Usage
  169.                                  =====
  170.  
  171.     MGSUDEL *must* be run from the main Telegard directory (where STATUS.DAT
  172.     resides) in order to locate the files it requires to execute.  Successful
  173.     completion returns a zero condition code, any errors will produce a non-
  174.     zero return code.
  175.  
  176.     MGSUDEL accepts three command line parameters, one of which is required.
  177.  
  178.     Command format is:
  179.  
  180.       MGSUDEL PROCESS|ESTIMATE [NOBACKUP|BACKUP] [LOG|NOLOG]
  181.  
  182.     Where:
  183.  
  184.       PROCESS|ESTIMATE  - ONE of these parameters are REQUIRED for execution.
  185.                           If neither is specified, a command format screen
  186.                           is displayed.
  187.  
  188.                           PROCESS indicates that the USER.LST file should be
  189.                           processed and users deleted according to the above
  190.                           deletion criteria.  At successful completion, the
  191.                           USER.LST file will be updated.
  192.  
  193.                           ESTIMATE indicates that the USER.LST file should be
  194.                           processed and users that *would* be deleted accord-
  195.                           ing to the above deletion criteria will be recorded
  196.                           in the file MGSUDEL.EST.  NO updating of the USER.
  197.                           LST file will take place.
  198.  
  199.       NOBACKUP|BACKUP   - Optional parameter. If not specified, NOBACKUP is
  200.                           the default option. Note: not applicable to ESTIMATE
  201.                           mode processing, and if specified will be ignored.
  202.  
  203.                           NOBACKUP indicates that at successful completion,
  204.                           the original USER.LST file is deleted, and the newly
  205.                           created USER.L$T file is renamed to USER.LST.
  206.  
  207.                           BACKUP indicates that at successful completion, the
  208.                           original USER.LST file is NOT deleted, but is first
  209.                           renamed to USER.BAK prior to the newly created
  210.                           USER.L$T file being renamed to USER.LST.
  211.  
  212.       LOG|NOLOG         - Optional parameter. If not specified, LOG is the
  213.                           default option. Note: not applicable to ESTIMATE
  214.                           mode processing, and if specified will be ignored.
  215.  
  216.                           LOG indicates that processing will create a history
  217.                           log file named MGSUDEL.LOG in the main Telegard
  218.                           directory.  This file is appended for each execution
  219.                           and contains a listing of all deleted users, a date
  220.                           and time stamp, and processing totals.
  221.  
  222.                           NOLOG suppresses the history log file append. Note
  223.                           console displays will not be suppressed by use of
  224.                           this option.  To suppress console displays, simply
  225.                           redirect output to NUL (append "> NUL" to command
  226.                           line.
  227.  
  228.  
  229.                     MGSUDEL Version 1.50 Files List
  230.                     ===============================
  231.  
  232.       MGSUDEL.EXE       MGSUDEL executable program
  233.       MGSUDEL.HST       MGSUDEL change history documentation
  234.       MGSUDEL.DOC       MGSUDEL complete documentation (This file)
  235.       SAMPLE.LOG        Sample output LOG file
  236.       SAMPLE.EST        Sample output EST file
  237.  
  238.  
  239.                               ErrorLevels
  240.                               ===========
  241.  
  242.      0 = Normal completion.
  243.      4 = Invalid or Missing Parameters
  244.      8 = Error Opening or Reading STATUS.DAT File
  245.     12 = Error Opening or Writing Audit File (MSGUDEL.LOG or MGSUDEL.EST)
  246.     16 = Error Opening or Reading USER.LST Input File
  247.     20 = Error Opening or Writing USER.L$T Output File
  248.  
  249.  
  250.                                 Support
  251.                                 =======
  252.  
  253.     I can be reached at the following for support/questions/suggestions about
  254.     this utility (listed in my preferred order):
  255.  
  256.     FIDO:     1:142/550 (FREQ magic name MGSUDEL for latest version)
  257.     USTGNET: 85:861/101 (FREQ magic name MGSUDEL for latest version)
  258.              Use NetMail for fastest reply.
  259.  
  260.     BBS:  The Twilight Zone
  261.           Telegard Connecticut State Center Support Site (ex-)
  262.           (203)688-0675  1200/2400/14.4K/V.32 HST Dual Standard
  263.  
  264.     U.S. Mail:  Michael G. Smith
  265.                 14 Oxford Lane
  266.                 Windsor, CT  06095
  267.  
  268.     Phone:      Sorry. No voice support available.
  269.  
  270.  
  271.                                 History
  272.                                 =======
  273.  
  274.     Version
  275.     -------
  276.       1.00    Initial Release.  Deletion limited to fixed internal criteria.
  277.       1.01    Minor Bug fix for USER.LST with 20 or less user records.
  278.       1.50    Revised for Telegard version 2.5p+ to accomodate major changes
  279.               in the USER.LST file.  Added color to displayed text.
  280.       1.51    Coded around a bug in Borlands MKTIME function when processing
  281.               a user who had last logged on on leap day (02/29/92).  *sigh*
  282.  
  283.  
  284.                         Futures and Enhancements
  285.                         ========================
  286.  
  287.     Well, that all depends.  If I get some positive feedback on this utility,
  288.     I will probably enhance it.  If not, well, it does what I want now...
  289.  
  290.     - The most obvious enhancement would be the ability to specify your own
  291.       deletion criteria.  I envision a .CFG file with some sort of rules based
  292.       input criteria.
  293.  
  294.     - Other input parameters could be accepted from a .CFG file as well.
  295.  
  296.     - Ability to do USER.LST compression, that is, drop the users from the
  297.       file completely and recover the space.  I would envision a parameter
  298.       that would limit the compression to start from a particular user number.
  299.       This would seem especially desirable as the ZSCAN.DAT information (with
  300.       high message pointers) is now stored in USER.LST.  My USER.LST is over
  301.       2 megs now!!
  302.  
  303.     - Ability to natively do related file cleanup. This includes: NAMES.LST,
  304.       SHORTMSG.DAT, EMAIL, and VOTING.DAT files.  I might approach the
  305.       VOTING.DAT file as a separate utility.
  306.  
  307.  
  308.  
  309.              Other Mt. Glacier Software Telegard Utilities
  310.              =============================================
  311.  
  312.     MGSFLOFF - A .DIR file offliner.  This handy utility lets you "split
  313.                out" files that are "offline" (i.e no longer on disk) into
  314.                separate .DIR files.  This keeps your online dirs smaller,
  315.                and lets users toggle off the offline areas in their New
  316.                Scans. FREQ MGSFLOFF from 1:142/550 or 85:861/101 or look for
  317.                MGSFOnnn.ZIP on your favorite Telegard support board.
  318.  
  319.     MGSULL   - A User Uploads Lister for Telegard.  Lists all uploads for a
  320.                specified user. Usable online or offline. Very handy! For
  321.                TG 2.7 systems. FREQ MGSULL from 1:142/550 or 85:861/101 or
  322.                look for MGSULnnn.ZIP on your favorite Telegard support board.
  323.  
  324.  
  325.                      -= End of MGSUDEL.DOC file =-
  326.