From 31a84f9b75cd5fd3ce0013287719cca9548b5761 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:11:15 -0600 Subject: [PATCH 01/13] Allow setting by constructor Signed-off-by: Andy Miller --- classes/sitemapentry.php | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/classes/sitemapentry.php b/classes/sitemapentry.php index f27685a..580bb42 100644 --- a/classes/sitemapentry.php +++ b/classes/sitemapentry.php @@ -8,4 +8,22 @@ class SitemapEntry public $changefreq; public $priority; public $image; + + /** + * SitemapEntry constructor. + * + * @param null $location + * @param null $lastmod + * @param null $changefreq + * @param null $priority + * @param null $image + */ + public function __construct($location = null, $lastmod = null, $changefreq = null, $priority = null, $image = null) + { + $this->location = $location; + $this->lastmod = $lastmod; + $this->changefreq = $changefreq; + $this->priority = $priority; + $this->image = $image; + } } From 78d890f3b1fb0b75747208db3cf6b775b0aa3f56 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:12:01 -0600 Subject: [PATCH 02/13] update lang + blueprints Signed-off-by: Andy Miller --- blueprints.yaml | 80 +++++++++++++++++++++++++++++++++++++------------ languages.yaml | 3 +- 2 files changed, 63 insertions(+), 20 deletions(-) diff --git a/blueprints.yaml b/blueprints.yaml index f0dfeba..068619c 100644 --- a/blueprints.yaml +++ b/blueprints.yaml @@ -29,7 +29,6 @@ form: 0: PLUGIN_ADMIN.DISABLED validate: type: bool - changefreq: type: select label: PLUGIN_SITEMAP.CHANGEFREQ @@ -68,26 +67,69 @@ form: label: PLUGIN_SITEMAP.ROUTE placeholder: /sitemap validate: - pattern: "/([a-z\-_]+/?)+" + pattern: "/([a-z-_]+/?)+" + + ignore_external: + type: toggle + label: PLUGIN_SITEMAP.IGNORE_EXTERNAL + help: PLUGIN_SITEMAP.IGNORE_EXTERNAL_HELP + highlight: 1 + default: 1 + options: + 1: PLUGIN_ADMIN.ENABLED + 0: PLUGIN_ADMIN.DISABLED + validate: + type: bool ignores: - type: array - label: PLUGIN_SITEMAP.IGNORES - help: PLUGIN_SITEMAP.IGNORES_HELP - value_only: true - placeholder_value: /ignore-this-route + type: array + label: PLUGIN_SITEMAP.IGNORES + help: PLUGIN_SITEMAP.IGNORES_HELP + value_only: true + placeholder_value: '/ignore-this-route' additions: - type: list - label: PLUGIN_SITEMAP.ADDITIONS - help: PLUGIN_SITEMAP.ADDITIONS_HELP + type: list + label: PLUGIN_SITEMAP.ADDITIONS + help: PLUGIN_SITEMAP.ADDITIONS_HELP - fields: - .location: - type: text - label: PLUGIN_SITEMAP.LOCATION - placeholder: "/not-a-grav-url" - .lastmod: - type: text - label: PLUGIN_SITEMAP.LASTMOD - placeholder: "2017-04-06" + fields: + .location: + type: text + label: PLUGIN_SITEMAP.LOCATION + placeholder: "/not-a-grav-url" + .lastmod: + type: text + label: PLUGIN_SITEMAP.LASTMOD + placeholder: "2017-04-06" + .changefreq: + type: select + label: PLUGIN_SITEMAP.CHANGEFREQ + default: '' + options: + '': PLUGIN_SITEMAP.CHANGEFREQ_DEFAULT + always: PLUGIN_SITEMAP.CHANGEFREQ_ALWAYS + hourly: PLUGIN_SITEMAP.CHANGEFREQ_HOURLY + daily: PLUGIN_SITEMAP.CHANGEFREQ_DAILY + weekly: PLUGIN_SITEMAP.CHANGEFREQ_WEEKLY + monthly: PLUGIN_SITEMAP.CHANGEFREQ_MONTHLY + yearly: PLUGIN_SITEMAP.CHANGEFREQ_YEARLY + never: PLUGIN_SITEMAP.CHANGEFREQ_NEVER + .priority: + type: select + label: PLUGIN_SITEMAP.PRIORITY + default: '' + options: + '': PLUGIN_SITEMAP.PRIORITY_USE_GLOBAL + '0.1': 0.1 + '0.2': 0.2 + '0.3': 0.3 + '0.4': 0.4 + '0.5': 0.5 + '0.6': 0.6 + '0.7': 0.7 + '0.8': 0.8 + '0.9': 0.9 + '1.0': 1.0 + validate: + type: float diff --git a/languages.yaml b/languages.yaml index dc300b7..d068709 100644 --- a/languages.yaml +++ b/languages.yaml @@ -22,7 +22,8 @@ en: ADDITIONS_HELP: 'Add external URLs to the sitemap' LOCATION: 'The URL location' LASTMOD: 'Last modification e.g. 2017-04-06' - + IGNORE_EXTERNAL: 'Ignore External URLs' + IGNORE_EXTERNAL_HELP: 'By default Sitemap hides pages that have an `external` URL' ru: PLUGIN_SITEMAP: SITEMAP: 'Карта сайта' From 3c2b18ec1f8fe30ecd16612c81b0c306a535ff02 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:12:32 -0600 Subject: [PATCH 03/13] updated default config Signed-off-by: Andy Miller --- sitemap.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sitemap.yaml b/sitemap.yaml index c876c7f..a928785 100644 --- a/sitemap.yaml +++ b/sitemap.yaml @@ -1,4 +1,7 @@ enabled: true route: '/sitemap' +ignore_external: true +ignores: +whitelist: changefreq: daily priority: !!float 1 From 6959ce2a1018847fa9e4c642cc98fcf156fb7c39 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:12:56 -0600 Subject: [PATCH 04/13] Added ignore externals + new onSitemapProcessed() event Signed-off-by: Andy Miller --- sitemap.php | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/sitemap.php b/sitemap.php index c37d60e..953a0c6 100644 --- a/sitemap.php +++ b/sitemap.php @@ -7,6 +7,7 @@ use Grav\Common\Plugin; use Grav\Common\Uri; use Grav\Common\Page\Pages; +use Grav\Common\Utils; use RocketTheme\Toolbox\Event\Event; class SitemapPlugin extends Plugin @@ -69,15 +70,19 @@ public function onPagesInitialized() ksort($routes); $ignores = (array) $this->config->get('plugins.sitemap.ignores'); + $ignore_external = $this->config->get('plugins.sitemap.ignore_external'); foreach ($routes as $route => $path) { $page = $pages->get($path); $header = $page->header(); - $page_ignored = isset($header->sitemap['ignore']) ? $header->sitemap['ignore'] : false; + $external_url = $ignore_external ? isset($header->external_url) : false; + $page_ignored = $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()); @@ -103,16 +108,16 @@ public function onPagesInitialized() } } - $rootUrl = $this->grav['uri']->rootUrl(true) . $pages->base(); $additions = (array) $this->config->get('plugins.sitemap.additions'); - foreach ($additions as $addition) { - $entry = new SitemapEntry(); - $entry->location = $rootUrl . $addition['location']; - $entry->lastmod = $addition['lastmod']; - - $this->sitemap[] = $entry; + 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) From 499d75129eb56b57c38ab7664ed8e431a3402cf3 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:29:45 -0600 Subject: [PATCH 05/13] reworked for composer Signed-off-by: Andy Miller --- CHANGELOG.md | 10 + classes/sitemapentry.php | 2 +- composer.json | 30 ++ composer.lock | 23 ++ vendor/autoload.php | 7 + vendor/composer/ClassLoader.php | 445 ++++++++++++++++++++++++ vendor/composer/LICENSE | 21 ++ vendor/composer/autoload_classmap.php | 10 + vendor/composer/autoload_namespaces.php | 9 + vendor/composer/autoload_psr4.php | 10 + vendor/composer/autoload_real.php | 55 +++ vendor/composer/autoload_static.php | 36 ++ vendor/composer/installed.json | 1 + 13 files changed, 658 insertions(+), 1 deletion(-) create mode 100644 composer.json create mode 100644 composer.lock create mode 100644 vendor/autoload.php create mode 100644 vendor/composer/ClassLoader.php create mode 100644 vendor/composer/LICENSE create mode 100644 vendor/composer/autoload_classmap.php create mode 100644 vendor/composer/autoload_namespaces.php create mode 100644 vendor/composer/autoload_psr4.php create mode 100644 vendor/composer/autoload_real.php create mode 100644 vendor/composer/autoload_static.php create mode 100644 vendor/composer/installed.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 2cab279..38c2dd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +# v2.0.0 +## 07/01/2020 + +1. [](#new) + * Added a new `Ignore External URLs` option that defaults to `true` + * Added a new `onSitemapProcessed()` event to allow for dynamic manipulation of the sitemap +1. [](#improved) + * Improved `SitemapEntry` to allow setting via constructor + * Added `changefreq` and `priority` to manually and dynamically added entries + # v1.9.5 ## 04/27/2020 diff --git a/classes/sitemapentry.php b/classes/sitemapentry.php index 580bb42..690b292 100644 --- a/classes/sitemapentry.php +++ b/classes/sitemapentry.php @@ -1,5 +1,5 @@ =7.1.3" + }, + "autoload": { + "psr-4": { + "Grav\\Plugin\\Sitemap\\": "classes/" + }, + "classmap": ["sitemap.php"] + }, + "config": { + "platform": { + "php": "7.1.3" + } + } +} diff --git a/composer.lock b/composer.lock new file mode 100644 index 0000000..eb013db --- /dev/null +++ b/composer.lock @@ -0,0 +1,23 @@ +{ + "_readme": [ + "This file locks the dependencies of your project to a known state", + "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", + "This file is @generated automatically" + ], + "content-hash": "7b3a8451f3be62bce1c1dd5736e649ea", + "packages": [], + "packages-dev": [], + "aliases": [], + "minimum-stability": "stable", + "stability-flags": [], + "prefer-stable": false, + "prefer-lowest": false, + "platform": { + "php": ">=7.1.3" + }, + "platform-dev": [], + "platform-overrides": { + "php": "7.1.3" + }, + "plugin-api-version": "1.1.0" +} diff --git a/vendor/autoload.php b/vendor/autoload.php new file mode 100644 index 0000000..123c284 --- /dev/null +++ b/vendor/autoload.php @@ -0,0 +1,7 @@ + + * Jordi Boggiano + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Composer\Autoload; + +/** + * ClassLoader implements a PSR-0, PSR-4 and classmap class loader. + * + * $loader = new \Composer\Autoload\ClassLoader(); + * + * // register classes with namespaces + * $loader->add('Symfony\Component', __DIR__.'/component'); + * $loader->add('Symfony', __DIR__.'/framework'); + * + * // activate the autoloader + * $loader->register(); + * + * // to enable searching the include path (eg. for PEAR packages) + * $loader->setUseIncludePath(true); + * + * In this example, if you try to use a class in the Symfony\Component + * namespace or one of its children (Symfony\Component\Console for instance), + * the autoloader will first look for the class under the component/ + * directory, and it will then fallback to the framework/ directory if not + * found before giving up. + * + * This class is loosely based on the Symfony UniversalClassLoader. + * + * @author Fabien Potencier + * @author Jordi Boggiano + * @see http://www.php-fig.org/psr/psr-0/ + * @see http://www.php-fig.org/psr/psr-4/ + */ +class ClassLoader +{ + // PSR-4 + private $prefixLengthsPsr4 = array(); + private $prefixDirsPsr4 = array(); + private $fallbackDirsPsr4 = array(); + + // PSR-0 + private $prefixesPsr0 = array(); + private $fallbackDirsPsr0 = array(); + + private $useIncludePath = false; + private $classMap = array(); + private $classMapAuthoritative = false; + private $missingClasses = array(); + private $apcuPrefix; + + public function getPrefixes() + { + if (!empty($this->prefixesPsr0)) { + return call_user_func_array('array_merge', $this->prefixesPsr0); + } + + return array(); + } + + public function getPrefixesPsr4() + { + return $this->prefixDirsPsr4; + } + + public function getFallbackDirs() + { + return $this->fallbackDirsPsr0; + } + + public function getFallbackDirsPsr4() + { + return $this->fallbackDirsPsr4; + } + + public function getClassMap() + { + return $this->classMap; + } + + /** + * @param array $classMap Class to filename map + */ + public function addClassMap(array $classMap) + { + if ($this->classMap) { + $this->classMap = array_merge($this->classMap, $classMap); + } else { + $this->classMap = $classMap; + } + } + + /** + * Registers a set of PSR-0 directories for a given prefix, either + * appending or prepending to the ones previously set for this prefix. + * + * @param string $prefix The prefix + * @param array|string $paths The PSR-0 root directories + * @param bool $prepend Whether to prepend the directories + */ + public function add($prefix, $paths, $prepend = false) + { + if (!$prefix) { + if ($prepend) { + $this->fallbackDirsPsr0 = array_merge( + (array) $paths, + $this->fallbackDirsPsr0 + ); + } else { + $this->fallbackDirsPsr0 = array_merge( + $this->fallbackDirsPsr0, + (array) $paths + ); + } + + return; + } + + $first = $prefix[0]; + if (!isset($this->prefixesPsr0[$first][$prefix])) { + $this->prefixesPsr0[$first][$prefix] = (array) $paths; + + return; + } + if ($prepend) { + $this->prefixesPsr0[$first][$prefix] = array_merge( + (array) $paths, + $this->prefixesPsr0[$first][$prefix] + ); + } else { + $this->prefixesPsr0[$first][$prefix] = array_merge( + $this->prefixesPsr0[$first][$prefix], + (array) $paths + ); + } + } + + /** + * Registers a set of PSR-4 directories for a given namespace, either + * appending or prepending to the ones previously set for this namespace. + * + * @param string $prefix The prefix/namespace, with trailing '\\' + * @param array|string $paths The PSR-4 base directories + * @param bool $prepend Whether to prepend the directories + * + * @throws \InvalidArgumentException + */ + public function addPsr4($prefix, $paths, $prepend = false) + { + if (!$prefix) { + // Register directories for the root namespace. + if ($prepend) { + $this->fallbackDirsPsr4 = array_merge( + (array) $paths, + $this->fallbackDirsPsr4 + ); + } else { + $this->fallbackDirsPsr4 = array_merge( + $this->fallbackDirsPsr4, + (array) $paths + ); + } + } elseif (!isset($this->prefixDirsPsr4[$prefix])) { + // Register directories for a new namespace. + $length = strlen($prefix); + if ('\\' !== $prefix[$length - 1]) { + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); + } + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; + $this->prefixDirsPsr4[$prefix] = (array) $paths; + } elseif ($prepend) { + // Prepend directories for an already registered namespace. + $this->prefixDirsPsr4[$prefix] = array_merge( + (array) $paths, + $this->prefixDirsPsr4[$prefix] + ); + } else { + // Append directories for an already registered namespace. + $this->prefixDirsPsr4[$prefix] = array_merge( + $this->prefixDirsPsr4[$prefix], + (array) $paths + ); + } + } + + /** + * Registers a set of PSR-0 directories for a given prefix, + * replacing any others previously set for this prefix. + * + * @param string $prefix The prefix + * @param array|string $paths The PSR-0 base directories + */ + public function set($prefix, $paths) + { + if (!$prefix) { + $this->fallbackDirsPsr0 = (array) $paths; + } else { + $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths; + } + } + + /** + * Registers a set of PSR-4 directories for a given namespace, + * replacing any others previously set for this namespace. + * + * @param string $prefix The prefix/namespace, with trailing '\\' + * @param array|string $paths The PSR-4 base directories + * + * @throws \InvalidArgumentException + */ + public function setPsr4($prefix, $paths) + { + if (!$prefix) { + $this->fallbackDirsPsr4 = (array) $paths; + } else { + $length = strlen($prefix); + if ('\\' !== $prefix[$length - 1]) { + throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); + } + $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; + $this->prefixDirsPsr4[$prefix] = (array) $paths; + } + } + + /** + * Turns on searching the include path for class files. + * + * @param bool $useIncludePath + */ + public function setUseIncludePath($useIncludePath) + { + $this->useIncludePath = $useIncludePath; + } + + /** + * Can be used to check if the autoloader uses the include path to check + * for classes. + * + * @return bool + */ + public function getUseIncludePath() + { + return $this->useIncludePath; + } + + /** + * Turns off searching the prefix and fallback directories for classes + * that have not been registered with the class map. + * + * @param bool $classMapAuthoritative + */ + public function setClassMapAuthoritative($classMapAuthoritative) + { + $this->classMapAuthoritative = $classMapAuthoritative; + } + + /** + * Should class lookup fail if not found in the current class map? + * + * @return bool + */ + public function isClassMapAuthoritative() + { + return $this->classMapAuthoritative; + } + + /** + * APCu prefix to use to cache found/not-found classes, if the extension is enabled. + * + * @param string|null $apcuPrefix + */ + public function setApcuPrefix($apcuPrefix) + { + $this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null; + } + + /** + * The APCu prefix in use, or null if APCu caching is not enabled. + * + * @return string|null + */ + public function getApcuPrefix() + { + return $this->apcuPrefix; + } + + /** + * Registers this instance as an autoloader. + * + * @param bool $prepend Whether to prepend the autoloader or not + */ + public function register($prepend = false) + { + spl_autoload_register(array($this, 'loadClass'), true, $prepend); + } + + /** + * Unregisters this instance as an autoloader. + */ + public function unregister() + { + spl_autoload_unregister(array($this, 'loadClass')); + } + + /** + * Loads the given class or interface. + * + * @param string $class The name of the class + * @return bool|null True if loaded, null otherwise + */ + public function loadClass($class) + { + if ($file = $this->findFile($class)) { + includeFile($file); + + return true; + } + } + + /** + * Finds the path to the file where the class is defined. + * + * @param string $class The name of the class + * + * @return string|false The path if found, false otherwise + */ + public function findFile($class) + { + // class map lookup + if (isset($this->classMap[$class])) { + return $this->classMap[$class]; + } + if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) { + return false; + } + if (null !== $this->apcuPrefix) { + $file = apcu_fetch($this->apcuPrefix.$class, $hit); + if ($hit) { + return $file; + } + } + + $file = $this->findFileWithExtension($class, '.php'); + + // Search for Hack files if we are running on HHVM + if (false === $file && defined('HHVM_VERSION')) { + $file = $this->findFileWithExtension($class, '.hh'); + } + + if (null !== $this->apcuPrefix) { + apcu_add($this->apcuPrefix.$class, $file); + } + + if (false === $file) { + // Remember that this class does not exist. + $this->missingClasses[$class] = true; + } + + return $file; + } + + private function findFileWithExtension($class, $ext) + { + // PSR-4 lookup + $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext; + + $first = $class[0]; + if (isset($this->prefixLengthsPsr4[$first])) { + $subPath = $class; + while (false !== $lastPos = strrpos($subPath, '\\')) { + $subPath = substr($subPath, 0, $lastPos); + $search = $subPath . '\\'; + if (isset($this->prefixDirsPsr4[$search])) { + $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1); + foreach ($this->prefixDirsPsr4[$search] as $dir) { + if (file_exists($file = $dir . $pathEnd)) { + return $file; + } + } + } + } + } + + // PSR-4 fallback dirs + foreach ($this->fallbackDirsPsr4 as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) { + return $file; + } + } + + // PSR-0 lookup + if (false !== $pos = strrpos($class, '\\')) { + // namespaced class name + $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1) + . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR); + } else { + // PEAR-like class name + $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext; + } + + if (isset($this->prefixesPsr0[$first])) { + foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) { + if (0 === strpos($class, $prefix)) { + foreach ($dirs as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { + return $file; + } + } + } + } + } + + // PSR-0 fallback dirs + foreach ($this->fallbackDirsPsr0 as $dir) { + if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { + return $file; + } + } + + // PSR-0 include paths. + if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) { + return $file; + } + + return false; + } +} + +/** + * Scope isolated include. + * + * Prevents access to $this/self from included files. + */ +function includeFile($file) +{ + include $file; +} diff --git a/vendor/composer/LICENSE b/vendor/composer/LICENSE new file mode 100644 index 0000000..f27399a --- /dev/null +++ b/vendor/composer/LICENSE @@ -0,0 +1,21 @@ + +Copyright (c) Nils Adermann, Jordi Boggiano + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php new file mode 100644 index 0000000..73041ff --- /dev/null +++ b/vendor/composer/autoload_classmap.php @@ -0,0 +1,10 @@ + $baseDir . '/sitemap.php', +); diff --git a/vendor/composer/autoload_namespaces.php b/vendor/composer/autoload_namespaces.php new file mode 100644 index 0000000..b7fc012 --- /dev/null +++ b/vendor/composer/autoload_namespaces.php @@ -0,0 +1,9 @@ + array($baseDir . '/classes'), +); diff --git a/vendor/composer/autoload_real.php b/vendor/composer/autoload_real.php new file mode 100644 index 0000000..9400d61 --- /dev/null +++ b/vendor/composer/autoload_real.php @@ -0,0 +1,55 @@ += 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded()); + if ($useStaticLoader) { + require_once __DIR__ . '/autoload_static.php'; + + call_user_func(\Composer\Autoload\ComposerStaticInit751b26473acbe012cea5482fdb145bdc::getInitializer($loader)); + } else { + $map = require __DIR__ . '/autoload_namespaces.php'; + foreach ($map as $namespace => $path) { + $loader->set($namespace, $path); + } + + $map = require __DIR__ . '/autoload_psr4.php'; + foreach ($map as $namespace => $path) { + $loader->setPsr4($namespace, $path); + } + + $classMap = require __DIR__ . '/autoload_classmap.php'; + if ($classMap) { + $loader->addClassMap($classMap); + } + } + + $loader->register(true); + + return $loader; + } +} diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php new file mode 100644 index 0000000..0702625 --- /dev/null +++ b/vendor/composer/autoload_static.php @@ -0,0 +1,36 @@ + + array ( + 'Grav\\Plugin\\Sitemap\\' => 20, + ), + ); + + public static $prefixDirsPsr4 = array ( + 'Grav\\Plugin\\Sitemap\\' => + array ( + 0 => __DIR__ . '/../..' . '/classes', + ), + ); + + public static $classMap = array ( + 'Grav\\Plugin\\SitemapPlugin' => __DIR__ . '/../..' . '/sitemap.php', + ); + + public static function getInitializer(ClassLoader $loader) + { + return \Closure::bind(function () use ($loader) { + $loader->prefixLengthsPsr4 = ComposerStaticInit751b26473acbe012cea5482fdb145bdc::$prefixLengthsPsr4; + $loader->prefixDirsPsr4 = ComposerStaticInit751b26473acbe012cea5482fdb145bdc::$prefixDirsPsr4; + $loader->classMap = ComposerStaticInit751b26473acbe012cea5482fdb145bdc::$classMap; + + }, null, ClassLoader::class); + } +} diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json new file mode 100644 index 0000000..fe51488 --- /dev/null +++ b/vendor/composer/installed.json @@ -0,0 +1 @@ +[] From 6c08ef7d44f21ed9b349ff3cbf0aa36584e941a9 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:29:52 -0600 Subject: [PATCH 06/13] require Grav 1.6 Signed-off-by: Andy Miller --- blueprints.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blueprints.yaml b/blueprints.yaml index 068619c..06f8f2e 100644 --- a/blueprints.yaml +++ b/blueprints.yaml @@ -14,7 +14,7 @@ bugs: https://github.com/getgrav/grav-plugin-sitemap/issues license: MIT dependencies: - - { name: grav, version: '>=1.1.6' } + - { name: grav, version: '>=1.6.0' } form: validation: strict From 6f2b0f5ce66fe0b260790b711328b127d16f0c44 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:30:20 -0600 Subject: [PATCH 07/13] Use composer Signed-off-by: Andy Miller --- sitemap.php | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/sitemap.php b/sitemap.php index 953a0c6..34c8f3f 100644 --- a/sitemap.php +++ b/sitemap.php @@ -1,6 +1,7 @@ ['onPluginsInitialized', 0], + '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. */ @@ -58,8 +73,6 @@ public function onPluginsInitialized() */ public function onPagesInitialized() { - require_once __DIR__ . '/classes/sitemapentry.php'; - // get grav instance and current language $grav = Grav::instance(); $current_lang = $grav['language']->getLanguage(); From 67762076173fc822f9b8a8b198b46c4f2f0974d5 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:30:25 -0600 Subject: [PATCH 08/13] update readme Signed-off-by: Andy Miller --- README.md | 40 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b7827a3..a549a59 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,25 @@ The `sitemap` plugin works out of the box. You can just go directly to `http://y ``` enabled: true +changefreq: daily +priority: !!float 1 route: '/sitemap' +ignore_external: true ignores: - /blog/blog-post-to-ignore - /ignore-this-route - /ignore-children-of-this-route/.* +additions: + - + location: /something-special + lastmod: '2020-04-16' + changefreq: hourly + priority: 0.3 + - + location: /something-else + lastmod: '2020-04-17' + changefreq: weekly + priority: 0.2 ``` You can ignore your own pages by providing a list of routes to ignore. You can also use a page's Frontmatter to signal that the sitemap should ignore it: @@ -61,6 +75,26 @@ You can manually add URLs to the sitemap using the Admin settings, or by adding ``` additions: - - location: /not-a-grav-url - lastmod: '2017-04-06' -``` \ No newline at end of file + location: /something-special + lastmod: '2020-04-16' + changefreq: hourly + priority: 0.3 +``` + +## Dynamically adding pages to the sitemap + +If you have some dynamic content being added to your site via another plugin, or perhaps a 3rd party API, you can now add them dynamically to the sitemap with a simple event: + +Make sure you are subscribed to the `` event then add simply add your entry to the sitemap like this: + +```php + public function onSitemapProcessed(\RocketTheme\Toolbox\Event\Event $e) + { + $sitemap = $e['sitemap']; + $location = \Grav\Common\Utils::url('/foo-location', true); + $sitemap['/foo'] = new \Grav\Plugin\Sitemap\SitemapEntry($location, '2020-07-02', 'weekly', '2.0'); + $e['sitemap'] = $sitemap; + } +``` + +The use `Utils::url()` method allow us to easily create the correct full URL by passing it a route plus the optional `true` parameter. \ No newline at end of file From 9bc1faed199c83420f535e948ee4c64433f2229d Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 11:31:21 -0600 Subject: [PATCH 09/13] Updated changelog Signed-off-by: Andy Miller --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38c2dd3..a4f4501 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ 1. [](#improved) * Improved `SitemapEntry` to allow setting via constructor * Added `changefreq` and `priority` to manually and dynamically added entries + * Use composer for autoloading # v1.9.5 ## 04/27/2020 From 4abc36cfdd232a275ca4bec1fecdd9c3ddeceb93 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 12:01:50 -0600 Subject: [PATCH 10/13] Force fallback to en - fixes #74 Signed-off-by: Andy Miller --- CHANGELOG.md | 2 ++ sitemap.php | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4f4501..30feadf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ * Improved `SitemapEntry` to allow setting via constructor * Added `changefreq` and `priority` to manually and dynamically added entries * Use composer for autoloading +1. [](#bugfix) + * Force a fallback to `en` to ensure you can't get `null/false` language [#74](https://github.com/getgrav/grav-plugin-sitemap/issues/74) # v1.9.5 ## 04/27/2020 diff --git a/sitemap.php b/sitemap.php index 34c8f3f..8644f3a 100644 --- a/sitemap.php +++ b/sitemap.php @@ -75,7 +75,7 @@ public function onPagesInitialized() { // get grav instance and current language $grav = Grav::instance(); - $current_lang = $grav['language']->getLanguage(); + $current_lang = $grav['language']->getLanguage() ?: 'en'; /** @var Pages $pages */ $pages = $this->grav['pages']; From 0123fd2165bc05eb407683c9b589afbab54d4c75 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 12:23:12 -0600 Subject: [PATCH 11/13] Ignore protected pages Signed-off-by: Andy Miller --- CHANGELOG.md | 1 + blueprints.yaml | 12 ++++++++++++ languages.yaml | 2 ++ sitemap.php | 4 +++- sitemap.yaml | 1 + 5 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 30feadf..a93ab29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ 1. [](#new) * Added a new `Ignore External URLs` option that defaults to `true` + * Added a new `Ignore Protected Pages' option that defaults to `true` * Added a new `onSitemapProcessed()` event to allow for dynamic manipulation of the sitemap 1. [](#improved) * Improved `SitemapEntry` to allow setting via constructor diff --git a/blueprints.yaml b/blueprints.yaml index 06f8f2e..7f35a6d 100644 --- a/blueprints.yaml +++ b/blueprints.yaml @@ -81,6 +81,18 @@ form: validate: type: bool + ignore_protected: + type: toggle + label: PLUGIN_SITEMAP.IGNORE_PROTECTED + help: PLUGIN_SITEMAP.IGNORE_PROTECTED_HELP + highlight: 1 + default: 1 + options: + 1: PLUGIN_ADMIN.ENABLED + 0: PLUGIN_ADMIN.DISABLED + validate: + type: bool + ignores: type: array label: PLUGIN_SITEMAP.IGNORES diff --git a/languages.yaml b/languages.yaml index d068709..60d63ad 100644 --- a/languages.yaml +++ b/languages.yaml @@ -24,6 +24,8 @@ en: LASTMOD: 'Last modification e.g. 2017-04-06' IGNORE_EXTERNAL: 'Ignore External URLs' IGNORE_EXTERNAL_HELP: 'By default Sitemap hides pages that have an `external` URL' + IGNORE_PROTECTED: 'Ignore Protected Pages' + IGNORE_PROTECTED_HELP: 'Ignore pages that custom "access" set to protect them via a login' ru: PLUGIN_SITEMAP: SITEMAP: 'Карта сайта' diff --git a/sitemap.php b/sitemap.php index 8644f3a..f24dc35 100644 --- a/sitemap.php +++ b/sitemap.php @@ -84,12 +84,14 @@ public function onPagesInitialized() $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; - $page_ignored = $external_url || (isset($header->sitemap['ignore']) ? $header->sitemap['ignore'] : 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)); diff --git a/sitemap.yaml b/sitemap.yaml index a928785..70d4922 100644 --- a/sitemap.yaml +++ b/sitemap.yaml @@ -1,6 +1,7 @@ enabled: true route: '/sitemap' ignore_external: true +ignore_protected: true ignores: whitelist: changefreq: daily From ae62ab89929f0a948987e57b601e5e3d8dbbe88c Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 12:24:12 -0600 Subject: [PATCH 12/13] updated changelog Signed-off-by: Andy Miller --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a93ab29..0e7cc6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ 1. [](#new) * Added a new `Ignore External URLs` option that defaults to `true` - * Added a new `Ignore Protected Pages' option that defaults to `true` + * Added a new `Ignore Protected Pages` option that defaults to `true` [#62](https://github.com/getgrav/grav-plugin-sitemap/issues/62) * Added a new `onSitemapProcessed()` event to allow for dynamic manipulation of the sitemap 1. [](#improved) * Improved `SitemapEntry` to allow setting via constructor From cb846c9b61259055787be87d95bca52040a15137 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Wed, 1 Jul 2020 12:41:40 -0600 Subject: [PATCH 13/13] prepare for release Signed-off-by: Andy Miller --- blueprints.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/blueprints.yaml b/blueprints.yaml index 7f35a6d..54c2ecd 100644 --- a/blueprints.yaml +++ b/blueprints.yaml @@ -1,8 +1,8 @@ name: Sitemap +version: 2.0.0 +description: "Provide automatically generated **XML sitemaps** with this very useful, but simple to configure, Grav plugin." slug: sitemap type: plugin -version: 1.9.5 -description: "Provide automatically generated **XML sitemaps** with this very useful, but simple to configure, Grav plugin." icon: map-marker author: name: Team Grav