1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 #include "inspircd_version.h"
22 #include <sys/resource.h>
26 /* Some systems don't define RUSAGE_SELF. This should fix them. */
31 #include <pwd.h> // setuid
32 #include <grp.h> // setgid
38 #include "socketengine.h"
39 #include "inspircd_se_config.h"
41 #include "command_parse.h"
42 #include "exitcodes.h"
44 #include "testsuite.h"
46 InspIRCd* ServerInstance = NULL;
49 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
52 * This is provided as a pointer so that modules can change it to their custom mapping tables,
53 * e.g. for national character support.
55 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
58 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
59 * XXX this is a bit ugly. -- w00t
61 const char* ExitCodes[] =
64 "DIE command", /* 1 */
65 "execv() failed", /* 2 */
66 "Internal error", /* 3 */
67 "Config file error", /* 4 */
68 "Logfile error", /* 5 */
69 "POSIX fork failed", /* 6 */
70 "Bad commandline parameters", /* 7 */
71 "No ports could be bound", /* 8 */
72 "Can't write PID file", /* 9 */
73 "SocketEngine could not initialize", /* 10 */
74 "Refusing to start up as root", /* 11 */
75 "Found a <die> tag!", /* 12 */
76 "Couldn't load module on startup", /* 13 */
77 "Could not create windows forked process", /* 14 */
78 "Received SIGTERM", /* 15 */
79 "Bad command handler loaded", /* 16 */
80 "RegisterServiceCtrlHandler failed", /* 17 */
81 "UpdateSCMStatus failed", /* 18 */
82 "CreateEvent failed" /* 19 */
85 template<typename T> static void DeleteZero(T*&n)
94 void InspIRCd::Cleanup()
98 for (unsigned int i = 0; i < ports.size(); i++)
100 /* This calls the constructor and closes the listening socket */
107 /* Close all client sockets, or the new process inherits them */
108 std::vector<User*>::reverse_iterator i = Users->local_users.rbegin();
109 while (i != this->Users->local_users.rend())
112 Users->QuitUser(u, "Server shutdown");
115 /* We do this more than once, so that any service providers get a
116 * chance to be unhooked by the modules using them, but then get
117 * a chance to be removed themsleves.
119 * XXX there may be a better way to do this with 1.2
121 for (int tries = 0; tries < 4; tries++)
123 std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
124 for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
126 /* Unload all modules, so they get a chance to clean up their listeners */
127 this->Modules->Unload(k->c_str());
131 /* Cleanup Server Names */
132 for(servernamelist::iterator itr = servernames.begin(); itr != servernames.end(); ++itr)
135 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
136 /* Must be deleted before modes as it decrements modelines */
137 DeleteZero(this->FakeClient);
138 DeleteZero(this->Users);
139 DeleteZero(this->Modes);
140 DeleteZero(this->XLines);
141 DeleteZero(this->Parser);
142 DeleteZero(this->stats);
143 DeleteZero(this->Modules);
144 DeleteZero(this->BanCache);
145 DeleteZero(this->SNO);
146 DeleteZero(this->Config);
147 DeleteZero(this->Res);
148 DeleteZero(this->chanlist);
149 DeleteZero(this->PI);
150 DeleteZero(this->Threads);
151 DeleteZero(this->Timers);
152 DeleteZero(this->SE);
154 this->Logs->CloseLogs();
155 DeleteZero(this->Logs);
158 void InspIRCd::Restart(const std::string &reason)
160 /* SendError flushes each client's queue,
161 * regardless of writeability state
163 this->SendError(reason);
165 /* Figure out our filename (if theyve renamed it, we're boned) */
169 char module[MAX_PATH];
170 if (GetModuleFileName(NULL, module, MAX_PATH))
173 me = Config->MyDir + "/inspircd";
176 char** argv = Config->argv;
180 if (execv(me.c_str(), argv) == -1)
182 /* Will raise a SIGABRT if not trapped */
183 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
187 void InspIRCd::ResetMaxBans()
189 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
190 i->second->ResetMaxBans();
193 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
194 * we must occasionally rehash the hash (yes really).
195 * We do this by copying the entries from the old hash to a new hash, causing all
196 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
197 * very expensive, so instead we do it when the user types /REHASH and expects a
198 * short delay anyway.
200 void InspIRCd::RehashUsersAndChans()
202 user_hash* old_users = this->Users->clientlist;
203 user_hash* old_uuid = this->Users->uuidlist;
204 chan_hash* old_chans = this->chanlist;
206 this->Users->clientlist = new user_hash();
207 this->Users->uuidlist = new user_hash();
208 this->chanlist = new chan_hash();
210 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
211 this->Users->clientlist->insert(*n);
215 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
216 this->Users->uuidlist->insert(*n);
220 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
221 this->chanlist->insert(*n);
226 void InspIRCd::SetSignals()
229 signal(SIGALRM, SIG_IGN);
230 signal(SIGHUP, InspIRCd::SetSignal);
231 signal(SIGPIPE, SIG_IGN);
232 signal(SIGCHLD, SIG_IGN);
233 /* We want E2BIG not a signal! */
234 signal(SIGXFSZ, SIG_IGN);
236 signal(SIGTERM, InspIRCd::SetSignal);
239 void InspIRCd::QuickExit(int status)
244 bool InspIRCd::DaemonSeed()
247 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
250 signal(SIGTERM, InspIRCd::QuickExit);
253 if ((childpid = fork ()) < 0)
255 else if (childpid > 0)
257 /* We wait here for the child process to kill us,
258 * so that the shell prompt doesnt come back over
260 * Sending a kill with a signal of 0 just checks
261 * if the child pid is still around. If theyre not,
262 * they threw an error and we should give up.
264 while (kill(childpid, 0) != -1)
270 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
272 signal(SIGTERM, InspIRCd::SetSignal);
275 if (getrlimit(RLIMIT_CORE, &rl) == -1)
277 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
282 rl.rlim_cur = rl.rlim_max;
283 if (setrlimit(RLIMIT_CORE, &rl) == -1)
284 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
291 void InspIRCd::WritePID(const std::string &filename)
293 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
294 std::replace(fname.begin(), fname.end(), '\\', '/');
295 if ((fname[0] != '/') && (!Config->StartsWithWindowsDriveLetter(filename)))
297 std::string::size_type pos;
298 std::string confpath = this->ConfigFileName;
299 if ((pos = confpath.rfind("/")) != std::string::npos)
301 /* Leaves us with just the path */
302 fname = confpath.substr(0, pos) + std::string("/") + fname;
305 std::ofstream outfile(fname.c_str());
306 if (outfile.is_open())
313 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
314 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
315 Exit(EXIT_STATUS_PID);
319 InspIRCd::InspIRCd(int argc, char** argv) :
320 ConfigFileName("inspircd.conf"),
322 /* Functor pointer initialisation.
324 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
325 * themselves within the class.
327 IsChannel(&HandleIsChannel),
329 Rehash(&HandleRehash),
330 IsNick(&HandleIsNick),
331 IsIdent(&HandleIsIdent),
332 FloodQuitUser(&HandleFloodQuitUser)
336 // Strict, frequent checking of memory on debug builds
337 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
339 // Avoid erroneous frees on early exit
343 ServerInstance = this;
345 Extensible::Register(&User::NICKForced);
346 Extensible::Register(&User::OperQuit);
349 int do_version = 0, do_nofork = 0, do_debug = 0,
350 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
353 // Initialize so that if we exit before proper initialization they're not deleted
369 this->ConfigThread = NULL;
372 this->TIME = time(NULL);
374 // This must be created first, so other parts of Insp can use it while starting up
375 this->Logs = new LogManager;
377 SocketEngineFactory SEF;
380 this->Threads = new ThreadEngine;
382 /* Default implementation does nothing */
383 this->PI = new ProtocolInterface;
387 // Create base manager classes early, so nothing breaks
388 this->Users = new UserManager;
390 this->Users->unregistered_count = 0;
392 this->Users->clientlist = new user_hash();
393 this->Users->uuidlist = new user_hash();
394 this->chanlist = new chan_hash();
396 this->Config = new ServerConfig;
397 this->SNO = new SnomaskManager;
398 this->BanCache = new BanCacheManager;
399 this->Modules = new ModuleManager();
400 this->stats = new serverstats();
401 this->Timers = new TimerManager;
402 this->Parser = new CommandParser;
403 this->XLines = new XLineManager;
405 this->Config->argv = argv;
406 this->Config->argc = argc;
408 if (chdir(Config->GetFullProgDir().c_str()))
410 printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
414 this->Config->opertypes.clear();
415 this->Config->operclass.clear();
417 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
420 *this->LogFileName = 0;
422 struct option longopts[] =
424 { "nofork", no_argument, &do_nofork, 1 },
425 { "logfile", required_argument, NULL, 'f' },
426 { "config", required_argument, NULL, 'c' },
427 { "debug", no_argument, &do_debug, 1 },
428 { "nolog", no_argument, &do_nolog, 1 },
429 { "runasroot", no_argument, &do_root, 1 },
430 { "version", no_argument, &do_version, 1 },
431 { "testsuite", no_argument, &do_testsuite, 1 },
436 while ((c = getopt_long_only(argc, argv, ":f:", longopts, &index)) != -1)
441 /* Log filename was set */
442 strlcpy(LogFileName, optarg, MAXBUF);
445 /* Config filename was set */
446 ConfigFileName = optarg;
449 /* getopt_long_only() set an int variable, just keep going */
452 /* Unknown parameter */
454 /* Fall through to handle other weird values too */
455 printf("Unknown parameter '%s'\n", argv[optind-1]);
456 printf("Usage: %s [--nofork] [--nolog] [--debug] [--logfile <filename>]\n%*s[--runasroot] [--version] [--config <config>] [--testsuite]\n", argv[0], static_cast<int>(8+strlen(argv[0])), " ");
457 Exit(EXIT_STATUS_ARGV);
463 do_nofork = do_debug = true;
467 printf("\n%s r%s\n", VERSION, REVISION);
468 Exit(EXIT_STATUS_NOERROR);
476 DWORD ExitCode = WindowsForkStart();
483 WSAStartup(MAKEWORD(2,0), &wsadata);
484 ChangeWindowsSpecificPointers();
486 Config->MyExecutable = argv[0];
488 /* Set the finished argument values */
489 Config->nofork = do_nofork;
490 Config->forcedebug = do_debug;
491 Config->writelog = !do_nolog;
492 Config->TestSuite = do_testsuite;
494 if (!this->OpenLog(argv, argc))
496 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
497 Exit(EXIT_STATUS_LOG);
500 if (!ServerConfig::FileExists(ConfigFileName.c_str()))
503 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
504 std::string txtconf = this->ConfigFileName;
505 txtconf.append(".txt");
507 if (ServerConfig::FileExists(txtconf.c_str()))
509 ConfigFileName = txtconf;
514 printf("ERROR: Cannot open config file: %s\nExiting...\n", ConfigFileName.c_str());
515 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", ConfigFileName.c_str());
516 Exit(EXIT_STATUS_CONFIG);
520 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
521 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
522 printf_c("Developers:\n");
523 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
524 printf_c("\t\033[1;32mpeavey, aquanight, psychon, dz, danieldg\033[0m\n\n");
525 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
527 this->Modes = new ModeParser;
533 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
534 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
535 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
536 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
537 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
538 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
539 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
540 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
548 if (!this->DaemonSeed())
550 printf("ERROR: could not go into daemon mode. Shutting down.\n");
551 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
552 Exit(EXIT_STATUS_FORK);
556 SE->RecoverFromFork();
558 /* During startup we don't actually initialize this
559 * in the thread engine.
561 this->Config->Read();
562 this->Config->Apply(NULL, "");
563 Logs->OpenFileLogs();
567 this->AddServerName(Config->ServerName);
570 * Initialise SID/UID.
571 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
579 for (const char* x = Config->ServerName; *x; ++x)
581 for (const char* y = Config->ServerDesc; *y; ++y)
585 Config->sid[0] = (char)(sid / 100 + 48);
586 Config->sid[1] = (char)(((sid / 10) % 10) + 48);
587 Config->sid[2] = (char)(sid % 10 + 48);
588 Config->sid[3] = '\0';
591 /* set up fake client again this time with the correct uid */
592 this->FakeClient = new FakeUser("!");
593 this->FakeClient->SetFakeServer(Config->ServerName);
595 // Get XLine to do it's thing.
596 this->XLines->CheckELines();
597 this->XLines->ApplyLines();
599 int bounditems = BindPorts(pl);
603 this->Modules->LoadAll();
605 /* Just in case no modules were loaded - fix for bug #101 */
606 this->BuildISupport();
607 Config->ApplyDisabledCommands(Config->DisabledCommands);
611 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n",
612 bounditems, bounditems + (int)pl.size());
613 printf("The following port(s) failed to bind:\n");
614 printf("Hint: Try using a public IP instead of blank or *\n\n");
616 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
618 printf("%d.\tAddress: %s\tReason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
622 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
627 if (kill(getppid(), SIGTERM) == -1)
629 printf("Error killing parent process: %s\n",strerror(errno));
630 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
634 if (isatty(0) && isatty(1) && isatty(2))
636 /* We didn't start from a TTY, we must have started from a background process -
637 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
640 if ((!do_nofork) && (!do_testsuite))
648 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
652 WindowsIPC = new IPC;
655 WindowsForkKillOwner();
658 /* Set win32 service as running, if we are running as a service */
662 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
665 if (*(this->Config->SetGroup))
670 ret = setgroups(0, NULL);
674 this->Logs->Log("SETGROUPS", DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
682 g = getgrnam(this->Config->SetGroup);
686 this->Logs->Log("SETGUID", DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
690 ret = setgid(g->gr_gid);
694 this->Logs->Log("SETGUID", DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
699 if (*(this->Config->SetUser))
705 u = getpwnam(this->Config->SetUser);
709 this->Logs->Log("SETGUID", DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
713 int ret = setuid(u->pw_uid);
717 this->Logs->Log("SETGUID", DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
723 this->WritePID(Config->PID);
728 /* See if we're supposed to be running the test suite rather than entering the mainloop */
729 if (Config->TestSuite)
731 TestSuite* ts = new TestSuite;
741 static time_t uptime;
742 static struct tm * stime;
743 static char window_title[100];
746 /* Check if there is a config thread which has finished executing but has not yet been freed */
747 if (this->ConfigThread && this->ConfigThread->IsDone())
749 /* Rehash has completed */
750 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
752 this->ConfigThread->Finish();
754 ConfigThread->join();
759 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
760 * Once per loop iteration is pleanty.
765 /* Run background module timers every few seconds
766 * (the docs say modules shouldnt rely on accurate
767 * timing using this event, so we dont have to
768 * time this exactly).
772 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
773 if (TIME < OLDTIME - 2)
775 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
777 else if (TIME > OLDTIME + 2)
779 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME - OLDTIME);
782 if ((TIME % 3600) == 0)
784 this->RehashUsersAndChans();
785 FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
788 Timers->TickTimers(TIME);
789 this->DoBackgroundUserStuff();
793 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
794 SNO->FlushSnotices();
797 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
798 if (!getrusage(RUSAGE_SELF, &ru))
800 gettimeofday(&this->stats->LastSampled, NULL);
801 this->stats->LastCPU = ru.ru_utime;
808 /* Call the socket engine to wait on the active
809 * file descriptors. The socket engine has everything's
810 * descriptors in its list... dns, modules, users,
811 * servers... so its nice and easy, just one call.
812 * This will cause any read or write events to be
813 * dispatched to their handlers.
815 this->SE->DispatchTrialWrites();
816 this->SE->DispatchEvents();
818 /* if any users were quit, take them out */
819 this->GlobalCulls.Apply();
823 this->SignalHandler(s_signal);
831 /**********************************************************************************/
834 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
837 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
838 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
839 * registration timeout maximum seconds)
841 bool InspIRCd::AllModulesReportReady(User* user)
844 FIRST_MOD_RESULT(OnCheckReady, res, (user));
845 return (res == MOD_RES_PASSTHRU);
848 time_t InspIRCd::Time()
853 void InspIRCd::SetSignal(int signal)
858 /* On posix systems, the flow of the program starts right here, with
859 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
860 * defines smain() and the real main() is in the service code under
861 * win32service.cpp. This allows the service control manager to control
862 * the process where we are running as a windows service.
866 new InspIRCd(argc, argv);
867 mysig = &ServerInstance->s_signal;
868 ServerInstance->Run();
869 delete ServerInstance;