libempathy/empathy-status-presets.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2005-2007 Imendio AB
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program 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  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA  02110-1301  USA
  19  *
  20  * Author: Martyn Russell <martyn@imendio.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <string.h>
  28
  29 #include <glib.h>
  30 #include <glib/gi18n-lib.h>
  31
  32 #include <libxml/parser.h>
  33 #include <libxml/tree.h>
  34
  35 #include <telepathy-glib/util.h>
  36
  37 #include "empathy-utils.h"
  38 #include "empathy-status-presets.h"
  39
  40 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
  41 #include "empathy-debug.h"
  42
  43 #define STATUS_PRESETS_XML_FILENAME "status-presets.xml"
  44 #define STATUS_PRESETS_DTD_FILENAME "empathy-status-presets.dtd"
  45 #define STATUS_PRESETS_MAX_EACH     15
  46
  47 typedef struct {
  48         gchar      *status;
  49         TpConnectionPresenceType  state;
  50 } StatusPreset;
  51
  52 static StatusPreset *status_preset_new          (TpConnectionPresenceType    state,
  53                                                  const gchar  *status);
  54 static void     status_preset_free              (StatusPreset *status);
  55 static void     status_presets_file_parse       (const gchar  *filename);
  56 const gchar *   status_presets_get_state_as_str (TpConnectionPresenceType    state);
  57 static gboolean status_presets_file_save        (void);
  58 static void     status_presets_set_default      (TpConnectionPresenceType    state,
  59                                                  const gchar  *status);
  60
  61 static GList        *presets = NULL;
  62 static StatusPreset *default_preset = NULL;
  63
  64 static StatusPreset *
  65 status_preset_new (TpConnectionPresenceType   state,
  66                    const gchar *status)
  67 {
  68         StatusPreset *preset;
  69
  70         preset = g_new0 (StatusPreset, 1);
  71
  72         preset->status = g_strdup (status);
  73         preset->state = state;
  74
  75         return preset;
  76 }
  77
  78 static void
  79 status_preset_free (StatusPreset *preset)
  80 {
  81         g_free (preset->status);
  82         g_free (preset);
  83 }
  84
  85 static void
  86 status_presets_file_parse (const gchar *filename)
  87 {
  88         xmlParserCtxtPtr ctxt;
  89         xmlDocPtr        doc;
  90         xmlNodePtr       presets_node;
  91         xmlNodePtr       node;
  92
  93         DEBUG ("Attempting to parse file:'%s'...", filename);
  94
  95         ctxt = xmlNewParserCtxt ();
  96
  97         /* Parse and validate the file. */
  98         doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
  99         if (!doc) {
 100                 g_warning ("Failed to parse file:'%s'", filename);
 101                 xmlFreeParserCtxt (ctxt);
 102                 return;
 103         }
 104
 105         if (!empathy_xml_validate (doc, STATUS_PRESETS_DTD_FILENAME)) {
 106                 g_warning ("Failed to validate file:'%s'", filename);
 107                 xmlFreeDoc (doc);
 108                 xmlFreeParserCtxt (ctxt);
 109                 return;
 110         }
 111
 112         /* The root node, presets. */
 113         presets_node = xmlDocGetRootElement (doc);
 114
 115         node = presets_node->children;
 116         while (node) {
 117                 if (strcmp ((gchar *) node->name, "status") == 0 ||
 118                     strcmp ((gchar *) node->name, "default") == 0) {
 119                         TpConnectionPresenceType    state;
 120                         gchar        *status;
 121                         gchar        *state_str;
 122                         StatusPreset *preset;
 123                         gboolean      is_default = FALSE;
 124
 125                         if (strcmp ((gchar *) node->name, "default") == 0) {
 126                                 is_default = TRUE;
 127                         }
 128
 129                         status = (gchar *) xmlNodeGetContent (node);
 130                         state_str = (gchar *) xmlGetProp (node, (const xmlChar *) "presence");
 131
 132                         if (state_str) {
 133                                 state = empathy_presence_from_str (state_str);
 134                                 if (empathy_status_presets_is_valid (state)) {
 135                                         if (is_default) {
 136                                                 DEBUG ("Default status preset state is:"
 137                                                         " '%s', status:'%s'", state_str,
 138                                                         status);
 139
 140                                                 status_presets_set_default (state, status);
 141                                         } else {
 142                                                 preset = status_preset_new (state, status);
 143                                                 presets = g_list_append (presets, preset);
 144                                         }
 145                                 }
 146                         }
 147
 148                         xmlFree (status);
 149                         xmlFree (state_str);
 150                 }
 151
 152                 node = node->next;
 153         }
 154
 155         /* Use the default if not set */
 156         if (!default_preset) {
 157                 status_presets_set_default (TP_CONNECTION_PRESENCE_TYPE_OFFLINE, NULL);
 158         }
 159
 160         DEBUG ("Parsed %d status presets", g_list_length (presets));
 161
 162         xmlFreeDoc (doc);
 163         xmlFreeParserCtxt (ctxt);
 164 }
 165
 166 void
 167 empathy_status_presets_get_all (void)
 168 {
 169         gchar *dir;
 170         gchar *file_with_path;
 171
 172         /* If already set up clean up first. */
 173         if (presets) {
 174                 g_list_foreach (presets, (GFunc) status_preset_free, NULL);
 175                 g_list_free (presets);
 176                 presets = NULL;
 177         }
 178
 179         dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
 180         g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
 181         file_with_path = g_build_filename (dir, STATUS_PRESETS_XML_FILENAME, NULL);
 182         g_free (dir);
 183
 184         if (g_file_test (file_with_path, G_FILE_TEST_EXISTS)) {
 185                 status_presets_file_parse (file_with_path);
 186         }
 187
 188         g_free (file_with_path);
 189 }
 190
 191 static gboolean
 192 status_presets_file_save (void)
 193 {
 194         xmlDocPtr   doc;
 195         xmlNodePtr  root;
 196         GList      *l;
 197         gchar      *dir;
 198         gchar      *file;
 199         gint        count[NUM_TP_CONNECTION_PRESENCE_TYPES];
 200         gint        i;
 201
 202         for (i = 0; i < NUM_TP_CONNECTION_PRESENCE_TYPES; i++) {
 203                 count[i] = 0;
 204         }
 205
 206         dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
 207         g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
 208         file = g_build_filename (dir, STATUS_PRESETS_XML_FILENAME, NULL);
 209         g_free (dir);
 210
 211         doc = xmlNewDoc ((const xmlChar *) "1.0");
 212         root = xmlNewNode (NULL, (const xmlChar *) "presets");
 213         xmlDocSetRootElement (doc, root);
 214
 215         if (default_preset) {
 216                 xmlNodePtr  subnode;
 217                 xmlChar    *state;
 218
 219                 state = (xmlChar *) empathy_presence_to_str (default_preset->state);
 220
 221                 subnode = xmlNewTextChild (root, NULL, (const xmlChar *) "default",
 222                                           (const xmlChar *) default_preset->status);
 223                 xmlNewProp (subnode, (const xmlChar *) "presence", state);
 224         }
 225
 226         for (l = presets; l; l = l->next) {
 227                 StatusPreset *sp;
 228                 xmlNodePtr    subnode;
 229                 xmlChar      *state;
 230
 231                 sp = l->data;
 232                 state = (xmlChar *) empathy_presence_to_str (sp->state);
 233
 234                 count[sp->state]++;
 235                 if (count[sp->state] > STATUS_PRESETS_MAX_EACH) {
 236                         continue;
 237                 }
 238
 239                 subnode = xmlNewTextChild (root, NULL,
 240                                            (const xmlChar *) "status", (const xmlChar *) sp->status);
 241                 xmlNewProp (subnode, (const xmlChar *) "presence", state);
 242         }
 243
 244         /* Make sure the XML is indented properly */
 245         xmlIndentTreeOutput = 1;
 246
 247         DEBUG ("Saving file:'%s'", file);
 248         xmlSaveFormatFileEnc (file, doc, "utf-8", 1);
 249         xmlFreeDoc (doc);
 250
 251         g_free (file);
 252
 253         return TRUE;
 254 }
 255
 256 GList *
 257 empathy_status_presets_get (TpConnectionPresenceType state,
 258                            gint       max_number)
 259 {
 260         GList *list = NULL;
 261         GList *l;
 262         gint   i;
 263
 264         i = 0;
 265         for (l = presets; l; l = l->next) {
 266                 StatusPreset *sp;
 267
 268                 sp = l->data;
 269
 270                 if (sp->state != state) {
 271                         continue;
 272                 }
 273
 274                 list = g_list_append (list, sp->status);
 275                 i++;
 276
 277                 if (max_number != -1 && i >= max_number) {
 278                         break;
 279                 }
 280         }
 281
 282         return list;
 283 }
 284
 285 void
 286 empathy_status_presets_set_last (TpConnectionPresenceType   state,
 287                                 const gchar *status)
 288 {
 289         GList        *l;
 290         StatusPreset *preset;
 291         gint          num;
 292
 293         /* Check if duplicate */
 294         for (l = presets; l; l = l->next) {
 295                 preset = l->data;
 296
 297                 if (state == preset->state &&
 298                     !tp_strdiff (status, preset->status)) {
 299                         return;
 300                 }
 301         }
 302
 303         preset = status_preset_new (state, status);
 304         presets = g_list_prepend (presets, preset);
 305
 306         num = 0;
 307         for (l = presets; l; l = l->next) {
 308                 preset = l->data;
 309
 310                 if (state != preset->state) {
 311                         continue;
 312                 }
 313
 314                 num++;
 315
 316                 if (num > STATUS_PRESETS_MAX_EACH) {
 317                         status_preset_free (preset);
 318                         presets = g_list_delete_link (presets, l);
 319                         break;
 320                 }
 321         }
 322
 323         status_presets_file_save ();
 324 }
 325
 326 void
 327 empathy_status_presets_remove (TpConnectionPresenceType   state,
 328                                const gchar *status)
 329 {
 330         StatusPreset *preset;
 331         GList        *l;
 332
 333         for (l = presets; l; l = l->next) {
 334                 preset = l->data;
 335
 336                 if (state == preset->state &&
 337                     !tp_strdiff (status, preset->status)) {
 338                         status_preset_free (preset);
 339                         presets = g_list_delete_link (presets, l);
 340                         status_presets_file_save ();
 341                         break;
 342                 }
 343         }
 344 }
 345
 346 void
 347 empathy_status_presets_reset (void)
 348 {
 349         g_list_foreach (presets, (GFunc) status_preset_free, NULL);
 350         g_list_free (presets);
 351
 352         presets = NULL;
 353
 354         status_presets_set_default (TP_CONNECTION_PRESENCE_TYPE_AVAILABLE, NULL);
 355
 356         status_presets_file_save ();
 357 }
 358
 359 TpConnectionPresenceType
 360 empathy_status_presets_get_default_state (void)
 361 {
 362         if (!default_preset) {
 363                 return TP_CONNECTION_PRESENCE_TYPE_OFFLINE;
 364         }
 365
 366         return default_preset->state;
 367 }
 368
 369 const gchar *
 370 empathy_status_presets_get_default_status (void)
 371 {
 372         if (!default_preset ||
 373             !default_preset->status) {
 374                 return NULL;
 375         }
 376
 377         return default_preset->status;
 378 }
 379
 380 static void
 381 status_presets_set_default (TpConnectionPresenceType   state,
 382                             const gchar *status)
 383 {
 384         if (default_preset) {
 385                 status_preset_free (default_preset);
 386         }
 387
 388         default_preset = status_preset_new (state, status);
 389 }
 390
 391 void
 392 empathy_status_presets_set_default (TpConnectionPresenceType   state,
 393                                    const gchar *status)
 394 {
 395         status_presets_set_default (state, status);
 396         status_presets_file_save ();
 397 }
 398
 399 void
 400 empathy_status_presets_clear_default (void)
 401 {
 402         if (default_preset) {
 403                 status_preset_free (default_preset);
 404                 default_preset = NULL;
 405         }
 406
 407         status_presets_file_save ();
 408 }
 409
 410 /**
 411  * empathy_status_presets_is_valid:
 412  * @state: a #TpConnectionPresenceType
 413  *
 414  * Check if a presence type can be used as a preset.
 415  *
 416  * Returns: %TRUE if the presence type can be used as a preset.
 417  */
 418 gboolean
 419 empathy_status_presets_is_valid (TpConnectionPresenceType state)
 420 {
 421         switch (state) {
 422                 case TP_CONNECTION_PRESENCE_TYPE_UNSET:
 423                 case TP_CONNECTION_PRESENCE_TYPE_OFFLINE:
 424                 case TP_CONNECTION_PRESENCE_TYPE_UNKNOWN:
 425                 case TP_CONNECTION_PRESENCE_TYPE_ERROR:
 426                         return FALSE;
 427
 428                 case TP_CONNECTION_PRESENCE_TYPE_AVAILABLE:
 429                 case TP_CONNECTION_PRESENCE_TYPE_AWAY:
 430                 case TP_CONNECTION_PRESENCE_TYPE_EXTENDED_AWAY:
 431                 case TP_CONNECTION_PRESENCE_TYPE_HIDDEN:
 432                 case TP_CONNECTION_PRESENCE_TYPE_BUSY:
 433                         return TRUE;
 434         }
 435         return FALSE;
 436 }