irc_client.hpp 12.1 KB
Newer Older
1 2 3
#ifndef IRC_CLIENT_INCLUDED
# define IRC_CLIENT_INCLUDED

4
#include <irc/irc_message.hpp>
5 6
#include <irc/irc_channel.hpp>
#include <irc/iid.hpp>
louiz’'s avatar
louiz’ committed
7

8 9
#include <network/socket_handler.hpp>

10
#include <unordered_map>
louiz’'s avatar
louiz’ committed
11
#include <vector>
12
#include <string>
louiz’'s avatar
louiz’ committed
13
#include <map>
14

15 16
class Bridge;

17 18 19 20 21 22 23 24 25
/**
 * Represent one IRC client, i.e. an endpoint connected to a single IRC
 * server, through a TCP socket, receiving and sending commands to it.
 *
 * TODO: TLS support, maybe, but that's not high priority
 */
class IrcClient: public SocketHandler
{
public:
26
  explicit IrcClient(const std::string& hostname, const std::string& username, Bridge* bridge);
27
  ~IrcClient();
28 29 30 31
  /**
   * Connect to the IRC server
   */
  void start();
32 33 34 35
  /**
   * Called when the connection to the server cannot be established
   */
  void on_connection_failed(const std::string& reason) override final;
louiz’'s avatar
louiz’ committed
36 37 38
  /**
   * Called when successfully connected to the server
   */
louiz’'s avatar
louiz’ committed
39
  void on_connected() override final;
40 41 42
  /**
   * Close the connection, remove us from the poller
   */
louiz’'s avatar
louiz’ committed
43
  void on_connection_close() override final;
44 45 46 47
  /**
   * Parse the data we have received so far and try to get one or more
   * complete messages from it.
   */
48
  void parse_in_buffer(const size_t) override final;
49 50 51 52
  /**
   * Return the channel with this name, create it if it does not yet exist
   */
  IrcChannel* get_channel(const std::string& name);
louiz’'s avatar
louiz’ committed
53 54 55 56
  /**
   * Returns true if the channel is joined
   */
  bool is_channel_joined(const std::string& name);
louiz’'s avatar
louiz’ committed
57 58 59 60
  /**
   * Return our own nick
   */
  std::string get_own_nick() const;
louiz’'s avatar
louiz’ committed
61 62 63 64 65 66
  /**
   * Serialize the given message into a line, and send that into the socket
   * (actually, into our out_buf and signal the poller that we want to wach
   * for send events to be ready)
   */
  void send_message(IrcMessage&& message);
67 68 69
  /**
   * Send the PONG irc command
   */
louiz’'s avatar
louiz’ committed
70
  void send_pong_command(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
71 72 73 74 75 76 77 78 79
  /**
   * Send the USER irc command
   */
  void send_user_command(const std::string& username, const std::string& realname);
  /**
   * Send the NICK irc command
   */
  void send_nick_command(const std::string& username);
  /**
louiz’'s avatar
louiz’ committed
80
   * Send the JOIN irc command.
louiz’'s avatar
louiz’ committed
81 82
   */
  void send_join_command(const std::string& chan_name);
louiz’'s avatar
louiz’ committed
83 84 85 86 87
  /**
   * Send a PRIVMSG command for a channel
   * Return true if the message was actually sent
   */
  bool send_channel_message(const std::string& chan_name, const std::string& body);
louiz’'s avatar
louiz’ committed
88 89 90
  /**
   * Send a PRIVMSG command for an user
   */
louiz’'s avatar
louiz’ committed
91
  void send_private_message(const std::string& username, const std::string& body, const std::string& type);
louiz’'s avatar
louiz’ committed
92 93 94 95
  /**
   * Send the PART irc command
   */
  void send_part_command(const std::string& chan_name, const std::string& status_message);
louiz’'s avatar
louiz’ committed
96 97 98 99
  /**
   * Send the MODE irc command
   */
  void send_mode_command(const std::string& chan_name, const std::vector<std::string>& arguments);
100 101 102 103
  /**
   * Send the KICK irc command
   */
  void send_kick_command(const std::string& chan_name, const std::string& target, const std::string& reason);
104
  void send_topic_command(const std::string& chan_name, const std::string& topic);
louiz’'s avatar
louiz’ committed
105 106 107
  /**
   * Send the QUIT irc command
   */
108
  void send_quit_command(const std::string& reason);
109 110 111 112 113 114
  /**
   * Send a message to the gateway user, not generated by the IRC server,
   * but that might be useful because we want to be verbose (for example we
   * might want to notify the user about the connexion state)
   */
  void send_gateway_message(const std::string& message, const std::string& from="");
115 116 117 118
  /**
   * Forward the server message received from IRC to the XMPP component
   */
  void forward_server_message(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
119 120 121 122 123
  /**
   * When receiving the isupport informations.  See
   * http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
   */
  void on_isupport_message(const IrcMessage& message);
124 125 126 127 128 129 130 131 132 133 134 135
  /**
   * Just empty the motd we kept as a string
   */
  void empty_motd(const IrcMessage& message);
  /**
   * Send the MOTD string as one single "big" message
   */
  void send_motd(const IrcMessage& message);
  /**
   * Append this line to the MOTD
   */
  void on_motd_line(const IrcMessage& message);
136 137 138 139 140 141 142 143 144
  /**
   * Forward the join of an other user into an IRC channel, and save the
   * IrcUsers in the IrcChannel
   */
  void set_and_forward_user_list(const IrcMessage& message);
  /**
   * Remember our nick and host, when we are joined to the channel. The list
   * of user comes after so we do not send the self-presence over XMPP yet.
   */
louiz’'s avatar
louiz’ committed
145
  void on_channel_join(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
146 147 148 149
  /**
   * When a channel message is received
   */
  void on_channel_message(const IrcMessage& message);
150 151 152 153
  /**
   * A notice is received
   */
  void on_notice(const IrcMessage& message);
154 155 156 157 158 159 160 161 162
  /**
   * Save the topic in the IrcChannel
   */
  void on_topic_received(const IrcMessage& message);
  /**
   * The channel has been completely joined (self presence, topic, all names
   * received etc), send the self presence and topic to the XMPP user.
   */
  void on_channel_completely_joined(const IrcMessage& message);
163 164 165 166
  /**
   * We tried to set an invalid nickname
   */
  void on_erroneous_nickname(const IrcMessage& message);
167 168 169 170 171
  /**
   * When the IRC servers denies our nickname because of a conflict.  Send a
   * presence conflict from all channels, because the name is server-wide.
   */
  void on_nickname_conflict(const IrcMessage& message);
172 173 174 175
  /**
   * Handles most errors from the server by just forwarding the message to the user.
   */
  void on_generic_error(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
176 177 178 179
  /**
   * When a message 001 is received, join the rooms we wanted to join, and set our actual nickname
   */
  void on_welcome_message(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
180
  void on_part(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
181
  void on_error(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
182
  void on_nick(const IrcMessage& message);
183
  void on_kick(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
184
  void on_mode(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
185
  /**
louiz’'s avatar
louiz’ committed
186 187 188
   * A mode towards our own user is received (note, that is different from a
   * channel mode towards or own nick, see
   * http://tools.ietf.org/html/rfc2812#section-3.1.5 VS #section-3.2.3)
louiz’'s avatar
louiz’ committed
189
   */
louiz’'s avatar
louiz’ committed
190
  void on_user_mode(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
191
  /**
louiz’'s avatar
louiz’ committed
192 193
   * A mode towards a channel. Note that this can change the mode of the
   * channel itself or an IrcUser in it.
louiz’'s avatar
louiz’ committed
194
   */
louiz’'s avatar
louiz’ committed
195
  void on_channel_mode(const IrcMessage& message);
louiz’'s avatar
louiz’ committed
196
  void on_quit(const IrcMessage& message);
197 198 199 200
  /**
   * Return the number of joined channels
   */
  size_t number_of_joined_channels() const;
louiz’'s avatar
louiz’ committed
201 202 203 204
  /**
   * Get a reference to the unique dummy channel
   */
  DummyIrcChannel& get_dummy_channel();
louiz’'s avatar
louiz’ committed
205 206 207 208 209
  /**
   * Leave the dummy channel: forward a message to the user to indicate that
   * he left it, and mark it as not joined.
   */
  void leave_dummy_channel(const std::string& exit_message);
louiz’'s avatar
louiz’ committed
210 211 212 213

  const std::string& get_hostname() const { return this->hostname; }
  std::string get_nick() const { return this->current_nick; }
  bool is_welcomed() const { return this->welcomed; }
214 215

private:
216 217 218 219 220 221 222 223
  /**
   * The hostname of the server we are connected to.
   */
  const std::string hostname;
  /**
   * The user name used in the USER irc command
   */
  const std::string username;
louiz’'s avatar
louiz’ committed
224 225 226 227
  /**
   * Our current nickname on the server
   */
  std::string current_nick;
228 229 230 231 232 233 234 235
  /**
   * Raw pointer because the bridge owns us.
   */
  Bridge* bridge;
  /**
   * The list of joined channels, indexed by name
   */
  std::unordered_map<std::string, std::unique_ptr<IrcChannel>> channels;
louiz’'s avatar
louiz’ committed
236 237 238 239 240
  /**
   * A single channel with a iid of the form "hostname" (normal channel have
   * an iid of the form "chan%hostname".
   */
  DummyIrcChannel dummy_channel;
louiz’'s avatar
louiz’ committed
241 242 243 244 245 246 247
  /**
   * A list of chan we want to join, but we need a response 001 from
   * the server before sending the actual JOIN commands. So we just keep the
   * channel names in a list, and send the JOIN commands for each of them
   * whenever the WELCOME message is received.
   */
  std::vector<std::string> channels_to_join;
louiz’'s avatar
louiz’ committed
248 249 250 251
  /**
   * This flag indicates that the server is completely joined (connection
   * has been established, we are authentified and we have a nick)
   */
louiz’'s avatar
louiz’ committed
252
  bool welcomed;
louiz’'s avatar
louiz’ committed
253 254 255 256 257 258
  /**
   * See http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt section 3.3
   * We store the possible chanmodes in this object.
   * chanmodes[0] contains modes of type A, [1] of type B etc
   */
  std::vector<std::string> chanmodes;
259 260 261 262 263
  /**
   * Each motd line received is appended to this string, which we send when
   * the motd is completely received
   */
  std::string motd;
louiz’'s avatar
louiz’ committed
264 265 266
  /**
   * See http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt section 3.14
   * The example given would be transformed into
267
   * modes_to_prefix = {{'&', 'a'}, {'*', 'b'}}
louiz’'s avatar
louiz’ committed
268 269
   */
  std::map<char, char> prefix_to_mode;
270 271 272 273 274
  /**
   * Available user modes, sorted from most significant to least significant
   * (for example 'ahov' is a common order).
   */
  std::vector<char> sorted_user_modes;
louiz’'s avatar
louiz’ committed
275

276 277 278 279 280 281
  IrcClient(const IrcClient&) = delete;
  IrcClient(IrcClient&&) = delete;
  IrcClient& operator=(const IrcClient&) = delete;
  IrcClient& operator=(IrcClient&&) = delete;
};

282 283 284 285 286 287 288
/**
 * Define a map of functions to be called for each IRC command we can
 * handle.
 */
typedef void (IrcClient::*irc_callback_t)(const IrcMessage&);

static const std::unordered_map<std::string, irc_callback_t> irc_callbacks = {
289
  {"NOTICE", &IrcClient::on_notice},
290 291
  {"002", &IrcClient::forward_server_message},
  {"003", &IrcClient::forward_server_message},
louiz’'s avatar
louiz’ committed
292
  {"005", &IrcClient::on_isupport_message},
293 294 295 296 297 298
  {"RPL_MOTDSTART", &IrcClient::empty_motd},
  {"375", &IrcClient::empty_motd},
  {"RPL_MOTD", &IrcClient::on_motd_line},
  {"372", &IrcClient::on_motd_line},
  {"RPL_MOTDEND", &IrcClient::send_motd},
  {"376", &IrcClient::send_motd},
299 300 301 302
  {"JOIN", &IrcClient::on_channel_join},
  {"PRIVMSG", &IrcClient::on_channel_message},
  {"353", &IrcClient::set_and_forward_user_list},
  {"332", &IrcClient::on_topic_received},
louiz’'s avatar
louiz’ committed
303
  {"TOPIC", &IrcClient::on_topic_received},
304
  {"366", &IrcClient::on_channel_completely_joined},
305
  {"432", &IrcClient::on_erroneous_nickname},
306
  {"433", &IrcClient::on_nickname_conflict},
307 308
  {"001", &IrcClient::on_welcome_message},
  {"PART", &IrcClient::on_part},
louiz’'s avatar
louiz’ committed
309
  {"ERROR", &IrcClient::on_error},
310 311 312 313
  {"QUIT", &IrcClient::on_quit},
  {"NICK", &IrcClient::on_nick},
  {"MODE", &IrcClient::on_mode},
  {"PING", &IrcClient::send_pong_command},
314
  {"KICK", &IrcClient::on_kick},
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

  {"401", &IrcClient::on_generic_error},
  {"402", &IrcClient::on_generic_error},
  {"403", &IrcClient::on_generic_error},
  {"404", &IrcClient::on_generic_error},
  {"405", &IrcClient::on_generic_error},
  {"406", &IrcClient::on_generic_error},
  {"407", &IrcClient::on_generic_error},
  {"408", &IrcClient::on_generic_error},
  {"409", &IrcClient::on_generic_error},
  {"410", &IrcClient::on_generic_error},
  {"411", &IrcClient::on_generic_error},
  {"412", &IrcClient::on_generic_error},
  {"414", &IrcClient::on_generic_error},
  {"421", &IrcClient::on_generic_error},
  {"422", &IrcClient::on_generic_error},
  {"423", &IrcClient::on_generic_error},
  {"424", &IrcClient::on_generic_error},
  {"431", &IrcClient::on_generic_error},
  {"436", &IrcClient::on_generic_error},
  {"441", &IrcClient::on_generic_error},
  {"442", &IrcClient::on_generic_error},
  {"443", &IrcClient::on_generic_error},
  {"444", &IrcClient::on_generic_error},
  {"446", &IrcClient::on_generic_error},
  {"451", &IrcClient::on_generic_error},
  {"461", &IrcClient::on_generic_error},
  {"462", &IrcClient::on_generic_error},
  {"463", &IrcClient::on_generic_error},
  {"464", &IrcClient::on_generic_error},
  {"465", &IrcClient::on_generic_error},
  {"467", &IrcClient::on_generic_error},
  {"470", &IrcClient::on_generic_error},
  {"471", &IrcClient::on_generic_error},
  {"472", &IrcClient::on_generic_error},
  {"473", &IrcClient::on_generic_error},
  {"474", &IrcClient::on_generic_error},
  {"475", &IrcClient::on_generic_error},
  {"476", &IrcClient::on_generic_error},
  {"477", &IrcClient::on_generic_error},
  {"481", &IrcClient::on_generic_error},
  {"482", &IrcClient::on_generic_error},
  {"483", &IrcClient::on_generic_error},
  {"484", &IrcClient::on_generic_error},
  {"485", &IrcClient::on_generic_error},
  {"487", &IrcClient::on_generic_error},
  {"491", &IrcClient::on_generic_error},
  {"501", &IrcClient::on_generic_error},
  {"502", &IrcClient::on_generic_error},
364 365
};

366
#endif // IRC_CLIENT_INCLUDED