[libsigrok.git] / src / output / srzip.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 *
 * 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 <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <zip.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/srzip"

struct out_context {
	gboolean zip_created;
	uint64_t samplerate;
	char *filename;
};

static int init(struct sr_output *o, GHashTable *options)
{
	struct out_context *outc;

	outc = g_malloc0(sizeof(struct out_context));
	o->priv = outc;
	outc->filename = g_strdup(g_variant_get_string(g_hash_table_lookup(options, "filename"), NULL));
	if (strlen(outc->filename) == 0)
		return SR_ERR_ARG;

	return SR_OK;
}

static int zip_create(const struct sr_output *o)
{
	struct out_context *outc;
	struct sr_channel *ch;
	FILE *meta;
	struct zip *zipfile;
	struct zip_source *versrc, *metasrc;
	GVariant *gvar;
	GSList *l;
	int tmpfile, ret;
	char version[1], metafile[32], *s;

	outc = o->priv;
	if (outc->samplerate == 0) {
		if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
				&gvar) == SR_OK) {
			outc->samplerate = g_variant_get_uint64(gvar);
			g_variant_unref(gvar);
		}
	}

	/* Quietly delete it first, libzip wants replace ops otherwise. */
	unlink(outc->filename);
	if (!(zipfile = zip_open(outc->filename, ZIP_CREATE, &ret)))
		return SR_ERR;

	/* "version" */
	version[0] = '2';
	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
		return SR_ERR;
	if (zip_add(zipfile, "version", versrc) == -1) {
		sr_info("Error saving version into zipfile: %s.",
			zip_strerror(zipfile));
		return SR_ERR;
	}

	/* init "metadata" */
	strcpy(metafile, "sigrok-meta-XXXXXX");
	if ((tmpfile = g_mkstemp(metafile)) == -1)
		return SR_ERR;
	close(tmpfile);
	meta = g_fopen(metafile, "wb");
	fprintf(meta, "[global]\n");
	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
	fprintf(meta, "[device 1]\ncapturefile = logic-1\n");
	fprintf(meta, "total probes = %d\n", g_slist_length(o->sdi->channels));
	s = sr_samplerate_string(outc->samplerate);
	fprintf(meta, "samplerate = %s\n", s);
	g_free(s);

	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		fprintf(meta, "probe%d = %s\n", ch->index + 1, ch->name);
	}
	fclose(meta);

	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
		unlink(metafile);
		return SR_ERR;
	}
	if (zip_add(zipfile, "metadata", metasrc) == -1) {
		unlink(metafile);
		return SR_ERR;
	}

	if ((ret = zip_close(zipfile)) == -1) {
		sr_info("Error saving zipfile: %s.", zip_strerror(zipfile));
		unlink(metafile);
		return SR_ERR;
	}

	unlink(metafile);

	return SR_OK;
}

static int zip_append(const struct sr_output *o, unsigned char *buf,
		int unitsize, int length)
{
	struct out_context *outc;
	struct zip *archive;
	struct zip_source *logicsrc;
	zip_int64_t num_files;
	struct zip_file *zf;
	struct zip_stat zs;
	struct zip_source *metasrc;
	GKeyFile *kf;
	GError *error;
	gsize len;
	int chunk_num, next_chunk_num, tmpfile, ret, i;
	const char *entry_name;
	char *metafile, tmpname[32], chunkname[16];

	outc = o->priv;
	if (!(archive = zip_open(outc->filename, 0, &ret)))
		return SR_ERR;

	if (zip_stat(archive, "metadata", 0, &zs) == -1)
		return SR_ERR;

	metafile = g_malloc(zs.size);
	zf = zip_fopen_index(archive, zs.index, 0);
	zip_fread(zf, metafile, zs.size);
	zip_fclose(zf);

	/*
	 * If the file was only initialized but doesn't yet have any
	 * data it in, it won't have a unitsize field in metadata yet.
	 */
	error = NULL;
	kf = g_key_file_new();
	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
		sr_err("Failed to parse metadata: %s.", error->message);
		return SR_ERR;
	}
	g_free(metafile);
	tmpname[0] = '\0';
	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
		if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
			sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
			return SR_ERR;
		}
		/* Add unitsize field. */
		g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
		metafile = g_key_file_to_data(kf, &len, &error);
		strcpy(tmpname, "sigrok-meta-XXXXXX");
		if ((tmpfile = g_mkstemp(tmpname)) == -1)
			return SR_ERR;
		if (write(tmpfile, metafile, len) < 0) {
			sr_dbg("Failed to create new metadata: %s", strerror(errno));
			g_free(metafile);
			unlink(tmpname);
			return SR_ERR;
		}
		close(tmpfile);
		if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
			sr_err("Failed to create zip source for metadata.");
			g_free(metafile);
			unlink(tmpname);
			return SR_ERR;
		}
		if (zip_replace(archive, zs.index, metasrc) == -1) {
			sr_err("Failed to replace metadata file.");
			g_free(metafile);
			unlink(tmpname);
			return SR_ERR;
		}
		g_free(metafile);
	}
	g_key_file_free(kf);

	next_chunk_num = 1;
	num_files = zip_get_num_entries(archive, 0);
	for (i = 0; i < num_files; i++) {
		entry_name = zip_get_name(archive, i, 0);
		if (strncmp(entry_name, "logic-1", 7))
			continue;
		if (strlen(entry_name) == 7) {
			/* This file has no extra chunks, just a single "logic-1".
			 * Rename it to "logic-1-1" * and continue with chunk 2. */
			if (zip_rename(archive, i, "logic-1-1") == -1) {
				sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
				unlink(tmpname);
				return SR_ERR;
			}
			next_chunk_num = 2;
			break;
		} else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
			chunk_num = strtoull(entry_name + 8, NULL, 10);
			if (chunk_num >= next_chunk_num)
				next_chunk_num = chunk_num + 1;
		}
	}
	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
	if (!(logicsrc = zip_source_buffer(archive, buf, length, FALSE))) {
		unlink(tmpname);
		return SR_ERR;
	}
	if (zip_add(archive, chunkname, logicsrc) == -1) {
		unlink(tmpname);
		return SR_ERR;
	}
	if ((ret = zip_close(archive)) == -1) {
		sr_info("error saving session file: %s", zip_strerror(archive));
		unlink(tmpname);
		return SR_ERR;
	}
	unlink(tmpname);

	return SR_OK;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	struct out_context *outc;
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_logic *logic;
	const struct sr_config *src;
	GSList *l;

	int ret;

	*out = NULL;
	if (!o || !o->sdi || !(outc = o->priv))
		return SR_ERR_ARG;

	switch (packet->type) {
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (src->key != SR_CONF_SAMPLERATE)
				continue;
			outc->samplerate = g_variant_get_uint64(src->data);
		}
		break;
	case SR_DF_LOGIC:
		if (!outc->zip_created) {
			if ((ret = zip_create(o)) != SR_OK)
				return ret;
			outc->zip_created = TRUE;
		}
		logic = packet->payload;
		ret = zip_append(o, logic->data, logic->unitsize, logic->length);
		break;
	}

	return SR_OK;
}

static int cleanup(struct sr_output *o)
{
	struct out_context *outc;

	outc = o->priv;
	g_free(outc->filename);
	g_free(outc);
	o->priv = NULL;

	return SR_OK;
}

static struct sr_option options[] = {
	{ "filename", "Filename", "File to write", NULL, NULL },
	ALL_ZERO
};

static const struct sr_option *get_options(void)
{
	if (!options[0].def)
		options[0].def = g_variant_ref_sink(g_variant_new_string(""));

	return options;
}

SR_PRIV struct sr_output_module output_srzip = {
	.id = "srzip",
	.name = "srzip",
	.desc = "srzip session file",
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
Commit	Line	Data
3250d8c7 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <stdlib.h>
	21	#include <unistd.h>
	22	#include <string.h>
	23	#include <errno.h>
	24	#include <glib.h>
	25	#include <glib/gstdio.h>
	26	#include <zip.h>
	27	#include "libsigrok.h"
	28	#include "libsigrok-internal.h"
	29
	30	#define LOG_PREFIX "output/srzip"
	31
	32	struct out_context {
	33	gboolean zip_created;
	34	uint64_t samplerate;
	35	char *filename;
	36	};
	37
	38	static int init(struct sr_output o, GHashTable options)
	39	{
	40	struct out_context *outc;
	41
	42	outc = g_malloc0(sizeof(struct out_context));
	43	o->priv = outc;
	44	outc->filename = g_strdup(g_variant_get_string(g_hash_table_lookup(options, "filename"), NULL));
	45	if (strlen(outc->filename) == 0)
	46	return SR_ERR_ARG;
	47
	48	return SR_OK;
	49	}
	50
	51	static int zip_create(const struct sr_output *o)
	52	{
	53	struct out_context *outc;
	54	struct sr_channel *ch;
	55	FILE *meta;
	56	struct zip *zipfile;
	57	struct zip_source versrc, metasrc;
	58	GVariant *gvar;
	59	GSList *l;
	60	int tmpfile, ret;
	61	char version[1], metafile[32], *s;
	62
	63	outc = o->priv;
	64	if (outc->samplerate == 0) {
65	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
66	&gvar) == SR_OK) {
67	outc->samplerate = g_variant_get_uint64(gvar);
68	g_variant_unref(gvar);
69	}
70	}
71
72	/* Quietly delete it first, libzip wants replace ops otherwise. */
73	unlink(outc->filename);
74	if (!(zipfile = zip_open(outc->filename, ZIP_CREATE, &ret)))
75	return SR_ERR;
76
77	/* "version" */
78	version[0] = '2';
79	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
80	return SR_ERR;
81	if (zip_add(zipfile, "version", versrc) == -1) {
82	sr_info("Error saving version into zipfile: %s.",
83	zip_strerror(zipfile));
84	return SR_ERR;
85	}
86
87	/* init "metadata" */
88	strcpy(metafile, "sigrok-meta-XXXXXX");
89	if ((tmpfile = g_mkstemp(metafile)) == -1)
90	return SR_ERR;
91	close(tmpfile);
92	meta = g_fopen(metafile, "wb");
93	fprintf(meta, "[global]\n");
94	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
95	fprintf(meta, "[device 1]\ncapturefile = logic-1\n");
96	fprintf(meta, "total probes = %d\n", g_slist_length(o->sdi->channels));
97	s = sr_samplerate_string(outc->samplerate);
98	fprintf(meta, "samplerate = %s\n", s);
99	g_free(s);
100
101	for (l = o->sdi->channels; l; l = l->next) {
102	ch = l->data;
103	if (ch->type != SR_CHANNEL_LOGIC)
104	continue;
3250d8c7 BV	105	fprintf(meta, "probe%d = %s\n", ch->index + 1, ch->name);
	106	}
	107	fclose(meta);
	108
	109	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
	110	unlink(metafile);
	111	return SR_ERR;
	112	}
	113	if (zip_add(zipfile, "metadata", metasrc) == -1) {
	114	unlink(metafile);
	115	return SR_ERR;
	116	}
	117
	118	if ((ret = zip_close(zipfile)) == -1) {
	119	sr_info("Error saving zipfile: %s.", zip_strerror(zipfile));
	120	unlink(metafile);
	121	return SR_ERR;
	122	}
	123
	124	unlink(metafile);
	125
	126	return SR_OK;
	127	}
	128
	129	static int zip_append(const struct sr_output o, unsigned char buf,
	130	int unitsize, int length)
	131	{
	132	struct out_context *outc;
	133	struct zip *archive;
	134	struct zip_source *logicsrc;
	135	zip_int64_t num_files;
	136	struct zip_file *zf;
	137	struct zip_stat zs;
	138	struct zip_source *metasrc;
	139	GKeyFile *kf;
	140	GError *error;
	141	gsize len;
	142	int chunk_num, next_chunk_num, tmpfile, ret, i;
	143	const char *entry_name;
	144	char *metafile, tmpname[32], chunkname[16];
	145
	146	outc = o->priv;
	147	if (!(archive = zip_open(outc->filename, 0, &ret)))
	148	return SR_ERR;
	149
	150	if (zip_stat(archive, "metadata", 0, &zs) == -1)
	151	return SR_ERR;
	152
	153	metafile = g_malloc(zs.size);
	154	zf = zip_fopen_index(archive, zs.index, 0);
	155	zip_fread(zf, metafile, zs.size);
	156	zip_fclose(zf);
	157
	158	/*
	159	* If the file was only initialized but doesn't yet have any
	160	* data it in, it won't have a unitsize field in metadata yet.
	161	*/
	162	error = NULL;
	163	kf = g_key_file_new();
	164	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
	165	sr_err("Failed to parse metadata: %s.", error->message);
	166	return SR_ERR;
	167	}
	168	g_free(metafile);
169	tmpname[0] = '\0';
170	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
171	if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
172	sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
173	return SR_ERR;
174	}
175	/* Add unitsize field. */
176	g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
177	metafile = g_key_file_to_data(kf, &len, &error);
178	strcpy(tmpname, "sigrok-meta-XXXXXX");
179	if ((tmpfile = g_mkstemp(tmpname)) == -1)
180	return SR_ERR;
181	if (write(tmpfile, metafile, len) < 0) {
182	sr_dbg("Failed to create new metadata: %s", strerror(errno));
183	g_free(metafile);
184	unlink(tmpname);
185	return SR_ERR;
186	}
187	close(tmpfile);
188	if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
189	sr_err("Failed to create zip source for metadata.");
190	g_free(metafile);
191	unlink(tmpname);
192	return SR_ERR;
193	}
194	if (zip_replace(archive, zs.index, metasrc) == -1) {
195	sr_err("Failed to replace metadata file.");
196	g_free(metafile);
197	unlink(tmpname);
198	return SR_ERR;
199	}
200	g_free(metafile);
201	}
202	g_key_file_free(kf);
203
204	next_chunk_num = 1;
205	num_files = zip_get_num_entries(archive, 0);
206	for (i = 0; i < num_files; i++) {
207	entry_name = zip_get_name(archive, i, 0);
208	if (strncmp(entry_name, "logic-1", 7))
209	continue;
210	if (strlen(entry_name) == 7) {
211	/* This file has no extra chunks, just a single "logic-1".
212	* Rename it to "logic-1-1" * and continue with chunk 2. */
213	if (zip_rename(archive, i, "logic-1-1") == -1) {
214	sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
215	unlink(tmpname);
216	return SR_ERR;
217	}
218	next_chunk_num = 2;
219	break;
220	} else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
221	chunk_num = strtoull(entry_name + 8, NULL, 10);
222	if (chunk_num >= next_chunk_num)
223	next_chunk_num = chunk_num + 1;
224	}
225	}
226	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
227	if (!(logicsrc = zip_source_buffer(archive, buf, length, FALSE))) {
228	unlink(tmpname);
229	return SR_ERR;
230	}
231	if (zip_add(archive, chunkname, logicsrc) == -1) {
232	unlink(tmpname);
233	return SR_ERR;
234	}
235	if ((ret = zip_close(archive)) == -1) {
236	sr_info("error saving session file: %s", zip_strerror(archive));
237	unlink(tmpname);
238	return SR_ERR;
239	}
240	unlink(tmpname);
241
242	return SR_OK;
243	}
244
245	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
246	GString **out)
247	{
248	struct out_context *outc;
249	const struct sr_datafeed_meta *meta;
250	const struct sr_datafeed_logic *logic;
251	const struct sr_config *src;
252	GSList *l;
253
254	int ret;
255
256	*out = NULL;
257	if (!o \|\| !o->sdi \|\| !(outc = o->priv))
258	return SR_ERR_ARG;
259
260	switch (packet->type) {
261	case SR_DF_META:
262	meta = packet->payload;
263	for (l = meta->config; l; l = l->next) {
264	src = l->data;
265	if (src->key != SR_CONF_SAMPLERATE)
266	continue;
267	outc->samplerate = g_variant_get_uint64(src->data);
268	}
269	break;
270	case SR_DF_LOGIC:
271	if (!outc->zip_created) {
272	if ((ret = zip_create(o)) != SR_OK)
273	return ret;
274	outc->zip_created = TRUE;
275	}
276	logic = packet->payload;
277	ret = zip_append(o, logic->data, logic->unitsize, logic->length);
278	break;
279	}
280
281	return SR_OK;
282	}
283
284	static int cleanup(struct sr_output *o)
285	{
286	struct out_context *outc;
287
288	outc = o->priv;
289	g_free(outc->filename);
290	g_free(outc);
291	o->priv = NULL;
292
293	return SR_OK;
294	}
295
296	static struct sr_option options[] = {
297	{ "filename", "Filename", "File to write", NULL, NULL },
298	ALL_ZERO
299	};
300
301	static const struct sr_option *get_options(void)
302	{
303	if (!options[0].def)
304	options[0].def = g_variant_ref_sink(g_variant_new_string(""));
305
306	return options;
307	}
308
309	SR_PRIV struct sr_output_module output_srzip = {
310	.id = "srzip",
311	.name = "srzip",
312	.desc = "srzip session file",
313	.options = get_options,
314	.init = init,
315	.receive = receive,
316	.cleanup = cleanup,
317	};
318