1 files changed, 102 insertions, 0 deletions
diff --git a/modules-available/serversetup-bwlp-ipxe/inc/scriptbuilderbase.inc.php b/modules-available/serversetup-bwlp-ipxe/inc/scriptbuilderbase.inc.php
new file mode 100644
index 00000000..9cd07388
--- /dev/null
+++ b/modules-available/serversetup-bwlp-ipxe/inc/scriptbuilderbase.inc.php
@@ -0,0 +1,102 @@
+<?php
+
+abstract class ScriptBuilderBase
+{
+
+	private $lblId = 0;
+
+	protected $serverIp;
+
+	protected $platform = '';
+
+	/** @var string  */
+	protected $clientIp;
+
+	/** @var ?string */
+	protected $uuid;
+
+	/**
+	 * @var bool Running iPXE has slx-extensions
+	 */
+	protected $hasExtension = false;
+
+	public function hasExtensions(): bool
+	{
+		return $this->hasExtension;
+	}
+
+	public function platform(): string
+	{
+		return $this->platform;
+	}
+
+	public function uuid(): ?string
+	{
+		return $this->uuid;
+	}
+
+	public function clientIp(): string
+	{
+		return $this->clientIp;
+	}
+
+	public function getLabel(): string
+	{
+		return 'b' . mt_rand(100, 999) . 'x' . (++$this->lblId);
+	}
+
+	public function __construct(?string $platform = null, ?string $serverIp = null, ?bool $slxExtensions = null)
+	{
+		$this->clientIp = (string)$_SERVER['REMOTE_ADDR'];
+		if (substr($this->clientIp, 0, 7) === '::ffff:') {
+			$this->clientIp = substr($this->clientIp, 7);
+		}
+		$this->serverIp = $serverIp ?? $_SERVER['SERVER_ADDR'] ?? Property::getServerIp();
+		$this->platform = $platform ?? Request::any('platform', null, 'string');
+		if ($this->platform !== null) {
+			$this->platform = strtoupper($this->platform);
+		}
+		if ($this->platform !== 'EFI' && $this->platform !== 'PCBIOS') {
+			$this->platform = '';
+		}
+		$this->hasExtension = $slxExtensions ?? (bool)Request::any('slx-extensions', false, 'int');
+		$uuid = Request::any('uuid', null, 'string');
+		if ($uuid !== null
+				&& preg_match('/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i', $uuid)) {
+			$this->uuid = (string)$uuid;
+		}
+	}
+
+	/**
+	 * Output given string (script) to client, in a suitable encoding, headers, etc.
+	 */
+	public abstract function output(string $string): void;
+
+	public abstract function bootstrapLive();
+
+	public abstract function getMenu(IPxeMenu $menu, bool $bootstrap);
+
+	/**
+	 * @param MenuEntry|null $menuEntry The according menu entry, or null if invalid.
+	 * @param bool $honorPassword Whether we should generate a password dialog if protected, or skip
+	 * @return string generated script/code/...
+	 */
+	public abstract function getMenuEntry(?MenuEntry $entry, bool $honorPassword = true): string;
+
+	/**
+	 * @param BootEntry|null|false $bootEntry
+	 */
+	public abstract function getBootEntry(?BootEntry $entry): string;
+
+	public abstract function getSpecial(string $special);
+
+	public abstract function menuToScript(IPxeMenu $menu): string;
+
+	/**
+	 * Pass EITHER only $agnostic, OR $bios and/or $efi
+	 * If $agnostic is given, it should be used unconditionally,
+	 * and $bios/$efi should be ignored.
+	 */
+	public abstract function execDataToScript(?ExecData $agnostic, ?ExecData $bios, ?ExecData $efi): string;
+
+}
+\ No newline at end of file