1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* +------------------------------------+
* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
* InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
#ifndef __PROTOCOL_H__
#define __PROTOCOL_H__
#include "hashcomp.h"
class InspIRCd;
class User;
typedef std::deque<std::string> parameterlist;
class ProtoServer
{
public:
std::string servername;
std::string parentname;
std::string gecos;
unsigned int usercount;
unsigned int opercount;
unsigned int latencyms;
};
typedef std::list<ProtoServer> ProtoServerList;
class ProtocolInterface : public Extensible
{
protected:
InspIRCd* ServerInstance;
public:
ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
virtual ~ProtocolInterface() { }
/** 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.
*/
virtual void SendEncapsulatedData(parameterlist &encap) { }
/** Send metadata for an object to other linked servers.
* @param target The object to send metadata for.
* @param type The type of metadata to send (TYPE_USER, TYPE_CHANNEL, etc)
* @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(void* target, TargetTypeFlags type, 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 target The channel name or user to send mode changes for.
* @param The mode changes to send.
*/
virtual void SendMode(const std::string &target, parameterlist &modedata) { }
/** 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::string v;
while (x.GetToken(v))
n.push_back(v);
SendMode(target, n);
}
/** 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.
*/
virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
/** 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) { }
/** Send information about a user connection to linked servers.
* @param u The user to send information about.
*/
virtual void Introduce(User* u) { }
};
#endif
|
