src/modules.cpp

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