Sync helpop chmodes s and p with docs

[user/henk/code/inspircd.git] / src / modules / m_conn_waitpong.cpp

diff --git a/src/modules/m_conn_waitpong.cpp b/src/modules/m_conn_waitpong.cpp
index 362835c6db0c8cba1845ca28a07dce220b682c8c..df04405d8d27c42ceacf93330311ae09179454f4 100644 (file)
--- a/src/modules/m_conn_waitpong.cpp
+++ b/src/modules/m_conn_waitpong.cpp
@@ -1,19 +1,30 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2013, 2015, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2006 Oliver Lupton <om@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: Forces connecting clients to send a PONG message back to the server before they can complete their connection */
+#include "inspircd.h"
 
 class ModuleWaitPong : public Module
 {
@@ -23,52 +34,33 @@ class ModuleWaitPong : public Module
 
  public:
        ModuleWaitPong()
-        : ext("waitpong_pingstr", this)
+               : ext("waitpong_pingstr", ExtensionItem::EXT_USER, this)
        {
-               OnRehash(NULL);
-               Implementation eventlist[] = { I_OnUserRegister, I_OnCheckReady, I_OnPreCommand, I_OnRehash };
-               ServerInstance->Modules->Attach(eventlist, this, 4);
-       }
-
-       void OnRehash(User* user)
-       {
-               ConfigReader Conf;
-
-               sendsnotice = Conf.ReadFlag("waitpong", "sendsnotice", 0);
-
-               if(Conf.GetError() == CONF_VALUE_NOT_FOUND)
-                       sendsnotice = true;
-
-               killonbadreply = Conf.ReadFlag("waitpong", "killonbadreply", 0);
-
-               if(Conf.GetError() == CONF_VALUE_NOT_FOUND)
-                       killonbadreply = true;
        }
 
-       std::string RandString()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               char out[11];
-               for(unsigned int i = 0; i < 10; i++)
-                       out[i] = ((rand() % 26) + 65);
-               out[10] = '\0';
-
-               return out;
+               ConfigTag* tag = ServerInstance->Config->ConfValue("waitpong");
+               sendsnotice = tag->getBool("sendsnotice", false);
+               killonbadreply = tag->getBool("killonbadreply", true);
        }
 
-       ModResult OnUserRegister(LocalUser* user)
+       ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
        {
-               std::string pingrpl = RandString();
-
-               user->Write("PING :%s", pingrpl.c_str());
+               std::string pingrpl = ServerInstance->GenRandomStr(10);
+               {
+                       ClientProtocol::Messages::Ping pingmsg(pingrpl);
+                       user->Send(ServerInstance->GetRFCEvents().ping, pingmsg);
+               }
 
                if(sendsnotice)
-                       user->WriteServ("NOTICE %s :*** If you are having problems connecting due to ping timeouts, please type /quote PONG %s or /raw PONG %s now.", user->nick.c_str(), pingrpl.c_str(), pingrpl.c_str());
+                       user->WriteNotice("*** If you are having problems connecting due to registration timeouts type /quote PONG " + pingrpl + " or /raw PONG " + pingrpl + " now.");
 
                ext.set(user, pingrpl);
                return MOD_RES_PASSTHRU;
        }
 
-       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, User* user, bool validated, const std::string &original_line)
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
        {
                if (command == "PONG")
                {
@@ -92,20 +84,15 @@ class ModuleWaitPong : public Module
                return MOD_RES_PASSTHRU;
        }
 
-       ModResult OnCheckReady(LocalUser* user)
+       ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
        {
                return ext.get(user) ? MOD_RES_DENY : MOD_RES_PASSTHRU;
        }
 
-       ~ModuleWaitPong()
+       Version GetVersion() CXX11_OVERRIDE
        {
+               return Version("Requires all clients to respond to a PING request before they can fully connect.", VF_VENDOR);
        }
-
-       Version GetVersion()
-       {
-               return Version("Require pong prior to registration", VF_VENDOR);
-       }
-
 };
 
 MODULE_INIT(ModuleWaitPong)