Beijing Paradise BBS Backup

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

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

Wrap

Text File | 1992-06-27 | 34.3 KB | 864 lines

███████┐ ███████┐ ProScribe Archive Laboratory ██┌──██│ ██┌────┘ ███████│ ███████┐ A Generic Upload Processor ██┌────┘ └────██│ ██│ ███████│ For Use With Most BBS Software └─┘ └──────┘ ProScribe Archive Laboratory Version 1.0 Copyright (C) 1992 Brett Nyborg Documentation Written by Rizwan Rasheed Registration & Some Routines by Damian Frank Fidonet 1:114/139 USTG/ITCNet 85:823/130 All Rights Reserved, Worldwide PLEASE REFER TO WHATS.NEW FOR DETAILS OF RECENT PROGRAM CHANGES! ProScribe Archive Laboratory v1.0 Documentation Page 1 Table of Contents _________________________________________________________________ Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Program Features . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Program Descriptions . . . . . . . . . . . . . . . . . . . . . . . . 5 Status Display . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 ProScribe Installation / Configuration Utility . . . . . . . . . . . 8 ProScribe Installation . . . . . . . . . . . . . . . . . . . . . 8 Navigating Through The ProScribe Setup Utility . . . . . . . . . 8 Path Names . . . . . . . . . . . . . . . . . . . . . . . . 9 Archivers . . . . . . . . . . . . . . . . . . . . . . . . . 10 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . 10 COM Port . . . . . . . . . . . . . . . . . . . . . . . . . 10 Archive Comments . . . . . . . . . . . . . . . . . . . . . 10 Toggles . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . 11 Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 13 Batch File Construction . . . . . . . . . . . . . . . . . . . . . . . 14 Errorlevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 The ADDCRC.EXE Program . . . . . . . . . . . . . . . . . . . . . . . 18 The MKERRLVL.EXE Program . . . . . . . . . . . . . . . . . . . . . . 19 Bug Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Registration Information . . . . . . . . . . . . . . . . . . . . . . 21 Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Distributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 ProScribe Archive Laboratory v1.0 Documentation Page 2 Introduction _________________________________________________________________ ProScribe is a generic upload processor designed to run on almost any BBS software package. ProScribe currently handles ARJ, LZH & ZIP file formats. ProScribe's main function is to test incoming files for integrity errors, virus infections, and removal of any known BBS ads by their CRC values listed in a database of CRC values supplied with this archive. There are more options to the program, and will be discussed in length in the main documentation. ProScribe was written because the majority of existing upload processors in the market are/were designed to work with PCBoard only. ProScribe will work with almost ANY BBS package that is able to send a complete filename and path specification of the uploaded file as a DOS parameter. If a batch upload is received, ProScribe will still work correctly, provided that the BBS program sends the filename and path specification of each individual file in sequence. ProScribe Archive Laboratory v1.0 Documentation Page 3 Program Features _________________________________________________________________ ■ File integrity testing upon unarchiving. BENEFIT: Detection of bad uploads. Bad uploads can be moved into a hold directory, if desired. ■ Archive format detection by signature using the included ARC-ID software, and NOT just by the filename extension. BENEFIT: A failsafe method of determining the archive format. ■ Virus scanning, using McAfee's SCAN.EXE. BENEFIT: Early detection of potentially dangerous uploads. Uploads that do not pass the virus scan test can be moved into a hold directory, if desired. ■ File date checking. BENEFIT: Enables the sysop to specify the age-limit of the incoming files he/she will allow to be uploaded to the BBS. ■ BBS ad(s) removal. BENEFIT: Gets rid of common BBS ads. ■ BBS ad insertion. BENEFIT: Inserts your favorite BBS ad into uploaded file(s). ■ Archive commenting (ZIP & ARJ formats only). BENEFIT: A more simple method of BBS advertising. ■ Conditional re-archiving. BENEFIT: If the file is unmodified during processing (no BBS ads added and no BBS ads removed), large amounts of processing time will be saved through the skipping of re-archiving. ■ Definitive setup program. BENEFIT: Ease of installation and configuration. ■ Up to 10 archive comments can be specified, selectable by default or by a command line switch. BENEFIT: ■ Up to 2 BBS ads can be inserted. BENEFIT: ■ Multiple exit errorlevels. BENEFIT: Enables the sysop to determine the urgency of the situation and handle it his/her own way. ProScribe Archive Laboratory v1.0 Documentation Page 4 ■ Sysop definable colors. BENEFIT: Allows the sysop to personalize ProScribe to a certain extent. ■ Editable & viewable BBS ad database. BENEFIT: Allows the sysop to expand his/her library of BBS ads that he/she wants removed. ■ Graphical display, shown locally and to the user: BENEFIT: Keeps the user entertained while processing the upload. ■ Upload logfile. BENEFIT: Allows the sysop to, at a glance, look at his/her uploads and determine the cause(s) of errors, if any. ■ Hold directory. BENEFIT: ProScribe will automatically move any uploads that did not pass any part of the processing into a sysop-defined directory. ■ Minimum space requirement. BENEFIT: Prevents large archives from causing a disk full error upon processing. ■ Definable archive program names and archive command line options/switches. BENEFIT: Allows the sysop to configure ProScribe to archive and unarchive uploads according to his/her needs, if necessary. ProScribe Archive Laboratory v1.0 Documentation Page 5 Program Descriptions _________________________________________________________________ When you unarchive the original ProScribe archive, you should see the following files: PROGRAM NAME Description ------------ ----------- WARNING .TXT Read this BEFORE attempting to install ProScribe! WHATS .NEW Whats new in this version of ProScribe PROCESS .BAT Sample batch file PROSCRIB.CFG ProScribe configuration file PROSCRIB.DOC Documentation for ProScribe ADDCRC .EXE Removable BBS ad database "editor" GETCRC .EXE Generates CRC values for files MKERRLVL.EXE Errorlevel generating program PROSCRIB.EXE Main program PSCONFIG.EXE ProScribe configuration utility PSREG .EXE ProScribe registration utility REGISTER.FRM ProScribe registration form CRC .REC Database for removable BBS ads NOLABEL .TXT Text file containing pipe commands ARCID093.ZIP ArcID v0.93 Archive Identification program The following are programs NOT included in the ProScribe archive, but are needed for various ProScribe processes: PROGRAM NAME DESCRIPTION ------------ ----------- ARJ .EXE Archive compress/extract utility UNARJ .EXE Archive extract utility LHA .EXE Archive compress/extract utility PKZIP .EXE Archive compress utility PKUNZIP .EXE Archive extract utility LABEL .EXE (or LABEL.COM) DOS program SCAN .EXE McAfee's virus checker WARNING: DO NOT RUN PROSCRIBE OUT OF ITS WORK DIRECTORY. ProScribe deletes the contents of the current directory where it was started from. Therefore ProScribe should only be started from a "scratch" directory which does not contain important files. Read the documentation completely before running ProScribe. ProScribe Archive Laboratory v1.0 Documentation Page 6 Status Display _________________________________________________________________ When ProScribe is operating, it presents the local display and the remote display with a status display. For example: ╒═════════════════════════════════════════════════════════════════════════════╕ │ ██ ██ ██ │ │ ██ ██ ██ │ │ ██ ██ ██ │ │ ██████████████ ██████████████ ██████████████ │ │ ██ ██ ██ │ │ ██ ██ ██ │ │ ██ ██ ██ (TM) │ │ │ │ ProScribe Archive Laboratory v1.0 │ │ Written By Brett Nyborg │ │ Registered To: Unregistered Evaluation Copy │ ╘═════════════════════════════════════════════════════════════════════════════╛ ╒═══════════════════╡ ProScribe Archive Laboratory v1.0ß ╞══════════════════╕ │ Unzip ■ Scan ■ BBS Ads ■ Zip ■ Commenting ■ │ │ │ │ Status> Checking for removable BBS ads │ │ ███████████████████████████░░░░░░░░░░░░░░░░░░░░░░░ 52% │ │ Ads left: 27 Ads Completed: 31 │ ╘═════════════════════════════╡ PLEASE REGISTER ╞═══════════════════════════╛ The first window contains the program identification and copyright. When you register your copy of ProScribe, this window will also show the name ProScribe is registered to. The second window, or "Status" window, shows the upload processing in progress. This window includes six items: 1. The ProScribe Archive Laboratory title 2. The status light line 3. The verbal status line of upload processing progress 4. The BBS ad removal status bar 5. The BBS ad removal status counters 6. The desperate cry to register ProScribe! Description of the Status Window Items -------------------------------------- 1. The ProScribe Archive Laboratory title. This line is static, except for its color. 2. The status light line. This line shows the current general operation in progress by activating activity lights (the ■'s). ProScribe Archive Laboratory v1.0 Documentation Page 7 3. The verbal status line of upload processing progress. This indicates, in plain text, the operation that is being performed. 4. The BBS ad removal status bar. This is a graphical indicator of the progress of the BBS ad removal process. It shows progress on a 100% scale, and includes a numerical percentage value to the right of the status bar. 5. The BBS ad removal status counters. These show exactly how many ads are left to process, and how many have been processed already. 6. The desperate cry to register ProScribe! This is a blatant cry to support the shareware revolution, in the form of an incessant, blinking red message to PLEASE REGISTER this fine product. As soon as you register ProScribe, this message will go away. ProScribe Archive Laboratory v1.0 Documentation Page 8 ProScribe Installation / Configuration Utility _________________________________________________________________ ProScribe Installation ---------------------- Select a directory in your PATH statement for ProScribe and its associated files to reside in. You may create a new directory exclusively for ProScribe. ProScribe will function properly as long as the directory it resides in is included in your PATH statement. Please refer to your DOS manual if you are unfamiliar with the operation of the PATH statement. Select the directory that you wish to install ProScribe into by using the CD command. For example: CD\PROSCRIB Next, unarchive the ProScribe archive into this directory. Included in the ProScribe archive are miscellaneous archives, like ARCID093.ZIP, etc., which are required for ProScribe to function properly, and which also need to be unarchived in the same directory. The next step is to configure ProScribe. Run the included setup program PSCONFIG.EXE. You will be presented with a full screen display that shows the following options: Path Names Archivers Colors COM Port Archive Comments Toggles Miscellaneous Navigating Through the ProScribe Setup Utility ---------------------------------------------- Generally, to navigate through ProScribe's menus, you use the up/down arrow keys to select the menus and options and ENTER to enter menus and/or modify/select options. On the Minimum Space Free option from the Miscellaneous menu, + and - keys can be used to increment and decrement the value by 100,000 bytes. Further, ] and [ keys can be used to increment and decrement the value by 1,000,000 bytes. On the Latest Date Necessary option from the Miscellaneous menu, the + and - keys can be used to increment and decrement the month field, and the ] and [ keys can be used to increment and decrement the year field. ProScribe Archive Laboratory v1.0 Documentation Page 9 Using the ESC key, you can abort changes in: Any text editing fields, such as the path names and archivers The color selection sub-menus The default archiving comment sub-menu Otherwise, the ESC key exits current menu, saving changes. Lastly, the ESC key exits the program, updating the configuration file with any changes. Path Names ---------- The first line under this menu is the directory where all unarchiving, scanning, and re-archiving of incoming uploads is done. You must create this directory on your own for ProScribe to work. For example: C:\PROSCRIB\TEMP\ Do not use this directory for any other programs because ProScribe will delete the contents of this directory after it processes a file. The second line under this menu is a complete path and filename of the text file that ProScribe will use as a log file. This log file will include information, such as, the beginning and ending times of each ProScribe session, each file that was processed, various status and error messages, BBS ads removed, etc. For example: C:\PROSCRIBE\UPLOAD.LOG The third line under this menu is a directory where ProScribe will place uploads that did not pass any of the ProScribe tests/processes. For example: C:\BBS\HOLD\ The fourth and fifth lines under this menu are full path(s) and filename(s) of BBS ads that you can specify ProScribe to insert into incoming uploads, if applicable. You can specify "NUL" in these two lines to completely disable BBS ad insertion. Otherwise, specify up to two BBS ads that you wish to insert into incoming uploads. If you specify only one, make sure the other line says "NUL". For example: C:\PROSCRIB\BBS1.AD C:\PROSCRIB\BBS2.AD OR NUL NUL OR ProScribe Archive Laboratory v1.0 Documentation Page 10 C:\PROSCRIB\BBS1.AD NUL Archivers --------- Lines 1 through 6 under this menu are the DOS filenames, and command line options that will be used to archive/unarchive incoming uploads for processing by ProScribe. The defaults provided by the sample configuration file with the ProScribe archive should work for most BBSes. It is not necessary to modify any items under this menu at the time of installation. However, if you have a setup where you need to modify some of the command line switches and/or options, you may change the default settings to those that suit your needs. Colors ------ Lines 1 through 8 under this menu are used to define ProScribe's color scheme. It is not necessary to modify any items under this menu at the time of installation. The defaults provided in the sample configuration file with the ProScribe archive should appeal to most sysops/users. However, you may change the default settings to those that suit your needs. COM Port -------- Lines 1 through 4 under this menu are the COM ports that are supported by ProScribe. Select the port of your choice by pressing Enter on the desired port. (This should be the same COM port that your BBS uses) Archive Comments ---------------- Lines 1 through 10 under this menu are complete path(s) and filename(s) of up to 10 different archive comments that you may insert into uploaded archives. Refer to the Miscellaneous menu to select the comment number you wish to insert as a default, as described below under the Miscellaneous menu description. Currently, only ARJ and ZIP archives can be commented. Set any unused lines to "NUL". To make installation easier, do not set line 1 to "NUL" if you plan to use archive commenting. You may set all of these to "NUL" if you do not wish to comment your archives. For example: C:\PROSCRIB\COMMENT1.TXT C:\PROSCRIB\COMMENT2.TXT ...etc. OR ProScribe Archive Laboratory v1.0 Documentation Page 11 C:\PROSCRIB\COMMENT1.TXT NUL ...etc. OR NUL NUL ...etc. Toggles ------- Lines 1 through 5 under this menu are used to define how ProScribe should behave. For example: Always Rearchive. If set to "Yes", all uploads will be re-archived, regardless of whether or not any modifications were done to the file (BBS ads removal, BBS ads insertion, archive commenting). If set to "No", uploads will be re-archived only when necessary. Place AV Stamp. If set to "Yes", an AV stamp will be appended onto any ZIP file that is re-archived. It is generally recommended that if you use this option, you should also set Always Rearchive to "Yes", above. DO NOT SET THIS OPTION TO YES IF YOU DO NOT HAVE A REGISTERED VERSION OF PKZIP, AS IT WILL CAUSE THE SYSTEM TO LOCK UP. (If this happens, you must press a key locally to resume.) Always Add Volume Labels. If set to "Yes", all uploads will correctly handle possible volume labels inside archives. If this option is used, you must make sure that the work drive does not have any volume labels present on it, as they will be inserted into every upload. Also, you should also "de-label" your work drive within your processing batch file. The means to do this are included. No Memory Check on SCAN. If set to "Yes", ProScribe will instruct SCAN.EXE to only check the files in the upload for viruses. If set to "No", SCAN.EXE will check both the files in the upload AND your computer's RAM for viruses. Setting this to "No" will make upload processing slower, as SCAN.EXE will take extra time to scan the RAM. Always Add Archive Comment. If set to "Yes", ProScribe will automatically insert the default archive comment, as described below under the Miscellaneous menu description. Miscellaneous ------------- Lines 1 through 3 under this menu are additional preferences that you may specify. ProScribe Archive Laboratory v1.0 Documentation Page 12 Minimum Space Free. This is the minimum space requirement before ProScribe unarchives the incoming upload. If the minimum space free on your hard drive where your work directory is located is less than the number specified on this line, ProScribe will an error level indicating this condition. Latest Date Necessary. This is the date that the most recent file within the upload must meet or exceed to pass the file date test. If you do not care about the file dates, you can set this to January 1980 (01/1980). Default Archive Comment. This is the number of the default archive comment that you wish to comment incoming uploads with. Valid selections are 1-10. ProScribe Archive Laboratory v1.0 Documentation Page 13 Command Line Syntax _________________________________________________________________ The command line format to run ProScribe is as follows: PROSCRIB.EXE <C:\UD\ARCHIVE.EXT> [/c#] Upon execution, ProScribe will look for a complete path and filename of the upload to be processed and an optional switch indicating the comment number to be inserted into the upload. Command line parameter and option are not case sensitive. If you do not specify a complete path and filename as a command line parameter, ProScribe will exit with an archive identification error. For example: PROSCRIB.EXE C:\UD\TESTFILE.ZIP OR PROSCRIB.EXE C:\UD\TESTFILE.ZIP /c1 AND NOT PROSCRIB.EXE TESTFILE.ZIP ProScribe Archive Laboratory v1.0 Documentation Page 14 Batch File Construction _________________________________________________________________ In order for ProScribe to run correctly, it must be called from a batch file after an upload is received on your BBS. The format for this batch file should be as follows: @ECHO OFF C: CD\PROSCRIB\TEMP PROSCRIB.EXE %1 %2 C: CD\BBS DO NOT RUN PROSCRIBE FROM OUTSIDE THE WORK DIRECTORY. For reference, the work directory is defined in the ProScribe configuration utility. ProScribe does "house cleaning" of the work directory where it was called from, and it will delete ALL FILES and DIRECTORIES, if created, in the work directory. The %1 and %2 parameters instruct ProScribe: the file name, and the archive comment number to use. The %1 parameter MUST be included, otherwise ProScribe will show a help screen and return with a non-zero errorlevel. The %2 parameter may be used to override the default comment number as defined in the ProScribe configuration utility. The following is the batch file included in the ProScribe archive. It has been written to run with Telegard v2.7 BBS. However, it shows the correct ways to handle errorlevels. @echo off d: cd \proscrib\temp proscrib.exe %1 %2 if errorlevel=9 goto error9 if errorlevel=8 goto error8 if errorlevel=7 goto error7 if errorlevel=6 goto error6 if errorlevel=5 goto error5 if errorlevel=4 goto error4 if errorlevel=3 goto error3 if errorlevel=2 goto error2 if errorlevel=1 goto error1 if errorlevel=0 goto error0 echo Something went wrong in PROCESS.BAT pause goto end :error9 ProScribe Archive Laboratory v1.0 Documentation Page 15 d: cd\bbs exit :error8 d: cd\bbs exit :error7 mkerrlvl 0 d: cd\bbs exit :error6 d: cd\bbs exit :error5 d: cd\bbs exit :error4 d: cd\bbs exit :error3 d: cd\bbs exit :error2 d: cd\bbs exit :error1 d: cd\bbs exit :error0 d: cd\bbs exit ProScribe Archive Laboratory v1.0 Documentation Page 16 :end d: cd\bbs exit Since Telegard BBS only accepts one errorlevel for success after integrity testing, this batch file uses the program MKERRLVL.EXE to create errorlevels of "0" wherever required. This may be desirable where you wish to classify certain errorlevels as acceptable (for example, errorlevel 7). (The MKERRLVL.EXE program is included in the ProScribe archive.) ProScribe Archive Laboratory v1.0 Documentation Page 17 Errorlevels _________________________________________________________________ The following errorlevels are returned after ProScribe completes its functions: Errorlevel Description ---------- ----------- 0 Processing completed OK, no errors 1 Not enough space free in the temporary archive directory 2 File uploaded not in ARJ, LZH or ZIP format 3 Virus detected by SCAN.EXE 4 Program error in SCAN.EXE (i.e., not enough memory to run) 5 No parameters specified on the command line (missing filename) 6 Archive identification (file isn't actually a valid archive, OR the actual file specified on the command line is not really there) 7 The user hung up, but the archive processed OK 8 The most recent file in archive did not pass the file date check 9 Configuration file not found in DOS path or current directory ProScribe Archive Laboratory v1.0 Documentation Page 18 The ADDCRC.EXE Program _________________________________________________________________ ADDCRC.EXE is a program that adds new records of files, to a file called CRC.REC, that you do not want to accept as a part of an upload to your BBS. These can be BBS ads from other boards, specific files, etc. Upon encountering these files by their existing CRC in CRC.REC, ProScribe can detect their CRC values and remove them from the upload. Included with the ProScribe archive is a database of known BBS ads that will be removed by ProScribe. Command line syntax is: ADDCRC.EXE <PATH> Example: ADDCRC C:\ADS\*.* Example: ADDCRC BBS.AD You can view the contents of CRC.REC by typing: ADDCRC /V OR ADDCRC /V /P (to enable screen pausing) ProScribe Archive Laboratory v1.0 Documentation Page 19 The MKERRLVL.EXE Program _________________________________________________________________ The MKERRLVL.EXE program is a small utility that can be used to generate any errorlevel from 0-255 within a batch file. The only instance to use this program would be if ProScribe is returning an errorlevel that you wish to change to another value. For instance, if ProScribe is returning an errorlevel of 7, you can use the MKERRLVL program to return an errorlevel of 0 to complete processing correctly. The format for the MKERRLVL.EXE program is: MKERRLVL.EXE 0 This will instantly change any errorlevels in your batch file to a "0" or whatever you definie the value on the command line. ProScribe Archive Laboratory v1.0 Documentation Page 20 Bug Reports _________________________________________________________________ Known bugs: None that we know of. If you encounter any bugs in this program, please report them to us. You may call the BBSes listed below in the distribution sites and report them via email, or you may send netmail to Brett Nyborg at Fidonet 1:114/139 or USTGNet 85:823/130. If you have any suggestions for improving ProScribe, please write to us or netmail us at address listed above. ProScribe Archive Laboratory v1.0 Documentation Page 21 Registration _________________________________________________________________ Qty Item US Price ___ Registration only ........................ @ $5 ea $________ (includes user name on ProScribe screen) ___ Registration & Future Upgrades ........... @ $15 ea $________ (includes user name on ProScribe screen & next 3 updates sent through mail) Please Specify: _____ 5¼" disk OR _____ 3½" disk TOTAL $________ Remit To: Brett Nyborg 9238 S. Heather Dr. Tempe, AZ 85284 Name _____________________________________________________________ Name to be displayed as registered to (Max 58 characters): __________________________________________________________________ Company _________________________________________________________ or BBS Address _________________________________________________________ _________________________________________________________ _________________________________________________________ Payment by: ___ Check (U.S. bank or branch) ___ Money Order Work Phone (____) _____________ Home Phone (____) ______________ Signature ________________________________________________________ This program is not free! You are hereby licensed to use this program for a trial period of 30 days free of charge. If, after 30 days, you decide that you would like to continue using ProScribe, you must complete the registration form (REGISTER.FRM) and return it to the author with the required registration fee enclosed. ProScribe Archive Laboratory v1.0 Documentation Page 22 DISCLAIMER IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. ProScribe Archive Laboratory v1.0 Documentation Page 23 Distributors _________________________________________________________________ You may download the latest version of ProScribe by calling: The Bazaar 602-964-2640 US Robotics HST/v42bis Fidonet 1:114/139 USTG/ITCNet 85:823/130 Central Intelligence Apparatus 602-730-5567 US Robotics HST/v42bis X_Net/UN'INet Node Name: CIA Node ID : 3286 You may also FREQ the latest version of ProScribe by FREQ'ing "PSAL*.*" from Fidonet 1:114/139, or USTG/ITCNet 85:823/130.