]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_swhois.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_swhois.cpp
index 4a9c385899f24ef926316acfe0ccce4e477576aa..46d96a9521d60d67446f425a21ef98eff79cda35 100644 (file)
@@ -1,64 +1,72 @@
-/*       +------------------------------------+
- *       | 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) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2007 John Brooks <john.brooks@dereferenced.net>
+ *   Copyright (C) 2005-2006 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
  *
- * 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"
 
-/* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
+#include "inspircd.h"
 
 /** Handle /SWHOIS
  */
 class CommandSwhois : public Command
 {
-
  public:
-       CommandSwhois (InspIRCd* Instance) : Command(Instance,"SWHOIS","o",2)
+       StringExtItem swhois;
+       CommandSwhois(Module* Creator)
+               : Command(Creator, "SWHOIS", 2, 2)
+               , swhois("swhois", ExtensionItem::EXT_USER, Creator)
        {
-               this->source = "m_swhois.so";
-               syntax = "<nick> :<swhois>";
-               TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
+               flags_needed = 'o'; syntax = "<nick> :<swhois>";
+               TRANSLATE2(TR_NICK, TR_TEXT);
        }
 
        CmdResult Handle(const std::vector<std::string> &parameters, User* user)
        {
                User* dest = ServerInstance->FindNick(parameters[0]);
 
-               if (!dest)
+               if (!dest) // allow setting swhois using SWHOIS before reg
                {
-                       user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameters[0].c_str());
+                       user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
                        return CMD_FAILURE;
                }
 
-               std::string* text;
-               dest->GetExt("swhois", text);
-
+               std::string* text = swhois.get(dest);
                if (text)
                {
                        // We already had it set...
-                       if (!ServerInstance->ULine(user->server))
+                       if (!user->server->IsULine())
                                // Ulines set SWHOISes silently
-                               ServerInstance->SNO->WriteToSnoMask('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());
-
-                       dest->Shrink("swhois");
-                       delete text;
+                               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());
                }
-               else if (!ServerInstance->ULine(user->server))
+               else if (!user->server->IsULine())
                {
                        // Ulines set SWHOISes silently
-                       ServerInstance->SNO->WriteToSnoMask('A', "%s used SWHOIS to set %s's extra whois to '%s'", user->nick.c_str(), dest->nick.c_str(), parameters[1].c_str());
+                       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());
                }
 
-               text = new std::string(parameters[1]);
-               dest->Extend("swhois", text);
+               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
@@ -66,198 +74,59 @@ class CommandSwhois : public Command
                 * Sorry w00t i know this was your fix, but i got bored and wanted to clear down the tracker :)
                 * -- Brain
                 */
-               ServerInstance->PI->SendMetaData(dest, TYPE_USER, "swhois", *text);
-
-               // If it's an empty swhois, unset it (not ideal, but ok)
-               if (text->empty())
-               {
-                       dest->Shrink("swhois");
-                       delete text;
-               }
+               ServerInstance->PI->SendMetaData(dest, "swhois", parameters[1]);
 
-               return CMD_LOCALONLY;
+               return CMD_SUCCESS;
        }
 
 };
 
-class ModuleSWhois : public Module
+class ModuleSWhois : public Module, public Whois::LineEventListener
 {
-       CommandSwhois* mycommand;
-
-       ConfigReader* Conf;
+       CommandSwhois cmd;
 
  public:
-       ModuleSWhois(InspIRCd* Me) : Module(Me)
-       {
-
-               Conf = new ConfigReader(ServerInstance);
-               mycommand = new CommandSwhois(ServerInstance);
-               ServerInstance->AddCommand(mycommand);
-               Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup, I_OnRehash, I_OnPostCommand };
-               ServerInstance->Modules->Attach(eventlist, this, 7);
-       }
-
-       void OnRehash(User* user, const std::string &parameter)
+       ModuleSWhois()
+               : Whois::LineEventListener(this)
+               , cmd(this)
        {
-               delete Conf;
-               Conf = new ConfigReader(ServerInstance);
        }
 
-
        // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
-       int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
+       ModResult OnWhoisLine(Whois::Context& whois, unsigned int& numeric, std::string& text) CXX11_OVERRIDE
        {
                /* We use this and not OnWhois because this triggers for remote, too */
                if (numeric == 312)
                {
                        /* Insert our numeric before 312 */
-                       std::string* swhois;
-                       dest->GetExt("swhois", swhois);
+                       std::string* swhois = cmd.swhois.get(whois.GetTarget());
                        if (swhois)
                        {
-                               ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), swhois->c_str());
+                               whois.SendLine(320, ":%s", swhois->c_str());
                        }
                }
 
                /* Dont block anything */
-               return 0;
+               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)
+       void OnPostOper(User* user, const std::string &opertype, const std::string &opername) CXX11_OVERRIDE
        {
-               // check if the linking module wants to know about OUR metadata
-               if (extname == "swhois")
-               {
-                       // check if this user has an swhois field to send
-                       std::string* swhois;
-                       user->GetExt("swhois", swhois);
-                       if (swhois)
-                       {
-                               // 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);
-                       }
-               }
-       }
-
-       // when a user quits, tidy up their metadata
-       virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
-       {
-               std::string* swhois;
-               user->GetExt("swhois", swhois);
-               if (swhois)
-               {
-                       user->Shrink("swhois");
-                       delete swhois;
-               }
-       }
-
-       // if the module is unloaded, tidy up all our dangling metadata
-       virtual void OnCleanup(int target_type, void* item)
-       {
-               if (target_type == TYPE_USER)
-               {
-                       User* user = (User*)item;
-                       std::string* swhois;
-                       user->GetExt("swhois", swhois);
-                       if (swhois)
-                       {
-                               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, 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 == "swhois"))
-               {
-                       User* dest = (User*)target;
-
-                       // if they already have an swhois field, trash it and replace it with the remote one.
-                       std::string* text;
-                       if (dest->GetExt("swhois", text))
-                       {
-                               dest->Shrink("swhois");
-                               delete text;
-                       }
-
-                       if (extdata.empty())
-                               return; // XXX does the command parser even allow sending blank mdata? it needs to here! -- w00t
-
-                       text = new std::string(extdata);
-                       dest->Extend("swhois", text);
-               }
-       }
-
-       virtual void OnPostCommand(const std::string &command, const std::vector<std::string> &params, User *user, CmdResult result, const std::string &original_line)
-       {
-               if ((command != "OPER") || (result != CMD_SUCCESS))
+               if (!IS_LOCAL(user))
                        return;
 
-               std::string swhois;
-
-               for (int i = 0; i < Conf->Enumerate("oper"); i++)
-               {
-                       std::string name = Conf->ReadValue("oper", "name", i);
-
-                       if (name == params[0])
-                       {
-                               swhois = Conf->ReadValue("oper", "swhois", i);
-                               break;
-                       }
-               }
-
-               if (!swhois.length())
-               {
-                       for (int i = 0; i < Conf->Enumerate("type"); i++)
-                       {
-                               std::string type = Conf->ReadValue("type", "name", i);
-
-                               if (type == user->oper)
-                               {
-                                       swhois = Conf->ReadValue("type", "swhois", i);
-                                       break;
-                               }
-                       }
-               }
-
-               std::string *old;
-               if (user->GetExt("swhois", old))
-               {
-                       user->Shrink("swhois");
-                       delete old;
-               }
+               std::string swhois = user->oper->getConfig("swhois");
 
                if (!swhois.length())
                        return;
 
-               std::string *text = new std::string(swhois);
-               user->Extend("swhois", text);
-               ServerInstance->PI->SendMetaData(user, TYPE_USER, "swhois", *text);
-       }
-
-       virtual ~ModuleSWhois()
-       {
-               delete Conf;
+               cmd.swhois.set(user, swhois);
+               ServerInstance->PI->SendMetaData(user, "swhois", swhois);
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Provides the SWHOIS command which allows setting of arbitrary WHOIS lines", VF_OPTCOMMON | VF_VENDOR);
        }
 };