Convert AWAY to use cross-module events and clean up slightly.

OnSetAway has been replaced with four events. OnUserPreAway and
OnUserPreBack can be used to deny an away state change and/or
change the away message of a local user. OnUserAway and OnUserBack
allow modules to be notified that a user's away state has changed.

3 files changed, 84 insertions, 14 deletions

diff --git a/include/modules.h b/include/modules.h
index 773e3b49f..4e5648512 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -223,7 +223,7 @@ enum Implementation
 	I_OnChangeLocalUserHost, I_OnPreTopicChange,
 	I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
 	I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
-	I_OnPostOper, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
+	I_OnPostOper, I_OnPostCommand, I_OnPostJoin,
 	I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
 	I_OnUserMessage, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
 	I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
@@ -894,16 +894,6 @@ class CoreExport Module : public classbase, public usecountbase
 	 */
 	virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
-	/** Called whenever a user sets away or returns from being away.
-	 * The away message is available as a parameter, but should not be modified.
-	 * At this stage, it has already been copied into the user record.
-	 * If awaymsg is empty, the user is returning from away.
-	 * @param user The user setting away
-	 * @param awaymsg The away message of the user, or empty if returning from away
-	 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
-	 */
-	virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
-
 	/** Called at intervals for modules to garbage-collect any hashes etc.
 	 * Certain data types such as hash_map 'leak' buckets, which must be
 	 * tidied up and freed by copying into a new item every so often. This
diff --git a/include/modules/away.h b/include/modules/away.h
new file mode 100644
index 000000000..f231f0a06
--- /dev/null
+++ b/include/modules/away.h
@@ -0,0 +1,83 @@
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2016-2017 Peter Powell <petpow@saberuk.com>
+ *
+ * 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/>.
+ */
+
+
+#pragma once
+
+#include "event.h"
+
+namespace Away
+{
+	class EventListener;
+	class EventProvider;
+}
+
+class Away::EventListener
+	: public Events::ModuleEventListener
+{
+ protected:
+	EventListener(Module* mod)
+		: ModuleEventListener(mod, "event/away")
+	{
+	}
+
+ public:
+	/** Called when a user wishes to mark themselves as away.
+	 * @param user The user who is going away.
+	 * @param message The away message that the user set.
+	 * @return Either MOD_RES_ALLOW to allow the user to mark themself as away, MOD_RES_DENY to
+	 *         disallow the user to mark themself as away, or MOD_RES_PASSTHRU to let another module
+	 *         handle the event.
+	 */
+	virtual ModResult OnUserPreAway(LocalUser* user, std::string& message)
+	{
+		return MOD_RES_PASSTHRU;
+	}
+
+	/** Called when a user wishes to mark themselves as back.
+	 * @param user The user who is going away.
+	 * @param message The away message that the user set.
+	 * @return Either MOD_RES_ALLOW to allow the user to mark themself as back, MOD_RES_DENY to
+	 *         disallow the user to mark themself as back, or MOD_RES_PASSTHRU to let another module
+	 *         handle the event.
+	 */
+	virtual ModResult OnUserPreBack(LocalUser* user)
+	{
+		return MOD_RES_PASSTHRU;
+	}
+
+	/** Called when a user has marked themself as away.
+	 * @param user The user who has gone away.
+	 */
+	virtual void OnUserAway(User* user) = 0;
+
+	/** Called when a user has returned from being away.
+	 * @param user The user who has returned from being away.
+	 */
+	virtual void OnUserBack(User* user) = 0;
+};
+
+class Away::EventProvider
+	: public Events::ModuleEventProvider
+{
+ public:
+	EventProvider(Module* mod)
+		: ModuleEventProvider(mod, "event/away")
+	{
+	}
+};
diff --git a/include/numerics.h b/include/numerics.h
index 9e0ee07da..8c2f0ce11 100644
--- a/include/numerics.h
+++ b/include/numerics.h
@@ -70,9 +70,6 @@ enum
 	RPL_USERHOST                    = 302,
 	RPL_ISON                        = 303,
 
-	RPL_UNAWAY                      = 305,
-	RPL_NOWAWAY                     = 306,
-
 	RPL_WHOISSERVER                 = 312,
 	RPL_ENDOFWHOIS                  = 318,