]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_swhois.cpp
Switch from the Ubuntu 16.04 image to the 18.04 Ubuntu image.
[user/henk/code/inspircd.git] / src / modules / m_swhois.cpp
index 887d17e39b7458d8bbac52773396d3378f5af2cf..de774a17139cda5a580806a519a24b9acb56c0af 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  Inspire is copyright (C) 2002-2005 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) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
+ *   Copyright (C) 2005, 2007, 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 "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-
-/* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
 
-Server *Srv;
+#include "inspircd.h"
+#include "modules/whois.h"
 
-void handle_swhois(char **parameters, int pcnt, userrec *user)
+enum
 {
-       userrec* dest = Srv->FindNick(std::string(parameters[0]));
-       if (dest)
-       {
-               std::string line = "";
-               for (int i = 1; i < pcnt; i++)
-               {
-                       if (i != 1)
-                               line = line + " ";
-                       line = line + std::string(parameters[i]);
-               }
-               char* field = dest->GetExt("swhois");
-               if (field)
-               {
-                       std::string* text = (std::string*)field;
-                       dest->Shrink("swhois");
-                       delete text;
-               }
-               std::string* text = new std::string(line);
-               dest->Extend("swhois",(char*)text);
-       }
-}
+       // From UnrealIRCd.
+       RPL_WHOISSPECIAL = 320
+};
 
-class ModuleSWhois : public Module
+/** Handle /SWHOIS
+ */
+class CommandSwhois : public Command
 {
  public:
-       ModuleSWhois(Server* Me)
-               : Module::Module(Me)
+       LocalIntExt operblock;
+       StringExtItem swhois;
+       CommandSwhois(Module* Creator)
+               : Command(Creator, "SWHOIS", 2, 2)
+               , operblock("swhois_operblock", ExtensionItem::EXT_USER, Creator)
+               , swhois("swhois", ExtensionItem::EXT_USER, Creator)
        {
-               Srv = Me;
-               Srv->AddCommand("SWHOIS",handle_swhois,'o',2,"m_swhois.so");
+               flags_needed = 'o';
+               syntax = "<nick> :<swhois>";
+               TRANSLATE2(TR_NICK, TR_TEXT);
        }
 
-       // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
-       virtual void OnWhois(userrec* source, userrec* dest)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               char* desc = dest->GetExt("swhois");
-               if (desc)
+               User* dest = ServerInstance->FindNick(parameters[0]);
+
+               if (!dest) // allow setting swhois using SWHOIS before reg
                {
-                       std::string* swhois = (std::string*)desc;
-                       WriteServ(source->fd,"320 %s %s :%s",source->nick,dest->nick,swhois->c_str());
+                       user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
+                       return CMD_FAILURE;
                }
-       }
 
-       // Whenever the linking module wants to send out data, but doesnt know what the data
-       // represents (e.g. it is metadata, added to a userrec or chanrec 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(userrec* user, Module* proto, void* opaque, std::string extname)
-       {
-               // check if the linking module wants to know about OUR metadata
-               if (extname == "swhois")
+               std::string* text = swhois.get(dest);
+               if (text)
                {
-                       // check if this user has an swhois field to send
-                       char* field = user->GetExt("swhois");
-                       if (field)
-                       {
-                               // get our extdata out with a cast
-                               std::string* swhois = (std::string*)field;
-                               // 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,*swhois);
-                       }
+                       // We already had it set...
+                       if (!user->server->IsULine())
+                               // Ulines set SWHOISes silently
+                               ServerInstance->SNO->WriteGlobalSno('a', "%s used SWHOIS to set %s's extra whois from '%s' to '%s'", user->nick.c_str(), dest->nick.c_str(), text->c_str(), parameters[1].c_str());
                }
-       }
-
-       // when a user quits, tidy up their metadata
-       virtual void OnUserQuit(userrec* user, std::string message)
-       {
-               char* field = user->GetExt("swhois");
-               if (field)
+               else if (!user->server->IsULine())
                {
-                       std::string* swhois = (std::string*)field;
-                       user->Shrink("swhois");
-                       delete swhois;
+                       // Ulines set SWHOISes silently
+                       ServerInstance->SNO->WriteGlobalSno('a', "%s used SWHOIS to set %s's extra whois to '%s'", user->nick.c_str(), dest->nick.c_str(), parameters[1].c_str());
                }
+
+               operblock.set(user, 0);
+               if (parameters[1].empty())
+                       swhois.unset(dest);
+               else
+                       swhois.set(dest, parameters[1]);
+
+               /* Bug #376 - feature request -
+                * To cut down on the amount of commands services etc have to recognise, this only sends METADATA across the network now
+                * not an actual SWHOIS command. Any SWHOIS command sent from services will be automatically translated to METADATA by this.
+                * Sorry w00t i know this was your fix, but i got bored and wanted to clear down the tracker :)
+                * -- Brain
+                */
+               ServerInstance->PI->SendMetaData(dest, "swhois", parameters[1]);
+
+               return CMD_SUCCESS;
        }
 
-       // if the module is unloaded, tidy up all our dangling metadata
-       virtual void OnCleanup(int target_type, void* item)
+};
+
+class ModuleSWhois : public Module, public Whois::LineEventListener
+{
+       CommandSwhois cmd;
+
+ public:
+       ModuleSWhois()
+               : Whois::LineEventListener(this)
+               , cmd(this)
        {
-               if (target_type == TYPE_USER)
-               {
-                       userrec* user = (userrec*)item;
-                       char* field = user->GetExt("swhois");
-                       if (field)
-                       {
-                               std::string* swhois = (std::string*)field;
-                               user->Shrink("swhois");
-                               delete swhois;
-                       }
-               }
        }
 
-       // 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, std::string extname, std::string extdata)
+       // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
+       ModResult OnWhoisLine(Whois::Context& whois, Numeric::Numeric& numeric) CXX11_OVERRIDE
        {
-               // check if its our metadata key, and its associated with a user
-               if ((target_type == TYPE_USER) && (extname == "swhois"))
+               /* We use this and not OnWhois because this triggers for remote, too */
+               if (numeric.GetNumeric() == 312)
                {
-                       userrec* dest = (userrec*)target;
-                       // if they dont already have an swhois field, accept the remote server's
-                       if (!dest->GetExt("swhois"))
+                       /* Insert our numeric before 312 */
+                       std::string* swhois = cmd.swhois.get(whois.GetTarget());
+                       if (swhois)
                        {
-                               std::string* text = new std::string(extdata);
-                               dest->Extend("swhois",(char*)text);
+                               whois.SendLine(RPL_WHOISSPECIAL, *swhois);
                        }
                }
+
+               /* Dont block anything */
+               return MOD_RES_PASSTHRU;
        }
-       
-       virtual ~ModuleSWhois()
-       {
-       }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1,0,0,0,VF_VENDOR);
-       }
-       
-       virtual void OnUserConnect(userrec* user)
+
+       void OnPostOper(User* user, const std::string &opertype, const std::string &opername) CXX11_OVERRIDE
        {
-       }
+               if (!IS_LOCAL(user))
+                       return;
 
-};
+               std::string swhois = user->oper->getConfig("swhois");
 
+               if (!swhois.length())
+                       return;
 
-class ModuleSWhoisFactory : public ModuleFactory
-{
- public:
-       ModuleSWhoisFactory()
+               cmd.operblock.set(user, 1);
+               cmd.swhois.set(user, swhois);
+               ServerInstance->PI->SendMetaData(user, "swhois", swhois);
+       }
+
+       void OnPostDeoper(User* user) CXX11_OVERRIDE
        {
+               std::string* swhois = cmd.swhois.get(user);
+               if (!swhois)
+                       return;
+
+               if (!cmd.operblock.get(user))
+                       return;
+
+               cmd.operblock.set(user, 0);
+               cmd.swhois.unset(user);
+               ServerInstance->PI->SendMetaData(user, "swhois", "");
        }
-       
-       ~ModuleSWhoisFactory()
+
+       void OnDecodeMetaData(Extensible* target, const std::string& extname, const std::string&) CXX11_OVERRIDE
        {
+               User* dest = static_cast<User*>(target);
+               if (dest && (extname == "swhois"))
+                       cmd.operblock.set(dest, 0);
        }
-       
-       virtual Module * CreateModule(Server* Me)
+
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return new ModuleSWhois(Me);
+               return Version("Adds the /SWHOIS command which adds custom lines to a user's WHOIS response.", VF_OPTCOMMON | VF_VENDOR);
        }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleSWhoisFactory;
-}
-
+MODULE_INIT(ModuleSWhois)