summaryrefslogtreecommitdiff
path: root/include/modules/exemption.h
blob: 9319c4737cd3dcde1aa095acb08e69048d7e6f2a (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
/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2017, 2019 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 CheckExemption
{
	class EventListener;
	class EventProvider;

	/** Helper function for calling the CheckExemption::EventListener::OnCheckExemption event.
	 * @param prov The CheckExemption::EventProvider which is calling the event.
	 * @param user The user to check exemption for.
	 * @param chan The channel to check exemption on.
	 * @param restriction The restriction to check for.
	 * @return Either MOD_RES_ALLOW if the exemption was confirmed, MOD_RES_DENY if the exemption was
	 *         denied or MOD_RES_PASSTHRU if no module handled the event.
	 */
	inline ModResult Call(const CheckExemption::EventProvider& prov, User* user, Channel* chan, const std::string& restriction);
}

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

 public:
	/** Called when checking if a user is exempt from something.
	 * @param user The user to check exemption for.
	 * @param chan The channel to check exemption on.
	 * @param restriction The restriction to check for.
	 * @return Either MOD_RES_ALLOW to confirm an exemption, MOD_RES_DENY to deny an exemption,
	 *         or MOD_RES_PASSTHRU to let another module handle the event.
	 */
	virtual ModResult OnCheckExemption(User* user, Channel* chan, const std::string& restriction) = 0;
};

class CheckExemption::EventProvider
	: public Events::ModuleEventProvider
{
 public:
	EventProvider(Module* mod)
		: ModuleEventProvider(mod, "event/exemption")
	{
	}
};

inline ModResult CheckExemption::Call(const CheckExemption::EventProvider& prov, User* user, Channel* chan, const std::string& restriction)
{
	ModResult result;
	FIRST_MOD_RESULT_CUSTOM(prov, CheckExemption::EventListener, OnCheckExemption, result, (user, chan, restriction));
	return result;
}