src/modules/m_setname.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013, 2018-2020 Sadie Powell <sadie@witchery.services>
   5  *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
   6  *   Copyright (C) 2012 Attila Molnar <attilamolnar@hush.com>
   7  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   8  *   Copyright (C) 2007 John Brooks <special@inspircd.org>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #include "inspircd.h"
  26 #include "modules/ircv3.h"
  27 #include "modules/ircv3_replies.h"
  28
  29 class CommandSetName : public SplitCommand
  30 {
  31 private:
  32         IRCv3::Replies::Fail fail;
  33
  34  public:
  35         Cap::Capability cap;
  36         bool notifyopers;
  37
  38         CommandSetName(Module* Creator)
  39                 : SplitCommand(Creator, "SETNAME", 1, 1)
  40                 , fail(Creator)
  41                 , cap(Creator, "setname")
  42         {
  43                 allow_empty_last_param = false;
  44                 syntax = ":<realname>";
  45         }
  46
  47         CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
  48         {
  49                 if (parameters[0].size() > ServerInstance->Config->Limits.MaxReal)
  50                 {
  51                         fail.SendIfCap(user, cap, this, "INVALID_REALNAME", "Real name is too long");
  52                         return CMD_FAILURE;
  53                 }
  54
  55                 if (!user->ChangeRealName(parameters[0]))
  56                 {
  57                         fail.SendIfCap(user, cap, this, "CANNOT_CHANGE_REALNAME", "Unable to change your real name");
  58                         return CMD_FAILURE;
  59                 }
  60
  61                 if (notifyopers)
  62                         ServerInstance->SNO->WriteGlobalSno('a', "%s used SETNAME to change their real name to '%s'",
  63                                 user->nick.c_str(), parameters[0].c_str());
  64                 return CMD_SUCCESS;
  65         }
  66 };
  67
  68 class ModuleSetName : public Module
  69 {
  70  private:
  71         CommandSetName cmd;
  72         ClientProtocol::EventProvider setnameevprov;
  73
  74  public:
  75         ModuleSetName()
  76                 : cmd(this)
  77                 , setnameevprov(this, "SETNAME")
  78         {
  79         }
  80
  81         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
  82         {
  83                 ConfigTag* tag = ServerInstance->Config->ConfValue("setname");
  84
  85                 // Whether the module should only be usable by server operators.
  86                 bool operonly = tag->getBool("operonly");
  87                 cmd.flags_needed = operonly ? 'o' : 0;
  88
  89                 // Whether a snotice should be sent out when a user changes their real name.
  90                 cmd.notifyopers = tag->getBool("notifyopers", !operonly);
  91         }
  92
  93         void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE
  94         {
  95                 if (!(user->registered & REG_NICKUSER))
  96                         return;
  97
  98                 ClientProtocol::Message msg("SETNAME", user);
  99                 msg.PushParamRef(real);
 100                 ClientProtocol::Event protoev(setnameevprov, msg);
 101                 IRCv3::WriteNeighborsWithCap(user, protoev, cmd.cap, true);
 102         }
 103
 104         Version GetVersion() CXX11_OVERRIDE
 105         {
 106                 return Version("Adds the /SETNAME command which allows users to change their real name (gecos).", VF_VENDOR);
 107         }
 108 };
 109
 110 MODULE_INIT(ModuleSetName)