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