summaryrefslogtreecommitdiff
path: root/include/modules/who.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/modules/who.h')
-rw-r--r--include/modules/who.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/include/modules/who.h b/include/modules/who.h
new file mode 100644
index 000000000..4fcbe5f91
--- /dev/null
+++ b/include/modules/who.h
@@ -0,0 +1,80 @@
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2015 Attila Molnar <attilamolnar@hush.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 Who
+{
+ class EventListener;
+ class Request;
+}
+
+class Who::EventListener : public Events::ModuleEventListener
+{
+ public:
+ EventListener(Module* mod)
+ : ModuleEventListener(mod, "event/who")
+ {
+ }
+
+ /** Called when a result from WHO is about to be queued.
+ * @param request Details about the WHO request which caused this response.
+ * @param source The user who initiated this WHO request.
+ * @param user The user that this line of the WHO request is about.
+ * @param memb The channel membership of the user or NULL if not targeted at a channel.
+ * @param numeric The numeric which will be sent in response to the request.
+ * @return MOD_RES_ALLOW to explicitly allow the response, MOD_RES_DENY to explicitly deny the
+ * response, or MOD_RES_PASSTHRU to let another module handle the event.
+ */
+ virtual ModResult OnWhoLine(const Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) = 0;
+};
+
+class Who::Request
+{
+ public:
+ /** The flags for matching users to include. */
+ std::bitset<UCHAR_MAX> flags;
+
+ /** Whether we are matching using a wildcard or a flag. */
+ bool fuzzy_match;
+
+ /** The text to match against. */
+ std::string matchtext;
+
+ /** The WHO/WHOX responses we will send to the source. */
+ std::vector<Numeric::Numeric> results;
+
+ /** Whether the source requested a WHOX response. */
+ bool whox;
+
+ /** The fields to include in the WHOX response. */
+ std::bitset<UCHAR_MAX> whox_fields;
+
+ /** A user specified label for the WHOX response. */
+ std::string whox_querytype;
+
+ protected:
+ Request()
+ : fuzzy_match(false)
+ , whox(false)
+ {
+ }
+};