blobdir::cleanup_corrupted() - Code Metrics - Inspection of "Also check for orphaned attachments (not only file..." - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( dc3f28...9cb9a1 )

by Andreas
created 2024-11-13 11:02 UTC
blobdir::cleanup_corrupted() A

↳ Parent: blobdir
Complexity

Conditions	3
Paths	3
Size

Total Lines	11
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
eloc	7
c	1
b	0
f	0
nc	3
nop	2
dl	0
loc	11
ccs	0
cts	8
cp	0
crap	12
rs	10
<?php
/**
 * @package midcom.console
 * @author CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @copyright CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License
 */

namespace midcom\console\command\cleanup;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use midcom_db_attachment;
use Symfony\Component\Console\Attribute\AsCommand;
use midgard\portable\storage\connection;
use Doctrine\ORM\AbstractQuery;

/**
 * Cleanup the blobdir
 * Search for corrupted (0 bytes) files
 *
 * @package midcom.console
 */
#[AsCommand(
    name: 'midcom:cleanup:blobdir',
    description: 'Cleanup the blobdir',
    aliases: ['blobdircleanup']
)]
class blobdir extends Command
{
    private int $_file_counter = 0;

    private string $_dir = "";

    private bool $dry = false;

    private array $findings = [
        'corrupted' => [],
        'orphaned' => [],
        'orphaned_attachments' => []
    ];

    protected function configure()
    {
        $this->addOption('dry', 'd', InputOption::VALUE_NONE, 'If set, files and attachments will not be deleted');
    }

    public function check_dir(string $outerDir)
    {
        $outerDir = rtrim($outerDir, "/");
        $dirs = array_diff(scandir($outerDir), [".", ".."]);
        foreach ($dirs as $d) {
            if (is_dir($outerDir . "/" . $d)) {
                $this->check_dir($outerDir . "/" . $d);
            } else {
                // got something
                $file = $outerDir . "/" . $d;
                if (filesize($file) == 0) {
                    $this->findings['corrupted'][] = $file;
                } else {
                    $attachment = $this->get_attachment($file);
                    if (!$attachment) {
                        $this->findings['orphaned'][] = $file;
                    } elseif (!$this->get_attachment_parent($attachment)) {
                        $this->findings['orphaned_attachments'][] = $attachment;
                    }
                }
                $this->_file_counter++;
            }
        }
    }

    private function _determine_location(string $path) : string
    {
        return ltrim(str_replace($this->_dir, "", $path), "/");
    }

    private function get_attachment_parent(midcom_db_attachment $attachment) : bool
    {
        $type = connection::get_em()
            ->createQuery('SELECT r.typename from midgard_repligard r WHERE r.guid = ?1')
            ->setParameter(1, $attachment->parentguid)
            ->getOneOrNullResult(AbstractQuery::HYDRATE_SINGLE_SCALAR);

        if (!$type) {
            return false;
        }

        $dba_type = \midcom::get()->dbclassloader->get_midcom_class_name_for_mgdschema_object($type);

        $qb = \midcom::get()->dbfactory->new_query_builder($dba_type);
        $qb = \midcom::get()->dbfactory->new_query_builder(/** @scrutinizer ignore-type */ $dba_type);
        $qb->include_deleted();
        $qb->add_constraint('guid', '=', $attachment->parentguid);
        return $qb->count() > 0;
    }

    private function get_attachment(string $file) : ?midcom_db_attachment
    {
        $location = $this->_determine_location($file);
        // get attachments
        $qb = midcom_db_attachment::new_query_builder();
        $qb->add_constraint("location", "=", $location);
        try {
            $attachments = $qb->execute();
        } catch (\Exception) {
            return null;
        }
        if (empty($attachments)) {
            return null;
        }
        if (count($attachments) > 1) {
            throw new \midcom_error('Multiple attachments share location ' . $location);
        }

        return $attachments[0];
    }

    private function cleanup_corrupted(OutputInterface $output, array $files)
    {
        $i = 0;
        foreach ($files as $file) {
            $i++;
            // cleanup file
            $output->writeln($i . ") " . $file);
            $this->cleanup_file($output, $file);

            if ($attachment = $this->get_attachment($file)) {
                $this->purge_attachment($output, $attachment);
            }
        }
    }

    private function purge_attachment(OutputInterface $output, midcom_db_attachment $attachment)
    {
        if (!$this->dry) {
            $stat = $attachment->purge();
            if (!$stat || $output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                $output->writeln(($stat) ? "<info>Purge OK</info>" : "<comment>Purge FAILED, reason: " . \midcom_connection::get_error_string() . "</comment>");
            }
        }
    }

    private function cleanup_file(OutputInterface $output, string $file)
    {
        if (!$this->dry) {
            $stat = unlink($file);
            if (!$stat || $output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                $output->writeln(($stat) ? "<info>Cleanup OK</info>" : "<comment>Cleanup FAILED</comment>");
            }
        }
    }

    protected function execute(InputInterface $input, OutputInterface $output) : int
    {
        $dir = \midgard_connection::get_instance()->config->blobdir;
        if (!is_dir($dir)) {
            $output->writeln("<comment>Unable to detect blobdir</comment>");
            return Command::FAILURE;
        }
        $this->_dir = $dir;
        $this->dry = $input->getOption("dry");
        if ($this->dry) {
            $output->writeln("<comment>Running in dry mode!</comment>");
        }

        $output->writeln("Start scanning dir: <comment>" . $dir . "</comment>");

        $this->check_dir($dir);

        $output->writeln("Scanned <info>" . $this->_file_counter . "</info> files");
        $output->writeln("Found <info>" . count($this->findings['corrupted']) . "</info> corrupted files");
        $output->writeln("Found <info>" . count($this->findings['orphaned']) . "</info> orphaned files");
        $output->writeln("Found <info>" . count($this->findings['orphaned_attachments']) . "</info> orphaned attachments");

        $this->cleanup_corrupted($output, $this->findings['corrupted']);

        foreach ($this->findings['orphaned'] as $file) {
            $this->cleanup_file($output, $file);
        }

        foreach ($this->findings['orphaned_attachments'] as $attachment) {
            $this->purge_attachment($output, $attachment);
        }

        $output->writeln("<comment>Done</comment>");
        return Command::SUCCESS;
    }
}

flack / openpsa

Push — master ( dc3f28...9cb9a1 )

blobdir::cleanup_corrupted() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
