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"
40 #include "command_parse.h"
41 #include "exitcodes.h"
43 #include "testsuite.h"
45 InspIRCd* ServerInstance = NULL;
48 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
51 * This is provided as a pointer so that modules can change it to their custom mapping tables,
52 * e.g. for national character support.
54 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
57 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
58 * XXX this is a bit ugly. -- w00t
60 const char* ExitCodes[] =
63 "DIE command", /* 1 */
64 "execv() failed", /* 2 */
65 "Internal error", /* 3 */
66 "Config file error", /* 4 */
67 "Logfile error", /* 5 */
68 "POSIX fork failed", /* 6 */
69 "Bad commandline parameters", /* 7 */
70 "No ports could be bound", /* 8 */
71 "Can't write PID file", /* 9 */
72 "SocketEngine could not initialize", /* 10 */
73 "Refusing to start up as root", /* 11 */
74 "Found a <die> tag!", /* 12 */
75 "Couldn't load module on startup", /* 13 */
76 "Could not create windows forked process", /* 14 */
77 "Received SIGTERM", /* 15 */
78 "Bad command handler loaded", /* 16 */
79 "RegisterServiceCtrlHandler failed", /* 17 */
80 "UpdateSCMStatus failed", /* 18 */
81 "CreateEvent failed" /* 19 */
84 template<typename T> static void DeleteZero(T*&n)
93 void InspIRCd::Cleanup()
97 for (unsigned int i = 0; i < ports.size(); i++)
99 /* This calls the constructor and closes the listening socket */
106 /* Close all client sockets, or the new process inherits them */
107 std::vector<User*>::reverse_iterator i = Users->local_users.rbegin();
108 while (i != this->Users->local_users.rend())
111 Users->QuitUser(u, "Server shutdown");
115 Modules->UnloadAll();
117 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
118 /* Must be deleted before modes as it decrements modelines */
119 DeleteZero(this->FakeClient);
120 DeleteZero(this->Users);
121 DeleteZero(this->Modes);
122 DeleteZero(this->XLines);
123 DeleteZero(this->Parser);
124 DeleteZero(this->stats);
125 DeleteZero(this->Modules);
126 DeleteZero(this->BanCache);
127 DeleteZero(this->SNO);
128 DeleteZero(this->Config);
129 DeleteZero(this->Res);
130 DeleteZero(this->chanlist);
131 DeleteZero(this->PI);
132 DeleteZero(this->Threads);
133 DeleteZero(this->Timers);
134 DeleteZero(this->SE);
136 this->Logs->CloseLogs();
137 DeleteZero(this->Logs);
140 void InspIRCd::Restart(const std::string &reason)
142 /* SendError flushes each client's queue,
143 * regardless of writeability state
145 this->SendError(reason);
147 /* Figure out our filename (if theyve renamed it, we're boned) */
151 char module[MAX_PATH];
152 if (GetModuleFileName(NULL, module, MAX_PATH))
155 me = Config->MyDir + "/inspircd";
158 char** argv = Config->argv;
162 if (execv(me.c_str(), argv) == -1)
164 /* Will raise a SIGABRT if not trapped */
165 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
169 void InspIRCd::ResetMaxBans()
171 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
172 i->second->ResetMaxBans();
175 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
176 * we must occasionally rehash the hash (yes really).
177 * We do this by copying the entries from the old hash to a new hash, causing all
178 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
179 * very expensive, so instead we do it when the user types /REHASH and expects a
180 * short delay anyway.
182 void InspIRCd::RehashUsersAndChans()
184 user_hash* old_users = this->Users->clientlist;
185 user_hash* old_uuid = this->Users->uuidlist;
186 chan_hash* old_chans = this->chanlist;
188 this->Users->clientlist = new user_hash();
189 this->Users->uuidlist = new user_hash();
190 this->chanlist = new chan_hash();
192 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
193 this->Users->clientlist->insert(*n);
197 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
198 this->Users->uuidlist->insert(*n);
202 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
203 this->chanlist->insert(*n);
208 void InspIRCd::SetSignals()
211 signal(SIGALRM, SIG_IGN);
212 signal(SIGHUP, InspIRCd::SetSignal);
213 signal(SIGPIPE, SIG_IGN);
214 signal(SIGCHLD, SIG_IGN);
215 /* We want E2BIG not a signal! */
216 signal(SIGXFSZ, SIG_IGN);
218 signal(SIGTERM, InspIRCd::SetSignal);
221 void InspIRCd::QuickExit(int status)
226 bool InspIRCd::DaemonSeed()
229 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
232 signal(SIGTERM, InspIRCd::QuickExit);
235 if ((childpid = fork ()) < 0)
237 else if (childpid > 0)
239 /* We wait here for the child process to kill us,
240 * so that the shell prompt doesnt come back over
242 * Sending a kill with a signal of 0 just checks
243 * if the child pid is still around. If theyre not,
244 * they threw an error and we should give up.
246 while (kill(childpid, 0) != -1)
252 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
254 signal(SIGTERM, InspIRCd::SetSignal);
257 if (getrlimit(RLIMIT_CORE, &rl) == -1)
259 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
262 rl.rlim_cur = rl.rlim_max;
264 if (setrlimit(RLIMIT_CORE, &rl) == -1)
265 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
271 void InspIRCd::WritePID(const std::string &filename)
273 std::string fname(filename);
275 fname = "data/inspircd.pid";
276 std::ofstream outfile(fname.c_str());
277 if (outfile.is_open())
284 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
285 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
286 Exit(EXIT_STATUS_PID);
290 InspIRCd::InspIRCd(int argc, char** argv) :
291 ConfigFileName("inspircd.conf"),
293 /* Functor pointer initialisation.
295 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
296 * themselves within the class.
298 NICKForced("NICKForced", NULL),
299 OperQuit("OperQuit", NULL),
300 IsChannel(&HandleIsChannel),
302 Rehash(&HandleRehash),
303 IsNick(&HandleIsNick),
304 IsIdent(&HandleIsIdent),
305 FloodQuitUser(&HandleFloodQuitUser)
308 // Strict, frequent checking of memory on debug builds
309 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
311 // Avoid erroneous frees on early exit
315 ServerInstance = this;
317 Extensions.Register(&NICKForced);
318 Extensions.Register(&OperQuit);
321 int do_version = 0, do_nofork = 0, do_debug = 0,
322 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
325 // Initialize so that if we exit before proper initialization they're not deleted
341 this->ConfigThread = NULL;
344 this->TIME = time(NULL);
346 // This must be created first, so other parts of Insp can use it while starting up
347 this->Logs = new LogManager;
349 SE = CreateSocketEngine();
351 this->Threads = new ThreadEngine;
353 /* Default implementation does nothing */
354 this->PI = new ProtocolInterface;
358 // Create base manager classes early, so nothing breaks
359 this->Users = new UserManager;
361 this->Users->unregistered_count = 0;
363 this->Users->clientlist = new user_hash();
364 this->Users->uuidlist = new user_hash();
365 this->chanlist = new chan_hash();
367 this->Config = new ServerConfig;
368 this->SNO = new SnomaskManager;
369 this->BanCache = new BanCacheManager;
370 this->Modules = new ModuleManager();
371 this->stats = new serverstats();
372 this->Timers = new TimerManager;
373 this->Parser = new CommandParser;
374 this->XLines = new XLineManager;
376 this->Config->argv = argv;
377 this->Config->argc = argc;
379 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
382 *this->LogFileName = 0;
384 struct option longopts[] =
386 { "nofork", no_argument, &do_nofork, 1 },
387 { "logfile", required_argument, NULL, 'f' },
388 { "config", required_argument, NULL, 'c' },
389 { "debug", no_argument, &do_debug, 1 },
390 { "nolog", no_argument, &do_nolog, 1 },
391 { "runasroot", no_argument, &do_root, 1 },
392 { "version", no_argument, &do_version, 1 },
393 { "testsuite", no_argument, &do_testsuite, 1 },
398 while ((c = getopt_long_only(argc, argv, ":f:", longopts, &index)) != -1)
403 /* Log filename was set */
404 strlcpy(LogFileName, optarg, MAXBUF);
407 /* Config filename was set */
408 ConfigFileName = optarg;
411 /* getopt_long_only() set an int variable, just keep going */
414 /* Unknown parameter */
416 /* Fall through to handle other weird values too */
417 printf("Unknown parameter '%s'\n", argv[optind-1]);
418 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])), " ");
419 Exit(EXIT_STATUS_ARGV);
425 do_nofork = do_debug = true;
429 printf("\n%s r%s\n", VERSION, REVISION);
430 Exit(EXIT_STATUS_NOERROR);
438 DWORD ExitCode = WindowsForkStart();
445 WSAStartup(MAKEWORD(2,0), &wsadata);
446 ChangeWindowsSpecificPointers();
449 /* Set the finished argument values */
450 Config->nofork = do_nofork;
451 Config->forcedebug = do_debug;
452 Config->writelog = !do_nolog;
453 Config->TestSuite = do_testsuite;
455 if (!this->OpenLog(argv, argc))
457 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
458 Exit(EXIT_STATUS_LOG);
461 if (!ServerConfig::FileExists(ConfigFileName.c_str()))
464 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
465 std::string txtconf = this->ConfigFileName;
466 txtconf.append(".txt");
468 if (ServerConfig::FileExists(txtconf.c_str()))
470 ConfigFileName = txtconf;
475 printf("ERROR: Cannot open config file: %s\nExiting...\n", ConfigFileName.c_str());
476 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", ConfigFileName.c_str());
477 Exit(EXIT_STATUS_CONFIG);
481 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
482 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
483 printf_c("Developers:\n");
484 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
485 printf_c("\t\033[1;32mpeavey, aquanight, psychon, dz, danieldg\033[0m\n\n");
486 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
488 this->Modes = new ModeParser;
494 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
495 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
496 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
497 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
498 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
499 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
500 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
501 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
509 if (!this->DaemonSeed())
511 printf("ERROR: could not go into daemon mode. Shutting down.\n");
512 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
513 Exit(EXIT_STATUS_FORK);
517 SE->RecoverFromFork();
519 /* During startup we don't actually initialize this
520 * in the thread engine.
522 this->Config->Read();
523 this->Config->Apply(NULL, "");
524 Logs->OpenFileLogs();
529 * Initialise SID/UID.
530 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
533 if (Config->sid.empty())
536 unsigned int sid = 0;
539 for (const char* x = Config->ServerName.c_str(); *x; ++x)
541 for (const char* y = Config->ServerDesc.c_str(); *y; ++y)
543 sprintf(sidstr, "%03d", sid % 1000);
545 Config->sid = sidstr;
548 /* set up fake client again this time with the correct uid */
549 this->FakeClient = new FakeUser("!");
550 this->FakeClient->SetFakeServer(Config->ServerName);
552 // Get XLine to do it's thing.
553 this->XLines->CheckELines();
554 this->XLines->ApplyLines();
556 int bounditems = BindPorts(pl);
560 this->Modules->LoadAll();
562 /* Just in case no modules were loaded - fix for bug #101 */
563 this->BuildISupport();
564 Config->ApplyDisabledCommands(Config->DisabledCommands);
568 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n",
569 bounditems, bounditems + (int)pl.size());
570 printf("The following port(s) failed to bind:\n");
571 printf("Hint: Try using a public IP instead of blank or *\n\n");
573 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
575 printf("%d.\tAddress: %s\tReason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
579 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n",
580 Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
585 if (kill(getppid(), SIGTERM) == -1)
587 printf("Error killing parent process: %s\n",strerror(errno));
588 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
592 if (isatty(0) && isatty(1) && isatty(2))
594 /* We didn't start from a TTY, we must have started from a background process -
595 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
598 if ((!do_nofork) && (!do_testsuite))
606 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
610 WindowsIPC = new IPC;
613 WindowsForkKillOwner();
616 /* Set win32 service as running, if we are running as a service */
620 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
623 if (!Config->SetGroup.empty())
628 ret = setgroups(0, NULL);
632 this->Logs->Log("SETGROUPS", DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
640 g = getgrnam(this->Config->SetGroup.c_str());
644 this->Logs->Log("SETGUID", DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
648 ret = setgid(g->gr_gid);
652 this->Logs->Log("SETGUID", DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
657 if (!Config->SetUser.empty())
663 u = getpwnam(this->Config->SetUser.c_str());
667 this->Logs->Log("SETGUID", DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
671 int ret = setuid(u->pw_uid);
675 this->Logs->Log("SETGUID", DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
681 this->WritePID(Config->PID);
686 /* See if we're supposed to be running the test suite rather than entering the mainloop */
687 if (Config->TestSuite)
689 TestSuite* ts = new TestSuite;
699 static time_t uptime;
700 static struct tm * stime;
701 static char window_title[100];
704 /* Check if there is a config thread which has finished executing but has not yet been freed */
705 if (this->ConfigThread && this->ConfigThread->IsDone())
707 /* Rehash has completed */
708 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
710 this->ConfigThread->Finish();
712 ConfigThread->join();
717 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
718 * Once per loop iteration is pleanty.
723 /* Run background module timers every few seconds
724 * (the docs say modules shouldnt rely on accurate
725 * timing using this event, so we dont have to
726 * time this exactly).
730 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
731 if (TIME < OLDTIME - 2)
733 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
735 else if (TIME > OLDTIME + 2)
737 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME - OLDTIME);
740 if ((TIME % 3600) == 0)
742 this->RehashUsersAndChans();
743 FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
746 Timers->TickTimers(TIME);
747 this->DoBackgroundUserStuff();
751 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
752 SNO->FlushSnotices();
755 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
756 if (!getrusage(RUSAGE_SELF, &ru))
758 gettimeofday(&this->stats->LastSampled, NULL);
759 this->stats->LastCPU = ru.ru_utime;
766 /* Call the socket engine to wait on the active
767 * file descriptors. The socket engine has everything's
768 * descriptors in its list... dns, modules, users,
769 * servers... so its nice and easy, just one call.
770 * This will cause any read or write events to be
771 * dispatched to their handlers.
773 this->SE->DispatchTrialWrites();
774 this->SE->DispatchEvents();
776 /* if any users were quit, take them out */
782 this->SignalHandler(s_signal);
790 /**********************************************************************************/
793 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
796 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
797 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
798 * registration timeout maximum seconds)
800 bool InspIRCd::AllModulesReportReady(User* user)
803 FIRST_MOD_RESULT(OnCheckReady, res, (user));
804 return (res == MOD_RES_PASSTHRU);
807 time_t InspIRCd::Time()
812 void InspIRCd::SetSignal(int signal)
817 /* On posix systems, the flow of the program starts right here, with
818 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
819 * defines smain() and the real main() is in the service code under
820 * win32service.cpp. This allows the service control manager to control
821 * the process where we are running as a windows service.
825 new InspIRCd(argc, argv);
826 mysig = &ServerInstance->s_signal;
827 ServerInstance->Run();
828 delete ServerInstance;