]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/inspircd.cpp
Change all socketengine methods to be static
[user/henk/code/inspircd.git] / src / inspircd.cpp
index 7b3d36e1cf7a32c7c86f900ca00e92f85cda794f..101df432fe699fcc7e3c1f1263f2972f279b999f 100644 (file)
@@ -26,7 +26,6 @@
  */
 
 
-/* $Core */
 #include "inspircd.h"
 #include <signal.h>
 
@@ -62,7 +61,6 @@
 #include "testsuite.h"
 
 InspIRCd* ServerInstance = NULL;
-int* mysig = NULL;
 
 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
  * if it must.
@@ -78,28 +76,26 @@ unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
  */
 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 */
-               "Bad command handler loaded", /* 16 */
-               "RegisterServiceCtrlHandler failed", /* 17 */
-               "UpdateSCMStatus failed", /* 18 */
-               "CreateEvent failed" /* 19 */
+               "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
 };
 
+#ifdef INSPIRCD_ENABLE_TESTSUITE
+/** True if we have been told to run the testsuite from the commandline,
+ * rather than entering the mainloop.
+ */
+static int do_testsuite = 0;
+#endif
+
 template<typename T> static void DeleteZero(T*&n)
 {
        T* t = n;
@@ -109,21 +105,18 @@ template<typename T> static void DeleteZero(T*&n)
 
 void InspIRCd::Cleanup()
 {
+       // Close all listening sockets
        for (unsigned int i = 0; i < ports.size(); i++)
        {
-               /* This calls the constructor and closes the listening socket */
                ports[i]->cull();
                delete ports[i];
        }
        ports.clear();
 
        /* Close all client sockets, or the new process inherits them */
-       LocalUserList::reverse_iterator i = Users->local_users.rbegin();
-       while (i != this->Users->local_users.rend())
-       {
-               User* u = *i++;
-               Users->QuitUser(u, "Server shutdown");
-       }
+       LocalUserList& list = Users->local_users;
+       for (LocalUserList::iterator i = list.begin(); i != list.end(); ++i)
+               Users->QuitUser(*i, "Server shutdown");
 
        GlobalCulls.Apply();
        Modules->UnloadAll();
@@ -131,7 +124,10 @@ void InspIRCd::Cleanup()
        /* 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)
+       {
+               delete FakeClient->server;
                FakeClient->cull();
+       }
        DeleteZero(this->FakeClient);
        DeleteZero(this->Users);
        DeleteZero(this->Modes);
@@ -146,41 +142,11 @@ void InspIRCd::Cleanup()
        DeleteZero(this->PI);
        DeleteZero(this->Threads);
        DeleteZero(this->Timers);
-       DeleteZero(this->SE);
-       /* Close logging */
-       this->Logs->CloseLogs();
+       SocketEngine::Deinit();
+       Logs->CloseLogs();
        DeleteZero(this->Logs);
 }
 
-void InspIRCd::Restart(const std::string &reason)
-{
-       /* SendError flushes each client's queue,
-        * regardless of writeability state
-        */
-       this->SendError(reason);
-
-       /* Figure out our filename (if theyve renamed it, we're boned) */
-       std::string me;
-
-       char** argv = Config->cmdline.argv;
-
-#ifdef _WIN32
-       char module[MAX_PATH];
-       if (GetModuleFileNameA(NULL, module, MAX_PATH))
-               me = module;
-#else
-       me = argv[0];
-#endif
-
-       this->Cleanup();
-
-       if (execv(me.c_str(), argv) == -1)
-       {
-               /* Will raise a SIGABRT if not trapped */
-               throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
-       }
-}
-
 void InspIRCd::SetSignals()
 {
 #ifndef _WIN32
@@ -195,6 +161,12 @@ void InspIRCd::SetSignals()
 }
 
 void InspIRCd::QuickExit(int status)
+{
+       exit(status);
+}
+
+// Required for returning the proper value of EXIT_SUCCESS for the parent process
+static void VoidSignalHandler(int signalreceived)
 {
        exit(0);
 }
@@ -205,10 +177,11 @@ bool InspIRCd::DaemonSeed()
        std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
        return true;
 #else
-       signal(SIGTERM, InspIRCd::QuickExit);
+       // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
+       signal(SIGTERM, VoidSignalHandler);
 
-       int childpid;
-       if ((childpid = fork ()) < 0)
+       int childpid = fork();
+       if (childpid < 0)
                return false;
        else if (childpid > 0)
        {
@@ -231,13 +204,13 @@ bool InspIRCd::DaemonSeed()
        rlimit rl;
        if (getrlimit(RLIMIT_CORE, &rl) == -1)
        {
-               this->Logs->Log("STARTUP",LOG_DEFAULT,"Failed to getrlimit()!");
+               this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
                return false;
        }
        rl.rlim_cur = rl.rlim_max;
 
        if (setrlimit(RLIMIT_CORE, &rl) == -1)
-                       this->Logs->Log("STARTUP",LOG_DEFAULT,"setrlimit() failed, cannot increase coredump size.");
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
 
        return true;
 #endif
@@ -248,7 +221,7 @@ void InspIRCd::WritePID(const std::string &filename)
 #ifndef _WIN32
        std::string fname(filename);
        if (fname.empty())
-               fname = DATA_PATH "/inspircd.pid";
+               fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
        std::ofstream outfile(fname.c_str());
        if (outfile.is_open())
        {
@@ -258,7 +231,7 @@ void InspIRCd::WritePID(const std::string &filename)
        else
        {
                std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
-               this->Logs->Log("STARTUP",LOG_DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
+               this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s', exiting.",fname.c_str());
                Exit(EXIT_STATUS_PID);
        }
 #endif
@@ -272,24 +245,21 @@ InspIRCd::InspIRCd(int argc, char** argv) :
          * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
          * themselves within the class.
          */
-        NICKForced("NICKForced", NULL),
-        OperQuit("OperQuit", NULL),
+        OperQuit("operquit", NULL),
         GenRandom(&HandleGenRandom),
         IsChannel(&HandleIsChannel),
-        Rehash(&HandleRehash),
         IsNick(&HandleIsNick),
         IsIdent(&HandleIsIdent),
         OnCheckExemption(&HandleOnCheckExemption)
 {
        ServerInstance = this;
 
-       Extensions.Register(&NICKForced);
        Extensions.Register(&OperQuit);
 
        FailedPortList pl;
+       // Flag variables passed to getopt_long() later
        int do_version = 0, do_nofork = 0, do_debug = 0,
-           do_nolog = 0, do_root = 0, do_testsuite = 0;    /* flag variables */
-       int c = 0;
+           do_nolog = 0, do_root = 0;
 
        // Initialize so that if we exit before proper initialization they're not deleted
        this->Logs = 0;
@@ -315,22 +285,16 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        // This must be created first, so other parts of Insp can use it while starting up
        this->Logs = new LogManager;
 
-       SE = CreateSocketEngine();
+       SocketEngine::Init();
 
        this->Threads = new ThreadEngine;
 
        /* Default implementation does nothing */
        this->PI = new ProtocolInterface;
 
-       this->s_signal = 0;
-
        // Create base manager classes early, so nothing breaks
        this->Users = new UserManager;
 
-       this->Users->unregistered_count = 0;
-
-       this->Users->clientlist = new user_hash();
-       this->Users->uuidlist = new user_hash();
        this->chanlist = new chan_hash();
 
        this->Config = new ServerConfig;
@@ -369,28 +333,26 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        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       },
+#ifdef INSPIRCD_ENABLE_TESTSUITE
                { "testsuite",  no_argument,            &do_testsuite,  1       },
+#endif
                { 0, 0, 0, 0 }
        };
 
+       int c;
        int index;
-       while ((c = getopt_long(argc, argv, ":c:f:", longopts, &index)) != -1)
+       while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
        {
                switch (c)
                {
-                       case 'f':
-                               /* Log filename was set */
-                               Config->cmdline.startup_log = optarg;
-                       break;
                        case 'c':
                                /* Config filename was set */
-                               ConfigFileName = optarg;
+                               ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
                        break;
                        case 0:
                                /* getopt_long_only() set an int variable, just keep going */
@@ -400,19 +362,21 @@ InspIRCd::InspIRCd(int argc, char** argv) :
                        default:
                                /* Fall through to handle other weird values too */
                                std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
-                               std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--logfile <filename>] " << std::endl <<
-                                       std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version] [--config <config>] [--testsuite]" << std::endl;
+                               std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
+                                       std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
                                Exit(EXIT_STATUS_ARGV);
                        break;
                }
        }
 
+#ifdef INSPIRCD_ENABLE_TESTSUITE
        if (do_testsuite)
                do_nofork = do_debug = true;
+#endif
 
        if (do_version)
        {
-               std::cout << std::endl << VERSION << " r" << REVISION << std::endl;
+               std::cout << std::endl << VERSION << " " << REVISION << std::endl;
                Exit(EXIT_STATUS_NOERROR);
        }
 
@@ -426,7 +390,6 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        Config->cmdline.nofork = (do_nofork != 0);
        Config->cmdline.forcedebug = (do_debug != 0);
        Config->cmdline.writelog = (!do_nolog != 0);
-       Config->cmdline.TestSuite = (do_testsuite != 0);
 
        if (do_debug)
        {
@@ -434,20 +397,15 @@ InspIRCd::InspIRCd(int argc, char** argv) :
                FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
                Logs->AddLogTypes("*", fls, true);
        }
-       else if (!this->OpenLog(argv, argc))
-       {
-               std::cout << "ERROR: Could not open initial logfile " << Config->cmdline.startup_log << ": " << strerror(errno) << std::endl << std::endl;
-               Exit(EXIT_STATUS_LOG);
-       }
 
-       if (!ServerConfig::FileExists(ConfigFileName.c_str()))
+       if (!FileSystem::FileExists(ConfigFileName))
        {
 #ifdef _WIN32
                /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
                std::string txtconf = this->ConfigFileName;
                txtconf.append(".txt");
 
-               if (ServerConfig::FileExists(txtconf.c_str()))
+               if (FileSystem::FileExists(txtconf))
                {
                        ConfigFileName = txtconf;
                }
@@ -455,7 +413,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 #endif
                {
                        std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
-                       this->Logs->Log("STARTUP",LOG_DEFAULT,"Unable to open config file %s", ConfigFileName.c_str());
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
                        Exit(EXIT_STATUS_CONFIG);
                }
        }
@@ -464,7 +422,8 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        std::cout << con_green << "(C) InspIRCd Development Team." << con_reset << std::endl << std::endl;
        std::cout << "Developers:" << std::endl;
        std::cout << con_green << "\tBrain, FrostyCoolSlug, w00t, Om, Special, peavey" << std::endl;
-       std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << con_reset << std::endl << std::endl;
+       std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << std::endl;
+       std::cout << "\tAttila" << con_reset << std::endl << std::endl;
        std::cout << "Others:\t\t\t" << con_green << "See /INFO Output" << con_reset << std::endl;
 
        this->Modes = new ModeParser;
@@ -498,10 +457,10 @@ InspIRCd::InspIRCd(int argc, char** argv) :
                }
        }
 
-       SE->RecoverFromFork();
+       SocketEngine::RecoverFromFork();
 
-       /* During startup we don't actually initialize this
-        * in the thread engine.
+       /* During startup we read the configuration now, not in
+        * a seperate thread
         */
        this->Config->Read();
        this->Config->Apply(NULL, "");
@@ -515,11 +474,10 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        // Initialize the UID generator with our sid
        this->UIDGen.init(Config->sid);
 
-       /* set up fake client again this time with the correct uid */
-       this->FakeClient = new FakeUser(Config->sid, Config->ServerName);
+       // Create the server user for this server
+       this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
 
-       // Get XLine to do it's thing.
-       this->XLines->CheckELines();
+       // This is needed as all new XLines are marked pending until ApplyLines() is called
        this->XLines->ApplyLines();
 
        int bounditems = BindPorts(pl);
@@ -528,7 +486,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
        this->Modules->LoadAll();
 
-       /* Just in case no modules were loaded - fix for bug #101 */
+       // Build ISupport as ModuleManager::LoadAll() does not do it
        this->ISupport.Build();
        Config->ApplyDisabledCommands(Config->DisabledCommands);
 
@@ -546,7 +504,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
                std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
        }
 
-       std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SE->GetMaxFds() << " max open sockets" << std::endl;
+       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)
@@ -568,7 +526,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
         *
         *    -- nenolod
         */
-       if ((!do_nofork) && (!do_testsuite) && (!Config->cmdline.forcedebug))
+       if ((!do_nofork) && (!Config->cmdline.forcedebug))
        {
                int fd = open("/dev/null", O_RDWR);
 
@@ -586,7 +544,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        }
        else
        {
-               Logs->Log("STARTUP", LOG_DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
+               Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
        }
 #else
        /* Set win32 service as running, if we are running as a service */
@@ -601,7 +559,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
        QueryPerformanceFrequency(&stats->QPFrequency);
 #endif
 
-       Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SE->GetMaxFds());
+       Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
 
 #ifndef _WIN32
        std::string SetUser = Config->ConfValue("security")->getString("runasuser");
@@ -615,7 +573,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
                if (ret == -1)
                {
-                       this->Logs->Log("SETGROUPS", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
                        this->QuickExit(0);
                }
 
@@ -627,7 +585,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
                if (!g)
                {
-                       this->Logs->Log("SETGUID", LOG_DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
                        this->QuickExit(0);
                }
 
@@ -635,7 +593,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
                if (ret == -1)
                {
-                       this->Logs->Log("SETGUID", LOG_DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (wrong group?): %s", strerror(errno));
                        this->QuickExit(0);
                }
        }
@@ -650,7 +608,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
                if (!u)
                {
-                       this->Logs->Log("SETGUID", LOG_DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
                        this->QuickExit(0);
                }
 
@@ -658,7 +616,7 @@ InspIRCd::InspIRCd(int argc, char** argv) :
 
                if (ret == -1)
                {
-                       this->Logs->Log("SETGUID", LOG_DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
+                       this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (wrong user?): %s", strerror(errno));
                        this->QuickExit(0);
                }
        }
@@ -687,15 +645,17 @@ void InspIRCd::UpdateTime()
 #endif
 }
 
-int InspIRCd::Run()
+void InspIRCd::Run()
 {
+#ifdef INSPIRCD_ENABLE_TESTSUITE
        /* See if we're supposed to be running the test suite rather than entering the mainloop */
-       if (Config->cmdline.TestSuite)
+       if (do_testsuite)
        {
                TestSuite* ts = new TestSuite;
                delete ts;
-               Exit(0);
+               return;
        }
+#endif
 
        UpdateTime();
        time_t OLDTIME = TIME.tv_sec;
@@ -710,7 +670,7 @@ int InspIRCd::Run()
                if (this->ConfigThread && this->ConfigThread->IsDone())
                {
                        /* Rehash has completed */
-                       this->Logs->Log("CONFIG",LOG_DEBUG,"Detected ConfigThread exiting, tidying up...");
+                       this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
 
                        this->ConfigThread->Finish();
 
@@ -760,15 +720,15 @@ int InspIRCd::Run()
                        if ((TIME.tv_sec % 3600) == 0)
                        {
                                Users->GarbageCollect();
-                               FOREACH_MOD(I_OnGarbageCollect, OnGarbageCollect());
+                               FOREACH_MOD(OnGarbageCollect, ());
                        }
 
                        Timers->TickTimers(TIME.tv_sec);
-                       this->DoBackgroundUserStuff();
+                       Users->DoBackgroundUserStuff();
 
                        if ((TIME.tv_sec % 5) == 0)
                        {
-                               FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME.tv_sec));
+                               FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
                                SNO->FlushSnotices();
                        }
                }
@@ -780,43 +740,26 @@ int InspIRCd::Run()
                 * This will cause any read or write events to be
                 * dispatched to their handlers.
                 */
-               this->SE->DispatchTrialWrites();
-               this->SE->DispatchEvents();
+               SocketEngine::DispatchTrialWrites();
+               SocketEngine::DispatchEvents();
 
                /* 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;
 }
 
-/**********************************************************************************/
-
-/**
- * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
- */
-
-/* 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)
- */
-bool InspIRCd::AllModulesReportReady(LocalUser* user)
-{
-       ModResult res;
-       FIRST_MOD_RESULT(OnCheckReady, res, (user));
-       return (res == MOD_RES_PASSTHRU);
-}
+sig_atomic_t InspIRCd::s_signal = 0;
 
 void InspIRCd::SetSignal(int signal)
 {
-       *mysig = signal;
+       s_signal = signal;
 }
 
 /* On posix systems, the flow of the program starts right here, with
@@ -828,7 +771,6 @@ void InspIRCd::SetSignal(int signal)
 ENTRYPOINT
 {
        new InspIRCd(argc, argv);
-       mysig = &ServerInstance->s_signal;
        ServerInstance->Run();
        delete ServerInstance;
        return 0;