src/data/gnumeric-reader.c

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