Allow modules to prevent a message from updating the idle time.

[user/henk/code/inspircd.git] / include / ctables.h

diff --git a/include/ctables.h b/include/ctables.h
index 43a311a6635e6243759cf644f82dc2ae7662fa13..938deac156d3c6ffeca1923e8d9207b44e530e83 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -1,11 +1,14 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006-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
@@ -110,6 +113,41 @@ struct RouteDescriptor
 class CoreExport CommandBase : public ServiceProvider
 {
  public:
+       /** Encapsulates parameters to a command. */
+       class Params : public std::vector<std::string>
+       {
+        private:
+               /* IRCv3 message tags. */
+               ClientProtocol::TagMap tags;
+
+        public:
+               /** Initializes a new instance from parameter and tag references.
+                * @param paramsref Message parameters.
+                * @param tagsref IRCv3 message tags.
+                */
+               Params(const std::vector<std::string>& paramsref, const ClientProtocol::TagMap& tagsref)
+                       : std::vector<std::string>(paramsref)
+                       , tags(tagsref)
+               {
+               }
+
+               /** Initializes a new instance from parameter iterators.
+                * @param first The first element in the parameter array.
+                * @param last The last element in the parameter array.
+                */
+               template<typename Iterator>
+               Params(Iterator first, Iterator last)
+                       : std::vector<std::string>(first, last)
+               {
+               }
+
+               /** Initializes a new empty instance. */
+               Params() { }
+
+               /** Retrieves the IRCv3 message tags. */
+               const ClientProtocol::TagMap& GetTags() const { return tags; }
+       };
+
        /** User flags needed to execute the command or 0
         */
        unsigned char flags_needed;
@@ -128,10 +166,6 @@ class CoreExport CommandBase : public ServiceProvider
         */
        unsigned long use_count;
 
-       /** True if the command is disabled to non-opers
-        */
-       bool disabled;
-
        /** True if the command can be issued before registering
         */
        bool works_before_reg;
@@ -168,7 +202,7 @@ class CoreExport CommandBase : public ServiceProvider
         */
        CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
 
-       virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters);
+       virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& parameters);
 
        /** Encode a parameter for server->server transmission.
         * Used for parameters for which the translation type is TR_CUSTOM.
@@ -177,23 +211,6 @@ class CoreExport CommandBase : public ServiceProvider
         */
        virtual void EncodeParameter(std::string& parameter, unsigned int index);
 
-       /** Disable or enable this command.
-        * @param setting True to disable the command.
-        */
-       void Disable(bool setting)
-       {
-               disabled = setting;
-       }
-
-       /** Obtain this command's disable state.
-        * @return true if the command is currently disabled
-        * (disabled commands can be used only by operators)
-        */
-       bool IsDisabled()
-       {
-               return disabled;
-       }
-
        /** @return true if the command works before registration.
         */
        bool WorksBeforeReg()
@@ -219,7 +236,7 @@ class CoreExport Command : public CommandBase
         * @param user The user who issued the command.
         * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
         */
-       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
+       virtual CmdResult Handle(User* user, const Params& parameters) = 0;
 
        /** Register this object in the CommandParser
         */
@@ -236,10 +253,10 @@ class CoreExport SplitCommand : public Command
  public:
        SplitCommand(Module* me, const std::string &cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
                : Command(me, cmd, minpara, maxpara) {}
-       CmdResult Handle(const std::vector<std::string>& parameters, User* user) CXX11_OVERRIDE;
-       virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
-       virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
-       virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
+       virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters);
+       virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters);
+       virtual CmdResult HandleServer(FakeUser* user, const Params& parameters);
 };
 
 /** Shortcut macros for defining translation lists