home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / VD050B.ZIP / VD.DOC < prev    next >
Encoding:
Text File  |  1989-03-18  |  8.6 KB  |  297 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                  ValidOOR
  8.                                  --------
  9.  
  10.  
  11.  
  12.                       Pre-Release beta Documentation
  13.                       -------------------------------
  14.  
  15.  
  16.  
  17.          Copyright (c)1989, Cabell B. Clarke Jr., All Rights Reserved.
  18.  
  19.  
  20.                            The Boot Factory BBS
  21.                            --------------------
  22.                              FidoNET 1:264/19
  23.                               3/12/24/96HST
  24.                               804-262-9289
  25.  
  26.  
  27. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  28. Disclaimer
  29. ----------
  30.  
  31. This is beta test software.  It is not guaranteed to work at all. If
  32. it trashes your system or ruins your life, you have been warned.  I am
  33. not responsible for any damages incurred from the use or misuse of this
  34. software.
  35. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  36.  
  37.  
  38. ValidOOR beta Release
  39. ----------------------
  40.  
  41. This documentation is very incomplete right now.  I have not had time to
  42. finish it.  Hopefully some kind soul will come to the rescue with some
  43. decent docs. <HINT>  I apologize for the sorry state of the docs.
  44.  
  45.  
  46.  
  47.  
  48. ValidOOR is a User Validation Door written for the Quick Bulletin Board
  49. System.  ValidOOR allows QuickBBS Sysops have their systems call users
  50. back in order to verify that they have left a valid phone number for
  51. the sysop's records.  This results in a more secure system for the sysop
  52. as well as his users.
  53.  
  54. This is a beta version of ValidOOR.  I have decided to release it to
  55. the FidoNET community for beta testing since the program development
  56. has slowed in the last few weeks.  I am specifically looking for ideas
  57. enhancements, and BUG reports.  This and subsequent beta versions will
  58. have an expiration date built-in (usually the end of the month).  I will
  59. publish the expiration dates in a file called EXPIRE.TXT in each release.
  60. This is primarily to keep the beta versions from spreading all over the
  61. net and to insure that you will have the latest version for your system.
  62.  
  63.  
  64. When ValidOOR 1.00 is released!
  65. -------------------------------
  66. ValidOOR will be released to the general public as ShareWare.  This means
  67. that you will be free to use the program to evaluate it.  If it meets your
  68. needs, then you will then be expected to register your copy so you can
  69. receive the full-blown ValidOOR system.
  70.  
  71.  
  72.  
  73. In order to get going with VD, first you need to unARC all of the files
  74. into your QuickBBS directory.  I recommend printing this documentation
  75. as well as the VD.CFG file as it contains helpful hints for setting up
  76. the config file in it's comments.
  77.  
  78.  
  79.  
  80.  
  81. vd.cfg
  82. ------
  83. The VD.CFG file contains all of the important parameters necessary to
  84. run VD.  Please remember that any line which begins with a per-cent (%)
  85. is a comment and may be removed, however, if you remove comments, you
  86. are on your own.  VD.CFG is well-commented and should be self explanatory
  87. in setting it up.  Just load it into your text editor.  Make sure that
  88. there are no comments on the lines which contain parameters.  Also make
  89. sure that you only have one (1) space between the Variable Descriptor and
  90. the variable itself like this:
  91.  
  92.  
  93. ModemSuffix &M4
  94.            ^
  95.            |
  96.            one space here
  97.  
  98. NOTE:  In the beta versions there have been several vd.cfg file formats.
  99.        Make sure the vd.cfg file you are using is compatible with your
  100.        version of VD.
  101.  
  102.  
  103.  
  104. Once the user selects ValidOOR, QuickBBS should exit via type
  105. 7 or 15 to run ValidOOR.  I use type 7 with a batch file which I have
  106. included here.  ValidOOR loads, initializes the FOSSIL driver, and does
  107. some setup things - reads VD.CFG which you the user must set up, it looks
  108. for EXITINFO.BBS, and PHONENUM.CTL (if phonenum.ctl processing is enabled).
  109. It also looks for it's directory file which it creates if not found.
  110.  
  111.  
  112.  
  113. Several cases will cause ValidOOR to abort with an errorlevel:
  114.  
  115.         o  absence of any of these files:
  116.                 EXITINFO.BBS
  117.                 VD.CFG
  118.                 PHONENUM.CTL (if enabled)
  119.  
  120.         o  Long Distance attempt (if enabled)
  121.  
  122.         o  Carrier Loss
  123.  
  124.         o  Absence of FOSSIL Comm Driver
  125.  
  126.         o  Duplicate Phone Number (Number already in directory file)
  127.  
  128. If ValidOOR aborts, an entry will be written into the log to inform you
  129. what happened.
  130.  
  131. ValidOOR knows the two phone numbers that the user entered during his
  132. initial login to QuickBBS.  It will prompt the user to select which of
  133. the two numbers his modem is currently connected to.  After this selection
  134. is made, ValidOOR will ask him if a 1- should be placed in front of the
  135. number for a long distance call.
  136.  
  137. If all files are present and everything went properly, ValidOOR will inform
  138. the user that he about to be validated and prompt him to hit <ENTER> when
  139. he is ready.  When the user hits <ENTER> ValidOOR will disconnect him,
  140. take the phone off the hook, and wait a pre-defined number of seconds
  141. (ModemWait Time in VD.CFG).  The ValidOOR will put the modem back on
  142. the hook and call the user at the same baud rate that he logged into
  143. the BBS. The number of "Non-Connect" attempts can be set up in VD.CFG but
  144. the system will only try 1 time if a connection is established.
  145.  
  146. When the connection is successful, ValidOOR will display a brief message
  147. to the user and prompt him to enter his password.  He gets three tries
  148. before ValidOOR gives up and disconnects.  An Inactivity timer which is
  149. configurable in VD.CFG will disconnect him if he falls asleep.
  150.  
  151. If he fails to enter the proper password (from EXITINFO.BBS) for whatever
  152. reason, the system will disconnect him and exit with an errorlevel 2. Your
  153. batch file can then process the errorlevel accordingly.  An appropriate
  154. entry will be written to the log.
  155.  
  156. If he is successful, then ValidOOR will exit with an errorlevel 0.  Your
  157. batch file can process accordingly.  Also an entry will be written into
  158. the log file to let you know what happened.
  159.  
  160. I use Rob Fletcher's SetFlag to process these errorlevels, so the user
  161. can call back immediately and have access to the BBS.  See NOTE below
  162. about SetFlag. *
  163.  
  164.  
  165.  
  166. Registered Users
  167. ----------------
  168.  
  169. Those of you who choose to register your copy of ValidOOR will receive
  170. the full-blown system via Snail Mail which includes the following:
  171.  
  172.  
  173. o  A control file compiler.
  174.  
  175. o  A User Directory utility.
  176.  
  177. o  Flag/Security Update utility.
  178.  
  179. o  whatever else I think of.
  180.  
  181.  
  182.  
  183. beta Notes
  184. -----------
  185.  
  186. 0.50b
  187. -----
  188. Minor Code Cleanups.
  189.  
  190.  
  191. 0.47b
  192. -----
  193. Removed PhoneNum.Ctl support.
  194.  
  195.  
  196. 0.46b
  197. -----
  198. Added "Hit Any Key" toggle to vd.cfg for High Speed modems. Not released.
  199.  
  200.  
  201. 0.45b
  202. -----
  203. Minor cleanup. Not released
  204.  
  205.  
  206. 0.44b
  207. -----
  208. Added more errorlevels.  Removed the hard-coded DTR drops so that sysops
  209. can let users back on the bbs if they choose. Not released.
  210.  
  211.  
  212. 0.43b
  213. -----
  214. Added the <A>bort to questionaire to let user back to BBS. Not released.
  215.  
  216.  
  217. 0.42b
  218. -----
  219. Experimented with "Hit Any Key" prompt at the end of text files.
  220. Not released.
  221.  
  222.  
  223. 0.41b
  224. -----
  225. Fixed 3 bugs that resulted from the rewrite of the config file parser.
  226.  
  227.  
  228. 0.40b
  229. -----
  230. Did away with the .q-a file - VD now handles this internally. Not released.
  231.  
  232.  
  233. 0.39b
  234. -----
  235. Added External text files to valid logoff, invalid logoff, and Long distance
  236. logoff.  Fixed minor bugs which showed up in 0.38b due to the cfg file
  237. changes.  Not released.
  238.  
  239.  
  240. 0.38b
  241. -----
  242. Complete new type of vd.cfg file (intelligent parser). Not released.
  243.  
  244.  
  245. 0.37b
  246. -----
  247. Multiple Local Area Code Support added.
  248.  
  249.  
  250. 0.35b
  251. -----
  252. Fixed the PhoneNum.Ctl processing bug and increased total entries
  253. allowed in PhoneNum.Ctl to 200.
  254. Now takes the phone offhook in between calls.
  255.  
  256.  
  257. 0.34b
  258. -----
  259. Fixed the FOSSIL bug which actually was an improper port initialization.
  260. Only showed up on systems running Com2.  Stupid programming error.
  261.  
  262.  
  263. 0.30g
  264. -----
  265. Initial gamma release.
  266.  
  267.  
  268. * SetFlag
  269. ---------
  270. Rob Fletcher has written a great utility called SetFlag and has generously
  271. given me his permission to include it in the ValidOOR Archive.  See the
  272. doc file Setflag.Doc for the ins and outs of using this program.
  273.  
  274. Thanks Rob!
  275.  
  276.  
  277.  
  278.  
  279. Credits
  280. -------
  281.  
  282. Thanks to the following individuals:
  283.  
  284. Adam Hudson      -  The Author of QuickBBS.
  285. Robert Rosanio   -  whose REGISTER program gave me the original idea.
  286. Greg Dawson      -  for teaching me how to access FOSSIL from QuickBASIC.
  287. Mike Janke       -  for his wonderful Exit w/errorlevel code.
  288. Rob Fletcher     -  for writing SetFlag.
  289.  
  290.  
  291. Also Thanks to the Beta Testers....  All of you.
  292.  
  293.  
  294. Report ALL to:
  295. Cabell Clarke
  296. 1:264/19
  297.