3 * Laconica, the distributed open-source microblogging tool
5 * URL routing utilities
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@controlyourself.ca>
25 * @copyright 2009 Control Yourself, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://laconi.ca/
30 if (!defined('LACONICA')) {
34 require_once 'Net/URL/Mapper.php';
39 * Cheap wrapper around Net_URL_Mapper
43 * @author Evan Prodromou <evan@controlyourself.ca>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://laconi.ca/
52 static $bare = array('requesttoken', 'accesstoken', 'userauthorization',
53 'postnotice', 'updateprofile', 'finishremotesubscribe',
54 'finishopenidlogin', 'finishaddopenid');
59 Router::$inst = new Router();
64 function __construct()
67 $this->m = $this->initialize();
73 $m = Net_URL_Mapper::getInstance();
77 $m->connect('', array('action' => 'public'));
78 $m->connect('rss', array('action' => 'publicrss'));
79 $m->connect('xrds', array('action' => 'publicxrds'));
80 $m->connect('featuredrss', array('action' => 'featuredrss'));
81 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
82 $m->connect('opensearch/people', array('action' => 'opensearch',
84 $m->connect('opensearch/notice', array('action' => 'opensearch',
89 $m->connect('doc/:title', array('action' => 'doc'));
93 $m->connect('facebook', array('action' => 'facebookhome'));
94 $m->connect('facebook/index.php', array('action' => 'facebookhome'));
95 $m->connect('facebook/settings.php', array('action' => 'facebooksettings'));
96 $m->connect('facebook/invite.php', array('action' => 'facebookinvite'));
97 $m->connect('facebook/remove', array('action' => 'facebookremove'));
99 // main stuff is repetitive
101 $main = array('login', 'logout', 'register', 'subscribe',
102 'unsubscribe', 'confirmaddress', 'recoverpassword',
103 'invite', 'favor', 'disfavor', 'sup',
106 foreach ($main as $a) {
107 $m->connect('main/'.$a, array('action' => $a));
110 $m->connect('main/sup/:seconds', array('action' => 'sup'),
111 array('seconds' => '[0-9]+'));
113 $m->connect('main/tagother/:id', array('action' => 'tagother'));
117 foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
118 $m->connect('main/'.$c.'/:code', array('action' => $c));
123 $m->connect('main/openid', array('action' => 'openidlogin'));
124 $m->connect('main/remote', array('action' => 'remotesubscribe'));
125 $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
127 foreach (Router::$bare as $action) {
128 $m->connect('index.php?action=' . $action, array('action' => $action));
133 foreach (array('profile', 'avatar', 'password', 'openid', 'im',
134 'email', 'sms', 'twitter', 'design', 'other') as $s) {
135 $m->connect('settings/'.$s, array('action' => $s.'settings'));
140 foreach (array('group', 'people', 'notice') as $s) {
141 $m->connect('search/'.$s, array('action' => $s.'search'));
142 $m->connect('search/'.$s.'?q=:q',
143 array('action' => $s.'search'),
147 // The second of these is needed to make the link work correctly
148 // when inserted into the page. The first is needed to match the
149 // route on the way in. Seems to be another Net_URL_Mapper bug to me.
150 $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
151 $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
154 $m->connect('attachment/:attachment/ajax',
155 array('action' => 'attachment_ajax'),
156 array('attachment' => '[0-9]+'));
158 $m->connect('attachment/:attachment/thumbnail',
159 array('action' => 'attachment_thumbnail'),
160 array('attachment' => '[0-9]+'));
162 $m->connect('notice/new', array('action' => 'newnotice'));
163 $m->connect('notice/new?replyto=:replyto',
164 array('action' => 'newnotice'),
165 array('replyto' => '[A-Za-z0-9_-]+'));
168 $m->connect('notice/:notice/file',
169 array('action' => 'file'),
170 array('notice' => '[0-9]+'));
173 $m->connect('notice/:notice',
174 array('action' => 'shownotice'),
175 array('notice' => '[0-9]+'));
176 $m->connect('notice/delete', array('action' => 'deletenotice'));
177 $m->connect('notice/delete/:notice',
178 array('action' => 'deletenotice'),
179 array('notice' => '[0-9]+'));
183 $m->connect('conversation/:id',
184 array('action' => 'conversation'),
185 array('id' => '[0-9]+'));
187 $m->connect('message/new', array('action' => 'newmessage'));
188 $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
189 $m->connect('message/:message',
190 array('action' => 'showmessage'),
191 array('message' => '[0-9]+'));
193 $m->connect('user/:id',
194 array('action' => 'userbyid'),
195 array('id' => '[0-9]+'));
197 $m->connect('tags/', array('action' => 'publictagcloud'));
198 $m->connect('tag/', array('action' => 'publictagcloud'));
199 $m->connect('tags', array('action' => 'publictagcloud'));
200 $m->connect('tag', array('action' => 'publictagcloud'));
201 $m->connect('tag/:tag/rss',
202 array('action' => 'tagrss'),
203 array('tag' => '[a-zA-Z0-9]+'));
204 $m->connect('tag/:tag',
205 array('action' => 'tag'),
206 array('tag' => '[a-zA-Z0-9]+'));
208 $m->connect('peopletag/:tag',
209 array('action' => 'peopletag'),
210 array('tag' => '[a-zA-Z0-9]+'));
212 $m->connect('featured/', array('action' => 'featured'));
213 $m->connect('featured', array('action' => 'featured'));
214 $m->connect('favorited/', array('action' => 'favorited'));
215 $m->connect('favorited', array('action' => 'favorited'));
219 $m->connect('group/new', array('action' => 'newgroup'));
221 foreach (array('edit', 'join', 'leave') as $v) {
222 $m->connect('group/:nickname/'.$v,
223 array('action' => $v.'group'),
224 array('nickname' => '[a-zA-Z0-9]+'));
227 foreach (array('members', 'logo', 'rss') as $n) {
228 $m->connect('group/:nickname/'.$n,
229 array('action' => 'group'.$n),
230 array('nickname' => '[a-zA-Z0-9]+'));
233 $m->connect('group/:id/id',
234 array('action' => 'groupbyid'),
235 array('id' => '[0-9]+'));
237 $m->connect('group/:nickname',
238 array('action' => 'showgroup'),
239 array('nickname' => '[a-zA-Z0-9]+'));
241 $m->connect('group/', array('action' => 'groups'));
242 $m->connect('group', array('action' => 'groups'));
243 $m->connect('groups/', array('action' => 'groups'));
244 $m->connect('groups', array('action' => 'groups'));
246 // Twitter-compatible API
250 $m->connect('api/statuses/:method',
251 array('action' => 'api',
252 'apiaction' => 'statuses'),
253 array('method' => '(public_timeline|friends_timeline|user_timeline|update|replies|mentions|friends|followers|featured)(\.(atom|rss|xml|json))?'));
255 $m->connect('api/statuses/:method/:argument',
256 array('action' => 'api',
257 'apiaction' => 'statuses'),
258 array('method' => '(user_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
262 $m->connect('api/users/:method/:argument',
263 array('action' => 'api',
264 'apiaction' => 'users'),
265 array('method' => 'show(\.(xml|json))?'));
267 $m->connect('api/users/:method',
268 array('action' => 'api',
269 'apiaction' => 'users'),
270 array('method' => 'show(\.(xml|json))?'));
274 foreach (array('xml', 'json') as $e) {
275 $m->connect('api/direct_messages/new.'.$e,
276 array('action' => 'api',
277 'apiaction' => 'direct_messages',
278 'method' => 'create.'.$e));
281 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
282 $m->connect('api/direct_messages.'.$e,
283 array('action' => 'api',
284 'apiaction' => 'direct_messages',
285 'method' => 'direct_messages.'.$e));
288 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
289 $m->connect('api/direct_messages/sent.'.$e,
290 array('action' => 'api',
291 'apiaction' => 'direct_messages',
292 'method' => 'sent.'.$e));
295 $m->connect('api/direct_messages/destroy/:argument',
296 array('action' => 'api',
297 'apiaction' => 'direct_messages'));
301 $m->connect('api/friendships/:method/:argument',
302 array('action' => 'api',
303 'apiaction' => 'friendships'),
304 array('method' => '(create|destroy)'));
306 $m->connect('api/friendships/:method',
307 array('action' => 'api',
308 'apiaction' => 'friendships'),
309 array('method' => 'exists(\.(xml|json))'));
313 $m->connect('api/friends/ids/:argument',
314 array('action' => 'api',
315 'apiaction' => 'statuses',
316 'method' => 'friendsIDs'));
318 foreach (array('xml', 'json') as $e) {
319 $m->connect('api/friends/ids.'.$e,
320 array('action' => 'api',
321 'apiaction' => 'statuses',
322 'method' => 'friendsIDs.'.$e));
325 $m->connect('api/followers/ids/:argument',
326 array('action' => 'api',
327 'apiaction' => 'statuses',
328 'method' => 'followersIDs'));
330 foreach (array('xml', 'json') as $e) {
331 $m->connect('api/followers/ids.'.$e,
332 array('action' => 'api',
333 'apiaction' => 'statuses',
334 'method' => 'followersIDs.'.$e));
339 $m->connect('api/account/:method',
340 array('action' => 'api',
341 'apiaction' => 'account'));
345 $m->connect('api/favorites/:method/:argument',
346 array('action' => 'api',
347 'apiaction' => 'favorites'));
349 $m->connect('api/favorites/:argument',
350 array('action' => 'api',
351 'apiaction' => 'favorites',
352 'method' => 'favorites'));
354 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
355 $m->connect('api/favorites.'.$e,
356 array('action' => 'api',
357 'apiaction' => 'favorites',
358 'method' => 'favorites.'.$e));
363 $m->connect('api/notifications/:method/:argument',
364 array('action' => 'api',
365 'apiaction' => 'favorites'));
369 $m->connect('api/blocks/:method/:argument',
370 array('action' => 'api',
371 'apiaction' => 'blocks'));
375 $m->connect('api/help/:method',
376 array('action' => 'api',
377 'apiaction' => 'help'));
381 $m->connect('api/laconica/:method',
382 array('action' => 'api',
383 'apiaction' => 'laconica'));
386 $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
387 $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
388 $m->connect('api/trends.json', array('action' => 'twitapitrends'));
392 foreach (array('subscriptions', 'subscribers',
393 'nudge', 'xrds', 'all', 'foaf',
394 'replies', 'inbox', 'outbox', 'microsummary') as $a) {
395 $m->connect(':nickname/'.$a,
396 array('action' => $a),
397 array('nickname' => '[a-zA-Z0-9]{1,64}'));
400 foreach (array('subscriptions', 'subscribers') as $a) {
401 $m->connect(':nickname/'.$a.'/:tag',
402 array('action' => $a),
403 array('tag' => '[a-zA-Z0-9]+',
404 'nickname' => '[a-zA-Z0-9]{1,64}'));
407 foreach (array('rss', 'groups') as $a) {
408 $m->connect(':nickname/'.$a,
409 array('action' => 'user'.$a),
410 array('nickname' => '[a-zA-Z0-9]{1,64}'));
413 foreach (array('all', 'replies', 'favorites') as $a) {
414 $m->connect(':nickname/'.$a.'/rss',
415 array('action' => $a.'rss'),
416 array('nickname' => '[a-zA-Z0-9]{1,64}'));
419 $m->connect(':nickname/favorites',
420 array('action' => 'showfavorites'),
421 array('nickname' => '[a-zA-Z0-9]{1,64}'));
423 $m->connect(':nickname/avatar/:size',
424 array('action' => 'avatarbynickname'),
425 array('size' => '(original|96|48|24)',
426 'nickname' => '[a-zA-Z0-9]{1,64}'));
428 $m->connect(':nickname/tag/:tag/rss',
429 array('action' => 'userrss'),
430 array('nickname' => '[a-zA-Z0-9]{1,64}'),
431 array('tag' => '[a-zA-Z0-9]+'));
433 $m->connect(':nickname/tag/:tag',
434 array('action' => 'showstream'),
435 array('nickname' => '[a-zA-Z0-9]{1,64}'),
436 array('tag' => '[a-zA-Z0-9]+'));
438 $m->connect(':nickname',
439 array('action' => 'showstream'),
440 array('nickname' => '[a-zA-Z0-9]{1,64}'));
442 Event::handle('RouterInitialized', array($m));
450 $match = $this->m->match($path);
451 } catch (Net_URL_Mapper_InvalidException $e) {
452 common_log(LOG_ERR, "Problem getting route for $path - " .
454 $cac = new ClientErrorAction("Page not found.", 404);
461 function build($action, $args=null, $params=null, $fragment=null)
463 $action_arg = array('action' => $action);
466 $args = array_merge($action_arg, $args);
471 $url = $this->m->generate($args, $params, $fragment);
473 // Due to a bug in the Net_URL_Mapper code, the returned URL may
474 // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
475 // repair that here rather than modifying the upstream code...
477 $qpos = strpos($url, '?');
478 if ($qpos !== false) {
479 $url = substr($url, 0, $qpos+1) .
480 str_replace('?', '&', substr($url, $qpos+1));