src/modules.cpp

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