1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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 * ---------------------------------------------------
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) */
30 #include "exitcodes.h"
31 #include "commands/cmd_whowas.h"
33 std::vector<std::string> old_module_names, new_module_names, added_modules, removed_modules;
35 /* Needs forward declaration */
36 bool ValidateDnsServer(ServerConfig* conf, const char* tag, const char* value, ValueItem &data);
37 bool DoneELine(ServerConfig* conf, const char* tag);
39 ServerConfig::ServerConfig(InspIRCd* Instance) : ServerInstance(Instance)
42 *sid = *ServerName = *Network = *ServerDesc = *AdminName = '\0';
43 *HideWhoisServer = *AdminEmail = *AdminNick = *diepass = *restartpass = *FixedQuit = *HideKillsServer = '\0';
44 *DefaultModes = *CustomVersion = *motd = *rules = *PrefixQuit = *DieValue = *DNSServer = '\0';
45 *UserStats = *ModPath = *MyExecutable = *DisabledCommands = *PID = *SuffixQuit = '\0';
46 WhoWasGroupSize = WhoWasMaxGroups = WhoWasMaxKeep = 0;
48 NoUserDns = forcedebug = OperSpyWhois = nofork = HideBans = HideSplits = UndernetMsgPrefix = false;
49 CycleHosts = writelog = AllowHalfop = InvBypassModes = true;
50 dns_timeout = DieDelay = 5;
52 NetBufferSize = 10240;
53 SoftLimit = Instance->SE->GetMaxFds();
62 DNSServerValidator = &ValidateDnsServer;
65 void ServerConfig::ClearStack()
67 include_stack.clear();
70 void ServerConfig::Update005()
72 std::stringstream out(data005);
75 int token_counter = 0;
79 line5 = line5 + token + " ";
81 if (token_counter >= 13)
84 snprintf(buf, MAXBUF, "%s:are supported by this server", line5.c_str());
85 isupport.push_back(buf);
93 snprintf(buf, MAXBUF, "%s:are supported by this server", line5.c_str());
94 isupport.push_back(buf);
98 void ServerConfig::Send005(User* user)
100 for (std::vector<std::string>::iterator line = ServerInstance->Config->isupport.begin(); line != ServerInstance->Config->isupport.end(); line++)
101 user->WriteNumeric(RPL_ISUPPORT, "%s %s", user->nick.c_str(), line->c_str());
104 bool ServerConfig::CheckOnce(const char* tag, ConfigDataHash &newconf)
106 int count = ConfValueEnum(newconf, tag);
109 throw CoreException("You have more than one <"+std::string(tag)+"> tag, this is not permitted.");
111 throw CoreException("You have not defined a <"+std::string(tag)+"> tag, this is required.");
115 bool NoValidation(ServerConfig*, const char*, const char*, ValueItem&)
120 bool DoneConfItem(ServerConfig* conf, const char* tag)
125 void ServerConfig::ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val)
127 for (const char* ptr = p; *ptr; ++ptr)
130 throw CoreException("The value of <"+tag+":"+val+"> cannot contain spaces");
134 /* 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,
135 * even in strerror(errno). They just return 'yes' or 'no' to an address without such detail as to whats WRONG with the address.
136 * Because ircd users arent as technical as they used to be (;)) we are going to give more of a useful error message.
138 void ServerConfig::ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild)
142 int not_numbers = false;
148 throw CoreException("The value of <"+tag+":"+val+"> is not an IP address");
150 for (const char* ptr = p; *ptr; ++ptr)
152 if (wild && (*ptr == '*' || *ptr == '?' || *ptr == '/'))
155 if (*ptr != ':' && *ptr != '.')
157 if (*ptr < '0' || *ptr > '9')
159 if ((*ptr < '0' || *ptr > '9') && (toupper(*ptr) < 'A' || toupper(*ptr) > 'F'))
165 throw CoreException("The value of <"+tag+":"+val+"> is not an IP address");
176 throw CoreException("The value of <"+tag+":"+val+"> is an IPv4 address with too many fields!");
179 throw CoreException("The value of <"+tag+":"+val+"> is an IPv6 address with too many fields!");
181 if (num_seps == 0 && num_dots < 3 && !wild)
182 throw CoreException("The value of <"+tag+":"+val+"> looks to be a malformed IPv4 address");
184 if (num_seps == 0 && num_dots == 3 && not_numbers)
185 throw CoreException("The value of <"+tag+":"+val+"> contains non-numeric characters in an IPv4 address");
187 if (num_seps != 0 && not_hex)
188 throw CoreException("The value of <"+tag+":"+val+"> contains non-hexdecimal characters in an IPv6 address");
190 if (num_seps != 0 && num_dots != 3 && num_dots != 0 && !wild)
191 throw CoreException("The value of <"+tag+":"+val+"> is a malformed IPv6 4in6 address");
195 void ServerConfig::ValidateHostname(const char* p, const std::string &tag, const std::string &val)
201 throw CoreException("The value of <"+tag+":"+val+"> is not a valid hostname");
202 for (const char* ptr = p; *ptr; ++ptr)
207 throw CoreException("The value of <"+tag+":"+val+"> is not a valid hostname");
214 throw CoreException("The value of <"+tag+":"+val+"> is not a valid hostname");
218 bool ValidateMaxTargets(ServerConfig* conf, const char*, const char*, ValueItem &data)
220 if ((data.GetInteger() < 0) || (data.GetInteger() > 31))
222 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <security:maxtargets> value is greater than 31 or less than 0, set to 20.");
228 bool ValidateSoftLimit(ServerConfig* conf, const char*, const char*, ValueItem &data)
230 if ((data.GetInteger() < 1) || (data.GetInteger() > conf->GetInstance()->SE->GetMaxFds()))
232 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <performance:softlimit> value is greater than %d or less than 0, set to %d.",conf->GetInstance()->SE->GetMaxFds(),conf->GetInstance()->SE->GetMaxFds());
233 data.Set(conf->GetInstance()->SE->GetMaxFds());
238 bool ValidateMaxConn(ServerConfig* conf, const char*, const char*, ValueItem &data)
240 if (data.GetInteger() > SOMAXCONN)
241 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <performance:somaxconn> value may be higher than the system-defined SOMAXCONN value!");
245 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance)
247 std::stringstream dcmds(data);
250 /* Enable everything first */
251 for (Commandtable::iterator x = ServerInstance->Parser->cmdlist.begin(); x != ServerInstance->Parser->cmdlist.end(); x++)
252 x->second->Disable(false);
254 /* Now disable all the ones which the user wants disabled */
255 while (dcmds >> thiscmd)
257 Commandtable::iterator cm = ServerInstance->Parser->cmdlist.find(thiscmd);
258 if (cm != ServerInstance->Parser->cmdlist.end())
260 cm->second->Disable(true);
266 bool ValidateDisabledUModes(ServerConfig* conf, const char*, const char*, ValueItem &data)
268 memset(conf->DisabledUModes, 0, sizeof(conf->DisabledUModes));
269 for (const unsigned char* p = (const unsigned char*)data.GetString(); *p; ++p)
271 if (*p < 'A' || *p > ('A' + 64)) throw CoreException(std::string("Invalid usermode ")+(char)*p+" was found.");
272 conf->DisabledUModes[*p - 'A'] = 1;
277 bool ValidateDisabledCModes(ServerConfig* conf, const char*, const char*, ValueItem &data)
279 memset(conf->DisabledCModes, 0, sizeof(conf->DisabledCModes));
280 for (const unsigned char* p = (const unsigned char*)data.GetString(); *p; ++p)
282 if (*p < 'A' || *p > ('A' + 64)) throw CoreException(std::string("Invalid chanmode ")+(char)*p+" was found.");
283 conf->DisabledCModes[*p - 'A'] = 1;
288 bool ValidateDnsServer(ServerConfig* conf, const char*, const char*, ValueItem &data)
290 if (!*(data.GetString()))
292 std::string nameserver;
293 // attempt to look up their nameserver from /etc/resolv.conf
294 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <dns:server> not defined, attempting to find working server in /etc/resolv.conf...");
295 std::ifstream resolv("/etc/resolv.conf");
296 bool found_server = false;
298 if (resolv.is_open())
300 while (resolv >> nameserver)
302 if ((nameserver == "nameserver") && (!found_server))
304 resolv >> nameserver;
305 data.Set(nameserver.c_str());
307 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"<dns:server> set to '%s' as first resolver in /etc/resolv.conf.",nameserver.c_str());
313 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"/etc/resolv.conf contains no viable nameserver entries! Defaulting to nameserver '127.0.0.1'!");
314 data.Set("127.0.0.1");
319 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"/etc/resolv.conf can't be opened! Defaulting to nameserver '127.0.0.1'!");
320 data.Set("127.0.0.1");
326 bool ValidateServerName(ServerConfig* conf, const char*, const char*, ValueItem &data)
328 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"Validating server name");
329 /* If we already have a servername, and they changed it, we should throw an exception. */
330 if (!strchr(data.GetString(), '.'))
332 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <server:name> '%s' is not a fully-qualified domain name. Changed to '%s%c'",data.GetString(),data.GetString(),'.');
333 std::string moo = std::string(data.GetString()).append(".");
334 data.Set(moo.c_str());
336 conf->ValidateHostname(data.GetString(), "server", "name");
340 bool ValidateNetBufferSize(ServerConfig* conf, const char*, const char*, ValueItem &data)
342 // 65534 not 65535 because of null terminator
343 if ((!data.GetInteger()) || (data.GetInteger() > 65534) || (data.GetInteger() < 1024))
345 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"No NetBufferSize specified or size out of range, setting to default of 10240.");
351 bool ValidateMaxWho(ServerConfig* conf, const char*, const char*, ValueItem &data)
353 if ((data.GetInteger() > 65535) || (data.GetInteger() < 1))
355 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"<performance:maxwho> size out of range, setting to default of 128.");
361 bool ValidateMotd(ServerConfig* conf, const char*, const char*, ValueItem &data)
363 conf->ReadFile(conf->MOTD, data.GetString());
367 bool ValidateNotEmpty(ServerConfig*, const char* tag, const char* val, ValueItem &data)
369 if (!*data.GetString())
370 throw CoreException(std::string("The value for <")+tag+":"+val+"> cannot be empty!");
374 bool ValidateRules(ServerConfig* conf, const char*, const char*, ValueItem &data)
376 conf->ReadFile(conf->RULES, data.GetString());
380 bool ValidateModeLists(ServerConfig* conf, const char*, const char*, ValueItem &data)
382 memset(conf->HideModeLists, 0, sizeof(conf->HideModeLists));
383 for (const unsigned char* x = (const unsigned char*)data.GetString(); *x; ++x)
384 conf->HideModeLists[*x] = true;
388 bool ValidateExemptChanOps(ServerConfig* conf, const char*, const char*, ValueItem &data)
390 memset(conf->ExemptChanOps, 0, sizeof(conf->ExemptChanOps));
391 for (const unsigned char* x = (const unsigned char*)data.GetString(); *x; ++x)
392 conf->ExemptChanOps[*x] = true;
396 bool ValidateInvite(ServerConfig* conf, const char*, const char*, ValueItem &data)
398 std::string v = data.GetString();
401 conf->AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_OPS;
403 conf->AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_ALL;
404 else if (v == "dynamic")
405 conf->AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_DYNAMIC;
407 conf->AnnounceInvites = ServerConfig::INVITE_ANNOUNCE_NONE;
412 bool ValidateSID(ServerConfig* conf, const char*, const char*, ValueItem &data)
414 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"Validating server id");
416 const char *sid = data.GetString();
418 if (*sid && !conf->GetInstance()->IsSID(sid))
420 throw CoreException(std::string(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.");
423 strlcpy(conf->sid, sid, 5);
428 bool ValidateWhoWas(ServerConfig* conf, const char*, const char*, ValueItem &data)
430 conf->WhoWasMaxKeep = conf->GetInstance()->Duration(data.GetString());
432 if (conf->WhoWasGroupSize < 0)
433 conf->WhoWasGroupSize = 0;
435 if (conf->WhoWasMaxGroups < 0)
436 conf->WhoWasMaxGroups = 0;
438 if (conf->WhoWasMaxKeep < 3600)
440 conf->WhoWasMaxKeep = 3600;
441 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"WARNING: <whowas:maxkeep> value less than 3600, setting to default 3600");
444 Command* whowas_command = conf->GetInstance()->Parser->GetHandler("WHOWAS");
447 std::deque<classbase*> params;
448 whowas_command->HandleInternal(WHOWAS_PRUNE, params);
454 /* Callback called before processing the first <connect> tag
456 bool InitConnect(ServerConfig* conf, const char*)
458 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"Reading connect classes... class list is:");
461 * Remove all connect classes.. we'll reset the pointers in user classes
462 * once all new classes have been read from config.
464 while (conf->Classes.begin() != conf->Classes.end())
466 ConnectClass *c = *(conf->Classes.begin());
467 conf->Classes.erase(conf->Classes.begin());
474 /* Callback called to process a single <connect> tag
476 bool DoConnect(ServerConfig* conf, const char*, char**, ValueList &values, int*)
479 const char* allow = values[0].GetString(); /* Yeah, there are a lot of values. Live with it. */
480 const char* deny = values[1].GetString();
481 const char* password = values[2].GetString();
482 int timeout = values[3].GetInteger();
483 int pingfreq = values[4].GetInteger();
484 int flood = values[5].GetInteger();
485 int threshold = values[6].GetInteger();
486 int sendq = values[7].GetInteger();
487 int recvq = values[8].GetInteger();
488 int localmax = values[9].GetInteger();
489 int globalmax = values[10].GetInteger();
490 int port = values[11].GetInteger();
491 const char* name = values[12].GetString();
492 const char* parent = values[13].GetString();
493 int maxchans = values[14].GetInteger();
494 unsigned long limit = values[15].GetInteger();
495 const char* hashtype = values[16].GetString();
497 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT,"Adding a connect class!");
499 ConnectClass *cc = NULL;
503 /* Find 'parent' and inherit a new class from it,
504 * then overwrite any values that are set here
506 ClassVector::iterator item = conf->Classes.begin();
507 for (; item != conf->Classes.end(); ++item)
510 conf->GetInstance()->Logs->Log("CONFIG",DEBUG,"Class: %s", cc->GetName().c_str());
511 if (cc->GetName() == parent)
513 cc = new ConnectClass(name, cc);
514 cc->Update(timeout, flood, *allow ? allow : deny, pingfreq, password, threshold, sendq, recvq, localmax, globalmax, maxchans, port, limit);
515 conf->Classes.push_back(cc);
519 if (item == conf->Classes.end())
520 throw CoreException("Class name '" + std::string(name) + "' is configured to inherit from class '" + std::string(parent) + "' which cannot be found.");
526 /* Find existing class by mask, the mask should be unique */
527 for (ClassVector::iterator item = conf->Classes.begin(); item != conf->Classes.end(); ++item)
529 if ((*item)->GetHost() == allow)
531 (*item)->Update(timeout, flood, allow, pingfreq, password, threshold, sendq, recvq, localmax, globalmax, maxchans, port, limit);
535 cc = new ConnectClass(name, timeout, flood, allow, pingfreq, password, hashtype, threshold, sendq, recvq, localmax, globalmax, maxchans);
538 conf->Classes.push_back(cc);
542 /* Find existing class by mask, the mask should be unique */
543 for (ClassVector::iterator item = conf->Classes.begin(); item != conf->Classes.end(); ++item)
545 if ((*item)->GetHost() == deny)
547 (*item)->Update(name, deny);
548 (*item)->SetPort(port);
552 cc = new ConnectClass(name, deny);
554 conf->Classes.push_back(cc);
561 /* Callback called when there are no more <connect> tags
563 bool DoneConnect(ServerConfig *conf, const char*)
566 * Update connect classes on all users.
568 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT, "Resetting connect classes for users...");
569 for (std::vector<User*>::iterator n = conf->GetInstance()->Users->local_users.begin(); n != conf->GetInstance()->Users->local_users.end(); n++)
574 * Make their existing class go away so that SetClass doesn't touch a wild ptr, important!
581 * Check that the user falls into a valid class block.. if they don't,
582 * they need to be quit, which CheckClass will do. -- w00t
588 conf->GetInstance()->Logs->Log("CONFIG",DEFAULT, "Done adding connect classes!");
592 /* Callback called before processing the first <uline> tag
594 bool InitULine(ServerConfig* conf, const char*)
596 conf->ulines.clear();
600 /* Callback called to process a single <uline> tag
602 bool DoULine(ServerConfig* conf, const char*, char**, ValueList &values, int*)
604 const char* server = values[0].GetString();
605 const bool silent = values[1].GetBool();
606 conf->ulines[server] = silent;
610 /* Callback called when there are no more <uline> tags
612 bool DoneULine(ServerConfig*, const char*)
617 /* Callback called before processing the first <module> tag
619 bool InitModule(ServerConfig* conf, const char*)
621 old_module_names = conf->GetInstance()->Modules->GetAllModuleNames(0);
622 new_module_names.clear();
623 added_modules.clear();
624 removed_modules.clear();
628 /* Callback called to process a single <module> tag
630 bool DoModule(ServerConfig*, const char*, char**, ValueList &values, int*)
632 const char* modname = values[0].GetString();
633 new_module_names.push_back(modname);
637 /* Callback called when there are no more <module> tags
639 bool DoneModule(ServerConfig*, const char*)
641 // now create a list of new modules that are due to be loaded
642 // and a seperate list of modules which are due to be unloaded
643 for (std::vector<std::string>::iterator _new = new_module_names.begin(); _new != new_module_names.end(); _new++)
647 for (std::vector<std::string>::iterator old = old_module_names.begin(); old != old_module_names.end(); old++)
654 added_modules.push_back(*_new);
657 for (std::vector<std::string>::iterator oldm = old_module_names.begin(); oldm != old_module_names.end(); oldm++)
660 for (std::vector<std::string>::iterator newm = new_module_names.begin(); newm != new_module_names.end(); newm++)
667 removed_modules.push_back(*oldm);
672 /* Callback called before processing the first <banlist> tag
674 bool InitMaxBans(ServerConfig* conf, const char*)
676 conf->maxbans.clear();
680 /* Callback called to process a single <banlist> tag
682 bool DoMaxBans(ServerConfig* conf, const char*, char**, ValueList &values, int*)
684 const char* channel = values[0].GetString();
685 int limit = values[1].GetInteger();
686 conf->maxbans[channel] = limit;
690 /* Callback called when there are no more <banlist> tags.
692 bool DoneMaxBans(ServerConfig*, const char*)
697 void ServerConfig::ReportConfigError(const std::string &errormessage, bool bail, const std::string &useruid)
699 ServerInstance->Logs->Log("CONFIG",DEFAULT, "There were errors in your configuration file: %s", errormessage.c_str());
702 /* Unneeded because of the ServerInstance->Log() aboive? */
703 printf("There were errors in your configuration:\n%s\n\n",errormessage.c_str());
704 ServerInstance->Exit(EXIT_STATUS_CONFIG);
708 std::string errors = errormessage;
709 std::string::size_type start;
710 unsigned int prefixlen;
712 /* ":ServerInstance->Config->ServerName NOTICE user->nick :" */
713 if (!useruid.empty())
715 User* user = ServerInstance->FindNick(useruid);
718 prefixlen = strlen(this->ServerName) + user->nick.length() + 11;
719 user->WriteServ("NOTICE %s :There were errors in the configuration file:",user->nick.c_str());
720 while (start < errors.length())
722 user->WriteServ("NOTICE %s :%s",user->nick.c_str(), errors.substr(start, 510 - prefixlen).c_str());
723 start += 510 - prefixlen;
729 ServerInstance->SNO->WriteToSnoMask('A', "There were errors in the configuration file:");
730 while (start < errors.length())
732 ServerInstance->SNO->WriteToSnoMask('A', errors.substr(start, 360));
740 void ServerConfig::Read(bool bail, const std::string &useruid)
742 int rem = 0, add = 0; /* Number of modules added, number of modules removed */
744 static char maxkeep[MAXBUF]; /* Temporary buffer for WhoWasMaxKeep value */
745 static char hidemodes[MAXBUF]; /* Modes to not allow listing from users below halfop */
746 static char exemptchanops[MAXBUF]; /* Exempt channel ops from these modes */
747 static char announceinvites[MAXBUF]; /* options:announceinvites setting */
748 static char disabledumodes[MAXBUF]; /* Disabled usermodes */
749 static char disabledcmodes[MAXBUF]; /* Disabled chanmodes */
752 include_stack.clear();
754 /* These tags MUST occur and must ONLY occur once in the config file */
755 static const char* Once[] = { "server", "admin", "files", "power", "options", NULL };
757 Deprecated ChangedConfig[] = {
758 {"options", "hidelinks", "has been moved to <security:hidelinks> as of 1.2a3"},
759 {"options", "hidewhois", "has been moved to <security:hidewhois> as of 1.2a3"},
760 {"options", "userstats", "has been moved to <security:userstats> as of 1.2a3"},
761 {"options", "customversion", "has been moved to <security:customversion> as of 1.2a3"},
762 {"options", "hidesplits", "has been moved to <security:hidesplits> as of 1.2a3"},
763 {"options", "hidebans", "has been moved to <security:hidebans> as of 1.2a3"},
764 {"options", "hidekills", "has been moved to <security:hidekills> as of 1.2a3"},
765 {"options", "operspywhois", "has been moved to <security:operspywhois> as of 1.2a3"},
766 {"options", "announceinvites", "has been moved to <security:announceinvites> as of 1.2a3"},
767 {"options", "hidemodes", "has been moved to <security:hidemodes> as of 1.2a3"},
768 {"options", "maxtargets", "has been moved to <security:maxtargets> as of 1.2a3"},
769 {"options", "nouserdns", "has been moved to <performance:nouserdns> as of 1.2a3"},
770 {"options", "maxwho", "has been moved to <performance:maxwho> as of 1.2a3"},
771 {"options", "softlimit", "has been moved to <performance:softlimit> as of 1.2a3"},
772 {"options", "somaxconn", "has been moved to <performance:somaxconn> as of 1.2a3"},
773 {"options", "netbuffersize", "has been moved to <performance:netbuffersize> as of 1.2a3"},
774 {"options", "maxwho", "has been moved to <performance:maxwho> as of 1.2a3"},
775 {"options", "loglevel", "1.2 does not use the loglevel value. Please define <log> tags instead."},
779 /* These tags can occur ONCE or not at all */
780 InitialConfig Values[] = {
781 {"performance", "softlimit", "0", new ValueContainerUInt (&this->SoftLimit), DT_INTEGER, ValidateSoftLimit},
782 {"performance", "somaxconn", SOMAXCONN_S, new ValueContainerInt (&this->MaxConn), DT_INTEGER, ValidateMaxConn},
783 {"options", "moronbanner", "Youre banned!", new ValueContainerChar (this->MoronBanner), DT_CHARPTR, NoValidation},
784 {"server", "name", "", new ValueContainerChar (this->ServerName), DT_HOSTNAME|DT_BOOTONLY, ValidateServerName},
785 {"server", "description", "Configure Me", new ValueContainerChar (this->ServerDesc), DT_CHARPTR, NoValidation},
786 {"server", "network", "Network", new ValueContainerChar (this->Network), DT_NOSPACES, NoValidation},
787 {"server", "id", "", new ValueContainerChar (this->sid), DT_CHARPTR|DT_BOOTONLY, ValidateSID},
788 {"admin", "name", "", new ValueContainerChar (this->AdminName), DT_CHARPTR, NoValidation},
789 {"admin", "email", "Mis@configu.red", new ValueContainerChar (this->AdminEmail), DT_CHARPTR, NoValidation},
790 {"admin", "nick", "Misconfigured", new ValueContainerChar (this->AdminNick), DT_CHARPTR, NoValidation},
791 {"files", "motd", "", new ValueContainerChar (this->motd), DT_CHARPTR, ValidateMotd},
792 {"files", "rules", "", new ValueContainerChar (this->rules), DT_CHARPTR, ValidateRules},
793 {"power", "diepass", "", new ValueContainerChar (this->diepass), DT_CHARPTR, ValidateNotEmpty},
794 {"power", "pause", "", new ValueContainerInt (&this->DieDelay), DT_INTEGER, NoValidation},
795 {"power", "hash", "", new ValueContainerChar (this->powerhash), DT_CHARPTR, NoValidation},
796 {"power", "restartpass", "", new ValueContainerChar (this->restartpass), DT_CHARPTR, ValidateNotEmpty},
797 {"options", "prefixquit", "", new ValueContainerChar (this->PrefixQuit), DT_CHARPTR, NoValidation},
798 {"options", "suffixquit", "", new ValueContainerChar (this->SuffixQuit), DT_CHARPTR, NoValidation},
799 {"options", "fixedquit", "", new ValueContainerChar (this->FixedQuit), DT_CHARPTR, NoValidation},
800 {"options", "prefixpart", "", new ValueContainerChar (this->PrefixPart), DT_CHARPTR, NoValidation},
801 {"options", "suffixpart", "", new ValueContainerChar (this->SuffixPart), DT_CHARPTR, NoValidation},
802 {"options", "fixedpart", "", new ValueContainerChar (this->FixedPart), DT_CHARPTR, NoValidation},
803 {"performance", "netbuffersize","10240", new ValueContainerInt (&this->NetBufferSize), DT_INTEGER, ValidateNetBufferSize},
804 {"performance", "maxwho", "128", new ValueContainerInt (&this->MaxWhoResults), DT_INTEGER, ValidateMaxWho},
805 {"options", "allowhalfop", "0", new ValueContainerBool (&this->AllowHalfop), DT_BOOLEAN, NoValidation},
806 {"dns", "server", "", new ValueContainerChar (this->DNSServer), DT_IPADDRESS,DNSServerValidator},
807 {"dns", "timeout", "5", new ValueContainerInt (&this->dns_timeout), DT_INTEGER, NoValidation},
808 {"options", "moduledir", MOD_PATH, new ValueContainerChar (this->ModPath), DT_CHARPTR, NoValidation},
809 {"disabled", "commands", "", new ValueContainerChar (this->DisabledCommands), DT_CHARPTR, NoValidation},
810 {"disabled", "usermodes", "", new ValueContainerChar (disabledumodes), DT_CHARPTR, ValidateDisabledUModes},
811 {"disabled", "chanmodes", "", new ValueContainerChar (disabledcmodes), DT_CHARPTR, ValidateDisabledCModes},
812 {"disabled", "fakenonexistant", "0", new ValueContainerBool (&this->DisabledDontExist), DT_BOOLEAN, NoValidation},
814 {"security", "runasuser", "", new ValueContainerChar(this->SetUser), DT_CHARPTR, NoValidation},
815 {"security", "runasgroup", "", new ValueContainerChar(this->SetGroup), DT_CHARPTR, NoValidation},
816 {"security", "userstats", "", new ValueContainerChar (this->UserStats), DT_CHARPTR, NoValidation},
817 {"security", "customversion","", new ValueContainerChar (this->CustomVersion), DT_CHARPTR, NoValidation},
818 {"security", "hidesplits", "0", new ValueContainerBool (&this->HideSplits), DT_BOOLEAN, NoValidation},
819 {"security", "hidebans", "0", new ValueContainerBool (&this->HideBans), DT_BOOLEAN, NoValidation},
820 {"security", "hidewhois", "", new ValueContainerChar (this->HideWhoisServer), DT_NOSPACES, NoValidation},
821 {"security", "hidekills", "", new ValueContainerChar (this->HideKillsServer), DT_NOSPACES, NoValidation},
822 {"security", "operspywhois", "0", new ValueContainerBool (&this->OperSpyWhois), DT_BOOLEAN, NoValidation},
823 {"performance", "nouserdns", "0", new ValueContainerBool (&this->NoUserDns), DT_BOOLEAN, NoValidation},
824 {"options", "syntaxhints", "0", new ValueContainerBool (&this->SyntaxHints), DT_BOOLEAN, NoValidation},
825 {"options", "cyclehosts", "0", new ValueContainerBool (&this->CycleHosts), DT_BOOLEAN, NoValidation},
826 {"options", "ircumsgprefix","0", new ValueContainerBool (&this->UndernetMsgPrefix), DT_BOOLEAN, NoValidation},
827 {"security", "announceinvites", "1", new ValueContainerChar (announceinvites), DT_CHARPTR, ValidateInvite},
828 {"options", "hostintopic", "1", new ValueContainerBool (&this->FullHostInTopic), DT_BOOLEAN, NoValidation},
829 {"security", "hidemodes", "", new ValueContainerChar (hidemodes), DT_CHARPTR, ValidateModeLists},
830 {"options", "exemptchanops","", new ValueContainerChar (exemptchanops), DT_CHARPTR, ValidateExemptChanOps},
831 {"security", "maxtargets", "20", new ValueContainerUInt (&this->MaxTargets), DT_INTEGER, ValidateMaxTargets},
832 {"options", "defaultmodes", "nt", new ValueContainerChar (this->DefaultModes), DT_CHARPTR, NoValidation},
833 {"pid", "file", "", new ValueContainerChar (this->PID), DT_CHARPTR, NoValidation},
834 {"whowas", "groupsize", "10", new ValueContainerInt (&this->WhoWasGroupSize), DT_INTEGER, NoValidation},
835 {"whowas", "maxgroups", "10240", new ValueContainerInt (&this->WhoWasMaxGroups), DT_INTEGER, NoValidation},
836 {"whowas", "maxkeep", "3600", new ValueContainerChar (maxkeep), DT_CHARPTR, ValidateWhoWas},
837 {"die", "value", "", new ValueContainerChar (this->DieValue), DT_CHARPTR, NoValidation},
838 {"channels", "users", "20", new ValueContainerUInt (&this->MaxChans), DT_INTEGER, NoValidation},
839 {"channels", "opers", "60", new ValueContainerUInt (&this->OperMaxChans), DT_INTEGER, NoValidation},
840 {"cidr", "ipv4clone", "32", new ValueContainerInt (&this->c_ipv4_range), DT_INTEGER, NoValidation},
841 {"cidr", "ipv6clone", "128", new ValueContainerInt (&this->c_ipv6_range), DT_INTEGER, NoValidation},
842 {"limits", "maxnick", "32", new ValueContainerST (&this->Limits.NickMax), DT_INTEGER, NoValidation},
843 {"limits", "maxchan", "64", new ValueContainerST (&this->Limits.ChanMax), DT_INTEGER, NoValidation},
844 {"limits", "maxmodes", "20", new ValueContainerST (&this->Limits.MaxModes), DT_INTEGER, NoValidation},
845 {"limits", "maxident", "11", new ValueContainerST (&this->Limits.IdentMax), DT_INTEGER, NoValidation},
846 {"limits", "maxquit", "255", new ValueContainerST (&this->Limits.MaxQuit), DT_INTEGER, NoValidation},
847 {"limits", "maxtopic", "307", new ValueContainerST (&this->Limits.MaxTopic), DT_INTEGER, NoValidation},
848 {"limits", "maxkick", "255", new ValueContainerST (&this->Limits.MaxKick), DT_INTEGER, NoValidation},
849 {"limits", "maxgecos", "128", new ValueContainerST (&this->Limits.MaxGecos), DT_INTEGER, NoValidation},
850 {"limits", "maxaway", "200", new ValueContainerST (&this->Limits.MaxAway), DT_INTEGER, NoValidation},
851 {"options", "invitebypassmodes", "1", new ValueContainerBool (&this->InvBypassModes), DT_BOOLEAN, NoValidation},
852 {NULL, NULL, NULL, NULL, DT_NOTHING, NoValidation}
856 /* These tags can occur multiple times, and therefore they have special code to read them
857 * which is different to the code for reading the singular tags listed above.
859 MultiConfig MultiValues[] = {
862 {"allow", "deny", "password", "timeout", "pingfreq", "flood",
863 "threshold", "sendq", "recvq", "localmax", "globalmax", "port",
864 "name", "parent", "maxchans", "limit", "hash",
866 {"", "", "", "", "120", "",
867 "", "", "", "3", "3", "0",
868 "", "", "0", "0", "",
870 {DT_IPADDRESS|DT_ALLOW_WILD,
871 DT_IPADDRESS|DT_ALLOW_WILD,
872 DT_CHARPTR, DT_INTEGER, DT_INTEGER, DT_INTEGER,
873 DT_INTEGER, DT_INTEGER, DT_INTEGER, DT_INTEGER, DT_INTEGER, DT_INTEGER,
874 DT_NOSPACES, DT_NOSPACES, DT_INTEGER, DT_INTEGER, DT_CHARPTR},
875 InitConnect, DoConnect, DoneConnect},
878 {"server", "silent", NULL},
880 {DT_HOSTNAME, DT_BOOLEAN},
881 InitULine,DoULine,DoneULine},
884 {"chan", "limit", NULL},
886 {DT_CHARPTR, DT_INTEGER},
887 InitMaxBans, DoMaxBans, DoneMaxBans},
893 InitModule, DoModule, DoneModule},
896 {"reason", "ipmask", NULL},
897 {"No reason", "", NULL},
898 {DT_CHARPTR, DT_IPADDRESS|DT_ALLOW_WILD},
899 InitXLine, DoZLine, DoneConfItem},
902 {"reason", "nick", NULL},
903 {"No reason", "", NULL},
904 {DT_CHARPTR, DT_CHARPTR},
905 InitXLine, DoQLine, DoneConfItem},
908 {"reason", "host", NULL},
909 {"No reason", "", NULL},
910 {DT_CHARPTR, DT_CHARPTR},
911 InitXLine, DoKLine, DoneConfItem},
914 {"reason", "host", NULL},
915 {"No reason", "", NULL},
916 {DT_CHARPTR, DT_CHARPTR},
917 InitXLine, DoELine, DoneELine},
920 {"name", "classes", NULL},
922 {DT_NOSPACES, DT_CHARPTR},
923 InitTypes, DoType, DoneClassesAndTypes},
926 {"name", "commands", "usermodes", "chanmodes", "privs", NULL},
927 {"", "", "", "", "", NULL},
928 {DT_NOSPACES, DT_CHARPTR, DT_CHARPTR, DT_CHARPTR, DT_CHARPTR},
929 InitClasses, DoClass, DoneClassesAndTypes},
938 /* Load and parse the config file, if there are any errors then explode */
940 /* Make a copy here so if it fails then we can carry on running with an unaffected config */
943 if (!this->DoInclude(newconfig, ServerInstance->ConfigFileName, errstr))
945 ReportConfigError(errstr.str(), bail, useruid);
949 /* The stuff in here may throw CoreException, be sure we're in a position to catch it. */
952 /* Check we dont have more than one of singular tags, or any of them missing
954 for (int Index = 0; Once[Index]; Index++)
955 if (!CheckOnce(Once[Index], newconfig))
958 for (int Index = 0; ChangedConfig[Index].tag; Index++)
962 if (ConfValue(newconfig, ChangedConfig[Index].tag, ChangedConfig[Index].value, "", 0, item, MAXBUF, true) || *item)
963 throw CoreException(std::string("Your configuration contains a deprecated value: <") + ChangedConfig[Index].tag + ":" + ChangedConfig[Index].value + "> - " + ChangedConfig[Index].reason);
966 /* Read the values of all the tags which occur once or not at all, and call their callbacks.
968 for (int Index = 0; Values[Index].tag; ++Index)
971 int dt = Values[Index].datatype;
972 bool allow_newlines = ((dt & DT_ALLOW_NEWLINE) > 0);
973 bool allow_wild = ((dt & DT_ALLOW_WILD) > 0);
974 bool bootonly = ((dt & DT_BOOTONLY) > 0);
975 dt &= ~DT_ALLOW_NEWLINE;
976 dt &= ~DT_ALLOW_WILD;
979 /* Silently ignore boot only values */
980 if (bootonly && !bail)
983 ConfValue(newconfig, Values[Index].tag, Values[Index].value, Values[Index].default_value, 0, item, MAXBUF, allow_newlines);
986 if (!Values[Index].validation_function(this, Values[Index].tag, Values[Index].value, vi))
987 throw CoreException("One or more values in your configuration file failed to validate. Please see your ircd.log for more information.");
989 ServerInstance->Threads->Lock();
994 ValueContainerChar* vcc = (ValueContainerChar*)Values[Index].val;
995 this->ValidateNoSpaces(vi.GetString(), Values[Index].tag, Values[Index].value);
996 vcc->Set(vi.GetString(), strlen(vi.GetString()) + 1);
1001 ValueContainerChar* vcc = (ValueContainerChar*)Values[Index].val;
1002 this->ValidateHostname(vi.GetString(), Values[Index].tag, Values[Index].value);
1003 vcc->Set(vi.GetString(), strlen(vi.GetString()) + 1);
1008 ValueContainerChar* vcc = (ValueContainerChar*)Values[Index].val;
1009 this->ValidateIP(vi.GetString(), Values[Index].tag, Values[Index].value, allow_wild);
1010 vcc->Set(vi.GetString(), strlen(vi.GetString()) + 1);
1015 ValueContainerChar* vcc = (ValueContainerChar*)Values[Index].val;
1016 if (*(vi.GetString()) && !ServerInstance->IsChannel(vi.GetString(), MAXBUF))
1018 ServerInstance->Threads->Unlock();
1019 throw CoreException("The value of <"+std::string(Values[Index].tag)+":"+Values[Index].value+"> is not a valid channel name");
1021 vcc->Set(vi.GetString(), strlen(vi.GetString()) + 1);
1026 ValueContainerChar* vcc = (ValueContainerChar*)Values[Index].val;
1027 /* Make sure we also copy the null terminator */
1028 vcc->Set(vi.GetString(), strlen(vi.GetString()) + 1);
1033 int val = vi.GetInteger();
1034 ValueContainerInt* vci = (ValueContainerInt*)Values[Index].val;
1035 vci->Set(&val, sizeof(int));
1040 bool val = vi.GetBool();
1041 ValueContainerBool* vcb = (ValueContainerBool*)Values[Index].val;
1042 vcb->Set(&val, sizeof(bool));
1046 /* You don't want to know what happens if someones bad code sends us here. */
1049 /* We're done with this now */
1050 delete Values[Index].val;
1051 ServerInstance->Threads->Unlock();
1054 /* Read the multiple-tag items (class tags, connect tags, etc)
1055 * and call the callbacks associated with them. We have three
1056 * callbacks for these, a 'start', 'item' and 'end' callback.
1058 for (int Index = 0; MultiValues[Index].tag; ++Index)
1060 ServerInstance->Threads->Lock();
1061 MultiValues[Index].init_function(this, MultiValues[Index].tag);
1062 ServerInstance->Threads->Unlock();
1064 int number_of_tags = ConfValueEnum(newconfig, MultiValues[Index].tag);
1066 for (int tagnum = 0; tagnum < number_of_tags; ++tagnum)
1069 for (int valuenum = 0; (MultiValues[Index].items[valuenum]) && (valuenum < MAX_VALUES_PER_TAG); ++valuenum)
1071 int dt = MultiValues[Index].datatype[valuenum];
1072 bool allow_newlines = ((dt & DT_ALLOW_NEWLINE) > 0);
1073 bool allow_wild = ((dt & DT_ALLOW_WILD) > 0);
1074 dt &= ~DT_ALLOW_NEWLINE;
1075 dt &= ~DT_ALLOW_WILD;
1077 ServerInstance->Threads->Lock();
1078 /* We catch and rethrow any exception here just so we can free our mutex
1087 if (ConfValue(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item, MAXBUF, allow_newlines))
1088 vl.push_back(ValueItem(item));
1090 vl.push_back(ValueItem(""));
1091 this->ValidateNoSpaces(vl[vl.size()-1].GetString(), MultiValues[Index].tag, MultiValues[Index].items[valuenum]);
1097 if (ConfValue(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item, MAXBUF, allow_newlines))
1098 vl.push_back(ValueItem(item));
1100 vl.push_back(ValueItem(""));
1101 this->ValidateHostname(vl[vl.size()-1].GetString(), MultiValues[Index].tag, MultiValues[Index].items[valuenum]);
1107 if (ConfValue(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item, MAXBUF, allow_newlines))
1108 vl.push_back(ValueItem(item));
1110 vl.push_back(ValueItem(""));
1111 this->ValidateIP(vl[vl.size()-1].GetString(), MultiValues[Index].tag, MultiValues[Index].items[valuenum], allow_wild);
1117 if (ConfValue(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item, MAXBUF, allow_newlines))
1118 vl.push_back(ValueItem(item));
1120 vl.push_back(ValueItem(""));
1121 if (!ServerInstance->IsChannel(vl[vl.size()-1].GetString(), MAXBUF))
1122 throw CoreException("The value of <"+std::string(MultiValues[Index].tag)+":"+MultiValues[Index].items[valuenum]+"> number "+ConvToStr(tagnum + 1)+" is not a valid channel name");
1128 if (ConfValue(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item, MAXBUF, allow_newlines))
1129 vl.push_back(ValueItem(item));
1131 vl.push_back(ValueItem(""));
1137 if (ConfValueInteger(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum, item))
1138 vl.push_back(ValueItem(item));
1140 vl.push_back(ValueItem(0));
1145 bool item = ConfValueBool(newconfig, MultiValues[Index].tag, MultiValues[Index].items[valuenum], MultiValues[Index].items_default[valuenum], tagnum);
1146 vl.push_back(ValueItem(item));
1150 /* Someone was smoking craq if we got here, and we're all gonna die. */
1154 catch (CoreException &e)
1156 ServerInstance->Threads->Unlock();
1159 ServerInstance->Threads->Unlock();
1161 MultiValues[Index].validation_function(this, MultiValues[Index].tag, (char**)MultiValues[Index].items, vl, MultiValues[Index].datatype);
1163 MultiValues[Index].finish_function(this, MultiValues[Index].tag);
1166 /* Finalise the limits, increment them all by one so that we can just put assign(str, 0, val)
1167 * rather than assign(str, 0, val + 1)
1173 catch (CoreException &ce)
1175 ReportConfigError(ce.GetReason(), bail, useruid);
1179 ServerInstance->Threads->Lock();
1180 for (int i = 0; i < ConfValueEnum(newconfig, "type"); ++i)
1182 char item[MAXBUF], classn[MAXBUF], classes[MAXBUF];
1183 std::string classname;
1184 ConfValue(newconfig, "type", "classes", "", i, classes, MAXBUF, false);
1185 irc::spacesepstream str(classes);
1186 ConfValue(newconfig, "type", "name", "", i, item, MAXBUF, false);
1187 while (str.GetToken(classname))
1190 bool foundclass = false;
1191 for (int j = 0; j < ConfValueEnum(newconfig, "class"); ++j)
1193 ConfValue(newconfig, "class", "name", "", j, classn, MAXBUF, false);
1194 if (!strcmp(classn, classname.c_str()))
1202 if (!useruid.empty())
1204 User* user = ServerInstance->FindNick(useruid);
1206 user->WriteServ("NOTICE %s :*** Warning: Oper type '%s' has a missing class named '%s', this does nothing!", user->nick.c_str(), item, classname.c_str());
1211 printf("Warning: Oper type '%s' has a missing class named '%s', this does nothing!\n", item, classname.c_str());
1213 ServerInstance->SNO->WriteToSnoMask('A', "Warning: Oper type '%s' has a missing class named '%s', this does nothing!", item, classname.c_str());
1219 /* If we succeeded, set the ircd config to the new one */
1220 this->config_data = newconfig;
1222 ServerInstance->Threads->Unlock();
1224 // write once here, to try it out and make sure its ok
1225 ServerInstance->WritePID(this->PID);
1227 /* Switch over logfiles */
1228 ServerInstance->Logs->CloseLogs();
1229 ServerInstance->Logs->OpenFileLogs();
1231 ServerInstance->Logs->Log("CONFIG", DEFAULT, "Done reading configuration file.");
1233 /* If we're rehashing, let's load any new modules, and unload old ones
1237 int found_ports = 0;
1239 ServerInstance->BindPorts(false, found_ports, pl);
1241 if (pl.size() && !useruid.empty())
1243 ServerInstance->Threads->Lock();
1244 User* user = ServerInstance->FindNick(useruid);
1247 user->WriteServ("NOTICE %s :*** Not all your client ports could be bound.", user->nick.c_str());
1248 user->WriteServ("NOTICE %s :*** The following port(s) failed to bind:", user->nick.c_str());
1250 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
1252 user->WriteServ("NOTICE %s :*** %d. Address: %s Reason: %s", user->nick.c_str(), j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
1255 ServerInstance->Threads->Unlock();
1258 ServerInstance->Threads->Lock();
1259 if (!removed_modules.empty())
1261 for (std::vector<std::string>::iterator removing = removed_modules.begin(); removing != removed_modules.end(); removing++)
1263 if (ServerInstance->Modules->Unload(removing->c_str()))
1265 ServerInstance->SNO->WriteToSnoMask('A', "*** REHASH UNLOADED MODULE: %s",removing->c_str());
1267 if (!useruid.empty())
1269 User* user = ServerInstance->FindNick(useruid);
1271 user->WriteNumeric(RPL_UNLOADEDMODULE, "%s %s :Module %s successfully unloaded.",user->nick.c_str(), removing->c_str(), removing->c_str());
1274 ServerInstance->SNO->WriteToSnoMask('A', "Module %s successfully unloaded.", removing->c_str());
1280 if (!useruid.empty())
1282 User* user = ServerInstance->FindNick(useruid);
1284 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());
1287 ServerInstance->SNO->WriteToSnoMask('A', "Failed to unload module %s: %s", removing->c_str(), ServerInstance->Modules->LastError().c_str());
1292 if (!added_modules.empty())
1294 for (std::vector<std::string>::iterator adding = added_modules.begin(); adding != added_modules.end(); adding++)
1296 if (ServerInstance->Modules->Load(adding->c_str()))
1298 ServerInstance->SNO->WriteToSnoMask('A', "*** REHASH LOADED MODULE: %s",adding->c_str());
1299 if (!useruid.empty())
1301 User* user = ServerInstance->FindNick(useruid);
1303 user->WriteNumeric(RPL_LOADEDMODULE, "%s %s :Module %s successfully loaded.",user->nick.c_str(), adding->c_str(), adding->c_str());
1306 ServerInstance->SNO->WriteToSnoMask('A', "Module %s successfully loaded.", adding->c_str());
1312 if (!useruid.empty())
1314 User* user = ServerInstance->FindNick(useruid);
1316 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());
1319 ServerInstance->SNO->WriteToSnoMask('A', "Failed to load module %s: %s", adding->c_str(), ServerInstance->Modules->LastError().c_str());
1324 ServerInstance->Logs->Log("CONFIG", DEFAULT, "Successfully unloaded %lu of %lu modules and loaded %lu of %lu modules.",(unsigned long)rem,(unsigned long)removed_modules.size(),(unsigned long)add,(unsigned long)added_modules.size());
1326 ServerInstance->Threads->Unlock();
1332 /** Note: This is safe, the method checks for user == NULL */
1333 ServerInstance->Threads->Lock();
1335 if (!useruid.empty())
1336 user = ServerInstance->FindNick(useruid);
1337 ServerInstance->Parser->SetupCommandTable(user);
1338 ServerInstance->Threads->Unlock();
1342 if (!useruid.empty())
1344 User* user = ServerInstance->FindNick(useruid);
1346 user->WriteServ("NOTICE %s :*** Successfully rehashed server.", user->nick.c_str());
1349 ServerInstance->SNO->WriteToSnoMask('A', "*** Successfully rehashed server.");
1355 bool ServerConfig::LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream)
1359 long linenumber = 1;
1360 long last_successful_parse = 1;
1364 int character_count = 0;
1370 ServerInstance->Logs->Log("CONFIG", DEBUG, "Reading %s", filename);
1372 /* Check if the file open failed first */
1375 errorstream << "LoadConf: Couldn't open config file: " << filename << std::endl;
1379 for (unsigned int t = 0; t < include_stack.size(); t++)
1381 if (std::string(filename) == include_stack[t])
1383 errorstream << "File " << filename << " is included recursively (looped inclusion)." << std::endl;
1388 /* It's not already included, add it to the list of files we've loaded */
1389 include_stack.push_back(filename);
1391 /* Start reading characters... */
1392 while ((ch = fgetc(conf)) != EOF)
1395 * Fix for moronic windows issue spotted by Adremelech.
1396 * Some windows editors save text files as utf-16, which is
1397 * a total pain in the ass to parse. Users should save in the
1398 * right config format! If we ever see a file where the first
1399 * byte is 0xFF or 0xFE, or the second is 0xFF or 0xFE, then
1400 * this is most likely a utf-16 file. Bail out and insult user.
1402 if ((character_count++ < 2) && (ch == '\xFF' || ch == '\xFE'))
1404 errorstream << "File " << filename << " cannot be read, as it is encoded in braindead UTF-16. Save your file as plain ASCII!" << std::endl;
1409 * Here we try and get individual tags on separate lines,
1410 * this would be so easy if we just made people format
1411 * their config files like that, but they don't so...
1412 * We check for a '<' and then know the line is over when
1413 * we get a '>' not inside quotes. If we find two '<' and
1414 * no '>' then die with an error.
1417 if ((ch == '#') && !in_quote)
1438 /* XXX: Added by Brain, May 1st 2006 - Escaping of characters.
1439 * Note that this WILL NOT usually allow insertion of newlines,
1440 * because a newline is two characters long. Use it primarily to
1441 * insert the " symbol.
1443 * Note that this also involves a further check when parsing the line,
1444 * which can be found below.
1446 if ((ch == '\\') && (in_quote) && (in_tag))
1449 char real_character;
1452 real_character = fgetc(conf);
1453 if (real_character == 'n')
1454 real_character = '\n';
1455 line += real_character;
1460 errorstream << "End of file after a \\, what did you want to escape?: " << filename << ":" << linenumber << std::endl;
1468 if ((ch != '<') && (!in_tag) && (!in_comment) && (ch > ' ') && (ch != 9))
1470 errorstream << "You have stray characters beyond the tag which starts at " << filename << ":" << last_successful_parse << std::endl;
1480 errorstream << "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;
1488 errorstream << "Parser error: Inside a quote but not within the last valid tag, which was opened at: " << filename << ":" << last_successful_parse << std::endl;
1493 // errorstream << "Opening new config tag on line " << linenumber << std::endl;
1504 // errorstream << "Closing quote in config tag on line " << linenumber << std::endl;
1509 // errorstream << "Opening quote in config tag on line " << linenumber << std::endl;
1517 errorstream << "The tag immediately after the one at " << filename << ":" << last_successful_parse << " has a missing closing \" symbol. Please check this." << std::endl;
1521 errorstream << "You have opened a quote (\") beyond the tag at " << filename << ":" << last_successful_parse << " without opening a new tag. Please check this." << std::endl;
1531 // errorstream << "Closing config tag on line " << linenumber << std::endl;
1535 * If this finds an <include> then ParseLine can simply call
1536 * LoadConf() and load the included config into the same ConfigDataHash
1538 long bl = linenumber;
1539 if (!this->ParseLine(target, filename, line, linenumber, errorstream))
1541 last_successful_parse = linenumber;
1549 errorstream << "You forgot to close the tag which comes immediately after the one at " << filename << ":" << last_successful_parse << std::endl;
1556 /* 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 */
1557 if (in_comment || in_quote)
1559 errorstream << "Reached end of file whilst still inside a quoted section or tag. This is most likely an error or there \
1560 is a newline missing from the end of the file: " << filename << ":" << linenumber << std::endl;
1567 bool ServerConfig::LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream)
1569 return this->LoadConf(target, conf, filename.c_str(), errorstream);
1572 bool ServerConfig::ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream)
1574 std::string tagname;
1575 std::string current_key;
1576 std::string current_value;
1583 got_name = got_key = in_quote = false;
1585 for(std::string::iterator c = line.begin(); c != line.end(); c++)
1589 /* We don't know the tag name yet. */
1595 if ((*c >= 'a' && *c <= 'z') || (*c >= 'A' && *c <='Z') || (*c >= '0' && *c <= '9') || *c == '_')
1599 errorstream << "Invalid character in value name of tag: '" << *c << "' in value '" << tagname << "' in filename: " << filename << ":" << linenumber << std::endl;
1606 /* We got to a space, we should have the tagname now. */
1607 if(tagname.length())
1615 /* We have the tag name */
1618 /* We're still reading the key name */
1619 if ((*c != '=') && (*c != '>'))
1623 if ((*c >= 'a' && *c <= 'z') || (*c >= 'A' && *c <='Z') || (*c >= '0' && *c <= '9') || *c == '_')
1627 errorstream << "Invalid character in key: '" << *c << "' in key '" << current_key << "' in filename: " << filename << ":" << linenumber << std::endl;
1634 /* We got an '=', end of the key name. */
1640 /* We have the key name, now we're looking for quotes and the value */
1642 /* Correctly handle escaped characters here.
1643 * See the XXX'ed section above.
1645 if ((*c == '\\') && (in_quote))
1649 current_value += '\n';
1651 current_value += *c;
1654 else if ((*c == '\\') && (!in_quote))
1656 errorstream << "You can't have an escape sequence outside of a quoted section: " << filename << ":" << linenumber << std::endl;
1659 else if ((*c == '\n') && (in_quote))
1661 /* Got a 'real' \n, treat it as part of the value */
1662 current_value += '\n';
1665 else if ((*c == '\r') && (in_quote))
1667 /* Got a \r, drop it */
1675 /* We're not already in a quote. */
1680 /* Leaving the quotes, we have the current value */
1681 results.push_back(KeyVal(current_key, current_value));
1683 // std::cout << "<" << tagname << ":" << current_key << "> " << current_value << std::endl;
1688 if ((tagname == "include") && (current_key == "file"))
1690 if (!this->DoInclude(target, current_value, errorstream))
1693 else if ((tagname == "include") && (current_key == "executable"))
1695 /* Pipe an executable and use its stdout as config data */
1696 if (!this->DoPipe(target, current_value, errorstream))
1700 current_key.clear();
1701 current_value.clear();
1709 current_value += *c;
1716 /* Finished parsing the tag, add it to the config hash */
1717 target.insert(std::pair<std::string, KeyValList > (tagname, results));
1722 bool ServerConfig::DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream)
1724 FILE* conf = popen(file.c_str(), "r");
1729 ret = LoadConf(target, conf, file.c_str(), errorstream);
1733 errorstream << "Couldn't execute: " << file << std::endl;
1738 bool ServerConfig::StartsWithWindowsDriveLetter(const std::string &path)
1740 return (path.length() > 2 && isalpha(path[0]) && path[1] == ':');
1743 bool ServerConfig::DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream)
1745 std::string confpath;
1746 std::string newfile;
1747 std::string::size_type pos;
1749 confpath = ServerInstance->ConfigFileName;
1752 std::replace(newfile.begin(),newfile.end(),'\\','/');
1753 std::replace(confpath.begin(),confpath.end(),'\\','/');
1755 if ((newfile[0] != '/') && (!StartsWithWindowsDriveLetter(newfile)))
1757 if((pos = confpath.rfind("/")) != std::string::npos)
1759 /* Leaves us with just the path */
1760 newfile = confpath.substr(0, pos) + std::string("/") + newfile;
1764 errorstream << "Couldn't get config path from: " << ServerInstance->ConfigFileName << std::endl;
1769 FILE* conf = fopen(newfile.c_str(), "r");
1774 ret = LoadConf(target, conf, newfile, errorstream);
1778 errorstream << "Couldn't open config file: " << file << std::endl;
1783 bool ServerConfig::ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds)
1785 return ConfValue(target, tag, var, "", index, result, length, allow_linefeeds);
1788 bool ServerConfig::ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds)
1791 bool r = ConfValue(target, std::string(tag), std::string(var), std::string(default_value), index, value, allow_linefeeds);
1792 strlcpy(result, value.c_str(), length);
1796 bool ServerConfig::ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds)
1798 return ConfValue(target, tag, var, "", index, result, allow_linefeeds);
1801 bool ServerConfig::ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds)
1803 ConfigDataHash::size_type pos = index;
1804 if (pos < target.count(tag))
1806 ConfigDataHash::iterator iter = target.find(tag);
1808 for(int i = 0; i < index; i++)
1811 for(KeyValList::iterator j = iter->second.begin(); j != iter->second.end(); j++)
1815 if ((!allow_linefeeds) && (j->second.find('\n') != std::string::npos))
1817 ServerInstance->Logs->Log("CONFIG",DEFAULT, "Value of <" + tag + ":" + var+ "> contains a linefeed, and linefeeds in this value are not permitted -- stripped to spaces.");
1818 for (std::string::iterator n = j->second.begin(); n != j->second.end(); n++)
1829 if (!default_value.empty())
1831 result = default_value;
1837 if (!default_value.empty())
1839 result = default_value;
1846 bool ServerConfig::ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result)
1848 return ConfValueInteger(target, std::string(tag), std::string(var), "", index, result);
1851 bool ServerConfig::ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result)
1853 return ConfValueInteger(target, std::string(tag), std::string(var), std::string(default_value), index, result);
1856 bool ServerConfig::ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result)
1858 return ConfValueInteger(target, tag, var, "", index, result);
1861 bool ServerConfig::ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result)
1864 std::istringstream stream;
1865 bool r = ConfValue(target, tag, var, default_value, index, value);
1867 if(!(stream >> result))
1873 if (value.substr(0,2) == "0x")
1878 result = strtol(value.c_str(), &endptr, 16);
1880 /* No digits found */
1881 if (endptr == value.c_str())
1886 char denominator = *(value.end() - 1);
1887 switch (toupper(denominator))
1890 /* Kilobytes -> bytes */
1891 result = result * 1024;
1894 /* Megabytes -> bytes */
1895 result = result * 1024 * 1024;
1898 /* Gigabytes -> bytes */
1899 result = result * 1024 * 1024 * 1024;
1909 bool ServerConfig::ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index)
1911 return ConfValueBool(target, std::string(tag), std::string(var), "", index);
1914 bool ServerConfig::ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index)
1916 return ConfValueBool(target, std::string(tag), std::string(var), std::string(default_value), index);
1919 bool ServerConfig::ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index)
1921 return ConfValueBool(target, tag, var, "", index);
1924 bool ServerConfig::ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index)
1927 if(!ConfValue(target, tag, var, default_value, index, result))
1930 return ((result == "yes") || (result == "true") || (result == "1"));
1933 int ServerConfig::ConfValueEnum(ConfigDataHash &target, const char* tag)
1935 return target.count(tag);
1938 int ServerConfig::ConfValueEnum(ConfigDataHash &target, const std::string &tag)
1940 return target.count(tag);
1943 int ServerConfig::ConfVarEnum(ConfigDataHash &target, const char* tag, int index)
1945 return ConfVarEnum(target, std::string(tag), index);
1948 int ServerConfig::ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index)
1950 ConfigDataHash::size_type pos = index;
1952 if (pos < target.count(tag))
1954 ConfigDataHash::const_iterator iter = target.find(tag);
1956 for(int i = 0; i < index; i++)
1959 return iter->second.size();
1965 /** Read the contents of a file located by `fname' into a file_cache pointed at by `F'.
1967 bool ServerConfig::ReadFile(file_cache &F, const char* fname)
1969 if (!fname || !*fname)
1973 char linebuf[MAXBUF];
1977 if ((*fname != '/') && (*fname != '\\') && (!StartsWithWindowsDriveLetter(fname)))
1979 std::string::size_type pos;
1980 std::string confpath = ServerInstance->ConfigFileName;
1981 std::string newfile = fname;
1983 if (((pos = confpath.rfind("/"))) != std::string::npos)
1984 newfile = confpath.substr(0, pos) + std::string("/") + fname;
1985 else if (((pos = confpath.rfind("\\"))) != std::string::npos)
1986 newfile = confpath.substr(0, pos) + std::string("\\") + fname;
1988 ServerInstance->Logs->Log("config", DEBUG, "Filename: %s", newfile.c_str());
1990 if (!FileExists(newfile.c_str()))
1992 file = fopen(newfile.c_str(), "r");
1996 if (!FileExists(fname))
1998 file = fopen(fname, "r");
2005 if (fgets(linebuf, sizeof(linebuf), file))
2006 linebuf[strlen(linebuf)-1] = 0;
2010 F.push_back(*linebuf ? linebuf : " ");
2021 bool ServerConfig::FileExists(const char* file)
2024 if (stat(file, &sb) == -1)
2027 if ((sb.st_mode & S_IFDIR) > 0)
2031 if ((input = fopen (file, "r")) == NULL)
2040 char* ServerConfig::CleanFilename(char* name)
2042 char* p = name + strlen(name);
2043 while ((p != name) && (*p != '/') && (*p != '\\')) p--;
2044 return (p != name ? ++p : p);
2048 bool ServerConfig::DirValid(const char* dirandfile)
2056 char otherdir[1024];
2059 strlcpy(work, dirandfile, 1024);
2062 // we just want the dir
2074 // Get the current working directory
2075 if (getcwd(buffer, 1024 ) == NULL )
2078 if (chdir(work) == -1)
2081 if (getcwd(otherdir, 1024 ) == NULL )
2084 if (chdir(buffer) == -1)
2087 size_t t = strlen(work);
2089 if (strlen(otherdir) >= t)
2092 if (!strcmp(otherdir,work))
2106 std::string ServerConfig::GetFullProgDir()
2108 char buffer[PATH_MAX];
2110 /* Windows has specific api calls to get the exe path that never fail.
2111 * For once, windows has something of use, compared to the POSIX code
2112 * for this, this is positively neato.
2114 if (GetModuleFileName(NULL, buffer, MAX_PATH))
2116 std::string fullpath = buffer;
2117 std::string::size_type n = fullpath.rfind("\\inspircd.exe");
2118 return std::string(fullpath, 0, n);
2121 // Get the current working directory
2122 if (getcwd(buffer, PATH_MAX))
2124 std::string remainder = this->argv[0];
2126 /* Does argv[0] start with /? its a full path, use it */
2127 if (remainder[0] == '/')
2129 std::string::size_type n = remainder.rfind("/inspircd");
2130 return std::string(remainder, 0, n);
2133 std::string fullpath = std::string(buffer) + "/" + remainder;
2134 std::string::size_type n = fullpath.rfind("/inspircd");
2135 return std::string(fullpath, 0, n);
2141 InspIRCd* ServerConfig::GetInstance()
2143 return ServerInstance;
2146 std::string ServerConfig::GetSID()
2151 ValueItem::ValueItem(int value)
2153 std::stringstream n;
2158 ValueItem::ValueItem(bool value)
2160 std::stringstream n;
2165 ValueItem::ValueItem(const char* value)
2170 void ValueItem::Set(const char* value)
2175 void ValueItem::Set(int value)
2177 std::stringstream n;
2182 int ValueItem::GetInteger()
2186 return atoi(v.c_str());
2189 char* ValueItem::GetString()
2191 return (char*)v.c_str();
2194 bool ValueItem::GetBool()
2196 return (GetInteger() || v == "yes" || v == "true");
2203 * XXX should this be in a class? -- w00t
2205 bool InitTypes(ServerConfig* conf, const char*)
2207 if (conf->opertypes.size())
2209 for (opertype_t::iterator n = conf->opertypes.begin(); n != conf->opertypes.end(); n++)
2216 conf->opertypes.clear();
2221 * XXX should this be in a class? -- w00t
2223 bool InitClasses(ServerConfig* conf, const char*)
2225 if (conf->operclass.size())
2227 for (operclass_t::iterator n = conf->operclass.begin(); n != conf->operclass.end(); n++)
2229 if (n->second.commandlist)
2230 delete[] n->second.commandlist;
2231 if (n->second.cmodelist)
2232 delete[] n->second.cmodelist;
2233 if (n->second.umodelist)
2234 delete[] n->second.umodelist;
2235 if (n->second.privs)
2236 delete[] n->second.privs;
2240 conf->operclass.clear();
2245 * XXX should this be in a class? -- w00t
2247 bool DoType(ServerConfig* conf, const char*, char**, ValueList &values, int*)
2249 const char* TypeName = values[0].GetString();
2250 const char* Classes = values[1].GetString();
2252 conf->opertypes[TypeName] = strnewdup(Classes);
2257 * XXX should this be in a class? -- w00t
2259 bool DoClass(ServerConfig* conf, const char* tag, char**, ValueList &values, int*)
2261 const char* ClassName = values[0].GetString();
2262 const char* CommandList = values[1].GetString();
2263 const char* UModeList = values[2].GetString();
2264 const char* CModeList = values[3].GetString();
2265 const char *PrivsList = values[4].GetString();
2267 for (const char* c = UModeList; *c; ++c)
2269 if ((*c < 'A' || *c > 'z') && *c != '*')
2271 throw CoreException("Character " + std::string(1, *c) + " is not a valid mode in <class:usermodes>");
2274 for (const char* c = CModeList; *c; ++c)
2276 if ((*c < 'A' || *c > 'z') && *c != '*')
2278 throw CoreException("Character " + std::string(1, *c) + " is not a valid mode in <class:chanmodes>");
2282 conf->operclass[ClassName].commandlist = strnewdup(CommandList);
2283 conf->operclass[ClassName].umodelist = strnewdup(UModeList);
2284 conf->operclass[ClassName].cmodelist = strnewdup(CModeList);
2285 conf->operclass[ClassName].privs = strnewdup(PrivsList);
2290 * XXX should this be in a class? -- w00t
2292 bool DoneClassesAndTypes(ServerConfig*, const char*)
2299 bool InitXLine(ServerConfig* conf, const char* tag)
2304 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
2306 const char* reason = values[0].GetString();
2307 const char* ipmask = values[1].GetString();
2309 ZLine* zl = new ZLine(conf->GetInstance(), conf->GetInstance()->Time(), 0, "<Config>", reason, ipmask);
2310 if (!conf->GetInstance()->XLines->AddLine(zl, NULL))
2316 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
2318 const char* reason = values[0].GetString();
2319 const char* nick = values[1].GetString();
2321 QLine* ql = new QLine(conf->GetInstance(), conf->GetInstance()->Time(), 0, "<Config>", reason, nick);
2322 if (!conf->GetInstance()->XLines->AddLine(ql, NULL))
2328 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
2330 const char* reason = values[0].GetString();
2331 const char* host = values[1].GetString();
2333 XLineManager* xlm = conf->GetInstance()->XLines;
2335 IdentHostPair ih = xlm->IdentSplit(host);
2337 KLine* kl = new KLine(conf->GetInstance(), conf->GetInstance()->Time(), 0, "<Config>", reason, ih.first.c_str(), ih.second.c_str());
2338 if (!xlm->AddLine(kl, NULL))
2343 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
2345 const char* reason = values[0].GetString();
2346 const char* host = values[1].GetString();
2348 XLineManager* xlm = conf->GetInstance()->XLines;
2350 IdentHostPair ih = xlm->IdentSplit(host);
2352 ELine* el = new ELine(conf->GetInstance(), conf->GetInstance()->Time(), 0, "<Config>", reason, ih.first.c_str(), ih.second.c_str());
2353 if (!xlm->AddLine(el, NULL))
2358 // this should probably be moved to configreader, but atm it relies on CheckELines above.
2359 bool DoneELine(ServerConfig* conf, const char* tag)
2361 for (std::vector<User*>::const_iterator u2 = conf->GetInstance()->Users->local_users.begin(); u2 != conf->GetInstance()->Users->local_users.end(); u2++)
2363 User* u = (User*)(*u2);
2367 conf->GetInstance()->XLines->CheckELines();
2371 void ConfigReaderThread::Run()
2373 ServerInstance->Config->Read(do_bail, TheUserUID);
2374 ServerInstance->Threads->Lock();
2375 this->SetExitFlag();
2376 ServerInstance->Threads->Unlock();