home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WILDCAT / DDMESS21.ZIP / DDMESS2.DOC next >
Text File  |  1994-02-12  |  16KB  |  365 lines

  1. DDMESS2 version 1.11 Message Activity Bulletin Generator
  2. --------------------------------------------------------
  3.  
  4. Copyright (C) 1994 by Dirk Daff. All rights reserved.
  5. -----------------------------------------------------
  6.  
  7. Disclaimer
  8. ----------
  9. This product is provided "as is" without warranty of any kind. All risks
  10. are assumed by the user. Should this product prove defective in any way
  11. any and all costs are assumed by the user including but not limited to
  12. repair of hardware or data or any other required corrective action.
  13.  
  14. Dirk Daff, being the author of this product, will not accept
  15. responsibility or liability for system damage loss of profit or any
  16. other special incidental or consequential damages resulting from the use
  17. or inability to use this product.
  18.  
  19. Freeware Licence
  20. -----------------
  21. Please note that Freeware is NOT the same as Public Domain. This
  22. producted is NOT donated to the Public Domain and the author retains all
  23. Copyright.
  24.  
  25. The Freeware version of DDMESS2 (version numbers 1.01 and 1.11 ONLY) can
  26. be used free of charge for as long as you like provided that your
  27. bulletin board service is not a commercial one. The original version
  28. (1.01) was released as Shareware but having started my own board I've
  29. realised that hobby board operators spend enough money on electricity
  30. and telephone bills without burdening them further. The original version
  31. is now also Freeware.
  32.  
  33. Limited Commercial Licence
  34. --------------------------
  35. If you do operate a COMMERCIAL board, you are hereby granted a Limited
  36. Licence to use this product (this also applies to version 1.01) for a
  37. period not exceeding thirty days for evaluation purposes only. After that
  38. time you must either stop using it or obtain a registered version from the
  39. author.
  40.  
  41. Due to the nature of this product it can only be evaluated properly on a
  42. live Bulletin Board System (BBS). You are therefore granted a Limited Licence
  43. to install this product on your BBS for the aforementioned time period.
  44.  
  45. For the purposes of the Limited Licence, a commercial board is one which
  46. meets one or more of the following criteria :
  47.  
  48.         a) fees are charged for online time
  49.         b) one or more of the phone lines are premium rate numbers
  50.         c) fees are charged for advertising space
  51.         d) fees are charged for downloading files or messages
  52.         e) donations or subscriptions by users are used for profit
  53.            rather than exclusively for offsetting the running expenses
  54.            of the board
  55.         f) subscription or donation is required before users have access
  56.            to the local message facilities on the board
  57.         g) subscription or donation is required before users have access
  58.            to the file base
  59.  
  60. Commercial Registration
  61. -----------------------
  62. A registered version can be obtained from the author Dirk Daff in the
  63. following ways:
  64.  
  65.         1. Send the completed order form (see DDMESS2.ORD)
  66.            and the appropriate amount in UK Sterling to :
  67.  
  68.                 Dirk Daff
  69.                 32 Spencer Road
  70.                 Wealdstone
  71.                 Harrow
  72.                 Middx. HA3 7AP
  73.                 UK
  74.  
  75.            You will be sent a copy of the registered and personalised
  76.            version of DDMESS2.
  77.  
  78.         2. Call the Loose Cannon BBS on 081-863-7521 (8/N/1) and leave me a
  79.            message. We'll sort something out...<grin>
  80.  
  81.         3. Alternatively, E-Mail me on the Internet using
  82.            dirkdaff@loosecan.demon.co.uk
  83.  
  84. The registered version will have FREEWARE in the header removed and
  85. replaced by REGISTERED to show how you support the shareware concept.
  86.  
  87. Your version will have a personalised message of your own choice
  88. displayed instead of the advert for my BBS (2 lines of 50 characters).
  89.  
  90. Your name will be highlighted on the message activity bulletins instead
  91. of mine when you upload messages.
  92.  
  93. You will get technical support via the Loose Cannon BBS.
  94.  
  95. Prices
  96. ------
  97. Single User licence..................................... £  5.00
  98. 10 User licence..........................................£ 40.00
  99. Postage/packing (UK/Europe)..............................£  2.00
  100.                 (International)..........................£  4.00
  101.  
  102. VAT is charged at the prevailing rate for UK orders.
  103.  
  104. If you require a licence for more than 10 users order the required number 
  105. of 10-user licences. A user is defined as a single Bulletin Board operated 
  106. by an individual or organisation. This means you need only a Single User 
  107. licence whether you have only 1 node or 250 nodes as long as all nodes are 
  108. operated as one Bulletin Board. If for example nodes 1 to 50 are BBS no.1 
  109. and nodes 51 to 100 are BBS no.2 you need 2 user licences so you need to 
  110. order 2 Single User licences.
  111.  
  112. Postage and packing includes the registered version on disk and sending
  113. by ordinary first class post. If you don't want to use snail-mail you
  114. can pick up your registered copy from the BBS instead and thereby avoid
  115. the postage and packing charges. You know it makes sense.
  116.  
  117. Trademarks
  118. ----------
  119. Any trademarks mentioned belong to their respective owners. Fair enough ?
  120.  
  121. OK, that's all the legal and money stuff over and done with.
  122.  
  123. DDMESS2 files
  124. -------------
  125. You should find the following files in the archive:
  126.  
  127.         DDMESS2.EXE     - bulletin generator.
  128.         DDMESS2.INI     - sample configuration file
  129.         DDMESS2.DOC     - this documentation file
  130.         DDMESS2.ORD     - order form for the registered version
  131.         EXAMPLE.LOG     - sample Wildcat TD 2.6 log file
  132.         EXAMPLE.BBS     - sample plain text bulletin
  133.         EXAMPLE.SCR     - sample ANSI bulletin
  134.  
  135. DDMESS2 creates the following files in the current path when run :
  136.  
  137.         DDMESS2.ERR     - error report
  138.         DDMESS2.BBS     - plain text bulletin
  139.         DDMESS2.SCR     - ANSI bulletin
  140.         DDMESS2.DAT     - message activity history
  141.  
  142. The following files must be in the current path when running DDMESS2 :
  143.  
  144.         DDMESS2.INI
  145.         ACTIVITY.LOG
  146.  
  147. What do I need to run DDMESS2 ?
  148. -------------------------------
  149.  
  150. You need the following :
  151.  
  152.         An IBM-compatible PC
  153.         WildCat 2.6 TestDrive
  154.         Tomcat 2.9F (optional)
  155.         MSDOS 3.3 or higher
  156.  
  157. I don't see any reason why you can't use DDMESS2 with earlier WildCat
  158. versions as long as the activity log records are written in the same way
  159. as in 2.6TD. I will be writing a WildCat 3.xx version sooner or later.
  160.  
  161. How to use DDMESS2
  162. ------------------
  163. If you want to test this product offline before you let it loose on your
  164. precious live files, simply create a test directory with DDMESS2.EXE and
  165. DDMESS2.INI in it, then copy your live ACTIVITY.LOG into the test
  166. directory. DDMESS2 will run quite happily without the rest of WildCat.
  167.  
  168. For live installation, copy DDMESS2.EXE and DDMESS2.INI to your node home
  169. directory or wherever your WildCat ACTIVITY.LOG file resides.
  170.  
  171. Personalise the DDMESS2.INI file using a plain text editor like Norton
  172. Commander or QEdit (or even Edlin if you're a complete masochist) with
  173. the following information:
  174.  
  175. Line 1 - text to be displayed on the top line of the bulletin up to a
  176.          maximum of 70 characters. A carriage return here will mean a blank
  177.          first line on the bulletin.
  178.  
  179. Line 2 - ditto line 1 except the text is of course displayed on the 2nd
  180.          line of the bulletin.
  181.  
  182. Line 3 - include local logons in the bulletin. Enter "Y" or "N" here, in
  183.          upper-case and without the quotes.
  184.  
  185. Line 4 - exclude this security level and higher from the bulletin. Enter
  186.          a 4 digit security level number here with leading zeroes. E.g
  187.          "0099" will exclude all callers with a security level of 99 or
  188.          higher.
  189.  
  190. Line 5 - number of names to include in the list. Enter a 4 digit number
  191.          here with leading zeroes. E.g. "0000" will only show 1 name,
  192.          "0099" will show up to 100. The maximum number of names that
  193.          will be shown is 100 in each list.
  194.  
  195. Run DDMESS2 from the command line or a batch file. There are no pesky
  196. command line switches or parameters to specify. DDMESS2 identifies
  197. itself and displays a few dots to let you know it's still running and
  198. hasn't crashed <gasp>. It scans the activity log for logons since the last
  199. time DDMESS2 was run, adds any new message activity into its history
  200. file reporting any updates to the screen and then generates the bulletin
  201. files DDMESS2.BBS and DDMESS2.SCR. I suggest you add the history file
  202. (DDMESS2.DAT) to your backup routine.
  203.  
  204. Now you're asking yourself : all well and good, but how do I get it to
  205. put the bulletins in the right directory with the proper names..?
  206.  
  207. Easy : you use the DOS COPY command. I'm afraid I just couldn't be
  208. bothered to work out the CONFIGWC structure just to get the bulletin
  209. directory path and use command line parameters for the bulletin file
  210. name when a batch file command does it for you anyway. Also it means you
  211. can copy the bulletin files anywhere you like, such as to a HELLO
  212. bulletin file and to multiple filenames if you want the bulletin to
  213. appear in more than one place on your board.
  214.  
  215. Example batch file :
  216.         DDMESS2
  217.         COPY DDMESS2.BBS BULL\BULL10.BBS
  218.         COPY DDMESS2.SCR BULL\BULL10.SCR
  219.  
  220. DDMESS2 extracts the following information from the activity log :
  221.  
  222. User name          : This is the login name for each user on the list up
  223.                      to a maximum of 25 characters.
  224.  
  225. Most messages sent : This is the number of messages uploaded via TomCat
  226.                      and/or entered online for individual users since DDMESS2
  227.                      has been in use. This is cumulative.
  228.  
  229. Most messages in
  230. one session        : This is the number of messages uploaded via TomCat
  231.                      and/or entered online for individual users in a
  232.                      single online session since DDMESS2 has been in
  233.                      use.
  234.  
  235. The user names are then collated into two lists showing the users with
  236. the highest number of messages and the largest packet sizes. Each list
  237. is sorted in order of descending number of messages, showing up to the
  238. maximum number of entries specified in the .INI file or less if there
  239. are not enough users with messages. If you specify 100 user names in
  240. your list and you only have 10 users with messages only those 10 will
  241. appear in the bulletin. You won't get 90 blank lines at the bottom.
  242.  
  243. Errors
  244. ------
  245. DDMESS2 does some checking on files before it runs. Any detected errors
  246. are reported to the screen, written to the error log file DDMESS2.ERR
  247. along with the date and the errorlevel set. DDMESS2 doesn't write to any
  248. WildCat files and the ACTIVITY.LOG is accessed in read-only mode. The
  249. following errors are reported :
  250.  
  251. Error description               Errorlevel  Probable Reason
  252. -----------------               ----------  ---------------
  253. No error reported                   0       Errr... no error....?
  254. Cannot find ACTIVITY.LOG            1       Running in wrong directory
  255. Cannot find DDMESS2.INI             2       Missing parameter file
  256. Error in DDMESS2.INI                3       Missing line in parameter
  257.                                             file
  258. Cannot open DDMESS2.ERR             4       Disk full
  259. Cannot open DDMESS2.BBS             5       Disk Full
  260. Cannot open DDMESS2.SCR             6       Disk full
  261. Cannot open DDMESS2.DAT             7       Disk full
  262.  
  263. Don't worry if you see DDMESS2.ERR with a zero byte file length. DDMESS2
  264. creates this file whether or not there were any errors. Whenever an
  265. error is reported it is appended to the end of the file.
  266.  
  267. History file structure
  268. ----------------------
  269. DDMESS2.DAT is a straight DOS text file and can be modified using a text
  270. editor if necessary. You might want to do this if you want to include
  271. message activity prior to what's contained in your current ACTIVITY.LOG
  272. or if you want to remove a user from the list.
  273.  
  274. The file contains a control record with a timestamp for the last time
  275. DDMESS2 was run followed by one line for each login name.
  276.  
  277. Control record:
  278. YYYYMMDDHHMMSS where YYYY is the century/year, e.g. "1980", MM is the
  279.                month number (01-12), DD is the day of the month (01-31),
  280.                HH is the hour in 24hr format (00-23), MM is the minute
  281.                (00-59) and SS is the second (00-59) of the last run.
  282.  
  283. Login name record:
  284. XXXXXXXXXXXXXXXXXXXXXXXXXMMMMMPPPPP
  285.                where XXXX is the login name (with trailing spaces), MMMMM
  286.                is the total number of messages posted for this login name
  287.                (with leading zeroes), PPPPP is the number of messages in the
  288.                largest packet posted for this login name (with leading zeroes).
  289.  
  290. The message number fields will only hold a maximum value of 65535. Once
  291. a login name has reached this number it won't increase but will stay at
  292. 65535. It's up to you if you wish to reset his total or start the
  293. history file from scratch to give somebody else a chance.
  294.  
  295. To restart the history file from scratch just delete it. DDMESS2 will
  296. then add the users back in as they post messages. Remember that the
  297. first time you run DDMESS2 after deleting the history file it will
  298. include all postings currently recorded in your ACTIVITY.LOG.
  299.  
  300. Additional information
  301. ----------------------
  302. The .BBS bulletin is written in plain text using only low ASCII
  303. to a width of 75 characters. Even XT systems should be able to cope with
  304. this. The only control character is a ^L (ASCII 12) to tell WildCat
  305. to clear the screen before displaying the bulletin. It also prints
  306. properly from DOS so you could even send it to the printer at the end of
  307. the day as a permanent record for yourself.
  308.  
  309. The .SCR bulletin is exactly the same as the .BBS one except of course
  310. use has been made of ANSI codes for colour. It displays properly in DOS,
  311. WildCat local logon, remote logon and after downloading through TomCat.
  312. The bulletin contains a screen clearing code at the start and a colour
  313. reset to default code at the end.
  314.  
  315. Nearly all the 2.xx bulletin makers I've tested create ANSI bulletins which
  316. are not displayed properly by TomCat 2.9F. This seems to be due to a
  317. restriction on the line length that can be used. For this reason and the
  318. fact that no message bulletins display all the information I wanted,
  319. I wrote DDMESS2.
  320.  
  321. Lookout for the following utilities for WildCat 2.6TD :
  322.  
  323. DDCALL21.ZIP - caller online activity summary bulletin maker, shows
  324.                logon and logoff times, user name, call duration, number
  325.                of messages uploaded, number of files uploaded and downloaded,
  326.                number of bulletins read, number of questionnaires
  327.                answered, newsletter read, TomCat used, new caller and
  328.                drop carrier. All of the above on 1 line per caller with a
  329.                total for all callers at the bottom in both .BBS and .SCR
  330.                format.
  331.  
  332. DDFILE21.ZIP - file activity bulletin maker, shows user name, number
  333.                of files uploaded and downloaded to the board so far. Two
  334.                tables are produced showing the most prolific users in the
  335.                above categories sorted in descending order of the number of
  336.                files. The maximum number of names in the tables is configurable
  337.                up to a limit of 100.
  338.  
  339. Compatibility
  340. -------------
  341. DDMESS2 has been tested with the following hardware/software :
  342.  
  343.         Intel 286 processor
  344.         Intel 486 processor
  345.         MSDOS version 3.3
  346.         MSDOS version 5.0
  347.         WildCat! TestDrive version 2.6
  348.         TomCat! version 2.9F
  349.  
  350. Version history
  351. ---------------
  352. 1.11 - 12.02.94 - Maintenance release
  353.  
  354.                   MSDOS 5.0 seems to cause WCTD to write dates to the
  355.                   log in a different format than when running under
  356.                   MSDOS 3.3. Hence checks are now made for the following
  357.                   formats : MM-DD-YY
  358.                             MM/DD/YY
  359.                             MM.DD.YY
  360.  
  361.                   Also tidied up the code a bit to make it run faster.
  362.  
  363. 1.01 - 14.01.94 - Original release
  364.  
  365.