[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / gio / ginetsocketaddress.c
index b8275a8..5cf26f7 100644 (file)
@@ -13,9 +13,7 @@
  * 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., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  *
  * Authors: Christian Kellner <gicmo@gnome.org>
  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
 #include "ginetsocketaddress.h"
 #include "ginetaddress.h"
 #include "gnetworkingprivate.h"
+#include "gioerror.h"
+#include "glibintl.h"
 
-#include "gioalias.h"
 
 /**
  * SECTION:ginetsocketaddress
- * @short_description: Internet socket addresses
+ * @short_description: Internet GSocketAddress
+ * @include: gio/gio.h
  *
  * An IPv4 or IPv6 socket address; that is, the combination of a
  * #GInetAddress and a port number.
- **/
+ */
 
 /**
  * GInetSocketAddress:
  *
- * An IPv4 or IPv6 socket address, corresponding to a <type>struct
- * sockaddr_in</type> or <type>struct sockaddr_in6</type>.
- **/
-G_DEFINE_TYPE (GInetSocketAddress, g_inet_socket_address, G_TYPE_SOCKET_ADDRESS);
-
-enum {
-  PROP_0,
-  PROP_ADDRESS,
-  PROP_PORT
-};
+ * An IPv4 or IPv6 socket address, corresponding to a struct
+ * sockaddr_in or struct sockaddr_in6.
+ */
 
 struct _GInetSocketAddressPrivate
 {
   GInetAddress *address;
   guint16       port;
+  guint32       flowinfo;
+  guint32       scope_id;
 };
 
-static void
-g_inet_socket_address_finalize (GObject *object)
-{
-  GInetSocketAddress *address G_GNUC_UNUSED = G_INET_SOCKET_ADDRESS (object);
+G_DEFINE_TYPE_WITH_PRIVATE (GInetSocketAddress, g_inet_socket_address, G_TYPE_SOCKET_ADDRESS)
 
-  if (G_OBJECT_CLASS (g_inet_socket_address_parent_class)->finalize)
-    (*G_OBJECT_CLASS (g_inet_socket_address_parent_class)->finalize) (object);
-}
+enum {
+  PROP_0,
+  PROP_ADDRESS,
+  PROP_PORT,
+  PROP_FLOWINFO,
+  PROP_SCOPE_ID
+};
 
 static void
 g_inet_socket_address_dispose (GObject *object)
 {
-  GInetSocketAddress *address G_GNUC_UNUSED = G_INET_SOCKET_ADDRESS (object);
+  GInetSocketAddress *address = G_INET_SOCKET_ADDRESS (object);
 
-  g_object_unref (address->priv->address);
+  g_clear_object (&(address->priv->address));
 
-  if (G_OBJECT_CLASS (g_inet_socket_address_parent_class)->dispose)
-    (*G_OBJECT_CLASS (g_inet_socket_address_parent_class)->dispose) (object);
+  G_OBJECT_CLASS (g_inet_socket_address_parent_class)->dispose (object);
 }
 
 static void
@@ -97,6 +92,16 @@ g_inet_socket_address_get_property (GObject    *object,
         g_value_set_uint (value, address->priv->port);
         break;
 
+      case PROP_FLOWINFO:
+       g_return_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6);
+        g_value_set_uint (value, address->priv->flowinfo);
+        break;
+
+      case PROP_SCOPE_ID:
+       g_return_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6);
+        g_value_set_uint (value, address->priv->scope_id);
+        break;
+
       default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -120,6 +125,17 @@ g_inet_socket_address_set_property (GObject      *object,
         address->priv->port = (guint16) g_value_get_uint (value);
         break;
 
+      case PROP_FLOWINFO:
+       /* We can't test that address->priv->address is IPv6 here,
+        * since this property might get set before PROP_ADDRESS.
+        */
+        address->priv->flowinfo = g_value_get_uint (value);
+        break;
+
+      case PROP_SCOPE_ID:
+        address->priv->scope_id = g_value_get_uint (value);
+        break;
+
       default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -157,14 +173,15 @@ g_inet_socket_address_get_native_size (GSocketAddress *address)
 }
 
 static gboolean
-g_inet_socket_address_to_native (GSocketAddress *address,
-                                 gpointer        dest,
-                                gsize           destlen)
+g_inet_socket_address_to_native (GSocketAddress  *address,
+                                 gpointer         dest,
+                                gsize            destlen,
+                                GError         **error)
 {
   GInetSocketAddress *addr;
   GSocketFamily family;
 
-  g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
+  g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), FALSE);
 
   addr = G_INET_SOCKET_ADDRESS (address);
   family = g_inet_address_get_family (addr->priv->address);
@@ -174,7 +191,11 @@ g_inet_socket_address_to_native (GSocketAddress *address,
       struct sockaddr_in *sock = (struct sockaddr_in *) dest;
 
       if (destlen < sizeof (*sock))
-       return FALSE;
+       {
+         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NO_SPACE,
+                              _("Not enough space for socket address"));
+         return FALSE;
+       }
 
       sock->sin_family = AF_INET;
       sock->sin_port = g_htons (addr->priv->port);
@@ -187,16 +208,26 @@ g_inet_socket_address_to_native (GSocketAddress *address,
       struct sockaddr_in6 *sock = (struct sockaddr_in6 *) dest;
 
       if (destlen < sizeof (*sock))
-       return FALSE;
+       {
+         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NO_SPACE,
+                              _("Not enough space for socket address"));
+         return FALSE;
+       }
 
-      memset (sock, 0, sizeof (sock));
+      memset (sock, 0, sizeof (*sock));
       sock->sin6_family = AF_INET6;
       sock->sin6_port = g_htons (addr->priv->port);
+      sock->sin6_flowinfo = addr->priv->flowinfo;
+      sock->sin6_scope_id = addr->priv->scope_id;
       memcpy (&(sock->sin6_addr.s6_addr), g_inet_address_to_bytes (addr->priv->address), sizeof (sock->sin6_addr));
       return TRUE;
     }
   else
-    return FALSE;
+    {
+      g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+                          _("Unsupported socket address"));
+      return FALSE;
+    }
 }
 
 static void
@@ -205,9 +236,6 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
   GSocketAddressClass *gsocketaddress_class = G_SOCKET_ADDRESS_CLASS (klass);
 
-  g_type_class_add_private (klass, sizeof (GInetSocketAddressPrivate));
-
-  gobject_class->finalize = g_inet_socket_address_finalize;
   gobject_class->dispose = g_inet_socket_address_dispose;
   gobject_class->set_property = g_inet_socket_address_set_property;
   gobject_class->get_property = g_inet_socket_address_get_property;
@@ -218,30 +246,65 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
 
   g_object_class_install_property (gobject_class, PROP_ADDRESS,
                                    g_param_spec_object ("address",
-                                                        "address",
-                                                        "address",
+                                                        P_("Address"),
+                                                        P_("The address"),
                                                         G_TYPE_INET_ADDRESS,
-                                                        G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
+                                                        G_PARAM_CONSTRUCT_ONLY |
+                                                        G_PARAM_READWRITE |
+                                                        G_PARAM_STATIC_STRINGS));
 
   g_object_class_install_property (gobject_class, PROP_PORT,
                                    g_param_spec_uint ("port",
-                                                      "port",
-                                                      "port",
+                                                      P_("Port"),
+                                                      P_("The port"),
                                                       0,
                                                       65535,
                                                       0,
-                                                      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
+                                                      G_PARAM_CONSTRUCT_ONLY |
+                                                      G_PARAM_READWRITE |
+                                                      G_PARAM_STATIC_STRINGS));
+
+  /**
+   * GInetSocketAddress:flowinfo:
+   *
+   * The `sin6_flowinfo` field, for IPv6 addresses.
+   *
+   * Since: 2.32
+   */
+  g_object_class_install_property (gobject_class, PROP_FLOWINFO,
+                                   g_param_spec_uint ("flowinfo",
+                                                      P_("Flow info"),
+                                                      P_("IPv6 flow info"),
+                                                      0,
+                                                      G_MAXUINT32,
+                                                      0,
+                                                      G_PARAM_CONSTRUCT_ONLY |
+                                                      G_PARAM_READWRITE |
+                                                      G_PARAM_STATIC_STRINGS));
+
+  /**
+   * GInetSocketAddress:scope_id:
+   *
+   * The `sin6_scope_id` field, for IPv6 addresses.
+   *
+   * Since: 2.32
+   */
+  g_object_class_install_property (gobject_class, PROP_SCOPE_ID,
+                                   g_param_spec_uint ("scope-id",
+                                                      P_("Scope ID"),
+                                                      P_("IPv6 scope ID"),
+                                                      0,
+                                                      G_MAXUINT32,
+                                                      0,
+                                                      G_PARAM_CONSTRUCT_ONLY |
+                                                      G_PARAM_READWRITE |
+                                                      G_PARAM_STATIC_STRINGS));
 }
 
 static void
 g_inet_socket_address_init (GInetSocketAddress *address)
 {
-  address->priv = G_TYPE_INSTANCE_GET_PRIVATE (address,
-                                               G_TYPE_INET_SOCKET_ADDRESS,
-                                               GInetSocketAddressPrivate);
-
-  address->priv->address = NULL;
-  address->priv->port = 0;
+  address->priv = g_inet_socket_address_get_instance_private (address);
 }
 
 /**
@@ -266,12 +329,88 @@ g_inet_socket_address_new (GInetAddress *address,
 }
 
 /**
+ * g_inet_socket_address_new_from_string:
+ * @address: the string form of an IP address
+ * @port: a port number
+ *
+ * Creates a new #GInetSocketAddress for @address and @port.
+ *
+ * If @address is an IPv6 address, it can also contain a scope ID
+ * (separated from the address by a "<literal>%</literal>").
+ *
+ * Returns: a new #GInetSocketAddress, or %NULL if @address cannot be
+ * parsed.
+ *
+ * Since: 2.40
+ */
+GSocketAddress *
+g_inet_socket_address_new_from_string (const char *address,
+                                       guint       port)
+{
+  static struct addrinfo *hints, hints_struct;
+  GSocketAddress *saddr;
+  GInetAddress *iaddr;
+  struct addrinfo *res;
+  gint status;
+
+  if (strchr (address, ':'))
+    {
+      /* IPv6 address (or it's invalid). We use getaddrinfo() because
+       * it will handle parsing a scope_id as well.
+       */
+
+      if (G_UNLIKELY (g_once_init_enter (&hints)))
+        {
+          hints_struct.ai_family = AF_UNSPEC;
+          hints_struct.ai_socktype = SOCK_STREAM;
+          hints_struct.ai_protocol = 0;
+          hints_struct.ai_flags = AI_NUMERICHOST;
+          g_once_init_leave (&hints, &hints_struct);
+        }
+
+      status = getaddrinfo (address, NULL, hints, &res);
+      if (status != 0)
+        return NULL;
+
+      if (res->ai_family == AF_INET6 &&
+          res->ai_addrlen == sizeof (struct sockaddr_in6))
+        {
+          ((struct sockaddr_in6 *)res->ai_addr)->sin6_port = g_htons (port);
+          saddr = g_socket_address_new_from_native (res->ai_addr, res->ai_addrlen);
+        }
+      else
+        saddr = NULL;
+
+      freeaddrinfo (res);
+    }
+  else
+    {
+      /* IPv4 (or invalid). We don't want to use getaddrinfo() here,
+       * because it accepts the stupid "IPv4 numbers-and-dots
+       * notation" addresses that are never used for anything except
+       * phishing. Since we don't have to worry about scope IDs for
+       * IPv4, we can just use g_inet_address_new_from_string().
+       */
+      iaddr = g_inet_address_new_from_string (address);
+      if (!iaddr)
+        return NULL;
+
+      g_warn_if_fail (g_inet_address_get_family (iaddr) == G_SOCKET_FAMILY_IPV4);
+
+      saddr = g_inet_socket_address_new (iaddr, port);
+      g_object_unref (iaddr);
+    }
+
+  return saddr;
+}
+
+/**
  * g_inet_socket_address_get_address:
  * @address: a #GInetSocketAddress
  *
  * Gets @address's #GInetAddress.
  *
- * Returns: the #GInetAddress for @address, which must be
+ * Returns: (transfer none): the #GInetAddress for @address, which must be
  * g_object_ref()'d if it will be stored
  *
  * Since: 2.22
@@ -302,5 +441,43 @@ g_inet_socket_address_get_port (GInetSocketAddress *address)
   return address->priv->port;
 }
 
-#define __G_INET_SOCKET_ADDRESS_C__
-#include "gioaliasdef.c"
+
+/**
+ * g_inet_socket_address_get_flowinfo:
+ * @address: a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress
+ *
+ * Gets the `sin6_flowinfo` field from @address,
+ * which must be an IPv6 address.
+ *
+ * Returns: the flowinfo field
+ *
+ * Since: 2.32
+ */
+guint32
+g_inet_socket_address_get_flowinfo (GInetSocketAddress *address)
+{
+  g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
+  g_return_val_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6, 0);
+
+  return address->priv->flowinfo;
+}
+
+/**
+ * g_inet_socket_address_get_scope_id:
+ * @address: a %G_SOCKET_FAMILY_IPV6 #GInetAddress
+ *
+ * Gets the `sin6_scope_id` field from @address,
+ * which must be an IPv6 address.
+ *
+ * Returns: the scope id field
+ *
+ * Since: 2.32
+ */
+guint32
+g_inet_socket_address_get_scope_id (GInetSocketAddress *address)
+{
+  g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
+  g_return_val_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6, 0);
+
+  return address->priv->scope_id;
+}