-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * 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 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 "modules/whois.h"
-/* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
+enum
+{
+ // From UnrealIRCd.
+ RPL_WHOISSPECIAL = 320
+};
/** Handle /SWHOIS
*/
class CommandSwhois : public Command
{
-
public:
- CommandSwhois (InspIRCd* Instance, Module* Creator) : Command(Instance, Creator,"SWHOIS","o",2, 2)
+ 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)
{
+ flags_needed = 'o';
syntax = "<nick> :<swhois>";
- TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
+ TRANSLATE2(TR_NICK, TR_TEXT);
}
- CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
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;
- if (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->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());
-
- dest->Shrink("swhois");
- delete text;
}
- else if (!ServerInstance->ULine(user->server))
+ else if (!user->server->IsULine())
{
// 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());
}
- text = new std::string(parameters[1]);
- dest->Extend("swhois", text);
+ 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
* 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", *text);
+ ServerInstance->PI->SendMetaData(dest, "swhois", parameters[1]);
- // If it's an empty swhois, unset it (not ideal, but ok)
- if (text->empty())
- {
- dest->Shrink("swhois");
- delete text;
- }
-
- return CMD_LOCALONLY;
+ return CMD_SUCCESS;
}
};
-class ModuleSWhois : public Module
+class ModuleSWhois : public Module, public Whois::LineEventListener
{
CommandSwhois cmd;
- ConfigReader* Conf;
-
public:
- ModuleSWhois(InspIRCd* Me) : Module(Me), cmd(Me, this)
+ ModuleSWhois()
+ : Whois::LineEventListener(this)
+ , cmd(this)
{
-
- Conf = new ConfigReader(ServerInstance);
- ServerInstance->AddCommand(&cmd);
- Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUser, I_OnUserQuit, I_OnCleanup, I_OnRehash, I_OnPostCommand };
- ServerInstance->Modules->Attach(eventlist, this, 7);
}
- void OnRehash(User* user)
- {
- 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, Numeric::Numeric& numeric) CXX11_OVERRIDE
{
/* We use this and not OnWhois because this triggers for remote, too */
- if (numeric == 312)
+ if (numeric.GetNumeric() == 312)
{
/* Insert our numeric before 312 */
- std::string* swhois;
- if (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(RPL_WHOISSPECIAL, *swhois);
}
}
/* Dont block anything */
- return 0;
- }
-
- // 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 OnSyncUser(User* user, Module* proto, void* opaque)
- {
- // check if this user has an swhois field to send
- std::string* swhois;
- if (user->GetExt("swhois", swhois))
- proto->ProtoSendMetaData(opaque,user,"swhois",*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;
- if (user->GetExt("swhois", swhois))
- {
- user->Shrink("swhois");
- delete swhois;
- }
+ return MOD_RES_PASSTHRU;
}
- // if the module is unloaded, tidy up all our dangling metadata
- virtual void OnCleanup(int target_type, void* item)
+ void OnPostOper(User* user, const std::string &opertype, const std::string &opername) CXX11_OVERRIDE
{
- if (target_type != TYPE_USER) return;
- User* user = static_cast<User*>(item);
- std::string* swhois;
- if (user && user->GetExt("swhois", 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(Extensible* target, const std::string &extname, const std::string &extdata)
- {
- User* dest = dynamic_cast<User*>(target);
- // check if its our metadata key, and its associated with a user
- if (extname != "swhois" || !dest)
+ if (!IS_LOCAL(user))
return;
- // 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;
- }
+ std::string swhois = user->oper->getConfig("swhois");
- if (extdata.empty())
+ if (!swhois.length())
return;
- text = new std::string(extdata);
- dest->Extend("swhois", text);
+ cmd.operblock.set(user, 1);
+ cmd.swhois.set(user, swhois);
+ ServerInstance->PI->SendMetaData(user, "swhois", swhois);
}
- virtual void OnPostCommand(const std::string &command, const std::vector<std::string> ¶ms, User *user, CmdResult result, const std::string &original_line)
+ void OnPostDeoper(User* user) CXX11_OVERRIDE
{
- if ((command != "OPER") || (result != CMD_SUCCESS))
+ std::string* swhois = cmd.swhois.get(user);
+ if (!swhois)
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;
- }
-
- if (!swhois.length())
+ if (!cmd.operblock.get(user))
return;
- std::string *text = new std::string(swhois);
- user->Extend("swhois", text);
- ServerInstance->PI->SendMetaData(user, "swhois", *text);
+ cmd.operblock.set(user, 0);
+ cmd.swhois.unset(user);
+ ServerInstance->PI->SendMetaData(user, "swhois", "");
}
- virtual ~ModuleSWhois()
+ void OnDecodeMetaData(Extensible* target, const std::string& extname, const std::string&) CXX11_OVERRIDE
{
- delete Conf;
+ User* dest = static_cast<User*>(target);
+ if (dest && (extname == "swhois"))
+ cmd.operblock.set(dest, 0);
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+ return Version("Adds the /SWHOIS command which adds custom lines to a user's WHOIS response.", VF_OPTCOMMON | VF_VENDOR);
}
};
projects / user / henk / code / inspircd.git / blobdiff