glib/gfileutils.c

   1 /* gfileutils.c - File utility functions
   2  *
   3  *  Copyright 2000 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 #include "config.h"
  22 #include "glibconfig.h"
  23
  24 #include <sys/stat.h>
  25 #ifdef HAVE_UNISTD_H
  26 #include <unistd.h>
  27 #endif
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <stdarg.h>
  31 #include <string.h>
  32 #include <errno.h>
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <fcntl.h>
  36 #include <stdlib.h>
  37
  38 #ifdef G_OS_WIN32
  39 #include <windows.h>
  40 #include <io.h>
  41 #endif /* G_OS_WIN32 */
  42
  43 #ifndef S_ISLNK
  44 #define S_ISLNK(x) 0
  45 #endif
  46
  47 #ifndef O_BINARY
  48 #define O_BINARY 0
  49 #endif
  50
  51 #include "gfileutils.h"
  52
  53 #include "gstdio.h"
  54 #include "glibintl.h"
  55
  56 #ifdef HAVE_LINUX_MAGIC_H /* for btrfs check */
  57 #include <linux/magic.h>
  58 #include <sys/vfs.h>
  59 #endif
  60
  61
  62 /**
  63  * SECTION:fileutils
  64  * @title: File Utilities
  65  * @short_description: various file-related functions
  66  *
  67  * There is a group of functions which wrap the common POSIX functions
  68  * dealing with filenames (g_open(), g_rename(), g_mkdir(), g_stat(),
  69  * g_unlink(), g_remove(), g_fopen(), g_freopen()). The point of these
  70  * wrappers is to make it possible to handle file names with any Unicode
  71  * characters in them on Windows without having to use ifdefs and the
  72  * wide character API in the application code.
  73  *
  74  * The pathname argument should be in the GLib file name encoding.
  75  * On POSIX this is the actual on-disk encoding which might correspond
  76  * to the locale settings of the process (or the
  77  * <envar>G_FILENAME_ENCODING</envar> environment variable), or not.
  78  *
  79  * On Windows the GLib file name encoding is UTF-8. Note that the
  80  * Microsoft C library does not use UTF-8, but has separate APIs for
  81  * current system code page and wide characters (UTF-16). The GLib
  82  * wrappers call the wide character API if present (on modern Windows
  83  * systems), otherwise convert to/from the system code page.
  84  *
  85  * Another group of functions allows to open and read directories
  86  * in the GLib file name encoding. These are g_dir_open(),
  87  * g_dir_read_name(), g_dir_rewind(), g_dir_close().
  88  */
  89
  90 /**
  91  * GFileError:
  92  * @G_FILE_ERROR_EXIST: Operation not permitted; only the owner of
  93  *     the file (or other resource) or processes with special privileges
  94  *     can perform the operation.
  95  * @G_FILE_ERROR_ISDIR: File is a directory; you cannot open a directory
  96  *     for writing, or create or remove hard links to it.
  97  * @G_FILE_ERROR_ACCES: Permission denied; the file permissions do not
  98  *     allow the attempted operation.
  99  * @G_FILE_ERROR_NAMETOOLONG: Filename too long.
 100  * @G_FILE_ERROR_NOENT: No such file or directory. This is a "file
 101  *     doesn't exist" error for ordinary files that are referenced in
 102  *     contexts where they are expected to already exist.
 103  * @G_FILE_ERROR_NOTDIR: A file that isn't a directory was specified when
 104  *     a directory is required.
 105  * @G_FILE_ERROR_NXIO: No such device or address. The system tried to
 106  *     use the device represented by a file you specified, and it
 107  *     couldn't find the device. This can mean that the device file was
 108  *     installed incorrectly, or that the physical device is missing or
 109  *     not correctly attached to the computer.
 110  * @G_FILE_ERROR_NODEV: The underlying file system of the specified file
 111  *     does not support memory mapping.
 112  * @G_FILE_ERROR_ROFS: The directory containing the new link can't be
 113  *     modified because it's on a read-only file system.
 114  * @G_FILE_ERROR_TXTBSY: Text file busy.
 115  * @G_FILE_ERROR_FAULT: You passed in a pointer to bad memory.
 116  *     (GLib won't reliably return this, don't pass in pointers to bad
 117  *     memory.)
 118  * @G_FILE_ERROR_LOOP: Too many levels of symbolic links were encountered
 119  *     in looking up a file name. This often indicates a cycle of symbolic
 120  *     links.
 121  * @G_FILE_ERROR_NOSPC: No space left on device; write operation on a
 122  *     file failed because the disk is full.
 123  * @G_FILE_ERROR_NOMEM: No memory available. The system cannot allocate
 124  *     more virtual memory because its capacity is full.
 125  * @G_FILE_ERROR_MFILE: The current process has too many files open and
 126  *     can't open any more. Duplicate descriptors do count toward this
 127  *     limit.
 128  * @G_FILE_ERROR_NFILE: There are too many distinct file openings in the
 129  *     entire system.
 130  * @G_FILE_ERROR_BADF: Bad file descriptor; for example, I/O on a
 131  *     descriptor that has been closed or reading from a descriptor open
 132  *     only for writing (or vice versa).
 133  * @G_FILE_ERROR_INVAL: Invalid argument. This is used to indicate
 134  *     various kinds of problems with passing the wrong argument to a
 135  *     library function.
 136  * @G_FILE_ERROR_PIPE: Broken pipe; there is no process reading from the
 137  *     other end of a pipe. Every library function that returns this
 138  *     error code also generates a 'SIGPIPE' signal; this signal
 139  *     terminates the program if not handled or blocked. Thus, your
 140  *     program will never actually see this code unless it has handled
 141  *     or blocked 'SIGPIPE'.
 142  * @G_FILE_ERROR_AGAIN: Resource temporarily unavailable; the call might
 143  *     work if you try again later.
 144  * @G_FILE_ERROR_INTR: Interrupted function call; an asynchronous signal
 145  *     occurred and prevented completion of the call. When this
 146  *     happens, you should try the call again.
 147  * @G_FILE_ERROR_IO: Input/output error; usually used for physical read
 148  *    or write errors. i.e. the disk or other physical device hardware
 149  *    is returning errors.
 150  * @G_FILE_ERROR_PERM: Operation not permitted; only the owner of the
 151  *    file (or other resource) or processes with special privileges can
 152  *    perform the operation.
 153  * @G_FILE_ERROR_NOSYS: Function not implemented; this indicates that
 154  *    the system is missing some functionality.
 155  * @G_FILE_ERROR_FAILED: Does not correspond to a UNIX error code; this
 156  *    is the standard "failed for unspecified reason" error code present
 157  *    in all #GError error code enumerations. Returned if no specific
 158  *    code applies.
 159  *
 160  * Values corresponding to @errno codes returned from file operations
 161  * on UNIX. Unlike @errno codes, GFileError values are available on
 162  * all systems, even Windows. The exact meaning of each code depends
 163  * on what sort of file operation you were performing; the UNIX
 164  * documentation gives more details. The following error code descriptions
 165  * come from the GNU C Library manual, and are under the copyright
 166  * of that manual.
 167  *
 168  * It's not very portable to make detailed assumptions about exactly
 169  * which errors will be returned from a given operation. Some errors
 170  * don't occur on some systems, etc., sometimes there are subtle
 171  * differences in when a system will report a given error, etc.
 172  */
 173
 174 /**
 175  * G_FILE_ERROR:
 176  *
 177  * Error domain for file operations. Errors in this domain will
 178  * be from the #GFileError enumeration. See #GError for information
 179  * on error domains.
 180  */
 181
 182 /**
 183  * GFileTest:
 184  * @G_FILE_TEST_IS_REGULAR: %TRUE if the file is a regular file
 185  *     (not a directory). Note that this test will also return %TRUE
 186  *     if the tested file is a symlink to a regular file.
 187  * @G_FILE_TEST_IS_SYMLINK: %TRUE if the file is a symlink.
 188  * @G_FILE_TEST_IS_DIR: %TRUE if the file is a directory.
 189  * @G_FILE_TEST_IS_EXECUTABLE: %TRUE if the file is executable.
 190  * @G_FILE_TEST_EXISTS: %TRUE if the file exists. It may or may not
 191  *     be a regular file.
 192  *
 193  * A test to perform on a file using g_file_test().
 194  */
 195
 196 /**
 197  * g_mkdir_with_parents:
 198  * @pathname: a pathname in the GLib file name encoding
 199  * @mode: permissions to use for newly created directories
 200  *
 201  * Create a directory if it doesn't already exist. Create intermediate
 202  * parent directories as needed, too.
 203  *
 204  * Returns: 0 if the directory already exists, or was successfully
 205  * created. Returns -1 if an error occurred, with errno set.
 206  *
 207  * Since: 2.8
 208  */
 209 int
 210 g_mkdir_with_parents (const gchar *pathname,
 211                       int          mode)
 212 {
 213   gchar *fn, *p;
 214
 215   if (pathname == NULL || *pathname == '\0')
 216     {
 217       errno = EINVAL;
 218       return -1;
 219     }
 220
 221   fn = g_strdup (pathname);
 222
 223   if (g_path_is_absolute (fn))
 224     p = (gchar *) g_path_skip_root (fn);
 225   else
 226     p = fn;
 227
 228   do
 229     {
 230       while (*p && !G_IS_DIR_SEPARATOR (*p))
 231         p++;
 232
 233       if (!*p)
 234         p = NULL;
 235       else
 236         *p = '\0';
 237
 238       if (!g_file_test (fn, G_FILE_TEST_EXISTS))
 239         {
 240           if (g_mkdir (fn, mode) == -1 && errno != EEXIST)
 241             {
 242               int errno_save = errno;
 243               g_free (fn);
 244               errno = errno_save;
 245               return -1;
 246             }
 247         }
 248       else if (!g_file_test (fn, G_FILE_TEST_IS_DIR))
 249         {
 250           g_free (fn);
 251           errno = ENOTDIR;
 252           return -1;
 253         }
 254       if (p)
 255         {
 256           *p++ = G_DIR_SEPARATOR;
 257           while (*p && G_IS_DIR_SEPARATOR (*p))
 258             p++;
 259         }
 260     }
 261   while (p);
 262
 263   g_free (fn);
 264
 265   return 0;
 266 }
 267
 268 /**
 269  * g_file_test:
 270  * @filename: a filename to test in the GLib file name encoding
 271  * @test: bitfield of #GFileTest flags
 272  *
 273  * Returns %TRUE if any of the tests in the bitfield @test are
 274  * %TRUE. For example, <literal>(G_FILE_TEST_EXISTS |
 275  * G_FILE_TEST_IS_DIR)</literal> will return %TRUE if the file exists;
 276  * the check whether it's a directory doesn't matter since the existence
 277  * test is %TRUE. With the current set of available tests, there's no point
 278  * passing in more than one test at a time.
 279  *
 280  * Apart from %G_FILE_TEST_IS_SYMLINK all tests follow symbolic links,
 281  * so for a symbolic link to a regular file g_file_test() will return
 282  * %TRUE for both %G_FILE_TEST_IS_SYMLINK and %G_FILE_TEST_IS_REGULAR.
 283  *
 284  * Note, that for a dangling symbolic link g_file_test() will return
 285  * %TRUE for %G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.
 286  *
 287  * You should never use g_file_test() to test whether it is safe
 288  * to perform an operation, because there is always the possibility
 289  * of the condition changing before you actually perform the operation.
 290  * For example, you might think you could use %G_FILE_TEST_IS_SYMLINK
 291  * to know whether it is safe to write to a file without being
 292  * tricked into writing into a different location. It doesn't work!
 293  * |[
 294  * /&ast; DON'T DO THIS &ast;/
 295  *  if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK))
 296  *    {
 297  *      fd = g_open (filename, O_WRONLY);
 298  *      /&ast; write to fd &ast;/
 299  *    }
 300  * ]|
 301  *
 302  * Another thing to note is that %G_FILE_TEST_EXISTS and
 303  * %G_FILE_TEST_IS_EXECUTABLE are implemented using the access()
 304  * system call. This usually doesn't matter, but if your program
 305  * is setuid or setgid it means that these tests will give you
 306  * the answer for the real user ID and group ID, rather than the
 307  * effective user ID and group ID.
 308  *
 309  * On Windows, there are no symlinks, so testing for
 310  * %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
 311  * %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
 312  * its name indicates that it is executable, checking for well-known
 313  * extensions and those listed in the <envar>PATHEXT</envar> environment variable.
 314  *
 315  * Return value: whether a test was %TRUE
 316  **/
 317 gboolean
 318 g_file_test (const gchar *filename,
 319              GFileTest    test)
 320 {
 321 #ifdef G_OS_WIN32
 322 /* stuff missing in std vc6 api */
 323 #  ifndef INVALID_FILE_ATTRIBUTES
 324 #    define INVALID_FILE_ATTRIBUTES -1
 325 #  endif
 326 #  ifndef FILE_ATTRIBUTE_DEVICE
 327 #    define FILE_ATTRIBUTE_DEVICE 64
 328 #  endif
 329   int attributes;
 330   wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
 331
 332   if (wfilename == NULL)
 333     return FALSE;
 334
 335   attributes = GetFileAttributesW (wfilename);
 336
 337   g_free (wfilename);
 338
 339   if (attributes == INVALID_FILE_ATTRIBUTES)
 340     return FALSE;
 341
 342   if (test & G_FILE_TEST_EXISTS)
 343     return TRUE;
 344
 345   if (test & G_FILE_TEST_IS_REGULAR)
 346     {
 347       if ((attributes & (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_DEVICE)) == 0)
 348         return TRUE;
 349     }
 350
 351   if (test & G_FILE_TEST_IS_DIR)
 352     {
 353       if ((attributes & FILE_ATTRIBUTE_DIRECTORY) != 0)
 354         return TRUE;
 355     }
 356
 357   /* "while" so that we can exit this "loop" with a simple "break" */
 358   while (test & G_FILE_TEST_IS_EXECUTABLE)
 359     {
 360       const gchar *lastdot = strrchr (filename, '.');
 361       const gchar *pathext = NULL, *p;
 362       int extlen;
 363
 364       if (lastdot == NULL)
 365         break;
 366
 367       if (_stricmp (lastdot, ".exe") == 0 ||
 368           _stricmp (lastdot, ".cmd") == 0 ||
 369           _stricmp (lastdot, ".bat") == 0 ||
 370           _stricmp (lastdot, ".com") == 0)
 371         return TRUE;
 372
 373       /* Check if it is one of the types listed in %PATHEXT% */
 374
 375       pathext = g_getenv ("PATHEXT");
 376       if (pathext == NULL)
 377         break;
 378
 379       pathext = g_utf8_casefold (pathext, -1);
 380
 381       lastdot = g_utf8_casefold (lastdot, -1);
 382       extlen = strlen (lastdot);
 383
 384       p = pathext;
 385       while (TRUE)
 386         {
 387           const gchar *q = strchr (p, ';');
 388           if (q == NULL)
 389             q = p + strlen (p);
 390           if (extlen == q - p &&
 391               memcmp (lastdot, p, extlen) == 0)
 392             {
 393               g_free ((gchar *) pathext);
 394               g_free ((gchar *) lastdot);
 395               return TRUE;
 396             }
 397           if (*q)
 398             p = q + 1;
 399           else
 400             break;
 401         }
 402
 403       g_free ((gchar *) pathext);
 404       g_free ((gchar *) lastdot);
 405       break;
 406     }
 407
 408   return FALSE;
 409 #else
 410   if ((test & G_FILE_TEST_EXISTS) && (access (filename, F_OK) == 0))
 411     return TRUE;
 412
 413   if ((test & G_FILE_TEST_IS_EXECUTABLE) && (access (filename, X_OK) == 0))
 414     {
 415       if (getuid () != 0)
 416         return TRUE;
 417
 418       /* For root, on some POSIX systems, access (filename, X_OK)
 419        * will succeed even if no executable bits are set on the
 420        * file. We fall through to a stat test to avoid that.
 421        */
 422     }
 423   else
 424     test &= ~G_FILE_TEST_IS_EXECUTABLE;
 425
 426   if (test & G_FILE_TEST_IS_SYMLINK)
 427     {
 428       struct stat s;
 429
 430       if ((lstat (filename, &s) == 0) && S_ISLNK (s.st_mode))
 431         return TRUE;
 432     }
 433
 434   if (test & (G_FILE_TEST_IS_REGULAR |
 435               G_FILE_TEST_IS_DIR |
 436               G_FILE_TEST_IS_EXECUTABLE))
 437     {
 438       struct stat s;
 439
 440       if (stat (filename, &s) == 0)
 441         {
 442           if ((test & G_FILE_TEST_IS_REGULAR) && S_ISREG (s.st_mode))
 443             return TRUE;
 444
 445           if ((test & G_FILE_TEST_IS_DIR) && S_ISDIR (s.st_mode))
 446             return TRUE;
 447
 448           /* The extra test for root when access (file, X_OK) succeeds.
 449            */
 450           if ((test & G_FILE_TEST_IS_EXECUTABLE) &&
 451               ((s.st_mode & S_IXOTH) ||
 452                (s.st_mode & S_IXUSR) ||
 453                (s.st_mode & S_IXGRP)))
 454             return TRUE;
 455         }
 456     }
 457
 458   return FALSE;
 459 #endif
 460 }
 461
 462 G_DEFINE_QUARK (g-file-error-quark, g_file_error)
 463
 464 /**
 465  * g_file_error_from_errno:
 466  * @err_no: an "errno" value
 467  *
 468  * Gets a #GFileError constant based on the passed-in @err_no.
 469  * For example, if you pass in <literal>EEXIST</literal> this function returns
 470  * #G_FILE_ERROR_EXIST. Unlike <literal>errno</literal> values, you can portably
 471  * assume that all #GFileError values will exist.
 472  *
 473  * Normally a #GFileError value goes into a #GError returned
 474  * from a function that manipulates files. So you would use
 475  * g_file_error_from_errno() when constructing a #GError.
 476  *
 477  * Return value: #GFileError corresponding to the given @errno
 478  **/
 479 GFileError
 480 g_file_error_from_errno (gint err_no)
 481 {
 482   switch (err_no)
 483     {
 484 #ifdef EEXIST
 485     case EEXIST:
 486       return G_FILE_ERROR_EXIST;
 487       break;
 488 #endif
 489
 490 #ifdef EISDIR
 491     case EISDIR:
 492       return G_FILE_ERROR_ISDIR;
 493       break;
 494 #endif
 495
 496 #ifdef EACCES
 497     case EACCES:
 498       return G_FILE_ERROR_ACCES;
 499       break;
 500 #endif
 501
 502 #ifdef ENAMETOOLONG
 503     case ENAMETOOLONG:
 504       return G_FILE_ERROR_NAMETOOLONG;
 505       break;
 506 #endif
 507
 508 #ifdef ENOENT
 509     case ENOENT:
 510       return G_FILE_ERROR_NOENT;
 511       break;
 512 #endif
 513
 514 #ifdef ENOTDIR
 515     case ENOTDIR:
 516       return G_FILE_ERROR_NOTDIR;
 517       break;
 518 #endif
 519
 520 #ifdef ENXIO
 521     case ENXIO:
 522       return G_FILE_ERROR_NXIO;
 523       break;
 524 #endif
 525
 526 #ifdef ENODEV
 527     case ENODEV:
 528       return G_FILE_ERROR_NODEV;
 529       break;
 530 #endif
 531
 532 #ifdef EROFS
 533     case EROFS:
 534       return G_FILE_ERROR_ROFS;
 535       break;
 536 #endif
 537
 538 #ifdef ETXTBSY
 539     case ETXTBSY:
 540       return G_FILE_ERROR_TXTBSY;
 541       break;
 542 #endif
 543
 544 #ifdef EFAULT
 545     case EFAULT:
 546       return G_FILE_ERROR_FAULT;
 547       break;
 548 #endif
 549
 550 #ifdef ELOOP
 551     case ELOOP:
 552       return G_FILE_ERROR_LOOP;
 553       break;
 554 #endif
 555
 556 #ifdef ENOSPC
 557     case ENOSPC:
 558       return G_FILE_ERROR_NOSPC;
 559       break;
 560 #endif
 561
 562 #ifdef ENOMEM
 563     case ENOMEM:
 564       return G_FILE_ERROR_NOMEM;
 565       break;
 566 #endif
 567
 568 #ifdef EMFILE
 569     case EMFILE:
 570       return G_FILE_ERROR_MFILE;
 571       break;
 572 #endif
 573
 574 #ifdef ENFILE
 575     case ENFILE:
 576       return G_FILE_ERROR_NFILE;
 577       break;
 578 #endif
 579
 580 #ifdef EBADF
 581     case EBADF:
 582       return G_FILE_ERROR_BADF;
 583       break;
 584 #endif
 585
 586 #ifdef EINVAL
 587     case EINVAL:
 588       return G_FILE_ERROR_INVAL;
 589       break;
 590 #endif
 591
 592 #ifdef EPIPE
 593     case EPIPE:
 594       return G_FILE_ERROR_PIPE;
 595       break;
 596 #endif
 597
 598 #ifdef EAGAIN
 599     case EAGAIN:
 600       return G_FILE_ERROR_AGAIN;
 601       break;
 602 #endif
 603
 604 #ifdef EINTR
 605     case EINTR:
 606       return G_FILE_ERROR_INTR;
 607       break;
 608 #endif
 609
 610 #ifdef EIO
 611     case EIO:
 612       return G_FILE_ERROR_IO;
 613       break;
 614 #endif
 615
 616 #ifdef EPERM
 617     case EPERM:
 618       return G_FILE_ERROR_PERM;
 619       break;
 620 #endif
 621
 622 #ifdef ENOSYS
 623     case ENOSYS:
 624       return G_FILE_ERROR_NOSYS;
 625       break;
 626 #endif
 627
 628     default:
 629       return G_FILE_ERROR_FAILED;
 630       break;
 631     }
 632 }
 633
 634 static gboolean
 635 get_contents_stdio (const gchar  *display_filename,
 636                     FILE         *f,
 637                     gchar       **contents,
 638                     gsize        *length,
 639                     GError      **error)
 640 {
 641   gchar buf[4096];
 642   gsize bytes;
 643   gchar *str = NULL;
 644   gsize total_bytes = 0;
 645   gsize total_allocated = 0;
 646   gchar *tmp;
 647
 648   g_assert (f != NULL);
 649
 650   while (!feof (f))
 651     {
 652       gint save_errno;
 653
 654       bytes = fread (buf, 1, sizeof (buf), f);
 655       save_errno = errno;
 656
 657       while ((total_bytes + bytes + 1) > total_allocated)
 658         {
 659           if (str)
 660             total_allocated *= 2;
 661           else
 662             total_allocated = MIN (bytes + 1, sizeof (buf));
 663
 664           tmp = g_try_realloc (str, total_allocated);
 665
 666           if (tmp == NULL)
 667             {
 668               g_set_error (error,
 669                            G_FILE_ERROR,
 670                            G_FILE_ERROR_NOMEM,
 671                            g_dngettext (GETTEXT_PACKAGE, "Could not allocate %lu byte to read file \"%s\"", "Could not allocate %lu bytes to read file \"%s\"", (gulong)total_allocated),
 672                            (gulong) total_allocated,
 673                            display_filename);
 674
 675               goto error;
 676             }
 677
 678           str = tmp;
 679         }
 680
 681       if (ferror (f))
 682         {
 683           g_set_error (error,
 684                        G_FILE_ERROR,
 685                        g_file_error_from_errno (save_errno),
 686                        _("Error reading file '%s': %s"),
 687                        display_filename,
 688                        g_strerror (save_errno));
 689
 690           goto error;
 691         }
 692
 693       memcpy (str + total_bytes, buf, bytes);
 694
 695       if (total_bytes + bytes < total_bytes)
 696         {
 697           g_set_error (error,
 698                        G_FILE_ERROR,
 699                        G_FILE_ERROR_FAILED,
 700                        _("File \"%s\" is too large"),
 701                        display_filename);
 702
 703           goto error;
 704         }
 705
 706       total_bytes += bytes;
 707     }
 708
 709   fclose (f);
 710
 711   if (total_allocated == 0)
 712     {
 713       str = g_new (gchar, 1);
 714       total_bytes = 0;
 715     }
 716
 717   str[total_bytes] = '\0';
 718
 719   if (length)
 720     *length = total_bytes;
 721
 722   *contents = str;
 723
 724   return TRUE;
 725
 726  error:
 727
 728   g_free (str);
 729   fclose (f);
 730
 731   return FALSE;
 732 }
 733
 734 #ifndef G_OS_WIN32
 735
 736 static gboolean
 737 get_contents_regfile (const gchar  *display_filename,
 738                       struct stat  *stat_buf,
 739                       gint          fd,
 740                       gchar       **contents,
 741                       gsize        *length,
 742                       GError      **error)
 743 {
 744   gchar *buf;
 745   gsize bytes_read;
 746   gsize size;
 747   gsize alloc_size;
 748
 749   size = stat_buf->st_size;
 750
 751   alloc_size = size + 1;
 752   buf = g_try_malloc (alloc_size);
 753
 754   if (buf == NULL)
 755     {
 756       g_set_error (error,
 757                    G_FILE_ERROR,
 758                    G_FILE_ERROR_NOMEM,
 759                            g_dngettext (GETTEXT_PACKAGE, "Could not allocate %lu byte to read file \"%s\"", "Could not allocate %lu bytes to read file \"%s\"", (gulong)alloc_size),
 760                    (gulong) alloc_size,
 761                    display_filename);
 762
 763       goto error;
 764     }
 765
 766   bytes_read = 0;
 767   while (bytes_read < size)
 768     {
 769       gssize rc;
 770
 771       rc = read (fd, buf + bytes_read, size - bytes_read);
 772
 773       if (rc < 0)
 774         {
 775           if (errno != EINTR)
 776             {
 777               int save_errno = errno;
 778
 779               g_free (buf);
 780               g_set_error (error,
 781                            G_FILE_ERROR,
 782                            g_file_error_from_errno (save_errno),
 783                            _("Failed to read from file '%s': %s"),
 784                            display_filename,
 785                            g_strerror (save_errno));
 786
 787               goto error;
 788             }
 789         }
 790       else if (rc == 0)
 791         break;
 792       else
 793         bytes_read += rc;
 794     }
 795
 796   buf[bytes_read] = '\0';
 797
 798   if (length)
 799     *length = bytes_read;
 800
 801   *contents = buf;
 802
 803   close (fd);
 804
 805   return TRUE;
 806
 807  error:
 808
 809   close (fd);
 810
 811   return FALSE;
 812 }
 813
 814 static gboolean
 815 get_contents_posix (const gchar  *filename,
 816                     gchar       **contents,
 817                     gsize        *length,
 818                     GError      **error)
 819 {
 820   struct stat stat_buf;
 821   gint fd;
 822   gchar *display_filename = g_filename_display_name (filename);
 823
 824   /* O_BINARY useful on Cygwin */
 825   fd = open (filename, O_RDONLY|O_BINARY);
 826
 827   if (fd < 0)
 828     {
 829       int save_errno = errno;
 830
 831       g_set_error (error,
 832                    G_FILE_ERROR,
 833                    g_file_error_from_errno (save_errno),
 834                    _("Failed to open file '%s': %s"),
 835                    display_filename,
 836                    g_strerror (save_errno));
 837       g_free (display_filename);
 838
 839       return FALSE;
 840     }
 841
 842   /* I don't think this will ever fail, aside from ENOMEM, but. */
 843   if (fstat (fd, &stat_buf) < 0)
 844     {
 845       int save_errno = errno;
 846
 847       close (fd);
 848       g_set_error (error,
 849                    G_FILE_ERROR,
 850                    g_file_error_from_errno (save_errno),
 851                    _("Failed to get attributes of file '%s': fstat() failed: %s"),
 852                    display_filename,
 853                    g_strerror (save_errno));
 854       g_free (display_filename);
 855
 856       return FALSE;
 857     }
 858
 859   if (stat_buf.st_size > 0 && S_ISREG (stat_buf.st_mode))
 860     {
 861       gboolean retval = get_contents_regfile (display_filename,
 862                                               &stat_buf,
 863                                               fd,
 864                                               contents,
 865                                               length,
 866                                               error);
 867       g_free (display_filename);
 868
 869       return retval;
 870     }
 871   else
 872     {
 873       FILE *f;
 874       gboolean retval;
 875
 876       f = fdopen (fd, "r");
 877
 878       if (f == NULL)
 879         {
 880           int save_errno = errno;
 881
 882           g_set_error (error,
 883                        G_FILE_ERROR,
 884                        g_file_error_from_errno (save_errno),
 885                        _("Failed to open file '%s': fdopen() failed: %s"),
 886                        display_filename,
 887                        g_strerror (save_errno));
 888           g_free (display_filename);
 889
 890           return FALSE;
 891         }
 892
 893       retval = get_contents_stdio (display_filename, f, contents, length, error);
 894       g_free (display_filename);
 895
 896       return retval;
 897     }
 898 }
 899
 900 #else  /* G_OS_WIN32 */
 901
 902 static gboolean
 903 get_contents_win32 (const gchar  *filename,
 904                     gchar       **contents,
 905                     gsize        *length,
 906                     GError      **error)
 907 {
 908   FILE *f;
 909   gboolean retval;
 910   gchar *display_filename = g_filename_display_name (filename);
 911   int save_errno;
 912
 913   f = g_fopen (filename, "rb");
 914   save_errno = errno;
 915
 916   if (f == NULL)
 917     {
 918       g_set_error (error,
 919                    G_FILE_ERROR,
 920                    g_file_error_from_errno (save_errno),
 921                    _("Failed to open file '%s': %s"),
 922                    display_filename,
 923                    g_strerror (save_errno));
 924       g_free (display_filename);
 925
 926       return FALSE;
 927     }
 928
 929   retval = get_contents_stdio (display_filename, f, contents, length, error);
 930   g_free (display_filename);
 931
 932   return retval;
 933 }
 934
 935 #endif
 936
 937 /**
 938  * g_file_get_contents:
 939  * @filename: (type filename): name of a file to read contents from, in the GLib file name encoding
 940  * @contents: (out) (array length=length) (element-type guint8): location to store an allocated string, use g_free() to free
 941  *     the returned string
 942  * @length: (allow-none): location to store length in bytes of the contents, or %NULL
 943  * @error: return location for a #GError, or %NULL
 944  *
 945  * Reads an entire file into allocated memory, with good error
 946  * checking.
 947  *
 948  * If the call was successful, it returns %TRUE and sets @contents to the file
 949  * contents and @length to the length of the file contents in bytes. The string
 950  * stored in @contents will be nul-terminated, so for text files you can pass
 951  * %NULL for the @length argument. If the call was not successful, it returns
 952  * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
 953  * codes are those in the #GFileError enumeration. In the error case,
 954  * @contents is set to %NULL and @length is set to zero.
 955  *
 956  * Return value: %TRUE on success, %FALSE if an error occurred
 957  **/
 958 gboolean
 959 g_file_get_contents (const gchar  *filename,
 960                      gchar       **contents,
 961                      gsize        *length,
 962                      GError      **error)
 963 {
 964   g_return_val_if_fail (filename != NULL, FALSE);
 965   g_return_val_if_fail (contents != NULL, FALSE);
 966
 967   *contents = NULL;
 968   if (length)
 969     *length = 0;
 970
 971 #ifdef G_OS_WIN32
 972   return get_contents_win32 (filename, contents, length, error);
 973 #else
 974   return get_contents_posix (filename, contents, length, error);
 975 #endif
 976 }
 977
 978 static gboolean
 979 rename_file (const char  *old_name,
 980              const char  *new_name,
 981              GError     **err)
 982 {
 983   errno = 0;
 984   if (g_rename (old_name, new_name) == -1)
 985     {
 986       int save_errno = errno;
 987       gchar *display_old_name = g_filename_display_name (old_name);
 988       gchar *display_new_name = g_filename_display_name (new_name);
 989
 990       g_set_error (err,
 991                    G_FILE_ERROR,
 992                    g_file_error_from_errno (save_errno),
 993                    _("Failed to rename file '%s' to '%s': g_rename() failed: %s"),
 994                    display_old_name,
 995                    display_new_name,
 996                    g_strerror (save_errno));
 997
 998       g_free (display_old_name);
 999       g_free (display_new_name);
1000
1001       return FALSE;
1002     }
1003
1004   return TRUE;
1005 }
1006
1007 static char *
1008 format_error_message (const gchar  *filename,
1009                       const gchar  *format_string) G_GNUC_FORMAT(2);
1010
1011 #pragma GCC diagnostic push
1012 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
1013
1014 static char *
1015 format_error_message (const gchar  *filename,
1016                       const gchar  *format_string)
1017 {
1018   gint saved_errno = errno;
1019   gchar *display_name;
1020   gchar *msg;
1021
1022   display_name = g_filename_display_name (filename);
1023   msg = g_strdup_printf (format_string, display_name, g_strerror (saved_errno));
1024   g_free (display_name);
1025
1026   return msg;
1027 }
1028
1029 #pragma GCC diagnostic pop
1030
1031 /* format string must have two '%s':
1032  *
1033  *   - the place for the filename
1034  *   - the place for the strerror
1035  */
1036 static void
1037 set_file_error (GError      **error,
1038                 const gchar  *filename,
1039                 const gchar  *format_string)
1040
1041 {
1042   int saved_errno = errno;
1043   char *msg = format_error_message (filename, format_string);
1044
1045   g_set_error_literal (error, G_FILE_ERROR, g_file_error_from_errno (saved_errno),
1046                        msg);
1047   g_free (msg);
1048 }
1049
1050 static gchar *
1051 write_to_temp_file (const gchar  *contents,
1052                     gssize        length,
1053                     const gchar  *dest_file,
1054                     GError      **err)
1055 {
1056   gchar *tmp_name;
1057   gchar *retval;
1058   gint fd;
1059
1060   retval = NULL;
1061
1062   tmp_name = g_strdup_printf ("%s.XXXXXX", dest_file);
1063
1064   errno = 0;
1065   fd = g_mkstemp_full (tmp_name, O_RDWR | O_BINARY, 0666);
1066
1067   if (fd == -1)
1068     {
1069       set_file_error (err, tmp_name, _("Failed to create file '%s': %s"));
1070       goto out;
1071     }
1072
1073 #ifdef HAVE_FALLOCATE
1074   if (length > 0)
1075     {
1076       /* We do this on a 'best effort' basis... It may not be supported
1077        * on the underlying filesystem.
1078        */
1079       (void) fallocate (fd, 0, 0, length);
1080     }
1081 #endif
1082   while (length > 0)
1083     {
1084       gssize s;
1085
1086       s = write (fd, contents, length);
1087
1088       if (s < 0)
1089         {
1090           if (errno == EINTR)
1091             continue;
1092
1093           set_file_error (err, tmp_name, _("Failed to write file '%s': write() failed: %s"));
1094           close (fd);
1095           g_unlink (tmp_name);
1096
1097           goto out;
1098         }
1099
1100       g_assert (s <= length);
1101
1102       contents += s;
1103       length -= s;
1104     }
1105
1106 #ifdef BTRFS_SUPER_MAGIC
1107   {
1108     struct statfs buf;
1109
1110     /* On Linux, on btrfs, skip the fsync since rename-over-existing is
1111      * guaranteed to be atomic and this is the only case in which we
1112      * would fsync() anyway.
1113      */
1114
1115     if (fstatfs (fd, &buf) == 0 && buf.f_type == BTRFS_SUPER_MAGIC)
1116       goto no_fsync;
1117   }
1118 #endif
1119
1120 #ifdef HAVE_FSYNC
1121   {
1122     struct stat statbuf;
1123
1124     errno = 0;
1125     /* If the final destination exists and is > 0 bytes, we want to sync the
1126      * newly written file to ensure the data is on disk when we rename over
1127      * the destination. Otherwise if we get a system crash we can lose both
1128      * the new and the old file on some filesystems. (I.E. those that don't
1129      * guarantee the data is written to the disk before the metadata.)
1130      */
1131     if (g_lstat (dest_file, &statbuf) == 0 && statbuf.st_size > 0 && fsync (fd) != 0)
1132       {
1133         set_file_error (err, tmp_name, _("Failed to write file '%s': fsync() failed: %s"));
1134         close (fd);
1135         g_unlink (tmp_name);
1136
1137         goto out;
1138       }
1139   }
1140 #endif
1141
1142 #ifdef BTRFS_SUPER_MAGIC
1143  no_fsync:
1144 #endif
1145
1146   errno = 0;
1147   if (!g_close (fd, err))
1148     {
1149       g_unlink (tmp_name);
1150
1151       goto out;
1152     }
1153
1154   retval = g_strdup (tmp_name);
1155
1156  out:
1157   g_free (tmp_name);
1158
1159   return retval;
1160 }
1161
1162 /**
1163  * g_file_set_contents:
1164  * @filename: (type filename): name of a file to write @contents to, in the GLib file name
1165  *   encoding
1166  * @contents: (array length=length) (element-type guint8): string to write to the file
1167  * @length: length of @contents, or -1 if @contents is a nul-terminated string
1168  * @error: return location for a #GError, or %NULL
1169  *
1170  * Writes all of @contents to a file named @filename, with good error checking.
1171  * If a file called @filename already exists it will be overwritten.
1172  *
1173  * This write is atomic in the sense that it is first written to a temporary
1174  * file which is then renamed to the final name. Notes:
1175  * <itemizedlist>
1176  * <listitem>
1177  *    On Unix, if @filename already exists hard links to @filename will break.
1178  *    Also since the file is recreated, existing permissions, access control
1179  *    lists, metadata etc. may be lost. If @filename is a symbolic link,
1180  *    the link itself will be replaced, not the linked file.
1181  * </listitem>
1182  * <listitem>
1183  *   On Windows renaming a file will not remove an existing file with the
1184  *   new name, so on Windows there is a race condition between the existing
1185  *   file being removed and the temporary file being renamed.
1186  * </listitem>
1187  * <listitem>
1188  *   On Windows there is no way to remove a file that is open to some
1189  *   process, or mapped into memory. Thus, this function will fail if
1190  *   @filename already exists and is open.
1191  * </listitem>
1192  * </itemizedlist>
1193  *
1194  * If the call was successful, it returns %TRUE. If the call was not successful,
1195  * it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
1196  * Possible error codes are those in the #GFileError enumeration.
1197  *
1198  * Note that the name for the temporary file is constructed by appending up
1199  * to 7 characters to @filename.
1200  *
1201  * Return value: %TRUE on success, %FALSE if an error occurred
1202  *
1203  * Since: 2.8
1204  **/
1205 gboolean
1206 g_file_set_contents (const gchar  *filename,
1207                      const gchar  *contents,
1208                      gssize        length,
1209                      GError      **error)
1210 {
1211   gchar *tmp_filename;
1212   gboolean retval;
1213   GError *rename_error = NULL;
1214
1215   g_return_val_if_fail (filename != NULL, FALSE);
1216   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1217   g_return_val_if_fail (contents != NULL || length == 0, FALSE);
1218   g_return_val_if_fail (length >= -1, FALSE);
1219
1220   if (length == -1)
1221     length = strlen (contents);
1222
1223   tmp_filename = write_to_temp_file (contents, length, filename, error);
1224
1225   if (!tmp_filename)
1226     {
1227       retval = FALSE;
1228       goto out;
1229     }
1230
1231   if (!rename_file (tmp_filename, filename, &rename_error))
1232     {
1233 #ifndef G_OS_WIN32
1234
1235       g_unlink (tmp_filename);
1236       g_propagate_error (error, rename_error);
1237       retval = FALSE;
1238       goto out;
1239
1240 #else /* G_OS_WIN32 */
1241
1242       /* Renaming failed, but on Windows this may just mean
1243        * the file already exists. So if the target file
1244        * exists, try deleting it and do the rename again.
1245        */
1246       if (!g_file_test (filename, G_FILE_TEST_EXISTS))
1247         {
1248           g_unlink (tmp_filename);
1249           g_propagate_error (error, rename_error);
1250           retval = FALSE;
1251           goto out;
1252         }
1253
1254       g_error_free (rename_error);
1255
1256       if (g_unlink (filename) == -1)
1257         {
1258           gchar *display_filename = g_filename_display_name (filename);
1259
1260           int save_errno = errno;
1261
1262           g_set_error (error,
1263                        G_FILE_ERROR,
1264                        g_file_error_from_errno (save_errno),
1265                        _("Existing file '%s' could not be removed: g_unlink() failed: %s"),
1266                        display_filename,
1267                        g_strerror (save_errno));
1268
1269           g_free (display_filename);
1270           g_unlink (tmp_filename);
1271           retval = FALSE;
1272           goto out;
1273         }
1274
1275       if (!rename_file (tmp_filename, filename, error))
1276         {
1277           g_unlink (tmp_filename);
1278           retval = FALSE;
1279           goto out;
1280         }
1281
1282 #endif
1283     }
1284
1285   retval = TRUE;
1286
1287  out:
1288   g_free (tmp_filename);
1289   return retval;
1290 }
1291
1292 /*
1293  * get_tmp_file based on the mkstemp implementation from the GNU C library.
1294  * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
1295  */
1296 typedef gint (*GTmpFileCallback) (const gchar *, gint, gint);
1297
1298 static gint
1299 get_tmp_file (gchar            *tmpl,
1300               GTmpFileCallback  f,
1301               int               flags,
1302               int               mode)
1303 {
1304   char *XXXXXX;
1305   int count, fd;
1306   static const char letters[] =
1307     "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1308   static const int NLETTERS = sizeof (letters) - 1;
1309   glong value;
1310   GTimeVal tv;
1311   static int counter = 0;
1312
1313   g_return_val_if_fail (tmpl != NULL, -1);
1314
1315   /* find the last occurrence of "XXXXXX" */
1316   XXXXXX = g_strrstr (tmpl, "XXXXXX");
1317
1318   if (!XXXXXX || strncmp (XXXXXX, "XXXXXX", 6))
1319     {
1320       errno = EINVAL;
1321       return -1;
1322     }
1323
1324   /* Get some more or less random data.  */
1325   g_get_current_time (&tv);
1326   value = (tv.tv_usec ^ tv.tv_sec) + counter++;
1327
1328   for (count = 0; count < 100; value += 7777, ++count)
1329     {
1330       glong v = value;
1331
1332       /* Fill in the random bits.  */
1333       XXXXXX[0] = letters[v % NLETTERS];
1334       v /= NLETTERS;
1335       XXXXXX[1] = letters[v % NLETTERS];
1336       v /= NLETTERS;
1337       XXXXXX[2] = letters[v % NLETTERS];
1338       v /= NLETTERS;
1339       XXXXXX[3] = letters[v % NLETTERS];
1340       v /= NLETTERS;
1341       XXXXXX[4] = letters[v % NLETTERS];
1342       v /= NLETTERS;
1343       XXXXXX[5] = letters[v % NLETTERS];
1344
1345       fd = f (tmpl, flags, mode);
1346
1347       if (fd >= 0)
1348         return fd;
1349       else if (errno != EEXIST)
1350         /* Any other error will apply also to other names we might
1351          *  try, and there are 2^32 or so of them, so give up now.
1352          */
1353         return -1;
1354     }
1355
1356   /* We got out of the loop because we ran out of combinations to try.  */
1357   errno = EEXIST;
1358   return -1;
1359 }
1360
1361 /* Some GTmpFileCallback implementations.
1362  *
1363  * Note: we cannot use open() or g_open() directly because even though
1364  * they appear compatible, they may be vararg functions and calling
1365  * varargs functions through a non-varargs type is undefined.
1366  */
1367 static gint
1368 wrap_g_mkdir (const gchar *filename,
1369               int          flags G_GNUC_UNUSED,
1370               int          mode)
1371 {
1372   /* tmpl is in UTF-8 on Windows, thus use g_mkdir() */
1373   return g_mkdir (filename, mode);
1374 }
1375
1376 static gint
1377 wrap_g_open (const gchar *filename,
1378                 int          flags,
1379                 int          mode)
1380 {
1381   return g_open (filename, flags, mode);
1382 }
1383
1384 /**
1385  * g_mkdtemp_full:
1386  * @tmpl: (type filename): template directory name
1387  * @mode: permissions to create the temporary directory with
1388  *
1389  * Creates a temporary directory. See the mkdtemp() documentation
1390  * on most UNIX-like systems.
1391  *
1392  * The parameter is a string that should follow the rules for
1393  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1394  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1395  * sequence does not have to occur at the very end of the template
1396  * and you can pass a @mode. The X string will be modified to form
1397  * the name of a directory that didn't exist. The string should be
1398  * in the GLib file name encoding. Most importantly, on Windows it
1399  * should be in UTF-8.
1400  *
1401  * Return value: A pointer to @tmpl, which has been modified
1402  *     to hold the directory name. In case of errors, %NULL is
1403  *     returned, and %errno will be set.
1404  *
1405  * Since: 2.30
1406  */
1407 gchar *
1408 g_mkdtemp_full (gchar *tmpl,
1409                 gint   mode)
1410 {
1411   if (get_tmp_file (tmpl, wrap_g_mkdir, 0, mode) == -1)
1412     return NULL;
1413   else
1414     return tmpl;
1415 }
1416
1417 /**
1418  * g_mkdtemp:
1419  * @tmpl: (type filename): template directory name
1420  *
1421  * Creates a temporary directory. See the mkdtemp() documentation
1422  * on most UNIX-like systems.
1423  *
1424  * The parameter is a string that should follow the rules for
1425  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1426  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1427  * sequence does not have to occur at the very end of the template
1428  * and you can pass a @mode and additional @flags. The X string will
1429  * be modified to form the name of a directory that didn't exist.
1430  * The string should be in the GLib file name encoding. Most importantly,
1431  * on Windows it should be in UTF-8.
1432  *
1433  * Return value: A pointer to @tmpl, which has been modified
1434  *     to hold the directory name.  In case of errors, %NULL is
1435  *     returned and %errno will be set.
1436  *
1437  * Since: 2.30
1438  */
1439 gchar *
1440 g_mkdtemp (gchar *tmpl)
1441 {
1442   return g_mkdtemp_full (tmpl, 0700);
1443 }
1444
1445 /**
1446  * g_mkstemp_full:
1447  * @tmpl: (type filename): template filename
1448  * @flags: flags to pass to an open() call in addition to O_EXCL
1449  *     and O_CREAT, which are passed automatically
1450  * @mode: permissions to create the temporary file with
1451  *
1452  * Opens a temporary file. See the mkstemp() documentation
1453  * on most UNIX-like systems.
1454  *
1455  * The parameter is a string that should follow the rules for
1456  * mkstemp() templates, i.e. contain the string "XXXXXX".
1457  * g_mkstemp_full() is slightly more flexible than mkstemp()
1458  * in that the sequence does not have to occur at the very end of the
1459  * template and you can pass a @mode and additional @flags. The X
1460  * string will be modified to form the name of a file that didn't exist.
1461  * The string should be in the GLib file name encoding. Most importantly,
1462  * on Windows it should be in UTF-8.
1463  *
1464  * Return value: A file handle (as from open()) to the file
1465  *     opened for reading and writing. The file handle should be
1466  *     closed with close(). In case of errors, -1 is returned
1467  *     and %errno will be set.
1468  *
1469  * Since: 2.22
1470  */
1471 gint
1472 g_mkstemp_full (gchar *tmpl,
1473                 gint   flags,
1474                 gint   mode)
1475 {
1476   /* tmpl is in UTF-8 on Windows, thus use g_open() */
1477   return get_tmp_file (tmpl, wrap_g_open,
1478                        flags | O_CREAT | O_EXCL, mode);
1479 }
1480
1481 /**
1482  * g_mkstemp:
1483  * @tmpl: (type filename): template filename
1484  *
1485  * Opens a temporary file. See the mkstemp() documentation
1486  * on most UNIX-like systems.
1487  *
1488  * The parameter is a string that should follow the rules for
1489  * mkstemp() templates, i.e. contain the string "XXXXXX".
1490  * g_mkstemp() is slightly more flexible than mkstemp() in that the
1491  * sequence does not have to occur at the very end of the template.
1492  * The X string will be modified to form the name of a file that
1493  * didn't exist. The string should be in the GLib file name encoding.
1494  * Most importantly, on Windows it should be in UTF-8.
1495  *
1496  * Return value: A file handle (as from open()) to the file
1497  *     opened for reading and writing. The file is opened in binary
1498  *     mode on platforms where there is a difference. The file handle
1499  *     should be closed with close(). In case of errors, -1 is
1500  *     returned and %errno will be set.
1501  */
1502 gint
1503 g_mkstemp (gchar *tmpl)
1504 {
1505   return g_mkstemp_full (tmpl, O_RDWR | O_BINARY, 0600);
1506 }
1507
1508 static gint
1509 g_get_tmp_name (const gchar      *tmpl,
1510                 gchar           **name_used,
1511                 GTmpFileCallback  f,
1512                 gint              flags,
1513                 gint              mode,
1514                 GError          **error)
1515 {
1516   int retval;
1517   const char *tmpdir;
1518   const char *sep;
1519   char *fulltemplate;
1520   const char *slash;
1521
1522   if (tmpl == NULL)
1523     tmpl = ".XXXXXX";
1524
1525   if ((slash = strchr (tmpl, G_DIR_SEPARATOR)) != NULL
1526 #ifdef G_OS_WIN32
1527       || (strchr (tmpl, '/') != NULL && (slash = "/"))
1528 #endif
1529       )
1530     {
1531       gchar *display_tmpl = g_filename_display_name (tmpl);
1532       char c[2];
1533       c[0] = *slash;
1534       c[1] = '\0';
1535
1536       g_set_error (error,
1537                    G_FILE_ERROR,
1538                    G_FILE_ERROR_FAILED,
1539                    _("Template '%s' invalid, should not contain a '%s'"),
1540                    display_tmpl, c);
1541       g_free (display_tmpl);
1542
1543       return -1;
1544     }
1545
1546   if (strstr (tmpl, "XXXXXX") == NULL)
1547     {
1548       gchar *display_tmpl = g_filename_display_name (tmpl);
1549       g_set_error (error,
1550                    G_FILE_ERROR,
1551                    G_FILE_ERROR_FAILED,
1552                    _("Template '%s' doesn't contain XXXXXX"),
1553                    display_tmpl);
1554       g_free (display_tmpl);
1555       return -1;
1556     }
1557
1558   tmpdir = g_get_tmp_dir ();
1559
1560   if (G_IS_DIR_SEPARATOR (tmpdir [strlen (tmpdir) - 1]))
1561     sep = "";
1562   else
1563     sep = G_DIR_SEPARATOR_S;
1564
1565   fulltemplate = g_strconcat (tmpdir, sep, tmpl, NULL);
1566
1567   retval = get_tmp_file (fulltemplate, f, flags, mode);
1568   if (retval == -1)
1569     {
1570       int save_errno = errno;
1571       gchar *display_fulltemplate = g_filename_display_name (fulltemplate);
1572
1573       g_set_error (error,
1574                    G_FILE_ERROR,
1575                    g_file_error_from_errno (save_errno),
1576                    _("Failed to create file '%s': %s"),
1577                    display_fulltemplate, g_strerror (save_errno));
1578       g_free (display_fulltemplate);
1579       g_free (fulltemplate);
1580       return -1;
1581     }
1582
1583   *name_used = fulltemplate;
1584
1585   return retval;
1586 }
1587
1588 /**
1589  * g_file_open_tmp:
1590  * @tmpl: (type filename) (allow-none): Template for file name, as in
1591  *     g_mkstemp(), basename only, or %NULL for a default template
1592  * @name_used: (out) (type filename): location to store actual name used,
1593  *     or %NULL
1594  * @error: return location for a #GError
1595  *
1596  * Opens a file for writing in the preferred directory for temporary
1597  * files (as returned by g_get_tmp_dir()).
1598  *
1599  * @tmpl should be a string in the GLib file name encoding containing
1600  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1601  * However, unlike these functions, the template should only be a
1602  * basename, no directory components are allowed. If template is
1603  * %NULL, a default template is used.
1604  *
1605  * Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
1606  * modified, and might thus be a read-only literal string.
1607  *
1608  * Upon success, and if @name_used is non-%NULL, the actual name used
1609  * is returned in @name_used. This string should be freed with g_free()
1610  * when not needed any longer. The returned name is in the GLib file
1611  * name encoding.
1612  *
1613  * Return value: A file handle (as from open()) to the file opened for
1614  *     reading and writing. The file is opened in binary mode on platforms
1615  *     where there is a difference. The file handle should be closed with
1616  *     close(). In case of errors, -1 is returned and @error will be set.
1617  */
1618 gint
1619 g_file_open_tmp (const gchar  *tmpl,
1620                  gchar       **name_used,
1621                  GError      **error)
1622 {
1623   gchar *fulltemplate;
1624   gint result;
1625
1626   result = g_get_tmp_name (tmpl, &fulltemplate,
1627                            wrap_g_open,
1628                            O_CREAT | O_EXCL | O_RDWR | O_BINARY,
1629                            0600,
1630                            error);
1631   if (result != -1)
1632     {
1633       if (name_used)
1634         *name_used = fulltemplate;
1635       else
1636         g_free (fulltemplate);
1637     }
1638
1639   return result;
1640 }
1641
1642 /**
1643  * g_dir_make_tmp:
1644  * @tmpl: (type filename) (allow-none): Template for directory name,
1645  *     as in g_mkdtemp(), basename only, or %NULL for a default template
1646  * @error: return location for a #GError
1647  *
1648  * Creates a subdirectory in the preferred directory for temporary
1649  * files (as returned by g_get_tmp_dir()).
1650  *
1651  * @tmpl should be a string in the GLib file name encoding containing
1652  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1653  * However, unlike these functions, the template should only be a
1654  * basename, no directory components are allowed. If template is
1655  * %NULL, a default template is used.
1656  *
1657  * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
1658  * modified, and might thus be a read-only literal string.
1659  *
1660  * Return value: (type filename): The actual name used. This string
1661  *     should be freed with g_free() when not needed any longer and is
1662  *     is in the GLib file name encoding. In case of errors, %NULL is
1663  *     returned and @error will be set.
1664  *
1665  * Since: 2.30
1666  */
1667 gchar *
1668 g_dir_make_tmp (const gchar  *tmpl,
1669                 GError      **error)
1670 {
1671   gchar *fulltemplate;
1672
1673   if (g_get_tmp_name (tmpl, &fulltemplate, wrap_g_mkdir, 0, 0700, error) == -1)
1674     return NULL;
1675   else
1676     return fulltemplate;
1677 }
1678
1679 static gchar *
1680 g_build_path_va (const gchar  *separator,
1681                  const gchar  *first_element,
1682                  va_list      *args,
1683                  gchar       **str_array)
1684 {
1685   GString *result;
1686   gint separator_len = strlen (separator);
1687   gboolean is_first = TRUE;
1688   gboolean have_leading = FALSE;
1689   const gchar *single_element = NULL;
1690   const gchar *next_element;
1691   const gchar *last_trailing = NULL;
1692   gint i = 0;
1693
1694   result = g_string_new (NULL);
1695
1696   if (str_array)
1697     next_element = str_array[i++];
1698   else
1699     next_element = first_element;
1700
1701   while (TRUE)
1702     {
1703       const gchar *element;
1704       const gchar *start;
1705       const gchar *end;
1706
1707       if (next_element)
1708         {
1709           element = next_element;
1710           if (str_array)
1711             next_element = str_array[i++];
1712           else
1713             next_element = va_arg (*args, gchar *);
1714         }
1715       else
1716         break;
1717
1718       /* Ignore empty elements */
1719       if (!*element)
1720         continue;
1721
1722       start = element;
1723
1724       if (separator_len)
1725         {
1726           while (strncmp (start, separator, separator_len) == 0)
1727             start += separator_len;
1728         }
1729
1730       end = start + strlen (start);
1731
1732       if (separator_len)
1733         {
1734           while (end >= start + separator_len &&
1735                  strncmp (end - separator_len, separator, separator_len) == 0)
1736             end -= separator_len;
1737
1738           last_trailing = end;
1739           while (last_trailing >= element + separator_len &&
1740                  strncmp (last_trailing - separator_len, separator, separator_len) == 0)
1741             last_trailing -= separator_len;
1742
1743           if (!have_leading)
1744             {
1745               /* If the leading and trailing separator strings are in the
1746                * same element and overlap, the result is exactly that element
1747                */
1748               if (last_trailing <= start)
1749                 single_element = element;
1750
1751               g_string_append_len (result, element, start - element);
1752               have_leading = TRUE;
1753             }
1754           else
1755             single_element = NULL;
1756         }
1757
1758       if (end == start)
1759         continue;
1760
1761       if (!is_first)
1762         g_string_append (result, separator);
1763
1764       g_string_append_len (result, start, end - start);
1765       is_first = FALSE;
1766     }
1767
1768   if (single_element)
1769     {
1770       g_string_free (result, TRUE);
1771       return g_strdup (single_element);
1772     }
1773   else
1774     {
1775       if (last_trailing)
1776         g_string_append (result, last_trailing);
1777
1778       return g_string_free (result, FALSE);
1779     }
1780 }
1781
1782 /**
1783  * g_build_pathv:
1784  * @separator: a string used to separator the elements of the path.
1785  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1786  *
1787  * Behaves exactly like g_build_path(), but takes the path elements
1788  * as a string array, instead of varargs. This function is mainly
1789  * meant for language bindings.
1790  *
1791  * Return value: a newly-allocated string that must be freed with g_free().
1792  *
1793  * Since: 2.8
1794  */
1795 gchar *
1796 g_build_pathv (const gchar  *separator,
1797                gchar       **args)
1798 {
1799   if (!args)
1800     return NULL;
1801
1802   return g_build_path_va (separator, NULL, NULL, args);
1803 }
1804
1805
1806 /**
1807  * g_build_path:
1808  * @separator: a string used to separator the elements of the path.
1809  * @first_element: the first element in the path
1810  * @...: remaining elements in path, terminated by %NULL
1811  *
1812  * Creates a path from a series of elements using @separator as the
1813  * separator between elements. At the boundary between two elements,
1814  * any trailing occurrences of separator in the first element, or
1815  * leading occurrences of separator in the second element are removed
1816  * and exactly one copy of the separator is inserted.
1817  *
1818  * Empty elements are ignored.
1819  *
1820  * The number of leading copies of the separator on the result is
1821  * the same as the number of leading copies of the separator on
1822  * the first non-empty element.
1823  *
1824  * The number of trailing copies of the separator on the result is
1825  * the same as the number of trailing copies of the separator on
1826  * the last non-empty element. (Determination of the number of
1827  * trailing copies is done without stripping leading copies, so
1828  * if the separator is <literal>ABA</literal>, <literal>ABABA</literal>
1829  * has 1 trailing copy.)
1830  *
1831  * However, if there is only a single non-empty element, and there
1832  * are no characters in that element not part of the leading or
1833  * trailing separators, then the result is exactly the original value
1834  * of that element.
1835  *
1836  * Other than for determination of the number of leading and trailing
1837  * copies of the separator, elements consisting only of copies
1838  * of the separator are ignored.
1839  *
1840  * Return value: a newly-allocated string that must be freed with g_free().
1841  **/
1842 gchar *
1843 g_build_path (const gchar *separator,
1844               const gchar *first_element,
1845               ...)
1846 {
1847   gchar *str;
1848   va_list args;
1849
1850   g_return_val_if_fail (separator != NULL, NULL);
1851
1852   va_start (args, first_element);
1853   str = g_build_path_va (separator, first_element, &args, NULL);
1854   va_end (args);
1855
1856   return str;
1857 }
1858
1859 #ifdef G_OS_WIN32
1860
1861 static gchar *
1862 g_build_pathname_va (const gchar  *first_element,
1863                      va_list      *args,
1864                      gchar       **str_array)
1865 {
1866   /* Code copied from g_build_pathv(), and modified to use two
1867    * alternative single-character separators.
1868    */
1869   GString *result;
1870   gboolean is_first = TRUE;
1871   gboolean have_leading = FALSE;
1872   const gchar *single_element = NULL;
1873   const gchar *next_element;
1874   const gchar *last_trailing = NULL;
1875   gchar current_separator = '\\';
1876   gint i = 0;
1877
1878   result = g_string_new (NULL);
1879
1880   if (str_array)
1881     next_element = str_array[i++];
1882   else
1883     next_element = first_element;
1884
1885   while (TRUE)
1886     {
1887       const gchar *element;
1888       const gchar *start;
1889       const gchar *end;
1890
1891       if (next_element)
1892         {
1893           element = next_element;
1894           if (str_array)
1895             next_element = str_array[i++];
1896           else
1897             next_element = va_arg (*args, gchar *);
1898         }
1899       else
1900         break;
1901
1902       /* Ignore empty elements */
1903       if (!*element)
1904         continue;
1905
1906       start = element;
1907
1908       if (TRUE)
1909         {
1910           while (start &&
1911                  (*start == '\\' || *start == '/'))
1912             {
1913               current_separator = *start;
1914               start++;
1915             }
1916         }
1917
1918       end = start + strlen (start);
1919
1920       if (TRUE)
1921         {
1922           while (end >= start + 1 &&
1923                  (end[-1] == '\\' || end[-1] == '/'))
1924             {
1925               current_separator = end[-1];
1926               end--;
1927             }
1928
1929           last_trailing = end;
1930           while (last_trailing >= element + 1 &&
1931                  (last_trailing[-1] == '\\' || last_trailing[-1] == '/'))
1932             last_trailing--;
1933
1934           if (!have_leading)
1935             {
1936               /* If the leading and trailing separator strings are in the
1937                * same element and overlap, the result is exactly that element
1938                */
1939               if (last_trailing <= start)
1940                 single_element = element;
1941
1942               g_string_append_len (result, element, start - element);
1943               have_leading = TRUE;
1944             }
1945           else
1946             single_element = NULL;
1947         }
1948
1949       if (end == start)
1950         continue;
1951
1952       if (!is_first)
1953         g_string_append_len (result, &current_separator, 1);
1954
1955       g_string_append_len (result, start, end - start);
1956       is_first = FALSE;
1957     }
1958
1959   if (single_element)
1960     {
1961       g_string_free (result, TRUE);
1962       return g_strdup (single_element);
1963     }
1964   else
1965     {
1966       if (last_trailing)
1967         g_string_append (result, last_trailing);
1968
1969       return g_string_free (result, FALSE);
1970     }
1971 }
1972
1973 #endif
1974
1975 /**
1976  * g_build_filenamev:
1977  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1978  *
1979  * Behaves exactly like g_build_filename(), but takes the path elements
1980  * as a string array, instead of varargs. This function is mainly
1981  * meant for language bindings.
1982  *
1983  * Return value: a newly-allocated string that must be freed with g_free().
1984  *
1985  * Since: 2.8
1986  */
1987 gchar *
1988 g_build_filenamev (gchar **args)
1989 {
1990   gchar *str;
1991
1992 #ifndef G_OS_WIN32
1993   str = g_build_path_va (G_DIR_SEPARATOR_S, NULL, NULL, args);
1994 #else
1995   str = g_build_pathname_va (NULL, NULL, args);
1996 #endif
1997
1998   return str;
1999 }
2000
2001 /**
2002  * g_build_filename:
2003  * @first_element: the first element in the path
2004  * @...: remaining elements in path, terminated by %NULL
2005  *
2006  * Creates a filename from a series of elements using the correct
2007  * separator for filenames.
2008  *
2009  * On Unix, this function behaves identically to <literal>g_build_path
2010  * (G_DIR_SEPARATOR_S, first_element, ....)</literal>.
2011  *
2012  * On Windows, it takes into account that either the backslash
2013  * (<literal>\</literal> or slash (<literal>/</literal>) can be used
2014  * as separator in filenames, but otherwise behaves as on Unix. When
2015  * file pathname separators need to be inserted, the one that last
2016  * previously occurred in the parameters (reading from left to right)
2017  * is used.
2018  *
2019  * No attempt is made to force the resulting filename to be an absolute
2020  * path. If the first element is a relative path, the result will
2021  * be a relative path.
2022  *
2023  * Return value: a newly-allocated string that must be freed with g_free().
2024  **/
2025 gchar *
2026 g_build_filename (const gchar *first_element,
2027                   ...)
2028 {
2029   gchar *str;
2030   va_list args;
2031
2032   va_start (args, first_element);
2033 #ifndef G_OS_WIN32
2034   str = g_build_path_va (G_DIR_SEPARATOR_S, first_element, &args, NULL);
2035 #else
2036   str = g_build_pathname_va (first_element, &args, NULL);
2037 #endif
2038   va_end (args);
2039
2040   return str;
2041 }
2042
2043 /**
2044  * g_file_read_link:
2045  * @filename: the symbolic link
2046  * @error: return location for a #GError
2047  *
2048  * Reads the contents of the symbolic link @filename like the POSIX
2049  * readlink() function.  The returned string is in the encoding used
2050  * for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
2051  *
2052  * Returns: A newly-allocated string with the contents of the symbolic link,
2053  *          or %NULL if an error occurred.
2054  *
2055  * Since: 2.4
2056  */
2057 gchar *
2058 g_file_read_link (const gchar  *filename,
2059                   GError      **error)
2060 {
2061 #ifdef HAVE_READLINK
2062   gchar *buffer;
2063   guint size;
2064   gint read_size;
2065
2066   size = 256;
2067   buffer = g_malloc (size);
2068
2069   while (TRUE)
2070     {
2071       read_size = readlink (filename, buffer, size);
2072       if (read_size < 0) {
2073         int save_errno = errno;
2074         gchar *display_filename = g_filename_display_name (filename);
2075
2076         g_free (buffer);
2077         g_set_error (error,
2078                      G_FILE_ERROR,
2079                      g_file_error_from_errno (save_errno),
2080                      _("Failed to read the symbolic link '%s': %s"),
2081                      display_filename,
2082                      g_strerror (save_errno));
2083         g_free (display_filename);
2084
2085         return NULL;
2086       }
2087
2088       if (read_size < size)
2089         {
2090           buffer[read_size] = 0;
2091           return buffer;
2092         }
2093
2094       size *= 2;
2095       buffer = g_realloc (buffer, size);
2096     }
2097 #else
2098   g_set_error_literal (error,
2099                        G_FILE_ERROR,
2100                        G_FILE_ERROR_INVAL,
2101                        _("Symbolic links not supported"));
2102
2103   return NULL;
2104 #endif
2105 }
2106
2107 /**
2108  * g_path_is_absolute:
2109  * @file_name: a file name
2110  *
2111  * Returns %TRUE if the given @file_name is an absolute file name.
2112  * Note that this is a somewhat vague concept on Windows.
2113  *
2114  * On POSIX systems, an absolute file name is well-defined. It always
2115  * starts from the single root directory. For example "/usr/local".
2116  *
2117  * On Windows, the concepts of current drive and drive-specific
2118  * current directory introduce vagueness. This function interprets as
2119  * an absolute file name one that either begins with a directory
2120  * separator such as "\Users\tml" or begins with the root on a drive,
2121  * for example "C:\Windows". The first case also includes UNC paths
2122  * such as "\\myserver\docs\foo". In all cases, either slashes or
2123  * backslashes are accepted.
2124  *
2125  * Note that a file name relative to the current drive root does not
2126  * truly specify a file uniquely over time and across processes, as
2127  * the current drive is a per-process value and can be changed.
2128  *
2129  * File names relative the current directory on some specific drive,
2130  * such as "D:foo/bar", are not interpreted as absolute by this
2131  * function, but they obviously are not relative to the normal current
2132  * directory as returned by getcwd() or g_get_current_dir()
2133  * either. Such paths should be avoided, or need to be handled using
2134  * Windows-specific code.
2135  *
2136  * Returns: %TRUE if @file_name is absolute
2137  */
2138 gboolean
2139 g_path_is_absolute (const gchar *file_name)
2140 {
2141   g_return_val_if_fail (file_name != NULL, FALSE);
2142
2143   if (G_IS_DIR_SEPARATOR (file_name[0]))
2144     return TRUE;
2145
2146 #ifdef G_OS_WIN32
2147   /* Recognize drive letter on native Windows */
2148   if (g_ascii_isalpha (file_name[0]) &&
2149       file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
2150     return TRUE;
2151 #endif
2152
2153   return FALSE;
2154 }
2155
2156 /**
2157  * g_path_skip_root:
2158  * @file_name: a file name
2159  *
2160  * Returns a pointer into @file_name after the root component,
2161  * i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name
2162  * is not an absolute path it returns %NULL.
2163  *
2164  * Returns: a pointer into @file_name after the root component
2165  */
2166 const gchar *
2167 g_path_skip_root (const gchar *file_name)
2168 {
2169   g_return_val_if_fail (file_name != NULL, NULL);
2170
2171 #ifdef G_PLATFORM_WIN32
2172   /* Skip \\server\share or //server/share */
2173   if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2174       G_IS_DIR_SEPARATOR (file_name[1]) &&
2175       file_name[2] &&
2176       !G_IS_DIR_SEPARATOR (file_name[2]))
2177     {
2178       gchar *p;
2179       p = strchr (file_name + 2, G_DIR_SEPARATOR);
2180
2181 #ifdef G_OS_WIN32
2182       {
2183         gchar *q;
2184
2185         q = strchr (file_name + 2, '/');
2186         if (p == NULL || (q != NULL && q < p))
2187         p = q;
2188       }
2189 #endif
2190
2191       if (p && p > file_name + 2 && p[1])
2192         {
2193           file_name = p + 1;
2194
2195           while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
2196             file_name++;
2197
2198           /* Possibly skip a backslash after the share name */
2199           if (G_IS_DIR_SEPARATOR (file_name[0]))
2200             file_name++;
2201
2202           return (gchar *)file_name;
2203         }
2204     }
2205 #endif
2206
2207   /* Skip initial slashes */
2208   if (G_IS_DIR_SEPARATOR (file_name[0]))
2209     {
2210       while (G_IS_DIR_SEPARATOR (file_name[0]))
2211         file_name++;
2212       return (gchar *)file_name;
2213     }
2214
2215 #ifdef G_OS_WIN32
2216   /* Skip X:\ */
2217   if (g_ascii_isalpha (file_name[0]) &&
2218       file_name[1] == ':' &&
2219       G_IS_DIR_SEPARATOR (file_name[2]))
2220     return (gchar *)file_name + 3;
2221 #endif
2222
2223   return NULL;
2224 }
2225
2226 /**
2227  * g_basename:
2228  * @file_name: the name of the file
2229  *
2230  * Gets the name of the file without any leading directory
2231  * components. It returns a pointer into the given file name
2232  * string.
2233  *
2234  * Return value: the name of the file without any leading
2235  *     directory components
2236  *
2237  * Deprecated:2.2: Use g_path_get_basename() instead, but notice
2238  *     that g_path_get_basename() allocates new memory for the
2239  *     returned string, unlike this function which returns a pointer
2240  *     into the argument.
2241  */
2242 const gchar *
2243 g_basename (const gchar *file_name)
2244 {
2245   gchar *base;
2246
2247   g_return_val_if_fail (file_name != NULL, NULL);
2248
2249   base = strrchr (file_name, G_DIR_SEPARATOR);
2250
2251 #ifdef G_OS_WIN32
2252   {
2253     gchar *q;
2254     q = strrchr (file_name, '/');
2255     if (base == NULL || (q != NULL && q > base))
2256       base = q;
2257   }
2258 #endif
2259
2260   if (base)
2261     return base + 1;
2262
2263 #ifdef G_OS_WIN32
2264   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2265     return (gchar*) file_name + 2;
2266 #endif
2267
2268   return (gchar*) file_name;
2269 }
2270
2271 /**
2272  * g_path_get_basename:
2273  * @file_name: the name of the file
2274  *
2275  * Gets the last component of the filename.
2276  *
2277  * If @file_name ends with a directory separator it gets the component
2278  * before the last slash. If @file_name consists only of directory
2279  * separators (and on Windows, possibly a drive letter), a single
2280  * separator is returned. If @file_name is empty, it gets ".".
2281  *
2282  * Return value: a newly allocated string containing the last
2283  *    component of the filename
2284  */
2285 gchar *
2286 g_path_get_basename (const gchar *file_name)
2287 {
2288   gssize base;
2289   gssize last_nonslash;
2290   gsize len;
2291   gchar *retval;
2292
2293   g_return_val_if_fail (file_name != NULL, NULL);
2294
2295   if (file_name[0] == '\0')
2296     return g_strdup (".");
2297
2298   last_nonslash = strlen (file_name) - 1;
2299
2300   while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
2301     last_nonslash--;
2302
2303   if (last_nonslash == -1)
2304     /* string only containing slashes */
2305     return g_strdup (G_DIR_SEPARATOR_S);
2306
2307 #ifdef G_OS_WIN32
2308   if (last_nonslash == 1 &&
2309       g_ascii_isalpha (file_name[0]) &&
2310       file_name[1] == ':')
2311     /* string only containing slashes and a drive */
2312     return g_strdup (G_DIR_SEPARATOR_S);
2313 #endif
2314   base = last_nonslash;
2315
2316   while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
2317     base--;
2318
2319 #ifdef G_OS_WIN32
2320   if (base == -1 &&
2321       g_ascii_isalpha (file_name[0]) &&
2322       file_name[1] == ':')
2323     base = 1;
2324 #endif /* G_OS_WIN32 */
2325
2326   len = last_nonslash - base;
2327   retval = g_malloc (len + 1);
2328   memcpy (retval, file_name + base + 1, len);
2329   retval [len] = '\0';
2330
2331   return retval;
2332 }
2333
2334 /**
2335  * g_dirname:
2336  * @file_name: the name of the file
2337  *
2338  * Gets the directory components of a file name.
2339  *
2340  * If the file name has no directory components "." is returned.
2341  * The returned string should be freed when no longer needed.
2342  *
2343  * Returns: the directory components of the file
2344  *
2345  * Deprecated: use g_path_get_dirname() instead
2346  */
2347
2348 /**
2349  * g_path_get_dirname:
2350  * @file_name: the name of the file
2351  *
2352  * Gets the directory components of a file name.
2353  *
2354  * If the file name has no directory components "." is returned.
2355  * The returned string should be freed when no longer needed.
2356  *
2357  * Returns: the directory components of the file
2358  */
2359 gchar *
2360 g_path_get_dirname (const gchar *file_name)
2361 {
2362   gchar *base;
2363   gsize len;
2364
2365   g_return_val_if_fail (file_name != NULL, NULL);
2366
2367   base = strrchr (file_name, G_DIR_SEPARATOR);
2368
2369 #ifdef G_OS_WIN32
2370   {
2371     gchar *q;
2372     q = strrchr (file_name, '/');
2373     if (base == NULL || (q != NULL && q > base))
2374       base = q;
2375   }
2376 #endif
2377
2378   if (!base)
2379     {
2380 #ifdef G_OS_WIN32
2381       if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2382         {
2383           gchar drive_colon_dot[4];
2384
2385           drive_colon_dot[0] = file_name[0];
2386           drive_colon_dot[1] = ':';
2387           drive_colon_dot[2] = '.';
2388           drive_colon_dot[3] = '\0';
2389
2390           return g_strdup (drive_colon_dot);
2391         }
2392 #endif
2393     return g_strdup (".");
2394     }
2395
2396   while (base > file_name && G_IS_DIR_SEPARATOR (*base))
2397     base--;
2398
2399 #ifdef G_OS_WIN32
2400   /* base points to the char before the last slash.
2401    *
2402    * In case file_name is the root of a drive (X:\) or a child of the
2403    * root of a drive (X:\foo), include the slash.
2404    *
2405    * In case file_name is the root share of an UNC path
2406    * (\\server\share), add a slash, returning \\server\share\ .
2407    *
2408    * In case file_name is a direct child of a share in an UNC path
2409    * (\\server\share\foo), include the slash after the share name,
2410    * returning \\server\share\ .
2411    */
2412   if (base == file_name + 1 &&
2413       g_ascii_isalpha (file_name[0]) &&
2414       file_name[1] == ':')
2415     base++;
2416   else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2417            G_IS_DIR_SEPARATOR (file_name[1]) &&
2418            file_name[2] &&
2419            !G_IS_DIR_SEPARATOR (file_name[2]) &&
2420            base >= file_name + 2)
2421     {
2422       const gchar *p = file_name + 2;
2423       while (*p && !G_IS_DIR_SEPARATOR (*p))
2424         p++;
2425       if (p == base + 1)
2426         {
2427           len = (guint) strlen (file_name) + 1;
2428           base = g_new (gchar, len + 1);
2429           strcpy (base, file_name);
2430           base[len-1] = G_DIR_SEPARATOR;
2431           base[len] = 0;
2432           return base;
2433         }
2434       if (G_IS_DIR_SEPARATOR (*p))
2435         {
2436           p++;
2437           while (*p && !G_IS_DIR_SEPARATOR (*p))
2438             p++;
2439           if (p == base + 1)
2440             base++;
2441         }
2442     }
2443 #endif
2444
2445   len = (guint) 1 + base - file_name;
2446   base = g_new (gchar, len + 1);
2447   g_memmove (base, file_name, len);
2448   base[len] = 0;
2449
2450   return base;
2451 }
2452
2453 #if defined(MAXPATHLEN)
2454 #define G_PATH_LENGTH MAXPATHLEN
2455 #elif defined(PATH_MAX)
2456 #define G_PATH_LENGTH PATH_MAX
2457 #elif defined(_PC_PATH_MAX)
2458 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
2459 #else
2460 #define G_PATH_LENGTH 2048
2461 #endif
2462
2463 /**
2464  * g_get_current_dir:
2465  *
2466  * Gets the current directory.
2467  *
2468  * The returned string should be freed when no longer needed.
2469  * The encoding of the returned string is system defined.
2470  * On Windows, it is always UTF-8.
2471  *
2472  * Returns: the current directory
2473  */
2474 gchar *
2475 g_get_current_dir (void)
2476 {
2477 #ifdef G_OS_WIN32
2478
2479   gchar *dir = NULL;
2480   wchar_t dummy[2], *wdir;
2481   int len;
2482
2483   len = GetCurrentDirectoryW (2, dummy);
2484   wdir = g_new (wchar_t, len);
2485
2486   if (GetCurrentDirectoryW (len, wdir) == len - 1)
2487     dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
2488
2489   g_free (wdir);
2490
2491   if (dir == NULL)
2492     dir = g_strdup ("\\");
2493
2494   return dir;
2495
2496 #else
2497
2498   gchar *buffer = NULL;
2499   gchar *dir = NULL;
2500   static gulong max_len = 0;
2501
2502   if (max_len == 0)
2503     max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
2504
2505   /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
2506    * and, if that wasn't bad enough, hangs in doing so.
2507    */
2508 #if (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
2509   buffer = g_new (gchar, max_len + 1);
2510   *buffer = 0;
2511   dir = getwd (buffer);
2512 #else
2513   while (max_len < G_MAXULONG / 2)
2514     {
2515       g_free (buffer);
2516       buffer = g_new (gchar, max_len + 1);
2517       *buffer = 0;
2518       dir = getcwd (buffer, max_len);
2519
2520       if (dir || errno != ERANGE)
2521         break;
2522
2523       max_len *= 2;
2524     }
2525 #endif  /* !sun || !HAVE_GETCWD */
2526
2527   if (!dir || !*buffer)
2528     {
2529       /* hm, should we g_error() out here?
2530        * this can happen if e.g. "./" has mode \0000
2531        */
2532       buffer[0] = G_DIR_SEPARATOR;
2533       buffer[1] = 0;
2534     }
2535
2536   dir = g_strdup (buffer);
2537   g_free (buffer);
2538
2539   return dir;
2540
2541 #endif /* !G_OS_WIN32 */
2542 }
2543
2544
2545 /* NOTE : Keep this part last to ensure nothing in this file uses thn
2546  * below binary compatibility versions.
2547  */
2548 #if defined (G_OS_WIN32) && !defined (_WIN64)
2549
2550 /* Binary compatibility versions. Will be called by code compiled
2551  * against quite old (pre-2.8, I think) headers only, not from more
2552  * recently compiled code.
2553  */
2554
2555 #undef g_file_test
2556
2557 gboolean
2558 g_file_test (const gchar *filename,
2559              GFileTest    test)
2560 {
2561   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2562   gboolean retval;
2563
2564   if (utf8_filename == NULL)
2565     return FALSE;
2566
2567   retval = g_file_test_utf8 (utf8_filename, test);
2568
2569   g_free (utf8_filename);
2570
2571   return retval;
2572 }
2573
2574 #undef g_file_get_contents
2575
2576 gboolean
2577 g_file_get_contents (const gchar  *filename,
2578                      gchar       **contents,
2579                      gsize        *length,
2580                      GError      **error)
2581 {
2582   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, error);
2583   gboolean retval;
2584
2585   if (utf8_filename == NULL)
2586     return FALSE;
2587
2588   retval = g_file_get_contents_utf8 (utf8_filename, contents, length, error);
2589
2590   g_free (utf8_filename);
2591
2592   return retval;
2593 }
2594
2595 #undef g_mkstemp
2596
2597 static gint
2598 wrap_libc_open (const gchar *filename,
2599                 int          flags,
2600                 int          mode)
2601 {
2602   return open (filename, flags, mode);
2603 }
2604
2605 gint
2606 g_mkstemp (gchar *tmpl)
2607 {
2608   /* This is the backward compatibility system codepage version,
2609    * thus use normal open().
2610    */
2611   return get_tmp_file (tmpl, wrap_libc_open,
2612                        O_RDWR | O_CREAT | O_EXCL, 0600);
2613 }
2614
2615 #undef g_file_open_tmp
2616
2617 gint
2618 g_file_open_tmp (const gchar  *tmpl,
2619                  gchar       **name_used,
2620                  GError      **error)
2621 {
2622   gchar *utf8_tmpl = g_locale_to_utf8 (tmpl, -1, NULL, NULL, error);
2623   gchar *utf8_name_used;
2624   gint retval;
2625
2626   if (utf8_tmpl == NULL)
2627     return -1;
2628
2629   retval = g_file_open_tmp_utf8 (utf8_tmpl, &utf8_name_used, error);
2630
2631   if (retval == -1)
2632     return -1;
2633
2634   if (name_used)
2635     *name_used = g_locale_from_utf8 (utf8_name_used, -1, NULL, NULL, NULL);
2636
2637   g_free (utf8_name_used);
2638
2639   return retval;
2640 }
2641
2642 #undef g_get_current_dir
2643
2644 gchar *
2645 g_get_current_dir (void)
2646 {
2647   gchar *utf8_dir = g_get_current_dir_utf8 ();
2648   gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
2649   g_free (utf8_dir);
2650   return dir;
2651 }
2652
2653 #endif
2654