From 448bc5600bb2d0dccac39559e865df412d8e1363 Mon Sep 17 00:00:00 2001
From: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
Date: Mon, 8 Jun 2020 23:07:46 +0200
Subject: filter: implement saving of presets to XML file

Users might want to move their presets with there log-file. Therefore,
save the presets to the log. The alternative would be to save them
to the preferences. However, on the mailinglist it was decided that
moving the presets to a mobile device is a wanted feature.

The XML saving code has a rather reasonable interface, therefore
this turned out to be pretty easy to implement.

The filter presets are saved into a
<filterpresets>
 ...
</filterpresets>
block

Each individual preset is saved into a
 <filterpreset name='...'>
    ...
 </filterpreset>
Block with a unique name attribute.

Each preset contains zero or one fulltext and zero or more constraint entries.
The type and mode(s) are controlled by attributes, the "payload" is saved in
the block. Note that all the formatting is done by functions in core/filterconstraint.c
and not the parser itself.

A preset in the XML file might look like this:

 <filterpreset name='test1'>
  <fulltext mode='startswith'>Train</fulltext>
  <constraint type='planned'>0,0</constraint>
  <constraint type='sac' range_mode='range' negate='1'>5000,10000</constraint>
 </filterpreset>

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
---
 core/save-xml.c | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/core/save-xml.c b/core/save-xml.c
index 54469a1cf..0f2d92439 100644
--- a/core/save-xml.c
+++ b/core/save-xml.c
@@ -15,6 +15,8 @@
 #include "dive.h"
 #include "divesite.h"
 #include "errorhelper.h"
+#include "filterconstraint.h"
+#include "filterpreset.h"
 #include "subsurface-string.h"
 #include "subsurface-time.h"
 #include "trip.h"
@@ -609,6 +611,56 @@ int save_dives(const char *filename)
 	return save_dives_logic(filename, false, false);
 }
 
+static void save_filter_presets(struct membuffer *b)
+{
+	int i;
+
+	if (filter_presets_count() <= 0)
+		return;
+	put_format(b, "<filterpresets>\n");
+	for (i = 0; i < filter_presets_count(); i++) {
+		char *name, *fulltext;
+		name = filter_preset_name(i);
+		put_format(b, " <filterpreset");
+		show_utf8(b, name, " name='", "'", 1);
+		put_format(b, ">\n");
+		free(name);
+
+		fulltext = filter_preset_fulltext_query(i);
+		if (!empty_string(fulltext)) {
+			const char *fulltext_mode = filter_preset_fulltext_mode(i);
+			show_utf8(b, fulltext_mode, "  <fulltext mode='", "'>", 1);
+			show_utf8(b, fulltext, "", "</fulltext>\n", 0);
+		}
+		free(fulltext);
+
+		for (int j = 0; j < filter_preset_constraint_count(i); j++) {
+			char *data;
+			const struct filter_constraint *constraint = filter_preset_constraint(i, j);
+			const char *type = filter_constraint_type_to_string(constraint->type);
+			put_format(b, "  <constraint");
+			show_utf8(b, type, " type='", "'", 1);
+			if (filter_constraint_has_string_mode(constraint->type)) {
+				const char *mode = filter_constraint_string_mode_to_string(constraint->string_mode);
+				show_utf8(b, mode, " string_mode='", "'", 1);
+			}
+			if (filter_constraint_has_range_mode(constraint->type)) {
+				const char *mode = filter_constraint_range_mode_to_string(constraint->range_mode);
+				show_utf8(b, mode, " range_mode='", "'", 1);
+			}
+			if (constraint->negate)
+				put_format(b, " negate='1'");
+			put_format(b, ">");
+			data = filter_constraint_data_to_string(constraint);
+			show_utf8(b, data, "", "", 0);
+			free(data);
+			put_format(b, "</constraint>\n");
+		}
+		put_format(b, " </filterpreset>\n");
+	}
+	put_format(b, "</filterpresets>\n");
+}
+
 static void save_dives_buffer(struct membuffer *b, bool select_only, bool anonymize)
 {
 	int i;
@@ -657,6 +709,9 @@ static void save_dives_buffer(struct membuffer *b, bool select_only, bool anonym
 	for (i = 0; i < trip_table.nr; ++i)
 		trip_table.trips[i]->saved = 0;
 
+	/* save the filter presets */
+	save_filter_presets(b);
+
 	/* save the dives */
 	for_each_dive(i, dive) {
 		if (select_only) {
-- 
cgit v1.2.3-70-g09d2