]> 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 cd36f17475535c049d0fb001771ad290ba7929c6..db7b52ad6e4f225b217c57ae32b0ccb1f41f9834 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *   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 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/>.
  */
 
-using namespace std;
 
-#include <stdio.h>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-#include "hashcomp.h"
+#include "inspircd.h"
 
-/* $ModDesc: Provides the NICKLOCK command, allows an oper to chage a users nick and lock them to it until they quit */
-
-static Server *Srv;
+enum
+{
+       // InspIRCd-specific.
+       ERR_NICKNOTLOCKED = 946,
+       RPL_NICKLOCKON = 947,
+       RPL_NICKLOCKOFF = 945
+};
 
-class cmd_nicklock : public command_t
+/** Handle /NICKLOCK
+ */
+class CommandNicklock : public Command
 {
  public:
-        cmd_nicklock () : command_t("NICKLOCK", 'o', 2)
-        {
-               this->source = "m_nicklock.so";
-        }
+       LocalIntExt& locked;
+       CommandNicklock (Module* Creator, LocalIntExt& ext) : Command(Creator,"NICKLOCK", 2),
+               locked(ext)
+       {
+               flags_needed = 'o';
+               syntax = "<nick> <newnick>";
+               TRANSLATE2(TR_NICK, TR_TEXT);
+       }
 
-       void Handle(char **parameters, int pcnt, userrec *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               userrec* source = Srv->FindNick(std::string(parameters[0]));
-               irc::string server;
-               irc::string me;
+               User* target = ServerInstance->FindNick(parameters[0]);
+
+               if ((!target) || (target->registered != REG_ALL))
+               {
+                       user->WriteNotice("*** No such nickname: '" + parameters[0] + "'");
+                       return CMD_FAILURE;
+               }
 
-               if (source)
+               /* Do local sanity checks and bails */
+               if (IS_LOCAL(user))
                {
-                       if (source->GetExt("nick_locked"))
+                       if (!ServerInstance->IsNick(parameters[1]))
                        {
-                               WriteServ(user->fd,"946 %s %s :This user's nickname is already locked.",user->nick,source->nick);
-                               return;
+                               user->WriteNotice("*** Invalid nickname '" + parameters[1] + "'");
+                               return CMD_FAILURE;
                        }
-                       if (Srv->IsNick(std::string(parameters[1])))
+
+                       user->WriteNumeric(RPL_NICKLOCKON, parameters[1], "Nickname now locked.");
+               }
+
+               /* If we made it this far, extend the user */
+               if (IS_LOCAL(target))
+               {
+                       locked.set(target, 1);
+
+                       std::string oldnick = target->nick;
+                       if (target->ChangeNick(parameters[1]))
+                               ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKLOCK to change and hold "+oldnick+" to "+parameters[1]);
+                       else
                        {
-                               // give them a lock flag
-                               Srv->SendOpers(std::string(user->nick)+" used NICKLOCK to change and hold "+std::string(parameters[0])+" to "+parameters[1]);
-                               Srv->ChangeUserNick(source,std::string(parameters[1]));
-                               // only attempt to set their lockflag after we know the change succeeded
-                               source = Srv->FindNick(std::string(parameters[1]));
-                               if (source)
-                                       source->Extend("nick_locked", "ON");
+                               std::string newnick = target->nick;
+                               ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKLOCK, but "+oldnick+" failed nick change to "+parameters[1]+" and was locked to "+newnick+" instead");
                        }
                }
-       }
-};
 
-class cmd_nickunlock : public command_t
-{
- public:
-       cmd_nickunlock () : command_t("NICKUNLOCK", 'o', 1)
-       {
-               this->source = "m_nickunlock.so";
+               return CMD_SUCCESS;
        }
 
-       void Handle (char **parameters, int pcnt, userrec *user)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               userrec* source = Srv->FindNick(std::string(parameters[0]));
-               if (source)
-               {
-                       source->Shrink("nick_locked");
-                       WriteServ(user->fd,"945 %s %s :Nickname now unlocked.",user->nick,source->nick);
-                       Srv->SendOpers(std::string(user->nick)+" used NICKUNLOCK on "+std::string(parameters[0]));
-               }
+               return ROUTE_OPT_UCAST(parameters[0]);
        }
 };
 
-
-class ModuleNickLock : public Module
+/** Handle /NICKUNLOCK
+ */
+class CommandNickunlock : public Command
 {
-       cmd_nicklock*   cmd1;
-       cmd_nickunlock* cmd2;
  public:
-       ModuleNickLock(Server* Me)
-               : Module::Module(Me)
-       {
-               Srv = Me;
-               cmd1 = new cmd_nicklock();
-               cmd2 = new cmd_nickunlock();
-               Srv->AddCommand(cmd1);
-               Srv->AddCommand(cmd2);
-       }
-       
-       virtual ~ModuleNickLock()
+       LocalIntExt& locked;
+       CommandNickunlock (Module* Creator, LocalIntExt& ext) : Command(Creator,"NICKUNLOCK", 1),
+               locked(ext)
        {
-       }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1,0,0,1,VF_VENDOR);
+               flags_needed = 'o';
+               syntax = "<nick>";
+               TRANSLATE1(TR_NICK);
        }
 
-       void Implements(char* List)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               List[I_OnUserPreNick] = List[I_OnUserQuit] = List[I_OnCleanup] = 1;
-       }
+               User* target = ServerInstance->FindNick(parameters[0]);
 
-       virtual int OnUserPreNick(userrec* user, const std::string &newnick)
-       {
-               if (user->GetExt("nick_locked"))
+               if (!target)
                {
-                       WriteServ(user->fd,"447 %s :You cannot change your nickname (your nick is locked)",user->nick);
-                       return 1;
+                       user->WriteNotice("*** No such nickname: '" + parameters[0] + "'");
+                       return CMD_FAILURE;
                }
-               return 0;
-       }
 
-       virtual void OnUserQuit(userrec* user, const std::string &reason)
-       {
-               user->Shrink("nick_locked");
+               if (IS_LOCAL(target))
+               {
+                       if (locked.set(target, 0))
+                       {
+                               ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used NICKUNLOCK on "+target->nick);
+                               user->WriteRemoteNumeric(RPL_NICKLOCKOFF, target->nick, "Nickname now unlocked.");
+                       }
+                       else
+                       {
+                               user->WriteRemoteNumeric(ERR_NICKNOTLOCKED, target->nick, "This user's nickname is not locked.");
+                               return CMD_FAILURE;
+                       }
+               }
+
+               return CMD_SUCCESS;
        }
 
-       virtual void OnCleanup(int target_type, void* item)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               if(target_type == TYPE_USER)
-               {
-                       userrec* user = (userrec*)item;
-                       user->Shrink("nick_locked");
-               }
+               return ROUTE_OPT_UCAST(parameters[0]);
        }
 };
 
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-
-class ModuleNickLockFactory : public ModuleFactory
+class ModuleNickLock : public Module
 {
+       LocalIntExt locked;
+       CommandNicklock cmd1;
+       CommandNickunlock cmd2;
  public:
-       ModuleNickLockFactory()
+       ModuleNickLock()
+               : locked("nick_locked", ExtensionItem::EXT_USER, this)
+               , cmd1(this, locked)
+               , cmd2(this, locked)
        {
        }
-       
-       ~ModuleNickLockFactory()
+
+       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 Module * CreateModule(Server* Me)
+
+       ModResult OnUserPreNick(LocalUser* user, const std::string& newnick) CXX11_OVERRIDE
        {
-               return new ModuleNickLock(Me);
+               if (locked.get(user))
+               {
+                       user->WriteNumeric(ERR_CANTCHANGENICK, "You cannot change your nickname (your nick is locked)");
+                       return MOD_RES_DENY;
+               }
+               return MOD_RES_PASSTHRU;
        }
-       
-};
-
 
-extern "C" void * init_module( void )
-{
-       return new ModuleNickLockFactory;
-}
+       void Prioritize() CXX11_OVERRIDE
+       {
+               Module *nflood = ServerInstance->Modules->Find("m_nickflood.so");
+               ServerInstance->Modules->SetPriority(this, I_OnUserPreNick, PRIORITY_BEFORE, nflood);
+       }
+};
 
+MODULE_INIT(ModuleNickLock)