upstream/opnsense-plugins
1
0
Fork 0
mirror of https://github.com/opnsense/plugins.git synced 2026-04-25 16:17:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

sysutils/api-backup: add json download functionality

Browse source
This commit is contained in:
Frank Wall 2023-02-15 23:04:14 +01:00
parent 85a20658af
commit 48d25da33d
3 changed files with 58 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
sysutils/api-backup/Makefile
View file

@ -1,6 +1,5 @@
PLUGIN_NAME= api-backup
PLUGIN_VERSION= 1.0
PLUGIN_REVISION= 1
PLUGIN_VERSION= 1.1
PLUGIN_COMMENT= Provide the functionality to download the config.xml
PLUGIN_MAINTAINER= franz.fabian.94@gmail.com

11
sysutils/api-backup/pkg-descr
View file

@ -1 +1,12 @@
Provide the functionality to download the config.xml
Plugin Changelog
================
1.1
* add json download functionality
1.0
* initial release

52
sysutils/api-backup/src/opnsense/mvc/app/controllers/OPNsense/Backup/Api/BackupController.php
View file

@ -1,6 +1,7 @@
<?php
/*
* Copyright (C) 2023 Frank Wall
* Copyright (C) 2018 Fabian Franz
* All rights reserved.
*
@ -34,17 +35,56 @@ class BackupController extends ApiControllerBase
{
const CONFIG_XML = '/conf/config.xml';
public function downloadAction()
/**
* download system config
* @param string $format set to 'json' to get a base64 encoded config backup
* @return array|mixed
*/
public function downloadAction($format='plain')
{
$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);
$status = $data === false ? 'error' : 'success';
if ($format == 'json') {
$response = array(
'status' => $status,
'filename' => 'config.xml',
'filetype' => 'application/xml',
'content' => base64_encode($data),
);
return $response;
} else {
$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);
}
}
/**
* process API results, serialize return data to json.
* @param $dispatcher
* @return string json data
*/
public function afterExecuteRoute($dispatcher)
{
$this->response->send();
// check if reponse headers are already set
if ($this->response->getHeaders()->get("Status") != null) {
// Headers already set, send unmodified response.
} else {
// process response, serialize to json object
$data = $dispatcher->getReturnedValue();
if (is_array($data)) {
$this->response->setContentType('application/json', 'UTF-8');
if ($this->isExternalClient()) {
$this->response->setContent(json_encode($data));
} else {
$this->response->setContent(htmlspecialchars(json_encode($data), ENT_NOQUOTES));
}
}
}
return $this->response->send();
}
}