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 * ---------------------------------------------------
15 /* $CopyInstall: conf/inspircd.quotes.example $(CONPATH) */
16 /* $CopyInstall: conf/inspircd.rules.example $(CONPATH) */
17 /* $CopyInstall: conf/inspircd.motd.example $(CONPATH) */
18 /* $CopyInstall: conf/inspircd.helpop-full.example $(CONPATH) */
19 /* $CopyInstall: conf/inspircd.helpop.example $(CONPATH) */
20 /* $CopyInstall: conf/inspircd.censor.example $(CONPATH) */
21 /* $CopyInstall: conf/inspircd.filter.example $(CONPATH) */
22 /* $CopyInstall: conf/inspircd.conf.example $(CONPATH) */
23 /* $CopyInstall: conf/modules.conf.example $(CONPATH) */
24 /* $CopyInstall: conf/opers.conf.example $(CONPATH) */
25 /* $CopyInstall: conf/links.conf.example $(CONPATH) */
26 /* $CopyInstall: .gdbargs $(BASE) */
31 #include "exitcodes.h"
32 #include "commands/cmd_whowas.h"
33 #include "modes/cmode_h.h"
35 static void ReqRead(ServerConfig* src, const std::string& tag, const std::string& key, std::string& dest)
37 ConfigTag* t = src->ConfValue(tag);
38 if (!t || !t->readString(key, dest))
39 throw CoreException("You must specify a value for <" + tag + ":" + key + ">");
42 /** Represents a deprecated configuration tag.
52 /** Reason for deprecation
57 ServerConfig::ServerConfig()
59 WhoWasGroupSize = WhoWasMaxGroups = WhoWasMaxKeep = 0;
61 NoUserDns = forcedebug = OperSpyWhois = nofork = HideBans = HideSplits = UndernetMsgPrefix = false;
62 CycleHosts = writelog = AllowHalfop = InvBypassModes = true;
63 dns_timeout = DieDelay = 5;
65 NetBufferSize = 10240;
66 SoftLimit = ServerInstance->SE->GetMaxFds();
76 void ServerConfig::Update005()
78 std::stringstream out(data005);
81 int token_counter = 0;
85 line5 = line5 + token + " ";
87 if (token_counter >= 13)
90 snprintf(buf, MAXBUF, "%s:are supported by this server", line5.c_str());
91 isupport.push_back(buf);
99 snprintf(buf, MAXBUF, "%s:are supported by this server", line5.c_str());
100 isupport.push_back(buf);
104 void ServerConfig::Send005(User* user)
106 for (std::vector<std::string>::iterator line = ServerInstance->Config->isupport.begin(); line != ServerInstance->Config->isupport.end(); line++)
107 user->WriteNumeric(RPL_ISUPPORT, "%s %s", user->nick.c_str(), line->c_str());
110 template<typename T, typename V>
111 static void range(T& value, V min, V max, V def, const char* msg)
113 if (value >= (T)min && value <= (T)max)
115 ServerInstance->Logs->Log("CONFIG", DEFAULT,
116 "WARNING: %s value of %ld is not between %ld and %ld; set to %ld.",
117 msg, (long)value, (long)min, (long)max, (long)def);
121 bool ServerConfig::CheckOnce(const char* tag)
124 throw CoreException("You have not defined a <"+std::string(tag)+"> tag, this is required.");
125 if (ConfValue(tag, 1))
126 throw CoreException("You have more than one <"+std::string(tag)+"> tag, this is not permitted.");
130 /* NOTE: Before anyone asks why we're not using inet_pton for this, it is because inet_pton and friends do not return so much detail,
131 * even in strerror(errno). They just return 'yes' or 'no' to an address without such detail as to whats WRONG with the address.
132 * Because ircd users arent as technical as they used to be (;)) we are going to give more of a useful error message.
134 static void ValidIP(const std::string& ip, const std::string& key)
136 const char* p = ip.c_str();
139 int not_numbers = false;
145 throw CoreException("The value of "+key+" is not an IP address");
147 for (const char* ptr = p; *ptr; ++ptr)
149 if (*ptr != ':' && *ptr != '.')
151 if (*ptr < '0' || *ptr > '9')
153 if ((*ptr < '0' || *ptr > '9') && (toupper(*ptr) < 'A' || toupper(*ptr) > 'F'))
159 throw CoreException("The value of "+key+" is not an IP address");
170 throw CoreException("The value of "+key+" is an IPv4 address with too many fields!");
173 throw CoreException("The value of "+key+" is an IPv6 address with too many fields!");
175 if (num_seps == 0 && num_dots < 3)
176 throw CoreException("The value of "+key+" looks to be a malformed IPv4 address");
178 if (num_seps == 0 && num_dots == 3 && not_numbers)
179 throw CoreException("The value of "+key+" contains non-numeric characters in an IPv4 address");
181 if (num_seps != 0 && not_hex)
182 throw CoreException("The value of "+key+" contains non-hexdecimal characters in an IPv6 address");
184 if (num_seps != 0 && num_dots != 3 && num_dots != 0)
185 throw CoreException("The value of "+key+" is a malformed IPv6 4in6 address");
189 static void ValidHost(const std::string& p, const std::string& msg)
192 if (p.empty() || p[0] == '.')
193 throw CoreException("The value of "+msg+" is not a valid hostname");
194 for (unsigned int i=0;i < p.length();i++)
199 throw CoreException("The value of "+msg+" is not a valid hostname");
206 throw CoreException("The value of "+msg+" is not a valid hostname");
209 // Specialized validators
211 bool ServerConfig::ApplyDisabledCommands(const std::string& data)
213 std::stringstream dcmds(data);
216 /* Enable everything first */
217 for (Commandtable::iterator x = ServerInstance->Parser->cmdlist.begin(); x != ServerInstance->Parser->cmdlist.end(); x++)
218 x->second->Disable(false);
220 /* Now disable all the ones which the user wants disabled */
221 while (dcmds >> thiscmd)
223 Commandtable::iterator cm = ServerInstance->Parser->cmdlist.find(thiscmd);
224 if (cm != ServerInstance->Parser->cmdlist.end())
226 cm->second->Disable(true);
233 // Note: the windows validator is in win32wrapper.cpp
234 void ValidateDnsServer(std::string& server);
236 static void ValidateDnsServer(std::string& server)
240 ValidIP(server, "<dns:server>");
244 // attempt to look up their nameserver from /etc/resolv.conf
245 ServerInstance->Logs->Log("CONFIG",DEFAULT,"WARNING: <dns:server> not defined, attempting to find working server in /etc/resolv.conf...");
247 std::ifstream resolv("/etc/resolv.conf");
249 while (resolv >> server)
251 if (server == "nameserver")
254 ServerInstance->Logs->Log("CONFIG",DEFAULT,"<dns:server> set to '%s' as first resolver in /etc/resolv.conf.",server.c_str());
259 ServerInstance->Logs->Log("CONFIG",DEFAULT,"/etc/resolv.conf contains no viable nameserver entries! Defaulting to nameserver '127.0.0.1'!");
260 server = "127.0.0.1";
264 static void ReadXLine(ServerConfig* conf, const std::string& tag, const std::string& key, XLineFactory* make)
268 ConfigTag* ctag = conf->ConfValue(tag, i);
272 if (!ctag->readString(key, mask))
273 throw CoreException("<"+tag+":"+key+"> missing");
274 std::string reason = ctag->getString("reason", "<Config>");
275 XLine* xl = make->Generate(ServerInstance->Time(), 0, "<Config>", reason, mask);
276 if (!ServerInstance->XLines->AddLine(xl, NULL))
281 void ServerConfig::CrossCheckOperClassType()
283 for (int i = 0;; ++i)
285 ConfigTag* tag = ConfValue("class", i);
288 std::string name = tag->getString("name");
290 throw CoreException("<class:name> is required for all <class> tags");
291 operclass[name] = tag;
293 for (int i = 0;; ++i)
295 ConfigTag* tag = ConfValue("type", i);
299 std::string name = tag->getString("name");
301 throw CoreException("<type:name> is required for all <type> tags");
302 opertypes[name] = tag;
304 std::string classname;
305 irc::spacesepstream str(tag->getString("classes"));
306 while (str.GetToken(classname))
308 if (operclass.find(classname) == operclass.end())
309 throw CoreException("Oper type " + name + " has missing class " + classname);
314 void ServerConfig::CrossCheckConnectBlocks(ServerConfig* current)
316 typedef std::map<std::string, ConnectClass*> ClassMap;
317 ClassMap oldBlocksByMask;
320 for(ClassVector::iterator i = current->Classes.begin(); i != current->Classes.end(); ++i)
322 ConnectClass* c = *i;
323 std::string typeMask = (c->type == CC_ALLOW) ? "a" : "d";
325 oldBlocksByMask[typeMask] = c;
329 ClassMap newBlocksByMask;
330 std::map<std::string, int> names;
332 bool try_again = true;
333 for(int tries=0; try_again; tries++)
336 for(unsigned int i=0;; i++)
338 ConfigTag* tag = ConfValue("connect", i);
341 if (Classes.size() <= i)
346 ConnectClass* parent = NULL;
347 std::string parentName = tag->getString("parent");
348 if (!parentName.empty())
350 std::map<std::string,int>::iterator parentIter = names.find(parentName);
351 if (parentIter == names.end())
354 // couldn't find parent this time. If it's the last time, we'll never find it.
356 throw CoreException("Could not find parent connect class \"" + parentName + "\" for connect block " + ConvToStr(i));
359 parent = Classes[parentIter->second];
362 std::string name = tag->getString("name");
365 if (names.find(name) != names.end())
366 throw CoreException("Two connect classes with name \"" + name + "\" defined!");
370 std::string mask, typeMask;
373 if (tag->readString("allow", mask, false))
376 typeMask = 'a' + mask;
378 else if (tag->readString("deny", mask, false))
381 typeMask = 'd' + mask;
385 throw CoreException("Connect class must have an allow or deny mask (#" + ConvToStr(i) + ")");
387 ClassMap::iterator dupMask = newBlocksByMask.find(typeMask);
388 if (dupMask != newBlocksByMask.end())
389 throw CoreException("Two connect classes cannot have the same mask (" + mask + ")");
391 ConnectClass* me = parent ?
392 new ConnectClass(type, mask, *parent) :
393 new ConnectClass(type, mask);
398 tag->readString("password", me->pass);
399 tag->readString("hash", me->hash);
400 me->registration_timeout = tag->getInt("timeout", me->registration_timeout);
401 me->pingtime = tag->getInt("pingfreq", me->pingtime);
403 if (tag->readString("sendq", sendq))
405 // attempt to guess a good hard/soft sendq from a single value
406 long value = atol(sendq.c_str());
408 me->softsendqmax = value / 16;
410 me->softsendqmax = value;
411 me->hardsendqmax = value * 8;
413 me->softsendqmax = tag->getInt("softsendq", me->softsendqmax);
414 me->hardsendqmax = tag->getInt("hardsendq", me->hardsendqmax);
415 me->recvqmax = tag->getInt("recvq", me->recvqmax);
416 me->maxlocal = tag->getInt("localmax", me->maxlocal);
417 me->maxglobal = tag->getInt("globalmax", me->maxglobal);
418 me->port = tag->getInt("port", me->port);
419 me->maxchans = tag->getInt("maxchans", me->maxchans);
420 me->limit = tag->getInt("limit", me->limit);
422 ClassMap::iterator oldMask = oldBlocksByMask.find(typeMask);
423 if (oldMask != oldBlocksByMask.end())
425 ConnectClass* old = oldMask->second;
426 oldBlocksByMask.erase(oldMask);
431 newBlocksByMask[typeMask] = me;
437 static const Deprecated ChangedConfig[] = {
438 {"options", "hidelinks", "has been moved to <security:hidelinks> as of 1.2a3"},
439 {"options", "hidewhois", "has been moved to <security:hidewhois> as of 1.2a3"},
440 {"options", "userstats", "has been moved to <security:userstats> as of 1.2a3"},
441 {"options", "customversion", "has been moved to <security:customversion> as of 1.2a3"},
442 {"options", "hidesplits", "has been moved to <security:hidesplits> as of 1.2a3"},
443 {"options", "hidebans", "has been moved to <security:hidebans> as of 1.2a3"},
444 {"options", "hidekills", "has been moved to <security:hidekills> as of 1.2a3"},
445 {"options", "operspywhois", "has been moved to <security:operspywhois> as of 1.2a3"},
446 {"options", "announceinvites", "has been moved to <security:announceinvites> as of 1.2a3"},
447 {"options", "hidemodes", "has been moved to <security:hidemodes> as of 1.2a3"},
448 {"options", "maxtargets", "has been moved to <security:maxtargets> as of 1.2a3"},
449 {"options", "nouserdns", "has been moved to <performance:nouserdns> as of 1.2a3"},
450 {"options", "maxwho", "has been moved to <performance:maxwho> as of 1.2a3"},
451 {"options", "softlimit", "has been moved to <performance:softlimit> as of 1.2a3"},
452 {"options", "somaxconn", "has been moved to <performance:somaxconn> as of 1.2a3"},
453 {"options", "netbuffersize", "has been moved to <performance:netbuffersize> as of 1.2a3"},
454 {"options", "maxwho", "has been moved to <performance:maxwho> as of 1.2a3"},
455 {"options", "loglevel", "1.2 does not use the loglevel value. Please define <log> tags instead."},
456 {"die", "value", "has always been deprecated"},
459 void ServerConfig::Fill()
461 ReqRead(this, "server", "name", ServerName);
462 ReqRead(this, "power", "diepass", diepass);
463 ReqRead(this, "power", "restartpass", restartpass);
465 ConfigTag* options = ConfValue("options");
466 ConfigTag* security = ConfValue("security");
467 powerhash = ConfValue("power")->getString("hash");
468 DieDelay = ConfValue("power")->getInt("pause");
469 PrefixQuit = options->getString("prefixquit");
470 SuffixQuit = options->getString("suffixquit");
471 FixedQuit = options->getString("fixedquit");
472 PrefixPart = options->getString("prefixpart");
473 SuffixPart = options->getString("suffixpart");
474 FixedPart = options->getString("fixedpart");
475 SoftLimit = ConfValue("performance")->getInt("softlimit", ServerInstance->SE->GetMaxFds());
476 MaxConn = ConfValue("performance")->getInt("somaxconn", SOMAXCONN);
477 MoronBanner = options->getString("moronbanner", "You're banned!");
478 ServerDesc = ConfValue("server")->getString("description", "Configure Me");
479 Network = ConfValue("server")->getString("network", "Network");
480 sid = ConfValue("server")->getString("id", "");
481 AdminName = ConfValue("admin")->getString("name", "");
482 AdminEmail = ConfValue("admin")->getString("email", "null@example.com");
483 AdminNick = ConfValue("admin")->getString("nick", "admin");
484 ModPath = options->getString("moduledir", MOD_PATH);
485 NetBufferSize = ConfValue("performance")->getInt("netbuffersize", 10240);
486 MaxWhoResults = ConfValue("performance")->getInt("maxwho", 1024);
487 DNSServer = ConfValue("dns")->getString("server");
488 dns_timeout = ConfValue("dns")->getInt("timeout", 5);
489 DisabledCommands = ConfValue("disabled")->getString("commands", "");
490 DisabledDontExist = ConfValue("disabled")->getBool("fakenonexistant");
491 SetUser = security->getString("runasuser");
492 SetGroup = security->getString("runasgroup");
493 UserStats = security->getString("userstats");
494 CustomVersion = security->getString("customversion");
495 HideSplits = security->getBool("hidesplits");
496 HideBans = security->getBool("hidebans");
497 HideWhoisServer = security->getString("hidewhois");
498 HideKillsServer = security->getString("hidekills");
499 OperSpyWhois = security->getBool("operspywhois");
500 RestrictBannedUsers = security->getBool("restrictbannedusers");
501 GenericOper = security->getBool("genericoper");
502 NoUserDns = ConfValue("performance")->getBool("nouserdns");
503 SyntaxHints = options->getBool("syntaxhints");
504 CycleHosts = options->getBool("cyclehosts");
505 UndernetMsgPrefix = options->getBool("ircumsgprefix");
506 FullHostInTopic = options->getBool("hostintopic");
507 MaxTargets = security->getInt("maxtargets");
508 DefaultModes = options->getString("defaultmodes");
509 PID = ConfValue("pid")->getString("file");
510 WhoWasGroupSize = ConfValue("whowas")->getInt("groupsize");
511 WhoWasMaxGroups = ConfValue("whowas")->getInt("maxgroups");
512 WhoWasMaxKeep = ServerInstance->Duration(ConfValue("whowas")->getString("maxkeep"));
513 DieValue = ConfValue("die")->getString("value");
514 MaxChans = ConfValue("channels")->getInt("users");
515 OperMaxChans = ConfValue("channels")->getInt("opers");
516 c_ipv4_range = ConfValue("cidr")->getInt("ipv4clone");
517 c_ipv6_range = ConfValue("cidr")->getInt("ipv6clone");
518 Limits.NickMax = ConfValue("limits")->getInt("maxnick");
519 Limits.ChanMax = ConfValue("limits")->getInt("maxchan");
520 Limits.MaxModes = ConfValue("limits")->getInt("maxmodes");
521 Limits.IdentMax = ConfValue("limits")->getInt("maxident");
522 Limits.MaxQuit = ConfValue("limits")->getInt("maxquit");
523 Limits.MaxTopic = ConfValue("limits")->getInt("maxtopic");
524 Limits.MaxKick = ConfValue("limits")->getInt("maxkick");
525 Limits.MaxGecos = ConfValue("limits")->getInt("maxgecos");
526 Limits.MaxAway = ConfValue("limits")->getInt("maxaway");
527 InvBypassModes = options->getBool("invitebypassmodes");
529 ReadFile(MOTD, ConfValue("files")->getString("motd"));
530 ReadFile(RULES, ConfValue("files")->getString("rules"));
531 ValidateDnsServer(DNSServer);
533 range(SoftLimit, 10, ServerInstance->SE->GetMaxFds(), ServerInstance->SE->GetMaxFds(), "<performance:softlimit>");
534 range(MaxConn, 0, SOMAXCONN, SOMAXCONN, "<performance:somaxconn>");
535 range(MaxTargets, 1, 31, 20, "<security:maxtargets>");
536 range(NetBufferSize, 1024, 65534, 10240, "<performance:netbuffersize>");
537 range(MaxWhoResults, 1, 65535, 1024, "<performace:maxwho>");
538 range(WhoWasGroupSize, 0, 10000, 10, "<whowas:groupsize>");
539 range(WhoWasMaxGroups, 0, 1000000, 10240, "<whowas:maxgroups>");
540 range(WhoWasMaxKeep, 3600, INT_MAX, 3600, "<whowas:maxkeep>");
542 ValidHost(ServerName, "<server:name>");
543 if (!sid.empty() && !ServerInstance->IsSID(sid))
544 throw CoreException(sid + " is not a valid server ID. A server ID must be 3 characters long, with the first character a digit and the next two characters a digit or letter.");
546 for (int i = 0;; ++i)
548 ConfigTag* tag = ConfValue("uline", i);
552 if (!tag->readString("server", server))
553 throw CoreException("<uline> tag missing server");
554 ulines[assign(server)] = tag->getBool("silent");
559 ConfigTag* tag = ConfValue("banlist", i);
563 if (!tag->readString("chan", chan))
564 throw CoreException("<banlist> tag missing chan");
565 maxbans[chan] = tag->getInt("limit");
568 ReadXLine(this, "badip", "ipmask", ServerInstance->XLines->GetFactory("Z"));
569 ReadXLine(this, "badnick", "nick", ServerInstance->XLines->GetFactory("Q"));
570 ReadXLine(this, "badhost", "host", ServerInstance->XLines->GetFactory("K"));
571 ReadXLine(this, "exception", "host", ServerInstance->XLines->GetFactory("E"));
573 memset(DisabledUModes, 0, sizeof(DisabledUModes));
574 for (const unsigned char* p = (const unsigned char*)ConfValue("disabled")->getString("usermodes").c_str(); *p; ++p)
576 if (*p < 'A' || *p > ('A' + 64)) throw CoreException(std::string("Invalid usermode ")+(char)*p+" was found.");
577 DisabledUModes[*p - 'A'] = 1;
580 memset(DisabledCModes, 0, sizeof(DisabledCModes));
581 for (const unsigned char* p = (const unsigned char*)ConfValue("disabled")->getString("chanmodes").c_str(); *p; ++p)
583 if (*p < 'A' || *p > ('A' + 64)) throw CoreException(std::string("Invalid chanmode ")+(char)*p+" was found.");
584 DisabledCModes[*p - 'A'] = 1;
587 memset(HideModeLists, 0, sizeof(HideModeLists));
588 for (const unsigned char* p = (const unsigned char*)ConfValue("security")->getString("hidemodes").c_str(); *p; ++p)
589 HideModeLists[*p] = true;
591 std::string v = security->getString("announceinvites");
594 AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_OPS;
596 AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_ALL;
597 else if (v == "dynamic")
598 AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_DYNAMIC;
600 AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_NONE;
602 bool AllowHalfOp = options->getBool("allowhalfop");
603 ModeHandler* mh = ServerInstance->Modes->FindMode('h', MODETYPE_CHANNEL);
604 if (AllowHalfOp && !mh) {
605 ServerInstance->Logs->Log("CONFIG", DEFAULT, "Enabling halfop mode.");
606 mh = new ModeChannelHalfOp;
607 ServerInstance->Modes->AddMode(mh);
608 } else if (!AllowHalfOp && mh) {
609 ServerInstance->Logs->Log("CONFIG", DEFAULT, "Disabling halfop mode.");
610 ServerInstance->Modes->DelMode(mh);
614 Module* whowas = ServerInstance->Modules->Find("cmd_whowas.so");
616 WhowasRequest(NULL, whowas, WhowasRequest::WHOWAS_PRUNE).Send();
621 /* These tags MUST occur and must ONLY occur once in the config file */
622 static const char* const Once[] = { "server", "admin", "files", "power", "options" };
624 // WARNING: it is not safe to use most of the codebase in this function, as it
625 // will run in the config reader thread
626 void ServerConfig::Read()
628 /* Load and parse the config file, if there are any errors then explode */
630 if (!this->DoInclude(ServerInstance->ConfigFileName, true))
637 void ServerConfig::Apply(ServerConfig* old, const std::string &useruid)
640 /* std::ostringstream::clear() does not clear the string itself, only the error flags. */
642 errstr.str().clear();
643 include_stack.clear();
645 /* The stuff in here may throw CoreException, be sure we're in a position to catch it. */
648 /* Check we dont have more than one of singular tags, or any of them missing
650 for (int Index = 0; Index * sizeof(*Once) < sizeof(Once); Index++)
651 CheckOnce(Once[Index]);
653 for (int Index = 0; Index * sizeof(Deprecated) < sizeof(ChangedConfig); Index++)
656 if (ConfValue(ChangedConfig[Index].tag)->readString(ChangedConfig[Index].value, dummy, true))
657 throw CoreException(std::string("Your configuration contains a deprecated value: <") + ChangedConfig[Index].tag + ":" + ChangedConfig[Index].value + "> - " + ChangedConfig[Index].reason);
662 // Handle special items
663 CrossCheckOperClassType();
664 CrossCheckConnectBlocks(old);
666 catch (CoreException &ce)
668 errstr << ce.GetReason();
672 // write once here, to try it out and make sure its ok
673 ServerInstance->WritePID(this->PID);
676 * These values can only be set on boot. Keep their old values. Do it before we send messages so we actually have a servername.
680 this->ServerName = old->ServerName;
681 this->sid = old->sid;
682 this->argv = old->argv;
683 this->argc = old->argc;
685 // Same for ports... they're bound later on first run.
687 ServerInstance->BindPorts(pl);
690 errstr << "Not all your client ports could be bound.\nThe following port(s) failed to bind:\n";
693 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
696 snprintf(buf, MAXBUF, "%d. Address: %s Reason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
702 User* user = useruid.empty() ? NULL : ServerInstance->FindNick(useruid);
704 valid = errstr.str().empty();
706 ServerInstance->Logs->Log("CONFIG",DEFAULT, "There were errors in your configuration file:");
708 while (errstr.good())
711 getline(errstr, line, '\n');
715 user->WriteServ("NOTICE %s :*** %s", user->nick.c_str(), line.c_str());
717 ServerInstance->SNO->WriteGlobalSno('a', line);
722 // Starting up, so print it out so it's seen. XXX this is a bit of a hack.
723 printf("%s\n", line.c_str());
728 errstr.str(std::string());
730 /* No old configuration -> initial boot, nothing more to do here */
735 ServerInstance->Exit(EXIT_STATUS_CONFIG);
741 // If there were errors processing configuration, don't touch modules.
748 void ServerConfig::ApplyModules(User* user)
750 const std::vector<std::string> v = ServerInstance->Modules->GetAllModuleNames(0);
751 std::vector<std::string> added_modules;
752 std::set<std::string> removed_modules(v.begin(), v.end());
756 ConfigTag* tag = ConfValue("module", i);
760 if (tag->readString("name", name))
762 // if this module is already loaded, the erase will succeed, so we need do nothing
763 // otherwise, we need to add the module (which will be done later)
764 if (removed_modules.erase(name) == 0)
765 added_modules.push_back(name);
769 for (std::set<std::string>::iterator removing = removed_modules.begin(); removing != removed_modules.end(); removing++)
771 // Don't remove cmd_*.so, just remove m_*.so
772 if (removing->c_str()[0] == 'c')
774 Module* m = ServerInstance->Modules->Find(*removing);
775 if (m && ServerInstance->Modules->Unload(m))
777 ServerInstance->SNO->WriteGlobalSno('a', "*** REHASH UNLOADED MODULE: %s",removing->c_str());
780 user->WriteNumeric(RPL_UNLOADEDMODULE, "%s %s :Module %s successfully unloaded.",user->nick.c_str(), removing->c_str(), removing->c_str());
782 ServerInstance->SNO->WriteGlobalSno('a', "Module %s successfully unloaded.", removing->c_str());
787 user->WriteNumeric(ERR_CANTUNLOADMODULE, "%s %s :Failed to unload module %s: %s",user->nick.c_str(), removing->c_str(), removing->c_str(), ServerInstance->Modules->LastError().c_str());
789 ServerInstance->SNO->WriteGlobalSno('a', "Failed to unload module %s: %s", removing->c_str(), ServerInstance->Modules->LastError().c_str());
793 for (std::vector<std::string>::iterator adding = added_modules.begin(); adding != added_modules.end(); adding++)
795 if (ServerInstance->Modules->Load(adding->c_str()))
797 ServerInstance->SNO->WriteGlobalSno('a', "*** REHASH LOADED MODULE: %s",adding->c_str());
799 user->WriteNumeric(RPL_LOADEDMODULE, "%s %s :Module %s successfully loaded.",user->nick.c_str(), adding->c_str(), adding->c_str());
801 ServerInstance->SNO->WriteGlobalSno('a', "Module %s successfully loaded.", adding->c_str());
806 user->WriteNumeric(ERR_CANTLOADMODULE, "%s %s :Failed to load module %s: %s",user->nick.c_str(), adding->c_str(), adding->c_str(), ServerInstance->Modules->LastError().c_str());
808 ServerInstance->SNO->WriteGlobalSno('a', "Failed to load module %s: %s", adding->c_str(), ServerInstance->Modules->LastError().c_str());
813 user->WriteServ("NOTICE %s :*** Successfully rehashed server.", user->nick.c_str());
815 ServerInstance->SNO->WriteGlobalSno('a', "*** Successfully rehashed server.");
818 bool ServerConfig::LoadConf(FILE* &conf, const char* filename, bool allowexeinc)
823 long last_successful_parse = 1;
827 int character_count = 0;
833 ServerInstance->Logs->Log("CONFIG", DEBUG, "Reading %s", filename);
835 /* Check if the file open failed first */
838 errstr << "LoadConf: Couldn't open config file: " << filename << std::endl;
842 for (unsigned int t = 0; t < include_stack.size(); t++)
844 if (std::string(filename) == include_stack[t])
846 errstr << "File " << filename << " is included recursively (looped inclusion)." << std::endl;
851 /* It's not already included, add it to the list of files we've loaded */
852 include_stack.push_back(filename);
854 /* Start reading characters... */
855 while ((ch = fgetc(conf)) != EOF)
858 * Fix for moronic windows issue spotted by Adremelech.
859 * Some windows editors save text files as utf-16, which is
860 * a total pain in the ass to parse. Users should save in the
861 * right config format! If we ever see a file where the first
862 * byte is 0xFF or 0xFE, or the second is 0xFF or 0xFE, then
863 * this is most likely a utf-16 file. Bail out and insult user.
865 if ((character_count++ < 2) && (ch == '\xFF' || ch == '\xFE'))
867 errstr << "File " << filename << " cannot be read, as it is encoded in braindead UTF-16. Save your file as plain ASCII!" << std::endl;
872 * Here we try and get individual tags on separate lines,
873 * this would be so easy if we just made people format
874 * their config files like that, but they don't so...
875 * We check for a '<' and then know the line is over when
876 * we get a '>' not inside quotes. If we find two '<' and
877 * no '>' then die with an error.
880 if ((ch == '#') && !in_quote)
901 /* XXX: Added by Brain, May 1st 2006 - Escaping of characters.
902 * Note that this WILL NOT usually allow insertion of newlines,
903 * because a newline is two characters long. Use it primarily to
904 * insert the " symbol.
906 * Note that this also involves a further check when parsing the line,
907 * which can be found below.
909 if ((ch == '\\') && (in_quote) && (in_tag))
915 real_character = fgetc(conf);
916 if (real_character == 'n')
917 real_character = '\n';
918 line += real_character;
923 errstr << "End of file after a \\, what did you want to escape?: " << filename << ":" << linenumber << std::endl;
931 if ((ch != '<') && (!in_tag) && (!in_comment) && (ch > ' ') && (ch != 9))
933 errstr << "You have stray characters beyond the tag which starts at " << filename << ":" << last_successful_parse << std::endl;
943 errstr << "The tag at location " << filename << ":" << last_successful_parse << " was valid, but there is an error in the tag which comes after it. You are possibly missing a \" or >. Please check this." << std::endl;
951 errstr << "Parser error: Inside a quote but not within the last valid tag, which was opened at: " << filename << ":" << last_successful_parse << std::endl;
956 // errstr << "Opening new config tag on line " << linenumber << std::endl;
967 // errstr << "Closing quote in config tag on line " << linenumber << std::endl;
972 // errstr << "Opening quote in config tag on line " << linenumber << std::endl;
980 errstr << "The tag immediately after the one at " << filename << ":" << last_successful_parse << " has a missing closing \" symbol. Please check this." << std::endl;
984 errstr << "You have opened a quote (\") beyond the tag at " << filename << ":" << last_successful_parse << " without opening a new tag. Please check this." << std::endl;
994 // errstr << "Closing config tag on line " << linenumber << std::endl;
998 * If this finds an <include> then ParseLine can simply call
999 * LoadConf() and load the included config into the same ConfigDataHash
1001 long bl = linenumber;
1002 if (!this->ParseLine(filename, line, linenumber, allowexeinc))
1004 last_successful_parse = linenumber;
1012 errstr << "You forgot to close the tag which comes immediately after the one at " << filename << ":" << last_successful_parse << std::endl;
1019 /* Fix for bug #392 - if we reach the end of a file and we are still in a quote or comment, most likely the user fucked up */
1020 if (in_comment || in_quote)
1022 errstr << "Reached end of file whilst still inside a quoted section or tag. This is most likely an error or there \
1023 is a newline missing from the end of the file: " << filename << ":" << linenumber << std::endl;
1030 bool ServerConfig::LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc)
1032 return this->LoadConf(conf, filename.c_str(), allowexeinc);
1035 bool ServerConfig::ParseLine(const std::string &filename, std::string &line, long &linenumber, bool allowexeinc)
1037 std::string tagname;
1038 std::string current_key;
1039 std::string current_value;
1040 reference<ConfigTag> result;
1045 got_key = in_quote = false;
1047 for(std::string::iterator c = line.begin(); c != line.end(); c++)
1051 /* We don't know the tag name yet. */
1057 if ((*c >= 'a' && *c <= 'z') || (*c >= 'A' && *c <='Z') || (*c >= '0' && *c <= '9') || *c == '_')
1061 errstr << "Invalid character in value name of tag: '" << *c << "' in value '" << tagname << "' in filename: " << filename << ":" << linenumber << std::endl;
1068 /* We got to a space, we should have the tagname now. */
1069 if(tagname.length())
1071 result = new ConfigTag(tagname);
1077 /* We have the tag name */
1080 /* We're still reading the key name */
1081 if ((*c != '=') && (*c != '>'))
1085 if ((*c >= 'a' && *c <= 'z') || (*c >= 'A' && *c <='Z') || (*c >= '0' && *c <= '9') || *c == '_')
1089 errstr << "Invalid character in key: '" << *c << "' in key '" << current_key << "' in filename: " << filename << ":" << linenumber << std::endl;
1096 /* We got an '=', end of the key name. */
1102 /* We have the key name, now we're looking for quotes and the value */
1104 /* Correctly handle escaped characters here.
1105 * See the XXX'ed section above.
1107 if ((*c == '\\') && (in_quote))
1111 current_value += '\n';
1113 current_value += *c;
1116 else if ((*c == '\\') && (!in_quote))
1118 errstr << "You can't have an escape sequence outside of a quoted section: " << filename << ":" << linenumber << std::endl;
1121 else if ((*c == '\n') && (in_quote))
1123 /* Got a 'real' \n, treat it as part of the value */
1124 current_value += '\n';
1127 else if ((*c == '\r') && (in_quote))
1129 /* Got a \r, drop it */
1137 /* We're not already in a quote. */
1142 /* Leaving the quotes, we have the current value */
1143 result->items.push_back(KeyVal(current_key, current_value));
1145 // std::cout << "<" << tagname << ":" << current_key << "> " << current_value << std::endl;
1150 if ((tagname == "include") && (current_key == "file"))
1152 if (!this->DoInclude(current_value, allowexeinc))
1155 else if ((tagname == "include") && (current_key == "executable"))
1159 errstr << "Executable includes are not allowed to use <include:executable>\n"
1160 "This could be an attempt to execute commands from a malicious remote include.\n"
1161 "If you need multiple levels of remote include, create a script to assemble the "
1162 "contents locally or include files using <include:file>\n";
1166 /* Pipe an executable and use its stdout as config data */
1167 if (!this->DoPipe(current_value))
1171 current_key.clear();
1172 current_value.clear();
1180 current_value += *c;
1187 /* Finished parsing the tag, add it to the config hash */
1188 config_data.insert(std::make_pair(tagname, result));
1193 bool ServerConfig::DoPipe(const std::string &file)
1195 FILE* conf = popen(file.c_str(), "r");
1200 ret = LoadConf(conf, file.c_str(), false);
1204 errstr << "Couldn't execute: " << file << std::endl;
1209 bool ServerConfig::StartsWithWindowsDriveLetter(const std::string &path)
1211 return (path.length() > 2 && isalpha(path[0]) && path[1] == ':');
1214 bool ServerConfig::DoInclude(const std::string &file, bool allowexeinc)
1216 FILE* conf = fopen(file.c_str(), "r");
1221 ret = LoadConf(conf, file, allowexeinc);
1225 errstr << "Couldn't open config file: " << file << std::endl;
1230 ConfigTag* ServerConfig::ConfValue(const std::string &tag, int offset)
1232 ConfigDataHash::size_type pos = offset;
1233 if (pos >= config_data.count(tag))
1236 ConfigDataHash::iterator iter = config_data.find(tag);
1238 for(int i = 0; i < offset; i++)
1241 return iter->second;
1244 bool ConfigTag::readString(const std::string& key, std::string& value, bool allow_lf)
1248 for(std::vector<KeyVal>::iterator j = items.begin(); j != items.end(); ++j)
1253 if (!allow_lf && (value.find('\n') != std::string::npos))
1255 ServerInstance->Logs->Log("CONFIG",DEFAULT, "Value of <" + tag + ":" + key + "> contains a linefeed, and linefeeds in this value are not permitted -- stripped to spaces.");
1256 for (std::string::iterator n = value.begin(); n != value.end(); n++)
1265 std::string ConfigTag::getString(const std::string& key, const std::string& def)
1267 std::string res = def;
1269 readString(key, res);
1273 long ConfigTag::getInt(const std::string &key, long def)
1276 if(!this || !readString(key, result))
1279 const char* res_cstr = result.c_str();
1280 char* res_tail = NULL;
1281 long res = strtol(res_cstr, &res_tail, 0);
1282 if (res_tail == res_cstr)
1284 switch (toupper(*res_tail))
1290 res= res* 1024 * 1024;
1293 res= res* 1024 * 1024 * 1024;
1299 double ConfigTag::getFloat(const std::string &key, double def)
1302 if (!readString(key, result))
1304 return strtod(result.c_str(), NULL);
1307 bool ConfigTag::getBool(const std::string &key, bool def)
1310 if(!readString(key, result))
1313 return (result == "yes" || result == "true" || result == "1" || result == "on");
1316 /** Read the contents of a file located by `fname' into a file_cache pointed at by `F'.
1318 bool ServerConfig::ReadFile(file_cache &F, const std::string& fname)
1324 char linebuf[MAXBUF];
1328 if (!FileExists(fname.c_str()))
1330 file = fopen(fname.c_str(), "r");
1336 if (fgets(linebuf, sizeof(linebuf), file))
1337 linebuf[strlen(linebuf)-1] = 0;
1341 F.push_back(*linebuf ? linebuf : " ");
1352 bool ServerConfig::FileExists(const char* file)
1355 if (stat(file, &sb) == -1)
1358 if ((sb.st_mode & S_IFDIR) > 0)
1361 FILE *input = fopen(file, "r");
1371 const char* ServerConfig::CleanFilename(const char* name)
1373 const char* p = name + strlen(name);
1374 while ((p != name) && (*p != '/') && (*p != '\\')) p--;
1375 return (p != name ? ++p : p);
1379 std::string ServerConfig::GetSID()
1384 void ConfigReaderThread::Run()
1386 Config = new ServerConfig;
1391 void ConfigReaderThread::Finish()
1393 ServerConfig* old = ServerInstance->Config;
1394 ServerInstance->Logs->Log("CONFIG",DEBUG,"Switching to new configuration...");
1395 ServerInstance->Logs->CloseLogs();
1396 ServerInstance->Config = this->Config;
1397 ServerInstance->Logs->OpenFileLogs();
1398 Config->Apply(old, TheUserUID);
1403 * Apply the changed configuration from the rehash.
1405 * XXX: The order of these is IMPORTANT, do not reorder them without testing
1408 ServerInstance->XLines->CheckELines();
1409 ServerInstance->XLines->CheckELines();
1410 ServerInstance->XLines->ApplyLines();
1411 ServerInstance->Res->Rehash();
1412 ServerInstance->ResetMaxBans();
1413 Config->ApplyDisabledCommands(Config->DisabledCommands);
1414 User* user = TheUserUID.empty() ? ServerInstance->FindNick(TheUserUID) : NULL;
1415 FOREACH_MOD(I_OnRehash, OnRehash(user));
1416 ServerInstance->BuildISupport();
1423 ServerInstance->Logs->CloseLogs();
1424 ServerInstance->Config = old;
1425 ServerInstance->Logs->OpenFileLogs();
1426 delete this->Config;