1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __SNOMASKS_H__
15 #define __SNOMASKS_H__
17 class Snomask : public Extensible
20 InspIRCd *ServerInstance;
24 std::string Description;
25 std::string LastMessage;
27 bool LocalOnly; // whether or not messages are netwide
29 /** Create a new Snomask
31 Snomask(InspIRCd* Instance, char snomask, const std::string &description, bool local) : ServerInstance(Instance), MySnomask(snomask), Description(description), LastMessage(""), Count(0), LocalOnly(local)
35 /** Sends a message to all opers with this snomask.
37 void SendMessage(const std::string &message);
39 /** Sends out a pending message
44 /** A list of snomasks which are valid, and their descriptive texts
46 typedef std::map<char, Snomask *> SnoList;
48 /** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers.
49 * Modules and the core can enable and disable snomask characters. If they do,
50 * then sending snomasks using these characters becomes possible.
52 class CoreExport SnomaskManager : public Extensible
57 InspIRCd* ServerInstance;
59 /** Currently active snomask list
63 /** Set up the default (core available) snomask chars
67 /** Create a new SnomaskManager
69 SnomaskManager(InspIRCd* Instance);
71 /** Delete SnomaskManager
76 * @param letter The snomask letter to enable. Once enabled,
77 * server notices may be routed to users with this letter in
78 * their list, and users may add this letter to their list.
79 * @param description The descriptive text sent along with any
80 * server notices, at the start of the notice, e.g. "GLOBOPS".
81 * @param local Whether or not messages should be locally broadcast only (default off)
82 * @return True if the snomask was enabled, false if it already
85 bool EnableSnomask(char letter, const std::string &description, bool local = false);
87 /** Disable a snomask.
88 * @param letter The snomask letter to disable.
89 * @return True if the snomask was disabled, false if it didn't
92 bool DisableSnomask(char letter);
94 /** Set the local only message state of a given snomask.
95 * This is used by remote stuff to prevent endless recursion in sending
96 * XXX this is currently a really shit way to do it, as it effectively
97 * bypasses snomask compression!
99 bool SetLocalOnly(char letter, bool local);
101 /** Write to all users with a given snomask.
102 * @param letter The snomask letter to write to
103 * @param text The text to send to the users
105 void WriteToSnoMask(char letter, const std::string &text);
107 /** Write to all users with a given snomask.
108 * @param letter The snomask letter to write to
109 * @param text A format string containing text to send
110 * @param ... Format arguments
112 void WriteToSnoMask(char letter, const char* text, ...) CUSTOM_PRINTF(3, 4);
114 /** Called once per 5 seconds from the mainloop, this flushes any cached
115 * snotices. The way the caching works is as follows:
116 * Calls to WriteToSnoMask write to a cache, if the call is the same as it was
117 * for the previous call, then a count is incremented. If it is different,
118 * the previous message it just sent normally via NOTICE (with count if > 1)
119 * and the new message is cached. This acts as a sender in case the number of notices
120 * is not particularly significant, in order to keep notices going out.
122 void FlushSnotices();
124 /** Check if a snomask is enabled.
125 * @param letter The snomask letter to check.
126 * @return True if the snomask has been enabled.
128 bool IsEnabled(char letter);