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 * Note, that for a dangling symbolic link g_file_test() will return
85 * %TRUE for #G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.
87 * Return value: whether a test was %TRUE
90 g_file_test (const gchar *filename,
93 if ((test & G_FILE_TEST_EXISTS) && (access (filename, F_OK) == 0))
96 if ((test & G_FILE_TEST_IS_EXECUTABLE) && (access (filename, X_OK) == 0))
99 if (test & G_FILE_TEST_IS_SYMLINK)
102 /* no sym links on win32, no lstat in msvcrt */
106 if ((lstat (filename, &s) == 0) && S_ISLNK (s.st_mode))
111 if (test & (G_FILE_TEST_IS_REGULAR | G_FILE_TEST_IS_DIR))
115 if (stat (filename, &s) == 0)
117 if ((test & G_FILE_TEST_IS_REGULAR) && S_ISREG (s.st_mode))
120 if ((test & G_FILE_TEST_IS_DIR) && S_ISDIR (s.st_mode))
129 g_file_error_quark (void)
133 q = g_quark_from_static_string ("g-file-error-quark");
139 * g_file_error_from_errno:
140 * @err_no: an "errno" value
142 * Gets a #GFileError constant based on the passed-in @errno.
143 * For example, if you pass in %EEXIST this function returns
144 * #G_FILE_ERROR_EXIST. Unlike @errno values, you can portably
145 * assume that all #GFileError values will exist.
147 * Normally a #GFileError value goes into a #GError returned
148 * from a function that manipulates files. So you would use
149 * g_file_error_from_errno() when constructing a #GError.
151 * Return value: #GFileError corresponding to the given @errno
154 g_file_error_from_errno (gint err_no)
160 return G_FILE_ERROR_EXIST;
166 return G_FILE_ERROR_ISDIR;
172 return G_FILE_ERROR_ACCES;
178 return G_FILE_ERROR_NAMETOOLONG;
184 return G_FILE_ERROR_NOENT;
190 return G_FILE_ERROR_NOTDIR;
196 return G_FILE_ERROR_NXIO;
202 return G_FILE_ERROR_NODEV;
208 return G_FILE_ERROR_ROFS;
214 return G_FILE_ERROR_TXTBSY;
220 return G_FILE_ERROR_FAULT;
226 return G_FILE_ERROR_LOOP;
232 return G_FILE_ERROR_NOSPC;
238 return G_FILE_ERROR_NOMEM;
244 return G_FILE_ERROR_MFILE;
250 return G_FILE_ERROR_NFILE;
256 return G_FILE_ERROR_BADF;
262 return G_FILE_ERROR_INVAL;
268 return G_FILE_ERROR_PIPE;
274 return G_FILE_ERROR_AGAIN;
280 return G_FILE_ERROR_INTR;
286 return G_FILE_ERROR_IO;
292 return G_FILE_ERROR_PERM;
297 return G_FILE_ERROR_FAILED;
303 get_contents_stdio (const gchar *filename,
313 size_t total_allocated;
315 g_assert (f != NULL);
317 #define STARTING_ALLOC 64
320 total_allocated = STARTING_ALLOC;
321 str = g_malloc (STARTING_ALLOC);
325 bytes = fread (buf, 1, 2048, f);
327 while ((total_bytes + bytes + 1) > total_allocated)
329 total_allocated *= 2;
330 str = g_try_realloc (str, total_allocated);
337 _("Could not allocate %lu bytes to read file \"%s\""),
338 (gulong) total_allocated, filename);
347 g_file_error_from_errno (errno),
348 _("Error reading file '%s': %s"),
349 filename, g_strerror (errno));
354 memcpy (str + total_bytes, buf, bytes);
355 total_bytes += bytes;
360 str[total_bytes] = '\0';
363 *length = total_bytes;
380 get_contents_regfile (const gchar *filename,
381 struct stat *stat_buf,
392 size = stat_buf->st_size;
394 alloc_size = size + 1;
395 buf = g_try_malloc (alloc_size);
402 _("Could not allocate %lu bytes to read file \"%s\""),
403 (gulong) alloc_size, filename);
409 while (bytes_read < size)
413 rc = read (fd, buf + bytes_read, size - bytes_read);
423 g_file_error_from_errno (errno),
424 _("Failed to read from file '%s': %s"),
425 filename, g_strerror (errno));
436 buf[bytes_read] = '\0';
439 *length = bytes_read;
455 get_contents_posix (const gchar *filename,
460 struct stat stat_buf;
463 /* O_BINARY useful on Cygwin */
464 fd = open (filename, O_RDONLY|O_BINARY);
470 g_file_error_from_errno (errno),
471 _("Failed to open file '%s': %s"),
472 filename, g_strerror (errno));
477 /* I don't think this will ever fail, aside from ENOMEM, but. */
478 if (fstat (fd, &stat_buf) < 0)
484 g_file_error_from_errno (errno),
485 _("Failed to get attributes of file '%s': fstat() failed: %s"),
486 filename, g_strerror (errno));
491 if (stat_buf.st_size > 0 && S_ISREG (stat_buf.st_mode))
493 return get_contents_regfile (filename,
504 f = fdopen (fd, "r");
510 g_file_error_from_errno (errno),
511 _("Failed to open file '%s': fdopen() failed: %s"),
512 filename, g_strerror (errno));
517 return get_contents_stdio (filename, f, contents, length, error);
521 #else /* G_OS_WIN32 */
524 get_contents_win32 (const gchar *filename,
531 /* I guess you want binary mode; maybe you want text sometimes? */
532 f = fopen (filename, "rb");
538 g_file_error_from_errno (errno),
539 _("Failed to open file '%s': %s"),
540 filename, g_strerror (errno));
545 return get_contents_stdio (filename, f, contents, length, error);
551 * g_file_get_contents:
552 * @filename: a file to read contents from
553 * @contents: location to store an allocated string
554 * @length: location to store length in bytes of the contents
555 * @error: return location for a #GError
557 * Reads an entire file into allocated memory, with good error
558 * checking. If @error is set, %FALSE is returned, and @contents is set
559 * to %NULL. If %TRUE is returned, @error will not be set, and @contents
560 * will be set to the file contents. The string stored in @contents
561 * will be nul-terminated, so for text files you can pass %NULL for the
562 * @length argument. The error domain is #G_FILE_ERROR. Possible
563 * error codes are those in the #GFileError enumeration.
565 * Return value: %TRUE on success, %FALSE if error is set
568 g_file_get_contents (const gchar *filename,
573 g_return_val_if_fail (filename != NULL, FALSE);
574 g_return_val_if_fail (contents != NULL, FALSE);
581 return get_contents_win32 (filename, contents, length, error);
583 return get_contents_posix (filename, contents, length, error);
588 * mkstemp() implementation is from the GNU C library.
589 * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
593 * @tmpl: template filename
595 * Opens a temporary file. See the <function>mkstemp()</function> documentation
596 * on most UNIX-like systems. This is a portability wrapper, which simply calls
597 * <function>mkstemp()</function> on systems that have it, and implements
598 * it in GLib otherwise.
600 * The parameter is a string that should match the rules for
601 * <function>mkstemp()</function>, i.e. end in "XXXXXX". The X string will
602 * be modified to form the name of a file that didn't exist.
604 * Return value: A file handle (as from <function>open()</function>) to the file
605 * opened for reading and writing. The file is opened in binary mode
606 * on platforms where there is a difference. The file handle should be
607 * closed with <function>close()</function>. In case of errors, -1 is returned.
610 g_mkstemp (char *tmpl)
613 return mkstemp (tmpl);
618 static const char letters[] =
619 "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
620 static const int NLETTERS = sizeof (letters) - 1;
623 static int counter = 0;
626 if (len < 6 || strcmp (&tmpl[len - 6], "XXXXXX"))
629 /* This is where the Xs start. */
630 XXXXXX = &tmpl[len - 6];
632 /* Get some more or less random data. */
633 g_get_current_time (&tv);
634 value = (tv.tv_usec ^ tv.tv_sec) + counter++;
636 for (count = 0; count < 100; value += 7777, ++count)
640 /* Fill in the random bits. */
641 XXXXXX[0] = letters[v % NLETTERS];
643 XXXXXX[1] = letters[v % NLETTERS];
645 XXXXXX[2] = letters[v % NLETTERS];
647 XXXXXX[3] = letters[v % NLETTERS];
649 XXXXXX[4] = letters[v % NLETTERS];
651 XXXXXX[5] = letters[v % NLETTERS];
653 fd = open (tmpl, O_RDWR | O_CREAT | O_EXCL | O_BINARY, 0600);
657 else if (errno != EEXIST)
658 /* Any other error will apply also to other names we might
659 * try, and there are 2^32 or so of them, so give up now.
664 /* We got out of the loop because we ran out of combinations to try. */
671 * @tmpl: Template for file name, as in g_mkstemp(), basename only
672 * @name_used: location to store actual name used
673 * @error: return location for a #GError
675 * Opens a file for writing in the preferred directory for temporary
676 * files (as returned by g_get_tmp_dir()).
678 * @tmpl should be a string ending with six 'X' characters, as the
679 * parameter to g_mkstemp() (or <function>mkstemp()</function>).
680 * However, unlike these functions, the template should only be a
681 * basename, no directory components are allowed. If template is %NULL,
682 * a default template is used.
684 * Note that in contrast to g_mkstemp() (and <function>mkstemp()</function>)
685 * @tmpl is not modified, and might thus be a read-only literal string.
687 * The actual name used is returned in @name_used if non-%NULL. This
688 * string should be freed with g_free() when not needed any longer.
690 * Return value: A file handle (as from <function>open()</function>) to
691 * the file opened for reading and writing. The file is opened in binary
692 * mode on platforms where there is a difference. The file handle should be
693 * closed with <function>close()</function>. In case of errors, -1 is returned
694 * and @error will be set.
697 g_file_open_tmp (const char *tmpl,
709 if (strchr (tmpl, G_DIR_SEPARATOR)
711 || strchr (tmpl, '/')
718 _("Template '%s' invalid, should not contain a '%s'"),
719 tmpl, G_DIR_SEPARATOR_S);
724 if (strlen (tmpl) < 6 ||
725 strcmp (tmpl + strlen (tmpl) - 6, "XXXXXX") != 0)
730 _("Template '%s' doesn't end with XXXXXX"),
735 tmpdir = g_get_tmp_dir ();
737 if (tmpdir [strlen (tmpdir) - 1] == G_DIR_SEPARATOR)
740 sep = G_DIR_SEPARATOR_S;
742 fulltemplate = g_strconcat (tmpdir, sep, tmpl, NULL);
744 retval = g_mkstemp (fulltemplate);
750 g_file_error_from_errno (errno),
751 _("Failed to create file '%s': %s"),
752 fulltemplate, g_strerror (errno));
753 g_free (fulltemplate);
758 *name_used = fulltemplate;
760 g_free (fulltemplate);
766 g_build_pathv (const gchar *separator,
767 const gchar *first_element,
771 gint separator_len = strlen (separator);
772 gboolean is_first = TRUE;
773 gboolean have_leading = FALSE;
774 const gchar *single_element = NULL;
775 const gchar *next_element;
776 const gchar *last_trailing = NULL;
778 result = g_string_new (NULL);
780 next_element = first_element;
784 const gchar *element;
790 element = next_element;
791 next_element = va_arg (args, gchar *);
796 /* Ignore empty elements */
805 strncmp (start, separator, separator_len) == 0)
806 start += separator_len;
809 end = start + strlen (start);
813 while (end >= start + separator_len &&
814 strncmp (end - separator_len, separator, separator_len) == 0)
815 end -= separator_len;
818 while (last_trailing >= element + separator_len &&
819 strncmp (last_trailing - separator_len, separator, separator_len) == 0)
820 last_trailing -= separator_len;
824 /* If the leading and trailing separator strings are in the
825 * same element and overlap, the result is exactly that element
827 if (last_trailing <= start)
828 single_element = element;
830 g_string_append_len (result, element, start - element);
834 single_element = NULL;
841 g_string_append (result, separator);
843 g_string_append_len (result, start, end - start);
849 g_string_free (result, TRUE);
850 return g_strdup (single_element);
855 g_string_append (result, last_trailing);
857 return g_string_free (result, FALSE);
863 * @separator: a string used to separator the elements of the path.
864 * @first_element: the first element in the path
865 * @Varargs: remaining elements in path, terminated by %NULL
867 * Creates a path from a series of elements using @separator as the
868 * separator between elements. At the boundary between two elements,
869 * any trailing occurrences of separator in the first element, or
870 * leading occurrences of separator in the second element are removed
871 * and exactly one copy of the separator is inserted.
873 * Empty elements are ignored.
875 * The number of leading copies of the separator on the result is
876 * the same as the number of leading copies of the separator on
877 * the first non-empty element.
879 * The number of trailing copies of the separator on the result is
880 * the same as the number of trailing copies of the separator on
881 * the last non-empty element. (Determination of the number of
882 * trailing copies is done without stripping leading copies, so
883 * if the separator is <literal>ABA</literal>, <literal>ABABA</literal>
884 * has 1 trailing copy.)
886 * However, if there is only a single non-empty element, and there
887 * are no characters in that element not part of the leading or
888 * trailing separators, then the result is exactly the original value
891 * Other than for determination of the number of leading and trailing
892 * copies of the separator, elements consisting only of copies
893 * of the separator are ignored.
895 * Return value: a newly-allocated string that must be freed with g_free().
898 g_build_path (const gchar *separator,
899 const gchar *first_element,
905 g_return_val_if_fail (separator != NULL, NULL);
907 va_start (args, first_element);
908 str = g_build_pathv (separator, first_element, args);
916 * @first_element: the first element in the path
917 * @Varargs: remaining elements in path, terminated by %NULL
919 * Creates a filename from a series of elements using the correct
920 * separator for filenames. This function behaves identically
921 * to <literal>g_build_path (G_DIR_SEPARATOR_S, first_element, ....)</literal>.
923 * No attempt is made to force the resulting filename to be an absolute
924 * path. If the first element is a relative path, the result will
925 * be a relative path.
927 * Return value: a newly-allocated string that must be freed with g_free().
930 g_build_filename (const gchar *first_element,
936 va_start (args, first_element);
937 str = g_build_pathv (G_DIR_SEPARATOR_S, first_element, args);