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/>.
36 #include <sys/resource.h>
40 /* Some systems don't define RUSAGE_SELF. This should fix them. */
45 #include <pwd.h> // setuid
46 #include <grp.h> // setgid
48 WORD g_wOriginalColors;
49 WORD g_wBackgroundColor;
57 #include "socketengine.h"
59 #include "command_parse.h"
60 #include "exitcodes.h"
62 #include "testsuite.h"
64 InspIRCd* ServerInstance = NULL;
66 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
69 * This is provided as a pointer so that modules can change it to their custom mapping tables,
70 * e.g. for national character support.
72 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
75 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
76 * XXX this is a bit ugly. -- w00t
78 const char* ExitCodes[] =
82 "Config file error", // 2
84 "POSIX fork failed", // 4
85 "Bad commandline parameters", // 5
86 "Can't write PID file", // 6
87 "SocketEngine could not initialize", // 7
88 "Refusing to start up as root", // 8
89 "Couldn't load module on startup", // 9
90 "Received SIGTERM" // 10
93 template<typename T> static void DeleteZero(T*&n)
100 void InspIRCd::Cleanup()
102 // Close all listening sockets
103 for (unsigned int i = 0; i < ports.size(); i++)
110 /* Close all client sockets, or the new process inherits them */
111 LocalUserList::reverse_iterator i = Users->local_users.rbegin();
112 while (i != this->Users->local_users.rend())
115 Users->QuitUser(u, "Server shutdown");
119 Modules->UnloadAll();
121 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
122 /* Must be deleted before modes as it decrements modelines */
125 DeleteZero(this->FakeClient);
126 DeleteZero(this->Users);
127 DeleteZero(this->Modes);
128 DeleteZero(this->XLines);
129 DeleteZero(this->Parser);
130 DeleteZero(this->stats);
131 DeleteZero(this->Modules);
132 DeleteZero(this->BanCache);
133 DeleteZero(this->SNO);
134 DeleteZero(this->Config);
135 DeleteZero(this->chanlist);
136 DeleteZero(this->PI);
137 DeleteZero(this->Threads);
138 DeleteZero(this->Timers);
139 DeleteZero(this->SE);
140 DeleteZero(this->Logs);
143 void InspIRCd::Restart(const std::string &reason)
145 /* SendError flushes each client's queue,
146 * regardless of writeability state
148 this->SendError(reason);
150 /* Figure out our filename (if theyve renamed it, we're boned) */
153 char** argv = Config->cmdline.argv;
156 char module[MAX_PATH];
157 if (GetModuleFileNameA(NULL, module, MAX_PATH))
165 if (execv(me.c_str(), argv) == -1)
167 /* Will raise a SIGABRT if not trapped */
168 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
172 void InspIRCd::SetSignals()
175 signal(SIGALRM, SIG_IGN);
176 signal(SIGHUP, InspIRCd::SetSignal);
177 signal(SIGPIPE, SIG_IGN);
178 signal(SIGCHLD, SIG_IGN);
179 /* We want E2BIG not a signal! */
180 signal(SIGXFSZ, SIG_IGN);
182 signal(SIGTERM, InspIRCd::SetSignal);
185 void InspIRCd::QuickExit(int status)
190 bool InspIRCd::DaemonSeed()
193 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
196 signal(SIGTERM, InspIRCd::QuickExit);
198 int childpid = fork();
201 else if (childpid > 0)
203 /* We wait here for the child process to kill us,
204 * so that the shell prompt doesnt come back over
206 * Sending a kill with a signal of 0 just checks
207 * if the child pid is still around. If theyre not,
208 * they threw an error and we should give up.
210 while (kill(childpid, 0) != -1)
215 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
217 signal(SIGTERM, InspIRCd::SetSignal);
220 if (getrlimit(RLIMIT_CORE, &rl) == -1)
222 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
225 rl.rlim_cur = rl.rlim_max;
227 if (setrlimit(RLIMIT_CORE, &rl) == -1)
228 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
234 void InspIRCd::WritePID(const std::string &filename)
237 std::string fname(filename);
239 fname = DATA_PATH "/inspircd.pid";
240 std::ofstream outfile(fname.c_str());
241 if (outfile.is_open())
248 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
249 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s', exiting.",fname.c_str());
250 Exit(EXIT_STATUS_PID);
255 InspIRCd::InspIRCd(int argc, char** argv) :
256 ConfigFileName(CONFIG_PATH "/inspircd.conf"),
258 /* Functor pointer initialisation.
260 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
261 * themselves within the class.
263 OperQuit("OperQuit", NULL),
264 GenRandom(&HandleGenRandom),
265 IsChannel(&HandleIsChannel),
266 Rehash(&HandleRehash),
267 IsNick(&HandleIsNick),
268 IsIdent(&HandleIsIdent),
269 OnCheckExemption(&HandleOnCheckExemption)
271 ServerInstance = this;
273 Extensions.Register(&OperQuit);
276 int do_version = 0, do_nofork = 0, do_debug = 0,
277 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
279 // Initialize so that if we exit before proper initialization they're not deleted
294 this->ConfigThread = NULL;
295 this->FakeClient = NULL;
298 this->startup_time = TIME.tv_sec;
300 // This must be created first, so other parts of Insp can use it while starting up
301 this->Logs = new LogManager;
303 SE = CreateSocketEngine();
305 this->Threads = new ThreadEngine;
307 /* Default implementation does nothing */
308 this->PI = new ProtocolInterface;
310 // Create base manager classes early, so nothing breaks
311 this->Users = new UserManager;
313 this->chanlist = new chan_hash();
315 this->Config = new ServerConfig;
316 this->SNO = new SnomaskManager;
317 this->BanCache = new BanCacheManager;
318 this->Modules = new ModuleManager();
319 dynamic_reference_base::reset_all();
320 this->stats = new serverstats();
321 this->Timers = new TimerManager;
322 this->Parser = new CommandParser;
323 this->XLines = new XLineManager;
325 this->Config->cmdline.argv = argv;
326 this->Config->cmdline.argc = argc;
329 srand(TIME.tv_nsec ^ TIME.tv_sec);
331 // Initialize the console values
332 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
333 CONSOLE_SCREEN_BUFFER_INFO bufinf;
334 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
336 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
337 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
341 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
342 g_wBackgroundColor = 0;
345 srandom(TIME.tv_nsec ^ TIME.tv_sec);
348 struct option longopts[] =
350 { "nofork", no_argument, &do_nofork, 1 },
351 { "config", required_argument, NULL, 'c' },
352 { "debug", no_argument, &do_debug, 1 },
353 { "nolog", no_argument, &do_nolog, 1 },
354 { "runasroot", no_argument, &do_root, 1 },
355 { "version", no_argument, &do_version, 1 },
356 { "testsuite", no_argument, &do_testsuite, 1 },
362 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
367 /* Config filename was set */
368 ConfigFileName = optarg;
371 /* getopt_long_only() set an int variable, just keep going */
374 /* Unknown parameter */
376 /* Fall through to handle other weird values too */
377 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
378 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
379 std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version] [--testsuite]" << std::endl;
380 Exit(EXIT_STATUS_ARGV);
386 do_nofork = do_debug = true;
390 std::cout << std::endl << VERSION << " r" << REVISION << std::endl;
391 Exit(EXIT_STATUS_NOERROR);
397 WSAStartup(MAKEWORD(2,2), &wsadata);
400 /* Set the finished argument values */
401 Config->cmdline.nofork = (do_nofork != 0);
402 Config->cmdline.forcedebug = (do_debug != 0);
403 Config->cmdline.writelog = (!do_nolog != 0);
404 Config->cmdline.TestSuite = (do_testsuite != 0);
408 FileWriter* fw = new FileWriter(stdout);
409 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
410 Logs->AddLogTypes("*", fls, true);
413 if (!ServerConfig::FileExists(ConfigFileName.c_str()))
416 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
417 std::string txtconf = this->ConfigFileName;
418 txtconf.append(".txt");
420 if (ServerConfig::FileExists(txtconf.c_str()))
422 ConfigFileName = txtconf;
427 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
428 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
429 Exit(EXIT_STATUS_CONFIG);
433 std::cout << con_green << "Inspire Internet Relay Chat Server" << con_reset << ", compiled on " __DATE__ " at " __TIME__ << std::endl;
434 std::cout << con_green << "(C) InspIRCd Development Team." << con_reset << std::endl << std::endl;
435 std::cout << "Developers:" << std::endl;
436 std::cout << con_green << "\tBrain, FrostyCoolSlug, w00t, Om, Special, peavey" << std::endl;
437 std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << std::endl;
438 std::cout << "\tAttila" << con_reset << std::endl << std::endl;
439 std::cout << "Others:\t\t\t" << con_green << "See /INFO Output" << con_reset << std::endl;
441 this->Modes = new ModeParser;
448 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
449 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
450 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
451 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
452 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
453 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
454 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
455 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
462 if (!Config->cmdline.nofork)
464 if (!this->DaemonSeed())
466 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
467 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
468 Exit(EXIT_STATUS_FORK);
472 SE->RecoverFromFork();
474 /* During startup we read the configuration now, not in
477 this->Config->Read();
478 this->Config->Apply(NULL, "");
479 Logs->OpenFileLogs();
480 ModeParser::InitBuiltinModes();
482 // If we don't have a SID, generate one based on the server name and the server description
483 if (Config->sid.empty())
484 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
486 // Initialize the UID generator with our sid
487 this->UIDGen.init(Config->sid);
489 // Create the server user for this server
490 this->FakeClient = new FakeUser(Config->sid, Config->ServerName);
492 // This is needed as all new XLines are marked pending until ApplyLines() is called
493 this->XLines->ApplyLines();
495 int bounditems = BindPorts(pl);
497 std::cout << std::endl;
499 this->Modules->LoadAll();
501 // Build ISupport as ModuleManager::LoadAll() does not do it
502 this->ISupport.Build();
503 Config->ApplyDisabledCommands(Config->DisabledCommands);
507 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
508 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
509 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
511 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
513 std::cout << j << ".\tAddress: " << (i->first.empty() ? "<all>" : i->first) << " \tReason: " << i->second << std::endl;
516 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
519 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SE->GetMaxFds() << " max open sockets" << std::endl;
522 if (!Config->cmdline.nofork)
524 if (kill(getppid(), SIGTERM) == -1)
526 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
527 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
531 /* Explicitly shut down stdio's stdin/stdout/stderr.
533 * The previous logic here was to only do this if stdio was connected to a controlling
534 * terminal. However, we must do this always to avoid information leaks and other
535 * problems related to stdio.
537 * The only exception is if we are in debug mode.
541 if ((!do_nofork) && (!do_testsuite) && (!Config->cmdline.forcedebug))
543 int fd = open("/dev/null", O_RDWR);
549 if (dup2(fd, STDIN_FILENO) < 0)
550 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
551 if (dup2(fd, STDOUT_FILENO) < 0)
552 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
553 if (dup2(fd, STDERR_FILENO) < 0)
554 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
559 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
562 /* Set win32 service as running, if we are running as a service */
571 QueryPerformanceFrequency(&stats->QPFrequency);
574 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
577 std::string SetUser = Config->ConfValue("security")->getString("runasuser");
578 std::string SetGroup = Config->ConfValue("security")->getString("runasgroup");
579 if (!SetGroup.empty())
584 ret = setgroups(0, NULL);
588 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
596 g = getgrnam(SetGroup.c_str());
600 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
604 ret = setgid(g->gr_gid);
608 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
613 if (!SetUser.empty())
619 u = getpwnam(SetUser.c_str());
623 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
627 int ret = setuid(u->pw_uid);
631 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
636 this->WritePID(Config->PID);
640 void InspIRCd::UpdateTime()
646 TIME.tv_sec = time(NULL);
647 TIME.tv_nsec = st.wMilliseconds;
649 #ifdef HAS_CLOCK_GETTIME
650 clock_gettime(CLOCK_REALTIME, &TIME);
653 gettimeofday(&tv, NULL);
654 TIME.tv_sec = tv.tv_sec;
655 TIME.tv_nsec = tv.tv_usec * 1000;
662 /* See if we're supposed to be running the test suite rather than entering the mainloop */
663 if (Config->cmdline.TestSuite)
665 TestSuite* ts = new TestSuite;
671 time_t OLDTIME = TIME.tv_sec;
679 /* Check if there is a config thread which has finished executing but has not yet been freed */
680 if (this->ConfigThread && this->ConfigThread->IsDone())
682 /* Rehash has completed */
683 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
685 this->ConfigThread->Finish();
687 ConfigThread->join();
694 /* Run background module timers every few seconds
695 * (the docs say modules shouldnt rely on accurate
696 * timing using this event, so we dont have to
697 * time this exactly).
699 if (TIME.tv_sec != OLDTIME)
702 getrusage(RUSAGE_SELF, &ru);
703 stats->LastSampled = TIME;
704 stats->LastCPU = ru.ru_utime;
706 if(QueryPerformanceCounter(&stats->LastSampled))
708 FILETIME CreationTime;
712 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
713 stats->LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
714 stats->LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
718 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
719 if (TIME.tv_sec < OLDTIME - 2)
721 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME.tv_sec);
723 else if (TIME.tv_sec > OLDTIME + 2)
725 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME.tv_sec - OLDTIME);
728 OLDTIME = TIME.tv_sec;
730 if ((TIME.tv_sec % 3600) == 0)
732 Users->GarbageCollect();
733 FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
736 Timers->TickTimers(TIME.tv_sec);
737 Users->DoBackgroundUserStuff();
739 if ((TIME.tv_sec % 5) == 0)
741 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME.tv_sec));
742 SNO->FlushSnotices();
746 /* Call the socket engine to wait on the active
747 * file descriptors. The socket engine has everything's
748 * descriptors in its list... dns, modules, users,
749 * servers... so its nice and easy, just one call.
750 * This will cause any read or write events to be
751 * dispatched to their handlers.
753 this->SE->DispatchTrialWrites();
754 this->SE->DispatchEvents();
756 /* if any users were quit, take them out */
762 this->SignalHandler(s_signal);
768 sig_atomic_t InspIRCd::s_signal = 0;
770 void InspIRCd::SetSignal(int signal)
775 /* On posix systems, the flow of the program starts right here, with
776 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
777 * defines smain() and the real main() is in the service code under
778 * win32service.cpp. This allows the service control manager to control
779 * the process where we are running as a windows service.
783 new InspIRCd(argc, argv);
784 ServerInstance->Run();
785 delete ServerInstance;