Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HOTDOG31.ZIP / HOTDOG.DOC < prev next >

Wrap

Text File | 1993-01-20 | 29.3 KB | 678 lines

╔════════════════════════════════╗ ║ A NAPSWare Production Release ║ ╚════════════════════════════════╝ HOTDOG: PCBoard File/User Utility ~~~~~~~ ~~~~~~~ ~~~~~~~~~ ~~~~~~~ Version 3.1 Copyright (C), 1988, 1989 Author NAPS Executive Director John McNamara David Patterson MÄC's Place BBS Viking Magick BBS Dunn, North Carolina Cambridge, Massachusetts (919) 891-1111 [19,200 HST] (617) 354-2171 [9600 MicroCom] Release Date: 8 October 1989 HOTDOG - Version 3.1 Page - 1 HOTDOG - A NAPSWare Production PCBoard Utility ┌────────────────────────────────┐ │ Files included in this ARChive:│ └────────────────────────────────┘ HOTDOG.EXE - Main HotDog Executable File, Version 3.1. HOTDOG.DOC - Information on HotDog PCBoard File/User Utility HOT-CFG.TXT - Sample Configuration File with Comments and Information HOTDOG.CFG - Sample Configuration File without Comments TOPUP - Sample Footer for Production of the Top Uploaders Bulletin WHYTAKE - Sample Footer for Production of the Top Downloaders Bulletin WARNING.!!! - Information and Advice on Upgarding from previous versions of HotDog HOTDOG.HIS - Programme Release History REGISTER.DOC - Registration Information for HotDog README.NOW - Information on Files Available with the HotDog PCBoard File/User Utility NAPSSOFT.TXT - Background Information on NAPSWare Productions NAPSINFO.ZIP - Background Information and Application for NAPS ╔══════════════╗ ║ Introduction ║ ╚══════════════╝ HOTDOG is a PCBoard File/User utility programme that supports PCBoard Versions 11.X, 12.0, 12.1, and 14.0. It WILL NOT work with PCBoard Version 10. HOTDOG helps maintain the security levels within your User database. It can be used to generate reports of your users activities, including a list of your users and a Top UpLoaders and Top DownLoaders bulletins. The main features of the HOTDOG programme include: o Changes security level based on upload/download ratios o Changes security level based on top uploaders information o Changes security level based on top downloaders information o Creates list of top uploaders and an optional ANSI graphic list o Creates list of top downloaders and an optional ASNI graphic list o Creates list of all users with various statistics o You can have security levels that will Not change (i.e. Subscribers and other special users) o Programme eliminates the SYSOP [record one] from all bulletins for security reasons. o Very fast running (2000 users in under 27 seconds on an AT) o Designed for unattended operation during the daily event. o Creates backup file before any modification to the USER file o Share and Network Compatible operation for the UserList and Top UpLoaders bulletins. o Output report format is easy to read and understand. o ANSI color graphic version of Top UpLoaders and Top DownLoaders report is available. o Optional footer information can be displayed after Top UpLoaders information in the bulletin. HOTDOG Version 3.1 Page - 2 One of the primary reasons for the writting of the HOTDOG utility programme was to combine the best features of other security related programs into one comprehensive programme that does everything better and faster. HotDog is designed to let you use any any one or all of its features. You can create a userlist or a top uploaders bulletin without changing the users security levels. You can also adjust security levels based on the DownLoad to UpLoad ratios without needing to create an userlist or top uploaders report. HotDog uses the command line and a configuration file for its operation. A sample configuration [CFG] file is included in the ARChive. The HotDog.Cfg should be modified to reflect the file locations and security levels of your board. The file should be altered with care since the programme reads it in a certain order. All of the configuration lines must be present, excluding comment lines which will be discussed below. ╔═══════════════════════════╗ ║ HotDog Configuration File ║ ╚═══════════════════════════╝ A configuration file must be present for the operation of the HotDog programme. The programme will read the HotDog.Cfg configuration file by default unless another configuration file name is given on the command line. The Format of the HotDog Configuration File is: 1) Location and Name of Users File, PCBoard Version # 2) Location and Name of the UserList Report Output File 3) Security Levels NOT to Change if <= or >= these Values 4) Security Levels NOT to Change No Matter What 5) No. of Top UpLoaders, Security Level to UpDate to, Location and Name of Top UpLoaders Report Output File, Location and Name of the Top UpLoaders Footer File {Optional} 6) No. of Top DownLoaders, Security Level to UpDate to, Location and Name of Top DownLoaders Report Output File, Location and Name of the Top DownLoaders Footer File {Optional} 7) Upload/Download ratios, Security levels There are six one line data information lines [Items #1 through #6]. Each of these lines must have all information contained on one line. Item #7, the download/upload ratio information, can have a multiple number of lines. All seven lines MUST be present since the programme will look for the data by line in this specific order. Every line in the configuration file with a ';' before it is ignored, these lines are all considered comments. A ';' after information on a data line may also be used to represent a comment. The data lines may be separated by as many comment lines as you wish or comment lines may be left out entirely. We will now examine each of the different items in the order which they appear in the configuration file. HOTDOG Version 3.1 Page - 3 ITEM #1 - The Location and Name of the Users File. This line tells the HotDog programme the location and name of the Users file. It must contain a valid PCBoard 11, 12, or 14 Users file or the programme will not be able to do anything. The number following the Users file location is the version of PCBoard, which MUST be 11, 12, or 14. If no number is entered PCBoard defaults to processing version 14. If you specify the incorrect version of PCBoard your users file will be corrupted, so BE CAREFUL. NOTE, HotDog WILL NOT work with PCBoard version 10 - you must use PU Version 1.1 to process a PCBoard version 10 User file. An example line taken from a sample configuration file is as follows: C:\PCB\MAIN\USERS 14 ; Name and Location of Users File, ; Version of PCBoard (11, 12, or 14). ITEM #2 - Location and Name of Userlist Report. This line tells HotDog where to place the Userlist that it will create if if the userlist option is selected. Many SysOps will want to send the the userlist output straight to a bulletin file. An example line is as follows: C:\PCB\GEN\BLT15 ; Name and Location of the UserList ; Bulletin File. ITEM #3 - Security Levels to Change This line contains two numbers, a range of security levles that can be changed - that is a minimum and a maximum security level that can be modified. HotDog will not change any security level equal or less than the first number nor will it change any security level equal to or greater than second number. This option is useful if you have a certain level that everyone above or below is exempt from the DownLoad/UpLoad security level and the top uploaders and top downloaders security level calculations. For example, I keep all my subscribers and special users at a level of 40 or higher. I do not have have a lower level I don't wish to change so my line is as follows: 0 40 ; Do NOT alter security levels <= #1, ; or >= #2 Note that HotDog will NEVER alter a security level greater then or equal to 100. It will also NEVER change a security level of 0, since zero [0] represents deleted and/or locked out users. These values are hardcoded into the programme and may NOT be changed. This insures that the sysop's record and locked out users will not have their security levels changed. ITEM #4 - Security Levels Not to Change Under Any Condition This line is for security levels that are not to be altered under any condition. This line is used for any security levels that you wish not to alter that do not fall into item #3 ranges. You may have as many numbers as you want in this line, but there must have at least one 1 number, even if it is zero. An example line is as follows: HOTDOG Version 3.1 Page - 4 18 34 39 23 ; Security levels Not to change no matter ; what ITEM #5 - Top UpLoaders Information. This line contains information about what you want done with your Top Uploaders analysis. It is in the format: 1. # of Top UpLoaders to list in the Bulletin 2. Security Level to Upgrade the Top UpLoaders to, a zero [0] means that the Top UpLoaders should be kept at their original Security Level - ie - No Change. 3. The Location and Name of the Top UpLoaders Bulletin File 4. The Location and Name of the Top UpLoaders Report Footer file. NB - The actual data line should be seperated by spaces. The first item is a number between 1 and 100, the second is a number between 0 and 110, the third is a valid location and filename for the top uploaders bulletin. You should enter a "0" in the "Update to Level" field, if you do NOT wish to give your Top UpLoaders a special Security Level. If you enter a 0 only the Top UpLoaders Bulletin file will be created; NO level adjustments will be made. If you do NOT want to use a footer in your top uploaders report, simply enter 'NUL' in that space. You may still create a report and and not update any security levels if you wish. One special feature of the Top UpLoaders bulletin is the inclusion of a a footer after the Top UpLoaders information. The footer can be used to display any information that you would like your users to know - from basic imformation to advertisements. HotDog support the display of up to three screens [23 lines each] of information. The Top UpLoaders bulletin shown below provides an example of a two line footer. If the /G option is specified on the command line, HotDog will create an ANSI graphic version of the top uploaders report. This file will be created by appending a G to the output file specified. For example, if BLT11 were the output file, a BLT11G would also be created with the graphic report. HotDog will also look for a graphic footer file, the name of the footer file with a G appended to it. If this file does not exist it will simply use the non-graphic footer file if it exists. An example line is as follows: 10 0 C:\PCB\GEN\BLT11 C:\PCB\GEN\FOOTER ; # of UpLoaders, New Level, ; Name of Report, Footer ITEM #5 - Top DownLoaders Information. This line contains information about what you want done with your Top DownLoaders analysis. It is in the format: HOTDOG Version 3.1 Page - 5 1. # of Top DownLoaders to list in the Bulletin 2. Security Level to Change the Top DownLoaders to, a zero [0] means that the Top DownLoaders should be kept at their original Security Level - ie - No Change. 3. The Location and Name of the Top DownLoaders Bulletin File 4. The Location and Name of the Top DownLoaders Report Footer file. NB - The actual data line should be seperated by spaces. The first item is a number between 1 and 100, the second is a number between 0 and 110, the third is a valid location and filename for top downloaders bulletin. You should enter a "0" in the "Update to Level" field, if you do NOT wish to give your Top DownLoaders a special Security Level. If you enter a 0 only the Top DownLoaders Bulletin file will be created; NO level adjustments will be made. If you do NOT want to use a footer in your top downloaders report, simply enter 'NUL' in that space. You may still create a report and and not update any security levels if you wish. One special feature of the Top DownLoaders bulletin is the inclusion of a a footer after the Top DownLoaders information . The footer can be used to display any information that you would like your users to know - from basic imformation to advertisements. HotDog support the display of up to three screens [23 lines each] of information. The Top DownLoaders bulletin shown below provides an example of a footer. If the /G option is specified on the command line, HotDog will create an ANSI graphic version of the top downloaders report. This file will be created by appending a G to the output file specified. For example, if BLT22 were the output file, a BLT22G would also be created with the graphic report. HotDog will also look for a graphic footer file, the name of the footer file with a G appended to it. If this file does not exist it will simply use the non-graphic footer file if it exists. An example line is as follows: 10 0 C:\PCB\GEN\BLT22 C:\PCB\GEN\FOOTER ; # of DownLoaders, New ; Level,Name of Report, Footer ITEM #7 - Adjust the DownLoad-UpLoad Security Levels All the rest of the lines in the configuration file are used to calculate a users security level based on their download to upload ratio. The lines must be in numerical order with the lowest numbers first. The download upload ratio is represented by using a negative number to represent more downloads then uploads and a positive number to represent more uploads than downloads, with zero being used to represent an equal amount. Thus if a person has downloaded 20 files and uploaded 5 his ratio would be -4 ( 20/5 with a negative sign used to represent more downloads than uploads). If a user had downloaded 2 files and uploaded 5 his ratio would be 2.5 ( 5/2 with a positive sign used since there were more uploads than downloads). It is important to remember the larger of the two numbers is always the numerator of the fraction and the lower number is the denominator. A special case occurs when someone has download a file(s) and uploaded zero or uploaded a file(s) and downloaded no files. When this happens HotDog simply calculates the ratio by substituting a one for the zero. For example ten downloads and zero uploads yields -10 ( 10/1 with a negative sign). HOTDOG Version 3.1 Page - 6 This is all probably easier to understand then it is to explain, so if you still don't understand, take a look at the following example: -100 1 ; 100 DownLoads to 1 UpLoad -- Security Level 1 -50 5 ; 50 DownLoads to 1 UpLoad -- Security Level 5 -30 10 -20 15 -15 22 -12 24 -8 25 0 30 ; Less than 8 DLs to 1 UL -- Security Level 30 1.5 32 2.0 34 ; 2 UpLoads for every 1 DL -- Security Level 34 3.1 36 5.0 38 10.0 39 Security levels are set starting from the lowest ratio (lowest number). The programme starts out by giving each user the lowest ratio available and working its way up to the ratio the user actually has. So, for example if a user had a ratio of -6 he would be awarded a security level of 30, since his level of -6 is > -8 but < then the next ratio of 1.5. A user with a ratio of 2.0 would be awarded a security level of 34 by the same reasoning. A user with a ratio of -100 would be awarded a level security level of 1 since that is the lowest ratio available in this configuration file. A user with a ratio of 10.0 would be awarded a security level of 39 since that is the highest level in the configuration file. That is all there is to setting up the configuration file. The easiest way to set it up is to make a copy of the HOTDOG.CFG that is included with the distribution ARChive and modify it to reflect the configuration of your system. ╔═════════════════════╗ ║ HOTDOG Operation: ║ ╚═════════════════════╝ HOTDOG is easy to use. It operates by using the configuration file and command line switches. If you simply enter HotDog without any switches a short help message will be printed. The command line usage for HotDog is: HotDog [configfile] [/U /T /D /G /S] /U -- Create a UserList Bulletin /T -- Create a Top UpLoaders Bulletin /D -- Create a Top DownLoaders Bulletin /G -- Create a Graphics Top DownLoaders and/or UpLoaders Bulletin /S -- Update the Users Security based on their UL/DL ratio. NB - If Top UpLoaders is selected with the '/T' option, their Security Level will be raised to the Top Uploaders Level as specified for Item #5. If Top DownLoaders is selected with the '/D' option, their Security Level will be changed to the Top DownLoaders Level as specified for Item #6. HOTDOG Version 3.1 Page - 7 The /U option will create a userlist report to whatever file you have specified in the configuration file. The action only reads the users file and does not write to it, thus no backup file is created. The first record in the USER file [SYSOP] will Not be listed in the UserList bulletin for security reasons. The /T option creates a top uploaders report. If in addition a /G is specified HOTDOG creates a graphic version of the top uploaders bulletin. The /T option causes HOTDOG to only read the users file. The SYSOP record [first record] in the USER file will Not be listed in the Top UpLoaders bulletin for security reasons. [Thus, SYSOP who upload file remotely to their system do not have to keep changing their USER record information to make sure that they are not listed as a Top UpLoader]. The /D option creates a to downloaders report. If in addition a /G is specified HOTDOG creates a graphic version of the top downloaders bulletin. The /T option causes HOTDOG to only read the users file. The SYSOP record [first record] in the USER file will Not be listed in the Top DownLoaders bulletin for security reasons. [Thus, SYSOP who download file remotely from their system do not have to keep changing their USER record information to make sure that they are not listed as a Top DownLoader]. The /S option performs a security level update of the users file based on the DownLoad/UpLoad ratio lines in the configuration file. Whenever the /S option is specified a backup users file is always created. If the /S and /T option are both specified the top uploaders will also have their security level updated to that specified by the configuration file. These options may be used in any order but they must all be separated by a spaces and have a '/' in front of them. A example is as follows: HotDog C:\PCB\Utility\HotDog.Cfg /T /D /G /U /S If you do not specify a configfile file, HotDog will try to use the file called HotDog.CFG in the current directory. The above example would look for the configuration file in the specified location. Then, it would create a top uploaders bulletin, a graphic top uploaders bulletin, and a userlist report. It would also update security levels based on the top uploaders and DownLoad/UpLoad ratios. This programme should first be run on a backup of your users file. After running it check to make sure it has done what you want before using it on your working users file. A good way to check is to browse through the updated users file with PCBSM - the PCboard System Manager. If HOTDOG is invoked with no parameters, an explanatory help message will be printed to the screen, including: o Command line usage of the programme. o Brief information on each of the command line options. A typical Top Uploader output bulletin file produced by the above command line would be: HOTDOG Version 3.1 Page - 8 ╔═╦═╗ ╗ ╔ ╔═╗ ╦ ╔═╗ ╔═╗ ╦═╗ ╔═╗ ╦═╗ ╔═╗ Generated by: HOTDOG V3.1 ║╔═╗╔═╗ ║ ║ ╠═╝ ║ ║ ║ ╠═╣ ║ ║ ╠══ ╠═╣ ╚═╗ Released: 10 October 1989 ╩╚═╝╠═╝ ╚═╝ ╩ ╩═╝ ╚═╝ ╩ ╩ ╩═╩ ╚═╝ ╝ ╚ ╚═╝ MÄC's Place 919-891-1111 ╩ Top 10 Uploaders as of Sun October 07 23:06:50 1989 User Name Calling From Last On # of UL's ____________________________________________________________________________ BILL KELSEY CAMBRIDGE, MA 10-29-88 119 BILL BOUTILIER ABINGTON, MA 11-16-88 58 DEIRDRE COWDEN VALENCIA, CA 11-27-88 43 JAMES ANDERSON TORONTO, ON 11-29-88 41 JOHN MCNAMARA BEDFORD, MA 11-25-88 41 FRED KANTER BROOKLINE, MA 12-02-88 38 KEN SOMERVILLE CHARLESTOWN,MA 11-30-88 32 WILLIAM DAVIS SOMERVILLE, MA 11-09-88 32 FRANK GLADU BROCTON, MA 11-15-88 32 MARK ROBINSON CHELSEA, MA 11-29-88 32 ____________________________________________________________________________ VIKING MAGIC thanks you for contributing to the evolution of the MAGIC Norseman !! ____________________________________________________________________________ A typical Top Doloader output bulletin file produced by the above command line would be: HOTDOG Version 3.1 Page - 9 ╔═╦═╗ ╦═╗ ╦ ╔═╗ ╔═╗ ╦═╗ ╔═╗ ╦═╗ ╔═╗ Generated by: HOTDOG V3.1 ║╔═╗╔═╗ ║ ║ ══ ║ ║ ║ ╠═╣ ║ ║ ╠═ ╠═╣ ╚═╗ Released: 10 October 1989 ╩╚═╝╠═╝ ╩═╝ ╩═╝ ╚═╝ ╩ ╩ ╩═╩ ╚═╝ ╚ ╚ ╚═╝ MÄC's Place 919-891-1111 ╩ Top 10 Downloaders as of Tue October 09 23:36:04 1989 User Name Calling From Last On # of DL's ____________________________________________________________________________ JAMES SHEFF LOWELL, MA 02-20-89 147 JEFF BERNTSEN KEENE, NH 03-28-89 121 DON ZANETTI NEWTON, MA 04-04-89 107 ART WYNN PEABODY, MA 05-02-89 104 RAJESH SUD BOSTON, MA 04-21-89 91 PHIL DUBB CAMBRIDGE, MA 05-04-89 85 ALEX PRENGEL WALTHAM, MA 03-07-89 85 MICHAEL BARON WOODLAND HILLS, CA 03-25-89 84 PAUL MAX MELROSE, MA 04-10-89 78 MARK ROBINSON CHELSEA, MA 04-28-89 77 ____________________________________________________________________________ The Magickal Viking wonders why these particular Users have DOWNLOADED so many files from the VIKING MAGICK BBS !! We hope that they have found them useful. It is hoped that they might also consider contributing files to the evolution of the board. Otherwise, the powerful Viking might have to seek advice from the Magickal Runes on their continued admittance to his domain..... ____________________________________________________________________________ And a typical UserList output bulletin file produced by the above command line would be: ╗ ╔ ╔═╗ ╔═╗ ╦═╗ ╦ ╦ ╔═╗ ╔═╦═╗ Generated by: HOTDOG V3.1 ║ ║ ╚═╗ ╠═ ╠═╣ ║ ║ ╚═╗ ║ Released: 10 October 1989 ╚═╝ ╚═╝ ╚═╝ ╝ ╚ ╩═╝ ╩ ╚═╝ ╩ MÄC's Place 919-891-1111 ╔═════════════════╦═════════════════════╦════════╦═════╦══════╦═════╦════════╗ ║ Users Name ║ Calling From ║ Last On║ UL's║ DL's ║ Msg#║ #Calls ║ ╚═════════════════╩═════════════════════╩════════╩═════╩══════╩═════╩════════╝ BEN SMITH MEDFORD, MA 09-08-88 7 3 2238 46 JEFF ADAMS RUTLAND, VT 09-15-88 0 0 0 2 KIRK ANDERSON SAN ANGELO, TX 11-08-88 0 0 1600 1 ALLEN BAKER MILTON, MA 11-21-88 0 0 0 5 MARC BEAUDOIN ST-JEAN QUEBEC 09-31-88 2 3 1819 12 . . . . HOTDOG Version 3.1 Page - 10 ╔══════════════════════╗ ║ HOTDOG Background: ║ ╚══════════════════════╝ The HOTDOG programme originated from PU. David Patterson is mostly responsible for the complete documentation package contained herein. John McNamara wrote the HOTDOG programme. Brian Miller, SysOp of Channel One, created the name for the programme - HotDog. Both David and John can be contacted through the NAPS support conference which is one of the national PCRelay International network conferences. All messages concerning support of HOTDOG or any other NAPSWare Production programme doors and utilities should be left in the NAPS conference which can be accessed through most NAPS member boards. The HOTDOG programme is written in C and compiled with Microsoft C 5.1. The C language was choosen for writing several of the NAPSWare Production PCBoard utilities such as HOTDOG because of its speed and flexibility. The MSC source is NOT available. When I finished the program I said now its "MILLER" time. (Brian that is) Adam Szwarc is acknowledged for help with the Debugging of the programme. We also thank several PCBoard SysOps who helped with the beta testing of the programme, inchuding Brian Miller of Channel One BBS and Jim Boxmeyer of Synergy. The latest version of the HOTDOG programme and other NAPSWare Production PCBoard utilities can be obtained from most NAPS member boards. NAPSWare Production software are PCBoard Doors and Utilities written by NAPS [National Association of PCB SysOps] members. These programmes (including Graffiti Wall, HotDog User Utility, and HotStuff File Utility) will always be UserWare - that is Public Domain and freely available to All PCBoard SysOps. NAPS is an association of Regional Chapters that have been organized to insure users a high quality of Bulletin Board Systems. NAPS Member Boards are certified, assuring users that the SYSOPS are responsible people who are dedicated to running highest quality Bulletin Boards. If you have any questions, bugs, or suggestions for the HOTDOG programme, please contact National Association of PCB SysOps at either: Author: NAPS Executive Director: John McNamara - SysOp Dave Patterson - SysOp MÄC's Place BBS Viking Magick BBS (919) 891-1111 [19,200 HST] (617) 354-2171 [9600 MicroCom] HOTDOG Version 3.1 Page - 11 All written correspondence should be sent to: David Patterson, Executive Director National Association of PCB SysOps NAPSWare Productions 63 Liberty Street Acton, Massachusetts 01720