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