signify-nz / silverstripe-security-headers

src/Jobs/RemoveUnreferencedCSPDocumentJob.php

<?php
namespace Signify\Jobs;

use Signify\Models\CSPDocument;
use Signify\Models\CSPViolation;
use Signify\Reports\CSPViolationsReport;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataList;
use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
use SilverStripe\ORM\DB;

class RemoveUnreferencedCSPDocumentJob extends AbstractQueuedJob
{

    public function setup()
    {
        $this->lastSeenID = -1;

The property lastSeenID does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->documentsDeleted = 0;

The property documentsDeleted does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->totalSteps = CSPDocument::get()->count();
    }

    public function process()
    {
        $batchSize = Config::inst()->get(CSPViolationsReport::class, 'deletion_batch_size');

        $deleted = 0;
        $delta = 0;

        // Wrapped in a transaction for performance only.
        try {
            DB::get_conn()->transactionStart();

            $documents = $this->getItemsList()->limit($batchSize);

            $lastDocument = $documents->last();
            if ($lastDocument) {
                $this->lastSeenID = $lastDocument->ID;

The property lastSeenID does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                unset($lastDocument);
            }

            /** @var CSPViolation $document */
            foreach ($documents as $document) {
                if (!$document->CSPViolations()->first()) {
                    # See https://github.com/silverstripe/silverstripe-framework/issues/1903
                    $document->CSPViolations()->removeAll();

                    $document->delete();
                    ++$deleted;
                }
                ++$delta;
            }
        }
        finally {
            DB::get_conn()->transactionEnd();
        }

        $this->documentsDeleted += $deleted;
        $this->currentStep += $delta;

        if ($delta < $batchSize) {
            $this->isComplete = true;
            print 'Removed ' . number_format($this->documentsDeleted) . ' unreferenced document URIs.';
        }
    }

    public function getTitle()
    {
        return 'Remove unreferenced CSP Document URIs';
    }

    private function getItemsList(): DataList
    {
        return CSPDocument::get()
            ->filter(['ID:GreaterThan' => $this->lastSeenID])
            ->sort('ID');
    }
}