VirtualBox

source: vbox/trunk/src/VBox/Main/src-client/GuestSessionImplTasks.cpp@ 97481

Last change on this file since 97481 was 97481, checked in by vboxsync, 3 years ago

Guest Control/Main: A bit nicer progress object descriptions, which now also include information about how many (other) objects are copied to where. bugref:10286
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 121.9 KB
Line 
1/* $Id: GuestSessionImplTasks.cpp 97481 2022-11-09 14:13:50Z vboxsync $ */
2/** @file
3 * VirtualBox Main - Guest session tasks.
4 */
5
6/*
7 * Copyright (C) 2012-2022 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.215389.xyz.
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 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28
29/*********************************************************************************************************************************
30* Header Files *
31*********************************************************************************************************************************/
32#define LOG_GROUP LOG_GROUP_MAIN_GUESTSESSION
33#include "LoggingNew.h"
34
35#include "GuestImpl.h"
36#ifndef VBOX_WITH_GUEST_CONTROL
37# error "VBOX_WITH_GUEST_CONTROL must defined in this file"
38#endif
39#include "GuestSessionImpl.h"
40#include "GuestSessionImplTasks.h"
41#include "GuestCtrlImplPrivate.h"
42
43#include "Global.h"
44#include "AutoCaller.h"
45#include "ConsoleImpl.h"
46#include "ProgressImpl.h"
47
48#include <memory> /* For auto_ptr. */
49
50#include <iprt/env.h>
51#include <iprt/file.h> /* For CopyTo/From. */
52#include <iprt/dir.h>
53#include <iprt/path.h>
54#include <iprt/fsvfs.h>
55
56
57/*********************************************************************************************************************************
58* Defines *
59*********************************************************************************************************************************/
60
61/**
62 * (Guest Additions) ISO file flags.
63 * Needed for handling Guest Additions updates.
64 */
65#define ISOFILE_FLAG_NONE 0
66/** Copy over the file from host to the
67 * guest. */
68#define ISOFILE_FLAG_COPY_FROM_ISO RT_BIT(0)
69/** Execute file on the guest after it has
70 * been successfully transferred. */
71#define ISOFILE_FLAG_EXECUTE RT_BIT(7)
72/** File is optional, does not have to be
73 * existent on the .ISO. */
74#define ISOFILE_FLAG_OPTIONAL RT_BIT(8)
75
76
77// session task classes
78/////////////////////////////////////////////////////////////////////////////
79
80GuestSessionTask::GuestSessionTask(GuestSession *pSession)
81 : ThreadTask("GenericGuestSessionTask")
82{
83 mSession = pSession;
84
85 switch (mSession->i_getGuestPathStyle())
86 {
87 case PathStyle_DOS:
88 mstrGuestPathStyle = "\\";
89 break;
90
91 default:
92 mstrGuestPathStyle = "/";
93 break;
94 }
95}
96
97GuestSessionTask::~GuestSessionTask(void)
98{
99}
100
101/**
102 * Creates (and initializes / sets) the progress objects of a guest session task.
103 *
104 * @returns VBox status code.
105 * @param cOperations Number of operation the task wants to perform.
106 */
107int GuestSessionTask::createAndSetProgressObject(ULONG cOperations /* = 1 */)
108{
109 LogFlowThisFunc(("cOperations=%ld\n", cOperations));
110
111 /* Create the progress object. */
112 ComObjPtr<Progress> pProgress;
113 HRESULT hr = pProgress.createObject();
114 if (FAILED(hr))
115 return VERR_COM_UNEXPECTED;
116
117 hr = pProgress->init(static_cast<IGuestSession*>(mSession),
118 Bstr(mDesc).raw(),
119 TRUE /* aCancelable */, cOperations, Bstr(mDesc).raw());
120 if (FAILED(hr))
121 return VERR_COM_UNEXPECTED;
122
123 mProgress = pProgress;
124
125 LogFlowFuncLeave();
126 return VINF_SUCCESS;
127}
128
129#if 0 /* unused */
130/** @note The task object is owned by the thread after this returns, regardless of the result. */
131int GuestSessionTask::RunAsync(const Utf8Str &strDesc, ComObjPtr<Progress> &pProgress)
132{
133 LogFlowThisFunc(("strDesc=%s\n", strDesc.c_str()));
134
135 mDesc = strDesc;
136 mProgress = pProgress;
137 HRESULT hrc = createThreadWithType(RTTHREADTYPE_MAIN_HEAVY_WORKER);
138
139 LogFlowThisFunc(("Returning hrc=%Rhrc\n", hrc));
140 return Global::vboxStatusCodeToCOM(hrc);
141}
142#endif
143
144/**
145 * Gets a guest property from the VM.
146 *
147 * @returns VBox status code.
148 * @param pGuest Guest object of VM to get guest property from.
149 * @param strPath Guest property to path to get.
150 * @param strValue Where to store the guest property value on success.
151 */
152int GuestSessionTask::getGuestProperty(const ComObjPtr<Guest> &pGuest,
153 const Utf8Str &strPath, Utf8Str &strValue)
154{
155 ComObjPtr<Console> pConsole = pGuest->i_getConsole();
156 const ComPtr<IMachine> pMachine = pConsole->i_machine();
157
158 Assert(!pMachine.isNull());
159 Bstr strTemp, strFlags;
160 LONG64 i64Timestamp;
161 HRESULT hr = pMachine->GetGuestProperty(Bstr(strPath).raw(),
162 strTemp.asOutParam(),
163 &i64Timestamp, strFlags.asOutParam());
164 if (SUCCEEDED(hr))
165 {
166 strValue = strTemp;
167 return VINF_SUCCESS;
168 }
169 return VERR_NOT_FOUND;
170}
171
172/**
173 * Sets the percentage of a guest session task progress.
174 *
175 * @returns VBox status code.
176 * @param uPercent Percentage (0-100) to set.
177 */
178int GuestSessionTask::setProgress(ULONG uPercent)
179{
180 if (mProgress.isNull()) /* Progress is optional. */
181 return VINF_SUCCESS;
182
183 BOOL fCanceled;
184 if ( SUCCEEDED(mProgress->COMGETTER(Canceled(&fCanceled)))
185 && fCanceled)
186 return VERR_CANCELLED;
187 BOOL fCompleted;
188 if ( SUCCEEDED(mProgress->COMGETTER(Completed(&fCompleted)))
189 && fCompleted)
190 {
191 AssertMsgFailed(("Setting value of an already completed progress\n"));
192 return VINF_SUCCESS;
193 }
194 HRESULT hr = mProgress->SetCurrentOperationProgress(uPercent);
195 if (FAILED(hr))
196 return VERR_COM_UNEXPECTED;
197
198 return VINF_SUCCESS;
199}
200
201/**
202 * Sets the task's progress object to succeeded.
203 *
204 * @returns VBox status code.
205 */
206int GuestSessionTask::setProgressSuccess(void)
207{
208 if (mProgress.isNull()) /* Progress is optional. */
209 return VINF_SUCCESS;
210
211 BOOL fCompleted;
212 if ( SUCCEEDED(mProgress->COMGETTER(Completed(&fCompleted)))
213 && !fCompleted)
214 {
215#ifdef VBOX_STRICT
216 ULONG uCurOp; mProgress->COMGETTER(Operation(&uCurOp));
217 ULONG cOps; mProgress->COMGETTER(OperationCount(&cOps));
218 AssertMsg(uCurOp + 1 /* Zero-based */ == cOps, ("Not all operations done yet (%u/%u)\n", uCurOp + 1, cOps));
219#endif
220 HRESULT hr = mProgress->i_notifyComplete(S_OK);
221 if (FAILED(hr))
222 return VERR_COM_UNEXPECTED; /** @todo Find a better rc. */
223 }
224
225 return VINF_SUCCESS;
226}
227
228/**
229 * Sets the task's progress object to an error using a string message.
230 *
231 * @returns Returns \a hr for convenience.
232 * @param hr Progress operation result to set.
233 * @param strMsg Message to set.
234 */
235HRESULT GuestSessionTask::setProgressErrorMsg(HRESULT hr, const Utf8Str &strMsg)
236{
237 LogFlowFunc(("hr=%Rhrc, strMsg=%s\n", hr, strMsg.c_str()));
238
239 if (mProgress.isNull()) /* Progress is optional. */
240 return hr; /* Return original rc. */
241
242 BOOL fCanceled;
243 BOOL fCompleted;
244 if ( SUCCEEDED(mProgress->COMGETTER(Canceled(&fCanceled)))
245 && !fCanceled
246 && SUCCEEDED(mProgress->COMGETTER(Completed(&fCompleted)))
247 && !fCompleted)
248 {
249 HRESULT hr2 = mProgress->i_notifyComplete(hr,
250 COM_IIDOF(IGuestSession),
251 GuestSession::getStaticComponentName(),
252 /* Make sure to hand-in the message via format string to avoid problems
253 * with (file) paths which e.g. contain "%s" and friends. Can happen with
254 * randomly generated Validation Kit stuff. */
255 "%s", strMsg.c_str());
256 if (FAILED(hr2))
257 return hr2;
258 }
259 return hr; /* Return original rc. */
260}
261
262/**
263 * Sets the task's progress object to an error using a string message and a guest error info object.
264 *
265 * @returns Returns \a hr for convenience.
266 * @param hr Progress operation result to set.
267 * @param strMsg Message to set.
268 * @param guestErrorInfo Guest error info to use.
269 */
270HRESULT GuestSessionTask::setProgressErrorMsg(HRESULT hr, const Utf8Str &strMsg, const GuestErrorInfo &guestErrorInfo)
271{
272 return setProgressErrorMsg(hr, strMsg + Utf8Str(": ") + GuestBase::getErrorAsString(guestErrorInfo));
273}
274
275/**
276 * Creates a directory on the guest.
277 *
278 * @return VBox status code.
279 * VINF_ALREADY_EXISTS if directory on the guest already exists (\a fCanExist is \c true).
280 * VWRN_ALREADY_EXISTS if directory on the guest already exists but must not exist (\a fCanExist is \c false).
281 * @param strPath Absolute path to directory on the guest (guest style path) to create.
282 * @param fMode Directory mode to use for creation.
283 * @param enmDirectoryCreateFlags Directory creation flags.
284 * @param fFollowSymlinks Whether to follow symlinks on the guest or not.
285 * @param fCanExist Whether the directory to create is allowed to exist already.
286 */
287int GuestSessionTask::directoryCreateOnGuest(const com::Utf8Str &strPath,
288 uint32_t fMode, DirectoryCreateFlag_T enmDirectoryCreateFlags,
289 bool fFollowSymlinks, bool fCanExist)
290{
291 LogFlowFunc(("strPath=%s, enmDirectoryCreateFlags=0x%x, fMode=%RU32, fFollowSymlinks=%RTbool, fCanExist=%RTbool\n",
292 strPath.c_str(), enmDirectoryCreateFlags, fMode, fFollowSymlinks, fCanExist));
293
294 GuestFsObjData objData;
295 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
296 int vrc = mSession->i_directoryQueryInfo(strPath, fFollowSymlinks, objData, &vrcGuest);
297 if (RT_SUCCESS(vrc))
298 {
299 if (!fCanExist)
300 {
301 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
302 Utf8StrFmt(tr("Guest directory \"%s\" already exists"), strPath.c_str()));
303 vrc = VERR_ALREADY_EXISTS;
304 }
305 else
306 vrc = VWRN_ALREADY_EXISTS;
307 }
308 else
309 {
310 switch (vrc)
311 {
312 case VERR_GSTCTL_GUEST_ERROR:
313 {
314 switch (vrcGuest)
315 {
316 case VERR_FILE_NOT_FOUND:
317 RT_FALL_THROUGH();
318 case VERR_PATH_NOT_FOUND:
319 vrc = mSession->i_directoryCreate(strPath.c_str(), fMode, enmDirectoryCreateFlags, &vrcGuest);
320 break;
321 default:
322 break;
323 }
324
325 if (RT_FAILURE(vrc))
326 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
327 Utf8StrFmt(tr("Guest error creating directory \"%s\" on the guest: %Rrc"),
328 strPath.c_str(), vrcGuest));
329 break;
330 }
331
332 default:
333 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
334 Utf8StrFmt(tr("Host error creating directory \"%s\" on the guest: %Rrc"),
335 strPath.c_str(), vrc));
336 break;
337 }
338 }
339
340 LogFlowFuncLeaveRC(vrc);
341 return vrc;
342}
343
344/**
345 * Creates a directory on the host.
346 *
347 * @return VBox status code. VERR_ALREADY_EXISTS if directory on the guest already exists.
348 * @param strPath Absolute path to directory on the host (host style path) to create.
349 * @param fMode Directory mode to use for creation.
350 * @param fCreate Directory creation flags.
351 * @param fCanExist Whether the directory to create is allowed to exist already.
352 */
353int GuestSessionTask::directoryCreateOnHost(const com::Utf8Str &strPath, uint32_t fMode, uint32_t fCreate, bool fCanExist)
354{
355 LogFlowFunc(("strPath=%s, fMode=%RU32, fCreate=0x%x, fCanExist=%RTbool\n", strPath.c_str(), fMode, fCreate, fCanExist));
356
357 LogRel2(("Guest Control: Creating host directory '%s' ...\n", strPath.c_str()));
358
359 int vrc = RTDirCreate(strPath.c_str(), fMode, fCreate);
360 if (RT_FAILURE(vrc))
361 {
362 if (vrc == VERR_ALREADY_EXISTS)
363 {
364 if (!fCanExist)
365 {
366 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
367 Utf8StrFmt(tr("Host directory \"%s\" already exists"), strPath.c_str()));
368 }
369 else
370 vrc = VINF_SUCCESS;
371 }
372 else
373 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
374 Utf8StrFmt(tr("Could not create host directory \"%s\": %Rrc"),
375 strPath.c_str(), vrc));
376 }
377
378 LogFlowFuncLeaveRC(vrc);
379 return vrc;
380}
381
382/**
383 * Main function for copying a file from guest to the host.
384 *
385 * @return VBox status code.
386 * @param strSrcFile Full path of source file on the host to copy.
387 * @param srcFile Guest file (source) to copy to the host. Must be in opened and ready state already.
388 * @param strDstFile Full destination path and file name (guest style) to copy file to.
389 * @param phDstFile Pointer to host file handle (destination) to copy to. Must be in opened and ready state already.
390 * @param fFileCopyFlags File copy flags.
391 * @param offCopy Offset (in bytes) where to start copying the source file.
392 * @param cbSize Size (in bytes) to copy from the source file.
393 */
394int GuestSessionTask::fileCopyFromGuestInner(const Utf8Str &strSrcFile, ComObjPtr<GuestFile> &srcFile,
395 const Utf8Str &strDstFile, PRTFILE phDstFile,
396 FileCopyFlag_T fFileCopyFlags, uint64_t offCopy, uint64_t cbSize)
397{
398 RT_NOREF(fFileCopyFlags);
399
400 BOOL fCanceled = FALSE;
401 uint64_t cbWrittenTotal = 0;
402 uint64_t cbToRead = cbSize;
403
404 uint32_t uTimeoutMs = 30 * 1000; /* 30s timeout. */
405
406 int vrc = VINF_SUCCESS;
407
408 if (offCopy)
409 {
410 uint64_t offActual;
411 vrc = srcFile->i_seekAt(offCopy, GUEST_FILE_SEEKTYPE_BEGIN, uTimeoutMs, &offActual);
412 if (RT_FAILURE(vrc))
413 {
414 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
415 Utf8StrFmt(tr("Seeking to offset %RU64 of guest file \"%s\" failed: %Rrc"),
416 offCopy, strSrcFile.c_str(), vrc));
417 return vrc;
418 }
419 }
420
421 BYTE byBuf[_64K]; /** @todo Can we do better here? */
422 while (cbToRead)
423 {
424 uint32_t cbRead;
425 const uint32_t cbChunk = RT_MIN(cbToRead, sizeof(byBuf));
426 vrc = srcFile->i_readData(cbChunk, uTimeoutMs, byBuf, sizeof(byBuf), &cbRead);
427 if (RT_FAILURE(vrc))
428 {
429 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
430 Utf8StrFmt(tr("Reading %RU32 bytes @ %RU64 from guest \"%s\" failed: %Rrc", "", cbChunk),
431 cbChunk, cbWrittenTotal, strSrcFile.c_str(), vrc));
432 break;
433 }
434
435 vrc = RTFileWrite(*phDstFile, byBuf, cbRead, NULL /* No partial writes */);
436 if (RT_FAILURE(vrc))
437 {
438 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
439 Utf8StrFmt(tr("Writing %RU32 bytes to host file \"%s\" failed: %Rrc", "", cbRead),
440 cbRead, strDstFile.c_str(), vrc));
441 break;
442 }
443
444 AssertBreak(cbToRead >= cbRead);
445 cbToRead -= cbRead;
446
447 /* Update total bytes written to the guest. */
448 cbWrittenTotal += cbRead;
449 AssertBreak(cbWrittenTotal <= cbSize);
450
451 /* Did the user cancel the operation above? */
452 if ( SUCCEEDED(mProgress->COMGETTER(Canceled(&fCanceled)))
453 && fCanceled)
454 break;
455
456 vrc = setProgress((ULONG)((double)cbWrittenTotal / (double)cbSize / 100.0));
457 if (RT_FAILURE(vrc))
458 break;
459 }
460
461 if ( SUCCEEDED(mProgress->COMGETTER(Canceled(&fCanceled)))
462 && fCanceled)
463 return VINF_SUCCESS;
464
465 if (RT_FAILURE(vrc))
466 return vrc;
467
468 /*
469 * Even if we succeeded until here make sure to check whether we really transferred
470 * everything.
471 */
472 if ( cbSize > 0
473 && cbWrittenTotal == 0)
474 {
475 /* If nothing was transferred but the file size was > 0 then "vbox_cat" wasn't able to write
476 * to the destination -> access denied. */
477 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
478 Utf8StrFmt(tr("Writing guest file \"%s\" to host file \"%s\" failed: Access denied"),
479 strSrcFile.c_str(), strDstFile.c_str()));
480 vrc = VERR_ACCESS_DENIED;
481 }
482 else if (cbWrittenTotal < cbSize)
483 {
484 /* If we did not copy all let the user know. */
485 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
486 Utf8StrFmt(tr("Copying guest file \"%s\" to host file \"%s\" failed (%RU64/%RU64 bytes transferred)"),
487 strSrcFile.c_str(), strDstFile.c_str(), cbWrittenTotal, cbSize));
488 vrc = VERR_INTERRUPTED;
489 }
490
491 LogFlowFuncLeaveRC(vrc);
492 return vrc;
493}
494
495/**
496 * Copies a file from the guest to the host.
497 *
498 * @return VBox status code.
499 * @retval VWRN_ALREADY_EXISTS if the file already exists and FileCopyFlag_NoReplace is specified,
500 * *or * the file at the destination has the same (or newer) modification time
501 * and FileCopyFlag_Update is specified.
502 * @param strSrc Full path of source file on the guest to copy.
503 * @param strDst Full destination path and file name (host style) to copy file to.
504 * @param fFileCopyFlags File copy flags.
505 */
506int GuestSessionTask::fileCopyFromGuest(const Utf8Str &strSrc, const Utf8Str &strDst, FileCopyFlag_T fFileCopyFlags)
507{
508 LogFlowThisFunc(("strSource=%s, strDest=%s, enmFileCopyFlags=%#x\n", strSrc.c_str(), strDst.c_str(), fFileCopyFlags));
509
510 GuestFileOpenInfo srcOpenInfo;
511 srcOpenInfo.mFilename = strSrc;
512 srcOpenInfo.mOpenAction = FileOpenAction_OpenExisting;
513 srcOpenInfo.mAccessMode = FileAccessMode_ReadOnly;
514 srcOpenInfo.mSharingMode = FileSharingMode_All; /** @todo Use _Read when implemented. */
515
516 ComObjPtr<GuestFile> srcFile;
517
518 GuestFsObjData srcObjData;
519 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
520 int vrc = mSession->i_fsQueryInfo(strSrc, TRUE /* fFollowSymlinks */, srcObjData, &vrcGuest);
521 if (RT_FAILURE(vrc))
522 {
523 if (vrc == VERR_GSTCTL_GUEST_ERROR)
524 setProgressErrorMsg(VBOX_E_IPRT_ERROR, tr("Guest file lookup failed"),
525 GuestErrorInfo(GuestErrorInfo::Type_ToolStat, vrcGuest, strSrc.c_str()));
526 else
527 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
528 Utf8StrFmt(tr("Guest file lookup for \"%s\" failed: %Rrc"), strSrc.c_str(), vrc));
529 }
530 else
531 {
532 switch (srcObjData.mType)
533 {
534 case FsObjType_File:
535 break;
536
537 case FsObjType_Symlink:
538 if (!(fFileCopyFlags & FileCopyFlag_FollowLinks))
539 {
540 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
541 Utf8StrFmt(tr("Guest file \"%s\" is a symbolic link"),
542 strSrc.c_str()));
543 vrc = VERR_IS_A_SYMLINK;
544 }
545 break;
546
547 default:
548 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
549 Utf8StrFmt(tr("Guest object \"%s\" is not a file (is type %#x)"),
550 strSrc.c_str(), srcObjData.mType));
551 vrc = VERR_NOT_A_FILE;
552 break;
553 }
554 }
555
556 if (RT_FAILURE(vrc))
557 return vrc;
558
559 vrc = mSession->i_fileOpen(srcOpenInfo, srcFile, &vrcGuest);
560 if (RT_FAILURE(vrc))
561 {
562 if (vrc == VERR_GSTCTL_GUEST_ERROR)
563 setProgressErrorMsg(VBOX_E_IPRT_ERROR, tr("Guest file could not be opened"),
564 GuestErrorInfo(GuestErrorInfo::Type_File, vrcGuest, strSrc.c_str()));
565 else
566 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
567 Utf8StrFmt(tr("Guest file \"%s\" could not be opened: %Rrc"), strSrc.c_str(), vrc));
568 }
569
570 if (RT_FAILURE(vrc))
571 return vrc;
572
573 RTFSOBJINFO dstObjInfo;
574 RT_ZERO(dstObjInfo);
575
576 bool fSkip = false; /* Whether to skip handling the file. */
577
578 if (RT_SUCCESS(vrc))
579 {
580 vrc = RTPathQueryInfo(strDst.c_str(), &dstObjInfo, RTFSOBJATTRADD_NOTHING);
581 if (RT_SUCCESS(vrc))
582 {
583 if (fFileCopyFlags & FileCopyFlag_NoReplace)
584 {
585 LogRel2(("Guest Control: Host file \"%s\" already exists, skipping", strDst.c_str()));
586 vrc = VWRN_ALREADY_EXISTS;
587 fSkip = true;
588 }
589
590 if ( !fSkip
591 && fFileCopyFlags & FileCopyFlag_Update)
592 {
593 RTTIMESPEC srcModificationTimeTS;
594 RTTimeSpecSetSeconds(&srcModificationTimeTS, srcObjData.mModificationTime);
595 if (RTTimeSpecCompare(&srcModificationTimeTS, &dstObjInfo.ModificationTime) <= 0)
596 {
597 LogRel2(("Guest Control: Host file \"%s\" has same or newer modification date, skipping", strDst.c_str()));
598 vrc = VWRN_ALREADY_EXISTS;
599 fSkip = true;
600 }
601 }
602 }
603 else
604 {
605 if (vrc == VERR_PATH_NOT_FOUND) /* Destination file does not exist (yet)? */
606 vrc = VERR_FILE_NOT_FOUND; /* Needed in next block further down. */
607 else if (vrc != VERR_FILE_NOT_FOUND) /* Ditto. */
608 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
609 Utf8StrFmt(tr("Host file lookup for \"%s\" failed: %Rrc"), strDst.c_str(), vrc));
610 }
611 }
612
613 if (fSkip)
614 {
615 int vrc2 = srcFile->i_closeFile(&vrcGuest);
616 AssertRC(vrc2);
617 return vrc;
618 }
619
620 if (RT_SUCCESS(vrc))
621 {
622 if (RTFS_IS_FILE(dstObjInfo.Attr.fMode))
623 {
624 if (fFileCopyFlags & FileCopyFlag_NoReplace)
625 {
626 setProgressErrorMsg(VBOX_E_IPRT_ERROR, Utf8StrFmt(tr("Host file \"%s\" already exists"), strDst.c_str()));
627 vrc = VERR_ALREADY_EXISTS;
628 }
629 }
630 else if (RTFS_IS_DIRECTORY(dstObjInfo.Attr.fMode))
631 {
632 setProgressErrorMsg(VBOX_E_IPRT_ERROR, Utf8StrFmt(tr("Host destination \"%s\" is a directory"), strDst.c_str()));
633 vrc = VERR_IS_A_DIRECTORY;
634 }
635 else if (RTFS_IS_SYMLINK(dstObjInfo.Attr.fMode))
636 {
637 if (!(fFileCopyFlags & FileCopyFlag_FollowLinks))
638 {
639 setProgressErrorMsg(VBOX_E_IPRT_ERROR, Utf8StrFmt(tr("Host destination \"%s\" is a symbolic link"), strDst.c_str()));
640 vrc = VERR_IS_A_SYMLINK;
641 }
642 }
643 else
644 {
645 LogFlowThisFunc(("Host file system type %#x not supported\n", dstObjInfo.Attr.fMode & RTFS_TYPE_MASK));
646 vrc = VERR_NOT_SUPPORTED;
647 }
648 }
649
650 LogFlowFunc(("vrc=%Rrc, dstFsType=%#x, pszDstFile=%s\n", vrc, dstObjInfo.Attr.fMode & RTFS_TYPE_MASK, strDst.c_str()));
651
652 if ( RT_SUCCESS(vrc)
653 || vrc == VERR_FILE_NOT_FOUND)
654 {
655 LogRel2(("Guest Control: Copying file '%s' from guest to '%s' on host ...\n", strSrc.c_str(), strDst.c_str()));
656
657 RTFILE hDstFile;
658 vrc = RTFileOpen(&hDstFile, strDst.c_str(),
659 RTFILE_O_WRITE | RTFILE_O_OPEN_CREATE | RTFILE_O_DENY_WRITE); /** @todo Use the correct open modes! */
660 if (RT_SUCCESS(vrc))
661 {
662 LogFlowThisFunc(("Copying '%s' to '%s' (%RI64 bytes) ...\n",
663 strSrc.c_str(), strDst.c_str(), srcObjData.mObjectSize));
664
665 vrc = fileCopyFromGuestInner(strSrc, srcFile, strDst, &hDstFile, fFileCopyFlags,
666 0 /* Offset, unused */, (uint64_t)srcObjData.mObjectSize);
667
668 int vrc2 = RTFileClose(hDstFile);
669 AssertRC(vrc2);
670 }
671 else
672 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
673 Utf8StrFmt(tr("Opening/creating host file \"%s\" failed: %Rrc"), strDst.c_str(), vrc));
674 }
675
676 int vrc2 = srcFile->i_closeFile(&vrcGuest);
677 AssertRC(vrc2);
678
679 LogFlowFuncLeaveRC(vrc);
680 return vrc;
681}
682
683/**
684 * Main function for copying a file from host to the guest.
685 *
686 * @return VBox status code.
687 * @param strSrcFile Full path of source file on the host to copy.
688 * @param hVfsFile The VFS file handle to read from.
689 * @param strDstFile Full destination path and file name (guest style) to copy file to.
690 * @param fileDst Guest file (destination) to copy to the guest. Must be in opened and ready state already.
691 * @param fFileCopyFlags File copy flags.
692 * @param offCopy Offset (in bytes) where to start copying the source file.
693 * @param cbSize Size (in bytes) to copy from the source file.
694 */
695int GuestSessionTask::fileCopyToGuestInner(const Utf8Str &strSrcFile, RTVFSFILE hVfsFile,
696 const Utf8Str &strDstFile, ComObjPtr<GuestFile> &fileDst,
697 FileCopyFlag_T fFileCopyFlags, uint64_t offCopy, uint64_t cbSize)
698{
699 RT_NOREF(fFileCopyFlags);
700
701 BOOL fCanceled = FALSE;
702 uint64_t cbWrittenTotal = 0;
703 uint64_t cbToRead = cbSize;
704
705 uint32_t uTimeoutMs = 30 * 1000; /* 30s timeout. */
706
707 int vrc = VINF_SUCCESS;
708
709 if (offCopy)
710 {
711 uint64_t offActual;
712 vrc = RTVfsFileSeek(hVfsFile, offCopy, RTFILE_SEEK_END, &offActual);
713 if (RT_FAILURE(vrc))
714 {
715 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
716 Utf8StrFmt(tr("Seeking to offset %RU64 of host file \"%s\" failed: %Rrc"),
717 offCopy, strSrcFile.c_str(), vrc));
718 return vrc;
719 }
720 }
721
722 BYTE byBuf[_64K];
723 while (cbToRead)
724 {
725 size_t cbRead;
726 const uint32_t cbChunk = RT_MIN(cbToRead, sizeof(byBuf));
727 vrc = RTVfsFileRead(hVfsFile, byBuf, cbChunk, &cbRead);
728 if (RT_FAILURE(vrc))
729 {
730 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
731 Utf8StrFmt(tr("Reading %RU32 bytes @ %RU64 from host file \"%s\" failed: %Rrc", "", cbChunk),
732 cbChunk, cbWrittenTotal, strSrcFile.c_str(), vrc));
733 break;
734 }
735
736 vrc = fileDst->i_writeData(uTimeoutMs, byBuf, (uint32_t)cbRead, NULL /* No partial writes */);
737 if (RT_FAILURE(vrc))
738 {
739 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
740 Utf8StrFmt(tr("Writing %zu bytes to guest file \"%s\" failed: %Rrc", "", cbRead),
741 cbRead, strDstFile.c_str(), vrc));
742 break;
743 }
744
745 Assert(cbToRead >= cbRead);
746 cbToRead -= cbRead;
747
748 /* Update total bytes written to the guest. */
749 cbWrittenTotal += cbRead;
750 Assert(cbWrittenTotal <= cbSize);
751
752 /* Did the user cancel the operation above? */
753 if ( SUCCEEDED(mProgress->COMGETTER(Canceled(&fCanceled)))
754 && fCanceled)
755 break;
756
757 vrc = setProgress((ULONG)((double)cbWrittenTotal / (double)cbSize / 100.0));
758 if (RT_FAILURE(vrc))
759 break;
760 }
761
762 if (RT_FAILURE(vrc))
763 return vrc;
764
765 /*
766 * Even if we succeeded until here make sure to check whether we really transferred
767 * everything.
768 */
769 if ( cbSize > 0
770 && cbWrittenTotal == 0)
771 {
772 /* If nothing was transferred but the file size was > 0 then "vbox_cat" wasn't able to write
773 * to the destination -> access denied. */
774 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
775 Utf8StrFmt(tr("Writing to guest file \"%s\" failed: Access denied"),
776 strDstFile.c_str()));
777 vrc = VERR_ACCESS_DENIED;
778 }
779 else if (cbWrittenTotal < cbSize)
780 {
781 /* If we did not copy all let the user know. */
782 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
783 Utf8StrFmt(tr("Copying to guest file \"%s\" failed (%RU64/%RU64 bytes transferred)"),
784 strDstFile.c_str(), cbWrittenTotal, cbSize));
785 vrc = VERR_INTERRUPTED;
786 }
787
788 LogFlowFuncLeaveRC(vrc);
789 return vrc;
790}
791
792/**
793 * Copies a file from the host to the guest.
794 *
795 * @return VBox status code.
796 * @retval VWRN_ALREADY_EXISTS if the file already exists and FileCopyFlag_NoReplace is specified,
797 * *or * the file at the destination has the same (or newer) modification time
798 * and FileCopyFlag_Update is specified.
799 * @param strSrc Full path of source file on the host.
800 * @param strDst Full destination path and file name (guest style) to copy file to. Guest-path style.
801 * @param fFileCopyFlags File copy flags.
802 */
803int GuestSessionTask::fileCopyToGuest(const Utf8Str &strSrc, const Utf8Str &strDst, FileCopyFlag_T fFileCopyFlags)
804{
805 LogFlowThisFunc(("strSource=%s, strDst=%s, fFileCopyFlags=%#x\n", strSrc.c_str(), strDst.c_str(), fFileCopyFlags));
806
807 GuestFileOpenInfo dstOpenInfo;
808 dstOpenInfo.mFilename = strDst;
809 if (fFileCopyFlags & FileCopyFlag_NoReplace)
810 dstOpenInfo.mOpenAction = FileOpenAction_CreateNew;
811 else
812 dstOpenInfo.mOpenAction = FileOpenAction_CreateOrReplace;
813 dstOpenInfo.mAccessMode = FileAccessMode_WriteOnly;
814 dstOpenInfo.mSharingMode = FileSharingMode_All; /** @todo Use _Read when implemented. */
815
816 ComObjPtr<GuestFile> dstFile;
817 int vrcGuest;
818 int vrc = mSession->i_fileOpen(dstOpenInfo, dstFile, &vrcGuest);
819 if (RT_FAILURE(vrc))
820 {
821 if (vrc == VERR_GSTCTL_GUEST_ERROR)
822 setProgressErrorMsg(VBOX_E_IPRT_ERROR, tr("Guest file could not be created or replaced"),
823 GuestErrorInfo(GuestErrorInfo::Type_File, vrcGuest, strDst.c_str()));
824 else
825 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
826 Utf8StrFmt(tr("Guest file \"%s\" could not be created or replaced: %Rrc"), strDst.c_str(), vrc));
827 return vrc;
828 }
829
830 char szSrcReal[RTPATH_MAX];
831
832 RTFSOBJINFO srcObjInfo;
833 RT_ZERO(srcObjInfo);
834
835 bool fSkip = false; /* Whether to skip handling the file. */
836
837 if (RT_SUCCESS(vrc))
838 {
839 vrc = RTPathReal(strSrc.c_str(), szSrcReal, sizeof(szSrcReal));
840 if (RT_FAILURE(vrc))
841 {
842 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
843 Utf8StrFmt(tr("Host path lookup for file \"%s\" failed: %Rrc"),
844 strSrc.c_str(), vrc));
845 }
846 else
847 {
848 vrc = RTPathQueryInfo(szSrcReal, &srcObjInfo, RTFSOBJATTRADD_NOTHING);
849 if (RT_SUCCESS(vrc))
850 {
851 /* Only perform a remote file query when needed. */
852 if ( (fFileCopyFlags & FileCopyFlag_Update)
853 || (fFileCopyFlags & FileCopyFlag_NoReplace))
854 {
855 GuestFsObjData dstObjData;
856 vrc = mSession->i_fileQueryInfo(strDst, RT_BOOL(fFileCopyFlags & FileCopyFlag_FollowLinks), dstObjData,
857 &vrcGuest);
858 if (RT_SUCCESS(vrc))
859 {
860 if (fFileCopyFlags & FileCopyFlag_NoReplace)
861 {
862 LogRel2(("Guest Control: Guest file \"%s\" already exists, skipping", strDst.c_str()));
863 vrc = VWRN_ALREADY_EXISTS;
864 fSkip = true;
865 }
866
867 if ( !fSkip
868 && fFileCopyFlags & FileCopyFlag_Update)
869 {
870 RTTIMESPEC dstModificationTimeTS;
871 RTTimeSpecSetSeconds(&dstModificationTimeTS, dstObjData.mModificationTime);
872 if (RTTimeSpecCompare(&dstModificationTimeTS, &srcObjInfo.ModificationTime) <= 0)
873 {
874 LogRel2(("Guest Control: Guest file \"%s\" has same or newer modification date, skipping",
875 strDst.c_str()));
876 vrc = VWRN_ALREADY_EXISTS;
877 fSkip = true;
878 }
879 }
880 }
881 else
882 {
883 if (vrc == VERR_GSTCTL_GUEST_ERROR)
884 {
885 switch (vrcGuest)
886 {
887 case VERR_FILE_NOT_FOUND:
888 vrc = VINF_SUCCESS;
889 break;
890
891 default:
892 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
893 Utf8StrFmt(tr("Guest error while determining object data for guest file \"%s\": %Rrc"),
894 strDst.c_str(), vrcGuest));
895 break;
896 }
897 }
898 else
899 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
900 Utf8StrFmt(tr("Host error while determining object data for guest file \"%s\": %Rrc"),
901 strDst.c_str(), vrc));
902 }
903 }
904 }
905 else
906 {
907 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
908 Utf8StrFmt(tr("Host source file lookup for \"%s\" failed: %Rrc"),
909 szSrcReal, vrc));
910 }
911 }
912 }
913
914 if (fSkip)
915 {
916 int vrc2 = dstFile->i_closeFile(&vrcGuest);
917 AssertRC(vrc2);
918 return vrc;
919 }
920
921 if (RT_SUCCESS(vrc))
922 {
923 LogRel2(("Guest Control: Copying file '%s' from host to '%s' on guest ...\n", strSrc.c_str(), strDst.c_str()));
924
925 RTVFSFILE hSrcFile;
926 vrc = RTVfsFileOpenNormal(szSrcReal, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE, &hSrcFile);
927 if (RT_SUCCESS(vrc))
928 {
929 LogFlowThisFunc(("Copying '%s' to '%s' (%RI64 bytes) ...\n",
930 szSrcReal, strDst.c_str(), srcObjInfo.cbObject));
931
932 vrc = fileCopyToGuestInner(szSrcReal, hSrcFile, strDst, dstFile,
933 fFileCopyFlags, 0 /* Offset, unused */, srcObjInfo.cbObject);
934
935 int vrc2 = RTVfsFileRelease(hSrcFile);
936 AssertRC(vrc2);
937 }
938 else
939 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
940 Utf8StrFmt(tr("Opening host file \"%s\" failed: %Rrc"),
941 szSrcReal, vrc));
942 }
943
944 int vrc2 = dstFile->i_closeFile(&vrcGuest);
945 AssertRC(vrc2);
946
947 LogFlowFuncLeaveRC(vrc);
948 return vrc;
949}
950
951/**
952 * Adds a guest file system entry to a given list.
953 *
954 * @return VBox status code.
955 * @param strFile Path to file system entry to add.
956 * @param fsObjData Guest file system information of entry to add.
957 */
958int FsList::AddEntryFromGuest(const Utf8Str &strFile, const GuestFsObjData &fsObjData)
959{
960 LogFlowFunc(("Adding '%s'\n", strFile.c_str()));
961
962 FsEntry *pEntry = NULL;
963 try
964 {
965 pEntry = new FsEntry();
966 pEntry->fMode = fsObjData.GetFileMode();
967 pEntry->strPath = strFile;
968
969 mVecEntries.push_back(pEntry);
970 }
971 catch (std::bad_alloc &)
972 {
973 if (pEntry)
974 delete pEntry;
975 return VERR_NO_MEMORY;
976 }
977
978 return VINF_SUCCESS;
979}
980
981/**
982 * Adds a host file system entry to a given list.
983 *
984 * @return VBox status code.
985 * @param strFile Path to file system entry to add.
986 * @param pcObjInfo File system information of entry to add.
987 */
988int FsList::AddEntryFromHost(const Utf8Str &strFile, PCRTFSOBJINFO pcObjInfo)
989{
990 LogFlowFunc(("Adding '%s'\n", strFile.c_str()));
991
992 FsEntry *pEntry = NULL;
993 try
994 {
995 pEntry = new FsEntry();
996 pEntry->fMode = pcObjInfo->Attr.fMode;
997 pEntry->strPath = strFile;
998
999 mVecEntries.push_back(pEntry);
1000 }
1001 catch (std::bad_alloc &)
1002 {
1003 if (pEntry)
1004 delete pEntry;
1005 return VERR_NO_MEMORY;
1006 }
1007
1008 return VINF_SUCCESS;
1009}
1010
1011FsList::FsList(const GuestSessionTask &Task)
1012 : mTask(Task)
1013{
1014}
1015
1016FsList::~FsList()
1017{
1018 Destroy();
1019}
1020
1021/**
1022 * Initializes a file list.
1023 *
1024 * @return VBox status code.
1025 * @param strSrcRootAbs Source root path (absolute) for this file list.
1026 * @param strDstRootAbs Destination root path (absolute) for this file list.
1027 * @param SourceSpec Source specification to use.
1028 */
1029int FsList::Init(const Utf8Str &strSrcRootAbs, const Utf8Str &strDstRootAbs,
1030 const GuestSessionFsSourceSpec &SourceSpec)
1031{
1032 mSrcRootAbs = strSrcRootAbs;
1033 mDstRootAbs = strDstRootAbs;
1034 mSourceSpec = SourceSpec;
1035
1036 /* Note: Leave the source and dest roots unmodified -- how paths will be treated
1037 * will be done directly when working on those. See @bugref{10139}. */
1038
1039 LogFlowFunc(("mSrcRootAbs=%s, mDstRootAbs=%s, fDirCopyFlags=%#x, fFileCopyFlags=%#x\n",
1040 mSrcRootAbs.c_str(), mDstRootAbs.c_str(), mSourceSpec.fDirCopyFlags, mSourceSpec.fFileCopyFlags));
1041
1042 return VINF_SUCCESS;
1043}
1044
1045/**
1046 * Destroys a file list.
1047 */
1048void FsList::Destroy(void)
1049{
1050 LogFlowFuncEnter();
1051
1052 FsEntries::iterator itEntry = mVecEntries.begin();
1053 while (itEntry != mVecEntries.end())
1054 {
1055 FsEntry *pEntry = *itEntry;
1056 delete pEntry;
1057 mVecEntries.erase(itEntry);
1058 itEntry = mVecEntries.begin();
1059 }
1060
1061 Assert(mVecEntries.empty());
1062
1063 LogFlowFuncLeave();
1064}
1065
1066#ifdef DEBUG
1067/**
1068 * Dumps a FsList to the debug log.
1069 */
1070void FsList::DumpToLog(void)
1071{
1072 LogFlowFunc(("strSrcRootAbs=%s, strDstRootAbs=%s\n", mSrcRootAbs.c_str(), mDstRootAbs.c_str()));
1073
1074 FsEntries::iterator itEntry = mVecEntries.begin();
1075 while (itEntry != mVecEntries.end())
1076 {
1077 FsEntry *pEntry = *itEntry;
1078 LogFlowFunc(("\tstrPath=%s (fMode %#x)\n", pEntry->strPath.c_str(), pEntry->fMode));
1079 ++itEntry;
1080 }
1081
1082 LogFlowFuncLeave();
1083}
1084#endif /* DEBUG */
1085
1086/**
1087 * Builds a guest file list from a given path (and optional filter).
1088 *
1089 * @return VBox status code.
1090 * @param strPath Directory on the guest to build list from.
1091 * @param strSubDir Current sub directory path; needed for recursion.
1092 * Set to an empty path.
1093 */
1094int FsList::AddDirFromGuest(const Utf8Str &strPath, const Utf8Str &strSubDir /* = "" */)
1095{
1096 Utf8Str strPathAbs = strPath;
1097 if (!strPathAbs.endsWith(PATH_STYLE_SEP_STR(mSourceSpec.enmPathStyle)))
1098 strPathAbs += PATH_STYLE_SEP_STR(mSourceSpec.enmPathStyle);
1099
1100 Utf8Str strPathSub = strSubDir;
1101 if ( strPathSub.isNotEmpty()
1102 && !strPathSub.endsWith(PATH_STYLE_SEP_STR(mSourceSpec.enmPathStyle)))
1103 strPathSub += PATH_STYLE_SEP_STR(mSourceSpec.enmPathStyle);
1104
1105 strPathAbs += strPathSub;
1106
1107 LogFlowFunc(("Entering '%s' (sub '%s')\n", strPathAbs.c_str(), strPathSub.c_str()));
1108
1109 LogRel2(("Guest Control: Handling directory '%s' on guest ...\n", strPathAbs.c_str()));
1110
1111 GuestDirectoryOpenInfo dirOpenInfo;
1112 dirOpenInfo.mFilter = "";
1113 dirOpenInfo.mPath = strPathAbs;
1114 dirOpenInfo.mFlags = 0; /** @todo Handle flags? */
1115
1116 const ComObjPtr<GuestSession> &pSession = mTask.GetSession();
1117
1118 ComObjPtr <GuestDirectory> pDir;
1119 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
1120 int vrc = pSession->i_directoryOpen(dirOpenInfo, pDir, &vrcGuest);
1121 if (RT_FAILURE(vrc))
1122 {
1123 switch (vrc)
1124 {
1125 case VERR_INVALID_PARAMETER:
1126 break;
1127
1128 case VERR_GSTCTL_GUEST_ERROR:
1129 break;
1130
1131 default:
1132 break;
1133 }
1134
1135 return vrc;
1136 }
1137
1138 if (strPathSub.isNotEmpty())
1139 {
1140 GuestFsObjData fsObjData;
1141 fsObjData.mType = FsObjType_Directory;
1142
1143 vrc = AddEntryFromGuest(strPathSub, fsObjData);
1144 }
1145
1146 if (RT_SUCCESS(vrc))
1147 {
1148 ComObjPtr<GuestFsObjInfo> fsObjInfo;
1149 while (RT_SUCCESS(vrc = pDir->i_read(fsObjInfo, &vrcGuest)))
1150 {
1151 FsObjType_T enmObjType = FsObjType_Unknown; /* Shut up MSC. */
1152 HRESULT hrc2 = fsObjInfo->COMGETTER(Type)(&enmObjType);
1153 AssertComRC(hrc2);
1154
1155 com::Bstr bstrName;
1156 hrc2 = fsObjInfo->COMGETTER(Name)(bstrName.asOutParam());
1157 AssertComRC(hrc2);
1158
1159 Utf8Str strEntry = strPathSub + Utf8Str(bstrName);
1160
1161 LogFlowFunc(("Entry '%s'\n", strEntry.c_str()));
1162
1163 switch (enmObjType)
1164 {
1165 case FsObjType_Directory:
1166 {
1167 if ( bstrName.equals(".")
1168 || bstrName.equals(".."))
1169 {
1170 break;
1171 }
1172
1173 LogRel2(("Guest Control: Directory '%s'\n", strEntry.c_str()));
1174
1175 if (!(mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_Recursive))
1176 break;
1177
1178 vrc = AddDirFromGuest(strPath, strEntry);
1179 break;
1180 }
1181
1182 case FsObjType_Symlink:
1183 {
1184 if ( mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_FollowLinks
1185 || mSourceSpec.fFileCopyFlags & FileCopyFlag_FollowLinks)
1186 {
1187 /** @todo Symlink handling from guest is not implemented yet.
1188 * See IGuestSession::symlinkRead(). */
1189 LogRel2(("Guest Control: Warning: Symlink support on guest side not available, skipping '%s'",
1190 strEntry.c_str()));
1191 }
1192 break;
1193 }
1194
1195 case FsObjType_File:
1196 {
1197 LogRel2(("Guest Control: File '%s'\n", strEntry.c_str()));
1198
1199 vrc = AddEntryFromGuest(strEntry, fsObjInfo->i_getData());
1200 break;
1201 }
1202
1203 default:
1204 break;
1205 }
1206 }
1207
1208 if (vrc == VERR_NO_MORE_FILES) /* End of listing reached? */
1209 vrc = VINF_SUCCESS;
1210 }
1211
1212 int vrc2 = pDir->i_closeInternal(&vrcGuest);
1213 if (RT_SUCCESS(vrc))
1214 vrc = vrc2;
1215
1216 return vrc;
1217}
1218
1219/**
1220 * Builds a host file list from a given path.
1221 *
1222 * @return VBox status code.
1223 * @param strPath Directory on the host to build list from.
1224 * @param strSubDir Current sub directory path; needed for recursion.
1225 * Set to an empty path.
1226 * @param pszPathReal Scratch buffer for holding the resolved real path.
1227 * Needed for recursion.
1228 * @param cbPathReal Size (in bytes) of \a pszPathReal.
1229 * @param pDirEntry Where to store looked up directory information for handled paths.
1230 * Needed for recursion.
1231 */
1232int FsList::AddDirFromHost(const Utf8Str &strPath, const Utf8Str &strSubDir,
1233 char *pszPathReal, size_t cbPathReal, PRTDIRENTRYEX pDirEntry)
1234{
1235 Utf8Str strPathAbs = strPath;
1236 if (!strPathAbs.endsWith(RTPATH_SLASH_STR))
1237 strPathAbs += RTPATH_SLASH_STR;
1238
1239 Utf8Str strPathSub = strSubDir;
1240 if ( strPathSub.isNotEmpty()
1241 && !strPathSub.endsWith(RTPATH_SLASH_STR))
1242 strPathSub += RTPATH_SLASH_STR;
1243
1244 strPathAbs += strPathSub;
1245
1246 LogFlowFunc(("Entering '%s' (sub '%s')\n", strPathAbs.c_str(), strPathSub.c_str()));
1247
1248 LogRel2(("Guest Control: Handling directory '%s' on host ...\n", strPathAbs.c_str()));
1249
1250 RTFSOBJINFO objInfo;
1251 int vrc = RTPathQueryInfo(strPathAbs.c_str(), &objInfo, RTFSOBJATTRADD_NOTHING);
1252 if (RT_SUCCESS(vrc))
1253 {
1254 if (RTFS_IS_DIRECTORY(objInfo.Attr.fMode))
1255 {
1256 if (strPathSub.isNotEmpty())
1257 vrc = AddEntryFromHost(strPathSub, &objInfo);
1258
1259 if (RT_SUCCESS(vrc))
1260 {
1261 RTDIR hDir;
1262 vrc = RTDirOpen(&hDir, strPathAbs.c_str());
1263 if (RT_SUCCESS(vrc))
1264 {
1265 do
1266 {
1267 /* Retrieve the next directory entry. */
1268 vrc = RTDirReadEx(hDir, pDirEntry, NULL, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
1269 if (RT_FAILURE(vrc))
1270 {
1271 if (vrc == VERR_NO_MORE_FILES)
1272 vrc = VINF_SUCCESS;
1273 break;
1274 }
1275
1276 Utf8Str strEntry = strPathSub + Utf8Str(pDirEntry->szName);
1277
1278 LogFlowFunc(("Entry '%s'\n", strEntry.c_str()));
1279
1280 switch (pDirEntry->Info.Attr.fMode & RTFS_TYPE_MASK)
1281 {
1282 case RTFS_TYPE_DIRECTORY:
1283 {
1284 /* Skip "." and ".." entries. */
1285 if (RTDirEntryExIsStdDotLink(pDirEntry))
1286 break;
1287
1288 LogRel2(("Guest Control: Directory '%s'\n", strEntry.c_str()));
1289
1290 if (!(mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_Recursive))
1291 break;
1292
1293 vrc = AddDirFromHost(strPath, strEntry, pszPathReal, cbPathReal, pDirEntry);
1294 break;
1295 }
1296
1297 case RTFS_TYPE_FILE:
1298 {
1299 LogRel2(("Guest Control: File '%s'\n", strEntry.c_str()));
1300
1301 vrc = AddEntryFromHost(strEntry, &pDirEntry->Info);
1302 break;
1303 }
1304
1305 case RTFS_TYPE_SYMLINK:
1306 {
1307 Utf8Str strEntryAbs = strPathAbs + (const char *)pDirEntry->szName;
1308
1309 vrc = RTPathReal(strEntryAbs.c_str(), pszPathReal, cbPathReal);
1310 if (RT_SUCCESS(vrc))
1311 {
1312 vrc = RTPathQueryInfo(pszPathReal, &objInfo, RTFSOBJATTRADD_NOTHING);
1313 if (RT_SUCCESS(vrc))
1314 {
1315 if (RTFS_IS_DIRECTORY(objInfo.Attr.fMode))
1316 {
1317 LogRel2(("Guest Control: Symbolic link '%s' -> '%s' (directory)\n",
1318 strEntryAbs.c_str(), pszPathReal));
1319 if (mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_FollowLinks)
1320 vrc = AddDirFromHost(strPath, strEntry, pszPathReal, cbPathReal, pDirEntry);
1321 }
1322 else if (RTFS_IS_FILE(objInfo.Attr.fMode))
1323 {
1324 LogRel2(("Guest Control: Symbolic link '%s' -> '%s' (file)\n",
1325 strEntryAbs.c_str(), pszPathReal));
1326 if (mSourceSpec.fFileCopyFlags & DirectoryCopyFlag_FollowLinks)
1327 vrc = AddEntryFromHost(strEntry, &objInfo);
1328 }
1329 else
1330 vrc = VERR_NOT_SUPPORTED;
1331 }
1332
1333 if (RT_FAILURE(vrc))
1334 LogRel2(("Guest Control: Unable to query symbolic link info for '%s', rc=%Rrc\n",
1335 pszPathReal, vrc));
1336 }
1337 else
1338 {
1339 LogRel2(("Guest Control: Unable to resolve symlink for '%s', rc=%Rrc\n", strPathAbs.c_str(), vrc));
1340 if (vrc == VERR_FILE_NOT_FOUND) /* Broken symlink, skip. */
1341 vrc = VINF_SUCCESS;
1342 }
1343 break;
1344 }
1345
1346 default:
1347 break;
1348 }
1349
1350 } while (RT_SUCCESS(vrc));
1351
1352 RTDirClose(hDir);
1353 }
1354 }
1355 }
1356 else if (RTFS_IS_FILE(objInfo.Attr.fMode))
1357 vrc = VERR_IS_A_FILE;
1358 else if (RTFS_IS_SYMLINK(objInfo.Attr.fMode))
1359 vrc = VERR_IS_A_SYMLINK;
1360 else
1361 vrc = VERR_NOT_SUPPORTED;
1362 }
1363 else
1364 LogFlowFunc(("Unable to query '%s', rc=%Rrc\n", strPathAbs.c_str(), vrc));
1365
1366 LogFlowFuncLeaveRC(vrc);
1367 return vrc;
1368}
1369
1370GuestSessionTaskOpen::GuestSessionTaskOpen(GuestSession *pSession, uint32_t uFlags, uint32_t uTimeoutMS)
1371 : GuestSessionTask(pSession)
1372 , mFlags(uFlags)
1373 , mTimeoutMS(uTimeoutMS)
1374{
1375 m_strTaskName = "gctlSesOpen";
1376}
1377
1378GuestSessionTaskOpen::~GuestSessionTaskOpen(void)
1379{
1380
1381}
1382
1383/** @copydoc GuestSessionTask::Run */
1384int GuestSessionTaskOpen::Run(void)
1385{
1386 LogFlowThisFuncEnter();
1387
1388 AutoCaller autoCaller(mSession);
1389 if (FAILED(autoCaller.rc())) return autoCaller.rc();
1390
1391 int vrc = mSession->i_startSession(NULL /*pvrcGuest*/);
1392 /* Nothing to do here anymore. */
1393
1394 LogFlowFuncLeaveRC(vrc);
1395 return vrc;
1396}
1397
1398GuestSessionCopyTask::GuestSessionCopyTask(GuestSession *pSession)
1399 : GuestSessionTask(pSession)
1400{
1401}
1402
1403GuestSessionCopyTask::~GuestSessionCopyTask()
1404{
1405 FsLists::iterator itList = mVecLists.begin();
1406 while (itList != mVecLists.end())
1407 {
1408 FsList *pFsList = (*itList);
1409 pFsList->Destroy();
1410 delete pFsList;
1411 mVecLists.erase(itList);
1412 itList = mVecLists.begin();
1413 }
1414
1415 Assert(mVecLists.empty());
1416}
1417
1418GuestSessionTaskCopyFrom::GuestSessionTaskCopyFrom(GuestSession *pSession, GuestSessionFsSourceSet const &vecSrc,
1419 const Utf8Str &strDest)
1420 : GuestSessionCopyTask(pSession)
1421{
1422 m_strTaskName = "gctlCpyFrm";
1423
1424 mSources = vecSrc;
1425 mDest = strDest;
1426}
1427
1428GuestSessionTaskCopyFrom::~GuestSessionTaskCopyFrom(void)
1429{
1430}
1431
1432/**
1433 * Initializes a copy-from-guest task.
1434 *
1435 * @returns HRESULT
1436 * @param strTaskDesc Friendly task description.
1437 */
1438HRESULT GuestSessionTaskCopyFrom::Init(const Utf8Str &strTaskDesc)
1439{
1440 setTaskDesc(strTaskDesc);
1441
1442 /* Create the progress object. */
1443 ComObjPtr<Progress> pProgress;
1444 HRESULT hrc = pProgress.createObject();
1445 if (FAILED(hrc))
1446 return hrc;
1447
1448 mProgress = pProgress;
1449
1450 int vrc = VINF_SUCCESS;
1451
1452 ULONG cOperations = 0;
1453 Utf8Str strErrorInfo;
1454
1455 /**
1456 * Note: We need to build up the file/directory here instead of GuestSessionTaskCopyFrom::Run
1457 * because the caller expects a ready-for-operation progress object on return.
1458 * The progress object will have a variable operation count, based on the elements to
1459 * be processed.
1460 */
1461
1462 if (mDest.isEmpty())
1463 {
1464 strErrorInfo.printf(tr("Host destination must not be empty"));
1465 vrc = VERR_INVALID_PARAMETER;
1466 }
1467 else
1468 {
1469 GuestSessionFsSourceSet::iterator itSrc = mSources.begin();
1470 while (itSrc != mSources.end())
1471 {
1472 Utf8Str strSrc = itSrc->strSource;
1473 Utf8Str strDst = mDest;
1474
1475 bool fFollowSymlinks;
1476
1477 if (strSrc.isEmpty())
1478 {
1479 strErrorInfo.printf(tr("Guest source entry must not be empty"));
1480 vrc = VERR_INVALID_PARAMETER;
1481 break;
1482 }
1483
1484 if (itSrc->enmType == FsObjType_Directory)
1485 {
1486 fFollowSymlinks = itSrc->fDirCopyFlags & DirectoryCopyFlag_FollowLinks;
1487 }
1488 else
1489 {
1490 fFollowSymlinks = RT_BOOL(itSrc->fFileCopyFlags & FileCopyFlag_FollowLinks);
1491 }
1492
1493 LogFlowFunc(("strSrc=%s (path style is %s), strDst=%s, fFollowSymlinks=%RTbool\n",
1494 strSrc.c_str(), GuestBase::pathStyleToStr(itSrc->enmPathStyle), strDst.c_str(), fFollowSymlinks));
1495
1496 GuestFsObjData srcObjData;
1497 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
1498 vrc = mSession->i_fsQueryInfo(strSrc, fFollowSymlinks, srcObjData, &vrcGuest);
1499 if (RT_FAILURE(vrc))
1500 {
1501 if (vrc == VERR_GSTCTL_GUEST_ERROR)
1502 strErrorInfo = GuestBase::getErrorAsString(tr("Guest source lookup failed"),
1503 GuestErrorInfo(GuestErrorInfo::Type_ToolStat, vrcGuest, strSrc.c_str()));
1504 else
1505 strErrorInfo.printf(tr("Guest source lookup for \"%s\" failed: %Rrc"),
1506 strSrc.c_str(), vrc);
1507 break;
1508 }
1509
1510 if (srcObjData.mType == FsObjType_Directory)
1511 {
1512 if (itSrc->enmType != FsObjType_Directory)
1513 {
1514 strErrorInfo.printf(tr("Guest source is not a file: %s"), strSrc.c_str());
1515 vrc = VERR_NOT_A_FILE;
1516 break;
1517 }
1518 }
1519 else
1520 {
1521 if (itSrc->enmType != FsObjType_File)
1522 {
1523 strErrorInfo.printf(tr("Guest source is not a directory: %s"), strSrc.c_str());
1524 vrc = VERR_NOT_A_DIRECTORY;
1525 break;
1526 }
1527 }
1528
1529 FsList *pFsList = NULL;
1530 try
1531 {
1532 pFsList = new FsList(*this);
1533 vrc = pFsList->Init(strSrc, strDst, *itSrc);
1534 if (RT_SUCCESS(vrc))
1535 {
1536 switch (itSrc->enmType)
1537 {
1538 case FsObjType_Directory:
1539 {
1540 vrc = pFsList->AddDirFromGuest(strSrc);
1541 break;
1542 }
1543
1544 case FsObjType_File:
1545 /* The file name is already part of the actual list's source root (strSrc). */
1546 break;
1547
1548 default:
1549 LogRel2(("Guest Control: Warning: Unknown guest file system type %#x for source \"%s\", skipping\n",
1550 itSrc->enmType, strSrc.c_str()));
1551 break;
1552 }
1553 }
1554
1555 if (RT_FAILURE(vrc))
1556 {
1557 delete pFsList;
1558 strErrorInfo.printf(tr("Error adding guest source '%s' to list: %Rrc"),
1559 strSrc.c_str(), vrc);
1560 break;
1561 }
1562#ifdef DEBUG
1563 pFsList->DumpToLog();
1564#endif
1565 mVecLists.push_back(pFsList);
1566 }
1567 catch (std::bad_alloc &)
1568 {
1569 vrc = VERR_NO_MEMORY;
1570 break;
1571 }
1572
1573 AssertPtr(pFsList);
1574 cOperations += (ULONG)pFsList->mVecEntries.size();
1575
1576 itSrc++;
1577 }
1578 }
1579
1580 if (cOperations) /* Use the first element as description (if available). */
1581 {
1582 Assert(mVecLists.size());
1583 Assert(mVecLists[0]->mVecEntries.size());
1584
1585 Utf8Str const &strFirstOp = mVecLists[0]->mVecEntries[0]->strPath;
1586
1587 /* Now that we know how many objects we're handling, tweak the progress description so that it
1588 * reflects more accurately what the progress is actually doing. */
1589 if (cOperations > 1)
1590 {
1591 mDesc.printf(tr("Copying \"%s\" [and %zu %s] from guest to \"%s\" on the host ..."),
1592 strFirstOp.c_str(), cOperations - 1, cOperations > 2 ? tr("others") : tr("other"), mDest.c_str());
1593 }
1594 else
1595 mDesc.printf(tr("Copying \"%s\" from guest to \"%s\" on the host ..."), strFirstOp.c_str(), mDest.c_str());
1596
1597 hrc = pProgress->init(static_cast<IGuestSession*>(mSession), Bstr(mDesc).raw(),
1598 TRUE /* aCancelable */, cOperations + 1 /* Number of operations */, Bstr(strFirstOp).raw());
1599 }
1600 else /* If no operations have been defined, go with an "empty" progress object when will be used for error handling. */
1601 hrc = pProgress->init(static_cast<IGuestSession*>(mSession), Bstr(mDesc).raw(),
1602 TRUE /* aCancelable */, 1 /* cOperations */, Bstr(mDesc).raw());
1603
1604 if (RT_FAILURE(vrc))
1605 {
1606 if (strErrorInfo.isEmpty())
1607 strErrorInfo.printf(tr("Failed with %Rrc"), vrc);
1608 setProgressErrorMsg(VBOX_E_IPRT_ERROR, strErrorInfo);
1609 }
1610
1611 LogFlowFunc(("Returning %Rhrc (%Rrc)\n", hrc, vrc));
1612 return hrc;
1613}
1614
1615/** @copydoc GuestSessionTask::Run */
1616int GuestSessionTaskCopyFrom::Run(void)
1617{
1618 LogFlowThisFuncEnter();
1619
1620 AutoCaller autoCaller(mSession);
1621 if (FAILED(autoCaller.rc())) return autoCaller.rc();
1622
1623 int vrc = VINF_SUCCESS;
1624
1625 FsLists::const_iterator itList = mVecLists.begin();
1626 while (itList != mVecLists.end())
1627 {
1628 FsList *pList = *itList;
1629 AssertPtr(pList);
1630
1631 LogFlowFunc(("List: srcRootAbs=%s, dstRootAbs=%s\n", pList->mSrcRootAbs.c_str(), pList->mDstRootAbs.c_str()));
1632
1633 Utf8Str strSrcRootAbs = pList->mSrcRootAbs;
1634 Utf8Str strDstRootAbs = pList->mDstRootAbs;
1635
1636 GuestPath::BuildDestinationPath(strSrcRootAbs, mSession->i_getGuestPathStyle(),
1637 strDstRootAbs, PATH_STYLE_NATIVE);
1638
1639 bool fCopyIntoExisting;
1640 bool fFollowSymlinks;
1641
1642 if (pList->mSourceSpec.enmType == FsObjType_Directory)
1643 {
1644 fCopyIntoExisting = RT_BOOL(pList->mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_CopyIntoExisting);
1645 fFollowSymlinks = RT_BOOL(pList->mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_FollowLinks);
1646 }
1647 else if (pList->mSourceSpec.enmType == FsObjType_File)
1648 {
1649 fCopyIntoExisting = !RT_BOOL(pList->mSourceSpec.fFileCopyFlags & FileCopyFlag_NoReplace);
1650 fFollowSymlinks = RT_BOOL(pList->mSourceSpec.fFileCopyFlags & FileCopyFlag_FollowLinks);
1651 }
1652 else
1653 AssertFailedBreakStmt(vrc = VERR_NOT_IMPLEMENTED);
1654
1655 uint32_t const fDirMode = 0700; /** @todo Play safe by default; implement ACLs. */
1656 uint32_t fDirCreate = 0;
1657
1658 bool fDstExists = true;
1659
1660 RTFSOBJINFO ObjInfo;
1661 RT_ZERO(ObjInfo);
1662 vrc = RTPathQueryInfoEx(strDstRootAbs.c_str(), &ObjInfo, RTFSOBJATTRADD_NOTHING,
1663 fFollowSymlinks ? RTPATH_F_FOLLOW_LINK : RTPATH_F_ON_LINK /* fFlags */);
1664 if (RT_FAILURE(vrc))
1665 {
1666 if ( vrc == VERR_FILE_NOT_FOUND
1667 || vrc == VERR_PATH_NOT_FOUND)
1668 {
1669 fDstExists = false;
1670 vrc = VINF_SUCCESS;
1671 }
1672 else
1673 {
1674 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1675 Utf8StrFmt(tr("Host path lookup for \"%s\" failed: %Rrc"), strDstRootAbs.c_str(), vrc));
1676 break;
1677 }
1678 }
1679
1680 /* Create the root directory. */
1681 if (pList->mSourceSpec.enmType == FsObjType_Directory)
1682 {
1683 LogFlowFunc(("Directory: fDirCopyFlags=%#x, fCopyIntoExisting=%RTbool, fFollowSymlinks=%RTbool -> fDstExist=%RTbool (%s)\n",
1684 pList->mSourceSpec.fDirCopyFlags, fCopyIntoExisting, fFollowSymlinks,
1685 fDstExists, GuestBase::fsObjTypeToStr(GuestBase::fileModeToFsObjType(ObjInfo.Attr.fMode))));
1686
1687 if (fDstExists)
1688 {
1689 switch (ObjInfo.Attr.fMode & RTFS_TYPE_MASK)
1690 {
1691 case RTFS_TYPE_DIRECTORY:
1692 {
1693 if (!fCopyIntoExisting)
1694 {
1695 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1696 Utf8StrFmt(tr("Host root directory \"%s\" already exists"), strDstRootAbs.c_str()));
1697 vrc = VERR_ALREADY_EXISTS;
1698 break;
1699 }
1700 break;
1701 }
1702
1703 case RTFS_TYPE_FILE:
1704 {
1705 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1706 Utf8StrFmt(tr("Destination \"%s\" on the host already exists and is a file"), strDstRootAbs.c_str()));
1707 vrc = VERR_IS_A_FILE;
1708 break;
1709 }
1710
1711 default:
1712 {
1713 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1714 Utf8StrFmt(tr("Unknown object type (%#x) on host for \"%s\""),
1715 ObjInfo.Attr.fMode & RTFS_TYPE_MASK, strDstRootAbs.c_str()));
1716 vrc = VERR_NOT_SUPPORTED;
1717 break;
1718 }
1719 }
1720 }
1721
1722 if (RT_FAILURE(vrc))
1723 break;
1724
1725 /* Clean up the final host destination root path (for cleaning up mixed path separators). */
1726 vrc = GuestPath::Translate(strDstRootAbs,
1727 PATH_STYLE_NATIVE /* Source */, PATH_STYLE_NATIVE /* Dest */);
1728 if (RT_FAILURE(vrc))
1729 {
1730 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1731 Utf8StrFmt(tr("Translating host destination root path \"%s\" failed: %Rrc"),
1732 strDstRootAbs.c_str(), vrc));
1733 break;
1734 }
1735
1736 /* Make sure the destination root directory exists. */
1737 if (pList->mSourceSpec.fDryRun == false)
1738 {
1739 vrc = directoryCreateOnHost(strDstRootAbs, fDirMode, 0 /* fCreate */, true /* fCanExist */);
1740 if (RT_FAILURE(vrc))
1741 break;
1742 }
1743
1744 AssertBreakStmt(pList->mSourceSpec.enmType == FsObjType_Directory, vrc = VERR_NOT_SUPPORTED);
1745
1746 /* Walk the entries. */
1747 FsEntries::const_iterator itEntry = pList->mVecEntries.begin();
1748 while (itEntry != pList->mVecEntries.end())
1749 {
1750 FsEntry *pEntry = *itEntry;
1751 AssertPtr(pEntry);
1752
1753 Utf8Str strSrcAbs = strSrcRootAbs;
1754 Utf8Str strDstAbs = strDstRootAbs;
1755
1756 strSrcAbs += PATH_STYLE_SEP_STR(pList->mSourceSpec.enmPathStyle);
1757 strSrcAbs += pEntry->strPath;
1758
1759 strDstAbs += PATH_STYLE_SEP_STR(PATH_STYLE_NATIVE);
1760 strDstAbs += pEntry->strPath;
1761
1762 /* Clean up the final guest source path (for cleaning up mixed path separators). */
1763 vrc = GuestPath::Translate(strSrcAbs, pList->mSourceSpec.enmPathStyle /* Source */,
1764 pList->mSourceSpec.enmPathStyle /* Dest */);
1765 if (RT_FAILURE(vrc))
1766 {
1767 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1768 Utf8StrFmt(tr("Translating guest source path \"%s\" failed: %Rrc"),
1769 strSrcAbs.c_str(), vrc));
1770 break;
1771 }
1772
1773 /* Translate the final host destination path. */
1774 vrc = GuestPath::Translate(strDstAbs, PATH_STYLE_NATIVE /* Source */, PATH_STYLE_NATIVE /* Dest */);
1775 if (RT_FAILURE(vrc))
1776 {
1777 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1778 Utf8StrFmt(tr("Translating host destination path \"%s\" failed: %Rrc"),
1779 strDstAbs.c_str(), vrc));
1780 break;
1781 }
1782
1783 mProgress->SetNextOperation(Bstr(strSrcAbs).raw(), 1);
1784
1785 switch (pEntry->fMode & RTFS_TYPE_MASK)
1786 {
1787 case RTFS_TYPE_DIRECTORY:
1788 if (!pList->mSourceSpec.fDryRun)
1789 vrc = directoryCreateOnHost(strDstAbs, fDirMode, fDirCreate, fCopyIntoExisting);
1790 break;
1791
1792 case RTFS_TYPE_FILE:
1793 RT_FALL_THROUGH();
1794 case RTFS_TYPE_SYMLINK:
1795 if (!pList->mSourceSpec.fDryRun)
1796 vrc = fileCopyFromGuest(strSrcAbs, strDstAbs, pList->mSourceSpec.fFileCopyFlags);
1797 break;
1798
1799 default:
1800 AssertFailed(); /* Should never happen (we already have a filtered list). */
1801 break;
1802 }
1803
1804 if (RT_FAILURE(vrc))
1805 break;
1806
1807 ++itEntry;
1808 }
1809 }
1810 else if (pList->mSourceSpec.enmType == FsObjType_File)
1811 {
1812 LogFlowFunc(("File: fFileCopyFlags=%#x, fCopyIntoExisting=%RTbool, fFollowSymlinks=%RTbool -> fDstExist=%RTbool (%s)\n",
1813 pList->mSourceSpec.fFileCopyFlags, fCopyIntoExisting, fFollowSymlinks,
1814 fDstExists, GuestBase::fsObjTypeToStr(GuestBase::fileModeToFsObjType(ObjInfo.Attr.fMode))));
1815
1816 if (fDstExists)
1817 {
1818 switch (ObjInfo.Attr.fMode & RTFS_TYPE_MASK)
1819 {
1820 case RTFS_TYPE_DIRECTORY:
1821 {
1822 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1823 Utf8StrFmt(tr("Destination \"%s\" on the host already exists and is a directory"),
1824 strDstRootAbs.c_str()));
1825 vrc = VERR_IS_A_DIRECTORY;
1826 break;
1827 }
1828
1829 case RTFS_TYPE_FILE:
1830 {
1831 if (!fCopyIntoExisting)
1832 {
1833 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1834 Utf8StrFmt(tr("Host file \"%s\" already exists"), strDstRootAbs.c_str()));
1835 vrc = VERR_ALREADY_EXISTS;
1836 }
1837 break;
1838 }
1839
1840 default:
1841 {
1842 /** @todo Resolve symlinks? */
1843 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
1844 Utf8StrFmt(tr("Unknown object type (%#x) on host for \"%s\""),
1845 ObjInfo.Attr.fMode & RTFS_TYPE_MASK, strDstRootAbs.c_str()));
1846 vrc = VERR_NOT_SUPPORTED;
1847 break;
1848 }
1849 }
1850 }
1851
1852 if ( RT_SUCCESS(vrc)
1853 && !pList->mSourceSpec.fDryRun)
1854 vrc = fileCopyFromGuest(strSrcRootAbs, strDstRootAbs, pList->mSourceSpec.fFileCopyFlags);
1855 }
1856 else
1857 AssertFailedStmt(vrc = VERR_NOT_SUPPORTED);
1858
1859 if (RT_FAILURE(vrc))
1860 break;
1861
1862 ++itList;
1863 }
1864
1865 if (RT_SUCCESS(vrc))
1866 vrc = setProgressSuccess();
1867
1868 LogFlowFuncLeaveRC(vrc);
1869 return vrc;
1870}
1871
1872GuestSessionTaskCopyTo::GuestSessionTaskCopyTo(GuestSession *pSession, GuestSessionFsSourceSet const &vecSrc,
1873 const Utf8Str &strDest)
1874 : GuestSessionCopyTask(pSession)
1875{
1876 m_strTaskName = "gctlCpyTo";
1877
1878 mSources = vecSrc;
1879 mDest = strDest;
1880}
1881
1882GuestSessionTaskCopyTo::~GuestSessionTaskCopyTo(void)
1883{
1884}
1885
1886/**
1887 * Initializes a copy-to-guest task.
1888 *
1889 * @returns HRESULT
1890 * @param strTaskDesc Friendly task description.
1891 */
1892HRESULT GuestSessionTaskCopyTo::Init(const Utf8Str &strTaskDesc)
1893{
1894 LogFlowFuncEnter();
1895
1896 setTaskDesc(strTaskDesc);
1897
1898 /* Create the progress object. */
1899 ComObjPtr<Progress> pProgress;
1900 HRESULT hrc = pProgress.createObject();
1901 if (FAILED(hrc))
1902 return hrc;
1903
1904 mProgress = pProgress;
1905
1906 int vrc = VINF_SUCCESS;
1907
1908 ULONG cOperations = 0;
1909 Utf8Str strErrorInfo;
1910
1911 /*
1912 * Note: We need to build up the file/directory here instead of GuestSessionTaskCopyTo::Run
1913 * because the caller expects a ready-for-operation progress object on return.
1914 * The progress object will have a variable operation count, based on the elements to
1915 * be processed.
1916 */
1917
1918 if (mDest.isEmpty())
1919 {
1920 strErrorInfo.printf(tr("Guest destination must not be empty"));
1921 vrc = VERR_INVALID_PARAMETER;
1922 }
1923 else
1924 {
1925 GuestSessionFsSourceSet::iterator itSrc = mSources.begin();
1926 while (itSrc != mSources.end())
1927 {
1928 Utf8Str strSrc = itSrc->strSource;
1929 Utf8Str strDst = mDest;
1930
1931 bool fFollowSymlinks;
1932
1933 if (strSrc.isEmpty())
1934 {
1935 strErrorInfo.printf(tr("Host source entry must not be empty"));
1936 vrc = VERR_INVALID_PARAMETER;
1937 break;
1938 }
1939
1940 if (itSrc->enmType == FsObjType_Directory)
1941 {
1942 fFollowSymlinks = itSrc->fDirCopyFlags & DirectoryCopyFlag_FollowLinks;
1943 }
1944 else
1945 {
1946 fFollowSymlinks = RT_BOOL(itSrc->fFileCopyFlags & FileCopyFlag_FollowLinks);
1947 }
1948
1949 LogFlowFunc(("strSrc=%s (path style is %s), strDst=%s\n",
1950 strSrc.c_str(), GuestBase::pathStyleToStr(itSrc->enmPathStyle), strDst.c_str()));
1951
1952 RTFSOBJINFO srcFsObjInfo;
1953 vrc = RTPathQueryInfoEx(strSrc.c_str(), &srcFsObjInfo, RTFSOBJATTRADD_NOTHING,
1954 fFollowSymlinks ? RTPATH_F_FOLLOW_LINK : RTPATH_F_ON_LINK /* fFlags */);
1955 if (RT_FAILURE(vrc))
1956 {
1957 strErrorInfo.printf(tr("No such host file/directory: %s"), strSrc.c_str());
1958 break;
1959 }
1960
1961 if (RTFS_IS_DIRECTORY(srcFsObjInfo.Attr.fMode))
1962 {
1963 if (itSrc->enmType != FsObjType_Directory)
1964 {
1965 strErrorInfo.printf(tr("Host source is not a file: %s"), strSrc.c_str());
1966 vrc = VERR_NOT_A_FILE;
1967 break;
1968 }
1969 }
1970 else
1971 {
1972 if (itSrc->enmType == FsObjType_Directory)
1973 {
1974 strErrorInfo.printf(tr("Host source is not a directory: %s"), strSrc.c_str());
1975 vrc = VERR_NOT_A_DIRECTORY;
1976 break;
1977 }
1978 }
1979
1980 FsList *pFsList = NULL;
1981 try
1982 {
1983 pFsList = new FsList(*this);
1984 vrc = pFsList->Init(strSrc, strDst, *itSrc);
1985 if (RT_SUCCESS(vrc))
1986 {
1987 switch (itSrc->enmType)
1988 {
1989 case FsObjType_Directory:
1990 {
1991 char szPathReal[RTPATH_MAX];
1992 RTDIRENTRYEX DirEntry;
1993 vrc = pFsList->AddDirFromHost(strSrc /* strPath */, "" /* strSubDir */,
1994 szPathReal, sizeof(szPathReal), &DirEntry);
1995 }
1996
1997 case FsObjType_File:
1998 /* The file name is already part of the actual list's source root (strSrc). */
1999 break;
2000
2001 default:
2002 LogRel2(("Guest Control: Warning: Unknown guest host system type %#x for source \"%s\", skipping\n",
2003 itSrc->enmType, strSrc.c_str()));
2004 break;
2005 }
2006 }
2007
2008 if (RT_FAILURE(vrc))
2009 {
2010 delete pFsList;
2011 strErrorInfo.printf(tr("Error adding host source '%s' to list: %Rrc"),
2012 strSrc.c_str(), vrc);
2013 break;
2014 }
2015#ifdef DEBUG
2016 pFsList->DumpToLog();
2017#endif
2018 mVecLists.push_back(pFsList);
2019 }
2020 catch (std::bad_alloc &)
2021 {
2022 vrc = VERR_NO_MEMORY;
2023 break;
2024 }
2025
2026 AssertPtr(pFsList);
2027 cOperations += (ULONG)pFsList->mVecEntries.size();
2028
2029 itSrc++;
2030 }
2031 }
2032
2033 if (cOperations) /* Use the first element as description (if available). */
2034 {
2035 Assert(mVecLists.size());
2036 Assert(mVecLists[0]->mVecEntries.size());
2037
2038 Utf8Str const &strFirstOp = mVecLists[0]->mVecEntries[0]->strPath;
2039
2040 /* Now that we know how many objects we're handling, tweak the progress description so that it
2041 * reflects more accurately what the progress is actually doing. */
2042 if (cOperations > 1)
2043 {
2044 mDesc.printf(tr("Copying \"%s\" [and %zu %s] from host to \"%s\" on the guest ..."),
2045 strFirstOp.c_str(), cOperations - 1, cOperations > 2 ? tr("others") : tr("other"), mDest.c_str());
2046 }
2047 else
2048 mDesc.printf(tr("Copying \"%s\" from host to \"%s\" on the guest ..."), strFirstOp.c_str(), mDest.c_str());
2049
2050 hrc = pProgress->init(static_cast<IGuestSession*>(mSession), Bstr(mDesc).raw(),
2051 TRUE /* aCancelable */, cOperations + 1 /* Number of operations */,
2052 Bstr(strFirstOp).raw());
2053 }
2054 else /* If no operations have been defined, go with an "empty" progress object when will be used for error handling. */
2055 hrc = pProgress->init(static_cast<IGuestSession*>(mSession), Bstr(mDesc).raw(),
2056 TRUE /* aCancelable */, 1 /* cOperations */, Bstr(mDesc).raw());
2057
2058 if (RT_FAILURE(vrc))
2059 {
2060 if (strErrorInfo.isEmpty())
2061 strErrorInfo.printf(tr("Failed with %Rrc"), vrc);
2062 setProgressErrorMsg(VBOX_E_IPRT_ERROR, strErrorInfo);
2063 }
2064
2065 LogFlowFunc(("Returning %Rhrc (%Rrc)\n", hrc, vrc));
2066 return hrc;
2067}
2068
2069/** @copydoc GuestSessionTask::Run */
2070int GuestSessionTaskCopyTo::Run(void)
2071{
2072 LogFlowThisFuncEnter();
2073
2074 AutoCaller autoCaller(mSession);
2075 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2076
2077 int vrc = VINF_SUCCESS;
2078
2079 FsLists::const_iterator itList = mVecLists.begin();
2080 while (itList != mVecLists.end())
2081 {
2082 FsList *pList = *itList;
2083 AssertPtr(pList);
2084
2085 LogFlowFunc(("List: srcRootAbs=%s, dstRootAbs=%s\n", pList->mSrcRootAbs.c_str(), pList->mDstRootAbs.c_str()));
2086
2087 Utf8Str strSrcRootAbs = pList->mSrcRootAbs;
2088 Utf8Str strDstRootAbs = pList->mDstRootAbs;
2089
2090 /* Translate the destination path to a path compatible with the guest.
2091 * Note: This needs to be done *before* GuestPath::BuildDestinationPath() below! */
2092 vrc = GuestPath::Translate(strDstRootAbs, mSession->i_getGuestPathStyle() /* Source */,
2093 mSession->i_getGuestPathStyle() /* Dest */);
2094
2095 GuestPath::BuildDestinationPath(strSrcRootAbs, PATH_STYLE_NATIVE,
2096 strDstRootAbs, mSession->i_getGuestPathStyle());
2097
2098
2099 if (RT_FAILURE(vrc))
2100 {
2101 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2102 Utf8StrFmt(tr("Translating guest destination path \"%s\" failed: %Rrc"),
2103 strDstRootAbs.c_str(), vrc));
2104 break;
2105 }
2106
2107 bool fCopyIntoExisting;
2108 bool fFollowSymlinks;
2109
2110 if (pList->mSourceSpec.enmType == FsObjType_Directory)
2111 {
2112 fCopyIntoExisting = RT_BOOL(pList->mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_CopyIntoExisting);
2113 fFollowSymlinks = RT_BOOL(pList->mSourceSpec.fDirCopyFlags & DirectoryCopyFlag_FollowLinks);
2114 }
2115 else if (pList->mSourceSpec.enmType == FsObjType_File)
2116 {
2117 fCopyIntoExisting = !RT_BOOL(pList->mSourceSpec.fFileCopyFlags & FileCopyFlag_NoReplace);
2118 fFollowSymlinks = RT_BOOL(pList->mSourceSpec.fFileCopyFlags & FileCopyFlag_FollowLinks);
2119 }
2120 else
2121 AssertFailedBreakStmt(vrc = VERR_NOT_IMPLEMENTED);
2122
2123 uint32_t const fDirMode = 0700; /** @todo Play safe by default; implement ACLs. */
2124
2125 bool fDstExists = true;
2126
2127 GuestFsObjData dstObjData;
2128 int vrcGuest;
2129 vrc = mSession->i_fsQueryInfo(strDstRootAbs, fFollowSymlinks, dstObjData, &vrcGuest);
2130 if (RT_FAILURE(vrc))
2131 {
2132 if (vrc == VERR_GSTCTL_GUEST_ERROR)
2133 {
2134 switch (vrcGuest)
2135 {
2136 case VERR_PATH_NOT_FOUND:
2137 RT_FALL_THROUGH();
2138 case VERR_FILE_NOT_FOUND:
2139 {
2140 fDstExists = false;
2141 vrc = VINF_SUCCESS;
2142 break;
2143 }
2144 default:
2145 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2146 Utf8StrFmt(tr("Querying information on guest for '%s' failed: %Rrc"),
2147 strDstRootAbs.c_str(), vrcGuest));
2148 break;
2149 }
2150 }
2151 else
2152 {
2153 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2154 Utf8StrFmt(tr("Querying information on guest for '%s' failed: %Rrc"),
2155 strDstRootAbs.c_str(), vrc));
2156 break;
2157 }
2158 }
2159
2160 if (pList->mSourceSpec.enmType == FsObjType_Directory)
2161 {
2162 LogFlowFunc(("Directory: fDirCopyFlags=%#x, fCopyIntoExisting=%RTbool, fFollowSymlinks=%RTbool -> fDstExist=%RTbool (%s)\n",
2163 pList->mSourceSpec.fDirCopyFlags, fCopyIntoExisting, fFollowSymlinks,
2164 fDstExists, GuestBase::fsObjTypeToStr(dstObjData.mType)));
2165
2166 if (fDstExists)
2167 {
2168 switch (dstObjData.mType)
2169 {
2170 case FsObjType_Directory:
2171 {
2172 if (!fCopyIntoExisting)
2173 {
2174 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2175 Utf8StrFmt(tr("Guest root directory \"%s\" already exists"),
2176 strDstRootAbs.c_str()));
2177 vrc = VERR_ALREADY_EXISTS;
2178 }
2179 break;
2180 }
2181
2182 case FsObjType_File:
2183 {
2184 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2185 Utf8StrFmt(tr("Destination \"%s\" on guest already exists and is a file"),
2186 strDstRootAbs.c_str()));
2187 vrc = VERR_IS_A_FILE;
2188 }
2189
2190 case FsObjType_Symlink:
2191 /** @todo Resolve symlinks? */
2192 break;
2193
2194 default:
2195 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2196 Utf8StrFmt(tr("Unknown object type (%#x) on guest for \"%s\""),
2197 dstObjData.mType, strDstRootAbs.c_str()));
2198 vrc = VERR_NOT_SUPPORTED;
2199 break;
2200 }
2201 }
2202
2203 if (RT_FAILURE(vrc))
2204 break;
2205
2206 /* Clean up the final guest destination root path (for cleaning up mixed path separators). */
2207 vrc = GuestPath::Translate(strDstRootAbs,
2208 mSession->i_getGuestPathStyle() /* Source */, mSession->i_getGuestPathStyle() /* Dest */);
2209 if (RT_FAILURE(vrc))
2210 {
2211 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2212 Utf8StrFmt(tr("Translating guest destination root path \"%s\" failed: %Rrc"),
2213 strDstRootAbs.c_str(), vrc));
2214 break;
2215 }
2216
2217 /* Make sure the destination root directory exists. */
2218 if (pList->mSourceSpec.fDryRun == false)
2219 {
2220 vrc = directoryCreateOnGuest(strDstRootAbs, fDirMode, DirectoryCreateFlag_None,
2221 fFollowSymlinks, fCopyIntoExisting);
2222 if (RT_FAILURE(vrc))
2223 break;
2224 }
2225
2226 /* Walk the entries. */
2227 FsEntries::const_iterator itEntry = pList->mVecEntries.begin();
2228 while ( RT_SUCCESS(vrc)
2229 && itEntry != pList->mVecEntries.end())
2230 {
2231 FsEntry *pEntry = *itEntry;
2232 AssertPtr(pEntry);
2233
2234 Utf8Str strSrcAbs = strSrcRootAbs;
2235 Utf8Str strDstAbs = strDstRootAbs;
2236
2237 strSrcAbs += PATH_STYLE_SEP_STR(PATH_STYLE_NATIVE);
2238 strSrcAbs += pEntry->strPath;
2239
2240 strDstAbs += PATH_STYLE_SEP_STR(mSession->i_getGuestPathStyle());
2241 strDstAbs += pEntry->strPath;
2242
2243 /* Clean up the final host source path (for cleaning up mixed path separators). */
2244 vrc = GuestPath::Translate(strSrcAbs, PATH_STYLE_NATIVE /* Source */, PATH_STYLE_NATIVE /* Dest */);
2245 if (RT_FAILURE(vrc))
2246 {
2247 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2248 Utf8StrFmt(tr("Translating host source path\"%s\" failed: %Rrc"),
2249 strSrcAbs.c_str(), vrc));
2250 break;
2251 }
2252
2253 /* Translate the final guest destination path. */
2254 vrc = GuestPath::Translate(strDstAbs,
2255 mSession->i_getGuestPathStyle() /* Source */, mSession->i_getGuestPathStyle() /* Dest */);
2256 if (RT_FAILURE(vrc))
2257 {
2258 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2259 Utf8StrFmt(tr("Translating guest destination path \"%s\" failed: %Rrc"),
2260 strDstAbs.c_str(), vrc));
2261 break;
2262 }
2263
2264 mProgress->SetNextOperation(Bstr(strSrcAbs).raw(), 1);
2265
2266 switch (pEntry->fMode & RTFS_TYPE_MASK)
2267 {
2268 case RTFS_TYPE_DIRECTORY:
2269 {
2270 LogRel2(("Guest Control: Copying directory '%s' from host to '%s' on guest ...\n", strSrcAbs.c_str(), strDstAbs.c_str()));
2271 if (!pList->mSourceSpec.fDryRun)
2272 vrc = directoryCreateOnGuest(strDstAbs, fDirMode, DirectoryCreateFlag_None,
2273 fFollowSymlinks, fCopyIntoExisting);
2274 break;
2275 }
2276
2277 case RTFS_TYPE_FILE:
2278 {
2279 if (!pList->mSourceSpec.fDryRun)
2280 vrc = fileCopyToGuest(strSrcAbs, strDstAbs, pList->mSourceSpec.fFileCopyFlags);
2281 break;
2282 }
2283
2284 default:
2285 LogRel2(("Guest Control: Warning: Host file system type 0x%x for '%s' is not supported, skipping\n",
2286 pEntry->fMode & RTFS_TYPE_MASK, strSrcAbs.c_str()));
2287 break;
2288 }
2289
2290 if (RT_FAILURE(vrc))
2291 break;
2292
2293 ++itEntry;
2294 }
2295 }
2296 else if (pList->mSourceSpec.enmType == FsObjType_File)
2297 {
2298 LogFlowFunc(("File: fFileCopyFlags=%#x, fCopyIntoExisting=%RTbool, fFollowSymlinks=%RTbool -> fDstExist=%RTbool (%s)\n",
2299 pList->mSourceSpec.fFileCopyFlags, fCopyIntoExisting, fFollowSymlinks,
2300 fDstExists, GuestBase::fsObjTypeToStr(dstObjData.mType)));
2301
2302 if (fDstExists)
2303 {
2304 switch (dstObjData.mType)
2305 {
2306 case FsObjType_Directory:
2307 {
2308 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2309 Utf8StrFmt(tr("Destination \"%s\" on the guest already exists and is a directory"),
2310 strDstRootAbs.c_str()));
2311 vrc = VERR_IS_A_DIRECTORY;
2312 break;
2313 }
2314
2315 case FsObjType_File:
2316 {
2317 if (!fCopyIntoExisting)
2318 {
2319 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2320 Utf8StrFmt(tr("Guest file \"%s\" already exists"), strDstRootAbs.c_str()));
2321 vrc = VERR_ALREADY_EXISTS;
2322 }
2323 break;
2324 }
2325
2326 default:
2327 {
2328 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2329 Utf8StrFmt(tr("Unsupported guest file system type (%#x) for \"%s\""),
2330 dstObjData.mType, strDstRootAbs.c_str()));
2331 vrc = VERR_NOT_SUPPORTED;
2332 break;
2333 }
2334 }
2335 }
2336
2337 /* Cleanup the destination path. */
2338 vrc = GuestPath::Translate(strDstRootAbs,
2339 mSession->i_getGuestPathStyle() /* Source */, mSession->i_getGuestPathStyle() /* Dest */);
2340 if (RT_FAILURE(vrc))
2341 {
2342 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2343 Utf8StrFmt(tr("Translating guest destination path \"%s\" failed: %Rrc"),
2344 strDstRootAbs.c_str(), vrc));
2345 break;
2346 }
2347
2348 if ( RT_SUCCESS(vrc)
2349 && !pList->mSourceSpec.fDryRun)
2350 vrc = fileCopyToGuest(strSrcRootAbs, strDstRootAbs, pList->mSourceSpec.fFileCopyFlags);
2351 }
2352 else
2353 AssertFailedStmt(vrc = VERR_NOT_SUPPORTED);
2354
2355 if (RT_FAILURE(vrc))
2356 break;
2357
2358 ++itList;
2359 }
2360
2361 if (RT_SUCCESS(vrc))
2362 vrc = setProgressSuccess();
2363
2364 LogFlowFuncLeaveRC(vrc);
2365 return vrc;
2366}
2367
2368GuestSessionTaskUpdateAdditions::GuestSessionTaskUpdateAdditions(GuestSession *pSession,
2369 const Utf8Str &strSource,
2370 const ProcessArguments &aArguments,
2371 uint32_t fFlags)
2372 : GuestSessionTask(pSession)
2373{
2374 m_strTaskName = "gctlUpGA";
2375
2376 mSource = strSource;
2377 mArguments = aArguments;
2378 mFlags = fFlags;
2379}
2380
2381GuestSessionTaskUpdateAdditions::~GuestSessionTaskUpdateAdditions(void)
2382{
2383
2384}
2385
2386/**
2387 * Adds arguments to existing process arguments.
2388 * Identical / already existing arguments will be filtered out.
2389 *
2390 * @returns VBox status code.
2391 * @param aArgumentsDest Destination to add arguments to.
2392 * @param aArgumentsSource Arguments to add.
2393 */
2394int GuestSessionTaskUpdateAdditions::addProcessArguments(ProcessArguments &aArgumentsDest, const ProcessArguments &aArgumentsSource)
2395{
2396 try
2397 {
2398 /* Filter out arguments which already are in the destination to
2399 * not end up having them specified twice. Not the fastest method on the
2400 * planet but does the job. */
2401 ProcessArguments::const_iterator itSource = aArgumentsSource.begin();
2402 while (itSource != aArgumentsSource.end())
2403 {
2404 bool fFound = false;
2405 ProcessArguments::iterator itDest = aArgumentsDest.begin();
2406 while (itDest != aArgumentsDest.end())
2407 {
2408 if ((*itDest).equalsIgnoreCase((*itSource)))
2409 {
2410 fFound = true;
2411 break;
2412 }
2413 ++itDest;
2414 }
2415
2416 if (!fFound)
2417 aArgumentsDest.push_back((*itSource));
2418
2419 ++itSource;
2420 }
2421 }
2422 catch(std::bad_alloc &)
2423 {
2424 return VERR_NO_MEMORY;
2425 }
2426
2427 return VINF_SUCCESS;
2428}
2429
2430/**
2431 * Helper function to copy a file from a VISO to the guest.
2432 *
2433 * @returns VBox status code.
2434 * @param pSession Guest session to use.
2435 * @param hVfsIso VISO handle to use.
2436 * @param strFileSrc Source file path on VISO to copy.
2437 * @param strFileDst Destination file path on guest.
2438 * @param fOptional When set to \c true, the file is optional, i.e. can be skipped
2439 * when not found, \c false if not.
2440 */
2441int GuestSessionTaskUpdateAdditions::copyFileToGuest(GuestSession *pSession, RTVFS hVfsIso,
2442 Utf8Str const &strFileSrc, const Utf8Str &strFileDst, bool fOptional)
2443{
2444 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
2445 AssertReturn(hVfsIso != NIL_RTVFS, VERR_INVALID_POINTER);
2446
2447 RTVFSFILE hVfsFile = NIL_RTVFSFILE;
2448 int vrc = RTVfsFileOpen(hVfsIso, strFileSrc.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE, &hVfsFile);
2449 if (RT_SUCCESS(vrc))
2450 {
2451 uint64_t cbSrcSize = 0;
2452 vrc = RTVfsFileQuerySize(hVfsFile, &cbSrcSize);
2453 if (RT_SUCCESS(vrc))
2454 {
2455 LogRel(("Copying Guest Additions installer file \"%s\" to \"%s\" on guest ...\n",
2456 strFileSrc.c_str(), strFileDst.c_str()));
2457
2458 GuestFileOpenInfo dstOpenInfo;
2459 dstOpenInfo.mFilename = strFileDst;
2460 dstOpenInfo.mOpenAction = FileOpenAction_CreateOrReplace;
2461 dstOpenInfo.mAccessMode = FileAccessMode_WriteOnly;
2462 dstOpenInfo.mSharingMode = FileSharingMode_All; /** @todo Use _Read when implemented. */
2463
2464 ComObjPtr<GuestFile> dstFile;
2465 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
2466 vrc = mSession->i_fileOpen(dstOpenInfo, dstFile, &vrcGuest);
2467 if (RT_FAILURE(vrc))
2468 {
2469 switch (vrc)
2470 {
2471 case VERR_GSTCTL_GUEST_ERROR:
2472 setProgressErrorMsg(VBOX_E_IPRT_ERROR, GuestFile::i_guestErrorToString(vrcGuest, strFileDst.c_str()));
2473 break;
2474
2475 default:
2476 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2477 Utf8StrFmt(tr("Guest file \"%s\" could not be opened: %Rrc"),
2478 strFileDst.c_str(), vrc));
2479 break;
2480 }
2481 }
2482 else
2483 {
2484 vrc = fileCopyToGuestInner(strFileSrc, hVfsFile, strFileDst, dstFile, FileCopyFlag_None, 0 /*offCopy*/, cbSrcSize);
2485
2486 int vrc2 = dstFile->i_closeFile(&vrcGuest);
2487 AssertRC(vrc2);
2488 }
2489 }
2490
2491 RTVfsFileRelease(hVfsFile);
2492 }
2493 else if (fOptional)
2494 vrc = VINF_SUCCESS;
2495
2496 return vrc;
2497}
2498
2499/**
2500 * Helper function to run (start) a file on the guest.
2501 *
2502 * @returns VBox status code.
2503 * @param pSession Guest session to use.
2504 * @param procInfo Guest process startup info to use.
2505 */
2506int GuestSessionTaskUpdateAdditions::runFileOnGuest(GuestSession *pSession, GuestProcessStartupInfo &procInfo)
2507{
2508 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
2509
2510 LogRel(("Running %s ...\n", procInfo.mName.c_str()));
2511
2512 GuestProcessTool procTool;
2513 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
2514 int vrc = procTool.init(pSession, procInfo, false /* Async */, &vrcGuest);
2515 if (RT_SUCCESS(vrc))
2516 {
2517 if (RT_SUCCESS(vrcGuest))
2518 vrc = procTool.wait(GUESTPROCESSTOOL_WAIT_FLAG_NONE, &vrcGuest);
2519 if (RT_SUCCESS(vrc))
2520 vrc = procTool.getTerminationStatus();
2521 }
2522
2523 if (RT_FAILURE(vrc))
2524 {
2525 switch (vrc)
2526 {
2527 case VERR_GSTCTL_PROCESS_EXIT_CODE:
2528 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2529 Utf8StrFmt(tr("Running update file \"%s\" on guest failed: %Rrc"),
2530 procInfo.mExecutable.c_str(), procTool.getRc()));
2531 break;
2532
2533 case VERR_GSTCTL_GUEST_ERROR:
2534 setProgressErrorMsg(VBOX_E_IPRT_ERROR, tr("Running update file on guest failed"),
2535 GuestErrorInfo(GuestErrorInfo::Type_Process, vrcGuest, procInfo.mExecutable.c_str()));
2536 break;
2537
2538 case VERR_INVALID_STATE: /** @todo Special guest control rc needed! */
2539 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2540 Utf8StrFmt(tr("Update file \"%s\" reported invalid running state"),
2541 procInfo.mExecutable.c_str()));
2542 break;
2543
2544 default:
2545 setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2546 Utf8StrFmt(tr("Error while running update file \"%s\" on guest: %Rrc"),
2547 procInfo.mExecutable.c_str(), vrc));
2548 break;
2549 }
2550 }
2551
2552 return vrc;
2553}
2554
2555/** @copydoc GuestSessionTask::Run */
2556int GuestSessionTaskUpdateAdditions::Run(void)
2557{
2558 LogFlowThisFuncEnter();
2559
2560 ComObjPtr<GuestSession> pSession = mSession;
2561 Assert(!pSession.isNull());
2562
2563 AutoCaller autoCaller(pSession);
2564 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2565
2566 int vrc = setProgress(10);
2567 if (RT_FAILURE(vrc))
2568 return vrc;
2569
2570 HRESULT hrc = S_OK;
2571
2572 LogRel(("Automatic update of Guest Additions started, using \"%s\"\n", mSource.c_str()));
2573
2574 ComObjPtr<Guest> pGuest(mSession->i_getParent());
2575#if 0
2576 /*
2577 * Wait for the guest being ready within 30 seconds.
2578 */
2579 AdditionsRunLevelType_T addsRunLevel;
2580 uint64_t tsStart = RTTimeSystemMilliTS();
2581 while ( SUCCEEDED(hrc = pGuest->COMGETTER(AdditionsRunLevel)(&addsRunLevel))
2582 && ( addsRunLevel != AdditionsRunLevelType_Userland
2583 && addsRunLevel != AdditionsRunLevelType_Desktop))
2584 {
2585 if ((RTTimeSystemMilliTS() - tsStart) > 30 * 1000)
2586 {
2587 vrc = VERR_TIMEOUT;
2588 break;
2589 }
2590
2591 RTThreadSleep(100); /* Wait a bit. */
2592 }
2593
2594 if (FAILED(hrc)) vrc = VERR_TIMEOUT;
2595 if (vrc == VERR_TIMEOUT)
2596 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2597 Utf8StrFmt(tr("Guest Additions were not ready within time, giving up")));
2598#else
2599 /*
2600 * For use with the GUI we don't want to wait, just return so that the manual .ISO mounting
2601 * can continue.
2602 */
2603 AdditionsRunLevelType_T addsRunLevel;
2604 if ( FAILED(hrc = pGuest->COMGETTER(AdditionsRunLevel)(&addsRunLevel))
2605 || ( addsRunLevel != AdditionsRunLevelType_Userland
2606 && addsRunLevel != AdditionsRunLevelType_Desktop))
2607 {
2608 if (addsRunLevel == AdditionsRunLevelType_System)
2609 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2610 Utf8StrFmt(tr("Guest Additions are installed but not fully loaded yet, aborting automatic update")));
2611 else
2612 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2613 Utf8StrFmt(tr("Guest Additions not installed or ready, aborting automatic update")));
2614 vrc = VERR_NOT_SUPPORTED;
2615 }
2616#endif
2617
2618 if (RT_SUCCESS(vrc))
2619 {
2620 /*
2621 * Determine if we are able to update automatically. This only works
2622 * if there are recent Guest Additions installed already.
2623 */
2624 Utf8Str strAddsVer;
2625 vrc = getGuestProperty(pGuest, "/VirtualBox/GuestAdd/Version", strAddsVer);
2626 if ( RT_SUCCESS(vrc)
2627 && RTStrVersionCompare(strAddsVer.c_str(), "4.1") < 0)
2628 {
2629 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2630 Utf8StrFmt(tr("Guest has too old Guest Additions (%s) installed for automatic updating, please update manually"),
2631 strAddsVer.c_str()));
2632 vrc = VERR_NOT_SUPPORTED;
2633 }
2634 }
2635
2636 Utf8Str strOSVer;
2637 eOSType osType = eOSType_Unknown;
2638 if (RT_SUCCESS(vrc))
2639 {
2640 /*
2641 * Determine guest OS type and the required installer image.
2642 */
2643 Utf8Str strOSType;
2644 vrc = getGuestProperty(pGuest, "/VirtualBox/GuestInfo/OS/Product", strOSType);
2645 if (RT_SUCCESS(vrc))
2646 {
2647 if ( strOSType.contains("Microsoft", Utf8Str::CaseInsensitive)
2648 || strOSType.contains("Windows", Utf8Str::CaseInsensitive))
2649 {
2650 osType = eOSType_Windows;
2651
2652 /*
2653 * Determine guest OS version.
2654 */
2655 vrc = getGuestProperty(pGuest, "/VirtualBox/GuestInfo/OS/Release", strOSVer);
2656 if (RT_FAILURE(vrc))
2657 {
2658 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2659 Utf8StrFmt(tr("Unable to detected guest OS version, please update manually")));
2660 vrc = VERR_NOT_SUPPORTED;
2661 }
2662
2663 /* Because Windows 2000 + XP and is bitching with WHQL popups even if we have signed drivers we
2664 * can't do automated updates here. */
2665 /* Windows XP 64-bit (5.2) is a Windows 2003 Server actually, so skip this here. */
2666 if ( RT_SUCCESS(vrc)
2667 && RTStrVersionCompare(strOSVer.c_str(), "5.0") >= 0)
2668 {
2669 if ( strOSVer.startsWith("5.0") /* Exclude the build number. */
2670 || strOSVer.startsWith("5.1") /* Exclude the build number. */)
2671 {
2672 /* If we don't have AdditionsUpdateFlag_WaitForUpdateStartOnly set we can't continue
2673 * because the Windows Guest Additions installer will fail because of WHQL popups. If the
2674 * flag is set this update routine ends successfully as soon as the installer was started
2675 * (and the user has to deal with it in the guest). */
2676 if (!(mFlags & AdditionsUpdateFlag_WaitForUpdateStartOnly))
2677 {
2678 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2679 Utf8StrFmt(tr("Windows 2000 and XP are not supported for automatic updating due to WHQL interaction, please update manually")));
2680 vrc = VERR_NOT_SUPPORTED;
2681 }
2682 }
2683 }
2684 else
2685 {
2686 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2687 Utf8StrFmt(tr("%s (%s) not supported for automatic updating, please update manually"),
2688 strOSType.c_str(), strOSVer.c_str()));
2689 vrc = VERR_NOT_SUPPORTED;
2690 }
2691 }
2692 else if (strOSType.contains("Solaris", Utf8Str::CaseInsensitive))
2693 {
2694 osType = eOSType_Solaris;
2695 }
2696 else /* Everything else hopefully means Linux :-). */
2697 osType = eOSType_Linux;
2698
2699 if ( RT_SUCCESS(vrc)
2700 && ( osType != eOSType_Windows
2701 && osType != eOSType_Linux))
2702 /** @todo Support Solaris. */
2703 {
2704 hrc = setProgressErrorMsg(VBOX_E_NOT_SUPPORTED,
2705 Utf8StrFmt(tr("Detected guest OS (%s) does not support automatic Guest Additions updating, please update manually"),
2706 strOSType.c_str()));
2707 vrc = VERR_NOT_SUPPORTED;
2708 }
2709 }
2710 }
2711
2712 if (RT_SUCCESS(vrc))
2713 {
2714 /*
2715 * Try to open the .ISO file to extract all needed files.
2716 */
2717 RTVFSFILE hVfsFileIso;
2718 vrc = RTVfsFileOpenNormal(mSource.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE, &hVfsFileIso);
2719 if (RT_FAILURE(vrc))
2720 {
2721 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2722 Utf8StrFmt(tr("Unable to open Guest Additions .ISO file \"%s\": %Rrc"),
2723 mSource.c_str(), vrc));
2724 }
2725 else
2726 {
2727 RTVFS hVfsIso;
2728 vrc = RTFsIso9660VolOpen(hVfsFileIso, 0 /*fFlags*/, &hVfsIso, NULL);
2729 if (RT_FAILURE(vrc))
2730 {
2731 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2732 Utf8StrFmt(tr("Unable to open file as ISO 9660 file system volume: %Rrc"), vrc));
2733 }
2734 else
2735 {
2736 Utf8Str strUpdateDir;
2737
2738 vrc = setProgress(5);
2739 if (RT_SUCCESS(vrc))
2740 {
2741 /* Try getting the installed Guest Additions version to know whether we
2742 * can install our temporary Guest Addition data into the original installation
2743 * directory.
2744 *
2745 * Because versions prior to 4.2 had bugs wrt spaces in paths we have to choose
2746 * a different location then.
2747 */
2748 bool fUseInstallDir = false;
2749
2750 Utf8Str strAddsVer;
2751 vrc = getGuestProperty(pGuest, "/VirtualBox/GuestAdd/Version", strAddsVer);
2752 if ( RT_SUCCESS(vrc)
2753 && RTStrVersionCompare(strAddsVer.c_str(), "4.2r80329") > 0)
2754 {
2755 fUseInstallDir = true;
2756 }
2757
2758 if (fUseInstallDir)
2759 {
2760 vrc = getGuestProperty(pGuest, "/VirtualBox/GuestAdd/InstallDir", strUpdateDir);
2761 if (RT_SUCCESS(vrc))
2762 {
2763 if (strUpdateDir.isNotEmpty())
2764 {
2765 if (osType == eOSType_Windows)
2766 {
2767 strUpdateDir.findReplace('/', '\\');
2768 strUpdateDir.append("\\Update\\");
2769 }
2770 else
2771 strUpdateDir.append("/update/");
2772 }
2773 /* else Older Guest Additions might not handle this property correctly. */
2774 }
2775 /* Ditto. */
2776 }
2777
2778 /** @todo Set fallback installation directory. Make this a *lot* smarter. Later. */
2779 if (strUpdateDir.isEmpty())
2780 {
2781 if (osType == eOSType_Windows)
2782 strUpdateDir = "C:\\Temp\\";
2783 else
2784 strUpdateDir = "/tmp/";
2785 }
2786 }
2787
2788 /* Create the installation directory. */
2789 int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
2790 if (RT_SUCCESS(vrc))
2791 {
2792 LogRel(("Guest Additions update directory is: %s\n", strUpdateDir.c_str()));
2793
2794 vrc = pSession->i_directoryCreate(strUpdateDir, 755 /* Mode */, DirectoryCreateFlag_Parents, &vrcGuest);
2795 if (RT_FAILURE(vrc))
2796 {
2797 switch (vrc)
2798 {
2799 case VERR_GSTCTL_GUEST_ERROR:
2800 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR, tr("Creating installation directory on guest failed"),
2801 GuestErrorInfo(GuestErrorInfo::Type_Directory, vrcGuest, strUpdateDir.c_str()));
2802 break;
2803
2804 default:
2805 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2806 Utf8StrFmt(tr("Creating installation directory \"%s\" on guest failed: %Rrc"),
2807 strUpdateDir.c_str(), vrc));
2808 break;
2809 }
2810 }
2811 }
2812
2813 if (RT_SUCCESS(vrc))
2814 vrc = setProgress(10);
2815
2816 if (RT_SUCCESS(vrc))
2817 {
2818 /* Prepare the file(s) we want to copy over to the guest and
2819 * (maybe) want to run. */
2820 switch (osType)
2821 {
2822 case eOSType_Windows:
2823 {
2824 /* Do we need to install our certificates? We do this for W2K and up. */
2825 bool fInstallCert = false;
2826
2827 /* Only Windows 2000 and up need certificates to be installed. */
2828 if (RTStrVersionCompare(strOSVer.c_str(), "5.0") >= 0)
2829 {
2830 fInstallCert = true;
2831 LogRel(("Certificates for auto updating WHQL drivers will be installed\n"));
2832 }
2833 else
2834 LogRel(("Skipping installation of certificates for WHQL drivers\n"));
2835
2836 if (fInstallCert)
2837 {
2838 static struct { const char *pszDst, *pszIso; } const s_aCertFiles[] =
2839 {
2840 { "vbox.cer", "/CERT/VBOX.CER" },
2841 { "vbox-sha1.cer", "/CERT/VBOX-SHA1.CER" },
2842 { "vbox-sha256.cer", "/CERT/VBOX-SHA256.CER" },
2843 { "vbox-sha256-r3.cer", "/CERT/VBOX-SHA256-R3.CER" },
2844 { "oracle-vbox.cer", "/CERT/ORACLE-VBOX.CER" },
2845 };
2846 uint32_t fCopyCertUtil = ISOFILE_FLAG_COPY_FROM_ISO;
2847 for (uint32_t i = 0; i < RT_ELEMENTS(s_aCertFiles); i++)
2848 {
2849 /* Skip if not present on the ISO. */
2850 RTFSOBJINFO ObjInfo;
2851 vrc = RTVfsQueryPathInfo(hVfsIso, s_aCertFiles[i].pszIso, &ObjInfo, RTFSOBJATTRADD_NOTHING,
2852 RTPATH_F_ON_LINK);
2853 if (RT_FAILURE(vrc))
2854 continue;
2855
2856 /* Copy the certificate certificate. */
2857 Utf8Str const strDstCert(strUpdateDir + s_aCertFiles[i].pszDst);
2858 mFiles.push_back(ISOFile(s_aCertFiles[i].pszIso,
2859 strDstCert,
2860 ISOFILE_FLAG_COPY_FROM_ISO | ISOFILE_FLAG_OPTIONAL));
2861
2862 /* Out certificate installation utility. */
2863 /* First pass: Copy over the file (first time only) + execute it to remove any
2864 * existing VBox certificates. */
2865 GuestProcessStartupInfo siCertUtilRem;
2866 siCertUtilRem.mName = "VirtualBox Certificate Utility, removing old VirtualBox certificates";
2867 /* The argv[0] should contain full path to the executable module */
2868 siCertUtilRem.mArguments.push_back(strUpdateDir + "VBoxCertUtil.exe");
2869 siCertUtilRem.mArguments.push_back(Utf8Str("remove-trusted-publisher"));
2870 siCertUtilRem.mArguments.push_back(Utf8Str("--root")); /* Add root certificate as well. */
2871 siCertUtilRem.mArguments.push_back(strDstCert);
2872 siCertUtilRem.mArguments.push_back(strDstCert);
2873 mFiles.push_back(ISOFile("CERT/VBOXCERTUTIL.EXE",
2874 strUpdateDir + "VBoxCertUtil.exe",
2875 fCopyCertUtil | ISOFILE_FLAG_EXECUTE | ISOFILE_FLAG_OPTIONAL,
2876 siCertUtilRem));
2877 fCopyCertUtil = 0;
2878 /* Second pass: Only execute (but don't copy) again, this time installng the
2879 * recent certificates just copied over. */
2880 GuestProcessStartupInfo siCertUtilAdd;
2881 siCertUtilAdd.mName = "VirtualBox Certificate Utility, installing VirtualBox certificates";
2882 /* The argv[0] should contain full path to the executable module */
2883 siCertUtilAdd.mArguments.push_back(strUpdateDir + "VBoxCertUtil.exe");
2884 siCertUtilAdd.mArguments.push_back(Utf8Str("add-trusted-publisher"));
2885 siCertUtilAdd.mArguments.push_back(Utf8Str("--root")); /* Add root certificate as well. */
2886 siCertUtilAdd.mArguments.push_back(strDstCert);
2887 siCertUtilAdd.mArguments.push_back(strDstCert);
2888 mFiles.push_back(ISOFile("CERT/VBOXCERTUTIL.EXE",
2889 strUpdateDir + "VBoxCertUtil.exe",
2890 ISOFILE_FLAG_EXECUTE | ISOFILE_FLAG_OPTIONAL,
2891 siCertUtilAdd));
2892 }
2893 }
2894 /* The installers in different flavors, as we don't know (and can't assume)
2895 * the guest's bitness. */
2896 mFiles.push_back(ISOFile("VBOXWINDOWSADDITIONS-X86.EXE",
2897 strUpdateDir + "VBoxWindowsAdditions-x86.exe",
2898 ISOFILE_FLAG_COPY_FROM_ISO));
2899 mFiles.push_back(ISOFile("VBOXWINDOWSADDITIONS-AMD64.EXE",
2900 strUpdateDir + "VBoxWindowsAdditions-amd64.exe",
2901 ISOFILE_FLAG_COPY_FROM_ISO));
2902 /* The stub loader which decides which flavor to run. */
2903 GuestProcessStartupInfo siInstaller;
2904 siInstaller.mName = "VirtualBox Windows Guest Additions Installer";
2905 /* Set a running timeout of 5 minutes -- the Windows Guest Additions
2906 * setup can take quite a while, so be on the safe side. */
2907 siInstaller.mTimeoutMS = 5 * 60 * 1000;
2908
2909 /* The argv[0] should contain full path to the executable module */
2910 siInstaller.mArguments.push_back(strUpdateDir + "VBoxWindowsAdditions.exe");
2911 siInstaller.mArguments.push_back(Utf8Str("/S")); /* We want to install in silent mode. */
2912 siInstaller.mArguments.push_back(Utf8Str("/l")); /* ... and logging enabled. */
2913 /* Don't quit VBoxService during upgrade because it still is used for this
2914 * piece of code we're in right now (that is, here!) ... */
2915 siInstaller.mArguments.push_back(Utf8Str("/no_vboxservice_exit"));
2916 /* Tell the installer to report its current installation status
2917 * using a running VBoxTray instance via balloon messages in the
2918 * Windows taskbar. */
2919 siInstaller.mArguments.push_back(Utf8Str("/post_installstatus"));
2920 /* Add optional installer command line arguments from the API to the
2921 * installer's startup info. */
2922 vrc = addProcessArguments(siInstaller.mArguments, mArguments);
2923 AssertRC(vrc);
2924 /* If the caller does not want to wait for out guest update process to end,
2925 * complete the progress object now so that the caller can do other work. */
2926 if (mFlags & AdditionsUpdateFlag_WaitForUpdateStartOnly)
2927 siInstaller.mFlags |= ProcessCreateFlag_WaitForProcessStartOnly;
2928 mFiles.push_back(ISOFile("VBOXWINDOWSADDITIONS.EXE",
2929 strUpdateDir + "VBoxWindowsAdditions.exe",
2930 ISOFILE_FLAG_COPY_FROM_ISO | ISOFILE_FLAG_EXECUTE, siInstaller));
2931 break;
2932 }
2933 case eOSType_Linux:
2934 {
2935 /* Copy over the installer to the guest but don't execute it.
2936 * Execution will be done by the shell instead. */
2937 mFiles.push_back(ISOFile("VBOXLINUXADDITIONS.RUN",
2938 strUpdateDir + "VBoxLinuxAdditions.run", ISOFILE_FLAG_COPY_FROM_ISO));
2939
2940 GuestProcessStartupInfo siInstaller;
2941 siInstaller.mName = "VirtualBox Linux Guest Additions Installer";
2942 /* Set a running timeout of 5 minutes -- compiling modules and stuff for the Linux Guest Additions
2943 * setup can take quite a while, so be on the safe side. */
2944 siInstaller.mTimeoutMS = 5 * 60 * 1000;
2945 /* The argv[0] should contain full path to the shell we're using to execute the installer. */
2946 siInstaller.mArguments.push_back("/bin/sh");
2947 /* Now add the stuff we need in order to execute the installer. */
2948 siInstaller.mArguments.push_back(strUpdateDir + "VBoxLinuxAdditions.run");
2949 /* Make sure to add "--nox11" to the makeself wrapper in order to not getting any blocking xterm
2950 * window spawned when doing any unattended Linux GA installations. */
2951 siInstaller.mArguments.push_back("--nox11");
2952 siInstaller.mArguments.push_back("--");
2953 /* Force the upgrade. Needed in order to skip the confirmation dialog about warning to upgrade. */
2954 siInstaller.mArguments.push_back("--force"); /** @todo We might want a dedicated "--silent" switch here. */
2955 /* If the caller does not want to wait for out guest update process to end,
2956 * complete the progress object now so that the caller can do other work. */
2957 if (mFlags & AdditionsUpdateFlag_WaitForUpdateStartOnly)
2958 siInstaller.mFlags |= ProcessCreateFlag_WaitForProcessStartOnly;
2959 mFiles.push_back(ISOFile("/bin/sh" /* Source */, "/bin/sh" /* Dest */,
2960 ISOFILE_FLAG_EXECUTE, siInstaller));
2961 break;
2962 }
2963 case eOSType_Solaris:
2964 /** @todo Add Solaris support. */
2965 break;
2966 default:
2967 AssertReleaseMsgFailed(("Unsupported guest type: %d\n", osType));
2968 break;
2969 }
2970 }
2971
2972 if (RT_SUCCESS(vrc))
2973 {
2974 /* We want to spend 40% total for all copying operations. So roughly
2975 * calculate the specific percentage step of each copied file. */
2976 uint8_t uOffset = 20; /* Start at 20%. */
2977 uint8_t uStep = 40 / (uint8_t)mFiles.size(); Assert(mFiles.size() <= 10);
2978
2979 LogRel(("Copying over Guest Additions update files to the guest ...\n"));
2980
2981 std::vector<ISOFile>::const_iterator itFiles = mFiles.begin();
2982 while (itFiles != mFiles.end())
2983 {
2984 if (itFiles->fFlags & ISOFILE_FLAG_COPY_FROM_ISO)
2985 {
2986 bool fOptional = false;
2987 if (itFiles->fFlags & ISOFILE_FLAG_OPTIONAL)
2988 fOptional = true;
2989 vrc = copyFileToGuest(pSession, hVfsIso, itFiles->strSource, itFiles->strDest, fOptional);
2990 if (RT_FAILURE(vrc))
2991 {
2992 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR,
2993 Utf8StrFmt(tr("Error while copying file \"%s\" to \"%s\" on the guest: %Rrc"),
2994 itFiles->strSource.c_str(), itFiles->strDest.c_str(), vrc));
2995 break;
2996 }
2997 }
2998
2999 vrc = setProgress(uOffset);
3000 if (RT_FAILURE(vrc))
3001 break;
3002 uOffset += uStep;
3003
3004 ++itFiles;
3005 }
3006 }
3007
3008 /* Done copying, close .ISO file. */
3009 RTVfsRelease(hVfsIso);
3010
3011 if (RT_SUCCESS(vrc))
3012 {
3013 /* We want to spend 35% total for all copying operations. So roughly
3014 * calculate the specific percentage step of each copied file. */
3015 uint8_t uOffset = 60; /* Start at 60%. */
3016 uint8_t uStep = 35 / (uint8_t)mFiles.size(); Assert(mFiles.size() <= 10);
3017
3018 LogRel(("Executing Guest Additions update files ...\n"));
3019
3020 std::vector<ISOFile>::iterator itFiles = mFiles.begin();
3021 while (itFiles != mFiles.end())
3022 {
3023 if (itFiles->fFlags & ISOFILE_FLAG_EXECUTE)
3024 {
3025 vrc = runFileOnGuest(pSession, itFiles->mProcInfo);
3026 if (RT_FAILURE(vrc))
3027 break;
3028 }
3029
3030 vrc = setProgress(uOffset);
3031 if (RT_FAILURE(vrc))
3032 break;
3033 uOffset += uStep;
3034
3035 ++itFiles;
3036 }
3037 }
3038
3039 if (RT_SUCCESS(vrc))
3040 {
3041 LogRel(("Automatic update of Guest Additions succeeded\n"));
3042 vrc = setProgressSuccess();
3043 }
3044 }
3045
3046 RTVfsFileRelease(hVfsFileIso);
3047 }
3048 }
3049
3050 if (RT_FAILURE(vrc))
3051 {
3052 if (vrc == VERR_CANCELLED)
3053 {
3054 LogRel(("Automatic update of Guest Additions was canceled\n"));
3055
3056 hrc = setProgressErrorMsg(VBOX_E_IPRT_ERROR,
3057 Utf8StrFmt(tr("Installation was canceled")));
3058 }
3059 else
3060 {
3061 Utf8Str strError = Utf8StrFmt("No further error information available (%Rrc)", vrc);
3062 if (!mProgress.isNull()) /* Progress object is optional. */
3063 {
3064#ifdef VBOX_STRICT
3065 /* If we forgot to set the progress object accordingly, let us know. */
3066 LONG rcProgress;
3067 AssertMsg( SUCCEEDED(mProgress->COMGETTER(ResultCode(&rcProgress)))
3068 && FAILED(rcProgress), ("Task indicated an error (%Rrc), but progress did not indicate this (%Rhrc)\n",
3069 vrc, rcProgress));
3070#endif
3071 com::ProgressErrorInfo errorInfo(mProgress);
3072 if ( errorInfo.isFullAvailable()
3073 || errorInfo.isBasicAvailable())
3074 {
3075 strError = errorInfo.getText();
3076 }
3077 }
3078
3079 LogRel(("Automatic update of Guest Additions failed: %s (%Rhrc)\n",
3080 strError.c_str(), hrc));
3081 }
3082
3083 LogRel(("Please install Guest Additions manually\n"));
3084 }
3085
3086 /** @todo Clean up copied / left over installation files. */
3087
3088 LogFlowFuncLeaveRC(vrc);
3089 return vrc;
3090}
Note: See TracBrowser for help on using the repository browser.

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