dlls/shell32/xdg.c

   1 /*
   2  * Generic freedesktop.org support code
   3  *
   4  * Copyright (C) 2006 Mikolaj Zalewski
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  *
  21  * XDG_UserDirLookup() and helper functions are based on code from:
  22  * http://www.freedesktop.org/wiki/Software/xdg-user-dirs
  23  *
  24  * Copyright (c) 2007 Red Hat, inc
  25  *
  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:
  34  *
  35  * The above copyright notice and this permission notice shall be
  36  * included in all copies or substantial portions of the Software.
  37  *
  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
  45  * SOFTWARE.
  46  */
  47
  48 #include "config.h"
  49 #include "wine/port.h"
  50
  51 #include <stdio.h>
  52 #include <stdarg.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #ifdef HAVE_SYS_STAT_H
  56 # include <sys/stat.h>
  57 #endif
  58 #ifdef HAVE_UNISTD_H
  59 # include <unistd.h>
  60 #endif
  61 #include <errno.h>
  62
  63 #include "windef.h"
  64 #include "winbase.h"
  65 #include "winreg.h"
  66 #include "shlwapi.h"
  67 #include "wine/debug.h"
  68 #include "shell32_main.h"
  69 #include "xdg.h"
  70
  71 WINE_DEFAULT_DEBUG_CHANNEL(xdg);
  72
  73 /*
  74  * XDG paths implemented using Desktop Base Directory spec version 0.6
  75  * (from http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html)
  76  */
  77
  78 static CRITICAL_SECTION XDG_PathsLock;
  79 static CRITICAL_SECTION_DEBUG XDG_PathsLock_Debug =
  80 {
  81     0, 0, &XDG_PathsLock,
  82     { &XDG_PathsLock_Debug.ProcessLocksList,
  83       &XDG_PathsLock_Debug.ProcessLocksList},
  84     0, 0, { (DWORD_PTR)__FILE__ ": XDG_PathsLock"}
  85 };
  86 static CRITICAL_SECTION XDG_PathsLock = { &XDG_PathsLock_Debug, -1, 0, 0, 0, 0 };
  87
  88 typedef struct
  89 {
  90     const char *var_name;
  91     const char *default_value;
  92 } std_path;
  93
  94 static const std_path paths[] = {
  95     {"XDG_DATA_HOME", "$HOME/.local/share"},
  96     {"XDG_CONFIG_HOME", "$HOME/.config"},
  97     {"XDG_DATA_DIRS", "/usr/local/share:/usr/share"},
  98     {"XDG_CONFIG_DIRS", "/etc/xdg"},
  99     {"XDG_CACHE_HOME", "$HOME/.cache"}
 100 };
 101
 102 /* will be filled with paths as they are computed */
 103 static const char *path_values[ARRAY_SIZE(paths)] = {
 104     NULL,
 105     NULL,
 106     NULL,
 107     NULL,
 108     NULL
 109 };
 110
 111 static char *load_path(int path_id)
 112 {
 113     char *env = getenv(paths[path_id].var_name);
 114     char *ret;
 115
 116     if (env != NULL && env[0]=='/')
 117     {
 118         ret = SHAlloc(strlen(env)+1);
 119         if (ret != NULL)
 120             lstrcpyA(ret, env);
 121         return ret;
 122     }
 123
 124     if (memcmp(paths[path_id].default_value, "$HOME", 5)==0)
 125     {
 126         char *home = getenv("HOME");
 127         int len;
 128
 129         if (!home) return NULL;
 130         ret = SHAlloc(strlen(home)+strlen(paths[path_id].default_value)-5+1);
 131         if (ret == NULL) return NULL;
 132
 133         lstrcpyA(ret, home);
 134         len = strlen(ret);
 135         if (len>0 && ret[len-1]=='/')
 136             ret[--len]=0;
 137         lstrcatA(ret, paths[path_id].default_value+5);
 138         return ret;
 139     }
 140
 141     ret = SHAlloc(strlen(paths[path_id].default_value)+1);
 142     if (ret != NULL)
 143         lstrcpyA(ret, paths[path_id].default_value);
 144     return ret;
 145 }
 146
 147 /******************************************************************************
 148  * XDG_GetPath    [internal]
 149  *
 150  * Get one of the XDG standard patch. The return value shouldn't be modified nor
 151  * freed. A return value of NULL means that the memory is exhausted or the input
 152  * is invalid
 153  *
 154  * For XDG_DATA_HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME the result is a Unix path.
 155  * For XDG_DATA_DIRS and XDG_CONFIG_DIRS the result is a colon-separated list of Unix
 156  * paths
 157  *
 158  * The paths are guaranteed to start with '/'
 159  */
 160 static const char *XDG_GetPath(int path_id)
 161 {
 162     if (path_id >= ARRAY_SIZE(paths) || path_id < 0)
 163     {
 164         ERR("Invalid path_id %d\n", path_id);
 165         return NULL;
 166     }
 167
 168     if (path_values[path_id] != NULL)
 169         return path_values[path_id];
 170     EnterCriticalSection(&XDG_PathsLock);
 171     if (path_values[path_id] == NULL)
 172         path_values[path_id] = load_path(path_id);
 173     LeaveCriticalSection(&XDG_PathsLock);
 174     return path_values[path_id];
 175 }
 176
 177 /******************************************************************************
 178  * XDG_BuildPath    [internal]
 179  *
 180  * Build a string with a subpath of one of the XDG standard paths.
 181  * The root can be one of XDG_DATA_HOME, XDG_CONFIG_HOME and XDG_CACHE_HOME.
 182  * The subpath is a path relative to that root (it shouldn't start with a slash)
 183  *
 184  * The returned path should be freed with SHFree. A return of NULL means that the
 185  * memory is exhausted or the parameters are invalid
 186  */
 187 char *XDG_BuildPath(int root_id, const char *subpath)
 188 {
 189     const char *root_path = XDG_GetPath(root_id);
 190     char *ret_buffer;
 191     int root_len;
 192
 193     if (root_id == XDG_DATA_DIRS || root_id == XDG_CONFIG_DIRS)
 194     {
 195         ERR("Invalid path id %d\n", root_id);
 196         return NULL;
 197     }
 198
 199     if (root_path == NULL) return NULL;
 200     root_len = strlen(root_path);
 201     if (root_path[root_len-1]=='/') root_len--;
 202     ret_buffer = SHAlloc(root_len+1+strlen(subpath)+1);
 203     if (ret_buffer == NULL) return NULL;
 204     lstrcpyA(ret_buffer, root_path);
 205     ret_buffer[root_len]='/';
 206     lstrcpyA(ret_buffer+root_len+1, subpath);
 207     return ret_buffer;
 208 }
 209
 210 /******************************************************************************
 211  * XDG_MakeDirs    [internal]
 212  *
 213  * Checks that all the directories on the specified path exists. If some don't exists
 214  * they are created with mask 0700 as required by many the freedeskop.org specs.
 215  * If the path doesn't end with '/' it is assumed to be a path to a file and the last
 216  * segment is not checked
 217  *
 218  * In case of a failure the errno is always set and can be used e.g for debugging
 219  *
 220  * RETURNS
 221  *   TRUE on success, FALSE on error
 222  */
 223 BOOL XDG_MakeDirs(const char *path)
 224 {
 225     int last_slash = 0;
 226     BOOL success = TRUE;
 227     struct stat tmp;
 228     char *buffer = SHAlloc(strlen(path)+1);
 229
 230     if (buffer == NULL)
 231     {
 232         errno = ENOMEM;
 233         return FALSE;
 234     }
 235     lstrcpyA(buffer, path);
 236
 237     TRACE("(%s)\n", debugstr_a(path));
 238     while (1)
 239     {
 240         char *slash=strchr(buffer+last_slash+1, '/');
 241         if (slash==NULL)
 242             break;
 243
 244         /* cut the string at that position and create the directory if it doesn't exist */
 245         *slash=0;
 246         TRACE("Checking path %s\n", debugstr_a(buffer));
 247         success = (stat(buffer, &tmp)==0);
 248         if (!success && errno==ENOENT)
 249         {
 250             TRACE("Creating\n");
 251             success = (mkdir(buffer, 0700)==0);
 252         }
 253         if (!success)
 254         {
 255             WARN("Couldn't process directory %s (errno=%d)\n", debugstr_a(buffer), errno);
 256             break;
 257         }
 258         *slash='/';
 259         last_slash = slash-buffer;
 260     }
 261     SHFree(buffer);
 262     return success;
 263 }
 264
 265 /*
 266  * .desktop files functions
 267  */
 268
 269
 270 /******************************************************************************
 271  * dskentry_encode    [internal]
 272  *
 273  * Escape the characters that can't be present in a desktop entry value like \n, leading
 274  * spaces etc. The output parameter may be NULL. Then only the number of characters will
 275  * be computers.
 276  *
 277  * RETURNS
 278  *   The number of characters after escaping the special characters, including the
 279  * terminating NUL.
 280  */
 281 static int dskentry_encode(const char *value, char *output)
 282 {
 283     BOOL only_spc = TRUE;
 284     int num_written = 0;
 285     const char *c;
 286     for (c = value; *c; c++)
 287     {
 288         if (only_spc && *c==' ')
 289         {
 290             if (output)
 291             {
 292                 *(output++) = '\\';
 293                 *(output++) = 's';
 294             }
 295             num_written += 2;
 296             continue;
 297         }
 298         only_spc = FALSE;
 299
 300         if (*c=='\t' || *c=='\r' || *c=='\n' || *c=='\\')
 301         {
 302             if (output)
 303             {
 304                 *(output++) = '\\';
 305                 if (*c=='\t') *(output++) = 't';
 306                 if (*c=='\r') *(output++) = 'r';
 307                 if (*c=='\n') *(output++) = 'n';
 308                 if (*c=='\\') *(output++) = '\\';
 309             }
 310             num_written += 2;
 311         }
 312         else
 313         {
 314             if (output)
 315                 *(output++)=*c;
 316             num_written++;
 317         }
 318     }
 319
 320     if (output)
 321         *(output++) = 0;
 322     num_written++;
 323     return num_written;
 324 }
 325
 326 /******************************************************************************
 327  * dskentry_decode    [internal]
 328  *
 329  * Unescape the characters that can be escaped according to the desktop entry spec.
 330  * The output parameter may be NULL. Then only the number of characters will
 331  * be computers.
 332  *
 333  * RETURNS
 334  *   The number of characters after unescaping the special characters, including the
 335  * terminating NUL.
 336  */
 337 static int dskentry_decode(const char *value, int len, char *output)
 338 {
 339     int pos = 0;
 340     int count = 0;
 341     while (pos<len)
 342     {
 343         char c;
 344         if (pos<len-1 && value[pos] == '\\')
 345         {
 346             pos++;
 347             switch (value[pos])
 348             {
 349                 case 's': c = ' '; break;
 350                 case 'n': c = '\n'; break;
 351                 case 't': c = '\t'; break;
 352                 case 'r': c = 'r'; break;
 353                 case '\\': c = '\\'; break;
 354                 default:
 355                     /* store both the backslash and the character */
 356                     if (output)
 357                         *(output++) = '\\';
 358                     count++;
 359                     c = value[pos];
 360                     break;
 361             }
 362         }
 363         else
 364             c = value[pos];
 365
 366         if (output)
 367             *(output++) = c;
 368         count++;
 369         pos++;
 370     }
 371
 372     if (output)
 373         *(output++) = 0;
 374     count++;
 375     return count;
 376 }
 377
 378
 379 /******************************************************************************
 380  * url_encode    [internal]
 381  *
 382  * URL-encode the given string (i.e. use escape codes like %20). Note that an
 383  * URL-encoded string can be used as a value in desktop entry files as all
 384  * unsafe characters are escaped.
 385  *
 386  * The output can be NULL. Then only the number of characters will be counted
 387  *
 388  * RETURNS
 389  *   The number of characters after escaping the special characters, including the
 390  * terminating NUL.
 391  */
 392 static int url_encode(const char *value, char *output)
 393 {
 394     static const char unsafechars[] = "^&`{}|[]'<>\\#%\"+";
 395     static const char hexchars[] = "0123456789ABCDEF";
 396     int num_written = 0;
 397     const char *c;
 398
 399     for (c = value; *c; c++)
 400     {
 401         if (*c<=0x20 || *c>=0x7f || strchr(unsafechars, *c))
 402         {
 403             if (output)
 404             {
 405                 *(output++) = '%';
 406                 *(output++) = hexchars[(unsigned char)*c / 16];
 407                 *(output++) = hexchars[(unsigned char)*c % 16];
 408             }
 409             num_written += 3;
 410         }
 411         else
 412         {
 413             if (output)
 414                 *(output++) = *c;
 415             num_written++;
 416         }
 417     }
 418
 419     if (output)
 420         *(output++) = 0;
 421     num_written++;
 422
 423     return num_written;
 424 }
 425
 426 static int decode_url_code(const char *c)
 427 {
 428     const char *p1, *p2;
 429     int v1, v2;
 430     static const char hexchars[] = "0123456789ABCDEF";
 431     if (*c == 0)
 432         return -1;
 433
 434     p1 = strchr(hexchars, toupper(*c));
 435     p2 = strchr(hexchars, toupper(*(c+1)));
 436     if (p1 == NULL || p2 == NULL)
 437         return -1;
 438     v1 = (int)(p1 - hexchars);
 439     v2 = (int)(p2 - hexchars);
 440     return (v1<<4) + v2;
 441 }
 442
 443 /******************************************************************************
 444  * url_decode    [internal]
 445  *
 446  * URL-decode the given string (i.e. unescape codes like %20). The decoded string
 447  * will never be longer than the encoded one. The decoding can be done in place - the
 448  * output variable can point to the value buffer.
 449  *
 450  * output should not be NULL
 451  */
 452 static void url_decode(const char *value, char *output)
 453 {
 454     const char *c = value;
 455     while (*c)
 456     {
 457         if (*c == '%')
 458         {
 459             int v = decode_url_code(c+1);
 460             if (v != -1)
 461             {
 462                 *(output++) = v;
 463                 c += 3;
 464                 continue;
 465             }
 466         }
 467
 468         *(output++) = *c;
 469         c++;
 470     }
 471     *output = 0;
 472 }
 473
 474 static int escape_value(const char *value, DWORD dwFlags, char *output)
 475 {
 476     if (dwFlags & XDG_URLENCODE)
 477         return url_encode(value, output);
 478     return dskentry_encode(value, output);
 479 }
 480
 481 /******************************************************************************
 482  * XDG_WriteDesktopStringEntry    [internal]
 483  *
 484  * Writes a key=value pair into the specified file descriptor.
 485  *
 486  * RETURNS
 487  *   TRUE on success, else FALSE
 488  */
 489 BOOL XDG_WriteDesktopStringEntry(int writer, const char *keyName, DWORD dwFlags, const char *value)
 490 {
 491     int keyLen = lstrlenA(keyName);
 492     int valueLen = escape_value(value, dwFlags, NULL);
 493     char *string = SHAlloc(keyLen+1+valueLen);
 494     BOOL ret;
 495
 496     if (string == NULL)
 497         return FALSE;
 498     lstrcpyA(string, keyName);
 499     string[keyLen] = '=';
 500     escape_value(value, dwFlags, string+keyLen+1);
 501     string[keyLen+1+valueLen-1]='\n';   /* -1 because valueLen contains the last NUL character */
 502     ret = (write(writer, string, keyLen+1+valueLen)!=-1);
 503     SHFree(string);
 504     return ret;
 505 }
 506
 507 typedef struct
 508 {
 509     char *str;
 510     int len;
 511 } PARSED_STRING;
 512
 513 typedef struct tagPARSED_ENTRY PARSED_ENTRY;
 514 struct tagPARSED_ENTRY
 515 {
 516     PARSED_STRING name;
 517     PARSED_STRING equals;
 518     PARSED_STRING value;
 519     PARSED_ENTRY *next;
 520 };
 521
 522 typedef struct tagPARSED_GROUP PARSED_GROUP;
 523 struct tagPARSED_GROUP
 524 {
 525     PARSED_STRING name;
 526     PARSED_ENTRY *entries;
 527     PARSED_GROUP *next;
 528 };
 529
 530
 531 struct tagXDG_PARSED_FILE
 532 {
 533     char *contents;
 534     PARSED_ENTRY *head_comments;
 535     PARSED_GROUP *groups;
 536 };
 537
 538 static BOOL parsed_str_eq(const PARSED_STRING *str1, const char *str2)
 539 {
 540     if (strncmp(str1->str, str2, str1->len) != 0)
 541         return FALSE;
 542     if (str2[str1->len] != 0)
 543         return FALSE;
 544     return TRUE;
 545 }
 546
 547 static void free_entries_list(PARSED_ENTRY *first)
 548 {
 549     PARSED_ENTRY *next;
 550     while (first)
 551     {
 552         next = first->next;
 553         SHFree(first);
 554         first = next;
 555     }
 556 }
 557
 558 void XDG_FreeParsedFile(XDG_PARSED_FILE *parsed)
 559 {
 560     PARSED_GROUP *group, *next;
 561     if (!parsed)
 562         return;
 563     free_entries_list(parsed->head_comments);
 564
 565     group = parsed->groups;
 566     while (group)
 567     {
 568         next = group->next;
 569         free_entries_list(group->entries);
 570         SHFree(group);
 571         group = next;
 572     }
 573     SHFree(parsed->contents);
 574     SHFree(parsed);
 575 }
 576
 577 #define LINE_GROUP   1
 578 #define LINE_ENTRY   2
 579 #define LINE_COMMENT 3
 580
 581 static int parse_line(char *content, PARSED_ENTRY *output, int *outType)
 582 {
 583     char *end;
 584
 585     ZeroMemory(output, sizeof(PARSED_ENTRY));
 586     end = strchr(content, '\n');
 587     if (end == NULL)
 588         end = content + strlen(content) - 1;
 589
 590     if (*content == '#')
 591     {
 592         *outType = LINE_COMMENT;
 593         output->equals.str = content;
 594         output->equals.len = end - content;
 595         if (*end != '\n')
 596             output->equals.len++;
 597     }
 598     else if (*content == '[')
 599     {
 600         char *last_char = end;
 601
 602         *outType = LINE_GROUP;
 603
 604         /* the standard says nothing about skipping white spaces but e.g. KDE accepts such files */
 605         while (isspace(*last_char))
 606             last_char--;
 607         if (*last_char != ']')
 608             return -1;
 609         output->name.str = content + 1;
 610         output->name.len = last_char - (content + 1);
 611     }
 612     else
 613     {
 614         /* 'name = value' line */
 615         char *equal, *eq_begin, *eq_end;
 616
 617         *outType = LINE_ENTRY;
 618
 619         equal = strchr(content, '=');
 620         if (equal == NULL || equal > end)
 621             return -1;
 622         for (eq_begin = equal-1;  isspace(*eq_begin) && eq_begin >= content; eq_begin--)
 623             ;
 624         for (eq_end = equal+1; isspace(*eq_end) && *eq_end != '\n'; eq_end++)
 625             ;
 626
 627         output->name.str = content;
 628         output->name.len = eq_begin - content + 1;
 629
 630         output->equals.str = eq_begin + 1;
 631         output->equals.len = eq_end - eq_begin - 1;
 632
 633         output->value.str = eq_end;
 634         output->value.len = end - eq_end;
 635
 636         if (*end != '\n')
 637             output->value.len++;
 638     }
 639     return end - content + 1;
 640 }
 641
 642 XDG_PARSED_FILE *XDG_ParseDesktopFile(int fd)
 643 {
 644     struct stat stats;
 645     XDG_PARSED_FILE *parsed = NULL;
 646     PARSED_ENTRY **curr_entry;
 647     PARSED_GROUP **curr_group;
 648     BOOL is_in_group = FALSE;
 649
 650     int pos = 0;
 651
 652     if (fstat(fd, &stats) == -1) goto failed;
 653     parsed = SHAlloc(sizeof(XDG_PARSED_FILE));
 654     if (parsed == NULL) goto failed;
 655     parsed->groups = NULL;
 656     parsed->head_comments = NULL;
 657     parsed->contents = SHAlloc(stats.st_size+1);
 658     if (parsed->contents == NULL) goto failed;
 659
 660     curr_entry = &parsed->head_comments;
 661     curr_group = &parsed->groups;
 662
 663     if (read(fd, parsed->contents, stats.st_size) == -1) goto failed;
 664     parsed->contents[stats.st_size] = 0;
 665
 666     while (pos < stats.st_size)
 667     {
 668         PARSED_ENTRY statement;
 669         int type, size;
 670
 671         size = parse_line(parsed->contents + pos, &statement, &type);
 672         if (size == -1) goto failed;
 673         if (size == 0)
 674             break;
 675         pos += size;
 676
 677         switch (type)
 678         {
 679             case LINE_GROUP:
 680             {
 681                 PARSED_GROUP *group = SHAlloc(sizeof(PARSED_GROUP));
 682                 if (group == NULL) goto failed;
 683                 is_in_group = TRUE;
 684
 685                 group->name = statement.name;
 686                 group->entries = NULL;
 687                 group->next = NULL;
 688                 *curr_group = group;
 689                 curr_group = &group->next;
 690                 curr_entry = &group->entries;
 691                 break;
 692             }
 693
 694             case LINE_ENTRY:
 695                 if (!is_in_group) goto failed;
 696                 /* fall through */
 697             case LINE_COMMENT:
 698             {
 699                 PARSED_ENTRY *new_stat = SHAlloc(sizeof(PARSED_ENTRY));
 700                 if (new_stat == NULL) goto failed;
 701                 *new_stat = statement;
 702                 new_stat->next = NULL;
 703                 *curr_entry = new_stat;
 704                 curr_entry = &new_stat->next;
 705                 break;
 706             }
 707         }
 708     }
 709     return parsed;
 710
 711 failed:
 712     XDG_FreeParsedFile(parsed);
 713     return NULL;
 714 }
 715
 716 char *XDG_GetStringValue(XDG_PARSED_FILE *file, const char *group_name, const char *value_name, DWORD dwFlags)
 717 {
 718     PARSED_GROUP *group;
 719     PARSED_ENTRY *entry;
 720
 721     for (group = file->groups; group; group = group->next)
 722     {
 723         if (!parsed_str_eq(&group->name, group_name))
 724             continue;
 725
 726         for (entry = group->entries; entry; entry = entry->next)
 727             if (entry->name.str != NULL && parsed_str_eq(&entry->name, value_name))
 728             {
 729                 int len;
 730                 char *ret;
 731
 732                 len = dskentry_decode(entry->value.str, entry->value.len, NULL);
 733                 ret = SHAlloc(len);
 734                 if (ret == NULL) return NULL;
 735                 dskentry_decode(entry->value.str, entry->value.len, ret);
 736                 if (dwFlags & XDG_URLENCODE)
 737                     url_decode(ret, ret);
 738                 return ret;
 739             }
 740     }
 741
 742     return NULL;
 743 }
 744
 745 /* Get the name of the xdg configuration file.
 746  *
 747  * [in] home_dir - $HOME
 748  * [out] config_file - the name of the configuration file
 749  */
 750 static HRESULT get_xdg_config_file(char * home_dir, char ** config_file)
 751 {
 752     char *config_home;
 753
 754     config_home = getenv("XDG_CONFIG_HOME");
 755     if (!config_home || !config_home[0])
 756     {
 757         *config_file = heap_alloc(strlen(home_dir) + strlen("/.config/user-dirs.dirs") + 1);
 758         if (!*config_file)
 759             return E_OUTOFMEMORY;
 760
 761         strcpy(*config_file, home_dir);
 762         strcat(*config_file, "/.config/user-dirs.dirs");
 763     }
 764     else
 765     {
 766         *config_file = heap_alloc(strlen(config_home) + strlen("/user-dirs.dirs") + 1);
 767         if (!*config_file)
 768             return E_OUTOFMEMORY;
 769
 770         strcpy(*config_file, config_home);
 771         strcat(*config_file, "/user-dirs.dirs");
 772     }
 773     return S_OK;
 774 }
 775
 776 /* Parse the key in a line in the xdg-user-dir config file.
 777  * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
 778  *      ^                ^
 779  *
 780  * [in] xdg_dirs - array of xdg directories to look for
 781  * [in] num_dirs - number of elements in xdg_dirs
 782  * [in/out] p_ptr - pointer to where we are in the buffer
 783  * Returns the index to xdg_dirs if we find the key, or -1 on error.
 784  */
 785 static int parse_config1(const char * const *xdg_dirs, const unsigned int num_dirs, char ** p_ptr)
 786 {
 787     char *p;
 788     int i;
 789
 790     p = *p_ptr;
 791     while (*p == ' ' || *p == '\t')
 792         p++;
 793     if (strncmp(p, "XDG_", 4))
 794         return -1;
 795
 796     p += 4;
 797     for (i = 0; i < num_dirs; i++)
 798     {
 799         if (!strncmp(p, xdg_dirs[i], strlen(xdg_dirs[i])))
 800         {
 801             p += strlen(xdg_dirs[i]);
 802             break;
 803         }
 804     }
 805     if (i == num_dirs)
 806         return -1;
 807     if (strncmp(p, "_DIR", 4))
 808         return -1;
 809     p += 4;
 810     while (*p == ' ' || *p == '\t')
 811         p++;
 812     if (*p != '=')
 813         return -1;
 814     p++;
 815     while (*p == ' ' || *p == '\t')
 816         p++;
 817     if (*p != '"')
 818         return -1;
 819     p++;
 820
 821     *p_ptr = p;
 822     return i;
 823 }
 824
 825 /* Parse the value in a line in the xdg-user-dir config file.
 826  * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
 827  *                        ^             ^
 828  *
 829  * [in] p - pointer to the buffer
 830  * [in] home_dir - $HOME
 831  * [out] out_ptr - the directory name
 832  */
 833 static HRESULT parse_config2(char * p, const char * home_dir, char ** out_ptr)
 834 {
 835     BOOL relative;
 836     char *out, *d;
 837
 838     relative = FALSE;
 839
 840     if (!strncmp(p, "$HOME/", 6))
 841     {
 842         p += 6;
 843         relative = TRUE;
 844     }
 845     else if (*p != '/')
 846         return E_FAIL;
 847
 848     if (relative)
 849     {
 850         out = heap_alloc(strlen(home_dir) + strlen(p) + 2);
 851         if (!out)
 852             return E_OUTOFMEMORY;
 853
 854         strcpy(out, home_dir);
 855         strcat(out, "/");
 856     }
 857     else
 858     {
 859         out = heap_alloc(strlen(p) + 1);
 860         if (!out)
 861             return E_OUTOFMEMORY;
 862         *out = 0;
 863     }
 864
 865     d = out + strlen(out);
 866     while (*p && *p != '"')
 867     {
 868         if ((*p == '\\') && (*(p + 1) != 0))
 869             p++;
 870         *d++ = *p++;
 871     }
 872     *d = 0;
 873     *out_ptr = out;
 874     return S_OK;
 875 }
 876
 877 /* Parse part of a line in the xdg-user-dir config file.
 878  * i.e. XDG_PICTURES_DIR="$HOME/Pictures"
 879  *                        ^             ^
 880  *
 881  * The calling function is responsible for freeing all elements of out_ptr as
 882  * well as out_ptr itself.
 883  *
 884  * [in] xdg_dirs - array of xdg directories to look for
 885  * [in] num_dirs - number of elements in xdg_dirs
 886  * [out] out_ptr - an array of the xdg directories names
 887  */
 888 HRESULT XDG_UserDirLookup(const char * const *xdg_dirs, const unsigned int num_dirs, char *** out_ptr)
 889 {
 890     FILE *file;
 891     char **out;
 892     char *home_dir, *config_file;
 893     char buffer[512];
 894     int len;
 895     unsigned int i;
 896     HRESULT hr;
 897
 898     *out_ptr = heap_alloc_zero(num_dirs * sizeof(char *));
 899     out = *out_ptr;
 900     if (!out)
 901         return E_OUTOFMEMORY;
 902
 903     home_dir = getenv("HOME");
 904     if (!home_dir)
 905     {
 906         hr = E_FAIL;
 907         goto xdg_user_dir_lookup_error;
 908     }
 909
 910     hr = get_xdg_config_file(home_dir, &config_file);
 911     if (FAILED(hr))
 912         goto xdg_user_dir_lookup_error;
 913
 914     file = fopen(config_file, "r");
 915     heap_free(config_file);
 916     if (!file)
 917     {
 918         hr = E_HANDLE;
 919         goto xdg_user_dir_lookup_error;
 920     }
 921
 922     while (fgets(buffer, sizeof(buffer), file))
 923     {
 924         int idx;
 925         char *p;
 926
 927         /* Remove newline at end */
 928         len = strlen(buffer);
 929         if (len > 0 && buffer[len-1] == '\n')
 930             buffer[len-1] = 0;
 931
 932         /* Parse the key */
 933         p = buffer;
 934         idx = parse_config1(xdg_dirs, num_dirs, &p);
 935         if (idx < 0)
 936             continue;
 937         if (out[idx])
 938             continue;
 939
 940         /* Parse the value */
 941         hr = parse_config2(p, home_dir, &out[idx]);
 942         if (FAILED(hr))
 943         {
 944             if (hr == E_OUTOFMEMORY)
 945             {
 946                 fclose(file);
 947                 goto xdg_user_dir_lookup_error;
 948             }
 949             continue;
 950         }
 951     }
 952     fclose (file);
 953     hr = S_OK;
 954
 955     /* Remove entries for directories that do not exist */
 956     for (i = 0; i <  num_dirs; i++)
 957     {
 958         struct stat statFolder;
 959
 960         if (!out[i])
 961             continue;
 962         if (!stat(out[i], &statFolder) && S_ISDIR(statFolder.st_mode))
 963             continue;
 964         heap_free(out[i]);
 965         out[i] = NULL;
 966     }
 967
 968 xdg_user_dir_lookup_error:
 969     if (FAILED(hr))
 970     {
 971         for (i = 0; i < num_dirs; i++)
 972             heap_free(out[i]);
 973         heap_free(*out_ptr);
 974     }
 975     return hr;
 976 }