]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules.cpp
This works with multiple remote includes now except it hangs when an include is withi...
[user/henk/code/inspircd.git] / src / modules.cpp
index 354d9877e94bcfcae24b894086b00632177d40eb..6fecc1f507d8cd8f16a577271a840fb25b74705e 100644 (file)
@@ -106,10 +106,12 @@ std::string Event::GetEventID()
 
                Module::Module(InspIRCd* Me) : ServerInstance(Me) { }
                Module::~Module() { }
+void           Module::OnReadConfig(ServerConfig*, ConfigReader*) { }
+int            Module::OnDownloadFile(const std::string&, std::istream*&) { return 0; }
 void           Module::OnUserConnect(User*) { }
 void           Module::OnUserQuit(User*, const std::string&, const std::string&) { }
 void           Module::OnUserDisconnect(User*) { }
-void           Module::OnUserJoin(User*, Channel*, bool&) { }
+void           Module::OnUserJoin(User*, Channel*, bool, bool&) { }
 void           Module::OnPostJoin(User*, Channel*) { }
 void           Module::OnUserPart(User*, Channel*, const std::string&, bool&) { }
 void           Module::OnRehash(User*, const std::string&) { }
@@ -191,8 +193,6 @@ void                Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
 
 ModuleManager::ModuleManager(InspIRCd* Ins) : ModCount(0), Instance(Ins)
 {
-       for (int n = I_BEGIN; n != I_END; ++n)
-               EventHandlers.push_back(std::vector<Module*>());
 }
 
 ModuleManager::~ModuleManager()
@@ -241,18 +241,20 @@ bool ModuleManager::SetPriority(Module* mod, PriorityState s)
 
 bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules, size_t sz)
 {
-       if (GetModuleName(mod) != "m_spanningtree.so")
-               Instance->Log(DEBUG,"ModuleManager::SetPriority called by %s, priority state %s num_modules=%u", GetModuleName(mod).c_str(), s == PRIO_BEFORE ? "PRIO_BEFORE" : 
-                       s == PRIO_AFTER ? "PRIO_AFTER" :
-                       s == PRIO_LAST ? "PRIO_LAST" :
-                       s == PRIO_FIRST ? "PRIO_FIRST" : "<unknown!>",
-                       sz);
-
+       /** 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
+        * wants to be before/after. We pick off either the first or last of these depending
+        * 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;
        size_t source = 0;
        bool swap = true;
        bool found = false;
 
+       /* Locate our module. This is O(n) but it only occurs on module load so we're
+        * not too bothered about it
+        */
        for (size_t x = 0; x != EventHandlers[i].size(); ++x)
        {
                if (EventHandlers[i][x] == mod)
@@ -263,36 +265,30 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s,
                }
        }
 
+       /* Eh? this module doesnt exist, probably trying to set priority on an event
+        * theyre not attached to.
+        */
        if (!found)
                return false;
 
-       Instance->Log(DEBUG,"ModuleManager::SetPriority: My position: %u", source);
-
-       if (modules)
-       {
-               for (size_t n = 0; n < sz; ++n)
-               {
-                       if (modules[n])
-                               Instance->Log(DEBUG,"    Listed Module: [%08x] %s", modules[n], GetModuleName(modules[n]).c_str());
-                       else
-                               Instance->Log(DEBUG,"    [null module]");
-               }
-       }
-
        switch (s)
        {
+               /* Dummy value */
                case PRIO_DONTCARE:
                        swap = false;
                break;
+               /* Module wants to be first, sod everything else */
                case PRIO_FIRST:
                        swap_pos = 0;
                break;
+               /* Module is submissive and wants to be last... awww. */
                case PRIO_LAST:
                        if (EventHandlers[i].empty())
                                swap_pos = 0;
                        else
                                swap_pos = EventHandlers[i].size() - 1;
                break;
+               /* Place this module after a set of other modules */
                case PRIO_AFTER:
                {
                        /* Find the latest possible position */
@@ -311,6 +307,7 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s,
                        }
                }
                break;
+               /* Place this module before a set of other modules */
                case PRIO_BEFORE:
                {
                        swap_pos = EventHandlers[i].size() - 1;
@@ -330,26 +327,16 @@ bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s,
                break;
        }
 
+       /* Do we need to swap? */
        if (swap && (swap_pos != source))
-       {
                std::swap(EventHandlers[i][swap_pos], EventHandlers[i][source]);
-               Instance->Log(DEBUG,"Swap locations %u and %u", swap_pos, source);
-       }
-       else
-               Instance->Log(DEBUG,"No need to swap");
-
-       Instance->Log(DEBUG,"New ordering:");
-       for (size_t x = 0; x != EventHandlers[i].size(); ++x)
-       {
-               Instance->Log(DEBUG,"  [%08x] %s", EventHandlers[i][x], GetModuleName(EventHandlers[i][x]).c_str());
-       }
 
        return true;
 }
 
-const char* ModuleManager::LastError()
+std::string& ModuleManager::LastError()
 {
-       return MODERR;
+       return LastModuleError;
 }
 
 bool ModuleManager::Load(const char* filename)
@@ -389,31 +376,28 @@ bool ModuleManager::Load(const char* filename)
 
        if (!ServerConfig::DirValid(modfile))
        {
-               snprintf(MODERR, MAXBUF,"Module %s is not within the modules directory.", modfile);
-               Instance->Log(DEFAULT, MODERR);
+               LastModuleError = "Module " + filename_str + " is not within the modules directory.";
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
        
        if (!ServerConfig::FileExists(modfile))
        {
-               snprintf(MODERR,MAXBUF,"Module file could not be found: %s", modfile);
-               Instance->Log(DEFAULT, MODERR);
+               LastModuleError = "Module file could not be found: " + filename_str;
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
        
        if (Modules.find(filename_str) != Modules.end())
        {       
-               Instance->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
-               snprintf(MODERR, MAXBUF, "Module already loaded");
+               LastModuleError = "Module " + filename_str + " is already loaded, cannot load a module twice!";
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
                
-       Module* newmod;
-       ircd_module* newhandle;
-       
-       newmod = NULL;
-       newhandle = NULL;
-               
+       Module* newmod = NULL;
+       ircd_module* newhandle = NULL;
+
        try
        {
                /* This will throw a CoreException if there's a problem loading
@@ -422,15 +406,17 @@ bool ModuleManager::Load(const char* filename)
                newhandle = new ircd_module(Instance, modfile, "init_module");
                newmod = newhandle->CallInit();
 
-               if(newmod)
+               if (newmod)
                {
                        Version v = newmod->GetVersion();
 
                        if (v.API != API_VERSION)
                        {
+                               DetachAll(newmod);
                                delete newmod;
-                               Instance->Log(DEFAULT,"Unable to load %s: Incorrect module API version: %d (our version: %d)",modfile,v.API,API_VERSION);
-                               snprintf(MODERR,MAXBUF,"Loader/Linker error: Incorrect module API version: %d (our version: %d)",v.API,API_VERSION);
+                               delete newhandle;
+                               LastModuleError = "Unable to load " + filename_str + ": Incorrect module API version: " + ConvToStr(v.API) + " (our version: " + ConvToStr(API_VERSION) + ")";
+                               Instance->Log(DEFAULT, LastModuleError);
                                return false;
                        }
                        else
@@ -442,33 +428,54 @@ bool ModuleManager::Load(const char* filename)
                }
                else
                {
-                       Instance->Log(DEFAULT, "Unable to load %s",modfile);
-                       snprintf(MODERR,MAXBUF, "Probably missing init_module() entrypoint, but dlsym() didn't notice a problem");
+                       delete newhandle;
+                       LastModuleError = "Unable to load " + filename_str + ": Probably missing init_module() entrypoint, but dlsym() didn't notice a problem";
+                       Instance->Log(DEFAULT, LastModuleError);
                        return false;
                }
        }
+       /** XXX: Is there anything we can do about this mess? -- Brain */
        catch (LoadModuleException& modexcept)
        {
-               Instance->Log(DEFAULT,"Unable to load %s: %s", modfile, modexcept.GetReason());
-               snprintf(MODERR,MAXBUF,"Loader/Linker error: %s", modexcept.GetReason());
+               DetachAll(newmod);
+               if (newmod)
+                       delete newmod;
+               if (newhandle)
+                       delete newhandle;
+               LastModuleError = "Unable to load " + filename_str + ": Error when loading: " + modexcept.GetReason();
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
        catch (FindSymbolException& modexcept)
        {
-               Instance->Log(DEFAULT,"Unable to load %s: %s", modfile, modexcept.GetReason());
-               snprintf(MODERR,MAXBUF,"Loader/Linker error: %s", modexcept.GetReason());
+               DetachAll(newmod);
+               if (newmod)
+                       delete newmod;
+               if (newhandle)
+                       delete newhandle;
+               LastModuleError = "Unable to load " + filename_str + ": Error finding symbol: " + modexcept.GetReason();
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
        catch (CoreException& modexcept)
        {
-               Instance->Log(DEFAULT,"Unable to load %s: %s",modfile,modexcept.GetReason());
-               snprintf(MODERR,MAXBUF,"Factory function of %s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
+               DetachAll(newmod);
+               if (newmod)
+                       delete newmod;
+               if (newhandle)
+                       delete newhandle;
+               LastModuleError = "Unable to load " + filename_str + ": " + modexcept.GetReason();
+               Instance->Log(DEFAULT, LastModuleError);
                return false;
        }
-       
+
        this->ModCount++;
        FOREACH_MOD_I(Instance,I_OnLoadModule,OnLoadModule(newmod, filename_str));
 
+       /* 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
+        * of others
+        */
        for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
                n->second.second->Prioritize();
 
@@ -478,26 +485,22 @@ bool ModuleManager::Load(const char* filename)
 
 bool ModuleManager::Unload(const char* filename)
 {
-       std::string filename_str = filename;
+       std::string filename_str(filename);
        std::map<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(filename);
 
        if (modfind != Modules.end())
        {
                if (modfind->second.second->GetVersion().Flags & VF_STATIC)
                {
-                       Instance->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
-                       snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
+                       LastModuleError = "Module " + filename_str + " not unloadable (marked static)";
+                       Instance->Log(DEFAULT, LastModuleError);
                        return false;
                }
                std::pair<int,std::string> intercount = GetInterfaceInstanceCount(modfind->second.second);
                if (intercount.first > 0)
                {
-                       Instance->Log(DEFAULT,"Failed to unload module %s, being used by %d other(s) via interface '%s'",filename, intercount.first, intercount.second.c_str());
-                       snprintf(MODERR,MAXBUF,"Module not unloadable (Still in use by %d other module%s which %s using its interface '%s') -- unload dependent modules first!",
-                                       intercount.first,
-                                       intercount.first > 1 ? "s" : "",
-                                       intercount.first > 1 ? "are" : "is",
-                                       intercount.second.c_str());
+                       LastModuleError = "Failed to unload module " + filename_str + ", being used by " + ConvToStr(intercount.first) + " other(s) via interface '" + intercount.second + "'";
+                       Instance->Log(DEFAULT, LastModuleError);
                        return false;
                }
 
@@ -531,8 +534,8 @@ bool ModuleManager::Unload(const char* filename)
                return true;
        }
 
-       Instance->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
-       snprintf(MODERR,MAXBUF,"Module not loaded");
+       LastModuleError = "Module " + filename_str + " is not loaded, cannot unload it!";
+       Instance->Log(DEFAULT, LastModuleError);
        return false;
 }
 
@@ -549,13 +552,11 @@ void ModuleManager::LoadAll()
                
                if (!this->Load(configToken))           
                {
-                       Instance->Log(DEFAULT,"There was an error loading the module '%s': %s", configToken, this->LastError());
-                       printf_c("\n[\033[1;31m*\033[0m] There was an error loading the module '%s': %s\n\n", configToken, this->LastError());
+                       Instance->Log(DEFAULT, this->LastError());
+                       printf_c("\n[\033[1;31m*\033[0m] %s\n\n", this->LastError().c_str());
                        Instance->Exit(EXIT_STATUS_MODULE);
                }
        }
-       printf_c("\nA total of \033[1;32m%d\033[0m module%s been loaded.\n", (this->GetCount()+1), (this->GetCount()+1) == 1 ? " has" : "s have");
-       Instance->Log(DEFAULT,"Total loaded modules: %d", this->GetCount()+1);
 }
 
 bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod)
@@ -824,7 +825,11 @@ ConfigReader::ConfigReader(InspIRCd* Instance, const std::string &filename) : Se
        this->data = new ConfigDataHash;
        this->privatehash = true;
        this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
-       this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog);
+       for (int pass = 0; pass < 2; pass++)
+       {
+               /*** XXX: Can return a 'not ready yet!' code! */
+               this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog, pass);
+       }
        if (!this->readerror)
                this->error = CONF_FILE_NOT_FOUND;
 }