X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsnomasks.h;h=85ad26f71392a7e068f35a43b7e3564cc17770cd;hb=e6601069038c35c546fd3f3dce95024b0d13f1b4;hp=b718a2908b5ef06bc6b09fde1622c0d37501ca25;hpb=7015eeaa33b8a1650595484f53076faf2de8243b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/snomasks.h b/include/snomasks.h index b718a2908..85ad26f71 100644 --- a/include/snomasks.h +++ b/include/snomasks.h @@ -1,55 +1,64 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * + * Copyright (C) 2010 Daniel De Graaf + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 Craig Edwards * - * 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 . */ -#ifndef __SNOMASKS_H__ -#define __SNOMASKS_H__ -#include -#include -#include -#include "configreader.h" -#include "inspircd.h" +#ifndef SNOMASKS_H +#define SNOMASKS_H -/** A list of snomasks which are valid, and their descriptive texts - */ -typedef std::map SnoList; +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); -/** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers. + /** Sends out the (last message repeated N times) message + */ + void Flush(); +}; + +/** 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 SnomaskManager : public Extensible +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: + Snomask masks[26]; + /** Create a new SnomaskManager */ - SnomaskManager(InspIRCd* Instance); - /** Delete SnomaskManager - */ - ~SnomaskManager(); + SnomaskManager(); /** Enable a snomask. * @param letter The snomask letter to enable. Once enabled, @@ -57,32 +66,45 @@ class 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); - /** 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. + 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. + + /** 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, ...); - /** Check if a snomask is enabled. - * @param letter The snomask letter to check. - * @return True if the snomask has been enabled. + 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. */ - bool IsEnabled(char letter); + void FlushSnotices(); }; #endif