1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 #include <libpspp/message.h>
27 #include <libpspp/alloc.h>
29 #include <libpspp/message.h>
30 #include <libpspp/str.h>
32 #include <libpspp/version.h>
33 #include "xreadlink.h"
36 #define _(msgid) gettext (msgid)
38 #include <libpspp/debug-print.h>
40 /* PORTME: Everything in this file is system dependent. */
46 #include "stat-macros.h"
53 #include <win32/windows.h>
62 const char *config_path;
67 config_path = fn_getenv_default ("STAT_CONFIG_PATH", default_config_path);
70 /* Functions for performing operations on filenames. */
73 /* Substitutes $variables as defined by GETENV into TARGET.
74 TARGET must be a string containing the text for which substitution
76 Supports $var and ${var} syntaxes;
80 fn_interp_vars (struct string *target,
81 const char *(*getenv) (const char *))
88 input = xmalloc(ds_length(target) + 1);
91 strcpy(input, ds_c_str(target));
93 if (NULL == strchr (ds_c_str(target), '$'))
110 ds_putc (target, '$');
119 start = ds_length (target);
134 while (*s && *s != stop
135 && (stop || isalpha ((unsigned char) *s)))
137 ds_putc (target, *s++);
140 value = getenv (ds_c_str (target) + start);
141 ds_truncate (target, start);
142 ds_puts (target, value);
144 if (stop && *s == stop)
150 ds_putc (target, *s++);
160 /* Expands csh tilde notation from the path INPUT into a malloc()'d
163 fn_tilde_expand (const char *input)
166 struct string output;
168 if (NULL == strchr (input, '~'))
169 return xstrdup (input);
170 ds_init (&output, strlen (input));
174 for (ip = input; *ip; )
175 if (*ip != '~' || (ip != input && ip[-1] != PATH_DELIMITER))
176 ds_putc (&output, *ip++);
179 static const char stop_set[3] = {DIR_SEPARATOR, PATH_DELIMITER, 0};
184 cp = ip + strcspn (ip, stop_set);
191 strncpy (username, ip, cp - ip + 1);
193 pwd = getpwnam (username);
195 if (!pwd || !pwd->pw_dir)
196 ds_putc (&output, *ip++);
198 ds_puts (&output, pwd->pw_dir);
202 const char *home = fn_getenv ("HOME");
204 ds_putc (&output, *ip++);
206 ds_puts (&output, home);
212 return ds_c_str (&output);
216 fn_tilde_expand (const char *input)
218 return xstrdup (input);
222 /* Searches for a configuration file with name NAME in the path given
223 by PATH, which is tilde- and environment-interpolated. Directories
224 in PATH are delimited by PATH_DELIMITER, defined in <pref.h>.
225 Returns the malloc'd full name of the first file found, or NULL if
228 If PREPEND is non-NULL, then it is prepended to each filename;
229 i.e., it looks like PREPEND/PATH_COMPONENT/NAME. This is not done
230 with absolute directories in the path. */
231 #if defined (unix) || defined (__MSDOS__) || defined (__WIN32__)
233 fn_search_path (const char *basename, const char *path, const char *prepend)
236 struct string filename;
239 if (fn_absolute_p (basename))
240 return fn_tilde_expand (basename);
244 ds_create(&temp, path);
246 fn_interp_vars(&temp, fn_getenv);
248 bp = subst_path = fn_tilde_expand (ds_c_str(&temp));
253 msg (VM (4), _("Searching for `%s'..."), basename);
254 ds_init (&filename, 64);
261 msg (VM (4), _("Search unsuccessful!"));
262 ds_destroy (&filename);
267 for (ep = bp; *ep && *ep != PATH_DELIMITER; ep++)
270 /* Paste together PREPEND/PATH/BASENAME. */
271 ds_clear (&filename);
272 if (prepend && !fn_absolute_p (bp))
274 ds_puts (&filename, prepend);
275 ds_putc (&filename, DIR_SEPARATOR);
277 ds_concat (&filename, bp, ep - bp);
279 && ds_c_str (&filename)[ds_length (&filename) - 1] != DIR_SEPARATOR)
280 ds_putc (&filename, DIR_SEPARATOR);
281 ds_puts (&filename, basename);
283 msg (VM (5), " - %s", ds_c_str (&filename));
284 if (fn_exists_p (ds_c_str (&filename)))
286 msg (VM (4), _("Found `%s'."), ds_c_str (&filename));
288 return ds_c_str (&filename);
293 msg (VM (4), _("Search unsuccessful!"));
295 ds_destroy (&filename);
301 #else /* not unix, msdog, lose32 */
303 fn_search_path (const char *basename, const char *path, const char *prepend)
305 size_t size = strlen (path) + 1 + strlen (basename) + 1;
310 size += strlen (prepend) + 1;
311 string = xmalloc (size);
316 cp = stpcpy (cp, prepend);
317 *cp++ = DIR_SEPARATOR;
319 cp = stpcpy (cp, path);
320 *cp++ = DIR_SEPARATOR;
321 strcpy (cp, basename);
325 #endif /* not unix, msdog, lose32 */
327 /* Prepends directory DIR to filename FILE and returns a malloc()'d
330 fn_prepend_dir (const char *file, const char *dir)
335 if (fn_absolute_p (file))
336 return xstrdup (file);
338 temp = xmalloc (strlen (file) + 1 + strlen (dir) + 1);
339 cp = stpcpy (temp, dir);
340 if (cp != temp && cp[-1] != DIR_SEPARATOR)
341 *cp++ = DIR_SEPARATOR;
342 cp = stpcpy (cp, file);
347 /* fn_normalize(): This very OS-dependent routine canonicalizes
348 filename FN1. The filename should not need to be the name of an
349 existing file. Returns a malloc()'d copy of the canonical name.
350 This function must always succeed; if it needs to bail out then it
351 should return xstrdup(FN1). */
354 fn_normalize (const char *filename)
357 char *fn1, *fn2, *dest;
360 if (fn_special_p (filename))
361 return xstrdup (filename);
363 fn1 = fn_tilde_expand (filename);
365 /* Follow symbolic links. */
369 fn1 = fn_readlink (fn1);
378 maxlen = strlen (fn1) * 2;
381 dest = fn2 = xmalloc (maxlen + 1);
384 if (*src == DIR_SEPARATOR)
389 while (getcwd (dest, maxlen - (dest - fn2)) == NULL && errno == ERANGE)
392 dest = fn2 = xrealloc (fn2, maxlen + 1);
401 dest = strchr (fn2, '\0');
402 if (dest - fn2 >= maxlen)
404 int ofs = dest - fn2;
406 fn2 = xrealloc (fn2, maxlen + 1);
409 if (dest[-1] != DIR_SEPARATOR)
410 *dest++ = DIR_SEPARATOR;
420 if (c == DIR_SEPARATOR || c == 0)
422 /* remove `./', `../' from directory */
423 if (dest[-1] == '.' && dest[-2] == DIR_SEPARATOR)
425 else if (dest[-1] == '.' && dest[-2] == '.' && dest[-3] == DIR_SEPARATOR)
430 while (dest[-1] != DIR_SEPARATOR)
433 else if (dest[-1] != DIR_SEPARATOR) /* remove extra slashes */
438 if (dest[-1] == DIR_SEPARATOR && dest > fn2 + 1)
443 return xrealloc (fn2, strlen (fn2) + 1);
451 if (dest - fn2 >= maxlen)
453 int ofs = dest - fn2;
455 fn2 = xrealloc (fn2, maxlen + 1);
462 #elif defined (__WIN32__)
464 fn_normalize (const char *fn1)
470 /* Don't change special filenames. */
471 if (is_special_filename (filename))
472 return xstrdup (filename);
474 /* First find the required buffer length. */
475 len = GetFullPathName (fn1, 0, NULL, NULL);
482 /* Then make a buffer that big. */
484 success = GetFullPathName (fn1, len, fn2, NULL);
485 if (success >= len || success == 0)
495 fn_normalize (const char *fn1)
497 char *fn2 = _fullpath (NULL, fn1, 0);
501 for (cp = fn2; *cp; cp++)
502 *cp = toupper ((unsigned char) (*cp));
505 return xstrdup (fn1);
509 fn_normalize (const char *fn1)
511 char *fn2 = xmalloc (1024);
513 fn2 = xrealloc (fn2, strlen (fn2) + 1);
516 #else /* not Lose32, Unix, or DJGPP */
518 fn_normalize (const char *fn)
522 #endif /* not Lose32, Unix, or DJGPP */
524 /* Returns the directory part of FILENAME, as a malloc()'d
527 fn_dirname (const char *filename)
533 len = strlen (filename);
534 if (len == 1 && filename[0] == '/')
536 else if (len && filename[len - 1] == DIR_SEPARATOR)
537 p = buf_find_reverse (filename, len - 1, filename + len - 1, 1);
539 p = strrchr (filename, DIR_SEPARATOR);
543 s = xmalloc (p - filename + 1);
544 memcpy (s, filename, p - filename);
550 /* Returns the basename part of FILENAME as a malloc()'d string. */
553 fn_basename (const char *filename)
555 /* Not used, not implemented. */
560 /* Returns the extension part of FILENAME as a malloc()'d string.
561 If FILENAME does not have an extension, returns an empty
564 fn_extension (const char *filename)
566 const char *extension = strrchr (filename, '.');
567 if (extension == NULL)
569 return xstrdup (extension);
573 /* Returns the current working directory, as a malloc()'d string.
579 char *buffer = xmalloc (size);
583 char *value = getcwd (buffer, size);
589 buffer = xmalloc (size);
597 char *buffer = xmalloc (size);
609 /* Find out information about files. */
611 /* Returns nonzero iff NAME specifies an absolute filename. */
613 fn_absolute_p (const char *name)
617 || !strncmp (name, "./", 2)
618 || !strncmp (name, "../", 3)
621 #elif defined (__MSDOS__)
623 || !strncmp (name, ".\\", 2)
624 || !strncmp (name, "..\\", 3)
625 || (name[0] && name[1] == ':'))
632 /* Returns 1 if the filename specified is a virtual file that doesn't
633 really exist on disk, 0 if it's a real filename. */
635 fn_special_p (const char *filename)
637 if (!strcmp (filename, "-") || !strcmp (filename, "stdin")
638 || !strcmp (filename, "stdout") || !strcmp (filename, "stderr")
640 || filename[0] == '|'
641 || (*filename && filename[strlen (filename) - 1] == '|')
649 /* Returns nonzero if file with name NAME exists. */
651 fn_exists_p (const char *name)
656 return stat (name, &temp) == 0;
658 FILE *f = fopen (name, "r");
666 /* Returns the symbolic link value for FILENAME as a dynamically
667 allocated buffer, or a null pointer on failure. */
669 fn_readlink (const char *filename)
671 return xreadlink (filename, 32);
674 /* Environment variables. */
676 /* Simulates $VER and $ARCH environment variables. */
678 fn_getenv (const char *s)
680 if (!strcmp (s, "VER"))
681 return fn_getenv_default ("STAT_VER", bare_version);
682 else if (!strcmp (s, "ARCH"))
683 return fn_getenv_default ("STAT_ARCH", host_system);
688 /* Returns getenv(KEY) if that's non-NULL; else returns DEF. */
690 fn_getenv_default (const char *key, const char *def)
692 const char *value = getenv (key);
693 return value ? value : def;
696 /* Basic file handling. */
698 /* Used for giving an error message on a set_safer security
701 safety_violation (const char *fn)
703 msg (SE, _("Not opening pipe file `%s' because SAFER option set."), fn);
708 /* As a general comment on the following routines, a `sensible value'
709 for errno includes 0 if there is no associated system error. The
710 routines will only set errno to 0 if there is an error in a
711 callback that sets errno to 0; they themselves won't. */
713 /* File open routine that understands `-' as stdin/stdout and `|cmd'
714 as a pipe to command `cmd'. Returns resultant FILE on success,
715 NULL on failure. If NULL is returned then errno is set to a
718 fn_open (const char *fn, const char *mode)
720 assert (mode[0] == 'r' || mode[0] == 'w');
722 if (mode[0] == 'r' && (!strcmp (fn, "stdin") || !strcmp (fn, "-")))
724 else if (mode[0] == 'w' && (!strcmp (fn, "stdout") || !strcmp (fn, "-")))
726 else if (mode[0] == 'w' && !strcmp (fn, "stderr"))
732 if (get_safer_mode ())
733 return safety_violation (fn);
735 return popen (&fn[1], mode);
737 else if (*fn && fn[strlen (fn) - 1] == '|')
742 if (get_safer_mode ())
743 return safety_violation (fn);
745 s = local_alloc (strlen (fn));
746 memcpy (s, fn, strlen (fn) - 1);
747 s[strlen (fn) - 1] = 0;
758 FILE *f = fopen (fn, mode);
760 if (f && mode[0] == 'w')
761 setvbuf (f, NULL, _IOLBF, 0);
767 /* Counterpart to fn_open that closes file F with name FN; returns 0
768 on success, EOF on failure. If EOF is returned, errno is set to a
771 fn_close (const char *fn, FILE *f)
773 if (!strcmp (fn, "-"))
776 else if (fn[0] == '|' || (*fn && fn[strlen (fn) - 1] == '|'))
786 /* More extensive file handling. */
788 /* File open routine that extends fn_open(). Opens or reopens a
789 file according to the contents of file_ext F. Returns nonzero on
790 success. If 0 is returned, errno is set to a sensible value. */
792 fn_open_ext (struct file_ext *f)
796 p = strstr (f->filename, "%d");
799 char *s = local_alloc (strlen (f->filename)
800 + INT_STRLEN_BOUND (int) - 1);
803 memcpy (s, f->filename, p - f->filename);
804 cp = spprintf (&s[p - f->filename], "%d", *f->sequence_no);
812 if (f->preclose (f) == 0)
815 if (EOF == fn_close (f->filename, f->file) || error)
829 f->file = fn_open (s, f->mode);
832 if (f->file && f->postopen)
833 if (f->postopen (f) == 0)
836 fn_close (f->filename, f->file);
842 return (f->file != NULL);
848 f->file = fn_open (f->filename, f->mode);
850 if (f->file && f->postopen)
851 if (f->postopen (f) == 0)
854 fn_close (f->filename, f->file);
860 return (f->file != NULL);
864 /* Properly closes the file associated with file_ext F, if any.
865 Return nonzero on success. If zero is returned, errno is set to a
868 fn_close_ext (struct file_ext *f)
875 if (f->preclose (f) == 0)
878 if (EOF == fn_close (f->filename, f->file) || error)
894 /* A file's identity. */
897 dev_t device; /* Device number. */
898 ino_t inode; /* Inode number. */
901 /* Returns a pointer to a dynamically allocated structure whose
902 value can be used to tell whether two files are actually the
903 same file. Returns a null pointer if no information about the
904 file is available, perhaps because it does not exist. The
905 caller is responsible for freeing the structure with
906 fn_free_identity() when finished. */
907 struct file_identity *
908 fn_get_identity (const char *filename)
912 if (stat (filename, &s) == 0)
914 struct file_identity *identity = xmalloc (sizeof *identity);
915 identity->device = s.st_dev;
916 identity->inode = s.st_ino;
923 /* Frees IDENTITY obtained from fn_get_identity(). */
925 fn_free_identity (struct file_identity *identity)
930 /* Compares A and B, returning a strcmp()-type result. */
932 fn_compare_file_identities (const struct file_identity *a,
933 const struct file_identity *b)
937 if (a->device != b->device)
938 return a->device < b->device ? -1 : 1;
940 return a->inode < b->inode ? -1 : a->inode > b->inode;
943 /* A file's identity. */
946 char *normalized_filename; /* File's normalized name. */
949 /* Returns a pointer to a dynamically allocated structure whose
950 value can be used to tell whether two files are actually the
951 same file. Returns a null pointer if no information about the
952 file is available, perhaps because it does not exist. The
953 caller is responsible for freeing the structure with
954 fn_free_identity() when finished. */
955 struct file_identity *
956 fn_get_identity (const char *filename)
958 struct file_identity *identity = xmalloc (sizeof *identity);
959 identity->normalized_filename = fn_normalize (filename);
963 /* Frees IDENTITY obtained from fn_get_identity(). */
965 fn_free_identity (struct file_identity *identity)
967 if (identity != NULL)
969 free (identity->normalized_filename);
974 /* Compares A and B, returning a strcmp()-type result. */
976 fn_compare_file_identities (const struct file_identity *a,
977 const struct file_identity *b)
979 return strcmp (a->normalized_filename, b->normalized_filename);
981 #endif /* not unix */