2 * Generic freedesktop.org support code
4 * Copyright (C) 2006 Mikolaj Zalewski
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * XDG_UserDirLookup() and helper functions are based on code from:
22 * http://www.freedesktop.org/wiki/Software/xdg-user-dirs
24 * Copyright (c) 2007 Red Hat, inc
26 * From the xdg-user-dirs license:
27 * Permission is hereby granted, free of charge, to any person
28 * obtaining a copy of this software and associated documentation files
29 * (the "Software"), to deal in the Software without restriction,
30 * including without limitation the rights to use, copy, modify, merge,
31 * publish, distribute, sublicense, and/or sell copies of the Software,
32 * and to permit persons to whom the Software is furnished to do so,
33 * subject to the following conditions:
35 * The above copyright notice and this permission notice shall be
36 * included in all copies or substantial portions of the Software.
38 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
39 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
40 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
42 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
43 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
44 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
54 #ifdef HAVE_SYS_STAT_H
55 # include <sys/stat.h>
66 #include "wine/debug.h"
67 #include "shell32_main.h"
70 WINE_DEFAULT_DEBUG_CHANNEL(xdg
);
73 * XDG paths implemented using Desktop Base Directory spec version 0.6
74 * (from http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html)
77 static CRITICAL_SECTION XDG_PathsLock
;
78 static CRITICAL_SECTION_DEBUG XDG_PathsLock_Debug
=
81 { &XDG_PathsLock_Debug
.ProcessLocksList
,
82 &XDG_PathsLock_Debug
.ProcessLocksList
},
83 0, 0, { (DWORD_PTR
)__FILE__
": XDG_PathsLock"}
85 static CRITICAL_SECTION XDG_PathsLock
= { &XDG_PathsLock_Debug
, -1, 0, 0, 0, 0 };
90 const char *default_value
;
93 static const std_path paths
[] = {
94 {"XDG_DATA_HOME", "$HOME/.local/share"},
95 {"XDG_CONFIG_HOME", "$HOME/.config"},
96 {"XDG_DATA_DIRS", "/usr/local/share:/usr/share"},
97 {"XDG_CONFIG_DIRS", "/etc/xdg"},
98 {"XDG_CACHE_HOME", "$HOME/.cache"}
101 #define PATHS_COUNT (sizeof(paths)/sizeof(paths[0]))
103 /* will be filled with paths as they are computed */
104 static const char *path_values
[PATHS_COUNT
] = {
112 static char *load_path(int path_id
)
114 char *env
= getenv(paths
[path_id
].var_name
);
117 if (env
!= NULL
&& env
[0]=='/')
119 ret
= SHAlloc(strlen(env
)+1);
125 if (memcmp(paths
[path_id
].default_value
, "$HOME", 5)==0)
127 char *home
= getenv("HOME");
130 if (!home
) return NULL
;
131 ret
= SHAlloc(strlen(home
)+strlen(paths
[path_id
].default_value
)-5+1);
132 if (ret
== NULL
) return NULL
;
136 if (len
>0 && ret
[len
-1]=='/')
138 lstrcatA(ret
, paths
[path_id
].default_value
+5);
142 ret
= SHAlloc(strlen(paths
[path_id
].default_value
)+1);
144 lstrcpyA(ret
, paths
[path_id
].default_value
);
148 /******************************************************************************
149 * XDG_GetPath [internal]
151 * Get one of the XDG standard patch. The return value shouldn't be modified nor
152 * freed. A return value of NULL means that the memory is exhausted or the input
155 * For XDG_DATA_HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME the result is a Unix path.
156 * For XDG_DATA_DIRS and XDG_CONFIG_DIRS the result is a colon-separated list of Unix
159 * The paths are guaranteed to start with '/'
161 const char *XDG_GetPath(int path_id
)
163 if (path_id
>= PATHS_COUNT
|| path_id
< 0)
165 ERR("Invalid path_id %d\n", path_id
);
169 if (path_values
[path_id
] != NULL
)
170 return path_values
[path_id
];
171 EnterCriticalSection(&XDG_PathsLock
);
172 if (path_values
[path_id
] == NULL
)
173 path_values
[path_id
] = load_path(path_id
);
174 LeaveCriticalSection(&XDG_PathsLock
);
175 return path_values
[path_id
];
178 /******************************************************************************
179 * XDG_BuildPath [internal]
181 * Build a string with a subpath of one of the XDG standard paths.
182 * The root can be one of XDG_DATA_HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME.
183 * The subpath is a path relative to that root (it shouldn't start with a slash)
185 * The returned path should be freed with SHFree. A return of NULL means that the
186 * memory is exhausted or the parameters are invalid
188 char *XDG_BuildPath(int root_id
, const char *subpath
)
190 const char *root_path
= XDG_GetPath(root_id
);
194 if (root_id
== XDG_DATA_DIRS
|| root_id
== XDG_CONFIG_DIRS
)
196 ERR("Invalid path id %d\n", root_id
);
200 if (root_path
== NULL
) return NULL
;
201 root_len
= strlen(root_path
);
202 if (root_path
[root_len
-1]=='/') root_len
--;
203 ret_buffer
= SHAlloc(root_len
+1+strlen(subpath
)+1);
204 if (ret_buffer
== NULL
) return NULL
;
205 lstrcpyA(ret_buffer
, root_path
);
206 ret_buffer
[root_len
]='/';
207 lstrcpyA(ret_buffer
+root_len
+1, subpath
);
211 /******************************************************************************
212 * XDG_MakeDirs [internal]
214 * Checks that all the directories on the specified path exists. If some don't exists
215 * they are created with mask 0700 as required by many the freedeskop.org specs.
216 * If the path doesn't end with '/' it is assumed to be a path to a file and the last
217 * segment is not checked
219 * In case of a failure the errno is always set and can be used e.g for debugging
222 * TRUE on success, FALSE on error
224 BOOL
XDG_MakeDirs(const char *path
)
229 char *buffer
= SHAlloc(strlen(path
)+1);
236 lstrcpyA(buffer
, path
);
238 TRACE("(%s)\n", debugstr_a(path
));
241 char *slash
=strchr(buffer
+last_slash
+1, '/');
245 /* cut the string at that position and create the directory if it doesn't exist */
247 TRACE("Checking path %s\n", debugstr_a(buffer
));
248 success
= (stat(buffer
, &tmp
)==0);
249 if (!success
&& errno
==ENOENT
)
252 success
= (mkdir(buffer
, 0700)==0);
256 WARN("Couldn't process directory %s (errno=%d)\n", debugstr_a(buffer
), errno
);
260 last_slash
= slash
-buffer
;
267 * .desktop files functions
271 /******************************************************************************
272 * dskentry_encode [internal]
274 * Escape the characters that can't be present in a desktop entry value like \n, leading
275 * spaces etc. The output parameter may be NULL. Then only the number of characters will
279 * The number of characters after escaping the special characters, including the
282 static int dskentry_encode(const char *value
, char *output
)
287 for (c
= value
; *c
; c
++)
289 if (only_spc
&& *c
==' ')
301 if (*c
=='\t' || *c
=='\r' || *c
=='\n' || *c
=='\\')
306 if (*c
=='\t') *(output
++) = 't';
307 if (*c
=='\r') *(output
++) = 'r';
308 if (*c
=='\n') *(output
++) = 'n';
309 if (*c
=='\\') *(output
++) = '\\';
327 /******************************************************************************
328 * dskentry_decode [internal]
330 * Unescape the characters that can be escaped according to the desktop entry spec.
331 * The output parameter may be NULL. Then only the number of characters will
335 * The number of characters after unescaping the special characters, including the
338 static int dskentry_decode(const char *value
, int len
, char *output
)
345 if (value
[pos
] == '\\' && pos
<len
-1)
350 case 's': c
= ' '; break;
351 case 'n': c
= '\n'; break;
352 case 't': c
= '\t'; break;
353 case 'r': c
= 'r'; break;
354 case '\\': c
= '\\'; break;
356 /* store both the backslash and the character */
380 /******************************************************************************
381 * url_encode [internal]
383 * URL-encode the given string (i.e. use escape codes like %20). Note that an
384 * URL-encoded string can be used as a value in desktop entry files as all
385 * unsafe characters are escaped.
387 * The output can be NULL. Then only the number of characters will be counted
390 * The number of characters after escaping the special characters, including the
393 static int url_encode(const char *value
, char *output
)
395 static const char unsafechars
[] = "^&`{}|[]'<>\\#%\"+";
396 static const char hexchars
[] = "0123456789ABCDEF";
400 for (c
= value
; *c
; c
++)
402 if (*c
<=0x20 || *c
>=0x7f || strchr(unsafechars
, *c
))
407 *(output
++) = hexchars
[(unsigned char)*c
/ 16];
408 *(output
++) = hexchars
[(unsigned char)*c
% 16];
427 static int decode_url_code(const char *c
)
431 static const char hexchars
[] = "0123456789ABCDEF";
435 p1
= strchr(hexchars
, toupper(*c
));
436 p2
= strchr(hexchars
, toupper(*(c
+1)));
437 if (p1
== NULL
|| p2
== NULL
)
439 v1
= (int)(p1
- hexchars
);
440 v2
= (int)(p2
- hexchars
);
444 /******************************************************************************
445 * url_decode [internal]
447 * URL-decode the given string (i.e. unescape codes like %20). The decoded string
448 * will never be longer than the encoded one. The decoding can be done in place - the
449 * output variable can point to the value buffer.
451 * output should not be NULL
453 static void url_decode(const char *value
, char *output
)
455 const char *c
= value
;
460 int v
= decode_url_code(c
+1);
475 static int escape_value(const char *value
, DWORD dwFlags
, char *output
)
477 if (dwFlags
& XDG_URLENCODE
)
478 return url_encode(value
, output
);
479 return dskentry_encode(value
, output
);
482 /******************************************************************************
483 * XDG_WriteDesktopStringEntry [internal]
485 * Writes a key=value pair into the specified file descriptor.
488 * TRUE on success, else FALSE
490 BOOL
XDG_WriteDesktopStringEntry(int writer
, const char *keyName
, DWORD dwFlags
, const char *value
)
492 int keyLen
= lstrlenA(keyName
);
493 int valueLen
= escape_value(value
, dwFlags
, NULL
);
494 char *string
= SHAlloc(keyLen
+1+valueLen
);
499 lstrcpyA(string
, keyName
);
500 string
[keyLen
] = '=';
501 escape_value(value
, dwFlags
, string
+keyLen
+1);
502 string
[keyLen
+1+valueLen
-1]='\n'; /* -1 because valueLen contains the last NUL character */
503 ret
= (write(writer
, string
, keyLen
+1+valueLen
)!=-1);
514 typedef struct tagPARSED_ENTRY PARSED_ENTRY
;
515 struct tagPARSED_ENTRY
518 PARSED_STRING equals
;
523 typedef struct tagPARSED_GROUP PARSED_GROUP
;
524 struct tagPARSED_GROUP
527 PARSED_ENTRY
*entries
;
532 struct tagXDG_PARSED_FILE
535 PARSED_ENTRY
*head_comments
;
536 PARSED_GROUP
*groups
;
539 static BOOL
parsed_str_eq(const PARSED_STRING
*str1
, const char *str2
)
541 if (strncmp(str1
->str
, str2
, str1
->len
) != 0)
543 if (str2
[str1
->len
] != 0)
548 static void free_entries_list(PARSED_ENTRY
*first
)
559 void XDG_FreeParsedFile(XDG_PARSED_FILE
*parsed
)
561 PARSED_GROUP
*group
, *next
;
564 free_entries_list(parsed
->head_comments
);
566 group
= parsed
->groups
;
570 free_entries_list(group
->entries
);
578 #define LINE_COMMENT 3
580 static int parse_line(char *content
, PARSED_ENTRY
*output
, int *outType
)
584 ZeroMemory(output
, sizeof(PARSED_ENTRY
));
585 end
= strchr(content
, '\n');
587 end
= content
+ strlen(content
) - 1;
591 *outType
= LINE_COMMENT
;
592 output
->equals
.str
= content
;
593 output
->equals
.len
= end
- content
;
595 output
->equals
.len
++;
597 else if (*content
== '[')
599 char *last_char
= end
;
601 *outType
= LINE_GROUP
;
603 /* the standard says nothing about skipping white spaces but e.g. KDE accepts such files */
604 while (isspace(*last_char
))
606 if (*last_char
!= ']')
608 output
->name
.str
= content
+ 1;
609 output
->name
.len
= last_char
- (content
+ 1);
613 /* 'name = value' line */
614 char *equal
, *eq_begin
, *eq_end
;
616 *outType
= LINE_ENTRY
;
618 equal
= strchr(content
, '=');
619 if (equal
== NULL
|| equal
> end
)
621 for (eq_begin
= equal
-1; isspace(*eq_begin
) && eq_begin
>= content
; eq_begin
--)
623 for (eq_end
= equal
+1; isspace(*eq_end
) && *eq_end
!= '\n'; eq_end
++)
626 output
->name
.str
= content
;
627 output
->name
.len
= eq_begin
- content
+ 1;
629 output
->equals
.str
= eq_begin
+ 1;
630 output
->equals
.len
= eq_end
- eq_begin
- 1;
632 output
->value
.str
= eq_end
;
633 output
->value
.len
= end
- eq_end
;
638 return end
- content
+ 1;
641 XDG_PARSED_FILE
*XDG_ParseDesktopFile(int fd
)
644 XDG_PARSED_FILE
*parsed
= NULL
;
645 PARSED_ENTRY
**curr_entry
;
646 PARSED_GROUP
**curr_group
;
647 BOOL is_in_group
= FALSE
;
651 if (fstat(fd
, &stats
) == -1) goto failed
;
652 parsed
= SHAlloc(sizeof(XDG_PARSED_FILE
));
653 if (parsed
== NULL
) goto failed
;
654 parsed
->groups
= NULL
;
655 parsed
->head_comments
= NULL
;
656 parsed
->contents
= SHAlloc(stats
.st_size
+1);
657 if (parsed
->contents
== NULL
) goto failed
;
659 curr_entry
= &parsed
->head_comments
;
660 curr_group
= &parsed
->groups
;
662 if (read(fd
, parsed
->contents
, stats
.st_size
) == -1) goto failed
;
663 parsed
->contents
[stats
.st_size
] = 0;
665 while (pos
< stats
.st_size
)
667 PARSED_ENTRY statement
;
670 size
= parse_line(parsed
->contents
+ pos
, &statement
, &type
);
671 if (size
== -1) goto failed
;
680 PARSED_GROUP
*group
= SHAlloc(sizeof(PARSED_GROUP
));
681 if (group
== NULL
) goto failed
;
684 group
->name
= statement
.name
;
685 group
->entries
= NULL
;
688 curr_group
= &group
->next
;
689 curr_entry
= &group
->entries
;
694 if (!is_in_group
) goto failed
;
698 PARSED_ENTRY
*new_stat
= SHAlloc(sizeof(PARSED_ENTRY
));
699 if (new_stat
== NULL
) goto failed
;
700 *new_stat
= statement
;
701 new_stat
->next
= NULL
;
702 *curr_entry
= new_stat
;
703 curr_entry
= &new_stat
->next
;
711 XDG_FreeParsedFile(parsed
);
715 char *XDG_GetStringValue(XDG_PARSED_FILE
*file
, const char *group_name
, const char *value_name
, DWORD dwFlags
)
720 for (group
= file
->groups
; group
; group
= group
->next
)
722 if (!parsed_str_eq(&group
->name
, group_name
))
725 for (entry
= group
->entries
; entry
; entry
= entry
->next
)
726 if (entry
->name
.str
!= NULL
&& parsed_str_eq(&entry
->name
, value_name
))
731 len
= dskentry_decode(entry
->value
.str
, entry
->value
.len
, NULL
);
733 if (ret
== NULL
) return NULL
;
734 dskentry_decode(entry
->value
.str
, entry
->value
.len
, ret
);
735 if (dwFlags
& XDG_URLENCODE
)
736 url_decode(ret
, ret
);
744 /* Get the name of the xdg configuration file.
746 * [in] home_dir - $HOME
747 * [out] config_file - the name of the configuration file
749 static HRESULT
get_xdg_config_file(char * home_dir
, char ** config_file
)
753 config_home
= getenv("XDG_CONFIG_HOME");
754 if (!config_home
|| !config_home
[0])
756 *config_file
= HeapAlloc(GetProcessHeap(), 0, strlen(home_dir
) + strlen("/.config/user-dirs.dirs") + 1);
758 return E_OUTOFMEMORY
;
760 strcpy(*config_file
, home_dir
);
761 strcat(*config_file
, "/.config/user-dirs.dirs");
765 *config_file
= HeapAlloc(GetProcessHeap(), 0, strlen(config_home
) + strlen("/user-dirs.dirs") + 1);
767 return E_OUTOFMEMORY
;
769 strcpy(*config_file
, config_home
);
770 strcat(*config_file
, "/user-dirs.dirs");
775 /* Parse the key in a line in the xdg-user-dir config file.
776 * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
779 * [in] xdg_dirs - array of xdg directories to look for
780 * [in] num_dirs - number of elements in xdg_dirs
781 * [in/out] p_ptr - pointer to where we are in the buffer
782 * Returns the index to xdg_dirs if we find the key, or -1 on error.
784 static int parse_config1(const char * const *xdg_dirs
, const unsigned int num_dirs
, char ** p_ptr
)
790 while (*p
== ' ' || *p
== '\t')
792 if (strncmp(p
, "XDG_", 4))
796 for (i
= 0; i
< num_dirs
; i
++)
798 if (!strncmp(p
, xdg_dirs
[i
], strlen(xdg_dirs
[i
])))
800 p
+= strlen(xdg_dirs
[i
]);
806 if (strncmp(p
, "_DIR", 4))
809 while (*p
== ' ' || *p
== '\t')
814 while (*p
== ' ' || *p
== '\t')
824 /* Parse the value in a line in the xdg-user-dir config file.
825 * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
828 * [in] p - pointer to the buffer
829 * [in] home_dir - $HOME
830 * [out] out_ptr - the directory name
832 static HRESULT
parse_config2(char * p
, const char * home_dir
, char ** out_ptr
)
839 if (!strncmp(p
, "$HOME/", 6))
849 out
= HeapAlloc(GetProcessHeap(), 0, strlen(home_dir
) + strlen(p
) + 2);
851 return E_OUTOFMEMORY
;
853 strcpy(out
, home_dir
);
858 out
= HeapAlloc(GetProcessHeap(), 0, strlen(p
) + 1);
860 return E_OUTOFMEMORY
;
864 d
= out
+ strlen(out
);
865 while (*p
&& *p
!= '"')
867 if ((*p
== '\\') && (*(p
+ 1) != 0))
876 /* Parse part of a line in the xdg-user-dir config file.
877 * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
880 * The calling function is responsible for freeing all elements of out_ptr as
881 * well as out_ptr itself.
883 * [in] xdg_dirs - array of xdg directories to look for
884 * [in] num_dirs - number of elements in xdg_dirs
885 * [out] out_ptr - an array of the xdg directories names
887 HRESULT
XDG_UserDirLookup(const char * const *xdg_dirs
, const unsigned int num_dirs
, char *** out_ptr
)
891 char *home_dir
, *config_file
;
897 *out_ptr
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, num_dirs
* sizeof(char *));
900 return E_OUTOFMEMORY
;
902 home_dir
= getenv("HOME");
906 goto xdg_user_dir_lookup_error
;
909 hr
= get_xdg_config_file(home_dir
, &config_file
);
911 goto xdg_user_dir_lookup_error
;
913 file
= fopen(config_file
, "r");
914 HeapFree(GetProcessHeap(), 0, config_file
);
918 goto xdg_user_dir_lookup_error
;
921 while (fgets(buffer
, sizeof(buffer
), file
))
926 /* Remove newline at end */
927 len
= strlen(buffer
);
928 if (len
> 0 && buffer
[len
-1] == '\n')
933 idx
= parse_config1(xdg_dirs
, num_dirs
, &p
);
939 /* Parse the value */
940 hr
= parse_config2(p
, home_dir
, &out
[idx
]);
943 if (hr
== E_OUTOFMEMORY
)
944 goto xdg_user_dir_lookup_error
;
950 /* Remove entries for directories that do not exist */
951 for (i
= 0; i
< num_dirs
; i
++)
953 struct stat statFolder
;
957 if (!stat(out
[i
], &statFolder
) && S_ISDIR(statFolder
.st_mode
))
959 HeapFree(GetProcessHeap(), 0, out
[i
]);
963 xdg_user_dir_lookup_error
:
966 for (i
= 0; i
< num_dirs
; i
++) HeapFree(GetProcessHeap(), 0, out
[i
]);
967 HeapFree(GetProcessHeap(), 0, *out_ptr
);