Load feeds on dashboard with AJAX instead of on page render #13507
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
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,81 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Class modDashboardWidgetFeedProcessor | ||
| * | ||
| * Used to load the news and security feeds on the dashboard over AJAX. The processed feed content | ||
| * (i.e. HTML) is returned in object->html. | ||
| */ | ||
| class modDashboardWidgetFeedProcessor extends modProcessor | ||
| { | ||
| /** | ||
| * @var modRSSParser | ||
| */ | ||
| protected $rss; | ||
|
|
||
| public function process() | ||
| { | ||
| $feed = $this->getProperty('feed', 'news'); | ||
| if (!in_array($feed, array('news', 'security'), true)) { | ||
| return $this->failure('Invalid feed type'); | ||
| } | ||
|
|
||
| $enabled = $this->modx->getOption('feed_modx_' . $feed . '_enabled', null, true); | ||
| if (!$enabled) { | ||
| return $this->failure(); | ||
| } | ||
|
|
||
| $url = $this->modx->getOption('feed_modx_' . $feed); | ||
| // Check if the domain is valid before attempting to load it | ||
| $feedHost = parse_url($url, PHP_URL_HOST); | ||
| if ($feedHost && function_exists('checkdnsrr') && !checkdnsrr($feedHost, 'A')) { | ||
| return $this->failure(); | ||
| } | ||
|
|
||
| return $this->loadFeed($url); | ||
| } | ||
|
|
||
| public function loadFeed($url) | ||
| { | ||
| $this->modx->loadClass('xmlrss.modRSSParser','',false,true); | ||
|
There was a problem hiding this comment. No particular reason. Mostly just copied the old code from the widgets into the processor, and that used it like this... getService is probably cleaner though. |
||
| $this->rss = new modRSSParser($this->modx); | ||
|
|
||
| $o = array(); | ||
| $rss = $this->rss->parse($url); | ||
| if (is_object($rss)) { | ||
| foreach (array_keys($rss->items) as $key) { | ||
| $item= &$rss->items[$key]; | ||
| $item['pubdate'] = strftime('%c',$item['date_timestamp']); | ||
| $o[] = $this->getFileChunk('dashboard/rssitem.tpl',$item); | ||
| } | ||
| } | ||
| return $this->success('', array('html' => implode("\n",$o))); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $tpl | ||
| * @param array $placeholders | ||
| * @return string | ||
| */ | ||
| public function getFileChunk($tpl,array $placeholders = array()) { | ||
| $output = ''; | ||
| $file = $tpl; | ||
| if (!file_exists($file)) { | ||
| $file = $this->modx->getOption('manager_path').'templates/'.$this->modx->getOption('manager_theme',null,'default').'/'.$tpl; | ||
| } | ||
| if (!file_exists($file)) { | ||
| $file = $this->modx->getOption('manager_path').'templates/default/'.$tpl; | ||
| } | ||
| if (file_exists($file)) { | ||
| /** @var modChunk $chunk */ | ||
| $chunk = $this->modx->newObject('modChunk'); | ||
| $chunk->setCacheable(false); | ||
| $tplContent = file_get_contents($file); | ||
| $chunk->setContent($tplContent); | ||
| $output = $chunk->process($placeholders); | ||
| } | ||
| return $output; | ||
| } | ||
| } | ||
|
|
||
| return 'modDashboardWidgetFeedProcessor'; | ||
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
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
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really a failure ? Seems perfectly legit to have those disabled.
Or maybe is that because the request should have never occurred ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah... i should have reviewed the whole diff first!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this shouldn't actually trigger. Was tempted to take it out, and happy to do so if you think that's better ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, i'm fine with it (we can never assume only core components would use it).
I was just concerned about the "failure" semantic...