src/modules.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /* $Core: libIRCDmodules */
  15
  16 #include "inspircd.h"
  17 #include "wildcard.h"
  18 #include "xline.h"
  19 #include "socket.h"
  20 #include "socketengine.h"
  21 #include "command_parse.h"
  22 #include "dns.h"
  23 #include "exitcodes.h"
  24
  25 #ifndef WIN32
  26         #include <dirent.h>
  27 #endif
  28
  29 // version is a simple class for holding a modules version number
  30 Version::Version(int major, int minor, int revision, int build, int flags, int api_ver)
  31 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags), API(api_ver)
  32 {
  33 }
  34
  35 Request::Request(char* anydata, Module* src, Module* dst)
  36 : data(anydata), source(src), dest(dst)
  37 {
  38         /* Ensure that because this module doesnt support ID strings, it doesnt break modules that do
  39          * by passing them uninitialized pointers (could happen)
  40          */
  41         id = '\0';
  42 }
  43
  44 Request::Request(Module* src, Module* dst, const char* idstr)
  45 : id(idstr), source(src), dest(dst)
  46 {
  47 }
  48
  49 char* Request::GetData()
  50 {
  51         return this->data;
  52 }
  53
  54 const char* Request::GetId()
  55 {
  56         return this->id;
  57 }
  58
  59 Module* Request::GetSource()
  60 {
  61         return this->source;
  62 }
  63
  64 Module* Request::GetDest()
  65 {
  66         return this->dest;
  67 }
  68
  69 char* Request::Send()
  70 {
  71         if (this->dest)
  72         {
  73                 return dest->OnRequest(this);
  74         }
  75         else
  76         {
  77                 return NULL;
  78         }
  79 }
  80
  81 Event::Event(char* anydata, Module* src, const std::string &eventid) : data(anydata), source(src), id(eventid) { }
  82
  83 char* Event::GetData()
  84 {
  85         return (char*)this->data;
  86 }
  87
  88 Module* Event::GetSource()
  89 {
  90         return this->source;
  91 }
  92
  93 char* Event::Send(InspIRCd* ServerInstance)
  94 {
  95         FOREACH_MOD(I_OnEvent,OnEvent(this));
  96         return NULL;
  97 }
  98
  99 std::string Event::GetEventID()
 100 {
 101         return this->id;
 102 }
 103
 104
 105 // These declarations define the behavours of the base class Module (which does nothing at all)
 106
 107                 Module::Module(InspIRCd* Me) : ServerInstance(Me) { }
 108                 Module::~Module() { }
 109 void            Module::OnUserConnect(User*) { }
 110 void            Module::OnUserQuit(User*, const std::string&, const std::string&) { }
 111 void            Module::OnUserDisconnect(User*) { }
 112 void            Module::OnUserJoin(User*, Channel*, bool&) { }
 113 void            Module::OnPostJoin(User*, Channel*) { }
 114 void            Module::OnUserPart(User*, Channel*, const std::string&, bool&) { }
 115 void            Module::OnRehash(User*, const std::string&) { }
 116 void            Module::OnServerRaw(std::string&, bool, User*) { }
 117 int             Module::OnUserPreJoin(User*, Channel*, const char*, std::string&) { return 0; }
 118 void            Module::OnMode(User*, void*, int, const std::string&) { }
 119 Version         Module::GetVersion() { return Version(1,0,0,0,VF_VENDOR,-1); }
 120 void            Module::OnOper(User*, const std::string&) { }
 121 void            Module::OnPostOper(User*, const std::string&) { }
 122 void            Module::OnInfo(User*) { }
 123 void            Module::OnWhois(User*, User*) { }
 124 int             Module::OnUserPreInvite(User*, User*, Channel*) { return 0; }
 125 int             Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&) { return 0; }
 126 int             Module::OnUserPreNotice(User*, void*, int, std::string&, char, CUList&) { return 0; }
 127 int             Module::OnUserPreNick(User*, const std::string&) { return 0; }
 128 void            Module::OnUserPostNick(User*, const std::string&) { }
 129 int             Module::OnAccessCheck(User*, User*, Channel*, int) { return ACR_DEFAULT; }
 130 void            Module::On005Numeric(std::string&) { }
 131 int             Module::OnKill(User*, User*, const std::string&) { return 0; }
 132 void            Module::OnLoadModule(Module*, const std::string&) { }
 133 void            Module::OnUnloadModule(Module*, const std::string&) { }
 134 void            Module::OnBackgroundTimer(time_t) { }
 135 int             Module::OnPreCommand(const std::string&, const char**, int, User *, bool, const std::string&) { return 0; }
 136 void            Module::OnPostCommand(const std::string&, const char**, int, User *, CmdResult, const std::string&) { }
 137 bool            Module::OnCheckReady(User*) { return true; }
 138 int             Module::OnUserRegister(User*) { return 0; }
 139 int             Module::OnUserPreKick(User*, User*, Channel*, const std::string&) { return 0; }
 140 void            Module::OnUserKick(User*, User*, Channel*, const std::string&, bool&) { }
 141 int             Module::OnCheckInvite(User*, Channel*) { return 0; }
 142 int             Module::OnCheckKey(User*, Channel*, const std::string&) { return 0; }
 143 int             Module::OnCheckLimit(User*, Channel*) { return 0; }
 144 int             Module::OnCheckBan(User*, Channel*) { return 0; }
 145 int             Module::OnStats(char, User*, string_list&) { return 0; }
 146 int             Module::OnChangeLocalUserHost(User*, const std::string&) { return 0; }
 147 int             Module::OnChangeLocalUserGECOS(User*, const std::string&) { return 0; }
 148 int             Module::OnLocalTopicChange(User*, Channel*, const std::string&) { return 0; }
 149 void            Module::OnEvent(Event*) { return; }
 150 char*           Module::OnRequest(Request*) { return NULL; }
 151 int             Module::OnOperCompare(const std::string&, const std::string&, int) { return 0; }
 152 void            Module::OnGlobalOper(User*) { }
 153 void            Module::OnPostConnect(User*) { }
 154 int             Module::OnAddBan(User*, Channel*, const std::string &) { return 0; }
 155 int             Module::OnDelBan(User*, Channel*, const std::string &) { return 0; }
 156 void            Module::OnRawSocketAccept(int, const std::string&, int) { }
 157 int             Module::OnRawSocketWrite(int, const char*, int) { return 0; }
 158 void            Module::OnRawSocketClose(int) { }
 159 void            Module::OnRawSocketConnect(int) { }
 160 int             Module::OnRawSocketRead(int, char*, unsigned int, int&) { return 0; }
 161 void            Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
 162 void            Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
 163 void            Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
 164 void            Module::OnUserInvite(User*, User*, Channel*) { }
 165 void            Module::OnPostLocalTopicChange(User*, Channel*, const std::string&) { }
 166 void            Module::OnGetServerDescription(const std::string&, std::string&) { }
 167 void            Module::OnSyncUser(User*, Module*, void*) { }
 168 void            Module::OnSyncChannel(Channel*, Module*, void*) { }
 169 void            Module::ProtoSendMode(void*, int, void*, const std::string&) { }
 170 void            Module::OnSyncChannelMetaData(Channel*, Module*, void*, const std::string&, bool) { }
 171 void            Module::OnSyncUserMetaData(User*, Module*, void*, const std::string&, bool) { }
 172 void            Module::OnSyncOtherMetaData(Module*, void*, bool) { }
 173 void            Module::OnDecodeMetaData(int, void*, const std::string&, const std::string&) { }
 174 void            Module::ProtoSendMetaData(void*, int, void*, const std::string&, const std::string&) { }
 175 void            Module::OnWallops(User*, const std::string&) { }
 176 void            Module::OnChangeHost(User*, const std::string&) { }
 177 void            Module::OnChangeName(User*, const std::string&) { }
 178 void            Module::OnAddLine(User*, XLine*) { }
 179 void            Module::OnDelLine(User*, XLine*) { }
 180 void            Module::OnCleanup(int, void*) { }
 181 void            Module::OnChannelDelete(Channel*) { }
 182 void            Module::OnSetAway(User*) { }
 183 void            Module::OnCancelAway(User*) { }
 184 int             Module::OnUserList(User*, Channel*, CUList*&) { return 0; }
 185 int             Module::OnWhoisLine(User*, User*, int&, std::string&) { return 0; }
 186 void            Module::OnBuildExemptList(MessageType, Channel*, User*, char, CUList&, const std::string&) { }
 187 void            Module::OnGarbageCollect() { }
 188 void            Module::OnBufferFlushed(User*) { }
 189 void            Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
 190
 191
 192 ModuleManager::ModuleManager(InspIRCd* Ins) : ModCount(0), Instance(Ins)
 193 {
 194         for (int n = I_BEGIN; n != I_END; ++n)
 195                 EventHandlers.push_back(std::vector<Module*>());
 196 }
 197
 198 ModuleManager::~ModuleManager()
 199 {
 200 }
 201
 202 bool ModuleManager::Attach(Implementation i, Module* mod)
 203 {
 204         if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
 205                 return false;
 206
 207         EventHandlers[i].push_back(mod);
 208         return true;
 209 }
 210
 211 bool ModuleManager::Detach(Implementation i, Module* mod)
 212 {
 213         EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
 214
 215         if (x == EventHandlers[i].end())
 216                 return false;
 217
 218         EventHandlers[i].erase(x);
 219         return true;
 220 }
 221
 222 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
 223 {
 224         for (size_t n = 0; n < sz; ++n)
 225                 Attach(i[n], mod);
 226 }
 227
 228 void ModuleManager::DetachAll(Module* mod)
 229 {
 230         for (size_t n = I_BEGIN + 1; n != I_END; ++n)
 231                 Detach((Implementation)n, mod);
 232 }
 233
 234 bool ModuleManager::SetPriority(Module* mod, PriorityState s)
 235 {
 236         for (size_t n = I_BEGIN + 1; n != I_END; ++n)
 237                 SetPriority(mod, (Implementation)n, s);
 238
 239         return true;
 240 }
 241
 242 bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules, size_t sz)
 243 {
 244         if (GetModuleName(mod) != "m_spanningtree.so")
 245                 Instance->Log(DEBUG,"ModuleManager::SetPriority called by %s, priority state %s num_modules=%u", GetModuleName(mod).c_str(), s == PRIO_BEFORE ? "PRIO_BEFORE" :
 246                         s == PRIO_AFTER ? "PRIO_AFTER" :
 247                         s == PRIO_LAST ? "PRIO_LAST" :
 248                         s == PRIO_FIRST ? "PRIO_FIRST" : "<unknown!>",
 249                         sz);
 250
 251         /** To change the priority of a module, we first find its position in the vector,
 252          * then we find the position of the other modules in the vector that this module
 253          * wants to be before/after. We pick off either the first or last of these depending
 254          * on which they want, and we make sure our module is *at least* before or after
 255          * the first or last of this subset, depending again on the type of priority.
 256          */
 257         size_t swap_pos;
 258         size_t source = 0;
 259         bool swap = true;
 260         bool found = false;
 261
 262         /* Locate our module. This is O(n) but it only occurs on module load so we're
 263          * not too bothered about it
 264          */
 265         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 266         {
 267                 if (EventHandlers[i][x] == mod)
 268                 {
 269                         source = x;
 270                         found = true;
 271                         break;
 272                 }
 273         }
 274
 275         /* Eh? this module doesnt exist, probably trying to set priority on an event
 276          * theyre not attached to.
 277          */
 278         if (!found)
 279                 return false;
 280
 281         Instance->Log(DEBUG,"ModuleManager::SetPriority: My position: %u", source);
 282
 283         /* Debug stuff. We will probably comment this out some time */
 284         if (modules)
 285         {
 286                 for (size_t n = 0; n < sz; ++n)
 287                 {
 288                         if (modules[n])
 289                                 Instance->Log(DEBUG,"    Listed Module: [%08x] %s", modules[n], GetModuleName(modules[n]).c_str());
 290                         else
 291                                 Instance->Log(DEBUG,"    [null module]");
 292                 }
 293         }
 294
 295         switch (s)
 296         {
 297                 /* Dummy value */
 298                 case PRIO_DONTCARE:
 299                         swap = false;
 300                 break;
 301                 /* Module wants to be first, sod everything else */
 302                 case PRIO_FIRST:
 303                         swap_pos = 0;
 304                 break;
 305                 /* Module is submissive and wants to be last... awww. */
 306                 case PRIO_LAST:
 307                         if (EventHandlers[i].empty())
 308                                 swap_pos = 0;
 309                         else
 310                                 swap_pos = EventHandlers[i].size() - 1;
 311                 break;
 312                 /* Place this module after a set of other modules */
 313                 case PRIO_AFTER:
 314                 {
 315                         /* Find the latest possible position */
 316                         swap_pos = 0;
 317                         swap = false;
 318                         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 319                         {
 320                                 for (size_t n = 0; n < sz; ++n)
 321                                 {
 322                                         if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos))
 323                                         {
 324                                                 swap_pos = x;
 325                                                 swap = true;
 326                                         }
 327                                 }
 328                         }
 329                 }
 330                 break;
 331                 /* Place this module before a set of other modules */
 332                 case PRIO_BEFORE:
 333                 {
 334                         swap_pos = EventHandlers[i].size() - 1;
 335                         swap = false;
 336                         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 337                         {
 338                                 for (size_t n = 0; n < sz; ++n)
 339                                 {
 340                                         if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos))
 341                                         {
 342                                                 swap = true;
 343                                                 swap_pos = x;
 344                                         }
 345                                 }
 346                         }
 347                 }
 348                 break;
 349         }
 350
 351         /* Do we need to swap? */
 352         if (swap && (swap_pos != source))
 353         {
 354                 std::swap(EventHandlers[i][swap_pos], EventHandlers[i][source]);
 355                 Instance->Log(DEBUG,"Swap locations %u and %u", swap_pos, source);
 356         }
 357         else
 358                 Instance->Log(DEBUG,"No need to swap");
 359
 360         /* Debug stuff. We wont need this some day soon (tm) */
 361         Instance->Log(DEBUG,"New ordering:");
 362         for (size_t x = 0; x != EventHandlers[i].size(); ++x)
 363         {
 364                 Instance->Log(DEBUG,"  [%08x] %s", EventHandlers[i][x], GetModuleName(EventHandlers[i][x]).c_str());
 365         }
 366
 367         return true;
 368 }
 369
 370 const char* ModuleManager::LastError()
 371 {
 372         return MODERR;
 373 }
 374
 375 bool ModuleManager::Load(const char* filename)
 376 {
 377         /* Do we have a glob pattern in the filename?
 378          * The user wants to load multiple modules which
 379          * match the pattern.
 380          */
 381         if (strchr(filename,'*') || (strchr(filename,'?')))
 382         {
 383                 int n_match = 0;
 384                 DIR* library = opendir(Instance->Config->ModPath);
 385                 if (library)
 386                 {
 387                         /* Try and locate and load all modules matching the pattern */
 388                         dirent* entry = NULL;
 389                         while ((entry = readdir(library)))
 390                         {
 391                                 if (Instance->MatchText(entry->d_name, filename))
 392                                 {
 393                                         if (!this->Load(entry->d_name))
 394                                                 n_match++;
 395                                 }
 396                         }
 397                         closedir(library);
 398                 }
 399                 /* Loadmodule will now return false if any one of the modules failed
 400                  * to load (but wont abort when it encounters a bad one) and when 1 or
 401                  * more modules were actually loaded.
 402                  */
 403                 return (n_match > 0);
 404         }
 405
 406         char modfile[MAXBUF];
 407         snprintf(modfile,MAXBUF,"%s/%s",Instance->Config->ModPath,filename);
 408         std::string filename_str = filename;
 409
 410         if (!ServerConfig::DirValid(modfile))
 411         {
 412                 snprintf(MODERR, MAXBUF,"Module %s is not within the modules directory.", modfile);
 413                 Instance->Log(DEFAULT, MODERR);
 414                 return false;
 415         }
 416
 417         if (!ServerConfig::FileExists(modfile))
 418         {
 419                 snprintf(MODERR,MAXBUF,"Module file could not be found: %s", modfile);
 420                 Instance->Log(DEFAULT, MODERR);
 421                 return false;
 422         }
 423
 424         if (Modules.find(filename_str) != Modules.end())
 425         {
 426                 Instance->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
 427                 snprintf(MODERR, MAXBUF, "Module already loaded");
 428                 return false;
 429         }
 430
 431         Module* newmod = NULL;
 432         ircd_module* newhandle = NULL;
 433
 434         try
 435         {
 436                 /* This will throw a CoreException if there's a problem loading
 437                  * the module file or getting a pointer to the init_module symbol.
 438                  */
 439                 newhandle = new ircd_module(Instance, modfile, "init_module");
 440                 newmod = newhandle->CallInit();
 441
 442                 if(newmod)
 443                 {
 444                         Version v = newmod->GetVersion();
 445
 446                         if (v.API != API_VERSION)
 447                         {
 448                                 delete newmod;
 449                                 Instance->Log(DEFAULT,"Unable to load %s: Incorrect module API version: %d (our version: %d)",modfile,v.API,API_VERSION);
 450                                 snprintf(MODERR,MAXBUF,"Loader/Linker error: Incorrect module API version: %d (our version: %d)",v.API,API_VERSION);
 451                                 return false;
 452                         }
 453                         else
 454                         {
 455                                 Instance->Log(DEFAULT,"New module introduced: %s (API version %d, Module version %d.%d.%d.%d)%s", filename, v.API, v.Major, v.Minor, v.Revision, v.Build, (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]"));
 456                         }
 457
 458                         Modules[filename_str] = std::make_pair(newhandle, newmod);
 459                 }
 460                 else
 461                 {
 462                         Instance->Log(DEFAULT, "Unable to load %s",modfile);
 463                         snprintf(MODERR,MAXBUF, "Probably missing init_module() entrypoint, but dlsym() didn't notice a problem");
 464                         return false;
 465                 }
 466         }
 467         catch (LoadModuleException& modexcept)
 468         {
 469                 Instance->Log(DEFAULT,"Unable to load %s: %s", modfile, modexcept.GetReason());
 470                 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s", modexcept.GetReason());
 471                 return false;
 472         }
 473         catch (FindSymbolException& modexcept)
 474         {
 475                 Instance->Log(DEFAULT,"Unable to load %s: %s", modfile, modexcept.GetReason());
 476                 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s", modexcept.GetReason());
 477                 return false;
 478         }
 479         catch (CoreException& modexcept)
 480         {
 481                 Instance->Log(DEFAULT,"Unable to load %s: %s",modfile,modexcept.GetReason());
 482                 snprintf(MODERR,MAXBUF,"Factory function of %s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
 483                 return false;
 484         }
 485
 486         this->ModCount++;
 487         FOREACH_MOD_I(Instance,I_OnLoadModule,OnLoadModule(newmod, filename_str));
 488
 489         /* We give every module a chance to re-prioritize when we introduce a new one,
 490          * not just the one thats loading, as the new module could affect the preference
 491          * of others
 492          */
 493         for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
 494                 n->second.second->Prioritize();
 495
 496         Instance->BuildISupport();
 497         return true;
 498 }
 499
 500 bool ModuleManager::Unload(const char* filename)
 501 {
 502         std::string filename_str = filename;
 503         std::map<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(filename);
 504
 505         if (modfind != Modules.end())
 506         {
 507                 if (modfind->second.second->GetVersion().Flags & VF_STATIC)
 508                 {
 509                         Instance->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
 510                         snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
 511                         return false;
 512                 }
 513                 std::pair<int,std::string> intercount = GetInterfaceInstanceCount(modfind->second.second);
 514                 if (intercount.first > 0)
 515                 {
 516                         Instance->Log(DEFAULT,"Failed to unload module %s, being used by %d other(s) via interface '%s'",filename, intercount.first, intercount.second.c_str());
 517                         snprintf(MODERR,MAXBUF,"Module not unloadable (Still in use by %d other module%s which %s using its interface '%s') -- unload dependent modules first!",
 518                                         intercount.first,
 519                                         intercount.first > 1 ? "s" : "",
 520                                         intercount.first > 1 ? "are" : "is",
 521                                         intercount.second.c_str());
 522                         return false;
 523                 }
 524
 525                 /* Give the module a chance to tidy out all its metadata */
 526                 for (chan_hash::iterator c = Instance->chanlist->begin(); c != Instance->chanlist->end(); c++)
 527                 {
 528                         modfind->second.second->OnCleanup(TYPE_CHANNEL,c->second);
 529                 }
 530                 for (user_hash::iterator u = Instance->clientlist->begin(); u != Instance->clientlist->end(); u++)
 531                 {
 532                         modfind->second.second->OnCleanup(TYPE_USER,u->second);
 533                 }
 534
 535                 /* Tidy up any dangling resolvers */
 536                 Instance->Res->CleanResolvers(modfind->second.second);
 537
 538
 539                 FOREACH_MOD_I(Instance,I_OnUnloadModule,OnUnloadModule(modfind->second.second, modfind->first));
 540
 541                 this->DetachAll(modfind->second.second);
 542
 543                 Instance->Parser->RemoveCommands(filename);
 544
 545                 delete modfind->second.second;
 546                 delete modfind->second.first;
 547                 Modules.erase(modfind);
 548
 549                 Instance->Log(DEFAULT,"Module %s unloaded",filename);
 550                 this->ModCount--;
 551                 Instance->BuildISupport();
 552                 return true;
 553         }
 554
 555         Instance->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
 556         snprintf(MODERR,MAXBUF,"Module not loaded");
 557         return false;
 558 }
 559
 560 /* We must load the modules AFTER initializing the socket engine, now */
 561 void ModuleManager::LoadAll()
 562 {
 563         char configToken[MAXBUF];
 564         ModCount = -1;
 565
 566         for(int count = 0; count < Instance->Config->ConfValueEnum(Instance->Config->config_data, "module"); count++)
 567         {
 568                 Instance->Config->ConfValue(Instance->Config->config_data, "module", "name", count, configToken, MAXBUF);
 569                 printf_c("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",configToken);
 570
 571                 if (!this->Load(configToken))
 572                 {
 573                         Instance->Log(DEFAULT,"There was an error loading the module '%s': %s", configToken, this->LastError());
 574                         printf_c("\n[\033[1;31m*\033[0m] There was an error loading the module '%s': %s\n\n", configToken, this->LastError());
 575                         Instance->Exit(EXIT_STATUS_MODULE);
 576                 }
 577         }
 578         printf_c("\nA total of \033[1;32m%d\033[0m module%s been loaded.\n", (this->GetCount()+1), (this->GetCount()+1) == 1 ? " has" : "s have");
 579         Instance->Log(DEFAULT,"Total loaded modules: %d", this->GetCount()+1);
 580 }
 581
 582 bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod)
 583 {
 584         if (Features.find(FeatureName) == Features.end())
 585         {
 586                 Features[FeatureName] = Mod;
 587                 return true;
 588         }
 589         return false;
 590 }
 591
 592 bool ModuleManager::UnpublishFeature(const std::string &FeatureName)
 593 {
 594         featurelist::iterator iter = Features.find(FeatureName);
 595
 596         if (iter == Features.end())
 597                 return false;
 598
 599         Features.erase(iter);
 600         return true;
 601 }
 602
 603 Module* ModuleManager::FindFeature(const std::string &FeatureName)
 604 {
 605         featurelist::iterator iter = Features.find(FeatureName);
 606
 607         if (iter == Features.end())
 608                 return NULL;
 609
 610         return iter->second;
 611 }
 612
 613 bool ModuleManager::PublishInterface(const std::string &InterfaceName, Module* Mod)
 614 {
 615         interfacelist::iterator iter = Interfaces.find(InterfaceName);
 616
 617         if (iter == Interfaces.end())
 618         {
 619                 modulelist ml;
 620                 ml.push_back(Mod);
 621                 Interfaces[InterfaceName] = std::make_pair(0, ml);
 622                 return true;
 623         }
 624         else
 625         {
 626                 iter->second.second.push_back(Mod);
 627                 return true;
 628         }
 629         return false;
 630 }
 631
 632 bool ModuleManager::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
 633 {
 634         interfacelist::iterator iter = Interfaces.find(InterfaceName);
 635
 636         if (iter == Interfaces.end())
 637                 return false;
 638
 639         for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
 640         {
 641                 if (*x == Mod)
 642                 {
 643                         iter->second.second.erase(x);
 644                         if (iter->second.second.empty())
 645                                 Interfaces.erase(InterfaceName);
 646                         return true;
 647                 }
 648         }
 649         return false;
 650 }
 651
 652 modulelist* ModuleManager::FindInterface(const std::string &InterfaceName)
 653 {
 654         interfacelist::iterator iter = Interfaces.find(InterfaceName);
 655         if (iter == Interfaces.end())
 656                 return NULL;
 657         else
 658                 return &(iter->second.second);
 659 }
 660
 661 void ModuleManager::UseInterface(const std::string &InterfaceName)
 662 {
 663         interfacelist::iterator iter = Interfaces.find(InterfaceName);
 664         if (iter != Interfaces.end())
 665                 iter->second.first++;
 666
 667 }
 668
 669 void ModuleManager::DoneWithInterface(const std::string &InterfaceName)
 670 {
 671         interfacelist::iterator iter = Interfaces.find(InterfaceName);
 672         if (iter != Interfaces.end())
 673                 iter->second.first--;
 674 }
 675
 676 std::pair<int,std::string> ModuleManager::GetInterfaceInstanceCount(Module* m)
 677 {
 678         for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
 679         {
 680                 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
 681                 {
 682                         if (*x == m)
 683                         {
 684                                 return std::make_pair(iter->second.first, iter->first);
 685                         }
 686                 }
 687         }
 688         return std::make_pair(0, "");
 689 }
 690
 691 const std::string& ModuleManager::GetModuleName(Module* m)
 692 {
 693         static std::string nothing;
 694
 695         for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
 696         {
 697                 if (n->second.second == m)
 698                         return n->first;
 699         }
 700
 701         return nothing;
 702 }
 703
 704 /* This is ugly, yes, but hash_map's arent designed to be
 705  * addressed in this manner, and this is a bit of a kludge.
 706  * Luckily its a specialist function and rarely used by
 707  * many modules (in fact, it was specially created to make
 708  * m_safelist possible, initially).
 709  */
 710
 711 Channel* InspIRCd::GetChannelIndex(long index)
 712 {
 713         int target = 0;
 714         for (chan_hash::iterator n = this->chanlist->begin(); n != this->chanlist->end(); n++, target++)
 715         {
 716                 if (index == target)
 717                         return n->second;
 718         }
 719         return NULL;
 720 }
 721
 722 bool InspIRCd::MatchText(const std::string &sliteral, const std::string &spattern)
 723 {
 724         return match(sliteral.c_str(),spattern.c_str());
 725 }
 726
 727 CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user)
 728 {
 729         return this->Parser->CallHandler(commandname,parameters,pcnt,user);
 730 }
 731
 732 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user)
 733 {
 734         return this->Parser->IsValidCommand(commandname, pcnt, user);
 735 }
 736
 737 void InspIRCd::AddCommand(Command *f)
 738 {
 739         if (!this->Parser->CreateCommand(f))
 740         {
 741                 ModuleException err("Command "+std::string(f->command)+" already exists.");
 742                 throw (err);
 743         }
 744 }
 745
 746 void InspIRCd::SendMode(const char** parameters, int pcnt, User *user)
 747 {
 748         this->Modes->Process(parameters,pcnt,user,true);
 749 }
 750
 751 void InspIRCd::DumpText(User* User, const std::string &LinePrefix, stringstream &TextStream)
 752 {
 753         std::string CompleteLine = LinePrefix;
 754         std::string Word;
 755         while (TextStream >> Word)
 756         {
 757                 if (CompleteLine.length() + Word.length() + 3 > 500)
 758                 {
 759                         User->WriteServ(CompleteLine);
 760                         CompleteLine = LinePrefix;
 761                 }
 762                 CompleteLine = CompleteLine + Word + " ";
 763         }
 764         User->WriteServ(CompleteLine);
 765 }
 766
 767 User* FindDescriptorHandler::Call(int socket)
 768 {
 769         return reinterpret_cast<User*>(Server->SE->GetRef(socket));
 770 }
 771
 772 bool InspIRCd::AddMode(ModeHandler* mh)
 773 {
 774         return this->Modes->AddMode(mh);
 775 }
 776
 777 bool InspIRCd::AddModeWatcher(ModeWatcher* mw)
 778 {
 779         return this->Modes->AddModeWatcher(mw);
 780 }
 781
 782 bool InspIRCd::DelModeWatcher(ModeWatcher* mw)
 783 {
 784         return this->Modes->DelModeWatcher(mw);
 785 }
 786
 787 bool InspIRCd::AddResolver(Resolver* r, bool cached)
 788 {
 789         if (!cached)
 790                 return this->Res->AddResolverClass(r);
 791         else
 792         {
 793                 r->TriggerCachedResult();
 794                 delete r;
 795                 return true;
 796         }
 797 }
 798
 799 Module* ModuleManager::Find(const std::string &name)
 800 {
 801         std::map<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(name);
 802
 803         if (modfind == Modules.end())
 804                 return NULL;
 805         else
 806                 return modfind->second.second;
 807 }
 808
 809 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
 810 {
 811         std::vector<std::string> retval;
 812         for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator x = Modules.begin(); x != Modules.end(); ++x)
 813                 if (!filter || (x->second.second->GetVersion().Flags & filter))
 814                         retval.push_back(x->first);
 815         return retval;
 816 }
 817
 818 ConfigReader::ConfigReader(InspIRCd* Instance) : ServerInstance(Instance)
 819 {
 820         /* Is there any reason to load the entire config file again here?
 821          * it's needed if they specify another config file, but using the
 822          * default one we can just use the global config data - pre-parsed!
 823          */
 824         this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
 825         this->error = CONF_NO_ERROR;
 826         this->data = &ServerInstance->Config->config_data;
 827         this->privatehash = false;
 828 }
 829
 830
 831 ConfigReader::~ConfigReader()
 832 {
 833         if (this->errorlog)
 834                 delete this->errorlog;
 835         if(this->privatehash)
 836                 delete this->data;
 837 }
 838
 839
 840 ConfigReader::ConfigReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
 841 {
 842         ServerInstance->Config->ClearStack();
 843
 844         this->error = CONF_NO_ERROR;
 845         this->data = new ConfigDataHash;
 846         this->privatehash = true;
 847         this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
 848         this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog);
 849         if (!this->readerror)
 850                 this->error = CONF_FILE_NOT_FOUND;
 851 }
 852
 853
 854 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
 855 {
 856         /* Don't need to strlcpy() tag and name anymore, ReadConf() takes const char* */
 857         std::string result;
 858
 859         if (!ServerInstance->Config->ConfValue(*this->data, tag, name, default_value, index, result, allow_linefeeds))
 860         {
 861                 this->error = CONF_VALUE_NOT_FOUND;
 862         }
 863         return result;
 864 }
 865
 866 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
 867 {
 868         return ReadValue(tag, name, "", index, allow_linefeeds);
 869 }
 870
 871 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
 872 {
 873         return ServerInstance->Config->ConfValueBool(*this->data, tag, name, default_value, index);
 874 }
 875
 876 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
 877 {
 878         return ReadFlag(tag, name, "", index);
 879 }
 880
 881
 882 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive)
 883 {
 884         int result;
 885
 886         if(!ServerInstance->Config->ConfValueInteger(*this->data, tag, name, default_value, index, result))
 887         {
 888                 this->error = CONF_VALUE_NOT_FOUND;
 889                 return 0;
 890         }
 891
 892         if ((need_positive) && (result < 0))
 893         {
 894                 this->error = CONF_INT_NEGATIVE;
 895                 return 0;
 896         }
 897
 898         return result;
 899 }
 900
 901 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive)
 902 {
 903         return ReadInteger(tag, name, "", index, need_positive);
 904 }
 905
 906 long ConfigReader::GetError()
 907 {
 908         long olderr = this->error;
 909         this->error = 0;
 910         return olderr;
 911 }
 912
 913 void ConfigReader::DumpErrors(bool bail, User* user)
 914 {
 915         ServerInstance->Config->ReportConfigError(this->errorlog->str(), bail, user);
 916 }
 917
 918
 919 int ConfigReader::Enumerate(const std::string &tag)
 920 {
 921         return ServerInstance->Config->ConfValueEnum(*this->data, tag);
 922 }
 923
 924 int ConfigReader::EnumerateValues(const std::string &tag, int index)
 925 {
 926         return ServerInstance->Config->ConfVarEnum(*this->data, tag, index);
 927 }
 928
 929 bool ConfigReader::Verify()
 930 {
 931         return this->readerror;
 932 }
 933
 934
 935 FileReader::FileReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
 936 {
 937         LoadFile(filename);
 938 }
 939
 940 FileReader::FileReader(InspIRCd* Instance) : ServerInstance(Instance)
 941 {
 942 }
 943
 944 std::string FileReader::Contents()
 945 {
 946         std::string x;
 947         for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
 948         {
 949                 x.append(*a);
 950                 x.append("\r\n");
 951         }
 952         return x;
 953 }
 954
 955 unsigned long FileReader::ContentSize()
 956 {
 957         return this->contentsize;
 958 }
 959
 960 void FileReader::CalcSize()
 961 {
 962         unsigned long n = 0;
 963         for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
 964                 n += (a->length() + 2);
 965         this->contentsize = n;
 966 }
 967
 968 void FileReader::LoadFile(const std::string &filename)
 969 {
 970         file_cache c;
 971         c.clear();
 972         if (ServerInstance->Config->ReadFile(c,filename.c_str()))
 973         {
 974                 this->fc = c;
 975                 this->CalcSize();
 976         }
 977 }
 978
 979
 980 FileReader::~FileReader()
 981 {
 982 }
 983
 984 bool FileReader::Exists()
 985 {
 986         return (!(fc.size() == 0));
 987 }
 988
 989 std::string FileReader::GetLine(int x)
 990 {
 991         if ((x<0) || ((unsigned)x>fc.size()))
 992                 return "";
 993         return fc[x];
 994 }
 995
 996 int FileReader::FileSize()
 997 {
 998         return fc.size();
 999 }