-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __SNOMASKS_H__\r#define __SNOMASKS_H__\r\r#include <string>\r#include <vector>\r#include <map>\r#include "configreader.h"\r#include "inspircd.h"\r\r/** A list of snomasks which are valid, and their descriptive texts\r */\rtypedef std::map<char, std::string> SnoList;\r\r/** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers.\r * Modules and the core can enable and disable snomask characters. If they do,\r * then sending snomasks using these characters becomes possible.\r */\rclass CoreExport SnomaskManager : public Extensible\r{\r private:\r /** Creator/owner\r */\r InspIRCd* ServerInstance;\r /** Currently active snomask list\r */\r SnoList SnoMasks;\r /** Set up the default (core available) snomask chars\r */\r void SetupDefaults();\r public:\r /** Create a new SnomaskManager\r */\r SnomaskManager(InspIRCd* Instance);\r /** Delete SnomaskManager\r */\r ~SnomaskManager();\r\r /** Enable a snomask.\r * @param letter The snomask letter to enable. Once enabled,\r * server notices may be routed to users with this letter in\r * their list, and users may add this letter to their list.\r * @param description The descriptive text sent along with any\r * server notices, at the start of the notice, e.g. "GLOBOPS".\r * @return True if the snomask was enabled, false if it already\r * exists.\r */\r bool EnableSnomask(char letter, const std::string &description);\r /** Disable a snomask.\r * @param letter The snomask letter to disable.\r * @return True if the snomask was disabled, false if it didn't\r * exist.\r */\r bool DisableSnomask(char letter);\r /** Write to all users with a given snomask.\r * @param letter The snomask letter to write to\r * @param text The text to send to the users\r */\r void WriteToSnoMask(char letter, const std::string &text);\r /** Write to all users with a given snomask.\r * @param letter The snomask letter to write to\r * @param text A format string containing text to send\r * @param ... Format arguments\r */\r void WriteToSnoMask(char letter, const char* text, ...);\r /** Check if a snomask is enabled.\r * @param letter The snomask letter to check.\r * @return True if the snomask has been enabled.\r */\r bool IsEnabled(char letter);\r};\r\r#endif\r
\ No newline at end of file
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/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;
+ bool LastBlocked;
+ unsigned int Count;
+
+ /** Create a new Snomask
+ */
+ Snomask(InspIRCd* Instance, char snomask, const std::string &description) : ServerInstance(Instance), MySnomask(snomask), Description(description), LastMessage(""), Count(0)
+ {
+ }
+
+ /** Sends a message to all opers with this snomask.
+ */
+ void SendMessage(const std::string &message);
+
+ /** Sends out the (last message repeated N times) 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
+{
+ 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 (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 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
projects / user / henk / code / inspircd.git / blobdiff