1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 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 &modv, int flags, const std::string& rev)
30 : description(modv), version(rev), Flags(flags)
34 Request::Request(Module* src, Module* dst, const char* idstr)
35 : id(idstr), source(src), dest(dst)
42 dest->OnRequest(*this);
45 Event::Event(Module* src, const std::string &eventid) : source(src), id(eventid) { }
49 FOREACH_MOD(I_OnEvent,OnEvent(*this));
52 // These declarations define the behavours of the base class Module (which does nothing at all)
55 CullResult Module::cull()
57 return classbase::cull();
63 ModResult Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return MOD_RES_PASSTHRU; }
64 void Module::OnUserConnect(LocalUser*) { }
65 void Module::OnUserQuit(User*, const std::string&, const std::string&) { }
66 void Module::OnUserDisconnect(LocalUser*) { }
67 void Module::OnUserJoin(Membership*, bool, bool, CUList&) { }
68 void Module::OnPostJoin(Membership*) { }
69 void Module::OnUserPart(Membership*, std::string&, CUList&) { }
70 void Module::OnPreRehash(User*, const std::string&) { }
71 void Module::OnModuleRehash(User*, const std::string&) { }
72 void Module::OnRehash(User*) { }
73 ModResult Module::OnUserPreJoin(User*, Channel*, const char*, std::string&, const std::string&) { return MOD_RES_PASSTHRU; }
74 void Module::OnMode(User*, void*, int, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
75 void Module::OnOper(User*, const std::string&) { }
76 void Module::OnPostOper(User*, const std::string&, const std::string &) { }
77 void Module::OnInfo(User*) { }
78 void Module::OnWhois(User*, User*) { }
79 ModResult Module::OnUserPreInvite(User*, User*, Channel*, time_t) { return MOD_RES_PASSTHRU; }
80 ModResult Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
81 ModResult Module::OnUserPreNotice(User*, void*, int, std::string&, char, CUList&) { return MOD_RES_PASSTHRU; }
82 ModResult Module::OnUserPreNick(User*, const std::string&) { return MOD_RES_PASSTHRU; }
83 void Module::OnUserPostNick(User*, const std::string&) { }
84 ModResult Module::OnPreMode(User*, User*, Channel*, const std::vector<std::string>&) { return MOD_RES_PASSTHRU; }
85 void Module::On005Numeric(std::string&) { }
86 ModResult Module::OnKill(User*, User*, const std::string&) { return MOD_RES_PASSTHRU; }
87 void Module::OnLoadModule(Module*) { }
88 void Module::OnUnloadModule(Module*) { }
89 void Module::OnBackgroundTimer(time_t) { }
90 ModResult Module::OnPreCommand(std::string&, std::vector<std::string>&, User *, bool, const std::string&) { return MOD_RES_PASSTHRU; }
91 void Module::OnPostCommand(const std::string&, const std::vector<std::string>&, User *, CmdResult, const std::string&) { }
92 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
93 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
94 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
95 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
96 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
97 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
98 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
99 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
100 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
101 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
102 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
103 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
104 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
105 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
106 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
107 void Module::OnEvent(Event&) { }
108 void Module::OnRequest(Request&) { }
109 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
110 void Module::OnGlobalOper(User*) { }
111 void Module::OnPostConnect(User*) { }
112 ModResult Module::OnAddBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
113 ModResult Module::OnDelBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
114 void Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
115 int Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
116 void Module::OnStreamSocketClose(StreamSocket*) { }
117 void Module::OnStreamSocketConnect(StreamSocket*) { }
118 int Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
119 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
120 void Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
121 void Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
122 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
123 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
124 void Module::OnGetServerDescription(const std::string&, std::string&) { }
125 void Module::OnSyncUser(User*, Module*, void*) { }
126 void Module::OnSyncChannel(Channel*, Module*, void*) { }
127 void Module::OnSyncNetwork(Module*, void*) { }
128 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
129 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
130 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
131 void Module::OnWallops(User*, const std::string&) { }
132 void Module::OnChangeHost(User*, const std::string&) { }
133 void Module::OnChangeName(User*, const std::string&) { }
134 void Module::OnChangeIdent(User*, const std::string&) { }
135 void Module::OnAddLine(User*, XLine*) { }
136 void Module::OnDelLine(User*, XLine*) { }
137 void Module::OnExpireLine(XLine*) { }
138 void Module::OnCleanup(int, void*) { }
139 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
140 void Module::OnChannelDelete(Channel*) { }
141 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
142 ModResult Module::OnUserList(User*, Channel*) { return MOD_RES_PASSTHRU; }
143 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
144 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
145 void Module::OnGarbageCollect() { }
146 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
147 void Module::OnRunTestSuite() { }
148 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
149 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
150 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
151 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
152 void Module::OnSendWhoLine(User*, User*, Channel*, std::string&) { }
153 ModResult Module::OnChannelRestrictionApply(User*, Channel*, const char*) { return MOD_RES_PASSTHRU; }
155 ModuleManager::ModuleManager() : ModCount(0)
159 ModuleManager::~ModuleManager()
163 bool ModuleManager::Attach(Implementation i, Module* mod)
165 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
168 EventHandlers[i].push_back(mod);
172 bool ModuleManager::Detach(Implementation i, Module* mod)
174 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
176 if (x == EventHandlers[i].end())
179 EventHandlers[i].erase(x);
183 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
185 for (size_t n = 0; n < sz; ++n)
189 void ModuleManager::DetachAll(Module* mod)
191 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
192 Detach((Implementation)n, mod);
195 bool ModuleManager::SetPriority(Module* mod, Priority s)
197 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
198 SetPriority(mod, (Implementation)n, s);
203 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module** modules, size_t sz)
205 /** To change the priority of a module, we first find its position in the vector,
206 * then we find the position of the other modules in the vector that this module
207 * wants to be before/after. We pick off either the first or last of these depending
208 * on which they want, and we make sure our module is *at least* before or after
209 * the first or last of this subset, depending again on the type of priority.
216 /* Locate our module. This is O(n) but it only occurs on module load so we're
217 * not too bothered about it
219 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
221 if (EventHandlers[i][x] == mod)
229 /* Eh? this module doesnt exist, probably trying to set priority on an event
230 * theyre not attached to.
238 case PRIORITY_DONTCARE:
241 /* Module wants to be first, sod everything else */
243 if (prioritizationState != PRIO_STATE_FIRST)
248 /* Module wants to be last. */
250 if (prioritizationState != PRIO_STATE_FIRST)
252 else if (EventHandlers[i].empty())
255 swap_pos = EventHandlers[i].size() - 1;
257 /* Place this module after a set of other modules */
260 /* Find the latest possible position */
263 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
265 for (size_t n = 0; n < sz; ++n)
267 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos))
276 /* Place this module before a set of other modules */
277 case PRIORITY_BEFORE:
279 swap_pos = EventHandlers[i].size() - 1;
281 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
283 for (size_t n = 0; n < sz; ++n)
285 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos))
296 /* Do we need to swap? */
297 if (swap && (swap_pos != source))
299 // We are going to change positions; we'll need to run again to verify all requirements
300 if (prioritizationState == PRIO_STATE_LAST)
301 prioritizationState = PRIO_STATE_AGAIN;
302 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
305 if (source > swap_pos)
308 for (unsigned int j = source; j != swap_pos; j += incrmnt)
310 if (( j + incrmnt > EventHandlers[i].size() - 1) || (j + incrmnt < 0))
313 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
320 std::string& ModuleManager::LastError()
322 return LastModuleError;
325 bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod)
327 if (Features.find(FeatureName) == Features.end())
329 Features[FeatureName] = Mod;
335 bool ModuleManager::UnpublishFeature(const std::string &FeatureName)
337 featurelist::iterator iter = Features.find(FeatureName);
339 if (iter == Features.end())
342 Features.erase(iter);
346 Module* ModuleManager::FindFeature(const std::string &FeatureName)
348 featurelist::iterator iter = Features.find(FeatureName);
350 if (iter == Features.end())
356 bool ModuleManager::PublishInterface(const std::string &InterfaceName, Module* Mod)
358 interfacelist::iterator iter = Interfaces.find(InterfaceName);
360 if (iter == Interfaces.end())
364 Interfaces[InterfaceName] = std::make_pair(0, ml);
368 iter->second.second.push_back(Mod);
373 bool ModuleManager::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
375 interfacelist::iterator iter = Interfaces.find(InterfaceName);
377 if (iter == Interfaces.end())
380 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
384 iter->second.second.erase(x);
385 if (iter->second.second.empty())
386 Interfaces.erase(InterfaceName);
393 modulelist* ModuleManager::FindInterface(const std::string &InterfaceName)
395 interfacelist::iterator iter = Interfaces.find(InterfaceName);
396 if (iter == Interfaces.end())
399 return &(iter->second.second);
402 bool ModuleManager::ModuleHasInterface(Module* mod, const std::string& InterfaceName)
404 interfacelist::iterator iter = Interfaces.find(InterfaceName);
405 if (iter == Interfaces.end())
409 modulelist& ml = iter->second.second;
410 modulelist::iterator mi = std::find(ml.begin(), ml.end(), mod);
411 return (mi != ml.end());
415 void ModuleManager::UseInterface(const std::string &InterfaceName)
417 interfacelist::iterator iter = Interfaces.find(InterfaceName);
418 if (iter != Interfaces.end())
419 iter->second.first++;
423 void ModuleManager::DoneWithInterface(const std::string &InterfaceName)
425 interfacelist::iterator iter = Interfaces.find(InterfaceName);
426 if (iter != Interfaces.end())
427 iter->second.first--;
430 std::pair<int,std::string> ModuleManager::GetInterfaceInstanceCount(Module* m)
432 for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
434 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
438 return std::make_pair(iter->second.first, iter->first);
442 return std::make_pair(0, "");
445 const std::string& ModuleManager::GetModuleName(Module* m)
447 static std::string nothing;
449 for (std::map<std::string, Module*>::iterator n = Modules.begin(); n != Modules.end(); ++n)
458 CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user)
460 return this->Parser->CallHandler(commandname, parameters, user);
463 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user)
465 return this->Parser->IsValidCommand(commandname, pcnt, user);
468 void InspIRCd::AddCommand(Command *f)
470 if (!this->Parser->AddCommand(f))
472 throw ModuleException("Command "+std::string(f->command)+" already exists.");
476 void InspIRCd::SendMode(const std::vector<std::string>& parameters, User *user)
478 this->Modes->Process(parameters, user);
481 bool InspIRCd::AddResolver(Resolver* r, bool cached)
484 return this->Res->AddResolverClass(r);
487 r->TriggerCachedResult();
493 Module* ModuleManager::Find(const std::string &name)
495 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
497 if (modfind == Modules.end())
500 return modfind->second;
503 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
505 std::vector<std::string> retval;
506 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
507 if (!filter || (x->second->GetVersion().Flags & filter))
508 retval.push_back(x->first);
512 ConfigReader::ConfigReader()
518 ConfigReader::~ConfigReader()
522 static ConfigTag* SlowGetTag(const std::string &tag, int index)
524 ConfigTagList tags = ServerInstance->Config->ConfTags(tag);
525 while (tags.first != tags.second)
528 return tags.first->second;
535 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
537 std::string result = default_value;
538 if (!SlowGetTag(tag, index)->readString(name, result, allow_linefeeds))
540 this->error = CONF_VALUE_NOT_FOUND;
545 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
547 return ReadValue(tag, name, "", index, allow_linefeeds);
550 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
552 bool def = (default_value == "yes");
553 return SlowGetTag(tag, index)->getBool(name, def);
556 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
558 return ReadFlag(tag, name, "", index);
562 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive)
564 int v = atoi(default_value.c_str());
565 int result = SlowGetTag(tag, index)->getInt(name, v);
567 if ((need_positive) && (result < 0))
569 this->error = CONF_INT_NEGATIVE;
576 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive)
578 return ReadInteger(tag, name, "", index, need_positive);
581 long ConfigReader::GetError()
583 long olderr = this->error;
588 int ConfigReader::Enumerate(const std::string &tag)
590 ServerInstance->Logs->Log("MODULE", DEBUG, "Module is using ConfigReader::Enumerate on %s; this is slow!",
593 while (SlowGetTag(tag, i)) i++;
597 FileReader::FileReader(const std::string &filename)
602 FileReader::FileReader()
606 std::string FileReader::Contents()
609 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
617 unsigned long FileReader::ContentSize()
619 return this->contentsize;
622 void FileReader::CalcSize()
625 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
626 n += (a->length() + 2);
627 this->contentsize = n;
630 void FileReader::LoadFile(const std::string &filename)
634 if (ServerInstance->Config->ReadFile(c,filename.c_str()))
642 FileReader::~FileReader()
646 bool FileReader::Exists()
648 return (!(fc.size() == 0));
651 std::string FileReader::GetLine(int x)
653 if ((x<0) || ((unsigned)x>fc.size()))
658 int FileReader::FileSize()