signify-nz / silverstripe-security-headers

src/Jobs/RemoveOldCSPViolationsJob.php

<?php
namespace Signify\Jobs;

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

class RemoveOldCSPViolationsJob extends AbstractQueuedJob
{
    /**
     * Reports that were last changed longer than this period ago can be deleted.
     *
     * The string must be in DateInterval duration format.
     * @see https://www.php.net/manual/en/dateinterval.construct.php
     *
     * @var string
     */
    private static $retention_period = 'P1M';

The private property $retention_period is not used, and could be removed.

    public function setup()
    {
        $retention = Config::inst()->get(self::class, 'retention_period');
        $retention = new DateInterval($retention);

        $date = new DateTime();
        $date->sub($retention);
        $this->retentionDate = $date->format(DateTime::ATOM);

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

        $this->reportsDeleted = 0;

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

        $this->totalSteps = $this->getItemsList()->count();
    }

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

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

        $delta = 0;

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

            /** @var CSPViolation $report */
            foreach ($oldReports as $report) {
                # See https://github.com/silverstripe/silverstripe-framework/issues/1903
                $report->Documents()->removeAll();
                $report->delete();
                $delta++;
            }
        }
        finally {
            DB::get_conn()->transactionEnd();
        }

        $this->reportsDeleted += $delta;
        $this->currentStep += $delta;

        if ($delta < $batchSize) {
            $this->isComplete = true;
            print 'Removed ' . number_format($this->reportsDeleted) . ' reports.' . "\n";

            $deletionJob = new RemoveUnreferencedCSPDocumentJob();
            $jobId = singleton(QueuedJobService::class)->queueJob($deletionJob);

            print "Unreferenced CSP Document job queued with ID $jobId\n";

        }
    }

    public function getTitle()
    {
        return 'Remove old CSP Violation reports';
    }

    private function getItemsList(): DataList
    {
        return CSPViolation::get()->filter(['ReportedTime:LessThan' => $this->retentionDate]);
    }
}