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