src/modules.cpp

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