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