1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#include "base/plugins.h"
#include "common/config-manager.h"
#include "common/file.h"
#include "common/md5.h"
#include "common/str-array.h"
#include "common/util.h"
#include "common/punycode.h"
#include "ags/detection.h"
#include "ags/detection_tables.h"
namespace AGS3 {
static const char *const HEAD_SIG = "CLIB\x1a";
static const char *const TAIL_SIG = "CLIB\x1\x2\x3\x4SIGE";
#define HEAD_SIG_SIZE 5
#define TAIL_SIG_SIZE 12
/**
* Detect the presence of an AGS game
* TODO: This is a compact version of MFLUtil::ReadSigsAndVersion. I didn't
* use the full version due to the complexities of including it when
* plugins are enabled. In the future, though, it would be nice to figure
* out, since the full version can handle not detecting on files that are
* AGS, but only contain sounds, etc. rather than a game
*/
static bool isAGSFile(Common::File &f) {
// Check for signature at beginning of file
char buffer[16];
if (f.read(buffer, HEAD_SIG_SIZE) == HEAD_SIG_SIZE &&
!memcmp(buffer, HEAD_SIG, HEAD_SIG_SIZE))
return true;
// Check for signature at end of EXE files
f.seek(-TAIL_SIG_SIZE, SEEK_END);
if (f.read(buffer, TAIL_SIG_SIZE) == TAIL_SIG_SIZE &&
!memcmp(buffer, TAIL_SIG, TAIL_SIG_SIZE))
return true;
return false;
}
} // namespace AGS3
const DebugChannelDef AGSMetaEngineDetection::debugFlagList[] = {
{AGS::kDebugGraphics, "Graphics", "Graphics debug level"},
{AGS::kDebugPath, "Path", "Pathfinding debug level"},
{AGS::kDebugFilePath, "FilePath", "File path debug level"},
{AGS::kDebugScan, "Scan", "Scan for unrecognised games"},
{AGS::kDebugScript, "Script", "Enable debug script dump"},
DEBUG_CHANNEL_END
};
AGSMetaEngineDetection::AGSMetaEngineDetection() : AdvancedMetaEngineDetection(AGS::GAME_DESCRIPTIONS, AGS::GAME_NAMES) {
_flags = kADFlagCanPlayUnknownVariants;
}
DetectedGames AGSMetaEngineDetection::detectGames(const Common::FSList &fslist, uint32 skipADFlags, bool skipIncomplete) {
FileMap allFiles;
if (fslist.empty())
return DetectedGames();
// Compose a hashmap of all files in fslist.
composeFileHashMap(allFiles, fslist, (_maxScanDepth == 0 ? 1 : _maxScanDepth));
// Run the detector on this
ADDetectedGames matches = detectGame(fslist.begin()->getParent(), allFiles, Common::UNK_LANG, Common::kPlatformUnknown, "", skipADFlags, skipIncomplete);
cleanupPirated(matches);
bool foundKnownGames = false;
DetectedGames detectedGames;
for (uint i = 0; i < matches.size(); i++) {
DetectedGame game = toDetectedGame(matches[i]);
if (game.hasUnknownFiles) {
// Check the game is an AGS game
for (FilePropertiesMap::const_iterator it = game.matchedFiles.begin(); it != game.matchedFiles.end(); it++) {
Common::File f;
if (f.open(allFiles[it->_key]) && AGS3::isAGSFile(f)) {
detectedGames.push_back(game);
break;
}
}
} else {
detectedGames.push_back(game);
foundKnownGames = true;
}
}
// If we didn't find a known game, also add a fallback detection
if (!foundKnownGames) {
// Use fallback detector if there were no matches by other means
ADDetectedGame fallbackDetectionResult = fallbackDetect(allFiles, fslist);
if (fallbackDetectionResult.desc) {
DetectedGame fallbackDetectedGame = toDetectedGame(fallbackDetectionResult);
fallbackDetectedGame.preferredTarget += "-fallback";
detectedGames.push_back(fallbackDetectedGame);
}
}
return detectedGames;
}
ADDetectedGame AGSMetaEngineDetection::fallbackDetect(const FileMap &allFiles, const Common::FSList &fslist, ADDetectedGameExtraInfo **extra) const {
// Set the default values for the fallback descriptor's ADGameDescription part.
AGS::g_fallbackDesc.desc.language = Common::UNK_LANG;
AGS::g_fallbackDesc.desc.platform = Common::kPlatformUnknown;
AGS::g_fallbackDesc.desc.flags = ADGF_NO_FLAGS;
// FIXME: Hack to return match without checking for game data,
// so that the command line game scanner will work
if (ConfMan.get("gameid") == "ags-scan") {
_gameid = "ags-scan";
AGS::g_fallbackDesc.desc.gameId = "ags-scan";
return ADDetectedGame(&AGS::g_fallbackDesc.desc);
}
// Set the defaults for gameid and extra
_gameid = "ags";
_extra.clear();
bool hasUnknownFiles = true;
// Scan for AGS games
for (Common::FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
if (file->isDirectory())
continue;
Common::Path filename = file->getPathInArchive();
if (!filename.baseName().hasSuffixIgnoreCase(".exe") &&
!filename.baseName().hasSuffixIgnoreCase(".ags") &&
!filename.equalsIgnoreCase("ac2game.dat"))
// Neither, so move on
continue;
filename = filename.punycodeEncode();
Common::File f;
if (!allFiles.contains(filename) || !f.open(allFiles[filename]))
continue;
if (AGS3::isAGSFile(f)) {
f.seek(0);
_md5 = Common::computeStreamMD5AsString(f, 5000);
// Check whether the game is in the detection list with a different filename
for (const ::AGS::AGSGameDescription *gameP = ::AGS::GAME_DESCRIPTIONS;
gameP->desc.gameId; ++gameP) {
if (_md5 == gameP->desc.filesDescriptions[0].md5 &&
f.size() == gameP->desc.filesDescriptions[0].fileSize &&
AD_NO_SIZE != gameP->desc.filesDescriptions[0].fileSize) {
hasUnknownFiles = false;
_gameid = gameP->desc.gameId;
break;
}
}
AGS::g_fallbackDesc.desc.gameId = _gameid.c_str();
AGS::g_fallbackDesc.desc.extra = _extra.c_str();
_filenameStr = filename.toString('/');
AGS::g_fallbackDesc.desc.filesDescriptions[0].fileName = _filenameStr.c_str();
AGS::g_fallbackDesc.desc.filesDescriptions[0].fileSize = (f.size() >= 0xffffffff) ? AD_NO_SIZE : f.size();
AGS::g_fallbackDesc.desc.filesDescriptions[0].md5 = _md5.c_str();
ADDetectedGame game(&AGS::g_fallbackDesc.desc);
game.matchedFiles[filename].md5 = _md5;
game.matchedFiles[filename].size = f.size();
game.hasUnknownFiles = hasUnknownFiles;
return game;
}
}
return ADDetectedGame();
}
REGISTER_PLUGIN_STATIC(AGS_DETECTION, PLUGIN_TYPE_ENGINE_DETECTION, AGSMetaEngineDetection);
|
