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