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