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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
/* $Id: SharedFolderImpl.cpp $ */
/** @file
* VirtualBox COM class implementation
*/
/*
* Copyright (C) 2006-2022 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
*/
#define LOG_GROUP LOG_GROUP_MAIN_SHAREDFOLDER
#include "SharedFolderImpl.h"
#include "VirtualBoxImpl.h"
#include "MachineImpl.h"
#include "ConsoleImpl.h"
#include "AutoCaller.h"
#include <iprt/param.h>
#include <iprt/cpp/utils.h>
#include <iprt/path.h>
/////////////////////////////////////////////////////////////////////////////
// SharedFolder::Data structure
/////////////////////////////////////////////////////////////////////////////
struct SharedFolder::Data
{
Data()
: fWritable(false),
fAutoMount(false)
{ }
const Utf8Str strName;
const Utf8Str strHostPath;
bool fWritable;
bool fAutoMount;
const Utf8Str strAutoMountPoint;
Utf8Str strLastAccessError;
};
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
SharedFolder::SharedFolder()
: mParent(NULL),
mMachine(NULL),
mVirtualBox(NULL)
{
m = new Data;
}
SharedFolder::~SharedFolder()
{
delete m;
m = NULL;
}
HRESULT SharedFolder::FinalConstruct()
{
return BaseFinalConstruct();
}
void SharedFolder::FinalRelease()
{
uninit();
BaseFinalRelease();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes the shared folder object.
*
* This variant initializes a machine instance that lives in the server address space.
*
* @param aMachine parent Machine object
* @param aName logical name of the shared folder
* @param aHostPath full path to the shared folder on the host
* @param aWritable writable if true, readonly otherwise
* @param aAutoMount if auto mounted by guest true, false otherwise
* @param aAutoMountPoint Where the guest should try auto mount it.
* @param fFailOnError Whether to fail with an error if the shared folder path is bad.
*
* @return COM result indicator
*/
HRESULT SharedFolder::init(Machine *aMachine,
const Utf8Str &aName,
const Utf8Str &aHostPath,
bool aWritable,
bool aAutoMount,
const Utf8Str &aAutoMountPoint,
bool fFailOnError)
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
unconst(mMachine) = aMachine;
HRESULT hrc = i_protectedInit(aMachine, aName, aHostPath, aWritable, aAutoMount, aAutoMountPoint, fFailOnError);
/* Confirm a successful initialization when it's the case */
if (SUCCEEDED(hrc))
autoInitSpan.setSucceeded();
return hrc;
}
/**
* Initializes the shared folder object given another object
* (a kind of copy constructor). This object makes a private copy of data
* of the original object passed as an argument.
*
* @param aMachine parent Machine object
* @param aThat shared folder object to copy
*
* @return COM result indicator
*/
HRESULT SharedFolder::initCopy(Machine *aMachine, SharedFolder *aThat)
{
ComAssertRet(aThat, E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
unconst(mMachine) = aMachine;
HRESULT hrc = i_protectedInit(aMachine,
aThat->m->strName,
aThat->m->strHostPath,
aThat->m->fWritable,
aThat->m->fAutoMount,
aThat->m->strAutoMountPoint,
false /* fFailOnError */ );
/* Confirm a successful initialization when it's the case */
if (SUCCEEDED(hrc))
autoInitSpan.setSucceeded();
return hrc;
}
# if 0
/**
* Initializes the shared folder object.
*
* This variant initializes a global instance that lives in the server address space. It is not presently used.
*
* @param aVirtualBox VirtualBox parent object
* @param aName logical name of the shared folder
* @param aHostPath full path to the shared folder on the host
* @param aWritable writable if true, readonly otherwise
* @param aAutoMountPoint Where the guest should try auto mount it.
* @param fFailOnError Whether to fail with an error if the shared folder path is bad.
*
* @return COM result indicator
*/
HRESULT SharedFolder::init(VirtualBox *aVirtualBox,
const Utf8Str &aName,
const Utf8Str &aHostPath,
bool aWritable,
bool aAutoMount,
const Utf8Str &aAutoMountPoint,
bool fFailOnError)
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
unconst(mVirtualBox) = aVirtualBox;
HRESULT hrc = protectedInit(aVirtualBox, aName, aHostPath, aWritable, aAutoMount, aAutoMountPoint, fFailOnError);
/* Confirm a successful initialization when it's the case */
if (SUCCEEDED(hrc))
autoInitSpan.setSucceeded();
return hrc;
}
# endif
/**
* Shared initialization code. Called from the other constructors.
*
* @note
* Must be called from under the object's lock!
*/
HRESULT SharedFolder::i_protectedInit(VirtualBoxBase *aParent,
const Utf8Str &aName,
const Utf8Str &aHostPath,
bool aWritable,
bool aAutoMount,
const Utf8Str &aAutoMountPoint,
bool fFailOnError)
{
LogFlowThisFunc(("aName={%s}, aHostPath={%s}, aWritable={%d}, aAutoMount={%d}\n",
aName.c_str(), aHostPath.c_str(), aWritable, aAutoMount));
ComAssertRet(aParent && aName.isNotEmpty() && aHostPath.isNotEmpty(), E_INVALIDARG);
Utf8Str hostPath = aHostPath;
size_t hostPathLen = hostPath.length();
/* Remove the trailing slash unless it's a root directory
* (otherwise the comparison with the RTPathAbs() result will fail at least
* on Linux). Note that this isn't really necessary for the shared folder
* itself, since adding a mapping eventually results into a
* RTDirOpenFiltered() call (see HostServices/SharedFolders) that seems to
* accept both the slashified paths and not. */
#if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)
if ( hostPathLen > 2
&& RTPATH_IS_SEP(hostPath.c_str()[hostPathLen - 1])
&& RTPATH_IS_VOLSEP(hostPath.c_str()[hostPathLen - 2]))
;
#else
if (hostPathLen == 1 && RTPATH_IS_SEP(hostPath[0]))
;
#endif
else
hostPath.stripTrailingSlash();
if (fFailOnError)
{
/* Check whether the path is full (absolute) */
char hostPathFull[RTPATH_MAX];
int vrc = RTPathAbs(hostPath.c_str(),
hostPathFull,
sizeof(hostPathFull));
if (RT_FAILURE(vrc))
return setErrorBoth(E_INVALIDARG, vrc, tr("Invalid shared folder path: '%s' (%Rrc)"), hostPath.c_str(), vrc);
if (RTPathCompare(hostPath.c_str(), hostPathFull) != 0)
return setError(E_INVALIDARG, tr("Shared folder path '%s' is not absolute"), hostPath.c_str());
RTFSOBJINFO ObjInfo;
vrc = RTPathQueryInfoEx(hostPathFull, &ObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_FOLLOW_LINK);
if (RT_FAILURE(vrc))
return setError(E_INVALIDARG, tr("RTPathQueryInfo failed on shared folder path '%s': %Rrc"), hostPathFull, vrc);
if (!RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode))
return setError(E_INVALIDARG, tr("Shared folder path '%s' is not a directory"), hostPathFull);
}
unconst(mParent) = aParent;
unconst(m->strName) = aName;
unconst(m->strHostPath) = hostPath;
m->fWritable = aWritable;
m->fAutoMount = aAutoMount;
unconst(m->strAutoMountPoint) = aAutoMountPoint;
return S_OK;
}
/**
* Uninitializes the instance and sets the ready flag to FALSE.
* Called either from FinalRelease() or by the parent when it gets destroyed.
*/
void SharedFolder::uninit()
{
LogFlowThisFunc(("\n"));
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
unconst(mParent) = NULL;
unconst(mMachine) = NULL;
unconst(mVirtualBox) = NULL;
}
// wrapped ISharedFolder properties
/////////////////////////////////////////////////////////////////////////////
HRESULT SharedFolder::getName(com::Utf8Str &aName)
{
/* mName is constant during life time, no need to lock */
aName = m->strName;
return S_OK;
}
HRESULT SharedFolder::getHostPath(com::Utf8Str &aHostPath)
{
/* mHostPath is constant during life time, no need to lock */
aHostPath = m->strHostPath;
return S_OK;
}
HRESULT SharedFolder::getAccessible(BOOL *aAccessible)
{
/* mName and mHostPath are constant during life time, no need to lock */
/* check whether the host path exists */
Utf8Str hostPath = m->strHostPath;
char hostPathFull[RTPATH_MAX];
int vrc = RTPathExists(hostPath.c_str()) ? RTPathReal(hostPath.c_str(),
hostPathFull,
sizeof(hostPathFull))
: VERR_PATH_NOT_FOUND;
if (RT_SUCCESS(vrc))
{
*aAccessible = TRUE;
return S_OK;
}
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
m->strLastAccessError = Utf8StrFmt(tr("'%s' is not accessible (%Rrc)"),
m->strHostPath.c_str(),
vrc);
Log1WarningThisFunc(("m.lastAccessError=\"%s\"\n", m->strLastAccessError.c_str()));
*aAccessible = FALSE;
return S_OK;
}
HRESULT SharedFolder::getWritable(BOOL *aWritable)
{
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aWritable = m->fWritable;
return S_OK;
}
HRESULT SharedFolder::setWritable(BOOL aWritable)
{
RT_NOREF(aWritable);
return E_NOTIMPL;
}
HRESULT SharedFolder::getAutoMount(BOOL *aAutoMount)
{
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aAutoMount = m->fAutoMount;
return S_OK;
}
HRESULT SharedFolder::setAutoMount(BOOL aAutoMount)
{
RT_NOREF(aAutoMount);
return E_NOTIMPL;
}
HRESULT SharedFolder::getAutoMountPoint(com::Utf8Str &aAutoMountPoint)
{
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
aAutoMountPoint = m->strAutoMountPoint;
return S_OK;
}
HRESULT SharedFolder::setAutoMountPoint(com::Utf8Str const &aAutoMountPoint)
{
RT_NOREF(aAutoMountPoint);
return E_NOTIMPL;
}
HRESULT SharedFolder::getLastAccessError(com::Utf8Str &aLastAccessError)
{
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
aLastAccessError = m->strLastAccessError;
return S_OK;
}
const Utf8Str& SharedFolder::i_getName() const
{
return m->strName;
}
const Utf8Str& SharedFolder::i_getHostPath() const
{
return m->strHostPath;
}
bool SharedFolder::i_isWritable() const
{
return m->fWritable;
}
bool SharedFolder::i_isAutoMounted() const
{
return m->fAutoMount;
}
const Utf8Str &SharedFolder::i_getAutoMountPoint() const
{
return m->strAutoMountPoint;
}
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|