4569fdd34b
According to some bug reports, it seems that under some (unknown)
conditions we might save an empty custom gradient file on exit (for
equally unknown reasons). The only difference in the way we save
internal data files, such as the custom gradient, compared to
gimp_data_save(), is the fact that we currently don't explicitly
close the output stream, but rather only unref it.
The output stream should be implicitly closed (and hence flushed)
upon destruction, but maybe the unreffing is not enough to
guarantee that it's actually destroyed (maybe it spawns an extra
reference for some reason, who knows.) Anyway, let's just
explicitly close it, which also gives us a chance to catch and
report any errors occursing during flushing/closing (which,
altenatively, might be the culprit).
Additionally, a few more error-reporting improvements, to match
gimp_data_save().
(cherry picked from commit a72f7f1ace)
338 lines
9 KiB
C
338 lines
9 KiB
C
/* GIMP - The GNU Image Manipulation Program
|
|
* Copyright (C) 1995-2002 Spencer Kimball, Peter Mattis, and others
|
|
*
|
|
* gimp-internal-data.c
|
|
* Copyright (C) 2017 Ell
|
|
*
|
|
* 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, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <gdk-pixbuf/gdk-pixbuf.h>
|
|
#include <gegl.h>
|
|
|
|
#include "libgimpbase/gimpbase.h"
|
|
|
|
#include "core-types.h"
|
|
|
|
#include "gimp.h"
|
|
#include "gimp-gradients.h"
|
|
#include "gimp-internal-data.h"
|
|
#include "gimpdata.h"
|
|
#include "gimpdataloaderfactory.h"
|
|
#include "gimperror.h"
|
|
#include "gimpgradient-load.h"
|
|
|
|
#include "gimp-intl.h"
|
|
|
|
|
|
#define GIMP_INTERNAL_DATA_DIRECTORY "internal-data"
|
|
|
|
|
|
typedef GimpData * (* GimpDataGetFunc) (Gimp *gimp);
|
|
|
|
|
|
typedef struct _GimpInternalDataFile GimpInternalDataFile;
|
|
|
|
struct _GimpInternalDataFile
|
|
{
|
|
const gchar *name;
|
|
GimpDataGetFunc get_func;
|
|
GimpDataLoadFunc load_func;
|
|
};
|
|
|
|
|
|
/* local function prototypes */
|
|
|
|
static gboolean gimp_internal_data_create_directory (GError **error);
|
|
|
|
static GFile * gimp_internal_data_get_file (const GimpInternalDataFile *data_file);
|
|
|
|
static gboolean gimp_internal_data_load_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error);
|
|
static gboolean gimp_internal_data_save_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error);
|
|
static gboolean gimp_internal_data_delete_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error);
|
|
|
|
/* static variables */
|
|
|
|
static const GimpInternalDataFile internal_data_files[] =
|
|
{
|
|
/* Custom gradient */
|
|
{
|
|
.name = "custom" GIMP_GRADIENT_FILE_EXTENSION,
|
|
.get_func = (GimpDataGetFunc) gimp_gradients_get_custom,
|
|
.load_func = gimp_gradient_load
|
|
}
|
|
};
|
|
|
|
|
|
/* public functions */
|
|
|
|
gboolean
|
|
gimp_internal_data_load (Gimp *gimp,
|
|
GError **error)
|
|
{
|
|
gint i;
|
|
|
|
g_return_val_if_fail (GIMP_IS_GIMP (gimp), FALSE);
|
|
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
|
|
|
|
for (i = 0; i < G_N_ELEMENTS (internal_data_files); i++)
|
|
{
|
|
const GimpInternalDataFile *data_file = &internal_data_files[i];
|
|
|
|
if (! gimp_internal_data_load_data_file (gimp, data_file, error))
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
gboolean
|
|
gimp_internal_data_save (Gimp *gimp,
|
|
GError **error)
|
|
{
|
|
gint i;
|
|
|
|
g_return_val_if_fail (GIMP_IS_GIMP (gimp), FALSE);
|
|
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
|
|
|
|
if (! gimp_internal_data_create_directory (error))
|
|
return FALSE;
|
|
|
|
for (i = 0; i < G_N_ELEMENTS (internal_data_files); i++)
|
|
{
|
|
const GimpInternalDataFile *data_file = &internal_data_files[i];
|
|
|
|
if (! gimp_internal_data_save_data_file (gimp, data_file, error))
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
gboolean
|
|
gimp_internal_data_clear (Gimp *gimp,
|
|
GError **error)
|
|
{
|
|
gint i;
|
|
|
|
g_return_val_if_fail (GIMP_IS_GIMP (gimp), FALSE);
|
|
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
|
|
|
|
for (i = 0; i < G_N_ELEMENTS (internal_data_files); i++)
|
|
{
|
|
const GimpInternalDataFile *data_file = &internal_data_files[i];
|
|
|
|
if (! gimp_internal_data_delete_data_file (gimp, data_file, error))
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
/* private functions */
|
|
|
|
static gboolean
|
|
gimp_internal_data_create_directory (GError **error)
|
|
{
|
|
GFile *directory;
|
|
GError *my_error = NULL;
|
|
gboolean success;
|
|
|
|
directory = gimp_directory_file (GIMP_INTERNAL_DATA_DIRECTORY, NULL);
|
|
|
|
success = g_file_make_directory (directory, NULL, &my_error);
|
|
|
|
g_object_unref (directory);
|
|
|
|
if (! success)
|
|
{
|
|
if (my_error->code == G_IO_ERROR_EXISTS)
|
|
{
|
|
g_clear_error (&my_error);
|
|
success = TRUE;
|
|
}
|
|
else
|
|
{
|
|
g_propagate_error (error, my_error);
|
|
}
|
|
}
|
|
|
|
return success;
|
|
}
|
|
|
|
static GFile *
|
|
gimp_internal_data_get_file (const GimpInternalDataFile *data_file)
|
|
{
|
|
return gimp_directory_file (GIMP_INTERNAL_DATA_DIRECTORY,
|
|
data_file->name,
|
|
NULL);
|
|
}
|
|
|
|
static gboolean
|
|
gimp_internal_data_load_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error)
|
|
{
|
|
GFile *file;
|
|
GInputStream *input;
|
|
GimpData *data;
|
|
GList *list;
|
|
GError *my_error = NULL;
|
|
|
|
file = gimp_internal_data_get_file (data_file);
|
|
|
|
if (gimp->be_verbose)
|
|
g_print ("Parsing '%s'\n", gimp_file_get_utf8_name (file));
|
|
|
|
input = G_INPUT_STREAM (g_file_read (file, NULL, &my_error));
|
|
|
|
if (! input)
|
|
{
|
|
g_object_unref (file);
|
|
|
|
if (my_error->code == G_IO_ERROR_NOT_FOUND)
|
|
{
|
|
g_clear_error (&my_error);
|
|
return TRUE;
|
|
}
|
|
else
|
|
{
|
|
g_propagate_error (error, my_error);
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
list = data_file->load_func (gimp->user_context, file, input, error);
|
|
|
|
g_object_unref (input);
|
|
g_object_unref (file);
|
|
|
|
if (! list)
|
|
return FALSE;
|
|
|
|
data = data_file->get_func (gimp);
|
|
|
|
gimp_data_copy (data, GIMP_DATA (list->data));
|
|
|
|
g_list_free_full (list, g_object_unref);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
gimp_internal_data_save_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error)
|
|
{
|
|
GFile *file;
|
|
GOutputStream *output;
|
|
GimpData *data;
|
|
gboolean success;
|
|
|
|
file = gimp_internal_data_get_file (data_file);
|
|
|
|
if (gimp->be_verbose)
|
|
g_print ("Writing '%s'\n", gimp_file_get_utf8_name (file));
|
|
|
|
output = G_OUTPUT_STREAM (g_file_replace (file, NULL, FALSE,
|
|
G_FILE_CREATE_NONE,
|
|
NULL, error));
|
|
|
|
if (! output)
|
|
{
|
|
g_object_unref (file);
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
data = data_file->get_func (gimp);
|
|
|
|
/* we bypass gimp_data_save() and call the data's save() virtual function
|
|
* directly, since gimp_data_save() is a nop for internal data.
|
|
*
|
|
* FIXME: we save the data whether it's dirty or not, since it might not
|
|
* exist on disk. currently, we only use this for cheap data, such as
|
|
* gradients, so this is not a big concern, but if we save more expensive
|
|
* data in the future, we should fix this.
|
|
*/
|
|
gimp_assert (GIMP_DATA_GET_CLASS (data)->save);
|
|
success = GIMP_DATA_GET_CLASS (data)->save (data, output, error);
|
|
|
|
if (success)
|
|
{
|
|
if (! g_output_stream_close (output, NULL, error))
|
|
{
|
|
g_prefix_error (error,
|
|
_("Error saving '%s': "),
|
|
gimp_file_get_utf8_name (file));
|
|
success = FALSE;
|
|
}
|
|
}
|
|
else if (error && *error)
|
|
{
|
|
g_prefix_error (error,
|
|
_("Error saving '%s': "),
|
|
gimp_file_get_utf8_name (file));
|
|
}
|
|
else
|
|
{
|
|
g_set_error (error, GIMP_DATA_ERROR, GIMP_DATA_ERROR_WRITE,
|
|
_("Error saving '%s'"),
|
|
gimp_file_get_utf8_name (file));
|
|
}
|
|
|
|
g_object_unref (output);
|
|
g_object_unref (file);
|
|
|
|
return success;
|
|
}
|
|
|
|
static gboolean
|
|
gimp_internal_data_delete_data_file (Gimp *gimp,
|
|
const GimpInternalDataFile *data_file,
|
|
GError **error)
|
|
{
|
|
GFile *file;
|
|
GError *my_error = NULL;
|
|
gboolean success = TRUE;
|
|
|
|
file = gimp_internal_data_get_file (data_file);
|
|
|
|
if (gimp->be_verbose)
|
|
g_print ("Deleting '%s'\n", gimp_file_get_utf8_name (file));
|
|
|
|
if (! g_file_delete (file, NULL, &my_error) &&
|
|
my_error->code != G_IO_ERROR_NOT_FOUND)
|
|
{
|
|
success = FALSE;
|
|
|
|
g_set_error (error, GIMP_ERROR, GIMP_FAILED,
|
|
_("Deleting \"%s\" failed: %s"),
|
|
gimp_file_get_utf8_name (file), my_error->message);
|
|
}
|
|
|
|
g_clear_error (&my_error);
|
|
g_object_unref (file);
|
|
|
|
return success;
|
|
}
|