X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsnomasks.h;h=df4faab47b982c71781b900f183709e2e59c2951;hb=02220d48eec4dd3507b582031de639c9d7835ec8;hp=742528c06cec5f4a1d57710460744c5625f8d5d6;hpb=606aa8f09b64d9b779fe847f7f969b6c456f8343;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/snomasks.h b/include/snomasks.h index 742528c06..df4faab47 100644 --- a/include/snomasks.h +++ b/include/snomasks.h @@ -1,76 +1,85 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2010 Daniel De Graaf + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 Craig Edwards * - * 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 . */ -#ifndef __SNOMASKS_H__ -#define __SNOMASKS_H__ -class Snomask : public Extensible -{ - private: - InspIRCd *ServerInstance; +#pragma once - public: - char MySnomask; +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; - 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(InspIRCd* Instance, char snomask, const std::string &description) : ServerInstance(Instance), MySnomask(snomask), Description(description), LastMessage(""), Count(0) - { - } + Snomask(); /** Sends a message to all opers with this snomask. + * @param message The message to send + * @param remote If true the message will go to the uppercase variant of this snomask */ - void SendMessage(const std::string &message); + void SendMessage(const std::string& message, char letter); /** 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 SnoList; + /** 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; -/** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers. + 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 Extensible +class CoreExport SnomaskManager { - private: - /** Creator/owner - */ - InspIRCd* ServerInstance; + Snomask masks[26]; - /** 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(); + SnomaskManager(); /** Enable a snomask. * @param letter The snomask letter to enable. Once enabled, @@ -78,31 +87,35 @@ class CoreExport SnomaskManager : public Extensible * 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); + void 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. + /** 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. + /** 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 @@ -113,11 +126,11 @@ class CoreExport SnomaskManager : public Extensible */ void FlushSnotices(); - /** Check if a snomask is enabled. - * @param letter The snomask letter to check. - * @return True if the snomask has been enabled. + /** 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 IsEnabled(char letter); + bool IsSnomaskUsable(char ch) const; }; - -#endif