PageRenderTime 43ms CodeModel.GetById 13ms RepoModel.GetById 1ms app.codeStats 0ms

/src/plugins/irc/irc-server.h

#
C Header | 305 lines | 254 code | 21 blank | 30 comment | 0 complexity | a53d8ea468dcf34c740153f48261d167 MD5 | raw file
Possible License(s): GPL-3.0 
    

  1. /*
    2. 

  2.  * Copyright (C) 2003-2012 Sebastien Helleu <flashcode@flashtux.org>
    3. 

  3.  *
    4. 

  4.  * This file is part of WeeChat, the extensible chat client.
    5. 

  5.  *
    6. 

  6.  * WeeChat is free software; you can redistribute it and/or modify
    7. 

  7.  * it under the terms of the GNU General Public License as published by
    8. 

  8.  * the Free Software Foundation; either version 3 of the License, or
    9. 

  9.  * (at your option) any later version.
    10. 

  10.  *
    11. 

  11.  * WeeChat is distributed in the hope that it will be useful,
    12. 

  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    13. 

  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14. 

  14.  * GNU General Public License for more details.
    15. 

  15.  *
    16. 

  16.  * You should have received a copy of the GNU General Public License
    17. 

  17.  * along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
    18. 

  18.  */
    19. 

  19. 

  20. #ifndef __WEECHAT_IRC_SERVER_H
    21. 

  21. #define __WEECHAT_IRC_SERVER_H 1
    22. 

  22. 

  23. #include <sys/time.h>
    24. 

  24. #include <regex.h>
    25. 

  25. 

  26. #ifdef HAVE_GNUTLS
    27. 

  27. #include <gnutls/gnutls.h>
    28. 

  28. #endif
    29. 

  29. 

  30. #ifndef NI_MAXHOST
    31. 

  31. #define NI_MAXHOST 256
    32. 

  32. #endif
    33. 

  33. 

  34. enum t_irc_server_option
    35. 

  35. {
    36. 

  36.     IRC_SERVER_OPTION_ADDRESSES = 0, /* server addresses (IP/name with port) */
    37. 

  37.     IRC_SERVER_OPTION_PROXY,         /* proxy used for server (optional)     */
    38. 

  38.     IRC_SERVER_OPTION_IPV6,          /* use IPv6 protocol                    */
    39. 

  39.     IRC_SERVER_OPTION_SSL,           /* SSL protocol                         */
    40. 

  40.     IRC_SERVER_OPTION_SSL_CERT,      /* client ssl certificate file          */
    41. 

  41.     IRC_SERVER_OPTION_SSL_PRIORITIES, /* gnutls priorities                   */
    42. 

  42.     IRC_SERVER_OPTION_SSL_DHKEY_SIZE, /* Diffie Hellman key size             */
    43. 

  43.     IRC_SERVER_OPTION_SSL_VERIFY,    /* check if the connection is trusted   */
    44. 

  44.     IRC_SERVER_OPTION_PASSWORD,      /* password for server                  */
    45. 

  45.     IRC_SERVER_OPTION_CAPABILITIES,  /* client capabilities to enable        */
    46. 

  46.     IRC_SERVER_OPTION_SASL_MECHANISM,/* mechanism for SASL authentication    */
    47. 

  47.     IRC_SERVER_OPTION_SASL_USERNAME, /* username for SASL authentication     */
    48. 

  48.     IRC_SERVER_OPTION_SASL_PASSWORD, /* password for SASL authentication     */
    49. 

  49.     IRC_SERVER_OPTION_SASL_TIMEOUT,  /* timeout for SASL authentication      */
    50. 

  50.     IRC_SERVER_OPTION_AUTOCONNECT,   /* autoconnect to server at startup     */
    51. 

  51.     IRC_SERVER_OPTION_AUTORECONNECT, /* autoreconnect when disconnected      */
    52. 

  52.     IRC_SERVER_OPTION_AUTORECONNECT_DELAY, /* delay before trying again reco */
    53. 

  53.     IRC_SERVER_OPTION_NICKS,         /* nicknames (comma separated list)     */
    54. 

  54.     IRC_SERVER_OPTION_USERNAME,      /* user name                            */
    55. 

  55.     IRC_SERVER_OPTION_REALNAME,      /* real name                            */
    56. 

  56.     IRC_SERVER_OPTION_LOCAL_HOSTNAME,/* custom local hostname                */
    57. 

  57.     IRC_SERVER_OPTION_COMMAND,       /* command to run once connected        */
    58. 

  58.     IRC_SERVER_OPTION_COMMAND_DELAY, /* delay after execution of command     */
    59. 

  59.     IRC_SERVER_OPTION_AUTOJOIN,      /* channels to automatically join       */
    60. 

  60.     IRC_SERVER_OPTION_AUTOREJOIN,    /* auto rejoin channels when kicked     */
    61. 

  61.     IRC_SERVER_OPTION_AUTOREJOIN_DELAY,     /* delay before auto rejoin      */
    62. 

  62.     IRC_SERVER_OPTION_CONNECTION_TIMEOUT,   /* timeout for connection        */
    63. 

  63.     IRC_SERVER_OPTION_ANTI_FLOOD_PRIO_HIGH, /* anti-flood (high priority)    */
    64. 

  64.     IRC_SERVER_OPTION_ANTI_FLOOD_PRIO_LOW,  /* anti-flood (low priority)     */
    65. 

  65.     IRC_SERVER_OPTION_AWAY_CHECK,           /* delay between away checks     */
    66. 

  66.     IRC_SERVER_OPTION_AWAY_CHECK_MAX_NICKS, /* max nicks for away check      */
    67. 

  67.     IRC_SERVER_OPTION_DEFAULT_MSG_PART,     /* default part message          */
    68. 

  68.     IRC_SERVER_OPTION_DEFAULT_MSG_QUIT,     /* default quit message          */
    69. 

  69.     IRC_SERVER_OPTION_NOTIFY,               /* notify list                   */
    70. 

  70.     /* number of server options */
    71. 

  71.     IRC_SERVER_NUM_OPTIONS,
    72. 

  72. };
    73. 

  73. 

  74. #define IRC_SERVER_OPTION_BOOLEAN(__server, __index)                          \
    75. 

  75.     ((!weechat_config_option_is_null(__server->options[__index])) ?           \
    76. 

  76.      weechat_config_boolean(__server->options[__index]) :                     \
    77. 

  77.      ((!weechat_config_option_is_null(irc_config_server_default[__index])) ?  \
    78. 

  78.       weechat_config_boolean(irc_config_server_default[__index])              \
    79. 

  79.       : weechat_config_boolean_default(irc_config_server_default[__index])))
    80. 

  80. 

  81. #define IRC_SERVER_OPTION_INTEGER(__server, __index)                          \
    82. 

  82.     ((!weechat_config_option_is_null(__server->options[__index])) ?           \
    83. 

  83.      weechat_config_integer(__server->options[__index]) :                     \
    84. 

  84.      ((!weechat_config_option_is_null(irc_config_server_default[__index])) ?  \
    85. 

  85.       weechat_config_integer(irc_config_server_default[__index])              \
    86. 

  86.       : weechat_config_integer_default(irc_config_server_default[__index])))
    87. 

  87. 

  88. #define IRC_SERVER_OPTION_STRING(__server, __index)                           \
    89. 

  89.     ((!weechat_config_option_is_null(__server->options[__index])) ?           \
    90. 

  90.      weechat_config_string(__server->options[__index]) :                      \
    91. 

  91.      ((!weechat_config_option_is_null(irc_config_server_default[__index])) ?  \
    92. 

  92.       weechat_config_string(irc_config_server_default[__index])               \
    93. 

  93.       : weechat_config_string_default(irc_config_server_default[__index])))
    94. 

  94. 

  95. #define IRC_SERVER_DEFAULT_PORT  6667
    96. 

  96. #define IRC_SERVER_DEFAULT_NICKS "weechat1,weechat2,weechat3,weechat4,weechat5"
    97. 

  97. 

  98. /* number of queues for sending messages */
    99. 

  99. #define IRC_SERVER_NUM_OUTQUEUES_PRIO 2
    100. 

  100. 

  101. /* flags for irc_server_sendf() */
    102. 

  102. #define IRC_SERVER_SEND_OUTQ_PRIO_HIGH   1
    103. 

  103. #define IRC_SERVER_SEND_OUTQ_PRIO_LOW    2
    104. 

  104. #define IRC_SERVER_SEND_RETURN_HASHTABLE 4
    105. 

  105. 

  106. /* casemapping (string comparisons for nicks/channels) */
    107. 

  107. enum t_irc_server_casemapping
    108. 

  108. {
    109. 

  109.     IRC_SERVER_CASEMAPPING_RFC1459 = 0,    /* A-Z [ \ ] ^ ==> a-z { | } ~    */
    110. 

  110.     IRC_SERVER_CASEMAPPING_STRICT_RFC1459, /* A-Z [ \ ]   ==> a-z { | }      */
    111. 

  111.     IRC_SERVER_CASEMAPPING_ASCII,          /* A-Z         ==> a-z            */
    112. 

  112.     /* number of casemapping */
    113. 

  113.     IRC_SERVER_NUM_CASEMAPPING,
    114. 

  114. };
    115. 

  115. 

  116. /* output queue of messages to server (for sending slowly to server) */
    117. 

  117. 

  118. struct t_irc_outqueue
    119. 

  119. {
    120. 

  120.     char *command;                        /* IRC command                     */
    121. 

  121.     char *message_before_mod;             /* msg before any modifier         */
    122. 

  122.     char *message_after_mod;              /* msg after modifier(s)           */
    123. 

  123.     int modified;                         /* msg was modified by modifier(s) */
    124. 

  124.     char *tags;                           /* tags (used by Relay plugin)     */
    125. 

  125.     struct t_irc_redirect *redirect;      /* command redirection             */
    126. 

  126.     struct t_irc_outqueue *next_outqueue; /* link to next msg in queue       */
    127. 

  127.     struct t_irc_outqueue *prev_outqueue; /* link to prev msg in queue       */
    128. 

  128. };
    129. 

  129. 

  130. struct t_irc_server
    131. 

  131. {
    132. 

  132.     /* user choices */
    133. 

  133.     char *name;                             /* internal name of server       */
    134. 

  134.     struct t_config_option *options[IRC_SERVER_NUM_OPTIONS];
    135. 

  135. 

  136.     /* internal vars */
    137. 

  137.     int temp_server;                /* temporary server (not saved)          */
    138. 

  138.     int reloading_from_config;      /* 1 if reloading from config file       */
    139. 

  139.     int reloaded_from_config;       /* 1 if reloaded from config file        */
    140. 

  140.     int addresses_count;            /* number of addresses                   */
    141. 

  141.     char **addresses_array;         /* addresses (after split)               */
    142. 

  142.     int *ports_array;               /* ports for addresses                   */
    143. 

  143.     int index_current_address;      /* current address index in array        */
    144. 

  144.     char *current_address;          /* current address                       */
    145. 

  145.     char *current_ip;               /* current IP address                    */
    146. 

  146.     int current_port;               /* current port                          */
    147. 

  147.     int sock;                       /* socket for server (IPv4 or IPv6)      */
    148. 

  148.     struct t_hook *hook_connect;    /* connection hook                       */
    149. 

  149.     struct t_hook *hook_fd;         /* hook for server socket                */
    150. 

  150.     struct t_hook *hook_timer_connection; /* timer for connection            */
    151. 

  151.     struct t_hook *hook_timer_sasl; /* timer for SASL authentication         */
    152. 

  152.     int is_connected;               /* 1 if WeeChat is connected to server   */
    153. 

  153.     int ssl_connected;              /* = 1 if connected with SSL             */
    154. 

  154. #ifdef HAVE_GNUTLS
    155. 

  155.     gnutls_session_t gnutls_sess;   /* gnutls session (only if SSL is used)  */
    156. 

  156.     gnutls_x509_crt_t tls_cert;     /* certificate used if ssl_cert is set   */
    157. 

  157.     gnutls_x509_privkey_t tls_cert_key; /* key used if ssl_cert is set       */
    158. 

  158. #endif
    159. 

  159.     char *unterminated_message;     /* beginning of a message in input buf   */
    160. 

  160.     int nicks_count;                /* number of nicknames                   */
    161. 

  161.     char **nicks_array;             /* nicknames (after split)               */
    162. 

  162.     int nick_first_tried;           /* first nick tried in list of nicks     */
    163. 

  163.                                     /* when (re-)connecting to server        */
    164. 

  164.     char *nick;                     /* current nickname                      */
    165. 

  165.     char *nick_modes;               /* nick modes                            */
    166. 

  166.     char *isupport;                 /* copy of message 005 (ISUPPORT)        */
    167. 

  167.     char *prefix_modes;             /* prefix modes from msg 005 (eg "ohv")  */
    168. 

  168.     char *prefix_chars;             /* prefix chars from msg 005 (eg "@%+")  */
    169. 

  169.     int nick_max_length;            /* max lenth of nick (from msg 005)      */
    170. 

  170.     int casemapping;                /* casemapping from msg 005              */
    171. 

  171.     char *chantypes;                /* chantypes from msg 005 (eg "&#")      */
    172. 

  172.     int reconnect_delay;            /* current reconnect delay (growing)     */
    173. 

  173.     time_t reconnect_start;         /* this time + delay = reconnect time    */
    174. 

  174.     time_t command_time;            /* this time + command_delay = time to   */
    175. 

  175.                                     /* autojoin channels                     */
    176. 

  176.     int reconnect_join;             /* 1 if channels opened to rejoin        */
    177. 

  177.     int disable_autojoin;           /* 1 if user asked to not autojoin chans */
    178. 

  178.     int is_away;                    /* 1 is user is marked as away           */
    179. 

  179.     char *away_message;             /* away message, NULL if not away        */
    180. 

  180.     time_t away_time;               /* time() when user marking as away      */
    181. 

  181.     int lag;                        /* lag (in milliseconds)                 */
    182. 

  182.     struct timeval lag_check_time;  /* last time lag was checked (ping sent) */
    183. 

  183.     time_t lag_next_check;          /* time for next check                   */
    184. 

  184.     time_t lag_last_refresh;        /* last refresh of lag item              */
    185. 

  185.     regex_t *cmd_list_regexp;       /* compiled Regular Expression for /list */
    186. 

  186.     time_t last_user_message;       /* time of last user message (anti flood)*/
    187. 

  187.     time_t last_away_check;         /* time of last away check on server     */
    188. 

  188.     struct t_irc_outqueue *outqueue[2];      /* queue for outgoing messages  */
    189. 

  189.                                              /* with 2 priorities (high/low) */
    190. 

  190.     struct t_irc_outqueue *last_outqueue[2]; /* last outgoing message        */
    191. 

  191.     struct t_irc_redirect *redirects;        /* command redirections         */
    192. 

  192.     struct t_irc_redirect *last_redirect;    /* last command redirection     */
    193. 

  193.     struct t_irc_notify *notify_list;        /* list of notify               */
    194. 

  194.     struct t_irc_notify *last_notify;        /* last notify                  */
    195. 

  195.     struct t_hashtable *manual_joins;        /* manual joins pending         */
    196. 

  196.     struct t_gui_buffer *buffer;          /* GUI buffer allocated for server */
    197. 

  197.     char *buffer_as_string;               /* used to return buffer info      */
    198. 

  198.     struct t_irc_channel *channels;       /* opened channels on server       */
    199. 

  199.     struct t_irc_channel *last_channel;   /* last opened channel on server   */
    200. 

  200.     struct t_irc_server *prev_server;     /* link to previous server         */
    201. 

  201.     struct t_irc_server *next_server;     /* link to next server             */
    202. 

  202. };
    203. 

  203. 

  204. /* IRC messages */
    205. 

  205. 

  206. struct t_irc_message
    207. 

  207. {
    208. 

  208.     struct t_irc_server *server;        /* server pointer for received msg   */
    209. 

  209.     char *data;                         /* message content                   */
    210. 

  210.     struct t_irc_message *next_message; /* link to next message              */
    211. 

  211. };
    212. 

  212. 

  213. extern struct t_irc_server *irc_servers;
    214. 

  214. #ifdef HAVE_GNUTLS
    215. 

  215. extern const int gnutls_cert_type_prio[];
    216. 

  216. extern const int gnutls_prot_prio[];
    217. 

  217. #endif
    218. 

  218. extern struct t_irc_message *irc_recv_msgq, *irc_msgq_last_msg;
    219. 

  219. extern char *irc_server_option_string[];
    220. 

  220. extern char *irc_server_option_default[];
    221. 

  221. 

  222. extern int irc_server_valid (struct t_irc_server *server);
    223. 

  223. extern struct t_irc_server *irc_server_search (const char *server_name);
    224. 

  224. extern struct t_irc_server *irc_server_casesearch (const char *server_name);
    225. 

  225. extern int irc_server_search_option (const char *option_name);
    226. 

  226. extern int irc_server_search_casemapping (const char *casemapping);
    227. 

  227. extern int irc_server_strcasecmp (struct t_irc_server *server,
    228. 

  228.                                   const char *string1, const char *string2);
    229. 

  229. extern int irc_server_strncasecmp (struct t_irc_server *server,
    230. 

  230.                                    const char *string1, const char *string2,
    231. 

  231.                                    int max);
    232. 

  232. extern int irc_server_sasl_enabled (struct t_irc_server *server);
    233. 

  233. extern char *irc_server_get_name_without_port (const char *name);
    234. 

  234. extern void irc_server_set_addresses (struct t_irc_server *server,
    235. 

  235.                                       const char *addresses);
    236. 

  236. extern void irc_server_set_nicks (struct t_irc_server *server, const char *nicks);
    237. 

  237. extern void irc_server_set_nick (struct t_irc_server *server, const char *nick);
    238. 

  238. extern int irc_server_get_nick_index (struct t_irc_server *server);
    239. 

  239. extern const char *irc_server_get_isupport_value (struct t_irc_server *server,
    240. 

  240.                                                   const char *feature);
    241. 

  241. extern void irc_server_set_prefix_modes_chars (struct t_irc_server *server,
    242. 

  242.                                                const char *prefix);
    243. 

  243. extern const char *irc_server_get_prefix_modes (struct t_irc_server *server);
    244. 

  244. extern const char *irc_server_get_prefix_chars (struct t_irc_server *server);
    245. 

  245. extern int irc_server_get_prefix_mode_index (struct t_irc_server *server,
    246. 

  246.                                              char mode);
    247. 

  247. extern int irc_server_get_prefix_char_index (struct t_irc_server *server,
    248. 

  248.                                              char prefix_char);
    249. 

  249. extern char irc_server_get_prefix_mode_for_char (struct t_irc_server *server,
    250. 

  250.                                                  char prefix_char);
    251. 

  251. extern char irc_server_get_prefix_char_for_mode (struct t_irc_server *server,
    252. 

  252.                                                  char mode);
    253. 

  253. extern struct t_irc_server *irc_server_alloc (const char *name);
    254. 

  254. extern struct t_irc_server *irc_server_alloc_with_url (const char *irc_url);
    255. 

  255. extern void irc_server_apply_command_line_options (struct t_irc_server *server,
    256. 

  256.                                                    int argc, char **argv);
    257. 

  257. extern void irc_server_free_all ();
    258. 

  258. extern struct t_irc_server *irc_server_copy (struct t_irc_server *server,
    259. 

  259.                                              const char *new_name);
    260. 

  260. extern int irc_server_rename (struct t_irc_server *server, const char *new_name);
    261. 

  261. extern void irc_server_send_signal (struct t_irc_server *server,
    262. 

  262.                                     const char *signal, const char *command,
    263. 

  263.                                     const char *full_message,
    264. 

  264.                                     const char *tags);
    265. 

  265. extern void irc_server_set_send_default_tags (const char *tags);
    266. 

  266. extern struct t_hashtable *irc_server_sendf (struct t_irc_server *server,
    267. 

  267.                                              int flags,
    268. 

  268.                                              const char *tags,
    269. 

  269.                                              const char *format, ...);
    270. 

  270. extern void irc_server_set_buffer_title (struct t_irc_server *server);
    271. 

  271. extern struct t_gui_buffer *irc_server_create_buffer (struct t_irc_server *server);
    272. 

  272. extern int irc_server_connect (struct t_irc_server *server);
    273. 

  273. extern void irc_server_auto_connect (int auto_connect);
    274. 

  274. extern void irc_server_autojoin_channels ();
    275. 

  275. extern int irc_server_recv_cb (void *data, int fd);
    276. 

  276. extern int irc_server_timer_sasl_cb (void *data, int remaining_calls);
    277. 

  277. extern int irc_server_timer_cb (void *data, int remaining_calls);
    278. 

  278. extern void irc_server_outqueue_free_all (struct t_irc_server *server,
    279. 

  279.                                           int priority);
    280. 

  280. extern int irc_server_get_channel_count (struct t_irc_server *server);
    281. 

  281. extern int irc_server_get_pv_count (struct t_irc_server *server);
    282. 

  282. extern void irc_server_set_away (struct t_irc_server *server, const char *nick,
    283. 

  283.                                  int is_away);
    284. 

  284. extern void irc_server_remove_away (struct t_irc_server *server);
    285. 

  285. extern void irc_server_check_away (struct t_irc_server *server);
    286. 

  286. extern void irc_server_switch_address (struct t_irc_server *server,
    287. 

  287.                                        int connection);
    288. 

  288. extern void irc_server_disconnect (struct t_irc_server *server,
    289. 

  289.                                    int switch_address, int reconnect);
    290. 

  290. extern void irc_server_disconnect_all ();
    291. 

  291. extern void irc_server_free (struct t_irc_server *server);
    292. 

  292. extern int irc_server_xfer_send_ready_cb (void *data, const char *signal,
    293. 

  293.                                           const char *type_data, void *signal_data);
    294. 

  294. extern int irc_server_xfer_resume_ready_cb (void *data, const char *signal,
    295. 

  295.                                             const char *type_data, void *signal_data);
    296. 

  296. extern int irc_server_xfer_send_accept_resume_cb (void *data, const char *signal,
    297. 

  297.                                                   const char *type_data,
    298. 

  298.                                                   void *signal_data);
    299. 

  299. extern struct t_hdata *irc_server_hdata_server_cb (void *data,
    300. 

  300.                                                    const char *hdata_name);
    301. 

  301. extern int irc_server_add_to_infolist (struct t_infolist *infolist,
    302. 

  302.                                        struct t_irc_server *server);
    303. 

  303. extern void irc_server_print_log ();
    304. 

  304. 

  305. #endif /* __WEECHAT_IRC_SERVER_H */
    306. 

  306.