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/>.
30 #include "socketengine.h"
31 #include "command_parse.h"
32 #include "exitcodes.h"
38 static std::vector<dynamic_reference_base*>* dynrefs = NULL;
39 static bool dynref_init_complete = false;
41 void dynamic_reference_base::reset_all()
43 dynref_init_complete = true;
46 for(unsigned int i = 0; i < dynrefs->size(); i++)
47 (*dynrefs)[i]->resolve();
50 // Version is a simple class for holding a modules version number
51 Version::Version(const std::string &desc, int flags) : description(desc), Flags(flags)
55 Version::Version(const std::string &desc, int flags, const std::string& linkdata)
56 : description(desc), Flags(flags), link_data(linkdata)
60 Request::Request(Module* src, Module* dst, const char* idstr)
61 : id(idstr), source(src), dest(dst)
68 dest->OnRequest(*this);
71 Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { }
75 FOREACH_MOD(I_OnEvent,OnEvent(*this));
78 // These declarations define the behavours of the base class Module (which does nothing at all)
81 CullResult Module::cull()
83 return classbase::cull();
89 ModResult Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; }
90 void Module::OnUserConnect(LocalUser*) { }
91 void Module::OnUserQuit(User*, const std::string&, const std::string&) { }
92 void Module::OnUserDisconnect(LocalUser*) { }
93 void Module::OnUserJoin(Membership*, bool, bool, CUList&) { }
94 void Module::OnPostJoin(Membership*) { }
95 void Module::OnUserPart(Membership*, std::string&, CUList&) { }
96 void Module::OnPreRehash(User*, const std::string&) { }
97 void Module::OnModuleRehash(User*, const std::string&) { }
98 void Module::OnRehash(User*) { }
99 ModResult Module::OnUserPreJoin(LocalUser*, Channel*, const std::string&, std::string&, const std::string&) { return MOD_RES_PASSTHRU; }
100 void Module::OnMode(User*, void*, int, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
101 void Module::OnOper(User*, const std::string&) { }
102 void Module::OnPostOper(User*, const std::string&, const std::string &) { }
103 void Module::OnInfo(User*) { }
104 void Module::OnWhois(User*, User*) { }
105 ModResult Module::OnUserPreInvite(User*, User*, Channel*, time_t) { return MOD_RES_PASSTHRU; }
106 ModResult Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
107 ModResult Module::OnUserPreNotice(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
108 ModResult Module::OnUserPreNick(User*, const std::string&) { return MOD_RES_PASSTHRU; }
109 void Module::OnUserPostNick(User*, const std::string&) { }
110 ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { return MOD_RES_PASSTHRU; }
111 void Module::On005Numeric(std::map<std::string, std::string>&) { }
112 ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; }
113 void Module::OnLoadModule(Module*) { }
114 void Module::OnUnloadModule(Module*) { }
115 void Module::OnBackgroundTimer(time_t) { }
116 ModResult Module::OnPreCommand(std::string&, std::vector<std::string>&, LocalUser*, bool, const std::string&) { return MOD_RES_PASSTHRU; }
117 void Module::OnPostCommand(const std::string&, const std::vector<std::string>&, LocalUser*, CmdResult, const std::string&) { }
118 void Module::OnUserInit(LocalUser*) { }
119 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
120 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
121 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
122 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
123 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
124 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
125 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
126 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
127 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
128 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
129 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
130 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
131 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
132 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
133 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
134 void Module::OnEvent(Event&) { }
135 void Module::OnRequest(Request&) { }
136 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
137 void Module::OnGlobalOper(User*) { }
138 void Module::OnPostConnect(User*) { }
139 void Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
140 int Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
141 void Module::OnStreamSocketClose(StreamSocket*) { }
142 void Module::OnStreamSocketConnect(StreamSocket*) { }
143 int Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
144 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
145 void Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
146 void Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
147 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
148 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
149 void Module::OnGetServerDescription(const std::string&, std::string&) { }
150 void Module::OnSyncUser(User*, Module*, void*) { }
151 void Module::OnSyncChannel(Channel*, Module*, void*) { }
152 void Module::OnSyncNetwork(Module*, void*) { }
153 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
154 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
155 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
156 void Module::OnWallops(User*, const std::string&) { }
157 void Module::OnChangeHost(User*, const std::string&) { }
158 void Module::OnChangeName(User*, const std::string&) { }
159 void Module::OnChangeIdent(User*, const std::string&) { }
160 void Module::OnAddLine(User*, XLine*) { }
161 void Module::OnDelLine(User*, XLine*) { }
162 void Module::OnExpireLine(XLine*) { }
163 void Module::OnCleanup(int, void*) { }
164 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
165 void Module::OnChannelDelete(Channel*) { }
166 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
167 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
168 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
169 void Module::OnGarbageCollect() { }
170 ModResult Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { return MOD_RES_PASSTHRU; }
171 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
172 void Module::OnRunTestSuite() { }
173 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
174 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
175 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
176 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
177 void Module::OnSendWhoLine(User*, const std::vector<std::string>&, User*, std::string&) { }
178 void Module::OnSetUserIP(LocalUser*) { }
180 ModuleManager::ModuleManager() : ModCount(0)
184 ModuleManager::~ModuleManager()
188 bool ModuleManager::Attach(Implementation i, Module* mod)
190 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
193 EventHandlers[i].push_back(mod);
197 bool ModuleManager::Detach(Implementation i, Module* mod)
199 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
201 if (x == EventHandlers[i].end())
204 EventHandlers[i].erase(x);
208 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
210 for (size_t n = 0; n < sz; ++n)
214 void ModuleManager::DetachAll(Module* mod)
216 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
217 Detach((Implementation)n, mod);
220 bool ModuleManager::SetPriority(Module* mod, Priority s)
222 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
223 SetPriority(mod, (Implementation)n, s);
228 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which)
230 /** To change the priority of a module, we first find its position in the vector,
231 * then we find the position of the other modules in the vector that this module
232 * wants to be before/after. We pick off either the first or last of these depending
233 * on which they want, and we make sure our module is *at least* before or after
234 * the first or last of this subset, depending again on the type of priority.
238 /* Locate our module. This is O(n) but it only occurs on module load so we're
239 * not too bothered about it
241 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
243 if (EventHandlers[i][x] == mod)
250 /* Eh? this module doesnt exist, probably trying to set priority on an event
251 * theyre not attached to.
256 size_t swap_pos = my_pos;
260 if (prioritizationState != PRIO_STATE_FIRST)
266 if (prioritizationState != PRIO_STATE_FIRST)
269 swap_pos = EventHandlers[i].size() - 1;
273 /* Find the latest possible position, only searching AFTER our position */
274 for (size_t x = EventHandlers[i].size() - 1; x > my_pos; --x)
276 if (EventHandlers[i][x] == which)
282 // didn't find it - either not loaded or we're already after
285 /* Place this module before a set of other modules */
286 case PRIORITY_BEFORE:
288 for (size_t x = 0; x < my_pos; ++x)
290 if (EventHandlers[i][x] == which)
296 // didn't find it - either not loaded or we're already before
302 /* Do we need to swap? */
303 if (swap_pos != my_pos)
305 // We are going to change positions; we'll need to run again to verify all requirements
306 if (prioritizationState == PRIO_STATE_LAST)
307 prioritizationState = PRIO_STATE_AGAIN;
308 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
311 if (my_pos > swap_pos)
314 for (unsigned int j = my_pos; j != swap_pos; j += incrmnt)
316 if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0)))
319 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
326 bool ModuleManager::CanUnload(Module* mod)
328 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
330 if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying))
332 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
333 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
336 if (mod->GetVersion().Flags & VF_STATIC)
338 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
339 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
347 void ModuleManager::DoSafeUnload(Module* mod)
349 // First, notify all modules that a module is about to be unloaded, so in case
350 // they pass execution to the soon to be unloaded module, it will happen now,
351 // i.e. before we unregister the services of the module being unloaded
352 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
354 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
356 std::vector<reference<ExtensionItem> > items;
357 ServerInstance->Extensions.BeginUnregister(modfind->second, items);
358 /* Give the module a chance to tidy out all its metadata */
359 for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++)
361 mod->OnCleanup(TYPE_CHANNEL,c->second);
362 c->second->doUnhookExtensions(items);
363 const UserMembList* users = c->second->GetUsers();
364 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
365 mi->second->doUnhookExtensions(items);
367 for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
369 mod->OnCleanup(TYPE_USER,u->second);
370 u->second->doUnhookExtensions(items);
372 for(char m='A'; m <= 'z'; m++)
375 mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
376 if (mh && mh->creator == mod)
377 this->DelService(*mh);
378 mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL);
379 if (mh && mh->creator == mod)
380 this->DelService(*mh);
382 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
384 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
385 if (curr->second->creator == mod)
386 DataProviders.erase(curr);
389 dynamic_reference_base::reset_all();
393 Modules.erase(modfind);
394 ServerInstance->GlobalCulls.AddItem(mod);
396 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str());
398 ServerInstance->ISupport.Build();
401 void ModuleManager::UnloadAll()
403 /* We do this more than once, so that any service providers get a
404 * chance to be unhooked by the modules using them, but then get
405 * a chance to be removed themsleves.
407 * Note: this deliberately does NOT delete the DLLManager objects
409 for (int tries = 0; tries < 4; tries++)
411 std::map<std::string, Module*>::iterator i = Modules.begin();
412 while (i != Modules.end())
414 std::map<std::string, Module*>::iterator me = i++;
415 if (CanUnload(me->second))
417 DoSafeUnload(me->second);
420 ServerInstance->GlobalCulls.Apply();
424 std::string& ModuleManager::LastError()
426 return LastModuleError;
429 void ModuleManager::AddService(ServiceProvider& item)
431 switch (item.service)
433 case SERVICE_COMMAND:
434 if (!ServerInstance->Parser->AddCommand(static_cast<Command*>(&item)))
435 throw ModuleException("Command "+std::string(item.name)+" already exists.");
438 if (!ServerInstance->Modes->AddMode(static_cast<ModeHandler*>(&item)))
439 throw ModuleException("Mode "+std::string(item.name)+" already exists.");
440 DataProviders.insert(std::make_pair("mode/" + item.name, &item));
441 dynamic_reference_base::reset_all();
443 case SERVICE_METADATA:
444 if (!ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item)))
445 throw ModuleException("Extension " + std::string(item.name) + " already exists.");
450 if (item.name.substr(0, 5) == "mode/")
451 throw ModuleException("The \"mode/\" service name prefix is reserved.");
453 DataProviders.insert(std::make_pair(item.name, &item));
454 std::string::size_type slash = item.name.find('/');
455 if (slash != std::string::npos)
457 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
458 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
460 dynamic_reference_base::reset_all();
464 throw ModuleException("Cannot add unknown service type");
468 void ModuleManager::DelService(ServiceProvider& item)
470 switch (item.service)
473 if (!ServerInstance->Modes->DelMode(static_cast<ModeHandler*>(&item)))
474 throw ModuleException("Mode "+std::string(item.name)+" does not exist.");
479 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
481 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
482 if (curr->second == &item)
483 DataProviders.erase(curr);
485 dynamic_reference_base::reset_all();
489 throw ModuleException("Cannot delete unknown service type");
493 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
500 std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
501 if (i != DataProviders.end() && i->second->service == type)
505 // TODO implement finding of the other types
507 throw ModuleException("Cannot find unknown service type");
511 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
512 : name(Name), value(NULL), creator(Creator)
515 dynrefs = new std::vector<dynamic_reference_base*>;
516 dynrefs->push_back(this);
517 if (dynref_init_complete)
521 dynamic_reference_base::~dynamic_reference_base()
523 for(unsigned int i = 0; i < dynrefs->size(); i++)
525 if (dynrefs->at(i) == this)
527 unsigned int last = dynrefs->size() - 1;
529 dynrefs->at(i) = dynrefs->at(last);
530 dynrefs->erase(dynrefs->begin() + last);
531 if (dynrefs->empty())
541 void dynamic_reference_base::SetProvider(const std::string& newname)
547 void dynamic_reference_base::resolve()
549 std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
550 if (i != ServerInstance->Modules->DataProviders.end())
551 value = static_cast<DataProvider*>(i->second);
556 void InspIRCd::SendMode(const std::vector<std::string>& parameters, User *user)
558 this->Modes->Process(parameters, user);
562 void InspIRCd::SendGlobalMode(const std::vector<std::string>& parameters, User *user)
564 Modes->Process(parameters, user);
565 if (!Modes->GetLastParse().empty())
566 this->PI->SendMode(parameters[0], Modes->GetLastParseParams(), Modes->GetLastParseTranslate());
569 Module* ModuleManager::Find(const std::string &name)
571 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
573 if (modfind == Modules.end())
576 return modfind->second;
579 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
581 std::vector<std::string> retval;
582 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
583 if (!filter || (x->second->GetVersion().Flags & filter))
584 retval.push_back(x->first);
588 FileReader::FileReader(const std::string &filename)
593 FileReader::FileReader()
597 std::string FileReader::Contents()
600 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
608 unsigned long FileReader::ContentSize()
610 return this->contentsize;
613 void FileReader::CalcSize()
616 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
617 n += (a->length() + 2);
618 this->contentsize = n;
621 void FileReader::LoadFile(const std::string &filename)
623 std::map<std::string, file_cache>::iterator file = ServerInstance->Config->Files.find(filename);
624 if (file != ServerInstance->Config->Files.end())
626 this->fc = file->second;
631 FILE* f = fopen(filename.c_str(), "r");
634 char linebuf[MAXBUF*10];
635 while (fgets(linebuf, sizeof(linebuf), f))
637 int len = strlen(linebuf);
639 fc.push_back(std::string(linebuf, len - 1));
647 FileReader::~FileReader()
651 bool FileReader::Exists()
653 return (!(fc.size() == 0));
656 std::string FileReader::GetLine(int x)
658 if ((x<0) || ((unsigned)x>fc.size()))
663 int FileReader::FileSize()