tools/dbus-print-message.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-print-message.h  Utility function to print out a message
   3  *
   4  * Copyright (C) 2003 Philip Blundell <philb@gnu.org>
   5  * Copyright (C) 2003 Red Hat, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  */
  22 #include "dbus-print-message.h"
  23
  24 #include <stdlib.h>
  25 #include "config.h"
  26
  27 static const char*
  28 type_to_name (int message_type)
  29 {
  30   switch (message_type)
  31     {
  32     case DBUS_MESSAGE_TYPE_SIGNAL:
  33       return "signal";
  34     case DBUS_MESSAGE_TYPE_METHOD_CALL:
  35       return "method call";
  36     case DBUS_MESSAGE_TYPE_METHOD_RETURN:
  37       return "method return";
  38     case DBUS_MESSAGE_TYPE_ERROR:
  39       return "error";
  40     default:
  41       return "(unknown message type)";
  42     }
  43 }
  44
  45 #define INDENT 3
  46
  47 static void
  48 indent (int depth)
  49 {
  50   while (depth-- > 0)
  51     printf ("   "); /* INDENT spaces. */
  52 }
  53
  54 static void
  55 print_hex (unsigned char *bytes, unsigned int len, int depth)
  56 {
  57   int i, columns;
  58
  59   printf ("array of bytes [\n");
  60
  61   indent (depth + 1);
  62
  63   /* Each byte takes 3 cells (two hexits, and a space), except the last one. */
  64   columns = (80 - ((depth + 1) * INDENT)) / 3;
  65
  66   if (columns < 8)
  67     columns = 8;
  68
  69   i = 0;
  70
  71   while (i < len)
  72     {
  73       printf ("%02x", bytes[i]);
  74       i++;
  75
  76       if (i != len)
  77         {
  78           if (i % columns == 0)
  79             {
  80               printf ("\n");
  81               indent (depth + 1);
  82             }
  83           else
  84             {
  85               printf (" ");
  86             }
  87         }
  88     }
  89
  90   printf ("\n");
  91   indent (depth);
  92   printf ("]\n");
  93 }
  94
  95 #define DEFAULT_SIZE 100
  96
  97 static void
  98 print_ay (DBusMessageIter *iter, int depth)
  99 {
 100   /* Not using DBusString because it's not public API. It's 2009, and I'm
 101    * manually growing a string chunk by chunk.
 102    */
 103   unsigned char *bytes = malloc (DEFAULT_SIZE + 1);
 104   unsigned int len = 0;
 105   unsigned int max = DEFAULT_SIZE;
 106   dbus_bool_t all_ascii = TRUE;
 107   int current_type;
 108
 109   while ((current_type = dbus_message_iter_get_arg_type (iter))
 110           != DBUS_TYPE_INVALID)
 111     {
 112       unsigned char val;
 113
 114       dbus_message_iter_get_basic (iter, &val);
 115       bytes[len] = val;
 116       len++;
 117
 118       if (val < 32 || val > 126)
 119         all_ascii = FALSE;
 120
 121       if (len == max)
 122         {
 123           max *= 2;
 124           bytes = realloc (bytes, max + 1);
 125         }
 126
 127       dbus_message_iter_next (iter);
 128     }
 129
 130   if (all_ascii)
 131     {
 132       bytes[len] = '\0';
 133       printf ("array of bytes \"%s\"\n", bytes);
 134     }
 135   else
 136     {
 137       print_hex (bytes, len, depth);
 138     }
 139
 140   free (bytes);
 141 }
 142
 143 static void
 144 print_iter (DBusMessageIter *iter, dbus_bool_t literal, int depth)
 145 {
 146   do
 147     {
 148       int type = dbus_message_iter_get_arg_type (iter);
 149
 150       if (type == DBUS_TYPE_INVALID)
 151         break;
 152
 153       indent(depth);
 154
 155       switch (type)
 156         {
 157         case DBUS_TYPE_STRING:
 158           {
 159             char *val;
 160             dbus_message_iter_get_basic (iter, &val);
 161             if (!literal)
 162               printf ("string \"");
 163             printf ("%s", val);
 164             if (!literal)
 165               printf ("\"\n");
 166             break;
 167           }
 168
 169         case DBUS_TYPE_SIGNATURE:
 170           {
 171             char *val;
 172             dbus_message_iter_get_basic (iter, &val);
 173             if (!literal)
 174               printf ("signature \"");
 175             printf ("%s", val);
 176             if (!literal)
 177               printf ("\"\n");
 178             break;
 179           }
 180
 181         case DBUS_TYPE_OBJECT_PATH:
 182           {
 183             char *val;
 184             dbus_message_iter_get_basic (iter, &val);
 185             if (!literal)
 186               printf ("object path \"");
 187             printf ("%s", val);
 188             if (!literal)
 189               printf ("\"\n");
 190             break;
 191           }
 192
 193         case DBUS_TYPE_INT16:
 194           {
 195             dbus_int16_t val;
 196             dbus_message_iter_get_basic (iter, &val);
 197             printf ("int16 %d\n", val);
 198             break;
 199           }
 200
 201         case DBUS_TYPE_UINT16:
 202           {
 203             dbus_uint16_t val;
 204             dbus_message_iter_get_basic (iter, &val);
 205             printf ("uint16 %u\n", val);
 206             break;
 207           }
 208
 209         case DBUS_TYPE_INT32:
 210           {
 211             dbus_int32_t val;
 212             dbus_message_iter_get_basic (iter, &val);
 213             printf ("int32 %d\n", val);
 214             break;
 215           }
 216
 217         case DBUS_TYPE_UINT32:
 218           {
 219             dbus_uint32_t val;
 220             dbus_message_iter_get_basic (iter, &val);
 221             printf ("uint32 %u\n", val);
 222             break;
 223           }
 224
 225         case DBUS_TYPE_INT64:
 226           {
 227             dbus_int64_t val;
 228             dbus_message_iter_get_basic (iter, &val);
 229 #ifdef DBUS_INT64_PRINTF_MODIFIER
 230         printf ("int64 %" DBUS_INT64_PRINTF_MODIFIER "d\n", val);
 231 #else
 232         printf ("int64 (omitted)\n");
 233 #endif
 234             break;
 235           }
 236
 237         case DBUS_TYPE_UINT64:
 238           {
 239             dbus_uint64_t val;
 240             dbus_message_iter_get_basic (iter, &val);
 241 #ifdef DBUS_INT64_PRINTF_MODIFIER
 242         printf ("uint64 %" DBUS_INT64_PRINTF_MODIFIER "u\n", val);
 243 #else
 244         printf ("uint64 (omitted)\n");
 245 #endif
 246             break;
 247           }
 248
 249         case DBUS_TYPE_DOUBLE:
 250           {
 251             double val;
 252             dbus_message_iter_get_basic (iter, &val);
 253             printf ("double %g\n", val);
 254             break;
 255           }
 256
 257         case DBUS_TYPE_BYTE:
 258           {
 259             unsigned char val;
 260             dbus_message_iter_get_basic (iter, &val);
 261             printf ("byte %d\n", val);
 262             break;
 263           }
 264
 265         case DBUS_TYPE_BOOLEAN:
 266           {
 267             dbus_bool_t val;
 268             dbus_message_iter_get_basic (iter, &val);
 269             printf ("boolean %s\n", val ? "true" : "false");
 270             break;
 271           }
 272
 273         case DBUS_TYPE_VARIANT:
 274           {
 275             DBusMessageIter subiter;
 276
 277             dbus_message_iter_recurse (iter, &subiter);
 278
 279             printf ("variant ");
 280             print_iter (&subiter, literal, depth+1);
 281             break;
 282           }
 283         case DBUS_TYPE_ARRAY:
 284           {
 285             int current_type;
 286             DBusMessageIter subiter;
 287
 288             dbus_message_iter_recurse (iter, &subiter);
 289
 290             current_type = dbus_message_iter_get_arg_type (&subiter);
 291
 292             if (current_type == DBUS_TYPE_BYTE)
 293               {
 294                 print_ay (&subiter, depth);
 295                 break;
 296               }
 297
 298             printf("array [\n");
 299             while (current_type != DBUS_TYPE_INVALID)
 300               {
 301                 print_iter (&subiter, literal, depth+1);
 302
 303                 dbus_message_iter_next (&subiter);
 304                 current_type = dbus_message_iter_get_arg_type (&subiter);
 305
 306                 if (current_type != DBUS_TYPE_INVALID)
 307                   printf (",");
 308               }
 309             indent(depth);
 310             printf("]\n");
 311             break;
 312           }
 313         case DBUS_TYPE_DICT_ENTRY:
 314           {
 315             DBusMessageIter subiter;
 316
 317             dbus_message_iter_recurse (iter, &subiter);
 318
 319             printf("dict entry(\n");
 320             print_iter (&subiter, literal, depth+1);
 321             dbus_message_iter_next (&subiter);
 322             print_iter (&subiter, literal, depth+1);
 323             indent(depth);
 324             printf(")\n");
 325             break;
 326           }
 327
 328         case DBUS_TYPE_STRUCT:
 329           {
 330             int current_type;
 331             DBusMessageIter subiter;
 332
 333             dbus_message_iter_recurse (iter, &subiter);
 334
 335             printf("struct {\n");
 336             while ((current_type = dbus_message_iter_get_arg_type (&subiter)) != DBUS_TYPE_INVALID)
 337               {
 338                 print_iter (&subiter, literal, depth+1);
 339                 dbus_message_iter_next (&subiter);
 340                 if (dbus_message_iter_get_arg_type (&subiter) != DBUS_TYPE_INVALID)
 341                   printf (",");
 342               }
 343             indent(depth);
 344             printf("}\n");
 345             break;
 346           }
 347
 348         default:
 349           printf (" (dbus-monitor too dumb to decipher arg type '%c')\n", type);
 350           break;
 351         }
 352     } while (dbus_message_iter_next (iter));
 353 }
 354
 355 void
 356 print_message (DBusMessage *message, dbus_bool_t literal)
 357 {
 358   DBusMessageIter iter;
 359   const char *sender;
 360   const char *destination;
 361   int message_type;
 362
 363   message_type = dbus_message_get_type (message);
 364   sender = dbus_message_get_sender (message);
 365   destination = dbus_message_get_destination (message);
 366
 367   if (!literal)
 368     {
 369       printf ("%s sender=%s -> dest=%s",
 370               type_to_name (message_type),
 371               sender ? sender : "(null sender)",
 372               destination ? destination : "(null destination)");
 373
 374       switch (message_type)
 375         {
 376         case DBUS_MESSAGE_TYPE_METHOD_CALL:
 377         case DBUS_MESSAGE_TYPE_SIGNAL:
 378           printf (" serial=%u path=%s; interface=%s; member=%s\n",
 379                   dbus_message_get_serial (message),
 380                   dbus_message_get_path (message),
 381                   dbus_message_get_interface (message),
 382                   dbus_message_get_member (message));
 383           break;
 384
 385         case DBUS_MESSAGE_TYPE_METHOD_RETURN:
 386           printf (" reply_serial=%u\n",
 387           dbus_message_get_reply_serial (message));
 388           break;
 389
 390         case DBUS_MESSAGE_TYPE_ERROR:
 391           printf (" error_name=%s reply_serial=%u\n",
 392                   dbus_message_get_error_name (message),
 393           dbus_message_get_reply_serial (message));
 394           break;
 395
 396         default:
 397           printf ("\n");
 398           break;
 399         }
 400     }
 401
 402   dbus_message_iter_init (message, &iter);
 403   print_iter (&iter, literal, 1);
 404   fflush (stdout);
 405
 406 }
 407