]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_nicklock.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_nicklock.cpp
index e7c9e01994cd85d2d2a8c4f38f2ecba406c26cd6..db7b52ad6e4f225b217c57ae32b0ccb1f41f9834 100644 (file)
@@ -1,71 +1,82 @@
-/*       +------------------------------------+
- *       | 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, 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) 2005-2006, 2008, 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/>.
  */
 
+
 #include "inspircd.h"
 
-/* $ModDesc: Provides the NICKLOCK command, allows an oper to chage a users nick and lock them to it until they quit */
+enum
+{
+       // InspIRCd-specific.
+       ERR_NICKNOTLOCKED = 946,
+       RPL_NICKLOCKON = 947,
+       RPL_NICKLOCKOFF = 945
+};
 
 /** Handle /NICKLOCK
  */
 class CommandNicklock : public Command
 {
-
  public:
-       CommandNicklock (InspIRCd* Instance, Module* Creator) : Command(Instance, Creator,"NICKLOCK", "o", 2)
+       LocalIntExt& locked;
+       CommandNicklock (Module* Creator, LocalIntExt& ext) : Command(Creator,"NICKLOCK", 2),
+               locked(ext)
        {
-               syntax = "<oldnick> <newnick>";
-               TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
+               flags_needed = 'o';
+               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]);
 
+               if ((!target) || (target->registered != REG_ALL))
+               {
+                       user->WriteNotice("*** No such nickname: '" + parameters[0] + "'");
+                       return CMD_FAILURE;
+               }
+
                /* Do local sanity checks and bails */
                if (IS_LOCAL(user))
                {
-                       if (target && ServerInstance->ULine(target->server))
+                       if (!ServerInstance->IsNick(parameters[1]))
                        {
-                               user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Cannot use an NICKLOCK command on a u-lined client",user->nick.c_str());
+                               user->WriteNotice("*** Invalid nickname '" + parameters[1] + "'");
                                return CMD_FAILURE;
                        }
 
-                       if (!target)
-                       {
-                               user->WriteServ("NOTICE %s :*** No such nickname: '%s'", user->nick.c_str(), parameters[0].c_str());
-                               return CMD_FAILURE;
-                       }
-
-                       if (!ServerInstance->IsNick(parameters[1].c_str(), ServerInstance->Config->Limits.NickMax))
-                       {
-                               user->WriteServ("NOTICE %s :*** Invalid nickname '%s'", user->nick.c_str(), parameters[1].c_str());
-                               return CMD_FAILURE;
-                       }
-
-                       user->WriteServ("947 %s %s :Nickname now locked.", user->nick.c_str(), parameters[1].c_str());
+                       user->WriteNumeric(RPL_NICKLOCKON, parameters[1], "Nickname now locked.");
                }
 
                /* If we made it this far, extend the user */
-               if (target && IS_LOCAL(target))
+               if (IS_LOCAL(target))
                {
-                       // This has to be done *here*, because this metadata must be stored netwide.
-                       target->Extend("nick_locked", "ON");
-
-                       /* Only send out nick from local server */
-                       target->Extend("nick_locked");
+                       locked.set(target, 1);
 
                        std::string oldnick = target->nick;
-                       if (target->ForceNickChange(parameters[1].c_str()))
+                       if (target->ChangeNick(parameters[1]))
                                ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKLOCK to change and hold "+oldnick+" to "+parameters[1]);
                        else
                        {
@@ -77,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]);
        }
 };
 
@@ -91,42 +99,35 @@ class CommandNicklock : public Command
 class CommandNickunlock : public Command
 {
  public:
-       CommandNickunlock (InspIRCd* Instance, Module* Creator) : Command(Instance, Creator,"NICKUNLOCK", "o", 1)
+       LocalIntExt& locked;
+       CommandNickunlock (Module* Creator, LocalIntExt& ext) : Command(Creator,"NICKUNLOCK", 1),
+               locked(ext)
        {
-               syntax = "<locked-nick>";
-               TRANSLATE2(TR_NICK, TR_END);
+               flags_needed = 'o';
+               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]);
 
-               /* Do local sanity checks and bails */
-               if (IS_LOCAL(user))
+               if (!target)
                {
-                       if (target && ServerInstance->ULine(target->server))
-                       {
-                               user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Cannot use an NICKUNLOCK command on a u-lined client",user->nick.c_str());
-                               return CMD_FAILURE;
-                       }
-
-                       if (!target)
-                       {
-                               user->WriteServ("NOTICE %s :*** No such nickname: '%s'", user->nick.c_str(), parameters[0].c_str());
-                               return CMD_FAILURE;
-                       }
+                       user->WriteNotice("*** No such nickname: '" + parameters[0] + "'");
+                       return CMD_FAILURE;
                }
 
-               if (target && IS_LOCAL(target))
+               if (IS_LOCAL(target))
                {
-                       if (target->Shrink("nick_locked"))
+                       if (locked.set(target, 0))
                        {
-                               ServerInstance->SNO->WriteGlobalSno('a', std::string(user->nick)+" used NICKUNLOCK on "+parameters[0]);
-                               user->WriteNumeric(945, "%s %s :Nickname now unlocked.",user->nick.c_str(),target->nick.c_str());
+                               ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKUNLOCK on "+target->nick);
+                               user->WriteRemoteNumeric(RPL_NICKLOCKOFF, target->nick, "Nickname now unlocked.");
                        }
                        else
                        {
-                               user->WriteNumeric(946, "%s %s :This user's nickname is not locked.",user->nick.c_str(),target->nick.c_str());
+                               user->WriteRemoteNumeric(ERR_NICKNOTLOCKED, target->nick, "This user's nickname is not locked.");
                                return CMD_FAILURE;
                        }
                }
@@ -134,77 +135,44 @@ 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]);
        }
 };
 
-
 class ModuleNickLock : public Module
 {
+       LocalIntExt locked;
        CommandNicklock cmd1;
        CommandNickunlock cmd2;
  public:
-       ModuleNickLock(InspIRCd* Me)
-               : Module(Me), cmd1(Me, this), cmd2(Me, this)
+       ModuleNickLock()
+               : locked("nick_locked", ExtensionItem::EXT_USER, this)
+               , cmd1(this, locked)
+               , cmd2(this, locked)
        {
-               ServerInstance->AddCommand(&cmd1);
-               ServerInstance->AddCommand(&cmd2);
-               Implementation eventlist[] = { I_OnUserPreNick, I_OnUserQuit, I_OnCleanup };
-               ServerInstance->Modules->Attach(eventlist, this, 3);
        }
 
-       virtual ~ModuleNickLock()
+       Version GetVersion() CXX11_OVERRIDE
        {
+               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);
        }
 
-       virtual Version GetVersion()
+       ModResult OnUserPreNick(LocalUser* user, const std::string& newnick) CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
-       }
-
-
-       virtual ModResult OnUserPreNick(User* user, const std::string &newnick)
-       {
-               if (!IS_LOCAL(user))
-                       return MOD_RES_PASSTHRU;
-
-               if (isdigit(newnick[0])) /* Allow a switch to a UID */
-                       return MOD_RES_PASSTHRU;
-
-               if (user->GetExt("NICKForced")) /* Allow forced nick changes */
-                       return MOD_RES_PASSTHRU;
-
-               if (user->GetExt("nick_locked"))
+               if (locked.get(user))
                {
-                       user->WriteNumeric(447, "%s :You cannot change your nickname (your nick is locked)",user->nick.c_str());
+                       user->WriteNumeric(ERR_CANTCHANGENICK, "You cannot change your nickname (your nick is locked)");
                        return MOD_RES_DENY;
                }
                return MOD_RES_PASSTHRU;
        }
 
-       virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
-       {
-               user->Shrink("nick_locked");
-       }
-
-       void Prioritize()
+       void Prioritize() CXX11_OVERRIDE
        {
                Module *nflood = ServerInstance->Modules->Find("m_nickflood.so");
-               ServerInstance->Modules->SetPriority(this, I_OnUserPreJoin, PRIORITY_BEFORE, &nflood);
-       }
-
-       virtual void OnCleanup(int target_type, void* item)
-       {
-               if(target_type == TYPE_USER)
-               {
-                       User* user = (User*)item;
-                       user->Shrink("nick_locked");
-               }
+               ServerInstance->Modules->SetPriority(this, I_OnUserPreNick, PRIORITY_BEFORE, nflood);
        }
 };