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 #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 <data/casereader-provider.h>
  44 #include <errno.h>
  45 #include <libpspp/str.h>
  46 #include <libpspp/i18n.h>
  47 #include <data/dictionary.h>
  48 #include <data/variable.h>
  49 #include <xalloc.h>
  50
  51 #include <errno.h>
  52 #include <libxml/xmlreader.h>
  53 #include <zlib.h>
  54 #include <stdbool.h>
  55
  56 #include <data/case.h>
  57 #include <data/value.h>
  58
  59 #include "gnumeric-reader.h"
  60 #include <data/identifier.h>
  61 #include <assert.h>
  62
  63
  64 static void gnm_file_casereader_destroy (struct casereader *, void *);
  65
  66 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
  67
  68 static const 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   struct caseproto *proto;
 175   struct dictionary *dict;
 176   struct ccase *first_case;
 177   bool used_first_case;
 178 };
 179
 180 static void process_node (struct gnumeric_reader *r);
 181
 182 #define _xml(X) (const xmlChar *)(X)
 183
 184 #define _xmlchar_to_int(X) atoi((const char *)X)
 185
 186 static void
 187 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
 188 {
 189   struct gnumeric_reader *r = r_;
 190   if ( r == NULL)
 191         return ;
 192
 193   if ( r->xtr)
 194     xmlFreeTextReader (r->xtr);
 195
 196   if ( ! r->used_first_case )
 197     case_unref (r->first_case);
 198
 199   caseproto_unref (r->proto);
 200
 201   free (r);
 202 }
 203
 204 static void
 205 process_node (struct gnumeric_reader *r)
 206 {
 207   xmlChar *name = xmlTextReaderName (r->xtr);
 208   if (name == NULL)
 209     name = xmlStrdup (_xml ("--"));
 210
 211
 212   r->node_type = xmlTextReaderNodeType (r->xtr);
 213
 214   switch ( r->state)
 215     {
 216     case STATE_INIT:
 217       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
 218           XML_READER_TYPE_ELEMENT  == r->node_type)
 219         {
 220           r->state = STATE_SHEET_START;
 221         }
 222       break;
 223     case STATE_SHEET_START:
 224       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
 225           XML_READER_TYPE_ELEMENT  == r->node_type)
 226         {
 227           r->state = STATE_SHEET_NAME;
 228         }
 229       else if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
 230                XML_READER_TYPE_END_ELEMENT  == r->node_type)
 231         {
 232           r->state = STATE_INIT;
 233         }
 234       break;
 235     case STATE_SHEET_NAME:
 236       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
 237           XML_READER_TYPE_END_ELEMENT  == r->node_type)
 238         {
 239           r->state = STATE_SHEET_START;
 240         }
 241       else if (XML_READER_TYPE_TEXT == r->node_type)
 242         {
 243           ++r->sheet_index;
 244           if ( r->target_sheet != NULL)
 245             {
 246               xmlChar *value = xmlTextReaderValue (r->xtr);
 247               if ( 0 == xmlStrcmp (value, r->target_sheet))
 248                 r->state = STATE_SHEET_FOUND;
 249               free (value);
 250             }
 251           else if (r->target_sheet_index == r->sheet_index)
 252             {
 253               r->state = STATE_SHEET_FOUND;
 254             }
 255         }
 256       break;
 257     case STATE_SHEET_FOUND:
 258       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
 259           XML_READER_TYPE_ELEMENT  == r->node_type)
 260         {
 261           if (! xmlTextReaderIsEmptyElement (r->xtr))
 262             r->state = STATE_CELLS_START;
 263         }
 264       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
 265           XML_READER_TYPE_ELEMENT  == r->node_type)
 266         {
 267           r->state = STATE_MAXROW;
 268         }
 269       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
 270           XML_READER_TYPE_END_ELEMENT  == r->node_type)
 271         {
 272           r->state = STATE_INIT;
 273         }
 274       break;
 275     case STATE_MAXROW:
 276       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
 277           XML_READER_TYPE_END_ELEMENT  == r->node_type)
 278         {
 279           r->state = STATE_SHEET_FOUND;
 280         }
 281     case STATE_CELLS_START:
 282       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
 283           XML_READER_TYPE_ELEMENT  == r->node_type)
 284         {
 285           xmlChar *attr = NULL;
 286           r->state = STATE_CELL;
 287
 288           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
 289           r->col =  _xmlchar_to_int (attr);
 290           free (attr);
 291
 292           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
 293           r->row = _xmlchar_to_int (attr);
 294           free (attr);
 295         }
 296       else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
 297                XML_READER_TYPE_END_ELEMENT  == r->node_type)
 298         r->state = STATE_SHEET_NAME;
 299
 300       break;
 301     case STATE_CELL:
 302       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  &&
 303                               XML_READER_TYPE_END_ELEMENT  == r->node_type)
 304         r->state = STATE_CELLS_START;
 305       break;
 306     default:
 307       break;
 308     };
 309
 310   xmlFree (name);
 311 }
 312
 313
 314 /*
 315    Sets the VAR of case C, to the value corresponding to the xml string XV
 316  */
 317 static void
 318 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
 319                              const xmlChar *xv)
 320 {
 321   int n_bytes = 0;
 322   union value *v = case_data_rw (c, var);
 323
 324   const char *text = (const char *) xv;
 325
 326   if ( text)
 327     n_bytes = MIN (var_get_width (var), strlen (text));
 328
 329   if ( var_is_alpha (var))
 330     {
 331       memcpy (value_str_rw (v, var_get_width (var)), text, n_bytes);
 332     }
 333   else
 334     {
 335       char *endptr;
 336       errno = 0;
 337       v->f = strtod (text, &endptr);
 338       if ( errno != 0 || endptr == text)
 339         v->f = SYSMIS;
 340     }
 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 = xrealloc (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           xmlChar *value = xmlTextReaderValue (r->xtr);
 464           const char *text  = (const char *) value;
 465
 466           if ( r->row < r->start_row)
 467             {
 468               if ( gri->read_names )
 469                 {
 470                   var_spec [idx].name = xstrdup (text);
 471                 }
 472             }
 473           else
 474             {
 475               var_spec [idx].first_value = xmlStrdup (value);
 476
 477               if (-1 ==  var_spec [idx].width )
 478                 var_spec [idx].width = (gri->asw == -1) ?
 479                   ROUND_UP (strlen(text), MAX_SHORT_STRING) : gri->asw;
 480             }
 481
 482           free (value);
 483         }
 484       else if ( r->node_type == XML_READER_TYPE_ELEMENT
 485                 && r->state == STATE_CELL)
 486         {
 487           if ( r->row == r->start_row )
 488             {
 489               xmlChar *attr =
 490                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
 491
 492               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
 493                 var_spec [idx].width = 0;
 494
 495               free (attr);
 496             }
 497         }
 498     }
 499
 500
 501   /* Create the dictionary and populate it */
 502   *dict = r->dict = dict_create ();
 503
 504   dict_set_encoding (r->dict, (const char *) xmlTextReaderConstEncoding (r->xtr));
 505
 506   for (i = 0 ; i < n_var_specs ; ++i )
 507     {
 508       char name[VAR_NAME_LEN + 1];
 509
 510       /* Probably no data exists for this variable, so allocate a
 511          default width */
 512       if ( var_spec[i].width == -1 )
 513         var_spec[i].width = MAX_SHORT_STRING;
 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->proto = caseproto_ref (dict_get_proto (r->dict));
 536   r->first_case = case_create (r->proto);
 537   case_set_missing (r->first_case);
 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->proto,
 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->proto);
 596   case_set_missing (c);
 597
 598   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
 599          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
 600     {
 601       process_node (r);
 602
 603       if ( r->col < r->start_col || (r->stop_col != -1 &&
 604                                      r->col > r->stop_col))
 605         continue;
 606
 607       if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
 608         continue;
 609
 610       if ( r->stop_row != -1 && r->row > r->stop_row)
 611         break;
 612
 613       if ( r->node_type == XML_READER_TYPE_TEXT )
 614         {
 615           xmlChar *value = xmlTextReaderValue (r->xtr);
 616
 617           const int idx = r->col - r->start_col;
 618
 619           const struct variable *var = dict_get_var (r->dict, idx);
 620
 621           convert_xml_string_to_value (c, var, value);
 622
 623           free (value);
 624         }
 625
 626     }
 627
 628   if (ret == 1)
 629     return c;
 630   else
 631     {
 632       case_unref (c);
 633       return NULL;
 634     }
 635 }
 636
 637
 638 #endif /* GNM_SUPPORT */