VBoxManage.cpp@ 16637

Last change on this file since 16637 was 16530, checked in by vboxsync, 16 years ago
Main: rework error macros everywhere; make error messages much more readable (esp. with VBoxManage); use shared function to actually print message; reduces size of VBoxManage debug build from 3.4 to 2.3 MB
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 108.3 KB

Line
1	/* $Id: VBoxManage.cpp 16530 2009-02-05 16:08:49Z vboxsync $ */
2	/** @file
3	* VBoxManage - VirtualBox's command-line interface.
4	*/
5
6	/*
7	* Copyright (C) 2006-2009 Sun Microsystems, Inc.
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22
23	/*******************************************************************************
24	* Header Files *
25	*******************************************************************************/
26	#ifndef VBOX_ONLY_DOCS
27	#include <VBox/com/com.h>
28	#include <VBox/com/string.h>
29	#include <VBox/com/Guid.h>
30	#include <VBox/com/array.h>
31	#include <VBox/com/ErrorInfo.h>
32	#include <VBox/com/errorprint2.h>
33	#include <VBox/com/EventQueue.h>
34
35	#include <VBox/com/VirtualBox.h>
36
37	#include <vector>
38	#include <list>
39	#endif /* !VBOX_ONLY_DOCS */
40
41	#include <iprt/asm.h>
42	#include <iprt/cidr.h>
43	#include <iprt/ctype.h>
44	#include <iprt/dir.h>
45	#include <iprt/env.h>
46	#include <VBox/err.h>
47	#include <iprt/file.h>
48	#include <iprt/initterm.h>
49	#include <iprt/param.h>
50	#include <iprt/path.h>
51	#include <iprt/stream.h>
52	#include <iprt/string.h>
53	#include <iprt/stdarg.h>
54	#include <iprt/thread.h>
55	#include <iprt/uuid.h>
56	#include <VBox/version.h>
57	#include <VBox/log.h>
58
59	#include "VBoxManage.h"
60
61	#ifndef VBOX_ONLY_DOCS
62	using namespace com;
63
64	/* missing XPCOM <-> COM wrappers */
65	#ifndef STDMETHOD_
66	# define STDMETHOD_(ret, meth) NS_IMETHOD_(ret) meth
67	#endif
68	#ifndef NS_GET_IID
69	# define NS_GET_IID(I) IID_##I
70	#endif
71	#ifndef RT_OS_WINDOWS
72	#define IUnknown nsISupports
73	#endif
74
75	/** command handler type */
76	typedef int (PFNHANDLER)(HandlerArg a);
77
78	/**
79	* Quick IUSBDevice implementation for detaching / attaching
80	* devices to the USB Controller.
81	*/
82	class MyUSBDevice : public IUSBDevice
83	{
84	public:
85	// public initializer/uninitializer for internal purposes only
86	MyUSBDevice(uint16_t a_u16VendorId, uint16_t a_u16ProductId, uint16_t a_bcdRevision, uint64_t a_u64SerialHash, const char *a_pszComment)
87	: m_usVendorId(a_u16VendorId), m_usProductId(a_u16ProductId),
88	m_bcdRevision(a_bcdRevision), m_u64SerialHash(a_u64SerialHash),
89	m_bstrComment(a_pszComment),
90	m_cRefs(0)
91	{
92	}
93
94	STDMETHOD_(ULONG, AddRef)(void)
95	{
96	return ASMAtomicIncU32(&m_cRefs);
97	}
98	STDMETHOD_(ULONG, Release)(void)
99	{
100	ULONG cRefs = ASMAtomicDecU32(&m_cRefs);
101	if (!cRefs)
102	delete this;
103	return cRefs;
104	}
105	STDMETHOD(QueryInterface)(const IID &iid, void **ppvObject)
106	{
107	Guid guid(iid);
108	if (guid == Guid(NS_GET_IID(IUnknown)))
109	ppvObject = (IUnknown )this;
110	else if (guid == Guid(NS_GET_IID(IUSBDevice)))
111	ppvObject = (IUSBDevice )this;
112	else
113	return E_NOINTERFACE;
114	AddRef();
115	return S_OK;
116	}
117
118	STDMETHOD(COMGETTER(Id))(OUT_GUID a_pId) { return E_NOTIMPL; }
119	STDMETHOD(COMGETTER(VendorId))(USHORT a_pusVendorId) { a_pusVendorId = m_usVendorId; return S_OK; }
120	STDMETHOD(COMGETTER(ProductId))(USHORT a_pusProductId) { a_pusProductId = m_usProductId; return S_OK; }
121	STDMETHOD(COMGETTER(Revision))(USHORT a_pusRevision) { a_pusRevision = m_bcdRevision; return S_OK; }
122	STDMETHOD(COMGETTER(SerialHash))(ULONG64 a_pullSerialHash) { a_pullSerialHash = m_u64SerialHash; return S_OK; }
123	STDMETHOD(COMGETTER(Manufacturer))(BSTR *a_pManufacturer) { return E_NOTIMPL; }
124	STDMETHOD(COMGETTER(Product))(BSTR *a_pProduct) { return E_NOTIMPL; }
125	STDMETHOD(COMGETTER(SerialNumber))(BSTR *a_pSerialNumber) { return E_NOTIMPL; }
126	STDMETHOD(COMGETTER(Address))(BSTR *a_pAddress) { return E_NOTIMPL; }
127
128	private:
129	/** The vendor id of this USB device. */
130	USHORT m_usVendorId;
131	/** The product id of this USB device. */
132	USHORT m_usProductId;
133	/** The product revision number of this USB device.
134	* (high byte = integer; low byte = decimal) */
135	USHORT m_bcdRevision;
136	/** The USB serial hash of the device. */
137	uint64_t m_u64SerialHash;
138	/** The user comment string. */
139	Bstr m_bstrComment;
140	/** Reference counter. */
141	uint32_t volatile m_cRefs;
142	};
143
144
145	// types
146	///////////////////////////////////////////////////////////////////////////////
147
148	template <typename T>
149	class Nullable
150	{
151	public:
152
153	Nullable() : mIsNull (true) {}
154	Nullable (const T &aValue, bool aIsNull = false)
155	: mIsNull (aIsNull), mValue (aValue) {}
156
157	bool isNull() const { return mIsNull; };
158	void setNull (bool aIsNull = true) { mIsNull = aIsNull; }
159
160	operator const T&() const { return mValue; }
161
162	Nullable &operator= (const T &aValue)
163	{
164	mValue = aValue;
165	mIsNull = false;
166	return *this;
167	}
168
169	private:
170
171	bool mIsNull;
172	T mValue;
173	};
174
175	/** helper structure to encapsulate USB filter manipulation commands */
176	struct USBFilterCmd
177	{
178	struct USBFilter
179	{
180	USBFilter ()
181	: mAction (USBDeviceFilterAction_Null)
182	{}
183
184	Bstr mName;
185	Nullable <bool> mActive;
186	Bstr mVendorId;
187	Bstr mProductId;
188	Bstr mRevision;
189	Bstr mManufacturer;
190	Bstr mProduct;
191	Bstr mRemote;
192	Bstr mSerialNumber;
193	Nullable <ULONG> mMaskedInterfaces;
194	USBDeviceFilterAction_T mAction;
195	};
196
197	enum Action { Invalid, Add, Modify, Remove };
198
199	USBFilterCmd() : mAction (Invalid), mIndex (0), mGlobal (false) {}
200
201	Action mAction;
202	uint32_t mIndex;
203	/** flag whether the command target is a global filter */
204	bool mGlobal;
205	/** machine this command is targeted at (null for global filters) */
206	ComPtr<IMachine> mMachine;
207	USBFilter mFilter;
208	};
209	#endif /* !VBOX_ONLY_DOCS */
210
211	// funcs
212	///////////////////////////////////////////////////////////////////////////////
213
214	static void showLogo(void)
215	{
216	static bool fShown; /* show only once */
217
218	if (!fShown)
219	{
220	RTPrintf("VirtualBox Command Line Management Interface Version "
221	VBOX_VERSION_STRING "\n"
222	"(C) 2005-2009 Sun Microsystems, Inc.\n"
223	"All rights reserved.\n"
224	"\n");
225	fShown = true;
226	}
227	}
228
229	static void printUsage(USAGECATEGORY u64Cmd)
230	{
231	#ifdef RT_OS_LINUX
232	bool fLinux = true;
233	#else
234	bool fLinux = false;
235	#endif
236	#ifdef RT_OS_WINDOWS
237	bool fWin = true;
238	#else
239	bool fWin = false;
240	#endif
241	#ifdef RT_OS_SOLARIS
242	bool fSolaris = true;
243	#else
244	bool fSolaris = false;
245	#endif
246	#ifdef RT_OS_DARWIN
247	bool fDarwin = true;
248	#else
249	bool fDarwin = false;
250	#endif
251	#ifdef VBOX_WITH_VRDP
252	bool fVRDP = true;
253	#else
254	bool fVRDP = false;
255	#endif
256
257	if (u64Cmd == USAGE_DUMPOPTS)
258	{
259	fLinux = true;
260	fWin = true;
261	fSolaris = true;
262	fDarwin = true;
263	fVRDP = true;
264	u64Cmd = USAGE_ALL;
265	}
266
267	RTPrintf("Usage:\n"
268	"\n");
269
270	if (u64Cmd == USAGE_ALL)
271	{
272	RTPrintf("VBoxManage [-v\|-version] print version number and exit\n"
273	"VBoxManage -nologo ... suppress the logo\n"
274	"\n"
275	"VBoxManage -convertSettings ... allow to auto-convert settings files\n"
276	"VBoxManage -convertSettingsBackup ... allow to auto-convert settings files\n"
277	" but create backup copies before\n"
278	"VBoxManage -convertSettingsIgnore ... allow to auto-convert settings files\n"
279	" but don't explicitly save the results\n"
280	"\n");
281	}
282
283	if (u64Cmd & USAGE_LIST)
284	{
285	RTPrintf("VBoxManage list vms\|runningvms\|ostypes\|hostdvds\|hostfloppies\|\n"
286	" hostifs\|hostinfo\|hddbackends\|hdds\|dvds\|floppies\|\n"
287	" usbhost\|usbfilters\|systemproperties\n"
288	"\n");
289	}
290
291	if (u64Cmd & USAGE_SHOWVMINFO)
292	{
293	RTPrintf("VBoxManage showvminfo <uuid>\|<name>\n"
294	" [-details]\n"
295	" [-statistics]\n"
296	" [-machinereadable]\n"
297	"\n");
298	}
299
300	if (u64Cmd & USAGE_REGISTERVM)
301	{
302	RTPrintf("VBoxManage registervm <filename>\n"
303	"\n");
304	}
305
306	if (u64Cmd & USAGE_UNREGISTERVM)
307	{
308	RTPrintf("VBoxManage unregistervm <uuid>\|<name>\n"
309	" [-delete]\n"
310	"\n");
311	}
312
313	if (u64Cmd & USAGE_CREATEVM)
314	{
315	RTPrintf("VBoxManage createvm -name <name>\n"
316	" [-ostype <ostype>]\n"
317	" [-register]\n"
318	" [-basefolder <path> \| -settingsfile <path>]\n"
319	" [-uuid <uuid>]\n"
320	"\n");
321	}
322
323	if (u64Cmd & USAGE_IMPORTAPPLIANCE)
324	{
325	RTPrintf("VBoxManage import <ovf>\n"
326	"\n");
327	}
328
329	if (u64Cmd & USAGE_MODIFYVM)
330	{
331	RTPrintf("VBoxManage modifyvm <uuid\|name>\n"
332	" [-name <name>]\n"
333	" [-ostype <ostype>]\n"
334	" [-memory <memorysize in MB>]\n"
335	" [-vram <vramsize in MB>]\n"
336	" [-acpi on\|off]\n"
337	" [-ioapic on\|off]\n"
338	" [-pae on\|off]\n"
339	" [-hwvirtex on\|off\|default]\n"
340	" [-nestedpaging on\|off]\n"
341	" [-vtxvpid on\|off]\n"
342	" [-monitorcount <number>]\n"
343	" [-accelerate3d <on\|off>]\n"
344	" [-bioslogofadein on\|off]\n"
345	" [-bioslogofadeout on\|off]\n"
346	" [-bioslogodisplaytime <msec>]\n"
347	" [-bioslogoimagepath <imagepath>]\n"
348	" [-biosbootmenu disabled\|menuonly\|messageandmenu]\n"
349	" [-biossystemtimeoffset <msec>]\n"
350	" [-biospxedebug on\|off]\n"
351	" [-boot<1-4> none\|floppy\|dvd\|disk\|net>]\n"
352	" [-hd<a\|b\|d> none\|<uuid>\|<filename>]\n"
353	" [-idecontroller PIIX3\|PIIX4]\n"
354	#ifdef VBOX_WITH_AHCI
355	" [-sata on\|off]\n"
356	" [-sataportcount <1-30>]\n"
357	" [-sataport<1-30> none\|<uuid>\|<filename>]\n"
358	" [-sataideemulation<1-4> <1-30>]\n"
359	#endif
360	" [-dvd none\|<uuid>\|<filename>\|host:<drive>]\n"
361	" [-dvdpassthrough on\|off]\n"
362	" [-floppy disabled\|empty\|<uuid>\|\n"
363	" <filename>\|host:<drive>]\n"
364	#ifdef RT_OS_LINUX
365	" [-nic<1-N> none\|null\|nat\|hostif\|intnet\|hostonly]\n"
366	#else /* !RT_OS_LINUX */
367	" [-nic<1-N> none\|null\|nat\|hostif\|intnet]\n"
368	#endif /* !RT_OS_LINUX */
369	" [-nictype<1-N> Am79C970A\|Am79C973"
370	#ifdef VBOX_WITH_E1000
371	"\|82540EM\|82543GC"
372	#endif
373	"]\n"
374	" [-cableconnected<1-N> on\|off]\n"
375	" [-nictrace<1-N> on\|off]\n"
376	" [-nictracefile<1-N> <filename>]\n"
377	" [-nicspeed<1-N> <kbps>]\n"
378	" [-hostifdev<1-N> none\|<devicename>]\n"
379	" [-intnet<1-N> <network name>]\n"
380	" [-natnet<1-N> <network>\|default]\n"
381	" [-macaddress<1-N> auto\|<mac>]\n"
382	" [-uart<1-N> off\|<I/O base> <IRQ>]\n"
383	" [-uartmode<1-N> disconnected\|\n"
384	" server <pipe>\|\n"
385	" client <pipe>\|\n"
386	" <devicename>]\n"
387	#ifdef VBOX_WITH_MEM_BALLOONING
388	" [-guestmemoryballoon <balloonsize in MB>]\n"
389	#endif
390	" [-gueststatisticsinterval <seconds>]\n"
391	);
392	RTPrintf(" [-audio none\|null");
393	if (fWin)
394	{
395	#ifdef VBOX_WITH_WINMM
396	RTPrintf( "\|winmm\|dsound");
397	#else
398	RTPrintf( "\|dsound");
399	#endif
400	}
401	if (fSolaris)
402	{
403	RTPrintf( "\|solaudio");
404	}
405	if (fLinux)
406	{
407	RTPrintf( "\|oss"
408	#ifdef VBOX_WITH_ALSA
409	"\|alsa"
410	#endif
411	#ifdef VBOX_WITH_PULSE
412	"\|pulse"
413	#endif
414	);
415	}
416	if (fDarwin)
417	{
418	RTPrintf( "\|coreaudio");
419	}
420	RTPrintf( "]\n");
421	RTPrintf(" [-audiocontroller ac97\|sb16]\n"
422	" [-clipboard disabled\|hosttoguest\|guesttohost\|\n"
423	" bidirectional]\n");
424	if (fVRDP)
425	{
426	RTPrintf(" [-vrdp on\|off]\n"
427	" [-vrdpport default\|<port>]\n"
428	" [-vrdpaddress <host>]\n"
429	" [-vrdpauthtype null\|external\|guest]\n"
430	" [-vrdpmulticon on\|off]\n"
431	" [-vrdpreusecon on\|off]\n");
432	}
433	RTPrintf(" [-usb on\|off]\n"
434	" [-usbehci on\|off]\n"
435	" [-snapshotfolder default\|<path>]\n");
436	RTPrintf("\n");
437	}
438
439	if (u64Cmd & USAGE_STARTVM)
440	{
441	RTPrintf("VBoxManage startvm <uuid>\|<name>\n");
442	if (fVRDP)
443	RTPrintf(" [-type gui\|vrdp]\n");
444	RTPrintf("\n");
445	}
446
447	if (u64Cmd & USAGE_CONTROLVM)
448	{
449	RTPrintf("VBoxManage controlvm <uuid>\|<name>\n"
450	" pause\|resume\|reset\|poweroff\|savestate\|\n"
451	" acpipowerbutton\|acpisleepbutton\|\n"
452	" keyboardputscancode <hex> [<hex> ...]\|\n"
453	" injectnmi\|\n"
454	" setlinkstate<1-4> on\|off \|\n"
455	" usbattach <uuid>\|<address> \|\n"
456	" usbdetach <uuid>\|<address> \|\n"
457	" dvdattach none\|<uuid>\|<filename>\|host:<drive> \|\n"
458	" floppyattach none\|<uuid>\|<filename>\|host:<drive> \|\n");
459	if (fVRDP)
460	{
461	RTPrintf(" vrdp on\|off] \|\n");
462	}
463	RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]\|\n"
464	" setcredentials <username> <password> <domain>\n"
465	" [-allowlocallogon <yes\|no>]\n"
466	"\n");
467	}
468
469	if (u64Cmd & USAGE_DISCARDSTATE)
470	{
471	RTPrintf("VBoxManage discardstate <uuid>\|<name>\n"
472	"\n");
473	}
474
475	if (u64Cmd & USAGE_ADOPTSTATE)
476	{
477	RTPrintf("VBoxManage adoptstate <uuid>\|<name> <state_file>\n"
478	"\n");
479	}
480
481	if (u64Cmd & USAGE_SNAPSHOT)
482	{
483	RTPrintf("VBoxManage snapshot <uuid>\|<name>\n"
484	" take <name> [-desc <desc>] \|\n"
485	" discard <uuid>\|<name> \|\n"
486	" discardcurrent -state\|-all \|\n"
487	" edit <uuid>\|<name>\|-current\n"
488	" [-newname <name>]\n"
489	" [-newdesc <desc>] \|\n"
490	" showvminfo <uuid>\|<name>\n"
491	"\n");
492	}
493
494	if (u64Cmd & USAGE_REGISTERIMAGE)
495	{
496	RTPrintf("VBoxManage openmedium disk\|dvd\|floppy <filename>\n"
497	" [-type normal\|immutable\|writethrough] (disk only)\n"
498	"\n");
499	}
500
501	if (u64Cmd & USAGE_UNREGISTERIMAGE)
502	{
503	RTPrintf("VBoxManage closemedium disk\|dvd\|floppy <uuid>\|<filename>\n"
504	"\n");
505	}
506
507	if (u64Cmd & USAGE_SHOWHDINFO)
508	{
509	RTPrintf("VBoxManage showhdinfo <uuid>\|<filename>\n"
510	"\n");
511	}
512
513	if (u64Cmd & USAGE_CREATEHD)
514	{
515	/// @todo NEWMEDIA add -format to specify the hard disk backend
516	RTPrintf("VBoxManage createhd -filename <filename>\n"
517	" -size <megabytes>\n"
518	" [-format VDI\|VMDK\|VHD]\n"
519	" [-static]\n"
520	" [-comment <comment>]\n"
521	" [-register]\n"
522	" [-type normal\|writethrough] (default: normal)\n"
523	"\n");
524	}
525
526	if (u64Cmd & USAGE_MODIFYHD)
527	{
528	RTPrintf("VBoxManage modifyhd <uuid>\|<filename>\n"
529	" settype normal\|writethrough\|immutable \|\n"
530	" compact\n"
531	"\n");
532	}
533
534	if (u64Cmd & USAGE_CLONEHD)
535	{
536	RTPrintf("VBoxManage clonehd <uuid>\|<filename> <outputfile>\n"
537	" [-format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
538	" [-remember]\n"
539	"\n");
540	}
541
542	if (u64Cmd & USAGE_CONVERTFROMRAW)
543	{
544	RTPrintf("VBoxManage convertfromraw [-static] [-format VDI\|VMDK\|VHD]\n"
545	" <filename> <outputfile>\n"
546	"VBoxManage convertfromraw [-static] [-format VDI\|VMDK\|VHD]\n"
547	" stdin <outputfile> <bytes>\n"
548	"\n");
549	}
550
551	if (u64Cmd & USAGE_ADDISCSIDISK)
552	{
553	RTPrintf("VBoxManage addiscsidisk -server <name>\|<ip>\n"
554	" -target <target>\n"
555	" [-port <port>]\n"
556	" [-lun <lun>]\n"
557	" [-encodedlun <lun>]\n"
558	" [-username <username>]\n"
559	" [-password <password>]\n"
560	" [-comment <comment>]\n"
561	" [-intnet]\n"
562	"\n");
563	}
564
565	if (u64Cmd & USAGE_GETEXTRADATA)
566	{
567	RTPrintf("VBoxManage getextradata global\|<uuid>\|<name>\n"
568	" <key>\|enumerate\n"
569	"\n");
570	}
571
572	if (u64Cmd & USAGE_SETEXTRADATA)
573	{
574	RTPrintf("VBoxManage setextradata global\|<uuid>\|<name>\n"
575	" <key>\n"
576	" [<value>] (no value deletes key)\n"
577	"\n");
578	}
579
580	if (u64Cmd & USAGE_SETPROPERTY)
581	{
582	RTPrintf("VBoxManage setproperty hdfolder default\|<folder> \|\n"
583	" machinefolder default\|<folder> \|\n"
584	" vrdpauthlibrary default\|<library> \|\n"
585	" websrvauthlibrary default\|null\|<library> \|\n"
586	" hwvirtexenabled yes\|no\n"
587	" loghistorycount <value>\n"
588	"\n");
589	}
590
591	if (u64Cmd & USAGE_USBFILTER_ADD)
592	{
593	RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
594	" -target <uuid>\|<name>\|global\n"
595	" -name <string>\n"
596	" -action ignore\|hold (global filters only)\n"
597	" [-active yes\|no] (yes)\n"
598	" [-vendorid <XXXX>] (null)\n"
599	" [-productid <XXXX>] (null)\n"
600	" [-revision <IIFF>] (null)\n"
601	" [-manufacturer <string>] (null)\n"
602	" [-product <string>] (null)\n"
603	" [-remote yes\|no] (null, VM filters only)\n"
604	" [-serialnumber <string>] (null)\n"
605	" [-maskedinterfaces <XXXXXXXX>]\n"
606	"\n");
607	}
608
609	if (u64Cmd & USAGE_USBFILTER_MODIFY)
610	{
611	RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
612	" -target <uuid>\|<name>\|global\n"
613	" [-name <string>]\n"
614	" [-action ignore\|hold] (global filters only)\n"
615	" [-active yes\|no]\n"
616	" [-vendorid <XXXX>\|\"\"]\n"
617	" [-productid <XXXX>\|\"\"]\n"
618	" [-revision <IIFF>\|\"\"]\n"
619	" [-manufacturer <string>\|\"\"]\n"
620	" [-product <string>\|\"\"]\n"
621	" [-remote yes\|no] (null, VM filters only)\n"
622	" [-serialnumber <string>\|\"\"]\n"
623	" [-maskedinterfaces <XXXXXXXX>]\n"
624	"\n");
625	}
626
627	if (u64Cmd & USAGE_USBFILTER_REMOVE)
628	{
629	RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
630	" -target <uuid>\|<name>\|global\n"
631	"\n");
632	}
633
634	if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
635	{
636	RTPrintf("VBoxManage sharedfolder add <vmname>\|<uuid>\n"
637	" -name <name> -hostpath <hostpath>\n"
638	" [-transient] [-readonly]\n"
639	"\n");
640	}
641
642	if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
643	{
644	RTPrintf("VBoxManage sharedfolder remove <vmname>\|<uuid>\n"
645	" -name <name> [-transient]\n"
646	"\n");
647	}
648
649	if (u64Cmd & USAGE_VM_STATISTICS)
650	{
651	RTPrintf("VBoxManage vmstatistics <vmname>\|<uuid> [-reset]\n"
652	" [-pattern <pattern>] [-descriptions]\n"
653	"\n");
654	}
655
656	#ifdef VBOX_WITH_GUEST_PROPS
657	if (u64Cmd & USAGE_GUESTPROPERTY)
658	usageGuestProperty();
659	#endif /* VBOX_WITH_GUEST_PROPS defined */
660
661	if (u64Cmd & USAGE_METRICS)
662	{
663	RTPrintf("VBoxManage metrics list [*\|host\|<vmname> [<metric_list>]] (comma-separated)\n\n"
664	"VBoxManage metrics setup\n"
665	" [-period <seconds>]\n"
666	" [-samples <count>]\n"
667	" [-list]\n"
668	" [*\|host\|<vmname> [<metric_list>]]\n\n"
669	"VBoxManage metrics query [*\|host\|<vmname> [<metric_list>]]\n\n"
670	"VBoxManage metrics collect\n"
671	" [-period <seconds>]\n"
672	" [-samples <count>]\n"
673	" [-list]\n"
674	" [-detach]\n"
675	" [*\|host\|<vmname> [<metric_list>]]\n"
676	"\n");
677	}
678
679	}
680
681	/**
682	* Print a usage synopsis and the syntax error message.
683	*/
684	int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
685	{
686	va_list args;
687	showLogo(); // show logo even if suppressed
688	#ifndef VBOX_ONLY_DOCS
689	if (g_fInternalMode)
690	printUsageInternal(u64Cmd);
691	else
692	printUsage(u64Cmd);
693	#endif /* !VBOX_ONLY_DOCS */
694	va_start(args, pszFormat);
695	RTPrintf("\n"
696	"Syntax error: %N\n", pszFormat, &args);
697	va_end(args);
698	return 1;
699	}
700
701	/**
702	* Print an error message without the syntax stuff.
703	*/
704	int errorArgument(const char *pszFormat, ...)
705	{
706	va_list args;
707	va_start(args, pszFormat);
708	RTPrintf("error: %N\n", pszFormat, &args);
709	va_end(args);
710	return 1;
711	}
712
713	#ifndef VBOX_ONLY_DOCS
714	/**
715	* Print out progress on the console
716	*/
717	void showProgress(ComPtr<IProgress> progress)
718	{
719	BOOL fCompleted;
720	LONG currentPercent;
721	LONG lastPercent = 0;
722
723	RTPrintf("0%%...");
724	RTStrmFlush(g_pStdOut);
725	while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))
726	{
727	progress->COMGETTER(Percent(&currentPercent));
728
729	/* did we cross a 10% mark? */
730	if (((currentPercent / 10) > (lastPercent / 10)))
731	{
732	/* make sure to also print out missed steps */
733	for (LONG curVal = (lastPercent / 10) * 10 + 10; curVal <= (currentPercent / 10) * 10; curVal += 10)
734	{
735	if (curVal < 100)
736	{
737	RTPrintf("%ld%%...", curVal);
738	RTStrmFlush(g_pStdOut);
739	}
740	}
741	lastPercent = (currentPercent / 10) * 10;
742	}
743	if (fCompleted)
744	break;
745
746	/* make sure the loop is not too tight */
747	progress->WaitForCompletion(100);
748	}
749
750	/* complete the line. */
751	HRESULT rc;
752	if (SUCCEEDED(progress->COMGETTER(ResultCode)(&rc)))
753	{
754	if (SUCCEEDED(rc))
755	RTPrintf("100%%\n");
756	else
757	RTPrintf("FAILED\n");
758	}
759	else
760	RTPrintf("\n");
761	RTStrmFlush(g_pStdOut);
762	}
763
764	static int handleRegisterVM(HandlerArg *a)
765	{
766	HRESULT rc;
767
768	if (a->argc != 1)
769	return errorSyntax(USAGE_REGISTERVM, "Incorrect number of parameters");
770
771	ComPtr<IMachine> machine;
772	CHECK_ERROR(a->virtualBox, OpenMachine(Bstr(a->argv[0]), machine.asOutParam()));
773	if (SUCCEEDED(rc))
774	{
775	ASSERT(machine);
776	CHECK_ERROR(a->virtualBox, RegisterMachine(machine));
777	}
778	return SUCCEEDED(rc) ? 0 : 1;
779	}
780
781	static int handleUnregisterVM(HandlerArg *a)
782	{
783	HRESULT rc;
784
785	if ((a->argc != 1) && (a->argc != 2))
786	return errorSyntax(USAGE_UNREGISTERVM, "Incorrect number of parameters");
787
788	ComPtr<IMachine> machine;
789	/* assume it's a UUID */
790	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
791	if (FAILED(rc) \|\| !machine)
792	{
793	/* must be a name */
794	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
795	}
796	if (machine)
797	{
798	Guid uuid;
799	machine->COMGETTER(Id)(uuid.asOutParam());
800	machine = NULL;
801	CHECK_ERROR(a->virtualBox, UnregisterMachine(uuid, machine.asOutParam()));
802	if (SUCCEEDED(rc) && machine)
803	{
804	/* are we supposed to delete the config file? */
805	if ((a->argc == 2) && (strcmp(a->argv[1], "-delete") == 0))
806	{
807	CHECK_ERROR(machine, DeleteSettings());
808	}
809	}
810	}
811	return SUCCEEDED(rc) ? 0 : 1;
812	}
813
814	static int handleCreateVM(HandlerArg *a)
815	{
816	HRESULT rc;
817	Bstr baseFolder;
818	Bstr settingsFile;
819	Bstr name;
820	Bstr osTypeId;
821	RTUUID id;
822	bool fRegister = false;
823
824	RTUuidClear(&id);
825	for (int i = 0; i < a->argc; i++)
826	{
827	if (strcmp(a->argv[i], "-basefolder") == 0)
828	{
829	if (a->argc <= i + 1)
830	return errorArgument("Missing argument to '%s'", a->argv[i]);
831	i++;
832	baseFolder = a->argv[i];
833	}
834	else if (strcmp(a->argv[i], "-settingsfile") == 0)
835	{
836	if (a->argc <= i + 1)
837	return errorArgument("Missing argument to '%s'", a->argv[i]);
838	i++;
839	settingsFile = a->argv[i];
840	}
841	else if (strcmp(a->argv[i], "-name") == 0)
842	{
843	if (a->argc <= i + 1)
844	return errorArgument("Missing argument to '%s'", a->argv[i]);
845	i++;
846	name = a->argv[i];
847	}
848	else if (strcmp(a->argv[i], "-ostype") == 0)
849	{
850	if (a->argc <= i + 1)
851	return errorArgument("Missing argument to '%s'", a->argv[i]);
852	i++;
853	osTypeId = a->argv[i];
854	}
855	else if (strcmp(a->argv[i], "-uuid") == 0)
856	{
857	if (a->argc <= i + 1)
858	return errorArgument("Missing argument to '%s'", a->argv[i]);
859	i++;
860	if (RT_FAILURE(RTUuidFromStr(&id, a->argv[i])))
861	return errorArgument("Invalid UUID format %s\n", a->argv[i]);
862	}
863	else if (strcmp(a->argv[i], "-register") == 0)
864	{
865	fRegister = true;
866	}
867	else
868	return errorSyntax(USAGE_CREATEVM, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
869	}
870	if (!name)
871	return errorSyntax(USAGE_CREATEVM, "Parameter -name is required");
872
873	if (!!baseFolder && !!settingsFile)
874	return errorSyntax(USAGE_CREATEVM, "Either -basefolder or -settingsfile must be specified");
875
876	do
877	{
878	ComPtr<IMachine> machine;
879
880	if (!settingsFile)
881	CHECK_ERROR_BREAK(a->virtualBox,
882	CreateMachine(name, osTypeId, baseFolder, Guid(id), machine.asOutParam()));
883	else
884	CHECK_ERROR_BREAK(a->virtualBox,
885	CreateLegacyMachine(name, osTypeId, settingsFile, Guid(id), machine.asOutParam()));
886
887	CHECK_ERROR_BREAK(machine, SaveSettings());
888	if (fRegister)
889	{
890	CHECK_ERROR_BREAK(a->virtualBox, RegisterMachine(machine));
891	}
892	Guid uuid;
893	CHECK_ERROR_BREAK(machine, COMGETTER(Id)(uuid.asOutParam()));
894	CHECK_ERROR_BREAK(machine, COMGETTER(SettingsFilePath)(settingsFile.asOutParam()));
895	RTPrintf("Virtual machine '%ls' is created%s.\n"
896	"UUID: %s\n"
897	"Settings file: '%ls'\n",
898	name.raw(), fRegister ? " and registered" : "",
899	uuid.toString().raw(), settingsFile.raw());
900	}
901	while (0);
902
903	return SUCCEEDED(rc) ? 0 : 1;
904	}
905
906	/**
907	* Parses a number.
908	*
909	* @returns Valid number on success.
910	* @returns 0 if invalid number. All necesary bitching has been done.
911	* @param psz Pointer to the nic number.
912	*/
913	unsigned parseNum(const char psz, unsigned cMaxNum, const char name)
914	{
915	uint32_t u32;
916	char *pszNext;
917	int rc = RTStrToUInt32Ex(psz, &pszNext, 10, &u32);
918	if ( RT_SUCCESS(rc)
919	&& *pszNext == '\0'
920	&& u32 >= 1
921	&& u32 <= cMaxNum)
922	return (unsigned)u32;
923	errorArgument("Invalid %s number '%s'", name, psz);
924	return 0;
925	}
926
927
928	/** @todo refine this after HDD changes; MSC 8.0/64 has trouble with handleModifyVM. */
929	#if defined(_MSC_VER)
930	# pragma optimize("", on)
931	#endif
932
933	static int handleStartVM(HandlerArg *a)
934	{
935	HRESULT rc;
936
937	if (a->argc < 1)
938	return errorSyntax(USAGE_STARTVM, "Not enough parameters");
939
940	ComPtr<IMachine> machine;
941	/* assume it's a UUID */
942	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
943	if (FAILED(rc) \|\| !machine)
944	{
945	/* must be a name */
946	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
947	}
948	if (machine)
949	{
950	Guid uuid;
951	machine->COMGETTER(Id)(uuid.asOutParam());
952
953	/* default to GUI session type */
954	Bstr sessionType = "gui";
955	/* has a session type been specified? */
956	if ((a->argc > 2) && (strcmp(a->argv[1], "-type") == 0))
957	{
958	if (strcmp(a->argv[2], "gui") == 0)
959	{
960	sessionType = "gui";
961	}
962	else if (strcmp(a->argv[2], "vrdp") == 0)
963	{
964	sessionType = "vrdp";
965	}
966	else if (strcmp(a->argv[2], "capture") == 0)
967	{
968	sessionType = "capture";
969	}
970	else
971	return errorArgument("Invalid session type argument '%s'", a->argv[2]);
972	}
973
974	Bstr env;
975	#ifdef RT_OS_LINUX
976	/* make sure the VM process will start on the same display as VBoxManage */
977	{
978	const char *display = RTEnvGet ("DISPLAY");
979	if (display)
980	env = Utf8StrFmt ("DISPLAY=%s", display);
981	}
982	#endif
983	ComPtr<IProgress> progress;
984	CHECK_ERROR_RET(a->virtualBox, OpenRemoteSession(a->session, uuid, sessionType,
985	env, progress.asOutParam()), rc);
986	RTPrintf("Waiting for the remote session to open...\n");
987	CHECK_ERROR_RET(progress, WaitForCompletion (-1), 1);
988
989	BOOL completed;
990	CHECK_ERROR_RET(progress, COMGETTER(Completed)(&completed), rc);
991	ASSERT(completed);
992
993	HRESULT resultCode;
994	CHECK_ERROR_RET(progress, COMGETTER(ResultCode)(&resultCode), rc);
995	if (FAILED(resultCode))
996	{
997	ComPtr <IVirtualBoxErrorInfo> errorInfo;
998	CHECK_ERROR_RET(progress, COMGETTER(ErrorInfo)(errorInfo.asOutParam()), 1);
999	ErrorInfo info (errorInfo);
1000	GluePrintErrorInfo(info);
1001	}
1002	else
1003	{
1004	RTPrintf("Remote session has been successfully opened.\n");
1005	}
1006	}
1007
1008	/* it's important to always close sessions */
1009	a->session->Close();
1010
1011	return SUCCEEDED(rc) ? 0 : 1;
1012	}
1013
1014	static int handleControlVM(HandlerArg *a)
1015	{
1016	HRESULT rc;
1017
1018	if (a->argc < 2)
1019	return errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
1020
1021	/* try to find the given machine */
1022	ComPtr <IMachine> machine;
1023	Guid uuid (a->argv[0]);
1024	if (!uuid.isEmpty())
1025	{
1026	CHECK_ERROR (a->virtualBox, GetMachine (uuid, machine.asOutParam()));
1027	}
1028	else
1029	{
1030	CHECK_ERROR (a->virtualBox, FindMachine (Bstr(a->argv[0]), machine.asOutParam()));
1031	if (SUCCEEDED (rc))
1032	machine->COMGETTER(Id) (uuid.asOutParam());
1033	}
1034	if (FAILED (rc))
1035	return 1;
1036
1037	/* open a session for the VM */
1038	CHECK_ERROR_RET (a->virtualBox, OpenExistingSession (a->session, uuid), 1);
1039
1040	do
1041	{
1042	/* get the associated console */
1043	ComPtr<IConsole> console;
1044	CHECK_ERROR_BREAK (a->session, COMGETTER(Console)(console.asOutParam()));
1045	/* ... and session machine */
1046	ComPtr<IMachine> sessionMachine;
1047	CHECK_ERROR_BREAK (a->session, COMGETTER(Machine)(sessionMachine.asOutParam()));
1048
1049	/* which command? */
1050	if (strcmp(a->argv[1], "pause") == 0)
1051	{
1052	CHECK_ERROR_BREAK (console, Pause());
1053	}
1054	else if (strcmp(a->argv[1], "resume") == 0)
1055	{
1056	CHECK_ERROR_BREAK (console, Resume());
1057	}
1058	else if (strcmp(a->argv[1], "reset") == 0)
1059	{
1060	CHECK_ERROR_BREAK (console, Reset());
1061	}
1062	else if (strcmp(a->argv[1], "poweroff") == 0)
1063	{
1064	CHECK_ERROR_BREAK (console, PowerDown());
1065	}
1066	else if (strcmp(a->argv[1], "savestate") == 0)
1067	{
1068	ComPtr<IProgress> progress;
1069	CHECK_ERROR_BREAK (console, SaveState(progress.asOutParam()));
1070
1071	showProgress(progress);
1072
1073	progress->COMGETTER(ResultCode)(&rc);
1074	if (FAILED(rc))
1075	{
1076	com::ProgressErrorInfo info(progress);
1077	if (info.isBasicAvailable())
1078	{
1079	RTPrintf("Error: failed to save machine state. Error message: %lS\n", info.getText().raw());
1080	}
1081	else
1082	{
1083	RTPrintf("Error: failed to save machine state. No error message available!\n");
1084	}
1085	}
1086	}
1087	else if (strcmp(a->argv[1], "acpipowerbutton") == 0)
1088	{
1089	CHECK_ERROR_BREAK (console, PowerButton());
1090	}
1091	else if (strcmp(a->argv[1], "acpisleepbutton") == 0)
1092	{
1093	CHECK_ERROR_BREAK (console, SleepButton());
1094	}
1095	else if (strcmp(a->argv[1], "injectnmi") == 0)
1096	{
1097	/* get the machine debugger. */
1098	ComPtr <IMachineDebugger> debugger;
1099	CHECK_ERROR_BREAK(console, COMGETTER(Debugger)(debugger.asOutParam()));
1100	CHECK_ERROR_BREAK(debugger, InjectNMI());
1101	}
1102	else if (strcmp(a->argv[1], "keyboardputscancode") == 0)
1103	{
1104	ComPtr<IKeyboard> keyboard;
1105	CHECK_ERROR_BREAK(console, COMGETTER(Keyboard)(keyboard.asOutParam()));
1106
1107	if (a->argc <= 1 + 1)
1108	{
1109	errorArgument("Missing argument to '%s'. Expected IBM PC AT set 2 keyboard scancode(s) as hex byte(s).", a->argv[1]);
1110	rc = E_FAIL;
1111	break;
1112	}
1113
1114	/* Arbitrary restrict the length of a sequence of scancodes to 1024. */
1115	LONG alScancodes[1024];
1116	int cScancodes = 0;
1117
1118	/* Process the command line. */
1119	int i;
1120	for (i = 1 + 1; i < a->argc && cScancodes < (int)RT_ELEMENTS(alScancodes); i++, cScancodes++)
1121	{
1122	if ( RT_C_IS_XDIGIT (a->argv[i][0])
1123	&& RT_C_IS_XDIGIT (a->argv[i][1])
1124	&& a->argv[i][2] == 0)
1125	{
1126	uint8_t u8Scancode;
1127	int rc = RTStrToUInt8Ex(a->argv[i], NULL, 16, &u8Scancode);
1128	if (RT_FAILURE (rc))
1129	{
1130	RTPrintf("Error: converting '%s' returned %Rrc!\n", a->argv[i], rc);
1131	rc = E_FAIL;
1132	break;
1133	}
1134
1135	alScancodes[cScancodes] = u8Scancode;
1136	}
1137	else
1138	{
1139	RTPrintf("Error: '%s' is not a hex byte!\n", a->argv[i]);
1140	rc = E_FAIL;
1141	break;
1142	}
1143	}
1144
1145	if (FAILED(rc))
1146	break;
1147
1148	if ( cScancodes == RT_ELEMENTS(alScancodes)
1149	&& i < a->argc)
1150	{
1151	RTPrintf("Error: too many scancodes, maximum %d allowed!\n", RT_ELEMENTS(alScancodes));
1152	rc = E_FAIL;
1153	break;
1154	}
1155
1156	/* Send scancodes to the VM.
1157	* Note: 'PutScancodes' did not work here. Only the first scancode was transmitted.
1158	*/
1159	for (i = 0; i < cScancodes; i++)
1160	{
1161	CHECK_ERROR_BREAK(keyboard, PutScancode(alScancodes[i]));
1162	RTPrintf("Scancode[%d]: 0x%02X\n", i, alScancodes[i]);
1163	}
1164	}
1165	else if (strncmp(a->argv[1], "setlinkstate", 12) == 0)
1166	{
1167	/* Get the number of network adapters */
1168	ULONG NetworkAdapterCount = 0;
1169	ComPtr <ISystemProperties> info;
1170	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
1171	CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
1172
1173	unsigned n = parseNum(&a->argv[1][12], NetworkAdapterCount, "NIC");
1174	if (!n)
1175	{
1176	rc = E_FAIL;
1177	break;
1178	}
1179	if (a->argc <= 1 + 1)
1180	{
1181	errorArgument("Missing argument to '%s'", a->argv[1]);
1182	rc = E_FAIL;
1183	break;
1184	}
1185	/* get the corresponding network adapter */
1186	ComPtr<INetworkAdapter> adapter;
1187	CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
1188	if (adapter)
1189	{
1190	if (strcmp(a->argv[2], "on") == 0)
1191	{
1192	CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(TRUE));
1193	}
1194	else if (strcmp(a->argv[2], "off") == 0)
1195	{
1196	CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(FALSE));
1197	}
1198	else
1199	{
1200	errorArgument("Invalid link state '%s'", Utf8Str(a->argv[2]).raw());
1201	rc = E_FAIL;
1202	break;
1203	}
1204	}
1205	}
1206	#ifdef VBOX_WITH_VRDP
1207	else if (strcmp(a->argv[1], "vrdp") == 0)
1208	{
1209	if (a->argc <= 1 + 1)
1210	{
1211	errorArgument("Missing argument to '%s'", a->argv[1]);
1212	rc = E_FAIL;
1213	break;
1214	}
1215	/* get the corresponding VRDP server */
1216	ComPtr<IVRDPServer> vrdpServer;
1217	sessionMachine->COMGETTER(VRDPServer)(vrdpServer.asOutParam());
1218	ASSERT(vrdpServer);
1219	if (vrdpServer)
1220	{
1221	if (strcmp(a->argv[2], "on") == 0)
1222	{
1223	CHECK_ERROR_BREAK (vrdpServer, COMSETTER(Enabled)(TRUE));
1224	}
1225	else if (strcmp(a->argv[2], "off") == 0)
1226	{
1227	CHECK_ERROR_BREAK (vrdpServer, COMSETTER(Enabled)(FALSE));
1228	}
1229	else
1230	{
1231	errorArgument("Invalid vrdp server state '%s'", Utf8Str(a->argv[2]).raw());
1232	rc = E_FAIL;
1233	break;
1234	}
1235	}
1236	}
1237	#endif /* VBOX_WITH_VRDP */
1238	else if (strcmp (a->argv[1], "usbattach") == 0 \|\|
1239	strcmp (a->argv[1], "usbdetach") == 0)
1240	{
1241	if (a->argc < 3)
1242	{
1243	errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
1244	rc = E_FAIL;
1245	break;
1246	}
1247
1248	bool attach = strcmp (a->argv[1], "usbattach") == 0;
1249
1250	Guid usbId = a->argv [2];
1251	if (usbId.isEmpty())
1252	{
1253	// assume address
1254	if (attach)
1255	{
1256	ComPtr <IHost> host;
1257	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(Host) (host.asOutParam()));
1258	ComPtr <IHostUSBDeviceCollection> coll;
1259	CHECK_ERROR_BREAK (host, COMGETTER(USBDevices) (coll.asOutParam()));
1260	ComPtr <IHostUSBDevice> dev;
1261	CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (a->argv [2]), dev.asOutParam()));
1262	CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
1263	}
1264	else
1265	{
1266	ComPtr <IUSBDeviceCollection> coll;
1267	CHECK_ERROR_BREAK (console, COMGETTER(USBDevices)(coll.asOutParam()));
1268	ComPtr <IUSBDevice> dev;
1269	CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (a->argv [2]), dev.asOutParam()));
1270	CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
1271	}
1272	}
1273
1274	if (attach)
1275	CHECK_ERROR_BREAK (console, AttachUSBDevice (usbId));
1276	else
1277	{
1278	ComPtr <IUSBDevice> dev;
1279	CHECK_ERROR_BREAK (console, DetachUSBDevice (usbId, dev.asOutParam()));
1280	}
1281	}
1282	else if (strcmp(a->argv[1], "setvideomodehint") == 0)
1283	{
1284	if (a->argc != 5 && a->argc != 6)
1285	{
1286	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1287	rc = E_FAIL;
1288	break;
1289	}
1290	uint32_t xres = RTStrToUInt32(a->argv[2]);
1291	uint32_t yres = RTStrToUInt32(a->argv[3]);
1292	uint32_t bpp = RTStrToUInt32(a->argv[4]);
1293	uint32_t displayIdx = 0;
1294	if (a->argc == 6)
1295	displayIdx = RTStrToUInt32(a->argv[5]);
1296
1297	ComPtr<IDisplay> display;
1298	CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam()));
1299	CHECK_ERROR_BREAK(display, SetVideoModeHint(xres, yres, bpp, displayIdx));
1300	}
1301	else if (strcmp(a->argv[1], "setcredentials") == 0)
1302	{
1303	bool fAllowLocalLogon = true;
1304	if (a->argc == 7)
1305	{
1306	if (strcmp(a->argv[5], "-allowlocallogon") != 0)
1307	{
1308	errorArgument("Invalid parameter '%s'", a->argv[5]);
1309	rc = E_FAIL;
1310	break;
1311	}
1312	if (strcmp(a->argv[6], "no") == 0)
1313	fAllowLocalLogon = false;
1314	}
1315	else if (a->argc != 5)
1316	{
1317	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1318	rc = E_FAIL;
1319	break;
1320	}
1321
1322	ComPtr<IGuest> guest;
1323	CHECK_ERROR_BREAK(console, COMGETTER(Guest)(guest.asOutParam()));
1324	CHECK_ERROR_BREAK(guest, SetCredentials(Bstr(a->argv[2]), Bstr(a->argv[3]), Bstr(a->argv[4]), fAllowLocalLogon));
1325	}
1326	else if (strcmp(a->argv[1], "dvdattach") == 0)
1327	{
1328	if (a->argc != 3)
1329	{
1330	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1331	rc = E_FAIL;
1332	break;
1333	}
1334	ComPtr<IDVDDrive> dvdDrive;
1335	sessionMachine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
1336	ASSERT(dvdDrive);
1337
1338	/* unmount? */
1339	if (strcmp(a->argv[2], "none") == 0)
1340	{
1341	CHECK_ERROR(dvdDrive, Unmount());
1342	}
1343	/* host drive? */
1344	else if (strncmp(a->argv[2], "host:", 5) == 0)
1345	{
1346	ComPtr<IHost> host;
1347	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
1348	ComPtr<IHostDVDDriveCollection> hostDVDs;
1349	CHECK_ERROR(host, COMGETTER(DVDDrives)(hostDVDs.asOutParam()));
1350	ComPtr<IHostDVDDrive> hostDVDDrive;
1351	rc = hostDVDs->FindByName(Bstr(a->argv[2] + 5), hostDVDDrive.asOutParam());
1352	if (!hostDVDDrive)
1353	{
1354	errorArgument("Invalid host DVD drive name");
1355	rc = E_FAIL;
1356	break;
1357	}
1358	CHECK_ERROR(dvdDrive, CaptureHostDrive(hostDVDDrive));
1359	}
1360	else
1361	{
1362	/* first assume it's a UUID */
1363	Guid uuid(a->argv[2]);
1364	ComPtr<IDVDImage2> dvdImage;
1365	rc = a->virtualBox->GetDVDImage(uuid, dvdImage.asOutParam());
1366	if (FAILED(rc) \|\| !dvdImage)
1367	{
1368	/* must be a filename, check if it's in the collection */
1369	rc = a->virtualBox->FindDVDImage(Bstr(a->argv[2]), dvdImage.asOutParam());
1370	/* not registered, do that on the fly */
1371	if (!dvdImage)
1372	{
1373	Guid emptyUUID;
1374	CHECK_ERROR(a->virtualBox, OpenDVDImage(Bstr(a->argv[2]), emptyUUID, dvdImage.asOutParam()));
1375	}
1376	}
1377	if (!dvdImage)
1378	{
1379	rc = E_FAIL;
1380	break;
1381	}
1382	dvdImage->COMGETTER(Id)(uuid.asOutParam());
1383	CHECK_ERROR(dvdDrive, MountImage(uuid));
1384	}
1385	}
1386	else if (strcmp(a->argv[1], "floppyattach") == 0)
1387	{
1388	if (a->argc != 3)
1389	{
1390	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1391	rc = E_FAIL;
1392	break;
1393	}
1394
1395	ComPtr<IFloppyDrive> floppyDrive;
1396	sessionMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
1397	ASSERT(floppyDrive);
1398
1399	/* unmount? */
1400	if (strcmp(a->argv[2], "none") == 0)
1401	{
1402	CHECK_ERROR(floppyDrive, Unmount());
1403	}
1404	/* host drive? */
1405	else if (strncmp(a->argv[2], "host:", 5) == 0)
1406	{
1407	ComPtr<IHost> host;
1408	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
1409	ComPtr<IHostFloppyDriveCollection> hostFloppies;
1410	CHECK_ERROR(host, COMGETTER(FloppyDrives)(hostFloppies.asOutParam()));
1411	ComPtr<IHostFloppyDrive> hostFloppyDrive;
1412	rc = hostFloppies->FindByName(Bstr(a->argv[2] + 5), hostFloppyDrive.asOutParam());
1413	if (!hostFloppyDrive)
1414	{
1415	errorArgument("Invalid host floppy drive name");
1416	rc = E_FAIL;
1417	break;
1418	}
1419	CHECK_ERROR(floppyDrive, CaptureHostDrive(hostFloppyDrive));
1420	}
1421	else
1422	{
1423	/* first assume it's a UUID */
1424	Guid uuid(a->argv[2]);
1425	ComPtr<IFloppyImage2> floppyImage;
1426	rc = a->virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam());
1427	if (FAILED(rc) \|\| !floppyImage)
1428	{
1429	/* must be a filename, check if it's in the collection */
1430	rc = a->virtualBox->FindFloppyImage(Bstr(a->argv[2]), floppyImage.asOutParam());
1431	/* not registered, do that on the fly */
1432	if (!floppyImage)
1433	{
1434	Guid emptyUUID;
1435	CHECK_ERROR(a->virtualBox, OpenFloppyImage(Bstr(a->argv[2]), emptyUUID, floppyImage.asOutParam()));
1436	}
1437	}
1438	if (!floppyImage)
1439	{
1440	rc = E_FAIL;
1441	break;
1442	}
1443	floppyImage->COMGETTER(Id)(uuid.asOutParam());
1444	CHECK_ERROR(floppyDrive, MountImage(uuid));
1445	}
1446	}
1447	#ifdef VBOX_WITH_MEM_BALLOONING
1448	else if (strncmp(a->argv[1], "-guestmemoryballoon", 19) == 0)
1449	{
1450	if (a->argc != 3)
1451	{
1452	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1453	rc = E_FAIL;
1454	break;
1455	}
1456	uint32_t uVal;
1457	int vrc;
1458	vrc = RTStrToUInt32Ex(a->argv[2], NULL, 0, &uVal);
1459	if (vrc != VINF_SUCCESS)
1460	{
1461	errorArgument("Error parsing guest memory balloon size '%s'", a->argv[2]);
1462	rc = E_FAIL;
1463	break;
1464	}
1465
1466	/* guest is running; update IGuest */
1467	ComPtr <IGuest> guest;
1468
1469	rc = console->COMGETTER(Guest)(guest.asOutParam());
1470	if (SUCCEEDED(rc))
1471	CHECK_ERROR(guest, COMSETTER(MemoryBalloonSize)(uVal));
1472	}
1473	#endif
1474	else if (strncmp(a->argv[1], "-gueststatisticsinterval", 24) == 0)
1475	{
1476	if (a->argc != 3)
1477	{
1478	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1479	rc = E_FAIL;
1480	break;
1481	}
1482	uint32_t uVal;
1483	int vrc;
1484	vrc = RTStrToUInt32Ex(a->argv[2], NULL, 0, &uVal);
1485	if (vrc != VINF_SUCCESS)
1486	{
1487	errorArgument("Error parsing guest statistics interval '%s'", a->argv[2]);
1488	rc = E_FAIL;
1489	break;
1490	}
1491
1492	/* guest is running; update IGuest */
1493	ComPtr <IGuest> guest;
1494
1495	rc = console->COMGETTER(Guest)(guest.asOutParam());
1496	if (SUCCEEDED(rc))
1497	CHECK_ERROR(guest, COMSETTER(StatisticsUpdateInterval)(uVal));
1498	}
1499	else
1500	{
1501	errorSyntax(USAGE_CONTROLVM, "Invalid parameter '%s'", Utf8Str(a->argv[1]).raw());
1502	rc = E_FAIL;
1503	}
1504	}
1505	while (0);
1506
1507	a->session->Close();
1508
1509	return SUCCEEDED (rc) ? 0 : 1;
1510	}
1511
1512	static int handleDiscardState(HandlerArg *a)
1513	{
1514	HRESULT rc;
1515
1516	if (a->argc != 1)
1517	return errorSyntax(USAGE_DISCARDSTATE, "Incorrect number of parameters");
1518
1519	ComPtr<IMachine> machine;
1520	/* assume it's a UUID */
1521	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
1522	if (FAILED(rc) \|\| !machine)
1523	{
1524	/* must be a name */
1525	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1526	}
1527	if (machine)
1528	{
1529	do
1530	{
1531	/* we have to open a session for this task */
1532	Guid guid;
1533	machine->COMGETTER(Id)(guid.asOutParam());
1534	CHECK_ERROR_BREAK(a->virtualBox, OpenSession(a->session, guid));
1535	do
1536	{
1537	ComPtr<IConsole> console;
1538	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
1539	CHECK_ERROR_BREAK(console, DiscardSavedState());
1540	}
1541	while (0);
1542	CHECK_ERROR_BREAK(a->session, Close());
1543	}
1544	while (0);
1545	}
1546
1547	return SUCCEEDED(rc) ? 0 : 1;
1548	}
1549
1550	static int handleAdoptdState(HandlerArg *a)
1551	{
1552	HRESULT rc;
1553
1554	if (a->argc != 2)
1555	return errorSyntax(USAGE_ADOPTSTATE, "Incorrect number of parameters");
1556
1557	ComPtr<IMachine> machine;
1558	/* assume it's a UUID */
1559	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
1560	if (FAILED(rc) \|\| !machine)
1561	{
1562	/* must be a name */
1563	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1564	}
1565	if (machine)
1566	{
1567	do
1568	{
1569	/* we have to open a session for this task */
1570	Guid guid;
1571	machine->COMGETTER(Id)(guid.asOutParam());
1572	CHECK_ERROR_BREAK(a->virtualBox, OpenSession(a->session, guid));
1573	do
1574	{
1575	ComPtr<IConsole> console;
1576	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
1577	CHECK_ERROR_BREAK(console, AdoptSavedState (Bstr (a->argv[1])));
1578	}
1579	while (0);
1580	CHECK_ERROR_BREAK(a->session, Close());
1581	}
1582	while (0);
1583	}
1584
1585	return SUCCEEDED(rc) ? 0 : 1;
1586	}
1587
1588	static int handleSnapshot(HandlerArg *a)
1589	{
1590	HRESULT rc;
1591
1592	/* we need at least a VM and a command */
1593	if (a->argc < 2)
1594	return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters");
1595
1596	/* the first argument must be the VM */
1597	ComPtr<IMachine> machine;
1598	/* assume it's a UUID */
1599	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
1600	if (FAILED(rc) \|\| !machine)
1601	{
1602	/* must be a name */
1603	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1604	}
1605	if (!machine)
1606	return 1;
1607	Guid guid;
1608	machine->COMGETTER(Id)(guid.asOutParam());
1609
1610	do
1611	{
1612	/* we have to open a session for this task. First try an existing session */
1613	rc = a->virtualBox->OpenExistingSession(a->session, guid);
1614	if (FAILED(rc))
1615	CHECK_ERROR_BREAK(a->virtualBox, OpenSession(a->session, guid));
1616	ComPtr<IConsole> console;
1617	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
1618
1619	/* switch based on the command */
1620	if (strcmp(a->argv[1], "take") == 0)
1621	{
1622	/* there must be a name */
1623	if (a->argc < 3)
1624	{
1625	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
1626	rc = E_FAIL;
1627	break;
1628	}
1629	Bstr name(a->argv[2]);
1630	if ((a->argc > 3) && ((a->argc != 5) \|\| (strcmp(a->argv[3], "-desc") != 0)))
1631	{
1632	errorSyntax(USAGE_SNAPSHOT, "Incorrect description format");
1633	rc = E_FAIL;
1634	break;
1635	}
1636	Bstr desc;
1637	if (a->argc == 5)
1638	desc = a->argv[4];
1639	ComPtr<IProgress> progress;
1640	CHECK_ERROR_BREAK(console, TakeSnapshot(name, desc, progress.asOutParam()));
1641
1642	showProgress(progress);
1643	progress->COMGETTER(ResultCode)(&rc);
1644	if (FAILED(rc))
1645	{
1646	com::ProgressErrorInfo info(progress);
1647	if (info.isBasicAvailable())
1648	RTPrintf("Error: failed to take snapshot. Error message: %lS\n", info.getText().raw());
1649	else
1650	RTPrintf("Error: failed to take snapshot. No error message available!\n");
1651	}
1652	}
1653	else if (strcmp(a->argv[1], "discard") == 0)
1654	{
1655	/* exactly one parameter: snapshot name */
1656	if (a->argc != 3)
1657	{
1658	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
1659	rc = E_FAIL;
1660	break;
1661	}
1662
1663	ComPtr<ISnapshot> snapshot;
1664
1665	/* assume it's a UUID */
1666	Guid guid(a->argv[2]);
1667	if (!guid.isEmpty())
1668	{
1669	CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
1670	}
1671	else
1672	{
1673	/* then it must be a name */
1674	CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(a->argv[2]), snapshot.asOutParam()));
1675	}
1676
1677	snapshot->COMGETTER(Id)(guid.asOutParam());
1678
1679	ComPtr<IProgress> progress;
1680	CHECK_ERROR_BREAK(console, DiscardSnapshot(guid, progress.asOutParam()));
1681
1682	showProgress(progress);
1683	progress->COMGETTER(ResultCode)(&rc);
1684	if (FAILED(rc))
1685	{
1686	com::ProgressErrorInfo info(progress);
1687	if (info.isBasicAvailable())
1688	RTPrintf("Error: failed to discard snapshot. Error message: %lS\n", info.getText().raw());
1689	else
1690	RTPrintf("Error: failed to discard snapshot. No error message available!\n");
1691	}
1692	}
1693	else if (strcmp(a->argv[1], "discardcurrent") == 0)
1694	{
1695	if ( (a->argc != 3)
1696	\|\| ( (strcmp(a->argv[2], "-state") != 0)
1697	&& (strcmp(a->argv[2], "-all") != 0)))
1698	{
1699	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[2]).raw());
1700	rc = E_FAIL;
1701	break;
1702	}
1703	bool fAll = false;
1704	if (strcmp(a->argv[2], "-all") == 0)
1705	fAll = true;
1706
1707	ComPtr<IProgress> progress;
1708
1709	if (fAll)
1710	{
1711	CHECK_ERROR_BREAK(console, DiscardCurrentSnapshotAndState(progress.asOutParam()));
1712	}
1713	else
1714	{
1715	CHECK_ERROR_BREAK(console, DiscardCurrentState(progress.asOutParam()));
1716	}
1717
1718	showProgress(progress);
1719	progress->COMGETTER(ResultCode)(&rc);
1720	if (FAILED(rc))
1721	{
1722	com::ProgressErrorInfo info(progress);
1723	if (info.isBasicAvailable())
1724	RTPrintf("Error: failed to discard. Error message: %lS\n", info.getText().raw());
1725	else
1726	RTPrintf("Error: failed to discard. No error message available!\n");
1727	}
1728
1729	}
1730	else if (strcmp(a->argv[1], "edit") == 0)
1731	{
1732	if (a->argc < 3)
1733	{
1734	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
1735	rc = E_FAIL;
1736	break;
1737	}
1738
1739	ComPtr<ISnapshot> snapshot;
1740
1741	if (strcmp(a->argv[2], "-current") == 0)
1742	{
1743	CHECK_ERROR_BREAK(machine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
1744	}
1745	else
1746	{
1747	/* assume it's a UUID */
1748	Guid guid(a->argv[2]);
1749	if (!guid.isEmpty())
1750	{
1751	CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
1752	}
1753	else
1754	{
1755	/* then it must be a name */
1756	CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(a->argv[2]), snapshot.asOutParam()));
1757	}
1758	}
1759
1760	/* parse options */
1761	for (int i = 3; i < a->argc; i++)
1762	{
1763	if (strcmp(a->argv[i], "-newname") == 0)
1764	{
1765	if (a->argc <= i + 1)
1766	{
1767	errorArgument("Missing argument to '%s'", a->argv[i]);
1768	rc = E_FAIL;
1769	break;
1770	}
1771	i++;
1772	snapshot->COMSETTER(Name)(Bstr(a->argv[i]));
1773	}
1774	else if (strcmp(a->argv[i], "-newdesc") == 0)
1775	{
1776	if (a->argc <= i + 1)
1777	{
1778	errorArgument("Missing argument to '%s'", a->argv[i]);
1779	rc = E_FAIL;
1780	break;
1781	}
1782	i++;
1783	snapshot->COMSETTER(Description)(Bstr(a->argv[i]));
1784	}
1785	else
1786	{
1787	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
1788	rc = E_FAIL;
1789	break;
1790	}
1791	}
1792
1793	}
1794	else if (strcmp(a->argv[1], "showvminfo") == 0)
1795	{
1796	/* exactly one parameter: snapshot name */
1797	if (a->argc != 3)
1798	{
1799	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
1800	rc = E_FAIL;
1801	break;
1802	}
1803
1804	ComPtr<ISnapshot> snapshot;
1805
1806	/* assume it's a UUID */
1807	Guid guid(a->argv[2]);
1808	if (!guid.isEmpty())
1809	{
1810	CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
1811	}
1812	else
1813	{
1814	/* then it must be a name */
1815	CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(a->argv[2]), snapshot.asOutParam()));
1816	}
1817
1818	/* get the machine of the given snapshot */
1819	ComPtr<IMachine> machine;
1820	snapshot->COMGETTER(Machine)(machine.asOutParam());
1821	showVMInfo(a->virtualBox, machine, console);
1822	}
1823	else
1824	{
1825	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).raw());
1826	rc = E_FAIL;
1827	}
1828	} while (0);
1829
1830	a->session->Close();
1831
1832	return SUCCEEDED(rc) ? 0 : 1;
1833	}
1834
1835	static int handleGetExtraData(HandlerArg *a)
1836	{
1837	HRESULT rc = S_OK;
1838
1839	if (a->argc != 2)
1840	return errorSyntax(USAGE_GETEXTRADATA, "Incorrect number of parameters");
1841
1842	/* global data? */
1843	if (strcmp(a->argv[0], "global") == 0)
1844	{
1845	/* enumeration? */
1846	if (strcmp(a->argv[1], "enumerate") == 0)
1847	{
1848	Bstr extraDataKey;
1849
1850	do
1851	{
1852	Bstr nextExtraDataKey;
1853	Bstr nextExtraDataValue;
1854	HRESULT rcEnum = a->virtualBox->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(),
1855	nextExtraDataValue.asOutParam());
1856	extraDataKey = nextExtraDataKey;
1857
1858	if (SUCCEEDED(rcEnum) && extraDataKey)
1859	RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw());
1860	} while (extraDataKey);
1861	}
1862	else
1863	{
1864	Bstr value;
1865	CHECK_ERROR(a->virtualBox, GetExtraData(Bstr(a->argv[1]), value.asOutParam()));
1866	if (value)
1867	RTPrintf("Value: %lS\n", value.raw());
1868	else
1869	RTPrintf("No value set!\n");
1870	}
1871	}
1872	else
1873	{
1874	ComPtr<IMachine> machine;
1875	/* assume it's a UUID */
1876	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
1877	if (FAILED(rc) \|\| !machine)
1878	{
1879	/* must be a name */
1880	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1881	}
1882	if (machine)
1883	{
1884	/* enumeration? */
1885	if (strcmp(a->argv[1], "enumerate") == 0)
1886	{
1887	Bstr extraDataKey;
1888
1889	do
1890	{
1891	Bstr nextExtraDataKey;
1892	Bstr nextExtraDataValue;
1893	HRESULT rcEnum = machine->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(),
1894	nextExtraDataValue.asOutParam());
1895	extraDataKey = nextExtraDataKey;
1896
1897	if (SUCCEEDED(rcEnum) && extraDataKey)
1898	{
1899	RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw());
1900	}
1901	} while (extraDataKey);
1902	}
1903	else
1904	{
1905	Bstr value;
1906	CHECK_ERROR(machine, GetExtraData(Bstr(a->argv[1]), value.asOutParam()));
1907	if (value)
1908	RTPrintf("Value: %lS\n", value.raw());
1909	else
1910	RTPrintf("No value set!\n");
1911	}
1912	}
1913	}
1914	return SUCCEEDED(rc) ? 0 : 1;
1915	}
1916
1917	static int handleSetExtraData(HandlerArg *a)
1918	{
1919	HRESULT rc = S_OK;
1920
1921	if (a->argc < 2)
1922	return errorSyntax(USAGE_SETEXTRADATA, "Not enough parameters");
1923
1924	/* global data? */
1925	if (strcmp(a->argv[0], "global") == 0)
1926	{
1927	if (a->argc < 3)
1928	CHECK_ERROR(a->virtualBox, SetExtraData(Bstr(a->argv[1]), NULL));
1929	else if (a->argc == 3)
1930	CHECK_ERROR(a->virtualBox, SetExtraData(Bstr(a->argv[1]), Bstr(a->argv[2])));
1931	else
1932	return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
1933	}
1934	else
1935	{
1936	ComPtr<IMachine> machine;
1937	/* assume it's a UUID */
1938	rc = a->virtualBox->GetMachine(Guid(a->argv[0]), machine.asOutParam());
1939	if (FAILED(rc) \|\| !machine)
1940	{
1941	/* must be a name */
1942	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1943	}
1944	if (machine)
1945	{
1946	if (a->argc < 3)
1947	CHECK_ERROR(machine, SetExtraData(Bstr(a->argv[1]), NULL));
1948	else if (a->argc == 3)
1949	CHECK_ERROR(machine, SetExtraData(Bstr(a->argv[1]), Bstr(a->argv[2])));
1950	else
1951	return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
1952	}
1953	}
1954	return SUCCEEDED(rc) ? 0 : 1;
1955	}
1956
1957	static int handleSetProperty(HandlerArg *a)
1958	{
1959	HRESULT rc;
1960
1961	/* there must be two arguments: property name and value */
1962	if (a->argc != 2)
1963	return errorSyntax(USAGE_SETPROPERTY, "Incorrect number of parameters");
1964
1965	ComPtr<ISystemProperties> systemProperties;
1966	a->virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
1967
1968	if (strcmp(a->argv[0], "hdfolder") == 0)
1969	{
1970	/* reset to default? */
1971	if (strcmp(a->argv[1], "default") == 0)
1972	CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(NULL));
1973	else
1974	CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(Bstr(a->argv[1])));
1975	}
1976	else if (strcmp(a->argv[0], "machinefolder") == 0)
1977	{
1978	/* reset to default? */
1979	if (strcmp(a->argv[1], "default") == 0)
1980	CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(NULL));
1981	else
1982	CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(Bstr(a->argv[1])));
1983	}
1984	else if (strcmp(a->argv[0], "vrdpauthlibrary") == 0)
1985	{
1986	/* reset to default? */
1987	if (strcmp(a->argv[1], "default") == 0)
1988	CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(NULL));
1989	else
1990	CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(Bstr(a->argv[1])));
1991	}
1992	else if (strcmp(a->argv[0], "websrvauthlibrary") == 0)
1993	{
1994	/* reset to default? */
1995	if (strcmp(a->argv[1], "default") == 0)
1996	CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(NULL));
1997	else
1998	CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(Bstr(a->argv[1])));
1999	}
2000	else if (strcmp(a->argv[0], "hwvirtexenabled") == 0)
2001	{
2002	if (strcmp(a->argv[1], "yes") == 0)
2003	CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(TRUE));
2004	else if (strcmp(a->argv[1], "no") == 0)
2005	CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(FALSE));
2006	else
2007	return errorArgument("Invalid value '%s' for hardware virtualization extension flag", a->argv[1]);
2008	}
2009	else if (strcmp(a->argv[0], "loghistorycount") == 0)
2010	{
2011	uint32_t uVal;
2012	int vrc;
2013	vrc = RTStrToUInt32Ex(a->argv[1], NULL, 0, &uVal);
2014	if (vrc != VINF_SUCCESS)
2015	return errorArgument("Error parsing Log history count '%s'", a->argv[1]);
2016	CHECK_ERROR(systemProperties, COMSETTER(LogHistoryCount)(uVal));
2017	}
2018	else
2019	return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", a->argv[0]);
2020
2021	return SUCCEEDED(rc) ? 0 : 1;
2022	}
2023
2024	static int handleUSBFilter (HandlerArg *a)
2025	{
2026	HRESULT rc = S_OK;
2027	USBFilterCmd cmd;
2028
2029	/* at least: 0: command, 1: index, 2: -target, 3: <target value> */
2030	if (a->argc < 4)
2031	return errorSyntax(USAGE_USBFILTER, "Not enough parameters");
2032
2033	/* which command? */
2034	cmd.mAction = USBFilterCmd::Invalid;
2035	if (strcmp (a->argv [0], "add") == 0) cmd.mAction = USBFilterCmd::Add;
2036	else if (strcmp (a->argv [0], "modify") == 0) cmd.mAction = USBFilterCmd::Modify;
2037	else if (strcmp (a->argv [0], "remove") == 0) cmd.mAction = USBFilterCmd::Remove;
2038
2039	if (cmd.mAction == USBFilterCmd::Invalid)
2040	return errorSyntax(USAGE_USBFILTER, "Invalid parameter '%s'", a->argv[0]);
2041
2042	/* which index? */
2043	if (VINF_SUCCESS != RTStrToUInt32Full (a->argv[1], 10, &cmd.mIndex))
2044	return errorSyntax(USAGE_USBFILTER, "Invalid index '%s'", a->argv[1]);
2045
2046	switch (cmd.mAction)
2047	{
2048	case USBFilterCmd::Add:
2049	case USBFilterCmd::Modify:
2050	{
2051	/* at least: 0: command, 1: index, 2: -target, 3: <target value>, 4: -name, 5: <name value> */
2052	if (a->argc < 6)
2053	{
2054	if (cmd.mAction == USBFilterCmd::Add)
2055	return errorSyntax(USAGE_USBFILTER_ADD, "Not enough parameters");
2056
2057	return errorSyntax(USAGE_USBFILTER_MODIFY, "Not enough parameters");
2058	}
2059
2060	// set Active to true by default
2061	// (assuming that the user sets up all necessary attributes
2062	// at once and wants the filter to be active immediately)
2063	if (cmd.mAction == USBFilterCmd::Add)
2064	cmd.mFilter.mActive = true;
2065
2066	for (int i = 2; i < a->argc; i++)
2067	{
2068	if (strcmp(a->argv [i], "-target") == 0)
2069	{
2070	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2071	return errorArgument("Missing argument to '%s'", a->argv[i]);
2072	i++;
2073	if (strcmp (a->argv [i], "global") == 0)
2074	cmd.mGlobal = true;
2075	else
2076	{
2077	/* assume it's a UUID of a machine */
2078	rc = a->virtualBox->GetMachine(Guid(a->argv[i]), cmd.mMachine.asOutParam());
2079	if (FAILED(rc) \|\| !cmd.mMachine)
2080	{
2081	/* must be a name */
2082	CHECK_ERROR_RET(a->virtualBox, FindMachine(Bstr(a->argv[i]), cmd.mMachine.asOutParam()), 1);
2083	}
2084	}
2085	}
2086	else if (strcmp(a->argv [i], "-name") == 0)
2087	{
2088	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2089	return errorArgument("Missing argument to '%s'", a->argv[i]);
2090	i++;
2091	cmd.mFilter.mName = a->argv [i];
2092	}
2093	else if (strcmp(a->argv [i], "-active") == 0)
2094	{
2095	if (a->argc <= i + 1)
2096	return errorArgument("Missing argument to '%s'", a->argv[i]);
2097	i++;
2098	if (strcmp (a->argv [i], "yes") == 0)
2099	cmd.mFilter.mActive = true;
2100	else if (strcmp (a->argv [i], "no") == 0)
2101	cmd.mFilter.mActive = false;
2102	else
2103	return errorArgument("Invalid -active argument '%s'", a->argv[i]);
2104	}
2105	else if (strcmp(a->argv [i], "-vendorid") == 0)
2106	{
2107	if (a->argc <= i + 1)
2108	return errorArgument("Missing argument to '%s'", a->argv[i]);
2109	i++;
2110	cmd.mFilter.mVendorId = a->argv [i];
2111	}
2112	else if (strcmp(a->argv [i], "-productid") == 0)
2113	{
2114	if (a->argc <= i + 1)
2115	return errorArgument("Missing argument to '%s'", a->argv[i]);
2116	i++;
2117	cmd.mFilter.mProductId = a->argv [i];
2118	}
2119	else if (strcmp(a->argv [i], "-revision") == 0)
2120	{
2121	if (a->argc <= i + 1)
2122	return errorArgument("Missing argument to '%s'", a->argv[i]);
2123	i++;
2124	cmd.mFilter.mRevision = a->argv [i];
2125	}
2126	else if (strcmp(a->argv [i], "-manufacturer") == 0)
2127	{
2128	if (a->argc <= i + 1)
2129	return errorArgument("Missing argument to '%s'", a->argv[i]);
2130	i++;
2131	cmd.mFilter.mManufacturer = a->argv [i];
2132	}
2133	else if (strcmp(a->argv [i], "-product") == 0)
2134	{
2135	if (a->argc <= i + 1)
2136	return errorArgument("Missing argument to '%s'", a->argv[i]);
2137	i++;
2138	cmd.mFilter.mProduct = a->argv [i];
2139	}
2140	else if (strcmp(a->argv [i], "-remote") == 0)
2141	{
2142	if (a->argc <= i + 1)
2143	return errorArgument("Missing argument to '%s'", a->argv[i]);
2144	i++;
2145	cmd.mFilter.mRemote = a->argv[i];
2146	}
2147	else if (strcmp(a->argv [i], "-serialnumber") == 0)
2148	{
2149	if (a->argc <= i + 1)
2150	return errorArgument("Missing argument to '%s'", a->argv[i]);
2151	i++;
2152	cmd.mFilter.mSerialNumber = a->argv [i];
2153	}
2154	else if (strcmp(a->argv [i], "-maskedinterfaces") == 0)
2155	{
2156	if (a->argc <= i + 1)
2157	return errorArgument("Missing argument to '%s'", a->argv[i]);
2158	i++;
2159	uint32_t u32;
2160	rc = RTStrToUInt32Full(a->argv[i], 0, &u32);
2161	if (RT_FAILURE(rc))
2162	return errorArgument("Failed to convert the -maskedinterfaces value '%s' to a number, rc=%Rrc", a->argv[i], rc);
2163	cmd.mFilter.mMaskedInterfaces = u32;
2164	}
2165	else if (strcmp(a->argv [i], "-action") == 0)
2166	{
2167	if (a->argc <= i + 1)
2168	return errorArgument("Missing argument to '%s'", a->argv[i]);
2169	i++;
2170	if (strcmp (a->argv [i], "ignore") == 0)
2171	cmd.mFilter.mAction = USBDeviceFilterAction_Ignore;
2172	else if (strcmp (a->argv [i], "hold") == 0)
2173	cmd.mFilter.mAction = USBDeviceFilterAction_Hold;
2174	else
2175	return errorArgument("Invalid USB filter action '%s'", a->argv[i]);
2176	}
2177	else
2178	return errorSyntax(cmd.mAction == USBFilterCmd::Add ? USAGE_USBFILTER_ADD : USAGE_USBFILTER_MODIFY,
2179	"Unknown option '%s'", a->argv[i]);
2180	}
2181
2182	if (cmd.mAction == USBFilterCmd::Add)
2183	{
2184	// mandatory/forbidden options
2185	if ( cmd.mFilter.mName.isEmpty()
2186	\|\|
2187	( cmd.mGlobal
2188	&& cmd.mFilter.mAction == USBDeviceFilterAction_Null
2189	)
2190	\|\| ( !cmd.mGlobal
2191	&& !cmd.mMachine)
2192	\|\| ( cmd.mGlobal
2193	&& cmd.mFilter.mRemote)
2194	)
2195	{
2196	return errorSyntax(USAGE_USBFILTER_ADD, "Mandatory options not supplied");
2197	}
2198	}
2199	break;
2200	}
2201
2202	case USBFilterCmd::Remove:
2203	{
2204	/* at least: 0: command, 1: index, 2: -target, 3: <target value> */
2205	if (a->argc < 4)
2206	return errorSyntax(USAGE_USBFILTER_REMOVE, "Not enough parameters");
2207
2208	for (int i = 2; i < a->argc; i++)
2209	{
2210	if (strcmp(a->argv [i], "-target") == 0)
2211	{
2212	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2213	return errorArgument("Missing argument to '%s'", a->argv[i]);
2214	i++;
2215	if (strcmp (a->argv [i], "global") == 0)
2216	cmd.mGlobal = true;
2217	else
2218	{
2219	/* assume it's a UUID of a machine */
2220	rc = a->virtualBox->GetMachine(Guid(a->argv[i]), cmd.mMachine.asOutParam());
2221	if (FAILED(rc) \|\| !cmd.mMachine)
2222	{
2223	/* must be a name */
2224	CHECK_ERROR_RET(a->virtualBox, FindMachine(Bstr(a->argv[i]), cmd.mMachine.asOutParam()), 1);
2225	}
2226	}
2227	}
2228	}
2229
2230	// mandatory options
2231	if (!cmd.mGlobal && !cmd.mMachine)
2232	return errorSyntax(USAGE_USBFILTER_REMOVE, "Mandatory options not supplied");
2233
2234	break;
2235	}
2236
2237	default: break;
2238	}
2239
2240	USBFilterCmd::USBFilter &f = cmd.mFilter;
2241
2242	ComPtr <IHost> host;
2243	ComPtr <IUSBController> ctl;
2244	if (cmd.mGlobal)
2245	CHECK_ERROR_RET (a->virtualBox, COMGETTER(Host) (host.asOutParam()), 1);
2246	else
2247	{
2248	Guid uuid;
2249	cmd.mMachine->COMGETTER(Id)(uuid.asOutParam());
2250	/* open a session for the VM */
2251	CHECK_ERROR_RET (a->virtualBox, OpenSession(a->session, uuid), 1);
2252	/* get the mutable session machine */
2253	a->session->COMGETTER(Machine)(cmd.mMachine.asOutParam());
2254	/* and get the USB controller */
2255	CHECK_ERROR_RET (cmd.mMachine, COMGETTER(USBController) (ctl.asOutParam()), 1);
2256	}
2257
2258	switch (cmd.mAction)
2259	{
2260	case USBFilterCmd::Add:
2261	{
2262	if (cmd.mGlobal)
2263	{
2264	ComPtr <IHostUSBDeviceFilter> flt;
2265	CHECK_ERROR_BREAK (host, CreateUSBDeviceFilter (f.mName, flt.asOutParam()));
2266
2267	if (!f.mActive.isNull())
2268	CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
2269	if (!f.mVendorId.isNull())
2270	CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
2271	if (!f.mProductId.isNull())
2272	CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
2273	if (!f.mRevision.isNull())
2274	CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
2275	if (!f.mManufacturer.isNull())
2276	CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
2277	if (!f.mSerialNumber.isNull())
2278	CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
2279	if (!f.mMaskedInterfaces.isNull())
2280	CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
2281
2282	if (f.mAction != USBDeviceFilterAction_Null)
2283	CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction));
2284
2285	CHECK_ERROR_BREAK (host, InsertUSBDeviceFilter (cmd.mIndex, flt));
2286	}
2287	else
2288	{
2289	ComPtr <IUSBDeviceFilter> flt;
2290	CHECK_ERROR_BREAK (ctl, CreateDeviceFilter (f.mName, flt.asOutParam()));
2291
2292	if (!f.mActive.isNull())
2293	CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
2294	if (!f.mVendorId.isNull())
2295	CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
2296	if (!f.mProductId.isNull())
2297	CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
2298	if (!f.mRevision.isNull())
2299	CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
2300	if (!f.mManufacturer.isNull())
2301	CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
2302	if (!f.mRemote.isNull())
2303	CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty()));
2304	if (!f.mSerialNumber.isNull())
2305	CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
2306	if (!f.mMaskedInterfaces.isNull())
2307	CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
2308
2309	CHECK_ERROR_BREAK (ctl, InsertDeviceFilter (cmd.mIndex, flt));
2310	}
2311	break;
2312	}
2313	case USBFilterCmd::Modify:
2314	{
2315	if (cmd.mGlobal)
2316	{
2317	ComPtr <IHostUSBDeviceFilterCollection> coll;
2318	CHECK_ERROR_BREAK (host, COMGETTER(USBDeviceFilters) (coll.asOutParam()));
2319	ComPtr <IHostUSBDeviceFilter> flt;
2320	CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam()));
2321
2322	if (!f.mName.isNull())
2323	CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty()));
2324	if (!f.mActive.isNull())
2325	CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
2326	if (!f.mVendorId.isNull())
2327	CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
2328	if (!f.mProductId.isNull())
2329	CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
2330	if (!f.mRevision.isNull())
2331	CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
2332	if (!f.mManufacturer.isNull())
2333	CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
2334	if (!f.mSerialNumber.isNull())
2335	CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
2336	if (!f.mMaskedInterfaces.isNull())
2337	CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
2338
2339	if (f.mAction != USBDeviceFilterAction_Null)
2340	CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction));
2341	}
2342	else
2343	{
2344	ComPtr <IUSBDeviceFilterCollection> coll;
2345	CHECK_ERROR_BREAK (ctl, COMGETTER(DeviceFilters) (coll.asOutParam()));
2346
2347	ComPtr <IUSBDeviceFilter> flt;
2348	CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam()));
2349
2350	if (!f.mName.isNull())
2351	CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty()));
2352	if (!f.mActive.isNull())
2353	CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
2354	if (!f.mVendorId.isNull())
2355	CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
2356	if (!f.mProductId.isNull())
2357	CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
2358	if (!f.mRevision.isNull())
2359	CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
2360	if (!f.mManufacturer.isNull())
2361	CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
2362	if (!f.mRemote.isNull())
2363	CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty()));
2364	if (!f.mSerialNumber.isNull())
2365	CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
2366	if (!f.mMaskedInterfaces.isNull())
2367	CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
2368	}
2369	break;
2370	}
2371	case USBFilterCmd::Remove:
2372	{
2373	if (cmd.mGlobal)
2374	{
2375	ComPtr <IHostUSBDeviceFilter> flt;
2376	CHECK_ERROR_BREAK (host, RemoveUSBDeviceFilter (cmd.mIndex, flt.asOutParam()));
2377	}
2378	else
2379	{
2380	ComPtr <IUSBDeviceFilter> flt;
2381	CHECK_ERROR_BREAK (ctl, RemoveDeviceFilter (cmd.mIndex, flt.asOutParam()));
2382	}
2383	break;
2384	}
2385	default:
2386	break;
2387	}
2388
2389	if (cmd.mMachine)
2390	{
2391	/* commit and close the session */
2392	CHECK_ERROR(cmd.mMachine, SaveSettings());
2393	a->session->Close();
2394	}
2395
2396	return SUCCEEDED (rc) ? 0 : 1;
2397	}
2398
2399	static int handleSharedFolder (HandlerArg *a)
2400	{
2401	HRESULT rc;
2402
2403	/* we need at least a command and target */
2404	if (a->argc < 2)
2405	return errorSyntax(USAGE_SHAREDFOLDER, "Not enough parameters");
2406
2407	ComPtr<IMachine> machine;
2408	/* assume it's a UUID */
2409	rc = a->virtualBox->GetMachine(Guid(a->argv[1]), machine.asOutParam());
2410	if (FAILED(rc) \|\| !machine)
2411	{
2412	/* must be a name */
2413	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[1]), machine.asOutParam()));
2414	}
2415	if (!machine)
2416	return 1;
2417	Guid uuid;
2418	machine->COMGETTER(Id)(uuid.asOutParam());
2419
2420	if (strcmp(a->argv[0], "add") == 0)
2421	{
2422	/* we need at least four more parameters */
2423	if (a->argc < 5)
2424	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Not enough parameters");
2425
2426	char *name = NULL;
2427	char *hostpath = NULL;
2428	bool fTransient = false;
2429	bool fWritable = true;
2430
2431	for (int i = 2; i < a->argc; i++)
2432	{
2433	if (strcmp(a->argv[i], "-name") == 0)
2434	{
2435	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2436	return errorArgument("Missing argument to '%s'", a->argv[i]);
2437	i++;
2438	name = a->argv[i];
2439	}
2440	else if (strcmp(a->argv[i], "-hostpath") == 0)
2441	{
2442	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2443	return errorArgument("Missing argument to '%s'", a->argv[i]);
2444	i++;
2445	hostpath = a->argv[i];
2446	}
2447	else if (strcmp(a->argv[i], "-readonly") == 0)
2448	{
2449	fWritable = false;
2450	}
2451	else if (strcmp(a->argv[i], "-transient") == 0)
2452	{
2453	fTransient = true;
2454	}
2455	else
2456	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
2457	}
2458
2459	if (NULL != strstr(name, " "))
2460	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "No spaces allowed in parameter '-name'!");
2461
2462	/* required arguments */
2463	if (!name \|\| !hostpath)
2464	{
2465	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Parameters -name and -hostpath are required");
2466	}
2467
2468	if (fTransient)
2469	{
2470	ComPtr <IConsole> console;
2471
2472	/* open an existing session for the VM */
2473	CHECK_ERROR_RET(a->virtualBox, OpenExistingSession (a->session, uuid), 1);
2474	/* get the session machine */
2475	CHECK_ERROR_RET(a->session, COMGETTER(Machine)(machine.asOutParam()), 1);
2476	/* get the session console */
2477	CHECK_ERROR_RET(a->session, COMGETTER(Console)(console.asOutParam()), 1);
2478
2479	CHECK_ERROR(console, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
2480
2481	if (console)
2482	a->session->Close();
2483	}
2484	else
2485	{
2486	/* open a session for the VM */
2487	CHECK_ERROR_RET (a->virtualBox, OpenSession(a->session, uuid), 1);
2488
2489	/* get the mutable session machine */
2490	a->session->COMGETTER(Machine)(machine.asOutParam());
2491
2492	CHECK_ERROR(machine, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
2493
2494	if (SUCCEEDED(rc))
2495	CHECK_ERROR(machine, SaveSettings());
2496
2497	a->session->Close();
2498	}
2499	}
2500	else if (strcmp(a->argv[0], "remove") == 0)
2501	{
2502	/* we need at least two more parameters */
2503	if (a->argc < 3)
2504	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Not enough parameters");
2505
2506	char *name = NULL;
2507	bool fTransient = false;
2508
2509	for (int i = 2; i < a->argc; i++)
2510	{
2511	if (strcmp(a->argv[i], "-name") == 0)
2512	{
2513	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
2514	return errorArgument("Missing argument to '%s'", a->argv[i]);
2515	i++;
2516	name = a->argv[i];
2517	}
2518	else if (strcmp(a->argv[i], "-transient") == 0)
2519	{
2520	fTransient = true;
2521	}
2522	else
2523	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
2524	}
2525
2526	/* required arguments */
2527	if (!name)
2528	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Parameter -name is required");
2529
2530	if (fTransient)
2531	{
2532	ComPtr <IConsole> console;
2533
2534	/* open an existing session for the VM */
2535	CHECK_ERROR_RET(a->virtualBox, OpenExistingSession (a->session, uuid), 1);
2536	/* get the session machine */
2537	CHECK_ERROR_RET(a->session, COMGETTER(Machine)(machine.asOutParam()), 1);
2538	/* get the session console */
2539	CHECK_ERROR_RET(a->session, COMGETTER(Console)(console.asOutParam()), 1);
2540
2541	CHECK_ERROR(console, RemoveSharedFolder(Bstr(name)));
2542
2543	if (console)
2544	a->session->Close();
2545	}
2546	else
2547	{
2548	/* open a session for the VM */
2549	CHECK_ERROR_RET (a->virtualBox, OpenSession(a->session, uuid), 1);
2550
2551	/* get the mutable session machine */
2552	a->session->COMGETTER(Machine)(machine.asOutParam());
2553
2554	CHECK_ERROR(machine, RemoveSharedFolder(Bstr(name)));
2555
2556	/* commit and close the session */
2557	CHECK_ERROR(machine, SaveSettings());
2558	a->session->Close();
2559	}
2560	}
2561	else
2562	return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", Utf8Str(a->argv[0]).raw());
2563
2564	return 0;
2565	}
2566
2567	static int handleVMStatistics(HandlerArg *a)
2568	{
2569	HRESULT rc;
2570
2571	/* at least one option: the UUID or name of the VM */
2572	if (a->argc < 1)
2573	return errorSyntax(USAGE_VM_STATISTICS, "Incorrect number of parameters");
2574
2575	/* try to find the given machine */
2576	ComPtr <IMachine> machine;
2577	Guid uuid (a->argv[0]);
2578	if (!uuid.isEmpty())
2579	CHECK_ERROR(a->virtualBox, GetMachine(uuid, machine.asOutParam()));
2580	else
2581	{
2582	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
2583	if (SUCCEEDED (rc))
2584	machine->COMGETTER(Id)(uuid.asOutParam());
2585	}
2586	if (FAILED(rc))
2587	return 1;
2588
2589	/* parse arguments. */
2590	bool fReset = false;
2591	bool fWithDescriptions = false;
2592	const char pszPattern = NULL; / all */
2593	for (int i = 1; i < a->argc; i++)
2594	{
2595	if (!strcmp(a->argv[i], "-pattern"))
2596	{
2597	if (pszPattern)
2598	return errorSyntax(USAGE_VM_STATISTICS, "Multiple -patterns options is not permitted");
2599	if (i + 1 >= a->argc)
2600	return errorArgument("Missing argument to '%s'", a->argv[i]);
2601	pszPattern = a->argv[++i];
2602	}
2603	else if (!strcmp(a->argv[i], "-descriptions"))
2604	fWithDescriptions = true;
2605	/* add: -file <filename> and -formatted */
2606	else if (!strcmp(a->argv[i], "-reset"))
2607	fReset = true;
2608	else
2609	return errorSyntax(USAGE_VM_STATISTICS, "Unknown option '%s'", a->argv[i]);
2610	}
2611	if (fReset && fWithDescriptions)
2612	return errorSyntax(USAGE_VM_STATISTICS, "The -reset and -descriptions options does not mix");
2613
2614
2615	/* open an existing session for the VM. */
2616	CHECK_ERROR(a->virtualBox, OpenExistingSession(a->session, uuid));
2617	if (SUCCEEDED(rc))
2618	{
2619	/* get the session console. */
2620	ComPtr <IConsole> console;
2621	CHECK_ERROR(a->session, COMGETTER(Console)(console.asOutParam()));
2622	if (SUCCEEDED(rc))
2623	{
2624	/* get the machine debugger. */
2625	ComPtr <IMachineDebugger> debugger;
2626	CHECK_ERROR(console, COMGETTER(Debugger)(debugger.asOutParam()));
2627	if (SUCCEEDED(rc))
2628	{
2629	if (fReset)
2630	CHECK_ERROR(debugger, ResetStats(Bstr(pszPattern)));
2631	else
2632	{
2633	Bstr stats;
2634	CHECK_ERROR(debugger, GetStats(Bstr(pszPattern), fWithDescriptions, stats.asOutParam()));
2635	if (SUCCEEDED(rc))
2636	{
2637	/* if (fFormatted)
2638	{ big mess }
2639	else
2640	*/
2641	RTPrintf("%ls\n", stats.raw());
2642	}
2643	}
2644	}
2645	a->session->Close();
2646	}
2647	}
2648
2649	return SUCCEEDED(rc) ? 0 : 1;
2650	}
2651	#endif /* !VBOX_ONLY_DOCS */
2652
2653	enum ConvertSettings
2654	{
2655	ConvertSettings_No = 0,
2656	ConvertSettings_Yes = 1,
2657	ConvertSettings_Backup = 2,
2658	ConvertSettings_Ignore = 3,
2659	};
2660
2661	#ifndef VBOX_ONLY_DOCS
2662	/**
2663	* Checks if any of the settings files were auto-converted and informs the
2664	* user if so.
2665	*
2666	* @return @false if the program should terminate and @true otherwise.
2667	*/
2668	static bool checkForAutoConvertedSettings (ComPtr<IVirtualBox> virtualBox,
2669	ComPtr<ISession> session,
2670	ConvertSettings fConvertSettings)
2671	{
2672	/* return early if nothing to do */
2673	if (fConvertSettings == ConvertSettings_Ignore)
2674	return true;
2675
2676	HRESULT rc;
2677
2678	do
2679	{
2680	Bstr formatVersion;
2681	CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFormatVersion) (formatVersion.asOutParam()));
2682
2683	bool isGlobalConverted = false;
2684	std::list <ComPtr <IMachine> > cvtMachines;
2685	std::list <Utf8Str> fileList;
2686	Bstr version;
2687	Bstr filePath;
2688
2689	com::SafeIfaceArray <IMachine> machines;
2690	CHECK_ERROR_BREAK(virtualBox, COMGETTER(Machines2) (ComSafeArrayAsOutParam (machines)));
2691
2692	for (size_t i = 0; i < machines.size(); ++ i)
2693	{
2694	BOOL accessible;
2695	CHECK_ERROR_BREAK(machines[i], COMGETTER(Accessible) (&accessible));
2696	if (!accessible)
2697	continue;
2698
2699	CHECK_ERROR_BREAK(machines[i], COMGETTER(SettingsFileVersion) (version.asOutParam()));
2700
2701	if (version != formatVersion)
2702	{
2703	cvtMachines.push_back (machines [i]);
2704	Bstr filePath;
2705	CHECK_ERROR_BREAK(machines[i], COMGETTER(SettingsFilePath) (filePath.asOutParam()));
2706	fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(),
2707	version.raw()));
2708	}
2709	}
2710
2711	if (FAILED(rc))
2712	break;
2713
2714	CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFileVersion) (version.asOutParam()));
2715	if (version != formatVersion)
2716	{
2717	isGlobalConverted = true;
2718	CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFilePath) (filePath.asOutParam()));
2719	fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(),
2720	version.raw()));
2721	}
2722
2723	if (fileList.size() > 0)
2724	{
2725	switch (fConvertSettings)
2726	{
2727	case ConvertSettings_No:
2728	{
2729	RTPrintf (
2730	"WARNING! The following VirtualBox settings files have been automatically\n"
2731	"converted to the new settings file format version '%ls':\n"
2732	"\n",
2733	formatVersion.raw());
2734
2735	for (std::list <Utf8Str>::const_iterator f = fileList.begin();
2736	f != fileList.end(); ++ f)
2737	RTPrintf (" %S\n", (*f).raw());
2738	RTPrintf (
2739	"\n"
2740	"The current command was aborted to prevent overwriting the above settings\n"
2741	"files with the results of the auto-conversion without your permission.\n"
2742	"Please put one of the following command line switches to the beginning of\n"
2743	"the VBoxManage command line and repeat the command:\n"
2744	"\n"
2745	" -convertSettings - to save all auto-converted files (it will not\n"
2746	" be possible to use these settings files with an\n"
2747	" older version of VirtualBox in the future);\n"
2748	" -convertSettingsBackup - to create backup copies of the settings files in\n"
2749	" the old format before saving them in the new format;\n"
2750	" -convertSettingsIgnore - to not save the auto-converted settings files.\n"
2751	"\n"
2752	"Note that if you use -convertSettingsIgnore, the auto-converted settings files\n"
2753	"will be implicitly saved in the new format anyway once you change a setting or\n"
2754	"start a virtual machine, but NO backup copies will be created in this case.\n");
2755	return false;
2756	}
2757	case ConvertSettings_Yes:
2758	case ConvertSettings_Backup:
2759	{
2760	break;
2761	}
2762	default:
2763	AssertFailedReturn (false);
2764	}
2765
2766	for (std::list <ComPtr <IMachine> >::const_iterator m = cvtMachines.begin();
2767	m != cvtMachines.end(); ++ m)
2768	{
2769	Guid id;
2770	CHECK_ERROR_BREAK((*m), COMGETTER(Id) (id.asOutParam()));
2771
2772	/* open a session for the VM */
2773	CHECK_ERROR_BREAK (virtualBox, OpenSession (session, id));
2774
2775	ComPtr <IMachine> sm;
2776	CHECK_ERROR_BREAK(session, COMGETTER(Machine) (sm.asOutParam()));
2777
2778	Bstr bakFileName;
2779	if (fConvertSettings == ConvertSettings_Backup)
2780	CHECK_ERROR (sm, SaveSettingsWithBackup (bakFileName.asOutParam()));
2781	else
2782	CHECK_ERROR (sm, SaveSettings());
2783
2784	session->Close();
2785
2786	if (FAILED(rc))
2787	break;
2788	}
2789
2790	if (FAILED(rc))
2791	break;
2792
2793	if (isGlobalConverted)
2794	{
2795	Bstr bakFileName;
2796	if (fConvertSettings == ConvertSettings_Backup)
2797	CHECK_ERROR (virtualBox, SaveSettingsWithBackup (bakFileName.asOutParam()));
2798	else
2799	CHECK_ERROR (virtualBox, SaveSettings());
2800	}
2801
2802	if (FAILED(rc))
2803	break;
2804	}
2805	}
2806	while (0);
2807
2808	return SUCCEEDED (rc);
2809	}
2810	#endif /* !VBOX_ONLY_DOCS */
2811
2812	// main
2813	///////////////////////////////////////////////////////////////////////////////
2814
2815	int main(int argc, char *argv[])
2816	{
2817	/*
2818	* Before we do anything, init the runtime without loading
2819	* the support driver.
2820	*/
2821	RTR3Init();
2822
2823	bool fShowLogo = true;
2824	int iCmd = 1;
2825	int iCmdArg;
2826
2827	ConvertSettings fConvertSettings = ConvertSettings_No;
2828
2829	/* global options */
2830	for (int i = 1; i < argc \|\| argc <= iCmd; i++)
2831	{
2832	if ( argc <= iCmd
2833	\|\| (strcmp(argv[i], "help") == 0)
2834	\|\| (strcmp(argv[i], "-?") == 0)
2835	\|\| (strcmp(argv[i], "-h") == 0)
2836	\|\| (strcmp(argv[i], "-help") == 0)
2837	\|\| (strcmp(argv[i], "--help") == 0))
2838	{
2839	showLogo();
2840	printUsage(USAGE_ALL);
2841	return 0;
2842	}
2843	else if ( strcmp(argv[i], "-v") == 0
2844	\|\| strcmp(argv[i], "-version") == 0
2845	\|\| strcmp(argv[i], "-Version") == 0
2846	\|\| strcmp(argv[i], "--version") == 0)
2847	{
2848	/* Print version number, and do nothing else. */
2849	RTPrintf("%sr%d\n", VBOX_VERSION_STRING, VBoxSVNRev ());
2850	return 0;
2851	}
2852	else if (strcmp(argv[i], "-dumpopts") == 0)
2853	{
2854	/* Special option to dump really all commands,
2855	* even the ones not understood on this platform. */
2856	printUsage(USAGE_DUMPOPTS);
2857	return 0;
2858	}
2859	else if (strcmp(argv[i], "-nologo") == 0)
2860	{
2861	/* suppress the logo */
2862	fShowLogo = false;
2863	iCmd++;
2864	}
2865	else if (strcmp(argv[i], "-convertSettings") == 0)
2866	{
2867	fConvertSettings = ConvertSettings_Yes;
2868	iCmd++;
2869	}
2870	else if (strcmp(argv[i], "-convertSettingsBackup") == 0)
2871	{
2872	fConvertSettings = ConvertSettings_Backup;
2873	iCmd++;
2874	}
2875	else if (strcmp(argv[i], "-convertSettingsIgnore") == 0)
2876	{
2877	fConvertSettings = ConvertSettings_Ignore;
2878	iCmd++;
2879	}
2880	else
2881	{
2882	break;
2883	}
2884	}
2885
2886	iCmdArg = iCmd + 1;
2887
2888	if (fShowLogo)
2889	showLogo();
2890
2891
2892	#ifdef VBOX_ONLY_DOCS
2893	int rc = 0;
2894	#else /* !VBOX_ONLY_DOCS */
2895	HRESULT rc = 0;
2896
2897	rc = com::Initialize();
2898	if (FAILED(rc))
2899	{
2900	RTPrintf("ERROR: failed to initialize COM!\n");
2901	return rc;
2902	}
2903
2904	/*
2905	* The input is in the host OS'es codepage (NT guarantees ACP).
2906	* For VBox we use UTF-8 and convert to UCS-2 when calling (XP)COM APIs.
2907	* For simplicity, just convert the argv[] array here.
2908	*/
2909	for (int i = iCmdArg; i < argc; i++)
2910	{
2911	char *converted;
2912	RTStrCurrentCPToUtf8(&converted, argv[i]);
2913	argv[i] = converted;
2914	}
2915
2916	do
2917	{
2918	// scopes all the stuff till shutdown
2919	////////////////////////////////////////////////////////////////////////////
2920
2921	/* convertfromraw: does not need a VirtualBox instantiation. */
2922	if (argc >= iCmdArg && ( !strcmp(argv[iCmd], "convertfromraw")
2923	\|\| !strcmp(argv[iCmd], "convertdd")))
2924	{
2925	rc = handleConvertFromRaw(argc - iCmdArg, argv + iCmdArg);
2926	break;
2927	}
2928
2929	ComPtr<IVirtualBox> virtualBox;
2930	ComPtr<ISession> session;
2931
2932	rc = virtualBox.createLocalObject(CLSID_VirtualBox);
2933	if (FAILED(rc))
2934	RTPrintf("ERROR: failed to create the VirtualBox object!\n");
2935	else
2936	{
2937	rc = session.createInprocObject(CLSID_Session);
2938	if (FAILED(rc))
2939	RTPrintf("ERROR: failed to create a session object!\n");
2940	}
2941
2942	if (FAILED(rc))
2943	{
2944	com::ErrorInfo info;
2945	if (!info.isFullAvailable() && !info.isBasicAvailable())
2946	{
2947	com::GluePrintRCMessage(rc);
2948	RTPrintf("Most likely, the VirtualBox COM server is not running or failed to start.\n");
2949	}
2950	else
2951	GluePrintErrorInfo(info);
2952	break;
2953	}
2954
2955	/* create the event queue
2956	* (here it is necessary only to process remaining XPCOM/IPC events
2957	* after the session is closed) */
2958
2959	#ifdef USE_XPCOM_QUEUE
2960	nsCOMPtr<nsIEventQueue> eventQ;
2961	NS_GetMainEventQ(getter_AddRefs(eventQ));
2962	#endif
2963
2964	if (!checkForAutoConvertedSettings (virtualBox, session, fConvertSettings))
2965	break;
2966
2967	#ifdef USE_XPCOM_QUEUE
2968	HandlerArg handlerArg = { 0, NULL, eventQ, virtualBox, session };
2969	#else
2970	HandlerArg handlerArg = { 0, NULL, virtualBox, session };
2971	#endif
2972
2973	/*
2974	* All registered command handlers
2975	*/
2976	struct
2977	{
2978	const char *command;
2979	PFNHANDLER handler;
2980	} commandHandlers[] =
2981	{
2982	{ "internalcommands", handleInternalCommands },
2983	{ "list", handleList },
2984	{ "showvminfo", handleShowVMInfo },
2985	{ "registervm", handleRegisterVM },
2986	{ "unregistervm", handleUnregisterVM },
2987	{ "createhd", handleCreateHardDisk },
2988	{ "createvdi", handleCreateHardDisk }, /* backward compatiblity */
2989	{ "modifyhd", handleModifyHardDisk },
2990	{ "modifyvdi", handleModifyHardDisk }, /* backward compatiblity */
2991	{ "clonehd", handleCloneHardDisk },
2992	{ "clonevdi", handleCloneHardDisk }, /* backward compatiblity */
2993	{ "addiscsidisk", handleAddiSCSIDisk },
2994	{ "createvm", handleCreateVM },
2995	{ "modifyvm", handleModifyVM },
2996	{ "startvm", handleStartVM },
2997	{ "controlvm", handleControlVM },
2998	{ "discardstate", handleDiscardState },
2999	{ "adoptstate", handleAdoptdState },
3000	{ "snapshot", handleSnapshot },
3001	{ "openmedium", handleOpenMedium },
3002	{ "registerimage", handleOpenMedium }, /* backward compatiblity */
3003	{ "closemedium", handleCloseMedium },
3004	{ "unregisterimage", handleCloseMedium }, /* backward compatiblity */
3005	{ "showhdinfo", handleShowHardDiskInfo },
3006	{ "showvdiinfo", handleShowHardDiskInfo }, /* backward compatiblity */
3007	{ "getextradata", handleGetExtraData },
3008	{ "setextradata", handleSetExtraData },
3009	{ "setproperty", handleSetProperty },
3010	{ "usbfilter", handleUSBFilter },
3011	{ "sharedfolder", handleSharedFolder },
3012	{ "vmstatistics", handleVMStatistics },
3013	#ifdef VBOX_WITH_GUEST_PROPS
3014	{ "guestproperty", handleGuestProperty },
3015	#endif /* VBOX_WITH_GUEST_PROPS defined */
3016	{ "metrics", handleMetrics },
3017	{ "import", handleImportAppliance },
3018	{ NULL, NULL }
3019	};
3020
3021	int commandIndex;
3022	for (commandIndex = 0; commandHandlers[commandIndex].command != NULL; commandIndex++)
3023	{
3024	if (strcmp(commandHandlers[commandIndex].command, argv[iCmd]) == 0)
3025	{
3026	handlerArg.argc = argc - iCmdArg;
3027	handlerArg.argv = &argv[iCmdArg];
3028	rc = commandHandlers[commandIndex].handler(&handlerArg);
3029	break;
3030	}
3031	}
3032	if (!commandHandlers[commandIndex].command)
3033	{
3034	rc = errorSyntax(USAGE_ALL, "Invalid command '%s'", Utf8Str(argv[iCmd]).raw());
3035	}
3036
3037	/* Although all handlers should always close the session if they open it,
3038	* we do it here just in case if some of the handlers contains a bug --
3039	* leaving the direct session not closed will turn the machine state to
3040	* Aborted which may have unwanted side effects like killing the saved
3041	* state file (if the machine was in the Saved state before). */
3042	session->Close();
3043
3044	#ifdef USE_XPCOM_QUEUE
3045	eventQ->ProcessPendingEvents();
3046	#endif
3047
3048	// end "all-stuff" scope
3049	////////////////////////////////////////////////////////////////////////////
3050	}
3051	while (0);
3052
3053	com::Shutdown();
3054	#endif /* !VBOX_ONLY_DOCS */
3055
3056	/*
3057	* Free converted argument vector
3058	*/
3059	for (int i = iCmdArg; i < argc; i++)
3060	RTStrFree(argv[i]);
3061
3062	return rc != 0;
3063	}

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

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

Download in other formats: