/* GTK - The GIMP Toolkit

 * gtkfilechoosersettings.c: Internal settings for the GtkFileChooser widget

 * Copyright (C) 2006, Novell, Inc.

 *

 * Authors: Federico Mena-Quintero <federico@novell.com>

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/* TODO:

 *

 * - Persist these:

 *   - hpaned position

 *   - browse_for_other_folders?

 *

 * - Do we want lockdown?

 */

#include "config.h"

#include <errno.h>

#include <string.h>

#include <glib.h>

#include <glib/gi18n-lib.h>

#include "gtkfilechoosersettings.h"

#include "gtkalias.h"

#define SETTINGS_GROUP		"Filechooser Settings"

#define LOCATION_MODE_KEY	"LocationMode"

#define SHOW_HIDDEN_KEY		"ShowHidden"

#define SHOW_SIZE_COLUMN_KEY    "ShowSizeColumn"

#define GEOMETRY_X_KEY		"GeometryX"

#define GEOMETRY_Y_KEY		"GeometryY"

#define GEOMETRY_WIDTH_KEY	"GeometryWidth"

#define GEOMETRY_HEIGHT_KEY	"GeometryHeight"

#define SORT_COLUMN_KEY         "SortColumn"

#define SORT_ORDER_KEY          "SortOrder"

#define STARTUP_MODE_KEY        "StartupMode"

#define COLUMN_NAME_STRING      "name"

#define COLUMN_MTIME_STRING     "modified"

#define COLUMN_SIZE_STRING      "size"

#define SORT_ASCENDING_STRING   "ascending"

#define SORT_DESCENDING_STRING  "descending"

#define STARTUP_MODE_RECENT_STRING "recent"

#define STARTUP_MODE_CWD_STRING    "cwd"

#define MODE_PATH_BAR          "path-bar"

#define MODE_FILENAME_ENTRY    "filename-entry"

#define EQ(a, b) (g_ascii_strcasecmp ((a), (b)) == 0)

static char *

get_config_dirname (void)

{

  return g_build_filename (g_get_user_config_dir (), "gtk-2.0", NULL);

}

static char *

get_config_filename (void)

{

  return g_build_filename (g_get_user_config_dir (), "gtk-2.0", "gtkfilechooser.ini", NULL);

}

static void

warn_if_invalid_key_and_clear_error (const gchar  *key,

                                     GError      **error)

{

  if (error && *error)

    {

      if ((*error)->domain == G_KEY_FILE_ERROR &&

          (*error)->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND)

        g_warning ("Failed to read '%s' setting in filechooser settings: %s",

                   key,

                   (*error)->message);

      g_clear_error (error);

    }

}

static void

get_int_key (GKeyFile *key_file, const char *group, const char *key, int *out_value)

{

  GError *error;

  int val;

  error = NULL;

  val = g_key_file_get_integer (key_file, group, key, &error);

  if (val == 0 && error != NULL)

    {

      *out_value = -1;

      g_error_free (error);

    }

  else

    *out_value = val;

}

static void

ensure_settings_read (GtkFileChooserSettings *settings)

{

  GError *error;

  GKeyFile *key_file;

  gchar *location_mode_str, *filename;

  gchar *sort_column, *sort_order;

  gchar *startup_mode;

  gboolean value;

  if (settings->settings_read)

    return;

  key_file = g_key_file_new ();

  filename = get_config_filename ();

  error = NULL;

  if (!g_key_file_load_from_file (key_file, filename, 0, &error))

    {

      /* Don't warn on non-existent file */

      if (error->domain != G_FILE_ERROR ||

	  error->code != G_FILE_ERROR_NOENT)

        g_warning ("Failed to read filechooser settings from \"%s\": %s",

                   filename, error->message);

      g_error_free (error);

      goto out;

    }

  if (!g_key_file_has_group (key_file, SETTINGS_GROUP))

    goto out;

  /* Location mode */

  location_mode_str = g_key_file_get_string (key_file, SETTINGS_GROUP,

					     LOCATION_MODE_KEY, NULL);

  if (location_mode_str)

    {

      if (EQ (location_mode_str, MODE_PATH_BAR))

        settings->location_mode = LOCATION_MODE_PATH_BAR;

      else if (EQ (location_mode_str, MODE_FILENAME_ENTRY))

        settings->location_mode = LOCATION_MODE_FILENAME_ENTRY;

      else

        g_warning ("Unknown location mode '%s' encountered in filechooser settings",

		   location_mode_str);

      g_free (location_mode_str);

    }

  /* Show hidden */

  value = g_key_file_get_boolean (key_file, SETTINGS_GROUP,

				  SHOW_HIDDEN_KEY, &error);

  if (error)

    warn_if_invalid_key_and_clear_error (SHOW_HIDDEN_KEY, &error);

  else

    settings->show_hidden = value != FALSE;

  /* Show size column */

  value = g_key_file_get_boolean (key_file, SETTINGS_GROUP,

				  SHOW_SIZE_COLUMN_KEY, &error);

  if (error)

    warn_if_invalid_key_and_clear_error (SHOW_SIZE_COLUMN_KEY, &error);

  else

    settings->show_size_column = value != FALSE;

  /* Geometry */

  get_int_key (key_file, SETTINGS_GROUP, GEOMETRY_X_KEY, &settings->geometry_x);

  get_int_key (key_file, SETTINGS_GROUP, GEOMETRY_Y_KEY, &settings->geometry_y);

  get_int_key (key_file, SETTINGS_GROUP, GEOMETRY_WIDTH_KEY, &settings->geometry_width);

  get_int_key (key_file, SETTINGS_GROUP, GEOMETRY_HEIGHT_KEY, &settings->geometry_height);

  /* Sort column */

  sort_column = g_key_file_get_string (key_file, SETTINGS_GROUP,

				       SORT_COLUMN_KEY, NULL);

  if (sort_column)

    {

      if (EQ (COLUMN_NAME_STRING, sort_column))

	settings->sort_column = FILE_LIST_COL_NAME;

      else if (EQ (COLUMN_MTIME_STRING, sort_column))

	settings->sort_column = FILE_LIST_COL_MTIME;

      else if (EQ (COLUMN_SIZE_STRING, sort_column))

	settings->sort_column = FILE_LIST_COL_SIZE;

      else

	g_warning ("Unknown sort column name '%s' encountered in filechooser settings",

		   sort_column);

      g_free (sort_column);

    }

  /* Sort order */

  sort_order = g_key_file_get_string (key_file, SETTINGS_GROUP,

				      SORT_ORDER_KEY, NULL);

  if (sort_order)

    {

      if (EQ (SORT_ASCENDING_STRING, sort_order))

	settings->sort_order = GTK_SORT_ASCENDING;

      else if (EQ (SORT_DESCENDING_STRING, sort_order))

	settings->sort_order = GTK_SORT_DESCENDING;

      else

	g_warning ("Unknown sort column order '%s' encountered in filechooser settings",

		   sort_order);

      g_free (sort_order);

    }

  /* Startup mode */

  startup_mode = g_key_file_get_string (key_file, SETTINGS_GROUP,

					STARTUP_MODE_KEY, NULL);

  if (startup_mode)

    {

      if (EQ (STARTUP_MODE_RECENT_STRING, startup_mode))

	settings->startup_mode = STARTUP_MODE_RECENT;

      else if (EQ (STARTUP_MODE_CWD_STRING, startup_mode))

	settings->startup_mode = STARTUP_MODE_CWD;

      else

	g_warning ("Unknown startup mode '%s' encountered in filechooser settings",

		   startup_mode);

      g_free (startup_mode);

    }

 out:

  g_key_file_free (key_file);

  g_free (filename);

  settings->settings_read = TRUE;

}

G_DEFINE_TYPE (GtkFileChooserSettings, _gtk_file_chooser_settings, G_TYPE_OBJECT)

static void

_gtk_file_chooser_settings_class_init (GtkFileChooserSettingsClass *class)

{

}

static void

_gtk_file_chooser_settings_init (GtkFileChooserSettings *settings)

{

  settings->location_mode = LOCATION_MODE_PATH_BAR;

  settings->sort_order = GTK_SORT_ASCENDING;

  settings->sort_column = FILE_LIST_COL_NAME;

  settings->show_hidden = FALSE;

  settings->show_size_column = TRUE;

  settings->geometry_x	    = -1;

  settings->geometry_y	    = -1;

  settings->geometry_width  = -1;

  settings->geometry_height = -1;

  settings->startup_mode = STARTUP_MODE_RECENT;

}

GtkFileChooserSettings *

_gtk_file_chooser_settings_new (void)

{

  return g_object_new (GTK_FILE_CHOOSER_SETTINGS_TYPE, NULL);

}

LocationMode

_gtk_file_chooser_settings_get_location_mode (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->location_mode;

}

void

_gtk_file_chooser_settings_set_location_mode (GtkFileChooserSettings *settings,

					      LocationMode location_mode)

{

  settings->location_mode = location_mode;

}

gboolean

_gtk_file_chooser_settings_get_show_hidden (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->show_hidden;

}

void

_gtk_file_chooser_settings_set_show_hidden (GtkFileChooserSettings *settings,

					    gboolean show_hidden)

{

  settings->show_hidden = show_hidden != FALSE;

}

void

_gtk_file_chooser_settings_set_show_size_column (GtkFileChooserSettings *settings,

					         gboolean show_column)

{

  settings->show_size_column = show_column != FALSE;

}

gboolean

_gtk_file_chooser_settings_get_show_size_column (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->show_size_column;

}

void

_gtk_file_chooser_settings_get_geometry (GtkFileChooserSettings *settings,

					 int                    *out_x,

					 int                    *out_y,

					 int                    *out_width,

					 int                    *out_height)

{

  ensure_settings_read (settings);

  *out_x      = settings->geometry_x;

  *out_y      = settings->geometry_y;

  *out_width  = settings->geometry_width;

  *out_height = settings->geometry_height;

}

void

_gtk_file_chooser_settings_set_geometry (GtkFileChooserSettings *settings,

					 int                     x,

					 int                     y,

					 int                     width,

					 int                     height)

{

  settings->geometry_x	    = x;

  settings->geometry_y	    = y;

  settings->geometry_width  = width;

  settings->geometry_height = height;

}

gint

_gtk_file_chooser_settings_get_sort_column (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->sort_column;

}

void

_gtk_file_chooser_settings_set_sort_column (GtkFileChooserSettings *settings,

					    gint sort_column)

{

  settings->sort_column = sort_column;

}

GtkSortType

_gtk_file_chooser_settings_get_sort_order (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->sort_order;

}

void

_gtk_file_chooser_settings_set_sort_order (GtkFileChooserSettings *settings,

					   GtkSortType sort_order)

{

  settings->sort_order = sort_order;

}

void

_gtk_file_chooser_settings_set_startup_mode (GtkFileChooserSettings *settings,

					     StartupMode             startup_mode)

{

  settings->startup_mode = startup_mode;

}

StartupMode

_gtk_file_chooser_settings_get_startup_mode (GtkFileChooserSettings *settings)

{

  ensure_settings_read (settings);

  return settings->startup_mode;

}

gboolean

_gtk_file_chooser_settings_save (GtkFileChooserSettings *settings,

				 GError                **error)

{

  const gchar *location_mode_str;

  gchar *filename;

  gchar *dirname;

  gchar *contents;

  gchar *sort_column;

  gchar *sort_order;

  gchar *startup_mode;

  gsize len;

  gboolean retval;

  GKeyFile *key_file;

  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);

  filename = get_config_filename ();

  dirname = NULL;

  retval = FALSE;

  if (settings->location_mode == LOCATION_MODE_PATH_BAR)

    location_mode_str = MODE_PATH_BAR;

  else if (settings->location_mode == LOCATION_MODE_FILENAME_ENTRY)

    location_mode_str = MODE_FILENAME_ENTRY;

  else

    {

      g_assert_not_reached ();

      return FALSE;

    }

  switch (settings->sort_column)

    {

    case FILE_LIST_COL_NAME:

      sort_column = COLUMN_NAME_STRING;

      break;

    case FILE_LIST_COL_MTIME:

      sort_column = COLUMN_MTIME_STRING;

      break;

    case FILE_LIST_COL_SIZE:

      sort_column = COLUMN_SIZE_STRING;

      break;

    default:

      g_assert_not_reached ();

      sort_column = NULL;

    }

  switch (settings->sort_order)

    {

    case GTK_SORT_ASCENDING:

      sort_order = SORT_ASCENDING_STRING;

      break;

    case GTK_SORT_DESCENDING:

      sort_order = SORT_DESCENDING_STRING;

      break;

    default:

      g_assert_not_reached ();

      sort_order = NULL;

    }

  switch (settings->startup_mode)

    {

    case STARTUP_MODE_RECENT:

      startup_mode = STARTUP_MODE_RECENT_STRING;

      break;

    case STARTUP_MODE_CWD:

      startup_mode = STARTUP_MODE_CWD_STRING;

      break;

    default:

      g_assert_not_reached ();

      startup_mode = NULL;

    }

  key_file = g_key_file_new ();

  /* Initialise with the on-disk keyfile, so we keep unknown options */

  g_key_file_load_from_file (key_file, filename, 0, NULL);

  g_key_file_set_string (key_file, SETTINGS_GROUP,

			 LOCATION_MODE_KEY, location_mode_str);

  g_key_file_set_boolean (key_file, SETTINGS_GROUP,

			  SHOW_HIDDEN_KEY, settings->show_hidden);

  g_key_file_set_boolean (key_file, SETTINGS_GROUP,

			  SHOW_SIZE_COLUMN_KEY, settings->show_size_column);

  g_key_file_set_integer (key_file, SETTINGS_GROUP,

			  GEOMETRY_X_KEY, settings->geometry_x);

  g_key_file_set_integer (key_file, SETTINGS_GROUP,

			  GEOMETRY_Y_KEY, settings->geometry_y);

  g_key_file_set_integer (key_file, SETTINGS_GROUP,

			  GEOMETRY_WIDTH_KEY, settings->geometry_width);

  g_key_file_set_integer (key_file, SETTINGS_GROUP,

			  GEOMETRY_HEIGHT_KEY, settings->geometry_height);

  g_key_file_set_string (key_file, SETTINGS_GROUP,

			 SORT_COLUMN_KEY, sort_column);

  g_key_file_set_string (key_file, SETTINGS_GROUP,

			 SORT_ORDER_KEY, sort_order);

  g_key_file_set_string (key_file, SETTINGS_GROUP,

			 STARTUP_MODE_KEY, startup_mode);

  contents = g_key_file_to_data (key_file, &len, error);

  g_key_file_free (key_file);

  if (!contents)

    goto out;

  if (!g_file_set_contents (filename, contents, len, NULL))

    {

      char *dirname;

      int saved_errno;

      /* Directory is not there? */

      dirname = get_config_dirname ();

      if (g_mkdir_with_parents (dirname, 0700) != 0) /* 0700 per the XDG basedir spec */

	{

	  saved_errno = errno;

	  g_set_error (error,

		       G_FILE_ERROR,

		       g_file_error_from_errno (saved_errno),

		       _("Error creating folder '%s': %s"),

		       dirname, g_strerror (saved_errno));

	  goto out;

	}

      if (!g_file_set_contents (filename, contents, len, error))

	goto out;

    }

  retval = TRUE;

 out:

  g_free (contents);

  g_free (dirname);

  g_free (filename);

  return retval;

}