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");
114 /* We do this more than once, so that any service providers get a
115 * chance to be unhooked by the modules using them, but then get
116 * a chance to be removed themsleves.
118 * XXX there may be a better way to do this
120 for (int tries = 0; tries < 4; tries++)
122 std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
123 for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
125 /* Unload all modules, so they get a chance to clean up their listeners */
126 this->Modules->Unload(k->c_str());
131 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
132 /* Must be deleted before modes as it decrements modelines */
133 DeleteZero(this->FakeClient);
134 DeleteZero(this->Users);
135 DeleteZero(this->Modes);
136 DeleteZero(this->XLines);
137 DeleteZero(this->Parser);
138 DeleteZero(this->stats);
139 DeleteZero(this->Modules);
140 DeleteZero(this->BanCache);
141 DeleteZero(this->SNO);
142 DeleteZero(this->Config);
143 DeleteZero(this->Res);
144 DeleteZero(this->chanlist);
145 DeleteZero(this->PI);
146 DeleteZero(this->Threads);
147 DeleteZero(this->Timers);
148 DeleteZero(this->SE);
150 this->Logs->CloseLogs();
151 DeleteZero(this->Logs);
154 void InspIRCd::Restart(const std::string &reason)
156 /* SendError flushes each client's queue,
157 * regardless of writeability state
159 this->SendError(reason);
161 /* Figure out our filename (if theyve renamed it, we're boned) */
165 char module[MAX_PATH];
166 if (GetModuleFileName(NULL, module, MAX_PATH))
169 me = Config->MyDir + "/inspircd";
172 char** argv = Config->argv;
176 if (execv(me.c_str(), argv) == -1)
178 /* Will raise a SIGABRT if not trapped */
179 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
183 void InspIRCd::ResetMaxBans()
185 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
186 i->second->ResetMaxBans();
189 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
190 * we must occasionally rehash the hash (yes really).
191 * We do this by copying the entries from the old hash to a new hash, causing all
192 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
193 * very expensive, so instead we do it when the user types /REHASH and expects a
194 * short delay anyway.
196 void InspIRCd::RehashUsersAndChans()
198 user_hash* old_users = this->Users->clientlist;
199 user_hash* old_uuid = this->Users->uuidlist;
200 chan_hash* old_chans = this->chanlist;
202 this->Users->clientlist = new user_hash();
203 this->Users->uuidlist = new user_hash();
204 this->chanlist = new chan_hash();
206 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
207 this->Users->clientlist->insert(*n);
211 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
212 this->Users->uuidlist->insert(*n);
216 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
217 this->chanlist->insert(*n);
222 void InspIRCd::SetSignals()
225 signal(SIGALRM, SIG_IGN);
226 signal(SIGHUP, InspIRCd::SetSignal);
227 signal(SIGPIPE, SIG_IGN);
228 signal(SIGCHLD, SIG_IGN);
229 /* We want E2BIG not a signal! */
230 signal(SIGXFSZ, SIG_IGN);
232 signal(SIGTERM, InspIRCd::SetSignal);
235 void InspIRCd::QuickExit(int status)
240 bool InspIRCd::DaemonSeed()
243 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
246 signal(SIGTERM, InspIRCd::QuickExit);
249 if ((childpid = fork ()) < 0)
251 else if (childpid > 0)
253 /* We wait here for the child process to kill us,
254 * so that the shell prompt doesnt come back over
256 * Sending a kill with a signal of 0 just checks
257 * if the child pid is still around. If theyre not,
258 * they threw an error and we should give up.
260 while (kill(childpid, 0) != -1)
266 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
268 signal(SIGTERM, InspIRCd::SetSignal);
271 if (getrlimit(RLIMIT_CORE, &rl) == -1)
273 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
278 rl.rlim_cur = rl.rlim_max;
279 if (setrlimit(RLIMIT_CORE, &rl) == -1)
280 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
287 void InspIRCd::WritePID(const std::string &filename)
289 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
290 std::replace(fname.begin(), fname.end(), '\\', '/');
291 if ((fname[0] != '/') && (!Config->StartsWithWindowsDriveLetter(filename)))
293 std::string::size_type pos;
294 std::string confpath = this->ConfigFileName;
295 if ((pos = confpath.rfind("/")) != std::string::npos)
297 /* Leaves us with just the path */
298 fname = confpath.substr(0, pos) + std::string("/") + fname;
301 std::ofstream outfile(fname.c_str());
302 if (outfile.is_open())
309 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
310 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
311 Exit(EXIT_STATUS_PID);
315 InspIRCd::InspIRCd(int argc, char** argv) :
316 ConfigFileName("inspircd.conf"),
318 /* Functor pointer initialisation.
320 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
321 * themselves within the class.
323 IsChannel(&HandleIsChannel),
325 Rehash(&HandleRehash),
326 IsNick(&HandleIsNick),
327 IsIdent(&HandleIsIdent),
328 FloodQuitUser(&HandleFloodQuitUser)
332 // Strict, frequent checking of memory on debug builds
333 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
335 // Avoid erroneous frees on early exit
339 ServerInstance = this;
341 Extensible::Register(&User::NICKForced);
342 Extensible::Register(&User::OperQuit);
345 int do_version = 0, do_nofork = 0, do_debug = 0,
346 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
349 // Initialize so that if we exit before proper initialization they're not deleted
365 this->ConfigThread = NULL;
368 this->TIME = time(NULL);
370 // This must be created first, so other parts of Insp can use it while starting up
371 this->Logs = new LogManager;
373 SE = CreateSocketEngine();
375 this->Threads = new ThreadEngine;
377 /* Default implementation does nothing */
378 this->PI = new ProtocolInterface;
382 // Create base manager classes early, so nothing breaks
383 this->Users = new UserManager;
385 this->Users->unregistered_count = 0;
387 this->Users->clientlist = new user_hash();
388 this->Users->uuidlist = new user_hash();
389 this->chanlist = new chan_hash();
391 this->Config = new ServerConfig;
392 this->SNO = new SnomaskManager;
393 this->BanCache = new BanCacheManager;
394 this->Modules = new ModuleManager();
395 this->stats = new serverstats();
396 this->Timers = new TimerManager;
397 this->Parser = new CommandParser;
398 this->XLines = new XLineManager;
400 this->Config->argv = argv;
401 this->Config->argc = argc;
403 if (chdir(Config->GetFullProgDir().c_str()))
405 printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
409 this->Config->opertypes.clear();
410 this->Config->operclass.clear();
412 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
415 *this->LogFileName = 0;
417 struct option longopts[] =
419 { "nofork", no_argument, &do_nofork, 1 },
420 { "logfile", required_argument, NULL, 'f' },
421 { "config", required_argument, NULL, 'c' },
422 { "debug", no_argument, &do_debug, 1 },
423 { "nolog", no_argument, &do_nolog, 1 },
424 { "runasroot", no_argument, &do_root, 1 },
425 { "version", no_argument, &do_version, 1 },
426 { "testsuite", no_argument, &do_testsuite, 1 },
431 while ((c = getopt_long_only(argc, argv, ":f:", longopts, &index)) != -1)
436 /* Log filename was set */
437 strlcpy(LogFileName, optarg, MAXBUF);
440 /* Config filename was set */
441 ConfigFileName = optarg;
444 /* getopt_long_only() set an int variable, just keep going */
447 /* Unknown parameter */
449 /* Fall through to handle other weird values too */
450 printf("Unknown parameter '%s'\n", argv[optind-1]);
451 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])), " ");
452 Exit(EXIT_STATUS_ARGV);
458 do_nofork = do_debug = true;
462 printf("\n%s r%s\n", VERSION, REVISION);
463 Exit(EXIT_STATUS_NOERROR);
471 DWORD ExitCode = WindowsForkStart();
478 WSAStartup(MAKEWORD(2,0), &wsadata);
479 ChangeWindowsSpecificPointers();
481 Config->MyExecutable = argv[0];
483 /* Set the finished argument values */
484 Config->nofork = do_nofork;
485 Config->forcedebug = do_debug;
486 Config->writelog = !do_nolog;
487 Config->TestSuite = do_testsuite;
489 if (!this->OpenLog(argv, argc))
491 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
492 Exit(EXIT_STATUS_LOG);
495 if (!ServerConfig::FileExists(ConfigFileName.c_str()))
498 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
499 std::string txtconf = this->ConfigFileName;
500 txtconf.append(".txt");
502 if (ServerConfig::FileExists(txtconf.c_str()))
504 ConfigFileName = txtconf;
509 printf("ERROR: Cannot open config file: %s\nExiting...\n", ConfigFileName.c_str());
510 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", ConfigFileName.c_str());
511 Exit(EXIT_STATUS_CONFIG);
515 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
516 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
517 printf_c("Developers:\n");
518 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
519 printf_c("\t\033[1;32mpeavey, aquanight, psychon, dz, danieldg\033[0m\n\n");
520 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
522 this->Modes = new ModeParser;
528 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
529 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
530 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
531 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
532 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
533 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
534 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
535 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
543 if (!this->DaemonSeed())
545 printf("ERROR: could not go into daemon mode. Shutting down.\n");
546 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
547 Exit(EXIT_STATUS_FORK);
551 SE->RecoverFromFork();
553 /* During startup we don't actually initialize this
554 * in the thread engine.
556 this->Config->Read();
557 this->Config->Apply(NULL, "");
558 Logs->OpenFileLogs();
563 * Initialise SID/UID.
564 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
567 if (Config->sid.empty())
572 for (const char* x = Config->ServerName.c_str(); *x; ++x)
574 for (const char* y = Config->ServerDesc.c_str(); *y; ++y)
578 Config->sid = ConvToStr(sid);
581 /* set up fake client again this time with the correct uid */
582 this->FakeClient = new FakeUser("!");
583 this->FakeClient->SetFakeServer(Config->ServerName);
585 // Get XLine to do it's thing.
586 this->XLines->CheckELines();
587 this->XLines->ApplyLines();
589 int bounditems = BindPorts(pl);
593 this->Modules->LoadAll();
595 /* Just in case no modules were loaded - fix for bug #101 */
596 this->BuildISupport();
597 Config->ApplyDisabledCommands(Config->DisabledCommands);
601 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n",
602 bounditems, bounditems + (int)pl.size());
603 printf("The following port(s) failed to bind:\n");
604 printf("Hint: Try using a public IP instead of blank or *\n\n");
606 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
608 printf("%d.\tAddress: %s\tReason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
612 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n",
613 Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
618 if (kill(getppid(), SIGTERM) == -1)
620 printf("Error killing parent process: %s\n",strerror(errno));
621 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
625 if (isatty(0) && isatty(1) && isatty(2))
627 /* We didn't start from a TTY, we must have started from a background process -
628 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
631 if ((!do_nofork) && (!do_testsuite))
639 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
643 WindowsIPC = new IPC;
646 WindowsForkKillOwner();
649 /* Set win32 service as running, if we are running as a service */
653 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
656 if (!Config->SetGroup.empty())
661 ret = setgroups(0, NULL);
665 this->Logs->Log("SETGROUPS", DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
673 g = getgrnam(this->Config->SetGroup.c_str());
677 this->Logs->Log("SETGUID", DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
681 ret = setgid(g->gr_gid);
685 this->Logs->Log("SETGUID", DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
690 if (!Config->SetUser.empty())
696 u = getpwnam(this->Config->SetUser.c_str());
700 this->Logs->Log("SETGUID", DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
704 int ret = setuid(u->pw_uid);
708 this->Logs->Log("SETGUID", DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
714 this->WritePID(Config->PID);
719 /* See if we're supposed to be running the test suite rather than entering the mainloop */
720 if (Config->TestSuite)
722 TestSuite* ts = new TestSuite;
732 static time_t uptime;
733 static struct tm * stime;
734 static char window_title[100];
737 /* Check if there is a config thread which has finished executing but has not yet been freed */
738 if (this->ConfigThread && this->ConfigThread->IsDone())
740 /* Rehash has completed */
741 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
743 this->ConfigThread->Finish();
745 ConfigThread->join();
750 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
751 * Once per loop iteration is pleanty.
756 /* Run background module timers every few seconds
757 * (the docs say modules shouldnt rely on accurate
758 * timing using this event, so we dont have to
759 * time this exactly).
763 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
764 if (TIME < OLDTIME - 2)
766 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
768 else if (TIME > OLDTIME + 2)
770 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME - OLDTIME);
773 if ((TIME % 3600) == 0)
775 this->RehashUsersAndChans();
776 FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
779 Timers->TickTimers(TIME);
780 this->DoBackgroundUserStuff();
784 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
785 SNO->FlushSnotices();
788 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
789 if (!getrusage(RUSAGE_SELF, &ru))
791 gettimeofday(&this->stats->LastSampled, NULL);
792 this->stats->LastCPU = ru.ru_utime;
799 /* Call the socket engine to wait on the active
800 * file descriptors. The socket engine has everything's
801 * descriptors in its list... dns, modules, users,
802 * servers... so its nice and easy, just one call.
803 * This will cause any read or write events to be
804 * dispatched to their handlers.
806 this->SE->DispatchTrialWrites();
807 this->SE->DispatchEvents();
809 /* if any users were quit, take them out */
810 this->GlobalCulls.Apply();
814 this->SignalHandler(s_signal);
822 /**********************************************************************************/
825 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
828 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
829 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
830 * registration timeout maximum seconds)
832 bool InspIRCd::AllModulesReportReady(User* user)
835 FIRST_MOD_RESULT(OnCheckReady, res, (user));
836 return (res == MOD_RES_PASSTHRU);
839 time_t InspIRCd::Time()
844 void InspIRCd::SetSignal(int signal)
849 /* On posix systems, the flow of the program starts right here, with
850 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
851 * defines smain() and the real main() is in the service code under
852 * win32service.cpp. This allows the service control manager to control
853 * the process where we are running as a windows service.
857 new InspIRCd(argc, argv);
858 mysig = &ServerInstance->s_signal;
859 ServerInstance->Run();
860 delete ServerInstance;