OpenTTD Source 20261112-master-gbcbec5e63f
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "../stdafx.h"
11#include "../debug.h"
12#include "../string_func.h"
13#include "../settings_type.h"
14
16#include "script_scanner.hpp"
17#include "script_info.hpp"
18#include "script_fatalerror.hpp"
19
21#include "../3rdparty/md5/md5.h"
22#include "../tar_type.h"
23
24#include "../safeguards.h"
25
26bool 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(Facility::Script, Severity::Critical, "Fatal error '{}' when trying to load the script '{}'.", e.GetErrorMessage(), filename);
42 return false;
43 }
44 return true;
45}
46
47ScriptScanner::ScriptScanner() = default;
48
50{
51 this->engine->Reset();
52 this->engine->SetGlobalPointer(this);
53 this->RegisterAPI(*this->engine);
54}
55
56void ScriptScanner::Initialize(std::string_view name)
57{
58 this->engine = std::make_unique<Squirrel>(name);
59
60 this->RescanDir();
61
62 this->ResetEngine();
63}
64
66{
67 /* Forget about older scans */
68 this->Reset();
69
70 /* Scan for scripts */
71 this->Scan(this->GetFileName(), this->GetDirectory());
72}
73
75{
76 this->info_list.clear();
77 this->info_single_list.clear();
78 this->info_vector.clear();
79}
80
81void ScriptScanner::RegisterScript(std::unique_ptr<ScriptInfo> &&info)
82{
83 std::string script_original_name = this->GetScriptName(*info);
84 std::string script_name = fmt::format("{}.{}", script_original_name, info->GetVersion());
85
86 /* Check if GetShortName follows the rules */
87 if (info->GetShortName().size() != 4) {
88 Debug(Facility::Script, Severity::Critical, "The script '{}' returned a string from GetShortName() which is not four characters. Unable to load the script.", info->GetName());
89 return;
90 }
91
92 if (auto it = this->info_list.find(script_name); it != this->info_list.end()) {
93 /* This script was already registered */
94#ifdef _WIN32
95 /* Windows doesn't care about the case */
96 if (StrEqualsIgnoreCase(it->second->GetMainScript(), info->GetMainScript())) {
97#else
98 if (it->second->GetMainScript() == info->GetMainScript()) {
99#endif
100 return;
101 }
102
103 Debug(Facility::Script, Severity::Error, "Registering two scripts with the same name and version");
104 Debug(Facility::Script, Severity::Error, " 1: {}", it->second->GetMainScript());
105 Debug(Facility::Script, Severity::Error, " 2: {}", info->GetMainScript());
106 Debug(Facility::Script, Severity::Error, "The first is taking precedence.");
107
108 return;
109 }
110
111 ScriptInfo *script_info = this->info_vector.emplace_back(std::move(info)).get();
112 this->info_list[script_name] = script_info;
113
114 if (!script_info->IsDeveloperOnly() || _settings_client.gui.ai_developer_tools) {
115 /* Add the script to the 'unique' script list, where only the highest version
116 * of the script is registered. */
117 auto it = this->info_single_list.find(script_original_name);
118 if (it == this->info_single_list.end()) {
119 this->info_single_list[script_original_name] = script_info;
120 } else if (it->second->GetVersion() < script_info->GetVersion()) {
121 it->second = script_info;
122 }
123 }
124}
125
126void ScriptScanner::GetConsoleList(std::back_insert_iterator<std::string> &output_iterator, bool newest_only) const
127{
128 fmt::format_to(output_iterator, "List of {}:\n", this->GetScannerName());
129 const ScriptInfoList &list = newest_only ? this->info_single_list : this->info_list;
130 for (const auto &item : list) {
131 ScriptInfo *i = item.second;
132 fmt::format_to(output_iterator, "{:>10} (v{:d}): {}\n", i->GetName(), i->GetVersion(), i->GetDescription());
133 }
134 fmt::format_to(output_iterator, "\n");
135}
136
139 MD5Hash md5sum;
141
148
149 /* Add the file and calculate the md5 sum. */
150 bool AddFile(const std::string &filename, size_t, const std::string &) override
151 {
152 Md5 checksum;
153 uint8_t buffer[1024];
154 size_t len, size;
155
156 /* Open the file ... */
157 auto f = FioFOpenFile(filename, "rb", this->dir, &size);
158 if (!f.has_value()) return false;
159
160 /* ... calculate md5sum... */
161 while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, *f)) != 0 && size != 0) {
162 size -= len;
163 checksum.Append(buffer, len);
164 }
165
166 MD5Hash tmp_md5sum;
167 checksum.Finish(tmp_md5sum);
168
169 /* ... and xor it to the overall md5sum. */
170 this->md5sum ^= tmp_md5sum;
171
172 return true;
173 }
174};
175
185static bool IsSameScript(const ContentInfo &ci, bool md5sum, const ScriptInfo &info, Subdirectory dir)
186{
187 uint32_t id = 0;
188 auto str = std::string_view{info.GetShortName()}.substr(0, 4);
189 for (size_t j = 0; j < str.size(); j++) id |= static_cast<uint8_t>(str[j]) << (8 * j);
190
191 if (id != ci.unique_id) return false;
192 if (!md5sum) return true;
193
194 ScriptFileChecksumCreator checksum(dir);
195 const auto &tar_filename = info.GetTarFile();
196 TarList::iterator iter;
197 if (!tar_filename.empty() && (iter = _tar_list[dir].find(tar_filename)) != _tar_list[dir].end()) {
198 /* The main script is in a tar file, so find all files that
199 * are in the same tar and add them to the MD5 checksumming. */
200 for (const auto &tar : _tar_filelist[dir]) {
201 /* Not in the same tar. */
202 if (tar.second.tar_filename != iter->first) continue;
203
204 /* Check the extension. */
205 auto ext = tar.first.rfind('.');
206 if (ext == std::string_view::npos || !StrEqualsIgnoreCase(tar.first.substr(ext), ".nut")) continue;
207
208 checksum.AddFile(tar.first, 0, tar_filename);
209 }
210 } else {
211 /* There'll always be at least 1 path separator character in a script
212 * main script name as the search algorithm requires the main script to
213 * be in a subdirectory of the script directory; so <dir>/<path>/main.nut. */
214 const std::string &main_script = info.GetMainScript();
215 std::string path = main_script.substr(0, main_script.find_last_of(PATHSEPCHAR));
216 checksum.Scan(".nut", path);
217 }
218
219 return ci.md5sum == checksum.md5sum;
220}
221
222bool ScriptScanner::HasScript(const ContentInfo &ci, bool md5sum)
223{
224 for (const auto &item : this->info_list) {
225 if (IsSameScript(ci, md5sum, *item.second, this->GetDirectory())) return true;
226 }
227 return false;
228}
229
230std::optional<std::string_view> ScriptScanner::FindMainScript(const ContentInfo &ci, bool md5sum)
231{
232 for (const auto &item : this->info_list) {
233 if (IsSameScript(ci, md5sum, *item.second, this->GetDirectory())) return item.second->GetMainScript();
234 }
235 return std::nullopt;
236}
Helper for scanning for files with a given name.
Definition fileio_func.h:37
uint Scan(std::string_view extension, Subdirectory sd, bool tars=true, bool recursive=true)
Scan for files with the given extension in the given search path.
Definition fileio.cpp:1169
Subdirectory subdir
The current sub directory we are searching through.
Definition fileio_func.h:39
All static information from an Script like name, version, etc.
const std::string & GetName() const
Get the Name of the script.
const std::string & GetMainScript() const
Get the filename of the main.nut script.
const std::string & GetShortName() const
Get the 4 character long short name of the script.
int GetVersion() const
Get the version of the script.
const std::string & GetTarFile() const
Get the filename of the tar the script is in.
const std::string & GetDescription() const
Get the description of the script.
virtual bool IsDeveloperOnly() const
Can this script be selected by developers only?
bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) override
Add a file with the given filename.
virtual std::string_view GetScannerName() const =0
Get the type of the script, in plural.
std::vector< std::unique_ptr< ScriptInfo > > info_vector
The known ScriptInfo objects.
std::string tar_file
If, which tar file the script was in.
virtual void RegisterAPI(class Squirrel &engine)=0
Register the API for this ScriptInfo.
void Reset()
Reset all allocated lists.
virtual void Initialize()=0
Initialize the scanner by scanning for scripts and creating dummies if needed.
virtual std::string GetScriptName(ScriptInfo &info)=0
Get the script name how to store the script in memory.
void RescanDir()
Rescan the script dir.
virtual Subdirectory GetDirectory() const =0
Get the directory to scan in.
std::string main_script
The full path of the script.
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.
std::optional< std::string_view > FindMainScript(const ContentInfo &ci, bool md5sum)
Find a script of a ContentInfo.
virtual std::string_view GetFileName() const =0
Get the filename to scan for this type of script.
ScriptInfoList info_list
The list of all script.
ScriptInfoList info_single_list
The list of all unique script. The best script (highest version) is shown.
void RegisterScript(std::unique_ptr< class ScriptInfo > &&info)
Register a ScriptInfo to the scanner.
std::unique_ptr< class Squirrel > engine
The engine we're scanning with.
bool HasScript(const struct ContentInfo &ci, bool md5sum)
Check whether we have a script with the exact characteristics as ci.
void ResetEngine()
Reset the engine to ensure a clean environment for further steps.
A throw-class that is given when the script made a fatal error.
const std::string & GetErrorMessage() const
The error message associated with the fatal error.
Functions related to debugging.
#define Debug(facility, severity, format_string,...)
Output a line of debugging information.
Definition debug.h:36
@ Script
Script message facility.
Definition debug_type.h:38
@ Critical
Critical, user should know about this.
Definition debug_type.h:15
@ Error
Error, but we are recovering.
Definition debug_type.h:16
EnumIndexArray< TarFileList, Subdirectory, Subdirectory::End > _tar_filelist
List of files within tar files found in each subdirectory.
Definition fileio.cpp:69
std::optional< FileHandle > FioFOpenFile(std::string_view filename, std::string_view mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition fileio.cpp:248
EnumIndexArray< TarList, Subdirectory, Subdirectory::End > _tar_list
List of tar files found in each subdirectory.
Definition fileio.cpp:67
bool FioCheckFileExists(std::string_view filename, Subdirectory subdir)
Check whether the given file exists.
Definition fileio.cpp:122
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition fileio_type.h:87
Part of the network protocol handling content distribution.
A number of safeguards to prevent using unsafe methods.
The definition of Script_FatalError.
ScriptInfo keeps track of all information of a script, like Author, Description, ....
static bool IsSameScript(const ContentInfo &ci, bool md5sum, const ScriptInfo &info, Subdirectory dir)
Check whether the script given in info is the same as in ci based on the shortname and md5 sum.
Declarations of the class for the script scanner.
std::map< std::string, class ScriptInfo *, CaseInsensitiveComparator > ScriptInfoList
Type for the list of scripts.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Types related to global configuration settings.
Defines the Squirrel class.
Definition of base types and functions in a cross-platform compatible way.
bool StrEqualsIgnoreCase(std::string_view str1, std::string_view str2)
Compares two string( view)s for equality, while ignoring the case of the characters.
Definition string.cpp:324
Functions related to low-level strings.
Container for all important information about a piece of content.
uint32_t unique_id
Unique ID; either GRF ID or shortname.
MD5Hash md5sum
The MD5 checksum.
Helper for creating a MD5sum of all files within of a script.
MD5Hash md5sum
The final md5sum.
bool AddFile(const std::string &filename, size_t, const std::string &) override
Add a file with the given filename.
Subdirectory dir
The directory to look in.
ScriptFileChecksumCreator(Subdirectory dir)
Initialise the md5sum to be all zeroes, so we can easily xor the data.
Structs, typedefs and macros used for TAR file handling.