Switch <stdint.h> test to use a test file too.

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

diff --git a/include/snomasks.h b/include/snomasks.h
index c1578e2d0e6edc889cc5f37ec43d18601403002d..85ad26f71392a7e068f35a43b7e3564cc17770cd 100644 (file)
--- a/include/snomasks.h
+++ b/include/snomasks.h
@@ -1,45 +1,110 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *   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>
  *
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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__
 
-#include <string>
-#include <vector>
-#include <map>
-#include "configreader.h"
-#include "inspircd.h"
+#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);
 
-typedef std::map<char, std::string> SnoList;
+       /** Sends out the (last message repeated N times) message
+        */
+       void Flush();
+};
 
-class SnomaskManager : public Extensible
+/** 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
 {
- private:
-       InspIRCd* ServerInstance;
-       SnoList SnoMasks;
-       void SetupDefaults();
  public:
-       SnomaskManager(InspIRCd* Instance);
-       ~SnomaskManager();
+       Snomask masks[26];
 
-       bool EnableSnomask(char letter, const std::string &description);
-       bool DisableSnomask(char letter);
+       /** 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);
-       void WriteToSnoMask(char letter, const char* text, ...);
-       bool IsEnabled(char letter);
+
+       /** 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