VirtualBox

source: vbox/trunk/src/VBox/Main/include/UnattendedImpl.h@ 90434

Last change on this file since 90434 was 86274, checked in by vboxsync, 4 years ago

bugref:9781. New function Unattended::i_getDetectedOSVersion(). New function UnattendedScriptTemplate::getGuestOSConditional(). New placeholders @@VBOX_GUEST_OS_COND_VERSION@@, @@VBOX_INSERT_GUEST_OS_VERSION@@, @@VBOX_INSERT_GUEST_OS_MAJOR_VERSION@@.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.0 KB
Line 
1/* $Id: UnattendedImpl.h 86274 2020-09-24 19:52:56Z vboxsync $ */
2/** @file
3 * Unattended class header
4 */
5
6/*
7 * Copyright (C) 2006-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef MAIN_INCLUDED_UnattendedImpl_h
19#define MAIN_INCLUDED_UnattendedImpl_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include <VBox/ostypes.h>
25#include <iprt/time.h>
26#include "UnattendedWrap.h"
27
28/* Forward declarations. */
29class UnattendedInstaller;
30struct UnattendedInstallationDisk;
31struct ControllerSlot;
32
33
34/**
35 * Class implementing the IUnattended interface.
36 *
37 * This class is instantiated on the request by IMachine::getUnattended.
38 */
39class ATL_NO_VTABLE Unattended
40 : public UnattendedWrap
41{
42public:
43 DECLARE_EMPTY_CTOR_DTOR(Unattended)
44
45 HRESULT FinalConstruct();
46 void FinalRelease();
47
48 // public initializer/uninitializer for internal purposes only
49 HRESULT initUnattended(VirtualBox *aParent);
50 void uninit();
51
52 // public methods for internal purposes
53 Utf8Str const &i_getIsoPath() const;
54 Utf8Str const &i_getUser() const;
55 Utf8Str const &i_getPassword() const;
56 Utf8Str const &i_getFullUserName() const;
57 Utf8Str const &i_getProductKey() const;
58 Utf8Str const &i_getProxy() const;
59 Utf8Str const &i_getAdditionsIsoPath() const;
60 bool i_getInstallGuestAdditions() const;
61 Utf8Str const &i_getValidationKitIsoPath() const;
62 bool i_getInstallTestExecService() const;
63 Utf8Str const &i_getTimeZone() const;
64 PCRTTIMEZONEINFO i_getTimeZoneInfo() const;
65 Utf8Str const &i_getLocale() const;
66 Utf8Str const &i_getLanguage() const;
67 Utf8Str const &i_getCountry() const;
68 bool i_isMinimalInstallation() const;
69 Utf8Str const &i_getHostname() const;
70 Utf8Str const &i_getAuxiliaryBasePath() const;
71 ULONG i_getImageIndex() const;
72 Utf8Str const &i_getScriptTemplatePath() const;
73 Utf8Str const &i_getPostInstallScriptTemplatePath() const;
74 Utf8Str const &i_getPostInstallCommand() const;
75 Utf8Str const &i_getExtraInstallKernelParameters() const;
76
77 bool i_isRtcUsingUtc() const;
78 bool i_isGuestOs64Bit() const;
79 VBOXOSTYPE i_getGuestOsType() const;
80 Utf8Str const &i_getDetectedOSVersion();
81
82
83private:
84 ComPtr<VirtualBox> const mParent; /**< Strong reference to the parent object (VirtualBox/IMachine). */
85 ComPtr<Machine> mMachine; /**< Strong reference to the machine object (Machine/IMachine). */
86 Guid mMachineUuid; /**< The machine UUID. */
87 RTNATIVETHREAD mhThreadReconfigureVM; /**< Set when reconfigureVM is running. */
88 Utf8Str mStrGuestOsTypeId; /**< Guest OS type ID (set by prepare). */
89 bool mfRtcUseUtc; /**< Copy of IMachine::RTCUseUTC (locking reasons). */
90 bool mfGuestOs64Bit; /**< 64-bit (true) or 32-bit guest OS (set by prepare). */
91 VBOXOSTYPE meGuestOsType; /**< The guest OS type (set by prepare). */
92 UnattendedInstaller *mpInstaller; /**< The installer instance (set by prepare, deleted by done). */
93
94 /** @name Values of the IUnattended attributes.
95 * @{ */
96 Utf8Str mStrUser;
97 Utf8Str mStrPassword;
98 Utf8Str mStrFullUserName;
99 Utf8Str mStrProductKey;
100 Utf8Str mStrIsoPath;
101 Utf8Str mStrAdditionsIsoPath;
102 bool mfInstallGuestAdditions;
103 bool mfInstallTestExecService;
104 Utf8Str mStrValidationKitIsoPath;
105 Utf8Str mStrTimeZone;
106 PCRTTIMEZONEINFO mpTimeZoneInfo;
107 Utf8Str mStrLocale;
108 Utf8Str mStrLanguage; /**< (only relevant for windows at the moment) */
109 Utf8Str mStrCountry;
110 RTCList<RTCString, RTCString *> mPackageSelectionAdjustments;
111 Utf8Str mStrHostname;
112 Utf8Str mStrAuxiliaryBasePath;
113 bool mfIsDefaultAuxiliaryBasePath;
114 ULONG midxImage;
115 Utf8Str mStrScriptTemplatePath;
116 Utf8Str mStrPostInstallScriptTemplatePath;
117 Utf8Str mStrPostInstallCommand;
118 Utf8Str mStrExtraInstallKernelParameters;
119
120 bool mfDoneDetectIsoOS; /**< Set by detectIsoOS(), cleared by setIsoPath(). */
121 Utf8Str mStrDetectedOSTypeId;
122 Utf8Str mStrDetectedOSVersion;
123 Utf8Str mStrDetectedOSFlavor;
124 RTCList<RTCString, RTCString *> mDetectedOSLanguages; /**< (only relevant for windows at the moment) */
125 Utf8Str mStrDetectedOSHints;
126 Utf8Str mStrProxy;
127 /** @} */
128
129 // wrapped IUnattended functions:
130
131 /**
132 * Checks what mStrIsoPath points to and sets the detectedOS* properties.
133 */
134 HRESULT detectIsoOS();
135
136 /**
137 * Prepare any data, environment, etc.
138 */
139 HRESULT prepare();
140
141 /**
142 * Prepare installation ISO/floppy.
143 */
144 HRESULT constructMedia();
145
146 /**
147 * Prepare a VM to run an unattended installation
148 */
149 HRESULT reconfigureVM();
150
151 /**
152 * Done with all media construction and VM configuration and stuff.
153 */
154 HRESULT done();
155
156 // wrapped IUnattended attributes:
157 HRESULT getIsoPath(com::Utf8Str &isoPath);
158 HRESULT setIsoPath(const com::Utf8Str &isoPath);
159 HRESULT getUser(com::Utf8Str &user);
160 HRESULT setUser(const com::Utf8Str &user);
161 HRESULT getPassword(com::Utf8Str &password);
162 HRESULT setPassword(const com::Utf8Str &password);
163 HRESULT getFullUserName(com::Utf8Str &user);
164 HRESULT setFullUserName(const com::Utf8Str &user);
165 HRESULT getProductKey(com::Utf8Str &productKey);
166 HRESULT setProductKey(const com::Utf8Str &productKey);
167 HRESULT getAdditionsIsoPath(com::Utf8Str &additionsIsoPath);
168 HRESULT setAdditionsIsoPath(const com::Utf8Str &additionsIsoPath);
169 HRESULT getInstallGuestAdditions(BOOL *installGuestAdditions);
170 HRESULT setInstallGuestAdditions(BOOL installGuestAdditions);
171 HRESULT getValidationKitIsoPath(com::Utf8Str &aValidationKitIsoPath);
172 HRESULT setValidationKitIsoPath(const com::Utf8Str &aValidationKitIsoPath);
173 HRESULT getInstallTestExecService(BOOL *aInstallTestExecService);
174 HRESULT setInstallTestExecService(BOOL aInstallTestExecService);
175 HRESULT getTimeZone(com::Utf8Str &aTimezone);
176 HRESULT setTimeZone(const com::Utf8Str &aTimezone);
177 HRESULT getLocale(com::Utf8Str &aLocale);
178 HRESULT setLocale(const com::Utf8Str &aLocale);
179 HRESULT getLanguage(com::Utf8Str &aLanguage);
180 HRESULT setLanguage(const com::Utf8Str &aLanguage);
181 HRESULT getCountry(com::Utf8Str &aCountry);
182 HRESULT setCountry(const com::Utf8Str &aCountry);
183 HRESULT getProxy(com::Utf8Str &aProxy);
184 HRESULT setProxy(const com::Utf8Str &aProxy);
185 HRESULT getPackageSelectionAdjustments(com::Utf8Str &aPackageSelectionAdjustments);
186 HRESULT setPackageSelectionAdjustments(const com::Utf8Str &aPackageSelectionAdjustments);
187 HRESULT getHostname(com::Utf8Str &aHostname);
188 HRESULT setHostname(const com::Utf8Str &aHostname);
189 HRESULT getAuxiliaryBasePath(com::Utf8Str &aAuxiliaryBasePath);
190 HRESULT setAuxiliaryBasePath(const com::Utf8Str &aAuxiliaryBasePath);
191 HRESULT getImageIndex(ULONG *index);
192 HRESULT setImageIndex(ULONG index);
193 HRESULT getMachine(ComPtr<IMachine> &aMachine);
194 HRESULT setMachine(const ComPtr<IMachine> &aMachine);
195 HRESULT getScriptTemplatePath(com::Utf8Str &aScriptTemplatePath);
196 HRESULT setScriptTemplatePath(const com::Utf8Str &aScriptTemplatePath);
197 HRESULT getPostInstallScriptTemplatePath(com::Utf8Str &aPostInstallScriptTemplatePath);
198 HRESULT setPostInstallScriptTemplatePath(const com::Utf8Str &aPostInstallScriptTemplatePath);
199 HRESULT getPostInstallCommand(com::Utf8Str &aPostInstallCommand);
200 HRESULT setPostInstallCommand(const com::Utf8Str &aPostInstallCommand);
201 HRESULT getExtraInstallKernelParameters(com::Utf8Str &aExtraInstallKernelParameters);
202 HRESULT setExtraInstallKernelParameters(const com::Utf8Str &aExtraInstallKernelParameters);
203 HRESULT getDetectedOSTypeId(com::Utf8Str &aDetectedOSTypeId);
204 HRESULT getDetectedOSVersion(com::Utf8Str &aDetectedOSVersion);
205 HRESULT getDetectedOSLanguages(com::Utf8Str &aDetectedOSLanguages);
206 HRESULT getDetectedOSFlavor(com::Utf8Str &aDetectedOSFlavor);
207 HRESULT getDetectedOSHints(com::Utf8Str &aDetectedOSHints);
208 //internal functions
209
210 /**
211 * Worker for detectIsoOs().
212 *
213 * @returns COM status code.
214 * @retval S_OK if detected.
215 * @retval S_FALSE if not detected.
216 *
217 * @param hVfsIso The ISO file system handle.
218 */
219 HRESULT i_innerDetectIsoOS(RTVFS hVfsIso);
220 typedef union DETECTBUFFER
221 {
222 char sz[4096];
223 char ach[4096];
224 uint8_t ab[4096];
225 uint32_t au32[1024];
226 } DETECTBUFFER;
227 HRESULT i_innerDetectIsoOSWindows(RTVFS hVfsIso, DETECTBUFFER *puBuf, VBOXOSTYPE *penmOsType);
228 HRESULT i_innerDetectIsoOSLinux(RTVFS hVfsIso, DETECTBUFFER *puBuf, VBOXOSTYPE *penmOsType);
229
230 /**
231 * Worker for reconfigureVM().
232 * The caller makes sure to close the session whatever happens.
233 */
234 HRESULT i_innerReconfigureVM(AutoMultiWriteLock2 &rAutoLock, StorageBus_T enmRecommendedStorageBus,
235 ComPtr<IMachine> const &rPtrSessionMachine);
236 HRESULT i_reconfigureFloppy(com::SafeIfaceArray<IStorageController> &rControllers,
237 std::vector<UnattendedInstallationDisk> &rVecInstallatationDisks,
238 ComPtr<IMachine> const &rPtrSessionMachine,
239 AutoMultiWriteLock2 &rAutoLock);
240 HRESULT i_reconfigureIsos(com::SafeIfaceArray<IStorageController> &rControllers,
241 std::vector<UnattendedInstallationDisk> &rVecInstallatationDisks,
242 ComPtr<IMachine> const &rPtrSessionMachine,
243 AutoMultiWriteLock2 &rAutoLock, StorageBus_T enmRecommendedStorageBus);
244
245 /**
246 * Adds all free slots on the controller to @a rOutput.
247 */
248 HRESULT i_findOrCreateNeededFreeSlots(const Utf8Str &rStrControllerName, StorageBus_T enmStorageBus,
249 ComPtr<IMachine> const &rPtrSessionMachine, uint32_t cSlotsNeeded,
250 std::list<ControllerSlot> &rDvdSlots);
251
252 /**
253 * Attach to VM a disk
254 */
255 HRESULT i_attachImage(UnattendedInstallationDisk const *pImage, ComPtr<IMachine> const &rPtrSessionMachine,
256 AutoMultiWriteLock2 &rLock);
257
258 /*
259 * Wrapper functions
260 */
261
262 /**
263 * Check whether guest is 64bit platform or not
264 */
265 bool i_isGuestOSArchX64(Utf8Str const &rStrGuestOsTypeId);
266};
267
268#endif /* !MAIN_INCLUDED_UnattendedImpl_h */
269
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