X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules.cpp;h=b2d2f23c68af1acf45b429bd3de819298f0393de;hb=4c751dbbe8945e5efc230a59b0ed51c2ba10cf92;hp=a2c4aa6ea5b8f78fcedc7d2e1768104cfd4b2366;hpb=19487dbebc520450e457472b97d9e7bcd5160c00;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules.cpp b/src/modules.cpp index a2c4aa6ea..b2d2f23c6 100644 --- a/src/modules.cpp +++ b/src/modules.cpp @@ -1,16 +1,29 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2003-2008 Craig Edwards + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2006-2007 Robin Burchell + * Copyright (C) 2006-2007 Oliver Lupton + * Copyright (C) 2007 Pippijn van Steenhoven + * Copyright (C) 2003 randomdan * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd 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. * - * --------------------------------------------------- + * This program 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 this program. If not, see . */ + #include "inspircd.h" #include "xline.h" #include "socket.h" @@ -19,15 +32,27 @@ #include "dns.h" #include "exitcodes.h" -#ifndef WIN32 +#ifndef _WIN32 #include #endif +static std::vector* dynrefs = NULL; + +void dynamic_reference_base::reset_all() +{ + if (!dynrefs) + return; + for(unsigned int i = 0; i < dynrefs->size(); i++) + (*dynrefs)[i]->ClearCache(); +} // 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) +Version::Version(const std::string &desc, int flags) : description(desc), Flags(flags) +{ +} + +Version::Version(const std::string &desc, int flags, const std::string& linkdata) +: description(desc), Flags(flags), link_data(linkdata) { } @@ -87,8 +112,9 @@ ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASS 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&) { } +ModResult Module::OnPreCommand(std::string&, std::vector&, LocalUser*, bool, const std::string&) { return MOD_RES_PASSTHRU; } +void Module::OnPostCommand(const std::string&, const std::vector&, LocalUser*, CmdResult, const std::string&) { } +void Module::OnUserInit(LocalUser*) { } ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; } ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; } ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; } @@ -139,18 +165,18 @@ void Module::OnCleanup(int, void*) { } ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; } void Module::OnChannelDelete(Channel*) { } ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; } -ModResult Module::OnUserList(User*, Channel*) { return MOD_RES_PASSTHRU; } ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; } void Module::OnBuildNeighborList(User*, UserChanList&, std::map&) { } void Module::OnGarbageCollect() { } +ModResult Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { return MOD_RES_PASSTHRU; } void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { } void Module::OnRunTestSuite() { } 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*, ListenSocket*) { } ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; } -void Module::OnSendWhoLine(User*, User*, Channel*, std::string&) { } -ModResult Module::OnChannelRestrictionApply(User*, Channel*, const char*) { return MOD_RES_PASSTHRU; } +void Module::OnSendWhoLine(User*, const std::vector&, User*, std::string&) { } +void Module::OnSetUserIP(LocalUser*) { } ModuleManager::ModuleManager() : ModCount(0) { @@ -200,7 +226,7 @@ bool ModuleManager::SetPriority(Module* mod, Priority s) return true; } -bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module** modules, size_t sz) +bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which) { /** To change the priority of a module, we first find its position in the vector, * then we find the position of the other modules in the vector that this module @@ -208,10 +234,7 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Modul * on which they want, and we make sure our module is *at least* before or after * the first or last of this subset, depending again on the type of priority. */ - size_t swap_pos = 0; - size_t source = 0; - bool swap = true; - bool found = false; + size_t my_pos = 0; /* Locate our module. This is O(n) but it only occurs on module load so we're * not too bothered about it @@ -220,81 +243,65 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Modul { if (EventHandlers[i][x] == mod) { - source = x; - found = true; - break; + my_pos = x; + goto found_src; } } /* Eh? this module doesnt exist, probably trying to set priority on an event * theyre not attached to. */ - if (!found) - return false; + return false; +found_src: + size_t swap_pos = my_pos; switch (s) { - /* Dummy value */ - case PRIORITY_DONTCARE: - swap = false; - break; - /* Module wants to be first, sod everything else */ case PRIORITY_FIRST: if (prioritizationState != PRIO_STATE_FIRST) - swap = false; + return true; else swap_pos = 0; - break; - /* Module wants to be last. */ + break; case PRIORITY_LAST: if (prioritizationState != PRIO_STATE_FIRST) - swap = false; - else if (EventHandlers[i].empty()) - swap_pos = 0; + return true; else swap_pos = EventHandlers[i].size() - 1; - break; - /* Place this module after a set of other modules */ + break; case PRIORITY_AFTER: { - /* Find the latest possible position */ - swap_pos = 0; - swap = false; - for (size_t x = 0; x != EventHandlers[i].size(); ++x) + /* Find the latest possible position, only searching AFTER our position */ + for (size_t x = EventHandlers[i].size() - 1; x > my_pos; --x) { - for (size_t n = 0; n < sz; ++n) + if (EventHandlers[i][x] == which) { - if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos)) - { - swap_pos = x; - swap = true; - } + swap_pos = x; + goto swap_now; } } + // didn't find it - either not loaded or we're already after + return true; } - break; /* Place this module before a set of other modules */ case PRIORITY_BEFORE: { - swap_pos = EventHandlers[i].size() - 1; - swap = false; - for (size_t x = 0; x != EventHandlers[i].size(); ++x) + for (size_t x = 0; x < my_pos; ++x) { - for (size_t n = 0; n < sz; ++n) + if (EventHandlers[i][x] == which) { - if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos)) - { - swap = true; - swap_pos = x; - } + swap_pos = x; + goto swap_now; } } + // didn't find it - either not loaded or we're already before + return true; } - break; } +swap_now: /* Do we need to swap? */ - if (swap && (swap_pos != source)) + if (swap_pos != my_pos) { // We are going to change positions; we'll need to run again to verify all requirements if (prioritizationState == PRIO_STATE_LAST) @@ -302,12 +309,12 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Modul /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */ int incrmnt = 1; - if (source > swap_pos) + if (my_pos > swap_pos) incrmnt = -1; - for (unsigned int j = source; j != swap_pos; j += incrmnt) + for (unsigned int j = my_pos; j != swap_pos; j += incrmnt) { - if (( j + incrmnt > EventHandlers[i].size() - 1) || (j + incrmnt < 0)) + if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0))) continue; std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]); @@ -317,160 +324,249 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Modul return true; } -std::string& ModuleManager::LastError() +bool ModuleManager::CanUnload(Module* mod) { - return LastModuleError; -} + std::map::iterator modfind = Modules.find(mod->ModuleSourceFile); -bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod) -{ - if (Features.find(FeatureName) == Features.end()) + if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying)) { - Features[FeatureName] = Mod; - return true; + LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!"; + ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); + return false; } - return false; -} - -bool ModuleManager::UnpublishFeature(const std::string &FeatureName) -{ - featurelist::iterator iter = Features.find(FeatureName); - - if (iter == Features.end()) + if (mod->GetVersion().Flags & VF_STATIC) + { + LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)"; + ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError); return false; + } - Features.erase(iter); + mod->dying = true; return true; } -Module* ModuleManager::FindFeature(const std::string &FeatureName) +void ModuleManager::DoSafeUnload(Module* mod) { - featurelist::iterator iter = Features.find(FeatureName); - - if (iter == Features.end()) - return NULL; - - return iter->second; -} + std::map::iterator modfind = Modules.find(mod->ModuleSourceFile); -bool ModuleManager::PublishInterface(const std::string &InterfaceName, Module* Mod) -{ - interfacelist::iterator iter = Interfaces.find(InterfaceName); - - if (iter == Interfaces.end()) + 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(); ) { - modulelist ml; - ml.push_back(Mod); - Interfaces[InterfaceName] = std::make_pair(0, ml); + Channel* chan = c->second; + ++c; + mod->OnCleanup(TYPE_CHANNEL, chan); + chan->doUnhookExtensions(items); + const UserMembList* users = chan->GetUsers(); + for(UserMembCIter mi = users->begin(); mi != users->end(); mi++) + mi->second->doUnhookExtensions(items); } - else + for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); ) { - iter->second.second.push_back(Mod); + User* user = u->second; + // The module may quit the user (e.g. SSL mod unloading) and that will remove it from the container + ++u; + mod->OnCleanup(TYPE_USER, user); + user->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); + } + for(std::multimap::iterator i = DataProviders.begin(); i != DataProviders.end(); ) + { + std::multimap::iterator curr = i++; + if (curr->second->creator == mod) + DataProviders.erase(curr); } - return true; -} -bool ModuleManager::UnpublishInterface(const std::string &InterfaceName, Module* Mod) -{ - interfacelist::iterator iter = Interfaces.find(InterfaceName); + dynamic_reference_base::reset_all(); - if (iter == Interfaces.end()) - return false; + /* Tidy up any dangling resolvers */ + ServerInstance->Res->CleanResolvers(mod); + + FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod)); - for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++) + DetachAll(mod); + + Modules.erase(modfind); + ServerInstance->GlobalCulls.AddItem(mod); + + ServerInstance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str()); + this->ModCount--; + ServerInstance->BuildISupport(); +} + +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++) { - if (*x == Mod) + std::map::iterator i = Modules.begin(); + while (i != Modules.end()) { - iter->second.second.erase(x); - if (iter->second.second.empty()) - Interfaces.erase(InterfaceName); - return true; + std::map::iterator me = i++; + if (CanUnload(me->second)) + { + DoSafeUnload(me->second); + } } + ServerInstance->GlobalCulls.Apply(); } - return false; } -modulelist* ModuleManager::FindInterface(const std::string &InterfaceName) +std::string& ModuleManager::LastError() { - interfacelist::iterator iter = Interfaces.find(InterfaceName); - if (iter == Interfaces.end()) - return NULL; - else - return &(iter->second.second); + return LastModuleError; } -bool ModuleManager::ModuleHasInterface(Module* mod, const std::string& InterfaceName) +CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector& parameters, User* user) { - interfacelist::iterator iter = Interfaces.find(InterfaceName); - if (iter == Interfaces.end()) - return false; - else - { - modulelist& ml = iter->second.second; - modulelist::iterator mi = std::find(ml.begin(), ml.end(), mod); - return (mi != ml.end()); - } + return this->Parser->CallHandler(commandname, parameters, user); } -void ModuleManager::UseInterface(const std::string &InterfaceName) +bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user) { - interfacelist::iterator iter = Interfaces.find(InterfaceName); - if (iter != Interfaces.end()) - iter->second.first++; - + return this->Parser->IsValidCommand(commandname, pcnt, user); } -void ModuleManager::DoneWithInterface(const std::string &InterfaceName) +void ModuleManager::AddService(ServiceProvider& item) { - interfacelist::iterator iter = Interfaces.find(InterfaceName); - if (iter != Interfaces.end()) - iter->second.first--; + switch (item.service) + { + case SERVICE_COMMAND: + if (!ServerInstance->Parser->AddCommand(static_cast(&item))) + throw ModuleException("Command "+std::string(item.name)+" already exists."); + return; + case SERVICE_MODE: + if (!ServerInstance->Modes->AddMode(static_cast(&item))) + throw ModuleException("Mode "+std::string(item.name)+" already exists."); + return; + case SERVICE_METADATA: + if (!ServerInstance->Extensions.Register(static_cast(&item))) + throw ModuleException("Extension " + std::string(item.name) + " already exists."); + return; + case SERVICE_DATA: + case SERVICE_IOHOOK: + { + DataProviders.insert(std::make_pair(item.name, &item)); + std::string::size_type slash = item.name.find('/'); + if (slash != std::string::npos) + { + DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item)); + DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item)); + } + return; + } + default: + throw ModuleException("Cannot add unknown service type"); + } } -std::pair ModuleManager::GetInterfaceInstanceCount(Module* m) +void ModuleManager::DelService(ServiceProvider& item) { - for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++) + switch (item.service) { - for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++) + case SERVICE_MODE: + if (!ServerInstance->Modes->DelMode(static_cast(&item))) + throw ModuleException("Mode "+std::string(item.name)+" does not exist."); + return; + case SERVICE_DATA: + case SERVICE_IOHOOK: { - if (*x == m) + for(std::multimap::iterator i = DataProviders.begin(); i != DataProviders.end(); ) { - return std::make_pair(iter->second.first, iter->first); + std::multimap::iterator curr = i++; + if (curr->second == &item) + DataProviders.erase(curr); } + dynamic_reference_base::reset_all(); + return; } + default: + throw ModuleException("Cannot delete unknown service type"); } - return std::make_pair(0, ""); } -const std::string& ModuleManager::GetModuleName(Module* m) +ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name) { - static std::string nothing; - - for (std::map::iterator n = Modules.begin(); n != Modules.end(); ++n) + switch (type) { - if (n->second == m) - return n->first; + case SERVICE_DATA: + case SERVICE_IOHOOK: + { + std::multimap::iterator i = DataProviders.find(name); + if (i != DataProviders.end() && i->second->service == type) + return i->second; + return NULL; + } + // TODO implement finding of the other types + default: + throw ModuleException("Cannot find unknown service type"); } +} - return nothing; +dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name) + : name(Name), value(NULL), creator(Creator) +{ + if (!dynrefs) + dynrefs = new std::vector; + dynrefs->push_back(this); } -CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector& parameters, User* user) +dynamic_reference_base::~dynamic_reference_base() { - return this->Parser->CallHandler(commandname, parameters, user); + for(unsigned int i = 0; i < dynrefs->size(); i++) + { + if (dynrefs->at(i) == this) + { + unsigned int last = dynrefs->size() - 1; + if (i != last) + dynrefs->at(i) = dynrefs->at(last); + dynrefs->erase(dynrefs->begin() + last); + if (dynrefs->empty()) + { + delete dynrefs; + dynrefs = NULL; + } + return; + } + } } -bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user) +void dynamic_reference_base::SetProvider(const std::string& newname) { - return this->Parser->IsValidCommand(commandname, pcnt, user); + name = newname; + ClearCache(); } -void InspIRCd::AddCommand(Command *f) +void dynamic_reference_base::lookup() { - if (!this->Parser->AddCommand(f)) + if (!*this) + throw ModuleException("Dynamic reference to '" + name + "' failed to resolve"); +} + +dynamic_reference_base::operator bool() +{ + if (!value) { - throw ModuleException("Command "+std::string(f->command)+" already exists."); + std::multimap::iterator i = ServerInstance->Modules->DataProviders.find(name); + if (i != ServerInstance->Modules->DataProviders.end()) + value = static_cast(i->second); } + return (value != NULL); } void InspIRCd::SendMode(const std::vector& parameters, User *user) @@ -478,6 +574,14 @@ void InspIRCd::SendMode(const std::vector& parameters, User *user) this->Modes->Process(parameters, user); } + +void InspIRCd::SendGlobalMode(const std::vector& parameters, User *user) +{ + Modes->Process(parameters, user); + if (!Modes->GetLastParse().empty()) + this->PI->SendMode(parameters[0], Modes->GetLastParseParams(), Modes->GetLastParseTranslate()); +} + bool InspIRCd::AddResolver(Resolver* r, bool cached) { if (!cached) @@ -512,6 +616,8 @@ const std::vector ModuleManager::GetAllModuleNames(int filter) ConfigReader::ConfigReader() { this->error = 0; + ServerInstance->Logs->Log("MODULE", DEBUG, "ConfigReader is deprecated in 2.0; " + "use ServerInstance->Config->ConfValue(\"key\") or ->ConfTags(\"key\") instead"); } @@ -629,13 +735,27 @@ void FileReader::CalcSize() void FileReader::LoadFile(const std::string &filename) { - file_cache c; - c.clear(); - if (ServerInstance->Config->ReadFile(c,filename.c_str())) + std::map::iterator file = ServerInstance->Config->Files.find(filename); + if (file != ServerInstance->Config->Files.end()) + { + this->fc = file->second; + } + else { - this->fc = c; - this->CalcSize(); + fc.clear(); + FILE* f = fopen(filename.c_str(), "r"); + if (!f) + return; + char linebuf[MAXBUF*10]; + while (fgets(linebuf, sizeof(linebuf), f)) + { + int len = strlen(linebuf); + if (len) + fc.push_back(std::string(linebuf, len - 1)); + } + fclose(f); } + CalcSize(); } @@ -650,7 +770,7 @@ bool FileReader::Exists() std::string FileReader::GetLine(int x) { - if ((x<0) || ((unsigned)x>fc.size())) + if ((x<0) || ((unsigned)x>=fc.size())) return ""; return fc[x]; }