GuestDirectoryImpl.cpp revision e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * VirtualBox Main - Guest directory handling.
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * Copyright (C) 2012-2013 Oracle Corporation
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * This file is part of VirtualBox Open Source Edition (OSE), as
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * available from http://www.virtualbox.org. This file is free software;
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * you can redistribute it and/or modify it under the terms of the GNU
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * General Public License (GPL) as published by the Free Software
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * Foundation, in version 2 as it comes in the "COPYING" file of the
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington/*******************************************************************************
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington* Header Files *
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington*******************************************************************************/
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster// constructor / destructor
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/////////////////////////////////////////////////////////////////////////////
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster// public initializer/uninitializer for internal purposes only
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/////////////////////////////////////////////////////////////////////////////
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterint GuestDirectory::init(Console *pConsole, GuestSession *pSession,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ULONG uDirID, const GuestDirectoryOpenInfo &openInfo)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster LogFlowThisFunc(("pConsole=%p, pSession=%p, uDirID=%RU32, strPath=%s, strFilter=%s, uFlags=%x\n",
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster pConsole, pSession, uDirID, openInfo.mPath.c_str(), openInfo.mFilter.c_str(),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AssertPtrReturn(pSession, VERR_INVALID_POINTER);
b174f2fef6b1d8ee82424e19de3ad21f872c1ed7Mark de Reeper /* Enclose the state transition NotReady->InInit->Ready. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster int vrc = bindToSession(pConsole, pSession, uDirID /* Object ID */);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Start the directory process on the guest. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mName = Utf8StrFmt(tr("Reading directory \"%s\"", openInfo.mPath.c_str()));
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mCommand = Utf8Str(VBOXSERVICE_TOOL_LS);
b174f2fef6b1d8ee82424e19de3ad21f872c1ed7Mark de Reeper procInfo.mTimeoutMS = 5 * 60 * 1000; /* 5 minutes timeout. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mFlags = ProcessCreateFlag_WaitForStdOut;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mArguments.push_back(Utf8Str("--machinereadable"));
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* We want the long output format which contains all the object details. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster#if 0 /* Flags are not supported yet. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mArguments.push_back(Utf8Str("--nosymlinks")); /** @todo What does GNU here? */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /** @todo Recursion support? */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster procInfo.mArguments.push_back(openInfo.mPath); /* The directory we want to open. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Start the process asynchronously and keep it around so that we can use
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * it later in subsequent read() calls.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Note: No guest rc available because operation is asynchronous.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster vrc = mData.mProcessTool.Init(mSession, procInfo,
b174f2fef6b1d8ee82424e19de3ad21f872c1ed7Mark de Reeper /* Confirm a successful initialization when it's the case. */
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major#endif /* VBOX_WITH_GUEST_CONTROL */
57a1b25dcdf865eacb2fe2e17c5ca83e942da047David Luna * Uninitializes the instance.
57a1b25dcdf865eacb2fe2e17c5ca83e942da047David Luna * Called from FinalRelease().
57a1b25dcdf865eacb2fe2e17c5ca83e942da047David Luna /* Enclose the state transition Ready->InUninit->NotReady. */
57a1b25dcdf865eacb2fe2e17c5ca83e942da047David Luna// implementation of public getters/setters for attributes
b174f2fef6b1d8ee82424e19de3ad21f872c1ed7Mark de Reeper/////////////////////////////////////////////////////////////////////////////
57a1b25dcdf865eacb2fe2e17c5ca83e942da047David LunaSTDMETHODIMP GuestDirectory::COMGETTER(DirectoryName)(BSTR *aName)
b174f2fef6b1d8ee82424e19de3ad21f872c1ed7Mark de Reeper if (FAILED(autoCaller.rc())) return autoCaller.rc();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterSTDMETHODIMP GuestDirectory::COMGETTER(Filter)(BSTR *aFilter)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (FAILED(autoCaller.rc())) return autoCaller.rc();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster// private methods
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/////////////////////////////////////////////////////////////////////////////
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterint GuestDirectory::callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster LogFlowThisFunc(("strPath=%s, uContextID=%RU32, uFunction=%RU32, pSvcCb=%p\n",
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster mData.mOpenInfo.mPath.c_str(), pCbCtx->uContextID, pCbCtx->uFunction, pSvcCb));
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* pSvcCb->mpaParms[0] always contains the context ID. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster pSvcCb->mpaParms[idx++].getUInt32(&dataCb.uType);
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major int guestRc = (int)dataCb.rc; /* uint32_t vs. int. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Nothing here yet, nothing to dispatch further. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Silently ignore not implemented functions. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterUtf8Str GuestDirectory::guestErrorToString(int guestRc)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /** @todo pData->u32Flags: int vs. uint32 -- IPRT errors are *negative* !!! */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster strError += Utf8StrFmt("Directoy is not empty");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Called by IGuestSession right before this directory gets
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * removed from the public directory list.
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterHRESULT GuestDirectory::setErrorExternal(VirtualBoxBase *pInterface, int guestRc)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AssertMsg(RT_FAILURE(guestRc), ("Guest rc does not indicate a failure when setting error\n"));
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return pInterface->setError(VBOX_E_IPRT_ERROR, GuestDirectory::guestErrorToString(guestRc).c_str());
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster// implementation of public methods
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/////////////////////////////////////////////////////////////////////////////
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (FAILED(autoCaller.rc())) return autoCaller.rc();
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major int rc = mSession->directoryRemoveFromList(this);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster rc = mData.mProcessTool.Terminate(30 * 1000, &guestRc);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster hr = GuestProcess::setErrorExternal(this, guestRc);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Silently skip old Guest Additions which do not support killing the
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major * the guest directory handling process. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster tr("Terminating open guest directory \"%s\" failed: %Rrc"),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Release autocaller before calling uninit.
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major#endif /* VBOX_WITH_GUEST_CONTROL */
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterSTDMETHODIMP GuestDirectory::Read(IFsObjInfo **aInfo)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (FAILED(autoCaller.rc())) return autoCaller.rc();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster int rc = mData.mProcessTool.WaitEx(GUESTPROCESSTOOL_FLAG_STDOUT_BLOCK,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Note: The guest process can still be around to serve the next
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * upcoming stream block next time.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster rc = mData.mProcessTool.TerminatedOk(NULL /* Exit code */);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (curBlock.GetCount()) /* Did we get content? */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Create the object. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Return info object to the caller. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* Nothing to read anymore. Tell the caller. */
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major if (RT_FAILURE(rc)) /** @todo Add more errors here. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster hr = GuestProcess::setErrorExternal(this, guestRc);
ecb73e63056eb80738d8460818f1a742f515de1cPeter Major hr = setError(VBOX_E_IPRT_ERROR, tr("Reading directory \"%s\" failed: Unable to read / access denied"),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster hr = setError(VBOX_E_IPRT_ERROR, tr("Reading directory \"%s\" failed: Path not found"),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /* See SDK reference. */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster hr = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No more entries for directory \"%s\""),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster hr = setError(VBOX_E_IPRT_ERROR, tr("Error while reading directory \"%s\": %Rrc\n"),
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster#endif /* VBOX_WITH_GUEST_CONTROL */