src/telepathy/telepathy-debug.c

   1 /**
   2  * @file telepathy-debug.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2012-2013 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  ******************************************************************************
  23  *
  24  * How to collect debugging information
  25  *
  26  * Run the connection manager from the command line like this:
  27  *
  28  *    $ G_MESSAGES_DEBUG="all" SIPE_PERSIST=1 \
  29  *      SIPE_DEBUG=[space separated keyword list \
  30  *      [SIPE_TIMING=1] [SIPE_LOGFILE="..."] \
  31  *      telepathy-sipe
  32  *
  33  * G_MESSAGES_DEBUG=all: make debug & informational messages visible
  34  *
  35  * SIPE_PERSISTS=1     : keep the CM running permanently,
  36  *                       [otherwise the one installed in the system will
  37  *                       be started automatically by D-Bus when needed]
  38  *
  39  * SIPE_DEBUG=...      :
  40  *    all        - enable all sipe & telepathy-glib messages
  41  *    sipe       - enable only sipe messages
  42  *    "sipe ..." - enable sipe and some telepathy-glib messages
  43  *
  44  * SIPE_TIMING=1       : enable time stamps
  45  *                       [recommeded for any usable log file]
  46  *
  47  * SIPE_LOGFILE="..."  : redirect output to this file
  48  *                       [prepend file name with "+" to enable append mode]
  49  *
  50  ******************************************************************************
  51  */
  52
  53 #include <stdarg.h>
  54
  55 #include <glib.h>
  56 #include <telepathy-glib/debug-sender.h>
  57 #include <telepathy-glib/telepathy-glib.h>
  58
  59 #include "sipe-backend.h"
  60
  61 #include "telepathy-private.h"
  62
  63 #define SIPE_TELEPATHY_DEBUG 1
  64
  65 static TpDebugSender *debug;
  66 static guint          flags = 0;
  67
  68 void sipe_telepathy_debug_init(void)
  69 {
  70         static const GDebugKey const keys[] = {
  71                 /* This simulates pidgin's --debug flag, i.e. we only see
  72                  * output from SIPE if this is set.
  73                  *
  74                  *  @TODO: we could make this more finely grained, i.e.
  75                  *         which levels should be visible
  76                  */
  77                 { "sipe", SIPE_TELEPATHY_DEBUG },
  78         };
  79         const gchar *env_flags = g_getenv("SIPE_DEBUG");
  80
  81         /* Telepathy debugger */
  82         debug = tp_debug_sender_dup();
  83
  84         /* divert g_log_default_handler() output to a logfile */
  85         tp_debug_divert_messages(g_getenv("SIPE_LOGFILE"));
  86
  87         /* sipe & telepathy-glib debugging flags */
  88         if (env_flags) flags |= g_parse_debug_string(env_flags, keys, 1);
  89         tp_debug_set_flags(env_flags);
  90
  91         /* add time stamps to debug output */
  92         if (g_getenv("SIPE_TIMING"))
  93                 g_log_set_default_handler(tp_debug_timestamped_log_handler, NULL);
  94
  95         /* enable test mode */
  96         if (g_getenv("SIPE_PERSIST"))
  97                 tp_debug_set_persistent(TRUE);
  98 }
  99
 100 void sipe_telepathy_debug_finalize(void)
 101 {
 102         g_object_unref(debug);
 103 }
 104
 105 static const GLogLevelFlags debug_level_mapping[] = {
 106         G_LOG_LEVEL_DEBUG,    /* SIPE_DEBUG_LEVEL_INFO    */
 107         G_LOG_LEVEL_WARNING,  /* SIPE_DEBUG_LEVEL_WARNING */
 108         G_LOG_LEVEL_CRITICAL, /* SIPE_DEBUG_LEVEL_ERROR   */
 109         G_LOG_LEVEL_ERROR,    /* SIPE_DEBUG_LEVEL_FATAL, this will abort! */
 110 };
 111
 112 void sipe_backend_debug_literal(sipe_debug_level level,
 113                                 const gchar *msg)
 114 {
 115         if (flags & SIPE_TELEPATHY_DEBUG) {
 116                 GLogLevelFlags g_level = debug_level_mapping[level];
 117                 g_log(SIPE_TELEPATHY_DOMAIN, g_level, "%s", msg);
 118                 tp_debug_sender_add_message(debug, NULL,
 119                                             SIPE_TELEPATHY_DOMAIN,
 120                                             g_level,
 121                                             msg);
 122         }
 123 }
 124
 125 void sipe_backend_debug(sipe_debug_level level,
 126                         const gchar *format,
 127                         ...)
 128 {
 129         va_list ap;
 130
 131         va_start(ap, format);
 132         if (flags & SIPE_TELEPATHY_DEBUG) {
 133                 gchar *msg = g_strdup_vprintf(format, ap);
 134                 sipe_backend_debug_literal(level, msg);
 135                 g_free(msg);
 136         }
 137         va_end(ap);
 138 }
 139
 140 gboolean sipe_backend_debug_enabled(void)
 141 {
 142         return(flags & SIPE_TELEPATHY_DEBUG);
 143 }
 144
 145 /*
 146   Local Variables:
 147   mode: c
 148   c-file-style: "bsd"
 149   indent-tabs-mode: t
 150   tab-width: 8
 151   End:
 152 */