pintos-os.org Git - pspp/blob - src/data/gnumeric-reader.c

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