VirtualBox

source: vbox/trunk/src/VBox/Main/include/UnattendedInstaller.h@ 101381

Last change on this file since 101381 was 101356, checked in by vboxsync, 8 months ago

Unattended: ​bugref:10530. Looks like OL8 kickstart used to include a removed command.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 38.1 KB
Line 
1/* $Id: UnattendedInstaller.h 101356 2023-10-05 12:44:33Z vboxsync $ */
2/** @file
3 * UnattendedInstaller 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_UnattendedInstaller_h
29#define MAIN_INCLUDED_UnattendedInstaller_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34#include "UnattendedScript.h"
35
36/* Forward declarations */
37class Unattended;
38class UnattendedInstaller;
39class BaseTextScript;
40
41
42/**
43 * The abstract UnattendedInstaller class declaration
44 *
45 * The class is intended to service a new VM that this VM will be able to
46 * execute an unattended installation
47 */
48class UnattendedInstaller : public RTCNonCopyable
49{
50/*data*/
51protected:
52 /** Main unattended installation script. */
53 UnattendedScriptTemplate mMainScript;
54 /** Full path to the main template file (set by initInstaller). */
55 Utf8Str mStrMainScriptTemplate;
56
57 /** Post installation (shell) script. */
58 UnattendedScriptTemplate mPostScript;
59 /** Full path to the post template file (set by initInstaller). */
60 Utf8Str mStrPostScriptTemplate;
61
62 /** Pointer to the parent object.
63 * We use this for setting errors and querying attributes. */
64 Unattended *mpParent;
65 /** The path of the extra ISO image we create (set by initInstaller).
66 * This is only valid when isAdditionsIsoNeeded() returns true. */
67 Utf8Str mStrAuxiliaryIsoFilePath;
68 /** The path of the extra floppy image we create (set by initInstaller)
69 * This is only valid when isAdditionsFloppyNeeded() returns true. */
70 Utf8Str mStrAuxiliaryFloppyFilePath;
71 /** The boot device. */
72 DeviceType_T const meBootDevice;
73 /** Default extra install kernel parameters (set by constructor).
74 * This can be overridden by the extraInstallKernelParameters attribute of
75 * IUnattended. */
76 Utf8Str mStrDefaultExtraInstallKernelParameters;
77 /** The directory of the post install script in the unattended install
78 * environment, i.e. when it gets started by the unattended installer
79 * of the respective guest OS. */
80 Utf8Str mStrAuxiliaryInstallDir;
81
82private:
83 UnattendedInstaller(); /* no default constructors */
84
85public:
86 DECLARE_TRANSLATE_METHODS(UnattendedInstaller)
87
88 /**
89 * Regular constructor.
90 *
91 * @param pParent The parent object. Used for setting
92 * errors and querying attributes.
93 * @param pszMainScriptTemplateName The name of the template file (no path)
94 * for the main unattended installer
95 * script.
96 * @param pszPostScriptTemplateName The name of the template file (no path)
97 * for the post installation script.
98 * @param pszMainScriptFilename The main unattended installer script
99 * filename (on aux media).
100 * @param pszPostScriptFilename The post installation script filename
101 * (on aux media).
102 * @param enmBootDevice The boot device type.
103 */
104 UnattendedInstaller(Unattended *pParent,
105 const char *pszMainScriptTemplateName, const char *pszPostScriptTemplateName,
106 const char *pszMainScriptFilename, const char *pszPostScriptFilename,
107 DeviceType_T enmBootDevice = DeviceType_DVD);
108 virtual ~UnattendedInstaller();
109
110 /**
111 * Instantiates the appropriate child class.
112 *
113 * @returns Pointer to the new instance, NULL if no appropriate installer.
114 * @param enmDetectedOSType The detected guest OS type value.
115 * @param strDetectedOSType The detected guest OS type string
116 * @param strDetectedOSVersion The detected guest OS version.
117 * @param strDetectedOSFlavor The detected guest OS flavor.
118 * @param strDetectedOSHints Hints about the detected guest OS.
119 * @param pParent The parent object. Used for setting errors
120 * and querying attributes.
121 * @throws std::bad_alloc
122 */
123 static UnattendedInstaller *createInstance(VBOXOSTYPE enmDetectedOSType, const Utf8Str &strDetectedOSType,
124 const Utf8Str &strDetectedOSVersion, const Utf8Str &strDetectedOSFlavor,
125 const Utf8Str &strDetectedOSHints, Unattended *pParent);
126
127 /**
128 * Initialize the installer.
129 *
130 * @note This is called immediately after instantiation and the caller will
131 * always destroy the unattended installer instance on failure, so it
132 * is not necessary to keep track of whether this succeeded or not.
133 */
134 virtual HRESULT initInstaller();
135
136#if 0 /* These are now in the AUX VISO. */
137 /**
138 * Whether the VBox Guest Additions ISO is needed or not.
139 *
140 * The default implementation always returns false when a VISO is used, see
141 * UnattendedInstaller::addFilesToAuxVisoVectors.
142 */
143 virtual bool isAdditionsIsoNeeded() const;
144
145 /**
146 * Whether the VBox validation kit ISO is needed or not.
147 *
148 * The default implementation always returns false when a VISO is used, see
149 * UnattendedInstaller::addFilesToAuxVisoVectors.
150 */
151 virtual bool isValidationKitIsoNeeded() const;
152#endif
153
154 /**
155 * Indicates whether an original installation ISO is needed or not.
156 */
157 virtual bool isOriginalIsoNeeded() const { return true; }
158
159 /**
160 * Indicates whether a floppy image is needed or not.
161 */
162 virtual bool isAuxiliaryFloppyNeeded() const { return false; }
163
164 /**
165 * Indicates whether an additional or replacement ISO image is needed or not.
166 */
167 virtual bool isAuxiliaryIsoNeeded() const;
168
169 /**
170 * Indicates whether we should boot from the auxiliary ISO image.
171 *
172 * Will boot from installation ISO if false.
173 */
174 virtual bool bootFromAuxiliaryIso() const { return isAuxiliaryIsoNeeded(); }
175
176 /**
177 * Indicates whether a the auxiliary ISO is a .viso-file rather than an
178 * .iso-file.
179 *
180 * Different worker methods are used depending on the return value. A
181 * .viso-file is generally only used when the installation media needs to
182 * be remastered with small changes and additions.
183 */
184 virtual bool isAuxiliaryIsoIsVISO() const { return true; }
185
186 /*
187 * Getters
188 */
189 DeviceType_T getBootableDeviceType() const { return meBootDevice; }
190 const Utf8Str &getTemplateFilePath() const { return mStrMainScriptTemplate; }
191 const Utf8Str &getPostTemplateFilePath() const { return mStrPostScriptTemplate; }
192 const Utf8Str &getAuxiliaryIsoFilePath() const { return mStrAuxiliaryIsoFilePath; }
193 const Utf8Str &getAuxiliaryFloppyFilePath() const { return mStrAuxiliaryFloppyFilePath; }
194 const Utf8Str &getDefaultExtraInstallKernelParameters() const { return mStrDefaultExtraInstallKernelParameters; }
195 const Utf8Str &getAuxiliaryInstallDir() const { return mStrAuxiliaryInstallDir; }
196
197 /*
198 * Setters
199 */
200 void setTemplatePath(const Utf8Str& data); /**< @todo r=bird: This is confusing as heck. Dir for a while, then it's a file. Not a comment about it. Brilliant. */
201
202 /**
203 * Prepares the unattended scripts, does all but write them to the installation
204 * media.
205 */
206 HRESULT prepareUnattendedScripts();
207
208 /**
209 * Prepares the media - floppy image, ISO image.
210 *
211 * This method calls prepareAuxFloppyImage() and prepareAuxIsoImage(), child
212 * classes may override these methods or methods they call.
213 *
214 * @returns COM status code.
215 * @param fOverwrite Whether to overwrite media files or fail if they
216 * already exist.
217 */
218 HRESULT prepareMedia(bool fOverwrite = true);
219
220protected:
221 /**
222 * Prepares (creates) the auxiliary floppy image.
223 *
224 * This is called by the base class prepareMedia() when
225 * isAuxiliaryFloppyNeeded() is true. The base class implementation puts the
226 * edited unattended script onto it.
227 */
228 HRESULT prepareAuxFloppyImage(bool fOverwrite);
229
230 /**
231 * Creates and formats (FAT12) a floppy image.
232 *
233 * This can be overridden to do more preparation work or/and create a different
234 * sized floppy.
235 *
236 * @returns COM status code.
237 * @param pszFilename The path to the image file.
238 * @param fOverwrite Whether to overwrite the file.
239 * @param phVfsFile Where to return a read-writable handle to the newly
240 * created image.
241 */
242 virtual HRESULT newAuxFloppyImage(const char *pszFilename, bool fOverwrite, PRTVFSFILE phVfsFile);
243
244 /**
245 * Copies files to the auxiliary floppy image.
246 *
247 * The base class implementation copies the main and post scripts to the root of
248 * the floppy using the default script names. Child classes may override this
249 * to add additional or different files.
250 *
251 * @returns COM status code.
252 * @param hVfs The floppy image VFS handle.
253 */
254 virtual HRESULT copyFilesToAuxFloppyImage(RTVFS hVfs);
255
256 /**
257 * Adds the given script to the root of the floppy image under the default
258 * script filename.
259 *
260 * @returns COM status code.
261 * @param pEditor The script to add.
262 * @param hVfs The VFS to add it to.
263 */
264 HRESULT addScriptToFloppyImage(BaseTextScript *pEditor, RTVFS hVfs);
265
266 /**
267 * Copy an arbritrary file onto the floopy image.
268 *
269 * @returns COM status code.
270 * @param hVfs The VFS to add it to.
271 * @param pszSrc The source filename.
272 * @param pszDst The destination filename (on @a hVfs).
273 */
274 HRESULT addFileToFloppyImage(RTVFS hVfs, const char *pszSrc, const char *pszDst);
275
276 /**
277 * Prepares (creates) the auxiliary ISO image.
278 *
279 * This is called by the base class prepareMedia() when isAuxiliaryIsoNeeded()
280 * is true. The base class implementation puts the edited unattended script
281 * onto it.
282 */
283 virtual HRESULT prepareAuxIsoImage(bool fOverwrite);
284
285 /**
286 * Opens the installation ISO image.
287 *
288 * @returns COM status code.
289 * @param phVfsIso Where to return the VFS handle for the ISO.
290 * @param fFlags RTFSISO9660_F_XXX flags to pass to the
291 * RTFsIso9660VolOpen API.
292 */
293 virtual HRESULT openInstallIsoImage(PRTVFS phVfsIso, uint32_t fFlags = 0);
294
295 /**
296 * Creates and configures the ISO maker instance.
297 *
298 * This can be overridden to set configure options.
299 *
300 * @returns COM status code.
301 * @param phIsoMaker Where to return the ISO maker.
302 */
303 virtual HRESULT newAuxIsoImageMaker(PRTFSISOMAKER phIsoMaker);
304
305 /**
306 * Adds files to the auxiliary ISO image maker.
307 *
308 * The base class implementation copies just the mMainScript and mPostScript
309 * files to root directory using the default filenames.
310 *
311 * @returns COM status code.
312 * @param hIsoMaker The ISO maker handle.
313 * @param hVfsOrgIso The VFS handle to the original ISO in case files
314 * needs to be added from it.
315 */
316 virtual HRESULT addFilesToAuxIsoImageMaker(RTFSISOMAKER hIsoMaker, RTVFS hVfsOrgIso);
317
318 /**
319 * Adds the given script to the ISO maker.
320 *
321 * @returns COM status code.
322 * @param pEditor The script to add.
323 * @param hIsoMaker The ISO maker to add it to.
324 * @param pszDstFilename The file name (w/ path) to add it under. If NULL,
325 * the default script filename is used to add it to the
326 * root.
327 */
328 HRESULT addScriptToIsoMaker(BaseTextScript *pEditor, RTFSISOMAKER hIsoMaker, const char *pszDstFilename = NULL);
329
330 /**
331 * Writes the ISO image to disk.
332 *
333 * @returns COM status code.
334 * @param hIsoMaker The ISO maker handle.
335 * @param pszFilename The filename.
336 * @param fOverwrite Whether to overwrite the destination file or not.
337 */
338 HRESULT finalizeAuxIsoImage(RTFSISOMAKER hIsoMaker, const char *pszFilename, bool fOverwrite);
339
340 /**
341 * Adds files to the .viso-file vectors.
342 *
343 * The base class implementation adds the script from mAlg, additions ISO
344 * content to '/vboxadditions', and validation kit ISO to '/vboxvalidationkit'.
345 *
346 * @returns COM status code.
347 * @param rVecArgs The ISO maker argument list that will be turned into
348 * a .viso-file.
349 * @param rVecFiles The list of files we've created. This is for
350 * cleaning up at the end.
351 * @param hVfsOrgIso The VFS handle to the original ISO in case files
352 * needs to be added from it.
353 * @param fOverwrite Whether to overwrite files or not.
354 */
355 virtual HRESULT addFilesToAuxVisoVectors(RTCList<RTCString> &rVecArgs, RTCList<RTCString> &rVecFiles,
356 RTVFS hVfsOrgIso, bool fOverwrite);
357
358 /**
359 * Saves the given script to disk and adds it to the .viso-file vectors.
360 *
361 * @returns COM status code.
362 * @param pEditor The script to add.
363 * @param rVecArgs The ISO maker argument list that will be turned into
364 * a .viso-file.
365 * @param rVecFiles The list of files we've created. This is for
366 * cleaning up at the end.
367 * @param fOverwrite Whether to overwrite files or not.
368 */
369 HRESULT addScriptToVisoVectors(BaseTextScript *pEditor, RTCList<RTCString> &rVecArgs,
370 RTCList<RTCString> &rVecFiles, bool fOverwrite);
371
372 /**
373 * Writes out the .viso-file to disk.
374 *
375 * @returns COM status code.
376 * @param rVecArgs The ISO maker argument list to write out.
377 * @param pszFilename The filename.
378 * @param fOverwrite Whether to overwrite the destination file or not.
379 */
380 HRESULT finalizeAuxVisoFile(RTCList<RTCString> const &rVecArgs, const char *pszFilename, bool fOverwrite);
381
382 /**
383 * Loads @a pszFilename from @a hVfsOrgIso into @a pEditor and parses it.
384 *
385 * @returns COM status code.
386 * @param hVfsOrgIso The handle to the original installation ISO.
387 * @param pszFilename The filename to open and load from the ISO.
388 * @param pEditor The editor instance to load the file into and
389 * do the parseing with.
390 */
391 HRESULT loadAndParseFileFromIso(RTVFS hVfsOrgIso, const char *pszFilename, AbstractScript *pEditor);
392};
393
394
395/**
396 * Windows installer, for versions up to xp 64 / w2k3.
397 */
398class UnattendedWindowsSifInstaller : public UnattendedInstaller
399{
400public:
401 DECLARE_TRANSLATE_METHODS(UnattendedWindowsSifInstaller)
402
403 UnattendedWindowsSifInstaller(Unattended *pParent)
404 : UnattendedInstaller(pParent,
405 "win_nt5_unattended.sif", "win_postinstall.cmd",
406 "WINNT.SIF", "VBOXPOST.CMD")
407 {
408 Assert(isOriginalIsoNeeded()); Assert(isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); Assert(!bootFromAuxiliaryIso());
409 mStrAuxiliaryInstallDir = "A:\\";
410 }
411 ~UnattendedWindowsSifInstaller() {}
412
413 bool isAuxiliaryFloppyNeeded() const { return true; }
414 bool bootFromAuxiliaryIso() const { return false; }
415
416};
417
418/**
419 * Windows installer, for versions starting with Vista.
420 */
421class UnattendedWindowsXmlInstaller : public UnattendedInstaller
422{
423public:
424 DECLARE_TRANSLATE_METHODS(UnattendedWindowsXmlInstaller)
425
426 UnattendedWindowsXmlInstaller(Unattended *pParent)
427 : UnattendedInstaller(pParent,
428 "win_nt6_unattended.xml", "win_postinstall.cmd",
429 "autounattend.xml", "VBOXPOST.CMD")
430 {
431 Assert(isOriginalIsoNeeded()); Assert(isAuxiliaryFloppyNeeded() || isAuxiliaryIsoNeeded()); Assert(isAuxiliaryIsoIsVISO()); Assert(!bootFromAuxiliaryIso());
432 if (isAuxiliaryFloppyNeeded())
433 mStrAuxiliaryInstallDir = "A:\\";
434 else if (bootFromAuxiliaryIso())
435 mStrAuxiliaryInstallDir = "D:\\";
436 else
437 mStrAuxiliaryInstallDir = "E:\\";
438 }
439 ~UnattendedWindowsXmlInstaller() {}
440
441 bool isAuxiliaryFloppyNeeded() const { return !mpParent->i_isFirmwareEFI(); }
442 bool isAuxiliaryIsoNeeded() const { return UnattendedInstaller::isAuxiliaryIsoNeeded() || mpParent->i_isFirmwareEFI(); }
443 bool isAuxiliaryIsoIsVISO() const { return true; }
444 bool bootFromAuxiliaryIso() const { return false; }
445};
446
447
448/**
449 * OS/2 installer.
450 */
451class UnattendedOs2Installer : public UnattendedInstaller
452{
453public:
454 DECLARE_TRANSLATE_METHODS(UnattendedOs2Installer)
455
456 UnattendedOs2Installer(Unattended *pParent, Utf8Str const &rStrHints);
457 ~UnattendedOs2Installer() {}
458
459 /* Remaster original ISO with auxiliary floppy used for el torito floppy emulation: */
460 bool isOriginalIsoNeeded() const RT_OVERRIDE { return false; }
461 bool isAuxiliaryFloppyNeeded() const RT_OVERRIDE { return true; }
462 bool isAuxiliaryIsoNeeded() const RT_OVERRIDE { return true; }
463
464protected:
465 HRESULT replaceAuxFloppyImageBootSector(RTVFSFILE hVfsFile) RT_NOEXCEPT;
466 HRESULT newAuxFloppyImage(const char *pszFilename, bool fOverwrite, PRTVFSFILE phVfsFile) RT_OVERRIDE;
467 HRESULT copyFilesToAuxFloppyImage(RTVFS hVfs) RT_OVERRIDE;
468 HRESULT addFilesToAuxVisoVectors(RTCList<RTCString> &rVecArgs, RTCList<RTCString> &rVecFiles,
469 RTVFS hVfsOrgIso, bool fOverwrite) RT_OVERRIDE;
470
471 HRESULT splitResponseFile() RT_NOEXCEPT;
472
473 /**
474 * Splits up the given file into sub-files and writes them out with the auxilary
475 * path base as prefix.
476 *
477 * The source file contains @@VBOX_SPLITTER_START[filename]@@ and
478 * @@VBOX_SPLITTER_END[filename]@@ markup that is used to split it up. Any
479 * text between END and START tags are ignored and can be used for comments.
480 *
481 * @returns COM status code (error info set).
482 * @param pszFileToSplit The name of the file to split.
483 * @param rVecSplitFiles Vector where names of the sub-files are appended
484 * (without any path or prefix).
485 */
486 HRESULT splitFile(const char *pszFileToSplit, RTCList<RTCString> &rVecSplitFiles) RT_NOEXCEPT;
487
488 /**
489 * Splits up the given editor output into sub-files and writes them out with the
490 * auxilary path base as prefix.
491 *
492 * The source file contains @@VBOX_SPLITTER_START[filename]@@ and
493 * @@VBOX_SPLITTER_END[filename]@@ markup that is used to split it up. Any
494 * text between END and START tags are ignored and can be used for comments.
495 *
496 * @returns COM status code (error info set).
497 * @param pEditor The editor which output should be split.
498 * @param rVecSplitFiles Vector where names of the sub-files are appended
499 * (without any path or prefix).
500 */
501 HRESULT splitFile(BaseTextScript *pEditor, RTCList<RTCString> &rVecSplitFiles) RT_NOEXCEPT;
502
503 HRESULT splitFileInner(const char *pszFileToSplit, RTCList<RTCString> &rVecSplitFiles,
504 const char *pszSrc, size_t cbLeft) RT_NOEXCEPT;
505
506 static int patchTestCfg(uint8_t *pbFile, size_t cbFile, const char *pszFilename, UnattendedOs2Installer *pThis);
507 static int patchOs2Ldr(uint8_t *pbFile, size_t cbFile, const char *pszFilename, UnattendedOs2Installer *pThis);
508
509 /** The OS2SE20.SRC path ("\\OS2IMAGES"). */
510 Utf8Str mStrOs2Images;
511 /** Files split out from os2_response_files.rsp (bare filenames, no paths). */
512 RTCList<RTCString> mVecSplitFiles;
513};
514
515
516
517/**
518 * Base class for the unattended linux installers.
519 */
520class UnattendedLinuxInstaller : public UnattendedInstaller
521{
522protected:
523 /** Array of linux parameter patterns that should be removed by editIsoLinuxCfg.
524 * The patterns are proceed by RTStrSimplePatternNMatch. */
525 RTCList<RTCString, RTCString *> mArrStrRemoveInstallKernelParameters;
526
527public:
528 DECLARE_TRANSLATE_METHODS(UnattendedLinuxInstaller)
529
530 UnattendedLinuxInstaller(Unattended *pParent,
531 const char *pszMainScriptTemplateName, const char *pszPostScriptTemplateName,
532 const char *pszMainScriptFilename, const char *pszPostScriptFilename = "vboxpostinstall.sh")
533 : UnattendedInstaller(pParent,
534 pszMainScriptTemplateName, pszPostScriptTemplateName,
535 pszMainScriptFilename, pszPostScriptFilename) {}
536 ~UnattendedLinuxInstaller() {}
537
538 bool isAuxiliaryIsoNeeded() const { return true; }
539
540protected:
541 /**
542 * Performs basic edits on a isolinux.cfg file.
543 *
544 * @returns COM status code
545 * @param pEditor Editor with the isolinux.cfg file loaded and parsed.
546 */
547 virtual HRESULT editIsoLinuxCfg(GeneralTextScript *pEditor);
548 /**
549 * Performs basic common edits on a isolinux.cfg and menu configuration file(s) (txt.cfg or menu.cfg etc).
550 *
551 * @returns COM status code
552 * @param pEditor Editor with the isolinux.cfg file loaded and parsed.
553 */
554 virtual HRESULT editIsoLinuxCommon(GeneralTextScript *pEditor);
555};
556
557
558/**
559 * Debian installer.
560 *
561 * This will remaster the orignal ISO and therefore be producing a .viso-file.
562 */
563class UnattendedDebianInstaller : public UnattendedLinuxInstaller
564{
565public:
566 DECLARE_TRANSLATE_METHODS(UnattendedDebianInstaller)
567
568 UnattendedDebianInstaller(Unattended *pParent,
569 const char *pszMainScriptTemplateName = "debian_preseed.cfg",
570 const char *pszPostScriptTemplateName = "debian_postinstall.sh",
571 const char *pszMainScriptFilename = "preseed.cfg")
572 : UnattendedLinuxInstaller(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
573 {
574 Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded());
575 Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO());
576 mStrDefaultExtraInstallKernelParameters.setNull();
577 mStrDefaultExtraInstallKernelParameters += " auto=true";
578 mStrDefaultExtraInstallKernelParameters.append(" preseed/file=/cdrom/").append(pszMainScriptFilename);
579 mStrDefaultExtraInstallKernelParameters += " priority=critical";
580 mStrDefaultExtraInstallKernelParameters += " quiet";
581 mStrDefaultExtraInstallKernelParameters += " splash";
582 mStrDefaultExtraInstallKernelParameters += " noprompt"; /* no questions about things like CD/DVD ejections */
583 mStrDefaultExtraInstallKernelParameters += " noshell"; /* No shells on VT1-3 (debian, not ubuntu). */
584 mStrDefaultExtraInstallKernelParameters += " automatic-ubiquity"; // ubiquity
585 // the following can probably go into the preseed.cfg:
586 mStrDefaultExtraInstallKernelParameters.append(" debian-installer/locale=").append(pParent->i_getLocale());
587 mStrDefaultExtraInstallKernelParameters += " keyboard-configuration/layoutcode=us";
588 mStrDefaultExtraInstallKernelParameters += " languagechooser/language-name=English"; /** @todo fixme */
589 mStrDefaultExtraInstallKernelParameters.append(" localechooser/supported-locales=").append(pParent->i_getLocale()).append(".UTF-8");
590 mStrDefaultExtraInstallKernelParameters.append(" countrychooser/shortlist=").append(pParent->i_getCountry()); // ubiquity?
591 mStrDefaultExtraInstallKernelParameters += " --";
592 }
593 ~UnattendedDebianInstaller() {}
594
595 bool isOriginalIsoNeeded() const { return false; }
596
597protected:
598 HRESULT addFilesToAuxVisoVectors(RTCList<RTCString> &rVecArgs, RTCList<RTCString> &rVecFiles,
599 RTVFS hVfsOrgIso, bool fOverwrite);
600 /**
601 * Performs basic edits on menu configuration file(s) of isolinux (txt.cfg or menu.cfg etc).
602 *
603 * @returns COM status code
604 * @param pEditor Editor with the menu config. file loaded and parsed.
605 */
606 HRESULT editDebianMenuCfg(GeneralTextScript *pEditor);
607 /**
608 * Performs basic edits on grub configuration file (grub.cfg).
609 *
610 * @returns COM status code
611 * @param pEditor Editor with the grub.cfg file loaded and parsed.
612 */
613 HRESULT editDebianGrubCfg(GeneralTextScript *pEditor);
614
615 /**
616 * Performs basic edits on a isolinux.cfg file.
617 *
618 * @returns COM status code
619 * @param pEditor Editor with the isolinux.cfg file loaded and parsed.
620 * @param pszMenuConfigFileName Name of the menu config file to include in isolinux.txt. On Debians (at least)
621 it includes the kernel command line with our preseed file and command line argument.
622 */
623 virtual HRESULT editIsoLinuxCfg(GeneralTextScript *pEditor, const char *pszMenuConfigFileName);
624
625private:
626
627 /**
628 * Tries to set label name of a label line.
629 *
630 * @returns true if label line is found and label name can be set.
631 * @param pEditor Editor with the menu configuration file loaded and parsed.
632 * @param vecLineNumbers Indices of the label lines (within pEditor data).
633 * @param pszKeyWord The keyword searched within the original label name.
634 * @param pszNewLabelName The new name of the label.
635 */
636 bool modifyLabelLine(GeneralTextScript *pEditor, const std::vector<size_t> &vecLineNumbers,
637 const char *pszKeyWord, const char *pszNewLabelName);
638};
639
640
641/**
642 * Ubuntu installer (same as debian, except for the template).
643 */
644class UnattendedUbuntuInstaller : public UnattendedDebianInstaller
645{
646public:
647 DECLARE_TRANSLATE_METHODS(UnattendedUbuntuInstaller)
648
649 UnattendedUbuntuInstaller(Unattended *pParent)
650 : UnattendedDebianInstaller(pParent, "ubuntu_preseed.cfg")
651 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
652 ~UnattendedUbuntuInstaller() {}
653};
654
655/**
656 * RHEL installer.
657 *
658 * This serves as a base for the kickstart based installers.
659 */
660class UnattendedRhelInstaller : public UnattendedLinuxInstaller
661{
662public:
663 DECLARE_TRANSLATE_METHODS(UnattendedRhelInstaller)
664
665 UnattendedRhelInstaller(Unattended *pParent,
666 const char *pszMainScriptTemplateName,
667 const char *pszPostScriptTemplateName,
668 const char *pszMainScriptFilename)
669 : UnattendedLinuxInstaller(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
670 {}
671 ~UnattendedRhelInstaller() {}
672
673 bool isAuxiliaryIsoIsVISO() { return true; }
674 bool isOriginalIsoNeeded() const { return false; }
675
676protected:
677 HRESULT addFilesToAuxVisoVectors(RTCList<RTCString> &rVecArgs, RTCList<RTCString> &rVecFiles,
678 RTVFS hVfsOrgIso, bool fOverwrite);
679};
680
681/**
682 * RHEL 6 installer.
683 *
684 */
685class UnattendedRhel6Installer : public UnattendedRhelInstaller
686{
687public:
688 DECLARE_TRANSLATE_METHODS(UnattendedRhel6Installer)
689
690 UnattendedRhel6Installer(Unattended *pParent,
691 const char *pszMainScriptTemplateName = "redhat67_ks.cfg",
692 const char *pszPostScriptTemplateName = "redhat_postinstall.sh",
693 const char *pszMainScriptFilename = "ks.cfg")
694 : UnattendedRhelInstaller(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
695 {
696 Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded());
697 Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO());
698 mStrDefaultExtraInstallKernelParameters.assign(" ks=cdrom:/").append(pszMainScriptFilename).append(' ');
699 mArrStrRemoveInstallKernelParameters.append("rd.live.check"); /* Disables the checkisomd5 step. Required for VISO. */
700 }
701 ~UnattendedRhel6Installer() {}
702};
703
704/**
705 * RHEL 7 installer (same as RHEL 6).
706 * The class was added for better handling any possible subtle difference between RHEL6 and RHEL7.
707 */
708class UnattendedRhel7Installer : public UnattendedRhel6Installer
709{
710public:
711 DECLARE_TRANSLATE_METHODS(UnattendedRhel7Installer)
712
713 UnattendedRhel7Installer(Unattended *pParent)
714 : UnattendedRhel6Installer(pParent)
715 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
716
717 UnattendedRhel7Installer(Unattended *pParent,
718 const char *pszMainScriptTemplateName,
719 const char *pszPostScriptTemplateName,
720 const char *pszMainScriptFilename)
721 : UnattendedRhel6Installer(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
722 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
723 ~UnattendedRhel7Installer() {}
724};
725
726
727/**
728 * RHEL 8 installer (same as RHEL 7).
729 * The class was added for better handling any possible subtle difference between RHEL7 and RHEL8.
730 */
731class UnattendedRhel8Installer : public UnattendedRhel7Installer
732{
733public:
734 DECLARE_TRANSLATE_METHODS(UnattendedRhel8Installer)
735
736 UnattendedRhel8Installer(Unattended *pParent)
737 : UnattendedRhel7Installer(pParent)
738 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
739
740 UnattendedRhel8Installer(Unattended *pParent,
741 const char *pszMainScriptTemplateName,
742 const char *pszPostScriptTemplateName,
743 const char *pszMainScriptFilename)
744 : UnattendedRhel7Installer(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
745 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
746 ~UnattendedRhel8Installer() {}
747};
748
749
750/**
751 * RHEL 5 installer (same as RHEL 6, except for the kickstart template).
752 */
753class UnattendedRhel5Installer : public UnattendedRhel6Installer
754{
755public:
756 DECLARE_TRANSLATE_METHODS(UnattendedRhel5Installer)
757
758 UnattendedRhel5Installer(Unattended *pParent) : UnattendedRhel6Installer(pParent, "rhel5_ks.cfg") {}
759 ~UnattendedRhel5Installer() {}
760};
761
762
763/**
764 * RHEL 4 installer (same as RHEL 6, except for the kickstart template).
765 */
766class UnattendedRhel4Installer : public UnattendedRhel6Installer
767{
768public:
769 DECLARE_TRANSLATE_METHODS(UnattendedRhel4Installer)
770
771 UnattendedRhel4Installer(Unattended *pParent) : UnattendedRhel6Installer(pParent, "rhel4_ks.cfg") {}
772 ~UnattendedRhel4Installer() {}
773};
774
775
776/**
777 * RHEL 3 installer (same as RHEL 6, except for the kickstart template).
778 */
779class UnattendedRhel3Installer : public UnattendedRhel6Installer
780{
781public:
782 DECLARE_TRANSLATE_METHODS(UnattendedRhel3Installer)
783
784 UnattendedRhel3Installer(Unattended *pParent) : UnattendedRhel6Installer(pParent, "rhel3_ks.cfg") {}
785 ~UnattendedRhel3Installer() {}
786};
787
788
789/**
790 * Fedora installer (same as RHEL 6, except for the template).
791 */
792class UnattendedFedoraInstaller : public UnattendedRhel6Installer
793{
794public:
795 DECLARE_TRANSLATE_METHODS(UnattendedFedoraInstaller)
796
797 UnattendedFedoraInstaller(Unattended *pParent)
798 : UnattendedRhel6Installer(pParent, "fedora_ks.cfg")
799 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
800 ~UnattendedFedoraInstaller() {}
801};
802
803
804/**
805 * Oracle Linux 6 installer. Same as RHEL 6, except for the templates.
806 * The reason of adding new class is to sepatate the RHEL from OL.
807 */
808class UnattendedOracleLinux6Installer : public UnattendedRhel6Installer
809{
810public:
811 DECLARE_TRANSLATE_METHODS(UnattendedOracleLinux6Installer)
812
813 UnattendedOracleLinux6Installer(Unattended *pParent,
814 const char *pszMainScriptTemplateName = "ol_ks.cfg",
815 const char *pszPostScriptTemplateName = "ol_postinstall.sh",
816 const char *pszMainScriptFilename = "ks.cfg")
817 : UnattendedRhel6Installer(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
818 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
819 ~UnattendedOracleLinux6Installer() {}
820};
821
822
823/**
824 * Oracle Linux 7 installer. Same as OL 6.
825 * The class was added for better handling any possible subtle difference between OL6 and OL7.
826 */
827class UnattendedOracleLinux7Installer : public UnattendedOracleLinux6Installer
828{
829public:
830 DECLARE_TRANSLATE_METHODS(UnattendedOracleLinux7Installer)
831
832 UnattendedOracleLinux7Installer(Unattended *pParent)
833 : UnattendedOracleLinux6Installer(pParent)
834 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
835
836 UnattendedOracleLinux7Installer(Unattended *pParent,
837 const char *pszMainScriptTemplateName,
838 const char *pszPostScriptTemplateName,
839 const char *pszMainScriptFilename)
840 : UnattendedOracleLinux6Installer(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
841 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
842 ~UnattendedOracleLinux7Installer() {}
843};
844
845
846/**
847 * Oracle Linux 8 installer. Using a different kickstart file than earlier OL versions.
848 */
849class UnattendedOracleLinux8Installer : public UnattendedOracleLinux7Installer
850{
851public:
852 DECLARE_TRANSLATE_METHODS(UnattendedOracleLinux8Installer)
853
854 UnattendedOracleLinux8Installer(Unattended *pParent,
855 const char *pszMainScriptTemplateName = "ol8_ks.cfg",
856 const char *pszPostScriptTemplateName = "ol_postinstall.sh",
857 const char *pszMainScriptFilename = "ks.cfg")
858
859 : UnattendedOracleLinux7Installer(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
860 { Assert(!isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(isAuxiliaryIsoIsVISO()); }
861 ~UnattendedOracleLinux8Installer() {}
862};
863
864/**
865 * Oracle Linux 9 installer.
866 * Uses a different kickstart file since several commands/options are removed in OL9.
867 * See the ol9_ks.cfg file for comments. Also, as of OL9 kernel command argument 'ks' should have
868 * 'inst.' prefix.
869 */
870class UnattendedOracleLinux9Installer : public UnattendedRhelInstaller
871{
872public:
873 DECLARE_TRANSLATE_METHODS(UnattendedOracleLinux9Installer)
874
875 UnattendedOracleLinux9Installer(Unattended *pParent,
876 const char *pszMainScriptTemplateName = "ol9_ks.cfg",
877 const char *pszPostScriptTemplateName = "ol_postinstall.sh",
878 const char *pszMainScriptFilename = "ks.cfg")
879 : UnattendedRhelInstaller(pParent, pszMainScriptTemplateName, pszPostScriptTemplateName, pszMainScriptFilename)
880 {
881 Assert(!isOriginalIsoNeeded());
882 Assert(isAuxiliaryIsoNeeded());
883 Assert(!isAuxiliaryFloppyNeeded());
884 Assert(isAuxiliaryIsoIsVISO());
885 mStrDefaultExtraInstallKernelParameters.assign(" inst.ks=cdrom:/").append(pszMainScriptFilename).append(' ');
886 mArrStrRemoveInstallKernelParameters.append("rd.live.check"); /* Disables the checkisomd5 step. Required for VISO. */
887 }
888 ~UnattendedOracleLinux9Installer() {}
889};
890
891
892#if 0 /* fixme */
893/**
894 * SUSE linux installer.
895 *
896 * @todo needs fixing.
897 */
898class UnattendedSuseInstaller : public UnattendedLinuxInstaller
899{
900public:
901 DECLARE_TRANSLATE_METHODS(UnattendedSuseInstaller)
902
903 UnattendedSuseInstaller(BaseTextScript *pAlg, Unattended *pParent)
904 : UnattendedLinuxInstaller(pAlg, pParent, "suse_autoinstall.xml")
905 { Assert(isOriginalIsoNeeded()); Assert(isAuxiliaryIsoNeeded()); Assert(!isAuxiliaryFloppyNeeded()); Assert(!isAuxiliaryIsoIsVISO()); }
906 ~UnattendedSuseInstaller() {}
907
908 HRESULT setupScriptOnAuxiliaryCD(const Utf8Str &path);
909};
910#endif
911
912/**
913 * Base class for the unattended FreeBSD installers.
914 */
915class UnattendedFreeBsdInstaller : public UnattendedInstaller
916{
917public:
918 UnattendedFreeBsdInstaller(Unattended *pParent)
919 : UnattendedInstaller(pParent,
920 "freebsd_installer.cfg", "freebsd_postinstall.sh",
921 "installerconfig", "vboxpostinstall.sh") {}
922 ~UnattendedFreeBsdInstaller() {}
923
924 bool isAuxiliaryIsoNeeded() const { return true; }
925 bool isOriginalIsoNeeded() const { return false; }
926
927protected:
928 HRESULT addFilesToAuxVisoVectors(RTCList<RTCString> &rVecArgs, RTCList<RTCString> &rVecFiles,
929 RTVFS hVfsOrgIso, bool fOverwrite);
930};
931
932#endif /* !MAIN_INCLUDED_UnattendedInstaller_h */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use