Sync helpop chmodes s and p with docs

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

diff --git a/src/modules/m_nicklock.cpp b/src/modules/m_nicklock.cpp
index 634982d14dc72a8d226a8674098362633cd91125..db7b52ad6e4f225b217c57ae32b0ccb1f41f9834 100644 (file)
--- a/src/modules/m_nicklock.cpp
+++ b/src/modules/m_nicklock.cpp
@@ -1,10 +1,14 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2013, 2017-2018 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2005-2006 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2005-2006, 2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
@@ -22,6 +26,14 @@
 
 #include "inspircd.h"
 
+enum
+{
+       // InspIRCd-specific.
+       ERR_NICKNOTLOCKED = 946,
+       RPL_NICKLOCKON = 947,
+       RPL_NICKLOCKOFF = 945
+};
+
 /** Handle /NICKLOCK
  */
 class CommandNicklock : public Command
@@ -32,11 +44,11 @@ class CommandNicklock : public Command
                locked(ext)
        {
                flags_needed = 'o';
-               syntax = "<oldnick> <newnick>";
+               syntax = "<nick> <newnick>";
                TRANSLATE2(TR_NICK, TR_TEXT);
        }
 
-       CmdResult Handle(const std::vector<std::string>& parameters, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                User* target = ServerInstance->FindNick(parameters[0]);
 
@@ -55,7 +67,7 @@ class CommandNicklock : public Command
                                return CMD_FAILURE;
                        }
 
-                       user->WriteNumeric(947, parameters[1], "Nickname now locked.");
+                       user->WriteNumeric(RPL_NICKLOCKON, parameters[1], "Nickname now locked.");
                }
 
                /* If we made it this far, extend the user */
@@ -76,12 +88,9 @@ class CommandNicklock : public Command
                return CMD_SUCCESS;
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               User* dest = ServerInstance->FindNick(parameters[0]);
-               if (dest)
-                       return ROUTE_OPT_UCAST(dest->server);
-               return ROUTE_LOCALONLY;
+               return ROUTE_OPT_UCAST(parameters[0]);
        }
 };
 
@@ -95,11 +104,11 @@ class CommandNickunlock : public Command
                locked(ext)
        {
                flags_needed = 'o';
-               syntax = "<locked-nick>";
+               syntax = "<nick>";
                TRANSLATE1(TR_NICK);
        }
 
-       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                User* target = ServerInstance->FindNick(parameters[0]);
 
@@ -114,13 +123,11 @@ class CommandNickunlock : public Command
                        if (locked.set(target, 0))
                        {
                                ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKUNLOCK on "+target->nick);
-                               user->SendText(":%s 945 %s %s :Nickname now unlocked.",
-                                       ServerInstance->Config->ServerName.c_str(),user->nick.c_str(),target->nick.c_str());
+                               user->WriteRemoteNumeric(RPL_NICKLOCKOFF, target->nick, "Nickname now unlocked.");
                        }
                        else
                        {
-                               user->SendText(":%s 946 %s %s :This user's nickname is not locked.",
-                                       ServerInstance->Config->ServerName.c_str(),user->nick.c_str(),target->nick.c_str());
+                               user->WriteRemoteNumeric(ERR_NICKNOTLOCKED, target->nick, "This user's nickname is not locked.");
                                return CMD_FAILURE;
                        }
                }
@@ -128,12 +135,9 @@ class CommandNickunlock : public Command
                return CMD_SUCCESS;
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               User* dest = ServerInstance->FindNick(parameters[0]);
-               if (dest)
-                       return ROUTE_OPT_UCAST(dest->server);
-               return ROUTE_LOCALONLY;
+               return ROUTE_OPT_UCAST(parameters[0]);
        }
 };
 
@@ -152,7 +156,7 @@ class ModuleNickLock : public Module
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides the NICKLOCK command, allows an oper to change a users nick and lock them to it until they quit", VF_OPTCOMMON | VF_VENDOR);
+               return Version("Adds the /NICKLOCK command which allows server operators to change a user's nickname and prevent them from changing it again until they disconnect.", VF_OPTCOMMON | VF_VENDOR);
        }
 
        ModResult OnUserPreNick(LocalUser* user, const std::string& newnick) CXX11_OVERRIDE
@@ -165,7 +169,7 @@ class ModuleNickLock : public Module
                return MOD_RES_PASSTHRU;
        }
 
-       void Prioritize()
+       void Prioritize() CXX11_OVERRIDE
        {
                Module *nflood = ServerInstance->Modules->Find("m_nickflood.so");
                ServerInstance->Modules->SetPriority(this, I_OnUserPreNick, PRIORITY_BEFORE, nflood);