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
51 * Load related modules when needed
53 * Most non-trivial plugins will require extra modules to do their work. Typically
54 * these include data classes, action classes, widget classes, or external libraries.
56 * This method receives a class name and loads the PHP file related to that class. By
57 * tradition, action classes typically have files named for the action, all lower-case.
58 * Data classes are in files with the data class name, initial letter capitalized.
60 * Note that this method will be called for *all* overloaded classes, not just ones
61 * in this plugin! So, make sure to return true by default to let other plugins, and
62 * the core code, get a chance.
64 * @param string $cls Name of the class to be loaded
66 * @return boolean hook value; true means continue processing, false means stop.
69 function onAutoload($cls)
71 $dir = dirname(__FILE__);
75 case 'SitemapindexAction':
76 case 'NoticesitemapAction':
77 case 'UsersitemapAction':
78 require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
81 require_once $dir . '/' . strtolower($cls) . '.php';
90 * @param Net_URL_Mapper $m path-to-action mapper
92 * @return boolean hook value; true means continue processing, false means stop.
95 function onRouterInitialized($m)
97 $m->connect('sitemapindex.xml',
98 array('action' => 'sitemapindex'));
99 $m->connect('/sitemaps/notice/:year/:month/:day/:index.xml',
100 array('action' => 'noticesitemap'),
101 array('year' => '[0-9]{4}',
102 'month' => '[1]?[0-9]',
103 'day' => '[123]?[0-9]',
104 'index' => '[0-9]+'));
106 $m->connect('/sitemaps/user/:index.xml',
107 array('action' => 'usersitemap'),
108 array('index' => '[0-9]+',
109 'month' => '[1]?[0-9]',
110 'day' => '[123]?[0-9]'));