lib/router.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once 'Net/URL/Mapper.php';
  35
  36 /**
  37  * URL Router
  38  *
  39  * Cheap wrapper around Net_URL_Mapper
  40  *
  41  * @category URL
  42  * @package  Laconica
  43  * @author   Evan Prodromou <evan@controlyourself.ca>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://laconi.ca/
  46  */
  47
  48 class Router
  49 {
  50     var $m = null;
  51     static $inst = null;
  52     static $bare = array('requesttoken', 'accesstoken', 'userauthorization',
  53                          'postnotice', 'updateprofile', 'finishremotesubscribe',
  54                          'finishopenidlogin', 'finishaddopenid');
  55
  56     static function get()
  57     {
  58         if (!Router::$inst) {
  59             Router::$inst = new Router();
  60         }
  61         return Router::$inst;
  62     }
  63
  64     function __construct()
  65     {
  66         if (!$this->m) {
  67             $this->m = $this->initialize();
  68         }
  69     }
  70
  71     function initialize()
  72     {
  73         $m = Net_URL_Mapper::getInstance();
  74
  75         // In the "root"
  76
  77         $m->connect('', array('action' => 'public'));
  78         $m->connect('rss', array('action' => 'publicrss'));
  79         $m->connect('xrds', array('action' => 'publicxrds'));
  80         $m->connect('featuredrss', array('action' => 'featuredrss'));
  81         $m->connect('favoritedrss', array('action' => 'favoritedrss'));
  82         $m->connect('opensearch/people', array('action' => 'opensearch',
  83                                                'type' => 'people'));
  84         $m->connect('opensearch/notice', array('action' => 'opensearch',
  85                                                'type' => 'notice'));
  86
  87         // docs
  88
  89         $m->connect('doc/:title', array('action' => 'doc'));
  90
  91         // facebook
  92
  93         $m->connect('facebook', array('action' => 'facebookhome'));
  94         $m->connect('facebook/index.php', array('action' => 'facebookhome'));
  95         $m->connect('facebook/settings.php', array('action' => 'facebooksettings'));
  96         $m->connect('facebook/invite.php', array('action' => 'facebookinvite'));
  97         $m->connect('facebook/remove', array('action' => 'facebookremove'));
  98
  99         // main stuff is repetitive
 100
 101         $main = array('login', 'logout', 'register', 'subscribe',
 102                       'unsubscribe', 'confirmaddress', 'recoverpassword',
 103                       'invite', 'favor', 'disfavor', 'sup',
 104                       'block', 'unblock', 'subedit',
 105                       'groupblock', 'groupunblock');
 106
 107         foreach ($main as $a) {
 108             $m->connect('main/'.$a, array('action' => $a));
 109         }
 110
 111         $m->connect('main/sup/:seconds', array('action' => 'sup'),
 112                     array('seconds' => '[0-9]+'));
 113
 114         $m->connect('main/tagother/:id', array('action' => 'tagother'));
 115
 116         // these take a code
 117
 118         foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
 119             $m->connect('main/'.$c.'/:code', array('action' => $c));
 120         }
 121
 122         // exceptional
 123
 124         $m->connect('main/openid', array('action' => 'openidlogin'));
 125         $m->connect('main/remote', array('action' => 'remotesubscribe'));
 126         $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+'));
 127
 128         foreach (Router::$bare as $action) {
 129             $m->connect('index.php?action=' . $action, array('action' => $action));
 130         }
 131
 132         // settings
 133
 134         foreach (array('profile', 'avatar', 'password', 'openid', 'im',
 135                        'email', 'sms', 'twitter', 'design', 'other') as $s) {
 136             $m->connect('settings/'.$s, array('action' => $s.'settings'));
 137         }
 138
 139         // search
 140
 141         foreach (array('group', 'people', 'notice') as $s) {
 142             $m->connect('search/'.$s, array('action' => $s.'search'));
 143             $m->connect('search/'.$s.'?q=:q',
 144                         array('action' => $s.'search'),
 145                         array('q' => '.+'));
 146         }
 147
 148         // The second of these is needed to make the link work correctly
 149         // when inserted into the page. The first is needed to match the
 150         // route on the way in. Seems to be another Net_URL_Mapper bug to me.
 151         $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
 152         $m->connect('search/notice/rss?q=:q', array('action' => 'noticesearchrss'),
 153                     array('q' => '.+'));
 154
 155         $m->connect('attachment/:attachment/ajax',
 156                     array('action' => 'attachment_ajax'),
 157                     array('attachment' => '[0-9]+'));
 158
 159         $m->connect('attachment/:attachment/thumbnail',
 160                     array('action' => 'attachment_thumbnail'),
 161                     array('attachment' => '[0-9]+'));
 162
 163         $m->connect('notice/new', array('action' => 'newnotice'));
 164         $m->connect('notice/new?replyto=:replyto',
 165                     array('action' => 'newnotice'),
 166                     array('replyto' => '[A-Za-z0-9_-]+'));
 167
 168         $m->connect('notice/:notice/file',
 169             array('action' => 'file'),
 170             array('notice' => '[0-9]+'));
 171
 172         $m->connect('notice/:notice',
 173                     array('action' => 'shownotice'),
 174                     array('notice' => '[0-9]+'));
 175         $m->connect('notice/delete', array('action' => 'deletenotice'));
 176         $m->connect('notice/delete/:notice',
 177                     array('action' => 'deletenotice'),
 178                     array('notice' => '[0-9]+'));
 179
 180         // conversation
 181
 182         $m->connect('conversation/:id',
 183                     array('action' => 'conversation'),
 184                     array('id' => '[0-9]+'));
 185
 186         $m->connect('message/new', array('action' => 'newmessage'));
 187         $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
 188         $m->connect('message/:message',
 189                     array('action' => 'showmessage'),
 190                     array('message' => '[0-9]+'));
 191
 192         $m->connect('user/:id',
 193                     array('action' => 'userbyid'),
 194                     array('id' => '[0-9]+'));
 195
 196         $m->connect('tags/', array('action' => 'publictagcloud'));
 197         $m->connect('tag/', array('action' => 'publictagcloud'));
 198         $m->connect('tags', array('action' => 'publictagcloud'));
 199         $m->connect('tag', array('action' => 'publictagcloud'));
 200         $m->connect('tag/:tag/rss',
 201                     array('action' => 'tagrss'),
 202                     array('tag' => '[a-zA-Z0-9]+'));
 203         $m->connect('tag/:tag',
 204                     array('action' => 'tag'),
 205                     array('tag' => '[a-zA-Z0-9]+'));
 206
 207         $m->connect('peopletag/:tag',
 208                     array('action' => 'peopletag'),
 209                     array('tag' => '[a-zA-Z0-9]+'));
 210
 211         $m->connect('featured/', array('action' => 'featured'));
 212         $m->connect('featured', array('action' => 'featured'));
 213         $m->connect('favorited/', array('action' => 'favorited'));
 214         $m->connect('favorited', array('action' => 'favorited'));
 215
 216         // groups
 217
 218         $m->connect('group/new', array('action' => 'newgroup'));
 219
 220         foreach (array('edit', 'join', 'leave') as $v) {
 221             $m->connect('group/:nickname/'.$v,
 222                         array('action' => $v.'group'),
 223                         array('nickname' => '[a-zA-Z0-9]+'));
 224         }
 225
 226         foreach (array('members', 'logo', 'rss') as $n) {
 227             $m->connect('group/:nickname/'.$n,
 228                         array('action' => 'group'.$n),
 229                         array('nickname' => '[a-zA-Z0-9]+'));
 230         }
 231
 232         $m->connect('group/:nickname/blocked',
 233                     array('action' => 'blockedfromgroup'),
 234                     array('nickname' => '[a-zA-Z0-9]+'));
 235
 236         $m->connect('group/:nickname/makeadmin',
 237                     array('action' => 'makeadmin'),
 238                     array('nickname' => '[a-zA-Z0-9]+'));
 239
 240         $m->connect('group/:id/id',
 241                     array('action' => 'groupbyid'),
 242                     array('id' => '[0-9]+'));
 243
 244         $m->connect('group/:nickname',
 245                     array('action' => 'showgroup'),
 246                     array('nickname' => '[a-zA-Z0-9]+'));
 247
 248         $m->connect('group/', array('action' => 'groups'));
 249         $m->connect('group', array('action' => 'groups'));
 250         $m->connect('groups/', array('action' => 'groups'));
 251         $m->connect('groups', array('action' => 'groups'));
 252
 253         // Twitter-compatible API
 254
 255         // statuses API
 256
 257         $m->connect('api/statuses/:method',
 258                     array('action' => 'api',
 259                           'apiaction' => 'statuses'),
 260                     array('method' => '(public_timeline|friends_timeline|user_timeline|update|replies|mentions|friends|followers|featured)(\.(atom|rss|xml|json))?'));
 261
 262         $m->connect('api/statuses/:method/:argument',
 263                     array('action' => 'api',
 264                           'apiaction' => 'statuses'),
 265                     array('method' => '(user_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
 266
 267         // users
 268
 269         $m->connect('api/users/:method/:argument',
 270                     array('action' => 'api',
 271                           'apiaction' => 'users'),
 272                     array('method' => 'show(\.(xml|json))?'));
 273
 274         $m->connect('api/users/:method',
 275                     array('action' => 'api',
 276                           'apiaction' => 'users'),
 277                     array('method' => 'show(\.(xml|json))?'));
 278
 279         // direct messages
 280
 281         foreach (array('xml', 'json') as $e) {
 282             $m->connect('api/direct_messages/new.'.$e,
 283                         array('action' => 'api',
 284                               'apiaction' => 'direct_messages',
 285                               'method' => 'create.'.$e));
 286         }
 287
 288         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 289             $m->connect('api/direct_messages.'.$e,
 290                         array('action' => 'api',
 291                               'apiaction' => 'direct_messages',
 292                               'method' => 'direct_messages.'.$e));
 293         }
 294
 295         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 296             $m->connect('api/direct_messages/sent.'.$e,
 297                         array('action' => 'api',
 298                               'apiaction' => 'direct_messages',
 299                               'method' => 'sent.'.$e));
 300         }
 301
 302         $m->connect('api/direct_messages/destroy/:argument',
 303                     array('action' => 'api',
 304                           'apiaction' => 'direct_messages'));
 305
 306         // friendships
 307
 308         $m->connect('api/friendships/:method/:argument',
 309                     array('action' => 'api',
 310                           'apiaction' => 'friendships'),
 311                     array('method' => '(create|destroy)'));
 312
 313         $m->connect('api/friendships/:method',
 314                     array('action' => 'api',
 315                           'apiaction' => 'friendships'),
 316                     array('method' => 'exists(\.(xml|json))'));
 317
 318         // Social graph
 319
 320         $m->connect('api/friends/ids/:argument',
 321                     array('action' => 'api',
 322                           'apiaction' => 'statuses',
 323                           'method' => 'friendsIDs'));
 324
 325         foreach (array('xml', 'json') as $e) {
 326             $m->connect('api/friends/ids.'.$e,
 327                         array('action' => 'api',
 328                               'apiaction' => 'statuses',
 329                               'method' => 'friendsIDs.'.$e));
 330         }
 331
 332         $m->connect('api/followers/ids/:argument',
 333                     array('action' => 'api',
 334                           'apiaction' => 'statuses',
 335                           'method' => 'followersIDs'));
 336
 337         foreach (array('xml', 'json') as $e) {
 338             $m->connect('api/followers/ids.'.$e,
 339                         array('action' => 'api',
 340                               'apiaction' => 'statuses',
 341                               'method' => 'followersIDs.'.$e));
 342         }
 343
 344         // account
 345
 346         $m->connect('api/account/:method',
 347                     array('action' => 'api',
 348                           'apiaction' => 'account'));
 349
 350         // favorites
 351
 352         $m->connect('api/favorites/:method/:argument',
 353                     array('action' => 'api',
 354                           'apiaction' => 'favorites',
 355                           array('method' => '(create|destroy)')));
 356
 357         $m->connect('api/favorites/:argument',
 358                     array('action' => 'api',
 359                           'apiaction' => 'favorites',
 360                           'method' => 'favorites'));
 361
 362         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
 363             $m->connect('api/favorites.'.$e,
 364                         array('action' => 'api',
 365                               'apiaction' => 'favorites',
 366                               'method' => 'favorites.'.$e));
 367         }
 368
 369         // notifications
 370
 371         $m->connect('api/notifications/:method/:argument',
 372                     array('action' => 'api',
 373                           'apiaction' => 'favorites'));
 374
 375         // blocks
 376
 377         $m->connect('api/blocks/:method/:argument',
 378                     array('action' => 'api',
 379                           'apiaction' => 'blocks'));
 380
 381         // help
 382
 383         $m->connect('api/help/:method',
 384                     array('action' => 'api',
 385                           'apiaction' => 'help'));
 386
 387         // laconica
 388
 389         $m->connect('api/laconica/:method',
 390                     array('action' => 'api',
 391                           'apiaction' => 'laconica'));
 392
 393         // search
 394         $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
 395         $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
 396         $m->connect('api/trends.json', array('action' => 'twitapitrends'));
 397
 398         // user stuff
 399
 400         foreach (array('subscriptions', 'subscribers',
 401                        'nudge', 'xrds', 'all', 'foaf',
 402                        'replies', 'inbox', 'outbox', 'microsummary') as $a) {
 403             $m->connect(':nickname/'.$a,
 404                         array('action' => $a),
 405                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 406         }
 407
 408         foreach (array('subscriptions', 'subscribers') as $a) {
 409             $m->connect(':nickname/'.$a.'/:tag',
 410                         array('action' => $a),
 411                         array('tag' => '[a-zA-Z0-9]+',
 412                               'nickname' => '[a-zA-Z0-9]{1,64}'));
 413         }
 414
 415         foreach (array('rss', 'groups') as $a) {
 416             $m->connect(':nickname/'.$a,
 417                         array('action' => 'user'.$a),
 418                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 419         }
 420
 421         foreach (array('all', 'replies', 'favorites') as $a) {
 422             $m->connect(':nickname/'.$a.'/rss',
 423                         array('action' => $a.'rss'),
 424                         array('nickname' => '[a-zA-Z0-9]{1,64}'));
 425         }
 426
 427         $m->connect(':nickname/favorites',
 428                     array('action' => 'showfavorites'),
 429                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 430
 431         $m->connect(':nickname/avatar/:size',
 432                     array('action' => 'avatarbynickname'),
 433                     array('size' => '(original|96|48|24)',
 434                           'nickname' => '[a-zA-Z0-9]{1,64}'));
 435
 436         $m->connect(':nickname/tag/:tag/rss',
 437             array('action' => 'userrss'),
 438             array('nickname' => '[a-zA-Z0-9]{1,64}'),
 439             array('tag' => '[a-zA-Z0-9]+'));
 440
 441         $m->connect(':nickname/tag/:tag',
 442                     array('action' => 'showstream'),
 443                     array('nickname' => '[a-zA-Z0-9]{1,64}'),
 444                     array('tag' => '[a-zA-Z0-9]+'));
 445
 446         $m->connect(':nickname',
 447                     array('action' => 'showstream'),
 448                     array('nickname' => '[a-zA-Z0-9]{1,64}'));
 449
 450         Event::handle('RouterInitialized', array($m));
 451
 452         return $m;
 453     }
 454
 455     function map($path)
 456     {
 457         try {
 458             $match = $this->m->match($path);
 459         } catch (Net_URL_Mapper_InvalidException $e) {
 460             common_log(LOG_ERR, "Problem getting route for $path - " .
 461                        $e->getMessage());
 462             $cac = new ClientErrorAction("Page not found.", 404);
 463             $cac->showPage();
 464         }
 465
 466         return $match;
 467     }
 468
 469     function build($action, $args=null, $params=null, $fragment=null)
 470     {
 471         $action_arg = array('action' => $action);
 472
 473         if ($args) {
 474             $args = array_merge($action_arg, $args);
 475         } else {
 476             $args = $action_arg;
 477         }
 478
 479         $url = $this->m->generate($args, $params, $fragment);
 480
 481         // Due to a bug in the Net_URL_Mapper code, the returned URL may
 482         // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
 483         // repair that here rather than modifying the upstream code...
 484
 485         $qpos = strpos($url, '?');
 486         if ($qpos !== false) {
 487             $url = substr($url, 0, $qpos+1) .
 488               str_replace('?', '&', substr($url, $qpos+1));
 489         }
 490         return $url;
 491     }
 492 }