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               printf ("%s:%d\n", __FILE__, __LINE__);
 173               xmlChar *value = xmlTextReaderValue (r->xtr);
 174               if ( 0 == xmlStrcmp (value, r->target_sheet))
 175                 r->state = STATE_SHEET_FOUND;
 176               free (value);
 177             }
 178           else if (r->target_sheet_index == r->sheet_index)
 179             {
 180               printf ("%s:%d %d\n", __FILE__, __LINE__, r->sheet_index);
 181               r->state = STATE_SHEET_FOUND;
 182             }
 183         }
 184       break;
 185     case STATE_SHEET_FOUND:
 186       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
 187           XML_READER_TYPE_ELEMENT  == r->node_type)
 188         {
 189           r->min_col = INT_MAX;
 190           if (! xmlTextReaderIsEmptyElement (r->xtr))
 191             r->state = STATE_CELLS_START;
 192         }
 193       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
 194           XML_READER_TYPE_ELEMENT  == r->node_type)
 195         {
 196           r->state = STATE_MAXROW;
 197         }
 198       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
 199           XML_READER_TYPE_END_ELEMENT  == r->node_type)
 200         {
 201           r->state = STATE_INIT;
 202         }
 203       break;
 204     case STATE_MAXROW:
 205       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
 206           XML_READER_TYPE_END_ELEMENT  == r->node_type)
 207         {
 208           r->state = STATE_SHEET_FOUND;
 209         }
 210     case STATE_CELLS_START:
 211       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
 212           XML_READER_TYPE_ELEMENT  == r->node_type)
 213         {
 214           xmlChar *attr = NULL;
 215           r->state = STATE_CELL;
 216
 217           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
 218           r->col =  _xmlchar_to_int (attr);
 219           free (attr);
 220
 221           if (r->col < r->min_col)
 222             r->min_col = r->col;
 223
 224           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
 225           r->row = _xmlchar_to_int (attr);
 226           free (attr);
 227         }
 228       else if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
 229                XML_READER_TYPE_END_ELEMENT  == r->node_type)
 230         r->state = STATE_SHEET_NAME;
 231
 232       break;
 233     case STATE_CELL:
 234       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  &&
 235                               XML_READER_TYPE_END_ELEMENT  == r->node_type)
 236         {
 237           r->state = STATE_CELLS_START;
 238         }
 239       break;
 240     default:
 241       break;
 242     };
 243
 244   xmlFree (name);
 245 }
 246
 247
 248 /*
 249    Sets the VAR of case C, to the value corresponding to the xml string XV
 250  */
 251 static void
 252 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
 253                              const xmlChar *xv)
 254 {
 255   union value *v = case_data_rw (c, var);
 256
 257   if (xv == NULL)
 258     value_set_missing (v, var_get_width (var));
 259   else if ( var_is_alpha (var))
 260     value_copy_str_rpad (v, var_get_width (var), xv, ' ');
 261   else
 262     {
 263       const char *text = CHAR_CAST (const char *, xv);
 264       char *endptr;
 265
 266       errno = 0;
 267       v->f = c_strtod (text, &endptr);
 268       if ( errno != 0 || endptr == text)
 269         v->f = SYSMIS;
 270     }
 271 }
 272
 273 struct var_spec
 274 {
 275   char *name;
 276   int width;
 277   xmlChar *first_value;
 278 };
 279
 280 struct casereader *
 281 gnumeric_open_reader (const struct spreadsheet_read_info *gri,
 282                       struct spreadsheet_read_options *opts,
 283                       struct dictionary **dict)
 284 {
 285   unsigned long int vstart = 0;
 286   int ret;
 287   casenumber n_cases = CASENUMBER_MAX;
 288   int i;
 289   struct var_spec *var_spec = NULL;
 290   int n_var_specs = 0;
 291
 292   struct gnumeric_reader *r = NULL;
 293
 294   gzFile gz = gzopen (gri->file_name, "r");
 295
 296   if ( NULL == gz)
 297     {
 298       msg (ME, _("Error opening `%s' for reading as a Gnumeric file: %s."),
 299            gri->file_name, strerror (errno));
 300
 301       goto error;
 302     }
 303
 304   r = xzalloc (sizeof *r);
 305
 306   r->xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
 307                            (xmlInputCloseCallback) gzclose, gz,
 308                            NULL, NULL, 0);
 309
 310   if ( r->xtr == NULL )
 311     goto error;
 312
 313   if ( opts->cell_range )
 314     {
 315       if ( ! convert_cell_ref (opts->cell_range,
 316                                &r->start_col, &r->start_row,
 317                                &r->stop_col, &r->stop_row))
 318         {
 319           msg (SE, _("Invalid cell range `%s'"),
 320                opts->cell_range);
 321           goto error;
 322         }
 323     }
 324   else
 325     {
 326       r->start_col = -1;
 327       r->start_row = 0;
 328       r->stop_col = -1;
 329       r->stop_row = -1;
 330     }
 331
 332   r->state = STATE_INIT;
 333   r->target_sheet = BAD_CAST opts->sheet_name;
 334   r->target_sheet_index = opts->sheet_index;
 335   r->row = r->col = -1;
 336   r->sheet_index = 0;
 337
 338   /* Advance to the start of the cells for the target sheet */
 339   while ( (r->state != STATE_CELL || r->row < r->start_row )
 340           && 1 == (ret = xmlTextReaderRead (r->xtr)))
 341     {
 342       xmlChar *value ;
 343       process_node (r);
 344       value = xmlTextReaderValue (r->xtr);
 345
 346       if ( r->state == STATE_MAXROW  && r->node_type == XML_READER_TYPE_TEXT)
 347         {
 348           n_cases = 1 + _xmlchar_to_int (value) ;
 349         }
 350       free (value);
 351     }
 352
 353
 354   /* If a range has been given, then  use that to calculate the number
 355      of cases */
 356   if ( opts->cell_range)
 357     {
 358       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
 359     }
 360
 361   if ( gri->read_names )
 362     {
 363       r->start_row++;
 364       n_cases --;
 365     }
 366
 367   /* Read in the first row of cells,
 368      including the headers if read_names was set */
 369   while (
 370          (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
 371          && (ret = xmlTextReaderRead (r->xtr))
 372          )
 373     {
 374       int idx;
 375       process_node (r);
 376
 377       if ( r->row > r->start_row ) break;
 378
 379       if ( r->col < r->start_col ||
 380            (r->stop_col != -1 && r->col > r->stop_col))
 381         continue;
 382
 383       idx = r->col - r->start_col;
 384
 385       if ( idx  >= n_var_specs )
 386         {
 387           int i;
 388           var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
 389           for (i = n_var_specs; i <= idx; ++i)
 390           {
 391             var_spec [i].name = NULL;
 392             var_spec [i].width = -1;
 393             var_spec [i].first_value = NULL;
 394           }
 395           n_var_specs =  idx + 1 ;
 396         }
 397
 398       if ( r->node_type == XML_READER_TYPE_TEXT )
 399         {
 400           xmlChar *value = xmlTextReaderValue (r->xtr);
 401           const char *text  = CHAR_CAST (const char *, value);
 402
 403           if ( r->row < r->start_row)
 404             {
 405               if ( gri->read_names )
 406                 {
 407                   var_spec [idx].name = xstrdup (text);
 408                 }
 409             }
 410           else
 411             {
 412               var_spec [idx].first_value = xmlStrdup (value);
 413
 414               if (-1 ==  var_spec [idx].width )
 415                 var_spec [idx].width = (gri->asw == -1) ?
 416                   ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : gri->asw;
 417             }
 418
 419           free (value);
 420         }
 421       else if ( r->node_type == XML_READER_TYPE_ELEMENT
 422                 && r->state == STATE_CELL)
 423         {
 424           if ( r->row == r->start_row )
 425             {
 426               xmlChar *attr =
 427                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
 428
 429               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
 430                 var_spec [idx].width = 0;
 431
 432               free (attr);
 433             }
 434         }
 435     }
 436
 437   {
 438     const xmlChar *enc = xmlTextReaderConstEncoding (r->xtr);
 439     if ( enc == NULL)
 440       goto error;
 441     /* Create the dictionary and populate it */
 442     *dict = r->dict = dict_create (CHAR_CAST (const char *, enc));
 443   }
 444
 445   for (i = 0 ; i < n_var_specs ; ++i )
 446     {
 447       char *name;
 448
 449       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
 450         continue;
 451
 452       /* Probably no data exists for this variable, so allocate a
 453          default width */
 454       if ( var_spec[i].width == -1 )
 455         var_spec[i].width = SPREADSHEET_DEFAULT_WIDTH;
 456
 457       name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
 458       dict_create_var (r->dict, name, var_spec[i].width);
 459       free (name);
 460     }
 461
 462   /* Create the first case, and cache it */
 463   r->used_first_case = false;
 464
 465   if ( n_var_specs ==  0 )
 466     {
 467       msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
 468            gri->file_name);
 469       goto error;
 470     }
 471
 472   r->proto = caseproto_ref (dict_get_proto (r->dict));
 473   r->first_case = case_create (r->proto);
 474   case_set_missing (r->first_case);
 475
 476   int x = 0;
 477   for ( i = 0 ; i < n_var_specs ; ++i )
 478     {
 479       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
 480         continue;
 481
 482       const struct variable *var = dict_get_var (r->dict, x++);
 483
 484       convert_xml_string_to_value (r->first_case, var,
 485                                    var_spec[i].first_value);
 486     }
 487
 488   for ( i = 0 ; i < n_var_specs ; ++i )
 489     {
 490       free (var_spec[i].first_value);
 491       free (var_spec[i].name);
 492     }
 493
 494   free (var_spec);
 495
 496
 497   if (opts->cell_range == NULL)
 498     {
 499       opts->cell_range = c_xasprintf ("%c%d:%c%d",
 500                                        r->start_col + 'A',
 501                                        r->start_row,
 502                                        r->stop_col + 'A' + caseproto_get_n_widths (r->proto),
 503                                        r->start_row + n_cases);
 504     }
 505
 506   return casereader_create_sequential
 507     (NULL,
 508      r->proto,
 509      n_cases,
 510      &gnm_file_casereader_class, r);
 511
 512
 513  error:
 514   for ( i = 0 ; i < n_var_specs ; ++i )
 515     {
 516       free (var_spec[i].first_value);
 517       free (var_spec[i].name);
 518     }
 519
 520   free (var_spec);
 521   dict_destroy (*dict);
 522   *dict = NULL;
 523
 524   gnm_file_casereader_destroy (NULL, r);
 525
 526   return NULL;
 527 };
 528
 529
 530 /* Reads and returns one case from READER's file.  Returns a null
 531    pointer on failure. */
 532 static struct ccase *
 533 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_)
 534 {
 535   struct ccase *c;
 536   int ret = 0;
 537
 538   struct gnumeric_reader *r = r_;
 539   int current_row = r->row;
 540
 541   if ( !r->used_first_case )
 542     {
 543       r->used_first_case = true;
 544       return r->first_case;
 545     }
 546
 547   c = case_create (r->proto);
 548   case_set_missing (c);
 549
 550   if (r->start_col == -1)
 551     r->start_col = r->min_col;
 552
 553   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
 554          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
 555     {
 556       process_node (r);
 557
 558       if ( r->col < r->start_col || (r->stop_col != -1 &&
 559                                      r->col > r->stop_col))
 560         continue;
 561
 562       if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
 563         continue;
 564
 565       if ( r->stop_row != -1 && r->row > r->stop_row)
 566         break;
 567
 568       if ( r->node_type == XML_READER_TYPE_TEXT )
 569         {
 570           xmlChar *value = xmlTextReaderValue (r->xtr);
 571
 572           const int idx = r->col - r->start_col;
 573
 574           const struct variable *var = dict_get_var (r->dict, idx);
 575
 576           convert_xml_string_to_value (c, var, value);
 577
 578           free (value);
 579         }
 580
 581     }
 582
 583   if (ret == 1)
 584     return c;
 585   else
 586     {
 587       case_unref (c);
 588       return NULL;
 589     }
 590 }
 591
 592
 593 #endif /* GNM_SUPPORT */