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