3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, HTML, user, files) */
24 function common_server_error($msg, $code=500) {
25 static $status = array(500 => 'Internal Server Error',
26 501 => 'Not Implemented',
28 503 => 'Service Unavailable',
29 504 => 'Gateway Timeout',
30 505 => 'HTTP Version Not Supported');
32 if (!array_key_exists($code, $status)) {
36 $status_string = $status[$code];
38 header('HTTP/1.1 '.$code.' '.$status_string);
39 header('Content-type: text/plain');
47 function common_user_error($msg, $code=400) {
48 static $status = array(400 => 'Bad Request',
49 401 => 'Unauthorized',
50 402 => 'Payment Required',
53 405 => 'Method Not Allowed',
54 406 => 'Not Acceptable',
55 407 => 'Proxy Authentication Required',
56 408 => 'Request Timeout',
59 411 => 'Length Required',
60 412 => 'Precondition Failed',
61 413 => 'Request Entity Too Large',
62 414 => 'Request-URI Too Long',
63 415 => 'Unsupported Media Type',
64 416 => 'Requested Range Not Satisfiable',
65 417 => 'Expectation Failed');
67 if (!array_key_exists($code, $status)) {
71 $status_string = $status[$code];
73 header('HTTP/1.1 '.$code.' '.$status_string);
75 common_show_header('Error');
76 common_element('div', array('class' => 'error'), $msg);
82 # Start an HTML element
83 function common_element_start($tag, $attrs=NULL) {
85 $xw->startElement($tag);
86 if (is_array($attrs)) {
87 foreach ($attrs as $name => $value) {
88 $xw->writeAttribute($name, $value);
90 } else if (is_string($attrs)) {
91 $xw->writeAttribute('class', $attrs);
95 function common_element_end($tag) {
97 # TODO: switch based on $tag
98 $xw->fullEndElement();
101 function common_element($tag, $attrs=NULL, $content=NULL) {
102 common_element_start($tag, $attrs);
105 common_element_end($tag);
108 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
110 $xw = new XMLWriter();
111 $xw->openURI('php://output');
112 $xw->setIndent(true);
113 $xw->startDocument('1.0', 'UTF-8');
115 $xw->writeDTD($doc, $public, $system);
119 function common_end_xml() {
125 define('PAGE_TYPE_PREFS', 'text/html,application/xhtml+xml,application/xml;q=0.3,text/xml;q=0.2');
127 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
130 $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
132 # XXX: allow content negotiation for RDF, RSS, or XRDS
134 $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
135 common_accept_to_prefs(PAGE_TYPE_PREFS));
138 common_user_error(_t('This page is not available in a media type you accept'), 406);
142 header('Content-Type: '.$type);
144 common_start_xml('html',
145 '-//W3C//DTD XHTML 1.0 Strict//EN',
146 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
148 # FIXME: correct language for interface
150 common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
154 common_element_start('head');
155 common_element('title', NULL,
156 $pagetitle . " - " . $config['site']['name']);
157 common_element('link', array('rel' => 'stylesheet',
158 'type' => 'text/css',
159 'href' => theme_path('display.css'),
160 'media' => 'screen, projection, tv'));
161 foreach (array(6,7) as $ver) {
162 if (file_exists(theme_file('ie'.$ver.'.css'))) {
163 # Yes, IE people should be put in jail.
164 $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
165 'href="'.theme_path('ie'.$ver.'.css').'" /><![endif]');
169 common_element('script', array('type' => 'text/javascript',
170 'src' => common_path('js/jquery.min.js')),
172 common_element('script', array('type' => 'text/javascript',
173 'src' => common_path('js/util.js')),
178 call_user_func($callable, $data);
180 call_user_func($callable);
183 common_element_end('head');
184 common_element_start('body');
185 common_element_start('div', array('id' => 'wrap'));
186 common_element_start('div', array('id' => 'header'));
188 if ((is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
189 || file_exists(theme_file('logo.png')))
191 common_element_start('a', array('href' => common_local_url('public')));
192 common_element('img', array('src' => ($config['site']['logo']) ?
193 ($config['site']['logo']) : theme_path('logo.png'),
194 'alt' => $config['site']['name'],
196 common_element_end('a');
198 common_element_start('p', array('id' => 'branding'));
199 common_element('a', array('href' => common_local_url('public')),
200 $config['site']['name']);
201 common_element_end('p');
204 common_element('h1', 'pagetitle', $pagetitle);
208 call_user_func($headercall, $data);
210 call_user_func($headercall);
213 common_element_end('div');
214 common_element_start('div', array('id' => 'content'));
217 function common_show_footer() {
219 common_element_end('div'); # content div
221 common_element_start('div', array('id' => 'footer'));
222 common_element_start('div', 'laconica');
223 if (common_config('site', 'broughtby')) {
224 $instr = _t('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
226 $instr = _t('**%%site.name%%** is a microblogging service. ');
228 $instr .= _t('It runs the [Laconica](http://laconi.ca/) ' .
229 'microblogging software, version ' . LACONICA_VERSION . ', ' .
230 'available under the ' .
231 '[GNU Affero General Public License]' .
232 '(http://www.fsf.org/licensing/licenses/agpl-3.0.html).');
233 $output = common_markup_to_html($instr);
235 common_element_end('div');
236 common_element('img', array('id' => 'cc',
237 'src' => $config['license']['image'],
238 'alt' => $config['license']['title']));
239 common_element_start('p');
240 common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
241 common_element('a', array('class' => 'license',
243 href => $config['license']['url']),
244 $config['license']['title']);
245 common_text(_t('. Contributors should be attributed by full name or nickname.'));
246 common_element_end('p');
247 common_element_end('div');
248 common_element_end('div');
249 common_element_end('body');
250 common_element_end('html');
254 function common_text($txt) {
259 function common_raw($xml) {
264 function common_nav_menu() {
265 $user = common_current_user();
266 common_element_start('ul', array('id' => 'nav'));
268 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
271 common_menu_item(common_local_url('public'), _t('Public'));
272 common_menu_item(common_local_url('doc', array('title' => 'help')),
275 common_menu_item(common_local_url('profilesettings'),
277 common_menu_item(common_local_url('logout'),
280 common_menu_item(common_local_url('login'), _t('Login'));
281 common_menu_item(common_local_url('register'), _t('Register'));
282 common_menu_item(common_local_url('openidlogin'), _t('OpenID'));
284 common_element_end('ul');
287 function common_foot_menu() {
288 common_element_start('ul', array('id' => 'nav_sub'));
289 common_menu_item(common_local_url('doc', array('title' => 'about')),
291 common_menu_item(common_local_url('doc', array('title' => 'faq')),
293 common_menu_item(common_local_url('doc', array('title' => 'privacy')),
295 common_menu_item(common_local_url('doc', array('title' => 'source')),
297 common_menu_item(common_local_url('doc', array('title' => 'contact')),
299 common_element_end('ul');
302 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
305 $lattrs['class'] = 'current';
307 common_element_start('li', $lattrs);
308 $attrs['href'] = $url;
310 $attrs['title'] = $title;
312 common_element('a', $attrs, $text);
313 common_element_end('li');
316 function common_input($id, $label, $value=NULL,$instructions=NULL) {
317 common_element_start('p');
318 common_element('label', array('for' => $id), $label);
319 $attrs = array('name' => $id,
321 'class' => 'input_text',
324 $attrs['value'] = htmlspecialchars($value);
326 common_element('input', $attrs);
328 common_element('span', 'input_instructions', $instructions);
330 common_element_end('p');
333 function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true')
335 common_element_start('p');
336 $attrs = array('name' => $id,
337 'type' => 'checkbox',
338 'class' => 'checkbox',
341 $attrs['value'] = htmlspecialchars($value);
344 $attrs['checked'] = 'checked';
346 common_element('input', $attrs);
349 common_element('span', 'checkbox_label', $label);
352 common_element('span', 'input_instructions', $instructions);
354 common_element_end('p');
357 function common_hidden($id, $value) {
358 common_element('input', array('name' => $id,
364 function common_password($id, $label, $instructions=NULL) {
365 common_element_start('p');
366 common_element('label', array('for' => $id), $label);
367 $attrs = array('name' => $id,
368 'type' => 'password',
369 'class' => 'password',
371 common_element('input', $attrs);
373 common_element('span', 'input_instructions', $instructions);
375 common_element_end('p');
378 function common_submit($id, $label) {
380 common_element_start('p');
381 common_element('input', array('type' => 'submit',
386 common_element_end('p');
389 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
390 common_element_start('p');
391 common_element('label', array('for' => $id), $label);
392 common_element('textarea', array('rows' => 3,
396 ($content) ? $content : '');
398 common_element('span', 'input_instructions', $instructions);
400 common_element_end('p');
403 # salted, hashed passwords are stored in the DB
405 function common_munge_password($password, $id) {
406 return md5($password . $id);
409 # check if a username exists and has matching password
410 function common_check_user($nickname, $password) {
411 $user = User::staticGet('nickname', $nickname);
412 if (is_null($user)) {
415 return (0 == strcmp(common_munge_password($password, $user->id),
420 # is the current user logged in?
421 function common_logged_in() {
422 return (!is_null(common_current_user()));
425 function common_have_session() {
426 return (0 != strcmp(session_id(), ''));
429 function common_ensure_session() {
430 if (!common_have_session()) {
435 function common_set_user($nickname) {
436 if (is_null($nickname) && common_have_session()) {
437 unset($_SESSION['userid']);
440 $user = User::staticGet('nickname', $nickname);
442 common_ensure_session();
443 $_SESSION['userid'] = $user->id;
452 function common_set_cookie($key, $value, $expiration=0) {
453 $path = common_config('site', 'path');
454 $server = common_config('site', 'server');
456 if ($path && ($path != '/')) {
457 $cookiepath = '/' . $path . '/';
461 return setcookie($key,
468 define('REMEMBERME', 'rememberme');
469 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60);
471 function common_rememberme() {
472 $user = common_current_user();
476 $rm = new Remember_me();
477 $rm->code = common_good_rand(16);
478 $rm->user_id = $user->id;
479 $result = $rm->insert();
481 common_log_db_error($rm, 'INSERT', __FILE__);
484 common_set_cookie(REMEMBERME,
485 implode(':', array($rm->user_id, $rm->code)),
486 time() + REMEMBERME_EXPIRY);
490 function common_remembered_user() {
493 $packed = $_COOKIE[REMEMBERME];
495 list($id, $code) = explode(':', $packed);
497 $rm = Remember_me::staticGet($code);
498 if ($rm && ($rm->user_id == $id)) {
499 $user = User::staticGet($rm->user_id);
502 $result = $rm->delete();
504 common_log_db_error($rm, 'DELETE', __FILE__);
507 common_set_user($user->nickname);
508 common_real_login(false);
509 # We issue a new cookie, so they can log in
510 # automatically again after this session
520 # must be called with a valid user!
522 function common_forgetme() {
523 common_set_cookie(REMEMBERME, '', 0);
526 # who is the current user?
527 function common_current_user() {
528 if ($_REQUEST[session_name()]) {
529 common_ensure_session();
530 $id = $_SESSION['userid'];
532 # note: this should cache
533 $user = User::staticGet($id);
537 # that didn't work; try to remember
538 $user = common_remembered_user();
542 # Logins that are 'remembered' aren't 'real' -- they're subject to
543 # cookie-stealing. So, we don't let them do certain things. New reg,
544 # OpenID, and password logins _are_ real.
546 function common_real_login($real=true) {
547 common_ensure_session();
548 $_SESSION['real_login'] = $real;
551 function common_is_real_login() {
552 return common_logged_in() && $_SESSION['real_login'];
555 # get canonical version of nickname for comparison
556 function common_canonical_nickname($nickname) {
557 # XXX: UTF-8 canonicalization (like combining chars)
558 return strtolower($nickname);
561 # get canonical version of email for comparison
562 function common_canonical_email($email) {
563 # XXX: canonicalize UTF-8
564 # XXX: lcase the domain part
568 define('URL_REGEX', '^|[ \t\r\n])((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file|prospero|aim|webcal):(([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2}){2,}(#([a-zA-Z0-9][a-zA-Z0-9$_.+!*(),;/?:@&~=%-]*))?([A-Za-z0-9$_+!*();/?:~-]))');
570 function common_render_content($text, $notice) {
571 $r = htmlspecialchars($text);
572 $id = $notice->profile_id;
573 $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
574 $r = preg_replace('/(^|\s+)@([a-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
580 function common_at_link($sender_id, $nickname) {
581 $sender = Profile::staticGet($sender_id);
582 $recipient = common_relative_profile($sender, $nickname);
584 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink">'.$nickname.'</a>';
590 function common_relative_profile($sender, $nickname, $dt) {
591 # Try to find profiles this profile is subscribed to that have this nickname
592 $recipient = new Profile();
593 # XXX: use a join instead of a subquery
594 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
595 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
596 if ($recipient->find(TRUE)) {
597 # XXX: should probably differentiate between profiles with
598 # the same name by date of most recent update
601 # Try to find profiles that listen to this profile and that have this nickname
602 $recipient = new Profile();
603 # XXX: use a join instead of a subquery
604 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
605 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
606 if ($recipient->find(TRUE)) {
607 # XXX: should probably differentiate between profiles with
608 # the same name by date of most recent update
611 # If this is a local user, try to find a local user with that nickname.
612 $sender = User::staticGet($sender->id);
614 $recipient_user = User::staticGet('nickname', $nickname);
615 if ($recipient_user) {
616 return $recipient_user->getProfile();
619 # Otherwise, no links. @messages from local users to remote users,
620 # or from remote users to other remote users, are just
621 # outside our ability to make intelligent guesses about
625 // where should the avatar go for this user?
627 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
631 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
633 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
637 function common_avatar_path($filename) {
639 return INSTALLDIR . '/avatar/' . $filename;
642 function common_avatar_url($filename) {
643 return common_path('avatar/'.$filename);
646 function common_avatar_display_url($avatar) {
647 $server = common_config('avatar', 'server');
649 return 'http://'.$server.'/'.$avatar->filename;
655 function common_default_avatar($size) {
656 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
657 AVATAR_STREAM_SIZE => 'stream',
658 AVATAR_MINI_SIZE => 'mini');
659 return theme_path('default-avatar-'.$sizenames[$size].'.png');
662 function common_local_url($action, $args=NULL) {
664 if ($config['site']['fancy']) {
665 return common_fancy_url($action, $args);
667 return common_simple_url($action, $args);
671 function common_fancy_url($action, $args=NULL) {
672 switch (strtolower($action)) {
674 if ($args && $args['page']) {
675 return common_path('?page=' . $args['page']);
677 return common_path('');
680 return common_path('rss');
682 return common_path('xrds');
684 return common_path('doc/'.$args['title']);
690 return common_path('main/'.$action);
691 case 'remotesubscribe':
692 if ($args && $args['nickname']) {
693 return common_path('main/remote?nickname=' . $args['nickname']);
695 return common_path('main/remote');
698 return common_path('main/openid');
701 return common_path('settings/'.$action);
702 case 'profilesettings':
703 return common_path('settings/profile');
704 case 'openidsettings':
705 return common_path('settings/openid');
707 return common_path('notice/new');
709 return common_path('notice/'.$args['notice']);
712 return common_path($args['nickname'].'/'.$action);
713 case 'subscriptions':
717 if ($args && $args['page']) {
718 return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
720 return common_path($args['nickname'].'/'.$action);
723 return common_path($args['nickname'].'/all/rss');
725 return common_path($args['nickname'].'/rss');
727 if ($args && $args['page']) {
728 return common_path($args['nickname'].'?page=' . $args['page']);
730 return common_path($args['nickname']);
732 case 'confirmaddress':
733 return common_path('main/confirmaddress/'.$args['code']);
735 return common_path('user/'.$args['id']);
736 case 'recoverpassword':
737 $path = 'main/recoverpassword';
739 $path .= '/' . $args['code'];
741 return common_path($path);
743 return common_path('settings/im');
745 return common_simple_url($action, $args);
749 function common_simple_url($action, $args=NULL) {
751 /* XXX: pretty URLs */
754 foreach ($args as $key => $value) {
755 $extra .= "&${key}=${value}";
758 return common_path("index.php?action=${action}${extra}");
761 function common_path($relative) {
763 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
764 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
767 function common_date_string($dt) {
768 // XXX: do some sexy date formatting
769 // return date(DATE_RFC822, $dt);
774 if ($now < $t) { # that shouldn't happen!
775 return common_exact_date($dt);
776 } else if ($diff < 60) {
777 return _t('a few seconds ago');
778 } else if ($diff < 92) {
779 return _t('about a minute ago');
780 } else if ($diff < 3300) {
781 return _t('about ') . round($diff/60) . _t(' minutes ago');
782 } else if ($diff < 5400) {
783 return _t('about an hour ago');
784 } else if ($diff < 22 * 3600) {
785 return _t('about ') . round($diff/3600) . _t(' hours ago');
786 } else if ($diff < 37 * 3600) {
787 return _t('about a day ago');
788 } else if ($diff < 24 * 24 * 3600) {
789 return _t('about ') . round($diff/(24*3600)) . _t(' days ago');
790 } else if ($diff < 46 * 24 * 3600) {
791 return _t('about a month ago');
792 } else if ($diff < 330 * 24 * 3600) {
793 return _t('about ') . round($diff/(30*24*3600)) . _t(' months ago');
794 } else if ($diff < 480 * 24 * 3600) {
795 return _t('about a year ago');
797 return common_exact_date($dt);
801 function common_exact_date($dt) {
803 return date(DATE_RFC850, $t);
806 function common_date_w3dtf($dt) {
808 return date(DATE_W3C, $t);
811 function common_redirect($url, $code=307) {
812 static $status = array(301 => "Moved Permanently",
815 307 => "Temporary Redirect");
816 header("Status: ${code} $status[$code]");
817 header("Location: $url");
819 common_start_xml('a',
820 '-//W3C//DTD XHTML 1.0 Strict//EN',
821 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
822 common_element('a', array('href' => $url), $url);
826 function common_save_replies($notice) {
827 # extract all @messages
828 $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $notice->content, $match);
832 $sender = Profile::staticGet($notice->profile_id);
833 # store replied only for first @ (what user/notice what the reply directed,
834 # we assume first @ is it)
835 for ($i=0; $i<count($match[1]); $i++) {
836 $nickname = $match[1][$i];
837 $recipient = common_relative_profile($sender, $nickname, $notice->created);
842 $reply_for = $recipient;
844 $reply = new Reply();
845 $reply->notice_id = $notice->id;
846 $reply->profile_id = $recipient->id;
847 $reply->created = DB_DataObject_Cast::dateTime();
848 $recipient_notice = $reply_for->getCurrentNotice($notice->created);
849 $reply->replied_id = $recipient_notice->id;
850 $id = $reply->insert();
852 common_server_error(_t('Problem saving reply.'));
858 function common_broadcast_notice($notice, $remote=false) {
859 if (common_config('queue', 'enabled')) {
861 return common_enqueue_notice($notice);
863 return common_real_broadcast($notice, $remote);
867 # Stick the notice on the queue
869 function common_enqueue_notice($notice) {
870 common_log(LOG_INFO, 'start queueing notice ID = ' . $notice->id);
871 $qi = new Queue_item();
872 $qi->notice_id = $notice->id;
873 $qi->created = DB_DataObject_Cast::dateTime();
874 $result = $qi->insert();
875 if ($result === FALSE) {
876 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
877 common_log(LOG_ERROR, 'DB error inserting queue item: ' . $last_error->message);
880 common_log(LOG_INFO, 'complete queueing notice ID = ' . $notice->id);
884 function common_real_broadcast($notice, $remote=false) {
887 # Make sure we have the OMB stuff
888 require_once(INSTALLDIR.'/lib/omb.php');
889 $success = omb_broadcast_remote_subscribers($notice);
891 common_log(LOG_ERROR, 'Error in OMB broadcast for notice ' . $notice->id);
895 require_once(INSTALLDIR.'/lib/jabber.php');
896 $success = jabber_broadcast_notice($notice);
898 common_log(LOG_ERROR, 'Error in jabber broadcast for notice ' . $notice->id);
901 // XXX: broadcast notices to SMS
902 // XXX: broadcast notices to other IM
906 function common_broadcast_profile($profile) {
907 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
908 require_once(INSTALLDIR.'/lib/omb.php');
909 omb_broadcast_profile($profile);
910 // XXX: Other broadcasts...?
914 function common_profile_url($nickname) {
915 return common_local_url('showstream', array('nickname' => $nickname));
918 # Don't call if nobody's logged in
920 function common_notice_form($action=NULL, $content=NULL) {
921 $user = common_current_user();
922 assert(!is_null($user));
923 common_element_start('form', array('id' => 'status_form',
925 'action' => common_local_url('newnotice')));
926 common_element_start('p');
927 common_element('label', array('for' => 'status_textarea',
928 'id' => 'status_label'),
929 _t('What\'s up, ').$user->nickname.'?');
930 common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
931 common_element('textarea', array('id' => 'status_textarea',
934 'name' => 'status_textarea'),
935 ($content) ? $content : '');
937 common_hidden('returnto', $action);
939 common_element('input', array('id' => 'status_submit',
940 'name' => 'status_submit',
942 'value' => _t('Send')));
943 common_element_end('p');
944 common_element_end('form');
947 function common_mint_tag($extra) {
950 'tag:'.$config['tag']['authority'].','.
951 $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
954 # Should make up a reasonable root URL
956 function common_root_url() {
957 return common_path('');
960 # returns $bytes bytes of random data as a hexadecimal string
961 # "good" here is a goal and not a guarantee
963 function common_good_rand($bytes) {
964 # XXX: use random.org...?
965 if (file_exists('/dev/urandom')) {
966 return common_urandom($bytes);
967 } else { # FIXME: this is probably not good enough
968 return common_mtrand($bytes);
972 function common_urandom($bytes) {
973 $h = fopen('/dev/urandom', 'rb');
975 $src = fread($h, $bytes);
978 for ($i = 0; $i < $bytes; $i++) {
979 $enc .= sprintf("%02x", (ord($src[$i])));
984 function common_mtrand($bytes) {
986 for ($i = 0; $i < $bytes; $i++) {
987 $enc .= sprintf("%02x", mt_rand(0, 255));
992 function common_set_returnto($url) {
993 common_ensure_session();
994 $_SESSION['returnto'] = $url;
997 function common_get_returnto() {
998 common_ensure_session();
999 return $_SESSION['returnto'];
1002 function common_timestamp() {
1003 return date('YmdHis');
1006 // XXX: set up gettext
1012 function common_ensure_syslog() {
1013 static $initialized = false;
1014 if (!$initialized) {
1016 define_syslog_variables();
1017 openlog($config['syslog']['appname'], 0, LOG_USER);
1018 $initialized = true;
1022 function common_log($priority, $msg, $filename=NULL) {
1023 common_ensure_syslog();
1024 syslog($priority, $msg);
1027 function common_debug($msg, $filename=NULL) {
1029 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1031 common_log(LOG_DEBUG, $msg);
1035 function common_log_db_error(&$object, $verb, $filename=NULL) {
1036 $objstr = common_log_objstring($object);
1037 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1038 common_log(LOG_ERROR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1041 function common_log_objstring(&$object) {
1042 if (is_null($object)) {
1045 $arr = $object->toArray();
1047 foreach ($arr as $k => $v) {
1048 $fields[] = "$k='$v'";
1050 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1054 function common_valid_http_url($url) {
1055 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1058 function common_valid_tag($tag) {
1059 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1060 return (Validate::email($matches[1]) ||
1061 preg_match('/^([\w-\.]+)$/', $matches[1]));
1066 # Does a little before-after block for next/prev page
1068 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
1070 if ($have_before || $have_after) {
1071 common_element_start('div', array('id' => 'pagination'));
1072 common_element_start('ul', array('id' => 'nav_pagination'));
1076 $pargs = array('page' => $page-1);
1077 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1079 common_element_start('li', 'before');
1080 common_element('a', array('href' => common_local_url($action, $newargs)),
1082 common_element_end('li');
1086 $pargs = array('page' => $page+1);
1087 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1088 common_element_start('li', 'after');
1089 common_element('a', array('href' => common_local_url($action, $newargs)),
1091 common_element_end('li');
1094 if ($have_before || $have_after) {
1095 common_element_end('ul');
1096 common_element_end('div');
1100 /* Following functions are copied from MediaWiki GlobalFunctions.php
1101 * and written by Evan Prodromou. */
1103 function common_accept_to_prefs($accept, $def = '*/*') {
1104 # No arg means accept anything (per HTTP spec)
1106 return array($def => 1);
1111 $parts = explode(',', $accept);
1113 foreach($parts as $part) {
1114 # FIXME: doesn't deal with params like 'text/html; level=1'
1115 @list($value, $qpart) = explode(';', $part);
1117 if(!isset($qpart)) {
1119 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1120 $prefs[$value] = $match[1];
1127 function common_mime_type_match($type, $avail) {
1128 if(array_key_exists($type, $avail)) {
1131 $parts = explode('/', $type);
1132 if(array_key_exists($parts[0] . '/*', $avail)) {
1133 return $parts[0] . '/*';
1134 } elseif(array_key_exists('*/*', $avail)) {
1142 function common_negotiate_type($cprefs, $sprefs) {
1145 foreach(array_keys($sprefs) as $type) {
1146 $parts = explode('/', $type);
1147 if($parts[1] != '*') {
1148 $ckey = common_mime_type_match($type, $cprefs);
1150 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1155 foreach(array_keys($cprefs) as $type) {
1156 $parts = explode('/', $type);
1157 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1158 $skey = common_mime_type_match($type, $sprefs);
1160 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1166 $besttype = "text/html";
1168 foreach(array_keys($combine) as $type) {
1169 if($combine[$type] > $bestq) {
1171 $bestq = $combine[$type];
1178 function common_config($main, $sub) {
1180 return $config[$main][$sub];
1183 function common_copy_args($from) {
1185 $strip = get_magic_quotes_gpc();
1186 foreach ($from as $k => $v) {
1187 $to[$k] = ($strip) ? stripslashes($v) : $v;
1192 function common_user_uri(&$user) {
1193 return common_local_url('userbyid', array('id' => $user->id));
1196 function common_notice_uri(&$notice) {
1197 return common_local_url('shownotice',
1198 array('notice' => $notice->id));
1201 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1203 function common_confirmation_code($bits) {
1204 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1205 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1206 $chars = ceil($bits/5);
1208 for ($i = 0; $i < $chars; $i++) {
1209 # XXX: convert to string and back
1210 $num = hexdec(common_good_rand(1));
1211 # XXX: randomness is too precious to throw away almost
1212 # 40% of the bits we get!
1213 $code .= $codechars[$num%32];
1218 # convert markup to HTML
1220 function common_markup_to_html($c) {
1221 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1222 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1223 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1224 return Markdown($c);