* @file ft.c File Transfer API * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * This program 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 General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA #define FT_INITIAL_BUFFER_SIZE 4096 #define FT_MAX_BUFFER_SIZE 65535 static PurpleXferUiOps *xfer_ui_ops = NULL; * A hack to store more data since we can't extend the size of PurpleXfer static GHashTable *xfers_data = NULL; typedef struct _PurpleXferPrivData { * Used to moderate the file transfer when either the read/write ui_ops are * set or fd is not set. In those cases, the UI/prpl call the respective * function, which is somewhat akin to a fd watch being triggered. PURPLE_XFER_READY_NONE = 0x0, PURPLE_XFER_READY_UI = 0x1, PURPLE_XFER_READY_PRPL = 0x2, /* TODO: Should really use a PurpleCircBuffer for this. */ gpointer thumbnail_data; /**< thumbnail image */ gchar *thumbnail_mimetype; static int purple_xfer_choose_file(PurpleXfer *xfer); purple_xfer_priv_data_destroy(gpointer data) PurpleXferPrivData *priv = data; g_byte_array_free(priv->buffer, TRUE); g_free(priv->thumbnail_data); g_free(priv->thumbnail_mimetype); purple_xfer_status_type_to_string(PurpleXferStatusType type) PurpleXferStatusType type; { PURPLE_XFER_STATUS_UNKNOWN, "unknown" }, { PURPLE_XFER_STATUS_NOT_STARTED, "not started" }, { PURPLE_XFER_STATUS_ACCEPTED, "accepted" }, { PURPLE_XFER_STATUS_STARTED, "started" }, { PURPLE_XFER_STATUS_DONE, "done" }, { PURPLE_XFER_STATUS_CANCEL_LOCAL, "cancelled locally" }, { PURPLE_XFER_STATUS_CANCEL_REMOTE, "cancelled remotely" } for (i = 0; i < G_N_ELEMENTS(type_names); ++i) if (type_names[i].type == type) return type_names[i].name; purple_xfer_new(PurpleAccount *account, PurpleXferType type, const char *who) PurpleXferPrivData *priv; g_return_val_if_fail(type != PURPLE_XFER_UNKNOWN, NULL); g_return_val_if_fail(account != NULL, NULL); g_return_val_if_fail(who != NULL, NULL); xfer = g_new0(PurpleXfer, 1); PURPLE_DBUS_REGISTER_POINTER(xfer, PurpleXfer); xfer->who = g_strdup(who); xfer->ui_ops = ui_ops = purple_xfers_get_ui_ops(); xfer->current_buffer_size = FT_INITIAL_BUFFER_SIZE; priv = g_new0(PurpleXferPrivData, 1); priv->ready = PURPLE_XFER_READY_NONE; if (ui_ops && ui_ops->data_not_sent) { /* If the ui will handle unsent data no need for buffer */ priv->buffer = g_byte_array_sized_new(FT_INITIAL_BUFFER_SIZE); g_hash_table_insert(xfers_data, xfer, priv); ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->new_xfer != NULL) xfers = g_list_prepend(xfers, xfer); if (purple_debug_is_verbose()) purple_debug_info("xfer", "new %p [%d]\n", xfer, xfer->ref); purple_xfer_destroy(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); if (purple_debug_is_verbose()) purple_debug_info("xfer", "destroyed %p [%d]\n", xfer, xfer->ref); /* Close the file browser, if it's open */ purple_request_close_with_handle(xfer); if (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_STARTED) purple_xfer_cancel_local(xfer); ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->destroy != NULL) g_free(xfer->local_filename); g_hash_table_remove(xfers_data, xfer); PURPLE_DBUS_UNREGISTER_POINTER(xfer); xfers = g_list_remove(xfers, xfer); purple_xfer_ref(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); if (purple_debug_is_verbose()) purple_debug_info("xfer", "ref'd %p [%d]\n", xfer, xfer->ref); purple_xfer_unref(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); g_return_if_fail(xfer->ref > 0); if (purple_debug_is_verbose()) purple_debug_info("xfer", "unref'd %p [%d]\n", xfer, xfer->ref); purple_xfer_destroy(xfer); purple_xfer_set_status(PurpleXfer *xfer, PurpleXferStatusType status) g_return_if_fail(xfer != NULL); if (purple_debug_is_verbose()) purple_debug_info("xfer", "Changing status of xfer %p from %s to %s\n", xfer, purple_xfer_status_type_to_string(xfer->status), purple_xfer_status_type_to_string(status)); if (xfer->status == status) if(xfer->type == PURPLE_XFER_SEND) { case PURPLE_XFER_STATUS_ACCEPTED: purple_signal_emit(purple_xfers_get_handle(), "file-send-accept", xfer); case PURPLE_XFER_STATUS_STARTED: purple_signal_emit(purple_xfers_get_handle(), "file-send-start", xfer); case PURPLE_XFER_STATUS_DONE: purple_signal_emit(purple_xfers_get_handle(), "file-send-complete", xfer); case PURPLE_XFER_STATUS_CANCEL_LOCAL: case PURPLE_XFER_STATUS_CANCEL_REMOTE: purple_signal_emit(purple_xfers_get_handle(), "file-send-cancel", xfer); } else if(xfer->type == PURPLE_XFER_RECEIVE) { case PURPLE_XFER_STATUS_ACCEPTED: purple_signal_emit(purple_xfers_get_handle(), "file-recv-accept", xfer); case PURPLE_XFER_STATUS_STARTED: purple_signal_emit(purple_xfers_get_handle(), "file-recv-start", xfer); case PURPLE_XFER_STATUS_DONE: purple_signal_emit(purple_xfers_get_handle(), "file-recv-complete", xfer); case PURPLE_XFER_STATUS_CANCEL_LOCAL: case PURPLE_XFER_STATUS_CANCEL_REMOTE: purple_signal_emit(purple_xfers_get_handle(), "file-recv-cancel", xfer); purple_xfer_conversation_write_internal(PurpleXfer *xfer, const char *message, gboolean is_error, gboolean print_thumbnail) PurpleConversation *conv = NULL; PurpleMessageFlags flags = PURPLE_MESSAGE_SYSTEM; gconstpointer thumbnail_data; g_return_if_fail(xfer != NULL); g_return_if_fail(message != NULL); thumbnail_data = purple_xfer_get_thumbnail(xfer, &size); conv = purple_find_conversation_with_account(PURPLE_CONV_TYPE_IM, xfer->who, purple_xfer_get_account(xfer)); escaped = g_markup_escape_text(message, -1); flags |= PURPLE_MESSAGE_ERROR; if (print_thumbnail && thumbnail_data) { gpointer data = g_memdup(thumbnail_data, size); int id = purple_imgstore_add_with_id(data, size, NULL); g_strdup_printf("<img id='%d'> %s", id, escaped); purple_conversation_write(conv, NULL, message_with_img, flags, purple_imgstore_unref_by_id(id); g_free(message_with_img); purple_conversation_write(conv, NULL, escaped, flags, time(NULL)); purple_xfer_conversation_write(PurpleXfer *xfer, gchar *message, purple_xfer_conversation_write_internal(xfer, message, is_error, FALSE); /* maybe this one should be exported publically? */ purple_xfer_conversation_write_with_thumbnail(PurpleXfer *xfer, purple_xfer_conversation_write_internal(xfer, message, FALSE, TRUE); static void purple_xfer_show_file_error(PurpleXfer *xfer, const char *filename) gchar *msg = NULL, *utf8; PurpleXferType xfer_type = purple_xfer_get_type(xfer); PurpleAccount *account = purple_xfer_get_account(xfer); utf8 = g_filename_to_utf8(filename, -1, NULL, NULL, NULL); msg = g_strdup_printf(_("Error reading %s: \n%s.\n"), case PURPLE_XFER_RECEIVE: msg = g_strdup_printf(_("Error writing %s: \n%s.\n"), msg = g_strdup_printf(_("Error accessing %s: \n%s.\n"), purple_xfer_conversation_write(xfer, msg, TRUE); purple_xfer_error(xfer_type, account, xfer->who, msg); purple_xfer_choose_file_ok_cb(void *user_data, const char *filename) xfer = (PurpleXfer *)user_data; type = purple_xfer_get_type(xfer); if (g_stat(filename, &st) != 0) { if (type == PURPLE_XFER_RECEIVE) { dir = g_path_get_dirname(filename); if (g_access(dir, mode) == 0) { purple_xfer_request_accepted(xfer, filename); NULL, PURPLE_NOTIFY_MSG_ERROR, NULL, _("Directory is not writable."), NULL, (PurpleNotifyCloseCallback)purple_xfer_choose_file, xfer); purple_xfer_show_file_error(xfer, filename); purple_xfer_cancel_local(xfer); else if ((type == PURPLE_XFER_SEND) && (st.st_size == 0)) { purple_notify_error(NULL, NULL, _("Cannot send a file of 0 bytes."), NULL); purple_xfer_cancel_local(xfer); else if ((type == PURPLE_XFER_SEND) && S_ISDIR(st.st_mode)) { * XXX - Sending a directory should be valid for some protocols. purple_notify_error(NULL, NULL, _("Cannot send a directory."), NULL); purple_xfer_cancel_local(xfer); else if ((type == PURPLE_XFER_RECEIVE) && S_ISDIR(st.st_mode)) { utf8 = g_filename_to_utf8(filename, -1, NULL, NULL, NULL); _("%s is not a regular file. Cowardly refusing to overwrite it.\n"), utf8); purple_notify_error(NULL, NULL, msg, NULL); purple_xfer_request_denied(xfer); else if (type == PURPLE_XFER_SEND) { if (g_access(filename, mode) == 0) { purple_xfer_request_accepted(xfer, filename); NULL, PURPLE_NOTIFY_MSG_ERROR, NULL, _("File is not readable."), NULL, (PurpleNotifyCloseCallback)purple_xfer_choose_file, xfer); purple_xfer_request_accepted(xfer, filename); purple_xfer_choose_file_cancel_cb(void *user_data, const char *filename) PurpleXfer *xfer = (PurpleXfer *)user_data; purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_CANCEL_LOCAL); if (purple_xfer_get_type(xfer) == PURPLE_XFER_SEND) purple_xfer_cancel_local(xfer); purple_xfer_request_denied(xfer); purple_xfer_choose_file(PurpleXfer *xfer) purple_request_file(xfer, NULL, purple_xfer_get_filename(xfer), (purple_xfer_get_type(xfer) == PURPLE_XFER_RECEIVE), G_CALLBACK(purple_xfer_choose_file_ok_cb), G_CALLBACK(purple_xfer_choose_file_cancel_cb), purple_xfer_get_account(xfer), xfer->who, NULL, cancel_recv_cb(PurpleXfer *xfer) purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_CANCEL_LOCAL); purple_xfer_request_denied(xfer); purple_xfer_ask_recv(PurpleXfer *xfer) /* If we have already accepted the request, ask the destination file if (purple_xfer_get_status(xfer) != PURPLE_XFER_STATUS_ACCEPTED) { PurpleBuddy *buddy = purple_find_buddy(xfer->account, xfer->who); if (purple_xfer_get_filename(xfer) != NULL) size = purple_xfer_get_size(xfer); size_buf = purple_str_size_to_units(size); buf = g_strdup_printf(_("%s wants to send you %s (%s)"), buddy ? purple_buddy_get_alias(buddy) : xfer->who, purple_xfer_get_filename(xfer), size_buf); buf = g_strdup_printf(_("%s wants to send you a file"), buddy ? purple_buddy_get_alias(buddy) : xfer->who); if (xfer->message != NULL) serv_got_im(purple_account_get_connection(xfer->account), xfer->who, xfer->message, 0, time(NULL)); if ((thumb = purple_xfer_get_thumbnail(xfer, &thumb_size))) { purple_request_accept_cancel_with_icon(xfer, NULL, buf, NULL, PURPLE_DEFAULT_ACTION_NONE, xfer->account, xfer->who, NULL, G_CALLBACK(purple_xfer_choose_file), G_CALLBACK(cancel_recv_cb)); purple_request_accept_cancel(xfer, NULL, buf, NULL, PURPLE_DEFAULT_ACTION_NONE, xfer->account, xfer->who, NULL, xfer, G_CALLBACK(purple_xfer_choose_file), G_CALLBACK(cancel_recv_cb)); purple_xfer_choose_file(xfer); ask_accept_ok(PurpleXfer *xfer) purple_xfer_request_accepted(xfer, NULL); ask_accept_cancel(PurpleXfer *xfer) purple_xfer_request_denied(xfer); purple_xfer_ask_accept(PurpleXfer *xfer) PurpleBuddy *buddy = purple_find_buddy(xfer->account, xfer->who); buf = g_strdup_printf(_("Accept file transfer request from %s?"), buddy ? purple_buddy_get_alias(buddy) : xfer->who); if (purple_xfer_get_remote_ip(xfer) && purple_xfer_get_remote_port(xfer)) buf2 = g_strdup_printf(_("A file is available for download from:\n" "Remote host: %s\nRemote port: %d"), purple_xfer_get_remote_ip(xfer), purple_xfer_get_remote_port(xfer)); purple_request_accept_cancel(xfer, NULL, buf, buf2, PURPLE_DEFAULT_ACTION_NONE, xfer->account, xfer->who, NULL, G_CALLBACK(ask_accept_ok), G_CALLBACK(ask_accept_cancel)); purple_xfer_request(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); g_return_if_fail(xfer->ops.init != NULL); if (purple_xfer_get_type(xfer) == PURPLE_XFER_RECEIVE) purple_signal_emit(purple_xfers_get_handle(), "file-recv-request", xfer); if (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_CANCEL_LOCAL) /* The file-transfer was cancelled by a plugin */ purple_xfer_cancel_local(xfer); else if (purple_xfer_get_filename(xfer) || purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_ACCEPTED) PurpleBuddy *buddy = purple_find_buddy(xfer->account, xfer->who); message = g_strdup_printf(_("%s is offering to send file %s"), buddy ? purple_buddy_get_alias(buddy) : xfer->who, purple_xfer_get_filename(xfer)); purple_xfer_conversation_write_with_thumbnail(xfer, message); /* Ask for a filename to save to if it's not already given by a plugin */ if (xfer->local_filename == NULL) purple_xfer_ask_recv(xfer); purple_xfer_ask_accept(xfer); purple_xfer_choose_file(xfer); purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename) type = purple_xfer_get_type(xfer); account = purple_xfer_get_account(xfer); purple_debug_misc("xfer", "request accepted for %p\n", xfer); if (!filename && type == PURPLE_XFER_RECEIVE) { xfer->status = PURPLE_XFER_STATUS_ACCEPTED; buddy = purple_find_buddy(account, xfer->who); if (type == PURPLE_XFER_SEND) { /* Check the filename. */ ui_ops = purple_xfer_get_ui_ops(xfer); if (g_strrstr(filename, "../") || g_strrstr(filename, "..\\")) if (g_strrstr(filename, "../")) utf8 = g_filename_to_utf8(filename, -1, NULL, NULL, NULL); msg = g_strdup_printf(_("%s is not a valid filename.\n"), utf8); purple_xfer_error(type, account, xfer->who, msg); if (ui_ops == NULL || (ui_ops->ui_read == NULL && ui_ops->ui_write == NULL)) { if (g_stat(filename, &st) == -1) { purple_xfer_show_file_error(xfer, filename); purple_xfer_set_local_filename(xfer, filename); purple_xfer_set_size(xfer, st.st_size); purple_xfer_set_local_filename(xfer, filename); base = g_path_get_basename(filename); utf8 = g_filename_to_utf8(base, -1, NULL, NULL, NULL); purple_xfer_set_filename(xfer, utf8); msg = g_strdup_printf(_("Offering to send %s to %s"), utf8, buddy ? purple_buddy_get_alias(buddy) : xfer->who); purple_xfer_conversation_write(xfer, msg, FALSE); xfer->status = PURPLE_XFER_STATUS_ACCEPTED; purple_xfer_set_local_filename(xfer, filename); msg = g_strdup_printf(_("Starting transfer of %s from %s"), xfer->filename, buddy ? purple_buddy_get_alias(buddy) : xfer->who); purple_xfer_conversation_write(xfer, msg, FALSE); purple_xfer_request_denied(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); purple_debug_misc("xfer", "xfer %p denied\n", xfer); if (xfer->ops.request_denied != NULL) xfer->ops.request_denied(xfer); purple_xfer_get_type(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, PURPLE_XFER_UNKNOWN); purple_xfer_get_account(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); purple_xfer_get_remote_user(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); purple_xfer_get_status(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, PURPLE_XFER_STATUS_UNKNOWN); /* FIXME: Rename with cancelled for 3.0.0. */ purple_xfer_is_canceled(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, TRUE); if ((purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_CANCEL_LOCAL) || (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_CANCEL_REMOTE)) purple_xfer_is_completed(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, TRUE); return (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_DONE); purple_xfer_get_filename(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); purple_xfer_get_local_filename(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); return xfer->local_filename; purple_xfer_get_bytes_sent(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0); purple_xfer_get_bytes_remaining(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0); return xfer->bytes_remaining; purple_xfer_get_size(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0); purple_xfer_get_progress(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0.0); if (purple_xfer_get_size(xfer) == 0) return ((double)purple_xfer_get_bytes_sent(xfer) / (double)purple_xfer_get_size(xfer)); purple_xfer_get_local_port(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, -1); purple_xfer_get_remote_ip(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); purple_xfer_get_remote_port(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, -1); return xfer->remote_port; purple_xfer_get_start_time(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0); purple_xfer_get_end_time(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, 0); purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed) g_return_if_fail(xfer != NULL); PurpleConversation *conv; purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_DONE); if (purple_xfer_get_filename(xfer) != NULL) char *filename = g_markup_escape_text(purple_xfer_get_filename(xfer), -1); if (purple_xfer_get_local_filename(xfer) && purple_xfer_get_type(xfer) == PURPLE_XFER_RECEIVE) char *local = g_markup_escape_text(purple_xfer_get_local_filename(xfer), -1); msg = g_strdup_printf(_("Transfer of file <A HREF=\"file://%s\">%s</A> complete"), msg = g_strdup_printf(_("Transfer of file %s complete"), msg = g_strdup(_("File transfer complete")); conv = purple_find_conversation_with_account(PURPLE_CONV_TYPE_IM, xfer->who, purple_xfer_get_account(xfer)); purple_conversation_write(conv, NULL, msg, PURPLE_MESSAGE_SYSTEM, time(NULL)); ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->update_progress != NULL) ui_ops->update_progress(xfer, purple_xfer_get_progress(xfer)); purple_xfer_set_message(PurpleXfer *xfer, const char *message) g_return_if_fail(xfer != NULL); xfer->message = g_strdup(message); purple_xfer_set_filename(PurpleXfer *xfer, const char *filename) g_return_if_fail(xfer != NULL); xfer->filename = g_strdup(filename); purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename) g_return_if_fail(xfer != NULL); g_free(xfer->local_filename); xfer->local_filename = g_strdup(filename); purple_xfer_set_size(PurpleXfer *xfer, size_t size) g_return_if_fail(xfer != NULL); xfer->bytes_remaining = xfer->size - purple_xfer_get_bytes_sent(xfer); purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent) g_return_if_fail(xfer != NULL); xfer->bytes_sent = bytes_sent; xfer->bytes_remaining = purple_xfer_get_size(xfer) - bytes_sent; purple_xfer_get_ui_ops(const PurpleXfer *xfer) g_return_val_if_fail(xfer != NULL, NULL); purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); xfer->ops.request_denied = fnc; purple_xfer_set_read_fnc(PurpleXfer *xfer, gssize (*fnc)(guchar **, PurpleXfer *)) g_return_if_fail(xfer != NULL); purple_xfer_set_write_fnc(PurpleXfer *xfer, gssize (*fnc)(const guchar *, size_t, PurpleXfer *)) g_return_if_fail(xfer != NULL); purple_xfer_set_ack_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *, const guchar *, size_t)) g_return_if_fail(xfer != NULL); purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); xfer->ops.cancel_send = fnc; purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *)) g_return_if_fail(xfer != NULL); xfer->ops.cancel_recv = fnc; purple_xfer_increase_buffer_size(PurpleXfer *xfer) xfer->current_buffer_size = MIN(xfer->current_buffer_size * 1.5, purple_xfer_read(PurpleXfer *xfer, guchar **buffer) g_return_val_if_fail(xfer != NULL, 0); g_return_val_if_fail(buffer != NULL, 0); if (purple_xfer_get_size(xfer) == 0) s = xfer->current_buffer_size; s = MIN(purple_xfer_get_bytes_remaining(xfer), xfer->current_buffer_size); if (xfer->ops.read != NULL) { r = (xfer->ops.read)(buffer, xfer); r = read(xfer->fd, *buffer, s); if (r < 0 && errno == EAGAIN) if (r == xfer->current_buffer_size) * We managed to read the entire buffer. This means our this * network is fast and our buffer is too small, so make it purple_xfer_increase_buffer_size(xfer); purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size) g_return_val_if_fail(xfer != NULL, 0); g_return_val_if_fail(buffer != NULL, 0); g_return_val_if_fail(size != 0, 0); s = MIN(purple_xfer_get_bytes_remaining(xfer), size); if (xfer->ops.write != NULL) { r = (xfer->ops.write)(buffer, s, xfer); r = write(xfer->fd, buffer, s); if (r < 0 && errno == EAGAIN) if (r >= 0 && (purple_xfer_get_bytes_sent(xfer)+r) >= purple_xfer_get_size(xfer) && !purple_xfer_is_completed(xfer)) purple_xfer_set_completed(xfer, TRUE); do_transfer(PurpleXfer *xfer) ui_ops = purple_xfer_get_ui_ops(xfer); if (xfer->type == PURPLE_XFER_RECEIVE) { r = purple_xfer_read(xfer, &buffer); if (ui_ops && ui_ops->ui_write) wc = ui_ops->ui_write(xfer, buffer, r); wc = fwrite(buffer, 1, r, xfer->dest_fp); purple_debug_error("filetransfer", "Unable to write whole buffer.\n"); purple_xfer_cancel_local(xfer); if ((purple_xfer_get_size(xfer) > 0) && ((purple_xfer_get_bytes_sent(xfer)+r) >= purple_xfer_get_size(xfer))) purple_xfer_set_completed(xfer, TRUE); purple_xfer_cancel_remote(xfer); } else if (xfer->type == PURPLE_XFER_SEND) { size_t s = MIN(purple_xfer_get_bytes_remaining(xfer), xfer->current_buffer_size); PurpleXferPrivData *priv = g_hash_table_lookup(xfers_data, xfer); /* this is so the prpl can keep the connection open if it needs to for some odd reason. */ purple_input_remove(xfer->watcher); if (priv->buffer->len < s) { if (ui_ops && ui_ops->ui_read) { gssize tmp = ui_ops->ui_read(xfer, &buffer, s); * The UI claimed it was ready, but didn't have any data for * us... It will call purple_xfer_ui_ready when ready, which * sets back up this watcher. if (xfer->watcher != 0) { purple_input_remove(xfer->watcher); /* Need to indicate the prpl is still ready... */ priv->ready |= PURPLE_XFER_READY_PRPL; purple_debug_error("filetransfer", "Unable to read whole buffer.\n"); purple_xfer_cancel_local(xfer); result = fread(buffer, 1, s, xfer->dest_fp); purple_debug_error("filetransfer", "Unable to read whole buffer.\n"); purple_xfer_cancel_local(xfer); g_byte_array_append(priv->buffer, buffer, result); buffer = priv->buffer->data; result = priv->buffer->len; r = purple_xfer_write(xfer, buffer, result); purple_xfer_cancel_remote(xfer); /* We don't free buffer if priv->buffer is set, because in that case buffer doesn't belong to us. */ } else if (r == result) { * We managed to write the entire buffer. This means our * network is fast and our buffer is too small, so make it purple_xfer_increase_buffer_size(xfer); if (ui_ops && ui_ops->data_not_sent) ui_ops->data_not_sent(xfer, buffer + r, result - r); * If we wrote the whole buffer the byte array will be empty * Otherwise we'll keep what wasn't sent for next time. g_byte_array_remove_range(priv->buffer, 0, r); if (purple_xfer_get_size(xfer) > 0) xfer->bytes_remaining -= r; if (xfer->ops.ack != NULL) xfer->ops.ack(xfer, buffer, r); if (ui_ops != NULL && ui_ops->update_progress != NULL) ui_ops->update_progress(xfer, purple_xfer_get_progress(xfer)); if (purple_xfer_is_completed(xfer)) transfer_cb(gpointer data, gint source, PurpleInputCondition condition) if (xfer->dest_fp == NULL) { /* The UI is moderating its side manually */ PurpleXferPrivData *priv = g_hash_table_lookup(xfers_data, xfer); if (0 == (priv->ready & PURPLE_XFER_READY_UI)) { priv->ready |= PURPLE_XFER_READY_PRPL; purple_input_remove(xfer->watcher); purple_debug_misc("xfer", "prpl is ready on ft %p, waiting for UI\n", xfer); priv->ready = PURPLE_XFER_READY_NONE; begin_transfer(PurpleXfer *xfer, PurpleInputCondition cond) PurpleXferType type = purple_xfer_get_type(xfer); PurpleXferUiOps *ui_ops = purple_xfer_get_ui_ops(xfer); if (xfer->start_time != 0) { purple_debug_error("xfer", "Transfer is being started multiple times\n"); if (ui_ops == NULL || (ui_ops->ui_read == NULL && ui_ops->ui_write == NULL)) { xfer->dest_fp = g_fopen(purple_xfer_get_local_filename(xfer), type == PURPLE_XFER_RECEIVE ? "wb" : "rb"); if (xfer->dest_fp == NULL) { purple_xfer_show_file_error(xfer, purple_xfer_get_local_filename(xfer)); purple_xfer_cancel_local(xfer); fseek(xfer->dest_fp, xfer->bytes_sent, SEEK_SET); xfer->watcher = purple_input_add(xfer->fd, cond, transfer_cb, xfer); xfer->start_time = time(NULL); if (xfer->ops.start != NULL) connect_cb(gpointer data, gint source, const gchar *error_message) PurpleXfer *xfer = (PurpleXfer *)data; purple_xfer_cancel_local(xfer); begin_transfer(xfer, PURPLE_INPUT_READ); purple_xfer_ui_ready(PurpleXfer *xfer) PurpleInputCondition cond; PurpleXferPrivData *priv; g_return_if_fail(xfer != NULL); priv = g_hash_table_lookup(xfers_data, xfer); priv->ready |= PURPLE_XFER_READY_UI; if (0 == (priv->ready & PURPLE_XFER_READY_PRPL)) { purple_debug_misc("xfer", "UI is ready on ft %p, waiting for prpl\n", xfer); purple_debug_misc("xfer", "UI (and prpl) ready on ft %p, so proceeding\n", xfer); type = purple_xfer_get_type(xfer); if (type == PURPLE_XFER_SEND) cond = PURPLE_INPUT_WRITE; else /* if (type == PURPLE_XFER_RECEIVE) */ cond = PURPLE_INPUT_READ; if (xfer->watcher == 0 && xfer->fd != -1) xfer->watcher = purple_input_add(xfer->fd, cond, transfer_cb, xfer); priv->ready = PURPLE_XFER_READY_NONE; purple_xfer_prpl_ready(PurpleXfer *xfer) PurpleXferPrivData *priv; g_return_if_fail(xfer != NULL); priv = g_hash_table_lookup(xfers_data, xfer); priv->ready |= PURPLE_XFER_READY_PRPL; /* I don't think fwrite/fread are ever *not* ready */ if (xfer->dest_fp == NULL && 0 == (priv->ready & PURPLE_XFER_READY_UI)) { purple_debug_misc("xfer", "prpl is ready on ft %p, waiting for UI\n", xfer); purple_debug_misc("xfer", "Prpl (and UI) ready on ft %p, so proceeding\n", xfer); priv->ready = PURPLE_XFER_READY_NONE; purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip, PurpleInputCondition cond; g_return_if_fail(xfer != NULL); g_return_if_fail(purple_xfer_get_type(xfer) != PURPLE_XFER_UNKNOWN); type = purple_xfer_get_type(xfer); purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_STARTED); * FIXME 3.0.0 -- there's too much broken code depending on fd == 0 * meaning "don't use a real fd" if (type == PURPLE_XFER_RECEIVE) { cond = PURPLE_INPUT_READ; xfer->remote_ip = g_strdup(ip); xfer->remote_port = port; /* Establish a file descriptor. */ purple_proxy_connect(NULL, xfer->account, xfer->remote_ip, xfer->remote_port, connect_cb, xfer); cond = PURPLE_INPUT_WRITE; begin_transfer(xfer, cond); purple_xfer_end(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); /* See if we are actually trying to cancel this. */ if (!purple_xfer_is_completed(xfer)) { purple_xfer_cancel_local(xfer); xfer->end_time = time(NULL); if (xfer->ops.end != NULL) if (xfer->watcher != 0) { purple_input_remove(xfer->watcher); if (xfer->dest_fp != NULL) { purple_xfer_add(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->add_xfer != NULL) purple_xfer_cancel_local(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); /* TODO: We definitely want to close any open request dialogs associated with this transfer. However, in some cases the request dialog might own a reference on the xfer. This happens at least with the "%s wants to send you %s" dialog from purple_xfer_ask_recv(). In these cases the ref count will not be decremented when the request dialog is closed, so the ref count will never reach 0 and the xfer will never be freed. This is a memleak and should be fixed. It's not clear what the correct fix is. Probably requests should have a destroy function that is called when the request is destroyed. But also, ref counting xfer objects makes this code REALLY complicated. An alternate fix is to not ref count and instead just make sure the object still exists when we try to use it. */ purple_request_close_with_handle(xfer); purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_CANCEL_LOCAL); xfer->end_time = time(NULL); if (purple_xfer_get_filename(xfer) != NULL) msg = g_strdup_printf(_("You cancelled the transfer of %s"), purple_xfer_get_filename(xfer)); msg = g_strdup(_("File transfer cancelled")); purple_xfer_conversation_write(xfer, msg, FALSE); if (purple_xfer_get_type(xfer) == PURPLE_XFER_SEND) if (xfer->ops.cancel_send != NULL) xfer->ops.cancel_send(xfer); if (xfer->ops.cancel_recv != NULL) xfer->ops.cancel_recv(xfer); if (xfer->watcher != 0) { purple_input_remove(xfer->watcher); if (xfer->dest_fp != NULL) { ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->cancel_local != NULL) ui_ops->cancel_local(xfer); xfer->bytes_remaining = 0; purple_xfer_cancel_remote(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); purple_request_close_with_handle(xfer); purple_xfer_set_status(xfer, PURPLE_XFER_STATUS_CANCEL_REMOTE); xfer->end_time = time(NULL); account = purple_xfer_get_account(xfer); buddy = purple_find_buddy(account, xfer->who); if (purple_xfer_get_filename(xfer) != NULL) msg = g_strdup_printf(_("%s cancelled the transfer of %s"), buddy ? purple_buddy_get_alias(buddy) : xfer->who, purple_xfer_get_filename(xfer)); msg = g_strdup_printf(_("%s cancelled the file transfer"), buddy ? purple_buddy_get_alias(buddy) : xfer->who); purple_xfer_conversation_write(xfer, msg, TRUE); purple_xfer_error(purple_xfer_get_type(xfer), account, xfer->who, msg); if (purple_xfer_get_type(xfer) == PURPLE_XFER_SEND) if (xfer->ops.cancel_send != NULL) xfer->ops.cancel_send(xfer); if (xfer->ops.cancel_recv != NULL) xfer->ops.cancel_recv(xfer); if (xfer->watcher != 0) { purple_input_remove(xfer->watcher); if (xfer->dest_fp != NULL) { ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->cancel_remote != NULL) ui_ops->cancel_remote(xfer); xfer->bytes_remaining = 0; purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg) g_return_if_fail(msg != NULL); g_return_if_fail(type != PURPLE_XFER_UNKNOWN); buddy = purple_find_buddy(account, who); who = purple_buddy_get_alias(buddy); if (type == PURPLE_XFER_SEND) title = g_strdup_printf(_("File transfer to %s failed."), who); title = g_strdup_printf(_("File transfer from %s failed."), who); purple_notify_error(NULL, NULL, title, msg); purple_xfer_update_progress(PurpleXfer *xfer) g_return_if_fail(xfer != NULL); ui_ops = purple_xfer_get_ui_ops(xfer); if (ui_ops != NULL && ui_ops->update_progress != NULL) ui_ops->update_progress(xfer, purple_xfer_get_progress(xfer)); purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len) PurpleXferPrivData *priv = g_hash_table_lookup(xfers_data, xfer); *len = priv->thumbnail_size; return priv->thumbnail_data; purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer) PurpleXferPrivData *priv = g_hash_table_lookup(xfers_data, xfer); return priv->thumbnail_mimetype; purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail, gsize size, const gchar *mimetype) PurpleXferPrivData *priv = g_hash_table_lookup(xfers_data, xfer); g_free(priv->thumbnail_data); g_free(priv->thumbnail_mimetype); if (thumbnail && size > 0) { priv->thumbnail_data = g_memdup(thumbnail, size); priv->thumbnail_size = size; priv->thumbnail_mimetype = g_strdup(mimetype); priv->thumbnail_data = NULL; priv->thumbnail_size = 0; priv->thumbnail_mimetype = NULL; purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats) if (xfer->ui_ops->add_thumbnail) { xfer->ui_ops->add_thumbnail(xfer, formats); /************************************************************************** * File Transfer Subsystem API **************************************************************************/ purple_xfers_get_handle(void) { purple_xfers_init(void) { void *handle = purple_xfers_get_handle(); xfers_data = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, purple_xfer_priv_data_destroy); purple_signal_register(handle, "file-recv-accept", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-send-accept", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-recv-start", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-send-start", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-send-cancel", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-recv-cancel", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-send-complete", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-recv-complete", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_signal_register(handle, "file-recv-request", purple_marshal_VOID__POINTER, NULL, 1, purple_value_new(PURPLE_TYPE_SUBTYPE, purple_xfers_uninit(void) void *handle = purple_xfers_get_handle(); purple_signals_disconnect_by_handle(handle); purple_signals_unregister_by_instance(handle); g_hash_table_destroy(xfers_data); purple_xfers_set_ui_ops(PurpleXferUiOps *ops) { purple_xfers_get_ui_ops(void) {