/usr/include/inspircd/snomasks.h is in inspircd-dev 2.0.20-5build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* 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/>.
*/
#ifndef SNOMASKS_H
#define SNOMASKS_H
class Snomask
{
public:
std::string Description;
std::string LastMessage;
int Count;
bool LastBlocked;
char LastLetter;
/** Create a new Snomask
*/
Snomask() : Count(0), LastBlocked(false), LastLetter(0)
{
}
/** Sends a message to all opers with this snomask.
*/
void SendMessage(const std::string &message, char letter);
/** Sends out the (last message repeated N times) message
*/
void Flush();
};
/** 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
{
public:
Snomask masks[26];
/** 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();
};
#endif
|