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