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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
|
/*
* Purple's oscar protocol plugin
* This file is the legal property of its developers.
* Please see the AUTHORS file distributed alongside this file.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
/* From the oscar PRPL */
#include "oscar.h"
#include "peer.h"
/* From Purple */
#include "conversation.h"
#include "imgstore.h"
#include "util.h"
#define DIRECTIM_MAX_FILESIZE 52428800
/**
* Free any ODC related data and print a message to the conversation
* window based on conn->disconnect_reason.
*/
void
peer_odc_close(PeerConnection *conn)
{
gchar *tmp;
if (conn->disconnect_reason == OSCAR_DISCONNECT_REMOTE_CLOSED)
tmp = g_strdup(_("The remote user has closed the connection."));
else if (conn->disconnect_reason == OSCAR_DISCONNECT_REMOTE_REFUSED)
tmp = g_strdup(_("The remote user has declined your request."));
else if (conn->disconnect_reason == OSCAR_DISCONNECT_LOST_CONNECTION)
tmp = g_strdup_printf(_("Lost connection with the remote user:<br>%s"),
conn->error_message);
else if (conn->disconnect_reason == OSCAR_DISCONNECT_INVALID_DATA)
tmp = g_strdup(_("Received invalid data on connection with remote user."));
else if (conn->disconnect_reason == OSCAR_DISCONNECT_COULD_NOT_CONNECT)
tmp = g_strdup(_("Unable to establish a connection with the remote user."));
else
/*
* We shouldn't print a message for some disconnect_reasons.
* Like OSCAR_DISCONNECT_LOCAL_CLOSED.
*/
tmp = NULL;
if (tmp != NULL)
{
PurpleAccount *account;
PurpleConversation *conv;
account = purple_connection_get_account(conn->od->gc);
conv = purple_conversation_new(PURPLE_CONV_TYPE_IM, account, conn->bn);
purple_conversation_write(conv, NULL, tmp, PURPLE_MESSAGE_SYSTEM, time(NULL));
g_free(tmp);
}
if (conn->frame != NULL)
{
OdcFrame *frame;
frame = conn->frame;
g_free(frame->payload.data);
g_free(frame);
}
}
/**
* Write the given OdcFrame to a ByteStream and send it out
* on the established PeerConnection.
*/
static void
peer_odc_send(PeerConnection *conn, OdcFrame *frame)
{
PurpleAccount *account;
const char *username;
size_t length;
ByteStream bs;
purple_debug_info("oscar", "Outgoing ODC frame to %s with "
"type=0x%04x, flags=0x%04x, payload length=%u\n",
conn->bn, frame->type, frame->flags, frame->payload.len);
account = purple_connection_get_account(conn->od->gc);
username = purple_account_get_username(account);
memcpy(frame->bn, username, strlen(username));
memcpy(frame->cookie, conn->cookie, 8);
length = 76;
byte_stream_new(&bs, length + frame->payload.len);
byte_stream_putraw(&bs, conn->magic, 4);
byte_stream_put16(&bs, length);
byte_stream_put16(&bs, frame->type);
byte_stream_put16(&bs, frame->subtype);
byte_stream_put16(&bs, 0x0000);
byte_stream_putraw(&bs, frame->cookie, 8);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, 0x0000);
byte_stream_put32(&bs, frame->payload.len);
byte_stream_put16(&bs, frame->encoding);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, frame->flags);
byte_stream_put16(&bs, 0x0000);
byte_stream_put16(&bs, 0x0000);
byte_stream_putraw(&bs, frame->bn, 32);
byte_stream_putraw(&bs, frame->payload.data, frame->payload.len);
peer_connection_send(conn, &bs);
byte_stream_destroy(&bs);
}
/**
* Send a very basic ODC frame (which contains the cookie) so that the
* remote user can verify that we are the person they were expecting.
* If we made an outgoing connection to then remote user, then we send
* this immediately. If the remote user connected to us, then we wait
* for the other person to send this to us, then we send one to them.
*/
void
peer_odc_send_cookie(PeerConnection *conn)
{
OdcFrame frame;
memset(&frame, 0, sizeof(OdcFrame));
frame.type = 0x0001;
frame.subtype = 0x0006;
frame.flags = 0x0060; /* Maybe this means "we're sending the cookie"? */
peer_odc_send(conn, &frame);
}
/**
* Send client-to-client typing notification over an established direct connection.
*/
void
peer_odc_send_typing(PeerConnection *conn, PurpleTypingState typing)
{
OdcFrame frame;
memset(&frame, 0, sizeof(OdcFrame));
frame.type = 0x0001;
frame.subtype = 0x0006;
if (typing == PURPLE_TYPING)
frame.flags = 0x0002 | 0x0008;
else if (typing == PURPLE_TYPED)
frame.flags = 0x0002 | 0x0004;
else
frame.flags = 0x0002;
peer_odc_send(conn, &frame);
}
/**
* Send client-to-client IM over an established direct connection.
* To send a direct IM, call this just like you would aim_send_im.
*
* @param conn The already-connected ODC connection.
* @param msg Null-terminated string to send.
* @param len The length of the message to send, including binary data.
* @param encoding See the AIM_CHARSET_* defines in oscar.h
* @param autoreply TRUE if this is any auto-reply.
*/
void
peer_odc_send_im(PeerConnection *conn, const char *msg, int len, int encoding, gboolean autoreply)
{
OdcFrame frame;
g_return_if_fail(msg != NULL);
g_return_if_fail(len > 0);
memset(&frame, 0, sizeof(OdcFrame));
frame.type = 0x0001;
frame.subtype = 0x0006;
frame.payload.len = len;
frame.encoding = encoding;
frame.flags = autoreply;
byte_stream_new(&frame.payload, len);
byte_stream_putraw(&frame.payload, (guint8 *)msg, len);
peer_odc_send(conn, &frame);
g_free(frame.payload.data);
}
struct embedded_data
{
size_t size;
const guint8 *data;
};
/**
* This is called after a direct IM has been received in its entirety. This
* function is passed a long chunk of data which contains the IM with any
* data chunks (images) appended to it.
*
* This function rips out all the data chunks and creates an imgstore for
* each one. In order to do this, it first goes through the IM and takes
* out all the IMG tags. When doing so, it rewrites the original IMG tag
* with one compatible with the imgstore Purple core code. For each one, we
* then read in chunks of data from the end of the message and actually
* create the img store using the given data.
*
* For somewhat easy reference, here's a sample message
* (with added whitespace):
*
* <HTML><BODY BGCOLOR="#ffffff">
* <FONT LANG="0">
* This is a really stupid picture:<BR>
* <IMG SRC="Sample.jpg" ID="1" WIDTH="283" HEIGHT="212" DATASIZE="9894"><BR>
* Yeah it is<BR>
* Here is another one:<BR>
* <IMG SRC="Soap Bubbles.bmp" ID="2" WIDTH="256" HEIGHT="256" DATASIZE="65978">
* </FONT>
* </BODY></HTML>
* <BINARY>
* <DATA ID="1" SIZE="9894">datadatadatadata</DATA>
* <DATA ID="2" SIZE="65978">datadatadatadata</DATA>
* </BINARY>
*/
static void
peer_odc_handle_payload(PeerConnection *conn, const char *msg, size_t len, int encoding, gboolean autoreply)
{
PurpleConnection *gc;
PurpleAccount *account;
const char *msgend, *binary_start, *dataend;
const char *tmp, *start, *end, *idstr, *src, *sizestr;
GData *attributes;
GHashTable *embedded_datas;
struct embedded_data *embedded_data;
GSList *images;
gchar *utf8;
GString *newmsg;
PurpleMessageFlags imflags;
gc = conn->od->gc;
account = purple_connection_get_account(gc);
dataend = msg + len;
/*
* Create a hash table containing references to each embedded
* data chunk. The key is the "ID" and the value is an
* embedded_data struct.
*/
embedded_datas = g_hash_table_new_full(g_direct_hash,
g_direct_equal, NULL, g_free);
/*
* Create an index of any binary chunks. If we run into any
* problems while parsing the binary data section then we stop
* parsing it, and the local user will see broken image icons.
*/
/* TODO: Use a length argument when looking for the <binary> tag! */
binary_start = purple_strcasestr(msg, "<binary>");
if (binary_start == NULL)
msgend = dataend;
else
{
msgend = binary_start;
/* Move our pointer to immediately after the <binary> tag */
tmp = binary_start + 8;
/* The embedded binary markup has a mimimum length of 29 bytes */
/* TODO: Use a length argument when looking for the <data> tag! */
while ((tmp + 29 <= dataend) &&
purple_markup_find_tag("data", tmp, &start, &tmp, &attributes))
{
unsigned int id;
size_t size;
/* Move the binary pointer from ">" to the start of the data */
tmp++;
/* Get the ID */
idstr = g_datalist_get_data(&attributes, "id");
if (idstr == NULL)
{
g_datalist_clear(&attributes);
break;
}
id = atoi(idstr);
/* Get the size */
sizestr = g_datalist_get_data(&attributes, "size");
if (sizestr == NULL)
{
g_datalist_clear(&attributes);
break;
}
size = atol(sizestr);
g_datalist_clear(&attributes);
if ((size > 0) && (tmp + size > dataend))
break;
embedded_data = g_new(struct embedded_data, 1);
embedded_data->size = size;
embedded_data->data = (const guint8 *)tmp;
tmp += size;
/* Skip past the closing </data> tag */
if (g_ascii_strncasecmp(tmp, "</data>", 7))
{
g_free(embedded_data);
break;
}
tmp += 7;
g_hash_table_insert(embedded_datas,
GINT_TO_POINTER(id), embedded_data);
}
}
/*
* Loop through the message, replacing OSCAR img tags with the
* equivalent Purple img tag.
*/
images = NULL;
newmsg = g_string_new("");
tmp = msg;
while (purple_markup_find_tag("img", tmp, &start, &end, &attributes))
{
int imgid = 0;
idstr = g_datalist_get_data(&attributes, "id");
src = g_datalist_get_data(&attributes, "src");
sizestr = g_datalist_get_data(&attributes, "datasize");
if ((idstr != NULL) && (src != NULL) && (sizestr!= NULL))
{
unsigned int id;
size_t size;
id = atoi(idstr);
size = atol(sizestr);
embedded_data = g_hash_table_lookup(embedded_datas,
GINT_TO_POINTER(id));
if ((embedded_data != NULL) && (embedded_data->size == size))
{
imgid = purple_imgstore_add_with_id(g_memdup(embedded_data->data, size), size, src);
/* Record the image number */
images = g_slist_append(images, GINT_TO_POINTER(imgid));
}
}
/* Delete the attribute list */
g_datalist_clear(&attributes);
/* Append the message up to the tag */
utf8 = purple_plugin_oscar_decode_im_part(account, conn->bn,
encoding, 0x0000, tmp, start - tmp);
if (utf8 != NULL) {
g_string_append(newmsg, utf8);
g_free(utf8);
}
if (imgid != 0)
{
/* Write the new image tag */
g_string_append_printf(newmsg, "<IMG ID=\"%d\">", imgid);
}
/* Continue from the end of the tag */
tmp = end + 1;
}
/* Append any remaining message data */
if (tmp <= msgend)
{
utf8 = purple_plugin_oscar_decode_im_part(account, conn->bn,
encoding, 0x0000, tmp, msgend - tmp);
if (utf8 != NULL) {
g_string_append(newmsg, utf8);
g_free(utf8);
}
}
/* Display the message we received */
imflags = 0;
if (images != NULL)
imflags |= PURPLE_MESSAGE_IMAGES;
if (autoreply)
imflags |= PURPLE_MESSAGE_AUTO_RESP;
serv_got_im(gc, conn->bn, newmsg->str, imflags, time(NULL));
g_string_free(newmsg, TRUE);
/* unref any images we allocated */
if (images)
{
GSList *l;
for (l = images; l != NULL; l = l->next)
purple_imgstore_unref_by_id(GPOINTER_TO_INT(l->data));
g_slist_free(images);
}
/* Delete our list of pointers to embedded images */
g_hash_table_destroy(embedded_datas);
}
/**
* This is a purple_input_add() watcher callback function for reading
* direct IM payload data. "Payload data" is always an IM and
* maybe some embedded images or files or something. The actual
* ODC frame is read using peer_connection_recv_cb(). We temporarily
* switch to this watcher callback ONLY to read the payload, and we
* switch back once we're done.
*/
static void
peer_odc_recv_cb(gpointer data, gint source, PurpleInputCondition cond)
{
PeerConnection *conn;
OdcFrame *frame;
ByteStream *bs;
gssize read;
conn = data;
frame = conn->frame;
bs = &frame->payload;
/* Read data into the temporary buffer until it is complete */
read = recv(conn->fd,
&bs->data[bs->offset],
bs->len - bs->offset,
0);
/* Check if the remote user closed the connection */
if (read == 0)
{
peer_connection_destroy(conn, OSCAR_DISCONNECT_REMOTE_CLOSED, NULL);
return;
}
if (read < 0)
{
if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
/* No worries */
return;
peer_connection_destroy(conn,
OSCAR_DISCONNECT_LOST_CONNECTION, g_strerror(errno));
return;
}
bs->offset += read;
if (bs->offset < bs->len)
/* Waiting for more data to arrive */
return;
/* We have a complete ODC/OFT frame! Handle it and continue reading */
byte_stream_rewind(bs);
peer_odc_handle_payload(conn, (const char *)bs->data,
bs->len, frame->encoding, frame->flags & 0x0001);
g_free(bs->data);
bs->data = NULL;
g_free(frame);
conn->frame = NULL;
purple_input_remove(conn->watcher_incoming);
conn->watcher_incoming = purple_input_add(conn->fd,
PURPLE_INPUT_READ, peer_connection_recv_cb, conn);
}
/**
* Handle an incoming OdcFrame. If there is a payload associated
* with this frame, then we remove the old watcher and add the
* ODC watcher to read in the payload.
*/
void
peer_odc_recv_frame(PeerConnection *conn, ByteStream *bs)
{
PurpleConnection *gc;
OdcFrame *frame;
gc = conn->od->gc;
frame = g_new0(OdcFrame, 1);
frame->type = byte_stream_get16(bs);
frame->subtype = byte_stream_get16(bs);
byte_stream_advance(bs, 2);
byte_stream_getrawbuf(bs, frame->cookie, 8);
byte_stream_advance(bs, 8);
frame->payload.len = byte_stream_get32(bs);
frame->encoding = byte_stream_get16(bs);
byte_stream_advance(bs, 4);
frame->flags = byte_stream_get16(bs);
byte_stream_advance(bs, 4);
byte_stream_getrawbuf(bs, frame->bn, 32);
purple_debug_info("oscar", "Incoming ODC frame from %s with "
"type=0x%04x, flags=0x%04x, payload length=%u\n",
frame->bn, frame->type, frame->flags, frame->payload.len);
if (!conn->ready)
{
/*
* We need to verify the cookie so that we know we are
* connected to our friend and not a malicious middle man.
*/
PurpleAccount *account;
PurpleConversation *conv;
if (conn->flags & PEER_CONNECTION_FLAG_IS_INCOMING)
{
if (memcmp(conn->cookie, frame->cookie, 8))
{
/*
* Oh no! The user that connected to us did not send
* the correct cookie! They are not our friend. Go try
* to accept another connection?
*/
purple_debug_info("oscar", "Received an incorrect cookie. "
"Closing connection.\n");
peer_connection_destroy(conn,
OSCAR_DISCONNECT_INVALID_DATA, NULL);
g_free(frame);
return;
}
/*
* Ok, we know they are legit. Now be courteous and
* send them our cookie. Note: This doesn't seem
* to be necessary, but it also doesn't seem to hurt.
*/
peer_odc_send_cookie(conn);
}
conn->ready = TRUE;
/*
* If they connected to us then close the listener socket
* and send them our cookie.
*/
if (conn->listenerfd != -1)
{
close(conn->listenerfd);
conn->listenerfd = -1;
}
/* Tell the local user that we are connected */
account = purple_connection_get_account(gc);
conv = purple_conversation_new(PURPLE_CONV_TYPE_IM, account, conn->bn);
purple_conversation_write(conv, NULL, _("Direct IM established"),
PURPLE_MESSAGE_SYSTEM, time(NULL));
}
if ((frame->type != 0x0001) && (frame->subtype != 0x0006))
{
purple_debug_info("oscar", "Unknown ODC frame type 0x%04hx, "
"subtype 0x%04hx.\n", frame->type, frame->subtype);
g_free(frame);
return;
}
if (frame->flags & 0x0008)
{
/* I had to leave this. It's just too funny. It reminds me of my sister. */
purple_debug_info("oscar", "ohmigod! %s has started typing "
"(DirectIM). He's going to send you a message! "
"*squeal*\n", conn->bn);
serv_got_typing(gc, conn->bn, 0, PURPLE_TYPING);
}
else if (frame->flags & 0x0004)
{
serv_got_typing(gc, conn->bn, 0, PURPLE_TYPED);
}
else
{
serv_got_typing_stopped(gc, conn->bn);
}
if (frame->payload.len > 0)
{
if (frame->payload.len > DIRECTIM_MAX_FILESIZE)
{
gchar *tmp, *size1, *size2;
PurpleAccount *account;
PurpleConversation *conv;
size1 = purple_str_size_to_units(frame->payload.len);
size2 = purple_str_size_to_units(DIRECTIM_MAX_FILESIZE);
tmp = g_strdup_printf(_("%s tried to send you a %s file, but we only allow files up to %s over Direct IM. Try using file transfer instead.\n"), conn->bn, size1, size2);
g_free(size1);
g_free(size2);
account = purple_connection_get_account(conn->od->gc);
conv = purple_conversation_new(PURPLE_CONV_TYPE_IM, account, conn->bn);
purple_conversation_write(conv, NULL, tmp, PURPLE_MESSAGE_SYSTEM, time(NULL));
g_free(tmp);
peer_connection_destroy(conn, OSCAR_DISCONNECT_LOCAL_CLOSED, NULL);
g_free(frame);
return;
}
/* We have payload data! Switch to the ODC watcher to read it. */
frame->payload.data = g_new(guint8, frame->payload.len);
frame->payload.offset = 0;
conn->frame = frame;
purple_input_remove(conn->watcher_incoming);
conn->watcher_incoming = purple_input_add(conn->fd,
PURPLE_INPUT_READ, peer_odc_recv_cb, conn);
return;
}
g_free(frame);
}
|