CheckExternalLinksTask::updateJobInfo() - Code Metrics - Inspection of "Merge pull request #27 from creative-commoners/pul..." - silverstripe/silverstripe-externallinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9ea506...789ce9 )

by Robbie

created 2017-11-27 06:41 UTC

CheckExternalLinksTask::updateJobInfo() A

↳ Parent: CheckExternalLinksTask

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace SilverStripe\ExternalLinks\Tasks;

use SilverStripe\ExternalLinks\Model\BrokenExternalLink;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrack;
use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\Dev\Debug;
use DOMNode;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ExternalLinks\Tasks\LinkChecker;
use SilverStripe\CMS\Model\SiteTree;

class CheckExternalLinksTask extends BuildTask
{

    private static $dependencies = [

        'LinkChecker' => '%$' . LinkChecker::class
    ];

    /**
     * @var bool
     */
    protected $silent = false;

    /**
     * @var LinkChecker
     */
    protected $linkChecker;

    protected $title = 'Checking broken External links in the SiteTree';

    protected $description = 'A task that records external broken links in the SiteTree';

    protected $enabled = true;

    /**
     * Log a message
     *
     * @param string $message
     */
    protected function log($message)
    {
        if (!$this->silent) {
            Debug::message($message);
        }
    }

    public function run($request)
    {
        $this->runLinksCheck();
    }
    /**
     * Turn on or off message output
     *
     * @param bool $silent
     */
    public function setSilent($silent)
    {
        $this->silent = $silent;
    }

    /**
     * @param LinkChecker $linkChecker
     */
    public function setLinkChecker(LinkChecker $linkChecker)
    {
        $this->linkChecker = $linkChecker;
    }

    /**
     * @return LinkChecker
     */
    public function getLinkChecker()
    {
        return $this->linkChecker;
    }

    /**
     * Check the status of a single link on a page
     *
     * @param BrokenExternalPageTrack $pageTrack
     * @param DOMNode $link
     */
    protected function checkPageLink(BrokenExternalPageTrack $pageTrack, DOMNode $link)
    {
        $class = $link->getAttribute('class');
        $href = $link->getAttribute('href');
        $markedBroken = preg_match('/\b(ss-broken)\b/', $class);

        // Check link
        $httpCode = $this->linkChecker->checkLink($href);
        if ($httpCode === null) {
            return; // Null link means uncheckable, such as an internal link
        }

        // If this code is broken then mark as such
        if ($foundBroken = $this->isCodeBroken($httpCode)) {
            // Create broken record
            $brokenLink = new BrokenExternalLink();
            $brokenLink->Link = $href;

            $brokenLink->HTTPCode = $httpCode;

            $brokenLink->TrackID = $pageTrack->ID;

            $brokenLink->StatusID = $pageTrack->StatusID; // Slight denormalisation here for performance reasons

            $brokenLink->write();
        }

        // Check if we need to update CSS class, otherwise return
        if ($markedBroken == $foundBroken) {
            return;
        }
        if ($foundBroken) {
            $class .= ' ss-broken';
        } else {
            $class = preg_replace('/\s*\b(ss-broken)\b\s*/', ' ', $class);
        }
        $link->setAttribute('class', trim($class));
    }

    /**
     * Determine if the given HTTP code is "broken"
     *
     * @param int $httpCode
     * @return bool True if this is a broken code
     */
    protected function isCodeBroken($httpCode)
    {
        // Null represents no request attempted
        if ($httpCode === null) {
            return false;
        }

        // do we have any whitelisted codes
        $ignoreCodes = $this->config()->get('IgnoreCodes');
        if (is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) {
            return false;
        }

        // Check if code is outside valid range
        return $httpCode < 200 || $httpCode > 302;
    }

    /**
     * Runs the links checker and returns the track used
     *
     * @param int $limit Limit to number of pages to run, or null to run all
     * @return BrokenExternalPageTrackStatus
     */
    public function runLinksCheck($limit = null)
    {
        // Check the current status
        $status = BrokenExternalPageTrackStatus::get_or_create();

        // Calculate pages to run
        $pageTracks = $status->getIncompleteTracks();
        if ($limit) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $pageTracks = $pageTracks->limit($limit);
        }

        // Check each page
        foreach ($pageTracks as $pageTrack) {
            // Flag as complete
            $pageTrack->Processed = 1;
            $pageTrack->write();

            // Check value of html area
            $page = $pageTrack->Page();
            $this->log("Checking {$page->Title}");
            $htmlValue = Injector::inst()->create('HTMLValue', $page->Content);
            if (!$htmlValue->isValid()) {
                continue;
            }

            // Check each link
            $links = $htmlValue->getElementsByTagName('a');
            foreach ($links as $link) {
                $this->checkPageLink($pageTrack, $link);
            }

            // Update content of page based on link fixes / breakages
            $htmlValue->saveHTML();
            $page->Content = $htmlValue->getContent();
            $page->write();

            // Once all links have been created for this page update HasBrokenLinks
            $count = $pageTrack->BrokenLinks()->count();
            $this->log("Found {$count} broken links");
            if ($count) {
                $siteTreeTable = DataObject::getSchema()->tableName(SiteTree::class);
                // Bypass the ORM as syncLinkTracking does not allow you to update HasBrokenLink to true
                DB::query(sprintf(
                    'UPDATE "%s" SET "HasBrokenLink" = 1 WHERE "ID" = \'%d\'',
                    $siteTreeTable,
                    intval($pageTrack->ID)
                ));
            }
        }

        $status->updateJobInfo('Updating completed pages');
        $status->updateStatus();
        return $status;
    }

    private function updateCompletedPages($trackID = 0)

    {
        $noPages = BrokenExternalPageTrack::get()
            ->filter(array(
                'TrackID' => $trackID,
                'Processed' => 1
            ))
            ->count();
        $track = BrokenExternalPageTrackStatus::get_latest();
        $track->CompletedPages = $noPages;
        $track->write();
        return $noPages;
    }

    private function updateJobInfo($message)
    {
        $track = BrokenExternalPageTrackStatus::get_latest();
        if ($track) {
            $track->JobInfo = $message;

            $track->write();
        }
    }
}


1			<?php
2
3			namespace SilverStripe\ExternalLinks\Tasks;
4
5			use SilverStripe\ExternalLinks\Model\BrokenExternalLink;
6			use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrack;
7			use SilverStripe\ExternalLinks\Model\BrokenExternalPageTrackStatus;
8			use SilverStripe\Dev\BuildTask;
9			use SilverStripe\Core\Config\Config;
10			use SilverStripe\ORM\DataObject;
11			use SilverStripe\ORM\DB;
12			use SilverStripe\Dev\Debug;
13			use DOMNode;
14			use SilverStripe\Core\Injector\Injector;
15			use SilverStripe\ExternalLinks\Tasks\LinkChecker;
16			use SilverStripe\CMS\Model\SiteTree;
17
18			class CheckExternalLinksTask extends BuildTask
19			{
20
21			private static $dependencies = [
			0 ignored issues – show introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The private property `$dependencies` is not used, and could be removed. Loading history...
22			'LinkChecker' => '%$' . LinkChecker::class
23			];
24
25			/**
26			* @var bool
27			*/
28			protected $silent = false;
29
30			/**
31			* @var LinkChecker
32			*/
33			protected $linkChecker;
34
35			protected $title = 'Checking broken External links in the SiteTree';
36
37			protected $description = 'A task that records external broken links in the SiteTree';
38
39			protected $enabled = true;
40
41			/**
42			* Log a message
43			*
44			* @param string $message
45			*/
46			protected function log($message)
47			{
48			if (!$this->silent) {
49			Debug::message($message);
50			}
51			}
52
53			public function run($request)
54			{
55			$this->runLinksCheck();
56			}
57			/**
58			* Turn on or off message output
59			*
60			* @param bool $silent
61			*/
62			public function setSilent($silent)
63			{
64			$this->silent = $silent;
65			}
66
67			/**
68			* @param LinkChecker $linkChecker
69			*/
70			public function setLinkChecker(LinkChecker $linkChecker)
71			{
72			$this->linkChecker = $linkChecker;
73			}
74
75			/**
76			* @return LinkChecker
77			*/
78			public function getLinkChecker()
79			{
80			return $this->linkChecker;
81			}
82
83			/**
84			* Check the status of a single link on a page
85			*
86			* @param BrokenExternalPageTrack $pageTrack
87			* @param DOMNode $link
88			*/
89			protected function checkPageLink(BrokenExternalPageTrack $pageTrack, DOMNode $link)
90			{
91			$class = $link->getAttribute('class');
92			$href = $link->getAttribute('href');
93			$markedBroken = preg_match('/\b(ss-broken)\b/', $class);
94
95			// Check link
96			$httpCode = $this->linkChecker->checkLink($href);
97			if ($httpCode === null) {
98			return; // Null link means uncheckable, such as an internal link
99			}
100
101			// If this code is broken then mark as such
102			if ($foundBroken = $this->isCodeBroken($httpCode)) {
103			// Create broken record
104			$brokenLink = new BrokenExternalLink();
105			$brokenLink->Link = $href;
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `Link` does not exist on `SilverStripe\ExternalLin...odel\BrokenExternalLink`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
106			$brokenLink->HTTPCode = $httpCode;
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `HTTPCode` does not exist on `SilverStripe\ExternalLin...odel\BrokenExternalLink`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
107			$brokenLink->TrackID = $pageTrack->ID;
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `TrackID` does not exist on `SilverStripe\ExternalLin...odel\BrokenExternalLink`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
108			$brokenLink->StatusID = $pageTrack->StatusID; // Slight denormalisation here for performance reasons
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `StatusID` does not exist on `SilverStripe\ExternalLin...BrokenExternalPageTrack`. Since you implemented `__get`, consider adding a @property annotation. Loading history... Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `StatusID` does not exist on `SilverStripe\ExternalLin...odel\BrokenExternalLink`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
109			$brokenLink->write();
110			}
111
112			// Check if we need to update CSS class, otherwise return
113			if ($markedBroken == $foundBroken) {
114			return;
115			}
116			if ($foundBroken) {
117			$class .= ' ss-broken';
118			} else {
119			$class = preg_replace('/\s\b(ss-broken)\b\s/', ' ', $class);
120			}
121			$link->setAttribute('class', trim($class));
122			}
123
124			/**
125			* Determine if the given HTTP code is "broken"
126			*
127			* @param int $httpCode
128			* @return bool True if this is a broken code
129			*/
130			protected function isCodeBroken($httpCode)
131			{
132			// Null represents no request attempted
133			if ($httpCode === null) {
134			return false;
135			}
136
137			// do we have any whitelisted codes
138			$ignoreCodes = $this->config()->get('IgnoreCodes');
139			if (is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) {
140			return false;
141			}
142
143			// Check if code is outside valid range
144			return $httpCode < 200 \|\| $httpCode > 302;
145			}
146
147			/**
148			* Runs the links checker and returns the track used
149			*
150			* @param int $limit Limit to number of pages to run, or null to run all
151			* @return BrokenExternalPageTrackStatus
152			*/
153			public function runLinksCheck($limit = null)
154			{
155			// Check the current status
156			$status = BrokenExternalPageTrackStatus::get_or_create();
157
158			// Calculate pages to run
159			$pageTracks = $status->getIncompleteTracks();
160			if ($limit) {
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The expression `$limit` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
161			$pageTracks = $pageTracks->limit($limit);
162			}
163
164			// Check each page
165			foreach ($pageTracks as $pageTrack) {
166			// Flag as complete
167			$pageTrack->Processed = 1;
168			$pageTrack->write();
169
170			// Check value of html area
171			$page = $pageTrack->Page();
172			$this->log("Checking {$page->Title}");
173			$htmlValue = Injector::inst()->create('HTMLValue', $page->Content);
174			if (!$htmlValue->isValid()) {
175			continue;
176			}
177
178			// Check each link
179			$links = $htmlValue->getElementsByTagName('a');
180			foreach ($links as $link) {
181			$this->checkPageLink($pageTrack, $link);
182			}
183
184			// Update content of page based on link fixes / breakages
185			$htmlValue->saveHTML();
186			$page->Content = $htmlValue->getContent();
187			$page->write();
188
189			// Once all links have been created for this page update HasBrokenLinks
190			$count = $pageTrack->BrokenLinks()->count();
191			$this->log("Found {$count} broken links");
192			if ($count) {
193			$siteTreeTable = DataObject::getSchema()->tableName(SiteTree::class);
194			// Bypass the ORM as syncLinkTracking does not allow you to update HasBrokenLink to true
195			DB::query(sprintf(
196			'UPDATE "%s" SET "HasBrokenLink" = 1 WHERE "ID" = \'%d\'',
197			$siteTreeTable,
198			intval($pageTrack->ID)
199			));
200			}
201			}
202
203			$status->updateJobInfo('Updating completed pages');
204			$status->updateStatus();
205			return $status;
206			}
207
208			private function updateCompletedPages($trackID = 0)
			0 ignored issues – show Unused Code introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The method `updateCompletedPages()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
209			{
210			$noPages = BrokenExternalPageTrack::get()
211			->filter(array(
212			'TrackID' => $trackID,
213			'Processed' => 1
214			))
215			->count();
216			$track = BrokenExternalPageTrackStatus::get_latest();
217			$track->CompletedPages = $noPages;
218			$track->write();
219			return $noPages;
220			}
221
222			private function updateJobInfo($message)
223			{
224			$track = BrokenExternalPageTrackStatus::get_latest();
225			if ($track) {
226			$track->JobInfo = $message;
			0 ignored issues – show Bug Best Practice introduced 2017-11-23 02:03 UTC by Report Bug Copy Issue Report The property `JobInfo` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
227			$track->write();
228			}
229			}
230			}
231

silverstripe / silverstripe-externallinks

Push — master ( 9ea506...789ce9 )

CheckExternalLinksTask::updateJobInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like