Module which tracks external broken links in SilverStripe CMS pages
Clone or download
Pull request Compare This branch is 125 commits ahead of kmayo-ss:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.tx re-add transifex config as it was removed from the wrong branch. Nov 26, 2017
_config Update unit tests to be rid of Phockito Nov 27, 2017
css NEW Add loading animation to Create Report button, fix bug in CurlLin… Nov 28, 2017
javascript NEW Add loading animation to Create Report button, fix bug in CurlLin… Nov 28, 2017
lang FIX Update plural name of BrokenExternalPageTrackStatus Aug 24, 2018
src FIX Update plural name of BrokenExternalPageTrackStatus Aug 24, 2018
tests FIX Implement TestOnly in PretendLinkChecker, move Page stub and sort… Nov 27, 2017
.editorconfig NEW Add loading animation to Create Report button, fix bug in CurlLin… Nov 28, 2017
.gitattributes Update supporting items for SilverStripe 4 conventions Nov 22, 2017
.scrutinizer.yml Update supporting items for SilverStripe 4 conventions Nov 22, 2017
.travis.yml FIX Update plural name of BrokenExternalPageTrackStatus Aug 24, 2018
.upgrade.yml FIX Linting errors for code cleanliness Nov 23, 2017
README.md Add supported module badge to readme Jun 15, 2018
changelog.md Update changelog for 1.0.5 May 18, 2016
code-of-conduct.md Added standard code of conduct Nov 21, 2015
codecov.yml Update supporting items for SilverStripe 4 conventions Nov 22, 2017
composer.json Merge branch '2.0' Apr 5, 2018
license.md Update supporting items for SilverStripe 4 conventions Nov 22, 2017
phpcs.xml.dist Update tests & left over fixes from upgrader tool Nov 23, 2017
phpunit.xml.dist Update supporting items for SilverStripe 4 conventions Nov 22, 2017

README.md

External links

Build Status Scrutinizer Code Quality codecov SilverStripe supported module

Introduction

The external links module is a task and ModelAdmin to track and to report on broken external links.

Maintainer Contact

Requirements

  • SilverStripe ^4.0

Note: For a SilverStripe 3.x compatible version, please use the 1.x release line.

Features

  • Add external links to broken links reports
  • Add a task to track external broken links

Installation

  1. Require the module via composer: composer require silverstripe/externallinks
  2. Run /dev/build in your browser to rebuild the database.
  3. Run the following task http://path.to.silverstripe/dev/tasks/CheckExternalLinks to check for broken external links

Report

A new report is added called 'External Broken links report'. When viewing this report, a user may press the "Create new report" button which will trigger an ajax request to initiate a report run.

In this initial ajax request this module will do one of two things, depending on which modules are included:

  • If the queuedjobs module is installed, a new queued job will be initiated. The queuedjobs module will then manage the progress of the task.
  • If the queuedjobs module is absent, then the controller will fallback to running a buildtask in the background. This is less robust, as a failure or error during this process will abort the run.

In either case, the background task will loop over every page in the system, inspecting all external urls and checking the status code returned by requesting each one. If a URL returns a response code that is considered "broken" (defined as < 200 or > 302) then the ss-broken css class will be assigned to that url, and a line item will be added to the report. If a previously broken link has been corrected or fixed, then this class is removed.

In the actual report generated the user can click on any broken link item to either view the link in their browser, or edit the containing page in the CMS.

While a report is running the current status of this report will be displayed on the report details page, along with the status. The user may leave this page and return to it later to view the ongoing status of this report.

Any subsequent report may not be generated until a prior report has completed.

Dev task

Run the following task http://path.to.silverstripe/dev/tasks/CheckExternalLinksTask to check your site for external broken links.

Queued job

If you have the queuedjobs module installed you can set the task to be run every so often.

Whitelisting codes

If you want to ignore or whitelist certain HTTP codes this can be setup via ignore_codes in the config.yml file in mysite/_config:

SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask:
  ignore_codes:
    - 401
    - 403
    - 501

Upgrading from 1.x to 2.x

When upgrading from 1.x to 2.x (SilverStripe 3.x to 4.x) you will need to be aware of the following API changes:

  • Configuration property CheckExternalLinksTask.IgnoreCodes renamed to CheckExternalLinksTask.ignore_codes
  • Configuration property CheckExternalLinksTask.FollowLocation and BypassCache renamed to follow_location and bypass_cache

Follow 301 redirects

You may want to follow a redirected URL a example of this would be redirecting from http to https can give you a false poitive as the http code of 301 will be returned which will be classed as a working link.

To allow redirects to be followed setup the following config in your config.yml

# Follow 301 redirects
SilverStripe\ExternalLinks\Tasks\CurlLinkChecker:
  follow_location: 1

Bypass cache

By default the task will attempt to cache any results the cache can be bypassed with the following config in config.yml.

# Bypass SS_Cache
SilverStripe\ExternalLinks\Tasks\CurlLinkChecker::
  bypass_cache: 1