home *** CD-ROM | disk | FTP | other *** search
/ Zodiac Super OZ / MEDIADEPOT.ISO / FILES / 13 / COMMIO0B.ZIP / DFUNIT.PAS < prev    next >
Pascal/Delphi Source File  |  1996-05-14  |  14KB  |  422 lines
  1. {$V-,O+,F+}
  2.     {^..^ overlay it; since the routines here are only used once, theres no
  3.           need for the code to sit in memory, if not being used. }
  4. unit DFunit; {Drop file unit}
  5. {
  6.          This unit is a companion to the COMMIO communications kit.
  7.                 Written by Jason Morriss a.k.a. Lief O'Pardy
  8.  
  9.                   Copyright (C) 1995,1996 by Jason Morriss
  10.  
  11.   v- All of the following crap can be ignored (except for the last paragraph)
  12.      I finally decided that this method will still require just about the
  13.      same amount of programming.  The Last paragraph discribes the best
  14.      option IMO.
  15.  
  16.   This unit contains the functions needed to read in a drop file that the
  17.   BBS creates when your DOOR is run.  I thought long and hard trying to
  18.   make this unit easy to use.  Since there are a countless number of
  19.   different Drop File formats, its hard to make it easy for the programmer
  20.   to support them all (or most), without a lot of extra programming.  I
  21.   finally decided to make a seperate RECORD for each format (only the ones
  22.   that i know are implemented).  But no variables of those types are declared
  23.   by this unit, Thats totally up to the programmer.  The method i can think
  24.   of that is the easiest to use (IMO), would be something like:
  25.     x) This method is useful because you only need to declare _1_ pointer,
  26.        and you can use all of the different types of drop files.  The method
  27.        below is only a suggestion, you don't have to use it.  You could also
  28.        declare a variable for each dropfile, and do it that way, but it takes
  29.        more memory that way... its a waste. anyways...
  30.     1) declare a pointer in your program (a generic pointer, that is... it
  31.        must not have a TYPE except of "pointer"; ie: p:pointer).
  32.     2) Decide which Dropfile you want to load (either through the command
  33.        line, or an INI file, etc), and getmem() memory for the pointer.  The
  34.        amount of memory it needs depends on which dropfile your going to
  35.        load.  Use the record types that i defined in the interface section.
  36.        (ie: sizeof(Tchain_txt))
  37.     3) Call the corresponding function to load the dropfile you want, passing
  38.        the pointer you created as the buffer to be filled.
  39.     4) Later in your program, whenever you need to get info from the pointer,
  40.        you have to TYPECAST the pointer to the corresponding dropfile record
  41.        needed.  Example:  port := Tchain_txt(p^).comport;
  42.        Looks weird?  it does kinda, but those that haven't seen anything
  43.        like this, its easy to understand.  What it does is, it "fools" TP
  44.        into thinking that p^ is actually of the type Tchain_txt, and not
  45.        a pointer, this way TP will calculate the offset needed to find the
  46.        "comport" variable in p^.
  47.    4a) If your going to support more then 1 dropfile then you'll have to
  48.        setup some sort of case statement everywhere you want to access info
  49.        from the dropfile buffer.  Just create a variable of the type
  50.        "Tdropfiles", and when you load a dropfile, change the variable to
  51.        the dropfile loaded. ie:
  52.          case DFloaded of
  53.            DFdorinfox_def : port := Tdorinfox_def(p^).comport;
  54.            DFchain_txt    : port := Tchain_txt(p^).comport;
  55.          end;
  56.        That does require a little more programming on your part, but i feel
  57.        that its minimal.
  58.  
  59.   Another method that would be a LOT easier is to make a seperate program
  60.   to read in the drop file that the sysop specifies, and extract all
  61.   important data from it (anything your door needs) into another file.
  62.   Then your door would only need to support that _1_ (one, uno) file, and
  63.   no extra programming is needed in the actual DOOR code!  At the time that
  64.   I write this, i have not made such a program... But I might create one for
  65.   this door library (its easy enough ;)
  66. }
  67. interface
  68.  
  69. uses dos;
  70.  
  71. type
  72.   string40 = string[40];
  73.   TUserSex = (SexUnknown,SexMale,SexFemale);
  74.   TDropFiles = (DFfake,DFdorinfox_def,DFchain_txt);   {known drop file types}
  75.  
  76.   TDorinfox_Def = record
  77.     Node       : byte;
  78.     BBSName    : string[40];
  79.     SysopName  : string[40];
  80.     {^ FName & LName are actually on seperate lines (LName is blank if none;
  81.        but the line for it is STILL there!)}
  82.     Comport    : byte;
  83.     Baudrate   : longint;
  84.     DataBits   : byte;
  85.     StopBits   : byte;
  86.     Parity     : char;
  87.     _Unknown_  : byte;       {this has always been 0 in my experience}
  88.     UserName   : string[40]; {could be an alias or real name (but mostly alias i think)}
  89.     {^ FName & LName are actually on seperate lines (LName is blank if none;
  90.        but the line for it is STILL there!)}
  91.     UserLoc    : string[40]; {ie: "Silver Spring, MD" [w/o quotes]}
  92.     UseAnsi    : boolean;
  93.     Seclevel   : integer;
  94.     BBSMinLeft : word;       {minutes left on BBS, when user entered DOOR}
  95.     UseFossil  : boolean;
  96.   end;
  97.  
  98.   TChain_Txt = record
  99.     UserNum      : word;
  100.     UserName     : string[40]; {user's ALIAS}
  101.     UserRealName : string[40];
  102.     UserCallSign : string[15];
  103.     {^ what the hell is "HAM radio"!?!?  In my 3½ years of BBSing, i've
  104.        never been able to find out! (i haven't really looked either ;)}
  105.     UserAge      : byte;
  106.     UserSex      : TUserSex;
  107.     UserGold     : Real;
  108.     LastLogon    : string[10]; {ie: "08/5/95" [w/o quotes]}
  109.     ScreenWidth  : byte;       {80 mostly}
  110.     ScreenLength : byte;       {24/25 mostly}
  111.     SecLevel     : integer;
  112.     IsCoSysop    : boolean;    {Is user a CoSysop?}
  113.     IsSysop      : boolean;    {Is user the Sysop?}
  114.     UseAnsi      : boolean;
  115.     Local        : boolean;    {Is user on locally?}
  116.     BBSsecLeft   : real;       {Seconds left on BBS, before entering DOOR}
  117.     GFILESpath   : string[80];
  118.     SYSDATApath  : string[80];
  119.     SYSLOGname   : string[12];
  120.     Baudrate     : longint;
  121.     Comport      : byte;
  122.     BBSname      : string[40];
  123.     SysopName    : string[40];
  124.     _Unknown_    : longint;    {# of secs after midnight... or something...?}
  125.     UserTotalSec : longint;
  126.     UserTotalULk : longint;
  127.     UserTotalUL  : word;
  128.     UserTotalDLk : longint;
  129.     UserTotalDL  : word;
  130.     DataBits     : byte; {this actually is written to the file like: "8N1". }
  131.     parity       : char; {"}
  132.     StopBits     : byte; {"}
  133.   end;
  134.  
  135. {const
  136.   AutoFillDoorRec : boolean = true;{}
  137.  
  138. {─--[headers]-──────────────────────────────────────────────────────────────}
  139. Function Read_Fake:boolean;
  140. {^ "fake" reading a dropfile.  This is to help you test your DOOR, w/o
  141.    needing a dropfile.  This will load in a bunch of default settings, so
  142.    you won't just have a zero dropfile record.  If you don't load a DropFile,
  143.    then all the comport info MUST be in the INI file, or you can get it from
  144.    the command line.  It is suggested though, that you always include an INI
  145.    file with your DOOR, its easier then using the command line, IMO. }
  146. Function Read_ChainTxt(fn:pathstr; var p):boolean;
  147. {^ Read in a CHAIN.TXT dropfile.
  148.    NOTE: This function is untested, but it should work fine.
  149.      fn = [d:\path\]filename to drop file.  If the file is in another
  150.           directory, then the entire path WILL need to be given.
  151.      P = Buffer to store the info.  Besure its large enough to hold the
  152.          entire record. }
  153. Function Read_DorinfoxDef(fn:pathstr; var p):boolean;
  154. {^ Read in a DORINFOx.DEF dropfile.
  155.    NOTE: This function has been tested, and it works.
  156.      fn = [d:\path\]filename to drop file.  If the file is in another
  157.           directory, then the entire path WILL need to be given.
  158.           The "X" in the filename is actually replaced (by the bbs) with
  159.           the node # of the user about to play your door.  It ranges from
  160.           0..9.  So the filename never actually has an "X" in it.
  161.      P = Buffer to store the info.  Besure its large enough to hold the
  162.          entire record. }
  163.  
  164. implementation
  165.  
  166. var
  167.   f : text;             {used in reading the drop files}
  168.   i,e : integer;        {"}
  169.   s,s2 : string;        {"}
  170.  
  171. {───────────────────────────────────────────────────────────────────────────}
  172. procedure KillExtraBlanks(var s:string);
  173. {This only kills the blanks in front of and at the end of the string}
  174. var i:byte;
  175. begin
  176.   i:=1;
  177.   while (s[i]=' ')and(i<=length(s)) do delete(s,i,1);
  178.   i:=length(s);
  179.   while (s[i]=' ')and(i>=1) do begin
  180.     delete(s,i,1);
  181.     dec(i);
  182.   end;
  183. end;
  184. {───────────────────────────────────────────────────────────────────────────}
  185. Function Read_DorinfoxDef;
  186. var
  187.   buf : TDorinfox_Def absolute p;
  188. begin
  189.   fillchar(buf,sizeof(buf),0);
  190.   assign(f,fn);
  191.   {$I-}
  192.   reset(f);
  193.   {$I+}
  194.   if IOresult<>0 then begin
  195.     Read_DorinfoxDef:=false;
  196.     exit;
  197.   end;
  198.  
  199.   s:=fn[length(fn)-4];                   {get node# from filename}
  200.   val(s,buf.node,e);
  201.  
  202.   readln(f,buf.BBSname);                 {get BBS name}
  203.   killextrablanks(buf.BBSname);
  204.  
  205.   readln(f,s);                           {get sysop's name}
  206.   killextrablanks(s);
  207.   buf.sysopname:=s;
  208.   readln(f,s);
  209.   killextrablanks(s);
  210.   buf.sysopname:=buf.sysopname+' '+s;
  211.  
  212.   readln(f,s);                           {get comport}
  213.   killextrablanks(s);
  214.   while not (s[1] in ['0'..'9']) do delete(s,1,1);
  215.   val(s,buf.comport,e);
  216.  
  217.   readln(f,s);                          {get baudrate & parity info}
  218.   killextrablanks(s);
  219.   s2:='';
  220.   while s[1] in ['0'..'9'] do begin
  221.     s2:=s2 + s[1];
  222.     delete(s,1,1);
  223.   end;
  224.   val(s2,buf.baudrate,e);
  225.   while not (s[1]=',' {in [',']}) do delete(s,1,1);
  226.   delete(s,1,1);
  227.   buf.parity:=s[1];
  228.   delete(s,1,2);
  229.   val(s[1],buf.databits,e);
  230.   delete(s,1,2);
  231.   val(s[1],buf.stopbits,e);
  232.  
  233.   readln(f,s);                          {get _unknown_ variable}
  234.   val(s,buf._unknown_,e);
  235.  
  236.   readln(f,s);                          {get user's name}
  237.   killextrablanks(s);
  238.   buf.username:=s;
  239.   readln(f,s);
  240.   killextrablanks(s);
  241.   buf.username:=buf.username+' '+s;
  242.  
  243.   readln(f,s);                          {get user's location}
  244.   killextrablanks(s);
  245.   buf.userloc:=s;
  246.  
  247.   readln(f,s);                          {get ansi mode (on/off)}
  248.   killextrablanks(s);
  249. {  val(s[1],i,e);
  250.   buf.UseAnsi:=(i=1);{}
  251.   buf.UseAnsi:=(s[1]='1');
  252.  
  253.   readln(f,s);                          {get security level}
  254.   killextrablanks(s);
  255.   val(s,buf.seclevel,e);
  256.  
  257.   readln(f,s);                          {get minutes left on BBS}
  258.   killextrablanks(s);
  259.   val(s,buf.BBSMinLeft,e);
  260.  
  261.   readln(f,s);                          {get fossil info (on/off)}
  262.   killextrablanks(s);
  263.   val(s,i,e);
  264.   buf.UseFossil:=(i=-1);
  265.  
  266.   close(f);
  267.   Read_DorinfoxDef:=true;
  268. end;
  269. {───────────────────────────────────────────────────────────────────────────}
  270. Function Read_ChainTxt;
  271. var
  272.   buf : TChain_Txt absolute p;
  273. begin
  274.   fillchar(buf,sizeof(buf),0);
  275.   assign(f,fn);
  276.   {$I-}
  277.   reset(f);
  278.   {$I+}
  279.   if IOresult<>0 then begin
  280.     Read_ChainTxt:=false;
  281.     exit;
  282.   end;
  283.  
  284.   readln(f,s);                           {get user #}
  285.   killextrablanks(s);
  286.   val(s,buf.usernum,e);
  287.  
  288.   readln(f,s);                           {get user's name}
  289.   killextrablanks(s);
  290.   buf.username:=s;
  291.  
  292.   readln(f,s);                           {get user's name}
  293.   killextrablanks(s);
  294.   buf.userrealname:=s;
  295.  
  296.   readln(f,s);
  297.   killextrablanks(s);
  298.   buf.usercallsign:=s;
  299.  
  300.   readln(f,s);
  301.   killextrablanks(s);
  302.   val(s,buf.userage,e);
  303.  
  304.   readln(f,s);
  305.   killextrablanks(s);
  306.   case s[1] of
  307.     'M' : buf.usersex:=sexmale;
  308.     'F' : buf.usersex:=sexfemale;
  309.     else buf.usersex:=sexunknown;
  310.   end;
  311.  
  312.   readln(f,s);
  313.   killextrablanks(s);
  314.   val(s,buf.usergold,e);
  315.  
  316.   readln(f,s);
  317.   killextrablanks(s);
  318.   buf.lastlogon:=s;
  319.  
  320.   readln(f,s);
  321.   killextrablanks(s);
  322.   val(s,buf.ScreenWidth,e);
  323.  
  324.   readln(f,s);
  325.   killextrablanks(s);
  326.   val(s,buf.ScreenLength,e);
  327.  
  328.   readln(f,s);
  329.   killextrablanks(s);
  330.   val(s,buf.seclevel,e);
  331.  
  332.   readln(f,s);
  333.   killextrablanks(s);
  334.   buf.IsCoSysop:=boolean(ord(s[1]));
  335.  
  336.   readln(f,s);
  337.   killextrablanks(s);
  338.   buf.IsSysop:=boolean(ord(s[1]));
  339.  
  340.   readln(f,s);
  341.   killextrablanks(s);
  342.   buf.UseAnsi:=boolean(ord(s[1]));
  343.  
  344.   readln(f,s);
  345.   killextrablanks(s);
  346.   buf.Local:=not boolean(ord(s[1]));
  347.  
  348.   readln(f,s);
  349.   killextrablanks(s);
  350.   val(s,buf.bbssecleft,e);
  351.  
  352.   readln(f,s);
  353.   killextrablanks(s);
  354.   buf.GFILESpath:=s;
  355.  
  356.   readln(f,s);
  357.   killextrablanks(s);
  358.   buf.SYSDATApath:=s;
  359.  
  360.   readln(f,s);
  361.   killextrablanks(s);
  362.   buf.SYSLOGname:=s;
  363.  
  364.   readln(f,s);
  365.   killextrablanks(s);
  366.   val(s,buf.baudrate,e);
  367.  
  368.   readln(f,s);
  369.   killextrablanks(s);
  370.   val(s,buf.comport,e);
  371.  
  372.   readln(f,s);
  373.   killextrablanks(s);
  374.   buf.BBSname:=s;
  375.  
  376.   readln(f,s);
  377.   killextrablanks(s);
  378.   buf.SysopName:=s;
  379.  
  380.   readln(f,s);
  381.   killextrablanks(s);
  382.   val(s,buf._unknown_,e);
  383.  
  384.   readln(f,s);
  385.   killextrablanks(s);
  386.   val(s,buf.UserTotalSec,e);
  387.  
  388.   readln(f,s);
  389.   killextrablanks(s);
  390.   val(s,buf.UserTotalULk,e);
  391.  
  392.   readln(f,s);
  393.   killextrablanks(s);
  394.   val(s,buf.UserTotalUL,e);
  395.  
  396.   readln(f,s);
  397.   killextrablanks(s);
  398.   val(s,buf.UserTotalDLk,e);
  399.  
  400.   readln(f,s);
  401.   killextrablanks(s);
  402.   val(s,buf.UserTotalDL,e);
  403.  
  404.   readln(f,s);
  405.   killextrablanks(s);
  406.   val(s[1],buf.DataBits,e);
  407.   buf.parity:=s[2];
  408.   val(s[3],buf.StopBits,e);
  409.  
  410.   close(f);
  411. end;
  412. {───────────────────────────────────────────────────────────────────────────}
  413. Function Read_Fake;
  414. begin
  415. end;
  416. {───────────────────────────────────────────────────────────────────────────}
  417.  
  418. {var
  419.   p:pointer; c:byte;
  420. begin
  421.   p:= tdorinfox_def(p) absolute{}
  422. end.