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