From eb1f41f449bf49454376e952287f74d2b254d0d2 Mon Sep 17 00:00:00 2001
From: Ad Schellevis <ad@opnsense.org>
Date: Tue, 30 Mar 2021 11:38:37 +0200
Subject: [PATCH] Firmware - minor bugfix to map Subscription on page load and
 add initial migration so BE users stick to their version.

---
 .../mvc/app/models/OPNsense/Core/Firmware.php | 39 ++++++++++++++
 .../mvc/app/models/OPNsense/Core/Firmware.xml | 25 +++++++++
 .../OPNsense/Core/Migrations/M1_0_0.php       | 52 +++++++++++++++++++
 .../mvc/app/views/OPNsense/Core/firmware.volt |  7 +++
 4 files changed, 123 insertions(+)
 create mode 100644 src/opnsense/mvc/app/models/OPNsense/Core/Firmware.php
 create mode 100644 src/opnsense/mvc/app/models/OPNsense/Core/Firmware.xml
 create mode 100644 src/opnsense/mvc/app/models/OPNsense/Core/Migrations/M1_0_0.php

diff --git a/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.php b/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.php
new file mode 100644
index 000000000..3211d6fa7
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.php
@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * Copyright (C) 2021 Deciso B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace OPNsense\Core;
+
+use OPNsense\Base\BaseModel;
+
+/**
+ * Class Firmware
+ * @package OPNsense\Core
+ */
+class Firmware extends BaseModel
+{
+}
diff --git a/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.xml b/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.xml
new file mode 100644
index 000000000..ac570ebfc
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Core/Firmware.xml
@@ -0,0 +1,25 @@
+<model>
+    <mount>//system/firmware</mount>
+    <version>1.0.0</version>
+    <description>
+        OPNsense Firmware settings
+    </description>
+    <items>
+        <mirror type="TextField">
+            <Required>N</Required>
+            <default></default>
+        </mirror>
+        <flavour type="TextField">
+            <Required>N</Required>
+            <default></default>
+        </flavour>
+        <plugins type="TextField">
+            <Required>N</Required>
+            <default></default>
+        </plugins>
+        <type type="TextField">
+            <Required>N</Required>
+            <default></default>
+        </type>
+    </items>
+</model>
diff --git a/src/opnsense/mvc/app/models/OPNsense/Core/Migrations/M1_0_0.php b/src/opnsense/mvc/app/models/OPNsense/Core/Migrations/M1_0_0.php
new file mode 100644
index 000000000..d11477b91
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Core/Migrations/M1_0_0.php
@@ -0,0 +1,52 @@
+<?php
+
+/**
+ *    Copyright (C) 2021 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+namespace OPNsense\Core\Migrations;
+
+use OPNsense\Base\BaseModelMigration;
+
+class M1_0_0 extends BaseModelMigration
+{
+    /**
+     * Migrate BE release type
+     * @param $model
+     */
+    public function run($model)
+    {
+
+        if ((empty((string)$model->type) || (string)$model->type == "devel") && !empty((string)$model->mirror) ) {
+            $is_business = stripos((string)$model->mirror, "opnsense-update.deciso.com") > 1;
+            if ($is_business) {
+                $model->type = "business";
+                $model->flavour = "latest";
+            }
+        }
+    }
+}
diff --git a/src/opnsense/mvc/app/views/OPNsense/Core/firmware.volt b/src/opnsense/mvc/app/views/OPNsense/Core/firmware.volt
index a1a3acf2a..4aacce06b 100644
--- a/src/opnsense/mvc/app/views/OPNsense/Core/firmware.volt
+++ b/src/opnsense/mvc/app/views/OPNsense/Core/firmware.volt
@@ -622,6 +622,7 @@
                     $("#firmware_mirror").append($("<option/>")
                             .attr("value",key)
                             .text(value)
+                            .data("has_subscription", firmwareoptions['families_has_subscription'].length > 0)
                             .prop('selected', selected)
                     );
                 });
@@ -634,6 +635,12 @@
                     );
                 }
 
+                if ($("#firmware_mirror option:selected").data("has_subscription") == true) {
+                    $("#firmware_mirror_subscription").val(firmwareconfig['mirror'].substr($("#firmware_mirror").val().length+1));
+                } else {
+                    $("#firmware_mirror_subscription").val("");
+                }
+
                 $("#firmware_mirror").selectpicker('refresh');
                 $("#firmware_mirror").change();