DP Tool Club 15

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

/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / spot12.zip / SPOTCHEK.DOC < prev next >

Wrap

Text File | 1994-05-29 | 29KB | 736 lines

╓─╖ ╖ ╥ ║ ╙╖╖ ╖╓╖ ╥╓─╖╓── ╥─╖ ╓─╖╓─╖╥╙╖╓╜ ║ ║╙─╢║╙╖║╟─╢║ ─╖╟─╨╖╟─╢╟─ ║╓╨╨╖ ╓─╙──╜──╜╨ ╙╜╨ ╨╙──╜╨ ╨╨ ╨╨ ╨╨ ╙──╖ ║ D E V E L O P M E N T S ║ ╙────────────────────────────────────╜ Innovative Communications Products S p o t C h e k v 1 . 2 By Steve Tupy Copyright (C) 1994 Dynagrafix Developments All Rights Reserved SpotChek v1.2 SpotChek is shareware. Is not a free program and must be registered after an evaluation period of 60 days if you continue its use. Fully functional demo keys are available from the support BBS at (905)-579-3127. See REGISTER.DOC for reistration information. Introduction SpotChek is an Uploaded Files Processor. This version of SpotChek is designed to run with Clark Development's PcBoard BBS system, version 15.0 or higher. SpotChek will do the following, all of which are optional and configurable by the sysop. - Checks to see if this file is unwanted. A TrashCan file is checked for filenames (wildcards accepted) and if the currently uploaded file matches one of the filenames, the appropriate action is taken depending on how you configured SpotChek to handle it. - Does a CRC check of the file to see if it is a duplicate file already uploaded to the system. CRC calculation of the file ensures that the filename can't be changed because the calculation is on the file, not the filename. - Extracts the archive to a temporary directory. This allows SpotChek to do various processing tasks, necessary for archive conversion, virus scanning, and FILE_ID.DIZ insertion. Fully configurable, the only side effect to disabling this option is not having the above options. - Performs a Virus scan with your favorite scanner. Merely enter the command line in the config program and you may use any existing Virus system. - Checks to see if you want to convert all archives to a default format. If you do, SpotChek will recreate an archive and update all the necessary PCBoard files. After a successful convert, SpotChek resumes the remaining tests on the file using the new format. - Performs a CRC override of the archive. This is handy if you have disabled the above functions, but still want to test for CRC integrity, or to recheck a converted archive. - Will optionally insert a Comment file (except LZH, it does not support commenting) into the archive header. Any text file containing your comment can be used. Page 2 SpotChek v1.2 - Checks for files from within the archive that are undesirable. This may include advertisements from other BBS's or any unwanted file. Please remember that the difference between this and the trashcan is that the TrashCan checks the files name, this function checks the filenames within the archive, not the actual filename of the archive itself. - SpotChek will optionally insert a file or advertisement of your choice. This may again be any file you wish to insert. - 6 Archive protocols are supported: ZIP,ARJ,ARC,ZOO,LZH,PAK. - At any time, if the file fails any of the tests, you may optionally move the file to a bad/alternate directory. This may be a file with a virus in it, or any other thing that may have gone wrong with it. The alternate directory may be an offline directory that protects other users from downloading it, at least until you get a chance to check it or remove a virus etc. - Also, at any time, if the file fails, SpotChek will generate a message to either the user or the sysop or both indicating which file failed, what time and other info you may wish to insert. You may also override the users current conference, and force all mail generated by SpotChek into your Main Conference, away from echomail scanners etc. - Two modes of operation are used by SpotChek. UPLOAD is the initial upload of the file and will result in all the tests being run. TEST is a user who is on-line and executing the TEST command, in which case SpotChek will abort the dupe check and the file_id insert as it is assumed it has already been done, making the processor quicker with the task at hand. - Full logging is supported, including filenames and all errors SpotChek might encounter. You may optionally have SpotChek write to its own log file, located anywhere you wish, or simply have SpotChek write to the current default logfile for that particular node. Page 3 SpotChek v1.2 Configuring SpotChek Fire up the configuration program, SPOTCFG.EXE, and start at the top. SpotChek has a full built in help system that would almost ensure a clean configure, but we will go over all the fine points here anyway. Paths/FileNames - Path/FileName of your Add File This is a file you wish to have added to the archive. This may be any filename, as long as it exists. If it does not exist, SpotChek will log an error telling you it could not find the file. - Path to your Temporary Directory Path to a work directory where SpotChek will store temporary files it creates when doing extraction, FILE_ID.DIZ insertion, virus scanning and archive conversion. This directory MUST be empty as SpotChek will wipe it and ALL sub-directories from it that may exist, so please make sure this path is used for nothing else. Here you may want to make use of a RAM drive to increase performance and reduce on drive wear and tear. Please read docs on MULTI NODE if using multi node. - Path/FileName of your StripFile This is a file that includes one filename per line, wildcards permitted, of all the files you want stripped out of the archive. The main difference between this and the TrashCan function is that this takes files from within the archive, not checking the filename itself. - Path/FileName of the TrashCan This is a file that includes one filename per line, wildcards permitted, of all the files you don't want uploaded to your system. The difference between this and the above StripFile option is that this only checks the filename being uploaded (e.g. *.GIF) and will only act on a violation of the filename, nothing else. Page 4 SpotChek v1.2 - Path to your Bad Files Directory Path to an optional directory you may wish to have files moved to when a file fails, for whatever reason. You may then have the file offline, away from prospective downloaders until you can determine if the file can be cleaned or repaired. This may include a directory with files already in them, they are not touched or deleted in any way. - Path/FileName of your Log File This is an optional path to a file that will be maintained by SpotChek. Please note that if the "Log to PCB" prompt on the switches menu will override this. This will only be disabled if you have both the log to pcb prompt set to "N" and this line blank. - Path/FileName of Comment File This is a text file to be used to insert as a comment into the archive. LHA or LZH does not support this. Please remember to leave the first line blank for the proper formatting of the comment file while displaying the header in the text file. If this file does not exist, SpotChek will log an error, but no harm is done. - Path/FileName of Intro Screen A file used for displaying the initial screen to the user. This is a fully qualified path and name of a file that exists. If it does not, SpotChek will ignore it and not show it. There is a sample screen called INTRO included with the distribution archive. Please note that you may at any time disable this function (to further customize your system) by simply leaving the field blank in your config program. Also note that you may use any of the PCBoard color codes as they are translated and shown to users at run time, and ANY PCBoard system macros may also be used, but not all of the same ones the BBS has. Here is a list of available macros available to SpotChek. @AUTOMORE@ @BEEP@ @BOARDNAME@ @BPS@ @CITY@ @CLREOL@ @CLS@ @DATAPHONE@ @DAYBYTES@ @DLBYTES@ @DLFILES@ @EVENT@ @EXPDATE@ @EXPDAYS@ @FIRSTU@ @FIRST@ @HOMEPHONE@ @LASTDATEON@ @MORE@ @MSGLEFT@ @MSGREAD@ @NODE@ @NUMTIMESON@ @OPTEXT@ @PAUSE@ @POFF@ @PON@ @QON@ @QOFF@ @SECURITY@ @SYSDATE@ @SYSOPIN@ Page 5 SpotChek v1.2 @SYSOPOUT@ @SYSTIME@ @TIMELEFT@ @TIMEUSED@ @TOTALTIME@ @UPBYTES@ @UPFILES@ @USER@ @WAIT@ @Xbf .... where b = background color and f = foreground color If you need further assistance with the description of each of these macros, please consult your PCBoard Manual, but please remember, not all of the macros supported by PCBoard are supported by SpotChek. As many as possible were fit in, but limitations kept us from using all of them. All of the above macros are supported by SpotChek. - Path/FileName of Main Screen The Main Screen for SpotChek. This Screen should only ever be designed for use with the first 19 lines. In other words, SpotChek reserves the last 5 lines for the User box ( a small text box which keeps the user updated on what is happening during the processing ). So , if you created a screen which only used up the first 19 lines of the screen, you would not have the over bleeding, or scrolling of the users screen. There is a sample screen included called MAIN in the distribution archive. You may leave this blank to disable the function, but it is strongly suggested to show at least something as all SpotChek puts to the screen is the "Windows" looking box at the bottom of the screen. - Path/FileName of the Failed Screen This is the screen shown to users upon a file failing any of the tests configured. As before, you may use any of the macros within this file, SpotChek will recognize them. There is a sample screen included with the archive called FAILED which you are free to use. You may also create your own. - Path/FileName of the Bye Screen This is a file holding a screen shown to users (optionally) upon leaving SpotChek. This may be disabled by simply leaving the field blank. All of the above macros are supported. There is a sample screen included with this archive called BYE. All screens are in ansi, but can be converted to PCBoard color codes if you wish, or you may draw your own to give your file processor its own flavor. Page 6 SpotChek v1.2 Archivers / Utilities - Archive / Unarchiver Command Lines These are all set up for you, but if you should happen to not use the default settings for the default archivers, you may use any one you wish. Default command line parameters are provided and are adequate for most of the "generic" archiver programs. Please make note that SpotChek supports use of sub-directories, so make sure the archiver is set to extract to sub-directories as well. - Virus Scanner / Command Line Memory can be a consideration here, so if your particular Virus Scanner has any memory requirements beyond an average of 350K (this is only an average, all systems have different configurations and may vary slightly), you may wish to set it up to use extended memory. This is not a fault of Spotchek as it only maintains a minimum of memory, but it is shelled under PCB and may not have as much memory to work with as might be necessary to invoke your particular Virus Scanner. Messaging - To Sysop, Path / MsgFile This is a path and name of a file that holds the text you wish to use as the message text of the message you wish to post to the Sysop upon a file failing SpotChek's testing. This may include any of PCB's color codes or macros, including any of the ones not included above. - To Users, Path / MsgFile Same as above, this is a path and filename of a text file containing the text of the message you wish SpotChek to post to the user upon a failed upload. As above, you may use PCB's color codes. - Force Failed Messages to Main? This is to force SpotChek to place any messages it generates into the main conference by default. This forces SpotChek to find the appropriate base to add the message to. If this is not set, SpotChek will place the message in the users current conference. This may not be desirable as you may have echo bases where you do not want internal system generated messages getting scanned and sent out to other nodes. This toggle is usually set to "Y". Page 7 SpotChek v1.2 Switches - Post Message to User on Failed Upload? This instructs SpotChek to post a message to the User, but only if the file fails the upload tests you have specified. You may have SpotChek not post a message at all, post a message in the users current conference or have SpotChek override and automatically post the message to the main conference. This is preferable in a situation where you may have many echomail conferences and messages of this type are not desirable in echomail conferences. SpotChek will set the private bit by default when generating its messages. - Post Message to Sysop on Failed Upload? The same rule applies here as above, except that the target for this message is for the Sysop. The "To" field will have your name entered as it is entered in your PCBSETUP, so all your regular mail scans should work properly, notifying you of the new mail waiting. The same three options apply here as above. - Move Files to Bad Dir on Failed Upload? SpotChek can move failed files to an offline directory or an alternate directory so that you may investigate it later. The file is moved, not copied, so the original file is deleted. - Insert File Id as Description? Sometimes a file called FILE_ID.DIZ is included with the archive that is uploaded. This is quickly becoming a standard as the file id contains info about the file that may be important to show to the users. SpotChek supports full FILE_ID.DIZ insertion and will automatically insert the file id in place of what the user entered as a description. - Check for Duplicates? SpotChek has an internal duplicate checking system which handles up to 9999 files using a CRC calculation of the file contents. This ensures that the filename hasn't been changed to fool you into thinking it is a different file. A small database is maintained in your SpotChek directory to record the file info. This file will grow as more files get uploaded. For each file, SpotChek reserves 4 bytes of disk space, so if you used the total 9999 files, you would have a 40K datafile, which is easy to maintain. It is done automatically by SpotChek. Page 8 SpotChek v1.2 - How Many Files to Maintain in Duplicate List If the above switch is set to "Y", then this number tells SpotChek how many files to maintain in its list. Please note the size of the file you will have to have in order for this to function. - CRC OverRide Toggle? If for some reason you wish to not use the extract, scan, convert and file id functions, you may still wish to use the CRC test on the archive as an override. Assuming you are using the extract, scan, etc. functions, a successful extract already means the archive has a valid CRC, so this function becomes redundant. In that case, you can shut this feature off. - Convert Files to Default Format? If you have configured SpotChek to extract, scan, and insert, you may also convert all your files to a default format. The amount of bytes uploaded are not changed, however, as the original number of bytes transferred remain the updated amount the user receives credit for. - Default Convert Format This is the 3 character format specifier. Available formats are ZIP, ARJ, LHZ, ARC, ZOO, PAK. - OverRide and Write to PCB log File? This tells SpotChek to put all log entries into your log file specified in your PCBSETUP. SpotChek will append this file with a similar format to PCBoard's. If this is set to "N" and the logfile path is a valid filename, SpotChek will append that file instead of the PCB one. - Refuse Archive with Old Files In it? SpotChek will check the files in the archive for dates that are older than the specified date in the field below. This is just the toggle that will tell SpotChek whether or not to carry out the function. - If Above = Y, What Date is the Cutoff Date for Failed Files? This is the date that will be the cutoff point for the files in the archive. If any file in the archive is older than this date, the file will be considered a failed file. Page 9 SpotChek v1.2 Colors - Box Color This is the color used for the actual box, not the text. The color selection box is easy to use, just point and hit enter. At any time while leafing through the selections, you may hit F10 also to achieve the same thing. - Raise Color The box can be made to appear 3D when using this wisely. This will alter only the left and top sides of the box, giving you shading and giving the impression of a 3 Dimensional box, as is the case with programs such as Microsoft Windows. - Filename Color The color for the actual filename in the box. - Action Color During program execution, there will be many messages sent to the box. This is the color of regular text used for actions during this time and does NOT reflect the color of the text when the current function fails. - Failed Box Color There is also a little flashing box during execution. This can be altered during an error, as is the case with this selection. A bright color such as red works good here as the user sees it easier. - Ok Box Color As with above, when the current function is successful, this color will determine how the box will look. - Dos Box Color When SpotChek needs to call the archiving functions, a box will appear on the top of your screen. You may configure the color of the "dosbox" with this option. Page 10 SpotChek v1.2 Installing SpotChek 1 - Extract all the files in this archive into a directory specified in your path. You do NOT have to have SpotChek in your path, but then you must make sure to specify the path in the call to SpotChek(PCBTEST.BAT). Make sure all executables, and all *.HLP and *.IDX files are in this directory also. You may run the config program from anywhere on your system, but SpotChek will create a config file in the current directory, so use the PCB dir 2 - Run SpotCFG and put in all paths and switches etc. 3 - Install the SPOT.PPE file included with this archive into your PCBTEXT file. MKPCBTXT <PCBTEXT> will work on this in your GEN directory. Line 433 must be altered to reflect a line that looks something like this: !c:\pcb\ppe\spot.ppe This will tell PCB to run the SPOT.PPE. That PPE is only a small PPE that creates a USERS.SYS file as PCBoard does not include such an option. This is important to the function of SpotChek as it is needed for conference paths, directory paths, users name, etc... 4 - Edit a file in your PCBoard directory called PCBTEST.BAT. This batch file should include only the line... SPOTCHEK %1 %2 %3 This is necessary for SpotChek as PcBoard passes certain parameters on the command line, which get translated by the %1 %2 etc. Be sure Spotchek is run from your PCB dir with the config. 5 - Make sure you have PcbSetup->Configuration Options->File Transfers->Verify Uploaded Files set to yes. This will ensure that SpotChek will be called upon to check your files. That is it, SpotChek should be fully functional, provided you set up everything properly. You can contact Dynagrafix Developments to gain access for SpotChek support. Page 11 SpotChek v1.2 Support If you need help with SpotChek you can contact Dynagrafix anytime via the following: BBS (905)-579-3127 (V.32/42 14.4k baud) FidoNet 1:229/412 Youcan also find us lurkingin the Fido PCBNET conference, the international PCBoard sysop echo. Address any problems or questions to Steve Tupy. About Dynagrafix Developments Dynagrafix Developments isa software developmentand marketing company that produces a wide range of software including graphics, business and communications. There are 3 developers currently involved. These are: Greg Newland - Graphic Design Tom Wilson - Software Development Steve Tupy - Software Development Our main goal is to produce softwares that are creative and innovative, and we mean it. The upcoming softwares currently under development and in beta test are not just the same old ideas with new bells and whistles. They are new innovative ideas that do more than what they appear. Below are our main products currently in development: DynaMail DynaMail (or DMail) is an echomail processordesigned with the needs of the future in mind. It features: Processing for Fido, QWK and Internet mail packets Support for PCBoard v15.x and JAM message bases Multiple zone based netmail areas Unlimited number of message areas Handles PC satellite packet processing Areamgr remote maintenance Full gating support between packet formats And LOTS more.... Page 12 SpotChek v1.2 DynaBase Dynabase is a file database utility. It will take over your entire BBS file area system and almost completely self maintain it. It's also a fully functional .TIC compatible file echo processor. It works along side DynaMail and uses most of the same configuration files. It has these features: Automatic file movement between file areas Compression conversion Zip comments Add/delete files from compressed files (bbs ads etc.) Complete file echo support File listing headers and footers File database editor much like PCBFILER or RAMGR Duplicate checking Filemgr remote maintenance And LOTS more...