silverstripe / silverstripe-externallinks

src/Controllers/CMSExternalLinksController.php

<?php

namespace SilverStripe\ExternalLinks\Controllers;

use SilverStripe\Control\HTTP;
use SilverStripe\Core\Convert;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\ExternalLinks\Jobs\CheckExternalLinksJob;
use SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask;
use SilverStripe\Control\Controller;
use Symbiote\QueuedJobs\Services\QueuedJobService;

The type Symbiote\QueuedJobs\Services\QueuedJobService was not found. Maybe you did not declare it correctly or list all dependencies?

class CMSExternalLinksController extends Controller
{

    private static $allowed_actions = [

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

        'getJobStatus',
        'start'
    ];

    /**
     * Respond to Ajax requests for info on a running job
     *
     * @return string JSON string detailing status of the job
     */
    public function getJobStatus()
    {
        // Set headers
        HTTP::set_cache_age(0);

The function SilverStripe\Control\HTTP::set_cache_age() has been deprecated: 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead

        HTTP::add_cache_headers($this->response);

The function SilverStripe\Control\HTTP::add_cache_headers() has been deprecated: 4.2.0:5.0.0 Headers are added automatically by HTTPCacheControlMiddleware instead.

        $this->response
            ->addHeader('Content-Type', 'application/json')
            ->addHeader('Content-Encoding', 'UTF-8')
            ->addHeader('X-Content-Type-Options', 'nosniff');

        // Format status
        $track = BrokenExternalPageTrackStatus::get_latest();
        if ($track) {

$track is of type SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus, thus it always evaluated to true.

            return json_encode([
                'TrackID' => $track->ID,
                'Status' => $track->Status,
                'Completed' => $track->getCompletedPages(),
                'Total' => $track->getTotalPages()
            ]);
        }
    }


    /**
     * Starts a broken external link check
     */
    public function start()
    {
        // return if the a job is already running
        $status = BrokenExternalPageTrackStatus::get_latest();
        if ($status && $status->Status == 'Running') {
            return;
        }

        // Create a new job
        if (class_exists(QueuedJobService::class)) {
            // Force the creation of a new run
            BrokenExternalPageTrackStatus::create_status();
            $checkLinks = new CheckExternalLinksJob();
            singleton(QueuedJobService::class)->queueJob($checkLinks);
        } else {
            //TODO this hangs as it waits for the connection to be released
            // should return back and continue processing
            // http://us3.php.net/manual/en/features.connection-handling.php
            $task = CheckExternalLinksTask::create();
            $task->runLinksCheck();
        }
    }
}