src/purple/purple-ft.c

   1 /**
   2  * @file purple-ft.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2015 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2010 Jakub Adam <jakub.adam@ktknet.cz>
   8  * Copyright (C) 2010 Tomáš Hrabčík <tomas.hrabcik@tieto.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include "config.h"
  27 #endif
  28
  29 #include <string.h>
  30 #include <fcntl.h>
  31 #include <errno.h>
  32
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36
  37 #include <glib.h>
  38
  39 #include "version.h"
  40 #if PURPLE_VERSION_CHECK(3,0,0)
  41 #include "protocol.h"
  42 #define PURPLE_XFER_TO_SIPE_CORE_PUBLIC        ((struct sipe_core_public *) purple_connection_get_protocol_data(purple_account_get_connection(purple_xfer_get_account(xfer))))
  43 #else
  44 #include "ft.h"
  45 #define PurpleXferStatus                       PurpleXferStatusType
  46 #define PURPLE_XFER_TO_SIPE_CORE_PUBLIC        ((struct sipe_core_public *) purple_account_get_connection(xfer->account)->proto_data)
  47 #define PURPLE_XFER_TYPE_RECEIVE               PURPLE_XFER_RECEIVE
  48 #define PURPLE_XFER_TYPE_SEND                  PURPLE_XFER_SEND
  49 #define purple_xfer_get_fd(xfer)               xfer->fd
  50 #define purple_xfer_get_protocol_data(xfer)    xfer->data
  51 #define purple_xfer_get_status(xfer)           purple_xfer_get_status(xfer)
  52 #define purple_xfer_get_xfer_type(xfer)        purple_xfer_get_type(xfer)
  53 #define purple_xfer_get_watcher(xfer)          xfer->watcher
  54 #define purple_xfer_set_protocol_data(xfer, d) xfer->data = d
  55 #define purple_xfer_set_watcher(xfer, w)       xfer->watcher = w
  56 #endif
  57
  58 #ifdef _WIN32
  59 /* wrappers for write() & friends for socket handling */
  60 #include "win32/win32dep.h"
  61 #endif
  62
  63 #include "sipe-common.h"
  64 #include "sipe-backend.h"
  65 #include "sipe-core.h"
  66
  67 #include "purple-private.h"
  68
  69 #define FT_TO_PURPLE_XFER                      ((PurpleXfer *) ft->backend_private)
  70 #define PURPLE_XFER_TO_SIPE_FILE_TRANSFER      ((struct sipe_file_transfer *) purple_xfer_get_protocol_data(xfer))
  71
  72 void sipe_backend_ft_error(struct sipe_file_transfer *ft,
  73                            const char *errmsg)
  74 {
  75         PurpleXfer *xfer = FT_TO_PURPLE_XFER;
  76         purple_xfer_error(purple_xfer_get_xfer_type(xfer),
  77                           purple_xfer_get_account(xfer),
  78                           purple_xfer_get_remote_user(xfer),
  79                           errmsg);
  80 }
  81
  82 const gchar *sipe_backend_ft_get_error(SIPE_UNUSED_PARAMETER struct sipe_file_transfer *ft)
  83 {
  84         return strerror(errno);
  85 }
  86
  87 void sipe_backend_ft_deallocate(struct sipe_file_transfer *ft)
  88 {
  89         PurpleXfer *xfer = FT_TO_PURPLE_XFER;
  90         PurpleXferStatus status = purple_xfer_get_status(xfer);
  91
  92         // If file transfer is not finished, cancel it
  93         if (   status != PURPLE_XFER_STATUS_DONE
  94                 && status != PURPLE_XFER_STATUS_CANCEL_LOCAL
  95                 && status != PURPLE_XFER_STATUS_CANCEL_REMOTE) {
  96                 purple_xfer_set_cancel_recv_fnc(xfer, NULL);
  97                 purple_xfer_set_cancel_send_fnc(xfer, NULL);
  98                 purple_xfer_cancel_remote(xfer);
  99         }
 100 }
 101
 102 gssize sipe_backend_ft_read(struct sipe_file_transfer *ft,
 103                             guchar *data,
 104                             gsize size)
 105 {
 106         gssize bytes_read = read(purple_xfer_get_fd(FT_TO_PURPLE_XFER),
 107                                  data,
 108                                  size);
 109         if (bytes_read == 0) {
 110                 /* Sender canceled transfer before it was finished */
 111                 return -2;
 112         } else if (bytes_read == -1) {
 113                 if (errno == EAGAIN)
 114                         return 0;
 115                 else
 116                         return -1;
 117         }
 118         return bytes_read;
 119 }
 120
 121 gssize sipe_backend_ft_write(struct sipe_file_transfer *ft,
 122                              const guchar *data,
 123                              gsize size)
 124 {
 125         gssize bytes_written = write(purple_xfer_get_fd(FT_TO_PURPLE_XFER),
 126                                      data,
 127                                      size);
 128         if (bytes_written == -1) {
 129                 if (errno == EAGAIN)
 130                         return 0;
 131                 else
 132                         return -1;
 133         }
 134         return bytes_written;
 135 }
 136
 137 void sipe_backend_ft_cancel_local(struct sipe_file_transfer *ft)
 138 {
 139         purple_xfer_cancel_local(FT_TO_PURPLE_XFER);
 140 }
 141
 142 void sipe_backend_ft_cancel_remote(struct sipe_file_transfer *ft)
 143 {
 144         purple_xfer_cancel_remote(FT_TO_PURPLE_XFER);
 145 }
 146
 147 static void
 148 ft_free_xfer_struct(PurpleXfer *xfer)
 149 {
 150         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 151
 152         if (ft) {
 153                 if (purple_xfer_get_watcher(xfer)) {
 154                         purple_input_remove(purple_xfer_get_watcher(xfer));
 155                         purple_xfer_set_watcher(xfer, 0);
 156                 }
 157                 if (ft->deallocate) {
 158                         ft->deallocate(ft);
 159                 }
 160                 purple_xfer_set_protocol_data(xfer, NULL);
 161         }
 162 }
 163
 164 static void
 165 ft_request_denied(PurpleXfer *xfer)
 166 {
 167         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 168         if (ft->request_denied) {
 169                 ft->request_denied(ft);
 170         }
 171
 172         ft_free_xfer_struct(xfer);
 173 }
 174
 175 static void
 176 ft_init(PurpleXfer *xfer)
 177 {
 178         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 179         g_return_if_fail(ft->init);
 180
 181         ft->init(ft,
 182                  purple_xfer_get_filename(xfer),
 183                  purple_xfer_get_size(xfer),
 184                  purple_xfer_get_remote_user(xfer));
 185 }
 186
 187 static void
 188 ft_start(PurpleXfer *xfer)
 189 {
 190         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 191
 192         if (purple_xfer_get_xfer_type(xfer) == PURPLE_XFER_TYPE_RECEIVE) {
 193                 /* Set socket to non-blocking mode */
 194                 int flags = fcntl(purple_xfer_get_fd(xfer), F_GETFL, 0);
 195                 if (flags == -1) {
 196                         flags = 0;
 197                 }
 198                 /* @TODO: ignoring potential error return - how to handle? */
 199                 fcntl(purple_xfer_get_fd(xfer), F_SETFL, flags | O_NONBLOCK);
 200         }
 201
 202         if (ft->start) {
 203                 ft->start(ft, purple_xfer_get_size(xfer));
 204         }
 205 }
 206
 207 static void
 208 ft_end(PurpleXfer *xfer)
 209 {
 210         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 211
 212         if (ft->end && ft->end(ft)) {
 213                 /* We're done with this transfer */
 214                 ft_free_xfer_struct(xfer);
 215         } else if (purple_xfer_get_xfer_type(xfer) == PURPLE_XFER_TYPE_RECEIVE) {
 216                 /* Remove incomplete file from failed transfer. */
 217                 unlink(purple_xfer_get_local_filename(xfer));
 218         }
 219 }
 220
 221 static gssize
 222 ft_read(guchar **buffer,
 223 #if PURPLE_VERSION_CHECK(3,0,0)
 224                         size_t buffer_size,
 225 #endif
 226                         PurpleXfer *xfer)
 227 {
 228         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 229         g_return_val_if_fail(ft->read, 0);
 230         return ft->read(ft, buffer, purple_xfer_get_bytes_remaining(xfer),
 231 #if PURPLE_VERSION_CHECK(3,0,0)
 232                         buffer_size
 233 #else
 234                         xfer->current_buffer_size
 235 #endif
 236         );
 237 }
 238
 239 static gssize
 240 ft_write(const guchar *buffer, size_t size, PurpleXfer *xfer)
 241 {
 242         struct sipe_file_transfer *ft = PURPLE_XFER_TO_SIPE_FILE_TRANSFER;
 243         gssize bytes_written = 0;
 244
 245         g_return_val_if_fail(ft->write, 0);
 246
 247         bytes_written = ft->write(ft, buffer, size);
 248
 249         if ((purple_xfer_get_bytes_remaining(xfer) - bytes_written) == 0)
 250                 purple_xfer_set_completed(xfer, TRUE);
 251
 252         return bytes_written;
 253 }
 254
 255 static PurpleXfer *
 256 create_xfer(PurpleAccount *account, PurpleXferType type, const char *who,
 257             struct sipe_file_transfer *ft)
 258 {
 259         PurpleXfer *xfer = purple_xfer_new(account, type, who);
 260         if (xfer) {
 261                 ft->backend_private = (struct sipe_backend_file_transfer *)xfer;
 262
 263                 purple_xfer_set_protocol_data(xfer, ft);
 264                 purple_xfer_set_init_fnc(xfer, ft_init);
 265                 purple_xfer_set_request_denied_fnc(xfer, ft_request_denied);
 266                 purple_xfer_set_cancel_send_fnc(xfer, ft_free_xfer_struct);
 267                 purple_xfer_set_cancel_recv_fnc(xfer, ft_free_xfer_struct);
 268                 purple_xfer_set_start_fnc(xfer, ft_start);
 269                 purple_xfer_set_end_fnc(xfer, ft_end);
 270                 if (type == PURPLE_XFER_TYPE_SEND) {
 271                         purple_xfer_set_write_fnc(xfer, ft_write);
 272                 } else if (type == PURPLE_XFER_TYPE_RECEIVE) {
 273                         purple_xfer_set_read_fnc(xfer, ft_read);
 274                 }
 275         }
 276
 277         return xfer;
 278 }
 279
 280 void sipe_backend_ft_incoming(struct sipe_core_public *sipe_public,
 281                               struct sipe_file_transfer *ft,
 282                               const gchar *who,
 283                               const gchar *file_name,
 284                               gsize file_size)
 285 {
 286         struct sipe_backend_private *purple_private = sipe_public->backend_private;
 287         PurpleXfer *xfer = create_xfer(purple_private->account,
 288                                        PURPLE_XFER_TYPE_RECEIVE, who, ft);
 289         if (xfer) {
 290                 purple_xfer_set_filename(xfer, file_name);
 291                 purple_xfer_set_size(xfer, file_size);
 292
 293                 purple_xfer_request(xfer);
 294         }
 295 }
 296
 297 static void
 298 connect_cb(gpointer data, gint fd, SIPE_UNUSED_PARAMETER const gchar *error_message)
 299 {
 300         struct sipe_file_transfer *ft = data;
 301
 302         if (fd < 0) {
 303                 purple_xfer_cancel_local(FT_TO_PURPLE_XFER);
 304                 return;
 305         }
 306
 307         purple_xfer_start(FT_TO_PURPLE_XFER, fd, NULL, 0);
 308 }
 309
 310 void
 311 sipe_backend_ft_start(struct sipe_file_transfer *ft, struct sipe_backend_fd *fd,
 312                       const char* ip, unsigned port)
 313 {
 314         if (ip && port && !sipe_backend_ft_is_incoming(ft)) {
 315                 /* Purple accepts ip & port only for incoming file transfers.
 316                  * If we want to send file with Sender-Connect = TRUE negotiated,
 317                  * we have to open the connection ourselves and pass the file
 318                  * descriptor to purple_xfer_start. */
 319                 purple_proxy_connect(NULL,
 320                                      purple_xfer_get_account(FT_TO_PURPLE_XFER),
 321                                      ip,
 322                                      port,
 323                                      connect_cb,
 324                                      ft);
 325                 return;
 326         }
 327
 328         purple_xfer_start(FT_TO_PURPLE_XFER, fd ? fd->fd : -1, ip, port);
 329 }
 330
 331 void sipe_purple_ft_send_file(PurpleConnection *gc,
 332                               const char *who,
 333                               const char *file)
 334 {
 335         struct sipe_file_transfer *ft =
 336                         sipe_core_ft_create_outgoing(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 337         PurpleXfer *xfer = create_xfer(purple_connection_get_account(gc),
 338                                        PURPLE_XFER_TYPE_SEND, who, ft);
 339         if (xfer) {
 340                 if (file != NULL)
 341                         purple_xfer_request_accepted(xfer, file);
 342                 else
 343                         purple_xfer_request(xfer);
 344         }
 345 }
 346
 347 gboolean
 348 sipe_backend_ft_is_incoming(struct sipe_file_transfer *ft)
 349 {
 350         return(purple_xfer_get_xfer_type(FT_TO_PURPLE_XFER) == PURPLE_XFER_TYPE_RECEIVE);
 351 }
 352
 353 /*
 354   Local Variables:
 355   mode: c
 356   c-file-style: "bsd"
 357   indent-tabs-mode: t
 358   tab-width: 8
 359   End:
 360 */