]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_lockserv.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_lockserv.cpp
index d9cd3c67cec8c0848eace982cc1b17a0b4f34c0c..b50ca24c0030455ba1c8256e39ebd14429c5d138 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2013, 2016-2018 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2013 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2006-2007 Dennis Friis <peavey@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/>.
  */
 
-#include "inspircd.h"
 
-/* $ModDesc: Allows locking of the server to stop all incoming connections till unlocked again */
+#include "inspircd.h"
 
 /** Adds numerics
  * 988 <nick> <servername> :Closed for new connections
  * 989 <nick> <servername> :Open for new connections
-*/
-
+ */
+enum
+{
+       // InspIRCd-specific.
+       RPL_SERVLOCKON = 988,
+       RPL_SERVLOCKOFF = 989
+};
 
 class CommandLockserv : public Command
 {
-private:
-       bool& locked;
+       std::string& locked;
 
-public:
-       CommandLockserv (InspIRCd* Instance, bool &lock)
-       : Command(Instance, "LOCKSERV", 'o', 0), locked(lock)
+ public:
+       CommandLockserv(Module* Creator, std::string& lock) : Command(Creator, "LOCKSERV", 0, 1), locked(lock)
        {
-               this->source = "m_lockserv.so";
-               syntax.clear();
+               allow_empty_last_param = false;
+               flags_needed = 'o';
        }
 
-       CmdResult Handle (const char** parameters, int pcnt, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               locked = true;
-               user->WriteServ("988 %s %s :Closed for new connections", user->nick, user->server);
-               ServerInstance->WriteOpers("*** Oper %s used LOCKSERV to temporarily close for new connections", user->nick);
-               /* Dont send to the network */
-               return CMD_LOCALONLY;
+               if (!locked.empty())
+               {
+                       user->WriteNotice("The server is already locked.");
+                       return CMD_FAILURE;
+               }
+
+               locked = parameters.empty() ? "Server is temporarily closed. Please try again later." : parameters[0];
+               user->WriteNumeric(RPL_SERVLOCKON, user->server->GetName(), "Closed for new connections");
+               ServerInstance->SNO->WriteGlobalSno('a', "Oper %s used LOCKSERV to temporarily disallow new connections", user->nick.c_str());
+               return CMD_SUCCESS;
        }
 };
 
 class CommandUnlockserv : public Command
 {
-private:
-       bool& locked;
+       std::string& locked;
 
-public:
-       CommandUnlockserv (InspIRCd* Instance, bool &lock)
-       : Command(Instance, "UNLOCKSERV", 'o', 0), locked(lock)
+ public:
+       CommandUnlockserv(Module* Creator, std::string& lock) : Command(Creator, "UNLOCKSERV", 0), locked(lock)
        {
-               this->source = "m_lockserv.so";
-               syntax.clear();
+               flags_needed = 'o';
        }
 
-       CmdResult Handle (const char** parameters, int pcnt, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               locked = false;
-               user->WriteServ("989 %s %s :Open for new connections", user->nick, user->server);
-               ServerInstance->WriteOpers("*** Oper %s used UNLOCKSERV to allow for new connections", user->nick);
-               /* Dont send to the network */
-               return CMD_LOCALONLY;
+               if (locked.empty())
+               {
+                       user->WriteNotice("The server isn't locked.");
+                       return CMD_FAILURE;
+               }
+
+               locked.clear();
+               user->WriteNumeric(RPL_SERVLOCKOFF, user->server->GetName(), "Open for new connections");
+               ServerInstance->SNO->WriteGlobalSno('a', "Oper %s used UNLOCKSERV to allow new connections", user->nick.c_str());
+               return CMD_SUCCESS;
        }
 };
 
 class ModuleLockserv : public Module
 {
-private:
-       bool locked;
-       CommandLockserv* lockcommand;
-       CommandUnlockserv* unlockcommand;
+       std::string locked;
+       CommandLockserv lockcommand;
+       CommandUnlockserv unlockcommand;
 
-       virtual void ResetLocked()
+ public:
+       ModuleLockserv() : lockcommand(this, locked), unlockcommand(this, locked)
        {
-               locked = false;
        }
 
-public:
-       ModuleLockserv(InspIRCd* Me) : Module(Me)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ResetLocked();
-               lockcommand = new CommandLockserv(ServerInstance, locked);
-               ServerInstance->AddCommand(lockcommand);
-
-               unlockcommand = new CommandUnlockserv(ServerInstance, locked);
-               ServerInstance->AddCommand(unlockcommand);
-               Implementation eventlist[] = { I_OnUserRegister, I_OnRehash, I_OnCheckReady };
-               ServerInstance->Modules->Attach(eventlist, this, 3);
+               // Emergency way to unlock
+               if (!status.srcuser)
+                       locked.clear();
        }
 
-       virtual ~ModuleLockserv()
-       {
-       }
-
-
-       virtual void OnRehash(User* user, const std::string &parameter)
+       void OnModuleRehash(User* user, const std::string& param) CXX11_OVERRIDE
        {
-               ResetLocked();
+               if (irc::equals(param, "lockserv") && !locked.empty())
+                       locked.clear();
        }
 
-       virtual int OnUserRegister(User* user)
+       ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
        {
-               if (locked)
+               if (!locked.empty())
                {
-                       User::QuitUser(ServerInstance, user, "Server is temporarily closed. Please try again later.");
-                       return 1;
+                       ServerInstance->Users->QuitUser(user, locked);
+                       return MOD_RES_DENY;
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual bool OnCheckReady(User* user)
+       ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
        {
-               return !locked;
+               return !locked.empty() ? MOD_RES_DENY : MOD_RES_PASSTHRU;
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version(1, 0, 0, 1, VF_VENDOR, API_VERSION);
+               return Version("Adds the /LOCKSERV and /UNLOCKSERV commands which allows server operators to control whether users can connect to the local server.", VF_VENDOR);
        }
 };