Skip to content

Firefly III: a personal finances manager

2.8 KB
Raw Blame
<?php

/*
 * ValidatesFilePermissions.php
 * Copyright (c) 2026 [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\Console\Commands\Integrity;

use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Log;

class ValidatesFilePermissions extends Command
{
    use ShowsFriendlyMessages;

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature   = 'integrity:file-permissions';

    /**
     * Execute the console command.
     */
    public function handle(): int
    {
        Log::debug(sprintf('Start of %s', $this->signature));
        $directories = [storage_path('upload')];
        $errors      = false;

        /** @var string $directory */
        foreach ($directories as $directory) {
            Log::debug(sprintf('Processing directory: %s', $directory));
            if (!is_dir($directory)) {
                $message = sprintf('Directory "%s" cannot found. It is necessary to allow files to be uploaded.', $directory);
                Log::error($message);
                $this->friendlyError($message);
                $errors  = true;

                continue;
            }
            Log::debug('It is a directory!');
            if (!is_writable($directory)) {
                $message = sprintf('Directory "%s" is not writeable. Uploading attachments may fail silently.', $directory);
                $this->friendlyError($message);
                Log::error($message);
                $errors  = true;
            }
            Log::debug('It is writeable!');
            Log::debug(sprintf('Done processing %s', $directory));
        }
        Log::debug('Done with loop.');
        if (false === $errors) {
            Log::debug('No errors.');
            $this->friendlyInfo('All necessary file paths seem to exist, and are writeable.');
        }

        Log::debug(sprintf('End of %s', $this->signature));

        return self::SUCCESS;
    }
}