2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2012 William Pitcock <nenolod@dereferenced.org>
5 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
6 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Uli Schlachter <psychon@znc.in>
8 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * Copyright (C) 2007 Burlex <???@???>
12 * Copyright (C) 2003 Craig McLure <craig@chatspike.net>
13 * Copyright (C) 2003 randomdan <???@???>
15 * This file is part of InspIRCd. InspIRCd is free software: you can
16 * redistribute it and/or modify it under the terms of the GNU General Public
17 * License as published by the Free Software Foundation, version 2.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 #include <sys/resource.h>
39 /* Some systems don't define RUSAGE_SELF. This should fix them. */
44 #include <pwd.h> // setuid
45 #include <grp.h> // setgid
47 WORD g_wOriginalColors;
48 WORD g_wBackgroundColor;
56 #include "socketengine.h"
58 #include "command_parse.h"
59 #include "exitcodes.h"
61 #include "testsuite.h"
63 InspIRCd* ServerInstance = NULL;
65 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
68 * This is provided as a pointer so that modules can change it to their custom mapping tables,
69 * e.g. for national character support.
71 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
74 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
75 * XXX this is a bit ugly. -- w00t
77 const char* ExitCodes[] =
81 "Config file error", // 2
83 "POSIX fork failed", // 4
84 "Bad commandline parameters", // 5
85 "Can't write PID file", // 6
86 "SocketEngine could not initialize", // 7
87 "Refusing to start up as root", // 8
88 "Couldn't load module on startup", // 9
89 "Received SIGTERM" // 10
92 #ifdef INSPIRCD_ENABLE_TESTSUITE
93 /** True if we have been told to run the testsuite from the commandline,
94 * rather than entering the mainloop.
96 static int do_testsuite = 0;
99 template<typename T> static void DeleteZero(T*&n)
106 void InspIRCd::Cleanup()
108 // Close all listening sockets
109 for (unsigned int i = 0; i < ports.size(); i++)
116 /* Close all client sockets, or the new process inherits them */
117 LocalUserList& list = Users->local_users;
118 for (LocalUserList::iterator i = list.begin(); i != list.end(); ++i)
119 Users->QuitUser(*i, "Server shutdown");
122 Modules->UnloadAll();
124 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
125 /* Must be deleted before modes as it decrements modelines */
128 delete FakeClient->server;
131 DeleteZero(this->FakeClient);
132 DeleteZero(this->Users);
133 DeleteZero(this->Modes);
134 DeleteZero(this->XLines);
135 DeleteZero(this->Parser);
136 DeleteZero(this->stats);
137 DeleteZero(this->Modules);
138 DeleteZero(this->BanCache);
139 DeleteZero(this->SNO);
140 DeleteZero(this->Config);
141 DeleteZero(this->PI);
142 DeleteZero(this->Threads);
143 SocketEngine::Deinit();
145 DeleteZero(this->Logs);
148 void InspIRCd::SetSignals()
151 signal(SIGALRM, SIG_IGN);
152 signal(SIGHUP, InspIRCd::SetSignal);
153 signal(SIGPIPE, SIG_IGN);
154 signal(SIGCHLD, SIG_IGN);
155 /* We want E2BIG not a signal! */
156 signal(SIGXFSZ, SIG_IGN);
158 signal(SIGTERM, InspIRCd::SetSignal);
161 void InspIRCd::QuickExit(int status)
166 // Required for returning the proper value of EXIT_SUCCESS for the parent process
167 static void VoidSignalHandler(int signalreceived)
172 bool InspIRCd::DaemonSeed()
175 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
178 // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
179 signal(SIGTERM, VoidSignalHandler);
181 int childpid = fork();
184 else if (childpid > 0)
186 /* We wait here for the child process to kill us,
187 * so that the shell prompt doesnt come back over
189 * Sending a kill with a signal of 0 just checks
190 * if the child pid is still around. If theyre not,
191 * they threw an error and we should give up.
193 while (kill(childpid, 0) != -1)
198 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
200 signal(SIGTERM, InspIRCd::SetSignal);
203 if (getrlimit(RLIMIT_CORE, &rl) == -1)
205 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
208 rl.rlim_cur = rl.rlim_max;
210 if (setrlimit(RLIMIT_CORE, &rl) == -1)
211 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
217 void InspIRCd::WritePID(const std::string &filename)
220 std::string fname(filename);
222 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
223 std::ofstream outfile(fname.c_str());
224 if (outfile.is_open())
231 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
232 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s', exiting.",fname.c_str());
233 Exit(EXIT_STATUS_PID);
238 InspIRCd::InspIRCd(int argc, char** argv) :
239 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
241 /* Functor pointer initialisation.
243 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
244 * themselves within the class.
246 OperQuit("operquit", NULL),
247 GenRandom(&HandleGenRandom),
248 IsChannel(&HandleIsChannel),
249 IsNick(&HandleIsNick),
250 IsIdent(&HandleIsIdent),
251 OnCheckExemption(&HandleOnCheckExemption)
253 ServerInstance = this;
255 Extensions.Register(&OperQuit);
258 // Flag variables passed to getopt_long() later
259 int do_version = 0, do_nofork = 0, do_debug = 0,
260 do_nolog = 0, do_root = 0;
262 // Initialize so that if we exit before proper initialization they're not deleted
275 this->ConfigThread = NULL;
276 this->FakeClient = NULL;
279 this->startup_time = TIME.tv_sec;
281 // This must be created first, so other parts of Insp can use it while starting up
282 this->Logs = new LogManager;
284 SocketEngine::Init();
286 this->Threads = new ThreadEngine;
288 /* Default implementation does nothing */
289 this->PI = new ProtocolInterface;
291 // Create base manager classes early, so nothing breaks
292 this->Users = new UserManager;
294 this->Config = new ServerConfig;
295 this->SNO = new SnomaskManager;
296 this->BanCache = new BanCacheManager;
297 this->Modules = new ModuleManager();
298 dynamic_reference_base::reset_all();
299 this->stats = new serverstats();
300 this->Parser = new CommandParser;
301 this->XLines = new XLineManager;
303 this->Config->cmdline.argv = argv;
304 this->Config->cmdline.argc = argc;
307 srand(TIME.tv_nsec ^ TIME.tv_sec);
309 // Initialize the console values
310 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
311 CONSOLE_SCREEN_BUFFER_INFO bufinf;
312 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
314 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
315 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
319 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
320 g_wBackgroundColor = 0;
323 srandom(TIME.tv_nsec ^ TIME.tv_sec);
326 struct option longopts[] =
328 { "nofork", no_argument, &do_nofork, 1 },
329 { "config", required_argument, NULL, 'c' },
330 { "debug", no_argument, &do_debug, 1 },
331 { "nolog", no_argument, &do_nolog, 1 },
332 { "runasroot", no_argument, &do_root, 1 },
333 { "version", no_argument, &do_version, 1 },
334 #ifdef INSPIRCD_ENABLE_TESTSUITE
335 { "testsuite", no_argument, &do_testsuite, 1 },
342 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
347 /* Config filename was set */
348 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
351 /* getopt_long_only() set an int variable, just keep going */
354 /* Unknown parameter */
356 /* Fall through to handle other weird values too */
357 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
358 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
359 std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
360 Exit(EXIT_STATUS_ARGV);
365 #ifdef INSPIRCD_ENABLE_TESTSUITE
367 do_nofork = do_debug = true;
372 std::cout << std::endl << INSPIRCD_VERSION << " " << INSPIRCD_REVISION << std::endl;
373 Exit(EXIT_STATUS_NOERROR);
379 WSAStartup(MAKEWORD(2,2), &wsadata);
382 /* Set the finished argument values */
383 Config->cmdline.nofork = (do_nofork != 0);
384 Config->cmdline.forcedebug = (do_debug != 0);
385 Config->cmdline.writelog = !do_nolog;
389 FileWriter* fw = new FileWriter(stdout);
390 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
391 Logs->AddLogTypes("*", fls, true);
394 if (!FileSystem::FileExists(ConfigFileName))
397 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
398 std::string txtconf = this->ConfigFileName;
399 txtconf.append(".txt");
401 if (FileSystem::FileExists(txtconf))
403 ConfigFileName = txtconf;
408 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
409 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
410 Exit(EXIT_STATUS_CONFIG);
414 std::cout << con_green << "Inspire Internet Relay Chat Server" << con_reset << ", compiled on " __DATE__ " at " __TIME__ << std::endl;
415 std::cout << con_green << "(C) InspIRCd Development Team." << con_reset << std::endl << std::endl;
416 std::cout << "Developers:" << std::endl;
417 std::cout << con_green << "\tBrain, FrostyCoolSlug, w00t, Om, Special, peavey" << std::endl;
418 std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << std::endl;
419 std::cout << "\tAttila" << con_reset << std::endl << std::endl;
420 std::cout << "Others:\t\t\t" << con_green << "See /INFO Output" << con_reset << std::endl;
422 this->Modes = new ModeParser;
429 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
430 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
431 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
432 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
433 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
434 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
435 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
436 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
443 if (!Config->cmdline.nofork)
445 if (!this->DaemonSeed())
447 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
448 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
449 Exit(EXIT_STATUS_FORK);
453 SocketEngine::RecoverFromFork();
455 /* During startup we read the configuration now, not in
458 this->Config->Read();
459 this->Config->Apply(NULL, "");
460 Logs->OpenFileLogs();
461 ModeParser::InitBuiltinModes();
463 // If we don't have a SID, generate one based on the server name and the server description
464 if (Config->sid.empty())
465 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
467 // Initialize the UID generator with our sid
468 this->UIDGen.init(Config->sid);
470 // Create the server user for this server
471 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
473 // This is needed as all new XLines are marked pending until ApplyLines() is called
474 this->XLines->ApplyLines();
476 int bounditems = BindPorts(pl);
478 std::cout << std::endl;
480 this->Modules->LoadAll();
482 // Build ISupport as ModuleManager::LoadAll() does not do it
483 this->ISupport.Build();
484 Config->ApplyDisabledCommands(Config->DisabledCommands);
488 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
489 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
490 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
492 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
494 std::cout << j << ".\tAddress: " << (i->first.empty() ? "<all>" : i->first) << " \tReason: " << i->second << std::endl;
497 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
500 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
503 if (!Config->cmdline.nofork)
505 if (kill(getppid(), SIGTERM) == -1)
507 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
508 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
512 /* Explicitly shut down stdio's stdin/stdout/stderr.
514 * The previous logic here was to only do this if stdio was connected to a controlling
515 * terminal. However, we must do this always to avoid information leaks and other
516 * problems related to stdio.
518 * The only exception is if we are in debug mode.
522 if ((!do_nofork) && (!Config->cmdline.forcedebug))
524 int fd = open("/dev/null", O_RDWR);
530 if (dup2(fd, STDIN_FILENO) < 0)
531 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
532 if (dup2(fd, STDOUT_FILENO) < 0)
533 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
534 if (dup2(fd, STDERR_FILENO) < 0)
535 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
540 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
543 /* Set win32 service as running, if we are running as a service */
552 QueryPerformanceFrequency(&stats->QPFrequency);
555 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
558 std::string SetUser = Config->ConfValue("security")->getString("runasuser");
559 std::string SetGroup = Config->ConfValue("security")->getString("runasgroup");
560 if (!SetGroup.empty())
565 ret = setgroups(0, NULL);
569 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
577 g = getgrnam(SetGroup.c_str());
581 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
585 ret = setgid(g->gr_gid);
589 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (wrong group?): %s", strerror(errno));
594 if (!SetUser.empty())
600 u = getpwnam(SetUser.c_str());
604 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
608 int ret = setuid(u->pw_uid);
612 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (wrong user?): %s", strerror(errno));
617 this->WritePID(Config->PID);
621 void InspIRCd::UpdateTime()
627 TIME.tv_sec = time(NULL);
628 TIME.tv_nsec = st.wMilliseconds;
630 #ifdef HAS_CLOCK_GETTIME
631 clock_gettime(CLOCK_REALTIME, &TIME);
634 gettimeofday(&tv, NULL);
635 TIME.tv_sec = tv.tv_sec;
636 TIME.tv_nsec = tv.tv_usec * 1000;
643 #ifdef INSPIRCD_ENABLE_TESTSUITE
644 /* See if we're supposed to be running the test suite rather than entering the mainloop */
647 TestSuite* ts = new TestSuite;
654 time_t OLDTIME = TIME.tv_sec;
662 /* Check if there is a config thread which has finished executing but has not yet been freed */
663 if (this->ConfigThread && this->ConfigThread->IsDone())
665 /* Rehash has completed */
666 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
668 this->ConfigThread->Finish();
670 ConfigThread->join();
677 /* Run background module timers every few seconds
678 * (the docs say modules shouldnt rely on accurate
679 * timing using this event, so we dont have to
680 * time this exactly).
682 if (TIME.tv_sec != OLDTIME)
685 getrusage(RUSAGE_SELF, &ru);
686 stats->LastSampled = TIME;
687 stats->LastCPU = ru.ru_utime;
689 if(QueryPerformanceCounter(&stats->LastSampled))
691 FILETIME CreationTime;
695 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
696 stats->LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
697 stats->LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
701 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
702 if (TIME.tv_sec < OLDTIME - 2)
704 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME.tv_sec);
706 else if (TIME.tv_sec > OLDTIME + 2)
708 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME.tv_sec - OLDTIME);
711 OLDTIME = TIME.tv_sec;
713 if ((TIME.tv_sec % 3600) == 0)
715 Users->GarbageCollect();
716 FOREACH_MOD(OnGarbageCollect, ());
719 Timers.TickTimers(TIME.tv_sec);
720 Users->DoBackgroundUserStuff();
722 if ((TIME.tv_sec % 5) == 0)
724 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
725 SNO->FlushSnotices();
729 /* Call the socket engine to wait on the active
730 * file descriptors. The socket engine has everything's
731 * descriptors in its list... dns, modules, users,
732 * servers... so its nice and easy, just one call.
733 * This will cause any read or write events to be
734 * dispatched to their handlers.
736 SocketEngine::DispatchTrialWrites();
737 SocketEngine::DispatchEvents();
739 /* if any users were quit, take them out */
745 this->SignalHandler(s_signal);
751 sig_atomic_t InspIRCd::s_signal = 0;
753 void InspIRCd::SetSignal(int signal)
758 /* On posix systems, the flow of the program starts right here, with
759 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
760 * defines smain() and the real main() is in the service code under
761 * win32service.cpp. This allows the service control manager to control
762 * the process where we are running as a windows service.
766 new InspIRCd(argc, argv);
767 ServerInstance->Run();
768 delete ServerInstance;