tonyair
/
silverstripe-googlesitemaps
mirror of https://github.com/wilr/silverstripe-googlesitemaps.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge 805c7e2ee4 into 9c0d50e726

This commit is contained in:
GitHub Merge Button 2011-06-12 16:03:22 -07:00
parent 9c0d50e726 805c7e2ee4
commit 11ed61f4c7
4 changed files with 177 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
code/GoogleSitemap.php
View File

@ -10,7 +10,7 @@
* sitemap whenever the GoogleBot visits your website.
*
* Enabling notification of Google after every publish (in your _config.php):
*
* <example>
* GoogleSitemap::enable_google_notificaton();
* </example>
@ -54,22 +54,38 @@ class GoogleSitemap extends Controller {
* @var array
*/
public static $google_sitemap_dataobjects_changefreq = array();
/**
* List of DataObjects priority
*
* @var array
*/
public static $google_sitemap_dataobjects_priority = array();
/**
/**
* Decorates the given DataObject with {@link GoogleSitemapDecorator}
* and pushes the class name to the registered DataObjects.
* Note that all registered DataObjects need the method AbsoluteLink().
*
* @param string $className name of DataObject to register
* @param string $changeFreq
* @param string $className name of DataObject to register
* @param string $changeFreq how often is this DataObject updated?
* Possible values:
* always, hourly, daily, weekly, monthly, yearly, never
* @param string $priority How important is this DataObject in comparison to other urls?
* Possible values: 0.1, 0.2 ... , 0.9, 1.0
*
* @return void
*/
public static function register_dataobject($className, $changeFreq = 'monthly') {
public static function register_dataobject($className, $changeFreq = 'monthly', $priority = '0.6') {
if (!self::is_registered($className)) {
Object::add_extension($className, 'GoogleSitemapDecorator');
self::$google_sitemap_dataobjects[] = $className;
self::$google_sitemap_dataobjects_changefreq[] = $changeFreq;
if ($changeFreq === null) {
self::$google_sitemap_dataobjects_changefreq[] = "monthly";
} else {
self::$google_sitemap_dataobjects_changefreq[] = $changeFreq;
}
self::$google_sitemap_dataobjects_priority[] = $priority;
}
}
@ -88,8 +104,6 @@ class GoogleSitemap extends Controller {
* Adds DataObjects to the existing DataObjectSet with pages from the
* site tree
*
* @param DataObjectSet $newPages
*
* @return DataObjectSet
*/
protected function addRegisteredDataObjects() {
@ -100,11 +114,11 @@ class GoogleSitemap extends Controller {
if($dataObjectSet) {
foreach($dataObjectSet as $dataObject) {
if($dataObject->canView() && (!isset($dataObject->Priority) || $dataObject->Priority > 0)) {
if($dataObject->canView()) {
$dataObject->ChangeFreq = self::$google_sitemap_dataobjects_changefreq[$index];
if(!isset($dataObject->Priority)) {
$dataObject->Priority = 1.0;
$dataObject->Priority = self::$google_sitemap_dataobjects_priority[$index];
}
$output->push($dataObject);
@ -150,51 +164,12 @@ class GoogleSitemap extends Controller {
// If the page has been set to 0 priority, we set a flag so
// it won't be included
if($page->canView() && (!isset($page->Priority) || $page->Priority > 0)) {
// The one field that isn't easy to deal with in the template is
// Change frequency, so we set that here.
$date = date('Y-m-d H:i:s');
$prop = $page->toMap();
$created = new SS_Datetime();
$created->value = (isset($prop['Created'])) ? $prop['Created'] : $date;
$now = new SS_Datetime();
$now->value = $date;
$versions = (isset($prop['Version'])) ? $prop['Version'] : 1;
$timediff = $now->format('U') - $created->format('U');
// Check how many revisions have been made over the lifetime of the
// Page for a rough estimate of it's changing frequency.
$period = $timediff / ($versions + 1);
if($period > 60*60*24*365) {
// > 1 year
$page->ChangeFreq = 'yearly';
}
elseif($period > 60*60*24*30) {
$page->ChangeFreq = 'monthly';
}
elseif($period > 60*60*24*7) {
// > 1 week
$page->ChangeFreq = 'weekly';
}
elseif($period > 60*60*24) {
// > 1 day
$page->ChangeFreq = 'daily';
}
elseif($period > 60*60) {
// > 1 hour
$page->ChangeFreq = 'hourly';
} else {
// < 1 hour
$page->ChangeFreq = 'always';
}
$page->setChangeFrequency();
$newPages->push($page);
}
}
}
}
$newPages->merge($this->addRegisteredDataObjects());

201
code/GoogleSitemapDecorator.php
View File

@ -7,89 +7,132 @@
* @package googlesitemaps
*/
class GoogleSitemapDecorator extends DataObjectDecorator {
}
/**
* @package googlesitemaps
*/
class GoogleSitemapSiteTreeDecorator extends SiteTreeDecorator {
function extraStatics() {
return array(
'db' => array(
"Priority" => "Varchar(5)",
)
);
}
function updateCMSFields(&$fields) {
$pagePriorities = array(
'' => _t('SiteTree.PRIORITYAUTOSET','Auto-set based on page depth'),
'-1' => _t('SiteTree.PRIORITYNOTINDEXED', "Not indexed"), // We set this to -ve one because a blank value implies auto-generation of Priority
'1.0' => '1 - ' . _t('SiteTree.PRIORITYMOSTIMPORTANT', "Most important"),
'0.9' => '2',
'0.8' => '3',
'0.7' => '4',
'0.6' => '5',
'0.5' => '6',
'0.4' => '7',
'0.3' => '8',
'0.2' => '9',
'0.1' => '10 - ' . _t('SiteTree.PRIORITYLEASTIMPORTANT', "Least important")
);
$tabset = $fields->findOrMakeTab('Root.Content');
$tabset->push(
$addTab = new Tab(
'GoogleSitemap',
_t('SiteTree.TABGOOGLESITEMAP', 'Google Sitemap'),
new LiteralField(
"GoogleSitemapIntro",
"<p>" .
sprintf(
_t(
'SiteTree.METANOTEPRIORITY',
"Manually specify a Google Sitemaps priority for this page (%s)"
),
'<a href="http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=71936#prioritize" target="_blank">?</a>'
) .
"</p>"
),
new DropdownField("Priority", $this->owner->fieldLabel('Priority'), $pagePriorities)
)
);
}
function updateFieldLabels(&$labels) {
parent::updateFieldLabels($labels);
$labels['Priority'] = _t('SiteTree.METAPAGEPRIO', "Page Priority");
}
function onAfterPublish() {
GoogleSitemap::ping();
}
function onAfterUnpublish() {
GoogleSitemap::ping();
}
/**
* The default value of the priority field depends on the depth of the page in
* the site tree, so it must be calculated dynamically.
*/
function getPriority() {
if(!$this->owner->getField('Priority')) {
$parentStack = $this->owner->parentStack();
$numParents = is_array($parentStack) ? count($parentStack) - 1: 0;
return max(0.1, 1.0 - ($numParents / 10));
} elseif($this->owner->getField('Priority') == -1) {
return 0;
} else {
return $this->owner->getField('Priority');
}
}
function extraStatics() {
return array(
'db' => array(
"Priority" => "Varchar(5)",
)
);
}
function updateCMSFields(&$fields) {
$pagePriorities = array(
'' => _t('SiteTree.PRIORITYAUTOSET', 'Auto-set based on page depth'),
'-1' => _t('SiteTree.PRIORITYNOTINDEXED', "Not indexed"), // We set this to -ve one because a blank value implies auto-generation of Priority
'1.0' => '1 - ' . _t('SiteTree.PRIORITYMOSTIMPORTANT', "Most important"),
'0.9' => '2',
'0.8' => '3',
'0.7' => '4',
'0.6' => '5',
'0.5' => '6',
'0.4' => '7',
'0.3' => '8',
'0.2' => '9',
'0.1' => '10 - ' . _t('SiteTree.PRIORITYLEASTIMPORTANT', "Least important")
);
$tabset = $fields->findOrMakeTab('Root.Content');
$tabset->push(
$addTab = new Tab(
'GoogleSitemap',
_t('SiteTree.TABGOOGLESITEMAP', 'Google Sitemap'),
new LiteralField(
"GoogleSitemapIntro",
"<p>" .
sprintf(
_t(
'SiteTree.METANOTEPRIORITY', "Manually specify a Google Sitemaps priority for this page (%s)"
), '<a href="http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=71936#prioritize" target="_blank">?</a>'
) .
"</p>"
),
new DropdownField("Priority", $this->owner->fieldLabel('Priority'), $pagePriorities)
)
);
}
function updateFieldLabels(&$labels) {
parent::updateFieldLabels($labels);
$labels['Priority'] = _t('SiteTree.METAPAGEPRIO', "Page Priority");
}
function onAfterPublish() {
GoogleSitemap::ping();
}
function onAfterUnpublish() {
GoogleSitemap::ping();
}
/**
* The default value of the priority field depends on the depth of the page in
* the site tree, so it must be calculated dynamically.
*/
function getPriority() {
if (!$this->owner->getField('Priority')) {
$parentStack = $this->owner->parentStack();
$numParents = is_array($parentStack) ? count($parentStack) - 1 : 0;
return max(0.1, 1.0 - ($numParents / 10));
} elseif ($this->owner->getField('Priority') == -1) {
return 0;
} else {
return $this->owner->getField('Priority');
}
}
/**
* Set a pages change frequency calculated by pages age and number of versions.
* Google expects always, hourly, daily, weekly, monthly, yearly or never as values.
*
* @return void
*/
public function setChangeFrequency() {
// The one field that isn't easy to deal with in the template is
// Change frequency, so we set that here.
$date = date('Y-m-d H:i:s');
$prop = $this->owner->toMap();
$created = new SS_Datetime();
$created->value = (isset($prop['Created'])) ? $prop['Created'] : $date;
$now = new SS_Datetime();
$now->value = $date;
$versions = (isset($prop['Version'])) ? $prop['Version'] : 1;
$timediff = $now->format('U') - $created->format('U');
// Check how many revisions have been made over the lifetime of the
// Page for a rough estimate of it's changing frequency.
$period = $timediff / ($versions + 1);
if ($period > 60 * 60 * 24 * 365) {
// > 1 year
$this->owner->ChangeFreq = 'yearly';
} elseif ($period > 60 * 60 * 24 * 30) {
$this->owner->ChangeFreq = 'monthly';
} elseif ($period > 60 * 60 * 24 * 7) {
// > 1 week
$this->owner->ChangeFreq = 'weekly';
} elseif ($period > 60 * 60 * 24) {
// > 1 day
$this->owner->ChangeFreq = 'daily';
} elseif ($period > 60 * 60) {
// > 1 hour
$this->owner->ChangeFreq = 'hourly';
} else {
// < 1 hour
$this->owner->ChangeFreq = 'always';
}
}
}

20
tests/GoogleSitemapTest.php Normal file
View File

@ -0,0 +1,20 @@
<?php
/**
* Unit test for GoogleSitemap
*
* @author Roland Lehmann <rlehmann@pixeltricks.de>
* @since 11.06.2011
*/
class GoogleSitemapTest extends SapphireTest {
public function testItems() {
//Publish a page and check if it returns
$obj = $this->objFromFixture("Page", "Page1");
$page = DataObject::get_by_id("Page", $obj->ID);
#$page->publish();
#$sitemap = new GoogleSitemap();
#$this->assertEquals(1, $sitemap->Items()->Count());
}
}

9
tests/GoogleSitemapTest.yml Normal file
View File

@ -0,0 +1,9 @@
Page:
Page1:
Page2:
Page3:
DataObject:
DataObject1:
DataObject2:
DataObject3: