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)
91 void InspIRCd::Cleanup()
95 for (unsigned int i = 0; i < ports.size(); i++)
97 /* This calls the constructor and closes the listening socket */
104 /* Close all client sockets, or the new process inherits them */
105 std::vector<User*>::reverse_iterator i = Users->local_users.rbegin();
106 while (i != this->Users->local_users.rend())
109 Users->QuitUser(u, "Server shutdown");
113 Modules->UnloadAll();
115 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
116 /* Must be deleted before modes as it decrements modelines */
117 DeleteZero(this->FakeClient);
118 DeleteZero(this->Users);
119 DeleteZero(this->Modes);
120 DeleteZero(this->XLines);
121 DeleteZero(this->Parser);
122 DeleteZero(this->stats);
123 DeleteZero(this->Modules);
124 DeleteZero(this->BanCache);
125 DeleteZero(this->SNO);
126 DeleteZero(this->Config);
127 DeleteZero(this->Res);
128 DeleteZero(this->chanlist);
129 DeleteZero(this->PI);
130 DeleteZero(this->Threads);
131 DeleteZero(this->Timers);
132 DeleteZero(this->SE);
134 this->Logs->CloseLogs();
135 DeleteZero(this->Logs);
138 void InspIRCd::Restart(const std::string &reason)
140 /* SendError flushes each client's queue,
141 * regardless of writeability state
143 this->SendError(reason);
145 /* Figure out our filename (if theyve renamed it, we're boned) */
149 char module[MAX_PATH];
150 if (GetModuleFileName(NULL, module, MAX_PATH))
153 me = Config->MyDir + "/inspircd";
156 char** argv = Config->argv;
160 if (execv(me.c_str(), argv) == -1)
162 /* Will raise a SIGABRT if not trapped */
163 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
167 void InspIRCd::ResetMaxBans()
169 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
170 i->second->ResetMaxBans();
173 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
174 * we must occasionally rehash the hash (yes really).
175 * We do this by copying the entries from the old hash to a new hash, causing all
176 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
177 * very expensive, so instead we do it when the user types /REHASH and expects a
178 * short delay anyway.
180 void InspIRCd::RehashUsersAndChans()
182 user_hash* old_users = this->Users->clientlist;
183 user_hash* old_uuid = this->Users->uuidlist;
184 chan_hash* old_chans = this->chanlist;
186 this->Users->clientlist = new user_hash();
187 this->Users->uuidlist = new user_hash();
188 this->chanlist = new chan_hash();
190 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
191 this->Users->clientlist->insert(*n);
195 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
196 this->Users->uuidlist->insert(*n);
200 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
201 this->chanlist->insert(*n);
206 void InspIRCd::SetSignals()
209 signal(SIGALRM, SIG_IGN);
210 signal(SIGHUP, InspIRCd::SetSignal);
211 signal(SIGPIPE, SIG_IGN);
212 signal(SIGCHLD, SIG_IGN);
213 /* We want E2BIG not a signal! */
214 signal(SIGXFSZ, SIG_IGN);
216 signal(SIGTERM, InspIRCd::SetSignal);
219 void InspIRCd::QuickExit(int status)
224 bool InspIRCd::DaemonSeed()
227 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
230 signal(SIGTERM, InspIRCd::QuickExit);
233 if ((childpid = fork ()) < 0)
235 else if (childpid > 0)
237 /* We wait here for the child process to kill us,
238 * so that the shell prompt doesnt come back over
240 * Sending a kill with a signal of 0 just checks
241 * if the child pid is still around. If theyre not,
242 * they threw an error and we should give up.
244 while (kill(childpid, 0) != -1)
250 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
252 signal(SIGTERM, InspIRCd::SetSignal);
255 if (getrlimit(RLIMIT_CORE, &rl) == -1)
257 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
260 rl.rlim_cur = rl.rlim_max;
262 if (setrlimit(RLIMIT_CORE, &rl) == -1)
263 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
269 void InspIRCd::WritePID(const std::string &filename)
271 std::string fname(filename);
273 fname = "data/inspircd.pid";
274 std::ofstream outfile(fname.c_str());
275 if (outfile.is_open())
282 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
283 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
284 Exit(EXIT_STATUS_PID);
288 InspIRCd::InspIRCd(int argc, char** argv) :
289 ConfigFileName("inspircd.conf"),
291 /* Functor pointer initialisation.
293 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
294 * themselves within the class.
296 NICKForced("NICKForced", NULL),
297 OperQuit("OperQuit", NULL),
298 IsChannel(&HandleIsChannel),
300 Rehash(&HandleRehash),
301 IsNick(&HandleIsNick),
302 IsIdent(&HandleIsIdent),
303 FloodQuitUser(&HandleFloodQuitUser)
306 // Strict, frequent checking of memory on debug builds
307 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
309 // Avoid erroneous frees on early exit
313 ServerInstance = this;
315 Extensions.Register(&NICKForced);
316 Extensions.Register(&OperQuit);
319 int do_version = 0, do_nofork = 0, do_debug = 0,
320 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
323 // Initialize so that if we exit before proper initialization they're not deleted
339 this->ConfigThread = NULL;
342 this->TIME = time(NULL);
344 // This must be created first, so other parts of Insp can use it while starting up
345 this->Logs = new LogManager;
347 SE = CreateSocketEngine();
349 this->Threads = new ThreadEngine;
351 /* Default implementation does nothing */
352 this->PI = new ProtocolInterface;
356 // Create base manager classes early, so nothing breaks
357 this->Users = new UserManager;
359 this->Users->unregistered_count = 0;
361 this->Users->clientlist = new user_hash();
362 this->Users->uuidlist = new user_hash();
363 this->chanlist = new chan_hash();
365 this->Config = new ServerConfig;
366 this->SNO = new SnomaskManager;
367 this->BanCache = new BanCacheManager;
368 this->Modules = new ModuleManager();
369 this->stats = new serverstats();
370 this->Timers = new TimerManager;
371 this->Parser = new CommandParser;
372 this->XLines = new XLineManager;
374 this->Config->argv = argv;
375 this->Config->argc = argc;
377 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
380 *this->LogFileName = 0;
382 struct option longopts[] =
384 { "nofork", no_argument, &do_nofork, 1 },
385 { "logfile", required_argument, NULL, 'f' },
386 { "config", required_argument, NULL, 'c' },
387 { "debug", no_argument, &do_debug, 1 },
388 { "nolog", no_argument, &do_nolog, 1 },
389 { "runasroot", no_argument, &do_root, 1 },
390 { "version", no_argument, &do_version, 1 },
391 { "testsuite", no_argument, &do_testsuite, 1 },
396 while ((c = getopt_long_only(argc, argv, ":f:", longopts, &index)) != -1)
401 /* Log filename was set */
402 strlcpy(LogFileName, optarg, MAXBUF);
405 /* Config filename was set */
406 ConfigFileName = optarg;
409 /* getopt_long_only() set an int variable, just keep going */
412 /* Unknown parameter */
414 /* Fall through to handle other weird values too */
415 printf("Unknown parameter '%s'\n", argv[optind-1]);
416 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])), " ");
417 Exit(EXIT_STATUS_ARGV);
423 do_nofork = do_debug = true;
427 printf("\n%s r%s\n", VERSION, REVISION);
428 Exit(EXIT_STATUS_NOERROR);
436 DWORD ExitCode = WindowsForkStart();
443 WSAStartup(MAKEWORD(2,0), &wsadata);
444 ChangeWindowsSpecificPointers();
447 /* Set the finished argument values */
448 Config->nofork = do_nofork;
449 Config->forcedebug = do_debug;
450 Config->writelog = !do_nolog;
451 Config->TestSuite = do_testsuite;
453 if (!this->OpenLog(argv, argc))
455 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
456 Exit(EXIT_STATUS_LOG);
459 if (!ServerConfig::FileExists(ConfigFileName.c_str()))
462 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
463 std::string txtconf = this->ConfigFileName;
464 txtconf.append(".txt");
466 if (ServerConfig::FileExists(txtconf.c_str()))
468 ConfigFileName = txtconf;
473 printf("ERROR: Cannot open config file: %s\nExiting...\n", ConfigFileName.c_str());
474 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", ConfigFileName.c_str());
475 Exit(EXIT_STATUS_CONFIG);
479 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
480 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
481 printf_c("Developers:\n");
482 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
483 printf_c("\t\033[1;32mpeavey, aquanight, psychon, dz, danieldg\033[0m\n\n");
484 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
486 this->Modes = new ModeParser;
492 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
493 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
494 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
495 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
496 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
497 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
498 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
499 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
507 if (!this->DaemonSeed())
509 printf("ERROR: could not go into daemon mode. Shutting down.\n");
510 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
511 Exit(EXIT_STATUS_FORK);
515 SE->RecoverFromFork();
517 /* During startup we don't actually initialize this
518 * in the thread engine.
520 this->Config->Read();
521 this->Config->Apply(NULL, "");
522 Logs->OpenFileLogs();
527 * Initialise SID/UID.
528 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
531 if (Config->sid.empty())
534 unsigned int sid = 0;
537 for (const char* x = Config->ServerName.c_str(); *x; ++x)
539 for (const char* y = Config->ServerDesc.c_str(); *y; ++y)
541 sprintf(sidstr, "%03d", sid % 1000);
543 Config->sid = sidstr;
546 /* set up fake client again this time with the correct uid */
547 this->FakeClient = new FakeUser("!");
548 this->FakeClient->SetFakeServer(Config->ServerName);
550 // Get XLine to do it's thing.
551 this->XLines->CheckELines();
552 this->XLines->ApplyLines();
554 int bounditems = BindPorts(pl);
558 this->Modules->LoadAll();
560 /* Just in case no modules were loaded - fix for bug #101 */
561 this->BuildISupport();
562 Config->ApplyDisabledCommands(Config->DisabledCommands);
566 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n",
567 bounditems, bounditems + (int)pl.size());
568 printf("The following port(s) failed to bind:\n");
569 printf("Hint: Try using a public IP instead of blank or *\n\n");
571 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
573 printf("%d.\tAddress: %s\tReason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
577 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n",
578 Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
583 if (kill(getppid(), SIGTERM) == -1)
585 printf("Error killing parent process: %s\n",strerror(errno));
586 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
590 if (isatty(0) && isatty(1) && isatty(2))
592 /* We didn't start from a TTY, we must have started from a background process -
593 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
596 if ((!do_nofork) && (!do_testsuite))
604 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
608 WindowsIPC = new IPC;
611 WindowsForkKillOwner();
614 /* Set win32 service as running, if we are running as a service */
618 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
621 if (!Config->SetGroup.empty())
626 ret = setgroups(0, NULL);
630 this->Logs->Log("SETGROUPS", DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
638 g = getgrnam(this->Config->SetGroup.c_str());
642 this->Logs->Log("SETGUID", DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
646 ret = setgid(g->gr_gid);
650 this->Logs->Log("SETGUID", DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
655 if (!Config->SetUser.empty())
661 u = getpwnam(this->Config->SetUser.c_str());
665 this->Logs->Log("SETGUID", DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
669 int ret = setuid(u->pw_uid);
673 this->Logs->Log("SETGUID", DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
679 this->WritePID(Config->PID);
684 /* See if we're supposed to be running the test suite rather than entering the mainloop */
685 if (Config->TestSuite)
687 TestSuite* ts = new TestSuite;
697 static time_t uptime;
698 static struct tm * stime;
699 static char window_title[100];
702 /* Check if there is a config thread which has finished executing but has not yet been freed */
703 if (this->ConfigThread && this->ConfigThread->IsDone())
705 /* Rehash has completed */
706 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
708 this->ConfigThread->Finish();
710 ConfigThread->join();
715 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
716 * Once per loop iteration is pleanty.
721 /* Run background module timers every few seconds
722 * (the docs say modules shouldnt rely on accurate
723 * timing using this event, so we dont have to
724 * time this exactly).
728 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
729 if (TIME < OLDTIME - 2)
731 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
733 else if (TIME > OLDTIME + 2)
735 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME - OLDTIME);
738 if ((TIME % 3600) == 0)
740 this->RehashUsersAndChans();
741 FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
744 Timers->TickTimers(TIME);
745 this->DoBackgroundUserStuff();
749 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
750 SNO->FlushSnotices();
753 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
754 if (!getrusage(RUSAGE_SELF, &ru))
756 gettimeofday(&this->stats->LastSampled, NULL);
757 this->stats->LastCPU = ru.ru_utime;
764 /* Call the socket engine to wait on the active
765 * file descriptors. The socket engine has everything's
766 * descriptors in its list... dns, modules, users,
767 * servers... so its nice and easy, just one call.
768 * This will cause any read or write events to be
769 * dispatched to their handlers.
771 this->SE->DispatchTrialWrites();
772 this->SE->DispatchEvents();
774 /* if any users were quit, take them out */
780 this->SignalHandler(s_signal);
788 /**********************************************************************************/
791 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
794 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
795 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
796 * registration timeout maximum seconds)
798 bool InspIRCd::AllModulesReportReady(User* user)
801 FIRST_MOD_RESULT(OnCheckReady, res, (user));
802 return (res == MOD_RES_PASSTHRU);
805 time_t InspIRCd::Time()
810 void InspIRCd::SetSignal(int signal)
815 /* On posix systems, the flow of the program starts right here, with
816 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
817 * defines smain() and the real main() is in the service code under
818 * win32service.cpp. This allows the service control manager to control
819 * the process where we are running as a windows service.
823 new InspIRCd(argc, argv);
824 mysig = &ServerInstance->s_signal;
825 ServerInstance->Run();
826 delete ServerInstance;