summaryrefslogtreecommitdiff
path: root/include/modules/ctctags.h
blob: d0f0f83bd8a87ad21af0446fbef6d5627ebb8faa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2018 Sadie Powell <sadie@witchery.services>
 *
 * 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 CTCTags
{
	class EventListener;
	class TagMessage;
	class TagMessageDetails;
}

class CTCTags::TagMessage : public ClientProtocol::Message
{
 public:
	TagMessage(User* source, const Channel* targetchan, const ClientProtocol::TagMap& Tags)
		: ClientProtocol::Message("TAGMSG", source)
	{
		PushParamRef(targetchan->name);
		AddTags(Tags);
	}

	TagMessage(User* source, const User* targetuser, const ClientProtocol::TagMap& Tags)
		: ClientProtocol::Message("TAGMSG", source)
	{
		if (targetuser->registered & REG_NICK)
			PushParamRef(targetuser->nick);
		else
			PushParam("*");
		AddTags(Tags);
	}

	TagMessage(User* source, const char* targetstr, const ClientProtocol::TagMap& Tags)
		: ClientProtocol::Message("TAGMSG", source)
	{
		PushParam(targetstr);
		AddTags(Tags);
	}
};

class CTCTags::TagMessageDetails
{
 public:
	/** Whether to echo the tags at all. */
	bool echo;

	/* Whether to send the original tags back to clients with echo-message support. */
	bool echo_original;

	/** The users who are exempted from receiving this message. */
	CUList exemptions;

	/** IRCv3 message tags sent to the server by the user. */
	const ClientProtocol::TagMap tags_in;

	/** IRCv3 message tags sent out to users who get this message. */
	ClientProtocol::TagMap tags_out;

	TagMessageDetails(const ClientProtocol::TagMap& tags)
		: echo(true)
		, echo_original(false)
		, tags_in(tags)
	{
	}
};

class CTCTags::EventListener
	: public Events::ModuleEventListener
{
 protected:
	EventListener(Module* mod, unsigned int eventprio = DefaultPriority)
		: ModuleEventListener(mod, "event/tagmsg", eventprio)
	{
	}

 public:
	/** Called before a user sends a tag message to a channel, a user, or a server glob mask.
	 * @param user The user sending the message.
	 * @param target The target of the message. This can either be a channel, a user, or a server
	 *               glob mask.
	 * @param details Details about the message such as the message tags or whether to echo. See the
	 *                TagMessageDetails class for more information.
	 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
	 *         message, or MOD_RES_PASSTHRU to let another module handle the event.
	 */
	virtual ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, TagMessageDetails& details) { return MOD_RES_PASSTHRU; }
	
	/** Called immediately after a user sends a tag message to a channel, a user, or a server glob mask.
	 * @param user The user sending the message.
	 * @param target The target of the message. This can either be a channel, a user, or a server
	 *               glob mask.
	 * @param details Details about the message such as the message tags or whether to echo. See the
	 *                TagMessageDetails class for more information.
	 */
	virtual void OnUserPostTagMessage(User* user, const MessageTarget& target, const TagMessageDetails& details) { }

	/** Called immediately before a user sends a tag message to a channel, a user, or a server glob mask.
	 * @param user The user sending the message.
	 * @param target The target of the message. This can either be a channel, a user, or a server
	 *               glob mask.
	 * @param details Details about the message such as the message tags or whether to echo. See the
	 *                TagMessageDetails class for more information.
	 */
	virtual void OnUserTagMessage(User* user, const MessageTarget& target, const TagMessageDetails& details) { }

	/** Called when a tag message sent by a user to a channel, a user, or a server glob mask is blocked.
	 * @param user The user sending the message.
	 * @param target The target of the message. This can either be a channel, a user, or a server
	 *               glob mask.
	 * @param details Details about the message such as the message tags or whether to echo. See the
	 *                TagMessageDetails class for more information.
	 */
	virtual void OnUserTagMessageBlocked(User* user, const MessageTarget& target, const TagMessageDetails& details) { }
};