src/modules.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   8  *   Copyright (C) 2006-2007 Robin Burchell <robin+git@viroteck.net>
   9  *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
  10  *   Copyright (C) 2007 Pippijn van Steenhoven <pip88nl@gmail.com>
  11  *   Copyright (C) 2003 randomdan <???@???>
  12  *
  13  * This file is part of InspIRCd.  InspIRCd is free software: you can
  14  * redistribute it and/or modify it under the terms of the GNU General Public
  15  * License as published by the Free Software Foundation, version 2.
  16  *
  17  * This program is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  19  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26
  27 #include "inspircd.h"
  28 #include "exitcodes.h"
  29 #include <iostream>
  30
  31 static insp::intrusive_list<dynamic_reference_base>* dynrefs = NULL;
  32
  33 void dynamic_reference_base::reset_all()
  34 {
  35         if (!dynrefs)
  36                 return;
  37         for (insp::intrusive_list<dynamic_reference_base>::iterator i = dynrefs->begin(); i != dynrefs->end(); ++i)
  38                 (*i)->resolve();
  39 }
  40
  41 // Version is a simple class for holding a modules version number
  42 Version::Version(const std::string &desc, int flags) : description(desc), Flags(flags)
  43 {
  44 }
  45
  46 Version::Version(const std::string &desc, int flags, const std::string& linkdata)
  47 : description(desc), Flags(flags), link_data(linkdata)
  48 {
  49 }
  50
  51 // These declarations define the behavours of the base class Module (which does nothing at all)
  52
  53 Module::Module()
  54         : ModuleDLLManager(NULL)
  55         , dying(false)
  56 {
  57 }
  58
  59 CullResult Module::cull()
  60 {
  61         return classbase::cull();
  62 }
  63
  64 Module::~Module()
  65 {
  66 }
  67
  68 void Module::DetachEvent(Implementation i)
  69 {
  70         ServerInstance->Modules->Detach(i, this);
  71 }
  72
  73 void            Module::ReadConfig(ConfigStatus& status) { }
  74 ModResult       Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { DetachEvent(I_OnSendSnotice); return MOD_RES_PASSTHRU; }
  75 void            Module::OnUserConnect(LocalUser*) { DetachEvent(I_OnUserConnect); }
  76 ModResult       Module::OnUserPreQuit(LocalUser*, std::string&, std::string&) { DetachEvent(I_OnUserPreQuit); return MOD_RES_PASSTHRU; }
  77 void            Module::OnUserQuit(User*, const std::string&, const std::string&) { DetachEvent(I_OnUserQuit); }
  78 void            Module::OnUserDisconnect(LocalUser*) { DetachEvent(I_OnUserDisconnect); }
  79 void            Module::OnUserJoin(Membership*, bool, bool, CUList&) { DetachEvent(I_OnUserJoin); }
  80 void            Module::OnPostJoin(Membership*) { DetachEvent(I_OnPostJoin); }
  81 void            Module::OnUserPart(Membership*, std::string&, CUList&) { DetachEvent(I_OnUserPart); }
  82 void            Module::OnPreRehash(User*, const std::string&) { DetachEvent(I_OnPreRehash); }
  83 void            Module::OnModuleRehash(User*, const std::string&) { DetachEvent(I_OnModuleRehash); }
  84 ModResult       Module::OnUserPreJoin(LocalUser*, Channel*, const std::string&, std::string&, const std::string&) { DetachEvent(I_OnUserPreJoin); return MOD_RES_PASSTHRU; }
  85 void            Module::OnMode(User*, User*, Channel*, const Modes::ChangeList&, ModeParser::ModeProcessFlag) { DetachEvent(I_OnMode); }
  86 void            Module::OnOper(User*, const std::string&) { DetachEvent(I_OnOper); }
  87 void            Module::OnPostOper(User*, const std::string&, const std::string &) { DetachEvent(I_OnPostOper); }
  88 void            Module::OnPostDeoper(User*) { DetachEvent(I_OnPostDeoper); }
  89 ModResult       Module::OnUserPreInvite(User*, User*, Channel*, time_t) { DetachEvent(I_OnUserPreInvite); return MOD_RES_PASSTHRU; }
  90 ModResult       Module::OnUserPreMessage(User*, const MessageTarget&, MessageDetails&) { DetachEvent(I_OnUserPreMessage); return MOD_RES_PASSTHRU; }
  91 ModResult       Module::OnUserPreNick(LocalUser*, const std::string&) { DetachEvent(I_OnUserPreNick); return MOD_RES_PASSTHRU; }
  92 void            Module::OnUserPostNick(User*, const std::string&) { DetachEvent(I_OnUserPostNick); }
  93 ModResult       Module::OnPreMode(User*, User*, Channel*, Modes::ChangeList&) { DetachEvent(I_OnPreMode); return MOD_RES_PASSTHRU; }
  94 void            Module::On005Numeric(std::map<std::string, std::string>&) { DetachEvent(I_On005Numeric); }
  95 ModResult       Module::OnKill(User*, User*, const std::string&) { DetachEvent(I_OnKill); return MOD_RES_PASSTHRU; }
  96 void            Module::OnLoadModule(Module*) { DetachEvent(I_OnLoadModule); }
  97 void            Module::OnUnloadModule(Module*) { DetachEvent(I_OnUnloadModule); }
  98 void            Module::OnBackgroundTimer(time_t) { DetachEvent(I_OnBackgroundTimer); }
  99 ModResult       Module::OnPreCommand(std::string&, CommandBase::Params&, LocalUser*, bool) { DetachEvent(I_OnPreCommand); return MOD_RES_PASSTHRU; }
 100 void            Module::OnPostCommand(Command*, const CommandBase::Params&, LocalUser*, CmdResult, bool) { DetachEvent(I_OnPostCommand); }
 101 void            Module::OnUserInit(LocalUser*) { DetachEvent(I_OnUserInit); }
 102 void            Module::OnUserPostInit(LocalUser*) { DetachEvent(I_OnUserPostInit); }
 103 ModResult       Module::OnCheckReady(LocalUser*) { DetachEvent(I_OnCheckReady); return MOD_RES_PASSTHRU; }
 104 ModResult       Module::OnUserRegister(LocalUser*) { DetachEvent(I_OnUserRegister); return MOD_RES_PASSTHRU; }
 105 ModResult       Module::OnUserPreKick(User*, Membership*, const std::string&) { DetachEvent(I_OnUserPreKick); return MOD_RES_PASSTHRU; }
 106 void            Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { DetachEvent(I_OnUserKick); }
 107 ModResult       Module::OnRawMode(User*, Channel*, ModeHandler*, const std::string&, bool) { DetachEvent(I_OnRawMode); return MOD_RES_PASSTHRU; }
 108 ModResult       Module::OnCheckInvite(User*, Channel*) { DetachEvent(I_OnCheckInvite); return MOD_RES_PASSTHRU; }
 109 ModResult       Module::OnCheckKey(User*, Channel*, const std::string&) { DetachEvent(I_OnCheckKey); return MOD_RES_PASSTHRU; }
 110 ModResult       Module::OnCheckLimit(User*, Channel*) { DetachEvent(I_OnCheckLimit); return MOD_RES_PASSTHRU; }
 111 ModResult       Module::OnCheckChannelBan(User*, Channel*) { DetachEvent(I_OnCheckChannelBan); return MOD_RES_PASSTHRU; }
 112 ModResult       Module::OnCheckBan(User*, Channel*, const std::string&) { DetachEvent(I_OnCheckBan); return MOD_RES_PASSTHRU; }
 113 ModResult       Module::OnExtBanCheck(User*, Channel*, char) { DetachEvent(I_OnExtBanCheck); return MOD_RES_PASSTHRU; }
 114 ModResult       Module::OnPreChangeHost(LocalUser*, const std::string&) { DetachEvent(I_OnPreChangeHost); return MOD_RES_PASSTHRU; }
 115 ModResult       Module::OnPreChangeRealName(LocalUser*, const std::string&) { DetachEvent(I_OnPreChangeRealName); return MOD_RES_PASSTHRU; }
 116 ModResult       Module::OnPreTopicChange(User*, Channel*, const std::string&) { DetachEvent(I_OnPreTopicChange); return MOD_RES_PASSTHRU; }
 117 ModResult       Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { DetachEvent(I_OnPassCompare); return MOD_RES_PASSTHRU; }
 118 void            Module::OnPostConnect(User*) { DetachEvent(I_OnPostConnect); }
 119 void            Module::OnUserPostMessage(User*, const MessageTarget&, const MessageDetails&) { DetachEvent(I_OnUserPostMessage); }
 120 void            Module::OnUserMessageBlocked(User*, const MessageTarget&, const MessageDetails&) { DetachEvent(I_OnUserMessageBlocked); }
 121 void            Module::OnUserInvite(User*, User*, Channel*, time_t, unsigned int, CUList&) { DetachEvent(I_OnUserInvite); }
 122 void            Module::OnPostTopicChange(User*, Channel*, const std::string&) { DetachEvent(I_OnPostTopicChange); }
 123 void            Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { DetachEvent(I_OnDecodeMetaData); }
 124 void            Module::OnChangeHost(User*, const std::string&) { DetachEvent(I_OnChangeHost); }
 125 void            Module::OnChangeRealName(User*, const std::string&) { DetachEvent(I_OnChangeRealName); }
 126 void            Module::OnChangeIdent(User*, const std::string&) { DetachEvent(I_OnChangeIdent); }
 127 void            Module::OnAddLine(User*, XLine*) { DetachEvent(I_OnAddLine); }
 128 void            Module::OnDelLine(User*, XLine*) { DetachEvent(I_OnDelLine); }
 129 void            Module::OnExpireLine(XLine*) { DetachEvent(I_OnExpireLine); }
 130 void            Module::OnCleanup(ExtensionItem::ExtensibleType, Extensible*) { }
 131 ModResult       Module::OnChannelPreDelete(Channel*) { DetachEvent(I_OnChannelPreDelete); return MOD_RES_PASSTHRU; }
 132 void            Module::OnChannelDelete(Channel*) { DetachEvent(I_OnChannelDelete); }
 133 void            Module::OnBuildNeighborList(User*, IncludeChanList&, std::map<User*,bool>&) { DetachEvent(I_OnBuildNeighborList); }
 134 void            Module::OnGarbageCollect() { DetachEvent(I_OnGarbageCollect); }
 135 ModResult       Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { DetachEvent(I_OnSetConnectClass); return MOD_RES_PASSTHRU; }
 136 void            Module::OnUserMessage(User*, const MessageTarget&, const MessageDetails&) { DetachEvent(I_OnUserMessage); }
 137 ModResult       Module::OnNumeric(User*, const Numeric::Numeric&) { DetachEvent(I_OnNumeric); return MOD_RES_PASSTHRU; }
 138 ModResult   Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { DetachEvent(I_OnAcceptConnection); return MOD_RES_PASSTHRU; }
 139 void            Module::OnSetUserIP(LocalUser*) { DetachEvent(I_OnSetUserIP); }
 140 void            Module::OnServiceAdd(ServiceProvider&) { DetachEvent(I_OnServiceAdd); }
 141 void            Module::OnServiceDel(ServiceProvider&) { DetachEvent(I_OnServiceDel); }
 142 ModResult       Module::OnUserWrite(LocalUser*, ClientProtocol::Message&) { DetachEvent(I_OnUserWrite); return MOD_RES_PASSTHRU; }
 143 ModResult       Module::OnConnectionFail(LocalUser*, BufferedSocketError) { DetachEvent(I_OnConnectionFail); return MOD_RES_PASSTHRU; }
 144
 145 ServiceProvider::ServiceProvider(Module* Creator, const std::string& Name, ServiceType Type)
 146         : creator(Creator), name(Name), service(Type)
 147 {
 148         if ((ServerInstance) && (ServerInstance->Modules->NewServices))
 149                 ServerInstance->Modules->NewServices->push_back(this);
 150 }
 151
 152 void ServiceProvider::DisableAutoRegister()
 153 {
 154         if ((ServerInstance) && (ServerInstance->Modules->NewServices))
 155                 stdalgo::erase(*ServerInstance->Modules->NewServices, this);
 156 }
 157
 158 ModuleManager::ModuleManager()
 159 {
 160 }
 161
 162 ModuleManager::~ModuleManager()
 163 {
 164 }
 165
 166 bool ModuleManager::Attach(Implementation i, Module* mod)
 167 {
 168         if (stdalgo::isin(EventHandlers[i], mod))
 169                 return false;
 170
 171         EventHandlers[i].push_back(mod);
 172         return true;
 173 }
 174
 175 bool ModuleManager::Detach(Implementation i, Module* mod)
 176 {
 177         return stdalgo::erase(EventHandlers[i], mod);
 178 }
 179
 180 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
 181 {
 182         for (size_t n = 0; n < sz; ++n)
 183                 Attach(i[n], mod);
 184 }
 185
 186 void ModuleManager::AttachAll(Module* mod)
 187 {
 188         for (size_t i = 0; i != I_END; ++i)
 189                 Attach((Implementation)i, mod);
 190 }
 191
 192 void ModuleManager::DetachAll(Module* mod)
 193 {
 194         for (size_t n = 0; n != I_END; ++n)
 195                 Detach((Implementation)n, mod);
 196 }
 197
 198 void ModuleManager::SetPriority(Module* mod, Priority s)
 199 {
 200         for (size_t n = 0; n != I_END; ++n)
 201                 SetPriority(mod, (Implementation)n, s);
 202 }
 203
 204 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which)
 205 {
 206         /** To change the priority of a module, we first find its position in the vector,
 207          * then we find the position of the other modules in the vector that this module
 208          * wants to be before/after. We pick off either the first or last of these depending
 209          * on which they want, and we make sure our module is *at least* before or after
 210          * the first or last of this subset, depending again on the type of priority.
 211          */
 212         size_t my_pos = 0;
 213
 214         /* Locate our module. This is O(n) but it only occurs on module load so we're
 215          * not too bothered about it
 216          */
 217         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 218         {
 219                 if (EventHandlers[i][x] == mod)
 220                 {
 221                         my_pos = x;
 222                         goto found_src;
 223                 }
 224         }
 225
 226         /* Eh? this module doesnt exist, probably trying to set priority on an event
 227          * theyre not attached to.
 228          */
 229         return false;
 230
 231 found_src:
 232         // The modules registered for a hook are called in reverse order (to allow for easier removal
 233         // of list entries while looping), meaning that the Priority given to us has the exact opposite effect
 234         // on the list, e.g.: PRIORITY_BEFORE will actually put 'mod' after 'which', etc.
 235         size_t swap_pos = my_pos;
 236         switch (s)
 237         {
 238                 case PRIORITY_LAST:
 239                         if (prioritizationState != PRIO_STATE_FIRST)
 240                                 return true;
 241                         else
 242                                 swap_pos = 0;
 243                         break;
 244                 case PRIORITY_FIRST:
 245                         if (prioritizationState != PRIO_STATE_FIRST)
 246                                 return true;
 247                         else
 248                                 swap_pos = EventHandlers[i].size() - 1;
 249                         break;
 250                 case PRIORITY_BEFORE:
 251                 {
 252                         /* Find the latest possible position, only searching AFTER our position */
 253                         for (size_t x = EventHandlers[i].size() - 1; x > my_pos; --x)
 254                         {
 255                                 if (EventHandlers[i][x] == which)
 256                                 {
 257                                         swap_pos = x;
 258                                         goto swap_now;
 259                                 }
 260                         }
 261                         // didn't find it - either not loaded or we're already after
 262                         return true;
 263                 }
 264                 /* Place this module before a set of other modules */
 265                 case PRIORITY_AFTER:
 266                 {
 267                         for (size_t x = 0; x < my_pos; ++x)
 268                         {
 269                                 if (EventHandlers[i][x] == which)
 270                                 {
 271                                         swap_pos = x;
 272                                         goto swap_now;
 273                                 }
 274                         }
 275                         // didn't find it - either not loaded or we're already before
 276                         return true;
 277                 }
 278         }
 279
 280 swap_now:
 281         /* Do we need to swap? */
 282         if (swap_pos != my_pos)
 283         {
 284                 // We are going to change positions; we'll need to run again to verify all requirements
 285                 if (prioritizationState == PRIO_STATE_LAST)
 286                         prioritizationState = PRIO_STATE_AGAIN;
 287                 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
 288                 int incrmnt = 1;
 289
 290                 if (my_pos > swap_pos)
 291                         incrmnt = -1;
 292
 293                 for (unsigned int j = my_pos; j != swap_pos; j += incrmnt)
 294                 {
 295                         if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0)))
 296                                 continue;
 297
 298                         std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
 299                 }
 300         }
 301
 302         return true;
 303 }
 304
 305 bool ModuleManager::PrioritizeHooks()
 306 {
 307         /* We give every module a chance to re-prioritize when we introduce a new one,
 308          * not just the one thats loading, as the new module could affect the preference
 309          * of others
 310          */
 311         for (int tries = 0; tries < 20; tries++)
 312         {
 313                 prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
 314                 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
 315                         n->second->Prioritize();
 316
 317                 if (prioritizationState == PRIO_STATE_LAST)
 318                         break;
 319                 if (tries == 19)
 320                 {
 321                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Hook priority dependency loop detected");
 322                         return false;
 323                 }
 324         }
 325         return true;
 326 }
 327
 328 bool ModuleManager::CanUnload(Module* mod)
 329 {
 330         std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 331
 332         if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying))
 333         {
 334                 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
 335                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 336                 return false;
 337         }
 338
 339         mod->dying = true;
 340         return true;
 341 }
 342
 343 void ModuleManager::UnregisterModes(Module* mod, ModeType modetype)
 344 {
 345         const ModeParser::ModeHandlerMap& modes = ServerInstance->Modes.GetModes(modetype);
 346         for (ModeParser::ModeHandlerMap::const_iterator i = modes.begin(); i != modes.end(); )
 347         {
 348                 ModeHandler* const mh = i->second;
 349                 ++i;
 350                 if (mh->creator == mod)
 351                         this->DelService(*mh);
 352         }
 353 }
 354
 355 void ModuleManager::DoSafeUnload(Module* mod)
 356 {
 357         // First, notify all modules that a module is about to be unloaded, so in case
 358         // they pass execution to the soon to be unloaded module, it will happen now,
 359         // i.e. before we unregister the services of the module being unloaded
 360         FOREACH_MOD(OnUnloadModule, (mod));
 361
 362         std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 363
 364         // Unregister modes before extensions because modes may require their extension to show the mode being unset
 365         UnregisterModes(mod, MODETYPE_USER);
 366         UnregisterModes(mod, MODETYPE_CHANNEL);
 367
 368         std::vector<reference<ExtensionItem> > items;
 369         ServerInstance->Extensions.BeginUnregister(modfind->second, items);
 370         /* Give the module a chance to tidy out all its metadata */
 371         const chan_hash& chans = ServerInstance->GetChans();
 372         for (chan_hash::const_iterator c = chans.begin(); c != chans.end(); )
 373         {
 374                 Channel* chan = c->second;
 375                 ++c;
 376                 mod->OnCleanup(ExtensionItem::EXT_CHANNEL, chan);
 377                 chan->doUnhookExtensions(items);
 378                 const Channel::MemberMap& users = chan->GetUsers();
 379                 for (Channel::MemberMap::const_iterator mi = users.begin(); mi != users.end(); ++mi)
 380                 {
 381                         mod->OnCleanup(ExtensionItem::EXT_MEMBERSHIP, mi->second);
 382                         mi->second->doUnhookExtensions(items);
 383                 }
 384         }
 385
 386         const user_hash& users = ServerInstance->Users->GetUsers();
 387         for (user_hash::const_iterator u = users.begin(); u != users.end(); )
 388         {
 389                 User* user = u->second;
 390                 // The module may quit the user (e.g. SSL mod unloading) and that will remove it from the container
 391                 ++u;
 392                 mod->OnCleanup(ExtensionItem::EXT_USER, user);
 393                 user->doUnhookExtensions(items);
 394         }
 395
 396         for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
 397         {
 398                 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
 399                 if (curr->second->creator == mod)
 400                         DataProviders.erase(curr);
 401         }
 402
 403         dynamic_reference_base::reset_all();
 404
 405         DetachAll(mod);
 406
 407         Modules.erase(modfind);
 408         ServerInstance->GlobalCulls.AddItem(mod);
 409
 410         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Module %s unloaded",mod->ModuleSourceFile.c_str());
 411         ServerInstance->ISupport.Build();
 412 }
 413
 414 void ModuleManager::UnloadAll()
 415 {
 416         /* We do this more than once, so that any service providers get a
 417          * chance to be unhooked by the modules using them, but then get
 418          * a chance to be removed themsleves.
 419          *
 420          * Note: this deliberately does NOT delete the DLLManager objects
 421          */
 422         for (int tries = 0; tries < 4; tries++)
 423         {
 424                 std::map<std::string, Module*>::iterator i = Modules.begin();
 425                 while (i != Modules.end())
 426                 {
 427                         std::map<std::string, Module*>::iterator me = i++;
 428                         if (CanUnload(me->second))
 429                         {
 430                                 DoSafeUnload(me->second);
 431                         }
 432                 }
 433                 ServerInstance->GlobalCulls.Apply();
 434         }
 435 }
 436
 437 namespace
 438 {
 439         struct UnloadAction : public ActionBase
 440         {
 441                 Module* const mod;
 442                 UnloadAction(Module* m) : mod(m) {}
 443                 void Call() CXX11_OVERRIDE
 444                 {
 445                         DLLManager* dll = mod->ModuleDLLManager;
 446                         ServerInstance->Modules->DoSafeUnload(mod);
 447                         ServerInstance->GlobalCulls.Apply();
 448                         // In pure static mode this is always NULL
 449                         delete dll;
 450                         ServerInstance->GlobalCulls.AddItem(this);
 451                 }
 452         };
 453 }
 454
 455 bool ModuleManager::Unload(Module* mod)
 456 {
 457         if (!CanUnload(mod))
 458                 return false;
 459         ServerInstance->AtomicActions.AddAction(new UnloadAction(mod));
 460         return true;
 461 }
 462
 463 void ModuleManager::LoadAll()
 464 {
 465         std::map<std::string, ServiceList> servicemap;
 466         LoadCoreModules(servicemap);
 467
 468         // Step 1: load all of the modules.
 469         ConfigTagList tags = ServerInstance->Config->ConfTags("module");
 470         for (ConfigIter i = tags.first; i != tags.second; ++i)
 471         {
 472                 ConfigTag* tag = i->second;
 473                 std::string name = ExpandModName(tag->getString("name"));
 474                 this->NewServices = &servicemap[name];
 475
 476                 // Skip modules which are already loaded.
 477                 if (Modules.find(name) != Modules.end())
 478                         continue;
 479
 480                 std::cout << "[" << con_green << "*" << con_reset << "] Loading module:\t" << con_green << name << con_reset << std::endl;
 481                 if (!this->Load(name, true))
 482                 {
 483                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, this->LastError());
 484                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << this->LastError() << std::endl << std::endl;
 485                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 486                 }
 487         }
 488
 489         // Step 2: initialize the modules and register their services.
 490         for (ModuleMap::const_iterator i = Modules.begin(); i != Modules.end(); ++i)
 491         {
 492                 Module* mod = i->second;
 493                 try
 494                 {
 495                         ServerInstance->Logs->Log("MODULE", LOG_DEBUG, "Initializing %s", i->first.c_str());
 496                         AttachAll(mod);
 497                         AddServices(servicemap[i->first]);
 498                         mod->init();
 499                 }
 500                 catch (CoreException& modexcept)
 501                 {
 502                         LastModuleError = "Unable to initialize " + mod->ModuleSourceFile + ": " + modexcept.GetReason();
 503                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 504                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << LastModuleError << std::endl << std::endl;
 505                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 506                 }
 507         }
 508
 509         this->NewServices = NULL;
 510         ConfigStatus confstatus;
 511
 512         // Step 3: Read the configuration for the modules. This must be done as part of
 513         // its own step so that services provided by modules can be registered before
 514         // the configuration is read.
 515         for (ModuleMap::const_iterator i = Modules.begin(); i != Modules.end(); ++i)
 516         {
 517                 Module* mod = i->second;
 518                 try
 519                 {
 520                         ServerInstance->Logs->Log("MODULE", LOG_DEBUG, "Reading configuration for %s", i->first.c_str());
 521                         mod->ReadConfig(confstatus);
 522                 }
 523                 catch (CoreException& modexcept)
 524                 {
 525                         LastModuleError = "Unable to read the configuration for " + mod->ModuleSourceFile + ": " + modexcept.GetReason();
 526                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 527                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << LastModuleError << std::endl << std::endl;
 528                         ServerInstance->Exit(EXIT_STATUS_CONFIG);
 529                 }
 530         }
 531
 532         if (!PrioritizeHooks())
 533                 ServerInstance->Exit(EXIT_STATUS_MODULE);
 534 }
 535
 536 std::string& ModuleManager::LastError()
 537 {
 538         return LastModuleError;
 539 }
 540
 541 void ModuleManager::AddServices(const ServiceList& list)
 542 {
 543         for (ServiceList::const_iterator i = list.begin(); i != list.end(); ++i)
 544         {
 545                 ServiceProvider& s = **i;
 546                 AddService(s);
 547         }
 548 }
 549
 550 void ModuleManager::AddService(ServiceProvider& item)
 551 {
 552         switch (item.service)
 553         {
 554                 case SERVICE_DATA:
 555                 case SERVICE_IOHOOK:
 556                 {
 557                         if ((!item.name.compare(0, 5, "mode/", 5)) || (!item.name.compare(0, 6, "umode/", 6)))
 558                                 throw ModuleException("The \"mode/\" and the \"umode\" service name prefixes are reserved.");
 559
 560                         DataProviders.insert(std::make_pair(item.name, &item));
 561                         std::string::size_type slash = item.name.find('/');
 562                         if (slash != std::string::npos)
 563                         {
 564                                 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
 565                                 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
 566                         }
 567                         dynamic_reference_base::reset_all();
 568                         break;
 569                 }
 570                 default:
 571                         item.RegisterService();
 572         }
 573
 574         FOREACH_MOD(OnServiceAdd, (item));
 575 }
 576
 577 void ModuleManager::DelService(ServiceProvider& item)
 578 {
 579         switch (item.service)
 580         {
 581                 case SERVICE_MODE:
 582                         if (!ServerInstance->Modes->DelMode(static_cast<ModeHandler*>(&item)))
 583                                 throw ModuleException("Mode "+std::string(item.name)+" does not exist.");
 584                         // Fall through
 585                 case SERVICE_DATA:
 586                 case SERVICE_IOHOOK:
 587                 {
 588                         DelReferent(&item);
 589                         return;
 590                 }
 591                 default:
 592                         throw ModuleException("Cannot delete unknown service type");
 593         }
 594
 595         FOREACH_MOD(OnServiceDel, (item));
 596 }
 597
 598 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
 599 {
 600         switch (type)
 601         {
 602                 case SERVICE_DATA:
 603                 case SERVICE_IOHOOK:
 604                 {
 605                         std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
 606                         if (i != DataProviders.end() && i->second->service == type)
 607                                 return i->second;
 608                         return NULL;
 609                 }
 610                 // TODO implement finding of the other types
 611                 default:
 612                         throw ModuleException("Cannot find unknown service type");
 613         }
 614 }
 615
 616 std::string ModuleManager::ExpandModName(const std::string& modname)
 617 {
 618         // Transform "callerid" -> "m_callerid.so" unless it already has a ".so" extension,
 619         // so coremods in the "core_*.so" form aren't changed
 620         std::string ret = modname;
 621         if ((modname.length() < 3) || (modname.compare(modname.size() - 3, 3, ".so")))
 622                 ret.insert(0, "m_").append(".so");
 623         return ret;
 624 }
 625
 626 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
 627         : name(Name), hook(NULL), value(NULL), creator(Creator)
 628 {
 629         if (!dynrefs)
 630                 dynrefs = new insp::intrusive_list<dynamic_reference_base>;
 631         dynrefs->push_front(this);
 632
 633         // Resolve unless there is no ModuleManager (part of class InspIRCd)
 634         if (ServerInstance)
 635                 resolve();
 636 }
 637
 638 dynamic_reference_base::~dynamic_reference_base()
 639 {
 640         dynrefs->erase(this);
 641         if (dynrefs->empty())
 642         {
 643                 delete dynrefs;
 644                 dynrefs = NULL;
 645         }
 646 }
 647
 648 void dynamic_reference_base::SetProvider(const std::string& newname)
 649 {
 650         name = newname;
 651         resolve();
 652 }
 653
 654 void dynamic_reference_base::resolve()
 655 {
 656         // Because find() may return any element with a matching key in case count(key) > 1 use lower_bound()
 657         // to ensure a dynref with the same name as another one resolves to the same object
 658         std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules.DataProviders.lower_bound(name);
 659         if ((i != ServerInstance->Modules.DataProviders.end()) && (i->first == this->name))
 660         {
 661                 ServiceProvider* newvalue = i->second;
 662                 if (value != newvalue)
 663                 {
 664                         value = newvalue;
 665                         if (hook)
 666                                 hook->OnCapture();
 667                 }
 668         }
 669         else
 670                 value = NULL;
 671 }
 672
 673 Module* ModuleManager::Find(const std::string &name)
 674 {
 675         std::map<std::string, Module*>::const_iterator modfind = Modules.find(ExpandModName(name));
 676
 677         if (modfind == Modules.end())
 678                 return NULL;
 679         else
 680                 return modfind->second;
 681 }
 682
 683 void ModuleManager::AddReferent(const std::string& name, ServiceProvider* service)
 684 {
 685         DataProviders.insert(std::make_pair(name, service));
 686         dynamic_reference_base::reset_all();
 687 }
 688
 689 void ModuleManager::DelReferent(ServiceProvider* service)
 690 {
 691         for (std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
 692         {
 693                 ServiceProvider* curr = i->second;
 694                 if (curr == service)
 695                         DataProviders.erase(i++);
 696                 else
 697                         ++i;
 698         }
 699         dynamic_reference_base::reset_all();
 700 }