OpenTTD Source: src/script/script_scanner.cpp Source File

OpenTTD Source 14.0-beta3

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 std::string &filename, size_t, const std::string &tar_filename)
27 {
28 this->main_script = filename;
29 this->tar_file = tar_filename;
30
31 auto p = this->main_script.find_last_of(PATHSEPCHAR);
32 this->main_script.erase(p != std::string::npos ? p + 1 : 0);
33 this->main_script += "main.nut";
34
35 if (!FioCheckFileExists(filename, this->subdir) || !FioCheckFileExists(this->main_script, this->subdir)) return false;
36
37 this->ResetEngine();
38 try {
39 this->engine->LoadScript(filename);
40 } catch (Script_FatalError &e) {
41 Debug(script, 0, "Fatal error '{}' when trying to load the script '{}'.", e.GetErrorMessage(), filename);
42 return false;
43 }
44 return true;
45 }
46
47 ScriptScanner::ScriptScanner() :
48 engine(nullptr)
49 {
50 }
51
52 void ScriptScanner::ResetEngine()
53 {
54 this->engine->Reset();
55 this->engine->SetGlobalPointer(this);
56 this->RegisterAPI(this->engine);
57 }
58
59 void ScriptScanner::Initialize(const char *name)
60 {
61 this->engine = new Squirrel(name);
62
63 this->RescanDir();
64
65 this->ResetEngine();
66 }
67
68 ScriptScanner::~ScriptScanner()
69 {
70 this->Reset();
71
72 delete this->engine;
73 }
74
75 void ScriptScanner::RescanDir()
76 {
77 /* Forget about older scans */
78 this->Reset();
79
80 /* Scan for scripts */
81 this->Scan(this->GetFileName(), this->GetDirectory());
82 }
83
84 void ScriptScanner::Reset()
85 {
86 for (const auto &item : this->info_list) {
87 delete item.second;
88 }
89
90 this->info_list.clear();
91 this->info_single_list.clear();
92 }
93
94 void ScriptScanner::RegisterScript(ScriptInfo *info)
95 {
96 std::string script_original_name = this->GetScriptName(info);
97 std::string script_name = fmt::format("{}.{}", script_original_name, info->GetVersion());
98
99 /* Check if GetShortName follows the rules */
100 if (info->GetShortName().size() != 4) {
101 Debug(script, 0, "The script '{}' returned a string from GetShortName() which is not four characters. Unable to load the script.", info->GetName());
102 delete info;
103 return;
104 }
105
106 if (this->info_list.find(script_name) != this->info_list.end()) {
107 /* This script was already registered */
108 #ifdef _WIN32
109 /* Windows doesn't care about the case */
110 if (StrEqualsIgnoreCase(this->info_list[script_name]->GetMainScript(), info->GetMainScript())) {
111 #else
112 if (this->info_list[script_name]->GetMainScript() == info->GetMainScript()) {
113 #endif
114 delete info;
115 return;
116 }
117
118 Debug(script, 1, "Registering two scripts with the same name and version");
119 Debug(script, 1, " 1: {}", this->info_list[script_name]->GetMainScript());
120 Debug(script, 1, " 2: {}", info->GetMainScript());
121 Debug(script, 1, "The first is taking precedence.");
122
123 delete info;
124 return;
125 }
126
127 this->info_list[script_name] = info;
128
129 if (!info->IsDeveloperOnly() || _settings_client.gui.ai_developer_tools) {
130 /* Add the script to the 'unique' script list, where only the highest version
131 * of the script is registered. */
132 auto it = this->info_single_list.find(script_original_name);
133 if (it == this->info_single_list.end()) {
134 this->info_single_list[script_original_name] = info;
135 } else if (it->second->GetVersion() < info->GetVersion()) {
136 it->second = info;
137 }
138 }
139 }
140
141 void ScriptScanner::GetConsoleList(std::back_insert_iterator<std::string> &output_iterator, bool newest_only) const
142 {
143 fmt::format_to(output_iterator, "List of {}:\n", this->GetScannerName());
144 const ScriptInfoList &list = newest_only ? this->info_single_list : this->info_list;
145 for (const auto &item : list) {
146 ScriptInfo *i = item.second;
147 fmt::format_to(output_iterator, "{:>10} (v{:d}): {}\n", i->GetName(), i->GetVersion(), i->GetDescription());
148 }
149 fmt::format_to(output_iterator, "\n");
150 }
151
153 struct ScriptFileChecksumCreator : FileScanner {
154 MD5Hash md5sum;
155 Subdirectory dir;
156
161 ScriptFileChecksumCreator(Subdirectory dir) : dir(dir) {}
162
163 /* Add the file and calculate the md5 sum. */
164 bool AddFile(const std::string &filename, size_t, const std::string &) override
165 {
166 Md5 checksum;
167 uint8_t buffer[1024];
168 size_t len, size;
169
170 /* Open the file ... */
171 FILE *f = FioFOpenFile(filename, "rb", this->dir, &size);
172 if (f == nullptr) return false;
173
174 /* ... calculate md5sum... */
175 while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {
176 size -= len;
177 checksum.Append(buffer, len);
178 }
179
180 MD5Hash tmp_md5sum;
181 checksum.Finish(tmp_md5sum);
182
183 FioFCloseFile(f);
184
185 /* ... and xor it to the overall md5sum. */
186 this->md5sum ^= tmp_md5sum;
187
188 return true;
189 }
190 };
191
200 static bool IsSameScript(const ContentInfo *ci, bool md5sum, ScriptInfo *info, Subdirectory dir)
201 {
202 uint32_t id = 0;
203 const char *str = info->GetShortName().c_str();
204 for (int j = 0; j < 4 && *str != '\0'; j++, str++) id |= *str << (8 * j);
205
206 if (id != ci->unique_id) return false;
207 if (!md5sum) return true;
208
209 ScriptFileChecksumCreator checksum(dir);
210 auto tar_filename = info->GetTarFile();
211 TarList::iterator iter;
212 if (!tar_filename.empty() && (iter = _tar_list[dir].find(tar_filename)) != _tar_list[dir].end()) {
213 /* The main script is in a tar file, so find all files that
214 * are in the same tar and add them to the MD5 checksumming. */
215 for (const auto &tar : _tar_filelist[dir]) {
216 /* Not in the same tar. */
217 if (tar.second.tar_filename != iter->first) continue;
218
219 /* Check the extension. */
220 const char *ext = strrchr(tar.first.c_str(), '.');
221 if (ext == nullptr || !StrEqualsIgnoreCase(ext, ".nut")) continue;
222
223 checksum.AddFile(tar.first, 0, tar_filename);
224 }
225 } else {
226 /* There'll always be at least 1 path separator character in a script
227 * main script name as the search algorithm requires the main script to
228 * be in a subdirectory of the script directory; so <dir>/<path>/main.nut. */
229 const std::string &main_script = info->GetMainScript();
230 std::string path = main_script.substr(0, main_script.find_last_of(PATHSEPCHAR));
231 checksum.Scan(".nut", path);
232 }
233
234 return ci->md5sum == checksum.md5sum;
235 }
236
237 bool ScriptScanner::HasScript(const ContentInfo *ci, bool md5sum)
238 {
239 for (const auto &item : this->info_list) {
240 if (IsSameScript(ci, md5sum, item.second, this->GetDirectory())) return true;
241 }
242 return false;
243 }
244
245 const char *ScriptScanner::FindMainScript(const ContentInfo *ci, bool md5sum)
246 {
247 for (const auto &item : this->info_list) {
248 if (IsSameScript(ci, md5sum, item.second, this->GetDirectory())) return item.second->GetMainScript().c_str();
249 }
250 return nullptr;
251 }
ScriptInfoList
std::map< std::string, class ScriptInfo *, CaseInsensitiveComparator > ScriptInfoList
Type for the list of scripts.
Definition: script_scanner.hpp:16
ScriptFileChecksumCreator
Helper for creating a MD5sum of all files within of a script.
Definition: script_scanner.cpp:153
ScriptScanner::engine
class Squirrel * engine
The engine we're scanning with.
Definition: script_scanner.hpp:87
ScriptFileChecksumCreator::ScriptFileChecksumCreator
ScriptFileChecksumCreator(Subdirectory dir)
Initialise the md5sum to be all zeroes, so we can easily xor the data.
Definition: script_scanner.cpp:161
ScriptScanner::GetMainScript
std::string GetMainScript()
Get the current main script the ScanDir is currently tracking.
Definition: script_scanner.hpp:34
FileScanner::Scan
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:1210
ScriptScanner::RegisterAPI
virtual void RegisterAPI(class Squirrel *engine)=0
Register the API for this ScriptInfo.
ScriptScanner::GetConsoleList
void GetConsoleList(std::back_insert_iterator< std::string > &output_iterator, bool newest_only) const
Get the list of registered scripts to print on the console.
Definition: script_scanner.cpp:141
ScriptInfo::GetMainScript
const std::string & GetMainScript() const
Get the filename of the main.nut script.
Definition: script_info.hpp:81
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
ScriptScanner::tar_file
std::string tar_file
If, which tar file the script was in.
Definition: script_scanner.hpp:89
Squirrel::Reset
void Reset()
Completely reset the engine; start from scratch.
Definition: squirrel.cpp:761
ScriptScanner::GetScriptName
virtual std::string GetScriptName(ScriptInfo *info)=0
Get the script name how to store the script in memory.
Script_FatalError::GetErrorMessage
const std::string & GetErrorMessage() const
The error message associated with the fatal error.
Definition: script_fatalerror.hpp:30
ContentInfo::md5sum
MD5Hash md5sum
The MD5 checksum.
Definition: tcp_content_type.h:72
ScriptInfo::IsDeveloperOnly
virtual bool IsDeveloperOnly() const
Can this script be selected by developers only?
Definition: script_info.hpp:136
ScriptScanner::RescanDir
void RescanDir()
Rescan the script dir.
Definition: script_scanner.cpp:75
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
ScriptScanner::ResetEngine
void ResetEngine()
Reset the engine to ensure a clean environment for further steps.
Definition: script_scanner.cpp:52
Squirrel
Definition: squirrel.hpp:23
GUISettings::ai_developer_tools
bool ai_developer_tools
activate AI/GS developer tools
Definition: settings_type.h:217
ScriptScanner::GetFileName
virtual const char * GetFileName() const =0
Get the filename to scan for this type of script.
FioFOpenFile
FILE * FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition: fileio.cpp:263
ContentInfo
Container for all important information about a piece of content.
Definition: tcp_content_type.h:52
ScriptScanner::AddFile
bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) override
Add a file with the given filename.
Definition: script_scanner.cpp:26
Squirrel::SetGlobalPointer
void SetGlobalPointer(void *ptr)
Sets a pointer in the VM that is reachable from where ever you are in SQ.
Definition: squirrel.hpp:221
ScriptInfo::GetName
const std::string & GetName() const
Get the Name of the script.
Definition: script_info.hpp:46
FileScanner::subdir
Subdirectory subdir
The current sub directory we are searching through.
Definition: fileio_func.h:39
ScriptScanner::main_script
std::string main_script
The full path of the script.
Definition: script_scanner.hpp:88
ScriptInfo::GetDescription
const std::string & GetDescription() const
Get the description of the script.
Definition: script_info.hpp:56
Squirrel::LoadScript
bool LoadScript(const std::string &script)
Load a script.
Definition: squirrel.cpp:731
ScriptScanner::HasScript
bool HasScript(const struct ContentInfo *ci, bool md5sum)
Check whether we have a script with the exact characteristics as ci.
Definition: script_scanner.cpp:237
ScriptScanner::info_list
ScriptInfoList info_list
The list of all script.
Definition: script_scanner.hpp:91
FioCheckFileExists
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:126
ScriptScanner::GetScannerName
virtual const char * GetScannerName() const =0
Get the type of the script, in plural.
ScriptScanner::RegisterScript
void RegisterScript(class ScriptInfo *info)
Register a ScriptInfo to the scanner.
Definition: script_scanner.cpp:94
ScriptInfo::GetVersion
int GetVersion() const
Get the version of the script.
Definition: script_info.hpp:61
ScriptScanner::Reset
void Reset()
Reset all allocated lists.
Definition: script_scanner.cpp:84
script_info.hpp
ScriptScanner::GetDirectory
virtual Subdirectory GetDirectory() const =0
Get the directory to scan in.
script_scanner.hpp
StrEqualsIgnoreCase
bool StrEqualsIgnoreCase(const std::string_view str1, const std::string_view str2)
Compares two string( view)s for equality, while ignoring the case of the characters.
Definition: string.cpp:366
ScriptInfo::GetTarFile
const std::string & GetTarFile() const
Get the filename of the tar the script is in.
Definition: script_info.hpp:86
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
Script_FatalError
A throw-class that is given when the script made a fatal error.
Definition: script_fatalerror.hpp:16
ScriptInfo::GetShortName
const std::string & GetShortName() const
Get the 4 character long short name of the script.
Definition: script_info.hpp:51
ScriptFileChecksumCreator::dir
Subdirectory dir
The directory to look in.
Definition: script_scanner.cpp:155
script_fatalerror.hpp
FileScanner
Helper for scanning for files with a given name.
Definition: fileio_func.h:37
ScriptFileChecksumCreator::md5sum
MD5Hash md5sum
The final md5sum.
Definition: script_scanner.cpp:154
ScriptScanner::FindMainScript
const char * FindMainScript(const ContentInfo *ci, bool md5sum)
Find a script of a ContentInfo.
Definition: script_scanner.cpp:245
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
IsSameScript
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.
Definition: script_scanner.cpp:200
ScriptScanner::info_single_list
ScriptInfoList info_single_list
The list of all unique script. The best script (highest version) is shown.
Definition: script_scanner.hpp:92
ContentInfo::unique_id
uint32_t unique_id
Unique ID; either GRF ID or shortname.
Definition: tcp_content_type.h:71
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:636
FioFCloseFile
void FioFCloseFile(FILE *f)
Close a file in a safe way.
Definition: fileio.cpp:148
ScriptFileChecksumCreator::AddFile
bool AddFile(const std::string &filename, size_t, const std::string &) override
Add a file with the given filename.
Definition: script_scanner.cpp:164