-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
NEW Move code from silverstripe/externallinks
- Loading branch information
1 parent
cfc9f7a
commit f0143d6
Showing
28 changed files
with
2,593 additions
and
1,104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
module.exports = require('@silverstripe/eslint-config/.stylelintrc'); | ||
module.exports = require('@silverstripe/eslint-config/.stylelintrc'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
Name: reports-externallinksdependencies | ||
--- | ||
SilverStripe\Core\Injector\Injector: | ||
SilverStripe\Reports\ExternalLinks\Tasks\LinkChecker: SilverStripe\Reports\ExternalLinks\Tasks\CurlLinkChecker | ||
Psr\SimpleCache\CacheInterface.CurlLinkChecker: | ||
factory: SilverStripe\Core\Cache\CacheFactory | ||
constructor: | ||
namespace: 'curllinkchecker' |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.external-links-report__create-report,.external-links-report__report-progress{margin-top:20px} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
/* global jQuery */ | ||
(function ($) { | ||
// eslint-disable-next-line no-shadow | ||
$.entwine('ss', ($) => { | ||
$('.external-links-report__create-report').entwine({ | ||
PollTimeout: null, | ||
ButtonIsLoading: false, | ||
ReloadContent: false, | ||
|
||
onclick(e) { | ||
e.preventDefault(); | ||
|
||
this.buttonLoading(); | ||
this.start(); | ||
}, | ||
|
||
onmatch() { | ||
// poll the current job and update the front end status | ||
this.poll(); | ||
}, | ||
|
||
start() { | ||
const self = this; | ||
// initiate a new job | ||
$('.external-links-report__report-progress') | ||
.empty() | ||
.text('Running report 0%'); | ||
|
||
$.ajax({ | ||
url: 'admin/externallinks/start', | ||
async: true, | ||
timeout: 3000, | ||
success() { | ||
self.setReloadContent(true); | ||
self.poll(); | ||
}, | ||
error() { | ||
self.buttonReset(); | ||
} | ||
}); | ||
}, | ||
|
||
/** | ||
* Get the "create report" button selector | ||
* | ||
* @return {Object} | ||
*/ | ||
getButton() { | ||
return $('.external-links-report__create-report'); | ||
}, | ||
|
||
/** | ||
* Sets the button into a loading state. See LeftAndMain.js. | ||
*/ | ||
buttonLoading() { | ||
if (this.getButtonIsLoading()) { | ||
return; | ||
} | ||
this.setButtonIsLoading(true); | ||
|
||
const $button = this.getButton(); | ||
|
||
// set button to "submitting" state | ||
$button.addClass('btn--loading loading'); | ||
$button.attr('disabled', true); | ||
|
||
if ($button.is('button')) { | ||
$button.append($( | ||
'<div class="btn__loading-icon">' + | ||
'<span class="btn__circle btn__circle--1" />' + | ||
'<span class="btn__circle btn__circle--2" />' + | ||
'<span class="btn__circle btn__circle--3" />' + | ||
'</div>')); | ||
|
||
$button.css(`${$button.outerWidth()}px`); | ||
} | ||
}, | ||
|
||
/** | ||
* Reset the button back to its original state after loading. See LeftAndMain.js. | ||
*/ | ||
buttonReset() { | ||
this.setButtonIsLoading(false); | ||
|
||
const $button = this.getButton(); | ||
|
||
$button.removeClass('btn--loading loading'); | ||
$button.attr('disabled', false); | ||
$button.find('.btn__loading-icon').remove(); | ||
$button.css('width', 'auto'); | ||
}, | ||
|
||
poll() { | ||
const self = this; | ||
this.buttonLoading(); | ||
|
||
$.ajax({ | ||
url: 'admin/externallinks/getJobStatus', | ||
async: true, | ||
success(data) { | ||
// No report, so let user create one | ||
if (!data || (typeof data === 'object' && data.length < 1)) { | ||
self.buttonReset(); | ||
return; | ||
} | ||
|
||
// Parse data | ||
const completed = data.Completed ? data.Completed : 0; | ||
const total = data.Total ? data.Total : 0; | ||
|
||
// If complete status | ||
if (data.Status === 'Completed') { | ||
if (self.getReloadContent()) { | ||
$('.cms-container').loadPanel(document.location.href, null, {}, true, false); | ||
self.setReloadContent(false); | ||
} | ||
$('.external-links-report__report-progress') | ||
.text(`Report finished ${completed}/${total}`); | ||
|
||
self.buttonReset(); | ||
return; | ||
} | ||
|
||
// If incomplete update status | ||
if (completed < total) { | ||
const percent = (completed / total) * 100; | ||
$('.external-links-report__report-progress') | ||
.text(`Running report ${completed}/${total} (${percent.toFixed(2)}%)`); | ||
} | ||
|
||
// Ensure the regular poll method is run | ||
// kill any existing timeout | ||
if (self.getPollTimeout() !== null) { | ||
clearTimeout(self.getPollTimeout()); | ||
} | ||
|
||
self.setPollTimeout(setTimeout(() => { | ||
$('.external-links-report__create-report').poll(); | ||
}, 1000)); | ||
}, | ||
error() { | ||
self.buttonReset(); | ||
} | ||
}); | ||
} | ||
}); | ||
}); | ||
}(jQuery)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.external-links-report__create-report, | ||
.external-links-report__report-progress { | ||
margin-top: 20px; | ||
} |
67 changes: 67 additions & 0 deletions
67
code/ExternalLinks/Controllers/CMSExternalLinksController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<?php | ||
|
||
namespace SilverStripe\Reports\ExternalLinks\Controllers; | ||
|
||
use SilverStripe\Admin\AdminController; | ||
use SilverStripe\Control\HTTPResponse; | ||
use SilverStripe\Reports\ExternalLinks\Model\BrokenExternalPageTrackStatus; | ||
use SilverStripe\Reports\ExternalLinks\Jobs\CheckExternalLinksJob; | ||
use SilverStripe\Reports\ExternalLinks\Tasks\CheckExternalLinksTask; | ||
use Symbiote\QueuedJobs\Services\QueuedJobService; | ||
use SilverStripe\PolyExecution\PolyOutput; | ||
|
||
class CMSExternalLinksController extends AdminController | ||
{ | ||
private static ?string $url_segment = 'externallinks'; | ||
|
||
private static string|array $required_permission_codes = [ | ||
'CMS_ACCESS_CMSMain', | ||
]; | ||
|
||
private static $allowed_actions = [ | ||
'getJobStatus', | ||
'start' | ||
]; | ||
|
||
/** | ||
* Respond to Ajax requests for info on a running job | ||
*/ | ||
public function getJobStatus(): HTTPResponse | ||
{ | ||
$this->getResponse()->addHeader('X-Content-Type-Options', 'nosniff'); | ||
$track = BrokenExternalPageTrackStatus::get_latest(); | ||
if ($track) { | ||
return $this->jsonSuccess(200, [ | ||
'TrackID' => $track->ID, | ||
'Status' => $track->Status, | ||
'Completed' => $track->getCompletedPages(), | ||
'Total' => $track->getTotalPages() | ||
]); | ||
} | ||
return $this->jsonSuccess(200, []); | ||
} | ||
|
||
/** | ||
* Starts a broken external link check | ||
*/ | ||
public function start(): HTTPResponse | ||
{ | ||
// return if the a job is already running | ||
$status = BrokenExternalPageTrackStatus::get_latest(); | ||
if ($status && $status->Status == 'Running') { | ||
return $this->jsonSuccess(200, []); | ||
} | ||
|
||
// 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 { | ||
$task = CheckExternalLinksTask::create(); | ||
$task->runLinksCheck(PolyOutput::create(PolyOutput::FORMAT_HTML)); | ||
} | ||
return $this->jsonSuccess(200, []); | ||
} | ||
} |
Oops, something went wrong.