lib/router.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * URL routing utilities
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  URL
  23  * @package   StatusNet
  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/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once 'Net/URL/Mapper.php';
  35
  36 /**
  37  * URL Router
  38  *
  39  * Cheap wrapper around Net_URL_Mapper
  40  *
  41  * @category URL
  42  * @package  StatusNet
  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/
  46  */
  47
  48 class Router
  49 {
  50     var $m = null;
  51     static $inst = null;
  52     static $bare = array('requesttoken', 'accesstoken', 'userauthorization',
  53                          'postnotice', 'updateprofile', 'finishremotesubscribe');
  54
  55     static function get()
  56     {
  57         if (!Router::$inst) {
  58             Router::$inst = new Router();
  59         }
  60         return Router::$inst;
  61     }
  62
  63     function __construct()
  64     {
  65         if (!$this->m) {
  66             $this->m = $this->initialize();
  67         }
  68     }
  69
  70     function initialize()
  71     {
  72         $m = Net_URL_Mapper::getInstance();
  73
  74         // In the "root"
  75
  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',
  81                                                'type' => 'people'));
  82         $m->connect('opensearch/notice', array('action' => 'opensearch',
  83                                                'type' => 'notice'));
  84
  85         // docs
  86
  87         $m->connect('doc/:title', array('action' => 'doc'));
  88
  89         // Twitter
  90
  91         $m->connect('twitter/authorization', array('action' => 'twitterauthorization'));
  92
  93         // facebook
  94
  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'));
 100
 101         // main stuff is repetitive
 102
 103         $main = array('login', 'logout', 'register', 'subscribe',
 104                       'unsubscribe', 'confirmaddress', 'recoverpassword',
 105                       'invite', 'favor', 'disfavor', 'sup',
 106                       'block', 'unblock', 'subedit',
 107                       'groupblock', 'groupunblock');
 108
 109         foreach ($main as $a) {
 110             $m->connect('main/'.$a, array('action' => $a));
 111         }
 112
 113         $m->connect('main/sup/:seconds', array('action' => 'sup'),
 114                     array('seconds' => '[0-9]+'));
 115
 116         $m->connect('main/tagother/:id', array('action' => 'tagother'));
 117
 118         $m->connect('main/oembed',
 119                     array('action' => 'oembed'));
 120
 121         // these take a code
 122
 123         foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
 124             $m->connect('main/'.$c.'/:code', array('action' => $c));
 125         }
 126
 127         // exceptional
 128
 129         $m->connect('main/remote', array('action' => 'remotesubscribe'));
 130         $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
 131
 132         foreach (Router::$bare as $action) {
 133             $m->connect('index.php?action=' . $action, array('action' => $action));
 134         }
 135
 136         // settings
 137
 138         foreach (array('profile', 'avatar', 'password', 'im',
 139                        'email', 'sms', 'twitter', 'userdesign', 'other') as $s) {
 140             $m->connect('settings/'.$s, array('action' => $s.'settings'));
 141         }
 142
 143         // search
 144
 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'),
 149                         array('q' => '.+'));
 150         }
 151
 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'),
 157                     array('q' => '.+'));
 158
 159         $m->connect('attachment/:attachment',
 160                     array('action' => 'attachment'),
 161                     array('attachment' => '[0-9]+'));
 162
 163         $m->connect('attachment/:attachment/ajax',
 164                     array('action' => 'attachment_ajax'),
 165                     array('attachment' => '[0-9]+'));
 166
 167         $m->connect('attachment/:attachment/thumbnail',
 168                     array('action' => 'attachment_thumbnail'),
 169                     array('attachment' => '[0-9]+'));
 170
 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]+'));
 179
 180         $m->connect('notice/:notice/file',
 181             array('action' => 'file'),
 182             array('notice' => '[0-9]+'));
 183
 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]+'));
 191
 192         // conversation
 193
 194         $m->connect('conversation/:id',
 195                     array('action' => 'conversation'),
 196                     array('id' => '[0-9]+'));
 197
 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]+'));
 203
 204         $m->connect('user/:id',
 205                     array('action' => 'userbyid'),
 206                     array('id' => '[0-9]+'));
 207
 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}'));
 218
 219         $m->connect('peopletag/:tag',
 220                     array('action' => 'peopletag'),
 221                     array('tag' => '[a-zA-Z0-9]+'));
 222
 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'));
 227
 228         // groups
 229
 230         $m->connect('group/new', array('action' => 'newgroup'));
 231
 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]+'));
 236         }
 237
 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]+'));
 242         }
 243
 244         $m->connect('group/:nickname/blocked',
 245                     array('action' => 'blockedfromgroup'),
 246                     array('nickname' => '[a-zA-Z0-9]+'));
 247
 248         $m->connect('group/:nickname/makeadmin',
 249                     array('action' => 'makeadmin'),
 250                     array('nickname' => '[a-zA-Z0-9]+'));
 251
 252         $m->connect('group/:id/id',
 253                     array('action' => 'groupbyid'),
 254                     array('id' => '[0-9]+'));
 255
 256         $m->connect('group/:nickname',
 257                     array('action' => 'showgroup'),
 258                     array('nickname' => '[a-zA-Z0-9]+'));
 259
 260         $m->connect('group/', array('action' => 'groups'));
 261         $m->connect('group', array('action' => 'groups'));
 262         $m->connect('groups/', array('action' => 'groups'));
 263         $m->connect('groups', array('action' => 'groups'));
 264
 265         // Twitter-compatible API
 266
 267         // statuses API
 268
 269         $m->connect('api/statuses/public_timeline.:format',
 270                     array('action' => 'ApiPublicTimeline',
 271                     'format' => '(xml|json|rss|atom)'));
 272
 273         $m->connect('api/statuses/friends_timeline.:format',
 274                     array('action' => 'ApiFriendsTimeline',
 275                           'format' => '(xml|json|rss|atom)'));
 276
 277         $m->connect('api/statuses/friends_timeline/:id.:format',
 278                     array('action' => 'ApiFriendsTimeline',
 279                           'id' => '[a-zA-Z0-9]+',
 280                           'format' => '(xml|json|rss|atom)'));
 281
 282         $m->connect('api/statuses/user_timeline.:format',
 283                     array('action' => 'ApiUserTimeline',
 284                     'format' => '(xml|json|rss|atom)'));
 285
 286         $m->connect('api/statuses/user_timeline/:id.:format',
 287                     array('action' => 'ApiUserTimeline',
 288                     'id' => '[a-zA-Z0-9]+',
 289                     'format' => '(xml|json|rss|atom)'));
 290
 291         $m->connect('api/statuses/mentions.:format',
 292                     array('action' => 'ApiMentions',
 293                     'format' => '(xml|json|rss|atom)'));
 294
 295         $m->connect('api/statuses/mentions/:id.:format',
 296                     array('action' => 'ApiMentions',
 297                     'id' => '[a-zA-Z0-9]+',
 298                     'format' => '(xml|json|rss|atom)'));
 299
 300         $m->connect('api/statuses/home_timeline',
 301                     array('action' => 'apifriendstimeline'));
 302
 303         $m->connect('api/statuses/:method',
 304                     array('action' => 'api',
 305                           'apiaction' => 'statuses'),
 306                     array('method' => '(update|replies|show|friends|followers|featured)(\.(atom|rss|xml|json))?'));
 307
 308         $m->connect('api/statuses/:method/:argument',
 309                     array('action' => 'api',
 310                           'apiaction' => 'statuses'),
 311                     array('method' => '(replies|show|destroy|friends|followers)'));
 312
 313         // users
 314
 315         $m->connect('api/users/:method/:argument',
 316                     array('action' => 'api',
 317                           'apiaction' => 'users'),
 318                     array('method' => 'show(\.(xml|json))?'));
 319
 320         $m->connect('api/users/:method',
 321                     array('action' => 'api',
 322                           'apiaction' => 'users'),
 323                     array('method' => 'show(\.(xml|json))?'));
 324
 325         // direct messages
 326
 327         foreach (array('xml', 'json') as $e) {
 328             $m->connect('api/direct_messages/new.'.$e,
 329                         array('action' => 'api',
 330                               'apiaction' => 'direct_messages',
 331                               'method' => 'create.'.$e));
 332         }
 333
 334         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 335             $m->connect('api/direct_messages.'.$e,
 336                         array('action' => 'api',
 337                               'apiaction' => 'direct_messages',
 338                               'method' => 'direct_messages.'.$e));
 339         }
 340
 341         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 342             $m->connect('api/direct_messages/sent.'.$e,
 343                         array('action' => 'api',
 344                               'apiaction' => 'direct_messages',
 345                               'method' => 'sent.'.$e));
 346         }
 347
 348         $m->connect('api/direct_messages/destroy/:argument',
 349                     array('action' => 'api',
 350                           'apiaction' => 'direct_messages'));
 351
 352         // friendships
 353
 354         $m->connect('api/friendships/:method/:argument',
 355                     array('action' => 'api',
 356                           'apiaction' => 'friendships'),
 357                     array('method' => '(create|destroy)'));
 358
 359         $m->connect('api/friendships/:method',
 360                     array('action' => 'api',
 361                           'apiaction' => 'friendships'),
 362                     array('method' => '(show|exists)(\.(xml|json))'));
 363
 364         // Social graph
 365
 366         $m->connect('api/friends/ids/:argument',
 367                     array('action' => 'api',
 368                           'apiaction' => 'statuses',
 369                           'method' => 'friendsIDs'));
 370
 371         foreach (array('xml', 'json') as $e) {
 372             $m->connect('api/friends/ids.'.$e,
 373                         array('action' => 'api',
 374                               'apiaction' => 'statuses',
 375                               'method' => 'friendsIDs.'.$e));
 376         }
 377
 378         $m->connect('api/followers/ids/:argument',
 379                     array('action' => 'api',
 380                           'apiaction' => 'statuses',
 381                           'method' => 'followersIDs'));
 382
 383         foreach (array('xml', 'json') as $e) {
 384             $m->connect('api/followers/ids.'.$e,
 385                         array('action' => 'api',
 386                               'apiaction' => 'statuses',
 387                               'method' => 'followersIDs.'.$e));
 388         }
 389
 390         // account
 391
 392         $m->connect('api/account/:method',
 393                     array('action' => 'api',
 394                           'apiaction' => 'account'));
 395
 396         // favorites
 397
 398         $m->connect('api/favorites/:method/:argument',
 399                     array('action' => 'api',
 400                           'apiaction' => 'favorites',
 401                           array('method' => '(create|destroy)')));
 402
 403         $m->connect('api/favorites/:argument',
 404                     array('action' => 'api',
 405                           'apiaction' => 'favorites',
 406                           'method' => 'favorites'));
 407
 408         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 409             $m->connect('api/favorites.'.$e,
 410                         array('action' => 'api',
 411                               'apiaction' => 'favorites',
 412                               'method' => 'favorites.'.$e));
 413         }
 414
 415         // notifications
 416
 417         $m->connect('api/notifications/:method/:argument',
 418                     array('action' => 'api',
 419                           'apiaction' => 'favorites'));
 420
 421         // blocks
 422
 423         $m->connect('api/blocks/:method/:argument',
 424                     array('action' => 'api',
 425                           'apiaction' => 'blocks'));
 426
 427         // help
 428
 429         $m->connect('api/help/:method',
 430                     array('action' => 'api',
 431                           'apiaction' => 'help'));
 432
 433         // statusnet
 434
 435         $m->connect('api/statusnet/:method',
 436                     array('action' => 'api',
 437                           'apiaction' => 'statusnet'));
 438
 439         // For older methods, we provide "laconica" base action
 440
 441         $m->connect('api/laconica/:method',
 442                     array('action' => 'api',
 443                           'apiaction' => 'statusnet'));
 444
 445         // Groups and tags are newer than 0.8.1 so no backward-compatibility
 446         // necessary
 447
 448         // Groups
 449         //'list' has to be handled differently, as php will not allow a method to be named 'list'
 450         $m->connect('api/statusnet/groups/list/:argument',
 451                     array('action' => 'api',
 452                           'method' => 'list_groups',
 453                           'apiaction' => 'groups'));
 454
 455         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 456             $m->connect('api/statusnet/groups/list.' . $e,
 457                     array('action' => 'api',
 458                           'method' => 'list_groups.' . $e,
 459                           'apiaction' => 'groups'));
 460         }
 461
 462         $m->connect('api/statusnet/groups/:method',
 463                     array('action' => 'api',
 464                           'apiaction' => 'statuses'),
 465                     array('method' => '(list_all|)(\.(atom|rss|xml|json))?'));
 466
 467         $m->connect('api/statuses/:method/:argument',
 468                     array('action' => 'api',
 469                           'apiaction' => 'statuses'),
 470                     array('method' => '(user_timeline|home_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
 471
 472         $m->connect('api/statusnet/groups/:method/:argument',
 473                     array('action' => 'api',
 474                           'apiaction' => 'groups'));
 475
 476         $m->connect('api/statusnet/groups/:method',
 477                     array('action' => 'api',
 478                           'apiaction' => 'groups'));
 479
 480         // Tags
 481         $m->connect('api/statusnet/tags/:method/:argument',
 482                     array('action' => 'api',
 483                           'apiaction' => 'tags'));
 484
 485         $m->connect('api/statusnet/tags/:method',
 486                     array('action' => 'api',
 487                           'apiaction' => 'tags'));
 488
 489         // search
 490         $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
 491         $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
 492         $m->connect('api/trends.json', array('action' => 'twitapitrends'));
 493
 494         // user stuff
 495
 496         foreach (array('subscriptions', 'subscribers',
 497                        'nudge', 'all', 'foaf', 'xrds',
 498                        'replies', 'inbox', 'outbox', 'microsummary') as $a) {
 499             $m->connect(':nickname/'.$a,
 500                         array('action' => $a),
 501                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 502         }
 503
 504         foreach (array('subscriptions', 'subscribers') as $a) {
 505             $m->connect(':nickname/'.$a.'/:tag',
 506                         array('action' => $a),
 507                         array('tag' => '[a-zA-Z0-9]+',
 508                               'nickname' => '[a-zA-Z0-9]{1,64}'));
 509         }
 510
 511         foreach (array('rss', 'groups') as $a) {
 512             $m->connect(':nickname/'.$a,
 513                         array('action' => 'user'.$a),
 514                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 515         }
 516
 517         foreach (array('all', 'replies', 'favorites') as $a) {
 518             $m->connect(':nickname/'.$a.'/rss',
 519                         array('action' => $a.'rss'),
 520                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 521         }
 522
 523         $m->connect(':nickname/favorites',
 524                     array('action' => 'showfavorites'),
 525                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 526
 527         $m->connect(':nickname/avatar/:size',
 528                     array('action' => 'avatarbynickname'),
 529                     array('size' => '(original|96|48|24)',
 530                           'nickname' => '[a-zA-Z0-9]{1,64}'));
 531
 532         $m->connect(':nickname/tag/:tag/rss',
 533             array('action' => 'userrss'),
 534             array('nickname' => '[a-zA-Z0-9]{1,64}'),
 535             array('tag' => '[a-zA-Z0-9]+'));
 536
 537         $m->connect(':nickname/tag/:tag',
 538                     array('action' => 'showstream'),
 539                     array('nickname' => '[a-zA-Z0-9]{1,64}'),
 540                     array('tag' => '[a-zA-Z0-9]+'));
 541
 542         $m->connect(':nickname',
 543                     array('action' => 'showstream'),
 544                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 545
 546         Event::handle('RouterInitialized', array($m));
 547
 548         return $m;
 549     }
 550
 551     function map($path)
 552     {
 553         try {
 554             $match = $this->m->match($path);
 555         } catch (Net_URL_Mapper_InvalidException $e) {
 556             common_log(LOG_ERR, "Problem getting route for $path - " .
 557                        $e->getMessage());
 558             $cac = new ClientErrorAction("Page not found.", 404);
 559             $cac->showPage();
 560         }
 561
 562         return $match;
 563     }
 564
 565     function build($action, $args=null, $params=null, $fragment=null)
 566     {
 567         $action_arg = array('action' => $action);
 568
 569         if ($args) {
 570             $args = array_merge($action_arg, $args);
 571         } else {
 572             $args = $action_arg;
 573         }
 574
 575         $url = $this->m->generate($args, $params, $fragment);
 576
 577         // Due to a bug in the Net_URL_Mapper code, the returned URL may
 578         // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
 579         // repair that here rather than modifying the upstream code...
 580
 581         $qpos = strpos($url, '?');
 582         if ($qpos !== false) {
 583             $url = substr($url, 0, $qpos+1) .
 584               str_replace('?', '&', substr($url, $qpos+1));
 585         }
 586         return $url;
 587     }
 588 }