OpenTTD
script_scanner.cpp
Go to the documentation of this file.
1 /* $Id: script_scanner.cpp 26617 2014-05-25 19:53:46Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "../stdafx.h"
13 #include "../debug.h"
14 #include "../string_func.h"
15 #include "../settings_type.h"
16 
17 #include "../script/squirrel.hpp"
18 #include "script_scanner.hpp"
19 #include "script_info.hpp"
20 
21 #if defined(ENABLE_NETWORK)
22 #include "../network/network_content.h"
23 #include "../3rdparty/md5/md5.h"
24 #include "../tar_type.h"
25 #endif /* ENABLE_NETWORK */
26 
27 #include "../safeguards.h"
28 
29 bool ScriptScanner::AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
30 {
31  free(this->main_script);
32  this->main_script = stredup(filename);
33  if (this->main_script == NULL) return false;
34 
35  free(this->tar_file);
36  if (tar_filename != NULL) {
37  this->tar_file = stredup(tar_filename);
38  if (this->tar_file == NULL) return false;
39  } else {
40  this->tar_file = NULL;
41  }
42 
43  const char *end = this->main_script + strlen(this->main_script) + 1;
44  char *p = strrchr(this->main_script, PATHSEPCHAR);
45  if (p == NULL) {
46  p = this->main_script;
47  } else {
48  /* Skip over the path separator character. We don't need that. */
49  p++;
50  }
51 
52  strecpy(p, "main.nut", end);
53 
54  if (!FioCheckFileExists(filename, this->subdir) || !FioCheckFileExists(this->main_script, this->subdir)) return false;
55 
56  this->ResetEngine();
57  this->engine->LoadScript(filename);
58 
59  return true;
60 }
61 
62 ScriptScanner::ScriptScanner() :
63  engine(NULL),
64  main_script(NULL),
65  tar_file(NULL)
66 {
67 }
68 
70 {
71  this->engine->Reset();
72  this->engine->SetGlobalPointer(this);
73  this->RegisterAPI(this->engine);
74 }
75 
76 void ScriptScanner::Initialize(const char *name)
77 {
78  this->engine = new Squirrel(name);
79 
80  this->RescanDir();
81 
82  this->ResetEngine();
83 }
84 
85 ScriptScanner::~ScriptScanner()
86 {
87  this->Reset();
88 
89  free(this->main_script);
90  free(this->tar_file);
91  delete this->engine;
92 }
93 
95 {
96  /* Forget about older scans */
97  this->Reset();
98 
99  /* Scan for scripts */
100  this->Scan(this->GetFileName(), this->GetDirectory());
101 }
102 
104 {
105  ScriptInfoList::iterator it = this->info_list.begin();
106  for (; it != this->info_list.end(); it++) {
107  free((*it).first);
108  delete (*it).second;
109  }
110  it = this->info_single_list.begin();
111  for (; it != this->info_single_list.end(); it++) {
112  free((*it).first);
113  }
114 
115  this->info_list.clear();
116  this->info_single_list.clear();
117 }
118 
120 {
121  char script_original_name[1024];
122  this->GetScriptName(info, script_original_name, lastof(script_original_name));
123  strtolower(script_original_name);
124 
125  char script_name[1024];
126  seprintf(script_name, lastof(script_name), "%s.%d", script_original_name, info->GetVersion());
127 
128  /* Check if GetShortName follows the rules */
129  if (strlen(info->GetShortName()) != 4) {
130  DEBUG(script, 0, "The script '%s' returned a string from GetShortName() which is not four characaters. Unable to load the script.", info->GetName());
131  delete info;
132  return;
133  }
134 
135  if (this->info_list.find(script_name) != this->info_list.end()) {
136  /* This script was already registered */
137 #ifdef WIN32
138  /* Windows doesn't care about the case */
139  if (strcasecmp(this->info_list[script_name]->GetMainScript(), info->GetMainScript()) == 0) {
140 #else
141  if (strcmp(this->info_list[script_name]->GetMainScript(), info->GetMainScript()) == 0) {
142 #endif
143  delete info;
144  return;
145  }
146 
147  DEBUG(script, 1, "Registering two scripts with the same name and version");
148  DEBUG(script, 1, " 1: %s", this->info_list[script_name]->GetMainScript());
149  DEBUG(script, 1, " 2: %s", info->GetMainScript());
150  DEBUG(script, 1, "The first is taking precedence.");
151 
152  delete info;
153  return;
154  }
155 
156  this->info_list[stredup(script_name)] = info;
157 
159  /* Add the script to the 'unique' script list, where only the highest version
160  * of the script is registered. */
161  if (this->info_single_list.find(script_original_name) == this->info_single_list.end()) {
162  this->info_single_list[stredup(script_original_name)] = info;
163  } else if (this->info_single_list[script_original_name]->GetVersion() < info->GetVersion()) {
164  this->info_single_list[script_original_name] = info;
165  }
166  }
167 }
168 
169 char *ScriptScanner::GetConsoleList(char *p, const char *last, bool newest_only) const
170 {
171  p += seprintf(p, last, "List of %s:\n", this->GetScannerName());
172  const ScriptInfoList &list = newest_only ? this->info_single_list : this->info_list;
173  ScriptInfoList::const_iterator it = list.begin();
174  for (; it != list.end(); it++) {
175  ScriptInfo *i = (*it).second;
176  p += seprintf(p, last, "%10s (v%d): %s\n", i->GetName(), i->GetVersion(), i->GetDescription());
177  }
178  p += seprintf(p, last, "\n");
179 
180  return p;
181 }
182 
183 #if defined(ENABLE_NETWORK)
184 
187  byte md5sum[16];
189 
195  {
196  this->dir = dir;
197  memset(this->md5sum, 0, sizeof(this->md5sum));
198  }
199 
200  /* Add the file and calculate the md5 sum. */
201  virtual bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
202  {
203  Md5 checksum;
204  uint8 buffer[1024];
205  size_t len, size;
206  byte tmp_md5sum[16];
207 
208  /* Open the file ... */
209  FILE *f = FioFOpenFile(filename, "rb", this->dir, &size);
210  if (f == NULL) return false;
211 
212  /* ... calculate md5sum... */
213  while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {
214  size -= len;
215  checksum.Append(buffer, len);
216  }
217  checksum.Finish(tmp_md5sum);
218 
219  FioFCloseFile(f);
220 
221  /* ... and xor it to the overall md5sum. */
222  for (uint i = 0; i < sizeof(md5sum); i++) this->md5sum[i] ^= tmp_md5sum[i];
223 
224  return true;
225  }
226 };
227 
236 static bool IsSameScript(const ContentInfo *ci, bool md5sum, ScriptInfo *info, Subdirectory dir)
237 {
238  uint32 id = 0;
239  const char *str = info->GetShortName();
240  for (int j = 0; j < 4 && *str != '\0'; j++, str++) id |= *str << (8 * j);
241 
242  if (id != ci->unique_id) return false;
243  if (!md5sum) return true;
244 
245  ScriptFileChecksumCreator checksum(dir);
246  const char *tar_filename = info->GetTarFile();
247  TarList::iterator iter;
248  if (tar_filename != NULL && (iter = _tar_list[dir].find(tar_filename)) != _tar_list[dir].end()) {
249  /* The main script is in a tar file, so find all files that
250  * are in the same tar and add them to the MD5 checksumming. */
251  TarFileList::iterator tar;
252  FOR_ALL_TARS(tar, dir) {
253  /* Not in the same tar. */
254  if (tar->second.tar_filename != iter->first) continue;
255 
256  /* Check the extension. */
257  const char *ext = strrchr(tar->first.c_str(), '.');
258  if (ext == NULL || strcasecmp(ext, ".nut") != 0) continue;
259 
260  checksum.AddFile(tar->first.c_str(), 0, tar_filename);
261  }
262  } else {
263  char path[MAX_PATH];
264  strecpy(path, info->GetMainScript(), lastof(path));
265  /* There'll always be at least 1 path separator character in a script
266  * main script name as the search algorithm requires the main script to
267  * be in a subdirectory of the script directory; so <dir>/<path>/main.nut. */
268  *strrchr(path, PATHSEPCHAR) = '\0';
269  checksum.Scan(".nut", path);
270  }
271 
272  return memcmp(ci->md5sum, checksum.md5sum, sizeof(ci->md5sum)) == 0;
273 }
274 
275 bool ScriptScanner::HasScript(const ContentInfo *ci, bool md5sum)
276 {
277  for (ScriptInfoList::iterator it = this->info_list.begin(); it != this->info_list.end(); it++) {
278  if (IsSameScript(ci, md5sum, (*it).second, this->GetDirectory())) return true;
279  }
280  return false;
281 }
282 
283 const char *ScriptScanner::FindMainScript(const ContentInfo *ci, bool md5sum)
284 {
285  for (ScriptInfoList::iterator it = this->info_list.begin(); it != this->info_list.end(); it++) {
286  if (IsSameScript(ci, md5sum, (*it).second, this->GetDirectory())) return (*it).second->GetMainScript();
287  }
288  return NULL;
289 }
290 
291 #endif /* ENABLE_NETWORK */
int GetVersion() const
Get the version of the script.
Definition: script_info.hpp:74
const char * GetMainScript()
Get the current main script the ScanDir is currently tracking.
uint32 unique_id
Unique ID; either GRF ID or shortname.
Definition: tcp_content.h:77
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:110
void FioFCloseFile(FILE *f)
Close a file in a safe way.
Definition: fileio.cpp:342
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:398
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:1428
const char * GetName() const
Get the Name of the script.
Definition: script_info.hpp:59
std::map< const char *, class ScriptInfo *, StringCompare > ScriptInfoList
A list that maps AI names to their AIInfo object.
Definition: ai.hpp:21
const char * GetShortName() const
Get the 4 character long short name of the script.
Definition: script_info.hpp:64
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
bool strtolower(char *str)
Convert a given ASCII string to lowercase.
Definition: string.cpp:320
char * tar_file
If, which tar file the script was in.
Helper for scanning for files with a given name.
Definition: fileio_func.h:73
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:94
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:32
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
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:474
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:126
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:312
byte md5sum[16]
The MD5 checksum.
Definition: tcp_content.h:78
void RescanDir()
Rescan the script dir.
const char * GetDescription() const
Get the description of the script.
Definition: script_info.hpp:69
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
Subdirectory subdir
The current sub directory we are searching through.
Definition: fileio_func.h:75
bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
Add a file with the given filename.
GUISettings gui
settings related to the GUI
void Reset()
Completely reset the engine; start from scratch.
Definition: squirrel.cpp:548
void SetGlobalPointer(void *ptr)
Sets a pointer in the VM that is reachable from where ever you are in SQ.
Definition: squirrel.hpp:218
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:68
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:114
bool LoadScript(const char *script)
Load a script.
Definition: squirrel.cpp:531
const char * GetTarFile() const
Get the filename of the tar the script is in.
Definition: script_info.hpp:99
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:58
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, ...