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 void Module::OnUserInit(LocalUser*) { }
105 ModResult Module::OnCheckReady(LocalUser*) { return MOD_RES_PASSTHRU; }
106 ModResult Module::OnUserRegister(LocalUser*) { return MOD_RES_PASSTHRU; }
107 ModResult Module::OnUserPreKick(User*, Membership*, const std::string&) { return MOD_RES_PASSTHRU; }
108 void Module::OnUserKick(User*, Membership*, const std::string&, CUList&) { }
109 ModResult Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int) { return MOD_RES_PASSTHRU; }
110 ModResult Module::OnCheckInvite(User*, Channel*) { return MOD_RES_PASSTHRU; }
111 ModResult Module::OnCheckKey(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
112 ModResult Module::OnCheckLimit(User*, Channel*) { return MOD_RES_PASSTHRU; }
113 ModResult Module::OnCheckChannelBan(User*, Channel*) { return MOD_RES_PASSTHRU; }
114 ModResult Module::OnCheckBan(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
115 ModResult Module::OnExtBanCheck(User*, Channel*, char) { return MOD_RES_PASSTHRU; }
116 ModResult Module::OnStats(char, User*, string_list&) { return MOD_RES_PASSTHRU; }
117 ModResult Module::OnChangeLocalUserHost(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
118 ModResult Module::OnChangeLocalUserGECOS(LocalUser*, const std::string&) { return MOD_RES_PASSTHRU; }
119 ModResult Module::OnPreTopicChange(User*, Channel*, const std::string&) { return MOD_RES_PASSTHRU; }
120 void Module::OnEvent(Event&) { }
121 void Module::OnRequest(Request&) { }
122 ModResult Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return MOD_RES_PASSTHRU; }
123 void Module::OnGlobalOper(User*) { }
124 void Module::OnPostConnect(User*) { }
125 ModResult Module::OnAddBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
126 ModResult Module::OnDelBan(User*, Channel*, const std::string &) { return MOD_RES_PASSTHRU; }
127 void Module::OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { }
128 int Module::OnStreamSocketWrite(StreamSocket*, std::string&) { return -1; }
129 void Module::OnStreamSocketClose(StreamSocket*) { }
130 void Module::OnStreamSocketConnect(StreamSocket*) { }
131 int Module::OnStreamSocketRead(StreamSocket*, std::string&) { return -1; }
132 void Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
133 void Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
134 void Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
135 void Module::OnUserInvite(User*, User*, Channel*, time_t) { }
136 void Module::OnPostTopicChange(User*, Channel*, const std::string&) { }
137 void Module::OnGetServerDescription(const std::string&, std::string&) { }
138 void Module::OnSyncUser(User*, Module*, void*) { }
139 void Module::OnSyncChannel(Channel*, Module*, void*) { }
140 void Module::OnSyncNetwork(Module*, void*) { }
141 void Module::ProtoSendMode(void*, TargetTypeFlags, void*, const std::vector<std::string>&, const std::vector<TranslateType>&) { }
142 void Module::OnDecodeMetaData(Extensible*, const std::string&, const std::string&) { }
143 void Module::ProtoSendMetaData(void*, Extensible*, const std::string&, const std::string&) { }
144 void Module::OnWallops(User*, const std::string&) { }
145 void Module::OnChangeHost(User*, const std::string&) { }
146 void Module::OnChangeName(User*, const std::string&) { }
147 void Module::OnChangeIdent(User*, const std::string&) { }
148 void Module::OnAddLine(User*, XLine*) { }
149 void Module::OnDelLine(User*, XLine*) { }
150 void Module::OnExpireLine(XLine*) { }
151 void Module::OnCleanup(int, void*) { }
152 ModResult Module::OnChannelPreDelete(Channel*) { return MOD_RES_PASSTHRU; }
153 void Module::OnChannelDelete(Channel*) { }
154 ModResult Module::OnSetAway(User*, const std::string &) { return MOD_RES_PASSTHRU; }
155 ModResult Module::OnUserList(User*, Channel*) { return MOD_RES_PASSTHRU; }
156 ModResult Module::OnWhoisLine(User*, User*, int&, std::string&) { return MOD_RES_PASSTHRU; }
157 void Module::OnBuildNeighborList(User*, UserChanList&, std::map<User*,bool>&) { }
158 void Module::OnGarbageCollect() { }
159 ModResult Module::OnSetConnectClass(LocalUser* user, ConnectClass* myclass) { return MOD_RES_PASSTHRU; }
160 void Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
161 void Module::OnRunTestSuite() { }
162 void Module::OnNamesListItem(User*, Membership*, std::string&, std::string&) { }
163 ModResult Module::OnNumeric(User*, unsigned int, const std::string&) { return MOD_RES_PASSTHRU; }
164 void Module::OnHookIO(StreamSocket*, ListenSocket*) { }
165 ModResult Module::OnAcceptConnection(int, ListenSocket*, irc::sockets::sockaddrs*, irc::sockets::sockaddrs*) { return MOD_RES_PASSTHRU; }
166 void Module::OnSendWhoLine(User*, const std::vector<std::string>&, User*, Channel*, std::string&) { }
167 ModResult Module::OnChannelRestrictionApply(User*, Channel*, const char*) { return MOD_RES_PASSTHRU; }
169 ModuleManager::ModuleManager() : ModCount(0)
173 ModuleManager::~ModuleManager()
177 bool ModuleManager::Attach(Implementation i, Module* mod)
179 if (Modules.find(mod->ModuleSourceFile) == Modules.end())
180 ServerInstance->Logs->Log("MODULE", DEFAULT, "Module is attaching to hook %d in constructor; this does not handle exceptions correctly!", i);
182 if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
185 EventHandlers[i].push_back(mod);
189 bool ModuleManager::Detach(Implementation i, Module* mod)
191 EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);
193 if (x == EventHandlers[i].end())
196 EventHandlers[i].erase(x);
200 void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
202 for (size_t n = 0; n < sz; ++n)
206 void ModuleManager::DetachAll(Module* mod)
208 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
209 Detach((Implementation)n, mod);
212 bool ModuleManager::SetPriority(Module* mod, Priority s)
214 for (size_t n = I_BEGIN + 1; n != I_END; ++n)
215 SetPriority(mod, (Implementation)n, s);
220 bool ModuleManager::SetPriority(Module* mod, Implementation i, Priority s, Module** modules, size_t sz)
222 /** To change the priority of a module, we first find its position in the vector,
223 * then we find the position of the other modules in the vector that this module
224 * wants to be before/after. We pick off either the first or last of these depending
225 * on which they want, and we make sure our module is *at least* before or after
226 * the first or last of this subset, depending again on the type of priority.
233 /* Locate our module. This is O(n) but it only occurs on module load so we're
234 * not too bothered about it
236 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
238 if (EventHandlers[i][x] == mod)
246 /* Eh? this module doesnt exist, probably trying to set priority on an event
247 * theyre not attached to.
255 case PRIORITY_DONTCARE:
258 /* Module wants to be first, sod everything else */
260 if (prioritizationState != PRIO_STATE_FIRST)
265 /* Module wants to be last. */
267 if (prioritizationState != PRIO_STATE_FIRST)
269 else if (EventHandlers[i].empty())
272 swap_pos = EventHandlers[i].size() - 1;
274 /* Place this module after a set of other modules */
277 /* Find the latest possible position */
280 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
282 for (size_t n = 0; n < sz; ++n)
284 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos))
293 /* Place this module before a set of other modules */
294 case PRIORITY_BEFORE:
296 swap_pos = EventHandlers[i].size() - 1;
298 for (size_t x = 0; x != EventHandlers[i].size(); ++x)
300 for (size_t n = 0; n < sz; ++n)
302 if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos))
313 /* Do we need to swap? */
314 if (swap && (swap_pos != source))
316 // We are going to change positions; we'll need to run again to verify all requirements
317 if (prioritizationState == PRIO_STATE_LAST)
318 prioritizationState = PRIO_STATE_AGAIN;
319 /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
322 if (source > swap_pos)
325 for (unsigned int j = source; j != swap_pos; j += incrmnt)
327 if (( j + incrmnt > EventHandlers[i].size() - 1) || (j + incrmnt < 0))
330 std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
337 bool ModuleManager::CanUnload(Module* mod)
339 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
341 if (modfind == Modules.end() || modfind->second != mod)
343 LastModuleError = "Module " + mod->ModuleSourceFile + " is not loaded, cannot unload it!";
344 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
347 if (mod->GetVersion().Flags & VF_STATIC)
349 LastModuleError = "Module " + mod->ModuleSourceFile + " not unloadable (marked static)";
350 ServerInstance->Logs->Log("MODULE", DEFAULT, LastModuleError);
356 void ModuleManager::DoSafeUnload(Module* mod)
358 std::map<std::string, Module*>::iterator modfind = Modules.find(mod->ModuleSourceFile);
360 std::vector<reference<ExtensionItem> > items;
361 ServerInstance->Extensions.BeginUnregister(modfind->second, items);
362 /* Give the module a chance to tidy out all its metadata */
363 for (chan_hash::iterator c = ServerInstance->chanlist->begin(); c != ServerInstance->chanlist->end(); c++)
365 mod->OnCleanup(TYPE_CHANNEL,c->second);
366 c->second->doUnhookExtensions(items);
367 const UserMembList* users = c->second->GetUsers();
368 for(UserMembCIter mi = users->begin(); mi != users->end(); mi++)
369 mi->second->doUnhookExtensions(items);
371 for (user_hash::iterator u = ServerInstance->Users->clientlist->begin(); u != ServerInstance->Users->clientlist->end(); u++)
373 mod->OnCleanup(TYPE_USER,u->second);
374 u->second->doUnhookExtensions(items);
376 for(char m='A'; m <= 'z'; m++)
379 mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
380 if (mh && mh->creator == mod)
381 ServerInstance->Modes->DelMode(mh);
382 mh = ServerInstance->Modes->FindMode(m, MODETYPE_CHANNEL);
383 if (mh && mh->creator == mod)
384 ServerInstance->Modes->DelMode(mh);
386 for(std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.begin(); i != DataProviders.end(); )
388 std::multimap<std::string, ServiceProvider*>::iterator curr = i++;
389 if (curr->second->creator == mod)
390 DataProviders.erase(curr);
392 for(unsigned int i = 0; i < ServerInstance->Modules->ActiveDynrefs.size(); i++)
393 ServerInstance->Modules->ActiveDynrefs[i]->ClearCache();
395 /* Tidy up any dangling resolvers */
396 ServerInstance->Res->CleanResolvers(mod);
398 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(mod));
402 Modules.erase(modfind);
403 ServerInstance->GlobalCulls.AddItem(mod);
405 ServerInstance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",mod->ModuleSourceFile.c_str());
407 ServerInstance->BuildISupport();
410 std::string& ModuleManager::LastError()
412 return LastModuleError;
415 CmdResult InspIRCd::CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user)
417 return this->Parser->CallHandler(commandname, parameters, user);
420 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, User* user)
422 return this->Parser->IsValidCommand(commandname, pcnt, user);
425 void ModuleManager::AddService(ServiceProvider& item)
427 Module* owner = item.creator;
428 if (Modules.find(owner->ModuleSourceFile) == Modules.end())
429 ServerInstance->Logs->Log("MODULE", DEFAULT, "Module is registering item %s in constructor; this does not handle exceptions correctly!", item.name.c_str());
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.");
441 case SERVICE_METADATA:
442 ServerInstance->Extensions.Register(static_cast<ExtensionItem*>(&item));
447 DataProviders.insert(std::make_pair(item.name, &item));
448 std::string::size_type slash = item.name.find('/');
449 if (slash != std::string::npos)
451 DataProviders.insert(std::make_pair(item.name.substr(0, slash), &item));
452 DataProviders.insert(std::make_pair(item.name.substr(slash + 1), &item));
457 throw ModuleException("Cannot add unknown service type");
461 ServiceProvider* ModuleManager::FindService(ServiceType type, const std::string& name)
468 std::multimap<std::string, ServiceProvider*>::iterator i = DataProviders.find(name);
469 if (i != DataProviders.end() && i->second->service == type)
473 // TODO implement finding of the other types
475 throw ModuleException("Cannot find unknown service type");
479 dynamic_reference_base::dynamic_reference_base(Module* Creator, const std::string& Name)
480 : name(Name), value(NULL), creator(Creator)
482 ServerInstance->Modules->ActiveDynrefs.push_back(this);
485 dynamic_reference_base::~dynamic_reference_base()
487 for(unsigned int i = 0; i < ServerInstance->Modules->ActiveDynrefs.size(); i++)
489 if (ServerInstance->Modules->ActiveDynrefs[i] == this)
491 unsigned int last = ServerInstance->Modules->ActiveDynrefs.size() - 1;
493 ServerInstance->Modules->ActiveDynrefs[i] = ServerInstance->Modules->ActiveDynrefs[last];
494 ServerInstance->Modules->ActiveDynrefs.erase(ServerInstance->Modules->ActiveDynrefs.begin() + last);
500 void dynamic_reference_base::SetProvider(const std::string& newname)
506 void dynamic_reference_base::lookup()
509 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
512 dynamic_reference_base::operator bool()
516 std::multimap<std::string, ServiceProvider*>::iterator i = ServerInstance->Modules->DataProviders.find(name);
517 if (i != ServerInstance->Modules->DataProviders.end())
518 value = static_cast<DataProvider*>(i->second);
523 void InspIRCd::SendMode(const std::vector<std::string>& parameters, User *user)
525 this->Modes->Process(parameters, user);
529 void InspIRCd::SendGlobalMode(const std::vector<std::string>& parameters, User *user)
531 Modes->Process(parameters, user);
532 if (!Modes->GetLastParse().empty())
533 this->PI->SendMode(parameters[0], Modes->GetLastParseParams(), Modes->GetLastParseTranslate());
536 bool InspIRCd::AddResolver(Resolver* r, bool cached)
539 return this->Res->AddResolverClass(r);
542 r->TriggerCachedResult();
548 Module* ModuleManager::Find(const std::string &name)
550 std::map<std::string, Module*>::iterator modfind = Modules.find(name);
552 if (modfind == Modules.end())
555 return modfind->second;
558 const std::vector<std::string> ModuleManager::GetAllModuleNames(int filter)
560 std::vector<std::string> retval;
561 for (std::map<std::string, Module*>::iterator x = Modules.begin(); x != Modules.end(); ++x)
562 if (!filter || (x->second->GetVersion().Flags & filter))
563 retval.push_back(x->first);
567 ConfigReader::ConfigReader()
570 ServerInstance->Logs->Log("MODULE", DEBUG, "ConfigReader is deprecated in 2.0; "
571 "use ServerInstance->Config->ConfValue(\"key\") or ->ConfTags(\"key\") instead");
575 ConfigReader::~ConfigReader()
579 static ConfigTag* SlowGetTag(const std::string &tag, int index)
581 ConfigTagList tags = ServerInstance->Config->ConfTags(tag);
582 while (tags.first != tags.second)
585 return tags.first->second;
592 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
594 std::string result = default_value;
595 if (!SlowGetTag(tag, index)->readString(name, result, allow_linefeeds))
597 this->error = CONF_VALUE_NOT_FOUND;
602 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
604 return ReadValue(tag, name, "", index, allow_linefeeds);
607 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
609 bool def = (default_value == "yes");
610 return SlowGetTag(tag, index)->getBool(name, def);
613 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
615 return ReadFlag(tag, name, "", index);
619 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive)
621 int v = atoi(default_value.c_str());
622 int result = SlowGetTag(tag, index)->getInt(name, v);
624 if ((need_positive) && (result < 0))
626 this->error = CONF_INT_NEGATIVE;
633 int ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive)
635 return ReadInteger(tag, name, "", index, need_positive);
638 long ConfigReader::GetError()
640 long olderr = this->error;
645 int ConfigReader::Enumerate(const std::string &tag)
647 ServerInstance->Logs->Log("MODULE", DEBUG, "Module is using ConfigReader::Enumerate on %s; this is slow!",
650 while (SlowGetTag(tag, i)) i++;
654 FileReader::FileReader(const std::string &filename)
659 FileReader::FileReader()
663 std::string FileReader::Contents()
666 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
674 unsigned long FileReader::ContentSize()
676 return this->contentsize;
679 void FileReader::CalcSize()
682 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
683 n += (a->length() + 2);
684 this->contentsize = n;
687 void FileReader::LoadFile(const std::string &filename)
689 std::map<std::string, file_cache>::iterator file = ServerInstance->Config->Files.find(filename);
690 if (file != ServerInstance->Config->Files.end())
692 this->fc = file->second;
697 FILE* f = fopen(filename.c_str(), "r");
700 char linebuf[MAXBUF*10];
701 while (fgets(linebuf, sizeof(linebuf), f))
703 int len = strlen(linebuf);
705 fc.push_back(std::string(linebuf, len - 1));
713 FileReader::~FileReader()
717 bool FileReader::Exists()
719 return (!(fc.size() == 0));
722 std::string FileReader::GetLine(int x)
724 if ((x<0) || ((unsigned)x>fc.size()))
729 int FileReader::FileSize()