GuestCtrlImplTasks.cpp@ 39694

Last change on this file since 39694 was 39694, checked in by vboxsync, 13 years ago
Main/GuestCtrl: fixed assertion (cbToRead is unsigned)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 47.8 KB

Line
1	/* $Id: */
2	/** @file
3	* VirtualBox Guest Control - Threaded operations (tasks).
4	*/
5
6	/*
7	* Copyright (C) 2011 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#include <memory>
19
20	#include "GuestImpl.h"
21	#include "GuestCtrlImplPrivate.h"
22
23	#include "Global.h"
24	#include "ConsoleImpl.h"
25	#include "ProgressImpl.h"
26	#include "VMMDev.h"
27
28	#include "AutoCaller.h"
29	#include "Logging.h"
30
31	#include <VBox/VMMDev.h>
32	#ifdef VBOX_WITH_GUEST_CONTROL
33	# include <VBox/com/array.h>
34	# include <VBox/com/ErrorInfo.h>
35	#endif
36
37	#include <iprt/file.h>
38	#include <iprt/isofs.h>
39	#include <iprt/list.h>
40	#include <iprt/path.h>
41
42	GuestTask::GuestTask(TaskType aTaskType, Guest aThat, Progress aProgress)
43	: taskType(aTaskType),
44	pGuest(aThat),
45	pProgress(aProgress),
46	rc(S_OK)
47	{
48
49	}
50
51	GuestTask::~GuestTask()
52	{
53
54	}
55
56	int GuestTask::startThread()
57	{
58	return RTThreadCreate(NULL, GuestTask::taskThread, this,
59	0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
60	"GuestTask");
61	}
62
63	/* static */
64	DECLCALLBACK(int) GuestTask::taskThread(RTTHREAD /* aThread /, void pvUser)
65	{
66	std::auto_ptr<GuestTask> task(static_cast<GuestTask*>(pvUser));
67	AssertReturn(task.get(), VERR_GENERAL_FAILURE);
68
69	ComObjPtr<Guest> pGuest = task->pGuest;
70
71	LogFlowFuncEnter();
72
73	HRESULT rc = S_OK;
74
75	switch (task->taskType)
76	{
77	#ifdef VBOX_WITH_GUEST_CONTROL
78	case TaskType_CopyFileToGuest:
79	{
80	rc = pGuest->taskCopyFileToGuest(task.get());
81	break;
82	}
83	case TaskType_CopyFileFromGuest:
84	{
85	rc = pGuest->taskCopyFileFromGuest(task.get());
86	break;
87	}
88	case TaskType_UpdateGuestAdditions:
89	{
90	rc = pGuest->taskUpdateGuestAdditions(task.get());
91	break;
92	}
93	#endif
94	default:
95	AssertMsgFailed(("Invalid task type %u specified!\n", task->taskType));
96	break;
97	}
98
99	LogFlowFunc(("rc=%Rhrc\n", rc));
100	LogFlowFuncLeave();
101
102	return VINF_SUCCESS;
103	}
104
105	/* static */
106	int GuestTask::uploadProgress(unsigned uPercent, void *pvUser)
107	{
108	GuestTask pTask = (GuestTask**)pvUser;
109
110	if ( pTask
111	&& !pTask->pProgress.isNull())
112	{
113	BOOL fCanceled;
114	pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
115	if (fCanceled)
116	return -1;
117	pTask->pProgress->SetCurrentOperationProgress(uPercent);
118	}
119	return VINF_SUCCESS;
120	}
121
122	/* static */
123	HRESULT GuestTask::setProgressErrorInfo(HRESULT hr, ComObjPtr<Progress> pProgress,
124	const char *pszText, ...)
125	{
126	BOOL fCanceled;
127	BOOL fCompleted;
128	if ( SUCCEEDED(pProgress->COMGETTER(Canceled(&fCanceled)))
129	&& !fCanceled
130	&& SUCCEEDED(pProgress->COMGETTER(Completed(&fCompleted)))
131	&& !fCompleted)
132	{
133	va_list va;
134	va_start(va, pszText);
135	HRESULT hr2 = pProgress->notifyCompleteV(hr,
136	COM_IIDOF(IGuest),
137	Guest::getStaticComponentName(),
138	pszText,
139	va);
140	va_end(va);
141	if (hr2 == S_OK) /* If unable to retrieve error, return input error. */
142	hr2 = hr;
143	return hr2;
144	}
145	return S_OK;
146	}
147
148	/* static */
149	HRESULT GuestTask::setProgressErrorInfo(HRESULT hr,
150	ComObjPtr<Progress> pProgress, ComObjPtr<Guest> pGuest)
151	{
152	return setProgressErrorInfo(hr, pProgress,
153	Utf8Str(com::ErrorInfo((IGuest*)pGuest, COM_IIDOF(IGuest)).getText()).c_str());
154	}
155
156	#ifdef VBOX_WITH_GUEST_CONTROL
157	HRESULT Guest::taskCopyFileToGuest(GuestTask *aTask)
158	{
159	LogFlowFuncEnter();
160
161	AutoCaller autoCaller(this);
162	if (FAILED(autoCaller.rc())) return autoCaller.rc();
163
164	/*
165	* Do not take a write lock here since we don't (and won't)
166	* touch any class-specific data (of IGuest) here - only the member functions
167	* which get called here can do that.
168	*/
169
170	HRESULT rc = S_OK;
171
172	try
173	{
174	ComObjPtr<Guest> pGuest = aTask->pGuest;
175
176	/* Does our source file exist? */
177	if (!RTFileExists(aTask->strSource.c_str()))
178	{
179	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
180	Guest::tr("Source file \"%s\" does not exist, or is not a file"),
181	aTask->strSource.c_str());
182	}
183	else
184	{
185	RTFILE fileSource;
186	int vrc = RTFileOpen(&fileSource, aTask->strSource.c_str(),
187	RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_WRITE);
188	if (RT_FAILURE(vrc))
189	{
190	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
191	Guest::tr("Could not open source file \"%s\" for reading (%Rrc)"),
192	aTask->strSource.c_str(), vrc);
193	}
194	else
195	{
196	uint64_t cbSize;
197	vrc = RTFileGetSize(fileSource, &cbSize);
198	if (RT_FAILURE(vrc))
199	{
200	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
201	Guest::tr("Could not query file size of \"%s\" (%Rrc)"),
202	aTask->strSource.c_str(), vrc);
203	}
204	else
205	{
206	com::SafeArray<IN_BSTR> args;
207	com::SafeArray<IN_BSTR> env;
208
209	/*
210	* Prepare tool command line.
211	*/
212	char szOutput[RTPATH_MAX];
213	if (RTStrPrintf(szOutput, sizeof(szOutput), "--output=%s", aTask->strDest.c_str()) <= sizeof(szOutput) - 1)
214	{
215	/*
216	* Normalize path slashes, based on the detected guest.
217	*/
218	Utf8Str osType = mData.mOSTypeId;
219	if ( osType.contains("Microsoft", Utf8Str::CaseInsensitive)
220	\|\| osType.contains("Windows", Utf8Str::CaseInsensitive))
221	{
222	/* We have a Windows guest. */
223	RTPathChangeToDosSlashes(szOutput, true /* Force conversion. */);
224	}
225	else /* ... or something which isn't from Redmond ... */
226	{
227	RTPathChangeToUnixSlashes(szOutput, true /* Force conversion. */);
228	}
229
230	args.push_back(Bstr(szOutput).raw()); /* We want to write a file ... */
231	}
232	else
233	{
234	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
235	Guest::tr("Error preparing command line"));
236	}
237
238	ComPtr<IProgress> execProgress;
239	ULONG uPID;
240	if (SUCCEEDED(rc))
241	{
242	LogRel(("Copying file \"%s\" to guest \"%s\" (%u bytes) ...\n",
243	aTask->strSource.c_str(), aTask->strDest.c_str(), cbSize));
244	/*
245	* Okay, since we gathered all stuff we need until now to start the
246	* actual copying, start the guest part now.
247	*/
248	rc = pGuest->executeAndWaitForTool(Bstr(VBOXSERVICE_TOOL_CAT).raw(),
249	Bstr("Copying file to guest").raw(),
250	ComSafeArrayAsInParam(args),
251	ComSafeArrayAsInParam(env),
252	Bstr(aTask->strUserName).raw(),
253	Bstr(aTask->strPassword).raw(),
254	ExecuteProcessFlag_None,
255	NULL, NULL,
256	execProgress.asOutParam(), &uPID);
257	if (FAILED(rc))
258	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
259	}
260
261	if (SUCCEEDED(rc))
262	{
263	BOOL fCompleted = FALSE;
264	BOOL fCanceled = FALSE;
265
266	size_t cbToRead = cbSize;
267	uint64_t cbTransferedTotal = 0;
268
269	size_t cbRead;
270
271	SafeArray<BYTE> aInputData(_64K);
272	while ( SUCCEEDED(execProgress->COMGETTER(Completed(&fCompleted)))
273	&& !fCompleted)
274	{
275	/** @todo Not very efficient, but works for now. */
276	vrc = RTFileSeek(fileSource, cbTransferedTotal,
277	RTFILE_SEEK_BEGIN, NULL /* poffActual */);
278	if (RT_SUCCESS(vrc))
279	{
280	vrc = RTFileRead(fileSource, (uint8_t*)aInputData.raw(),
281	RT_MIN(cbToRead, _64K), &cbRead);
282	/*
283	* Some other error occured? There might be a chance that RTFileRead
284	* could not resolve/map the native error code to an IPRT code, so just
285	* print a generic error.
286	*/
287	if (RT_FAILURE(vrc))
288	{
289	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
290	Guest::tr("Could not read from file \"%s\" (%Rrc)"),
291	aTask->strSource.c_str(), vrc);
292	break;
293	}
294	}
295	else
296	{
297	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
298	Guest::tr("Seeking file \"%s\" failed; offset = %RU64 (%Rrc)"),
299	aTask->strSource.c_str(), cbTransferedTotal, vrc);
300	break;
301	}
302	/* Resize buffer to reflect amount we just have read.
303	* Size 0 is allowed! */
304	aInputData.resize(cbRead);
305
306	ULONG uFlags = ProcessInputFlag_None;
307	/* Did we reach the end of the content we want to transfer (last chunk)? */
308	if ( (cbRead < _64K)
309	/* Did we reach the last block which is exactly _64K? */
310	\|\| (cbToRead - cbRead == 0)
311	/* ... or does the user want to cancel? */
312	\|\| ( SUCCEEDED(aTask->pProgress->COMGETTER(Canceled(&fCanceled)))
313	&& fCanceled)
314	)
315	{
316	uFlags \|= ProcessInputFlag_EndOfFile;
317	}
318
319	ULONG uBytesWritten;
320	rc = pGuest->SetProcessInput(uPID, uFlags,
321	0 /* Infinite timeout */,
322	ComSafeArrayAsInParam(aInputData), &uBytesWritten);
323	if (FAILED(rc))
324	{
325	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
326	break;
327	}
328
329	Assert(cbRead <= cbToRead);
330	Assert(cbToRead >= cbRead);
331	cbToRead -= cbRead;
332
333	cbTransferedTotal += uBytesWritten;
334	Assert(cbTransferedTotal <= cbSize);
335	aTask->pProgress->SetCurrentOperationProgress(cbTransferedTotal / (cbSize / 100.0));
336
337	/* End of file reached? */
338	if (cbToRead == 0)
339	break;
340
341	/* Did the user cancel the operation above? */
342	if (fCanceled)
343	break;
344
345	/* Progress canceled by Main API? */
346	if ( SUCCEEDED(execProgress->COMGETTER(Canceled(&fCanceled)))
347	&& fCanceled)
348	{
349	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
350	Guest::tr("Copy operation of file \"%s\" was canceled on guest side"),
351	aTask->strSource.c_str());
352	break;
353	}
354	}
355
356	if (SUCCEEDED(rc))
357	{
358	/*
359	* If we got here this means the started process either was completed,
360	* canceled or we simply got all stuff transferred.
361	*/
362	ExecuteProcessStatus_T retStatus;
363	ULONG uRetExitCode;
364
365	rc = executeWaitForExit(uPID, execProgress, 0 /* No timeout */,
366	&retStatus, &uRetExitCode);
367	if (FAILED(rc))
368	{
369	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
370	}
371	else
372	{
373	if ( uRetExitCode != 0
374	\|\| retStatus != ExecuteProcessStatus_TerminatedNormally)
375	{
376	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
377	Guest::tr("Guest process reported error %u (status: %u) while copying file \"%s\" to \"%s\""),
378	uRetExitCode, retStatus, aTask->strSource.c_str(), aTask->strDest.c_str());
379	}
380	}
381	}
382
383	if (SUCCEEDED(rc))
384	{
385	if (fCanceled)
386	{
387	/*
388	* In order to make the progress object to behave nicely, we also have to
389	* notify the object with a complete event when it's canceled.
390	*/
391	aTask->pProgress->notifyComplete(VBOX_E_IPRT_ERROR,
392	COM_IIDOF(IGuest),
393	Guest::getStaticComponentName(),
394	Guest::tr("Copying file \"%s\" canceled"), aTask->strSource.c_str());
395	}
396	else
397	{
398	/*
399	* Even if we succeeded until here make sure to check whether we really transfered
400	* everything.
401	*/
402	if ( cbSize > 0
403	&& cbTransferedTotal == 0)
404	{
405	/* If nothing was transfered but the file size was > 0 then "vbox_cat" wasn't able to write
406	* to the destination -> access denied. */
407	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
408	Guest::tr("Access denied when copying file \"%s\" to \"%s\""),
409	aTask->strSource.c_str(), aTask->strDest.c_str());
410	}
411	else if (cbTransferedTotal < cbSize)
412	{
413	/* If we did not copy all let the user know. */
414	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
415	Guest::tr("Copying file \"%s\" failed (%u/%u bytes transfered)"),
416	aTask->strSource.c_str(), cbTransferedTotal, cbSize);
417	}
418	else /* Yay, all went fine! */
419	aTask->pProgress->notifyComplete(S_OK);
420	}
421	}
422	}
423	}
424	RTFileClose(fileSource);
425	}
426	}
427	}
428	catch (HRESULT aRC)
429	{
430	rc = aRC;
431	}
432
433	/* Clean up */
434	aTask->rc = rc;
435
436	LogFlowFunc(("rc=%Rhrc\n", rc));
437	LogFlowFuncLeave();
438
439	return VINF_SUCCESS;
440	}
441
442	HRESULT Guest::taskCopyFileFromGuest(GuestTask *aTask)
443	{
444	LogFlowFuncEnter();
445
446	AutoCaller autoCaller(this);
447	if (FAILED(autoCaller.rc())) return autoCaller.rc();
448
449	/*
450	* Do not take a write lock here since we don't (and won't)
451	* touch any class-specific data (of IGuest) here - only the member functions
452	* which get called here can do that.
453	*/
454
455	HRESULT rc = S_OK;
456
457	try
458	{
459	ComObjPtr<Guest> pGuest = aTask->pGuest;
460
461	/* Does our source file exist? */
462	BOOL fFileExists;
463	rc = pGuest->FileExists(Bstr(aTask->strSource).raw(),
464	Bstr(aTask->strUserName).raw(), Bstr(aTask->strPassword).raw(),
465	&fFileExists);
466	if (SUCCEEDED(rc))
467	{
468	if (!fFileExists)
469	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
470	Guest::tr("Source file \"%s\" does not exist, or is not a file"),
471	aTask->strSource.c_str());
472	}
473	else
474	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
475
476	/* Query file size to make an estimate for our progress object. */
477	if (SUCCEEDED(rc))
478	{
479	LONG64 lFileSize;
480	rc = pGuest->FileQuerySize(Bstr(aTask->strSource).raw(),
481	Bstr(aTask->strUserName).raw(), Bstr(aTask->strPassword).raw(),
482	&lFileSize);
483	if (FAILED(rc))
484	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
485
486	com::SafeArray<IN_BSTR> args;
487	com::SafeArray<IN_BSTR> env;
488
489	if (SUCCEEDED(rc))
490	{
491	/*
492	* Prepare tool command line.
493	*/
494	char szSource[RTPATH_MAX];
495	if (RTStrPrintf(szSource, sizeof(szSource), "%s", aTask->strSource.c_str()) <= sizeof(szSource) - 1)
496	{
497	/*
498	* Normalize path slashes, based on the detected guest.
499	*/
500	Utf8Str osType = mData.mOSTypeId;
501	if ( osType.contains("Microsoft", Utf8Str::CaseInsensitive)
502	\|\| osType.contains("Windows", Utf8Str::CaseInsensitive))
503	{
504	/* We have a Windows guest. */
505	RTPathChangeToDosSlashes(szSource, true /* Force conversion. */);
506	}
507	else /* ... or something which isn't from Redmond ... */
508	{
509	RTPathChangeToUnixSlashes(szSource, true /* Force conversion. */);
510	}
511
512	args.push_back(Bstr(szSource).raw()); /* Tell our cat tool which file to output. */
513	}
514	else
515	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
516	Guest::tr("Error preparing command line"));
517	}
518
519	ComPtr<IProgress> execProgress;
520	ULONG uPID;
521	if (SUCCEEDED(rc))
522	{
523	LogRel(("Copying file \"%s\" to host \"%s\" (%u bytes) ...\n",
524	aTask->strSource.c_str(), aTask->strDest.c_str(), lFileSize));
525
526	/*
527	* Okay, since we gathered all stuff we need until now to start the
528	* actual copying, start the guest part now.
529	*/
530	rc = pGuest->executeAndWaitForTool(Bstr(VBOXSERVICE_TOOL_CAT).raw(),
531	Bstr("Copying file to host").raw(),
532	ComSafeArrayAsInParam(args),
533	ComSafeArrayAsInParam(env),
534	Bstr(aTask->strUserName).raw(),
535	Bstr(aTask->strPassword).raw(),
536	ExecuteProcessFlag_WaitForStdOut,
537	NULL, NULL,
538	execProgress.asOutParam(), &uPID);
539	if (FAILED(rc))
540	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
541	}
542
543	if (SUCCEEDED(rc))
544	{
545	BOOL fCompleted = FALSE;
546	BOOL fCanceled = FALSE;
547
548	RTFILE hFileDest;
549	int vrc = RTFileOpen(&hFileDest, aTask->strDest.c_str(),
550	RTFILE_O_WRITE \| RTFILE_O_OPEN_CREATE \| RTFILE_O_DENY_WRITE);
551	if (RT_FAILURE(vrc))
552	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
553	Guest::tr("Unable to create/open destination file \"%s\", rc=%Rrc"),
554	aTask->strDest.c_str(), vrc);
555	else
556	{
557	size_t cbToRead = lFileSize;
558	size_t cbTransfered = 0;
559	SafeArray<BYTE> aOutputData(_64K);
560	while ( SUCCEEDED(execProgress->COMGETTER(Completed(&fCompleted)))
561	&& !fCompleted)
562	{
563	rc = pGuest->GetProcessOutput(uPID, ProcessOutputFlag_None /* StdOut */,
564	0 /* No timeout. */,
565	_64K, ComSafeArrayAsOutParam(aOutputData));
566	if (SUCCEEDED(rc))
567	{
568	if (aOutputData.size())
569	{
570	vrc = RTFileWrite(hFileDest, aOutputData.raw(), aOutputData.size(), NULL /* No partial writes */);
571	if (RT_FAILURE(vrc))
572	{
573	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
574	Guest::tr("Error writing to file \"%s\" (%u bytes left), rc=%Rrc"),
575	aTask->strSource.c_str(), cbToRead, vrc);
576	break;
577	}
578
579	Assert(cbToRead >= aOutputData.size());
580	cbToRead -= aOutputData.size();
581	cbTransfered += aOutputData.size();
582
583	aTask->pProgress->SetCurrentOperationProgress(cbTransfered / (lFileSize / 100.0));
584	}
585
586	/* Nothing read this time; try next round. */
587	}
588	else
589	{
590	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
591	break;
592	}
593	}
594
595	RTFileClose(hFileDest);
596
597	if (SUCCEEDED(rc))
598	{
599	if ( cbTransfered
600	&& (cbTransfered != lFileSize))
601	{
602	/*
603	* Only bitch about an unexpected end of a file when there already
604	* was data read from that file. If this was the very first read we can
605	* be (almost) sure that this file is not meant to be read by the specified user.
606	*/
607	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
608	Guest::tr("Unexpected end of file \"%s\" (%u bytes total, %u bytes transferred)"),
609	aTask->strSource.c_str(), lFileSize, cbTransfered);
610	}
611
612	if (SUCCEEDED(rc))
613	aTask->pProgress->notifyComplete(S_OK);
614	}
615	}
616	}
617	}
618	}
619	catch (HRESULT aRC)
620	{
621	rc = aRC;
622	}
623
624	/* Clean up */
625	aTask->rc = rc;
626
627	LogFlowFunc(("rc=%Rhrc\n", rc));
628	LogFlowFuncLeave();
629
630	return VINF_SUCCESS;
631	}
632
633	HRESULT Guest::taskUpdateGuestAdditions(GuestTask *aTask)
634	{
635	LogFlowFuncEnter();
636
637	AutoCaller autoCaller(this);
638	if (FAILED(autoCaller.rc())) return autoCaller.rc();
639
640	/*
641	* Do not take a write lock here since we don't (and won't)
642	* touch any class-specific data (of IGuest) here - only the member functions
643	* which get called here can do that.
644	*/
645
646	HRESULT rc = S_OK;
647	BOOL fCompleted;
648	BOOL fCanceled;
649
650	try
651	{
652	ComObjPtr<Guest> pGuest = aTask->pGuest;
653
654	aTask->pProgress->SetCurrentOperationProgress(10);
655
656	/*
657	* Determine guest OS type and the required installer image.
658	* At the moment only Windows guests are supported.
659	*/
660	Utf8Str installerImage;
661	Bstr osTypeId;
662	if ( SUCCEEDED(pGuest->COMGETTER(OSTypeId(osTypeId.asOutParam())))
663	&& !osTypeId.isEmpty())
664	{
665	Utf8Str osTypeIdUtf8(osTypeId); /* Needed for .contains(). */
666	if ( osTypeIdUtf8.contains("Microsoft", Utf8Str::CaseInsensitive)
667	\|\| osTypeIdUtf8.contains("Windows", Utf8Str::CaseInsensitive))
668	{
669	if (osTypeIdUtf8.contains("64", Utf8Str::CaseInsensitive))
670	installerImage = "VBOXWINDOWSADDITIONS_AMD64.EXE";
671	else
672	installerImage = "VBOXWINDOWSADDITIONS_X86.EXE";
673	/* Since the installers are located in the root directory,
674	* no further path processing needs to be done (yet). */
675	}
676	else /* Everything else is not supported (yet). */
677	throw GuestTask::setProgressErrorInfo(VBOX_E_NOT_SUPPORTED, aTask->pProgress,
678	Guest::tr("Detected guest OS (%s) does not support automatic Guest Additions updating, please update manually"),
679	osTypeIdUtf8.c_str());
680	}
681	else
682	throw GuestTask::setProgressErrorInfo(VBOX_E_NOT_SUPPORTED, aTask->pProgress,
683	Guest::tr("Could not detected guest OS type/version, please update manually"));
684	Assert(!installerImage.isEmpty());
685
686	/*
687	* Try to open the .ISO file and locate the specified installer.
688	*/
689	RTISOFSFILE iso;
690	int vrc = RTIsoFsOpen(&iso, aTask->strSource.c_str());
691	if (RT_FAILURE(vrc))
692	{
693	rc = GuestTask::setProgressErrorInfo(VBOX_E_FILE_ERROR, aTask->pProgress,
694	Guest::tr("Invalid installation medium detected: \"%s\""),
695	aTask->strSource.c_str());
696	}
697	else
698	{
699	uint32_t cbOffset;
700	size_t cbLength;
701	vrc = RTIsoFsGetFileInfo(&iso, installerImage.c_str(), &cbOffset, &cbLength);
702	if ( RT_SUCCESS(vrc)
703	&& cbOffset
704	&& cbLength)
705	{
706	vrc = RTFileSeek(iso.file, cbOffset, RTFILE_SEEK_BEGIN, NULL);
707	if (RT_FAILURE(vrc))
708	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
709	Guest::tr("Could not seek to setup file on installation medium \"%s\" (%Rrc)"),
710	aTask->strSource.c_str(), vrc);
711	}
712	else
713	{
714	switch (vrc)
715	{
716	case VERR_FILE_NOT_FOUND:
717	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
718	Guest::tr("Setup file was not found on installation medium \"%s\""),
719	aTask->strSource.c_str());
720	break;
721
722	default:
723	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
724	Guest::tr("An unknown error (%Rrc) occured while retrieving information of setup file on installation medium \"%s\""),
725	vrc, aTask->strSource.c_str());
726	break;
727	}
728	}
729
730	/* Specify the ouput path on the guest side. */
731	Utf8Str strInstallerPath = "%TEMP%\\VBoxWindowsAdditions.exe";
732
733	if (RT_SUCCESS(vrc))
734	{
735	/* Okay, we're ready to start our copy routine on the guest! */
736	aTask->pProgress->SetCurrentOperationProgress(15);
737
738	/* Prepare command line args. */
739	com::SafeArray<IN_BSTR> args;
740	com::SafeArray<IN_BSTR> env;
741
742	args.push_back(Bstr("--output").raw()); /* We want to write a file ... */
743	args.push_back(Bstr(strInstallerPath.c_str()).raw()); /* ... with this path. */
744
745	if (SUCCEEDED(rc))
746	{
747	ComPtr<IProgress> progressCat;
748	ULONG uPID;
749
750	/*
751	* Start built-in "vbox_cat" tool (inside VBoxService) to
752	* copy over/pipe the data into a file on the guest (with
753	* system rights, no username/password specified).
754	*/
755	rc = pGuest->executeProcessInternal(Bstr(VBOXSERVICE_TOOL_CAT).raw(),
756	ExecuteProcessFlag_Hidden
757	\| ExecuteProcessFlag_WaitForProcessStartOnly,
758	ComSafeArrayAsInParam(args),
759	ComSafeArrayAsInParam(env),
760	Bstr("").raw() /* Username. */,
761	Bstr("").raw() /* Password */,
762	5 * 1000 /* Wait 5s for getting the process started. */,
763	&uPID, progressCat.asOutParam(), &vrc);
764	if (FAILED(rc))
765	{
766	/* Errors which return VBOX_E_NOT_SUPPORTED can be safely skipped by the caller
767	* to silently fall back to "normal" (old) .ISO mounting. */
768
769	/* Due to a very limited COM error range we use vrc for a more detailed error
770	* lookup to figure out what went wrong. */
771	switch (vrc)
772	{
773	/* Guest execution service is not (yet) ready. This basically means that either VBoxService
774	* is not running (yet) or that the Guest Additions are too old (because VBoxService does not
775	* support the guest execution feature in this version). */
776	case VERR_NOT_FOUND:
777	LogRel(("Guest Additions seem not to be installed yet\n"));
778	rc = GuestTask::setProgressErrorInfo(VBOX_E_NOT_SUPPORTED, aTask->pProgress,
779	Guest::tr("Guest Additions seem not to be installed or are not ready to update yet"));
780	break;
781
782	/* Getting back a VERR_INVALID_PARAMETER indicates that the installed Guest Additions are supporting the guest
783	* execution but not the built-in "vbox_cat" tool of VBoxService (< 4.0). */
784	case VERR_INVALID_PARAMETER:
785	LogRel(("Guest Additions are installed but don't supported automatic updating\n"));
786	rc = GuestTask::setProgressErrorInfo(VBOX_E_NOT_SUPPORTED, aTask->pProgress,
787	Guest::tr("Installed Guest Additions do not support automatic updating"));
788	break;
789
790	case VERR_TIMEOUT:
791	LogRel(("Guest was unable to start copying the Guest Additions setup within time\n"));
792	rc = GuestTask::setProgressErrorInfo(E_FAIL, aTask->pProgress,
793	Guest::tr("Guest was unable to start copying the Guest Additions setup within time"));
794	break;
795
796	default:
797	rc = GuestTask::setProgressErrorInfo(E_FAIL, aTask->pProgress,
798	Guest::tr("Error copying Guest Additions setup file to guest path \"%s\" (%Rrc)"),
799	strInstallerPath.c_str(), vrc);
800	break;
801	}
802	}
803	else
804	{
805	LogRel(("Automatic update of Guest Additions started, using \"%s\"\n", aTask->strSource.c_str()));
806	LogRel(("Copying Guest Additions installer \"%s\" to \"%s\" on guest ...\n",
807	installerImage.c_str(), strInstallerPath.c_str()));
808	aTask->pProgress->SetCurrentOperationProgress(20);
809
810	/* Wait for process to exit ... */
811	SafeArray<BYTE> aInputData(_64K);
812	while ( SUCCEEDED(progressCat->COMGETTER(Completed(&fCompleted)))
813	&& !fCompleted)
814	{
815	size_t cbRead;
816	/* cbLength contains remaining bytes of our installer file
817	* opened above to read. */
818	size_t cbToRead = RT_MIN(cbLength, _64K);
819	if (cbToRead)
820	{
821	vrc = RTFileRead(iso.file, (uint8_t*)aInputData.raw(), cbToRead, &cbRead);
822	if ( cbRead
823	&& RT_SUCCESS(vrc))
824	{
825	/* Resize buffer to reflect amount we just have read. */
826	if (cbRead > 0)
827	aInputData.resize(cbRead);
828
829	/* Did we reach the end of the content we want to transfer (last chunk)? */
830	ULONG uFlags = ProcessInputFlag_None;
831	if ( (cbRead < _64K)
832	/* Did we reach the last block which is exactly _64K? */
833	\|\| (cbToRead - cbRead == 0)
834	/* ... or does the user want to cancel? */
835	\|\| ( SUCCEEDED(aTask->pProgress->COMGETTER(Canceled(&fCanceled)))
836	&& fCanceled)
837	)
838	{
839	uFlags \|= ProcessInputFlag_EndOfFile;
840	}
841
842	/* Transfer the current chunk ... */
843	#ifdef DEBUG_andy
844	LogRel(("Copying Guest Additions (%u bytes left) ...\n", cbLength));
845	#endif
846	ULONG uBytesWritten;
847	rc = pGuest->SetProcessInput(uPID, uFlags,
848	10 * 1000 /* Wait 10s for getting the input data transfered. */,
849	ComSafeArrayAsInParam(aInputData), &uBytesWritten);
850	if (FAILED(rc))
851	{
852	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
853	break;
854	}
855
856	/* If task was canceled above also cancel the process execution. */
857	if (fCanceled)
858	progressCat->Cancel();
859
860	#ifdef DEBUG_andy
861	LogRel(("Copying Guest Additions (%u bytes written) ...\n", uBytesWritten));
862	#endif
863	Assert(cbLength >= uBytesWritten);
864	cbLength -= uBytesWritten;
865	}
866	else if (RT_FAILURE(vrc))
867	{
868	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
869	Guest::tr("Error while reading setup file \"%s\" (To read: %u, Size: %u) from installation medium (%Rrc)"),
870	installerImage.c_str(), cbToRead, cbLength, vrc);
871	}
872	}
873
874	/* Internal progress canceled? */
875	if ( SUCCEEDED(progressCat->COMGETTER(Canceled(&fCanceled)))
876	&& fCanceled)
877	{
878	aTask->pProgress->Cancel();
879	break;
880	}
881	}
882	}
883	}
884	}
885	RTIsoFsClose(&iso);
886
887	if ( SUCCEEDED(rc)
888	&& ( SUCCEEDED(aTask->pProgress->COMGETTER(Canceled(&fCanceled)))
889	&& !fCanceled
890	)
891	)
892	{
893	/*
894	* Installer was transferred successfully, so let's start it
895	* (with system rights).
896	*/
897	LogRel(("Preparing to execute Guest Additions update ...\n"));
898	aTask->pProgress->SetCurrentOperationProgress(66);
899
900	/* Prepare command line args for installer. */
901	com::SafeArray<IN_BSTR> installerArgs;
902	com::SafeArray<IN_BSTR> installerEnv;
903
904	/** @todo Only Windows! */
905	installerArgs.push_back(Bstr(strInstallerPath).raw()); /* The actual (internal) installer image (as argv[0]). */
906	/* Note that starting at Windows Vista the lovely session 0 separation applies:
907	* This means that if we run an application with the profile/security context
908	* of VBoxService (system rights!) we're not able to show any UI. */
909	installerArgs.push_back(Bstr("/S").raw()); /* We want to install in silent mode. */
910	installerArgs.push_back(Bstr("/l").raw()); /* ... and logging enabled. */
911	/* Don't quit VBoxService during upgrade because it still is used for this
912	* piece of code we're in right now (that is, here!) ... */
913	installerArgs.push_back(Bstr("/no_vboxservice_exit").raw());
914	/* Tell the installer to report its current installation status
915	* using a running VBoxTray instance via balloon messages in the
916	* Windows taskbar. */
917	installerArgs.push_back(Bstr("/post_installstatus").raw());
918
919	/*
920	* Start the just copied over installer with system rights
921	* in silent mode on the guest. Don't use the hidden flag since there
922	* may be pop ups the user has to process.
923	*/
924	ComPtr<IProgress> progressInstaller;
925	ULONG uPID;
926	rc = pGuest->executeProcessInternal(Bstr(strInstallerPath).raw(),
927	ExecuteProcessFlag_WaitForProcessStartOnly,
928	ComSafeArrayAsInParam(installerArgs),
929	ComSafeArrayAsInParam(installerEnv),
930	Bstr("").raw() /* Username */,
931	Bstr("").raw() /* Password */,
932	10 * 1000 /* Wait 10s for getting the process started */,
933	&uPID, progressInstaller.asOutParam(), &vrc);
934	if (SUCCEEDED(rc))
935	{
936	LogRel(("Guest Additions update is running ...\n"));
937
938	/* If the caller does not want to wait for out guest update process to end,
939	* complete the progress object now so that the caller can do other work. */
940	if (aTask->uFlags & AdditionsUpdateFlag_WaitForUpdateStartOnly)
941	aTask->pProgress->notifyComplete(S_OK);
942	else
943	aTask->pProgress->SetCurrentOperationProgress(70);
944
945	/* Wait until the Guest Additions installer finishes ... */
946	while ( SUCCEEDED(progressInstaller->COMGETTER(Completed(&fCompleted)))
947	&& !fCompleted)
948	{
949	if ( SUCCEEDED(aTask->pProgress->COMGETTER(Canceled(&fCanceled)))
950	&& fCanceled)
951	{
952	progressInstaller->Cancel();
953	break;
954	}
955	/* Progress canceled by Main API? */
956	if ( SUCCEEDED(progressInstaller->COMGETTER(Canceled(&fCanceled)))
957	&& fCanceled)
958	{
959	break;
960	}
961	RTThreadSleep(100);
962	}
963
964	ExecuteProcessStatus_T retStatus;
965	ULONG uRetExitCode, uRetFlags;
966	rc = pGuest->GetProcessStatus(uPID, &uRetExitCode, &uRetFlags, &retStatus);
967	if (SUCCEEDED(rc))
968	{
969	if (fCompleted)
970	{
971	if (uRetExitCode == 0)
972	{
973	LogRel(("Guest Additions update successful!\n"));
974	if ( SUCCEEDED(aTask->pProgress->COMGETTER(Completed(&fCompleted)))
975	&& !fCompleted)
976	aTask->pProgress->notifyComplete(S_OK);
977	}
978	else
979	{
980	LogRel(("Guest Additions update failed (Exit code=%u, Status=%u, Flags=%u)\n",
981	uRetExitCode, retStatus, uRetFlags));
982	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
983	Guest::tr("Guest Additions update failed with exit code=%u (status=%u, flags=%u)"),
984	uRetExitCode, retStatus, uRetFlags);
985	}
986	}
987	else if ( SUCCEEDED(progressInstaller->COMGETTER(Canceled(&fCanceled)))
988	&& fCanceled)
989	{
990	LogRel(("Guest Additions update was canceled\n"));
991	rc = GuestTask::setProgressErrorInfo(VBOX_E_IPRT_ERROR, aTask->pProgress,
992	Guest::tr("Guest Additions update was canceled by the guest with exit code=%u (status=%u, flags=%u)"),
993	uRetExitCode, retStatus, uRetFlags);
994	}
995	else
996	{
997	LogRel(("Guest Additions update was canceled by the user\n"));
998	}
999	}
1000	else
1001	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
1002	}
1003	else
1004	rc = GuestTask::setProgressErrorInfo(rc, aTask->pProgress, pGuest);
1005	}
1006	}
1007	}
1008	catch (HRESULT aRC)
1009	{
1010	rc = aRC;
1011	}
1012
1013	/* Clean up */
1014	aTask->rc = rc;
1015
1016	LogFlowFunc(("rc=%Rhrc\n", rc));
1017	LogFlowFuncLeave();
1018
1019	return VINF_SUCCESS;
1020	}
1021	#endif
1022

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-client/GuestCtrlImplTasks.cpp@ 39694

Download in other formats: