home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / thdpro10.zip / TESTINFO.INC < prev    next >
Text File  |  1994-08-27  |  14KB  |  295 lines
  1.  
  2. {
  3.                      This file format may be used freely by
  4.                    any utility which might have a use for it.
  5.  
  6.               If you program a file processor, you might consider
  7.               utilizing the format to simplify the programming of
  8.               external interface  utilities. (Wouldn't it be nice
  9.               if third party  utils could be used to  interface a
  10.               number of  upload testers, thus  allowing the users
  11.               of different BBS  packages an opportunity to switch
  12.               from one tester to another  without having to worry
  13.               about interfacing problems?)
  14.  
  15. ****************************************************************************
  16. **                                                                        **
  17. **    TESTINFO_REC record types as created by THD ProScan Version 10.0    **
  18. **                                                                        **
  19. **      TESTINFO.DAT is a "file of TESTINFO_REC" which is created by      **
  20. **  THD ProScan Version 10.0 when the user has configured a BBSTYPE       **
  21. **  other than "NONE" in THDINSTL.                                        **
  22. **                                                                        **
  23. ****************************************************************************
  24. }
  25.  
  26. TYPE
  27.  
  28. TESTINFO_FILE_REC = record {individual file information record}
  29.  
  30.    FILE_SFX,
  31.    FILE_EXISTS  : boolean;
  32.    FILE_FULL,
  33.    FILE_PATH    : string[60];
  34.    FILE_DRIVE   : string[2];
  35.    FILE_NAME    : string[8];
  36.    FILE_EXT,
  37.    FILE_TYPE    : string[3];
  38.    FILE_DT,
  39.    FILE_SIZE    : longint;
  40.    end;
  41.  
  42.  
  43.  
  44. TESTINFO_REC = Record {format of TESTINFO.DAT individual records}
  45.  
  46.    Processed,
  47.    VND_present,
  48.    DESC_imp_req,
  49.    ADD_rec,
  50.    F_conv,
  51.    Ansi_detected,
  52.    Avatar_detected,
  53.    CD_detected,
  54.    RES_bool_one,
  55.    RES_bool_two,
  56.    RES_bool_thr,
  57.    RES_bool_fou,
  58.    RES_bool_fiv,
  59.    RES_bool_six,
  60.    RES_bool_sev,
  61.    RES_bool_eig,
  62.    RES_bool_nin      : boolean;
  63.    Check_count,
  64.    BBS_type,
  65.    COM_port,
  66.    EXIT_level,
  67.    TESTINFO_REV,
  68.    RES_byte_one,
  69.    RES_byte_two,
  70.    RES_byte_thr,
  71.    RES_byte_fou,
  72.    RES_byte_fiv,
  73.    RES_byte_six,
  74.    RES_byte_sev,
  75.    RES_byte_eig,
  76.    RES_byte_nin      : byte;
  77.    TEST_DT,
  78.    RES_li_one,
  79.    RES_li_two,
  80.    RES_li_thr,
  81.    RES_li_fou,
  82.    RES_li_fiv,
  83.    RES_li_six,
  84.    RES_li_sev,
  85.    RES_li_eig,
  86.    RES_li_nin,
  87.    RES_li_ten        :longint;
  88.    CMD_options,
  89.    BBS_data_dir,
  90.    Creator,
  91.    Log_path,
  92.    RES_str60_one,
  93.    RES_str60_two,
  94.    RES_str60_thr     : string[60];
  95.    Ver_major,
  96.    Ver_minor         : string[2];
  97.    VAR_ext           : string[3];
  98.    Desc_filename,
  99.    RES_str12_one,
  100.    RES_str12_two,
  101.    RES_str12_thr     : string[12];
  102.    ORIGINAL_F_info,
  103.    FINISHED_F_info   : TESTINFO_FILE_REC;
  104.    RES_int_one,
  105.    RES_int_two,
  106.    RES_int_thr,
  107.    RES_int_fou,
  108.    RES_int_fiv,
  109.    Descr_Length      : integer;
  110.    DIZ_Description   : array[1..1500] of char
  111.    end;
  112.  
  113. {
  114.                      *********************************
  115.                      **  EACH RECORD IS 2380 BYTES  **
  116.                      *********************************
  117.  
  118.     This format is Copyright 1994 PainSoft and is freely usable but may not
  119. be modified. Persons wishing to add or change fields should contact David Muir
  120. at 1:259/423.0 (fidonet) to discuss suggestions for changes.
  121.  
  122.      This file is an "include" file for use with Turbo Pascal. It defines the
  123. 2 "types" used by THDPRO.EXE to create the file "TESTINFO.DAT" which is the
  124. data file used by THDPLUS.EXE to update the various file databases of BBS
  125. types supported to date.
  126.      It includes a great bit of information that could be useful to utility
  127. programmers wishing to program an interface for THD and any number of BBS
  128. programs. Much of the information included here could be easily determined
  129. by programmers. It is included here to simply your efforts (as well as my
  130. own).
  131.      TESTINFO.DAT will only be created (or added to) if THDPRO.EXE is
  132. configured with a BBSTYPE other than "NONE". And only by THD ProScan Version
  133. 10.0 or later (note that this is not supported in the THD 10m beta released
  134. prior to 10.0). TESTINFO.DAT will be created and maintained in the directory
  135. in which THDPRO.EXE and/or THDPLUS.EXE reside(s).
  136.      THDPRO.EXE has it's own numbering of BBS TYPES and reserves values of
  137. 1-254 for itself. A BBSTYPE of "0" indicates no BBS is involved and will not
  138. cause this file to be written and should therefore never be encountered.
  139.      If a user defines his BBS types as "other" in THDINSTL, then the
  140. BBSTYPE value in the record will be 255. THDPLUS will ignore records
  141. containing this BBSTYPE. HOWEVER, THDPRO.EXE will increase the "Check_Count"
  142. variable for these records each time it is read and will delete any record
  143. which has a Check_Count of 51 or higher or which is marked as having been 
  144. processed.
  145.      Note that if a user selects a BBS type that is not "other", THD will
  146. attempt to run it's proprietary THDPLUS program to process this file. It
  147. identifies THDPLUS by a special configuration and will not run any program
  148. which does not identify itself correctly. That identification process is not
  149. being released to the public, so any third party programmers should NOT
  150. expect THDPRO.EXE to run their program no matter what they name it. This is
  151. a security feature and will not be open for negotiation. Third party
  152. programmers should include instructions for running their program via an
  153. event or as part of a batch file after THDPRO.EXE is run.
  154.      They might even consider running THDPRO.EXE in a shell from their
  155. program and processing the TESTINFO.DAT file after control is returned to
  156. their program. If you opt to use this method please watch your memory usage
  157. VERY closely and swap out the memory if possible so THD does not run short
  158. when calling the archivers and virus scanners.
  159.  
  160.      Outline for TESTINFO_FILE_REC as a type used below
  161.  
  162. FILE_SFX    - Is this a self extracting archive?
  163. FILE_EXISTS - did this file exist at the time this record was written
  164. FILE_FULL   - fully qualified file path - drive:\path\name.extension
  165.               "drive:" will always be included even if the user did not
  166.               supply a drive letter in the path to the test file. When this
  167.               occurs, THDPRO.EXE inserts the drive specification of the
  168.               current drive in this path. That drive specification may
  169.               differ from the time THD runs and the time an external utility
  170.               runs. Be sure to check the FILE_DRIVE variable to see that
  171.               this drive was supplied and not assumed (network drive specs
  172.               can change depending on the remote system).
  173.               [if length(FILE_DRIVE)=2 then the drive letter was supplied.]
  174. FILE_DRIVE  - Drive Letter of file path (colon is included if a drive letter
  175.               is defined. In cases where THD is not specifically given a
  176.               drive letter this entry will be empty)
  177. FILE_PATH   - file path (in the format "\WHAT\DIR\" with both beginning and
  178.               trailing backslashes)
  179. FILE_NAME   - file name (name only no "." or extension)
  180. FILE_EXT    - file extension [note that the "." is not included in this
  181.               record]
  182. FILE_TYPE   - file "type" will be one of...
  183.               ARC / ARJ / GIF / HYP / LZH / PAK / RAR /SQZ / TD0 /UC2 / ZIP
  184.               or NON [for un-supported types] (Types reported here may be
  185.               expanded on by third party programmers, but should try to use
  186.               accepted conventions for file types, usually the file
  187.               extension would be suggested.)
  188. FILE_DT     - file date/time [packed format]
  189. FILE_SIZE   - file size in bytes
  190.  
  191.  
  192.      The proposed outline for the extra record to be created by THD ProScan
  193. for the purpose of allowing external manipulation of file data bases or
  194. other uses for data which THD can extract.
  195.  
  196.    labels beginning with "RES_" (as in "reserved") are currently not used
  197. (or explained here) but are present to help ensure the future compatibility
  198. of this file format.
  199.  
  200. Outline for TESTINFO_REC - (as used to create TESTINFO.DAT)
  201.  
  202. Processed        - Has this record been processed? [if true THD will remove
  203.                    this record on it's next run]. Use this to indicate when
  204.                    the file has been completely processed and will no longer
  205.                    be required. Proper use of this field will help
  206.                    THDPRO.EXE to keep the TESTINFO.DAT file compressed to a
  207.                    reasonable size.
  208. VND_present      - is VENDINFO.DIZ present in file?
  209. DESC_imp_req     - is Description importation requested? If set to false,
  210.                    the user has requested that descriptions not be imported
  211.                    into their file database.
  212. ADD_rec          - does the THD user wish to Create a new entry in their
  213.                    file database if one is not currently present?
  214. F_conv           - was file successfully converted [true even if file type
  215.                    was not changed during conversion]
  216. Ansi_detected    - was ANSI detected on remote system at THDPRO.EXE's
  217.                    initialization.
  218. Avatar_detected  - was Avatar 0+ detected on remote system at THDPRO.EXE's
  219.                    initialization.
  220. CD_detected      - was carrier detected at last check on remote system?
  221.                    Carrier is checked before each output line is sent.
  222. Check_count      - Number of times this record has been found but not
  223.                    processed [ THDPRO.EXE will purge any record checked
  224.                    more than 50 times. as well THD will increment this
  225.                    number by one each time it writes a new record ]
  226. BBS_type         - BBSTYPE as defined in THDPRO.EXE
  227. COM_port         - Comport used during test [0 if local]. This variable will
  228.                    be the comport used at the time of initialization of
  229.                    THDPRO.EXE. CD_Detected should be checked to see if it
  230.                    was still active on this comport at the time of writing
  231.                    this record.
  232. EXIT_level       - Dos Error level returned by THDPRO.EXE on this file test.
  233.                    When THDPLUS.EXE resides in the same directory as
  234.                    THDPRO.EXE this will be set to "0". Note that this refers
  235.                    only to a verified PainSoft created version of THDPLUS
  236.                    and not any other utils which may happen to have the
  237.                    same name. Otherwise it will contain the Errorlevel
  238.                    expected to be returned on completing (barring any run-
  239.                    time errors)
  240. TESTINFO_REV     - The revision number of the TESTINFO file. Currently
  241.                    there is only revision "1" (This revision).
  242. TEST_DT          - date/time [ at time of writing this record ]
  243. CMD_options      - Command line options supplied to THDPRO.EXE. [The first
  244.                    and last character will always be " " [space]].
  245. Log_path         - This is the full path and filename used as THD ProScan's
  246.                    temporary log file. This information will be of no use
  247.                    to third party programmers as this log file will be
  248.                    closed and erased before any third party utilities are
  249.                    invoked. It is included for use by THDPLUS.EXE.
  250. Creator          - The name of the Program that created this record.
  251.                    Under all normal circumstances this will be
  252.                    "THD ProScan". Although if other programmers choose to
  253.                    create a record of this type, they should insert their
  254.                    own identification in this area. This is the ONLY place
  255.                    where a string variable will contain lower case.
  256. BBS_data_dir     - Path to BBS data directory [usually main BBS directory]
  257. Ver_major        - Creator's version number (major) [ie. "10"]
  258. Ver_minor        - Creator's version number (minor) [ie. "m" or ".0"]
  259. VAR_ext          - Variable extension number used for this test. (the three
  260.                    number extension used on temp directories and files
  261.                    during this test)
  262. Desc_filename    - Name of the file from which the description included
  263.                    was extracted. [blank if none] This is included if for
  264.                    some reason the third party programmer wishes to
  265.                    re-extract the file from which the description was taken.
  266.                    This file name will always be contained in the main
  267.                    archive, and thus could be extracted from the resulting
  268.                    archive if need be. This may be help for instance where a
  269.                    description is the full 1500 characters and not taken
  270.                    from a VENDINFO.DIZ. The programmer could re-extract the
  271.                    description file and use it in it's entirety (if they
  272.                    wished).
  273. ORIGINAL_F_info  - Original file information [as stored in the type
  274.                    TESTINFO_FILE_REC]. Information on the file prior to
  275.                    THDPRO.EXE making any modifications.
  276. FINISHED_F_info  - Finished file information [as stored in the type
  277.                    TESTINFO_FILE_REC]. Information on the resulting file after
  278.                    THDPRO.EXE has completed it's processing of this file.
  279.                    Changes from the original file "can" occur in any of the
  280.                    fields through archive conversion or other manipulation.
  281. Descr_Length     - Number of characters in the DIZ_Description field
  282.                    [ 0 if no description, maximum 1500 ]
  283. DIZ_Description  - Description containing the full description including
  284.                    any CR/LF (or other control or non ASCII characters) that
  285.                    may have been present in the description file used
  286.                    [maximum 1500 characters]
  287.  
  288.      ** NOTE **
  289.      All string variables and character variables will be stored as
  290. uppercase in these records except for the "CREATOR" field which contains the
  291. name of the creator of the record. There will be absolutely no lowercase
  292. information in these records anywhere else except in the diz_description
  293. field.
  294.      Strings and arrays are NOT necessarily null terminated.
  295. }