src/modules.cpp

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