1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 #include "socketengine.h"
18 #include "command_parse.h"
20 #include "exitcodes.h"
27 // Version is a simple class for holding a modules version number
29 VersionBase<API_VERSION>::VersionBase(const std::string &desc, int flags)
30 : description(desc), Flags(flags)
35 VersionBase<API_VERSION>::VersionBase(const std::string &desc, int flags, const std::string& linkdata)
36 : description(desc), Flags(flags), link_data(linkdata)
41 bool VersionBase<API_VERSION>::CanLink(const std::string& other_data)
43 return link_data == other_data;
46 Request::Request(Module* src, Module* dst, const char* idstr)
47 : id(idstr), source(src), dest(dst)
54 dest->OnRequest(*this);
57 Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { }
61 FOREACH_MOD(I_OnEvent,OnEvent(*this));
64 // These declarations define the behavours of the base class Module (which does nothing at all)
67 CullResult Module::cull()
69 return classbase::cull();
75 ModResult Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; }
76 void Module::OnUserConnect(LocalUser*) { }
77 void Module::OnUserQuit(User*, const std::string&, const std::string&) { }
78 void Module::OnUserDisconnect(LocalUser*) { }
79 void Module::OnUserJoin(Membership*, bool, bool, CUList&) { }
80 void Module::OnPostJoin(Membership*) { }
81 void Module::OnUserPart(Membership*, std::string&, CUList&) { }
82 void Module::OnPreRehash(User*, const std::string&) { }
83 void Module::OnModuleRehash(User*, const std::string&) { }
84 void Module::OnRehash(User*) { }
85 ModResult Module::OnUserPreJoin(User*, Channel*, const char*, std::string&, const std::string&) { return MOD_RES_PASSTHRU; }
86 void Module::OnMode(User*, void*, int, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
87 void Module::OnOper(User*, const std::string&) { }
88 void Module::OnPostOper(User*, const std::string&, const std::string &) { }
89 void Module::OnInfo(User*) { }
90 void Module::OnWhois(User*, User*) { }
91 ModResult Module::OnUserPreInvite(User*, User*, Channel*, time_t) { return MOD_RES_PASSTHRU; }
92 ModResult Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
93 ModResult Module::OnUserPreNotice(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
94 ModResult Module::OnUserPreNick(User*, const std::string&) { return MOD_RES_PASSTHRU; }
95 void Module::OnUserPostNick(User*, const std::string&) { }
96 ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { return MOD_RES_PASSTHRU; }
97 void Module::On005Numeric(std::string&) { }
98 ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; }
99 void Module::OnLoadModule(Module*) { }
100 void Module::OnUnloadModule(Module*) { }
101 void Module::OnBackgroundTimer(time_t) { }
102 ModResult Module::OnPreCommand(std::string&, std::vector<std::string>&, LocalUser*, bool, const std::string&) { return MOD_RES_PASSTHRU; }
103 void Module::OnPostCommand(const std::string&, const std::vector<std::string>&, LocalUser*, CmdResult, const std::string&) { }
104 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
105 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
106 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
107 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
108 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
109 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
110 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
111 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
112 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
113 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
114 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
115 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
116 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
117 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
118 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
119 void Module::OnEvent(Event&) { }
120 void Module::OnRequest(Request&) { }
121 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
122 void Module::OnGlobalOper(User*) { }
123 void Module::OnPostConnect(User*) { }
124 ModResult Module::OnAddBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
125 ModResult Module::OnDelBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
126 void Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
127 int Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
128 void Module::OnStreamSocketClose(StreamSocket*) { }
129 void Module::OnStreamSocketConnect(StreamSocket*) { }
130 int Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
131 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
132 void Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
133 void Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
134 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
135 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
136 void Module::OnGetServerDescription(const std::string&, std::string&) { }
137 void Module::OnSyncUser(User*, Module*, void*) { }
138 void Module::OnSyncChannel(Channel*, Module*, void*) { }
139 void Module::OnSyncNetwork(Module*, void*) { }
140 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
141 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
142 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
143 void Module::OnWallops(User*, const std::string&) { }
144 void Module::OnChangeHost(User*, const std::string&) { }
145 void Module::OnChangeName(User*, const std::string&) { }
146 void Module::OnChangeIdent(User*, const std::string&) { }
147 void Module::OnAddLine(User*, XLine*) { }
148 void Module::OnDelLine(User*, XLine*) { }
149 void Module::OnExpireLine(XLine*) { }
150 void Module::OnCleanup(int, void*) { }
151 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
152 void Module::OnChannelDelete(Channel*) { }
153 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
154 ModResult Module::OnUserList(User*, Channel*) { return MOD_RES_PASSTHRU; }
155 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
156 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
157 void Module::OnGarbageCollect() { }
158 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
159 void Module::OnRunTestSuite() { }
160 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
161 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
162 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
163 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
164 void Module::OnSendWhoLine(User*, User*, Channel*, std::string&) { }
165 ModResult Module::OnChannelRestrictionApply(User*, Channel*, const char*) { return MOD_RES_PASSTHRU; }
167 ModuleManager::ModuleManager() : ModCount(0)
171 ModuleManager::~ModuleManager()
175 bool ModuleManager::Attach(Implementation i, Module* mod)
177 if (Modules.find(mod->ModuleSourceFile) == Modules.end())
178 ServerInstance->Logs->Log("MODULE", DEFAULT, "Module is attaching to hook %d in constructor; this does not handle exceptions correctly!", i);
180 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
183 EventHandlers[i].push_back(mod);
187 bool ModuleManager::Detach(Implementation i, Module* mod)
189 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
191 if (x == EventHandlers[i].end())
194 EventHandlers[i].erase(x);
198 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
200 for (size_t n = 0; n < sz; ++n)
204 void ModuleManager::DetachAll(Module* mod)
206 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
207 Detach((Implementation)n, mod);
210 bool ModuleManager::SetPriority(Module* mod, Priority s)
212 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
213 SetPriority(mod, (Implementation)n, s);
218 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module** modules, size_t sz)
220 /** To change the priority of a module, we first find its position in the vector,
221 * then we find the position of the other modules in the vector that this module
222 * wants to be before/after. We pick off either the first or last of these depending
223 * on which they want, and we make sure our module is *at least* before or after
224 * the first or last of this subset, depending again on the type of priority.
231 /* Locate our module. This is O(n) but it only occurs on module load so we're
232 * not too bothered about it
234 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
236 if (EventHandlers[i][x] == mod)
244 /* Eh? this module doesnt exist, probably trying to set priority on an event
245 * theyre not attached to.
253 case PRIORITY_DONTCARE:
256 /* Module wants to be first, sod everything else */
258 if (prioritizationState != PRIO_STATE_FIRST)
263 /* Module wants to be last. */
265 if (prioritizationState != PRIO_STATE_FIRST)
267 else if (EventHandlers[i].empty())
270 swap_pos = EventHandlers[i].size() - 1;
272 /* Place this module after a set of other modules */
275 /* Find the latest possible position */
278 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
280 for (size_t n = 0; n < sz; ++n)
282 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos))
291 /* Place this module before a set of other modules */
292 case PRIORITY_BEFORE:
294 swap_pos = EventHandlers[i].size() - 1;
296 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
298 for (size_t n = 0; n < sz; ++n)
300 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos))
311 /* Do we need to swap? */
312 if (swap && (swap_pos != source))
314 // We are going to change positions; we'll need to run again to verify all requirements
315 if (prioritizationState == PRIO_STATE_LAST)
316 prioritizationState = PRIO_STATE_AGAIN;
317 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
320 if (source > swap_pos)
323 for (unsigned int j = source; j != swap_pos; j += incrmnt)
325 if (( j + incrmnt > EventHandlers[i].size() - 1) || (j + incrmnt < 0))
328 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
335 bool ModuleManager::CanUnload(Module* mod)
337 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
339 if (modfind == Modules.end() || modfind->second != mod)
341 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
342 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
345 if (mod->GetVersion().Flags & VF_STATIC)
347 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
348 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
354 void ModuleManager::DoSafeUnload(Module* mod)
356 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
358 std::vector<reference<ExtensionItem> > items;
359 ServerInstance->Extensions.BeginUnregister(modfind->second, items);
360 /* Give the module a chance to tidy out all its metadata */
361 for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++)
363 mod->OnCleanup(TYPE_CHANNEL,c->second);
364 c->second->doUnhookExtensions(items);
365 const UserMembList* users = c->second->GetUsers();
366 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
367 mi->second->doUnhookExtensions(items);
369 for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
371 mod->OnCleanup(TYPE_USER,u->second);
372 u->second->doUnhookExtensions(items);
374 for(char m='A'; m <= 'z'; m++)
377 mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
378 if (mh && mh->creator == mod)
379 ServerInstance->Modes->DelMode(mh);
380 mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL);
381 if (mh && mh->creator == mod)
382 ServerInstance->Modes->DelMode(mh);
384 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
386 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
387 if (curr->second->creator == mod)
388 DataProviders.erase(curr);
390 for(unsigned int i = 0; i < ServerInstance->Modules->ActiveDynrefs.size(); i++)
391 ServerInstance->Modules->ActiveDynrefs[i]->ClearCache();
393 /* Tidy up any dangling resolvers */
394 ServerInstance->Res->CleanResolvers(mod);
396 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
400 Modules.erase(modfind);
401 ServerInstance->GlobalCulls.AddItem(mod);
403 ServerInstance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str());
405 ServerInstance->BuildISupport();
408 std::string& ModuleManager::LastError()
410 return LastModuleError;
413 CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user)
415 return this->Parser->CallHandler(commandname, parameters, user);
418 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user)
420 return this->Parser->IsValidCommand(commandname, pcnt, user);
423 void ModuleManager::AddService(ServiceProvider& item)
425 Module* owner = item.creator;
426 if (Modules.find(owner->ModuleSourceFile) == Modules.end())
427 ServerInstance->Logs->Log("MODULE", DEFAULT, "Module is registering item %s in constructor; this does not handle exceptions correctly!", item.name.c_str());
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.");
437 if (!ServerInstance->Modes->AddMode(static_cast<ModeHandler*>(&item)))
438 throw ModuleException("Mode "+std::string(item.name)+" already exists.");
440 case SERVICE_METADATA:
441 ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item));
446 DataProviders.insert(std::make_pair(item.name, &item));
447 std::string::size_type slash = item.name.find('/');
448 if (slash != std::string::npos)
450 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
451 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
456 throw ModuleException("Cannot add unknown service type");
460 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
467 std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
468 if (i != DataProviders.end() && i->second->service == type)
472 // TODO implement finding of the other types
474 throw ModuleException("Cannot find unknown service type");
478 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
479 : name(Name), value(NULL), creator(Creator)
481 ServerInstance->Modules->ActiveDynrefs.push_back(this);
484 dynamic_reference_base::~dynamic_reference_base()
486 for(unsigned int i = 0; i < ServerInstance->Modules->ActiveDynrefs.size(); i++)
488 if (ServerInstance->Modules->ActiveDynrefs[i] == this)
490 unsigned int last = ServerInstance->Modules->ActiveDynrefs.size() - 1;
492 ServerInstance->Modules->ActiveDynrefs[i] = ServerInstance->Modules->ActiveDynrefs[last];
493 ServerInstance->Modules->ActiveDynrefs.erase(ServerInstance->Modules->ActiveDynrefs.begin() + last);
499 void dynamic_reference_base::SetProvider(const std::string& newname)
505 void dynamic_reference_base::lookup()
508 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
511 dynamic_reference_base::operator bool()
515 std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
516 if (i != ServerInstance->Modules->DataProviders.end())
517 value = static_cast<DataProvider*>(i->second);
522 void InspIRCd::SendMode(const std::vector<std::string>& parameters, User *user)
524 this->Modes->Process(parameters, user);
528 void InspIRCd::SendGlobalMode(const std::vector<std::string>& parameters, User *user)
530 Modes->Process(parameters, user);
531 if (!Modes->GetLastParse().empty())
532 this->PI->SendMode(parameters[0], Modes->GetLastParseParams(), Modes->GetLastParseTranslate());
535 bool InspIRCd::AddResolver(Resolver* r, bool cached)
538 return this->Res->AddResolverClass(r);
541 r->TriggerCachedResult();
547 Module* ModuleManager::Find(const std::string &name)
549 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
551 if (modfind == Modules.end())
554 return modfind->second;
557 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
559 std::vector<std::string> retval;
560 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
561 if (!filter || (x->second->GetVersion().Flags & filter))
562 retval.push_back(x->first);
566 ConfigReader::ConfigReader()
569 ServerInstance->Logs->Log("MODULE", DEBUG, "ConfigReader is deprecated in 2.0; "
570 "use ServerInstance->Config->ConfValue(\"key\") or ->ConfTags(\"key\") instead");
574 ConfigReader::~ConfigReader()
578 static ConfigTag* SlowGetTag(const std::string &tag, int index)
580 ConfigTagList tags = ServerInstance->Config->ConfTags(tag);
581 while (tags.first != tags.second)
584 return tags.first->second;
591 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
593 std::string result = default_value;
594 if (!SlowGetTag(tag, index)->readString(name, result, allow_linefeeds))
596 this->error = CONF_VALUE_NOT_FOUND;
601 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
603 return ReadValue(tag, name, "", index, allow_linefeeds);
606 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
608 bool def = (default_value == "yes");
609 return SlowGetTag(tag, index)->getBool(name, def);
612 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
614 return ReadFlag(tag, name, "", index);
618 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive)
620 int v = atoi(default_value.c_str());
621 int result = SlowGetTag(tag, index)->getInt(name, v);
623 if ((need_positive) && (result < 0))
625 this->error = CONF_INT_NEGATIVE;
632 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive)
634 return ReadInteger(tag, name, "", index, need_positive);
637 long ConfigReader::GetError()
639 long olderr = this->error;
644 int ConfigReader::Enumerate(const std::string &tag)
646 ServerInstance->Logs->Log("MODULE", DEBUG, "Module is using ConfigReader::Enumerate on %s; this is slow!",
649 while (SlowGetTag(tag, i)) i++;
653 FileReader::FileReader(const std::string &filename)
658 FileReader::FileReader()
662 std::string FileReader::Contents()
665 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
673 unsigned long FileReader::ContentSize()
675 return this->contentsize;
678 void FileReader::CalcSize()
681 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
682 n += (a->length() + 2);
683 this->contentsize = n;
686 void FileReader::LoadFile(const std::string &filename)
690 if (ServerInstance->Config->ReadFile(c,filename.c_str()))
698 FileReader::~FileReader()
702 bool FileReader::Exists()
704 return (!(fc.size() == 0));
707 std::string FileReader::GetLine(int x)
709 if ((x<0) || ((unsigned)x>fc.size()))
714 int FileReader::FileSize()