OpenTTD
script_scanner.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD 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, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../stdafx.h"
11 #include "../debug.h"
12 #include "../string_func.h"
13 #include "../settings_type.h"
14 
15 #include "../script/squirrel.hpp"
16 #include "script_scanner.hpp"
17 #include "script_info.hpp"
18 #include "script_fatalerror.hpp"
19 
20 #include "../network/network_content.h"
21 #include "../3rdparty/md5/md5.h"
22 #include "../tar_type.h"
23 
24 #include "../safeguards.h"
25 
26 bool ScriptScanner::AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
27 {
28  free(this->main_script);
29  this->main_script = stredup(filename);
30  if (this->main_script == nullptr) return false;
31 
32  free(this->tar_file);
33  if (tar_filename != nullptr) {
34  this->tar_file = stredup(tar_filename);
35  if (this->tar_file == nullptr) return false;
36  } else {
37  this->tar_file = nullptr;
38  }
39 
40  const char *end = this->main_script + strlen(this->main_script) + 1;
41  char *p = strrchr(this->main_script, PATHSEPCHAR);
42  if (p == nullptr) {
43  p = this->main_script;
44  } else {
45  /* Skip over the path separator character. We don't need that. */
46  p++;
47  }
48 
49  strecpy(p, "main.nut", end);
50 
51  if (!FioCheckFileExists(filename, this->subdir) || !FioCheckFileExists(this->main_script, this->subdir)) return false;
52 
53  this->ResetEngine();
54  try {
55  this->engine->LoadScript(filename);
56  } catch (Script_FatalError &e) {
57  DEBUG(script, 0, "Fatal error '%s' when trying to load the script '%s'.", e.GetErrorMessage(), filename);
58  return false;
59  }
60  return true;
61 }
62 
63 ScriptScanner::ScriptScanner() :
64  engine(nullptr),
65  main_script(nullptr),
66  tar_file(nullptr)
67 {
68 }
69 
71 {
72  this->engine->Reset();
73  this->engine->SetGlobalPointer(this);
74  this->RegisterAPI(this->engine);
75 }
76 
77 void ScriptScanner::Initialize(const char *name)
78 {
79  this->engine = new Squirrel(name);
80 
81  this->RescanDir();
82 
83  this->ResetEngine();
84 }
85 
86 ScriptScanner::~ScriptScanner()
87 {
88  this->Reset();
89 
90  free(this->main_script);
91  free(this->tar_file);
92  delete this->engine;
93 }
94 
96 {
97  /* Forget about older scans */
98  this->Reset();
99 
100  /* Scan for scripts */
101  this->Scan(this->GetFileName(), this->GetDirectory());
102 }
103 
105 {
106  ScriptInfoList::iterator it = this->info_list.begin();
107  for (; it != this->info_list.end(); it++) {
108  free((*it).first);
109  delete (*it).second;
110  }
111  it = this->info_single_list.begin();
112  for (; it != this->info_single_list.end(); it++) {
113  free((*it).first);
114  }
115 
116  this->info_list.clear();
117  this->info_single_list.clear();
118 }
119 
121 {
122  char script_original_name[1024];
123  this->GetScriptName(info, script_original_name, lastof(script_original_name));
124  strtolower(script_original_name);
125 
126  char script_name[1024];
127  seprintf(script_name, lastof(script_name), "%s.%d", script_original_name, info->GetVersion());
128 
129  /* Check if GetShortName follows the rules */
130  if (strlen(info->GetShortName()) != 4) {
131  DEBUG(script, 0, "The script '%s' returned a string from GetShortName() which is not four characaters. Unable to load the script.", info->GetName());
132  delete info;
133  return;
134  }
135 
136  if (this->info_list.find(script_name) != this->info_list.end()) {
137  /* This script was already registered */
138 #ifdef _WIN32
139  /* Windows doesn't care about the case */
140  if (strcasecmp(this->info_list[script_name]->GetMainScript(), info->GetMainScript()) == 0) {
141 #else
142  if (strcmp(this->info_list[script_name]->GetMainScript(), info->GetMainScript()) == 0) {
143 #endif
144  delete info;
145  return;
146  }
147 
148  DEBUG(script, 1, "Registering two scripts with the same name and version");
149  DEBUG(script, 1, " 1: %s", this->info_list[script_name]->GetMainScript());
150  DEBUG(script, 1, " 2: %s", info->GetMainScript());
151  DEBUG(script, 1, "The first is taking precedence.");
152 
153  delete info;
154  return;
155  }
156 
157  this->info_list[stredup(script_name)] = info;
158 
160  /* Add the script to the 'unique' script list, where only the highest version
161  * of the script is registered. */
162  if (this->info_single_list.find(script_original_name) == this->info_single_list.end()) {
163  this->info_single_list[stredup(script_original_name)] = info;
164  } else if (this->info_single_list[script_original_name]->GetVersion() < info->GetVersion()) {
165  this->info_single_list[script_original_name] = info;
166  }
167  }
168 }
169 
170 char *ScriptScanner::GetConsoleList(char *p, const char *last, bool newest_only) const
171 {
172  p += seprintf(p, last, "List of %s:\n", this->GetScannerName());
173  const ScriptInfoList &list = newest_only ? this->info_single_list : this->info_list;
174  ScriptInfoList::const_iterator it = list.begin();
175  for (; it != list.end(); it++) {
176  ScriptInfo *i = (*it).second;
177  p += seprintf(p, last, "%10s (v%d): %s\n", i->GetName(), i->GetVersion(), i->GetDescription());
178  }
179  p += seprintf(p, last, "\n");
180 
181  return p;
182 }
183 
186  byte md5sum[16];
188 
194  {
195  this->dir = dir;
196  memset(this->md5sum, 0, sizeof(this->md5sum));
197  }
198 
199  /* Add the file and calculate the md5 sum. */
200  virtual bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
201  {
202  Md5 checksum;
203  uint8 buffer[1024];
204  size_t len, size;
205  byte tmp_md5sum[16];
206 
207  /* Open the file ... */
208  FILE *f = FioFOpenFile(filename, "rb", this->dir, &size);
209  if (f == nullptr) return false;
210 
211  /* ... calculate md5sum... */
212  while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {
213  size -= len;
214  checksum.Append(buffer, len);
215  }
216  checksum.Finish(tmp_md5sum);
217 
218  FioFCloseFile(f);
219 
220  /* ... and xor it to the overall md5sum. */
221  for (uint i = 0; i < sizeof(md5sum); i++) this->md5sum[i] ^= tmp_md5sum[i];
222 
223  return true;
224  }
225 };
226 
235 static bool IsSameScript(const ContentInfo *ci, bool md5sum, ScriptInfo *info, Subdirectory dir)
236 {
237  uint32 id = 0;
238  const char *str = info->GetShortName();
239  for (int j = 0; j < 4 && *str != '\0'; j++, str++) id |= *str << (8 * j);
240 
241  if (id != ci->unique_id) return false;
242  if (!md5sum) return true;
243 
244  ScriptFileChecksumCreator checksum(dir);
245  const char *tar_filename = info->GetTarFile();
246  TarList::iterator iter;
247  if (tar_filename != nullptr && (iter = _tar_list[dir].find(tar_filename)) != _tar_list[dir].end()) {
248  /* The main script is in a tar file, so find all files that
249  * are in the same tar and add them to the MD5 checksumming. */
250  TarFileList::iterator tar;
251  FOR_ALL_TARS(tar, dir) {
252  /* Not in the same tar. */
253  if (tar->second.tar_filename != iter->first) continue;
254 
255  /* Check the extension. */
256  const char *ext = strrchr(tar->first.c_str(), '.');
257  if (ext == nullptr || strcasecmp(ext, ".nut") != 0) continue;
258 
259  checksum.AddFile(tar->first.c_str(), 0, tar_filename);
260  }
261  } else {
262  char path[MAX_PATH];
263  strecpy(path, info->GetMainScript(), lastof(path));
264  /* There'll always be at least 1 path separator character in a script
265  * main script name as the search algorithm requires the main script to
266  * be in a subdirectory of the script directory; so <dir>/<path>/main.nut. */
267  *strrchr(path, PATHSEPCHAR) = '\0';
268  checksum.Scan(".nut", path);
269  }
270 
271  return memcmp(ci->md5sum, checksum.md5sum, sizeof(ci->md5sum)) == 0;
272 }
273 
274 bool ScriptScanner::HasScript(const ContentInfo *ci, bool md5sum)
275 {
276  for (ScriptInfoList::iterator it = this->info_list.begin(); it != this->info_list.end(); it++) {
277  if (IsSameScript(ci, md5sum, (*it).second, this->GetDirectory())) return true;
278  }
279  return false;
280 }
281 
282 const char *ScriptScanner::FindMainScript(const ContentInfo *ci, bool md5sum)
283 {
284  for (ScriptInfoList::iterator it = this->info_list.begin(); it != this->info_list.end(); it++) {
285  if (IsSameScript(ci, md5sum, (*it).second, this->GetDirectory())) return (*it).second->GetMainScript();
286  }
287  return nullptr;
288 }
int GetVersion() const
Get the version of the script.
Definition: script_info.hpp:72
const char * GetMainScript()
Get the current main script the ScanDir is currently tracking.
bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename) override
Add a file with the given filename.
uint32 unique_id
Unique ID; either GRF ID or shortname.
Definition: tcp_content.h:73
virtual void RegisterAPI(class Squirrel *engine)=0
Register the API for this ScriptInfo.
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
void FioFCloseFile(FILE *f)
Close a file in a safe way.
Definition: fileio.cpp:332
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:407
uint Scan(const char *extension, Subdirectory sd, bool tars=true, bool recursive=true)
Scan for files with the given extension in the given search path.
Definition: fileio.cpp:1373
const char * GetName() const
Get the Name of the script.
Definition: script_info.hpp:57
std::map< const char *, class ScriptInfo *, StringCompare > ScriptInfoList
A list that maps AI names to their AIInfo object.
Definition: ai.hpp:19
The definition of Script_FatalError.
const char * GetShortName() const
Get the 4 character long short name of the script.
Definition: script_info.hpp:62
A throw-class that is given when the script made a fatal error.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:48
bool strtolower(char *str)
Convert a given ASCII string to lowercase.
Definition: string.cpp:330
char * tar_file
If, which tar file the script was in.
Helper for scanning for files with a given name.
Definition: fileio_func.h:70
const char * GetErrorMessage()
The error message associated with the fatal error.
Helper for creating a MD5sum of all files within of a script.
const char * GetMainScript() const
Get the filename of the main.nut script.
Definition: script_info.hpp:92
bool HasScript(const struct ContentInfo *ci, bool md5sum)
Check whether we have a script with the exact characteristics as ci.
void RegisterScript(class ScriptInfo *info)
Register a ScriptInfo to the scanner.
Subdirectory dir
The directory to look in.
virtual Subdirectory GetDirectory() const =0
Get the directory to scan in.
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
FILE * FioFOpenFile(const char *filename, const char *mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition: fileio.cpp:463
char * main_script
The full path of the script.
virtual bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
Add a file with the given filename.
virtual const char * GetFileName() const =0
Get the filename to scan for this type of script.
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:136
virtual void GetScriptName(ScriptInfo *info, char *name, const char *last)=0
Get the script name how to store the script in memory.
ScriptInfoList info_list
The list of all script.
bool ai_developer_tools
activate AI developer tools
bool FioCheckFileExists(const char *filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:310
byte md5sum[16]
The MD5 checksum.
Definition: tcp_content.h:74
void RescanDir()
Rescan the script dir.
const char * GetDescription() const
Get the description of the script.
Definition: script_info.hpp:67
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
Subdirectory subdir
The current sub directory we are searching through.
Definition: fileio_func.h:72
GUISettings gui
settings related to the GUI
void Reset()
Completely reset the engine; start from scratch.
Definition: squirrel.cpp:697
void SetGlobalPointer(void *ptr)
Sets a pointer in the VM that is reachable from where ever you are in SQ.
Definition: squirrel.hpp:221
void Reset()
Reset all allocated lists.
const char * FindMainScript(const ContentInfo *ci, bool md5sum)
Find a script of a ContentInfo.
Declarations of the class for the script scanner.
char * GetConsoleList(char *p, const char *last, bool newest_only) const
Get the list of registered scripts to print on the console.
ScriptFileChecksumCreator(Subdirectory dir)
Initialise the md5sum to be all zeroes, so we can easily xor the data.
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: depend.cpp:66
void ResetEngine()
Reset the engine to ensure a clean environment for further steps.
ScriptInfoList info_single_list
The list of all unique script. The best script (highest version) is shown.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:129
bool LoadScript(const char *script)
Load a script.
Definition: squirrel.cpp:678
const char * GetTarFile() const
Get the filename of the tar the script is in.
Definition: script_info.hpp:97
virtual bool IsDeveloperOnly() const
Can this script be selected by developers only?
byte md5sum[16]
The final md5sum.
static bool IsSameScript(const ContentInfo *ci, bool md5sum, ScriptInfo *info, Subdirectory dir)
Check whether the script given in info is the same as in ci based on the shortname and md5 sum...
Container for all important information about a piece of content.
Definition: tcp_content.h:54
virtual const char * GetScannerName() const =0
Get the type of the script, in plural.
class Squirrel * engine
The engine we&#39;re scanning with.
ScriptInfo keeps track of all information of a script, like Author, Description, ...