X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fsnomasks.h;h=e3859faba7c5787c175857feeaae785f196e204b;hb=27f8e788c2a515f63f1f0e5e2b4b0d5e78c3dab4;hp=b318fdc265bff0677767565284b8bcbcfd1e41c8;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/snomasks.h b/include/snomasks.h index b318fdc26..e3859faba 100644 --- a/include/snomasks.h +++ b/include/snomasks.h @@ -1 +1,141 @@ -/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2007 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__ #include #include #include #include "configreader.h" #include "inspircd.h" /** A list of snomasks which are valid, and their descriptive texts */ typedef std::map 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". * @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. * @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, ...); /** 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 \ No newline at end of file +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2013-2014 Attila Molnar + * Copyright (C) 2013, 2017 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006, 2010 Craig Edwards + * + * 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 . + */ + + +#pragma once + +class SnomaskManager; +class Snomask +{ + /** 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; + 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(); + + /** 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); + + /** 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 : public fakederef +{ + Snomask masks[26]; + + public: + /** 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); + + /** 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 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; +};