VirtualBox

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp@ 98298

Last change on this file since 98298 was 98298, checked in by vboxsync, 17 months ago

VBoxManage: rc -> vrc/hrc. Make scm check. bugref:10223
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 139.2 KB
Line 
1/* $Id: VBoxManageGuestCtrl.cpp 98298 2023-01-25 02:23:33Z vboxsync $ */
2/** @file
3 * VBoxManage - Implementation of guestcontrol command.
4 */
5
6/*
7 * Copyright (C) 2010-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
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#include "VBoxManage.h"
33#include "VBoxManageGuestCtrl.h"
34
35#include <VBox/com/array.h>
36#include <VBox/com/com.h>
37#include <VBox/com/ErrorInfo.h>
38#include <VBox/com/errorprint.h>
39#include <VBox/com/listeners.h>
40#include <VBox/com/NativeEventQueue.h>
41#include <VBox/com/string.h>
42#include <VBox/com/VirtualBox.h>
43
44#include <VBox/err.h>
45#include <VBox/log.h>
46
47#include <iprt/asm.h>
48#include <iprt/dir.h>
49#include <iprt/file.h>
50#include <iprt/getopt.h>
51#include <iprt/list.h>
52#include <iprt/path.h>
53#include <iprt/process.h> /* For RTProcSelf(). */
54#include <iprt/semaphore.h>
55#include <iprt/thread.h>
56#include <iprt/vfs.h>
57
58#include <iprt/cpp/path.h>
59
60#include <map>
61#include <vector>
62
63#ifdef USE_XPCOM_QUEUE
64# include <sys/select.h>
65# include <errno.h>
66#endif
67
68#include <signal.h>
69
70#ifdef RT_OS_DARWIN
71# include <CoreFoundation/CFRunLoop.h>
72#endif
73
74using namespace com;
75
76
77/*********************************************************************************************************************************
78 * Defined Constants And Macros *
79*********************************************************************************************************************************/
80
81#define GCTLCMD_COMMON_OPT_USER 999 /**< The --username option number. */
82#define GCTLCMD_COMMON_OPT_PASSWORD 998 /**< The --password option number. */
83#define GCTLCMD_COMMON_OPT_PASSWORD_FILE 997 /**< The --password-file option number. */
84#define GCTLCMD_COMMON_OPT_DOMAIN 996 /**< The --domain option number. */
85/** Common option definitions. */
86#define GCTLCMD_COMMON_OPTION_DEFS() \
87 { "--user", GCTLCMD_COMMON_OPT_USER, RTGETOPT_REQ_STRING }, \
88 { "--username", GCTLCMD_COMMON_OPT_USER, RTGETOPT_REQ_STRING }, \
89 { "--passwordfile", GCTLCMD_COMMON_OPT_PASSWORD_FILE, RTGETOPT_REQ_STRING }, \
90 { "--password", GCTLCMD_COMMON_OPT_PASSWORD, RTGETOPT_REQ_STRING }, \
91 { "--domain", GCTLCMD_COMMON_OPT_DOMAIN, RTGETOPT_REQ_STRING }, \
92 { "--quiet", 'q', RTGETOPT_REQ_NOTHING }, \
93 { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
94
95/** Handles common options in the typical option parsing switch. */
96#define GCTLCMD_COMMON_OPTION_CASES(a_pCtx, a_ch, a_pValueUnion) \
97 case 'v': \
98 case 'q': \
99 case GCTLCMD_COMMON_OPT_USER: \
100 case GCTLCMD_COMMON_OPT_DOMAIN: \
101 case GCTLCMD_COMMON_OPT_PASSWORD: \
102 case GCTLCMD_COMMON_OPT_PASSWORD_FILE: \
103 { \
104 RTEXITCODE rcExitCommon = gctlCtxSetOption(a_pCtx, a_ch, a_pValueUnion); \
105 if (RT_UNLIKELY(rcExitCommon != RTEXITCODE_SUCCESS)) \
106 return rcExitCommon; \
107 } break
108
109
110/*********************************************************************************************************************************
111* Global Variables *
112*********************************************************************************************************************************/
113/** Set by the signal handler when current guest control
114 * action shall be aborted. */
115static volatile bool g_fGuestCtrlCanceled = false;
116/** Event semaphore used for wait notifications.
117 * Also being used for the listener implementations in VBoxManageGuestCtrlListener.cpp. */
118 RTSEMEVENT g_SemEventGuestCtrlCanceled = NIL_RTSEMEVENT;
119
120
121/*********************************************************************************************************************************
122* Structures and Typedefs *
123*********************************************************************************************************************************/
124/**
125 * Listener declarations.
126 */
127VBOX_LISTENER_DECLARE(GuestFileEventListenerImpl)
128VBOX_LISTENER_DECLARE(GuestProcessEventListenerImpl)
129VBOX_LISTENER_DECLARE(GuestSessionEventListenerImpl)
130VBOX_LISTENER_DECLARE(GuestEventListenerImpl)
131VBOX_LISTENER_DECLARE(GuestAdditionsRunlevelListener)
132
133/**
134 * Definition of a guestcontrol command, with handler and various flags.
135 */
136typedef struct GCTLCMDDEF
137{
138 /** The command name. */
139 const char *pszName;
140
141 /**
142 * Actual command handler callback.
143 *
144 * @param pCtx Pointer to command context to use.
145 */
146 DECLR3CALLBACKMEMBER(RTEXITCODE, pfnHandler, (struct GCTLCMDCTX *pCtx, int argc, char **argv));
147
148 /** The sub-command scope flags. */
149 uint64_t fSubcommandScope;
150 /** Command context flags (GCTLCMDCTX_F_XXX). */
151 uint32_t fCmdCtx;
152} GCTLCMD;
153/** Pointer to a const guest control command definition. */
154typedef GCTLCMDDEF const *PCGCTLCMDDEF;
155
156/** @name GCTLCMDCTX_F_XXX - Command context flags.
157 * @{
158 */
159/** No flags set. */
160#define GCTLCMDCTX_F_NONE 0
161/** Don't install a signal handler (CTRL+C trap). */
162#define GCTLCMDCTX_F_NO_SIGNAL_HANDLER RT_BIT(0)
163/** No guest session needed. */
164#define GCTLCMDCTX_F_SESSION_ANONYMOUS RT_BIT(1)
165/** @} */
166
167/**
168 * Context for handling a specific command.
169 */
170typedef struct GCTLCMDCTX
171{
172 HandlerArg *pArg;
173
174 /** Pointer to the command definition. */
175 PCGCTLCMDDEF pCmdDef;
176 /** The VM name or UUID. */
177 const char *pszVmNameOrUuid;
178
179 /** Whether we've done the post option parsing init already. */
180 bool fPostOptionParsingInited;
181 /** Whether we've locked the VM session. */
182 bool fLockedVmSession;
183 /** Whether to detach (@c true) or close the session. */
184 bool fDetachGuestSession;
185 /** Set if we've installed the signal handler. */
186 bool fInstalledSignalHandler;
187 /** The verbosity level. */
188 uint32_t cVerbose;
189 /** User name. */
190 Utf8Str strUsername;
191 /** Password. */
192 Utf8Str strPassword;
193 /** Domain. */
194 Utf8Str strDomain;
195 /** Pointer to the IGuest interface. */
196 ComPtr<IGuest> pGuest;
197 /** Pointer to the to be used guest session. */
198 ComPtr<IGuestSession> pGuestSession;
199 /** The guest session ID. */
200 ULONG uSessionID;
201
202} GCTLCMDCTX, *PGCTLCMDCTX;
203
204
205/**
206 * An entry for an element which needs to be copied/created to/on the guest.
207 */
208typedef struct DESTFILEENTRY
209{
210 DESTFILEENTRY(Utf8Str strFilename) : mFilename(strFilename) {}
211 Utf8Str mFilename;
212} DESTFILEENTRY, *PDESTFILEENTRY;
213/*
214 * Map for holding destination entries, whereas the key is the destination
215 * directory and the mapped value is a vector holding all elements for this directory.
216 */
217typedef std::map< Utf8Str, std::vector<DESTFILEENTRY> > DESTDIRMAP, *PDESTDIRMAP;
218typedef std::map< Utf8Str, std::vector<DESTFILEENTRY> >::iterator DESTDIRMAPITER, *PDESTDIRMAPITER;
219
220
221enum kStreamTransform
222{
223 kStreamTransform_None = 0,
224 kStreamTransform_Dos2Unix,
225 kStreamTransform_Unix2Dos
226};
227
228
229DECLARE_TRANSLATION_CONTEXT(GuestCtrl);
230
231
232#ifdef RT_OS_WINDOWS
233static BOOL WINAPI gctlSignalHandler(DWORD dwCtrlType) RT_NOTHROW_DEF
234{
235 bool fEventHandled = FALSE;
236 switch (dwCtrlType)
237 {
238 /* User pressed CTRL+C or CTRL+BREAK or an external event was sent
239 * via GenerateConsoleCtrlEvent(). */
240 case CTRL_BREAK_EVENT:
241 case CTRL_CLOSE_EVENT:
242 case CTRL_C_EVENT:
243 ASMAtomicWriteBool(&g_fGuestCtrlCanceled, true);
244 RTSemEventSignal(g_SemEventGuestCtrlCanceled);
245 fEventHandled = TRUE;
246 break;
247 default:
248 break;
249 /** @todo Add other events here. */
250 }
251
252 return fEventHandled;
253}
254#else /* !RT_OS_WINDOWS */
255/**
256 * Signal handler that sets g_fGuestCtrlCanceled.
257 *
258 * This can be executed on any thread in the process, on Windows it may even be
259 * a thread dedicated to delivering this signal. Don't do anything
260 * unnecessary here.
261 */
262static void gctlSignalHandler(int iSignal) RT_NOTHROW_DEF
263{
264 RT_NOREF(iSignal);
265 ASMAtomicWriteBool(&g_fGuestCtrlCanceled, true);
266 RTSemEventSignal(g_SemEventGuestCtrlCanceled);
267}
268#endif
269
270
271/**
272 * Installs a custom signal handler to get notified
273 * whenever the user wants to intercept the program.
274 *
275 * @todo Make this handler available for all VBoxManage modules?
276 */
277static int gctlSignalHandlerInstall(void)
278{
279 g_fGuestCtrlCanceled = false;
280
281 int vrc = VINF_SUCCESS;
282#ifdef RT_OS_WINDOWS
283 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)gctlSignalHandler, TRUE /* Add handler */))
284 {
285 vrc = RTErrConvertFromWin32(GetLastError());
286 RTMsgError(GuestCtrl::tr("Unable to install console control handler, vrc=%Rrc\n"), vrc);
287 }
288#else
289 signal(SIGINT, gctlSignalHandler);
290 signal(SIGTERM, gctlSignalHandler);
291# ifdef SIGBREAK
292 signal(SIGBREAK, gctlSignalHandler);
293# endif
294#endif
295
296 if (RT_SUCCESS(vrc))
297 vrc = RTSemEventCreate(&g_SemEventGuestCtrlCanceled);
298
299 return vrc;
300}
301
302
303/**
304 * Uninstalls a previously installed signal handler.
305 */
306static int gctlSignalHandlerUninstall(void)
307{
308 int vrc = VINF_SUCCESS;
309#ifdef RT_OS_WINDOWS
310 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)NULL, FALSE /* Remove handler */))
311 {
312 vrc = RTErrConvertFromWin32(GetLastError());
313 RTMsgError(GuestCtrl::tr("Unable to uninstall console control handler, vrc=%Rrc\n"), vrc);
314 }
315#else
316 signal(SIGINT, SIG_DFL);
317 signal(SIGTERM, SIG_DFL);
318# ifdef SIGBREAK
319 signal(SIGBREAK, SIG_DFL);
320# endif
321#endif
322
323 if (g_SemEventGuestCtrlCanceled != NIL_RTSEMEVENT)
324 {
325 RTSemEventDestroy(g_SemEventGuestCtrlCanceled);
326 g_SemEventGuestCtrlCanceled = NIL_RTSEMEVENT;
327 }
328 return vrc;
329}
330
331
332/**
333 * Translates a process status to a human readable string.
334 *
335 * @sa GuestProcess::i_statusToString()
336 */
337const char *gctlProcessStatusToText(ProcessStatus_T enmStatus)
338{
339 switch (enmStatus)
340 {
341 case ProcessStatus_Starting:
342 return GuestCtrl::tr("starting");
343 case ProcessStatus_Started:
344 return GuestCtrl::tr("started");
345 case ProcessStatus_Paused:
346 return GuestCtrl::tr("paused");
347 case ProcessStatus_Terminating:
348 return GuestCtrl::tr("terminating");
349 case ProcessStatus_TerminatedNormally:
350 return GuestCtrl::tr("successfully terminated");
351 case ProcessStatus_TerminatedSignal:
352 return GuestCtrl::tr("terminated by signal");
353 case ProcessStatus_TerminatedAbnormally:
354 return GuestCtrl::tr("abnormally aborted");
355 case ProcessStatus_TimedOutKilled:
356 return GuestCtrl::tr("timed out");
357 case ProcessStatus_TimedOutAbnormally:
358 return GuestCtrl::tr("timed out, hanging");
359 case ProcessStatus_Down:
360 return GuestCtrl::tr("killed");
361 case ProcessStatus_Error:
362 return GuestCtrl::tr("error");
363 default:
364 break;
365 }
366 return GuestCtrl::tr("unknown");
367}
368
369/**
370 * Translates a guest process wait result to a human readable string.
371 */
372const char *gctlProcessWaitResultToText(ProcessWaitResult_T enmWaitResult)
373{
374 switch (enmWaitResult)
375 {
376 case ProcessWaitResult_Start:
377 return GuestCtrl::tr("started");
378 case ProcessWaitResult_Terminate:
379 return GuestCtrl::tr("terminated");
380 case ProcessWaitResult_Status:
381 return GuestCtrl::tr("status changed");
382 case ProcessWaitResult_Error:
383 return GuestCtrl::tr("error");
384 case ProcessWaitResult_Timeout:
385 return GuestCtrl::tr("timed out");
386 case ProcessWaitResult_StdIn:
387 return GuestCtrl::tr("stdin ready");
388 case ProcessWaitResult_StdOut:
389 return GuestCtrl::tr("data on stdout");
390 case ProcessWaitResult_StdErr:
391 return GuestCtrl::tr("data on stderr");
392 case ProcessWaitResult_WaitFlagNotSupported:
393 return GuestCtrl::tr("waiting flag not supported");
394 default:
395 break;
396 }
397 return GuestCtrl::tr("unknown");
398}
399
400/**
401 * Translates a guest session status to a human readable string.
402 */
403const char *gctlGuestSessionStatusToText(GuestSessionStatus_T enmStatus)
404{
405 switch (enmStatus)
406 {
407 case GuestSessionStatus_Starting:
408 return GuestCtrl::tr("starting");
409 case GuestSessionStatus_Started:
410 return GuestCtrl::tr("started");
411 case GuestSessionStatus_Terminating:
412 return GuestCtrl::tr("terminating");
413 case GuestSessionStatus_Terminated:
414 return GuestCtrl::tr("terminated");
415 case GuestSessionStatus_TimedOutKilled:
416 return GuestCtrl::tr("timed out");
417 case GuestSessionStatus_TimedOutAbnormally:
418 return GuestCtrl::tr("timed out, hanging");
419 case GuestSessionStatus_Down:
420 return GuestCtrl::tr("killed");
421 case GuestSessionStatus_Error:
422 return GuestCtrl::tr("error");
423 default:
424 break;
425 }
426 return GuestCtrl::tr("unknown");
427}
428
429/**
430 * Translates a guest file status to a human readable string.
431 */
432const char *gctlFileStatusToText(FileStatus_T enmStatus)
433{
434 switch (enmStatus)
435 {
436 case FileStatus_Opening:
437 return GuestCtrl::tr("opening");
438 case FileStatus_Open:
439 return GuestCtrl::tr("open");
440 case FileStatus_Closing:
441 return GuestCtrl::tr("closing");
442 case FileStatus_Closed:
443 return GuestCtrl::tr("closed");
444 case FileStatus_Down:
445 return GuestCtrl::tr("killed");
446 case FileStatus_Error:
447 return GuestCtrl::tr("error");
448 default:
449 break;
450 }
451 return GuestCtrl::tr("unknown");
452}
453
454/**
455 * Translates a file system objec type to a string.
456 */
457const char *gctlFsObjTypeToName(FsObjType_T enmType)
458{
459 switch (enmType)
460 {
461 case FsObjType_Unknown: return GuestCtrl::tr("unknown");
462 case FsObjType_Fifo: return GuestCtrl::tr("fifo");
463 case FsObjType_DevChar: return GuestCtrl::tr("char-device");
464 case FsObjType_Directory: return GuestCtrl::tr("directory");
465 case FsObjType_DevBlock: return GuestCtrl::tr("block-device");
466 case FsObjType_File: return GuestCtrl::tr("file");
467 case FsObjType_Symlink: return GuestCtrl::tr("symlink");
468 case FsObjType_Socket: return GuestCtrl::tr("socket");
469 case FsObjType_WhiteOut: return GuestCtrl::tr("white-out");
470#ifdef VBOX_WITH_XPCOM_CPP_ENUM_HACK
471 case FsObjType_32BitHack: break;
472#endif
473 }
474 return GuestCtrl::tr("unknown");
475}
476
477static int gctlPrintError(com::ErrorInfo &errorInfo)
478{
479 if ( errorInfo.isFullAvailable()
480 || errorInfo.isBasicAvailable())
481 {
482 /* If we got a VBOX_E_IPRT error we handle the error in a more gentle way
483 * because it contains more accurate info about what went wrong. */
484 if (errorInfo.getResultCode() == VBOX_E_IPRT_ERROR)
485 RTMsgError("%ls.", errorInfo.getText().raw());
486 else
487 {
488 RTMsgError(GuestCtrl::tr("Error details:"));
489 GluePrintErrorInfo(errorInfo);
490 }
491 return VERR_GENERAL_FAILURE; /** @todo */
492 }
493 AssertMsgFailedReturn((GuestCtrl::tr("Object has indicated no error (%Rhrc)!?\n"), errorInfo.getResultCode()),
494 VERR_INVALID_PARAMETER);
495}
496
497static int gctlPrintError(IUnknown *pObj, const GUID &aIID)
498{
499 com::ErrorInfo ErrInfo(pObj, aIID);
500 return gctlPrintError(ErrInfo);
501}
502
503static int gctlPrintProgressError(ComPtr<IProgress> pProgress)
504{
505 int vrc = VINF_SUCCESS;
506 HRESULT hrc;
507
508 do
509 {
510 BOOL fCanceled;
511 CHECK_ERROR_BREAK(pProgress, COMGETTER(Canceled)(&fCanceled));
512 if (!fCanceled)
513 {
514 LONG rcProc;
515 CHECK_ERROR_BREAK(pProgress, COMGETTER(ResultCode)(&rcProc));
516 if (FAILED(rcProc))
517 {
518 com::ProgressErrorInfo ErrInfo(pProgress);
519 vrc = gctlPrintError(ErrInfo);
520 }
521 }
522
523 } while(0);
524
525 AssertMsgStmt(SUCCEEDED(hrc), (GuestCtrl::tr("Could not lookup progress information\n")), vrc = VERR_COM_UNEXPECTED);
526
527 return vrc;
528}
529
530
531
532/*
533 *
534 *
535 * Guest Control Command Context
536 * Guest Control Command Context
537 * Guest Control Command Context
538 * Guest Control Command Context
539 *
540 *
541 *
542 */
543
544
545/**
546 * Initializes a guest control command context structure.
547 *
548 * @returns RTEXITCODE_SUCCESS on success, RTEXITCODE_FAILURE on failure (after
549 * informing the user of course).
550 * @param pCtx The command context to init.
551 * @param pArg The handle argument package.
552 */
553static RTEXITCODE gctrCmdCtxInit(PGCTLCMDCTX pCtx, HandlerArg *pArg)
554{
555 pCtx->pArg = pArg;
556 pCtx->pCmdDef = NULL;
557 pCtx->pszVmNameOrUuid = NULL;
558 pCtx->fPostOptionParsingInited = false;
559 pCtx->fLockedVmSession = false;
560 pCtx->fDetachGuestSession = false;
561 pCtx->fInstalledSignalHandler = false;
562 pCtx->cVerbose = 0;
563 pCtx->strUsername.setNull();
564 pCtx->strPassword.setNull();
565 pCtx->strDomain.setNull();
566 pCtx->pGuest.setNull();
567 pCtx->pGuestSession.setNull();
568 pCtx->uSessionID = 0;
569
570 /*
571 * The user name defaults to the host one, if we can get at it.
572 */
573 char szUser[1024];
574 int vrc = RTProcQueryUsername(RTProcSelf(), szUser, sizeof(szUser), NULL);
575 if ( RT_SUCCESS(vrc)
576 && RTStrIsValidEncoding(szUser)) /* paranoia was required on posix at some point, not needed any more! */
577 {
578 try
579 {
580 pCtx->strUsername = szUser;
581 }
582 catch (std::bad_alloc &)
583 {
584 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory"));
585 }
586 }
587 /* else: ignore this failure. */
588
589 return RTEXITCODE_SUCCESS;
590}
591
592
593/**
594 * Worker for GCTLCMD_COMMON_OPTION_CASES.
595 *
596 * @returns RTEXITCODE_SUCCESS if the option was handled successfully. If not,
597 * an error message is printed and an appropriate failure exit code is
598 * returned.
599 * @param pCtx The guest control command context.
600 * @param ch The option char or ordinal.
601 * @param pValueUnion The option value union.
602 */
603static RTEXITCODE gctlCtxSetOption(PGCTLCMDCTX pCtx, int ch, PRTGETOPTUNION pValueUnion)
604{
605 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
606 switch (ch)
607 {
608 case GCTLCMD_COMMON_OPT_USER: /* User name */
609 if (!pCtx->pCmdDef || !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS))
610 pCtx->strUsername = pValueUnion->psz;
611 else
612 RTMsgWarning(GuestCtrl::tr("The --username|-u option is ignored by '%s'"), pCtx->pCmdDef->pszName);
613 break;
614
615 case GCTLCMD_COMMON_OPT_PASSWORD: /* Password */
616 if (!pCtx->pCmdDef || !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS))
617 {
618 if (pCtx->strPassword.isNotEmpty())
619 RTMsgWarning(GuestCtrl::tr("Password is given more than once."));
620 pCtx->strPassword = pValueUnion->psz;
621 }
622 else
623 RTMsgWarning(GuestCtrl::tr("The --password option is ignored by '%s'"), pCtx->pCmdDef->pszName);
624 break;
625
626 case GCTLCMD_COMMON_OPT_PASSWORD_FILE: /* Password file */
627 if (!pCtx->pCmdDef || !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS))
628 rcExit = readPasswordFile(pValueUnion->psz, &pCtx->strPassword);
629 else
630 RTMsgWarning(GuestCtrl::tr("The --password-file|-p option is ignored by '%s'"), pCtx->pCmdDef->pszName);
631 break;
632
633 case GCTLCMD_COMMON_OPT_DOMAIN: /* domain */
634 if (!pCtx->pCmdDef || !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS))
635 pCtx->strDomain = pValueUnion->psz;
636 else
637 RTMsgWarning(GuestCtrl::tr("The --domain option is ignored by '%s'"), pCtx->pCmdDef->pszName);
638 break;
639
640 case 'v': /* --verbose */
641 pCtx->cVerbose++;
642 break;
643
644 case 'q': /* --quiet */
645 if (pCtx->cVerbose)
646 pCtx->cVerbose--;
647 break;
648
649 default:
650 AssertFatalMsgFailed(("ch=%d (%c)\n", ch, ch));
651 }
652 return rcExit;
653}
654
655
656/**
657 * Initializes the VM for IGuest operation.
658 *
659 * This opens a shared session to a running VM and gets hold of IGuest.
660 *
661 * @returns RTEXITCODE_SUCCESS on success. RTEXITCODE_FAILURE and user message
662 * on failure.
663 * @param pCtx The guest control command context.
664 * GCTLCMDCTX::pGuest will be set on success.
665 */
666static RTEXITCODE gctlCtxInitVmSession(PGCTLCMDCTX pCtx)
667{
668 HRESULT hrc;
669 AssertPtr(pCtx);
670 AssertPtr(pCtx->pArg);
671
672 /*
673 * Find the VM and check if it's running.
674 */
675 ComPtr<IMachine> machine;
676 CHECK_ERROR(pCtx->pArg->virtualBox, FindMachine(Bstr(pCtx->pszVmNameOrUuid).raw(), machine.asOutParam()));
677 if (SUCCEEDED(hrc))
678 {
679 MachineState_T enmMachineState;
680 CHECK_ERROR(machine, COMGETTER(State)(&enmMachineState));
681 if ( SUCCEEDED(hrc)
682 && enmMachineState == MachineState_Running)
683 {
684 /*
685 * It's running. So, open a session to it and get the IGuest interface.
686 */
687 CHECK_ERROR(machine, LockMachine(pCtx->pArg->session, LockType_Shared));
688 if (SUCCEEDED(hrc))
689 {
690 pCtx->fLockedVmSession = true;
691 ComPtr<IConsole> ptrConsole;
692 CHECK_ERROR(pCtx->pArg->session, COMGETTER(Console)(ptrConsole.asOutParam()));
693 if (SUCCEEDED(hrc))
694 {
695 if (ptrConsole.isNotNull())
696 {
697 CHECK_ERROR(ptrConsole, COMGETTER(Guest)(pCtx->pGuest.asOutParam()));
698 if (SUCCEEDED(hrc))
699 return RTEXITCODE_SUCCESS;
700 }
701 else
702 RTMsgError(GuestCtrl::tr("Failed to get a IConsole pointer for the machine. Is it still running?\n"));
703 }
704 }
705 }
706 else if (SUCCEEDED(hrc))
707 RTMsgError(GuestCtrl::tr("Machine \"%s\" is not running (currently %s)!\n"),
708 pCtx->pszVmNameOrUuid, machineStateToName(enmMachineState, false));
709 }
710 return RTEXITCODE_FAILURE;
711}
712
713
714/**
715 * Creates a guest session with the VM.
716 *
717 * @retval RTEXITCODE_SUCCESS on success.
718 * @retval RTEXITCODE_FAILURE and user message on failure.
719 * @param pCtx The guest control command context.
720 * GCTCMDCTX::pGuestSession and GCTLCMDCTX::uSessionID
721 * will be set.
722 */
723static RTEXITCODE gctlCtxInitGuestSession(PGCTLCMDCTX pCtx)
724{
725 HRESULT hrc;
726 AssertPtr(pCtx);
727 Assert(!(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS));
728 Assert(pCtx->pGuest.isNotNull());
729
730 /*
731 * Build up a reasonable guest session name. Useful for identifying
732 * a specific session when listing / searching for them.
733 */
734 char *pszSessionName;
735 if (RTStrAPrintf(&pszSessionName,
736 GuestCtrl::tr("[%RU32] VBoxManage Guest Control [%s] - %s"),
737 RTProcSelf(), pCtx->pszVmNameOrUuid, pCtx->pCmdDef->pszName) < 0)
738 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("No enough memory for session name"));
739
740 /*
741 * Create a guest session.
742 */
743 if (pCtx->cVerbose)
744 RTPrintf(GuestCtrl::tr("Creating guest session as user '%s'...\n"), pCtx->strUsername.c_str());
745 try
746 {
747 CHECK_ERROR(pCtx->pGuest, CreateSession(Bstr(pCtx->strUsername).raw(),
748 Bstr(pCtx->strPassword).raw(),
749 Bstr(pCtx->strDomain).raw(),
750 Bstr(pszSessionName).raw(),
751 pCtx->pGuestSession.asOutParam()));
752 }
753 catch (std::bad_alloc &)
754 {
755 RTMsgError(GuestCtrl::tr("Out of memory setting up IGuest::CreateSession call"));
756 hrc = E_OUTOFMEMORY;
757 }
758 if (SUCCEEDED(hrc))
759 {
760 /*
761 * Wait for guest session to start.
762 */
763 if (pCtx->cVerbose)
764 RTPrintf(GuestCtrl::tr("Waiting for guest session to start...\n"));
765 GuestSessionWaitResult_T enmWaitResult = GuestSessionWaitResult_None; /* Shut up MSC */
766 try
767 {
768 com::SafeArray<GuestSessionWaitForFlag_T> aSessionWaitFlags;
769 aSessionWaitFlags.push_back(GuestSessionWaitForFlag_Start);
770 CHECK_ERROR(pCtx->pGuestSession, WaitForArray(ComSafeArrayAsInParam(aSessionWaitFlags),
771 /** @todo Make session handling timeouts configurable. */
772 30 * 1000, &enmWaitResult));
773 }
774 catch (std::bad_alloc &)
775 {
776 RTMsgError(GuestCtrl::tr("Out of memory setting up IGuestSession::WaitForArray call"));
777 hrc = E_OUTOFMEMORY;
778 }
779 if (SUCCEEDED(hrc))
780 {
781 /* The WaitFlagNotSupported result may happen with GAs older than 4.3. */
782 if ( enmWaitResult == GuestSessionWaitResult_Start
783 || enmWaitResult == GuestSessionWaitResult_WaitFlagNotSupported)
784 {
785 /*
786 * Get the session ID and we're ready to rumble.
787 */
788 CHECK_ERROR(pCtx->pGuestSession, COMGETTER(Id)(&pCtx->uSessionID));
789 if (SUCCEEDED(hrc))
790 {
791 if (pCtx->cVerbose)
792 RTPrintf(GuestCtrl::tr("Successfully started guest session (ID %RU32)\n"), pCtx->uSessionID);
793 RTStrFree(pszSessionName);
794 return RTEXITCODE_SUCCESS;
795 }
796 }
797 else
798 {
799 GuestSessionStatus_T enmSessionStatus;
800 CHECK_ERROR(pCtx->pGuestSession, COMGETTER(Status)(&enmSessionStatus));
801 RTMsgError(GuestCtrl::tr("Error starting guest session (current status is: %s)\n"),
802 SUCCEEDED(hrc) ? gctlGuestSessionStatusToText(enmSessionStatus) : GuestCtrl::tr("<unknown>"));
803 }
804 }
805 }
806
807 RTStrFree(pszSessionName);
808 return RTEXITCODE_FAILURE;
809}
810
811
812/**
813 * Completes the guest control context initialization after parsing arguments.
814 *
815 * Will validate common arguments, open a VM session, and if requested open a
816 * guest session and install the CTRL-C signal handler.
817 *
818 * It is good to validate all the options and arguments you can before making
819 * this call. However, the VM session, IGuest and IGuestSession interfaces are
820 * not availabe till after this call, so take care.
821 *
822 * @retval RTEXITCODE_SUCCESS on success.
823 * @retval RTEXITCODE_FAILURE and user message on failure.
824 * @param pCtx The guest control command context.
825 * GCTCMDCTX::pGuestSession and GCTLCMDCTX::uSessionID
826 * will be set.
827 * @remarks Can safely be called multiple times, will only do work once.
828 */
829static RTEXITCODE gctlCtxPostOptionParsingInit(PGCTLCMDCTX pCtx)
830{
831 if (pCtx->fPostOptionParsingInited)
832 return RTEXITCODE_SUCCESS;
833
834 /*
835 * Check that the user name isn't empty when we need it.
836 */
837 RTEXITCODE rcExit;
838 if ( (pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS)
839 || pCtx->strUsername.isNotEmpty())
840 {
841 /*
842 * Open the VM session and if required, a guest session.
843 */
844 rcExit = gctlCtxInitVmSession(pCtx);
845 if ( rcExit == RTEXITCODE_SUCCESS
846 && !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS))
847 rcExit = gctlCtxInitGuestSession(pCtx);
848 if (rcExit == RTEXITCODE_SUCCESS)
849 {
850 /*
851 * Install signal handler if requested (errors are ignored).
852 */
853 if (!(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_NO_SIGNAL_HANDLER))
854 {
855 int vrc = gctlSignalHandlerInstall();
856 pCtx->fInstalledSignalHandler = RT_SUCCESS(vrc);
857 }
858 }
859 }
860 else
861 rcExit = errorSyntax(GuestCtrl::tr("No user name specified!"));
862
863 pCtx->fPostOptionParsingInited = rcExit == RTEXITCODE_SUCCESS;
864 return rcExit;
865}
866
867
868/**
869 * Cleans up the context when the command returns.
870 *
871 * This will close any open guest session, unless the DETACH flag is set.
872 * It will also close any VM session that may be been established. Any signal
873 * handlers we've installed will also be removed.
874 *
875 * Un-initializes the VM after guest control usage.
876 * @param pCmdCtx Pointer to command context.
877 */
878static void gctlCtxTerm(PGCTLCMDCTX pCtx)
879{
880 HRESULT hrc;
881 AssertPtr(pCtx);
882
883 /*
884 * Uninstall signal handler.
885 */
886 if (pCtx->fInstalledSignalHandler)
887 {
888 gctlSignalHandlerUninstall();
889 pCtx->fInstalledSignalHandler = false;
890 }
891
892 /*
893 * Close, or at least release, the guest session.
894 */
895 if (pCtx->pGuestSession.isNotNull())
896 {
897 if ( !(pCtx->pCmdDef->fCmdCtx & GCTLCMDCTX_F_SESSION_ANONYMOUS)
898 && !pCtx->fDetachGuestSession)
899 {
900 if (pCtx->cVerbose)
901 RTPrintf(GuestCtrl::tr("Closing guest session ...\n"));
902
903 CHECK_ERROR(pCtx->pGuestSession, Close());
904 }
905 else if ( pCtx->fDetachGuestSession
906 && pCtx->cVerbose)
907 RTPrintf(GuestCtrl::tr("Guest session detached\n"));
908
909 pCtx->pGuestSession.setNull();
910 }
911
912 /*
913 * Close the VM session.
914 */
915 if (pCtx->fLockedVmSession)
916 {
917 Assert(pCtx->pArg->session.isNotNull());
918 CHECK_ERROR(pCtx->pArg->session, UnlockMachine());
919 pCtx->fLockedVmSession = false;
920 }
921}
922
923
924
925
926
927/*
928 *
929 *
930 * Guest Control Command Handling.
931 * Guest Control Command Handling.
932 * Guest Control Command Handling.
933 * Guest Control Command Handling.
934 * Guest Control Command Handling.
935 *
936 *
937 */
938
939
940/** @name EXITCODEEXEC_XXX - Special run exit codes.
941 *
942 * Special exit codes for returning errors/information of a started guest
943 * process to the command line VBoxManage was started from. Useful for e.g.
944 * scripting.
945 *
946 * ASSUMING that all platforms have at least 7-bits for the exit code we can do
947 * the following mapping:
948 * - Guest exit code 0 is mapped to 0 on the host.
949 * - Guest exit codes 1 thru 93 (0x5d) are displaced by 32, so that 1
950 * becomes 33 (0x21) on the host and 93 becomes 125 (0x7d) on the host.
951 * - Guest exit codes 94 (0x5e) and above are mapped to 126 (0x5e).
952 *
953 * We ASSUME that all VBoxManage status codes are in the range 0 thru 32.
954 *
955 * @note These are frozen as of 4.1.0.
956 * @note The guest exit code mappings was introduced with 5.0 and the 'run'
957 * command, they are/was not supported by 'exec'.
958 * @sa gctlRunCalculateExitCode
959 */
960/** Process exited normally but with an exit code <> 0. */
961#define EXITCODEEXEC_CODE ((RTEXITCODE)16)
962#define EXITCODEEXEC_FAILED ((RTEXITCODE)17)
963#define EXITCODEEXEC_TERM_SIGNAL ((RTEXITCODE)18)
964#define EXITCODEEXEC_TERM_ABEND ((RTEXITCODE)19)
965#define EXITCODEEXEC_TIMEOUT ((RTEXITCODE)20)
966#define EXITCODEEXEC_DOWN ((RTEXITCODE)21)
967/** Execution was interrupt by user (ctrl-c). */
968#define EXITCODEEXEC_CANCELED ((RTEXITCODE)22)
969/** The first mapped guest (non-zero) exit code. */
970#define EXITCODEEXEC_MAPPED_FIRST 33
971/** The last mapped guest (non-zero) exit code value (inclusive). */
972#define EXITCODEEXEC_MAPPED_LAST 125
973/** The number of exit codes from EXITCODEEXEC_MAPPED_FIRST to
974 * EXITCODEEXEC_MAPPED_LAST. This is also the highest guest exit code number
975 * we're able to map. */
976#define EXITCODEEXEC_MAPPED_RANGE (93)
977/** The guest exit code displacement value. */
978#define EXITCODEEXEC_MAPPED_DISPLACEMENT 32
979/** The guest exit code was too big to be mapped. */
980#define EXITCODEEXEC_MAPPED_BIG ((RTEXITCODE)126)
981/** @} */
982
983/**
984 * Calculates the exit code of VBoxManage.
985 *
986 * @returns The exit code to return.
987 * @param enmStatus The guest process status.
988 * @param uExitCode The associated guest process exit code (where
989 * applicable).
990 * @param fReturnExitCodes Set if we're to use the 32-126 range for guest
991 * exit codes.
992 */
993static RTEXITCODE gctlRunCalculateExitCode(ProcessStatus_T enmStatus, ULONG uExitCode, bool fReturnExitCodes)
994{
995 switch (enmStatus)
996 {
997 case ProcessStatus_TerminatedNormally:
998 if (uExitCode == 0)
999 return RTEXITCODE_SUCCESS;
1000 if (!fReturnExitCodes)
1001 return EXITCODEEXEC_CODE;
1002 if (uExitCode <= EXITCODEEXEC_MAPPED_RANGE)
1003 return (RTEXITCODE) (uExitCode + EXITCODEEXEC_MAPPED_DISPLACEMENT);
1004 return EXITCODEEXEC_MAPPED_BIG;
1005
1006 case ProcessStatus_TerminatedAbnormally:
1007 return EXITCODEEXEC_TERM_ABEND;
1008 case ProcessStatus_TerminatedSignal:
1009 return EXITCODEEXEC_TERM_SIGNAL;
1010
1011#if 0 /* see caller! */
1012 case ProcessStatus_TimedOutKilled:
1013 return EXITCODEEXEC_TIMEOUT;
1014 case ProcessStatus_Down:
1015 return EXITCODEEXEC_DOWN; /* Service/OS is stopping, process was killed. */
1016 case ProcessStatus_Error:
1017 return EXITCODEEXEC_FAILED;
1018
1019 /* The following is probably for detached? */
1020 case ProcessStatus_Starting:
1021 return RTEXITCODE_SUCCESS;
1022 case ProcessStatus_Started:
1023 return RTEXITCODE_SUCCESS;
1024 case ProcessStatus_Paused:
1025 return RTEXITCODE_SUCCESS;
1026 case ProcessStatus_Terminating:
1027 return RTEXITCODE_SUCCESS; /** @todo ???? */
1028#endif
1029
1030 default:
1031 AssertMsgFailed(("Unknown exit status (%u/%u) from guest process returned!\n", enmStatus, uExitCode));
1032 return RTEXITCODE_FAILURE;
1033 }
1034}
1035
1036
1037/**
1038 * Pumps guest output to the host.
1039 *
1040 * @return IPRT status code.
1041 * @param pProcess Pointer to appropriate process object.
1042 * @param hVfsIosDst Where to write the data. Can be the bit bucket or a (valid [std]) handle.
1043 * @param uHandle Handle where to read the data from.
1044 * @param cMsTimeout Timeout (in ms) to wait for the operation to
1045 * complete.
1046 */
1047static int gctlRunPumpOutput(IProcess *pProcess, RTVFSIOSTREAM hVfsIosDst, ULONG uHandle, RTMSINTERVAL cMsTimeout)
1048{
1049 AssertPtrReturn(pProcess, VERR_INVALID_POINTER);
1050 Assert(hVfsIosDst != NIL_RTVFSIOSTREAM);
1051
1052 int vrc;
1053
1054 SafeArray<BYTE> aOutputData;
1055 HRESULT hrc = pProcess->Read(uHandle, _64K, RT_MAX(cMsTimeout, 1), ComSafeArrayAsOutParam(aOutputData));
1056 if (SUCCEEDED(hrc))
1057 {
1058 size_t cbOutputData = aOutputData.size();
1059 if (cbOutputData == 0)
1060 vrc = VINF_SUCCESS;
1061 else
1062 {
1063 BYTE const *pbBuf = aOutputData.raw();
1064 AssertPtr(pbBuf);
1065
1066 vrc = RTVfsIoStrmWrite(hVfsIosDst, pbBuf, cbOutputData, true /*fBlocking*/, NULL);
1067 if (RT_FAILURE(vrc))
1068 RTMsgError(GuestCtrl::tr("Unable to write output, vrc=%Rrc\n"), vrc);
1069 }
1070 }
1071 else
1072 vrc = gctlPrintError(pProcess, COM_IIDOF(IProcess));
1073 return vrc;
1074}
1075
1076
1077/**
1078 * Configures a host handle for pumping guest bits.
1079 *
1080 * @returns true if enabled and we successfully configured it.
1081 * @param fEnabled Whether pumping this pipe is configured to std handles,
1082 * or going to the bit bucket instead.
1083 * @param enmHandle The IPRT standard handle designation.
1084 * @param pszName The name for user messages.
1085 * @param enmTransformation The transformation to apply.
1086 * @param phVfsIos Where to return the resulting I/O stream handle.
1087 */
1088static bool gctlRunSetupHandle(bool fEnabled, RTHANDLESTD enmHandle, const char *pszName,
1089 kStreamTransform enmTransformation, PRTVFSIOSTREAM phVfsIos)
1090{
1091 if (fEnabled)
1092 {
1093 int vrc = RTVfsIoStrmFromStdHandle(enmHandle, 0, true /*fLeaveOpen*/, phVfsIos);
1094 if (RT_SUCCESS(vrc))
1095 {
1096 if (enmTransformation != kStreamTransform_None)
1097 {
1098 RTMsgWarning(GuestCtrl::tr("Unsupported %s line ending conversion"), pszName);
1099 /** @todo Implement dos2unix and unix2dos stream filters. */
1100 }
1101 return true;
1102 }
1103 RTMsgWarning(GuestCtrl::tr("Error getting %s handle: %Rrc"), pszName, vrc);
1104 }
1105 else /* If disabled, all goes to / gets fed to/from the bit bucket. */
1106 {
1107 RTFILE hFile;
1108 int vrc = RTFileOpenBitBucket(&hFile, enmHandle == RTHANDLESTD_INPUT ? RTFILE_O_READ : RTFILE_O_WRITE);
1109 if (RT_SUCCESS(vrc))
1110 {
1111 vrc = RTVfsIoStrmFromRTFile(hFile, 0 /* fOpen */, false /* fLeaveOpen */, phVfsIos);
1112 if (RT_SUCCESS(vrc))
1113 return true;
1114 }
1115 }
1116
1117 return false;
1118}
1119
1120
1121/**
1122 * Returns the remaining time (in ms) based on the start time and a set
1123 * timeout value. Returns RT_INDEFINITE_WAIT if no timeout was specified.
1124 *
1125 * @return RTMSINTERVAL Time left (in ms).
1126 * @param u64StartMs Start time (in ms).
1127 * @param cMsTimeout Timeout value (in ms).
1128 */
1129static RTMSINTERVAL gctlRunGetRemainingTime(uint64_t u64StartMs, RTMSINTERVAL cMsTimeout)
1130{
1131 if (!cMsTimeout || cMsTimeout == RT_INDEFINITE_WAIT) /* If no timeout specified, wait forever. */
1132 return RT_INDEFINITE_WAIT;
1133
1134 uint64_t u64ElapsedMs = RTTimeMilliTS() - u64StartMs;
1135 if (u64ElapsedMs >= cMsTimeout)
1136 return 0;
1137
1138 return cMsTimeout - (RTMSINTERVAL)u64ElapsedMs;
1139}
1140
1141/**
1142 * Common handler for the 'run' and 'start' commands.
1143 *
1144 * @returns Command exit code.
1145 * @param pCtx Guest session context.
1146 * @param argc The argument count.
1147 * @param argv The argument vector for this command.
1148 * @param fRunCmd Set if it's 'run' clear if 'start'.
1149 */
1150static RTEXITCODE gctlHandleRunCommon(PGCTLCMDCTX pCtx, int argc, char **argv, bool fRunCmd)
1151{
1152 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1153
1154 /*
1155 * Parse arguments.
1156 */
1157 enum kGstCtrlRunOpt
1158 {
1159 kGstCtrlRunOpt_IgnoreOrphanedProcesses = 1000,
1160 kGstCtrlRunOpt_NoProfile, /** @todo Deprecated and will be removed soon; use kGstCtrlRunOpt_Profile instead, if needed. */
1161 kGstCtrlRunOpt_Profile,
1162 kGstCtrlRunOpt_Dos2Unix,
1163 kGstCtrlRunOpt_Unix2Dos,
1164 kGstCtrlRunOpt_WaitForStdOut,
1165 kGstCtrlRunOpt_NoWaitForStdOut,
1166 kGstCtrlRunOpt_WaitForStdErr,
1167 kGstCtrlRunOpt_NoWaitForStdErr
1168 };
1169 static const RTGETOPTDEF s_aOptions[] =
1170 {
1171 GCTLCMD_COMMON_OPTION_DEFS()
1172 { "--putenv", 'E', RTGETOPT_REQ_STRING },
1173 { "--exe", 'e', RTGETOPT_REQ_STRING },
1174 { "--timeout", 't', RTGETOPT_REQ_UINT32 },
1175 { "--unquoted-args", 'u', RTGETOPT_REQ_NOTHING },
1176 { "--ignore-operhaned-processes", kGstCtrlRunOpt_IgnoreOrphanedProcesses, RTGETOPT_REQ_NOTHING },
1177 { "--no-profile", kGstCtrlRunOpt_NoProfile, RTGETOPT_REQ_NOTHING }, /** @todo Deprecated. */
1178 { "--profile", kGstCtrlRunOpt_Profile, RTGETOPT_REQ_NOTHING },
1179 /* run only: 6 - options */
1180 { "--dos2unix", kGstCtrlRunOpt_Dos2Unix, RTGETOPT_REQ_NOTHING },
1181 { "--unix2dos", kGstCtrlRunOpt_Unix2Dos, RTGETOPT_REQ_NOTHING },
1182 { "--no-wait-stdout", kGstCtrlRunOpt_NoWaitForStdOut, RTGETOPT_REQ_NOTHING },
1183 { "--wait-stdout", kGstCtrlRunOpt_WaitForStdOut, RTGETOPT_REQ_NOTHING },
1184 { "--no-wait-stderr", kGstCtrlRunOpt_NoWaitForStdErr, RTGETOPT_REQ_NOTHING },
1185 { "--wait-stderr", kGstCtrlRunOpt_WaitForStdErr, RTGETOPT_REQ_NOTHING },
1186 };
1187
1188 /** @todo stdin handling. */
1189
1190 int ch;
1191 RTGETOPTUNION ValueUnion;
1192 RTGETOPTSTATE GetState;
1193 int vrc = RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions) - (fRunCmd ? 0 : 6),
1194 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1195 AssertRC(vrc);
1196
1197 com::SafeArray<ProcessCreateFlag_T> aCreateFlags;
1198 com::SafeArray<ProcessWaitForFlag_T> aWaitFlags;
1199 com::SafeArray<IN_BSTR> aArgs;
1200 com::SafeArray<IN_BSTR> aEnv;
1201 const char * pszImage = NULL;
1202 bool fWaitForStdOut = fRunCmd;
1203 bool fWaitForStdErr = fRunCmd;
1204 RTVFSIOSTREAM hVfsStdOut = NIL_RTVFSIOSTREAM;
1205 RTVFSIOSTREAM hVfsStdErr = NIL_RTVFSIOSTREAM;
1206 enum kStreamTransform enmStdOutTransform = kStreamTransform_None;
1207 enum kStreamTransform enmStdErrTransform = kStreamTransform_None;
1208 RTMSINTERVAL cMsTimeout = 0;
1209
1210 try
1211 {
1212 /* Wait for process start in any case. This is useful for scripting VBoxManage
1213 * when relying on its overall exit code. */
1214 aWaitFlags.push_back(ProcessWaitForFlag_Start);
1215
1216 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1217 {
1218 /* For options that require an argument, ValueUnion has received the value. */
1219 switch (ch)
1220 {
1221 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1222
1223 case 'E':
1224 if ( ValueUnion.psz[0] == '\0'
1225 || ValueUnion.psz[0] == '=')
1226 return errorSyntax(GuestCtrl::tr("Invalid argument variable[=value]: '%s'"), ValueUnion.psz);
1227 aEnv.push_back(Bstr(ValueUnion.psz).raw());
1228 break;
1229
1230 case kGstCtrlRunOpt_IgnoreOrphanedProcesses:
1231 aCreateFlags.push_back(ProcessCreateFlag_IgnoreOrphanedProcesses);
1232 break;
1233
1234 case kGstCtrlRunOpt_NoProfile:
1235 /** @todo Deprecated, will be removed. */
1236 RTPrintf(GuestCtrl::tr("Warning: Deprecated option \"--no-profile\" specified\n"));
1237 break;
1238
1239 case kGstCtrlRunOpt_Profile:
1240 aCreateFlags.push_back(ProcessCreateFlag_Profile);
1241 break;
1242
1243 case 'e':
1244 pszImage = ValueUnion.psz;
1245 break;
1246
1247 case 'u':
1248 aCreateFlags.push_back(ProcessCreateFlag_UnquotedArguments);
1249 break;
1250
1251 /** @todo Add a hidden flag. */
1252
1253 case 't': /* Timeout */
1254 cMsTimeout = ValueUnion.u32;
1255 break;
1256
1257 /* run only options: */
1258 case kGstCtrlRunOpt_Dos2Unix:
1259 Assert(fRunCmd);
1260 enmStdErrTransform = enmStdOutTransform = kStreamTransform_Dos2Unix;
1261 break;
1262 case kGstCtrlRunOpt_Unix2Dos:
1263 Assert(fRunCmd);
1264 enmStdErrTransform = enmStdOutTransform = kStreamTransform_Unix2Dos;
1265 break;
1266
1267 case kGstCtrlRunOpt_WaitForStdOut:
1268 Assert(fRunCmd);
1269 fWaitForStdOut = true;
1270 break;
1271 case kGstCtrlRunOpt_NoWaitForStdOut:
1272 Assert(fRunCmd);
1273 fWaitForStdOut = false;
1274 break;
1275
1276 case kGstCtrlRunOpt_WaitForStdErr:
1277 Assert(fRunCmd);
1278 fWaitForStdErr = true;
1279 break;
1280 case kGstCtrlRunOpt_NoWaitForStdErr:
1281 Assert(fRunCmd);
1282 fWaitForStdErr = false;
1283 break;
1284
1285 case VINF_GETOPT_NOT_OPTION:
1286 aArgs.push_back(Bstr(ValueUnion.psz).raw());
1287 if (!pszImage)
1288 {
1289 Assert(aArgs.size() == 1);
1290 pszImage = ValueUnion.psz;
1291 }
1292 break;
1293
1294 default:
1295 return errorGetOpt(ch, &ValueUnion);
1296
1297 } /* switch */
1298 } /* while RTGetOpt */
1299
1300 /* Must have something to execute. */
1301 if (!pszImage || !*pszImage)
1302 return errorSyntax(GuestCtrl::tr("No executable specified!"));
1303
1304 /*
1305 * Finalize process creation and wait flags and input/output streams.
1306 */
1307 if (!fRunCmd)
1308 {
1309 aCreateFlags.push_back(ProcessCreateFlag_WaitForProcessStartOnly);
1310 Assert(!fWaitForStdOut);
1311 Assert(!fWaitForStdErr);
1312 }
1313 else
1314 {
1315 aWaitFlags.push_back(ProcessWaitForFlag_Terminate);
1316 fWaitForStdOut = gctlRunSetupHandle(fWaitForStdOut, RTHANDLESTD_OUTPUT, "stdout", enmStdOutTransform, &hVfsStdOut);
1317 if (fWaitForStdOut)
1318 {
1319 aCreateFlags.push_back(ProcessCreateFlag_WaitForStdOut);
1320 aWaitFlags.push_back(ProcessWaitForFlag_StdOut);
1321 }
1322 fWaitForStdErr = gctlRunSetupHandle(fWaitForStdErr, RTHANDLESTD_ERROR, "stderr", enmStdErrTransform, &hVfsStdErr);
1323 if (fWaitForStdErr)
1324 {
1325 aCreateFlags.push_back(ProcessCreateFlag_WaitForStdErr);
1326 aWaitFlags.push_back(ProcessWaitForFlag_StdErr);
1327 }
1328 }
1329 }
1330 catch (std::bad_alloc &)
1331 {
1332 return RTMsgErrorExit(RTEXITCODE_FAILURE, "VERR_NO_MEMORY\n");
1333 }
1334
1335 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
1336 if (rcExit != RTEXITCODE_SUCCESS)
1337 return rcExit;
1338
1339 HRESULT hrc;
1340
1341 try
1342 {
1343 do
1344 {
1345 /* Get current time stamp to later calculate rest of timeout left. */
1346 uint64_t msStart = RTTimeMilliTS();
1347
1348 /*
1349 * Create the process.
1350 */
1351 if (pCtx->cVerbose)
1352 {
1353 if (cMsTimeout == 0)
1354 RTPrintf(GuestCtrl::tr("Starting guest process ...\n"));
1355 else
1356 RTPrintf(GuestCtrl::tr("Starting guest process (within %ums)\n"), cMsTimeout);
1357 }
1358 ComPtr<IGuestProcess> pProcess;
1359 CHECK_ERROR_BREAK(pCtx->pGuestSession, ProcessCreate(Bstr(pszImage).raw(),
1360 ComSafeArrayAsInParam(aArgs),
1361 ComSafeArrayAsInParam(aEnv),
1362 ComSafeArrayAsInParam(aCreateFlags),
1363 gctlRunGetRemainingTime(msStart, cMsTimeout),
1364 pProcess.asOutParam()));
1365
1366 /*
1367 * Explicitly wait for the guest process to be in a started state.
1368 */
1369 com::SafeArray<ProcessWaitForFlag_T> aWaitStartFlags;
1370 aWaitStartFlags.push_back(ProcessWaitForFlag_Start);
1371 ProcessWaitResult_T waitResult;
1372 CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitStartFlags),
1373 gctlRunGetRemainingTime(msStart, cMsTimeout), &waitResult));
1374
1375 ULONG uPID = 0;
1376 CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID));
1377 if (fRunCmd && pCtx->cVerbose)
1378 RTPrintf(GuestCtrl::tr("Process '%s' (PID %RU32) started\n"), pszImage, uPID);
1379 else if (!fRunCmd && pCtx->cVerbose)
1380 {
1381 /* Just print plain PID to make it easier for scripts
1382 * invoking VBoxManage. */
1383 RTPrintf(GuestCtrl::tr("[%RU32 - Session %RU32]\n"), uPID, pCtx->uSessionID);
1384 }
1385
1386 /*
1387 * Wait for process to exit/start...
1388 */
1389 RTMSINTERVAL cMsTimeLeft = 1; /* Will be calculated. */
1390 bool fReadStdOut = false;
1391 bool fReadStdErr = false;
1392 bool fCompleted = false;
1393 bool fCompletedStartCmd = false;
1394
1395 vrc = VINF_SUCCESS;
1396 while ( !fCompleted
1397 && cMsTimeLeft > 0)
1398 {
1399 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1400 CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitFlags),
1401 RT_MIN(500 /*ms*/, RT_MAX(cMsTimeLeft, 1 /*ms*/)),
1402 &waitResult));
1403 if (pCtx->cVerbose)
1404 RTPrintf(GuestCtrl::tr("waitResult: %d\n"), waitResult);
1405 switch (waitResult)
1406 {
1407 case ProcessWaitResult_Start: /** @todo you always wait for 'start', */
1408 fCompletedStartCmd = fCompleted = !fRunCmd; /* Only wait for startup if the 'start' command. */
1409 if (!fCompleted && aWaitFlags[0] == ProcessWaitForFlag_Start)
1410 aWaitFlags[0] = ProcessWaitForFlag_Terminate;
1411 break;
1412 case ProcessWaitResult_StdOut:
1413 fReadStdOut = true;
1414 break;
1415 case ProcessWaitResult_StdErr:
1416 fReadStdErr = true;
1417 break;
1418 case ProcessWaitResult_Terminate:
1419 if (pCtx->cVerbose)
1420 RTPrintf(GuestCtrl::tr("Process terminated\n"));
1421 /* Process terminated, we're done. */
1422 fCompleted = true;
1423 break;
1424 case ProcessWaitResult_WaitFlagNotSupported:
1425 /* The guest does not support waiting for stdout/err, so
1426 * yield to reduce the CPU load due to busy waiting. */
1427 RTThreadYield();
1428 fReadStdOut = fReadStdErr = true;
1429 /* Note: In case the user specified explicitly not wanting to wait for stdout / stderr,
1430 * the configured VFS handle goes to / will be fed from the bit bucket. */
1431 break;
1432 case ProcessWaitResult_Timeout:
1433 {
1434 /** @todo It is really unclear whether we will get stuck with the timeout
1435 * result here if the guest side times out the process and fails to
1436 * kill the process... To be on the save side, double the IPC and
1437 * check the process status every time we time out. */
1438 ProcessStatus_T enmProcStatus;
1439 CHECK_ERROR_BREAK(pProcess, COMGETTER(Status)(&enmProcStatus));
1440 if ( enmProcStatus == ProcessStatus_TimedOutKilled
1441 || enmProcStatus == ProcessStatus_TimedOutAbnormally)
1442 fCompleted = true;
1443 fReadStdOut = fReadStdErr = true;
1444 break;
1445 }
1446 case ProcessWaitResult_Status:
1447 /* ignore. */
1448 break;
1449 case ProcessWaitResult_Error:
1450 /* waitFor is dead in the water, I think, so better leave the loop. */
1451 vrc = VERR_CALLBACK_RETURN;
1452 break;
1453
1454 case ProcessWaitResult_StdIn: AssertFailed(); /* did ask for this! */ break;
1455 case ProcessWaitResult_None: AssertFailed(); /* used. */ break;
1456 default: AssertFailed(); /* huh? */ break;
1457 }
1458
1459 if (g_fGuestCtrlCanceled)
1460 break;
1461
1462 /*
1463 * Pump output as needed.
1464 */
1465 if (fReadStdOut)
1466 {
1467 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1468 int vrc2 = gctlRunPumpOutput(pProcess, hVfsStdOut, 1 /* StdOut */, cMsTimeLeft);
1469 if (RT_FAILURE(vrc2) && RT_SUCCESS(vrc))
1470 vrc = vrc2;
1471 fReadStdOut = false;
1472 }
1473 if (fReadStdErr)
1474 {
1475 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1476 int vrc2 = gctlRunPumpOutput(pProcess, hVfsStdErr, 2 /* StdErr */, cMsTimeLeft);
1477 if (RT_FAILURE(vrc2) && RT_SUCCESS(vrc))
1478 vrc = vrc2;
1479 fReadStdErr = false;
1480 }
1481 if ( RT_FAILURE(vrc)
1482 || g_fGuestCtrlCanceled)
1483 break;
1484
1485 /*
1486 * Process events before looping.
1487 */
1488 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
1489 } /* while */
1490
1491 /*
1492 * Report status back to the user.
1493 */
1494 if (g_fGuestCtrlCanceled)
1495 {
1496 if (pCtx->cVerbose)
1497 RTPrintf(GuestCtrl::tr("Process execution aborted!\n"));
1498 rcExit = EXITCODEEXEC_CANCELED;
1499 }
1500 else if (fCompletedStartCmd)
1501 {
1502 if (pCtx->cVerbose)
1503 RTPrintf(GuestCtrl::tr("Process successfully started!\n"));
1504 rcExit = RTEXITCODE_SUCCESS;
1505 }
1506 else if (fCompleted)
1507 {
1508 ProcessStatus_T procStatus;
1509 CHECK_ERROR_BREAK(pProcess, COMGETTER(Status)(&procStatus));
1510 if ( procStatus == ProcessStatus_TerminatedNormally
1511 || procStatus == ProcessStatus_TerminatedAbnormally
1512 || procStatus == ProcessStatus_TerminatedSignal)
1513 {
1514 LONG lExitCode;
1515 CHECK_ERROR_BREAK(pProcess, COMGETTER(ExitCode)(&lExitCode));
1516 if (pCtx->cVerbose)
1517 RTPrintf(GuestCtrl::tr("Exit code=%u (Status=%u [%s])\n"),
1518 lExitCode, procStatus, gctlProcessStatusToText(procStatus));
1519
1520 rcExit = gctlRunCalculateExitCode(procStatus, lExitCode, true /*fReturnExitCodes*/);
1521 }
1522 else if ( procStatus == ProcessStatus_TimedOutKilled
1523 || procStatus == ProcessStatus_TimedOutAbnormally)
1524 {
1525 if (pCtx->cVerbose)
1526 RTPrintf(GuestCtrl::tr("Process timed out (guest side) and %s\n"),
1527 procStatus == ProcessStatus_TimedOutAbnormally
1528 ? GuestCtrl::tr("failed to terminate so far") : GuestCtrl::tr("was terminated"));
1529 rcExit = EXITCODEEXEC_TIMEOUT;
1530 }
1531 else
1532 {
1533 if (pCtx->cVerbose)
1534 RTPrintf(GuestCtrl::tr("Process now is in status [%s] (unexpected)\n"),
1535 gctlProcessStatusToText(procStatus));
1536 rcExit = RTEXITCODE_FAILURE;
1537 }
1538 }
1539 else if (RT_FAILURE_NP(vrc))
1540 {
1541 if (pCtx->cVerbose)
1542 RTPrintf(GuestCtrl::tr("Process monitor loop quit with vrc=%Rrc\n"), vrc);
1543 rcExit = RTEXITCODE_FAILURE;
1544 }
1545 else
1546 {
1547 if (pCtx->cVerbose)
1548 RTPrintf(GuestCtrl::tr("Process monitor loop timed out\n"));
1549 rcExit = EXITCODEEXEC_TIMEOUT;
1550 }
1551
1552 } while (0);
1553 }
1554 catch (std::bad_alloc &)
1555 {
1556 hrc = E_OUTOFMEMORY;
1557 }
1558
1559 /*
1560 * Decide what to do with the guest session.
1561 *
1562 * If it's the 'start' command where detach the guest process after
1563 * starting, don't close the guest session it is part of, except on
1564 * failure or ctrl-c.
1565 *
1566 * For the 'run' command the guest process quits with us.
1567 */
1568 if (!fRunCmd && SUCCEEDED(hrc) && !g_fGuestCtrlCanceled)
1569 pCtx->fDetachGuestSession = true;
1570
1571 /* Make sure we return failure on failure. */
1572 if (FAILED(hrc) && rcExit == RTEXITCODE_SUCCESS)
1573 rcExit = RTEXITCODE_FAILURE;
1574 return rcExit;
1575}
1576
1577
1578static DECLCALLBACK(RTEXITCODE) gctlHandleRun(PGCTLCMDCTX pCtx, int argc, char **argv)
1579{
1580 return gctlHandleRunCommon(pCtx, argc, argv, true /*fRunCmd*/);
1581}
1582
1583
1584static DECLCALLBACK(RTEXITCODE) gctlHandleStart(PGCTLCMDCTX pCtx, int argc, char **argv)
1585{
1586 return gctlHandleRunCommon(pCtx, argc, argv, false /*fRunCmd*/);
1587}
1588
1589
1590static RTEXITCODE gctlHandleCopy(PGCTLCMDCTX pCtx, int argc, char **argv, bool fHostToGuest)
1591{
1592 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1593
1594 /*
1595 * IGuest::CopyToGuest is kept as simple as possible to let the developer choose
1596 * what and how to implement the file enumeration/recursive lookup, like VBoxManage
1597 * does in here.
1598 */
1599 static const RTGETOPTDEF s_aOptions[] =
1600 {
1601 GCTLCMD_COMMON_OPTION_DEFS()
1602 { "--follow", 'L', RTGETOPT_REQ_NOTHING }, /* Kept for backwards-compatibility (VBox < 7.0). */
1603 { "--dereference", 'L', RTGETOPT_REQ_NOTHING },
1604 { "--no-replace", 'n', RTGETOPT_REQ_NOTHING }, /* like "-n" via cp. */
1605 { "--recursive", 'R', RTGETOPT_REQ_NOTHING },
1606 { "--target-directory", 't', RTGETOPT_REQ_STRING },
1607 { "--update", 'u', RTGETOPT_REQ_NOTHING } /* like "-u" via cp. */
1608 };
1609
1610 int ch;
1611 RTGETOPTUNION ValueUnion;
1612 RTGETOPTSTATE GetState;
1613 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1614
1615 bool fDstMustBeDir = false;
1616 const char *pszDst = NULL;
1617 bool fFollow = false;
1618 bool fRecursive = false;
1619 bool fUpdate = false; /* Whether to copy the file only if it's newer than the target. */
1620 bool fNoReplace = false; /* Only copy the file if it does not exist yet. */
1621
1622 int vrc = VINF_SUCCESS;
1623 while ( (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
1624 && ch != VINF_GETOPT_NOT_OPTION)
1625 {
1626 /* For options that require an argument, ValueUnion has received the value. */
1627 switch (ch)
1628 {
1629 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1630
1631 case 'L':
1632 if (!RTStrICmp(ValueUnion.pDef->pszLong, "--follow"))
1633 RTMsgWarning("--follow is deprecated; use --dereference instead.");
1634 fFollow = true;
1635 break;
1636
1637 case 'n':
1638 fNoReplace = true;
1639 break;
1640
1641 case 'R':
1642 fRecursive = true;
1643 break;
1644
1645 case 't':
1646 pszDst = ValueUnion.psz;
1647 fDstMustBeDir = true;
1648 break;
1649
1650 case 'u':
1651 fUpdate = true;
1652 break;
1653
1654 default:
1655 return errorGetOpt(ch, &ValueUnion);
1656 }
1657 }
1658
1659 char **papszSources = RTGetOptNonOptionArrayPtr(&GetState);
1660 size_t cSources = &argv[argc] - papszSources;
1661
1662 if (!cSources)
1663 return errorSyntax(GuestCtrl::tr("No sources specified!"));
1664
1665 /* Unless a --target-directory is given, the last argument is the destination, so
1666 bump it from the source list. */
1667 if (pszDst == NULL && cSources >= 2)
1668 pszDst = papszSources[--cSources];
1669
1670 if (pszDst == NULL)
1671 return errorSyntax(GuestCtrl::tr("No destination specified!"));
1672
1673 char szAbsDst[RTPATH_MAX];
1674 if (!fHostToGuest)
1675 {
1676 vrc = RTPathAbs(pszDst, szAbsDst, sizeof(szAbsDst));
1677 if (RT_SUCCESS(vrc))
1678 pszDst = szAbsDst;
1679 else
1680 return RTMsgErrorExitFailure(GuestCtrl::tr("RTPathAbs failed on '%s': %Rrc"), pszDst, vrc);
1681 }
1682
1683 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
1684 if (rcExit != RTEXITCODE_SUCCESS)
1685 return rcExit;
1686
1687 /*
1688 * Done parsing arguments, do some more preparations.
1689 */
1690 if (pCtx->cVerbose)
1691 {
1692 if (fHostToGuest)
1693 RTPrintf(GuestCtrl::tr("Copying from host to guest ...\n"));
1694 else
1695 RTPrintf(GuestCtrl::tr("Copying from guest to host ...\n"));
1696 }
1697
1698 HRESULT hrc = S_OK;
1699
1700 com::SafeArray<IN_BSTR> aSources;
1701 com::SafeArray<IN_BSTR> aFilters; /** @todo Populate those? For now we use caller-based globbing. */
1702 com::SafeArray<IN_BSTR> aCopyFlags;
1703
1704 size_t iSrc = 0;
1705 for (; iSrc < cSources; iSrc++)
1706 {
1707 aSources.push_back(Bstr(papszSources[iSrc]).raw());
1708 aFilters.push_back(Bstr("").raw()); /* Empty for now. See @todo above. */
1709
1710 /* Compile the comma-separated list of flags.
1711 * Certain flags are only available for specific file system objects, e.g. directories. */
1712 bool fIsDir = false;
1713 if (fHostToGuest)
1714 {
1715 RTFSOBJINFO ObjInfo;
1716 vrc = RTPathQueryInfo(papszSources[iSrc], &ObjInfo, RTFSOBJATTRADD_NOTHING);
1717 if (RT_SUCCESS(vrc))
1718 fIsDir = RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode);
1719
1720 if (RT_FAILURE(vrc))
1721 break;
1722 }
1723 else /* Guest to host. */
1724 {
1725 ComPtr<IGuestFsObjInfo> pFsObjInfo;
1726 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(papszSources[iSrc]).raw(), RT_BOOL(fFollow) /* fFollowSymlinks */,
1727 pFsObjInfo.asOutParam());
1728 if (SUCCEEDED(hrc))
1729 {
1730 FsObjType_T enmObjType;
1731 CHECK_ERROR(pFsObjInfo,COMGETTER(Type)(&enmObjType));
1732 if (SUCCEEDED(hrc))
1733 {
1734 /* Take action according to source file. */
1735 fIsDir = enmObjType == FsObjType_Directory;
1736 }
1737 }
1738
1739 if (FAILED(hrc))
1740 {
1741 vrc = gctlPrintError(pCtx->pGuestSession, COM_IIDOF(IGuestSession));
1742 break;
1743 }
1744 }
1745
1746 if (pCtx->cVerbose)
1747 RTPrintf(GuestCtrl::tr("Source '%s' is a %s\n"), papszSources[iSrc], fIsDir ? "directory" : "file");
1748
1749 Utf8Str strCopyFlags;
1750 if (fRecursive && fIsDir) /* Only available for directories. Just ignore otherwise. */
1751 strCopyFlags += "Recursive,";
1752 if (fFollow)
1753 strCopyFlags += "FollowLinks,";
1754 if (fUpdate) /* Only copy source files which are newer than the destination file. */
1755 strCopyFlags += "Update,";
1756 if (fNoReplace) /* Do not overwrite files. */
1757 strCopyFlags += "NoReplace,";
1758 else if (!fNoReplace && fIsDir)
1759 strCopyFlags += "CopyIntoExisting,"; /* Only copy into existing directories if "--no-replace" isn't specified. */
1760 aCopyFlags.push_back(Bstr(strCopyFlags).raw());
1761 }
1762
1763 if (RT_FAILURE(vrc))
1764 return RTMsgErrorExitFailure(GuestCtrl::tr("Error looking file system information for source '%s', vrc=%Rrc"),
1765 papszSources[iSrc], vrc);
1766
1767 ComPtr<IProgress> pProgress;
1768 if (fHostToGuest)
1769 {
1770 hrc = pCtx->pGuestSession->CopyToGuest(ComSafeArrayAsInParam(aSources),
1771 ComSafeArrayAsInParam(aFilters), ComSafeArrayAsInParam(aCopyFlags),
1772 Bstr(pszDst).raw(), pProgress.asOutParam());
1773 }
1774 else /* Guest to host. */
1775 {
1776 hrc = pCtx->pGuestSession->CopyFromGuest(ComSafeArrayAsInParam(aSources),
1777 ComSafeArrayAsInParam(aFilters), ComSafeArrayAsInParam(aCopyFlags),
1778 Bstr(pszDst).raw(), pProgress.asOutParam());
1779 }
1780
1781 if (FAILED(hrc))
1782 {
1783 vrc = gctlPrintError(pCtx->pGuestSession, COM_IIDOF(IGuestSession));
1784 }
1785 else if (pProgress.isNotNull())
1786 {
1787 if (pCtx->cVerbose)
1788 hrc = showProgress(pProgress);
1789 else
1790 hrc = pProgress->WaitForCompletion(-1 /* No timeout */);
1791 if (SUCCEEDED(hrc))
1792 CHECK_PROGRESS_ERROR(pProgress, (GuestCtrl::tr("File copy failed")));
1793 vrc = gctlPrintProgressError(pProgress);
1794 }
1795
1796 if (RT_FAILURE(vrc))
1797 rcExit = RTEXITCODE_FAILURE;
1798
1799 return rcExit;
1800}
1801
1802static DECLCALLBACK(RTEXITCODE) gctlHandleCopyFrom(PGCTLCMDCTX pCtx, int argc, char **argv)
1803{
1804 return gctlHandleCopy(pCtx, argc, argv, false /* Guest to host */);
1805}
1806
1807static DECLCALLBACK(RTEXITCODE) gctlHandleCopyTo(PGCTLCMDCTX pCtx, int argc, char **argv)
1808{
1809 return gctlHandleCopy(pCtx, argc, argv, true /* Host to guest */);
1810}
1811
1812static DECLCALLBACK(RTEXITCODE) gctrlHandleMkDir(PGCTLCMDCTX pCtx, int argc, char **argv)
1813{
1814 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1815
1816 static const RTGETOPTDEF s_aOptions[] =
1817 {
1818 GCTLCMD_COMMON_OPTION_DEFS()
1819 { "--mode", 'm', RTGETOPT_REQ_UINT32 },
1820 { "--parents", 'P', RTGETOPT_REQ_NOTHING }
1821 };
1822
1823 int ch;
1824 RTGETOPTUNION ValueUnion;
1825 RTGETOPTSTATE GetState;
1826 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1827
1828 SafeArray<DirectoryCreateFlag_T> aDirCreateFlags;
1829 uint32_t fDirMode = 0; /* Default mode. */
1830 uint32_t cDirsCreated = 0;
1831 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
1832
1833 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1834 {
1835 /* For options that require an argument, ValueUnion has received the value. */
1836 switch (ch)
1837 {
1838 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1839
1840 case 'm': /* Mode */
1841 fDirMode = ValueUnion.u32;
1842 break;
1843
1844 case 'P': /* Create parents */
1845 aDirCreateFlags.push_back(DirectoryCreateFlag_Parents);
1846 break;
1847
1848 case VINF_GETOPT_NOT_OPTION:
1849 if (cDirsCreated == 0)
1850 {
1851 /*
1852 * First non-option - no more options now.
1853 */
1854 rcExit = gctlCtxPostOptionParsingInit(pCtx);
1855 if (rcExit != RTEXITCODE_SUCCESS)
1856 return rcExit;
1857 if (pCtx->cVerbose)
1858 RTPrintf(GuestCtrl::tr("Creating %RU32 directories...\n", "", argc - GetState.iNext + 1),
1859 argc - GetState.iNext + 1);
1860 }
1861 if (g_fGuestCtrlCanceled)
1862 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("mkdir was interrupted by Ctrl-C (%u left)\n"),
1863 argc - GetState.iNext + 1);
1864
1865 /*
1866 * Create the specified directory.
1867 *
1868 * On failure we'll change the exit status to failure and
1869 * continue with the next directory that needs creating. We do
1870 * this because we only create new things, and because this is
1871 * how /bin/mkdir works on unix.
1872 */
1873 cDirsCreated++;
1874 if (pCtx->cVerbose)
1875 RTPrintf(GuestCtrl::tr("Creating directory \"%s\" ...\n"), ValueUnion.psz);
1876 try
1877 {
1878 HRESULT hrc;
1879 CHECK_ERROR(pCtx->pGuestSession, DirectoryCreate(Bstr(ValueUnion.psz).raw(),
1880 fDirMode, ComSafeArrayAsInParam(aDirCreateFlags)));
1881 if (FAILED(hrc))
1882 rcExit = RTEXITCODE_FAILURE;
1883 }
1884 catch (std::bad_alloc &)
1885 {
1886 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
1887 }
1888 break;
1889
1890 default:
1891 return errorGetOpt(ch, &ValueUnion);
1892 }
1893 }
1894
1895 if (!cDirsCreated)
1896 return errorSyntax(GuestCtrl::tr("No directory to create specified!"));
1897 return rcExit;
1898}
1899
1900
1901static DECLCALLBACK(RTEXITCODE) gctlHandleRmDir(PGCTLCMDCTX pCtx, int argc, char **argv)
1902{
1903 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1904
1905 static const RTGETOPTDEF s_aOptions[] =
1906 {
1907 GCTLCMD_COMMON_OPTION_DEFS()
1908 { "--recursive", 'R', RTGETOPT_REQ_NOTHING },
1909 };
1910
1911 int ch;
1912 RTGETOPTUNION ValueUnion;
1913 RTGETOPTSTATE GetState;
1914 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1915
1916 bool fRecursive = false;
1917 uint32_t cDirRemoved = 0;
1918 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
1919
1920 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1921 {
1922 /* For options that require an argument, ValueUnion has received the value. */
1923 switch (ch)
1924 {
1925 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1926
1927 case 'R':
1928 fRecursive = true;
1929 break;
1930
1931 case VINF_GETOPT_NOT_OPTION:
1932 {
1933 if (cDirRemoved == 0)
1934 {
1935 /*
1936 * First non-option - no more options now.
1937 */
1938 rcExit = gctlCtxPostOptionParsingInit(pCtx);
1939 if (rcExit != RTEXITCODE_SUCCESS)
1940 return rcExit;
1941 if (pCtx->cVerbose)
1942 {
1943 if (fRecursive)
1944 RTPrintf(GuestCtrl::tr("Removing %RU32 directory tree(s)...\n", "", argc - GetState.iNext + 1),
1945 argc - GetState.iNext + 1);
1946 else
1947 RTPrintf(GuestCtrl::tr("Removing %RU32 directorie(s)...\n", "", argc - GetState.iNext + 1),
1948 argc - GetState.iNext + 1);
1949 }
1950 }
1951 if (g_fGuestCtrlCanceled)
1952 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("rmdir was interrupted by Ctrl-C (%u left)\n"),
1953 argc - GetState.iNext + 1);
1954
1955 cDirRemoved++;
1956 HRESULT hrc;
1957 if (!fRecursive)
1958 {
1959 /*
1960 * Remove exactly one directory.
1961 */
1962 if (pCtx->cVerbose)
1963 RTPrintf(GuestCtrl::tr("Removing directory \"%s\" ...\n"), ValueUnion.psz);
1964 try
1965 {
1966 CHECK_ERROR(pCtx->pGuestSession, DirectoryRemove(Bstr(ValueUnion.psz).raw()));
1967 }
1968 catch (std::bad_alloc &)
1969 {
1970 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
1971 }
1972 }
1973 else
1974 {
1975 /*
1976 * Remove the directory and anything under it, that means files
1977 * and everything. This is in the tradition of the Windows NT
1978 * CMD.EXE "rmdir /s" operation, a tradition which jpsoft's TCC
1979 * strongly warns against (and half-ways questions the sense of).
1980 */
1981 if (pCtx->cVerbose)
1982 RTPrintf(GuestCtrl::tr("Recursively removing directory \"%s\" ...\n"), ValueUnion.psz);
1983 try
1984 {
1985 /** @todo Make flags configurable. */
1986 com::SafeArray<DirectoryRemoveRecFlag_T> aRemRecFlags;
1987 aRemRecFlags.push_back(DirectoryRemoveRecFlag_ContentAndDir);
1988
1989 ComPtr<IProgress> ptrProgress;
1990 CHECK_ERROR(pCtx->pGuestSession, DirectoryRemoveRecursive(Bstr(ValueUnion.psz).raw(),
1991 ComSafeArrayAsInParam(aRemRecFlags),
1992 ptrProgress.asOutParam()));
1993 if (SUCCEEDED(hrc))
1994 {
1995 if (pCtx->cVerbose)
1996 hrc = showProgress(ptrProgress);
1997 else
1998 hrc = ptrProgress->WaitForCompletion(-1 /* indefinitely */);
1999 if (SUCCEEDED(hrc))
2000 CHECK_PROGRESS_ERROR(ptrProgress, (GuestCtrl::tr("Directory deletion failed")));
2001 ptrProgress.setNull();
2002 }
2003 }
2004 catch (std::bad_alloc &)
2005 {
2006 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory during recursive rmdir\n"));
2007 }
2008 }
2009
2010 /*
2011 * This command returns immediately on failure since it's destructive in nature.
2012 */
2013 if (FAILED(hrc))
2014 return RTEXITCODE_FAILURE;
2015 break;
2016 }
2017
2018 default:
2019 return errorGetOpt(ch, &ValueUnion);
2020 }
2021 }
2022
2023 if (!cDirRemoved)
2024 return errorSyntax(GuestCtrl::tr("No directory to remove specified!"));
2025 return rcExit;
2026}
2027
2028static DECLCALLBACK(RTEXITCODE) gctlHandleRm(PGCTLCMDCTX pCtx, int argc, char **argv)
2029{
2030 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2031
2032 static const RTGETOPTDEF s_aOptions[] =
2033 {
2034 GCTLCMD_COMMON_OPTION_DEFS()
2035 { "--force", 'f', RTGETOPT_REQ_NOTHING, },
2036 };
2037
2038 int ch;
2039 RTGETOPTUNION ValueUnion;
2040 RTGETOPTSTATE GetState;
2041 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2042
2043 uint32_t cFilesDeleted = 0;
2044 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
2045 bool fForce = true;
2046
2047 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
2048 {
2049 /* For options that require an argument, ValueUnion has received the value. */
2050 switch (ch)
2051 {
2052 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2053
2054 case VINF_GETOPT_NOT_OPTION:
2055 if (cFilesDeleted == 0)
2056 {
2057 /*
2058 * First non-option - no more options now.
2059 */
2060 rcExit = gctlCtxPostOptionParsingInit(pCtx);
2061 if (rcExit != RTEXITCODE_SUCCESS)
2062 return rcExit;
2063 if (pCtx->cVerbose)
2064 RTPrintf(GuestCtrl::tr("Removing %RU32 file(s)...\n", "", argc - GetState.iNext + 1),
2065 argc - GetState.iNext + 1);
2066 }
2067 if (g_fGuestCtrlCanceled)
2068 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("rm was interrupted by Ctrl-C (%u left)\n"),
2069 argc - GetState.iNext + 1);
2070
2071 /*
2072 * Remove the specified file.
2073 *
2074 * On failure we will by default stop, however, the force option will
2075 * by unix traditions force us to ignore errors and continue.
2076 */
2077 cFilesDeleted++;
2078 if (pCtx->cVerbose)
2079 RTPrintf(GuestCtrl::tr("Removing file \"%s\" ...\n", ValueUnion.psz));
2080 try
2081 {
2082 /** @todo How does IGuestSession::FsObjRemove work with read-only files? Do we
2083 * need to do some chmod or whatever to better emulate the --force flag? */
2084 HRESULT hrc;
2085 CHECK_ERROR(pCtx->pGuestSession, FsObjRemove(Bstr(ValueUnion.psz).raw()));
2086 if (FAILED(hrc) && !fForce)
2087 return RTEXITCODE_FAILURE;
2088 }
2089 catch (std::bad_alloc &)
2090 {
2091 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
2092 }
2093 break;
2094
2095 default:
2096 return errorGetOpt(ch, &ValueUnion);
2097 }
2098 }
2099
2100 if (!cFilesDeleted && !fForce)
2101 return errorSyntax(GuestCtrl::tr("No file to remove specified!"));
2102 return rcExit;
2103}
2104
2105static DECLCALLBACK(RTEXITCODE) gctlHandleMv(PGCTLCMDCTX pCtx, int argc, char **argv)
2106{
2107 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2108
2109 static const RTGETOPTDEF s_aOptions[] =
2110 {
2111 GCTLCMD_COMMON_OPTION_DEFS()
2112/** @todo Missing --force/-f flag. */
2113 };
2114
2115 int ch;
2116 RTGETOPTUNION ValueUnion;
2117 RTGETOPTSTATE GetState;
2118 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2119
2120 int vrc = VINF_SUCCESS;
2121
2122 bool fDryrun = false;
2123 std::vector< Utf8Str > vecSources;
2124 const char *pszDst = NULL;
2125 com::SafeArray<FsObjRenameFlag_T> aRenameFlags;
2126
2127 try
2128 {
2129 /** @todo Make flags configurable. */
2130 aRenameFlags.push_back(FsObjRenameFlag_NoReplace);
2131
2132 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
2133 && RT_SUCCESS(vrc))
2134 {
2135 /* For options that require an argument, ValueUnion has received the value. */
2136 switch (ch)
2137 {
2138 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2139
2140 /** @todo Implement a --dryrun command. */
2141 /** @todo Implement rename flags. */
2142
2143 case VINF_GETOPT_NOT_OPTION:
2144 vecSources.push_back(Utf8Str(ValueUnion.psz));
2145 pszDst = ValueUnion.psz;
2146 break;
2147
2148 default:
2149 return errorGetOpt(ch, &ValueUnion);
2150 }
2151 }
2152 }
2153 catch (std::bad_alloc &)
2154 {
2155 vrc = VERR_NO_MEMORY;
2156 }
2157
2158 if (RT_FAILURE(vrc))
2159 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Failed to initialize, vrc=%Rrc\n"), vrc);
2160
2161 size_t cSources = vecSources.size();
2162 if (!cSources)
2163 return errorSyntax(GuestCtrl::tr("No source(s) to move specified!"));
2164 if (cSources < 2)
2165 return errorSyntax(GuestCtrl::tr("No destination specified!"));
2166
2167 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2168 if (rcExit != RTEXITCODE_SUCCESS)
2169 return rcExit;
2170
2171 /* Delete last element, which now is the destination. */
2172 vecSources.pop_back();
2173 cSources = vecSources.size();
2174
2175 HRESULT hrc = S_OK;
2176
2177 /* Destination must be a directory when specifying multiple sources. */
2178 if (cSources > 1)
2179 {
2180 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2181 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(pszDst).raw(), FALSE /*followSymlinks*/, pFsObjInfo.asOutParam());
2182 if (FAILED(hrc))
2183 {
2184 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Destination does not exist\n"));
2185 }
2186 else
2187 {
2188 FsObjType_T enmObjType = FsObjType_Unknown; /* Shut up MSC */
2189 hrc = pFsObjInfo->COMGETTER(Type)(&enmObjType);
2190 if (SUCCEEDED(hrc))
2191 {
2192 if (enmObjType != FsObjType_Directory)
2193 return RTMsgErrorExit(RTEXITCODE_FAILURE,
2194 GuestCtrl::tr("Destination must be a directory when specifying multiple sources\n"));
2195 }
2196 else
2197 return RTMsgErrorExit(RTEXITCODE_FAILURE,
2198 GuestCtrl::tr("Unable to determine destination type: %Rhrc\n"),
2199 hrc);
2200 }
2201 }
2202
2203 /*
2204 * Rename (move) the entries.
2205 */
2206 if (pCtx->cVerbose)
2207 RTPrintf(GuestCtrl::tr("Renaming %RU32 %s ...\n"), cSources,
2208 cSources > 1 ? GuestCtrl::tr("sources", "", cSources) : GuestCtrl::tr("source"));
2209
2210 std::vector< Utf8Str >::iterator it = vecSources.begin();
2211 while ( it != vecSources.end()
2212 && !g_fGuestCtrlCanceled)
2213 {
2214 Utf8Str strSrcCur = (*it);
2215
2216 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2217 FsObjType_T enmObjType = FsObjType_Unknown; /* Shut up MSC */
2218 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(strSrcCur).raw(), FALSE /*followSymlinks*/, pFsObjInfo.asOutParam());
2219 if (SUCCEEDED(hrc))
2220 hrc = pFsObjInfo->COMGETTER(Type)(&enmObjType);
2221 if (FAILED(hrc))
2222 {
2223 RTPrintf(GuestCtrl::tr("Cannot stat \"%s\": No such file or directory\n"), strSrcCur.c_str());
2224 ++it;
2225 continue; /* Skip. */
2226 }
2227
2228 char *pszDstCur = NULL;
2229
2230 if (cSources > 1)
2231 {
2232 pszDstCur = RTPathJoinA(pszDst, RTPathFilename(strSrcCur.c_str()));
2233 }
2234 else
2235 pszDstCur = RTStrDup(pszDst);
2236
2237 AssertPtrBreakStmt(pszDstCur, VERR_NO_MEMORY);
2238
2239 if (pCtx->cVerbose)
2240 RTPrintf(GuestCtrl::tr("Renaming %s \"%s\" to \"%s\" ...\n"),
2241 enmObjType == FsObjType_Directory ? GuestCtrl::tr("directory", "object") : GuestCtrl::tr("file","object"),
2242 strSrcCur.c_str(), pszDstCur);
2243
2244 if (!fDryrun)
2245 {
2246 CHECK_ERROR(pCtx->pGuestSession, FsObjRename(Bstr(strSrcCur).raw(),
2247 Bstr(pszDstCur).raw(),
2248 ComSafeArrayAsInParam(aRenameFlags)));
2249 /* Keep going with next item in case of errors. */
2250 }
2251
2252 RTStrFree(pszDstCur);
2253
2254 ++it;
2255 }
2256
2257 if ( (it != vecSources.end())
2258 && pCtx->cVerbose)
2259 {
2260 RTPrintf(GuestCtrl::tr("Warning: Not all sources were renamed\n"));
2261 }
2262
2263 return FAILED(hrc) ? RTEXITCODE_FAILURE : RTEXITCODE_SUCCESS;
2264}
2265
2266static DECLCALLBACK(RTEXITCODE) gctlHandleMkTemp(PGCTLCMDCTX pCtx, int argc, char **argv)
2267{
2268 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2269
2270 static const RTGETOPTDEF s_aOptions[] =
2271 {
2272 GCTLCMD_COMMON_OPTION_DEFS()
2273 { "--mode", 'm', RTGETOPT_REQ_UINT32 },
2274 { "--directory", 'D', RTGETOPT_REQ_NOTHING },
2275 { "--secure", 's', RTGETOPT_REQ_NOTHING },
2276 { "--tmpdir", 't', RTGETOPT_REQ_STRING }
2277 };
2278
2279 int ch;
2280 RTGETOPTUNION ValueUnion;
2281 RTGETOPTSTATE GetState;
2282 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2283
2284 Utf8Str strTemplate;
2285 uint32_t fMode = 0; /* Default mode. */
2286 bool fDirectory = false;
2287 bool fSecure = false;
2288 Utf8Str strTempDir;
2289
2290 DESTDIRMAP mapDirs;
2291
2292 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
2293 {
2294 /* For options that require an argument, ValueUnion has received the value. */
2295 switch (ch)
2296 {
2297 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2298
2299 case 'm': /* Mode */
2300 fMode = ValueUnion.u32;
2301 break;
2302
2303 case 'D': /* Create directory */
2304 fDirectory = true;
2305 break;
2306
2307 case 's': /* Secure */
2308 fSecure = true;
2309 break;
2310
2311 case 't': /* Temp directory */
2312 strTempDir = ValueUnion.psz;
2313 break;
2314
2315 case VINF_GETOPT_NOT_OPTION:
2316 if (strTemplate.isEmpty())
2317 strTemplate = ValueUnion.psz;
2318 else
2319 return errorSyntax(GuestCtrl::tr("More than one template specified!\n"));
2320 break;
2321
2322 default:
2323 return errorGetOpt(ch, &ValueUnion);
2324 }
2325 }
2326
2327 if (strTemplate.isEmpty())
2328 return errorSyntax(GuestCtrl::tr("No template specified!"));
2329
2330 if (!fDirectory)
2331 return errorSyntax(GuestCtrl::tr("Creating temporary files is currently not supported!"));
2332
2333 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2334 if (rcExit != RTEXITCODE_SUCCESS)
2335 return rcExit;
2336
2337 /*
2338 * Create the directories.
2339 */
2340 if (pCtx->cVerbose)
2341 {
2342 if (fDirectory && !strTempDir.isEmpty())
2343 RTPrintf(GuestCtrl::tr("Creating temporary directory from template '%s' in directory '%s' ...\n"),
2344 strTemplate.c_str(), strTempDir.c_str());
2345 else if (fDirectory)
2346 RTPrintf(GuestCtrl::tr("Creating temporary directory from template '%s' in default temporary directory ...\n"),
2347 strTemplate.c_str());
2348 else if (!fDirectory && !strTempDir.isEmpty())
2349 RTPrintf(GuestCtrl::tr("Creating temporary file from template '%s' in directory '%s' ...\n"),
2350 strTemplate.c_str(), strTempDir.c_str());
2351 else if (!fDirectory)
2352 RTPrintf(GuestCtrl::tr("Creating temporary file from template '%s' in default temporary directory ...\n"),
2353 strTemplate.c_str());
2354 }
2355
2356 HRESULT hrc = S_OK;
2357 if (fDirectory)
2358 {
2359 Bstr bstrDirectory;
2360 CHECK_ERROR(pCtx->pGuestSession, DirectoryCreateTemp(Bstr(strTemplate).raw(),
2361 fMode, Bstr(strTempDir).raw(),
2362 fSecure,
2363 bstrDirectory.asOutParam()));
2364 if (SUCCEEDED(hrc))
2365 RTPrintf(GuestCtrl::tr("Directory name: %ls\n"), bstrDirectory.raw());
2366 }
2367 else
2368 {
2369 // else - temporary file not yet implemented
2370 /** @todo implement temporary file creation (we fend it off above, no
2371 * worries). */
2372 hrc = E_FAIL;
2373 }
2374
2375 return FAILED(hrc) ? RTEXITCODE_FAILURE : RTEXITCODE_SUCCESS;
2376}
2377
2378static DECLCALLBACK(RTEXITCODE) gctlHandleStat(PGCTLCMDCTX pCtx, int argc, char **argv)
2379{
2380 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2381
2382 static const RTGETOPTDEF s_aOptions[] =
2383 {
2384 GCTLCMD_COMMON_OPTION_DEFS()
2385 { "--dereference", 'L', RTGETOPT_REQ_NOTHING },
2386 { "--file-system", 'f', RTGETOPT_REQ_NOTHING },
2387 { "--format", 'c', RTGETOPT_REQ_STRING },
2388 { "--terse", 't', RTGETOPT_REQ_NOTHING }
2389 };
2390
2391 int ch;
2392 RTGETOPTUNION ValueUnion;
2393 RTGETOPTSTATE GetState;
2394 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2395
2396 while ( (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
2397 && ch != VINF_GETOPT_NOT_OPTION)
2398 {
2399 /* For options that require an argument, ValueUnion has received the value. */
2400 switch (ch)
2401 {
2402 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2403
2404 case 'L': /* Dereference */
2405 case 'f': /* File-system */
2406 case 'c': /* Format */
2407 case 't': /* Terse */
2408 return errorSyntax(GuestCtrl::tr("Command \"%s\" not implemented yet!"), ValueUnion.psz);
2409
2410 default:
2411 return errorGetOpt(ch, &ValueUnion);
2412 }
2413 }
2414
2415 if (ch != VINF_GETOPT_NOT_OPTION)
2416 return errorSyntax(GuestCtrl::tr("Nothing to stat!"));
2417
2418 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2419 if (rcExit != RTEXITCODE_SUCCESS)
2420 return rcExit;
2421
2422
2423 /*
2424 * Do the file stat'ing.
2425 */
2426 while (ch == VINF_GETOPT_NOT_OPTION)
2427 {
2428 if (pCtx->cVerbose)
2429 RTPrintf(GuestCtrl::tr("Checking for element \"%s\" ...\n"), ValueUnion.psz);
2430
2431 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2432 HRESULT hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(ValueUnion.psz).raw(), FALSE /*followSymlinks*/,
2433 pFsObjInfo.asOutParam());
2434 if (FAILED(hrc))
2435 {
2436 /** @todo r=bird: There might be other reasons why we end up here than
2437 * non-existing "element" (object or file, please, nobody calls it elements). */
2438 if (pCtx->cVerbose)
2439 RTPrintf(GuestCtrl::tr("Failed to stat '%s': No such file\n"), ValueUnion.psz);
2440 rcExit = RTEXITCODE_FAILURE;
2441 }
2442 else
2443 {
2444 RTPrintf(GuestCtrl::tr(" File: '%s'\n"), ValueUnion.psz); /** @todo escape this name. */
2445
2446 FsObjType_T enmType = FsObjType_Unknown;
2447 CHECK_ERROR2I(pFsObjInfo, COMGETTER(Type)(&enmType));
2448 LONG64 cbObject = 0;
2449 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ObjectSize)(&cbObject));
2450 LONG64 cbAllocated = 0;
2451 CHECK_ERROR2I(pFsObjInfo, COMGETTER(AllocatedSize)(&cbAllocated));
2452 LONG uid = 0;
2453 CHECK_ERROR2I(pFsObjInfo, COMGETTER(UID)(&uid));
2454 LONG gid = 0;
2455 CHECK_ERROR2I(pFsObjInfo, COMGETTER(GID)(&gid));
2456 Bstr bstrUsername;
2457 CHECK_ERROR2I(pFsObjInfo, COMGETTER(UserName)(bstrUsername.asOutParam()));
2458 Bstr bstrGroupName;
2459 CHECK_ERROR2I(pFsObjInfo, COMGETTER(GroupName)(bstrGroupName.asOutParam()));
2460 Bstr bstrAttribs;
2461 CHECK_ERROR2I(pFsObjInfo, COMGETTER(FileAttributes)(bstrAttribs.asOutParam()));
2462 LONG64 idNode = 0;
2463 CHECK_ERROR2I(pFsObjInfo, COMGETTER(NodeId)(&idNode));
2464 ULONG uDevNode = 0;
2465 CHECK_ERROR2I(pFsObjInfo, COMGETTER(NodeIdDevice)(&uDevNode));
2466 ULONG uDeviceNo = 0;
2467 CHECK_ERROR2I(pFsObjInfo, COMGETTER(DeviceNumber)(&uDeviceNo));
2468 ULONG cHardLinks = 1;
2469 CHECK_ERROR2I(pFsObjInfo, COMGETTER(HardLinks)(&cHardLinks));
2470 LONG64 nsBirthTime = 0;
2471 CHECK_ERROR2I(pFsObjInfo, COMGETTER(BirthTime)(&nsBirthTime));
2472 LONG64 nsChangeTime = 0;
2473 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ChangeTime)(&nsChangeTime));
2474 LONG64 nsModificationTime = 0;
2475 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ModificationTime)(&nsModificationTime));
2476 LONG64 nsAccessTime = 0;
2477 CHECK_ERROR2I(pFsObjInfo, COMGETTER(AccessTime)(&nsAccessTime));
2478
2479 RTPrintf(GuestCtrl::tr(" Size: %-17RU64 Alloc: %-19RU64 Type: %s\n"),
2480 cbObject, cbAllocated, gctlFsObjTypeToName(enmType));
2481 RTPrintf(GuestCtrl::tr("Device: %#-17RX32 INode: %-18RU64 Links: %u\n"), uDevNode, idNode, cHardLinks);
2482
2483 Utf8Str strAttrib(bstrAttribs);
2484 char *pszMode = strAttrib.mutableRaw();
2485 char *pszAttribs = strchr(pszMode, ' ');
2486 if (pszAttribs)
2487 do *pszAttribs++ = '\0';
2488 while (*pszAttribs == ' ');
2489 else
2490 pszAttribs = strchr(pszMode, '\0');
2491 if (uDeviceNo != 0)
2492 RTPrintf(GuestCtrl::tr(" Mode: %-16s Attrib: %-17s Dev ID: %#RX32\n"), pszMode, pszAttribs, uDeviceNo);
2493 else
2494 RTPrintf(GuestCtrl::tr(" Mode: %-16s Attrib: %s\n"), pszMode, pszAttribs);
2495
2496 RTPrintf(GuestCtrl::tr(" Owner: %4d/%-12ls Group: %4d/%ls\n"), uid, bstrUsername.raw(), gid, bstrGroupName.raw());
2497
2498 RTTIMESPEC TimeSpec;
2499 char szTmp[RTTIME_STR_LEN];
2500 RTPrintf(GuestCtrl::tr(" Birth: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsBirthTime),
2501 szTmp, sizeof(szTmp)));
2502 RTPrintf(GuestCtrl::tr("Change: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsChangeTime),
2503 szTmp, sizeof(szTmp)));
2504 RTPrintf(GuestCtrl::tr("Modify: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsModificationTime),
2505 szTmp, sizeof(szTmp)));
2506 RTPrintf(GuestCtrl::tr("Access: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsAccessTime),
2507 szTmp, sizeof(szTmp)));
2508
2509 /* Skiping: Generation ID - only the ISO9660 VFS sets this. FreeBSD user flags. */
2510 }
2511
2512 /* Next file. */
2513 ch = RTGetOpt(&GetState, &ValueUnion);
2514 }
2515
2516 return rcExit;
2517}
2518
2519/**
2520 * Waits for a Guest Additions run level being reached.
2521 *
2522 * @returns VBox status code.
2523 * Returns VERR_CANCELLED if waiting for cancelled due to signal handling, e.g. when CTRL+C or some sort was pressed.
2524 * @param pCtx The guest control command context.
2525 * @param enmRunLevel Run level to wait for.
2526 * @param cMsTimeout Timeout (in ms) for waiting.
2527 */
2528static int gctlWaitForRunLevel(PGCTLCMDCTX pCtx, AdditionsRunLevelType_T enmRunLevel, RTMSINTERVAL cMsTimeout)
2529{
2530 int vrc = VINF_SUCCESS; /* Shut up MSVC. */
2531
2532 try
2533 {
2534 HRESULT hrc = S_OK;
2535 /** Whether we need to actually wait for the run level or if we already reached it. */
2536 bool fWait = false;
2537
2538 /* Install an event handler first to catch any runlevel changes. */
2539 ComObjPtr<GuestAdditionsRunlevelListenerImpl> pGuestListener;
2540 do
2541 {
2542 /* Listener creation. */
2543 pGuestListener.createObject();
2544 pGuestListener->init(new GuestAdditionsRunlevelListener(enmRunLevel));
2545
2546 /* Register for IGuest events. */
2547 ComPtr<IEventSource> es;
2548 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(EventSource)(es.asOutParam()));
2549 com::SafeArray<VBoxEventType_T> eventTypes;
2550 eventTypes.push_back(VBoxEventType_OnGuestAdditionsStatusChanged);
2551 CHECK_ERROR_BREAK(es, RegisterListener(pGuestListener, ComSafeArrayAsInParam(eventTypes),
2552 true /* Active listener */));
2553
2554 AdditionsRunLevelType_T enmRunLevelCur = AdditionsRunLevelType_None;
2555 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(AdditionsRunLevel)(&enmRunLevelCur));
2556 fWait = enmRunLevelCur != enmRunLevel;
2557
2558 if (pCtx->cVerbose)
2559 RTPrintf(GuestCtrl::tr("Current run level is %RU32\n"), enmRunLevelCur);
2560
2561 } while (0);
2562
2563 if (fWait)
2564 {
2565 if (pCtx->cVerbose)
2566 RTPrintf(GuestCtrl::tr("Waiting for run level %RU32 ...\n"), enmRunLevel);
2567
2568 RTMSINTERVAL tsStart = RTTimeMilliTS();
2569 while (RTTimeMilliTS() - tsStart < cMsTimeout)
2570 {
2571 /* Wait for the global signal semaphore getting signalled. */
2572 vrc = RTSemEventWait(g_SemEventGuestCtrlCanceled, 100 /* ms */);
2573 if (RT_FAILURE(vrc))
2574 {
2575 if (vrc == VERR_TIMEOUT)
2576 continue;
2577 else
2578 {
2579 RTPrintf(GuestCtrl::tr("Waiting failed with %Rrc\n"), vrc);
2580 break;
2581 }
2582 }
2583 else if (pCtx->cVerbose)
2584 {
2585 RTPrintf(GuestCtrl::tr("Run level %RU32 reached\n"), enmRunLevel);
2586 break;
2587 }
2588
2589 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
2590 }
2591
2592 if ( vrc == VERR_TIMEOUT
2593 && pCtx->cVerbose)
2594 RTPrintf(GuestCtrl::tr("Run level %RU32 not reached within time\n"), enmRunLevel);
2595 }
2596
2597 if (!pGuestListener.isNull())
2598 {
2599 /* Guest callback unregistration. */
2600 ComPtr<IEventSource> pES;
2601 CHECK_ERROR(pCtx->pGuest, COMGETTER(EventSource)(pES.asOutParam()));
2602 if (!pES.isNull())
2603 CHECK_ERROR(pES, UnregisterListener(pGuestListener));
2604 pGuestListener.setNull();
2605 }
2606
2607 if (g_fGuestCtrlCanceled)
2608 vrc = VERR_CANCELLED;
2609 }
2610 catch (std::bad_alloc &)
2611 {
2612 vrc = VERR_NO_MEMORY;
2613 }
2614
2615 return vrc;
2616}
2617
2618static DECLCALLBACK(RTEXITCODE) gctlHandleUpdateAdditions(PGCTLCMDCTX pCtx, int argc, char **argv)
2619{
2620 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2621
2622 /** Timeout to wait for the whole updating procedure to complete. */
2623 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
2624 /** Source path to .ISO Guest Additions file to use. */
2625 Utf8Str strSource;
2626 com::SafeArray<IN_BSTR> aArgs;
2627 /** Whether to reboot the guest automatically when the update process has finished successfully. */
2628 bool fRebootOnFinish = false;
2629 /** Whether to only wait for getting the update process started instead of waiting until it finishes. */
2630 bool fWaitStartOnly = false;
2631 /** Whether to wait for the VM being ready to start the update. Needs Guest Additions facility reporting. */
2632 bool fWaitReady = false;
2633 /** Whether to verify if the Guest Additions were successfully updated on the guest. */
2634 bool fVerify = false;
2635
2636 /*
2637 * Parse arguments.
2638 */
2639 enum KGSTCTRLUPDATEADDITIONSOPT
2640 {
2641 KGSTCTRLUPDATEADDITIONSOPT_REBOOT = 1000,
2642 KGSTCTRLUPDATEADDITIONSOPT_SOURCE,
2643 KGSTCTRLUPDATEADDITIONSOPT_TIMEOUT,
2644 KGSTCTRLUPDATEADDITIONSOPT_VERIFY,
2645 KGSTCTRLUPDATEADDITIONSOPT_WAITREADY,
2646 KGSTCTRLUPDATEADDITIONSOPT_WAITSTART
2647 };
2648
2649 static const RTGETOPTDEF s_aOptions[] =
2650 {
2651 GCTLCMD_COMMON_OPTION_DEFS()
2652 { "--reboot", KGSTCTRLUPDATEADDITIONSOPT_REBOOT, RTGETOPT_REQ_NOTHING },
2653 { "--source", KGSTCTRLUPDATEADDITIONSOPT_SOURCE, RTGETOPT_REQ_STRING },
2654 { "--timeout", KGSTCTRLUPDATEADDITIONSOPT_TIMEOUT, RTGETOPT_REQ_UINT32 },
2655 { "--verify", KGSTCTRLUPDATEADDITIONSOPT_VERIFY, RTGETOPT_REQ_NOTHING },
2656 { "--wait-ready", KGSTCTRLUPDATEADDITIONSOPT_WAITREADY, RTGETOPT_REQ_NOTHING },
2657 { "--wait-start", KGSTCTRLUPDATEADDITIONSOPT_WAITSTART, RTGETOPT_REQ_NOTHING }
2658 };
2659
2660 int ch;
2661 RTGETOPTUNION ValueUnion;
2662 RTGETOPTSTATE GetState;
2663 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2664
2665 int vrc = VINF_SUCCESS;
2666 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
2667 && RT_SUCCESS(vrc))
2668 {
2669 switch (ch)
2670 {
2671 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2672
2673 case KGSTCTRLUPDATEADDITIONSOPT_REBOOT:
2674 fRebootOnFinish = true;
2675 break;
2676
2677 case KGSTCTRLUPDATEADDITIONSOPT_SOURCE:
2678 vrc = RTPathAbsCxx(strSource, ValueUnion.psz);
2679 if (RT_FAILURE(vrc))
2680 return RTMsgErrorExitFailure(GuestCtrl::tr("RTPathAbsCxx failed on '%s': %Rrc"), ValueUnion.psz, vrc);
2681 break;
2682
2683 case KGSTCTRLUPDATEADDITIONSOPT_WAITSTART:
2684 fWaitStartOnly = true;
2685 break;
2686
2687 case KGSTCTRLUPDATEADDITIONSOPT_WAITREADY:
2688 fWaitReady = true;
2689 break;
2690
2691 case KGSTCTRLUPDATEADDITIONSOPT_VERIFY:
2692 fVerify = true;
2693 fRebootOnFinish = true; /* Verification needs a mandatory reboot after successful update. */
2694 break;
2695
2696 case VINF_GETOPT_NOT_OPTION:
2697 if (aArgs.size() == 0 && strSource.isEmpty())
2698 strSource = ValueUnion.psz;
2699 else
2700 aArgs.push_back(Bstr(ValueUnion.psz).raw());
2701 break;
2702
2703 default:
2704 return errorGetOpt(ch, &ValueUnion);
2705 }
2706 }
2707
2708 if (pCtx->cVerbose)
2709 RTPrintf(GuestCtrl::tr("Updating Guest Additions ...\n"));
2710
2711 HRESULT hrc = S_OK;
2712 while (strSource.isEmpty())
2713 {
2714 ComPtr<ISystemProperties> pProperties;
2715 CHECK_ERROR_BREAK(pCtx->pArg->virtualBox, COMGETTER(SystemProperties)(pProperties.asOutParam()));
2716 Bstr strISO;
2717 CHECK_ERROR_BREAK(pProperties, COMGETTER(DefaultAdditionsISO)(strISO.asOutParam()));
2718 strSource = strISO;
2719 break;
2720 }
2721
2722 /* Determine source if not set yet. */
2723 if (strSource.isEmpty())
2724 {
2725 RTMsgError(GuestCtrl::tr("No Guest Additions source found or specified, aborting\n"));
2726 vrc = VERR_FILE_NOT_FOUND;
2727 }
2728 else if (!RTFileExists(strSource.c_str()))
2729 {
2730 RTMsgError(GuestCtrl::tr("Source \"%s\" does not exist!\n"), strSource.c_str());
2731 vrc = VERR_FILE_NOT_FOUND;
2732 }
2733
2734
2735
2736#if 0
2737 ComPtr<IGuest> guest;
2738 HRESULT hrc = pConsole->COMGETTER(Guest)(guest.asOutParam());
2739 if (SUCCEEDED(hrc) && !guest.isNull())
2740 {
2741 SHOW_STRING_PROP_NOT_EMPTY(guest, OSTypeId, "GuestOSType", GuestCtrl::tr("OS type:"));
2742
2743 AdditionsRunLevelType_T guestRunLevel; /** @todo Add a runlevel-to-string (e.g. 0 = "None") method? */
2744 hrc = guest->COMGETTER(AdditionsRunLevel)(&guestRunLevel);
2745 if (SUCCEEDED(hrc))
2746 SHOW_ULONG_VALUE("GuestAdditionsRunLevel", GuestCtrl::tr("Additions run level:"), (ULONG)guestRunLevel, "");
2747
2748 Bstr guestString;
2749 hrc = guest->COMGETTER(AdditionsVersion)(guestString.asOutParam());
2750 if ( SUCCEEDED(hrc)
2751 && !guestString.isEmpty())
2752 {
2753 ULONG uRevision;
2754 hrc = guest->COMGETTER(AdditionsRevision)(&uRevision);
2755 if (FAILED(hrc))
2756 uRevision = 0;
2757 RTStrPrintf(szValue, sizeof(szValue), "%ls r%u", guestString.raw(), uRevision);
2758 SHOW_UTF8_STRING("GuestAdditionsVersion", GuestCtrl::tr("Additions version:"), szValue);
2759 }
2760 }
2761#endif
2762
2763 if (RT_SUCCESS(vrc))
2764 {
2765 if (pCtx->cVerbose)
2766 RTPrintf(GuestCtrl::tr("Using source: %s\n"), strSource.c_str());
2767
2768 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2769 if (rcExit != RTEXITCODE_SUCCESS)
2770 return rcExit;
2771
2772 if (fWaitReady)
2773 {
2774 if (pCtx->cVerbose)
2775 RTPrintf(GuestCtrl::tr("Waiting for current Guest Additions inside VM getting ready for updating ...\n"));
2776
2777 const uint64_t uTsStart = RTTimeMilliTS();
2778 vrc = gctlWaitForRunLevel(pCtx, AdditionsRunLevelType_Userland, cMsTimeout);
2779 if (RT_SUCCESS(vrc))
2780 cMsTimeout = cMsTimeout != RT_INDEFINITE_WAIT ? cMsTimeout - (RTTimeMilliTS() - uTsStart) : cMsTimeout;
2781 }
2782
2783 if (RT_SUCCESS(vrc))
2784 {
2785 /* Get current Guest Additions version / revision. */
2786 Bstr strGstVerCur;
2787 ULONG uGstRevCur = 0;
2788 hrc = pCtx->pGuest->COMGETTER(AdditionsVersion)(strGstVerCur.asOutParam());
2789 if ( SUCCEEDED(hrc)
2790 && !strGstVerCur.isEmpty())
2791 {
2792 hrc = pCtx->pGuest->COMGETTER(AdditionsRevision)(&uGstRevCur);
2793 if (SUCCEEDED(hrc))
2794 {
2795 if (pCtx->cVerbose)
2796 RTPrintf(GuestCtrl::tr("Guest Additions %lsr%RU64 currently installed, waiting for Guest Additions installer to start ...\n"),
2797 strGstVerCur.raw(), uGstRevCur);
2798 }
2799 }
2800
2801 com::SafeArray<AdditionsUpdateFlag_T> aUpdateFlags;
2802 if (fWaitStartOnly)
2803 aUpdateFlags.push_back(AdditionsUpdateFlag_WaitForUpdateStartOnly);
2804
2805 ComPtr<IProgress> pProgress;
2806 CHECK_ERROR(pCtx->pGuest, UpdateGuestAdditions(Bstr(strSource).raw(),
2807 ComSafeArrayAsInParam(aArgs),
2808 ComSafeArrayAsInParam(aUpdateFlags),
2809 pProgress.asOutParam()));
2810 if (FAILED(hrc))
2811 vrc = gctlPrintError(pCtx->pGuest, COM_IIDOF(IGuest));
2812 else
2813 {
2814 if (pCtx->cVerbose)
2815 hrc = showProgress(pProgress);
2816 else
2817 hrc = pProgress->WaitForCompletion((int32_t)cMsTimeout);
2818
2819 if (SUCCEEDED(hrc))
2820 CHECK_PROGRESS_ERROR(pProgress, (GuestCtrl::tr("Guest Additions update failed")));
2821 vrc = gctlPrintProgressError(pProgress);
2822 if (RT_SUCCESS(vrc))
2823 {
2824 if (pCtx->cVerbose)
2825 RTPrintf(GuestCtrl::tr("Guest Additions update successful.\n"));
2826
2827 if (fRebootOnFinish)
2828 {
2829 if (pCtx->cVerbose)
2830 RTPrintf(GuestCtrl::tr("Rebooting guest ...\n"));
2831 com::SafeArray<GuestShutdownFlag_T> aShutdownFlags;
2832 aShutdownFlags.push_back(GuestShutdownFlag_Reboot);
2833 CHECK_ERROR(pCtx->pGuest, Shutdown(ComSafeArrayAsInParam(aShutdownFlags)));
2834 if (FAILED(hrc))
2835 {
2836 if (hrc == VBOX_E_NOT_SUPPORTED)
2837 {
2838 RTPrintf(GuestCtrl::tr("Current installed Guest Additions don't support automatic rebooting. "
2839 "Please reboot manually.\n"));
2840 vrc = VERR_NOT_SUPPORTED;
2841 }
2842 else
2843 vrc = gctlPrintError(pCtx->pGuest, COM_IIDOF(IGuest));
2844 }
2845 else
2846 {
2847 if (fWaitReady)
2848 {
2849 if (pCtx->cVerbose)
2850 RTPrintf(GuestCtrl::tr("Waiting for new Guest Additions inside VM getting ready ...\n"));
2851
2852 vrc = gctlWaitForRunLevel(pCtx, AdditionsRunLevelType_Userland, cMsTimeout);
2853 if (RT_SUCCESS(vrc))
2854 {
2855 if (fVerify)
2856 {
2857 if (pCtx->cVerbose)
2858 RTPrintf(GuestCtrl::tr("Verifying Guest Additions update ...\n"));
2859
2860 /* Get new Guest Additions version / revision. */
2861 Bstr strGstVerNew;
2862 ULONG uGstRevNew = 0;
2863 hrc = pCtx->pGuest->COMGETTER(AdditionsVersion)(strGstVerNew.asOutParam());
2864 if ( SUCCEEDED(hrc)
2865 && !strGstVerNew.isEmpty())
2866 {
2867 hrc = pCtx->pGuest->COMGETTER(AdditionsRevision)(&uGstRevNew);
2868 if (FAILED(hrc))
2869 uGstRevNew = 0;
2870 }
2871
2872 /** @todo Do more verification here. */
2873 vrc = uGstRevNew > uGstRevCur ? VINF_SUCCESS : VERR_NO_CHANGE;
2874
2875 if (pCtx->cVerbose)
2876 {
2877 RTPrintf(GuestCtrl::tr("Old Guest Additions: %ls%RU64\n"), strGstVerCur.raw(),
2878 uGstRevCur);
2879 RTPrintf(GuestCtrl::tr("New Guest Additions: %ls%RU64\n"), strGstVerNew.raw(),
2880 uGstRevNew);
2881
2882 if (RT_FAILURE(vrc))
2883 {
2884 RTPrintf(GuestCtrl::tr("\nError updating Guest Additions, please check guest installer log\n"));
2885 }
2886 else
2887 {
2888 if (uGstRevNew < uGstRevCur)
2889 RTPrintf(GuestCtrl::tr("\nWARNING: Guest Additions were downgraded\n"));
2890 }
2891 }
2892 }
2893 }
2894 }
2895 else if (pCtx->cVerbose)
2896 RTPrintf(GuestCtrl::tr("The guest needs to be restarted in order to make use of the updated Guest Additions.\n"));
2897 }
2898 }
2899 }
2900 }
2901 }
2902 }
2903
2904 return RT_SUCCESS(vrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
2905}
2906
2907/**
2908 * Returns a Guest Additions run level from a string.
2909 *
2910 * @returns Run level if found, or AdditionsRunLevelType_None if not found / invalid.
2911 * @param pcszStr String to return run level for.
2912 */
2913static AdditionsRunLevelType_T gctlGetRunLevelFromStr(const char *pcszStr)
2914{
2915 AssertPtrReturn(pcszStr, AdditionsRunLevelType_None);
2916
2917 if (RTStrICmp(pcszStr, "system") == 0) return AdditionsRunLevelType_System;
2918 else if (RTStrICmp(pcszStr, "userland") == 0) return AdditionsRunLevelType_Userland;
2919 else if (RTStrICmp(pcszStr, "desktop") == 0) return AdditionsRunLevelType_Desktop;
2920
2921 return AdditionsRunLevelType_None;
2922}
2923
2924static DECLCALLBACK(RTEXITCODE) gctlHandleWaitRunLevel(PGCTLCMDCTX pCtx, int argc, char **argv)
2925{
2926 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2927
2928 /** Timeout to wait for run level being reached.
2929 * By default we wait until it's reached. */
2930 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
2931
2932 /*
2933 * Parse arguments.
2934 */
2935 enum KGSTCTRLWAITRUNLEVELOPT
2936 {
2937 KGSTCTRLWAITRUNLEVELOPT_TIMEOUT = 1000
2938 };
2939
2940 static const RTGETOPTDEF s_aOptions[] =
2941 {
2942 GCTLCMD_COMMON_OPTION_DEFS()
2943 { "--timeout", KGSTCTRLWAITRUNLEVELOPT_TIMEOUT, RTGETOPT_REQ_UINT32 }
2944 };
2945
2946 int ch;
2947 RTGETOPTUNION ValueUnion;
2948 RTGETOPTSTATE GetState;
2949 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2950
2951 AdditionsRunLevelType_T enmRunLevel = AdditionsRunLevelType_None;
2952
2953 int vrc = VINF_SUCCESS;
2954 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
2955 && RT_SUCCESS(vrc))
2956 {
2957 switch (ch)
2958 {
2959 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2960
2961 case KGSTCTRLWAITRUNLEVELOPT_TIMEOUT:
2962 cMsTimeout = ValueUnion.u32;
2963 break;
2964
2965 case VINF_GETOPT_NOT_OPTION:
2966 {
2967 enmRunLevel = gctlGetRunLevelFromStr(ValueUnion.psz);
2968 if (enmRunLevel == AdditionsRunLevelType_None)
2969 return errorSyntax(GuestCtrl::tr("Invalid run level specified. Valid values are: system, userland, desktop"));
2970 break;
2971 }
2972
2973 default:
2974 return errorGetOpt(ch, &ValueUnion);
2975 }
2976 }
2977
2978 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2979 if (rcExit != RTEXITCODE_SUCCESS)
2980 return rcExit;
2981
2982 if (enmRunLevel == AdditionsRunLevelType_None)
2983 return errorSyntax(GuestCtrl::tr("Missing run level to wait for"));
2984
2985 vrc = gctlWaitForRunLevel(pCtx, enmRunLevel, cMsTimeout);
2986
2987 return RT_SUCCESS(vrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
2988}
2989
2990static DECLCALLBACK(RTEXITCODE) gctlHandleList(PGCTLCMDCTX pCtx, int argc, char **argv)
2991{
2992 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2993
2994 static const RTGETOPTDEF s_aOptions[] =
2995 {
2996 GCTLCMD_COMMON_OPTION_DEFS()
2997 };
2998
2999 int ch;
3000 RTGETOPTUNION ValueUnion;
3001 RTGETOPTSTATE GetState;
3002 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3003
3004 bool fSeenListArg = false;
3005 bool fListAll = false;
3006 bool fListSessions = false;
3007 bool fListProcesses = false;
3008 bool fListFiles = false;
3009
3010 int vrc = VINF_SUCCESS;
3011 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
3012 && RT_SUCCESS(vrc))
3013 {
3014 switch (ch)
3015 {
3016 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3017
3018 case VINF_GETOPT_NOT_OPTION:
3019 if ( !RTStrICmp(ValueUnion.psz, "sessions")
3020 || !RTStrICmp(ValueUnion.psz, "sess"))
3021 fListSessions = true;
3022 else if ( !RTStrICmp(ValueUnion.psz, "processes")
3023 || !RTStrICmp(ValueUnion.psz, "procs"))
3024 fListSessions = fListProcesses = true; /* Showing processes implies showing sessions. */
3025 else if (!RTStrICmp(ValueUnion.psz, "files"))
3026 fListSessions = fListFiles = true; /* Showing files implies showing sessions. */
3027 else if (!RTStrICmp(ValueUnion.psz, "all"))
3028 fListAll = true;
3029 else
3030 return errorSyntax(GuestCtrl::tr("Unknown list: '%s'"), ValueUnion.psz);
3031 fSeenListArg = true;
3032 break;
3033
3034 default:
3035 return errorGetOpt(ch, &ValueUnion);
3036 }
3037 }
3038
3039 if (!fSeenListArg)
3040 return errorSyntax(GuestCtrl::tr("Missing list name"));
3041 Assert(fListAll || fListSessions);
3042
3043 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3044 if (rcExit != RTEXITCODE_SUCCESS)
3045 return rcExit;
3046
3047
3048 /** @todo Do we need a machine-readable output here as well? */
3049
3050 HRESULT hrc;
3051 size_t cTotalProcs = 0;
3052 size_t cTotalFiles = 0;
3053
3054 SafeIfaceArray <IGuestSession> collSessions;
3055 CHECK_ERROR(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3056 if (SUCCEEDED(hrc))
3057 {
3058 size_t const cSessions = collSessions.size();
3059 if (cSessions)
3060 {
3061 RTPrintf(GuestCtrl::tr("Active guest sessions:\n"));
3062
3063 /** @todo Make this output a bit prettier. No time now. */
3064
3065 for (size_t i = 0; i < cSessions; i++)
3066 {
3067 ComPtr<IGuestSession> pCurSession = collSessions[i];
3068 if (!pCurSession.isNull())
3069 {
3070 do
3071 {
3072 ULONG uID;
3073 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Id)(&uID));
3074 Bstr strName;
3075 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Name)(strName.asOutParam()));
3076 Bstr strUser;
3077 CHECK_ERROR_BREAK(pCurSession, COMGETTER(User)(strUser.asOutParam()));
3078 GuestSessionStatus_T sessionStatus;
3079 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Status)(&sessionStatus));
3080 RTPrintf(GuestCtrl::tr("\n\tSession #%-3zu ID=%-3RU32 User=%-16ls Status=[%s] Name=%ls"),
3081 i, uID, strUser.raw(), gctlGuestSessionStatusToText(sessionStatus), strName.raw());
3082 } while (0);
3083
3084 if ( fListAll
3085 || fListProcesses)
3086 {
3087 SafeIfaceArray <IGuestProcess> collProcesses;
3088 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Processes)(ComSafeArrayAsOutParam(collProcesses)));
3089 for (size_t a = 0; a < collProcesses.size(); a++)
3090 {
3091 ComPtr<IGuestProcess> pCurProcess = collProcesses[a];
3092 if (!pCurProcess.isNull())
3093 {
3094 do
3095 {
3096 ULONG uPID;
3097 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(PID)(&uPID));
3098 Bstr strExecPath;
3099 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(ExecutablePath)(strExecPath.asOutParam()));
3100 ProcessStatus_T procStatus;
3101 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(Status)(&procStatus));
3102
3103 RTPrintf(GuestCtrl::tr("\n\t\tProcess #%-03zu PID=%-6RU32 Status=[%s] Command=%ls"),
3104 a, uPID, gctlProcessStatusToText(procStatus), strExecPath.raw());
3105 } while (0);
3106 }
3107 }
3108
3109 cTotalProcs += collProcesses.size();
3110 }
3111
3112 if ( fListAll
3113 || fListFiles)
3114 {
3115 SafeIfaceArray <IGuestFile> collFiles;
3116 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Files)(ComSafeArrayAsOutParam(collFiles)));
3117 for (size_t a = 0; a < collFiles.size(); a++)
3118 {
3119 ComPtr<IGuestFile> pCurFile = collFiles[a];
3120 if (!pCurFile.isNull())
3121 {
3122 do
3123 {
3124 ULONG idFile;
3125 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Id)(&idFile));
3126 Bstr strName;
3127 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Filename)(strName.asOutParam()));
3128 FileStatus_T fileStatus;
3129 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Status)(&fileStatus));
3130
3131 RTPrintf(GuestCtrl::tr("\n\t\tFile #%-03zu ID=%-6RU32 Status=[%s] Name=%ls"),
3132 a, idFile, gctlFileStatusToText(fileStatus), strName.raw());
3133 } while (0);
3134 }
3135 }
3136
3137 cTotalFiles += collFiles.size();
3138 }
3139 }
3140 }
3141
3142 RTPrintf(GuestCtrl::tr("\n\nTotal guest sessions: %zu\n"), collSessions.size());
3143 if (fListAll || fListProcesses)
3144 RTPrintf(GuestCtrl::tr("Total guest processes: %zu\n"), cTotalProcs);
3145 if (fListAll || fListFiles)
3146 RTPrintf(GuestCtrl::tr("Total guest files: %zu\n"), cTotalFiles);
3147 }
3148 else
3149 RTPrintf(GuestCtrl::tr("No active guest sessions found\n"));
3150 }
3151
3152 if (FAILED(hrc)) /** @todo yeah, right... Only the last error? */
3153 rcExit = RTEXITCODE_FAILURE;
3154
3155 return rcExit;
3156}
3157
3158static DECLCALLBACK(RTEXITCODE) gctlHandleCloseProcess(PGCTLCMDCTX pCtx, int argc, char **argv)
3159{
3160 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3161
3162 static const RTGETOPTDEF s_aOptions[] =
3163 {
3164 GCTLCMD_COMMON_OPTION_DEFS()
3165 { "--session-id", 'i', RTGETOPT_REQ_UINT32 },
3166 { "--session-name", 'n', RTGETOPT_REQ_STRING }
3167 };
3168
3169 int ch;
3170 RTGETOPTUNION ValueUnion;
3171 RTGETOPTSTATE GetState;
3172 int vrc = RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3173 AssertRCReturn(vrc, RTEXITCODE_FAILURE);
3174
3175 std::vector < uint32_t > vecPID;
3176 ULONG idSession = UINT32_MAX;
3177 Utf8Str strSessionName;
3178
3179 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3180 {
3181 /* For options that require an argument, ValueUnion has received the value. */
3182 switch (ch)
3183 {
3184 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3185
3186 case 'n': /* Session name (or pattern) */
3187 strSessionName = ValueUnion.psz;
3188 break;
3189
3190 case 'i': /* Session ID */
3191 idSession = ValueUnion.u32;
3192 break;
3193
3194 case VINF_GETOPT_NOT_OPTION:
3195 {
3196 /* Treat every else specified as a PID to kill. */
3197 uint32_t uPid;
3198 vrc = RTStrToUInt32Ex(ValueUnion.psz, NULL, 0, &uPid);
3199 if ( RT_SUCCESS(vrc)
3200 && vrc != VWRN_TRAILING_CHARS
3201 && vrc != VWRN_NUMBER_TOO_BIG
3202 && vrc != VWRN_NEGATIVE_UNSIGNED)
3203 {
3204 if (uPid != 0)
3205 {
3206 try
3207 {
3208 vecPID.push_back(uPid);
3209 }
3210 catch (std::bad_alloc &)
3211 {
3212 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory"));
3213 }
3214 }
3215 else
3216 return errorSyntax(GuestCtrl::tr("Invalid PID value: 0"));
3217 }
3218 else
3219 return errorSyntax(GuestCtrl::tr("Error parsing PID value: %Rrc"), vrc);
3220 break;
3221 }
3222
3223 default:
3224 return errorGetOpt(ch, &ValueUnion);
3225 }
3226 }
3227
3228 if (vecPID.empty())
3229 return errorSyntax(GuestCtrl::tr("At least one PID must be specified to kill!"));
3230
3231 if ( strSessionName.isEmpty()
3232 && idSession == UINT32_MAX)
3233 return errorSyntax(GuestCtrl::tr("No session ID specified!"));
3234
3235 if ( strSessionName.isNotEmpty()
3236 && idSession != UINT32_MAX)
3237 return errorSyntax(GuestCtrl::tr("Either session ID or name (pattern) must be specified"));
3238
3239 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3240 if (rcExit != RTEXITCODE_SUCCESS)
3241 return rcExit;
3242
3243 HRESULT hrc = S_OK;
3244
3245 ComPtr<IGuestSession> pSession;
3246 ComPtr<IGuestProcess> pProcess;
3247 do
3248 {
3249 uint32_t uProcsTerminated = 0;
3250
3251 SafeIfaceArray <IGuestSession> collSessions;
3252 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3253 size_t cSessions = collSessions.size();
3254
3255 uint32_t cSessionsHandled = 0;
3256 for (size_t i = 0; i < cSessions; i++)
3257 {
3258 pSession = collSessions[i];
3259 Assert(!pSession.isNull());
3260
3261 ULONG uID; /* Session ID */
3262 CHECK_ERROR_BREAK(pSession, COMGETTER(Id)(&uID));
3263 Bstr strName;
3264 CHECK_ERROR_BREAK(pSession, COMGETTER(Name)(strName.asOutParam()));
3265 Utf8Str strNameUtf8(strName); /* Session name */
3266
3267 bool fSessionFound;
3268 if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
3269 fSessionFound = uID == idSession;
3270 else /* ... or by naming pattern. */
3271 fSessionFound = RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str());
3272 if (fSessionFound)
3273 {
3274 AssertStmt(!pSession.isNull(), break);
3275 cSessionsHandled++;
3276
3277 SafeIfaceArray <IGuestProcess> collProcs;
3278 CHECK_ERROR_BREAK(pSession, COMGETTER(Processes)(ComSafeArrayAsOutParam(collProcs)));
3279
3280 size_t cProcs = collProcs.size();
3281 for (size_t p = 0; p < cProcs; p++)
3282 {
3283 pProcess = collProcs[p];
3284 Assert(!pProcess.isNull());
3285
3286 ULONG uPID; /* Process ID */
3287 CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID));
3288
3289 bool fProcFound = false;
3290 for (size_t a = 0; a < vecPID.size(); a++) /* Slow, but works. */
3291 {
3292 fProcFound = vecPID[a] == uPID;
3293 if (fProcFound)
3294 break;
3295 }
3296
3297 if (fProcFound)
3298 {
3299 if (pCtx->cVerbose)
3300 RTPrintf(GuestCtrl::tr("Terminating process (PID %RU32) (session ID %RU32) ...\n"),
3301 uPID, uID);
3302 CHECK_ERROR_BREAK(pProcess, Terminate());
3303 uProcsTerminated++;
3304 }
3305 else
3306 {
3307 if (idSession != UINT32_MAX)
3308 RTPrintf(GuestCtrl::tr("No matching process(es) for session ID %RU32 found\n"),
3309 idSession);
3310 }
3311
3312 pProcess.setNull();
3313 }
3314
3315 pSession.setNull();
3316 }
3317 }
3318
3319 if (!cSessionsHandled)
3320 RTPrintf(GuestCtrl::tr("No matching session(s) found\n"));
3321
3322 if (uProcsTerminated)
3323 RTPrintf(GuestCtrl::tr("%RU32 process(es) terminated\n", "", uProcsTerminated), uProcsTerminated);
3324
3325 } while (0);
3326
3327 pProcess.setNull();
3328 pSession.setNull();
3329
3330 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3331}
3332
3333
3334static DECLCALLBACK(RTEXITCODE) gctlHandleCloseSession(PGCTLCMDCTX pCtx, int argc, char **argv)
3335{
3336 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3337
3338 enum GETOPTDEF_SESSIONCLOSE
3339 {
3340 GETOPTDEF_SESSIONCLOSE_ALL = 2000
3341 };
3342 static const RTGETOPTDEF s_aOptions[] =
3343 {
3344 GCTLCMD_COMMON_OPTION_DEFS()
3345 { "--all", GETOPTDEF_SESSIONCLOSE_ALL, RTGETOPT_REQ_NOTHING },
3346 { "--session-id", 'i', RTGETOPT_REQ_UINT32 },
3347 { "--session-name", 'n', RTGETOPT_REQ_STRING }
3348 };
3349
3350 int ch;
3351 RTGETOPTUNION ValueUnion;
3352 RTGETOPTSTATE GetState;
3353 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3354
3355 ULONG idSession = UINT32_MAX;
3356 Utf8Str strSessionName;
3357
3358 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3359 {
3360 /* For options that require an argument, ValueUnion has received the value. */
3361 switch (ch)
3362 {
3363 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3364
3365 case 'n': /* Session name pattern */
3366 strSessionName = ValueUnion.psz;
3367 break;
3368
3369 case 'i': /* Session ID */
3370 idSession = ValueUnion.u32;
3371 break;
3372
3373 case GETOPTDEF_SESSIONCLOSE_ALL:
3374 strSessionName = "*";
3375 break;
3376
3377 case VINF_GETOPT_NOT_OPTION:
3378 /** @todo Supply a CSV list of IDs or patterns to close?
3379 * break; */
3380 default:
3381 return errorGetOpt(ch, &ValueUnion);
3382 }
3383 }
3384
3385 if ( strSessionName.isEmpty()
3386 && idSession == UINT32_MAX)
3387 return errorSyntax(GuestCtrl::tr("No session ID specified!"));
3388
3389 if ( !strSessionName.isEmpty()
3390 && idSession != UINT32_MAX)
3391 return errorSyntax(GuestCtrl::tr("Either session ID or name (pattern) must be specified"));
3392
3393 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3394 if (rcExit != RTEXITCODE_SUCCESS)
3395 return rcExit;
3396
3397 HRESULT hrc = S_OK;
3398
3399 do
3400 {
3401 size_t cSessionsHandled = 0;
3402
3403 SafeIfaceArray <IGuestSession> collSessions;
3404 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3405 size_t cSessions = collSessions.size();
3406
3407 for (size_t i = 0; i < cSessions; i++)
3408 {
3409 ComPtr<IGuestSession> pSession = collSessions[i];
3410 Assert(!pSession.isNull());
3411
3412 ULONG uID; /* Session ID */
3413 CHECK_ERROR_BREAK(pSession, COMGETTER(Id)(&uID));
3414 Bstr strName;
3415 CHECK_ERROR_BREAK(pSession, COMGETTER(Name)(strName.asOutParam()));
3416 Utf8Str strNameUtf8(strName); /* Session name */
3417
3418 bool fSessionFound;
3419 if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
3420 fSessionFound = uID == idSession;
3421 else /* ... or by naming pattern. */
3422 fSessionFound = RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str());
3423 if (fSessionFound)
3424 {
3425 cSessionsHandled++;
3426
3427 Assert(!pSession.isNull());
3428 if (pCtx->cVerbose)
3429 RTPrintf(GuestCtrl::tr("Closing guest session ID=#%RU32 \"%s\" ...\n"),
3430 uID, strNameUtf8.c_str());
3431 CHECK_ERROR_BREAK(pSession, Close());
3432 if (pCtx->cVerbose)
3433 RTPrintf(GuestCtrl::tr("Guest session successfully closed\n"));
3434
3435 pSession.setNull();
3436 }
3437 }
3438
3439 if (!cSessionsHandled)
3440 {
3441 RTPrintf(GuestCtrl::tr("No guest session(s) found\n"));
3442 hrc = E_ABORT; /* To set exit code accordingly. */
3443 }
3444
3445 } while (0);
3446
3447 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3448}
3449
3450
3451static DECLCALLBACK(RTEXITCODE) gctlHandleWatch(PGCTLCMDCTX pCtx, int argc, char **argv)
3452{
3453 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3454
3455 /*
3456 * Parse arguments.
3457 */
3458 static const RTGETOPTDEF s_aOptions[] =
3459 {
3460 GCTLCMD_COMMON_OPTION_DEFS()
3461 { "--timeout", 't', RTGETOPT_REQ_UINT32 }
3462 };
3463
3464 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
3465
3466 int ch;
3467 RTGETOPTUNION ValueUnion;
3468 RTGETOPTSTATE GetState;
3469 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3470
3471 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3472 {
3473 /* For options that require an argument, ValueUnion has received the value. */
3474 switch (ch)
3475 {
3476 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3477
3478 case 't': /* Timeout */
3479 cMsTimeout = ValueUnion.u32;
3480 break;
3481
3482 case VINF_GETOPT_NOT_OPTION:
3483 default:
3484 return errorGetOpt(ch, &ValueUnion);
3485 }
3486 }
3487
3488 /** @todo Specify categories to watch for. */
3489
3490 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3491 if (rcExit != RTEXITCODE_SUCCESS)
3492 return rcExit;
3493
3494 HRESULT hrc;
3495
3496 try
3497 {
3498 ComObjPtr<GuestEventListenerImpl> pGuestListener;
3499 do
3500 {
3501 /* Listener creation. */
3502 pGuestListener.createObject();
3503 pGuestListener->init(new GuestEventListener());
3504
3505 /* Register for IGuest events. */
3506 ComPtr<IEventSource> es;
3507 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(EventSource)(es.asOutParam()));
3508 com::SafeArray<VBoxEventType_T> eventTypes;
3509 eventTypes.push_back(VBoxEventType_OnGuestSessionRegistered);
3510 /** @todo Also register for VBoxEventType_OnGuestUserStateChanged on demand? */
3511 CHECK_ERROR_BREAK(es, RegisterListener(pGuestListener, ComSafeArrayAsInParam(eventTypes),
3512 true /* Active listener */));
3513 /* Note: All other guest control events have to be registered
3514 * as their corresponding objects appear. */
3515
3516 } while (0);
3517
3518 if (pCtx->cVerbose)
3519 RTPrintf(GuestCtrl::tr("Waiting for events ...\n"));
3520
3521 RTMSINTERVAL tsStart = RTTimeMilliTS();
3522 while (RTTimeMilliTS() - tsStart < cMsTimeout)
3523 {
3524 /* Wait for the global signal semaphore getting signalled. */
3525 int vrc = RTSemEventWait(g_SemEventGuestCtrlCanceled, 100 /* ms */);
3526 if (RT_FAILURE(vrc))
3527 {
3528 if (vrc != VERR_TIMEOUT)
3529 {
3530 RTPrintf(GuestCtrl::tr("Waiting failed with %Rrc\n"), vrc);
3531 break;
3532 }
3533 }
3534 else
3535 break;
3536
3537 /* We need to process the event queue, otherwise our registered listeners won't get any events. */
3538 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
3539 }
3540
3541 if (!pGuestListener.isNull())
3542 {
3543 /* Guest callback unregistration. */
3544 ComPtr<IEventSource> pES;
3545 CHECK_ERROR(pCtx->pGuest, COMGETTER(EventSource)(pES.asOutParam()));
3546 if (!pES.isNull())
3547 CHECK_ERROR(pES, UnregisterListener(pGuestListener));
3548 pGuestListener.setNull();
3549 }
3550 }
3551 catch (std::bad_alloc &)
3552 {
3553 hrc = E_OUTOFMEMORY;
3554 }
3555
3556 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3557}
3558
3559/**
3560 * Access the guest control store.
3561 *
3562 * @returns program exit code.
3563 * @note see the command line API description for parameters
3564 */
3565RTEXITCODE handleGuestControl(HandlerArg *pArg)
3566{
3567 AssertPtr(pArg);
3568
3569 /*
3570 * Command definitions.
3571 */
3572 static const GCTLCMDDEF s_aCmdDefs[] =
3573 {
3574 { "run", gctlHandleRun, HELP_SCOPE_GUESTCONTROL_RUN, 0 },
3575 { "start", gctlHandleStart, HELP_SCOPE_GUESTCONTROL_START, 0 },
3576 { "copyfrom", gctlHandleCopyFrom, HELP_SCOPE_GUESTCONTROL_COPYFROM, 0 },
3577 { "copyto", gctlHandleCopyTo, HELP_SCOPE_GUESTCONTROL_COPYTO, 0 },
3578
3579 { "mkdir", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3580 { "md", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3581 { "createdirectory", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3582 { "createdir", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3583
3584 { "rmdir", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3585 { "removedir", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3586 { "removedirectory", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3587
3588 { "rm", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3589 { "removefile", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3590 { "erase", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3591 { "del", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3592 { "delete", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3593
3594 { "mv", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3595 { "move", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3596 { "ren", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3597 { "rename", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3598
3599 { "mktemp", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3600 { "createtemp", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3601 { "createtemporary", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3602
3603 { "stat", gctlHandleStat, HELP_SCOPE_GUESTCONTROL_STAT, 0 },
3604
3605 { "closeprocess", gctlHandleCloseProcess, HELP_SCOPE_GUESTCONTROL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3606 { "closesession", gctlHandleCloseSession, HELP_SCOPE_GUESTCONTROL_CLOSESESSION, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3607 { "list", gctlHandleList, HELP_SCOPE_GUESTCONTROL_LIST, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3608 { "watch", gctlHandleWatch, HELP_SCOPE_GUESTCONTROL_WATCH, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3609
3610 {"updateguestadditions",gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3611 { "updateadditions", gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3612 { "updatega", gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3613
3614 { "waitrunlevel", gctlHandleWaitRunLevel, HELP_SCOPE_GUESTCONTROL_WAITRUNLEVEL, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3615 { "waitforrunlevel", gctlHandleWaitRunLevel, HELP_SCOPE_GUESTCONTROL_WAITRUNLEVEL, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3616 };
3617
3618 /*
3619 * VBoxManage guestcontrol [common-options] <VM> [common-options] <sub-command> ...
3620 *
3621 * Parse common options and VM name until we find a sub-command. Allowing
3622 * the user to put the user and password related options before the
3623 * sub-command makes it easier to edit the command line when doing several
3624 * operations with the same guest user account. (Accidentally, it also
3625 * makes the syntax diagram shorter and easier to read.)
3626 */
3627 GCTLCMDCTX CmdCtx;
3628 RTEXITCODE rcExit = gctrCmdCtxInit(&CmdCtx, pArg);
3629 if (rcExit == RTEXITCODE_SUCCESS)
3630 {
3631 static const RTGETOPTDEF s_CommonOptions[] = { GCTLCMD_COMMON_OPTION_DEFS() };
3632
3633 int ch;
3634 RTGETOPTUNION ValueUnion;
3635 RTGETOPTSTATE GetState;
3636 RTGetOptInit(&GetState, pArg->argc, pArg->argv, s_CommonOptions, RT_ELEMENTS(s_CommonOptions), 0, 0 /* No sorting! */);
3637
3638 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3639 {
3640 switch (ch)
3641 {
3642 GCTLCMD_COMMON_OPTION_CASES(&CmdCtx, ch, &ValueUnion);
3643
3644 case VINF_GETOPT_NOT_OPTION:
3645 /* First comes the VM name or UUID. */
3646 if (!CmdCtx.pszVmNameOrUuid)
3647 CmdCtx.pszVmNameOrUuid = ValueUnion.psz;
3648 /*
3649 * The sub-command is next. Look it up and invoke it.
3650 * Note! Currently no warnings about user/password options (like we'll do later on)
3651 * for GCTLCMDCTX_F_SESSION_ANONYMOUS commands. No reason to be too pedantic.
3652 */
3653 else
3654 {
3655 const char *pszCmd = ValueUnion.psz;
3656 uint32_t iCmd;
3657 for (iCmd = 0; iCmd < RT_ELEMENTS(s_aCmdDefs); iCmd++)
3658 if (strcmp(s_aCmdDefs[iCmd].pszName, pszCmd) == 0)
3659 {
3660 CmdCtx.pCmdDef = &s_aCmdDefs[iCmd];
3661
3662 setCurrentSubcommand(s_aCmdDefs[iCmd].fSubcommandScope);
3663 rcExit = s_aCmdDefs[iCmd].pfnHandler(&CmdCtx, pArg->argc - GetState.iNext + 1,
3664 &pArg->argv[GetState.iNext - 1]);
3665
3666 gctlCtxTerm(&CmdCtx);
3667 return rcExit;
3668 }
3669 return errorSyntax(GuestCtrl::tr("Unknown sub-command: '%s'"), pszCmd);
3670 }
3671 break;
3672
3673 default:
3674 return errorGetOpt(ch, &ValueUnion);
3675 }
3676 }
3677 if (CmdCtx.pszVmNameOrUuid)
3678 rcExit = errorSyntax(GuestCtrl::tr("Missing sub-command"));
3679 else
3680 rcExit = errorSyntax(GuestCtrl::tr("Missing VM name and sub-command"));
3681 }
3682 return rcExit;
3683}
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use