ftp.wwiv.com/ftp.wwiv.com.zip/ftp.wwiv.com/pub/UPCHECK/PCBCK12D.ZIP/PCBCHECK.DOC

Text File | 1994-01-29 | 30KB | 581 lines

                       PCBCheck Advanced Upload Checker
                              v.1.2  Jan 29, 1994
                                    Jim Dahl



┌────────────────────────────┐
│ 1.  Mission and conception │
└────────────────────────────┘

  I created PCBCheck (mainly for in-house use) when I was first exposed to
the difficulty in setting up other PCBoard upload checkers.  Creating a
SETUP.CNF file and putting 50 seperate pieces of information on different
lines in certain formats is not a nice way to set up a program!  In fact,
any program other than a BBS utility, would fail miserably if it required
such an intricate setup.  BBS utilities do not need to be so complicated to
setup!
  Comments are very welcomed and bug reports are PROMPTLY addressed!  I will
make and upload to you a special version of PCBCheck between releases if
necessary to get your system running!

┌────────────────────────────┐
│ 2.  Features               │
└────────────────────────────┘

  As mentioned above, I believe the main feature of the program is its
easy-to-use SETUP program!  I also think PCBCheck has kind of a cool,
modern PCBoard 15.0 look that others lack.  Specific functions are:

    *  Archive support is through PCC (archive information) files,
         NOT internal code, so new archivers can be added with a simple
         100 byte file!  (I would tell you how to make your own, but I
         may just change it, and I don't want to be responsible!  Should
         you ever need new PCC's, just send me the archiver and I'll make
         it!)
    *  Easy-to-use SETUP program which dynamically adjusts its menus
         based on your system setup, selected options, installed
         archivers, etc...  No wasted menu space, asks only those questions
         which affect you!  It even sets up your PCBTEST.BAT file for you!
    *  PCBCheck features advanced output (in graphics mode) which dynamically
         alters itself based on the type of upload, tests to be performed,
         etc...  A few examples:  When testing a GIF, a slot for resolution
         appears in the space normally used by the 'testing embedded
         archives' slot; when PCBCheck replaces the description with the
         FILE_ID.DIZ the change is reflected on the line of the description
         displayed on the screen, etc....  There will never be prompts which
         are irrelevant to the current upload displayed.
    *  Integrated GIF integrity checking and resolution reporting (no more
         third party utilities!  Though of course, you don't have the FULL
         flexibility of third party utilities, so anything can be disabled
         at your convenience!)
    *  Flexible virus scanning (you specify your favorite third-party
         virus scanning utility, give SETUP the information about it, and
         PCBCheck can use it!  F-Prot is supported by default with
         no real knowledge required)
    *  Hack report checking.  PCBCheck can currently read hack report IDX
         and test uploads against the list of hacks, trojans, and pirated
         software.  (Note- I haven't seen a new hack report since Sept.,
         not sure what's up.  But it's still quite useful even with just
         the indices through September!)
    *  Reason for failure is noted in the archive description, before the
         failed upload is moved to the private upload directory.  The
         reason is noted on its own line, so you should easily be able to
         remove the line after reading it and deciding for yourself whether
         you want to keep or kill the file.  It's all right there, easy to
         read from PCBFiler!
    *  PCBCHECK.LOG error log file is maintained so the sysop can track
         errors, not only in PCBCheck itself, but in the programs it spawns,
         such as virus scanners or archivers.

  Of course, it does all the usual stuff, date checking, integrity checking,
embedded archives, etc...

┌────────────────────────────┐
│ 3.  Installation           │
└────────────────────────────┘

  PCBCheck should be installed in it's own directory, preferably close to
the root directory.  DOS places limits on command and parameter lengths, and
PCBCheck can often come dangerously close to those limits while executing
complex archive/dearchive commands!  Putting PCBCheck in a directory
directly off the root directory gives it more room to play with by
shortening the paths to PCBCheck data files.

  The installation directory should not contain any files named HACK????.IDX,
except for actual hack reports, as PCBCheck will attempt to read them as
hack reports and probably crash.

  When PCBoard wants an upload checked, it calls PCBTEST.BAT in its home
directory.  SETUP will modify PCBTEST.BAT for you if it detects that
PCBTEST.BAT does not already run PCBCHECK and you tell it that it is
allowed to modify PCBTEST.BAT.  Note that you may need to add a special
parameter yourself.  The command line for PCBCheck reads:

  X:\<your-path>\PCBCHECK.EXE %1 %2 %3 [port]

  The optional parameter [port] (which SETUP leaves out by default) allows
you to specify an address for PCBCheck to use for serial output.  The default
(nothing specified) is for PCBCheck to read PCBoard's PCBOARD.DAT to
determine the COM port number, and then the COM port number is converted to
its standard address.  Particularly if you use COM3 or COM4 the address may
not be the default.

  Please configure your PCBoard setup to give over as much memory as possible
during any shell (not just doors, since this technically isn't a door).
In System Setup, under Configuration Options, then Configuration Switches,
set "swap during SHELL" to yes to free up more memory (at the cost of
slightly slower swapping).  Please read the section special memory
considerations, particularly if you have had any mysterious ill-behavior
from PCBCheck.

  Change directories to the PCBCheck directory you created earlier and run
SETUP.  This document explains the various features of SETUP later.

  I strongly recommend all PCBCheck users have SHARE installed (most BBS
computers already should).  Also, adding PCBCheck to the path seems to help
some users.

┌────────────────────────────┐
│ 4.  Setup                  │
└────────────────────────────┘

  4.1 Archive support

  The archive support page includes three fields and an information box.
The first field is a simple yes/no question whether or not you want to
accept uploads in that format.  SETUP creates an archive support page for
each PCC file it finds, so you may choose any combination of archivers for
which you have PCC files.

  The second and third fields are user-specific parameters you want passed
the archiver.  These fields should be blank for all people and all archivers,
but are included just in case (i.e. PKZip 2.04c had DPMI problems, so some
users may have needed to specify -) to disable DPMI).  DO NOT put the
parameters for archiving/dearchiving, etc... in these fields, that
information is in the PCC file.  These fields are for hardware-specific
parameters which are required to make the archiver/dearchiver do ANYTHING on
your machine.

  The information box scans the path for the archiver/dearchiver and reports
the presence of each.  If the archiver and dearchiver use the same executable
it notes that as well.  If SETUP reports that your archiver or dearchiver are
NOT in the path, and you have specified that you wish to support that format,
you put them in the path!

  4.2  Non-archive support

  The non-archive support screen allows you to enter the extensions of
acceptable non-archives.  You do not need to fill all or any of the fields,
though you cannot specify more than ten acceptable non-archive extensions.

  Special files which have internal PCBCheck support, such as GIF files, must
still be specified here to clear the detection phase of PCBCheck!  Self-
extracting archives in the form of EXE files are the only exceptions.  They
are considered archives, so if the archiver support is enabled on the
appropriate page and self-extracting support is enabled on the miscellaneous
page, PCBCheck will accept self-extracting archives as EXEs.  If you specify
EXE here, you will be telling PCBCheck to accept all executables.

  4.3  Miscellaneous pages

  Note that not all fields will appear in all situations.  For example, if
you have specified that you don't want to scan for viruses, SETUP will not
bother to ask you what virus checker you want to use, etc.....

    4.3.1  Minimum age of uploads

  You can use this field to specify a minimum age for uploads.  The age
should be entered as an integer (no decimals!) between 0 and 99.  The
integer represents the maximum number of 'months old' that you want
accepted.  PCBCheck will base the age on the newest file in the archive.
If you do not wish to have age checking, specify 0 and PCBCheck will accept
any archive, no matter how old (note that SETUP replaces 0 with a blank
field).

    4.3.2  Allow self-extracting uploads

  This parameter tells PCBCheck that if an EXE file is uploaded, and EXEs
are not specified as allowable non-archives, to check if the EXE is really
a self-extracting archive.  You must specify an archive type as acceptable
in the archive pages for PCBCheck to allow self-extracting archives in that
format.

    4.3.3  Replace comment

  Answer this question (yes/no) if you want PCBCheck to replace the archive
comment.  (Many archivers allow a 'comment' to be inserted into the archive,
then usually display the comment while dearchiving).  Specifying 'yes'
creates another field, 'File with which to replace comment'.

    4.3.4  File with which to replace comment

  Enter a filename of the file you wish to use to replace the comment.
WARNING!  Archivers allow different lengths of comments.  Attempting to
insert a comment which is too large will have unpredictable results
(dependent on the archiver, really, I guess).  Note that if you leave this
field blank or as its default, setup will insert 'NUL'.  That means to
replace the comment with nothing, or to clear the comment (which is what
I recommend).  You must create the file yourself in the PCBCheck directory.

    4.3.5  Enable virus scanning

  Answer this question (yes/no) to tell PCBCheck whether or not it should
scan the upload for viruses.  Specifying 'yes' creates three new virus
information fields.  (The defaults for all 'virus scanning' fields work
with McAfee's SCAN).

    4.3.6  Filename of virus scanner

  Fill this field with the name of the executable of the virus scanner you
want PCBCheck to use.  The virus scanner need not be in the PCBCheck
directory, only in the path.  (Do not add a path name in this field!)  SETUP
will not warn you if the virus scanner does not exist in the path, so you
must make sure it does!
  I have changed my recommendation since PCBCheck originated.  I now
recommend F-Prot as the best virus scanner to use with PCBCheck.  It has
low memory requirements and it has a command-line option to suppress all
output.  ** Note Memory Considerations below for more information on the
memory problems with such checkers as McAfee's SCAN.

    4.3.7  Error level which indicates virus infection

  Enter an integer which corresponds to the errorlevel the virus scanner
will return if it finds a virus.

    4.3.8  Special parameters to virus checker

  Unlike with archive support, PCBCheck does not know the behavior of any
virus checking software (except, of course, for the defaults, which are
configured for F-PROT).  Therefore, you must enter any necessary
parameters in this field (except for the filename, which PCBCheck will
supply).  Suggested parameters include:  don't scan memory, don't scan the
boot sector.  DO NOT disable local output, unless you want to stare at a
very boring empty screen during virus scanning.

    4.3.9  Add number of files to description

  Answer this question (yes/no) to indicate whether or not you want PCBCheck
to add a line to the description which reports the number of files in the
archive.  (I've always thought this was a stupid/useless feature, but
everyone else does it, and it's easy to implement, so I included it).
Note- this applies only to archives!

    4.3.10  Add date to description

  Answer this question (yes/no) to indicate whether or not you want PCBCheck
to add a line to the description which reports the newest file date in the
archive.  (Note that if you specify 'yes' to 'Add number of files to
description' as well as this, they will be put on the same line).
Note- this applies only to archives!

    4.3.11  Add GIF resolution to description

  Answer this question (yes/no) to indicate) whether or not you want PCBCheck
to add a line to the description which reports the resolution of GIF files.
(If GIFs are not specified as acceptable non-archive uploads, this field has
no effect, since the GIF will be 'failed').

    4.3.12  Add file to archive

  No one has any good reason for using this feature.  Not only is it
obnoxious to insert BBS ads into all incoming archives, it also violates
the integrity, or authenticity verification codes for many author-
distributed archives.  It is included, of course, for completeness.
Answering 'Y' to this creates a new field, which file do you want to add.

    4.3.13  Name of file to add to archive

  This is where you specify the file you wish to add to the archive, if
you specified you would like to.  The file should be in the PCBCheck
directory, as that's the only place it will look for it.

    4.3.14  Check for keywords in description

  If you respond 'Y' to this, PCBCheck will scan the file (a short sample
is included) KEYWORDS.PCB for words and check for the presence of them in
the description.  If any of the words are found anywhere in the description
(or the FILE_ID if it replaced the description), the file will fail.  Note
that you should follow the format prescribed in the sample, enclosing
words in quotes (so spaces can be discerned).  Also, please make sure to
enter words correctly (i.e. with spaces on either side, otherwise if
PCBCheck is set to reject 'SHIT' for example, it will reject 'MATSUSHITA' or
other similiar situations.  A better way to do it is to specify that
PCBCheck should reject ' SHIT '.

    4.3.15  Compare upload name to Hack Report

  If you specify 'Y', PCBCheck will scan the PCBCheck directory for
HACK????.IDX files and read in the hack reports.  If any of the hack reports
diagnose the file as a potential trojan, pirated software, etc... it will
reject the file and note the reason for rejection in the description.  Note
that the hack report provides only warnings, not confirmations.  If the
hack report fails a file, you should examine the hack report for more
information, and then test the file yourself to see if it really is
commercial software, a trojan, a hack, etc...  Because the hack report
relies only on names, false alarms are quite possible!
  The best place to obtain new copies of the hack report is off the SimTel
site on Internet, or its mirrors (i.e. OAK.OAKLAND.EDU).  There are also
alternate distribution methods listed in the hack report documentation.  A
sample hack report is included with PCBCheck.

    4.3.16  Path for work directory

  This feature was not originally included in PCBCheck due to some
complications and restrictions (I wanted to keep things as simple as
possible).  Due to popular demand, however, I have included it.
  First, the directory named should not already exist (if it does, it will
be destroyed).  The named directory should be a subdirectory of an existing
directory, or PCBCheck will not be able to create it.  SETUP will not allow
the directory name to contain more than five characters because the last
three are reserved for node definitions.  Please bear that in mind when
planning a directory name.  Note that since the directory should not already
exist and should be a subdirectory of an existing directory, the root
directory (or a RAM disk or otherwise) cannot be the work directory!  Failure
to strictly follow these guidelines may result in massive data loss or other
unpredictable behavior!  Please do not change the work directory unless you
need to, and please be careful!
  DO NOT put the work directory on a RAM disk, rather specify a RAM disk
letter in the RAM disk field, then the 'work directory' will be used as a
backup should the RAM disk not have enough space!

    4.3.17  RAM Disk drive letter

  If you have an empty (please, empty) RAM disk you'd like PCBCheck to use
as temporary storage (to speed up operation, I suppose), specify it's drive
letter here.  Note that PCBCheck will always attempt to decompress the
archive to the RAM disk first, regardless of size.  Should the dearchive
process fail (for any reason), PCBCheck will then try the 'work directory',
thereby allowing archives which are too large to fit on the RAM disk to
be processed (assuming enough hard drive space is free!)

    4.3.18  GIF minimum resolution

  You only need complete these three (3) fields if you have specified GIFs
as an acceptable non-archive, and you want to impose minimum resolution
requirements.  If you leave them blank or as 0x0x0, all GIFs will be
accepted.  The three fields, in order, are x-width, y-height, and colors.
Note that as minimums, all three are considered for each comparison, so
every GIF must meet all three minimum requirements to pass.

┌────────────────────────────────────────┐
│ 5.  Conference specific configurations │
└────────────────────────────────────────┘

  PCBCheck now has the ability to have different configurations for
different conferences.  (I realise you may not want to try the same
checking on archives in your Apple conference is in a regular conference,
or may want to insert a different comment, etc...)  Unfortunately, this
was a very difficult feature to integrate with setup (I couldn't figure
out any way, actually), so the only way to do it is by hand (suggestions
are always welcome for improvements).  SETUP creates PCBCHECK.CFG, the
configuration file for the main board.  Renaming it PCBCHECK.001 makes
it a configuration file for conference 1 (.002 for 2, etc....)  So,
if I run a ten conference system, and want a special configuration for
conference 3, I would first run setup, enter the values for conference 3,
then rename PCBCHECK.CFG PCBCHECK.003.  I would then run SETUP again,
entering the values I wanted used everywhere else, and SETUP would save
it as PCBCHECK.CFG (which is fine).  If there is not a specific configuration
file for a conference, PCBCheck uses PCBCHECK.CFG.  PCBCHECK.CFG is always
used for the main board.

┌────────────────────────────────────┐
│ 6.  Multinode/Multitasking, etc... │
└────────────────────────────────────┘

  Well, this is just about the same as running any other program on a
multinode system.  It does open all files in share mode, and does construct
the 'temp directory' name based on the current node, so there should be no
conflict.  Unfortunately, I don't personally have a multinode system, so
haven't really been able to test this.  I assume I will end up improving
multinode ability (should there be any problems) when I rewrite the comm.
routines.
  This should work just fine under multitasking OS's or shells.  I
developed it and tested it exclusively on OS/2 2.1, so I *know* it works
there.  I've also run it under Windows for the BBS.  I can't think of any
reason it wouldn't work with DesqView then, except of course that it
doesn't give up timeslices (but really, when I'm writing a DOS program I
don't feel that it's my responsibility to give up timeslices, I think the
multitasking OS which multitasks DOS programs should do that!)

┌────────────┐
│ 7.  Errors │
└────────────┘

  Should PCBCheck itself fail in some way, it will automatically pass the
file and report to the user the error code number.  It will also create a
file named PCBCHECK.LOG in the PCBCHECK directory which will note the error.
Many of the potential errors are actual internal program errors which you
can do nothing about (other than report to me), but a few are under your
control.  Here's a general rundown:

  -11    Can't open the file to test
  -12    Can't read from the (already open) file to test
  -14    Cannot open the FILE_ID.DIZ from the archive
  -15    Cannot open description file (as passed by PCBoard) for write
  -16    Cannot open description file (as passed by PCBoard) for write
  -17    Cannot write to (already open) description file
  -18    Cannot open/write to description file
  -19    Cannot open/read PCBCHECK.CFG (created by setup)
  -20    Cannot open/read a PCC file
  -21    Dearchive not successful!
  -22    Internal processing error, bad news!
  -23    Error reading PCC file
  -25    Can't find archiver/dearchiver in path!
  -26    Command is too long
  -27    Cannot open/read description file
  -28    Cannot open/read from keys file
  -35    Non-zero error code returned by external process

  Obviously, most of them deal with file access problems, which could be
related to access priveleges or something similiar on your system.  The most
likely user-addressable problems are -25 (can't find dearchiver/archiver in
path) and -26 (command too long).  The proper way to deal with a -26 is, as
described earlier, relocate the PCBCheck directory as close to the root as
possible to make the commands shorter.  Make sure that all designated
acceptable archivers are in the path to fix a -25.  Please report any other
error number (or even any of these, if you can't fix it) to me.

  PCBCHECK.LOG, should PCBCheck need to create it, is a wealth of information
for error-solving.  In addition to noting internal program errors (in
addition to the time/date/file on which the error occurred) it also notes
non-zero error levels as returned by archivers or virus scanning programs.
This allows you to catch errors such as SCAN running out of memory, which
otherwise be undetectable!  Should an external process return a non-zero
error code, in addition to being noted as error -35, the PCBCHECK.LOG file
will also record the error code returned by the process, so you can refer
to its documentation.


┌─────────────────┐
│ 8.  Legal Stuff │
└─────────────────┘

This program, its look, feel, and its related documentation are copyrighted.
You may not reverse engineer, decompile, or disassemble the program.  You
may not modify or translate the program or documentation without the written
consent of Jim Dahl.

This program is provided "as is" without any warranties (or conditions),
express or implied with respect to the program, including the implied
warranties (or conditions) of merchantability and fitness for a
particular purpose.  The entire risk arising out of use or performance of
the program and documentation remains with you.

Some jurisdictions do not allow the exclusion of implied warranties, so the
above may not apply to you.

In no event will Jim Dahl be liable for any lost profits, lost savings,
incidental or indirect damages or other economic consequential damages,
even if Jim Dahl has been advised of the possibility of such damages.  In
addition, Jim Dahl will be not be liable for any damages claimed by you
based on any third party claim.

Some jurisdictions do not allow the exclusion or limitation of
consequential or incidental damages, so the above may not apply to you.

┌─────────────────────────────┐
│ 9.   Memory Considerations  │
└─────────────────────────────┘

  When you consider what PCBCheck does, you realize that at times there
are up to three programs running at any one time, and each of them demands
it be running in conventional memory.  (PCBoard, PCBCheck, and a virus
scanner or archiver/dearchiver may be running).  PCBoard 15.x (in its latest
incarnation as of this writing) consumes a whopping 248.3k when it shells
to a program, such as PCBCheck, which leaves (assuming a base of 600k) only
351.7k for the other two programs!  Of course, your base free memory before
running PCBoard may be much lower than 600k.  PCBCheck does it's part by
swapping itself to XMS/EMS/disk, reducing it's kernel in active memory to
a mere 1.7K (it's not getting any smaller).  Unfortunately, some programs,
such as McAfee's virus scanner, require more conventional memory than this
leaves (McAfee's SCAN requires 380k).

  Since obviously PCBCheck cannot reduce it's memory requirements any
further, it is up to you to setup PCBoard so it swaps more of itself out
before shelling to PCBTEST.BAT to free up more memory.  Another option is
to use low-memory programs.  I personally recommend F-PROT as a virus
scanner (it is free, and has lower memory requirements).

  Note- if a program such as SCAN runs out of memory, it will not crash
PCBCheck, rather it will cause PCBCheck to always report files as 'clean',
thereby possibly allowing viruses to slip through!  If an archiver runs
out of memory, it will fail the upload.  All errorlevels, for virus scanning
and archiving/dearchiving, are noted in the PCBCheck log file, so you should
be able to catch "out of memory" errors by referring to the log regularly
(or if there are problems).

  If you get "Out of Memory" return codes from shelled applications,
In System Setup, under Configuration Options, then Configuration Switches,
set "swap during SHELL" to yes to free up more memory (at the cost of
slightly slower swapping).

┌────────────────────────────┐
│ 10. Registration/Shareware │
└────────────────────────────┘

  As I'm sure most Sysops know, shareware is not a type of program but a
distribution method.  If you continue to use my product you are obligated,
morally and legally, to pay me for it.  Therefore, I don't disable any cool
features, or even make promises of neat new features or extra utility or
maintenance programs if you register.  I want to give you the full program
so you know what you're really dealing with, and if you don't think it's
worth paying for (which is fine with me) I expect you to quit using it.  Note
that the amount of work I put into PCBCheck is directly proportional to
registrations received.  When I receive registrations, I can justify putting
large amounts of time into new, advanced features.  Think of your
registration as funding future releases.
  One registration does, of course, entitle you to use all future releases.
  The main advantage of registering PCBCheck (in addition to encouraging
me to keep improving it) is that you will receive instructions on how to
make PCBCheck display 'REGISTERED' in place of 'UNREGISTERED', or display
your BBS name in place of 'UNREGISTERED'.
  Registration is currently set at $15 (very reasonable, I think,
considering the time that went into this!
  You can register either by filling out the REGISTER.DOC and mailing it to
the given address, or you can register by credit card by calling City Lites
BBS [phone], joining conference 2 (PCBCheck support) and running
the 'registration' door or typing 'REGISTER' from the prompt.

┌────────────────────────────────────────────────────────┐
│ 11.  Where to complain / how to compliment the author  │
└────────────────────────────────────────────────────────┘

  I can be reached at:


    City Lites BBS  [phone] (four high-speed lines)

                    City Lites has an official PCBCheck support conference
                    (join conference 2) where I will announce current work
                    and field questions.  As I am NOT a sysop at this board,
                    please do not mail the sysop.

    Legal Eagle BBS [phone] (home of PCBCheck)

                    Legal Eagle is where I will continue to alpha test
                    PCBCheck, and will continue to provide support.  Also,
                    I can field mail addressed to 'SYSOP' on this board.
                    (note join conference 5)

    Internet        [e-mail]

    AOL             I have an account JamesDahl, not sure how long I'll keep
                    it though, so you're better off using InterNet mail

    I also have an account on Software Creations if you ever call there,
    though I'm not on it very often....

I intend to officially support PCBCheck from the Legal Eagle and City Lites,
the latest beta versions should always be available from both as well as
support information including bugs fixed in the beta, known problems, etc...
Note that beta versions can only be obtained from these boards, and should
not be distributed elsewhere, though they are open to anyone.  The support
structure isn't fully in place yet, though I expect it to be soon!

  And of course, write to me at:

    Jim Dahl
    RE: PCBCheck
    2236 Springbrook Ct.
    Grand Forks, ND 58201

-----------------------------------------------------------------------------

New versions can always be obtained from Salt Air, from the above BBS's,
or if you are on FidoNet, they will now be available via FREQ (1:14/644 is
City Lites node number) as PCBCHECK.

Registrations (currently $15) taken at:

        Jim Dahl                             City Lites BBS
        RE: PCBCheck               -or-      [phone]
        2236 Springbrook Ct.                 join PCBCheck support (2)
        Grand Forks, ND 58201                type 'REGISTER'