mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-18 20:43:03 -06:00
277 lines
10 KiB
PHP
277 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* DebugController.php
|
|
* Copyright (c) 2017 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\Http\Controllers;
|
|
|
|
use Artisan;
|
|
use Carbon\Carbon;
|
|
use DB;
|
|
use Exception;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Http\Middleware\IsDemoUser;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Routing\Route;
|
|
use Log;
|
|
use Monolog\Handler\RotatingFileHandler;
|
|
use Route as RouteFacade;
|
|
|
|
/**
|
|
* Class DebugController
|
|
*/
|
|
class DebugController extends Controller
|
|
{
|
|
/**
|
|
* HomeController constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->middleware(IsDemoUser::class);
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*/
|
|
public function displayError(): void
|
|
{
|
|
Log::debug('This is a test message at the DEBUG level.');
|
|
Log::info('This is a test message at the INFO level.');
|
|
Log::notice('This is a test message at the NOTICE level.');
|
|
Log::warning('This is a test message at the WARNING level.');
|
|
Log::error('This is a test message at the ERROR level.');
|
|
Log::critical('This is a test message at the CRITICAL level.');
|
|
Log::alert('This is a test message at the ALERT level.');
|
|
Log::emergency('This is a test message at the EMERGENCY level.');
|
|
throw new FireflyException('A very simple test error.');
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
*
|
|
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
|
|
*/
|
|
public function flush(Request $request)
|
|
{
|
|
app('preferences')->mark();
|
|
$request->session()->forget(['start', 'end', '_previous', 'viewRange', 'range', 'is_custom_range']);
|
|
Log::debug('Call cache:clear...');
|
|
Artisan::call('cache:clear');
|
|
Log::debug('Call config:clear...');
|
|
Artisan::call('config:clear');
|
|
Log::debug('Call route:clear...');
|
|
Artisan::call('route:clear');
|
|
Log::debug('Call twig:clean...');
|
|
try {
|
|
Artisan::call('twig:clean');
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Exception $e) {
|
|
// don't care
|
|
Log::debug(sprintf('Called twig:clean: %s', $e->getMessage()));
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
Log::debug('Call view:clear...');
|
|
Artisan::call('view:clear');
|
|
Log::debug('Done! Redirecting...');
|
|
|
|
return redirect(route('index'));
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
*
|
|
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
|
|
*/
|
|
public function index(Request $request)
|
|
{
|
|
$search = ['~', '#'];
|
|
$replace = ['\~', '# '];
|
|
|
|
$phpVersion = str_replace($search, $replace, PHP_VERSION);
|
|
$phpOs = str_replace($search, $replace, PHP_OS);
|
|
$interface = PHP_SAPI;
|
|
$now = Carbon::create()->format('Y-m-d H:i:s e');
|
|
$extensions = implode(', ', get_loaded_extensions());
|
|
$drivers = implode(', ', DB::availableDrivers());
|
|
$currentDriver = DB::getDriverName();
|
|
$userAgent = $request->header('user-agent');
|
|
$isSandstorm = var_export(env('IS_SANDSTORM', 'unknown'), true);
|
|
$isDocker = var_export(env('IS_DOCKER', 'unknown'), true);
|
|
$toSandbox = var_export(env('BUNQ_USE_SANDBOX', 'unknown'), true);
|
|
$trustedProxies = env('TRUSTED_PROXIES', '(none)');
|
|
$displayErrors = ini_get('display_errors');
|
|
$errorReporting = $this->errorReporting((int)ini_get('error_reporting'));
|
|
$appEnv = env('APP_ENV', '');
|
|
$appDebug = var_export(env('APP_DEBUG', false), true);
|
|
$appLog = env('APP_LOG', '');
|
|
$appLogLevel = env('APP_LOG_LEVEL', '');
|
|
$packages = $this->collectPackages();
|
|
$cacheDriver = env('CACHE_DRIVER', 'unknown');
|
|
|
|
// set languages, see what happens:
|
|
$original = setlocale(LC_ALL, 0);
|
|
$localeAttempts = [];
|
|
$parts = explode(',', trans('config.locale'));
|
|
foreach ($parts as $code) {
|
|
$code = trim($code);
|
|
$localeAttempts[$code] = var_export(setlocale(LC_ALL, $code), true);
|
|
}
|
|
setlocale(LC_ALL, $original);
|
|
|
|
// get latest log file:
|
|
$logger = Log::driver();
|
|
$handlers = $logger->getHandlers();
|
|
$logContent = '';
|
|
foreach ($handlers as $handler) {
|
|
if ($handler instanceof RotatingFileHandler) {
|
|
$logFile = $handler->getUrl();
|
|
if (null !== $logFile) {
|
|
try {
|
|
$logContent = file_get_contents($logFile);
|
|
// @codeCoverageIgnoreStart
|
|
} catch (Exception $e) {
|
|
// don't care
|
|
Log::debug(sprintf('Could not read log file. %s', $e->getMessage()));
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
}
|
|
}
|
|
// last few lines
|
|
$logContent = 'Truncated from this point <----|' . substr($logContent, -8192);
|
|
|
|
return view(
|
|
'debug', compact(
|
|
'phpVersion', 'extensions', 'localeAttempts', 'appEnv', 'appDebug', 'appLog', 'appLogLevel', 'now', 'packages', 'drivers',
|
|
'currentDriver',
|
|
'userAgent', 'displayErrors', 'errorReporting', 'phpOs', 'interface', 'logContent', 'cacheDriver', 'isDocker', 'isSandstorm',
|
|
'trustedProxies',
|
|
'toSandbox'
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function routes(): string
|
|
{
|
|
$set = RouteFacade::getRoutes();
|
|
$ignore = ['chart.', 'javascript.', 'json.', 'report-data.', 'popup.', 'debugbar.', 'attachments.download', 'attachments.preview',
|
|
'bills.rescan', 'budgets.income', 'currencies.def', 'error', 'flush', 'help.show', 'import.file',
|
|
'login', 'logout', 'password.reset', 'profile.confirm-email-change', 'profile.undo-email-change',
|
|
'register', 'report.options', 'routes', 'rule-groups.down', 'rule-groups.up', 'rules.up', 'rules.down',
|
|
'rules.select', 'search.search', 'test-flash', 'transactions.link.delete', 'transactions.link.switch',
|
|
'two-factor.lost', 'reports.options', 'debug', 'import.create-job', 'import.download', 'import.start', 'import.status.json',
|
|
'preferences.delete-code', 'rules.test-triggers', 'piggy-banks.remove-money', 'piggy-banks.add-money',
|
|
'accounts.reconcile.transactions', 'accounts.reconcile.overview', 'export.download',
|
|
'transactions.clone', 'two-factor.index', 'api.v1', 'installer.', 'attachments.view', 'import.create',
|
|
'import.job.download', 'import.job.start', 'import.job.status.json', 'import.job.store', 'recurring.events',
|
|
'recurring.suggest',
|
|
];
|
|
$return = ' ';
|
|
/** @var Route $route */
|
|
foreach ($set as $route) {
|
|
$name = $route->getName();
|
|
if (null !== $name && \strlen($name) > 0 && \in_array('GET', $route->methods(), true)) {
|
|
|
|
$found = false;
|
|
foreach ($ignore as $string) {
|
|
if (!(false === stripos($name, $string))) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (false === $found) {
|
|
$return .= 'touch ' . $route->getName() . '.md;';
|
|
}
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
*
|
|
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
|
|
*/
|
|
public function testFlash(Request $request)
|
|
{
|
|
$request->session()->flash('success', 'This is a success message.');
|
|
$request->session()->flash('info', 'This is an info message.');
|
|
$request->session()->flash('warning', 'This is a warning.');
|
|
$request->session()->flash('error', 'This is an error!');
|
|
|
|
return redirect(route('home'));
|
|
}
|
|
|
|
/**
|
|
* Some common combinations.
|
|
*
|
|
* @param int $value
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function errorReporting(int $value): string
|
|
{
|
|
$array = [
|
|
-1 => 'ALL errors',
|
|
E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED => 'E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED',
|
|
E_ALL => 'E_ALL',
|
|
E_ALL & ~E_DEPRECATED & ~E_STRICT => 'E_ALL & ~E_DEPRECATED & ~E_STRICT',
|
|
E_ALL & ~E_NOTICE => 'E_ALL & ~E_NOTICE',
|
|
E_ALL & ~E_NOTICE & ~E_STRICT => 'E_ALL & ~E_NOTICE & ~E_STRICT',
|
|
E_COMPILE_ERROR | E_RECOVERABLE_ERROR | E_ERROR | E_CORE_ERROR => 'E_COMPILE_ERROR|E_RECOVERABLE_ERROR|E_ERROR|E_CORE_ERROR',
|
|
];
|
|
$result = (string)$value;
|
|
if (isset($array[$value])) {
|
|
$result = $array[$value];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function collectPackages(): array
|
|
{
|
|
$packages = [];
|
|
$file = \dirname(__DIR__, 3) . '/vendor/composer/installed.json';
|
|
if (!(false === $file) && file_exists($file)) {
|
|
// file exists!
|
|
$content = file_get_contents($file);
|
|
$json = json_decode($content, true);
|
|
foreach ($json as $package) {
|
|
$packages[]
|
|
= [
|
|
'name' => $package['name'],
|
|
'version' => $package['version'],
|
|
];
|
|
}
|
|
}
|
|
|
|
return $packages;
|
|
}
|
|
}
|