glib/gutils.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1998  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /*
  28  * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
  29  */
  30
  31 #include "config.h"
  32
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36 #include <stdarg.h>
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <locale.h>
  40 #include <string.h>
  41 #include <ctype.h>              /* For tolower() */
  42 #include <errno.h>
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #ifdef HAVE_PWD_H
  46 #include <pwd.h>
  47 #endif
  48 #include <sys/types.h>
  49 #ifdef HAVE_SYS_PARAM_H
  50 #include <sys/param.h>
  51 #endif
  52 #ifdef HAVE_CRT_EXTERNS_H
  53 #include <crt_externs.h> /* for _NSGetEnviron */
  54 #endif
  55
  56 /* implement gutils's inline functions
  57  */
  58 #define G_IMPLEMENT_INLINES 1
  59 #define __G_UTILS_C__
  60 #include "gutils.h"
  61
  62 #include "glib-init.h"
  63 #include "glib-private.h"
  64 #include "genviron.h"
  65 #include "gfileutils.h"
  66 #include "ggettext.h"
  67 #include "ghash.h"
  68 #include "gthread.h"
  69 #include "gtestutils.h"
  70 #include "gunicode.h"
  71 #include "gstrfuncs.h"
  72 #include "garray.h"
  73 #include "glibintl.h"
  74
  75 #ifdef G_PLATFORM_WIN32
  76 #include "gconvert.h"
  77 #include "gwin32.h"
  78 #endif
  79
  80
  81 /**
  82  * SECTION:misc_utils
  83  * @title: Miscellaneous Utility Functions
  84  * @short_description: a selection of portable utility functions
  85  *
  86  * These are portable utility functions.
  87  */
  88
  89 #ifdef G_PLATFORM_WIN32
  90 #  include <windows.h>
  91 #  ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
  92 #    define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
  93 #    define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
  94 #  endif
  95 #  include <lmcons.h>           /* For UNLEN */
  96 #endif /* G_PLATFORM_WIN32 */
  97
  98 #ifdef G_OS_WIN32
  99 #  include <direct.h>
 100 #  include <shlobj.h>
 101    /* older SDK (e.g. msvc 5.0) does not have these*/
 102 #  ifndef CSIDL_MYMUSIC
 103 #    define CSIDL_MYMUSIC 13
 104 #  endif
 105 #  ifndef CSIDL_MYVIDEO
 106 #    define CSIDL_MYVIDEO 14
 107 #  endif
 108 #  ifndef CSIDL_INTERNET_CACHE
 109 #    define CSIDL_INTERNET_CACHE 32
 110 #  endif
 111 #  ifndef CSIDL_COMMON_APPDATA
 112 #    define CSIDL_COMMON_APPDATA 35
 113 #  endif
 114 #  ifndef CSIDL_MYPICTURES
 115 #    define CSIDL_MYPICTURES 0x27
 116 #  endif
 117 #  ifndef CSIDL_COMMON_DOCUMENTS
 118 #    define CSIDL_COMMON_DOCUMENTS 46
 119 #  endif
 120 #  ifndef CSIDL_PROFILE
 121 #    define CSIDL_PROFILE 40
 122 #  endif
 123 #  include <process.h>
 124 #endif
 125
 126 #ifdef HAVE_CARBON
 127 #include <CoreServices/CoreServices.h>
 128 #endif
 129
 130 #ifdef HAVE_CODESET
 131 #include <langinfo.h>
 132 #endif
 133
 134 #ifdef G_PLATFORM_WIN32
 135
 136 gchar *
 137 _glib_get_dll_directory (void)
 138 {
 139   gchar *retval;
 140   gchar *p;
 141   wchar_t wc_fn[MAX_PATH];
 142
 143 #ifdef DLL_EXPORT
 144   if (glib_dll == NULL)
 145     return NULL;
 146 #endif
 147
 148   /* This code is different from that in
 149    * g_win32_get_package_installation_directory_of_module() in that
 150    * here we return the actual folder where the GLib DLL is. We don't
 151    * do the check for it being in a "bin" or "lib" subfolder and then
 152    * returning the parent of that.
 153    *
 154    * In a statically built GLib, glib_dll will be NULL and we will
 155    * thus look up the application's .exe file's location.
 156    */
 157   if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
 158     return NULL;
 159
 160   retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
 161
 162   p = strrchr (retval, G_DIR_SEPARATOR);
 163   if (p == NULL)
 164     {
 165       /* Wtf? */
 166       return NULL;
 167     }
 168   *p = '\0';
 169
 170   return retval;
 171 }
 172
 173 #endif
 174
 175 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
 176 /**
 177  * g_memmove:
 178  * @dest: the destination address to copy the bytes to.
 179  * @src: the source address to copy the bytes from.
 180  * @len: the number of bytes to copy.
 181  *
 182  * Copies a block of memory @len bytes long, from @src to @dest.
 183  * The source and destination areas may overlap.
 184  *
 185  * In order to use this function, you must include
 186  * <filename>string.h</filename> yourself, because this macro will
 187  * typically simply resolve to memmove() and GLib does not include
 188  * <filename>string.h</filename> for you.
 189  */
 190 void
 191 g_memmove (gpointer      dest,
 192            gconstpointer src,
 193            gulong        len)
 194 {
 195   gchar* destptr = dest;
 196   const gchar* srcptr = src;
 197   if (src + len < dest || dest + len < src)
 198     {
 199       bcopy (src, dest, len);
 200       return;
 201     }
 202   else if (dest <= src)
 203     {
 204       while (len--)
 205         *(destptr++) = *(srcptr++);
 206     }
 207   else
 208     {
 209       destptr += len;
 210       srcptr += len;
 211       while (len--)
 212         *(--destptr) = *(--srcptr);
 213     }
 214 }
 215 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
 216
 217 #ifdef G_OS_WIN32
 218 #undef g_atexit
 219 #endif
 220
 221 /**
 222  * g_atexit:
 223  * @func: (scope async): the function to call on normal program termination.
 224  *
 225  * Specifies a function to be called at normal program termination.
 226  *
 227  * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
 228  * macro that maps to a call to the atexit() function in the C
 229  * library. This means that in case the code that calls g_atexit(),
 230  * i.e. atexit(), is in a DLL, the function will be called when the
 231  * DLL is detached from the program. This typically makes more sense
 232  * than that the function is called when the GLib DLL is detached,
 233  * which happened earlier when g_atexit() was a function in the GLib
 234  * DLL.
 235  *
 236  * The behaviour of atexit() in the context of dynamically loaded
 237  * modules is not formally specified and varies wildly.
 238  *
 239  * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
 240  * loaded module which is unloaded before the program terminates might
 241  * well cause a crash at program exit.
 242  *
 243  * Some POSIX systems implement atexit() like Windows, and have each
 244  * dynamically loaded module maintain an own atexit chain that is
 245  * called when the module is unloaded.
 246  *
 247  * On other POSIX systems, before a dynamically loaded module is
 248  * unloaded, the registered atexit functions (if any) residing in that
 249  * module are called, regardless where the code that registered them
 250  * resided. This is presumably the most robust approach.
 251  *
 252  * As can be seen from the above, for portability it's best to avoid
 253  * calling g_atexit() (or atexit()) except in the main executable of a
 254  * program.
 255  *
 256  * Deprecated:2.32: It is best to avoid g_atexit().
 257  */
 258 void
 259 g_atexit (GVoidFunc func)
 260 {
 261   gint result;
 262   const gchar *error = NULL;
 263
 264   /* keep this in sync with glib.h */
 265
 266 #ifdef  G_NATIVE_ATEXIT
 267   result = ATEXIT (func);
 268   if (result)
 269     error = g_strerror (errno);
 270 #elif defined (HAVE_ATEXIT)
 271 #  ifdef NeXT /* @#%@! NeXTStep */
 272   result = !atexit ((void (*)(void)) func);
 273   if (result)
 274     error = g_strerror (errno);
 275 #  else
 276   result = atexit ((void (*)(void)) func);
 277   if (result)
 278     error = g_strerror (errno);
 279 #  endif /* NeXT */
 280 #elif defined (HAVE_ON_EXIT)
 281   result = on_exit ((void (*)(int, void *)) func, NULL);
 282   if (result)
 283     error = g_strerror (errno);
 284 #else
 285   result = 0;
 286   error = "no implementation";
 287 #endif /* G_NATIVE_ATEXIT */
 288
 289   if (error)
 290     g_error ("Could not register atexit() function: %s", error);
 291 }
 292
 293 /* Based on execvp() from GNU Libc.
 294  * Some of this code is cut-and-pasted into gspawn.c
 295  */
 296
 297 static gchar*
 298 my_strchrnul (const gchar *str,
 299               gchar        c)
 300 {
 301   gchar *p = (gchar*)str;
 302   while (*p && (*p != c))
 303     ++p;
 304
 305   return p;
 306 }
 307
 308 #ifdef G_OS_WIN32
 309
 310 static gchar *inner_find_program_in_path (const gchar *program);
 311
 312 gchar*
 313 g_find_program_in_path (const gchar *program)
 314 {
 315   const gchar *last_dot = strrchr (program, '.');
 316
 317   if (last_dot == NULL ||
 318       strchr (last_dot, '\\') != NULL ||
 319       strchr (last_dot, '/') != NULL)
 320     {
 321       const gint program_length = strlen (program);
 322       gchar *pathext = g_build_path (";",
 323                                      ".exe;.cmd;.bat;.com",
 324                                      g_getenv ("PATHEXT"),
 325                                      NULL);
 326       gchar *p;
 327       gchar *decorated_program;
 328       gchar *retval;
 329
 330       p = pathext;
 331       do
 332         {
 333           gchar *q = my_strchrnul (p, ';');
 334
 335           decorated_program = g_malloc (program_length + (q-p) + 1);
 336           memcpy (decorated_program, program, program_length);
 337           memcpy (decorated_program+program_length, p, q-p);
 338           decorated_program [program_length + (q-p)] = '\0';
 339
 340           retval = inner_find_program_in_path (decorated_program);
 341           g_free (decorated_program);
 342
 343           if (retval != NULL)
 344             {
 345               g_free (pathext);
 346               return retval;
 347             }
 348           p = q;
 349         } while (*p++ != '\0');
 350       g_free (pathext);
 351       return NULL;
 352     }
 353   else
 354     return inner_find_program_in_path (program);
 355 }
 356
 357 #endif
 358
 359 /**
 360  * g_find_program_in_path:
 361  * @program: a program name in the GLib file name encoding
 362  *
 363  * Locates the first executable named @program in the user's path, in the
 364  * same way that execvp() would locate it. Returns an allocated string
 365  * with the absolute path name, or %NULL if the program is not found in
 366  * the path. If @program is already an absolute path, returns a copy of
 367  * @program if @program exists and is executable, and %NULL otherwise.
 368  *
 369  * On Windows, if @program does not have a file type suffix, tries
 370  * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
 371  * the <envar>PATHEXT</envar> environment variable.
 372  *
 373  * On Windows, it looks for the file in the same way as CreateProcess()
 374  * would. This means first in the directory where the executing
 375  * program was loaded from, then in the current directory, then in the
 376  * Windows 32-bit system directory, then in the Windows directory, and
 377  * finally in the directories in the <envar>PATH</envar> environment
 378  * variable. If the program is found, the return value contains the
 379  * full name including the type suffix.
 380  *
 381  * Return value: a newly-allocated string with the absolute path, or %NULL
 382  **/
 383 #ifdef G_OS_WIN32
 384 static gchar *
 385 inner_find_program_in_path (const gchar *program)
 386 #else
 387 gchar*
 388 g_find_program_in_path (const gchar *program)
 389 #endif
 390 {
 391   const gchar *path, *p;
 392   gchar *name, *freeme;
 393 #ifdef G_OS_WIN32
 394   const gchar *path_copy;
 395   gchar *filename = NULL, *appdir = NULL;
 396   gchar *sysdir = NULL, *windir = NULL;
 397   int n;
 398   wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
 399     wwindir[MAXPATHLEN];
 400 #endif
 401   gsize len;
 402   gsize pathlen;
 403
 404   g_return_val_if_fail (program != NULL, NULL);
 405
 406   /* If it is an absolute path, or a relative path including subdirectories,
 407    * don't look in PATH.
 408    */
 409   if (g_path_is_absolute (program)
 410       || strchr (program, G_DIR_SEPARATOR) != NULL
 411 #ifdef G_OS_WIN32
 412       || strchr (program, '/') != NULL
 413 #endif
 414       )
 415     {
 416       if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
 417           !g_file_test (program, G_FILE_TEST_IS_DIR))
 418         return g_strdup (program);
 419       else
 420         return NULL;
 421     }
 422
 423   path = g_getenv ("PATH");
 424 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
 425   if (path == NULL)
 426     {
 427       /* There is no 'PATH' in the environment.  The default
 428        * search path in GNU libc is the current directory followed by
 429        * the path 'confstr' returns for '_CS_PATH'.
 430        */
 431
 432       /* In GLib we put . last, for security, and don't use the
 433        * unportable confstr(); UNIX98 does not actually specify
 434        * what to search if PATH is unset. POSIX may, dunno.
 435        */
 436
 437       path = "/bin:/usr/bin:.";
 438     }
 439 #else
 440   n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
 441   if (n > 0 && n < MAXPATHLEN)
 442     filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
 443
 444   n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
 445   if (n > 0 && n < MAXPATHLEN)
 446     sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
 447
 448   n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
 449   if (n > 0 && n < MAXPATHLEN)
 450     windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
 451
 452   if (filename)
 453     {
 454       appdir = g_path_get_dirname (filename);
 455       g_free (filename);
 456     }
 457
 458   path = g_strdup (path);
 459
 460   if (windir)
 461     {
 462       const gchar *tem = path;
 463       path = g_strconcat (windir, ";", path, NULL);
 464       g_free ((gchar *) tem);
 465       g_free (windir);
 466     }
 467
 468   if (sysdir)
 469     {
 470       const gchar *tem = path;
 471       path = g_strconcat (sysdir, ";", path, NULL);
 472       g_free ((gchar *) tem);
 473       g_free (sysdir);
 474     }
 475
 476   {
 477     const gchar *tem = path;
 478     path = g_strconcat (".;", path, NULL);
 479     g_free ((gchar *) tem);
 480   }
 481
 482   if (appdir)
 483     {
 484       const gchar *tem = path;
 485       path = g_strconcat (appdir, ";", path, NULL);
 486       g_free ((gchar *) tem);
 487       g_free (appdir);
 488     }
 489
 490   path_copy = path;
 491 #endif
 492
 493   len = strlen (program) + 1;
 494   pathlen = strlen (path);
 495   freeme = name = g_malloc (pathlen + len + 1);
 496
 497   /* Copy the file name at the top, including '\0'  */
 498   memcpy (name + pathlen + 1, program, len);
 499   name = name + pathlen;
 500   /* And add the slash before the filename  */
 501   *name = G_DIR_SEPARATOR;
 502
 503   p = path;
 504   do
 505     {
 506       char *startp;
 507
 508       path = p;
 509       p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
 510
 511       if (p == path)
 512         /* Two adjacent colons, or a colon at the beginning or the end
 513          * of 'PATH' means to search the current directory.
 514          */
 515         startp = name + 1;
 516       else
 517         startp = memcpy (name - (p - path), path, p - path);
 518
 519       if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
 520           !g_file_test (startp, G_FILE_TEST_IS_DIR))
 521         {
 522           gchar *ret;
 523           ret = g_strdup (startp);
 524           g_free (freeme);
 525 #ifdef G_OS_WIN32
 526           g_free ((gchar *) path_copy);
 527 #endif
 528           return ret;
 529         }
 530     }
 531   while (*p++ != '\0');
 532
 533   g_free (freeme);
 534 #ifdef G_OS_WIN32
 535   g_free ((gchar *) path_copy);
 536 #endif
 537
 538   return NULL;
 539 }
 540
 541 /**
 542  * g_bit_nth_lsf:
 543  * @mask: a #gulong containing flags
 544  * @nth_bit: the index of the bit to start the search from
 545  *
 546  * Find the position of the first bit set in @mask, searching
 547  * from (but not including) @nth_bit upwards. Bits are numbered
 548  * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
 549  * usually). To start searching from the 0th bit, set @nth_bit to -1.
 550  *
 551  * Returns: the index of the first bit set which is higher than @nth_bit
 552  */
 553
 554 /**
 555  * g_bit_nth_msf:
 556  * @mask: a #gulong containing flags
 557  * @nth_bit: the index of the bit to start the search from
 558  *
 559  * Find the position of the first bit set in @mask, searching
 560  * from (but not including) @nth_bit downwards. Bits are numbered
 561  * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
 562  * usually). To start searching from the last bit, set @nth_bit to
 563  * -1 or GLIB_SIZEOF_LONG * 8.
 564  *
 565  * Returns: the index of the first bit set which is lower than @nth_bit
 566  */
 567
 568 /**
 569  * g_bit_storage:
 570  * @number: a #guint
 571  *
 572  * Gets the number of bits used to hold @number,
 573  * e.g. if @number is 4, 3 bits are needed.
 574  *
 575  * Returns: the number of bits used to hold @number
 576  */
 577
 578 G_LOCK_DEFINE_STATIC (g_utils_global);
 579
 580 typedef struct
 581 {
 582   gchar *user_name;
 583   gchar *real_name;
 584   gchar *home_dir;
 585 } UserDatabaseEntry;
 586
 587 static  gchar   *g_user_data_dir = NULL;
 588 static  gchar  **g_system_data_dirs = NULL;
 589 static  gchar   *g_user_cache_dir = NULL;
 590 static  gchar   *g_user_config_dir = NULL;
 591 static  gchar  **g_system_config_dirs = NULL;
 592
 593 static  gchar  **g_user_special_dirs = NULL;
 594
 595 /* fifteen minutes of fame for everybody */
 596 #define G_USER_DIRS_EXPIRE      15 * 60
 597
 598 #ifdef G_OS_WIN32
 599
 600 static gchar *
 601 get_special_folder (int csidl)
 602 {
 603   wchar_t path[MAX_PATH+1];
 604   HRESULT hr;
 605   LPITEMIDLIST pidl = NULL;
 606   BOOL b;
 607   gchar *retval = NULL;
 608
 609   hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
 610   if (hr == S_OK)
 611     {
 612       b = SHGetPathFromIDListW (pidl, path);
 613       if (b)
 614         retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
 615       CoTaskMemFree (pidl);
 616     }
 617   return retval;
 618 }
 619
 620 static char *
 621 get_windows_directory_root (void)
 622 {
 623   wchar_t wwindowsdir[MAX_PATH];
 624
 625   if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
 626     {
 627       /* Usually X:\Windows, but in terminal server environments
 628        * might be an UNC path, AFAIK.
 629        */
 630       char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
 631       char *p;
 632
 633       if (windowsdir == NULL)
 634         return g_strdup ("C:\\");
 635
 636       p = (char *) g_path_skip_root (windowsdir);
 637       if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
 638         p--;
 639       *p = '\0';
 640       return windowsdir;
 641     }
 642   else
 643     return g_strdup ("C:\\");
 644 }
 645
 646 #endif
 647
 648 /* HOLDS: g_utils_global_lock */
 649 static UserDatabaseEntry *
 650 g_get_user_database_entry (void)
 651 {
 652   static UserDatabaseEntry *entry;
 653
 654   if (g_once_init_enter (&entry))
 655     {
 656       static UserDatabaseEntry e;
 657
 658 #ifdef HAVE_PWD_H
 659       {
 660         struct passwd *pw = NULL;
 661         gpointer buffer = NULL;
 662         gint error;
 663         gchar *logname;
 664
 665 #  if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
 666         struct passwd pwd;
 667 #    ifdef _SC_GETPW_R_SIZE_MAX
 668         /* This reurns the maximum length */
 669         glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
 670
 671         if (bufsize < 0)
 672           bufsize = 64;
 673 #    else /* _SC_GETPW_R_SIZE_MAX */
 674         glong bufsize = 64;
 675 #    endif /* _SC_GETPW_R_SIZE_MAX */
 676
 677         logname = (gchar *) g_getenv ("LOGNAME");
 678
 679         do
 680           {
 681             g_free (buffer);
 682             /* we allocate 6 extra bytes to work around a bug in
 683              * Mac OS < 10.3. See #156446
 684              */
 685             buffer = g_malloc (bufsize + 6);
 686             errno = 0;
 687
 688 #    ifdef HAVE_POSIX_GETPWUID_R
 689             if (logname) {
 690               error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
 691               if (!pw || (pw->pw_uid != getuid ())) {
 692                 /* LOGNAME is lying, fall back to looking up the uid */
 693                 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
 694               }
 695             } else {
 696               error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
 697             }
 698             error = error < 0 ? errno : error;
 699 #    else /* HAVE_NONPOSIX_GETPWUID_R */
 700        /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
 701 #      if defined(_AIX) || defined(__hpux)
 702             error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 703             pw = error == 0 ? &pwd : NULL;
 704 #      else /* !_AIX */
 705             if (logname) {
 706               pw = getpwnam_r (logname, &pwd, buffer, bufsize);
 707               if (!pw || (pw->pw_uid != getuid ())) {
 708                 /* LOGNAME is lying, fall back to looking up the uid */
 709                 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 710               }
 711             } else {
 712               pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 713             }
 714             error = pw ? 0 : errno;
 715 #      endif /* !_AIX */
 716 #    endif /* HAVE_NONPOSIX_GETPWUID_R */
 717
 718             if (!pw)
 719               {
 720                 /* we bail out prematurely if the user id can't be found
 721                  * (should be pretty rare case actually), or if the buffer
 722                  * should be sufficiently big and lookups are still not
 723                  * successful.
 724                  */
 725                 if (error == 0 || error == ENOENT)
 726                   {
 727                     g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
 728                                (gulong) getuid ());
 729                     break;
 730                   }
 731                 if (bufsize > 32 * 1024)
 732                   {
 733                     g_warning ("getpwuid_r(): failed due to: %s.",
 734                                g_strerror (error));
 735                     break;
 736                   }
 737
 738                 bufsize *= 2;
 739               }
 740           }
 741         while (!pw);
 742 #  endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
 743
 744         if (!pw)
 745           {
 746             pw = getpwuid (getuid ());
 747           }
 748         if (pw)
 749           {
 750             e.user_name = g_strdup (pw->pw_name);
 751
 752 #ifndef __BIONIC__
 753             if (pw->pw_gecos && *pw->pw_gecos != '\0')
 754               {
 755                 gchar **gecos_fields;
 756                 gchar **name_parts;
 757
 758                 /* split the gecos field and substitute '&' */
 759                 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
 760                 name_parts = g_strsplit (gecos_fields[0], "&", 0);
 761                 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
 762                 e.real_name = g_strjoinv (pw->pw_name, name_parts);
 763                 g_strfreev (gecos_fields);
 764                 g_strfreev (name_parts);
 765               }
 766 #endif
 767
 768             if (!e.home_dir)
 769               e.home_dir = g_strdup (pw->pw_dir);
 770           }
 771         g_free (buffer);
 772       }
 773
 774 #else /* !HAVE_PWD_H */
 775
 776 #ifdef G_OS_WIN32
 777       {
 778         guint len = UNLEN+1;
 779         wchar_t buffer[UNLEN+1];
 780
 781         if (GetUserNameW (buffer, (LPDWORD) &len))
 782           {
 783             e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
 784             e.real_name = g_strdup (e.user_name);
 785           }
 786       }
 787 #endif /* G_OS_WIN32 */
 788
 789 #endif /* !HAVE_PWD_H */
 790
 791 #ifdef __EMX__
 792       /* change '\\' in %HOME% to '/' */
 793       g_strdelimit (e.home_dir, "\\",'/');
 794 #endif
 795       if (!e.user_name)
 796         e.user_name = g_strdup ("somebody");
 797       if (!e.real_name)
 798         e.real_name = g_strdup ("Unknown");
 799
 800       g_once_init_leave (&entry, &e);
 801     }
 802
 803   return entry;
 804 }
 805
 806 /**
 807  * g_get_user_name:
 808  *
 809  * Gets the user name of the current user. The encoding of the returned
 810  * string is system-defined. On UNIX, it might be the preferred file name
 811  * encoding, or something else, and there is no guarantee that it is even
 812  * consistent on a machine. On Windows, it is always UTF-8.
 813  *
 814  * Returns: the user name of the current user.
 815  */
 816 const gchar *
 817 g_get_user_name (void)
 818 {
 819   UserDatabaseEntry *entry;
 820
 821   entry = g_get_user_database_entry ();
 822
 823   return entry->user_name;
 824 }
 825
 826 /**
 827  * g_get_real_name:
 828  *
 829  * Gets the real name of the user. This usually comes from the user's entry
 830  * in the <filename>passwd</filename> file. The encoding of the returned
 831  * string is system-defined. (On Windows, it is, however, always UTF-8.)
 832  * If the real user name cannot be determined, the string "Unknown" is
 833  * returned.
 834  *
 835  * Returns: the user's real name.
 836  */
 837 const gchar *
 838 g_get_real_name (void)
 839 {
 840   UserDatabaseEntry *entry;
 841
 842   entry = g_get_user_database_entry ();
 843
 844   return entry->real_name;
 845 }
 846
 847 /**
 848  * g_get_home_dir:
 849  *
 850  * Gets the current user's home directory.
 851  *
 852  * As with most UNIX tools, this function will return the value of the
 853  * <envar>HOME</envar> environment variable if it is set to an existing
 854  * absolute path name, falling back to the <filename>passwd</filename>
 855  * file in the case that it is unset.
 856  *
 857  * If the path given in <envar>HOME</envar> is non-absolute, does not
 858  * exist, or is not a directory, the result is undefined.
 859  *
 860  * <note><para>
 861  *   Before version 2.36 this function would ignore the
 862  *   <envar>HOME</envar> environment variable, taking the value from the
 863  *   <filename>passwd</filename> database instead.  This was changed to
 864  *   increase the compatibility of GLib with other programs (and the XDG
 865  *   basedir specification) and to increase testability of programs
 866  *   based on GLib (by making it easier to run them from test
 867  *   frameworks).
 868  * </para><para>
 869  *   If your program has a strong requirement for either the new or the
 870  *   old behaviour (and if you don't wish to increase your GLib
 871  *   dependency to ensure that the new behaviour is in effect) then you
 872  *   should either directly check the <envar>HOME</envar> environment
 873  *   variable yourself or unset it before calling any functions in GLib.
 874  * </para></note>
 875  *
 876  * Returns: the current user's home directory
 877  */
 878 const gchar *
 879 g_get_home_dir (void)
 880 {
 881   static gchar *home_dir;
 882
 883   if (g_once_init_enter (&home_dir))
 884     {
 885       gchar *tmp;
 886
 887       /* We first check HOME and use it if it is set */
 888       tmp = g_strdup (g_getenv ("HOME"));
 889
 890 #ifdef G_OS_WIN32
 891       /* Only believe HOME if it is an absolute path and exists.
 892        *
 893        * We only do this check on Windows for a couple of reasons.
 894        * Historically, we only did it there because we used to ignore $HOME
 895        * on UNIX.  There are concerns about enabling it now on UNIX because
 896        * of things like autofs.  In short, if the user has a bogus value in
 897        * $HOME then they get what they pay for...
 898        */
 899       if (tmp)
 900         {
 901           if (!(g_path_is_absolute (tmp) &&
 902                 g_file_test (tmp, G_FILE_TEST_IS_DIR)))
 903             {
 904               g_free (tmp);
 905               tmp = NULL;
 906             }
 907         }
 908
 909       /* In case HOME is Unix-style (it happens), convert it to
 910        * Windows style.
 911        */
 912       if (tmp)
 913         {
 914           gchar *p;
 915           while ((p = strchr (tmp, '/')) != NULL)
 916             *p = '\\';
 917         }
 918
 919       if (!tmp)
 920         {
 921           /* USERPROFILE is probably the closest equivalent to $HOME? */
 922           if (g_getenv ("USERPROFILE") != NULL)
 923             tmp = g_strdup (g_getenv ("USERPROFILE"));
 924         }
 925
 926       if (!tmp)
 927         tmp = get_special_folder (CSIDL_PROFILE);
 928
 929       if (!tmp)
 930         tmp = get_windows_directory_root ();
 931 #endif /* G_OS_WIN32 */
 932
 933       if (!tmp)
 934         {
 935           /* If we didn't get it from any of those methods, we will have
 936            * to read the user database entry.
 937            */
 938           UserDatabaseEntry *entry;
 939
 940           entry = g_get_user_database_entry ();
 941
 942           /* Strictly speaking, we should copy this, but we know that
 943            * neither will ever be freed, so don't bother...
 944            */
 945           tmp = entry->home_dir;
 946         }
 947
 948       g_once_init_leave (&home_dir, tmp);
 949     }
 950
 951   return home_dir;
 952 }
 953
 954 /**
 955  * g_get_tmp_dir:
 956  *
 957  * Gets the directory to use for temporary files.
 958  *
 959  * On UNIX, this is taken from the <envar>TMPDIR</envar> environment
 960  * variable.  If the variable is not set, <literal>P_tmpdir</literal> is
 961  * used, as defined by the system C library.  Failing that, a hard-coded
 962  * default of "/tmp" is returned.
 963  *
 964  * On Windows, the <envar>TEMP</envar> environment variable is used,
 965  * with the root directory of the Windows installation (eg: "C:\") used
 966  * as a default.
 967  *
 968  * The encoding of the returned string is system-defined. On Windows, it
 969  * is always UTF-8. The return value is never %NULL or the empty string.
 970  *
 971  * Returns: the directory to use for temporary files.
 972  */
 973 const gchar *
 974 g_get_tmp_dir (void)
 975 {
 976   static gchar *tmp_dir;
 977
 978   if (g_once_init_enter (&tmp_dir))
 979     {
 980       gchar *tmp;
 981
 982 #ifdef G_OS_WIN32
 983       tmp = g_strdup (g_getenv ("TEMP"));
 984
 985       if (tmp == NULL || *tmp == '\0')
 986         {
 987           g_free (tmp);
 988           tmp = get_windows_directory_root ();
 989         }
 990 #else /* G_OS_WIN32 */
 991       tmp = g_strdup (g_getenv ("TMPDIR"));
 992
 993 #ifdef P_tmpdir
 994       if (tmp == NULL || *tmp == '\0')
 995         {
 996           gsize k;
 997           g_free (tmp);
 998           tmp = g_strdup (P_tmpdir);
 999           k = strlen (tmp);
1000           if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
1001             tmp[k - 1] = '\0';
1002         }
1003 #endif /* P_tmpdir */
1004
1005       if (tmp == NULL || *tmp == '\0')
1006         {
1007           g_free (tmp);
1008           tmp = g_strdup ("/tmp");
1009         }
1010 #endif /* !G_OS_WIN32 */
1011
1012       g_once_init_leave (&tmp_dir, tmp);
1013     }
1014
1015   return tmp_dir;
1016 }
1017
1018 /**
1019  * g_get_host_name:
1020  *
1021  * Return a name for the machine.
1022  *
1023  * The returned name is not necessarily a fully-qualified domain name,
1024  * or even present in DNS or some other name service at all. It need
1025  * not even be unique on your local network or site, but usually it
1026  * is. Callers should not rely on the return value having any specific
1027  * properties like uniqueness for security purposes. Even if the name
1028  * of the machine is changed while an application is running, the
1029  * return value from this function does not change. The returned
1030  * string is owned by GLib and should not be modified or freed. If no
1031  * name can be determined, a default fixed string "localhost" is
1032  * returned.
1033  *
1034  * Returns: the host name of the machine.
1035  *
1036  * Since: 2.8
1037  */
1038 const gchar *
1039 g_get_host_name (void)
1040 {
1041   static gchar *hostname;
1042
1043   if (g_once_init_enter (&hostname))
1044     {
1045       gboolean failed;
1046       gchar tmp[100];
1047
1048 #ifndef G_OS_WIN32
1049       failed = (gethostname (tmp, sizeof (tmp)) == -1);
1050 #else
1051       DWORD size = sizeof (tmp);
1052       failed = (!GetComputerName (tmp, &size));
1053 #endif
1054
1055       g_once_init_leave (&hostname, g_strdup (failed ? "localhost" : tmp));
1056     }
1057
1058   return hostname;
1059 }
1060
1061 G_LOCK_DEFINE_STATIC (g_prgname);
1062 static gchar *g_prgname = NULL;
1063
1064 /**
1065  * g_get_prgname:
1066  *
1067  * Gets the name of the program. This name should <emphasis>not</emphasis>
1068  * be localized, contrast with g_get_application_name().
1069  * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1070  * which is called by gtk_init(). The program name is found by taking
1071  * the last component of <literal>argv[0]</literal>.)
1072  *
1073  * Returns: the name of the program. The returned string belongs
1074  * to GLib and must not be modified or freed.
1075  */
1076 const gchar*
1077 g_get_prgname (void)
1078 {
1079   gchar* retval;
1080
1081   G_LOCK (g_prgname);
1082 #ifdef G_OS_WIN32
1083   if (g_prgname == NULL)
1084     {
1085       static gboolean beenhere = FALSE;
1086
1087       if (!beenhere)
1088         {
1089           gchar *utf8_buf = NULL;
1090           wchar_t buf[MAX_PATH+1];
1091
1092           beenhere = TRUE;
1093           if (GetModuleFileNameW (GetModuleHandle (NULL),
1094                                   buf, G_N_ELEMENTS (buf)) > 0)
1095             utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1096
1097           if (utf8_buf)
1098             {
1099               g_prgname = g_path_get_basename (utf8_buf);
1100               g_free (utf8_buf);
1101             }
1102         }
1103     }
1104 #endif
1105   retval = g_prgname;
1106   G_UNLOCK (g_prgname);
1107
1108   return retval;
1109 }
1110
1111 /**
1112  * g_set_prgname:
1113  * @prgname: the name of the program.
1114  *
1115  * Sets the name of the program. This name should <emphasis>not</emphasis>
1116  * be localized, contrast with g_set_application_name(). Note that for
1117  * thread-safety reasons this function can only be called once.
1118  */
1119 void
1120 g_set_prgname (const gchar *prgname)
1121 {
1122   G_LOCK (g_prgname);
1123   g_free (g_prgname);
1124   g_prgname = g_strdup (prgname);
1125   G_UNLOCK (g_prgname);
1126 }
1127
1128 G_LOCK_DEFINE_STATIC (g_application_name);
1129 static gchar *g_application_name = NULL;
1130
1131 /**
1132  * g_get_application_name:
1133  *
1134  * Gets a human-readable name for the application, as set by
1135  * g_set_application_name(). This name should be localized if
1136  * possible, and is intended for display to the user.  Contrast with
1137  * g_get_prgname(), which gets a non-localized name. If
1138  * g_set_application_name() has not been called, returns the result of
1139  * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1140  * been called).
1141  *
1142  * Return value: human-readable application name. may return %NULL
1143  *
1144  * Since: 2.2
1145  **/
1146 const gchar *
1147 g_get_application_name (void)
1148 {
1149   gchar* retval;
1150
1151   G_LOCK (g_application_name);
1152   retval = g_application_name;
1153   G_UNLOCK (g_application_name);
1154
1155   if (retval == NULL)
1156     return g_get_prgname ();
1157
1158   return retval;
1159 }
1160
1161 /**
1162  * g_set_application_name:
1163  * @application_name: localized name of the application
1164  *
1165  * Sets a human-readable name for the application. This name should be
1166  * localized if possible, and is intended for display to the user.
1167  * Contrast with g_set_prgname(), which sets a non-localized name.
1168  * g_set_prgname() will be called automatically by gtk_init(),
1169  * but g_set_application_name() will not.
1170  *
1171  * Note that for thread safety reasons, this function can only
1172  * be called once.
1173  *
1174  * The application name will be used in contexts such as error messages,
1175  * or when displaying an application's name in the task list.
1176  *
1177  * Since: 2.2
1178  **/
1179 void
1180 g_set_application_name (const gchar *application_name)
1181 {
1182   gboolean already_set = FALSE;
1183
1184   G_LOCK (g_application_name);
1185   if (g_application_name)
1186     already_set = TRUE;
1187   else
1188     g_application_name = g_strdup (application_name);
1189   G_UNLOCK (g_application_name);
1190
1191   if (already_set)
1192     g_warning ("g_set_application_name() called multiple times");
1193 }
1194
1195 /**
1196  * g_get_user_data_dir:
1197  *
1198  * Returns a base directory in which to access application data such
1199  * as icons that is customized for a particular user.
1200  *
1201  * On UNIX platforms this is determined using the mechanisms described in
1202  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1203  * XDG Base Directory Specification</ulink>.
1204  * In this case the directory retrieved will be XDG_DATA_HOME.
1205  *
1206  * On Windows this is the folder to use for local (as opposed to
1207  * roaming) application data. See documentation for
1208  * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1209  * what g_get_user_config_dir() returns.
1210  *
1211  * Return value: a string owned by GLib that must not be modified
1212  *               or freed.
1213  * Since: 2.6
1214  **/
1215 const gchar *
1216 g_get_user_data_dir (void)
1217 {
1218   gchar *data_dir;
1219
1220   G_LOCK (g_utils_global);
1221
1222   if (!g_user_data_dir)
1223     {
1224 #ifdef G_OS_WIN32
1225       data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1226 #else
1227       data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1228
1229       if (data_dir && data_dir[0])
1230         data_dir = g_strdup (data_dir);
1231 #endif
1232       if (!data_dir || !data_dir[0])
1233         {
1234           const gchar *home_dir = g_get_home_dir ();
1235
1236           if (home_dir)
1237             data_dir = g_build_filename (home_dir, ".local", "share", NULL);
1238           else
1239             data_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".local", "share", NULL);
1240         }
1241
1242       g_user_data_dir = data_dir;
1243     }
1244   else
1245     data_dir = g_user_data_dir;
1246
1247   G_UNLOCK (g_utils_global);
1248
1249   return data_dir;
1250 }
1251
1252 static void
1253 g_init_user_config_dir (void)
1254 {
1255   gchar *config_dir;
1256
1257   if (!g_user_config_dir)
1258     {
1259 #ifdef G_OS_WIN32
1260       config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1261 #else
1262       config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1263
1264       if (config_dir && config_dir[0])
1265         config_dir = g_strdup (config_dir);
1266 #endif
1267       if (!config_dir || !config_dir[0])
1268         {
1269           const gchar *home_dir = g_get_home_dir ();
1270
1271           if (home_dir)
1272             config_dir = g_build_filename (home_dir, ".config", NULL);
1273           else
1274             config_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".config", NULL);
1275         }
1276
1277       g_user_config_dir = config_dir;
1278     }
1279 }
1280
1281 /**
1282  * g_get_user_config_dir:
1283  *
1284  * Returns a base directory in which to store user-specific application
1285  * configuration information such as user preferences and settings.
1286  *
1287  * On UNIX platforms this is determined using the mechanisms described in
1288  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1289  * XDG Base Directory Specification</ulink>.
1290  * In this case the directory retrieved will be XDG_CONFIG_HOME.
1291  *
1292  * On Windows this is the folder to use for local (as opposed to
1293  * roaming) application data. See documentation for
1294  * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1295  * what g_get_user_data_dir() returns.
1296  *
1297  * Return value: a string owned by GLib that must not be modified
1298  *               or freed.
1299  * Since: 2.6
1300  **/
1301 const gchar *
1302 g_get_user_config_dir (void)
1303 {
1304   G_LOCK (g_utils_global);
1305
1306   g_init_user_config_dir ();
1307
1308   G_UNLOCK (g_utils_global);
1309
1310   return g_user_config_dir;
1311 }
1312
1313 /**
1314  * g_get_user_cache_dir:
1315  *
1316  * Returns a base directory in which to store non-essential, cached
1317  * data specific to particular user.
1318  *
1319  * On UNIX platforms this is determined using the mechanisms described in
1320  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1321  * XDG Base Directory Specification</ulink>.
1322  * In this case the directory retrieved will be XDG_CACHE_HOME.
1323  *
1324  * On Windows is the directory that serves as a common repository for
1325  * temporary Internet files. A typical path is
1326  * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1327  * See documentation for CSIDL_INTERNET_CACHE.
1328  *
1329  * Return value: a string owned by GLib that must not be modified
1330  *               or freed.
1331  * Since: 2.6
1332  **/
1333 const gchar *
1334 g_get_user_cache_dir (void)
1335 {
1336   gchar *cache_dir;
1337
1338   G_LOCK (g_utils_global);
1339
1340   if (!g_user_cache_dir)
1341     {
1342 #ifdef G_OS_WIN32
1343       cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1344 #else
1345       cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1346
1347       if (cache_dir && cache_dir[0])
1348           cache_dir = g_strdup (cache_dir);
1349 #endif
1350       if (!cache_dir || !cache_dir[0])
1351         {
1352           const gchar *home_dir = g_get_home_dir ();
1353
1354           if (home_dir)
1355             cache_dir = g_build_filename (home_dir, ".cache", NULL);
1356           else
1357             cache_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".cache", NULL);
1358         }
1359       g_user_cache_dir = cache_dir;
1360     }
1361   else
1362     cache_dir = g_user_cache_dir;
1363
1364   G_UNLOCK (g_utils_global);
1365
1366   return cache_dir;
1367 }
1368
1369 /**
1370  * g_get_user_runtime_dir:
1371  *
1372  * Returns a directory that is unique to the current user on the local
1373  * system.
1374  *
1375  * On UNIX platforms this is determined using the mechanisms described in
1376  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1377  * XDG Base Directory Specification</ulink>.  This is the directory
1378  * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
1379  * In the case that this variable is not set, GLib will issue a warning
1380  * message to stderr and return the value of g_get_user_cache_dir().
1381  *
1382  * On Windows this is the folder to use for local (as opposed to
1383  * roaming) application data. See documentation for
1384  * CSIDL_LOCAL_APPDATA.  Note that on Windows it thus is the same as
1385  * what g_get_user_config_dir() returns.
1386  *
1387  * Returns: a string owned by GLib that must not be modified or freed.
1388  *
1389  * Since: 2.28
1390  **/
1391 const gchar *
1392 g_get_user_runtime_dir (void)
1393 {
1394 #ifndef G_OS_WIN32
1395   static const gchar *runtime_dir;
1396   static gsize initialised;
1397
1398   if (g_once_init_enter (&initialised))
1399     {
1400       runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1401
1402       g_once_init_leave (&initialised, 1);
1403     }
1404
1405   if (runtime_dir)
1406     return runtime_dir;
1407
1408   /* Both fallback for UNIX and the default
1409    * in Windows: use the user cache directory.
1410    */
1411 #endif
1412
1413   return g_get_user_cache_dir ();
1414 }
1415
1416 #ifdef HAVE_CARBON
1417
1418 static gchar *
1419 find_folder (OSType type)
1420 {
1421   gchar *filename = NULL;
1422   FSRef  found;
1423
1424   if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1425     {
1426       CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1427
1428       if (url)
1429         {
1430           CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1431
1432           if (path)
1433             {
1434               filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1435
1436               if (! filename)
1437                 {
1438                   filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1439
1440                   CFStringGetCString (path, filename,
1441                                       CFStringGetLength (path) * 3 + 1,
1442                                       kCFStringEncodingUTF8);
1443                 }
1444
1445               CFRelease (path);
1446             }
1447
1448           CFRelease (url);
1449         }
1450     }
1451
1452   return filename;
1453 }
1454
1455 static void
1456 load_user_special_dirs (void)
1457 {
1458   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1459   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1460   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1461   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1462   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1463   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1464   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1465   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1466 }
1467
1468 #endif /* HAVE_CARBON */
1469
1470 #if defined(G_OS_WIN32)
1471 static void
1472 load_user_special_dirs (void)
1473 {
1474   typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1475                                                     DWORD dwFlags,
1476                                                     HANDLE hToken,
1477                                                     PWSTR *ppszPath);
1478   t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1479
1480   static const GUID FOLDERID_Downloads =
1481     { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1482   static const GUID FOLDERID_Public =
1483     { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1484
1485   wchar_t *wcp;
1486
1487   p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1488                                                                     "SHGetKnownFolderPath");
1489
1490   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1491   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1492
1493   if (p_SHGetKnownFolderPath == NULL)
1494     {
1495       g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1496     }
1497   else
1498     {
1499       wcp = NULL;
1500       (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1501       if (wcp)
1502         {
1503           g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1504           if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1505               g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1506           CoTaskMemFree (wcp);
1507         }
1508       else
1509           g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1510     }
1511
1512   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1513   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1514
1515   if (p_SHGetKnownFolderPath == NULL)
1516     {
1517       /* XXX */
1518       g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1519     }
1520   else
1521     {
1522       wcp = NULL;
1523       (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1524       if (wcp)
1525         {
1526           g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1527           if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1528               g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1529           CoTaskMemFree (wcp);
1530         }
1531       else
1532           g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1533     }
1534
1535   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1536   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1537 }
1538 #endif /* G_OS_WIN32 */
1539
1540 static void g_init_user_config_dir (void);
1541
1542 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1543
1544 /* adapted from xdg-user-dir-lookup.c
1545  *
1546  * Copyright (C) 2007 Red Hat Inc.
1547  *
1548  * Permission is hereby granted, free of charge, to any person
1549  * obtaining a copy of this software and associated documentation files
1550  * (the "Software"), to deal in the Software without restriction,
1551  * including without limitation the rights to use, copy, modify, merge,
1552  * publish, distribute, sublicense, and/or sell copies of the Software,
1553  * and to permit persons to whom the Software is furnished to do so,
1554  * subject to the following conditions:
1555  *
1556  * The above copyright notice and this permission notice shall be
1557  * included in all copies or substantial portions of the Software.
1558  *
1559  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1560  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1561  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1562  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1563  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1564  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1565  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1566  * SOFTWARE.
1567  */
1568 static void
1569 load_user_special_dirs (void)
1570 {
1571   gchar *config_file;
1572   gchar *data;
1573   gchar **lines;
1574   gint n_lines, i;
1575
1576   g_init_user_config_dir ();
1577   config_file = g_build_filename (g_user_config_dir,
1578                                   "user-dirs.dirs",
1579                                   NULL);
1580
1581   if (!g_file_get_contents (config_file, &data, NULL, NULL))
1582     {
1583       g_free (config_file);
1584       return;
1585     }
1586
1587   lines = g_strsplit (data, "\n", -1);
1588   n_lines = g_strv_length (lines);
1589   g_free (data);
1590
1591   for (i = 0; i < n_lines; i++)
1592     {
1593       gchar *buffer = lines[i];
1594       gchar *d, *p;
1595       gint len;
1596       gboolean is_relative = FALSE;
1597       GUserDirectory directory;
1598
1599       /* Remove newline at end */
1600       len = strlen (buffer);
1601       if (len > 0 && buffer[len - 1] == '\n')
1602         buffer[len - 1] = 0;
1603
1604       p = buffer;
1605       while (*p == ' ' || *p == '\t')
1606         p++;
1607
1608       if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1609         {
1610           directory = G_USER_DIRECTORY_DESKTOP;
1611           p += strlen ("XDG_DESKTOP_DIR");
1612         }
1613       else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1614         {
1615           directory = G_USER_DIRECTORY_DOCUMENTS;
1616           p += strlen ("XDG_DOCUMENTS_DIR");
1617         }
1618       else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1619         {
1620           directory = G_USER_DIRECTORY_DOWNLOAD;
1621           p += strlen ("XDG_DOWNLOAD_DIR");
1622         }
1623       else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1624         {
1625           directory = G_USER_DIRECTORY_MUSIC;
1626           p += strlen ("XDG_MUSIC_DIR");
1627         }
1628       else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1629         {
1630           directory = G_USER_DIRECTORY_PICTURES;
1631           p += strlen ("XDG_PICTURES_DIR");
1632         }
1633       else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1634         {
1635           directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1636           p += strlen ("XDG_PUBLICSHARE_DIR");
1637         }
1638       else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1639         {
1640           directory = G_USER_DIRECTORY_TEMPLATES;
1641           p += strlen ("XDG_TEMPLATES_DIR");
1642         }
1643       else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1644         {
1645           directory = G_USER_DIRECTORY_VIDEOS;
1646           p += strlen ("XDG_VIDEOS_DIR");
1647         }
1648       else
1649         continue;
1650
1651       while (*p == ' ' || *p == '\t')
1652         p++;
1653
1654       if (*p != '=')
1655         continue;
1656       p++;
1657
1658       while (*p == ' ' || *p == '\t')
1659         p++;
1660
1661       if (*p != '"')
1662         continue;
1663       p++;
1664
1665       if (strncmp (p, "$HOME", 5) == 0)
1666         {
1667           p += 5;
1668           is_relative = TRUE;
1669         }
1670       else if (*p != '/')
1671         continue;
1672
1673       d = strrchr (p, '"');
1674       if (!d)
1675         continue;
1676       *d = 0;
1677
1678       d = p;
1679
1680       /* remove trailing slashes */
1681       len = strlen (d);
1682       if (d[len - 1] == '/')
1683         d[len - 1] = 0;
1684
1685       if (is_relative)
1686         {
1687           g_user_special_dirs[directory] = g_build_filename (g_get_home_dir (), d, NULL);
1688         }
1689       else
1690         g_user_special_dirs[directory] = g_strdup (d);
1691     }
1692
1693   g_strfreev (lines);
1694   g_free (config_file);
1695 }
1696
1697 #endif /* G_OS_UNIX && !HAVE_CARBON */
1698
1699
1700 /**
1701  * g_reload_user_special_dirs_cache:
1702  *
1703  * Resets the cache used for g_get_user_special_dir(), so
1704  * that the latest on-disk version is used. Call this only
1705  * if you just changed the data on disk yourself.
1706  *
1707  * Due to threadsafety issues this may cause leaking of strings
1708  * that were previously returned from g_get_user_special_dir()
1709  * that can't be freed. We ensure to only leak the data for
1710  * the directories that actually changed value though.
1711  *
1712  * Since: 2.22
1713  */
1714 void
1715 g_reload_user_special_dirs_cache (void)
1716 {
1717   int i;
1718
1719   G_LOCK (g_utils_global);
1720
1721   if (g_user_special_dirs != NULL)
1722     {
1723       /* save a copy of the pointer, to check if some memory can be preserved */
1724       char **old_g_user_special_dirs = g_user_special_dirs;
1725       char *old_val;
1726
1727       /* recreate and reload our cache */
1728       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1729       load_user_special_dirs ();
1730
1731       /* only leak changed directories */
1732       for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1733         {
1734           old_val = old_g_user_special_dirs[i];
1735           if (g_user_special_dirs[i] == NULL)
1736             {
1737               g_user_special_dirs[i] = old_val;
1738             }
1739           else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1740             {
1741               /* don't leak */
1742               g_free (g_user_special_dirs[i]);
1743               g_user_special_dirs[i] = old_val;
1744             }
1745           else
1746             g_free (old_val);
1747         }
1748
1749       /* free the old array */
1750       g_free (old_g_user_special_dirs);
1751     }
1752
1753   G_UNLOCK (g_utils_global);
1754 }
1755
1756 /**
1757  * g_get_user_special_dir:
1758  * @directory: the logical id of special directory
1759  *
1760  * Returns the full path of a special directory using its logical id.
1761  *
1762  * On Unix this is done using the XDG special user directories.
1763  * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1764  * falls back to <filename>$HOME/Desktop</filename> when XDG special
1765  * user directories have not been set up.
1766  *
1767  * Depending on the platform, the user might be able to change the path
1768  * of the special directory without requiring the session to restart; GLib
1769  * will not reflect any change once the special directories are loaded.
1770  *
1771  * Return value: the path to the specified special directory, or %NULL
1772  *   if the logical id was not found. The returned string is owned by
1773  *   GLib and should not be modified or freed.
1774  *
1775  * Since: 2.14
1776  */
1777 const gchar *
1778 g_get_user_special_dir (GUserDirectory directory)
1779 {
1780   g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1781                         directory < G_USER_N_DIRECTORIES, NULL);
1782
1783   G_LOCK (g_utils_global);
1784
1785   if (G_UNLIKELY (g_user_special_dirs == NULL))
1786     {
1787       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1788
1789       load_user_special_dirs ();
1790
1791       /* Special-case desktop for historical compatibility */
1792       if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1793         g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (g_get_home_dir (), "Desktop", NULL);
1794     }
1795
1796   G_UNLOCK (g_utils_global);
1797
1798   return g_user_special_dirs[directory];
1799 }
1800
1801 #ifdef G_OS_WIN32
1802
1803 #undef g_get_system_data_dirs
1804
1805 static HMODULE
1806 get_module_for_address (gconstpointer address)
1807 {
1808   /* Holds the g_utils_global lock */
1809
1810   static gboolean beenhere = FALSE;
1811   typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1812   static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1813   HMODULE hmodule = NULL;
1814
1815   if (!address)
1816     return NULL;
1817
1818   if (!beenhere)
1819     {
1820       p_GetModuleHandleExA =
1821         (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1822                                                "GetModuleHandleExA");
1823       beenhere = TRUE;
1824     }
1825
1826   if (p_GetModuleHandleExA == NULL ||
1827       !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1828                                 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1829                                 address, &hmodule))
1830     {
1831       MEMORY_BASIC_INFORMATION mbi;
1832       VirtualQuery (address, &mbi, sizeof (mbi));
1833       hmodule = (HMODULE) mbi.AllocationBase;
1834     }
1835
1836   return hmodule;
1837 }
1838
1839 static gchar *
1840 get_module_share_dir (gconstpointer address)
1841 {
1842   HMODULE hmodule;
1843   gchar *filename;
1844   gchar *retval;
1845
1846   hmodule = get_module_for_address (address);
1847   if (hmodule == NULL)
1848     return NULL;
1849
1850   filename = g_win32_get_package_installation_directory_of_module (hmodule);
1851   retval = g_build_filename (filename, "share", NULL);
1852   g_free (filename);
1853
1854   return retval;
1855 }
1856
1857 const gchar * const *
1858 g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
1859 {
1860   GArray *data_dirs;
1861   HMODULE hmodule;
1862   static GHashTable *per_module_data_dirs = NULL;
1863   gchar **retval;
1864   gchar *p;
1865   gchar *exe_root;
1866
1867   if (address_of_function)
1868     {
1869       G_LOCK (g_utils_global);
1870       hmodule = get_module_for_address (address_of_function);
1871       if (hmodule != NULL)
1872         {
1873           if (per_module_data_dirs == NULL)
1874             per_module_data_dirs = g_hash_table_new (NULL, NULL);
1875           else
1876             {
1877               retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1878
1879               if (retval != NULL)
1880                 {
1881                   G_UNLOCK (g_utils_global);
1882                   return (const gchar * const *) retval;
1883                 }
1884             }
1885         }
1886     }
1887
1888   data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1889
1890   /* Documents and Settings\All Users\Application Data */
1891   p = get_special_folder (CSIDL_COMMON_APPDATA);
1892   if (p)
1893     g_array_append_val (data_dirs, p);
1894
1895   /* Documents and Settings\All Users\Documents */
1896   p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1897   if (p)
1898     g_array_append_val (data_dirs, p);
1899
1900   /* Using the above subfolders of Documents and Settings perhaps
1901    * makes sense from a Windows perspective.
1902    *
1903    * But looking at the actual use cases of this function in GTK+
1904    * and GNOME software, what we really want is the "share"
1905    * subdirectory of the installation directory for the package
1906    * our caller is a part of.
1907    *
1908    * The address_of_function parameter, if non-NULL, points to a
1909    * function in the calling module. Use that to determine that
1910    * module's installation folder, and use its "share" subfolder.
1911    *
1912    * Additionally, also use the "share" subfolder of the installation
1913    * locations of GLib and the .exe file being run.
1914    *
1915    * To guard against none of the above being what is really wanted,
1916    * callers of this function should have Win32-specific code to look
1917    * up their installation folder themselves, and handle a subfolder
1918    * "share" of it in the same way as the folders returned from this
1919    * function.
1920    */
1921
1922   p = get_module_share_dir (address_of_function);
1923   if (p)
1924     g_array_append_val (data_dirs, p);
1925
1926   if (glib_dll != NULL)
1927     {
1928       gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1929       p = g_build_filename (glib_root, "share", NULL);
1930       if (p)
1931         g_array_append_val (data_dirs, p);
1932       g_free (glib_root);
1933     }
1934
1935   exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1936   p = g_build_filename (exe_root, "share", NULL);
1937   if (p)
1938     g_array_append_val (data_dirs, p);
1939   g_free (exe_root);
1940
1941   retval = (gchar **) g_array_free (data_dirs, FALSE);
1942
1943   if (address_of_function)
1944     {
1945       if (hmodule != NULL)
1946         g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1947       G_UNLOCK (g_utils_global);
1948     }
1949
1950   return (const gchar * const *) retval;
1951 }
1952
1953 #endif
1954
1955 /**
1956  * g_get_system_data_dirs:
1957  *
1958  * Returns an ordered list of base directories in which to access
1959  * system-wide application data.
1960  *
1961  * On UNIX platforms this is determined using the mechanisms described in
1962  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1963  * XDG Base Directory Specification</ulink>
1964  * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1965  *
1966  * On Windows the first elements in the list are the Application Data
1967  * and Documents folders for All Users. (These can be determined only
1968  * on Windows 2000 or later and are not present in the list on other
1969  * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1970  * CSIDL_COMMON_DOCUMENTS.
1971  *
1972  * Then follows the "share" subfolder in the installation folder for
1973  * the package containing the DLL that calls this function, if it can
1974  * be determined.
1975  *
1976  * Finally the list contains the "share" subfolder in the installation
1977  * folder for GLib, and in the installation folder for the package the
1978  * application's .exe file belongs to.
1979  *
1980  * The installation folders above are determined by looking up the
1981  * folder where the module (DLL or EXE) in question is located. If the
1982  * folder's name is "bin", its parent is used, otherwise the folder
1983  * itself.
1984  *
1985  * Note that on Windows the returned list can vary depending on where
1986  * this function is called.
1987  *
1988  * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1989  *               not be modified or freed.
1990  * Since: 2.6
1991  **/
1992 const gchar * const *
1993 g_get_system_data_dirs (void)
1994 {
1995   gchar **data_dir_vector;
1996
1997   G_LOCK (g_utils_global);
1998
1999   if (!g_system_data_dirs)
2000     {
2001 #ifdef G_OS_WIN32
2002       data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2003 #else
2004       gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2005
2006       if (!data_dirs || !data_dirs[0])
2007           data_dirs = "/usr/local/share/:/usr/share/";
2008
2009       data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2010 #endif
2011
2012       g_system_data_dirs = data_dir_vector;
2013     }
2014   else
2015     data_dir_vector = g_system_data_dirs;
2016
2017   G_UNLOCK (g_utils_global);
2018
2019   return (const gchar * const *) data_dir_vector;
2020 }
2021
2022 /**
2023  * g_get_system_config_dirs:
2024  *
2025  * Returns an ordered list of base directories in which to access
2026  * system-wide configuration information.
2027  *
2028  * On UNIX platforms this is determined using the mechanisms described in
2029  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2030  * XDG Base Directory Specification</ulink>.
2031  * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2032  *
2033  * On Windows is the directory that contains application data for all users.
2034  * A typical path is C:\Documents and Settings\All Users\Application Data.
2035  * This folder is used for application data that is not user specific.
2036  * For example, an application can store a spell-check dictionary, a database
2037  * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2038  * This information will not roam and is available to anyone using the computer.
2039  *
2040  * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2041  *               not be modified or freed.
2042  * Since: 2.6
2043  **/
2044 const gchar * const *
2045 g_get_system_config_dirs (void)
2046 {
2047   gchar *conf_dirs, **conf_dir_vector;
2048
2049   G_LOCK (g_utils_global);
2050
2051   if (!g_system_config_dirs)
2052     {
2053 #ifdef G_OS_WIN32
2054       conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2055       if (conf_dirs)
2056         {
2057           conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2058           g_free (conf_dirs);
2059         }
2060       else
2061         {
2062           /* Return empty list */
2063           conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2064         }
2065 #else
2066       conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2067
2068       if (!conf_dirs || !conf_dirs[0])
2069           conf_dirs = "/etc/xdg";
2070
2071       conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2072 #endif
2073
2074       g_system_config_dirs = conf_dir_vector;
2075     }
2076   else
2077     conf_dir_vector = g_system_config_dirs;
2078   G_UNLOCK (g_utils_global);
2079
2080   return (const gchar * const *) conf_dir_vector;
2081 }
2082
2083 /**
2084  * g_nullify_pointer:
2085  * @nullify_location: the memory address of the pointer.
2086  *
2087  * Set the pointer at the specified location to %NULL.
2088  **/
2089 void
2090 g_nullify_pointer (gpointer *nullify_location)
2091 {
2092   g_return_if_fail (nullify_location != NULL);
2093
2094   *nullify_location = NULL;
2095 }
2096
2097 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2098 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2099 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2100 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2101 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2102 #define EXABYTE_FACTOR  (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2103
2104 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2105 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2106 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2107 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2108 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2109 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2110
2111 /**
2112  * g_format_size:
2113  * @size: a size in bytes
2114  *
2115  * Formats a size (for example the size of a file) into a human readable
2116  * string.  Sizes are rounded to the nearest size prefix (kB, MB, GB)
2117  * and are displayed rounded to the nearest tenth. E.g. the file size
2118  * 3292528 bytes will be converted into the string "3.2 MB".
2119  *
2120  * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2121  *
2122  * This string should be freed with g_free() when not needed any longer.
2123  *
2124  * See g_format_size_full() for more options about how the size might be
2125  * formatted.
2126  *
2127  * Returns: a newly-allocated formatted string containing a human readable
2128  *     file size
2129  *
2130  * Since: 2.30
2131  */
2132 gchar *
2133 g_format_size (guint64 size)
2134 {
2135   return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2136 }
2137
2138 /**
2139  * GFormatSizeFlags:
2140  * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2141  * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2142  *     of the returned string.  For example, "45.6 kB (45,612 bytes)".
2143  * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2144  *     suffixes. IEC units should only be used for reporting things with
2145  *     a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2146  *     Network and storage sizes should be reported in the normal SI units.
2147  *
2148  * Flags to modify the format of the string returned by g_format_size_full().
2149  */
2150
2151 /**
2152  * g_format_size_full:
2153  * @size: a size in bytes
2154  * @flags: #GFormatSizeFlags to modify the output
2155  *
2156  * Formats a size.
2157  *
2158  * This function is similar to g_format_size() but allows for flags
2159  * that modify the output. See #GFormatSizeFlags.
2160  *
2161  * Returns: a newly-allocated formatted string containing a human
2162  *     readable file size
2163  *
2164  * Since: 2.30
2165  */
2166 gchar *
2167 g_format_size_full (guint64          size,
2168                     GFormatSizeFlags flags)
2169 {
2170   GString *string;
2171
2172   string = g_string_new (NULL);
2173
2174   if (flags & G_FORMAT_SIZE_IEC_UNITS)
2175     {
2176       if (size < KIBIBYTE_FACTOR)
2177         {
2178           g_string_printf (string,
2179                            g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2180                            (guint) size);
2181           flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2182         }
2183
2184       else if (size < MEBIBYTE_FACTOR)
2185         g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2186       else if (size < GIBIBYTE_FACTOR)
2187         g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2188
2189       else if (size < TEBIBYTE_FACTOR)
2190         g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2191
2192       else if (size < PEBIBYTE_FACTOR)
2193         g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2194
2195       else if (size < EXBIBYTE_FACTOR)
2196         g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2197
2198       else
2199         g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2200     }
2201   else
2202     {
2203       if (size < KILOBYTE_FACTOR)
2204         {
2205           g_string_printf (string,
2206                            g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2207                            (guint) size);
2208           flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2209         }
2210
2211       else if (size < MEGABYTE_FACTOR)
2212         g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2213
2214       else if (size < GIGABYTE_FACTOR)
2215         g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2216
2217       else if (size < TERABYTE_FACTOR)
2218         g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2219       else if (size < PETABYTE_FACTOR)
2220         g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2221
2222       else if (size < EXABYTE_FACTOR)
2223         g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2224
2225       else
2226         g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2227     }
2228
2229   if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2230     {
2231       /* First problem: we need to use the number of bytes to decide on
2232        * the plural form that is used for display, but the number of
2233        * bytes potentially exceeds the size of a guint (which is what
2234        * ngettext() takes).
2235        *
2236        * From a pragmatic standpoint, it seems that all known languages
2237        * base plural forms on one or both of the following:
2238        *
2239        *   - the lowest digits of the number
2240        *
2241        *   - if the number if greater than some small value
2242        *
2243        * Here's how we fake it:  Draw an arbitrary line at one thousand.
2244        * If the number is below that, then fine.  If it is above it,
2245        * then we take the modulus of the number by one thousand (in
2246        * order to keep the lowest digits) and add one thousand to that
2247        * (in order to ensure that 1001 is not treated the same as 1).
2248        */
2249       guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2250
2251       /* Second problem: we need to translate the string "%u byte" and
2252        * "%u bytes" for pluralisation, but the correct number format to
2253        * use for a gsize is different depending on which architecture
2254        * we're on.
2255        *
2256        * Solution: format the number separately and use "%s bytes" on
2257        * all platforms.
2258        */
2259       const gchar *translated_format;
2260       gchar *formatted_number;
2261
2262       /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2263       translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2264       /* XXX: Windows doesn't support the "'" format modifier, so we
2265        * must not use it there.  Instead, just display the number
2266        * without separation.  Bug #655336 is open until a solution is
2267        * found.
2268        */
2269 #ifndef G_OS_WIN32
2270       formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2271 #else
2272       formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2273 #endif
2274
2275       g_string_append (string, " (");
2276 #pragma GCC diagnostic push
2277 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
2278       g_string_append_printf (string, translated_format, formatted_number);
2279 #pragma GCC diagnostic pop
2280       g_free (formatted_number);
2281       g_string_append (string, ")");
2282     }
2283
2284   return g_string_free (string, FALSE);
2285 }
2286
2287 /**
2288  * g_format_size_for_display:
2289  * @size: a size in bytes
2290  *
2291  * Formats a size (for example the size of a file) into a human
2292  * readable string. Sizes are rounded to the nearest size prefix
2293  * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2294  * E.g. the file size 3292528 bytes will be converted into the
2295  * string "3.1 MB".
2296  *
2297  * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2298  *
2299  * This string should be freed with g_free() when not needed any longer.
2300  *
2301  * Returns: a newly-allocated formatted string containing a human
2302  *     readable file size
2303  *
2304  * Since: 2.16
2305  *
2306  * Deprecated:2.30: This function is broken due to its use of SI
2307  *     suffixes to denote IEC units. Use g_format_size() instead.
2308  */
2309 gchar *
2310 g_format_size_for_display (goffset size)
2311 {
2312   if (size < (goffset) KIBIBYTE_FACTOR)
2313     return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2314   else
2315     {
2316       gdouble displayed_size;
2317
2318       if (size < (goffset) MEBIBYTE_FACTOR)
2319         {
2320           displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2321           /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
2322            * mean 1024 bytes.  I am aware that 'KB' is not correct, but it has been preserved for reasons of
2323            * compatibility.  Users will not see this string unless a program is using this deprecated function.
2324            * Please translate as literally as possible.
2325            */
2326           return g_strdup_printf (_("%.1f KB"), displayed_size);
2327         }
2328       else if (size < (goffset) GIBIBYTE_FACTOR)
2329         {
2330           displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2331           return g_strdup_printf (_("%.1f MB"), displayed_size);
2332         }
2333       else if (size < (goffset) TEBIBYTE_FACTOR)
2334         {
2335           displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2336           return g_strdup_printf (_("%.1f GB"), displayed_size);
2337         }
2338       else if (size < (goffset) PEBIBYTE_FACTOR)
2339         {
2340           displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2341           return g_strdup_printf (_("%.1f TB"), displayed_size);
2342         }
2343       else if (size < (goffset) EXBIBYTE_FACTOR)
2344         {
2345           displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2346           return g_strdup_printf (_("%.1f PB"), displayed_size);
2347         }
2348       else
2349         {
2350           displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2351           return g_strdup_printf (_("%.1f EB"), displayed_size);
2352         }
2353     }
2354 }
2355
2356 #if defined (G_OS_WIN32) && !defined (_WIN64)
2357
2358 /* Binary compatibility versions. Not for newly compiled code. */
2359
2360 _GLIB_EXTERN const gchar *g_get_user_name_utf8        (void);
2361 _GLIB_EXTERN const gchar *g_get_real_name_utf8        (void);
2362 _GLIB_EXTERN const gchar *g_get_home_dir_utf8         (void);
2363 _GLIB_EXTERN const gchar *g_get_tmp_dir_utf8          (void);
2364 _GLIB_EXTERN gchar       *g_find_program_in_path_utf8 (const gchar *program);
2365
2366 gchar *
2367 g_find_program_in_path_utf8 (const gchar *program)
2368 {
2369   return g_find_program_in_path (program);
2370 }
2371
2372 const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
2373 const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
2374 const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
2375 const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
2376
2377 #endif
2378
2379 /* Private API:
2380  *
2381  * Returns %TRUE if the current process was executed as setuid (or an
2382  * equivalent __libc_enable_secure is available).  See:
2383  * http://osdir.com/ml/linux.lfs.hardened/2007-04/msg00032.html
2384  */
2385 gboolean
2386 g_check_setuid (void)
2387 {
2388   /* TODO: get __libc_enable_secure exported from glibc.
2389    * See http://www.openwall.com/lists/owl-dev/2012/08/14/1
2390    */
2391 #if 0 && defined(HAVE_LIBC_ENABLE_SECURE)
2392   {
2393     /* See glibc/include/unistd.h */
2394     extern int __libc_enable_secure;
2395     return __libc_enable_secure;
2396   }
2397 #elif defined(HAVE_ISSETUGID)
2398   /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
2399   return issetugid ();
2400 #elif defined(G_OS_UNIX)
2401   uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
2402   gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
2403
2404   static gsize check_setuid_initialised;
2405   static gboolean is_setuid;
2406
2407   if (g_once_init_enter (&check_setuid_initialised))
2408     {
2409 #ifdef HAVE_GETRESUID
2410       /* These aren't in the header files, so we prototype them here.
2411        */
2412       int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
2413       int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
2414
2415       if (getresuid (&ruid, &euid, &suid) != 0 ||
2416           getresgid (&rgid, &egid, &sgid) != 0)
2417 #endif /* HAVE_GETRESUID */
2418         {
2419           suid = ruid = getuid ();
2420           sgid = rgid = getgid ();
2421           euid = geteuid ();
2422           egid = getegid ();
2423         }
2424
2425       is_setuid = (ruid != euid || ruid != suid ||
2426                    rgid != egid || rgid != sgid);
2427
2428       g_once_init_leave (&check_setuid_initialised, 1);
2429     }
2430   return is_setuid;
2431 #else
2432   return FALSE;
2433 #endif
2434 }