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
 176         $m->connect('notice/:notice/file',
 177             array('action' => 'file'),
 178             array('notice' => '[0-9]+'));
 179
 180         $m->connect('notice/:notice',
 181                     array('action' => 'shownotice'),
 182                     array('notice' => '[0-9]+'));
 183         $m->connect('notice/delete', array('action' => 'deletenotice'));
 184         $m->connect('notice/delete/:notice',
 185                     array('action' => 'deletenotice'),
 186                     array('notice' => '[0-9]+'));
 187
 188         // conversation
 189
 190         $m->connect('conversation/:id',
 191                     array('action' => 'conversation'),
 192                     array('id' => '[0-9]+'));
 193
 194         $m->connect('message/new', array('action' => 'newmessage'));
 195         $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
 196         $m->connect('message/:message',
 197                     array('action' => 'showmessage'),
 198                     array('message' => '[0-9]+'));
 199
 200         $m->connect('user/:id',
 201                     array('action' => 'userbyid'),
 202                     array('id' => '[0-9]+'));
 203
 204         $m->connect('tags/', array('action' => 'publictagcloud'));
 205         $m->connect('tag/', array('action' => 'publictagcloud'));
 206         $m->connect('tags', array('action' => 'publictagcloud'));
 207         $m->connect('tag', array('action' => 'publictagcloud'));
 208         $m->connect('tag/:tag/rss',
 209                     array('action' => 'tagrss'),
 210                     array('tag' => '[a-zA-Z0-9]+'));
 211         $m->connect('tag/:tag',
 212                     array('action' => 'tag'),
 213                     array('tag' => '[\pL\pN_\-\.]{1,64}'));
 214
 215         $m->connect('peopletag/:tag',
 216                     array('action' => 'peopletag'),
 217                     array('tag' => '[a-zA-Z0-9]+'));
 218
 219         $m->connect('featured/', array('action' => 'featured'));
 220         $m->connect('featured', array('action' => 'featured'));
 221         $m->connect('favorited/', array('action' => 'favorited'));
 222         $m->connect('favorited', array('action' => 'favorited'));
 223
 224         // groups
 225
 226         $m->connect('group/new', array('action' => 'newgroup'));
 227
 228         foreach (array('edit', 'join', 'leave') as $v) {
 229             $m->connect('group/:nickname/'.$v,
 230                         array('action' => $v.'group'),
 231                         array('nickname' => '[a-zA-Z0-9]+'));
 232         }
 233
 234         foreach (array('members', 'logo', 'rss', 'designsettings') as $n) {
 235             $m->connect('group/:nickname/'.$n,
 236                         array('action' => 'group'.$n),
 237                         array('nickname' => '[a-zA-Z0-9]+'));
 238         }
 239
 240         $m->connect('group/:nickname/blocked',
 241                     array('action' => 'blockedfromgroup'),
 242                     array('nickname' => '[a-zA-Z0-9]+'));
 243
 244         $m->connect('group/:nickname/makeadmin',
 245                     array('action' => 'makeadmin'),
 246                     array('nickname' => '[a-zA-Z0-9]+'));
 247
 248         $m->connect('group/:id/id',
 249                     array('action' => 'groupbyid'),
 250                     array('id' => '[0-9]+'));
 251
 252         $m->connect('group/:nickname',
 253                     array('action' => 'showgroup'),
 254                     array('nickname' => '[a-zA-Z0-9]+'));
 255
 256         $m->connect('group/', array('action' => 'groups'));
 257         $m->connect('group', array('action' => 'groups'));
 258         $m->connect('groups/', array('action' => 'groups'));
 259         $m->connect('groups', array('action' => 'groups'));
 260
 261         // Twitter-compatible API
 262
 263         // statuses API
 264
 265         $m->connect('api/statuses/:method',
 266                     array('action' => 'api',
 267                           'apiaction' => 'statuses'),
 268                     array('method' => '(public_timeline|home_timeline|friends_timeline|user_timeline|update|replies|mentions|show|friends|followers|featured)(\.(atom|rss|xml|json))?'));
 269
 270         $m->connect('api/statuses/:method/:argument',
 271                     array('action' => 'api',
 272                           'apiaction' => 'statuses'),
 273                     array('method' => '(user_timeline|home_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
 274
 275         // users
 276
 277         $m->connect('api/users/:method/:argument',
 278                     array('action' => 'api',
 279                           'apiaction' => 'users'),
 280                     array('method' => 'show(\.(xml|json))?'));
 281
 282         $m->connect('api/users/:method',
 283                     array('action' => 'api',
 284                           'apiaction' => 'users'),
 285                     array('method' => 'show(\.(xml|json))?'));
 286
 287         // direct messages
 288
 289         foreach (array('xml', 'json') as $e) {
 290             $m->connect('api/direct_messages/new.'.$e,
 291                         array('action' => 'api',
 292                               'apiaction' => 'direct_messages',
 293                               'method' => 'create.'.$e));
 294         }
 295
 296         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 297             $m->connect('api/direct_messages.'.$e,
 298                         array('action' => 'api',
 299                               'apiaction' => 'direct_messages',
 300                               'method' => 'direct_messages.'.$e));
 301         }
 302
 303         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 304             $m->connect('api/direct_messages/sent.'.$e,
 305                         array('action' => 'api',
 306                               'apiaction' => 'direct_messages',
 307                               'method' => 'sent.'.$e));
 308         }
 309
 310         $m->connect('api/direct_messages/destroy/:argument',
 311                     array('action' => 'api',
 312                           'apiaction' => 'direct_messages'));
 313
 314         // friendships
 315
 316         $m->connect('api/friendships/:method/:argument',
 317                     array('action' => 'api',
 318                           'apiaction' => 'friendships'),
 319                     array('method' => '(create|destroy)'));
 320
 321         $m->connect('api/friendships/:method',
 322                     array('action' => 'api',
 323                           'apiaction' => 'friendships'),
 324                     array('method' => '(show|exists)(\.(xml|json))'));
 325
 326         // Social graph
 327
 328         $m->connect('api/friends/ids/:argument',
 329                     array('action' => 'api',
 330                           'apiaction' => 'statuses',
 331                           'method' => 'friendsIDs'));
 332
 333         foreach (array('xml', 'json') as $e) {
 334             $m->connect('api/friends/ids.'.$e,
 335                         array('action' => 'api',
 336                               'apiaction' => 'statuses',
 337                               'method' => 'friendsIDs.'.$e));
 338         }
 339
 340         $m->connect('api/followers/ids/:argument',
 341                     array('action' => 'api',
 342                           'apiaction' => 'statuses',
 343                           'method' => 'followersIDs'));
 344
 345         foreach (array('xml', 'json') as $e) {
 346             $m->connect('api/followers/ids.'.$e,
 347                         array('action' => 'api',
 348                               'apiaction' => 'statuses',
 349                               'method' => 'followersIDs.'.$e));
 350         }
 351
 352         // account
 353
 354         $m->connect('api/account/:method',
 355                     array('action' => 'api',
 356                           'apiaction' => 'account'));
 357
 358         // favorites
 359
 360         $m->connect('api/favorites/:method/:argument',
 361                     array('action' => 'api',
 362                           'apiaction' => 'favorites',
 363                           array('method' => '(create|destroy)')));
 364
 365         $m->connect('api/favorites/:argument',
 366                     array('action' => 'api',
 367                           'apiaction' => 'favorites',
 368                           'method' => 'favorites'));
 369
 370         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 371             $m->connect('api/favorites.'.$e,
 372                         array('action' => 'api',
 373                               'apiaction' => 'favorites',
 374                               'method' => 'favorites.'.$e));
 375         }
 376
 377         // notifications
 378
 379         $m->connect('api/notifications/:method/:argument',
 380                     array('action' => 'api',
 381                           'apiaction' => 'favorites'));
 382
 383         // blocks
 384
 385         $m->connect('api/blocks/:method/:argument',
 386                     array('action' => 'api',
 387                           'apiaction' => 'blocks'));
 388
 389         // help
 390
 391         $m->connect('api/help/:method',
 392                     array('action' => 'api',
 393                           'apiaction' => 'help'));
 394
 395         // statusnet
 396
 397         $m->connect('api/statusnet/:method',
 398                     array('action' => 'api',
 399                           'apiaction' => 'statusnet'));
 400
 401         // For older methods, we provide "laconica" base action
 402
 403         $m->connect('api/laconica/:method',
 404                     array('action' => 'api',
 405                           'apiaction' => 'statusnet'));
 406
 407         // Groups and tags are newer than 0.8.1 so no backward-compatibility
 408         // necessary
 409
 410         // Groups
 411         //'list' has to be handled differently, as php will not allow a method to be named 'list'
 412         $m->connect('api/statusnet/groups/list/:argument',
 413                     array('action' => 'api',
 414                           'method' => 'list_groups',
 415                           'apiaction' => 'groups'));
 416
 417         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 418             $m->connect('api/statusnet/groups/list.' . $e,
 419                     array('action' => 'api',
 420                           'method' => 'list_groups.' . $e,
 421                           'apiaction' => 'groups'));
 422         }
 423
 424         $m->connect('api/statusnet/groups/:method',
 425                     array('action' => 'api',
 426                           'apiaction' => 'statuses'),
 427                     array('method' => '(list_all|)(\.(atom|rss|xml|json))?'));
 428
 429         $m->connect('api/statuses/:method/:argument',
 430                     array('action' => 'api',
 431                           'apiaction' => 'statuses'),
 432                     array('method' => '(user_timeline|home_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
 433
 434         $m->connect('api/statusnet/groups/:method/:argument',
 435                     array('action' => 'api',
 436                           'apiaction' => 'groups'));
 437
 438         $m->connect('api/statusnet/groups/:method',
 439                     array('action' => 'api',
 440                           'apiaction' => 'groups'));
 441
 442         // Tags
 443         $m->connect('api/statusnet/tags/:method/:argument',
 444                     array('action' => 'api',
 445                           'apiaction' => 'tags'));
 446
 447         $m->connect('api/statusnet/tags/:method',
 448                     array('action' => 'api',
 449                           'apiaction' => 'tags'));
 450
 451         // search
 452         $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
 453         $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
 454         $m->connect('api/trends.json', array('action' => 'twitapitrends'));
 455
 456         // user stuff
 457
 458         foreach (array('subscriptions', 'subscribers',
 459                        'nudge', 'all', 'foaf', 'xrds',
 460                        'replies', 'inbox', 'outbox', 'microsummary') as $a) {
 461             $m->connect(':nickname/'.$a,
 462                         array('action' => $a),
 463                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 464         }
 465
 466         foreach (array('subscriptions', 'subscribers') as $a) {
 467             $m->connect(':nickname/'.$a.'/:tag',
 468                         array('action' => $a),
 469                         array('tag' => '[a-zA-Z0-9]+',
 470                               'nickname' => '[a-zA-Z0-9]{1,64}'));
 471         }
 472
 473         foreach (array('rss', 'groups') as $a) {
 474             $m->connect(':nickname/'.$a,
 475                         array('action' => 'user'.$a),
 476                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 477         }
 478
 479         foreach (array('all', 'replies', 'favorites') as $a) {
 480             $m->connect(':nickname/'.$a.'/rss',
 481                         array('action' => $a.'rss'),
 482                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 483         }
 484
 485         $m->connect(':nickname/favorites',
 486                     array('action' => 'showfavorites'),
 487                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 488
 489         $m->connect(':nickname/avatar/:size',
 490                     array('action' => 'avatarbynickname'),
 491                     array('size' => '(original|96|48|24)',
 492                           'nickname' => '[a-zA-Z0-9]{1,64}'));
 493
 494         $m->connect(':nickname/tag/:tag/rss',
 495             array('action' => 'userrss'),
 496             array('nickname' => '[a-zA-Z0-9]{1,64}'),
 497             array('tag' => '[a-zA-Z0-9]+'));
 498
 499         $m->connect(':nickname/tag/:tag',
 500                     array('action' => 'showstream'),
 501                     array('nickname' => '[a-zA-Z0-9]{1,64}'),
 502                     array('tag' => '[a-zA-Z0-9]+'));
 503
 504         $m->connect(':nickname',
 505                     array('action' => 'showstream'),
 506                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 507
 508         Event::handle('RouterInitialized', array($m));
 509
 510         return $m;
 511     }
 512
 513     function map($path)
 514     {
 515         try {
 516             $match = $this->m->match($path);
 517         } catch (Net_URL_Mapper_InvalidException $e) {
 518             common_log(LOG_ERR, "Problem getting route for $path - " .
 519                        $e->getMessage());
 520             $cac = new ClientErrorAction("Page not found.", 404);
 521             $cac->showPage();
 522         }
 523
 524         return $match;
 525     }
 526
 527     function build($action, $args=null, $params=null, $fragment=null)
 528     {
 529         $action_arg = array('action' => $action);
 530
 531         if ($args) {
 532             $args = array_merge($action_arg, $args);
 533         } else {
 534             $args = $action_arg;
 535         }
 536
 537         $url = $this->m->generate($args, $params, $fragment);
 538
 539         // Due to a bug in the Net_URL_Mapper code, the returned URL may
 540         // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
 541         // repair that here rather than modifying the upstream code...
 542
 543         $qpos = strpos($url, '?');
 544         if ($qpos !== false) {
 545             $url = substr($url, 0, $qpos+1) .
 546               str_replace('?', '&', substr($url, $qpos+1));
 547         }
 548         return $url;
 549     }
 550 }