1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __PROTOCOL_H__
15 #define __PROTOCOL_H__
22 typedef std::deque<std::string> parameterlist;
27 std::string servername;
28 std::string parentname;
30 unsigned int usercount;
31 unsigned int opercount;
32 unsigned int latencyms;
35 typedef std::list<ProtoServer> ProtoServerList;
37 class ProtocolInterface : public Extensible
40 InspIRCd* ServerInstance;
42 ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
43 virtual ~ProtocolInterface() { }
45 /** Send an ENCAP message to one or more linked servers.
46 * See the protocol documentation for the purpose of ENCAP.
47 * @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
48 * The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
49 * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
51 virtual void SendEncapsulatedData(parameterlist &encap) { }
53 /** Send metadata for an object to other linked servers.
54 * @param target The object to send metadata for.
55 * @param type The type of metadata to send (TYPE_USER, TYPE_CHANNEL, etc)
56 * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user
57 * @param data The string representation of the data
59 virtual void SendMetaData(void* target, TargetTypeFlags type, const std::string &key, const std::string &data) { }
61 /** Send a topic change for a channel
62 * @param channel The channel to change the topic for.
63 * @param topic The new topic to use for the channel.
65 virtual void SendTopic(Channel* channel, std::string &topic) { }
67 /** Send mode changes for an object.
68 * @param target The channel name or user to send mode changes for.
69 * @param The mode changes to send.
71 virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::deque<TranslateType> &translate) { }
73 /** Convenience function, string wrapper around the above.
75 virtual void SendModeStr(const std::string &target, const std::string &modeline)
77 irc::spacesepstream x(modeline);
79 std::deque<TranslateType> types;
84 types.push_back(TR_TEXT);
86 SendMode(target, n, types);
89 /** Send a notice to users with a given mode(s).
90 * @param modes The modes required for the message to be sent.
91 * @param text The message to send.
93 virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
95 /** Send a notice to users with a given snomask.
96 * @param snomask The snomask required for the message to be sent.
97 * @param text The message to send.
99 virtual void SendSNONotice(const std::string &snomask, const std::string &text) { }
101 /** Send raw data to a remote client.
102 * @param target The user to push data to.
103 * @param rawline The raw IRC protocol line to deliver (":me NOTICE you :foo", whatever).
105 virtual void PushToClient(User* target, const std::string &rawline) { }
107 /** Send a message to a channel.
108 * @param target The channel to message.
109 * @param status The status character (e.g. %) required to recieve.
110 * @param text The message to send.
112 virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { }
114 /** Send a notice to a channel.
115 * @param target The channel to message.
116 * @param status The status character (e.g. %) required to recieve.
117 * @param text The message to send.
119 virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { }
121 /** Send a message to a user.
122 * @param target The user to message.
123 * @param text The message to send.
125 virtual void SendUserPrivmsg(User* target, const std::string &text) { }
127 /** Send a notice to a user.
128 * @param target The user to message.
129 * @param text The message to send.
131 virtual void SendUserNotice(User* target, const std::string &text) { }
133 /** Fill a list of servers and information about them.
134 * @param sl The list of servers to fill.
135 * XXX: document me properly, this is shit.
137 virtual void GetServerList(ProtoServerList &sl) { }
139 /** Send information about a user connection to linked servers.
140 * @param u The user to send information about.
142 virtual void Introduce(User* u) { }