VirtualBox

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

Last change on this file was 102534, checked in by vboxsync, 5 months ago

Main/Unattended: Renamed the attribute "IUnattended::password" to "IUnattended::userPassword". Added new getter/setter attribute "IUnattended::adminPassword", to set a dedicated admin / root password. If not specified explicitly, the password from "IUnattended::userPassword" will be used. Extended testcases. bugref:10554
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.0 KB
Line 
1/* $Id: UnattendedImpl.h 102534 2023-12-08 11:06:41Z vboxsync $ */
2/** @file
3 * Unattended class header
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#ifndef MAIN_INCLUDED_UnattendedImpl_h
29#define MAIN_INCLUDED_UnattendedImpl_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34#include <VBox/ostypes.h>
35#include <iprt/time.h>
36#include "UnattendedWrap.h"
37
38/* Forward declarations. */
39class UnattendedInstaller;
40struct UnattendedInstallationDisk;
41struct ControllerSlot;
42
43/**
44 * A data type to store image data which is read from intall.wim file.
45 * Currently relevant only for Windows OSs.
46 */
47struct WIMImage
48{
49 Utf8Str mName;
50 Utf8Str mVersion;
51 Utf8Str mArch;
52 Utf8Str mFlavor;
53 RTCList<RTCString, RTCString *> mLanguages;
54 Utf8Str mDefaultLanguage;
55 uint32_t mImageIndex;
56 VBOXOSTYPE mOSType;
57 WIMImage() : mImageIndex(0), mOSType(VBOXOSTYPE_Unknown) { }
58 const Utf8Str &formatName(Utf8Str &r_strName) const;
59};
60
61/**
62 * Class implementing the IUnattended interface.
63 *
64 * This class is instantiated on the request by IMachine::getUnattended.
65 */
66class ATL_NO_VTABLE Unattended
67 : public UnattendedWrap
68{
69public:
70 DECLARE_COMMON_CLASS_METHODS(Unattended)
71
72 HRESULT FinalConstruct();
73 void FinalRelease();
74
75 // public initializer/uninitializer for internal purposes only
76 HRESULT initUnattended(VirtualBox *aParent);
77 void uninit();
78
79 // public methods for internal purposes
80 Utf8Str const &i_getIsoPath() const;
81 Utf8Str const &i_getUser() const;
82 Utf8Str const &i_getUserPassword() const;
83 Utf8Str const &i_getAdminPassword() const;
84 Utf8Str const &i_getFullUserName() const;
85 Utf8Str const &i_getProductKey() const;
86 Utf8Str const &i_getProxy() const;
87 Utf8Str const &i_getAdditionsIsoPath() const;
88 bool i_getInstallGuestAdditions() const;
89 Utf8Str const &i_getValidationKitIsoPath() const;
90 bool i_getInstallTestExecService() const;
91 Utf8Str const &i_getUserPayloadIsoPath() const;
92 bool i_getInstallUserPayload() const;
93 Utf8Str const &i_getTimeZone() const;
94 PCRTTIMEZONEINFO i_getTimeZoneInfo() const;
95 Utf8Str const &i_getLocale() const;
96 Utf8Str const &i_getLanguage() const;
97 Utf8Str const &i_getCountry() const;
98 bool i_isMinimalInstallation() const;
99 Utf8Str const &i_getHostname() const;
100 Utf8Str const &i_getAuxiliaryBasePath() const;
101 ULONG i_getImageIndex() const;
102 Utf8Str const &i_getScriptTemplatePath() const;
103 Utf8Str const &i_getPostInstallScriptTemplatePath() const;
104 Utf8Str const &i_getPostInstallCommand() const;
105 /** The directory where the unattended install config and script is
106 * located, from the perspective of the running unattended install. */
107 Utf8Str const &i_getAuxiliaryInstallDir() const;
108 Utf8Str const &i_getExtraInstallKernelParameters() const;
109 Utf8Str const &i_getAdditionsInstallPackage() const;
110
111 bool i_isRtcUsingUtc() const;
112 bool i_isGuestOs64Bit() const;
113 bool i_isFirmwareEFI() const;
114 Utf8Str const &i_getDetectedOSVersion();
115 bool i_getAvoidUpdatesOverNetwork() const;
116
117private:
118 ComPtr<VirtualBox> const mParent; /**< Strong reference to the parent object (VirtualBox/IMachine). */
119 ComPtr<Machine> mMachine; /**< Strong reference to the machine object (Machine/IMachine). */
120 Guid mMachineUuid; /**< The machine UUID. */
121 RTNATIVETHREAD mhThreadReconfigureVM; /**< Set when reconfigureVM is running. */
122 Utf8Str mStrGuestOsTypeId; /**< Guest OS type ID (set by prepare). */
123 bool mfRtcUseUtc; /**< Copy of IMachine::RTCUseUTC (locking reasons). */
124 bool mfGuestOs64Bit; /**< 64-bit (true) or 32-bit guest OS (set by prepare). */
125 FirmwareType_T menmFirmwareType; /**< Firmware type BIOS/EFI (set by prepare). */
126 UnattendedInstaller *mpInstaller; /**< The installer instance (set by prepare, deleted by done). */
127
128 /** @name Values of the IUnattended attributes.
129 * @{ */
130 Utf8Str mStrUser;
131 Utf8Str mStrUserPassword;
132 Utf8Str mStrAdminPassword;
133 Utf8Str mStrFullUserName;
134 Utf8Str mStrProductKey;
135 Utf8Str mStrIsoPath;
136 Utf8Str mStrAdditionsIsoPath;
137 bool mfInstallGuestAdditions;
138 bool mfInstallTestExecService;
139 Utf8Str mStrValidationKitIsoPath;
140 Utf8Str mStrUserPayloadIsoPath;
141 bool mfInstallUserPayload;
142 Utf8Str mStrTimeZone;
143 PCRTTIMEZONEINFO mpTimeZoneInfo;
144 Utf8Str mStrLocale;
145 Utf8Str mStrLanguage; /**< (only relevant for windows at the moment) */
146 Utf8Str mStrCountry;
147 RTCList<RTCString, RTCString *> mPackageSelectionAdjustments;
148 Utf8Str mStrHostname;
149 Utf8Str mStrAuxiliaryBasePath;
150 bool mfIsDefaultAuxiliaryBasePath;
151 ULONG midxImage;
152 Utf8Str mStrScriptTemplatePath;
153 Utf8Str mStrPostInstallScriptTemplatePath;
154 Utf8Str mStrPostInstallCommand;
155 Utf8Str mStrExtraInstallKernelParameters;
156 Utf8Str mStrProxy;
157 Utf8Str mStrAdditionsInstallPackage;
158
159 bool mfDoneDetectIsoOS; /**< Set by detectIsoOS(), cleared by setIsoPath(). */
160 Utf8Str mStrDetectedOSTypeId;
161 Utf8Str mStrDetectedOSVersion;
162 Utf8Str mStrDetectedOSFlavor;
163 VBOXOSTYPE mEnmOsType;
164 RTCList<RTCString, RTCString *> mDetectedOSLanguages; /**< (only relevant for windows at the moment) */
165 Utf8Str mStrDetectedOSHints;
166 RTCList<WIMImage> mDetectedImages;
167 bool mfAvoidUpdatesOverNetwork;
168 /** @} */
169
170 // wrapped IUnattended functions:
171
172 /**
173 * Checks what mStrIsoPath points to and sets the detectedOS* properties.
174 */
175 HRESULT detectIsoOS();
176
177 /**
178 * Prepare any data, environment, etc.
179 */
180 HRESULT prepare();
181
182 /**
183 * Prepare installation ISO/floppy.
184 */
185 HRESULT constructMedia();
186
187 /**
188 * Prepare a VM to run an unattended installation
189 */
190 HRESULT reconfigureVM();
191
192 /**
193 * Done with all media construction and VM configuration and stuff.
194 */
195 HRESULT done();
196
197 // wrapped IUnattended attributes:
198 HRESULT getIsoPath(com::Utf8Str &isoPath);
199 HRESULT setIsoPath(const com::Utf8Str &isoPath);
200 HRESULT getUser(com::Utf8Str &user);
201 HRESULT setUser(const com::Utf8Str &user);
202 HRESULT getUserPassword(com::Utf8Str &password);
203 HRESULT setUserPassword(const com::Utf8Str &password);
204 HRESULT getAdminPassword(com::Utf8Str &password);
205 HRESULT setAdminPassword(const com::Utf8Str &password);
206 HRESULT getFullUserName(com::Utf8Str &user);
207 HRESULT setFullUserName(const com::Utf8Str &user);
208 HRESULT getProductKey(com::Utf8Str &productKey);
209 HRESULT setProductKey(const com::Utf8Str &productKey);
210 HRESULT getAdditionsIsoPath(com::Utf8Str &additionsIsoPath);
211 HRESULT setAdditionsIsoPath(const com::Utf8Str &additionsIsoPath);
212 HRESULT getInstallGuestAdditions(BOOL *installGuestAdditions);
213 HRESULT setInstallGuestAdditions(BOOL installGuestAdditions);
214 HRESULT getValidationKitIsoPath(com::Utf8Str &aValidationKitIsoPath);
215 HRESULT setValidationKitIsoPath(const com::Utf8Str &aValidationKitIsoPath);
216 HRESULT getInstallTestExecService(BOOL *aInstallTestExecService);
217 HRESULT setInstallTestExecService(BOOL aInstallTestExecService);
218 HRESULT getUserPayloadIsoPath(com::Utf8Str &aUserPayloadIsoPath);
219 HRESULT setUserPayloadIsoPath(const com::Utf8Str &aUserPayloadIsoPath);
220 HRESULT getInstallUserPayload(BOOL *aInstallUserPayload);
221 HRESULT setInstallUserPayload(BOOL aInstallUserPayload);
222 HRESULT getTimeZone(com::Utf8Str &aTimezone);
223 HRESULT setTimeZone(const com::Utf8Str &aTimezone);
224 HRESULT getKeyboardLayout(com::Utf8Str &aKeyboardLayout);
225 HRESULT setKeyboardLayout(const com::Utf8Str &aKeyboardLayout);
226 HRESULT getKeyboardVariant(com::Utf8Str &aKeyboardVariant);
227 HRESULT setKeyboardVariant(const com::Utf8Str &aKeyboardVariant);
228 HRESULT getLocale(com::Utf8Str &aLocale);
229 HRESULT setLocale(const com::Utf8Str &aLocale);
230 HRESULT getLanguage(com::Utf8Str &aLanguage);
231 HRESULT setLanguage(const com::Utf8Str &aLanguage);
232 HRESULT getCountry(com::Utf8Str &aCountry);
233 HRESULT setCountry(const com::Utf8Str &aCountry);
234 HRESULT getProxy(com::Utf8Str &aProxy);
235 HRESULT setProxy(const com::Utf8Str &aProxy);
236 HRESULT getPackageSelectionAdjustments(com::Utf8Str &aPackageSelectionAdjustments);
237 HRESULT setPackageSelectionAdjustments(const com::Utf8Str &aPackageSelectionAdjustments);
238 HRESULT getHostname(com::Utf8Str &aHostname);
239 HRESULT setHostname(const com::Utf8Str &aHostname);
240 HRESULT getAuxiliaryBasePath(com::Utf8Str &aAuxiliaryBasePath);
241 HRESULT setAuxiliaryBasePath(const com::Utf8Str &aAuxiliaryBasePath);
242 HRESULT getImageIndex(ULONG *index);
243 HRESULT setImageIndex(ULONG index);
244 HRESULT getMachine(ComPtr<IMachine> &aMachine);
245 HRESULT setMachine(const ComPtr<IMachine> &aMachine);
246 HRESULT getScriptTemplatePath(com::Utf8Str &aScriptTemplatePath);
247 HRESULT setScriptTemplatePath(const com::Utf8Str &aScriptTemplatePath);
248 HRESULT getPostInstallScriptTemplatePath(com::Utf8Str &aPostInstallScriptTemplatePath);
249 HRESULT setPostInstallScriptTemplatePath(const com::Utf8Str &aPostInstallScriptTemplatePath);
250 HRESULT getPostInstallCommand(com::Utf8Str &aPostInstallCommand);
251 HRESULT setPostInstallCommand(const com::Utf8Str &aPostInstallCommand);
252 HRESULT getExtraInstallKernelParameters(com::Utf8Str &aExtraInstallKernelParameters);
253 HRESULT setExtraInstallKernelParameters(const com::Utf8Str &aExtraInstallKernelParameters);
254 HRESULT getDetectedOSTypeId(com::Utf8Str &aDetectedOSTypeId);
255 HRESULT getDetectedOSVersion(com::Utf8Str &aDetectedOSVersion);
256 HRESULT getDetectedOSLanguages(com::Utf8Str &aDetectedOSLanguages);
257 HRESULT getDetectedOSFlavor(com::Utf8Str &aDetectedOSFlavor);
258 HRESULT getDetectedOSHints(com::Utf8Str &aDetectedOSHints);
259 HRESULT getDetectedImageNames(std::vector<com::Utf8Str> &aDetectedImageNames);
260 HRESULT getDetectedImageIndices(std::vector<ULONG> &aDetectedImageIndices);
261 HRESULT getIsUnattendedInstallSupported(BOOL *aIsUnattendedInstallSupported);
262 HRESULT getAvoidUpdatesOverNetwork(BOOL *aAvoidUpdatesOverNetwork);
263 HRESULT setAvoidUpdatesOverNetwork(BOOL aAvoidUpdatesOverNetwork);
264 //internal functions
265
266 /**
267 * Worker for detectIsoOs().
268 *
269 * @returns COM status code.
270 * @retval S_OK if detected.
271 * @retval S_FALSE if not detected.
272 *
273 * @param hVfsIso The ISO file system handle.
274 */
275 HRESULT i_innerDetectIsoOS(RTVFS hVfsIso);
276 typedef union DETECTBUFFER
277 {
278 char sz[4096];
279 char ach[4096];
280 uint8_t ab[4096];
281 uint32_t au32[1024];
282 } DETECTBUFFER;
283 HRESULT i_innerDetectIsoOSWindows(RTVFS hVfsIso, DETECTBUFFER *puBuf);
284 HRESULT i_innerDetectIsoOSLinux(RTVFS hVfsIso, DETECTBUFFER *puBuf);
285 HRESULT i_innerDetectIsoOSLinuxFedora(RTVFS hVfsIso, DETECTBUFFER *puBuf, char *pszVolId);
286 HRESULT i_innerDetectIsoOSOs2(RTVFS hVfsIso, DETECTBUFFER *puBuf);
287 HRESULT i_innerDetectIsoOSFreeBsd(RTVFS hVfsIso, DETECTBUFFER *puBuf);
288
289 /**
290 * Worker for reconfigureVM().
291 * The caller makes sure to close the session whatever happens.
292 */
293 HRESULT i_innerReconfigureVM(AutoMultiWriteLock2 &rAutoLock, StorageBus_T enmRecommendedStorageBus,
294 ComPtr<IMachine> const &rPtrSessionMachine);
295 HRESULT i_reconfigureFloppy(com::SafeIfaceArray<IStorageController> &rControllers,
296 std::vector<UnattendedInstallationDisk> &rVecInstallatationDisks,
297 ComPtr<IMachine> const &rPtrSessionMachine,
298 AutoMultiWriteLock2 &rAutoLock);
299 HRESULT i_reconfigureIsos(com::SafeIfaceArray<IStorageController> &rControllers,
300 std::vector<UnattendedInstallationDisk> &rVecInstallatationDisks,
301 ComPtr<IMachine> const &rPtrSessionMachine,
302 AutoMultiWriteLock2 &rAutoLock, StorageBus_T enmRecommendedStorageBus);
303
304 /**
305 * Adds all free slots on the controller to @a rOutput.
306 */
307 HRESULT i_findOrCreateNeededFreeSlots(const Utf8Str &rStrControllerName, StorageBus_T enmStorageBus,
308 ComPtr<IMachine> const &rPtrSessionMachine, uint32_t cSlotsNeeded,
309 std::list<ControllerSlot> &rDvdSlots);
310
311 /**
312 * Attach to VM a disk
313 */
314 HRESULT i_attachImage(UnattendedInstallationDisk const *pImage, ComPtr<IMachine> const &rPtrSessionMachine,
315 AutoMultiWriteLock2 &rLock);
316
317 /*
318 * Wrapper functions
319 */
320
321 /**
322 * Check whether guest is 64bit platform or not
323 */
324 bool i_isGuestOSArchX64(Utf8Str const &rStrGuestOsTypeId);
325
326 /**
327 * Updates the detected attributes when the image index or image list changes.
328 *
329 * @returns true if we've got all necessary stuff for a successful detection.
330 */
331 bool i_updateDetectedAttributeForImage(WIMImage const &rImage);
332
333};
334
335#endif /* !MAIN_INCLUDED_UnattendedImpl_h */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use