3 * StatusNet, 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@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once 'Net/URL/Mapper.php';
39 * Cheap wrapper around Net_URL_Mapper
43 * @author Evan Prodromou <evan@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
52 static $bare = array('requesttoken', 'accesstoken', 'userauthorization',
53 'postnotice', 'updateprofile', 'finishremotesubscribe');
58 Router::$inst = new Router();
63 function __construct()
66 $this->m = $this->initialize();
72 $m = Net_URL_Mapper::getInstance();
74 if (Event::handle('StartInitializeRouter', array(&$m))) {
78 $m->connect('', array('action' => 'public'));
79 $m->connect('rss', array('action' => 'publicrss'));
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'));
91 // main stuff is repetitive
93 $main = array('login', 'logout', 'register', 'subscribe',
94 'unsubscribe', 'confirmaddress', 'recoverpassword',
95 'invite', 'favor', 'disfavor', 'sup',
96 'block', 'unblock', 'subedit',
97 'groupblock', 'groupunblock');
99 foreach ($main as $a) {
100 $m->connect('main/'.$a, array('action' => $a));
103 $m->connect('main/sup/:seconds', array('action' => 'sup'),
104 array('seconds' => '[0-9]+'));
106 $m->connect('main/tagother/:id', array('action' => 'tagother'));
108 $m->connect('main/oembed',
109 array('action' => 'oembed'));
113 foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
114 $m->connect('main/'.$c.'/:code', array('action' => $c));
119 $m->connect('main/remote', array('action' => 'remotesubscribe'));
120 $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
122 foreach (Router::$bare as $action) {
123 $m->connect('index.php?action=' . $action, array('action' => $action));
128 foreach (array('profile', 'avatar', 'password', 'im',
129 'email', 'sms', 'userdesign', 'other') as $s) {
130 $m->connect('settings/'.$s, array('action' => $s.'settings'));
135 foreach (array('group', 'people', 'notice') as $s) {
136 $m->connect('search/'.$s, array('action' => $s.'search'));
137 $m->connect('search/'.$s.'?q=:q',
138 array('action' => $s.'search'),
142 // The second of these is needed to make the link work correctly
143 // when inserted into the page. The first is needed to match the
144 // route on the way in. Seems to be another Net_URL_Mapper bug to me.
145 $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
146 $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
149 $m->connect('attachment/:attachment',
150 array('action' => 'attachment'),
151 array('attachment' => '[0-9]+'));
153 $m->connect('attachment/:attachment/ajax',
154 array('action' => 'attachment_ajax'),
155 array('attachment' => '[0-9]+'));
157 $m->connect('attachment/:attachment/thumbnail',
158 array('action' => 'attachment_thumbnail'),
159 array('attachment' => '[0-9]+'));
161 $m->connect('notice/new', array('action' => 'newnotice'));
162 $m->connect('notice/new?replyto=:replyto',
163 array('action' => 'newnotice'),
164 array('replyto' => '[A-Za-z0-9_-]+'));
165 $m->connect('notice/new?replyto=:replyto&inreplyto=:inreplyto',
166 array('action' => 'newnotice'),
167 array('replyto' => '[A-Za-z0-9_-]+'),
168 array('inreplyto' => '[0-9]+'));
170 $m->connect('notice/:notice/file',
171 array('action' => 'file'),
172 array('notice' => '[0-9]+'));
174 $m->connect('notice/:notice',
175 array('action' => 'shownotice'),
176 array('notice' => '[0-9]+'));
177 $m->connect('notice/delete', array('action' => 'deletenotice'));
178 $m->connect('notice/delete/:notice',
179 array('action' => 'deletenotice'),
180 array('notice' => '[0-9]+'));
184 $m->connect('conversation/:id',
185 array('action' => 'conversation'),
186 array('id' => '[0-9]+'));
188 $m->connect('message/new', array('action' => 'newmessage'));
189 $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
190 $m->connect('message/:message',
191 array('action' => 'showmessage'),
192 array('message' => '[0-9]+'));
194 $m->connect('user/:id',
195 array('action' => 'userbyid'),
196 array('id' => '[0-9]+'));
198 $m->connect('tags/', array('action' => 'publictagcloud'));
199 $m->connect('tag/', array('action' => 'publictagcloud'));
200 $m->connect('tags', array('action' => 'publictagcloud'));
201 $m->connect('tag', array('action' => 'publictagcloud'));
202 $m->connect('tag/:tag/rss',
203 array('action' => 'tagrss'),
204 array('tag' => '[a-zA-Z0-9]+'));
205 $m->connect('tag/:tag',
206 array('action' => 'tag'),
207 array('tag' => '[\pL\pN_\-\.]{1,64}'));
209 $m->connect('peopletag/:tag',
210 array('action' => 'peopletag'),
211 array('tag' => '[a-zA-Z0-9]+'));
213 $m->connect('featured/', array('action' => 'featured'));
214 $m->connect('featured', array('action' => 'featured'));
215 $m->connect('favorited/', array('action' => 'favorited'));
216 $m->connect('favorited', array('action' => 'favorited'));
220 $m->connect('group/new', array('action' => 'newgroup'));
222 foreach (array('edit', 'join', 'leave') as $v) {
223 $m->connect('group/:nickname/'.$v,
224 array('action' => $v.'group'),
225 array('nickname' => '[a-zA-Z0-9]+'));
228 foreach (array('members', 'logo', 'rss', 'designsettings') as $n) {
229 $m->connect('group/:nickname/'.$n,
230 array('action' => 'group'.$n),
231 array('nickname' => '[a-zA-Z0-9]+'));
234 $m->connect('group/:nickname/foaf',
235 array('action' => 'foafgroup'),
236 array('nickname' => '[a-zA-Z0-9]+'));
238 $m->connect('group/:nickname/blocked',
239 array('action' => 'blockedfromgroup'),
240 array('nickname' => '[a-zA-Z0-9]+'));
242 $m->connect('group/:nickname/makeadmin',
243 array('action' => 'makeadmin'),
244 array('nickname' => '[a-zA-Z0-9]+'));
246 $m->connect('group/:id/id',
247 array('action' => 'groupbyid'),
248 array('id' => '[0-9]+'));
250 $m->connect('group/:nickname',
251 array('action' => 'showgroup'),
252 array('nickname' => '[a-zA-Z0-9]+'));
254 $m->connect('group/', array('action' => 'groups'));
255 $m->connect('group', array('action' => 'groups'));
256 $m->connect('groups/', array('action' => 'groups'));
257 $m->connect('groups', array('action' => 'groups'));
259 // Twitter-compatible API
263 $m->connect('api/statuses/public_timeline.:format',
264 array('action' => 'ApiTimelinePublic',
265 'format' => '(xml|json|rss|atom)'));
267 $m->connect('api/statuses/friends_timeline.:format',
268 array('action' => 'ApiTimelineFriends',
269 'format' => '(xml|json|rss|atom)'));
271 $m->connect('api/statuses/friends_timeline/:id.:format',
272 array('action' => 'ApiTimelineFriends',
273 'id' => '[a-zA-Z0-9]+',
274 'format' => '(xml|json|rss|atom)'));
275 $m->connect('api/statuses/home_timeline.:format',
276 array('action' => 'ApiTimelineFriends',
277 'format' => '(xml|json|rss|atom)'));
279 $m->connect('api/statuses/home_timeline/:id.:format',
280 array('action' => 'ApiTimelineFriends',
281 'id' => '[a-zA-Z0-9]+',
282 'format' => '(xml|json|rss|atom)'));
284 $m->connect('api/statuses/user_timeline.:format',
285 array('action' => 'ApiTimelineUser',
286 'format' => '(xml|json|rss|atom)'));
288 $m->connect('api/statuses/user_timeline/:id.:format',
289 array('action' => 'ApiTimelineUser',
290 'id' => '[a-zA-Z0-9]+',
291 'format' => '(xml|json|rss|atom)'));
293 $m->connect('api/statuses/mentions.:format',
294 array('action' => 'ApiTimelineMentions',
295 'format' => '(xml|json|rss|atom)'));
297 $m->connect('api/statuses/mentions/:id.:format',
298 array('action' => 'ApiTimelineMentions',
299 'id' => '[a-zA-Z0-9]+',
300 'format' => '(xml|json|rss|atom)'));
302 $m->connect('api/statuses/replies.:format',
303 array('action' => 'ApiTimelineMentions',
304 'format' => '(xml|json|rss|atom)'));
306 $m->connect('api/statuses/replies/:id.:format',
307 array('action' => 'ApiTimelineMentions',
308 'id' => '[a-zA-Z0-9]+',
309 'format' => '(xml|json|rss|atom)'));
311 $m->connect('api/statuses/friends.:format',
312 array('action' => 'ApiUserFriends',
313 'format' => '(xml|json)'));
315 $m->connect('api/statuses/friends/:id.:format',
316 array('action' => 'ApiUserFriends',
317 'id' => '[a-zA-Z0-9]+',
318 'format' => '(xml|json)'));
320 $m->connect('api/statuses/followers.:format',
321 array('action' => 'ApiUserFollowers',
322 'format' => '(xml|json)'));
324 $m->connect('api/statuses/followers/:id.:format',
325 array('action' => 'ApiUserFollowers',
326 'id' => '[a-zA-Z0-9]+',
327 'format' => '(xml|json)'));
329 $m->connect('api/statuses/show.:format',
330 array('action' => 'ApiStatusesShow',
331 'format' => '(xml|json)'));
333 $m->connect('api/statuses/show/:id.:format',
334 array('action' => 'ApiStatusesShow',
336 'format' => '(xml|json)'));
338 $m->connect('api/statuses/update.:format',
339 array('action' => 'ApiStatusesUpdate',
340 'format' => '(xml|json)'));
342 $m->connect('api/statuses/destroy.:format',
343 array('action' => 'ApiStatusesDestroy',
344 'format' => '(xml|json)'));
346 $m->connect('api/statuses/destroy/:id.:format',
347 array('action' => 'ApiStatusesDestroy',
349 'format' => '(xml|json)'));
353 $m->connect('api/users/show/:id.:format',
354 array('action' => 'ApiUserShow',
355 'id' => '[a-zA-Z0-9]+',
356 'format' => '(xml|json)'));
358 $m->connect('api/users/:method',
359 array('action' => 'api',
360 'apiaction' => 'users'),
361 array('method' => 'show(\.(xml|json))?'));
365 $m->connect('api/direct_messages.:format',
366 array('action' => 'ApiDirectMessage',
367 'format' => '(xml|json|rss|atom)'));
369 $m->connect('api/direct_messages/sent.:format',
370 array('action' => 'ApiDirectMessage',
371 'format' => '(xml|json|rss|atom)',
374 $m->connect('api/direct_messages/new.:format',
375 array('action' => 'ApiDirectMessageNew',
376 'format' => '(xml|json)'));
380 $m->connect('api/friendships/show.:format',
381 array('action' => 'ApiFriendshipsShow',
382 'format' => '(xml|json)'));
384 $m->connect('api/friendships/exists.:format',
385 array('action' => 'ApiFriendshipsExists',
386 'format' => '(xml|json)'));
388 $m->connect('api/friendships/create.:format',
389 array('action' => 'ApiFriendshipsCreate',
390 'format' => '(xml|json)'));
392 $m->connect('api/friendships/destroy.:format',
393 array('action' => 'ApiFriendshipsDestroy',
394 'format' => '(xml|json)'));
396 $m->connect('api/friendships/create/:id.:format',
397 array('action' => 'ApiFriendshipsCreate',
398 'id' => '[a-zA-Z0-9]+',
399 'format' => '(xml|json)'));
401 $m->connect('api/friendships/destroy/:id.:format',
402 array('action' => 'ApiFriendshipsDestroy',
403 'id' => '[a-zA-Z0-9]+',
404 'format' => '(xml|json)'));
408 $m->connect('api/friends/ids/:id.:format',
409 array('action' => 'apiFriends',
410 'ids_only' => true));
412 $m->connect('api/followers/ids/:id.:format',
413 array('action' => 'apiFollowers',
414 'ids_only' => true));
416 $m->connect('api/friends/ids.:format',
417 array('action' => 'apiFriends',
418 'ids_only' => true));
420 $m->connect('api/followers/ids.:format',
421 array('action' => 'apiFollowers',
422 'ids_only' => true));
426 $m->connect('api/account/verify_credentials.:format',
427 array('action' => 'ApiAccountVerifyCredentials'));
429 // special case where verify_credentials is called w/out a format
431 $m->connect('api/account/verify_credentials',
432 array('action' => 'ApiAccountVerifyCredentials'));
434 $m->connect('api/account/rate_limit_status.:format',
435 array('action' => 'ApiAccountRateLimitStatus'));
439 $m->connect('api/favorites.:format',
440 array('action' => 'ApiTimelineFavorites',
441 'format' => '(xml|json|rss|atom)'));
443 $m->connect('api/favorites/:id.:format',
444 array('action' => 'ApiTimelineFavorites',
445 'id' => '[a-zA-Z0-9]+',
446 'format' => '(xmljson|rss|atom)'));
448 $m->connect('api/favorites/create/:id.:format',
449 array('action' => 'ApiFavoriteCreate',
450 'id' => '[a-zA-Z0-9]+',
451 'format' => '(xml|json)'));
453 $m->connect('api/favorites/destroy/:id.:format',
454 array('action' => 'ApiFavoriteDestroy',
455 'id' => '[a-zA-Z0-9]+',
456 'format' => '(xml|json)'));
460 $m->connect('api/notifications/:method/:argument',
461 array('action' => 'api',
462 'apiaction' => 'favorites'));
466 $m->connect('api/blocks/create/:id.:format',
467 array('action' => 'ApiBlockCreate',
468 'id' => '[a-zA-Z0-9]+',
469 'format' => '(xml|json)'));
471 $m->connect('api/blocks/destroy/:id.:format',
472 array('action' => 'ApiBlockDestroy',
473 'id' => '[a-zA-Z0-9]+',
474 'format' => '(xml|json)'));
477 $m->connect('api/help/test.:format',
478 array('action' => 'ApiHelpTest',
479 'format' => '(xml|json)'));
483 $m->connect('api/statusnet/version.:format',
484 array('action' => 'ApiStatusnetVersion',
485 'format' => '(xml|json)'));
487 $m->connect('api/statusnet/config.:format',
488 array('action' => 'ApiStatusnetConfig',
489 'format' => '(xml|json)'));
491 // For older methods, we provide "laconica" base action
493 $m->connect('api/laconica/version.:format',
494 array('action' => 'ApiStatusnetVersion',
495 'format' => '(xml|json)'));
497 $m->connect('api/laconica/config.:format',
498 array('action' => 'ApiStatusnetConfig',
499 'format' => '(xml|json)'));
501 // Groups and tags are newer than 0.8.1 so no backward-compatibility
505 //'list' has to be handled differently, as php will not allow a method to be named 'list'
507 $m->connect('api/statusnet/groups/timeline/:id.:format',
508 array('action' => 'ApiTimelineGroup',
509 'id' => '[a-zA-Z0-9]+',
510 'format' => '(xmljson|rss|atom)'));
512 $m->connect('api/statusnet/groups/show.:format',
513 array('action' => 'ApiGroupShow',
514 'format' => '(xml|json)'));
516 $m->connect('api/statusnet/groups/show/:id.:format',
517 array('action' => 'ApiGroupShow',
518 'id' => '[a-zA-Z0-9]+',
519 'format' => '(xml|json)'));
521 $m->connect('api/statusnet/groups/join.:format',
522 array('action' => 'ApiGroupJoin',
523 'id' => '[a-zA-Z0-9]+',
524 'format' => '(xml|json)'));
526 $m->connect('api/statusnet/groups/join/:id.:format',
527 array('action' => 'ApiGroupJoin',
528 'format' => '(xml|json)'));
530 $m->connect('api/statusnet/groups/leave.:format',
531 array('action' => 'ApiGroupLeave',
532 'id' => '[a-zA-Z0-9]+',
533 'format' => '(xml|json)'));
535 $m->connect('api/statusnet/groups/leave/:id.:format',
536 array('action' => 'ApiGroupLeave',
537 'format' => '(xml|json)'));
539 $m->connect('api/statusnet/groups/is_member.:format',
540 array('action' => 'ApiGroupIsMember',
541 'format' => '(xml|json)'));
543 $m->connect('api/statusnet/groups/list.:format',
544 array('action' => 'ApiGroupList',
545 'format' => '(xml|json|rss|atom)'));
547 $m->connect('api/statusnet/groups/list/:id.:format',
548 array('action' => 'ApiGroupList',
549 'id' => '[a-zA-Z0-9]+',
550 'format' => '(xml|json|rss|atom)'));
552 $m->connect('api/statusnet/groups/list_all.:format',
553 array('action' => 'ApiGroupListAll',
554 'format' => '(xml|json|rss|atom)'));
556 $m->connect('api/statusnet/groups/membership.:format',
557 array('action' => 'ApiGroupMembership',
558 'format' => '(xml|json)'));
560 $m->connect('api/statusnet/groups/membership/:id.:format',
561 array('action' => 'ApiGroupMembership',
562 'id' => '[a-zA-Z0-9]+',
563 'format' => '(xml|json)'));
565 $m->connect('api/statusnet/groups/create.:format',
566 array('action' => 'ApiGroupCreate',
567 'format' => '(xml|json)'));
569 $m->connect('api/statusnet/tags/timeline/:tag.:format',
570 array('action' => 'ApiTimelineTag',
571 'format' => '(xmljson|rss|atom)'));
574 $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
575 $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
576 $m->connect('api/trends.json', array('action' => 'twitapitrends'));
580 foreach (array('subscriptions', 'subscribers',
581 'nudge', 'all', 'foaf', 'xrds',
582 'replies', 'inbox', 'outbox', 'microsummary') as $a) {
583 $m->connect(':nickname/'.$a,
584 array('action' => $a),
585 array('nickname' => '[a-zA-Z0-9]{1,64}'));
588 foreach (array('subscriptions', 'subscribers') as $a) {
589 $m->connect(':nickname/'.$a.'/:tag',
590 array('action' => $a),
591 array('tag' => '[a-zA-Z0-9]+',
592 'nickname' => '[a-zA-Z0-9]{1,64}'));
595 foreach (array('rss', 'groups') as $a) {
596 $m->connect(':nickname/'.$a,
597 array('action' => 'user'.$a),
598 array('nickname' => '[a-zA-Z0-9]{1,64}'));
601 foreach (array('all', 'replies', 'favorites') as $a) {
602 $m->connect(':nickname/'.$a.'/rss',
603 array('action' => $a.'rss'),
604 array('nickname' => '[a-zA-Z0-9]{1,64}'));
607 $m->connect(':nickname/favorites',
608 array('action' => 'showfavorites'),
609 array('nickname' => '[a-zA-Z0-9]{1,64}'));
611 $m->connect(':nickname/avatar/:size',
612 array('action' => 'avatarbynickname'),
613 array('size' => '(original|96|48|24)',
614 'nickname' => '[a-zA-Z0-9]{1,64}'));
616 $m->connect(':nickname/tag/:tag/rss',
617 array('action' => 'userrss'),
618 array('nickname' => '[a-zA-Z0-9]{1,64}'),
619 array('tag' => '[a-zA-Z0-9]+'));
621 $m->connect(':nickname/tag/:tag',
622 array('action' => 'showstream'),
623 array('nickname' => '[a-zA-Z0-9]{1,64}'),
624 array('tag' => '[a-zA-Z0-9]+'));
626 $m->connect(':nickname',
627 array('action' => 'showstream'),
628 array('nickname' => '[a-zA-Z0-9]{1,64}'));
630 Event::handle('RouterInitialized', array($m));
639 $match = $this->m->match($path);
640 } catch (Net_URL_Mapper_InvalidException $e) {
641 common_log(LOG_ERR, "Problem getting route for $path - " .
643 $cac = new ClientErrorAction("Page not found.", 404);
650 function build($action, $args=null, $params=null, $fragment=null)
652 $action_arg = array('action' => $action);
655 $args = array_merge($action_arg, $args);
660 $url = $this->m->generate($args, $params, $fragment);
662 // Due to a bug in the Net_URL_Mapper code, the returned URL may
663 // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
664 // repair that here rather than modifying the upstream code...
666 $qpos = strpos($url, '?');
667 if ($qpos !== false) {
668 $url = substr($url, 0, $qpos+1) .
669 str_replace('?', '&', substr($url, $qpos+1));