libsoup/soup-socket.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * soup-socket.c: Socket networking code.
   4  *
   5  * Copyright (C) 2000-2003, Ximian, Inc.
   6  */
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include <config.h>
  10 #endif
  11
  12 #include <errno.h>
  13 #include <fcntl.h>
  14 #include <signal.h>
  15 #include <string.h>
  16 #include <unistd.h>
  17
  18 #include "soup-address.h"
  19 #include "soup-socket.h"
  20 #include "soup-marshal.h"
  21 #include "soup-misc.h"
  22 #include "soup-ssl.h"
  23
  24 #include <sys/types.h>
  25 #include <sys/socket.h>
  26 #include <netinet/in.h>
  27 #include <netinet/tcp.h>
  28
  29 #define PARENT_TYPE G_TYPE_OBJECT
  30 static GObjectClass *parent_class;
  31
  32 enum {
  33         CONNECT_RESULT,
  34         READABLE,
  35         WRITABLE,
  36         DISCONNECTED,
  37         NEW_CONNECTION,
  38         LAST_SIGNAL
  39 };
  40
  41 static guint signals[LAST_SIGNAL] = { 0 };
  42
  43 enum {
  44         PROP_0,
  45
  46         PROP_NON_BLOCKING,
  47         PROP_NODELAY,
  48         PROP_REUSEADDR,
  49         PROP_IS_SERVER,
  50         PROP_SSL_CREDENTIALS,
  51
  52         LAST_PROP
  53 };
  54
  55 struct SoupSocketPrivate {
  56         int sockfd;
  57         SoupAddress *local_addr, *remote_addr;
  58         GIOChannel *iochannel;
  59
  60         guint non_blocking:1;
  61         guint nodelay:1;
  62         guint reuseaddr:1;
  63         guint is_server:1;
  64         gpointer ssl_creds;
  65
  66         guint           watch;
  67         guint           read_tag, write_tag, error_tag;
  68         GByteArray     *read_buf;
  69
  70         GMutex *iolock, *addrlock;
  71 };
  72
  73 #ifdef HAVE_IPV6
  74 #define soup_sockaddr_max sockaddr_in6
  75 #else
  76 #define soup_sockaddr_max sockaddr_in
  77 #endif
  78
  79 static void set_property (GObject *object, guint prop_id,
  80                           const GValue *value, GParamSpec *pspec);
  81 static void get_property (GObject *object, guint prop_id,
  82                           GValue *value, GParamSpec *pspec);
  83
  84 static void
  85 init (GObject *object)
  86 {
  87         SoupSocket *sock = SOUP_SOCKET (object);
  88
  89         sock->priv = g_new0 (SoupSocketPrivate, 1);
  90         sock->priv->sockfd = -1;
  91         sock->priv->non_blocking = sock->priv->nodelay = TRUE;
  92         sock->priv->reuseaddr = TRUE;
  93         sock->priv->addrlock = g_mutex_new ();
  94         sock->priv->iolock = g_mutex_new ();
  95 }
  96
  97 static void
  98 disconnect_internal (SoupSocket *sock)
  99 {
 100         g_io_channel_unref (sock->priv->iochannel);
 101         sock->priv->iochannel = NULL;
 102         sock->priv->sockfd = -1;
 103
 104         if (sock->priv->read_tag) {
 105                 g_source_remove (sock->priv->read_tag);
 106                 sock->priv->read_tag = 0;
 107         }
 108         if (sock->priv->write_tag) {
 109                 g_source_remove (sock->priv->write_tag);
 110                 sock->priv->write_tag = 0;
 111         }
 112         if (sock->priv->error_tag) {
 113                 g_source_remove (sock->priv->error_tag);
 114                 sock->priv->error_tag = 0;
 115         }
 116 }
 117
 118 static void
 119 finalize (GObject *object)
 120 {
 121         SoupSocket *sock = SOUP_SOCKET (object);
 122
 123         if (sock->priv->iochannel)
 124                 disconnect_internal (sock);
 125
 126         if (sock->priv->local_addr)
 127                 g_object_unref (sock->priv->local_addr);
 128         if (sock->priv->remote_addr)
 129                 g_object_unref (sock->priv->remote_addr);
 130
 131         if (sock->priv->watch)
 132                 g_source_remove (sock->priv->watch);
 133
 134         g_mutex_free (sock->priv->addrlock);
 135         g_mutex_free (sock->priv->iolock);
 136
 137         g_free (sock->priv);
 138
 139         G_OBJECT_CLASS (parent_class)->finalize (object);
 140 }
 141
 142 static void
 143 class_init (GObjectClass *object_class)
 144 {
 145         parent_class = g_type_class_ref (PARENT_TYPE);
 146
 147         /* virtual method override */
 148         object_class->finalize = finalize;
 149         object_class->set_property = set_property;
 150         object_class->get_property = get_property;
 151
 152         /* signals */
 153         signals[CONNECT_RESULT] =
 154                 g_signal_new ("connect_result",
 155                               G_OBJECT_CLASS_TYPE (object_class),
 156                               G_SIGNAL_RUN_FIRST,
 157                               G_STRUCT_OFFSET (SoupSocketClass, connect_result),
 158                               NULL, NULL,
 159                               soup_marshal_NONE__INT,
 160                               G_TYPE_NONE, 1,
 161                               G_TYPE_INT);
 162         signals[READABLE] =
 163                 g_signal_new ("readable",
 164                               G_OBJECT_CLASS_TYPE (object_class),
 165                               G_SIGNAL_RUN_LAST,
 166                               G_STRUCT_OFFSET (SoupSocketClass, readable),
 167                               NULL, NULL,
 168                               soup_marshal_NONE__NONE,
 169                               G_TYPE_NONE, 0);
 170         signals[WRITABLE] =
 171                 g_signal_new ("writable",
 172                               G_OBJECT_CLASS_TYPE (object_class),
 173                               G_SIGNAL_RUN_LAST,
 174                               G_STRUCT_OFFSET (SoupSocketClass, writable),
 175                               NULL, NULL,
 176                               soup_marshal_NONE__NONE,
 177                               G_TYPE_NONE, 0);
 178         signals[DISCONNECTED] =
 179                 g_signal_new ("disconnected",
 180                               G_OBJECT_CLASS_TYPE (object_class),
 181                               G_SIGNAL_RUN_LAST,
 182                               G_STRUCT_OFFSET (SoupSocketClass, disconnected),
 183                               NULL, NULL,
 184                               soup_marshal_NONE__NONE,
 185                               G_TYPE_NONE, 0);
 186         signals[NEW_CONNECTION] =
 187                 g_signal_new ("new_connection",
 188                               G_OBJECT_CLASS_TYPE (object_class),
 189                               G_SIGNAL_RUN_FIRST,
 190                               G_STRUCT_OFFSET (SoupSocketClass, new_connection),
 191                               NULL, NULL,
 192                               soup_marshal_NONE__OBJECT,
 193                               G_TYPE_NONE, 1,
 194                               SOUP_TYPE_SOCKET);
 195
 196         /* properties */
 197         g_object_class_install_property (
 198                 object_class, PROP_NON_BLOCKING,
 199                 g_param_spec_boolean (SOUP_SOCKET_FLAG_NONBLOCKING,
 200                                       "Non-blocking",
 201                                       "Whether or not the socket uses non-blocking I/O",
 202                                       TRUE,
 203                                       G_PARAM_READWRITE));
 204         g_object_class_install_property (
 205                 object_class, PROP_NODELAY,
 206                 g_param_spec_boolean (SOUP_SOCKET_FLAG_NODELAY,
 207                                       "NODELAY",
 208                                       "Whether or not the socket uses TCP NODELAY",
 209                                       TRUE,
 210                                       G_PARAM_READWRITE));
 211         g_object_class_install_property (
 212                 object_class, PROP_REUSEADDR,
 213                 g_param_spec_boolean (SOUP_SOCKET_FLAG_REUSEADDR,
 214                                       "REUSEADDR",
 215                                       "Whether or not the socket uses the TCP REUSEADDR flag",
 216                                       TRUE,
 217                                       G_PARAM_READWRITE));
 218         g_object_class_install_property (
 219                 object_class, PROP_IS_SERVER,
 220                 g_param_spec_boolean (SOUP_SOCKET_IS_SERVER,
 221                                       "Server",
 222                                       "Whether or not the socket is a server socket",
 223                                       FALSE,
 224                                       G_PARAM_READABLE));
 225         g_object_class_install_property (
 226                 object_class, PROP_SSL_CREDENTIALS,
 227                 g_param_spec_pointer (SOUP_SOCKET_SSL_CREDENTIALS,
 228                                       "SSL credentials",
 229                                       "SSL credential information, passed from the session to the SSL implementation",
 230                                       G_PARAM_READWRITE));
 231 }
 232
 233 SOUP_MAKE_TYPE (soup_socket, SoupSocket, class_init, init, PARENT_TYPE)
 234
 235
 236 static void
 237 update_fdflags (SoupSocket *sock)
 238 {
 239         int flags, opt;
 240
 241         if (sock->priv->sockfd == -1)
 242                 return;
 243
 244         flags = fcntl (sock->priv->sockfd, F_GETFL, 0);
 245         if (flags != -1) {
 246                 if (sock->priv->non_blocking)
 247                         flags |= O_NONBLOCK;
 248                 else
 249                         flags &= ~O_NONBLOCK;
 250                 fcntl (sock->priv->sockfd, F_SETFL, flags);
 251         }
 252
 253         opt = (sock->priv->nodelay != 0);
 254         setsockopt (sock->priv->sockfd, IPPROTO_TCP,
 255                     TCP_NODELAY, &opt, sizeof (opt));
 256
 257         opt = (sock->priv->reuseaddr != 0);
 258         setsockopt (sock->priv->sockfd, SOL_SOCKET,
 259                     SO_REUSEADDR, &opt, sizeof (opt));
 260 }
 261
 262 static void
 263 set_property (GObject *object, guint prop_id,
 264               const GValue *value, GParamSpec *pspec)
 265 {
 266         SoupSocket *sock = SOUP_SOCKET (object);
 267
 268         switch (prop_id) {
 269         case PROP_NON_BLOCKING:
 270                 sock->priv->non_blocking = g_value_get_boolean (value);
 271                 update_fdflags (sock);
 272                 break;
 273         case PROP_NODELAY:
 274                 sock->priv->nodelay = g_value_get_boolean (value);
 275                 update_fdflags (sock);
 276                 break;
 277         case PROP_REUSEADDR:
 278                 sock->priv->reuseaddr = g_value_get_boolean (value);
 279                 update_fdflags (sock);
 280                 break;
 281         case PROP_SSL_CREDENTIALS:
 282                 sock->priv->ssl_creds = g_value_get_pointer (value);
 283                 break;
 284         default:
 285                 break;
 286         }
 287 }
 288
 289 static void
 290 get_property (GObject *object, guint prop_id,
 291               GValue *value, GParamSpec *pspec)
 292 {
 293         SoupSocket *sock = SOUP_SOCKET (object);
 294
 295         switch (prop_id) {
 296         case PROP_NON_BLOCKING:
 297                 g_value_set_boolean (value, sock->priv->non_blocking);
 298                 break;
 299         case PROP_NODELAY:
 300                 g_value_set_boolean (value, sock->priv->nodelay);
 301                 break;
 302         case PROP_REUSEADDR:
 303                 g_value_set_boolean (value, sock->priv->reuseaddr);
 304                 break;
 305         case PROP_IS_SERVER:
 306                 g_value_set_boolean (value, sock->priv->is_server);
 307                 break;
 308         case PROP_SSL_CREDENTIALS:
 309                 g_value_set_pointer (value, sock->priv->ssl_creds);
 310                 break;
 311         default:
 312                 break;
 313         }
 314 }
 315
 316
 317 /**
 318  * soup_socket_new:
 319  * @optname1: name of first property to set (or %NULL)
 320  * @...: value of @optname1, followed by additional property/value pairs
 321  *
 322  * Return value: a new (disconnected) socket
 323  **/
 324 SoupSocket *
 325 soup_socket_new (const char *optname1, ...)
 326 {
 327         SoupSocket *sock;
 328         va_list ap;
 329
 330         va_start (ap, optname1);
 331         sock = (SoupSocket *)g_object_new_valist (SOUP_TYPE_SOCKET,
 332                                                   optname1, ap);
 333         va_end (ap);
 334
 335         return sock;
 336 }
 337
 338 static GIOChannel *
 339 get_iochannel (SoupSocket *sock)
 340 {
 341         g_mutex_lock (sock->priv->iolock);
 342         if (!sock->priv->iochannel) {
 343                 sock->priv->iochannel =
 344                         g_io_channel_unix_new (sock->priv->sockfd);
 345                 g_io_channel_set_close_on_unref (sock->priv->iochannel, TRUE);
 346                 g_io_channel_set_encoding (sock->priv->iochannel, NULL, NULL);
 347                 g_io_channel_set_buffered (sock->priv->iochannel, FALSE);
 348         }
 349         g_mutex_unlock (sock->priv->iolock);
 350         return sock->priv->iochannel;
 351 }
 352
 353 static gboolean
 354 idle_connect_result (gpointer user_data)
 355 {
 356         SoupSocket *sock = user_data;
 357
 358         sock->priv->watch = 0;
 359
 360         g_signal_emit (sock, signals[CONNECT_RESULT], 0,
 361                        sock->priv->sockfd != -1 ? SOUP_STATUS_OK : SOUP_STATUS_CANT_CONNECT);
 362         return FALSE;
 363 }
 364
 365 static gboolean
 366 connect_watch (GIOChannel* iochannel, GIOCondition condition, gpointer data)
 367 {
 368         SoupSocket *sock = data;
 369         int error = 0;
 370         int len = sizeof (error);
 371
 372         /* Remove the watch now in case we don't return immediately */
 373         g_source_remove (sock->priv->watch);
 374         sock->priv->watch = 0;
 375
 376         if (condition & ~(G_IO_IN | G_IO_OUT))
 377                 goto cant_connect;
 378
 379         if (getsockopt (sock->priv->sockfd, SOL_SOCKET, SO_ERROR,
 380                         &error, &len) != 0)
 381                 goto cant_connect;
 382         if (error)
 383                 goto cant_connect;
 384
 385         return idle_connect_result (sock);
 386
 387  cant_connect:
 388         g_signal_emit (sock, signals[CONNECT_RESULT], 0, SOUP_STATUS_CANT_CONNECT);
 389         return FALSE;
 390 }
 391
 392 static void
 393 got_address (SoupAddress *addr, guint status, gpointer user_data)
 394 {
 395         SoupSocket *sock = user_data;
 396
 397         if (!SOUP_STATUS_IS_SUCCESSFUL (status)) {
 398                 g_signal_emit (sock, signals[CONNECT_RESULT], 0, status);
 399                 g_object_unref (sock);
 400                 return;
 401         }
 402
 403         soup_socket_connect (sock, sock->priv->remote_addr);
 404         /* soup_socket_connect re-reffed addr */
 405         g_object_unref (addr);
 406
 407         g_object_unref (sock);
 408 }
 409
 410 /**
 411  * soup_socket_connect:
 412  * @sock: a client #SoupSocket (which must not already be connected)
 413  * @remote_addr: address to connect to
 414  *
 415  * If %SOUP_SOCKET_FLAG_NONBLOCKING has been set on the socket, this
 416  * begins asynchronously connecting to the given address. The socket
 417  * will emit %connect_result when it succeeds or fails (but not before
 418  * returning from this function).
 419  *
 420  * If %SOUP_SOCKET_FLAG_NONBLOCKING has not been set, this will
 421  * attempt to synchronously connect.
 422  *
 423  * Return value: %SOUP_STATUS_CONTINUE if connecting asynchronously,
 424  * otherwise a success or failure code.
 425  **/
 426 guint
 427 soup_socket_connect (SoupSocket *sock, SoupAddress *remote_addr)
 428 {
 429         struct sockaddr *sa;
 430         int len, status;
 431
 432         g_return_val_if_fail (SOUP_IS_SOCKET (sock), SOUP_STATUS_MALFORMED);
 433         g_return_val_if_fail (!sock->priv->is_server, SOUP_STATUS_MALFORMED);
 434         g_return_val_if_fail (sock->priv->sockfd == -1, SOUP_STATUS_MALFORMED);
 435         g_return_val_if_fail (SOUP_IS_ADDRESS (remote_addr), SOUP_STATUS_MALFORMED);
 436
 437         sock->priv->remote_addr = g_object_ref (remote_addr);
 438         if (!sock->priv->non_blocking) {
 439                 status = soup_address_resolve_sync (remote_addr);
 440                 if (!SOUP_STATUS_IS_SUCCESSFUL (status))
 441                         return status;
 442         }
 443
 444         sa = soup_address_get_sockaddr (sock->priv->remote_addr, &len);
 445         if (!sa) {
 446                 if (!sock->priv->non_blocking)
 447                         return SOUP_STATUS_CANT_RESOLVE;
 448
 449                 g_object_ref (sock);
 450                 soup_address_resolve_async (remote_addr, got_address, sock);
 451                 return SOUP_STATUS_CONTINUE;
 452         }
 453
 454         sock->priv->sockfd = socket (sa->sa_family, SOCK_STREAM, 0);
 455         if (sock->priv->sockfd == -1) {
 456                 g_free (sa);
 457                 goto done;
 458         }
 459         update_fdflags (sock);
 460
 461         status = connect (sock->priv->sockfd, sa, len);
 462         g_free (sa);
 463
 464         if (status == -1) {
 465                 if (errno == EINPROGRESS) {
 466                         /* Wait for connect to succeed or fail */
 467                         sock->priv->watch =
 468                                 g_io_add_watch (get_iochannel (sock),
 469                                                 G_IO_IN | G_IO_OUT |
 470                                                 G_IO_PRI | G_IO_ERR |
 471                                                 G_IO_HUP | G_IO_NVAL,
 472                                                 connect_watch, sock);
 473                         return SOUP_STATUS_CONTINUE;
 474                 } else {
 475                         close (sock->priv->sockfd);
 476                         sock->priv->sockfd = -1;
 477                 }
 478         }
 479
 480  done:
 481         if (sock->priv->non_blocking) {
 482                 sock->priv->watch = g_idle_add (idle_connect_result, sock);
 483                 return SOUP_STATUS_CONTINUE;
 484         } else if (sock->priv->sockfd == -1)
 485                 return SOUP_STATUS_CANT_CONNECT;
 486         else {
 487                 get_iochannel (sock);
 488                 return SOUP_STATUS_OK;
 489         }
 490 }
 491
 492 static gboolean
 493 listen_watch (GIOChannel* iochannel, GIOCondition condition, gpointer data)
 494 {
 495         SoupSocket *sock = data, *new;
 496         struct soup_sockaddr_max sa;
 497         int sa_len, sockfd;
 498
 499         if (condition & (G_IO_HUP | G_IO_ERR)) {
 500                 g_source_remove (sock->priv->watch);
 501                 sock->priv->watch = 0;
 502                 return FALSE;
 503         }
 504
 505         sa_len = sizeof (sa);
 506         sockfd = accept (sock->priv->sockfd, (struct sockaddr *)&sa, &sa_len);
 507         if (sockfd == -1)
 508                 return TRUE;
 509
 510         new = g_object_new (SOUP_TYPE_SOCKET, NULL);
 511         new->priv->sockfd = sockfd;
 512         new->priv->non_blocking = sock->priv->non_blocking;
 513         new->priv->nodelay = sock->priv->nodelay;
 514         new->priv->is_server = TRUE;
 515         new->priv->ssl_creds = sock->priv->ssl_creds;
 516         update_fdflags (new);
 517
 518         new->priv->remote_addr = soup_address_new_from_sockaddr ((struct sockaddr *)&sa, sa_len);
 519
 520         if (new->priv->ssl_creds) {
 521                 if (!soup_socket_start_ssl (new)) {
 522                         g_object_unref (new);
 523                         return TRUE;
 524                 }
 525         } else
 526                 get_iochannel (new);
 527
 528         g_signal_emit (sock, signals[NEW_CONNECTION], 0, new);
 529         g_object_unref (new);
 530
 531         return TRUE;
 532 }
 533
 534 /**
 535  * soup_socket_listen:
 536  * @sock: a server #SoupSocket (which must not already be connected or
 537  * listening)
 538  * @local_addr: Local address to bind to.
 539  *
 540  * Makes @sock start listening on the given interface and port. When
 541  * connections come in, @sock will emit %new_connection.
 542  *
 543  * Return value: whether or not @sock is now listening.
 544  **/
 545 gboolean
 546 soup_socket_listen (SoupSocket *sock, SoupAddress *local_addr)
 547 {
 548         struct sockaddr *sa;
 549         int sa_len;
 550
 551         g_return_val_if_fail (SOUP_IS_SOCKET (sock), FALSE);
 552         g_return_val_if_fail (sock->priv->is_server, FALSE);
 553         g_return_val_if_fail (sock->priv->sockfd == -1, FALSE);
 554         g_return_val_if_fail (SOUP_IS_ADDRESS (local_addr), FALSE);
 555
 556         /* @local_addr may have its port set to 0. So we intentionally
 557          * don't store it in sock->priv->local_addr, so that if the
 558          * caller calls soup_socket_get_local_address() later, we'll
 559          * have to make a new addr by calling getsockname(), which
 560          * will have the right port number.
 561          */
 562         sa = soup_address_get_sockaddr (local_addr, &sa_len);
 563         g_return_val_if_fail (sa != NULL, FALSE);
 564
 565         sock->priv->sockfd = socket (sa->sa_family, SOCK_STREAM, 0);
 566         if (sock->priv->sockfd < 0)
 567                 goto cant_listen;
 568         update_fdflags (sock);
 569
 570         /* Bind */
 571         if (bind (sock->priv->sockfd, sa, sa_len) != 0)
 572                 goto cant_listen;
 573
 574         /* Listen */
 575         if (listen (sock->priv->sockfd, 10) != 0)
 576                 goto cant_listen;
 577
 578         sock->priv->watch = g_io_add_watch (get_iochannel (sock),
 579                                             G_IO_IN | G_IO_ERR | G_IO_HUP,
 580                                             listen_watch, sock);
 581         return TRUE;
 582
 583  cant_listen:
 584         if (sock->priv->sockfd != -1) {
 585                 close (sock->priv->sockfd);
 586                 sock->priv->sockfd = -1;
 587         }
 588         if (sa)
 589                 g_free (sa);
 590         return FALSE;
 591 }
 592
 593 /**
 594  * soup_socket_start_ssl:
 595  * @sock: the socket
 596  *
 597  * Starts using SSL on @socket.
 598  *
 599  * Return value: success or failure
 600  **/
 601 gboolean
 602 soup_socket_start_ssl (SoupSocket *sock)
 603 {
 604         GIOChannel *ssl_chan;
 605
 606         get_iochannel (sock);
 607         ssl_chan = soup_ssl_wrap_iochannel (
 608                 sock->priv->iochannel, sock->priv->is_server ?
 609                 SOUP_SSL_TYPE_SERVER : SOUP_SSL_TYPE_CLIENT,
 610                 soup_address_get_name (sock->priv->remote_addr),
 611                 sock->priv->ssl_creds);
 612
 613         if (!ssl_chan)
 614                 return FALSE;
 615
 616         sock->priv->iochannel = ssl_chan;
 617         return TRUE;
 618 }
 619
 620
 621 /**
 622  * soup_socket_client_new_async:
 623  * @hostname: remote machine to connect to
 624  * @port: remote port to connect to
 625  * @ssl_creds: SSL credentials structure, or %NULL if not SSL
 626  * @callback: callback to call when the socket is connected
 627  * @user_data: data for @callback
 628  *
 629  * Creates a connection to @hostname and @port. @callback will be
 630  * called when the connection completes (or fails).
 631  *
 632  * Return value: the new socket (not yet ready for use).
 633  **/
 634 SoupSocket *
 635 soup_socket_client_new_async (const char *hostname, guint port,
 636                               gpointer ssl_creds,
 637                               SoupSocketCallback callback, gpointer user_data)
 638 {
 639         SoupSocket *sock;
 640
 641         g_return_val_if_fail (hostname != NULL, NULL);
 642
 643         sock = g_object_new (SOUP_TYPE_SOCKET,
 644                              SOUP_SOCKET_SSL_CREDENTIALS, ssl_creds,
 645                              NULL);
 646         soup_socket_connect (sock, soup_address_new (hostname, port));
 647
 648         if (callback) {
 649                 soup_signal_connect_once (sock, "connect_result",
 650                                           G_CALLBACK (callback), user_data);
 651         }
 652         return sock;
 653 }
 654
 655 /**
 656  * soup_socket_client_new_sync:
 657  * @hostname: remote machine to connect to
 658  * @port: remote port to connect to
 659  * @ssl_creds: SSL credentials structure, or %NULL if not SSL
 660  * @status_ret: pointer to return the soup status in
 661  *
 662  * Creates a connection to @hostname and @port. If @status_ret is not
 663  * %NULL, it will contain a status code on return.
 664  *
 665  * Return value: the new socket, or %NULL if it could not connect.
 666  **/
 667 SoupSocket *
 668 soup_socket_client_new_sync (const char *hostname, guint port,
 669                              gpointer ssl_creds, guint *status_ret)
 670 {
 671         SoupSocket *sock;
 672         guint status;
 673
 674         g_return_val_if_fail (hostname != NULL, NULL);
 675
 676         sock = g_object_new (SOUP_TYPE_SOCKET,
 677                              SOUP_SOCKET_SSL_CREDENTIALS, ssl_creds,
 678                              NULL);
 679         sock->priv->non_blocking = FALSE;
 680         status = soup_socket_connect (sock, soup_address_new (hostname, port));
 681
 682         if (!SOUP_STATUS_IS_SUCCESSFUL (status)) {
 683                 g_object_unref (sock);
 684                 sock = NULL;
 685         }
 686
 687         if (status_ret)
 688                 *status_ret = status;
 689         return sock;
 690 }
 691
 692 /**
 693  * soup_socket_server_new:
 694  * @local_addr: Local address to bind to. (Use soup_address_any_new() to
 695  * accept connections on any local address)
 696  * @ssl_creds: SSL credentials, or %NULL if this is not an SSL server
 697  * @callback: Callback to call when a client connects
 698  * @user_data: data to pass to @callback.
 699  *
 700  * Create and open a new #SoupSocket listening on the specified
 701  * address. @callback will be called each time a client connects,
 702  * with a new #SoupSocket.
 703  *
 704  * Returns: a new #SoupSocket, or NULL if there was a failure.
 705  **/
 706 SoupSocket *
 707 soup_socket_server_new (SoupAddress *local_addr, gpointer ssl_creds,
 708                         SoupSocketListenerCallback callback,
 709                         gpointer user_data)
 710 {
 711         SoupSocket *sock;
 712
 713         g_return_val_if_fail (SOUP_IS_ADDRESS (local_addr), NULL);
 714
 715         sock = g_object_new (SOUP_TYPE_SOCKET,
 716                              SOUP_SOCKET_SSL_CREDENTIALS, ssl_creds,
 717                              NULL);
 718         sock->priv->is_server = TRUE;
 719         if (!soup_socket_listen (sock, local_addr)) {
 720                 g_object_unref (sock);
 721                 return NULL;
 722         }
 723
 724         if (callback) {
 725                 g_signal_connect (sock, "new_connection",
 726                                   G_CALLBACK (callback), user_data);
 727         }
 728
 729         return sock;
 730 }
 731
 732
 733 void
 734 soup_socket_disconnect (SoupSocket *sock)
 735 {
 736         gboolean already_disconnected = FALSE;
 737
 738         g_return_if_fail (SOUP_IS_SOCKET (sock));
 739
 740         if (g_mutex_trylock (sock->priv->iolock)) {
 741                 if (sock->priv->iochannel)
 742                         disconnect_internal (sock);
 743                 else
 744                         already_disconnected = TRUE;
 745                 g_mutex_unlock (sock->priv->iolock);
 746         } else {
 747                 int sockfd;
 748
 749                 /* Another thread is currently doing IO, so
 750                  * we can't close the iochannel. So just kick
 751                  * the file descriptor out from under it.
 752                  */
 753
 754                 sockfd = sock->priv->sockfd;
 755                 sock->priv->sockfd = -1;
 756                 if (sockfd == -1)
 757                         already_disconnected = TRUE;
 758                 else {
 759                         g_io_channel_set_close_on_unref (sock->priv->iochannel,
 760                                                          FALSE);
 761                         close (sockfd);
 762                 }
 763         }
 764
 765         if (already_disconnected)
 766                 return;
 767
 768         /* Give all readers a chance to notice the connection close */
 769         g_signal_emit (sock, signals[READABLE], 0);
 770
 771         /* FIXME: can't disconnect until all data is read */
 772
 773         /* Then let everyone know we're disconnected */
 774         g_signal_emit (sock, signals[DISCONNECTED], 0);
 775 }
 776
 777 gboolean
 778 soup_socket_is_connected (SoupSocket *sock)
 779 {
 780         g_return_val_if_fail (SOUP_IS_SOCKET (sock), FALSE);
 781
 782         return sock->priv->iochannel != NULL;
 783 }
 784
 785
 786 SoupAddress *
 787 soup_socket_get_local_address (SoupSocket *sock)
 788 {
 789         g_return_val_if_fail (SOUP_IS_SOCKET (sock), NULL);
 790
 791         g_mutex_lock (sock->priv->addrlock);
 792         if (!sock->priv->local_addr) {
 793                 struct soup_sockaddr_max bound_sa;
 794                 int sa_len;
 795
 796                 sa_len = sizeof (bound_sa);
 797                 getsockname (sock->priv->sockfd, (struct sockaddr *)&bound_sa, &sa_len);
 798                 sock->priv->local_addr = soup_address_new_from_sockaddr ((struct sockaddr *)&bound_sa, sa_len);
 799         }
 800         g_mutex_unlock (sock->priv->addrlock);
 801
 802         return sock->priv->local_addr;
 803 }
 804
 805 SoupAddress *
 806 soup_socket_get_remote_address (SoupSocket *sock)
 807 {
 808         g_return_val_if_fail (SOUP_IS_SOCKET (sock), NULL);
 809
 810         g_mutex_lock (sock->priv->addrlock);
 811         if (!sock->priv->remote_addr) {
 812                 struct soup_sockaddr_max bound_sa;
 813                 int sa_len;
 814
 815                 sa_len = sizeof (bound_sa);
 816                 getpeername (sock->priv->sockfd, (struct sockaddr *)&bound_sa, &sa_len);
 817                 sock->priv->remote_addr = soup_address_new_from_sockaddr ((struct sockaddr *)&bound_sa, sa_len);
 818         }
 819         g_mutex_unlock (sock->priv->addrlock);
 820
 821         return sock->priv->remote_addr;
 822 }
 823
 824
 825
 826
 827 static gboolean
 828 socket_read_watch (GIOChannel *chan, GIOCondition cond, gpointer user_data)
 829 {
 830         SoupSocket *sock = user_data;
 831
 832         sock->priv->read_tag = 0;
 833         g_signal_emit (sock, signals[READABLE], 0);
 834
 835         return FALSE;
 836 }
 837
 838 static SoupSocketIOStatus
 839 read_from_network (SoupSocket *sock, gpointer buffer, gsize len, gsize *nread)
 840 {
 841         GIOStatus status;
 842
 843         if (!sock->priv->iochannel)
 844                 return SOUP_SOCKET_EOF;
 845
 846         status = g_io_channel_read_chars (sock->priv->iochannel,
 847                                           buffer, len, nread, NULL);
 848         switch (status) {
 849         case G_IO_STATUS_NORMAL:
 850         case G_IO_STATUS_AGAIN:
 851                 if (*nread > 0)
 852                         return SOUP_SOCKET_OK;
 853
 854                 if (!sock->priv->read_tag) {
 855                         sock->priv->read_tag =
 856                                 g_io_add_watch (sock->priv->iochannel, G_IO_IN,
 857                                                 socket_read_watch, sock);
 858                 }
 859                 return SOUP_SOCKET_WOULD_BLOCK;
 860
 861         case G_IO_STATUS_EOF:
 862                 return SOUP_SOCKET_EOF;
 863
 864         default:
 865                 return SOUP_SOCKET_ERROR;
 866         }
 867 }
 868
 869 static SoupSocketIOStatus
 870 read_from_buf (SoupSocket *sock, gpointer buffer, gsize len, gsize *nread)
 871 {
 872         GByteArray *read_buf = sock->priv->read_buf;
 873
 874         *nread = MIN (read_buf->len, len);
 875         memcpy (buffer, read_buf->data, *nread);
 876
 877         if (*nread == read_buf->len) {
 878                 g_byte_array_free (read_buf, TRUE);
 879                 sock->priv->read_buf = NULL;
 880         } else {
 881                 memcpy (read_buf->data, read_buf->data + *nread,
 882                         read_buf->len - *nread);
 883                 g_byte_array_set_size (read_buf, read_buf->len - *nread);
 884         }
 885
 886         return SOUP_SOCKET_OK;
 887 }
 888
 889 /**
 890  * soup_socket_read:
 891  * @sock: the socket
 892  * @buffer: buffer to read into
 893  * @len: size of @buffer in bytes
 894  * @nread: on return, the number of bytes read into @buffer
 895  *
 896  * Attempts to read up to @len bytes from @sock into @buffer. If some
 897  * data is successfully read, soup_socket_read() will return
 898  * %SOUP_SOCKET_OK, and *@nread will contain the number of bytes
 899  * actually read.
 900  *
 901  * If @sock is non-blocking, and no data is available, the return
 902  * value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, the caller
 903  * can connect to the %readable signal to know when there is more data
 904  * to read. (NB: You MUST read all available data off the socket
 905  * first. The %readable signal will only be emitted after
 906  * soup_socket_read() has returned %SOUP_SOCKET_WOULD_BLOCK.)
 907  *
 908  * Return value: a #SoupSocketIOStatus, as described above (or
 909  * %SOUP_SOCKET_EOF if the socket is no longer connected, or
 910  * %SOUP_SOCKET_ERROR on any other error).
 911  **/
 912 SoupSocketIOStatus
 913 soup_socket_read (SoupSocket *sock, gpointer buffer, gsize len, gsize *nread)
 914 {
 915         SoupSocketIOStatus status;
 916
 917         g_return_val_if_fail (SOUP_IS_SOCKET (sock), SOUP_SOCKET_ERROR);
 918
 919         g_mutex_lock (sock->priv->iolock);
 920         if (sock->priv->read_buf)
 921                 status = read_from_buf (sock, buffer, len, nread);
 922         else
 923                 status = read_from_network (sock, buffer, len, nread);
 924         g_mutex_unlock (sock->priv->iolock);
 925
 926         return status;
 927 }
 928
 929 /**
 930  * soup_socket_read_until:
 931  * @sock: the socket
 932  * @buffer: buffer to read into
 933  * @len: size of @buffer in bytes
 934  * @boundary: boundary to read until
 935  * @boundary_len: length of @boundary in bytes
 936  * @nread: on return, the number of bytes read into @buffer
 937  * @got_boundary: on return, whether or not the data in @buffer
 938  * ends with the boundary string
 939  *
 940  * Like soup_socket_read(), but reads no further than the first
 941  * occurrence of @boundary. (If the boundary is found, it will be
 942  * included in the returned data, and *@got_boundary will be set to
 943  * %TRUE.) Any data after the boundary will returned in future reads.
 944  *
 945  * Return value: as for soup_socket_read()
 946  **/
 947 SoupSocketIOStatus
 948 soup_socket_read_until (SoupSocket *sock, gpointer buffer, gsize len,
 949                         gconstpointer boundary, gsize boundary_len,
 950                         gsize *nread, gboolean *got_boundary)
 951 {
 952         SoupSocketIOStatus status;
 953         GByteArray *read_buf;
 954         guint match_len, prev_len;
 955         guint8 *p, *end;
 956
 957         g_return_val_if_fail (SOUP_IS_SOCKET (sock), SOUP_SOCKET_ERROR);
 958         g_return_val_if_fail (len >= boundary_len, SOUP_SOCKET_ERROR);
 959
 960         g_mutex_lock (sock->priv->iolock);
 961
 962         *got_boundary = FALSE;
 963
 964         if (!sock->priv->read_buf)
 965                 sock->priv->read_buf = g_byte_array_new ();
 966         read_buf = sock->priv->read_buf;
 967
 968         if (read_buf->len < boundary_len) {
 969                 prev_len = read_buf->len;
 970                 g_byte_array_set_size (read_buf, len);
 971                 status = read_from_network (sock,
 972                                             read_buf->data + prev_len,
 973                                             len - prev_len, nread);
 974                 read_buf->len = prev_len + *nread;
 975
 976                 if (status != SOUP_SOCKET_OK) {
 977                         g_mutex_unlock (sock->priv->iolock);
 978                         return status;
 979                 }
 980         }
 981
 982         /* Scan for the boundary */
 983         end = read_buf->data + read_buf->len;
 984         for (p = read_buf->data; p <= end - boundary_len; p++) {
 985                 if (!memcmp (p, boundary, boundary_len)) {
 986                         p += boundary_len;
 987                         *got_boundary = TRUE;
 988                         break;
 989                 }
 990         }
 991
 992         /* Return everything up to 'p' (which is either just after the
 993          * boundary, or @boundary_len - 1 bytes before the end of the
 994          * buffer).
 995          */
 996         match_len = p - read_buf->data;
 997         status = read_from_buf (sock, buffer, MIN (len, match_len), nread);
 998
 999         g_mutex_unlock (sock->priv->iolock);
1000         return status;
1001 }
1002
1003 static gboolean
1004 socket_write_watch (GIOChannel *chan, GIOCondition condition, gpointer user_data)
1005 {
1006         SoupSocket *sock = user_data;
1007
1008         sock->priv->write_tag = 0;
1009         g_signal_emit (sock, signals[WRITABLE], 0);
1010
1011         return FALSE;
1012 }
1013
1014 /**
1015  * soup_socket_write:
1016  * @sock: the socket
1017  * @buffer: data to write
1018  * @len: size of @buffer, in bytes
1019  * @nwrote: on return, number of bytes written
1020  *
1021  * Attempts to write @len bytes from @buffer to @sock. If some data is
1022  * successfully written, the resturn status will be
1023  * %SOUP_SOCKET_SUCCESS, and *@nwrote will contain the number of bytes
1024  * actually written.
1025  *
1026  * If @sock is non-blocking, and no data could be written right away,
1027  * the return value will be %SOUP_SOCKET_WOULD_BLOCK. In this case,
1028  * the caller can connect to the %writable signal to know when more
1029  * data can be written. (NB: %writable is only emitted after a
1030  * %SOUP_SOCKET_WOULD_BLOCK.)
1031  *
1032  * Return value: a #SoupSocketIOStatus, as described above (or
1033  * %SOUP_SOCKET_EOF or %SOUP_SOCKET_ERROR).
1034  **/
1035 SoupSocketIOStatus
1036 soup_socket_write (SoupSocket *sock, gconstpointer buffer,
1037                    gsize len, gsize *nwrote)
1038 {
1039         GIOStatus status;
1040         gpointer pipe_handler;
1041
1042         g_return_val_if_fail (SOUP_IS_SOCKET (sock), SOUP_SOCKET_ERROR);
1043
1044         g_mutex_lock (sock->priv->iolock);
1045
1046         if (!sock->priv->iochannel) {
1047                 g_mutex_unlock (sock->priv->iolock);
1048                 return SOUP_SOCKET_EOF;
1049         }
1050         if (sock->priv->write_tag) {
1051                 g_mutex_unlock (sock->priv->iolock);
1052                 return SOUP_SOCKET_WOULD_BLOCK;
1053         }
1054
1055         pipe_handler = signal (SIGPIPE, SIG_IGN);
1056         status = g_io_channel_write_chars (sock->priv->iochannel,
1057                                            buffer, len, nwrote, NULL);
1058         signal (SIGPIPE, pipe_handler);
1059         if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN) {
1060                 g_mutex_unlock (sock->priv->iolock);
1061                 return SOUP_SOCKET_ERROR;
1062         }
1063
1064         if (*nwrote) {
1065                 g_mutex_unlock (sock->priv->iolock);
1066                 return SOUP_SOCKET_OK;
1067         }
1068
1069         sock->priv->write_tag =
1070                 g_io_add_watch (sock->priv->iochannel, G_IO_OUT,
1071                                 socket_write_watch, sock);
1072         g_mutex_unlock (sock->priv->iolock);
1073         return SOUP_SOCKET_WOULD_BLOCK;
1074 }