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