home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / prgu101.zip / PRGUSER.DOC < prev    next >
Text File  |  1996-11-26  |  15KB  |  422 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                   PrgUser(c) 
  15.                                     v1.01
  16.  
  17.                    MAXimus 3.0 User Purge Maintenance Utility
  18.                                   WYSIWYG
  19.                              By:  Gary Zarzycki
  20.                     Internet: gary.zarzycki@pnet.playcom.com
  21.                              zarzycki@flash.net
  22.                               FidoNet 1:300/43
  23.  
  24.  
  25.                                                               PrgUser
  26.  
  27.  
  28.                                    Contents
  29.  
  30.  
  31.  
  32.         Introduction........................................... 1
  33.                                                                
  34.         License Agreement...................................... 1
  35.  
  36.         Installation..........................................  2
  37.  
  38.         PrgUser Configuration File............................. 3
  39.  
  40.         ErrorLevel Exits....................................... 6
  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.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.                                       (i)
  80.  
  81.  
  82.                                                               PrgUser
  83.  
  84.  
  85.  1.0 General.
  86.  
  87.     1.1 Introduction.
  88.  
  89.         PrgUser comes in two flavors,  DOS and OS/2 and use  a  common 
  90.         PRGUSER.CTL  file  for  either.  PrgUser  runs as a unattended 
  91.         maintenance application to purge old users from your  USER.BBS 
  92.         file  as configured in your PRGUSER.CTL control file.  PrgUser 
  93.         also cleans the message  area  pointer  files  of  the  purged 
  94.         users, purges your OLR\DATS of purged users if they exist, and
  95.         Automatically Purges/Re-Index's  the pointers for your MUeD or
  96.         UEDit's  USER.EXT  file,  if  it  exists.  PrgUser can also be
  97.         configured to maintain your MAX CALLERS.BBS file and Purge old
  98.         users from your CBK CALLBACK.DAT file, if you use CallBack for
  99.         your  User  Verifications.   PrgUser  will  check  MAXimus for 
  100.         activity and will not purge if active to prevent damaging your
  101.         user data base.   Sorry,  Prguser cannot handle USER.BBS files
  102.         in excess of 4500 users.
  103.  
  104.         PRGUSER allows up to 30  different  'PURGE'  commands  in  the 
  105.         PRGUSER.CTL  file.  These  can  be  set by Access Level,  Days 
  106.         Lapsed since last call,  and optionally by  maximum  calls  to 
  107.         your BBS.  PRGUSER will *NOT* purge any user that has been set 
  108.         to  PERMENENT,  on the same scheme,  if a user has been set to 
  109.         DELETE, PRGUSER will purge this user.
  110.         
  111.         PRGUSER also allows you to  set  your  Logging  Style,  either 
  112.         MAXimus/Binkley style, or FrontDoor style.   The log gives you 
  113.         details of the purging including users names that were purged.  
  114.         The log can be your BBS log file, or Front End Log, as long as 
  115.         the Log file is not is use by a application.
  116.  
  117.  
  118.  
  119.     1.2 PrgUser - Copywrite 1995
  120.  
  121.         Although,  for my protection I have PrgUser Copywrited,  it is 
  122.         being  distributed as FreeWare for use by  MAXimus Sysops in a
  123.         non-commercial environment.  You may not modify or disassemble 
  124.         PrgUser for any reason without written permission.  
  125.  
  126.         If  someone  wishes  to  use  PrgUser commercially,  they must 
  127.         contact me concerning a license to do so,  and are  prohibited 
  128.         from  using  PrgUser commercially unless a single user or site 
  129.         license is obtained from me.  Fees for such is as follows: 
  130.  
  131.  
  132.             Commercial single user License................ $ 10.00ea
  133.             Commercial Multi user site License............ $ 50.00
  134.  
  135.  
  136.                                       (1)
  137.  
  138.  
  139.                                                               PrgUser
  140.  
  141.  
  142.  2.0 Installation.
  143.  
  144.     2.1 Setting up a Directory.
  145.  
  146.         Make  a  subdirectory  using  the MD command from your MAXimus 
  147.         subdirectory for PrgUser, then log into this new subdirectory.  
  148.         
  149.            EXAMPLE:   MD PRGUSER
  150.                       CD PRGUSER
  151.  
  152.         Copy the PrgUser files into this subdirectory.
  153.  
  154.  
  155.     2.2 Executing PRGUSER
  156.  
  157.         PRGUSER can be executed from the command line as follows:
  158.  
  159.             drive:\path\PRGUSER  <drive:\path>
  160.  
  161.         Where  Drive:Path  is  where  you  have  your  PRGUSER.EXE and 
  162.         PRGUSER.CTL files.  If you log into the PRGUSER  subdirectory, 
  163.         the  a  simple  PrgUser  will execute the program.  Optionally 
  164.         PrgUser can be executed from any subdirectory if  you  include 
  165.         the  <drive:\path>  so  it can find it's config file.  PrgUser 
  166.         will use  it's  Prguser.Ctl  and  your  MAXimus  environmental 
  167.         variable maximus= to find all other files.  A over-ride option 
  168.         is  included in the PrgUser.Ctl file to find the MAX.PRM file.  
  169.         Prguser uses one of these options to find your MAX.PRM file.  
  170.  
  171.  
  172.     2.3 Unattended Maintenance Operation.
  173.  
  174.         Set up a maintenance event, either daily or weekly in your BBS 
  175.         or Front End Batch file.  For example,  if you use Front Door, 
  176.         you  would  create  a scheduled maintenance event with a error 
  177.         level exit.  Example Following has a maintenance  event to  do 
  178.         daily maintenance with a errorlevel of 150.  
  179.  
  180.            :Top
  181.              FD
  182.                if errorlevel 200 goto bbscall
  183.                if errorlevel 160 goto ZMH
  184.                if errorlevel 150 goto DayMaint
  185.                if errorlevel 100 goto MailIN
  186.                if errorlevel  10 EXIT
  187.                if errorlevel   1 goto Error
  188.            :DayMaint
  189.               c:\max\prguser\prguser.exe c:\max\prguser
  190.                 if errorlevel 255 ECHO ERROR OCCURED IN PrgUser
  191.                 if errorlevel 5 ECHO ACTIVE FILE FOUND
  192.               GOTO Top
  193.                                       (2)
  194.  
  195.  
  196.                                                               PrgUser
  197.  
  198.  
  199.  3.0 Configuration.
  200.  
  201.     3.1 Setting up your PRGUSER.CTL file.
  202.  
  203.         Description and usage of the PRGUSER.CTL commands are as follows.
  204.  
  205.         MAXdir <drive:path>
  206.         -OPTIONAL-
  207.  
  208.             Optionally this  may be used for PrgUser to  find your MAX
  209.             MAX.PRM  file.   Default uses  your  MAXimus environmental
  210.             variable set maximus=drive:path.   Once Prguser finds your
  211.             MAX.PRM file,  it will obtain  information from it.   This
  212.             option allows you to specify  the full drive and path to a
  213.             MAX.PRM file  if you need to  do so.   PrgUser will backup
  214.             your old USER.BBS file as USER.BAK
  215.  
  216.  
  217.         LogStyle FD
  218.         -OPTIONAL-
  219.  
  220.             LogStyle  FD  controls the type of logging format you wish 
  221.             to use.  Default is MAXimus/Binkley type  log  format.  If 
  222.             wish to log to your FrontDoor,  Intermail type logs,  then 
  223.             you can UnComment the LogStyle FD and PRGUSER  will  write 
  224.             in this format.  This is a Optional Parameter for PRGUSER.
  225.             
  226.  
  227.         LogFile <drive:path\filename>
  228.         -OPTIONAL-
  229.  
  230.             By default,  PrgUser will  use the  Log File  specified in 
  231.             your MAXimus MAX.CTL file,  ie: MAX.PRM.  For mutlitasking
  232.             applications, special environments, etc.  you can use this 
  233.             LogFile option to log your  PrgUser information elsewhere.
  234.             LogFile is the full Drive:Path\Filename of a log you wish
  235.             to use.  If you wish to log to separate log, then use this
  236.             and specify  a path and filename  you wish to use.   Note, 
  237.             make sure  the log you use is  not active  with some other 
  238.             application of a share violation will occure.
  239.  
  240.  
  241.         Purge  <accesslevel> <dayslapsed> <times>
  242.         -REQUIRED-
  243.  
  244.             The Purge Command with parameters controls how you wish to 
  245.             purge  your  system  files.   Up  to  30  different  Purge 
  246.             Commands with Parameters are acceptable.  The Access Level 
  247.             and DaysLapsed are required parameters, with Times being a 
  248.             optional parameter.
  249.  
  250.                                       (3)
  251.  
  252.  
  253.                                                               PrgUser
  254.  
  255.  
  256.  3.0 Configuration.
  257.  
  258.     3.1 Setting up your PRGUSER.CTL file (continued).
  259.  
  260.             The 'A' command controls the  access  level  you  wish  to 
  261.             purge  and  must  match as you have defined in you MAXimus 
  262.             ACCESS.CTL file.  For  example,  if  you  have  Transient, 
  263.             (Twit) set to 0, then a A0 would be used.
  264.  
  265.             The  'D'  command  is the Days Lapsed since the caller has 
  266.             logged onto the BBS.  For example if you have  D30,   then 
  267.             users  that  have  not been on the BBS for 30 or more days 
  268.             will be purged.  
  269.             
  270.             The 'T' command is  a  optional  command  which  sets  the 
  271.             maximum  times  the  user has logged onto the system.  For 
  272.             example,  if you set a T50 with the  A30  and  D180,  then 
  273.             users  with a access  level of  30,  with 180 or more days
  274.             since  their last  call to  the system,  and less  then 50
  275.             logons to  the  system would be  purged.   If the user has
  276.             been on more then 50 times, they would not be purged.  
  277.             
  278.             Following is a example of  the use of the Purge command in 
  279.             your PRGUSER.CTL file.
  280.  
  281.                         Access Level   DaysLapsed   Times
  282.                         ────────────   ──────────   ─────
  283.                 Purge   A0             D30
  284.                 Purge   A10            D45
  285.                 Purge   A20            D180
  286.                 Purge   A30            D180         T50
  287.                 Purge   A65535         D20
  288.  
  289.             In the above example,  the following action  will  occure.  
  290.             In the first case, all users with a access level of 0 with 
  291.             30  or  more  days since their last logon would be purged.  
  292.             The second case, users with a access level of 10 that have 
  293.             not logged on in 45 days would be purged.  The third case, 
  294.             users with a access level of 20 that have not logged on in 
  295.             180 days would be purged.  The fourth case,  users with  a 
  296.             access  level  of  30 that have not logged on in 180 days, 
  297.             and their total times on the system was 50 times  or  less 
  298.             would  be  purged.  The last example,  users with a access 
  299.             level of 65535,  (hidden) and 20 or more days have  lapsed 
  300.             would be purged.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.                                       (4)
  308.  
  309.  
  310.                                                               PrgUser
  311.  
  312.  
  313.  3.0 Configuration.
  314.  
  315.     3.1 Setting up your PRGUSER.CTL file (continued).
  316.  
  317.             If  you  use  MUeD  or  UED's comment field,  Prguser will 
  318.             automatically check to see if the USER.EXT file exists  by 
  319.             obtaining the name and location from you MAX.PRM file.  If 
  320.             it exists,  it will purge all comments that were linked to 
  321.             the  users that was purged and Re-Pack your USER.EXT file.
  322.             PrgUser will  backup your old  USER.EXT file  as USER.UED.  
  323.             PRGUSER will also automatically delete  any  QWK  OLR\DATS 
  324.             data files linked to a deleted user.  
  325.  
  326.  
  327.         SavePrgRecords Y
  328.         -OPTIONAL-
  329.  
  330.             Optionally,  you can tell PRGUSER  to  save  the  USER.BBS 
  331.             Records  of  the users purged.  Each record purged will be 
  332.             appended  into  the  USER.PRG  file.   This   feature   is 
  333.             compatable with MUeD and UED and very useful  with  MUeD's 
  334.             Restore  feature.  PrgUser  will  obtain  the filename and 
  335.             location of your USER.PRG file from your MAX.PRM file.  If 
  336.             you  wish  to  save  the  records,   then  Uncomment   the 
  337.             SavePrgRecords  Y in the PRGUSER.CTL file.  Warning,  this 
  338.             option can create a very large save file  if  you  have  a 
  339.             busy system with a lot of records purged.  
  340.  
  341.  
  342.         CallersBBS <dayslapsed>
  343.         -OPTIONAL-
  344.  
  345.             If you have CALLERS.BBS turned on, and you wish PRGUSER to 
  346.             maintain  this  data  file  for  you,  then you optionally 
  347.             choose to uncomment it and set the days lapsed  to  purge.  
  348.             For  example,  if you set CallersBBS 60,  then all records 
  349.             that are older then 60 days would be purged.  PRGUSER will 
  350.             find your  CALLERS.BBS  filename  and  location  via  your 
  351.             MAX.PRM file.  PrgUser will backup your old CALLERS.BBS as
  352.             CALLERS.BAK.   If you do not have CALLERS.BBS,   or do not 
  353.             wish PRGUSER to maintain your CALLERS.BBS  file  for  you, 
  354.             then leave CallersBBS commented out with a semicolon.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.                                       (5)
  365.  
  366.  
  367.                                                               PrgUser
  368.  
  369.  
  370.  3.0 Configuration.
  371.  
  372.     3.1 Setting up your PRGUSER.CTL file (continued).
  373.  
  374.                 
  375.         CallBack <drive:path>
  376.         -OPTIONAL-
  377.  
  378.             If  you  use CallBack,  and wish to have PRGUSER purge and 
  379.             rebuild your CALLBACK.DAT file of users that  are  not  in 
  380.             your  USER.BBS file,  then UnComment this line and set the 
  381.             Drive and Path to where your CallBack subdirectory resides
  382.             which  contains   your  CALLBACK.DAT file.   PrgUser  will
  383.             backup your CALLBACK.DAT as CALLBACK.PRG.
  384.  
  385.  4.0
  386.  
  387.     4.1 Errorlevel Exits
  388.  
  389.         Prguser supports three errorlevel exits as follows.
  390.  
  391.  
  392.             Errorlevel = 255
  393.  
  394.                 Most cases this will indicate  a  configuration  error 
  395.                 with  the  status  being displayed to the screen along 
  396.                 with logging to your log file.  
  397.  
  398.  
  399.             Errorlevel = 5
  400.  
  401.                 This indicates that PrgUser aborted because a  MAXimus 
  402.                 active  file  was  found.  If  you  do  not  specify a 
  403.                 different log file then you default MAXimus  log  file 
  404.                 as defined in your mAX.PRM file,  PrgUser will not log 
  405.                 this error to your  log  file  to  prevent  any  share 
  406.                 violations or corruption of your log file.  
  407.  
  408.  
  409.             Errorlevel = 0
  410.  
  411.                 PrgUser  completed  it's  purge  cycle.  Status of the 
  412.                 purge process will be displayed  to  your  screen  and 
  413.                 reported in your log file.
  414.  
  415.                     
  416.  
  417.  
  418.  
  419.  
  420.  
  421.                                       (6)
  422.