Move all command implementations into a single 'commands' directory.
[pspp] / src / language / commands / get-data.c
diff --git a/src/language/commands/get-data.c b/src/language/commands/get-data.c
new file mode 100644 (file)
index 0000000..deff70e
--- /dev/null
@@ -0,0 +1,630 @@
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012,
+                 2013, 2015, 2016 Free Software Foundation, Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+
+#include <config.h>
+
+#include <stdlib.h>
+
+#include <string.h>
+
+#include "data/dataset.h"
+#include "data/dictionary.h"
+#include "data/format.h"
+#include "data/gnumeric-reader.h"
+#include "data/ods-reader.h"
+#include "data/spreadsheet-reader.h"
+#include "data/psql-reader.h"
+#include "data/settings.h"
+#include "language/command.h"
+#include "language/commands/data-parser.h"
+#include "language/commands/data-reader.h"
+#include "language/commands/file-handle.h"
+#include "language/commands/placement-parser.h"
+#include "language/lexer/format-parser.h"
+#include "language/lexer/lexer.h"
+#include "libpspp/cast.h"
+#include "libpspp/i18n.h"
+#include "libpspp/message.h"
+
+#include "gl/xalloc.h"
+
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
+#define N_(msgid) (msgid)
+
+static bool parse_spreadsheet (struct lexer *lexer, char **filename,
+                              struct spreadsheet_read_options *opts);
+
+static void destroy_spreadsheet_read_info (struct spreadsheet_read_options *);
+
+static int parse_get_txt (struct lexer *, struct dataset *);
+static int parse_get_psql (struct lexer *, struct dataset *);
+static int parse_get_spreadsheet (struct lexer *, struct dataset *,
+                                  struct spreadsheet *(*probe)(
+                                    const char *filename, bool report_errors));
+
+int
+cmd_get_data (struct lexer *lexer, struct dataset *ds)
+{
+  if (!lex_force_match_phrase (lexer, "/TYPE="))
+    return CMD_FAILURE;
+
+  if (lex_match_id (lexer, "TXT"))
+    return parse_get_txt (lexer, ds);
+  else if (lex_match_id (lexer, "PSQL"))
+    return parse_get_psql (lexer, ds);
+  else if (lex_match_id (lexer, "GNM"))
+    return parse_get_spreadsheet (lexer, ds, gnumeric_probe);
+  else if (lex_match_id (lexer, "ODS"))
+    return parse_get_spreadsheet (lexer, ds, ods_probe);
+  else
+    {
+      lex_error_expecting (lexer, "TXT", "PSQL", "GNM", "ODS");
+      return CMD_FAILURE;
+    }
+}
+
+static int
+parse_get_spreadsheet (struct lexer *lexer, struct dataset *ds,
+                       struct spreadsheet *(*probe)(
+                         const char *filename, bool report_errors))
+{
+  struct spreadsheet_read_options opts;
+  char *filename;
+  if (!parse_spreadsheet (lexer, &filename, &opts))
+    return CMD_FAILURE;
+
+  bool ok = false;
+  struct spreadsheet *spreadsheet = probe (filename, true);
+  if (!spreadsheet)
+    {
+      msg (SE, _("error reading file `%s'"), filename);
+      goto done;
+    }
+
+  struct casereader *reader = spreadsheet_make_reader (spreadsheet, &opts);
+  if (reader)
+    {
+      dataset_set_dict (ds, dict_clone (spreadsheet->dict));
+      dataset_set_source (ds, reader);
+      ok = true;
+    }
+  spreadsheet_unref (spreadsheet);
+
+done:
+  free (filename);
+  destroy_spreadsheet_read_info (&opts);
+  return ok ? CMD_SUCCESS : CMD_FAILURE;
+}
+
+static int
+parse_get_psql (struct lexer *lexer, struct dataset *ds)
+{
+  if (!lex_force_match_phrase (lexer, "/CONNECT=") || !lex_force_string (lexer))
+    return CMD_FAILURE;
+
+  struct psql_read_info psql = {
+    .str_width = -1,
+    .bsize = -1,
+    .conninfo = ss_xstrdup (lex_tokss (lexer)),
+  };
+  bool ok = false;
+
+  lex_get (lexer);
+
+  while (lex_match (lexer, T_SLASH))
+    {
+      if (lex_match_id (lexer, "ASSUMEDSTRWIDTH"))
+       {
+         lex_match (lexer, T_EQUALS);
+          if (!lex_force_int_range (lexer, "ASSUMEDSTRWIDTH", 1, 32767))
+            goto done;
+          psql.str_width = lex_integer (lexer);
+          lex_get (lexer);
+       }
+      else if (lex_match_id (lexer, "BSIZE"))
+       {
+         lex_match (lexer, T_EQUALS);
+          if (!lex_force_int_range (lexer, "BSIZE", 1, INT_MAX))
+            goto done;
+          psql.bsize = lex_integer (lexer);
+          lex_get (lexer);
+       }
+      else if (lex_match_id (lexer, "UNENCRYPTED"))
+        psql.allow_clear = true;
+      else if (lex_match_id (lexer, "SQL"))
+       {
+         lex_match (lexer, T_EQUALS);
+         if (!lex_force_string (lexer))
+           goto done;
+
+          free (psql.sql);
+          psql.sql = ss_xstrdup (lex_tokss (lexer));
+         lex_get (lexer);
+       }
+     }
+
+  struct dictionary *dict = NULL;
+  struct casereader *reader = psql_open_reader (&psql, &dict);
+  if (reader)
+    {
+      dataset_set_dict (ds, dict);
+      dataset_set_source (ds, reader);
+    }
+
+ done:
+  free (psql.conninfo);
+  free (psql.sql);
+
+  return ok ? CMD_SUCCESS : CMD_FAILURE;
+}
+
+static bool
+parse_spreadsheet (struct lexer *lexer, char **filename,
+                  struct spreadsheet_read_options *opts)
+{
+  *opts = (struct spreadsheet_read_options) {
+    .sheet_index = 1,
+    .read_names = true,
+    .asw = -1,
+  };
+  *filename = NULL;
+
+  if (!lex_force_match_phrase (lexer, "/FILE=") || !lex_force_string (lexer))
+    goto error;
+
+  *filename = utf8_to_filename (lex_tokcstr (lexer));
+  lex_get (lexer);
+
+  while (lex_match (lexer, T_SLASH))
+    {
+      if (lex_match_id (lexer, "ASSUMEDSTRWIDTH"))
+       {
+         lex_match (lexer, T_EQUALS);
+          if (!lex_force_int_range (lexer, "ASSUMEDSTRWIDTH", 1, 32767))
+            goto error;
+          opts->asw = lex_integer (lexer);
+          lex_get (lexer);
+       }
+      else if (lex_match_id (lexer, "SHEET"))
+       {
+         lex_match (lexer, T_EQUALS);
+         if (lex_match_id (lexer, "NAME"))
+           {
+             if (!lex_force_string (lexer))
+               goto error;
+
+             opts->sheet_name = ss_xstrdup (lex_tokss (lexer));
+             opts->sheet_index = -1;
+
+             lex_get (lexer);
+           }
+         else if (lex_match_id (lexer, "INDEX"))
+           {
+              if (!lex_force_int_range (lexer, "INDEX", 1, INT_MAX))
+                goto error;
+             opts->sheet_index = lex_integer (lexer);
+             lex_get (lexer);
+           }
+         else
+           {
+              lex_error_expecting (lexer, "NAME", "INDEX");
+             goto error;
+           }
+       }
+      else if (lex_match_id (lexer, "CELLRANGE"))
+       {
+         lex_match (lexer, T_EQUALS);
+
+         if (lex_match_id (lexer, "FULL"))
+            opts->cell_range = NULL;
+         else if (lex_match_id (lexer, "RANGE"))
+           {
+             if (!lex_force_string (lexer))
+               goto error;
+
+             opts->cell_range = ss_xstrdup (lex_tokss (lexer));
+             lex_get (lexer);
+           }
+         else
+           {
+              lex_error_expecting (lexer, "FULL", "RANGE");
+             goto error;
+           }
+       }
+      else if (lex_match_id (lexer, "READNAMES"))
+       {
+         lex_match (lexer, T_EQUALS);
+
+         if (lex_match_id (lexer, "ON"))
+            opts->read_names = true;
+         else if (lex_match_id (lexer, "OFF"))
+            opts->read_names = false;
+         else
+           {
+              lex_error_expecting (lexer, "ON", "OFF");
+             goto error;
+           }
+       }
+      else
+       {
+         lex_error_expecting (lexer, "ASSUMEDSTRWIDTH", "SHEET", "CELLRANGE",
+                               "READNAMES");
+         goto error;
+       }
+    }
+
+  return true;
+
+ error:
+  destroy_spreadsheet_read_info (opts);
+  free (*filename);
+  return false;
+}
+
+
+static bool
+set_type (struct lexer *lexer, struct data_parser *parser,
+          enum data_parser_type type,
+          int type_start, int type_end, int *type_startp, int *type_endp)
+{
+  if (!*type_startp)
+    {
+      data_parser_set_type (parser, type);
+      *type_startp = type_start;
+      *type_endp = type_end;
+    }
+  else if (type != data_parser_get_type (parser))
+    {
+      msg (SE, _("FIXED and DELIMITED arrangements are mutually exclusive."));
+      lex_ofs_msg (lexer, SN, type_start, type_end,
+                   _("This syntax requires %s arrangement."),
+                   type == DP_FIXED ? "FIXED" : "DELIMITED");
+      lex_ofs_msg (lexer, SN, *type_startp, *type_endp,
+                   _("This syntax requires %s arrangement."),
+                   type == DP_FIXED ? "DELIMITED" : "FIXED");
+      return false;
+    }
+  return true;
+}
+
+static int
+parse_get_txt (struct lexer *lexer, struct dataset *ds)
+{
+  struct dictionary *dict = dict_create (get_default_encoding ());
+  struct data_parser *parser = data_parser_create ();
+  struct file_handle *fh = NULL;
+  char *encoding = NULL;
+  char *name = NULL;
+
+  if (!lex_force_match_phrase (lexer, "/FILE="))
+    goto error;
+  fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE, NULL);
+  if (fh == NULL)
+    goto error;
+
+  int type_start = 0, type_end = 0;
+  data_parser_set_type (parser, DP_DELIMITED);
+  data_parser_set_span (parser, false);
+  data_parser_set_quotes (parser, ss_empty ());
+  data_parser_set_quote_escape (parser, true);
+  data_parser_set_empty_line_has_field (parser, true);
+
+  for (;;)
+    {
+      if (!lex_force_match (lexer, T_SLASH))
+        goto error;
+
+      if (lex_match_id (lexer, "ENCODING"))
+       {
+         lex_match (lexer, T_EQUALS);
+         if (!lex_force_string (lexer))
+           goto error;
+
+          free (encoding);
+          encoding = ss_xstrdup (lex_tokss (lexer));
+
+         lex_get (lexer);
+       }
+      else if (lex_match_id (lexer, "ARRANGEMENT"))
+        {
+          bool ok;
+
+         lex_match (lexer, T_EQUALS);
+          if (lex_match_id (lexer, "FIXED"))
+            ok = set_type (lexer, parser, DP_FIXED,
+                           lex_ofs (lexer) - 3, lex_ofs (lexer) - 1,
+                           &type_start, &type_end);
+          else if (lex_match_id (lexer, "DELIMITED"))
+            ok = set_type (lexer, parser, DP_DELIMITED,
+                           lex_ofs (lexer) - 3, lex_ofs (lexer) - 1,
+                           &type_start, &type_end);
+          else
+            {
+              lex_error_expecting (lexer, "FIXED", "DELIMITED");
+              goto error;
+            }
+          if (!ok)
+            goto error;
+        }
+      else if (lex_match_id (lexer, "FIRSTCASE"))
+        {
+         lex_match (lexer, T_EQUALS);
+          if (!lex_force_int_range (lexer, "FIRSTCASE", 1, INT_MAX))
+            goto error;
+          data_parser_set_skip (parser, lex_integer (lexer) - 1);
+          lex_get (lexer);
+        }
+      else if (lex_match_id_n (lexer, "DELCASE", 4))
+        {
+          if (!set_type (lexer, parser, DP_DELIMITED,
+                         lex_ofs (lexer) - 1, lex_ofs (lexer) - 1,
+                         &type_start, &type_end))
+            goto error;
+          lex_match (lexer, T_EQUALS);
+          if (lex_match_id (lexer, "LINE"))
+            data_parser_set_span (parser, false);
+          else if (lex_match_id (lexer, "VARIABLES"))
+            {
+              data_parser_set_span (parser, true);
+
+              /* VARIABLES takes an integer argument, but for no
+                 good reason.  We just ignore it. */
+              if (!lex_force_int (lexer))
+                goto error;
+              lex_get (lexer);
+            }
+          else
+            {
+              lex_error_expecting (lexer, "LINE", "VARIABLES");
+              goto error;
+            }
+        }
+      else if (lex_match_id (lexer, "FIXCASE"))
+        {
+          if (!set_type (lexer, parser, DP_FIXED,
+                         lex_ofs (lexer) - 1, lex_ofs (lexer) - 1,
+                         &type_start, &type_end))
+            goto error;
+          lex_match (lexer, T_EQUALS);
+          if (!lex_force_int_range (lexer, "FIXCASE", 1, INT_MAX))
+            goto error;
+          data_parser_set_records (parser, lex_integer (lexer));
+          lex_get (lexer);
+        }
+      else if (lex_match_id (lexer, "IMPORTCASES"))
+        {
+          int start_ofs = lex_ofs (lexer) - 1;
+          lex_match (lexer, T_EQUALS);
+          if (lex_match (lexer, T_ALL))
+            {
+              /* Nothing to do. */
+            }
+          else if (lex_match_id (lexer, "FIRST"))
+            {
+              if (!lex_force_int (lexer))
+                goto error;
+              lex_get (lexer);
+            }
+          else if (lex_match_id (lexer, "PERCENT"))
+            {
+              if (!lex_force_int (lexer))
+                goto error;
+              lex_get (lexer);
+            }
+          lex_ofs_msg (lexer, SW, start_ofs, lex_ofs (lexer) - 1,
+                       _("Ignoring obsolete IMPORTCASES subcommand.  (N OF "
+                         "CASES or SAMPLE may be used to substitute.)"));
+        }
+      else if (lex_match_id_n (lexer, "DELIMITERS", 4))
+        {
+          if (!set_type (lexer, parser, DP_DELIMITED,
+                         lex_ofs (lexer) - 1, lex_ofs (lexer) - 1,
+                         &type_start, &type_end))
+            goto error;
+          lex_match (lexer, T_EQUALS);
+
+          if (!lex_force_string (lexer))
+            goto error;
+
+          /* XXX should support multibyte UTF-8 characters */
+          struct substring s = lex_tokss (lexer);
+          struct string hard_seps = DS_EMPTY_INITIALIZER;
+          const char *soft_seps = "";
+          if (ss_match_string (&s, ss_cstr ("\\t")))
+            ds_put_cstr (&hard_seps, "\t");
+          if (ss_match_string (&s, ss_cstr ("\\\\")))
+            ds_put_cstr (&hard_seps, "\\");
+          int c;
+          while ((c = ss_get_byte (&s)) != EOF)
+            if (c == ' ')
+              soft_seps = " ";
+            else
+              ds_put_byte (&hard_seps, c);
+          data_parser_set_soft_delimiters (parser, ss_cstr (soft_seps));
+          data_parser_set_hard_delimiters (parser, ds_ss (&hard_seps));
+          ds_destroy (&hard_seps);
+
+          lex_get (lexer);
+        }
+      else if (lex_match_id (lexer, "QUALIFIERS"))
+        {
+          if (!set_type (lexer, parser, DP_DELIMITED,
+                         lex_ofs (lexer) - 1, lex_ofs (lexer) - 1,
+                         &type_start, &type_end))
+            goto error;
+          lex_match (lexer, T_EQUALS);
+
+          if (!lex_force_string (lexer))
+            goto error;
+
+          /* XXX should support multibyte UTF-8 characters */
+          if (settings_get_syntax () == COMPATIBLE
+              && ss_length (lex_tokss (lexer)) != 1)
+            {
+              lex_error (lexer, _("In compatible syntax mode, the QUALIFIER "
+                                  "string must contain exactly one character."));
+              goto error;
+            }
+
+          data_parser_set_quotes (parser, lex_tokss (lexer));
+          lex_get (lexer);
+        }
+      else if (lex_match_id (lexer, "VARIABLES"))
+        break;
+      else
+        {
+          lex_error_expecting (lexer, "VARIABLES");
+          goto error;
+        }
+    }
+  lex_match (lexer, T_EQUALS);
+
+  int record = 1;
+  enum data_parser_type type = data_parser_get_type (parser);
+  do
+    {
+      while (type == DP_FIXED && lex_match (lexer, T_SLASH))
+        {
+          if (!lex_force_int_range (lexer, NULL, record,
+                                    data_parser_get_records (parser)))
+            goto error;
+          record = lex_integer (lexer);
+          lex_get (lexer);
+        }
+
+      int name_ofs = lex_ofs (lexer);
+      if (!lex_force_id (lexer))
+        goto error;
+      name = xstrdup (lex_tokcstr (lexer));
+      char *error = dict_id_is_valid__ (dict, name);
+      if (error)
+        {
+          lex_error (lexer, "%s", error);
+          free (error);
+         goto error;
+       }
+      lex_get (lexer);
+
+      struct fmt_spec input, output;
+      int fc, lc;
+      if (type == DP_DELIMITED)
+        {
+          if (!parse_format_specifier (lexer, &input))
+            goto error;
+          error = fmt_check_input__ (&input);
+          if (error)
+           {
+              lex_next_error (lexer, -1, -1, "%s", error);
+              free (error);
+             goto error;
+           }
+          output = fmt_for_output_from_input (&input,
+                                              settings_get_fmt_settings ());
+        }
+      else
+        {
+          int start_ofs = lex_ofs (lexer);
+          if (!parse_column_range (lexer, 0, &fc, &lc, NULL))
+            goto error;
+
+          /* Accept a format (e.g. F8.2) or just a type name (e.g. DOLLAR).  */
+          char fmt_type_name[FMT_TYPE_LEN_MAX + 1];
+          uint16_t w;
+          uint8_t d;
+          if (!parse_abstract_format_specifier (lexer, fmt_type_name, &w, &d))
+            goto error;
+
+          enum fmt_type fmt_type;
+          if (!fmt_from_name (fmt_type_name, &fmt_type))
+            {
+              lex_next_error (lexer, -1, -1,
+                              _("Unknown format type `%s'."), fmt_type_name);
+              goto error;
+            }
+          int end_ofs = lex_ofs (lexer) - 1;
+
+          /* Compose input format. */
+          input = (struct fmt_spec) { .type = fmt_type, .w = lc - fc + 1 };
+          error = fmt_check_input__ (&input);
+          if (error)
+            {
+              lex_ofs_error (lexer, start_ofs, end_ofs, "%s", error);
+              free (error);
+              goto error;
+            }
+
+          /* Compose output format. */
+          if (w != 0)
+            {
+              output = (struct fmt_spec) { .type = fmt_type, .w = w, .d = d };
+              error = fmt_check_output__ (&output);
+              if (error)
+                {
+                  lex_ofs_error (lexer, start_ofs, end_ofs, "%s", error);
+                  free (error);
+                  goto error;
+                }
+            }
+          else
+            output = fmt_for_output_from_input (&input,
+                                                settings_get_fmt_settings ());
+        }
+      struct variable *v = dict_create_var (dict, name, fmt_var_width (&input));
+      if (!v)
+        {
+          lex_ofs_error (lexer, name_ofs, name_ofs,
+                         _("%s is a duplicate variable name."), name);
+          goto error;
+        }
+      var_set_both_formats (v, &output);
+      if (type == DP_DELIMITED)
+        data_parser_add_delimited_field (parser, &input,
+                                         var_get_case_index (v),
+                                         name);
+      else
+        data_parser_add_fixed_field (parser, &input, var_get_case_index (v),
+                                     name, record, fc);
+      free (name);
+      name = NULL;
+    }
+  while (lex_token (lexer) != T_ENDCMD);
+
+  struct dfm_reader *reader = dfm_open_reader (fh, lexer, encoding);
+  if (!reader)
+    goto error;
+
+  data_parser_make_active_file (parser, ds, reader, dict, NULL, NULL);
+  fh_unref (fh);
+  free (encoding);
+  return CMD_SUCCESS;
+
+ error:
+  data_parser_destroy (parser);
+  dict_unref (dict);
+  fh_unref (fh);
+  free (name);
+  free (encoding);
+  return CMD_CASCADING_FAILURE;
+}
+
+static void
+destroy_spreadsheet_read_info (struct spreadsheet_read_options *opts)
+{
+  free (opts->cell_range);
+  free (opts->sheet_name);
+}