X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsnomasks.h;h=e3859faba7c5787c175857feeaae785f196e204b;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=0c62a42297e78ad9bd440b1ace6312bae1105f38;hpb=98131a0a1c9d8ccc1f0015552a26882b58a9cbf3;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/snomasks.h b/include/snomasks.h
index 0c62a4229..e3859faba 100644
--- a/include/snomasks.h
+++ b/include/snomasks.h
@@ -1,52 +1,87 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
  *
- * 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
 
+#pragma once
+
+class SnomaskManager;
 class Snomask
 {
- public:
+	/** Description of this snomask, e.g.: OPER, ANNOUNCEMENT, XLINE
+	 */
 	std::string Description;
+
+	/** Information about the last sent message,
+	 * used for sending "last message repeated X times" messages
+	 */
 	std::string LastMessage;
-	int Count;
-	bool LastBlocked;
 	char LastLetter;
+	unsigned int Count;
+
+	/** Log and send a message to all opers who have the given snomask set
+	 * @param letter The target users of this message
+	 * @param desc The description of this snomask, will be prepended to the message
+	 * @param msg The message to send
+	 */
+	static void Send(char letter, const std::string& desc, const std::string& msg);
 
+ public:
 	/** Create a new Snomask
 	 */
-	Snomask() : Count(0), LastBlocked(false), LastLetter(0)
-	{
-	}
+	Snomask();
 
 	/** Sends a message to all opers with this snomask.
+	 * @param message The message to send
+	 * @param letter The snomask character to send the message to.
 	 */
-	void SendMessage(const std::string &message, char letter);
+	void SendMessage(const std::string& message, char letter);
 
 	/** Sends out the (last message repeated N times) message
 	 */
 	void Flush();
+
+	/** Returns the description of this snomask
+	 * @param letter The letter of this snomask. If uppercase, the description of the remote
+	 * variant of this snomask will be returned (i.e.: "REMOTE" will be prepended to the description).
+	 * @return The description of this snomask
+	 */
+	std::string GetDescription(char letter) const;
+
+	friend class SnomaskManager;
 };
 
 /** 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
+class CoreExport SnomaskManager : public fakederef<SnomaskManager>
 {
- public:
 	Snomask	masks[26];
 
+ public:
 	/** Create a new SnomaskManager
 	 */
 	SnomaskManager();
@@ -86,7 +121,6 @@ class CoreExport SnomaskManager
 	 */
 	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
@@ -96,6 +130,12 @@ class CoreExport SnomaskManager
 	 * is not particularly significant, in order to keep notices going out.
 	 */
 	void FlushSnotices();
-};
 
-#endif
+	/** Check whether a given character is an enabled (initialized) snomask.
+	 * Valid snomask chars are lower- or uppercase letters and have a description.
+	 * Snomasks are initialized with EnableSnomask().
+	 * @param ch The character to check
+	 * @return True if the given char is allowed to be set via +s.
+	 */
+	bool IsSnomaskUsable(char ch) const;
+};