File Information (FINFO) v1.2 FINFO/FI Documentation Copyright 1992 Ernie Johnson All Rights Reserved What is FINFO and FI? ------------------------------------------------------------------ FINFO/FI are a pair of programs that work hand-in-hand to allow BBS users access to information on files uploaded and downloaded on your BBS. Using the FI door, users can look up information on a file to find out who uploaded it and when, how many times it has been downloaded, and the last time it has been uploaded. There are many benfits, but one obvious benefit is for programmers and other publishers to see how "popular" his or her uploaded file(s) are/is. What makes FINFO/FI different from the others? ------------------------------------------------------------------ Most sysops are aware of the other two or three programs that basically do the same thing as FINFO/FI. However, the FI program gives users *INSTANT* access to the file upload/download information. Users will no longer have to wait several minutes for other file information programs to search the download.txt file for the information. With FI, all information is stored in a database file and is instantly available. A second benefit, is to you, the sysop - using FI, you can cut down on wasted hard disk space by the DOWNLOAD.TXT file. After processing, FINFO can (optional) delete your DOWNLOAD.TXT file - since almost all information on the file is stored in a database, most sysops can safely remove the DOWNLOAD.TXT file instead of having it waste hard disk space (note that downloader names are not saved!). Limited Warranty and Software License Agreement ------------------------------------------------------------------ The FINFO.EXE & FI.EXE programs are no way guaranteed to work as advertised, although careful testing and design has been used on this program. IN NO EVENT WILL THE AUTHOR OF THIS PROGRAM BE LIABLE TO YOU FOR ANY DAMAGES (INCLUDING LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES) OR FOR ANY CLAIM BY ANY OTHER PARTY. This program is provided to you for use provided that you agree to and abide by the terms listed in this licensing agreement. You assume responsibility for selection of this program for your purposes, and for the installation, use and results from use of this program. This program is licensed to you for use as follows: 1. All copies of this program must include the copyright notice. 2. You may not reverse engineer, decompile, or dissemble the software. You may not modify the software in any way. 3. All files originally in this archive must be redistributed. For ZIP archives, the original archive should be used due to the fact it contains an "authenticity verification" code. Shareware Software & FINFO/FI ------------------------------------------------------------------ The FINFO/FI programs are currently being released as $0 Shareware. You are encouraged to try the FINFO/FI programs, and if you enjoy using them, and they suit your needs, simply call my BBS and leave me a message, or write me a letter with your BBS name and number in it and say you use FINFO. Comments, suggestions, and bug reports are welcome. Depending on options added, or time spent improving the program, FINFO/FI may end up with a registration fee for future versions - if you submit ideas not already "on the drawing board", you will receive a free registration to the next version of FINFO/FI if it requires a registration fee. If you are interested in receiving all future versions of FINFO mailed to you, please send a cheque or money order for $10.00 made payable to Ernie Johnson to P.O. Box 607, Wingham, Ontario, N0G 2W0, Canada. This is to cover mailing expenses only, you can also get the lastest version of FINFO from our support BBS free of charge, by calling 519-357-1943 or 519-357-2952 (the latter number supporting high speed modems). Please note this is completely voluntary - no registration fee is required for you to use FINFO/FI, but please let me know if you use the program! Feel free to print out the COMMENTS.FRM and upload it to our BBS, or mail it to the above address. System Requirements & multi-node support ------------------------------------------------------------------ FINFO should work on just about any hardware/software configuation found today. It has been tested on a variety of 286 and 386 computers running PCBoard 14.5a. FINFO/FI are somewhat multi-node aware. The FI door program can be in use on any number of nodes at the same time and no sharing errors will occur. The FINFO program should only run the EVENT process when all nodes are down - or when there is no danger of the DOWNLOAD.TXT file being added to by the BBS. If FINFO's EVENT is running and PCBoard tries to access the DOWNLOAD.TXT file, the BBS will stop until FINFO is finished. A file sharing error is almost sure to happen if the FI door is running and listing files while the FINFO EVENT is running, so under no circumstances should you allow the FINFO EVENT and FI door to be running at the same time. Required Files ------------------------------------------------------------------ Most files in the distribution archive are required for FINFO/FI to function. Here is an outline of the files included, their purpose, and if they are required or not. If any of these files are missing from the distribution archive, you should call our support BBS and download an archive that has not been tampered with. Distributed in archive: ---------------------- README - important info all users should read - Optional FI - sample PCBoard batch file for FI - Optional FI.EXE - FI BBS door - Required FINFO.EXE - FINFO configuration & event program - Required FINFO.DOC - FINFO/FI documentation (this file) - Optional FINFO.CFG - FINFO/FI sample configuration file - Optional COMMENTS.FRM - Comments and suggestion form - Optional FILE_ID.DIZ - Program upload description file - Optional Created at run-time: ------------------- FINFO.DB - FInfo database file - Required FINFO.PX - FInfo database index file - Required Setting up your configuration ------------------------------------------------------------------ The FINFO and FI programs both read the same configuration file so you may only need to create one configuration file. Multi-node systems may have to create several configuration files depending on the setup of your nodes. To create the configuration file, you may use a text editor, or use FINFO's built in configuration editor. To access the editor, simply type: FINFO CONFIG FINFO.CFG An entry form will pop up on screen, and you can enter the required information. When you are finished with the first line, press to edit the next line. Once you reach the last line, press and you will be asked if the entered information is correct. If so, the configuration file will be saved and you will return to DOS. You may specify any configuration filename on the command line for FINFO to edit - if the configuration file does not exist, defaults will be used and the file you specified will be created. The format of the FINFO.CFG is as follows: J:\PCB\MAIN\DOWNLOAD.TXT ; line 1 J:\DOORS\FINFO\FINFO ; line 2 C:\PCB\PCBOARD.SYS ; line 3 ; line 4 N ; line 5 DO NOT ENTER the semi colons or the 'line' indicator. They are for explanation purposes only. First, line 1 is the full drive, path and filename of your DOWNLOAD.TXT file. On my support BBS, it is on the J: drive, in the \PCB\MAIN\ directory and called DOWNLOAD.TXT Line 2 is the full drive, path and name (no extension) of the database file. If you specify a file extension it will be ignored and the database default of .DB will be used. This should be kept "common" to all of your BBS nodes so the same information on the files is the same on each node of your BBS. Line 3 is the full drive, path and filename of the PCBOARD.SYS file. For multi-node systems, you may have to create several configuration files with different information here. Line 4 is the information for non-standard com ports and interrupts. The correct format for using non-standard ports and interrupts is: PORT:AAAA:X Where AAAA is the port address, and X is the interrupt of where your modem is located. For example: PORT:03E8:5 This uses the modem at port address 03E8 (hex) and on interrupt 5. Line 5 is a Y or N character and signals the deletion of your DOWNLOAD.TXT file after FINFO is finished processing it. Most sysops may want to delete the DOWNLOAD.TXT file unless the names of everyone who downloads files is important. FINFO keeps track of uploader name, upload date, date last downloaded, time last downloaded and number of times downloaded. Again, for most sysops, this information is more than adequate and if you delete your DOWNLOAD.TXT file, you will likely save a bit of disk space - most noticeable if there are a lot of downloads on the same file. Running FINFO in your EVENT.SYS ------------------------------------------------------------------ To keep the database up-to-date, it is recommended that you run FINFO's event process in your daily EVENT.SYS file. Add an entry to your EVENT.SYS file similar to: J: CD\PCB\DOORS FINFO EVENT FINFO.CFG C: CD\PCB Of course, drive and path information may be different, but the main thing is to run the FINFO EVENT FINFO.CFG combination. Specify the configuration filename if different. If you run a muli-node system and you have different configuration files, you do NOT need to run this for each configuration file, unless your DOWNLOAD.TXT file is in different locations for different nodes. As FINFO processes, some messages may be displayed. Here is a list of common messages and what they mean. Processing will not stop when a message is on screen - there is a short pause, and processing continues. Database Error: Key Violation - this occurs when FINFO finds an upload of a file that is already in the database. The first occurence of the uploaded file will remain in the database and no harm is done. Database Error: Record not found - if a file is downloaded, but is not yet in the database, this message may appear. Again, it is harmless Database Error: Invalid date - if you get this message, check your download.txt file for corruption, or upload it to our support BBS for us to have a look over - its possible that an entry has been made to the download.txt file that has not been thought of (ie; in version 1.0 a comma in the users name). Setting up FI as a door ------------------------------------------------------------------ If you have had previous experience setting up door programs on your PCBoard BBS, FI should be no more difficult than the others you have set up. Here is an example batch file as used on EPIC BBS (our support BBS). Most information should work as displayed with the exception of drive and path names. J: CD\DOORS\FINFO FI FINFO.CFG C: CD\PCB To break down the above: Line 1: Change to drive where FI is located on Line 2: Change to directory where FI is located in. In this case, in the \DOORS\FINFO directory Line 3: Run FI and tell FI to read the FINFO.CFG config file Line 4: Change back to the BBS drive Line 5: Change back to the BBS directory Note, that FI (in my case) is run as a "shell" so I don't reload the BBS software. If you are using PCBoard 14.5a and FI doesn't run as a shell (ie; out of memory) you will need to reload the PCBoard software with the BOARD command. You will most likely need to change drive and path names around. A sample batch file named FI. has been provided in the archive for easy modification. Once you have completed the batch file, run PCBSETUP and edit the DOORS.LST file for your system. Add an entry that looks similar to below: Filename Password Sec Login USERS.SYS DOOR.SYS Path to Batch -------- -------- --- ----- --------- -------- ----------------- 1) FI 0 N N N C:\PCB\DOORS\ Note this is a sample as seen in the regular PCBoard 14.5 program. PCBoard 14.5a has a field that allows you to "shell" to the door instead of exiting PCBoard and reloading PCBoard when the door is finished - you will likely want to have this turned on to make the FI program seem to be an integrated part of PCBoard. You will also want to modify your door menu files (most likely named DOORS and/or DOORSG) to add the FI entry to it so your users know which door to open. Next, you should load PCBoard, and log in locally and run the door to verify that it is reading the correct configuration file and doing what it is supposed to do. If you are running FI as a "shelled" door, you may want to make the "FI" command a new menu option for your users. Users can access the FI door by typing "FI" and pressing or by typing "FI " where is the name of the file they wish to obtain download information on. Other BBS types supported ------------------------------------------------------------------ Sorry, but due to the fact the FINFO program reads from the DOWNLOAD.TXT file created by PCBoard, the FI program won't be much good for other BBS types. However, if you can provide me with a file that your BBS software creates to keep track of file uploads and downloads, I will consider making a version of FINFO for your BBS software. Sysop Keys ------------------------------------------------------------------ The USRBIOG door has a variety of features available to the sysop while a user is online and using the door. The commands that are available to the sysop include: F5 Shell to DOS - be sure to type "EXIT" to return to USRBIOG F8 Return user to system - the user will be given a message stating the sysop requested a return to the BBS F9 Toggle display on/off F10 Chat mode (use the ESCAPE key to exit) F3 Toggle printer on/off F4 Toggle pagebell on/off F7 Toggle caller alarm on/off ALT-H Toggle between different status lines, the help screen, and COM port status ALT-N Toggle sysop on next ALT-X Toggle exit to dos after call Product Support ------------------------------------------------------------------ To obtain support for the FINFO/FI file information program: Write to: Phone (voice): Phone (bbs): -------------------------------------------------------------- Ernie Johnson (519) 357-1941 (519) 357-1943 2400 v.42 P.O. Box 607 7pm to 10pm EST (519) 357-2952 38.4 HST D/S Wingham, Ontario (evenings) 24 hours, 7 days/week N0G 2W0 -- Canada Or: --- On CompuServe, leave a message to Ernest W Johnson [70751,2567] On City2City netmail services, leave a message to Ernie Johnson in the Shareware conference. Note that leaving a message on our support BBS is the fastest way to obtain support. I check the BBS every day, and phone messages sometimes don't get checked for a week at a time. Known bugs ------------------------------------------------------------------ The only known problem occurs when on a multi node BBS, and two files with the same name are downloaded at exactly the same time. The FINFO event processor will miss all but one entry - so, if you have a large BBS, and 5 nodes all downloading the same file at the same time, the FI program will register only 1 download. Due to the extremely slim chance this can occur, it is not likely to be a major problem for most sysops. The Future of FINFO/FI ------------------------------------------------------------------ Already on the list of things to add in future versions of the FINFO/FI program are: 1) "Zippy" scans in the FI program 2) Security level monitoring 3) Uploader and Downloader name exclusion lists 4) FINFO "browse" and "edit" mode (editor for sysops only) 5) Top-10 (or whatever) download bulletin creator based on information in the FINFO database file 6) Any other great ideas from users of FINFO/FI! End of File Information (FINFO) Documentation ------------------------------------------------------------------