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
130
131
132
133
134
135
136
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2010 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
*
* 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
class SnomaskManager;
class Snomask
{
/** Description of this snomask, e.g.: OPER, ANNOUNCEMENT, XLINE
*/
std::string Description;
/** Information about the last sent message,
* used for sending "last message repeated X times" messages
*/
std::string LastMessage;
char LastLetter;
unsigned int Count;
/** Log and send a message to all opers who have the given snomask set
* @param letter The target users of this message
* @param desc The description of this snomask, will be prepended to the message
* @param msg The message to send
*/
static void Send(char letter, const std::string& desc, const std::string& msg);
public:
/** Create a new Snomask
*/
Snomask();
/** Sends a message to all opers with this snomask.
* @param message The message to send
* @param remote If true the message will go to the uppercase variant of this snomask
*/
void SendMessage(const std::string& message, char letter);
/** Sends out the (last message repeated N times) message
*/
void Flush();
/** Returns the description of this snomask
* @param remote If true the description of the uppercase (remote) variant of this snomask
* will be returned (i.e.: "REMOTE" will be prepended to the description).
* @return The description of this snomask
*/
std::string GetDescription(char letter) const;
friend class SnomaskManager;
};
/** Snomask manager handles routing of SNOMASK (usermode +s) messages to opers.
* Modules and the core can enable and disable snomask characters. If they do,
* then sending snomasks using these characters becomes possible.
*/
class CoreExport SnomaskManager
{
Snomask masks[26];
public:
/** Create a new SnomaskManager
*/
SnomaskManager();
/** Enable a snomask.
* @param letter The snomask letter to enable. Once enabled,
* server notices may be routed to users with this letter in
* their list, and users may add this letter to their list.
* @param description The descriptive text sent along with any
* server notices, at the start of the notice, e.g. "GLOBOPS".
*/
void EnableSnomask(char letter, const std::string &description);
/** Write to all users with a given snomask (local server only)
* @param letter The snomask letter to write to
* @param text The text to send to the users
*/
void WriteToSnoMask(char letter, const std::string &text);
/** Write to all users with a given snomask (local server only)
* @param letter The snomask letter to write to
* @param text A format string containing text to send
* @param ... Format arguments
*/
void WriteToSnoMask(char letter, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Write to all users with a given snomask (sent globally)
* @param letter The snomask letter to write to
* @param text The text to send to the users
*/
void WriteGlobalSno(char letter, const std::string &text);
/** Write to all users with a given snomask (sent globally)
* @param letter The snomask letter to write to
* @param text A format string containing text to send
* @param ... Format arguments
*/
void WriteGlobalSno(char letter, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Called once per 5 seconds from the mainloop, this flushes any cached
* snotices. The way the caching works is as follows:
* Calls to WriteToSnoMask write to a cache, if the call is the same as it was
* for the previous call, then a count is incremented. If it is different,
* the previous message it just sent normally via NOTICE (with count if > 1)
* and the new message is cached. This acts as a sender in case the number of notices
* is not particularly significant, in order to keep notices going out.
*/
void FlushSnotices();
/** Check whether a given character is an enabled (initialized) snomask.
* Valid snomask chars are lower- or uppercase letters and have a description.
* Snomasks are initialized with EnableSnomask().
* @param ch The character to check
* @return True if the given char is allowed to be set via +s.
*/
bool IsSnomaskUsable(char ch) const;
};
|
