2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
6 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 * Copyright (C) 2006-2007 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2007 Pippijn van Steenhoven <pip88nl@gmail.com>
11 * Copyright (C) 2003 randomdan <???@???>
13 * This file is part of InspIRCd. InspIRCd is free software: you can
14 * redistribute it and/or modify it under the terms of the GNU General Public
15 * License as published by the Free Software Foundation, version 2.
17 * This program is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "socketengine.h"
32 #include "command_parse.h"
33 #include "exitcodes.h"
39 static std::vector<dynamic_reference_base*>* dynrefs = NULL;
40 static bool dynref_init_complete = false;
42 void dynamic_reference_base::reset_all()
44 dynref_init_complete = true;
47 for(unsigned int i = 0; i < dynrefs->size(); i++)
48 (*dynrefs)[i]->resolve();
51 // Version is a simple class for holding a modules version number
52 Version::Version(const std::string &desc, int flags) : description(desc), Flags(flags)
56 Version::Version(const std::string &desc, int flags, const std::string& linkdata)
57 : description(desc), Flags(flags), link_data(linkdata)
61 Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { }
65 FOREACH_MOD(I_OnEvent,OnEvent(*this));
68 // These declarations define the behavours of the base class Module (which does nothing at all)
71 CullResult Module::cull()
73 return classbase::cull();
79 ModResult Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; }
80 void Module::OnUserConnect(LocalUser*) { }
81 void Module::OnUserQuit(User*, const std::string&, const std::string&) { }
82 void Module::OnUserDisconnect(LocalUser*) { }
83 void Module::OnUserJoin(Membership*, bool, bool, CUList&) { }
84 void Module::OnPostJoin(Membership*) { }
85 void Module::OnUserPart(Membership*, std::string&, CUList&) { }
86 void Module::OnPreRehash(User*, const std::string&) { }
87 void Module::OnModuleRehash(User*, const std::string&) { }
88 void Module::OnRehash(User*) { }
89 ModResult Module::OnUserPreJoin(LocalUser*, Channel*, const std::string&, std::string&, const std::string&) { return MOD_RES_PASSTHRU; }
90 void Module::OnMode(User*, User*, Channel*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
91 void Module::OnOper(User*, const std::string&) { }
92 void Module::OnPostOper(User*, const std::string&, const std::string &) { }
93 void Module::OnInfo(User*) { }
94 void Module::OnWhois(User*, User*) { }
95 ModResult Module::OnUserPreInvite(User*, User*, Channel*, time_t) { return MOD_RES_PASSTHRU; }
96 ModResult Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&, MessageType) { return MOD_RES_PASSTHRU; }
97 ModResult Module::OnUserPreNick(User*, const std::string&) { return MOD_RES_PASSTHRU; }
98 void Module::OnUserPostNick(User*, const std::string&) { }
99 ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { return MOD_RES_PASSTHRU; }
100 void Module::On005Numeric(std::map<std::string, std::string>&) { }
101 ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; }
102 void Module::OnLoadModule(Module*) { }
103 void Module::OnUnloadModule(Module*) { }
104 void Module::OnBackgroundTimer(time_t) { }
105 ModResult Module::OnPreCommand(std::string&, std::vector<std::string>&, LocalUser*, bool, const std::string&) { return MOD_RES_PASSTHRU; }
106 void Module::OnPostCommand(Command*, const std::vector<std::string>&, LocalUser*, CmdResult, const std::string&) { }
107 void Module::OnUserInit(LocalUser*) { }
108 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
109 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
110 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
111 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
112 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
113 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
114 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
115 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
116 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
117 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
118 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
119 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
120 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
121 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
122 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
123 void Module::OnEvent(Event&) { }
124 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
125 void Module::OnGlobalOper(User*) { }
126 void Module::OnPostConnect(User*) { }
127 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&, MessageType) { }
128 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
129 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
130 void Module::OnGetServerDescription(const std::string&, std::string&) { }
131 void Module::OnSyncUser(User*, Module*, void*) { }
132 void Module::OnSyncChannel(Channel*, Module*, void*) { }
133 void Module::OnSyncNetwork(Module*, void*) { }
134 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
135 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
136 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
137 void Module::OnChangeHost(User*, const std::string&) { }
138 void Module::OnChangeName(User*, const std::string&) { }
139 void Module::OnChangeIdent(User*, const std::string&) { }
140 void Module::OnAddLine(User*, XLine*) { }
141 void Module::OnDelLine(User*, XLine*) { }
142 void Module::OnExpireLine(XLine*) { }
143 void Module::OnCleanup(int, void*) { }
144 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
145 void Module::OnChannelDelete(Channel*) { }
146 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
147 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
148 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
149 void Module::OnGarbageCollect() { }
150 ModResult Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { return MOD_RES_PASSTHRU; }
151 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
152 void Module::OnRunTestSuite() { }
153 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
154 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
155 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
156 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
157 void Module::OnSendWhoLine(User*, const std::vector<std::string>&, User*, std::string&) { }
158 void Module::OnSetUserIP(LocalUser*) { }
160 ModuleManager::ModuleManager() : ModCount(0)
164 ModuleManager::~ModuleManager()
168 bool ModuleManager::Attach(Implementation i, Module* mod)
170 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
173 EventHandlers[i].push_back(mod);
177 bool ModuleManager::Detach(Implementation i, Module* mod)
179 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
181 if (x == EventHandlers[i].end())
184 EventHandlers[i].erase(x);
188 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
190 for (size_t n = 0; n < sz; ++n)
194 void ModuleManager::DetachAll(Module* mod)
196 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
197 Detach((Implementation)n, mod);
200 bool ModuleManager::SetPriority(Module* mod, Priority s)
202 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
203 SetPriority(mod, (Implementation)n, s);
208 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which)
210 /** To change the priority of a module, we first find its position in the vector,
211 * then we find the position of the other modules in the vector that this module
212 * wants to be before/after. We pick off either the first or last of these depending
213 * on which they want, and we make sure our module is *at least* before or after
214 * the first or last of this subset, depending again on the type of priority.
218 /* Locate our module. This is O(n) but it only occurs on module load so we're
219 * not too bothered about it
221 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
223 if (EventHandlers[i][x] == mod)
230 /* Eh? this module doesnt exist, probably trying to set priority on an event
231 * theyre not attached to.
236 size_t swap_pos = my_pos;
240 if (prioritizationState != PRIO_STATE_FIRST)
246 if (prioritizationState != PRIO_STATE_FIRST)
249 swap_pos = EventHandlers[i].size() - 1;
253 /* Find the latest possible position, only searching AFTER our position */
254 for (size_t x = EventHandlers[i].size() - 1; x > my_pos; --x)
256 if (EventHandlers[i][x] == which)
262 // didn't find it - either not loaded or we're already after
265 /* Place this module before a set of other modules */
266 case PRIORITY_BEFORE:
268 for (size_t x = 0; x < my_pos; ++x)
270 if (EventHandlers[i][x] == which)
276 // didn't find it - either not loaded or we're already before
282 /* Do we need to swap? */
283 if (swap_pos != my_pos)
285 // We are going to change positions; we'll need to run again to verify all requirements
286 if (prioritizationState == PRIO_STATE_LAST)
287 prioritizationState = PRIO_STATE_AGAIN;
288 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
291 if (my_pos > swap_pos)
294 for (unsigned int j = my_pos; j != swap_pos; j += incrmnt)
296 if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0)))
299 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
306 bool ModuleManager::CanUnload(Module* mod)
308 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
310 if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying))
312 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
313 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
316 if (mod->GetVersion().Flags & VF_STATIC)
318 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
319 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
327 void ModuleManager::DoSafeUnload(Module* mod)
329 // First, notify all modules that a module is about to be unloaded, so in case
330 // they pass execution to the soon to be unloaded module, it will happen now,
331 // i.e. before we unregister the services of the module being unloaded
332 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
334 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
336 std::vector<reference<ExtensionItem> > items;
337 ServerInstance->Extensions.BeginUnregister(modfind->second, items);
338 /* Give the module a chance to tidy out all its metadata */
339 for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++)
341 mod->OnCleanup(TYPE_CHANNEL,c->second);
342 c->second->doUnhookExtensions(items);
343 const UserMembList* users = c->second->GetUsers();
344 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
345 mi->second->doUnhookExtensions(items);
347 for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
349 mod->OnCleanup(TYPE_USER,u->second);
350 u->second->doUnhookExtensions(items);
352 for(char m='A'; m <= 'z'; m++)
355 mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
356 if (mh && mh->creator == mod)
357 this->DelService(*mh);
358 mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL);
359 if (mh && mh->creator == mod)
360 this->DelService(*mh);
362 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
364 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
365 if (curr->second->creator == mod)
366 DataProviders.erase(curr);
369 dynamic_reference_base::reset_all();
373 Modules.erase(modfind);
374 ServerInstance->GlobalCulls.AddItem(mod);
376 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Module %s unloaded",mod->ModuleSourceFile.c_str());
378 ServerInstance->ISupport.Build();
381 void ModuleManager::UnloadAll()
383 /* We do this more than once, so that any service providers get a
384 * chance to be unhooked by the modules using them, but then get
385 * a chance to be removed themsleves.
387 * Note: this deliberately does NOT delete the DLLManager objects
389 for (int tries = 0; tries < 4; tries++)
391 std::map<std::string, Module*>::iterator i = Modules.begin();
392 while (i != Modules.end())
394 std::map<std::string, Module*>::iterator me = i++;
395 if (CanUnload(me->second))
397 DoSafeUnload(me->second);
400 ServerInstance->GlobalCulls.Apply();
404 std::string& ModuleManager::LastError()
406 return LastModuleError;
409 void ModuleManager::AddService(ServiceProvider& item)
411 switch (item.service)
413 case SERVICE_COMMAND:
414 if (!ServerInstance->Parser->AddCommand(static_cast<Command*>(&item)))
415 throw ModuleException("Command "+std::string(item.name)+" already exists.");
419 ModeHandler* mh = static_cast<ModeHandler*>(&item);
420 if (!ServerInstance->Modes->AddMode(mh))
421 throw ModuleException("Mode "+std::string(item.name)+" already exists.");
422 DataProviders.insert(std::make_pair((mh->GetModeType() == MODETYPE_CHANNEL ? "mode/" : "umode/") + item.name, &item));
423 dynamic_reference_base::reset_all();
426 case SERVICE_METADATA:
427 if (!ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item)))
428 throw ModuleException("Extension " + std::string(item.name) + " already exists.");
433 if ((item.name.substr(0, 5) == "mode/") || (item.name.substr(0, 6) == "umode/"))
434 throw ModuleException("The \"mode/\" and the \"umode\" service name prefixes are reserved.");
436 DataProviders.insert(std::make_pair(item.name, &item));
437 std::string::size_type slash = item.name.find('/');
438 if (slash != std::string::npos)
440 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
441 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
443 dynamic_reference_base::reset_all();
447 throw ModuleException("Cannot add unknown service type");
451 void ModuleManager::DelService(ServiceProvider& item)
453 switch (item.service)
456 if (!ServerInstance->Modes->DelMode(static_cast<ModeHandler*>(&item)))
457 throw ModuleException("Mode "+std::string(item.name)+" does not exist.");
462 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
464 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
465 if (curr->second == &item)
466 DataProviders.erase(curr);
468 dynamic_reference_base::reset_all();
472 throw ModuleException("Cannot delete unknown service type");
476 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
483 std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
484 if (i != DataProviders.end() && i->second->service == type)
488 // TODO implement finding of the other types
490 throw ModuleException("Cannot find unknown service type");
494 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
495 : name(Name), value(NULL), creator(Creator)
498 dynrefs = new std::vector<dynamic_reference_base*>;
499 dynrefs->push_back(this);
500 if (dynref_init_complete)
504 dynamic_reference_base::~dynamic_reference_base()
506 for(unsigned int i = 0; i < dynrefs->size(); i++)
508 if (dynrefs->at(i) == this)
510 unsigned int last = dynrefs->size() - 1;
512 dynrefs->at(i) = dynrefs->at(last);
513 dynrefs->erase(dynrefs->begin() + last);
514 if (dynrefs->empty())
524 void dynamic_reference_base::SetProvider(const std::string& newname)
530 void dynamic_reference_base::resolve()
532 std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
533 if (i != ServerInstance->Modules->DataProviders.end())
534 value = static_cast<DataProvider*>(i->second);
539 Module* ModuleManager::Find(const std::string &name)
541 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
543 if (modfind == Modules.end())
546 return modfind->second;
549 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
551 std::vector<std::string> retval;
552 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
553 if (!filter || (x->second->GetVersion().Flags & filter))
554 retval.push_back(x->first);
558 FileReader::FileReader(const std::string& filename)
563 void FileReader::Load(const std::string& filename)
565 // If the file is stored in the file cache then we used that version instead.
566 ConfigFileCache::iterator it = ServerInstance->Config->Files.find(filename);
567 if (it != ServerInstance->Config->Files.end())
569 this->lines = it->second;
575 std::ifstream stream(filename.c_str());
576 if (!stream.is_open())
577 throw CoreException(filename + " does not exist or is not readable!");
580 while (std::getline(stream, line))
582 lines.push_back(line);
583 totalSize += line.size() + 2;
590 std::string FileReader::GetString()
593 for (file_cache::iterator it = this->lines.begin(); it != this->lines.end(); ++it)
596 buffer.append("\r\n");