src/modmanager_dynamic.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #include "inspircd.h"
  21 #include "xline.h"
  22 #include "socket.h"
  23 #include "socketengine.h"
  24 #include "command_parse.h"
  25 #include "exitcodes.h"
  26 #include <iostream>
  27
  28 #ifndef _WIN32
  29 #include <dirent.h>
  30 #endif
  31
  32 #ifndef PURE_STATIC
  33
  34 bool ModuleManager::Load(const std::string& filename, bool defer)
  35 {
  36         /* Don't allow people to specify paths for modules, it doesn't work as expected */
  37         if (filename.find('/') != std::string::npos)
  38                 return false;
  39
  40         const std::string moduleFile = ServerInstance->Config->Paths.PrependModule(filename);
  41
  42         if (!ServerConfig::FileExists(moduleFile.c_str()))
  43         {
  44                 LastModuleError = "Module file could not be found: " + filename;
  45                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
  46                 return false;
  47         }
  48
  49         if (Modules.find(filename) != Modules.end())
  50         {
  51                 LastModuleError = "Module " + filename + " is already loaded, cannot load a module twice!";
  52                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
  53                 return false;
  54         }
  55
  56         Module* newmod = NULL;
  57         DLLManager* newhandle = new DLLManager(moduleFile.c_str());
  58
  59         try
  60         {
  61                 newmod = newhandle->CallInit();
  62
  63                 if (newmod)
  64                 {
  65                         newmod->ModuleSourceFile = filename;
  66                         newmod->ModuleDLLManager = newhandle;
  67                         newmod->dying = false;
  68                         Modules[filename] = newmod;
  69                         std::string version = newhandle->GetVersion();
  70                         if (defer)
  71                         {
  72                                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "New module introduced: %s (Module version %s)",
  73                                         filename.c_str(), version.c_str());
  74                         }
  75                         else
  76                         {
  77                                 ConfigStatus confstatus;
  78
  79                                 AttachAll(newmod);
  80                                 newmod->init();
  81                                 newmod->ReadConfig(confstatus);
  82
  83                                 Version v = newmod->GetVersion();
  84                                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "New module introduced: %s (Module version %s)%s",
  85                                         filename.c_str(), version.c_str(), (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]"));
  86                         }
  87                 }
  88                 else
  89                 {
  90                         LastModuleError = "Unable to load " + filename + ": " + newhandle->LastError();
  91                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
  92                         delete newhandle;
  93                         return false;
  94                 }
  95         }
  96         catch (CoreException& modexcept)
  97         {
  98                 // failure in module constructor
  99                 if (newmod)
 100                 {
 101                         DoSafeUnload(newmod);
 102                         ServerInstance->GlobalCulls.AddItem(newhandle);
 103                 }
 104                 else
 105                         delete newhandle;
 106                 LastModuleError = "Unable to load " + filename + ": " + modexcept.GetReason();
 107                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 108                 return false;
 109         }
 110
 111         if (defer)
 112                 return true;
 113
 114         FOREACH_MOD(OnLoadModule, (newmod));
 115         /* We give every module a chance to re-prioritize when we introduce a new one,
 116          * not just the one thats loading, as the new module could affect the preference
 117          * of others
 118          */
 119         for(int tries = 0; tries < 20; tries++)
 120         {
 121                 prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
 122                 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
 123                         n->second->Prioritize();
 124
 125                 if (prioritizationState == PRIO_STATE_LAST)
 126                         break;
 127                 if (tries == 19)
 128                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Hook priority dependency loop detected while loading " + filename);
 129         }
 130
 131         ServerInstance->ISupport.Build();
 132         return true;
 133 }
 134
 135 namespace {
 136         struct UnloadAction : public HandlerBase0<void>
 137         {
 138                 Module* const mod;
 139                 UnloadAction(Module* m) : mod(m) {}
 140                 void Call()
 141                 {
 142                         DLLManager* dll = mod->ModuleDLLManager;
 143                         ServerInstance->Modules->DoSafeUnload(mod);
 144                         ServerInstance->GlobalCulls.Apply();
 145                         delete dll;
 146                         ServerInstance->GlobalCulls.AddItem(this);
 147                 }
 148         };
 149
 150         struct ReloadAction : public HandlerBase0<void>
 151         {
 152                 Module* const mod;
 153                 HandlerBase1<void, bool>* const callback;
 154                 ReloadAction(Module* m, HandlerBase1<void, bool>* c)
 155                         : mod(m), callback(c) {}
 156                 void Call()
 157                 {
 158                         DLLManager* dll = mod->ModuleDLLManager;
 159                         std::string name = mod->ModuleSourceFile;
 160                         ServerInstance->Modules->DoSafeUnload(mod);
 161                         ServerInstance->GlobalCulls.Apply();
 162                         delete dll;
 163                         bool rv = ServerInstance->Modules->Load(name.c_str());
 164                         if (callback)
 165                                 callback->Call(rv);
 166                         ServerInstance->GlobalCulls.AddItem(this);
 167                 }
 168         };
 169 }
 170
 171 bool ModuleManager::Unload(Module* mod)
 172 {
 173         if (!CanUnload(mod))
 174                 return false;
 175         ServerInstance->AtomicActions.AddAction(new UnloadAction(mod));
 176         return true;
 177 }
 178
 179 void ModuleManager::Reload(Module* mod, HandlerBase1<void, bool>* callback)
 180 {
 181         if (CanUnload(mod))
 182                 ServerInstance->AtomicActions.AddAction(new ReloadAction(mod, callback));
 183         else
 184                 callback->Call(false);
 185 }
 186
 187 /* We must load the modules AFTER initializing the socket engine, now */
 188 void ModuleManager::LoadAll()
 189 {
 190         std::cout << std::endl << "Loading core commands";
 191         fflush(stdout);
 192
 193         DIR* library = opendir(ServerInstance->Config->Paths.Module.c_str());
 194         if (library)
 195         {
 196                 dirent* entry = NULL;
 197                 while (0 != (entry = readdir(library)))
 198                 {
 199                         if (InspIRCd::Match(entry->d_name, "cmd_*.so", ascii_case_insensitive_map))
 200                         {
 201                                 std::cout << ".";
 202                                 fflush(stdout);
 203
 204                                 if (!Load(entry->d_name, true))
 205                                 {
 206                                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, this->LastError());
 207                                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << this->LastError() << std::endl << std::endl;
 208                                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 209                                 }
 210                         }
 211                 }
 212                 closedir(library);
 213                 std::cout << std::endl;
 214         }
 215
 216         ConfigTagList tags = ServerInstance->Config->ConfTags("module");
 217         for(ConfigIter i = tags.first; i != tags.second; ++i)
 218         {
 219                 ConfigTag* tag = i->second;
 220                 std::string name = tag->getString("name");
 221                 std::cout << "[" << con_green << "*" << con_reset << "] Loading module:\t" << con_green << name << con_reset << std::endl;
 222
 223                 if (!this->Load(name, true))
 224                 {
 225                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, this->LastError());
 226                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << this->LastError() << std::endl << std::endl;
 227                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 228                 }
 229         }
 230
 231         ConfigStatus confstatus;
 232
 233         for(std::map<std::string, Module*>::iterator i = Modules.begin(); i != Modules.end(); i++)
 234         {
 235                 Module* mod = i->second;
 236                 try
 237                 {
 238                         ServerInstance->Logs->Log("MODULE", LOG_DEBUG, "Initializing %s", i->first.c_str());
 239                         AttachAll(mod);
 240                         mod->init();
 241                         mod->ReadConfig(confstatus);
 242                 }
 243                 catch (CoreException& modexcept)
 244                 {
 245                         LastModuleError = "Unable to initialize " + mod->ModuleSourceFile + ": " + modexcept.GetReason();
 246                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 247                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << LastModuleError << std::endl << std::endl;
 248                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 249                 }
 250         }
 251
 252         /* We give every module a chance to re-prioritize when we introduce a new one,
 253          * not just the one thats loading, as the new module could affect the preference
 254          * of others
 255          */
 256         for(int tries = 0; tries < 20; tries++)
 257         {
 258                 prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
 259                 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
 260                         n->second->Prioritize();
 261
 262                 if (prioritizationState == PRIO_STATE_LAST)
 263                         break;
 264                 if (tries == 19)
 265                 {
 266                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Hook priority dependency loop detected");
 267                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 268                 }
 269         }
 270 }
 271
 272 #endif