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                            _("Could not allocate %lu bytes to read file \"%s\""),
 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                    _("Could not allocate %lu bytes to read file \"%s\""),
 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 gchar *
1008 write_to_temp_file (const gchar  *contents,
1009                     gssize        length,
1010                     const gchar  *dest_file,
1011                     GError      **err)
1012 {
1013   gchar *tmp_name;
1014   gchar *display_name;
1015   gchar *retval;
1016   FILE *file;
1017   gint fd;
1018   int save_errno;
1019
1020   retval = NULL;
1021
1022   tmp_name = g_strdup_printf ("%s.XXXXXX", dest_file);
1023
1024   errno = 0;
1025   fd = g_mkstemp_full (tmp_name, O_RDWR | O_BINARY, 0666);
1026   save_errno = errno;
1027
1028   display_name = g_filename_display_name (tmp_name);
1029
1030   if (fd == -1)
1031     {
1032       g_set_error (err,
1033                    G_FILE_ERROR,
1034                    g_file_error_from_errno (save_errno),
1035                    _("Failed to create file '%s': %s"),
1036                    display_name, g_strerror (save_errno));
1037
1038       goto out;
1039     }
1040
1041   errno = 0;
1042   file = fdopen (fd, "wb");
1043   if (!file)
1044     {
1045       save_errno = errno;
1046       g_set_error (err,
1047                    G_FILE_ERROR,
1048                    g_file_error_from_errno (save_errno),
1049                    _("Failed to open file '%s' for writing: fdopen() failed: %s"),
1050                    display_name,
1051                    g_strerror (save_errno));
1052
1053       close (fd);
1054       g_unlink (tmp_name);
1055
1056       goto out;
1057     }
1058
1059   if (length > 0)
1060     {
1061       gsize n_written;
1062
1063       errno = 0;
1064
1065       n_written = fwrite (contents, 1, length, file);
1066
1067       if (n_written < length)
1068         {
1069           save_errno = errno;
1070
1071           g_set_error (err,
1072                        G_FILE_ERROR,
1073                        g_file_error_from_errno (save_errno),
1074                        _("Failed to write file '%s': fwrite() failed: %s"),
1075                        display_name,
1076                        g_strerror (save_errno));
1077
1078           fclose (file);
1079           g_unlink (tmp_name);
1080
1081           goto out;
1082         }
1083     }
1084
1085   errno = 0;
1086   if (fflush (file) != 0)
1087     {
1088       save_errno = errno;
1089
1090       g_set_error (err,
1091                    G_FILE_ERROR,
1092                    g_file_error_from_errno (save_errno),
1093                    _("Failed to write file '%s': fflush() failed: %s"),
1094                    display_name,
1095                    g_strerror (save_errno));
1096
1097       fclose (file);
1098       g_unlink (tmp_name);
1099
1100       goto out;
1101     }
1102
1103 #ifdef BTRFS_SUPER_MAGIC
1104   {
1105     struct statfs buf;
1106
1107     /* On Linux, on btrfs, skip the fsync since rename-over-existing is
1108      * guaranteed to be atomic and this is the only case in which we
1109      * would fsync() anyway.
1110      */
1111
1112     if (fstatfs (fd, &buf) == 0 && buf.f_type == BTRFS_SUPER_MAGIC)
1113       goto no_fsync;
1114   }
1115 #endif
1116
1117 #ifdef HAVE_FSYNC
1118   {
1119     struct stat statbuf;
1120
1121     errno = 0;
1122     /* If the final destination exists and is > 0 bytes, we want to sync the
1123      * newly written file to ensure the data is on disk when we rename over
1124      * the destination. Otherwise if we get a system crash we can lose both
1125      * the new and the old file on some filesystems. (I.E. those that don't
1126      * guarantee the data is written to the disk before the metadata.)
1127      */
1128     if (g_lstat (dest_file, &statbuf) == 0 &&
1129         statbuf.st_size > 0 &&
1130         fsync (fileno (file)) != 0)
1131       {
1132         save_errno = errno;
1133
1134         g_set_error (err,
1135                      G_FILE_ERROR,
1136                      g_file_error_from_errno (save_errno),
1137                      _("Failed to write file '%s': fsync() failed: %s"),
1138                      display_name,
1139                      g_strerror (save_errno));
1140
1141         fclose (file);
1142         g_unlink (tmp_name);
1143
1144         goto out;
1145       }
1146   }
1147 #endif
1148
1149 #ifdef BTRFS_SUPER_MAGIC
1150  no_fsync:
1151 #endif
1152
1153   errno = 0;
1154   if (fclose (file) == EOF)
1155     {
1156       save_errno = errno;
1157
1158       g_set_error (err,
1159                    G_FILE_ERROR,
1160                    g_file_error_from_errno (save_errno),
1161                    _("Failed to close file '%s': fclose() failed: %s"),
1162                    display_name,
1163                    g_strerror (save_errno));
1164
1165       g_unlink (tmp_name);
1166
1167       goto out;
1168     }
1169
1170   retval = g_strdup (tmp_name);
1171
1172  out:
1173   g_free (tmp_name);
1174   g_free (display_name);
1175
1176   return retval;
1177 }
1178
1179 /**
1180  * g_file_set_contents:
1181  * @filename: (type filename): name of a file to write @contents to, in the GLib file name
1182  *   encoding
1183  * @contents: (array length=length) (element-type guint8): string to write to the file
1184  * @length: length of @contents, or -1 if @contents is a nul-terminated string
1185  * @error: return location for a #GError, or %NULL
1186  *
1187  * Writes all of @contents to a file named @filename, with good error checking.
1188  * If a file called @filename already exists it will be overwritten.
1189  *
1190  * This write is atomic in the sense that it is first written to a temporary
1191  * file which is then renamed to the final name. Notes:
1192  * <itemizedlist>
1193  * <listitem>
1194  *    On Unix, if @filename already exists hard links to @filename will break.
1195  *    Also since the file is recreated, existing permissions, access control
1196  *    lists, metadata etc. may be lost. If @filename is a symbolic link,
1197  *    the link itself will be replaced, not the linked file.
1198  * </listitem>
1199  * <listitem>
1200  *   On Windows renaming a file will not remove an existing file with the
1201  *   new name, so on Windows there is a race condition between the existing
1202  *   file being removed and the temporary file being renamed.
1203  * </listitem>
1204  * <listitem>
1205  *   On Windows there is no way to remove a file that is open to some
1206  *   process, or mapped into memory. Thus, this function will fail if
1207  *   @filename already exists and is open.
1208  * </listitem>
1209  * </itemizedlist>
1210  *
1211  * If the call was successful, it returns %TRUE. If the call was not successful,
1212  * it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
1213  * Possible error codes are those in the #GFileError enumeration.
1214  *
1215  * Note that the name for the temporary file is constructed by appending up
1216  * to 7 characters to @filename.
1217  *
1218  * Return value: %TRUE on success, %FALSE if an error occurred
1219  *
1220  * Since: 2.8
1221  **/
1222 gboolean
1223 g_file_set_contents (const gchar  *filename,
1224                      const gchar  *contents,
1225                      gssize        length,
1226                      GError      **error)
1227 {
1228   gchar *tmp_filename;
1229   gboolean retval;
1230   GError *rename_error = NULL;
1231
1232   g_return_val_if_fail (filename != NULL, FALSE);
1233   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1234   g_return_val_if_fail (contents != NULL || length == 0, FALSE);
1235   g_return_val_if_fail (length >= -1, FALSE);
1236
1237   if (length == -1)
1238     length = strlen (contents);
1239
1240   tmp_filename = write_to_temp_file (contents, length, filename, error);
1241
1242   if (!tmp_filename)
1243     {
1244       retval = FALSE;
1245       goto out;
1246     }
1247
1248   if (!rename_file (tmp_filename, filename, &rename_error))
1249     {
1250 #ifndef G_OS_WIN32
1251
1252       g_unlink (tmp_filename);
1253       g_propagate_error (error, rename_error);
1254       retval = FALSE;
1255       goto out;
1256
1257 #else /* G_OS_WIN32 */
1258
1259       /* Renaming failed, but on Windows this may just mean
1260        * the file already exists. So if the target file
1261        * exists, try deleting it and do the rename again.
1262        */
1263       if (!g_file_test (filename, G_FILE_TEST_EXISTS))
1264         {
1265           g_unlink (tmp_filename);
1266           g_propagate_error (error, rename_error);
1267           retval = FALSE;
1268           goto out;
1269         }
1270
1271       g_error_free (rename_error);
1272
1273       if (g_unlink (filename) == -1)
1274         {
1275           gchar *display_filename = g_filename_display_name (filename);
1276
1277           int save_errno = errno;
1278
1279           g_set_error (error,
1280                        G_FILE_ERROR,
1281                        g_file_error_from_errno (save_errno),
1282                        _("Existing file '%s' could not be removed: g_unlink() failed: %s"),
1283                        display_filename,
1284                        g_strerror (save_errno));
1285
1286           g_free (display_filename);
1287           g_unlink (tmp_filename);
1288           retval = FALSE;
1289           goto out;
1290         }
1291
1292       if (!rename_file (tmp_filename, filename, error))
1293         {
1294           g_unlink (tmp_filename);
1295           retval = FALSE;
1296           goto out;
1297         }
1298
1299 #endif
1300     }
1301
1302   retval = TRUE;
1303
1304  out:
1305   g_free (tmp_filename);
1306   return retval;
1307 }
1308
1309 /*
1310  * get_tmp_file based on the mkstemp implementation from the GNU C library.
1311  * Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
1312  */
1313 typedef gint (*GTmpFileCallback) (gchar *, gint, gint);
1314
1315 static gint
1316 get_tmp_file (gchar            *tmpl,
1317               GTmpFileCallback  f,
1318               int               flags,
1319               int               mode)
1320 {
1321   char *XXXXXX;
1322   int count, fd;
1323   static const char letters[] =
1324     "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1325   static const int NLETTERS = sizeof (letters) - 1;
1326   glong value;
1327   GTimeVal tv;
1328   static int counter = 0;
1329
1330   g_return_val_if_fail (tmpl != NULL, -1);
1331
1332   /* find the last occurrence of "XXXXXX" */
1333   XXXXXX = g_strrstr (tmpl, "XXXXXX");
1334
1335   if (!XXXXXX || strncmp (XXXXXX, "XXXXXX", 6))
1336     {
1337       errno = EINVAL;
1338       return -1;
1339     }
1340
1341   /* Get some more or less random data.  */
1342   g_get_current_time (&tv);
1343   value = (tv.tv_usec ^ tv.tv_sec) + counter++;
1344
1345   for (count = 0; count < 100; value += 7777, ++count)
1346     {
1347       glong v = value;
1348
1349       /* Fill in the random bits.  */
1350       XXXXXX[0] = letters[v % NLETTERS];
1351       v /= NLETTERS;
1352       XXXXXX[1] = letters[v % NLETTERS];
1353       v /= NLETTERS;
1354       XXXXXX[2] = letters[v % NLETTERS];
1355       v /= NLETTERS;
1356       XXXXXX[3] = letters[v % NLETTERS];
1357       v /= NLETTERS;
1358       XXXXXX[4] = letters[v % NLETTERS];
1359       v /= NLETTERS;
1360       XXXXXX[5] = letters[v % NLETTERS];
1361
1362       fd = f (tmpl, flags, mode);
1363
1364       if (fd >= 0)
1365         return fd;
1366       else if (errno != EEXIST)
1367         /* Any other error will apply also to other names we might
1368          *  try, and there are 2^32 or so of them, so give up now.
1369          */
1370         return -1;
1371     }
1372
1373   /* We got out of the loop because we ran out of combinations to try.  */
1374   errno = EEXIST;
1375   return -1;
1376 }
1377
1378 static gint
1379 wrap_mkdir (gchar *tmpl,
1380             int    flags G_GNUC_UNUSED,
1381             int    mode)
1382 {
1383   /* tmpl is in UTF-8 on Windows, thus use g_mkdir() */
1384   return g_mkdir (tmpl, mode);
1385 }
1386
1387 /**
1388  * g_mkdtemp_full:
1389  * @tmpl: (type filename): template directory name
1390  * @mode: permissions to create the temporary directory with
1391  *
1392  * Creates a temporary directory. See the mkdtemp() documentation
1393  * on most UNIX-like systems.
1394  *
1395  * The parameter is a string that should follow the rules for
1396  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1397  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1398  * sequence does not have to occur at the very end of the template
1399  * and you can pass a @mode. The X string will be modified to form
1400  * the name of a directory that didn't exist. The string should be
1401  * in the GLib file name encoding. Most importantly, on Windows it
1402  * should be in UTF-8.
1403  *
1404  * Return value: A pointer to @tmpl, which has been modified
1405  *     to hold the directory name. In case of errors, %NULL is
1406  *     returned, and %errno will be set.
1407  *
1408  * Since: 2.30
1409  */
1410 gchar *
1411 g_mkdtemp_full (gchar *tmpl,
1412                 gint   mode)
1413 {
1414   if (get_tmp_file (tmpl, wrap_mkdir, 0, mode) == -1)
1415     return NULL;
1416   else
1417     return tmpl;
1418 }
1419
1420 /**
1421  * g_mkdtemp:
1422  * @tmpl: (type filename): template directory name
1423  *
1424  * Creates a temporary directory. See the mkdtemp() documentation
1425  * on most UNIX-like systems.
1426  *
1427  * The parameter is a string that should follow the rules for
1428  * mkdtemp() templates, i.e. contain the string "XXXXXX".
1429  * g_mkdtemp() is slightly more flexible than mkdtemp() in that the
1430  * sequence does not have to occur at the very end of the template
1431  * and you can pass a @mode and additional @flags. The X string will
1432  * be modified to form the name of a directory that didn't exist.
1433  * The string should be in the GLib file name encoding. Most importantly,
1434  * on Windows it should be in UTF-8.
1435  *
1436  * Return value: A pointer to @tmpl, which has been modified
1437  *     to hold the directory name.  In case of errors, %NULL is
1438  *     returned and %errno will be set.
1439  *
1440  * Since: 2.30
1441  */
1442 gchar *
1443 g_mkdtemp (gchar *tmpl)
1444 {
1445   return g_mkdtemp_full (tmpl, 0700);
1446 }
1447
1448 /**
1449  * g_mkstemp_full:
1450  * @tmpl: (type filename): template filename
1451  * @flags: flags to pass to an open() call in addition to O_EXCL
1452  *     and O_CREAT, which are passed automatically
1453  * @mode: permissions to create the temporary file with
1454  *
1455  * Opens a temporary file. See the mkstemp() documentation
1456  * on most UNIX-like systems.
1457  *
1458  * The parameter is a string that should follow the rules for
1459  * mkstemp() templates, i.e. contain the string "XXXXXX".
1460  * g_mkstemp_full() is slightly more flexible than mkstemp()
1461  * in that the sequence does not have to occur at the very end of the
1462  * template and you can pass a @mode and additional @flags. The X
1463  * string will be modified to form the name of a file that didn't exist.
1464  * The string should be in the GLib file name encoding. Most importantly,
1465  * on Windows it should be in UTF-8.
1466  *
1467  * Return value: A file handle (as from open()) to the file
1468  *     opened for reading and writing. The file handle should be
1469  *     closed with close(). In case of errors, -1 is returned
1470  *     and %errno will be set.
1471  *
1472  * Since: 2.22
1473  */
1474 gint
1475 g_mkstemp_full (gchar *tmpl,
1476                 gint   flags,
1477                 gint   mode)
1478 {
1479   /* tmpl is in UTF-8 on Windows, thus use g_open() */
1480   return get_tmp_file (tmpl, (GTmpFileCallback) g_open,
1481                        flags | O_CREAT | O_EXCL, mode);
1482 }
1483
1484 /**
1485  * g_mkstemp:
1486  * @tmpl: (type filename): template filename
1487  *
1488  * Opens a temporary file. See the mkstemp() documentation
1489  * on most UNIX-like systems.
1490  *
1491  * The parameter is a string that should follow the rules for
1492  * mkstemp() templates, i.e. contain the string "XXXXXX".
1493  * g_mkstemp() is slightly more flexible than mkstemp() in that the
1494  * sequence does not have to occur at the very end of the template.
1495  * The X string will be modified to form the name of a file that
1496  * didn't exist. The string should be in the GLib file name encoding.
1497  * Most importantly, on Windows it should be in UTF-8.
1498  *
1499  * Return value: A file handle (as from open()) to the file
1500  *     opened for reading and writing. The file is opened in binary
1501  *     mode on platforms where there is a difference. The file handle
1502  *     should be closed with close(). In case of errors, -1 is
1503  *     returned and %errno will be set.
1504  */
1505 gint
1506 g_mkstemp (gchar *tmpl)
1507 {
1508   return g_mkstemp_full (tmpl, O_RDWR | O_BINARY, 0600);
1509 }
1510
1511 static gint
1512 g_get_tmp_name (const gchar      *tmpl,
1513                 gchar           **name_used,
1514                 GTmpFileCallback  f,
1515                 gint              flags,
1516                 gint              mode,
1517                 GError          **error)
1518 {
1519   int retval;
1520   const char *tmpdir;
1521   const char *sep;
1522   char *fulltemplate;
1523   const char *slash;
1524
1525   if (tmpl == NULL)
1526     tmpl = ".XXXXXX";
1527
1528   if ((slash = strchr (tmpl, G_DIR_SEPARATOR)) != NULL
1529 #ifdef G_OS_WIN32
1530       || (strchr (tmpl, '/') != NULL && (slash = "/"))
1531 #endif
1532       )
1533     {
1534       gchar *display_tmpl = g_filename_display_name (tmpl);
1535       char c[2];
1536       c[0] = *slash;
1537       c[1] = '\0';
1538
1539       g_set_error (error,
1540                    G_FILE_ERROR,
1541                    G_FILE_ERROR_FAILED,
1542                    _("Template '%s' invalid, should not contain a '%s'"),
1543                    display_tmpl, c);
1544       g_free (display_tmpl);
1545
1546       return -1;
1547     }
1548
1549   if (strstr (tmpl, "XXXXXX") == NULL)
1550     {
1551       gchar *display_tmpl = g_filename_display_name (tmpl);
1552       g_set_error (error,
1553                    G_FILE_ERROR,
1554                    G_FILE_ERROR_FAILED,
1555                    _("Template '%s' doesn't contain XXXXXX"),
1556                    display_tmpl);
1557       g_free (display_tmpl);
1558       return -1;
1559     }
1560
1561   tmpdir = g_get_tmp_dir ();
1562
1563   if (G_IS_DIR_SEPARATOR (tmpdir [strlen (tmpdir) - 1]))
1564     sep = "";
1565   else
1566     sep = G_DIR_SEPARATOR_S;
1567
1568   fulltemplate = g_strconcat (tmpdir, sep, tmpl, NULL);
1569
1570   retval = get_tmp_file (fulltemplate, f, flags, mode);
1571   if (retval == -1)
1572     {
1573       int save_errno = errno;
1574       gchar *display_fulltemplate = g_filename_display_name (fulltemplate);
1575
1576       g_set_error (error,
1577                    G_FILE_ERROR,
1578                    g_file_error_from_errno (save_errno),
1579                    _("Failed to create file '%s': %s"),
1580                    display_fulltemplate, g_strerror (save_errno));
1581       g_free (display_fulltemplate);
1582       g_free (fulltemplate);
1583       return -1;
1584     }
1585
1586   *name_used = fulltemplate;
1587
1588   return retval;
1589 }
1590
1591 /**
1592  * g_file_open_tmp:
1593  * @tmpl: (type filename) (allow-none): Template for file name, as in
1594  *     g_mkstemp(), basename only, or %NULL for a default template
1595  * @name_used: (out) (type filename): location to store actual name used,
1596  *     or %NULL
1597  * @error: return location for a #GError
1598  *
1599  * Opens a file for writing in the preferred directory for temporary
1600  * files (as returned by g_get_tmp_dir()).
1601  *
1602  * @tmpl should be a string in the GLib file name encoding containing
1603  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1604  * However, unlike these functions, the template should only be a
1605  * basename, no directory components are allowed. If template is
1606  * %NULL, a default template is used.
1607  *
1608  * Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
1609  * modified, and might thus be a read-only literal string.
1610  *
1611  * Upon success, and if @name_used is non-%NULL, the actual name used
1612  * is returned in @name_used. This string should be freed with g_free()
1613  * when not needed any longer. The returned name is in the GLib file
1614  * name encoding.
1615  *
1616  * Return value: A file handle (as from open()) to the file opened for
1617  *     reading and writing. The file is opened in binary mode on platforms
1618  *     where there is a difference. The file handle should be closed with
1619  *     close(). In case of errors, -1 is returned and @error will be set.
1620  */
1621 gint
1622 g_file_open_tmp (const gchar  *tmpl,
1623                  gchar       **name_used,
1624                  GError      **error)
1625 {
1626   gchar *fulltemplate;
1627   gint result;
1628
1629   result = g_get_tmp_name (tmpl, &fulltemplate,
1630                            (GTmpFileCallback) g_open,
1631                            O_CREAT | O_EXCL | O_RDWR | O_BINARY,
1632                            0600,
1633                            error);
1634   if (result != -1)
1635     {
1636       if (name_used)
1637         *name_used = fulltemplate;
1638       else
1639         g_free (fulltemplate);
1640     }
1641
1642   return result;
1643 }
1644
1645 /**
1646  * g_dir_make_tmp:
1647  * @tmpl: (type filename) (allow-none): Template for directory name,
1648  *     as in g_mkdtemp(), basename only, or %NULL for a default template
1649  * @error: return location for a #GError
1650  *
1651  * Creates a subdirectory in the preferred directory for temporary
1652  * files (as returned by g_get_tmp_dir()).
1653  *
1654  * @tmpl should be a string in the GLib file name encoding containing
1655  * a sequence of six 'X' characters, as the parameter to g_mkstemp().
1656  * However, unlike these functions, the template should only be a
1657  * basename, no directory components are allowed. If template is
1658  * %NULL, a default template is used.
1659  *
1660  * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
1661  * modified, and might thus be a read-only literal string.
1662  *
1663  * Return value: (type filename): The actual name used. This string
1664  *     should be freed with g_free() when not needed any longer and is
1665  *     is in the GLib file name encoding. In case of errors, %NULL is
1666  *     returned and @error will be set.
1667  *
1668  * Since: 2.30
1669  */
1670 gchar *
1671 g_dir_make_tmp (const gchar  *tmpl,
1672                 GError      **error)
1673 {
1674   gchar *fulltemplate;
1675
1676   if (g_get_tmp_name (tmpl, &fulltemplate, wrap_mkdir, 0, 0700, error) == -1)
1677     return NULL;
1678   else
1679     return fulltemplate;
1680 }
1681
1682 static gchar *
1683 g_build_path_va (const gchar  *separator,
1684                  const gchar  *first_element,
1685                  va_list      *args,
1686                  gchar       **str_array)
1687 {
1688   GString *result;
1689   gint separator_len = strlen (separator);
1690   gboolean is_first = TRUE;
1691   gboolean have_leading = FALSE;
1692   const gchar *single_element = NULL;
1693   const gchar *next_element;
1694   const gchar *last_trailing = NULL;
1695   gint i = 0;
1696
1697   result = g_string_new (NULL);
1698
1699   if (str_array)
1700     next_element = str_array[i++];
1701   else
1702     next_element = first_element;
1703
1704   while (TRUE)
1705     {
1706       const gchar *element;
1707       const gchar *start;
1708       const gchar *end;
1709
1710       if (next_element)
1711         {
1712           element = next_element;
1713           if (str_array)
1714             next_element = str_array[i++];
1715           else
1716             next_element = va_arg (*args, gchar *);
1717         }
1718       else
1719         break;
1720
1721       /* Ignore empty elements */
1722       if (!*element)
1723         continue;
1724
1725       start = element;
1726
1727       if (separator_len)
1728         {
1729           while (strncmp (start, separator, separator_len) == 0)
1730             start += separator_len;
1731         }
1732
1733       end = start + strlen (start);
1734
1735       if (separator_len)
1736         {
1737           while (end >= start + separator_len &&
1738                  strncmp (end - separator_len, separator, separator_len) == 0)
1739             end -= separator_len;
1740
1741           last_trailing = end;
1742           while (last_trailing >= element + separator_len &&
1743                  strncmp (last_trailing - separator_len, separator, separator_len) == 0)
1744             last_trailing -= separator_len;
1745
1746           if (!have_leading)
1747             {
1748               /* If the leading and trailing separator strings are in the
1749                * same element and overlap, the result is exactly that element
1750                */
1751               if (last_trailing <= start)
1752                 single_element = element;
1753
1754               g_string_append_len (result, element, start - element);
1755               have_leading = TRUE;
1756             }
1757           else
1758             single_element = NULL;
1759         }
1760
1761       if (end == start)
1762         continue;
1763
1764       if (!is_first)
1765         g_string_append (result, separator);
1766
1767       g_string_append_len (result, start, end - start);
1768       is_first = FALSE;
1769     }
1770
1771   if (single_element)
1772     {
1773       g_string_free (result, TRUE);
1774       return g_strdup (single_element);
1775     }
1776   else
1777     {
1778       if (last_trailing)
1779         g_string_append (result, last_trailing);
1780
1781       return g_string_free (result, FALSE);
1782     }
1783 }
1784
1785 /**
1786  * g_build_pathv:
1787  * @separator: a string used to separator the elements of the path.
1788  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1789  *
1790  * Behaves exactly like g_build_path(), but takes the path elements
1791  * as a string array, instead of varargs. This function is mainly
1792  * meant for language bindings.
1793  *
1794  * Return value: a newly-allocated string that must be freed with g_free().
1795  *
1796  * Since: 2.8
1797  */
1798 gchar *
1799 g_build_pathv (const gchar  *separator,
1800                gchar       **args)
1801 {
1802   if (!args)
1803     return NULL;
1804
1805   return g_build_path_va (separator, NULL, NULL, args);
1806 }
1807
1808
1809 /**
1810  * g_build_path:
1811  * @separator: a string used to separator the elements of the path.
1812  * @first_element: the first element in the path
1813  * @...: remaining elements in path, terminated by %NULL
1814  *
1815  * Creates a path from a series of elements using @separator as the
1816  * separator between elements. At the boundary between two elements,
1817  * any trailing occurrences of separator in the first element, or
1818  * leading occurrences of separator in the second element are removed
1819  * and exactly one copy of the separator is inserted.
1820  *
1821  * Empty elements are ignored.
1822  *
1823  * The number of leading copies of the separator on the result is
1824  * the same as the number of leading copies of the separator on
1825  * the first non-empty element.
1826  *
1827  * The number of trailing copies of the separator on the result is
1828  * the same as the number of trailing copies of the separator on
1829  * the last non-empty element. (Determination of the number of
1830  * trailing copies is done without stripping leading copies, so
1831  * if the separator is <literal>ABA</literal>, <literal>ABABA</literal>
1832  * has 1 trailing copy.)
1833  *
1834  * However, if there is only a single non-empty element, and there
1835  * are no characters in that element not part of the leading or
1836  * trailing separators, then the result is exactly the original value
1837  * of that element.
1838  *
1839  * Other than for determination of the number of leading and trailing
1840  * copies of the separator, elements consisting only of copies
1841  * of the separator are ignored.
1842  *
1843  * Return value: a newly-allocated string that must be freed with g_free().
1844  **/
1845 gchar *
1846 g_build_path (const gchar *separator,
1847               const gchar *first_element,
1848               ...)
1849 {
1850   gchar *str;
1851   va_list args;
1852
1853   g_return_val_if_fail (separator != NULL, NULL);
1854
1855   va_start (args, first_element);
1856   str = g_build_path_va (separator, first_element, &args, NULL);
1857   va_end (args);
1858
1859   return str;
1860 }
1861
1862 #ifdef G_OS_WIN32
1863
1864 static gchar *
1865 g_build_pathname_va (const gchar  *first_element,
1866                      va_list      *args,
1867                      gchar       **str_array)
1868 {
1869   /* Code copied from g_build_pathv(), and modified to use two
1870    * alternative single-character separators.
1871    */
1872   GString *result;
1873   gboolean is_first = TRUE;
1874   gboolean have_leading = FALSE;
1875   const gchar *single_element = NULL;
1876   const gchar *next_element;
1877   const gchar *last_trailing = NULL;
1878   gchar current_separator = '\\';
1879   gint i = 0;
1880
1881   result = g_string_new (NULL);
1882
1883   if (str_array)
1884     next_element = str_array[i++];
1885   else
1886     next_element = first_element;
1887
1888   while (TRUE)
1889     {
1890       const gchar *element;
1891       const gchar *start;
1892       const gchar *end;
1893
1894       if (next_element)
1895         {
1896           element = next_element;
1897           if (str_array)
1898             next_element = str_array[i++];
1899           else
1900             next_element = va_arg (*args, gchar *);
1901         }
1902       else
1903         break;
1904
1905       /* Ignore empty elements */
1906       if (!*element)
1907         continue;
1908
1909       start = element;
1910
1911       if (TRUE)
1912         {
1913           while (start &&
1914                  (*start == '\\' || *start == '/'))
1915             {
1916               current_separator = *start;
1917               start++;
1918             }
1919         }
1920
1921       end = start + strlen (start);
1922
1923       if (TRUE)
1924         {
1925           while (end >= start + 1 &&
1926                  (end[-1] == '\\' || end[-1] == '/'))
1927             {
1928               current_separator = end[-1];
1929               end--;
1930             }
1931
1932           last_trailing = end;
1933           while (last_trailing >= element + 1 &&
1934                  (last_trailing[-1] == '\\' || last_trailing[-1] == '/'))
1935             last_trailing--;
1936
1937           if (!have_leading)
1938             {
1939               /* If the leading and trailing separator strings are in the
1940                * same element and overlap, the result is exactly that element
1941                */
1942               if (last_trailing <= start)
1943                 single_element = element;
1944
1945               g_string_append_len (result, element, start - element);
1946               have_leading = TRUE;
1947             }
1948           else
1949             single_element = NULL;
1950         }
1951
1952       if (end == start)
1953         continue;
1954
1955       if (!is_first)
1956         g_string_append_len (result, &current_separator, 1);
1957
1958       g_string_append_len (result, start, end - start);
1959       is_first = FALSE;
1960     }
1961
1962   if (single_element)
1963     {
1964       g_string_free (result, TRUE);
1965       return g_strdup (single_element);
1966     }
1967   else
1968     {
1969       if (last_trailing)
1970         g_string_append (result, last_trailing);
1971
1972       return g_string_free (result, FALSE);
1973     }
1974 }
1975
1976 #endif
1977
1978 /**
1979  * g_build_filenamev:
1980  * @args: (array zero-terminated=1): %NULL-terminated array of strings containing the path elements.
1981  *
1982  * Behaves exactly like g_build_filename(), but takes the path elements
1983  * as a string array, instead of varargs. This function is mainly
1984  * meant for language bindings.
1985  *
1986  * Return value: a newly-allocated string that must be freed with g_free().
1987  *
1988  * Since: 2.8
1989  */
1990 gchar *
1991 g_build_filenamev (gchar **args)
1992 {
1993   gchar *str;
1994
1995 #ifndef G_OS_WIN32
1996   str = g_build_path_va (G_DIR_SEPARATOR_S, NULL, NULL, args);
1997 #else
1998   str = g_build_pathname_va (NULL, NULL, args);
1999 #endif
2000
2001   return str;
2002 }
2003
2004 /**
2005  * g_build_filename:
2006  * @first_element: the first element in the path
2007  * @...: remaining elements in path, terminated by %NULL
2008  *
2009  * Creates a filename from a series of elements using the correct
2010  * separator for filenames.
2011  *
2012  * On Unix, this function behaves identically to <literal>g_build_path
2013  * (G_DIR_SEPARATOR_S, first_element, ....)</literal>.
2014  *
2015  * On Windows, it takes into account that either the backslash
2016  * (<literal>\</literal> or slash (<literal>/</literal>) can be used
2017  * as separator in filenames, but otherwise behaves as on Unix. When
2018  * file pathname separators need to be inserted, the one that last
2019  * previously occurred in the parameters (reading from left to right)
2020  * is used.
2021  *
2022  * No attempt is made to force the resulting filename to be an absolute
2023  * path. If the first element is a relative path, the result will
2024  * be a relative path.
2025  *
2026  * Return value: a newly-allocated string that must be freed with g_free().
2027  **/
2028 gchar *
2029 g_build_filename (const gchar *first_element,
2030                   ...)
2031 {
2032   gchar *str;
2033   va_list args;
2034
2035   va_start (args, first_element);
2036 #ifndef G_OS_WIN32
2037   str = g_build_path_va (G_DIR_SEPARATOR_S, first_element, &args, NULL);
2038 #else
2039   str = g_build_pathname_va (first_element, &args, NULL);
2040 #endif
2041   va_end (args);
2042
2043   return str;
2044 }
2045
2046 /**
2047  * g_file_read_link:
2048  * @filename: the symbolic link
2049  * @error: return location for a #GError
2050  *
2051  * Reads the contents of the symbolic link @filename like the POSIX
2052  * readlink() function.  The returned string is in the encoding used
2053  * for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
2054  *
2055  * Returns: A newly-allocated string with the contents of the symbolic link,
2056  *          or %NULL if an error occurred.
2057  *
2058  * Since: 2.4
2059  */
2060 gchar *
2061 g_file_read_link (const gchar  *filename,
2062                   GError      **error)
2063 {
2064 #ifdef HAVE_READLINK
2065   gchar *buffer;
2066   guint size;
2067   gint read_size;
2068
2069   size = 256;
2070   buffer = g_malloc (size);
2071
2072   while (TRUE)
2073     {
2074       read_size = readlink (filename, buffer, size);
2075       if (read_size < 0) {
2076         int save_errno = errno;
2077         gchar *display_filename = g_filename_display_name (filename);
2078
2079         g_free (buffer);
2080         g_set_error (error,
2081                      G_FILE_ERROR,
2082                      g_file_error_from_errno (save_errno),
2083                      _("Failed to read the symbolic link '%s': %s"),
2084                      display_filename,
2085                      g_strerror (save_errno));
2086         g_free (display_filename);
2087
2088         return NULL;
2089       }
2090
2091       if (read_size < size)
2092         {
2093           buffer[read_size] = 0;
2094           return buffer;
2095         }
2096
2097       size *= 2;
2098       buffer = g_realloc (buffer, size);
2099     }
2100 #else
2101   g_set_error_literal (error,
2102                        G_FILE_ERROR,
2103                        G_FILE_ERROR_INVAL,
2104                        _("Symbolic links not supported"));
2105
2106   return NULL;
2107 #endif
2108 }
2109
2110 /**
2111  * g_path_is_absolute:
2112  * @file_name: a file name
2113  *
2114  * Returns %TRUE if the given @file_name is an absolute file name.
2115  * Note that this is a somewhat vague concept on Windows.
2116  *
2117  * On POSIX systems, an absolute file name is well-defined. It always
2118  * starts from the single root directory. For example "/usr/local".
2119  *
2120  * On Windows, the concepts of current drive and drive-specific
2121  * current directory introduce vagueness. This function interprets as
2122  * an absolute file name one that either begins with a directory
2123  * separator such as "\Users\tml" or begins with the root on a drive,
2124  * for example "C:\Windows". The first case also includes UNC paths
2125  * such as "\\myserver\docs\foo". In all cases, either slashes or
2126  * backslashes are accepted.
2127  *
2128  * Note that a file name relative to the current drive root does not
2129  * truly specify a file uniquely over time and across processes, as
2130  * the current drive is a per-process value and can be changed.
2131  *
2132  * File names relative the current directory on some specific drive,
2133  * such as "D:foo/bar", are not interpreted as absolute by this
2134  * function, but they obviously are not relative to the normal current
2135  * directory as returned by getcwd() or g_get_current_dir()
2136  * either. Such paths should be avoided, or need to be handled using
2137  * Windows-specific code.
2138  *
2139  * Returns: %TRUE if @file_name is absolute
2140  */
2141 gboolean
2142 g_path_is_absolute (const gchar *file_name)
2143 {
2144   g_return_val_if_fail (file_name != NULL, FALSE);
2145
2146   if (G_IS_DIR_SEPARATOR (file_name[0]))
2147     return TRUE;
2148
2149 #ifdef G_OS_WIN32
2150   /* Recognize drive letter on native Windows */
2151   if (g_ascii_isalpha (file_name[0]) &&
2152       file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
2153     return TRUE;
2154 #endif
2155
2156   return FALSE;
2157 }
2158
2159 /**
2160  * g_path_skip_root:
2161  * @file_name: a file name
2162  *
2163  * Returns a pointer into @file_name after the root component,
2164  * i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name
2165  * is not an absolute path it returns %NULL.
2166  *
2167  * Returns: a pointer into @file_name after the root component
2168  */
2169 const gchar *
2170 g_path_skip_root (const gchar *file_name)
2171 {
2172   g_return_val_if_fail (file_name != NULL, NULL);
2173
2174 #ifdef G_PLATFORM_WIN32
2175   /* Skip \\server\share or //server/share */
2176   if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2177       G_IS_DIR_SEPARATOR (file_name[1]) &&
2178       file_name[2] &&
2179       !G_IS_DIR_SEPARATOR (file_name[2]))
2180     {
2181       gchar *p;
2182       p = strchr (file_name + 2, G_DIR_SEPARATOR);
2183
2184 #ifdef G_OS_WIN32
2185       {
2186         gchar *q;
2187
2188         q = strchr (file_name + 2, '/');
2189         if (p == NULL || (q != NULL && q < p))
2190         p = q;
2191       }
2192 #endif
2193
2194       if (p && p > file_name + 2 && p[1])
2195         {
2196           file_name = p + 1;
2197
2198           while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
2199             file_name++;
2200
2201           /* Possibly skip a backslash after the share name */
2202           if (G_IS_DIR_SEPARATOR (file_name[0]))
2203             file_name++;
2204
2205           return (gchar *)file_name;
2206         }
2207     }
2208 #endif
2209
2210   /* Skip initial slashes */
2211   if (G_IS_DIR_SEPARATOR (file_name[0]))
2212     {
2213       while (G_IS_DIR_SEPARATOR (file_name[0]))
2214         file_name++;
2215       return (gchar *)file_name;
2216     }
2217
2218 #ifdef G_OS_WIN32
2219   /* Skip X:\ */
2220   if (g_ascii_isalpha (file_name[0]) &&
2221       file_name[1] == ':' &&
2222       G_IS_DIR_SEPARATOR (file_name[2]))
2223     return (gchar *)file_name + 3;
2224 #endif
2225
2226   return NULL;
2227 }
2228
2229 /**
2230  * g_basename:
2231  * @file_name: the name of the file
2232  *
2233  * Gets the name of the file without any leading directory
2234  * components. It returns a pointer into the given file name
2235  * string.
2236  *
2237  * Return value: the name of the file without any leading
2238  *     directory components
2239  *
2240  * Deprecated:2.2: Use g_path_get_basename() instead, but notice
2241  *     that g_path_get_basename() allocates new memory for the
2242  *     returned string, unlike this function which returns a pointer
2243  *     into the argument.
2244  */
2245 const gchar *
2246 g_basename (const gchar *file_name)
2247 {
2248   gchar *base;
2249
2250   g_return_val_if_fail (file_name != NULL, NULL);
2251
2252   base = strrchr (file_name, G_DIR_SEPARATOR);
2253
2254 #ifdef G_OS_WIN32
2255   {
2256     gchar *q;
2257     q = strrchr (file_name, '/');
2258     if (base == NULL || (q != NULL && q > base))
2259       base = q;
2260   }
2261 #endif
2262
2263   if (base)
2264     return base + 1;
2265
2266 #ifdef G_OS_WIN32
2267   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2268     return (gchar*) file_name + 2;
2269 #endif
2270
2271   return (gchar*) file_name;
2272 }
2273
2274 /**
2275  * g_path_get_basename:
2276  * @file_name: the name of the file
2277  *
2278  * Gets the last component of the filename.
2279  *
2280  * If @file_name ends with a directory separator it gets the component
2281  * before the last slash. If @file_name consists only of directory
2282  * separators (and on Windows, possibly a drive letter), a single
2283  * separator is returned. If @file_name is empty, it gets ".".
2284  *
2285  * Return value: a newly allocated string containing the last
2286  *    component of the filename
2287  */
2288 gchar *
2289 g_path_get_basename (const gchar *file_name)
2290 {
2291   gssize base;
2292   gssize last_nonslash;
2293   gsize len;
2294   gchar *retval;
2295
2296   g_return_val_if_fail (file_name != NULL, NULL);
2297
2298   if (file_name[0] == '\0')
2299     return g_strdup (".");
2300
2301   last_nonslash = strlen (file_name) - 1;
2302
2303   while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
2304     last_nonslash--;
2305
2306   if (last_nonslash == -1)
2307     /* string only containing slashes */
2308     return g_strdup (G_DIR_SEPARATOR_S);
2309
2310 #ifdef G_OS_WIN32
2311   if (last_nonslash == 1 &&
2312       g_ascii_isalpha (file_name[0]) &&
2313       file_name[1] == ':')
2314     /* string only containing slashes and a drive */
2315     return g_strdup (G_DIR_SEPARATOR_S);
2316 #endif
2317   base = last_nonslash;
2318
2319   while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
2320     base--;
2321
2322 #ifdef G_OS_WIN32
2323   if (base == -1 &&
2324       g_ascii_isalpha (file_name[0]) &&
2325       file_name[1] == ':')
2326     base = 1;
2327 #endif /* G_OS_WIN32 */
2328
2329   len = last_nonslash - base;
2330   retval = g_malloc (len + 1);
2331   memcpy (retval, file_name + base + 1, len);
2332   retval [len] = '\0';
2333
2334   return retval;
2335 }
2336
2337 /**
2338  * g_dirname:
2339  * @file_name: the name of the file
2340  *
2341  * Gets the directory components of a file name.
2342  *
2343  * If the file name has no directory components "." is returned.
2344  * The returned string should be freed when no longer needed.
2345  *
2346  * Returns: the directory components of the file
2347  *
2348  * Deprecated: use g_path_get_dirname() instead
2349  */
2350
2351 /**
2352  * g_path_get_dirname:
2353  * @file_name: the name of the file
2354  *
2355  * Gets the directory components of a file name.
2356  *
2357  * If the file name has no directory components "." is returned.
2358  * The returned string should be freed when no longer needed.
2359  *
2360  * Returns: the directory components of the file
2361  */
2362 gchar *
2363 g_path_get_dirname (const gchar *file_name)
2364 {
2365   gchar *base;
2366   gsize len;
2367
2368   g_return_val_if_fail (file_name != NULL, NULL);
2369
2370   base = strrchr (file_name, G_DIR_SEPARATOR);
2371
2372 #ifdef G_OS_WIN32
2373   {
2374     gchar *q;
2375     q = strrchr (file_name, '/');
2376     if (base == NULL || (q != NULL && q > base))
2377       base = q;
2378   }
2379 #endif
2380
2381   if (!base)
2382     {
2383 #ifdef G_OS_WIN32
2384       if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
2385         {
2386           gchar drive_colon_dot[4];
2387
2388           drive_colon_dot[0] = file_name[0];
2389           drive_colon_dot[1] = ':';
2390           drive_colon_dot[2] = '.';
2391           drive_colon_dot[3] = '\0';
2392
2393           return g_strdup (drive_colon_dot);
2394         }
2395 #endif
2396     return g_strdup (".");
2397     }
2398
2399   while (base > file_name && G_IS_DIR_SEPARATOR (*base))
2400     base--;
2401
2402 #ifdef G_OS_WIN32
2403   /* base points to the char before the last slash.
2404    *
2405    * In case file_name is the root of a drive (X:\) or a child of the
2406    * root of a drive (X:\foo), include the slash.
2407    *
2408    * In case file_name is the root share of an UNC path
2409    * (\\server\share), add a slash, returning \\server\share\ .
2410    *
2411    * In case file_name is a direct child of a share in an UNC path
2412    * (\\server\share\foo), include the slash after the share name,
2413    * returning \\server\share\ .
2414    */
2415   if (base == file_name + 1 &&
2416       g_ascii_isalpha (file_name[0]) &&
2417       file_name[1] == ':')
2418     base++;
2419   else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
2420            G_IS_DIR_SEPARATOR (file_name[1]) &&
2421            file_name[2] &&
2422            !G_IS_DIR_SEPARATOR (file_name[2]) &&
2423            base >= file_name + 2)
2424     {
2425       const gchar *p = file_name + 2;
2426       while (*p && !G_IS_DIR_SEPARATOR (*p))
2427         p++;
2428       if (p == base + 1)
2429         {
2430           len = (guint) strlen (file_name) + 1;
2431           base = g_new (gchar, len + 1);
2432           strcpy (base, file_name);
2433           base[len-1] = G_DIR_SEPARATOR;
2434           base[len] = 0;
2435           return base;
2436         }
2437       if (G_IS_DIR_SEPARATOR (*p))
2438         {
2439           p++;
2440           while (*p && !G_IS_DIR_SEPARATOR (*p))
2441             p++;
2442           if (p == base + 1)
2443             base++;
2444         }
2445     }
2446 #endif
2447
2448   len = (guint) 1 + base - file_name;
2449   base = g_new (gchar, len + 1);
2450   g_memmove (base, file_name, len);
2451   base[len] = 0;
2452
2453   return base;
2454 }
2455
2456 #if defined(MAXPATHLEN)
2457 #define G_PATH_LENGTH MAXPATHLEN
2458 #elif defined(PATH_MAX)
2459 #define G_PATH_LENGTH PATH_MAX
2460 #elif defined(_PC_PATH_MAX)
2461 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
2462 #else
2463 #define G_PATH_LENGTH 2048
2464 #endif
2465
2466 /**
2467  * g_get_current_dir:
2468  *
2469  * Gets the current directory.
2470  *
2471  * The returned string should be freed when no longer needed.
2472  * The encoding of the returned string is system defined.
2473  * On Windows, it is always UTF-8.
2474  *
2475  * Returns: the current directory
2476  */
2477 gchar *
2478 g_get_current_dir (void)
2479 {
2480 #ifdef G_OS_WIN32
2481
2482   gchar *dir = NULL;
2483   wchar_t dummy[2], *wdir;
2484   int len;
2485
2486   len = GetCurrentDirectoryW (2, dummy);
2487   wdir = g_new (wchar_t, len);
2488
2489   if (GetCurrentDirectoryW (len, wdir) == len - 1)
2490     dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
2491
2492   g_free (wdir);
2493
2494   if (dir == NULL)
2495     dir = g_strdup ("\\");
2496
2497   return dir;
2498
2499 #else
2500
2501   gchar *buffer = NULL;
2502   gchar *dir = NULL;
2503   static gulong max_len = 0;
2504
2505   if (max_len == 0)
2506     max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
2507
2508   /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
2509    * and, if that wasn't bad enough, hangs in doing so.
2510    */
2511 #if (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
2512   buffer = g_new (gchar, max_len + 1);
2513   *buffer = 0;
2514   dir = getwd (buffer);
2515 #else
2516   while (max_len < G_MAXULONG / 2)
2517     {
2518       g_free (buffer);
2519       buffer = g_new (gchar, max_len + 1);
2520       *buffer = 0;
2521       dir = getcwd (buffer, max_len);
2522
2523       if (dir || errno != ERANGE)
2524         break;
2525
2526       max_len *= 2;
2527     }
2528 #endif  /* !sun || !HAVE_GETCWD */
2529
2530   if (!dir || !*buffer)
2531     {
2532       /* hm, should we g_error() out here?
2533        * this can happen if e.g. "./" has mode \0000
2534        */
2535       buffer[0] = G_DIR_SEPARATOR;
2536       buffer[1] = 0;
2537     }
2538
2539   dir = g_strdup (buffer);
2540   g_free (buffer);
2541
2542   return dir;
2543
2544 #endif /* !G_OS_WIN32 */
2545 }
2546
2547
2548 /* NOTE : Keep this part last to ensure nothing in this file uses thn
2549  * below binary compatibility versions.
2550  */
2551 #if defined (G_OS_WIN32) && !defined (_WIN64)
2552
2553 /* Binary compatibility versions. Will be called by code compiled
2554  * against quite old (pre-2.8, I think) headers only, not from more
2555  * recently compiled code.
2556  */
2557
2558 #undef g_file_test
2559
2560 gboolean
2561 g_file_test (const gchar *filename,
2562              GFileTest    test)
2563 {
2564   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2565   gboolean retval;
2566
2567   if (utf8_filename == NULL)
2568     return FALSE;
2569
2570   retval = g_file_test_utf8 (utf8_filename, test);
2571
2572   g_free (utf8_filename);
2573
2574   return retval;
2575 }
2576
2577 #undef g_file_get_contents
2578
2579 gboolean
2580 g_file_get_contents (const gchar  *filename,
2581                      gchar       **contents,
2582                      gsize        *length,
2583                      GError      **error)
2584 {
2585   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, error);
2586   gboolean retval;
2587
2588   if (utf8_filename == NULL)
2589     return FALSE;
2590
2591   retval = g_file_get_contents_utf8 (utf8_filename, contents, length, error);
2592
2593   g_free (utf8_filename);
2594
2595   return retval;
2596 }
2597
2598 #undef g_mkstemp
2599
2600 gint
2601 g_mkstemp (gchar *tmpl)
2602 {
2603   /* This is the backward compatibility system codepage version,
2604    * thus use normal open().
2605    */
2606   return get_tmp_file (tmpl, (GTmpFileCallback) open,
2607                        O_RDWR | O_CREAT | O_EXCL, 0600);
2608 }
2609
2610 #undef g_file_open_tmp
2611
2612 gint
2613 g_file_open_tmp (const gchar  *tmpl,
2614                  gchar       **name_used,
2615                  GError      **error)
2616 {
2617   gchar *utf8_tmpl = g_locale_to_utf8 (tmpl, -1, NULL, NULL, error);
2618   gchar *utf8_name_used;
2619   gint retval;
2620
2621   if (utf8_tmpl == NULL)
2622     return -1;
2623
2624   retval = g_file_open_tmp_utf8 (utf8_tmpl, &utf8_name_used, error);
2625
2626   if (retval == -1)
2627     return -1;
2628
2629   if (name_used)
2630     *name_used = g_locale_from_utf8 (utf8_name_used, -1, NULL, NULL, NULL);
2631
2632   g_free (utf8_name_used);
2633
2634   return retval;
2635 }
2636
2637 #undef g_get_current_dir
2638
2639 gchar *
2640 g_get_current_dir (void)
2641 {
2642   gchar *utf8_dir = g_get_current_dir_utf8 ();
2643   gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
2644   g_free (utf8_dir);
2645   return dir;
2646 }
2647
2648 #endif
2649