1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "data/file-name.h"
29 #include "data/settings.h"
30 #include "libpspp/hash-functions.h"
31 #include "libpspp/message.h"
32 #include "libpspp/str.h"
33 #include "libpspp/version.h"
35 #include "gl/dirname.h"
36 #include "gl/dosname.h"
37 #include "gl/intprops.h"
38 #include "gl/minmax.h"
39 #include "gl/relocatable.h"
40 #include "gl/xalloc.h"
41 #include "gl/xmalloca.h"
44 #define _(msgid) gettext (msgid)
46 #if defined _WIN32 || defined __WIN32__
47 #define WIN32_LEAN_AND_MEAN /* avoid including junk */
51 /* Functions for performing operations on file names. */
53 /* Searches for a configuration file with name NAME in the directories given in
54 PATH, which is terminated by a null pointer. Returns the full name of the
55 first file found, which the caller is responsible for freeing with free(),
56 or NULL if none is found. */
58 fn_search_path (const char *base_name, char **path)
62 if (fn_is_absolute (base_name))
63 return xstrdup (base_name);
65 for (i = 0; path[i] != NULL; i++)
67 const char *dir = path[i];
70 if (!strcmp (dir, "") || !strcmp (dir, "."))
71 file = xstrdup (base_name);
72 else if (ISSLASH (dir[strlen (dir) - 1]))
73 file = xasprintf ("%s%s", dir, base_name);
75 file = xasprintf ("%s/%s", dir, base_name);
85 /* Returns the directory part of FILE_NAME, as a malloc()'d
88 fn_dir_name (const char *file_name)
90 return dir_name (file_name);
93 /* Returns the extension part of FILE_NAME as a malloc()'d string.
94 If FILE_NAME does not have an extension, returns an empty
97 fn_extension (const char *file_name)
99 const char *extension = strrchr (file_name, '.');
100 if (extension == NULL)
102 return xstrdup (extension);
105 /* Find out information about files. */
107 /* Returns true iff NAME specifies an absolute file name. */
109 fn_is_absolute (const char *name)
111 return IS_ABSOLUTE_FILE_NAME (name);
114 /* Returns true if FILE_NAME is a virtual file that doesn't
115 really exist on disk, false if it's a real file name. */
117 fn_is_special (const char *file_name)
119 if (!strcmp (file_name, "-") || !strcmp (file_name, "stdin")
120 || !strcmp (file_name, "stdout") || !strcmp (file_name, "stderr")
122 || file_name[0] == '|'
123 || (*file_name && file_name[strlen (file_name) - 1] == '|')
131 /* Returns true if file with name NAME exists, and that file is not a
134 fn_exists (const char *name)
137 if ( stat (name, &temp) != 0 )
140 return ! S_ISDIR (temp.st_mode);
143 /* Environment variables. */
145 /* Simulates $VER and $ARCH environment variables. */
147 fn_getenv (const char *s)
149 if (!strcmp (s, "VER"))
150 return fn_getenv_default ("STAT_VER", bare_version);
151 else if (!strcmp (s, "ARCH"))
152 return fn_getenv_default ("STAT_ARCH", host_system);
157 /* Returns getenv(KEY) if that's non-NULL; else returns DEF. */
159 fn_getenv_default (const char *key, const char *def)
161 const char *value = getenv (key);
162 return value ? value : def;
165 /* Basic file handling. */
168 /* Used for giving an error message on a set_safer security
171 safety_violation (const char *fn)
173 msg (SE, _("Not opening pipe file `%s' because %s option set."), fn, "SAFER");
179 /* File open routine that understands `-' as stdin/stdout and `|cmd'
180 as a pipe to command `cmd'. Returns resultant FILE on success,
181 NULL on failure. If NULL is returned then errno is set to a
184 fn_open (const char *fn, const char *mode)
186 assert (mode[0] == 'r' || mode[0] == 'w' || mode[0] == 'a');
190 if (!strcmp (fn, "stdin") || !strcmp (fn, "-"))
195 if (!strcmp (fn, "stdout") || !strcmp (fn, "-"))
197 if (!strcmp (fn, "stderr"))
204 if (settings_get_safer_mode ())
205 return safety_violation (fn);
207 return popen (&fn[1], mode[0] == 'r' ? "r" : "w");
209 else if (*fn && fn[strlen (fn) - 1] == '|')
214 if (settings_get_safer_mode ())
215 return safety_violation (fn);
217 s = xmalloca (strlen (fn));
218 memcpy (s, fn, strlen (fn) - 1);
219 s[strlen (fn) - 1] = 0;
221 f = popen (s, mode[0] == 'r' ? "r" : "w");
229 return fopen (fn, mode);
232 /* Counterpart to fn_open that closes file F with name FN; returns 0
233 on success, EOF on failure. If EOF is returned, errno is set to a
236 fn_close (const char *fn, FILE *f)
238 if (fileno (f) == STDIN_FILENO
239 || fileno (f) == STDOUT_FILENO
240 || fileno (f) == STDERR_FILENO)
243 else if (fn[0] == '|' || (*fn && fn[strlen (fn) - 1] == '|'))
254 /* A file's identity:
256 - For a file that exists, this is its device and inode.
258 - For a file that does not exist, but which has a directory
259 name that exists, this is the device and inode of the
260 directory, plus the file's base name.
262 - For a file that does not exist and has a nonexistent
263 directory, this is the file name.
265 Windows doesn't have inode numbers, so we just use the name
269 dev_t device; /* Device number. */
270 ino_t inode; /* Inode number. */
271 char *name; /* File name, where needed, otherwise NULL. */
274 /* Returns a pointer to a dynamically allocated structure whose
275 value can be used to tell whether two files are actually the
276 same file. Returns a null pointer if no information about the
277 file is available, perhaps because it does not exist. The
278 caller is responsible for freeing the structure with
279 fn_free_identity() when finished. */
280 struct file_identity *
281 fn_get_identity (const char *file_name)
283 struct file_identity *identity = xmalloc (sizeof *identity);
285 #if !(defined _WIN32 || defined __WIN32__)
287 if (lstat (file_name, &s) == 0)
289 identity->device = s.st_dev;
290 identity->inode = s.st_ino;
291 identity->name = NULL;
295 char *dir = dir_name (file_name);
296 if (last_component (file_name) != NULL && stat (dir, &s) == 0)
298 identity->device = s.st_dev;
299 identity->inode = s.st_ino;
300 identity->name = base_name (file_name);
304 identity->device = 0;
306 identity->name = xstrdup (file_name);
311 char cname[PATH_MAX];
312 int ok = GetFullPathName (file_name, sizeof cname, cname, NULL);
313 identity->device = 0;
315 identity->name = xstrdup (ok ? cname : file_name);
316 str_lowercase (identity->name);
322 /* Frees IDENTITY obtained from fn_get_identity(). */
324 fn_free_identity (struct file_identity *identity)
326 if (identity != NULL)
328 free (identity->name);
333 /* Compares A and B, returning a strcmp()-type result. */
335 fn_compare_file_identities (const struct file_identity *a,
336 const struct file_identity *b)
338 if (a->device != b->device)
339 return a->device < b->device ? -1 : 1;
340 else if (a->inode != b->inode)
341 return a->inode < b->inode ? -1 : 1;
342 else if (a->name != NULL)
343 return b->name != NULL ? strcmp (a->name, b->name) : 1;
345 return b->name != NULL ? -1 : 0;
348 /* Returns a hash value for IDENTITY. */
350 fn_hash_identity (const struct file_identity *identity)
352 unsigned int hash = hash_int (identity->device, identity->inode);
353 if (identity->name != NULL)
354 hash = hash_string (identity->name, hash);
360 /* Apparently windoze users like to see output dumped into their home directory,
361 not the current directory (!) */
363 default_output_path (void)
365 static char *path = NULL;
369 /* Windows NT defines HOMEDRIVE and HOMEPATH. But give preference
370 to HOME, because the user can change HOME. */
372 const char *home_dir = getenv ("HOME");
375 if (home_dir == NULL)
377 const char *home_drive = getenv ("HOMEDRIVE");
378 const char *home_path = getenv ("HOMEPATH");
380 if (home_drive != NULL && home_path != NULL)
381 home_dir = xasprintf ("%s%s",
382 home_drive, home_path);
385 if (home_dir == NULL)
386 home_dir = "c:/users/default"; /* poor default */
388 /* Copy home_dir into path. Add a slash at the end but
389 only if there isn't already one there, because Windows
390 treats // specially. */
391 if (home_dir[0] == '\0'
392 || strchr ("/\\", home_dir[strlen (home_dir) - 1]) == NULL)
393 path = xasprintf ("%s%c", home_dir, '/');
395 path = xstrdup (home_dir);
397 for(i = 0; i < strlen (path); i++)
398 if (path[i] == '\\') path[i] = '/';
406 /* ... whereas the rest of the world just likes it to be
407 put "here" for easy access. */
409 default_output_path (void)
411 static char current_dir[] = "";