src/core/palettestorage.c

/*
 * palettestorage.c
 *
 * Copyright 2013 Richard Shann <rshann@virgin.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */
#include "ui/palettes.h"
#include "core/view.h"
#include "core/utils.h"
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xmlmemory.h>

static void save_button (xmlNodePtr button, GtkWidget *widget)
{
    //newXMLIntProp (xmlNodePtr parent, const xmlChar * name, gint content)
    const gchar *label = g_object_get_data (G_OBJECT(widget), "icon");
    if(label == NULL)
        label = gtk_button_get_label(GTK_BUTTON(widget));
    xmlSetProp (button, (xmlChar *) "label", (xmlChar *) label );
    xmlSetProp (button, (xmlChar *) "_tooltip", (xmlChar *) gtk_widget_get_tooltip_text(widget));
    xmlSetProp (button, (xmlChar *) "script", (xmlChar *) g_object_get_data (G_OBJECT(widget), "script"));
}
/**
 *
Set a prop of the parent, holding the passed name and integer.
 */
static void
newXMLIntProp (xmlNodePtr parent, const xmlChar * name, gint content)
{
  gchar *integer = g_strdup_printf ("%d", content);
  xmlSetProp (parent, name, (xmlChar *) integer);
  g_free (integer);
}


static void
save_palette (xmlNodePtr parent, DenemoPalette *pal)
{
    xmlSetProp (parent, (xmlChar *) "_name", (xmlChar *) pal->name);

    newXMLIntProp (parent, "row-wise", pal->rows);
    newXMLIntProp (parent, "limit", pal->limit);
    newXMLIntProp (parent, "dock", pal->docked);

    newXMLIntProp (parent, "hidden", pal->docked?!gtk_widget_get_visible(pal->box): !gtk_widget_get_visible(pal->window));
    GList *g;
    for(g=pal->buttons;g;g=g->next)
    {
        xmlNodePtr child = xmlNewChild (parent, NULL, (xmlChar *) "button", NULL);
        save_button (child, g->data);
    }

}


gint
writePalettes (void)
{
  gint ret = -1;
  xmlDocPtr doc;
  xmlNodePtr parent, child;
  gchar *localpal = NULL;

  localpal = g_build_filename (get_user_data_dir (TRUE), "actions", "palettes.xml", NULL);

  doc = xmlNewDoc ((xmlChar *) "1.0");
  doc->xmlRootNode = parent = xmlNewDocNode (doc, NULL, (xmlChar *) "Denemo", NULL);
    GList *g;
    for( g = Denemo.palettes; g; g = g->next)
        {
        child = xmlNewChild (parent, NULL, (xmlChar *) "palette", NULL);
        save_palette (child, g->data);
        }
    if (xmlSaveFormatFile (localpal, doc, 1) < 0)
    {
      g_warning ("Could not save file %s", localpal);
      ret = -1;
    } else
    ret = 0;
    xmlFreeDoc (doc);
    return ret;
}


/**
 * install palettes from file

 */

static gint getXMLIntProp (xmlNodePtr child, gchar *name)
 {
  gint val = -1;
  gchar *thename = (gchar *) xmlGetProp (child, (xmlChar *) name);
  if (thename)
    val = atoi (thename);
    xmlFree (thename);
    return val;
}


#define FOREACH_CHILD_ELEM(childElem, parentElem) \
for ((childElem) = (parentElem)->xmlChildrenNode; \
     (childElem) != NULL; \
     (childElem) = (childElem)->next)

#define ELEM_NAME_EQ(childElem, childElemName) \
(strcmp ((gchar *)(childElem)->name, (childElemName)) == 0)

 static void installButtons (xmlNodePtr palette, DenemoPalette *pal)
 {
    xmlNodePtr childElem;

  FOREACH_CHILD_ELEM (childElem, palette)
  if (ELEM_NAME_EQ (childElem, "button"))
  {
    gchar *label = (gchar *) xmlGetProp (childElem, (xmlChar *) "label");
    gchar *tooltip = (gchar *) xmlGetProp (childElem, (xmlChar *) "_tooltip");
    gchar *script = (gchar *) xmlGetProp (childElem, (xmlChar *) "script");
    if(label && tooltip && script)
        palette_add_button (pal, label, tooltip, script);
    else
        g_warning ("Bad value for button in palettes.xml %s %s %s", label, tooltip, script);
  }


 }

static void install_palette (xmlNodePtr palette, gboolean hide)
{
    gchar *name = (gchar *) xmlGetProp (palette, (xmlChar *) "_name");
    gboolean hidden =  getXMLIntProp (palette, (xmlChar *) "hidden");
    gboolean row_wise =  getXMLIntProp (palette, (xmlChar *) "row-wise");
    gboolean dock =  getXMLIntProp (palette, (xmlChar *) "dock");
    gint limit =  getXMLIntProp (palette, (xmlChar *) "limit");
    DenemoPalette *pal = create_palette (name, dock, row_wise);
    set_palate_shape (name, row_wise, limit);//does gtk_widget_show in repack
    installButtons (palette, pal);
    if (hide) hidden = TRUE;
    if(hidden)
        gtk_widget_hide(pal->docked?pal->box:pal->window);
    else
        gtk_widget_show(pal->docked?pal->box:pal->window);

    if (pal->buttons==NULL)
            {
                delete_palette (pal);
            }
}
static gint merge_palette (xmlNodePtr palette, const gchar *sought)
{
    gchar *name = (gchar *) xmlGetProp (palette, (xmlChar *) "_name");
    gboolean hidden =  getXMLIntProp (palette, (xmlChar *) "hidden");
    gboolean row_wise =  getXMLIntProp (palette, (xmlChar *) "row-wise");
    gboolean dock =  getXMLIntProp (palette, (xmlChar *) "dock");
    gint limit =  getXMLIntProp (palette, (xmlChar *) "limit");
    if(!strcmp(name, sought))
    {
        DenemoPalette *pal = create_palette (name, dock, row_wise);
        set_palate_shape (name, row_wise, limit);//does gtk_widget_show in repack
        installButtons (palette, pal);
        gtk_widget_show(pal->docked?pal->box:pal->window);
        if (pal->buttons==NULL)
            {
                delete_palette (pal);
                return -1;
            }
        return 0;
    }
    return -1;
}


gint installPalettesFile (gchar *filename, gboolean hide)
{
   xmlDocPtr doc = NULL;
  xmlNodePtr rootElem;
     doc = xmlParseFile (filename);
  if (doc == NULL)
    {
      g_warning ("Could not read XML file %s", filename);
      return -1;
    }

  rootElem = xmlDocGetRootElement (doc);
  if (rootElem == NULL)
    {
      g_warning ("Empty Document");
      xmlFreeDoc (doc);
      return -1;
    }

 //g_debug ("RootElem: %s\n", rootElem->name);
  if (0 != xmlStrcmp (rootElem->name, (xmlChar*) "Denemo"))
    {
      g_warning ("Document has wrong type");
      xmlFreeDoc (doc);
      return -1;
    }

  rootElem = rootElem->xmlChildrenNode;
  while (rootElem != NULL)
    {
     //g_debug ("RootElem %s\n", rootElem->name);
      if (0 == xmlStrcmp (rootElem->name, (const xmlChar *) "palette"))
        {
          install_palette (rootElem, hide);
        }
      rootElem = rootElem->next;
    }

  xmlFreeDoc (doc);
  return 0;

}

gint
installPalettes (void)
{
gint ret;
  gchar *filename = NULL;

  GList* dirs = NULL;
 // if(Denemo.old_user_data_dir)
 //   dirs = g_list_append(dirs, g_build_filename (Denemo.old_user_data_dir, COMMANDS_DIR, NULL));
//  else
    dirs = g_list_append(dirs, g_build_filename (get_user_data_dir (TRUE), COMMANDS_DIR, NULL));
  dirs = g_list_append(dirs, g_build_filename (PACKAGE_SOURCE_DIR, COMMANDS_DIR, NULL));
  dirs = g_list_append(dirs, g_build_filename (get_system_data_dir (), COMMANDS_DIR, NULL));

  filename = find_path_for_file("palettes.xml", dirs);
  if (filename == NULL)
    {
      g_warning ("Could not find palette file.");
      return -1;
    }


  if(Denemo.old_user_data_dir)
  {
    ret = installPalettesFile (filename, TRUE);//install but hide the new standard palettes
    installPalettesFile (g_build_filename (Denemo.old_user_data_dir, COMMANDS_DIR, "palettes.xml", NULL) , FALSE);//merge users previous custom palettes, showing them
   } else
   {
     ret = installPalettesFile (filename, FALSE);//install and show palettes
    }
  return ret;
}


gint
mergePalette (const gchar *name)
{
    gint ret = -1;
     xmlDocPtr doc = NULL;
  xmlNodePtr rootElem;

  gchar *filename = NULL;

  if (filename == NULL)
    filename = g_build_filename (get_system_data_dir (), "actions", "palettes.xml", NULL);

  doc = xmlParseFile (filename);
  if (doc == NULL)
    {
      g_warning ("Could not read XML file %s", filename);
      return -1;
    }

  rootElem = xmlDocGetRootElement (doc);
  if (rootElem == NULL)
    {
      g_warning ("Empty Document");
      xmlFreeDoc (doc);
      return -1;
    }

 //g_debug ("RootElem: %s\n", rootElem->name);
  if (0 != xmlStrcmp (rootElem->name, (xmlChar*) "Denemo"))
    {
      g_warning ("Document has wrong type");
      xmlFreeDoc (doc);
      return -1;
    }

  rootElem = rootElem->xmlChildrenNode;
  while (rootElem != NULL)
        {
      if (0 == xmlStrcmp (rootElem->name, (const xmlChar *) "palette"))
        {
          if( 0 == merge_palette (rootElem, name))
            {
                ret = 0;
                break;

            }
        }
      rootElem = rootElem->next;
    }

  xmlFreeDoc (doc);


    return ret;
}