]> git.mxchange.org Git - friendica.git/blobdiff - boot.php
don't invoke slap if there's no endpoint configured
[friendica.git] / boot.php
index ee1bba1cdd341f0cc1b14aba1387d826bd709f89..cdb1b35edb8d2bdec0d0f080cd401055cba7d07b 100644 (file)
--- a/boot.php
+++ b/boot.php
@@ -2,18 +2,51 @@
 
 set_time_limit(0);
 
-define ( 'BUILD_ID' , 1000 );
+define ( 'BUILD_ID',               1017   );
+define ( 'DFRN_PROTOCOL_VERSION',  '2.0'  );
 
-define ( 'EOL', "<br />\r\n");
+define ( 'EOL',                    "<br />\r\n"     );
+define ( 'ATOM_TIME',              'Y-m-d\TH:i:s\Z' );
 
-define ( 'REGISTER_CLOSED',  0);
-define ( 'REGISTER_APPROVE', 1);
-define ( 'REGISTER_OPEN',    2);
+// log levels
 
-define ( 'DIRECTION_ANY',  0);
-define ( 'DIRECTION_IN',   1);
-define ( 'DIRECTION_OUT',  2);
-define ( 'DIRECTION_BOTH', 3);
+define ( 'LOGGER_NORMAL',          0 );
+define ( 'LOGGER_TRACE',           1 );
+define ( 'LOGGER_DEBUG',           2 );
+define ( 'LOGGER_DATA',            3 );
+define ( 'LOGGER_ALL',             4 );
+
+// registration policy
+
+define ( 'REGISTER_CLOSED',        0 );
+define ( 'REGISTER_APPROVE',       1 );
+define ( 'REGISTER_OPEN',          2 );
+
+// relationship types
+
+define ( 'REL_VIP',        1);
+define ( 'REL_FAN',        2);
+define ( 'REL_BUD',        3);
+
+
+// page/profile types
+// PAGE_NORMAL is a typical personal profile account
+// PAGE_SOAPBOX automatically approves all friend requests as REL_FAN, (readonly)
+// PAGE_COMMUNITY automatically approves all friend requests as REL_FAN, but with 
+// write access to wall and comments (no email and not included in page owner's ACL lists)
+// PAGE_FREELOVE automatically approves all friend requests as full friends (REL_BUD). 
+
+define ( 'PAGE_NORMAL',            0 );
+define ( 'PAGE_SOAPBOX',           1 );
+define ( 'PAGE_COMMUNITY',         2 );
+define ( 'PAGE_FREELOVE',          3 );
+
+// Maximum number of "people who like (or don't like) this" 
+// that we will list by name
+
+define ( 'MAX_LIKERS',    75);
+
+// email notification options
 
 define ( 'NOTIFY_INTRO',   0x0001 );
 define ( 'NOTIFY_CONFIRM', 0x0002 );
@@ -21,8 +54,53 @@ define ( 'NOTIFY_WALL',    0x0004 );
 define ( 'NOTIFY_COMMENT', 0x0008 );
 define ( 'NOTIFY_MAIL',    0x0010 );
 
-define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' ); 
-
+// various namespaces we may need to parse
+
+define ( 'NAMESPACE_DFRN' ,           'http://purl.org/macgirvin/dfrn/1.0' ); 
+define ( 'NAMESPACE_THREAD' ,         'http://purl.org/syndication/thread/1.0' );
+define ( 'NAMESPACE_TOMB' ,           'http://purl.org/atompub/tombstones/1.0' );
+define ( 'NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/' );
+define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
+define ( 'NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia' );
+define ( 'NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env' );
+define ( 'NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe' );
+define ( 'NAMESPACE_GEORSS',          'http://www.georss.org/georss' );
+define ( 'NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0' );
+define ( 'NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from' );
+
+// activity stream defines
+
+define ( 'ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like' );
+define ( 'ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike' );
+define ( 'ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart' );
+
+define ( 'ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
+define ( 'ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
+define ( 'ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'unfollow' );
+define ( 'ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
+define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
+define ( 'ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
+
+define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
+define ( 'ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note' );
+define ( 'ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person' );
+define ( 'ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
+define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
+define ( 'ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
+
+// item weight for query ordering
+
+define ( 'GRAVITY_PARENT',       0);
+define ( 'GRAVITY_LIKE',         3);
+define ( 'GRAVITY_COMMENT',      6);
+
+
+// Our main application structure for the life of this page
+// Primarily deals with the URL that got us here
+// and tries to make some sense of it, and 
+// stores our page contents and config storage
+// and anything else that might need to be passed around 
+// before we spit the page out. 
 
 if(! class_exists('App')) {
 class App {
@@ -44,29 +122,33 @@ class App {
        public  $pager;
        public  $strings;   
        public  $path;
+       public  $interactive = true;
 
        private $scheme;
        private $hostname;
        private $baseurl;
        private $db;
 
+       private $curl_code;
+       private $curl_headers;
+
        function __construct() {
 
                $this->config = array();
                $this->page = array();
                $this->pager= array();
 
-               $this->scheme = ((isset($_SERVER['HTTPS']) 
-                               && ($_SERVER['HTTPS'])) ?  'https' : 'http' );
-               $this->hostname = str_replace('www.','',
-                               $_SERVER['SERVER_NAME']);
-               set_include_path("include/$this->hostname" 
-                               . PATH_SEPARATOR . 'include' 
-                               . PATH_SEPARATOR . '.' );
+               $this->scheme = ((isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS']))      ?  'https' : 'http' );
+
+               if(x($_SERVER,'SERVER_NAME'))
+                       $this->hostname = $_SERVER['SERVER_NAME'];
 
-                if(substr($_SERVER['QUERY_STRING'],0,2) == "q=")
+               set_include_path("include/$this->hostname" . PATH_SEPARATOR . 'include' . PATH_SEPARATOR . '.' );
+
+               if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=")
                        $_SERVER['QUERY_STRING'] = substr($_SERVER['QUERY_STRING'],2);
-               $this->cmd = trim($_GET['q'],'/');
+               if(x($_GET,'q'))
+                       $this->cmd = trim($_GET['q'],'/');
 
 
                $this->argv = explode('/',$this->cmd);
@@ -78,9 +160,10 @@ class App {
                        $this->module = 'home';
                }
 
-               if($this->cmd == '.well-known/host-meta')
+               if($this->cmd === '.well-known/host-meta')
                        require_once('include/hostxrd.php');
 
+
                $this->pager['page'] = ((x($_GET,'page')) ? $_GET['page'] : 1);
                $this->pager['itemspage'] = 50;
                $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
@@ -91,9 +174,7 @@ class App {
                if(strlen($this->baseurl))
                        return $this->baseurl;
 
-               $this->baseurl = (($ssl) ? 'https' : $this->scheme) . "://" . $this->hostname
-                       . ((isset($this->path) && strlen($this->path)) 
-                       ? '/' . $this->path : '' );
+               $this->baseurl = (($ssl) ? 'https' : $this->scheme) . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
                return $this->baseurl;
        }
 
@@ -111,7 +192,7 @@ class App {
        }
 
        function set_path($p) {
-               $this->path = ltrim(trim($p),'/');
+               $this->path = trim(trim($p),'/');
        } 
 
        function get_path() {
@@ -129,13 +210,46 @@ class App {
        } 
 
        function init_pagehead() {
-               if(file_exists("view/head.tpl"))
-                       $s = file_get_contents("view/head.tpl");
-               $this->page['htmlhead'] = replace_macros($s,array('$baseurl' => $this->get_baseurl()));
+               $tpl = load_view_file("view/head.tpl");
+               $this->page['htmlhead'] = replace_macros($tpl,array(
+                       '$baseurl' => $this->get_baseurl()
+               ));
+       }
+
+       function set_curl_code($code) {
+               $this->curl_code = $code;
+       }
+
+       function get_curl_code() {
+               return $this->curl_code;
        }
 
+       function set_curl_headers($headers) {
+               $this->curl_headers = $headers;
+       }
+
+       function get_curl_headers() {
+               return $this->curl_headers;
+       }
+
+
 }}
 
+// retrieve the App structure
+// useful in functions which require it but don't get it passed to them
+
+if(! function_exists('get_app')) {
+function get_app() {
+       global $a;
+       return $a;
+}};
+
+
+// Multi-purpose function to check variable state.
+// Usage: x($var) or $x($array,'key')
+// returns false if variable/key is not set
+// if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
+// e.g. x('') or x(0) returns 0;
 
 if(! function_exists('x')) {
 function x($s,$k = NULL) {
@@ -158,51 +272,59 @@ function x($s,$k = NULL) {
        }
 }}
 
+// called from db initialisation if db is dead.
+
 if(! function_exists('system_unavailable')) {
 function system_unavailable() {
        include('system_unavailable.php');
        killme();
 }}
 
+// Primarily involved with database upgrade, but also sets the 
+// base url for use in cmdline programs which don't have
+// $_SERVER variables.
 
 if(! function_exists('check_config')) {
 function check_config(&$a) {
-       $r = q("SELECT * FROM `config` WHERE `cat` = 'system' AND `k` IN ('url','build')");
-       if(! count($r)) {
-               q("INSERT INTO `config` (`cat`,`k`,`v`) VALUES ( 'system', 'url', '%s' )",
-                       dbesc($a->get_baseurl())
-               );
-               q("INSERT INTO `config` (`cat`,`k`,`v`) VALUES ( 'system', 'build', '%s' )",
-                       dbesc(BUILD_ID)
-               );
-               return;
-       }
-       foreach($r as $rr) {
-               if($rr['k'] == 'build') {
-                       $stored = intval($rr['v']);
-                       $current = intval(BUILD_ID);
-                       if(($stored < $current) && file_exists('update.php')) {
 
-                               // We're reporting a different version than what is currently installed.
-                               // Run any existing update scripts to bring the database up to current.
+       load_config('system');
 
-                               require_once('update.php');
-                               for($x = $stored; $x <= $current; $x ++) {
-                                       if(function_exists('update_' . $x)) {
-                                               $func = 'update_' . $x;
-                                               $func($a);
-                                       }
+       $build = get_config('system','build');
+       if(! x($build))
+               $build = set_config('system','build',BUILD_ID);
+
+       $url = get_config('system','url');
+       if(! x($url))
+               $url = set_config('system','url',$a->get_baseurl());
+
+       if($build != BUILD_ID) {
+               $stored = intval($build);
+               $current = intval(BUILD_ID);
+               if(($stored < $current) && file_exists('update.php')) {
+                       // We're reporting a different version than what is currently installed.
+                       // Run any existing update scripts to bring the database up to current.
+
+                       require_once('update.php');
+                       for($x = $stored; $x < $current; $x ++) {
+                               if(function_exists('update_' . $x)) {
+                                       $func = 'update_' . $x;
+                                       $func($a);
                                }
-                               q("UPDATE `config` SET `v` = '%s' WHERE `cat` = 'system' AND `k` = 'build' LIMIT 1",
-                                       dbesc(BUILD_ID)
-                               );
                        }
+                       set_config('system','build', BUILD_ID);
                }
        }
        return;
 }}
 
 
+// This is our template processor.
+// $s is the string requiring macro substitution.
+// $r is an array of key value pairs (search => replace)
+// returns substituted string.
+// WARNING: this is pretty basic, and doesn't properly handle search strings that are substrings of each other.
+// For instance if 'test' => "foo" and 'testing' => "bar", testing could become either bar or fooing, 
+// depending on the order in which they were declared in the array.   
 
 if(! function_exists('replace_macros')) {  
 function replace_macros($s,$r) {
@@ -220,91 +342,200 @@ function replace_macros($s,$r) {
 }}
 
 
+// load string translation table for alternate language
+
 if(! function_exists('load_translation_table')) {
 function load_translation_table($lang) {
        global $a;
 
+       if(file_exists("view/$lang/strings.php"))
+               include("view/$lang/strings.php");
 }}
 
+// translate string if translation exists
+
 if(! function_exists('t')) {
 function t($s) {
-       global $a;
 
-       if($a->strings[$s])
+       $a = get_app();
+
+       if(x($a->strings,$s))
                return $a->strings[$s];
        return $s;
 }}
 
+// curl wrapper. If binary flag is true, return binary
+// results. 
+
 if(! function_exists('fetch_url')) {
-function fetch_url($url,$binary = false) {
+function fetch_url($url,$binary = false, &$redirects = 0) {
        $ch = curl_init($url);
-       if(! $ch) return false;
+       if(($redirects > 8) || (! $ch)) 
+               return false;
 
-        curl_setopt($ch, CURLOPT_HEADER, 0);
-       curl_setopt($ch, CURLOPT_FOLLOWLOCATION,true);
-       curl_setopt($ch, CURLOPT_MAXREDIRS,8);
+       curl_setopt($ch, CURLOPT_HEADER, true);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
+
+
+       $curl_time = intval(get_config('system','curl_timeout'));
+       if($curl_time)
+               curl_setopt($ch, CURLOPT_TIMEOUT, $curl_time);
+
+       // by default we will allow self-signed certs
+       // but you can override this
+
+       $check_cert = get_config('system','verifyssl');
+       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
+
+       $prx = get_config('system','proxy');
+       if(strlen($prx)) {
+               curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
+               curl_setopt($ch, CURLOPT_PROXY, $prx);
+               $prxusr = get_config('system','proxyuser');
+               if(strlen($prxusr))
+                       curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
+       }
        if($binary)
                curl_setopt($ch, CURLOPT_BINARYTRANSFER,1);
 
        $s = curl_exec($ch);
+
+       $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+       $header = substr($s,0,strpos($s,"\r\n\r\n"));
+       if(stristr($header,'100') && (strlen($header) < 30)) {
+               // 100 Continue has two headers, get the real one
+               $s = substr($s,strlen($header)+4);
+               $header = substr($s,0,strpos($s,"\r\n\r\n"));
+       }
+       if($http_code == 301 || $http_code == 302 || $http_code == 303) {
+        $matches = array();
+        preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
+        $url = trim(array_pop($matches));
+        $url_parsed = parse_url($url);
+        if (isset($url_parsed)) {
+            $redirects++;
+            return fetch_url($url,$binary,$redirects);
+        }
+    }
+       $a = get_app();
+       $a->set_curl_code($http_code);
+       $body = substr($s,strlen($header)+4);
+       $a->set_curl_headers($header);
+
        curl_close($ch);
-       return($s);
+       return($body);
 }}
 
+// post request to $url. $params is an array of post variables.
 
 if(! function_exists('post_url')) {
-function post_url($url,$params) {
+function post_url($url,$params, $headers = null, &$redirects = 0) {
        $ch = curl_init($url);
-       if(! $ch) return false;
+       if(($redirects > 8) || (! $ch)) 
+               return false;
 
-        curl_setopt($ch, CURLOPT_HEADER, 0);
-       curl_setopt($ch, CURLOPT_FOLLOWLOCATION,true);
-       curl_setopt($ch, CURLOPT_MAXREDIRS,8);
+       curl_setopt($ch, CURLOPT_HEADER, true);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
        curl_setopt($ch, CURLOPT_POST,1);
        curl_setopt($ch, CURLOPT_POSTFIELDS,$params);
 
+       $curl_time = intval(get_config('system','curl_timeout'));
+       if($curl_time)
+               curl_setopt($ch, CURLOPT_TIMEOUT, $curl_time);
+
+       if(is_array($headers))
+               curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
+
+       $check_cert = get_config('system','verifyssl');
+       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
+       $prx = get_config('system','proxy');
+       if(strlen($prx)) {
+               curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
+               curl_setopt($ch, CURLOPT_PROXY, $prx);
+               $prxusr = get_config('system','proxyuser');
+               if(strlen($prxusr))
+                       curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
+       }
+
        $s = curl_exec($ch);
+
+       $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+       $header = substr($s,0,strpos($s,"\r\n\r\n"));
+       if(stristr($header,'100') && (strlen($header) < 30)) {
+               // 100 Continue has two headers, get the real one
+               $s = substr($s,strlen($header)+4);
+               $header = substr($s,0,strpos($s,"\r\n\r\n"));
+       }
+       if($http_code == 301 || $http_code == 302 || $http_code == 303) {
+        $matches = array();
+        preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
+        $url = trim(array_pop($matches));
+        $url_parsed = parse_url($url);
+        if (isset($url_parsed)) {
+            $redirects++;
+            return post_url($url,$binary,$headers,$redirects);
+        }
+    }
+       $a = get_app();
+       $a->set_curl_code($http_code);
+       $body = substr($s,strlen($header)+4);
+       $a->set_curl_headers($header);
+
        curl_close($ch);
-       return($s);
+       return($body);
 }}
 
+// random hash, 64 chars
 
 if(! function_exists('random_string')) {
 function random_string() {
        return(hash('sha256',uniqid(rand(),true)));
 }}
 
+// This is our primary input filter. The high bit hack only involved some old
+// IE browser, forget which. 
+// Use this on any text input where angle chars are not valid or permitted
+// They will be replaced with safer brackets. This may be filtered further
+// if these are not allowed either.   
+
 if(! function_exists('notags')) {
 function notags($string) {
        // protect against :<> with high-bit set
        return(str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string));
 }}
 
+// use this on "body" or "content" input where angle chars shouldn't be removed,
+// and allow them to be safely displayed.
+
 if(! function_exists('escape_tags')) {
 function escape_tags($string) {
 
        return(htmlspecialchars($string));
 }}
 
+// wrapper for adding a login box. If $register == true provide a registration
+// link. This will most always depend on the value of $a->config['register_policy'].
+// returns the complete html for inserting into the page
+
 if(! function_exists('login')) {
 function login($register = false) {
        $o = "";
-       $register_html = (($register) ? file_get_contents("view/register-link.tpl") : "");
+       $register_html = (($register) ? load_view_file("view/register-link.tpl") : "");
 
 
        if(x($_SESSION,'authenticated')) {
-               $o = file_get_contents("view/logout.tpl");
+               $o = load_view_file("view/logout.tpl");
        }
        else {
-               $o = file_get_contents("view/login.tpl");
+               $o = load_view_file("view/login.tpl");
 
                $o = replace_macros($o,array('$register_html' => $register_html ));
        }
        return $o;
 }}
 
+// generate a string that's random, but usually pronounceable. 
+// used to generate initial passwords
 
 if(! function_exists('autoname')) {
 function autoname($len) {
@@ -374,54 +605,80 @@ function autoname($len) {
        return $word;
 }}
 
+// Used to end the current process, after saving session state. 
+
 if(! function_exists('killme')) {
 function killme() {
        session_write_close();
        exit;
 }}
 
+// redirect to another URL and terminate this process.
+
 if(! function_exists('goaway')) {
 function goaway($s) {
        header("Location: $s");
        killme();
 }}
 
+// Generic XML return
+// Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable 
+// of $st and an optional text <message> of $message and terminates the current process. 
 
 if(! function_exists('xml_status')) {
-function xml_status($st) {
+function xml_status($st, $message = '') {
+
+       $xml_message = ((strlen($message)) ? "\t<message>" . xmlify($message) . "</message>\r\n" : '');
+
+       if($st)
+               logger('xml_status returning non_zero: ' . $st . " message=" . $message);
+
        header( "Content-type: text/xml" );
        echo '<?xml version="1.0" encoding="UTF-8"?>'."\r\n";
-       echo "<result><status>$st</status></result>\r\n";
+       echo "<result>\r\n\t<status>$st</status>\r\n$xml_message</result>\r\n";
        killme();
 }}
 
+// Returns the uid of locally logged in user or false.
+
 if(! function_exists('local_user')) {
 function local_user() {
        if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
-               return $_SESSION['uid'];
+               return intval($_SESSION['uid']);
        return false;
 }}
 
+// Returns contact id of authenticated site visitor or false
+
 if(! function_exists('remote_user')) {
 function remote_user() {
        if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
-               return $_SESSION['visitor_id'];
+               return intval($_SESSION['visitor_id']);
        return false;
 }}
 
+// contents of $s are displayed prominently on the page the next time
+// a page is loaded. Usually used for errors or alerts.
+
 if(! function_exists('notice')) {
 function notice($s) {
-
-       $_SESSION['sysmsg'] .= $s;
-
+       $a = get_app();
+       if($a->interactive)
+               $_SESSION['sysmsg'] .= $s;
 }}
 
+// wrapper around config to limit the text length of an incoming message
+
 if(! function_exists('get_max_import_size')) {
 function get_max_import_size() {
        global $a;
        return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
 }}
 
+
+// escape text ($str) for XML transport
+// returns escaped text.
+
 if(! function_exists('xmlify')) {
 function xmlify($str) {
        $buffer = '';
@@ -450,7 +707,7 @@ function xmlify($str) {
                                $buffer .= '&gt;';
                                break;
                        case "\n" :
-                               $buffer .= ' ';
+                               $buffer .= "\n";
                                break;
                        default :
                                $buffer .= $char;
@@ -461,6 +718,9 @@ function xmlify($str) {
        return($buffer);
 }}
 
+// undo an xmlify
+// pass xml escaped text ($s), returns unescaped text
+
 if(! function_exists('unxmlify')) {
 function unxmlify($s) {
        $ret = str_replace('&amp;','&', $s);
@@ -468,16 +728,27 @@ function unxmlify($s) {
        return $ret;    
 }}
 
+// convenience wrapper, reverse the operation "bin2hex"
+
 if(! function_exists('hex2bin')) {
 function hex2bin($s) {
        return(pack("H*",$s));
 }}
 
+// Automatic pagination.
+// To use, get the count of total items.
+// Then call $a->set_pager_total($number_items);
+// Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
+// Then call paginate($a) after the end of the display loop to insert the pager block on the page
+// (assuming there are enough items to paginate).
+// When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
+// will limit the results to the correct items for the current page. 
+// The actual page handling is then accomplished at the application layer. 
 
 if(! function_exists('paginate')) {
 function paginate(&$a) {
        $o = '';
-       $stripped = ereg_replace("(&page=[0-9]*)","",$_SERVER['QUERY_STRING']);
+       $stripped = preg_replace('/(&page=[0-9]*)/','',$_SERVER['QUERY_STRING']);
        $stripped = str_replace('q=','',$stripped);
        $stripped = trim($stripped,'/');
        $url = $a->get_baseurl() . '/' . $stripped;
@@ -526,19 +797,27 @@ function paginate(&$a) {
        return $o;
 }}
 
+// Turn user/group ACLs stored as angle bracketed text into arrays
+
 if(! function_exists('expand_acl')) {
 function expand_acl($s) {
+       // turn string array of angle-bracketed elements into numeric array
+       // e.g. "<1><2><3>" => array(1,2,3);
+       $ret = array();
 
        if(strlen($s)) {
-               $a = explode('<',$s);
-               for($x = 0; $x < count($a); $x ++) {
-                       $a[$x] = intval(str_replace(array('<','>'),array('',''),$a[$x]));
+               $t = str_replace('<','',$s);
+               $a = explode('>',$t);
+               foreach($a as $aa) {
+                       if(intval($aa))
+                               $ret[] = intval($aa);
                }
-               return $a;
        }
-       return array();
+       return $ret;
 }}             
 
+// Used to wrap ACL elements in angle brackets for storage 
+
 if(! function_exists('sanitise_acl')) {
 function sanitise_acl(&$item) {
        if(intval($item))
@@ -546,3 +825,670 @@ function sanitise_acl(&$item) {
        else
                unset($item);
 }}
+
+// retrieve a "family" of config variables from database to cached storage
+
+if(! function_exists('load_config')) {
+function load_config($family) {
+       global $a;
+       $r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
+               dbesc($family)
+       );
+       if(count($r)) {
+               foreach($r as $rr) {
+                       $k = $rr['k'];
+                       $a->config[$family][$k] = $rr['v'];
+               }
+       }
+}}
+
+// get a particular config variable given the family name
+// and key. Returns false if not set.
+// $instore is only used by the set_config function
+// to determine if the key already exists in the DB
+// If a key is found in the DB but doesn't exist in
+// local config cache, pull it into the cache so we don't have
+// to hit the DB again for this item.
+
+if(! function_exists('get_config')) {
+function get_config($family, $key, $instore = false) {
+
+       global $a;
+
+       if(! $instore) {
+               if(isset($a->config[$family][$key])) {
+                       if($a->config[$family][$key] === '!<unset>!') {
+                               return false;
+                       }
+                       return $a->config[$family][$key];
+               }
+       }
+       $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
+               dbesc($family),
+               dbesc($key)
+       );
+       if(count($ret)) {
+               $a->config[$family][$key] = $ret[0]['v'];
+               return $ret[0]['v'];
+       }
+       else {
+               $a->config[$family][$key] = '!<unset>!';
+       }
+       return false;
+}}
+
+// Store a config value ($value) in the category ($family)
+// under the key ($key)
+// Return the value, or false if the database update failed
+
+if(! function_exists('set_config')) {
+function set_config($family,$key,$value) {
+
+       global $a;
+       $a->config[$family][$key] = $value;
+
+       if(get_config($family,$key,true) === false) {
+               $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
+                       dbesc($family),
+                       dbesc($key),
+                       dbesc($value)
+               );
+               if($ret) 
+                       return $value;
+               return $ret;
+       }
+       $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
+               dbesc($value),
+               dbesc($family),
+               dbesc($key)
+       );
+       if($ret)
+               return $value;
+       return $ret;
+}}
+
+// convert an XML document to a normalised, case-corrected array
+// used by webfinger
+
+if(! function_exists('convert_xml_element_to_array')) {
+function convert_xml_element_to_array($xml_element, &$recursion_depth=0) {
+
+        // If we're getting too deep, bail out
+        if ($recursion_depth > 512) {
+                return(null);
+        }
+
+        if (!is_string($xml_element) &&
+        !is_array($xml_element) &&
+        (get_class($xml_element) == 'SimpleXMLElement')) {
+                $xml_element_copy = $xml_element;
+                $xml_element = get_object_vars($xml_element);
+        }
+
+        if (is_array($xml_element)) {
+                $result_array = array();
+                if (count($xml_element) <= 0) {
+                        return (trim(strval($xml_element_copy)));
+                }
+
+                foreach($xml_element as $key=>$value) {
+
+                        $recursion_depth++;
+                        $result_array[strtolower($key)] =
+                convert_xml_element_to_array($value, $recursion_depth);
+                        $recursion_depth--;
+                }
+                if ($recursion_depth == 0) {
+                        $temp_array = $result_array;
+                        $result_array = array(
+                                strtolower($xml_element_copy->getName()) => $temp_array,
+                        );
+                }
+
+                return ($result_array);
+
+        } else {
+                return (trim(strval($xml_element)));
+        }
+}}
+
+// Given an email style address, perform webfinger lookup and 
+// return the resulting DFRN profile URL, or if no DFRN profile URL
+// is located, returns an OStatus subscription template (prefixed 
+// with the string 'stat:' to identify it as on OStatus template).
+// If this isn't an email style address just return $s.
+// Return an empty string if email-style addresses but webfinger fails,
+// or if the resultant personal XRD doesn't contain a supported 
+// subscription/friend-request attribute.
+
+if(! function_exists('webfinger_dfrn')) {
+function webfinger_dfrn($s) {
+       if(! strstr($s,'@')) {
+               return $s;
+       }
+       $links = webfinger($s);
+       logger('webfinger_dfrn: ' . $s . ':' . print_r($links,true), LOGGER_DATA);
+       if(count($links)) {
+               foreach($links as $link)
+                       if($link['@attributes']['rel'] === NAMESPACE_DFRN)
+                               return $link['@attributes']['href'];
+               foreach($links as $link)
+                       if($link['@attributes']['rel'] === NAMESPACE_OSTATUSSUB)
+                               return 'stat:' . $link['@attributes']['template'];              
+       }
+       return '';
+}}
+
+// Given an email style address, perform webfinger lookup and 
+// return the array of link attributes from the personal XRD file.
+// On error/failure return an empty array.
+
+
+if(! function_exists('webfinger')) {
+function webfinger($s) {
+       $host = '';
+       if(strstr($s,'@')) {
+               $host = substr($s,strpos($s,'@') + 1);
+       }
+       if(strlen($host)) {
+               $tpl = fetch_lrdd_template($host);
+               logger('webfinger: lrdd template: ' . $tpl);
+               if(strlen($tpl)) {
+                       $pxrd = str_replace('{uri}', urlencode('acct:'.$s), $tpl);
+                       $links = fetch_xrd_links($pxrd);
+                       if(! count($links)) {
+                               // try with double slashes
+                               $pxrd = str_replace('{uri}', urlencode('acct://'.$s), $tpl);
+                               $links = fetch_xrd_links($pxrd);
+                       }
+                       return $links;
+               }
+       }
+       return array();
+}}
+
+if(! function_exists('lrdd')) {
+function lrdd($uri) {
+
+       $a = get_app();
+
+       if(strstr($uri,'@')) {  
+               return(webfinger($uri));
+       }
+       else {
+               $html = fetch_url($uri);
+               $headers = $a->get_curl_headers();
+               $lines = explode("\n",$headers);
+               if(count($lines)) {
+                       foreach($lines as $line) {                              
+                               // TODO alter the following regex to support multiple relations (space separated)
+                               if((stristr($line,'link:')) && preg_match('/<([^>].*)>.*rel\=[\'\"]lrdd[\'\"]/',$line,$matches)) {
+                                       $link = $matches[1];
+                                       break;
+                               }
+                       }
+               }
+               if(! isset($link)) {
+                       // parse the page of the supplied URL looking for rel links
+
+                       require_once('library/HTML5/Parser.php');
+                       $dom = HTML5_Parser::parse($html);
+
+                       if($dom) {
+                               $items = $dom->getElementsByTagName('link');
+
+                               foreach($items as $item) {
+                                       $x = $item->getAttribute('rel');
+                                       if($x == "lrdd") {
+                                               $link = $item->getAttribute('href');
+                                               break;
+                                       }
+                               }
+                       }
+               }
+
+               if(isset($link))
+                       return(fetch_xrd_links($link));
+       }
+       return array();
+}}
+
+
+
+// Given a host name, locate the LRDD template from that
+// host. Returns the LRDD template or an empty string on
+// error/failure.
+
+if(! function_exists('fetch_lrdd_template')) {
+function fetch_lrdd_template($host) {
+       $tpl = '';
+       $url = 'http://' . $host . '/.well-known/host-meta' ;
+       $links = fetch_xrd_links($url);
+       if(count($links)) {
+               foreach($links as $link)
+                       if($link['@attributes']['rel'] && $link['@attributes']['rel'] === 'lrdd')
+                               $tpl = $link['@attributes']['template'];
+       }
+       if(! strpos($tpl,'{uri}'))
+               $tpl = '';
+       return $tpl;
+}}
+
+// Given a URL, retrieve the page as an XRD document.
+// Return an array of links.
+// on error/failure return empty array.
+
+if(! function_exists('fetch_xrd_links')) {
+function fetch_xrd_links($url) {
+
+
+       $xml = fetch_url($url);
+       if (! $xml)
+               return array();
+
+       logger('fetch_xrd_links: ' . $xml, LOGGER_DATA);
+       $h = simplexml_load_string($xml);
+       $arr = convert_xml_element_to_array($h);
+
+       if(isset($arr['xrd']['link'])) {
+               $link = $arr['xrd']['link'];
+               if(! isset($link[0]))
+                       $links = array($link);
+               else
+                       $links = $link;
+               return $links;
+       }
+       return array();
+}}
+
+// Convert an ACL array to a storable string
+
+if(! function_exists('perms2str')) {
+function perms2str($p) {
+       $ret = '';
+       $tmp = $p;
+       if(is_array($tmp)) {
+               array_walk($tmp,'sanitise_acl');
+               $ret = implode('',$tmp);
+       }
+       return $ret;
+}}
+
+// generate a guaranteed unique (for this domain) item ID for ATOM
+// safe from birthday paradox
+
+if(! function_exists('item_new_uri')) {
+function item_new_uri($hostname,$uid) {
+
+       do {
+               $dups = false;
+               $hash = random_string();
+
+               $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
+
+               $r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1",
+                       dbesc($uri));
+               if(count($r))
+                       $dups = true;
+       } while($dups == true);
+       return $uri;
+}}
+
+// Generate a guaranteed unique photo ID.
+// safe from birthday paradox
+
+if(! function_exists('photo_new_resource')) {
+function photo_new_resource() {
+
+       do {
+               $found = false;
+               $resource = hash('md5',uniqid(mt_rand(),true));
+               $r = q("SELECT `id` FROM `photo` WHERE `resource-id` = '%s' LIMIT 1",
+                       dbesc($resource)
+               );
+               if(count($r))
+                       $found = true;
+       } while($found == true);
+       return $resource;
+}}
+
+
+// Take a URL from the wild, prepend http:// if necessary
+// and check DNS to see if it's real
+// return true if it's OK, false if something is wrong with it
+
+if(! function_exists('validate_url')) {
+function validate_url(&$url) {
+       if(substr($url,0,4) != 'http')
+               $url = 'http://' . $url;
+       $h = parse_url($url);
+
+       if(($h) && (checkdnsrr($h['host'], 'ANY'))) {
+               return true;
+       }
+       return false;
+}}
+
+// checks that email is an actual resolvable internet address
+
+if(! function_exists('validate_email')) {
+function validate_email($addr) {
+
+       if(! strpos($addr,'@'))
+               return false;
+       $h = substr($addr,strpos($addr,'@') + 1);
+
+       if(($h) && (checkdnsrr($h, 'ANY'))) {
+               return true;
+       }
+       return false;
+}}
+
+// Check $url against our list of allowed sites,
+// wildcards allowed. If allowed_sites is unset return true;
+// If url is allowed, return true.
+// otherwise, return false
+
+if(! function_exists('allowed_url')) {
+function allowed_url($url) {
+
+       $h = parse_url($url);
+
+       if(! $h) {
+               return false;
+       }
+
+       $str_allowed = get_config('system','allowed_sites');
+       if(! $str_allowed)
+               return true;
+
+       $found = false;
+
+       $host = strtolower($h['host']);
+
+       // always allow our own site
+
+       if($host == strtolower($_SERVER['SERVER_NAME']))
+               return true;
+
+       $fnmatch = function_exists('fnmatch');
+       $allowed = explode(',',$str_allowed);
+
+       if(count($allowed)) {
+               foreach($allowed as $a) {
+                       $pat = strtolower(trim($a));
+                       if(($fnmatch && fnmatch($pat,$host)) || ($pat == $host)) {
+                               $found = true; 
+                               break;
+                       }
+               }
+       }
+       return $found;
+}}
+
+// check if email address is allowed to register here.
+// Compare against our list (wildcards allowed).
+// Returns false if not allowed, true if allowed or if
+// allowed list is not configured.
+
+if(! function_exists('allowed_email')) {
+function allowed_email($email) {
+
+
+       $domain = strtolower(substr($email,strpos($email,'@') + 1));
+       if(! $domain)
+               return false;
+
+       $str_allowed = get_config('system','allowed_email');
+       if(! $str_allowed)
+               return true;
+
+       $found = false;
+
+       $fnmatch = function_exists('fnmatch');
+       $allowed = explode(',',$str_allowed);
+
+       if(count($allowed)) {
+               foreach($allowed as $a) {
+                       $pat = strtolower(trim($a));
+                       if(($fnmatch && fnmatch($pat,$host)) || ($pat == $host)) {
+                               $found = true; 
+                               break;
+                       }
+               }
+       }
+       return $found;
+}}
+
+// Format the like/dislike text for a profile item
+// $cnt = number of people who like/dislike the item
+// $arr = array of pre-linked names of likers/dislikers
+// $type = one of 'like, 'dislike'
+// $id  = item id
+// returns formatted text
+
+if(! function_exists('format_like')) {
+function format_like($cnt,$arr,$type,$id) {
+       $o = '';
+       if($cnt == 1)
+               $o .= $arr[0] . (($type === 'like') ? t(' likes this.') : t(' doesn\'t like this.')) . EOL ;
+       else {
+               $o .= '<span class="fakelink" onclick="openClose(\'' . $type . 'list-' . $id . '\');" >' 
+                       . $cnt . ' ' . t('people') . '</span> ' . (($type === 'like') ? t('like this.') : t('don\'t like this.')) . EOL ;
+               $total = count($arr);
+               if($total >= MAX_LIKERS)
+                       $arr = array_slice($arr, 0, MAX_LIKERS - 1);
+               if($total < MAX_LIKERS)
+                       $arr[count($arr)-1] = t('and') . ' ' . $arr[count($arr)-1];
+               $str = implode(', ', $arr);
+               if($total >= MAX_LIKERS)
+                       $str .= t(', and ') . $total - MAX_LIKERS . t(' other people');
+               $str .= (($type === 'like') ? t(' like this.') : t(' don\'t like this.'));
+               $o .= "\t" . '<div id="' . $type . 'list-' . $id . '" style="display: none;" >' . $str . '</div>';
+       }
+       return $o;
+}}
+
+
+// wrapper to load a view template, checking for alternate
+// languages before falling back to the default
+
+if(! function_exists('load_view_file')) {
+function load_view_file($s) {
+       $b = basename($s);
+       $d = dirname($s);
+       $lang = get_config('system','language');
+       if($lang === false)
+               $lang = 'en';
+       if(file_exists("$d/$lang/$b"))
+               return file_get_contents("$d/$lang/$b");
+       return file_get_contents($s);
+}}
+
+// for html,xml parsing - let's say you've got
+// an attribute foobar="class1 class2 class3"
+// and you want to find out if it contains 'class3'.
+// you can't use a normal sub string search because you
+// might match 'notclass3' and a regex to do the job is 
+// possible but a bit complicated. 
+// pass the attribute string as $attr and the attribute you 
+// are looking for as $s - returns true if found, otherwise false
+
+if(! function_exists('attribute_contains')) {
+function attribute_contains($attr,$s) {
+       $a = explode(' ', $attr);
+       if(count($a) && in_array($s,$a))
+               return true;
+       return false;
+}}
+
+if(! function_exists('logger')) {
+function logger($msg,$level = 0) {
+
+       $debugging = get_config('system','debugging');
+       $loglevel  = intval(get_config('system','loglevel'));
+       $logfile   = get_config('system','logfile');
+
+       if((! $debugging) || (! $logfile) || ($level > $loglevel))
+               return;
+       
+       @file_put_contents($logfile, datetime_convert() . ':' . session_id() . ' ' . $msg . "\n", FILE_APPEND);
+       return;
+}}
+
+
+if(! function_exists('activity_match')) {
+function activity_match($haystack,$needle) {
+       if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
+               return true;
+       return false;
+}}
+
+
+// Pull out all #hashtags and @person tags from $s;
+// We also get @person@domain.com - which would make 
+// the regex quite complicated as tags can also
+// end a sentence. So we'll run through our results
+// and strip the period from any tags which end with one.
+// Returns array of tags found, or empty array.
+
+
+if(! function_exists('get_tags')) {
+function get_tags($s) {
+       $ret = array();
+       if(preg_match_all('/([@#][^ ,:?]*)([ ,:?]|$)/',$s,$match)) {
+               foreach($match[1] as $match) {
+                       if(substr($match,-1,1) === '.')
+                               $ret[] = substr($match,0,-1);
+                       else
+                               $ret[] = $match;
+               }
+       }
+
+       return $ret;
+}}
+
+
+// quick and dirty quoted_printable encoding
+
+if(! function_exists('qp')) {
+function qp($s) {
+return str_replace ("%","=",rawurlencode($s));
+}} 
+
+
+if(! function_exists('like_puller')) {
+function like_puller($a,$item,&$arr,$mode) {
+
+       $url = '';
+       $sparkle = '';
+       $verb = (($mode === 'like') ? ACTIVITY_LIKE : ACTIVITY_DISLIKE);
+
+       if((activity_match($item['verb'],$verb)) && ($item['id'] != $item['parent'])) {
+               $url = $item['author-link'];
+               if(($item['network'] === 'dfrn') && (! $item['self']) && ($item['author-link'] == $item['url'])) {
+                       $url = $a->get_baseurl() . '/redir/' . $item['contact-id'];
+                       $sparkle = ' class="sparkle" ';
+               }
+               if(! ((isset($arr[$item['parent'] . '-l'])) && (is_array($arr[$item['parent'] . '-l']))))
+                       $arr[$item['parent'] . '-l'] = array();
+               if(! isset($arr[$item['parent']]))
+                       $arr[$item['parent']] = 1;
+               else    
+                       $arr[$item['parent']] ++;
+               $arr[$item['parent'] . '-l'][] = '<a href="'. $url . '"'. $sparkle .'>' . $item['author-name'] . '</a>';
+       }
+       return;
+}}
+
+if(! function_exists('get_mentions')) {
+function get_mentions($item) {
+       $o = '';
+       if(! strlen($item['tag']))
+               return $o;
+
+       $arr = explode(',',$item['tag']);
+       foreach($arr as $x) {
+               $matches = null;
+               if(preg_match('/@\[url=([^\]]*)\]/',$x,$matches))
+                       $o .= "\t\t" . '<link rel="mentioned" href="' . $matches[1] . '" />' . "\r\n";
+       }
+       return $o;
+}}
+
+if(! function_exists('contact_block')) {
+function contact_block() {
+       $o = '';
+       $a = get_app();
+       if((! is_array($a->profile)) || ($a->profile['hide-friends']))
+               return $o;
+       $r = q("SELECT COUNT(*) AS `total` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0",
+                       intval($a->profile['uid'])
+       );
+       if(count($r)) {
+               $total = intval($r[0]['total']);
+       }
+       if(! $total) {
+               $o .= '<h4 class="contact-h4">' . t('No contacts') . '</h4>';
+               return $o;
+       }
+       $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0 ORDER BY RAND() LIMIT 24",
+                       intval($a->profile['uid'])
+       );
+       if(count($r)) {
+               $o .= '<h4 class="contact-h4">' . $total . ' ' . t('Contacts') . '</h4><div id="contact-block">';
+               foreach($r as $rr) {
+                       $redirect_url = $a->get_baseurl() . '/redir/' . $rr['id'];
+                       if(local_user() && ($rr['uid'] == local_user())
+                               && ($rr['network'] === 'dfrn')) {
+                               $url = $redirect_url;
+                               $sparkle = ' sparkle';
+                       }
+                       else {
+                               $url = $rr['url'];
+                               $sparkle = '';
+                       }
+
+                       $o .= '<div class="contact-block-div"><a class="contact-block-link' . $sparkle . '" href="' . $url . '" ><img class="contact-block-img' . $sparkle . '" src="' . $rr['micro'] . '" title="' . $rr['name'] . ' [' . $rr['url'] . ']" alt="' . $rr['name'] . '" /></a></div>' . "\r\n";
+               }
+               $o .= '</div><div id="contact-block-end"></div>';
+               $o .=  '<div id="viewcontacts"><a id="viewcontacts-link" href="viewcontacts/' . $a->profile['nickname'] . '">' . t('View Contacts') . '</a></div>';
+               
+       }
+       return $o;
+
+}}
+
+if(! function_exists('search')) {
+function search($s) {
+       $a = get_app();
+       $o  = '<div id="search-box">';
+       $o .= '<form action="' . $a->get_baseurl() . '/search' . '" method="get" >';
+       $o .= '<input type="text" name="search" id="search-text" value="' . $s .'" />';
+       $o .= '<input type="submit" name="submit" id="search-submit" value="' . t('Search') . '" />'; 
+       $o .= '</form></div>';
+       return $o;
+}}
+
+if(! function_exists('valid_email')) {
+function valid_email($x){
+       if(preg_match('/^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/',$x))
+               return true;
+       return false;
+}}
+
+
+if(! function_exists('gravatar_img')) {
+function gravatar_img($email) {
+       $size = 175;
+       $opt = 'identicon';   // psuedo-random geometric pattern if not found
+       $rating = 'pg';
+       $hash = md5(trim(strtolower($email)));
+       
+       $url = 'http://www.gravatar.com/avatar/' . $hash . '.jpg' 
+               . '?s=' . $size . '&d=' . $opt . '&r=' . $rating;
+
+       logger('gravatar: ' . $email . ' ' . $url);
+       return $url;
+}}
+