Sync helpop chmodes s and p with docs

[user/henk/code/inspircd.git] / src / modules / m_uhnames.cpp

diff --git a/src/modules/m_uhnames.cpp b/src/modules/m_uhnames.cpp
index f0c466f871442860c7e68ffb419553b87064c126..790a9acbcb8b5012716c54bb53bbbc5309496a7e 100644 (file)
--- a/src/modules/m_uhnames.cpp
+++ b/src/modules/m_uhnames.cpp
@@ -1,86 +1,83 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2013, 2018-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012, 2014-2015 Attila Molnar <attilamolnar@hush.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) 2007 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 "m_cap.h"
 
-/* $ModDesc: Provides the UHNAMES facility. */
+#include "inspircd.h"
+#include "modules/cap.h"
+#include "modules/names.h"
 
-class ModuleUHNames : public Module
+class ModuleUHNames
+       : public Module
+       , public Names::EventListener
 {
-       CUList nl;
- public:
+ private:
+       Cap::Capability cap;
 
-       ModuleUHNames(InspIRCd* Me)
-               : Module(Me)
-       {
-               Implementation eventlist[] = { I_OnEvent, I_OnSyncUserMetaData, I_OnPreCommand, I_OnNamesListItem, I_On005Numeric };
-               ServerInstance->Modules->Attach(eventlist, this, 5);
-       }
-
-       virtual ~ModuleUHNames()
-       {
-       }
-
-       void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable)
+ public:
+       ModuleUHNames()
+               : Names::EventListener(this)
+               , cap(this, "userhost-in-names")
        {
-               if ((displayable) && (extname == "UHNAMES"))
-                       proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "Enabled");
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$",VF_VENDOR,API_VERSION);
+               return Version("Provides the IRCv3 userhost-in-names client capability.", VF_VENDOR);
        }
 
-       virtual void On005Numeric(std::string &output)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               output.append(" UHNAMES");
+               // The legacy PROTOCTL system is a wrapper around the cap.
+               dynamic_reference_nocheck<Cap::Manager> capmanager(this, "capmanager");
+               if (capmanager)
+                       tokens["UHNAMES"];
        }
 
-       virtual int OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
        {
-               irc::string c = command.c_str();
                /* We don't actually create a proper command handler class for PROTOCTL,
                 * because other modules might want to have PROTOCTL hooks too.
                 * Therefore, we just hook its as an unvalidated command therefore we
                 * can capture it even if it doesnt exist! :-)
                 */
-               if (c == "PROTOCTL")
+               if (command == "PROTOCTL")
                {
-                       if ((parameters.size()) && (!strcasecmp(parameters[0].c_str(),"UHNAMES")))
+                       if (!parameters.empty() && irc::equals(parameters[0], "UHNAMES"))
                        {
-                               user->Extend("UHNAMES");
-                               return 1;
+                               cap.set(user, true);
+                               return MOD_RES_DENY;
                        }
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick)
+       ModResult OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick) CXX11_OVERRIDE
        {
-               if (!issuer->GetExt("UHNAMES"))
-                       return;
-
-               if (nick.empty())
-                       return;
+               if (cap.get(issuer))
+                       nick = memb->user->GetFullHost();
 
-               nick = user->GetFullHost();
-       }
-
-       virtual void OnEvent(Event* ev)
-       {
-               GenericCapHandler(ev, "UHNAMES", "userhost-in-names");
+               return MOD_RES_PASSTHRU;
        }
 };