pintos-os.org Git - pspp/blob - src/data/csv-file-writer.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2010, 2011, 2012, 2013, 2014 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 "data/csv-file-writer.h"
  20
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <math.h>
  24 #include <stdint.h>
  25 #include <stdlib.h>
  26 #include <sys/stat.h>
  27 #include <time.h>
  28
  29 #include "data/calendar.h"
  30 #include "data/case.h"
  31 #include "data/casewriter-provider.h"
  32 #include "data/casewriter.h"
  33 #include "data/data-out.h"
  34 #include "data/dictionary.h"
  35 #include "data/file-handle-def.h"
  36 #include "data/file-name.h"
  37 #include "data/format.h"
  38 #include "data/make-file.h"
  39 #include "data/missing-values.h"
  40 #include "data/settings.h"
  41 #include "data/value-labels.h"
  42 #include "data/variable.h"
  43 #include "libpspp/assertion.h"
  44 #include "libpspp/i18n.h"
  45 #include "libpspp/message.h"
  46 #include "libpspp/str.h"
  47
  48 #include "gl/ftoastr.h"
  49 #include "gl/minmax.h"
  50 #include "gl/unlocked-io.h"
  51 #include "gl/xalloc.h"
  52
  53 #include "gettext.h"
  54 #define _(msgid) gettext (msgid)
  55 #define N_(msgid) (msgid)
  56
  57 /* A variable in a CSV file. */
  58 struct csv_var
  59   {
  60     int width;                     /* Variable width (0 to 32767). */
  61     int case_index;                /* Index into case. */
  62     struct fmt_spec format;        /* Print format. */
  63     struct missing_values missing; /* User-missing values, if recoding. */
  64     struct val_labs *val_labs;  /* Value labels, if any and they are in use. */
  65   };
  66
  67 /* Comma-separated value (CSV) file writer. */
  68 struct csv_writer
  69   {
  70     struct file_handle *fh;     /* File handle. */
  71     struct fh_lock *lock;       /* Mutual exclusion for file. */
  72     FILE *file;                 /* File stream. */
  73     struct replace_file *rf;    /* Ticket for replacing output file. */
  74
  75     struct csv_writer_options opts;
  76
  77     char *encoding;             /* Encoding used by variables. */
  78
  79     /* Variables. */
  80     struct csv_var *csv_vars;   /* Variables. */
  81     size_t n_csv_vars;         /* Number of variables. */
  82   };
  83
  84 static const struct casewriter_class csv_file_casewriter_class;
  85
  86 static void write_var_names (struct csv_writer *, const struct dictionary *);
  87
  88 static bool write_error (const struct csv_writer *);
  89 static bool close_writer (struct csv_writer *);
  90
  91 /* Initializes OPTS with default options for writing a CSV file. */
  92 void
  93 csv_writer_options_init (struct csv_writer_options *opts)
  94 {
  95   opts->recode_user_missing = false;
  96   opts->include_var_names = false;
  97   opts->use_value_labels = false;
  98   opts->use_print_formats = false;
  99   opts->decimal = settings_get_decimal_char (FMT_F);
 100   opts->delimiter = ',';
 101   opts->qualifier = '"';
 102 }
 103
 104 /* Opens the CSV file designated by file handle FH for writing cases from
 105    dictionary DICT according to the given OPTS.
 106
 107    No reference to D is retained, so it may be modified or
 108    destroyed at will after this function returns. */
 109 struct casewriter *
 110 csv_writer_open (struct file_handle *fh, const struct dictionary *dict,
 111                  const struct csv_writer_options *opts)
 112 {
 113   struct csv_writer *w;
 114   int i;
 115
 116   /* Create and initialize writer. */
 117   w = xmalloc (sizeof *w);
 118   w->fh = fh_ref (fh);
 119   w->lock = NULL;
 120   w->file = NULL;
 121   w->rf = NULL;
 122
 123   w->opts = *opts;
 124
 125   w->encoding = xstrdup (dict_get_encoding (dict));
 126
 127   w->n_csv_vars = dict_get_var_cnt (dict);
 128   w->csv_vars = xnmalloc (w->n_csv_vars, sizeof *w->csv_vars);
 129   for (i = 0; i < w->n_csv_vars; i++)
 130     {
 131       const struct variable *var = dict_get_var (dict, i);
 132       struct csv_var *cv = &w->csv_vars[i];
 133
 134       cv->width = var_get_width (var);
 135       cv->case_index = var_get_case_index (var);
 136
 137       cv->format = *var_get_print_format (var);
 138       if (opts->recode_user_missing)
 139         mv_copy (&cv->missing, var_get_missing_values (var));
 140       else
 141         mv_init (&cv->missing, cv->width);
 142
 143       if (opts->use_value_labels)
 144         cv->val_labs = val_labs_clone (var_get_value_labels (var));
 145       else
 146         cv->val_labs = NULL;
 147     }
 148
 149   /* Open file handle as an exclusive writer. */
 150   /* TRANSLATORS: this fragment will be interpolated into messages in fh_lock()
 151      that identify types of files. */
 152   w->lock = fh_lock (fh, FH_REF_FILE, N_("CSV file"), FH_ACC_WRITE, true);
 153   if (w->lock == NULL)
 154     goto error;
 155
 156   /* Create the file on disk. */
 157   w->rf = replace_file_start (fh, "w", 0666,  &w->file);
 158   if (w->rf == NULL)
 159     {
 160       msg (ME, _("Error opening `%s' for writing as a system file: %s."),
 161            fh_get_file_name (fh), strerror (errno));
 162       goto error;
 163     }
 164
 165   if (opts->include_var_names)
 166     write_var_names (w, dict);
 167
 168   if (write_error (w))
 169     goto error;
 170
 171   return casewriter_create (dict_get_proto (dict),
 172                             &csv_file_casewriter_class, w);
 173
 174 error:
 175   close_writer (w);
 176   return NULL;
 177 }
 178
 179 static bool
 180 csv_field_needs_quoting (struct csv_writer *w, const char *s, size_t len)
 181 {
 182   const char *p;
 183
 184   for (p = s; p < &s[len]; p++)
 185     if (*p == w->opts.qualifier || *p == w->opts.delimiter
 186         || *p == '\n' || *p == '\r')
 187       return true;
 188
 189   return false;
 190 }
 191
 192 static void
 193 csv_output_buffer (struct csv_writer *w, const char *s, size_t len)
 194 {
 195   if (csv_field_needs_quoting (w, s, len))
 196     {
 197       const char *p;
 198
 199       putc (w->opts.qualifier, w->file);
 200       for (p = s; p < &s[len]; p++)
 201         {
 202           /* We are writing the output file in text mode, so transform any
 203              explicit CR-LF line breaks into LF only, to allow the C library to
 204              use correct system-specific new-lines. */
 205           if (*p == '\r' && p[1] == '\n')
 206             continue;
 207
 208           if (*p == w->opts.qualifier)
 209             putc (w->opts.qualifier, w->file);
 210           putc (*p, w->file);
 211         }
 212       putc (w->opts.qualifier, w->file);
 213     }
 214   else
 215     fwrite (s, 1, len, w->file);
 216 }
 217
 218 static void
 219 csv_output_string (struct csv_writer *w, const char *s)
 220 {
 221   csv_output_buffer (w, s, strlen (s));
 222 }
 223
 224 static void
 225 write_var_names (struct csv_writer *w, const struct dictionary *d)
 226 {
 227   size_t i;
 228
 229   for (i = 0; i < w->n_csv_vars; i++)
 230     {
 231       if (i > 0)
 232         putc (w->opts.delimiter, w->file);
 233       csv_output_string (w, var_get_name (dict_get_var (d, i)));
 234     }
 235   putc ('\n', w->file);
 236 }
 237
 238 static void
 239 csv_output_format (struct csv_writer *w, const struct csv_var *cv,
 240                    const union value *value)
 241 {
 242   char *s = data_out (value, w->encoding, &cv->format);
 243   struct substring ss = ss_cstr (s);
 244   if (cv->format.type != FMT_A)
 245     ss_trim (&ss, ss_cstr (" "));
 246   else
 247     ss_rtrim (&ss, ss_cstr (" "));
 248   csv_output_buffer (w, ss.string, ss.length);
 249   free (s);
 250 }
 251
 252 static double
 253 extract_date (double number, int *y, int *m, int *d)
 254 {
 255   int yd;
 256
 257   calendar_offset_to_gregorian (number / 60. / 60. / 24., y, m, d, &yd);
 258   return fmod (number, 60. * 60. * 24.);
 259 }
 260
 261 static void
 262 extract_time (double number, double *H, int *M, int *S)
 263 {
 264   *H = floor (number / 60. / 60.);
 265   number = fmod (number, 60. * 60.);
 266
 267   *M = floor (number / 60.);
 268   number = fmod (number, 60.);
 269
 270   *S = floor (number);
 271 }
 272
 273 static void
 274 csv_write_var__ (struct csv_writer *w, const struct csv_var *cv,
 275                  const union value *value)
 276 {
 277   const char *label;
 278
 279   label = val_labs_find (cv->val_labs, value);
 280   if (label != NULL)
 281     csv_output_string (w, label);
 282   else if (cv->width == 0 && value->f == SYSMIS)
 283     csv_output_buffer (w, " ", 1);
 284   else if (w->opts.use_print_formats)
 285     csv_output_format (w, cv, value);
 286   else
 287     {
 288       char s[MAX (DBL_STRLEN_BOUND, 128)];
 289       char *cp;
 290
 291       switch (cv->format.type)
 292         {
 293         case FMT_F:
 294         case FMT_COMMA:
 295         case FMT_DOT:
 296         case FMT_DOLLAR:
 297         case FMT_PCT:
 298         case FMT_E:
 299         case FMT_CCA:
 300         case FMT_CCB:
 301         case FMT_CCC:
 302         case FMT_CCD:
 303         case FMT_CCE:
 304         case FMT_N:
 305         case FMT_Z:
 306         case FMT_P:
 307         case FMT_PK:
 308         case FMT_IB:
 309         case FMT_PIB:
 310         case FMT_PIBHEX:
 311         case FMT_RB:
 312         case FMT_RBHEX:
 313         case FMT_WKDAY:
 314         case FMT_MONTH:
 315           dtoastr (s, sizeof s, 0, 0, value->f);
 316           cp = strpbrk (s, ".,");
 317           if (cp != NULL)
 318             *cp = w->opts.decimal;
 319           break;
 320
 321         case FMT_DATE:
 322         case FMT_ADATE:
 323         case FMT_EDATE:
 324         case FMT_JDATE:
 325         case FMT_SDATE:
 326         case FMT_QYR:
 327         case FMT_MOYR:
 328         case FMT_WKYR:
 329           if (value->f < 0)
 330             strcpy (s, " ");
 331           else
 332             {
 333               int y, m, d;
 334
 335               extract_date (value->f, &y, &m, &d);
 336               snprintf (s, sizeof s, "%02d/%02d/%04d", m, d, y);
 337             }
 338           break;
 339
 340         case FMT_DATETIME:
 341           if (value->f < 0)
 342             strcpy (s, " ");
 343           else
 344             {
 345               int y, m, d, M, S;
 346               double H;
 347
 348               extract_time (extract_date (value->f, &y, &m, &d), &H, &M, &S);
 349               snprintf (s, sizeof s, "%02d/%02d/%04d %02.0f:%02d:%02d",
 350                         m, d, y, H, M, S);
 351             }
 352           break;
 353
 354         case FMT_TIME:
 355         case FMT_DTIME:
 356           {
 357             double H;
 358             int M, S;
 359
 360             extract_time (fabs (value->f), &H, &M, &S);
 361             snprintf (s, sizeof s, "%s%02.0f:%02d:%02d",
 362                       value->f < 0 ? "-" : "", H, M, S);
 363           }
 364           break;
 365
 366         case FMT_A:
 367         case FMT_AHEX:
 368           csv_output_format (w, cv, value);
 369           return;
 370
 371         case FMT_NUMBER_OF_FORMATS:
 372           NOT_REACHED ();
 373         }
 374       csv_output_string (w, s);
 375     }
 376 }
 377
 378 static void
 379 csv_write_var (struct csv_writer *w, const struct csv_var *cv,
 380                const union value *value)
 381 {
 382   if (mv_is_value_missing (&cv->missing, value, MV_USER))
 383     {
 384       union value missing;
 385
 386       value_init (&missing, cv->width);
 387       value_set_missing (&missing, cv->width);
 388       csv_write_var__ (w, cv, &missing);
 389       value_destroy (&missing, cv->width);
 390     }
 391   else
 392     csv_write_var__ (w, cv, value);
 393 }
 394
 395 static void
 396 csv_write_case (struct csv_writer *w, const struct ccase *c)
 397 {
 398   size_t i;
 399
 400   for (i = 0; i < w->n_csv_vars; i++)
 401     {
 402       const struct csv_var *cv = &w->csv_vars[i];
 403
 404       if (i > 0)
 405         putc (w->opts.delimiter, w->file);
 406       csv_write_var (w, cv, case_data_idx (c, cv->case_index));
 407     }
 408   putc ('\n', w->file);
 409 }
 410 \f
 411 /* Writes case C to CSV file W. */
 412 static void
 413 csv_file_casewriter_write (struct casewriter *writer, void *w_,
 414                            struct ccase *c)
 415 {
 416   struct csv_writer *w = w_;
 417
 418   if (ferror (w->file))
 419     {
 420       casewriter_force_error (writer);
 421       case_unref (c);
 422       return;
 423     }
 424
 425   csv_write_case (w, c);
 426   case_unref (c);
 427 }
 428
 429 /* Destroys CSV file writer W. */
 430 static void
 431 csv_file_casewriter_destroy (struct casewriter *writer, void *w_)
 432 {
 433   struct csv_writer *w = w_;
 434   if (!close_writer (w))
 435     casewriter_force_error (writer);
 436 }
 437
 438 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
 439 bool
 440 write_error (const struct csv_writer *writer)
 441 {
 442   return ferror (writer->file);
 443 }
 444
 445 /* Closes a CSV file after we're done with it.
 446    Returns true if successful, false if an I/O error occurred. */
 447 bool
 448 close_writer (struct csv_writer *w)
 449 {
 450   size_t i;
 451   bool ok;
 452
 453   if (w == NULL)
 454     return true;
 455
 456   ok = true;
 457   if (w->file != NULL)
 458     {
 459       if (write_error (w))
 460         ok = false;
 461       if (fclose (w->file) == EOF)
 462         ok = false;
 463
 464       if (!ok)
 465         msg (ME, _("An I/O error occurred writing CSV file `%s'."),
 466              fh_get_file_name (w->fh));
 467
 468       if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
 469         ok = false;
 470     }
 471
 472   fh_unlock (w->lock);
 473   fh_unref (w->fh);
 474
 475   free (w->encoding);
 476
 477   for (i = 0; i < w->n_csv_vars; i++)
 478     {
 479       struct csv_var *cv = &w->csv_vars[i];
 480       mv_destroy (&cv->missing);
 481       val_labs_destroy (cv->val_labs);
 482     }
 483
 484   free (w->csv_vars);
 485   free (w);
 486
 487   return ok;
 488 }
 489
 490 /* CSV file writer casewriter class. */
 491 static const struct casewriter_class csv_file_casewriter_class =
 492   {
 493     csv_file_casewriter_write,
 494     csv_file_casewriter_destroy,
 495     NULL,
 496   };