home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSFRONT / UUCP-RA.ZIP / UUCP-RA.DOC < prev    next >
Text File  |  1992-12-29  |  15KB  |  330 lines
  1. * UUCP-RA: Internet<==>FidoNet for Remote Access systems
  2.  
  3.                            Fredric L. Rice,
  4.              The Skeptic Tank, 1:102/890.0.  (818) 914-9551
  5.                       Version 1.4, December 1992
  6.  
  7. UUCP-RA: Internet <==> FidoNet for Remote Access systems
  8.  
  9. Objectives: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  10.     Allow SysOp and User alike to send and recieve messages to and
  11.     from Internet in an automated and comfortable manor, checking for
  12.     proper network addressing.
  13.  
  14.     Automatic addressing of outbound messages to the Internet/Fidonet
  15.     Gateway specified in a configuration file.
  16.  
  17.     Automatic addressing of inbound messages from the Internet/Fidonet
  18.     Gateway according to the name of the destination party in the
  19.     Internet message text.
  20.  
  21. Specifics: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  22.     This program scans the *.MSG subdirectory specified in the
  23.     configuration file (typically the inbound network mail directory)
  24.     for messages which are addressed FROM "uucp" and which are not
  25.     marked as "local" -- that is, messages that originated outside
  26.     of your system from a UUCP system.
  27.  
  28.     These messages are placed into the Remote Access folder secified
  29.     in the configuration file after the message text has been searched
  30.     for a "to:" kludge which is Internets way to specify the
  31.     destinations name and FidoNet address. If a valid name is located,
  32.     this program addresses the message to the User or SysOp by name,
  33.     else the destinations name is retained -- whatever it is.
  34.  
  35.     The program then scans the Remote Access folder you specify in the
  36.     configuration file for any messages which are addressed to "uucp"
  37.     and which are marked as "Umoved Echo Mail" -- that is, messages
  38.     that originated within your system and have yet to be tossed. Your
  39.     Remote Access Folder for the Internet Mail should be set to be an
  40.     EchoMail folder, not a Network Mail folder.
  41.  
  42.     After *.MSG messages are tossed to the Remote Access folder, they
  43.     are erased. If messages are tossed from Remote Access to a *.MSG
  44.     file, however, they are not marked as deleted in Remote Access,
  45.     merely marked as having been 'moved.'
  46.  
  47. Details: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  48.     When the SysOp or User write a message which is intended for the
  49.     Internet, the 'to' field is addressed to 'uucp' and the first line
  50.     of the message text contains the destination name and address
  51.     prefaced with a 'To:' label.
  52.  
  53.         An example. To send mail to someone called "Mark Diogenes"
  54.         whos network address is "netbios.com" you would address
  55.         your message something like this below from Remote Access:
  56.  
  57.                 From: FirstName LastName
  58.                 To: UUCP
  59.                 Sub: This is a sample test
  60.  
  61.                 1: To: mark.diogene@netbios.com
  62.                 2:
  63.                 3: Greetings, Mark. I'm testing the gateway.
  64.  
  65.     Messages which come in from Internet to your system through your
  66.     UUCP Gateway will be addressed FROM 'uucp' and will also have a
  67.     'To:' in the message text. This program scans for that 'To:' string
  68.     and attempts to extract the name of the individual to whom the
  69.     message is intended.
  70.  
  71.     While UUCP-RA is scanning the Remote Access data base, you may hit
  72.     the ESCAPE key to stop all processing.
  73.  
  74. Diagnostic displays: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  75.  
  76.     If /diag is offered on the command line, UUCP-RA will offer information
  77.     on what it is doing while it is processing.
  78.  
  79. Other Command Line Options: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  80.  
  81.     If /test is offered on the command line, even messages which are
  82.     marked as 'local' which appear in the Network Mail area of the *.MSG
  83.     subdirectory will be tossed to the Remote Access folder.
  84.  
  85.     If /list is offered on the command line, the program will scan through
  86.     the nodelist defined in the configuration file for UUCP gateways
  87.     which appear in the systems Zone and Network (if there are any.)
  88.  
  89.     If /listall is offered on the command line, the program will scan
  90.     through the nodelist for all UUCP gateways and offer a report.
  91.  
  92. Scan only and Toss only: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  93.     /toss
  94.  
  95.         A command-line option of /toss will only review the inbound
  96.         *.MSG messages in the network mail directory and toss them to
  97.         the Remote Access/QBBS Data base.
  98.  
  99.     /scan
  100.  
  101.         A command-line option of /scan will only scan the Remote
  102.         Access/QBBS data base for outbound mail and will toss them to
  103.         the network mail directory.
  104.  
  105. Configuration elements: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  106.     The environmental variable UUCPRA is used to tell UUCP-RA what
  107.     directory the UUCP-RA.CFG configuration file is located in. If the
  108.     environment variable is not set, the current directory is assumed.
  109.  
  110.                         set UUCPRA=C:\UTIL\
  111.  
  112.     A sample configuration file follows. This is offered for a detailed
  113.     description of how and what this project does:
  114.  
  115.         ; This is the address of your system. This address is used to
  116.         ; build the return address which appended to the end of every
  117.         ; text message so that the return address is automatically
  118.         ; offered. It is also needed so that the *.MSG message files may
  119.         ; be properly addressed to your UUCP <==>FidoNet gatewat.
  120.         ;
  121.         ; The syntax which must be followed is considered 'standard:'
  122.         ;
  123.         ;       zone:network/node.point
  124.         ;
  125.         ; The zone and point are _needed_. (Please change the sample below.)
  126.  
  127.         system          1:102/890.0
  128.  
  129.         ; This is the network address of the UUCP <==> FidoNet gateway. Its
  130.         ; syntax is the FidoNet 'Standard.' To find a UUCP <==> FidoNet gate
  131.         ; in your area, look through the standard distribution nodelist for
  132.         ; the User Flag UUCP or use the /list or /listall command to have
  133.         ; the project scan for the Gateways.
  134.  
  135.         gate            1:102/851.0
  136.  
  137.         ; This is the network mail directory path. Messages found in this
  138.         ; directory which are UUCP in origin will be tossed to Remote
  139.         ; Accesses data base. In addition, all messages found in the Remote
  140.         ; Access UUCP Mail folder will be tossed to this directory.
  141.         ;
  142.         ; Typically, this is your network mail directory. You may wish to
  143.         ; make it a holding directory so that you may revew all of the
  144.         ; messages prior to moving them maually to your outbound data
  145.         ; stream. This is a possible security measure you may take.
  146.  
  147.         network         c:\fd\mail\
  148.  
  149.         ; Where are the RA/QBBS *.BBS message files located?
  150.  
  151.         radir           c:\ra\msgbase\
  152.  
  153.         ; The program needs to know what message folder number in Remote
  154.         ; Access where the UUCP <==> FidoNet messages are to be found. All
  155.         ; messages which appear in this folder, regardless of who they
  156.         ; are addressed to, will be examined for a To: keyword in the
  157.         ; message text. If there is one, the program will process the
  158.         ; message and put it into the 'network' directory specified above.
  159.         ; In addition, any mail which has come in for your system which
  160.         ; appears in the 'network' directory specified above which is from
  161.         ; UUCP will be placed in this folder.
  162.  
  163.         folder          13
  164.  
  165.         ; Every time a message is tossed from UUCP to FidoNet or from
  166.         ; FidoNet to UUCP, a log entry in the file called UUCP-RA.LOG
  167.         ; can be created. The value which follows the 'log' keyword must
  168.         ; be either YES or NO. If no keyword is found or the value is
  169.         ; other than YES or NO, then NO is used as the default.
  170.  
  171.         log             yes
  172.  
  173.         ; When the command /list is entered on the command line, the
  174.         ; program will search through the nodelist specified following
  175.         ; this keyword for all of the systems which gate UUCP which
  176.         ; appear in the same zone and network as specified with the
  177.         ; 'SYSTEM' command. This this way, this project will provide
  178.         ; a list of systems which can be plugged into the 'GATE' value
  179.         ; if the SysOp doesn't know which systems gate UUCP mail.
  180.  
  181.         nodelist        c:\fd\nodelist\nodelist.339
  182.  
  183.         ; Each message can be appended with an Internet-type origin line
  184.         ; block. The text which follows each of the ORIGIN commands (and
  185.         ; there is no limit to the number of said lines) will be appended
  186.         ; to each of the messages that are tossed from Remote Access to
  187.         ; FidoNet. This is typical of Internet messages and the text
  188.         ; should reflect the SysOps name, the name of the FidoNet system,
  189.         ; phone numbers and message paths and what not.
  190.         ;
  191.         ; Note that you should keep it short and simple if you decide to
  192.         ; use it. Typically, three line or at most 4 lines are used and,
  193.         ; typically, the message text follows the format that this sample
  194.         ; file uses. As you can see, there is usually a tear line which
  195.         ; has the systems origins and various message paths on the left
  196.         ; with a 'clever' saying on the right. A newer habit is to limit
  197.         ; this line to _one_ line only, however, due to the number of
  198.         ; messages that systes handle andincreasing costs.
  199.         ;
  200.         ; If you don't wish to have an Origin Block appended to each and
  201.         ; every message, simply erase the ORIGIN lines or comment them
  202.         ; out with a ; character.
  203.  
  204.         origin ------------------------------------------------------------
  205.         origin The Skeptic Tank, Geldora, CA       |
  206.         origin SysOp: Fredric L. Rice              |   Stop discrimination!
  207.         origin FidoNet 1:102/890.0 (818) 914-9551  | Boycott Bells Inequality!
  208.         origin Packet: kc6efh@wb6ymh.#socal.usa.ca |
  209.  
  210.         ; All of the *.MSG message files that are created can be marked
  211.         ; as 'Hold For Pick-Up.' Typically it doesn't matter if it's
  212.         ; marked as hold or not yet you may wish to hold-off a
  213.         ; transmission of the outbound UUCP messages from your normal
  214.         ; outbound data stream.
  215.         ;
  216.         ; The values are either YES or NO. NO is defaultd if the HOLD
  217.         ; command is not offered.
  218.  
  219.         hold            no
  220.  
  221.         ; If messages are tossed from the 'network' subdirectory (The
  222.         ; *.MSG messages are tossed) you may have UUCP-RA keep a copy
  223.         ; of the message. This is done by setting the 'keep' value to
  224.         ; YES, otherwise if it's NO (or not supplied) the *.MSG will
  225.         ; be killed after it is tossed to Remote Access.
  226.         ;
  227.         ; The 'From' field is set to 'uucp' on inbound mail. After
  228.         ; UUCP-RA tosses the mail to Remote Access, if you want to keep
  229.         ; it, UUCP-RA will change the 'From' field to be '.uucp' with
  230.         ; a period before it. This will let UUCP-RA know that it has
  231.         ; already processed the message.
  232.  
  233.         keep            yes
  234.  
  235.         ; Most FidoNet systems will transport your outbound mail without
  236.         ; going through it and extracting the kludge lines. Typically,
  237.         ; you would want to answre the following question with 'no' unless
  238.         ; you plan to have the network transport your outbound Internet
  239.         ; mail.
  240.         ;
  241.         ; If you answer 'yes' to the following keyword, the MSGID, INTL,
  242.         ; TOPT, and FMPT Kludge lines will be included with each of your
  243.         ; messages. If you answer this keyword with 'no' then the kludges
  244.         ; will not be added.
  245.         ;
  246.         ; The default is NO. Only YES or NO are allowed.
  247.  
  248.         kludge          no
  249.  
  250.         ; Your mail can be marked as 'IMMEDIATE' if you wish to have your
  251.         ; mailer send the Internet mail as soon as your system returns
  252.         ; to the mailer.
  253.         ;
  254.         ; This is a kludge-line addition, by the way, so you'll have to
  255.         ; find out if your Fidonet UUCP Host has problems with it.
  256.         ;
  257.         ; The default is NO. YES or NO are the possible answers.
  258.  
  259.         immediate       no
  260.  
  261. ErrorLevels: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  262.     The ErrorLevel returned indicates whether any messages were found
  263.     and tossed, whether no messages were tossed and executed terminated
  264.     normally, or if there was a problem with the programs execution.
  265.  
  266.     The following are the ErrorLevel values returned. Hopefully the
  267.     short description offered is descriptive enough:
  268.  
  269.         -= No problems and no mail tossed =-
  270.  
  271.                 No_Problem              0
  272.  
  273.         -= Failure in execution =-
  274.  
  275.                 Missing_Config          10
  276.                 Bad_System_Address      11
  277.                 Bad_Folder              12
  278.                 Bad_Gate_Address        13
  279.                 Missing_Network         14
  280.                 Missing_RA_Dir          15
  281.                 Cant_Open_Message_Base  16
  282.                 Folder_Area_Bad         17
  283.                 Fail_Write              18
  284.                 Cant_Read_Message       19
  285.                 Seek_Failed             20
  286.                 No_Nodelist_Offered     21
  287.                 Cant_Open_Nodelist      22
  288.                 No_Memory               23
  289.                 Cant_Create_MSG_File    24
  290.                 Cant_Write_MSG_File     25
  291.                 Cant_Seek_Text_File     26
  292.                 Cant_Read_Text_File     27
  293.                 Cant_Seek_Header_File   28
  294.                 Cant_Update_Header      29
  295.                 Config_Hold_Error       30
  296.                 Config_Immediate_Error  31
  297.                 Cant_Open_MSG_File      32
  298.                 Config_Kludge_Error     33
  299.  
  300.         -= Mail tossed, normal termination =-
  301.  
  302.                 Toss_To_Outbound        100
  303.                 Toss_To_Inbound         101
  304.                 Toss_Both_Out_In_Bound  102
  305.  
  306. Distribution Package: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  307.     UUCP-RA.LZH contains:
  308.  
  309.         UUCP-RA.EXE     Executed file.
  310.         UUCP-RA.CFG     Sample configuration file. Please update.
  311.         UUCP-RA.C       The source code in C for this project.
  312.         UUCP-RA.DOC     This documentation file.
  313.         MAKEIT.BAT      Batch file to compile the project.
  314.         M-UUCP          Make file for the compile phase.
  315.         UUCP-RA.RES     Response file for its link phase.
  316.  
  317.     This project is copywritten by myself yet I grant anyone to use the
  318.     project and the source code as they wish. Please note that I refuse
  319.     to be held responsible for its use or misuse yet I _will_ take people
  320.     who steal from the public domain by selling my stuff (for _any_ cost)
  321.     to court.
  322.  
  323.     In other words, please distribute freely.
  324.  
  325. Fredric L. Rice
  326. Packet: kc6efh@wb6ymh.#socal.usa.ca
  327. Internet: fredric.rice@f102.n890.z1.fidonet.org
  328. FidoNet: 1:102/890.0 (818) 914-9551
  329.  
  330.