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