mirror of
				https://github.com/subsurface/subsurface.git
				synced 2025-02-19 22:16:15 +00:00 
			
		
		
		
	Store cylinder.depth in XML files and in git storage. This info is in fact the gas switch depth of a specific gas/cylinder in the planner. This change avoids the need of typing in a user specific depth value again when replanning an existing planned dive. Signed-off-by: Stefan Fuchs <sfuchs@gmx.de>
		
			
				
	
	
		
			801 lines
		
	
	
	
		
			22 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			801 lines
		
	
	
	
		
			22 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| // SPDX-License-Identifier: GPL-2.0
 | |
| #ifdef __clang__
 | |
| // Clang has a bug on zero-initialization of C structs.
 | |
| #pragma clang diagnostic ignored "-Wmissing-field-initializers"
 | |
| #endif
 | |
| 
 | |
| #include <stdio.h>
 | |
| #include <ctype.h>
 | |
| #include <string.h>
 | |
| #include <stdlib.h>
 | |
| #include <errno.h>
 | |
| #include <time.h>
 | |
| #include <unistd.h>
 | |
| #include <fcntl.h>
 | |
| 
 | |
| #include "dive.h"
 | |
| #include "divelist.h"
 | |
| #include "device.h"
 | |
| #include "membuffer.h"
 | |
| #include "strndup.h"
 | |
| #include "git-access.h"
 | |
| #include "qthelperfromc.h"
 | |
| 
 | |
| /*
 | |
|  * We're outputting utf8 in xml.
 | |
|  * We need to quote the characters <, >, &.
 | |
|  *
 | |
|  * Technically I don't think we'd necessarily need to quote the control
 | |
|  * characters, but at least libxml2 doesn't like them. It doesn't even
 | |
|  * allow them quoted. So we just skip them and replace them with '?'.
 | |
|  *
 | |
|  * If we do this for attributes, we need to quote the quotes we use too.
 | |
|  */
 | |
| static void quote(struct membuffer *b, const char *text, int is_attribute)
 | |
| {
 | |
| 	int is_html = 0;
 | |
| 	put_quoted(b, text, is_attribute, is_html);
 | |
| }
 | |
| 
 | |
| static void show_utf8(struct membuffer *b, const char *text, const char *pre, const char *post, int is_attribute)
 | |
| {
 | |
| 	int len;
 | |
| 	char *cleaned;
 | |
| 
 | |
| 	if (!text)
 | |
| 		return;
 | |
| 	/* remove leading and trailing space */
 | |
| 	/* We need to combine isascii() with isspace(),
 | |
| 	 * because we can only trust isspace() with 7-bit ascii,
 | |
| 	 * on windows for example */
 | |
| 	while (isascii(*text) && isspace(*text))
 | |
| 		text++;
 | |
| 	len = strlen(text);
 | |
| 	if (!len)
 | |
| 		return;
 | |
| 	while (len && isascii(text[len - 1]) && isspace(text[len - 1]))
 | |
| 		len--;
 | |
| 	cleaned = strndup(text, len);
 | |
| 	put_string(b, pre);
 | |
| 	quote(b, cleaned, is_attribute);
 | |
| 	put_string(b, post);
 | |
| 	free(cleaned);
 | |
| }
 | |
| 
 | |
| static void save_depths(struct membuffer *b, struct divecomputer *dc)
 | |
| {
 | |
| 	/* What's the point of this dive entry again? */
 | |
| 	if (!dc->maxdepth.mm && !dc->meandepth.mm)
 | |
| 		return;
 | |
| 
 | |
| 	put_string(b, "  <depth");
 | |
| 	put_depth(b, dc->maxdepth, " max='", " m'");
 | |
| 	put_depth(b, dc->meandepth, " mean='", " m'");
 | |
| 	put_string(b, " />\n");
 | |
| }
 | |
| 
 | |
| static void save_dive_temperature(struct membuffer *b, struct dive *dive)
 | |
| {
 | |
| 	if (!dive->airtemp.mkelvin && !dive->watertemp.mkelvin)
 | |
| 		return;
 | |
| 	if (dive->airtemp.mkelvin == dc_airtemp(&dive->dc) && dive->watertemp.mkelvin == dc_watertemp(&dive->dc))
 | |
| 		return;
 | |
| 
 | |
| 	put_string(b, "  <divetemperature");
 | |
| 	if (dive->airtemp.mkelvin != dc_airtemp(&dive->dc))
 | |
| 		put_temperature(b, dive->airtemp, " air='", " C'");
 | |
| 	if (dive->watertemp.mkelvin != dc_watertemp(&dive->dc))
 | |
| 		put_temperature(b, dive->watertemp, " water='", " C'");
 | |
| 	put_string(b, "/>\n");
 | |
| }
 | |
| 
 | |
| static void save_temperatures(struct membuffer *b, struct divecomputer *dc)
 | |
| {
 | |
| 	if (!dc->airtemp.mkelvin && !dc->watertemp.mkelvin)
 | |
| 		return;
 | |
| 	put_string(b, "  <temperature");
 | |
| 	put_temperature(b, dc->airtemp, " air='", " C'");
 | |
| 	put_temperature(b, dc->watertemp, " water='", " C'");
 | |
| 	put_string(b, " />\n");
 | |
| }
 | |
| 
 | |
| static void save_airpressure(struct membuffer *b, struct divecomputer *dc)
 | |
| {
 | |
| 	if (!dc->surface_pressure.mbar)
 | |
| 		return;
 | |
| 	put_string(b, "  <surface");
 | |
| 	put_pressure(b, dc->surface_pressure, " pressure='", " bar'");
 | |
| 	put_string(b, " />\n");
 | |
| }
 | |
| 
 | |
| static void save_salinity(struct membuffer *b, struct divecomputer *dc)
 | |
| {
 | |
| 	/* only save if we have a value that isn't the default of sea water */
 | |
| 	if (!dc->salinity || dc->salinity == SEAWATER_SALINITY)
 | |
| 		return;
 | |
| 	put_string(b, "  <water");
 | |
| 	put_salinity(b, dc->salinity, " salinity='", " g/l'");
 | |
| 	put_string(b, " />\n");
 | |
| }
 | |
| 
 | |
| static void save_overview(struct membuffer *b, struct dive *dive)
 | |
| {
 | |
| 	show_utf8(b, dive->divemaster, "  <divemaster>", "</divemaster>\n", 0);
 | |
| 	show_utf8(b, dive->buddy, "  <buddy>", "</buddy>\n", 0);
 | |
| 	show_utf8(b, dive->notes, "  <notes>", "</notes>\n", 0);
 | |
| 	show_utf8(b, dive->suit, "  <suit>", "</suit>\n", 0);
 | |
| }
 | |
| 
 | |
| static void put_gasmix(struct membuffer *b, struct gasmix *mix)
 | |
| {
 | |
| 	int o2 = mix->o2.permille;
 | |
| 	int he = mix->he.permille;
 | |
| 
 | |
| 	if (o2) {
 | |
| 		put_format(b, " o2='%u.%u%%'", FRACTION(o2, 10));
 | |
| 		if (he)
 | |
| 			put_format(b, " he='%u.%u%%'", FRACTION(he, 10));
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void save_cylinder_info(struct membuffer *b, struct dive *dive)
 | |
| {
 | |
| 	int i, nr;
 | |
| 
 | |
| 	nr = nr_cylinders(dive);
 | |
| 
 | |
| 	for (i = 0; i < nr; i++) {
 | |
| 		cylinder_t *cylinder = dive->cylinder + i;
 | |
| 		int volume = cylinder->type.size.mliter;
 | |
| 		const char *description = cylinder->type.description;
 | |
| 
 | |
| 		put_format(b, "  <cylinder");
 | |
| 		if (volume)
 | |
| 			put_milli(b, " size='", volume, " l'");
 | |
| 		put_pressure(b, cylinder->type.workingpressure, " workpressure='", " bar'");
 | |
| 		show_utf8(b, description, " description='", "'", 1);
 | |
| 		put_gasmix(b, &cylinder->gasmix);
 | |
| 		put_pressure(b, cylinder->start, " start='", " bar'");
 | |
| 		put_pressure(b, cylinder->end, " end='", " bar'");
 | |
| 		if (cylinder->cylinder_use != OC_GAS)
 | |
| 			show_utf8(b, cylinderuse_text[cylinder->cylinder_use], " use='", "'", 1);
 | |
| 		if (cylinder->depth.mm != 0)
 | |
| 			put_milli(b, " depth='", cylinder->depth.mm, " m'");
 | |
| 		put_format(b, " />\n");
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void save_weightsystem_info(struct membuffer *b, struct dive *dive)
 | |
| {
 | |
| 	int i, nr;
 | |
| 
 | |
| 	nr = nr_weightsystems(dive);
 | |
| 
 | |
| 	for (i = 0; i < nr; i++) {
 | |
| 		weightsystem_t *ws = dive->weightsystem + i;
 | |
| 		int grams = ws->weight.grams;
 | |
| 		const char *description = ws->description;
 | |
| 
 | |
| 		put_format(b, "  <weightsystem");
 | |
| 		put_milli(b, " weight='", grams, " kg'");
 | |
| 		show_utf8(b, description, " description='", "'", 1);
 | |
| 		put_format(b, " />\n");
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void show_integer(struct membuffer *b, int value, const char *pre, const char *post)
 | |
| {
 | |
| 	put_format(b, " %s%d%s", pre, value, post);
 | |
| }
 | |
| 
 | |
| static void show_index(struct membuffer *b, int value, const char *pre, const char *post)
 | |
| {
 | |
| 	if (value)
 | |
| 		show_integer(b, value, pre, post);
 | |
| }
 | |
| 
 | |
| static void save_sample(struct membuffer *b, struct sample *sample, struct sample *old, int o2sensor)
 | |
| {
 | |
| 	int idx;
 | |
| 
 | |
| 	put_format(b, "  <sample time='%u:%02u min'", FRACTION(sample->time.seconds, 60));
 | |
| 	put_milli(b, " depth='", sample->depth.mm, " m'");
 | |
| 	if (sample->temperature.mkelvin && sample->temperature.mkelvin != old->temperature.mkelvin) {
 | |
| 		put_temperature(b, sample->temperature, " temp='", " C'");
 | |
| 		old->temperature = sample->temperature;
 | |
| 	}
 | |
| 
 | |
| 	/*
 | |
| 	 * We only show sensor information for samples with pressure, and only if it
 | |
| 	 * changed from the previous sensor we showed.
 | |
| 	 */
 | |
| 	for (idx = 0; idx < MAX_SENSORS; idx++) {
 | |
| 		pressure_t p = sample->pressure[idx];
 | |
| 		int sensor = sample->sensor[idx];
 | |
| 
 | |
| 		if (!p.mbar)
 | |
| 			continue;
 | |
| 
 | |
| 		/* Legacy o2pressure format? */
 | |
| 		if (o2sensor >= 0) {
 | |
| 			if (sensor == o2sensor) {
 | |
| 				put_pressure(b, p, " o2pressure='", " bar'");
 | |
| 				continue;
 | |
| 			}
 | |
| 			put_pressure(b, p, " pressure='", " bar'");
 | |
| 			if (sensor != old->sensor[0]) {
 | |
| 				put_format(b, " sensor='%d'", sensor);
 | |
| 				old->sensor[0] = sensor;
 | |
| 			}
 | |
| 			continue;
 | |
| 		}
 | |
| 
 | |
| 		/* The new-style format is much simpler: the sensor is always encoded */
 | |
| 		put_format(b, " pressure%d=", sensor);
 | |
| 		put_pressure(b, p, "'", " bar'");
 | |
| 	}
 | |
| 
 | |
| 	/* the deco/ndl values are stored whenever they change */
 | |
| 	if (sample->ndl.seconds != old->ndl.seconds) {
 | |
| 		put_format(b, " ndl='%u:%02u min'", FRACTION(sample->ndl.seconds, 60));
 | |
| 		old->ndl = sample->ndl;
 | |
| 	}
 | |
| 	if (sample->tts.seconds != old->tts.seconds) {
 | |
| 		put_format(b, " tts='%u:%02u min'", FRACTION(sample->tts.seconds, 60));
 | |
| 		old->tts = sample->tts;
 | |
| 	}
 | |
| 	if (sample->rbt.seconds)
 | |
| 		put_format(b, " rbt='%u:%02u min'", FRACTION(sample->rbt.seconds, 60));
 | |
| 	if (sample->in_deco != old->in_deco) {
 | |
| 		put_format(b, " in_deco='%d'", sample->in_deco ? 1 : 0);
 | |
| 		old->in_deco = sample->in_deco;
 | |
| 	}
 | |
| 	if (sample->stoptime.seconds != old->stoptime.seconds) {
 | |
| 		put_format(b, " stoptime='%u:%02u min'", FRACTION(sample->stoptime.seconds, 60));
 | |
| 		old->stoptime = sample->stoptime;
 | |
| 	}
 | |
| 
 | |
| 	if (sample->stopdepth.mm != old->stopdepth.mm) {
 | |
| 		put_milli(b, " stopdepth='", sample->stopdepth.mm, " m'");
 | |
| 		old->stopdepth = sample->stopdepth;
 | |
| 	}
 | |
| 
 | |
| 	if (sample->cns != old->cns) {
 | |
| 		put_format(b, " cns='%u%%'", sample->cns);
 | |
| 		old->cns = sample->cns;
 | |
| 	}
 | |
| 
 | |
| 	if ((sample->o2sensor[0].mbar) && (sample->o2sensor[0].mbar != old->o2sensor[0].mbar)) {
 | |
| 		put_milli(b, " sensor1='", sample->o2sensor[0].mbar, " bar'");
 | |
| 		old->o2sensor[0] = sample->o2sensor[0];
 | |
| 	}
 | |
| 
 | |
| 	if ((sample->o2sensor[1].mbar) && (sample->o2sensor[1].mbar != old->o2sensor[1].mbar)) {
 | |
| 		put_milli(b, " sensor2='", sample->o2sensor[1].mbar, " bar'");
 | |
| 		old->o2sensor[1] = sample->o2sensor[1];
 | |
| 	}
 | |
| 
 | |
| 	if ((sample->o2sensor[2].mbar) && (sample->o2sensor[2].mbar != old->o2sensor[2].mbar)) {
 | |
| 		put_milli(b, " sensor3='", sample->o2sensor[2].mbar, " bar'");
 | |
| 		old->o2sensor[2] = sample->o2sensor[2];
 | |
| 	}
 | |
| 
 | |
| 	if (sample->setpoint.mbar != old->setpoint.mbar) {
 | |
| 		put_milli(b, " po2='", sample->setpoint.mbar, " bar'");
 | |
| 		old->setpoint = sample->setpoint;
 | |
| 	}
 | |
| 	if (sample->heartbeat != old->heartbeat) {
 | |
| 		show_index(b, sample->heartbeat, "heartbeat='", "'");
 | |
| 		old->heartbeat = sample->heartbeat;
 | |
| 	}
 | |
| 	if (sample->bearing.degrees != old->bearing.degrees) {
 | |
| 		show_index(b, sample->bearing.degrees, "bearing='", "'");
 | |
| 		old->bearing.degrees = sample->bearing.degrees;
 | |
| 	}
 | |
| 	put_format(b, " />\n");
 | |
| }
 | |
| 
 | |
| static void save_one_event(struct membuffer *b, struct dive *dive, struct event *ev)
 | |
| {
 | |
| 	put_format(b, "  <event time='%d:%02d min'", FRACTION(ev->time.seconds, 60));
 | |
| 	show_index(b, ev->type, "type='", "'");
 | |
| 	show_index(b, ev->flags, "flags='", "'");
 | |
| 	show_index(b, ev->value, "value='", "'");
 | |
| 	show_utf8(b, ev->name, " name='", "'", 1);
 | |
| 	if (event_is_gaschange(ev)) {
 | |
| 		struct gasmix *mix = get_gasmix_from_event(dive, ev);
 | |
| 		if (ev->gas.index >= 0)
 | |
| 			show_integer(b, ev->gas.index, "cylinder='", "'");
 | |
| 		put_gasmix(b, mix);
 | |
| 	}
 | |
| 	put_format(b, " />\n");
 | |
| }
 | |
| 
 | |
| 
 | |
| static void save_events(struct membuffer *b, struct dive *dive, struct event *ev)
 | |
| {
 | |
| 	while (ev) {
 | |
| 		save_one_event(b, dive, ev);
 | |
| 		ev = ev->next;
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void save_tags(struct membuffer *b, struct tag_entry *entry)
 | |
| {
 | |
| 	if (entry) {
 | |
| 		const char *sep = " tags='";
 | |
| 		do {
 | |
| 			struct divetag *tag = entry->tag;
 | |
| 			put_string(b, sep);
 | |
| 			/* If the tag has been translated, write the source to the xml file */
 | |
| 			quote(b, tag->source ?: tag->name, 1);
 | |
| 			sep = ", ";
 | |
| 		} while ((entry = entry->next) != NULL);
 | |
| 		put_string(b, "'");
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void save_extra_data(struct membuffer *b, struct extra_data *ed)
 | |
| {
 | |
| 	while (ed) {
 | |
| 		if (ed->key && ed->value) {
 | |
| 			put_string(b, "  <extradata");
 | |
| 			show_utf8(b, ed->key, " key='", "'", 1);
 | |
| 			show_utf8(b, ed->value, " value='", "'", 1);
 | |
| 			put_string(b, " />\n");
 | |
| 		}
 | |
| 		ed = ed->next;
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void show_date(struct membuffer *b, timestamp_t when)
 | |
| {
 | |
| 	struct tm tm;
 | |
| 
 | |
| 	utc_mkdate(when, &tm);
 | |
| 
 | |
| 	put_format(b, " date='%04u-%02u-%02u'",
 | |
| 		   tm.tm_year, tm.tm_mon + 1, tm.tm_mday);
 | |
| 	if (tm.tm_hour || tm.tm_min || tm.tm_sec)
 | |
| 		put_format(b, " time='%02u:%02u:%02u'",
 | |
| 			   tm.tm_hour, tm.tm_min, tm.tm_sec);
 | |
| }
 | |
| 
 | |
| static void save_samples(struct membuffer *b, struct dive *dive, struct divecomputer *dc)
 | |
| {
 | |
| 	int nr;
 | |
| 	int o2sensor;
 | |
| 	struct sample *s;
 | |
| 	struct sample dummy = { .bearing.degrees = -1, .ndl.seconds = -1 };
 | |
| 
 | |
| 	/* Set up default pressure sensor indexes */
 | |
| 	o2sensor = legacy_format_o2pressures(dive, dc);
 | |
| 	if (o2sensor >= 0) {
 | |
| 		dummy.sensor[0] = !o2sensor;
 | |
| 		dummy.sensor[1] = o2sensor;
 | |
| 	}
 | |
| 
 | |
| 	s = dc->sample;
 | |
| 	nr = dc->samples;
 | |
| 	while (--nr >= 0) {
 | |
| 		save_sample(b, s, &dummy, o2sensor);
 | |
| 		s++;
 | |
| 	}
 | |
| }
 | |
| 
 | |
| static void save_dc(struct membuffer *b, struct dive *dive, struct divecomputer *dc)
 | |
| {
 | |
| 	put_format(b, "  <divecomputer");
 | |
| 	show_utf8(b, dc->model, " model='", "'", 1);
 | |
| 	if (dc->deviceid)
 | |
| 		put_format(b, " deviceid='%08x'", dc->deviceid);
 | |
| 	if (dc->diveid)
 | |
| 		put_format(b, " diveid='%08x'", dc->diveid);
 | |
| 	if (dc->when && dc->when != dive->when)
 | |
| 		show_date(b, dc->when);
 | |
| 	if (dc->duration.seconds && dc->duration.seconds != dive->dc.duration.seconds)
 | |
| 		put_duration(b, dc->duration, " duration='", " min'");
 | |
| 	if (dc->divemode != OC) {
 | |
| 		for (enum dive_comp_type i = 0; i < NUM_DC_TYPE; i++)
 | |
| 			if (dc->divemode == i)
 | |
| 				show_utf8(b, divemode_text[i], " dctype='", "'", 1);
 | |
| 		if (dc->no_o2sensors)
 | |
| 			put_format(b," no_o2sensors='%d'", dc->no_o2sensors);
 | |
| 	}
 | |
| 	put_format(b, ">\n");
 | |
| 	save_depths(b, dc);
 | |
| 	save_temperatures(b, dc);
 | |
| 	save_airpressure(b, dc);
 | |
| 	save_salinity(b, dc);
 | |
| 	put_duration(b, dc->surfacetime, "  <surfacetime>", " min</surfacetime>\n");
 | |
| 	save_extra_data(b, dc->extra_data);
 | |
| 	save_events(b, dive, dc->events);
 | |
| 	save_samples(b, dive, dc);
 | |
| 
 | |
| 	put_format(b, "  </divecomputer>\n");
 | |
| }
 | |
| 
 | |
| static void save_picture(struct membuffer *b, struct picture *pic)
 | |
| {
 | |
| 	put_string(b, "  <picture filename='");
 | |
| 	put_quoted(b, pic->filename, true, false);
 | |
| 	put_string(b, "'");
 | |
| 	if (pic->offset.seconds) {
 | |
| 		int offset = pic->offset.seconds;
 | |
| 		char sign = '+';
 | |
| 		if (offset < 0) {
 | |
| 			sign = '-';
 | |
| 			offset = -offset;
 | |
| 		}
 | |
| 		put_format(b, " offset='%c%u:%02u min'", sign, FRACTION(offset, 60));
 | |
| 	}
 | |
| 	if (pic->latitude.udeg || pic->longitude.udeg) {
 | |
| 		put_degrees(b, pic->latitude, " gps='", " ");
 | |
| 		put_degrees(b, pic->longitude, "", "'");
 | |
| 	}
 | |
| 	if (hashstring(pic->filename))
 | |
| 		put_format(b, " hash='%s'", hashstring(pic->filename));
 | |
| 
 | |
| 	put_string(b, "/>\n");
 | |
| }
 | |
| 
 | |
| void save_one_dive_to_mb(struct membuffer *b, struct dive *dive)
 | |
| {
 | |
| 	struct divecomputer *dc;
 | |
| 
 | |
| 	put_string(b, "<dive");
 | |
| 	if (dive->number)
 | |
| 		put_format(b, " number='%d'", dive->number);
 | |
| 	if (dive->tripflag == NO_TRIP)
 | |
| 		put_format(b, " tripflag='NOTRIP'");
 | |
| 	if (dive->rating)
 | |
| 		put_format(b, " rating='%d'", dive->rating);
 | |
| 	if (dive->visibility)
 | |
| 		put_format(b, " visibility='%d'", dive->visibility);
 | |
| 	save_tags(b, dive->tag_list);
 | |
| 	if (dive->dive_site_uuid) {
 | |
| 		if (get_dive_site_by_uuid(dive->dive_site_uuid) != NULL)
 | |
| 			put_format(b, " divesiteid='%8x'", dive->dive_site_uuid);
 | |
| 		else if (verbose)
 | |
| 			fprintf(stderr, "removed reference to non-existant dive site with uuid %08x\n", dive->dive_site_uuid);
 | |
| 	}
 | |
| 	show_date(b, dive->when);
 | |
| 	if (dive->dc.duration.seconds > 0)
 | |
| 		put_format(b, " duration='%u:%02u min'>\n",
 | |
| 			   FRACTION(dive->dc.duration.seconds, 60));
 | |
| 	else
 | |
| 		put_format(b, ">\n");
 | |
| 	save_overview(b, dive);
 | |
| 	save_cylinder_info(b, dive);
 | |
| 	save_weightsystem_info(b, dive);
 | |
| 	save_dive_temperature(b, dive);
 | |
| 	/* Save the dive computer data */
 | |
| 	for_each_dc(dive, dc)
 | |
| 		save_dc(b, dive, dc);
 | |
| 	FOR_EACH_PICTURE(dive)
 | |
| 		save_picture(b, picture);
 | |
| 	put_format(b, "</dive>\n");
 | |
| }
 | |
| 
 | |
| int save_dive(FILE *f, struct dive *dive)
 | |
| {
 | |
| 	struct membuffer buf = { 0 };
 | |
| 
 | |
| 	save_one_dive_to_mb(&buf, dive);
 | |
| 	flush_buffer(&buf, f);
 | |
| 	/* Error handling? */
 | |
| 	return 0;
 | |
| }
 | |
| 
 | |
| static void save_trip(struct membuffer *b, dive_trip_t *trip)
 | |
| {
 | |
| 	int i;
 | |
| 	struct dive *dive;
 | |
| 
 | |
| 	put_format(b, "<trip");
 | |
| 	show_date(b, trip->when);
 | |
| 	show_utf8(b, trip->location, " location=\'", "\'", 1);
 | |
| 	put_format(b, ">\n");
 | |
| 	show_utf8(b, trip->notes, "<notes>", "</notes>\n", 0);
 | |
| 
 | |
| 	/*
 | |
| 	 * Incredibly cheesy: we want to save the dives sorted, and they
 | |
| 	 * are sorted in the dive array.. So instead of using the dive
 | |
| 	 * list in the trip, we just traverse the global dive array and
 | |
| 	 * check the divetrip pointer..
 | |
| 	 */
 | |
| 	for_each_dive(i, dive) {
 | |
| 		if (dive->divetrip == trip)
 | |
| 			save_one_dive_to_mb(b, dive);
 | |
| 	}
 | |
| 
 | |
| 	put_format(b, "</trip>\n");
 | |
| }
 | |
| 
 | |
| static void save_one_device(void *_f, const char *model, uint32_t deviceid,
 | |
| 			    const char *nickname, const char *serial_nr, const char *firmware)
 | |
| {
 | |
| 	struct membuffer *b = _f;
 | |
| 
 | |
| 	/* Nicknames that are empty or the same as the device model are not interesting */
 | |
| 	if (nickname) {
 | |
| 		if (!*nickname || !strcmp(model, nickname))
 | |
| 			nickname = NULL;
 | |
| 	}
 | |
| 
 | |
| 	/* Serial numbers that are empty are not interesting */
 | |
| 	if (serial_nr && !*serial_nr)
 | |
| 		serial_nr = NULL;
 | |
| 
 | |
| 	/* Firmware strings that are empty are not interesting */
 | |
| 	if (firmware && !*firmware)
 | |
| 		firmware = NULL;
 | |
| 
 | |
| 	/* Do we have anything interesting about this dive computer to save? */
 | |
| 	if (!serial_nr && !nickname && !firmware)
 | |
| 		return;
 | |
| 
 | |
| 	put_format(b, "<divecomputerid");
 | |
| 	show_utf8(b, model, " model='", "'", 1);
 | |
| 	put_format(b, " deviceid='%08x'", deviceid);
 | |
| 	show_utf8(b, serial_nr, " serial='", "'", 1);
 | |
| 	show_utf8(b, firmware, " firmware='", "'", 1);
 | |
| 	show_utf8(b, nickname, " nickname='", "'", 1);
 | |
| 	put_format(b, "/>\n");
 | |
| }
 | |
| 
 | |
| int save_dives(const char *filename)
 | |
| {
 | |
| 	return save_dives_logic(filename, false);
 | |
| }
 | |
| 
 | |
| void save_dives_buffer(struct membuffer *b, const bool select_only)
 | |
| {
 | |
| 	int i;
 | |
| 	struct dive *dive;
 | |
| 	dive_trip_t *trip;
 | |
| 
 | |
| 	put_format(b, "<divelog program='subsurface' version='%d'>\n<settings>\n", DATAFORMAT_VERSION);
 | |
| 
 | |
| 	if (prefs.save_userid_local)
 | |
| 		put_format(b, "  <userid>%30s</userid>\n", prefs.userid);
 | |
| 
 | |
| 	/* save the dive computer nicknames, if any */
 | |
| 	call_for_each_dc(b, save_one_device, select_only);
 | |
| 	if (autogroup)
 | |
| 		put_format(b, "  <autogroup state='1' />\n");
 | |
| 	put_format(b, "</settings>\n");
 | |
| 
 | |
| 	/* save the dive sites - to make the output consistent let's sort the table, first */
 | |
| 	dive_site_table_sort();
 | |
| 	put_format(b, "<divesites>\n");
 | |
| 	for (i = 0; i < dive_site_table.nr; i++) {
 | |
| 		int j;
 | |
| 		struct dive *d;
 | |
| 		struct dive_site *ds = get_dive_site(i);
 | |
| 		if (dive_site_is_empty(ds) || !is_dive_site_used(ds->uuid, false)) {
 | |
| 			for_each_dive(j, d) {
 | |
| 				if (d->dive_site_uuid == ds->uuid)
 | |
| 					d->dive_site_uuid = 0;
 | |
| 			}
 | |
| 			delete_dive_site(ds->uuid);
 | |
| 			i--; // since we just deleted that one
 | |
| 			continue;
 | |
| 		} else if (ds->name &&
 | |
| 			   (strncmp(ds->name, "Auto-created dive", 17) == 0 ||
 | |
| 			    strncmp(ds->name, "New Dive", 8) == 0)) {
 | |
| 			// these are the two default names for sites from
 | |
| 			// the web service; if the site isn't used in any
 | |
| 			// dive (really? you didn't rename it?), delete it
 | |
| 			if (!is_dive_site_used(ds->uuid, false)) {
 | |
| 				if (verbose)
 | |
| 					fprintf(stderr, "Deleted unused auto-created dive site %s\n", ds->name);
 | |
| 				delete_dive_site(ds->uuid);
 | |
| 				i--; // since we just deleted that one
 | |
| 				continue;
 | |
| 			}
 | |
| 		}
 | |
| 		if (select_only && !is_dive_site_used(ds->uuid, true))
 | |
| 				continue;
 | |
| 
 | |
| 		put_format(b, "<site uuid='%8x'", ds->uuid);
 | |
| 		show_utf8(b, ds->name, " name='", "'", 1);
 | |
| 		if (ds->latitude.udeg || ds->longitude.udeg) {
 | |
| 			put_degrees(b, ds->latitude, " gps='", " ");
 | |
| 			put_degrees(b, ds->longitude, "", "'");
 | |
| 		}
 | |
| 		show_utf8(b, ds->description, " description='", "'", 1);
 | |
| 		put_format(b, ">\n");
 | |
| 		show_utf8(b, ds->notes, "  <notes>", " </notes>\n", 0);
 | |
| 		if (ds->taxonomy.nr) {
 | |
| 			for (int j = 0; j < ds->taxonomy.nr; j++) {
 | |
| 				struct taxonomy *t = &ds->taxonomy.category[j];
 | |
| 				if (t->category != TC_NONE && t->value) {
 | |
| 					put_format(b, "  <geo cat='%d'", t->category);
 | |
| 					put_format(b, " origin='%d'", t->origin);
 | |
| 					show_utf8(b, t->value, " value='", "'/>\n", 1);
 | |
| 				}
 | |
| 			}
 | |
| 		}
 | |
| 		put_format(b, "</site>\n");
 | |
| 	}
 | |
| 	put_format(b, "</divesites>\n<dives>\n");
 | |
| 	for (trip = dive_trip_list; trip != NULL; trip = trip->next)
 | |
| 		trip->index = 0;
 | |
| 
 | |
| 	/* save the dives */
 | |
| 	for_each_dive(i, dive) {
 | |
| 		if (select_only) {
 | |
| 
 | |
| 			if (!dive->selected)
 | |
| 				continue;
 | |
| 			save_one_dive_to_mb(b, dive);
 | |
| 
 | |
| 		} else {
 | |
| 			trip = dive->divetrip;
 | |
| 
 | |
| 			/* Bare dive without a trip? */
 | |
| 			if (!trip) {
 | |
| 				save_one_dive_to_mb(b, dive);
 | |
| 				continue;
 | |
| 			}
 | |
| 
 | |
| 			/* Have we already seen this trip (and thus saved this dive?) */
 | |
| 			if (trip->index)
 | |
| 				continue;
 | |
| 
 | |
| 			/* We haven't seen this trip before - save it and all dives */
 | |
| 			trip->index = 1;
 | |
| 			save_trip(b, trip);
 | |
| 		}
 | |
| 	}
 | |
| 	put_format(b, "</dives>\n</divelog>\n");
 | |
| }
 | |
| 
 | |
| static void save_backup(const char *name, const char *ext, const char *new_ext)
 | |
| {
 | |
| 	int len = strlen(name);
 | |
| 	int a = strlen(ext), b = strlen(new_ext);
 | |
| 	char *newname;
 | |
| 
 | |
| 	/* len up to and including the final '.' */
 | |
| 	len -= a;
 | |
| 	if (len <= 1)
 | |
| 		return;
 | |
| 	if (name[len - 1] != '.')
 | |
| 		return;
 | |
| 	/* msvc doesn't have strncasecmp, has _strnicmp instead - crazy */
 | |
| 	if (strncasecmp(name + len, ext, a))
 | |
| 		return;
 | |
| 
 | |
| 	newname = malloc(len + b + 1);
 | |
| 	if (!newname)
 | |
| 		return;
 | |
| 
 | |
| 	memcpy(newname, name, len);
 | |
| 	memcpy(newname + len, new_ext, b + 1);
 | |
| 
 | |
| 	/*
 | |
| 	 * Ignore errors. Maybe we can't create the backup file,
 | |
| 	 * maybe no old file existed.  Regardless, we'll write the
 | |
| 	 * new file.
 | |
| 	 */
 | |
| 	(void) subsurface_rename(name, newname);
 | |
| 	free(newname);
 | |
| }
 | |
| 
 | |
| static void try_to_backup(const char *filename)
 | |
| {
 | |
| 	char extension[][5] = { "xml", "ssrf", "" };
 | |
| 	int i = 0;
 | |
| 	int flen = strlen(filename);
 | |
| 
 | |
| 	/* Maybe we might want to make this configurable? */
 | |
| 	while (extension[i][0] != '\0') {
 | |
| 		int elen = strlen(extension[i]);
 | |
| 		if (strcasecmp(filename + flen - elen, extension[i]) == 0) {
 | |
| 			if (last_xml_version < DATAFORMAT_VERSION) {
 | |
| 				int se_len = strlen(extension[i]) + 5;
 | |
| 				char *special_ext = malloc(se_len);
 | |
| 				snprintf(special_ext, se_len, "%s.v%d", extension[i], last_xml_version);
 | |
| 				save_backup(filename, extension[i], special_ext);
 | |
| 				free(special_ext);
 | |
| 			} else {
 | |
| 				save_backup(filename, extension[i], "bak");
 | |
| 			}
 | |
| 			break;
 | |
| 		}
 | |
| 		i++;
 | |
| 	}
 | |
| }
 | |
| 
 | |
| int save_dives_logic(const char *filename, const bool select_only)
 | |
| {
 | |
| 	struct membuffer buf = { 0 };
 | |
| 	FILE *f;
 | |
| 	void *git;
 | |
| 	const char *branch, *remote;
 | |
| 	int error;
 | |
| 
 | |
| 	git = is_git_repository(filename, &branch, &remote, false);
 | |
| 	if (git)
 | |
| 		return git_save_dives(git, branch, remote, select_only);
 | |
| 
 | |
| 	save_dives_buffer(&buf, select_only);
 | |
| 
 | |
| 	if (same_string(filename, "-")) {
 | |
| 		f = stdout;
 | |
| 	} else {
 | |
| 		try_to_backup(filename);
 | |
| 		error = -1;
 | |
| 		f = subsurface_fopen(filename, "w");
 | |
| 	}
 | |
| 	if (f) {
 | |
| 		flush_buffer(&buf, f);
 | |
| 		error = fclose(f);
 | |
| 	}
 | |
| 	if (error)
 | |
| 		report_error("Save failed (%s)", strerror(errno));
 | |
| 
 | |
| 	free_buffer(&buf);
 | |
| 	return error;
 | |
| }
 | |
| 
 | |
| int export_dives_xslt(const char *filename, const bool selected, const int units, const char *export_xslt)
 | |
| {
 | |
| 	FILE *f;
 | |
| 	struct membuffer buf = { 0 };
 | |
| 	xmlDoc *doc;
 | |
| 	xsltStylesheetPtr xslt = NULL;
 | |
| 	xmlDoc *transformed;
 | |
| 	int res = 0;
 | |
| 	char *params[3];
 | |
| 	int pnr = 0;
 | |
| 	char unitstr[3];
 | |
| 
 | |
| 	if (verbose)
 | |
| 		fprintf(stderr, "export_dives_xslt with stylesheet %s\n", export_xslt);
 | |
| 
 | |
| 	if (!filename)
 | |
| 		return report_error("No filename for export");
 | |
| 
 | |
| 	/* Save XML to file and convert it into a memory buffer */
 | |
| 	save_dives_buffer(&buf, selected);
 | |
| 
 | |
| 	/*
 | |
| 	 * Parse the memory buffer into XML document and
 | |
| 	 * transform it to selected export format, finally dumping
 | |
| 	 * the XML into a character buffer.
 | |
| 	 */
 | |
| 	doc = xmlReadMemory(buf.buffer, buf.len, "divelog", NULL, 0);
 | |
| 	free_buffer(&buf);
 | |
| 	if (!doc)
 | |
| 		return report_error("Failed to read XML memory");
 | |
| 
 | |
| 	/* Convert to export format */
 | |
| 	xslt = get_stylesheet(export_xslt);
 | |
| 	if (!xslt)
 | |
| 		return report_error("Failed to open export conversion stylesheet");
 | |
| 
 | |
| 	snprintf(unitstr, 3, "%d", units);
 | |
| 	params[pnr++] = "units";
 | |
| 	params[pnr++] = unitstr;
 | |
| 	params[pnr++] = NULL;
 | |
| 
 | |
| 	transformed = xsltApplyStylesheet(xslt, doc, (const char **)params);
 | |
| 	xmlFreeDoc(doc);
 | |
| 
 | |
| 	/* Write the transformed export to file */
 | |
| 	f = subsurface_fopen(filename, "w");
 | |
| 	if (f) {
 | |
| 		xsltSaveResultToFile(f, transformed, xslt);
 | |
| 		fclose(f);
 | |
| 		/* Check write errors? */
 | |
| 	} else {
 | |
| 		res = report_error("Failed to open %s for writing (%s)", filename, strerror(errno));
 | |
| 	}
 | |
| 	xsltFreeStylesheet(xslt);
 | |
| 	xmlFreeDoc(transformed);
 | |
| 
 | |
| 	return res;
 | |
| }
 |