Skip to content

Firefly III: a personal finances manager

18.9 KB
Raw Blame
<?php

/**
 * DebugController.php
 * Copyright (c) 2019 [email protected]
 *
 * 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 Carbon\Carbon;
use Exception;
use FireflyIII\Enums\AccountTypeEnum;
use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Http\Middleware\IsDemoUser;
use FireflyIII\Models\Configuration;
use FireflyIII\Models\PeriodStatistic;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
use FireflyIII\Support\Facades\Amount;
use FireflyIII\Support\Facades\AppConfiguration;
use FireflyIII\Support\Facades\Preferences;
use FireflyIII\Support\Facades\Steam;
use FireflyIII\Support\Http\Controllers\GetConfigurationData;
use FireflyIII\Support\Models\AccountBalanceCalculator;
use FireflyIII\Support\System\IsOldVersion;
use FireflyIII\User;
use Illuminate\Contracts\View\Factory;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Route;
use Illuminate\View\View;
use Monolog\Handler\RotatingFileHandler;
use Safe\Exceptions\FilesystemException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

use function Safe\file_get_contents;
use function Safe\ini_get;

use const PHP_INT_SIZE;
use const PHP_SAPI;

/**
 * Class DebugController
 */
final class DebugController extends Controller
{
    use GetConfigurationData;
    use IsOldVersion;

    /**
     * DebugController constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->middleware(IsDemoUser::class)->except(['displayError']);
    }

    public function apiTest(): View
    {
        return view('test.api-test');
    }

    /**
     * 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.');
        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.
     *
     * @throws FireflyException
     */
    public function flush(Request $request): View
    {
        if ($this->hasNoTables() || $this->isOldVersionInstalled()) {
            throw new FireflyException('This is not the moment.');
        }
        Preferences::mark();
        $request->session()->forget(['start', 'end', '_previous', 'viewRange', 'range', 'is_custom_range', 'temp-mfa-secret', 'temp-mfa-codes']);

        Cache::clear();
        Artisan::call('config:clear');
        Artisan::call('route:clear');
        Artisan::call('view:clear');

        PeriodStatistic::query()->where('id', '>', 0)->delete();

        // also do some recalculations.
        Artisan::call('correction:recalculates-liabilities');
        if (true === AppConfiguration::get('use_running_balance', config('firefly.feature_flags.running_balance_column'))->data) {
            AccountBalanceCalculator::recalculateAll(false);
        }

        Artisan::call('view:clear');

        return view('flush');

        // return redirect(route('index'));
    }

    /**
     * Show debug info.
     *
     * @return Factory|View
     *
     * @throws FilesystemException
     */
    public function index(): Factory|\Illuminate\Contracts\View\View
    {
        $table      = $this->generateTable();
        $table      = str_replace(["\n", "\t", '  '], '', $table);
        $now        = now(config('app.timezone'))->format('Y-m-d H:i:s');
        $logContent = '';

        if (auth()->check() && auth()->user()->hasRole('owner')) {
            // get latest log file:
            $logger   = Log::driver();
            // PHPstan doesn't recognize the method because of its polymorphic nature.
            $handlers = $logger->getHandlers();

            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, -16_384);
            }
        }

        return view('debug', ['table' => $table, 'now' => $now, 'logContent' => $logContent]);
    }

    public function routes(Request $request): never
    {
        if (!auth()->user()->hasRole('owner')) {
            throw new NotFoundHttpException();
        }

        /** @var iterable $routes */
        $routes = Route::getRoutes();

        if ('true' === $request->input('api')) {
            $collection = [];
            $i          = 0;

            echo 'PATHS="';

            /** @var \Illuminate\Routing\Route $route */
            foreach ($routes as $route) {
                ++$i;
                // skip API and other routes.
                if (!str_starts_with($route->uri(), 'api/v1')) {
                    continue;
                }
                // skip non GET routes
                if (!in_array('GET', $route->methods(), true)) {
                    continue;
                }
                // no name route:
                if (null === $route->getName()) {
                    exit('Route name is NULL, cannot deal with this.');
                }

                echo substr($route->uri(), 3);
                if (0 === ($i % 5)) {
                    echo '"<br>PATHS="${PATHS},';
                }
                if (0 !== ($i % 5)) {
                    echo ',';
                }
            }

            exit;
        }

        $return = [];

        /** @var \Illuminate\Routing\Route $route */
        foreach ($routes as $route) {
            // skip API and other routes.
            if (
                str_starts_with($route->uri(), 'api')
                || str_starts_with($route->uri(), '_debugbar')
                || str_starts_with($route->uri(), '_ignition')
                || str_starts_with($route->uri(), 'oauth')
                || str_starts_with($route->uri(), 'chart')
                || str_starts_with($route->uri(), 'v1/jscript')
                || str_starts_with($route->uri(), 'v2/jscript')
                || str_starts_with($route->uri(), 'json')
                || str_starts_with($route->uri(), 'sanctum')
            ) {
                continue;
            }
            // skip non GET routes
            if (!in_array('GET', $route->methods(), true)) {
                continue;
            }
            // no name route:
            if (null === $route->getName()) {
                exit('Route name is NULL, cannot deal with this.');
            }
            if (!str_contains($route->uri(), '{')) {
                $return[$route->getName()] = route($route->getName());

                continue;
            }
            $params                    = [];
            foreach ($route->parameterNames() as $name) {
                $params[] = $this->getParameter($name);
            }
            $return[$route->getName()] = route($route->getName(), $params);
        }
        $count  = 0;
        echo '<hr>';
        echo '<h1>Routes</h1>';
        echo sprintf('<h2>%s</h2>', $count);
        foreach ($return as $name => $path) {
            echo sprintf('<a href="%1$s">%2$s</a><br>', $path, $name);
            echo PHP_EOL;
            ++$count;
            if (0 === ($count % 10)) {
                echo '<hr>';
                echo sprintf('<h2>%s</h2>', $count);
            }
        }

        exit;
    }

    /**
     * Flash all types of messages.
     */
    public function testFlash(Request $request): RedirectResponse
    {
        $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'));
    }

    private function generateTable(): string
    {
        // system information:
        $system = $this->getSystemInformation();
        $docker = $this->getBuildInfo();
        $app    = $this->getAppInfo();
        $user   = $this->getUserInfo();

        return (string) view('partials.debug-table', ['system' => $system, 'docker' => $docker, 'app' => $app, 'user' => $user]);
    }

    private function getAppInfo(): array
    {
        $userGuard = config('auth.defaults.guard');

        $config    = AppConfiguration::get('last_rt_job', 0);
        // last_rt_job_1
        $configs   = AppConfiguration::getByPrefix('last_rt_job');
        $cronJobs  = [];

        /** @var Configuration $item */
        foreach ($configs as $item) {
            if ('last_rt_job' === $item->name) {
                continue;
            }
            $parts  = explode('_', $item->name);
            $userId = (int) $parts[count($parts) - 1];
            $time   = (int) $config->data;
            if ($time > 0) {
                $carbon      = Carbon::createFromTimestamp($time);
                $lastCronjob = $carbon->format('Y-m-d H:i:s');
                $cronJobs[]  = [
                    'user'         => $userId,
                    'last_run'     => $lastCronjob,
                    'last_run_ago' => Steam::secondsAsTime((int) $carbon->diffInSeconds(now(config('app.timezone')))),
                ];
            }
        }

        return [
            'debug'              => var_export(config('app.debug'), return: true),
            'audit_log_channel'  => implode(', ', config('logging.channels.audit.channels')),
            'default_language'   => (string) config('firefly.default_language'),
            'default_locale'     => (string) config('firefly.default_locale'),
            'remote_header'      => 'remote_user_guard' === $userGuard ? config('auth.guard_header') : 'N/A',
            'remote_mail_header' => 'remote_user_guard' === $userGuard ? config('auth.guard_email') : 'N/A',
            // 'stateful_domains'   => implode(', ', config('sanctum.stateful')),
            'cron_jobs'          => $cronJobs,
            // the dates for the cron job are based on the recurring cron job's times.
            // any of the cron jobs will do, they always run at the same time.
            // but this job is the oldest, so the biggest chance it ran once
            //            'last_cronjob'       => $lastCronjob,
            //            'last_cronjob_ago'   => $lastCronjobAgo,
        ];
    }

    private function getBuildInfo(): array
    {
        $return = [
            'is_docker'       => config('firefly.is_docker'),
            'build'           => '(unknown)',
            'build_date'      => '(unknown)',
            'base_build'      => config('firefly.base_image_build'),
            'base_build_date' => config('firefly.base_image_date'),
        ];

        try {
            if (file_exists('/var/www/counter-main.txt')) {
                $return['build'] = trim(file_get_contents('/var/www/counter-main.txt'));
                Log::debug(sprintf('build is now "%s"', $return['build']));
            }
        } catch (Exception $e) {
            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) {
            Log::debug('Could not check build date, but thats ok.');
            Log::warning($e->getMessage());
        }

        return $return;
    }

    private function getParameter(string $name): string
    {
        switch ($name) {
            default:
                throw new FireflyException(sprintf('Unknown parameter "%s"', $name));

            case 'cliToken':
            case 'token':
            case 'code':
            case 'oldAddressHash':
                return 'fake-token';

            case 'objectType':
                return 'asset';

            case 'account':

            case 'attachment':

            case 'bill':

            case 'budget':

            case 'budgetLimit':

            case 'category':

            case 'currency':

            case 'tag':

            case 'piggyBank':

            case 'objectGroup':

            case 'recurrence':

            case 'tj':

            case 'ruleGroup':

            case 'rule':

            case 'tagOrId':

            case 'transactionGroup':

            case 'journalLink':

            case 'webhook':

            case 'user':

            case 'linkType':

            case 'userGroup':
                return '1';

            case 'start_date':

            case 'date':
                return '20241201';

            case 'end_date':
                return '20241231';

            case 'fromCurrencyCode':
                return 'EUR';

            case 'toCurrencyCode':
                return 'USD';

            case 'accountList':
                return '1,6';

            case 'budgetList':
            case 'categoryList':
            case 'doubleList':
            case 'tagList':
            case 'journalList':
                return '1,2';

            case 'route':
                return 'accounts';

            case 'specificPage':
                return 'show';

            case 'reportType':
                return 'default';

            case 'transactionType':
                return 'withdrawal';
        }
    }

    private function getSystemInformation(): array
    {
        $maxFileSize   = Steam::phpBytes(ini_get('upload_max_filesize'));
        $maxPostSize   = Steam::phpBytes(ini_get('post_max_size'));
        $drivers       = DB::availableDrivers();
        $currentDriver = DB::getDriverName();

        return [
            'php_version'     => PHP_VERSION,
            'php_os'          => PHP_OS,
            'build_time'      => config('firefly.build_time'),
            'build_time_nice' => Carbon::parse(config('firefly.build_time'), 'Europe/Amsterdam')->setTimezone('Europe/Amsterdam')->format('Y-m-d H:i:s e'),
            'uname'           => php_uname('m'),
            'installation_id' => AppConfiguration::get('installation_id', '(no ID)')->data,
            'interface'       => PHP_SAPI,
            'bits'            => PHP_INT_SIZE * 8,
            '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,
        ];
    }

    private function getUserFlags(): string
    {
        $flags      = [];

        /** @var User $user */
        $user       = auth()->user();

        // has liabilities
        if ($user->accounts()->accountTypeIn([AccountTypeEnum::DEBT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value])->count() > 0) {
            $flags[] = '<span title="Has liabilities">:credit_card:</span>';
        }

        // has piggies
        $repository = app(PiggyBankRepositoryInterface::class);
        $repository->setUser($user);

        if ($repository->getPiggyBanks()->count() > 0) {
            $flags[] = '<span title="Has piggy banks">:pig:</span>';
        }

        // has stored reconciliations
        $type       = TransactionType::whereType(TransactionTypeEnum::RECONCILIATION->value)->first();
        if ($user->transactionJournals()->where('transaction_type_id', $type->id)->count() > 0) {
            $flags[] = '<span title="Has reconciled">:ledger:</span>';
        }

        // has used importer?

        // has rules
        if ($user->rules()->count() > 0) {
            $flags[] = '<span title="Has rules">:wrench:</span>';
        }

        // has recurring transactions
        if ($user->recurrences()->count() > 0) {
            $flags[] = '<span title="Has recurring transactions">:clock130:</span>';
        }

        // has groups
        if ($user->objectGroups()->count() > 0) {
            $flags[] = '<span title="Has object groups">:bookmark_tabs:</span>';
        }

        // uses bills
        if ($user->bills()->count() > 0) {
            $flags[] = '<span title="Has subscriptions">:email:</span>';
        }

        return implode(' ', $flags);
    }

    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          = Steam::getLocaleArray(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, (string) $original);

        return [
            'user_id'            => auth()->user()->id,
            'user_count'         => User::count(),
            'user_flags'         => $userFlags,
            'user_agent'         => $userAgent,
            'primary'            => Amount::getPrimaryCurrency(),
            'convert_to_primary' => Amount::convertToPrimary(),
            'locale_attempts'    => $localeAttempts,
            'locale'             => Steam::getLocale(),
            'language'           => Steam::getLanguage(),
            'view_range'         => Preferences::get('viewRange', '1M')->data,
        ];
    }
}