home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / PHREQ13B.ZIP / PHREQ.DOC < prev    next >
Text File  |  1995-01-15  |  14KB  |  230 lines
  1. ==============================   PHreq!.DOC   ===============================
  2. Version 1.3beta
  3.  
  4.     PHreq! is a TriBBS door program which allows a sysop to provide anonymous
  5. file transfers of selected files using various protocols.  PHreq! can be
  6. configured to allow the caller to download any/all of the listed files or
  7. only a preset number of files (up to 26 files).  PHreq! allows the use of 
  8. descriptive "magic" names which can be up to 20 characters long.  Also new 
  9. in this version are one line file descriptions (max. 70 characters).  In the 
  10. unregistered version a maximum of 3 files can be downloaded per session.  
  11.     The program supports an optional intro screen which can be of any 
  12. length (line length should not exceed 256 characters) and will be displayed 
  13. to the caller 22 lines at a time.  The door can make use of either DSZ or 
  14. GSZ Zmodem protocol (Omen Technology, seperate registration required), 
  15. any of TriBBS's internal protocols (TTPROT.EXE) or HS/Link (Samuel H. Smith, 
  16. seperate registration required) bi-directional protocol for transfers.  
  17. HS/Link is set to block any attempted uploads since the sysop will have no idea 
  18. where these files came from.  PHreq! now also supports any protocols defined
  19. in TriBBS's EXTPROT.MNU, including protocols which use redefined hotkeys
  20. for TriBBS's internal protocols.  If you have an error correcting protocol
  21. available, but TriBBS does not detect an error correcting modem then the
  22. protocol choice will not appear in the protocol list.
  23.     The door will also write a summary of the callers actions into the 
  24. CALLERS.LOG file so the sysop can easily see what files where downloaded and 
  25. when.  A 3 line message can also be left for the sysop (enter "*" as the 
  26. first file selection), which will be displayed to the sysop as a logon 
  27. message (appended to existing 1.bbs or creates a new 1.bbs file).  A caller 
  28. can also specify a single file to be downloaded by entering a "!" in front 
  29. of the magic name (eg. !PHREQ_BETA).  This will cause the program to search 
  30. for the named file (the search is NOT case-sensitive) and if it exists it 
  31. will start the download and log the caller out in the normal fashion (I have 
  32. included this feature so that people can use an automated script for their 
  33. terminal program to call and ask for a file by name rather than having to look 
  34. through a list and find a file by it's letter).  If the file is not found it 
  35. will notify the caller and wait for further input - either reenter the magic 
  36. name, choose a file(s) by letter or press <ENTER> to hangup without downloading. 
  37. The "*" and "!" options can be used together but the "*" must come first.  The 
  38. file descriptions are accessed by pressing "?" at the prompt.  In query mode, 
  39. you simply press the letter preceding the file you want the description for, and 
  40. it will be displayed at the bottom of the screen - you do not need to press 
  41. <ENTER>.  You may continue to query files for their descriptions as often as you 
  42. like.  When you are finished looking at the file descriptions, press "?" again 
  43. to return to file selection mode.
  44.     After the file transfer is complete the door will either hang up the modem 
  45. and reinitialize TriBBS to await the next caller or return to the BBS - depending
  46. on how you have configured the door.  The program will also update the "Today's 
  47. Downloads" line on the TriBBS "Waiting for Caller" screen.  This door may also work 
  48. with other BBS's that are capable of running user specific logon batch files.  If 
  49. used on other BBS software, the door will give error messages when it tries to write 
  50. to the log file, but the transfers should take place correctly.  Phreq should also 
  51. hang up on the caller properly, but it will not reset the BBS - the sysop will have 
  52. to ensure that this takes place by some other means.  I have not tested PHreq on any 
  53. other systems, so I would appreciate any feedback from anyone who might try this.
  54.  
  55. This door is perfect for software developers and sysops who want to be able
  56. to provide public access to commonly requested files without making the 
  57. caller fill out all the new user information.  This is especially important
  58. if the person is calling long distance with the express purpose of getting
  59. a file that they know you have available. 
  60.     The most likely setup for this door is to include it in a SECxxxx.BAT 
  61. file which gets run as soon as the caller logs onto the BBS.  You will need 
  62. to create a dummy account which you will use to access the SECxxxx.BAT file 
  63. - something like username PHREQ FILES, password GUEST.  Make sure you assign 
  64. a security level to this account that is unique, so that no regular users 
  65. will accidentally get into the door.  I would suggest setting it up with a 
  66. security level lower than your new user logon security level.  Since the sole 
  67. purpose of the door is for anonymous transfer, and the caller will never 
  68. access the BBS, there is no need for a higher level of security for the BBS.  
  69. Also if the caller should ever happen to break in to the BBS through the 
  70. door, they will have very limited access to the features of your BBS 
  71. (remember.... they are an anonymous caller).  As an additional security 
  72. measure, you should create a xxxxSEC.BBS screen that includes the @HANGUP@ 
  73. command which will have the effect of logging the caller off, if they should 
  74. somehow get past PHreq!'s internal logoff function.
  75.  
  76. Phreq! can also be run as a door from the BBS to provide access to files
  77. that you might want to make available off of a particular menu (eg. you might
  78. want to offer a selection of mail readers that callers can download off of 
  79. your message menu or offer a special list of files to visiting sysops, etc.)
  80. To run PHreq! as a door from within the BBS, you need to make the appropriate
  81. changes to the PHREQ.CFG file - put "N" (or any other character except "Y")
  82. on the line for logoff after download and as an option you can allow the
  83. caller to select the protocol to use (same protocols as listed above) by 
  84. entering "U" on the line for the protocol to use (U=user defined).  You can
  85. also configure the door so that it will give back the time that was used while
  86. in downloading files.  In effect this makes them free downloads since they are
  87. not counted into the total bytes downloaded, and their time is not reduced for
  88. having downloaded the files.  To set this option enter a "Y" in the phreq.cfg
  89. file on the line which asks if you want to "Give back the time used.....".
  90.  
  91. INSTALLATION (for Anonymous logins)
  92. ------------
  93. 1.   Create a directory to hold all the PHreq! files.  Move into the newly
  94.     created directory.
  95. 2.   Unzip all of the files contained in the PHreq! archive into the PHreq!
  96.     directory.
  97. 3.   Modify the PHREQ.CFG file following the instructions listed at the 
  98.     bottom of the configuration file.  Make sure that you have the trailing 
  99.     backslash on the directory path where indicated.
  100. 4.   If you want to run the door as a SECxxxx.BAT file, edit the sample 
  101.     SEC1.BAT file (or write your own) and rename it using the security level 
  102.     that you want to use.  Move this file to your TriBBS main directory.
  103.     If you have multiple nodes, you will have to copy this batch file to
  104.     the main directory of each node you wish to have access the door.
  105. 5.   Create a dummy account on your system which will be used to access the
  106.     door.  Remember to assign a unique security level to this account.  The
  107.     security level you enter for this account must match the number in the
  108.     filename used in step 4 (i.e. if you created a SEC1.BAT file in step 4
  109.     you must assign a security level of 1 to the dummy account).  Create a
  110.     xxxxSEC.BBS file (in the display directory) which includes the @HANGUP@
  111.     command.  This is simply as an added safety precaution -see text above.
  112. 6.   Edit the PHREQ.LST file to include all of the files you would like to
  113.     make available for anonymous download.  You may include any number of
  114.     files up to a maximum of 26 files (the unregistered version will only
  115.     allow a user to d/l a maximum of 3 files).  Each line MUST contain a
  116.     magic name for the file and the full path to the file.  The magic name
  117.     can be up to 20 characters long, and can include any characters except
  118.     spaces (use underlines instead of spaces).  There must be at least one
  119.     space between the magic name and the path\filename.  See the sample file
  120.     included in this archive.
  121. 7.   If desired, create an optional introduction screen which could list 
  122.     instructions, file limits, specifics about what certain files contain,
  123.     or any other information you might like to provide to anonymous callers.
  124.     The file must be called PHREQ.ANS or PHREQ.BBS and be located in the
  125.     PHreq! directory.  The screen supports the use of escape codes but NOT
  126.     @ codes.
  127. 8.   Copy the file SYSDAT2.DAT from the TriBBS main directory to the PHreq
  128.     directory.  If you don't use TriBBS don't worry about this part.
  129.  
  130. INSTALLATION ( as a door within the BBS)
  131. ----------------------------------------
  132. 1.   Complete instructions 1-3 and 6-8 from above.
  133. 2.   Change line 9 of the PHREQ.CFG file to "N", so that the door
  134.     will not hang up and reset the board, but return to the BBS.
  135. 3.   Modify the appropriate menu to add the PHreq! door.  If you are adding
  136.     it to the DOORS.MNU file you should have something like this:
  137.         
  138.         T,TEXT,PHREQ.BAT,100
  139.         Where: T=type of drop file to use (check TriBBS manual for values)
  140.               TEXT=text that will appear on default menus
  141.               PHREQ.BAT=name of the batch file that will call PHreq!
  142.               100=the minimum security level to access this option
  143.  
  144.     If you are adding Phreq! to any other menu you will have to add a line         
  145.     to the appropriate menu such as the following:
  146.         
  147.         !,!,TEXT,100
  148.             Where: !,!= the hotkey you want to use to access the door
  149.                   TEXT=the text you want to appear on the default menus
  150.                   100=the minimum security level to access the door
  151.         
  152.     The name of the batch file you will create to run the PHreq! door will
  153.     be dependent on what menu you have added it to.  Check the TriBBS manual
  154.     for the proper name to use (ex. MESSO.BAT to run a door off the message
  155.     menu using the "O" hotkey, MAIN1.BAT to run door from the main menu with
  156.     the hotkey "1").  The batch file should look similar to the following.
  157.     Make the appropriate changes to directory names and irq value (replace
  158.     [non-standard irq] with the appropriate value if required.
  159.         
  160.         CD \TRIBBS\DOORS\PHREQ
  161.         PHREQ PHREQ.CFG [non-standard irq]
  162.         CD \TRIBBS
  163.         BOARD
  164.  
  165.  
  166. INSTALLATION ( in logon.bat or newuser.bat file)
  167. ------------------------------------------------
  168. Set up PHreq! following the instructions for anonymous logons, but skip the 
  169. section where you create the dummy account and the SECxxxx.BAT file.  Simply
  170. add the appropriate lines to the LOGON.BAT or NEWUSER.BAT file (use included 
  171. batch file as an example).  This will cause the door to be run as part of the
  172. logon process so that you can offer up special files for download (i.e. ripterm)
  173. before the caller finishes logging into the board.
  174.  
  175. If you followed the steps above, the door should be installed properly,
  176. and should work without any problems, providing that you have the Zmodem
  177. program in your DOS path somewhere.  TTPROT should already be in the path
  178. since it is located in the TriBBS main directory.  Any protocols defined in
  179. your EXTPROT.MNU file should work properly since their batch files have to
  180. be in the TriBBS main directory and are also therefore in the DOS path.
  181.  
  182. If you want to check to see if the door is functioning properly, you can
  183. log in locally by switching to the PHreq directory and using the following 
  184. command line:
  185.    C:\>  PHREQ  PHREQ.CFG  LOCAL
  186. You will get an error message when you finish a local logon, because the
  187. program tries to update the DOORS.TMP file, which only exists if a caller
  188. is online and running a door, so just ignore the error message - it's OK.
  189. Also, when run locally the door will still write to the temporary
  190. callers.log file - this means that the next time you have a caller online
  191. you will get a bunch of extra lines added to the permanent callers.log file
  192. which reflect your local test.  To avoid this, simply remove the temporary
  193. callers.log file from the \TRIBBS\NWORK directory when you are done the 
  194. local session - BE SURE YOU DELETE THE FILE FROM THE CORRECT NODE!!
  195.  
  196. The following special keys are available to the sysop while the door is
  197. running, to allow access to a variety of functions.
  198.  
  199. HOME      Toggle between User status window and Sysop special keys window.
  200. F6        Takes 5 minutes away from callers time - only applies to time in
  201.              the door program - not to time on the BBS.
  202. F7        Adds 5 minutes to the callers time - only applies to time in the
  203.              door program - not to time on the BBS.
  204. F9        Quits the door and returns the caller to the BBS.
  205. F10       Enter Chat mode.  Exit chat mode by pressing ESC.
  206. ALT+D     Drop to DOS. Type EXIT at the DOS prompt to return to the door.
  207.  
  208.  
  209. ACKNOWLEDGEMENT
  210. ---------------
  211. This program is written in Turbo C++ using the TDoor and TBAPI libraries, 
  212. both of which are written by Mark Goodwin (author of TriBBS).  
  213. These libraries are easy to work with and greatly simplify the work of 3rd 
  214. party authors in providing seamless integration with TriBBS.
  215. THANKS MARK!!
  216.  
  217.  
  218. CONTACTING THE AUTHOR
  219. ---------------------
  220. If you have any questions or comments about this, or any of my other programs
  221. I can be reached through the following:
  222.  
  223. WME conferences - BBS Doors, C/C++ Programming, BBS Utilities, TriBBS Support
  224. PHONE (807) 767-4155, 
  225. BBS   (807) 767-1185
  226. Mail: Peter Hanmore
  227.      265 Cascade Cres.
  228.      Thunder Bay, ON
  229.      CANADA   P7B 6H9
  230.