/* $Id$ */ /* * This file is part of OpenTTD. * 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. * 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. * 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/>. */ /** @file ai_scanner.cpp allows scanning AI scripts */ #include "../stdafx.h" #include "../debug.h" #include "../fileio_func.h" #include "../network/network.h" #include "../core/random_func.hpp" #include <squirrel.h> #include "../script/squirrel.hpp" #include "../script/squirrel_helper.hpp" #include "../script/squirrel_class.hpp" #include "ai_info.hpp" #include "ai_scanner.hpp" #include "api/ai_controller.hpp" void AIScanner::RescanAIDir() { this->ScanScriptDir("info.nut", AI_DIR); this->ScanScriptDir("library.nut", AI_LIBRARY_DIR); } AIScanner::AIScanner() : ScriptScanner(), info_dummy(NULL) { /* Create the AIInfo class, and add the RegisterAI function */ DefSQClass <AIInfo> SQAIInfo("AIInfo"); SQAIInfo.PreRegister(engine); SQAIInfo.AddConstructor<void (AIInfo::*)(), 1>(engine, "x"); SQAIInfo.DefSQAdvancedMethod(this->engine, &AIInfo::AddSetting, "AddSetting"); SQAIInfo.DefSQAdvancedMethod(this->engine, &AIInfo::AddLabels, "AddLabels"); SQAIInfo.DefSQConst(engine, AICONFIG_NONE, "AICONFIG_NONE"); SQAIInfo.DefSQConst(engine, AICONFIG_RANDOM, "AICONFIG_RANDOM"); SQAIInfo.DefSQConst(engine, AICONFIG_BOOLEAN, "AICONFIG_BOOLEAN"); SQAIInfo.DefSQConst(engine, AICONFIG_INGAME, "AICONFIG_INGAME"); SQAIInfo.PostRegister(engine); this->engine->AddMethod("RegisterAI", &AIInfo::Constructor, 2, "tx"); this->engine->AddMethod("RegisterDummyAI", &AIInfo::DummyConstructor, 2, "tx"); /* Create the AILibrary class, and add the RegisterLibrary function */ this->engine->AddClassBegin("AILibrary"); this->engine->AddClassEnd(); this->engine->AddMethod("RegisterLibrary", &AILibrary::Constructor, 2, "tx"); /* Scan the AI dir for scripts */ this->RescanAIDir(); /* Create the dummy AI */ this->engine->ResetCrashed(); strecpy(this->main_script, "%_dummy", lastof(this->main_script)); extern void AI_CreateAIInfoDummy(HSQUIRRELVM vm); AI_CreateAIInfoDummy(this->engine->GetVM()); } AIScanner::~AIScanner() { AIInfoList::iterator it = this->info_list.begin(); for (; it != this->info_list.end(); it++) { free((void *)(*it).first); delete (*it).second; } it = this->info_single_list.begin(); for (; it != this->info_single_list.end(); it++) { free((void *)(*it).first); } AILibraryList::iterator lit = this->library_list.begin(); for (; lit != this->library_list.end(); lit++) { free((void *)(*lit).first); delete (*lit).second; } delete this->info_dummy; } bool AIScanner::ImportLibrary(const char *library, const char *class_name, int version, HSQUIRRELVM vm, AIController *controller) { /* Internally we store libraries as 'library.version' */ char library_name[1024]; snprintf(library_name, sizeof(library_name), "%s.%d", library, version); strtolower(library_name); /* Check if the library + version exists */ AILibraryList::iterator iter = this->library_list.find(library_name); if (iter == this->library_list.end()) { char error[1024]; /* Now see if the version doesn't exist, or the library */ iter = this->library_list.find(library); if (iter == this->library_list.end()) { snprintf(error, sizeof(error), "couldn't find library '%s'", library); } else { snprintf(error, sizeof(error), "couldn't find library '%s' version %d. The latest version available is %d", library, version, (*iter).second->GetVersion()); } sq_throwerror(vm, OTTD2SQ(error)); return false; } /* Get the current table/class we belong to */ HSQOBJECT parent; sq_getstackobj(vm, 1, &parent); char fake_class[1024]; int next_number; if (!controller->LoadedLibrary(library_name, &next_number, &fake_class[0], sizeof(fake_class))) { /* Create a new fake internal name */ snprintf(fake_class, sizeof(fake_class), "_internalNA%d", next_number); /* Load the library in a 'fake' namespace, so we can link it to the name the user requested */ sq_pushroottable(vm); sq_pushstring(vm, OTTD2SQ(fake_class), -1); sq_newclass(vm, SQFalse); /* Load the library */ if (!Squirrel::LoadScript(vm, (*iter).second->GetMainScript(), false)) { char error[1024]; snprintf(error, sizeof(error), "there was a compile error when importing '%s' version %d", library, version); sq_throwerror(vm, OTTD2SQ(error)); return false; } /* Create the fake class */ sq_newslot(vm, -3, SQFalse); sq_pop(vm, 1); controller->AddLoadedLibrary(library_name, fake_class); } /* Find the real class inside the fake class (like 'sets.Vector') */ sq_pushroottable(vm); sq_pushstring(vm, OTTD2SQ(fake_class), -1); if (SQ_FAILED(sq_get(vm, -2))) { sq_throwerror(vm, _SC("internal error assigning library class")); return false; } sq_pushstring(vm, OTTD2SQ((*iter).second->GetInstanceName()), -1); if (SQ_FAILED(sq_get(vm, -2))) { char error[1024]; snprintf(error, sizeof(error), "unable to find class '%s' in the library '%s' version %d", (*iter).second->GetInstanceName(), library, version); sq_throwerror(vm, OTTD2SQ(error)); return false; } HSQOBJECT obj; sq_getstackobj(vm, -1, &obj); sq_pop(vm, 3); if (StrEmpty(class_name)) { sq_pushobject(vm, obj); return true; } /* Now link the name the user wanted to our 'fake' class */ sq_pushobject(vm, parent); sq_pushstring(vm, OTTD2SQ(class_name), -1); sq_pushobject(vm, obj); sq_newclass(vm, SQTrue); sq_newslot(vm, -3, SQFalse); sq_pop(vm, 1); sq_pushobject(vm, obj); return true; } void AIScanner::RegisterLibrary(AILibrary *library) { char library_name[1024]; snprintf(library_name, sizeof(library_name), "%s.%s.%d", library->GetCategory(), library->GetInstanceName(), library->GetVersion()); strtolower(library_name); if (this->library_list.find(library_name) != this->library_list.end()) { /* This AI was already registered */ #ifdef WIN32 /* Windows doesn't care about the case */ if (strcasecmp(this->library_list[library_name]->GetMainScript(), library->GetMainScript()) == 0) { #else if (strcmp(this->library_list[library_name]->GetMainScript(), library->GetMainScript()) == 0) { #endif delete library; return; } DEBUG(ai, 0, "Registering two libraries with the same name and version"); DEBUG(ai, 0, " 1: %s", this->library_list[library_name]->GetMainScript()); DEBUG(ai, 0, " 2: %s", library->GetMainScript()); DEBUG(ai, 0, "The first is taking precedence."); delete library; return; } this->library_list[strdup(library_name)] = library; } void AIScanner::RegisterAI(AIInfo *info) { char ai_name[1024]; snprintf(ai_name, sizeof(ai_name), "%s.%d", info->GetName(), info->GetVersion()); strtolower(ai_name); /* Check if GetShortName follows the rules */ if (strlen(info->GetShortName()) != 4) { DEBUG(ai, 0, "The AI '%s' returned a string from GetShortName() which is not four characaters. Unable to load the AI.", info->GetName()); delete info; return; } if (this->info_list.find(ai_name) != this->info_list.end()) { /* This AI was already registered */ #ifdef WIN32 /* Windows doesn't care about the case */ if (strcasecmp(this->info_list[ai_name]->GetMainScript(), info->GetMainScript()) == 0) { #else if (strcmp(this->info_list[ai_name]->GetMainScript(), info->GetMainScript()) == 0) { #endif delete info; return; } DEBUG(ai, 0, "Registering two AIs with the same name and version"); DEBUG(ai, 0, " 1: %s", this->info_list[ai_name]->GetMainScript()); DEBUG(ai, 0, " 2: %s", info->GetMainScript()); DEBUG(ai, 0, "The first is taking precedence."); delete info; return; } this->info_list[strdup(ai_name)] = info; /* Add the AI to the 'unique' AI list, where only the highest version of the * AI is registered. */ snprintf(ai_name, sizeof(ai_name), "%s", info->GetName()); strtolower(ai_name); if (this->info_single_list.find(ai_name) == this->info_single_list.end()) { this->info_single_list[strdup(ai_name)] = info; } else if (this->info_single_list[ai_name]->GetVersion() < info->GetVersion()) { this->info_single_list[ai_name] = info; } } AIInfo *AIScanner::SelectRandomAI() const { uint num_random_ais = 0; for (AIInfoList::const_iterator it = this->info_single_list.begin(); it != this->info_single_list.end(); it++) { if (it->second->UseAsRandomAI()) num_random_ais++; } if (num_random_ais == 0) { DEBUG(ai, 0, "No suitable AI found, loading 'dummy' AI."); return this->info_dummy; } /* Find a random AI */ uint pos; if (_networking) { pos = InteractiveRandomRange(num_random_ais); } else { pos = RandomRange(num_random_ais); } /* Find the Nth item from the array */ AIInfoList::const_iterator it = this->info_single_list.begin(); while (!it->second->UseAsRandomAI()) it++; for (; pos > 0; pos--) { it++; while (!it->second->UseAsRandomAI()) it++; } return (*it).second; } AIInfo *AIScanner::FindInfo(const char *nameParam, int versionParam, bool force_exact_match) { if (this->info_list.size() == 0) return NULL; if (nameParam == NULL) return NULL; char ai_name[1024]; ttd_strlcpy(ai_name, nameParam, sizeof(ai_name)); strtolower(ai_name); AIInfo *info = NULL; int version = -1; if (versionParam == -1) { /* We want to load the latest version of this AI; so find it */ if (this->info_single_list.find(ai_name) != this->info_single_list.end()) return this->info_single_list[ai_name]; /* If we didn't find a match AI, maybe the user included a version */ char *e = strrchr(ai_name, '.'); if (e == NULL) return NULL; *e = '\0'; e++; versionParam = atoi(e); /* Fall-through, like we were calling this function with a version */ } if (force_exact_match) { /* Try to find a direct 'name.version' match */ char ai_name_tmp[1024]; snprintf(ai_name_tmp, sizeof(ai_name_tmp), "%s.%d", ai_name, versionParam); strtolower(ai_name_tmp); if (this->info_list.find(ai_name_tmp) != this->info_list.end()) return this->info_list[ai_name_tmp]; } /* See if there is a compatible AI which goes by that name, with the highest * version which allows loading the requested version */ AIInfoList::iterator it = this->info_list.begin(); for (; it != this->info_list.end(); it++) { if (strcasecmp(ai_name, (*it).second->GetName()) == 0 && (*it).second->CanLoadFromVersion(versionParam) && (version == -1 || (*it).second->GetVersion() > version)) { version = (*it).second->GetVersion(); info = (*it).second; } } return info; } char *AIScanner::GetAIConsoleList(char *p, const char *last) const { p += seprintf(p, last, "List of AIs:\n"); AIInfoList::const_iterator it = this->info_list.begin(); for (; it != this->info_list.end(); it++) { AIInfo *i = (*it).second; p += seprintf(p, last, "%10s (v%d): %s\n", i->GetName(), i->GetVersion(), i->GetDescription()); } p += seprintf(p, last, "\n"); return p; } #if defined(ENABLE_NETWORK) #include "../network/network_content.h" #include "../3rdparty/md5/md5.h" #include "../tar_type.h" /** Helper for creating a MD5sum of all files within of an AI. */ struct AIFileChecksumCreator : FileScanner { byte md5sum[16]; ///< The final md5sum /** * Initialise the md5sum to be all zeroes, * so we can easily xor the data. */ AIFileChecksumCreator() { memset(this->md5sum, 0, sizeof(this->md5sum)); } /* Add the file and calculate the md5 sum. */ virtual bool AddFile(const char *filename, size_t basepath_length) { Md5 checksum; uint8 buffer[1024]; size_t len, size; byte tmp_md5sum[16]; /* Open the file ... */ FILE *f = FioFOpenFile(filename, "rb", DATA_DIR, &size); if (f == NULL) return false; /* ... calculate md5sum... */ while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) { size -= len; checksum.Append(buffer, len); } checksum.Finish(tmp_md5sum); FioFCloseFile(f); /* ... and xor it to the overall md5sum. */ for (uint i = 0; i < sizeof(md5sum); i++) this->md5sum[i] ^= tmp_md5sum[i]; return true; } }; /** * Check whether the AI given in info is the same as in ci based * on the shortname and md5 sum. * @param ci the information to compare to * @param md5sum whether to check the MD5 checksum * @param info the AI to get the shortname and md5 sum from * @return true iff they're the same */ static bool IsSameAI(const ContentInfo *ci, bool md5sum, AIFileInfo *info) { uint32 id = 0; const char *str = info->GetShortName(); for (int j = 0; j < 4 && *str != '\0'; j++, str++) id |= *str << (8 * j); if (id != ci->unique_id) return false; if (!md5sum) return true; AIFileChecksumCreator checksum; char path[MAX_PATH]; strecpy(path, info->GetMainScript(), lastof(path)); /* There'll always be at least 2 path separator characters in an AI's * main script name as the search algorithm requires the main script to * be in a subdirectory of the AI directory; so ai/<path>/main.nut. */ *strrchr(path, PATHSEPCHAR) = '\0'; *strrchr(path, PATHSEPCHAR) = '\0'; TarList::iterator iter = _tar_list.find(path); if (iter != _tar_list.end()) { /* The main script is in a tar file, so find all files that * are in the same tar and add them to the MD5 checksumming. */ TarFileList::iterator tar; FOR_ALL_TARS(tar) { /* Not in the same tar. */ if (tar->second.tar_filename != iter->first) continue; /* Check the extension. */ const char *ext = strrchr(tar->first.c_str(), '.'); if (ext == NULL || strcasecmp(ext, ".nut") != 0) continue; /* Create the full path name, */ seprintf(path, lastof(path), "%s%c%s", tar->second.tar_filename, PATHSEPCHAR, tar->first.c_str()); checksum.AddFile(path, 0); } } else { /* Add the path sep char back when searching a directory, so we are * in the actual directory. */ path[strlen(path)] = PATHSEPCHAR; checksum.Scan(".nut", path); } return memcmp(ci->md5sum, checksum.md5sum, sizeof(ci->md5sum)) == 0; } /** * Check whether we have an AI (library) with the exact characteristics as ci. * @param ci the characteristics to search on (shortname and md5sum) * @param md5sum whether to check the MD5 checksum * @return true iff we have an AI (library) matching. */ bool AIScanner::HasAI(const ContentInfo *ci, bool md5sum) { switch (ci->type) { case CONTENT_TYPE_AI: for (AIInfoList::iterator it = this->info_list.begin(); it != this->info_list.end(); it++) { if (IsSameAI(ci, md5sum, (*it).second)) return true; } return false; case CONTENT_TYPE_AI_LIBRARY: for (AILibraryList::iterator it = this->library_list.begin(); it != this->library_list.end(); it++) { if (IsSameAI(ci, md5sum, (*it).second)) return true; } return false; default: NOT_REACHED(); } } /** * Check whether we have an AI (library) with the exact characteristics as ci. * @param ci the characteristics to search on (shortname and md5sum) * @param md5sum whether to check the MD5 checksum * @return true iff we have an AI (library) matching. */ /* static */ bool AI::HasAI(const ContentInfo *ci, bool md5sum) { return AI::ai_scanner->HasAI(ci, md5sum); } #endif /* ENABLE_NETWORK */