home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / ra / regchk10.zip / REGCHECK.DOC < prev    next >
Text File  |  1993-02-21  |  17KB  |  387 lines
  1.  
  2.                         Registered User Tracking Utility
  3.                          Copyright 1993 -- Ron Bergeron
  4.                         ════════════════════════════════
  5.  
  6.  
  7. ┌─────────────┐
  8. │ What is it? │
  9. └─────────────┘
  10. The Registered User Tracking Utility is a set of programs that allow you
  11. to easily and automatically keep track of your registered users.  Here
  12. are some of its features:
  13.  
  14.    *  Automatically downgrade users after registration period expires
  15.    *  Alter user security level and/or access flags
  16.    *  Display .ANS/.ASC screen encouraging users to register with your BBS
  17.    *  Display .ANS/.ASC screen warning registered users when registration is
  18.       going to expire soon
  19.    *  Display .ANS/.ASC screen advising users when their account has expired
  20.    *  All .ANS/.ASC screens are fully customizable by the sysop
  21.    *  Ignore users with certain security levels and/or access flags set
  22.    *  Automatically upgrade users by simply entering their name and
  23.       expiration date into database
  24.    *  Track up to 500 registered users
  25.    *  Logs all upgrades or downgrades
  26.    *  Multitasking capable for multinode systems
  27.    *  Many options yet easy to set up
  28.  
  29. ┌───────────────────┐
  30. │ How Does It Work? │
  31. └───────────────────┘
  32. When every user logs onto your BBS, REGCHECK.EXE will check to see if
  33. their name appears in the registered user database (which is created by
  34. CONFIG.EXE).
  35.  
  36. If the user is NOT in the database, REGCHECK.EXE will display a sysop
  37. configurable screen which suggests that the user consider registering
  38. with your BBS.
  39.  
  40. If the user IS in the database, but their registration period is due to
  41. expire soon, then a screen warning them of this will be displayed.
  42.  
  43. If the user IS in the database and their registration period has
  44. expired, REGCHECK.EXE will lower their security level and/or access
  45. flags and then display a screen telling them of this action.
  46.  
  47. If the user IS in the database and their registration period is NOT due
  48. to expire in the near future, the program exits and the user is sent to
  49. the BBS.
  50.  
  51. This version of the program can track up to 500 registered users.  If
  52. you need to be able to track more than this, let me know and I can
  53. arrange a special version for you.
  54.  
  55. ┌─────────────────────┐
  56. │ How Do I Set It Up? │
  57. └─────────────────────┘
  58. Create a separate directory and uncompress the distribution file into it.  The
  59. files in this compressed file include:
  60.  
  61.    REGCHECK.EXE -  The door portion of the program
  62.    CONFIG.EXE   -  The configuration and registered user database program
  63.    SUGGEST.ANS  -  A sample ANSI "suggestion" display screen
  64.    SUGGEST.ASC  -  A sample ASCII "suggestion" display screen
  65.    WARNING.ANS  -  A sample ANSI "warning" screen
  66.    WARNING.ASC  -  A sample ASCII "warning" screen
  67.    EXPIRED.ANS  -  A sample ANSI "expired" screen
  68.    EXPIRED.ASC  -  A sample ASCII "expired" screen
  69.    REGCHECK.DOC -  The documentation (the file you are reading now)
  70.    REGISTER.EXE -  Program to create the registration form
  71.    OTHERS.TXT   -  List of other available programs
  72.  
  73. The following files will be created by REGCHECK.EXE and CONFIG.EXE:
  74.  
  75.    REG_USR.DAT  - The registered user database
  76.    REGCFG.CFG   - Configuration file
  77.    REGCHECK.LOG - Upgrade/downgrade/error log file
  78.  
  79. ┌───────────────┐
  80. │ Configuration │
  81. └───────────────┘
  82. First of all, you must create the configuration file.  This is done
  83. using the program CONFIG.EXE.  Start the program and press "C" to enter
  84. the configuration menu.  You MUST enter the configuration menu even if
  85. you want to use the default settings.  Entering the menu the first time
  86. will create the configuration file.  Without the configuration file, the
  87. program will not work.  Figure 1 shows the configuration menu with all the
  88. default values displayed.
  89.  
  90.        ╔═══════════════════════════════════════════════════════════════╗
  91.        ║                     Configuration Options                     ║
  92.        ╠═══════════════════════════════════════════════════════════════╣
  93.        ║ (A) Number of Warning Days: 7                                 ║
  94.        ║ (B) Warning Delay: 5                                          ║
  95.        ║ (C) Suggestion Delay: 5                                       ║
  96.        ║ (D) Expire Delay: 1                                           ║
  97.        ║ (E) Zero D/L Counters (Y or N): YES                           ║
  98.        ║ (F) Before Security: 45                                       ║
  99.        ║ (G) After Security: 5                                         ║
  100.        ║ (H) Before Flags: A:???????? B:???????? C:???????? D:???????? ║
  101.        ║ (I) After Flags:  A:???????? B:???????? C:???????? D:???????? ║
  102.        ║ (J) Ignore Flags: A:???????? B:???????? C:???????? D:???????? ║
  103.        ║ (K) Ignore Security Level: 32000                              ║
  104.        ║ (L) Prompt Color: Foreground (0-15): 11  Background (0-7): 0  ║
  105.        ║ (M) Ignore User's First Number of Calls: 20                   ║
  106.        ║ (X) Exit Configuration Menu                                   ║
  107.        ╚═══════════════════════════════════════════════════════════════╝
  108.                        figure 1 - Configuration Options
  109.  
  110.  
  111. A brief explanation of each configuration item follows:
  112.  
  113.  
  114. "A" is the number of days before the expiration date that you want to
  115. start warning the registered users.  Give the user enough warning so that
  116. they can register again before their registration period expires.
  117.  
  118. "B, C, D" are delay times (in seconds) that occur after the various
  119. screens are displayed (0 = no delay).  You can use this to make sure
  120. your users get plenty of time to read the information on the screens.
  121.  
  122. "E" is whether or not to zero out the user's up/download counters when
  123. the user's registration expires and they are downgraded.  This is to prevent
  124. them from having an unfair upload/download ratio once they are downgraded.
  125.  
  126. "F" is the security level of a "registered" user.  The program will
  127. bring the user to this level if their name appears in the database.  If
  128. you enter a "0" here, the user's security level will NOT be affected in
  129. any way.  This can be useful if you have several registered user
  130. security levels.  The drawback is that you will have to alter the user's
  131. security level and access flags manually instead of having REGCHECK do
  132. it automatically.
  133.  
  134. "G" is the security level to downgrade the user to when their account
  135. expires.  Again, enter a "0" if you don't want to change the security
  136. level.
  137.  
  138. "H" are the user flags of a registered user.  If a user's name appears
  139. in the data base, their flags will be altered according to what you
  140. enter here.  Enter an "X" to turn the flag on, a "-" to turn it off, and
  141. a "?" to leave that particular flag alone.  (See the section "USER
  142. FLAGS" for more information on this).
  143.  
  144. "I" are the user flags of an unregistered user.  When a user's
  145. registration period expires, their flags will be altered according to
  146. what you enter here.  Enter an "X" to turn the flag on, a "-" to turn it
  147. off, and a "?" to leave that particular flag alone.  (See the section
  148. "USER FLAGS" for more information on this).
  149.  
  150. "J" are the ignore flags.  If, for example, you set flag A1 to ON and a
  151. user logs on with A1 set, the door will allow the user to go straight to
  152. the BBS without displaying any of the .ANS/.ASC screens to them.  This
  153. is good for your friends and visiting sysops.  If you choose not to use
  154. this feature, just leave all the bits as "?".
  155.  
  156. "K" is the ignore security level.  Anyone with a security level of this
  157. or above, will be sent straight to the BBS without seeing the .ANS/.ASC
  158. screens.  You'll want to at least put your own security level here.
  159.  
  160. "L" is the foreground and background colors of the prompts that are
  161. displayed after each screen is displayed to the user.  The colors are as
  162. follows:
  163.  
  164.                  0 - Black             8 - Bright Black
  165.                  1 - Blue              9 - Bright Blue
  166.                  2 - Green            10 - Bright Green
  167.                  3 - Cyan             11 - Bright Cyan
  168.                  4 - Red              12 - Bright Red
  169.                  5 - Magenta          13 - Bright Magenta
  170.                  6 - Brown            14 - Yellow
  171.                  7 - White (gray)     15 - White (bright)
  172.  
  173. "M" is the number of calls you want the user to have made to your BBS
  174. before the program starts displaying the "donation suggestion" screen.
  175. This is so a new user can have time to use your BBS for while without
  176. feeling pressured to send in a donation.
  177.  
  178. ┌────────────┐
  179. │ User Flags │
  180. └────────────┘
  181. REGCHECK alters the user flags based on the information that is in the
  182. configuration file.  If you put an "X" in one of the user flags,
  183. REGCHECK will turn that flag ON no matter how the flag was set
  184. originally.  If you put a "-", then the flag will be set OFF.  If you
  185. put a "?", then REGCHECK will NOT change the flag at all.
  186.  
  187. example:
  188.  
  189. flags when user logs onto BBS: A:XX------ B:--X-X--- C:-----X-X D:X-X-X-X-
  190. "after" flags:                 A:-??????X B:???????? C:???????? D:????????
  191.  
  192. If a user whose registration has just expired logs onto your BBS, REGCHECK
  193. will change the flags to:      A:-X-----X B:--X-X--- C:-----X-X D:X-X-X-X-
  194.  
  195. Notice that the only changes were that flag A1 was set OFF and that A8
  196. was set on.  All other flags were left alone because of the question
  197. marks in the configuration template.
  198.  
  199. ┌───────────────┐
  200. │ User Database │
  201. └───────────────┘
  202. Pressing "(R) Registered User List" from the main menu will bring you to
  203. the main registered user database menu (figure 2).  From this menu you can
  204. enter, edit, search, delete, or browse through your registered user list.
  205.  
  206.            ╔═══════════════════════════════════════════════════════╗
  207.            ║                  Registered User List                 ║
  208.            ╠═══════════════════════════════════════════════════════╣
  209.            ║  User Name:                                           ║
  210.            ║  Expiration Date (MM/DD/YY):                          ║
  211.            ║  Record Number:     of                                ║
  212.            ╟───────────────────────────────────────────────────────╢
  213.            ║ (M) Main Menu      (E) Edit User    (L) Last User     ║
  214.            ║ (A) Add User       (S) Search       (N) Next User     ║
  215.            ║ (D) Delete User    (F) First User   (P) Previous User ║
  216.            ╚═══════════════════════════════════════════════════════╝
  217.                         figure 2 - Registered User List
  218.  
  219. The following is a brief explanation of the choices on this menu:
  220.  
  221. "M" will return you to the main menu.
  222.  
  223. "A" will allow you to add a user to the registered user database.  The
  224. user's name will automatically be capitalized.  Note that you MUST use a
  225. slash (/) as the delimiter between the month, day, and year.
  226.  
  227. "D" will delete the current user from the database.
  228.  
  229. "E" will allow you to edit the current user information.
  230.  
  231. "S" will bring you to a search menu to search for a particular user.
  232. You can search for either a full or partial name.
  233.  
  234. "F" brings you to the first user in the database.
  235.  
  236. "L" brings you to the last user in the database.
  237.  
  238. "N" displays the next user in the database.
  239.  
  240. "P" displays the previous user in the database.
  241.  
  242. ┌─────────────────┐
  243. │ Display Screens │
  244. └─────────────────┘
  245. All the .ANS/.ASC screens which are displayed to your users are FULLY
  246. customizable.  You are encouraged to change the screens so that they
  247. match your bulletin board's look and feel.
  248.  
  249. You can use most of the QuickBBS/Remote Access "metacharacters" in your
  250. screens.  Metacharacters are control sequences that are automatically
  251. translated by the BBS to display information such as user name, password,
  252. time remaining, etc.  (Check your BBS documentation for more details).
  253.  
  254. I have added a new metacharacter for this program.  You can use the
  255. metacharacter  $ (or ^K$) to automatically display the number of days
  256. remaining until the user's registration period expires.  You can see an
  257. example of this on the screen WARNING.A??.
  258.  
  259. If you do not wish to take advantage of the feature which displays a
  260. screen suggesting that the user register with your BBS, then you can delete
  261. the files SUGGEST.A??.  If REGCHECK.EXE does not find these files in the
  262. default directory, it will not display them and will also skip the time
  263. delay and the prompt.  This happens only in the registered version.  In
  264. the unregistered version, the file is not displayed but the delay and
  265. prompt still occur.
  266.  
  267. ┌──────────────┐
  268. │ Installation │
  269. └──────────────┘
  270. The program REGCHECK.EXE MUST be run as soon as every user logs onto
  271. your BBS.  REGCHECK.EXE needs access to both your DORINFO1.DEF and
  272. EXITINFO.BBS files.  See the documentation for your BBS software for
  273. full details on setting up an external door.  You must pass the path to
  274. your DORINFO1.DEF and EXITINFO.BBS files to REGCHECK.EXE on its command
  275. line.  The following examples should make it clear how to set it up on
  276. your system.
  277.  
  278. This setup assumes that you have a separate TOP and MAIN menu.  If your
  279. TOP menu is also your MAIN menu, then REGCHECK will run every time the
  280. user goes to your main menu.  It is a very good idea to have separate
  281. TOP and MAIN menus as in the following diagram:
  282.  
  283.                                 ┌─────┐
  284.                                 │ TOP │
  285.                                 └──┬──┘
  286.                                ┌───┴───┐
  287.                                │ MAIN  │
  288.                                └───┬───┘
  289.                   ┌────────────────┼──────────────────┐
  290.               ┌───┴───┐        ┌───┴───┐        ┌─────┴────┐
  291.               │ FILES │        │ DOORS │        │ MESSAGES │
  292.               └───────┘        └───────┘        └──────────┘
  293.  
  294. This arrangement allows for more flexibility in your BBS.
  295.  
  296. If your TOP menu also serves as your MAIN menu, then you will have to
  297. come up some type of flag scheme to compensate for it.  For example,
  298. require that a certain user flag be ON in order to run REGCHECK.  Then,
  299. after REGCHECK runs, use a utility to turn that flag OFF.  Then, as part
  300. of your bulletin board's logoff routine, turn that flag back on so that
  301. REGCHECK will run next time the user is online.
  302.  
  303. ┌───────────────────┐
  304. │ Single Node Setup │
  305. └───────────────────┘
  306. For a single node BBS, you can use the following TOP.MNU type 7 menu entry as
  307. an example:
  308.  
  309.                   *c /c *M c:\doors\regcheck\check.bat
  310.  
  311. The appropriate batch file for this would be called CHECK.BAT and would
  312. look like:
  313.  
  314.                            @echo off
  315.                            cd\doors\regcheck
  316.                            regcheck c:\qbbs
  317.                            cd\qbbs
  318.  
  319. ┌──────────────────┐
  320. │ Multi-Node Setup │
  321. └──────────────────┘
  322. For a multiple node set up, you can use the following TOP.MNU type 7 menu entry
  323. as an example:
  324.  
  325.                   *c /c *M c:\doors\regcheck\check.bat *N
  326.  
  327. The appropriate batch file for this would be called CHECK.BAT and would
  328. look like:
  329.  
  330.                                @echo off
  331.                                cd\doors\regcheck
  332.                                regcheck \qbbs\node%1
  333.                                cd\qbbs\node%1
  334.  
  335. When running in a multitasking environment, MAKE SURE that SHARE.EXE has
  336. been loaded!
  337.  
  338. ┌──────────────┐
  339. │ Registration │
  340. └──────────────┘
  341. These programs are NOT freeware!  If you use them on your BBS for more
  342. than four weeks, you are required to register them.  Run the program
  343. REGISTER.EXE if you decide to register.  When you register, your BBS
  344. name will appear in place of the bright yellow [UNREGISTERED] displayed
  345. in the door.  This will show your callers that YOU support shareware!
  346. You can't expect your users to support you if you don't support the
  347. doors that you use.
  348.  
  349. Registration is $20.00 US.  The program may pay for itself by
  350. encouraging your users to register with your BBS!
  351.  
  352. ┌───────────┐
  353. │ Copyright │
  354. └───────────┘
  355. REGCHECK.EXE and CONFIG.EXE, Copyright 1993 by Ron Bergeron, are being
  356. distributed as Shareware.  Under this concept you may use the SHAREWARE
  357. (unregistered) versions for a reasonable period of time (4 weeks) for
  358. evaluation after which you must either register your copies or remove
  359. them from use on your BBS.
  360.  
  361. ┌──────────┐
  362. │ Warranty │
  363. └──────────┘
  364. Care has been taken in the development of this program.  However, I
  365. cannot guarantee its operation on your particular setup.
  366.  
  367. This product is provided AS IS without warranty of any kind.  The entire
  368. risk as to the results and performance of the programs is assumed by
  369. you.  Furthermore, the author does not warrant, guarantee, or make any
  370. other representations regarding the use of, or the results of the use of
  371. the program, and you rely on the program and results solely at your own
  372. risk.  The author cannot and will not accept responsibility for system
  373. damage, loss of profit or any other special, consequential or incidental
  374. damages resulting from the use of or inability to use this product.
  375.  
  376. If this policy is not acceptable to you, DO NOT run the program.
  377.  
  378. ┌───────────┐
  379. │ Questions │
  380. └───────────┘
  381. I can be reached for questions or comments on my BBS.
  382.  
  383.                               The Machine
  384.                              (508)948-2921
  385.                            FidoNet 1:324/124
  386.  
  387.