src/modules.cpp

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