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();
76 $m->connect('', array('action' => 'public'));
77 $m->connect('rss', array('action' => 'publicrss'));
78 $m->connect('featuredrss', array('action' => 'featuredrss'));
79 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
80 $m->connect('opensearch/people', array('action' => 'opensearch',
82 $m->connect('opensearch/notice', array('action' => 'opensearch',
87 $m->connect('doc/:title', array('action' => 'doc'));
91 $m->connect('twitter/authorization', array('action' => 'twitterauthorization'));
95 $m->connect('facebook', array('action' => 'facebookhome'));
96 $m->connect('facebook/index.php', array('action' => 'facebookhome'));
97 $m->connect('facebook/settings.php', array('action' => 'facebooksettings'));
98 $m->connect('facebook/invite.php', array('action' => 'facebookinvite'));
99 $m->connect('facebook/remove', array('action' => 'facebookremove'));
101 // main stuff is repetitive
103 $main = array('login', 'logout', 'register', 'subscribe',
104 'unsubscribe', 'confirmaddress', 'recoverpassword',
105 'invite', 'favor', 'disfavor', 'sup',
106 'block', 'unblock', 'subedit',
107 'groupblock', 'groupunblock');
109 foreach ($main as $a) {
110 $m->connect('main/'.$a, array('action' => $a));
113 $m->connect('main/sup/:seconds', array('action' => 'sup'),
114 array('seconds' => '[0-9]+'));
116 $m->connect('main/tagother/:id', array('action' => 'tagother'));
118 $m->connect('main/oembed',
119 array('action' => 'oembed'));
123 foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
124 $m->connect('main/'.$c.'/:code', array('action' => $c));
129 $m->connect('main/remote', array('action' => 'remotesubscribe'));
130 $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
132 foreach (Router::$bare as $action) {
133 $m->connect('index.php?action=' . $action, array('action' => $action));
138 foreach (array('profile', 'avatar', 'password', 'im',
139 'email', 'sms', 'twitter', 'userdesign', 'other') as $s) {
140 $m->connect('settings/'.$s, array('action' => $s.'settings'));
145 foreach (array('group', 'people', 'notice') as $s) {
146 $m->connect('search/'.$s, array('action' => $s.'search'));
147 $m->connect('search/'.$s.'?q=:q',
148 array('action' => $s.'search'),
152 // The second of these is needed to make the link work correctly
153 // when inserted into the page. The first is needed to match the
154 // route on the way in. Seems to be another Net_URL_Mapper bug to me.
155 $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
156 $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
159 $m->connect('attachment/:attachment',
160 array('action' => 'attachment'),
161 array('attachment' => '[0-9]+'));
163 $m->connect('attachment/:attachment/ajax',
164 array('action' => 'attachment_ajax'),
165 array('attachment' => '[0-9]+'));
167 $m->connect('attachment/:attachment/thumbnail',
168 array('action' => 'attachment_thumbnail'),
169 array('attachment' => '[0-9]+'));
171 $m->connect('notice/new', array('action' => 'newnotice'));
172 $m->connect('notice/new?replyto=:replyto',
173 array('action' => 'newnotice'),
174 array('replyto' => '[A-Za-z0-9_-]+'));
175 $m->connect('notice/new?replyto=:replyto&inreplyto=:inreplyto',
176 array('action' => 'newnotice'),
177 array('replyto' => '[A-Za-z0-9_-]+'),
178 array('inreplyto' => '[0-9]+'));
180 $m->connect('notice/:notice/file',
181 array('action' => 'file'),
182 array('notice' => '[0-9]+'));
184 $m->connect('notice/:notice',
185 array('action' => 'shownotice'),
186 array('notice' => '[0-9]+'));
187 $m->connect('notice/delete', array('action' => 'deletenotice'));
188 $m->connect('notice/delete/:notice',
189 array('action' => 'deletenotice'),
190 array('notice' => '[0-9]+'));
194 $m->connect('conversation/:id',
195 array('action' => 'conversation'),
196 array('id' => '[0-9]+'));
198 $m->connect('message/new', array('action' => 'newmessage'));
199 $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
200 $m->connect('message/:message',
201 array('action' => 'showmessage'),
202 array('message' => '[0-9]+'));
204 $m->connect('user/:id',
205 array('action' => 'userbyid'),
206 array('id' => '[0-9]+'));
208 $m->connect('tags/', array('action' => 'publictagcloud'));
209 $m->connect('tag/', array('action' => 'publictagcloud'));
210 $m->connect('tags', array('action' => 'publictagcloud'));
211 $m->connect('tag', array('action' => 'publictagcloud'));
212 $m->connect('tag/:tag/rss',
213 array('action' => 'tagrss'),
214 array('tag' => '[a-zA-Z0-9]+'));
215 $m->connect('tag/:tag',
216 array('action' => 'tag'),
217 array('tag' => '[\pL\pN_\-\.]{1,64}'));
219 $m->connect('peopletag/:tag',
220 array('action' => 'peopletag'),
221 array('tag' => '[a-zA-Z0-9]+'));
223 $m->connect('featured/', array('action' => 'featured'));
224 $m->connect('featured', array('action' => 'featured'));
225 $m->connect('favorited/', array('action' => 'favorited'));
226 $m->connect('favorited', array('action' => 'favorited'));
230 $m->connect('group/new', array('action' => 'newgroup'));
232 foreach (array('edit', 'join', 'leave') as $v) {
233 $m->connect('group/:nickname/'.$v,
234 array('action' => $v.'group'),
235 array('nickname' => '[a-zA-Z0-9]+'));
238 foreach (array('members', 'logo', 'rss', 'designsettings') as $n) {
239 $m->connect('group/:nickname/'.$n,
240 array('action' => 'group'.$n),
241 array('nickname' => '[a-zA-Z0-9]+'));
244 $m->connect('group/:nickname/foaf',
245 array('action' => 'foafgroup'),
246 array('nickname' => '[a-zA-Z0-9]+'));
248 $m->connect('group/:nickname/blocked',
249 array('action' => 'blockedfromgroup'),
250 array('nickname' => '[a-zA-Z0-9]+'));
252 $m->connect('group/:nickname/makeadmin',
253 array('action' => 'makeadmin'),
254 array('nickname' => '[a-zA-Z0-9]+'));
256 $m->connect('group/:id/id',
257 array('action' => 'groupbyid'),
258 array('id' => '[0-9]+'));
260 $m->connect('group/:nickname',
261 array('action' => 'showgroup'),
262 array('nickname' => '[a-zA-Z0-9]+'));
264 $m->connect('group/', array('action' => 'groups'));
265 $m->connect('group', array('action' => 'groups'));
266 $m->connect('groups/', array('action' => 'groups'));
267 $m->connect('groups', array('action' => 'groups'));
269 // Twitter-compatible API
273 $m->connect('api/statuses/public_timeline.:format',
274 array('action' => 'ApiTimelinePublic',
275 'format' => '(xml|json|rss|atom)'));
277 $m->connect('api/statuses/friends_timeline.:format',
278 array('action' => 'ApiTimelineFriends',
279 'format' => '(xml|json|rss|atom)'));
281 $m->connect('api/statuses/friends_timeline/:id.:format',
282 array('action' => 'ApiTimelineFriends',
283 'id' => '[a-zA-Z0-9]+',
284 'format' => '(xml|json|rss|atom)'));
285 $m->connect('api/statuses/home_timeline.:format',
286 array('action' => 'ApiTimelineFriends',
287 'format' => '(xml|json|rss|atom)'));
289 $m->connect('api/statuses/home_timeline/:id.:format',
290 array('action' => 'ApiTimelineFriends',
291 'id' => '[a-zA-Z0-9]+',
292 'format' => '(xml|json|rss|atom)'));
294 $m->connect('api/statuses/user_timeline.:format',
295 array('action' => 'ApiTimelineUser',
296 'format' => '(xml|json|rss|atom)'));
298 $m->connect('api/statuses/user_timeline/:id.:format',
299 array('action' => 'ApiTimelineUser',
300 'id' => '[a-zA-Z0-9]+',
301 'format' => '(xml|json|rss|atom)'));
303 $m->connect('api/statuses/mentions.:format',
304 array('action' => 'ApiTimelineMentions',
305 'format' => '(xml|json|rss|atom)'));
307 $m->connect('api/statuses/mentions/:id.:format',
308 array('action' => 'ApiTimelineMentions',
309 'id' => '[a-zA-Z0-9]+',
310 'format' => '(xml|json|rss|atom)'));
312 $m->connect('api/statuses/replies.:format',
313 array('action' => 'ApiTimelineMentions',
314 'format' => '(xml|json|rss|atom)'));
316 $m->connect('api/statuses/replies/:id.:format',
317 array('action' => 'ApiTimelineMentions',
318 'id' => '[a-zA-Z0-9]+',
319 'format' => '(xml|json|rss|atom)'));
321 $m->connect('api/statuses/friends.:format',
322 array('action' => 'ApiUserFriends',
323 'format' => '(xml|json)'));
325 $m->connect('api/statuses/friends/:id.:format',
326 array('action' => 'ApiUserFriends',
327 'id' => '[a-zA-Z0-9]+',
328 'format' => '(xml|json)'));
330 $m->connect('api/statuses/followers.:format',
331 array('action' => 'ApiUserFollowers',
332 'format' => '(xml|json)'));
334 $m->connect('api/statuses/followers/:id.:format',
335 array('action' => 'ApiUserFollowers',
336 'id' => '[a-zA-Z0-9]+',
337 'format' => '(xml|json)'));
339 $m->connect('api/statuses/show.:format',
340 array('action' => 'ApiStatusesShow',
341 'format' => '(xml|json)'));
343 $m->connect('api/statuses/show/:id.:format',
344 array('action' => 'ApiStatusesShow',
346 'format' => '(xml|json)'));
348 $m->connect('api/statuses/update.:format',
349 array('action' => 'ApiStatusesUpdate',
350 'format' => '(xml|json)'));
352 $m->connect('api/statuses/destroy.:format',
353 array('action' => 'ApiStatusesDestroy',
354 'format' => '(xml|json)'));
356 $m->connect('api/statuses/destroy/:id.:format',
357 array('action' => 'ApiStatusesDestroy',
359 'format' => '(xml|json)'));
364 $m->connect('api/users/:method/:argument',
365 array('action' => 'api',
366 'apiaction' => 'users'),
367 array('method' => 'show(\.(xml|json))?'));
369 $m->connect('api/users/:method',
370 array('action' => 'api',
371 'apiaction' => 'users'),
372 array('method' => 'show(\.(xml|json))?'));
376 foreach (array('xml', 'json') as $e) {
377 $m->connect('api/direct_messages/new.'.$e,
378 array('action' => 'api',
379 'apiaction' => 'direct_messages',
380 'method' => 'create.'.$e));
383 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
384 $m->connect('api/direct_messages.'.$e,
385 array('action' => 'api',
386 'apiaction' => 'direct_messages',
387 'method' => 'direct_messages.'.$e));
390 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
391 $m->connect('api/direct_messages/sent.'.$e,
392 array('action' => 'api',
393 'apiaction' => 'direct_messages',
394 'method' => 'sent.'.$e));
397 $m->connect('api/direct_messages/destroy/:argument',
398 array('action' => 'api',
399 'apiaction' => 'direct_messages'));
403 $m->connect('api/friendships/:method/:argument',
404 array('action' => 'api',
405 'apiaction' => 'friendships'),
406 array('method' => '(create|destroy)'));
408 $m->connect('api/friendships/:method',
409 array('action' => 'api',
410 'apiaction' => 'friendships'),
411 array('method' => '(show|exists)(\.(xml|json))'));
415 $m->connect('api/friends/ids/:id.:format',
416 array('action' => 'apiFriends',
417 'ids_only' => true));
419 $m->connect('api/followers/ids/:id.:format',
420 array('action' => 'apiFollowers',
421 'ids_only' => true));
423 $m->connect('api/friends/ids.:format',
424 array('action' => 'apiFriends',
425 'ids_only' => true));
427 $m->connect('api/followers/ids.:format',
428 array('action' => 'apiFollowers',
429 'ids_only' => true));
433 $m->connect('api/account/:method',
434 array('action' => 'api',
435 'apiaction' => 'account'));
439 $m->connect('api/favorites/:method/:argument',
440 array('action' => 'api',
441 'apiaction' => 'favorites',
442 array('method' => '(create|destroy)')));
444 $m->connect('api/favorites/:argument',
445 array('action' => 'api',
446 'apiaction' => 'favorites',
447 'method' => 'favorites'));
449 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
450 $m->connect('api/favorites.'.$e,
451 array('action' => 'api',
452 'apiaction' => 'favorites',
453 'method' => 'favorites.'.$e));
458 $m->connect('api/notifications/:method/:argument',
459 array('action' => 'api',
460 'apiaction' => 'favorites'));
464 $m->connect('api/blocks/:method/:argument',
465 array('action' => 'api',
466 'apiaction' => 'blocks'));
470 $m->connect('api/help/:method',
471 array('action' => 'api',
472 'apiaction' => 'help'));
476 $m->connect('api/statusnet/:method',
477 array('action' => 'api',
478 'apiaction' => 'statusnet'));
480 // For older methods, we provide "laconica" base action
482 $m->connect('api/laconica/:method',
483 array('action' => 'api',
484 'apiaction' => 'statusnet'));
486 // Groups and tags are newer than 0.8.1 so no backward-compatibility
490 //'list' has to be handled differently, as php will not allow a method to be named 'list'
491 $m->connect('api/statusnet/groups/list/:argument',
492 array('action' => 'api',
493 'method' => 'list_groups',
494 'apiaction' => 'groups'));
496 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
497 $m->connect('api/statusnet/groups/list.' . $e,
498 array('action' => 'api',
499 'method' => 'list_groups.' . $e,
500 'apiaction' => 'groups'));
503 $m->connect('api/statusnet/groups/:method',
504 array('action' => 'api',
505 'apiaction' => 'statuses'),
506 array('method' => '(list_all|)(\.(atom|rss|xml|json))?'));
508 $m->connect('api/statuses/:method/:argument',
509 array('action' => 'api',
510 'apiaction' => 'statuses'),
511 array('method' => '(user_timeline|home_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
513 $m->connect('api/statusnet/groups/:method/:argument',
514 array('action' => 'api',
515 'apiaction' => 'groups'));
517 $m->connect('api/statusnet/groups/:method',
518 array('action' => 'api',
519 'apiaction' => 'groups'));
522 $m->connect('api/statusnet/tags/:method/:argument',
523 array('action' => 'api',
524 'apiaction' => 'tags'));
526 $m->connect('api/statusnet/tags/:method',
527 array('action' => 'api',
528 'apiaction' => 'tags'));
531 $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
532 $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
533 $m->connect('api/trends.json', array('action' => 'twitapitrends'));
537 foreach (array('subscriptions', 'subscribers',
538 'nudge', 'all', 'foaf', 'xrds',
539 'replies', 'inbox', 'outbox', 'microsummary') as $a) {
540 $m->connect(':nickname/'.$a,
541 array('action' => $a),
542 array('nickname' => '[a-zA-Z0-9]{1,64}'));
545 foreach (array('subscriptions', 'subscribers') as $a) {
546 $m->connect(':nickname/'.$a.'/:tag',
547 array('action' => $a),
548 array('tag' => '[a-zA-Z0-9]+',
549 'nickname' => '[a-zA-Z0-9]{1,64}'));
552 foreach (array('rss', 'groups') as $a) {
553 $m->connect(':nickname/'.$a,
554 array('action' => 'user'.$a),
555 array('nickname' => '[a-zA-Z0-9]{1,64}'));
558 foreach (array('all', 'replies', 'favorites') as $a) {
559 $m->connect(':nickname/'.$a.'/rss',
560 array('action' => $a.'rss'),
561 array('nickname' => '[a-zA-Z0-9]{1,64}'));
564 $m->connect(':nickname/favorites',
565 array('action' => 'showfavorites'),
566 array('nickname' => '[a-zA-Z0-9]{1,64}'));
568 $m->connect(':nickname/avatar/:size',
569 array('action' => 'avatarbynickname'),
570 array('size' => '(original|96|48|24)',
571 'nickname' => '[a-zA-Z0-9]{1,64}'));
573 $m->connect(':nickname/tag/:tag/rss',
574 array('action' => 'userrss'),
575 array('nickname' => '[a-zA-Z0-9]{1,64}'),
576 array('tag' => '[a-zA-Z0-9]+'));
578 $m->connect(':nickname/tag/:tag',
579 array('action' => 'showstream'),
580 array('nickname' => '[a-zA-Z0-9]{1,64}'),
581 array('tag' => '[a-zA-Z0-9]+'));
583 $m->connect(':nickname',
584 array('action' => 'showstream'),
585 array('nickname' => '[a-zA-Z0-9]{1,64}'));
587 Event::handle('RouterInitialized', array($m));
595 $match = $this->m->match($path);
596 } catch (Net_URL_Mapper_InvalidException $e) {
597 common_log(LOG_ERR, "Problem getting route for $path - " .
599 $cac = new ClientErrorAction("Page not found.", 404);
606 function build($action, $args=null, $params=null, $fragment=null)
608 $action_arg = array('action' => $action);
611 $args = array_merge($action_arg, $args);
616 $url = $this->m->generate($args, $params, $fragment);
618 // Due to a bug in the Net_URL_Mapper code, the returned URL may
619 // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
620 // repair that here rather than modifying the upstream code...
622 $qpos = strpos($url, '?');
623 if ($qpos !== false) {
624 $url = substr($url, 0, $qpos+1) .
625 str_replace('?', '&', substr($url, $qpos+1));