123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193 |
- <?php
- namespace Grav\Plugin;
- use Composer\Autoload\ClassLoader;
- use Grav\Common\Grav;
- use Grav\Common\Data;
- use Grav\Common\Page\Page;
- use Grav\Common\Plugin;
- use Grav\Common\Uri;
- use Grav\Common\Page\Pages;
- use Grav\Common\Utils;
- use Grav\Plugin\Sitemap\SitemapEntry;
- use RocketTheme\Toolbox\Event\Event;
- class SitemapPlugin extends Plugin
- {
- /**
- * @var array
- */
- protected $sitemap = array();
- /**
- * @return array
- */
- public static function getSubscribedEvents()
- {
- return [
- 'onPluginsInitialized' => [
- ['autoload', 100000], // TODO: Remove when plugin requires Grav >=1.7
- ['onPluginsInitialized', 0],
- ],
- 'onBlueprintCreated' => ['onBlueprintCreated', 0]
- ];
- }
- /**
- * Composer autoload.
- *is
- * @return ClassLoader
- */
- public function autoload(): ClassLoader
- {
- return require __DIR__ . '/vendor/autoload.php';
- }
- /**
- * Enable sitemap only if url matches to the configuration.
- */
- public function onPluginsInitialized()
- {
- if ($this->isAdmin()) {
- $this->active = false;
- return;
- }
- /** @var Uri $uri */
- $uri = $this->grav['uri'];
- $route = $this->config->get('plugins.sitemap.route');
- if ($route && $route == $uri->path()) {
- $this->enable([
- 'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
- 'onPagesInitialized' => ['onPagesInitialized', 0],
- 'onPageInitialized' => ['onPageInitialized', 0],
- 'onTwigSiteVariables' => ['onTwigSiteVariables', 0]
- ]);
- }
- }
- /**
- * Generate data for the sitemap.
- */
- public function onPagesInitialized()
- {
- // get grav instance and current language
- $grav = Grav::instance();
- $current_lang = $grav['language']->getLanguage() ?: 'en';
- /** @var Pages $pages */
- $pages = $this->grav['pages'];
- $routes = array_unique($pages->routes());
- ksort($routes);
- $ignores = (array) $this->config->get('plugins.sitemap.ignores');
- $ignore_external = $this->config->get('plugins.sitemap.ignore_external');
- $ignore_protected = $this->config->get('plugins.sitemap.ignore_protected');
- foreach ($routes as $route => $path) {
- $page = $pages->get($path);
- $header = $page->header();
- $external_url = $ignore_external ? isset($header->external_url) : false;
- $protected_page = $ignore_protected ? isset($header->access) : false;
- $page_ignored = $protected_page || $external_url || (isset($header->sitemap['ignore']) ? $header->sitemap['ignore'] : false);
- $page_languages = $page->translatedLanguages();
- $lang_available = (empty($page_languages) || array_key_exists($current_lang, $page_languages));
- if ($page->published() && $page->routable() && !preg_match(sprintf("@^(%s)$@i", implode('|', $ignores)), $page->route()) && !$page_ignored && $lang_available ) {
-
- $entry = new SitemapEntry();
- $entry->location = $page->canonical();
- $entry->lastmod = date('Y-m-d', $page->modified());
- // optional changefreq & priority that you can set in the page header
- $entry->changefreq = (isset($header->sitemap['changefreq'])) ? $header->sitemap['changefreq'] : $this->config->get('plugins.sitemap.changefreq');
- $entry->priority = (isset($header->sitemap['priority'])) ? $header->sitemap['priority'] : $this->config->get('plugins.sitemap.priority');
- if (count($this->config->get('system.languages.supported', [])) > 0) {
- $entry->translated = $page->translatedLanguages(true);
- foreach($entry->translated as $lang => $page_route) {
- $page_route = $page->rawRoute();
- if ($page->home()) {
- $page_route = '';
- }
- $entry->translated[$lang] = $page_route;
- }
- }
- $this->sitemap[$route] = $entry;
- }
- }
- $additions = (array) $this->config->get('plugins.sitemap.additions');
- foreach ($additions as $addition) {
- if (isset($addition['location'])) {
- $location = Utils::url($addition['location'], true);
- $entry = new SitemapEntry($location,$addition['lastmod']??null,$addition['changefreq']??null, $addition['priority']??null);
- $this->sitemap[$location] = $entry;
- }
- }
- $this->grav->fireEvent('onSitemapProcessed', new Event(['sitemap' => &$this->sitemap]));
- }
- public function onPageInitialized($event)
- {
- $page = $event['page'] ?? null;
- $route = $this->config->get('plugins.sitemap.route');
- if (is_null($page) || $page->route() !== $route) {
- // set a dummy page
- $page = new Page;
- $page->init(new \SplFileInfo(__DIR__ . '/pages/sitemap.md'));
- unset($this->grav['page']);
- $this->grav['page'] = $page;
- $twig = $this->grav['twig'];
- $twig->template = 'sitemap.xml.twig';
- }
- }
- /**
- * Add current directory to twig lookup paths.
- */
- public function onTwigTemplatePaths()
- {
- $this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
- }
- /**
- * Set needed variables to display the sitemap.
- */
- public function onTwigSiteVariables()
- {
- $twig = $this->grav['twig'];
- $twig->twig_vars['sitemap'] = $this->sitemap;
- }
- /**
- * 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'];
- if (!$inEvent && $blueprint->get('form/fields/tabs', null, '/')) {
- if (!in_array($blueprint->getFilename(), array_keys($this->grav['pages']->modularTypes()))) {
- $inEvent = true;
- $blueprints = new Data\Blueprints(__DIR__ . '/blueprints/');
- $extends = $blueprints->get('sitemap');
- $blueprint->extend($extends, true);
- $inEvent = false;
- }
- }
- }
- }
|