home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / uscan10 / uscan.doc < prev    next >
Text File  |  1992-04-02  |  9KB  |  202 lines
  1.              U-Scan - The upload file scanner for QuickBBS-ST
  2.                     The Midas Development Team (c)1992
  3.  
  4. John Carolin                               Keyop Troy                          
  5. QueST BBS, QuickBBS-ST Support England     Magnum BBS
  6. Fidonet 2:255/303  NeST 90:1008/102        Fidonet 2:255/313  NeST 90:1008/101
  7. +44-422-381164                             +44-274-547006
  8.  
  9.  
  10. Purpose
  11. =-=-=-=
  12.  
  13. U-Scan's job in life is to prevent users uploading a file that is already
  14. in one of your download areas. There is nothing more annoying for a sysop
  15. than to sit back and watch a user uploadng a 200k file at 1200 baud that
  16. you know you already have.
  17.  
  18. 1. All areas listed in FLSEARCH.CTL are checked, as well as paths in the an 
  19.    optional config file such as upload folders.
  20. 2. If you have implemented download ratios like myself, within QBBS via the
  21.    use of .DOR files you really don't want to let people get away uploading
  22.    dupe or trash files to raise their ratio.
  23. 3. Extensive checking of the inputted filename for validity is made.
  24. 4. U-Scan can also be _optionally_ run a second time after the upload to check
  25.    if they acutally uploaded the filename given initially. If they faked a
  26.    filename just to get past U-Scan, actions can be taken to degrade their
  27.    security level, time limit, download limit or any other function QBBS
  28.    provides in the .DOR language.
  29. 5. File types can be blacklisted in an optional text file.
  30. 6. Full modem IO, carrier detect, and inactivity timeout.
  31. 7. Removes files of 0 bytes in length from your upload folders that are the
  32.    result of failed file transfers.
  33. 8. All activity written to SYSTEM.LOG.  
  34.  
  35.  
  36. How it works
  37. =-=-=-=-=-=-
  38.  
  39. U-Scan should be run from a door file before an upload on your BBS takes
  40. place. It prompts the user for the filename they are about to upload and
  41. checks all areas listed in FLSEARCH.CTL for its existance. It then displays
  42. the FILES.BBS entry (if there is one) and exits with an errorlevel depending
  43. on whether files were found or not.
  44. This errorlevel is then checked within the door file and the upload shall
  45. either proceed or return to the BBS.
  46. U-Scan uses the enviroment varaible QBBS to find its way to FLSEARCH.CTL
  47. and SYSTEM.LOG.
  48. Once a given filename has been declared valid, U-Scan strips the extension
  49. from the file, so just uploading a file in a different archive format to
  50. that of one already on the BBS cannot get through.. example :
  51.  
  52. quickbbs.lzh - inputted name
  53. quickbbs.*   - stripped name
  54.  
  55. A wildcard search is performed on each area catching the files quickbbs.zip,
  56. quickbbs.arc, quickbbs.lh5, quickbbs.zoo and so on.
  57.  
  58. If U-Scan is ran a second time it will check if the given filename was
  59. uploaded or not. This checking is VERY accurate and it is unlikely an
  60. incorrect decision will be made, providing U-Scan is setup correctly. 
  61. During the second run U-Scan will remove any files found in the current
  62. upload area of 0 bytes in length. These are usually the result of a failed
  63. file transfer and would hinder U-Scans operation, making it disallow the
  64. blank file to be uploaded in full a second time.
  65.  
  66. Before the above was implemented, the following was a common occurance:
  67.  
  68. User enters filename FRED.LZH
  69. U-Scan finds match and refuses upload.
  70. User enters filename FRED2.LZH
  71. U-Scan finds no match and upload proceeds.
  72. User uploads FRED.LZH.
  73.  
  74. This is no longer possible.
  75.  
  76.  
  77. Usage
  78. =-=-=
  79.  
  80. Make sure you have the enviroment variable QBBS set to the main folder
  81. that contains your QBBS files.
  82.  
  83. Command line options -
  84.  
  85. uscan <upload path>   Run within the BBS for a user.
  86.                       The <upload path> should be replaced with the dir
  87.                       QBBS will place the uploaded file into.
  88.                       If this is not correct U-Scan may unfairly judge
  89.                       whether they uploaded what they said they did on the
  90.                       second run if used.
  91. uscan check           Run uscan a second time after an upload to check if
  92.                       they uploaded what they said they would.
  93. uscan local           Run locally, no modem IO or carrier detect.
  94.  
  95. Installation
  96. ------------
  97.  
  98. To install it for your BBS :
  99.  
  100. 1> Edit the '[U]pload a file' menu option on your file transfer menu
  101.    to execute a door file from which U-Scan will be ran.
  102.  
  103.    Option Type : 7
  104.    Data Line :  *E UPLOAD <path of  upload folder for current area>
  105.  
  106. 2> Modify the included UPLOAD.DOR file to your needs that will execute U-Scan
  107.    and carry out the upload proceedure.
  108.  
  109.    It is assumed that you are running QuickBBS v1.06.
  110.  
  111. 3> Errorlevels explained :
  112.  
  113.    Normal run (search for filename matches) returns :
  114.    
  115.    Errorlevel 0 if NO matches were found and upload should proceed.
  116.    Errorlevel 1 if matching files WERE found, user quitted, uscan had an
  117.                 error or any other reason why the upload should not go ahead.
  118.                 
  119.    Check run (see if they uploaded the filename they gave at start) returns :
  120.    
  121.    Errorlevel 0 if they DID uploaded a file corresponding to the filename
  122.                 they gave U-Scan on its initial run.
  123.    Errorlevel 1 if they DIDN'T upload a file corresponding to the filename
  124.                 they gave U-Scan on its initial run. ( - punish them!).
  125.  
  126. 4> Two optional ascii text files can be placed in U-Scan's home directory
  127.    to enhance its operation :
  128.    
  129.    BLACKLST.SCN - Black list of file extensions. Any filename given with an
  130.                   extension found in the list will not be accepted by U-Scan
  131.                   and a message defined in this file will be displayed.
  132.                   Its use would be to say stop .prg un-arc'd files from being
  133.                   accepted.
  134.                   
  135.                   The format of the file is -
  136.                   
  137.                   <ext> <message>
  138.                   
  139.                   Where <ext> is a 3 character file extension for files that
  140.                   are not wanted, and <message> is a line of text to display
  141.                   to the user telling them so.
  142.                   See the example BLACKLST.SCN in this archive to see how it
  143.                   is used.
  144.                   
  145.    OTHER.SCN    - A list of directorys to be searched in addition to those
  146.                   found in FLSEARCH.CTL.
  147.                   If you make use of QBBS's ability to upload a file to
  148.                   seperate directorys from your download folders then this
  149.                   file should contain the paths of these areas. This then
  150.                   prevents even very new, untouched uploads being received
  151.                   in duplicate.
  152.    
  153. The above files should NOT contain any blank lines, comments or tab's.
  154. Please view the sample files included in this archive for the format of
  155. the contents.
  156.    
  157. U-Scan should now run every time a user wants to make an upload.
  158. If no matching files are found the upload will proceed, if files are found
  159. or the user quit's, the upload will go no further and the user will be
  160. returned to the BBS.
  161.         
  162.         
  163. Points to note
  164. =-=-=-=-=-=-=-
  165.  
  166. 1. U-Scan makes strong use of the GEMDOS and MS-DOS rules for file names,
  167.    i.e. 12345678.123.
  168.    Amiga users trying to upload files such as VIRUSKILLER (a valid filename
  169.    in the amiga OS) will experience problems. They must be advised to arc up
  170.    the file and try again with VKILLER.ZOO or equivilant.
  171. 2. Sometimes a user may want to upload a file that has the same name as a file
  172.    already on your BBS, but it is infact an enitirely different program.
  173.    This is why the FILES.BBS entry of a matched file is displayed, so the user
  174.    can determine if he has a different file to what is already on the BBS and
  175.    rename it accordingly.
  176.    
  177.    
  178. Copyright
  179. =-=-=-=-=
  180.  
  181. The program(s), documentation and any other related files to this software
  182. are copyright of The Midas Development Team 1992. Each piece of software maybe
  183. the sole work of John Carolin, Keyop Troy or a joint production. Copyright
  184. is held by the respective author(s).
  185.  
  186. This software may be freely distributed if:
  187.  
  188. 1. No charge is made for this software.
  189. 2. No modifications to the documentation or executables are made.
  190. 3. The contents of this archive are not changed in any way.
  191.    
  192.  
  193. Feedback
  194. =-=-=-=-
  195.  
  196. If you experience any problems at all with U-Scan, or have any suggestions
  197. for future features then PLEASE get in touch with us at the addresses at the
  198. top of this document. Messages can be left for us in the QUICKBBS.ST echo or
  199. most Fidonet and NeST sysop echos.
  200. This program has GREATLY improved the quality of user uploads on our boards
  201. and I hope it will have the same effect for you.
  202.