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