Remove SpanningTreeProtocolInterface::SendOperNotice - it was translated to a SendSNO...

[user/henk/code/inspircd.git] / include / snomasks.h

diff --git a/include/snomasks.h b/include/snomasks.h
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..5bd4742c18200c1f46987085601152940209cbc3 100644 (file)
--- a/include/snomasks.h
+++ b/include/snomasks.h
@@ -0,0 +1,124 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 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__
+
+class Snomask : public Extensible
+{
+ private:
+       InspIRCd *ServerInstance;
+
+ public:
+       char MySnomask;
+       std::string Description;
+       std::string LastMessage;
+       unsigned int Count;
+       bool LocalOnly; // whether or not messages are netwide
+
+       /** Create a new Snomask
+        */
+       Snomask(InspIRCd* Instance, char snomask, const std::string &description, bool local) : ServerInstance(Instance), MySnomask(snomask), Description(description), LastMessage(""), Count(0), LocalOnly(local)
+       {
+       }
+
+       /** Sends a message to all opers with this snomask.
+        */
+       void SendMessage(const std::string &message);
+
+       /** Sends out a pending message
+        */
+       void Flush();
+};
+
+/** 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".
+        * @param local Whether or not messages should be locally broadcast only (default off)
+        * @return True if the snomask was enabled, false if it already
+        * exists.
+        */
+       bool EnableSnomask(char letter, const std::string &description, bool local = false);
+
+       /** 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, ...) 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 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