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, const std::string &oper_message) { }
108 void Module::OnUserDisconnect(userrec* user) { }
109 void Module::OnUserJoin(userrec* user, chanrec* channel, bool &silent) { }
110 void Module::OnPostJoin(userrec* user, chanrec* channel) { }
111 void Module::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent) { }
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, bool &silent) { };
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, bool displayable) { };
168 void Module::OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname, bool displayable) { };
169 void Module::OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable) { };
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, CUList* &userlist) { 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() { };
195 void Module::OnBufferFlushed(userrec* user) { };
197 long InspIRCd::PriorityAfter(const std::string &modulename)
199 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
201 if (this->Config->module_names[j] == modulename)
203 return ((j << 8) | PRIORITY_AFTER);
206 return PRIORITY_DONTCARE;
209 long InspIRCd::PriorityBefore(const std::string &modulename)
211 for (unsigned int j = 0; j < this->Config->module_names.size(); j++)
213 if (this->Config->module_names[j] == modulename)
215 return ((j << 8) | PRIORITY_BEFORE);
218 return PRIORITY_DONTCARE;
221 bool InspIRCd::PublishFeature(const std::string &FeatureName, Module* Mod)
223 if (Features.find(FeatureName) == Features.end())
225 Features[FeatureName] = Mod;
231 bool InspIRCd::UnpublishFeature(const std::string &FeatureName)
233 featurelist::iterator iter = Features.find(FeatureName);
235 if (iter == Features.end())
238 Features.erase(iter);
242 Module* InspIRCd::FindFeature(const std::string &FeatureName)
244 featurelist::iterator iter = Features.find(FeatureName);
246 if (iter == Features.end())
252 bool InspIRCd::PublishInterface(const std::string &InterfaceName, Module* Mod)
254 interfacelist::iterator iter = Interfaces.find(InterfaceName);
256 if (iter == Interfaces.end())
260 Interfaces[InterfaceName] = std::make_pair(0, ml);
265 iter->second.second.push_back(Mod);
271 bool InspIRCd::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
273 interfacelist::iterator iter = Interfaces.find(InterfaceName);
275 if (iter == Interfaces.end())
278 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
282 iter->second.second.erase(x);
283 if (iter->second.second.empty())
284 Interfaces.erase(InterfaceName);
291 modulelist* InspIRCd::FindInterface(const std::string &InterfaceName)
293 interfacelist::iterator iter = Interfaces.find(InterfaceName);
294 if (iter == Interfaces.end())
297 return &(iter->second.second);
300 void InspIRCd::UseInterface(const std::string &InterfaceName)
302 interfacelist::iterator iter = Interfaces.find(InterfaceName);
303 if (iter != Interfaces.end())
304 iter->second.first++;
308 void InspIRCd::DoneWithInterface(const std::string &InterfaceName)
310 interfacelist::iterator iter = Interfaces.find(InterfaceName);
311 if (iter != Interfaces.end())
312 iter->second.first--;
315 std::pair<int,std::string> InspIRCd::GetInterfaceInstanceCount(Module* m)
317 for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
319 for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
323 return std::make_pair(iter->second.first, iter->first);
327 return std::make_pair(0, "");
330 const std::string& InspIRCd::GetModuleName(Module* m)
332 static std::string nothing = ""; /* Prevent compiler warning */
334 if (!this->GetModuleCount())
337 for (int i = 0; i <= this->GetModuleCount(); i++)
339 if (this->modules[i] == m)
341 return this->Config->module_names[i];
344 return nothing; /* As above */
347 void InspIRCd::RehashServer()
349 this->WriteOpers("*** Rehashing config file");
350 this->RehashUsersAndChans();
351 this->Config->Read(false,NULL);
352 this->ResetMaxBans();
356 /* This is ugly, yes, but hash_map's arent designed to be
357 * addressed in this manner, and this is a bit of a kludge.
358 * Luckily its a specialist function and rarely used by
359 * many modules (in fact, it was specially created to make
360 * m_safelist possible, initially).
363 chanrec* InspIRCd::GetChannelIndex(long index)
366 for (chan_hash::iterator n = this->chanlist->begin(); n != this->chanlist->end(); n++, target++)
374 bool InspIRCd::MatchText(const std::string &sliteral, const std::string &spattern)
376 return match(sliteral.c_str(),spattern.c_str());
379 bool InspIRCd::CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user)
381 return this->Parser->CallHandler(commandname,parameters,pcnt,user);
384 bool InspIRCd::IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user)
386 return this->Parser->IsValidCommand(commandname, pcnt, user);
389 void InspIRCd::AddCommand(command_t *f)
391 if (!this->Parser->CreateCommand(f))
393 ModuleException err("Command "+std::string(f->command)+" already exists.");
398 void InspIRCd::SendMode(const char** parameters, int pcnt, userrec *user)
400 this->Modes->Process(parameters,pcnt,user,true);
403 void InspIRCd::DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream)
405 std::string CompleteLine = LinePrefix;
406 std::string Word = "";
407 while (TextStream >> Word)
409 if (CompleteLine.length() + Word.length() + 3 > 500)
411 User->WriteServ(CompleteLine);
412 CompleteLine = LinePrefix;
414 CompleteLine = CompleteLine + Word + " ";
416 User->WriteServ(CompleteLine);
419 userrec* InspIRCd::FindDescriptor(int socket)
421 return reinterpret_cast<userrec*>(this->SE->GetRef(socket));
424 bool InspIRCd::AddMode(ModeHandler* mh, const unsigned char mode)
426 return this->Modes->AddMode(mh,mode);
429 bool InspIRCd::AddModeWatcher(ModeWatcher* mw)
431 return this->Modes->AddModeWatcher(mw);
434 bool InspIRCd::DelModeWatcher(ModeWatcher* mw)
436 return this->Modes->DelModeWatcher(mw);
439 bool InspIRCd::AddResolver(Resolver* r, bool cached)
442 return this->Res->AddResolverClass(r);
445 r->TriggerCachedResult();
451 void InspIRCd::AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
453 XLines->add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
454 XLines->apply_lines(APPLY_GLINES);
457 void InspIRCd::AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname)
459 XLines->add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
460 XLines->apply_lines(APPLY_QLINES);
463 void InspIRCd::AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr)
465 XLines->add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
466 XLines->apply_lines(APPLY_ZLINES);
469 void InspIRCd::AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
471 XLines->add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
472 XLines->apply_lines(APPLY_KLINES);
475 void InspIRCd::AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask)
477 XLines->add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
480 bool InspIRCd::DelGLine(const std::string &hostmask)
482 return XLines->del_gline(hostmask.c_str());
485 bool InspIRCd::DelQLine(const std::string &nickname)
487 return XLines->del_qline(nickname.c_str());
490 bool InspIRCd::DelZLine(const std::string &ipaddr)
492 return XLines->del_zline(ipaddr.c_str());
495 bool InspIRCd::DelKLine(const std::string &hostmask)
497 return XLines->del_kline(hostmask.c_str());
500 bool InspIRCd::DelELine(const std::string &hostmask)
502 return XLines->del_eline(hostmask.c_str());
506 * XXX why on *earth* is this in modules.cpp...? I think
507 * perhaps we need a server.cpp for InspIRCd:: stuff where possible. -- w00t
509 bool InspIRCd::IsValidMask(const std::string &mask)
511 char* dest = (char*)mask.c_str();
512 if (strchr(dest,'!')==0)
514 if (strchr(dest,'@')==0)
516 for (char* i = dest; *i; i++)
519 for (char* i = dest; *i; i++)
523 for (char* i = dest; *i; i++)
529 for (char* i = dest; *i; i++)
538 Module* InspIRCd::FindModule(const std::string &name)
540 for (int i = 0; i <= this->GetModuleCount(); i++)
542 if (this->Config->module_names[i] == name)
544 return this->modules[i];
550 ConfigReader::ConfigReader(InspIRCd* Instance) : ServerInstance(Instance)
552 /* Is there any reason to load the entire config file again here?
553 * it's needed if they specify another config file, but using the
554 * default one we can just use the global config data - pre-parsed!
556 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
558 this->data = &ServerInstance->Config->config_data;
559 this->privatehash = false;
563 ConfigReader::~ConfigReader()
566 DELETE(this->errorlog);
567 if(this->privatehash)
572 ConfigReader::ConfigReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
574 ServerInstance->Config->ClearStack();
576 this->data = new ConfigDataHash;
577 this->privatehash = true;
578 this->errorlog = new std::ostringstream(std::stringstream::in | std::stringstream::out);
579 this->readerror = ServerInstance->Config->LoadConf(*this->data, filename, *this->errorlog);
580 if (!this->readerror)
581 this->error = CONF_FILE_NOT_FOUND;
585 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds)
587 /* Don't need to strlcpy() tag and name anymore, ReadConf() takes const char* */
590 if (!ServerInstance->Config->ConfValue(*this->data, tag, name, default_value, index, result, allow_linefeeds))
592 this->error = CONF_VALUE_NOT_FOUND;
597 std::string ConfigReader::ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds)
599 return ReadValue(tag, name, "", index, allow_linefeeds);
602 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index)
604 return ServerInstance->Config->ConfValueBool(*this->data, tag, name, default_value, index);
607 bool ConfigReader::ReadFlag(const std::string &tag, const std::string &name, int index)
609 return ReadFlag(tag, name, "", index);
613 long ConfigReader::ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned)
617 if(!ServerInstance->Config->ConfValueInteger(*this->data, tag, name, default_value, index, result))
619 this->error = CONF_VALUE_NOT_FOUND;
623 if ((needs_unsigned) && (result < 0))
625 this->error = CONF_NOT_UNSIGNED;
632 long ConfigReader::ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned)
634 return ReadInteger(tag, name, "", index, needs_unsigned);
637 long ConfigReader::GetError()
639 long olderr = this->error;
644 void ConfigReader::DumpErrors(bool bail, userrec* user)
646 ServerInstance->Config->ReportConfigError(this->errorlog->str(), bail, user);
650 int ConfigReader::Enumerate(const std::string &tag)
652 return ServerInstance->Config->ConfValueEnum(*this->data, tag);
655 int ConfigReader::EnumerateValues(const std::string &tag, int index)
657 return ServerInstance->Config->ConfVarEnum(*this->data, tag, index);
660 bool ConfigReader::Verify()
662 return this->readerror;
666 FileReader::FileReader(InspIRCd* Instance, const std::string &filename) : ServerInstance(Instance)
671 FileReader::FileReader(InspIRCd* Instance) : ServerInstance(Instance)
675 std::string FileReader::Contents()
678 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
686 unsigned long FileReader::ContentSize()
688 return this->contentsize;
691 void FileReader::CalcSize()
694 for (file_cache::iterator a = this->fc.begin(); a != this->fc.end(); a++)
695 n += (a->length() + 2);
696 this->contentsize = n;
699 void FileReader::LoadFile(const std::string &filename)
703 if (ServerInstance->Config->ReadFile(c,filename.c_str()))
711 FileReader::~FileReader()
715 bool FileReader::Exists()
717 return (!(fc.size() == 0));
720 std::string FileReader::GetLine(int x)
722 if ((x<0) || ((unsigned)x>fc.size()))
727 int FileReader::FileSize()