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 /**
  35  * URL Router
  36  *
  37  * Cheap wrapper around Net_URL_Mapper
  38  *
  39  * @category URL
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class Router
  46 {
  47     var $m = null;
  48     static $inst = null;
  49
  50     const REGEX_TAG = '[^\/]+'; // [\pL\pN_\-\.]{1,64} better if we can do unicode regexes
  51
  52     static function get()
  53     {
  54         if (!Router::$inst) {
  55             Router::$inst = new Router();
  56         }
  57         return Router::$inst;
  58     }
  59
  60     /**
  61      * Clear the global singleton instance for this class.
  62      * Needed to ensure reset when switching site configurations.
  63      */
  64     static function clear()
  65     {
  66         Router::$inst = null;
  67     }
  68
  69     function __construct()
  70     {
  71         if (empty($this->m)) {
  72             $this->m = $this->initialize();
  73         }
  74     }
  75
  76     /**
  77      * Create a unique hashkey for the router.
  78      *
  79      * The router's url map can change based on the version of the software
  80      * you're running and the plugins that are enabled. To avoid having bad routes
  81      * get stuck in the cache, the key includes a list of plugins and the software
  82      * version.
  83      *
  84     * There can still be problems with a) differences in versions of the plugins and
  85      * b) people running code between official versions, but these tend to be more
  86      * sophisticated users who can grok what's going on and clear their caches.
  87      *
  88      * @return string cache key string that should uniquely identify a router
  89      */
  90
  91     static function cacheKey()
  92     {
  93         $parts = array('router');
  94
  95         // Many router paths depend on this setting.
  96         if (common_config('singleuser', 'enabled')) {
  97             $parts[] = '1user';
  98         } else {
  99             $parts[] = 'multi';
 100         }
 101
 102         return Cache::codeKey(implode(':', $parts));
 103     }
 104
 105     function initialize()
 106     {
 107         $m = new URLMapper();
 108
 109         if (Event::handle('StartInitializeRouter', array(&$m))) {
 110
 111             $m->connect('robots.txt', array('action' => 'robotstxt'));
 112
 113             $m->connect('opensearch/people', array('action' => 'opensearch',
 114                                                    'type' => 'people'));
 115             $m->connect('opensearch/notice', array('action' => 'opensearch',
 116                                                    'type' => 'notice'));
 117
 118             // docs
 119
 120             $m->connect('doc/:title', array('action' => 'doc'));
 121
 122             $m->connect('main/otp/:user_id/:token',
 123                         array('action' => 'otp'),
 124                         array('user_id' => '[0-9]+',
 125                               'token' => '.+'));
 126
 127             // these take a code; before the main part
 128
 129             foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
 130                 $m->connect('main/'.$c.'/:code', array('action' => $c));
 131             }
 132
 133             // Also need a block variant accepting ID on URL for mail links
 134             $m->connect('main/block/:profileid',
 135                         array('action' => 'block'),
 136                         array('profileid' => '[0-9]+'));
 137
 138             $m->connect('main/sup/:seconds', array('action' => 'sup'),
 139                         array('seconds' => '[0-9]+'));
 140
 141             // main stuff is repetitive
 142
 143             $main = array('login', 'logout', 'register', 'subscribe',
 144                           'unsubscribe', 'cancelsubscription', 'approvesub',
 145                           'confirmaddress', 'recoverpassword',
 146                           'invite', 'favor', 'disfavor', 'sup',
 147                           'block', 'unblock', 'subedit',
 148                           'groupblock', 'groupunblock',
 149                           'sandbox', 'unsandbox',
 150                           'silence', 'unsilence',
 151                           'grantrole', 'revokerole',
 152                           'repeat',
 153                           'deleteuser',
 154                           'geocode',
 155                           'version',
 156                           'backupaccount',
 157                           'deleteaccount',
 158                           'restoreaccount',
 159             );
 160
 161             foreach ($main as $a) {
 162                 $m->connect('main/'.$a, array('action' => $a));
 163             }
 164
 165             $m->connect('main/tagprofile/:id', array('action' => 'tagprofile'),
 166                                                array('id' => '[0-9]+'));
 167
 168             $m->connect('main/tagprofile', array('action' => 'tagprofile'));
 169
 170             $m->connect('main/oembed',
 171                         array('action' => 'oembed'));
 172
 173             $m->connect('main/xrds',
 174                         array('action' => 'publicxrds'));
 175             $m->connect('.well-known/host-meta',
 176                         array('action' => 'hostmeta'));
 177             $m->connect('main/xrd',
 178                         array('action' => 'userxrd'));
 179
 180             // settings
 181
 182             foreach (array('profile', 'avatar', 'password', 'im', 'oauthconnections',
 183                            'oauthapps', 'email', 'sms', 'url') as $s) {
 184                 $m->connect('settings/'.$s, array('action' => $s.'settings'));
 185             }
 186
 187             if (common_config('oldschool', 'enabled')) {
 188                 $m->connect('settings/oldschool', array('action' => 'oldschoolsettings'));
 189             }
 190
 191             $m->connect('settings/oauthapps/show/:id',
 192                         array('action' => 'showapplication'),
 193                         array('id' => '[0-9]+')
 194             );
 195             $m->connect('settings/oauthapps/new',
 196                         array('action' => 'newapplication')
 197             );
 198             $m->connect('settings/oauthapps/edit/:id',
 199                         array('action' => 'editapplication'),
 200                         array('id' => '[0-9]+')
 201             );
 202             $m->connect('settings/oauthapps/delete/:id',
 203                         array('action' => 'deleteapplication'),
 204                         array('id' => '[0-9]+')
 205             );
 206
 207             // search
 208
 209             foreach (array('group', 'people', 'notice') as $s) {
 210                 $m->connect('search/'.$s.'?q=:q',
 211                             array('action' => $s.'search'),
 212                             array('q' => '.+'));
 213                 $m->connect('search/'.$s, array('action' => $s.'search'));
 214             }
 215
 216             // The second of these is needed to make the link work correctly
 217             // when inserted into the page. The first is needed to match the
 218             // route on the way in. Seems to be another Net_URL_Mapper bug to me.
 219             $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
 220                         array('q' => '.+'));
 221             $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
 222
 223             $m->connect('attachment/:attachment',
 224                         array('action' => 'attachment'),
 225                         array('attachment' => '[0-9]+'));
 226
 227             $m->connect('attachment/:attachment/ajax',
 228                         array('action' => 'attachment_ajax'),
 229                         array('attachment' => '[0-9]+'));
 230
 231             $m->connect('attachment/:attachment/thumbnail',
 232                         array('action' => 'attachment_thumbnail'),
 233                         array('attachment' => '[0-9]+'));
 234
 235             $m->connect('notice/new?replyto=:replyto&inreplyto=:inreplyto',
 236                         array('action' => 'newnotice'),
 237                         array('replyto' => Nickname::DISPLAY_FMT),
 238                         array('inreplyto' => '[0-9]+'));
 239
 240             $m->connect('notice/new?replyto=:replyto',
 241                         array('action' => 'newnotice'),
 242                         array('replyto' => Nickname::DISPLAY_FMT));
 243
 244             $m->connect('notice/new', array('action' => 'newnotice'));
 245
 246             $m->connect('notice/:notice/file',
 247                         array('action' => 'file'),
 248                         array('notice' => '[0-9]+'));
 249
 250             $m->connect('notice/:notice',
 251                         array('action' => 'shownotice'),
 252                         array('notice' => '[0-9]+'));
 253
 254             $m->connect('notice/delete/:notice',
 255                         array('action' => 'deletenotice'),
 256                         array('notice' => '[0-9]+'));
 257
 258             $m->connect('notice/delete', array('action' => 'deletenotice'));
 259
 260             $m->connect('bookmarklet/new', array('action' => 'bookmarklet'));
 261
 262             // conversation
 263
 264             $m->connect('conversation/:id',
 265                         array('action' => 'conversation'),
 266                         array('id' => '[0-9]+'));
 267             $m->connect('conversation/:id/replies',
 268                         array('action' => 'conversationreplies'),
 269                         array('id' => '[0-9]+'));
 270
 271             $m->connect('message/new', array('action' => 'newmessage'));
 272             $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => Nickname::DISPLAY_FMT));
 273             $m->connect('message/:message',
 274                         array('action' => 'showmessage'),
 275                         array('message' => '[0-9]+'));
 276
 277             $m->connect('user/:id',
 278                         array('action' => 'userbyid'),
 279                         array('id' => '[0-9]+'));
 280
 281             if (!common_config('performance', 'high')) {
 282                 $m->connect('tags/', array('action' => 'publictagcloud'));
 283                 $m->connect('tag/', array('action' => 'publictagcloud'));
 284                 $m->connect('tags', array('action' => 'publictagcloud'));
 285                 $m->connect('tag', array('action' => 'publictagcloud'));
 286             }
 287             $m->connect('tag/:tag/rss',
 288                         array('action' => 'tagrss'),
 289                         array('tag' => self::REGEX_TAG));
 290             $m->connect('tag/:tag',
 291                         array('action' => 'tag'),
 292                         array('tag' => self::REGEX_TAG));
 293
 294             // groups
 295
 296             $m->connect('group/new', array('action' => 'newgroup'));
 297
 298             foreach (array('edit', 'join', 'leave', 'delete', 'cancel', 'approve') as $v) {
 299                 $m->connect('group/:nickname/'.$v,
 300                             array('action' => $v.'group'),
 301                             array('nickname' => Nickname::DISPLAY_FMT));
 302                 $m->connect('group/:id/id/'.$v,
 303                             array('action' => $v.'group'),
 304                             array('id' => '[0-9]+'));
 305             }
 306
 307             foreach (array('members', 'logo', 'rss') as $n) {
 308                 $m->connect('group/:nickname/'.$n,
 309                             array('action' => 'group'.$n),
 310                             array('nickname' => Nickname::DISPLAY_FMT));
 311             }
 312
 313             $m->connect('group/:nickname/foaf',
 314                         array('action' => 'foafgroup'),
 315                         array('nickname' => Nickname::DISPLAY_FMT));
 316
 317             $m->connect('group/:nickname/blocked',
 318                         array('action' => 'blockedfromgroup'),
 319                         array('nickname' => Nickname::DISPLAY_FMT));
 320
 321             $m->connect('group/:nickname/makeadmin',
 322                         array('action' => 'makeadmin'),
 323                         array('nickname' => Nickname::DISPLAY_FMT));
 324
 325             $m->connect('group/:nickname/members/pending',
 326                         array('action' => 'groupqueue'),
 327                         array('nickname' => Nickname::DISPLAY_FMT));
 328
 329             $m->connect('group/:id/id',
 330                         array('action' => 'groupbyid'),
 331                         array('id' => '[0-9]+'));
 332
 333             $m->connect('group/:nickname',
 334                         array('action' => 'showgroup'),
 335                         array('nickname' => Nickname::DISPLAY_FMT));
 336
 337             $m->connect('group/', array('action' => 'groups'));
 338             $m->connect('group', array('action' => 'groups'));
 339             $m->connect('groups/', array('action' => 'groups'));
 340             $m->connect('groups', array('action' => 'groups'));
 341
 342             // Twitter-compatible API
 343
 344             // statuses API
 345
 346             $m->connect('api',
 347                         array('action' => 'Redirect',
 348                               'nextAction' => 'doc',
 349                               'args' => array('title' => 'api')));
 350
 351             $m->connect('api/statuses/public_timeline.:format',
 352                         array('action' => 'ApiTimelinePublic',
 353                               'format' => '(xml|json|rss|atom|as)'));
 354
 355             $m->connect('api/statuses/friends_timeline/:id.:format',
 356                         array('action' => 'ApiTimelineFriends',
 357                               'id' => Nickname::INPUT_FMT,
 358                               'format' => '(xml|json|rss|atom|as)'));
 359
 360             $m->connect('api/statuses/friends_timeline.:format',
 361                         array('action' => 'ApiTimelineFriends',
 362                               'format' => '(xml|json|rss|atom|as)'));
 363
 364             $m->connect('api/statuses/home_timeline/:id.:format',
 365                         array('action' => 'ApiTimelineHome',
 366                               'id' => Nickname::INPUT_FMT,
 367                               'format' => '(xml|json|rss|atom|as)'));
 368
 369             $m->connect('api/statuses/home_timeline.:format',
 370                         array('action' => 'ApiTimelineHome',
 371                               'format' => '(xml|json|rss|atom|as)'));
 372
 373             $m->connect('api/statuses/user_timeline/:id.:format',
 374                         array('action' => 'ApiTimelineUser',
 375                               'id' => Nickname::INPUT_FMT,
 376                               'format' => '(xml|json|rss|atom|as)'));
 377
 378             $m->connect('api/statuses/user_timeline.:format',
 379                         array('action' => 'ApiTimelineUser',
 380                               'format' => '(xml|json|rss|atom|as)'));
 381
 382             $m->connect('api/statuses/mentions/:id.:format',
 383                         array('action' => 'ApiTimelineMentions',
 384                               'id' => Nickname::INPUT_FMT,
 385                               'format' => '(xml|json|rss|atom|as)'));
 386
 387             $m->connect('api/statuses/mentions.:format',
 388                         array('action' => 'ApiTimelineMentions',
 389                               'format' => '(xml|json|rss|atom|as)'));
 390
 391             $m->connect('api/statuses/replies/:id.:format',
 392                         array('action' => 'ApiTimelineMentions',
 393                               'id' => Nickname::INPUT_FMT,
 394                               'format' => '(xml|json|rss|atom|as)'));
 395
 396             $m->connect('api/statuses/replies.:format',
 397                         array('action' => 'ApiTimelineMentions',
 398                               'format' => '(xml|json|rss|atom|as)'));
 399
 400             $m->connect('api/statuses/retweeted_by_me.:format',
 401                         array('action' => 'ApiTimelineRetweetedByMe',
 402                               'format' => '(xml|json|atom|as)'));
 403
 404             $m->connect('api/statuses/retweeted_to_me.:format',
 405                         array('action' => 'ApiTimelineRetweetedToMe',
 406                               'format' => '(xml|json|atom|as)'));
 407
 408             $m->connect('api/statuses/retweets_of_me.:format',
 409                         array('action' => 'ApiTimelineRetweetsOfMe',
 410                               'format' => '(xml|json|atom|as)'));
 411
 412             $m->connect('api/statuses/friends/:id.:format',
 413                         array('action' => 'ApiUserFriends',
 414                               'id' => Nickname::INPUT_FMT,
 415                               'format' => '(xml|json)'));
 416
 417             $m->connect('api/statuses/friends.:format',
 418                         array('action' => 'ApiUserFriends',
 419                               'format' => '(xml|json)'));
 420
 421             $m->connect('api/statuses/followers/:id.:format',
 422                         array('action' => 'ApiUserFollowers',
 423                               'id' => Nickname::INPUT_FMT,
 424                               'format' => '(xml|json)'));
 425
 426             $m->connect('api/statuses/followers.:format',
 427                         array('action' => 'ApiUserFollowers',
 428                               'format' => '(xml|json)'));
 429
 430             $m->connect('api/statuses/show/:id.:format',
 431                         array('action' => 'ApiStatusesShow',
 432                               'id' => '[0-9]+',
 433                               'format' => '(xml|json|atom)'));
 434
 435             $m->connect('api/statuses/show.:format',
 436                         array('action' => 'ApiStatusesShow',
 437                               'format' => '(xml|json|atom)'));
 438
 439             $m->connect('api/statuses/update.:format',
 440                         array('action' => 'ApiStatusesUpdate',
 441                               'format' => '(xml|json)'));
 442
 443             $m->connect('api/statuses/destroy/:id.:format',
 444                         array('action' => 'ApiStatusesDestroy',
 445                               'id' => '[0-9]+',
 446                               'format' => '(xml|json)'));
 447
 448             $m->connect('api/statuses/destroy.:format',
 449                         array('action' => 'ApiStatusesDestroy',
 450                               'format' => '(xml|json)'));
 451
 452             $m->connect('api/statuses/retweet/:id.:format',
 453                         array('action' => 'ApiStatusesRetweet',
 454                               'id' => '[0-9]+',
 455                               'format' => '(xml|json)'));
 456
 457             $m->connect('api/statuses/retweets/:id.:format',
 458                         array('action' => 'ApiStatusesRetweets',
 459                               'id' => '[0-9]+',
 460                               'format' => '(xml|json)'));
 461
 462             // users
 463
 464             $m->connect('api/users/show/:id.:format',
 465                         array('action' => 'ApiUserShow',
 466                               'id' => Nickname::INPUT_FMT,
 467                               'format' => '(xml|json)'));
 468
 469             $m->connect('api/users/show.:format',
 470                         array('action' => 'ApiUserShow',
 471                               'format' => '(xml|json)'));
 472
 473             $m->connect('api/users/profile_image/:screen_name.:format',
 474                         array('action' => 'ApiUserProfileImage',
 475                               'screen_name' => Nickname::DISPLAY_FMT,
 476                               'format' => '(xml|json)'));
 477
 478             // direct messages
 479
 480             $m->connect('api/direct_messages.:format',
 481                         array('action' => 'ApiDirectMessage',
 482                               'format' => '(xml|json|rss|atom)'));
 483
 484             $m->connect('api/direct_messages/sent.:format',
 485                         array('action' => 'ApiDirectMessage',
 486                               'format' => '(xml|json|rss|atom)',
 487                               'sent' => true));
 488
 489             $m->connect('api/direct_messages/new.:format',
 490                         array('action' => 'ApiDirectMessageNew',
 491                               'format' => '(xml|json)'));
 492
 493             // friendships
 494
 495             $m->connect('api/friendships/show.:format',
 496                         array('action' => 'ApiFriendshipsShow',
 497                               'format' => '(xml|json)'));
 498
 499             $m->connect('api/friendships/exists.:format',
 500                         array('action' => 'ApiFriendshipsExists',
 501                               'format' => '(xml|json)'));
 502
 503             $m->connect('api/friendships/create/:id.:format',
 504                         array('action' => 'ApiFriendshipsCreate',
 505                               'id' => Nickname::INPUT_FMT,
 506                               'format' => '(xml|json)'));
 507
 508             $m->connect('api/friendships/create.:format',
 509                         array('action' => 'ApiFriendshipsCreate',
 510                               'format' => '(xml|json)'));
 511
 512             $m->connect('api/friendships/destroy/:id.:format',
 513                         array('action' => 'ApiFriendshipsDestroy',
 514                               'id' => Nickname::INPUT_FMT,
 515                               'format' => '(xml|json)'));
 516
 517             $m->connect('api/friendships/destroy.:format',
 518                         array('action' => 'ApiFriendshipsDestroy',
 519                               'format' => '(xml|json)'));
 520
 521             // Social graph
 522
 523             $m->connect('api/friends/ids/:id.:format',
 524                         array('action' => 'ApiUserFriends',
 525                               'ids_only' => true));
 526
 527             $m->connect('api/followers/ids/:id.:format',
 528                         array('action' => 'ApiUserFollowers',
 529                               'ids_only' => true));
 530
 531             $m->connect('api/friends/ids.:format',
 532                         array('action' => 'ApiUserFriends',
 533                               'ids_only' => true));
 534
 535             $m->connect('api/followers/ids.:format',
 536                         array('action' => 'ApiUserFollowers',
 537                               'ids_only' => true));
 538
 539             // account
 540
 541             $m->connect('api/account/verify_credentials.:format',
 542                         array('action' => 'ApiAccountVerifyCredentials'));
 543
 544             $m->connect('api/account/update_profile.:format',
 545                         array('action' => 'ApiAccountUpdateProfile'));
 546
 547             $m->connect('api/account/update_profile_image.:format',
 548                         array('action' => 'ApiAccountUpdateProfileImage'));
 549
 550             $m->connect('api/account/update_delivery_device.:format',
 551                         array('action' => 'ApiAccountUpdateDeliveryDevice'));
 552
 553             // special case where verify_credentials is called w/out a format
 554
 555             $m->connect('api/account/verify_credentials',
 556                         array('action' => 'ApiAccountVerifyCredentials'));
 557
 558             $m->connect('api/account/rate_limit_status.:format',
 559                         array('action' => 'ApiAccountRateLimitStatus'));
 560
 561             // favorites
 562
 563             $m->connect('api/favorites/:id.:format',
 564                         array('action' => 'ApiTimelineFavorites',
 565                               'id' => Nickname::INPUT_FMT,
 566                               'format' => '(xml|json|rss|atom|as)'));
 567
 568             $m->connect('api/favorites.:format',
 569                         array('action' => 'ApiTimelineFavorites',
 570                               'format' => '(xml|json|rss|atom|as)'));
 571
 572             $m->connect('api/favorites/create/:id.:format',
 573                         array('action' => 'ApiFavoriteCreate',
 574                               'id' => '[0-9]+',
 575                               'format' => '(xml|json)'));
 576
 577             $m->connect('api/favorites/destroy/:id.:format',
 578                         array('action' => 'ApiFavoriteDestroy',
 579                               'id' => '[0-9]+',
 580                               'format' => '(xml|json)'));
 581             // blocks
 582
 583             $m->connect('api/blocks/create/:id.:format',
 584                         array('action' => 'ApiBlockCreate',
 585                               'id' => Nickname::INPUT_FMT,
 586                               'format' => '(xml|json)'));
 587
 588             $m->connect('api/blocks/create.:format',
 589                         array('action' => 'ApiBlockCreate',
 590                               'format' => '(xml|json)'));
 591
 592             $m->connect('api/blocks/destroy/:id.:format',
 593                         array('action' => 'ApiBlockDestroy',
 594                               'id' => Nickname::INPUT_FMT,
 595                               'format' => '(xml|json)'));
 596
 597             $m->connect('api/blocks/destroy.:format',
 598                         array('action' => 'ApiBlockDestroy',
 599                               'format' => '(xml|json)'));
 600
 601             // help
 602
 603             $m->connect('api/help/test.:format',
 604                         array('action' => 'ApiHelpTest',
 605                               'format' => '(xml|json)'));
 606
 607             // statusnet
 608
 609             $m->connect('api/statusnet/version.:format',
 610                         array('action' => 'ApiStatusnetVersion',
 611                               'format' => '(xml|json)'));
 612
 613             $m->connect('api/statusnet/config.:format',
 614                         array('action' => 'ApiStatusnetConfig',
 615                               'format' => '(xml|json)'));
 616
 617             // For older methods, we provide "laconica" base action
 618
 619             $m->connect('api/laconica/version.:format',
 620                         array('action' => 'ApiStatusnetVersion',
 621                               'format' => '(xml|json)'));
 622
 623             $m->connect('api/laconica/config.:format',
 624                         array('action' => 'ApiStatusnetConfig',
 625                               'format' => '(xml|json)'));
 626
 627             // Groups and tags are newer than 0.8.1 so no backward-compatibility
 628             // necessary
 629
 630             // Groups
 631             //'list' has to be handled differently, as php will not allow a method to be named 'list'
 632
 633             $m->connect('api/statusnet/groups/timeline/:id.:format',
 634                         array('action' => 'ApiTimelineGroup',
 635                               'id' => Nickname::INPUT_FMT,
 636                               'format' => '(xml|json|rss|atom|as)'));
 637
 638             $m->connect('api/statusnet/groups/show/:id.:format',
 639                         array('action' => 'ApiGroupShow',
 640                               'id' => Nickname::INPUT_FMT,
 641                               'format' => '(xml|json)'));
 642
 643             $m->connect('api/statusnet/groups/show.:format',
 644                         array('action' => 'ApiGroupShow',
 645                               'format' => '(xml|json)'));
 646
 647             $m->connect('api/statusnet/groups/join/:id.:format',
 648                         array('action' => 'ApiGroupJoin',
 649                               'format' => '(xml|json)'));
 650
 651             $m->connect('api/statusnet/groups/join.:format',
 652                         array('action' => 'ApiGroupJoin',
 653                               'id' => Nickname::INPUT_FMT,
 654                               'format' => '(xml|json)'));
 655
 656             $m->connect('api/statusnet/groups/leave/:id.:format',
 657                         array('action' => 'ApiGroupLeave',
 658                               'format' => '(xml|json)'));
 659
 660             $m->connect('api/statusnet/groups/leave.:format',
 661                         array('action' => 'ApiGroupLeave',
 662                               'id' => Nickname::INPUT_FMT,
 663                               'format' => '(xml|json)'));
 664
 665             $m->connect('api/statusnet/groups/is_member.:format',
 666                         array('action' => 'ApiGroupIsMember',
 667                               'format' => '(xml|json)'));
 668
 669             $m->connect('api/statusnet/groups/list/:id.:format',
 670                         array('action' => 'ApiGroupList',
 671                               'id' => Nickname::INPUT_FMT,
 672                               'format' => '(xml|json|rss|atom)'));
 673
 674             $m->connect('api/statusnet/groups/list.:format',
 675                         array('action' => 'ApiGroupList',
 676                               'format' => '(xml|json|rss|atom)'));
 677
 678             $m->connect('api/statusnet/groups/list_all.:format',
 679                         array('action' => 'ApiGroupListAll',
 680                               'format' => '(xml|json|rss|atom)'));
 681
 682             $m->connect('api/statusnet/groups/membership/:id.:format',
 683                         array('action' => 'ApiGroupMembership',
 684                               'id' => Nickname::INPUT_FMT,
 685                               'format' => '(xml|json)'));
 686
 687             $m->connect('api/statusnet/groups/membership.:format',
 688                         array('action' => 'ApiGroupMembership',
 689                               'format' => '(xml|json)'));
 690
 691             $m->connect('api/statusnet/groups/create.:format',
 692                         array('action' => 'ApiGroupCreate',
 693                               'format' => '(xml|json)'));
 694
 695             $m->connect('api/statusnet/groups/update/:id.:format',
 696                         array('action' => 'ApiGroupProfileUpdate',
 697                               'id' => '[a-zA-Z0-9]+',
 698                               'format' => '(xml|json)'));
 699
 700             $m->connect('api/statusnet/conversation/:id.:format',
 701                         array('action' => 'apiconversation',
 702                               'id' => '[0-9]+',
 703                               'format' => '(xml|json|rss|atom|as)'));
 704
 705             // Lists (people tags)
 706
 707             $m->connect('api/lists/memberships.:format',
 708                         array('action' => 'ApiListMemberships',
 709                               'format' => '(xml|json)'));
 710
 711             $m->connect('api/:user/lists/memberships.:format',
 712                         array('action' => 'ApiListMemberships',
 713                               'user' => '[a-zA-Z0-9]+',
 714                               'format' => '(xml|json)'));
 715
 716             $m->connect('api/lists/subscriptions.:format',
 717                         array('action' => 'ApiListSubscriptions',
 718                               'format' => '(xml|json)'));
 719
 720             $m->connect('api/:user/lists/subscriptions.:format',
 721                         array('action' => 'ApiListSubscriptions',
 722                               'user' => '[a-zA-Z0-9]+',
 723                               'format' => '(xml|json)'));
 724
 725             $m->connect('api/lists.:format',
 726                         array('action' => 'ApiLists',
 727                               'format' => '(xml|json)'));
 728
 729             $m->connect('api/:user/lists/:id.:format',
 730                         array('action' => 'ApiList',
 731                               'user' => '[a-zA-Z0-9]+',
 732                               'id' => '[a-zA-Z0-9]+',
 733                               'format' => '(xml|json)'));
 734
 735             $m->connect('api/:user/lists.:format',
 736                         array('action' => 'ApiLists',
 737                               'user' => '[a-zA-Z0-9]+',
 738                               'format' => '(xml|json)'));
 739
 740             $m->connect('api/:user/lists/:id/statuses.:format',
 741                         array('action' => 'ApiTimelineList',
 742                               'user' => '[a-zA-Z0-9]+',
 743                               'id' => '[a-zA-Z0-9]+',
 744                               'format' => '(xml|json|rss|atom)'));
 745
 746             $m->connect('api/:user/:list_id/members/:id.:format',
 747                         array('action' => 'ApiListMember',
 748                               'user' => '[a-zA-Z0-9]+',
 749                               'list_id' => '[a-zA-Z0-9]+',
 750                               'id' => '[a-zA-Z0-9]+',
 751                               'format' => '(xml|json)'));
 752
 753             $m->connect('api/:user/:list_id/members.:format',
 754                         array('action' => 'ApiListMembers',
 755                               'user' => '[a-zA-Z0-9]+',
 756                               'list_id' => '[a-zA-Z0-9]+',
 757                               'format' => '(xml|json)'));
 758
 759             $m->connect('api/:user/:list_id/subscribers/:id.:format',
 760                         array('action' => 'ApiListSubscriber',
 761                               'user' => '[a-zA-Z0-9]+',
 762                               'list_id' => '[a-zA-Z0-9]+',
 763                               'id' => '[a-zA-Z0-9]+',
 764                               'format' => '(xml|json)'));
 765
 766             $m->connect('api/:user/:list_id/subscribers.:format',
 767                         array('action' => 'ApiListSubscribers',
 768                               'user' => '[a-zA-Z0-9]+',
 769                               'list_id' => '[a-zA-Z0-9]+',
 770                               'format' => '(xml|json)'));
 771
 772             // Tags
 773             $m->connect('api/statusnet/tags/timeline/:tag.:format',
 774                         array('action' => 'ApiTimelineTag',
 775                               'format' => '(xml|json|rss|atom|as)'));
 776
 777             // media related
 778             $m->connect(
 779                 'api/statusnet/media/upload',
 780                 array('action' => 'ApiMediaUpload')
 781             );
 782
 783             // search
 784             $m->connect('api/search.atom', array('action' => 'ApiSearchAtom'));
 785             $m->connect('api/search.json', array('action' => 'ApiSearchJSON'));
 786             $m->connect('api/trends.json', array('action' => 'ApiTrends'));
 787
 788             $m->connect('api/oauth/request_token',
 789                         array('action' => 'ApiOauthRequestToken'));
 790
 791             $m->connect('api/oauth/access_token',
 792                         array('action' => 'ApiOauthAccessToken'));
 793
 794             $m->connect('api/oauth/authorize',
 795                         array('action' => 'ApiOauthAuthorize'));
 796
 797             // Admin
 798
 799             $m->connect('panel/site', array('action' => 'siteadminpanel'));
 800             $m->connect('panel/user', array('action' => 'useradminpanel'));
 801                 $m->connect('panel/access', array('action' => 'accessadminpanel'));
 802             $m->connect('panel/paths', array('action' => 'pathsadminpanel'));
 803             $m->connect('panel/sessions', array('action' => 'sessionsadminpanel'));
 804             $m->connect('panel/sitenotice', array('action' => 'sitenoticeadminpanel'));
 805             $m->connect('panel/snapshot', array('action' => 'snapshotadminpanel'));
 806             $m->connect('panel/license', array('action' => 'licenseadminpanel'));
 807
 808             $m->connect('panel/plugins', array('action' => 'pluginsadminpanel'));
 809             $m->connect('panel/plugins/enable/:plugin',
 810                         array('action' => 'pluginenable'),
 811                         array('plugin' => '[A-Za-z0-9_]+'));
 812             $m->connect('panel/plugins/disable/:plugin',
 813                         array('action' => 'plugindisable'),
 814                         array('plugin' => '[A-Za-z0-9_]+'));
 815
 816             $m->connect('getfile/:filename',
 817                         array('action' => 'getfile'),
 818                         array('filename' => '[A-Za-z0-9._-]+'));
 819
 820             // In the "root"
 821
 822             if (common_config('singleuser', 'enabled')) {
 823
 824                 $nickname = User::singleUserNickname();
 825
 826                 foreach (array('subscriptions', 'subscribers',
 827                                'all', 'foaf', 'replies',
 828                                'microsummary', 'hcard') as $a) {
 829                     $m->connect($a,
 830                                 array('action' => $a,
 831                                       'nickname' => $nickname));
 832                 }
 833
 834                 foreach (array('subscriptions', 'subscribers') as $a) {
 835                     $m->connect($a.'/:tag',
 836                                 array('action' => $a,
 837                                       'nickname' => $nickname),
 838                                 array('tag' => self::REGEX_TAG));
 839                 }
 840
 841                 $m->connect('subscribers/pending',
 842                             array('action' => 'subqueue',
 843                                   'nickname' => $nickname));
 844
 845                 foreach (array('rss', 'groups') as $a) {
 846                     $m->connect($a,
 847                                 array('action' => 'user'.$a,
 848                                       'nickname' => $nickname));
 849                 }
 850
 851                 foreach (array('all', 'replies', 'favorites') as $a) {
 852                     $m->connect($a.'/rss',
 853                                 array('action' => $a.'rss',
 854                                       'nickname' => $nickname));
 855                 }
 856
 857                 $m->connect('favorites',
 858                             array('action' => 'showfavorites',
 859                                   'nickname' => $nickname));
 860
 861                 $m->connect('avatar/:size',
 862                             array('action' => 'avatarbynickname',
 863                                   'nickname' => $nickname),
 864                             array('size' => '(original|96|48|24)'));
 865
 866                 $m->connect('tag/:tag/rss',
 867                             array('action' => 'userrss',
 868                                   'nickname' => $nickname),
 869                             array('tag' => self::REGEX_TAG));
 870
 871                 $m->connect('tag/:tag',
 872                             array('action' => 'showstream',
 873                                   'nickname' => $nickname),
 874                             array('tag' => self::REGEX_TAG));
 875
 876                 $m->connect('rsd.xml',
 877                             array('action' => 'rsd',
 878                                   'nickname' => $nickname));
 879
 880                 $m->connect('',
 881                             array('action' => 'showstream',
 882                                   'nickname' => $nickname));
 883             } else {
 884                 $m->connect('', array('action' => 'public'));
 885                 $m->connect('rss', array('action' => 'publicrss'));
 886                 $m->connect('featuredrss', array('action' => 'featuredrss'));
 887                 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
 888                 $m->connect('featured/', array('action' => 'featured'));
 889                 $m->connect('featured', array('action' => 'featured'));
 890                 $m->connect('favorited/', array('action' => 'favorited'));
 891                 $m->connect('favorited', array('action' => 'favorited'));
 892                 $m->connect('rsd.xml', array('action' => 'rsd'));
 893
 894                 foreach (array('subscriptions', 'subscribers',
 895                                'nudge', 'all', 'foaf', 'replies',
 896                                'inbox', 'outbox', 'microsummary', 'hcard') as $a) {
 897                     $m->connect(':nickname/'.$a,
 898                                 array('action' => $a),
 899                                 array('nickname' => Nickname::DISPLAY_FMT));
 900                 }
 901                 $m->connect(':nickname/subscribers/pending',
 902                             array('action' => 'subqueue'),
 903                             array('nickname' => Nickname::DISPLAY_FMT));
 904
 905                 // people tags
 906
 907                 if (!common_config('performance', 'high')) {
 908                     $m->connect('peopletags', array('action' => 'publicpeopletagcloud'));
 909                 }
 910
 911                 $m->connect('peopletag/:tag', array('action' => 'peopletag',
 912                                                     'tag'    => self::REGEX_TAG));
 913
 914                 $m->connect('selftag/:tag', array('action' => 'selftag',
 915                                                   'tag'    => self::REGEX_TAG));
 916
 917                 $m->connect('main/addpeopletag', array('action' => 'addpeopletag'));
 918
 919                 $m->connect('main/removepeopletag', array('action' => 'removepeopletag'));
 920
 921                 $m->connect('main/profilecompletion', array('action' => 'profilecompletion'));
 922
 923                 $m->connect('main/peopletagautocomplete', array('action' => 'peopletagautocomplete'));
 924
 925                 $m->connect(':nickname/peopletags',
 926                                 array('action' => 'peopletagsbyuser',
 927                                       'nickname' => Nickname::DISPLAY_FMT));
 928
 929                 $m->connect(':nickname/peopletags/private',
 930                                 array('action' => 'peopletagsbyuser',
 931                                       'nickname' => Nickname::DISPLAY_FMT,
 932                                       'private' => 1));
 933
 934                 $m->connect(':nickname/peopletags/public',
 935                                 array('action' => 'peopletagsbyuser',
 936                                       'nickname' => Nickname::DISPLAY_FMT,
 937                                       'public' => 1));
 938
 939                 $m->connect(':nickname/othertags',
 940                                 array('action' => 'peopletagsforuser',
 941                                       'nickname' => Nickname::DISPLAY_FMT));
 942
 943                 $m->connect(':nickname/peopletagsubscriptions',
 944                                 array('action' => 'peopletagsubscriptions',
 945                                       'nickname' => Nickname::DISPLAY_FMT));
 946
 947                 $m->connect(':tagger/all/:tag/subscribers',
 948                                 array('action' => 'peopletagsubscribers',
 949                                       'tagger' => Nickname::DISPLAY_FMT,
 950                                       'tag' => self::REGEX_TAG));
 951
 952                 $m->connect(':tagger/all/:tag/tagged',
 953                                 array('action' => 'peopletagged',
 954                                       'tagger' => Nickname::DISPLAY_FMT,
 955                                       'tag' => self::REGEX_TAG));
 956
 957                 $m->connect(':tagger/all/:tag/edit',
 958                                 array('action' => 'editpeopletag',
 959                                       'tagger' => Nickname::DISPLAY_FMT,
 960                                       'tag' => self::REGEX_TAG));
 961
 962                 foreach(array('subscribe', 'unsubscribe') as $v) {
 963                     $m->connect('peopletag/:id/'.$v,
 964                                     array('action' => $v.'peopletag',
 965                                           'id' => '[0-9]{1,64}'));
 966                 }
 967                 $m->connect('user/:tagger_id/profiletag/:id/id',
 968                                 array('action' => 'profiletagbyid',
 969                                       'tagger_id' => '[0-9]+',
 970                                       'id' => '[0-9]+'));
 971
 972                 $m->connect(':tagger/all/:tag',
 973                                 array('action' => 'showprofiletag',
 974                                       'tagger' => Nickname::DISPLAY_FMT,
 975                                       'tag' => self::REGEX_TAG));
 976
 977                 foreach (array('subscriptions', 'subscribers') as $a) {
 978                     $m->connect(':nickname/'.$a.'/:tag',
 979                                 array('action' => $a),
 980                                 array('tag' => self::REGEX_TAG,
 981                                       'nickname' => Nickname::DISPLAY_FMT));
 982                 }
 983
 984                 foreach (array('rss', 'groups') as $a) {
 985                     $m->connect(':nickname/'.$a,
 986                                 array('action' => 'user'.$a),
 987                                 array('nickname' => Nickname::DISPLAY_FMT));
 988                 }
 989
 990                 foreach (array('all', 'replies', 'favorites') as $a) {
 991                     $m->connect(':nickname/'.$a.'/rss',
 992                                 array('action' => $a.'rss'),
 993                                 array('nickname' => Nickname::DISPLAY_FMT));
 994                 }
 995
 996                 $m->connect(':nickname/favorites',
 997                             array('action' => 'showfavorites'),
 998                             array('nickname' => Nickname::DISPLAY_FMT));
 999
1000                 $m->connect(':nickname/avatar/:size',
1001                             array('action' => 'avatarbynickname'),
1002                             array('size' => '(original|96|48|24)',
1003                                   'nickname' => Nickname::DISPLAY_FMT));
1004
1005                 $m->connect(':nickname/tag/:tag/rss',
1006                             array('action' => 'userrss'),
1007                             array('nickname' => Nickname::DISPLAY_FMT),
1008                             array('tag' => self::REGEX_TAG));
1009
1010                 $m->connect(':nickname/tag/:tag',
1011                             array('action' => 'showstream'),
1012                             array('nickname' => Nickname::DISPLAY_FMT),
1013                             array('tag' => self::REGEX_TAG));
1014
1015                 $m->connect(':nickname/rsd.xml',
1016                             array('action' => 'rsd'),
1017                             array('nickname' => Nickname::DISPLAY_FMT));
1018
1019                 $m->connect(':nickname',
1020                             array('action' => 'showstream'),
1021                             array('nickname' => Nickname::DISPLAY_FMT));
1022             }
1023
1024             // AtomPub API
1025
1026             $m->connect('api/statusnet/app/service/:id.xml',
1027                         array('action' => 'ApiAtomService'),
1028                         array('id' => Nickname::DISPLAY_FMT));
1029
1030             $m->connect('api/statusnet/app/service.xml',
1031                         array('action' => 'ApiAtomService'));
1032
1033             $m->connect('api/statusnet/app/subscriptions/:subscriber/:subscribed.atom',
1034                         array('action' => 'AtomPubShowSubscription'),
1035                         array('subscriber' => '[0-9]+',
1036                               'subscribed' => '[0-9]+'));
1037
1038             $m->connect('api/statusnet/app/subscriptions/:subscriber.atom',
1039                         array('action' => 'AtomPubSubscriptionFeed'),
1040                         array('subscriber' => '[0-9]+'));
1041
1042             $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
1043                         array('action' => 'AtomPubShowFavorite'),
1044                         array('profile' => '[0-9]+',
1045                               'notice' => '[0-9]+'));
1046
1047             $m->connect('api/statusnet/app/favorites/:profile.atom',
1048                         array('action' => 'AtomPubFavoriteFeed'),
1049                         array('profile' => '[0-9]+'));
1050
1051             $m->connect('api/statusnet/app/memberships/:profile/:group.atom',
1052                         array('action' => 'AtomPubShowMembership'),
1053                         array('profile' => '[0-9]+',
1054                               'group' => '[0-9]+'));
1055
1056             $m->connect('api/statusnet/app/memberships/:profile.atom',
1057                         array('action' => 'AtomPubMembershipFeed'),
1058                         array('profile' => '[0-9]+'));
1059
1060             // URL shortening
1061
1062             $m->connect('url/:id',
1063                         array('action' => 'redirecturl',
1064                               'id' => '[0-9]+'));
1065
1066             // user stuff
1067
1068             Event::handle('RouterInitialized', array($m));
1069         }
1070
1071         return $m;
1072     }
1073
1074     function map($path)
1075     {
1076         try {
1077             $match = $this->m->match($path);
1078         } catch (Exception $e) {
1079             common_log(LOG_ERR, "Problem getting route for $path - " .
1080                        $e->getMessage());
1081             // TRANS: Client error on action trying to visit a non-existing page.
1082             $cac = new ClientErrorAction(_('Page not found.'), 404);
1083             $cac->showPage();
1084         }
1085
1086         return $match;
1087     }
1088
1089     function build($action, $args=null, $params=null, $fragment=null)
1090     {
1091         $action_arg = array('action' => $action);
1092
1093         if ($args) {
1094             $args = array_merge($action_arg, $args);
1095         } else {
1096             $args = $action_arg;
1097         }
1098
1099         $url = $this->m->generate($args, $params, $fragment);
1100         // Due to a bug in the Net_URL_Mapper code, the returned URL may
1101         // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
1102         // repair that here rather than modifying the upstream code...
1103
1104         $qpos = strpos($url, '?');
1105         if ($qpos !== false) {
1106             $url = substr($url, 0, $qpos+1) .
1107                 str_replace('?', '&', substr($url, $qpos+1));
1108
1109             // @fixme this is a hacky workaround for http_build_query in the
1110             // lower-level code and bad configs that set the default separator
1111             // to &amp; instead of &. Encoded &s in parameters will not be
1112             // affected.
1113             $url = substr($url, 0, $qpos+1) .
1114                 str_replace('&amp;', '&', substr($url, $qpos+1));
1115
1116         }
1117
1118         return $url;
1119     }
1120 }