1 /* gfileutils.c - File utility functions
3 * Copyright 2000 Red Hat, Inc.
5 * GLib is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser 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 * GLib is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with GLib; see the file COPYING.LIB. If not,
17 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
34 #include <sys/types.h>
49 #define S_ISREG(mode) ((mode)&_S_IFREG)
53 #define S_ISDIR(mode) ((mode)&_S_IFDIR)
56 #endif /* G_OS_WIN32 */
70 * @filename: a filename to test
71 * @test: bitfield of #GFileTest flags
73 * Returns %TRUE if any of the tests in the bitfield @test are
74 * %TRUE. For example, <literal>(G_FILE_TEST_EXISTS |
75 * G_FILE_TEST_IS_DIR)</literal> will return %TRUE if the file exists;
76 * the check whether it's a directory doesn't matter since the existence
77 * test is %TRUE. With the current set of available tests, there's no point
78 * passing in more than one test at a time.
80 * Apart from #G_FILE_TEST_IS_SYMLINK all tests follow symbolic links,
81 * so for a symbolic link to a regular file g_file_test() will return
82 * %TRUE for both #G_FILE_TEST_IS_SYMLINK and #G_FILE_TEST_IS_REGULAR.
84 * Return value: whether a test was %TRUE
87 g_file_test (const gchar *filename,
90 if ((test & G_FILE_TEST_EXISTS) && (access (filename, F_OK) == 0))
93 if ((test & G_FILE_TEST_IS_EXECUTABLE) && (access (filename, X_OK) == 0))
96 if (test & G_FILE_TEST_IS_SYMLINK)
100 if ((lstat (filename, &s) == 0) && S_ISLNK (s.st_mode))
104 if (test & (G_FILE_TEST_IS_REGULAR | G_FILE_TEST_IS_DIR))
108 if (stat (filename, &s) == 0)
110 if ((test & G_FILE_TEST_IS_REGULAR) && S_ISREG (s.st_mode))
113 if ((test & G_FILE_TEST_IS_DIR) && S_ISDIR (s.st_mode))
122 g_file_error_quark (void)
126 q = g_quark_from_static_string ("g-file-error-quark");
132 * g_file_error_from_errno:
133 * @err_no: an "errno" value
135 * Gets a #GFileError constant based on the passed-in @errno.
136 * For example, if you pass in %EEXIST this function returns
137 * #G_FILE_ERROR_EXIST. Unlike @errno values, you can portably
138 * assume that all #GFileError values will exist.
140 * Normally a #GFileError value goes into a #GError returned
141 * from a function that manipulates files. So you would use
142 * g_file_error_from_errno() when constructing a #GError.
144 * Return value: #GFileError corresponding to the given @errno
147 g_file_error_from_errno (gint err_no)
153 return G_FILE_ERROR_EXIST;
159 return G_FILE_ERROR_ISDIR;
165 return G_FILE_ERROR_ACCES;
171 return G_FILE_ERROR_NAMETOOLONG;
177 return G_FILE_ERROR_NOENT;
183 return G_FILE_ERROR_NOTDIR;
189 return G_FILE_ERROR_NXIO;
195 return G_FILE_ERROR_NODEV;
201 return G_FILE_ERROR_ROFS;
207 return G_FILE_ERROR_TXTBSY;
213 return G_FILE_ERROR_FAULT;
219 return G_FILE_ERROR_LOOP;
225 return G_FILE_ERROR_NOSPC;
231 return G_FILE_ERROR_NOMEM;
237 return G_FILE_ERROR_MFILE;
243 return G_FILE_ERROR_NFILE;
249 return G_FILE_ERROR_BADF;
255 return G_FILE_ERROR_INVAL;
261 return G_FILE_ERROR_PIPE;
267 return G_FILE_ERROR_AGAIN;
273 return G_FILE_ERROR_INTR;
279 return G_FILE_ERROR_IO;
285 return G_FILE_ERROR_PERM;
290 return G_FILE_ERROR_FAILED;
296 get_contents_stdio (const gchar *filename,
306 size_t total_allocated;
308 g_assert (f != NULL);
310 #define STARTING_ALLOC 64
313 total_allocated = STARTING_ALLOC;
314 str = g_malloc (STARTING_ALLOC);
318 bytes = fread (buf, 1, 2048, f);
320 while ((total_bytes + bytes + 1) > total_allocated)
322 total_allocated *= 2;
323 str = g_try_realloc (str, total_allocated);
330 _("Could not allocate %lu bytes to read file \"%s\""),
331 (gulong) total_allocated, filename);
340 g_file_error_from_errno (errno),
341 _("Error reading file '%s': %s"),
342 filename, strerror (errno));
347 memcpy (str + total_bytes, buf, bytes);
348 total_bytes += bytes;
353 str[total_bytes] = '\0';
356 *length = total_bytes;
373 get_contents_regfile (const gchar *filename,
374 struct stat *stat_buf,
385 size = stat_buf->st_size;
387 alloc_size = size + 1;
388 buf = g_try_malloc (alloc_size);
395 _("Could not allocate %lu bytes to read file \"%s\""),
396 (gulong) alloc_size, filename);
402 while (bytes_read < size)
406 rc = read (fd, buf + bytes_read, size - bytes_read);
418 g_file_error_from_errno (errno),
419 _("Failed to read from file '%s': %s"),
420 filename, strerror (errno));
431 buf[bytes_read] = '\0';
434 *length = bytes_read;
442 get_contents_posix (const gchar *filename,
447 struct stat stat_buf;
450 /* O_BINARY useful on Cygwin */
451 fd = open (filename, O_RDONLY|O_BINARY);
457 g_file_error_from_errno (errno),
458 _("Failed to open file '%s': %s"),
459 filename, strerror (errno));
464 /* I don't think this will ever fail, aside from ENOMEM, but. */
465 if (fstat (fd, &stat_buf) < 0)
471 g_file_error_from_errno (errno),
472 _("Failed to get attributes of file '%s': fstat() failed: %s"),
473 filename, strerror (errno));
478 if (stat_buf.st_size > 0 && S_ISREG (stat_buf.st_mode))
480 return get_contents_regfile (filename,
491 f = fdopen (fd, "r");
497 g_file_error_from_errno (errno),
498 _("Failed to open file '%s': fdopen() failed: %s"),
499 filename, strerror (errno));
504 return get_contents_stdio (filename, f, contents, length, error);
508 #else /* G_OS_WIN32 */
511 get_contents_win32 (const gchar *filename,
518 /* I guess you want binary mode; maybe you want text sometimes? */
519 f = fopen (filename, "rb");
525 g_file_error_from_errno (errno),
526 _("Failed to open file '%s': %s"),
527 filename, strerror (errno));
532 return get_contents_stdio (filename, f, contents, length, error);
538 * g_file_get_contents:
539 * @filename: a file to read contents from
540 * @contents: location to store an allocated string
541 * @length: location to store length in bytes of the contents
542 * @error: return location for a #GError
544 * Reads an entire file into allocated memory, with good error
545 * checking. If @error is set, %FALSE is returned, and @contents is set
546 * to %NULL. If %TRUE is returned, @error will not be set, and @contents
547 * will be set to the file contents. The string stored in @contents
548 * will be nul-terminated, so for text files you can pass %NULL for the
549 * @length argument. The error domain is #G_FILE_ERROR. Possible
550 * error codes are those in the #GFileError enumeration.
552 * Return value: %TRUE on success, %FALSE if error is set
555 g_file_get_contents (const gchar *filename,
560 g_return_val_if_fail (filename != NULL, FALSE);
561 g_return_val_if_fail (contents != NULL, FALSE);
568 return get_contents_win32 (filename, contents, length, error);
570 return get_contents_posix (filename, contents, length, error);
575 * mkstemp() implementation is from the GNU C library.
576 * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
580 * @tmpl: template filename
582 * Opens a temporary file. See the <function>mkstemp()</function> documentation
583 * on most UNIX-like systems. This is a portability wrapper, which simply calls
584 * <function>mkstemp()</function> on systems that have it, and implements
585 * it in GLib otherwise.
587 * The parameter is a string that should match the rules for
588 * <function>mkstemp()</function>, i.e. end in "XXXXXX". The X string will
589 * be modified to form the name of a file that didn't exist.
591 * Return value: A file handle (as from <function>open()</function>) to the file
592 * opened for reading and writing. The file is opened in binary mode
593 * on platforms where there is a difference. The file handle should be
594 * closed with <function>close()</function>. In case of errors, -1 is returned.
597 g_mkstemp (char *tmpl)
600 return mkstemp (tmpl);
605 static const char letters[] =
606 "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
607 static const int NLETTERS = sizeof (letters) - 1;
610 static int counter = 0;
613 if (len < 6 || strcmp (&tmpl[len - 6], "XXXXXX"))
616 /* This is where the Xs start. */
617 XXXXXX = &tmpl[len - 6];
619 /* Get some more or less random data. */
620 g_get_current_time (&tv);
621 value = (tv.tv_usec ^ tv.tv_sec) + counter++;
623 for (count = 0; count < 100; value += 7777, ++count)
627 /* Fill in the random bits. */
628 XXXXXX[0] = letters[v % NLETTERS];
630 XXXXXX[1] = letters[v % NLETTERS];
632 XXXXXX[2] = letters[v % NLETTERS];
634 XXXXXX[3] = letters[v % NLETTERS];
636 XXXXXX[4] = letters[v % NLETTERS];
638 XXXXXX[5] = letters[v % NLETTERS];
640 fd = open (tmpl, O_RDWR | O_CREAT | O_EXCL | O_BINARY, 0600);
644 else if (errno != EEXIST)
645 /* Any other error will apply also to other names we might
646 * try, and there are 2^32 or so of them, so give up now.
651 /* We got out of the loop because we ran out of combinations to try. */
658 * @tmpl: Template for file name, as in g_mkstemp(), basename only
659 * @name_used: location to store actual name used
660 * @error: return location for a #GError
662 * Opens a file for writing in the preferred directory for temporary
663 * files (as returned by g_get_tmp_dir()).
665 * @tmpl should be a string ending with six 'X' characters, as the
666 * parameter to g_mkstemp() (or <function>mkstemp()</function>).
667 * However, unlike these functions, the template should only be a
668 * basename, no directory components are allowed. If template is %NULL,
669 * a default template is used.
671 * Note that in contrast to g_mkstemp() (and <function>mkstemp()</function>)
672 * @tmpl is not modified, and might thus be a read-only literal string.
674 * The actual name used is returned in @name_used if non-%NULL. This
675 * string should be freed with g_free() when not needed any longer.
677 * Return value: A file handle (as from <function>open()</function>) to
678 * the file opened for reading and writing. The file is opened in binary
679 * mode on platforms where there is a difference. The file handle should be
680 * closed with <function>close()</function>. In case of errors, -1 is returned
681 * and @error will be set.
684 g_file_open_tmp (const char *tmpl,
696 if (strchr (tmpl, G_DIR_SEPARATOR)
698 || strchr (tmpl, '/')
705 _("Template '%s' invalid, should not contain a '%s'"),
706 tmpl, G_DIR_SEPARATOR_S);
711 if (strlen (tmpl) < 6 ||
712 strcmp (tmpl + strlen (tmpl) - 6, "XXXXXX") != 0)
717 _("Template '%s' doesn't end with XXXXXX"),
722 tmpdir = g_get_tmp_dir ();
724 if (tmpdir [strlen (tmpdir) - 1] == G_DIR_SEPARATOR)
727 sep = G_DIR_SEPARATOR_S;
729 fulltemplate = g_strconcat (tmpdir, sep, tmpl, NULL);
731 retval = g_mkstemp (fulltemplate);
737 g_file_error_from_errno (errno),
738 _("Failed to create file '%s': %s"),
739 fulltemplate, strerror (errno));
740 g_free (fulltemplate);
745 *name_used = fulltemplate;
747 g_free (fulltemplate);
753 g_build_pathv (const gchar *separator,
754 const gchar *first_element,
758 gint separator_len = strlen (separator);
759 gboolean is_first = TRUE;
760 const gchar *next_element;
762 result = g_string_new (NULL);
764 next_element = first_element;
768 const gchar *element;
774 element = next_element;
775 next_element = va_arg (args, gchar *);
784 else if (separator_len)
787 strncmp (start, separator, separator_len) == 0)
788 start += separator_len;
791 end = start + strlen (start);
793 if (next_element && separator_len)
795 while (end > start + separator_len &&
796 strncmp (end - separator_len, separator, separator_len) == 0)
797 end -= separator_len;
803 g_string_append (result, separator);
805 g_string_append_len (result, start, end - start);
809 return g_string_free (result, FALSE);
814 * @separator: a string used to separator the elements of the path.
815 * @first_element: the first element in the path
816 * @Varargs: remaining elements in path
818 * Creates a path from a series of elements using @separator as the
819 * separator between elements. At the boundary between two elements,
820 * any trailing occurrences of separator in the first element, or
821 * leading occurrences of separator in the second element are removed
822 * and exactly one copy of the separator is inserted.
824 * Return value: a newly-allocated string that must be freed with g_free().
827 g_build_path (const gchar *separator,
828 const gchar *first_element,
834 g_return_val_if_fail (separator != NULL, NULL);
836 va_start (args, first_element);
837 str = g_build_pathv (separator, first_element, args);
845 * @first_element: the first element in the path
846 * @Varargs: remaining elements in path
848 * Creates a filename from a series of elements using the correct
849 * separator for filenames. This function behaves identically
850 * to <literal>g_build_path (G_DIR_SEPARATOR_S, first_element, ....)</literal>.
852 * No attempt is made to force the resulting filename to be an absolute
853 * path. If the first element is a relative path, the result will
854 * be a relative path.
856 * Return value: a newly-allocated string that must be freed with g_free().
859 g_build_filename (const gchar *first_element,
865 va_start (args, first_element);
866 str = g_build_pathv (G_DIR_SEPARATOR_S, first_element, args);