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