1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2011, 2012, 2013, 2016 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #include "ods-reader.h"
20 #include "spreadsheet-reader.h"
25 #include <libxml/xmlreader.h>
28 #include "data/case.h"
29 #include "data/casereader-provider.h"
30 #include "data/data-in.h"
31 #include "data/dictionary.h"
32 #include "data/format.h"
33 #include "data/identifier.h"
34 #include "data/value.h"
35 #include "data/variable.h"
36 #include "libpspp/assertion.h"
37 #include "libpspp/i18n.h"
38 #include "libpspp/message.h"
39 #include "libpspp/misc.h"
40 #include "libpspp/str.h"
41 #include "libpspp/zip-reader.h"
43 #include "gl/c-strtod.h"
44 #include "gl/minmax.h"
45 #include "gl/xalloc.h"
48 #define _(msgid) gettext (msgid)
49 #define N_(msgid) (msgid)
51 static void ods_file_casereader_destroy (struct casereader *, void *);
52 static struct ccase *ods_file_casereader_read (struct casereader *, void *);
55 static const struct casereader_class ods_file_casereader_class =
57 ods_file_casereader_read,
58 ods_file_casereader_destroy,
65 /* The name of the sheet (utf8 encoding) */
77 STATE_INIT = 0, /* Initial state */
78 STATE_SPREADSHEET, /* Found the start of the spreadsheet doc */
79 STATE_TABLE, /* Found the sheet that we actually want */
80 STATE_ROW, /* Found the start of the cell array */
81 STATE_CELL, /* Found a cell */
82 STATE_CELL_CONTENT /* Found a the text within a cell */
89 enum reader_state state;
93 xmlChar *current_sheet_name;
99 state_data_destroy (struct state_data *sd)
101 xmlFree (sd->current_sheet_name);
102 sd->current_sheet_name = NULL;
104 xmlFreeTextReader (sd->xtr);
110 struct spreadsheet spreadsheet;
111 struct zip_reader *zreader;
113 int target_sheet_index;
114 xmlChar *target_sheet_name;
116 /* State data for the meta data */
117 struct state_data msd;
119 /* State data for the reader */
120 struct state_data rsd;
127 struct sheet_detail *sheets;
128 int n_allocated_sheets;
130 struct caseproto *proto;
131 struct dictionary *dict;
132 struct ccase *first_case;
133 bool used_first_case;
136 struct string ods_errs;
138 struct string zip_errs;
142 ods_unref (struct spreadsheet *s)
144 struct ods_reader *r = (struct ods_reader *) s;
146 if (--s->ref_cnt == 0)
150 state_data_destroy (&r->msd);
151 for (i = 0; i < r->n_allocated_sheets; ++i)
153 xmlFree (r->sheets[i].name);
156 dict_unref (r->dict);
158 zip_reader_destroy (r->zreader);
168 reading_target_sheet (const struct ods_reader *r, const struct state_data *msd)
170 if (r->target_sheet_name != NULL)
172 if ( 0 == xmlStrcmp (r->target_sheet_name, msd->current_sheet_name))
176 if (r->target_sheet_index == msd->current_sheet + 1)
183 static void process_node (struct ods_reader *or, struct state_data *r);
187 ods_get_sheet_name (struct spreadsheet *s, int n)
189 struct ods_reader *r = (struct ods_reader *) s;
190 struct state_data *or = &r->msd;
192 assert (n < s->n_sheets);
195 (r->n_allocated_sheets <= n)
196 || or->state != STATE_SPREADSHEET
199 int ret = xmlTextReaderRead (or->xtr);
203 process_node (r, or);
206 return r->sheets[n].name;
210 ods_get_sheet_range (struct spreadsheet *s, int n)
212 struct ods_reader *r = (struct ods_reader *) s;
213 struct state_data *or = &r->msd;
215 assert (n < s->n_sheets);
218 (r->n_allocated_sheets <= n)
219 || (r->sheets[n].stop_row == -1)
220 || or->state != STATE_SPREADSHEET
223 int ret = xmlTextReaderRead (or->xtr);
227 process_node (r, or);
230 return create_cell_range (
231 r->sheets[n].start_col,
232 r->sheets[n].start_row,
233 r->sheets[n].stop_col,
234 r->sheets[n].stop_row);
239 ods_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
241 struct ods_reader *r = r_;
245 state_data_destroy (&r->rsd);
247 if ( ! ds_is_empty (&r->ods_errs))
248 msg (ME, "%s", ds_cstr (&r->ods_errs));
250 ds_destroy (&r->ods_errs);
252 if ( r->first_case && ! r->used_first_case )
253 case_unref (r->first_case);
256 caseproto_unref (r->proto);
259 xmlFree (r->target_sheet_name);
260 r->target_sheet_name = NULL;
263 ods_unref (&r->spreadsheet);
271 process_node (struct ods_reader *or, struct state_data *r)
273 xmlChar *name = xmlTextReaderName (r->xtr);
275 name = xmlStrdup (_xml ("--"));
278 r->node_type = xmlTextReaderNodeType (r->xtr);
283 if (0 == xmlStrcasecmp (name, _xml("office:spreadsheet")) &&
284 XML_READER_TYPE_ELEMENT == r->node_type)
286 r->state = STATE_SPREADSHEET;
287 r->current_sheet = -1;
288 r->current_sheet_name = NULL;
291 case STATE_SPREADSHEET:
292 if (0 == xmlStrcasecmp (name, _xml("table:table"))
294 (XML_READER_TYPE_ELEMENT == r->node_type))
296 xmlFree (r->current_sheet_name);
297 r->current_sheet_name = xmlTextReaderGetAttribute (r->xtr, _xml ("table:name"));
301 if (r->current_sheet >= or->n_allocated_sheets)
303 assert (r->current_sheet == or->n_allocated_sheets);
304 or->sheets = xrealloc (or->sheets, sizeof (*or->sheets) * ++or->n_allocated_sheets);
305 or->sheets[or->n_allocated_sheets - 1].start_col = -1;
306 or->sheets[or->n_allocated_sheets - 1].stop_col = -1;
307 or->sheets[or->n_allocated_sheets - 1].start_row = -1;
308 or->sheets[or->n_allocated_sheets - 1].stop_row = -1;
309 or->sheets[or->n_allocated_sheets - 1].name = CHAR_CAST (char *, xmlStrdup (r->current_sheet_name));
315 r->state = STATE_TABLE;
317 else if (0 == xmlStrcasecmp (name, _xml("office:spreadsheet")) &&
318 XML_READER_TYPE_ELEMENT == r->node_type)
320 r->state = STATE_INIT;
324 if (0 == xmlStrcasecmp (name, _xml("table:table-row")) &&
325 (XML_READER_TYPE_ELEMENT == r->node_type))
328 xmlTextReaderGetAttribute (r->xtr,
329 _xml ("table:number-rows-repeated"));
331 int row_span = value ? _xmlchar_to_int (value) : 1;
336 if (! xmlTextReaderIsEmptyElement (r->xtr))
337 r->state = STATE_ROW;
341 else if (0 == xmlStrcasecmp (name, _xml("table:table")) &&
342 (XML_READER_TYPE_END_ELEMENT == r->node_type))
344 r->state = STATE_SPREADSHEET;
348 if ( (0 == xmlStrcasecmp (name, _xml ("table:table-cell")))
350 (XML_READER_TYPE_ELEMENT == r->node_type))
353 xmlTextReaderGetAttribute (r->xtr,
354 _xml ("table:number-columns-repeated"));
356 r->col_span = value ? _xmlchar_to_int (value) : 1;
357 r->col += r->col_span;
359 if (! xmlTextReaderIsEmptyElement (r->xtr))
360 r->state = STATE_CELL;
364 else if ( (0 == xmlStrcasecmp (name, _xml ("table:table-row")))
366 (XML_READER_TYPE_END_ELEMENT == r->node_type))
368 r->state = STATE_TABLE;
372 if ( (0 == xmlStrcasecmp (name, _xml("text:p")))
374 ( XML_READER_TYPE_ELEMENT == r->node_type))
376 if (! xmlTextReaderIsEmptyElement (r->xtr))
377 r->state = STATE_CELL_CONTENT;
380 ( (0 == xmlStrcasecmp (name, _xml("table:table-cell")))
382 (XML_READER_TYPE_END_ELEMENT == r->node_type)
385 r->state = STATE_ROW;
388 case STATE_CELL_CONTENT:
389 assert (r->current_sheet >= 0);
390 assert (r->current_sheet < or->n_allocated_sheets);
392 if (or->sheets[r->current_sheet].start_row == -1)
393 or->sheets[r->current_sheet].start_row = r->row - 1;
396 (or->sheets[r->current_sheet].start_col == -1)
398 (or->sheets[r->current_sheet].start_col >= r->col - 1)
400 or->sheets[r->current_sheet].start_col = r->col - 1;
402 or->sheets[r->current_sheet].stop_row = r->row - 1;
404 if ( or->sheets[r->current_sheet].stop_col < r->col - 1)
405 or->sheets[r->current_sheet].stop_col = r->col - 1;
407 if (XML_READER_TYPE_END_ELEMENT == r->node_type)
408 r->state = STATE_CELL;
419 A struct containing the parameters of a cell's value
432 struct xml_value firstval;
436 /* Determine the width that a xmv should probably have */
438 xmv_to_width (const struct xml_value *xmv, int fallback)
440 int width = SPREADSHEET_DEFAULT_WIDTH;
442 /* Non-strings always have zero width */
443 if (xmv->type != NULL && 0 != xmlStrcmp (xmv->type, _xml("string")))
450 width = ROUND_UP (xmlStrlen (xmv->value),
451 SPREADSHEET_DEFAULT_WIDTH);
453 width = ROUND_UP (xmlStrlen (xmv->text),
454 SPREADSHEET_DEFAULT_WIDTH);
460 Sets the VAR of case C, to the value corresponding to the xml data
463 convert_xml_to_value (struct ccase *c, const struct variable *var,
464 const struct xml_value *xmv, int col, int row)
466 union value *v = case_data_rw (c, var);
468 if (xmv->value == NULL && xmv->text == NULL)
469 value_set_missing (v, var_get_width (var));
470 else if ( var_is_alpha (var))
471 /* Use the text field, because it seems that there is no
472 value field for strings */
473 value_copy_str_rpad (v, var_get_width (var), xmv->text, ' ');
476 const struct fmt_spec *fmt = var_get_write_format (var);
477 enum fmt_category fc = fmt_get_category (fmt->type);
479 assert ( fc != FMT_CAT_STRING);
481 if ( 0 == xmlStrcmp (xmv->type, _xml("float")))
483 v->f = c_strtod (CHAR_CAST (const char *, xmv->value), NULL);
487 const char *text = xmv->value ?
488 CHAR_CAST (const char *, xmv->value) : CHAR_CAST (const char *, xmv->text);
490 char *m = data_in (ss_cstr (text), "UTF-8",
498 char buf [FMT_STRING_LEN_MAX + 1];
499 char *cell = create_cell_ref (col, row);
501 msg (MW, _("Cannot convert the value in the spreadsheet cell %s to format (%s): %s"),
502 cell, fmt_to_string (fmt, buf), m);
511 xml_reader_for_zip_member (void *zm_, char *buffer, int len)
513 struct zip_member *zm = zm_;
514 return zip_member_read (zm, buffer, len);
517 /* Try to find out how many sheets there are in the "workbook" */
519 get_sheet_count (struct zip_reader *zreader)
521 xmlTextReaderPtr mxtr;
522 struct zip_member *meta = NULL;
523 meta = zip_member_open (zreader, "meta.xml");
528 mxtr = xmlReaderForIO (xml_reader_for_zip_member, NULL, meta, NULL, NULL, 0);
530 while (1 == xmlTextReaderRead (mxtr))
532 xmlChar *name = xmlTextReaderName (mxtr);
533 if ( 0 == xmlStrcmp (name, _xml("meta:document-statistic")))
535 xmlChar *attr = xmlTextReaderGetAttribute (mxtr, _xml ("meta:table-count"));
539 int s = _xmlchar_to_int (attr);
540 xmlFreeTextReader (mxtr);
550 xmlFreeTextReader (mxtr);
555 ods_error_handler (void *ctx, const char *mesg,
556 xmlParserSeverities sev UNUSED,
557 xmlTextReaderLocatorPtr loc)
559 struct ods_reader *r = ctx;
561 msg (MW, _("There was a problem whilst reading the %s file `%s' (near line %d): `%s'"),
563 r->spreadsheet.file_name,
564 xmlTextReaderLocatorLineNumber (loc),
569 static xmlTextReaderPtr
570 init_reader (struct ods_reader *r, bool report_errors)
572 struct zip_member *content = zip_member_open (r->zreader, "content.xml");
573 xmlTextReaderPtr xtr;
575 if ( content == NULL)
578 xtr = xmlReaderForIO (xml_reader_for_zip_member, NULL, content, NULL, NULL,
579 report_errors ? 0 : (XML_PARSE_NOERROR | XML_PARSE_NOWARNING) );
585 r->spreadsheet.type = SPREADSHEET_ODS;
588 xmlTextReaderSetErrorHandler (xtr, ods_error_handler, r);
596 ods_probe (const char *filename, bool report_errors)
599 struct ods_reader *r = xzalloc (sizeof *r);
600 xmlTextReaderPtr xtr;
601 struct zip_reader *zr;
603 ds_init_empty (&r->zip_errs);
605 zr = zip_reader_create (filename, &r->zip_errs);
611 msg (ME, _("Cannot open %s as a OpenDocument file: %s"),
612 filename, ds_cstr (&r->zip_errs));
614 ds_destroy (&r->zip_errs);
619 sheet_count = get_sheet_count (zr);
622 r->spreadsheet.ref_cnt = 1;
624 xtr = init_reader (r, report_errors);
632 r->msd.current_sheet = 0;
633 r->msd.state = STATE_INIT;
636 r->spreadsheet.n_sheets = sheet_count;
637 r->n_allocated_sheets = 0;
640 r->spreadsheet.file_name = strdup (filename);
641 return &r->spreadsheet;
644 ds_destroy (&r->zip_errs);
645 zip_reader_destroy (r->zreader);
651 ods_make_reader (struct spreadsheet *spreadsheet,
652 const struct spreadsheet_read_options *opts)
655 xmlChar *type = NULL;
656 unsigned long int vstart = 0;
657 casenumber n_cases = CASENUMBER_MAX;
659 struct var_spec *var_spec = NULL;
661 xmlTextReaderPtr xtr;
663 struct ods_reader *r = (struct ods_reader *) spreadsheet;
664 xmlChar *val_string = NULL;
667 r->read_names = opts->read_names;
668 ds_init_empty (&r->ods_errs);
669 ++r->spreadsheet.ref_cnt;
671 xtr = init_reader (r, true);
678 r->rsd.current_sheet = 0;
679 r->rsd.state = STATE_INIT;
681 r->used_first_case = false;
682 r->first_case = NULL;
684 if (opts->cell_range)
686 if ( ! convert_cell_ref (opts->cell_range,
687 &r->start_col, &r->start_row,
688 &r->stop_col, &r->stop_row))
690 msg (SE, _("Invalid cell range `%s'"),
703 r->target_sheet_name = xmlStrdup (BAD_CAST opts->sheet_name);
704 r->target_sheet_index = opts->sheet_index;
706 /* Advance to the start of the cells for the target sheet */
707 while ( ! reading_target_sheet (r, &r->rsd)
708 || r->rsd.state != STATE_ROW || r->rsd.row <= r->start_row )
710 if (1 != (ret = xmlTextReaderRead (r->rsd.xtr)))
713 process_node (r, &r->rsd);
718 msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
719 spreadsheet->file_name);
723 if ( opts->read_names)
725 while (1 == xmlTextReaderRead (r->rsd.xtr))
727 process_node (r, &r->rsd);
729 /* If the row is finished then stop for now */
730 if (r->rsd.state == STATE_TABLE && r->rsd.row > r->start_row)
733 int idx = r->rsd.col - r->start_col - 1;
738 if (r->stop_col != -1 && idx > r->stop_col - r->start_col)
741 if (r->rsd.state == STATE_CELL_CONTENT
743 XML_READER_TYPE_TEXT == r->rsd.node_type)
745 xmlChar *value = xmlTextReaderValue (r->rsd.xtr);
746 if (idx >= n_var_specs)
748 var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
750 /* xrealloc (unlike realloc) doesn't initialise its memory to 0 */
751 memset (var_spec + n_var_specs,
753 (idx - n_var_specs + 1) * sizeof (*var_spec));
754 n_var_specs = idx + 1;
756 for (int i = 0; i < r->rsd.col_span; ++i)
758 var_spec[idx - i].firstval.text = 0;
759 var_spec[idx - i].firstval.value = 0;
760 var_spec[idx - i].firstval.type = 0;
761 var_spec[idx - i].name =
762 strdup (CHAR_CAST (const char *, value));
770 /* Read in the first row of data */
771 while (1 == xmlTextReaderRead (r->rsd.xtr))
774 process_node (r, &r->rsd);
776 if ( ! reading_target_sheet (r, &r->rsd) )
779 /* If the row is finished then stop for now */
780 if (r->rsd.state == STATE_TABLE &&
781 r->rsd.row > r->start_row + (opts->read_names ? 1 : 0))
784 idx = r->rsd.col - r->start_col - 1;
788 if (r->stop_col != -1 && idx > r->stop_col - r->start_col)
791 if ( r->rsd.state == STATE_CELL &&
792 XML_READER_TYPE_ELEMENT == r->rsd.node_type)
794 type = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value-type"));
795 val_string = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value"));
798 if ( r->rsd.state == STATE_CELL_CONTENT &&
799 XML_READER_TYPE_TEXT == r->rsd.node_type)
801 if (idx >= n_var_specs)
803 var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
804 memset (var_spec + n_var_specs,
806 (idx - n_var_specs + 1) * sizeof (*var_spec));
808 var_spec [idx].name = NULL;
809 n_var_specs = idx + 1;
812 var_spec [idx].firstval.type = type;
813 var_spec [idx].firstval.text = xmlTextReaderValue (r->rsd.xtr);
814 var_spec [idx].firstval.value = val_string;
822 /* Create the dictionary and populate it */
823 r->spreadsheet.dict = r->dict = dict_create (
824 CHAR_CAST (const char *, xmlTextReaderConstEncoding (r->rsd.xtr)));
826 for (i = 0; i < n_var_specs ; ++i )
829 struct variable *var = NULL;
830 char *name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
831 int width = xmv_to_width (&var_spec[i].firstval, opts->asw);
832 dict_create_var (r->dict, name, width);
835 var = dict_get_var (r->dict, i);
837 if ( 0 == xmlStrcmp (var_spec[i].firstval.type, _xml("date")))
844 fmt = fmt_default_for_width (width);
846 var_set_both_formats (var, &fmt);
849 if ( n_var_specs == 0 )
851 msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
852 spreadsheet->file_name);
856 /* Create the first case, and cache it */
857 r->proto = caseproto_ref (dict_get_proto (r->dict));
858 r->first_case = case_create (r->proto);
859 case_set_missing (r->first_case);
861 for (i = 0 ; i < n_var_specs; ++i)
863 const struct variable *var = dict_get_var (r->dict, i);
865 convert_xml_to_value (r->first_case, var, &var_spec[i].firstval,
866 r->rsd.col - n_var_specs + i,
870 /* Read in the first row of data */
871 while (1 == xmlTextReaderRead (r->rsd.xtr))
873 process_node (r, &r->rsd);
875 if (r->rsd.state == STATE_ROW)
880 for ( i = 0 ; i < n_var_specs ; ++i )
882 free (var_spec[i].firstval.type);
883 free (var_spec[i].firstval.value);
884 free (var_spec[i].firstval.text);
885 free (var_spec[i].name);
891 return casereader_create_sequential
895 &ods_file_casereader_class, r);
899 for ( i = 0 ; i < n_var_specs ; ++i )
901 free (var_spec[i].firstval.type);
902 free (var_spec[i].firstval.value);
903 free (var_spec[i].firstval.text);
904 free (var_spec[i].name);
909 ods_file_casereader_destroy (NULL, r);
915 /* Reads and returns one case from READER's file. Returns a null
916 pointer on failure. */
917 static struct ccase *
918 ods_file_casereader_read (struct casereader *reader UNUSED, void *r_)
920 struct ccase *c = NULL;
921 struct ods_reader *r = r_;
923 xmlChar *val_string = NULL;
924 xmlChar *type = NULL;
926 if (!r->used_first_case)
928 r->used_first_case = true;
929 return r->first_case;
933 /* Advance to the start of a row. (If there is one) */
934 while (r->rsd.state != STATE_ROW
935 && 1 == xmlTextReaderRead (r->rsd.xtr)
938 process_node (r, &r->rsd);
942 if ( ! reading_target_sheet (r, &r->rsd)
943 || r->rsd.state < STATE_TABLE
944 || (r->stop_row != -1 && r->rsd.row > r->stop_row + 1)
950 c = case_create (r->proto);
951 case_set_missing (c);
953 while (1 == xmlTextReaderRead (r->rsd.xtr))
955 process_node (r, &r->rsd);
957 if ( r->stop_row != -1 && r->rsd.row > r->stop_row + 1)
960 if (r->rsd.state == STATE_CELL &&
961 r->rsd.node_type == XML_READER_TYPE_ELEMENT)
963 type = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value-type"));
964 val_string = xmlTextReaderGetAttribute (r->rsd.xtr, _xml ("office:value"));
967 if (r->rsd.state == STATE_CELL_CONTENT &&
968 r->rsd.node_type == XML_READER_TYPE_TEXT)
971 struct xml_value *xmv = xzalloc (sizeof *xmv);
972 xmv->text = xmlTextReaderValue (r->rsd.xtr);
973 xmv->value = val_string;
978 for (col = 0; col < r->rsd.col_span; ++col)
980 const struct variable *var;
981 const int idx = r->rsd.col - col - r->start_col - 1;
984 if (r->stop_col != -1 && idx > r->stop_col - r->start_col )
986 if (idx >= dict_get_var_cnt (r->dict))
989 var = dict_get_var (r->dict, idx);
990 convert_xml_to_value (c, var, xmv, idx + r->start_col, r->rsd.row - 1);
994 xmlFree (xmv->value);
998 if ( r->rsd.state <= STATE_TABLE)
1003 xmlFree (val_string);