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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2019 Sadie Powell <sadie@witchery.services>
* 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
namespace Invite
{
class APIBase;
class API;
class Invite;
typedef insp::intrusive_list<Invite, LocalUser> List;
}
class Invite::APIBase : public DataProvider
{
public:
APIBase(Module* parent);
/** Create or extend an Invite.
* When a user is invited to join a channel either a new Invite object is created or
* or the expiration timestamp is updated if there is already a pending Invite for
* the given (user, channel) pair and the new expiration time is further than the current.
* @param user Target user
* @param chan Target channel
* @param timeout Timestamp when the invite should expire, 0 for no expiration
*/
virtual void Create(LocalUser* user, Channel* chan, time_t timeout) = 0;
/** Retrieves the Invite object for the given (user, channel) pair
* @param user Target user
* @param chan Target channel
* @return Invite object for the given (channel, user) pair if it exists, NULL otherwise
*/
virtual Invite* Find(LocalUser* user, Channel* chan) = 0;
/** Returns the list of channels a user has been invited to but has not yet joined.
* @param user User whose invite list to retrieve
* @return List of channels the user is invited to or NULL if the list is empty
*/
virtual const List* GetList(LocalUser* user) = 0;
/** Check if a user is invited to a channel
* @param user User to check
* @param chan Channel to check
* @return True if the user is invited to the channel, false otherwise
*/
bool IsInvited(LocalUser* user, Channel* chan) { return (Find(user, chan) != NULL); }
/** Removes an Invite if it exists
* @param user User whose invite to remove
* @param chan Channel to remove the invite to
* @return True if the user was invited to the channel and the invite was removed, false if the user wasn't invited
*/
virtual bool Remove(LocalUser* user, Channel* chan) = 0;
};
class Invite::API : public dynamic_reference<APIBase>
{
public:
API(Module* parent)
: dynamic_reference<APIBase>(parent, "core_channel_invite")
{
}
};
/**
* The Invite class contains all data about a pending invite.
* Invite objects are referenced from the user and the channel they belong to.
*/
class Invite::Invite : public insp::intrusive_list_node<Invite, LocalUser>, public insp::intrusive_list_node<Invite, Channel>
{
public:
/** User the invite is for
*/
LocalUser* const user;
/** Channel where the user is invited to
*/
Channel* const chan;
/** Check whether the invite will expire or not
* @return True if the invite is timed, false if it doesn't expire
*/
bool IsTimed() const { return (expiretimer != NULL); }
/** Serialize this object
* @param human Whether to serialize for human consumption or not.
* @param show_chans True to include channel in the output, false to include the nick/uuid
* @param out Output will be appended to this string
*/
void Serialize(bool human, bool show_chans, std::string& out);
friend class APIImpl;
private:
/** Timer handling expiration. If NULL this invite doesn't expire.
*/
Timer* expiretimer;
/** Constructor, only available to the module providing the invite API (core_channel).
* To create Invites use InviteAPI::Create().
* @param user User being invited
* @param chan Channel the user is invited to
*/
Invite(LocalUser* user, Channel* chan);
/** Destructor, only available to the module providing the invite API (core_channel).
* To remove Invites use InviteAPI::Remove().
*/
~Invite();
};
|
