mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-06 04:34:00 +00:00
347 lines
11 KiB
PHP
347 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* DebugController.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Http\Controllers;
|
|
|
|
use DB;
|
|
use Exception;
|
|
use FireflyConfig;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Http\Middleware\IsDemoUser;
|
|
use FireflyIII\Models\AccountType;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Support\Http\Controllers\GetConfigurationData;
|
|
use FireflyIII\User;
|
|
use Illuminate\Contracts\View\Factory;
|
|
use Illuminate\Http\RedirectResponse;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Routing\Redirector;
|
|
use Illuminate\Support\Facades\Artisan;
|
|
use Illuminate\Support\Facades\Log;
|
|
use Illuminate\View\View;
|
|
use Monolog\Handler\RotatingFileHandler;
|
|
use Psr\Container\ContainerExceptionInterface;
|
|
use Psr\Container\NotFoundExceptionInterface;
|
|
|
|
/**
|
|
* Class DebugController
|
|
*
|
|
*/
|
|
class DebugController extends Controller
|
|
{
|
|
use GetConfigurationData;
|
|
|
|
/**
|
|
* DebugController constructor.
|
|
*
|
|
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->middleware(IsDemoUser::class)->except(['displayError']);
|
|
}
|
|
|
|
/**
|
|
* Show all possible errors.
|
|
*
|
|
* @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.');
|
|
app('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.');
|
|
}
|
|
|
|
/**
|
|
* Clear log and session.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return RedirectResponse|Redirector
|
|
* @throws FireflyException
|
|
*/
|
|
public function flush(Request $request)
|
|
{
|
|
app('preferences')->mark();
|
|
$request->session()->forget(['start', 'end', '_previous', 'viewRange', 'range', 'is_custom_range', 'temp-mfa-secret', 'temp-mfa-codes']);
|
|
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');
|
|
} catch (Exception $e) { // intentional generic exception
|
|
throw new FireflyException($e->getMessage(), 0, $e);
|
|
}
|
|
|
|
Log::debug('Call view:clear...');
|
|
Artisan::call('view:clear');
|
|
|
|
return redirect(route('index'));
|
|
}
|
|
|
|
/**
|
|
* Show debug info.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return Factory|View
|
|
* @throws FireflyException
|
|
*/
|
|
public function index(Request $request)
|
|
{
|
|
$table = $this->generateTable();
|
|
$now = now(config('app.timezone'))->format('Y-m-d H:i:s');
|
|
|
|
// get latest log file:
|
|
$logger = Log::driver();
|
|
// PHPstan doesn't recognize the method because of its polymorphic nature.
|
|
$handlers = $logger->getHandlers(); // @phpstan-ignore-line
|
|
$logContent = '';
|
|
foreach ($handlers as $handler) {
|
|
if ($handler instanceof RotatingFileHandler) {
|
|
$logFile = $handler->getUrl();
|
|
if (null !== $logFile && file_exists($logFile)) {
|
|
$logContent = file_get_contents($logFile);
|
|
}
|
|
}
|
|
}
|
|
if ('' !== $logContent) {
|
|
// last few lines
|
|
$logContent = 'Truncated from this point <----|' . substr($logContent, -16384);
|
|
}
|
|
|
|
return view('debug', compact('table', 'now', 'logContent'));
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
private function generateTable(): string
|
|
{
|
|
// system information:
|
|
$system = $this->getSystemInformation();
|
|
$docker = $this->getBuildInfo();
|
|
$app = $this->getAppInfo();
|
|
$user = $this->getuserInfo();
|
|
|
|
return (string)view('partials.debug-table', compact('system', 'docker', 'app', 'user'));
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function getSystemInformation(): array
|
|
{
|
|
$maxFileSize = app('steam')->phpBytes(ini_get('upload_max_filesize'));
|
|
$maxPostSize = app('steam')->phpBytes(ini_get('post_max_size'));
|
|
$drivers = DB::availableDrivers();
|
|
$currentDriver = DB::getDriverName();
|
|
return [
|
|
'db_version' => app('fireflyconfig')->get('db_version', 1)->data,
|
|
'php_version' => PHP_VERSION,
|
|
'php_os' => PHP_OS,
|
|
'interface' => PHP_SAPI,
|
|
'bcscale' => bcscale(),
|
|
'display_errors' => ini_get('display_errors'),
|
|
'error_reporting' => $this->errorReporting((int)ini_get('error_reporting')),
|
|
'upload_size' => min($maxFileSize, $maxPostSize),
|
|
'all_drivers' => $drivers,
|
|
'current_driver' => $currentDriver,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function getBuildInfo(): array
|
|
{
|
|
$return = [
|
|
'is_docker' => env('IS_DOCKER', false),
|
|
'build' => '(unknown)',
|
|
'build_date' => '(unknown)',
|
|
'base_build' => '(unknown)',
|
|
'base_build_date' => '(unknown)',
|
|
|
|
];
|
|
try {
|
|
if (file_exists('/var/www/counter-main.txt')) {
|
|
$return['build'] = trim(file_get_contents('/var/www/counter-main.txt'));
|
|
}
|
|
} catch (Exception $e) { // generic catch for open basedir.
|
|
Log::debug('Could not check build counter, but thats ok.');
|
|
Log::warning($e->getMessage());
|
|
}
|
|
try {
|
|
if (file_exists('/var/www/build-date-main.txt')) {
|
|
$return['build_date'] = trim(file_get_contents('/var/www/build-date-main.txt'));
|
|
}
|
|
} catch (Exception $e) { // generic catch for open basedir.
|
|
Log::debug('Could not check build date, but thats ok.');
|
|
Log::warning($e->getMessage());
|
|
}
|
|
if ('' !== (string)env('BASE_IMAGE_BUILD')) {
|
|
$return['base_build'] = env('BASE_IMAGE_BUILD');
|
|
}
|
|
if ('' !== (string)env('BASE_IMAGE_DATE')) {
|
|
$return['base_build_date'] = env('BASE_IMAGE_DATE');
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function getAppInfo(): array
|
|
{
|
|
$userGuard = config('auth.defaults.guard');
|
|
|
|
return [
|
|
'tz' => env('TZ'),
|
|
'debug' => var_export(config('app.debug'), true),
|
|
'log_channel' => env('LOG_CHANNEL'),
|
|
'audit_log_channel' => envNonEmpty('AUDIT_LOG_CHANNEL', '(empty)'),
|
|
'default_language' => (string)config('firefly.default_language'),
|
|
'default_locale' => (string)config('firefly.default_locale'),
|
|
'remote_header' => $userGuard === 'remote_user_guard' ? config('auth.guard_header') : 'N/A',
|
|
'remote_mail_header' => $userGuard === 'remote_user_guard' ? config('auth.guard_email') : 'N/A',
|
|
'stateful_domains' => join(', ', config('sanctum.stateful')),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
* @throws ContainerExceptionInterface
|
|
* @throws NotFoundExceptionInterface
|
|
*/
|
|
private function getuserInfo(): array
|
|
{
|
|
$userFlags = $this->getUserFlags();
|
|
|
|
// user info
|
|
$userAgent = request()->header('user-agent');
|
|
|
|
// set languages, see what happens:
|
|
$original = setlocale(LC_ALL, 0);
|
|
$localeAttempts = [];
|
|
$parts = app('steam')->getLocaleArray(app('steam')->getLocale());
|
|
foreach ($parts as $code) {
|
|
$code = trim($code);
|
|
Log::debug(sprintf('Trying to set %s', $code));
|
|
$result = setlocale(LC_ALL, $code);
|
|
$localeAttempts[$code] = $result === $code;
|
|
}
|
|
setlocale(LC_ALL, $original);
|
|
|
|
return [
|
|
'user_id' => auth()->user()->id,
|
|
'user_count' => User::count(),
|
|
'user_flags' => $userFlags,
|
|
'user_agent' => $userAgent,
|
|
'locale_attempts' => $localeAttempts,
|
|
'locale' => app('steam')->getLocale(),
|
|
'language' => app('steam')->getLanguage(),
|
|
'view_range' => app('preferences')->get('viewRange', '1M')->data,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
private function getUserFlags(): string
|
|
{
|
|
$flags = [];
|
|
/** @var User $user */
|
|
$user = auth()->user();
|
|
|
|
// has liabilities
|
|
if ($user->accounts()->accountTypeIn([AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE])->count() > 0) {
|
|
$flags[] = ':credit_card:';
|
|
}
|
|
|
|
// has piggies
|
|
if ($user->piggyBanks()->count() > 0) {
|
|
$flags[] = ':pig:';
|
|
}
|
|
|
|
// has stored reconciliations
|
|
$type = TransactionType::whereType(TransactionType::RECONCILIATION)->first();
|
|
if ($user->transactionJournals()->where('transaction_type_id', $type->id)->count()) {
|
|
$flags[] = ':ledger:';
|
|
}
|
|
|
|
// has used importer?
|
|
|
|
// has rules
|
|
if ($user->rules()->count() > 0) {
|
|
$flags[] = ':wrench:';
|
|
}
|
|
|
|
// has recurring transactions
|
|
if ($user->recurrences()->count() > 0) {
|
|
$flags[] = ':clock130:';
|
|
}
|
|
|
|
// has groups
|
|
if ($user->objectGroups()->count() > 0) {
|
|
$flags[] = ':bookmark_tabs:';
|
|
}
|
|
|
|
// uses bills
|
|
if ($user->bills()->count() > 0) {
|
|
$flags[] = ':email:';
|
|
}
|
|
return join(' ', $flags);
|
|
}
|
|
|
|
/**
|
|
* Flash all types of messages.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return RedirectResponse|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'));
|
|
}
|
|
|
|
}
|