VirtualBox

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

Last change on this file was 108003, checked in by vboxsync, 4 weeks ago

Parfait: fixed the warning "Change of signedness on implicit conversion" in VBoxManage part of the code
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 148.9 KB
Line 
1/* $Id: VBoxManageGuestCtrl.cpp 108003 2025-01-31 14:05:57Z vboxsync $ */
2/** @file
3 * VBoxManage - Implementation of guestcontrol command.
4 */
5
6/*
7 * Copyright (C) 2010-2024 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 */
372static const 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 */
457static const 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 if (pCtx->pGuestSession.isNotNull())
904 CHECK_ERROR(pCtx->pGuestSession, Close());
905
906 if (pCtx->cVerbose > 4)
907 {
908 SafeIfaceArray <IGuestSession> collSessions;
909 CHECK_ERROR(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
910 RTPrintf(GuestCtrl::tr("Now %zu guest sessions registered\n"), collSessions.size());
911 }
912 }
913 else if ( pCtx->fDetachGuestSession
914 && pCtx->cVerbose)
915 RTPrintf(GuestCtrl::tr("Guest session detached\n"));
916
917 pCtx->pGuestSession.setNull();
918 }
919
920 /*
921 * Close the VM session.
922 */
923 if (pCtx->fLockedVmSession)
924 {
925 Assert(pCtx->pArg->session.isNotNull());
926 CHECK_ERROR(pCtx->pArg->session, UnlockMachine());
927 pCtx->fLockedVmSession = false;
928 }
929}
930
931
932
933
934
935/*
936 *
937 *
938 * Guest Control Command Handling.
939 * Guest Control Command Handling.
940 * Guest Control Command Handling.
941 * Guest Control Command Handling.
942 * Guest Control Command Handling.
943 *
944 *
945 */
946
947
948/** @name EXITCODEEXEC_XXX - Special run exit codes.
949 *
950 * Special exit codes for returning errors/information of a started guest
951 * process to the command line VBoxManage was started from. Useful for e.g.
952 * scripting.
953 *
954 * ASSUMING that all platforms have at least 7-bits for the exit code we can do
955 * the following mapping:
956 * - Guest exit code 0 is mapped to 0 on the host.
957 * - Guest exit codes 1 thru 93 (0x5d) are displaced by 32, so that 1
958 * becomes 33 (0x21) on the host and 93 becomes 125 (0x7d) on the host.
959 * - Guest exit codes 94 (0x5e) and above are mapped to 126 (0x5e).
960 *
961 * We ASSUME that all VBoxManage status codes are in the range 0 thru 32.
962 *
963 * @note These are frozen as of 4.1.0.
964 * @note The guest exit code mappings was introduced with 5.0 and the 'run'
965 * command, they are/was not supported by 'exec'.
966 * @sa gctlRunCalculateExitCode
967 */
968/** Process exited normally but with an exit code <> 0. */
969#define EXITCODEEXEC_CODE ((RTEXITCODE)16)
970#define EXITCODEEXEC_FAILED ((RTEXITCODE)17)
971#define EXITCODEEXEC_TERM_SIGNAL ((RTEXITCODE)18)
972#define EXITCODEEXEC_TERM_ABEND ((RTEXITCODE)19)
973#define EXITCODEEXEC_TIMEOUT ((RTEXITCODE)20)
974#define EXITCODEEXEC_DOWN ((RTEXITCODE)21)
975/** Execution was interrupt by user (ctrl-c). */
976#define EXITCODEEXEC_CANCELED ((RTEXITCODE)22)
977/** The first mapped guest (non-zero) exit code. */
978#define EXITCODEEXEC_MAPPED_FIRST 33
979/** The last mapped guest (non-zero) exit code value (inclusive). */
980#define EXITCODEEXEC_MAPPED_LAST 125
981/** The number of exit codes from EXITCODEEXEC_MAPPED_FIRST to
982 * EXITCODEEXEC_MAPPED_LAST. This is also the highest guest exit code number
983 * we're able to map. */
984#define EXITCODEEXEC_MAPPED_RANGE (93)
985/** The guest exit code displacement value. */
986#define EXITCODEEXEC_MAPPED_DISPLACEMENT 32
987/** The guest exit code was too big to be mapped. */
988#define EXITCODEEXEC_MAPPED_BIG ((RTEXITCODE)126)
989/** @} */
990
991/**
992 * Calculates the exit code of VBoxManage.
993 *
994 * @returns The exit code to return.
995 * @param enmStatus The guest process status.
996 * @param uExitCode The associated guest process exit code (where
997 * applicable).
998 * @param fReturnExitCodes Set if we're to use the 32-126 range for guest
999 * exit codes.
1000 */
1001static RTEXITCODE gctlRunCalculateExitCode(ProcessStatus_T enmStatus, ULONG uExitCode, bool fReturnExitCodes)
1002{
1003 switch (enmStatus)
1004 {
1005 case ProcessStatus_TerminatedNormally:
1006 if (uExitCode == 0)
1007 return RTEXITCODE_SUCCESS;
1008 if (!fReturnExitCodes)
1009 return EXITCODEEXEC_CODE;
1010 if (uExitCode <= EXITCODEEXEC_MAPPED_RANGE)
1011 return (RTEXITCODE) (uExitCode + EXITCODEEXEC_MAPPED_DISPLACEMENT);
1012 return EXITCODEEXEC_MAPPED_BIG;
1013
1014 case ProcessStatus_TerminatedAbnormally:
1015 return EXITCODEEXEC_TERM_ABEND;
1016 case ProcessStatus_TerminatedSignal:
1017 return EXITCODEEXEC_TERM_SIGNAL;
1018
1019#if 0 /* see caller! */
1020 case ProcessStatus_TimedOutKilled:
1021 return EXITCODEEXEC_TIMEOUT;
1022 case ProcessStatus_Down:
1023 return EXITCODEEXEC_DOWN; /* Service/OS is stopping, process was killed. */
1024 case ProcessStatus_Error:
1025 return EXITCODEEXEC_FAILED;
1026
1027 /* The following is probably for detached? */
1028 case ProcessStatus_Starting:
1029 return RTEXITCODE_SUCCESS;
1030 case ProcessStatus_Started:
1031 return RTEXITCODE_SUCCESS;
1032 case ProcessStatus_Paused:
1033 return RTEXITCODE_SUCCESS;
1034 case ProcessStatus_Terminating:
1035 return RTEXITCODE_SUCCESS; /** @todo ???? */
1036#endif
1037
1038 default:
1039 AssertMsgFailed(("Unknown exit status (%u/%u) from guest process returned!\n", enmStatus, uExitCode));
1040 return RTEXITCODE_FAILURE;
1041 }
1042}
1043
1044
1045/**
1046 * Pumps guest output to the host.
1047 *
1048 * @return IPRT status code.
1049 * @param pProcess Pointer to appropriate process object.
1050 * @param hVfsIosDst Where to write the data. Can be the bit bucket or a (valid [std]) handle.
1051 * @param uHandle Handle where to read the data from.
1052 * @param cMsTimeout Timeout (in ms) to wait for the operation to
1053 * complete.
1054 */
1055static int gctlRunPumpOutput(IProcess *pProcess, RTVFSIOSTREAM hVfsIosDst, ULONG uHandle, RTMSINTERVAL cMsTimeout)
1056{
1057 AssertPtrReturn(pProcess, VERR_INVALID_POINTER);
1058 Assert(hVfsIosDst != NIL_RTVFSIOSTREAM);
1059
1060 int vrc;
1061
1062 SafeArray<BYTE> aOutputData;
1063 HRESULT hrc = pProcess->Read(uHandle, _64K, RT_MAX(cMsTimeout, 1), ComSafeArrayAsOutParam(aOutputData));
1064 if (SUCCEEDED(hrc))
1065 {
1066 size_t cbOutputData = aOutputData.size();
1067 if (cbOutputData == 0)
1068 vrc = VINF_SUCCESS;
1069 else
1070 {
1071 BYTE const *pbBuf = aOutputData.raw();
1072 AssertPtr(pbBuf);
1073
1074 vrc = RTVfsIoStrmWrite(hVfsIosDst, pbBuf, cbOutputData, true /*fBlocking*/, NULL);
1075 if (RT_FAILURE(vrc))
1076 RTMsgError(GuestCtrl::tr("Unable to write output, vrc=%Rrc\n"), vrc);
1077 }
1078 }
1079 else
1080 vrc = gctlPrintError(pProcess, COM_IIDOF(IProcess));
1081 return vrc;
1082}
1083
1084
1085/**
1086 * Configures a host handle for pumping guest bits.
1087 *
1088 * @returns true if enabled and we successfully configured it.
1089 * @param fEnabled Whether pumping this pipe is configured to std handles,
1090 * or going to the bit bucket instead.
1091 * @param enmHandle The IPRT standard handle designation.
1092 * @param pszName The name for user messages.
1093 * @param enmTransformation The transformation to apply.
1094 * @param phVfsIos Where to return the resulting I/O stream handle.
1095 */
1096static bool gctlRunSetupHandle(bool fEnabled, RTHANDLESTD enmHandle, const char *pszName,
1097 kStreamTransform enmTransformation, PRTVFSIOSTREAM phVfsIos)
1098{
1099 if (fEnabled)
1100 {
1101 int vrc = RTVfsIoStrmFromStdHandle(enmHandle, 0, true /*fLeaveOpen*/, phVfsIos);
1102 if (RT_SUCCESS(vrc))
1103 {
1104 if (enmTransformation != kStreamTransform_None)
1105 {
1106 RTMsgWarning(GuestCtrl::tr("Unsupported %s line ending conversion"), pszName);
1107 /** @todo Implement dos2unix and unix2dos stream filters. */
1108 }
1109 return true;
1110 }
1111 RTMsgWarning(GuestCtrl::tr("Error getting %s handle: %Rrc"), pszName, vrc);
1112 }
1113 else /* If disabled, all goes to / gets fed to/from the bit bucket. */
1114 {
1115 RTFILE hFile;
1116 int vrc = RTFileOpenBitBucket(&hFile, enmHandle == RTHANDLESTD_INPUT ? RTFILE_O_READ : RTFILE_O_WRITE);
1117 if (RT_SUCCESS(vrc))
1118 {
1119 vrc = RTVfsIoStrmFromRTFile(hFile, 0 /* fOpen */, false /* fLeaveOpen */, phVfsIos);
1120 if (RT_SUCCESS(vrc))
1121 return true;
1122 }
1123 }
1124
1125 return false;
1126}
1127
1128
1129/**
1130 * Returns the remaining time (in ms) based on the start time and a set
1131 * timeout value. Returns RT_INDEFINITE_WAIT if no timeout was specified.
1132 *
1133 * @return RTMSINTERVAL Time left (in ms).
1134 * @param u64StartMs Start time (in ms).
1135 * @param cMsTimeout Timeout value (in ms).
1136 */
1137static RTMSINTERVAL gctlRunGetRemainingTime(uint64_t u64StartMs, RTMSINTERVAL cMsTimeout)
1138{
1139 if (!cMsTimeout || cMsTimeout == RT_INDEFINITE_WAIT) /* If no timeout specified, wait forever. */
1140 return RT_INDEFINITE_WAIT;
1141
1142 uint64_t u64ElapsedMs = RTTimeMilliTS() - u64StartMs;
1143 if (u64ElapsedMs >= cMsTimeout)
1144 return 0;
1145
1146 return cMsTimeout - (RTMSINTERVAL)u64ElapsedMs;
1147}
1148
1149/**
1150 * Common handler for the 'run' and 'start' commands.
1151 *
1152 * @returns Command exit code.
1153 * @param pCtx Guest session context.
1154 * @param argc The argument count.
1155 * @param argv The argument vector for this command.
1156 * @param fRunCmd Set if it's 'run' clear if 'start'.
1157 */
1158static RTEXITCODE gctlHandleRunCommon(PGCTLCMDCTX pCtx, int argc, char **argv, bool fRunCmd)
1159{
1160 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1161
1162 /*
1163 * Parse arguments.
1164 */
1165 enum kGstCtrlRunOpt
1166 {
1167 kGstCtrlRunOpt_IgnoreOrphanedProcesses = 1000,
1168 kGstCtrlRunOpt_NoProfile, /** @todo Deprecated and will be removed soon; use kGstCtrlRunOpt_Profile instead, if needed. */
1169 kGstCtrlRunOpt_Profile,
1170 kGstCtrlRunOpt_Dos2Unix,
1171 kGstCtrlRunOpt_Unix2Dos,
1172 kGstCtrlRunOpt_WaitForStdOut,
1173 kGstCtrlRunOpt_NoWaitForStdOut,
1174 kGstCtrlRunOpt_WaitForStdErr,
1175 kGstCtrlRunOpt_NoWaitForStdErr
1176 };
1177 static const RTGETOPTDEF s_aOptions[] =
1178 {
1179 GCTLCMD_COMMON_OPTION_DEFS()
1180 { "--arg0", '0', RTGETOPT_REQ_STRING },
1181 { "--cwd", 'C', RTGETOPT_REQ_STRING },
1182 { "--putenv", 'E', RTGETOPT_REQ_STRING },
1183 { "--exe", 'e', RTGETOPT_REQ_STRING },
1184 { "--timeout", 't', RTGETOPT_REQ_UINT32 },
1185 { "--unquoted-args", 'u', RTGETOPT_REQ_NOTHING },
1186 { "--ignore-orphaned-processes", kGstCtrlRunOpt_IgnoreOrphanedProcesses, RTGETOPT_REQ_NOTHING },
1187 { "--no-profile", kGstCtrlRunOpt_NoProfile, RTGETOPT_REQ_NOTHING }, /** @todo Deprecated. */
1188 { "--profile", kGstCtrlRunOpt_Profile, RTGETOPT_REQ_NOTHING },
1189 /* run only: 6 - options */
1190 { "--dos2unix", kGstCtrlRunOpt_Dos2Unix, RTGETOPT_REQ_NOTHING },
1191 { "--unix2dos", kGstCtrlRunOpt_Unix2Dos, RTGETOPT_REQ_NOTHING },
1192 { "--no-wait-stdout", kGstCtrlRunOpt_NoWaitForStdOut, RTGETOPT_REQ_NOTHING },
1193 { "--wait-stdout", kGstCtrlRunOpt_WaitForStdOut, RTGETOPT_REQ_NOTHING },
1194 { "--no-wait-stderr", kGstCtrlRunOpt_NoWaitForStdErr, RTGETOPT_REQ_NOTHING },
1195 { "--wait-stderr", kGstCtrlRunOpt_WaitForStdErr, RTGETOPT_REQ_NOTHING },
1196 };
1197
1198 /** @todo stdin handling. */
1199
1200 int ch;
1201 RTGETOPTUNION ValueUnion;
1202 RTGETOPTSTATE GetState;
1203 int vrc = RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions) - (fRunCmd ? 0 : 6),
1204 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1205 AssertRC(vrc);
1206
1207 com::SafeArray<ProcessCreateFlag_T> aCreateFlags;
1208 com::SafeArray<ProcessWaitForFlag_T> aWaitFlags;
1209 com::SafeArray<IN_BSTR> aArgs;
1210 com::SafeArray<IN_BSTR> aEnv;
1211 const char * pszImage = NULL;
1212 const char * pszArg0 = NULL; /* Argument 0 to use. pszImage will be used if not specified. */
1213 const char * pszCwd = NULL;
1214 bool fWaitForStdOut = fRunCmd;
1215 bool fWaitForStdErr = fRunCmd;
1216 RTVFSIOSTREAM hVfsStdOut = NIL_RTVFSIOSTREAM;
1217 RTVFSIOSTREAM hVfsStdErr = NIL_RTVFSIOSTREAM;
1218 enum kStreamTransform enmStdOutTransform = kStreamTransform_None;
1219 enum kStreamTransform enmStdErrTransform = kStreamTransform_None;
1220 RTMSINTERVAL cMsTimeout = 0;
1221
1222 try
1223 {
1224 /* Wait for process start in any case. This is useful for scripting VBoxManage
1225 * when relying on its overall exit code. */
1226 aWaitFlags.push_back(ProcessWaitForFlag_Start);
1227
1228 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1229 {
1230 /* For options that require an argument, ValueUnion has received the value. */
1231 switch (ch)
1232 {
1233 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1234
1235 case 'E':
1236 if ( ValueUnion.psz[0] == '\0'
1237 || ValueUnion.psz[0] == '=')
1238 return errorSyntax(GuestCtrl::tr("Invalid argument variable[=value]: '%s'"), ValueUnion.psz);
1239 aEnv.push_back(Bstr(ValueUnion.psz).raw());
1240 break;
1241
1242 case kGstCtrlRunOpt_IgnoreOrphanedProcesses:
1243 aCreateFlags.push_back(ProcessCreateFlag_IgnoreOrphanedProcesses);
1244 break;
1245
1246 case kGstCtrlRunOpt_NoProfile:
1247 /** @todo Deprecated, will be removed. */
1248 RTPrintf(GuestCtrl::tr("Warning: Deprecated option \"--no-profile\" specified\n"));
1249 break;
1250
1251 case kGstCtrlRunOpt_Profile:
1252 aCreateFlags.push_back(ProcessCreateFlag_Profile);
1253 break;
1254
1255 case '0':
1256 pszArg0 = ValueUnion.psz;
1257 break;
1258
1259 case 'C':
1260 pszCwd = ValueUnion.psz;
1261 break;
1262
1263 case 'e':
1264 pszImage = ValueUnion.psz;
1265 break;
1266
1267 case 'u':
1268 aCreateFlags.push_back(ProcessCreateFlag_UnquotedArguments);
1269 break;
1270
1271 /** @todo Add a hidden flag. */
1272
1273 case 't': /* Timeout */
1274 cMsTimeout = ValueUnion.u32;
1275 break;
1276
1277 /* run only options: */
1278 case kGstCtrlRunOpt_Dos2Unix:
1279 Assert(fRunCmd);
1280 enmStdErrTransform = enmStdOutTransform = kStreamTransform_Dos2Unix;
1281 break;
1282 case kGstCtrlRunOpt_Unix2Dos:
1283 Assert(fRunCmd);
1284 enmStdErrTransform = enmStdOutTransform = kStreamTransform_Unix2Dos;
1285 break;
1286
1287 case kGstCtrlRunOpt_WaitForStdOut:
1288 Assert(fRunCmd);
1289 fWaitForStdOut = true;
1290 break;
1291 case kGstCtrlRunOpt_NoWaitForStdOut:
1292 Assert(fRunCmd);
1293 fWaitForStdOut = false;
1294 break;
1295
1296 case kGstCtrlRunOpt_WaitForStdErr:
1297 Assert(fRunCmd);
1298 fWaitForStdErr = true;
1299 break;
1300 case kGstCtrlRunOpt_NoWaitForStdErr:
1301 Assert(fRunCmd);
1302 fWaitForStdErr = false;
1303 break;
1304
1305 case VINF_GETOPT_NOT_OPTION:
1306 /* VINF_GETOPT_NOT_OPTION comes after all options have been specified;
1307 * so if pszImage still is zero at this stage, we use the first non-option found
1308 * as the image being executed. */
1309 if (!pszImage)
1310 pszImage = ValueUnion.psz;
1311 else /* Add anything else to the arguments vector. */
1312 aArgs.push_back(Bstr(ValueUnion.psz).raw());
1313 break;
1314
1315 default:
1316 return errorGetOpt(ch, &ValueUnion);
1317
1318 } /* switch */
1319 } /* while RTGetOpt */
1320
1321 /* Must have something to execute. */
1322 if (!pszImage || !*pszImage)
1323 return errorSyntax(GuestCtrl::tr("No executable specified!"));
1324
1325 /* Set the arg0 argument (descending precedence):
1326 * - If an argument 0 is explicitly specified (via "--arg0"), use this as argument 0.
1327 * - When an image is specified explicitly (via "--exe <image>"), use <image> as argument 0.
1328 * Note: This is (and ever was) the default behavior users expect, so don't change this! */
1329 if (pszArg0)
1330 aArgs.push_front(Bstr(pszArg0).raw());
1331 else
1332 aArgs.push_front(Bstr(pszImage).raw());
1333
1334 if (pCtx->cVerbose) /* Print the final execution parameters in verbose mode. */
1335 {
1336 RTPrintf(GuestCtrl::tr("Executing:\n Image : %s\n"), pszImage);
1337 for (size_t i = 0; i < aArgs.size(); i++)
1338 RTPrintf(GuestCtrl::tr(" arg[%d]: %ls\n"), i, aArgs[i]);
1339 }
1340 /* No altering of aArgs and/or pszImage after this point! */
1341
1342 /*
1343 * Finalize process creation and wait flags and input/output streams.
1344 */
1345 if (!fRunCmd)
1346 {
1347 aCreateFlags.push_back(ProcessCreateFlag_WaitForProcessStartOnly);
1348 Assert(!fWaitForStdOut);
1349 Assert(!fWaitForStdErr);
1350 }
1351 else
1352 {
1353 aWaitFlags.push_back(ProcessWaitForFlag_Terminate);
1354 if (gctlRunSetupHandle(fWaitForStdOut, RTHANDLESTD_OUTPUT, "stdout", enmStdOutTransform, &hVfsStdOut))
1355 {
1356 if (fWaitForStdOut)
1357 {
1358 aCreateFlags.push_back(ProcessCreateFlag_WaitForStdOut);
1359 aWaitFlags.push_back(ProcessWaitForFlag_StdOut);
1360 }
1361 }
1362 else /* Failed to set up handle, disable. */
1363 fWaitForStdOut = false;
1364
1365 if (gctlRunSetupHandle(fWaitForStdErr, RTHANDLESTD_ERROR, "stderr", enmStdErrTransform, &hVfsStdErr))
1366 {
1367 if (fWaitForStdErr)
1368 {
1369 aCreateFlags.push_back(ProcessCreateFlag_WaitForStdErr);
1370 aWaitFlags.push_back(ProcessWaitForFlag_StdErr);
1371 }
1372 }
1373 else /* Failed to set up handle, disable. */
1374 fWaitForStdErr = false;
1375 }
1376 }
1377 catch (std::bad_alloc &)
1378 {
1379 return RTMsgErrorExit(RTEXITCODE_FAILURE, "VERR_NO_MEMORY\n");
1380 }
1381
1382 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
1383 if (rcExit != RTEXITCODE_SUCCESS)
1384 return rcExit;
1385
1386 HRESULT hrc;
1387
1388 try
1389 {
1390 do
1391 {
1392 /* Get current time stamp to later calculate rest of timeout left. */
1393 uint64_t msStart = RTTimeMilliTS();
1394
1395 /*
1396 * Create the process.
1397 */
1398 if (pCtx->cVerbose)
1399 {
1400 if (cMsTimeout == 0)
1401 RTPrintf(GuestCtrl::tr("Starting guest process ...\n"));
1402 else
1403 RTPrintf(GuestCtrl::tr("Starting guest process (within %ums)\n"), cMsTimeout);
1404 }
1405 ComPtr<IGuestProcess> pProcess;
1406 CHECK_ERROR_BREAK(pCtx->pGuestSession, ProcessCreate(Bstr(pszImage).raw(),
1407 ComSafeArrayAsInParam(aArgs),
1408 Bstr(pszCwd).raw(),
1409 ComSafeArrayAsInParam(aEnv),
1410 ComSafeArrayAsInParam(aCreateFlags),
1411 gctlRunGetRemainingTime(msStart, cMsTimeout),
1412 pProcess.asOutParam()));
1413
1414 /*
1415 * Explicitly wait for the guest process to be in a started state.
1416 */
1417 com::SafeArray<ProcessWaitForFlag_T> aWaitStartFlags;
1418 aWaitStartFlags.push_back(ProcessWaitForFlag_Start);
1419 ProcessWaitResult_T waitResult;
1420 CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitStartFlags),
1421 gctlRunGetRemainingTime(msStart, cMsTimeout), &waitResult));
1422
1423 ULONG uPID = 0;
1424 CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID));
1425 if (fRunCmd && pCtx->cVerbose)
1426 RTPrintf(GuestCtrl::tr("Process '%s' (PID %RU32) started\n"), pszImage, uPID);
1427 else if (!fRunCmd && pCtx->cVerbose)
1428 {
1429 /* Just print plain PID to make it easier for scripts
1430 * invoking VBoxManage. */
1431 RTPrintf(GuestCtrl::tr("[%RU32 - Session %RU32]\n"), uPID, pCtx->uSessionID);
1432 }
1433
1434 /*
1435 * Wait for process to exit/start...
1436 */
1437 RTMSINTERVAL cMsTimeLeft = 1; /* Will be calculated. */
1438 bool fReadStdOut = false;
1439 bool fReadStdErr = false;
1440 bool fCompleted = false;
1441 bool fCompletedStartCmd = false;
1442
1443 vrc = VINF_SUCCESS;
1444 while ( !fCompleted
1445 && cMsTimeLeft > 0)
1446 {
1447 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1448 CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitFlags),
1449 RT_MIN(500 /*ms*/, RT_MAX(cMsTimeLeft, 1 /*ms*/)),
1450 &waitResult));
1451 if (pCtx->cVerbose)
1452 RTPrintf(GuestCtrl::tr("Wait result is '%s' (%d)\n"), gctlProcessWaitResultToText(waitResult), waitResult);
1453 switch (waitResult)
1454 {
1455 case ProcessWaitResult_Start: /** @todo you always wait for 'start', */
1456 fCompletedStartCmd = fCompleted = !fRunCmd; /* Only wait for startup if the 'start' command. */
1457 if (!fCompleted && aWaitFlags[0] == ProcessWaitForFlag_Start)
1458 aWaitFlags[0] = ProcessWaitForFlag_Terminate;
1459 break;
1460 case ProcessWaitResult_StdOut:
1461 fReadStdOut = true;
1462 break;
1463 case ProcessWaitResult_StdErr:
1464 fReadStdErr = true;
1465 break;
1466 case ProcessWaitResult_Terminate:
1467 if (pCtx->cVerbose)
1468 RTPrintf(GuestCtrl::tr("Process terminated\n"));
1469 /* Process terminated, we're done. */
1470 fCompleted = true;
1471 break;
1472 case ProcessWaitResult_WaitFlagNotSupported:
1473 /* The guest does not support waiting for stdout/err, so
1474 * yield to reduce the CPU load due to busy waiting. */
1475 RTThreadYield();
1476 fReadStdOut = fReadStdErr = true;
1477 /* Note: In case the user specified explicitly not wanting to wait for stdout / stderr,
1478 * the configured VFS handle goes to / will be fed from the bit bucket. */
1479 break;
1480 case ProcessWaitResult_Timeout:
1481 {
1482 /** @todo It is really unclear whether we will get stuck with the timeout
1483 * result here if the guest side times out the process and fails to
1484 * kill the process... To be on the save side, double the IPC and
1485 * check the process status every time we time out. */
1486 ProcessStatus_T enmProcStatus;
1487 CHECK_ERROR_BREAK(pProcess, COMGETTER(Status)(&enmProcStatus));
1488 if ( enmProcStatus == ProcessStatus_TimedOutKilled
1489 || enmProcStatus == ProcessStatus_TimedOutAbnormally)
1490 fCompleted = true;
1491 fReadStdOut = fReadStdErr = true;
1492 break;
1493 }
1494 case ProcessWaitResult_Status:
1495 /* ignore. */
1496 break;
1497 case ProcessWaitResult_Error:
1498 /* waitFor is dead in the water, I think, so better leave the loop. */
1499 vrc = VERR_CALLBACK_RETURN;
1500 break;
1501
1502 case ProcessWaitResult_StdIn: AssertFailed(); /* did ask for this! */ break;
1503 case ProcessWaitResult_None: AssertFailed(); /* used. */ break;
1504 default: AssertFailed(); /* huh? */ break;
1505 }
1506
1507 if (g_fGuestCtrlCanceled)
1508 break;
1509
1510 /*
1511 * Pump output as needed.
1512 */
1513 if (fReadStdOut)
1514 {
1515 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1516 int vrc2 = gctlRunPumpOutput(pProcess, hVfsStdOut, 1 /* StdOut */, cMsTimeLeft);
1517 if (RT_FAILURE(vrc2) && RT_SUCCESS(vrc))
1518 vrc = vrc2;
1519 fReadStdOut = false;
1520 }
1521 if (fReadStdErr)
1522 {
1523 cMsTimeLeft = gctlRunGetRemainingTime(msStart, cMsTimeout);
1524 int vrc2 = gctlRunPumpOutput(pProcess, hVfsStdErr, 2 /* StdErr */, cMsTimeLeft);
1525 if (RT_FAILURE(vrc2) && RT_SUCCESS(vrc))
1526 vrc = vrc2;
1527 fReadStdErr = false;
1528 }
1529 if ( RT_FAILURE(vrc)
1530 || g_fGuestCtrlCanceled)
1531 break;
1532
1533 /*
1534 * Process events before looping.
1535 */
1536 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
1537 } /* while */
1538
1539 /*
1540 * Report status back to the user.
1541 */
1542 if (g_fGuestCtrlCanceled)
1543 {
1544 if (pCtx->cVerbose)
1545 RTPrintf(GuestCtrl::tr("Process execution aborted!\n"));
1546 rcExit = EXITCODEEXEC_CANCELED;
1547 }
1548 else if (fCompletedStartCmd)
1549 {
1550 if (pCtx->cVerbose)
1551 RTPrintf(GuestCtrl::tr("Process successfully started!\n"));
1552 rcExit = RTEXITCODE_SUCCESS;
1553 }
1554 else if (fCompleted)
1555 {
1556 ProcessStatus_T procStatus;
1557 CHECK_ERROR_BREAK(pProcess, COMGETTER(Status)(&procStatus));
1558 if ( procStatus == ProcessStatus_TerminatedNormally
1559 || procStatus == ProcessStatus_TerminatedAbnormally
1560 || procStatus == ProcessStatus_TerminatedSignal)
1561 {
1562 LONG lExitCode;
1563 CHECK_ERROR_BREAK(pProcess, COMGETTER(ExitCode)(&lExitCode));
1564 if (pCtx->cVerbose)
1565 RTPrintf(GuestCtrl::tr("Exit code=%u (Status=%u [%s])\n"),
1566 lExitCode, procStatus, gctlProcessStatusToText(procStatus));
1567
1568 rcExit = gctlRunCalculateExitCode(procStatus, (ULONG)lExitCode, true /*fReturnExitCodes*/);
1569 }
1570 else if ( procStatus == ProcessStatus_TimedOutKilled
1571 || procStatus == ProcessStatus_TimedOutAbnormally)
1572 {
1573 if (pCtx->cVerbose)
1574 RTPrintf(GuestCtrl::tr("Process timed out (guest side) and %s\n"),
1575 procStatus == ProcessStatus_TimedOutAbnormally
1576 ? GuestCtrl::tr("failed to terminate so far") : GuestCtrl::tr("was terminated"));
1577 rcExit = EXITCODEEXEC_TIMEOUT;
1578 }
1579 else
1580 {
1581 if (pCtx->cVerbose)
1582 RTPrintf(GuestCtrl::tr("Process now is in status [%s] (unexpected)\n"),
1583 gctlProcessStatusToText(procStatus));
1584 rcExit = RTEXITCODE_FAILURE;
1585 }
1586 }
1587 else if (RT_FAILURE_NP(vrc))
1588 {
1589 if (pCtx->cVerbose)
1590 RTPrintf(GuestCtrl::tr("Process monitor loop quit with vrc=%Rrc\n"), vrc);
1591 rcExit = RTEXITCODE_FAILURE;
1592 }
1593 else
1594 {
1595 if (pCtx->cVerbose)
1596 RTPrintf(GuestCtrl::tr("Process monitor loop timed out\n"));
1597 rcExit = EXITCODEEXEC_TIMEOUT;
1598 }
1599
1600 } while (0);
1601 }
1602 catch (std::bad_alloc &)
1603 {
1604 hrc = E_OUTOFMEMORY;
1605 }
1606
1607 /*
1608 * Decide what to do with the guest session.
1609 *
1610 * If it's the 'start' command where detach the guest process after
1611 * starting, don't close the guest session it is part of, except on
1612 * failure or ctrl-c.
1613 *
1614 * For the 'run' command the guest process quits with us.
1615 */
1616 if (!fRunCmd && SUCCEEDED(hrc) && !g_fGuestCtrlCanceled)
1617 pCtx->fDetachGuestSession = true;
1618
1619 /* Make sure we return failure on failure. */
1620 if (FAILED(hrc) && rcExit == RTEXITCODE_SUCCESS)
1621 rcExit = RTEXITCODE_FAILURE;
1622 return rcExit;
1623}
1624
1625
1626static DECLCALLBACK(RTEXITCODE) gctlHandleRun(PGCTLCMDCTX pCtx, int argc, char **argv)
1627{
1628 return gctlHandleRunCommon(pCtx, argc, argv, true /*fRunCmd*/);
1629}
1630
1631
1632static DECLCALLBACK(RTEXITCODE) gctlHandleStart(PGCTLCMDCTX pCtx, int argc, char **argv)
1633{
1634 return gctlHandleRunCommon(pCtx, argc, argv, false /*fRunCmd*/);
1635}
1636
1637
1638static RTEXITCODE gctlHandleCopy(PGCTLCMDCTX pCtx, int argc, char **argv, bool fHostToGuest)
1639{
1640 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1641
1642 /*
1643 * IGuest::CopyToGuest is kept as simple as possible to let the developer choose
1644 * what and how to implement the file enumeration/recursive lookup, like VBoxManage
1645 * does in here.
1646 */
1647 static const RTGETOPTDEF s_aOptions[] =
1648 {
1649 GCTLCMD_COMMON_OPTION_DEFS()
1650 { "--follow", 'L', RTGETOPT_REQ_NOTHING }, /* Kept for backwards-compatibility (VBox < 7.0). */
1651 { "--dereference", 'L', RTGETOPT_REQ_NOTHING },
1652 { "--no-replace", 'n', RTGETOPT_REQ_NOTHING }, /* like "-n" via cp. */
1653 { "--recursive", 'R', RTGETOPT_REQ_NOTHING },
1654 { "--target-directory", 't', RTGETOPT_REQ_STRING },
1655 { "--update", 'u', RTGETOPT_REQ_NOTHING } /* like "-u" via cp. */
1656 };
1657
1658 int ch;
1659 RTGETOPTUNION ValueUnion;
1660 RTGETOPTSTATE GetState;
1661 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1662
1663 const char *pszDst = NULL;
1664 bool fFollow = false;
1665 bool fRecursive = false;
1666 bool fUpdate = false; /* Whether to copy the file only if it's newer than the target. */
1667 bool fNoReplace = false; /* Only copy the file if it does not exist yet. */
1668
1669 int vrc = VINF_SUCCESS;
1670 while ( (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
1671 && ch != VINF_GETOPT_NOT_OPTION)
1672 {
1673 /* For options that require an argument, ValueUnion has received the value. */
1674 switch (ch)
1675 {
1676 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1677
1678 case 'L':
1679 if (!RTStrICmp(ValueUnion.pDef->pszLong, "--follow"))
1680 RTMsgWarning("--follow is deprecated; use --dereference instead.");
1681 fFollow = true;
1682 break;
1683
1684 case 'n':
1685 fNoReplace = true;
1686 break;
1687
1688 case 'R':
1689 fRecursive = true;
1690 break;
1691
1692 case 't':
1693 pszDst = ValueUnion.psz;
1694 break;
1695
1696 case 'u':
1697 fUpdate = true;
1698 break;
1699
1700 default:
1701 return errorGetOpt(ch, &ValueUnion);
1702 }
1703 }
1704
1705 char **papszSources = RTGetOptNonOptionArrayPtr(&GetState);
1706 size_t cSources = (size_t)(&argv[argc] - papszSources);
1707
1708 if (!cSources)
1709 return errorSyntax(GuestCtrl::tr("No sources specified!"));
1710
1711 /* Unless a --target-directory is given, the last argument is the destination, so
1712 bump it from the source list. */
1713 if (pszDst == NULL && cSources >= 2)
1714 pszDst = papszSources[--cSources];
1715
1716 if (pszDst == NULL)
1717 return errorSyntax(GuestCtrl::tr("No destination specified!"));
1718
1719 char szAbsDst[RTPATH_MAX];
1720 if (!fHostToGuest)
1721 {
1722 vrc = RTPathAbs(pszDst, szAbsDst, sizeof(szAbsDst));
1723 if (RT_SUCCESS(vrc))
1724 pszDst = szAbsDst;
1725 else
1726 return RTMsgErrorExitFailure(GuestCtrl::tr("RTPathAbs failed on '%s': %Rrc"), pszDst, vrc);
1727 }
1728
1729 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
1730 if (rcExit != RTEXITCODE_SUCCESS)
1731 return rcExit;
1732
1733 /*
1734 * Done parsing arguments, do some more preparations.
1735 */
1736 if (pCtx->cVerbose)
1737 {
1738 if (fHostToGuest)
1739 RTPrintf(GuestCtrl::tr("Copying from host to guest ...\n"));
1740 else
1741 RTPrintf(GuestCtrl::tr("Copying from guest to host ...\n"));
1742 }
1743
1744 HRESULT hrc = S_OK;
1745
1746 com::SafeArray<IN_BSTR> aSources;
1747 com::SafeArray<IN_BSTR> aFilters; /** @todo Populate those? For now we use caller-based globbing. */
1748 com::SafeArray<IN_BSTR> aCopyFlags;
1749
1750 size_t iSrc = 0;
1751 for (; iSrc < cSources; iSrc++)
1752 {
1753 aSources.push_back(Bstr(papszSources[iSrc]).raw());
1754 aFilters.push_back(Bstr("").raw()); /* Empty for now. See @todo above. */
1755
1756 /* Compile the comma-separated list of flags.
1757 * Certain flags are only available for specific file system objects, e.g. directories. */
1758 bool fIsDir = false;
1759 if (fHostToGuest)
1760 {
1761 RTFSOBJINFO ObjInfo;
1762 vrc = RTPathQueryInfo(papszSources[iSrc], &ObjInfo, RTFSOBJATTRADD_NOTHING);
1763 if (RT_SUCCESS(vrc))
1764 fIsDir = RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode);
1765
1766 if (RT_FAILURE(vrc))
1767 break;
1768 }
1769 else /* Guest to host. */
1770 {
1771 ComPtr<IGuestFsObjInfo> pFsObjInfo;
1772 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(papszSources[iSrc]).raw(), RT_BOOL(fFollow) /* fFollowSymlinks */,
1773 pFsObjInfo.asOutParam());
1774 if (SUCCEEDED(hrc))
1775 {
1776 FsObjType_T enmObjType;
1777 CHECK_ERROR(pFsObjInfo,COMGETTER(Type)(&enmObjType));
1778 if (SUCCEEDED(hrc))
1779 {
1780 /* Take action according to source file. */
1781 fIsDir = enmObjType == FsObjType_Directory;
1782 }
1783 }
1784
1785 if (FAILED(hrc))
1786 {
1787 vrc = gctlPrintError(pCtx->pGuestSession, COM_IIDOF(IGuestSession));
1788 break;
1789 }
1790 }
1791
1792 if (pCtx->cVerbose)
1793 RTPrintf(GuestCtrl::tr("Source '%s' is a %s\n"), papszSources[iSrc], fIsDir ? "directory" : "file");
1794
1795 Utf8Str strCopyFlags;
1796 if (fRecursive && fIsDir) /* Only available for directories. Just ignore otherwise. */
1797 strCopyFlags += "Recursive,";
1798 if (fFollow)
1799 strCopyFlags += "FollowLinks,";
1800 if (fUpdate) /* Only copy source files which are newer than the destination file. */
1801 strCopyFlags += "Update,";
1802 if (fNoReplace) /* Do not overwrite files. */
1803 strCopyFlags += "NoReplace,";
1804 else if (fIsDir)
1805 strCopyFlags += "CopyIntoExisting,"; /* Only copy into existing directories if "--no-replace" isn't specified. */
1806 aCopyFlags.push_back(Bstr(strCopyFlags).raw());
1807 }
1808
1809 if (RT_FAILURE(vrc))
1810 return RTMsgErrorExitFailure(GuestCtrl::tr("Error looking file system information for source '%s', vrc=%Rrc"),
1811 papszSources[iSrc], vrc);
1812
1813 ComPtr<IProgress> pProgress;
1814 if (fHostToGuest)
1815 {
1816 hrc = pCtx->pGuestSession->CopyToGuest(ComSafeArrayAsInParam(aSources),
1817 ComSafeArrayAsInParam(aFilters), ComSafeArrayAsInParam(aCopyFlags),
1818 Bstr(pszDst).raw(), pProgress.asOutParam());
1819 }
1820 else /* Guest to host. */
1821 {
1822 hrc = pCtx->pGuestSession->CopyFromGuest(ComSafeArrayAsInParam(aSources),
1823 ComSafeArrayAsInParam(aFilters), ComSafeArrayAsInParam(aCopyFlags),
1824 Bstr(pszDst).raw(), pProgress.asOutParam());
1825 }
1826
1827 if (FAILED(hrc))
1828 {
1829 vrc = gctlPrintError(pCtx->pGuestSession, COM_IIDOF(IGuestSession));
1830 }
1831 else if (pProgress.isNotNull())
1832 {
1833 if (pCtx->cVerbose)
1834 hrc = showProgress(pProgress);
1835 else
1836 hrc = pProgress->WaitForCompletion(-1 /* No timeout */);
1837 if (SUCCEEDED(hrc))
1838 CHECK_PROGRESS_ERROR(pProgress, (GuestCtrl::tr("File copy failed")));
1839 vrc = gctlPrintProgressError(pProgress);
1840 }
1841
1842 if (RT_FAILURE(vrc))
1843 rcExit = RTEXITCODE_FAILURE;
1844
1845 return rcExit;
1846}
1847
1848static DECLCALLBACK(RTEXITCODE) gctlHandleCopyFrom(PGCTLCMDCTX pCtx, int argc, char **argv)
1849{
1850 return gctlHandleCopy(pCtx, argc, argv, false /* Guest to host */);
1851}
1852
1853static DECLCALLBACK(RTEXITCODE) gctlHandleCopyTo(PGCTLCMDCTX pCtx, int argc, char **argv)
1854{
1855 return gctlHandleCopy(pCtx, argc, argv, true /* Host to guest */);
1856}
1857
1858static DECLCALLBACK(RTEXITCODE) gctrlHandleMkDir(PGCTLCMDCTX pCtx, int argc, char **argv)
1859{
1860 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1861
1862 static const RTGETOPTDEF s_aOptions[] =
1863 {
1864 GCTLCMD_COMMON_OPTION_DEFS()
1865 { "--mode", 'm', RTGETOPT_REQ_UINT32 },
1866 { "--parents", 'P', RTGETOPT_REQ_NOTHING }
1867 };
1868
1869 int ch;
1870 RTGETOPTUNION ValueUnion;
1871 RTGETOPTSTATE GetState;
1872 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1873
1874 SafeArray<DirectoryCreateFlag_T> aDirCreateFlags;
1875 uint32_t fDirMode = 0; /* Default mode. */
1876 uint32_t cDirsCreated = 0;
1877 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
1878
1879 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1880 {
1881 /* For options that require an argument, ValueUnion has received the value. */
1882 switch (ch)
1883 {
1884 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1885
1886 case 'm': /* Mode */
1887 fDirMode = ValueUnion.u32;
1888 break;
1889
1890 case 'P': /* Create parents */
1891 aDirCreateFlags.push_back(DirectoryCreateFlag_Parents);
1892 break;
1893
1894 case VINF_GETOPT_NOT_OPTION:
1895 if (cDirsCreated == 0)
1896 {
1897 /*
1898 * First non-option - no more options now.
1899 */
1900 rcExit = gctlCtxPostOptionParsingInit(pCtx);
1901 if (rcExit != RTEXITCODE_SUCCESS)
1902 return rcExit;
1903 if (pCtx->cVerbose)
1904 RTPrintf(GuestCtrl::tr("Creating %RU32 directories...\n"), argc - GetState.iNext + 1);
1905 }
1906 if (g_fGuestCtrlCanceled)
1907 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("mkdir was interrupted by Ctrl-C (%u left)\n"),
1908 argc - GetState.iNext + 1);
1909
1910 /*
1911 * Create the specified directory.
1912 *
1913 * On failure we'll change the exit status to failure and
1914 * continue with the next directory that needs creating. We do
1915 * this because we only create new things, and because this is
1916 * how /bin/mkdir works on unix.
1917 */
1918 cDirsCreated++;
1919 if (pCtx->cVerbose)
1920 RTPrintf(GuestCtrl::tr("Creating directory \"%s\" ...\n"), ValueUnion.psz);
1921 try
1922 {
1923 HRESULT hrc;
1924 CHECK_ERROR(pCtx->pGuestSession, DirectoryCreate(Bstr(ValueUnion.psz).raw(),
1925 fDirMode, ComSafeArrayAsInParam(aDirCreateFlags)));
1926 if (FAILED(hrc))
1927 rcExit = RTEXITCODE_FAILURE;
1928 }
1929 catch (std::bad_alloc &)
1930 {
1931 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
1932 }
1933 break;
1934
1935 default:
1936 return errorGetOpt(ch, &ValueUnion);
1937 }
1938 }
1939
1940 if (!cDirsCreated)
1941 return errorSyntax(GuestCtrl::tr("No directory to create specified!"));
1942 return rcExit;
1943}
1944
1945
1946static DECLCALLBACK(RTEXITCODE) gctlHandleRmDir(PGCTLCMDCTX pCtx, int argc, char **argv)
1947{
1948 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
1949
1950 static const RTGETOPTDEF s_aOptions[] =
1951 {
1952 GCTLCMD_COMMON_OPTION_DEFS()
1953 { "--recursive", 'R', RTGETOPT_REQ_NOTHING },
1954 };
1955
1956 int ch;
1957 RTGETOPTUNION ValueUnion;
1958 RTGETOPTSTATE GetState;
1959 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
1960
1961 bool fRecursive = false;
1962 uint32_t cDirRemoved = 0;
1963 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
1964
1965 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
1966 {
1967 /* For options that require an argument, ValueUnion has received the value. */
1968 switch (ch)
1969 {
1970 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
1971
1972 case 'R':
1973 fRecursive = true;
1974 break;
1975
1976 case VINF_GETOPT_NOT_OPTION:
1977 {
1978 if (cDirRemoved == 0)
1979 {
1980 /*
1981 * First non-option - no more options now.
1982 */
1983 rcExit = gctlCtxPostOptionParsingInit(pCtx);
1984 if (rcExit != RTEXITCODE_SUCCESS)
1985 return rcExit;
1986 if (pCtx->cVerbose)
1987 {
1988 if (fRecursive)
1989 RTPrintf(GuestCtrl::tr("Removing %RU32 directory tree(s)...\n"), argc - GetState.iNext + 1);
1990 else
1991 RTPrintf(GuestCtrl::tr("Removing %RU32 directorie(s)...\n"), argc - GetState.iNext + 1);
1992 }
1993 }
1994 if (g_fGuestCtrlCanceled)
1995 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("rmdir was interrupted by Ctrl-C (%u left)\n"),
1996 argc - GetState.iNext + 1);
1997
1998 cDirRemoved++;
1999 HRESULT hrc;
2000 if (!fRecursive)
2001 {
2002 /*
2003 * Remove exactly one directory.
2004 */
2005 if (pCtx->cVerbose)
2006 RTPrintf(GuestCtrl::tr("Removing directory \"%s\" ...\n"), ValueUnion.psz);
2007 try
2008 {
2009 CHECK_ERROR(pCtx->pGuestSession, DirectoryRemove(Bstr(ValueUnion.psz).raw()));
2010 }
2011 catch (std::bad_alloc &)
2012 {
2013 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
2014 }
2015 }
2016 else
2017 {
2018 /*
2019 * Remove the directory and anything under it, that means files
2020 * and everything. This is in the tradition of the Windows NT
2021 * CMD.EXE "rmdir /s" operation, a tradition which jpsoft's TCC
2022 * strongly warns against (and half-ways questions the sense of).
2023 */
2024 if (pCtx->cVerbose)
2025 RTPrintf(GuestCtrl::tr("Recursively removing directory \"%s\" ...\n"), ValueUnion.psz);
2026 try
2027 {
2028 /** @todo Make flags configurable. */
2029 com::SafeArray<DirectoryRemoveRecFlag_T> aRemRecFlags;
2030 aRemRecFlags.push_back(DirectoryRemoveRecFlag_ContentAndDir);
2031
2032 ComPtr<IProgress> ptrProgress;
2033 CHECK_ERROR(pCtx->pGuestSession, DirectoryRemoveRecursive(Bstr(ValueUnion.psz).raw(),
2034 ComSafeArrayAsInParam(aRemRecFlags),
2035 ptrProgress.asOutParam()));
2036 if (SUCCEEDED(hrc))
2037 {
2038 if (pCtx->cVerbose)
2039 hrc = showProgress(ptrProgress);
2040 else
2041 hrc = ptrProgress->WaitForCompletion(-1 /* indefinitely */);
2042 if (SUCCEEDED(hrc))
2043 CHECK_PROGRESS_ERROR(ptrProgress, (GuestCtrl::tr("Directory deletion failed")));
2044 ptrProgress.setNull();
2045 }
2046 }
2047 catch (std::bad_alloc &)
2048 {
2049 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory during recursive rmdir\n"));
2050 }
2051 }
2052
2053 /*
2054 * This command returns immediately on failure since it's destructive in nature.
2055 */
2056 if (FAILED(hrc))
2057 return RTEXITCODE_FAILURE;
2058 break;
2059 }
2060
2061 default:
2062 return errorGetOpt(ch, &ValueUnion);
2063 }
2064 }
2065
2066 if (!cDirRemoved)
2067 return errorSyntax(GuestCtrl::tr("No directory to remove specified!"));
2068 return rcExit;
2069}
2070
2071static DECLCALLBACK(RTEXITCODE) gctlHandleRm(PGCTLCMDCTX pCtx, int argc, char **argv)
2072{
2073 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2074
2075 static const RTGETOPTDEF s_aOptions[] =
2076 {
2077 GCTLCMD_COMMON_OPTION_DEFS()
2078 { "--force", 'f', RTGETOPT_REQ_NOTHING, },
2079 };
2080
2081 int ch;
2082 RTGETOPTUNION ValueUnion;
2083 RTGETOPTSTATE GetState;
2084 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2085
2086 uint32_t cFilesDeleted = 0;
2087 RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
2088 bool fForce = true;
2089
2090 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
2091 {
2092 /* For options that require an argument, ValueUnion has received the value. */
2093 switch (ch)
2094 {
2095 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2096
2097 case VINF_GETOPT_NOT_OPTION:
2098 if (cFilesDeleted == 0)
2099 {
2100 /*
2101 * First non-option - no more options now.
2102 */
2103 rcExit = gctlCtxPostOptionParsingInit(pCtx);
2104 if (rcExit != RTEXITCODE_SUCCESS)
2105 return rcExit;
2106 if (pCtx->cVerbose)
2107 RTPrintf(GuestCtrl::tr("Removing %RU32 file(s)...\n"), argc - GetState.iNext + 1);
2108 }
2109 if (g_fGuestCtrlCanceled)
2110 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("rm was interrupted by Ctrl-C (%u left)\n"),
2111 argc - GetState.iNext + 1);
2112
2113 /*
2114 * Remove the specified file.
2115 *
2116 * On failure we will by default stop, however, the force option will
2117 * by unix traditions force us to ignore errors and continue.
2118 */
2119 cFilesDeleted++;
2120 if (pCtx->cVerbose)
2121 RTPrintf(GuestCtrl::tr("Removing file \"%s\" ...\n"), ValueUnion.psz);
2122 try
2123 {
2124 /** @todo How does IGuestSession::FsObjRemove work with read-only files? Do we
2125 * need to do some chmod or whatever to better emulate the --force flag? */
2126 HRESULT hrc;
2127 CHECK_ERROR(pCtx->pGuestSession, FsObjRemove(Bstr(ValueUnion.psz).raw()));
2128 if (FAILED(hrc) && !fForce)
2129 return RTEXITCODE_FAILURE;
2130 }
2131 catch (std::bad_alloc &)
2132 {
2133 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory\n"));
2134 }
2135 break;
2136
2137 default:
2138 return errorGetOpt(ch, &ValueUnion);
2139 }
2140 }
2141
2142 if (!cFilesDeleted && !fForce)
2143 return errorSyntax(GuestCtrl::tr("No file to remove specified!"));
2144 return rcExit;
2145}
2146
2147static DECLCALLBACK(RTEXITCODE) gctlHandleMv(PGCTLCMDCTX pCtx, int argc, char **argv)
2148{
2149 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2150
2151 static const RTGETOPTDEF s_aOptions[] =
2152 {
2153 GCTLCMD_COMMON_OPTION_DEFS()
2154/** @todo Missing --force/-f flag. */
2155 };
2156
2157 int ch;
2158 RTGETOPTUNION ValueUnion;
2159 RTGETOPTSTATE GetState;
2160 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2161
2162 int vrc = VINF_SUCCESS;
2163
2164 bool fDryrun = false;
2165 std::vector< Utf8Str > vecSources;
2166 const char *pszDst = NULL;
2167 com::SafeArray<FsObjRenameFlag_T> aRenameFlags;
2168
2169 try
2170 {
2171 /** @todo Make flags configurable. */
2172 aRenameFlags.push_back(FsObjRenameFlag_NoReplace);
2173
2174 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
2175 && RT_SUCCESS(vrc))
2176 {
2177 /* For options that require an argument, ValueUnion has received the value. */
2178 switch (ch)
2179 {
2180 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2181
2182 /** @todo Implement a --dryrun command. */
2183 /** @todo Implement rename flags. */
2184
2185 case VINF_GETOPT_NOT_OPTION:
2186 vecSources.push_back(Utf8Str(ValueUnion.psz));
2187 pszDst = ValueUnion.psz;
2188 break;
2189
2190 default:
2191 return errorGetOpt(ch, &ValueUnion);
2192 }
2193 }
2194 }
2195 catch (std::bad_alloc &)
2196 {
2197 vrc = VERR_NO_MEMORY;
2198 }
2199
2200 if (RT_FAILURE(vrc))
2201 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Failed to initialize, vrc=%Rrc\n"), vrc);
2202
2203 size_t cSources = vecSources.size();
2204 if (!cSources)
2205 return errorSyntax(GuestCtrl::tr("No source(s) to move specified!"));
2206 if (cSources < 2)
2207 return errorSyntax(GuestCtrl::tr("No destination specified!"));
2208
2209 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2210 if (rcExit != RTEXITCODE_SUCCESS)
2211 return rcExit;
2212
2213 /* Delete last element, which now is the destination. */
2214 vecSources.pop_back();
2215 cSources = vecSources.size();
2216
2217 HRESULT hrc = S_OK;
2218
2219 /* Destination must be a directory when specifying multiple sources. */
2220 if (cSources > 1)
2221 {
2222 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2223 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(pszDst).raw(), FALSE /*followSymlinks*/, pFsObjInfo.asOutParam());
2224 if (FAILED(hrc))
2225 {
2226 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Destination does not exist\n"));
2227 }
2228 else
2229 {
2230 FsObjType_T enmObjType = FsObjType_Unknown; /* Shut up MSC */
2231 hrc = pFsObjInfo->COMGETTER(Type)(&enmObjType);
2232 if (SUCCEEDED(hrc))
2233 {
2234 if (enmObjType != FsObjType_Directory)
2235 return RTMsgErrorExit(RTEXITCODE_FAILURE,
2236 GuestCtrl::tr("Destination must be a directory when specifying multiple sources\n"));
2237 }
2238 else
2239 return RTMsgErrorExit(RTEXITCODE_FAILURE,
2240 GuestCtrl::tr("Unable to determine destination type: %Rhrc\n"),
2241 hrc);
2242 }
2243 }
2244
2245 /*
2246 * Rename (move) the entries.
2247 */
2248 if (pCtx->cVerbose)
2249 RTPrintf(GuestCtrl::tr("Renaming %RU32 %s ...\n"), cSources,
2250 cSources > 1 ? GuestCtrl::tr("sources", "", cSources) : GuestCtrl::tr("source"));
2251
2252 std::vector< Utf8Str >::iterator it = vecSources.begin();
2253 while ( it != vecSources.end()
2254 && !g_fGuestCtrlCanceled)
2255 {
2256 Utf8Str strSrcCur = (*it);
2257
2258 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2259 FsObjType_T enmObjType = FsObjType_Unknown; /* Shut up MSC */
2260 hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(strSrcCur).raw(), FALSE /*followSymlinks*/, pFsObjInfo.asOutParam());
2261 if (SUCCEEDED(hrc))
2262 hrc = pFsObjInfo->COMGETTER(Type)(&enmObjType);
2263 if (FAILED(hrc))
2264 {
2265 RTPrintf(GuestCtrl::tr("Cannot stat \"%s\": No such file or directory\n"), strSrcCur.c_str());
2266 ++it;
2267 continue; /* Skip. */
2268 }
2269
2270 char *pszDstCur = NULL;
2271
2272 if (cSources > 1)
2273 {
2274 pszDstCur = RTPathJoinA(pszDst, RTPathFilename(strSrcCur.c_str()));
2275 }
2276 else
2277 pszDstCur = RTStrDup(pszDst);
2278
2279 AssertPtrBreakStmt(pszDstCur, hrc = E_OUTOFMEMORY);
2280
2281 if (pCtx->cVerbose)
2282 RTPrintf(GuestCtrl::tr("Renaming %s \"%s\" to \"%s\" ...\n"),
2283 enmObjType == FsObjType_Directory ? GuestCtrl::tr("directory", "object") : GuestCtrl::tr("file","object"),
2284 strSrcCur.c_str(), pszDstCur);
2285
2286 if (!fDryrun)
2287 {
2288 CHECK_ERROR(pCtx->pGuestSession, FsObjRename(Bstr(strSrcCur).raw(),
2289 Bstr(pszDstCur).raw(),
2290 ComSafeArrayAsInParam(aRenameFlags)));
2291 /* Keep going with next item in case of errors. */
2292 }
2293
2294 RTStrFree(pszDstCur);
2295
2296 ++it;
2297 }
2298
2299 if ( (it != vecSources.end())
2300 && pCtx->cVerbose)
2301 {
2302 RTPrintf(GuestCtrl::tr("Warning: Not all sources were renamed\n"));
2303 }
2304
2305 return FAILED(hrc) ? RTEXITCODE_FAILURE : RTEXITCODE_SUCCESS;
2306}
2307
2308static DECLCALLBACK(RTEXITCODE) gctlHandleMkTemp(PGCTLCMDCTX pCtx, int argc, char **argv)
2309{
2310 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2311
2312 static const RTGETOPTDEF s_aOptions[] =
2313 {
2314 GCTLCMD_COMMON_OPTION_DEFS()
2315 { "--mode", 'm', RTGETOPT_REQ_UINT32 },
2316 { "--directory", 'D', RTGETOPT_REQ_NOTHING },
2317 { "--secure", 's', RTGETOPT_REQ_NOTHING },
2318 { "--tmpdir", 't', RTGETOPT_REQ_STRING }
2319 };
2320
2321 int ch;
2322 RTGETOPTUNION ValueUnion;
2323 RTGETOPTSTATE GetState;
2324 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2325
2326 Utf8Str strTemplate;
2327 uint32_t fMode = 0; /* Default mode. */
2328 bool fDirectory = false;
2329 bool fSecure = false;
2330 Utf8Str strTempDir;
2331
2332 DESTDIRMAP mapDirs;
2333
2334 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
2335 {
2336 /* For options that require an argument, ValueUnion has received the value. */
2337 switch (ch)
2338 {
2339 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2340
2341 case 'm': /* Mode */
2342 fMode = ValueUnion.u32;
2343 break;
2344
2345 case 'D': /* Create directory */
2346 fDirectory = true;
2347 break;
2348
2349 case 's': /* Secure */
2350 fSecure = true;
2351 break;
2352
2353 case 't': /* Temp directory */
2354 strTempDir = ValueUnion.psz;
2355 break;
2356
2357 case VINF_GETOPT_NOT_OPTION:
2358 if (strTemplate.isEmpty())
2359 strTemplate = ValueUnion.psz;
2360 else
2361 return errorSyntax(GuestCtrl::tr("More than one template specified!\n"));
2362 break;
2363
2364 default:
2365 return errorGetOpt(ch, &ValueUnion);
2366 }
2367 }
2368
2369 if (strTemplate.isEmpty())
2370 return errorSyntax(GuestCtrl::tr("No template specified!"));
2371
2372#ifndef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2373 if (!fDirectory)
2374 return errorSyntax(GuestCtrl::tr("Creating temporary files is currently not supported!"));
2375#endif
2376
2377 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2378 if (rcExit != RTEXITCODE_SUCCESS)
2379 return rcExit;
2380
2381 /*
2382 * Create the directories.
2383 */
2384 if (pCtx->cVerbose)
2385 {
2386 if (!strTempDir.isEmpty())
2387 RTPrintf(GuestCtrl::tr("Creating temporary %s from template '%s' in directory '%s' ...\n"),
2388 fDirectory ? GuestCtrl::tr("directory") : GuestCtrl::tr("file"), strTemplate.c_str(), strTempDir.c_str());
2389 else
2390 RTPrintf(GuestCtrl::tr("Creating temporary %s from template '%s' in default temporary directory ...\n"),
2391 fDirectory ? GuestCtrl::tr("directory") : GuestCtrl::tr("file"), strTemplate.c_str());
2392 }
2393
2394 HRESULT hrc = S_OK;
2395 if (fDirectory)
2396 {
2397 Bstr bstrDirectory;
2398 CHECK_ERROR(pCtx->pGuestSession, DirectoryCreateTemp(Bstr(strTemplate).raw(),
2399 fMode, Bstr(strTempDir).raw(),
2400 fSecure,
2401 bstrDirectory.asOutParam()));
2402 if (SUCCEEDED(hrc))
2403 RTPrintf(GuestCtrl::tr("Directory name: %ls\n"), bstrDirectory.raw());
2404 }
2405 else
2406 {
2407 // else - temporary file not yet implemented
2408 /** @todo implement temporary file creation (we fend it off above, no
2409 * worries). */
2410 hrc = E_FAIL;
2411 }
2412
2413 return FAILED(hrc) ? RTEXITCODE_FAILURE : RTEXITCODE_SUCCESS;
2414}
2415
2416static DECLCALLBACK(RTEXITCODE) gctlHandleMount(PGCTLCMDCTX pCtx, int argc, char **argv)
2417{
2418 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2419
2420 static const RTGETOPTDEF s_aOptions[] =
2421 {
2422 GCTLCMD_COMMON_OPTION_DEFS()
2423 };
2424
2425 int ch;
2426 RTGETOPTUNION ValueUnion;
2427 RTGETOPTSTATE GetState;
2428 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2429
2430 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
2431 {
2432 /* For options that require an argument, ValueUnion has received the value. */
2433 switch (ch)
2434 {
2435 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2436
2437 default:
2438 return errorGetOpt(ch, &ValueUnion);
2439 }
2440 }
2441
2442 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2443 if (rcExit != RTEXITCODE_SUCCESS)
2444 return rcExit;
2445
2446 HRESULT hrc = S_OK;
2447
2448 com::SafeArray<BSTR> mountPoints;
2449 CHECK_ERROR_RET(pCtx->pGuestSession, COMGETTER(MountPoints)(ComSafeArrayAsOutParam(mountPoints)), RTEXITCODE_FAILURE);
2450
2451 for (size_t i = 0; i < mountPoints.size(); ++i)
2452 RTPrintf("%ls\n", mountPoints[i]);
2453
2454 if (pCtx->cVerbose)
2455 RTPrintf("Found %zu mount points\n", mountPoints.size());
2456
2457 return RTEXITCODE_SUCCESS;
2458}
2459
2460static DECLCALLBACK(RTEXITCODE) gctlHandleFsInfo(PGCTLCMDCTX pCtx, int argc, char **argv)
2461{
2462 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2463
2464 /*
2465 * Parse arguments.
2466 */
2467 enum GCTLCMD_FSINFO_OPT
2468 {
2469 GCTLCMD_FSINFO_OPT_TOTAL = 1000
2470 };
2471
2472 static const RTGETOPTDEF s_aOptions[] =
2473 {
2474 GCTLCMD_COMMON_OPTION_DEFS()
2475 { "--human-readable", 'h', RTGETOPT_REQ_NOTHING },
2476 { "--total", GCTLCMD_FSINFO_OPT_TOTAL, RTGETOPT_REQ_NOTHING }
2477 };
2478
2479 int ch;
2480 RTGETOPTUNION ValueUnion;
2481 RTGETOPTSTATE GetState;
2482 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2483
2484 bool fHumanReadable = false;
2485 bool fShowTotal = false;
2486
2487 while ( (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
2488 && ch != VINF_GETOPT_NOT_OPTION)
2489 {
2490 /* For options that require an argument, ValueUnion has received the value. */
2491 switch (ch)
2492 {
2493 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2494
2495 case 'h':
2496 fHumanReadable = true;
2497 break;
2498
2499 case GCTLCMD_FSINFO_OPT_TOTAL:
2500 fShowTotal = true;
2501 break;
2502
2503 default:
2504 return errorGetOpt(ch, &ValueUnion);
2505 }
2506 }
2507
2508 if (ch != VINF_GETOPT_NOT_OPTION)
2509 return errorSyntax(GuestCtrl::tr("No path specified to query information for!"));
2510
2511 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2512 if (rcExit != RTEXITCODE_SUCCESS)
2513 return rcExit;
2514
2515 /* Stay within 80 characters width by default. */
2516 unsigned const cwFileSys = 10;
2517 /* When displaying human-readable sizes, we need less space for a column. */
2518 unsigned const cwSize = fHumanReadable ? 10 : 14;
2519 unsigned const cwSizeTotal = cwSize;
2520 unsigned const cwSizeUsed = cwSize;
2521 unsigned const cwSizeAvail = cwSize;
2522 unsigned const cwUsePercent = 6;
2523 unsigned const cwPathSpacing = 3; /* Spacing between last value and actual path. */
2524
2525 RTPrintf("%-*s%*s%*s%*s%*s%*s%s\n",
2526 cwFileSys, GuestCtrl::tr("Filesystem"),
2527 cwSizeTotal, GuestCtrl::tr("Total"), cwSizeUsed, GuestCtrl::tr("Used"), cwSizeAvail, GuestCtrl::tr("Avail"),
2528 cwUsePercent, GuestCtrl::tr("Use%"),
2529 cwPathSpacing, "",
2530 GuestCtrl::tr("Path"));
2531
2532 uint64_t cbTotalSize = 0;
2533 uint64_t cbTotalFree = 0;
2534
2535 while (ch == VINF_GETOPT_NOT_OPTION)
2536 {
2537 ComPtr<IGuestFsInfo> pFsInfo;
2538 HRESULT hrc;
2539 CHECK_ERROR(pCtx->pGuestSession, FsQueryInfo(Bstr(ValueUnion.psz).raw(), pFsInfo.asOutParam()));
2540 if (FAILED(hrc))
2541 {
2542 rcExit = RTEXITCODE_FAILURE;
2543 }
2544 else
2545 {
2546 Bstr bstr;
2547 CHECK_ERROR2I(pFsInfo, COMGETTER(Type)(bstr.asOutParam()));
2548 /** @todo Add label and mount point once we return this. */
2549 LONG64 cbTotal, cbFree;
2550 CHECK_ERROR2I(pFsInfo, COMGETTER(TotalSize)(&cbTotal));
2551 CHECK_ERROR2I(pFsInfo, COMGETTER(FreeSize)(&cbFree));
2552 uint8_t const uPercentUsed = (cbTotal - cbFree) * 100 / cbTotal;
2553 if (fHumanReadable)
2554 {
2555 RTPrintf("%-*ls%*Rhcb%*Rhcb%*Rhcb%*RU8%%%*s%s",
2556 cwFileSys, bstr.raw(), /* Filesystem */
2557 cwSizeTotal, cbTotal, /* Total */
2558 cwSizeUsed, cbTotal - cbFree, /* Used */
2559 cwSizeAvail, cbFree, /* Available */
2560 cwUsePercent - 1 /* For percent sign */, uPercentUsed, /* Percent */
2561 cwPathSpacing, "",
2562 ValueUnion.psz); /* Path */
2563 }
2564 else
2565 {
2566 RTPrintf("%-*ls%*RU64%*RU64%*RU64%*RU8%%%*s%s",
2567 cwFileSys, bstr.raw(), /* Filesystem */
2568 cwSizeTotal, cbTotal, /* Total */
2569 cwSizeUsed, cbTotal - cbFree, /* Used */
2570 cwSizeAvail, cbFree, /* Available */
2571 cwUsePercent - 1 /* For percent sign */, uPercentUsed, /* Percent */
2572 cwPathSpacing, "",
2573 ValueUnion.psz); /* Path */
2574 }
2575
2576 if (fShowTotal)
2577 {
2578 cbTotalSize += cbTotal;
2579 cbTotalFree += cbFree;
2580 }
2581 RTPrintf("\n");
2582 }
2583
2584 /* Next path. */
2585 ch = RTGetOpt(&GetState, &ValueUnion);
2586 }
2587
2588 if (fShowTotal)
2589 {
2590 uint8_t const uPercentUsed = (cbTotalSize - cbTotalFree) * 100 / cbTotalSize;
2591
2592 if (fHumanReadable)
2593 {
2594 RTPrintf("%-*s%*Rhcb%*Rhcb%*Rhcb%*RU8%%%*s%s",
2595 cwFileSys, "total",
2596 cwSizeTotal, cbTotalSize, /* Total */
2597 cwSizeUsed, cbTotalSize - cbTotalFree, /* Used */
2598 cwSizeAvail, cbTotalFree, /* Available */
2599 cwUsePercent - 1 /* For percent sign */, uPercentUsed, /* Percent */
2600 cwPathSpacing, "",
2601 "-"); /* Path */
2602 }
2603 else
2604 {
2605 RTPrintf("%-*s%*RU64%*RU64%*RU64%*RU8%%%*s%s",
2606 cwFileSys, "total", /* Filesystem */
2607 cwSizeTotal, cbTotalSize, /* Total */
2608 cwSizeUsed, cbTotalSize - cbTotalFree, /* Used */
2609 cwSizeAvail, cbTotalFree, /* Available */
2610 cwUsePercent - 1 /* For percent sign */, uPercentUsed, /* Percent */
2611 cwPathSpacing, "",
2612 "-"); /* Path */
2613 }
2614 RTPrintf("\n");
2615 }
2616
2617 return rcExit;
2618}
2619
2620static DECLCALLBACK(RTEXITCODE) gctlHandleStat(PGCTLCMDCTX pCtx, int argc, char **argv)
2621{
2622 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2623
2624 static const RTGETOPTDEF s_aOptions[] =
2625 {
2626 GCTLCMD_COMMON_OPTION_DEFS()
2627 { "--dereference", 'L', RTGETOPT_REQ_NOTHING },
2628 { "--file-system", 'f', RTGETOPT_REQ_NOTHING },
2629 { "--format", 'c', RTGETOPT_REQ_STRING },
2630 { "--terse", 't', RTGETOPT_REQ_NOTHING }
2631 };
2632
2633 int ch;
2634 RTGETOPTUNION ValueUnion;
2635 RTGETOPTSTATE GetState;
2636 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2637
2638 while ( (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
2639 && ch != VINF_GETOPT_NOT_OPTION)
2640 {
2641 /* For options that require an argument, ValueUnion has received the value. */
2642 switch (ch)
2643 {
2644 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2645
2646 case 'L': /* Dereference */
2647 case 'f': /* File-system */
2648 case 'c': /* Format */
2649 case 't': /* Terse */
2650 return errorSyntax(GuestCtrl::tr("Command \"%s\" not implemented yet!"), ValueUnion.psz);
2651
2652 default:
2653 return errorGetOpt(ch, &ValueUnion);
2654 }
2655 }
2656
2657 if (ch != VINF_GETOPT_NOT_OPTION)
2658 return errorSyntax(GuestCtrl::tr("Nothing to stat!"));
2659
2660 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
2661 if (rcExit != RTEXITCODE_SUCCESS)
2662 return rcExit;
2663
2664
2665 /*
2666 * Do the file stat'ing.
2667 */
2668 while (ch == VINF_GETOPT_NOT_OPTION)
2669 {
2670 if (pCtx->cVerbose)
2671 RTPrintf(GuestCtrl::tr("Checking for element \"%s\" ...\n"), ValueUnion.psz);
2672
2673 ComPtr<IGuestFsObjInfo> pFsObjInfo;
2674 HRESULT hrc = pCtx->pGuestSession->FsObjQueryInfo(Bstr(ValueUnion.psz).raw(), FALSE /*followSymlinks*/,
2675 pFsObjInfo.asOutParam());
2676 if (FAILED(hrc))
2677 {
2678 /** @todo r=bird: There might be other reasons why we end up here than
2679 * non-existing "element" (object or file, please, nobody calls it elements). */
2680 if (pCtx->cVerbose)
2681 RTPrintf(GuestCtrl::tr("Failed to stat '%s': No such file\n"), ValueUnion.psz);
2682 rcExit = RTEXITCODE_FAILURE;
2683 }
2684 else
2685 {
2686 RTPrintf(GuestCtrl::tr(" File: '%s'\n"), ValueUnion.psz); /** @todo escape this name. */
2687
2688 FsObjType_T enmType = FsObjType_Unknown;
2689 CHECK_ERROR2I(pFsObjInfo, COMGETTER(Type)(&enmType));
2690 LONG64 cbObject = 0;
2691 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ObjectSize)(&cbObject));
2692 LONG64 cbAllocated = 0;
2693 CHECK_ERROR2I(pFsObjInfo, COMGETTER(AllocatedSize)(&cbAllocated));
2694 LONG uid = 0;
2695 CHECK_ERROR2I(pFsObjInfo, COMGETTER(UID)(&uid));
2696 LONG gid = 0;
2697 CHECK_ERROR2I(pFsObjInfo, COMGETTER(GID)(&gid));
2698 Bstr bstrUsername;
2699 CHECK_ERROR2I(pFsObjInfo, COMGETTER(UserName)(bstrUsername.asOutParam()));
2700 Bstr bstrGroupName;
2701 CHECK_ERROR2I(pFsObjInfo, COMGETTER(GroupName)(bstrGroupName.asOutParam()));
2702 Bstr bstrAttribs;
2703 CHECK_ERROR2I(pFsObjInfo, COMGETTER(FileAttributes)(bstrAttribs.asOutParam()));
2704 LONG64 idNode = 0;
2705 CHECK_ERROR2I(pFsObjInfo, COMGETTER(NodeId)(&idNode));
2706 ULONG uDevNode = 0;
2707 CHECK_ERROR2I(pFsObjInfo, COMGETTER(NodeIdDevice)(&uDevNode));
2708 ULONG uDeviceNo = 0;
2709 CHECK_ERROR2I(pFsObjInfo, COMGETTER(DeviceNumber)(&uDeviceNo));
2710 ULONG cHardLinks = 1;
2711 CHECK_ERROR2I(pFsObjInfo, COMGETTER(HardLinks)(&cHardLinks));
2712 LONG64 nsBirthTime = 0;
2713 CHECK_ERROR2I(pFsObjInfo, COMGETTER(BirthTime)(&nsBirthTime));
2714 LONG64 nsChangeTime = 0;
2715 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ChangeTime)(&nsChangeTime));
2716 LONG64 nsModificationTime = 0;
2717 CHECK_ERROR2I(pFsObjInfo, COMGETTER(ModificationTime)(&nsModificationTime));
2718 LONG64 nsAccessTime = 0;
2719 CHECK_ERROR2I(pFsObjInfo, COMGETTER(AccessTime)(&nsAccessTime));
2720
2721 RTPrintf(GuestCtrl::tr(" Size: %-17RU64 Alloc: %-19RU64 Type: %s\n"),
2722 cbObject, cbAllocated, gctlFsObjTypeToName(enmType));
2723 RTPrintf(GuestCtrl::tr("Device: %#-17RX32 INode: %-18RU64 Links: %u\n"), uDevNode, idNode, cHardLinks);
2724
2725 Utf8Str strAttrib(bstrAttribs);
2726 char *pszMode = strAttrib.mutableRaw();
2727 char *pszAttribs = strchr(pszMode, ' ');
2728 if (pszAttribs)
2729 do *pszAttribs++ = '\0';
2730 while (*pszAttribs == ' ');
2731 else
2732 pszAttribs = strchr(pszMode, '\0');
2733 if (uDeviceNo != 0)
2734 RTPrintf(GuestCtrl::tr(" Mode: %-16s Attrib: %-17s Dev ID: %#RX32\n"), pszMode, pszAttribs, uDeviceNo);
2735 else
2736 RTPrintf(GuestCtrl::tr(" Mode: %-16s Attrib: %s\n"), pszMode, pszAttribs);
2737
2738 RTPrintf(GuestCtrl::tr(" Owner: %4d/%-12ls Group: %4d/%ls\n"), uid, bstrUsername.raw(), gid, bstrGroupName.raw());
2739
2740 RTTIMESPEC TimeSpec;
2741 char szTmp[RTTIME_STR_LEN];
2742 RTPrintf(GuestCtrl::tr(" Birth: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsBirthTime),
2743 szTmp, sizeof(szTmp)));
2744 RTPrintf(GuestCtrl::tr("Change: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsChangeTime),
2745 szTmp, sizeof(szTmp)));
2746 RTPrintf(GuestCtrl::tr("Modify: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsModificationTime),
2747 szTmp, sizeof(szTmp)));
2748 RTPrintf(GuestCtrl::tr("Access: %s\n"), RTTimeSpecToString(RTTimeSpecSetNano(&TimeSpec, nsAccessTime),
2749 szTmp, sizeof(szTmp)));
2750
2751 /* Skiping: Generation ID - only the ISO9660 VFS sets this. FreeBSD user flags. */
2752 }
2753
2754 /* Next file. */
2755 ch = RTGetOpt(&GetState, &ValueUnion);
2756 }
2757
2758 return rcExit;
2759}
2760
2761/**
2762 * Waits for a Guest Additions run level being reached.
2763 *
2764 * @returns VBox status code.
2765 * Returns VERR_CANCELLED if waiting for cancelled due to signal handling, e.g. when CTRL+C or some sort was pressed.
2766 * @param pCtx The guest control command context.
2767 * @param enmRunLevel Run level to wait for.
2768 * @param cMsTimeout Timeout (in ms) for waiting.
2769 */
2770static int gctlWaitForRunLevel(PGCTLCMDCTX pCtx, AdditionsRunLevelType_T enmRunLevel, RTMSINTERVAL cMsTimeout)
2771{
2772 int vrc = VINF_SUCCESS; /* Shut up MSVC. */
2773
2774 try
2775 {
2776 HRESULT hrc = S_OK;
2777 /** Whether we need to actually wait for the run level or if we already reached it. */
2778 bool fWait = false;
2779
2780 /* Install an event handler first to catch any runlevel changes. */
2781 ComObjPtr<GuestAdditionsRunlevelListenerImpl> pGuestListener;
2782 do
2783 {
2784 /* Listener creation. */
2785 pGuestListener.createObject();
2786 pGuestListener->init(new GuestAdditionsRunlevelListener(enmRunLevel));
2787
2788 /* Register for IGuest events. */
2789 ComPtr<IEventSource> es;
2790 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(EventSource)(es.asOutParam()));
2791 com::SafeArray<VBoxEventType_T> eventTypes;
2792 eventTypes.push_back(VBoxEventType_OnGuestAdditionsStatusChanged);
2793 CHECK_ERROR_BREAK(es, RegisterListener(pGuestListener, ComSafeArrayAsInParam(eventTypes),
2794 true /* Active listener */));
2795
2796 AdditionsRunLevelType_T enmRunLevelCur = AdditionsRunLevelType_None;
2797 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(AdditionsRunLevel)(&enmRunLevelCur));
2798 fWait = enmRunLevelCur != enmRunLevel;
2799
2800 if (pCtx->cVerbose)
2801 RTPrintf(GuestCtrl::tr("Current run level is %RU32\n"), enmRunLevelCur);
2802
2803 } while (0);
2804
2805 if (fWait)
2806 {
2807 if (pCtx->cVerbose)
2808 RTPrintf(GuestCtrl::tr("Waiting for run level %RU32 ...\n"), enmRunLevel);
2809
2810 RTMSINTERVAL tsStart = RTTimeMilliTS();
2811 while (RTTimeMilliTS() - tsStart < cMsTimeout)
2812 {
2813 /* Wait for the global signal semaphore getting signalled. */
2814 vrc = RTSemEventWait(g_SemEventGuestCtrlCanceled, 100 /* ms */);
2815 if (RT_FAILURE(vrc))
2816 {
2817 if (vrc == VERR_TIMEOUT)
2818 continue;
2819 else
2820 {
2821 RTPrintf(GuestCtrl::tr("Waiting failed with %Rrc\n"), vrc);
2822 break;
2823 }
2824 }
2825 else if (pCtx->cVerbose)
2826 {
2827 RTPrintf(GuestCtrl::tr("Run level %RU32 reached\n"), enmRunLevel);
2828 break;
2829 }
2830
2831 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
2832 }
2833
2834 if ( vrc == VERR_TIMEOUT
2835 && pCtx->cVerbose)
2836 RTPrintf(GuestCtrl::tr("Run level %RU32 not reached within time\n"), enmRunLevel);
2837 }
2838
2839 if (!pGuestListener.isNull())
2840 {
2841 /* Guest callback unregistration. */
2842 ComPtr<IEventSource> pES;
2843 CHECK_ERROR(pCtx->pGuest, COMGETTER(EventSource)(pES.asOutParam()));
2844 if (!pES.isNull())
2845 CHECK_ERROR(pES, UnregisterListener(pGuestListener));
2846 pGuestListener.setNull();
2847 }
2848
2849 if (g_fGuestCtrlCanceled)
2850 vrc = VERR_CANCELLED;
2851 }
2852 catch (std::bad_alloc &)
2853 {
2854 vrc = VERR_NO_MEMORY;
2855 }
2856
2857 return vrc;
2858}
2859
2860static DECLCALLBACK(RTEXITCODE) gctlHandleUpdateAdditions(PGCTLCMDCTX pCtx, int argc, char **argv)
2861{
2862 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
2863
2864 /** Timeout to wait for the whole updating procedure to complete. */
2865 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
2866 /** Source path to .ISO Guest Additions file to use. */
2867 Utf8Str strSource;
2868 com::SafeArray<IN_BSTR> aArgs;
2869 /** Whether to reboot the guest automatically when the update process has finished successfully. */
2870 bool fRebootOnFinish = false;
2871 /** Whether to only wait for getting the update process started instead of waiting until it finishes. */
2872 bool fWaitStartOnly = false;
2873 /** Whether to wait for the VM being ready to start the update. Needs Guest Additions facility reporting. */
2874 bool fWaitReady = false;
2875 /** Whether to verify if the Guest Additions were successfully updated on the guest. */
2876 bool fVerify = false;
2877
2878 /*
2879 * Parse arguments.
2880 */
2881 enum KGSTCTRLUPDATEADDITIONSOPT
2882 {
2883 KGSTCTRLUPDATEADDITIONSOPT_REBOOT = 1000,
2884 KGSTCTRLUPDATEADDITIONSOPT_SOURCE,
2885 KGSTCTRLUPDATEADDITIONSOPT_TIMEOUT,
2886 KGSTCTRLUPDATEADDITIONSOPT_VERIFY,
2887 KGSTCTRLUPDATEADDITIONSOPT_WAITREADY,
2888 KGSTCTRLUPDATEADDITIONSOPT_WAITSTART
2889 };
2890
2891 static const RTGETOPTDEF s_aOptions[] =
2892 {
2893 GCTLCMD_COMMON_OPTION_DEFS()
2894 { "--reboot", KGSTCTRLUPDATEADDITIONSOPT_REBOOT, RTGETOPT_REQ_NOTHING },
2895 { "--source", KGSTCTRLUPDATEADDITIONSOPT_SOURCE, RTGETOPT_REQ_STRING },
2896 { "--timeout", KGSTCTRLUPDATEADDITIONSOPT_TIMEOUT, RTGETOPT_REQ_UINT32 },
2897 { "--verify", KGSTCTRLUPDATEADDITIONSOPT_VERIFY, RTGETOPT_REQ_NOTHING },
2898 { "--wait-ready", KGSTCTRLUPDATEADDITIONSOPT_WAITREADY, RTGETOPT_REQ_NOTHING },
2899 { "--wait-start", KGSTCTRLUPDATEADDITIONSOPT_WAITSTART, RTGETOPT_REQ_NOTHING }
2900 };
2901
2902 int ch;
2903 RTGETOPTUNION ValueUnion;
2904 RTGETOPTSTATE GetState;
2905 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
2906
2907 int vrc = VINF_SUCCESS;
2908 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
2909 && RT_SUCCESS(vrc))
2910 {
2911 switch (ch)
2912 {
2913 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
2914
2915 case KGSTCTRLUPDATEADDITIONSOPT_REBOOT:
2916 fRebootOnFinish = true;
2917 break;
2918
2919 case KGSTCTRLUPDATEADDITIONSOPT_SOURCE:
2920 vrc = RTPathAbsCxx(strSource, ValueUnion.psz);
2921 if (RT_FAILURE(vrc))
2922 return RTMsgErrorExitFailure(GuestCtrl::tr("RTPathAbsCxx failed on '%s': %Rrc"), ValueUnion.psz, vrc);
2923 break;
2924
2925 case KGSTCTRLUPDATEADDITIONSOPT_WAITSTART:
2926 fWaitStartOnly = true;
2927 break;
2928
2929 case KGSTCTRLUPDATEADDITIONSOPT_WAITREADY:
2930 fWaitReady = true;
2931 break;
2932
2933 case KGSTCTRLUPDATEADDITIONSOPT_VERIFY:
2934 fVerify = true;
2935 fRebootOnFinish = true; /* Verification needs a mandatory reboot after successful update. */
2936 break;
2937
2938 case VINF_GETOPT_NOT_OPTION:
2939 if (aArgs.size() == 0 && strSource.isEmpty())
2940 strSource = ValueUnion.psz;
2941 else
2942 aArgs.push_back(Bstr(ValueUnion.psz).raw());
2943 break;
2944
2945 default:
2946 return errorGetOpt(ch, &ValueUnion);
2947 }
2948 }
2949
2950 if (pCtx->cVerbose)
2951 RTPrintf(GuestCtrl::tr("Updating Guest Additions ...\n"));
2952
2953 HRESULT hrc = S_OK;
2954 while (strSource.isEmpty())
2955 {
2956 ComPtr<ISystemProperties> pProperties;
2957 CHECK_ERROR_BREAK(pCtx->pArg->virtualBox, COMGETTER(SystemProperties)(pProperties.asOutParam()));
2958 Bstr strISO;
2959 CHECK_ERROR_BREAK(pProperties, COMGETTER(DefaultAdditionsISO)(strISO.asOutParam()));
2960 strSource = strISO;
2961 break;
2962 }
2963
2964 /* Determine source if not set yet. */
2965 if (strSource.isEmpty())
2966 {
2967 RTMsgError(GuestCtrl::tr("No Guest Additions source found or specified, aborting\n"));
2968 vrc = VERR_FILE_NOT_FOUND;
2969 }
2970 else if (!RTFileExists(strSource.c_str()))
2971 {
2972 RTMsgError(GuestCtrl::tr("Source \"%s\" does not exist!\n"), strSource.c_str());
2973 vrc = VERR_FILE_NOT_FOUND;
2974 }
2975
2976
2977
2978#if 0
2979 ComPtr<IGuest> guest;
2980 HRESULT hrc = pConsole->COMGETTER(Guest)(guest.asOutParam());
2981 if (SUCCEEDED(hrc) && !guest.isNull())
2982 {
2983 SHOW_STRING_PROP_NOT_EMPTY(guest, OSTypeId, "GuestOSType", GuestCtrl::tr("OS type:"));
2984
2985 AdditionsRunLevelType_T guestRunLevel; /** @todo Add a runlevel-to-string (e.g. 0 = "None") method? */
2986 hrc = guest->COMGETTER(AdditionsRunLevel)(&guestRunLevel);
2987 if (SUCCEEDED(hrc))
2988 SHOW_ULONG_VALUE("GuestAdditionsRunLevel", GuestCtrl::tr("Additions run level:"), (ULONG)guestRunLevel, "");
2989
2990 Bstr guestString;
2991 hrc = guest->COMGETTER(AdditionsVersion)(guestString.asOutParam());
2992 if ( SUCCEEDED(hrc)
2993 && !guestString.isEmpty())
2994 {
2995 ULONG uRevision;
2996 hrc = guest->COMGETTER(AdditionsRevision)(&uRevision);
2997 if (FAILED(hrc))
2998 uRevision = 0;
2999 RTStrPrintf(szValue, sizeof(szValue), "%ls r%u", guestString.raw(), uRevision);
3000 SHOW_UTF8_STRING("GuestAdditionsVersion", GuestCtrl::tr("Additions version:"), szValue);
3001 }
3002 }
3003#endif
3004
3005 if (RT_SUCCESS(vrc))
3006 {
3007 if (pCtx->cVerbose)
3008 RTPrintf(GuestCtrl::tr("Using source: %s\n"), strSource.c_str());
3009
3010 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3011 if (rcExit != RTEXITCODE_SUCCESS)
3012 return rcExit;
3013
3014 if (fWaitReady)
3015 {
3016 if (pCtx->cVerbose)
3017 RTPrintf(GuestCtrl::tr("Waiting for current Guest Additions inside VM getting ready for updating ...\n"));
3018
3019 const uint64_t uTsStart = RTTimeMilliTS();
3020 vrc = gctlWaitForRunLevel(pCtx, AdditionsRunLevelType_Userland, cMsTimeout);
3021 if (RT_SUCCESS(vrc))
3022 cMsTimeout = cMsTimeout != RT_INDEFINITE_WAIT ? cMsTimeout - (RTTimeMilliTS() - uTsStart) : cMsTimeout;
3023 }
3024
3025 if (RT_SUCCESS(vrc))
3026 {
3027 /* Get current Guest Additions version / revision. */
3028 Bstr strGstVerCur;
3029 ULONG uGstRevCur = 0;
3030 hrc = pCtx->pGuest->COMGETTER(AdditionsVersion)(strGstVerCur.asOutParam());
3031 if ( SUCCEEDED(hrc)
3032 && !strGstVerCur.isEmpty())
3033 {
3034 hrc = pCtx->pGuest->COMGETTER(AdditionsRevision)(&uGstRevCur);
3035 if (SUCCEEDED(hrc))
3036 {
3037 if (pCtx->cVerbose)
3038 RTPrintf(GuestCtrl::tr("Guest Additions %lsr%RU64 currently installed, waiting for Guest Additions installer to start ...\n"),
3039 strGstVerCur.raw(), uGstRevCur);
3040 }
3041 }
3042
3043 com::SafeArray<AdditionsUpdateFlag_T> aUpdateFlags;
3044 if (fWaitStartOnly)
3045 aUpdateFlags.push_back(AdditionsUpdateFlag_WaitForUpdateStartOnly);
3046
3047 ComPtr<IProgress> pProgress;
3048 CHECK_ERROR(pCtx->pGuest, UpdateGuestAdditions(Bstr(strSource).raw(),
3049 ComSafeArrayAsInParam(aArgs),
3050 ComSafeArrayAsInParam(aUpdateFlags),
3051 pProgress.asOutParam()));
3052 if (FAILED(hrc))
3053 vrc = gctlPrintError(pCtx->pGuest, COM_IIDOF(IGuest));
3054 else
3055 {
3056 if (pCtx->cVerbose)
3057 hrc = showProgress(pProgress);
3058 else
3059 hrc = pProgress->WaitForCompletion((int32_t)cMsTimeout);
3060
3061 if (SUCCEEDED(hrc))
3062 CHECK_PROGRESS_ERROR(pProgress, (GuestCtrl::tr("Guest Additions update failed")));
3063 vrc = gctlPrintProgressError(pProgress);
3064 if (RT_SUCCESS(vrc))
3065 {
3066 if (pCtx->cVerbose)
3067 RTPrintf(GuestCtrl::tr("Guest Additions update successful.\n"));
3068
3069 if (fRebootOnFinish)
3070 {
3071 if (pCtx->cVerbose)
3072 RTPrintf(GuestCtrl::tr("Rebooting guest ...\n"));
3073 com::SafeArray<GuestShutdownFlag_T> aShutdownFlags;
3074 aShutdownFlags.push_back(GuestShutdownFlag_Reboot);
3075 CHECK_ERROR(pCtx->pGuest, Shutdown(ComSafeArrayAsInParam(aShutdownFlags)));
3076 if (FAILED(hrc))
3077 {
3078 if (hrc == VBOX_E_NOT_SUPPORTED)
3079 {
3080 RTPrintf(GuestCtrl::tr("Current installed Guest Additions don't support automatic rebooting. "
3081 "Please reboot manually.\n"));
3082 vrc = VERR_NOT_SUPPORTED;
3083 }
3084 else
3085 vrc = gctlPrintError(pCtx->pGuest, COM_IIDOF(IGuest));
3086 }
3087 else
3088 {
3089 if (fWaitReady)
3090 {
3091 if (pCtx->cVerbose)
3092 RTPrintf(GuestCtrl::tr("Waiting for new Guest Additions inside VM getting ready ...\n"));
3093
3094 vrc = gctlWaitForRunLevel(pCtx, AdditionsRunLevelType_Userland, cMsTimeout);
3095 if (RT_SUCCESS(vrc))
3096 {
3097 if (fVerify)
3098 {
3099 if (pCtx->cVerbose)
3100 RTPrintf(GuestCtrl::tr("Verifying Guest Additions update ...\n"));
3101
3102 /* Get new Guest Additions version / revision. */
3103 Bstr strGstVerNew;
3104 ULONG uGstRevNew = 0;
3105 hrc = pCtx->pGuest->COMGETTER(AdditionsVersion)(strGstVerNew.asOutParam());
3106 if ( SUCCEEDED(hrc)
3107 && !strGstVerNew.isEmpty())
3108 {
3109 hrc = pCtx->pGuest->COMGETTER(AdditionsRevision)(&uGstRevNew);
3110 if (FAILED(hrc))
3111 uGstRevNew = 0;
3112 }
3113
3114 /** @todo Do more verification here. */
3115 vrc = uGstRevNew > uGstRevCur ? VINF_SUCCESS : VERR_NO_CHANGE;
3116
3117 if (pCtx->cVerbose)
3118 {
3119 RTPrintf(GuestCtrl::tr("Old Guest Additions: %ls%RU64\n"), strGstVerCur.raw(),
3120 uGstRevCur);
3121 RTPrintf(GuestCtrl::tr("New Guest Additions: %ls%RU64\n"), strGstVerNew.raw(),
3122 uGstRevNew);
3123
3124 if (RT_FAILURE(vrc))
3125 {
3126 RTPrintf(GuestCtrl::tr("\nError updating Guest Additions, please check guest installer log\n"));
3127 }
3128 else
3129 {
3130 if (uGstRevNew < uGstRevCur)
3131 RTPrintf(GuestCtrl::tr("\nWARNING: Guest Additions were downgraded\n"));
3132 }
3133 }
3134 }
3135 }
3136 }
3137 else if (pCtx->cVerbose)
3138 RTPrintf(GuestCtrl::tr("The guest needs to be restarted in order to make use of the updated Guest Additions.\n"));
3139 }
3140 }
3141 }
3142 }
3143 }
3144 }
3145
3146 return RT_SUCCESS(vrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3147}
3148
3149/**
3150 * Returns a Guest Additions run level from a string.
3151 *
3152 * @returns Run level if found, or AdditionsRunLevelType_None if not found / invalid.
3153 * @param pcszStr String to return run level for.
3154 */
3155static AdditionsRunLevelType_T gctlGetRunLevelFromStr(const char *pcszStr)
3156{
3157 AssertPtrReturn(pcszStr, AdditionsRunLevelType_None);
3158
3159 if (RTStrICmp(pcszStr, "system") == 0) return AdditionsRunLevelType_System;
3160 else if (RTStrICmp(pcszStr, "userland") == 0) return AdditionsRunLevelType_Userland;
3161 else if (RTStrICmp(pcszStr, "desktop") == 0) return AdditionsRunLevelType_Desktop;
3162
3163 return AdditionsRunLevelType_None;
3164}
3165
3166static DECLCALLBACK(RTEXITCODE) gctlHandleWaitRunLevel(PGCTLCMDCTX pCtx, int argc, char **argv)
3167{
3168 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3169
3170 /** Timeout to wait for run level being reached.
3171 * By default we wait until it's reached. */
3172 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
3173
3174 /*
3175 * Parse arguments.
3176 */
3177 enum KGSTCTRLWAITRUNLEVELOPT
3178 {
3179 KGSTCTRLWAITRUNLEVELOPT_TIMEOUT = 1000
3180 };
3181
3182 static const RTGETOPTDEF s_aOptions[] =
3183 {
3184 GCTLCMD_COMMON_OPTION_DEFS()
3185 { "--timeout", KGSTCTRLWAITRUNLEVELOPT_TIMEOUT, RTGETOPT_REQ_UINT32 }
3186 };
3187
3188 int ch;
3189 RTGETOPTUNION ValueUnion;
3190 RTGETOPTSTATE GetState;
3191 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3192
3193 AdditionsRunLevelType_T enmRunLevel = AdditionsRunLevelType_None;
3194
3195 int vrc = VINF_SUCCESS;
3196 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
3197 && RT_SUCCESS(vrc))
3198 {
3199 switch (ch)
3200 {
3201 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3202
3203 case KGSTCTRLWAITRUNLEVELOPT_TIMEOUT:
3204 cMsTimeout = ValueUnion.u32;
3205 break;
3206
3207 case VINF_GETOPT_NOT_OPTION:
3208 {
3209 enmRunLevel = gctlGetRunLevelFromStr(ValueUnion.psz);
3210 if (enmRunLevel == AdditionsRunLevelType_None)
3211 return errorSyntax(GuestCtrl::tr("Invalid run level specified. Valid values are: system, userland, desktop"));
3212 break;
3213 }
3214
3215 default:
3216 return errorGetOpt(ch, &ValueUnion);
3217 }
3218 }
3219
3220 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3221 if (rcExit != RTEXITCODE_SUCCESS)
3222 return rcExit;
3223
3224 if (enmRunLevel == AdditionsRunLevelType_None)
3225 return errorSyntax(GuestCtrl::tr("Missing run level to wait for"));
3226
3227 vrc = gctlWaitForRunLevel(pCtx, enmRunLevel, cMsTimeout);
3228
3229 return RT_SUCCESS(vrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3230}
3231
3232static DECLCALLBACK(RTEXITCODE) gctlHandleList(PGCTLCMDCTX pCtx, int argc, char **argv)
3233{
3234 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3235
3236 static const RTGETOPTDEF s_aOptions[] =
3237 {
3238 GCTLCMD_COMMON_OPTION_DEFS()
3239 };
3240
3241 int ch;
3242 RTGETOPTUNION ValueUnion;
3243 RTGETOPTSTATE GetState;
3244 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3245
3246 bool fSeenListArg = false;
3247 bool fListAll = false;
3248 bool fListSessions = false;
3249 bool fListProcesses = false;
3250 bool fListFiles = false;
3251
3252 int vrc = VINF_SUCCESS;
3253 while ( (ch = RTGetOpt(&GetState, &ValueUnion))
3254 && RT_SUCCESS(vrc))
3255 {
3256 switch (ch)
3257 {
3258 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3259
3260 case VINF_GETOPT_NOT_OPTION:
3261 if ( !RTStrICmp(ValueUnion.psz, "sessions")
3262 || !RTStrICmp(ValueUnion.psz, "sess"))
3263 fListSessions = true;
3264 else if ( !RTStrICmp(ValueUnion.psz, "processes")
3265 || !RTStrICmp(ValueUnion.psz, "procs"))
3266 fListSessions = fListProcesses = true; /* Showing processes implies showing sessions. */
3267 else if (!RTStrICmp(ValueUnion.psz, "files"))
3268 fListSessions = fListFiles = true; /* Showing files implies showing sessions. */
3269 else if (!RTStrICmp(ValueUnion.psz, "all"))
3270 fListAll = true;
3271 else
3272 return errorSyntax(GuestCtrl::tr("Unknown list: '%s'"), ValueUnion.psz);
3273 fSeenListArg = true;
3274 break;
3275
3276 default:
3277 return errorGetOpt(ch, &ValueUnion);
3278 }
3279 }
3280
3281 if (!fSeenListArg)
3282 return errorSyntax(GuestCtrl::tr("Missing list name"));
3283 Assert(fListAll || fListSessions);
3284
3285 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3286 if (rcExit != RTEXITCODE_SUCCESS)
3287 return rcExit;
3288
3289
3290 /** @todo Do we need a machine-readable output here as well? */
3291
3292 HRESULT hrc;
3293 size_t cTotalProcs = 0;
3294 size_t cTotalFiles = 0;
3295
3296 SafeIfaceArray <IGuestSession> collSessions;
3297 CHECK_ERROR(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3298 if (SUCCEEDED(hrc))
3299 {
3300 size_t const cSessions = collSessions.size();
3301 if (cSessions)
3302 {
3303 RTPrintf(GuestCtrl::tr("Active guest sessions:\n"));
3304
3305 /** @todo Make this output a bit prettier. No time now. */
3306
3307 for (size_t i = 0; i < cSessions; i++)
3308 {
3309 ComPtr<IGuestSession> pCurSession = collSessions[i];
3310 if (!pCurSession.isNull())
3311 {
3312 do
3313 {
3314 ULONG uID;
3315 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Id)(&uID));
3316 Bstr strName;
3317 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Name)(strName.asOutParam()));
3318 Bstr strUser;
3319 CHECK_ERROR_BREAK(pCurSession, COMGETTER(User)(strUser.asOutParam()));
3320 GuestSessionStatus_T sessionStatus;
3321 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Status)(&sessionStatus));
3322 RTPrintf(GuestCtrl::tr("\n\tSession #%-3zu ID=%-3RU32 User=%-16ls Status=[%s] Name=%ls"),
3323 i, uID, strUser.raw(), gctlGuestSessionStatusToText(sessionStatus), strName.raw());
3324 } while (0);
3325
3326 if ( fListAll
3327 || fListProcesses)
3328 {
3329 SafeIfaceArray <IGuestProcess> collProcesses;
3330 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Processes)(ComSafeArrayAsOutParam(collProcesses)));
3331 for (size_t a = 0; a < collProcesses.size(); a++)
3332 {
3333 ComPtr<IGuestProcess> pCurProcess = collProcesses[a];
3334 if (!pCurProcess.isNull())
3335 {
3336 do
3337 {
3338 ULONG uPID;
3339 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(PID)(&uPID));
3340 Bstr strExecPath;
3341 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(ExecutablePath)(strExecPath.asOutParam()));
3342 ProcessStatus_T procStatus;
3343 CHECK_ERROR_BREAK(pCurProcess, COMGETTER(Status)(&procStatus));
3344
3345 RTPrintf(GuestCtrl::tr("\n\t\tProcess #%-03zu PID=%-6RU32 Status=[%s] Command=%ls"),
3346 a, uPID, gctlProcessStatusToText(procStatus), strExecPath.raw());
3347 } while (0);
3348 }
3349 }
3350
3351 cTotalProcs += collProcesses.size();
3352 }
3353
3354 if ( fListAll
3355 || fListFiles)
3356 {
3357 SafeIfaceArray <IGuestFile> collFiles;
3358 CHECK_ERROR_BREAK(pCurSession, COMGETTER(Files)(ComSafeArrayAsOutParam(collFiles)));
3359 for (size_t a = 0; a < collFiles.size(); a++)
3360 {
3361 ComPtr<IGuestFile> pCurFile = collFiles[a];
3362 if (!pCurFile.isNull())
3363 {
3364 do
3365 {
3366 ULONG idFile;
3367 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Id)(&idFile));
3368 Bstr strName;
3369 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Filename)(strName.asOutParam()));
3370 FileStatus_T fileStatus;
3371 CHECK_ERROR_BREAK(pCurFile, COMGETTER(Status)(&fileStatus));
3372
3373 RTPrintf(GuestCtrl::tr("\n\t\tFile #%-03zu ID=%-6RU32 Status=[%s] Name=%ls"),
3374 a, idFile, gctlFileStatusToText(fileStatus), strName.raw());
3375 } while (0);
3376 }
3377 }
3378
3379 cTotalFiles += collFiles.size();
3380 }
3381 }
3382 }
3383
3384 RTPrintf(GuestCtrl::tr("\n\nTotal guest sessions: %zu\n"), collSessions.size());
3385 if (fListAll || fListProcesses)
3386 RTPrintf(GuestCtrl::tr("Total guest processes: %zu\n"), cTotalProcs);
3387 if (fListAll || fListFiles)
3388 RTPrintf(GuestCtrl::tr("Total guest files: %zu\n"), cTotalFiles);
3389 }
3390 else
3391 RTPrintf(GuestCtrl::tr("No active guest sessions found\n"));
3392 }
3393
3394 if (FAILED(hrc)) /** @todo yeah, right... Only the last error? */
3395 rcExit = RTEXITCODE_FAILURE;
3396
3397 return rcExit;
3398}
3399
3400static DECLCALLBACK(RTEXITCODE) gctlHandleCloseProcess(PGCTLCMDCTX pCtx, int argc, char **argv)
3401{
3402 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3403
3404 static const RTGETOPTDEF s_aOptions[] =
3405 {
3406 GCTLCMD_COMMON_OPTION_DEFS()
3407 { "--session-id", 'i', RTGETOPT_REQ_UINT32 },
3408 { "--session-name", 'n', RTGETOPT_REQ_STRING }
3409 };
3410
3411 int ch;
3412 RTGETOPTUNION ValueUnion;
3413 RTGETOPTSTATE GetState;
3414 int vrc = RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3415 AssertRCReturn(vrc, RTEXITCODE_FAILURE);
3416
3417 std::vector < uint32_t > vecPID;
3418 ULONG idSession = UINT32_MAX;
3419 Utf8Str strSessionName;
3420
3421 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3422 {
3423 /* For options that require an argument, ValueUnion has received the value. */
3424 switch (ch)
3425 {
3426 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3427
3428 case 'n': /* Session name (or pattern) */
3429 strSessionName = ValueUnion.psz;
3430 break;
3431
3432 case 'i': /* Session ID */
3433 idSession = ValueUnion.u32;
3434 break;
3435
3436 case VINF_GETOPT_NOT_OPTION:
3437 {
3438 /* Treat every else specified as a PID to kill. */
3439 uint32_t uPid;
3440 vrc = RTStrToUInt32Ex(ValueUnion.psz, NULL, 0, &uPid);
3441 if ( RT_SUCCESS(vrc)
3442 && vrc != VWRN_TRAILING_CHARS
3443 && vrc != VWRN_NUMBER_TOO_BIG
3444 && vrc != VWRN_NEGATIVE_UNSIGNED)
3445 {
3446 if (uPid != 0)
3447 {
3448 try
3449 {
3450 vecPID.push_back(uPid);
3451 }
3452 catch (std::bad_alloc &)
3453 {
3454 return RTMsgErrorExit(RTEXITCODE_FAILURE, GuestCtrl::tr("Out of memory"));
3455 }
3456 }
3457 else
3458 return errorSyntax(GuestCtrl::tr("Invalid PID value: 0"));
3459 }
3460 else
3461 return errorSyntax(GuestCtrl::tr("Error parsing PID value: %Rrc"), vrc);
3462 break;
3463 }
3464
3465 default:
3466 return errorGetOpt(ch, &ValueUnion);
3467 }
3468 }
3469
3470 if (vecPID.empty())
3471 return errorSyntax(GuestCtrl::tr("At least one PID must be specified to kill!"));
3472
3473 if ( strSessionName.isEmpty()
3474 && idSession == UINT32_MAX)
3475 return errorSyntax(GuestCtrl::tr("No session ID specified!"));
3476
3477 if ( strSessionName.isNotEmpty()
3478 && idSession != UINT32_MAX)
3479 return errorSyntax(GuestCtrl::tr("Either session ID or name (pattern) must be specified"));
3480
3481 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3482 if (rcExit != RTEXITCODE_SUCCESS)
3483 return rcExit;
3484
3485 HRESULT hrc = S_OK;
3486
3487 ComPtr<IGuestSession> pSession;
3488 ComPtr<IGuestProcess> pProcess;
3489 do
3490 {
3491 uint32_t uProcsTerminated = 0;
3492
3493 SafeIfaceArray <IGuestSession> collSessions;
3494 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3495 size_t cSessions = collSessions.size();
3496
3497 uint32_t cSessionsHandled = 0;
3498 for (size_t i = 0; i < cSessions; i++)
3499 {
3500 pSession = collSessions[i];
3501 Assert(!pSession.isNull());
3502
3503 ULONG uID; /* Session ID */
3504 CHECK_ERROR_BREAK(pSession, COMGETTER(Id)(&uID));
3505 Bstr strName;
3506 CHECK_ERROR_BREAK(pSession, COMGETTER(Name)(strName.asOutParam()));
3507 Utf8Str strNameUtf8(strName); /* Session name */
3508
3509 bool fSessionFound;
3510 if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
3511 fSessionFound = uID == idSession;
3512 else /* ... or by naming pattern. */
3513 fSessionFound = RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str());
3514 if (fSessionFound)
3515 {
3516 AssertStmt(!pSession.isNull(), break);
3517 cSessionsHandled++;
3518
3519 SafeIfaceArray <IGuestProcess> collProcs;
3520 CHECK_ERROR_BREAK(pSession, COMGETTER(Processes)(ComSafeArrayAsOutParam(collProcs)));
3521
3522 size_t cProcs = collProcs.size();
3523 for (size_t p = 0; p < cProcs; p++)
3524 {
3525 pProcess = collProcs[p];
3526 Assert(!pProcess.isNull());
3527
3528 ULONG uPID; /* Process ID */
3529 CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID));
3530
3531 bool fProcFound = false;
3532 for (size_t a = 0; a < vecPID.size(); a++) /* Slow, but works. */
3533 {
3534 fProcFound = vecPID[a] == uPID;
3535 if (fProcFound)
3536 break;
3537 }
3538
3539 if (fProcFound)
3540 {
3541 if (pCtx->cVerbose)
3542 RTPrintf(GuestCtrl::tr("Terminating process (PID %RU32) (session ID %RU32) ...\n"),
3543 uPID, uID);
3544 CHECK_ERROR_BREAK(pProcess, Terminate());
3545 uProcsTerminated++;
3546 }
3547 else
3548 {
3549 if (idSession != UINT32_MAX)
3550 RTPrintf(GuestCtrl::tr("No matching process(es) for session ID %RU32 found\n"),
3551 idSession);
3552 }
3553
3554 pProcess.setNull();
3555 }
3556
3557 pSession.setNull();
3558 }
3559 }
3560
3561 if (!cSessionsHandled)
3562 RTPrintf(GuestCtrl::tr("No matching session(s) found\n"));
3563
3564 if (uProcsTerminated)
3565 RTPrintf(GuestCtrl::tr("%RU32 process(es) terminated\n", "", uProcsTerminated), uProcsTerminated);
3566
3567 } while (0);
3568
3569 pProcess.setNull();
3570 pSession.setNull();
3571
3572 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3573}
3574
3575
3576static DECLCALLBACK(RTEXITCODE) gctlHandleCloseSession(PGCTLCMDCTX pCtx, int argc, char **argv)
3577{
3578 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3579
3580 enum GETOPTDEF_SESSIONCLOSE
3581 {
3582 GETOPTDEF_SESSIONCLOSE_ALL = 2000
3583 };
3584 static const RTGETOPTDEF s_aOptions[] =
3585 {
3586 GCTLCMD_COMMON_OPTION_DEFS()
3587 { "--all", GETOPTDEF_SESSIONCLOSE_ALL, RTGETOPT_REQ_NOTHING },
3588 { "--session-id", 'i', RTGETOPT_REQ_UINT32 },
3589 { "--session-name", 'n', RTGETOPT_REQ_STRING }
3590 };
3591
3592 int ch;
3593 RTGETOPTUNION ValueUnion;
3594 RTGETOPTSTATE GetState;
3595 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3596
3597 ULONG idSession = UINT32_MAX;
3598 Utf8Str strSessionName;
3599
3600 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3601 {
3602 /* For options that require an argument, ValueUnion has received the value. */
3603 switch (ch)
3604 {
3605 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3606
3607 case 'n': /* Session name pattern */
3608 strSessionName = ValueUnion.psz;
3609 break;
3610
3611 case 'i': /* Session ID */
3612 idSession = ValueUnion.u32;
3613 break;
3614
3615 case GETOPTDEF_SESSIONCLOSE_ALL:
3616 strSessionName = "*";
3617 break;
3618
3619 case VINF_GETOPT_NOT_OPTION:
3620 /** @todo Supply a CSV list of IDs or patterns to close?
3621 * break; */
3622 default:
3623 return errorGetOpt(ch, &ValueUnion);
3624 }
3625 }
3626
3627 if ( strSessionName.isEmpty()
3628 && idSession == UINT32_MAX)
3629 return errorSyntax(GuestCtrl::tr("No session ID specified!"));
3630
3631 if ( !strSessionName.isEmpty()
3632 && idSession != UINT32_MAX)
3633 return errorSyntax(GuestCtrl::tr("Either session ID or name (pattern) must be specified"));
3634
3635 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3636 if (rcExit != RTEXITCODE_SUCCESS)
3637 return rcExit;
3638
3639 HRESULT hrc = S_OK;
3640
3641 do
3642 {
3643 size_t cSessionsHandled = 0;
3644
3645 SafeIfaceArray <IGuestSession> collSessions;
3646 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
3647 size_t cSessions = collSessions.size();
3648
3649 for (size_t i = 0; i < cSessions; i++)
3650 {
3651 ComPtr<IGuestSession> pSession = collSessions[i];
3652 Assert(!pSession.isNull());
3653
3654 ULONG uID; /* Session ID */
3655 CHECK_ERROR_BREAK(pSession, COMGETTER(Id)(&uID));
3656 Bstr strName;
3657 CHECK_ERROR_BREAK(pSession, COMGETTER(Name)(strName.asOutParam()));
3658 Utf8Str strNameUtf8(strName); /* Session name */
3659
3660 bool fSessionFound;
3661 if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
3662 fSessionFound = uID == idSession;
3663 else /* ... or by naming pattern. */
3664 fSessionFound = RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str());
3665 if (fSessionFound)
3666 {
3667 cSessionsHandled++;
3668
3669 Assert(!pSession.isNull());
3670 if (pCtx->cVerbose)
3671 RTPrintf(GuestCtrl::tr("Closing guest session ID=#%RU32 \"%s\" ...\n"),
3672 uID, strNameUtf8.c_str());
3673 CHECK_ERROR_BREAK(pSession, Close());
3674 if (pCtx->cVerbose)
3675 RTPrintf(GuestCtrl::tr("Guest session successfully closed\n"));
3676
3677 pSession.setNull();
3678 }
3679 }
3680
3681 if (!cSessionsHandled)
3682 {
3683 RTPrintf(GuestCtrl::tr("No guest session(s) found\n"));
3684 hrc = E_ABORT; /* To set exit code accordingly. */
3685 }
3686
3687 } while (0);
3688
3689 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3690}
3691
3692
3693static DECLCALLBACK(RTEXITCODE) gctlHandleWatch(PGCTLCMDCTX pCtx, int argc, char **argv)
3694{
3695 AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
3696
3697 /*
3698 * Parse arguments.
3699 */
3700 static const RTGETOPTDEF s_aOptions[] =
3701 {
3702 GCTLCMD_COMMON_OPTION_DEFS()
3703 { "--timeout", 't', RTGETOPT_REQ_UINT32 }
3704 };
3705
3706 uint32_t cMsTimeout = RT_INDEFINITE_WAIT;
3707
3708 int ch;
3709 RTGETOPTUNION ValueUnion;
3710 RTGETOPTSTATE GetState;
3711 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
3712
3713 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3714 {
3715 /* For options that require an argument, ValueUnion has received the value. */
3716 switch (ch)
3717 {
3718 GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
3719
3720 case 't': /* Timeout */
3721 cMsTimeout = ValueUnion.u32;
3722 break;
3723
3724 case VINF_GETOPT_NOT_OPTION:
3725 default:
3726 return errorGetOpt(ch, &ValueUnion);
3727 }
3728 }
3729
3730 /** @todo Specify categories to watch for. */
3731
3732 RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
3733 if (rcExit != RTEXITCODE_SUCCESS)
3734 return rcExit;
3735
3736 HRESULT hrc;
3737
3738 try
3739 {
3740 ComObjPtr<GuestEventListenerImpl> pGuestListener;
3741 do
3742 {
3743 /* Listener creation. */
3744 pGuestListener.createObject();
3745 pGuestListener->init(new GuestEventListener());
3746
3747 /* Register for IGuest events. */
3748 ComPtr<IEventSource> es;
3749 CHECK_ERROR_BREAK(pCtx->pGuest, COMGETTER(EventSource)(es.asOutParam()));
3750 com::SafeArray<VBoxEventType_T> eventTypes;
3751 eventTypes.push_back(VBoxEventType_OnGuestSessionRegistered);
3752 /** @todo Also register for VBoxEventType_OnGuestUserStateChanged on demand? */
3753 CHECK_ERROR_BREAK(es, RegisterListener(pGuestListener, ComSafeArrayAsInParam(eventTypes),
3754 true /* Active listener */));
3755 /* Note: All other guest control events have to be registered
3756 * as their corresponding objects appear. */
3757
3758 } while (0);
3759
3760 if (pCtx->cVerbose)
3761 RTPrintf(GuestCtrl::tr("Waiting for events ...\n"));
3762
3763 RTMSINTERVAL tsStart = RTTimeMilliTS();
3764 while (RTTimeMilliTS() - tsStart < cMsTimeout)
3765 {
3766 /* Wait for the global signal semaphore getting signalled. */
3767 int vrc = RTSemEventWait(g_SemEventGuestCtrlCanceled, 100 /* ms */);
3768 if (RT_FAILURE(vrc))
3769 {
3770 if (vrc != VERR_TIMEOUT)
3771 {
3772 RTPrintf(GuestCtrl::tr("Waiting failed with %Rrc\n"), vrc);
3773 break;
3774 }
3775 }
3776 else
3777 break;
3778
3779 /* We need to process the event queue, otherwise our registered listeners won't get any events. */
3780 NativeEventQueue::getMainEventQueue()->processEventQueue(0);
3781 }
3782
3783 if (!pGuestListener.isNull())
3784 {
3785 /* Guest callback unregistration. */
3786 ComPtr<IEventSource> pES;
3787 CHECK_ERROR(pCtx->pGuest, COMGETTER(EventSource)(pES.asOutParam()));
3788 if (!pES.isNull())
3789 CHECK_ERROR(pES, UnregisterListener(pGuestListener));
3790 pGuestListener.setNull();
3791 }
3792 }
3793 catch (std::bad_alloc &)
3794 {
3795 hrc = E_OUTOFMEMORY;
3796 }
3797
3798 return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
3799}
3800
3801/**
3802 * Access the guest control store.
3803 *
3804 * @returns program exit code.
3805 * @note see the command line API description for parameters
3806 */
3807RTEXITCODE handleGuestControl(HandlerArg *pArg)
3808{
3809 AssertPtr(pArg);
3810
3811 /*
3812 * Command definitions.
3813 */
3814 static const GCTLCMDDEF s_aCmdDefs[] =
3815 {
3816 { "run", gctlHandleRun, HELP_SCOPE_GUESTCONTROL_RUN, 0 },
3817 { "start", gctlHandleStart, HELP_SCOPE_GUESTCONTROL_START, 0 },
3818 { "copyfrom", gctlHandleCopyFrom, HELP_SCOPE_GUESTCONTROL_COPYFROM, 0 },
3819 { "copyto", gctlHandleCopyTo, HELP_SCOPE_GUESTCONTROL_COPYTO, 0 },
3820
3821 { "mkdir", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3822 { "md", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3823 { "createdirectory", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3824 { "createdir", gctrlHandleMkDir, HELP_SCOPE_GUESTCONTROL_MKDIR, 0 },
3825
3826 { "rmdir", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3827 { "removedir", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3828 { "removedirectory", gctlHandleRmDir, HELP_SCOPE_GUESTCONTROL_RMDIR, 0 },
3829
3830 { "rm", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3831 { "removefile", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3832 { "erase", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3833 { "del", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3834 { "delete", gctlHandleRm, HELP_SCOPE_GUESTCONTROL_RM, 0 },
3835
3836 { "mv", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3837 { "move", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3838 { "ren", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3839 { "rename", gctlHandleMv, HELP_SCOPE_GUESTCONTROL_MV, 0 },
3840
3841 { "mktemp", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3842 { "createtemp", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3843 { "createtemporary", gctlHandleMkTemp, HELP_SCOPE_GUESTCONTROL_MKTEMP, 0 },
3844
3845 { "mount", gctlHandleMount, HELP_SCOPE_GUESTCONTROL_MOUNT, 0 },
3846
3847 { "df", gctlHandleFsInfo, HELP_SCOPE_GUESTCONTROL_FSINFO, 0 },
3848 { "fsinfo", gctlHandleFsInfo, HELP_SCOPE_GUESTCONTROL_FSINFO, 0 },
3849
3850 { "stat", gctlHandleStat, HELP_SCOPE_GUESTCONTROL_STAT, 0 },
3851
3852 { "closeprocess", gctlHandleCloseProcess, HELP_SCOPE_GUESTCONTROL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3853 { "closesession", gctlHandleCloseSession, HELP_SCOPE_GUESTCONTROL_CLOSESESSION, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3854 { "list", gctlHandleList, HELP_SCOPE_GUESTCONTROL_LIST, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER },
3855 { "watch", gctlHandleWatch, HELP_SCOPE_GUESTCONTROL_WATCH, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3856
3857 {"updateguestadditions",gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3858 { "updateadditions", gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3859 { "updatega", gctlHandleUpdateAdditions, HELP_SCOPE_GUESTCONTROL_UPDATEGA, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3860
3861 { "waitrunlevel", gctlHandleWaitRunLevel, HELP_SCOPE_GUESTCONTROL_WAITRUNLEVEL, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3862 { "waitforrunlevel", gctlHandleWaitRunLevel, HELP_SCOPE_GUESTCONTROL_WAITRUNLEVEL, GCTLCMDCTX_F_SESSION_ANONYMOUS },
3863 };
3864
3865 /*
3866 * VBoxManage guestcontrol [common-options] <VM> [common-options] <sub-command> ...
3867 *
3868 * Parse common options and VM name until we find a sub-command. Allowing
3869 * the user to put the user and password related options before the
3870 * sub-command makes it easier to edit the command line when doing several
3871 * operations with the same guest user account. (Accidentally, it also
3872 * makes the syntax diagram shorter and easier to read.)
3873 */
3874 GCTLCMDCTX CmdCtx;
3875 RTEXITCODE rcExit = gctrCmdCtxInit(&CmdCtx, pArg);
3876 if (rcExit == RTEXITCODE_SUCCESS)
3877 {
3878 static const RTGETOPTDEF s_CommonOptions[] = { GCTLCMD_COMMON_OPTION_DEFS() };
3879
3880 int ch;
3881 RTGETOPTUNION ValueUnion;
3882 RTGETOPTSTATE GetState;
3883 RTGetOptInit(&GetState, pArg->argc, pArg->argv, s_CommonOptions, RT_ELEMENTS(s_CommonOptions), 0, 0 /* No sorting! */);
3884
3885 while ((ch = RTGetOpt(&GetState, &ValueUnion)) != 0)
3886 {
3887 switch (ch)
3888 {
3889 GCTLCMD_COMMON_OPTION_CASES(&CmdCtx, ch, &ValueUnion);
3890
3891 case VINF_GETOPT_NOT_OPTION:
3892 /* First comes the VM name or UUID. */
3893 if (!CmdCtx.pszVmNameOrUuid)
3894 CmdCtx.pszVmNameOrUuid = ValueUnion.psz;
3895 /*
3896 * The sub-command is next. Look it up and invoke it.
3897 * Note! Currently no warnings about user/password options (like we'll do later on)
3898 * for GCTLCMDCTX_F_SESSION_ANONYMOUS commands. No reason to be too pedantic.
3899 */
3900 else
3901 {
3902 const char *pszCmd = ValueUnion.psz;
3903 uint32_t iCmd;
3904 for (iCmd = 0; iCmd < RT_ELEMENTS(s_aCmdDefs); iCmd++)
3905 if (strcmp(s_aCmdDefs[iCmd].pszName, pszCmd) == 0)
3906 {
3907 CmdCtx.pCmdDef = &s_aCmdDefs[iCmd];
3908
3909 setCurrentSubcommand(s_aCmdDefs[iCmd].fSubcommandScope);
3910 rcExit = s_aCmdDefs[iCmd].pfnHandler(&CmdCtx, pArg->argc - GetState.iNext + 1,
3911 &pArg->argv[GetState.iNext - 1]);
3912
3913 gctlCtxTerm(&CmdCtx);
3914 return rcExit;
3915 }
3916 return errorSyntax(GuestCtrl::tr("Unknown sub-command: '%s'"), pszCmd);
3917 }
3918 break;
3919
3920 default:
3921 return errorGetOpt(ch, &ValueUnion);
3922 }
3923 }
3924 if (CmdCtx.pszVmNameOrUuid)
3925 rcExit = errorSyntax(GuestCtrl::tr("Missing sub-command"));
3926 else
3927 rcExit = errorSyntax(GuestCtrl::tr("Missing VM name and sub-command"));
3928 }
3929 return rcExit;
3930}
Note: See TracBrowser for help on using the repository browser.

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