1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #include "configreader.h"
21 #include "socketengine.h"
22 #include "command_parse.h"
26 // version is a simple class for holding a modules version number
27 Version::Version(int major, int minor, int revision, int build, int flags, int api_ver)
28 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags), API(api_ver)
32 Request::Request(char* anydata, Module* src, Module* dst)
33 : data(anydata), source(src), dest(dst)
35 /* Ensure that because this module doesnt support ID strings, it doesnt break modules that do
36 * by passing them uninitialized pointers (could happen)
41 Request::Request(Module* src, Module* dst, const char* idstr)
42 : id(idstr), source(src), dest(dst)
46 char* Request::GetData()
51 const char* Request::GetId()
56 Module* Request::GetSource()
61 Module* Request::GetDest()
70 return dest->OnRequest(this);
78 Event::Event(char* anydata, Module* src, const std::string &eventid) : data(anydata), source(src), id(eventid) { };
80 char* Event::GetData()
82 return (char*)this->data;
85 Module* Event::GetSource()
90 char* Event::Send(InspIRCd* ServerInstance)
92 FOREACH_MOD(I_OnEvent,OnEvent(this));
96 std::string Event::GetEventID()
102 // These declarations define the behavours of the base class Module (which does nothing at all)
104 Module::Module(InspIRCd* Me) : ServerInstance(Me) { }
105 Module::~Module() { }
106 void Module::OnUserConnect(userrec* user) { }
107 void Module::OnUserQuit(userrec* user, const std::string& message) { }
108 void Module::OnUserDisconnect(userrec* user) { }
109 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
110 void Module::OnPostJoin(userrec* user, chanrec* channel) { }
111 void Module::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage) { }
112 void Module::OnRehash(userrec* user, const std::string ¶meter) { }
113 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { }
114 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs) { return 0; }
115 void Module::OnMode(userrec* user, void* dest, int target_type, const std::string &text) { };
116 Version Module::GetVersion() { return Version(1,0,0,0,VF_VENDOR,-1); }
117 void Module::OnOper(userrec* user, const std::string &opertype) { };
118 void Module::OnPostOper(userrec* user, const std::string &opertype) { };
119 void Module::OnInfo(userrec* user) { };
120 void Module::OnWhois(userrec* source, userrec* dest) { };
121 int Module::OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel) { return 0; };
122 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list) { return 0; };
123 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list) { return 0; };
124 int Module::OnUserPreNick(userrec* user, const std::string &newnick) { return 0; };
125 void Module::OnUserPostNick(userrec* user, const std::string &oldnick) { };
126 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; };
127 void Module::On005Numeric(std::string &output) { };
128 int Module::OnKill(userrec* source, userrec* dest, const std::string &reason) { return 0; };
129 void Module::OnLoadModule(Module* mod,const std::string &name) { };
130 void Module::OnUnloadModule(Module* mod,const std::string &name) { };
131 void Module::OnBackgroundTimer(time_t curtime) { };
132 int Module::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line) { return 0; };
133 void Module::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line) { };
134 bool Module::OnCheckReady(userrec* user) { return true; };
135 int Module::OnUserRegister(userrec* user) { return 0; };
136 int Module::OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason) { return 0; };
137 void Module::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason) { };
138 int Module::OnCheckInvite(userrec* user, chanrec* chan) { return 0; };
139 int Module::OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven) { return 0; };
140 int Module::OnCheckLimit(userrec* user, chanrec* chan) { return 0; };
141 int Module::OnCheckBan(userrec* user, chanrec* chan) { return 0; };
142 int Module::OnStats(char symbol, userrec* user, string_list &results) { return 0; };
143 int Module::OnChangeLocalUserHost(userrec* user, const std::string &newhost) { return 0; };
144 int Module::OnChangeLocalUserGECOS(userrec* user, const std::string &newhost) { return 0; };
145 int Module::OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic) { return 0; };
146 void Module::OnEvent(Event* event) { return; };
147 char* Module::OnRequest(Request* request) { return NULL; };
148 int Module::OnOperCompare(const std::string &password, const std::string &input, int tagnumber) { return 0; };
149 void Module::OnGlobalOper(userrec* user) { };
150 void Module::OnPostConnect(userrec* user) { };
151 int Module::OnAddBan(userrec* source, chanrec* channel,const std::string &banmask) { return 0; };
152 int Module::OnDelBan(userrec* source, chanrec* channel,const std::string &banmask) { return 0; };
153 void Module::OnRawSocketAccept(int fd, const std::string &ip, int localport) { };
154 int Module::OnRawSocketWrite(int fd, const char* buffer, int count) { return 0; };
155 void Module::OnRawSocketClose(int fd) { };
156 void Module::OnRawSocketConnect(int fd) { };
157 int Module::OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult) { return 0; };
158 void Module::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) { };
159 void Module::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) { };
160 void Module::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason) { };
161 void Module::OnUserInvite(userrec* source,userrec* dest,chanrec* channel) { };
162 void Module::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic) { };
163 void Module::OnGetServerDescription(const std::string &servername,std::string &description) { };
164 void Module::OnSyncUser(userrec* user, Module* proto, void* opaque) { };
165 void Module::OnSyncChannel(chanrec* chan, Module* proto, void* opaque) { };
166 void Module::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline) { };
167 void Module::OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname) { };
168 void Module::OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname) { };
169 void Module::OnSyncOtherMetaData(Module* proto, void* opaque) { };
170 void Module::OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata) { };
171 void Module::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata) { };
172 void Module::OnWallops(userrec* user, const std::string &text) { };
173 void Module::OnChangeHost(userrec* user, const std::string &newhost) { };
174 void Module::OnChangeName(userrec* user, const std::string &gecos) { };
175 void Module::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
176 void Module::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask) { };
177 void Module::OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
178 void Module::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask) { };
179 void Module::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
180 void Module::OnDelGLine(userrec* source, const std::string &hostmask) { };
181 void Module::OnDelZLine(userrec* source, const std::string &ipmask) { };
182 void Module::OnDelKLine(userrec* source, const std::string &hostmask) { };
183 void Module::OnDelQLine(userrec* source, const std::string &nickmask) { };
184 void Module::OnDelELine(userrec* source, const std::string &hostmask) { };
185 void Module::OnCleanup(int target_type, void* item) { };
186 void Module::Implements(char* Implements) { for (int j = 0; j < 255; j++) Implements[j] = 0; };
187 void Module::OnChannelDelete(chanrec* chan) { };
188 Priority Module::Prioritize() { return PRIORITY_DONTCARE; }
189 void Module::OnSetAway(userrec* user) { };
190 void Module::OnCancelAway(userrec* user) { };
191 int Module::OnUserList(userrec* user, chanrec* Ptr) { return 0; };
192 int Module::OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text) { return 0; };
193 void Module::OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list) { };
194 void Module::OnGarbageCollect() { };
196 long InspIRCd::PriorityAfter(const std::string &modulename)
198 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
200 if (this->Config->module_names[j] == modulename)
202 return ((j << 8) | PRIORITY_AFTER);
205 return PRIORITY_DONTCARE;
208 long InspIRCd::PriorityBefore(const std::string &modulename)
210 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
212 if (this->Config->module_names[j] == modulename)
214 return ((j << 8) | PRIORITY_BEFORE);
217 return PRIORITY_DONTCARE;
220 bool InspIRCd::PublishFeature(const std::string &FeatureName, Module* Mod)
222 if (Features.find(FeatureName) == Features.end())
224 Features[FeatureName] = Mod;
230 bool InspIRCd::UnpublishFeature(const std::string &FeatureName)
232 featurelist::iterator iter = Features.find(FeatureName);
234 if (iter == Features.end())
237 Features.erase(iter);
241 Module* InspIRCd::FindFeature(const std::string &FeatureName)
243 featurelist::iterator iter = Features.find(FeatureName);
245 if (iter == Features.end())
251 bool InspIRCd::PublishInterface(const std::string &InterfaceName, Module* Mod)
253 interfacelist::iterator iter = Interfaces.find(InterfaceName);
255 if (iter == Interfaces.end())
259 Interfaces[InterfaceName] = std::make_pair(0, ml);
264 iter->second.second.push_back(Mod);
270 bool InspIRCd::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
272 interfacelist::iterator iter = Interfaces.find(InterfaceName);
274 if (iter == Interfaces.end())
277 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
281 iter->second.second.erase(x);
282 if (iter->second.second.empty())
283 Interfaces.erase(InterfaceName);
290 modulelist* InspIRCd::FindInterface(const std::string &InterfaceName)
292 interfacelist::iterator iter = Interfaces.find(InterfaceName);
293 if (iter == Interfaces.end())
296 return &(iter->second.second);
299 void InspIRCd::UseInterface(const std::string &InterfaceName)
301 interfacelist::iterator iter = Interfaces.find(InterfaceName);
302 if (iter != Interfaces.end())
303 iter->second.first++;
307 void InspIRCd::DoneWithInterface(const std::string &InterfaceName)
309 interfacelist::iterator iter = Interfaces.find(InterfaceName);
310 if (iter != Interfaces.end())
311 iter->second.first--;
314 std::pair<int,std::string> InspIRCd::GetInterfaceInstanceCount(Module* m)
316 for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
318 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
322 return std::make_pair(iter->second.first, iter->first);
326 return std::make_pair(0, "");
329 const std::string& InspIRCd::GetModuleName(Module* m)
331 static std::string nothing = ""; /* Prevent compiler warning */
333 if (!this->GetModuleCount())
336 for (int i = 0; i <= this->GetModuleCount(); i++)
338 if (this->modules[i] == m)
340 return this->Config->module_names[i];
343 return nothing; /* As above */
346 void InspIRCd::RehashServer()
348 this->WriteOpers("*** Rehashing config file");
349 this->RehashUsersAndChans();
350 this->Config->Read(false,NULL);
354 /* This is ugly, yes, but hash_map's arent designed to be
355 * addressed in this manner, and this is a bit of a kludge.
356 * Luckily its a specialist function and rarely used by
357 * many modules (in fact, it was specially created to make
358 * m_safelist possible, initially).
361 chanrec* InspIRCd::GetChannelIndex(long index)
364 for (chan_hash::iterator n = this->chanlist->begin(); n != this->chanlist->end(); n++, target++)
372 bool InspIRCd::MatchText(const std::string &sliteral, const std::string &spattern)
374 return match(sliteral.c_str(),spattern.c_str());
377 bool InspIRCd::CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user)
379 return this->Parser->CallHandler(commandname,parameters,pcnt,user);
382 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user)
384 return this->Parser->IsValidCommand(commandname, pcnt, user);
387 void InspIRCd::AddCommand(command_t *f)
389 if (!this->Parser->CreateCommand(f))
391 ModuleException err("Command "+std::string(f->command)+" already exists.");
396 void InspIRCd::SendMode(const char** parameters, int pcnt, userrec *user)
398 this->Modes->Process(parameters,pcnt,user,true);
401 void InspIRCd::DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream)
403 std::string CompleteLine = LinePrefix;
404 std::string Word = "";
405 while (TextStream >> Word)
407 if (CompleteLine.length() + Word.length() + 3 > 500)
409 User->WriteServ(CompleteLine);
410 CompleteLine = LinePrefix;
412 CompleteLine = CompleteLine + Word + " ";
414 User->WriteServ(CompleteLine);
417 userrec* InspIRCd::FindDescriptor(int socket)
419 return reinterpret_cast<userrec*>(this->SE->GetRef(socket));
422 bool InspIRCd::AddMode(ModeHandler* mh, const unsigned char mode)
424 return this->Modes->AddMode(mh,mode);
427 bool InspIRCd::AddModeWatcher(ModeWatcher* mw)
429 return this->Modes->AddModeWatcher(mw);
432 bool InspIRCd::DelModeWatcher(ModeWatcher* mw)
434 return this->Modes->DelModeWatcher(mw);
437 bool InspIRCd::AddResolver(Resolver* r)
439 return this->Res->AddResolverClass(r);
442 bool InspIRCd::UserToPseudo(userrec* user, const std::string &message)
444 unsigned int old_fd = user->GetFd();
445 user->Write("ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
446 user->FlushWriteBuf();
448 user->SetFd(FD_MAGIC_NUMBER);
450 if (find(local_users.begin(),local_users.end(),user) != local_users.end())
452 local_users.erase(find(local_users.begin(),local_users.end(),user));
455 this->SE->DelFd(user);
461 bool InspIRCd::PseudoToUser(userrec* alive, userrec* zombie, const std::string &message)
463 zombie->SetFd(alive->GetFd());
464 FOREACH_MOD_I(this,I_OnUserQuit,OnUserQuit(alive,message));
465 alive->SetFd(FD_MAGIC_NUMBER);
466 alive->FlushWriteBuf();
467 alive->ClearBuffer();
468 // save these for later
469 std::string oldnick = alive->nick;
470 std::string oldhost = alive->host;
471 std::string oldident = alive->ident;
472 userrec::QuitUser(this,alive,message.c_str());
473 if (find(local_users.begin(),local_users.end(),alive) != local_users.end())
475 local_users.erase(find(local_users.begin(),local_users.end(),alive));
477 // Fix by brain - cant write the user until their fd table entry is updated
478 zombie->Write(":%s!%s@%s NICK %s",oldnick.c_str(),oldident.c_str(),oldhost.c_str(),zombie->nick);
479 for (UCListIter i = zombie->chans.begin(); i != zombie->chans.end(); i++)
481 chanrec* Ptr = i->first;
482 zombie->WriteFrom(zombie,"JOIN %s",Ptr->name);
485 zombie->WriteServ("332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
486 zombie->WriteServ("333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
488 Ptr->UserList(zombie);
489 zombie->WriteServ("366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
491 if ((find(local_users.begin(),local_users.end(),zombie) == local_users.end()) && (zombie->GetFd() != FD_MAGIC_NUMBER))
492 local_users.push_back(zombie);
496 void InspIRCd::AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
498 XLines->add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
499 XLines->apply_lines(APPLY_GLINES);
502 void InspIRCd::AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname)
504 XLines->add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
505 XLines->apply_lines(APPLY_QLINES);
508 void InspIRCd::AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr)
510 XLines->add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
511 XLines->apply_lines(APPLY_ZLINES);
514 void InspIRCd::AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
516 XLines->add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
517 XLines->apply_lines(APPLY_KLINES);
520 void InspIRCd::AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
522 XLines->add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
525 bool InspIRCd::DelGLine(const std::string &hostmask)
527 return XLines->del_gline(hostmask.c_str());
530 bool InspIRCd::DelQLine(const std::string &nickname)
532 return XLines->del_qline(nickname.c_str());
535 bool InspIRCd::DelZLine(const std::string &ipaddr)
537 return XLines->del_zline(ipaddr.c_str());
540 bool InspIRCd::DelKLine(const std::string &hostmask)
542 return XLines->del_kline(hostmask.c_str());
545 bool InspIRCd::DelELine(const std::string &hostmask)
547 return XLines->del_eline(hostmask.c_str());
551 * XXX why on *earth* is this in modules.cpp...? I think
552 * perhaps we need a server.cpp for InspIRCd:: stuff where possible. -- w00t
554 bool InspIRCd::IsValidMask(const std::string &mask)
556 char* dest = (char*)mask.c_str();
557 if (strchr(dest,'!')==0)
559 if (strchr(dest,'@')==0)
561 for (char* i = dest; *i; i++)
564 for (char* i = dest; *i; i++)
568 for (char* i = dest; *i; i++)
574 for (char* i = dest; *i; i++)
583 Module* InspIRCd::FindModule(const std::string &name)
585 for (int i = 0; i <= this->GetModuleCount(); i++)
587 if (this->Config->module_names[i] == name)
589 return this->modules[i];
595 ConfigReader::ConfigReader(InspIRCd* Instance) : ServerInstance(Instance)
597 /* Is there any reason to load the entire config file again here?
598 * it's needed if they specify another config file, but using the
599 * default one we can just use the global config data - pre-parsed!
601 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
603 this->data = &ServerInstance->Config->config_data;
604 this->privatehash = false;
608 ConfigReader::~ConfigReader()
611 DELETE(this->errorlog);
612 if(this->privatehash)
617 ConfigReader::ConfigReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
619 ServerInstance->Config->ClearStack();
621 this->data = new ConfigDataHash;
622 this->privatehash = true;
623 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
624 this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog);
625 if (!this->readerror)
626 this->error = CONF_FILE_NOT_FOUND;
630 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
632 /* Don't need to strlcpy() tag and name anymore, ReadConf() takes const char* */
635 if (!ServerInstance->Config->ConfValue(*this->data, tag, name, default_value, index, result, allow_linefeeds))
637 this->error = CONF_VALUE_NOT_FOUND;
642 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
644 return ReadValue(tag, name, "", index, allow_linefeeds);
647 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
649 return ServerInstance->Config->ConfValueBool(*this->data, tag, name, default_value, index);
652 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
654 return ReadFlag(tag, name, "", index);
658 long ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned)
662 if(!ServerInstance->Config->ConfValueInteger(*this->data, tag, name, default_value, index, result))
664 this->error = CONF_VALUE_NOT_FOUND;
668 if ((needs_unsigned) && (result < 0))
670 this->error = CONF_NOT_UNSIGNED;
677 long ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned)
679 return ReadInteger(tag, name, "", index, needs_unsigned);
682 long ConfigReader::GetError()
684 long olderr = this->error;
689 void ConfigReader::DumpErrors(bool bail, userrec* user)
691 ServerInstance->Config->ReportConfigError(this->errorlog->str(), bail, user);
695 int ConfigReader::Enumerate(const std::string &tag)
697 return ServerInstance->Config->ConfValueEnum(*this->data, tag);
700 int ConfigReader::EnumerateValues(const std::string &tag, int index)
702 return ServerInstance->Config->ConfVarEnum(*this->data, tag, index);
705 bool ConfigReader::Verify()
707 return this->readerror;
711 FileReader::FileReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
714 ServerInstance->Config->ReadFile(c,filename.c_str());
719 FileReader::FileReader(InspIRCd* Instance) : ServerInstance(Instance)
723 std::string FileReader::Contents()
726 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
734 unsigned long FileReader::ContentSize()
736 return this->contentsize;
739 void FileReader::CalcSize()
742 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
743 n += (a->length() + 2);
744 this->contentsize = n;
747 void FileReader::LoadFile(const std::string &filename)
750 ServerInstance->Config->ReadFile(c,filename.c_str());
756 FileReader::~FileReader()
760 bool FileReader::Exists()
762 return (!(fc.size() == 0));
765 std::string FileReader::GetLine(int x)
767 if ((x<0) || ((unsigned)x>fc.size()))
772 int FileReader::FileSize()