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