home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / mailers / fdrpr100.zip / FDRQPRA.DOC < prev    next >
Text File  |  1993-06-19  |  14KB  |  329 lines
  1.     FrontDoor Request Processor for RemoteAccess 2.00       19 Jun 1993
  2.     -------------------------------------------------
  3.  
  4.     Copyright 1993 Mats Wallin                      All rights reserved
  5.  
  6.  
  7.     Introduction
  8.     ------------
  9.  
  10.         FDRQPRA is a Request Processor for RemoteAccess. A Request
  11.         Processor is a program that FrontDoor executes whenever it
  12.         receives a file request. It is then the Request Processor
  13.         that processes the list of requested files, and returns
  14.         a list of files to FrontDoor, that FrontDoor then will
  15.         send.
  16.  
  17.         The advantage with a Request Processor, is that it can
  18.         be adapted for a special BBS program, or any other
  19.         program on the system that uses the Request Processor.
  20.  
  21.         This Request Processor uses the advantages of the file
  22.         system that RemoteAccess 2.00 and later versions uses.
  23.         This will speed up most file requests, especially for
  24.         systems using CD-ROMs. It will also, optionally, update
  25.         the download counters for requested files.
  26.  
  27.         Another advantage of this Request Processor, is the possibility
  28.         to "check" a file request locally. E.g. you can run it
  29.         manually, and see what the result of a file request would
  30.         be for the system requesting files.
  31.  
  32.         One more advantage with this request processor, and that is
  33.         the possibility for it to return a message to the requesting
  34.         system, containing the descriptions of the requested files.
  35.  
  36.  
  37.  
  38.     Requirements
  39.     ------------
  40.  
  41.         FDRQPRA requires the following thing to run:
  42.  
  43.         * FrontDoor 2.20 or later
  44.  
  45.         * RemoteAccess 2.00 or later
  46.  
  47.         * The environment variable FD pointing to the directory 
  48.           where SETUP.FD is located, or SETUP.FD in the current 
  49.           directory
  50.  
  51.         * A list of requestable directories in the file specified 
  52.           in SETUP.FD
  53.  
  54.         * A list of magic (alias) file names, in the file 
  55.           specified in SETUP.FD
  56.  
  57.         * The environment variable RA pointing to the directory 
  58.           where CONFIG.RA is located, or CONFIG.RA in the current 
  59.           directory
  60.  
  61.  
  62.         FDRQPRA will create some files containing information
  63.         about the requestable directories and the magic filenames.
  64.         These files will be stored in the same directory and with 
  65.         the same name, as the files specified in SETUP.FD, but with
  66.         another extension. The extension used is .RQS for the files
  67.         used during secure sessions, .and .RQU for the files used 
  68.         during unsecure sessions.
  69.  
  70.         These files will be maintained automatically by FDRQPRA,
  71.         and is updated every time the list of requestable
  72.         directories, magic names, or FILES.RA, is changed. It is 
  73.         important that these file are not removed, since it is much 
  74.         slower to create them every time, then to use them from the 
  75.         last run.
  76.  
  77.         IMPORTANT!  If your lists of requestable directories or
  78.                     list of magic names, uses the .RQS or .RQU 
  79.                     extensions, make sure that you changes this 
  80.                     to another extension. If you don't rename 
  81.                     the file, FDRQPRA will overwrite your list 
  82.                     with it's own list.
  83.                     It is also important that your list of
  84.                     requestable directories, and the list of
  85.                     magic names, doesn't have the same basename 
  86.                     (the name before the extension). If they have, 
  87.                     FDRQPRA will not work properly, since it then 
  88.                     will overwrite its own files.
  89.  
  90.  
  91.         If your list with requestable directories contains a
  92.         directory which isn't defined as a file area in RemoteAccess,
  93.         FDRQPRA will switch over to the same kind of request
  94.         processing as FrontDoor does, e.g. to scan all the files
  95.         in that directory. This makes it possible to have a directory
  96.         with files that should be requestable, but not available from
  97.         the BBS.
  98.  
  99.         
  100.     How to use it
  101.     -------------
  102.  
  103.         FDRQPRA is executed by FrontDoor every time someone requests
  104.         a file. FDRQPRA needs some parameters to be able to know
  105.         what to do, and FrontDoor is capable of supplying these
  106.         parameters.
  107.  
  108.         The following is a list of the switches that FDRQPRA
  109.         supports. Switches can start either with a slash (/) or 
  110.         with a dash (-). All switches can be shortened to the shortest
  111.         unique name. The switches that accepts a value, can use
  112.         either a colon (:) or a equal character (=) between the
  113.         switch name and the actual value.
  114.  
  115.         All switches can either be specified on the command line,
  116.         or in a configuration file. The configuration file should
  117.         be located in the same directory as the .EXE file, and with
  118.         the same basename (i.e. FDRQPRA if you don't rename it). The
  119.         extension should either be .CFG, or, if you prefer to have
  120.         one configuration file per task, .%TASK%. If the .%TASK% file
  121.         exists, it will always be read. The .CFG file is only read if
  122.         the .%TASK% file doesn't exist.
  123.  
  124.         Switches specified in the config file can be overriden if
  125.         also specified on the command line.
  126.  
  127.         /address:<aka>      Address of system requesting files
  128.         /bps:<bps>          BPS rate of connection
  129.         /[no]cdrom          Support RA's CD-ROM settings
  130.         /check:<filename>   Check result of requesting specified file
  131.         /create             Create list of directories/magic names
  132.         /[no]descriptions   Send file descriptions to requesting
  133.                             system (default)
  134.         /[no]freefiles      Do not check request limits for files
  135.                             marked as free in RA's setup
  136.         /info:<filename>    Name of file containing info about
  137.                             requesting system. This parameter can be
  138.                             specified instead of /address, /bps and
  139.                             /operator
  140.         /[no]log:<filename> If logging should be performed (see below)
  141.         /minutes:<min>      Max # of minutes for the file request
  142.         /operator:<name>    Name of SysOp requesting files
  143.         /request:<filename> Name of file containing requested files
  144.         /secure             Session is password protected
  145.         /target:<filename>  Name of file where found files should be written
  146.         /unsecure           Session is not password protected
  147.         /updcount           Update RA's download counters
  148.  
  149.         Not all switches would make much sense to put in the config
  150.         file, especially not those that FD will use to pass
  151.         information to FDRQPRA. The switches that can be placed in
  152.         the config file is /[NO]CDROM, /[NO]DESCRIPTIONS, /[NO]FREEFILES,
  153.         /[NO]LOG:<filename> and /UPDCOUNT.
  154.  
  155.         The /LOG switch is a little bit special. If this switch is
  156.         not specified at all, FDRQPRA writes loginfo to FD's logfile.
  157.         If it is specified as /LOG=<filename>, logging is done to
  158.         the specified filename. To force FDRQPRA to write no loginfo
  159.         at all, use /NOLOG. If an error is detected during
  160.         initialization, it will always be written to FD's logfile,
  161.         ignoring how this switch is set. This is to aid trouble
  162.         shooting.
  163.  
  164.         The /CREATE switch is not meant to be used all the times.
  165.         FDRQPRA will automaticall detect if it is necessary to 
  166.         create its own lists of directories/magic names every time
  167.         its run. This switch is only meant if these files needs to
  168.         be recreated due to some reason, or if you know that you
  169.         have modified the list of requestable directories, magic
  170.         names, or RA's area configuration. To create both the list
  171.         for unsecure sessions, as well as the list for secure
  172.         sessions, you will have to run FDRQPRA twice, once specifying
  173.         only /CREATE, and once specifying /CREATE /SECURE.
  174.  
  175.         FrontDoor needs to fill in some information in the command
  176.         line, and to do that, it uses the same macros as it does
  177.         for Service Requests. The macros useful for FDRQPRA is:
  178.  
  179.         =A   The requesting system's network address. Eg.
  180.              2:270/17.
  181.  
  182.         =B   The baud rate of the connection. Eg. 9600.
  183.  
  184.         =F   Name of file containing information about requesting
  185.              system.
  186.  
  187.         =H   Number of minutes until next event not allowing
  188.              file requests
  189.  
  190.         =O   The operator of the requesting system. Eg.
  191.              Bilbo_Baggins.
  192.  
  193.         =R   Name of file containing requested files
  194.  
  195.         =T   Name of file where found files should be written
  196.  
  197.         =X   Whether or not the session is password protected.
  198.              This macro can have two values, SECURE or
  199.              UNSECURE.
  200.  
  201.         This means, that a typical command line to run FDRQPRA, would
  202.         look like this:
  203.  
  204.         FDRQPRA /REQUEST:=R /TARGET:=T /=X /INFO:=F /MINUTES:=H
  205.  
  206.         or, to make it shorter:
  207.  
  208.         FDRQPRA /R:=R /T:=T /=X /I:=F /M:=H
  209.  
  210.         An alternative command line would be:
  211.  
  212.         FDRQPRA /R:=R /T:=T /=X /A:=A /O:"=O" /B:=B /M:=H
  213.  
  214.         In most cases, one of the lines above would be the one needed, 
  215.         and should be entered in 
  216.         FDSETUP->Mailer->File Requests->Request Processor->Program
  217.  
  218.         If the =O macro is used, it should be enclosed with "
  219.         characters to prevent DOS to treat some special characters, 
  220.         e.g. < > and |, in a way that would prevent FDRQPRA from
  221.         working correctly.
  222.  
  223.         Even if it is possible to specify a fixed # of minutes for
  224.         a file request on the command line, it should be done in
  225.         FDSETUP. FDRQPRA uses that number in SETUP.FD, the
  226.         possibility to specify a number of minutes on the command
  227.         line should only be used to let FD specify the number of 
  228.         minutes left to next event not allowing file requests.
  229.  
  230.  
  231.     Use FDRQPRA to test file requests locally
  232.     -----------------------------------------
  233.  
  234.         FDRQPRA could be used to check a file request locally, too
  235.         get some information why a certain file request fails, or
  236.         just to test your setup.
  237.  
  238.         To run FDRQPRA like this, enter the following command:
  239.  
  240.         FDRQPRA /CHECK=<file>
  241.  
  242.         To test a file request that requires a password, use the
  243.         following command:
  244.  
  245.         FDRQPRA /CHECK="<file> !<password>"
  246.  
  247.         To test more then one file request at the same time, use the
  248.         following command:
  249.  
  250.         FDRQPRA /CHECK="<file1> [!<pwd1>],<file2> [!<pwd2>][,...]"
  251.  
  252.         To make the request more realistic, you can also add any of
  253.         the other switches. But the only switches that would make
  254.         any difference, is the /SECURE and the /BPS=<bps> switches,
  255.         and the /ADDRESS switch, which would have FDRQPRA create the
  256.         PKT file it should have sent to the requesting system.
  257.  
  258.  
  259.  
  260.     Legal notice
  261.     ------------
  262.  
  263.         FDRQPRA is provided to you as is, without warranty of any
  264.         kind. In no event shall Mats Wallin be liable to yoyu or
  265.         anyone else for any damages or costs arising from the use
  266.         or inability to use this program.
  267.  
  268.         FDRQPRA is protected by copyright laws, and may not be 
  269.         modified, reversed engineered, sold or distributed in any
  270.         way that would involve some sort of trade, without written
  271.         permission from Mats Wallin.
  272.  
  273.         FrontDoor is a trademark of Joaquim Homrighausen.
  274.  
  275.         RemoteAccess is a trademark of Wantree Development.
  276.  
  277.  
  278.  
  279.     Registering
  280.     -----------
  281.  
  282.         If you find FDRQPRA of any value, and continue to use it
  283.         after a first trial period, I would appreciate if you
  284.         register the program.
  285.         
  286.         The registration fee for the program is SEK 100, USD 15,
  287.         GBP 10 or the same amount in any other currency. 
  288.         If another currency then SEK is used, please add SEK 50, 
  289.         USD 7 or GBP 5 to cover the currency exchange.
  290.  
  291.         When the registration fee and a netmail with your name, 
  292.         nodenumber and the payment method used has been received,
  293.         I will send a netmail crash with the key information
  294.         needed to run in registered mode.
  295.  
  296.         Send the netmail with registration information to:
  297.  
  298.         Mats Wallin
  299.         2:201/329@fidonet
  300.  
  301.         If you're not a member of FidoNet, send the registration
  302.         information (including your snail mail address) to me at 
  303.         the following snail mail address:
  304.  
  305.         Mats Wallin
  306.         Förskottsvägen 11
  307.         S-126 44 Hägersten
  308.         Sweden
  309.  
  310.         The registration fee can either be sent to the address
  311.         above in cash, cheque, etc, or to the following postal
  312.         giro (CCP).
  313.  
  314.         640302-0297
  315.  
  316.         The only difference between the registered and unregistered
  317.         version, is that the unregistered version adds the text
  318.         (unregistered) to every netmail created.
  319.  
  320.  
  321.     Bug reports, suggestions, etc.
  322.     ------------------------------
  323.  
  324.         If you find any bugs, or have suggestions or comments on 
  325.         this program, I would appreciate if you would let me know.
  326.         Send the information to me at:
  327.  
  328.         2:201/329@fidonet       or      mw@fido.lu
  329.