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