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
|
/* +------------------------------------+
* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
* InspIRCd: (C) 2002-2007 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
#ifndef __SNOMASKS_H__
#define __SNOMASKS_H__
#include <string>
#include <vector>
#include <map>
#include "configreader.h"
#include "inspircd.h"
class Snomask
{
private:
InspIRCd *ServerInstance;
/** Sends out a pending message
*/
void Flush();
public:
char MySnomask;
std::string Description;
std::string LastMessage;
unsigned int Count;
/** Create a new Snomask
*/
Snomask(InspIRCd* Instance, char snomask, const std::string &description)
{
ServerInstance = Instance;
MySnomask = snomask;
Description = description;
}
/** Sends a message to all opers with this snomask.
*/
void SendMessage(const std::string &message);
};
/** A list of snomasks which are valid, and their descriptive texts
*/
typedef std::map<char, Snomask *> SnoList;
/** Snomask manager handles routing of SNOMASK (usermode +n) 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 : public Extensible
{
private:
/** Creator/owner
*/
InspIRCd* ServerInstance;
/** Currently active snomask list
*/
SnoList SnoMasks;
/** Set up the default (core available) snomask chars
*/
void SetupDefaults();
public:
/** Create a new SnomaskManager
*/
SnomaskManager(InspIRCd* Instance);
/** Delete 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".
* @return True if the snomask was enabled, false if it already
* exists.
*/
bool EnableSnomask(char letter, const std::string &description);
/** Disable a snomask.
* @param letter The snomask letter to disable.
* @return True if the snomask was disabled, false if it didn't
* exist.
*/
bool DisableSnomask(char letter);
/** Write to all users with a given snomask.
* @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.
* @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, ...);
/** 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 if a snomask is enabled.
* @param letter The snomask letter to check.
* @return True if the snomask has been enabled.
*/
bool IsEnabled(char letter);
};
#endif
|
