VirtualBox

source: vbox/trunk/src/VBox/Main/src-client/GuestDirectoryImpl.cpp@ 55426

Last change on this file since 55426 was 53127, checked in by vboxsync, 10 years ago

Main/GuestDirectoryImpl: fixed typo
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.9 KB
Line 
1
2/* $Id: GuestDirectoryImpl.cpp 53127 2014-10-23 09:28:17Z vboxsync $ */
3/** @file
4 * VirtualBox Main - Guest directory handling.
5 */
6
7/*
8 * Copyright (C) 2012-2013 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19
20/*******************************************************************************
21* Header Files *
22*******************************************************************************/
23#include "GuestDirectoryImpl.h"
24#include "GuestSessionImpl.h"
25#include "GuestCtrlImplPrivate.h"
26
27#include "Global.h"
28#include "AutoCaller.h"
29
30#include <VBox/com/array.h>
31
32#ifdef LOG_GROUP
33 #undef LOG_GROUP
34#endif
35#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
36#include <VBox/log.h>
37
38
39// constructor / destructor
40/////////////////////////////////////////////////////////////////////////////
41
42DEFINE_EMPTY_CTOR_DTOR(GuestDirectory)
43
44HRESULT GuestDirectory::FinalConstruct(void)
45{
46 LogFlowThisFunc(("\n"));
47 return BaseFinalConstruct();
48}
49
50void GuestDirectory::FinalRelease(void)
51{
52 LogFlowThisFuncEnter();
53 uninit();
54 BaseFinalRelease();
55 LogFlowThisFuncLeave();
56}
57
58// public initializer/uninitializer for internal purposes only
59/////////////////////////////////////////////////////////////////////////////
60
61int GuestDirectory::init(Console *pConsole, GuestSession *pSession,
62 ULONG uDirID, const GuestDirectoryOpenInfo &openInfo)
63{
64 LogFlowThisFunc(("pConsole=%p, pSession=%p, uDirID=%RU32, strPath=%s, strFilter=%s, uFlags=%x\n",
65 pConsole, pSession, uDirID, openInfo.mPath.c_str(), openInfo.mFilter.c_str(),
66 openInfo.mFlags));
67
68 AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
69 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
70
71 /* Enclose the state transition NotReady->InInit->Ready. */
72 AutoInitSpan autoInitSpan(this);
73 AssertReturn(autoInitSpan.isOk(), E_FAIL);
74
75#ifndef VBOX_WITH_GUEST_CONTROL
76 autoInitSpan.setSucceeded();
77 return VINF_SUCCESS;
78#else
79 int vrc = bindToSession(pConsole, pSession, uDirID /* Object ID */);
80 if (RT_SUCCESS(vrc))
81 {
82 mSession = pSession;
83
84 mData.mID = uDirID;
85 mData.mOpenInfo = openInfo;
86 }
87
88 if (RT_SUCCESS(vrc))
89 {
90 /* Start the directory process on the guest. */
91 GuestProcessStartupInfo procInfo;
92 procInfo.mName = Utf8StrFmt(tr("Reading directory \"%s\""), openInfo.mPath.c_str());
93 procInfo.mCommand = Utf8Str(VBOXSERVICE_TOOL_LS);
94 procInfo.mTimeoutMS = 5 * 60 * 1000; /* 5 minutes timeout. */
95 procInfo.mFlags = ProcessCreateFlag_WaitForStdOut;
96
97 procInfo.mArguments.push_back(Utf8Str("--machinereadable"));
98 /* We want the long output format which contains all the object details. */
99 procInfo.mArguments.push_back(Utf8Str("-l"));
100#if 0 /* Flags are not supported yet. */
101 if (uFlags & DirectoryOpenFlag_NoSymlinks)
102 procInfo.mArguments.push_back(Utf8Str("--nosymlinks")); /** @todo What does GNU here? */
103#endif
104 /** @todo Recursion support? */
105 procInfo.mArguments.push_back(openInfo.mPath); /* The directory we want to open. */
106
107 /*
108 * Start the process asynchronously and keep it around so that we can use
109 * it later in subsequent read() calls.
110 * Note: No guest rc available because operation is asynchronous.
111 */
112 vrc = mData.mProcessTool.Init(mSession, procInfo,
113 true /* Async */, NULL /* Guest rc */);
114 }
115
116 if (RT_SUCCESS(vrc))
117 {
118 /* Confirm a successful initialization when it's the case. */
119 autoInitSpan.setSucceeded();
120 return vrc;
121 }
122 else
123 autoInitSpan.setFailed();
124
125 return vrc;
126#endif /* VBOX_WITH_GUEST_CONTROL */
127}
128
129/**
130 * Uninitializes the instance.
131 * Called from FinalRelease().
132 */
133void GuestDirectory::uninit(void)
134{
135 LogFlowThisFuncEnter();
136
137 /* Enclose the state transition Ready->InUninit->NotReady. */
138 AutoUninitSpan autoUninitSpan(this);
139 if (autoUninitSpan.uninitDone())
140 return;
141
142 LogFlowThisFuncLeave();
143}
144
145// implementation of private wrapped getters/setters for attributes
146/////////////////////////////////////////////////////////////////////////////
147
148HRESULT GuestDirectory::getDirectoryName(com::Utf8Str &aDirectoryName)
149{
150 LogFlowThisFuncEnter();
151
152 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
153
154 aDirectoryName = mData.mOpenInfo.mPath;
155
156 return S_OK;
157}
158
159HRESULT GuestDirectory::getFilter(com::Utf8Str &aFilter)
160{
161 LogFlowThisFuncEnter();
162
163 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
164
165 aFilter = mData.mOpenInfo.mFilter;
166
167 return S_OK;
168}
169
170// private methods
171/////////////////////////////////////////////////////////////////////////////
172
173int GuestDirectory::i_callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
174{
175 AssertPtrReturn(pCbCtx, VERR_INVALID_POINTER);
176 AssertPtrReturn(pSvcCb, VERR_INVALID_POINTER);
177
178 LogFlowThisFunc(("strPath=%s, uContextID=%RU32, uFunction=%RU32, pSvcCb=%p\n",
179 mData.mOpenInfo.mPath.c_str(), pCbCtx->uContextID, pCbCtx->uFunction, pSvcCb));
180
181 int vrc;
182 switch (pCbCtx->uFunction)
183 {
184 case GUEST_DIR_NOTIFY:
185 {
186 int idx = 1; /* Current parameter index. */
187 CALLBACKDATA_DIR_NOTIFY dataCb;
188 /* pSvcCb->mpaParms[0] always contains the context ID. */
189 pSvcCb->mpaParms[idx++].getUInt32(&dataCb.uType);
190 pSvcCb->mpaParms[idx++].getUInt32(&dataCb.rc);
191
192 int guestRc = (int)dataCb.rc; /* uint32_t vs. int. */
193
194 LogFlowFunc(("uType=%RU32, guestRc=%Rrc\n",
195 dataCb.uType, guestRc));
196
197 switch (dataCb.uType)
198 {
199 /* Nothing here yet, nothing to dispatch further. */
200
201 default:
202 vrc = VERR_NOT_SUPPORTED;
203 break;
204 }
205 break;
206 }
207
208 default:
209 /* Silently ignore not implemented functions. */
210 vrc = VERR_NOT_SUPPORTED;
211 break;
212 }
213
214#ifdef DEBUG
215 LogFlowFuncLeaveRC(vrc);
216#endif
217 return vrc;
218}
219
220/* static */
221Utf8Str GuestDirectory::i_guestErrorToString(int guestRc)
222{
223 Utf8Str strError;
224
225 /** @todo pData->u32Flags: int vs. uint32 -- IPRT errors are *negative* !!! */
226 switch (guestRc)
227 {
228 case VERR_DIR_NOT_EMPTY:
229 strError += Utf8StrFmt("Directoy is not empty");
230 break;
231
232 default:
233 strError += Utf8StrFmt("%Rrc", guestRc);
234 break;
235 }
236
237 return strError;
238}
239
240/**
241 * Called by IGuestSession right before this directory gets
242 * removed from the public directory list.
243 */
244int GuestDirectory::i_onRemove(void)
245{
246 LogFlowThisFuncEnter();
247
248 int vrc = VINF_SUCCESS;
249
250 LogFlowFuncLeaveRC(vrc);
251 return vrc;
252}
253
254/* static */
255HRESULT GuestDirectory::i_setErrorExternal(VirtualBoxBase *pInterface, int guestRc)
256{
257 AssertPtr(pInterface);
258 AssertMsg(RT_FAILURE(guestRc), ("Guest rc does not indicate a failure when setting error\n"));
259
260 return pInterface->setError(VBOX_E_IPRT_ERROR, GuestDirectory::i_guestErrorToString(guestRc).c_str());
261}
262
263// implementation of public methods
264/////////////////////////////////////////////////////////////////////////////
265HRESULT GuestDirectory::close()
266{
267#ifndef VBOX_WITH_GUEST_CONTROL
268 ReturnComNotImplemented();
269#else
270 LogFlowThisFuncEnter();
271
272 AutoCaller autoCaller(this);
273 if (FAILED(autoCaller.rc())) return autoCaller.rc();
274
275 HRESULT hr = S_OK;
276
277 int guestRc;
278 int rc = mData.mProcessTool.i_terminate(30 * 1000, &guestRc);
279 if (RT_FAILURE(rc))
280 {
281 switch (rc)
282 {
283 case VERR_GSTCTL_GUEST_ERROR:
284 hr = GuestProcess::i_setErrorExternal(this, guestRc);
285 break;
286
287 case VERR_NOT_SUPPORTED:
288 /* Silently skip old Guest Additions which do not support killing the
289 * the guest directory handling process. */
290 break;
291
292 default:
293 hr = setError(VBOX_E_IPRT_ERROR,
294 tr("Terminating open guest directory \"%s\" failed: %Rrc"),
295 mData.mOpenInfo.mPath.c_str(), rc);
296 break;
297 }
298 }
299
300 AssertPtr(mSession);
301 int rc2 = mSession->i_directoryRemoveFromList(this);
302 if (RT_SUCCESS(rc))
303 rc = rc2;
304
305 LogFlowThisFunc(("Returning rc=%Rrc\n", rc));
306 return hr;
307#endif /* VBOX_WITH_GUEST_CONTROL */
308}
309
310HRESULT GuestDirectory::read(ComPtr<IFsObjInfo> &aObjInfo)
311{
312#ifndef VBOX_WITH_GUEST_CONTROL
313 ReturnComNotImplemented();
314#else
315 LogFlowThisFuncEnter();
316
317 AutoCaller autoCaller(this);
318 if (FAILED(autoCaller.rc())) return autoCaller.rc();
319
320 GuestProcessStreamBlock curBlock;
321 int guestRc;
322
323 int rc = mData.mProcessTool.i_waitEx(GUESTPROCESSTOOL_FLAG_STDOUT_BLOCK,
324 &curBlock, &guestRc);
325
326 /*
327 * Note: The guest process can still be around to serve the next
328 * upcoming stream block next time.
329 */
330 if ( RT_SUCCESS(rc)
331 && !mData.mProcessTool.i_isRunning())
332 {
333 rc = mData.mProcessTool.i_terminatedOk(NULL /* Exit code */);
334 if (rc == VERR_NOT_EQUAL)
335 rc = VERR_ACCESS_DENIED;
336 }
337
338 if (RT_SUCCESS(rc))
339 {
340 if (curBlock.GetCount()) /* Did we get content? */
341 {
342 GuestFsObjData objData;
343 rc = objData.FromLs(curBlock);
344 if (RT_FAILURE(rc))
345 rc = VERR_PATH_NOT_FOUND;
346
347 if (RT_SUCCESS(rc))
348 {
349 /* Create the object. */
350 ComObjPtr<GuestFsObjInfo> pFsObjInfo;
351 HRESULT hr2 = pFsObjInfo.createObject();
352 if (FAILED(hr2))
353 rc = VERR_COM_UNEXPECTED;
354
355 if (RT_SUCCESS(rc))
356 rc = pFsObjInfo->init(objData);
357
358 if (RT_SUCCESS(rc))
359 {
360 /* Return info object to the caller. */
361 hr2 = pFsObjInfo.queryInterfaceTo(aObjInfo.asOutParam());
362 if (FAILED(hr2))
363 rc = VERR_COM_UNEXPECTED;
364 }
365 }
366 }
367 else
368 {
369 /* Nothing to read anymore. Tell the caller. */
370 rc = VERR_NO_MORE_FILES;
371 }
372 }
373
374 HRESULT hr = S_OK;
375
376 if (RT_FAILURE(rc)) /** @todo Add more errors here. */
377 {
378 switch (rc)
379 {
380 case VERR_GSTCTL_GUEST_ERROR:
381 hr = GuestProcess::i_setErrorExternal(this, guestRc);
382 break;
383
384 case VERR_ACCESS_DENIED:
385 hr = setError(VBOX_E_IPRT_ERROR, tr("Reading directory \"%s\" failed: Unable to read / access denied"),
386 mData.mOpenInfo.mPath.c_str());
387 break;
388
389 case VERR_PATH_NOT_FOUND:
390 hr = setError(VBOX_E_IPRT_ERROR, tr("Reading directory \"%s\" failed: Path not found"),
391 mData.mOpenInfo.mPath.c_str());
392 break;
393
394 case VERR_NO_MORE_FILES:
395 /* See SDK reference. */
396 hr = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No more entries for directory \"%s\""),
397 mData.mOpenInfo.mPath.c_str());
398 break;
399
400 default:
401 hr = setError(VBOX_E_IPRT_ERROR, tr("Error while reading directory \"%s\": %Rrc\n"),
402 mData.mOpenInfo.mPath.c_str(), rc);
403 break;
404 }
405 }
406
407 LogFlowThisFunc(("Returning rc=%Rrc\n", rc));
408 return hr;
409#endif /* VBOX_WITH_GUEST_CONTROL */
410}
411
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette