src/modmanager_dynamic.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "xline.h"
  16 #include "socket.h"
  17 #include "socketengine.h"
  18 #include "command_parse.h"
  19 #include "dns.h"
  20 #include "exitcodes.h"
  21
  22 #ifndef WIN32
  23 #include <dirent.h>
  24 #endif
  25
  26 #ifndef PURE_STATIC
  27
  28 bool ModuleManager::Load(const char* filename)
  29 {
  30         /* Don't allow people to specify paths for modules, it doesn't work as expected */
  31         if (strchr(filename, '/'))
  32                 return false;
  33         /* Do we have a glob pattern in the filename?
  34          * The user wants to load multiple modules which
  35          * match the pattern.
  36          */
  37         if (strchr(filename,'*') || (strchr(filename,'?')))
  38         {
  39                 int n_match = 0;
  40                 DIR* library = opendir(ServerInstance->Config->ModPath.c_str());
  41                 if (library)
  42                 {
  43                         /* Try and locate and load all modules matching the pattern */
  44                         dirent* entry = NULL;
  45                         while (0 != (entry = readdir(library)))
  46                         {
  47                                 if (InspIRCd::Match(entry->d_name, filename, ascii_case_insensitive_map))
  48                                 {
  49                                         if (!this->Load(entry->d_name))
  50                                                 n_match++;
  51                                 }
  52                         }
  53                         closedir(library);
  54                 }
  55                 /* Loadmodule will now return false if any one of the modules failed
  56                  * to load (but wont abort when it encounters a bad one) and when 1 or
  57                  * more modules were actually loaded.
  58                  */
  59                 return (n_match > 0 ? false : true);
  60         }
  61
  62         char modfile[MAXBUF];
  63         snprintf(modfile,MAXBUF,"%s/%s",ServerInstance->Config->ModPath.c_str(),filename);
  64         std::string filename_str = filename;
  65
  66         if (!ServerConfig::FileExists(modfile))
  67         {
  68                 LastModuleError = "Module file could not be found: " + filename_str;
  69                 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
  70                 return false;
  71         }
  72
  73         if (Modules.find(filename_str) != Modules.end())
  74         {
  75                 LastModuleError = "Module " + filename_str + " is already loaded, cannot load a module twice!";
  76                 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
  77                 return false;
  78         }
  79
  80         Module* newmod = NULL;
  81         DLLManager* newhandle = new DLLManager(modfile);
  82
  83         try
  84         {
  85                 newmod = newhandle->CallInit();
  86
  87                 if (newmod)
  88                 {
  89                         newmod->ModuleSourceFile = filename_str;
  90                         newmod->ModuleDLLManager = newhandle;
  91                         Version v = newmod->GetVersion();
  92
  93                         ServerInstance->Logs->Log("MODULE", DEFAULT,"New module introduced: %s (Module version %s)%s",
  94                                 filename, newhandle->GetVersion().c_str(), (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]"));
  95
  96                         Modules[filename_str] = newmod;
  97                 }
  98                 else
  99                 {
 100                         LastModuleError = "Unable to load " + filename_str + ": " + newhandle->LastError();
 101                         ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
 102                         delete newhandle;
 103                         return false;
 104                 }
 105         }
 106         catch (CoreException& modexcept)
 107         {
 108                 // failure in module constructor
 109                 delete newmod;
 110                 delete newhandle;
 111                 LastModuleError = "Unable to load " + filename_str + ": " + modexcept.GetReason();
 112                 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
 113                 return false;
 114         }
 115
 116         this->ModCount++;
 117         FOREACH_MOD(I_OnLoadModule,OnLoadModule(newmod));
 118
 119         /* We give every module a chance to re-prioritize when we introduce a new one,
 120          * not just the one thats loading, as the new module could affect the preference
 121          * of others
 122          */
 123         for(int tries = 0; tries < 20; tries++)
 124         {
 125                 prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
 126                 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
 127                         n->second->Prioritize();
 128
 129                 if (prioritizationState == PRIO_STATE_LAST)
 130                         break;
 131                 if (tries == 19)
 132                         ServerInstance->Logs->Log("MODULE", DEFAULT, "Hook priority dependency loop detected while loading " + filename_str);
 133         }
 134
 135         ServerInstance->BuildISupport();
 136         return true;
 137 }
 138
 139 namespace {
 140         struct UnloadAction : public HandlerBase0<void>
 141         {
 142                 Module* const mod;
 143                 UnloadAction(Module* m) : mod(m) {}
 144                 void Call()
 145                 {
 146                         DLLManager* dll = mod->ModuleDLLManager;
 147                         ServerInstance->Modules->DoSafeUnload(mod);
 148                         ServerInstance->GlobalCulls.Apply();
 149                         delete dll;
 150                         ServerInstance->GlobalCulls.AddItem(this);
 151                 }
 152         };
 153
 154         struct ReloadAction : public HandlerBase0<void>
 155         {
 156                 Module* const mod;
 157                 HandlerBase1<void, bool>* const callback;
 158                 ReloadAction(Module* m, HandlerBase1<void, bool>* c)
 159                         : mod(m), callback(c) {}
 160                 void Call()
 161                 {
 162                         DLLManager* dll = mod->ModuleDLLManager;
 163                         std::string name = mod->ModuleSourceFile;
 164                         ServerInstance->Modules->DoSafeUnload(mod);
 165                         ServerInstance->GlobalCulls.Apply();
 166                         delete dll;
 167                         bool rv = ServerInstance->Modules->Load(name.c_str());
 168                         callback->Call(rv);
 169                         ServerInstance->GlobalCulls.AddItem(this);
 170                 }
 171         };
 172 }
 173
 174 bool ModuleManager::Unload(Module* mod)
 175 {
 176         if (!CanUnload(mod))
 177                 return false;
 178         ServerInstance->AtomicActions.AddAction(new UnloadAction(mod));
 179         return true;
 180 }
 181
 182 void ModuleManager::Reload(Module* mod, HandlerBase1<void, bool>* callback)
 183 {
 184         if (CanUnload(mod))
 185                 ServerInstance->AtomicActions.AddAction(new ReloadAction(mod, callback));
 186         else
 187                 callback->Call(false);
 188 }
 189
 190 /* We must load the modules AFTER initializing the socket engine, now */
 191 void ModuleManager::LoadAll()
 192 {
 193         ModCount = 0;
 194
 195         printf("\nLoading core commands");
 196         fflush(stdout);
 197
 198         DIR* library = opendir(ServerInstance->Config->ModPath.c_str());
 199         if (library)
 200         {
 201                 dirent* entry = NULL;
 202                 while (0 != (entry = readdir(library)))
 203                 {
 204                         if (InspIRCd::Match(entry->d_name, "cmd_*.so", ascii_case_insensitive_map))
 205                         {
 206                                 printf(".");
 207                                 fflush(stdout);
 208
 209                                 if (!Load(entry->d_name))
 210                                 {
 211                                         ServerInstance->Logs->Log("MODULE", DEFAULT, this->LastError());
 212                                         printf_c("\n[\033[1;31m*\033[0m] %s\n\n", this->LastError().c_str());
 213                                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 214                                 }
 215                         }
 216                 }
 217                 closedir(library);
 218                 printf("\n");
 219         }
 220
 221         ConfigTagList tags = ServerInstance->Config->ConfTags("module");
 222         for(ConfigIter i = tags.first; i != tags.second; ++i)
 223         {
 224                 ConfigTag* tag = i->second;
 225                 std::string name = tag->getString("name");
 226                 printf_c("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",name.c_str());
 227
 228                 if (!this->Load(name.c_str()))
 229                 {
 230                         ServerInstance->Logs->Log("MODULE", DEFAULT, this->LastError());
 231                         printf_c("\n[\033[1;31m*\033[0m] %s\n\n", this->LastError().c_str());
 232                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 233                 }
 234         }
 235 }
 236
 237 void ModuleManager::UnloadAll()
 238 {
 239         /* We do this more than once, so that any service providers get a
 240          * chance to be unhooked by the modules using them, but then get
 241          * a chance to be removed themsleves.
 242          *
 243          * Note: this deliberately does NOT delete the DLLManager objects
 244          */
 245         for (int tries = 0; tries < 4; tries++)
 246         {
 247                 std::map<std::string, Module*>::iterator i = Modules.begin();
 248                 while (i != Modules.end())
 249                 {
 250                         std::map<std::string, Module*>::iterator me = i++;
 251                         if (CanUnload(me->second))
 252                         {
 253                                 DoSafeUnload(me->second);
 254                         }
 255                 }
 256                 ServerInstance->GlobalCulls.Apply();
 257         }
 258 }
 259
 260 #endif