X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=f69acde0b2b0b6b675844c6cb0121f9485b56413;hb=2ba32afa9a9aca7c82966b66bda16c3c3dbfbba5;hp=a3afe9fb37f37da3066ea1e2481afc352abba425;hpb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/protocol.h b/include/protocol.h index a3afe9fb3..f69acde0b 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -1,137 +1,146 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2018 Matt Schatz + * Copyright (C) 2013-2014 Attila Molnar + * Copyright (C) 2013, 2018-2019 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2008, 2010 Craig Edwards + * Copyright (C) 2008 Robin Burchell * - * 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 __PROTOCOL_H__ -#define __PROTOCOL_H__ -#include "hashcomp.h" +#pragma once class User; -typedef std::vector parameterlist; - -class ProtoServer +class ProtocolServer { public: - std::string servername; - std::string parentname; - std::string gecos; - unsigned int usercount; - unsigned int opercount; - unsigned int latencyms; + /** Send metadata related to this server to the target server + * @param key The 'key' of the data + * @param data The string representation of the data + */ + virtual void SendMetaData(const std::string& key, const std::string& data) = 0; }; -typedef std::list ProtoServerList; - -class ProtocolInterface : public Extensible +class CoreExport ProtocolInterface { public: - ProtocolInterface() { } + typedef ProtocolServer Server; + + class ServerInfo + { + public: + std::string servername; + std::string parentname; + std::string description; + unsigned int usercount; + unsigned int opercount; + unsigned int latencyms; + }; + + typedef std::vector ServerList; + 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. */ - virtual void SendEncapsulatedData(parameterlist &encap) { } + virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const CommandBase::Params& params, User* source = NULL) { return false; } - /** Send metadata for an object to other linked servers. - * @param target The object to send metadata for. - * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user - * @param data The string representation of the data + /** 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 SendMetaData(Extensible* target, const std::string &key, const std::string &data) { } + virtual void BroadcastEncap(const std::string& cmd, const CommandBase::Params& params, User* source = NULL, User* omit = NULL) { } - /** 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. + /** Send metadata for a channel to other linked servers. + * @param chan The channel to send metadata for + * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user + * @param data The string representation of the data */ - virtual void SendTopic(Channel* channel, std::string &topic) { } + virtual void SendMetaData(Channel* chan, const std::string& key, const std::string& data) { } - /** Send mode changes for an object. - * @param target The channel name or user to send mode changes for. - * @param The mode changes to send. + /** Send metadata for a user to other linked servers. + * @param user The user to send metadata for + * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user + * @param data The string representation of the data */ - virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::vector &translate) { } - - /** Convenience function, string wrapper around the above. - */ - virtual void SendModeStr(const std::string &target, const std::string &modeline) - { - irc::spacesepstream x(modeline); - parameterlist n; - std::vector types; - std::string v; - while (x.GetToken(v)) - { - n.push_back(v); - types.push_back(TR_TEXT); - } - SendMode(target, n, types); - } + virtual void SendMetaData(User* user, const std::string& key, const std::string& data) { } - /** Send a notice to users with a given mode(s). - * @param modes The modes required for the message to be sent. - * @param text The message to send. + /** Send metadata related to the server to other linked servers. + * @param key The 'key' of the data + * @param data The string representation of the data */ - virtual void SendModeNotice(const std::string &modes, const std::string &text) { } + virtual void SendMetaData(const std::string& key, const std::string& data) { } /** 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(const std::string &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) { } + virtual void SendSNONotice(char snomask, const std::string& text) { } /** 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) */ - virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { } + virtual void SendMessage(Channel* target, char status, const std::string& text, MessageType type = MSG_PRIVMSG) { } - /** Send a notice to a channel. - * @param target The channel to message. - * @param status The status character (e.g. %) required to recieve. + /** Send a message to a user. + * @param target The user to message. * @param text The message to send. + * @param type The message type (MSG_PRIVMSG or MSG_NOTICE) */ - virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { } + virtual void SendMessage(User* target, const std::string& text, MessageType type = MSG_PRIVMSG) { } - /** Send a message to a user. - * @param target The user to message. + /** Send a notice to a channel. + * @param target The channel to message. + * @param status The status character (e.g. %) required to receive. * @param text The message to send. */ - virtual void SendUserPrivmsg(User* target, const std::string &text) { } + DEPRECATED_METHOD(void SendChannelNotice(Channel* target, char status, const std::string& text)) + { + SendMessage(target, status, text, MSG_NOTICE); + } /** Send a notice to a user. * @param target The user to message. * @param text The message to send. */ - virtual void SendUserNotice(User* target, const std::string &text) { } + DEPRECATED_METHOD(void SendUserNotice(User* target, const std::string& text)) + { + SendMessage(target, text, MSG_NOTICE); + } /** Fill a list of servers and information about them. * @param sl The list of servers to fill. * XXX: document me properly, this is shit. */ - virtual void GetServerList(ProtoServerList &sl) { } + virtual void GetServerList(ServerList& sl) { } }; - -#endif -