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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2012-2014 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
*
* 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 "convto.h"
/**
* Represents a member of a channel.
* A Membership object is created when a user joins a channel, and destroyed when a user leaves
* (via kick, part or quit) a channel.
* All prefix modes a member has is tracked by this object. Moreover, Memberships are Extensibles
* meaning modules can add arbitrary data to them using extensions (see m_delaymsg for an example).
*/
class CoreExport Membership : public Extensible, public insp::intrusive_list_node<Membership>
{
public:
/** Type of the Membership id
*/
typedef uint64_t Id;
/** User on the channel
*/
User* const user;
/** Channel the user is on
*/
Channel* const chan;
/** List of prefix mode letters this member has,
* sorted by prefix rank, highest first
*/
std::string modes;
/** Id of this Membership, set by the protocol module, other components should never read or
* write this field.
*/
Id id;
/** Converts a string to a Membership::Id
* @param str The string to convert
* @return Raw value of type Membership::Id
*/
static Id IdFromString(const std::string& str)
{
return ConvToNum<Id>(str);
}
/** Constructor, sets the user and chan fields to the parameters, does NOT update any bookkeeping
* information in the User or the Channel.
* Call Channel::JoinUser() or ForceJoin() to make a user join a channel instead of constructing
* Membership objects directly.
*/
Membership(User* u, Channel* c) : user(u), chan(c) {}
/** Check if this member has a given prefix mode set
* @param pm Prefix mode to check
* @return True if the member has the prefix mode set, false otherwise
*/
bool HasMode(const PrefixMode* pm) const
{
return (modes.find(pm->GetModeChar()) != std::string::npos);
}
/** Returns the rank of this member.
* The rank of a member is defined as the rank given by the 'strongest' prefix mode a
* member has. See the PrefixMode class description for more info.
* @return The rank of the member
*/
unsigned int getRank();
/** Add a prefix character to a user.
* Only the core should call this method, usually from
* within the mode parser or when the first user joins
* the channel (to grant the default privs to them)
* @param mh The mode handler of the prefix mode to associate
* @param adding True if adding the prefix, false when removing
* @return True if a change was made
*/
bool SetPrefix(PrefixMode* mh, bool adding);
/** Get the highest prefix this user has on the channel
* @return A character containing the highest prefix.
* If the user has no prefix, 0 is returned. If the user has multiple prefixes,
* the highest is returned. If you do not recognise the prefix character you
* can get, you can deal with it in a 'proportional' manner compared to known
* prefixes, using GetPrefixValue().
*/
char GetPrefixChar() const;
/** Return all prefix chars this member has.
* @return A list of all prefix characters. The prefixes will always
* be in rank order, greatest first, as certain IRC clients require
* this when multiple prefixes are used names lists.
*/
std::string GetAllPrefixChars() const;
/** Sends a server notice to this user in the context of this channel.
* @param text The contents of the message to send.
*/
void WriteNotice(const std::string& text) const;
};
|
