/* PSPP - a program for statistical analysis.
- Copyright (C) 2011 Free Software Foundation, Inc.
+ Copyright (C) 2011, 2012, 2013, 2016, 2020, 2021 Free Software Foundation, Inc.
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
#include <config.h>
-#include "libpspp/message.h"
-#include "libpspp/misc.h"
-
-#include "data/data-in.h"
-
-#include "gl/minmax.h"
-
-#include "gettext.h"
-#define _(msgid) gettext (msgid)
-#define N_(msgid) (msgid)
-
#include "ods-reader.h"
#include "spreadsheet-reader.h"
-#if !ODF_READ_SUPPORT
-
-struct casereader *
-ods_open_reader (struct spreadsheet_read_info *gri, struct dictionary **dict)
-{
- msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "OpenDocument");
-
- return NULL;
-}
-
-#else
-
-#include "libpspp/zip-reader.h"
-
-
#include <assert.h>
#include <stdbool.h>
#include <errno.h>
#include <libxml/xmlreader.h>
#include <zlib.h>
-#include "data/format.h"
#include "data/case.h"
#include "data/casereader-provider.h"
+#include "data/data-in.h"
#include "data/dictionary.h"
+#include "data/format.h"
#include "data/identifier.h"
#include "data/value.h"
#include "data/variable.h"
+#include "libpspp/assertion.h"
#include "libpspp/i18n.h"
+#include "libpspp/message.h"
+#include "libpspp/misc.h"
#include "libpspp/str.h"
+#include "libpspp/zip-reader.h"
+#include "libpspp/hmap.h"
+#include "libpspp/hash-functions.h"
+
+#include "gl/c-strtod.h"
+#include "gl/minmax.h"
#include "gl/xalloc.h"
-static void ods_file_casereader_destroy (struct casereader *, void *);
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
+
+/* Setting this to false can help with debugging and development.
+ Don't forget to set it back to true, or users will complain that
+ all but the smallest spreadsheets display VERY slowly. */
+static const bool use_cache = true;
+static void ods_file_casereader_destroy (struct casereader *, void *);
static struct ccase *ods_file_casereader_read (struct casereader *, void *);
static const struct casereader_class ods_file_casereader_class =
STATE_CELL_CONTENT /* Found a the text within a cell */
};
-struct ods_reader
+struct state_data
{
xmlTextReaderPtr xtr;
-
+ struct zip_member *zm;
+ int node_type;
enum reader_state state;
- bool sheet_found;
int row;
int col;
- int node_type;
- int sheet_index;
+ int current_sheet;
+ xmlChar *current_sheet_name;
+
+ int col_span;
+};
+
+static void
+state_data_destroy (struct state_data *sd)
+{
+ xmlFree (sd->current_sheet_name);
+ sd->current_sheet_name = NULL;
+
+ xmlFreeTextReader (sd->xtr);
+ sd->xtr = NULL;
+
+ zip_member_finish (sd->zm);
+ sd->zm = NULL;
+}
+
+struct ods_reader
+{
+ struct spreadsheet spreadsheet;
+ struct zip_reader *zreader;
- const xmlChar *target_sheet;
int target_sheet_index;
+ xmlChar *target_sheet_name;
- int start_row;
- int start_col;
- int stop_row;
- int stop_col;
+ int n_allocated_sheets;
- struct caseproto *proto;
- struct dictionary *dict;
- struct ccase *first_case;
- bool used_first_case;
- bool read_names;
+ /* The total number of sheets in the "workbook" */
+ int n_sheets;
+
+ /* State data for the reader */
+ struct state_data rsd;
struct string ods_errs;
- int span;
+
+ struct hmap cache;
};
-static void process_node (struct ods_reader *r);
+/* A value to be kept in the hash table for cache purposes. */
+struct cache_datum
+{
+ struct hmap_node node;
+
+ /* The number of the sheet. */
+ int sheet;
+
+ /* The cell's row. */
+ int row;
+
+ /* The cell's column. */
+ int col;
+
+ /* The value of the cell. */
+ char *value;
+};
+
+static int
+xml_reader_for_zip_member (void *zm_, char *buffer, int len)
+{
+ struct zip_member *zm = zm_;
+ return zip_member_read (zm, buffer, len);
+}
+
+static void
+ods_destroy (struct spreadsheet *s)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+
+ int i;
+
+ for (i = 0; i < r->n_allocated_sheets; ++i)
+ {
+ xmlFree (r->spreadsheet.sheets[i].name);
+ }
+
+ dict_unref (r->spreadsheet.dict);
+
+ zip_reader_unref (r->zreader);
+ free (r->spreadsheet.sheets);
+ free (s->file_name);
+
+ struct cache_datum *cell;
+ struct cache_datum *next;
+ HMAP_FOR_EACH_SAFE (cell, next, struct cache_datum, node, &r->cache)
+ {
+ free (cell->value);
+ free (cell);
+ }
+
+ hmap_destroy (&r->cache);
+
+ free (r);
+}
+
+static bool
+reading_target_sheet (const struct ods_reader *r, const struct state_data *sd)
+{
+ if (r->target_sheet_name != NULL)
+ {
+ if (0 == xmlStrcmp (r->target_sheet_name, sd->current_sheet_name))
+ return true;
+ }
+
+ if (r->target_sheet_index == sd->current_sheet + 1)
+ return true;
+
+ return false;
+}
+
+
+static void process_node (struct ods_reader *or, struct state_data *r);
+
+
+/* Initialise SD using R */
+static bool
+state_data_init (const struct ods_reader *r, struct state_data *sd)
+{
+ memset (sd, 0, sizeof (*sd));
+
+ char *error = zip_member_open (r->zreader, "content.xml", &sd->zm);
+ if (error)
+ {
+ free (error);
+ return false;
+ }
+
+ sd->xtr =
+ xmlReaderForIO (xml_reader_for_zip_member, NULL, sd->zm, NULL, NULL,
+ 0);
+
+ if (sd->xtr == NULL)
+ return NULL;
+
+ sd->state = STATE_INIT;
+ return true;
+}
+
+
+static const char *
+ods_get_sheet_name (struct spreadsheet *s, int n)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+ struct state_data sd;
+ state_data_init (r, &sd);
+
+ while ((r->n_allocated_sheets <= n)
+ || sd.state != STATE_SPREADSHEET)
+ {
+ int ret = xmlTextReaderRead (sd.xtr);
+ if (ret != 1)
+ break;
+
+ process_node (r, &sd);
+ }
+ state_data_destroy (&sd);
+
+ return r->spreadsheet.sheets[n].name;
+}
+
+static char *
+ods_get_sheet_range (struct spreadsheet *s, int n)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+ struct state_data sd;
+ state_data_init (r, &sd);
+
+ while ((r->n_allocated_sheets <= n)
+ || (r->spreadsheet.sheets[n].last_row == -1)
+ || sd.state != STATE_SPREADSHEET)
+ {
+ int ret = xmlTextReaderRead (sd.xtr);
+ if (ret != 1)
+ break;
+
+ process_node (r, &sd);
+ }
+ state_data_destroy (&sd);
+
+ return create_cell_range (
+ r->spreadsheet.sheets[n].first_col,
+ r->spreadsheet.sheets[n].first_row,
+ r->spreadsheet.sheets[n].last_col,
+ r->spreadsheet.sheets[n].last_row);
+}
+
+static unsigned int
+ods_get_sheet_n_rows (struct spreadsheet *s, int n)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+ struct state_data sd;
+
+ if (r->n_allocated_sheets > n && r->spreadsheet.sheets[n].last_row != -1)
+ {
+ return r->spreadsheet.sheets[n].last_row + 1;
+ }
+
+ state_data_init (r, &sd);
+
+ while (1 == xmlTextReaderRead (sd.xtr))
+ {
+ process_node (r, &sd);
+ }
+
+ state_data_destroy (&sd);
+
+ return r->spreadsheet.sheets[n].last_row + 1;
+}
+
+static unsigned int
+ods_get_sheet_n_columns (struct spreadsheet *s, int n)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+ struct state_data sd;
+
+ if (r->n_allocated_sheets > n && r->spreadsheet.sheets[n].last_col != -1)
+ return r->spreadsheet.sheets[n].last_col + 1;
+
+ state_data_init (r, &sd);
+
+ while (1 == xmlTextReaderRead (sd.xtr))
+ {
+ process_node (r, &sd);
+ }
+
+ state_data_destroy (&sd);
+
+ return r->spreadsheet.sheets[n].last_col + 1;
+}
+
+static char *
+ods_get_sheet_cell (struct spreadsheet *s, int n, int row, int column)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+ struct state_data sd;
+
+ /* See if this cell is in the cache. If it is, then use it. */
+ if (use_cache)
+ {
+ struct cache_datum *lookup = NULL;
+ unsigned int hash = hash_int (n, 0);
+ hash = hash_int (row, hash);
+ hash = hash_int (column, hash);
+
+ HMAP_FOR_EACH_WITH_HASH (lookup, struct cache_datum, node, hash,
+ &r->cache)
+ {
+ if (lookup->row == row && lookup->col == column
+ && lookup->sheet == n)
+ {
+ break;
+ }
+ }
+ if (lookup)
+ {
+ return lookup->value ? strdup (lookup->value) : NULL;
+ }
+ }
+
+ state_data_init (r, &sd);
+
+ char *cell_content = NULL;
+
+ int prev_col = 0;
+ int prev_row = 0;
+ while (1 == xmlTextReaderRead (sd.xtr))
+ {
+ process_node (r, &sd);
+ if (sd.row > prev_row)
+ prev_col = 0;
+
+ if (sd.state == STATE_CELL_CONTENT
+ && sd.current_sheet == n
+ && sd.node_type == XML_READER_TYPE_TEXT)
+ {
+ /* When cell contents are encountered, copy and save it, discarding
+ any older content. */
+ free (cell_content);
+ cell_content = CHAR_CAST (char *, xmlTextReaderValue (sd.xtr));
+ }
+ if (sd.state == STATE_ROW
+ && sd.current_sheet == n
+ && sd.node_type == XML_READER_TYPE_ELEMENT)
+ {
+ /* At the start of a row, free the cell contents and set it to NULL. */
+ free (cell_content);
+ cell_content = NULL;
+ }
+ if (sd.state == STATE_ROW
+ && sd.current_sheet == n
+ &&
+ (sd.node_type == XML_READER_TYPE_END_ELEMENT
+ ||
+ xmlTextReaderIsEmptyElement (sd.xtr)))
+ {
+ if (use_cache)
+ {
+ for (int c = prev_col; c < sd.col; ++c)
+ {
+ /* See if this cell has already been cached ... */
+ unsigned int hash = hash_int (sd.current_sheet, 0);
+ hash = hash_int (sd.row - 1, hash);
+ hash = hash_int (c, hash);
+ struct cache_datum *probe = NULL;
+ struct cache_datum *next;
+ HMAP_FOR_EACH_WITH_HASH_SAFE (probe, next, struct cache_datum, node, hash,
+ &r->cache)
+ {
+ if (probe->row == sd.row - 1 && probe->col == c
+ && probe->sheet == sd.current_sheet)
+ break;
+ probe = NULL;
+ }
+ /* If not, then cache it. */
+ if (!probe)
+ {
+ struct cache_datum *cell_data = XMALLOC (struct cache_datum);
+ cell_data->row = sd.row - 1;
+ cell_data->col = c;
+ cell_data->sheet = sd.current_sheet;
+ cell_data->value = cell_content ? strdup (cell_content) : NULL;
+
+ hmap_insert (&r->cache, &cell_data->node, hash);
+ }
+ }
+ }
+
+ if (sd.row == row + 1 && sd.col >= column + 1)
+ {
+ break;
+ }
+
+ prev_col = sd.col;
+ prev_row = sd.row;
+ }
+ }
+
+ state_data_destroy (&sd);
+ return cell_content;
+}
static void
ods_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
{
struct ods_reader *r = r_;
- if ( r == NULL)
+ if (r == NULL)
return ;
- if (r->xtr)
- xmlFreeTextReader (r->xtr);
+ state_data_destroy (&r->rsd);
- if ( ! ds_is_empty (&r->ods_errs))
- msg (ME, ds_cstr (&r->ods_errs));
+ if (! ds_is_empty (&r->ods_errs))
+ msg (ME, "%s", ds_cstr (&r->ods_errs));
ds_destroy (&r->ods_errs);
- if ( ! r->used_first_case )
- case_unref (r->first_case);
+ if (r->spreadsheet.first_case && ! r->spreadsheet.used_first_case)
+ case_unref (r->spreadsheet.first_case);
- caseproto_unref (r->proto);
+ caseproto_unref (r->spreadsheet.proto);
+ r->spreadsheet.proto = NULL;
- free (r);
+ xmlFree (r->target_sheet_name);
+ r->target_sheet_name = NULL;
+
+ spreadsheet_unref (&r->spreadsheet);
}
static void
-process_node (struct ods_reader *r)
+process_node (struct ods_reader *or, struct state_data *r)
{
xmlChar *name = xmlTextReaderName (r->xtr);
if (name == NULL)
name = xmlStrdup (_xml ("--"));
+
r->node_type = xmlTextReaderNodeType (r->xtr);
- switch ( r->state)
+ switch (r->state)
{
case STATE_INIT:
if (0 == xmlStrcasecmp (name, _xml("office:spreadsheet")) &&
XML_READER_TYPE_ELEMENT == r->node_type)
{
r->state = STATE_SPREADSHEET;
+ r->current_sheet = -1;
+ r->current_sheet_name = NULL;
}
break;
case STATE_SPREADSHEET:
- if (0 == xmlStrcasecmp (name, _xml("table:table")))
+ if (0 == xmlStrcasecmp (name, _xml("table:table"))
+ &&
+ (XML_READER_TYPE_ELEMENT == r->node_type))
{
- if (XML_READER_TYPE_ELEMENT == r->node_type)
+ xmlFree (r->current_sheet_name);
+ r->current_sheet_name = xmlTextReaderGetAttribute (r->xtr, _xml ("table:name"));
+
+ ++r->current_sheet;
+
+ if (r->current_sheet >= or->n_allocated_sheets)
{
- r->col = -1;
- r->row = -1;
- ++r->sheet_index;
- if ( r->target_sheet != NULL)
- {
- xmlChar *value = xmlTextReaderGetAttribute (r->xtr, _xml ("table:name"));
- if ( 0 == xmlStrcmp (value, r->target_sheet))
- {
- r->sheet_found = true;
- r->state = STATE_TABLE;
- }
- free (value);
- }
- else if (r->target_sheet_index == r->sheet_index)
- {
- r->sheet_found = true;
- r->state = STATE_TABLE;
- }
- else if ( r->target_sheet_index == -1)
- r->state = STATE_TABLE;
+ assert (r->current_sheet == or->n_allocated_sheets);
+ or->spreadsheet.sheets = xrealloc (or->spreadsheet.sheets, sizeof (*or->spreadsheet.sheets) * ++or->n_allocated_sheets);
+ or->spreadsheet.sheets[or->n_allocated_sheets - 1].first_col = -1;
+ or->spreadsheet.sheets[or->n_allocated_sheets - 1].last_col = -1;
+ or->spreadsheet.sheets[or->n_allocated_sheets - 1].first_row = -1;
+ or->spreadsheet.sheets[or->n_allocated_sheets - 1].last_row = -1;
+ or->spreadsheet.sheets[or->n_allocated_sheets - 1].name = CHAR_CAST (char *, xmlStrdup (r->current_sheet_name));
}
+ if (or->n_allocated_sheets > or->n_sheets)
+ or->n_sheets = or->n_allocated_sheets;
+
+ r->col = 0;
+ r->row = 0;
+
+ r->state = STATE_TABLE;
}
- else if (XML_READER_TYPE_END_ELEMENT == r->node_type
- && r->sheet_found)
+ else if (0 == xmlStrcasecmp (name, _xml("office:spreadsheet")) &&
+ XML_READER_TYPE_ELEMENT == r->node_type)
{
r->state = STATE_INIT;
}
- break;
+ break;
case STATE_TABLE:
- if (0 == xmlStrcasecmp (name, _xml("table:table-row")) )
+ if (0 == xmlStrcasecmp (name, _xml("table:table-row")) &&
+ (XML_READER_TYPE_ELEMENT == r->node_type))
{
- if ( XML_READER_TYPE_ELEMENT == r->node_type)
- {
- if (! xmlTextReaderIsEmptyElement (r->xtr))
- {
- r->state = STATE_ROW;
- }
- r->row++;
- r->span = 1;
- }
+ xmlChar *value =
+ xmlTextReaderGetAttribute (r->xtr,
+ _xml ("table:number-rows-repeated"));
+
+ int row_span = value ? _xmlchar_to_int (value) : 1;
+
+ r->row += row_span;
+ r->col = 0;
+
+ if (! xmlTextReaderIsEmptyElement (r->xtr))
+ r->state = STATE_ROW;
+
+ xmlFree (value);
}
- else if (XML_READER_TYPE_END_ELEMENT == r->node_type)
+ else if (0 == xmlStrcasecmp (name, _xml("table:table")) &&
+ (XML_READER_TYPE_END_ELEMENT == r->node_type))
{
r->state = STATE_SPREADSHEET;
}
break;
case STATE_ROW:
- if (0 == xmlStrcasecmp (name, _xml ("table:table-cell")))
+ if ((0 == xmlStrcasecmp (name, _xml ("table:table-cell")))
+ &&
+ (XML_READER_TYPE_ELEMENT == r->node_type))
{
- if ( XML_READER_TYPE_ELEMENT == r->node_type)
- {
- xmlChar *value =
- xmlTextReaderGetAttribute (r->xtr,
- _xml ("table:number-columns-repeated"));
- r->col += r->span;
- r->span = value ? _xmlchar_to_int (value) : 1;
- free (value);
- if (! xmlTextReaderIsEmptyElement (r->xtr))
- {
- r->state = STATE_CELL;
- }
- }
+ xmlChar *value =
+ xmlTextReaderGetAttribute (r->xtr,
+ _xml ("table:number-columns-repeated"));
+
+ r->col_span = value ? _xmlchar_to_int (value) : 1;
+ r->col += r->col_span;
+
+ if (! xmlTextReaderIsEmptyElement (r->xtr))
+ r->state = STATE_CELL;
+
+ xmlFree (value);
}
- else if (XML_READER_TYPE_END_ELEMENT == r->node_type)
+ else if ((0 == xmlStrcasecmp (name, _xml ("table:table-row")))
+ &&
+ (XML_READER_TYPE_END_ELEMENT == r->node_type))
{
r->state = STATE_TABLE;
- r->col = -1;
- /* Set the span back to the default */
- r->span = 1;
}
break;
case STATE_CELL:
- if (0 == xmlStrcasecmp (name, _xml("text:p")))
+ if ((0 == xmlStrcasecmp (name, _xml("text:p")))
+ &&
+ (XML_READER_TYPE_ELEMENT == r->node_type))
{
- if ( XML_READER_TYPE_ELEMENT == r->node_type)
- {
- r->state = STATE_CELL_CONTENT;
- }
+ if (! xmlTextReaderIsEmptyElement (r->xtr))
+ r->state = STATE_CELL_CONTENT;
}
- else if (XML_READER_TYPE_END_ELEMENT == r->node_type)
+ else if
+ ((0 == xmlStrcasecmp (name, _xml("table:table-cell")))
+ &&
+ (XML_READER_TYPE_END_ELEMENT == r->node_type)
+ )
{
r->state = STATE_ROW;
}
break;
case STATE_CELL_CONTENT:
- if (XML_READER_TYPE_TEXT != r->node_type)
+ assert (r->current_sheet >= 0);
+ assert (r->current_sheet < or->n_allocated_sheets);
+
+ if (or->spreadsheet.sheets[r->current_sheet].first_row == -1)
+ or->spreadsheet.sheets[r->current_sheet].first_row = r->row - 1;
+
+ if (
+ (or->spreadsheet.sheets[r->current_sheet].first_col == -1)
+ ||
+ (or->spreadsheet.sheets[r->current_sheet].first_col >= r->col - 1)
+ )
+ or->spreadsheet.sheets[r->current_sheet].first_col = r->col - 1;
+
+ if (or->spreadsheet.sheets[r->current_sheet].last_row < r->row - 1)
+ or->spreadsheet.sheets[r->current_sheet].last_row = r->row - 1;
+
+ if (or->spreadsheet.sheets[r->current_sheet].last_col < r->col - 1)
+ or->spreadsheet.sheets[r->current_sheet].last_col = r->col - 1;
+
+ if (XML_READER_TYPE_END_ELEMENT == r->node_type)
r->state = STATE_CELL;
break;
default:
+ NOT_REACHED ();
break;
};
xmlFree (name);
}
-/*
- A struct containing the parameters of a cell's value
+/*
+ A struct containing the parameters of a cell's value
parsed from the xml
*/
struct xml_value
if (xmv->type != NULL && 0 != xmlStrcmp (xmv->type, _xml("string")))
return 0;
- if ( fallback != -1)
+ if (fallback != -1)
return fallback;
- if ( xmv->value )
+ if (xmv->value)
width = ROUND_UP (xmlStrlen (xmv->value),
SPREADSHEET_DEFAULT_WIDTH);
- else if ( xmv->text)
+ else if (xmv->text)
width = ROUND_UP (xmlStrlen (xmv->text),
SPREADSHEET_DEFAULT_WIDTH);
*/
static void
convert_xml_to_value (struct ccase *c, const struct variable *var,
- const struct xml_value *xmv)
+ const struct xml_value *xmv, int col, int row)
{
union value *v = case_data_rw (c, var);
if (xmv->value == NULL && xmv->text == NULL)
value_set_missing (v, var_get_width (var));
- else if ( var_is_alpha (var))
+ else if (var_is_alpha (var))
/* Use the text field, because it seems that there is no
value field for strings */
value_copy_str_rpad (v, var_get_width (var), xmv->text, ' ');
else
{
- const char *text ;
const struct fmt_spec *fmt = var_get_write_format (var);
enum fmt_category fc = fmt_get_category (fmt->type);
- assert ( fc != FMT_CAT_STRING);
+ assert (fc != FMT_CAT_STRING);
+
+ if (0 == xmlStrcmp (xmv->type, _xml("float")))
+ {
+ v->f = c_strtod (CHAR_CAST (const char *, xmv->value), NULL);
+ }
+ else
+ {
+ const char *text = xmv->value ?
+ CHAR_CAST (const char *, xmv->value) : CHAR_CAST (const char *, xmv->text);
+
+ char *m = data_in (ss_cstr (text), "UTF-8", fmt->type,
+ settings_get_fmt_settings (), v,
+ var_get_width (var), "UTF-8");
+
+ if (m)
+ {
+ char buf [FMT_STRING_LEN_MAX + 1];
+ char *cell = create_cell_ref (col, row);
+
+ msg (MW, _("Cannot convert the value in the spreadsheet cell %s to format (%s): %s"),
+ cell, fmt_to_string (fmt, buf), m);
+ free (cell);
+ }
+ free (m);
+ }
+ }
+}
+
+/* Try to find out how many sheets there are in the "workbook" */
+static int
+get_sheet_count (struct zip_reader *zreader)
+{
+ xmlTextReaderPtr mxtr;
+ struct zip_member *meta = NULL;
+ char *error = zip_member_open (zreader, "meta.xml", &meta);
+ if (error)
+ {
+ free (error);
+ return -1;
+ }
- text =
- xmv->value ? CHAR_CAST (const char *, xmv->value) : CHAR_CAST (const char *, xmv->text);
+ mxtr = xmlReaderForIO (xml_reader_for_zip_member, NULL, meta, NULL, NULL, 0);
- data_in (ss_cstr (text), "UTF-8",
- fmt->type,
- v,
- var_get_width (var),
- "UTF-8");
+ while (1 == xmlTextReaderRead (mxtr))
+ {
+ xmlChar *name = xmlTextReaderName (mxtr);
+ if (0 == xmlStrcmp (name, _xml("meta:document-statistic")))
+ {
+ xmlChar *attr = xmlTextReaderGetAttribute (mxtr, _xml ("meta:table-count"));
+
+ if (attr != NULL)
+ {
+ int s = _xmlchar_to_int (attr);
+ xmlFreeTextReader (mxtr);
+ zip_member_finish (meta);
+ xmlFree (name);
+ xmlFree (attr);
+ return s;
+ }
+ xmlFree (attr);
+ }
+ xmlFree (name);
}
+
+ xmlFreeTextReader (mxtr);
+ zip_member_finish (meta);
+ return -1;
+}
+
+static int
+ods_get_sheet_n_sheets (struct spreadsheet *s)
+{
+ struct ods_reader *r = (struct ods_reader *) s;
+
+ if (r->n_sheets >= 0)
+ return r->n_sheets;
+
+ r->n_sheets = get_sheet_count (r->zreader);
+
+ return r->n_sheets;
}
-struct casereader *
-ods_open_reader (struct spreadsheet_read_info *gri, struct dictionary **dict)
+static void
+ods_error_handler (void *ctx, const char *mesg,
+ xmlParserSeverities sev UNUSED,
+ xmlTextReaderLocatorPtr loc)
{
- int ret = 0;
+ struct ods_reader *r = ctx;
+
+ msg (MW, _("There was a problem whilst reading the %s file `%s' (near line %d): `%s'"),
+ "ODF",
+ r->spreadsheet.file_name,
+ xmlTextReaderLocatorLineNumber (loc),
+ mesg);
+}
+
+
+static bool init_reader (struct ods_reader *r, bool report_errors, struct state_data *state);
+
+static struct casereader *
+ods_make_reader (struct spreadsheet *spreadsheet,
+ const struct spreadsheet_read_options *opts)
+{
+ intf ret = 0;
xmlChar *type = NULL;
unsigned long int vstart = 0;
casenumber n_cases = CASENUMBER_MAX;
struct var_spec *var_spec = NULL;
int n_var_specs = 0;
- struct ods_reader *r = xzalloc (sizeof *r);
- struct zip_member *content = NULL;
- struct zip_reader *zreader ;
+ struct ods_reader *r = (struct ods_reader *) spreadsheet;
xmlChar *val_string = NULL;
- r->read_names = gri->read_names;
+ assert (r);
ds_init_empty (&r->ods_errs);
+ r = (struct ods_reader *) spreadsheet_ref (SPREADSHEET_CAST (r));
- zreader = zip_reader_create (gri->file_name, &r->ods_errs);
-
- if ( NULL == zreader)
- {
- msg (ME, _("Error opening `%s' for reading as a OpenDocument spreadsheet file: %s."),
- gri->file_name, ds_cstr (&r->ods_errs));
+ if (!init_reader (r, true, &r->rsd))
+ goto error;
- goto error;
- }
+ r->spreadsheet.used_first_case = false;
+ r->spreadsheet.first_case = NULL;
- content = zip_member_open (zreader, "content.xml");
- if ( NULL == content)
+ if (opts->cell_range)
{
- msg (ME, _("Could not extract OpenDocument spreadsheet from file `%s': %s."),
- gri->file_name, ds_cstr (&r->ods_errs));
-
- goto error;
- }
-
- zip_member_ref (content);
-
- r->xtr = xmlReaderForIO ((xmlInputReadCallback) zip_member_read,
- (xmlInputCloseCallback) zip_member_finish,
- content, NULL, NULL, XML_PARSE_RECOVER);
-
- if ( r->xtr == NULL)
- {
- goto error;
- }
-
- if ( gri->cell_range )
- {
- if ( ! convert_cell_ref (gri->cell_range,
- &r->start_col, &r->start_row,
- &r->stop_col, &r->stop_row))
+ if (! convert_cell_ref (opts->cell_range,
+ &r->spreadsheet.start_col, &r->spreadsheet.start_row,
+ &r->spreadsheet.stop_col, &r->spreadsheet.stop_row))
{
msg (SE, _("Invalid cell range `%s'"),
- gri->cell_range);
+ opts->cell_range);
goto error;
}
}
else
{
- r->start_col = 0;
- r->start_row = 0;
- r->stop_col = -1;
- r->stop_row = -1;
- }
-
- r->state = STATE_INIT;
- r->target_sheet = BAD_CAST gri->sheet_name;
- r->target_sheet_index = gri->sheet_index;
- r->row = r->col = -1;
- r->sheet_index = 0;
-
-
- /* If CELLRANGE was given, then we know how many variables should be read */
- if ( r->stop_col != -1 )
- {
- n_var_specs = r->stop_col - r->start_col + 1;
- var_spec = xrealloc (var_spec, sizeof (*var_spec) * n_var_specs);
+ r->spreadsheet.start_col = 0;
+ r->spreadsheet.start_row = 0;
+ r->spreadsheet.stop_col = -1;
+ r->spreadsheet.stop_row = -1;
}
+ r->target_sheet_name = xmlStrdup (BAD_CAST opts->sheet_name);
+ r->target_sheet_index = opts->sheet_index;
/* Advance to the start of the cells for the target sheet */
- while ( (r->row < r->start_row ))
+ while (! reading_target_sheet (r, &r->rsd)
+ || r->rsd.state != STATE_ROW || r->rsd.row <= r->spreadsheet.start_row)
{
- if (1 != (ret = xmlTextReaderRead (r->xtr)))
+ if (1 != (ret = xmlTextReaderRead (r->rsd.xtr)))
break;
- process_node (r);
+ process_node (r, &r->rsd);
}
if (ret < 1)
{
msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
- gri->file_name);
+ spreadsheet->file_name);
goto error;
}
- if ( gri->read_names)
+ if (opts->read_names)
{
- while (1 == (ret = xmlTextReaderRead (r->xtr)))
+ while (1 == xmlTextReaderRead (r->rsd.xtr))
{
- int idx;
- process_node (r);
- if ( r->row > r->start_row)
- break;
+ process_node (r, &r->rsd);
- if (r->col == -1 && r->row == r->start_row)
+ /* If the row is finished then stop for now */
+ if (r->rsd.state == STATE_TABLE && r->rsd.row > r->spreadsheet.start_row)
break;
- if ( r->col < r->start_col)
+ int idx = r->rsd.col - r->spreadsheet.start_col - 1;
+
+ if (idx < 0)
continue;
- idx = r->col - r->start_col;
+ if (r->spreadsheet.stop_col != -1 && idx > r->spreadsheet.stop_col - r->spreadsheet.start_col)
+ continue;
- if (r->state == STATE_CELL_CONTENT
+ if (r->rsd.state == STATE_CELL_CONTENT
&&
- XML_READER_TYPE_TEXT == r->node_type)
+ XML_READER_TYPE_TEXT == r->rsd.node_type)
{
- xmlChar *value = xmlTextReaderValue (r->xtr);
- if ( idx >= n_var_specs)
+ xmlChar *value = xmlTextReaderValue (r->rsd.xtr);
+ if (idx >= n_var_specs)
{
-
var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
/* xrealloc (unlike realloc) doesn't initialise its memory to 0 */
- memset (var_spec + n_var_specs * sizeof (*var_spec),
- 0,
- (n_var_specs - idx + 1) * sizeof (*var_spec));
+ memset (var_spec + n_var_specs,
+ 0,
+ (idx - n_var_specs + 1) * sizeof (*var_spec));
n_var_specs = idx + 1;
}
- var_spec[idx].firstval.text = 0;
- var_spec[idx].firstval.value = 0;
- var_spec[idx].firstval.type = 0;
+ for (int i = 0; i < r->rsd.col_span; ++i)
+ {
+ var_spec[idx - i].firstval.text = 0;
+ var_spec[idx - i].firstval.value = 0;
+ var_spec[idx - i].firstval.type = 0;
+ var_spec[idx - i].name =
+ strdup (CHAR_CAST (const char *, value));
+ }
- var_spec [idx].name = strdup (CHAR_CAST (const char *, value));
- free (value);
- value = NULL;
+ xmlFree (value);
}
}
}
/* Read in the first row of data */
- while (1 == xmlTextReaderRead (r->xtr))
+ while (1 == xmlTextReaderRead (r->rsd.xtr))
{
int idx;
- process_node (r);
- if ( r->row >= r->start_row + 1 + gri->read_names)
+ process_node (r, &r->rsd);
+
+ if (! reading_target_sheet (r, &r->rsd))
break;
- if ( r->col < r->start_col)
- continue;
+ /* If the row is finished then stop for now */
+ if (r->rsd.state == STATE_TABLE &&
+ r->rsd.row > r->spreadsheet.start_row + (opts->read_names ? 1 : 0))
+ break;
- if ( r->col - r->start_col + 1 > n_var_specs)
+ idx = r->rsd.col - r->spreadsheet.start_col - 1;
+ if (idx < 0)
continue;
- idx = r->col - r->start_col;
+ if (r->spreadsheet.stop_col != -1 && idx > r->spreadsheet.stop_col - r->spreadsheet.start_col)
+ continue;
- if ( r->state == STATE_CELL &&
- XML_READER_TYPE_ELEMENT == r->node_type)
+ if (r->rsd.state == STATE_CELL &&
+ XML_READER_TYPE_ELEMENT == r->rsd.node_type)
{
- type = xmlTextReaderGetAttribute (r->xtr, _xml ("office:value-type"));
- val_string = xmlTextReaderGetAttribute (r->xtr, _xml ("office:value"));
+ type = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value-type"));
+ val_string = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value"));
}
- if ( r->state == STATE_CELL_CONTENT &&
- XML_READER_TYPE_TEXT == r->node_type)
+ if (r->rsd.state == STATE_CELL_CONTENT &&
+ XML_READER_TYPE_TEXT == r->rsd.node_type)
{
- var_spec [idx].firstval.type = type;
- var_spec [idx].firstval.text = xmlTextReaderValue (r->xtr);
- var_spec [idx].firstval.value = val_string;
- val_string = NULL;
- type = NULL;
+ if (idx >= n_var_specs)
+ {
+ var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + r->rsd.col_span));
+ memset (var_spec + n_var_specs,
+ 0,
+ (idx + r->rsd.col_span - n_var_specs) * sizeof (*var_spec));
+
+ var_spec [idx].name = NULL;
+ n_var_specs = idx + 1;
+ }
+
+ for (int x = 0; x < r->rsd.col_span; ++x)
+ {
+ var_spec [idx - x].firstval.type = xmlStrdup (type);
+ var_spec [idx - x].firstval.text = xmlTextReaderValue (r->rsd.xtr);
+ var_spec [idx - x].firstval.value = xmlStrdup (val_string);
+ }
+
+ free (val_string);
+ free (type);
}
}
/* Create the dictionary and populate it */
- *dict = r->dict = dict_create (
- CHAR_CAST (const char *, xmlTextReaderConstEncoding (r->xtr)));
+ r->spreadsheet.dict = dict_create (
+ CHAR_CAST (const char *, xmlTextReaderConstEncoding (r->rsd.xtr)));
- for (i = 0 ; i < n_var_specs ; ++i )
+ for (i = 0; i < n_var_specs ; ++i)
{
struct fmt_spec fmt;
struct variable *var = NULL;
- char *name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
- int width = xmv_to_width (&var_spec[i].firstval, gri->asw);
- dict_create_var (r->dict, name, width);
+ char *name = dict_make_unique_var_name (r->spreadsheet.dict, var_spec[i].name, &vstart);
+ int width = xmv_to_width (&var_spec[i].firstval, opts->asw);
+ dict_create_var (r->spreadsheet.dict, name, width);
free (name);
- var = dict_get_var (r->dict, i);
+ var = dict_get_var (r->spreadsheet.dict, i);
- if ( 0 == xmlStrcmp (var_spec[i].firstval.type, _xml("date")))
+ if (0 == xmlStrcmp (var_spec[i].firstval.type, _xml("date")))
{
fmt.type = FMT_DATE;
fmt.d = 0;
var_set_both_formats (var, &fmt);
}
- /* Create the first case, and cache it */
- r->used_first_case = false;
-
- if ( n_var_specs == 0 )
+ if (n_var_specs == 0)
{
msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
- gri->file_name);
+ spreadsheet->file_name);
goto error;
}
- r->proto = caseproto_ref (dict_get_proto (r->dict));
- r->first_case = case_create (r->proto);
- case_set_missing (r->first_case);
+ /* Create the first case, and cache it */
+ r->spreadsheet.proto = caseproto_ref (dict_get_proto (r->spreadsheet.dict));
+ r->spreadsheet.first_case = case_create (r->spreadsheet.proto);
+ case_set_missing (r->spreadsheet.first_case);
- for ( i = 0 ; i < n_var_specs ; ++i )
+ for (i = 0 ; i < n_var_specs; ++i)
{
- const struct variable *var = dict_get_var (r->dict, i);
+ const struct variable *var = dict_get_var (r->spreadsheet.dict, i);
- convert_xml_to_value (r->first_case, var, &var_spec[i].firstval);
+ convert_xml_to_value (r->spreadsheet.first_case, var, &var_spec[i].firstval,
+ r->rsd.col - n_var_specs + i,
+ r->rsd.row - 1);
+ }
+
+ /* Read in the first row of data */
+ while (1 == xmlTextReaderRead (r->rsd.xtr))
+ {
+ process_node (r, &r->rsd);
+
+ if (r->rsd.state == STATE_ROW)
+ break;
}
- zip_reader_destroy (zreader);
- for ( i = 0 ; i < n_var_specs ; ++i )
+ for (i = 0 ; i < n_var_specs ; ++i)
{
free (var_spec[i].firstval.type);
free (var_spec[i].firstval.value);
free (var_spec);
+
return casereader_create_sequential
(NULL,
- r->proto,
+ r->spreadsheet.proto,
n_cases,
&ods_file_casereader_class, r);
error:
-
- zip_reader_destroy (zreader);
- for ( i = 0 ; i < n_var_specs ; ++i )
+ for (i = 0 ; i < n_var_specs ; ++i)
{
free (var_spec[i].firstval.type);
free (var_spec[i].firstval.value);
free (var_spec);
+ ods_file_casereader_destroy (NULL, r);
+
return NULL;
}
ods_file_casereader_read (struct casereader *reader UNUSED, void *r_)
{
struct ccase *c = NULL;
- xmlChar *val_string = NULL;
struct ods_reader *r = r_;
- int current_row = r->row;
- if ( r->row == -1)
- return NULL;
+ xmlChar *val_string = NULL;
+ xmlChar *type = NULL;
- if ( !r->used_first_case )
+ if (!r->spreadsheet.used_first_case)
{
- r->used_first_case = true;
- return r->first_case;
+ r->spreadsheet.used_first_case = true;
+ return r->spreadsheet.first_case;
}
- if ( r->state > STATE_INIT)
+ /* Advance to the start of a row. (If there is one) */
+ while (r->rsd.state != STATE_ROW
+ && 1 == xmlTextReaderRead (r->rsd.xtr)
+ )
{
- c = case_create (r->proto);
- case_set_missing (c);
+ process_node (r, &r->rsd);
}
- while (1 == xmlTextReaderRead (r->xtr))
+
+ if (! reading_target_sheet (r, &r->rsd)
+ || r->rsd.state < STATE_TABLE
+ || (r->spreadsheet.stop_row != -1 && r->rsd.row > r->spreadsheet.stop_row + 1)
+)
{
- process_node (r);
- if ( r->row > current_row)
- {
- break;
- }
- if ( r->col < r->start_col || (r->stop_col != -1 && r->col > r->stop_col))
- {
- continue;
- }
- if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
- {
- continue;
- }
- if ( r->stop_row != -1 && r->row > r->stop_row)
- {
- continue;
- }
- if ( r->state == STATE_CELL &&
- r->node_type == XML_READER_TYPE_ELEMENT )
+ return NULL;
+ }
+
+ c = case_create (r->spreadsheet.proto);
+ case_set_missing (c);
+
+ while (1 == xmlTextReaderRead (r->rsd.xtr))
+ {
+ process_node (r, &r->rsd);
+
+ if (r->spreadsheet.stop_row != -1 && r->rsd.row > r->spreadsheet.stop_row + 1)
+ break;
+
+ if (r->rsd.state == STATE_CELL &&
+ r->rsd.node_type == XML_READER_TYPE_ELEMENT)
{
- val_string = xmlTextReaderGetAttribute (r->xtr, _xml ("office:value"));
+ type = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value-type"));
+ val_string = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value"));
}
- if ( r->state == STATE_CELL_CONTENT && r->node_type == XML_READER_TYPE_TEXT )
+ if (r->rsd.state == STATE_CELL_CONTENT &&
+ r->rsd.node_type == XML_READER_TYPE_TEXT)
{
int col;
- struct xml_value *xmv = xzalloc (sizeof *xmv);
- xmv->text = xmlTextReaderValue (r->xtr);
+ struct xml_value *xmv = XZALLOC (struct xml_value);
+ xmv->text = xmlTextReaderValue (r->rsd.xtr);
xmv->value = val_string;
val_string = NULL;
+ xmv->type = type;
+ type = NULL;
- for (col = 0; col < r->span ; ++col)
+ for (col = 0; col < r->rsd.col_span; ++col)
{
- const int idx = r->col + col - r->start_col;
-
- const struct variable *var = dict_get_var (r->dict, idx);
-
- convert_xml_to_value (c, var, xmv);
+ const struct variable *var;
+ const int idx = r->rsd.col - col - r->spreadsheet.start_col - 1;
+ if (idx < 0)
+ continue;
+ if (r->spreadsheet.stop_col != -1 && idx > r->spreadsheet.stop_col - r->spreadsheet.start_col)
+ break;
+ if (idx >= dict_get_n_vars (r->spreadsheet.dict))
+ break;
+
+ var = dict_get_var (r->spreadsheet.dict, idx);
+ convert_xml_to_value (c, var, xmv, idx + r->spreadsheet.start_col, r->rsd.row - 1);
}
- free (xmv->text);
- free (xmv->value);
+
+ xmlFree (xmv->text);
+ xmlFree (xmv->value);
+ xmlFree (xmv->type);
free (xmv);
}
-
- if ( r->state < STATE_TABLE)
+ if (r->rsd.state <= STATE_TABLE)
break;
}
- if (NULL == c || (r->stop_row != -1 && r->row > r->stop_row + 1))
+ xmlFree (type);
+ xmlFree (val_string);
+
+ return c;
+}
+
+static bool
+init_reader (struct ods_reader *r, bool report_errors,
+ struct state_data *state)
+{
+ struct spreadsheet *s = SPREADSHEET_CAST (r);
+
+ if (state)
{
- case_unref (c);
- return NULL;
- }
- else
+ struct zip_member *content;
+ char *error = zip_member_open (r->zreader, "content.xml", &content);
+ if (content == NULL)
+ {
+ free (error);
+ return NULL;
+ }
+
+ xmlTextReaderPtr xtr = xmlReaderForIO (xml_reader_for_zip_member, NULL, content, NULL, NULL,
+ report_errors
+ ? 0
+ : (XML_PARSE_NOERROR | XML_PARSE_NOWARNING));
+
+ if (xtr == NULL)
+ return false;
+
+ *state = (struct state_data) { .xtr = xtr,
+ .zm = content,
+ .state = STATE_INIT };
+ if (report_errors)
+ xmlTextReaderSetErrorHandler (xtr, ods_error_handler, r);
+ }
+
+ strcpy (s->type, "ODS");
+ s->destroy = ods_destroy;
+ s->make_reader = ods_make_reader;
+ s->get_sheet_name = ods_get_sheet_name;
+ s->get_sheet_range = ods_get_sheet_range;
+ s->get_sheet_n_sheets = ods_get_sheet_n_sheets;
+ s->get_sheet_n_rows = ods_get_sheet_n_rows;
+ s->get_sheet_n_columns = ods_get_sheet_n_columns;
+ s->get_sheet_cell = ods_get_sheet_cell;
+
+ return true;
+}
+
+struct spreadsheet *
+ods_probe (const char *filename, bool report_errors)
+{
+ struct ods_reader *r = XZALLOC (struct ods_reader);
+
+ struct zip_reader *zr;
+ char *error = zip_reader_create (filename, &zr);
+ if (error)
{
- return c;
+ if (report_errors)
+ {
+ msg (ME, _("Cannot open %s as a OpenDocument file: %s"),
+ filename, error);
+ }
+ free (error);
+ free (r);
+ return NULL;
}
+
+ r->zreader = zr;
+ r->spreadsheet.ref_cnt = 1;
+ hmap_init (&r->cache);
+
+ if (!init_reader (r, report_errors, NULL))
+ goto error;
+
+ r->n_sheets = -1;
+ r->n_allocated_sheets = 0;
+ r->spreadsheet.sheets = NULL;
+
+ r->spreadsheet.file_name = strdup (filename);
+ return &r->spreadsheet;
+
+ error:
+ zip_reader_unref (r->zreader);
+ free (r);
+ return NULL;
}
-#endif