src/newgrf_config.cpp

   1 /* $Id: newgrf_config.cpp 26070 2013-11-23 18:11:01Z 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
  10 /** @file newgrf_config.cpp Finding NewGRFs and configuring them. */
  11
  12 #include "stdafx.h"
  13 #include "debug.h"
  14 #include "3rdparty/md5/md5.h"
  15 #include "newgrf.h"
  16 #include "network/network_func.h"
  17 #include "gfx_func.h"
  18 #include "newgrf_text.h"
  19 #include "window_func.h"
  20 #include "progress.h"
  21 #include "video/video_driver.hpp"
  22 #include "strings_func.h"
  23 #include "textfile_gui.h"
  24
  25 #include "fileio_func.h"
  26 #include "fios.h"
  27
  28 #include "safeguards.h"
  29
  30 /** Create a new GRFTextWrapper. */
  31 GRFTextWrapper::GRFTextWrapper() :
  32         text(NULL)
  33 {
  34 }
  35
  36 /** Cleanup a GRFTextWrapper object. */
  37 GRFTextWrapper::~GRFTextWrapper()
  38 {
  39         CleanUpGRFText(this->text);
  40 }
  41
  42 /**
  43  * Create a new GRFConfig.
  44  * @param filename Set the filename of this GRFConfig to filename. The argument
  45  *   is copied so the original string isn't needed after the constructor.
  46  */
  47 GRFConfig::GRFConfig(const char *filename) :
  48         name(new GRFTextWrapper()),
  49         info(new GRFTextWrapper()),
  50         url(new GRFTextWrapper()),
  51         num_valid_params(lengthof(param))
  52 {
  53         if (filename != NULL) this->filename = stredup(filename);
  54         this->name->AddRef();
  55         this->info->AddRef();
  56         this->url->AddRef();
  57 }
  58
  59 /**
  60  * Create a new GRFConfig that is a deep copy of an existing config.
  61  * @param config The GRFConfig object to make a copy of.
  62  */
  63 GRFConfig::GRFConfig(const GRFConfig &config) :
  64         ZeroedMemoryAllocator(),
  65         ident(config.ident),
  66         name(config.name),
  67         info(config.info),
  68         url(config.url),
  69         version(config.version),
  70         min_loadable_version(config.min_loadable_version),
  71         flags(config.flags & ~(1 << GCF_COPY)),
  72         status(config.status),
  73         grf_bugs(config.grf_bugs),
  74         num_params(config.num_params),
  75         num_valid_params(config.num_valid_params),
  76         palette(config.palette),
  77         has_param_defaults(config.has_param_defaults)
  78 {
  79         MemCpyT<uint8>(this->original_md5sum, config.original_md5sum, lengthof(this->original_md5sum));
  80         MemCpyT<uint32>(this->param, config.param, lengthof(this->param));
  81         if (config.filename != NULL) this->filename = stredup(config.filename);
  82         this->name->AddRef();
  83         this->info->AddRef();
  84         this->url->AddRef();
  85         if (config.error != NULL) this->error = new GRFError(*config.error);
  86         for (uint i = 0; i < config.param_info.Length(); i++) {
  87                 if (config.param_info[i] == NULL) {
  88                         *this->param_info.Append() = NULL;
  89                 } else {
  90                         *this->param_info.Append() = new GRFParameterInfo(*config.param_info[i]);
  91                 }
  92         }
  93 }
  94
  95 /** Cleanup a GRFConfig object. */
  96 GRFConfig::~GRFConfig()
  97 {
  98         /* GCF_COPY as in NOT stredupped/alloced the filename */
  99         if (!HasBit(this->flags, GCF_COPY)) {
 100                 free(this->filename);
 101                 delete this->error;
 102         }
 103         this->name->Release();
 104         this->info->Release();
 105         this->url->Release();
 106
 107         for (uint i = 0; i < this->param_info.Length(); i++) delete this->param_info[i];
 108 }
 109
 110 /**
 111  * Copy the parameter information from the \a src config.
 112  * @param src Source config.
 113  */
 114 void GRFConfig::CopyParams(const GRFConfig &src)
 115 {
 116         this->num_params = src.num_params;
 117         this->num_valid_params = src.num_valid_params;
 118         MemCpyT<uint32>(this->param, src.param, lengthof(this->param));
 119 }
 120
 121 /**
 122  * Get the name of this grf. In case the name isn't known
 123  * the filename is returned.
 124  * @return The name of filename of this grf.
 125  */
 126 const char *GRFConfig::GetName() const
 127 {
 128         const char *name = GetGRFStringFromGRFText(this->name->text);
 129         return StrEmpty(name) ? this->filename : name;
 130 }
 131
 132 /**
 133  * Get the grf info.
 134  * @return A string with a description of this grf.
 135  */
 136 const char *GRFConfig::GetDescription() const
 137 {
 138         return GetGRFStringFromGRFText(this->info->text);
 139 }
 140
 141 /**
 142  * Get the grf url.
 143  * @return A string with an url of this grf.
 144  */
 145 const char *GRFConfig::GetURL() const
 146 {
 147         return GetGRFStringFromGRFText(this->url->text);
 148 }
 149
 150 /** Set the default value for all parameters as specified by action14. */
 151 void GRFConfig::SetParameterDefaults()
 152 {
 153         this->num_params = 0;
 154         MemSetT<uint32>(this->param, 0, lengthof(this->param));
 155
 156         if (!this->has_param_defaults) return;
 157
 158         for (uint i = 0; i < this->param_info.Length(); i++) {
 159                 if (this->param_info[i] == NULL) continue;
 160                 this->param_info[i]->SetValue(this, this->param_info[i]->def_value);
 161         }
 162 }
 163
 164 /**
 165  * Set the palette of this GRFConfig to something suitable.
 166  * That is either the setting coming from the NewGRF or
 167  * the globally used palette.
 168  */
 169 void GRFConfig::SetSuitablePalette()
 170 {
 171         PaletteType pal;
 172         switch (this->palette & GRFP_GRF_MASK) {
 173                 case GRFP_GRF_DOS:     pal = PAL_DOS;      break;
 174                 case GRFP_GRF_WINDOWS: pal = PAL_WINDOWS;  break;
 175                 default:               pal = _settings_client.gui.newgrf_default_palette == 1 ? PAL_WINDOWS : PAL_DOS; break;
 176         }
 177         SB(this->palette, GRFP_USE_BIT, 1, pal == PAL_WINDOWS ? GRFP_USE_WINDOWS : GRFP_USE_DOS);
 178 }
 179
 180 /**
 181  * Finalize Action 14 info after file scan is finished.
 182  */
 183 void GRFConfig::FinalizeParameterInfo()
 184 {
 185         for (GRFParameterInfo **info = this->param_info.Begin(); info != this->param_info.End(); ++info) {
 186                 if (*info == NULL) continue;
 187                 (*info)->Finalize();
 188         }
 189 }
 190
 191 GRFConfig *_all_grfs;
 192 GRFConfig *_grfconfig;
 193 GRFConfig *_grfconfig_newgame;
 194 GRFConfig *_grfconfig_static;
 195 uint _missing_extra_graphics = 0;
 196
 197 bool _grf_bug_too_many_strings = false;
 198
 199 /**
 200  * Construct a new GRFError.
 201  * @param severity The severity of this error.
 202  * @param message The actual error-string.
 203  */
 204 GRFError::GRFError(StringID severity, StringID message) :
 205         message(message),
 206         severity(severity)
 207 {
 208 }
 209
 210 /**
 211  * Create a new GRFError that is a deep copy of an existing error message.
 212  * @param error The GRFError object to make a copy of.
 213  */
 214 GRFError::GRFError(const GRFError &error) :
 215         ZeroedMemoryAllocator(),
 216         custom_message(error.custom_message),
 217         data(error.data),
 218         message(error.message),
 219         severity(error.severity)
 220 {
 221         if (error.custom_message != NULL) this->custom_message = stredup(error.custom_message);
 222         if (error.data           != NULL) this->data           = stredup(error.data);
 223         memcpy(this->param_value, error.param_value, sizeof(this->param_value));
 224 }
 225
 226 GRFError::~GRFError()
 227 {
 228         free(this->custom_message);
 229         free(this->data);
 230 }
 231
 232 /**
 233  * Create a new empty GRFParameterInfo object.
 234  * @param nr The newgrf parameter that is changed.
 235  */
 236 GRFParameterInfo::GRFParameterInfo(uint nr) :
 237         name(NULL),
 238         desc(NULL),
 239         type(PTYPE_UINT_ENUM),
 240         min_value(0),
 241         max_value(UINT32_MAX),
 242         def_value(0),
 243         param_nr(nr),
 244         first_bit(0),
 245         num_bit(32),
 246         complete_labels(false)
 247 {}
 248
 249 /**
 250  * Create a new GRFParameterInfo object that is a deep copy of an existing
 251  *   parameter info object.
 252  * @param info The GRFParameterInfo object to make a copy of.
 253  */
 254 GRFParameterInfo::GRFParameterInfo(GRFParameterInfo &info) :
 255         name(DuplicateGRFText(info.name)),
 256         desc(DuplicateGRFText(info.desc)),
 257         type(info.type),
 258         min_value(info.min_value),
 259         max_value(info.max_value),
 260         def_value(info.def_value),
 261         param_nr(info.param_nr),
 262         first_bit(info.first_bit),
 263         num_bit(info.num_bit),
 264         complete_labels(info.complete_labels)
 265 {
 266         for (uint i = 0; i < info.value_names.Length(); i++) {
 267                 SmallPair<uint32, GRFText *> *data = info.value_names.Get(i);
 268                 this->value_names.Insert(data->first, DuplicateGRFText(data->second));
 269         }
 270 }
 271
 272 /** Cleanup all parameter info. */
 273 GRFParameterInfo::~GRFParameterInfo()
 274 {
 275         CleanUpGRFText(this->name);
 276         CleanUpGRFText(this->desc);
 277         for (uint i = 0; i < this->value_names.Length(); i++) {
 278                 SmallPair<uint32, GRFText *> *data = this->value_names.Get(i);
 279                 CleanUpGRFText(data->second);
 280         }
 281 }
 282
 283 /**
 284  * Get the value of this user-changeable parameter from the given config.
 285  * @param config The GRFConfig to get the value from.
 286  * @return The value of this parameter.
 287  */
 288 uint32 GRFParameterInfo::GetValue(struct GRFConfig *config) const
 289 {
 290         /* GB doesn't work correctly with nbits == 32, so handle that case here. */
 291         if (this->num_bit == 32) return config->param[this->param_nr];
 292         return GB(config->param[this->param_nr], this->first_bit, this->num_bit);
 293 }
 294
 295 /**
 296  * Set the value of this user-changeable parameter in the given config.
 297  * @param config The GRFConfig to set the value in.
 298  * @param value The new value.
 299  */
 300 void GRFParameterInfo::SetValue(struct GRFConfig *config, uint32 value)
 301 {
 302         /* SB doesn't work correctly with nbits == 32, so handle that case here. */
 303         if (this->num_bit == 32) {
 304                 config->param[this->param_nr] = value;
 305         } else {
 306                 SB(config->param[this->param_nr], this->first_bit, this->num_bit, value);
 307         }
 308         config->num_params = max<uint>(config->num_params, this->param_nr + 1);
 309         SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
 310 }
 311
 312 /**
 313  * Finalize Action 14 info after file scan is finished.
 314  */
 315 void GRFParameterInfo::Finalize()
 316 {
 317         this->complete_labels = true;
 318         for (uint32 value = this->min_value; value <= this->max_value; value++) {
 319                 if (!this->value_names.Contains(value)) {
 320                         this->complete_labels = false;
 321                         break;
 322                 }
 323         }
 324 }
 325
 326 /**
 327  * Update the palettes of the graphics from the config file.
 328  * Called when changing the default palette in advanced settings.
 329  * @param p1 Unused.
 330  * @return Always true.
 331  */
 332 bool UpdateNewGRFConfigPalette(int32 p1)
 333 {
 334         for (GRFConfig *c = _grfconfig_newgame; c != NULL; c = c->next) c->SetSuitablePalette();
 335         for (GRFConfig *c = _grfconfig_static;  c != NULL; c = c->next) c->SetSuitablePalette();
 336         for (GRFConfig *c = _all_grfs;          c != NULL; c = c->next) c->SetSuitablePalette();
 337         return true;
 338 }
 339
 340 /**
 341  * Get the data section size of a GRF.
 342  * @param f GRF.
 343  * @return Size of the data section or SIZE_MAX if the file has no separate data section.
 344  */
 345 size_t GRFGetSizeOfDataSection(FILE *f)
 346 {
 347         extern const byte _grf_cont_v2_sig[];
 348         static const uint header_len = 14;
 349
 350         byte data[header_len];
 351         if (fread(data, 1, header_len, f) == header_len) {
 352                 if (data[0] == 0 && data[1] == 0 && MemCmpT(data + 2, _grf_cont_v2_sig, 8) == 0) {
 353                         /* Valid container version 2, get data section size. */
 354                         size_t offset = ((size_t)data[13] << 24) | ((size_t)data[12] << 16) | ((size_t)data[11] << 8) | (size_t)data[10];
 355                         if (offset >= 1 * 1024 * 1024 * 1024) {
 356                                 DEBUG(grf, 0, "Unexpectedly large offset for NewGRF");
 357                                 /* Having more than 1 GiB of data is very implausible. Mostly because then
 358                                  * all pools in OpenTTD are flooded already. Or it's just Action C all over.
 359                                  * In any case, the offsets to graphics will likely not work either. */
 360                                 return SIZE_MAX;
 361                         }
 362                         return header_len + offset;
 363                 }
 364         }
 365
 366         return SIZE_MAX;
 367 }
 368
 369 /**
 370  * Calculate the MD5 sum for a GRF, and store it in the config.
 371  * @param config GRF to compute.
 372  * @param subdir The subdirectory to look in.
 373  * @return MD5 sum was successfully computed
 374  */
 375 static bool CalcGRFMD5Sum(GRFConfig *config, Subdirectory subdir)
 376 {
 377         FILE *f;
 378         Md5 checksum;
 379         uint8 buffer[1024];
 380         size_t len, size;
 381
 382         /* open the file */
 383         f = FioFOpenFile(config->filename, "rb", subdir, &size);
 384         if (f == NULL) return false;
 385
 386         long start = ftell(f);
 387         size = min(size, GRFGetSizeOfDataSection(f));
 388
 389         if (start < 0 || fseek(f, start, SEEK_SET) < 0) {
 390                 FioFCloseFile(f);
 391                 return false;
 392         }
 393
 394         /* calculate md5sum */
 395         while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {
 396                 size -= len;
 397                 checksum.Append(buffer, len);
 398         }
 399         checksum.Finish(config->ident.md5sum);
 400
 401         FioFCloseFile(f);
 402
 403         return true;
 404 }
 405
 406
 407 /**
 408  * Find the GRFID of a given grf, and calculate its md5sum.
 409  * @param config    grf to fill.
 410  * @param is_static grf is static.
 411  * @param subdir    the subdirectory to search in.
 412  * @return Operation was successfully completed.
 413  */
 414 bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir)
 415 {
 416         if (!FioCheckFileExists(config->filename, subdir)) {
 417                 config->status = GCS_NOT_FOUND;
 418                 return false;
 419         }
 420
 421         /* Find and load the Action 8 information */
 422         LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN, subdir);
 423         config->SetSuitablePalette();
 424         config->FinalizeParameterInfo();
 425
 426         /* Skip if the grfid is 0 (not read) or if it is an internal GRF */
 427         if (config->ident.grfid == 0 || HasBit(config->flags, GCF_SYSTEM)) return false;
 428
 429         if (is_static) {
 430                 /* Perform a 'safety scan' for static GRFs */
 431                 LoadNewGRFFile(config, CONFIG_SLOT, GLS_SAFETYSCAN, subdir);
 432
 433                 /* GCF_UNSAFE is set if GLS_SAFETYSCAN finds unsafe actions */
 434                 if (HasBit(config->flags, GCF_UNSAFE)) return false;
 435         }
 436
 437         return CalcGRFMD5Sum(config, subdir);
 438 }
 439
 440
 441 /**
 442  * Clear a GRF Config list, freeing all nodes.
 443  * @param config Start of the list.
 444  * @post \a config is set to \c NULL.
 445  */
 446 void ClearGRFConfigList(GRFConfig **config)
 447 {
 448         GRFConfig *c, *next;
 449         for (c = *config; c != NULL; c = next) {
 450                 next = c->next;
 451                 delete c;
 452         }
 453         *config = NULL;
 454 }
 455
 456
 457 /**
 458  * Copy a GRF Config list
 459  * @param dst pointer to destination list
 460  * @param src pointer to source list values
 461  * @param init_only the copied GRF will be processed up to GLS_INIT
 462  * @return pointer to the last value added to the destination list
 463  */
 464 GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only)
 465 {
 466         /* Clear destination as it will be overwritten */
 467         ClearGRFConfigList(dst);
 468         for (; src != NULL; src = src->next) {
 469                 GRFConfig *c = new GRFConfig(*src);
 470
 471                 ClrBit(c->flags, GCF_INIT_ONLY);
 472                 if (init_only) SetBit(c->flags, GCF_INIT_ONLY);
 473
 474                 *dst = c;
 475                 dst = &c->next;
 476         }
 477
 478         return dst;
 479 }
 480
 481 /**
 482  * Removes duplicates from lists of GRFConfigs. These duplicates
 483  * are introduced when the _grfconfig_static GRFs are appended
 484  * to the _grfconfig on a newgame or savegame. As the parameters
 485  * of the static GRFs could be different that the parameters of
 486  * the ones used non-statically. This can result in desyncs in
 487  * multiplayers, so the duplicate static GRFs have to be removed.
 488  *
 489  * This function _assumes_ that all static GRFs are placed after
 490  * the non-static GRFs.
 491  *
 492  * @param list the list to remove the duplicates from
 493  */
 494 static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)
 495 {
 496         GRFConfig *prev;
 497         GRFConfig *cur;
 498
 499         if (list == NULL) return;
 500
 501         for (prev = list, cur = list->next; cur != NULL; prev = cur, cur = cur->next) {
 502                 if (cur->ident.grfid != list->ident.grfid) continue;
 503
 504                 prev->next = cur->next;
 505                 delete cur;
 506                 cur = prev; // Just go back one so it continues as normal later on
 507         }
 508
 509         RemoveDuplicatesFromGRFConfigList(list->next);
 510 }
 511
 512 /**
 513  * Appends the static GRFs to a list of GRFs
 514  * @param dst the head of the list to add to
 515  */
 516 void AppendStaticGRFConfigs(GRFConfig **dst)
 517 {
 518         GRFConfig **tail = dst;
 519         while (*tail != NULL) tail = &(*tail)->next;
 520
 521         CopyGRFConfigList(tail, _grfconfig_static, false);
 522         RemoveDuplicatesFromGRFConfigList(*dst);
 523 }
 524
 525 /**
 526  * Appends an element to a list of GRFs
 527  * @param dst the head of the list to add to
 528  * @param el the new tail to be
 529  */
 530 void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el)
 531 {
 532         GRFConfig **tail = dst;
 533         while (*tail != NULL) tail = &(*tail)->next;
 534         *tail = el;
 535
 536         RemoveDuplicatesFromGRFConfigList(*dst);
 537 }
 538
 539
 540 /** Reset the current GRF Config to either blank or newgame settings. */
 541 void ResetGRFConfig(bool defaults)
 542 {
 543         CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);
 544         AppendStaticGRFConfigs(&_grfconfig);
 545 }
 546
 547
 548 /**
 549  * Check if all GRFs in the GRF config from a savegame can be loaded.
 550  * @param grfconfig GrfConfig to check
 551  * @return will return any of the following 3 values:<br>
 552  * <ul>
 553  * <li> GLC_ALL_GOOD: No problems occurred, all GRF files were found and loaded
 554  * <li> GLC_COMPATIBLE: For one or more GRF's no exact match was found, but a
 555  *     compatible GRF with the same grfid was found and used instead
 556  * <li> GLC_NOT_FOUND: For one or more GRF's no match was found at all
 557  * </ul>
 558  */
 559 GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig)
 560 {
 561         GRFListCompatibility res = GLC_ALL_GOOD;
 562
 563         for (GRFConfig *c = grfconfig; c != NULL; c = c->next) {
 564                 const GRFConfig *f = FindGRFConfig(c->ident.grfid, FGCM_EXACT, c->ident.md5sum);
 565                 if (f == NULL || HasBit(f->flags, GCF_INVALID)) {
 566                         char buf[256];
 567
 568                         /* If we have not found the exactly matching GRF try to find one with the
 569                          * same grfid, as it most likely is compatible */
 570                         f = FindGRFConfig(c->ident.grfid, FGCM_COMPATIBLE, NULL, c->version);
 571                         if (f != NULL) {
 572                                 md5sumToString(buf, lastof(buf), c->ident.md5sum);
 573                                 DEBUG(grf, 1, "NewGRF %08X (%s) not found; checksum %s. Compatibility mode on", BSWAP32(c->ident.grfid), c->filename, buf);
 574                                 if (!HasBit(c->flags, GCF_COMPATIBLE)) {
 575                                         /* Preserve original_md5sum after it has been assigned */
 576                                         SetBit(c->flags, GCF_COMPATIBLE);
 577                                         memcpy(c->original_md5sum, c->ident.md5sum, sizeof(c->original_md5sum));
 578                                 }
 579
 580                                 /* Non-found has precedence over compatibility load */
 581                                 if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;
 582                                 goto compatible_grf;
 583                         }
 584
 585                         /* No compatible grf was found, mark it as disabled */
 586                         md5sumToString(buf, lastof(buf), c->ident.md5sum);
 587                         DEBUG(grf, 0, "NewGRF %08X (%s) not found; checksum %s", BSWAP32(c->ident.grfid), c->filename, buf);
 588
 589                         c->status = GCS_NOT_FOUND;
 590                         res = GLC_NOT_FOUND;
 591                 } else {
 592 compatible_grf:
 593                         DEBUG(grf, 1, "Loading GRF %08X from %s", BSWAP32(f->ident.grfid), f->filename);
 594                         /* The filename could be the filename as in the savegame. As we need
 595                          * to load the GRF here, we need the correct filename, so overwrite that
 596                          * in any case and set the name and info when it is not set already.
 597                          * When the GCF_COPY flag is set, it is certain that the filename is
 598                          * already a local one, so there is no need to replace it. */
 599                         if (!HasBit(c->flags, GCF_COPY)) {
 600                                 free(c->filename);
 601                                 c->filename = stredup(f->filename);
 602                                 memcpy(c->ident.md5sum, f->ident.md5sum, sizeof(c->ident.md5sum));
 603                                 c->name->Release();
 604                                 c->name = f->name;
 605                                 c->name->AddRef();
 606                                 c->info->Release();
 607                                 c->info = f->name;
 608                                 c->info->AddRef();
 609                                 c->error = NULL;
 610                                 c->version = f->version;
 611                                 c->min_loadable_version = f->min_loadable_version;
 612                                 c->num_valid_params = f->num_valid_params;
 613                                 c->has_param_defaults = f->has_param_defaults;
 614                                 for (uint i = 0; i < f->param_info.Length(); i++) {
 615                                         if (f->param_info[i] == NULL) {
 616                                                 *c->param_info.Append() = NULL;
 617                                         } else {
 618                                                 *c->param_info.Append() = new GRFParameterInfo(*f->param_info[i]);
 619                                         }
 620                                 }
 621                         }
 622                 }
 623         }
 624
 625         return res;
 626 }
 627
 628 /** Helper for scanning for files with GRF as extension */
 629 class GRFFileScanner : FileScanner {
 630         uint next_update; ///< The next (realtime tick) we do update the screen.
 631         uint num_scanned; ///< The number of GRFs we have scanned.
 632
 633 public:
 634         GRFFileScanner() : next_update(_realtime_tick), num_scanned(0)
 635         {
 636         }
 637
 638         /* virtual */ bool AddFile(const char *filename, size_t basepath_length, const char *tar_filename);
 639
 640         /** Do the scan for GRFs. */
 641         static uint DoScan()
 642         {
 643                 GRFFileScanner fs;
 644                 int ret = fs.Scan(".grf", NEWGRF_DIR);
 645                 /* The number scanned and the number returned may not be the same;
 646                  * duplicate NewGRFs and base sets are ignored in the return value. */
 647                 _settings_client.gui.last_newgrf_count = fs.num_scanned;
 648                 return ret;
 649         }
 650 };
 651
 652 bool GRFFileScanner::AddFile(const char *filename, size_t basepath_length, const char *tar_filename)
 653 {
 654         GRFConfig *c = new GRFConfig(filename + basepath_length);
 655
 656         bool added = true;
 657         if (FillGRFDetails(c, false)) {
 658                 if (_all_grfs == NULL) {
 659                         _all_grfs = c;
 660                 } else {
 661                         /* Insert file into list at a position determined by its
 662                          * name, so the list is sorted as we go along */
 663                         GRFConfig **pd, *d;
 664                         bool stop = false;
 665                         for (pd = &_all_grfs; (d = *pd) != NULL; pd = &d->next) {
 666                                 if (c->ident.grfid == d->ident.grfid && memcmp(c->ident.md5sum, d->ident.md5sum, sizeof(c->ident.md5sum)) == 0) added = false;
 667                                 /* Because there can be multiple grfs with the same name, make sure we checked all grfs with the same name,
 668                                  *  before inserting the entry. So insert a new grf at the end of all grfs with the same name, instead of
 669                                  *  just after the first with the same name. Avoids doubles in the list. */
 670                                 if (strcasecmp(c->GetName(), d->GetName()) <= 0) {
 671                                         stop = true;
 672                                 } else if (stop) {
 673                                         break;
 674                                 }
 675                         }
 676                         if (added) {
 677                                 c->next = d;
 678                                 *pd = c;
 679                         }
 680                 }
 681         } else {
 682                 added = false;
 683         }
 684
 685         this->num_scanned++;
 686         if (this->next_update <= _realtime_tick) {
 687                 _modal_progress_work_mutex->EndCritical();
 688                 _modal_progress_paint_mutex->BeginCritical();
 689
 690                 const char *name = NULL;
 691                 if (c->name != NULL) name = GetGRFStringFromGRFText(c->name->text);
 692                 if (name == NULL) name = c->filename;
 693                 UpdateNewGRFScanStatus(this->num_scanned, name);
 694
 695                 _modal_progress_work_mutex->BeginCritical();
 696                 _modal_progress_paint_mutex->EndCritical();
 697
 698                 this->next_update = _realtime_tick + 200;
 699         }
 700
 701         if (!added) {
 702                 /* File couldn't be opened, or is either not a NewGRF or is a
 703                  * 'system' NewGRF or it's already known, so forget about it. */
 704                 delete c;
 705         }
 706
 707         return added;
 708 }
 709
 710 /**
 711  * Simple sorter for GRFS
 712  * @param p1 the first GRFConfig *
 713  * @param p2 the second GRFConfig *
 714  * @return the same strcmp would return for the name of the NewGRF.
 715  */
 716 static int CDECL GRFSorter(GRFConfig * const *p1, GRFConfig * const *p2)
 717 {
 718         const GRFConfig *c1 = *p1;
 719         const GRFConfig *c2 = *p2;
 720
 721         return strnatcmp(c1->GetName(), c2->GetName());
 722 }
 723
 724 /**
 725  * Really perform the scan for all NewGRFs.
 726  * @param callback The callback to call after the scanning is complete.
 727  */
 728 void DoScanNewGRFFiles(void *callback)
 729 {
 730         _modal_progress_work_mutex->BeginCritical();
 731
 732         ClearGRFConfigList(&_all_grfs);
 733         TarScanner::DoScan(TarScanner::NEWGRF);
 734
 735         DEBUG(grf, 1, "Scanning for NewGRFs");
 736         uint num = GRFFileScanner::DoScan();
 737
 738         DEBUG(grf, 1, "Scan complete, found %d files", num);
 739         if (num != 0 && _all_grfs != NULL) {
 740                 /* Sort the linked list using quicksort.
 741                  * For that we first have to make an array, then sort and
 742                  * then remake the linked list. */
 743                 GRFConfig **to_sort = MallocT<GRFConfig*>(num);
 744
 745                 uint i = 0;
 746                 for (GRFConfig *p = _all_grfs; p != NULL; p = p->next, i++) {
 747                         to_sort[i] = p;
 748                 }
 749                 /* Number of files is not necessarily right */
 750                 num = i;
 751
 752                 QSortT(to_sort, num, &GRFSorter);
 753
 754                 for (i = 1; i < num; i++) {
 755                         to_sort[i - 1]->next = to_sort[i];
 756                 }
 757                 to_sort[num - 1]->next = NULL;
 758                 _all_grfs = to_sort[0];
 759
 760                 free(to_sort);
 761
 762 #ifdef ENABLE_NETWORK
 763                 NetworkAfterNewGRFScan();
 764 #endif
 765         }
 766
 767         _modal_progress_work_mutex->EndCritical();
 768         _modal_progress_paint_mutex->BeginCritical();
 769
 770         /* Yes... these are the NewGRF windows */
 771         InvalidateWindowClassesData(WC_SAVELOAD, 0, true);
 772         InvalidateWindowData(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE, GOID_NEWGRF_RESCANNED, true);
 773         if (callback != NULL) ((NewGRFScanCallback*)callback)->OnNewGRFsScanned();
 774
 775         DeleteWindowByClass(WC_MODAL_PROGRESS);
 776         SetModalProgress(false);
 777         MarkWholeScreenDirty();
 778         _modal_progress_paint_mutex->EndCritical();
 779 }
 780
 781 /**
 782  * Scan for all NewGRFs.
 783  * @param callback The callback to call after the scanning is complete.
 784  */
 785 void ScanNewGRFFiles(NewGRFScanCallback *callback)
 786 {
 787         /* First set the modal progress. This ensures that it will eventually let go of the paint mutex. */
 788         SetModalProgress(true);
 789         /* Only then can we really start, especially by marking the whole screen dirty. Get those other windows hidden!. */
 790         MarkWholeScreenDirty();
 791
 792         if (!VideoDriver::GetInstance()->HasGUI() || !ThreadObject::New(&DoScanNewGRFFiles, callback, NULL, "ottd:newgrf-scan")) {
 793                 _modal_progress_work_mutex->EndCritical();
 794                 _modal_progress_paint_mutex->EndCritical();
 795                 DoScanNewGRFFiles(callback);
 796                 _modal_progress_paint_mutex->BeginCritical();
 797                 _modal_progress_work_mutex->BeginCritical();
 798         } else {
 799                 UpdateNewGRFScanStatus(0, NULL);
 800         }
 801 }
 802
 803 /**
 804  * Find a NewGRF in the scanned list.
 805  * @param grfid GRFID to look for,
 806  * @param mode Restrictions for matching grfs
 807  * @param md5sum Expected MD5 sum
 808  * @param desired_version Requested version
 809  * @return The matching grf, if it exists in #_all_grfs, else \c NULL.
 810  */
 811 const GRFConfig *FindGRFConfig(uint32 grfid, FindGRFConfigMode mode, const uint8 *md5sum, uint32 desired_version)
 812 {
 813         assert((mode == FGCM_EXACT) != (md5sum == NULL));
 814         const GRFConfig *best = NULL;
 815         for (const GRFConfig *c = _all_grfs; c != NULL; c = c->next) {
 816                 /* if md5sum is set, we look for an exact match and continue if not found */
 817                 if (!c->ident.HasGrfIdentifier(grfid, md5sum)) continue;
 818                 /* return it, if the exact same newgrf is found, or if we do not care about finding "the best" */
 819                 if (md5sum != NULL || mode == FGCM_ANY) return c;
 820                 /* Skip incompatible stuff, unless explicitly allowed */
 821                 if (mode != FGCM_NEWEST && HasBit(c->flags, GCF_INVALID)) continue;
 822                 /* check version compatibility */
 823                 if (mode == FGCM_COMPATIBLE && (c->version < desired_version || c->min_loadable_version > desired_version)) continue;
 824                 /* remember the newest one as "the best" */
 825                 if (best == NULL || c->version > best->version) best = c;
 826         }
 827
 828         return best;
 829 }
 830
 831 #ifdef ENABLE_NETWORK
 832
 833 /** Structure for UnknownGRFs; this is a lightweight variant of GRFConfig */
 834 struct UnknownGRF : public GRFIdentifier {
 835         UnknownGRF *next;     ///< The next unknown GRF.
 836         GRFTextWrapper *name; ///< Name of the GRF.
 837 };
 838
 839 /**
 840  * Finds the name of a NewGRF in the list of names for unknown GRFs. An
 841  * unknown GRF is a GRF where the .grf is not found during scanning.
 842  *
 843  * The names are resolved via UDP calls to servers that should know the name,
 844  * though the replies may not come. This leaves "<Unknown>" as name, though
 845  * that shouldn't matter _very_ much as they need GRF crawler or so to look
 846  * up the GRF anyway and that works better with the GRF ID.
 847  *
 848  * @param grfid  the GRF ID part of the 'unique' GRF identifier
 849  * @param md5sum the MD5 checksum part of the 'unique' GRF identifier
 850  * @param create whether to create a new GRFConfig if the GRFConfig did not
 851  *               exist in the fake list of GRFConfigs.
 852  * @return The GRFTextWrapper of the name of the GRFConfig with the given GRF ID
 853  *         and MD5 checksum or NULL when it does not exist and create is false.
 854  *         This value must NEVER be freed by the caller.
 855  */
 856 GRFTextWrapper *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create)
 857 {
 858         UnknownGRF *grf;
 859         static UnknownGRF *unknown_grfs = NULL;
 860
 861         for (grf = unknown_grfs; grf != NULL; grf = grf->next) {
 862                 if (grf->grfid == grfid) {
 863                         if (memcmp(md5sum, grf->md5sum, sizeof(grf->md5sum)) == 0) return grf->name;
 864                 }
 865         }
 866
 867         if (!create) return NULL;
 868
 869         grf = CallocT<UnknownGRF>(1);
 870         grf->grfid = grfid;
 871         grf->next  = unknown_grfs;
 872         grf->name = new GRFTextWrapper();
 873         grf->name->AddRef();
 874
 875         AddGRFTextToList(&grf->name->text, UNKNOWN_GRF_NAME_PLACEHOLDER);
 876         memcpy(grf->md5sum, md5sum, sizeof(grf->md5sum));
 877
 878         unknown_grfs = grf;
 879         return grf->name;
 880 }
 881
 882 #endif /* ENABLE_NETWORK */
 883
 884
 885 /**
 886  * Retrieve a NewGRF from the current config by its grfid.
 887  * @param grfid grf to look for.
 888  * @param mask  GRFID mask to allow for partial matching.
 889  * @return The grf config, if it exists, else \c NULL.
 890  */
 891 GRFConfig *GetGRFConfig(uint32 grfid, uint32 mask)
 892 {
 893         GRFConfig *c;
 894
 895         for (c = _grfconfig; c != NULL; c = c->next) {
 896                 if ((c->ident.grfid & mask) == (grfid & mask)) return c;
 897         }
 898
 899         return NULL;
 900 }
 901
 902
 903 /** Build a string containing space separated parameter values, and terminate */
 904 char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last)
 905 {
 906         uint i;
 907
 908         /* Return an empty string if there are no parameters */
 909         if (c->num_params == 0) return strecpy(dst, "", last);
 910
 911         for (i = 0; i < c->num_params; i++) {
 912                 if (i > 0) dst = strecpy(dst, " ", last);
 913                 dst += seprintf(dst, last, "%d", c->param[i]);
 914         }
 915         return dst;
 916 }
 917
 918 /**
 919  * Search a textfile file next to this NewGRF.
 920  * @param type The type of the textfile to search for.
 921  * @return The filename for the textfile, \c NULL otherwise.
 922  */
 923 const char *GRFConfig::GetTextfile(TextfileType type) const
 924 {
 925         return ::GetTextfile(type, NEWGRF_DIR, this->filename);
 926 }