/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2018 Matt Schatz <genius3000@g3k.solutions>
+ * Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
* Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
- * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
*
* 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
#pragma once
-#include "hashcomp.h"
-
class User;
-typedef std::vector<std::string> parameterlist;
-
class ProtocolServer
{
public:
public:
std::string servername;
std::string parentname;
- std::string gecos;
+ std::string description;
unsigned int usercount;
unsigned int opercount;
unsigned int latencyms;
virtual ~ProtocolInterface() { }
- /** Send an ENCAP message to one or more linked servers.
+ /** Send an ENCAP message to all servers matching a wildcard string.
* See the protocol documentation for the purpose of ENCAP.
- * @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
- * The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
+ * @param targetmask The target server mask (can contain wildcards)
+ * @param cmd The ENCAP subcommand
+ * @param params List of string parameters which are dependent on the subcommand
+ * @param source The source of the message (prefix), must be a local user or NULL which means use local server
+ * @return Always true if the target mask contains wildcards; otherwise true if the server name was found,
+ * and the message was sent, false if it was not found.
* ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
- * @return True if the message was sent out (target exists)
*/
- virtual bool SendEncapsulatedData(const parameterlist &encap) { return false; }
+ virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const CommandBase::Params& params, User* source = NULL) { return false; }
+
+ /** Send an ENCAP message to all servers.
+ * See the protocol documentation for the purpose of ENCAP.
+ * @param cmd The ENCAP subcommand
+ * @param params List of string parameters which are dependent on the subcommand
+ * @param source The source of the message (prefix), must be a local user or a user behind 'omit'
+ * or NULL which is equivalent to the local server
+ * @param omit If non-NULL the message won't be sent in the direction of this server, useful for forwarding messages
+ */
+ virtual void BroadcastEncap(const std::string& cmd, const CommandBase::Params& params, User* source = NULL, User* omit = NULL) { }
/** Send metadata for a channel to other linked servers.
* @param chan The channel to send metadata for
*/
virtual void SendMetaData(const std::string& key, const std::string& data) { }
- /** Send a topic change for a channel
- * @param channel The channel to change the topic for.
- * @param topic The new topic to use for the channel.
- */
- virtual void SendTopic(Channel* channel, std::string &topic) { }
-
- /** Send mode changes for an object.
- * @param source The source of the mode change
- * @param usertarget The target user, NULL if the target is a channel
- * @param chantarget The target channel, NULL if the target is a user
- * @param modedata The mode changes to send.
- * @param translate A list of translation types
- */
- virtual void SendMode(User* source, User* usertarget, Channel* chantarget, const parameterlist& modedata, const std::vector<TranslateType>& translate) { }
-
/** Send a notice to users with a given snomask.
* @param snomask The snomask required for the message to be sent.
* @param text The message to send.
*/
virtual void SendSNONotice(char snomask, const std::string& text) { }
- /** Send raw data to a remote client.
- * @param target The user to push data to.
- * @param rawline The raw IRC protocol line to deliver (":me NOTICE you :foo", whatever).
- */
- virtual void PushToClient(User* target, const std::string &rawline) { }
-
/** Send a message to a channel.
* @param target The channel to message.
- * @param status The status character (e.g. %) required to recieve.
+ * @param status The status character (e.g. %) required to receive.
* @param text The message to send.
* @param type The message type (MSG_PRIVMSG or MSG_NOTICE)
*/
/** Send a notice to a channel.
* @param target The channel to message.
- * @param status The status character (e.g. %) required to recieve.
+ * @param status The status character (e.g. %) required to receive.
* @param text The message to send.
*/
- void SendChannelNotice(Channel* target, char status, const std::string &text)
+ DEPRECATED_METHOD(void SendChannelNotice(Channel* target, char status, const std::string& text))
{
SendMessage(target, status, text, MSG_NOTICE);
}
* @param target The user to message.
* @param text The message to send.
*/
- void SendUserNotice(User* target, const std::string &text)
+ DEPRECATED_METHOD(void SendUserNotice(User* target, const std::string& text))
{
SendMessage(target, text, MSG_NOTICE);
}
projects / user / henk / code / inspircd.git / blobdiff