src/data/gnumeric-reader.c

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