Skip to content

Feature/global sitemap ignore #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
justb3a wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature/global sitemap ignore #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f8fd85
adding global sitemap_ignore field to pages table
Nov 13, 2014
43c9070
updating Readme and adding some screens
Nov 13, 2014
261a5d9
correcting image paths in readme
Nov 13, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
351 changes: 214 additions & 137 deletions MarkupSitemapXML.module
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,137 +1,214 @@
<?php

class MarkupSitemapXML extends WireData implements Module {

/**
* Provide information about this module to ProcessWire
*
*/
public static function getModuleInfo() {
return array(
'title' => 'Markup Sitemap XML',
'summary' => 'Generates an XML sitemap at yoursite.com/sitemap.xml for use with Google Webmaster Tools etc.',
'href' => 'http://processwire.com/talk/index.php/topic,867.0.html',
'version' => 110,
'permanent' => false,
'autoload' => true,
'singular' => true,
);
}

/**
* Add the hook
*
*/
public function init() {
// Intercept a request for an URL ending in sitemap.xml and output
if (isset($_SERVER['REQUEST_URI']) && strlen($_SERVER['REQUEST_URI']) - strlen('/sitemap.xml') === strrpos($_SERVER['REQUEST_URI'], '/sitemap.xml')) {
$this->addHookBefore("ProcessPageView::pageNotFound",$this,"renderSitemap");
}
}

public function renderSitemap(HookEvent $event){
//$event->replace = true;
$lang = '';
$this->pageselector = '';
$langname = ''; // for LanguageLocalizedUrl
$subdomain = ''; // for Multisite

// set startpage according to request (sitemap.xml spec says that sitemap
// should only contain pages below it's root page in page tree)
// Fix #11 by FlipZoomMedia | David Karich
$startpage = str_ireplace(trim(wire('config')->urls->root, '/'), '', $this->sanitizer->path(dirname($_SERVER['REQUEST_URI'])));

// Multisite requires minor URL-related tweak
if (wire("modules")->isInstalled("Multisite")) {
$multisite = wire("modules")->get("Multisite");
if ($multisite->subdomain) {
$startpage = "/".$multisite->subdomain.$startpage;
}
}

// make sure that page used as root for sitemap actually exists
if ($this->pages->get($startpage) instanceof NullPage) return;

// support for LanguageLocalizedURL language module
if(wire("modules")->isInstalled("LanguageLocalizedURL")) {
$llu = wire("modules")->get("LanguageLocalizedURL");
$langname = $this->page->name;
$lang = ($llu->defaultLang == $langname) ? 'default' : $langname;
$langpage = $this->page;
// get the field name for published language from the modules settings
$publishedfield_name = $llu->publishedPageField ? $llu->publishedPageField : 'language_published';
// add a selector to find children pages when generating sitemap list
$this->pageselector = "$publishedfield_name=$langpage->id";
//set user language so the module will spit out language localized urls
$this->user->language = $this->languages->get($lang);
}
// Check for the cached sitemap, else generate and cache a fresh sitemap
$startpagestr = $this->sanitizer->pageName($startpage);
$cache = wire('modules')->get("MarkupCache");
if(!$output = $cache->get("MarkupSitemapXML$startpagestr$langname", 3600)) {
$output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
$output .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
$output .= $this->sitemapListPage(wire('pages')->get($startpage));
$output .= "\n</urlset>";
$cache->save($output);
}
header("Content-Type: text/xml", true, 200);
echo $output;
exit();
}

public function sitemapListPage($page) {
$entry = "";
if ($page->viewable() && ($page->sitemap_ignore == 0 || $page->path == '/')) { // $page->path part added so that it ignores hiding the homepage, else you wouldn't have ANY pages returned
$modified = date ('Y-m-d', $page->modified);
$entry = "\n <url>\n";
$entry .= " <loc>{$page->httpUrl}</loc>\n";
$entry .= " <lastmod>{$modified}</lastmod>\n";
$entry .= " </url>";
}
// Fix #12 by FlipZoomMedia | David Karich
$children = $page->children($this->pageselector);
if(count($children)) {
foreach($children as $child) {
$entry .= $this->sitemapListPage($child);
}
}
return $entry;
}

/**
* Install the module
*
*/
public function ___install() {

if($this->fields->get('sitemap_ignore')) {
$this->error("You already have a 'sitemap_ignore' field.");
return;
}

wire('modules')->get('MarkupCache');

$field = new Field();
$field->type = $this->modules->get("FieldtypeCheckbox");
$field->name = 'sitemap_ignore';
$field->label = 'Hide page from XML sitemap';
$field->description = 'Hide this page and its children from the XML sitemap';
$field->save();

$this->message("Added field 'sitemap_ignore'. Add this field to any templates where you want to prevent inclusion in the XML sitemap.");
}

/**
* Uninstall the module
*
*/
public function ___uninstall() {
// only do the following if you want to uninstall the fields that were installed
// this may be one thing that's safe to leave to the user
$field = wire('fields')->get('sitemap_ignore');
if($field && $field->numFieldgroups() > 0)
throw new WireException("Can't uninstall because field sitemap_ignore is still being used. Please remove it from any templates.");
wire('fields')->delete($field);
}
}
<?php
/**
* ProcessWire Fieldtype Image Extra
*
* See README.md for usage instructions.
*
* ProcessWire 2.x
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* @author Peter Burlingham <hello@notanotherdotcom.com>
* @author Tabea David <td@kf-interactive.com>
* @version 1.1.1
* @copyright Copyright (c) 2014 Notanotherdotcom, https://www.notanotherdotcom.com/, <hello@notanotherdotcom.com>
* @copyright Copyright (c) 2014 KF Interactive, www.kf-interactive.com, <info@kf-interactive.com>
* @see http://www.processwire.com
*
*/

/**
* Class MarkupSitemapXML
*/
class MarkupSitemapXML extends WireData implements Module {

/**
* Provide information about this module to ProcessWire
*
*/
public static function getModuleInfo() {
return array(
'title' => 'Markup Sitemap XML',
'summary' => 'Generates an XML sitemap at yoursite.com/sitemap.xml for use with Google Webmaster Tools etc.',
'href' => 'http://processwire.com/talk/index.php/topic,867.0.html',
'version' => 111,
'permanent' => false,
'autoload' => true,
'singular' => true,
);
}

/**
* Add the hook
*
*/
public function init() {
$this->addHookAfter('ProcessPageEdit::buildFormSettings', $this, 'addIgnoreXML');
$this->addHookAfter('Pages::save', $this, 'saveIgnoreXML');

// Intercept a request for an URL ending in sitemap.xml and output
if (isset($_SERVER['REQUEST_URI']) && strlen($_SERVER['REQUEST_URI']) - strlen('/sitemap.xml') === strrpos($_SERVER['REQUEST_URI'], '/sitemap.xml')) {
$this->addHookBefore("ProcessPageView::pageNotFound",$this,"renderSitemap");
}

}

/**
* Hook adding Checkbox Sitemap XML to form page edit adding Checkbox Sitemap XML to form page edit
*
* @param HookEvent $event
*/
public function addIgnoreXML(HookEvent $event) {
$page = $event->object->getPage();

// add checkbox only to user-defined templates, not system templates
if(!($page->template->flags & Template::flagSystem)) {
$fieldset = $event->return; // get the fieldwrapper returned
$checked = (int) $page->sitemap_ignore === 1 ? 'checked' : '';
$field = $this->modules->get('InputfieldCheckbox');
$field->attr('id+name', 'sitemap_ignore');
$field->attr('value', 1);
$field->label = $this->_('Markup Sitemap XML');
$field->description = $this->_('Check the box to confirm that you want to hide this page and its children from the XML sitemap');
$field->label2 = $this->_('Hide from XML sitemap');
$field->collapsed = Inputfield::collapsedYes;
$field->attr('checked', $checked);
$fieldset->add($field);
}
}

/**
* Hook save Checkbox Sitemap XML
*
* @param HookEvent $event
*/
public function saveIgnoreXML($event) {
$page = $event->arguments[0];
$database = $this->wire('database');
$query = $database->prepare("UPDATE pages SET sitemap_ignore=:page_sitemap_ignore WHERE id=:page_id");
$query->bindValue(":page_sitemap_ignore", (int) $page->sitemap_ignore, PDO::PARAM_INT);
$query->bindValue(":page_id", (int) $page->id, PDO::PARAM_INT);

try {
$query->execute();
} catch(Exception $e) {
$errorCode = $e->getCode();
$this->message("Could not remove column 'sitemap_ignore'. Errorcode: $errorCode");
}
}

/**
* Hook render Sitemap
*
* @param HookEvent $event
*/
public function renderSitemap(HookEvent $event){
//$event->replace = true;
$lang = '';
$this->pageselector = '';
$langname = ''; // for LanguageLocalizedUrl
$subdomain = ''; // for Multisite

// set startpage according to request (sitemap.xml spec says that sitemap
// should only contain pages below it's root page in page tree)
// Fix #11 by FlipZoomMedia | David Karich
$startpage = str_ireplace(trim(wire('config')->urls->root, '/'), '', $this->sanitizer->path(dirname($_SERVER['REQUEST_URI'])));

// Multisite requires minor URL-related tweak
if (wire("modules")->isInstalled("Multisite")) {
$multisite = wire("modules")->get("Multisite");
if ($multisite->subdomain) {
$startpage = "/".$multisite->subdomain.$startpage;
}
}

// make sure that page used as root for sitemap actually exists
if ($this->pages->get($startpage) instanceof NullPage) return;

// support for LanguageLocalizedURL language module
if(wire("modules")->isInstalled("LanguageLocalizedURL")) {
$llu = wire("modules")->get("LanguageLocalizedURL");
$langname = $this->page->name;
$lang = ($llu->defaultLang == $langname) ? 'default' : $langname;
$langpage = $this->page;
// get the field name for published language from the modules settings
$publishedfield_name = $llu->publishedPageField ? $llu->publishedPageField : 'language_published';
// add a selector to find children pages when generating sitemap list
$this->pageselector = "$publishedfield_name=$langpage->id";
//set user language so the module will spit out language localized urls
$this->user->language = $this->languages->get($lang);
}
// Check for the cached sitemap, else generate and cache a fresh sitemap
$startpagestr = $this->sanitizer->pageName($startpage);
$cache = wire('modules')->get("MarkupCache");
if(!$output = $cache->get("MarkupSitemapXML$startpagestr$langname", 3600)) {
$output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
$output .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
$output .= $this->sitemapListPage(wire('pages')->get($startpage));
$output .= "\n</urlset>";
$cache->save($output);
}
header("Content-Type: text/xml", true, 200);
echo $output;
exit();
}

/**
* sitemapListPage
*
* @param Page $page
*/
public function sitemapListPage($page) {
$entry = "";
if ($page->viewable() && ($page->sitemap_ignore == 0 || $page->path == '/')) { // $page->path part added so that it ignores hiding the homepage, else you wouldn't have ANY pages returned
$modified = date ('Y-m-d', $page->modified);
$entry = "\n <url>\n";
$entry .= " <loc>{$page->httpUrl}</loc>\n";
$entry .= " <lastmod>{$modified}</lastmod>\n";
$entry .= " </url>";
}
// Fix #12 by FlipZoomMedia | David Karich
$children = $page->children($this->pageselector);
if(count($children)) {
foreach($children as $child) {
$entry .= $this->sitemapListPage($child);
}
}
return $entry;
}

/**
* Install the module
*
*/
public function ___install() {
$database = $this->wire('database');
$newField = "sitemap_ignore int(11) unsigned NOT NULL DEFAULT '0'";
$query = $database->prepare("ALTER TABLE pages ADD $newField");

try {
$query->execute();
$this->message("Added column 'sitemap_ignore'. Check this field in page settings where you want to prevent inclusion in the XML sitempap");
} catch(Exception $e) {
$errorCode = $e->getCode();
$this->message("Could not add column 'sitemap_ignore'.");
}
}

/**
* Uninstall the module
*
*/
public function ___uninstall() {
$database = $this->wire('database');
$query = $database->prepare("ALTER TABLE pages DROP COLUMN sitemap_ignore");

try {
$query->execute();
$this->message("Removed successfully column 'sitemap_ignore'.");
} catch(Exception $e) {
$errorCode = $e->getCode();
$this->message("Could not remove column 'sitemap_ignore'.");
}

}
}
Loading