src/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 /*
 313   Change SUGGESTION until it's a valid name that can be added to DICT.
 314 */
 315 static void
 316 devise_name (const struct dictionary *dict, struct string *name, int *x)
 317 {
 318   struct string basename;
 319   if ( ds_is_empty (name))
 320     ds_init_cstr (&basename, "var");
 321   else
 322     ds_init_string (&basename, name);
 323   do
 324     {
 325       ds_clear (name);
 326       ds_put_format (name, "%s%d", ds_cstr (&basename), ++(*x));
 327     }
 328   while (NULL != dict_lookup_var (dict, ds_cstr (name)) );
 329
 330   ds_destroy (&basename);
 331 }
 332
 333 /*
 334    Mutate NAME of a variable, which is gauranteed to be valid for the
 335    dictionary DICT.
 336 */
 337 static void
 338 munge_name (const struct dictionary *dict, struct string *name)
 339 {
 340   int x = 0;
 341
 342   if (! ds_is_empty (name))
 343     {
 344       /* Change all the invalid characters to valid ones */
 345       char *s;
 346
 347       s = ds_data (name);
 348
 349       if ( !lex_is_id1 (*s))
 350         *s = '@';
 351
 352       s++;
 353
 354       while (s < ds_data (name) + ds_length (name))
 355         {
 356           if ( !lex_is_idn (*s))
 357             *s = '_';
 358           s++;
 359         }
 360
 361       assert (var_is_valid_name (ds_cstr (name), false));
 362     }
 363
 364   while (ds_is_empty (name) || NULL != dict_lookup_var (dict, ds_cstr (name)) )
 365     {
 366       devise_name (dict, name, &x);
 367     }
 368 }
 369
 370
 371 /*
 372    Sets the VAR of case C, to the value corresponding to the xml string XV
 373  */
 374 static void
 375 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
 376                              const xmlChar *xv)
 377 {
 378   char *text;
 379   int n_bytes = 0;
 380   union value *v = case_data_rw (c, var);
 381
 382   text = recode_string (CONV_UTF8_TO_PSPP, (const char *) xv, -1);
 383
 384   if ( text)
 385     n_bytes = MIN (var_get_width (var), strlen (text));
 386
 387   if ( var_is_alpha (var))
 388     {
 389       memcpy (v->s, text, n_bytes);
 390     }
 391   else
 392     {
 393       char *endptr;
 394       errno = 0;
 395       v->f = strtod (text, &endptr);
 396       if ( errno != 0 || endptr == text)
 397         v->f = SYSMIS;
 398     }
 399
 400   free (text);
 401 }
 402
 403 struct var_spec
 404 {
 405   char *name;
 406   int width;
 407   xmlChar *first_value;
 408 };
 409
 410 struct casereader *
 411 gnumeric_open_reader (struct gnumeric_read_info *gri, struct dictionary **dict)
 412 {
 413   int ret;
 414   casenumber n_cases = CASENUMBER_MAX;
 415   int i;
 416   struct var_spec *var_spec = NULL;
 417   int n_var_specs = 0;
 418
 419   struct gnumeric_reader *r = NULL;
 420
 421   gzFile gz = gzopen (gri->file_name, "r");
 422
 423   if ( NULL == gz)
 424     {
 425       msg (ME, _("Error opening \"%s\" for reading as a gnumeric file: %s."),
 426            gri->file_name, strerror (errno));
 427
 428       goto error;
 429     }
 430
 431   r = xzalloc (sizeof *r);
 432
 433   r->xtr = xmlReaderForIO ((xmlInputReadCallback) gzread, gzclose, gz,
 434                            NULL, NULL, 0);
 435
 436   if ( r->xtr == NULL)
 437     goto error;
 438
 439   if ( gri->cell_range )
 440     {
 441       if ( ! convert_cell_ref (gri->cell_range,
 442                                &r->start_col, &r->start_row,
 443                                &r->stop_col, &r->stop_row))
 444         {
 445           msg (SE, _("Invalid cell range \"%s\""),
 446                gri->cell_range);
 447           goto error;
 448         }
 449     }
 450   else
 451     {
 452       r->start_col = 0;
 453       r->start_row = 0;
 454       r->stop_col = -1;
 455       r->stop_row = -1;
 456     }
 457
 458   r->state = STATE_INIT;
 459   r->target_sheet = BAD_CAST gri->sheet_name;
 460   r->target_sheet_index = gri->sheet_index;
 461   r->row = r->col = -1;
 462   r->sheet_index = 0;
 463
 464   /* Advance to the start of the cells for the target sheet */
 465   while ( (r->state != STATE_CELL || r->row < r->start_row )
 466           && 1 == (ret = xmlTextReaderRead (r->xtr)))
 467     {
 468       xmlChar *value ;
 469       process_node (r);
 470       value = xmlTextReaderValue (r->xtr);
 471
 472       if ( r->state == STATE_MAXROW  && r->node_type == XML_READER_TYPE_TEXT)
 473         {
 474           n_cases = 1 + _xmlchar_to_int (value) ;
 475         }
 476       free (value);
 477     }
 478
 479
 480   /* If a range has been given, then  use that to calculate the number
 481      of cases */
 482   if ( gri->cell_range)
 483     {
 484       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
 485     }
 486
 487   if ( gri->read_names )
 488     {
 489       r->start_row++;
 490       n_cases --;
 491     }
 492
 493   /* Read in the first row of cells,
 494      including the headers if read_names was set */
 495   while (
 496          (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
 497          && (ret = xmlTextReaderRead (r->xtr))
 498          )
 499     {
 500       int idx;
 501       process_node (r);
 502
 503       if ( r->row > r->start_row ) break;
 504
 505       if ( r->col < r->start_col ||
 506            (r->stop_col != -1 && r->col > r->stop_col))
 507         continue;
 508
 509       idx = r->col - r->start_col;
 510
 511       if ( idx  >= n_var_specs )
 512         {
 513           n_var_specs =  idx + 1 ;
 514           var_spec = realloc (var_spec, sizeof (*var_spec) * n_var_specs);
 515           var_spec [idx].name = NULL;
 516           var_spec [idx].width = -1;
 517           var_spec [idx].first_value = NULL;
 518         }
 519
 520       if ( r->node_type == XML_READER_TYPE_TEXT )
 521         {
 522           char *text ;
 523           xmlChar *value = xmlTextReaderValue (r->xtr);
 524
 525           text = recode_string (CONV_UTF8_TO_PSPP, (const char *) value, -1);
 526
 527           if ( r->row < r->start_row)
 528             {
 529               if ( gri->read_names )
 530                 {
 531                   var_spec [idx].name = strdup (text);
 532                 }
 533             }
 534           else
 535             {
 536               var_spec [idx].first_value = xmlStrdup (value);
 537
 538               if (-1 ==  var_spec [idx].width )
 539                 var_spec [idx].width = (gri->asw == -1) ?
 540                   ROUND_UP (strlen(text), MAX_SHORT_STRING) : gri->asw;
 541             }
 542
 543           free (value);
 544           free (text);
 545         }
 546       else if ( r->node_type == XML_READER_TYPE_ELEMENT
 547                 && r->state == STATE_CELL)
 548         {
 549           if ( r->row == r->start_row )
 550             {
 551               xmlChar *attr =
 552                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
 553
 554               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
 555                 var_spec [idx].width = 0;
 556
 557               free (attr);
 558             }
 559         }
 560     }
 561
 562
 563   /* Create the dictionary and populate it */
 564   *dict = r->dict = dict_create ();
 565
 566   r->value_cnt = 0;
 567
 568   for (i = 0 ; i < n_var_specs ; ++i )
 569     {
 570       struct string name;
 571
 572       /* Probably no data exists for this variable, so allocate a default width */
 573       if ( var_spec[i].width == -1 )
 574         var_spec[i].width = MAX_SHORT_STRING;
 575
 576       r->value_cnt += value_cnt_from_width (var_spec[i].width);
 577
 578       if (var_spec[i].name)
 579         ds_init_cstr (&name, var_spec[i].name);
 580       else
 581         ds_init_empty (&name);
 582
 583       munge_name (r->dict, &name);
 584
 585
 586       dict_create_var (r->dict, ds_cstr (&name), var_spec[i].width);
 587
 588       ds_destroy (&name);
 589     }
 590
 591   /* Create the first case, and cache it */
 592   r->used_first_case = false;
 593
 594   if ( n_var_specs ==  0 )
 595     {
 596       msg (MW, _("Selected sheet or range of spreadsheet \"%s\" is empty."),
 597            gri->file_name);
 598       goto error;
 599     }
 600
 601   case_create (&r->first_case, r->value_cnt);
 602   memset (case_data_rw_idx (&r->first_case, 0)->s,
 603           ' ', MAX_SHORT_STRING * r->value_cnt);
 604
 605   for ( i = 0 ; i < n_var_specs ; ++i )
 606     {
 607       const struct variable *var = dict_get_var (r->dict, i);
 608
 609       convert_xml_string_to_value (&r->first_case, var,
 610                                    var_spec[i].first_value);
 611     }
 612
 613   for ( i = 0 ; i < n_var_specs ; ++i )
 614     {
 615       free (var_spec[i].first_value);
 616       free (var_spec[i].name);
 617     }
 618
 619   free (var_spec);
 620
 621   return casereader_create_sequential
 622     (NULL,
 623      r->value_cnt,
 624      n_cases,
 625      &gnm_file_casereader_class, r);
 626
 627
 628  error:
 629   for ( i = 0 ; i < n_var_specs ; ++i )
 630     {
 631       free (var_spec[i].first_value);
 632       free (var_spec[i].name);
 633     }
 634
 635   free (var_spec);
 636   dict_destroy (*dict);
 637
 638   gnm_file_casereader_destroy (NULL, r);
 639
 640   return NULL;
 641 };
 642
 643
 644 /* Reads one case from READER's file into C.  Returns true only
 645    if successful. */
 646 static bool
 647 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_,
 648                           struct ccase *c)
 649 {
 650   int ret = 0;
 651
 652   struct gnumeric_reader *r = r_;
 653   int current_row = r->row;
 654
 655   if ( !r->used_first_case )
 656     {
 657       *c = r->first_case;
 658       r->used_first_case = true;
 659       return true;
 660     }
 661
 662   case_create (c, r->value_cnt);
 663
 664   memset (case_data_rw_idx (c, 0)->s, ' ', MAX_SHORT_STRING * r->value_cnt);
 665
 666   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
 667          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
 668     {
 669       process_node (r);
 670
 671       if ( r->col < r->start_col || (r->stop_col != -1 &&
 672                                      r->col > r->stop_col))
 673         continue;
 674
 675       if ( r->col - r->start_col >= r->value_cnt)
 676         continue;
 677
 678       if ( r->stop_row != -1 && r->row > r->stop_row)
 679         break;
 680
 681       if ( r->node_type == XML_READER_TYPE_TEXT )
 682         {
 683           xmlChar *value = xmlTextReaderValue (r->xtr);
 684
 685           const int idx = r->col - r->start_col;
 686
 687           const struct variable *var = dict_get_var (r->dict, idx);
 688
 689           convert_xml_string_to_value (c, var, value);
 690
 691           free (value);
 692         }
 693
 694     }
 695
 696   return (ret == 1);
 697 }
 698
 699
 700 #endif /* GNM_SUPPORT */