Add encoding support and fix compression option handling

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@13746 57a11ea4-9604-0410-9ed3-97b8803252fd

lib/libqof/backend/file/qof-backend-qsf.h

@@ -141,7 +141,6 @@ Check the QofBackendError - don't assume the file is OK.
 
 #include "qoflog.h"
 #include "qofbackend.h"
-#include "qof-be-utils.h"
 
 /** \brief Describe this backend to the application. 
 
@@ -194,6 +193,11 @@ to offer multiple map selections to the user.
 */
 #define QSF_MAP_FILES   "selected_map_files"
 
+/** \brief Encoding string.
+ *
+ * Defaults of UTF-8. */
+#define QSF_ENCODING    "encoding_string"
+
 /** @} */
 
 /** @} */

lib/libqof/backend/file/qsf-backend.c

@@ -24,13 +24,17 @@
 #define _GNU_SOURCE
 
 #include "config.h"
+#include <glib.h>
 #include "qof.h"
 #include "qof-backend-qsf.h"
+#include <libxml/xmlmemory.h>
+#include <libxml/tree.h>
+#include <libxml/parser.h>
+#include <libxml/xmlschemas.h>
 #include "qsf-xml.h"
 #include "qsf-dir.h"
 #include <errno.h>
 #include <sys/stat.h>
-#include <locale.h> /* for setlocale() and LC_ALL */
 
 #define QSF_TYPE_BINARY "binary"
 #define QSF_TYPE_GLIST  "glist"
@@ -55,10 +59,15 @@ static void option_cb (QofBackendOption *option, gpointer data)
 	params = (qsf_param*)data;
 	g_return_if_fail(params);
 	if(0 == safe_strcmp(QSF_COMPRESS, option->option_name)) {
-		params->use_gz_level = GPOINTER_TO_INT(option->value);
+		params->use_gz_level = (*(gint64*)option->value);
+	        DEBUG (" gz=%" G_GINT64_FORMAT,params->use_gz_level);
 	}
 	if (0 == safe_strcmp(QSF_MAP_FILES, option->option_name)) {
-		params->map_files = g_list_copy(option->value);
+		params->map_files = g_list_copy((GList*)option->value);
+	}
+	if (0 == safe_strcmp(QSF_ENCODING, option->option_name)) {
+		params->encoding = g_strdup(option->value);
+		DEBUG (" encoding=%s", params->encoding);
 	}
 }
 
@@ -68,10 +77,12 @@ qsf_load_config(QofBackend *be, KvpFrame *config)
 	QSFBackend *qsf_be;
 	qsf_param  *params;
 
+	ENTER (" ");
 	qsf_be = (QSFBackend*)be;
 	g_return_if_fail(qsf_be->params);
 	params = qsf_be->params;
 	qof_backend_option_foreach(config, option_cb, params);
+	LEAVE (" ");
 }
 
 static KvpFrame*
@@ -82,6 +93,7 @@ qsf_get_config(QofBackend *be)
 	qsf_param *params;
 
 	if(!be) { return NULL; }
+	ENTER (" ");
 	qsf_be = (QSFBackend*)be;
 	g_return_val_if_fail(qsf_be->params, NULL);
 	params = qsf_be->params;
@@ -92,7 +104,7 @@ qsf_get_config(QofBackend *be)
 	option->tooltip = _("QOF can compress QSF XML files using gzip. "
 		"Note that compression is not used when outputting to STDOUT.");
 	option->type = KVP_TYPE_GINT64;
-	option->value = GINT_TO_POINTER(params->use_gz_level);
+	option->value = (gpointer)&params->use_gz_level;
 	qof_backend_prepare_option(be, option);
 	g_free(option);
 	option = g_new0(QofBackendOption, 1);
@@ -101,9 +113,19 @@ qsf_get_config(QofBackend *be)
 	option->tooltip = _("QOF can convert objects within QSF XML files "
 		"using a map of the changes required.");
 	option->type = KVP_TYPE_GLIST;
-	option->value = params->map_files;
+	option->value = (gpointer)params->map_files;
 	qof_backend_prepare_option(be, option);
 	g_free(option);
+	option = g_new0(QofBackendOption, 1);
+	option->option_name = QSF_ENCODING;
+	option->description = _("Encoding string to use when writing the XML file.");
+	option->tooltip = _("QSF defaults to UTF-8. Other encodings are supported by "
+			"passing the encoding string in this option.");
+	option->type = KVP_TYPE_STRING;
+	option->value = (gpointer)params->encoding;
+	qof_backend_prepare_option(be, option);
+	g_free(option);
+	LEAVE (" ");
 	return qof_backend_complete_frame(be);
 }
 
@@ -139,6 +161,7 @@ qsf_param_init(qsf_param *params)
 	params->map_ns = NULL;
 	params->map_files = NULL;
 	params->map_path = NULL;
+	params->encoding = "UTF-8";
 	params->qsf_object_list = NULL;
 	params->qsf_parameter_hash = g_hash_table_new(g_str_hash, g_str_equal);
 	params->qsf_default_hash = g_hash_table_new(g_str_hash, g_str_equal);
@@ -909,12 +932,14 @@ write_qsf_from_book(const char *path, QofBook *book, qsf_param *params)
 	be = qof_book_get_backend(book);
 	qsf_doc = qofbook_to_qsf(book, params);
 	write_result = 0;
+	DEBUG (" use_gz_level=%" G_GINT64_FORMAT " encoding=%s", 
+		params->use_gz_level, params->encoding);
 	if((params->use_gz_level > 0) && (params->use_gz_level <= 9)) 
 	{
 		xmlSetDocCompressMode(qsf_doc, params->use_gz_level); 
 	}
 	g_return_if_fail(qsf_is_valid(QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, qsf_doc) == TRUE);
-	write_result = xmlSaveFormatFileEnc(path, qsf_doc, "UTF-8", 1);
+	write_result = xmlSaveFormatFileEnc(path, qsf_doc, params->encoding, 1);
 	if(write_result < 0) 
 	{
 		qof_backend_set_error(be, ERR_FILEIO_WRITE_ERROR);
@@ -930,7 +955,9 @@ write_qsf_to_stdout(QofBook *book, qsf_param *params)
 
 	qsf_doc = qofbook_to_qsf(book, params);
 	g_return_if_fail(qsf_is_valid(QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, qsf_doc) == TRUE);
-	xmlSaveFormatFileEnc("-", qsf_doc, "UTF-8", 1);
+	DEBUG (" use_gz_level=%" G_GINT64_FORMAT " encoding=%s", 
+		params->use_gz_level, params->encoding);
+	xmlSaveFormatFileEnc("-", qsf_doc, params->encoding, 1);
 	fprintf(stdout, "\n");
 	xmlFreeDoc(qsf_doc);
 }
@@ -1249,15 +1276,12 @@ qsf_provider_init(void)
 {
 	QofBackendProvider *prov;
 
-	/* XXX: Do we REALLY want to do this???  Shouldn't the APP
-	 * have already done this?
-	 */
-	#ifdef ENABLE_NLS
+/*	#ifdef ENABLE_NLS
 	setlocale (LC_ALL, "");
 	bindtextdomain (GETTEXT_PACKAGE, LOCALE_DIR);
 	bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
 	textdomain (GETTEXT_PACKAGE);
-	#endif
+	#endif*/
 	prov = g_new0 (QofBackendProvider, 1);
 	prov->provider_name = "QSF Backend Version 0.2";
 	prov->access_method = "file";

lib/libqof/backend/file/qsf-xml-map.c

@@ -24,7 +24,7 @@
 #define _GNU_SOURCE
 
 #include "config.h"
-
+#include <glib.h>
 #include <libxml/xmlversion.h>
 #include <libxml/xmlmemory.h>
 #include <libxml/tree.h>

lib/libqof/backend/file/qsf-xml.c

@@ -24,8 +24,12 @@
 #define _GNU_SOURCE
 
 #include "config.h"
-
+#include <glib.h>
 #include <libxml/xmlversion.h>
+#include <libxml/xmlmemory.h>
+#include <libxml/tree.h>
+#include <libxml/parser.h>
+#include <libxml/xmlschemas.h>
 #include "qof.h"
 #include "qof-backend-qsf.h"
 #include "qsf-dir.h"

lib/libqof/backend/file/qsf-xml.h

@@ -31,17 +31,12 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <glib.h>
 #include <regex.h>
 #include <time.h>
-#include <libxml/xmlmemory.h>
-#include <libxml/tree.h>
-#include <libxml/parser.h>
-#include <libxml/xmlschemas.h>
 #include "qof.h"
 
 #include <libintl.h>
-#define _(String) gettext (String)
+#define _(String) dgettext (GETTEXT_PACKAGE, String)
 
 typedef enum  {
 	QSF_UNDEF = 0, /**< Initial undefined value. */
@@ -379,11 +374,12 @@ typedef struct qsf_metadata
 	gchar *filepath;              /**< Path to the QSF file. */
 	gchar *map_path;              /**< Path to best match map, if any. */
 	gchar* full_kvp_path;         /**< Full path for each KvpValue written out. */
-	gint use_gz_level;            /**< Default compression level. */
+	gint64 use_gz_level;          /**< Default compression level. */
 	GList *map_files;             /**< List of selected map files for this session.
 
 	Defaults to the pre-installed QSF maps, currently: pilot-qsf-GnuCashInvoice.xml
 	*/
+	const gchar *encoding;        /**< Backend encoding option - defaults to UTF-8. */ 
 }qsf_param;
 
 /** \brief Validation metadata