home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / callid1b / callid.doc < prev    next >
Text File  |  1993-08-15  |  7KB  |  171 lines

  1.                                 Call-ID
  2.                     (c) Copyright 1993, Steve Barnes
  3.  
  4.                 Supplied courtesy of the Logic Church BBS
  5.  
  6.                               Steve Barnes
  7.                           1166 Lorraine Street.
  8.                         Sudbury, Ontario, Canada
  9.                                 P3A-2V4
  10.                  (Voice) 705-560-3115, (BBS) 705-525-1307
  11.  
  12.  
  13. Introduction:
  14.  
  15.   G'day. Call-ID is a little utility I whipped up in C that is for
  16.   use with QBBS/ST and BinkleyTerm. It simply compares a users phone
  17.   number returned by Call-Display, and their phone numbers in their
  18.   user record. Depending on the result, the program will return
  19.   different errorlevels that you may do with what you wish. I use a
  20.   little script to provide auto-validation of new users and to weed
  21.   out lugens.
  22.  
  23.       'LUGEN' - (Loo`gan): Noun. A human entity with a propensity for
  24.       probing ones nasal passage with an extended index finger. These
  25.       beings, despite only having 7 functioning fingers, somehow
  26.       manage to learn to use a computer. Causing many sysops to
  27.       develop a dysfunction known as Lugenation. Which is symptomized
  28.       by a rapid, uncontrolable ticks about the eyes, having a
  29.       metallic taste in ones mouth, and last, but certainly not least,
  30.       hearing bag-pipes.
  31.  
  32.   I hope you'll find Call-ID useful. I know I have as its completely
  33.   eliminated lugens, and freeing me from the drudgery of
  34.   voice-validiting new users. My system runs itself thanks! Prior to
  35.   writing Call-ID, I wrote NOTARY, which is a successful shareware
  36.   call-back verifier for Forem/Turbo BBS's. So successful was NOTARY
  37.   that I become known across North America as 'The guy who wrote
  38.   NOTARY'. I had intended to duplicate NOTARY for QBBS, however our
  39.   local phone company graciously offered to hook up Call-Display
  40.   free! (Plus a $4.75 surcharge payable monthly).
  41.  
  42.   In this document I'll attempt to describe Call-ID's functioning, as
  43.   well as its setup. I'll conclude at the end as is the accepted norm.
  44.  
  45. FUNCTION:
  46.  
  47.   Call-ID reads its configuration file which contains 2 keywords
  48.   followed by their parameters. This is a plain jane ASCII text file.
  49.  
  50.   Call-ID then reads you BINKLEY.LOG file (or, any log file for that
  51.   matter, it doesn't matter a bit if it came from BINKLEY or not)
  52.   remembering the LAST entry in the list.
  53.  
  54.   It then reads from your USERS.BBS file the record for the user
  55.   currently online and compares the number returned by your phone
  56.   companies Caller-ID service (as reported by your log file) against
  57.   both of the users phone numbers in their user record.
  58.  
  59.   If either one of the numbers match, Call-ID returns 0 as an
  60.   errorlevel.
  61.  
  62.   If it doesn't match either, it returns 1.
  63.  
  64.   If the number was blocked, it returns 2.
  65.  
  66.   If the number was from another phone company it returns 3.
  67.  
  68.   Any error conditions are reported as a standard TOS error condition.
  69.   (A negative number).
  70.  
  71.   Finally, Call-ID will output its findings to the log specified in
  72.   the configuration file.
  73.  
  74.   As you can see, Call-ID in itself doesn't do a heck of a lot. But
  75.   it does provide you with the information you need to have QBBS/ST
  76.   decide what to do with the result. This is accomplished with a
  77.   standard .DOR file. I've included the one I use, no doubt you'll
  78.   wish to change a few things, but it really is easy to understand.
  79.  
  80. INSTALLATION:
  81.  
  82.   First things first. You must edit the supplied CALLID.CFG file to
  83.   reflect the way your system is laid out. It contains just 3
  84.   keywords, which I'll describe as follows:
  85.  
  86.     BinkLog           Path\Filename
  87.  
  88.       Specifies where Call-ID should look for your BinkleyTerm/ST log.
  89.  
  90.     LogName           Path\Filename
  91.  
  92.       Specifies where Call-ID should write its output log.
  93.  
  94.   Now that we've edited the CALLID.CFG, we need to copy it, the
  95.   CALLID.TTP program and the CALLID.DOR itself over into your BBS root
  96.   directory. (Where your QUICKBBS.PRG lives).
  97.  
  98.   Now, the trick is, how to get CALLID.TTP to run for every caller.
  99.   This is most easily accomplished by creating a phony TOP.MNU that
  100.   contains exactly two entries. The first runs CALLID.DOR (which in
  101.   turn runs CALLID.TTP) and the second simply runs your real TOP1.MNU
  102.   which is YOUR TOP.MNU renamed to TOP1.MNU. Both of these options
  103.   are autoexec types. The user doesn't have to do a thing.
  104.  
  105.   Do it now, rename your existing TOP.MNU too TOP1.MNU and copy the
  106.   supplied TOP.MNU over to your .MNU folder.
  107.  
  108.   Simple really. Though you really will want to edit the CALLID.DOR
  109.   file to reflect what you wish to happen to the user. See the QBBS/ST
  110.   docs for more info on this. Basically, if everything is fine.
  111.   Nothing happens.
  112.  
  113.   Call-ID takes a parameter on the command line, this you can see,
  114.   is already done for you in the CALLID.DOR, but for the sake of
  115.   completeness the parameter is:
  116.  
  117.   *R [users record number]
  118.  
  119.   Thats about it. Now for the previously mentioned conclusion.
  120.  
  121. CONCLUSION:
  122.  
  123.   I hope you find Call-ID as useful as I have. It really does the
  124.   trick. If you find any bugs, please, don't hesitate to let me know.
  125.  
  126.   Call-ID is being distributed as true shareware. As I mentioned
  127.   earlier, NOTARY was very successful (Over 80 registrations) for two
  128.   reasons. Number 1, its the BEST CALL BACK VERIFIER AVAILABLE FOR
  129.   ANY PLATFORM <ahem>. Really, it slices, it dices.. Number 2; it was
  130.   'Crippleware'. You needed a special key to get to the really juicy
  131.   bits. Since this program isn't anywhere near as complex as NOTARY
  132.   is, this one is true shareware. Send me $10 or whatever you feel
  133.   its worth to you if you use it. 
  134.  
  135.   Your are granted unlimited permission to distribute Call-ID
  136.   provided it is distributed unaltered and intact. No fees may be
  137.   charged for distribution beyond media costs.
  138.  
  139.   The author makes no claims whatsoever regarding performance,
  140.   fitness for purpose and is no way liable for financial losses, real
  141.   or percieved through the use of Call-ID. Your use of Call-ID is
  142.   done entirely at your own risk.
  143.  
  144.   One last thing before I unleash Call-ID on an unsuspecting user
  145.   base. Try to keep your BINKLEY.LOG to a reasonable size, say 10K.
  146.   Obviously, its going to take some time to parse a 100K log file.
  147.   You can tell BinkleyTerm to limit the size of the file by following
  148.   the StatusLog keyword in BINKLEY.CFG with a maximum size. I.E:
  149.  
  150.     StatusLog BINKLEY\BINKLEY.LOG 10
  151.  
  152.   This will dramatically speed up the running of Call-ID.
  153.  
  154. ADDENDUM:
  155.  
  156.   I suppose I should mention here that the format of Call-Display for
  157.   your modem should return the info in human readable form. This
  158.   program was written using the Bell Call-Display service and a Supra
  159.   14.4 Fax modem. It returns the strings in my Binkley log as follows:
  160.  
  161.   # 14 Aug 10:58:20 BINK Date = 0814
  162.   # 14 Aug 10:58:22 BINK Time = 1102
  163.   # 14 Aug 10:58:22 BINK Mesg = 030735323436383537
  164.  
  165.   You'll notice that the number is itself is ASCII based hex numbers.
  166.   prefixed with what I believe to be some field info. If you look at
  167.   the source you will notice that the only string that Call-ID looks
  168.   for is 'Date'. I've written it this way as I believe some modems
  169.   return different prefix strings. If yours is different, please let
  170.   me know!
  171.