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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2022-2023 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 Account
{
class API;
class APIBase;
class EventListener;
/** Encapsulates a list of nicknames associated with an account. */
typedef insp::flat_set<std::string, irc::insensitive_swo> NickList;
}
/** Defines the interface for the account API. */
class Account::APIBase
: public DataProvider
{
public:
APIBase(Module* parent)
: DataProvider(parent, "accountapi")
{
}
/** Retrieves the account identifier of the specified user.
* @param user The user to retrieve the account identifier of.
* @return If the user is logged in to an account then the account identifier; otherwise, nullptr.
*/
virtual std::string* GetAccountId(const User* user) const = 0;
/** Retrieves the account name of the specified user.
* @param user The user to retrieve the account name of.
* @return If the user is logged in to an account then the account name; otherwise, nullptr.
*/
virtual std::string* GetAccountName(const User* user) const = 0;
/** Retrieves the account nicks of the specified user.
* @param user The user to retrieve the account nicks of.
* @return If the user is logged in to an account then the account nicks; otherwise, nullptr.
*/
virtual NickList* GetAccountNicks(const User* user) const = 0;
/** Determines whether a user is identified to their nickname.
* @param user The user to check the identification status of.
* @return If the user is identified to their nickname then true; otherwise, false.
*/
virtual bool IsIdentifiedToNick(const User* user) = 0;
};
/** Allows modules to access information regarding user accounts. */
class Account::API final
: public dynamic_reference<Account::APIBase>
{
public:
API(Module* parent)
: dynamic_reference<Account::APIBase>(parent, "accountapi")
{
}
};
/** Provides handlers for events relating to accounts. */
class Account::EventListener
: public Events::ModuleEventListener
{
public:
EventListener(Module* mod, unsigned int eventprio = DefaultPriority)
: ModuleEventListener(mod, "event/account", eventprio)
{
}
/** Called whenever a user logs in or out of an account.
* @param user The user who logged in or out.
* @param account The name of the account if logging in or empty if logging out.
*/
virtual void OnAccountChange(User* user, const std::string& account) = 0;
};
|
