home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / AFG_B014.ZIP / REQUEST.TXT < prev    next >
Encoding:
Text File  |  1996-07-12  |  10.9 KB  |  296 lines
  1.                                                         Delft, May 6th 1996
  2.  
  3.         This document contains two extracts from the ALLFIX manual,
  4.         explaining how the request processor works.
  5.  
  6.  
  7.         Harald Harms.
  8.  
  9.  
  10.  
  11.         6.3.9     Request Processor
  12.  
  13.  
  14.         ALLFIX  contains a  fully functional  request processor.  A request
  15.         processor is a  program that handles file requests for your mailer.
  16.         Normally, a mailer is  capable of handling file requests,  however,
  17.         external utilities often offer more features.
  18.  
  19.         The request processor  in ALLFIX is fully integrated with the other
  20.         features in ALLFIX.  This means that  when someone file  requests a
  21.         file from your system, ALLFIX  will send the person a .TIC  file if
  22.         the system is listed  in the Node manager, and ALLFIX will send the
  23.         file  description of  the file  regardless of  the type  of BBS you
  24.         use, as long as it is supported by ALLFIX.
  25.  
  26.         In this  particular menu, there are a number of fields that control
  27.         how ALLFIX works. 
  28.  
  29.         Active
  30.  
  31.              This field determines whether or  not the request processor is
  32.              active. If  you want  to be  able to  use  the ALLFIX  request
  33.              processor, then this field must be set to "Yes". 
  34.  
  35.         Error
  36.  
  37.              This field is currently not available.
  38.  
  39.         Report
  40.  
  41.              This field can  be used to  define the template  that is  used
  42.              sent to a system after  processing a file request. Please  see
  43.              the sample RPREPORT template for more details.
  44.  
  45.         Groups
  46.  
  47.              This field  defines  the  groups  that  are  available  in  an
  48.              unsecure mailer session. 
  49.  
  50.         Sec groups
  51.  
  52.              This field defines  the groups that area available in a secure
  53.              mailer  session.   Please  note  that  this  feature  is  only
  54.              available in registered mode.
  55.  
  56.         List
  57.  
  58.              This field  defines the directories  that are available  in an
  59.              unsecure mailer  session.  The format  of  this file  is  very
  60.              simple.  It must be  a plain  text file.  Comments, designated
  61.              with a semi-colon,  ';', are allowed.  It is also  possible to
  62.              define passwords  per directory by placing the password behind
  63.              a  directory,  preceeded with  a  exclamation  mark, '!'.  For
  64.              example:
  65.  
  66.  
  67.                                         40
  68.  
  69.  
  70.  
  71.  
  72.  
  73.              D:\BBS\FILES\AREA1
  74.              D:\BBS\FILES\AREA2  !PASSWORD
  75.  
  76.              In the above example, people  can file request files from  the
  77.              directory  D:\BBS\FILES\AREA2 if  they  use the  correct  file
  78.              request password.
  79.  
  80.         Sec list
  81.  
  82.              This field defines  the directories  that are  available in  a
  83.              secure  mailer session. The  format of this  file is identical
  84.              to  the  List file  above.  Please note  that  this particular
  85.              feature is only available in registered mode.
  86.  
  87.         Max files
  88.  
  89.              This field can be used  to define the maximum number  of files
  90.              to send per session.
  91.  
  92.         Max size
  93.  
  94.              This  field  can  be  used to  define  the  maximum  number of
  95.         kilobytes te send per session.
  96.  
  97.         Min speed
  98.  
  99.              This field is currently not available.
  100.  
  101.         Max time
  102.  
  103.              This field is currently not available.
  104.  
  105.  
  106.         The request processor  can also work with an alias file. This alias
  107.         file must have the following format if you want to use the  request
  108.         processor in ALLFIX:
  109.  
  110.         [magicname]    [file1] [file2] ... [filen] [!password]
  111.  
  112.         For example:
  113.  
  114.         ALLFIX    D:\BBS\FILES\AREA1\AFIX440.ZIP
  115.         D:\BBS\FILES\AREA1\ALLFIX.REG
  116.         BETA      D:\BBS\FILES\AREA2\AFB_B004.ZIP !PASSWORD
  117.  
  118.         In the above  example, when someone file requests magic name ALLFIX
  119.         they  will receive the AFIX440.ZIP archive and the ALLFIX.REG form.
  120.         In order to file request  the latest ALLFIX beta they have  to file
  121.         request magic name BETA with the password "PASSWORD". 
  122.  
  123.         Please note that  ALLFIX will  use the above  format for the  alias
  124.         file if  the  request processor  has been  active,  by setting  the
  125.         active field in this menu to "Yes".
  126.  
  127.         When handling a file request, ALLFIX uses the following steps:
  128.  
  129.  
  130.                                         41
  131.  
  132.  
  133.  
  134.  
  135.  
  136.         1.   Read in the List directories.
  137.  
  138.         2.   If the session issecure, then read in theSec list directories.
  139.  
  140.         3.   If the requesting system is  listed in the Node manager,  then
  141.              give the node access to  the Public groups (as defined  in the
  142.              AreaMgr  options menu)  and to  the groups  he has  been given
  143.              access to in the Node manager.
  144.  
  145.         4.   If the requesting  system is not  listed in the  Node manager,
  146.              then give the system access  to the normal Groups, as  defined
  147.              in this menu, and  if it is a  secure session, then also  give
  148.              the node access to the Sec groups.
  149.  
  150.         5.   Before  searching  for any  files,  all  service requests  are
  151.              handled. Please  see  the  Magic  filename  section  for  more
  152.              information on service requests.
  153.  
  154.         6.   The  Alias file  is scanned  for magic  names. If  a match  is
  155.              found, then ALLFIX  will not continue searching for a match in
  156.              any of the directories or fileechos.
  157.  
  158.         7.   If there are file requests left  that were not matched in  the
  159.              Alias file, then  ALLFIX will scan the fileechos that the node
  160.              has access to and then the list  directories to which the node
  161.              has access.
  162.  
  163.         8.   After processing  the file requests,  a report is  written and
  164.              sent  to  the  node  along  with  any  files  that  were  file
  165.              requested.  If the  requesting system  is listed  in  the Node
  166.              manager, then ALLFIX  will send a .TIC  file accompanying each
  167.              file which was file requested from a fileecho.
  168.  
  169.  
  170.         The  ALLFIX request  processor  is  very easy  to  install in  your
  171.         mailer. For FrontDoor style  mailers, ALLFIX expects the  following
  172.         command line options in the following order:
  173.  
  174.         Aka
  175.  
  176.              Requesting system's aka.
  177.  
  178.         Sysop
  179.  
  180.              Requesting systems sysop name.
  181.  
  182.         Secure
  183.  
  184.              The  string "SECURE"  for secure  sessions and  "UNSECURE" for
  185.              unsecure sessions.
  186.  
  187.         Response
  188.  
  189.              The  name of the  response file  which is returned  the mailer
  190.              after  processing a  file request.  The name  of this  file is
  191.              provided by the mailer.
  192.  
  193.                                         42
  194.  
  195.  
  196.  
  197.  
  198.  
  199.         Rquests
  200.  
  201.              The name of the file  containing the file requests. This  file
  202.              is provided by the mailer.
  203.  
  204.         Below is an example of how to install ALLFIX in FrontDoor.
  205.  
  206.         D:\ALLFIX\ALLFIX.EXE Rp =A =O =X =T =R
  207.  
  208.         ALLFIX is also capable of working with SRIF files. These  files are
  209.         created  by  some  of  mailers  and  effectively  contain  all  the
  210.         information that ALLFIX may need.  When using ALLFIX with a  mailer
  211.         that supports  SRIF files, you  must specify  the name of  the SRIF
  212.         file on the commandline. Example:
  213.  
  214.         D:\ALLFIX\ALLFIX.EXE Rp [name of SRIF file]
  215.  
  216.         Most mailers should have a  macro which will expand to the  name of
  217.         the SRIF file.
  218.  
  219.  
  220.         [from the ServiceReq type in the Magic filename manager]
  221.  
  222.         ServiceReq
  223.  
  224.              This feature is only available in registered mode.
  225.  
  226.              This function can be used  to execute a specific program  when
  227.              a  magic filename  is requested.  This feature  could be used,
  228.              for example, to  allow a registration  site to file  request a
  229.              new  key for a  new user. A  service request is  given a magic
  230.              name, which can  be defined in this menu. Each service request
  231.              has a password,  which the user must also provide. The program
  232.              that has to  be executed can also  be defined. It  is possible
  233.              that the program  needs a number of command line options which
  234.              may need to be provided  by the user. This can be  using an at
  235.              symbol, '@'.  For each  '@' character, that  ALLFIX encounters
  236.              in the command line, ALLFIX  will use the next string  entered
  237.              by  the user. For  example, let  us assume that  the following
  238.              has been entered as the command to execute:
  239.  
  240.              D:\REG\KEYGEN %s %a @ @
  241.  
  242.              In the above example, the  two '@' characters are expanded  to
  243.              the two strings  which were file  requested by the  system. In
  244.              order to execute  this service request, the user would have to
  245.              "file request"  the service  request name, password,  and also
  246.              two other "magic  names" which are  password on to  the KEYGEN
  247.              program by ALLFIX. 
  248.  
  249.              For example:
  250.  
  251.                   FREQ:     KEYGEN !PASSWORD Harald Harms
  252.  
  253.              In  the   above  example,  the  service  request  "KEYGEN"  is
  254.              executed. Since the  command line for  the program to  execute
  255.              contains two '@' characters, the next two "magic  names" which
  256.              are  "requested" are passed  to the KEYGEN  program as command
  257.              line options.
  258.  
  259.              Below is a list of the options in this menu:
  260.  
  261.              Alias
  262.  
  263.                   The name of this  service request. In the  example above,
  264.                   the Alias is "KEYGEN".
  265.  
  266.  
  267.                                         65
  268.  
  269.  
  270.  
  271.  
  272.  
  273.              Password
  274.  
  275.                   The  password required to  execute this  service request.
  276.                   In the example above, the password is "PASSWORD".
  277.  
  278.              Command
  279.  
  280.                   The command to  execute for this service  request. In the
  281.                   example above, the command is "D:\REG\KEYGEN  %s %a @ @".
  282.                   The  %s and  %a  macros are  expanded  to the  requesting
  283.                   sysop name and aka, respectively.
  284.  
  285.              Directory
  286.  
  287.                   After  the command  has been  executed, ALLFIX  will scan
  288.                   this directory for any  files. ALLFIX will send  whatever
  289.                   is contained  in this directory to the requesting system.
  290.                   The  files will be  deleted after  they are sent!  In the
  291.                   above example, the  program KEYGEN  may place  a new  key
  292.                   file in  this  directory. This  means  that when  someone
  293.                   request a key, they automatically get a new keyfile.
  294.  
  295.  
  296.