-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
+ * Copyright (C) 2013, 2017-2021 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013 Adam <Adam@anope.org>
+ * Copyright (C) 2012-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012-2013 ChrisTX <xpipe@hotmail.de>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2012 Ariadne Conill <ariadne@dereferenced.org>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008-2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007 Oliver Lupton <om@inspircd.org>
+ * Copyright (C) 2005-2010 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/* $Install: src/inspircd $(BINPATH) */
#include "inspircd.h"
#include <signal.h>
-#ifndef WIN32
- #include <dirent.h>
+#ifndef _WIN32
#include <unistd.h>
#include <sys/resource.h>
- #include <dlfcn.h>
#include <getopt.h>
+ #include <pwd.h> // setuid
+ #include <grp.h> // setgid
+#else
+ /** Manages formatting lines written to stderr on Windows. */
+ WindowsStream StandardError(STD_ERROR_HANDLE);
- /* Some systems don't define RUSAGE_SELF. This should fix them. */
- #ifndef RUSAGE_SELF
- #define RUSAGE_SELF 0
- #endif
+ /** Manages formatting lines written to stdout on Windows. */
+ WindowsStream StandardOutput(STD_OUTPUT_HANDLE);
#endif
#include <fstream>
+#include <iostream>
#include "xline.h"
-#include "bancache.h"
-#include "socketengine.h"
-#include "inspircd_se_config.h"
-#include "socket.h"
-#include "command_parse.h"
#include "exitcodes.h"
-#include "caller.h"
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_inaddr;
-using irc::sockets::insp_sockaddr;
+InspIRCd* ServerInstance = NULL;
-InspIRCd* SI = NULL;
-int* mysig = NULL;
+/** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
+ * if it must.
+ *
+ * This is provided as a pointer so that modules can change it to their custom mapping tables,
+ * e.g. for national character support.
+ */
+unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
-/* Burlex: Moved from exitcodes.h -- due to duplicate symbols */
+/* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
+ * XXX this is a bit ugly. -- w00t
+ */
const char* ExitCodes[] =
{
- "No error", /* 0 */
- "DIE command", /* 1 */
- "execv() failed", /* 2 */
- "Internal error", /* 3 */
- "Config file error", /* 4 */
- "Logfile error", /* 5 */
- "POSIX fork failed", /* 6 */
- "Bad commandline parameters", /* 7 */
- "No ports could be bound", /* 8 */
- "Can't write PID file", /* 9 */
- "SocketEngine could not initialize", /* 10 */
- "Refusing to start up as root", /* 11 */
- "Found a <die> tag!", /* 12 */
- "Couldn't load module on startup", /* 13 */
- "Could not create windows forked process", /* 14 */
- "Received SIGTERM", /* 15 */
+ "No error", // 0
+ "DIE command", // 1
+ "Config file error", // 2
+ "Logfile error", // 3
+ "POSIX fork failed", // 4
+ "Bad commandline parameters", // 5
+ "Can't write PID file", // 6
+ "SocketEngine could not initialize", // 7
+ "Refusing to start up as root", // 8
+ "Couldn't load module on startup", // 9
+ "Received SIGTERM" // 10
};
-void InspIRCd::Cleanup()
+namespace
{
- if (Config)
+ void VoidSignalHandler(int);
+
+ // Warns a user running as root that they probably shouldn't.
+ void CheckRoot()
{
- for (unsigned int i = 0; i < Config->ports.size(); i++)
+#ifndef _WIN32
+ if (getegid() != 0 && geteuid() != 0)
+ return;
+
+ std::cout << con_red << "Warning!" << con_reset << " You have started as root. Running as root is generally not required" << std::endl
+ << "and may allow an attacker to gain access to your system if they find a way to" << std::endl
+ << "exploit your IRC server." << std::endl
+ << std::endl;
+ if (isatty(fileno(stdout)))
{
- /* This calls the constructor and closes the listening socket */
- delete Config->ports[i];
+ std::cout << "InspIRCd will start in 30 seconds. If you are sure that you need to run as root" << std::endl
+ << "then you can pass the " << con_bright << "--runasroot" << con_reset << " option to disable this wait." << std::endl;
+ sleep(30);
}
-
- Config->ports.clear();
- }
-
- /* Close all client sockets, or the new process inherits them */
- for (std::vector<User*>::const_iterator i = this->local_users.begin(); i != this->local_users.end(); i++)
- {
- (*i)->SetWriteError("Server shutdown");
- (*i)->CloseSocket();
- }
-
- /* We do this more than once, so that any service providers get a
- * chance to be unhooked by the modules using them, but then get
- * a chance to be removed themsleves.
- */
- for (int tries = 0; tries < 3; tries++)
- {
- std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
- for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
+ else
{
- /* Unload all modules, so they get a chance to clean up their listeners */
- this->Modules->Unload(k->c_str());
+ std::cout << "If you are sure that you need to run as root then you can pass the " << con_bright << "--runasroot" << con_reset << std::endl
+ << "option to disable this error." << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_ROOT);
}
+#endif
}
- /* Close logging */
- if (this->Logger)
- this->Logger->Close();
-
-
- /* Cleanup Server Names */
- for(servernamelist::iterator itr = servernames.begin(); itr != servernames.end(); ++itr)
- delete (*itr);
-
-
-}
-
-void InspIRCd::Restart(const std::string &reason)
-{
- /* SendError flushes each client's queue,
- * regardless of writeability state
- */
- this->SendError(reason);
+ // Collects performance statistics for the STATS command.
+ void CollectStats()
+ {
+#ifndef _WIN32
+ static rusage ru;
+ if (getrusage(RUSAGE_SELF, &ru) == -1)
+ return; // Should never happen.
- this->Cleanup();
+ ServerInstance->stats.LastSampled.tv_sec = ServerInstance->Time();
+ ServerInstance->stats.LastSampled.tv_nsec = ServerInstance->Time_ns();
+ ServerInstance->stats.LastCPU = ru.ru_utime;
+#else
+ if (!QueryPerformanceCounter(&ServerInstance->stats.LastSampled))
+ return; // Should never happen.
- /* Figure out our filename (if theyve renamed it, we're boned) */
- std::string me;
+ FILETIME CreationTime;
+ FILETIME ExitTime;
+ FILETIME KernelTime;
+ FILETIME UserTime;
+ GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
-#ifdef WINDOWS
- char module[MAX_PATH];
- if (GetModuleFileName(NULL, module, MAX_PATH))
- me = module;
-#else
- me = Config->MyDir + "/inspircd";
+ ServerInstance->stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
+ ServerInstance->stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
#endif
-
- if (execv(me.c_str(), Config->argv) == -1)
- {
- /* Will raise a SIGABRT if not trapped */
- throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
}
-}
-void InspIRCd::ResetMaxBans()
-{
- for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
- i->second->ResetMaxBans();
-}
-
-/** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
- * we must occasionally rehash the hash (yes really).
- * We do this by copying the entries from the old hash to a new hash, causing all
- * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
- * very expensive, so instead we do it when the user types /REHASH and expects a
- * short delay anyway.
- */
-void InspIRCd::RehashUsersAndChans()
-{
- user_hash* old_users = this->clientlist;
- user_hash* old_uuid = this->uuidlist;
- chan_hash* old_chans = this->chanlist;
+ // Checks whether the server clock has skipped too much and warn about it if it has.
+ void CheckTimeSkip(time_t oldtime, time_t newtime)
+ {
+ if (!ServerInstance->Config->TimeSkipWarn)
+ return;
- this->clientlist = new user_hash();
- this->uuidlist = new user_hash();
- this->chanlist = new chan_hash();
+ time_t timediff = newtime - oldtime;
- for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
- this->clientlist->insert(*n);
+ if (timediff > ServerInstance->Config->TimeSkipWarn)
+ ServerInstance->SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
- delete old_users;
+ else if (timediff < -ServerInstance->Config->TimeSkipWarn)
+ ServerInstance->SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
+ }
- for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
- this->uuidlist->insert(*n);
+ // Drops to the unprivileged user/group specified in <security:runas{user,group}>.
+ void DropRoot()
+ {
+#ifndef _WIN32
+ ConfigTag* security = ServerInstance->Config->ConfValue("security");
- delete old_uuid;
+ const std::string SetGroup = security->getString("runasgroup");
+ if (!SetGroup.empty())
+ {
+ errno = 0;
+ if (setgroups(0, NULL) == -1)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
+ exit(EXIT_STATUS_CONFIG);
+ }
- for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
- this->chanlist->insert(*n);
+ struct group* g = getgrnam(SetGroup.c_str());
+ if (!g)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
+ exit(EXIT_STATUS_CONFIG);
+ }
- delete old_chans;
-}
+ if (setgid(g->gr_gid) == -1)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
+ exit(EXIT_STATUS_CONFIG);
+ }
+ }
-void InspIRCd::CloseLog()
-{
- if (this->Logger)
- this->Logger->Close();
-}
+ const std::string SetUser = security->getString("runasuser");
+ if (!SetUser.empty())
+ {
+ errno = 0;
+ struct passwd* u = getpwnam(SetUser.c_str());
+ if (!u)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
+ exit(EXIT_STATUS_CONFIG);
+ }
-void InspIRCd::SetSignals()
-{
-#ifndef WIN32
- signal(SIGALRM, SIG_IGN);
- signal(SIGHUP, InspIRCd::SetSignal);
- signal(SIGPIPE, SIG_IGN);
- signal(SIGCHLD, SIG_IGN);
+ if (setuid(u->pw_uid) == -1)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
+ exit(EXIT_STATUS_CONFIG);
+ }
+ }
#endif
- signal(SIGTERM, InspIRCd::SetSignal);
-}
-
-void InspIRCd::QuickExit(int status)
-{
- exit(0);
-}
+ }
-bool InspIRCd::DaemonSeed()
-{
-#ifdef WINDOWS
- printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
- return true;
+ // Expands a path relative to the current working directory.
+ std::string ExpandPath(const char* path)
+ {
+#ifdef _WIN32
+ TCHAR configPath[MAX_PATH + 1];
+ if (GetFullPathName(path, MAX_PATH, configPath, NULL) > 0)
+ return configPath;
#else
- signal(SIGTERM, InspIRCd::QuickExit);
+ char configPath[PATH_MAX + 1];
+ if (realpath(path, configPath))
+ return configPath;
+#endif
+ return path;
+ }
- int childpid;
- if ((childpid = fork ()) < 0)
- return false;
- else if (childpid > 0)
+ // Locates a config file on the file system.
+ bool FindConfigFile(std::string& path)
{
- /* We wait here for the child process to kill us,
- * so that the shell prompt doesnt come back over
- * the output.
- * Sending a kill with a signal of 0 just checks
- * if the child pid is still around. If theyre not,
- * they threw an error and we should give up.
- */
- while (kill(childpid, 0) != -1)
- sleep(1);
- exit(0);
+ if (FileSystem::FileExists(path))
+ return true;
+
+#ifdef _WIN32
+ // Windows hides file extensions by default so try appending .txt to the path
+ // to help users who have that feature enabled and can't create .conf files.
+ const std::string txtpath = path + ".txt";
+ if (FileSystem::FileExists(txtpath))
+ {
+ path.assign(txtpath);
+ return true;
+ }
+#endif
+ return false;
}
- setsid ();
- umask (007);
- printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
- signal(SIGTERM, InspIRCd::SetSignal);
-
- rlimit rl;
- if (getrlimit(RLIMIT_CORE, &rl) == -1)
+ // Attempts to fork into the background.
+ void ForkIntoBackground()
{
- this->Log(DEFAULT,"Failed to getrlimit()!");
- return false;
+#ifndef _WIN32
+ // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
+ // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
+ signal(SIGTERM, VoidSignalHandler);
+
+ errno = 0;
+ int childpid = fork();
+ if (childpid < 0)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
+ std::cout << con_red << "Error:" << con_reset << " unable to fork into background: " << strerror(errno);
+ ServerInstance->Exit(EXIT_STATUS_FORK);
+ }
+ else if (childpid > 0)
+ {
+ // Wait until the child process kills the parent so that the shell prompt
+ // doesnt display over the output. Sending a kill with a signal of 0 just
+ // checks that the child pid is still running. If it is not then an error
+ // happened and the parent should exit.
+ while (kill(childpid, 0) != -1)
+ sleep(1);
+ exit(EXIT_STATUS_NOERROR);
+ }
+ else
+ {
+ setsid();
+ signal(SIGTERM, InspIRCd::SetSignal);
+ SocketEngine::RecoverFromFork();
+ }
+#endif
}
- else
+
+ // Increase the size of a core dump file to improve debugging problems.
+ void IncreaseCoreDumpSize()
{
+#ifndef _WIN32
+ errno = 0;
+ rlimit rl;
+ if (getrlimit(RLIMIT_CORE, &rl) == -1)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
+ return;
+ }
+
rl.rlim_cur = rl.rlim_max;
if (setrlimit(RLIMIT_CORE, &rl) == -1)
- this->Log(DEFAULT,"setrlimit() failed, cannot increase coredump size.");
- }
-
- return true;
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
#endif
-}
+ }
-void InspIRCd::WritePID(const std::string &filename)
-{
- std::string fname = (filename.empty() ? "inspircd.pid" : filename);
- if (*(fname.begin()) != '/')
+ // Parses the command line options.
+ void ParseOptions()
{
- std::string::size_type pos;
- std::string confpath = this->ConfigFileName;
- if ((pos = confpath.rfind("/")) != std::string::npos)
+ int do_debug = 0, do_nofork = 0, do_nolog = 0;
+ int do_nopid = 0, do_runasroot = 0, do_version = 0;
+ struct option longopts[] =
+ {
+ { "config", required_argument, NULL, 'c' },
+ { "debug", no_argument, &do_debug, 1 },
+ { "nofork", no_argument, &do_nofork, 1 },
+ { "nolog", no_argument, &do_nolog, 1 },
+ { "nopid", no_argument, &do_nopid, 1 },
+ { "runasroot", no_argument, &do_runasroot, 1 },
+ { "version", no_argument, &do_version, 1 },
+ { 0, 0, 0, 0 }
+ };
+
+ char** argv = ServerInstance->Config->cmdline.argv;
+ int ret;
+ while ((ret = getopt_long(ServerInstance->Config->cmdline.argc, argv, ":c:", longopts, NULL)) != -1)
{
- /* Leaves us with just the path */
- fname = confpath.substr(0, pos) + std::string("/") + fname;
+ switch (ret)
+ {
+ case 0:
+ // A long option was specified.
+ break;
+
+ case 'c':
+ // The -c option was specified.
+ ServerInstance->ConfigFileName = ExpandPath(optarg);
+ break;
+
+ default:
+ // An unknown option was specified.
+ std::cout << con_red << "Error:" << con_reset << " unknown option '" << argv[optind] << "'." << std::endl
+ << con_bright << "Usage: " << con_reset << argv[0] << " [--config <file>] [--debug] [--nofork] [--nolog]" << std::endl
+ << std::string(strlen(argv[0]) + 8, ' ') << "[--nopid] [--runasroot] [--version]" << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_ARGV);
+ break;
+ }
}
+
+ if (do_version)
+ {
+ std::cout << INSPIRCD_VERSION << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_NOERROR);
+ }
+
+ // Store the relevant parsed arguments
+ ServerInstance->Config->cmdline.forcedebug = !!do_debug;
+ ServerInstance->Config->cmdline.nofork = !!do_nofork;
+ ServerInstance->Config->cmdline.runasroot = !!do_runasroot;
+ ServerInstance->Config->cmdline.writelog = !do_nolog;
+ ServerInstance->Config->cmdline.writepid = !do_nopid;
}
- std::ofstream outfile(fname.c_str());
- if (outfile.is_open())
- {
- outfile << getpid();
- outfile.close();
- }
- else
+ // Seeds the random number generator if applicable.
+ void SeedRng(timespec ts)
{
- printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
- this->Log(DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
- Exit(EXIT_STATUS_PID);
+#if defined _WIN32
+ srand(ts.tv_nsec ^ ts.tv_sec);
+#elif !defined HAS_ARC4RANDOM_BUF
+ srandom(ts.tv_nsec ^ ts.tv_sec);
+#endif
}
-}
-InspIRCd::InspIRCd(int argc, char** argv)
- : GlobalCulls(this),
-
- /* Functor initialisation. Note that the ordering here is very important. */
- HandleProcessUser(this),
- HandleIsNick(this),
- HandleIsIdent(this),
- HandleFindDescriptor(this),
- HandleFloodQuitUser(this),
-
- /* Functor pointer initialisation. Must match the order of the list above */
- ProcessUser(&HandleProcessUser),
- IsNick(&HandleIsNick),
- IsIdent(&HandleIsIdent),
- FindDescriptor(&HandleFindDescriptor),
- FloodQuitUser(&HandleFloodQuitUser)
-
-{
-
- int found_ports = 0;
- FailedPortList pl;
- int do_version = 0, do_nofork = 0, do_debug = 0, do_nolog = 0, do_root = 0; /* flag variables */
- char c = 0;
-
- memset(&server, 0, sizeof(server));
- memset(&client, 0, sizeof(client));
-
- SocketEngineFactory* SEF = new SocketEngineFactory();
- SE = SEF->Create(this);
- delete SEF;
-
- this->s_signal = 0;
-
- this->unregistered_count = 0;
-
- this->clientlist = new user_hash();
- this->uuidlist = new user_hash();
- this->chanlist = new chan_hash();
-
-
- this->Config = new ServerConfig(this);
- this->SNO = new SnomaskManager(this);
- this->BanCache = new BanCacheManager(this);
- this->Modules = new ModuleManager(this);
- this->stats = new serverstats();
- this->Timers = new TimerManager(this);
- this->Parser = new CommandParser(this);
- this->XLines = new XLineManager(this);
-
- this->Config->argv = argv;
- this->Config->argc = argc;
-
- if (chdir(Config->GetFullProgDir().c_str()))
+ // Sets handlers for various process signals.
+ void SetSignals()
{
- printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
- exit(0);
+#ifndef _WIN32
+ signal(SIGALRM, SIG_IGN);
+ signal(SIGCHLD, SIG_IGN);
+ signal(SIGHUP, InspIRCd::SetSignal);
+ signal(SIGPIPE, SIG_IGN);
+ signal(SIGUSR1, SIG_IGN);
+ signal(SIGUSR2, SIG_IGN);
+ signal(SIGXFSZ, SIG_IGN);
+#endif
+ signal(SIGTERM, InspIRCd::SetSignal);
}
- this->Config->opertypes.clear();
- this->Config->operclass.clear();
+ void TryBindPorts()
+ {
+ FailedPortList pl;
+ ServerInstance->BindPorts(pl);
- this->TIME = this->OLDTIME = this->startup_time = time(NULL);
- this->time_delta = 0;
- srand(this->TIME);
+ if (!pl.empty())
+ {
+ std::cout << con_red << "Warning!" << con_reset << " Some of your listener" << (pl.size() == 1 ? "s" : "") << " failed to bind:" << std::endl
+ << std::endl;
- *this->LogFileName = 0;
- strlcpy(this->ConfigFileName, CONFIG_FILE, MAXBUF);
+ for (FailedPortList::const_iterator iter = pl.begin(); iter != pl.end(); ++iter)
+ {
+ const FailedPort& fp = *iter;
+ std::cout << " " << con_bright << fp.sa.str() << con_reset << ": " << strerror(fp.error) << '.' << std::endl
+ << " " << "Created from <bind> tag at " << fp.tag->getTagLocation() << std::endl
+ << std::endl;
+ }
- struct option longopts[] =
- {
- { "nofork", no_argument, &do_nofork, 1 },
- { "logfile", required_argument, NULL, 'f' },
- { "config", required_argument, NULL, 'c' },
- { "debug", no_argument, &do_debug, 1 },
- { "nolog", no_argument, &do_nolog, 1 },
- { "runasroot", no_argument, &do_root, 1 },
- { "version", no_argument, &do_version, 1 },
- { 0, 0, 0, 0 }
- };
-
- while ((c = getopt_long_only(argc, argv, ":f:", longopts, NULL)) != -1)
- {
- switch (c)
- {
- case 'f':
- /* Log filename was set */
- strlcpy(LogFileName, optarg, MAXBUF);
- break;
- case 'c':
- /* Config filename was set */
- strlcpy(ConfigFileName, optarg, MAXBUF);
- break;
- case 0:
- /* getopt_long_only() set an int variable, just keep going */
- break;
- default:
- /* Unknown parameter! DANGER, INTRUDER.... err.... yeah. */
- printf("Usage: %s [--nofork] [--nolog] [--debug] [--logfile <filename>] [--runasroot] [--version] [--config <config>]\n", argv[0]);
- Exit(EXIT_STATUS_ARGV);
- break;
+ std::cout << con_bright << "Hints:" << con_reset << std::endl
+ << "- For TCP/IP listeners try using a public IP address in <bind:address> instead" << std::endl
+ << " of * or leaving it blank." << std::endl
+ << "- For UNIX socket listeners try enabling <bind:rewrite> to replace old sockets." << std::endl;
}
}
- if (do_version)
+ // Required for returning the proper value of EXIT_SUCCESS for the parent process.
+ void VoidSignalHandler(int)
{
- printf("\n%s r%s\n", VERSION, REVISION);
- Exit(EXIT_STATUS_NOERROR);
+ exit(EXIT_STATUS_NOERROR);
}
+}
-#ifdef WIN32
-
- // Handle forking
- if(!do_nofork)
+void InspIRCd::Cleanup()
+{
+ // Close all listening sockets
+ for (unsigned int i = 0; i < ports.size(); i++)
{
- DWORD ExitCode = WindowsForkStart(this);
- if(ExitCode)
- exit(ExitCode);
+ ports[i]->cull();
+ delete ports[i];
}
+ ports.clear();
- // Set up winsock
- WSADATA wsadata;
- WSAStartup(MAKEWORD(2,0), &wsadata);
+ // Tell modules that we're shutting down.
+ const std::string quitmsg = "Server shutting down";
+ FOREACH_MOD(OnShutdown, (quitmsg));
- ChangeWindowsSpecificPointers(this);
-#endif
- strlcpy(Config->MyExecutable,argv[0],MAXBUF);
+ // Disconnect all local users
+ const UserManager::LocalList& list = Users.GetLocalUsers();
+ while (!list.empty())
+ ServerInstance->Users.QuitUser(list.front(), quitmsg);
+
+ GlobalCulls.Apply();
+ Modules->UnloadAll();
- if (!this->OpenLog(argv, argc))
+ /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
+ /* Must be deleted before modes as it decrements modelines */
+ if (FakeClient)
{
- printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
- Exit(EXIT_STATUS_LOG);
+ delete FakeClient->server;
+ FakeClient->cull();
}
+ stdalgo::delete_zero(this->FakeClient);
+ stdalgo::delete_zero(this->XLines);
+ stdalgo::delete_zero(this->Config);
+ SocketEngine::Deinit();
+ Logs->CloseLogs();
+}
- if (!ServerConfig::FileExists(this->ConfigFileName))
+void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
+{
+#ifndef _WIN32
+ if (!ServerInstance->Config->cmdline.writepid)
{
- printf("ERROR: Cannot open config file: %s\nExiting...\n", this->ConfigFileName);
- this->Log(DEFAULT,"Unable to open config file %s", this->ConfigFileName);
- Exit(EXIT_STATUS_CONFIG);
+ this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
+ return;
}
- printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
- printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
- printf_c("Developers:\t\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special, pippijn, peavey, Burlex\033[0m\n");
- printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
-
- /* Set the finished argument values */
- Config->nofork = do_nofork;
- Config->forcedebug = do_debug;
- Config->writelog = !do_nolog;
- Config->ClearStack();
-
- this->Modes = new ModeParser(this);
- this->AddServerName(Config->ServerName);
-
- /*
- * Initialise SID/UID.
- * For an explanation as to exactly how this works, and why it works this way, see GetUID().
- * -- w00t
- */
- /* Generate SID */
- size_t sid = 0;
- if (Config->sid)
+ std::string fname = ServerInstance->Config->Paths.PrependRuntime(filename.empty() ? "inspircd.pid" : filename);
+ std::ofstream outfile(fname.c_str());
+ if (outfile.is_open())
{
- sid = Config->sid;
+ outfile << getpid();
+ outfile.close();
}
else
{
- for (const char* x = Config->ServerName; *x; ++x)
- sid = 5 * sid + *x;
- for (const char* y = Config->ServerDesc; *y; ++y)
- sid = 5 * sid + *y;
- sid = sid % 999;
-
- Config->sid = sid;
+ if (exitonfail)
+ std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
+ this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
+ if (exitonfail)
+ Exit(EXIT_STATUS_PID);
}
+#endif
+}
- this->InitialiseUID();
+InspIRCd::InspIRCd(int argc, char** argv)
+ : FakeClient(NULL)
+ , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
+ , ConfigThread(NULL)
+ , Config(NULL)
+ , XLines(NULL)
+ , PI(&DefaultProtocolInterface)
+ , GenRandom(&DefaultGenRandom)
+ , IsChannel(&DefaultIsChannel)
+ , IsNick(&DefaultIsNick)
+ , IsIdent(&DefaultIsIdent)
+{
+ ServerInstance = this;
- /* set up fake client */
- this->FakeClient = new User(this);
- this->FakeClient->SetFd(FD_MAGIC_NUMBER);
+ UpdateTime();
+ this->startup_time = TIME.tv_sec;
- if (!do_root)
- this->CheckRoot();
- else
- {
- printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
- printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
- printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
- printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
- printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
- printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
- printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
- printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
- sleep(20);
- }
+ IncreaseCoreDumpSize();
+ SeedRng(TIME);
+ SocketEngine::Init();
- this->SetSignals();
+ this->Config = new ServerConfig;
+ dynamic_reference_base::reset_all();
+ this->XLines = new XLineManager;
+
+ this->Config->cmdline.argv = argv;
+ this->Config->cmdline.argc = argc;
+ ParseOptions();
- if (!Config->nofork)
{
- if (!this->DaemonSeed())
+ ServiceProvider* provs[] =
{
- printf("ERROR: could not go into daemon mode. Shutting down.\n");
- Log(DEFAULT,"ERROR: could not go into daemon mode. Shutting down.");
- Exit(EXIT_STATUS_FORK);
- }
+ &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
+ &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
+ &rfcevents.error
+ };
+ Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
}
- SE->RecoverFromFork();
-
- this->Res = new DNS(this);
-
- /* Read config, pass 0. At the end if this pass,
- * the Config->IncludeFiles is populated, we call
- * Config->StartDownloads to initialize the downlaods of all
- * these files.
- */
- Config->Read(true, NULL, 0);
- Config->StartDownloads();
-
- /* Now the downloads are started, we monitor them for completion.
- * On completion, we call Read again with pass = 1.
- * NOTE: We really should add a timeout here
- */
+ std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl
+ << "See " << con_green << "/INFO" << con_reset << " for contributors & authors" << std::endl
+ << std::endl;
- while (Config->Downloading())
+ if (Config->cmdline.forcedebug)
{
- SE->DispatchEvents();
- this->BufferedSocketCull();
+ FILE* newstdout = fdopen(dup(STDOUT_FILENO), "w");
+ FileWriter* fw = new FileWriter(newstdout, 1);
+ FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
+ Logs->AddLogTypes("*", fls, true);
}
- printf("\n");
-
- if (Config->FileErrors)
+ if (!FindConfigFile(ConfigFileName))
{
- /* One or more file download/access errors, do not
- * proceed to second pass
- */
+ this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
+ std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
Exit(EXIT_STATUS_CONFIG);
}
- /* We have all the files we can get, initiate pass 1 */
- Config->Read(true, NULL, 1);
+ SetSignals();
+ if (!Config->cmdline.runasroot)
+ CheckRoot();
+ if (!Config->cmdline.nofork)
+ ForkIntoBackground();
- // Get XLine to do it's thing.
- this->XLines->CheckELines();
- this->XLines->ApplyLines();
+ std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
+ /* During startup we read the configuration now, not in
+ * a separate thread
+ */
+ this->Config->Read();
+ this->Config->Apply(NULL, "");
+ Logs->OpenFileLogs();
- CheckDie();
- int bounditems = BindPorts(true, found_ports, pl);
+ // If we don't have a SID, generate one based on the server name and the server description
+ if (Config->sid.empty())
+ Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
- printf("\n");
+ // Initialize the UID generator with our sid
+ this->UIDGen.init(Config->sid);
- /*this->Modules->LoadAll();*/
-
- /* Just in case no modules were loaded - fix for bug #101 */
- this->BuildISupport();
- InitializeDisabledCommands(Config->DisabledCommands, this);
+ // Create the server user for this server
+ this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
- if ((Config->ports.size() == 0) && (found_ports > 0))
- {
- printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
- Log(DEFAULT,"ERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?");
- Exit(EXIT_STATUS_BIND);
- }
+ // This is needed as all new XLines are marked pending until ApplyLines() is called
+ this->XLines->ApplyLines();
- if (Config->ports.size() != (unsigned int)found_ports)
- {
- printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n", bounditems, found_ports);
- printf("The following port(s) failed to bind:\n");
- int j = 1;
- for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
- {
- printf("%d.\tIP: %s\tPort: %lu\n", j, i->first.empty() ? "<all>" : i->first.c_str(), (unsigned long)i->second);
- }
- }
-#ifndef WINDOWS
- if (!Config->nofork)
+ std::cout << std::endl;
+
+ TryBindPorts();
+
+ this->Modules->LoadAll();
+
+ // Build ISupport as ModuleManager::LoadAll() does not do it
+ this->ISupport.Build();
+
+ std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
+
+#ifndef _WIN32
+ if (!Config->cmdline.nofork)
{
if (kill(getppid(), SIGTERM) == -1)
{
- printf("Error killing parent process: %s\n",strerror(errno));
- Log(DEFAULT,"Error killing parent process: %s",strerror(errno));
+ std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
+ Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
}
}
- if (isatty(0) && isatty(1) && isatty(2))
+ /* Explicitly shut down stdio's stdin/stdout/stderr.
+ *
+ * The previous logic here was to only do this if stdio was connected to a controlling
+ * terminal. However, we must do this always to avoid information leaks and other
+ * problems related to stdio.
+ *
+ * The only exception is if we are in debug mode.
+ *
+ * -- nenolod
+ */
+ if ((!Config->cmdline.nofork) && (!Config->cmdline.forcedebug))
{
- /* We didn't start from a TTY, we must have started from a background process -
- * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
- * close stdin/stdout
- */
- if (!do_nofork)
- {
- fclose(stdin);
- fclose(stderr);
- fclose(stdout);
- }
- else
- {
- Log(DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
- }
+ int fd = open("/dev/null", O_RDWR);
+
+ fclose(stdin);
+ fclose(stderr);
+ fclose(stdout);
+
+ if (dup2(fd, STDIN_FILENO) < 0)
+ Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
+ if (dup2(fd, STDOUT_FILENO) < 0)
+ Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
+ if (dup2(fd, STDERR_FILENO) < 0)
+ Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
+ close(fd);
+ }
+ else
+ {
+ Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
}
#else
- WindowsIPC = new IPC(this);
- if(!Config->nofork)
+ /* Set win32 service as running, if we are running as a service */
+ SetServiceRunning();
+
+ // Handle forking
+ if(!Config->cmdline.nofork)
{
- WindowsForkKillOwner(this);
FreeConsole();
}
+
+ QueryPerformanceFrequency(&stats.QPFrequency);
#endif
- printf("\nInspIRCd is now running!\n");
- Log(DEFAULT,"Startup complete.");
+ WritePID(Config->PID);
+ DropRoot();
- this->WritePID(Config->PID);
+ Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
}
-/* moved to a function, as UID generation can call this also */
-void InspIRCd::InitialiseUID()
+void InspIRCd::UpdateTime()
{
- int i;
- size_t sid = Config->sid;
-
- current_uid[0] = sid / 100 + 48;
- current_uid[1] = ((sid / 10) % 10) + 48;
- current_uid[2] = sid % 10 + 48;
+#if defined HAS_CLOCK_GETTIME
+ clock_gettime(CLOCK_REALTIME, &TIME);
+#elif defined _WIN32
+ SYSTEMTIME st;
+ GetSystemTime(&st);
+
+ TIME.tv_sec = time(NULL);
+ TIME.tv_nsec = st.wMilliseconds;
+#else
+ struct timeval tv;
+ gettimeofday(&tv, NULL);
- /* Initialise UID */
- for(i = 3; i < UUID_LENGTH - 1; i++)
- current_uid[i] = 'A';
+ TIME.tv_sec = tv.tv_sec;
+ TIME.tv_nsec = tv.tv_usec * 1000;
+#endif
}
-int InspIRCd::Run()
+void InspIRCd::Run()
{
+ UpdateTime();
+ time_t OLDTIME = TIME.tv_sec;
+
while (true)
{
-#ifndef WIN32
- static rusage ru;
-#else
- static time_t uptime;
- static struct tm * stime;
- static char window_title[100];
-#endif
+ /* Check if there is a config thread which has finished executing but has not yet been freed */
+ if (this->ConfigThread && this->ConfigThread->IsDone())
+ {
+ /* Rehash has completed */
+ this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
- /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
- * Once per loop iteration is pleanty.
- */
- OLDTIME = TIME;
- TIME = time(NULL);
+ this->ConfigThread->Finish();
+
+ ConfigThread->join();
+ delete ConfigThread;
+ ConfigThread = NULL;
+ }
+
+ UpdateTime();
/* Run background module timers every few seconds
- * (the docs say modules shouldnt rely on accurate
+ * (the docs say modules should not rely on accurate
* timing using this event, so we dont have to
* time this exactly).
*/
- if (TIME != OLDTIME)
+ if (TIME.tv_sec != OLDTIME)
{
- if (TIME < OLDTIME)
- {
- WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
- }
+ CollectStats();
+ CheckTimeSkip(OLDTIME, TIME.tv_sec);
- if ((TIME % 3600) == 0)
- {
- this->RehashUsersAndChans();
- FOREACH_MOD_I(this, I_OnGarbageCollect, OnGarbageCollect());
- }
+ OLDTIME = TIME.tv_sec;
- Timers->TickTimers(TIME);
- this->DoBackgroundUserStuff();
+ if ((TIME.tv_sec % 3600) == 0)
+ FOREACH_MOD(OnGarbageCollect, ());
- if ((TIME % 5) == 0)
- {
- FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
- Timers->TickMissedTimers(TIME);
- }
-#ifndef WIN32
- /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
- if (!getrusage(RUSAGE_SELF, &ru))
- {
- gettimeofday(&this->stats->LastSampled, NULL);
- this->stats->LastCPU = ru.ru_utime;
- }
-#else
- WindowsIPC->Check();
-
- if(Config->nofork)
+ Timers.TickTimers(TIME.tv_sec);
+ Users->DoBackgroundUserStuff();
+
+ if ((TIME.tv_sec % 5) == 0)
{
- uptime = Time() - startup_time;
- stime = gmtime(&uptime);
- snprintf(window_title, 100, "InspIRCd - %u clients, %u accepted connections - Up %u days, %.2u:%.2u:%.2u",
- LocalUserCount(), stats->statsAccept, stime->tm_yday, stime->tm_hour, stime->tm_min, stime->tm_sec);
- SetConsoleTitle(window_title);
+ FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
+ SNO->FlushSnotices();
}
-#endif
}
/* Call the socket engine to wait on the active
* This will cause any read or write events to be
* dispatched to their handlers.
*/
- this->SE->DispatchEvents();
-
- /* if any users was quit, take them out */
- this->GlobalCulls.Apply();
+ SocketEngine::DispatchTrialWrites();
+ SocketEngine::DispatchEvents();
- /* If any inspsockets closed, remove them */
- this->BufferedSocketCull();
+ /* if any users were quit, take them out */
+ GlobalCulls.Apply();
+ AtomicActions.Run();
- if (this->s_signal)
+ if (s_signal)
{
this->SignalHandler(s_signal);
- this->s_signal = 0;
+ s_signal = 0;
}
}
-
- return 0;
-}
-
-void InspIRCd::BufferedSocketCull()
-{
- for (std::map<BufferedSocket*,BufferedSocket*>::iterator x = SocketCull.begin(); x != SocketCull.end(); ++x)
- {
- SE->DelFd(x->second);
- x->second->Close();
- delete x->second;
- }
- SocketCull.clear();
}
-/**********************************************************************************/
-
-/**
- * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
- */
+sig_atomic_t InspIRCd::s_signal = 0;
-int main(int argc, char ** argv)
+void InspIRCd::SetSignal(int signal)
{
- SI = new InspIRCd(argc, argv);
- mysig = &SI->s_signal;
- SI->Run();
- delete SI;
- return 0;
+ s_signal = signal;
}
-/* this returns true when all modules are satisfied that the user should be allowed onto the irc server
- * (until this returns true, a user will block in the waiting state, waiting to connect up to the
- * registration timeout maximum seconds)
+/* On posix systems, the flow of the program starts right here, with
+ * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
+ * defines smain() and the real main() is in the service code under
+ * win32service.cpp. This allows the service control manager to control
+ * the process where we are running as a windows service.
*/
-bool InspIRCd::AllModulesReportReady(User* user)
-{
- for (EventHandlerIter i = Modules->EventHandlers[I_OnCheckReady].begin(); i != Modules->EventHandlers[I_OnCheckReady].end(); ++i)
- {
- int res = (*i)->OnCheckReady(user);
- if (!res)
- return false;
- }
-
- return true;
-}
-
-time_t InspIRCd::Time(bool delta)
+ENTRYPOINT
{
- if (delta)
- return TIME + time_delta;
- return TIME;
-}
-
-int InspIRCd::SetTimeDelta(int delta)
-{
- int old = time_delta;
- time_delta = delta;
- this->Log(DEBUG, "Time delta set to %d (was %d)", time_delta, old);
- return old;
-}
-
-void InspIRCd::AddLocalClone(User* user)
-{
- clonemap::iterator x = local_clones.find(user->GetIPString());
- if (x != local_clones.end())
- x->second++;
- else
- local_clones[user->GetIPString()] = 1;
-}
-
-void InspIRCd::AddGlobalClone(User* user)
-{
- clonemap::iterator y = global_clones.find(user->GetIPString());
- if (y != global_clones.end())
- y->second++;
- else
- global_clones[user->GetIPString()] = 1;
-}
-
-int InspIRCd::GetTimeDelta()
-{
- return time_delta;
-}
-
-void InspIRCd::SetSignal(int signal)
-{
- *mysig = signal;
+ new InspIRCd(argc, argv);
+ ServerInstance->Run();
+ delete ServerInstance;
+ return 0;
}