wiki-grav/plugins/feed/feed.php

178 lines
4.4 KiB
PHP
Raw Normal View History

<?php
namespace Grav\Plugin;
use Composer\Autoload\ClassLoader;
use Grav\Common\Data;
use Grav\Common\Page\Collection;
use Grav\Common\Page\Interfaces\PageInterface;
use Grav\Common\Plugin;
use Grav\Common\Uri;
use RocketTheme\Toolbox\Event\Event;
class FeedPlugin extends Plugin
{
/**
* @var bool
*/
protected $active = false;
/**
* @var string
*/
protected $type;
/**
* @var array
*/
protected $feed_config;
/**
* @var array
*/
protected $valid_types = array('rss','atom');
/**
* @return array
*/
public static function getSubscribedEvents()
{
return [
'onPluginsInitialized' => [
['autoload', 100000],
['onPluginsInitialized', 0],
],
'onBlueprintCreated' => ['onBlueprintCreated', 0],
'onPageHeaders' => ['onPageHeaders', 0]
];
}
/**
* [onPluginsInitialized:100000] Composer autoload.
*
* @return ClassLoader
*/
public function autoload()
{
return require __DIR__ . '/vendor/autoload.php';
}
/**
* Activate feed plugin only if feed was requested for the current page.
*
* Also disables debugger.
*/
public function onPluginsInitialized()
{
if ($this->isAdmin()) {
return;
}
$this->feed_config = (array) $this->config->get('plugins.feed');
if ($this->feed_config['enable_json_feed']) {
$this->valid_types[] = 'json';
}
/** @var Uri $uri */
$uri = $this->grav['uri'];
$this->type = $uri->extension();
if ($this->type && in_array($this->type, $this->valid_types)) {
$this->enable([
'onPageInitialized' => ['onPageInitialized', 0],
'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
]);
}
}
/**
* Initialize feed configuration.
*/
public function onPageInitialized()
{
$page = $this->grav['page'];
// Overwrite regular content with feed config, so you can influence the collection processing with feed config
if (property_exists($page->header(), 'content')) {
if (isset($page->header()->feed)) {
$this->feed_config = array_merge($this->feed_config, $page->header()->feed);
}
$page->header()->content = array_merge($page->header()->content, $this->feed_config);
$this->grav['twig']->template = 'feed.' . $this->type . '.twig';
$this->enable([
'onCollectionProcessed' => ['onCollectionProcessed', 0],
]);
}
}
/**
* Feed consists of all sub-pages.
*
* @param Event $event
*/
public function onCollectionProcessed(Event $event)
{
/** @var Collection $collection */
$collection = $event['collection']->nonModular();
foreach ($collection as $slug => $page) {
$header = $page->header();
if (isset($header->feed) && !empty($header->feed['skip'])) {
$collection->remove($page);
}
}
}
/**
* Add current directory to twig lookup paths.
*/
public function onTwigTemplatePaths()
{
$this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
}
/**
* Extend page blueprints with feed configuration options.
*
* @param Event $event
*/
public function onBlueprintCreated(Event $event)
{
static $inEvent = false;
/** @var Data\Blueprint $blueprint */
$blueprint = $event['blueprint'];
$form = $blueprint->form();
$blog_tab_exists = isset($form['fields']['tabs']['fields']['blog']);
if (!$inEvent && $blog_tab_exists) {
$inEvent = true;
$blueprints = new Data\Blueprints(__DIR__ . '/blueprints/');
$extends = $blueprints->get('feed');
$blueprint->extend($extends, true);
$inEvent = false;
}
}
/**
* Force UTF-8 char-set encoding via `Content-Type` header
*
* @param Event $e
* @return void
*/
public function onPageHeaders(Event $e)
{
$headers = $e['headers'];
$content_type = $headers->{'Content-Type'} ?? null;
if ($content_type) {
$headers->{'Content-Type'} = "$content_type; charset=utf-8";
}
}
}