X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules.cpp;h=7e4e0ec6869d67b561df3763eb5162430cd885a0;hb=9facfd70b5a8ca4dca16fc93f6fcfe1c2bf6ce0f;hp=f7904d07b1642da0be0087460609742974fba6a0;hpb=085a8bc6605d3d07bfe5137423c4a7a02978cd88;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules.cpp b/src/modules.cpp index f7904d07b..7e4e0ec68 100644 --- a/src/modules.cpp +++ b/src/modules.cpp @@ -11,8 +11,6 @@ * --------------------------------------------------- */ -/* $Core */ - #include "inspircd.h" #include "xline.h" #include "socket.h" @@ -26,91 +24,43 @@ #endif -// version is a simple class for holding a modules version number -Version::Version(const std::string &modv, int flags, int api_ver, const std::string& rev) -: description(modv), version(rev), Flags(flags), API(api_ver) +// Version is a simple class for holding a modules version number +template<> +VersionBase::VersionBase(const std::string &modv, int flags, const std::string& rev) +: description(modv), version(rev), Flags(flags) { } -Request::Request(char* anydata, Module* src, Module* dst) -: data(anydata), source(src), dest(dst) -{ - /* Ensure that because this module doesnt support ID strings, it doesnt break modules that do - * by passing them uninitialized pointers (could happen) - */ - id = '\0'; -} - Request::Request(Module* src, Module* dst, const char* idstr) : id(idstr), source(src), dest(dst) { } -char* Request::GetData() +void Request::Send() { - return this->data; + if (dest) + dest->OnRequest(*this); } -const char* Request::GetId() -{ - return this->id; -} - -Module* Request::GetSource() -{ - return this->source; -} +Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { } -Module* Request::GetDest() +void Event::Send() { - return this->dest; + FOREACH_MOD(I_OnEvent,OnEvent(*this)); } -const char* Request::Send() -{ - if (this->dest) - { - return dest->OnRequest(this); - } - else - { - return NULL; - } -} - -Event::Event(char* anydata, Module* src, const std::string &eventid) : data(anydata), source(src), id(eventid) { } - -char* Event::GetData() -{ - return this->data; -} - -Module* Event::GetSource() -{ - return this->source; -} - -char* Event::Send() -{ - FOREACH_MOD(I_OnEvent,OnEvent(this)); - return NULL; -} +// These declarations define the behavours of the base class Module (which does nothing at all) -std::string Event::GetEventID() +Module::Module() : refcount(1) { } +CullResult Module::cull() { - return this->id; + return classbase::cull(); } - - -// These declarations define the behavours of the base class Module (which does nothing at all) - -Module::Module() { } -bool Module::cull() +Module::~Module() { - ServerInstance->GlobalCulls.AddItem(ModuleDLLFactory); - return true; + if (refcount != 1) + ServerInstance->Logs->Log("MODULE", DEFAULT, "References remain to destructed module " + ModuleSourceFile); } -Module::~Module() { } ModResult Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; } void Module::OnUserConnect(User*) { } @@ -136,8 +86,8 @@ void Module::OnUserPostNick(User*, const std::string&) { } ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector&) { return MOD_RES_PASSTHRU; } void Module::On005Numeric(std::string&) { } ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; } -void Module::OnLoadModule(Module*, const std::string&) { } -void Module::OnUnloadModule(Module*, const std::string&) { } +void Module::OnLoadModule(Module*) { } +void Module::OnUnloadModule(Module*) { } void Module::OnBackgroundTimer(time_t) { } ModResult Module::OnPreCommand(std::string&, std::vector&, User *, bool, const std::string&) { return MOD_RES_PASSTHRU; } void Module::OnPostCommand(const std::string&, const std::vector&, User *, CmdResult, const std::string&) { } @@ -156,8 +106,8 @@ ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; ModResult Module::OnChangeLocalUserHost(User*, const std::string&) { return MOD_RES_PASSTHRU; } ModResult Module::OnChangeLocalUserGECOS(User*, const std::string&) { return MOD_RES_PASSTHRU; } ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; } -void Module::OnEvent(Event*) { return; } -const char* Module::OnRequest(Request*) { return NULL; } +void Module::OnEvent(Event&) { } +void Module::OnRequest(Request&) { } ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; } void Module::OnGlobalOper(User*) { } void Module::OnPostConnect(User*) { } @@ -201,6 +151,7 @@ void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; } void Module::OnHookIO(StreamSocket*, ListenSocketBase*) { } void Module::OnSendWhoLine(User*, User*, Channel*, std::string&) { } +ModResult Module::OnChannelRestrictionApply(User*, Channel*, const char*) { return MOD_RES_PASSTHRU; } ModuleManager::ModuleManager() : ModCount(0) { @@ -374,6 +325,9 @@ std::string& ModuleManager::LastError() bool ModuleManager::Load(const char* filename) { + /* Don't allow people to specify paths for modules, it doesn't work as expected */ + if (strchr(filename, '/')) + return false; /* Do we have a glob pattern in the filename? * The user wants to load multiple modules which * match the pattern. @@ -422,84 +376,43 @@ bool ModuleManager::Load(const char* filename) } Module* newmod = NULL; - DLLFactory* newhandle = NULL; + DLLManager* newhandle = new DLLManager(modfile); try { - /* This will throw a CoreException if there's a problem loading - * the module file or getting a pointer to the init_module symbol. - */ - newhandle = new DLLFactory(modfile, "init_module"); - if (newhandle->init_func) - newmod = newhandle->init_func(); + newmod = newhandle->callInit(); if (newmod) { newmod->ModuleSourceFile = filename_str; - newmod->ModuleDLLFactory = newhandle; + newmod->ModuleDLLManager = newhandle; Version v = newmod->GetVersion(); - if (v.API != API_VERSION) - { - DetachAll(newmod); - delete newmod; - delete newhandle; - LastModuleError = "Unable to load " + filename_str + ": Incorrect module API version: " + ConvToStr(v.API) + " (our version: " + ConvToStr(API_VERSION) + ")"; - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; - } - else - { - ServerInstance->Logs->Log("MODULE", DEFAULT,"New module introduced: %s (API version %d, Module version %s)%s", filename, v.API, v.version.c_str(), (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]")); - } + ServerInstance->Logs->Log("MODULE", DEFAULT,"New module introduced: %s (Module version %s)%s", + filename, v.version.c_str(), (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]")); Modules[filename_str] = newmod; } else { - delete newhandle; - LastModuleError = "Unable to load " + filename_str + ": Probably missing init_module() entrypoint, but dlsym() didn't notice a problem"; + LastModuleError = "Unable to load " + filename_str + ": " + newhandle->LastError(); ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); + delete newhandle; return false; } } - /** XXX: Is there anything we can do about this mess? -- Brain */ - catch (LoadModuleException& modexcept) - { - DetachAll(newmod); - if (newmod) - delete newmod; - if (newhandle) - delete newhandle; - LastModuleError = "Unable to load " + filename_str + ": Error when loading: " + modexcept.GetReason(); - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; - } - catch (FindSymbolException& modexcept) - { - DetachAll(newmod); - if (newmod) - delete newmod; - if (newhandle) - delete newhandle; - LastModuleError = "Unable to load " + filename_str + ": Error finding symbol: " + modexcept.GetReason(); - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; - } catch (CoreException& modexcept) { - DetachAll(newmod); - if (newmod) - delete newmod; - if (newhandle) - delete newhandle; + // failure in module constructor + delete newmod; + delete newhandle; LastModuleError = "Unable to load " + filename_str + ": " + modexcept.GetReason(); ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); return false; } this->ModCount++; - FOREACH_MOD(I_OnLoadModule,OnLoadModule(newmod, filename_str)); + FOREACH_MOD(I_OnLoadModule,OnLoadModule(newmod)); /* We give every module a chance to re-prioritize when we introduce a new one, * not just the one thats loading, as the new module could affect the preference @@ -521,72 +434,133 @@ bool ModuleManager::Load(const char* filename) return true; } -bool ModuleManager::Unload(const char* filename) +bool ModuleManager::CanUnload(Module* mod) { - std::string filename_str(filename); - std::map::iterator modfind = Modules.find(filename); + std::map::iterator modfind = Modules.find(mod->ModuleSourceFile); - if (modfind != Modules.end()) + if (modfind == Modules.end() || modfind->second != mod) { - if (modfind->second->GetVersion().Flags & VF_STATIC) - { - LastModuleError = "Module " + filename_str + " not unloadable (marked static)"; - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; - } - std::pair intercount = GetInterfaceInstanceCount(modfind->second); - if (intercount.first > 0) - { - LastModuleError = "Failed to unload module " + filename_str + ", being used by " + ConvToStr(intercount.first) + " other(s) via interface '" + intercount.second + "'"; - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; - } + LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!"; + ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); + return false; + } + if (mod->GetVersion().Flags & VF_STATIC) + { + LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)"; + ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); + return false; + } + std::pair intercount = GetInterfaceInstanceCount(mod); + if (intercount.first > 0) + { + LastModuleError = "Failed to unload module " + mod->ModuleSourceFile + ", being used by " + ConvToStr(intercount.first) + " other(s) via interface '" + intercount.second + "'"; + ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); + return false; + } + return true; +} - std::vector items = Extensible::BeginUnregister(modfind->second); - /* Give the module a chance to tidy out all its metadata */ - for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++) - { - modfind->second->OnCleanup(TYPE_CHANNEL,c->second); - c->second->doUnhookExtensions(items); - const UserMembList* users = c->second->GetUsers(); - for(UserMembCIter mi = users->begin(); mi != users->end(); mi++) - mi->second->doUnhookExtensions(items); - } - for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++) - { - modfind->second->OnCleanup(TYPE_USER,u->second); - u->second->doUnhookExtensions(items); - } +void ModuleManager::DoSafeUnload(Module* mod) +{ + std::map::iterator modfind = Modules.find(mod->ModuleSourceFile); + + std::vector > items; + ServerInstance->Extensions.BeginUnregister(modfind->second, items); + /* Give the module a chance to tidy out all its metadata */ + for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++) + { + mod->OnCleanup(TYPE_CHANNEL,c->second); + c->second->doUnhookExtensions(items); + const UserMembList* users = c->second->GetUsers(); + for(UserMembCIter mi = users->begin(); mi != users->end(); mi++) + mi->second->doUnhookExtensions(items); + } + for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++) + { + mod->OnCleanup(TYPE_USER,u->second); + u->second->doUnhookExtensions(items); + } + for(char m='A'; m < 'z'; m++) + { + ModeHandler* mh; + mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER); + if (mh && mh->creator == mod) + ServerInstance->Modes->DelMode(mh); + mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL); + if (mh && mh->creator == mod) + ServerInstance->Modes->DelMode(mh); + } - /* Tidy up any dangling resolvers */ - ServerInstance->Res->CleanResolvers(modfind->second); + /* Tidy up any dangling resolvers */ + ServerInstance->Res->CleanResolvers(mod); - FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(modfind->second, modfind->first)); + FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod)); - this->DetachAll(modfind->second); + DetachAll(mod); - ServerInstance->Parser->RemoveCommands(modfind->second); - ServerInstance->Modes->RemoveModes(modfind->second); + Modules.erase(modfind); + ServerInstance->GlobalCulls.AddItem(mod); - ServerInstance->GlobalCulls.AddItem(modfind->second); - Modules.erase(modfind); + ServerInstance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str()); + this->ModCount--; + ServerInstance->BuildISupport(); +} - ServerInstance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",filename); - this->ModCount--; - ServerInstance->BuildISupport(); - return true; - } +namespace { + struct UnloadAction : public HandlerBase0 + { + Module* const mod; + UnloadAction(Module* m) : mod(m) {} + void Call() + { + DLLManager* dll = mod->ModuleDLLManager; + ServerInstance->Modules->DoSafeUnload(mod); + ServerInstance->GlobalCulls.Apply(); + delete dll; + ServerInstance->GlobalCulls.AddItem(this); + } + }; - LastModuleError = "Module " + filename_str + " is not loaded, cannot unload it!"; - ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); - return false; + struct ReloadAction : public HandlerBase0 + { + Module* const mod; + HandlerBase1* const callback; + ReloadAction(Module* m, HandlerBase1* c) + : mod(m), callback(c) {} + void Call() + { + DLLManager* dll = mod->ModuleDLLManager; + std::string name = mod->ModuleSourceFile; + ServerInstance->Modules->DoSafeUnload(mod); + ServerInstance->GlobalCulls.Apply(); + delete dll; + bool rv = ServerInstance->Modules->Load(name.c_str()); + callback->Call(rv); + ServerInstance->GlobalCulls.AddItem(this); + } + }; +} + +bool ModuleManager::Unload(Module* mod) +{ + if (!CanUnload(mod)) + return false; + ServerInstance->AtomicActions.AddAction(new UnloadAction(mod)); + return true; +} + +void ModuleManager::Reload(Module* mod, HandlerBase1* callback) +{ + if (CanUnload(mod)) + ServerInstance->AtomicActions.AddAction(new ReloadAction(mod, callback)); + else + callback->Call(false); } /* We must load the modules AFTER initializing the socket engine, now */ void ModuleManager::LoadAll() { - char configToken[MAXBUF]; - ModCount = -1; + ModCount = 0; printf("\nLoading core commands"); fflush(stdout); @@ -614,12 +588,15 @@ void ModuleManager::LoadAll() printf("\n"); } - for(int count = 0; count < ServerInstance->Config->ConfValueEnum("module"); count++) + for(int count = 0;; count++) { - ServerInstance->Config->ConfValue("module", "name", count, configToken, MAXBUF); - printf_c("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",configToken); + ConfigTag* tag = ServerInstance->Config->ConfValue("module", count); + if (!tag) + break; + std::string name = tag->getString("name"); + printf_c("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",name.c_str()); - if (!this->Load(configToken)) + if (!this->Load(name.c_str())) { ServerInstance->Logs->Log("MODULE", DEFAULT, this->LastError()); printf_c("\n[\033[1;31m*\033[0m] %s\n\n", this->LastError().c_str()); @@ -628,6 +605,29 @@ void ModuleManager::LoadAll() } } +void ModuleManager::UnloadAll() +{ + /* We do this more than once, so that any service providers get a + * chance to be unhooked by the modules using them, but then get + * a chance to be removed themsleves. + * + * Note: this deliberately does NOT delete the DLLManager objects + */ + for (int tries = 0; tries < 4; tries++) + { + std::map::iterator i = Modules.begin(); + while (i != Modules.end()) + { + std::map::iterator me = i++; + if (CanUnload(me->second)) + { + DoSafeUnload(me->second); + } + } + ServerInstance->GlobalCulls.Apply(); + } +} + bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod) { if (Features.find(FeatureName) == Features.end()) @@ -761,24 +761,6 @@ const std::string& ModuleManager::GetModuleName(Module* m) return nothing; } -/* This is ugly, yes, but hash_map's arent designed to be - * addressed in this manner, and this is a bit of a kludge. - * Luckily its a specialist function and rarely used by - * many modules (in fact, it was specially created to make - * m_safelist possible, initially). - */ - -Channel* InspIRCd::GetChannelIndex(long index) -{ - int target = 0; - for (chan_hash::iterator n = this->chanlist->begin(); n != this->chanlist->end(); n++, target++) - { - if (index == target) - return n->second; - } - return NULL; -} - CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector& parameters, User* user) { return this->Parser->CallHandler(commandname, parameters, user); @@ -791,10 +773,9 @@ bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, Us void InspIRCd::AddCommand(Command *f) { - if (!this->Parser->CreateCommand(f)) + if (!this->Parser->AddCommand(f)) { - ModuleException err("Command "+std::string(f->command)+" already exists."); - throw (err); + throw ModuleException("Command "+std::string(f->command)+" already exists."); } } @@ -896,9 +877,8 @@ ConfigReader::~ConfigReader() std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds) { /* Don't need to strlcpy() tag and name anymore, ReadConf() takes const char* */ - std::string result; - - if (!ServerInstance->Config->ConfValue(tag, name, default_value, index, result, allow_linefeeds)) + std::string result = default_value; + if (!ServerInstance->Config->ConfValue(tag, index)->readString(name, result, allow_linefeeds)) { this->error = CONF_VALUE_NOT_FOUND; } @@ -912,7 +892,8 @@ std::string ConfigReader::ReadValue(const std::string &tag, const std::string &n bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index) { - return ServerInstance->Config->ConfValueBool(tag, name, default_value, index); + bool def = (default_value == "yes"); + return ServerInstance->Config->ConfValue(tag, index)->getBool(name, def); } bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index) @@ -923,13 +904,8 @@ bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive) { - int result; - - if(!ServerInstance->Config->ConfValueInteger(tag, name, default_value, index, result)) - { - this->error = CONF_VALUE_NOT_FOUND; - return 0; - } + int v = atoi(default_value.c_str()); + int result = ServerInstance->Config->ConfValue(tag, index)->getInt(name, v); if ((need_positive) && (result < 0)) { @@ -954,12 +930,11 @@ long ConfigReader::GetError() int ConfigReader::Enumerate(const std::string &tag) { - return ServerInstance->Config->ConfValueEnum(tag); -} - -int ConfigReader::EnumerateValues(const std::string &tag, int index) -{ - return ServerInstance->Config->ConfVarEnum(tag, index); + ServerInstance->Logs->Log("MODULE", DEBUG, "Module is using ConfigReader::Enumerate on %s; this is slow!", + tag.c_str()); + int i=0; + while (ServerInstance->Config->ConfValue(tag, i)) i++; + return i; } FileReader::FileReader(const std::string &filename)