index 0b8d352eaab736e29962ea5e09d368ca8f913484..d67dc4c52db84c01abb20d58eb8f3ccae120908b 100644 (file)
uses sysutils, Classes, md5, g_net, g_netmsg, g_console, g_main, e_log;
-function g_Res_SearchSameWAD(const path, filename: AnsiString; const resMd5: TMD5Digest): AnsiString;
// download map wad from server (if necessary)
// download all required map resource wads too
+// registers all required replacement wads
// returns name of the map wad (relative to mapdir), or empty string on error
function g_Res_DownloadMapWAD (FileName: AnsiString; const mapHash: TMD5Digest): AnsiString;
-// call this before downloading a new map from a server
-procedure g_Res_ClearReplacementWads ();
// returns original name, or replacement name
function g_Res_FindReplacementWad (oldname: AnsiString): AnsiString;
-procedure g_Res_PutReplacementWad (oldname: AnsiString; newDiskName: AnsiString);
+// call this somewhere in startup sequence
+procedure g_Res_CreateDatabases (allowRescan: Boolean=false);
-implementation
-uses g_language, sfs, utils, wadreader, g_game, hashtable;
+implementation
-//const DOWNLOAD_DIR = 'downloads';
+uses g_language, sfs, utils, wadreader, g_game, hashtable, fhashdb;
var
+ // cvars
+ g_res_ignore_names: AnsiString = 'standart;shrshade';
+ g_res_ignore_enabled: Boolean = true;
+ g_res_save_databases: Boolean = true;
+ // other vars
replacements: THashStrStr = nil;
+ knownMaps: TFileHashDB = nil;
+ knownRes: TFileHashDB = nil;
+ saveDBsToDiskEnabled: Boolean = false; // this will be set to `true` if initial database saving succeed
-// call this before downloading a new map from a server
-procedure g_Res_ClearReplacementWads ();
+//==========================================================================
+//
+// saveDatabases
+//
+//==========================================================================
+procedure saveDatabases (saveMap, saveRes: Boolean);
+var
+ err: Boolean;
+ st: TStream;
begin
- if assigned(replacements) then replacements.clear();
- e_LogWriteln('cleared replacement wads');
+ if (not saveDBsToDiskEnabled) or (not g_res_save_databases) then exit;
+ // rescan dirs
+ // save map database
+ if (saveMap) then
+ begin
+ err := true;
+ st := nil;
+ try
+ st := createDiskFile(GameDir+'/data/maphash.db');
+ knownMaps.saveTo(st);
+ err := false;
+ except
+ end;
+ st.Free;
+ if (err) then begin saveDBsToDiskEnabled := false; e_LogWriteln('cannot write map database, disk refresh disabled'); exit; end;
+ end;
+ // save resource database
+ if (saveRes) then
+ begin
+ err := true;
+ st := nil;
+ try
+ st := createDiskFile(GameDir+'/data/reshash.db');
+ knownRes.saveTo(st);
+ err := false;
+ except
+ end;
+ st.Free;
+ if (err) then begin saveDBsToDiskEnabled := false; e_LogWriteln('cannot write resource database, disk refresh disabled'); exit; end;
+ end;
end;
-// returns original name, or replacement name
-function g_Res_FindReplacementWad (oldname: AnsiString): AnsiString;
+//==========================================================================
+//
+// g_Res_CreateDatabases
+//
+//==========================================================================
+procedure g_Res_CreateDatabases (allowRescan: Boolean=false);
var
- fn: AnsiString;
+ st: TStream;
+ upmap: Boolean;
+ upres: Boolean;
+ forcesave: Boolean;
begin
- result := oldname;
- if not assigned(replacements) then exit;
- if (replacements.get(toLowerCase1251(ExtractFileName(oldname)), fn)) then result := fn;
+ if not assigned(knownMaps) then
+ begin
+ // create and load a know map database, if necessary
+ knownMaps := TFileHashDB.Create(GameDir+'/maps/');
+ knownRes := TFileHashDB.Create(GameDir+'/wads/');
+ saveDBsToDiskEnabled := true;
+ // load map database
+ st := nil;
+ try
+ st := openDiskFileRO(GameDir+'/data/maphash.db');
+ knownMaps.loadFrom(st);
+ e_LogWriteln('loaded map database');
+ except
+ end;
+ st.Free;
+ // load resource database
+ st := nil;
+ try
+ st := openDiskFileRO(GameDir+'/data/reshash.db');
+ knownRes.loadFrom(st);
+ e_LogWriteln('loaded resource database');
+ except
+ end;
+ st.Free;
+ forcesave := true;
+ end
+ else
+ begin
+ if (not allowRescan) then exit;
+ forcesave := false;
+ end;
+ // rescan dirs
+ e_LogWriteln('refreshing map database');
+ upmap := knownMaps.scanFiles();
+ e_LogWriteln('refreshing resource database');
+ upres := knownRes.scanFiles();
+ // save databases
+ if (forcesave) then begin upmap := true; upres := true; end;
+ if upmap or upres then saveDatabases(upmap, upres);
+end;
+
+
+//==========================================================================
+//
+// getWord
+//
+// get next word from a string
+// words are delimited with ';'
+// ignores leading and trailing spaces
+// returns empty string if there are no more words
+//
+//==========================================================================
+function getWord (var list: AnsiString): AnsiString;
+var
+ pos: Integer;
+begin
+ result := '';
+ while (length(list) > 0) do
+ begin
+ if (ord(list[1]) <= 32) or (list[1] = ';') or (list[1] = ':') then begin Delete(list, 1, 1); continue; end;
+ pos := 1;
+ while (pos <= length(list)) and (list[pos] <> ';') and (list[pos] <> ':') do Inc(pos);
+ result := Copy(list, 1, pos-1);
+ Delete(list, 1, pos);
+ while (length(result) > 0) and (ord(result[length(result)]) <= 32) do Delete(result, length(result), 1);
+ if (length(result) > 0) then exit;
+ end;
+end;
+
+
+//==========================================================================
+//
+// isIgnoredResWad
+//
+// checks if the given resource wad can be ignored
+//
+// FIXME: preparse name list?
+//
+//==========================================================================
+function isIgnoredResWad (fname: AnsiString): Boolean;
+var
+ list: AnsiString;
+ name: AnsiString;
+begin
+ result := false;
+ if (not g_res_ignore_enabled) then exit;
+ fname := forceFilenameExt(ExtractFileName(fname), '');
+ list := g_res_ignore_names;
+ name := getWord(list);
+ while (length(name) > 0) do
+ begin
+ name := forceFilenameExt(name, '');
+ //writeln('*** name=[', name, ']; fname=[', fname, ']');
+ if (StrEquCI1251(name, fname)) then begin result := true; exit; end;
+ name := getWord(list);
+ end;
+end;
+
+
+//==========================================================================
+//
+// clearReplacementWads
+//
+// call this before downloading a new map from a server
+//
+//==========================================================================
+procedure clearReplacementWads ();
+begin
+ if assigned(replacements) then replacements.clear();
+ e_LogWriteln('cleared replacement wads');
end;
-procedure g_Res_PutReplacementWad (oldname: AnsiString; newDiskName: AnsiString);
+//==========================================================================
+//
+// addReplacementWad
+//
+// register new replacement wad
+//
+//==========================================================================
+procedure addReplacementWad (oldname: AnsiString; newDiskName: AnsiString);
begin
e_LogWritefln('adding replacement wad: oldname=%s; newname=%s', [oldname, newDiskName]);
if not assigned(replacements) then replacements := THashStrStr.Create();
end;
-function scanDir (dirName: AnsiString; baseName: AnsiString; const resMd5: TMD5Digest): AnsiString;
+//==========================================================================
+//
+// g_Res_FindReplacementWad
+//
+// returns original name, or replacement name
+//
+//==========================================================================
+function g_Res_FindReplacementWad (oldname: AnsiString): AnsiString;
var
- searchResult: TSearchRec;
- dfn: AnsiString;
- md5: TMD5Digest;
- dirs: array of AnsiString;
- f: Integer;
+ fn: AnsiString;
begin
- result := '';
- SetLength(dirs, 0);
- if (length(baseName) = 0) then exit;
- dirName := IncludeTrailingPathDelimiter(dirName);
- e_LogWritefln('scanning dir `%s` for file `%s`...', [dirName, baseName]);
-
- // scan files
- if (FindFirst(dirName+'*', faAnyFile, searchResult) <> 0) then exit;
- try
- repeat
- if ((searchResult.Attr and faDirectory) = 0) then
- begin
- if (isWadNamesEqu(searchResult.Name, baseName)) then
- begin
- dfn := dirName+searchResult.Name;
- if FileExists(dfn) then
- begin
- e_LogWritefln(' found `%s`...', [dfn]);
- md5 := MD5File(dfn);
- if MD5Match(md5, resMd5) then
- begin
- e_LogWritefln(' MATCH `%s`...', [dfn]);
- SetLength(dirs, 0);
- result := dfn;
- exit;
- end;
- end;
- end;
- end
- else
- begin
- if (searchResult.Name <> '.') and (searchResult.Name <> '..') then
- begin
- dfn := dirName+searchResult.Name;
- SetLength(dirs, Length(dirs)+1);
- dirs[length(dirs)-1] := dfn;
- end;
- end;
- until (FindNext(searchResult) <> 0);
- finally
- FindClose(searchResult);
+ //e_LogWritefln('LOOKING for replacement wad for [%s]...', [oldname], TMsgType.Notify);
+ result := oldname;
+ if not assigned(replacements) then exit;
+ if (replacements.get(toLowerCase1251(ExtractFileName(oldname)), fn)) then
+ begin
+ //e_LogWritefln('found replacement wad for [%s] -> [%s]', [oldname, fn], TMsgType.Notify);
+ result := fn;
end;
+end;
- // scan subdirs
- for f := 0 to High(dirs) do
+
+//==========================================================================
+//
+// findExistingMapWadWithHash
+//
+// find map or resource wad using its base name and hash
+//
+// returns found wad disk name, or empty string
+//
+//==========================================================================
+function findExistingMapWadWithHash (fname: AnsiString; const resMd5: TMD5Digest): AnsiString;
+begin
+ //result := scanDir(GameDir+'/maps', ExtractFileName(fname), resMd5);
+ result := knownMaps.findByHash(resMd5);
+ if (length(result) > 0) then
begin
- dfn := dirs[f];
- result := scanDir(dfn, baseName, resMd5);
- if (length(result) <> 0) then begin SetLength(dirs, 0); exit; end;
+ result := GameDir+'/maps/'+result;
+ if not FileExists(result) then
+ begin
+ if (knownMaps.scanFiles()) then saveDatabases(true, false);
+ result := '';
+ end;
end;
- SetLength(dirs, 0);
end;
-function g_Res_SearchResWad (asMap: Boolean; fname: AnsiString; const resMd5: TMD5Digest): AnsiString;
+//==========================================================================
+//
+// findExistingResWadWithHash
+//
+// find map or resource wad using its base name and hash
+//
+// returns found wad disk name, or empty string
+//
+//==========================================================================
+function findExistingResWadWithHash (fname: AnsiString; const resMd5: TMD5Digest): AnsiString;
begin
- result := '';
- //if not assigned(scannedDirs) then scannedDirs := THashStrInt.Create();
- if (asMap) then
- begin
- result := scanDir(GameDir+'/maps', ExtractFileName(fname), resMd5);
- end
- else
+ //result := scanDir(GameDir+'/wads', ExtractFileName(fname), resMd5);
+ result := knownRes.findByHash(resMd5);
+ if (length(result) > 0) then
begin
- result := scanDir(GameDir+'/wads', ExtractFileName(fname), resMd5);
+ result := GameDir+'/wads/'+result;
+ if not FileExists(result) then
+ begin
+ if (knownRes.scanFiles()) then saveDatabases(false, true);
+ result := '';
+ end;
end;
end;
-function g_Res_SearchSameWAD (const path, filename: AnsiString; const resMd5: TMD5Digest): AnsiString;
+//==========================================================================
+//
+// generateFileName
+//
+// generate new file name based on the given one and the hash
+// you can pass files with pathes here too
+//
+//==========================================================================
+function generateFileName (fname: AnsiString; const hash: TMD5Digest): AnsiString;
+var
+ mds: AnsiString;
+ path: AnsiString;
+ base: AnsiString;
+ ext: AnsiString;
begin
- result := scanDir(path, filename, resMd5);
+ mds := MD5Print(hash);
+ if (length(mds) > 16) then mds := Copy(mds, 1, 16);
+ mds := '_'+mds;
+ if (length(fname) = 0) then begin result := mds; exit; end;
+ path := ExtractFilePath(fname);
+ base := ExtractFileName(fname);
+ ext := getFilenameExt(base);
+ base := forceFilenameExt(base, '');
+ if (length(path) > 0) then result := IncludeTrailingPathDelimiter(path) else result := '';
+ result := result+base+mds+ext;
end;
+//==========================================================================
+//
+// g_Res_DownloadMapWAD
+//
+// download map wad from server (if necessary)
+// download all required map resource wads too
+// registers all required replacement wads
+//
+// returns name of the map wad (relative to mapdir), or empty string on error
+//
+//==========================================================================
function g_Res_DownloadMapWAD (FileName: AnsiString; const mapHash: TMD5Digest): AnsiString;
var
tf: TNetFileTransfer;
- resList: TStringList;
+ resList: array of TNetMapResourceInfo = nil;
f, res: Integer;
strm: TStream;
fname: AnsiString;
wadname: AnsiString;
md5: TMD5Digest;
+ mapdbUpdated: Boolean = false;
+ resdbUpdated: Boolean = false;
+ transStarted: Boolean;
begin
- //SetLength(mapData.ExternalResources, 0);
result := '';
- g_Res_ClearReplacementWads();
-
- resList := TStringList.Create();
+ clearReplacementWads();
+ g_Res_CreateDatabases();
try
g_Res_received_map_start := 1;
g_Console_Add(Format(_lc[I_NET_MAP_DL], [FileName]));
e_WriteLog('Downloading map `' + FileName + '` from server', TMsgType.Notify);
g_Game_SetLoadingText(FileName + '...', 0, False);
- //MC_SEND_MapRequest();
- if (not g_Net_SendMapRequest()) then exit;
FileName := ExtractFileName(FileName);
if (length(FileName) = 0) then FileName := 'fucked_map_wad.wad';
+
+ // this also sends map request
res := g_Net_Wait_MapInfo(tf, resList);
if (res <> 0) then exit;
// find or download a map
- result := g_Res_SearchResWad(true{asMap}, tf.diskName, mapHash);
+ result := findExistingMapWadWithHash(tf.diskName, mapHash);
if (length(result) = 0) then
begin
// download map
CreateDir(GameDir+'/maps/downloads');
except
end;
- fname := GameDir+'/maps/downloads/'+FileName;
+ fname := GameDir+'/maps/downloads/'+generateFileName(FileName, mapHash);
+ tf.diskName := fname;
+ e_LogWritefln('map disk file for `%s` is `%s`', [FileName, fname], TMsgType.Fatal);
try
strm := openDiskFileRW(fname);
except
- e_WriteLog('cannot create map file `'+FileName+'`', TMsgType.Fatal);
+ e_WriteLog('cannot create map file `'+fname+'`', TMsgType.Fatal);
result := '';
exit;
end;
- tf.diskName := fname;
try
res := g_Net_ReceiveResourceFile(-1{map}, tf, strm);
except
- e_WriteLog('error downloading map file `'+FileName+'`', TMsgType.Fatal);
+ e_WriteLog('error downloading map file (exception) `'+FileName+'`', TMsgType.Fatal);
strm.Free;
result := '';
exit;
strm.Free;
if (res <> 0) then
begin
- e_WriteLog('error downloading map file `'+FileName+'`', TMsgType.Fatal);
+ e_LogWritefln('error downloading map `%s` (res=%d)', [FileName, res], TMsgType.Fatal);
result := '';
exit;
end;
DeleteFile(fname);
strm := createDiskFile(fname);
except
- e_WriteLog('cannot create map file `'+fname+'`', TMsgType.Fatal);
+ e_WriteLog('cannot create map file `'+fname+'` (exception)', TMsgType.Fatal);
result := '';
exit;
end;
strm.Free;
if (res <> 0) then
begin
- e_WriteLog('error downloading map file `'+FileName+'`', TMsgType.Fatal);
+ e_LogWritefln('error downloading map `%s` (res=%d)', [FileName, res], TMsgType.Fatal);
result := '';
exit;
end;
end;
end;
+ if (knownMaps.addWithHash(fname, mapHash)) then mapdbUpdated := true;
result := fname;
end;
// download resources
- for f := 0 to resList.Count-1 do
+ for f := 0 to High(resList) do
begin
- res := g_Net_RequestResFileInfo(f, tf);
- if (res <> 0) then begin result := ''; exit; end;
- wadname := g_Res_SearchResWad(false{asMap}, tf.diskName, tf.hash);
+ // if we got a new-style reslist packet, use received data to check for resource files
+ if (resList[f].size < 0) then
+ begin
+ // old-style packet
+ transStarted := true;
+ res := g_Net_RequestResFileInfo(f, tf);
+ if (res <> 0) then begin result := ''; exit; end;
+ end
+ else
+ begin
+ // new-style packet
+ transStarted := false;
+ tf.diskName := resList[f].wadName;
+ tf.hash := resList[f].hash;
+ tf.size := resList[f].size;
+ end;
+ if (isIgnoredResWad(tf.diskName)) then
+ begin
+ // ignored file, abort download
+ if (transStarted) then g_Net_AbortResTransfer(tf);
+ e_LogWritefln('ignoring wad resource `%s` by user request', [tf.diskName]);
+ continue;
+ end;
+ wadname := findExistingResWadWithHash(tf.diskName, tf.hash);
if (length(wadname) <> 0) then
begin
// already here
- g_Net_AbortResTransfer(tf);
- g_Res_PutReplacementWad(tf.diskName, wadname);
+ if (transStarted) then g_Net_AbortResTransfer(tf);
+ addReplacementWad(tf.diskName, wadname);
end
else
begin
+ if (not transStarted) then
+ begin
+ res := g_Net_RequestResFileInfo(f, tf);
+ if (res <> 0) then begin result := ''; exit; end;
+ end;
try
CreateDir(GameDir+'/wads/downloads');
except
end;
- fname := GameDir+'/wads/downloads/'+tf.diskName;
+ fname := GameDir+'/wads/downloads/'+generateFileName(tf.diskName, tf.hash);
e_LogWritefln('downloading resource `%s` to `%s`...', [tf.diskName, fname]);
try
strm := openDiskFileRW(fname);
end;
end;
end;
- g_Res_PutReplacementWad(tf.diskName, fname);
+ addReplacementWad(tf.diskName, fname);
+ if (knownRes.addWithHash(fname, tf.hash)) then resdbUpdated := true;
end;
end;
finally
- resList.Free;
+ SetLength(resList, 0);
g_Res_received_map_start := 0;
end;
+
+ if saveDBsToDiskEnabled and (mapdbUpdated or resdbUpdated) then saveDatabases(mapdbUpdated, resdbUpdated);
end;
+initialization
+ conRegVar('rdl_ignore_names', @g_res_ignore_names, 'list of resource wad names (without extensions) to ignore in dl hash checks', 'dl ignore wads');
+ conRegVar('rdl_ignore_enabled', @g_res_ignore_enabled, 'enable dl hash check ignore list', 'dl hash check ignore list active');
+ conRegVar('rdl_hashdb_save_enabled', @g_res_save_databases, 'enable saving map/resource hash databases to disk', 'controls storing hash databases to disk');
end.