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