]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_services_account.cpp
Space-delimit the human readable callerid extensible data.
[user/henk/code/inspircd.git] / src / modules / m_services_account.cpp
index 283310621240c76ad5b52e195418d70b851ecd57..7baa9c75f5cd50f3070cd68e8e524b500d88dba2 100644 (file)
@@ -1,48 +1,78 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   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 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"
-#include "account.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,
 
-/* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
+       // From IRCv3 sasl-3.1.
+       RPL_LOGGEDIN = 900,
+       RPL_LOGGEDOUT = 901
+};
 
 /** Channel mode +r - mark a channel as identified
  */
 class Channel_r : public ModeHandler
 {
-
  public:
-       Channel_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_CHANNEL, false) { }
+       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, bool)
+       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.
-               if (IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
+               // 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
-                       if ((adding && !channel->IsModeSet('r')) || (!adding && channel->IsModeSet('r')))
+                       if ((adding != channel->IsModeSet(this)))
                        {
-                               channel->SetMode('r',adding);
+                               channel->SetMode(this, adding);
                                return MODEACTION_ALLOW;
                        }
-
-                       return MODEACTION_DENY;
                }
                else
                {
-                       source->WriteNumeric(500, "%s :Only a server may modify the +r channel mode", source->nick.c_str());
-                       return MODEACTION_DENY;
+                       source->WriteNumeric(ERR_NOPRIVILEGES, "Only a server may modify the +r channel mode");
                }
+               return MODEACTION_DENY;
        }
 };
 
@@ -52,326 +82,252 @@ class User_r : public ModeHandler
 {
 
  public:
-       User_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_USER, false) { }
+       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, bool)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
-               if (IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
+               if (!IS_LOCAL(source))
                {
-                       if ((adding && !dest->IsModeSet('r')) || (!adding && dest->IsModeSet('r')))
+                       if ((adding != dest->IsModeSet(this)))
                        {
-                               dest->SetMode('r',adding);
+                               dest->SetMode(this, adding);
                                return MODEACTION_ALLOW;
                        }
-                       return MODEACTION_DENY;
                }
                else
                {
-                       source->WriteNumeric(500, "%s :Only a server may modify the +r user mode", source->nick.c_str());
-                       return MODEACTION_DENY;
+                       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
+class AccountExtItemImpl : public AccountExtItem
 {
- public:
-       AChannel_R(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'R') { }
-};
+       Events::ModuleEventProvider eventprov;
 
-/** User mode +R - unidentified users cannot message
- */
-class AUser_R : public SimpleUserModeHandler
-{
  public:
-       AUser_R(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'R') { }
-};
+       AccountExtItemImpl(Module* mod)
+               : AccountExtItem("accountname", ExtensionItem::EXT_USER, mod)
+               , eventprov(mod, "event/account")
+       {
+       }
 
-/** Channel mode +M - unidentified users cannot message channel
- */
-class AChannel_M : public SimpleChannelModeHandler
-{
- public:
-       AChannel_M(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'M') { }
-};
+       void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE
+       {
+               StringExtItem::FromInternal(container, value);
+       }
 
-class ModuleServicesAccount : public Module
-{
-       AChannel_R* m1;
-       AChannel_M* m2;
-       AUser_R* m3;
-       Channel_r *m4;
-       User_r *m5;
- public:
-       ModuleServicesAccount(InspIRCd* Me) : Module(Me)
+       void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
        {
-               m1 = new AChannel_R(ServerInstance);
-               m2 = new AChannel_M(ServerInstance);
-               m3 = new AUser_R(ServerInstance);
-               m4 = new Channel_r(ServerInstance);
-               m5 = new User_r(ServerInstance);
+               StringExtItem::FromNetwork(container, value);
+
+               User* user = static_cast<User*>(container);
+               if (IS_LOCAL(user))
+               {
+                       if (value.empty())
+                       {
+                               // 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()));
+                       }
+               }
 
-               if (!ServerInstance->Modes->AddMode(m1) || !ServerInstance->Modes->AddMode(m2) || !ServerInstance->Modes->AddMode(m3) || !ServerInstance->Modes->AddMode(m4) || !ServerInstance->Modes->AddMode(m5))
-                       throw ModuleException("Some other module has claimed our modes!");
+               FOREACH_MOD_CUSTOM(eventprov, AccountEventListener, OnAccountChange, (user, value));
+       }
+};
 
-               Implementation eventlist[] = { I_OnWhois, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreJoin,
-                       I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup, I_OnDecodeMetaData, I_On005Numeric, I_OnUserPostNick };
+class ModuleServicesAccount
+       : public Module
+       , public Whois::EventListener
+       , public CTCTags::EventListener
+{
+ private:
+       CallerID::API calleridapi;
+       CheckExemption::EventProvider exemptionprov;
+       SimpleChannelModeHandler reginvitemode;
+       SimpleChannelModeHandler regmoderatedmode;
+       SimpleUserModeHandler regdeafmode;
+       Channel_r chanregmode;
+       User_r userregmode;
+       AccountExtItemImpl accountname;
+       bool checking_ban;
 
-               ServerInstance->Modules->Attach(eventlist, this, 10);
+ public:
+       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)
+       {
        }
 
-       virtual void On005Numeric(std::string &t)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               ServerInstance->AddExtBanChar('R');
-               ServerInstance->AddExtBanChar('M');
+               tokens["EXTBAN"].push_back('R');
+               tokens["EXTBAN"].push_back('U');
        }
 
        /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
-       virtual void OnWhois(User* source, User* dest)
+       void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
        {
-               std::string *account;
-               dest->GetExt("accountname", account);
+               std::string* account = accountname.get(whois.GetTarget());
 
                if (account)
                {
-                       ServerInstance->SendWhoisLine(source, dest, 330, "%s %s %s :is logged in as", source->nick.c_str(), dest->nick.c_str(), account->c_str());
+                       whois.SendLine(RPL_WHOISACCOUNT, *account, "is logged in as");
                }
 
-               if (dest->IsModeSet('r'))
+               if (whois.GetTarget()->IsModeSet(userregmode))
                {
                        /* user is registered */
-                       ServerInstance->SendWhoisLine(source, dest, 307, "%s %s :is a registered nick", source->nick.c_str(), dest->nick.c_str());
+                       whois.SendLine(RPL_WHOISREGNICK, "is a registered nick");
                }
        }
 
-       virtual void OnUserPostNick(User* user, const std::string &oldnick)
+       void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
        {
                /* On nickchange, if they have +r, remove it */
-               if (user->IsModeSet('r') && assign(user->nick) != oldnick)
-               {
-                       std::vector<std::string> modechange;
-                       modechange.push_back(user->nick);
-                       modechange.push_back("-r");
-                       ServerInstance->SendMode(modechange, user);
-               }
+               if ((user->IsModeSet(userregmode)) && (ServerInstance->FindNickOnly(oldnick) != user))
+                       userregmode.RemoveMode(user);
        }
 
-       virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+       ModResult HandleMessage(User* user, const MessageTarget& target)
        {
                if (!IS_LOCAL(user))
-                       return 0;
+                       return MOD_RES_PASSTHRU;
 
-               std::string *account;
-               user->GetExt("accountname", account);
-               bool is_registered = !account->empty();
+               std::string *account = accountname.get(user);
+               bool is_registered = account && !account->empty();
 
-               if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
+               switch (target.type)
                {
-                       // user is ulined, can speak regardless
-                       return 0;
-               }
+                       case MessageTarget::TYPE_CHANNEL:
+                       {
+                               Channel* targchan = target.Get<Channel>();
 
-               if (target_type == TYPE_CHANNEL)
-               {
-                       Channel* c = (Channel*)dest;
+                               if (!targchan->IsModeSet(regmoderatedmode) || is_registered)
+                                       return MOD_RES_PASSTHRU;
 
-                       if (c->IsModeSet('M') && !is_registered)
-                       {
-                               // user messaging a +M channel and is not registered
-                               user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You need to be identified to a registered account to message this channel");
-                               return 1;
-                       }
+                               if (CheckExemption::Call(exemptionprov, user, targchan, "regmoderated") == MOD_RES_ALLOW)
+                                       return MOD_RES_PASSTHRU;
 
-                       if (account)
-                       {
-                               if (c->IsExtBanned(*account, 'M'))
-                               {
-                                       // may not speak (text is deliberately vague, so they don't know which restriction to evade)
-                                       user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You may not speak in this channel");
-                                       return 1;
-                               }
+                               // 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('R') && !is_registered)
+                       case MessageTarget::TYPE_USER:
                        {
-                               // user messaging a +R user and is not registered
-                               user->WriteNumeric(477, ""+ user->nick +" "+ u->nick +" :You need to be identified to a registered account to message this user");
-                               return 1;
+                               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 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               return OnUserPreMessage(user, dest, target_type, text, status, exempt_list);
+               return HandleMessage(user, target);
        }
 
-       virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven)
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
        {
-               if (!IS_LOCAL(user))
-                       return 0;
+               return HandleMessage(user, target);
+       }
 
-               std::string *account;
-               user->GetExt("accountname", account);
-               bool is_registered = !account->empty();
+       ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
+       {
+               if (checking_ban)
+                       return MOD_RES_PASSTHRU;
 
-               if (chan)
+               if ((mask.length() > 2) && (mask[1] == ':'))
                {
-                       if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
+                       if (mask[0] == 'R')
                        {
-                               // user is ulined, won't be stopped from joining
-                               return 0;
-                       }
-                       
-                       if (chan->IsModeSet('R'))
-                       {
-                               if (!is_registered)
-                               {
-                                       // joining a +R channel and not identified
-                                       user->WriteNumeric(477, user->nick + " " + chan->name + " :You need to be identified to a registered account to join this channel");
-                                       return 1;
-                               }
+                               std::string *account = accountname.get(user);
+                               if (account && InspIRCd::Match(*account, mask.substr(2)))
+                                       return MOD_RES_DENY;
                        }
-
-                       if (account)
+                       else if (mask[0] == 'U')
                        {
-                               if (chan->IsExtBanned(*account, 'R'))
-                               {
-                                       // may not join
-                                       user->WriteNumeric(ERR_BANNEDFROMCHAN, "%s %s :Cannot join channel (You're banned)", user->nick.c_str(),  chan->name.c_str());
-                                       return 1;
-                               }
-                       }
-               }
-               return 0;
-       }
+                               std::string *account = accountname.get(user);
+                               /* If the user is registered we don't care. */
+                               if (account)
+                                       return MOD_RES_PASSTHRU;
 
-       // Whenever the linking module wants to send out data, but doesnt know what the data
-       // represents (e.g. it is metadata, added to a User or Channel by a module) then
-       // this method is called. We should use the ProtoSendMetaData function after we've
-       // corrected decided how the data should look, to send the metadata on its way if
-       // it is ours.
-       virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
-       {
-               // check if the linking module wants to know about OUR metadata
-               if (extname == "accountname")
-               {
-                       // check if this user has an swhois field to send
-                       std::string* account;
-                       user->GetExt("accountname", account);
-                       if (account)
-                       {
-                               // remove any accidental leading/trailing spaces
-                               trim(*account);
+                               /* If we made it this far we know the user isn't registered
+                                       so just deny if it matches */
+                               checking_ban = true;
+                               bool result = chan->CheckBan(user, mask.substr(2));
+                               checking_ban = false;
 
-                               // call this function in the linking module, let it format the data how it
-                               // sees fit, and send it on its way. We dont need or want to know how.
-                               proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*account);
+                               if (result)
+                                       return MOD_RES_DENY;
                        }
                }
-       }
 
-       // when a user quits, tidy up their metadata
-       virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
-       {
-               std::string* account;
-               user->GetExt("accountname", account);
-               if (account)
-               {
-                       user->Shrink("accountname");
-                       delete account;
-               }
+               /* If we made it this far then the ban wasn't an ExtBan
+                       or the user we were checking for didn't match either ExtBan */
+               return MOD_RES_PASSTHRU;
        }
 
-       // if the module is unloaded, tidy up all our dangling metadata
-       virtual void OnCleanup(int target_type, void* item)
+       ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_USER)
-               {
-                       User* user = (User*)item;
-                       std::string* account;
-                       user->GetExt("accountname", account);
-                       if (account)
-                       {
-                               user->Shrink("accountname");
-                               delete account;
-                       }
-               }
-       }
+               std::string *account = accountname.get(user);
+               bool is_registered = account && !account->empty();
 
-       // Whenever the linking module receives metadata from another server and doesnt know what
-       // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
-       // module in turn to figure out if this metadata key belongs to them, and what they want
-       // to do with it.
-       // In our case we're only sending a single string around, so we just construct a std::string.
-       // Some modules will probably get much more complex and format more detailed structs and classes
-       // in a textual way for sending over the link.
-       virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
-       {
-               // check if its our metadata key, and its associated with a user
-               if ((target_type == TYPE_USER) && (extname == "accountname"))
+               if (chan)
                {
-                       User* dest = (User*)target;
-
-                       /* logging them out? */
-                       if (extdata.empty())
-                       {
-                               std::string* account;
-                               dest->GetExt("accountname", account);
-                               if (account)
-                               {
-                                       dest->Shrink("accountname");
-                                       delete account;
-                               }
-                       }
-                       else
+                       if (chan->IsModeSet(reginvitemode))
                        {
-                               // if they dont already have an accountname field, accept the remote server's
-                               std::string* text;
-                               if (!dest->GetExt("accountname", text))
+                               if (!is_registered)
                                {
-                                       text = new std::string(extdata);
-                                       // remove any accidental leading/trailing spaces
-                                       trim(*text);
-                                       dest->Extend("accountname", text);
-
-                                       if (IS_LOCAL(dest))
-                                               dest->WriteNumeric(900, "%s %s %s :You are now logged in as %s", dest->nick.c_str(), dest->GetFullHost().c_str(), text->c_str(), text->c_str());
-
-                                       AccountData ac;
-                                       ac.user = dest;
-                                       ac.account = *text;
-                                       Event n((char*)&ac, this, "account_login");
-                                       n.Send(ServerInstance);
+                                       // joining a +R channel and not identified
+                                       user->WriteNumeric(ERR_NEEDREGGEDNICK, chan->name, "You need to be identified to a registered account to join this channel");
+                                       return MOD_RES_DENY;
                                }
                        }
                }
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual ~ModuleServicesAccount()
+       ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
        {
-               ServerInstance->Modes->DelMode(m1);
-               ServerInstance->Modes->DelMode(m2);
-               ServerInstance->Modes->DelMode(m3);
-               ServerInstance->Modes->DelMode(m4);
-               ServerInstance->Modes->DelMode(m5);
-               delete m1;
-               delete m2;
-               delete m3;
-               delete m4;
-               delete m5;
+               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;
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$",VF_COMMON|VF_VENDOR,API_VERSION);
+               return Version("Adds various channel and user modes relating to services accounts.", VF_OPTCOMMON|VF_VENDOR);
        }
 };