home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / LUPS150B.ZIP / LOOPUPS.DOC < prev    next >
Text File  |  1994-01-29  |  19KB  |  383 lines
  1.         ╔════════════════════════════════════════════════════════════════╗
  2.         ║      LOOPUPS - Complete Upload Processing for RBBS/STUNY.      ║
  3.         ╟────────────────────────────────────────────────────────────────╢
  4.         ║                  Support board: THE LOOP BBS                   ║
  5.         ║      Node 1: (314) 862-1253 (Zoom 2400-14.4 V.32/V.42bis)      ║
  6.         ║      Node 2: (314) 862-1261 (Zoom 2400-14.4 V.32/V.42bis)      ║
  7.         ╚════════════════════════════════════════════════════════════════╝
  8.          LOOPUPS copyright (C) 1993 by Chris Quinn.  All rights reserved.  
  9.                                        
  10.                                        
  11.  --------------------------------------------------------------------------- 
  12.                    DISCLAIMER OF WARRANTIES AND FAIR WARNING
  13.  ---------------------------------------------------------------------------
  14.  
  15.      THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  16. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES 
  17. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  The entire risk of 
  18. all damages resulting from use of this software, including the cost of all  
  19. necessary remedies, lies with the user of this software and not the author 
  20. of LOOPUPS.
  21.  
  22.      During normal operation, LOOPUPS mass deletes all files in the work
  23. directory specified by the sysop and may alter the ZIP, ARJ and LZH files it 
  24. processes.  Every precaution has been taken to assure that LOOPUPS does not
  25. inadvertently harm other files.  However, for safety's sake you are urged to 
  26. verify that LOOPUPS functions properly with your particular configuration
  27. before permanently installing the program.                     
  28.  
  29.     
  30.  ---------------------------------------------------------------------------
  31.                   WHAT LOOPUPS DOES (ER, IS SUPPOSED TO DO)
  32.  ---------------------------------------------------------------------------
  33.  
  34.      LOOPUPS is a comprehensive upload processor for RBBS/STUNY which is
  35. executed from the RBBS/STUNY TEST.BAT and TESTC.BAT files.  LOOPUPS was
  36. written in Microsoft BASIC PDS 7.1 with help from Jeff Sumberg's QBSerial 
  37. v. 3.0 communication routines.  The idea behind LOOPUPS comes largely from
  38. Jeffrey Morley's excellent program, ZIPLAB Plus Generic, which the author
  39. used for several weeks before setting out to create a more fully-featured
  40. upload processor designed specifically for RBBS/STUNY.
  41.  
  42. LOOPUPS has the following features:
  43. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44.   o  Support for ZIP, ARJ and LZH archive types.
  45.   o  Detection and testing of unlimited ZIP, ARJ and LZH embedded archives.
  46.   o  Archive integrity testing, including embedded archives.
  47.   o  Rejection of sysop-defined file types, even within embedded archives.
  48.   o  Virus scan of uploads and embedded archives with SCAN.EXE.
  49.   o  FILE_ID.DIZ and DESC.SDI description file handling.
  50.   o  Restriction of uploads by file date.
  51.   o  Optional restriction of uploads to sysop-defined types.  
  52.   o  Removal of sysop-defined BBS comment files from archives.
  53.   o  Insertion of BBS logo to ZIP and ARJ archives with external programs.
  54.   o  Great, sysop-configurable ANSI interface.
  55.   o  Text-only mode for non-ANSI terminals.
  56.   o  Extensive status reporting to local monitor.
  57.   o  Optional obnoxious audible status indicators.
  58.   o  Extensive reporting and logging of all actions taken on uploads.  
  59.   o  Extensive error trapping, reporting and logging.
  60.   o  Support for high-speed modems, non-standard COM ports & FOSSIL drivers.
  61.   o  Complete sysop configuability.
  62.   o  Optional failed test bypass for sysops.
  63.  
  64.  
  65.  ---------------------------------------------------------------------------
  66.                            WHAT LOOPUPS DOES NOT DO
  67.  ---------------------------------------------------------------------------
  68.                                        
  69.      LOOPUPS provides no support for processing of GIF files.  Unless the 
  70. sysop configures LOOPUPS to reject GIFs, it simply ignores them.  The 
  71. reasons for this are twofold:  First, LOOPUPS was initially written for 
  72. use on THE LOOP BBS, where GIFs are not accepted for upload. Second, the 
  73. concerns underlying examination of GIF uploads are radically different from 
  74. those pertaining to archived uploads.  In any event, GIFs can be easily 
  75. handled separately in the TESTx.BAT file (outside LOOPUPS), as illustrated 
  76. below.
  77.  
  78.      This version of LOOPUPS does NOT operate with DOS v. 6.02.
  79.  
  80. ---------------------------------------------------------------------------
  81.                         WHAT IS NEEDED TO RUN LOOPUPS
  82.  ---------------------------------------------------------------------------
  83.  
  84. The LOOPUPS distribution archive contains the following files:
  85.  
  86.   o  LOOPUPS.DOC    This file (obviously).
  87.   o  LOOPUPS.EXE    LOOPUPS executable program file.
  88.   o  LOOPUPS.ANS    LOOPUPS ANSI screen output file.
  89.   o  LOOP1.CFG      Sample LOOPUPS configuration file for node 1.
  90.   o  LOOP2.CFG      Sample LOOPUPS configuration file for node 2.
  91.   o  TEST.BAT       Sample text-only RBBS/STUNY upload test batch file.
  92.   o  TESTC.BAT      Sample ANSI RBBS/STUNY upload test batch file.
  93.   o  HISTORY.TXT    LOOPUPS revision history (for the truly bored).
  94.   o  REGISTER.TXT   LOOPUPS registration form and instructions.
  95.   o  FILE_ID.DIZ    LOOPUPS upload description file.
  96.  
  97. The following files may be created by LOOPUPS:
  98.  
  99.   o  LOOPUPS.ERR    LOOPUPS error log file.
  100.   o  LOOPUPS.DAT    LOOPUPS error and rejected file data file.
  101.   o  ????????.???   Sysop defined upload log file.
  102.  
  103.      LOOPUPS can be used only with RBBS v. 17.4 modified with the STUNY mods
  104. package, release 0411 or later.  In addition, LOOPUPS requires current
  105. versions of the following programs, all of which are available on most BBS
  106. systems, including THE LOOP BBS:
  107.  
  108.   o  SCAN.EXE (distributed as SCANVxxx.ZIP).
  109.   o  PKZIP.EXE (distributed as PKZ2xxx.ZIP).
  110.   o  PKUNZIP.EXE (distributed as PKZ2xxx.ZIP).
  111.   o  ARJ.EXE (distributed as ARJ2xxx.ZIP).
  112.   o  LHA.EXE (distributed as LHA2xx.ZIP).
  113.   o  ZIPLOGO.EXE (optional ZIP comment program distributed as ZIPLOGO6.ZIP).
  114.   o  ARJCMNT4.EXE (optional ARJ comment program distributed as ARJCMNT4.ZIP).
  115.  
  116. These programs were written by other authors and are not distributed with
  117. LOOPUPS.  You are strongly encouraged to register these excellent utilities
  118. with their respective authors.
  119.  
  120.  
  121.  ---------------------------------------------------------------------------
  122.                              LOOPUPS INSTALLATION
  123.  ---------------------------------------------------------------------------
  124.      
  125. The LOOPUPS Command Line:
  126. ~~~~~~~~~~~~~~~~~~~~~~~~~
  127.      LOOPUPS is designed to be executed from RBBS/STUNY's TEST.BAT and
  128. TESTC.BAT files.  The LOOPUPS command line syntax is as follows:
  129.  
  130.      LOOPUPS [File] [Port] [Firstname] [Lastname] [Graphics] [Configfile]
  131.  
  132. [File]       represents the path and filename of the file to test.  
  133.              RBBS/STUNY passes this to TESTx.BAT as %1.  
  134.            
  135. [Port]       is the RBBS-style COM port (e.g. COM2), which RBBS/STUNY passes 
  136.              to TESTx.BAT as %3.  
  137.            
  138. [Firstname]  denotes the users's first name, which RBBS/STUNY passes to 
  139.              TESTx.BAT as %4.  
  140.  
  141. [Lastname]   represents the user's last name, which RBBS/STUNY passes to 
  142.              TESTx.BAT as %5.  
  143.              
  144. [Graphics]   denotes the type of output LOOPUPS is to use.  This should be 
  145.              "ANSI" in TESTC.BAT and "TEXT" in TEST.BAT.
  146.  
  147. [Configfile] represents the name of the LOOPUPS configuration file to use.
  148.              This should be something like LOOP%node%.CFG, assuming the 
  149.              %node% environment variable is used in your setup.
  150.  
  151.      Examples:  
  152.      ~~~~~~~~~
  153.      In TEST.BAT:  LOOPUPS %1 %3 %4 %5 TEXT LOOP%node%.CFG
  154.      In TESTC.BAT: LOOPUPS %1 %3 %4 %5 ANSI LOOP%node%.CFG
  155.      
  156.      EXAMPLE TEST.BAT
  157.      ~~~~~~~~~~~~~~~~
  158.          @echo off
  159.          REM RBBS/STUNY PASSES THE TEST FILE EXTENSION AS %6.
  160.          REM IF YOU WANT TO PROCESS GIFS SEPARATELY, UNREMARK THE NEXT LINE.
  161.          REM IF %6 == GIF GOTO GIFS
  162.          cd c:\loopups
  163.          C:\loopups\loopups.exe %1 %3 %4 %5 text loop%node%.cfg
  164.          cd c:\rbbs
  165.          GOTO LATER
  166.  
  167.          :GIFS
  168.          REM Do your GIF file processing here, if applicable.
  169.  
  170.          :LATER
  171.          seterror 0    
  172.  
  173.      EXAMPLE TESTC.BAT
  174.      ~~~~~~~~~~~~~~~~~
  175.          @echo off
  176.          REM RBBS/STUNY PASSES THE TEST FILE EXTENSION AS %6.
  177.          REM IF YOU WANT TO PROCESS GIFS SEPARATELY, UNREMARK THE NEXT LINE.
  178.          REM IF %6 == GIF GOTO GIFS
  179.          cd c:\loopups
  180.          C:\loopups\loopups.exe %1 %3 %4 %5 ansi loop%node%.cfg
  181.          cd c:\rbbs
  182.          GOTO LATER
  183.  
  184.          :GIFS
  185.          REM Do your GIF file processing here, if applicable.
  186.  
  187.          :LATER
  188.          seterror 0 
  189.  
  190.  
  191. The LOOPUPS Configuration File:     
  192. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  193.      LOOPUPS requires a separate configuration file for each node.  The
  194. format for this file is as follows:
  195.  
  196.      LINE 1  -  Node number for this CFG file.
  197.      LINE 2  -  Registration number (or 00000 if not registered).
  198.      LINE 3  -  Case-sensitive BBS name.
  199.      LINE 4  -  Full log file path (e.g. D:\UPLOADS\UPLOAD.DAT).
  200.      LINE 5  -  List of unwanted file extensions separated by commas.       
  201.                 LOOPUPS will reject an upload if either the upload or any   
  202.                 of the files contained in an uploaded archive have an       
  203.                 extension contained on this list (e.g. GIF,PCX,PIC).  
  204.                 10  maximum.
  205.      LINE 6  -  List of acceptable file extensions for uploaded files 
  206.                 separated by commas  (e.g. ZIP,LZH,ARJ).  10 maximum.
  207.      LINE 7  -  Should LOOPUPS reject all files having extensions other     
  208.                 than those listed in line 6 (YES/NO)?
  209.      LINE 8  -  Full path to logo file for ZIPLOGO and ARJCMNT4 to add to
  210.                 archives (e.g. C:\LOGO\MYLOGO.DOC).
  211.      LINE 9  -  List of BBS comment files, separated by commas, which       
  212.                 LOOPUPS should remove from archives (e.g. OBNXIOUS.AD,      
  213.                 COMMENT.BBS).  10 maximum.
  214.      LINE 10 -  Year restriction.  LOOPUPS will reject any upload if more   
  215.                 than 50% of its files are older than this date (e.g. 1990). 
  216.      LINE 11 -  Full path to which rejected files are moved (e.g. C:\BAD).  
  217.      LINE 12 -  Full LOOPUPS work directory path.  NOTE: LOOPUPS will       
  218.                 destroy all files in this directory!!!  Multinode sysops
  219.                 should create a separate directory for each .CFG file.
  220.      LINE 13 -  Type of modem handshaking to use (XON/CTS/BOTH).
  221.      LINE 14 -  Is a FOSSIL driver in use (YES/NO)?
  222.      LINE 15 -  Should LOOPUPS play obnoxious theme tunes (YES/NO)? 
  223.                 NOTE: The status tones may not function properly under      
  224.                 DESQview.
  225.      LINE 16 -  Full path to ALL utilities.  LOOPUPS must be able to find   
  226.                 each of the following programs in this directory:
  227.                     SCAN.EXE
  228.                     PKZIP.EXE
  229.                     PKUNZIP.EXE
  230.                     ARJ.EXE
  231.                     LHA.EXE
  232.                     ZIPLOGO.EXE
  233.                     ARJCMNT4.EXE
  234.      LINE 17 -  Should LOOPUPS use the standard IRQ for this COM port? 
  235.                 (YES -OR- IRQ#, e.g. 3).
  236.      LINE 18 -  Full path to node directory for .SDI & .DIZ files
  237.                 (e.g. C:\RBBS\NODE1).  NOTE:  For proper RBBS/STUNY 
  238.                 description file processing, this must be different for     
  239.                 each node.
  240.      LINE 19 -  Seconds to pause after each test (or 0 for no pause).
  241.      LINE 20 -  List of user names to be given option of bypassing
  242.                 failed test, separated by commas.  10 maximum.
  243.  
  244.      Sample LOOPUPS Configuration File:
  245.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  246.      1
  247.      00000
  248.      THE LOOP BBS
  249.      D:\UPLOADS\UPLOAD.DAT
  250.      GIF,BMP,PCX,PIC
  251.      ZIP,ARJ,LZH
  252.      YES
  253.      C:\LOGO\MYLOGO.DOC
  254.      OBNXIOUS.AD,COMMENT.AEI
  255.      1990
  256.      C:\RBBS\FILES\BAD
  257.      D:\UPLOADS\TEST1
  258.      BOTH
  259.      YES
  260.      NO
  261.      C:\DOS
  262.      YES
  263.      C:\RBBS\NODE1
  264.      0
  265.      SYSOP, Joe Sysop, Sue Cosysop
  266.  
  267. The LOOPUPS.ANS File:
  268. ~~~~~~~~~~~~~~~~~~~~~
  269.      When the LOOPUPS command line switch [Graphics] is set to ANSI, LOOPUPS
  270. uses the included file LOOPUPS.ANS as the background for its ANSI interface.
  271. This file may be customized with any suitable ANSI drawing program.  Please
  272. note, however, that neither the background color nor the position of any of
  273. the ANSI character fields (filename, user name and status indicators) should 
  274. be altered.  Also note that for proper ANSI cursor positioning, blank lines
  275. should not be added to the end of the file.
  276.  
  277.  
  278.  ---------------------------------------------------------------------------
  279.                         LOOPUPS MEMORY CONSIDERATIONS
  280.  ---------------------------------------------------------------------------
  281.  
  282.      Although LOOPUPS itself requires a relatively small amount of RAM, some 
  283. of the external programs it executes -- most notably SCAN.EXE -- are RAM 
  284. hogs.  LOOPUPS attempts to detect memory deficiencies in two ways:  First, it
  285. shuts itself down if free RAM is less than 330K - the minimum amount required
  286. to execute SCAN.EXE.  Second, LOOPUPS monitors the exit codes returned by
  287. most of the external programs to which it shells.  If SCAN returns an
  288. errorlevel of 2 (abnormal program termination), LOOPUPS shuts down and logs
  289. the error.  
  290.  
  291.      Several strategies may be employed in order to recover additional free
  292. RAM.  First, using the EMS overlay version of the STUNY mods may free up
  293. enough RAM to run LOOPUPS on your system.  Second, diligent QEMM/DESQview
  294. users may be able to scrounge up enough RAM using QEMM's OPTIMIZE program,
  295. the INCLUDE command line switch and/or Quarterdeck's VIDRAM.COM utility.
  296. Consult the QEMM documentation for additional information.
  297.  
  298.      If after taking the above steps and removing all unnecessary TSRs from
  299. memory LOOPUPS still reports inadequate RAM to execute SCAN, the problem can
  300. usually be solved via Davis Augustine's fantastic SHROOM (shell room)
  301. utility.  SHROOM, distributed as SHROMxxx.ZIP, is available for download on
  302. many boards, including THE LOOP BBS.  Please register SHROOM if you use it! 
  303.  
  304.      A lengthy explanation of SHROOM and its use is beyond the scope of this
  305. document.  However, detailed instructions can be found in the documentation
  306. accompanying the SHROOM program itself.  For present purposes, please note 
  307. that if SHROOM is used,  RBBS-PC.EXE, _NOT_ LOOPUPS.EXE should be executed
  308. from the SHROOM command line.  In other words, your RBBS.BAT file should
  309. contain a line such as: 
  310.  
  311.      SHROOM -Q RBBS-PC.EXE %node% RBBS%node%PC.DEF %1
  312.  
  313. Loading LOOPUPS.EXE from SHROOM in the TESTx.BAT file typically will not free
  314. up sufficient RAM to execute LOOPUPS and SCAN.  
  315.  
  316.      Although this configuration has not been extensively tested, SHROOM may 
  317. not work properly with the EMS overlay version of RBBS/STUNY.  If you
  318. experience problems using SHROOM with STUNY's overlay version, try using the
  319. non-overlay version.  Note that this should not create a memory problem for
  320. your BBS doors or other programs, since they are run either as a door (in
  321. which case RBBS is removed from memory to make room for the door) or as a
  322. shell (in which case SHROOM will swap out RBBS out as needed).  Consult the
  323. RBBS manual and the STUNY documentation for additional information. 
  324.  
  325.      Finally, multinode RBBS sysops should play it safe by setting the
  326. attribute of SHROOM.EXE (and, for that matter, ALL programs used by LOOPUPS!)
  327. to "read only" using the DOS ATTRIB +R command.  Additional information may
  328. be found under the "Miscellaneous Tricks" heading in Chapter 21 (Going Multi-
  329. Node) of the RBBS-PC v. 17.4 manual. 
  330.  
  331.  
  332.  ---------------------------------------------------------------------------
  333.                                LOOPUPS SUPPORT
  334.  ---------------------------------------------------------------------------
  335.  
  336.      LOOPUPS provides detailed reporting and logging of all command line and
  337. configuration errors it discovers.  If additional installation help is
  338. required, please feel free to contact the author, Chris Quinn, at THE LOOP
  339. BBS.  Node 1, (314) 862-1253, and node 2, (314) 862-1261, operate at 2400 - 
  340. 14,400 baud (V.32/V.42bis).
  341.  
  342.  
  343.  ---------------------------------------------------------------------------
  344.                                 THANKS, GUYS!    
  345.  ---------------------------------------------------------------------------
  346.  
  347.      The author would like to thank the following beta testers whose 
  348. thoughtful comments and suggestions made the development of LOOPUPS 
  349. possible:
  350.  
  351.      Seth Phelps
  352.      Richie Molinelli
  353.      Gary Glueckert           
  354.      Jim Loos
  355.      Alan Bratteson
  356.  
  357.      ... and (undoubtably) others whose names I've forgotten.  Sorry!
  358.  
  359.  
  360.  ---------------------------------------------------------------------------
  361.                              LOOPUPS REGISTRATION
  362.  ---------------------------------------------------------------------------
  363.  
  364.      As a fellow sysop, I recognize the amount of time and money required to
  365. operate a BBS.  Therefore, I'll not bore you with ridiculous "shareware
  366. license agreements" or pathetic pleas for money.  LOOPUPS is not crippled in 
  367. any way.  If you wish to rid yourself of the annoying "UNREGISTERED EVALUATION
  368. COPY" screen prints and log entries, you must register LOOPUPS.  Registration
  369. not only permits continued support and development of LOOPUPS (and other
  370. programs), but also helps me register programs that I use at THE LOOP.
  371.  
  372.      Complete registration instructions are contained in the REGISTER.TXT
  373. file.  Registration costs only $10 US and I will gladly waive the fee for 
  374. any shareware author whose free software I currently use.  To obtain your
  375. personal LOOPUPS registration code, complete and print the registration form
  376. contained in the REGISTER.TXT file and send it to the address noted on the
  377. form.  Your code will either be placed in a personal message at THE LOOP BBS
  378. or sent to you by return mail, at your option.  
  379.  
  380.                                      Chris Quinn
  381.                                      06/09/93
  382.  
  383.