mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-06 04:34:00 +00:00
Add configuration to Api.
This commit is contained in:
104
app/Api/V1/Controllers/ConfigurationController.php
Normal file
104
app/Api/V1/Controllers/ConfigurationController.php
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* ConfigurationController.php
|
||||||
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
||||||
|
*
|
||||||
|
* This file is part of Firefly III.
|
||||||
|
*
|
||||||
|
* Firefly III is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Firefly III is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Api\V1\Controllers;
|
||||||
|
|
||||||
|
use FireflyIII\Exceptions\FireflyException;
|
||||||
|
use FireflyIII\Models\Configuration;
|
||||||
|
use Illuminate\Http\JsonResponse;
|
||||||
|
use Illuminate\Http\Request;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class ConfigurationController
|
||||||
|
*/
|
||||||
|
class ConfigurationController extends Controller
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws FireflyException
|
||||||
|
*/
|
||||||
|
public function index()
|
||||||
|
{
|
||||||
|
if (!auth()->user()->hasRole('owner')) {
|
||||||
|
throw new FireflyException('No access to method.'); // @codeCoverageIgnore
|
||||||
|
}
|
||||||
|
$configData = $this->getConfigData();
|
||||||
|
|
||||||
|
return response()->json(['data' => $configData], 200)->header('Content-Type', 'application/vnd.api+json');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param Request $request
|
||||||
|
*
|
||||||
|
* @throws FireflyException
|
||||||
|
*/
|
||||||
|
public function update(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
if (!auth()->user()->hasRole('owner')) {
|
||||||
|
throw new FireflyException('No access to method.'); // @codeCoverageIgnore
|
||||||
|
}
|
||||||
|
$name = $request->get('name');
|
||||||
|
$value = $request->get('value');
|
||||||
|
$valid = ['is_demo_site', 'permission_update_check', 'single_user_mode'];
|
||||||
|
if (!\in_array($name, $valid, true)) {
|
||||||
|
throw new FireflyException('You cannot edit this configuration value.');
|
||||||
|
}
|
||||||
|
$configValue = '';
|
||||||
|
switch ($name) {
|
||||||
|
case 'is_demo_site':
|
||||||
|
case 'single_user_mode':
|
||||||
|
$configValue = $value === 'true';
|
||||||
|
break;
|
||||||
|
case 'permission_update_check':
|
||||||
|
$configValue = (int)$value >= -1 && (int)$value <= 1 ? (int)$value : -1;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
app('fireflyconfig')->set($name, $configValue);
|
||||||
|
$configData = $this->getConfigData();
|
||||||
|
|
||||||
|
return response()->json(['data' => $configData], 200)->header('Content-Type', 'application/vnd.api+json');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private function getConfigData(): array
|
||||||
|
{
|
||||||
|
/** @var Configuration $isDemoSite */
|
||||||
|
$isDemoSite = app('fireflyconfig')->get('is_demo_site');
|
||||||
|
/** @var Configuration $updateCheck */
|
||||||
|
$updateCheck = app('fireflyconfig')->get('permission_update_check');
|
||||||
|
/** @var Configuration $lastCheck */
|
||||||
|
$lastCheck = app('fireflyconfig')->get('last_update_check');
|
||||||
|
/** @var Configuration $singleUser */
|
||||||
|
$singleUser = app('fireflyconfig')->get('single_user_mode');
|
||||||
|
$data = [
|
||||||
|
'is_demo_site' => null === $isDemoSite ? null : $isDemoSite->data,
|
||||||
|
'permission_update_check' => null === $updateCheck ? null : (int)$updateCheck->data,
|
||||||
|
'last_update_check' => null === $lastCheck ? null : (int)$lastCheck->data,
|
||||||
|
'single_user_mode' => null === $singleUser ? null : $singleUser->data,
|
||||||
|
];
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
}
|
@@ -27,6 +27,8 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Class Configuration.
|
* Class Configuration.
|
||||||
|
*
|
||||||
|
* @property string $data
|
||||||
*/
|
*/
|
||||||
class Configuration extends Model
|
class Configuration extends Model
|
||||||
{
|
{
|
||||||
|
@@ -55,7 +55,7 @@ class FireflyConfig
|
|||||||
*
|
*
|
||||||
* @return \FireflyIII\Models\Configuration|null
|
* @return \FireflyIII\Models\Configuration|null
|
||||||
*/
|
*/
|
||||||
public function get($name, $default = null)
|
public function get($name, $default = null): ?Configuration
|
||||||
{
|
{
|
||||||
$fullName = 'ff-config-' . $name;
|
$fullName = 'ff-config-' . $name;
|
||||||
if (Cache::has($fullName)) {
|
if (Cache::has($fullName)) {
|
||||||
|
@@ -124,6 +124,15 @@ Route::group(
|
|||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
|
Route::group(
|
||||||
|
['middleware' => ['auth:api', 'bindings'], 'namespace' => 'FireflyIII\Api\V1\Controllers', 'prefix' => 'configuration', 'as' => 'api.v1.configuration.'],
|
||||||
|
function () {
|
||||||
|
|
||||||
|
// Configuration API routes:
|
||||||
|
Route::get('', ['uses' => 'ConfigurationController@index', 'as' => 'index']);
|
||||||
|
Route::put('', ['uses' => 'ConfigurationController@update', 'as' => 'update']);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
Route::group(
|
Route::group(
|
||||||
['middleware' => ['auth:api', 'bindings'], 'namespace' => 'FireflyIII\Api\V1\Controllers', 'prefix' => 'currencies', 'as' => 'api.v1.currencies.'],
|
['middleware' => ['auth:api', 'bindings'], 'namespace' => 'FireflyIII\Api\V1\Controllers', 'prefix' => 'currencies', 'as' => 'api.v1.currencies.'],
|
||||||
|
Reference in New Issue
Block a user