1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #include "configreader.h"
24 #include "socketengine.h"
25 #include "command_parse.h"
29 // version is a simple class for holding a modules version number
30 Version::Version(int major, int minor, int revision, int build, int flags, int api_ver)
31 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags), API(api_ver)
35 Request::Request(char* anydata, Module* src, Module* dst)
36 : data(anydata), source(src), dest(dst)
38 /* Ensure that because this module doesnt support ID strings, it doesnt break modules that do
39 * by passing them uninitialized pointers (could happen)
44 Request::Request(Module* src, Module* dst, const char* idstr)
45 : id(idstr), source(src), dest(dst)
49 char* Request::GetData()
54 const char* Request::GetId()
59 Module* Request::GetSource()
64 Module* Request::GetDest()
73 return dest->OnRequest(this);
81 Event::Event(char* anydata, Module* src, const std::string &eventid) : data(anydata), source(src), id(eventid) { };
83 char* Event::GetData()
85 return (char*)this->data;
88 Module* Event::GetSource()
93 char* Event::Send(InspIRCd* ServerInstance)
95 FOREACH_MOD(I_OnEvent,OnEvent(this));
99 std::string Event::GetEventID()
105 // These declarations define the behavours of the base class Module (which does nothing at all)
107 Module::Module(InspIRCd* Me) : ServerInstance(Me) { }
108 Module::~Module() { }
109 void Module::OnUserConnect(userrec* user) { }
110 void Module::OnUserQuit(userrec* user, const std::string& message) { }
111 void Module::OnUserDisconnect(userrec* user) { }
112 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
113 void Module::OnPostJoin(userrec* user, chanrec* channel) { }
114 void Module::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage) { }
115 void Module::OnRehash(const std::string ¶meter) { }
116 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { }
117 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs) { return 0; }
118 void Module::OnMode(userrec* user, void* dest, int target_type, const std::string &text) { };
119 Version Module::GetVersion() { return Version(1,0,0,0,VF_VENDOR,-1); }
120 void Module::OnOper(userrec* user, const std::string &opertype) { };
121 void Module::OnPostOper(userrec* user, const std::string &opertype) { };
122 void Module::OnInfo(userrec* user) { };
123 void Module::OnWhois(userrec* source, userrec* dest) { };
124 int Module::OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel) { return 0; };
125 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list) { return 0; };
126 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list) { return 0; };
127 int Module::OnUserPreNick(userrec* user, const std::string &newnick) { return 0; };
128 void Module::OnUserPostNick(userrec* user, const std::string &oldnick) { };
129 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; };
130 void Module::On005Numeric(std::string &output) { };
131 int Module::OnKill(userrec* source, userrec* dest, const std::string &reason) { return 0; };
132 void Module::OnLoadModule(Module* mod,const std::string &name) { };
133 void Module::OnUnloadModule(Module* mod,const std::string &name) { };
134 void Module::OnBackgroundTimer(time_t curtime) { };
135 int Module::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line) { return 0; };
136 void Module::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line) { };
137 bool Module::OnCheckReady(userrec* user) { return true; };
138 int Module::OnUserRegister(userrec* user) { return 0; };
139 int Module::OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason) { return 0; };
140 void Module::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason) { };
141 int Module::OnCheckInvite(userrec* user, chanrec* chan) { return 0; };
142 int Module::OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven) { return 0; };
143 int Module::OnCheckLimit(userrec* user, chanrec* chan) { return 0; };
144 int Module::OnCheckBan(userrec* user, chanrec* chan) { return 0; };
145 int Module::OnStats(char symbol, userrec* user, string_list &results) { return 0; };
146 int Module::OnChangeLocalUserHost(userrec* user, const std::string &newhost) { return 0; };
147 int Module::OnChangeLocalUserGECOS(userrec* user, const std::string &newhost) { return 0; };
148 int Module::OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic) { return 0; };
149 void Module::OnEvent(Event* event) { return; };
150 char* Module::OnRequest(Request* request) { return NULL; };
151 int Module::OnOperCompare(const std::string &password, const std::string &input, int tagnumber) { return 0; };
152 void Module::OnGlobalOper(userrec* user) { };
153 void Module::OnPostConnect(userrec* user) { };
154 int Module::OnAddBan(userrec* source, chanrec* channel,const std::string &banmask) { return 0; };
155 int Module::OnDelBan(userrec* source, chanrec* channel,const std::string &banmask) { return 0; };
156 void Module::OnRawSocketAccept(int fd, const std::string &ip, int localport) { };
157 int Module::OnRawSocketWrite(int fd, const char* buffer, int count) { return 0; };
158 void Module::OnRawSocketClose(int fd) { };
159 void Module::OnRawSocketConnect(int fd) { };
160 int Module::OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult) { return 0; };
161 void Module::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) { };
162 void Module::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) { };
163 void Module::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason) { };
164 void Module::OnUserInvite(userrec* source,userrec* dest,chanrec* channel) { };
165 void Module::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic) { };
166 void Module::OnGetServerDescription(const std::string &servername,std::string &description) { };
167 void Module::OnSyncUser(userrec* user, Module* proto, void* opaque) { };
168 void Module::OnSyncChannel(chanrec* chan, Module* proto, void* opaque) { };
169 void Module::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline) { };
170 void Module::OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname) { };
171 void Module::OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname) { };
172 void Module::OnSyncOtherMetaData(Module* proto, void* opaque) { };
173 void Module::OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata) { };
174 void Module::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata) { };
175 void Module::OnWallops(userrec* user, const std::string &text) { };
176 void Module::OnChangeHost(userrec* user, const std::string &newhost) { };
177 void Module::OnChangeName(userrec* user, const std::string &gecos) { };
178 void Module::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
179 void Module::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask) { };
180 void Module::OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
181 void Module::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask) { };
182 void Module::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask) { };
183 void Module::OnDelGLine(userrec* source, const std::string &hostmask) { };
184 void Module::OnDelZLine(userrec* source, const std::string &ipmask) { };
185 void Module::OnDelKLine(userrec* source, const std::string &hostmask) { };
186 void Module::OnDelQLine(userrec* source, const std::string &nickmask) { };
187 void Module::OnDelELine(userrec* source, const std::string &hostmask) { };
188 void Module::OnCleanup(int target_type, void* item) { };
189 void Module::Implements(char* Implements) { for (int j = 0; j < 255; j++) Implements[j] = 0; };
190 void Module::OnChannelDelete(chanrec* chan) { };
191 Priority Module::Prioritize() { return PRIORITY_DONTCARE; }
192 void Module::OnSetAway(userrec* user) { };
193 void Module::OnCancelAway(userrec* user) { };
194 int Module::OnUserList(userrec* user, chanrec* Ptr) { return 0; };
195 int Module::OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text) { return 0; };
196 void Module::OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list) { };
198 long InspIRCd::PriorityAfter(const std::string &modulename)
200 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
202 if (this->Config->module_names[j] == modulename)
204 return ((j << 8) | PRIORITY_AFTER);
207 return PRIORITY_DONTCARE;
210 long InspIRCd::PriorityBefore(const std::string &modulename)
212 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
214 if (this->Config->module_names[j] == modulename)
216 return ((j << 8) | PRIORITY_BEFORE);
219 return PRIORITY_DONTCARE;
222 bool InspIRCd::PublishFeature(const std::string &FeatureName, Module* Mod)
224 if (Features.find(FeatureName) == Features.end())
226 Features[FeatureName] = Mod;
232 bool InspIRCd::UnpublishFeature(const std::string &FeatureName)
234 featurelist::iterator iter = Features.find(FeatureName);
236 if (iter == Features.end())
239 Features.erase(iter);
243 Module* InspIRCd::FindFeature(const std::string &FeatureName)
245 featurelist::iterator iter = Features.find(FeatureName);
247 if (iter == Features.end())
253 bool InspIRCd::PublishInterface(const std::string &InterfaceName, Module* Mod)
255 interfacelist::iterator iter = Interfaces.find(InterfaceName);
257 if (iter == Interfaces.end())
261 Interfaces[InterfaceName] = std::make_pair(0, ml);
266 iter->second.second.push_back(Mod);
272 bool InspIRCd::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
274 interfacelist::iterator iter = Interfaces.find(InterfaceName);
276 if (iter == Interfaces.end())
279 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
283 iter->second.second.erase(x);
284 if (iter->second.second.empty())
285 Interfaces.erase(InterfaceName);
292 modulelist* InspIRCd::FindInterface(const std::string &InterfaceName)
294 interfacelist::iterator iter = Interfaces.find(InterfaceName);
295 if (iter == Interfaces.end())
298 return &(iter->second.second);
301 void InspIRCd::UseInterface(const std::string &InterfaceName)
303 interfacelist::iterator iter = Interfaces.find(InterfaceName);
304 if (iter != Interfaces.end())
305 iter->second.first++;
309 void InspIRCd::DoneWithInterface(const std::string &InterfaceName)
311 interfacelist::iterator iter = Interfaces.find(InterfaceName);
312 if (iter != Interfaces.end())
313 iter->second.first--;
316 std::pair<int,std::string> InspIRCd::GetInterfaceInstanceCount(Module* m)
318 for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
320 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
324 return std::make_pair(iter->second.first, iter->first);
328 return std::make_pair(0, "");
331 const std::string& InspIRCd::GetModuleName(Module* m)
333 static std::string nothing = ""; /* Prevent compiler warning */
334 for (int i = 0; i <= this->GetModuleCount(); i++)
336 if (this->modules[i] == m)
338 return this->Config->module_names[i];
341 return nothing; /* As above */
344 void InspIRCd::RehashServer()
346 this->WriteOpers("*** Rehashing config file");
347 this->Config->Read(false,NULL);
350 /* This is ugly, yes, but hash_map's arent designed to be
351 * addressed in this manner, and this is a bit of a kludge.
352 * Luckily its a specialist function and rarely used by
353 * many modules (in fact, it was specially created to make
354 * m_safelist possible, initially).
357 chanrec* InspIRCd::GetChannelIndex(long index)
360 for (chan_hash::iterator n = this->chanlist.begin(); n != this->chanlist.end(); n++, target++)
368 bool InspIRCd::MatchText(const std::string &sliteral, const std::string &spattern)
370 return match(sliteral.c_str(),spattern.c_str());
373 bool InspIRCd::CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user)
375 return this->Parser->CallHandler(commandname,parameters,pcnt,user);
378 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user)
380 return this->Parser->IsValidCommand(commandname, pcnt, user);
383 void InspIRCd::AddCommand(command_t *f)
385 if (!this->Parser->CreateCommand(f))
387 ModuleException err("Command "+std::string(f->command)+" already exists.");
392 void InspIRCd::SendMode(const char** parameters, int pcnt, userrec *user)
394 this->Modes->Process(parameters,pcnt,user,true);
397 void InspIRCd::DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream)
399 std::string CompleteLine = LinePrefix;
400 std::string Word = "";
401 while (TextStream >> Word)
403 if (CompleteLine.length() + Word.length() + 3 > 500)
405 User->WriteServ(CompleteLine);
406 CompleteLine = LinePrefix;
408 CompleteLine = CompleteLine + Word + " ";
410 User->WriteServ(CompleteLine);
413 userrec* InspIRCd::FindDescriptor(int socket)
415 return reinterpret_cast<userrec*>(this->SE->GetRef(socket));
418 bool InspIRCd::AddMode(ModeHandler* mh, const unsigned char mode)
420 return this->Modes->AddMode(mh,mode);
423 bool InspIRCd::AddModeWatcher(ModeWatcher* mw)
425 return this->Modes->AddModeWatcher(mw);
428 bool InspIRCd::DelModeWatcher(ModeWatcher* mw)
430 return this->Modes->DelModeWatcher(mw);
433 bool InspIRCd::AddResolver(Resolver* r)
435 return this->Res->AddResolverClass(r);
438 bool InspIRCd::UserToPseudo(userrec* user, const std::string &message)
440 unsigned int old_fd = user->GetFd();
441 user->Write("ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
442 user->FlushWriteBuf();
444 user->SetFd(FD_MAGIC_NUMBER);
446 if (find(local_users.begin(),local_users.end(),user) != local_users.end())
448 local_users.erase(find(local_users.begin(),local_users.end(),user));
451 this->SE->DelFd(user);
457 bool InspIRCd::PseudoToUser(userrec* alive, userrec* zombie, const std::string &message)
459 zombie->SetFd(alive->GetFd());
460 FOREACH_MOD_I(this,I_OnUserQuit,OnUserQuit(alive,message));
461 alive->SetFd(FD_MAGIC_NUMBER);
462 alive->FlushWriteBuf();
463 alive->ClearBuffer();
464 // save these for later
465 std::string oldnick = alive->nick;
466 std::string oldhost = alive->host;
467 std::string oldident = alive->ident;
468 userrec::QuitUser(this,alive,message.c_str());
469 if (find(local_users.begin(),local_users.end(),alive) != local_users.end())
471 local_users.erase(find(local_users.begin(),local_users.end(),alive));
473 // Fix by brain - cant write the user until their fd table entry is updated
474 zombie->Write(":%s!%s@%s NICK %s",oldnick.c_str(),oldident.c_str(),oldhost.c_str(),zombie->nick);
475 for (UCListIter i = zombie->chans.begin(); i != zombie->chans.end(); i++)
477 chanrec* Ptr = i->first;
478 zombie->WriteFrom(zombie,"JOIN %s",Ptr->name);
481 zombie->WriteServ("332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
482 zombie->WriteServ("333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
484 Ptr->UserList(zombie);
485 zombie->WriteServ("366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
487 if ((find(local_users.begin(),local_users.end(),zombie) == local_users.end()) && (zombie->GetFd() != FD_MAGIC_NUMBER))
488 local_users.push_back(zombie);
492 void InspIRCd::AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
494 XLines->add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
495 XLines->apply_lines(APPLY_GLINES);
498 void InspIRCd::AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname)
500 XLines->add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
501 XLines->apply_lines(APPLY_QLINES);
504 void InspIRCd::AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr)
506 XLines->add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
507 XLines->apply_lines(APPLY_ZLINES);
510 void InspIRCd::AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
512 XLines->add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
513 XLines->apply_lines(APPLY_KLINES);
516 void InspIRCd::AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
518 XLines->add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
521 bool InspIRCd::DelGLine(const std::string &hostmask)
523 return XLines->del_gline(hostmask.c_str());
526 bool InspIRCd::DelQLine(const std::string &nickname)
528 return XLines->del_qline(nickname.c_str());
531 bool InspIRCd::DelZLine(const std::string &ipaddr)
533 return XLines->del_zline(ipaddr.c_str());
536 bool InspIRCd::DelKLine(const std::string &hostmask)
538 return XLines->del_kline(hostmask.c_str());
541 bool InspIRCd::DelELine(const std::string &hostmask)
543 return XLines->del_eline(hostmask.c_str());
547 * XXX why on *earth* is this in modules.cpp...? I think
548 * perhaps we need a server.cpp for InspIRCd:: stuff where possible. -- w00t
550 bool InspIRCd::IsValidMask(const std::string &mask)
552 char* dest = (char*)mask.c_str();
553 if (strchr(dest,'!')==0)
555 if (strchr(dest,'@')==0)
557 for (char* i = dest; *i; i++)
560 for (char* i = dest; *i; i++)
564 for (char* i = dest; *i; i++)
570 for (char* i = dest; *i; i++)
579 Module* InspIRCd::FindModule(const std::string &name)
581 for (int i = 0; i <= this->GetModuleCount(); i++)
583 if (this->Config->module_names[i] == name)
585 return this->modules[i];
591 ConfigReader::ConfigReader(InspIRCd* Instance) : ServerInstance(Instance)
593 /* Is there any reason to load the entire config file again here?
594 * it's needed if they specify another config file, but using the
595 * default one we can just use the global config data - pre-parsed!
597 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
599 this->data = &ServerInstance->Config->config_data;
600 this->privatehash = false;
604 ConfigReader::~ConfigReader()
607 DELETE(this->errorlog);
608 if(this->privatehash)
613 ConfigReader::ConfigReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
615 ServerInstance->Config->ClearStack();
617 this->data = new ConfigDataHash;
618 this->privatehash = true;
619 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
620 this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog);
621 if (!this->readerror)
622 this->error = CONF_FILE_NOT_FOUND;
625 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index)
627 /* Don't need to strlcpy() tag and name anymore, ReadConf() takes const char* */
630 if (!ServerInstance->Config->ConfValue(*this->data, tag, name, index, result))
632 this->error = CONF_VALUE_NOT_FOUND;
639 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
641 return ServerInstance->Config->ConfValueBool(*this->data, tag, name, index);
644 long ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned)
648 if(!ServerInstance->Config->ConfValueInteger(*this->data, tag, name, index, result))
650 this->error = CONF_VALUE_NOT_FOUND;
654 if ((needs_unsigned) && (result < 0))
656 this->error = CONF_NOT_UNSIGNED;
663 long ConfigReader::GetError()
665 long olderr = this->error;
670 void ConfigReader::DumpErrors(bool bail, userrec* user)
672 /* XXX - Duplicated code */
676 printf("There were errors in your configuration:\n%s", this->errorlog->str().c_str());
677 InspIRCd::Exit(ERROR);
681 std::string errors = this->errorlog->str();
682 std::string::size_type start;
683 unsigned int prefixlen;
686 /* ":ServerInstance->Config->ServerName NOTICE user->nick :" */
687 prefixlen = strlen(ServerInstance->Config->ServerName) + strlen(user->nick) + 11;
691 user->WriteServ("NOTICE %s :There were errors in the configuration file:",user->nick);
693 while(start < errors.length())
695 user->WriteServ("NOTICE %s :%s",user->nick, errors.substr(start, 510 - prefixlen).c_str());
696 start += 510 - prefixlen;
701 ServerInstance->WriteOpers("There were errors in the configuration file:");
703 while(start < errors.length())
705 ServerInstance->WriteOpers(errors.substr(start, 360).c_str());
715 int ConfigReader::Enumerate(const std::string &tag)
717 return ServerInstance->Config->ConfValueEnum(*this->data, tag);
720 int ConfigReader::EnumerateValues(const std::string &tag, int index)
722 return ServerInstance->Config->ConfVarEnum(*this->data, tag, index);
725 bool ConfigReader::Verify()
727 return this->readerror;
731 FileReader::FileReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
734 ServerInstance->Config->ReadFile(c,filename.c_str());
739 FileReader::FileReader(InspIRCd* Instance) : ServerInstance(Instance)
743 std::string FileReader::Contents()
746 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
754 unsigned long FileReader::ContentSize()
756 return this->contentsize;
759 void FileReader::CalcSize()
762 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
763 n += (a->length() + 2);
764 this->contentsize = n;
767 void FileReader::LoadFile(const std::string &filename)
770 ServerInstance->Config->ReadFile(c,filename.c_str());
776 FileReader::~FileReader()
780 bool FileReader::Exists()
782 return (!(fc.size() == 0));
785 std::string FileReader::GetLine(int x)
787 if ((x<0) || ((unsigned)x>fc.size()))
792 int FileReader::FileSize()