]> git.mxchange.org Git - friendica.git/blobdiff - boot.php
inline salmon magic keys
[friendica.git] / boot.php
index 4c2526d66d779fcec9a14ec3eccb3ba932fc5145..4deafe317c279c1a4a514e4d19ee34d2cc742b2e 100644 (file)
--- a/boot.php
+++ b/boot.php
@@ -2,18 +2,20 @@
 
 set_time_limit(0);
 
-define ( 'BUILD_ID' , 1001 );
+define ( 'BUILD_ID' , 1007 );
 
 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);
 
-define ( 'DIRECTION_NONE', 0);                 // No relationship
-define ( 'DIRECTION_IN',   1);                 // VIP e.g. has FAN
-define ( 'DIRECTION_OUT',  2);                 // FAN to a VIP
-define ( 'DIRECTION_BOTH', 3);                 // Mutual Friends
+// relationship types
+
+define ( 'REL_VIP',        1);
+define ( 'REL_FAN',        2);
+define ( 'REL_BUD',        3);
 
 define ( 'NOTIFY_INTRO',   0x0001 );
 define ( 'NOTIFY_CONFIRM', 0x0002 );
@@ -21,10 +23,17 @@ define ( 'NOTIFY_WALL',    0x0004 );
 define ( 'NOTIFY_COMMENT', 0x0008 );
 define ( 'NOTIFY_MAIL',    0x0010 );
 
-define ( 'NAMESPACE_DFRN' ,      'http://purl.org/macgirvin/dfrn/1.0' ); 
-define ( 'NAMESPACE_ACTIVITY',   'http://activitystrea.ms/spec/1.0/' );
+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_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
+
 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_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
 define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
@@ -36,10 +45,17 @@ 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' );
 
-
-define ( 'ACTIVITY_OBJ_HEART',    NAMESPACE_DFRN     . '/heart' );
+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 {
@@ -95,7 +111,7 @@ 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);
@@ -146,15 +162,29 @@ 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(
+               $tpl = load_view_file("view/head.tpl");
+               $this->page['htmlhead'] = replace_macros($tpl,array(
                        '$baseurl' => $this->get_baseurl()
                ));
        }
 
 }}
 
+// 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) {
@@ -177,12 +207,17 @@ 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) {
@@ -201,7 +236,6 @@ function check_config(&$a) {
                $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.
 
@@ -219,6 +253,13 @@ function check_config(&$a) {
 }}
 
 
+// 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) {
@@ -236,21 +277,31 @@ function replace_macros($s,$r) {
 }}
 
 
+// load string tranlsation 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;
+       
+       $a = get_app();
 
        if($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) {
        $ch = curl_init($url);
@@ -260,6 +311,13 @@ function fetch_url($url,$binary = false) {
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION,true);
        curl_setopt($ch, CURLOPT_MAXREDIRS,8);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
+
+       // 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);
@@ -276,6 +334,7 @@ function fetch_url($url,$binary = false) {
        return($s);
 }}
 
+// post request to $url. $params is an array of post variables.
 
 if(! function_exists('post_url')) {
 function post_url($url,$params) {
@@ -288,6 +347,8 @@ function post_url($url,$params) {
        curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
        curl_setopt($ch, CURLOPT_POST,1);
        curl_setopt($ch, CURLOPT_POSTFIELDS,$params);
+       $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);
@@ -302,41 +363,56 @@ function post_url($url,$params) {
        return($s);
 }}
 
+// 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'].
+
 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) {
@@ -406,27 +482,40 @@ 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 = '') {
+
+       if(strlen($message))
+               $xml_message = "\t<message>" . xmlify($message) . "</message>\r\n";
+
        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 on user or false.
+
 if(! function_exists('local_user')) {
 function local_user() {
        if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
@@ -434,6 +523,8 @@ function local_user() {
        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')))
@@ -441,6 +532,9 @@ function remote_user() {
        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) {
 
@@ -448,12 +542,18 @@ function notice($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 = '';
@@ -493,6 +593,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);
@@ -500,11 +603,22 @@ 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) {
@@ -558,19 +672,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))
@@ -579,6 +701,8 @@ function sanitise_acl(&$item) {
                unset($item);
 }}
 
+// retrieve a "family" of config variables from database to cached storage
+
 if(! function_exists('load_config')) {
 function load_config($family) {
        global $a;
@@ -593,15 +717,24 @@ function load_config($family) {
        }
 }}
 
+// 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>!')
+                       if($a->config[$family][$key] === '!<unset>!') {
                                return false;
+                       }
                        return $a->config[$family][$key];
                }
        }
@@ -619,6 +752,10 @@ function get_config($family, $key, $instore = false) {
        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) {
 
@@ -645,6 +782,9 @@ function set_config($family,$key,$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) {
 
@@ -687,6 +827,11 @@ function convert_xml_element_to_array($xml_element, &$recursion_depth=0) {
         }
 }}
 
+// Given an email style address, perform webfinger lookup and 
+// return the resulting DFRN profile URL.
+// 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 DFRN profile.
 
 if(! function_exists('webfinger')) {
 function webfinger($s) {
@@ -711,7 +856,7 @@ function webfinger($s) {
                $links = $link;
 
        foreach($links as $link)
-               if($link['@attributes']['rel'] && $link['@attributes']['rel'] == 'lrdd')
+               if($link['@attributes']['rel'] && $link['@attributes']['rel'] === 'lrdd')
                        $tpl = $link['@attributes']['template'];
        if((empty($tpl)) || (! strpos($tpl, '{uri}')))
                return '';
@@ -739,6 +884,9 @@ function webfinger($s) {
        return '';
 }}
 
+
+// Convert an ACL array to a storable string
+
 if(! function_exists('perms2str')) {
 function perms2str($p) {
        $ret = '';
@@ -750,6 +898,9 @@ function perms2str($p) {
        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) {
 
@@ -767,22 +918,165 @@ function item_new_uri($hostname,$uid) {
        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;
+}}
+
+
+// Returns logged in user ID
+
 if(! function_exists('get_uid')) {
 function get_uid() {
        return ((x($_SESSION,'uid')) ? intval($_SESSION['uid']) : 0) ;
 }}
 
+// 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) {
+function validate_url(&$url) {
        if(substr($url,0,4) != 'http')
                $url = 'http://' . $url;
        $h = parse_url($url);
 
-       if(! $h)
+       if(! $h) {
                return false;
-       if(! checkdnsrr($h['host'], 'ANY'))
+       }
+       if(! checkdnsrr($h['host'], 'ANY')) {
                return false;
+       }
        return true;
 }}
 
+// 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) {
+       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 >= 75)
+                       $arr = array_slice($arr,0,74);
+               if($total < 75)
+                       $arr[count($arr)-1] = t('and') . ' ' . $arr[count($arr)-1];
+               $str = implode(', ', $arr);
+               if($total >= 75)
+                       $str .= t(', and ') . $total - 75 . t(' other people');
+               $str .= (($type === 'like') ? t(' like this.') : t(' don\'t like this.'));
+               $o .= '<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 && file_exists("$d/$lang/$b"))
+               return file_get_contents("$d/$lang/$b");
+       return file_get_contents($s);
+}}
\ No newline at end of file