silverstripe / silverstripe-externallinks

src/Model/BrokenExternalPageTrack.php

Indentation +19 added lines, -19 removed lines

@@ -13,27 +13,27 @@
  */
 class BrokenExternalPageTrack extends DataObject
 {
-    private static $table_name = 'BrokenExternalPageTrack';
+	private static $table_name = 'BrokenExternalPageTrack';
 
-    private static $db = array(
-        'Processed' => 'Boolean'
-    );
+	private static $db = array(
+		'Processed' => 'Boolean'
+	);
 
-    private static $has_one = array(
-        'Page' => SiteTree::class,
-        'Status' => BrokenExternalPageTrackStatus::class
-    );
+	private static $has_one = array(
+		'Page' => SiteTree::class,
+		'Status' => BrokenExternalPageTrackStatus::class
+	);
 
-    private static $has_many = array(
-        'BrokenLinks' => BrokenExternalLink::class
-    );
+	private static $has_many = array(
+		'BrokenLinks' => BrokenExternalLink::class
+	);
 
-    /**
-     * @return SiteTree
-     */
-    public function Page()
-    {
-        return Versioned::get_by_stage(SiteTree::class, 'Stage')
-            ->byID($this->PageID);
-    }
+	/**
+	 * @return SiteTree
+	 */
+	public function Page()
+	{
+		return Versioned::get_by_stage(SiteTree::class, 'Stage')
+			->byID($this->PageID);
+	}
 }

src/Tasks/LinkChecker.php

Indentation +7 added lines, -7 removed lines

@@ -8,11 +8,11 @@
 interface LinkChecker
 {
     
-    /**
-     * Determine the http status code for a given link
-     *
-     * @param string $href URL to check
-     * @return int HTTP status code, or null if not checkable (not a link)
-     */
-    public function checkLink($href);
+	/**
+	 * Determine the http status code for a given link
+	 *
+	 * @param string $href URL to check
+	 * @return int HTTP status code, or null if not checkable (not a link)
+	 */
+	public function checkLink($href);
 }

src/Jobs/CheckExternalLinksJob.php

Indentation +27 added lines, -27 removed lines

@@ -7,7 +7,7 @@ 
 use SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask;
 
 if (!class_exists(AbstractQueuedJob::class)) {
-    return;
+	return;
 }
 
 /**
@@ -17,30 +17,30 @@ 
 class CheckExternalLinksJob extends AbstractQueuedJob implements QueuedJob
 {
 
-    public function getTitle()
-    {
-        return _t(__CLASS__ . '.TITLE', 'Checking for external broken links');
-    }
-
-    public function getJobType()
-    {
-        return QueuedJob::QUEUED;
-    }
-
-    public function getSignature()
-    {
-        return md5(get_class($this));
-    }
-
-    /**
-     * Check an individual page
-     */
-    public function process()
-    {
-        $task = CheckExternalLinksTask::create();
-        $track = $task->runLinksCheck(1);
-        $this->currentStep = $track->CompletedPages;
-        $this->totalSteps = $track->TotalPages;
-        $this->isComplete = $track->Status === 'Completed';
-    }
+	public function getTitle()
+	{
+		return _t(__CLASS__ . '.TITLE', 'Checking for external broken links');
+	}
+
+	public function getJobType()
+	{
+		return QueuedJob::QUEUED;
+	}
+
+	public function getSignature()
+	{
+		return md5(get_class($this));
+	}
+
+	/**
+	 * Check an individual page
+	 */
+	public function process()
+	{
+		$task = CheckExternalLinksTask::create();
+		$track = $task->runLinksCheck(1);
+		$this->currentStep = $track->CompletedPages;
+		$this->totalSteps = $track->TotalPages;
+		$this->isComplete = $track->Status === 'Completed';
+	}
 }

tests/ExternalLinksTest.php

Indentation +80 added lines, -80 removed lines

@@ -16,95 +16,95 @@
 class ExternalLinksTest extends SapphireTest
 {
 
-    protected static $fixture_file = 'ExternalLinksTest.yml';
+	protected static $fixture_file = 'ExternalLinksTest.yml';
 
-    protected static $extra_dataobjects = array(
-        ExternalLinksTestPage::class
-    );
+	protected static $extra_dataobjects = array(
+		ExternalLinksTestPage::class
+	);
 
-    protected function setUp()
-    {
-        parent::setUp();
+	protected function setUp()
+	{
+		parent::setUp();
 
-        // Stub link checker
-        $checker = new PretendLinkChecker;
-        Injector::inst()->registerService($checker, LinkChecker::class);
-    }
+		// Stub link checker
+		$checker = new PretendLinkChecker;
+		Injector::inst()->registerService($checker, LinkChecker::class);
+	}
 
-    public function testLinks()
-    {
-        // Run link checker
-        $task = CheckExternalLinksTask::create();
-        $task->setSilent(true); // Be quiet during the test!
-        $task->runLinksCheck();
+	public function testLinks()
+	{
+		// Run link checker
+		$task = CheckExternalLinksTask::create();
+		$task->setSilent(true); // Be quiet during the test!
+		$task->runLinksCheck();
 
-        // Get all links checked
-        $status = BrokenExternalPageTrackStatus::get_latest();
-        $this->assertEquals('Completed', $status->Status);
-        $this->assertEquals(5, $status->TotalPages);
-        $this->assertEquals(5, $status->CompletedPages);
+		// Get all links checked
+		$status = BrokenExternalPageTrackStatus::get_latest();
+		$this->assertEquals('Completed', $status->Status);
+		$this->assertEquals(5, $status->TotalPages);
+		$this->assertEquals(5, $status->CompletedPages);
 
-        // Check all pages have had the correct HTML adjusted
-        for ($i = 1; $i <= 5; $i++) {
-            $page = $this->objFromFixture(ExternalLinksTestPage::class, 'page'.$i);
-            $this->assertNotEmpty($page->Content);
-            $this->assertEquals(
-                $page->ExpectedContent,
-                $page->Content,
-                "Assert that the content of page{$i} has been updated"
-            );
-        }
+		// Check all pages have had the correct HTML adjusted
+		for ($i = 1; $i <= 5; $i++) {
+			$page = $this->objFromFixture(ExternalLinksTestPage::class, 'page'.$i);
+			$this->assertNotEmpty($page->Content);
+			$this->assertEquals(
+				$page->ExpectedContent,
+				$page->Content,
+				"Assert that the content of page{$i} has been updated"
+			);
+		}
 
-        // Check that the correct report of broken links is generated
-        $links = $status
-            ->BrokenLinks()
-            ->sort('Link');
+		// Check that the correct report of broken links is generated
+		$links = $status
+			->BrokenLinks()
+			->sort('Link');
 
-        $this->assertEquals(4, $links->count());
-        $this->assertEquals(
-            array(
-                'http://www.broken.com',
-                'http://www.broken.com/url/thing',
-                'http://www.broken.com/url/thing',
-                'http://www.nodomain.com'
-            ),
-            array_values($links->map('ID', 'Link')->toArray())
-        );
+		$this->assertEquals(4, $links->count());
+		$this->assertEquals(
+			array(
+				'http://www.broken.com',
+				'http://www.broken.com/url/thing',
+				'http://www.broken.com/url/thing',
+				'http://www.nodomain.com'
+			),
+			array_values($links->map('ID', 'Link')->toArray())
+		);
 
-        // Check response codes are correct
-        $expected = array(
-            'http://www.broken.com' => 403,
-            'http://www.broken.com/url/thing' => 404,
-            'http://www.nodomain.com' => 0
-        );
-        $actual = $links->map('Link', 'HTTPCode')->toArray();
-        $this->assertEquals($expected, $actual);
+		// Check response codes are correct
+		$expected = array(
+			'http://www.broken.com' => 403,
+			'http://www.broken.com/url/thing' => 404,
+			'http://www.nodomain.com' => 0
+		);
+		$actual = $links->map('Link', 'HTTPCode')->toArray();
+		$this->assertEquals($expected, $actual);
 
-        // Check response descriptions are correct
-        i18n::set_locale('en_NZ');
-        $expected = array(
-            'http://www.broken.com' => '403 (Forbidden)',
-            'http://www.broken.com/url/thing' => '404 (Not Found)',
-            'http://www.nodomain.com' => '0 (Server Not Available)'
-        );
-        $actual = $links->map('Link', 'HTTPCodeDescription')->toArray();
-        $this->assertEquals($expected, $actual);
-    }
+		// Check response descriptions are correct
+		i18n::set_locale('en_NZ');
+		$expected = array(
+			'http://www.broken.com' => '403 (Forbidden)',
+			'http://www.broken.com/url/thing' => '404 (Not Found)',
+			'http://www.nodomain.com' => '0 (Server Not Available)'
+		);
+		$actual = $links->map('Link', 'HTTPCodeDescription')->toArray();
+		$this->assertEquals($expected, $actual);
+	}
 
-    /**
-     * Test that broken links appears in the reports list
-     */
-    public function testReportExists()
-    {
-        $reports = Report::get_reports();
-        $reportNames = array();
-        foreach ($reports as $report) {
-            $reportNames[] = get_class($report);
-        }
-        $this->assertContains(
-            BrokenExternalLinksReport::class,
-            $reportNames,
-            'BrokenExternalLinksReport is in reports list'
-        );
-    }
+	/**
+	 * Test that broken links appears in the reports list
+	 */
+	public function testReportExists()
+	{
+		$reports = Report::get_reports();
+		$reportNames = array();
+		foreach ($reports as $report) {
+			$reportNames[] = get_class($report);
+		}
+		$this->assertContains(
+			BrokenExternalLinksReport::class,
+			$reportNames,
+			'BrokenExternalLinksReport is in reports list'
+		);
+	}
 }

src/Controllers/CMSExternalLinksController.php

Indentation +53 added lines, -53 removed lines

@@ -12,62 +12,62 @@
 class CMSExternalLinksController extends Controller
 {
 
-    private static $allowed_actions = [
-        'getJobStatus',
-        'start'
-    ];
+	private static $allowed_actions = [
+		'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);
-        HTTP::add_cache_headers($this->response);
-        $this->response
-            ->addHeader('Content-Type', 'application/json')
-            ->addHeader('Content-Encoding', 'UTF-8')
-            ->addHeader('X-Content-Type-Options', 'nosniff');
+	/**
+	 * 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);
+		HTTP::add_cache_headers($this->response);
+		$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) {
-            return json_encode([
-                'TrackID' => $track->ID,
-                'Status' => $track->Status,
-                'Completed' => $track->getCompletedPages(),
-                'Total' => $track->getTotalPages()
-            ]);
-        }
-    }
+		// Format status
+		$track = BrokenExternalPageTrackStatus::get_latest();
+		if ($track) {
+			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;
-        }
+	/**
+	 * 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();
-        }
-    }
+		// 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();
+		}
+	}
 }

tests/Stubs/PretendLinkChecker.php

Indentation +20 added lines, -20 removed lines

@@ -6,24 +6,24 @@
 
 class PretendLinkChecker implements LinkChecker, TestOnly
 {
-    public function checkLink($href)
-    {
-        switch ($href) {
-            case 'http://www.working.com':
-                return 200;
-            case 'http://www.broken.com':
-                return 403;
-            case 'http://www.nodomain.com':
-                return 0;
-            case '/internal/link':
-            case '[sitetree_link,id=9999]':
-            case 'home':
-            case 'broken-internal':
-            case '[sitetree_link,id=1]':
-                return null;
-            case 'http://www.broken.com/url/thing':
-            default:
-                return 404;
-        }
-    }
+	public function checkLink($href)
+	{
+		switch ($href) {
+			case 'http://www.working.com':
+				return 200;
+			case 'http://www.broken.com':
+				return 403;
+			case 'http://www.nodomain.com':
+				return 0;
+			case '/internal/link':
+			case '[sitetree_link,id=9999]':
+			case 'home':
+			case 'broken-internal':
+			case '[sitetree_link,id=1]':
+				return null;
+			case 'http://www.broken.com/url/thing':
+			default:
+				return 404;
+		}
+	}
 }

tests/Stubs/ExternalLinksTestPage.php

Indentation +4 added lines, -4 removed lines

@@ -7,9 +7,9 @@
 
 class ExternalLinksTestPage extends Page implements TestOnly
 {
-    private static $table_name = 'ExternalLinksTestPage';
+	private static $table_name = 'ExternalLinksTestPage';
 
-    private static $db = array(
-        'ExpectedContent' => 'HTMLText'
-    );
+	private static $db = array(
+		'ExpectedContent' => 'HTMLText'
+	);
 }

src/Model/BrokenExternalLink.php

Indentation +54 added lines, -54 removed lines

@@ -17,68 +17,68 @@
  */
 class BrokenExternalLink extends DataObject
 {
-    private static $table_name = 'BrokenExternalLink';
+	private static $table_name = 'BrokenExternalLink';
 
-    private static $db = array(
-        'Link' => 'Varchar(2083)', // 2083 is the maximum length of a URL in Internet Explorer.
-        'HTTPCode' =>'Int'
-    );
+	private static $db = array(
+		'Link' => 'Varchar(2083)', // 2083 is the maximum length of a URL in Internet Explorer.
+		'HTTPCode' =>'Int'
+	);
 
-    private static $has_one = array(
-        'Track' => BrokenExternalPageTrack::class,
-        'Status' => BrokenExternalPageTrackStatus::class
-    );
+	private static $has_one = array(
+		'Track' => BrokenExternalPageTrack::class,
+		'Status' => BrokenExternalPageTrackStatus::class
+	);
 
-    private static $summary_fields = array(
-        'Created' => 'Checked',
-        'Link' => 'External Link',
-        'HTTPCodeDescription' => 'HTTP Error Code',
-        'Page.Title' => 'Page link is on'
-    );
+	private static $summary_fields = array(
+		'Created' => 'Checked',
+		'Link' => 'External Link',
+		'HTTPCodeDescription' => 'HTTP Error Code',
+		'Page.Title' => 'Page link is on'
+	);
 
-    private static $searchable_fields = array(
-        'HTTPCode' => array('title' => 'HTTP Code')
-    );
+	private static $searchable_fields = array(
+		'HTTPCode' => array('title' => 'HTTP Code')
+	);
 
-    /**
-     * @return SiteTree
-     */
-    public function Page()
-    {
-        return $this->Track()->Page();
-    }
+	/**
+	 * @return SiteTree
+	 */
+	public function Page()
+	{
+		return $this->Track()->Page();
+	}
 
-    public function canEdit($member = false)
-    {
-        return false;
-    }
+	public function canEdit($member = false)
+	{
+		return false;
+	}
 
-    public function canView($member = false)
-    {
-        $member = $member ? $member : Security::getCurrentUser();
-        $codes = array('content-authors', 'administrators');
-        return Permission::checkMember($member, $codes);
-    }
+	public function canView($member = false)
+	{
+		$member = $member ? $member : Security::getCurrentUser();
+		$codes = array('content-authors', 'administrators');
+		return Permission::checkMember($member, $codes);
+	}
 
-    /**
-     * Retrieve a human readable description of a response code
-     *
-     * @return string
-     */
-    public function getHTTPCodeDescription()
-    {
-        $code = $this->HTTPCode;
+	/**
+	 * Retrieve a human readable description of a response code
+	 *
+	 * @return string
+	 */
+	public function getHTTPCodeDescription()
+	{
+		$code = $this->HTTPCode;
 
-        try {
-            $response = HTTPResponse::create('', $code);
-            // Assume that $code = 0 means there was no response
-            $description = $code ?
-                $response->getStatusDescription() :
-                _t(__CLASS__ . '.NOTAVAILABLE', 'Server Not Available');
-        } catch (InvalidArgumentException $e) {
-            $description = _t(__CLASS__ . '.UNKNOWNRESPONSE', 'Unknown Response Code');
-        }
+		try {
+			$response = HTTPResponse::create('', $code);
+			// Assume that $code = 0 means there was no response
+			$description = $code ?
+				$response->getStatusDescription() :
+				_t(__CLASS__ . '.NOTAVAILABLE', 'Server Not Available');
+		} catch (InvalidArgumentException $e) {
+			$description = _t(__CLASS__ . '.UNKNOWNRESPONSE', 'Unknown Response Code');
+		}
 
-        return sprintf("%d (%s)", $code, $description);
-    }
+		return sprintf("%d (%s)", $code, $description);
+	}
 }

src/Reports/BrokenExternalLinksReport.php

Indentation +68 added lines, -68 removed lines

@@ -18,80 +18,80 @@
 class BrokenExternalLinksReport extends Report
 {
 
-    /**
-     * Returns the report title
-     *
-     * @return string
-     */
-    public function title()
-    {
-        return _t(__CLASS__ . '.EXTERNALBROKENLINKS', "External broken links report");
-    }
+	/**
+	 * Returns the report title
+	 *
+	 * @return string
+	 */
+	public function title()
+	{
+		return _t(__CLASS__ . '.EXTERNALBROKENLINKS', "External broken links report");
+	}
 
-    public function columns()
-    {
-        return array(
-            "Created" => "Checked",
-            'Link' => array(
-                'title' => 'External Link',
-                'formatting' => function ($value, $item) {
-                    return sprintf(
-                        '<a target="_blank" href="%s">%s</a>',
-                        Convert::raw2att($item->Link),
-                        Convert::raw2xml($item->Link)
-                    );
-                }
-            ),
-            'HTTPCodeDescription' => 'HTTP Error Code',
-            "Title" => array(
-                "title" => 'Page link is on',
-                'formatting' => function ($value, $item) {
-                    $page = $item->Page();
-                    return sprintf(
-                        '<a href="%s">%s</a>',
-                        Convert::raw2att($page->CMSEditLink()),
-                        Convert::raw2xml($page->Title)
-                    );
-                }
-            )
-        );
-    }
+	public function columns()
+	{
+		return array(
+			"Created" => "Checked",
+			'Link' => array(
+				'title' => 'External Link',
+				'formatting' => function ($value, $item) {
+					return sprintf(
+						'<a target="_blank" href="%s">%s</a>',
+						Convert::raw2att($item->Link),
+						Convert::raw2xml($item->Link)
+					);
+				}
+			),
+			'HTTPCodeDescription' => 'HTTP Error Code',
+			"Title" => array(
+				"title" => 'Page link is on',
+				'formatting' => function ($value, $item) {
+					$page = $item->Page();
+					return sprintf(
+						'<a href="%s">%s</a>',
+						Convert::raw2att($page->CMSEditLink()),
+						Convert::raw2xml($page->Title)
+					);
+				}
+			)
+		);
+	}
 
-    /**
-     * Alias of columns(), to support the export to csv action
-     * in {@link GridFieldExportButton} generateExportFileData method.
-     * @return array
-     */
-    public function getColumns()
-    {
-        return $this->columns();
-    }
+	/**
+	 * Alias of columns(), to support the export to csv action
+	 * in {@link GridFieldExportButton} generateExportFileData method.
+	 * @return array
+	 */
+	public function getColumns()
+	{
+		return $this->columns();
+	}
 
-    public function sourceRecords()
-    {
-        $track = BrokenExternalPageTrackStatus::get_latest();
-        if ($track) {
-            return $track->BrokenLinks();
-        }
-        return ArrayList::create();
-    }
+	public function sourceRecords()
+	{
+		$track = BrokenExternalPageTrackStatus::get_latest();
+		if ($track) {
+			return $track->BrokenLinks();
+		}
+		return ArrayList::create();
+	}
 
-    public function getCMSFields()
-    {
-        Requirements::css('silverstripe/externallinks: css/BrokenExternalLinksReport.css');
-        Requirements::javascript('silverstripe/externallinks: javascript/BrokenExternalLinksReport.js');
+	public function getCMSFields()
+	{
+		Requirements::css('silverstripe/externallinks: css/BrokenExternalLinksReport.css');
+		Requirements::javascript('silverstripe/externallinks: javascript/BrokenExternalLinksReport.js');
 
-        $fields = parent::getCMSFields();
+		$fields = parent::getCMSFields();
 
-        $runReportButton = FormAction::create('createReport', _t(__CLASS__ . '.RUNREPORT', 'Create new report'))
-            ->addExtraClass('btn-primary external-links-report__create-report')
-            ->setUseButtonTag(true);
-        $fields->push($runReportButton);
+		$runReportButton = FormAction::create('createReport', _t(__CLASS__ . '.RUNREPORT', 'Create new report'))
+			->addExtraClass('btn-primary external-links-report__create-report')
+			->setUseButtonTag(true);
+		$fields->push($runReportButton);
 
-        $reportResultSpan = '<p class="external-links-report__report-progress"></p>';
-        $reportResult = LiteralField::create('ResultTitle', $reportResultSpan);
-        $fields->push($reportResult);
+		$reportResultSpan = '<p class="external-links-report__report-progress"></p>';
+		$reportResult = LiteralField::create('ResultTitle', $reportResultSpan);
+		$fields->push($reportResult);
 
-        return $fields;
-    }
+		return $fields;
+	}
 }