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