3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Creates a dynamic sitemap for a StatusNet site
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Evan Prodromou <evan@status.net>
26 * @copyright 2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
42 * @author Evan Prodromou <evan@status.net>
43 * @copyright 2010 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45 * @link http://status.net/
48 class SitemapPlugin extends Plugin
50 const USERS_PER_MAP = 50000;
51 const NOTICES_PER_MAP = 50000;
54 * Load related modules when needed
56 * @param string $cls Name of the class to be loaded
58 * @return boolean hook value; true means continue processing, false means stop.
61 function onAutoload($cls)
63 $dir = dirname(__FILE__);
67 case 'SitemapindexAction':
68 case 'NoticesitemapAction':
69 case 'UsersitemapAction':
70 require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
73 require_once $dir . '/' . strtolower($cls) . '.php';
80 * Add sitemap-related information at the end of robots.txt
82 * @param Action $action Action being run
84 * @return boolean hook value.
87 function onEndRobotsTxt($action)
89 $url = common_local_url('sitemapindex');
91 print "\nSitemap: $url\n";
99 * @param Net_URL_Mapper $m path-to-action mapper
101 * @return boolean hook value; true means continue processing, false means stop.
104 function onRouterInitialized($m)
106 $m->connect('sitemapindex.xml',
107 array('action' => 'sitemapindex'));
109 $m->connect('/notice-sitemap-:year-:month-:day-:index.xml',
110 array('action' => 'noticesitemap'),
111 array('year' => '[0-9]{4}',
112 'month' => '[01][0-9]',
113 'day' => '[0123][0-9]',
114 'index' => '[1-9][0-9]*'));
116 $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
117 array('action' => 'usersitemap'),
118 array('year' => '[0-9]{4}',
119 'month' => '[01][0-9]',
120 'day' => '[0123][0-9]',
121 'index' => '[1-9][0-9]*'));