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&, MessageType) { return MOD_RES_PASSTHRU; }
107 ModResult Module::OnUserPreNick(User*, const std::string&) { return MOD_RES_PASSTHRU; }
108 void Module::OnUserPostNick(User*, const std::string&) { }
109 ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { return MOD_RES_PASSTHRU; }
110 void Module::On005Numeric(std::map<std::string, std::string>&) { }
111 ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; }
112 void Module::OnLoadModule(Module*) { }
113 void Module::OnUnloadModule(Module*) { }
114 void Module::OnBackgroundTimer(time_t) { }
115 ModResult Module::OnPreCommand(std::string&, std::vector<std::string>&, LocalUser*, bool, const std::string&) { return MOD_RES_PASSTHRU; }
116 void Module::OnPostCommand(const std::string&, const std::vector<std::string>&, LocalUser*, CmdResult, const std::string&) { }
117 void Module::OnUserInit(LocalUser*) { }
118 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
119 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
120 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
121 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
122 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
123 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
124 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
125 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
126 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
127 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
128 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
129 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
130 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
131 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
132 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
133 void Module::OnEvent(Event&) { }
134 void Module::OnRequest(Request&) { }
135 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
136 void Module::OnGlobalOper(User*) { }
137 void Module::OnPostConnect(User*) { }
138 void Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
139 int Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
140 void Module::OnStreamSocketClose(StreamSocket*) { }
141 void Module::OnStreamSocketConnect(StreamSocket*) { }
142 int Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
143 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&, MessageType) { }
144 void Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
145 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
146 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
147 void Module::OnGetServerDescription(const std::string&, std::string&) { }
148 void Module::OnSyncUser(User*, Module*, void*) { }
149 void Module::OnSyncChannel(Channel*, Module*, void*) { }
150 void Module::OnSyncNetwork(Module*, void*) { }
151 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
152 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
153 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
154 void Module::OnWallops(User*, const std::string&) { }
155 void Module::OnChangeHost(User*, const std::string&) { }
156 void Module::OnChangeName(User*, const std::string&) { }
157 void Module::OnChangeIdent(User*, const std::string&) { }
158 void Module::OnAddLine(User*, XLine*) { }
159 void Module::OnDelLine(User*, XLine*) { }
160 void Module::OnExpireLine(XLine*) { }
161 void Module::OnCleanup(int, void*) { }
162 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
163 void Module::OnChannelDelete(Channel*) { }
164 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
165 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
166 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
167 void Module::OnGarbageCollect() { }
168 ModResult Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { return MOD_RES_PASSTHRU; }
169 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
170 void Module::OnRunTestSuite() { }
171 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
172 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
173 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
174 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
175 void Module::OnSendWhoLine(User*, const std::vector<std::string>&, User*, std::string&) { }
176 void Module::OnSetUserIP(LocalUser*) { }
178 ModuleManager::ModuleManager() : ModCount(0)
182 ModuleManager::~ModuleManager()
186 bool ModuleManager::Attach(Implementation i, Module* mod)
188 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
191 EventHandlers[i].push_back(mod);
195 bool ModuleManager::Detach(Implementation i, Module* mod)
197 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
199 if (x == EventHandlers[i].end())
202 EventHandlers[i].erase(x);
206 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
208 for (size_t n = 0; n < sz; ++n)
212 void ModuleManager::DetachAll(Module* mod)
214 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
215 Detach((Implementation)n, mod);
218 bool ModuleManager::SetPriority(Module* mod, Priority s)
220 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
221 SetPriority(mod, (Implementation)n, s);
226 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module* which)
228 /** To change the priority of a module, we first find its position in the vector,
229 * then we find the position of the other modules in the vector that this module
230 * wants to be before/after. We pick off either the first or last of these depending
231 * on which they want, and we make sure our module is *at least* before or after
232 * the first or last of this subset, depending again on the type of priority.
236 /* Locate our module. This is O(n) but it only occurs on module load so we're
237 * not too bothered about it
239 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
241 if (EventHandlers[i][x] == mod)
248 /* Eh? this module doesnt exist, probably trying to set priority on an event
249 * theyre not attached to.
254 size_t swap_pos = my_pos;
258 if (prioritizationState != PRIO_STATE_FIRST)
264 if (prioritizationState != PRIO_STATE_FIRST)
267 swap_pos = EventHandlers[i].size() - 1;
271 /* Find the latest possible position, only searching AFTER our position */
272 for (size_t x = EventHandlers[i].size() - 1; x > my_pos; --x)
274 if (EventHandlers[i][x] == which)
280 // didn't find it - either not loaded or we're already after
283 /* Place this module before a set of other modules */
284 case PRIORITY_BEFORE:
286 for (size_t x = 0; x < my_pos; ++x)
288 if (EventHandlers[i][x] == which)
294 // didn't find it - either not loaded or we're already before
300 /* Do we need to swap? */
301 if (swap_pos != my_pos)
303 // We are going to change positions; we'll need to run again to verify all requirements
304 if (prioritizationState == PRIO_STATE_LAST)
305 prioritizationState = PRIO_STATE_AGAIN;
306 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
309 if (my_pos > swap_pos)
312 for (unsigned int j = my_pos; j != swap_pos; j += incrmnt)
314 if ((j + incrmnt > EventHandlers[i].size() - 1) || ((incrmnt == -1) && (j == 0)))
317 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
324 bool ModuleManager::CanUnload(Module* mod)
326 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
328 if ((modfind == Modules.end()) || (modfind->second != mod) || (mod->dying))
330 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
331 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
334 if (mod->GetVersion().Flags & VF_STATIC)
336 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
337 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, LastModuleError);
345 void ModuleManager::DoSafeUnload(Module* mod)
347 // First, notify all modules that a module is about to be unloaded, so in case
348 // they pass execution to the soon to be unloaded module, it will happen now,
349 // i.e. before we unregister the services of the module being unloaded
350 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
352 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
354 std::vector<reference<ExtensionItem> > items;
355 ServerInstance->Extensions.BeginUnregister(modfind->second, items);
356 /* Give the module a chance to tidy out all its metadata */
357 for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++)
359 mod->OnCleanup(TYPE_CHANNEL,c->second);
360 c->second->doUnhookExtensions(items);
361 const UserMembList* users = c->second->GetUsers();
362 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
363 mi->second->doUnhookExtensions(items);
365 for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
367 mod->OnCleanup(TYPE_USER,u->second);
368 u->second->doUnhookExtensions(items);
370 for(char m='A'; m <= 'z'; m++)
373 mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
374 if (mh && mh->creator == mod)
375 this->DelService(*mh);
376 mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL);
377 if (mh && mh->creator == mod)
378 this->DelService(*mh);
380 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
382 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
383 if (curr->second->creator == mod)
384 DataProviders.erase(curr);
387 dynamic_reference_base::reset_all();
391 Modules.erase(modfind);
392 ServerInstance->GlobalCulls.AddItem(mod);
394 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str());
396 ServerInstance->ISupport.Build();
399 void ModuleManager::UnloadAll()
401 /* We do this more than once, so that any service providers get a
402 * chance to be unhooked by the modules using them, but then get
403 * a chance to be removed themsleves.
405 * Note: this deliberately does NOT delete the DLLManager objects
407 for (int tries = 0; tries < 4; tries++)
409 std::map<std::string, Module*>::iterator i = Modules.begin();
410 while (i != Modules.end())
412 std::map<std::string, Module*>::iterator me = i++;
413 if (CanUnload(me->second))
415 DoSafeUnload(me->second);
418 ServerInstance->GlobalCulls.Apply();
422 std::string& ModuleManager::LastError()
424 return LastModuleError;
427 void ModuleManager::AddService(ServiceProvider& item)
429 switch (item.service)
431 case SERVICE_COMMAND:
432 if (!ServerInstance->Parser->AddCommand(static_cast<Command*>(&item)))
433 throw ModuleException("Command "+std::string(item.name)+" already exists.");
436 if (!ServerInstance->Modes->AddMode(static_cast<ModeHandler*>(&item)))
437 throw ModuleException("Mode "+std::string(item.name)+" already exists.");
438 DataProviders.insert(std::make_pair("mode/" + item.name, &item));
439 dynamic_reference_base::reset_all();
441 case SERVICE_METADATA:
442 if (!ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item)))
443 throw ModuleException("Extension " + std::string(item.name) + " already exists.");
448 if (item.name.substr(0, 5) == "mode/")
449 throw ModuleException("The \"mode/\" service name prefix is reserved.");
451 DataProviders.insert(std::make_pair(item.name, &item));
452 std::string::size_type slash = item.name.find('/');
453 if (slash != std::string::npos)
455 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
456 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
458 dynamic_reference_base::reset_all();
462 throw ModuleException("Cannot add unknown service type");
466 void ModuleManager::DelService(ServiceProvider& item)
468 switch (item.service)
471 if (!ServerInstance->Modes->DelMode(static_cast<ModeHandler*>(&item)))
472 throw ModuleException("Mode "+std::string(item.name)+" does not exist.");
477 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
479 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
480 if (curr->second == &item)
481 DataProviders.erase(curr);
483 dynamic_reference_base::reset_all();
487 throw ModuleException("Cannot delete unknown service type");
491 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
498 std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
499 if (i != DataProviders.end() && i->second->service == type)
503 // TODO implement finding of the other types
505 throw ModuleException("Cannot find unknown service type");
509 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
510 : name(Name), value(NULL), creator(Creator)
513 dynrefs = new std::vector<dynamic_reference_base*>;
514 dynrefs->push_back(this);
515 if (dynref_init_complete)
519 dynamic_reference_base::~dynamic_reference_base()
521 for(unsigned int i = 0; i < dynrefs->size(); i++)
523 if (dynrefs->at(i) == this)
525 unsigned int last = dynrefs->size() - 1;
527 dynrefs->at(i) = dynrefs->at(last);
528 dynrefs->erase(dynrefs->begin() + last);
529 if (dynrefs->empty())
539 void dynamic_reference_base::SetProvider(const std::string& newname)
545 void dynamic_reference_base::resolve()
547 std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
548 if (i != ServerInstance->Modules->DataProviders.end())
549 value = static_cast<DataProvider*>(i->second);
554 void InspIRCd::SendMode(const std::vector<std::string>& parameters, User *user)
556 this->Modes->Process(parameters, user);
560 void InspIRCd::SendGlobalMode(const std::vector<std::string>& parameters, User *user)
562 Modes->Process(parameters, user);
563 if (!Modes->GetLastParse().empty())
564 this->PI->SendMode(parameters[0], Modes->GetLastParseParams(), Modes->GetLastParseTranslate());
567 Module* ModuleManager::Find(const std::string &name)
569 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
571 if (modfind == Modules.end())
574 return modfind->second;
577 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
579 std::vector<std::string> retval;
580 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
581 if (!filter || (x->second->GetVersion().Flags & filter))
582 retval.push_back(x->first);
586 FileReader::FileReader(const std::string &filename)
591 FileReader::FileReader()
595 std::string FileReader::Contents()
598 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
606 unsigned long FileReader::ContentSize()
608 return this->contentsize;
611 void FileReader::CalcSize()
614 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
615 n += (a->length() + 2);
616 this->contentsize = n;
619 void FileReader::LoadFile(const std::string &filename)
621 std::map<std::string, file_cache>::iterator file = ServerInstance->Config->Files.find(filename);
622 if (file != ServerInstance->Config->Files.end())
624 this->fc = file->second;
629 FILE* f = fopen(filename.c_str(), "r");
632 char linebuf[MAXBUF*10];
633 while (fgets(linebuf, sizeof(linebuf), f))
635 int len = strlen(linebuf);
637 fc.push_back(std::string(linebuf, len - 1));
645 FileReader::~FileReader()
649 bool FileReader::Exists()
651 return (!(fc.size() == 0));
654 std::string FileReader::GetLine(int x)
656 if ((x<0) || ((unsigned)x>fc.size()))
661 int FileReader::FileSize()