gnu-social/plugins/Sitemap/SitemapPlugin.php

197 lines
5.7 KiB
PHP
Raw Permalink Normal View History

2010-03-22 04:25:49 +00:00
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2010-03-22 04:25:49 +00:00
/**
* Creates a dynamic sitemap for a StatusNet site
*
* @package GNUsocial
2010-03-22 04:25:49 +00:00
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2010-03-22 04:25:49 +00:00
*/
defined('GNUSOCIAL') || die();
2010-03-22 04:25:49 +00:00
/**
* Sitemap plugin
*
* @copyright 2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2010-03-22 04:25:49 +00:00
*/
class SitemapPlugin extends Plugin
{
const PLUGIN_VERSION = '2.0.0';
2010-04-12 16:05:19 +01:00
const USERS_PER_MAP = 50000;
const NOTICES_PER_MAP = 50000;
2010-04-10 15:03:57 +01:00
2010-04-12 19:32:01 +01:00
/**
* Add sitemap-related information at the end of robots.txt
*
* @param Action $action Action being run
*
* @return boolean hook value.
*/
public function onEndRobotsTxt($action)
2010-04-12 19:32:01 +01:00
{
$url = common_local_url('sitemapindex');
print "\nSitemap: $url\n";
return true;
}
2010-03-22 04:25:49 +00:00
/**
* Map URLs to actions
*
* @param URLMapper $m path-to-action mapper
2010-03-22 04:25:49 +00:00
*
* @return boolean hook value; true means continue processing, false means stop.
*/
public function onRouterInitialized(URLMapper $m)
2010-03-22 04:25:49 +00:00
{
$m->connect(
'sitemapindex.xml',
['action' => 'sitemapindex']
);
$m->connect(
'notice-sitemap-:year-:month-:day-:index.xml',
['action' => 'noticesitemap'],
[
'year' => '[0-9]{4}',
'month' => '[01][0-9]',
'day' => '[0123][0-9]',
'index' => '[1-9][0-9]*',
]
);
$m->connect(
'user-sitemap-:year-:month-:day-:index.xml',
['action' => 'usersitemap'],
[
'year' => '[0-9]{4}',
'month' => '[01][0-9]',
'day' => '[0123][0-9]',
'index' => '[1-9][0-9]*',
]
);
$m->connect(
'panel/sitemap',
['action' => 'sitemapadminpanel']
);
2010-03-22 04:25:49 +00:00
return true;
}
2010-06-13 19:58:06 +01:00
/**
* Meta tags for "claiming" a site
*
* We add extra meta tags that search engines like Yahoo! and Bing
2010-06-13 19:58:06 +01:00
* require to let you claim your site.
*
* @param Action $action Action being executed
*
* @return boolean hook value.
*/
public function onStartShowHeadElements($action)
2010-06-13 19:58:06 +01:00
{
$actionName = $action->trimmed('action');
$singleUser = common_config('singleuser', 'enabled');
// Different "top" pages if it's single user or not
if (($singleUser && $actionName == 'showstream') ||
(!$singleUser && $actionName == 'public')) {
$keys = array('yahookey' => 'y_key',
2010-06-13 19:58:06 +01:00
'bingkey' => 'msvalidate.01'); // XXX: is this the same for all sites?
foreach ($keys as $config => $metaname) {
$content = common_config('sitemap', $config);
if (!empty($content)) {
$action->element('meta', array('name' => $metaname,
'content' => $content));
}
}
}
return true;
}
/**
* Database schema setup
*
* We cache some data persistently to avoid overlong queries.
*
* @see Sitemap_user_count
* @see Sitemap_notice_count
*
* @return boolean hook value; true means continue processing, false means stop.
*/
public function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('sitemap_user_count', Sitemap_user_count::schemaDef());
$schema->ensureTable('sitemap_notice_count', Sitemap_notice_count::schemaDef());
return true;
}
public function onEndAdminPanelNav($menu)
{
if (AdminPanelAction::canAdmin('sitemap')) {
// TRANS: Menu item title/tooltip
$menu_title = _m('Sitemap configuration');
// TRANS: Menu item for site administration
$menu->out->menuItem(
common_local_url('sitemapadminpanel'),
_m('MENU', 'Sitemap'),
$menu_title,
($action_name === 'sitemapadminpanel'),
'nav_sitemap_admin_panel'
);
}
return true;
}
/**
* Provide plugin version information.
*
* This data is used when showing the version page.
*
* @param array &$versions array of version data arrays; see EVENTS.txt
*
* @return boolean hook value
*/
public function onPluginVersion(array &$versions): bool
{
$url = GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/Sitemap';
$versions[] = array('name' => 'Sitemap',
'version' => self::PLUGIN_VERSION,
'author' => 'Evan Prodromou',
'homepage' => $url,
'rawdescription' =>
// TRANS: Plugin description.
_m('This plugin allows creation of sitemaps for Bing and Yahoo!.'));
return true;
}
2010-03-22 04:25:49 +00:00
}