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 <iostream>
  28 #include "inspircd.h"
  29 #include "exitcodes.h"
  30
  31 #ifndef _WIN32
  32         #include <dirent.h>
  33 #endif
  34
  35 static intrusive_list<dynamic_reference_base>* dynrefs = NULL;
  36
  37 void dynamic_reference_base::reset_all()
  38 {
  39         if (!dynrefs)
  40                 return;
  41         for (intrusive_list<dynamic_reference_base>::iterator i = dynrefs->begin(); i != dynrefs->end(); ++i)
  42                 (*i)->resolve();
  43 }
  44
  45 // Version is a simple class for holding a modules version number
  46 Version::Version(const std::string &desc, int flags) : description(desc), Flags(flags)
  47 {
  48 }
  49
  50 Version::Version(const std::string &desc, int flags, const std::string& linkdata)
  51 : description(desc), Flags(flags), link_data(linkdata)
  52 {
  53 }
  54
  55 Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { }
  56
  57 void Event::Send()
  58 {
  59         FOREACH_MOD(OnEvent, (*this));
  60 }
  61
  62 // These declarations define the behavours of the base class Module (which does nothing at all)
  63
  64 Module::Module() { }
  65 CullResult Module::cull()
  66 {
  67         return classbase::cull();
  68 }
  69 Module::~Module()
  70 {
  71 }
  72
  73 void Module::DetachEvent(Implementation i)
  74 {
  75         ServerInstance->Modules->Detach(i, this);
  76 }
  77
  78 void            Module::ReadConfig(ConfigStatus& status) { }
  79 ModResult       Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { DetachEvent(I_OnSendSnotice); return MOD_RES_PASSTHRU; }
  80 void            Module::OnUserConnect(LocalUser*) { DetachEvent(I_OnUserConnect); }
  81 void            Module::OnUserQuit(User*, const std::string&, const std::string&) { DetachEvent(I_OnUserQuit); }
  82 void            Module::OnUserDisconnect(LocalUser*) { DetachEvent(I_OnUserDisconnect); }
  83 void            Module::OnUserJoin(Membership*, bool, bool, CUList&) { DetachEvent(I_OnUserJoin); }
  84 void            Module::OnPostJoin(Membership*) { DetachEvent(I_OnPostJoin); }
  85 void            Module::OnUserPart(Membership*, std::string&, CUList&) { DetachEvent(I_OnUserPart); }
  86 void            Module::OnPreRehash(User*, const std::string&) { DetachEvent(I_OnPreRehash); }
  87 void            Module::OnModuleRehash(User*, const std::string&) { DetachEvent(I_OnModuleRehash); }
  88 ModResult       Module::OnUserPreJoin(LocalUser*, Channel*, const std::string&, std::string&, const std::string&) { DetachEvent(I_OnUserPreJoin); return MOD_RES_PASSTHRU; }
  89 void            Module::OnMode(User*, User*, Channel*, const std::vector<std::string>&, const std::vector<TranslateType>&) { DetachEvent(I_OnMode); }
  90 void            Module::OnOper(User*, const std::string&) { DetachEvent(I_OnOper); }
  91 void            Module::OnPostOper(User*, const std::string&, const std::string &) { DetachEvent(I_OnPostOper); }
  92 void            Module::OnInfo(User*) { DetachEvent(I_OnInfo); }
  93 void            Module::OnWhois(User*, User*) { DetachEvent(I_OnWhois); }
  94 ModResult       Module::OnUserPreInvite(User*, User*, Channel*, time_t) { DetachEvent(I_OnUserPreInvite); return MOD_RES_PASSTHRU; }
  95 ModResult       Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&, MessageType) { DetachEvent(I_OnUserPreMessage); return MOD_RES_PASSTHRU; }
  96 ModResult       Module::OnUserPreNick(LocalUser*, const std::string&) { DetachEvent(I_OnUserPreNick); return MOD_RES_PASSTHRU; }
  97 void            Module::OnUserPostNick(User*, const std::string&) { DetachEvent(I_OnUserPostNick); }
  98 ModResult       Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { DetachEvent(I_OnPreMode); return MOD_RES_PASSTHRU; }
  99 void            Module::On005Numeric(std::map<std::string, std::string>&) { DetachEvent(I_On005Numeric); }
 100 ModResult       Module::OnKill(User*, User*, const std::string&) { DetachEvent(I_OnKill); return MOD_RES_PASSTHRU; }
 101 void            Module::OnLoadModule(Module*) { DetachEvent(I_OnLoadModule); }
 102 void            Module::OnUnloadModule(Module*) { DetachEvent(I_OnUnloadModule); }
 103 void            Module::OnBackgroundTimer(time_t) { DetachEvent(I_OnBackgroundTimer); }
 104 ModResult       Module::OnPreCommand(std::string&, std::vector<std::string>&, LocalUser*, bool, const std::string&) { DetachEvent(I_OnPreCommand); return MOD_RES_PASSTHRU; }
 105 void            Module::OnPostCommand(Command*, const std::vector<std::string>&, LocalUser*, CmdResult, const std::string&) { DetachEvent(I_OnPostCommand); }
 106 void            Module::OnUserInit(LocalUser*) { DetachEvent(I_OnUserInit); }
 107 ModResult       Module::OnCheckReady(LocalUser*) { DetachEvent(I_OnCheckReady); return MOD_RES_PASSTHRU; }
 108 ModResult       Module::OnUserRegister(LocalUser*) { DetachEvent(I_OnUserRegister); return MOD_RES_PASSTHRU; }
 109 ModResult       Module::OnUserPreKick(User*, Membership*, const std::string&) { DetachEvent(I_OnUserPreKick); return MOD_RES_PASSTHRU; }
 110 void            Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { DetachEvent(I_OnUserKick); }
 111 ModResult       Module::OnRawMode(User*, Channel*, ModeHandler*, const std::string&, bool) { DetachEvent(I_OnRawMode); return MOD_RES_PASSTHRU; }
 112 ModResult       Module::OnCheckInvite(User*, Channel*) { DetachEvent(I_OnCheckInvite); return MOD_RES_PASSTHRU; }
 113 ModResult       Module::OnCheckKey(User*, Channel*, const std::string&) { DetachEvent(I_OnCheckKey); return MOD_RES_PASSTHRU; }
 114 ModResult       Module::OnCheckLimit(User*, Channel*) { DetachEvent(I_OnCheckLimit); return MOD_RES_PASSTHRU; }
 115 ModResult       Module::OnCheckChannelBan(User*, Channel*) { DetachEvent(I_OnCheckChannelBan); return MOD_RES_PASSTHRU; }
 116 ModResult       Module::OnCheckBan(User*, Channel*, const std::string&) { DetachEvent(I_OnCheckBan); return MOD_RES_PASSTHRU; }
 117 ModResult       Module::OnExtBanCheck(User*, Channel*, char) { DetachEvent(I_OnExtBanCheck); return MOD_RES_PASSTHRU; }
 118 ModResult       Module::OnStats(char, User*, string_list&) { DetachEvent(I_OnStats); return MOD_RES_PASSTHRU; }
 119 ModResult       Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { DetachEvent(I_OnChangeLocalUserHost); return MOD_RES_PASSTHRU; }
 120 ModResult       Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { DetachEvent(I_OnChangeLocalUserGECOS); return MOD_RES_PASSTHRU; }
 121 ModResult       Module::OnPreTopicChange(User*, Channel*, const std::string&) { DetachEvent(I_OnPreTopicChange); return MOD_RES_PASSTHRU; }
 122 void            Module::OnEvent(Event&) { DetachEvent(I_OnEvent); }
 123 ModResult       Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { DetachEvent(I_OnPassCompare); return MOD_RES_PASSTHRU; }
 124 void            Module::OnGlobalOper(User*) { DetachEvent(I_OnGlobalOper); }
 125 void            Module::OnPostConnect(User*) { DetachEvent(I_OnPostConnect); }
 126 void            Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&, MessageType) { DetachEvent(I_OnUserMessage); }
 127 void            Module::OnUserInvite(User*, User*, Channel*, time_t) { DetachEvent(I_OnUserInvite); }
 128 void            Module::OnPostTopicChange(User*, Channel*, const std::string&) { DetachEvent(I_OnPostTopicChange); }
 129 void            Module::OnSyncUser(User*, ProtocolInterface::Server&) { DetachEvent(I_OnSyncUser); }
 130 void            Module::OnSyncChannel(Channel*, ProtocolInterface::Server&) { DetachEvent(I_OnSyncChannel); }
 131 void            Module::OnSyncNetwork(ProtocolInterface::Server&) { DetachEvent(I_OnSyncNetwork); }
 132 void            Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { DetachEvent(I_OnDecodeMetaData); }
 133 void            Module::OnChangeHost(User*, const std::string&) { DetachEvent(I_OnChangeHost); }
 134 void            Module::OnChangeName(User*, const std::string&) { DetachEvent(I_OnChangeName); }
 135 void            Module::OnChangeIdent(User*, const std::string&) { DetachEvent(I_OnChangeIdent); }
 136 void            Module::OnAddLine(User*, XLine*) { DetachEvent(I_OnAddLine); }
 137 void            Module::OnDelLine(User*, XLine*) { DetachEvent(I_OnDelLine); }
 138 void            Module::OnExpireLine(XLine*) { DetachEvent(I_OnExpireLine); }
 139 void            Module::OnCleanup(int, void*) { }
 140 ModResult       Module::OnChannelPreDelete(Channel*) { DetachEvent(I_OnChannelPreDelete); return MOD_RES_PASSTHRU; }
 141 void            Module::OnChannelDelete(Channel*) { DetachEvent(I_OnChannelDelete); }
 142 ModResult       Module::OnSetAway(User*, const std::string &) { DetachEvent(I_OnSetAway); return MOD_RES_PASSTHRU; }
 143 ModResult       Module::OnWhoisLine(User*, User*, int&, std::string&) { DetachEvent(I_OnWhoisLine); return MOD_RES_PASSTHRU; }
 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::OnText(User*, void*, int, const std::string&, char, CUList&) { DetachEvent(I_OnText); }
 148 ModResult       Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { DetachEvent(I_OnNamesListItem); return MOD_RES_PASSTHRU; }
 149 ModResult       Module::OnNumeric(User*, unsigned int, const std::string&) { DetachEvent(I_OnNumeric); return MOD_RES_PASSTHRU; }
 150 ModResult   Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { DetachEvent(I_OnAcceptConnection); return MOD_RES_PASSTHRU; }
 151 void            Module::OnSendWhoLine(User*, const std::vector<std::string>&, User*, Membership*, std::string&) { DetachEvent(I_OnSendWhoLine); }
 152 void            Module::OnSetUserIP(LocalUser*) { DetachEvent(I_OnSetUserIP); }
 153
 154 #ifdef INSPIRCD_ENABLE_TESTSUITE
 155 void            Module::OnRunTestSuite() { }
 156 #endif
 157
 158 ServiceProvider::ServiceProvider(Module* Creator, const std::string& Name, ServiceType Type)
 159         : creator(Creator), name(Name), service(Type)
 160 {
 161         if ((ServerInstance) && (ServerInstance->Modules->NewServices))
 162                 ServerInstance->Modules->NewServices->push_back(this);
 163 }
 164
 165 void ServiceProvider::DisableAutoRegister()
 166 {
 167         if ((ServerInstance) && (ServerInstance->Modules->NewServices))
 168         {
 169                 ModuleManager::ServiceList& list = *ServerInstance->Modules->NewServices;
 170                 ModuleManager::ServiceList::iterator it = std::find(list.begin(), list.end(), this);
 171                 if (it != list.end())
 172                         list.erase(it);
 173         }
 174 }
 175
 176 ModuleManager::ModuleManager()
 177 {
 178 }
 179
 180 ModuleManager::~ModuleManager()
 181 {
 182 }
 183
 184 bool ModuleManager::Attach(Implementation i, Module* mod)
 185 {
 186         if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
 187                 return false;
 188
 189         EventHandlers[i].push_back(mod);
 190         return true;
 191 }
 192
 193 bool ModuleManager::Detach(Implementation i, Module* mod)
 194 {
 195         EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
 196
 197         if (x == EventHandlers[i].end())
 198                 return false;
 199
 200         EventHandlers[i].erase(x);
 201         return true;
 202 }
 203
 204 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
 205 {
 206         for (size_t n = 0; n < sz; ++n)
 207                 Attach(i[n], mod);
 208 }
 209
 210 void ModuleManager::AttachAll(Module* mod)
 211 {
 212         for (size_t i = I_BEGIN + 1; i != I_END; ++i)
 213                 Attach((Implementation)i, mod);
 214 }
 215
 216 void ModuleManager::DetachAll(Module* mod)
 217 {
 218         for (size_t n = I_BEGIN + 1; n != I_END; ++n)
 219                 Detach((Implementation)n, mod);
 220 }
 221
 222 bool ModuleManager::SetPriority(Module* mod, Priority s)
 223 {
 224         for (size_t n = I_BEGIN + 1; n != I_END; ++n)
 225                 SetPriority(mod, (Implementation)n, s);
 226
 227         return true;
 228 }
 229
 230 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which)
 231 {
 232         /** To change the priority of a module, we first find its position in the vector,
 233          * then we find the position of the other modules in the vector that this module
 234          * wants to be before/after. We pick off either the first or last of these depending
 235          * on which they want, and we make sure our module is *at least* before or after
 236          * the first or last of this subset, depending again on the type of priority.
 237          */
 238         size_t my_pos = 0;
 239
 240         /* Locate our module. This is O(n) but it only occurs on module load so we're
 241          * not too bothered about it
 242          */
 243         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 244         {
 245                 if (EventHandlers[i][x] == mod)
 246                 {
 247                         my_pos = x;
 248                         goto found_src;
 249                 }
 250         }
 251
 252         /* Eh? this module doesnt exist, probably trying to set priority on an event
 253          * theyre not attached to.
 254          */
 255         return false;
 256
 257 found_src:
 258         // The modules registered for a hook are called in reverse order (to allow for easier removal
 259         // of list entries while looping), meaning that the Priority given to us has the exact opposite effect
 260         // on the list, e.g.: PRIORITY_BEFORE will actually put 'mod' after 'which', etc.
 261         size_t swap_pos = my_pos;
 262         switch (s)
 263         {
 264                 case PRIORITY_LAST:
 265                         if (prioritizationState != PRIO_STATE_FIRST)
 266                                 return true;
 267                         else
 268                                 swap_pos = 0;
 269                         break;
 270                 case PRIORITY_FIRST:
 271                         if (prioritizationState != PRIO_STATE_FIRST)
 272                                 return true;
 273                         else
 274                                 swap_pos = EventHandlers[i].size() - 1;
 275                         break;
 276                 case PRIORITY_BEFORE:
 277                 {
 278                         /* Find the latest possible position, only searching AFTER our position */
 279                         for (size_t x = EventHandlers[i].size() - 1; 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 after
 288                         return true;
 289                 }
 290                 /* Place this module before a set of other modules */
 291                 case PRIORITY_AFTER:
 292                 {
 293                         for (size_t x = 0; x < my_pos; ++x)
 294                         {
 295                                 if (EventHandlers[i][x] == which)
 296                                 {
 297                                         swap_pos = x;
 298                                         goto swap_now;
 299                                 }
 300                         }
 301                         // didn't find it - either not loaded or we're already before
 302                         return true;
 303                 }
 304         }
 305
 306 swap_now:
 307         /* Do we need to swap? */
 308         if (swap_pos != my_pos)
 309         {
 310                 // We are going to change positions; we'll need to run again to verify all requirements
 311                 if (prioritizationState == PRIO_STATE_LAST)
 312                         prioritizationState = PRIO_STATE_AGAIN;
 313                 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
 314                 int incrmnt = 1;
 315
 316                 if (my_pos > swap_pos)
 317                         incrmnt = -1;
 318
 319                 for (unsigned int j = my_pos; j != swap_pos; j += incrmnt)
 320                 {
 321                         if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0)))
 322                                 continue;
 323
 324                         std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
 325                 }
 326         }
 327
 328         return true;
 329 }
 330
 331 bool ModuleManager::PrioritizeHooks()
 332 {
 333         /* We give every module a chance to re-prioritize when we introduce a new one,
 334          * not just the one thats loading, as the new module could affect the preference
 335          * of others
 336          */
 337         for (int tries = 0; tries < 20; tries++)
 338         {
 339                 prioritizationState = tries > 0 ? PRIO_STATE_LAST : PRIO_STATE_FIRST;
 340                 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
 341                         n->second->Prioritize();
 342
 343                 if (prioritizationState == PRIO_STATE_LAST)
 344                         break;
 345                 if (tries == 19)
 346                 {
 347                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Hook priority dependency loop detected");
 348                         return false;
 349                 }
 350         }
 351         return true;
 352 }
 353
 354 bool ModuleManager::CanUnload(Module* mod)
 355 {
 356         std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 357
 358         if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying))
 359         {
 360                 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
 361                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 362                 return false;
 363         }
 364         if (mod->GetVersion().Flags & VF_STATIC)
 365         {
 366                 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
 367                 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 368                 return false;
 369         }
 370
 371         mod->dying = true;
 372         return true;
 373 }
 374
 375 void ModuleManager::DoSafeUnload(Module* mod)
 376 {
 377         // First, notify all modules that a module is about to be unloaded, so in case
 378         // they pass execution to the soon to be unloaded module, it will happen now,
 379         // i.e. before we unregister the services of the module being unloaded
 380         FOREACH_MOD(OnUnloadModule, (mod));
 381
 382         std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
 383
 384         std::vector<reference<ExtensionItem> > items;
 385         ServerInstance->Extensions.BeginUnregister(modfind->second, items);
 386         /* Give the module a chance to tidy out all its metadata */
 387         const chan_hash& chans = ServerInstance->GetChans();
 388         for (chan_hash::const_iterator c = chans.begin(); c != chans.end(); )
 389         {
 390                 Channel* chan = c->second;
 391                 ++c;
 392                 mod->OnCleanup(TYPE_CHANNEL, chan);
 393                 chan->doUnhookExtensions(items);
 394                 const UserMembList* users = chan->GetUsers();
 395                 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
 396                         mi->second->doUnhookExtensions(items);
 397         }
 398
 399         const user_hash& users = ServerInstance->Users->GetUsers();
 400         for (user_hash::const_iterator u = users.begin(); u != users.end(); )
 401         {
 402                 User* user = u->second;
 403                 // The module may quit the user (e.g. SSL mod unloading) and that will remove it from the container
 404                 ++u;
 405                 mod->OnCleanup(TYPE_USER, user);
 406                 user->doUnhookExtensions(items);
 407         }
 408
 409         const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
 410         for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); )
 411         {
 412                 ModeHandler* mh = i->second;
 413                 ++i;
 414                 if (mh->creator == mod)
 415                         this->DelService(*mh);
 416         }
 417
 418         const ModeParser::ModeHandlerMap& chanmodes = ServerInstance->Modes->GetModes(MODETYPE_CHANNEL);
 419         for (ModeParser::ModeHandlerMap::const_iterator i = chanmodes.begin(); i != chanmodes.end(); )
 420         {
 421                 ModeHandler* mh = i->second;
 422                 ++i;
 423                 if (mh->creator == mod)
 424                         this->DelService(*mh);
 425         }
 426
 427         for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
 428         {
 429                 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
 430                 if (curr->second->creator == mod)
 431                         DataProviders.erase(curr);
 432         }
 433
 434         dynamic_reference_base::reset_all();
 435
 436         DetachAll(mod);
 437
 438         Modules.erase(modfind);
 439         ServerInstance->GlobalCulls.AddItem(mod);
 440
 441         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Module %s unloaded",mod->ModuleSourceFile.c_str());
 442         ServerInstance->ISupport.Build();
 443 }
 444
 445 void ModuleManager::UnloadAll()
 446 {
 447         /* We do this more than once, so that any service providers get a
 448          * chance to be unhooked by the modules using them, but then get
 449          * a chance to be removed themsleves.
 450          *
 451          * Note: this deliberately does NOT delete the DLLManager objects
 452          */
 453         for (int tries = 0; tries < 4; tries++)
 454         {
 455                 std::map<std::string, Module*>::iterator i = Modules.begin();
 456                 while (i != Modules.end())
 457                 {
 458                         std::map<std::string, Module*>::iterator me = i++;
 459                         if (CanUnload(me->second))
 460                         {
 461                                 DoSafeUnload(me->second);
 462                         }
 463                 }
 464                 ServerInstance->GlobalCulls.Apply();
 465         }
 466 }
 467
 468 namespace
 469 {
 470         struct UnloadAction : public HandlerBase0<void>
 471         {
 472                 Module* const mod;
 473                 UnloadAction(Module* m) : mod(m) {}
 474                 void Call()
 475                 {
 476                         DLLManager* dll = mod->ModuleDLLManager;
 477                         ServerInstance->Modules->DoSafeUnload(mod);
 478                         ServerInstance->GlobalCulls.Apply();
 479                         // In pure static mode this is always NULL
 480                         delete dll;
 481                         ServerInstance->GlobalCulls.AddItem(this);
 482                 }
 483         };
 484
 485         struct ReloadAction : public HandlerBase0<void>
 486         {
 487                 Module* const mod;
 488                 HandlerBase1<void, bool>* const callback;
 489                 ReloadAction(Module* m, HandlerBase1<void, bool>* c)
 490                         : mod(m), callback(c) {}
 491                 void Call()
 492                 {
 493                         DLLManager* dll = mod->ModuleDLLManager;
 494                         std::string name = mod->ModuleSourceFile;
 495                         ServerInstance->Modules->DoSafeUnload(mod);
 496                         ServerInstance->GlobalCulls.Apply();
 497                         delete dll;
 498                         bool rv = ServerInstance->Modules->Load(name);
 499                         if (callback)
 500                                 callback->Call(rv);
 501                         ServerInstance->GlobalCulls.AddItem(this);
 502                 }
 503         };
 504 }
 505
 506 bool ModuleManager::Unload(Module* mod)
 507 {
 508         if (!CanUnload(mod))
 509                 return false;
 510         ServerInstance->AtomicActions.AddAction(new UnloadAction(mod));
 511         return true;
 512 }
 513
 514 void ModuleManager::Reload(Module* mod, HandlerBase1<void, bool>* callback)
 515 {
 516         if (CanUnload(mod))
 517                 ServerInstance->AtomicActions.AddAction(new ReloadAction(mod, callback));
 518         else
 519                 callback->Call(false);
 520 }
 521
 522 void ModuleManager::LoadAll()
 523 {
 524         std::map<std::string, ServiceList> servicemap;
 525         LoadCoreModules(servicemap);
 526
 527         ConfigTagList tags = ServerInstance->Config->ConfTags("module");
 528         for (ConfigIter i = tags.first; i != tags.second; ++i)
 529         {
 530                 ConfigTag* tag = i->second;
 531                 std::string name = tag->getString("name");
 532                 this->NewServices = &servicemap[name];
 533                 std::cout << "[" << con_green << "*" << con_reset << "] Loading module:\t" << con_green << name << con_reset << std::endl;
 534
 535                 if (!this->Load(name, true))
 536                 {
 537                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, this->LastError());
 538                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << this->LastError() << std::endl << std::endl;
 539                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 540                 }
 541         }
 542
 543         ConfigStatus confstatus;
 544
 545         for (ModuleMap::const_iterator i = Modules.begin(); i != Modules.end(); ++i)
 546         {
 547                 Module* mod = i->second;
 548                 try
 549                 {
 550                         ServerInstance->Logs->Log("MODULE", LOG_DEBUG, "Initializing %s", i->first.c_str());
 551                         AttachAll(mod);
 552                         AddServices(servicemap[i->first]);
 553                         mod->init();
 554                         mod->ReadConfig(confstatus);
 555                 }
 556                 catch (CoreException& modexcept)
 557                 {
 558                         LastModuleError = "Unable to initialize " + mod->ModuleSourceFile + ": " + modexcept.GetReason();
 559                         ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
 560                         std::cout << std::endl << "[" << con_red << "*" << con_reset << "] " << LastModuleError << std::endl << std::endl;
 561                         ServerInstance->Exit(EXIT_STATUS_MODULE);
 562                 }
 563         }
 564
 565         this->NewServices = NULL;
 566
 567         if (!PrioritizeHooks())
 568                 ServerInstance->Exit(EXIT_STATUS_MODULE);
 569 }
 570
 571 std::string& ModuleManager::LastError()
 572 {
 573         return LastModuleError;
 574 }
 575
 576 void ModuleManager::AddServices(const ServiceList& list)
 577 {
 578         for (ServiceList::const_iterator i = list.begin(); i != list.end(); ++i)
 579         {
 580                 ServiceProvider& s = **i;
 581                 AddService(s);
 582         }
 583 }
 584
 585 void ModuleManager::AddService(ServiceProvider& item)
 586 {
 587         switch (item.service)
 588         {
 589                 case SERVICE_COMMAND:
 590                         if (!ServerInstance->Parser.AddCommand(static_cast<Command*>(&item)))
 591                                 throw ModuleException("Command "+std::string(item.name)+" already exists.");
 592                         return;
 593                 case SERVICE_MODE:
 594                 {
 595                         ModeHandler* mh = static_cast<ModeHandler*>(&item);
 596                         ServerInstance->Modes->AddMode(mh);
 597                         DataProviders.insert(std::make_pair((mh->GetModeType() == MODETYPE_CHANNEL ? "mode/" : "umode/") + item.name, &item));
 598                         dynamic_reference_base::reset_all();
 599                         return;
 600                 }
 601                 case SERVICE_METADATA:
 602                         if (!ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item)))
 603                                 throw ModuleException("Extension " + std::string(item.name) + " already exists.");
 604                         return;
 605                 case SERVICE_DATA:
 606                 case SERVICE_IOHOOK:
 607                 {
 608                         if ((!item.name.compare(0, 5, "mode/", 5)) || (!item.name.compare(0, 6, "umode/", 6)))
 609                                 throw ModuleException("The \"mode/\" and the \"umode\" service name prefixes are reserved.");
 610
 611                         DataProviders.insert(std::make_pair(item.name, &item));
 612                         std::string::size_type slash = item.name.find('/');
 613                         if (slash != std::string::npos)
 614                         {
 615                                 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
 616                                 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
 617                         }
 618                         dynamic_reference_base::reset_all();
 619                         return;
 620                 }
 621                 default:
 622                         throw ModuleException("Cannot add unknown service type");
 623         }
 624 }
 625
 626 void ModuleManager::DelService(ServiceProvider& item)
 627 {
 628         switch (item.service)
 629         {
 630                 case SERVICE_MODE:
 631                         if (!ServerInstance->Modes->DelMode(static_cast<ModeHandler*>(&item)))
 632                                 throw ModuleException("Mode "+std::string(item.name)+" does not exist.");
 633                         // Fall through
 634                 case SERVICE_DATA:
 635                 case SERVICE_IOHOOK:
 636                 {
 637                         for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
 638                         {
 639                                 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
 640                                 if (curr->second == &item)
 641                                         DataProviders.erase(curr);
 642                         }
 643                         dynamic_reference_base::reset_all();
 644                         return;
 645                 }
 646                 default:
 647                         throw ModuleException("Cannot delete unknown service type");
 648         }
 649 }
 650
 651 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
 652 {
 653         switch (type)
 654         {
 655                 case SERVICE_DATA:
 656                 case SERVICE_IOHOOK:
 657                 {
 658                         std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
 659                         if (i != DataProviders.end() && i->second->service == type)
 660                                 return i->second;
 661                         return NULL;
 662                 }
 663                 // TODO implement finding of the other types
 664                 default:
 665                         throw ModuleException("Cannot find unknown service type");
 666         }
 667 }
 668
 669 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
 670         : name(Name), value(NULL), creator(Creator)
 671 {
 672         if (!dynrefs)
 673                 dynrefs = new intrusive_list<dynamic_reference_base>;
 674         dynrefs->push_front(this);
 675
 676         // Resolve unless there is no ModuleManager (part of class InspIRCd)
 677         if (ServerInstance)
 678                 resolve();
 679 }
 680
 681 dynamic_reference_base::~dynamic_reference_base()
 682 {
 683         dynrefs->erase(this);
 684         if (dynrefs->empty())
 685         {
 686                 delete dynrefs;
 687                 dynrefs = NULL;
 688         }
 689 }
 690
 691 void dynamic_reference_base::SetProvider(const std::string& newname)
 692 {
 693         name = newname;
 694         resolve();
 695 }
 696
 697 void dynamic_reference_base::resolve()
 698 {
 699         std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
 700         if (i != ServerInstance->Modules->DataProviders.end())
 701                 value = static_cast<DataProvider*>(i->second);
 702         else
 703                 value = NULL;
 704 }
 705
 706 Module* ModuleManager::Find(const std::string &name)
 707 {
 708         std::map<std::string, Module*>::iterator modfind = Modules.find(name);
 709
 710         if (modfind == Modules.end())
 711                 return NULL;
 712         else
 713                 return modfind->second;
 714 }