bridge.hpp 13.4 KB
Newer Older
1 2
#pragma once

3 4
#include <bridge/result_set_management.hpp>
#include <bridge/list_element.hpp>
5

6
#include <irc/irc_message.hpp>
7
#include <irc/irc_client.hpp>
8
#include <bridge/colors.hpp>
9
#include <irc/irc_user.hpp>
10 11 12
#include <irc/iid.hpp>

#include <unordered_map>
13
#include <functional>
14
#include <exception>
15 16 17
#include <string>
#include <memory>

18 19
#include <biboumi.h>

20
class BiboumiComponent;
21
class Poller;
22
struct ResultSetInfo;
23

24 25
/**
 * A callback called for each IrcMessage we receive. If the message triggers
26 27
 * a response, it must send ore or more iq and return true (in that case it
 * is removed from the list), otherwise it must do nothing and just return
28 29
 * false.
 */
30
using irc_responder_callback_t = std::function<bool(const std::string& irc_hostname, const IrcMessage& message)>;
31

32 33 34 35 36 37 38 39 40
/**
 * One bridge is spawned for each XMPP user that uses the component.  The
 * bridge spawns IrcClients when needed (when the user wants to join a
 * channel on a new server) and does the translation between the two
 * protocols.
 */
class Bridge
{
public:
41
  explicit Bridge(const std::string& user_jid, BiboumiComponent& xmpp, std::shared_ptr<Poller> poller);
louiz’'s avatar
louiz’ committed
42 43 44 45 46 47
  ~Bridge() = default;

  Bridge(const Bridge&) = delete;
  Bridge(Bridge&& other) = delete;
  Bridge& operator=(const Bridge&) = delete;
  Bridge& operator=(Bridge&&) = delete;
louiz’'s avatar
louiz’ committed
48 49 50
  /**
   * QUIT all connected IRC servers.
   */
51
  void shutdown(const std::string& exit_message);
52 53 54 55
  /**
   * PART the given resource from all the channels
   */
  void remove_resource(const std::string& resource, const std::string& part_message);
louiz’'s avatar
louiz’ committed
56 57 58 59
  /**
   * Remove all inactive IrcClients
   */
  void clean();
60 61 62 63
  /**
   * Return the jid of the XMPP user using this bridge
   */
  const std::string& get_jid() const;
louiz’'s avatar
louiz’ committed
64
  std::string get_bare_jid() const;
65

Link Mauve's avatar
Link Mauve committed
66
  static Xmpp::body make_xmpp_body(const std::string& str, const std::string& encoding = "ISO-8859-1");
67 68 69 70 71 72
  /***
   **
   ** From XMPP to IRC.
   **
   **/

louiz’'s avatar
louiz’ committed
73 74 75 76
  /**
   * Try to join an irc_channel, does nothing and return true if the channel
   * was already joined.
   */
77
  bool join_irc_channel(const Iid& iid, const std::string& nickname, const std::string& password, const std::string& resource);
78

louiz’'s avatar
louiz’ committed
79
  void send_channel_message(const Iid& iid, const std::string& body);
louiz’'s avatar
louiz’ committed
80
  void send_private_message(const Iid& iid, const std::string& body, const std::string& type="PRIVMSG");
louiz’'s avatar
louiz’ committed
81
  void send_raw_message(const std::string& hostname, const std::string& body);
82
  void leave_irc_channel(Iid&& iid, const std::string& status_message, const std::string& resource);
louiz’'s avatar
louiz’ committed
83
  void send_irc_nick_change(const Iid& iid, const std::string& new_nick);
84 85
  void send_irc_kick(const Iid& iid, const std::string& target, const std::string& reason,
                     const std::string& iq_id, const std::string& to_jid);
86
  void set_channel_topic(const Iid& iid, const std::string& subject);
87 88
  void send_xmpp_version_to_irc(const Iid& iid, const std::string& name, const std::string& version,
                                const std::string& os);
89
  void send_irc_ping_result(const Iid& iid, const std::string& id);
90 91 92
  void send_irc_version_request(const std::string& irc_hostname, const std::string& target,
                                const std::string& iq_id, const std::string& to_jid,
                                const std::string& from_jid);
93 94 95 96 97 98 99 100 101 102 103 104 105
  void send_irc_channel_list_request(const Iid& iid, const std::string& iq_id, const std::string& to_jid,
                                     ResultSetInfo rs_info);
  /**
   * Check if the channel list contains what is needed to answer the RSM request,
   * if it does, send the iq result. If the list is complete but does not contain
   * everything, send the result anyway (because there are no more available
   * channels that could complete the list).
   *
   * Returns true if we sent the answer.
   */
  bool send_matching_channel_list(const ChannelList& channel_list,
                                  const ResultSetInfo& rs_info, const std::string& id, const std::string& to_jid,
                                  const std::string& from);
106 107
  void forward_affiliation_role_change(const Iid& iid, const std::string& nick,
                                       const std::string& affiliation, const std::string& role);
108 109 110 111 112 113
  /**
   * Directly send a CTCP PING request to the IRC user
   */
  void send_irc_user_ping_request(const std::string& irc_hostname, const std::string& nick,
                                  const std::string& iq_id, const std::string& to_jid,
                                  const std::string& from_jid);
114 115 116 117 118 119 120
  /**
   * First check if the participant is in the room, before sending a direct
   * CTCP PING request to the IRC user
   */
  void send_irc_participant_ping_request(const Iid& iid, const std::string& nick,
                                         const std::string& iq_id, const std::string& to_jid,
                                         const std::string& from_jid);
121 122 123 124 125 126
  /**
   * Directly send back a result if it's a gateway ping or if we are
   * connected to the given IRC server, an error otherwise.
   */
  void on_gateway_ping(const std::string& irc_hostname, const std::string& iq_id, const std::string& to_jid,
                       const std::string& from_jid);
127

128
  void send_irc_invitation(const Iid& iid, const std::string& to);
129

130 131 132 133 134 135 136 137
  /***
   **
   ** From IRC to XMPP.
   **
   **/

  /**
   * Send a message corresponding to a server NOTICE, the from attribute
138
   * should be juste the server hostname.
139 140 141 142 143
   */
  void send_xmpp_message(const std::string& from, const std::string& author, const std::string& msg);
  /**
   * Send the presence of a new user in the MUC.
   */
144 145 146 147 148
  void send_user_join(const std::string& hostname, const std::string& chan_name,
                      const IrcUser* user, const char user_mode,
                      const bool self, const std::string& resource);
  void send_user_join(const std::string& hostname, const std::string& chan_name,
                      const IrcUser* user, const char user_mode,
149
                      const bool self);
150

151 152 153
  /**
   * Send the topic of the MUC to the user
   */
154
  void send_topic(const std::string& hostname, const std::string& chan_name, const std::string& topic, const std::string& who);
155
  void send_topic(const std::string& hostname, const std::string& chan_name, const std::string& topic, const std::string& who, const std::string& resource);
156 157 158 159 160
  /**
   * Send the MUC history to the user
   */
  void send_room_history(const std::string& hostname, const std::string& chan_name);
  void send_room_history(const std::string& hostname, const std::string& chan_name, const std::string& resource);
louiz’'s avatar
louiz’ committed
161 162 163
  /**
   * Send a MUC message from some participant
   */
louiz’'s avatar
louiz’ committed
164
  void send_message(const Iid& iid, const std::string& nick, const std::string& body, const bool muc);
165
  /**
166
   * Send a presence of type error, from a room.
167
   */
168
  void send_presence_error(const Iid& iid, const std::string& nick, const std::string& type, const std::string& condition, const std::string& error_code, const std::string& text);
louiz’'s avatar
louiz’ committed
169 170 171
  /**
   * Send an unavailable presence from this participant
   */
172
  void send_muc_leave(Iid&& iid, std::string&& nick, const std::string& message, const bool self, const std::string& resource="");
louiz’'s avatar
louiz’ committed
173 174
  /**
   * Send presences to indicate that an user old_nick (ourself if self ==
175 176 177
   * true) changed his nick to new_nick.  The user_mode is needed because
   * the xmpp presence needs ton contain the role and affiliation of the
   * user.
louiz’'s avatar
louiz’ committed
178
   */
179 180 181 182 183
  void send_nick_change(Iid&& iid,
                        const std::string& old_nick,
                        const std::string& new_nick,
                        const char user_mode,
                        const bool self);
184
  void kick_muc_user(Iid&& iid, const std::string& target, const std::string& reason, const std::string& author);
185
  void send_nickname_conflict_error(const Iid& iid, const std::string& nickname);
186 187 188 189
  /**
   * Send a role/affiliation change, matching the change of mode for that user
   */
  void send_affiliation_role_change(const Iid& iid, const std::string& target, const char mode);
190
  /**
louiz’'s avatar
louiz’ committed
191
   * Send an iq version request coming from nick!hostname@
192 193
   */
  void send_iq_version_request(const std::string& nick, const std::string& hostname);
194 195 196 197 198
  /**
   * Send an iq ping request coming from nick!hostname@
   */
  void send_xmpp_ping_request(const std::string& nick, const std::string& hostname,
                              const std::string& id);
louiz’'s avatar
louiz’ committed
199 200
  void send_xmpp_invitation(const Iid& iid, const std::string& author);

louiz’'s avatar
louiz’ committed
201 202 203 204
  /**
   * Misc
   */
  std::string get_own_nick(const Iid& iid);
louiz’'s avatar
louiz’ committed
205
  /**
206
   * Get the number of server to which this bridge is connected or connecting.
louiz’'s avatar
louiz’ committed
207
   */
208
  size_t active_clients() const;
209 210 211 212 213 214 215 216
  /**
   * Add (or replace the existing) <nick, jid> into the preferred_user_from map
   */
  void set_preferred_from_jid(const std::string& nick, const std::string& full_jid);
  /**
   * Remove the preferred jid for the given IRC nick
   */
  void remove_preferred_from_jid(const std::string& nick);
217 218 219 220 221
  /**
   * Given a channel_name, remove all preferred from_jid that come
   * from this chan.
   */
  void remove_all_preferred_from_jid_of_room(const std::string& channel_name);
222
  /**
223
   * Add a callback to the waiting list of irc callbacks.
224
   */
225
  void add_waiting_irc(irc_responder_callback_t&& callback);
226 227 228 229 230
  /**
   * Iter over all the waiting_iq, call the iq_responder_filter_t for each,
   * whenever one of them returns true: call the corresponding
   * iq_responder_callback_t and remove the callback from the list.
   */
231
  void trigger_on_irc_message(const std::string& irc_hostname, const IrcMessage& message);
232
  std::unordered_map<std::string, std::shared_ptr<IrcClient>>& get_irc_clients();
233
  std::set<char> get_chantypes(const std::string& hostname) const;
234 235 236
#ifdef USE_DATABASE
  void set_record_history(const bool val);
#endif
louiz’'s avatar
louiz’ committed
237

238 239 240 241 242 243
private:
  /**
   * Returns the client for the given hostname, create one (and use the
   * username in this case) if none is found, and connect that newly-created
   * client immediately.
   */
244
  IrcClient* make_irc_client(const std::string& hostname, const std::string& nickname);
louiz’'s avatar
louiz’ committed
245
  /**
246 247
   * This version does not create the IrcClient if it does not exist, throws
   * a IRCServerNotConnected error in that case.
louiz’'s avatar
louiz’ committed
248 249
   */
  IrcClient* get_irc_client(const std::string& hostname);
250 251 252
  /**
   * Idem, but returns nullptr if the server does not exist.
   */
253
  IrcClient* find_irc_client(const std::string& hostname) const;
254
  /**
255
   * The bare JID of the user associated with this bridge. Messages from/to this
256 257
   * JID are only managed by this bridge.
   */
258
  const std::string user_jid;
259 260 261 262 263 264
  /**
   * One IrcClient for each IRC server we need to be connected to.
   * The pointer is shared by the bridge and the poller.
   */
  std::unordered_map<std::string, std::shared_ptr<IrcClient>> irc_clients;
  /**
265
   * To communicate back with the XMPP component
266
   */
267
  BiboumiComponent& xmpp;
268 269 270 271
  /**
   * Poller, to give it the IrcClients that we spawn, to make it manage
   * their sockets.
   */
272
  std::shared_ptr<Poller> poller;
273 274 275 276 277 278 279 280
  /**
   * A map of <nick, full_jid>. For example if this map contains <"toto",
   * "#somechan%server@biboumi/ToTo">, whenever a private message is
   * received from the user "toto", instead of forwarding it to XMPP with
   * from='toto!server@biboumi', we use instead
   * from='#somechan%server@biboumi/ToTo'
   */
  std::unordered_map<std::string, std::string> preferred_user_from;
281 282 283 284 285 286
  /**
   * A list of callbacks that are waiting for some IrcMessage to trigger a
   * response.  We add callbacks in this list whenever we received an IQ
   * request and we need a response from IRC to be able to provide the
   * response iq.
   */
louiz’'s avatar
louiz’ committed
287
  std::vector<irc_responder_callback_t> waiting_irc;
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
  /**
   * Resources to IRC channel/server mapping:
   */
  using Resource = std::string;
  using ChannelName = std::string;
  using IrcHostname = std::string;
  using ChannelKey = std::tuple<ChannelName, IrcHostname>;
  std::map<ChannelKey, std::set<Resource>> resources_in_chan;
  std::map<IrcHostname, std::set<Resource>> resources_in_server;
  /**
   * Manage which resource is in which channel
   */
  void add_resource_to_chan(const ChannelKey& channel_key, const std::string& resource);
  void remove_resource_from_chan(const ChannelKey& channel_key, const std::string& resource);
  bool is_resource_in_chan(const ChannelKey& channel_key, const std::string& resource) const;
303
  std::size_t number_of_resources_in_chan(const ChannelKey& channel_key) const;
304 305 306 307

  void add_resource_to_server(const IrcHostname& irc_hostname, const std::string& resource);
  void remove_resource_from_server(const IrcHostname& irc_hostname, const std::string& resource);
  bool is_resource_in_server(const IrcHostname& irc_hostname, const std::string& resource) const;
308
  size_t number_of_channels_the_resource_is_in(const std::string& irc_hostname, const std::string& resource) const;
309

310
  /**
311 312 313
   * Generate all the stanzas to be sent to this resource, simulating a join on this channel.
   * This means sending the whole user list, the topic, etc
   * TODO: send message history
314
   */
315
  void generate_channel_join_for_resource(const Iid& iid, const std::string& resource);
316 317 318 319 320 321 322
  /**
   * A cache of the channels list (as returned by the server on a LIST
   * request), to be re-used on a subsequent XMPP list request that
   * uses result-set-management.
   */
  std::map<IrcHostname, ChannelList> channel_list_cache;

323 324 325
#ifdef USE_DATABASE
  bool record_history { true };
#endif
326 327
};

328 329 330 331 332 333 334
struct IRCNotConnected: public std::exception
{
  IRCNotConnected(const std::string& hostname):
    hostname(hostname) {}
  const std::string hostname;
};

335