From b44d8ba70637b635f7579c6b5a43ef821148b6c7 Mon Sep 17 00:00:00 2001
From: Fabian Franz BSc <fabianfrz@users.noreply.github.com>
Date: Sun, 7 Oct 2018 15:57:59 +0200
Subject: [PATCH] add backup api; closes #865 (#895)

* add backup api; closes #865
* make backup api devel
* sysutils/api-backup: rename
* sysutils/api-backup: fix prev
* fix ACL
---
 sysutils/api-backup/Makefile                  |  7 +++
 sysutils/api-backup/pkg-descr                 |  1 +
 .../OPNsense/Backup/Api/BackupController.php  | 47 +++++++++++++++++++
 .../app/models/OPNsense/Backup/ACL/ACL.xml    |  8 ++++
 4 files changed, 63 insertions(+)
 create mode 100644 sysutils/api-backup/Makefile
 create mode 100644 sysutils/api-backup/pkg-descr
 create mode 100644 sysutils/api-backup/src/opnsense/mvc/app/controllers/OPNsense/Backup/Api/BackupController.php
 create mode 100644 sysutils/api-backup/src/opnsense/mvc/app/models/OPNsense/Backup/ACL/ACL.xml

diff --git a/sysutils/api-backup/Makefile b/sysutils/api-backup/Makefile
new file mode 100644
index 000000000..abef4dd09
--- /dev/null
+++ b/sysutils/api-backup/Makefile
@@ -0,0 +1,7 @@
+PLUGIN_NAME=          api-backup
+PLUGIN_VERSION=       0.0.1
+PLUGIN_COMMENT=       Provide the functionality to download the config.xml
+PLUGIN_MAINTAINER=    franz.fabian.94@gmail.com
+PLUGIN_DEVEL=         YES
+
+.include "../../Mk/plugins.mk"
diff --git a/sysutils/api-backup/pkg-descr b/sysutils/api-backup/pkg-descr
new file mode 100644
index 000000000..578a3db51
--- /dev/null
+++ b/sysutils/api-backup/pkg-descr
@@ -0,0 +1 @@
+Provide the functionality to download the config.xml
\ No newline at end of file
diff --git a/sysutils/api-backup/src/opnsense/mvc/app/controllers/OPNsense/Backup/Api/BackupController.php b/sysutils/api-backup/src/opnsense/mvc/app/controllers/OPNsense/Backup/Api/BackupController.php
new file mode 100644
index 000000000..cb5b14b79
--- /dev/null
+++ b/sysutils/api-backup/src/opnsense/mvc/app/controllers/OPNsense/Backup/Api/BackupController.php
@@ -0,0 +1,47 @@
+<?php
+/*
+ * Copyright (C) 2018 Fabian Franz
+ * 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\Backup\Api;
+use OPNsense\Base\ApiControllerBase;
+
+class BackupController extends ApiControllerBase
+{
+    const CONFIG_XML = '/conf/config.xml';
+
+    public function downloadAction()
+    {
+        $this->response->setStatusCode(200, "OK");
+        $this->response->setContentType('application/xml', 'UTF-8');
+        $this->response->setHeader("Content-Disposition", "attachment; filename=\"config.xml\"");
+        $data = file_get_contents(self::CONFIG_XML);
+        $this->response->setContent($data);
+    }
+
+    public function afterExecuteRoute($dispatcher)
+    {
+        $this->response->send();
+    }
+}
\ No newline at end of file
diff --git a/sysutils/api-backup/src/opnsense/mvc/app/models/OPNsense/Backup/ACL/ACL.xml b/sysutils/api-backup/src/opnsense/mvc/app/models/OPNsense/Backup/ACL/ACL.xml
new file mode 100644
index 000000000..2a1b83765
--- /dev/null
+++ b/sysutils/api-backup/src/opnsense/mvc/app/models/OPNsense/Backup/ACL/ACL.xml
@@ -0,0 +1,8 @@
+<acl>
+  <page-Backup>
+    <name>Backup API</name>
+    <patterns>
+      <pattern>api/backup/*</pattern>
+    </patterns>
+  </page-Backup>
+</acl>