pintos-os.org Git - pspp/blob - src/language/data-io/get-data.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2008, 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 <stdlib.h>
  20
  21 #include <string.h>
  22
  23 #include "data/dataset.h"
  24 #include "data/dictionary.h"
  25 #include "data/format.h"
  26 #include "data/gnumeric-reader.h"
  27 #include "data/ods-reader.h"
  28 #include "data/spreadsheet-reader.h"
  29 #include "data/psql-reader.h"
  30 #include "data/settings.h"
  31 #include "language/command.h"
  32 #include "language/data-io/data-parser.h"
  33 #include "language/data-io/data-reader.h"
  34 #include "language/data-io/file-handle.h"
  35 #include "language/data-io/placement-parser.h"
  36 #include "language/lexer/format-parser.h"
  37 #include "language/lexer/lexer.h"
  38 #include "libpspp/cast.h"
  39 #include "libpspp/i18n.h"
  40 #include "libpspp/message.h"
  41
  42 #include "gl/xalloc.h"
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46 #define N_(msgid) (msgid)
  47
  48 static struct spreadsheet_read_info *parse_spreadsheet (struct lexer *lexer);
  49 static void destroy_spreadsheet_read_info (struct spreadsheet_read_info *);
  50
  51 static int parse_get_txt (struct lexer *lexer, struct dataset *);
  52 static int parse_get_psql (struct lexer *lexer, struct dataset *);
  53
  54 int
  55 cmd_get_data (struct lexer *lexer, struct dataset *ds)
  56 {
  57   char *tok = NULL;
  58   lex_force_match (lexer, T_SLASH);
  59
  60   if (!lex_force_match_id (lexer, "TYPE"))
  61     return CMD_FAILURE;
  62
  63   lex_force_match (lexer, T_EQUALS);
  64
  65   tok = strdup (lex_tokcstr (lexer));
  66   if (lex_match_id (lexer, "TXT"))
  67     {
  68       free (tok);
  69       return parse_get_txt (lexer, ds);
  70     }
  71   else if (lex_match_id (lexer, "PSQL"))
  72     {
  73       free (tok);
  74       return parse_get_psql (lexer, ds);
  75     }
  76   else if (lex_match_id (lexer, "GNM") ||
  77       lex_match_id (lexer, "ODS"))
  78     {
  79       struct casereader *reader = NULL;
  80       struct dictionary *dict = NULL;
  81       struct spreadsheet_read_info *sri = parse_spreadsheet (lexer);
  82       if (NULL == sri)
  83         goto error;
  84
  85       if ( 0 == strncasecmp (tok, "GNM", 3))
  86         reader = gnumeric_open_reader (sri, &dict);
  87       else if (0 == strncasecmp (tok, "ODS", 3))
  88         reader = ods_open_reader (sri, &dict);
  89
  90       if (reader)
  91         {
  92           dataset_set_dict (ds, dict);
  93           dataset_set_source (ds, reader);
  94           destroy_spreadsheet_read_info (sri);
  95           free (tok);
  96           return CMD_SUCCESS;
  97         }
  98       destroy_spreadsheet_read_info (sri);
  99     }
 100   else
 101     msg (SE, _("Unsupported TYPE %s."), tok);
 102
 103  error:
 104   free (tok);
 105   return CMD_FAILURE;
 106 }
 107
 108 static int
 109 parse_get_psql (struct lexer *lexer, struct dataset *ds)
 110 {
 111   struct psql_read_info psql;
 112   psql.allow_clear = false;
 113   psql.conninfo = NULL;
 114   psql.str_width = -1;
 115   psql.bsize = -1;
 116   ds_init_empty (&psql.sql);
 117
 118   lex_force_match (lexer, T_SLASH);
 119
 120   if (!lex_force_match_id (lexer, "CONNECT"))
 121     goto error;
 122
 123   lex_force_match (lexer, T_EQUALS);
 124
 125   if (!lex_force_string (lexer))
 126     goto error;
 127
 128   psql.conninfo = ss_xstrdup (lex_tokss (lexer));
 129
 130   lex_get (lexer);
 131
 132   while (lex_match (lexer, T_SLASH) )
 133     {
 134       if ( lex_match_id (lexer, "ASSUMEDSTRWIDTH"))
 135         {
 136           lex_match (lexer, T_EQUALS);
 137           psql.str_width = lex_integer (lexer);
 138           lex_get (lexer);
 139         }
 140       else if ( lex_match_id (lexer, "BSIZE"))
 141         {
 142           lex_match (lexer, T_EQUALS);
 143           psql.bsize = lex_integer (lexer);
 144           lex_get (lexer);
 145         }
 146       else if ( lex_match_id (lexer, "UNENCRYPTED"))
 147         {
 148           psql.allow_clear = true;
 149         }
 150       else if (lex_match_id (lexer, "SQL"))
 151         {
 152           lex_match (lexer, T_EQUALS);
 153           if ( ! lex_force_string (lexer) )
 154             goto error;
 155
 156           ds_put_substring (&psql.sql, lex_tokss (lexer));
 157           lex_get (lexer);
 158         }
 159      }
 160   {
 161     struct dictionary *dict = NULL;
 162     struct casereader *reader = psql_open_reader (&psql, &dict);
 163
 164     if ( reader )
 165       {
 166         dataset_set_dict (ds, dict);
 167         dataset_set_source (ds, reader);
 168       }
 169   }
 170
 171   ds_destroy (&psql.sql);
 172   free (psql.conninfo);
 173
 174   return CMD_SUCCESS;
 175
 176  error:
 177
 178   ds_destroy (&psql.sql);
 179   free (psql.conninfo);
 180
 181   return CMD_FAILURE;
 182 }
 183
 184 static struct spreadsheet_read_info *
 185 parse_spreadsheet (struct lexer *lexer)
 186 {
 187   struct spreadsheet_read_info *sri = xzalloc (sizeof *sri);
 188   sri->sheet_index = 1;
 189   sri->read_names = true;
 190   sri->asw = -1;
 191
 192   lex_force_match (lexer, T_SLASH);
 193
 194   if (!lex_force_match_id (lexer, "FILE"))
 195     goto error;
 196
 197   lex_force_match (lexer, T_EQUALS);
 198
 199   if (!lex_force_string (lexer))
 200     goto error;
 201
 202   sri->file_name = utf8_to_filename (lex_tokcstr (lexer));
 203
 204   lex_get (lexer);
 205
 206   while (lex_match (lexer, T_SLASH) )
 207     {
 208       if ( lex_match_id (lexer, "ASSUMEDSTRWIDTH"))
 209         {
 210           lex_match (lexer, T_EQUALS);
 211           sri->asw = lex_integer (lexer);
 212           lex_get (lexer);
 213         }
 214       else if (lex_match_id (lexer, "SHEET"))
 215         {
 216           lex_match (lexer, T_EQUALS);
 217           if (lex_match_id (lexer, "NAME"))
 218             {
 219               if ( ! lex_force_string (lexer) )
 220                 goto error;
 221
 222               sri->sheet_name = ss_xstrdup (lex_tokss (lexer));
 223               sri->sheet_index = -1;
 224
 225               lex_get (lexer);
 226             }
 227           else if (lex_match_id (lexer, "INDEX"))
 228             {
 229               sri->sheet_index = lex_integer (lexer);
 230               lex_get (lexer);
 231             }
 232           else
 233             goto error;
 234         }
 235       else if (lex_match_id (lexer, "CELLRANGE"))
 236         {
 237           lex_match (lexer, T_EQUALS);
 238
 239           if (lex_match_id (lexer, "FULL"))
 240             {
 241               sri->cell_range = NULL;
 242             }
 243           else if (lex_match_id (lexer, "RANGE"))
 244             {
 245               if ( ! lex_force_string (lexer) )
 246                 goto error;
 247
 248               sri->cell_range = ss_xstrdup (lex_tokss (lexer));
 249               lex_get (lexer);
 250             }
 251           else
 252             goto error;
 253         }
 254       else if (lex_match_id (lexer, "READNAMES"))
 255         {
 256           lex_match (lexer, T_EQUALS);
 257
 258           if ( lex_match_id (lexer, "ON"))
 259             {
 260               sri->read_names = true;
 261             }
 262           else if (lex_match_id (lexer, "OFF"))
 263             {
 264               sri->read_names = false;
 265             }
 266           else
 267             goto error;
 268         }
 269       else
 270         {
 271           lex_error (lexer, NULL);
 272           goto error;
 273         }
 274     }
 275
 276   return sri;
 277
 278  error:
 279   destroy_spreadsheet_read_info (sri);
 280   return NULL;
 281 }
 282
 283
 284 static bool
 285 set_type (struct data_parser *parser, const char *subcommand,
 286           enum data_parser_type type, bool *has_type)
 287 {
 288   if (!*has_type)
 289     {
 290       data_parser_set_type (parser, type);
 291       *has_type = true;
 292     }
 293   else if (type != data_parser_get_type (parser))
 294     {
 295       msg (SE, _("%s is allowed only with %s arrangement, but %s arrangement "
 296                  "was stated or implied earlier in this command."),
 297            subcommand,
 298            type == DP_FIXED ? "FIXED" : "DELIMITED",
 299            type == DP_FIXED ? "DELIMITED" : "FIXED");
 300       return false;
 301     }
 302   return true;
 303 }
 304
 305 static int
 306 parse_get_txt (struct lexer *lexer, struct dataset *ds)
 307 {
 308   struct data_parser *parser = NULL;
 309   struct dictionary *dict = dict_create (get_default_encoding ());
 310   struct file_handle *fh = NULL;
 311   struct dfm_reader *reader = NULL;
 312   char *encoding = NULL;
 313   char *name = NULL;
 314
 315   int record;
 316   enum data_parser_type type;
 317   bool has_type;
 318
 319   lex_force_match (lexer, T_SLASH);
 320
 321   if (!lex_force_match_id (lexer, "FILE"))
 322     goto error;
 323   lex_force_match (lexer, T_EQUALS);
 324   fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE, NULL);
 325   if (fh == NULL)
 326     goto error;
 327
 328   parser = data_parser_create (dict);
 329   has_type = false;
 330   data_parser_set_type (parser, DP_DELIMITED);
 331   data_parser_set_span (parser, false);
 332   data_parser_set_quotes (parser, ss_empty ());
 333   data_parser_set_empty_line_has_field (parser, true);
 334
 335   for (;;)
 336     {
 337       if (!lex_force_match (lexer, T_SLASH))
 338         goto error;
 339
 340       if (lex_match_id (lexer, "ENCODING"))
 341         {
 342           lex_match (lexer, T_EQUALS);
 343           if (!lex_force_string (lexer))
 344             goto error;
 345
 346           free (encoding);
 347           encoding = ss_xstrdup (lex_tokss (lexer));
 348
 349           lex_get (lexer);
 350         }
 351       else if (lex_match_id (lexer, "ARRANGEMENT"))
 352         {
 353           bool ok;
 354
 355           lex_match (lexer, T_EQUALS);
 356           if (lex_match_id (lexer, "FIXED"))
 357             ok = set_type (parser, "ARRANGEMENT=FIXED", DP_FIXED, &has_type);
 358           else if (lex_match_id (lexer, "DELIMITED"))
 359             ok = set_type (parser, "ARRANGEMENT=DELIMITED",
 360                            DP_DELIMITED, &has_type);
 361           else
 362             {
 363               lex_error_expecting (lexer, "FIXED", "DELIMITED", NULL_SENTINEL);
 364               goto error;
 365             }
 366           if (!ok)
 367             goto error;
 368         }
 369       else if (lex_match_id (lexer, "FIRSTCASE"))
 370         {
 371           lex_match (lexer, T_EQUALS);
 372           if (!lex_force_int (lexer))
 373             goto error;
 374           if (lex_integer (lexer) < 1)
 375             {
 376               msg (SE, _("Value of FIRSTCASE must be 1 or greater."));
 377               goto error;
 378             }
 379           data_parser_set_skip (parser, lex_integer (lexer) - 1);
 380           lex_get (lexer);
 381         }
 382       else if (lex_match_id_n (lexer, "DELCASE", 4))
 383         {
 384           if (!set_type (parser, "DELCASE", DP_DELIMITED, &has_type))
 385             goto error;
 386           lex_match (lexer, T_EQUALS);
 387           if (lex_match_id (lexer, "LINE"))
 388             data_parser_set_span (parser, false);
 389           else if (lex_match_id (lexer, "VARIABLES"))
 390             {
 391               data_parser_set_span (parser, true);
 392
 393               /* VARIABLES takes an integer argument, but for no
 394                  good reason.  We just ignore it. */
 395               if (!lex_force_int (lexer))
 396                 goto error;
 397               lex_get (lexer);
 398             }
 399           else
 400             {
 401               lex_error_expecting (lexer, "LINE", "VARIABLES", NULL_SENTINEL);
 402               goto error;
 403             }
 404         }
 405       else if (lex_match_id (lexer, "FIXCASE"))
 406         {
 407           if (!set_type (parser, "FIXCASE", DP_FIXED, &has_type))
 408             goto error;
 409           lex_match (lexer, T_EQUALS);
 410           if (!lex_force_int (lexer))
 411             goto error;
 412           if (lex_integer (lexer) < 1)
 413             {
 414               msg (SE, _("Value of FIXCASE must be at least 1."));
 415               goto error;
 416             }
 417           data_parser_set_records (parser, lex_integer (lexer));
 418           lex_get (lexer);
 419         }
 420       else if (lex_match_id (lexer, "IMPORTCASES"))
 421         {
 422           lex_match (lexer, T_EQUALS);
 423           if (lex_match (lexer, T_ALL))
 424             {
 425               data_parser_set_case_limit (parser, -1);
 426               data_parser_set_case_percent (parser, 100);
 427             }
 428           else if (lex_match_id (lexer, "FIRST"))
 429             {
 430               if (!lex_force_int (lexer))
 431                 goto error;
 432               if (lex_integer (lexer) < 1)
 433                 {
 434                   msg (SE, _("Value of FIRST must be at least 1."));
 435                   goto error;
 436                 }
 437               data_parser_set_case_limit (parser, lex_integer (lexer));
 438               lex_get (lexer);
 439             }
 440           else if (lex_match_id (lexer, "PERCENT"))
 441             {
 442               if (!lex_force_int (lexer))
 443                 goto error;
 444               if (lex_integer (lexer) < 1 || lex_integer (lexer) > 100)
 445                 {
 446                   msg (SE, _("Value of PERCENT must be between 1 and 100."));
 447                   goto error;
 448                 }
 449               data_parser_set_case_percent (parser, lex_integer (lexer));
 450               lex_get (lexer);
 451             }
 452         }
 453       else if (lex_match_id_n (lexer, "DELIMITERS", 4))
 454         {
 455           struct string hard_seps = DS_EMPTY_INITIALIZER;
 456           const char *soft_seps = "";
 457           struct substring s;
 458           int c;
 459
 460           if (!set_type (parser, "DELIMITERS", DP_DELIMITED, &has_type))
 461             goto error;
 462           lex_match (lexer, T_EQUALS);
 463
 464           if (!lex_force_string (lexer))
 465             goto error;
 466
 467           /* XXX should support multibyte UTF-8 characters */
 468           s = lex_tokss (lexer);
 469           if (ss_match_string (&s, ss_cstr ("\\t")))
 470             ds_put_cstr (&hard_seps, "\t");
 471           if (ss_match_string (&s, ss_cstr ("\\\\")))
 472             ds_put_cstr (&hard_seps, "\\");
 473           while ((c = ss_get_byte (&s)) != EOF)
 474             if (c == ' ')
 475               soft_seps = " ";
 476             else
 477               ds_put_byte (&hard_seps, c);
 478           data_parser_set_soft_delimiters (parser, ss_cstr (soft_seps));
 479           data_parser_set_hard_delimiters (parser, ds_ss (&hard_seps));
 480           ds_destroy (&hard_seps);
 481
 482           lex_get (lexer);
 483         }
 484       else if (lex_match_id (lexer, "QUALIFIERS"))
 485         {
 486           if (!set_type (parser, "QUALIFIERS", DP_DELIMITED, &has_type))
 487             goto error;
 488           lex_match (lexer, T_EQUALS);
 489
 490           if (!lex_force_string (lexer))
 491             goto error;
 492
 493           /* XXX should support multibyte UTF-8 characters */
 494           if (settings_get_syntax () == COMPATIBLE
 495               && ss_length (lex_tokss (lexer)) != 1)
 496             {
 497               msg (SE, _("In compatible syntax mode, the QUALIFIER string "
 498                          "must contain exactly one character."));
 499               goto error;
 500             }
 501
 502           data_parser_set_quotes (parser, lex_tokss (lexer));
 503           lex_get (lexer);
 504         }
 505       else if (settings_get_syntax () == ENHANCED
 506                && lex_match_id (lexer, "ESCAPE"))
 507         data_parser_set_quote_escape (parser, true);
 508       else if (lex_match_id (lexer, "VARIABLES"))
 509         break;
 510       else
 511         {
 512           lex_error_expecting (lexer, "VARIABLES", NULL_SENTINEL);
 513           goto error;
 514         }
 515     }
 516   lex_match (lexer, T_EQUALS);
 517
 518   record = 1;
 519   type = data_parser_get_type (parser);
 520   do
 521     {
 522       struct fmt_spec input, output;
 523       struct variable *v;
 524       int fc, lc;
 525
 526       while (type == DP_FIXED && lex_match (lexer, T_SLASH))
 527         {
 528           if (!lex_force_int (lexer))
 529             goto error;
 530           if (lex_integer (lexer) < record)
 531             {
 532               msg (SE, _("The record number specified, %ld, is at or "
 533                          "before the previous record, %d.  Data "
 534                          "fields must be listed in order of "
 535                          "increasing record number."),
 536                    lex_integer (lexer), record);
 537               goto error;
 538             }
 539           if (lex_integer (lexer) > data_parser_get_records (parser))
 540             {
 541               msg (SE, _("The record number specified, %ld, exceeds "
 542                          "the number of records per case specified "
 543                          "on FIXCASE, %d."),
 544                    lex_integer (lexer), data_parser_get_records (parser));
 545               goto error;
 546             }
 547           record = lex_integer (lexer);
 548           lex_get (lexer);
 549         }
 550
 551       if (!lex_force_id (lexer)
 552           || !dict_id_is_valid (dict, lex_tokcstr (lexer), true))
 553         goto error;
 554       name = xstrdup (lex_tokcstr (lexer));
 555       lex_get (lexer);
 556
 557       if (type == DP_DELIMITED)
 558         {
 559           if (!parse_format_specifier (lexer, &input)
 560               || !fmt_check_input (&input))
 561             goto error;
 562
 563           output = fmt_for_output_from_input (&input);
 564         }
 565       else
 566         {
 567           char fmt_type_name[FMT_TYPE_LEN_MAX + 1];
 568           enum fmt_type fmt_type;
 569           int w, d;
 570
 571           if (!parse_column_range (lexer, 0, &fc, &lc, NULL))
 572             goto error;
 573
 574           /* Accept a format (e.g. F8.2) or just a type name (e.g. DOLLAR).  */
 575           if (!parse_abstract_format_specifier (lexer, fmt_type_name, &w, &d))
 576             goto error;
 577           if (!fmt_from_name (fmt_type_name, &fmt_type))
 578             {
 579               msg (SE, _("Unknown format type `%s'."), fmt_type_name);
 580               goto error;
 581             }
 582
 583           /* Compose input format. */
 584           input.type = fmt_type;
 585           input.w = lc - fc + 1;
 586           input.d = 0;
 587           if (!fmt_check_input (&input))
 588             goto error;
 589
 590           /* Compose output format. */
 591           if (w != 0)
 592             {
 593               output.type = fmt_type;
 594               output.w = w;
 595               output.d = d;
 596               if (!fmt_check_output (&output))
 597                 goto error;
 598             }
 599           else
 600             output = fmt_for_output_from_input (&input);
 601         }
 602
 603       v = dict_create_var (dict, name, fmt_var_width (&input));
 604       if (v == NULL)
 605         {
 606           msg (SE, _("%s is a duplicate variable name."), name);
 607           goto error;
 608         }
 609       var_set_both_formats (v, &output);
 610
 611       if (type == DP_DELIMITED)
 612         data_parser_add_delimited_field (parser, &input,
 613                                          var_get_case_index (v),
 614                                          name);
 615       else
 616         data_parser_add_fixed_field (parser, &input, var_get_case_index (v),
 617                                      name, record, fc);
 618       free (name);
 619       name = NULL;
 620     }
 621   while (lex_token (lexer) != T_ENDCMD);
 622
 623   reader = dfm_open_reader (fh, lexer, encoding);
 624   if (reader == NULL)
 625     goto error;
 626
 627   data_parser_make_active_file (parser, ds, reader, dict);
 628   fh_unref (fh);
 629   free (encoding);
 630   return CMD_SUCCESS;
 631
 632  error:
 633   data_parser_destroy (parser);
 634   dict_destroy (dict);
 635   fh_unref (fh);
 636   free (name);
 637   free (encoding);
 638   return CMD_CASCADING_FAILURE;
 639 }
 640
 641
 642 static void
 643 destroy_spreadsheet_read_info (struct spreadsheet_read_info *sri)
 644 {
 645   if ( NULL == sri)
 646     return;
 647
 648   free (sri->sheet_name);
 649   free (sri->cell_range);
 650   free (sri->file_name);
 651   free (sri);
 652 }