3 * Laconica, the distributed open-source microblogging tool
5 * URL routing utilities
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.
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.
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/>.
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/
30 if (!defined('LACONICA')) {
34 require_once 'Net/URL/Mapper.php';
39 * Cheap wrapper around Net_URL_Mapper
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/
52 static $bare = array('requesttoken', 'accesstoken', 'userauthorization',
53 'postnotice', 'updateprofile', 'finishremotesubscribe',
54 'finishopenidlogin', 'finishaddopenid');
59 Router::$inst = new Router();
64 function __construct()
67 $this->m = $this->initialize();
73 $m = Net_URL_Mapper::getInstance();
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',
84 $m->connect('opensearch/notice', array('action' => 'opensearch',
89 $m->connect('doc/:title', array('action' => 'doc'));
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'));
99 // main stuff is repetitive
101 $main = array('login', 'logout', 'register', 'subscribe',
102 'unsubscribe', 'confirmaddress', 'recoverpassword',
103 'invite', 'favor', 'disfavor', 'sup',
104 'block', 'unblock', 'subedit',
105 'groupblock', 'groupunblock');
107 foreach ($main as $a) {
108 $m->connect('main/'.$a, array('action' => $a));
111 $m->connect('main/sup/:seconds', array('action' => 'sup'),
112 array('seconds' => '[0-9]+'));
114 $m->connect('main/tagother/:id', array('action' => 'tagother'));
118 foreach (array('register', 'confirmaddress', 'recoverpassword') as $c) {
119 $m->connect('main/'.$c.'/:code', array('action' => $c));
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_-]+'));
128 foreach (Router::$bare as $action) {
129 $m->connect('index.php?action=' . $action, array('action' => $action));
134 foreach (array('profile', 'avatar', 'password', 'openid', 'im',
135 'email', 'sms', 'twitter', 'userdesign', 'other') as $s) {
136 $m->connect('settings/'.$s, array('action' => $s.'settings'));
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'),
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'),
155 $m->connect('attachment/:attachment',
156 array('action' => 'attachment'),
157 array('attachment' => '[0-9]+'));
159 $m->connect('attachment/:attachment/ajax',
160 array('action' => 'attachment_ajax'),
161 array('attachment' => '[0-9]+'));
163 $m->connect('attachment/:attachment/thumbnail',
164 array('action' => 'attachment_thumbnail'),
165 array('attachment' => '[0-9]+'));
167 $m->connect('notice/new', array('action' => 'newnotice'));
168 $m->connect('notice/new?replyto=:replyto',
169 array('action' => 'newnotice'),
170 array('replyto' => '[A-Za-z0-9_-]+'));
172 $m->connect('notice/:notice/file',
173 array('action' => 'file'),
174 array('notice' => '[0-9]+'));
176 $m->connect('notice/:notice',
177 array('action' => 'shownotice'),
178 array('notice' => '[0-9]+'));
179 $m->connect('notice/delete', array('action' => 'deletenotice'));
180 $m->connect('notice/delete/:notice',
181 array('action' => 'deletenotice'),
182 array('notice' => '[0-9]+'));
186 $m->connect('conversation/:id',
187 array('action' => 'conversation'),
188 array('id' => '[0-9]+'));
190 $m->connect('message/new', array('action' => 'newmessage'));
191 $m->connect('message/new?to=:to', array('action' => 'newmessage'), array('to' => '[A-Za-z0-9_-]+'));
192 $m->connect('message/:message',
193 array('action' => 'showmessage'),
194 array('message' => '[0-9]+'));
196 $m->connect('user/:id',
197 array('action' => 'userbyid'),
198 array('id' => '[0-9]+'));
200 $m->connect('tags/', array('action' => 'publictagcloud'));
201 $m->connect('tag/', array('action' => 'publictagcloud'));
202 $m->connect('tags', array('action' => 'publictagcloud'));
203 $m->connect('tag', array('action' => 'publictagcloud'));
204 $m->connect('tag/:tag/rss',
205 array('action' => 'tagrss'),
206 array('tag' => '[a-zA-Z0-9]+'));
207 $m->connect('tag/:tag',
208 array('action' => 'tag'),
209 array('tag' => '[a-zA-Z0-9]+'));
211 $m->connect('peopletag/:tag',
212 array('action' => 'peopletag'),
213 array('tag' => '[a-zA-Z0-9]+'));
215 $m->connect('featured/', array('action' => 'featured'));
216 $m->connect('featured', array('action' => 'featured'));
217 $m->connect('favorited/', array('action' => 'favorited'));
218 $m->connect('favorited', array('action' => 'favorited'));
222 $m->connect('group/new', array('action' => 'newgroup'));
224 foreach (array('edit', 'join', 'leave') as $v) {
225 $m->connect('group/:nickname/'.$v,
226 array('action' => $v.'group'),
227 array('nickname' => '[a-zA-Z0-9]+'));
230 foreach (array('members', 'logo', 'rss', 'designsettings') as $n) {
231 $m->connect('group/:nickname/'.$n,
232 array('action' => 'group'.$n),
233 array('nickname' => '[a-zA-Z0-9]+'));
236 $m->connect('group/:nickname/blocked',
237 array('action' => 'blockedfromgroup'),
238 array('nickname' => '[a-zA-Z0-9]+'));
240 $m->connect('group/:nickname/makeadmin',
241 array('action' => 'makeadmin'),
242 array('nickname' => '[a-zA-Z0-9]+'));
244 $m->connect('group/:id/id',
245 array('action' => 'groupbyid'),
246 array('id' => '[0-9]+'));
248 $m->connect('group/:nickname',
249 array('action' => 'showgroup'),
250 array('nickname' => '[a-zA-Z0-9]+'));
252 $m->connect('group/', array('action' => 'groups'));
253 $m->connect('group', array('action' => 'groups'));
254 $m->connect('groups/', array('action' => 'groups'));
255 $m->connect('groups', array('action' => 'groups'));
257 // Twitter-compatible API
261 $m->connect('api/statuses/:method',
262 array('action' => 'api',
263 'apiaction' => 'statuses'),
264 array('method' => '(public_timeline|friends_timeline|user_timeline|update|replies|mentions|show|friends|followers|featured)(\.(atom|rss|xml|json))?'));
266 $m->connect('api/statuses/:method/:argument',
267 array('action' => 'api',
268 'apiaction' => 'statuses'),
269 array('method' => '(|user_timeline|friends_timeline|replies|mentions|show|destroy|friends|followers)'));
273 $m->connect('api/users/:method/:argument',
274 array('action' => 'api',
275 'apiaction' => 'users'),
276 array('method' => 'show(\.(xml|json))?'));
278 $m->connect('api/users/:method',
279 array('action' => 'api',
280 'apiaction' => 'users'),
281 array('method' => 'show(\.(xml|json))?'));
285 foreach (array('xml', 'json') as $e) {
286 $m->connect('api/direct_messages/new.'.$e,
287 array('action' => 'api',
288 'apiaction' => 'direct_messages',
289 'method' => 'create.'.$e));
292 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
293 $m->connect('api/direct_messages.'.$e,
294 array('action' => 'api',
295 'apiaction' => 'direct_messages',
296 'method' => 'direct_messages.'.$e));
299 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
300 $m->connect('api/direct_messages/sent.'.$e,
301 array('action' => 'api',
302 'apiaction' => 'direct_messages',
303 'method' => 'sent.'.$e));
306 $m->connect('api/direct_messages/destroy/:argument',
307 array('action' => 'api',
308 'apiaction' => 'direct_messages'));
312 $m->connect('api/friendships/:method/:argument',
313 array('action' => 'api',
314 'apiaction' => 'friendships'),
315 array('method' => '(create|destroy)'));
317 $m->connect('api/friendships/:method',
318 array('action' => 'api',
319 'apiaction' => 'friendships'),
320 array('method' => '(show|exists)(\.(xml|json))'));
324 $m->connect('api/friends/ids/:argument',
325 array('action' => 'api',
326 'apiaction' => 'statuses',
327 'method' => 'friendsIDs'));
329 foreach (array('xml', 'json') as $e) {
330 $m->connect('api/friends/ids.'.$e,
331 array('action' => 'api',
332 'apiaction' => 'statuses',
333 'method' => 'friendsIDs.'.$e));
336 $m->connect('api/followers/ids/:argument',
337 array('action' => 'api',
338 'apiaction' => 'statuses',
339 'method' => 'followersIDs'));
341 foreach (array('xml', 'json') as $e) {
342 $m->connect('api/followers/ids.'.$e,
343 array('action' => 'api',
344 'apiaction' => 'statuses',
345 'method' => 'followersIDs.'.$e));
350 $m->connect('api/account/:method',
351 array('action' => 'api',
352 'apiaction' => 'account'));
356 $m->connect('api/favorites/:method/:argument',
357 array('action' => 'api',
358 'apiaction' => 'favorites',
359 array('method' => '(create|destroy)')));
361 $m->connect('api/favorites/:argument',
362 array('action' => 'api',
363 'apiaction' => 'favorites',
364 'method' => 'favorites'));
366 foreach (array('xml', 'json', 'rss', 'atom') as $e) {
367 $m->connect('api/favorites.'.$e,
368 array('action' => 'api',
369 'apiaction' => 'favorites',
370 'method' => 'favorites.'.$e));
375 $m->connect('api/notifications/:method/:argument',
376 array('action' => 'api',
377 'apiaction' => 'favorites'));
381 $m->connect('api/blocks/:method/:argument',
382 array('action' => 'api',
383 'apiaction' => 'blocks'));
387 $m->connect('api/help/:method',
388 array('action' => 'api',
389 'apiaction' => 'help'));
393 $m->connect('api/laconica/:method',
394 array('action' => 'api',
395 'apiaction' => 'laconica'));
398 $m->connect('api/laconica/groups/:method/:argument',
399 array('action' => 'api',
400 'apiaction' => 'groups'));
402 $m->connect('api/laconica/groups/:method',
403 array('action' => 'api',
404 'apiaction' => 'groups'));
407 $m->connect('api/laconica/tags/:method/:argument',
408 array('action' => 'api',
409 'apiaction' => 'tags'));
411 $m->connect('api/laconica/tags/:method',
412 array('action' => 'api',
413 'apiaction' => 'tags'));
416 $m->connect('api/search.atom', array('action' => 'twitapisearchatom'));
417 $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
418 $m->connect('api/trends.json', array('action' => 'twitapitrends'));
422 foreach (array('subscriptions', 'subscribers',
423 'nudge', 'xrds', 'all', 'foaf',
424 'replies', 'inbox', 'outbox', 'microsummary') as $a) {
425 $m->connect(':nickname/'.$a,
426 array('action' => $a),
427 array('nickname' => '[a-zA-Z0-9]{1,64}'));
430 foreach (array('subscriptions', 'subscribers') as $a) {
431 $m->connect(':nickname/'.$a.'/:tag',
432 array('action' => $a),
433 array('tag' => '[a-zA-Z0-9]+',
434 'nickname' => '[a-zA-Z0-9]{1,64}'));
437 foreach (array('rss', 'groups') as $a) {
438 $m->connect(':nickname/'.$a,
439 array('action' => 'user'.$a),
440 array('nickname' => '[a-zA-Z0-9]{1,64}'));
443 foreach (array('all', 'replies', 'favorites') as $a) {
444 $m->connect(':nickname/'.$a.'/rss',
445 array('action' => $a.'rss'),
446 array('nickname' => '[a-zA-Z0-9]{1,64}'));
449 $m->connect(':nickname/favorites',
450 array('action' => 'showfavorites'),
451 array('nickname' => '[a-zA-Z0-9]{1,64}'));
453 $m->connect(':nickname/avatar/:size',
454 array('action' => 'avatarbynickname'),
455 array('size' => '(original|96|48|24)',
456 'nickname' => '[a-zA-Z0-9]{1,64}'));
458 $m->connect(':nickname/tag/:tag/rss',
459 array('action' => 'userrss'),
460 array('nickname' => '[a-zA-Z0-9]{1,64}'),
461 array('tag' => '[a-zA-Z0-9]+'));
463 $m->connect(':nickname/tag/:tag',
464 array('action' => 'showstream'),
465 array('nickname' => '[a-zA-Z0-9]{1,64}'),
466 array('tag' => '[a-zA-Z0-9]+'));
468 $m->connect(':nickname',
469 array('action' => 'showstream'),
470 array('nickname' => '[a-zA-Z0-9]{1,64}'));
472 Event::handle('RouterInitialized', array($m));
480 $match = $this->m->match($path);
481 } catch (Net_URL_Mapper_InvalidException $e) {
482 common_log(LOG_ERR, "Problem getting route for $path - " .
484 $cac = new ClientErrorAction("Page not found.", 404);
491 function build($action, $args=null, $params=null, $fragment=null)
493 $action_arg = array('action' => $action);
496 $args = array_merge($action_arg, $args);
501 $url = $this->m->generate($args, $params, $fragment);
503 // Due to a bug in the Net_URL_Mapper code, the returned URL may
504 // contain a malformed query of the form ?p1=v1?p2=v2?p3=v3. We
505 // repair that here rather than modifying the upstream code...
507 $qpos = strpos($url, '?');
508 if ($qpos !== false) {
509 $url = substr($url, 0, $qpos+1) .
510 str_replace('?', '&', substr($url, $qpos+1));