]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules.cpp
Fix module unmapping with culled Module objects
[user/henk/code/inspircd.git] / src / modules.cpp
index 48b477658b99382180fcf71daf0bcbde63396f12..f1e53deba59056c952f5bb1b594eb19c8a36e469 100644 (file)
@@ -11,8 +11,6 @@
  * ---------------------------------------------------
  */
 
-/* $Core */
-
 #include "inspircd.h"
 #include "xline.h"
 #include "socket.h"
 
 
 // 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)
-: version(modv + " - " + rev), Flags(flags), API(api_ver)
-{
-}
-
-Request::Request(char* anydata, Module* src, Module* dst)
-: data(anydata), source(src), dest(dst)
+template<>
+VersionBase<API_VERSION>::VersionBase(const std::string &modv, int flags, int, const std::string& rev)
+: description(modv), version(rev), Flags(flags)
 {
-       /* 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)
@@ -46,65 +36,26 @@ Request::Request(Module* src, Module* dst, const char* idstr)
 {
 }
 
-char* Request::GetData()
-{
-       return this->data;
-}
-
-const char* Request::GetId()
+void Request::Send()
 {
-       return this->id;
+       if (dest)
+               dest->OnRequest(*this);
 }
 
-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(InspIRCd* SI)
-{
-       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() { }
+bool Module::cull()
 {
-       return this->id;
+       return true;
 }
-
-
-// These declarations define the behavours of the base class Module (which does nothing at all)
-
-Module::Module(InspIRCd*) { }
 Module::~Module() { }
 
 ModResult      Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; }
@@ -119,7 +70,6 @@ void         Module::OnModuleRehash(User*, const std::string&) { }
 void           Module::OnRehash(User*) { }
 ModResult      Module::OnUserPreJoin(User*, Channel*, const char*, std::string&, const std::string&) { return MOD_RES_PASSTHRU; }
 void           Module::OnMode(User*, void*, int, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
-Version                Module::GetVersion() { return Version("Misconfigured", VF_VENDOR, -1); }
 void           Module::OnOper(User*, const std::string&) { }
 void           Module::OnPostOper(User*, const std::string&, const std::string &) { }
 void           Module::OnInfo(User*) { }
@@ -132,8 +82,8 @@ void         Module::OnUserPostNick(User*, const std::string&) { }
 ModResult      Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { 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<std::string>&, User *, bool, const std::string&) { return MOD_RES_PASSTHRU; }
 void           Module::OnPostCommand(const std::string&, const std::vector<std::string>&, User *, CmdResult, const std::string&) { }
@@ -152,18 +102,18 @@ 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*) { }
 ModResult      Module::OnAddBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
 ModResult      Module::OnDelBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
-void           Module::OnRawSocketAccept(int, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
-int            Module::OnRawSocketWrite(int, const char*, int) { return 0; }
-void           Module::OnRawSocketClose(int) { }
-void           Module::OnRawSocketConnect(int) { }
-int            Module::OnRawSocketRead(int, char*, unsigned int, int&) { return 0; }
+void           Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
+int            Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
+void           Module::OnStreamSocketClose(StreamSocket*) { }
+void           Module::OnStreamSocketConnect(StreamSocket*) { }
+int            Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
 void           Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
 void           Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
 void           Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
@@ -189,16 +139,15 @@ 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::OnBuildExemptList(MessageType, Channel*, User*, char, CUList&, const std::string&) { }
+void           Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
 void           Module::OnGarbageCollect() { }
-void           Module::OnBufferFlushed(User*) { }
 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(EventHandler*, ListenSocketBase*) { }
-ModResult      Module::OnHostCycle(User*) { 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)
 {
@@ -420,82 +369,43 @@ bool ModuleManager::Load(const char* filename)
        }
 
        Module* newmod = NULL;
-       ircd_module* 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 ircd_module(ServerInstance, modfile, "init_module");
-               newmod = newhandle->CallInit();
+               newmod = newhandle->callInit();
 
                if (newmod)
                {
                        newmod->ModuleSourceFile = filename_str;
+                       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] = std::make_pair(newhandle, newmod);
+                       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(ServerInstance,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
@@ -504,8 +414,8 @@ bool ModuleManager::Load(const char* filename)
        for(int tries = 0; tries < 20; tries++)
        {
                prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
-               for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
-                       n->second.second->Prioritize();
+               for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
+                       n->second->Prioritize();
 
                if (prioritizationState == PRIO_STATE_LAST)
                        break;
@@ -517,68 +427,124 @@ 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<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(filename);
+       std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 
-       if (modfind != Modules.end())
+       if (modfind == Modules.end() || modfind->second != mod)
        {
-               if (modfind->second.second->GetVersion().Flags & VF_STATIC)
-               {
-                       LastModuleError = "Module " + filename_str + " not unloadable (marked static)";
-                       ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
-                       return false;
-               }
-               std::pair<int,std::string> intercount = GetInterfaceInstanceCount(modfind->second.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<int,std::string> 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;
+}
 
-               /* 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.second->OnCleanup(TYPE_CHANNEL,c->second);
-               }
-               for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
-               {
-                       modfind->second.second->OnCleanup(TYPE_USER,u->second);
-               }
+void ModuleManager::DoSafeUnload(Module* mod)
+{
+       std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 
-               /* Tidy up any dangling resolvers */
-               ServerInstance->Res->CleanResolvers(modfind->second.second);
+       std::vector<ExtensionItem*> 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);
+       }
 
+       /* Tidy up any dangling resolvers */
+       ServerInstance->Res->CleanResolvers(mod);
 
-               FOREACH_MOD_I(ServerInstance,I_OnUnloadModule,OnUnloadModule(modfind->second.second, modfind->first));
+       FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
 
-               this->DetachAll(modfind->second.second);
+       DetachAll(mod);
 
-               ServerInstance->Parser->RemoveCommands(modfind->second.second);
-               Extensible::UnRegister(modfind->second.second);
+       Modules.erase(modfind);
+       ServerInstance->GlobalCulls.AddItem(mod);
 
-               delete modfind->second.second;
-               delete modfind->second.first;
-               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<void>
+       {
+               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<void>
+       {
+               Module* const mod;
+               HandlerBase1<void, bool>* const callback;
+               ReloadAction(Module* m, HandlerBase1<void, bool>* 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<void, bool>* 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);
@@ -620,6 +586,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<std::string, Module*>::iterator i = Modules.begin();
+               while (i != Modules.end())
+               {
+                       std::map<std::string, Module*>::iterator me = i++;
+                       if (CanUnload(me->second))
+                       {
+                               ServerInstance->GlobalCulls.AddItem(me->second);
+                       }
+               }
+               ServerInstance->GlobalCulls.Apply();
+       }
+}
+
 bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod)
 {
        if (Features.find(FeatureName) == Features.end())
@@ -744,33 +733,15 @@ const std::string& ModuleManager::GetModuleName(Module* m)
 {
        static std::string nothing;
 
-       for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
+       for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
        {
-               if (n->second.second == m)
+               if (n->second == m)
                        return n->first;
        }
 
        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<std::string>& parameters, User* user)
 {
        return this->Parser->CallHandler(commandname, parameters, user);
@@ -783,10 +754,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.");
        }
 }
 
@@ -857,24 +827,24 @@ bool InspIRCd::AddResolver(Resolver* r, bool cached)
 
 Module* ModuleManager::Find(const std::string &name)
 {
-       std::map<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(name);
+       std::map<std::string, Module*>::iterator modfind = Modules.find(name);
 
        if (modfind == Modules.end())
                return NULL;
        else
-               return modfind->second.second;
+               return modfind->second;
 }
 
 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
 {
        std::vector<std::string> retval;
-       for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator x = Modules.begin(); x != Modules.end(); ++x)
-               if (!filter || (x->second.second->GetVersion().Flags & filter))
+       for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
+               if (!filter || (x->second->GetVersion().Flags & filter))
                        retval.push_back(x->first);
        return retval;
 }
 
-ConfigReader::ConfigReader(InspIRCd* Instance)
+ConfigReader::ConfigReader()
 {
        this->error = 0;
 }
@@ -954,12 +924,12 @@ int ConfigReader::EnumerateValues(const std::string &tag, int index)
        return ServerInstance->Config->ConfVarEnum(tag, index);
 }
 
-FileReader::FileReader(InspIRCd* Instance, const std::string &filename)
+FileReader::FileReader(const std::string &filename)
 {
        LoadFile(filename);
 }
 
-FileReader::FileReader(InspIRCd* Instance)
+FileReader::FileReader()
 {
 }