X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=f69acde0b2b0b6b675844c6cb0121f9485b56413;hb=2ba32afa9a9aca7c82966b66bda16c3c3dbfbba5;hp=85490c1d0387f5e0257f0f32c8040075064b58c3;hpb=d3d32dcf6ddb15d8ca9089de63a51b45b437a063;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/protocol.h b/include/protocol.h index 85490c1d0..f69acde0b 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -1,60 +1,146 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/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" -class InspIRCd; +#pragma once -typedef std::deque parameterlist; +class User; -class ProtocolInterface : public Extensible +class ProtocolServer { - protected: - InspIRCd* ServerInstance; public: - ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { } - virtual ~ProtocolInterface() { } + /** 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; +}; - virtual void SendEncapsulatedData(parameterlist &encap) { } +class CoreExport ProtocolInterface +{ + public: + typedef ProtocolServer Server; - virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { } + class ServerInfo + { + public: + std::string servername; + std::string parentname; + std::string description; + unsigned int usercount; + unsigned int opercount; + unsigned int latencyms; + }; - virtual void SendTopic(Channel* channel, std::string &topic) { } + typedef std::vector ServerList; - virtual void SendMode(const std::string &target, parameterlist &modedata) { } + virtual ~ProtocolInterface() { } - virtual void SendMode(const std::string &target, const std::string &modeline) + /** Send an ENCAP message to all servers matching a wildcard string. + * See the protocol documentation for the purpose of ENCAP. + * @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 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 + * @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 SendMetaData(Channel* chan, const std::string& key, const std::string& data) { } + + /** 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 SendMetaData(User* user, const std::string& key, const std::string& data) { } + + /** 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 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(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 receive. + * @param text The message to send. + * @param type The message type (MSG_PRIVMSG or MSG_NOTICE) + */ + virtual void SendMessage(Channel* target, char status, const std::string& text, MessageType type = MSG_PRIVMSG) { } + + /** 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 SendMessage(User* target, 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 receive. + * @param text The message to send. + */ + DEPRECATED_METHOD(void SendChannelNotice(Channel* target, char status, const std::string& text)) { - /* Convenience function */ - irc::spacesepstream x(modeline); - parameterlist n; - std::string v; - while (x.GetToken(v)) - n.push_back(v); - SendMode(target, n); + SendMessage(target, status, text, MSG_NOTICE); } - virtual void SendOperNotice(const std::string &text) { } - - virtual void SendModeNotice(const std::string &modes, const std::string &text) { } - - virtual void SendSNONotice(const std::string &snomask, const std::string &text) { } + /** Send a notice to a user. + * @param target The user to message. + * @param text The message to send. + */ + DEPRECATED_METHOD(void SendUserNotice(User* target, const std::string& text)) + { + SendMessage(target, text, MSG_NOTICE); + } - virtual void PushToClient(User* target, const std::string &rawline) { } + /** 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(ServerList& sl) { } }; - -#endif -