Update GPG key for signing flatpaks.
[pspp] / data / gnumeric-reader.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007 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
18
19 #include <config.h>
20
21 #include <libpspp/message.h>
22
23 #include "gettext.h"
24 #define _(msgid) gettext (msgid)
25 #define N_(msgid) (msgid)
26
27
28 #if !GNM_SUPPORT
29
30 struct casereader *
31 gnumeric_open_reader (struct gnumeric_read_info *gri, struct dictionary **dict)
32 {
33   msg (ME, _("Support for Gnumeric files was not compiled into this installation of PSPP"));
34
35   return NULL;
36 }
37
38 #else
39
40 #include <data/casereader-provider.h>
41 #include <errno.h>
42 #include <libpspp/str.h>
43 #include <libpspp/i18n.h>
44 #include <data/dictionary.h>
45 #include <data/variable.h>
46 #include <xalloc.h>
47
48 #include <errno.h>
49 #include <libxml/xmlreader.h>
50 #include <zlib.h>
51 #include <stdbool.h>
52
53 #include <data/case.h>
54 #include <data/value.h>
55
56 #include "gnumeric-reader.h"
57 #include <data/identifier.h>
58 #include <assert.h>
59
60
61 static void gnm_file_casereader_destroy (struct casereader *, void *);
62
63 static bool gnm_file_casereader_read (struct casereader *, void *,
64                                       struct ccase *);
65
66 static const struct casereader_class gnm_file_casereader_class =
67   {
68     gnm_file_casereader_read,
69     gnm_file_casereader_destroy,
70     NULL,
71     NULL,
72   };
73
74 /* Convert a string, which is an integer encoded in base26
75    IE, A=0, B=1, ... Z=25 to the integer it represents.
76    ... except that in this scheme, digits with an exponent
77    greater than 1 are implicitly incremented by 1, so
78    AA  = 0 + 1*26, AB = 1 + 1*26,
79    ABC = 2 + 2*26 + 1*26^2 ....
80 */
81 static int
82 pseudo_base26 (const char *str)
83 {
84   int i;
85   int multiplier = 1;
86   int result = 0;
87   int len = strlen (str);
88
89   for ( i = len - 1 ; i >= 0; --i)
90     {
91       int mantissa = (str[i] - 'A');
92
93       if ( mantissa < 0 || mantissa > 25 )
94         return -1;
95
96       if ( i != len - 1)
97         mantissa++;
98
99       result += mantissa * multiplier;
100
101       multiplier *= 26;
102     }
103
104   return result;
105 }
106
107
108
109 /* Convert a cell reference in the form "A1:B2", to
110    integers.  A1 means column zero, row zero.
111    B1 means column 1 row 0. AA1 means column 26, row 0.
112 */
113 static bool
114 convert_cell_ref (const char *ref,
115                   int *col0, int *row0,
116                   int *coli, int *rowi)
117 {
118   char startcol[5];
119   char stopcol [5];
120
121   int startrow;
122   int stoprow;
123
124   int n = sscanf (ref, "%4[a-zA-Z]%d:%4[a-zA-Z]%d",
125               startcol, &startrow,
126               stopcol, &stoprow);
127   if ( n != 4)
128     return false;
129
130   str_uppercase (startcol);
131   *col0 = pseudo_base26 (startcol);
132   str_uppercase (stopcol);
133   *coli = pseudo_base26 (stopcol);
134   *row0 = startrow - 1;
135   *rowi = stoprow - 1 ;
136
137   return true;
138 }
139
140
141 enum reader_state
142   {
143     STATE_INIT = 0,        /* Initial state */
144     STATE_SHEET_START,     /* Found the start of a sheet */
145     STATE_SHEET_NAME,      /* Found the sheet name */
146     STATE_MAXROW,
147     STATE_SHEET_FOUND,     /* Found the sheet that we actually want */
148     STATE_CELLS_START,     /* Found the start of the cell array */
149     STATE_CELL             /* Found a cell */
150   };
151
152
153 struct gnumeric_reader
154 {
155   xmlTextReaderPtr xtr;
156
157   enum reader_state state;
158   int row;
159   int col;
160   int node_type;
161   int sheet_index;
162
163
164   const xmlChar *target_sheet;
165   int target_sheet_index;
166
167   int start_row;
168   int start_col;
169   int stop_row;
170   int stop_col;
171
172
173   size_t value_cnt;
174   struct dictionary *dict;
175   struct ccase first_case;
176   bool used_first_case;
177 };
178
179 static void process_node (struct gnumeric_reader *r);
180
181 #define _xml(X) (const xmlChar *)(X)
182
183 #define _xmlchar_to_int(X) atoi((const char *)X)
184
185 static void
186 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
187 {
188   struct gnumeric_reader *r = r_;
189   if ( r == NULL)
190         return ;
191
192   if ( r->xtr)
193     xmlFreeTextReader (r->xtr);
194
195   if ( ! r->used_first_case )
196     case_destroy (&r->first_case);
197
198   free (r);
199 }
200
201 static void
202 process_node (struct gnumeric_reader *r)
203 {
204   xmlChar *name = xmlTextReaderName (r->xtr);
205   if (name == NULL)
206     name = xmlStrdup (_xml ("--"));
207
208
209   r->node_type = xmlTextReaderNodeType (r->xtr);
210
211   switch ( r->state)
212     {
213     case STATE_INIT:
214       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
215           XML_READER_TYPE_ELEMENT  == r->node_type)
216         {
217           r->state = STATE_SHEET_START;
218         }
219       break;
220     case STATE_SHEET_START:
221       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
222           XML_READER_TYPE_ELEMENT  == r->node_type)
223         {
224           r->state = STATE_SHEET_NAME;
225         }
226       else if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
227                XML_READER_TYPE_END_ELEMENT  == r->node_type)
228         {
229           r->state = STATE_INIT;
230         }
231       break;
232     case STATE_SHEET_NAME:
233       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
234           XML_READER_TYPE_END_ELEMENT  == r->node_type)
235         {
236           r->state = STATE_SHEET_START;
237         }
238       else if (XML_READER_TYPE_TEXT == r->node_type)
239         {
240           ++r->sheet_index;
241           if ( r->target_sheet != NULL)
242             {
243               xmlChar *value = xmlTextReaderValue (r->xtr);
244               if ( 0 == xmlStrcmp (value, r->target_sheet))
245                 r->state = STATE_SHEET_FOUND;
246               free (value);
247             }
248           else if (r->target_sheet_index == r->sheet_index)
249             {
250               r->state = STATE_SHEET_FOUND;
251             }
252         }
253       break;
254     case STATE_SHEET_FOUND:
255       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
256           XML_READER_TYPE_ELEMENT  == r->node_type)
257         {
258           if (! xmlTextReaderIsEmptyElement (r->xtr))
259             r->state = STATE_CELLS_START;
260         }
261       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
262           XML_READER_TYPE_ELEMENT  == r->node_type)
263         {
264           r->state = STATE_MAXROW;
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       break;
272     case STATE_MAXROW:
273       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
274           XML_READER_TYPE_END_ELEMENT  == r->node_type)
275         {
276           r->state = STATE_SHEET_FOUND;
277         }
278     case STATE_CELLS_START:
279       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
280           XML_READER_TYPE_ELEMENT  == r->node_type)
281         {
282           xmlChar *attr = NULL;
283           r->state = STATE_CELL;
284
285           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
286           r->col =  _xmlchar_to_int (attr);
287           free (attr);
288
289           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
290           r->row = _xmlchar_to_int (attr);
291           free (attr);
292         }
293       else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
294                XML_READER_TYPE_END_ELEMENT  == r->node_type)
295         r->state = STATE_SHEET_NAME;
296
297       break;
298     case STATE_CELL:
299       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  &&
300                               XML_READER_TYPE_END_ELEMENT  == r->node_type)
301         r->state = STATE_CELLS_START;
302       break;
303     default:
304       break;
305     };
306
307   xmlFree (name);
308 }
309
310
311 /*
312    Sets the VAR of case C, to the value corresponding to the xml string XV
313  */
314 static void
315 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
316                              const xmlChar *xv)
317 {
318   char *text;
319   int n_bytes = 0;
320   union value *v = case_data_rw (c, var);
321
322   text = recode_string (CONV_UTF8_TO_PSPP, (const char *) xv, -1);
323
324   if ( text)
325     n_bytes = MIN (var_get_width (var), strlen (text));
326
327   if ( var_is_alpha (var))
328     {
329       memcpy (v->s, text, n_bytes);
330     }
331   else
332     {
333       char *endptr;
334       errno = 0;
335       v->f = strtod (text, &endptr);
336       if ( errno != 0 || endptr == text)
337         v->f = SYSMIS;
338     }
339
340   free (text);
341 }
342
343 struct var_spec
344 {
345   char *name;
346   int width;
347   xmlChar *first_value;
348 };
349
350 struct casereader *
351 gnumeric_open_reader (struct gnumeric_read_info *gri, struct dictionary **dict)
352 {
353   unsigned long int vstart = 0;
354   int ret;
355   casenumber n_cases = CASENUMBER_MAX;
356   int i;
357   struct var_spec *var_spec = NULL;
358   int n_var_specs = 0;
359
360   struct gnumeric_reader *r = NULL;
361
362   gzFile gz = gzopen (gri->file_name, "r");
363
364   if ( NULL == gz)
365     {
366       msg (ME, _("Error opening \"%s\" for reading as a gnumeric file: %s."),
367            gri->file_name, strerror (errno));
368
369       goto error;
370     }
371
372   r = xzalloc (sizeof *r);
373
374   r->xtr = xmlReaderForIO ((xmlInputReadCallback) gzread, gzclose, gz,
375                            NULL, NULL, 0);
376
377   if ( r->xtr == NULL)
378     goto error;
379
380   if ( gri->cell_range )
381     {
382       if ( ! convert_cell_ref (gri->cell_range,
383                                &r->start_col, &r->start_row,
384                                &r->stop_col, &r->stop_row))
385         {
386           msg (SE, _("Invalid cell range \"%s\""),
387                gri->cell_range);
388           goto error;
389         }
390     }
391   else
392     {
393       r->start_col = 0;
394       r->start_row = 0;
395       r->stop_col = -1;
396       r->stop_row = -1;
397     }
398
399   r->state = STATE_INIT;
400   r->target_sheet = BAD_CAST gri->sheet_name;
401   r->target_sheet_index = gri->sheet_index;
402   r->row = r->col = -1;
403   r->sheet_index = 0;
404
405   /* Advance to the start of the cells for the target sheet */
406   while ( (r->state != STATE_CELL || r->row < r->start_row )
407           && 1 == (ret = xmlTextReaderRead (r->xtr)))
408     {
409       xmlChar *value ;
410       process_node (r);
411       value = xmlTextReaderValue (r->xtr);
412
413       if ( r->state == STATE_MAXROW  && r->node_type == XML_READER_TYPE_TEXT)
414         {
415           n_cases = 1 + _xmlchar_to_int (value) ;
416         }
417       free (value);
418     }
419
420
421   /* If a range has been given, then  use that to calculate the number
422      of cases */
423   if ( gri->cell_range)
424     {
425       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
426     }
427
428   if ( gri->read_names )
429     {
430       r->start_row++;
431       n_cases --;
432     }
433
434   /* Read in the first row of cells,
435      including the headers if read_names was set */
436   while (
437          (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
438          && (ret = xmlTextReaderRead (r->xtr))
439          )
440     {
441       int idx;
442       process_node (r);
443
444       if ( r->row > r->start_row ) break;
445
446       if ( r->col < r->start_col ||
447            (r->stop_col != -1 && r->col > r->stop_col))
448         continue;
449
450       idx = r->col - r->start_col;
451
452       if ( idx  >= n_var_specs )
453         {
454           n_var_specs =  idx + 1 ;
455           var_spec = realloc (var_spec, sizeof (*var_spec) * n_var_specs);
456           var_spec [idx].name = NULL;
457           var_spec [idx].width = -1;
458           var_spec [idx].first_value = NULL;
459         }
460
461       if ( r->node_type == XML_READER_TYPE_TEXT )
462         {
463           char *text ;
464           xmlChar *value = xmlTextReaderValue (r->xtr);
465
466           text = recode_string (CONV_UTF8_TO_PSPP, (const char *) value, -1);
467
468           if ( r->row < r->start_row)
469             {
470               if ( gri->read_names )
471                 {
472                   var_spec [idx].name = strdup (text);
473                 }
474             }
475           else
476             {
477               var_spec [idx].first_value = xmlStrdup (value);
478
479               if (-1 ==  var_spec [idx].width )
480                 var_spec [idx].width = (gri->asw == -1) ?
481                   ROUND_UP (strlen(text), MAX_SHORT_STRING) : gri->asw;
482             }
483
484           free (value);
485           free (text);
486         }
487       else if ( r->node_type == XML_READER_TYPE_ELEMENT
488                 && r->state == STATE_CELL)
489         {
490           if ( r->row == r->start_row )
491             {
492               xmlChar *attr =
493                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
494
495               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
496                 var_spec [idx].width = 0;
497
498               free (attr);
499             }
500         }
501     }
502
503
504   /* Create the dictionary and populate it */
505   *dict = r->dict = dict_create ();
506
507   r->value_cnt = 0;
508
509   for (i = 0 ; i < n_var_specs ; ++i )
510     {
511       char name[VAR_NAME_LEN + 1];
512
513       /* Probably no data exists for this variable, so allocate a
514          default width */
515       if ( var_spec[i].width == -1 )
516         var_spec[i].width = MAX_SHORT_STRING;
517
518       r->value_cnt += value_cnt_from_width (var_spec[i].width);
519
520       if  ( ! dict_make_unique_var_name (r->dict, var_spec[i].name,
521                                          &vstart, name))
522         {
523           msg (ME, _("Cannot create variable name from %s"), var_spec[i].name);
524           goto error;
525         }
526
527       dict_create_var (r->dict, name, var_spec[i].width);
528     }
529
530   /* Create the first case, and cache it */
531   r->used_first_case = false;
532
533   if ( n_var_specs ==  0 )
534     {
535       msg (MW, _("Selected sheet or range of spreadsheet \"%s\" is empty."),
536            gri->file_name);
537       goto error;
538     }
539
540   case_create (&r->first_case, r->value_cnt);
541   memset (case_data_rw_idx (&r->first_case, 0)->s,
542           ' ', MAX_SHORT_STRING * r->value_cnt);
543
544   for ( i = 0 ; i < n_var_specs ; ++i )
545     {
546       const struct variable *var = dict_get_var (r->dict, i);
547
548       convert_xml_string_to_value (&r->first_case, var,
549                                    var_spec[i].first_value);
550     }
551
552   for ( i = 0 ; i < n_var_specs ; ++i )
553     {
554       free (var_spec[i].first_value);
555       free (var_spec[i].name);
556     }
557
558   free (var_spec);
559
560   return casereader_create_sequential
561     (NULL,
562      r->value_cnt,
563      n_cases,
564      &gnm_file_casereader_class, r);
565
566
567  error:
568   for ( i = 0 ; i < n_var_specs ; ++i )
569     {
570       free (var_spec[i].first_value);
571       free (var_spec[i].name);
572     }
573
574   free (var_spec);
575   dict_destroy (*dict);
576
577   gnm_file_casereader_destroy (NULL, r);
578
579   return NULL;
580 };
581
582
583 /* Reads one case from READER's file into C.  Returns true only
584    if successful. */
585 static bool
586 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_,
587                           struct ccase *c)
588 {
589   int ret = 0;
590
591   struct gnumeric_reader *r = r_;
592   int current_row = r->row;
593
594   if ( !r->used_first_case )
595     {
596       *c = r->first_case;
597       r->used_first_case = true;
598       return true;
599     }
600
601   case_create (c, r->value_cnt);
602
603   memset (case_data_rw_idx (c, 0)->s, ' ', MAX_SHORT_STRING * r->value_cnt);
604
605   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
606          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
607     {
608       process_node (r);
609
610       if ( r->col < r->start_col || (r->stop_col != -1 &&
611                                      r->col > r->stop_col))
612         continue;
613
614       if ( r->col - r->start_col >= r->value_cnt)
615         continue;
616
617       if ( r->stop_row != -1 && r->row > r->stop_row)
618         break;
619
620       if ( r->node_type == XML_READER_TYPE_TEXT )
621         {
622           xmlChar *value = xmlTextReaderValue (r->xtr);
623
624           const int idx = r->col - r->start_col;
625
626           const struct variable *var = dict_get_var (r->dict, idx);
627
628           convert_xml_string_to_value (c, var, value);
629
630           free (value);
631         }
632
633     }
634
635   return (ret == 1);
636 }
637
638
639 #endif /* GNM_SUPPORT */