X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=c880eee23f2cc03770c3d81325ac14f35b313c04;hb=fcacc8e0306382bc3f938073092c3729d77e2b41;hp=65369e781ea48fb815f9daaf507bdc1d2fb2ccc1;hpb=e48c7e038abe2954ecec30f465c811f017793332;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/protocol.h b/include/protocol.h index 65369e781..c880eee23 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -1,39 +1,138 @@ -/* +------------------------------------+ - * | 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) 2008 Robin Burchell + * Copyright (C) 2008 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 __PROTOCOL_H__ -#define __PROTOCOL_H__ -class InspIRCd; +#ifndef PROTOCOL_H +#define PROTOCOL_H + +#include "hashcomp.h" + +class User; + +typedef std::vector parameterlist; + +class ProtoServer +{ + public: + std::string servername; + std::string parentname; + std::string gecos; + unsigned int usercount; + unsigned int opercount; + unsigned int latencyms; +}; -typedef std::deque parameterlist; +typedef std::list ProtoServerList; -class ProtocolInterface : public Extensible +class ProtocolInterface { - protected: - InspIRCd* ServerInstance; public: - ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { } + ProtocolInterface() { } virtual ~ProtocolInterface() { } - virtual void SendEncapsulatedData(parameterlist &encap) { } - virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { } + /** Send an ENCAP message to one or more linked servers. + * 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. + * 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; } + + /** 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 + */ + virtual void SendMetaData(Extensible* target, 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) { } - virtual void SendMode(const std::string &origin, const std::string &target, parameterlist &modedata) { } - virtual void SendOperNotice(const std::string &text) { } - virtual void SendModeNotice(const std::string &modes, const std::string &text) { } + + /** Send mode changes for an object. + * @param target The channel name or user to send mode changes for. + * @param The mode changes to send. + */ + 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); + } + + /** 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) { } + + /** Send a message to a channel. + * @param target The channel to message. + * @param status The status character (e.g. %) required to recieve. + * @param text The message to send. + */ + virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { } + + /** Send a notice to a channel. + * @param target The channel to message. + * @param status The status character (e.g. %) required to recieve. + * @param text The message to send. + */ + virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { } + + /** Send a message to a user. + * @param target The user to message. + * @param text The message to send. + */ + virtual void SendUserPrivmsg(User* target, const std::string &text) { } + + /** 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) { } + + /** 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) { } }; #endif