]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_services_account.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_services_account.cpp
index aac0b9ce079d7f3fff6264a8d8d57512e16d1780..7baa9c75f5cd50f3070cd68e8e524b500d88dba2 100644 (file)
@@ -1,12 +1,16 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2012 Shawn Smith <shawn@inspircd.org>
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
- *   Copyright (C) 2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 Shawn Smith <ShawnSmith0828@gmail.com>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2006, 2008 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
 
 #include "inspircd.h"
 #include "modules/account.h"
+#include "modules/callerid.h"
+#include "modules/ctctags.h"
+#include "modules/exemption.h"
+#include "modules/whois.h"
+
+enum
+{
+       // From UnrealIRCd.
+       RPL_WHOISREGNICK = 307,
+
+       // From ircu.
+       RPL_WHOISACCOUNT = 330,
+
+       // From ircd-hybrid?
+       ERR_NEEDREGGEDNICK = 477,
+
+       // From IRCv3 sasl-3.1.
+       RPL_LOGGEDIN = 900,
+       RPL_LOGGEDOUT = 901
+};
 
 /** Channel mode +r - mark a channel as identified
  */
@@ -32,9 +56,9 @@ class Channel_r : public ModeHandler
  public:
        Channel_r(Module* Creator) : ModeHandler(Creator, "c_registered", 'r', PARAM_NONE, MODETYPE_CHANNEL) { }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
-               // only a u-lined server may add or remove the +r mode.
+               // Only a U-lined server may add or remove the +r mode.
                if (!IS_LOCAL(source))
                {
                        // Only change the mode if it's not redundant
@@ -46,7 +70,7 @@ class Channel_r : public ModeHandler
                }
                else
                {
-                       source->WriteNumeric(500, ":Only a server may modify the +r channel mode");
+                       source->WriteNumeric(ERR_NOPRIVILEGES, "Only a server may modify the +r channel mode");
                }
                return MODEACTION_DENY;
        }
@@ -60,7 +84,7 @@ class User_r : public ModeHandler
  public:
        User_r(Module* Creator) : ModeHandler(Creator, "u_registered", 'r', PARAM_NONE, MODETYPE_USER) { }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
                if (!IS_LOCAL(source))
                {
@@ -72,80 +96,79 @@ class User_r : public ModeHandler
                }
                else
                {
-                       source->WriteNumeric(500, ":Only a server may modify the +r user mode");
+                       source->WriteNumeric(ERR_NOPRIVILEGES, "Only a server may modify the +r user mode");
                }
                return MODEACTION_DENY;
        }
 };
 
-/** Channel mode +R - unidentified users cannot join
- */
-class AChannel_R : public SimpleChannelModeHandler
-{
- public:
-       AChannel_R(Module* Creator) : SimpleChannelModeHandler(Creator, "reginvite", 'R') { }
-};
-
-/** User mode +R - unidentified users cannot message
- */
-class AUser_R : public SimpleUserModeHandler
-{
- public:
-       AUser_R(Module* Creator) : SimpleUserModeHandler(Creator, "regdeaf", 'R') { }
-};
-
-/** Channel mode +M - unidentified users cannot message channel
- */
-class AChannel_M : public SimpleChannelModeHandler
-{
- public:
-       AChannel_M(Module* Creator) : SimpleChannelModeHandler(Creator, "regmoderated", 'M') { }
-};
-
 class AccountExtItemImpl : public AccountExtItem
 {
+       Events::ModuleEventProvider eventprov;
+
  public:
        AccountExtItemImpl(Module* mod)
                : AccountExtItem("accountname", ExtensionItem::EXT_USER, mod)
+               , eventprov(mod, "event/account")
        {
        }
 
-       void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
+       void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE
        {
-               User* user = static_cast<User*>(container);
+               StringExtItem::FromInternal(container, value);
+       }
 
-               StringExtItem::unserialize(format, container, value);
-               if (!value.empty())
+       void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
+       {
+               StringExtItem::FromNetwork(container, value);
+
+               User* user = static_cast<User*>(container);
+               if (IS_LOCAL(user))
                {
-                       // Logged in
-                       if (IS_LOCAL(user))
+                       if (value.empty())
                        {
-                               user->WriteNumeric(900, "%s %s :You are now logged in as %s",
-                                       user->GetFullHost().c_str(), value.c_str(), value.c_str());
+                               // Logged out.
+                               user->WriteNumeric(RPL_LOGGEDOUT, user->GetFullHost(), "You are now logged out");
+                       }
+                       else
+                       {
+                               // Logged in.
+                               user->WriteNumeric(RPL_LOGGEDIN, user->GetFullHost(), value, InspIRCd::Format("You are now logged in as %s", value.c_str()));
                        }
-
-                       AccountEvent(creator, user, value).Send();
-               }
-               else
-               {
-                       // Logged out
-                       AccountEvent(creator, user, "").Send();
                }
+
+               FOREACH_MOD_CUSTOM(eventprov, AccountEventListener, OnAccountChange, (user, value));
        }
 };
 
-class ModuleServicesAccount : public Module
+class ModuleServicesAccount
+       : public Module
+       , public Whois::EventListener
+       , public CTCTags::EventListener
 {
-       AChannel_R m1;
-       AChannel_M m2;
-       AUser_R m3;
-       Channel_r m4;
-       User_r m5;
+ private:
+       CallerID::API calleridapi;
+       CheckExemption::EventProvider exemptionprov;
+       SimpleChannelModeHandler reginvitemode;
+       SimpleChannelModeHandler regmoderatedmode;
+       SimpleUserModeHandler regdeafmode;
+       Channel_r chanregmode;
+       User_r userregmode;
        AccountExtItemImpl accountname;
        bool checking_ban;
+
  public:
-       ModuleServicesAccount() : m1(this), m2(this), m3(this), m4(this), m5(this),
-               accountname(this)
+       ModuleServicesAccount()
+               : Whois::EventListener(this)
+               , CTCTags::EventListener(this)
+               , calleridapi(this)
+               , exemptionprov(this)
+               , reginvitemode(this, "reginvite", 'R')
+               , regmoderatedmode(this, "regmoderated", 'M')
+               , regdeafmode(this, "regdeaf", 'R')
+               , chanregmode(this)
+               , userregmode(this)
+               , accountname(this)
                , checking_ban(false)
        {
        }
@@ -157,30 +180,30 @@ class ModuleServicesAccount : public Module
        }
 
        /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
-       void OnWhois(User* source, User* dest) CXX11_OVERRIDE
+       void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
        {
-               std::string *account = accountname.get(dest);
+               std::string* account = accountname.get(whois.GetTarget());
 
                if (account)
                {
-                       ServerInstance->SendWhoisLine(source, dest, 330, "%s %s :is logged in as", dest->nick.c_str(), account->c_str());
+                       whois.SendLine(RPL_WHOISACCOUNT, *account, "is logged in as");
                }
 
-               if (dest->IsModeSet(m5))
+               if (whois.GetTarget()->IsModeSet(userregmode))
                {
                        /* user is registered */
-                       ServerInstance->SendWhoisLine(source, dest, 307, "%s :is a registered nick", dest->nick.c_str());
+                       whois.SendLine(RPL_WHOISREGNICK, "is a registered nick");
                }
        }
 
        void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
        {
                /* On nickchange, if they have +r, remove it */
-               if (user->IsModeSet(m5) && assign(user->nick) != oldnick)
-                       m5.RemoveMode(user);
+               if ((user->IsModeSet(userregmode)) && (ServerInstance->FindNickOnly(oldnick) != user))
+                       userregmode.RemoveMode(user);
        }
 
-       ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
+       ModResult HandleMessage(User* user, const MessageTarget& target)
        {
                if (!IS_LOCAL(user))
                        return MOD_RES_PASSTHRU;
@@ -188,32 +211,53 @@ class ModuleServicesAccount : public Module
                std::string *account = accountname.get(user);
                bool is_registered = account && !account->empty();
 
-               if (target_type == TYPE_CHANNEL)
+               switch (target.type)
                {
-                       Channel* c = (Channel*)dest;
-                       ModResult res = ServerInstance->OnCheckExemption(user,c,"regmoderated");
-
-                       if (c->IsModeSet(m2) && !is_registered && res != MOD_RES_ALLOW)
+                       case MessageTarget::TYPE_CHANNEL:
                        {
-                               // user messaging a +M channel and is not registered
-                               user->WriteNumeric(477, c->name+" :You need to be identified to a registered account to message this channel");
+                               Channel* targchan = target.Get<Channel>();
+
+                               if (!targchan->IsModeSet(regmoderatedmode) || is_registered)
+                                       return MOD_RES_PASSTHRU;
+
+                               if (CheckExemption::Call(exemptionprov, user, targchan, "regmoderated") == MOD_RES_ALLOW)
+                                       return MOD_RES_PASSTHRU;
+
+                               // User is messaging a +M channel and is not registered or exempt.
+                               user->WriteNumeric(ERR_NEEDREGGEDNICK, targchan->name, "You need to be identified to a registered account to message this channel");
                                return MOD_RES_DENY;
+                               break;
                        }
-               }
-               else if (target_type == TYPE_USER)
-               {
-                       User* u = (User*)dest;
-
-                       if (u->IsModeSet(m3) && !is_registered)
+                       case MessageTarget::TYPE_USER:
                        {
-                               // user messaging a +R user and is not registered
-                               user->WriteNumeric(477, u->nick +" :You need to be identified to a registered account to message this user");
+                               User* targuser = target.Get<User>();
+                               if (!targuser->IsModeSet(regdeafmode)  || is_registered)
+                                       return MOD_RES_PASSTHRU;
+
+                               if (calleridapi && calleridapi->IsOnAcceptList(user, targuser))
+                                       return MOD_RES_PASSTHRU;
+
+                               // User is messaging a +R user and is not registered or on an accept list.
+                               user->WriteNumeric(ERR_NEEDREGGEDNICK, targuser->nick, "You need to be identified to a registered account to message this user");
                                return MOD_RES_DENY;
+                               break;
                        }
+                       case MessageTarget::TYPE_SERVER:
+                               break;
                }
                return MOD_RES_PASSTHRU;
        }
 
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target);
+       }
+
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target);
+       }
+
        ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
        {
                if (checking_ban)
@@ -257,12 +301,12 @@ class ModuleServicesAccount : public Module
 
                if (chan)
                {
-                       if (chan->IsModeSet(m1))
+                       if (chan->IsModeSet(reginvitemode))
                        {
                                if (!is_registered)
                                {
                                        // joining a +R channel and not identified
-                                       user->WriteNumeric(477, chan->name + " :You need to be identified to a registered account to join this channel");
+                                       user->WriteNumeric(ERR_NEEDREGGEDNICK, chan->name, "You need to be identified to a registered account to join this channel");
                                        return MOD_RES_DENY;
                                }
                        }
@@ -273,13 +317,17 @@ class ModuleServicesAccount : public Module
        ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
        {
                if (myclass->config->getBool("requireaccount") && !accountname.get(user))
+               {
+                       ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires the user to be logged into an account",
+                               myclass->GetName().c_str());
                        return MOD_RES_DENY;
+               }
                return MOD_RES_PASSTHRU;
        }
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides support for ircu-style services accounts, including chmode +R, etc.",VF_OPTCOMMON|VF_VENDOR);
+               return Version("Adds various channel and user modes relating to services accounts.", VF_OPTCOMMON|VF_VENDOR);
        }
 };