subsurface/smtk-import/smartrak.cpp

// SPDX-License-Identifier: GPL-2.0
/*
 * An .slg file is composed of a main table (Dives), a bunch of tables directly
 * linked to Dives by their indices (Site, Suit, Tank, etc) and another group of
 * independent tables (Activity, Type, Gear, Fish ...) which connect with the dives
 * via a related group of tables (ActivityRelation, TypeRelation ...) that contain
 * just the dive index number and the related table index number.
 * The data stored in the main group of tables are very extensive, going far beyond
 * the actual scope of Subsurface in most of cases; e.g. Dives table keeps
 * information which can be directly uploaded to DAN's database of dives, or Buddy
 * table can include telephones, photo or, even, buddy mother's maiden name.
 *
 * Although these funcs are suposed to work in a standalone tool, will also work
 * on main Subsurface import menu, by simply tweaking file.c and main_window.cpp
 * to call smartrak_import()
 */

/*
 * This is a workaround around a mdbtools bug.
 * mdbtools includes <glib.h> in an extern "C"
 * block. However, the latter includes C++ only
 * headers for C++ source files leading to a
 * torrent of compile errors. Include <glib.h>
 * first so that the include guards prevent it
 * from being included by mdbtools.
 */
#include <glib.h>

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <mdbtools.h>
#include <stdarg.h>
#include <locale.h>
#include <array>
#include <string_view>
#include <vector>

#if defined(WIN32) || defined(_WIN32)
#include <windows.h>
#endif

#include "core/dive.h"
#include "core/divelog.h"
#include "core/subsurface-string.h"
#include "core/gettext.h"
#include "core/divelist.h"
#include "core/event.h"
#include "core/libdivecomputer.h"
#include "core/divesite.h"
#include "core/errorhelper.h"
#include "core/format.h"
#include "core/tag.h"
#include "core/device.h"

/* SmartTrak version, constant for every single file */
int smtk_version;
int tanks;

/*
 * There are AFAIK three versions of Smarttrak DB format. The newer one supports trimix and up
 * to 10 tanks. The intermediate one just 3 tanks and no trimix but only nitrox. This is a
 * problem for an automated parser which has to support both formats.
 * In this solution I made an enum of fields with the same order they would have in
 * a smarttrak db, and a tiny function which returns the number of the column where
 * a field is expected to be, taking into account the different db formats.
 * The older version (version 10000), just one tank (nitrox) but it's critically different from
 * the newer version, not only in the Dives table format, but it has different tables. We won't
 * give support for this oldest DB format.
 */
enum field_pos {IDX = 0, DIVENUM, _DATE, INTIME, INTVAL, DURATION, OUTTIME, DESATBEFORE, DESATAFTER, NOFLYBEFORE,
		NOFLYAFTER, NOSTOPDECO, MAXDEPTH, VISIBILITY, WEIGHT, O2FRAC, HEFRAC, PSTART, PEND, AIRTEMP,
		MINWATERTEMP, MAXWATERTEMP, SECFACT, ALARMS, MODE, REMARKS, DCNUMBER, DCMODEL, DIVETIMECOUNT, LOG,
		PROFILE, SITEIDX, ALTIDX, SUITIDX, WEATHERIDX, SURFACEIDX, UNDERWATERIDX, TANKIDX};

/*
 * Returns calculated column number depending on smartrak version, as there are more
 * tanks (10) in later versions than in older (3).
 * Older versions also lacks of 3 columns storing he fraction, one for each tank.
 */
static int coln(enum field_pos pos_in)
{
	int pos = static_cast<int>(pos_in);
	int amnd = (smtk_version < 10213) ? 3 : 0;

	if (pos <= O2FRAC)
		return pos;
	if (pos >= AIRTEMP) {
		pos += 4 * (tanks - 1) - amnd;
		return pos;
	}
	switch (pos) {
	case HEFRAC:
		pos = O2FRAC + tanks;
		return pos;
	case PSTART:
		pos = O2FRAC + 2 * tanks - amnd;
		return pos;
	case PEND:
		pos = O2FRAC + 2 * tanks + 1 - amnd;
		return pos;
	default:
		report_error("smartrak: unknown field_pos (shouldn't happen)");
		return pos;
	}
}

/*
 * Fills the date part of a tm structure with the string data obtained
 * from smartrak in format "DD/MM/YY HH:MM:SS" where time is irrelevant.
 */
static void smtk_date_to_tm(char *d_buffer, struct tm *tm_date)
{
	int n, d, m, y;

	if ((d_buffer) && (!empty_string(d_buffer))) {
		n = sscanf(d_buffer, "%d/%d/%d ", &m, &d, &y);
		y = (y < 70) ? y + 100 : y;
		if (n == 3) {
			tm_date->tm_mday = d;
			tm_date->tm_mon = m - 1;
			tm_date->tm_year = y;
		} else {
			tm_date->tm_mday = tm_date->tm_mon = tm_date->tm_year = 0;
		}
	} else {
		tm_date->tm_mday = tm_date->tm_mon = tm_date->tm_year = 0;
	}
}

/*
 * Fills the time part of a tm structure with the string data obtained
 * from smartrak in format "DD/MM/YY HH:MM:SS" where date is irrelevant.
 */
static void smtk_time_to_tm(const char *t_buffer, struct tm *tm_date)
{
	int n, hr, min, sec;

	if ((t_buffer) && (!empty_string(t_buffer))) {
		n = sscanf(t_buffer, "%*[0-9/] %d:%d:%d ", &hr, &min, &sec);
		if (n == 3) {
			tm_date->tm_hour = hr;
			tm_date->tm_min = min;
			tm_date->tm_sec = sec;
		} else {
			tm_date->tm_hour = tm_date->tm_min = tm_date->tm_sec = 0;
		}
	} else {
		tm_date->tm_hour = tm_date->tm_min = tm_date->tm_sec = 0;
	}
	tm_date->tm_isdst = -1;
}

/*
 * Converts to seconds a time lapse returned from smartrak in string format
 * "DD/MM/YY HH:MM:SS" where date is irrelevant.
 * TODO: modify to support times > 24h where date means difference in days
 * from 29/12/99.
 */
static unsigned int smtk_time_to_secs(const char *t_buffer)
{
	int n, hr, min, sec;

	if (!empty_string(t_buffer)) {
		n = sscanf(t_buffer, "%*[0-9/] %d:%d:%d ", &hr, &min, &sec);
		return (n == 3) ? (((hr*60)+min)*60)+sec : 0;
	} else {
		return 0;
	}
}

/*
 * Emulate the non portable timegm() function.
 * Based on timegm man page, changing setenv and unsetenv with putenv,
 * because of portability issues.
 */
static time_t smtk_timegm(struct tm *tm)
{
	time_t ret;
	char *tz, *str;

	tz = getenv("TZ");
	putenv(strdup("TZ="));
	tzset();
	ret = mktime(tm);
	if (tz) {
		str = (char *)calloc(strlen(tz)+4, 1);
		sprintf(str, "TZ=%s", tz);
		putenv(str);
	} else {
		putenv(strdup("TZ"));
	}
	tzset();
	return ret;
}

class SmtkTable {
	struct Entry {
		std::array<char, MDB_BIND_SIZE> value;
		int len;
	};
	std::vector<Entry> data;
public:
	MdbTableDef *table;
	SmtkTable(MdbHandle *mdb, const char *name);
	~SmtkTable();
	size_t size() const {
		return data.size();
	}
	operator bool() const {
		return !!table;
	}
	int fetch_row() {
		return table ? mdb_fetch_row(table) : 0;
	}
	const char *get_data(size_t col) const {
		return data[col].value.data();
	}
	std::string_view get_string_view(size_t col) const {
		return std::string_view(get_data(col));
	}
	int get_len(size_t col) const {
		return data[col].len;
	}
};

/*
 * Returns an opened table given its name and mdb.
 */
SmtkTable::SmtkTable(MdbHandle *mdb, const char *tablename)
	: table(nullptr)
{
	MdbCatalogEntry *entry;

	entry = mdb_get_catalogentry_by_name(mdb, tablename);
	if (!entry)
		return;
	table = mdb_read_table(entry);
	if (!table)
		return;
	mdb_read_columns(table);
	data.resize(table->num_cols);
	for (size_t i = 0; i < table->num_cols; i++)
		mdb_bind_column(table, i+1, data[i].value.data(), &data[i].len);
	mdb_rewind_table(table);
}

SmtkTable::~SmtkTable()
{
	if (table)
		mdb_free_tabledef(table);
}

/*
 * Utility function which joins three strings, being the second a separator string,
 * usually a "\n". The third is a format string with an argument list.
 * If the original string is empty, then just returns the third.
 * The first argument is overwritten with the concatenated string.
 */
static void concat(std::string &orig, const char *sep, std::string_view s)
{
	if (!orig.empty())
		orig += sep;
	orig += s;
}

/*
 * Temporary funcion as long as core still has C-strings.
 * Equivalent to concat, but takes a C-string as first argument and
 * frees it. Returns a newly allocated copy.
 *
 * Note: taking "const char * const *" is an ugly hack to
 * allow passing pointer to "const char *" as well as
 * "char *". Which in turn is necessary, as this function currently
 * replaces "const char *" strings.
 */
static void concat(const char * const *orig_in, const char *sep, std::string_view s)
{
	char **orig = const_cast<char **>(orig_in);
	char *to_free = *orig;
	std::string orig_std(*orig ? *orig : "");
	concat(orig_std, sep, s);
	*orig = strdup(orig_std.c_str());
	free(to_free);
}

/*
 * A site may be a wreck, which has its own table.
 * Parse this table referred by the site idx. If found, put the different info items in
 * Subsurface's dive_site notes.
 * Wreck format:
 * | Idx | SiteIdx | Text | Built | Sank | SankTime | Reason | ... | Notes | TrakId |
 */
static void smtk_wreck_site(MdbHandle *mdb, char *site_idx, struct dive_site *ds)
{
	std::string notes;
	int i;
	uint32_t d;
	const char *wreck_fields[] = {QT_TRANSLATE_NOOP("gettextFromC", "Built"), QT_TRANSLATE_NOOP("gettextFromC", "Sank"), QT_TRANSLATE_NOOP("gettextFromC", "Sank Time"),
				      QT_TRANSLATE_NOOP("gettextFromC", "Reason"), QT_TRANSLATE_NOOP("gettextFromC", "Nationality"), QT_TRANSLATE_NOOP("gettextFromC", "Shipyard"),
				      QT_TRANSLATE_NOOP("gettextFromC", "ShipType"), QT_TRANSLATE_NOOP("gettextFromC", "Length"), QT_TRANSLATE_NOOP("gettextFromC", "Beam"),
				      QT_TRANSLATE_NOOP("gettextFromC", "Draught"), QT_TRANSLATE_NOOP("gettextFromC", "Displacement"), QT_TRANSLATE_NOOP("gettextFromC", "Cargo"),
				      QT_TRANSLATE_NOOP("gettextFromC", "Notes")};

	SmtkTable table(mdb, "Wreck");

	/* Sanity check for table, unlikely but ... */
	if (!table)
		return;

	/* Begin parsing. Write strings to notes only if available.*/
	while (table.fetch_row()) {
		if (!strcmp(table.get_data(1), site_idx)) {
			concat(notes, "\n", translate("gettextFromC", "Wreck Data"));
			for (i = 3; i < 16; i++) {
				switch (i) {
				case 3:
				case 4: {
					std::string_view tmp = table.get_string_view(i);
					if (!tmp.empty()) {
						tmp = tmp.substr(0, tmp.find(' '));
						concat(notes, "\n", format_string_std("%s: %s", wreck_fields[i - 3], std::string(tmp).c_str()));
					}
					break;
				}
				case 5: {
					std::string_view tmp = table.get_string_view(i);
					if (!tmp.empty()) {
						size_t pos = tmp.rfind(' ');
						tmp.remove_prefix(pos + 1);
						concat(notes, "\n", format_string_std("%s: %s", wreck_fields[i - 3], std::string(tmp).c_str()));
					}
					break;
				}
				case 6 ... 9:
				case 14:
				case 15: {
					const char *tmp = table.get_data(i);
					if (!empty_string(tmp))
						concat(notes, "\n", format_string_std("%s: %s", wreck_fields[i - 3], tmp));
					break;
				}
				default:
					d = lrintl(strtold(table.get_data(1), NULL));
					if (d)
						concat(notes, "\n", format_string_std("%s: %d", wreck_fields[i - 3], d));
					break;
				}
			}
			concat(ds->notes, "\n", notes);
			break;
		}
	}
}

/*
 * Smartrak locations db is quite extensive. This builds a string joining some of
 * the data in the style:   "Country, State, Locality, Site"  if this data are
 * available. Uses two tables, Site and Location. Puts Altitude, Depth and Notes
 * in Subsurface's dive site structure's notes if they are available.
 * Site format:
 * | Idx | Text | LocationIdx | WaterIdx | PlatformIdx | BottomIdx | Latitude | Longitude | Altitude | Depth | Notes | TrakId |
 * Location format:
 * | Idx | Text | Province | Country | Depth |
 */
static void smtk_build_location(MdbHandle *mdb, char *idx, struct dive_site **location, struct divelog *log)
{
	int i, rc;
	uint32_t d;
	struct dive_site *ds;
	location_t loc;
	std::string str, loc_idx, site, notes;
	const char *site_fields[] = {QT_TRANSLATE_NOOP("gettextFromC", "Altitude"), QT_TRANSLATE_NOOP("gettextFromC", "Depth"),
				     QT_TRANSLATE_NOOP("gettextFromC", "Notes")};

	/* Read data from Site table. Format notes for the dive site if any.*/
	{
		SmtkTable table(mdb, "Site");
		if (!table)
			return;
		do {
			rc = table.fetch_row();
		} while (strcasecmp(table.get_data(0), idx) && rc != 0);
		if (rc == 0)
			return;
		loc_idx = table.get_data(2);
		site = table.get_data(1);
		loc = create_location(strtod(table.get_data(6), NULL), strtod(table.get_data(7), NULL));

		for (i = 8; i < 11; i++) {
			switch (i) {
			case 8:
			case 9:
				d = lrintl(strtold(table.get_data(i), NULL));
				if (d)
					concat(notes, "\n", format_string_std("%s: %d m", site_fields[i - 8], d));
				break;
			case 10:
				if (!empty_string(table.get_data(i)))
					concat(notes, "\n", format_string_std("%s: %s", site_fields[i - 8], table.get_data(i)));
				break;
			}
		}
	}

	/* Read data from Location table, linked to Site by loc_idx */
	SmtkTable table(mdb, "Location");
	do {
		rc = table.fetch_row();
	} while (strcasecmp(table.get_data(0), loc_idx.c_str()) && rc != 0);
	if (rc == 0)
		return;

	/*
	 * Create a string for Subsurface's dive site structure with coordinates
	 * if available, if the site's name doesn't previously exists.
	 */
	if (!empty_string(table.get_data(3)))
		concat(str, ", ", table.get_string_view(3)); // Country
	if (!empty_string(table.get_data(2)))
		concat(str, ", ", table.get_string_view(2)); // State - Province
	if (!empty_string(table.get_data(1)))
		concat(str, ", ", table.get_string_view(1)); // Locality
	concat(str, ", ", site);

	ds = log->sites->get_by_name(str);
	if (!ds) {
		if (!has_location(&loc))
			ds = log->sites->create(str);
		else
			ds = log->sites->create(str, &loc);
	}
	*location = ds;

	/* Insert site notes */
	ds->notes = notes.c_str();

	/* Check if we have a wreck */
	smtk_wreck_site(mdb, idx, ds);
}

static void smtk_build_tank_info(MdbHandle *mdb, cylinder_t *tank, char *idx)
{
	int i;

	SmtkTable table(mdb, "Tank");
	if (!table)
		return;

	for (i = 1; i <= atoi(idx); i++)
		table.fetch_row();
	tank->type.description = copy_string(table.get_data(1));
	tank->type.size.mliter = lrint(strtod(table.get_data(2), NULL) * 1000);
	tank->type.workingpressure.mbar = lrint(strtod(table.get_data(4), NULL) * 1000);
}

/*
 * Under some circustances we can get the same tank from DC and from
 * the smartrak DB. Will use this utility to check and clean .
 */
static bool is_same_cylinder(cylinder_t *cyl_a, cylinder_t *cyl_b)
{
	// different gasmixes (non zero)
	if (cyl_a->gasmix.o2.permille - cyl_b->gasmix.o2.permille != 0 &&
	    cyl_a->gasmix.o2.permille != 0 &&
	    cyl_b->gasmix.o2.permille != 0)
		return false;
	// different start pressures (possible error 0.1 bar)
	if (!(abs(cyl_a->start.mbar - cyl_b->start.mbar) <= 100))
		return false;
	// different end pressures (possible error 0.1 bar)
	if (!(abs(cyl_a->end.mbar - cyl_b->end.mbar) <= 100))
		return false;
	// different names (none of them null)
	if (!same_string(cyl_a->type.description, "---") &&
	    !same_string(cyl_b->type.description, "---") &&
	    !same_string(cyl_a->type.description, cyl_b->type.description))
		return false;
	// Cylinders are most probably the same
	return true;
}

/*
 * Next three functions were removed from dive.c just when I was going to use them
 * for this import (see 16276faa). Will tweak them a bit and will use for our needs
 * Macros are copied from dive.c
 */

#define MERGE_MAX(res, a, b, n) res->n = std::max(a->n, b->n)
#define MERGE_MIN(res, a, b, n) res->n = (a->n) ? (b->n) ? std::min(a->n, b->n) : (a->n) : (b->n)

static void merge_cylinder_type(cylinder_type_t *src, cylinder_type_t *dst)
{
	if (!dst->size.mliter)
		dst->size.mliter = src->size.mliter;
	if (!dst->workingpressure.mbar)
		dst->workingpressure.mbar = src->workingpressure.mbar;
	if (!dst->description || same_string(dst->description, "---")) {
		dst->description = src->description;
		src->description = NULL;
	}
}

static void merge_cylinder_mix(struct gasmix src, struct gasmix *dst)
{
	if (!dst->o2.permille)
		*dst = src;
}

static void merge_cylinder_info(cylinder_t *src, cylinder_t *dst)
{
	merge_cylinder_type(&src->type, &dst->type);
	merge_cylinder_mix(src->gasmix, &dst->gasmix);
	MERGE_MAX(dst, dst, src, start.mbar);
	MERGE_MIN(dst, dst, src, end.mbar);
	if (!dst->cylinder_use)
		dst->cylinder_use = src->cylinder_use;
}

/*
 * Remove unused tanks and merge cylinders if there are signs that
 * they might be duplicated. Higher numbers are more prone to be unused,
 * so will make the clean reverse order.
 * When a used cylinder is found, check against previous one; if they are
 * both the same, merge and delete the higher number (as lower numbers are
 * most probably returned by libdivecomputer raw data parse.
 */
static void smtk_clean_cylinders(struct dive *d)
{
	int i = tanks - 1;
	cylinder_t  *cyl, *base = get_cylinder(d, 0);

	cyl = base + tanks - 1;
	while (cyl != base) {
		if (same_string(cyl->type.description, "---") && cyl->start.mbar == 0 && cyl->end.mbar == 0)
			remove_cylinder(d, i);
		else
			if (is_same_cylinder(cyl, cyl - 1)) {
				merge_cylinder_info(cyl, cyl - 1);
				remove_cylinder(d, i);
			}
		cyl--;
		i--;
	}
}

/*
 * List related functions
 */
struct types_list {
	int idx;
	char *text;
	struct types_list *next;
};

/*
 * Build a list from a given table_name (Type, Gear, etc)
 * Managed tables formats: Just consider Idx and Text
 * Type:
 * | Idx | Text | Default (bool)
 * Activity:
 * | Idx | Text | Default (bool)
 * Gear:
 * | Idx | Text | Vendor | Type | Typenum | Notes | Default (bool) | TrakId
 * Fish:
 * | Idx | Text | Name | Latin name | Typelength | Maxlength | Picture | Default (bool)| TrakId
 * TODO: Although all divelogs I've seen use *only* the Text field, a concerned diver could
 * be using some other like Vendor (in Gear) or Latin name (in Fish). I'll take a look at this
 * in the future, may be something like Buddy table...
 */
static std::vector<std::string> smtk_build_list(MdbHandle *mdb, const char *table_name)
{
	SmtkTable table(mdb, table_name);
	if (!table)
		return {};

	/* Read the table items into the array */
	std::vector<std::string> res;
	while (table.fetch_row()) {
		std::string str(table.get_data(1));
		if (str == "---" || str == "--")
	               str.clear();
		int pos = atoi(table.get_data(0)) - 1;
		if (pos < 0)
			continue;
		if (pos >= (int)res.size())
			res.resize(pos + 1);
		res[pos] = std::move(str);
	}
	return res;
}

/*
 * Parses a relation table and returns a list with the relations for a dive idx.
 * Use types_list items with text set to NULL.
 * Returns a pointer to the list head.
 * Table relation format:
 * | Diveidx | Idx |
 */
static std::vector<int> smtk_index_list(MdbHandle *mdb, const char *table_name, char *dive_idx)
{
	SmtkTable table(mdb, table_name);

	/* Sanity check */
	if (!table)
		return {};

	/* Parse the table searching for dive_idx */
	std::vector<int> res;
	while (table.fetch_row()) {
		if (!strcmp(dive_idx, table.get_data(0)))
			res.push_back(atoi(table.get_data(1)));
	}

	return res;
}

/*
 * "Buddy" is a bit special table that needs some extra work, so we can't just use smtk_build_list.
 * "Buddy" table is a buddies relation with lots and lots and lots of data (even buddy mother's
 * maiden name ;-) ) most of them useless for a dive log. Let's just consider the nickname as main
 * field and the full name if this exists and its construction is different from the nickname.
 * Buddy table format:
 * | Idx | Text (nickname) | Name | Firstname | Middlename | Title | Picture | Phone | ...
 */
static std::vector<std::string> smtk_build_buddies(MdbHandle *mdb)
{
	SmtkTable table(mdb, "Buddy");
	if (!table)
		return {};

	std::vector<std::string> res;
	while (table.fetch_row()) {
		std::string fullname;
		if (!empty_string(table.get_data(3)))
			concat(fullname, " ", table.get_string_view(3));
		if (!empty_string(table.get_data(4)))
			concat(fullname, " ", table.get_string_view(4));
		if (!empty_string(table.get_data(2)))
			concat(fullname, " ", table.get_string_view(2));
		std::string str = !fullname.empty() && fullname != table.get_data(1) ?
			format_string_std("%s (%s)", table.get_data(1), fullname.c_str()) :
			std::string(table.get_string_view(1));
		int pos = atoi(table.get_data(0)) - 1;
		if (pos < 0)
			continue;
		if (static_cast<size_t>(pos) >= res.size())
			res.resize(pos + 1);
		res[pos] = std::move(str);
	}
	return res;
}

/*
 * Helper function that gets an element of a vector or a default constructed value
 * if out-of-bounds.
 */
template <typename T>
T get(const std::vector<T> &v, int idx)
{
	return idx >= 0 && static_cast<size_t>(idx) < v.size() ? v[idx] : T();
}

/*
 * Returns string with buddies names as registered in smartrak (may be a nickname).
 */
static std::string smtk_locate_buddy(MdbHandle *mdb, char *dive_idx, const std::vector<std::string> &buddies_list)
{
	std::string str;

	std::vector<int> rel_list = smtk_index_list(mdb, "BuddyRelation", dive_idx);
	for (int idx: rel_list)
		concat(str, ", ", std::string(get(buddies_list, idx - 1)));

	return str;
}

/* Parses the dive_type mdb tables and import the data into dive's
 * taglist structure or notes.  If there are tags that affects dive's dive_mode
 * (SCR, CCR or so), set the dive mode too.
 * The "tag" parameter is used to mark if we want this table to be imported
 * into tags or into notes.
 */
static void smtk_parse_relations(MdbHandle *mdb, struct dive *dive, char *dive_idx, const char *table_name, const char *rel_table_name, const std::vector<std::string> &list, bool tag)
{
	std::string tmp;

	/* Get the text associated with the relations */
	std::vector<int> diverel_list = smtk_index_list(mdb, rel_table_name, dive_idx);
	for (int idx: diverel_list) {
		const std::string str = get(list, idx - 1);
		if (str.empty())
			continue;
		if (tag)
			taglist_add_tag(&dive->tag_list, str.c_str());
		else
			concat(tmp, ", ", str);
		if (str.find("SCR") != std::string::npos)
			dive->dc.divemode = PSCR;
		else if (str.find("CCR") != std::string::npos)
			dive->dc.divemode = CCR;
	}
	if (!tmp.empty())
		concat(&dive->notes, "\n", format_string_std("Smartrak %s: %s", table_name, tmp.c_str()));
}

/*
 * Add data from tables related in Dives table which are not directly supported
 * in Subsurface. Write them as tags or dive notes by setting true or false the
 * boolean parameter "tag".
 */
static void smtk_parse_other(struct dive *dive, const std::vector<std::string> &list, const char *data_name, char *idx, bool tag)
{
       int i = atoi(idx) - 1;
       if (i < 0 || i >= (int)list.size())
	       return;

       const std::string &str = list[i];
       if (!str.empty()) {
               if (tag)
                       taglist_add_tag(&dive->tag_list, str.c_str());
               else
                       concat(&dive->notes, "\n", format_string_std("Smartrak %s: %s", data_name, str.c_str()));
       }
}

/*
 * Returns a pointer to a bookmark event in an event list if it exists for
 * a given time. Return NULL otherwise.
 */
static struct event *find_bookmark(struct event *orig, int t)
{
	struct event *ev = orig;

	while (ev) {
		if ((ev->time.seconds == t) && (ev->type == SAMPLE_EVENT_BOOKMARK))
			return ev;
		ev = ev->next;
	}
	return NULL;
}

/*
 * Marker table is a mix between Type tables and Relations tables. Its format is
 * | Dive Idx | Idx | Text | Type | XPos | YPos | XConnect | YConnect
 * Type may be one of 1 = Text; 2 = DC; 3 = Tissue Data; 4 = Photo (0 most of time??)
 * XPos is time in minutes during the dive (long int)
 * YPos irelevant
 * XConnect irelevant
 * YConnect irelevant
 */
static void smtk_parse_bookmarks(MdbHandle *mdb, struct dive *d, char *dive_idx)
{
	int time;
	struct event *ev;

	SmtkTable table(mdb, "Marker");
	if (!table) {
		report_error("[smtk-import] Error - Couldn't open table 'Marker', dive %d", d->number);
		return;
	}
	while (table.fetch_row()) {
		if (same_string(table.get_data(0), dive_idx)) {
			time = lrint(strtod(table.get_data(4), NULL) * 60);
			const char *tmp = table.get_data(2);
			ev = find_bookmark(d->dc.events, time);
			if (ev)
				update_event_name(d, 0, ev, tmp);
			else
				if (!add_event(&d->dc, time, SAMPLE_EVENT_BOOKMARK, 0, 0, tmp))
					report_error("[smtk-import] Error - Couldn't add bookmark, dive %d, Name = %s",
						     d->number, tmp);
		}
	}
}

/*
 * Returns a dc_descriptor_t structure based on dc  model's number.
 * This ensures the model pased to libdc_buffer_parser() is a supported model and avoids
 * problems with shared model num devices by taking the family into account.  The family
 * is estimated elsewhere based in dive header length.
 */
static dc_descriptor_t *get_data_descriptor(int data_model, dc_family_t data_fam)
{
	dc_descriptor_t *descriptor = NULL, *current = NULL;
	dc_iterator_t *iterator = NULL;
	dc_status_t rc;

	rc = dc_descriptor_iterator(&iterator);
	if (rc != DC_STATUS_SUCCESS) {
		report_error("[Error][libdc]\t\t\tCreating the device descriptor iterator.\n");
		return current;
	}
	while ((dc_iterator_next(iterator, &descriptor)) == DC_STATUS_SUCCESS) {
		int desc_model = dc_descriptor_get_model(descriptor);
		dc_family_t desc_fam = dc_descriptor_get_type(descriptor);

		if (data_fam == DC_FAMILY_UWATEC_ALADIN) {
			if (data_model == desc_model && data_fam == desc_fam) {
				current = descriptor;
				break;
			}
		} else if (data_model == desc_model && (desc_fam == DC_FAMILY_UWATEC_SMART ||
							desc_fam == DC_FAMILY_UWATEC_MERIDIAN)) {
			current = descriptor;
			break;
		}
		dc_descriptor_free(descriptor);
	}
	dc_iterator_free(iterator);
	return current;
}

/*
 * Fills a device_data_t structure with known dc data.
 * Completes a dc_descriptor_t structure with libdc's g_descriptors[] table so
 * we ensure that data passed for parsing to libdc have a supported and known
 * DC.  dc_family_t is certainly known *only* if it is Aladin/Memomouse family
 * otherwise it will be known after get_data_descriptor call.
 */
static dc_status_t prepare_data(int data_model, const char *serial, dc_family_t dc_fam, device_data_t &dev_data)
{
	dev_data.device = NULL;
	dev_data.context = NULL;
	if (!data_model) {
		dev_data.model = manual_dc_name;
		dev_data.descriptor = NULL;
		return DC_STATUS_NODEVICE;
	}
	dev_data.descriptor = get_data_descriptor(data_model, dc_fam);
	if (dev_data.descriptor) {
		dev_data.vendor = dc_descriptor_get_vendor(dev_data.descriptor);
		dev_data.product = dc_descriptor_get_product(dev_data.descriptor);
		dev_data.model += dev_data.vendor + " " + dev_data.product;
		dev_data.devinfo.serial = (uint32_t) lrint(strtod(serial, NULL));
		return DC_STATUS_SUCCESS;
	} else {
		dev_data.model = "unsupported dive computer";
		dev_data.devinfo.serial = (uint32_t) lrint(strtod(serial, NULL));
		return DC_STATUS_UNSUPPORTED;
	}
}

/*
 * Returns a buffer prepared for libdc parsing.
 * Aladin and memomouse dives were imported from datatrak, so they lack of a
 * header. Creates a fake header for them and inserts the dc model where libdc
 * expects it to be.
 */
static dc_status_t libdc_buffer_complete(device_data_t *dev_data, unsigned char *hdr_buffer, int hdr_length,
				     unsigned char *prf_buffer, int prf_length, unsigned char *compl_buf)
{
	switch (dc_descriptor_get_type(dev_data->descriptor)) {
	case DC_FAMILY_UWATEC_ALADIN:
	case DC_FAMILY_UWATEC_MEMOMOUSE:
		compl_buf[3] = (unsigned char) dc_descriptor_get_model(dev_data->descriptor);
		memcpy(compl_buf+hdr_length, prf_buffer, prf_length);
		break;
	case DC_FAMILY_UWATEC_SMART:
	case DC_FAMILY_UWATEC_MERIDIAN:
		memcpy(compl_buf, hdr_buffer, hdr_length);
		memcpy(compl_buf+hdr_length, prf_buffer, prf_length);
		break;
	default:
		return DC_STATUS_UNSUPPORTED;
	}
	return DC_STATUS_SUCCESS;
}

/*
 * Main function.
 * Two looping levels using a database for the first level ("Dives" table)
 * and a clone of the first DB for the second level (each dive items). Using
 * a DB clone is necessary as calling mdb_fetch_row() over different tables in
 * a single DB breaks binded row data, and so would break the top loop.
 */
void smartrak_import(const char *file, struct divelog *log)
{
	MdbHandle *mdb, *mdb_clon;
	MdbColumn *col[MDB_MAX_COLS];
	int i, dc_model;

	// Set an european style locale to work date/time conversion
	setlocale(LC_TIME, "POSIX");
	mdb = mdb_open(file, MDB_NOFLAGS);
	if (!mdb) {
		report_error("[Error][smartrak_import]\tFile %s does not seem to be an Access database.", file);
		return;
	}
	if (!mdb_read_catalog(mdb, MDB_TABLE)) {
		report_error("[Error][smartrak_import]\tFile %s does not seem to be an Access database.", file);
		return;
	}
	mdb_clon = mdb_clone_handle(mdb);
	mdb_read_catalog(mdb_clon, MDB_TABLE);

	/* Load auxiliary tables */
	std::vector<std::string> type_list = smtk_build_list(mdb_clon, "Type");
	std::vector<std::string> activity_list = smtk_build_list(mdb_clon, "Activity");
	std::vector<std::string> gear_list = smtk_build_list(mdb_clon, "Gear");
	std::vector<std::string> fish_list = smtk_build_list(mdb_clon, "Fish");
	std::vector<std::string> smtk_ver = smtk_build_list(mdb_clon, "SmartTrak");
	std::vector<std::string> suit_list = smtk_build_list(mdb_clon, "Suit");
	std::vector<std::string> weather_list = smtk_build_list(mdb_clon, "Weather");
	std::vector<std::string> underwater_list = smtk_build_list(mdb_clon, "Underwater");
	std::vector<std::string> surface_list = smtk_build_list(mdb_clon, "Surface");
	std::vector<std::string> buddy_list = smtk_build_buddies(mdb_clon);

	/* Check Smarttrak version (different number of supported tanks, mixes and so).
	 * File format 10000 is quite different from other formats, just drop it and give
	 * a tip to the user.
	 */
	smtk_version = atoi(get(smtk_ver, 0).c_str());
	if (smtk_version == 10000) {
		report_error("[Error]\t File %s is SmartTrak file format %d which is not supported. Please load the file in a newer SmartTrak software version and upgrade it.", file, smtk_version);
		return;
	}
	tanks = (smtk_version < 10213) ? 3 : 10;

	SmtkTable mdb_table(mdb, "Dives");
	if (!mdb_table) {
		report_error("[Error][smartrak_import]\tFile %s does not seem to be an SmartTrak file.", file);
		return;
	}
	while (mdb_table.fetch_row()) {
		device_data_t devdata;
		dc_family_t dc_fam = DC_FAMILY_NULL;
		unsigned char *prf_buffer, *hdr_buffer;
		struct dive *smtkdive = alloc_dive();
		struct tm tm_date;
		size_t hdr_length, prf_length;
		dc_status_t rc = DC_STATUS_SUCCESS;

		for (size_t j = 0; j < mdb_table.table->num_cols; j++)
			col[j] = static_cast<MdbColumn *>(g_ptr_array_index(mdb_table.table->columns, j));
		smtkdive->number = lrint(strtod(mdb_table.get_data(1), NULL));
		/*
		 * If there is a DC model (no zero) try to create a buffer for the
		 * dive and parse it with libdivecomputer
		 */
		dc_model = lrint(strtod(mdb_table.get_data(coln(DCMODEL)), NULL)) & 0xFF;
		if (mdb_table.get_len(coln(LOG))) {
			hdr_buffer = static_cast<unsigned char *>(mdb_ole_read_full(mdb, col[coln(LOG)], &hdr_length));
			if (hdr_length > 0 && hdr_length < 20)	// We have a profile but it's imported from datatrak
				dc_fam = DC_FAMILY_UWATEC_ALADIN;
		}
		rc = prepare_data(dc_model, (char *)col[coln(DCNUMBER)]->bind_ptr, dc_fam, devdata);
		smtkdive->dc.model = copy_string(devdata.model.c_str());
		if (rc == DC_STATUS_SUCCESS && mdb_table.get_len(coln(PROFILE))) {
			prf_buffer = static_cast<unsigned char *>(mdb_ole_read_full(mdb, col[coln(PROFILE)], &prf_length));
			if (prf_length > 0) {
				if (dc_descriptor_get_type(devdata.descriptor) == DC_FAMILY_UWATEC_ALADIN || dc_descriptor_get_type(devdata.descriptor) == DC_FAMILY_UWATEC_MEMOMOUSE)
					hdr_length = 18;
				std::vector<unsigned char> compl_buffer(hdr_length+prf_length);
				rc = libdc_buffer_complete(&devdata, hdr_buffer, hdr_length, prf_buffer, prf_length, compl_buffer.data());
				if (rc != DC_STATUS_SUCCESS) {
					report_error("[Error][smartrak_import]\t- %s - for dive %d", errmsg(rc), smtkdive->number);
				} else {
					rc = libdc_buffer_parser(smtkdive, &devdata, compl_buffer.data(), hdr_length + prf_length);
					if (rc != DC_STATUS_SUCCESS)
						report_error("[Error][libdc]\t\t- %s - for dive %d", errmsg(rc), smtkdive->number);
				}
			} else {
				/* Dives without profile samples (usual in older aladin series) */
				report_error("[Warning][smartrak_import]\t No profile for dive %d", smtkdive->number);
				smtkdive->dc.duration.seconds = smtkdive->duration.seconds = smtk_time_to_secs((char *)col[coln(DURATION)]->bind_ptr);
				smtkdive->dc.maxdepth.mm = smtkdive->maxdepth.mm = lrint(strtod((char *)col[coln(MAXDEPTH)]->bind_ptr, NULL) * 1000);
			}
			free(hdr_buffer);
			free(prf_buffer);
		} else {
			/* Manual dives or unknown DCs */
			report_error("[Warning][smartrak_import]\t Manual or unknown dive computer for dive %d", smtkdive->number);
			smtkdive->dc.duration.seconds = smtkdive->duration.seconds = smtk_time_to_secs((char *)col[coln(DURATION)]->bind_ptr);
			smtkdive->dc.maxdepth.mm = smtkdive->maxdepth.mm = lrint(strtod((char *)col[coln(MAXDEPTH)]->bind_ptr, NULL) * 1000);
		}
		/*
		 * Cylinder and gasmixes completion.
		 * Revisit data under some circunstances, e.g. a start pressure = 0 may mean
		 * that dc doesn't support gas control, in this situation let's look into mdb data
		 */
		int pstartcol = coln(PSTART);
		int o2fraccol = coln(O2FRAC);
		int hefraccol = coln(HEFRAC);
		int tankidxcol = coln(TANKIDX);

		for (i = 0; i < tanks; i++) {
			cylinder_t *tmptank = get_or_create_cylinder(smtkdive, i);
			if (!tmptank)
				break;
			if (tmptank->start.mbar == 0)
				tmptank->start.mbar = lrint(strtod((char *)col[(i * 2) + pstartcol]->bind_ptr, NULL) * 1000);
			/*
			 * If there is a start pressure ensure that end pressure is not zero as
			 * will be registered in DCs which only keep track of differential pressures,
			 * and collect the data registered  by the user in mdb
			 */
			if (tmptank->end.mbar == 0 && tmptank->start.mbar != 0)
				tmptank->end.mbar = lrint(strtod((char *)col[(i * 2) + 1 + pstartcol]->bind_ptr, NULL) * 1000 ? : 1000);
			if (tmptank->gasmix.o2.permille == 0)
				tmptank->gasmix.o2.permille = lrint(strtod((char *)col[i + o2fraccol]->bind_ptr, NULL) * 10);
			if (smtk_version == 10213) {
				if (tmptank->gasmix.he.permille == 0)
					tmptank->gasmix.he.permille = lrint(strtod((char *)col[i + hefraccol]->bind_ptr, NULL) * 10);
			} else {
				tmptank->gasmix.he.permille = 0;
			}
			smtk_build_tank_info(mdb_clon, tmptank, (char *)col[i + tankidxcol]->bind_ptr);
		}
		/* Check for duplicated cylinders and clean them */
		smtk_clean_cylinders(smtkdive);

		/* Date issues with libdc parser - Take date time from mdb */
		smtk_date_to_tm((char *)col[coln(_DATE)]->bind_ptr, &tm_date);
		smtk_time_to_tm((char *)col[coln(INTIME)]->bind_ptr, &tm_date);
		smtkdive->dc.when = smtkdive->when = smtk_timegm(&tm_date);
		smtkdive->dc.surfacetime.seconds = smtk_time_to_secs((char *)col[coln(INTVAL)]->bind_ptr);

		/* Data that user may have registered manually if not supported by DC, or not parsed */
		if (!smtkdive->airtemp.mkelvin)
			smtkdive->airtemp.mkelvin = C_to_mkelvin(lrint(strtod((char *)col[coln(AIRTEMP)]->bind_ptr, NULL)));
		if (!smtkdive->watertemp.mkelvin)
			smtkdive->watertemp.mkelvin = smtkdive->mintemp.mkelvin = C_to_mkelvin(lrint(strtod((char *)col[coln(MINWATERTEMP)]->bind_ptr, NULL)));
		if (!smtkdive->maxtemp.mkelvin)
			smtkdive->maxtemp.mkelvin = C_to_mkelvin(lrint(strtod((char *)col[coln(MAXWATERTEMP)]->bind_ptr, NULL)));

		/* No DC related data */
		smtkdive->visibility = strtod((char *)col[coln(VISIBILITY)]->bind_ptr, NULL) > 25 ? 5 : lrint(strtod((char *)col[13]->bind_ptr, NULL) / 5);
		weightsystem_t ws = { {(int)lrint(strtod((char *)col[coln(WEIGHT)]->bind_ptr, NULL) * 1000)}, "", false };
		add_cloned_weightsystem(&smtkdive->weightsystems, ws);
		smtkdive->suit = strdup(get(suit_list, atoi((char *)col[coln(SUITIDX)]->bind_ptr) - 1).c_str());
		smtk_build_location(mdb_clon, (char *)col[coln(SITEIDX)]->bind_ptr, &smtkdive->dive_site, log);
		smtkdive->buddy = strdup(smtk_locate_buddy(mdb_clon, (char *)col[0]->bind_ptr, buddy_list).c_str());
		smtk_parse_relations(mdb_clon, smtkdive, (char *)col[0]->bind_ptr, "Type", "TypeRelation", type_list, true);
		smtk_parse_relations(mdb_clon, smtkdive, (char *)col[0]->bind_ptr, "Activity", "ActivityRelation", activity_list, false);
		smtk_parse_relations(mdb_clon, smtkdive, (char *)col[0]->bind_ptr, "Gear", "GearRelation", gear_list, false);
		smtk_parse_relations(mdb_clon, smtkdive, (char *)col[0]->bind_ptr, "Fish", "FishRelation", fish_list, false);
		smtk_parse_other(smtkdive, weather_list, "Weather", (char *)col[coln(WEATHERIDX)]->bind_ptr, false);
		smtk_parse_other(smtkdive, underwater_list, "Underwater", (char *)col[coln(UNDERWATERIDX)]->bind_ptr, false);
		smtk_parse_other(smtkdive, surface_list, "Surface", (char *)col[coln(SURFACEIDX)]->bind_ptr, false);
		smtk_parse_bookmarks(mdb_clon, smtkdive, (char *)col[0]->bind_ptr);
		concat(&smtkdive->notes, "\n", std::string((char *)col[coln(REMARKS)]->bind_ptr));

		record_dive_to_table(smtkdive, log->dives);
	}
	mdb_free_catalog(mdb_clon);
	mdb->catalog = NULL;
	mdb_close(mdb_clon);
	mdb_close(mdb);
	sort_dive_table(log->dives);
}