[f06894d] | 1 | /***************************************************************************\ |
---|
| 2 | * * |
---|
| 3 | * BitlBee - An IRC to IM gateway * |
---|
| 4 | * Jabber module - Main file * |
---|
| 5 | * * |
---|
[0e788f5] | 6 | * Copyright 2006-2013 Wilmer van der Gaast <wilmer@gaast.net> * |
---|
[f06894d] | 7 | * * |
---|
| 8 | * This program is free software; you can redistribute it and/or modify * |
---|
| 9 | * it under the terms of the GNU General Public License as published by * |
---|
| 10 | * the Free Software Foundation; either version 2 of the License, or * |
---|
| 11 | * (at your option) any later version. * |
---|
| 12 | * * |
---|
| 13 | * This program is distributed in the hope that it will be useful, * |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of * |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * |
---|
| 16 | * GNU General Public License for more details. * |
---|
| 17 | * * |
---|
| 18 | * You should have received a copy of the GNU General Public License along * |
---|
| 19 | * with this program; if not, write to the Free Software Foundation, Inc., * |
---|
| 20 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * |
---|
| 21 | * * |
---|
| 22 | \***************************************************************************/ |
---|
| 23 | |
---|
| 24 | #include <glib.h> |
---|
| 25 | #include <string.h> |
---|
| 26 | #include <unistd.h> |
---|
| 27 | #include <ctype.h> |
---|
| 28 | #include <stdio.h> |
---|
| 29 | |
---|
[21167d2] | 30 | #include "ssl_client.h" |
---|
[f06894d] | 31 | #include "xmltree.h" |
---|
| 32 | #include "bitlbee.h" |
---|
| 33 | #include "jabber.h" |
---|
[e14b47b8] | 34 | #include "oauth.h" |
---|
[608f8cf] | 35 | #include "md5.h" |
---|
[f06894d] | 36 | |
---|
[b5c8a34] | 37 | GSList *jabber_connections; |
---|
| 38 | |
---|
[7f69740] | 39 | /* First enty is the default */ |
---|
| 40 | static const int jabber_port_list[] = { |
---|
| 41 | 5222, |
---|
| 42 | 5223, |
---|
| 43 | 5220, |
---|
| 44 | 5221, |
---|
| 45 | 5224, |
---|
| 46 | 5225, |
---|
| 47 | 5226, |
---|
| 48 | 5227, |
---|
| 49 | 5228, |
---|
| 50 | 5229, |
---|
| 51 | 80, |
---|
| 52 | 443, |
---|
| 53 | 0 |
---|
| 54 | }; |
---|
| 55 | |
---|
[5ebff60] | 56 | static void jabber_init(account_t *acc) |
---|
[f06894d] | 57 | { |
---|
| 58 | set_t *s; |
---|
[7f69740] | 59 | char str[16]; |
---|
[5ebff60] | 60 | |
---|
| 61 | s = set_add(&acc->set, "activity_timeout", "600", set_eval_int, acc); |
---|
| 62 | |
---|
| 63 | s = set_add(&acc->set, "display_name", NULL, NULL, acc); |
---|
| 64 | |
---|
| 65 | g_snprintf(str, sizeof(str), "%d", jabber_port_list[0]); |
---|
| 66 | s = set_add(&acc->set, "port", str, set_eval_int, acc); |
---|
[f06894d] | 67 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[1c3008a] | 68 | |
---|
[5ebff60] | 69 | s = set_add(&acc->set, "priority", "0", set_eval_priority, acc); |
---|
| 70 | |
---|
| 71 | s = set_add(&acc->set, "proxy", "<local>;<auto>", NULL, acc); |
---|
| 72 | |
---|
| 73 | s = set_add(&acc->set, "resource", "BitlBee", NULL, acc); |
---|
[ebe7b36] | 74 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[5ebff60] | 75 | |
---|
| 76 | s = set_add(&acc->set, "resource_select", "activity", NULL, acc); |
---|
| 77 | |
---|
| 78 | s = set_add(&acc->set, "sasl", "true", set_eval_bool, acc); |
---|
[ce199b7] | 79 | s->flags |= ACC_SET_OFFLINE_ONLY | SET_HIDDEN_DEFAULT; |
---|
[5ebff60] | 80 | |
---|
| 81 | s = set_add(&acc->set, "server", NULL, set_eval_account, acc); |
---|
[bb5ce568] | 82 | s->flags |= SET_NOSAVE | ACC_SET_OFFLINE_ONLY | SET_NULL_OK; |
---|
[5ebff60] | 83 | |
---|
[67ea361] | 84 | set_add(&acc->set, "oauth", "false", set_eval_oauth, acc); |
---|
| 85 | |
---|
[71074ac] | 86 | if (strcmp(acc->prpl->name, "hipchat") == 0) { |
---|
| 87 | set_setstr(&acc->set, "server", "chat.hipchat.com"); |
---|
| 88 | } else { |
---|
[73dd021] | 89 | /* this reuses set_eval_oauth, which clears the password */ |
---|
| 90 | set_add(&acc->set, "anonymous", "false", set_eval_oauth, acc); |
---|
[71074ac] | 91 | } |
---|
| 92 | |
---|
[5ebff60] | 93 | s = set_add(&acc->set, "ssl", "false", set_eval_bool, acc); |
---|
[f06894d] | 94 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[5ebff60] | 95 | |
---|
| 96 | s = set_add(&acc->set, "tls", "true", set_eval_tls, acc); |
---|
[f06894d] | 97 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[5ebff60] | 98 | |
---|
| 99 | s = set_add(&acc->set, "tls_verify", "true", set_eval_bool, acc); |
---|
[486ddb5] | 100 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[34ded90] | 101 | |
---|
[5ebff60] | 102 | s = set_add(&acc->set, "user_agent", "BitlBee", NULL, acc); |
---|
| 103 | |
---|
| 104 | s = set_add(&acc->set, "xmlconsole", "false", set_eval_bool, acc); |
---|
[dd43c62] | 105 | |
---|
[b38f655] | 106 | s = set_add(&acc->set, "mail_notifications", "false", set_eval_bool, acc); |
---|
[a6df0b5] | 107 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
[5ebff60] | 108 | |
---|
[faeb521] | 109 | /* changing this is rarely needed so keeping it secret */ |
---|
[b38f655] | 110 | s = set_add(&acc->set, "mail_notifications_limit", "5", set_eval_int, acc); |
---|
[faeb521] | 111 | s->flags |= SET_HIDDEN_DEFAULT; |
---|
| 112 | |
---|
[b38f655] | 113 | s = set_add(&acc->set, "mail_notifications_handle", NULL, NULL, acc); |
---|
[dd43c62] | 114 | s->flags |= ACC_SET_OFFLINE_ONLY | SET_NULL_OK; |
---|
| 115 | |
---|
[fa8f57b] | 116 | s = set_add(&acc->set, "carbons", "true", set_eval_bool, acc); |
---|
| 117 | s->flags |= ACC_SET_OFFLINE_ONLY; |
---|
| 118 | |
---|
[06eef80] | 119 | acc->flags |= ACC_FLAG_AWAY_MESSAGE | ACC_FLAG_STATUS_MESSAGE | |
---|
| 120 | ACC_FLAG_HANDLE_DOMAINS; |
---|
[f06894d] | 121 | } |
---|
| 122 | |
---|
[5ebff60] | 123 | static void jabber_generate_id_hash(struct jabber_data *jd); |
---|
[608f8cf] | 124 | |
---|
[5ebff60] | 125 | static void jabber_login(account_t *acc) |
---|
[f06894d] | 126 | { |
---|
[5ebff60] | 127 | struct im_connection *ic = imcb_new(acc); |
---|
| 128 | struct jabber_data *jd = g_new0(struct jabber_data, 1); |
---|
[4a5d885] | 129 | char *s; |
---|
[5ebff60] | 130 | |
---|
[b5c8a34] | 131 | /* For now this is needed in the _connected() handlers if using |
---|
| 132 | GLib event handling, to make sure we're not handling events |
---|
| 133 | on dead connections. */ |
---|
[5ebff60] | 134 | jabber_connections = g_slist_prepend(jabber_connections, ic); |
---|
| 135 | |
---|
[0da65d5] | 136 | jd->ic = ic; |
---|
| 137 | ic->proto_data = jd; |
---|
[5ebff60] | 138 | |
---|
| 139 | jabber_set_me(ic, acc->user); |
---|
| 140 | |
---|
[de03374] | 141 | jd->fd = jd->r_inpa = jd->w_inpa = -1; |
---|
[5ebff60] | 142 | |
---|
[71074ac] | 143 | if (strcmp(acc->prpl->name, "hipchat") == 0) { |
---|
| 144 | jd->flags |= JFLAG_HIPCHAT; |
---|
| 145 | } |
---|
| 146 | |
---|
[5ebff60] | 147 | if (jd->server == NULL) { |
---|
| 148 | imcb_error(ic, "Incomplete account name (format it like <username@jabberserver.name>)"); |
---|
| 149 | imc_logout(ic, FALSE); |
---|
[21167d2] | 150 | return; |
---|
| 151 | } |
---|
[5ebff60] | 152 | |
---|
[9b02bab] | 153 | if (strstr(jd->server, ".facebook.com")) { |
---|
| 154 | imcb_error(ic, "Facebook's XMPP service is gone. Try this instead: https://wiki.bitlbee.org/HowtoFacebookMQTT"); |
---|
| 155 | imc_logout(ic, FALSE); |
---|
| 156 | return; |
---|
| 157 | } |
---|
| 158 | |
---|
[5ebff60] | 159 | if ((s = strchr(jd->server, '/'))) { |
---|
[3b3cd693] | 160 | *s = 0; |
---|
[5ebff60] | 161 | set_setstr(&acc->set, "resource", s + 1); |
---|
| 162 | |
---|
[3b3cd693] | 163 | /* Also remove the /resource from the original variable so we |
---|
| 164 | won't have to do this again every time. */ |
---|
[5ebff60] | 165 | s = strchr(acc->user, '/'); |
---|
[3b3cd693] | 166 | *s = 0; |
---|
| 167 | } |
---|
[5ebff60] | 168 | |
---|
| 169 | jd->node_cache = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, jabber_cache_entry_free); |
---|
| 170 | jd->buddies = g_hash_table_new(g_str_hash, g_str_equal); |
---|
| 171 | |
---|
| 172 | if (set_getbool(&acc->set, "oauth")) { |
---|
[e14b47b8] | 173 | GSList *p_in = NULL; |
---|
| 174 | const char *tok; |
---|
[5ebff60] | 175 | |
---|
[f138bd2] | 176 | jd->fd = jd->r_inpa = jd->w_inpa = -1; |
---|
[5ebff60] | 177 | |
---|
[9b02bab] | 178 | /* There are no other options atm, so assume google for everything |
---|
| 179 | Facebook and MSN XMPP used to be here. RIP. */ |
---|
| 180 | jd->oauth2_service = &oauth2_service_google; |
---|
[5ebff60] | 181 | |
---|
| 182 | oauth_params_parse(&p_in, ic->acc->pass); |
---|
| 183 | |
---|
[64b6635] | 184 | /* First see if we have a refresh token, in which case any |
---|
| 185 | access token we *might* have has probably expired already |
---|
| 186 | anyway. */ |
---|
[5ebff60] | 187 | if ((tok = oauth_params_get(&p_in, "refresh_token"))) { |
---|
| 188 | sasl_oauth2_refresh(ic, tok); |
---|
[64b6635] | 189 | } |
---|
| 190 | /* If we don't have a refresh token, let's hope the access |
---|
| 191 | token is still usable. */ |
---|
[5ebff60] | 192 | else if ((tok = oauth_params_get(&p_in, "access_token"))) { |
---|
| 193 | jd->oauth2_access_token = g_strdup(tok); |
---|
| 194 | jabber_connect(ic); |
---|
[64b6635] | 195 | } |
---|
| 196 | /* If we don't have any, start the OAuth process now. Don't |
---|
| 197 | even open an XMPP connection yet. */ |
---|
[5ebff60] | 198 | else { |
---|
| 199 | sasl_oauth2_init(ic); |
---|
[f988ad3] | 200 | ic->flags |= OPT_SLOW_LOGIN; |
---|
| 201 | } |
---|
[5ebff60] | 202 | |
---|
| 203 | oauth_params_free(&p_in); |
---|
| 204 | } else { |
---|
| 205 | jabber_connect(ic); |
---|
[4a5d885] | 206 | } |
---|
| 207 | } |
---|
| 208 | |
---|
[3314ced] | 209 | static void jabber_xmlconsole_enable(struct im_connection *ic) |
---|
| 210 | { |
---|
| 211 | struct jabber_data *jd = ic->proto_data; |
---|
| 212 | const char *handle = JABBER_XMLCONSOLE_HANDLE; |
---|
| 213 | bee_user_t *bu; |
---|
| 214 | |
---|
| 215 | jd->flags |= JFLAG_XMLCONSOLE; |
---|
| 216 | |
---|
| 217 | if (!(bu = bee_user_by_handle(ic->bee, ic, handle))) { |
---|
| 218 | bu = bee_user_new(ic->bee, ic, handle, 0); |
---|
| 219 | bu->flags |= BEE_USER_NOOTR; |
---|
| 220 | } |
---|
| 221 | } |
---|
| 222 | |
---|
[4a5d885] | 223 | /* Separate this from jabber_login() so we can do OAuth first if necessary. |
---|
| 224 | Putting this in io.c would probably be more correct. */ |
---|
[5ebff60] | 225 | void jabber_connect(struct im_connection *ic) |
---|
[4a5d885] | 226 | { |
---|
| 227 | account_t *acc = ic->acc; |
---|
| 228 | struct jabber_data *jd = ic->proto_data; |
---|
| 229 | int i; |
---|
| 230 | char *connect_to; |
---|
| 231 | struct ns_srv_reply **srvl = NULL, *srv = NULL; |
---|
[5ebff60] | 232 | |
---|
[36e9f62] | 233 | /* Figure out the hostname to connect to. */ |
---|
[5ebff60] | 234 | if (acc->server && *acc->server) { |
---|
[36e9f62] | 235 | connect_to = acc->server; |
---|
[5ebff60] | 236 | } else if ((srvl = srv_lookup("xmpp-client", "tcp", jd->server)) || |
---|
| 237 | (srvl = srv_lookup("jabber-client", "tcp", jd->server))) { |
---|
[ffdf2e7] | 238 | /* Find the lowest-priority one. These usually come |
---|
| 239 | back in random/shuffled order. Not looking at |
---|
| 240 | weights etc for now. */ |
---|
| 241 | srv = *srvl; |
---|
[5ebff60] | 242 | for (i = 1; srvl[i]; i++) { |
---|
| 243 | if (srvl[i]->prio < srv->prio) { |
---|
[ffdf2e7] | 244 | srv = srvl[i]; |
---|
[5ebff60] | 245 | } |
---|
| 246 | } |
---|
| 247 | |
---|
[36e9f62] | 248 | connect_to = srv->name; |
---|
[5ebff60] | 249 | } else { |
---|
[36e9f62] | 250 | connect_to = jd->server; |
---|
[5ebff60] | 251 | } |
---|
| 252 | |
---|
| 253 | imcb_log(ic, "Connecting"); |
---|
| 254 | |
---|
| 255 | for (i = 0; jabber_port_list[i] > 0; i++) { |
---|
| 256 | if (set_getint(&acc->set, "port") == jabber_port_list[i]) { |
---|
[7f69740] | 257 | break; |
---|
[5ebff60] | 258 | } |
---|
| 259 | } |
---|
[7f69740] | 260 | |
---|
[5ebff60] | 261 | if (jabber_port_list[i] == 0) { |
---|
| 262 | imcb_log(ic, "Illegal port number"); |
---|
| 263 | imc_logout(ic, FALSE); |
---|
[0f4c1bb5] | 264 | return; |
---|
| 265 | } |
---|
[5ebff60] | 266 | |
---|
[36e9f62] | 267 | /* For non-SSL connections we can try to use the port # from the SRV |
---|
| 268 | reply, but let's not do that when using SSL, SSL usually runs on |
---|
| 269 | non-standard ports... */ |
---|
[5ebff60] | 270 | if (set_getbool(&acc->set, "ssl")) { |
---|
| 271 | jd->ssl = ssl_connect(connect_to, set_getint(&acc->set, "port"), set_getbool(&acc->set, |
---|
| 272 | "tls_verify"), jabber_connected_ssl, |
---|
| 273 | ic); |
---|
| 274 | jd->fd = jd->ssl ? ssl_getfd(jd->ssl) : -1; |
---|
| 275 | } else { |
---|
| 276 | jd->fd = proxy_connect(connect_to, srv ? srv->port : set_getint(&acc->set, |
---|
| 277 | "port"), jabber_connected_plain, ic); |
---|
| 278 | } |
---|
| 279 | srv_free(srvl); |
---|
| 280 | |
---|
| 281 | if (jd->fd == -1) { |
---|
| 282 | imcb_error(ic, "Could not connect to server"); |
---|
| 283 | imc_logout(ic, TRUE); |
---|
| 284 | |
---|
[fb4ebcc5] | 285 | return; |
---|
[35f6677] | 286 | } |
---|
[5ebff60] | 287 | |
---|
| 288 | if (set_getbool(&acc->set, "xmlconsole")) { |
---|
[3314ced] | 289 | jabber_xmlconsole_enable(ic); |
---|
[a6df0b5] | 290 | } |
---|
[b38f655] | 291 | |
---|
| 292 | if (set_getbool(&acc->set, "mail_notifications")) { |
---|
| 293 | /* It's gmail specific, but it checks for server support before enabling it */ |
---|
[dd43c62] | 294 | jd->flags |= JFLAG_GMAILNOTIFY; |
---|
[b38f655] | 295 | if (set_getstr(&acc->set, "mail_notifications_handle")) { |
---|
| 296 | imcb_add_buddy(ic, set_getstr(&acc->set, "mail_notifications_handle"), NULL); |
---|
[dd43c62] | 297 | } |
---|
| 298 | } |
---|
[5ebff60] | 299 | |
---|
| 300 | jabber_generate_id_hash(jd); |
---|
[608f8cf] | 301 | } |
---|
| 302 | |
---|
[89d736a] | 303 | /* This generates an unfinished md5_state_t variable. Every time we generate |
---|
| 304 | an ID, we finish the state by adding a sequence number and take the hash. */ |
---|
[5ebff60] | 305 | static void jabber_generate_id_hash(struct jabber_data *jd) |
---|
[608f8cf] | 306 | { |
---|
[89d736a] | 307 | md5_byte_t binbuf[4]; |
---|
[608f8cf] | 308 | char *s; |
---|
[5ebff60] | 309 | |
---|
| 310 | md5_init(&jd->cached_id_prefix); |
---|
| 311 | md5_append(&jd->cached_id_prefix, (unsigned char *) jd->username, strlen(jd->username)); |
---|
| 312 | md5_append(&jd->cached_id_prefix, (unsigned char *) jd->server, strlen(jd->server)); |
---|
| 313 | s = set_getstr(&jd->ic->acc->set, "resource"); |
---|
| 314 | md5_append(&jd->cached_id_prefix, (unsigned char *) s, strlen(s)); |
---|
| 315 | random_bytes(binbuf, 4); |
---|
| 316 | md5_append(&jd->cached_id_prefix, binbuf, 4); |
---|
[f06894d] | 317 | } |
---|
| 318 | |
---|
[5ebff60] | 319 | static void jabber_logout(struct im_connection *ic) |
---|
[f06894d] | 320 | { |
---|
[0da65d5] | 321 | struct jabber_data *jd = ic->proto_data; |
---|
[4ac647d] | 322 | |
---|
[399d65a] | 323 | imcb_chat_list_free(ic); |
---|
| 324 | |
---|
[5ebff60] | 325 | while (jd->filetransfers) { |
---|
| 326 | imcb_file_canceled(ic, (( struct jabber_transfer *) jd->filetransfers->data)->ft, "Logging out"); |
---|
| 327 | } |
---|
| 328 | |
---|
| 329 | while (jd->streamhosts) { |
---|
[4ac647d] | 330 | jabber_streamhost_t *sh = jd->streamhosts->data; |
---|
[5ebff60] | 331 | jd->streamhosts = g_slist_remove(jd->streamhosts, sh); |
---|
| 332 | g_free(sh->jid); |
---|
| 333 | g_free(sh->host); |
---|
| 334 | g_free(sh); |
---|
| 335 | } |
---|
| 336 | |
---|
| 337 | if (jd->fd >= 0) { |
---|
| 338 | jabber_end_stream(ic); |
---|
| 339 | } |
---|
| 340 | |
---|
| 341 | while (ic->groupchats) { |
---|
| 342 | jabber_chat_free(ic->groupchats->data); |
---|
| 343 | } |
---|
| 344 | |
---|
| 345 | if (jd->r_inpa >= 0) { |
---|
| 346 | b_event_remove(jd->r_inpa); |
---|
| 347 | } |
---|
| 348 | if (jd->w_inpa >= 0) { |
---|
| 349 | b_event_remove(jd->w_inpa); |
---|
| 350 | } |
---|
| 351 | |
---|
| 352 | if (jd->ssl) { |
---|
| 353 | ssl_disconnect(jd->ssl); |
---|
| 354 | } |
---|
| 355 | if (jd->fd >= 0) { |
---|
[0db6618] | 356 | proxy_disconnect(jd->fd); |
---|
[5ebff60] | 357 | } |
---|
| 358 | |
---|
| 359 | if (jd->tx_len) { |
---|
| 360 | g_free(jd->txq); |
---|
| 361 | } |
---|
| 362 | |
---|
| 363 | if (jd->node_cache) { |
---|
| 364 | g_hash_table_destroy(jd->node_cache); |
---|
| 365 | } |
---|
| 366 | |
---|
[666722e] | 367 | if (jd->buddies) { |
---|
| 368 | jabber_buddy_remove_all(ic); |
---|
| 369 | } |
---|
[5ebff60] | 370 | |
---|
| 371 | xt_free(jd->xt); |
---|
| 372 | |
---|
| 373 | md5_free(&jd->cached_id_prefix); |
---|
| 374 | |
---|
| 375 | g_free(jd->oauth2_access_token); |
---|
| 376 | g_free(jd->away_message); |
---|
| 377 | g_free(jd->internal_jid); |
---|
[dd43c62] | 378 | g_free(jd->gmail_tid); |
---|
[9c8dbc7] | 379 | g_free(jd->muc_host); |
---|
[5ebff60] | 380 | g_free(jd->username); |
---|
| 381 | g_free(jd->me); |
---|
| 382 | g_free(jd); |
---|
| 383 | |
---|
| 384 | jabber_connections = g_slist_remove(jabber_connections, ic); |
---|
[f06894d] | 385 | } |
---|
| 386 | |
---|
[5ebff60] | 387 | static int jabber_buddy_msg(struct im_connection *ic, char *who, char *message, int flags) |
---|
[f06894d] | 388 | { |
---|
[0da65d5] | 389 | struct jabber_data *jd = ic->proto_data; |
---|
[a21a8ac] | 390 | struct jabber_buddy *bud; |
---|
[cc2cb2d] | 391 | struct xt_node *node; |
---|
[b9f8b87] | 392 | char *s; |
---|
[4a0614e] | 393 | int st; |
---|
[5ebff60] | 394 | |
---|
| 395 | if (g_strcasecmp(who, JABBER_XMLCONSOLE_HANDLE) == 0) { |
---|
| 396 | return jabber_write(ic, message, strlen(message)); |
---|
| 397 | } |
---|
| 398 | |
---|
| 399 | if (g_strcasecmp(who, JABBER_OAUTH_HANDLE) == 0 && |
---|
| 400 | !(jd->flags & OPT_LOGGED_IN) && jd->fd == -1) { |
---|
[67ea361] | 401 | |
---|
| 402 | if (jd->flags & JFLAG_HIPCHAT) { |
---|
| 403 | sasl_oauth2_got_token(ic, message, NULL, NULL); |
---|
| 404 | return 1; |
---|
| 405 | } else if (sasl_oauth2_get_refresh_token(ic, message)) { |
---|
[4a5d885] | 406 | return 1; |
---|
[5ebff60] | 407 | } else { |
---|
| 408 | imcb_error(ic, "OAuth failure"); |
---|
| 409 | imc_logout(ic, TRUE); |
---|
[911d97a] | 410 | return 0; |
---|
[4a5d885] | 411 | } |
---|
| 412 | } |
---|
[5ebff60] | 413 | |
---|
| 414 | if ((s = strchr(who, '=')) && jabber_chat_by_jid(ic, s + 1)) { |
---|
| 415 | bud = jabber_buddy_by_ext_jid(ic, who, 0); |
---|
| 416 | } else { |
---|
| 417 | bud = jabber_buddy_by_jid(ic, who, GET_BUDDY_BARE_OK); |
---|
| 418 | } |
---|
| 419 | |
---|
| 420 | node = xt_new_node("body", message, NULL); |
---|
| 421 | node = jabber_make_packet("message", "chat", bud ? bud->full_jid : who, node); |
---|
| 422 | |
---|
| 423 | if (bud && (jd->flags & JFLAG_WANT_TYPING) && |
---|
| 424 | ((bud->flags & JBFLAG_DOES_XEP85) || |
---|
| 425 | !(bud->flags & JBFLAG_PROBED_XEP85))) { |
---|
[a21a8ac] | 426 | struct xt_node *act; |
---|
[5ebff60] | 427 | |
---|
[a21a8ac] | 428 | /* If the user likes typing notification and if we don't know |
---|
[788a1af] | 429 | (and didn't probe before) if this resource supports XEP85, |
---|
[abbd8ed] | 430 | include a probe in this packet now. Also, if we know this |
---|
| 431 | buddy does support XEP85, we have to send this <active/> |
---|
| 432 | tag to tell that the user stopped typing (well, that's what |
---|
| 433 | we guess when s/he pressed Enter...). */ |
---|
[5ebff60] | 434 | act = xt_new_node("active", NULL, NULL); |
---|
| 435 | xt_add_attr(act, "xmlns", XMLNS_CHATSTATES); |
---|
| 436 | xt_add_child(node, act); |
---|
| 437 | |
---|
[a21a8ac] | 438 | /* Just make sure we do this only once. */ |
---|
[788a1af] | 439 | bud->flags |= JBFLAG_PROBED_XEP85; |
---|
[a21a8ac] | 440 | } |
---|
[5ebff60] | 441 | |
---|
[3a620ff] | 442 | /* XEP-0364 suggests we add message processing hints (XEP-0334) to OTR messages, |
---|
| 443 | mostly to avoid carbons (XEP-0280) and server-side message archiving. |
---|
| 444 | OTR messages are roughly like this: /^\?OTR(.*\?| Error:|:)/ |
---|
| 445 | But I'm going to simplify it to messages starting with "?OTR". */ |
---|
| 446 | if (g_str_has_prefix(message, "?OTR")) { |
---|
| 447 | int i; |
---|
| 448 | char *hints[] = { |
---|
| 449 | "no-copy", XMLNS_HINTS, |
---|
| 450 | "no-permanent-store", XMLNS_HINTS, |
---|
| 451 | "private", XMLNS_CARBONS, |
---|
| 452 | NULL |
---|
| 453 | }; |
---|
| 454 | |
---|
| 455 | for (i = 0; hints[i]; i += 2) { |
---|
| 456 | struct xt_node *hint; |
---|
| 457 | hint = xt_new_node(hints[i], NULL, NULL); |
---|
| 458 | xt_add_attr(hint, "xmlns", hints[i + 1]); |
---|
| 459 | xt_add_child(node, hint); |
---|
| 460 | } |
---|
| 461 | } |
---|
| 462 | |
---|
[5ebff60] | 463 | st = jabber_write_packet(ic, node); |
---|
| 464 | xt_free_node(node); |
---|
| 465 | |
---|
[4a0614e] | 466 | return st; |
---|
[f06894d] | 467 | } |
---|
| 468 | |
---|
[5ebff60] | 469 | static GList *jabber_away_states(struct im_connection *ic) |
---|
[dd788bb] | 470 | { |
---|
[5e202b0] | 471 | static GList *l = NULL; |
---|
| 472 | int i; |
---|
[5ebff60] | 473 | |
---|
| 474 | if (l == NULL) { |
---|
| 475 | for (i = 0; jabber_away_state_list[i].full_name; i++) { |
---|
| 476 | l = g_list_append(l, (void *) jabber_away_state_list[i].full_name); |
---|
| 477 | } |
---|
| 478 | } |
---|
| 479 | |
---|
[5e202b0] | 480 | return l; |
---|
[dd788bb] | 481 | } |
---|
| 482 | |
---|
[5ebff60] | 483 | static void jabber_get_info(struct im_connection *ic, char *who) |
---|
[038d17f] | 484 | { |
---|
[6a1128d] | 485 | struct jabber_buddy *bud; |
---|
[5ebff60] | 486 | |
---|
| 487 | bud = jabber_buddy_by_jid(ic, who, GET_BUDDY_FIRST); |
---|
| 488 | |
---|
| 489 | while (bud) { |
---|
| 490 | imcb_log(ic, "Buddy %s (%d) information:", bud->full_jid, bud->priority); |
---|
| 491 | if (bud->away_state) { |
---|
| 492 | imcb_log(ic, "Away state: %s", bud->away_state->full_name); |
---|
| 493 | } |
---|
| 494 | imcb_log(ic, "Status message: %s", bud->away_message ? bud->away_message : "(none)"); |
---|
| 495 | |
---|
[6a1128d] | 496 | bud = bud->next; |
---|
| 497 | } |
---|
[5ebff60] | 498 | |
---|
[5535a47] | 499 | jabber_get_vcard(ic, who); |
---|
[038d17f] | 500 | } |
---|
| 501 | |
---|
[5ebff60] | 502 | static void jabber_set_away(struct im_connection *ic, char *state_txt, char *message) |
---|
[dd788bb] | 503 | { |
---|
[0da65d5] | 504 | struct jabber_data *jd = ic->proto_data; |
---|
[5ebff60] | 505 | |
---|
[840bba8] | 506 | /* state_txt == NULL -> Not away. |
---|
| 507 | Unknown state -> fall back to the first defined away state. */ |
---|
[5ebff60] | 508 | if (state_txt == NULL) { |
---|
[daae10f] | 509 | jd->away_state = NULL; |
---|
[5ebff60] | 510 | } else if ((jd->away_state = jabber_away_state_by_name(state_txt)) == NULL) { |
---|
[daae10f] | 511 | jd->away_state = jabber_away_state_list; |
---|
[5ebff60] | 512 | } |
---|
| 513 | |
---|
| 514 | g_free(jd->away_message); |
---|
| 515 | jd->away_message = (message && *message) ? g_strdup(message) : NULL; |
---|
| 516 | |
---|
| 517 | presence_send_update(ic); |
---|
[deff040] | 518 | } |
---|
| 519 | |
---|
[5ebff60] | 520 | static void jabber_add_buddy(struct im_connection *ic, char *who, char *group) |
---|
[cfbb3a6] | 521 | { |
---|
[5ebff60] | 522 | if (g_strcasecmp(who, JABBER_XMLCONSOLE_HANDLE) == 0) { |
---|
[3314ced] | 523 | jabber_xmlconsole_enable(ic); |
---|
[bb95d43] | 524 | return; |
---|
| 525 | } |
---|
[5ebff60] | 526 | |
---|
| 527 | if (jabber_add_to_roster(ic, who, NULL, group)) { |
---|
| 528 | presence_send_request(ic, who, "subscribe"); |
---|
| 529 | } |
---|
[cfbb3a6] | 530 | } |
---|
| 531 | |
---|
[5ebff60] | 532 | static void jabber_remove_buddy(struct im_connection *ic, char *who, char *group) |
---|
[cfbb3a6] | 533 | { |
---|
[bb95d43] | 534 | struct jabber_data *jd = ic->proto_data; |
---|
[5ebff60] | 535 | |
---|
| 536 | if (g_strcasecmp(who, JABBER_XMLCONSOLE_HANDLE) == 0) { |
---|
[bb95d43] | 537 | jd->flags &= ~JFLAG_XMLCONSOLE; |
---|
[a3d5766] | 538 | /* Not necessary for now. And for now the code isn't too |
---|
| 539 | happy if the buddy is completely gone right after calling |
---|
| 540 | this function already. |
---|
[998b103] | 541 | imcb_remove_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL ); |
---|
[a3d5766] | 542 | */ |
---|
[bb95d43] | 543 | return; |
---|
| 544 | } |
---|
[5ebff60] | 545 | |
---|
[788a1af] | 546 | /* We should always do this part. Clean up our administration a little bit. */ |
---|
[5ebff60] | 547 | jabber_buddy_remove_bare(ic, who); |
---|
| 548 | |
---|
| 549 | if (jabber_remove_from_roster(ic, who)) { |
---|
| 550 | presence_send_request(ic, who, "unsubscribe"); |
---|
| 551 | } |
---|
[cfbb3a6] | 552 | } |
---|
| 553 | |
---|
[5ebff60] | 554 | static struct groupchat *jabber_chat_join_(struct im_connection *ic, const char *room, const char *nick, |
---|
| 555 | const char *password, set_t **sets) |
---|
[e35d1a1] | 556 | { |
---|
[441a67e] | 557 | struct jabber_data *jd = ic->proto_data; |
---|
[fcb2c2e] | 558 | char *final_nick; |
---|
[5ebff60] | 559 | |
---|
[fcb2c2e] | 560 | /* Ignore the passed nick parameter if we have our own default */ |
---|
[5ebff60] | 561 | if (!(final_nick = set_getstr(sets, "nick")) && |
---|
| 562 | !(final_nick = set_getstr(&ic->acc->set, "display_name"))) { |
---|
[fcb2c2e] | 563 | /* Well, whatever, actually use the provided default, then */ |
---|
| 564 | final_nick = (char *) nick; |
---|
| 565 | } |
---|
| 566 | |
---|
[9c8dbc7] | 567 | if (jd->flags & JFLAG_HIPCHAT && jd->muc_host && !g_str_has_suffix(room, jd->muc_host)) { |
---|
| 568 | char *guessed_name = hipchat_guess_channel_name(ic, room); |
---|
| 569 | if (guessed_name) { |
---|
| 570 | set_setstr(sets, "room", guessed_name); |
---|
| 571 | g_free(guessed_name); |
---|
| 572 | |
---|
| 573 | /* call this same function again with the fixed name */ |
---|
| 574 | return jabber_chat_join_(ic, set_getstr(sets, "room"), nick, password, sets); |
---|
| 575 | } |
---|
| 576 | } |
---|
| 577 | |
---|
[5ebff60] | 578 | if (strchr(room, '@') == NULL) { |
---|
| 579 | imcb_error(ic, "%s is not a valid Jabber room name. Maybe you mean %s@conference.%s?", |
---|
| 580 | room, room, jd->server); |
---|
| 581 | } else { |
---|
[246b98b] | 582 | struct groupchat *old; |
---|
| 583 | |
---|
| 584 | if ((old = jabber_chat_by_jid(ic, room))) { |
---|
| 585 | imcb_log(ic, "Warning: Already present in chat `%s' - trying to join anyway", room); |
---|
| 586 | jabber_chat_free(old); |
---|
| 587 | } |
---|
| 588 | |
---|
[9c8dbc7] | 589 | /* jabber_chat_join without the underscore is the conference.c one */ |
---|
[3320d6d] | 590 | return jabber_chat_join(ic, room, final_nick, set_getstr(sets, "password"), |
---|
| 591 | set_getbool(sets, "always_use_nicks")); |
---|
[5ebff60] | 592 | } |
---|
| 593 | |
---|
[e35d1a1] | 594 | return NULL; |
---|
| 595 | } |
---|
| 596 | |
---|
[5ebff60] | 597 | static struct groupchat *jabber_chat_with_(struct im_connection *ic, char *who) |
---|
[fc0640e] | 598 | { |
---|
[5ebff60] | 599 | return jabber_chat_with(ic, who); |
---|
[fc0640e] | 600 | } |
---|
| 601 | |
---|
[399d65a] | 602 | static void jabber_chat_list_(struct im_connection *ic, const char *server) |
---|
| 603 | { |
---|
| 604 | struct jabber_data *jd = ic->proto_data; |
---|
| 605 | |
---|
| 606 | if (server && *server) { |
---|
| 607 | jabber_iq_disco_muc(ic, server); |
---|
| 608 | } else if (jd->muc_host && *jd->muc_host) { |
---|
| 609 | jabber_iq_disco_muc(ic, jd->muc_host); |
---|
| 610 | } else { |
---|
| 611 | /* throw an error here, don't query conference.[server] directly. |
---|
| 612 | * for things like jabber.org it gets you 18000 results of garbage */ |
---|
| 613 | imcb_error(ic, "Please specify a server name such as `conference.%s'", jd->server); |
---|
| 614 | } |
---|
| 615 | } |
---|
| 616 | |
---|
[5ebff60] | 617 | static void jabber_chat_msg_(struct groupchat *c, char *message, int flags) |
---|
[43671b9] | 618 | { |
---|
[5ebff60] | 619 | if (c && message) { |
---|
| 620 | jabber_chat_msg(c, message, flags); |
---|
| 621 | } |
---|
[43671b9] | 622 | } |
---|
| 623 | |
---|
[5ebff60] | 624 | static void jabber_chat_topic_(struct groupchat *c, char *topic) |
---|
[ef5c185] | 625 | { |
---|
[5ebff60] | 626 | if (c && topic) { |
---|
| 627 | jabber_chat_topic(c, topic); |
---|
| 628 | } |
---|
[ef5c185] | 629 | } |
---|
| 630 | |
---|
[5ebff60] | 631 | static void jabber_chat_leave_(struct groupchat *c) |
---|
[e35d1a1] | 632 | { |
---|
[5ebff60] | 633 | if (c) { |
---|
| 634 | jabber_chat_leave(c, NULL); |
---|
| 635 | } |
---|
[e35d1a1] | 636 | } |
---|
| 637 | |
---|
[5ebff60] | 638 | static void jabber_chat_invite_(struct groupchat *c, char *who, char *msg) |
---|
[c058ff9] | 639 | { |
---|
[68286eb] | 640 | struct jabber_data *jd = c->ic->proto_data; |
---|
[c058ff9] | 641 | struct jabber_chat *jc = c->data; |
---|
| 642 | gchar *msg_alt = NULL; |
---|
| 643 | |
---|
[5ebff60] | 644 | if (msg == NULL) { |
---|
| 645 | msg_alt = g_strdup_printf("%s invited you to %s", jd->me, jc->name); |
---|
| 646 | } |
---|
| 647 | |
---|
| 648 | if (c && who) { |
---|
| 649 | jabber_chat_invite(c, who, msg ? msg : msg_alt); |
---|
| 650 | } |
---|
| 651 | |
---|
| 652 | g_free(msg_alt); |
---|
[c058ff9] | 653 | } |
---|
| 654 | |
---|
[5ebff60] | 655 | static void jabber_keepalive(struct im_connection *ic) |
---|
[deff040] | 656 | { |
---|
| 657 | /* Just any whitespace character is enough as a keepalive for XMPP sessions. */ |
---|
[5ebff60] | 658 | if (!jabber_write(ic, "\n", 1)) { |
---|
[38ff846] | 659 | return; |
---|
[5ebff60] | 660 | } |
---|
| 661 | |
---|
[038d17f] | 662 | /* This runs the garbage collection every minute, which means every packet |
---|
| 663 | is in the cache for about a minute (which should be enough AFAIK). */ |
---|
[5ebff60] | 664 | jabber_cache_clean(ic); |
---|
[dd788bb] | 665 | } |
---|
| 666 | |
---|
[5ebff60] | 667 | static int jabber_send_typing(struct im_connection *ic, char *who, int typing) |
---|
[a21a8ac] | 668 | { |
---|
[0da65d5] | 669 | struct jabber_data *jd = ic->proto_data; |
---|
[0c78bb7] | 670 | struct jabber_buddy *bud, *bare; |
---|
[5ebff60] | 671 | |
---|
[a21a8ac] | 672 | /* Enable typing notification related code from now. */ |
---|
| 673 | jd->flags |= JFLAG_WANT_TYPING; |
---|
[5ebff60] | 674 | |
---|
[0c78bb7] | 675 | if ((bud = jabber_buddy_by_jid(ic, who, 0)) == NULL || |
---|
| 676 | (bare = jabber_buddy_by_jid(ic, who, GET_BUDDY_BARE)) == NULL) { |
---|
[788a1af] | 677 | /* Sending typing notifications to unknown buddies is |
---|
| 678 | unsupported for now. Shouldn't be a problem, I think. */ |
---|
| 679 | return 0; |
---|
| 680 | } |
---|
[5ebff60] | 681 | |
---|
[0c78bb7] | 682 | |
---|
| 683 | if (bud->flags & JBFLAG_DOES_XEP85 || bare->flags & JBFLAG_DOES_XEP85) { |
---|
[a21a8ac] | 684 | /* We're only allowed to send this stuff if we know the other |
---|
[0c78bb7] | 685 | side supports it. If the bare JID has the flag, all other |
---|
| 686 | resources get it, too (That is the case in gtalk) */ |
---|
[5ebff60] | 687 | |
---|
[a21a8ac] | 688 | struct xt_node *node; |
---|
| 689 | char *type; |
---|
| 690 | int st; |
---|
[5ebff60] | 691 | |
---|
| 692 | if (typing & OPT_TYPING) { |
---|
[a21a8ac] | 693 | type = "composing"; |
---|
[5ebff60] | 694 | } else if (typing & OPT_THINKING) { |
---|
[df1fb67] | 695 | type = "paused"; |
---|
[5ebff60] | 696 | } else { |
---|
[df1fb67] | 697 | type = "active"; |
---|
[5ebff60] | 698 | } |
---|
| 699 | |
---|
| 700 | node = xt_new_node(type, NULL, NULL); |
---|
| 701 | xt_add_attr(node, "xmlns", XMLNS_CHATSTATES); |
---|
| 702 | node = jabber_make_packet("message", "chat", bud->full_jid, node); |
---|
| 703 | |
---|
| 704 | st = jabber_write_packet(ic, node); |
---|
| 705 | xt_free_node(node); |
---|
| 706 | |
---|
[a21a8ac] | 707 | return st; |
---|
| 708 | } |
---|
[5ebff60] | 709 | |
---|
[a21a8ac] | 710 | return 1; |
---|
| 711 | } |
---|
| 712 | |
---|
[5ebff60] | 713 | void jabber_chat_add_settings(account_t *acc, set_t **head) |
---|
[6d544a1] | 714 | { |
---|
[3320d6d] | 715 | set_add(head, "always_use_nicks", "false", set_eval_bool, NULL); |
---|
| 716 | |
---|
[6d544a1] | 717 | /* Meh. Stupid room passwords. Not trying to obfuscate/hide |
---|
| 718 | them from the user for now. */ |
---|
[5ebff60] | 719 | set_add(head, "password", NULL, NULL, NULL); |
---|
[6d544a1] | 720 | } |
---|
| 721 | |
---|
[5ebff60] | 722 | void jabber_chat_free_settings(account_t *acc, set_t **head) |
---|
[6d544a1] | 723 | { |
---|
[3320d6d] | 724 | set_del(head, "always_use_nicks"); |
---|
| 725 | |
---|
[5ebff60] | 726 | set_del(head, "password"); |
---|
[6d544a1] | 727 | } |
---|
| 728 | |
---|
[5ebff60] | 729 | GList *jabber_buddy_action_list(bee_user_t *bu) |
---|
[d88c92a] | 730 | { |
---|
| 731 | static GList *ret = NULL; |
---|
[5ebff60] | 732 | |
---|
| 733 | if (ret == NULL) { |
---|
[a97a336] | 734 | static const struct buddy_action ba[2] = { |
---|
[d88c92a] | 735 | { "VERSION", "Get client (version) information" }, |
---|
| 736 | }; |
---|
[5ebff60] | 737 | |
---|
| 738 | ret = g_list_prepend(ret, (void *) ba + 0); |
---|
[d88c92a] | 739 | } |
---|
[5ebff60] | 740 | |
---|
[d88c92a] | 741 | return ret; |
---|
| 742 | } |
---|
| 743 | |
---|
[5ebff60] | 744 | void *jabber_buddy_action(struct bee_user *bu, const char *action, char * const args[], void *data) |
---|
[d88c92a] | 745 | { |
---|
[5ebff60] | 746 | if (g_strcasecmp(action, "VERSION") == 0) { |
---|
[d88c92a] | 747 | struct jabber_buddy *bud; |
---|
[5ebff60] | 748 | |
---|
| 749 | if ((bud = jabber_buddy_by_ext_jid(bu->ic, bu->handle, 0)) == NULL) { |
---|
| 750 | bud = jabber_buddy_by_jid(bu->ic, bu->handle, GET_BUDDY_FIRST); |
---|
| 751 | } |
---|
| 752 | for (; bud; bud = bud->next) { |
---|
| 753 | jabber_iq_version_send(bu->ic, bud, data); |
---|
| 754 | } |
---|
[d88c92a] | 755 | } |
---|
[5ebff60] | 756 | |
---|
[d88c92a] | 757 | return NULL; |
---|
| 758 | } |
---|
| 759 | |
---|
[5ebff60] | 760 | gboolean jabber_handle_is_self(struct im_connection *ic, const char *who) |
---|
| 761 | { |
---|
[be1efa3] | 762 | struct jabber_data *jd = ic->proto_data; |
---|
[5ebff60] | 763 | |
---|
| 764 | return ((g_strcasecmp(who, ic->acc->user) == 0) || |
---|
| 765 | (jd->internal_jid && |
---|
| 766 | g_strcasecmp(who, jd->internal_jid) == 0)); |
---|
[be1efa3] | 767 | } |
---|
| 768 | |
---|
[0da65d5] | 769 | void jabber_initmodule() |
---|
[f06894d] | 770 | { |
---|
[5ebff60] | 771 | struct prpl *ret = g_new0(struct prpl, 1); |
---|
[71074ac] | 772 | struct prpl *hipchat = NULL; |
---|
[5ebff60] | 773 | |
---|
[f06894d] | 774 | ret->name = "jabber"; |
---|
[6d544a1] | 775 | ret->mms = 0; /* no limit */ |
---|
[f06894d] | 776 | ret->login = jabber_login; |
---|
[0da65d5] | 777 | ret->init = jabber_init; |
---|
| 778 | ret->logout = jabber_logout; |
---|
[f6c963b] | 779 | ret->buddy_msg = jabber_buddy_msg; |
---|
[dd788bb] | 780 | ret->away_states = jabber_away_states; |
---|
| 781 | ret->set_away = jabber_set_away; |
---|
[f06894d] | 782 | // ret->set_info = jabber_set_info; |
---|
[038d17f] | 783 | ret->get_info = jabber_get_info; |
---|
[cfbb3a6] | 784 | ret->add_buddy = jabber_add_buddy; |
---|
| 785 | ret->remove_buddy = jabber_remove_buddy; |
---|
[43671b9] | 786 | ret->chat_msg = jabber_chat_msg_; |
---|
[ef5c185] | 787 | ret->chat_topic = jabber_chat_topic_; |
---|
[c058ff9] | 788 | ret->chat_invite = jabber_chat_invite_; |
---|
[e35d1a1] | 789 | ret->chat_leave = jabber_chat_leave_; |
---|
| 790 | ret->chat_join = jabber_chat_join_; |
---|
[fc0640e] | 791 | ret->chat_with = jabber_chat_with_; |
---|
[399d65a] | 792 | ret->chat_list = jabber_chat_list_; |
---|
[6d544a1] | 793 | ret->chat_add_settings = jabber_chat_add_settings; |
---|
| 794 | ret->chat_free_settings = jabber_chat_free_settings; |
---|
[deff040] | 795 | ret->keepalive = jabber_keepalive; |
---|
[a21a8ac] | 796 | ret->send_typing = jabber_send_typing; |
---|
[f06894d] | 797 | ret->handle_cmp = g_strcasecmp; |
---|
[be1efa3] | 798 | ret->handle_is_self = jabber_handle_is_self; |
---|
[2ff2076] | 799 | ret->transfer_request = jabber_si_transfer_request; |
---|
[d88c92a] | 800 | ret->buddy_action_list = jabber_buddy_action_list; |
---|
| 801 | ret->buddy_action = jabber_buddy_action; |
---|
[f06894d] | 802 | |
---|
[5ebff60] | 803 | register_protocol(ret); |
---|
[71074ac] | 804 | |
---|
| 805 | /* Another one for hipchat, which has completely different logins */ |
---|
| 806 | hipchat = g_memdup(ret, sizeof(struct prpl)); |
---|
| 807 | hipchat->name = "hipchat"; |
---|
| 808 | register_protocol(hipchat); |
---|
[f06894d] | 809 | } |
---|