Merge branch 'urlroute' into 0.7.x

2 files changed, 373 insertions, 263 deletions

diff --git a/lib/router.php b/lib/router.php
new file mode 100644
index 000000000..d47ad7118
--- /dev/null
+++ b/lib/router.php
@@ -0,0 +1,363 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * URL routing utilities
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  URL
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once 'Net/URL/Mapper.php';
+
+/**
+ * URL Router
+ *
+ * Cheap wrapper around Net_URL_Mapper
+ *
+ * @category URL
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
+
+class Router
+{
+    static $m = null;
+    static $inst = null;
+
+    static function get()
+    {
+        if (!Router::$inst) {
+            Router::$inst = new Router();
+        }
+        return Router::$inst;
+    }
+
+    function __construct()
+    {
+        if (!$this->m) {
+            $this->m = $this->initialize();
+        }
+    }
+
+    function initialize() {
+
+        $m = Net_URL_Mapper::getInstance();
+
+        // In the "root"
+
+        $m->connect('', array('action' => 'public'));
+        $m->connect('rss', array('action' => 'publicrss'));
+        $m->connect('xrds', array('action' => 'publicxrds'));
+        $m->connect('featuredrss', array('action' => 'featuredrss'));
+        $m->connect('favoritedrss', array('action' => 'favoritedrss'));
+        $m->connect('opensearch/people', array('action' => 'opensearch',
+                                               'type' => 'people'));
+        $m->connect('opensearch/notice', array('action' => 'opensearch',
+                                               'type' => 'notice'));
+
+        // docs
+
+        $m->connect('doc/:title', array('action' => 'doc'));
+
+        // facebook
+
+        $m->connect('facebook', array('action' => 'facebookhome'));
+        $m->connect('facebook/index.php', array('action' => 'facebookhome'));
+        $m->connect('facebook/settings.php', array('action' => 'facebooksettings'));
+        $m->connect('facebook/invite.php', array('action' => 'facebookinvite'));
+        $m->connect('facebook/remove', array('action' => 'facebookremove'));
+
+        // main stuff is repetitive
+
+        $main = array('login', 'logout', 'register', 'subscribe',
+                      'unsubscribe', 'confirmaddress', 'recoverpassword',
+                      'invite', 'favor', 'disfavor', 'sup',
+                      'tagother', 'block');
+
+        foreach ($main as $a) {
+            $m->connect('main/'.$a, array('action' => $a));
+        }
+
+        // these take a code
+
+        foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
+            $m->connect('main/'.$c.'/:code', array('action' => $c));
+        }
+
+        // exceptional
+
+        $m->connect('main/openid', array('action' => 'openidlogin'));
+        $m->connect('main/remote', array('action' => 'remotesubscribe'));
+
+        // settings
+
+        foreach (array('profile', 'avatar', 'password', 'openid', 'im',
+                       'email', 'sms', 'twitter', 'other') as $s) {
+            $m->connect('settings/'.$s, array('action' => $s.'settings'));
+        }
+
+        // search
+
+        foreach (array('group', 'people', 'notice') as $s) {
+            $m->connect('search/'.$s, array('action' => $s.'search'));
+        }
+
+        $m->connect('search/notice/rss', array('action' => 'noticesearchrss'));
+
+        // notice
+
+        $m->connect('notice/new', array('action' => 'newnotice'));
+        $m->connect('notice/:notice',
+                    array('action' => 'shownotice'),
+                    array('notice' => '[0-9]+'));
+        $m->connect('notice/delete', array('action' => 'deletenotice'));
+        $m->connect('notice/delete/:notice',
+                    array('action' => 'deletenotice'),
+                    array('notice' => '[0-9]+'));
+
+        $m->connect('message/new', array('action' => 'newmessage'));
+        $m->connect('message/:message',
+                    array('action' => 'showmessage'),
+                    array('message' => '[0-9]+'));
+
+        $m->connect('user/:id',
+                    array('action' => 'userbyid'),
+                    array('id' => '[0-9]+'));
+
+        $m->connect('tags/', array('action' => 'publictagcloud'));
+        $m->connect('tag/', array('action' => 'publictagcloud'));
+        $m->connect('tags', array('action' => 'publictagcloud'));
+        $m->connect('tag', array('action' => 'publictagcloud'));
+        $m->connect('tag/:tag/rss',
+                    array('action' => 'tagrss'),
+                    array('tag' => '[a-zA-Z0-9]+'));
+        $m->connect('tag/:tag',
+                    array('action' => 'tag'),
+                    array('tag' => '[a-zA-Z0-9]+'));
+
+        $m->connect('peopletag/:tag',
+                    array('action' => 'peopletag'),
+                    array('tag' => '[a-zA-Z0-9]+'));
+
+        $m->connect('featured/', array('action' => 'featured'));
+        $m->connect('featured', array('action' => 'featured'));
+        $m->connect('favorited/', array('action' => 'favorited'));
+        $m->connect('favorited', array('action' => 'favorited'));
+
+        // groups
+
+        $m->connect('group/new', array('action' => 'newgroup'));
+
+        foreach (array('edit', 'join', 'leave') as $v) {
+            $m->connect('group/:nickname/'.$v,
+                        array('action' => $v.'group'),
+                        array('nickname' => '[a-zA-Z0-9]+'));
+        }
+
+        foreach (array('members', 'logo', 'rss') as $n) {
+            $m->connect('group/:nickname/'.$n,
+                        array('action' => 'group'.$n),
+                        array('nickname' => '[a-zA-Z0-9]+'));
+        }
+
+        $m->connect('group/:id/id',
+                    array('action' => 'groupbyid'),
+                    array('id' => '[0-9]+'));
+
+        $m->connect('group/:nickname',
+                    array('action' => 'showgroup'),
+                    array('nickname' => '[a-zA-Z0-9]+'));
+
+        $m->connect('group/', array('action' => 'groups'));
+        $m->connect('group', array('action' => 'groups'));
+        $m->connect('groups/', array('action' => 'groups'));
+        $m->connect('groups', array('action' => 'groups'));
+
+        // Twitter-compatible API
+
+        // statuses API
+
+        $m->connect('api/statuses/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'statuses'),
+                    array('method' => '(public_timeline|friends_timeline|user_timeline|update|replies|friends|followers|featured)(\.(atom|rss|xml|json))?'));
+
+        $m->connect('api/statuses/:method/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'statuses'),
+                    array('method' => '(user_timeline|show|destroy|friends|followers)'));
+
+        // users
+
+        $m->connect('api/users/show/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'users'));
+
+        $m->connect('api/users/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'users'),
+                    array('method' => 'show(\.(xml|json|atom|rss))?'));
+
+        // direct messages
+
+        $m->connect('api/direct_messages/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'direct_messages'),
+                    array('method' => '(sent|new)(\.(xml|json|atom|rss))?'));
+
+        $m->connect('api/direct_messages/destroy/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'direct_messages'));
+
+        $m->connect('api/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'direct_messages'),
+                    array('method' => 'direct_messages(\.(xml|json|atom|rss))?'));
+
+        // friendships
+
+        $m->connect('api/friendships/:method/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'friendships'),
+                    array('method' => '(create|destroy)'));
+
+        $m->connect('api/friendships/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'friendships'),
+                    array('method' => 'exists(\.(xml|json|rss|atom))'));
+
+        // account
+
+        $m->connect('api/account/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'account'));
+
+        // favorites
+
+        $m->connect('api/favorites/:method/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'favorites'));
+
+        $m->connect('api/favorites/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'favorites',
+                          'method' => 'favorites'));
+
+        $m->connect('api/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'favorites'),
+                    array('method' => 'favorites(\.(xml|json|rss|atom))?'));
+
+        // notifications
+
+        $m->connect('api/notifications/:method/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'favorites'));
+
+        // blocks
+
+        $m->connect('api/blocks/:method/:argument',
+                    array('action' => 'api',
+                          'apiaction' => 'blocks'));
+
+        // help
+
+        $m->connect('api/help/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'help'));
+
+        // laconica
+
+        $m->connect('api/laconica/:method',
+                    array('action' => 'api',
+                          'apiaction' => 'laconica'));
+
+        // user stuff
+
+        foreach (array('subscriptions', 'subscribers',
+                       'nudge', 'xrds', 'all', 'foaf',
+                       'replies', 'inbox', 'outbox', 'microsummary') as $a) {
+            $m->connect(':nickname/'.$a,
+                        array('action' => $a),
+                        array('nickname' => '[a-zA-Z0-9]{1,64}'));
+        }
+
+        foreach (array('subscriptions', 'subscribers') as $a) {
+            $m->connect(':nickname/'.$a.'/:tag',
+                        array('action' => $a),
+                        array('tag' => '[a-zA-Z0-9]+',
+                              'nickname' => '[a-zA-Z0-9]{1,64}'));
+        }
+
+        foreach (array('rss', 'groups') as $a) {
+            $m->connect(':nickname/'.$a,
+                        array('action' => 'user'.$a),
+                        array('nickname' => '[a-zA-Z0-9]{1,64}'));
+        }
+
+        foreach (array('all', 'replies', 'favorites') as $a) {
+            $m->connect(':nickname/'.$a.'/rss',
+                        array('action' => $a.'rss'),
+                        array('nickname' => '[a-zA-Z0-9]{1,64}'));
+        }
+
+        $m->connect(':nickname/favorites',
+                    array('action' => 'showfavorites'),
+                    array('nickname' => '[a-zA-Z0-9]{1,64}'));
+
+        $m->connect(':nickname/avatar/:size',
+                    array('action' => 'avatarbynickname'),
+                    array('size' => '(original|96|48|24)',
+                          'nickname' => '[a-zA-Z0-9]{1,64}'));
+
+        $m->connect(':nickname',
+                    array('action' => 'showstream'),
+                    array('nickname' => '[a-zA-Z0-9]{1,64}'));
+
+        return $m;
+    }
+
+    function map($path)
+    {
+        return $this->m->match($path);
+    }
+
+    function build($action, $args=null, $fragment=null)
+    {
+        $action_arg = array('action' => $action);
+
+        if ($args) {
+            $args = array_merge($action_arg, $args);
+        } else {
+            $args = $action_arg;
+        }
+
+        return $this->m->generate($args, null, $fragment);
+    }
+}
\ No newline at end of file
diff --git a/lib/util.php b/lib/util.php
index c5a092f63..9b38b5596 100644
--- a/lib/util.php
+++ b/lib/util.php
@@ -669,275 +669,22 @@ function common_relative_profile($sender, $nickname, $dt=null)
 
 function common_local_url($action, $args=null, $fragment=null)
 {
-    $url = null;
+    common_debug("Action = $action, args = " . (($args) ? '(' . implode($args, ',') . ')' : $args) . ", fragment = $fragment");
+    $r = Router::get();
+    $start = microtime();
+    $path = $r->build($action, $args, $fragment);
+    $end = microtime();
+    common_debug("Pathbuilding took " . ($end - $start));
+    if ($path) {
+    }
     if (common_config('site','fancy')) {
-        $url = common_fancy_url($action, $args);
+        $url = common_path(mb_substr($path, 1));
     } else {
-        $url = common_simple_url($action, $args);
-    }
-    if (!is_null($fragment)) {
-        $url .= '#'.$fragment;
+        $url = common_path('index.php'.$path);
     }
     return $url;
 }
 
-function common_fancy_url($action, $args=null)
-{
-    switch (strtolower($action)) {
-     case 'public':
-        if ($args && isset($args['page'])) {
-            return common_path('?page=' . $args['page']);
-        } else {
-            return common_path('');
-        }
-     case 'featured':
-        if ($args && isset($args['page'])) {
-            return common_path('featured?page=' . $args['page']);
-        } else {
-            return common_path('featured');
-        }
-     case 'favorited':
-        if ($args && isset($args['page'])) {
-            return common_path('favorited?page=' . $args['page']);
-        } else {
-            return common_path('favorited');
-        }
-     case 'publicrss':
-        return common_path('rss');
-     case 'publicatom':
-        return common_path("api/statuses/public_timeline.atom");
-     case 'publicxrds':
-        return common_path('xrds');
-     case 'tagrss':
-        return common_path('tag/' . $args['tag'] . '/rss');
-     case 'featuredrss':
-        return common_path('featuredrss');
-     case 'favoritedrss':
-        return common_path('favoritedrss');
-     case 'opensearch':
-        if ($args && $args['type']) {
-            return common_path('opensearch/'.$args['type']);
-        } else {
-            return common_path('opensearch/people');
-        }
-     case 'doc':
-        return common_path('doc/'.$args['title']);
-     case 'block':
-     case 'login':
-     case 'logout':
-     case 'subscribe':
-     case 'unsubscribe':
-     case 'invite':
-        return common_path('main/'.$action);
-     case 'tagother':
-        return common_path('main/tagother?id='.$args['id']);
-     case 'register':
-        if ($args && $args['code']) {
-            return common_path('main/register/'.$args['code']);
-        } else {
-            return common_path('main/register');
-        }
-     case 'remotesubscribe':
-        if ($args && $args['nickname']) {
-            return common_path('main/remote?nickname=' . $args['nickname']);
-        } else {
-            return common_path('main/remote');
-        }
-     case 'nudge':
-        return common_path($args['nickname'].'/nudge');
-     case 'openidlogin':
-        return common_path('main/openid');
-     case 'profilesettings':
-        return common_path('settings/profile');
-     case 'passwordsettings':
-        return common_path('settings/password');
-     case 'emailsettings':
-        return common_path('settings/email');
-     case 'openidsettings':
-        return common_path('settings/openid');
-     case 'smssettings':
-        return common_path('settings/sms');
-     case 'twittersettings':
-        return common_path('settings/twitter');
-     case 'othersettings':
-        return common_path('settings/other');
-     case 'deleteprofile':
-        return common_path('settings/delete');
-     case 'newnotice':
-        if ($args && $args['replyto']) {
-            return common_path('notice/new?replyto='.$args['replyto']);
-        } else {
-            return common_path('notice/new');
-        }
-     case 'shownotice':
-        return common_path('notice/'.$args['notice']);
-     case 'deletenotice':
-        if ($args && $args['notice']) {
-            return common_path('notice/delete/'.$args['notice']);
-        } else {
-            return common_path('notice/delete');
-        }
-     case 'microsummary':
-     case 'xrds':
-     case 'foaf':
-        return common_path($args['nickname'].'/'.$action);
-     case 'all':
-     case 'replies':
-     case 'inbox':
-     case 'outbox':
-        if ($args && isset($args['page'])) {
-            return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
-        } else {
-            return common_path($args['nickname'].'/'.$action);
-        }
-     case 'subscriptions':
-     case 'subscribers':
-        $nickname = $args['nickname'];
-        unset($args['nickname']);
-        if (isset($args['tag'])) {
-            $tag = $args['tag'];
-            unset($args['tag']);
-        }
-        $params = http_build_query($args);
-        if ($params) {
-            return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
-        } else {
-            return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
-        }
-     case 'allrss':
-        return common_path($args['nickname'].'/all/rss');
-     case 'repliesrss':
-        return common_path($args['nickname'].'/replies/rss');
-     case 'userrss':
-        if (isset($args['limit']))
-          return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
-        return common_path($args['nickname'].'/rss');
-     case 'showstream':
-        if ($args && isset($args['page'])) {
-            return common_path($args['nickname'].'?page=' . $args['page']);
-        } else {
-            return common_path($args['nickname']);
-        }
-
-     case 'usertimeline':
-        return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
-     case 'confirmaddress':
-        return common_path('main/confirmaddress/'.$args['code']);
-     case 'userbyid':
-        return common_path('user/'.$args['id']);
-     case 'recoverpassword':
-        $path = 'main/recoverpassword';
-        if ($args['code']) {
-            $path .= '/' . $args['code'];
-        }
-        return common_path($path);
-     case 'imsettings':
-        return common_path('settings/im');
-     case 'avatarsettings':
-        return common_path('settings/avatar');
-     case 'groupsearch':
-        return common_path('search/group' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'peoplesearch':
-        return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'noticesearch':
-        return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'noticesearchrss':
-        return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'avatarbynickname':
-        return common_path($args['nickname'].'/avatar/'.$args['size']);
-     case 'tag':
-        $path = 'tag/' . $args['tag'];
-        unset($args['tag']);
-        return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'publictagcloud':
-        return common_path('tags');
-     case 'peopletag':
-        $path = 'peopletag/' . $args['tag'];
-        unset($args['tag']);
-        return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'tags':
-        return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'favor':
-        return common_path('main/favor');
-     case 'disfavor':
-        return common_path('main/disfavor');
-     case 'showfavorites':
-        if ($args && isset($args['page'])) {
-            return common_path($args['nickname'].'/favorites?page=' . $args['page']);
-        } else {
-            return common_path($args['nickname'].'/favorites');
-        }
-     case 'favoritesrss':
-        return common_path($args['nickname'].'/favorites/rss');
-     case 'showmessage':
-        return common_path('message/' . $args['message']);
-     case 'newmessage':
-        return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'api':
-        // XXX: do fancy URLs for all the API methods
-        switch (strtolower($args['apiaction'])) {
-         case 'statuses':
-            switch (strtolower($args['method'])) {
-             case 'user_timeline.rss':
-                return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
-             case 'user_timeline.atom':
-                return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
-             case 'user_timeline.json':
-                return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
-             case 'user_timeline.xml':
-                return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
-             default: return common_simple_url($action, $args);
-            }
-         default: return common_simple_url($action, $args);
-        }
-     case 'sup':
-        if ($args && isset($args['seconds'])) {
-            return common_path('main/sup?seconds='.$args['seconds']);
-        } else {
-            return common_path('main/sup');
-        }
-     case 'newgroup':
-        return common_path('group/new');
-     case 'showgroup':
-        return common_path('group/'.$args['nickname'] . (($args['page']) ? ('?page=' . $args['page']) : ''));
-     case 'editgroup':
-        return common_path('group/'.$args['nickname'].'/edit');
-     case 'joingroup':
-        return common_path('group/'.$args['nickname'].'/join');
-     case 'leavegroup':
-        return common_path('group/'.$args['nickname'].'/leave');
-     case 'groupbyid':
-        return common_path('group/'.$args['id'].'/id');
-     case 'grouprss':
-        return common_path('group/'.$args['nickname'].'/rss');
-     case 'groupmembers':
-        return common_path('group/'.$args['nickname'].'/members' . (($args['page']) ? ('?page=' . $args['page']) : ''));
-     case 'grouplogo':
-        return common_path('group/'.$args['nickname'].'/logo');
-     case 'usergroups':
-        $nickname = $args['nickname'];
-        unset($args['nickname']);
-        return common_path($nickname.'/groups' . (($args) ? ('?' . http_build_query($args)) : ''));
-     case 'groups':
-        return common_path('group' . (($args) ? ('?' . http_build_query($args)) : ''));
-     default:
-        return common_simple_url($action, $args);
-    }
-}
-
-function common_simple_url($action, $args=null)
-{
-    global $config;
-    /* XXX: pretty URLs */
-    $extra = '';
-    if ($args) {
-        foreach ($args as $key => $value) {
-            $extra .= "&${key}=${value}";
-        }
-    }
-    return common_path("index.php?action=${action}${extra}");
-}
-
 function common_path($relative)
 {
     global $config;