gio/gdbusutils.c

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2009 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include <glib/gi18n.h>
  29
  30 #include "gdbusutils.h"
  31
  32 /**
  33  * SECTION:gdbusutils
  34  * @title: D-Bus Utilities
  35  * @short_description: Various utilities related to D-Bus.
  36  * @include: gdbus/gdbus.h
  37  *
  38  * Various utility routines related to D-Bus.
  39  */
  40
  41 static gboolean
  42 is_valid_bus_name_character (gint c,
  43                              gboolean allow_hyphen)
  44 {
  45   return
  46     (c >= '0' && c <= '9') ||
  47     (c >= 'A' && c <= 'Z') ||
  48     (c >= 'a' && c <= 'z') ||
  49     (c == '_') ||
  50     (allow_hyphen && c == '-');
  51 }
  52
  53 static gboolean
  54 is_valid_initial_bus_name_character (gint c,
  55                                      gboolean allow_initial_digit,
  56                                      gboolean allow_hyphen)
  57 {
  58   if (allow_initial_digit)
  59     return is_valid_bus_name_character (c, allow_hyphen);
  60   else
  61     return
  62       (c >= 'A' && c <= 'Z') ||
  63       (c >= 'a' && c <= 'z') ||
  64       (c == '_') ||
  65       (allow_hyphen && c == '-');
  66 }
  67
  68 static gboolean
  69 is_valid_name (const gchar *start,
  70                guint len,
  71                gboolean allow_initial_digit,
  72                gboolean allow_hyphen)
  73 {
  74   gboolean ret;
  75   const gchar *s;
  76   const gchar *end;
  77   gboolean has_dot;
  78
  79   ret = FALSE;
  80
  81   if (len == 0)
  82     goto out;
  83
  84   s = start;
  85   end = s + len;
  86   has_dot = FALSE;
  87   while (s != end)
  88     {
  89       if (*s == '.')
  90         {
  91           s += 1;
  92           if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, allow_initial_digit, allow_hyphen)))
  93             goto out;
  94           has_dot = TRUE;
  95         }
  96       else if (G_UNLIKELY (!is_valid_bus_name_character (*s, allow_hyphen)))
  97         {
  98           goto out;
  99         }
 100       s += 1;
 101     }
 102
 103   if (G_UNLIKELY (!has_dot))
 104     goto out;
 105
 106   ret = TRUE;
 107
 108  out:
 109   return ret;
 110 }
 111
 112 /**
 113  * g_dbus_is_name:
 114  * @string: The string to check.
 115  *
 116  * Checks if @string is a valid D-Bus bus name (either unique or well-known).
 117  *
 118  * Returns: %TRUE if valid, %FALSE otherwise.
 119  */
 120 gboolean
 121 g_dbus_is_name (const gchar *string)
 122 {
 123   guint len;
 124   gboolean ret;
 125   const gchar *s;
 126   const gchar *end;
 127
 128   g_return_val_if_fail (string != NULL, FALSE);
 129
 130   ret = FALSE;
 131
 132   len = strlen (string);
 133   if (G_UNLIKELY (len == 0 || len > 255))
 134     goto out;
 135
 136   s = string;
 137   end = s + len;
 138   if (*s == ':')
 139     {
 140       /* handle unique name */
 141       if (!is_valid_name (s + 1, len - 1, TRUE, TRUE))
 142         goto out;
 143       ret = TRUE;
 144       goto out;
 145     }
 146   else if (G_UNLIKELY (*s == '.'))
 147     {
 148       /* can't start with a . */
 149       goto out;
 150     }
 151   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, TRUE)))
 152     goto out;
 153
 154   ret = is_valid_name (s + 1, len - 1, FALSE, TRUE);
 155
 156  out:
 157   return ret;
 158 }
 159
 160 /**
 161  * g_dbus_is_unique_name:
 162  * @string: The string to check.
 163  *
 164  * Checks if @string is a valid D-Bus unique bus name.
 165  *
 166  * Returns: %TRUE if valid, %FALSE otherwise.
 167  */
 168 gboolean
 169 g_dbus_is_unique_name (const gchar *string)
 170 {
 171   gboolean ret;
 172   guint len;
 173
 174   g_return_val_if_fail (string != NULL, FALSE);
 175
 176   ret = FALSE;
 177
 178   len = strlen (string);
 179   if (G_UNLIKELY (len == 0 || len > 255))
 180     goto out;
 181
 182   if (G_UNLIKELY (*string != ':'))
 183     goto out;
 184
 185   if (G_UNLIKELY (!is_valid_name (string + 1, len - 1, TRUE, TRUE)))
 186     goto out;
 187
 188   ret = TRUE;
 189
 190  out:
 191   return ret;
 192 }
 193
 194 /**
 195  * g_dbus_is_member_name:
 196  * @string: The string to check.
 197  *
 198  * Checks if @string is a valid D-Bus member (e.g. signal or method) name.
 199  *
 200  * Returns: %TRUE if valid, %FALSE otherwise.
 201  */
 202 gboolean
 203 g_dbus_is_member_name (const gchar *string)
 204 {
 205   gboolean ret;
 206   guint n;
 207
 208   ret = FALSE;
 209   if (G_UNLIKELY (string == NULL))
 210     goto out;
 211
 212   if (G_UNLIKELY (!is_valid_initial_bus_name_character (string[0], FALSE, FALSE)))
 213     goto out;
 214
 215   for (n = 1; string[n] != '\0'; n++)
 216     {
 217       if (G_UNLIKELY (!is_valid_bus_name_character (string[n], FALSE)))
 218         {
 219           goto out;
 220         }
 221     }
 222
 223   ret = TRUE;
 224
 225  out:
 226   return ret;
 227 }
 228
 229 /**
 230  * g_dbus_is_interface_name:
 231  * @string: The string to check.
 232  *
 233  * Checks if @string is a valid D-Bus interface name.
 234  *
 235  * Returns: %TRUE if valid, %FALSE otherwise.
 236  */
 237 gboolean
 238 g_dbus_is_interface_name (const gchar *string)
 239 {
 240   guint len;
 241   gboolean ret;
 242   const gchar *s;
 243   const gchar *end;
 244
 245   g_return_val_if_fail (string != NULL, FALSE);
 246
 247   ret = FALSE;
 248
 249   len = strlen (string);
 250   if (G_UNLIKELY (len == 0 || len > 255))
 251     goto out;
 252
 253   s = string;
 254   end = s + len;
 255   if (G_UNLIKELY (*s == '.'))
 256     {
 257       /* can't start with a . */
 258       goto out;
 259     }
 260   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, FALSE)))
 261     goto out;
 262
 263   ret = is_valid_name (s + 1, len - 1, FALSE, FALSE);
 264
 265  out:
 266   return ret;
 267 }
 268
 269 /* ---------------------------------------------------------------------------------------------------- */
 270
 271 /* TODO: maybe move to glib? if so, it should conform to http://en.wikipedia.org/wiki/Guid and/or
 272  *       http://tools.ietf.org/html/rfc4122 - specifically it should have hyphens then.
 273  */
 274
 275 /**
 276  * g_dbus_generate_guid:
 277  *
 278  * Generate a D-Bus GUID that can be used with
 279  * e.g. g_dbus_connection_new().
 280  *
 281  * See the D-Bus specification regarding what strings are valid D-Bus
 282  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
 283  *
 284  * Returns: A valid D-Bus GUID. Free with g_free().
 285  */
 286 gchar *
 287 g_dbus_generate_guid (void)
 288 {
 289   GString *s;
 290   GTimeVal now;
 291   guint32 r1;
 292   guint32 r2;
 293   guint32 r3;
 294
 295   s = g_string_new (NULL);
 296
 297   r1 = g_random_int ();
 298   r2 = g_random_int ();
 299   r3 = g_random_int ();
 300   g_get_current_time (&now);
 301
 302   g_string_append_printf (s, "%08x", r1);
 303   g_string_append_printf (s, "%08x", r2);
 304   g_string_append_printf (s, "%08x", r3);
 305   g_string_append_printf (s, "%08x", (guint32) now.tv_sec);
 306
 307   return g_string_free (s, FALSE);
 308 }
 309
 310 /**
 311  * g_dbus_is_guid:
 312  * @string: The string to check.
 313  *
 314  * Checks if @string is a D-Bus GUID.
 315  *
 316  * See the D-Bus specification regarding what strings are valid D-Bus
 317  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
 318  *
 319  * Returns: %TRUE if @string is a guid, %FALSE otherwise.
 320  */
 321 gboolean
 322 g_dbus_is_guid (const gchar *string)
 323 {
 324   gboolean ret;
 325   guint n;
 326
 327   g_return_val_if_fail (string != NULL, FALSE);
 328
 329   ret = FALSE;
 330
 331   for (n = 0; n < 32; n++)
 332     {
 333       if (!g_ascii_isxdigit (string[n]))
 334         goto out;
 335     }
 336   if (string[32] != '\0')
 337     goto out;
 338
 339   ret = TRUE;
 340
 341  out:
 342   return ret;
 343 }
 344
 345 /* ---------------------------------------------------------------------------------------------------- */
 346
 347
 348 /**
 349  * g_dbus_is_activated:
 350  *
 351  * Determine if the process has been activated by a message bus.
 352  *
 353  * Returns: %TRUE if this process has been started by a message bus, %FALSE otherwise.
 354  */
 355 gboolean
 356 g_dbus_is_activated (void)
 357 {
 358   /* TODO: technically this will make child processes forked by us
 359    * return TRUE too..
 360    */
 361   return g_getenv ("DBUS_STARTER_BUS_TYPE") != NULL;
 362 }
 363
 364 /* ---------------------------------------------------------------------------------------------------- */