]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/util.php
add a display url function to display URLs
[quix0rs-gnu-social.git] / lib / util.php
index aa4f8773942b39e68cf9ca3fc888de30c118e53a..4d1abe51a7c03ee25d6b47cbd242d45bd5a0e307 100644 (file)
@@ -94,16 +94,15 @@ function common_element_start($tag, $attrs=NULL) {
 
 function common_element_end($tag) {
        global $xw;
-       $xw->endElement();
+       # TODO: switch based on $tag
+       $xw->fullEndElement();
 }
 
 function common_element($tag, $attrs=NULL, $content=NULL) {
     common_element_start($tag, $attrs);
-       if ($content) {
-               global $xw;
-               $xw->text($content);
-       }
-       common_element_end($tag);
+    global $xw;
+    $xw->text($content);
+    common_element_end($tag);
 }
 
 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
@@ -124,22 +123,22 @@ function common_end_xml() {
 }
 
 define('PAGE_TYPE_PREFS', 'application/xhtml+xml,text/html;q=0.7,application/xml;q=0.3,text/xml;q=0.2');
-          
+
 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
        global $config, $xw;
 
        $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
 
        # XXX: allow content negotiation for RDF, RSS, or XRDS
-       
+
        $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
                                                                  common_accept_to_prefs(PAGE_TYPE_PREFS));
 
        if (!$type) {
-               common_client_error(_t('This page is not available in a media type you accept'), 406);
+               common_user_error(_t('This page is not available in a media type you accept'), 406);
                exit(0);
        }
-       
+
        header('Content-Type: '.$type);
 
        common_start_xml('html',
@@ -163,14 +162,17 @@ function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=
                if (file_exists(theme_file('ie'.$ver.'.css'))) {
                        # Yes, IE people should be put in jail.
                        $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
-                                                         'href="'.theme_path('ie'.$ver.'.css').' /><![endif]');
+                                                         'href="'.theme_path('ie'.$ver.'.css').'" /><![endif]');
                }
        }
-       
+
        common_element('script', array('type' => 'text/javascript',
                                                                   'src' => common_path('js/jquery.min.js')),
                                   ' ');
-                                                
+       common_element('script', array('type' => 'text/javascript',
+                                                                  'src' => common_path('js/util.js')),
+                                  ' ');
+
        if ($callable) {
                if ($data) {
                        call_user_func($callable, $data);
@@ -183,17 +185,24 @@ function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=
        common_element_start('div', array('id' => 'wrap'));
        common_element_start('div', array('id' => 'header'));
        common_nav_menu();
-       if ($config['site']['logo'] || file_exists(theme_file('logo.png'))) {
+       if ((is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
+               || file_exists(theme_file('logo.png')))
+       {
                common_element_start('a', array('href' => common_local_url('public')));
                common_element('img', array('src' => ($config['site']['logo']) ?
                                                                        ($config['site']['logo']) : theme_path('logo.png'),
                                                                        'alt' => $config['site']['name'],
                                                                        'id' => 'logo'));
                common_element_end('a');
+       } else {
+               common_element_start('p', array('id' => 'branding'));
+               common_element('a', array('href' => common_local_url('public')),
+                                          $config['site']['name']);
+               common_element_end('p');
        }
+
        common_element('h1', 'pagetitle', $pagetitle);
-       common_element('h2', 'sitename', $config['site']['name']);
-       
+
        if ($headercall) {
                if ($data) {
                        call_user_func($headercall, $data);
@@ -210,16 +219,20 @@ function common_show_footer() {
        common_element_end('div'); # content div
        common_foot_menu();
        common_element_start('div', array('id' => 'footer'));
-       common_element_start('p', 'laconica');
-       common_text(_t('This site is running the '));
-       common_element('a', array('class' => 'software',
-                                                         href => 'http://laconi.ca/'),
-                                  'Laconica');
-       common_text(_t('microblogging tool, version ' . LACONICA_VERSION . ', available under the '));
-       common_element('a', array(href => 'http://www.fsf.org/licensing/licenses/agpl-3.0.html'),
-                                  'GNU Affero General Public License');
-       common_text(_t('.'));
-       common_element_end('p');
+       common_element_start('div', 'laconica');
+       if (common_config('site', 'broughtby')) {
+               $instr = _t('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
+       } else {
+               $instr = _t('**%%site.name%%** is a microblogging service. ');
+       }
+       $instr .= _t('It runs the [Laconica](http://laconi.ca/) ' .
+                        'microblogging software, version ' . LACONICA_VERSION . ', ' .
+                        'available under the ' .
+                        '[GNU Affero General Public License]' .
+                        '(http://www.fsf.org/licensing/licenses/agpl-3.0.html).');
+    $output = common_markup_to_html($instr);
+    common_raw($output);
+       common_element_end('div');
        common_element('img', array('id' => 'cc',
                                                                'src' => $config['license']['image'],
                                                                'alt' => $config['license']['title']));
@@ -275,10 +288,14 @@ function common_foot_menu() {
        common_element_start('ul', array('id' => 'nav_sub'));
        common_menu_item(common_local_url('doc', array('title' => 'about')),
                                         _t('About'));
+       common_menu_item(common_local_url('doc', array('title' => 'faq')),
+                                        _t('FAQ'));
        common_menu_item(common_local_url('doc', array('title' => 'privacy')),
                                         _t('Privacy'));
        common_menu_item(common_local_url('doc', array('title' => 'source')),
                                         _t('Source'));
+       common_menu_item(common_local_url('doc', array('title' => 'contact')),
+                                        _t('Contact'));
        common_element_end('ul');
 }
 
@@ -301,6 +318,7 @@ function common_input($id, $label, $value=NULL,$instructions=NULL) {
        common_element('label', array('for' => $id), $label);
        $attrs = array('name' => $id,
                                   'type' => 'text',
+                                  'class' => 'input_text',
                                   'id' => $id);
        if ($value) {
                $attrs['value'] = htmlspecialchars($value);
@@ -312,6 +330,30 @@ function common_input($id, $label, $value=NULL,$instructions=NULL) {
        common_element_end('p');
 }
 
+function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true')
+{
+       common_element_start('p');
+       $attrs = array('name' => $id,
+                                  'type' => 'checkbox',
+                                  'class' => 'checkbox',
+                                  'id' => $id);
+       if ($value) {
+               $attrs['value'] = htmlspecialchars($value);
+       }
+       if ($checked) {
+               $attrs['checked'] = 'checked';
+       }
+       common_element('input', $attrs);
+       # XXX: use a <label>
+       common_text(' ');
+       common_element('span', 'checkbox_label', $label);
+       common_text(' ');
+       if ($instructions) {
+               common_element('span', 'input_instructions', $instructions);
+       }
+       common_element_end('p');
+}
+
 function common_hidden($id, $value) {
        common_element('input', array('name' => $id,
                                                                  'type' => 'hidden',
@@ -324,6 +366,7 @@ function common_password($id, $label, $instructions=NULL) {
        common_element('label', array('for' => $id), $label);
        $attrs = array('name' => $id,
                                   'type' => 'password',
+                                  'class' => 'password',
                                   'id' => $id);
        common_element('input', $attrs);
        if ($instructions) {
@@ -338,6 +381,7 @@ function common_submit($id, $label) {
        common_element('input', array('type' => 'submit',
                                                                  'id' => $id,
                                                                  'name' => $id,
+                                                                 'class' => 'submit',
                                                                  'value' => $label));
        common_element_end('p');
 }
@@ -349,7 +393,7 @@ function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
                                                                         'cols' => 40,
                                                                         'name' => $id,
                                                                         'id' => $id),
-                                  ($content) ? $content : ' ');
+                                  ($content) ? $content : '');
        if ($instructions) {
                common_element('span', 'input_instructions', $instructions);
        }
@@ -358,8 +402,8 @@ function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
 
 # salted, hashed passwords are stored in the DB
 
-function common_munge_password($id, $password) {
-       return md5($id . $password);
+function common_munge_password($password, $id) {
+       return md5($password . $id);
 }
 
 # check if a username exists and has matching password
@@ -405,19 +449,108 @@ function common_set_user($nickname) {
        return false;
 }
 
+function common_set_cookie($key, $value, $expiration=0) {
+       $path = common_config('site', 'path');
+       $server = common_config('site', 'server');
+
+       if ($path && ($path != '/')) {
+               $cookiepath = '/' . $path . '/';
+       } else {
+               $cookiepath = '/';
+       }
+       return setcookie($key,
+                        $value,
+                                $expiration,
+                                        $cookiepath,
+                                    $server);
+}
+
+define('REMEMBERME', 'rememberme');
+define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60);
+
+function common_rememberme() {
+       $user = common_current_user();
+       if (!$user) {
+               return false;
+       }
+       $rm = new Remember_me();
+       $rm->code = common_good_rand(16);
+       $rm->user_id = $user->id;
+       $result = $rm->insert();
+       if (!$result) {
+               common_log_db_error($rm, 'INSERT', __FILE__);
+               return false;
+       }
+       common_set_cookie(REMEMBERME,
+                                         implode(':', array($rm->user_id, $rm->code)),
+                                         time() + REMEMBERME_EXPIRY);
+}
+
+function common_remembered_user() {
+       $user = NULL;
+       # Try to remember
+       $packed = $_COOKIE[REMEMBERME];
+       if ($packed) {
+               list($id, $code) = explode(':', $packed);
+               if ($id && $code) {
+                       $rm = Remember_me::staticGet($code);
+                       if ($rm && ($rm->user_id == $id)) {
+                               $user = User::staticGet($rm->user_id);
+                               if ($user) {
+                                       # successful!
+                                       $result = $rm->delete();
+                                       if (!$result) {
+                                               common_log_db_error($rm, 'DELETE', __FILE__);
+                                               $user = NULL;
+                                       } else {
+                                               common_set_user($user->nickname);
+                                               common_real_login(false);
+                                               # We issue a new cookie, so they can log in
+                                               # automatically again after this session
+                                               common_rememberme();
+                                       }
+                               }
+                       }
+               }
+       }
+       return $user;
+}
+
+# must be called with a valid user!
+
+function common_forgetme() {
+       common_set_cookie(REMEMBERME, '', 0);
+}
+
 # who is the current user?
 function common_current_user() {
-       static $user = NULL; # FIXME: global memcached
-       if (is_null($user)) {
+       if ($_REQUEST[session_name()]) {
                common_ensure_session();
                $id = $_SESSION['userid'];
                if ($id) {
+                       # note: this should cache
                        $user = User::staticGet($id);
+                       return $user;
                }
        }
+       # that didn't work; try to remember
+       $user = common_remembered_user();
        return $user;
 }
 
+# Logins that are 'remembered' aren't 'real' -- they're subject to
+# cookie-stealing. So, we don't let them do certain things. New reg,
+# OpenID, and password logins _are_ real.
+
+function common_real_login($real=true) {
+       common_ensure_session();
+       $_SESSION['real_login'] = $real;
+}
+
+function common_is_real_login() {
+       return common_logged_in() && $_SESSION['real_login'];
+}
+
 # get canonical version of nickname for comparison
 function common_canonical_nickname($nickname) {
        # XXX: UTF-8 canonicalization (like combining chars)
@@ -437,7 +570,7 @@ function common_render_content($text, $notice) {
        $r = htmlspecialchars($text);
        $id = $notice->profile_id;
        $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
-       $r = preg_replace('/(^|\b)@([\w-]+)($|\b)/e', "'\\1@'.common_at_link($id, '\\2').'\\3'", $r);
+       $r = preg_replace('/(^|\s+)@([a-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
        # XXX: # tags
        # XXX: machine tags
        return $r;
@@ -465,8 +598,7 @@ function common_at_link($sender_id, $nickname) {
        if ($sender) {
                $recipient_user = User::staticGet('nickname', $nickname);
                if ($recipient_user) {
-                       $recipient = $recipient->getProfile();
-                       return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink usertouser">'.$nickname.'</a>';
+                       return '<a href="'.htmlspecialchars(common_profile_url($nickname)).'" class="atlink usertouser">'.$nickname.'</a>';
                }
        }
        # Otherwise, no links. @messages from local users to remote users,
@@ -496,6 +628,15 @@ function common_avatar_url($filename) {
        return common_path('avatar/'.$filename);
 }
 
+function common_avatar_display_url($avatar) {
+       $server = common_config('avatar', 'server');
+       if ($server) {
+               return 'http://'.$server.'/'.$avatar->filename;
+       } else {
+               return $avatar->url;
+       }
+}
+
 function common_default_avatar($size) {
        static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
                                                          AVATAR_STREAM_SIZE => 'stream',
@@ -522,6 +663,8 @@ function common_fancy_url($action, $args=NULL) {
                }
         case 'publicrss':
                return common_path('rss');
+        case 'publicxrds':
+               return common_path('xrds');
         case 'doc':
                return common_path('doc/'.$args['title']);
         case 'login':
@@ -530,6 +673,12 @@ function common_fancy_url($action, $args=NULL) {
         case 'subscribe':
         case 'unsubscribe':
                return common_path('main/'.$action);
+        case 'remotesubscribe':
+               if ($args && $args['nickname']) {
+                       return common_path('main/remote?nickname=' . $args['nickname']);
+               } else {
+                       return common_path('main/remote');
+               }
         case 'openidlogin':
                return common_path('main/openid');
         case 'avatar':
@@ -543,11 +692,11 @@ function common_fancy_url($action, $args=NULL) {
                return common_path('notice/new');
         case 'shownotice':
                return common_path('notice/'.$args['notice']);
-        case 'xrds':           
+        case 'xrds':
         case 'foaf':
                return common_path($args['nickname'].'/'.$action);
         case 'subscriptions':
-        case 'subscribed':
+        case 'subscribers':
         case 'all':
                if ($args && $args['page']) {
                        return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
@@ -564,6 +713,18 @@ function common_fancy_url($action, $args=NULL) {
                } else {
                        return common_path($args['nickname']);
                }
+        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');
         default:
                return common_simple_url($action, $args);
        }
@@ -590,7 +751,40 @@ function common_path($relative) {
 function common_date_string($dt) {
        // XXX: do some sexy date formatting
        // return date(DATE_RFC822, $dt);
-       return $dt;
+       $t = strtotime($dt);
+       $now = time();
+       $diff = $now - $t;
+
+       if ($now < $t) { # that shouldn't happen!
+               return common_exact_date($dt);
+       } else if ($diff < 60) {
+               return _t('a few seconds ago');
+       } else if ($diff < 92) {
+               return _t('about a minute ago');
+       } else if ($diff < 3300) {
+               return _t('about ') . round($diff/60) . _t(' minutes ago');
+       } else if ($diff < 5400) {
+               return _t('about an hour ago');
+       } else if ($diff < 22 * 3600) {
+               return _t('about ') . round($diff/3600) . _t(' hours ago');
+       } else if ($diff < 37 * 3600) {
+               return _t('about a day ago');
+       } else if ($diff < 24 * 24 * 3600) {
+               return _t('about ') . round($diff/(24*3600)) . _t(' days ago');
+       } else if ($diff < 46 * 24 * 3600) {
+               return _t('about a month ago');
+       } else if ($diff < 330 * 24 * 3600) {
+               return _t('about ') . round($diff/(30*24*3600)) . _t(' months ago');
+       } else if ($diff < 480 * 24 * 3600) {
+               return _t('about a year ago');
+       } else {
+               return common_exact_date($dt);
+       }
+}
+
+function common_exact_date($dt) {
+       $t = strtotime($dt);
+       return date(DATE_RFC850, $t);
 }
 
 function common_date_w3dtf($dt) {
@@ -605,7 +799,12 @@ function common_redirect($url, $code=307) {
                                                   307 => "Temporary Redirect");
        header("Status: ${code} $status[$code]");
        header("Location: $url");
+
+       common_start_xml('a',
+                                        '-//W3C//DTD XHTML 1.0 Strict//EN',
+                                        'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
        common_element('a', array('href' => $url), $url);
+       common_end_xml();
 }
 
 function common_broadcast_notice($notice, $remote=false) {
@@ -615,7 +814,8 @@ function common_broadcast_notice($notice, $remote=false) {
                require_once(INSTALLDIR.'/lib/omb.php');
                omb_broadcast_remote_subscribers($notice);
        }
-       // XXX: broadcast notices to Jabber
+       require_once(INSTALLDIR.'/lib/jabber.php');
+       jabber_broadcast_notice($notice);
        // XXX: broadcast notices to SMS
        // XXX: broadcast notices to other IM
        return true;
@@ -635,18 +835,25 @@ function common_profile_url($nickname) {
 
 # Don't call if nobody's logged in
 
-function common_notice_form() {
+function common_notice_form($action=NULL, $content=NULL) {
        $user = common_current_user();
        assert(!is_null($user));
        common_element_start('form', array('id' => 'status_form',
-                                                                          'method' => 'POST',
+                                                                          'method' => 'post',
                                                                           'action' => common_local_url('newnotice')));
        common_element_start('p');
-       common_element('label', array('for' => 'status_update',
+       common_element('label', array('for' => 'status_textarea',
                                                                  'id' => 'status_label'),
                                   _t('What\'s up, ').$user->nickname.'?');
+        common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
        common_element('textarea', array('id' => 'status_textarea',
-                                                                        'name' => 'status_textarea'));
+                                                                        'cols' => 60,
+                                                                        'rows' => 3,
+                                                                        'name' => 'status_textarea'),
+                                  ($content) ? $content : '');
+       if ($action) {
+               common_hidden('returnto', $action);
+       }
        common_element('input', array('id' => 'status_submit',
                                                                  'name' => 'status_submit',
                                                                  'type' => 'submit',
@@ -732,7 +939,7 @@ function common_ensure_syslog() {
 
 function common_log($priority, $msg, $filename=NULL) {
        common_ensure_syslog();
-       syslog($priority, $msg);
+#      syslog($priority, $msg);
 }
 
 function common_debug($msg, $filename=NULL) {
@@ -743,6 +950,25 @@ function common_debug($msg, $filename=NULL) {
        }
 }
 
+function common_log_db_error(&$object, $verb, $filename=NULL) {
+       $objstr = common_log_objstring($object);
+       $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
+       common_log(LOG_ERROR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
+}
+
+function common_log_objstring(&$object) {
+       if (is_null($object)) {
+               return "NULL";
+       }
+       $arr = $object->toArray();
+       $fields = array();
+       foreach ($arr as $k => $v) {
+               $fields[] = "$k='$v'";
+       }
+       $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
+       return $objstring;
+}
+
 function common_valid_http_url($url) {
        return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
 }
@@ -757,17 +983,17 @@ function common_valid_tag($tag) {
 
 # Does a little before-after block for next/prev page
 
-function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {            
-       
+function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
+
        if ($have_before || $have_after) {
                common_element_start('div', array('id' => 'pagination'));
                common_element_start('ul', array('id' => 'nav_pagination'));
        }
-       
+
        if ($have_before) {
                $pargs = array('page' => $page-1);
                $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
-                                                                                
+
                common_element_start('li', 'before');
                common_element('a', array('href' => common_local_url($action, $newargs)),
                                           _t('« After'));
@@ -782,7 +1008,7 @@ function common_pagination($have_before, $have_after, $page, $action, $args=NULL
                                                   _t('Before »'));
                common_element_end('li');
        }
-       
+
        if ($have_before || $have_after) {
                common_element_end('ul');
                common_element_end('div');
@@ -855,7 +1081,7 @@ function common_negotiate_type($cprefs, $sprefs) {
        }
 
        $bestq = 0;
-       $besttype = NULL;
+       $besttype = "text/html";
 
        foreach(array_keys($combine) as $type) {
                if($combine[$type] > $bestq) {
@@ -871,3 +1097,47 @@ function common_config($main, $sub) {
        global $config;
        return $config[$main][$sub];
 }
+
+function common_copy_args($from) {
+       $to = array();
+       $strip = get_magic_quotes_gpc();
+       foreach ($from as $k => $v) {
+               $to[$k] = ($strip) ? stripslashes($v) : $v;
+       }
+       return $to;
+}
+
+function common_user_uri(&$user) {
+       return common_local_url('userbyid', array('id' => $user->id));
+}
+
+function common_notice_uri(&$notice) {
+       return common_local_url('shownotice',
+               array('notice' => $notice->id));
+}
+
+# 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
+
+function common_confirmation_code($bits) {
+       # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
+       static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
+       $chars = ceil($bits/5);
+       $code = '';
+       for ($i = 0; $i < $chars; $i++) {
+               # XXX: convert to string and back
+               $num = hexdec(common_good_rand(1));
+               # XXX: randomness is too precious to throw away almost
+               # 40% of the bits we get!
+               $code .= $codechars[$num%32];
+       }
+       return $code;
+}
+
+# convert markup to HTML
+
+function common_markup_to_html($c) {
+       $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
+       $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
+       $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
+       return Markdown($c);
+}