1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* $Install: src/inspircd $(BINPATH) */
22 #include <sys/resource.h>
26 /* Some systems don't define RUSAGE_SELF. This should fix them. */
35 #include "socketengine.h"
36 #include "inspircd_se_config.h"
38 #include "command_parse.h"
39 #include "exitcodes.h"
41 #include "testsuite.h"
43 using irc::sockets::insp_ntoa;
44 using irc::sockets::insp_inaddr;
45 using irc::sockets::insp_sockaddr;
51 /* Burlex: Moved from exitcodes.h -- due to duplicate symbols */
52 const char* ExitCodes[] =
55 "DIE command", /* 1 */
56 "execv() failed", /* 2 */
57 "Internal error", /* 3 */
58 "Config file error", /* 4 */
59 "Logfile error", /* 5 */
60 "POSIX fork failed", /* 6 */
61 "Bad commandline parameters", /* 7 */
62 "No ports could be bound", /* 8 */
63 "Can't write PID file", /* 9 */
64 "SocketEngine could not initialize", /* 10 */
65 "Refusing to start up as root", /* 11 */
66 "Found a <die> tag!", /* 12 */
67 "Couldn't load module on startup", /* 13 */
68 "Could not create windows forked process", /* 14 */
69 "Received SIGTERM", /* 15 */
72 void InspIRCd::Cleanup()
76 for (unsigned int i = 0; i < Config->ports.size(); i++)
78 /* This calls the constructor and closes the listening socket */
79 delete Config->ports[i];
82 Config->ports.clear();
85 /* Close all client sockets, or the new process inherits them */
86 for (std::vector<User*>::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
88 (*i)->SetWriteError("Server shutdown");
92 /* We do this more than once, so that any service providers get a
93 * chance to be unhooked by the modules using them, but then get
94 * a chance to be removed themsleves.
96 * XXX there may be a better way to do this with 1.2
98 for (int tries = 0; tries < 3; tries++)
100 std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
101 for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
103 /* Unload all modules, so they get a chance to clean up their listeners */
104 this->Modules->Unload(k->c_str());
109 this->Logs->CloseLogs();
111 /* Cleanup Server Names */
112 for(servernamelist::iterator itr = servernames.begin(); itr != servernames.end(); ++itr)
118 void InspIRCd::Restart(const std::string &reason)
120 /* SendError flushes each client's queue,
121 * regardless of writeability state
123 this->SendError(reason);
127 /* Figure out our filename (if theyve renamed it, we're boned) */
131 char module[MAX_PATH];
132 if (GetModuleFileName(NULL, module, MAX_PATH))
135 me = Config->MyDir + "/inspircd";
138 if (execv(me.c_str(), Config->argv) == -1)
140 /* Will raise a SIGABRT if not trapped */
141 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
145 void InspIRCd::ResetMaxBans()
147 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
148 i->second->ResetMaxBans();
151 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
152 * we must occasionally rehash the hash (yes really).
153 * We do this by copying the entries from the old hash to a new hash, causing all
154 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
155 * very expensive, so instead we do it when the user types /REHASH and expects a
156 * short delay anyway.
158 void InspIRCd::RehashUsersAndChans()
160 user_hash* old_users = this->Users->clientlist;
161 user_hash* old_uuid = this->Users->uuidlist;
162 chan_hash* old_chans = this->chanlist;
164 this->Users->clientlist = new user_hash();
165 this->Users->uuidlist = new user_hash();
166 this->chanlist = new chan_hash();
168 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
169 this->Users->clientlist->insert(*n);
173 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
174 this->Users->uuidlist->insert(*n);
178 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
179 this->chanlist->insert(*n);
184 void InspIRCd::SetSignals()
187 signal(SIGALRM, SIG_IGN);
188 signal(SIGHUP, InspIRCd::SetSignal);
189 signal(SIGPIPE, SIG_IGN);
190 signal(SIGCHLD, SIG_IGN);
192 signal(SIGTERM, InspIRCd::SetSignal);
195 void InspIRCd::QuickExit(int status)
200 bool InspIRCd::DaemonSeed()
203 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
206 signal(SIGTERM, InspIRCd::QuickExit);
209 if ((childpid = fork ()) < 0)
211 else if (childpid > 0)
213 /* We wait here for the child process to kill us,
214 * so that the shell prompt doesnt come back over
216 * Sending a kill with a signal of 0 just checks
217 * if the child pid is still around. If theyre not,
218 * they threw an error and we should give up.
220 while (kill(childpid, 0) != -1)
226 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
228 signal(SIGTERM, InspIRCd::SetSignal);
231 if (getrlimit(RLIMIT_CORE, &rl) == -1)
233 this->Log(DEFAULT,"Failed to getrlimit()!");
238 rl.rlim_cur = rl.rlim_max;
239 if (setrlimit(RLIMIT_CORE, &rl) == -1)
240 this->Log(DEFAULT,"setrlimit() failed, cannot increase coredump size.");
247 void InspIRCd::WritePID(const std::string &filename)
249 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
250 if (*(fname.begin()) != '/')
252 std::string::size_type pos;
253 std::string confpath = this->ConfigFileName;
254 if ((pos = confpath.rfind("/")) != std::string::npos)
256 /* Leaves us with just the path */
257 fname = confpath.substr(0, pos) + std::string("/") + fname;
260 std::ofstream outfile(fname.c_str());
261 if (outfile.is_open())
268 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
269 this->Log(DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
270 Exit(EXIT_STATUS_PID);
274 InspIRCd::InspIRCd(int argc, char** argv)
277 /* Functor initialisation. Note that the ordering here is very important. */
278 HandleProcessUser(this),
281 HandleFindDescriptor(this),
282 HandleFloodQuitUser(this),
284 /* Functor pointer initialisation. Must match the order of the list above */
285 ProcessUser(&HandleProcessUser),
286 IsNick(&HandleIsNick),
287 IsIdent(&HandleIsIdent),
288 FindDescriptor(&HandleFindDescriptor),
289 FloodQuitUser(&HandleFloodQuitUser)
295 int do_version = 0, do_nofork = 0, do_debug = 0,
296 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
299 memset(&server, 0, sizeof(server));
300 memset(&client, 0, sizeof(client));
302 // This must be created first, so other parts of Insp can use it while starting up
303 this->Logs = new LogManager(this);
305 SocketEngineFactory* SEF = new SocketEngineFactory();
306 SE = SEF->Create(this);
311 // Create base manager classes early, so nothing breaks
312 this->Users = new UserManager(this);
314 this->Users->unregistered_count = 0;
316 this->Users->clientlist = new user_hash();
317 this->Users->uuidlist = new user_hash();
318 this->chanlist = new chan_hash();
322 this->Config = new ServerConfig(this);
323 this->SNO = new SnomaskManager(this);
324 this->BanCache = new BanCacheManager(this);
325 this->Modules = new ModuleManager(this);
326 this->stats = new serverstats();
327 this->Timers = new TimerManager(this);
328 this->Parser = new CommandParser(this);
329 this->XLines = new XLineManager(this);
331 this->Config->argv = argv;
332 this->Config->argc = argc;
334 if (chdir(Config->GetFullProgDir().c_str()))
336 printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
340 this->Config->opertypes.clear();
341 this->Config->operclass.clear();
343 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
346 *this->LogFileName = 0;
347 strlcpy(this->ConfigFileName, CONFIG_FILE, MAXBUF);
349 struct option longopts[] =
351 { "nofork", no_argument, &do_nofork, 1 },
352 { "logfile", required_argument, NULL, 'f' },
353 { "config", required_argument, NULL, 'c' },
354 { "debug", no_argument, &do_debug, 1 },
355 { "nolog", no_argument, &do_nolog, 1 },
356 { "runasroot", no_argument, &do_root, 1 },
357 { "version", no_argument, &do_version, 1 },
358 { "testsuite", no_argument, &do_testsuite, 1 },
362 while ((c = getopt_long_only(argc, argv, ":f:", longopts, NULL)) != -1)
367 /* Log filename was set */
368 strlcpy(LogFileName, optarg, MAXBUF);
371 /* Config filename was set */
372 strlcpy(ConfigFileName, optarg, MAXBUF);
375 /* getopt_long_only() set an int variable, just keep going */
378 /* Unknown parameter! DANGER, INTRUDER.... err.... yeah. */
379 printf("Usage: %s [--nofork] [--nolog] [--debug] [--logfile <filename>]\n\
380 [--runasroot] [--version] [--config <config>] [--testsuite]\n", argv[0]);
381 Exit(EXIT_STATUS_ARGV);
387 do_nofork = do_debug = true;
391 printf("\n%s r%s\n", VERSION, REVISION);
392 Exit(EXIT_STATUS_NOERROR);
400 DWORD ExitCode = WindowsForkStart(this);
407 WSAStartup(MAKEWORD(2,0), &wsadata);
408 ChangeWindowsSpecificPointers(this);
410 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
412 /* Set the finished argument values */
413 Config->nofork = do_nofork;
414 Config->forcedebug = do_debug;
415 Config->writelog = !do_nolog;
416 Config->TestSuite = do_testsuite;
418 if (!this->OpenLog(argv, argc))
420 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
421 Exit(EXIT_STATUS_LOG);
424 if (!ServerConfig::FileExists(this->ConfigFileName))
426 printf("ERROR: Cannot open config file: %s\nExiting...\n", this->ConfigFileName);
427 this->Log(DEFAULT,"Unable to open config file %s", this->ConfigFileName);
428 Exit(EXIT_STATUS_CONFIG);
431 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
432 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
433 printf_c("Developers:\n");
434 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
435 printf_c("\t\033[1;32mpippijn, peavey, aquanight, fez\033[0m\n\n");
436 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
438 Config->ClearStack();
440 this->Modes = new ModeParser(this);
442 /* set up fake client (uid is incorrect at this point,
443 * until after config is read. we set up the user again
446 this->FakeClient = new User(this);
447 this->FakeClient->SetFd(FD_MAGIC_NUMBER);
453 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
454 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
455 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
456 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
457 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
458 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
459 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
460 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
468 if (!this->DaemonSeed())
470 printf("ERROR: could not go into daemon mode. Shutting down.\n");
471 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
472 Exit(EXIT_STATUS_FORK);
476 SE->RecoverFromFork();
478 /* Read config, pass 0. At the end if this pass,
479 * the Config->IncludeFiles is populated, we call
480 * Config->StartDownloads to initialize the downlaods of all
483 Config->Read(true, NULL, 0);
484 Config->DoDownloads();
485 /* We have all the files we can get, initiate pass 1 */
486 Config->Read(true, NULL, 1);
488 this->AddServerName(Config->ServerName);
491 * Initialise SID/UID.
492 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
503 for (const char* x = Config->ServerName; *x; ++x)
505 for (const char* y = Config->ServerDesc; *y; ++y)
509 Config->sid[0] = (char)(sid / 100 + 48);
510 Config->sid[1] = (char)(((sid / 10) % 10) + 48);
511 Config->sid[2] = (char)(sid % 10 + 48);
514 this->InitialiseUID();
516 /* set up fake client again this time with the correct uid */
518 this->FakeClient = new User(this);
519 this->FakeClient->SetFd(FD_MAGIC_NUMBER);
521 // Get XLine to do it's thing.
522 this->XLines->CheckELines();
523 this->XLines->ApplyLines();
527 int bounditems = BindPorts(true, found_ports, pl);
531 /*this->Modules->LoadAll();*/
533 /* Just in case no modules were loaded - fix for bug #101 */
534 this->BuildISupport();
535 InitializeDisabledCommands(Config->DisabledCommands, this);
537 if ((Config->ports.size() == 0) && (found_ports > 0))
539 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
540 Logs->Log("STARTUP", DEFAULT,"ERROR: I couldn't bind any ports! Something else is bound to those ports!");
541 Exit(EXIT_STATUS_BIND);
544 if (Config->ports.size() != (unsigned int)found_ports)
546 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n", bounditems, found_ports);
547 printf("The following port(s) failed to bind:\n");
549 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
551 printf("%d.\tIP: %s\tPort: %lu\n", j, i->first.empty() ? "<all>" : i->first.c_str(), (unsigned long)i->second);
557 if (kill(getppid(), SIGTERM) == -1)
559 printf("Error killing parent process: %s\n",strerror(errno));
560 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
564 if (isatty(0) && isatty(1) && isatty(2))
566 /* We didn't start from a TTY, we must have started from a background process -
567 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
578 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
582 WindowsIPC = new IPC(this);
585 WindowsForkKillOwner(this);
590 printf("\nInspIRCd is now running as '%s'[%s]\n", Config->ServerName,Config->GetSID().c_str());
591 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s]", Config->ServerName,Config->GetSID().c_str());
593 this->WritePID(Config->PID);
596 /* moved to a function, as UID generation can call this also */
597 void InspIRCd::InitialiseUID()
601 current_uid[0] = Config->sid[0];
602 current_uid[1] = Config->sid[1];
603 current_uid[2] = Config->sid[2];
606 for(i = 3; i < UUID_LENGTH - 1; i++)
607 current_uid[i] = 'A';
609 current_uid[UUID_LENGTH] = '\0';
614 /* See if we're supposed to be running the test suite rather than entering the mainloop */
615 if (Config->TestSuite)
617 TestSuite* ts = new TestSuite(this);
627 static time_t uptime;
628 static struct tm * stime;
629 static char window_title[100];
632 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
633 * Once per loop iteration is pleanty.
638 /* Run background module timers every few seconds
639 * (the docs say modules shouldnt rely on accurate
640 * timing using this event, so we dont have to
641 * time this exactly).
647 SNO->WriteToSnoMask('A', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
650 if ((TIME % 3600) == 0)
652 this->RehashUsersAndChans();
653 FOREACH_MOD_I(this, I_OnGarbageCollect, OnGarbageCollect());
656 Timers->TickTimers(TIME);
657 this->DoBackgroundUserStuff();
661 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
662 SNO->FlushSnotices();
665 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
666 if (!getrusage(RUSAGE_SELF, &ru))
668 gettimeofday(&this->stats->LastSampled, NULL);
669 this->stats->LastCPU = ru.ru_utime;
676 /* Call the socket engine to wait on the active
677 * file descriptors. The socket engine has everything's
678 * descriptors in its list... dns, modules, users,
679 * servers... so its nice and easy, just one call.
680 * This will cause any read or write events to be
681 * dispatched to their handlers.
683 this->SE->DispatchEvents();
685 /* if any users were quit, take them out */
686 this->GlobalCulls.Apply();
688 /* If any inspsockets closed, remove them */
689 this->BufferedSocketCull();
693 this->SignalHandler(s_signal);
701 void InspIRCd::BufferedSocketCull()
703 for (std::map<BufferedSocket*,BufferedSocket*>::iterator x = SocketCull.begin(); x != SocketCull.end(); ++x)
705 Log(DEBUG,"Cull socket");
706 SE->DelFd(x->second);
713 /**********************************************************************************/
716 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
719 int main(int argc, char ** argv)
721 SI = new InspIRCd(argc, argv);
722 mysig = &SI->s_signal;
728 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
729 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
730 * registration timeout maximum seconds)
732 bool InspIRCd::AllModulesReportReady(User* user)
734 for (EventHandlerIter i = Modules->EventHandlers[I_OnCheckReady].begin(); i != Modules->EventHandlers[I_OnCheckReady].end(); ++i)
736 int res = (*i)->OnCheckReady(user);
744 time_t InspIRCd::Time()
749 void InspIRCd::SetSignal(int signal)