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 $m->connect('main/login?user_id=:user_id&token=:token', array('action'=>'login'), array('user_id'=> '[0-9]+', 'token'=>'.+'));
93 // main stuff is repetitive
95 $main = array('login', 'logout', 'register', 'subscribe',
96 'unsubscribe', 'confirmaddress', 'recoverpassword',
97 'invite', 'favor', 'disfavor', 'sup',
98 'block', 'unblock', 'subedit',
99 'groupblock', 'groupunblock',
100 'sandbox', 'unsandbox',
101 'silence', 'unsilence',
105 foreach ($main as $a) {
106 $m->connect('main/'.$a, array('action' => $a));
109 $m->connect('main/sup/:seconds', array('action' => 'sup'),
110 array('seconds' => '[0-9]+'));
112 $m->connect('main/tagother/:id', array('action' => 'tagother'));
114 $m->connect('main/oembed',
115 array('action' => 'oembed'));
117 $m->connect('main/xrds',
118 array('action' => 'publicxrds'));
122 foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
123 $m->connect('main/'.$c.'/:code', array('action' => $c));
128 $m->connect('main/remote', array('action' => 'remotesubscribe'));
129 $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
131 foreach (Router::$bare as $action) {
132 $m->connect('index.php?action=' . $action, array('action' => $action));
137 foreach (array('profile', 'avatar', 'password', 'im',
138 'email', 'sms', 'userdesign', 'other') as $s) {
139 $m->connect('settings/'.$s, array('action' => $s.'settings'));
144 foreach (array('group', 'people', 'notice') as $s) {
145 $m->connect('search/'.$s, array('action' => $s.'search'));
146 $m->connect('search/'.$s.'?q=:q',
147 array('action' => $s.'search'),
151 // The second of these is needed to make the link work correctly
152 // when inserted into the page. The first is needed to match the
153 // route on the way in. Seems to be another Net_URL_Mapper bug to me.
154 $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
155 $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
158 $m->connect('attachment/:attachment',
159 array('action' => 'attachment'),
160 array('attachment' => '[0-9]+'));
162 $m->connect('attachment/:attachment/ajax',
163 array('action' => 'attachment_ajax'),
164 array('attachment' => '[0-9]+'));
166 $m->connect('attachment/:attachment/thumbnail',
167 array('action' => 'attachment_thumbnail'),
168 array('attachment' => '[0-9]+'));
170 $m->connect('notice/new', array('action' => 'newnotice'));
171 $m->connect('notice/new?replyto=:replyto',
172 array('action' => 'newnotice'),
173 array('replyto' => '[A-Za-z0-9_-]+'));
174 $m->connect('notice/new?replyto=:replyto&inreplyto=:inreplyto',
175 array('action' => 'newnotice'),
176 array('replyto' => '[A-Za-z0-9_-]+'),
177 array('inreplyto' => '[0-9]+'));
179 $m->connect('notice/:notice/file',
180 array('action' => 'file'),
181 array('notice' => '[0-9]+'));
183 $m->connect('notice/:notice',
184 array('action' => 'shownotice'),
185 array('notice' => '[0-9]+'));
186 $m->connect('notice/delete', array('action' => 'deletenotice'));
187 $m->connect('notice/delete/:notice',
188 array('action' => 'deletenotice'),
189 array('notice' => '[0-9]+'));
191 $m->connect('bookmarklet/new', array('action' => 'bookmarklet'));
195 $m->connect('conversation/:id',
196 array('action' => 'conversation'),
197 array('id' => '[0-9]+'));
199 $m->connect('message/new', array('action' => 'newmessage'));
200 $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
201 $m->connect('message/:message',
202 array('action' => 'showmessage'),
203 array('message' => '[0-9]+'));
205 $m->connect('user/:id',
206 array('action' => 'userbyid'),
207 array('id' => '[0-9]+'));
209 $m->connect('tags/', array('action' => 'publictagcloud'));
210 $m->connect('tag/', array('action' => 'publictagcloud'));
211 $m->connect('tags', array('action' => 'publictagcloud'));
212 $m->connect('tag', array('action' => 'publictagcloud'));
213 $m->connect('tag/:tag/rss',
214 array('action' => 'tagrss'),
215 array('tag' => '[a-zA-Z0-9]+'));
216 $m->connect('tag/:tag',
217 array('action' => 'tag'),
218 array('tag' => '[\pL\pN_\-\.]{1,64}'));
220 $m->connect('peopletag/:tag',
221 array('action' => 'peopletag'),
222 array('tag' => '[a-zA-Z0-9]+'));
224 $m->connect('featured/', array('action' => 'featured'));
225 $m->connect('featured', array('action' => 'featured'));
226 $m->connect('favorited/', array('action' => 'favorited'));
227 $m->connect('favorited', array('action' => 'favorited'));
231 $m->connect('group/new', array('action' => 'newgroup'));
233 foreach (array('edit', 'join', 'leave') as $v) {
234 $m->connect('group/:nickname/'.$v,
235 array('action' => $v.'group'),
236 array('nickname' => '[a-zA-Z0-9]+'));
239 foreach (array('members', 'logo', 'rss', 'designsettings') as $n) {
240 $m->connect('group/:nickname/'.$n,
241 array('action' => 'group'.$n),
242 array('nickname' => '[a-zA-Z0-9]+'));
245 $m->connect('group/:nickname/foaf',
246 array('action' => 'foafgroup'),
247 array('nickname' => '[a-zA-Z0-9]+'));
249 $m->connect('group/:nickname/blocked',
250 array('action' => 'blockedfromgroup'),
251 array('nickname' => '[a-zA-Z0-9]+'));
253 $m->connect('group/:nickname/makeadmin',
254 array('action' => 'makeadmin'),
255 array('nickname' => '[a-zA-Z0-9]+'));
257 $m->connect('group/:id/id',
258 array('action' => 'groupbyid'),
259 array('id' => '[0-9]+'));
261 $m->connect('group/:nickname',
262 array('action' => 'showgroup'),
263 array('nickname' => '[a-zA-Z0-9]+'));
265 $m->connect('group/', array('action' => 'groups'));
266 $m->connect('group', array('action' => 'groups'));
267 $m->connect('groups/', array('action' => 'groups'));
268 $m->connect('groups', array('action' => 'groups'));
270 // Twitter-compatible API
274 $m->connect('api/statuses/public_timeline.:format',
275 array('action' => 'ApiTimelinePublic',
276 'format' => '(xml|json|rss|atom)'));
278 $m->connect('api/statuses/friends_timeline.:format',
279 array('action' => 'ApiTimelineFriends',
280 'format' => '(xml|json|rss|atom)'));
282 $m->connect('api/statuses/friends_timeline/:id.:format',
283 array('action' => 'ApiTimelineFriends',
284 'id' => '[a-zA-Z0-9]+',
285 'format' => '(xml|json|rss|atom)'));
286 $m->connect('api/statuses/home_timeline.:format',
287 array('action' => 'ApiTimelineFriends',
288 'format' => '(xml|json|rss|atom)'));
290 $m->connect('api/statuses/home_timeline/:id.:format',
291 array('action' => 'ApiTimelineFriends',
292 'id' => '[a-zA-Z0-9]+',
293 'format' => '(xml|json|rss|atom)'));
295 $m->connect('api/statuses/user_timeline.:format',
296 array('action' => 'ApiTimelineUser',
297 'format' => '(xml|json|rss|atom)'));
299 $m->connect('api/statuses/user_timeline/:id.:format',
300 array('action' => 'ApiTimelineUser',
301 'id' => '[a-zA-Z0-9]+',
302 'format' => '(xml|json|rss|atom)'));
304 $m->connect('api/statuses/mentions.:format',
305 array('action' => 'ApiTimelineMentions',
306 'format' => '(xml|json|rss|atom)'));
308 $m->connect('api/statuses/mentions/:id.:format',
309 array('action' => 'ApiTimelineMentions',
310 'id' => '[a-zA-Z0-9]+',
311 'format' => '(xml|json|rss|atom)'));
313 $m->connect('api/statuses/replies.:format',
314 array('action' => 'ApiTimelineMentions',
315 'format' => '(xml|json|rss|atom)'));
317 $m->connect('api/statuses/replies/:id.:format',
318 array('action' => 'ApiTimelineMentions',
319 'id' => '[a-zA-Z0-9]+',
320 'format' => '(xml|json|rss|atom)'));
322 $m->connect('api/statuses/friends.:format',
323 array('action' => 'ApiUserFriends',
324 'format' => '(xml|json)'));
326 $m->connect('api/statuses/friends/:id.:format',
327 array('action' => 'ApiUserFriends',
328 'id' => '[a-zA-Z0-9]+',
329 'format' => '(xml|json)'));
331 $m->connect('api/statuses/followers.:format',
332 array('action' => 'ApiUserFollowers',
333 'format' => '(xml|json)'));
335 $m->connect('api/statuses/followers/:id.:format',
336 array('action' => 'ApiUserFollowers',
337 'id' => '[a-zA-Z0-9]+',
338 'format' => '(xml|json)'));
340 $m->connect('api/statuses/show.:format',
341 array('action' => 'ApiStatusesShow',
342 'format' => '(xml|json)'));
344 $m->connect('api/statuses/show/:id.:format',
345 array('action' => 'ApiStatusesShow',
347 'format' => '(xml|json)'));
349 $m->connect('api/statuses/update.:format',
350 array('action' => 'ApiStatusesUpdate',
351 'format' => '(xml|json)'));
353 $m->connect('api/statuses/destroy.:format',
354 array('action' => 'ApiStatusesDestroy',
355 'format' => '(xml|json)'));
357 $m->connect('api/statuses/destroy/:id.:format',
358 array('action' => 'ApiStatusesDestroy',
360 'format' => '(xml|json)'));
362 $m->connect('api/statuses/retweet/:id.:format',
363 array('action' => 'ApiStatusesRetweet',
365 'format' => '(xml|json)'));
369 $m->connect('api/users/show.:format',
370 array('action' => 'ApiUserShow',
371 'format' => '(xml|json)'));
373 $m->connect('api/users/show/:id.:format',
374 array('action' => 'ApiUserShow',
375 'id' => '[a-zA-Z0-9]+',
376 'format' => '(xml|json)'));
380 $m->connect('api/direct_messages.:format',
381 array('action' => 'ApiDirectMessage',
382 'format' => '(xml|json|rss|atom)'));
384 $m->connect('api/direct_messages/sent.:format',
385 array('action' => 'ApiDirectMessage',
386 'format' => '(xml|json|rss|atom)',
389 $m->connect('api/direct_messages/new.:format',
390 array('action' => 'ApiDirectMessageNew',
391 'format' => '(xml|json)'));
395 $m->connect('api/friendships/show.:format',
396 array('action' => 'ApiFriendshipsShow',
397 'format' => '(xml|json)'));
399 $m->connect('api/friendships/exists.:format',
400 array('action' => 'ApiFriendshipsExists',
401 'format' => '(xml|json)'));
403 $m->connect('api/friendships/create.:format',
404 array('action' => 'ApiFriendshipsCreate',
405 'format' => '(xml|json)'));
407 $m->connect('api/friendships/destroy.:format',
408 array('action' => 'ApiFriendshipsDestroy',
409 'format' => '(xml|json)'));
411 $m->connect('api/friendships/create/:id.:format',
412 array('action' => 'ApiFriendshipsCreate',
413 'id' => '[a-zA-Z0-9]+',
414 'format' => '(xml|json)'));
416 $m->connect('api/friendships/destroy/:id.:format',
417 array('action' => 'ApiFriendshipsDestroy',
418 'id' => '[a-zA-Z0-9]+',
419 'format' => '(xml|json)'));
423 $m->connect('api/friends/ids/:id.:format',
424 array('action' => 'apiFriends',
425 'ids_only' => true));
427 $m->connect('api/followers/ids/:id.:format',
428 array('action' => 'apiFollowers',
429 'ids_only' => true));
431 $m->connect('api/friends/ids.:format',
432 array('action' => 'apiFriends',
433 'ids_only' => true));
435 $m->connect('api/followers/ids.:format',
436 array('action' => 'apiFollowers',
437 'ids_only' => true));
441 $m->connect('api/account/verify_credentials.:format',
442 array('action' => 'ApiAccountVerifyCredentials'));
444 $m->connect('api/account/update_profile.:format',
445 array('action' => 'ApiAccountUpdateProfile'));
447 $m->connect('api/account/update_profile_image.:format',
448 array('action' => 'ApiAccountUpdateProfileImage'));
450 $m->connect('api/account/update_profile_background_image.:format',
451 array('action' => 'ApiAccountUpdateProfileBackgroundImage'));
453 $m->connect('api/account/update_profile_colors.:format',
454 array('action' => 'ApiAccountUpdateProfileColors'));
456 $m->connect('api/account/update_delivery_device.:format',
457 array('action' => 'ApiAccountUpdateDeliveryDevice'));
459 // special case where verify_credentials is called w/out a format
461 $m->connect('api/account/verify_credentials',
462 array('action' => 'ApiAccountVerifyCredentials'));
464 $m->connect('api/account/rate_limit_status.:format',
465 array('action' => 'ApiAccountRateLimitStatus'));
469 $m->connect('api/favorites.:format',
470 array('action' => 'ApiTimelineFavorites',
471 'format' => '(xml|json|rss|atom)'));
473 $m->connect('api/favorites/:id.:format',
474 array('action' => 'ApiTimelineFavorites',
475 'id' => '[a-zA-Z0-9]+',
476 'format' => '(xmljson|rss|atom)'));
478 $m->connect('api/favorites/create/:id.:format',
479 array('action' => 'ApiFavoriteCreate',
480 'id' => '[a-zA-Z0-9]+',
481 'format' => '(xml|json)'));
483 $m->connect('api/favorites/destroy/:id.:format',
484 array('action' => 'ApiFavoriteDestroy',
485 'id' => '[a-zA-Z0-9]+',
486 'format' => '(xml|json)'));
489 $m->connect('api/blocks/create/:id.:format',
490 array('action' => 'ApiBlockCreate',
491 'id' => '[a-zA-Z0-9]+',
492 'format' => '(xml|json)'));
494 $m->connect('api/blocks/destroy/:id.:format',
495 array('action' => 'ApiBlockDestroy',
496 'id' => '[a-zA-Z0-9]+',
497 'format' => '(xml|json)'));
500 $m->connect('api/help/test.:format',
501 array('action' => 'ApiHelpTest',
502 'format' => '(xml|json)'));
506 $m->connect('api/statusnet/version.:format',
507 array('action' => 'ApiStatusnetVersion',
508 'format' => '(xml|json)'));
510 $m->connect('api/statusnet/config.:format',
511 array('action' => 'ApiStatusnetConfig',
512 'format' => '(xml|json)'));
514 // For older methods, we provide "laconica" base action
516 $m->connect('api/laconica/version.:format',
517 array('action' => 'ApiStatusnetVersion',
518 'format' => '(xml|json)'));
520 $m->connect('api/laconica/config.:format',
521 array('action' => 'ApiStatusnetConfig',
522 'format' => '(xml|json)'));
524 // Groups and tags are newer than 0.8.1 so no backward-compatibility
528 //'list' has to be handled differently, as php will not allow a method to be named 'list'
530 $m->connect('api/statusnet/groups/timeline/:id.:format',
531 array('action' => 'ApiTimelineGroup',
532 'id' => '[a-zA-Z0-9]+',
533 'format' => '(xmljson|rss|atom)'));
535 $m->connect('api/statusnet/groups/show.:format',
536 array('action' => 'ApiGroupShow',
537 'format' => '(xml|json)'));
539 $m->connect('api/statusnet/groups/show/:id.:format',
540 array('action' => 'ApiGroupShow',
541 'id' => '[a-zA-Z0-9]+',
542 'format' => '(xml|json)'));
544 $m->connect('api/statusnet/groups/join.:format',
545 array('action' => 'ApiGroupJoin',
546 'id' => '[a-zA-Z0-9]+',
547 'format' => '(xml|json)'));
549 $m->connect('api/statusnet/groups/join/:id.:format',
550 array('action' => 'ApiGroupJoin',
551 'format' => '(xml|json)'));
553 $m->connect('api/statusnet/groups/leave.:format',
554 array('action' => 'ApiGroupLeave',
555 'id' => '[a-zA-Z0-9]+',
556 'format' => '(xml|json)'));
558 $m->connect('api/statusnet/groups/leave/:id.:format',
559 array('action' => 'ApiGroupLeave',
560 'format' => '(xml|json)'));
562 $m->connect('api/statusnet/groups/is_member.:format',
563 array('action' => 'ApiGroupIsMember',
564 'format' => '(xml|json)'));
566 $m->connect('api/statusnet/groups/list.:format',
567 array('action' => 'ApiGroupList',
568 'format' => '(xml|json|rss|atom)'));
570 $m->connect('api/statusnet/groups/list/:id.:format',
571 array('action' => 'ApiGroupList',
572 'id' => '[a-zA-Z0-9]+',
573 'format' => '(xml|json|rss|atom)'));
575 $m->connect('api/statusnet/groups/list_all.:format',
576 array('action' => 'ApiGroupListAll',
577 'format' => '(xml|json|rss|atom)'));
579 $m->connect('api/statusnet/groups/membership.:format',
580 array('action' => 'ApiGroupMembership',
581 'format' => '(xml|json)'));
583 $m->connect('api/statusnet/groups/membership/:id.:format',
584 array('action' => 'ApiGroupMembership',
585 'id' => '[a-zA-Z0-9]+',
586 'format' => '(xml|json)'));
588 $m->connect('api/statusnet/groups/create.:format',
589 array('action' => 'ApiGroupCreate',
590 'format' => '(xml|json)'));
592 $m->connect('api/statusnet/tags/timeline/:tag.:format',
593 array('action' => 'ApiTimelineTag',
594 'format' => '(xmljson|rss|atom)'));
597 $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
598 $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
599 $m->connect('api/trends.json', array('action' => 'twitapitrends'));
601 $m->connect('admin/site', array('action' => 'siteadminpanel'));
602 $m->connect('admin/design', array('action' => 'designadminpanel'));
603 $m->connect('admin/user', array('action' => 'useradminpanel'));
604 $m->connect('admin/paths', array('action' => 'pathsadminpanel'));
606 $m->connect('getfile/:filename',
607 array('action' => 'getfile'),
608 array('filename' => '[A-Za-z0-9._-]+'));
612 foreach (array('subscriptions', 'subscribers',
613 'nudge', 'all', 'foaf', 'xrds',
614 'replies', 'inbox', 'outbox', 'microsummary') as $a) {
615 $m->connect(':nickname/'.$a,
616 array('action' => $a),
617 array('nickname' => '[a-zA-Z0-9]{1,64}'));
620 foreach (array('subscriptions', 'subscribers') as $a) {
621 $m->connect(':nickname/'.$a.'/:tag',
622 array('action' => $a),
623 array('tag' => '[a-zA-Z0-9]+',
624 'nickname' => '[a-zA-Z0-9]{1,64}'));
627 foreach (array('rss', 'groups') as $a) {
628 $m->connect(':nickname/'.$a,
629 array('action' => 'user'.$a),
630 array('nickname' => '[a-zA-Z0-9]{1,64}'));
633 foreach (array('all', 'replies', 'favorites') as $a) {
634 $m->connect(':nickname/'.$a.'/rss',
635 array('action' => $a.'rss'),
636 array('nickname' => '[a-zA-Z0-9]{1,64}'));
639 $m->connect(':nickname/favorites',
640 array('action' => 'showfavorites'),
641 array('nickname' => '[a-zA-Z0-9]{1,64}'));
643 $m->connect(':nickname/avatar/:size',
644 array('action' => 'avatarbynickname'),
645 array('size' => '(original|96|48|24)',
646 'nickname' => '[a-zA-Z0-9]{1,64}'));
648 $m->connect(':nickname/tag/:tag/rss',
649 array('action' => 'userrss'),
650 array('nickname' => '[a-zA-Z0-9]{1,64}'),
651 array('tag' => '[a-zA-Z0-9]+'));
653 $m->connect(':nickname/tag/:tag',
654 array('action' => 'showstream'),
655 array('nickname' => '[a-zA-Z0-9]{1,64}'),
656 array('tag' => '[a-zA-Z0-9]+'));
658 $m->connect(':nickname',
659 array('action' => 'showstream'),
660 array('nickname' => '[a-zA-Z0-9]{1,64}'));
662 Event::handle('RouterInitialized', array($m));
671 $match = $this->m->match($path);
672 } catch (Net_URL_Mapper_InvalidException $e) {
673 common_log(LOG_ERR, "Problem getting route for $path - " .
675 $cac = new ClientErrorAction("Page not found.", 404);
682 function build($action, $args=null, $params=null, $fragment=null)
684 $action_arg = array('action' => $action);
687 $args = array_merge($action_arg, $args);
692 $url = $this->m->generate($args, $params, $fragment);
694 // Due to a bug in the Net_URL_Mapper code, the returned URL may
695 // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
696 // repair that here rather than modifying the upstream code...
698 $qpos = strpos($url, '?');
699 if ($qpos !== false) {
700 $url = substr($url, 0, $qpos+1) .
701 str_replace('?', '&', substr($url, $qpos+1));