DEADSOFTWARE

utils: made `wadExtensions` array public, because we may need it elsewhere
[d2df-sdl.git] / src / shared / utils.pas
index 21172272a8a01ca64132494ddeed01fb63b0d27c..a3a650070a1ff1ef05791ee85676edd231259dd1 100644 (file)
@@ -2,8 +2,7 @@
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * the Free Software Foundation, version 3 of the License ONLY.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -19,7 +18,7 @@ unit utils;
 interface
 
 uses
-  SysUtils, Classes;
+  SysUtils, Classes, md5;
 
 
 // ////////////////////////////////////////////////////////////////////////// //
@@ -27,6 +26,17 @@ type
   SSArray = array of ShortString;
 
 
+const wadExtensions: array [0..6] of AnsiString = (
+  '.dfz',
+  '.wad',
+  '.dfwad',
+  '.pk3',
+  '.pak',
+  '.zip',
+  '.dfzip'
+);
+
+
 // ////////////////////////////////////////////////////////////////////////// //
 type
   TUtf8DecoderFast = packed record
@@ -80,11 +90,16 @@ function isWadPath (const fn: AnsiString): Boolean;
 // adds ".wad" extension if filename doesn't have one of ".wad", ".pk3", ".zip"
 function addWadExtension (const fn: AnsiString): AnsiString;
 
+// check wad signature
+function isWadData (data: Pointer; len: LongWord): Boolean;
+
 // convert number to strig with nice commas
 function int64ToStrComma (i: Int64): AnsiString;
 
 function upcase1251 (ch: AnsiChar): AnsiChar; inline;
 function locase1251 (ch: AnsiChar): AnsiChar; inline;
+function IsValid1251 (ch: Word): Boolean;
+function IsPrintable1251 (ch: AnsiChar): Boolean;
 
 function toLowerCase1251 (const s: AnsiString): AnsiString;
 
@@ -95,17 +110,27 @@ function utf8Valid (const s: AnsiString): Boolean;
 
 function utf8to1251 (s: AnsiString): AnsiString;
 
-// `pathname` will be modified if path is valid
-// `lastIsDir` should be `true` if we are searching for directory
-// nobody cares about shitdoze, so i'll use the same code path for it
+// findFileCI takes case-insensitive path, traverses it, and rewrites it to
+// a case-sensetive one (using real on-disk names). return value means 'success'.
+// if some dir or file wasn't found, pathname is undefined (destroyed, but not
+// necessarily cleared).
+// last name assumed to be a file, not directory (unless `lastIsDir` flag is set).
 function findFileCI (var pathname: AnsiString; lastIsDir: Boolean=false): Boolean;
 
-// return fixed AnsiString or empty AnsiString
+// findDiskWad tries to find the wad file using common wad extensions
+// (see `wadExtensions` array).
+// returns real on-disk filename, or empty string.
+// original wad extension is used as a hint for the first try.
+// also, this automatically performs `findFileCI()`.
 function findDiskWad (fname: AnsiString): AnsiString;
+// slashes must be normalized!
+function isWadNamesEqu (wna, wnb: AnsiString): Boolean;
 
 // they throws
 function openDiskFileRO (pathname: AnsiString): TStream;
 function createDiskFile (pathname: AnsiString): TStream;
+// create file if necessary, but don't truncate the existing one
+function openDiskFileRW (pathname: AnsiString): TStream;
 
 // little endian
 procedure writeSign (st: TStream; const sign: AnsiString);
@@ -271,12 +296,26 @@ procedure CopyMemory (Dest: Pointer; Src: Pointer; Len: LongWord); inline;
 procedure ZeroMemory (Dest: Pointer; Len: LongWord); inline;
 
 
+type
+  TDiskFileInfo = record
+    diskName: AnsiString;
+    size: LongInt;
+    age: LongInt;
+    // not changed by info getter; used in other parts of the code
+    userName: AnsiString;
+    tag: Integer;
+    hash: TMD5Digest;
+    udata: Pointer;
+  end;
+
+function GetDiskFileInfo (fname: AnsiString; var info: TDiskFileInfo): Boolean;
+
+
 implementation
 
 uses
   xstreams;
 
-
 // ////////////////////////////////////////////////////////////////////////// //
 procedure CopyMemory (Dest: Pointer; Src: Pointer; Len: LongWord); inline;
 begin
@@ -810,10 +849,13 @@ end;
 
 function hasWadExtension (const fn: AnsiString): Boolean;
 var
-  ext: AnsiString;
+  ext, newExt: AnsiString;
 begin
   ext := getFilenameExt(fn);
-  result := StrEquCI1251(ext, '.wad') or StrEquCI1251(ext, '.pk3') or StrEquCI1251(ext, '.zip') or StrEquCI1251(ext, '.dfz');
+  result := true;
+  for newExt in wadExtensions do if (StrEquCI1251(ext, newExt)) then exit;
+  result := false;
+  //result := StrEquCI1251(ext, '.wad') or StrEquCI1251(ext, '.pk3') or StrEquCI1251(ext, '.zip') or StrEquCI1251(ext, '.dfz');
 end;
 
 
@@ -824,6 +866,22 @@ begin
 end;
 
 
+function isWadData (data: Pointer; len: LongWord): Boolean;
+  var p: PChar;
+begin
+  p := PChar(data);
+  Result :=
+    (* ZIP *)
+    ((len > 3) and (p[0] = 'P') and (p[1] = 'K') and (p[2] = #03) and (p[3] = #04)) or
+    ((len > 3) and (p[0] = 'P') and (p[1] = 'K') and (p[2] = #05) and (p[3] = #06)) or
+    (* PACK *)
+    ((len > 3) and (p[0] = 'P') and (p[1] = 'A') and (p[2] = 'C') and (p[3] = 'K')) or
+    ((len > 3) and (p[0] = 'S') and (p[1] = 'P') and (p[2] = 'A') and (p[3] = 'K')) or
+    (* DFWAD *)
+    ((len > 5) and (p[0] = 'D') and (p[1] = 'F') and (p[2] = 'W') and (p[3] = 'A') and (p[4] = 'D') and (p[5] = #01))
+end;
+
+
 function isWadPath (const fn: AnsiString): Boolean;
 var
   pos: Integer;
@@ -911,6 +969,16 @@ begin
   result := ch;
 end;
 
+function IsValid1251 (ch: Word): Boolean;
+begin
+  result := (ch = Ord('?')) or (wc2shitmap[ch] <> '?')
+end;
+
+function IsPrintable1251 (ch: AnsiChar): Boolean;
+begin
+  result := (ch >= #32) and (ch <> #127)
+end;
+
 
 function strEquCI1251 (const s0, s1: AnsiString): Boolean;
 var
@@ -1061,9 +1129,9 @@ end;
 
 
 // ////////////////////////////////////////////////////////////////////////// //
-// `pathname` will be modified if path is valid
-// `lastIsDir` should be `true` if we are searching for directory
-// nobody cares about shitdoze, so i'll use the same code path for it
+// findFileCI eats case-insensitive path, traverses it and rewrites it to a
+// case-sensetive. result value means success.
+// if file/dir not founded than pathname is in undefined state!
 function findFileCI (var pathname: AnsiString; lastIsDir: Boolean=false): Boolean;
 var
   sr: TSearchRec;
@@ -1129,7 +1197,27 @@ begin
 end;
 
 
-const fileExtensions: array [0..6] of AnsiString = ('.dfz', '.wad', '.dfwad', '.pk3', '.pak', '.zip', '.dfzip');
+function isWadNamesEqu (wna, wnb: AnsiString): Boolean;
+var
+  ext, newExt: AnsiString;
+  found: Boolean;
+begin
+  result := StrEquCI1251(wna, wnb);
+  if result then exit;
+  // check first ext
+  ext := getFilenameExt(wna);
+  found := false;
+  for newExt in wadExtensions do if (StrEquCI1251(ext, newExt)) then begin found := true; break; end;
+  if not found then exit;
+  // check second ext
+  ext := getFilenameExt(wnb);
+  found := false;
+  for newExt in wadExtensions do if (StrEquCI1251(ext, newExt)) then begin found := true; break; end;
+  if not found then exit;
+  wna := forceFilenameExt(wna, '');
+  wnb := forceFilenameExt(wnb, '');
+  result := StrEquCI1251(wna, wnb);
+end;
 
 function findDiskWad (fname: AnsiString): AnsiString;
 var
@@ -1142,7 +1230,7 @@ begin
   origExt := getFilenameExt(fname);
   fname := forceFilenameExt(fname, '');
   //writeln(' findDiskWad01: fname=<', fname, '>; origExt=<', origExt, '>');
-  for newExt in fileExtensions do
+  for newExt in wadExtensions do
   begin
     //writeln(' findDiskWad02: fname=<', fname, '>; origExt=<', origExt, '>; newExt=<', newExt, '>');
     if (StrEquCI1251(newExt, origExt)) then
@@ -1159,7 +1247,7 @@ end;
 
 function openDiskFileRO (pathname: AnsiString): TStream;
 begin
-  if not findFileCI(pathname) then raise Exception.Create('can''t open file "'+pathname+'"');
+  if not findFileCI(pathname) then raise EFileNotFoundException.Create('can''t open file "'+pathname+'"');
   result := TFileStream.Create(pathname, fmOpenRead or {fmShareDenyWrite}fmShareDenyNone);
 end;
 
@@ -1176,6 +1264,30 @@ begin
 end;
 
 
+function openDiskFileRW (pathname: AnsiString): TStream;
+var
+  path: AnsiString;
+  oldname: AnsiString;
+begin
+  //writeln('*** TRYING R/W FILE "', pathname, '"');
+  path := ExtractFilePath(pathname);
+  if length(path) > 0 then
+  begin
+    if not findFileCI(path, true) then raise Exception.Create('can''t create file "'+pathname+'"');
+  end;
+  oldname := pathname;
+  if findFileCI(oldname) then
+  begin
+    //writeln('*** found old file "', oldname, '"');
+    result := TFileStream.Create(oldname, fmOpenReadWrite or fmShareDenyWrite);
+  end
+  else
+  begin
+    result := TFileStream.Create(path+ExtractFileName(pathname), fmCreate);
+  end;
+end;
+
+
 procedure writeIntegerLE (st: TStream; vp: Pointer; size: Integer);
 {$IFDEF ENDIAN_LITTLE}
 begin
@@ -1918,6 +2030,32 @@ begin
 end;
 
 
+function GetDiskFileInfo (fname: AnsiString; var info: TDiskFileInfo): Boolean;
+var
+  age: LongInt;
+  size: LongInt;
+  handle: THandle;
+begin
+  result := false;
+  if (length(fname) = 0) then exit;
+  if not findFileCI(fname) then exit;
+  // get age
+  age := FileAge(fname);
+  if (age = -1) then exit;
+  // get size
+  handle := FileOpen(fname, fmOpenRead or fmShareDenyNone);
+  if (handle = THandle(-1)) then exit;
+  size := FileSeek(handle, 0, fsFromEnd);
+  FileClose(handle);
+  if (size = -1) then exit;
+  // fill info
+  info.diskName := fname;
+  info.size := size;
+  info.age := age;
+  result := true;
+end;
+
+
 (*
 var
   ss: ShortString;