Added a reopen capability
[pspp] / src / data / gnumeric-reader.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007, 2009, 2010, 2011, 2012, 2013  Free Software Foundation, Inc.
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include "libpspp/message.h"
20 #include "libpspp/misc.h"
21
22 #include "gl/minmax.h"
23 #include "gl/c-strtod.h"
24
25 #include "gettext.h"
26 #define _(msgid) gettext (msgid)
27 #define N_(msgid) (msgid)
28
29 #include "spreadsheet-reader.h"
30
31 #include "c-xvasprintf.h"
32
33 #if !GNM_SUPPORT
34
35 struct casereader *
36 gnumeric_open_reader (struct spreadsheet_read_info *gri, struct spreadsheet_read_options *opts, struct dictionary **dict)
37 {
38   msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "Gnumeric");
39
40   return NULL;
41 }
42
43 #else
44
45 #include "data/gnumeric-reader.h"
46
47 #include <assert.h>
48 #include <stdbool.h>
49 #include <errno.h>
50 #include <libxml/xmlreader.h>
51 #include <zlib.h>
52
53 #include "data/case.h"
54 #include "data/casereader-provider.h"
55 #include "data/dictionary.h"
56 #include "data/identifier.h"
57 #include "data/value.h"
58 #include "data/variable.h"
59 #include "libpspp/i18n.h"
60 #include "libpspp/str.h"
61
62 #include "gl/xalloc.h"
63
64 static void gnm_file_casereader_destroy (struct casereader *, void *);
65
66 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
67
68 static const struct casereader_class gnm_file_casereader_class =
69   {
70     gnm_file_casereader_read,
71     gnm_file_casereader_destroy,
72     NULL,
73     NULL,
74   };
75
76 enum reader_state
77   {
78     STATE_PRE_INIT = 0,        /* Initial state */
79     STATE_SHEET_COUNT,      /* Found the sheet index */
80     STATE_INIT ,           /* Other Initial state */
81     STATE_SHEET_START,     /* Found the start of a sheet */
82     STATE_SHEET_NAME,      /* Found the sheet name */
83     STATE_MAXROW,
84     STATE_MAXCOL,
85     STATE_SHEET_FOUND,     /* Found the sheet that we actually want */
86     STATE_CELLS_START,     /* Found the start of the cell array */
87     STATE_CELL             /* Found a cell */
88   };
89
90 struct sheet_detail
91 {
92   xmlChar *name;
93
94   int start_col;
95   int stop_col;
96   int start_row;
97   int stop_row;
98
99   int maxcol;
100   int maxrow;
101 };
102
103
104 struct gnumeric_reader
105 {
106   struct spreadsheet spreadsheet;
107
108   /* The libxml reader for this instance */
109   xmlTextReaderPtr xtr;
110
111   /* An internal state variable */
112   enum reader_state state;
113
114   int row;
115   int col;
116   int min_col;
117   int node_type;
118   int sheet_index;
119
120   int start_col;
121   int stop_col;
122   int start_row;
123   int stop_row;
124   
125   struct sheet_detail *sheets;
126
127   const xmlChar *target_sheet;
128   int target_sheet_index;
129
130   struct caseproto *proto;
131   struct dictionary *dict;
132   struct ccase *first_case;
133   bool used_first_case;
134 };
135
136
137 const char *
138 gnumeric_get_sheet_name (struct spreadsheet *s, int n)
139 {
140   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
141   assert (n < s->sheets);
142
143   return gr->sheets[n].name;
144 }
145
146
147 static void process_node (struct gnumeric_reader *r);
148
149
150 char *
151 gnumeric_get_sheet_range (struct spreadsheet *s, int n)
152 {
153   int ret;
154   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
155   
156   assert (n < s->sheets);
157
158   while ( 
159          (gr->sheets[n].stop_col == -1)
160          && 
161          (1 == (ret = xmlTextReaderRead (gr->xtr)))
162           )
163     {
164       process_node (gr);
165     }
166
167
168   return create_cell_ref (
169                           gr->sheets[n].start_col,
170                           gr->sheets[n].start_row,
171                           gr->sheets[n].stop_col,
172                           gr->sheets[n].stop_row);
173 }
174
175
176 static void
177 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
178 {
179   int i;
180   struct gnumeric_reader *r = r_;
181   if ( r == NULL)
182         return ;
183
184   if ( r->xtr)
185     xmlFreeTextReader (r->xtr);
186
187   if ( ! r->used_first_case )
188     case_unref (r->first_case);
189
190   caseproto_unref (r->proto);
191
192   for (i = 0; i < r->spreadsheet.sheets; ++i)
193     {
194       xmlFree (r->sheets[i].name);
195     }
196     
197   free (r->sheets);
198
199   free (r);
200 }
201
202 static void
203 process_node (struct gnumeric_reader *r)
204 {
205   xmlChar *name = xmlTextReaderName (r->xtr);
206   if (name == NULL)
207     name = xmlStrdup (_xml ("--"));
208
209
210   r->node_type = xmlTextReaderNodeType (r->xtr);
211
212   switch ( r->state)
213     {
214     case STATE_PRE_INIT:
215       r->sheet_index = -1;
216       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
217           XML_READER_TYPE_ELEMENT  == r->node_type)
218         {
219           r->state = STATE_SHEET_COUNT;
220           r->spreadsheet.sheets = 0;
221         }
222       break;
223
224     case STATE_SHEET_COUNT:
225       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetName")) &&
226           XML_READER_TYPE_ELEMENT  == r->node_type)
227         {
228           struct sheet_detail *sd ;
229           r->spreadsheet.sheets++;
230           r->sheets = xrealloc (r->sheets, r->spreadsheet.sheets * sizeof *r->sheets);
231           sd = &r->sheets[r->spreadsheet.sheets - 1];
232           sd->start_col = sd->stop_col = sd->start_row = sd->stop_row = -1;
233         }
234       else if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
235           XML_READER_TYPE_END_ELEMENT  == r->node_type)
236         {
237           r->state = STATE_INIT;
238         }
239       else if (XML_READER_TYPE_TEXT == r->node_type)
240         {
241           r->sheets [r->spreadsheet.sheets - 1].name = xmlTextReaderValue (r->xtr);
242         }
243       break;
244
245     case STATE_INIT:
246       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
247           XML_READER_TYPE_ELEMENT  == r->node_type)
248         {
249           ++r->sheet_index;
250           r->state = STATE_SHEET_START;
251         }
252       break;
253     case STATE_SHEET_START:
254       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
255           XML_READER_TYPE_ELEMENT  == r->node_type)
256         {
257           r->state = STATE_SHEET_NAME;
258         }
259       break;
260     case STATE_SHEET_NAME:
261       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
262           XML_READER_TYPE_END_ELEMENT  == r->node_type)
263         {
264           r->state = STATE_INIT;
265         }
266       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
267           XML_READER_TYPE_END_ELEMENT  == r->node_type)
268         {
269           r->state = STATE_INIT;
270         }
271       else if (XML_READER_TYPE_TEXT == r->node_type)
272         {
273           if ( r->target_sheet != NULL)
274             {
275               xmlChar *value = xmlTextReaderValue (r->xtr);
276               if ( 0 == xmlStrcmp (value, r->target_sheet))
277                 r->state = STATE_SHEET_FOUND;
278               free (value);
279             }
280           else if (r->target_sheet_index == r->sheet_index + 1)
281             {
282               r->state = STATE_SHEET_FOUND;
283             }
284           else if (r->target_sheet_index == -1)
285             {
286               r->state = STATE_SHEET_FOUND;
287             }
288         }
289       break;
290     case STATE_SHEET_FOUND:
291       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
292           XML_READER_TYPE_ELEMENT  == r->node_type)
293         {
294           r->min_col = INT_MAX;
295           if (! xmlTextReaderIsEmptyElement (r->xtr))
296             r->state = STATE_CELLS_START;
297         }
298       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
299           XML_READER_TYPE_ELEMENT  == r->node_type)
300         {
301           r->state = STATE_MAXROW;
302         }
303       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
304           XML_READER_TYPE_ELEMENT  == r->node_type)
305         {
306           r->state = STATE_MAXCOL;
307         }
308       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
309           XML_READER_TYPE_END_ELEMENT  == r->node_type)
310         {
311           r->state = STATE_INIT;
312         }
313       break;
314     case STATE_MAXROW:
315       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
316           XML_READER_TYPE_END_ELEMENT  == r->node_type)
317         {
318           r->state = STATE_SHEET_FOUND;
319         }
320       else if (r->node_type == XML_READER_TYPE_TEXT)
321         {
322           xmlChar *value = xmlTextReaderValue (r->xtr);
323           r->sheets[r->sheet_index].maxrow = _xmlchar_to_int (value);
324           xmlFree (value);
325         }
326       break;
327     case STATE_MAXCOL:
328       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
329           XML_READER_TYPE_END_ELEMENT  == r->node_type)
330         {
331           r->state = STATE_SHEET_FOUND;
332         }
333       else if (r->node_type == XML_READER_TYPE_TEXT)
334         {
335           xmlChar *value = xmlTextReaderValue (r->xtr);
336           r->sheets[r->sheet_index].maxcol = _xmlchar_to_int (value);
337           xmlFree (value);
338         }
339       break;
340     case STATE_CELLS_START:
341       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
342           XML_READER_TYPE_ELEMENT  == r->node_type)
343         {
344           xmlChar *attr = NULL;
345           r->state = STATE_CELL;
346
347           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
348           r->col =  _xmlchar_to_int (attr);
349           free (attr);
350
351           if (r->col < r->min_col)
352             r->min_col = r->col;
353
354           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
355           r->row = _xmlchar_to_int (attr);
356           free (attr);
357           if (r->sheets[r->sheet_index].start_row == -1)
358             {
359               r->sheets[r->sheet_index].start_row = r->row;
360             }
361
362           if (r->sheets[r->sheet_index].start_col == -1)
363             {
364               r->sheets[r->sheet_index].start_col = r->col;
365             }
366         }
367       else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
368                XML_READER_TYPE_END_ELEMENT  == r->node_type)
369         {
370           r->sheets[r->sheet_index].stop_col = r->col;
371           r->sheets[r->sheet_index].stop_row = r->row;
372           r->state = STATE_SHEET_NAME;
373         }
374       break;
375     case STATE_CELL:
376       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  &&
377                               XML_READER_TYPE_END_ELEMENT  == r->node_type)
378         {
379           r->state = STATE_CELLS_START;
380         }
381       break;
382     default:
383       break;
384     };
385
386   xmlFree (name);
387 }
388
389
390 /*
391    Sets the VAR of case C, to the value corresponding to the xml string XV
392  */
393 static void
394 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
395                              const xmlChar *xv)
396 {
397   union value *v = case_data_rw (c, var);
398
399   if (xv == NULL)
400     value_set_missing (v, var_get_width (var));
401   else if ( var_is_alpha (var))
402     value_copy_str_rpad (v, var_get_width (var), xv, ' ');
403   else
404     {
405       const char *text = CHAR_CAST (const char *, xv);
406       char *endptr;
407
408       errno = 0;
409       v->f = c_strtod (text, &endptr);
410       if ( errno != 0 || endptr == text)
411         v->f = SYSMIS;
412     }
413 }
414
415 struct var_spec
416 {
417   char *name;
418   int width;
419   xmlChar *first_value;
420 };
421
422
423 void 
424 gnumeric_destroy (struct spreadsheet *s)
425 {
426   struct gnumeric_reader *r = (struct gnumeric *) s;
427   gnm_file_casereader_destroy (NULL, s);
428 }
429
430
431 static struct gnumeric_reader *
432 gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
433 {  
434   int ret;
435
436   xmlTextReaderPtr xtr;
437   gzFile gz;
438
439   assert (r == NULL || filename == NULL);
440
441   if (r && r->xtr)
442     xmlFreeTextReader (r->xtr);
443
444   if (filename)
445     gz = gzopen (filename, "r");
446   else
447     gz = gzopen ( r->spreadsheet.file_name, "r");
448
449   if (NULL == gz)
450     return NULL;
451
452   xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
453                            (xmlInputCloseCallback) gzclose, gz,
454                            NULL, NULL, 0);
455
456   if (xtr == NULL)
457     {
458       gzclose (gz);
459       return NULL;
460     }
461
462   if (r == NULL)
463     r = xzalloc (sizeof *r);
464
465   r->xtr = xtr;
466   r->spreadsheet.sheets = -1;
467   r->state = STATE_PRE_INIT;
468
469   r->target_sheet = NULL;
470   r->target_sheet_index = -1;
471
472
473   /* Advance to the start of the workbook.
474      This gives us some confidence that we are actually dealing with a gnumeric
475      spreadsheet.
476    */
477   while ( (r->state != STATE_INIT )
478           && 1 == (ret = xmlTextReaderRead (r->xtr)))
479     {
480       process_node (r);
481     }
482
483   r->spreadsheet.type = SPREADSHEET_GNUMERIC;
484
485   if (filename)
486     r->spreadsheet.file_name = filename;
487
488   return r;
489 }
490
491
492 struct spreadsheet *
493 gnumeric_probe (const char *filename)
494 {
495   struct gnumeric_reader *r = NULL;
496   
497   r = gnumeric_reopen (r, filename);
498   
499   return &r->spreadsheet;
500 }
501
502
503 struct casereader *
504 gnumeric_make_reader (struct spreadsheet *spreadsheet,
505                       const struct spreadsheet_read_info *gri, 
506                       struct spreadsheet_read_options *opts)
507 {
508   struct gnumeric_reader *r = NULL;
509   unsigned long int vstart = 0;
510   int ret;
511   casenumber n_cases = CASENUMBER_MAX;
512   int i;
513   struct var_spec *var_spec = NULL;
514   int n_var_specs = 0;
515
516   r = (struct gnumeric_reader *) (spreadsheet);
517
518   if ( opts->cell_range )
519     {
520       if ( ! convert_cell_ref (opts->cell_range,
521                                &r->start_col, &r->start_row,
522                                &r->stop_col, &r->stop_row))
523         {
524           msg (SE, _("Invalid cell range `%s'"),
525                opts->cell_range);
526           goto error;
527         }
528     }
529   else
530     {
531       r->start_col = -1;
532       r->start_row = 0;
533       r->stop_col = -1;
534       r->stop_row = -1;
535     }
536
537   r->target_sheet = BAD_CAST opts->sheet_name;
538   r->target_sheet_index = opts->sheet_index;
539   r->row = r->col = -1;
540   r->sheet_index = -1;
541
542   /* Advance to the start of the cells for the target sheet */
543   while ( (r->state != STATE_CELL || r->row < r->start_row )
544           && 1 == (ret = xmlTextReaderRead (r->xtr)))
545     {
546       xmlChar *value ;
547       process_node (r);
548       value = xmlTextReaderValue (r->xtr);
549
550       if ( r->state == STATE_MAXROW  && r->node_type == XML_READER_TYPE_TEXT)
551         {
552           n_cases = 1 + _xmlchar_to_int (value) ;
553         }
554       free (value);
555     }
556
557   /* If a range has been given, then  use that to calculate the number
558      of cases */
559   if ( opts->cell_range)
560     {
561       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
562     }
563
564   if ( gri->read_names )
565     {
566       r->start_row++;
567       n_cases --;
568     }
569
570   /* Read in the first row of cells,
571      including the headers if read_names was set */
572   while (
573          (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
574          && (ret = xmlTextReaderRead (r->xtr))
575          )
576     {
577       int idx;
578       process_node (r);
579
580       if ( r->row > r->start_row ) break;
581
582       if ( r->col < r->start_col ||
583            (r->stop_col != -1 && r->col > r->stop_col))
584         continue;
585
586       idx = r->col - r->start_col;
587
588       if ( idx  >= n_var_specs )
589         {
590           int i;
591           var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
592           for (i = n_var_specs; i <= idx; ++i)
593           {
594             var_spec [i].name = NULL;
595             var_spec [i].width = -1;
596             var_spec [i].first_value = NULL;
597           }
598           n_var_specs =  idx + 1 ;
599         }
600
601       if ( r->node_type == XML_READER_TYPE_TEXT )
602         {
603           xmlChar *value = xmlTextReaderValue (r->xtr);
604           const char *text  = CHAR_CAST (const char *, value);
605
606           if ( r->row < r->start_row)
607             {
608               if ( gri->read_names )
609                 {
610                   var_spec [idx].name = xstrdup (text);
611                 }
612             }
613           else
614             {
615               var_spec [idx].first_value = xmlStrdup (value);
616
617               if (-1 ==  var_spec [idx].width )
618                 var_spec [idx].width = (gri->asw == -1) ?
619                   ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : gri->asw;
620             }
621
622           free (value);
623         }
624       else if ( r->node_type == XML_READER_TYPE_ELEMENT
625                 && r->state == STATE_CELL)
626         {
627           if ( r->row == r->start_row )
628             {
629               xmlChar *attr =
630                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
631
632               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
633                 var_spec [idx].width = 0;
634
635               free (attr);
636             }
637         }
638     }
639
640   {
641     const xmlChar *enc = xmlTextReaderConstEncoding (r->xtr);
642     if ( enc == NULL)
643       goto error;
644     /* Create the dictionary and populate it */
645     spreadsheet->dict = r->dict = dict_create (CHAR_CAST (const char *, enc));
646   }
647
648   for (i = 0 ; i < n_var_specs ; ++i )
649     {
650       char *name;
651
652       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
653         continue;
654
655       /* Probably no data exists for this variable, so allocate a
656          default width */
657       if ( var_spec[i].width == -1 )
658         var_spec[i].width = SPREADSHEET_DEFAULT_WIDTH;
659
660       name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
661       dict_create_var (r->dict, name, var_spec[i].width);
662       free (name);
663     }
664
665   /* Create the first case, and cache it */
666   r->used_first_case = false;
667
668   if ( n_var_specs ==  0 )
669     {
670       msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
671            spreadsheet->file_name);
672       goto error;
673     }
674
675   r->proto = caseproto_ref (dict_get_proto (r->dict));
676   r->first_case = case_create (r->proto);
677   case_set_missing (r->first_case);
678
679   int x = 0;
680   for ( i = 0 ; i < n_var_specs ; ++i )
681     {
682       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
683         continue;
684
685       const struct variable *var = dict_get_var (r->dict, x++);
686
687       convert_xml_string_to_value (r->first_case, var,
688                                    var_spec[i].first_value);
689     }
690
691   for ( i = 0 ; i < n_var_specs ; ++i )
692     {
693       free (var_spec[i].first_value);
694       free (var_spec[i].name);
695     }
696
697   free (var_spec);
698   
699   
700   if (opts->cell_range == NULL)
701     {
702       opts->cell_range = c_xasprintf ("%c%d:%c%ld", 
703                                        r->start_col + 'A',
704                                        r->start_row,
705                                        r->stop_col + 'A' + caseproto_get_n_widths (r->proto),
706                                        r->start_row + n_cases);
707     }
708   
709   return casereader_create_sequential
710     (NULL,
711      r->proto,
712      n_cases,
713      &gnm_file_casereader_class, r);
714
715
716  error:
717   for ( i = 0 ; i < n_var_specs ; ++i )
718     {
719       free (var_spec[i].first_value);
720       free (var_spec[i].name);
721     }
722
723   free (var_spec);
724   dict_destroy (spreadsheet->dict);
725   spreadsheet->dict = NULL;
726
727   gnm_file_casereader_destroy (NULL, r);
728
729   return NULL;
730 };
731
732
733 /* Reads and returns one case from READER's file.  Returns a null
734    pointer on failure. */
735 static struct ccase *
736 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_)
737 {
738   struct ccase *c;
739   int ret = 0;
740
741   struct gnumeric_reader *r = r_;
742   int current_row = r->row;
743
744   if ( !r->used_first_case )
745     {
746       r->used_first_case = true;
747       return r->first_case;
748     }
749
750   c = case_create (r->proto);
751   case_set_missing (c);
752
753   if (r->start_col == -1)
754     r->start_col = r->min_col;
755
756   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
757          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
758     {
759       process_node (r);
760
761       if ( r->col < r->start_col || (r->stop_col != -1 &&
762                                      r->col > r->stop_col))
763         continue;
764
765       if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
766         continue;
767
768       if ( r->stop_row != -1 && r->row > r->stop_row)
769         break;
770
771       if ( r->node_type == XML_READER_TYPE_TEXT )
772         {
773           xmlChar *value = xmlTextReaderValue (r->xtr);
774
775           const int idx = r->col - r->start_col;
776
777           const struct variable *var = dict_get_var (r->dict, idx);
778
779           convert_xml_string_to_value (c, var, value);
780
781           free (value);
782         }
783
784     }
785
786   if (ret == 1)
787     return c;
788   else
789     {
790       case_unref (c);
791       return NULL;
792     }
793 }
794
795
796 #endif /* GNM_SUPPORT */