1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* $Id: GetVBoxUserHomeDirectory.cpp $ */
/** @file
* MS COM / XPCOM Abstraction Layer - GetVBoxUserHomeDirectory.
*/
/*
* Copyright (C) 2005-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_MAIN
#include <VBox/com/utils.h>
#include <iprt/env.h>
#include <iprt/dir.h>
#include <iprt/param.h>
#include <iprt/path.h>
#include <iprt/string.h>
#include <VBox/err.h>
#include <VBox/log.h>
/*********************************************************************************************************************************
* Global Variables *
*********************************************************************************************************************************/
#if !defined(RT_OS_DARWIN) && !defined(RT_OS_WINDOWS)
char g_szXdgConfigHome[RTPATH_MAX] = "";
#endif
/**
* Possible locations for the VirtualBox user configuration folder,
* listed from oldest (as in legacy) to newest. These can be either
* absolute or relative to the home directory. We use the first entry
* of the list which corresponds to a real folder on storage, or
* create a folder corresponding to the last in the list (the least
* legacy) if none do.
*/
const char * const g_apcszUserHome[] =
{
#ifdef RT_OS_DARWIN
"Library/VirtualBox",
#elif defined RT_OS_WINDOWS
".VirtualBox",
#else
".VirtualBox", g_szXdgConfigHome,
#endif
};
namespace com
{
static int composeHomePath(char *aDir, size_t aDirLen, const char *pcszBase)
{
int vrc;
if (RTPathStartsWithRoot(pcszBase))
vrc = RTStrCopy(aDir, aDirLen, pcszBase);
else
{
/* compose the config directory (full path) */
/** @todo r=bird: RTPathUserHome doesn't necessarily return a
* full (abs) path like the comment above seems to indicate. */
vrc = RTPathUserHome(aDir, aDirLen);
if (RT_SUCCESS(vrc))
vrc = RTPathAppend(aDir, aDirLen, pcszBase);
}
return vrc;
}
int GetVBoxUserHomeDirectory(char *aDir, size_t aDirLen, bool fCreateDir)
{
AssertReturn(aDir, VERR_INVALID_POINTER);
AssertReturn(aDirLen > 0, VERR_BUFFER_OVERFLOW);
/* start with null */
*aDir = 0;
char szTmp[RTPATH_MAX];
int vrc = RTEnvGetEx(RTENV_DEFAULT, "VBOX_USER_HOME", szTmp, sizeof(szTmp), NULL);
if (RT_SUCCESS(vrc) || vrc == VERR_ENV_VAR_NOT_FOUND)
{
bool fFound = false;
if (RT_SUCCESS(vrc))
{
/* get the full path name */
vrc = RTPathAbs(szTmp, aDir, aDirLen);
}
else
{
#if !defined(RT_OS_WINDOWS) && !defined(RT_OS_DARWIN)
vrc = RTEnvGetEx(RTENV_DEFAULT, "XDG_CONFIG_HOME", g_szXdgConfigHome, sizeof(g_szXdgConfigHome), NULL);
if (RT_SUCCESS(vrc))
vrc = RTPathAppend(g_szXdgConfigHome, sizeof(g_szXdgConfigHome), "VirtualBox");
AssertMsg(vrc == VINF_SUCCESS || vrc == VERR_ENV_VAR_NOT_FOUND, ("%Rrc\n", vrc));
if (RT_FAILURE_NP(vrc))
vrc = RTStrCopy(g_szXdgConfigHome, sizeof(g_szXdgConfigHome), ".config/VirtualBox");
#endif
for (unsigned i = 0; i < RT_ELEMENTS(g_apcszUserHome); ++i)
{
vrc = composeHomePath(aDir, aDirLen, g_apcszUserHome[i]);
if ( RT_SUCCESS(vrc)
&& RTDirExists(aDir))
{
fFound = true;
break;
}
}
}
/* ensure the home directory exists */
if (RT_SUCCESS(vrc))
if (!fFound && fCreateDir)
vrc = RTDirCreateFullPath(aDir, 0700);
}
return vrc;
}
} /* namespace com */
|
