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