aboutsummaryrefslogtreecommitdiff
path: root/include/modules/isupport.h
blob: 50753de4971cfed47ad4f44126f847edb8de9ec7 (about) (plain) (blame)
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
/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2020-2023 Sadie Powell <sadie@sadiepowell.dev>
 *
 * 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

namespace ISupport
{
	class API;
	class APIBase;
	class EventListener;
	class EventProvider;

	/* A mapping of ISUPPORT tokens to their values. */
	typedef std::map<std::string, std::string, irc::insensitive_swo> TokenMap;
}

enum
{
	// From draft-brocklesby-irc-isupport-03.
	RPL_ISUPPORT = 5,
};

/** Defines the interface for the ISupport API. */
class ISupport::APIBase
	: public DataProvider
{
public:
	APIBase(Module* mod)
		: DataProvider(mod, "isupportapi")
	{
	}

	/** Sends a full ISupport numeric set to the specified user.
	 * @param user The user to send to.
	 */
	virtual void SendTo(LocalUser* user) const = 0;
};

/** Allows modules to send ISupport messages to users. */
class ISupport::API final
	: public dynamic_reference<ISupport::APIBase>
{
public:
	API(Module* mod)
		: dynamic_reference<ISupport::APIBase>(mod, "isupportapi")
	{
	}
};

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

public:
	virtual void OnBuildISupport(TokenMap& tokens) { }
	virtual void OnBuildClassISupport(const std::shared_ptr<ConnectClass>& klass, TokenMap& tokens) { }
	virtual ModResult OnSendISupportDiff(LocalUser* user, const TokenMap& tokens)
	{
		return MOD_RES_PASSTHRU;
	}
};

class ISupport::EventProvider final
	: public Events::ModuleEventProvider
{
public:
	EventProvider(Module* mod)
		: Events::ModuleEventProvider(mod, "event/isupport")
	{
	}
};