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 'Sitemap_user_count':
68 require_once $dir . '/' . $cls . '.php';
70 case 'SitemapindexAction':
71 case 'NoticesitemapAction':
72 case 'UsersitemapAction':
73 require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
76 require_once $dir . '/' . strtolower($cls) . '.php';
84 * Add sitemap-related information at the end of robots.txt
86 * @param Action $action Action being run
88 * @return boolean hook value.
91 function onEndRobotsTxt($action)
93 $url = common_local_url('sitemapindex');
95 print "\nSitemap: $url\n";
101 * Map URLs to actions
103 * @param Net_URL_Mapper $m path-to-action mapper
105 * @return boolean hook value; true means continue processing, false means stop.
108 function onRouterInitialized($m)
110 $m->connect('sitemapindex.xml',
111 array('action' => 'sitemapindex'));
113 $m->connect('/notice-sitemap-:year-:month-:day-:index.xml',
114 array('action' => 'noticesitemap'),
115 array('year' => '[0-9]{4}',
116 'month' => '[01][0-9]',
117 'day' => '[0123][0-9]',
118 'index' => '[1-9][0-9]*'));
120 $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
121 array('action' => 'usersitemap'),
122 array('year' => '[0-9]{4}',
123 'month' => '[01][0-9]',
124 'day' => '[0123][0-9]',
125 'index' => '[1-9][0-9]*'));
130 * Database schema setup
132 * We cache some data persistently to avoid overlong queries.
134 * @see Sitemap_user_count
135 * @see Sitemap_notice_count
137 * @return boolean hook value; true means continue processing, false means stop.
140 function onCheckSchema()
142 $schema = Schema::get();
144 // For storing user-submitted flags on profiles
146 $schema->ensureTable('sitemap_user_count',
147 array(new ColumnDef('registration_date', 'date', null,
149 new ColumnDef('user_count', 'integer'),
150 new ColumnDef('created', 'datetime',
152 new ColumnDef('modified', 'timestamp')));
154 $schema->ensureTable('sitemap_notice_count',
155 array(new ColumnDef('notice_date', 'date', null,
157 new ColumnDef('notice_count', 'integer'),
158 new ColumnDef('created', 'datetime',
160 new ColumnDef('modified', 'timestamp')));