]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_customtitle.cpp
Some more text fixes and improvements (#1618).
[user/henk/code/inspircd.git] / src / modules / m_customtitle.cpp
index b7e67b5073da25ad3f1011ce3f5e63a599ae7300..3ffc9f682aaef26fd0193954313eaa8ae3f23338 100644 (file)
-/*       +------------------------------------+
- *       | 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 Dennis Friis <peavey@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 "wildcard.h"
+#include "modules/whois.h"
+
+enum
+{
+       // From UnrealIRCd.
+       RPL_WHOISSPECIAL = 320
+};
+
+struct CustomTitle
+{
+       const std::string name;
+       const std::string password;
+       const std::string hash;
+       const std::string host;
+       const std::string title;
+       const std::string vhost;
+
+       CustomTitle(const std::string& n, const std::string& p, const std::string& h, const std::string& hst, const std::string& t, const std::string& v)
+               : name(n)
+               , password(p)
+               , hash(h)
+               , host(hst)
+               , title(t)
+               , vhost(v)
+       {
+       }
 
-/* $ModDesc: Provides the TITLE command which allows setting of CUSTOM WHOIS TITLE line */
+       bool MatchUser(User* user) const
+       {
+               const std::string userHost = user->ident + "@" + user->GetRealHost();
+               const std::string userIP = user->ident + "@" + user->GetIPString();
+               return InspIRCd::MatchMask(host, userHost, userIP);
+       }
+
+       bool CheckPass(User* user, const std::string& pass) const
+       {
+               return ServerInstance->PassCompare(user, password, pass, hash);
+       }
+};
+
+typedef std::multimap<std::string, CustomTitle> CustomVhostMap;
+typedef std::pair<CustomVhostMap::iterator, CustomVhostMap::iterator> MatchingConfigs;
 
 /** Handle /TITLE
  */
 class CommandTitle : public Command
 {
-       
  public:
-       CommandTitle (InspIRCd* Instance) : Command(Instance,"TITLE",0,2)
+       StringExtItem ctitle;
+       CustomVhostMap configs;
+
+       CommandTitle(Module* Creator) : Command(Creator,"TITLE", 2),
+               ctitle("ctitle", ExtensionItem::EXT_USER, Creator)
        {
-               this->source = "m_customtitle.so";
-               syntax = "<user> <password>";
-               TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
+               syntax = "<username> <password>";
        }
 
-bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
-{
-    std::stringstream hl(hostlist);
-    std::string xhost;
-    while (hl >> xhost)
-    {
-        if (match(host, xhost) || match(ip,xhost, true))
-        {
-            return true;
-        }
-    }
-    return false;
-}
-
-       CmdResult Handle(const std::vector<std::string> &parameters, User* user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               if (!IS_LOCAL(user))
-                       return CMD_LOCALONLY;
-       
-               char TheHost[MAXBUF];
-               char TheIP[MAXBUF];
+               MatchingConfigs matching = configs.equal_range(parameters[0]);
 
-               snprintf(TheHost,MAXBUF,"%s@%s",user->ident.c_str(), user->host.c_str());
-               snprintf(TheIP, MAXBUF,"%s@%s",user->ident.c_str(), user->GetIPString());
-
-               ConfigReader Conf(ServerInstance);
-               for (int i=0; i<Conf.Enumerate("title"); i++)
+               for (MatchingConfigs::first_type i = matching.first; i != matching.second; ++i)
                {
-                       std::string name = Conf.ReadValue("title", "name", "", i);
-                       std::string pass = Conf.ReadValue("title", "password", "", i);
-                       std::string hash = Conf.ReadValue("title", "hash", "", i);
-                       std::string host = Conf.ReadValue("title", "host", "*@*", i);
-                       std::string title = Conf.ReadValue("title", "title", "", i);
-                       std::string vhost = Conf.ReadValue("title", "vhost", "", i);
-
-                       if (!strcmp(name.c_str(),parameters[0].c_str()) && !ServerInstance->PassCompare(user, pass.c_str(), parameters[1].c_str(), hash.c_str()) && OneOfMatches(TheHost,TheIP,host.c_str()) && !title.empty())
+                       CustomTitle config = i->second;
+                       if (config.MatchUser(user) && config.CheckPass(user, parameters[1]))
                        {
-                               std::string* text;
-                               user->GetExt("ctitle", text);
-
-                               if (text)
-                               {
-                                       user->Shrink("ctitle");
-                                       delete text;
-                               }
-
-                               text = new std::string(title);
-                               user->Extend("ctitle", text);
+                               ctitle.set(user, config.title);
 
-                               ServerInstance->PI->SendMetaData(user, TYPE_USER, "ctitle", *text);
-                                                                                       
-                               if (!vhost.empty())
-                                       user->ChangeDisplayedHost(vhost.c_str());
+                               ServerInstance->PI->SendMetaData(user, "ctitle", config.title);
 
-                               if (!ServerInstance->ULine(user->server))
-                                       // Ulines set TITLEs silently
-                                       ServerInstance->SNO->WriteToSnoMask('A', "%s used TITLE to set custom title '%s'",user->nick.c_str(),title.c_str());
+                               if (!config.vhost.empty())
+                                       user->ChangeDisplayedHost(config.vhost);
 
-                               user->WriteServ("NOTICE %s :Custom title set to '%s'",user->nick.c_str(), title.c_str());
+                               user->WriteNotice("Custom title set to '" + config.title + "'");
 
                                return CMD_SUCCESS;
                        }
                }
 
-               if (!ServerInstance->ULine(user->server))
-                       // Ulines also fail TITLEs silently
-                       ServerInstance->SNO->WriteToSnoMask('A', "Failed TITLE attempt by %s!%s@%s using login '%s'", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), parameters[0].c_str());
-
-               user->WriteServ("NOTICE %s :Invalid title credentials",user->nick.c_str());
+               user->WriteNotice("Invalid title credentials");
                return CMD_SUCCESS;
        }
 
 };
 
-class ModuleCustomTitle : public Module
+class ModuleCustomTitle : public Module, public Whois::LineEventListener
 {
-       CommandTitle* mycommand;
-       
- public:
-       ModuleCustomTitle(InspIRCd* Me) : Module(Me)
-       {
-               
-               mycommand = new CommandTitle(ServerInstance);
-               ServerInstance->AddCommand(mycommand);
-               Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup };
-               ServerInstance->Modules->Attach(eventlist, this, 5);
-       }
-
-
-       // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
-       int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
-       {
-               /* We use this and not OnWhois because this triggers for remote, too */
-               if (numeric == 312)
-               {
-                       /* Insert our numeric before 312 */
-                       std::string* ctitle;
-                       dest->GetExt("ctitle", ctitle);
-                       if (ctitle)
-                       {
-                               ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), ctitle->c_str());
-                       }
-               }
-               /* Dont block anything */
-               return 0;
-       }
+       CommandTitle cmd;
 
-       // 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)
+ public:
+       ModuleCustomTitle()
+               : Whois::LineEventListener(this)
+               , cmd(this)
        {
-               // check if the linking module wants to know about OUR metadata
-               if (extname == "ctitle")
-               {
-                       // check if this user has an ctitle field to send
-                       std::string* ctitle;
-                       user->GetExt("ctitle", ctitle);
-                       if (ctitle)
-                       {
-                               // 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,*ctitle);
-                       }
-               }
        }
 
-       // when a user quits, tidy up their metadata
-       virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               std::string* ctitle;
-               user->GetExt("ctitle", ctitle);
-               if (ctitle)
+               ConfigTagList tags = ServerInstance->Config->ConfTags("title");
+               CustomVhostMap newtitles;
+               for (ConfigIter i = tags.first; i != tags.second; ++i)
                {
-                       user->Shrink("ctitle");
-                       delete ctitle;
+                       reference<ConfigTag> tag = i->second;
+                       std::string name = tag->getString("name", "", 1);
+                       if (name.empty())
+                               throw ModuleException("<title:name> is empty at " + tag->getTagLocation());
+
+                       std::string pass = tag->getString("password");
+                       if (pass.empty())
+                               throw ModuleException("<title:password> is empty at " + tag->getTagLocation());
+
+                       std::string hash = tag->getString("hash");
+                       std::string host = tag->getString("host", "*@*");
+                       std::string title = tag->getString("title");
+                       std::string vhost = tag->getString("vhost");
+                       CustomTitle config(name, pass, hash, host, title, vhost);
+                       newtitles.insert(std::make_pair(name, config));
                }
+               cmd.configs.swap(newtitles);
        }
 
-       // if the module is unloaded, tidy up all our dangling metadata
-       virtual void OnCleanup(int target_type, void* item)
+       // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
+       ModResult OnWhoisLine(Whois::Context& whois, Numeric::Numeric& numeric) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_USER)
+               /* We use this and not OnWhois because this triggers for remote, too */
+               if (numeric.GetNumeric() == 312)
                {
-                       User* user = (User*)item;
-                       std::string* ctitle;
-                       user->GetExt("ctitle", ctitle);
+                       /* Insert our numeric before 312 */
+                       const std::string* ctitle = cmd.ctitle.get(whois.GetTarget());
                        if (ctitle)
                        {
-                               user->Shrink("ctitle");
-                               delete ctitle;
+                               whois.SendLine(RPL_WHOISSPECIAL, ctitle);
                        }
                }
+               /* Don't block anything */
+               return MOD_RES_PASSTHRU;
        }
 
-       // 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 == "ctitle"))
-               {
-                       User* dest = (User*)target;
-                       // if they dont already have an ctitle field, accept the remote server's
-                       std::string* text;
-                       if (!dest->GetExt("ctitle", text))
-                       {
-                               std::string* ntext = new std::string(extdata);
-                               dest->Extend("ctitle",ntext);
-                       }
-               }
-       }
-       
-       virtual ~ModuleCustomTitle()
-       {
-       }
-       
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Provides the TITLE command, custom titles for users", VF_OPTCOMMON | VF_VENDOR);
        }
 };