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