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 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <errno.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <fcntl.h>
  33 #include <stdlib.h>
  34
  35 #ifdef G_OS_UNIX
  36 #include <unistd.h>
  37 #endif
  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 #endif
 488
 489 #ifdef EISDIR
 490     case EISDIR:
 491       return G_FILE_ERROR_ISDIR;
 492 #endif
 493
 494 #ifdef EACCES
 495     case EACCES:
 496       return G_FILE_ERROR_ACCES;
 497 #endif
 498
 499 #ifdef ENAMETOOLONG
 500     case ENAMETOOLONG:
 501       return G_FILE_ERROR_NAMETOOLONG;
 502 #endif
 503
 504 #ifdef ENOENT
 505     case ENOENT:
 506       return G_FILE_ERROR_NOENT;
 507 #endif
 508
 509 #ifdef ENOTDIR
 510     case ENOTDIR:
 511       return G_FILE_ERROR_NOTDIR;
 512 #endif
 513
 514 #ifdef ENXIO
 515     case ENXIO:
 516       return G_FILE_ERROR_NXIO;
 517 #endif
 518
 519 #ifdef ENODEV
 520     case ENODEV:
 521       return G_FILE_ERROR_NODEV;
 522 #endif
 523
 524 #ifdef EROFS
 525     case EROFS:
 526       return G_FILE_ERROR_ROFS;
 527 #endif
 528
 529 #ifdef ETXTBSY
 530     case ETXTBSY:
 531       return G_FILE_ERROR_TXTBSY;
 532 #endif
 533
 534 #ifdef EFAULT
 535     case EFAULT:
 536       return G_FILE_ERROR_FAULT;
 537 #endif
 538
 539 #ifdef ELOOP
 540     case ELOOP:
 541       return G_FILE_ERROR_LOOP;
 542 #endif
 543
 544 #ifdef ENOSPC
 545     case ENOSPC:
 546       return G_FILE_ERROR_NOSPC;
 547 #endif
 548
 549 #ifdef ENOMEM
 550     case ENOMEM:
 551       return G_FILE_ERROR_NOMEM;
 552 #endif
 553
 554 #ifdef EMFILE
 555     case EMFILE:
 556       return G_FILE_ERROR_MFILE;
 557 #endif
 558
 559 #ifdef ENFILE
 560     case ENFILE:
 561       return G_FILE_ERROR_NFILE;
 562 #endif
 563
 564 #ifdef EBADF
 565     case EBADF:
 566       return G_FILE_ERROR_BADF;
 567 #endif
 568
 569 #ifdef EINVAL
 570     case EINVAL:
 571       return G_FILE_ERROR_INVAL;
 572 #endif
 573
 574 #ifdef EPIPE
 575     case EPIPE:
 576       return G_FILE_ERROR_PIPE;
 577 #endif
 578
 579 #ifdef EAGAIN
 580     case EAGAIN:
 581       return G_FILE_ERROR_AGAIN;
 582 #endif
 583
 584 #ifdef EINTR
 585     case EINTR:
 586       return G_FILE_ERROR_INTR;
 587 #endif
 588
 589 #ifdef EIO
 590     case EIO:
 591       return G_FILE_ERROR_IO;
 592 #endif
 593
 594 #ifdef EPERM
 595     case EPERM:
 596       return G_FILE_ERROR_PERM;
 597 #endif
 598
 599 #ifdef ENOSYS
 600     case ENOSYS:
 601       return G_FILE_ERROR_NOSYS;
 602 #endif
 603
 604     default:
 605       return G_FILE_ERROR_FAILED;
 606     }
 607 }
 608
 609 static gboolean
 610 get_contents_stdio (const gchar  *display_filename,
 611                     FILE         *f,
 612                     gchar       **contents,
 613                     gsize        *length,
 614                     GError      **error)
 615 {
 616   gchar buf[4096];
 617   gsize bytes;  /* always <= sizeof(buf) */
 618   gchar *str = NULL;
 619   gsize total_bytes = 0;
 620   gsize total_allocated = 0;
 621   gchar *tmp;
 622
 623   g_assert (f != NULL);
 624
 625   while (!feof (f))
 626     {
 627       gint save_errno;
 628
 629       bytes = fread (buf, 1, sizeof (buf), f);
 630       save_errno = errno;
 631
 632       if (total_bytes > G_MAXSIZE - bytes)
 633           goto file_too_large;
 634
 635       /* Possibility of overflow eliminated above. */
 636       while (total_bytes + bytes >= total_allocated)
 637         {
 638           if (str)
 639             {
 640               if (total_allocated > G_MAXSIZE / 2)
 641                   goto file_too_large;
 642               total_allocated *= 2;
 643             }
 644           else
 645             {
 646               total_allocated = MIN (bytes + 1, sizeof (buf));
 647             }
 648
 649           tmp = g_try_realloc (str, total_allocated);
 650
 651           if (tmp == NULL)
 652             {
 653               g_set_error (error,
 654                            G_FILE_ERROR,
 655                            G_FILE_ERROR_NOMEM,
 656                            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),
 657                            (gulong) total_allocated,
 658                            display_filename);
 659
 660               goto error;
 661             }
 662
 663           str = tmp;
 664         }
 665
 666       if (ferror (f))
 667         {
 668           g_set_error (error,
 669                        G_FILE_ERROR,
 670                        g_file_error_from_errno (save_errno),
 671                        _("Error reading file '%s': %s"),
 672                        display_filename,
 673                        g_strerror (save_errno));
 674
 675           goto error;
 676         }
 677
 678       g_assert (str != NULL);
 679       memcpy (str + total_bytes, buf, bytes);
 680
 681       total_bytes += bytes;
 682     }
 683
 684   fclose (f);
 685
 686   if (total_allocated == 0)
 687     {
 688       str = g_new (gchar, 1);
 689       total_bytes = 0;
 690     }
 691
 692   str[total_bytes] = '\0';
 693
 694   if (length)
 695     *length = total_bytes;
 696
 697   *contents = str;
 698
 699   return TRUE;
 700
 701  file_too_large:
 702   g_set_error (error,
 703                G_FILE_ERROR,
 704                G_FILE_ERROR_FAILED,
 705                _("File \"%s\" is too large"),
 706                display_filename);
 707
 708  error:
 709
 710   g_free (str);
 711   fclose (f);
 712
 713   return FALSE;
 714 }
 715
 716 #ifndef G_OS_WIN32
 717
 718 static gboolean
 719 get_contents_regfile (const gchar  *display_filename,
 720                       struct stat  *stat_buf,
 721                       gint          fd,
 722                       gchar       **contents,
 723                       gsize        *length,
 724                       GError      **error)
 725 {
 726   gchar *buf;
 727   gsize bytes_read;
 728   gsize size;
 729   gsize alloc_size;
 730
 731   size = stat_buf->st_size;
 732
 733   alloc_size = size + 1;
 734   buf = g_try_malloc (alloc_size);
 735
 736   if (buf == NULL)
 737     {
 738       g_set_error (error,
 739                    G_FILE_ERROR,
 740                    G_FILE_ERROR_NOMEM,
 741                            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),
 742                    (gulong) alloc_size,
 743                    display_filename);
 744
 745       goto error;
 746     }
 747
 748   bytes_read = 0;
 749   while (bytes_read < size)
 750     {
 751       gssize rc;
 752
 753       rc = read (fd, buf + bytes_read, size - bytes_read);
 754
 755       if (rc < 0)
 756         {
 757           if (errno != EINTR)
 758             {
 759               int save_errno = errno;
 760
 761               g_free (buf);
 762               g_set_error (error,
 763                            G_FILE_ERROR,
 764                            g_file_error_from_errno (save_errno),
 765                            _("Failed to read from file '%s': %s"),
 766                            display_filename,
 767                            g_strerror (save_errno));
 768
 769               goto error;
 770             }
 771         }
 772       else if (rc == 0)
 773         break;
 774       else
 775         bytes_read += rc;
 776     }
 777
 778   buf[bytes_read] = '\0';
 779
 780   if (length)
 781     *length = bytes_read;
 782
 783   *contents = buf;
 784
 785   close (fd);
 786
 787   return TRUE;
 788
 789  error:
 790
 791   close (fd);
 792
 793   return FALSE;
 794 }
 795
 796 static gboolean
 797 get_contents_posix (const gchar  *filename,
 798                     gchar       **contents,
 799                     gsize        *length,
 800                     GError      **error)
 801 {
 802   struct stat stat_buf;
 803   gint fd;
 804   gchar *display_filename = g_filename_display_name (filename);
 805
 806   /* O_BINARY useful on Cygwin */
 807   fd = open (filename, O_RDONLY|O_BINARY);
 808
 809   if (fd < 0)
 810     {
 811       int save_errno = errno;
 812
 813       g_set_error (error,
 814                    G_FILE_ERROR,
 815                    g_file_error_from_errno (save_errno),
 816                    _("Failed to open file '%s': %s"),
 817                    display_filename,
 818                    g_strerror (save_errno));
 819       g_free (display_filename);
 820
 821       return FALSE;
 822     }
 823
 824   /* I don't think this will ever fail, aside from ENOMEM, but. */
 825   if (fstat (fd, &stat_buf) < 0)
 826     {
 827       int save_errno = errno;
 828
 829       close (fd);
 830       g_set_error (error,
 831                    G_FILE_ERROR,
 832                    g_file_error_from_errno (save_errno),
 833                    _("Failed to get attributes of file '%s': fstat() failed: %s"),
 834                    display_filename,
 835                    g_strerror (save_errno));
 836       g_free (display_filename);
 837
 838       return FALSE;
 839     }
 840
 841   if (stat_buf.st_size > 0 && S_ISREG (stat_buf.st_mode))
 842     {
 843       gboolean retval = get_contents_regfile (display_filename,
 844                                               &stat_buf,
 845                                               fd,
 846                                               contents,
 847                                               length,
 848                                               error);
 849       g_free (display_filename);
 850
 851       return retval;
 852     }
 853   else
 854     {
 855       FILE *f;
 856       gboolean retval;
 857
 858       f = fdopen (fd, "r");
 859
 860       if (f == NULL)
 861         {
 862           int save_errno = errno;
 863
 864           g_set_error (error,
 865                        G_FILE_ERROR,
 866                        g_file_error_from_errno (save_errno),
 867                        _("Failed to open file '%s': fdopen() failed: %s"),
 868                        display_filename,
 869                        g_strerror (save_errno));
 870           g_free (display_filename);
 871
 872           return FALSE;
 873         }
 874
 875       retval = get_contents_stdio (display_filename, f, contents, length, error);
 876       g_free (display_filename);
 877
 878       return retval;
 879     }
 880 }
 881
 882 #else  /* G_OS_WIN32 */
 883
 884 static gboolean
 885 get_contents_win32 (const gchar  *filename,
 886                     gchar       **contents,
 887                     gsize        *length,
 888                     GError      **error)
 889 {
 890   FILE *f;
 891   gboolean retval;
 892   gchar *display_filename = g_filename_display_name (filename);
 893   int save_errno;
 894
 895   f = g_fopen (filename, "rb");
 896   save_errno = errno;
 897
 898   if (f == NULL)
 899     {
 900       g_set_error (error,
 901                    G_FILE_ERROR,
 902                    g_file_error_from_errno (save_errno),
 903                    _("Failed to open file '%s': %s"),
 904                    display_filename,
 905                    g_strerror (save_errno));
 906       g_free (display_filename);
 907
 908       return FALSE;
 909     }
 910
 911   retval = get_contents_stdio (display_filename, f, contents, length, error);
 912   g_free (display_filename);
 913
 914   return retval;
 915 }
 916
 917 #endif
 918
 919 /**
 920  * g_file_get_contents:
 921  * @filename: (type filename): name of a file to read contents from, in the GLib file name encoding
 922  * @contents: (out) (array length=length) (element-type guint8): location to store an allocated string, use g_free() to free
 923  *     the returned string
 924  * @length: (allow-none): location to store length in bytes of the contents, or %NULL
 925  * @error: return location for a #GError, or %NULL
 926  *
 927  * Reads an entire file into allocated memory, with good error
 928  * checking.
 929  *
 930  * If the call was successful, it returns %TRUE and sets @contents to the file
 931  * contents and @length to the length of the file contents in bytes. The string
 932  * stored in @contents will be nul-terminated, so for text files you can pass
 933  * %NULL for the @length argument. If the call was not successful, it returns
 934  * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
 935  * codes are those in the #GFileError enumeration. In the error case,
 936  * @contents is set to %NULL and @length is set to zero.
 937  *
 938  * Return value: %TRUE on success, %FALSE if an error occurred
 939  **/
 940 gboolean
 941 g_file_get_contents (const gchar  *filename,
 942                      gchar       **contents,
 943                      gsize        *length,
 944                      GError      **error)
 945 {
 946   g_return_val_if_fail (filename != NULL, FALSE);
 947   g_return_val_if_fail (contents != NULL, FALSE);
 948
 949   *contents = NULL;
 950   if (length)
 951     *length = 0;
 952
 953 #ifdef G_OS_WIN32
 954   return get_contents_win32 (filename, contents, length, error);
 955 #else
 956   return get_contents_posix (filename, contents, length, error);
 957 #endif
 958 }
 959
 960 static gboolean
 961 rename_file (const char  *old_name,
 962              const char  *new_name,
 963              GError     **err)
 964 {
 965   errno = 0;
 966   if (g_rename (old_name, new_name) == -1)
 967     {
 968       int save_errno = errno;
 969       gchar *display_old_name = g_filename_display_name (old_name);
 970       gchar *display_new_name = g_filename_display_name (new_name);
 971
 972       g_set_error (err,
 973                    G_FILE_ERROR,
 974                    g_file_error_from_errno (save_errno),
 975                    _("Failed to rename file '%s' to '%s': g_rename() failed: %s"),
 976                    display_old_name,
 977                    display_new_name,
 978                    g_strerror (save_errno));
 979
 980       g_free (display_old_name);
 981       g_free (display_new_name);
 982
 983       return FALSE;
 984     }
 985
 986   return TRUE;
 987 }
 988
 989 static char *
 990 format_error_message (const gchar  *filename,
 991                       const gchar  *format_string) G_GNUC_FORMAT(2);
 992
 993 #pragma GCC diagnostic push
 994 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
 995
 996 static char *
 997 format_error_message (const gchar  *filename,
 998                       const gchar  *format_string)
 999 {
1000   gint saved_errno = errno;
1001   gchar *display_name;
1002   gchar *msg;
1003
1004   display_name = g_filename_display_name (filename);
1005   msg = g_strdup_printf (format_string, display_name, g_strerror (saved_errno));
1006   g_free (display_name);
1007
1008   return msg;
1009 }
1010
1011 #pragma GCC diagnostic pop
1012
1013 /* format string must have two '%s':
1014  *
1015  *   - the place for the filename
1016  *   - the place for the strerror
1017  */
1018 static void
1019 set_file_error (GError      **error,
1020                 const gchar  *filename,
1021                 const gchar  *format_string)
1022
1023 {
1024   int saved_errno = errno;
1025   char *msg = format_error_message (filename, format_string);
1026
1027   g_set_error_literal (error, G_FILE_ERROR, g_file_error_from_errno (saved_errno),
1028                        msg);
1029   g_free (msg);
1030 }
1031
1032 static gchar *
1033 write_to_temp_file (const gchar  *contents,
1034                     gssize        length,
1035                     const gchar  *dest_file,
1036                     GError      **err)
1037 {
1038   gchar *tmp_name;
1039   gchar *retval;
1040   gint fd;
1041
1042   retval = NULL;
1043
1044   tmp_name = g_strdup_printf ("%s.XXXXXX", dest_file);
1045
1046   errno = 0;
1047   fd = g_mkstemp_full (tmp_name, O_RDWR | O_BINARY, 0666);
1048
1049   if (fd == -1)
1050     {
1051       set_file_error (err, tmp_name, _("Failed to create file '%s': %s"));
1052       goto out;
1053     }
1054
1055 #ifdef HAVE_FALLOCATE
1056   if (length > 0)
1057     {
1058       /* We do this on a 'best effort' basis... It may not be supported
1059        * on the underlying filesystem.
1060        */
1061       (void) fallocate (fd, 0, 0, length);
1062     }
1063 #endif
1064   while (length > 0)
1065     {
1066       gssize s;
1067
1068       s = write (fd, contents, length);
1069
1070       if (s < 0)
1071         {
1072           if (errno == EINTR)
1073             continue;
1074
1075           set_file_error (err, tmp_name, _("Failed to write file '%s': write() failed: %s"));
1076           close (fd);
1077           g_unlink (tmp_name);
1078
1079           goto out;
1080         }
1081
1082       g_assert (s <= length);
1083
1084       contents += s;
1085       length -= s;
1086     }
1087
1088 #ifdef BTRFS_SUPER_MAGIC
1089   {
1090     struct statfs buf;
1091
1092     /* On Linux, on btrfs, skip the fsync since rename-over-existing is
1093      * guaranteed to be atomic and this is the only case in which we
1094      * would fsync() anyway.
1095      */
1096
1097     if (fstatfs (fd, &buf) == 0 && buf.f_type == BTRFS_SUPER_MAGIC)
1098       goto no_fsync;
1099   }
1100 #endif
1101
1102 #ifdef HAVE_FSYNC
1103   {
1104     struct stat statbuf;
1105
1106     errno = 0;
1107     /* If the final destination exists and is > 0 bytes, we want to sync the
1108      * newly written file to ensure the data is on disk when we rename over
1109      * the destination. Otherwise if we get a system crash we can lose both
1110      * the new and the old file on some filesystems. (I.E. those that don't
1111      * guarantee the data is written to the disk before the metadata.)
1112      */
1113     if (g_lstat (dest_file, &statbuf) == 0 && statbuf.st_size > 0 && fsync (fd) != 0)
1114       {
1115         set_file_error (err, tmp_name, _("Failed to write file '%s': fsync() failed: %s"));
1116         close (fd);
1117         g_unlink (tmp_name);
1118
1119         goto out;
1120       }
1121   }
1122 #endif
1123
1124 #ifdef BTRFS_SUPER_MAGIC
1125  no_fsync:
1126 #endif
1127
1128   errno = 0;
1129   if (!g_close (fd, err))
1130     {
1131       g_unlink (tmp_name);
1132
1133       goto out;
1134     }
1135
1136   retval = g_strdup (tmp_name);
1137
1138  out:
1139   g_free (tmp_name);
1140
1141   return retval;
1142 }
1143
1144 /**
1145  * g_file_set_contents:
1146  * @filename: (type filename): name of a file to write @contents to, in the GLib file name
1147  *   encoding
1148  * @contents: (array length=length) (element-type guint8): string to write to the file
1149  * @length: length of @contents, or -1 if @contents is a nul-terminated string
1150  * @error: return location for a #GError, or %NULL
1151  *
1152  * Writes all of @contents to a file named @filename, with good error checking.
1153  * If a file called @filename already exists it will be overwritten.
1154  *
1155  * This write is atomic in the sense that it is first written to a temporary
1156  * file which is then renamed to the final name. Notes:
1157  * <itemizedlist>
1158  * <listitem>
1159  *    On Unix, if @filename already exists hard links to @filename will break.
1160  *    Also since the file is recreated, existing permissions, access control
1161  *    lists, metadata etc. may be lost. If @filename is a symbolic link,
1162  *    the link itself will be replaced, not the linked file.
1163  * </listitem>
1164  * <listitem>
1165  *   On Windows renaming a file will not remove an existing file with the
1166  *   new name, so on Windows there is a race condition between the existing
1167  *   file being removed and the temporary file being renamed.
1168  * </listitem>
1169  * <listitem>
1170  *   On Windows there is no way to remove a file that is open to some
1171  *   process, or mapped into memory. Thus, this function will fail if
1172  *   @filename already exists and is open.
1173  * </listitem>
1174  * </itemizedlist>
1175  *
1176  * If the call was successful, it returns %TRUE. If the call was not successful,
1177  * it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
1178  * Possible error codes are those in the #GFileError enumeration.
1179  *
1180  * Note that the name for the temporary file is constructed by appending up
1181  * to 7 characters to @filename.
1182  *
1183  * Return value: %TRUE on success, %FALSE if an error occurred
1184  *
1185  * Since: 2.8
1186  **/
1187 gboolean
1188 g_file_set_contents (const gchar  *filename,
1189                      const gchar  *contents,
1190                      gssize        length,
1191                      GError      **error)
1192 {
1193   gchar *tmp_filename;
1194   gboolean retval;
1195   GError *rename_error = NULL;
1196
1197   g_return_val_if_fail (filename != NULL, FALSE);
1198   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1199   g_return_val_if_fail (contents != NULL || length == 0, FALSE);
1200   g_return_val_if_fail (length >= -1, FALSE);
1201
1202   if (length == -1)
1203     length = strlen (contents);
1204
1205   tmp_filename = write_to_temp_file (contents, length, filename, error);
1206
1207   if (!tmp_filename)
1208     {
1209       retval = FALSE;
1210       goto out;
1211     }
1212
1213   if (!rename_file (tmp_filename, filename, &rename_error))
1214     {
1215 #ifndef G_OS_WIN32
1216
1217       g_unlink (tmp_filename);
1218       g_propagate_error (error, rename_error);
1219       retval = FALSE;
1220       goto out;
1221
1222 #else /* G_OS_WIN32 */
1223
1224       /* Renaming failed, but on Windows this may just mean
1225        * the file already exists. So if the target file
1226        * exists, try deleting it and do the rename again.
1227        */
1228       if (!g_file_test (filename, G_FILE_TEST_EXISTS))
1229         {
1230           g_unlink (tmp_filename);
1231           g_propagate_error (error, rename_error);
1232           retval = FALSE;
1233           goto out;
1234         }
1235
1236       g_error_free (rename_error);
1237
1238       if (g_unlink (filename) == -1)
1239         {
1240           gchar *display_filename = g_filename_display_name (filename);
1241
1242           int save_errno = errno;
1243
1244           g_set_error (error,
1245                        G_FILE_ERROR,
1246                        g_file_error_from_errno (save_errno),
1247                        _("Existing file '%s' could not be removed: g_unlink() failed: %s"),
1248                        display_filename,
1249                        g_strerror (save_errno));
1250
1251           g_free (display_filename);
1252           g_unlink (tmp_filename);
1253           retval = FALSE;
1254           goto out;
1255         }
1256
1257       if (!rename_file (tmp_filename, filename, error))
1258         {
1259           g_unlink (tmp_filename);
1260           retval = FALSE;
1261           goto out;
1262         }
1263
1264 #endif
1265     }
1266
1267   retval = TRUE;
1268
1269  out:
1270   g_free (tmp_filename);
1271   return retval;
1272 }
1273
1274 /*
1275  * get_tmp_file based on the mkstemp implementation from the GNU C library.
1276  * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
1277  */
1278 typedef gint (*GTmpFileCallback) (const gchar *, gint, gint);
1279
1280 static gint
1281 get_tmp_file (gchar            *tmpl,
1282               GTmpFileCallback  f,
1283               int               flags,
1284               int               mode)
1285 {
1286   char *XXXXXX;
1287   int count, fd;
1288   static const char letters[] =
1289     "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1290   static const int NLETTERS = sizeof (letters) - 1;
1291   glong value;
1292   GTimeVal tv;
1293   static int counter = 0;
1294
1295   g_return_val_if_fail (tmpl != NULL, -1);
1296
1297   /* find the last occurrence of "XXXXXX" */
1298   XXXXXX = g_strrstr (tmpl, "XXXXXX");
1299
1300   if (!XXXXXX || strncmp (XXXXXX, "XXXXXX", 6))
1301     {
1302       errno = EINVAL;
1303       return -1;
1304     }
1305
1306   /* Get some more or less random data.  */
1307   g_get_current_time (&tv);
1308   value = (tv.tv_usec ^ tv.tv_sec) + counter++;
1309
1310   for (count = 0; count < 100; value += 7777, ++count)
1311     {
1312       glong v = value;
1313
1314       /* Fill in the random bits.  */
1315       XXXXXX[0] = letters[v % NLETTERS];
1316       v /= NLETTERS;
1317       XXXXXX[1] = letters[v % NLETTERS];
1318       v /= NLETTERS;
1319       XXXXXX[2] = letters[v % NLETTERS];
1320       v /= NLETTERS;
1321       XXXXXX[3] = letters[v % NLETTERS];
1322       v /= NLETTERS;
1323       XXXXXX[4] = letters[v % NLETTERS];
1324       v /= NLETTERS;
1325       XXXXXX[5] = letters[v % NLETTERS];
1326
1327       fd = f (tmpl, flags, mode);
1328
1329       if (fd >= 0)
1330         return fd;
1331       else if (errno != EEXIST)
1332         /* Any other error will apply also to other names we might
1333          *  try, and there are 2^32 or so of them, so give up now.
1334          */
1335         return -1;
1336     }
1337
1338   /* We got out of the loop because we ran out of combinations to try.  */
1339   errno = EEXIST;
1340   return -1;
1341 }
1342
1343 /* Some GTmpFileCallback implementations.
1344  *
1345  * Note: we cannot use open() or g_open() directly because even though
1346  * they appear compatible, they may be vararg functions and calling
1347  * varargs functions through a non-varargs type is undefined.
1348  */
1349 static gint
1350 wrap_g_mkdir (const gchar *filename,
1351               int          flags G_GNUC_UNUSED,
1352               int          mode)
1353 {
1354   /* tmpl is in UTF-8 on Windows, thus use g_mkdir() */
1355   return g_mkdir (filename, mode);
1356 }
1357
1358 static gint
1359 wrap_g_open (const gchar *filename,
1360                 int          flags,
1361                 int          mode)
1362 {
1363   return g_open (filename, flags, mode);
1364 }
1365
1366 /**
1367  * g_mkdtemp_full:
1368  * @tmpl: (type filename): template directory name
1369  * @mode: permissions to create the temporary directory with
1370  *
1371  * Creates a temporary directory. See the mkdtemp() documentation
1372  * on most UNIX-like systems.
1373  *
1374  * The parameter is a string that should follow the rules for
1375  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1376  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1377  * sequence does not have to occur at the very end of the template
1378  * and you can pass a @mode. The X string will be modified to form
1379  * the name of a directory that didn't exist. The string should be
1380  * in the GLib file name encoding. Most importantly, on Windows it
1381  * should be in UTF-8.
1382  *
1383  * Return value: A pointer to @tmpl, which has been modified
1384  *     to hold the directory name. In case of errors, %NULL is
1385  *     returned, and %errno will be set.
1386  *
1387  * Since: 2.30
1388  */
1389 gchar *
1390 g_mkdtemp_full (gchar *tmpl,
1391                 gint   mode)
1392 {
1393   if (get_tmp_file (tmpl, wrap_g_mkdir, 0, mode) == -1)
1394     return NULL;
1395   else
1396     return tmpl;
1397 }
1398
1399 /**
1400  * g_mkdtemp:
1401  * @tmpl: (type filename): template directory name
1402  *
1403  * Creates a temporary directory. See the mkdtemp() documentation
1404  * on most UNIX-like systems.
1405  *
1406  * The parameter is a string that should follow the rules for
1407  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1408  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1409  * sequence does not have to occur at the very end of the template
1410  * and you can pass a @mode and additional @flags. The X string will
1411  * be modified to form the name of a directory that didn't exist.
1412  * The string should be in the GLib file name encoding. Most importantly,
1413  * on Windows it should be in UTF-8.
1414  *
1415  * Return value: A pointer to @tmpl, which has been modified
1416  *     to hold the directory name.  In case of errors, %NULL is
1417  *     returned and %errno will be set.
1418  *
1419  * Since: 2.30
1420  */
1421 gchar *
1422 g_mkdtemp (gchar *tmpl)
1423 {
1424   return g_mkdtemp_full (tmpl, 0700);
1425 }
1426
1427 /**
1428  * g_mkstemp_full:
1429  * @tmpl: (type filename): template filename
1430  * @flags: flags to pass to an open() call in addition to O_EXCL
1431  *     and O_CREAT, which are passed automatically
1432  * @mode: permissions to create the temporary file with
1433  *
1434  * Opens a temporary file. See the mkstemp() documentation
1435  * on most UNIX-like systems.
1436  *
1437  * The parameter is a string that should follow the rules for
1438  * mkstemp() templates, i.e. contain the string "XXXXXX".
1439  * g_mkstemp_full() is slightly more flexible than mkstemp()
1440  * in that the sequence does not have to occur at the very end of the
1441  * template and you can pass a @mode and additional @flags. The X
1442  * string will be modified to form the name of a file that didn't exist.
1443  * The string should be in the GLib file name encoding. Most importantly,
1444  * on Windows it should be in UTF-8.
1445  *
1446  * Return value: A file handle (as from open()) to the file
1447  *     opened for reading and writing. The file handle should be
1448  *     closed with close(). In case of errors, -1 is returned
1449  *     and %errno will be set.
1450  *
1451  * Since: 2.22
1452  */
1453 gint
1454 g_mkstemp_full (gchar *tmpl,
1455                 gint   flags,
1456                 gint   mode)
1457 {
1458   /* tmpl is in UTF-8 on Windows, thus use g_open() */
1459   return get_tmp_file (tmpl, wrap_g_open,
1460                        flags | O_CREAT | O_EXCL, mode);
1461 }
1462
1463 /**
1464  * g_mkstemp:
1465  * @tmpl: (type filename): template filename
1466  *
1467  * Opens a temporary file. See the mkstemp() documentation
1468  * on most UNIX-like systems.
1469  *
1470  * The parameter is a string that should follow the rules for
1471  * mkstemp() templates, i.e. contain the string "XXXXXX".
1472  * g_mkstemp() is slightly more flexible than mkstemp() in that the
1473  * sequence does not have to occur at the very end of the template.
1474  * The X string will be modified to form the name of a file that
1475  * didn't exist. The string should be in the GLib file name encoding.
1476  * Most importantly, on Windows it should be in UTF-8.
1477  *
1478  * Return value: A file handle (as from open()) to the file
1479  *     opened for reading and writing. The file is opened in binary
1480  *     mode on platforms where there is a difference. The file handle
1481  *     should be closed with close(). In case of errors, -1 is
1482  *     returned and %errno will be set.
1483  */
1484 gint
1485 g_mkstemp (gchar *tmpl)
1486 {
1487   return g_mkstemp_full (tmpl, O_RDWR | O_BINARY, 0600);
1488 }
1489
1490 static gint
1491 g_get_tmp_name (const gchar      *tmpl,
1492                 gchar           **name_used,
1493                 GTmpFileCallback  f,
1494                 gint              flags,
1495                 gint              mode,
1496                 GError          **error)
1497 {
1498   int retval;
1499   const char *tmpdir;
1500   const char *sep;
1501   char *fulltemplate;
1502   const char *slash;
1503
1504   if (tmpl == NULL)
1505     tmpl = ".XXXXXX";
1506
1507   if ((slash = strchr (tmpl, G_DIR_SEPARATOR)) != NULL
1508 #ifdef G_OS_WIN32
1509       || (strchr (tmpl, '/') != NULL && (slash = "/"))
1510 #endif
1511       )
1512     {
1513       gchar *display_tmpl = g_filename_display_name (tmpl);
1514       char c[2];
1515       c[0] = *slash;
1516       c[1] = '\0';
1517
1518       g_set_error (error,
1519                    G_FILE_ERROR,
1520                    G_FILE_ERROR_FAILED,
1521                    _("Template '%s' invalid, should not contain a '%s'"),
1522                    display_tmpl, c);
1523       g_free (display_tmpl);
1524
1525       return -1;
1526     }
1527
1528   if (strstr (tmpl, "XXXXXX") == NULL)
1529     {
1530       gchar *display_tmpl = g_filename_display_name (tmpl);
1531       g_set_error (error,
1532                    G_FILE_ERROR,
1533                    G_FILE_ERROR_FAILED,
1534                    _("Template '%s' doesn't contain XXXXXX"),
1535                    display_tmpl);
1536       g_free (display_tmpl);
1537       return -1;
1538     }
1539
1540   tmpdir = g_get_tmp_dir ();
1541
1542   if (G_IS_DIR_SEPARATOR (tmpdir [strlen (tmpdir) - 1]))
1543     sep = "";
1544   else
1545     sep = G_DIR_SEPARATOR_S;
1546
1547   fulltemplate = g_strconcat (tmpdir, sep, tmpl, NULL);
1548
1549   retval = get_tmp_file (fulltemplate, f, flags, mode);
1550   if (retval == -1)
1551     {
1552       int save_errno = errno;
1553       gchar *display_fulltemplate = g_filename_display_name (fulltemplate);
1554
1555       g_set_error (error,
1556                    G_FILE_ERROR,
1557                    g_file_error_from_errno (save_errno),
1558                    _("Failed to create file '%s': %s"),
1559                    display_fulltemplate, g_strerror (save_errno));
1560       g_free (display_fulltemplate);
1561       g_free (fulltemplate);
1562       return -1;
1563     }
1564
1565   *name_used = fulltemplate;
1566
1567   return retval;
1568 }
1569
1570 /**
1571  * g_file_open_tmp:
1572  * @tmpl: (type filename) (allow-none): Template for file name, as in
1573  *     g_mkstemp(), basename only, or %NULL for a default template
1574  * @name_used: (out) (type filename): location to store actual name used,
1575  *     or %NULL
1576  * @error: return location for a #GError
1577  *
1578  * Opens a file for writing in the preferred directory for temporary
1579  * files (as returned by g_get_tmp_dir()).
1580  *
1581  * @tmpl should be a string in the GLib file name encoding containing
1582  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1583  * However, unlike these functions, the template should only be a
1584  * basename, no directory components are allowed. If template is
1585  * %NULL, a default template is used.
1586  *
1587  * Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
1588  * modified, and might thus be a read-only literal string.
1589  *
1590  * Upon success, and if @name_used is non-%NULL, the actual name used
1591  * is returned in @name_used. This string should be freed with g_free()
1592  * when not needed any longer. The returned name is in the GLib file
1593  * name encoding.
1594  *
1595  * Return value: A file handle (as from open()) to the file opened for
1596  *     reading and writing. The file is opened in binary mode on platforms
1597  *     where there is a difference. The file handle should be closed with
1598  *     close(). In case of errors, -1 is returned and @error will be set.
1599  */
1600 gint
1601 g_file_open_tmp (const gchar  *tmpl,
1602                  gchar       **name_used,
1603                  GError      **error)
1604 {
1605   gchar *fulltemplate;
1606   gint result;
1607
1608   result = g_get_tmp_name (tmpl, &fulltemplate,
1609                            wrap_g_open,
1610                            O_CREAT | O_EXCL | O_RDWR | O_BINARY,
1611                            0600,
1612                            error);
1613   if (result != -1)
1614     {
1615       if (name_used)
1616         *name_used = fulltemplate;
1617       else
1618         g_free (fulltemplate);
1619     }
1620
1621   return result;
1622 }
1623
1624 /**
1625  * g_dir_make_tmp:
1626  * @tmpl: (type filename) (allow-none): Template for directory name,
1627  *     as in g_mkdtemp(), basename only, or %NULL for a default template
1628  * @error: return location for a #GError
1629  *
1630  * Creates a subdirectory in the preferred directory for temporary
1631  * files (as returned by g_get_tmp_dir()).
1632  *
1633  * @tmpl should be a string in the GLib file name encoding containing
1634  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1635  * However, unlike these functions, the template should only be a
1636  * basename, no directory components are allowed. If template is
1637  * %NULL, a default template is used.
1638  *
1639  * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
1640  * modified, and might thus be a read-only literal string.
1641  *
1642  * Return value: (type filename): The actual name used. This string
1643  *     should be freed with g_free() when not needed any longer and is
1644  *     is in the GLib file name encoding. In case of errors, %NULL is
1645  *     returned and @error will be set.
1646  *
1647  * Since: 2.30
1648  */
1649 gchar *
1650 g_dir_make_tmp (const gchar  *tmpl,
1651                 GError      **error)
1652 {
1653   gchar *fulltemplate;
1654
1655   if (g_get_tmp_name (tmpl, &fulltemplate, wrap_g_mkdir, 0, 0700, error) == -1)
1656     return NULL;
1657   else
1658     return fulltemplate;
1659 }
1660
1661 static gchar *
1662 g_build_path_va (const gchar  *separator,
1663                  const gchar  *first_element,
1664                  va_list      *args,
1665                  gchar       **str_array)
1666 {
1667   GString *result;
1668   gint separator_len = strlen (separator);
1669   gboolean is_first = TRUE;
1670   gboolean have_leading = FALSE;
1671   const gchar *single_element = NULL;
1672   const gchar *next_element;
1673   const gchar *last_trailing = NULL;
1674   gint i = 0;
1675
1676   result = g_string_new (NULL);
1677
1678   if (str_array)
1679     next_element = str_array[i++];
1680   else
1681     next_element = first_element;
1682
1683   while (TRUE)
1684     {
1685       const gchar *element;
1686       const gchar *start;
1687       const gchar *end;
1688
1689       if (next_element)
1690         {
1691           element = next_element;
1692           if (str_array)
1693             next_element = str_array[i++];
1694           else
1695             next_element = va_arg (*args, gchar *);
1696         }
1697       else
1698         break;
1699
1700       /* Ignore empty elements */
1701       if (!*element)
1702         continue;
1703
1704       start = element;
1705
1706       if (separator_len)
1707         {
1708           while (strncmp (start, separator, separator_len) == 0)
1709             start += separator_len;
1710         }
1711
1712       end = start + strlen (start);
1713
1714       if (separator_len)
1715         {
1716           while (end >= start + separator_len &&
1717                  strncmp (end - separator_len, separator, separator_len) == 0)
1718             end -= separator_len;
1719
1720           last_trailing = end;
1721           while (last_trailing >= element + separator_len &&
1722                  strncmp (last_trailing - separator_len, separator, separator_len) == 0)
1723             last_trailing -= separator_len;
1724
1725           if (!have_leading)
1726             {
1727               /* If the leading and trailing separator strings are in the
1728                * same element and overlap, the result is exactly that element
1729                */
1730               if (last_trailing <= start)
1731                 single_element = element;
1732
1733               g_string_append_len (result, element, start - element);
1734               have_leading = TRUE;
1735             }
1736           else
1737             single_element = NULL;
1738         }
1739
1740       if (end == start)
1741         continue;
1742
1743       if (!is_first)
1744         g_string_append (result, separator);
1745
1746       g_string_append_len (result, start, end - start);
1747       is_first = FALSE;
1748     }
1749
1750   if (single_element)
1751     {
1752       g_string_free (result, TRUE);
1753       return g_strdup (single_element);
1754     }
1755   else
1756     {
1757       if (last_trailing)
1758         g_string_append (result, last_trailing);
1759
1760       return g_string_free (result, FALSE);
1761     }
1762 }
1763
1764 /**
1765  * g_build_pathv:
1766  * @separator: a string used to separator the elements of the path.
1767  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1768  *
1769  * Behaves exactly like g_build_path(), but takes the path elements
1770  * as a string array, instead of varargs. This function is mainly
1771  * meant for language bindings.
1772  *
1773  * Return value: a newly-allocated string that must be freed with g_free().
1774  *
1775  * Since: 2.8
1776  */
1777 gchar *
1778 g_build_pathv (const gchar  *separator,
1779                gchar       **args)
1780 {
1781   if (!args)
1782     return NULL;
1783
1784   return g_build_path_va (separator, NULL, NULL, args);
1785 }
1786
1787
1788 /**
1789  * g_build_path:
1790  * @separator: a string used to separator the elements of the path.
1791  * @first_element: the first element in the path
1792  * @...: remaining elements in path, terminated by %NULL
1793  *
1794  * Creates a path from a series of elements using @separator as the
1795  * separator between elements. At the boundary between two elements,
1796  * any trailing occurrences of separator in the first element, or
1797  * leading occurrences of separator in the second element are removed
1798  * and exactly one copy of the separator is inserted.
1799  *
1800  * Empty elements are ignored.
1801  *
1802  * The number of leading copies of the separator on the result is
1803  * the same as the number of leading copies of the separator on
1804  * the first non-empty element.
1805  *
1806  * The number of trailing copies of the separator on the result is
1807  * the same as the number of trailing copies of the separator on
1808  * the last non-empty element. (Determination of the number of
1809  * trailing copies is done without stripping leading copies, so
1810  * if the separator is <literal>ABA</literal>, <literal>ABABA</literal>
1811  * has 1 trailing copy.)
1812  *
1813  * However, if there is only a single non-empty element, and there
1814  * are no characters in that element not part of the leading or
1815  * trailing separators, then the result is exactly the original value
1816  * of that element.
1817  *
1818  * Other than for determination of the number of leading and trailing
1819  * copies of the separator, elements consisting only of copies
1820  * of the separator are ignored.
1821  *
1822  * Return value: a newly-allocated string that must be freed with g_free().
1823  **/
1824 gchar *
1825 g_build_path (const gchar *separator,
1826               const gchar *first_element,
1827               ...)
1828 {
1829   gchar *str;
1830   va_list args;
1831
1832   g_return_val_if_fail (separator != NULL, NULL);
1833
1834   va_start (args, first_element);
1835   str = g_build_path_va (separator, first_element, &args, NULL);
1836   va_end (args);
1837
1838   return str;
1839 }
1840
1841 #ifdef G_OS_WIN32
1842
1843 static gchar *
1844 g_build_pathname_va (const gchar  *first_element,
1845                      va_list      *args,
1846                      gchar       **str_array)
1847 {
1848   /* Code copied from g_build_pathv(), and modified to use two
1849    * alternative single-character separators.
1850    */
1851   GString *result;
1852   gboolean is_first = TRUE;
1853   gboolean have_leading = FALSE;
1854   const gchar *single_element = NULL;
1855   const gchar *next_element;
1856   const gchar *last_trailing = NULL;
1857   gchar current_separator = '\\';
1858   gint i = 0;
1859
1860   result = g_string_new (NULL);
1861
1862   if (str_array)
1863     next_element = str_array[i++];
1864   else
1865     next_element = first_element;
1866
1867   while (TRUE)
1868     {
1869       const gchar *element;
1870       const gchar *start;
1871       const gchar *end;
1872
1873       if (next_element)
1874         {
1875           element = next_element;
1876           if (str_array)
1877             next_element = str_array[i++];
1878           else
1879             next_element = va_arg (*args, gchar *);
1880         }
1881       else
1882         break;
1883
1884       /* Ignore empty elements */
1885       if (!*element)
1886         continue;
1887
1888       start = element;
1889
1890       if (TRUE)
1891         {
1892           while (start &&
1893                  (*start == '\\' || *start == '/'))
1894             {
1895               current_separator = *start;
1896               start++;
1897             }
1898         }
1899
1900       end = start + strlen (start);
1901
1902       if (TRUE)
1903         {
1904           while (end >= start + 1 &&
1905                  (end[-1] == '\\' || end[-1] == '/'))
1906             {
1907               current_separator = end[-1];
1908               end--;
1909             }
1910
1911           last_trailing = end;
1912           while (last_trailing >= element + 1 &&
1913                  (last_trailing[-1] == '\\' || last_trailing[-1] == '/'))
1914             last_trailing--;
1915
1916           if (!have_leading)
1917             {
1918               /* If the leading and trailing separator strings are in the
1919                * same element and overlap, the result is exactly that element
1920                */
1921               if (last_trailing <= start)
1922                 single_element = element;
1923
1924               g_string_append_len (result, element, start - element);
1925               have_leading = TRUE;
1926             }
1927           else
1928             single_element = NULL;
1929         }
1930
1931       if (end == start)
1932         continue;
1933
1934       if (!is_first)
1935         g_string_append_len (result, &current_separator, 1);
1936
1937       g_string_append_len (result, start, end - start);
1938       is_first = FALSE;
1939     }
1940
1941   if (single_element)
1942     {
1943       g_string_free (result, TRUE);
1944       return g_strdup (single_element);
1945     }
1946   else
1947     {
1948       if (last_trailing)
1949         g_string_append (result, last_trailing);
1950
1951       return g_string_free (result, FALSE);
1952     }
1953 }
1954
1955 #endif
1956
1957 /**
1958  * g_build_filenamev:
1959  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1960  *
1961  * Behaves exactly like g_build_filename(), but takes the path elements
1962  * as a string array, instead of varargs. This function is mainly
1963  * meant for language bindings.
1964  *
1965  * Return value: a newly-allocated string that must be freed with g_free().
1966  *
1967  * Since: 2.8
1968  */
1969 gchar *
1970 g_build_filenamev (gchar **args)
1971 {
1972   gchar *str;
1973
1974 #ifndef G_OS_WIN32
1975   str = g_build_path_va (G_DIR_SEPARATOR_S, NULL, NULL, args);
1976 #else
1977   str = g_build_pathname_va (NULL, NULL, args);
1978 #endif
1979
1980   return str;
1981 }
1982
1983 /**
1984  * g_build_filename:
1985  * @first_element: the first element in the path
1986  * @...: remaining elements in path, terminated by %NULL
1987  *
1988  * Creates a filename from a series of elements using the correct
1989  * separator for filenames.
1990  *
1991  * On Unix, this function behaves identically to <literal>g_build_path
1992  * (G_DIR_SEPARATOR_S, first_element, ....)</literal>.
1993  *
1994  * On Windows, it takes into account that either the backslash
1995  * (<literal>\</literal> or slash (<literal>/</literal>) can be used
1996  * as separator in filenames, but otherwise behaves as on Unix. When
1997  * file pathname separators need to be inserted, the one that last
1998  * previously occurred in the parameters (reading from left to right)
1999  * is used.
2000  *
2001  * No attempt is made to force the resulting filename to be an absolute
2002  * path. If the first element is a relative path, the result will
2003  * be a relative path.
2004  *
2005  * Return value: a newly-allocated string that must be freed with g_free().
2006  **/
2007 gchar *
2008 g_build_filename (const gchar *first_element,
2009                   ...)
2010 {
2011   gchar *str;
2012   va_list args;
2013
2014   va_start (args, first_element);
2015 #ifndef G_OS_WIN32
2016   str = g_build_path_va (G_DIR_SEPARATOR_S, first_element, &args, NULL);
2017 #else
2018   str = g_build_pathname_va (first_element, &args, NULL);
2019 #endif
2020   va_end (args);
2021
2022   return str;
2023 }
2024
2025 /**
2026  * g_file_read_link:
2027  * @filename: the symbolic link
2028  * @error: return location for a #GError
2029  *
2030  * Reads the contents of the symbolic link @filename like the POSIX
2031  * readlink() function.  The returned string is in the encoding used
2032  * for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
2033  *
2034  * Returns: A newly-allocated string with the contents of the symbolic link,
2035  *          or %NULL if an error occurred.
2036  *
2037  * Since: 2.4
2038  */
2039 gchar *
2040 g_file_read_link (const gchar  *filename,
2041                   GError      **error)
2042 {
2043 #ifdef HAVE_READLINK
2044   gchar *buffer;
2045   guint size;
2046   gint read_size;
2047
2048   size = 256;
2049   buffer = g_malloc (size);
2050
2051   while (TRUE)
2052     {
2053       read_size = readlink (filename, buffer, size);
2054       if (read_size < 0) {
2055         int save_errno = errno;
2056         gchar *display_filename = g_filename_display_name (filename);
2057
2058         g_free (buffer);
2059         g_set_error (error,
2060                      G_FILE_ERROR,
2061                      g_file_error_from_errno (save_errno),
2062                      _("Failed to read the symbolic link '%s': %s"),
2063                      display_filename,
2064                      g_strerror (save_errno));
2065         g_free (display_filename);
2066
2067         return NULL;
2068       }
2069
2070       if (read_size < size)
2071         {
2072           buffer[read_size] = 0;
2073           return buffer;
2074         }
2075
2076       size *= 2;
2077       buffer = g_realloc (buffer, size);
2078     }
2079 #else
2080   g_set_error_literal (error,
2081                        G_FILE_ERROR,
2082                        G_FILE_ERROR_INVAL,
2083                        _("Symbolic links not supported"));
2084
2085   return NULL;
2086 #endif
2087 }
2088
2089 /**
2090  * g_path_is_absolute:
2091  * @file_name: a file name
2092  *
2093  * Returns %TRUE if the given @file_name is an absolute file name.
2094  * Note that this is a somewhat vague concept on Windows.
2095  *
2096  * On POSIX systems, an absolute file name is well-defined. It always
2097  * starts from the single root directory. For example "/usr/local".
2098  *
2099  * On Windows, the concepts of current drive and drive-specific
2100  * current directory introduce vagueness. This function interprets as
2101  * an absolute file name one that either begins with a directory
2102  * separator such as "\Users\tml" or begins with the root on a drive,
2103  * for example "C:\Windows". The first case also includes UNC paths
2104  * such as "\\myserver\docs\foo". In all cases, either slashes or
2105  * backslashes are accepted.
2106  *
2107  * Note that a file name relative to the current drive root does not
2108  * truly specify a file uniquely over time and across processes, as
2109  * the current drive is a per-process value and can be changed.
2110  *
2111  * File names relative the current directory on some specific drive,
2112  * such as "D:foo/bar", are not interpreted as absolute by this
2113  * function, but they obviously are not relative to the normal current
2114  * directory as returned by getcwd() or g_get_current_dir()
2115  * either. Such paths should be avoided, or need to be handled using
2116  * Windows-specific code.
2117  *
2118  * Returns: %TRUE if @file_name is absolute
2119  */
2120 gboolean
2121 g_path_is_absolute (const gchar *file_name)
2122 {
2123   g_return_val_if_fail (file_name != NULL, FALSE);
2124
2125   if (G_IS_DIR_SEPARATOR (file_name[0]))
2126     return TRUE;
2127
2128 #ifdef G_OS_WIN32
2129   /* Recognize drive letter on native Windows */
2130   if (g_ascii_isalpha (file_name[0]) &&
2131       file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
2132     return TRUE;
2133 #endif
2134
2135   return FALSE;
2136 }
2137
2138 /**
2139  * g_path_skip_root:
2140  * @file_name: a file name
2141  *
2142  * Returns a pointer into @file_name after the root component,
2143  * i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name
2144  * is not an absolute path it returns %NULL.
2145  *
2146  * Returns: a pointer into @file_name after the root component
2147  */
2148 const gchar *
2149 g_path_skip_root (const gchar *file_name)
2150 {
2151   g_return_val_if_fail (file_name != NULL, NULL);
2152
2153 #ifdef G_PLATFORM_WIN32
2154   /* Skip \\server\share or //server/share */
2155   if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2156       G_IS_DIR_SEPARATOR (file_name[1]) &&
2157       file_name[2] &&
2158       !G_IS_DIR_SEPARATOR (file_name[2]))
2159     {
2160       gchar *p;
2161       p = strchr (file_name + 2, G_DIR_SEPARATOR);
2162
2163 #ifdef G_OS_WIN32
2164       {
2165         gchar *q;
2166
2167         q = strchr (file_name + 2, '/');
2168         if (p == NULL || (q != NULL && q < p))
2169         p = q;
2170       }
2171 #endif
2172
2173       if (p && p > file_name + 2 && p[1])
2174         {
2175           file_name = p + 1;
2176
2177           while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
2178             file_name++;
2179
2180           /* Possibly skip a backslash after the share name */
2181           if (G_IS_DIR_SEPARATOR (file_name[0]))
2182             file_name++;
2183
2184           return (gchar *)file_name;
2185         }
2186     }
2187 #endif
2188
2189   /* Skip initial slashes */
2190   if (G_IS_DIR_SEPARATOR (file_name[0]))
2191     {
2192       while (G_IS_DIR_SEPARATOR (file_name[0]))
2193         file_name++;
2194       return (gchar *)file_name;
2195     }
2196
2197 #ifdef G_OS_WIN32
2198   /* Skip X:\ */
2199   if (g_ascii_isalpha (file_name[0]) &&
2200       file_name[1] == ':' &&
2201       G_IS_DIR_SEPARATOR (file_name[2]))
2202     return (gchar *)file_name + 3;
2203 #endif
2204
2205   return NULL;
2206 }
2207
2208 /**
2209  * g_basename:
2210  * @file_name: the name of the file
2211  *
2212  * Gets the name of the file without any leading directory
2213  * components. It returns a pointer into the given file name
2214  * string.
2215  *
2216  * Return value: the name of the file without any leading
2217  *     directory components
2218  *
2219  * Deprecated:2.2: Use g_path_get_basename() instead, but notice
2220  *     that g_path_get_basename() allocates new memory for the
2221  *     returned string, unlike this function which returns a pointer
2222  *     into the argument.
2223  */
2224 const gchar *
2225 g_basename (const gchar *file_name)
2226 {
2227   gchar *base;
2228
2229   g_return_val_if_fail (file_name != NULL, NULL);
2230
2231   base = strrchr (file_name, G_DIR_SEPARATOR);
2232
2233 #ifdef G_OS_WIN32
2234   {
2235     gchar *q;
2236     q = strrchr (file_name, '/');
2237     if (base == NULL || (q != NULL && q > base))
2238       base = q;
2239   }
2240 #endif
2241
2242   if (base)
2243     return base + 1;
2244
2245 #ifdef G_OS_WIN32
2246   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2247     return (gchar*) file_name + 2;
2248 #endif
2249
2250   return (gchar*) file_name;
2251 }
2252
2253 /**
2254  * g_path_get_basename:
2255  * @file_name: the name of the file
2256  *
2257  * Gets the last component of the filename.
2258  *
2259  * If @file_name ends with a directory separator it gets the component
2260  * before the last slash. If @file_name consists only of directory
2261  * separators (and on Windows, possibly a drive letter), a single
2262  * separator is returned. If @file_name is empty, it gets ".".
2263  *
2264  * Return value: a newly allocated string containing the last
2265  *    component of the filename
2266  */
2267 gchar *
2268 g_path_get_basename (const gchar *file_name)
2269 {
2270   gssize base;
2271   gssize last_nonslash;
2272   gsize len;
2273   gchar *retval;
2274
2275   g_return_val_if_fail (file_name != NULL, NULL);
2276
2277   if (file_name[0] == '\0')
2278     return g_strdup (".");
2279
2280   last_nonslash = strlen (file_name) - 1;
2281
2282   while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
2283     last_nonslash--;
2284
2285   if (last_nonslash == -1)
2286     /* string only containing slashes */
2287     return g_strdup (G_DIR_SEPARATOR_S);
2288
2289 #ifdef G_OS_WIN32
2290   if (last_nonslash == 1 &&
2291       g_ascii_isalpha (file_name[0]) &&
2292       file_name[1] == ':')
2293     /* string only containing slashes and a drive */
2294     return g_strdup (G_DIR_SEPARATOR_S);
2295 #endif
2296   base = last_nonslash;
2297
2298   while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
2299     base--;
2300
2301 #ifdef G_OS_WIN32
2302   if (base == -1 &&
2303       g_ascii_isalpha (file_name[0]) &&
2304       file_name[1] == ':')
2305     base = 1;
2306 #endif /* G_OS_WIN32 */
2307
2308   len = last_nonslash - base;
2309   retval = g_malloc (len + 1);
2310   memcpy (retval, file_name + base + 1, len);
2311   retval [len] = '\0';
2312
2313   return retval;
2314 }
2315
2316 /**
2317  * g_dirname:
2318  * @file_name: the name of the file
2319  *
2320  * Gets the directory components of a file name.
2321  *
2322  * If the file name has no directory components "." is returned.
2323  * The returned string should be freed when no longer needed.
2324  *
2325  * Returns: the directory components of the file
2326  *
2327  * Deprecated: use g_path_get_dirname() instead
2328  */
2329
2330 /**
2331  * g_path_get_dirname:
2332  * @file_name: the name of the file
2333  *
2334  * Gets the directory components of a file name.
2335  *
2336  * If the file name has no directory components "." is returned.
2337  * The returned string should be freed when no longer needed.
2338  *
2339  * Returns: the directory components of the file
2340  */
2341 gchar *
2342 g_path_get_dirname (const gchar *file_name)
2343 {
2344   gchar *base;
2345   gsize len;
2346
2347   g_return_val_if_fail (file_name != NULL, NULL);
2348
2349   base = strrchr (file_name, G_DIR_SEPARATOR);
2350
2351 #ifdef G_OS_WIN32
2352   {
2353     gchar *q;
2354     q = strrchr (file_name, '/');
2355     if (base == NULL || (q != NULL && q > base))
2356       base = q;
2357   }
2358 #endif
2359
2360   if (!base)
2361     {
2362 #ifdef G_OS_WIN32
2363       if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2364         {
2365           gchar drive_colon_dot[4];
2366
2367           drive_colon_dot[0] = file_name[0];
2368           drive_colon_dot[1] = ':';
2369           drive_colon_dot[2] = '.';
2370           drive_colon_dot[3] = '\0';
2371
2372           return g_strdup (drive_colon_dot);
2373         }
2374 #endif
2375     return g_strdup (".");
2376     }
2377
2378   while (base > file_name && G_IS_DIR_SEPARATOR (*base))
2379     base--;
2380
2381 #ifdef G_OS_WIN32
2382   /* base points to the char before the last slash.
2383    *
2384    * In case file_name is the root of a drive (X:\) or a child of the
2385    * root of a drive (X:\foo), include the slash.
2386    *
2387    * In case file_name is the root share of an UNC path
2388    * (\\server\share), add a slash, returning \\server\share\ .
2389    *
2390    * In case file_name is a direct child of a share in an UNC path
2391    * (\\server\share\foo), include the slash after the share name,
2392    * returning \\server\share\ .
2393    */
2394   if (base == file_name + 1 &&
2395       g_ascii_isalpha (file_name[0]) &&
2396       file_name[1] == ':')
2397     base++;
2398   else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2399            G_IS_DIR_SEPARATOR (file_name[1]) &&
2400            file_name[2] &&
2401            !G_IS_DIR_SEPARATOR (file_name[2]) &&
2402            base >= file_name + 2)
2403     {
2404       const gchar *p = file_name + 2;
2405       while (*p && !G_IS_DIR_SEPARATOR (*p))
2406         p++;
2407       if (p == base + 1)
2408         {
2409           len = (guint) strlen (file_name) + 1;
2410           base = g_new (gchar, len + 1);
2411           strcpy (base, file_name);
2412           base[len-1] = G_DIR_SEPARATOR;
2413           base[len] = 0;
2414           return base;
2415         }
2416       if (G_IS_DIR_SEPARATOR (*p))
2417         {
2418           p++;
2419           while (*p && !G_IS_DIR_SEPARATOR (*p))
2420             p++;
2421           if (p == base + 1)
2422             base++;
2423         }
2424     }
2425 #endif
2426
2427   len = (guint) 1 + base - file_name;
2428   base = g_new (gchar, len + 1);
2429   memmove (base, file_name, len);
2430   base[len] = 0;
2431
2432   return base;
2433 }
2434
2435 #if defined(MAXPATHLEN)
2436 #define G_PATH_LENGTH MAXPATHLEN
2437 #elif defined(PATH_MAX)
2438 #define G_PATH_LENGTH PATH_MAX
2439 #elif defined(_PC_PATH_MAX)
2440 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
2441 #else
2442 #define G_PATH_LENGTH 2048
2443 #endif
2444
2445 /**
2446  * g_get_current_dir:
2447  *
2448  * Gets the current directory.
2449  *
2450  * The returned string should be freed when no longer needed.
2451  * The encoding of the returned string is system defined.
2452  * On Windows, it is always UTF-8.
2453  *
2454  * Returns: the current directory
2455  */
2456 gchar *
2457 g_get_current_dir (void)
2458 {
2459 #ifdef G_OS_WIN32
2460
2461   gchar *dir = NULL;
2462   wchar_t dummy[2], *wdir;
2463   int len;
2464
2465   len = GetCurrentDirectoryW (2, dummy);
2466   wdir = g_new (wchar_t, len);
2467
2468   if (GetCurrentDirectoryW (len, wdir) == len - 1)
2469     dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
2470
2471   g_free (wdir);
2472
2473   if (dir == NULL)
2474     dir = g_strdup ("\\");
2475
2476   return dir;
2477
2478 #else
2479
2480   gchar *buffer = NULL;
2481   gchar *dir = NULL;
2482   static gulong max_len = 0;
2483
2484   if (max_len == 0)
2485     max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
2486
2487   while (max_len < G_MAXULONG / 2)
2488     {
2489       g_free (buffer);
2490       buffer = g_new (gchar, max_len + 1);
2491       *buffer = 0;
2492       dir = getcwd (buffer, max_len);
2493
2494       if (dir || errno != ERANGE)
2495         break;
2496
2497       max_len *= 2;
2498     }
2499
2500   if (!dir || !*buffer)
2501     {
2502       /* hm, should we g_error() out here?
2503        * this can happen if e.g. "./" has mode \0000
2504        */
2505       buffer[0] = G_DIR_SEPARATOR;
2506       buffer[1] = 0;
2507     }
2508
2509   dir = g_strdup (buffer);
2510   g_free (buffer);
2511
2512   return dir;
2513
2514 #endif /* !G_OS_WIN32 */
2515 }
2516
2517
2518 /* NOTE : Keep this part last to ensure nothing in this file uses thn
2519  * below binary compatibility versions.
2520  */
2521 #if defined (G_OS_WIN32) && !defined (_WIN64)
2522
2523 /* Binary compatibility versions. Will be called by code compiled
2524  * against quite old (pre-2.8, I think) headers only, not from more
2525  * recently compiled code.
2526  */
2527
2528 #undef g_file_test
2529
2530 gboolean
2531 g_file_test (const gchar *filename,
2532              GFileTest    test)
2533 {
2534   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2535   gboolean retval;
2536
2537   if (utf8_filename == NULL)
2538     return FALSE;
2539
2540   retval = g_file_test_utf8 (utf8_filename, test);
2541
2542   g_free (utf8_filename);
2543
2544   return retval;
2545 }
2546
2547 #undef g_file_get_contents
2548
2549 gboolean
2550 g_file_get_contents (const gchar  *filename,
2551                      gchar       **contents,
2552                      gsize        *length,
2553                      GError      **error)
2554 {
2555   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, error);
2556   gboolean retval;
2557
2558   if (utf8_filename == NULL)
2559     return FALSE;
2560
2561   retval = g_file_get_contents_utf8 (utf8_filename, contents, length, error);
2562
2563   g_free (utf8_filename);
2564
2565   return retval;
2566 }
2567
2568 #undef g_mkstemp
2569
2570 static gint
2571 wrap_libc_open (const gchar *filename,
2572                 int          flags,
2573                 int          mode)
2574 {
2575   return open (filename, flags, mode);
2576 }
2577
2578 gint
2579 g_mkstemp (gchar *tmpl)
2580 {
2581   /* This is the backward compatibility system codepage version,
2582    * thus use normal open().
2583    */
2584   return get_tmp_file (tmpl, wrap_libc_open,
2585                        O_RDWR | O_CREAT | O_EXCL, 0600);
2586 }
2587
2588 #undef g_file_open_tmp
2589
2590 gint
2591 g_file_open_tmp (const gchar  *tmpl,
2592                  gchar       **name_used,
2593                  GError      **error)
2594 {
2595   gchar *utf8_tmpl = g_locale_to_utf8 (tmpl, -1, NULL, NULL, error);
2596   gchar *utf8_name_used;
2597   gint retval;
2598
2599   if (utf8_tmpl == NULL)
2600     return -1;
2601
2602   retval = g_file_open_tmp_utf8 (utf8_tmpl, &utf8_name_used, error);
2603
2604   if (retval == -1)
2605     return -1;
2606
2607   if (name_used)
2608     *name_used = g_locale_from_utf8 (utf8_name_used, -1, NULL, NULL, NULL);
2609
2610   g_free (utf8_name_used);
2611
2612   return retval;
2613 }
2614
2615 #undef g_get_current_dir
2616
2617 gchar *
2618 g_get_current_dir (void)
2619 {
2620   gchar *utf8_dir = g_get_current_dir_utf8 ();
2621   gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
2622   g_free (utf8_dir);
2623   return dir;
2624 }
2625
2626 #endif
2627