| 1 | /* $Id: RTPathUserDocuments-darwin.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - RTPathUserDocuments, darwin ring-3.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2011-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /*********************************************************************************************************************************
|
|---|
| 39 | * Header Files *
|
|---|
| 40 | *********************************************************************************************************************************/
|
|---|
| 41 | #include <iprt/path.h>
|
|---|
| 42 | #include "internal/iprt.h"
|
|---|
| 43 |
|
|---|
| 44 | #include <iprt/assert.h>
|
|---|
| 45 | #include <iprt/string.h>
|
|---|
| 46 | #include <iprt/err.h>
|
|---|
| 47 |
|
|---|
| 48 | #if MAC_OS_X_VERSION_MIN_REQUIRED >= 101200
|
|---|
| 49 | # include <sysdir.h>
|
|---|
| 50 | #else
|
|---|
| 51 | # include <NSSystemDirectories.h>
|
|---|
| 52 | #endif
|
|---|
| 53 | #include <sys/syslimits.h>
|
|---|
| 54 | #ifdef IPRT_USE_CORE_SERVICE_FOR_USER_DOCUMENTS
|
|---|
| 55 | # include <CoreServices/CoreServices.h>
|
|---|
| 56 | #endif
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | RTDECL(int) RTPathUserDocuments(char *pszPath, size_t cchPath)
|
|---|
| 60 | {
|
|---|
| 61 | /*
|
|---|
| 62 | * Validate input
|
|---|
| 63 | */
|
|---|
| 64 | AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
|
|---|
| 65 | AssertReturn(cchPath, VERR_INVALID_PARAMETER);
|
|---|
| 66 |
|
|---|
| 67 | /*
|
|---|
| 68 | * Try NSSystemDirectories first since that works for directories that doesn't exist.
|
|---|
| 69 | * The NSSystemDirectories API was renamed in 10.12 to sysdir.
|
|---|
| 70 | */
|
|---|
| 71 | int rc = VERR_PATH_NOT_FOUND;
|
|---|
| 72 | #if MAC_OS_X_VERSION_MIN_REQUIRED >= 101200
|
|---|
| 73 | sysdir_search_path_enumeration_state EnmState = sysdir_start_search_path_enumeration(SYSDIR_DIRECTORY_DOCUMENT,
|
|---|
| 74 | SYSDIR_DOMAIN_MASK_USER);
|
|---|
| 75 | #else
|
|---|
| 76 | NSSearchPathEnumerationState EnmState = NSStartSearchPathEnumeration(NSDocumentDirectory, NSUserDomainMask);
|
|---|
| 77 | #endif
|
|---|
| 78 | if (EnmState != 0)
|
|---|
| 79 | {
|
|---|
| 80 | char szTmp[PATH_MAX];
|
|---|
| 81 | szTmp[0] = szTmp[PATH_MAX - 1] = '\0';
|
|---|
| 82 | #if MAC_OS_X_VERSION_MIN_REQUIRED >= 101200
|
|---|
| 83 | EnmState = sysdir_get_next_search_path_enumeration(EnmState, szTmp);
|
|---|
| 84 | #else
|
|---|
| 85 | EnmState = NSGetNextSearchPathEnumeration(EnmState, szTmp);
|
|---|
| 86 | #endif
|
|---|
| 87 | if (EnmState != 0)
|
|---|
| 88 | {
|
|---|
| 89 | size_t cchTmp = strlen(szTmp);
|
|---|
| 90 | if (cchTmp >= cchPath)
|
|---|
| 91 | return VERR_BUFFER_OVERFLOW;
|
|---|
| 92 |
|
|---|
| 93 | if (szTmp[0] == '~' && szTmp[1] == '/')
|
|---|
| 94 | {
|
|---|
| 95 | /* Expand tilde. */
|
|---|
| 96 | rc = RTPathUserHome(pszPath, cchPath - cchTmp + 2);
|
|---|
| 97 | if (RT_FAILURE(rc))
|
|---|
| 98 | return rc;
|
|---|
| 99 | rc = RTPathAppend(pszPath, cchPath, &szTmp[2]);
|
|---|
| 100 | }
|
|---|
| 101 | else
|
|---|
| 102 | rc = RTStrCopy(pszPath, cchPath, szTmp);
|
|---|
| 103 | return rc;
|
|---|
| 104 | }
|
|---|
| 105 | }
|
|---|
| 106 |
|
|---|
| 107 | #ifdef IPRT_USE_CORE_SERVICE_FOR_USER_DOCUMENTS
|
|---|
| 108 | /*
|
|---|
| 109 | * Fall back on FSFindFolder in case the above should fail...
|
|---|
| 110 | */
|
|---|
| 111 | FSRef ref;
|
|---|
| 112 | OSErr err = FSFindFolder(kOnAppropriateDisk, kDocumentsFolderType, false /* createFolder */, &ref);
|
|---|
| 113 | if (err == noErr)
|
|---|
| 114 | {
|
|---|
| 115 | err = FSRefMakePath(&ref, (UInt8*)pszPath, cchPath);
|
|---|
| 116 | if (err == noErr)
|
|---|
| 117 | return VINF_SUCCESS;
|
|---|
| 118 | }
|
|---|
| 119 | #endif
|
|---|
| 120 | Assert(RT_FAILURE_NP(rc));
|
|---|
| 121 | return rc;
|
|---|
| 122 | }
|
|---|
| 123 |
|
|---|
