5 define ( 'BUILD_ID', 1019 );
6 define ( 'DFRN_PROTOCOL_VERSION', '2.0' );
8 define ( 'EOL', "<br />\r\n" );
9 define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
13 define ( 'LOGGER_NORMAL', 0 );
14 define ( 'LOGGER_TRACE', 1 );
15 define ( 'LOGGER_DEBUG', 2 );
16 define ( 'LOGGER_DATA', 3 );
17 define ( 'LOGGER_ALL', 4 );
19 // registration policy
21 define ( 'REGISTER_CLOSED', 0 );
22 define ( 'REGISTER_APPROVE', 1 );
23 define ( 'REGISTER_OPEN', 2 );
27 define ( 'REL_VIP', 1);
28 define ( 'REL_FAN', 2);
29 define ( 'REL_BUD', 3);
33 // PAGE_NORMAL is a typical personal profile account
34 // PAGE_SOAPBOX automatically approves all friend requests as REL_FAN, (readonly)
35 // PAGE_COMMUNITY automatically approves all friend requests as REL_FAN, but with
36 // write access to wall and comments (no email and not included in page owner's ACL lists)
37 // PAGE_FREELOVE automatically approves all friend requests as full friends (REL_BUD).
39 define ( 'PAGE_NORMAL', 0 );
40 define ( 'PAGE_SOAPBOX', 1 );
41 define ( 'PAGE_COMMUNITY', 2 );
42 define ( 'PAGE_FREELOVE', 3 );
44 // Maximum number of "people who like (or don't like) this"
45 // that we will list by name
47 define ( 'MAX_LIKERS', 75);
49 // email notification options
51 define ( 'NOTIFY_INTRO', 0x0001 );
52 define ( 'NOTIFY_CONFIRM', 0x0002 );
53 define ( 'NOTIFY_WALL', 0x0004 );
54 define ( 'NOTIFY_COMMENT', 0x0008 );
55 define ( 'NOTIFY_MAIL', 0x0010 );
57 // various namespaces we may need to parse
59 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
60 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
61 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
62 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
63 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
64 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
65 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
66 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
67 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
68 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
69 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
71 // activity stream defines
73 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
74 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
75 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
77 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
78 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
79 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'unfollow' );
80 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
81 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
82 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
84 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
85 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
86 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
87 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
88 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
89 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
91 // item weight for query ordering
93 define ( 'GRAVITY_PARENT', 0);
94 define ( 'GRAVITY_LIKE', 3);
95 define ( 'GRAVITY_COMMENT', 6);
97 // Please disable magic_quotes_gpc so we don't have to do this.
98 // See http://php.net/manual/en/security.magicquotes.disabling.php
100 if (get_magic_quotes_gpc()) {
101 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
102 while (list($key, $val) = each($process)) {
103 foreach ($val as $k => $v) {
104 unset($process[$key][$k]);
106 $process[$key][stripslashes($k)] = $v;
107 $process[] = &$process[$key][stripslashes($k)];
109 $process[$key][stripslashes($k)] = stripslashes($v);
117 // Our main application structure for the life of this page
118 // Primarily deals with the URL that got us here
119 // and tries to make some sense of it, and
120 // stores our page contents and config storage
121 // and anything else that might need to be passed around
122 // before we spit the page out.
124 if(! class_exists('App')) {
127 public $module_loaded = false;
136 public $error = false;
144 public $interactive = true;
152 private $curl_headers;
154 function __construct() {
156 $this->config = array();
157 $this->page = array();
158 $this->pager= array();
160 $this->scheme = ((isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'])) ? 'https' : 'http' );
162 if(x($_SERVER,'SERVER_NAME'))
163 $this->hostname = $_SERVER['SERVER_NAME'];
165 set_include_path("include/$this->hostname" . PATH_SEPARATOR . 'include' . PATH_SEPARATOR . '.' );
167 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=")
168 $_SERVER['QUERY_STRING'] = substr($_SERVER['QUERY_STRING'],2);
170 $this->cmd = trim($_GET['q'],'/');
173 $this->argv = explode('/',$this->cmd);
174 $this->argc = count($this->argv);
175 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
176 $this->module = $this->argv[0];
179 $this->module = 'home';
182 if($this->cmd === '.well-known/host-meta')
183 require_once('include/hostxrd.php');
186 $this->pager['page'] = ((x($_GET,'page')) ? $_GET['page'] : 1);
187 $this->pager['itemspage'] = 50;
188 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
189 $this->pager['total'] = 0;
192 function get_baseurl($ssl = false) {
193 if(strlen($this->baseurl))
194 return $this->baseurl;
196 $this->baseurl = (($ssl) ? 'https' : $this->scheme) . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
197 return $this->baseurl;
200 function set_baseurl($url) {
201 $this->baseurl = $url;
202 $this->hostname = basename($url);
205 function get_hostname() {
206 return $this->hostname;
209 function set_hostname($h) {
210 $this->hostname = $h;
213 function set_path($p) {
214 $this->path = trim(trim($p),'/');
217 function get_path() {
221 function set_pager_total($n) {
222 $this->pager['total'] = intval($n);
225 function set_pager_itemspage($n) {
226 $this->pager['itemspage'] = intval($n);
227 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
231 function init_pagehead() {
232 $tpl = load_view_file("view/head.tpl");
233 $this->page['htmlhead'] = replace_macros($tpl,array(
234 '$baseurl' => $this->get_baseurl()
238 function set_curl_code($code) {
239 $this->curl_code = $code;
242 function get_curl_code() {
243 return $this->curl_code;
246 function set_curl_headers($headers) {
247 $this->curl_headers = $headers;
250 function get_curl_headers() {
251 return $this->curl_headers;
257 // retrieve the App structure
258 // useful in functions which require it but don't get it passed to them
260 if(! function_exists('get_app')) {
267 // Multi-purpose function to check variable state.
268 // Usage: x($var) or $x($array,'key')
269 // returns false if variable/key is not set
270 // if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
271 // e.g. x('') or x(0) returns 0;
273 if(! function_exists('x')) {
274 function x($s,$k = NULL) {
276 if((is_array($s)) && (array_key_exists($k,$s))) {
294 // called from db initialisation if db is dead.
296 if(! function_exists('system_unavailable')) {
297 function system_unavailable() {
298 include('system_unavailable.php');
302 // Primarily involved with database upgrade, but also sets the
303 // base url for use in cmdline programs which don't have
304 // $_SERVER variables.
306 if(! function_exists('check_config')) {
307 function check_config(&$a) {
309 load_config('system');
311 $build = get_config('system','build');
313 $build = set_config('system','build',BUILD_ID);
315 $url = get_config('system','url');
317 $url = set_config('system','url',$a->get_baseurl());
319 if($build != BUILD_ID) {
320 $stored = intval($build);
321 $current = intval(BUILD_ID);
322 if(($stored < $current) && file_exists('update.php')) {
323 // We're reporting a different version than what is currently installed.
324 // Run any existing update scripts to bring the database up to current.
326 require_once('update.php');
327 for($x = $stored; $x < $current; $x ++) {
328 if(function_exists('update_' . $x)) {
329 $func = 'update_' . $x;
333 set_config('system','build', BUILD_ID);
340 // This is our template processor.
341 // $s is the string requiring macro substitution.
342 // $r is an array of key value pairs (search => replace)
343 // returns substituted string.
344 // WARNING: this is pretty basic, and doesn't properly handle search strings that are substrings of each other.
345 // For instance if 'test' => "foo" and 'testing' => "bar", testing could become either bar or fooing,
346 // depending on the order in which they were declared in the array.
348 if(! function_exists('replace_macros')) {
349 function replace_macros($s,$r) {
354 if(is_array($r) && count($r)) {
355 foreach ($r as $k => $v ) {
360 return str_replace($search,$replace,$s);
364 // load string translation table for alternate language
366 if(! function_exists('load_translation_table')) {
367 function load_translation_table($lang) {
370 if(file_exists("view/$lang/strings.php"))
371 include("view/$lang/strings.php");
374 // translate string if translation exists
376 if(! function_exists('t')) {
381 if(x($a->strings,$s))
382 return $a->strings[$s];
386 // curl wrapper. If binary flag is true, return binary
389 if(! function_exists('fetch_url')) {
390 function fetch_url($url,$binary = false, &$redirects = 0) {
391 $ch = curl_init($url);
392 if(($redirects > 8) || (! $ch))
395 curl_setopt($ch, CURLOPT_HEADER, true);
396 curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
399 $curl_time = intval(get_config('system','curl_timeout'));
400 curl_setopt($ch, CURLOPT_TIMEOUT, (($curl_time !== false) ? $curl_time : 60));
402 // by default we will allow self-signed certs
403 // but you can override this
405 $check_cert = get_config('system','verifyssl');
406 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
408 $prx = get_config('system','proxy');
410 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
411 curl_setopt($ch, CURLOPT_PROXY, $prx);
412 $prxusr = get_config('system','proxyuser');
414 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
417 curl_setopt($ch, CURLOPT_BINARYTRANSFER,1);
421 $http_code = intval(curl_getinfo($ch, CURLINFO_HTTP_CODE));
422 $header = substr($s,0,strpos($s,"\r\n\r\n"));
423 if(stristr($header,'100') && (strlen($header) < 30)) {
424 // 100 Continue has two headers, get the real one
425 $s = substr($s,strlen($header)+4);
426 $header = substr($s,0,strpos($s,"\r\n\r\n"));
428 if($http_code == 301 || $http_code == 302 || $http_code == 303) {
430 preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
431 $url = trim(array_pop($matches));
432 $url_parsed = parse_url($url);
433 if (isset($url_parsed)) {
435 return fetch_url($url,$binary,$redirects);
439 $a->set_curl_code($http_code);
440 $body = substr($s,strlen($header)+4);
441 $a->set_curl_headers($header);
447 // post request to $url. $params is an array of post variables.
449 if(! function_exists('post_url')) {
450 function post_url($url,$params, $headers = null, &$redirects = 0) {
451 $ch = curl_init($url);
452 if(($redirects > 8) || (! $ch))
455 curl_setopt($ch, CURLOPT_HEADER, true);
456 curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
457 curl_setopt($ch, CURLOPT_POST,1);
458 curl_setopt($ch, CURLOPT_POSTFIELDS,$params);
460 $curl_time = intval(get_config('system','curl_timeout'));
461 curl_setopt($ch, CURLOPT_TIMEOUT, (($curl_time !== false) ? $curl_time : 60));
463 if(is_array($headers))
464 curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
466 $check_cert = get_config('system','verifyssl');
467 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
468 $prx = get_config('system','proxy');
470 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
471 curl_setopt($ch, CURLOPT_PROXY, $prx);
472 $prxusr = get_config('system','proxyuser');
474 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
479 $http_code = intval(curl_getinfo($ch, CURLINFO_HTTP_CODE));
480 $header = substr($s,0,strpos($s,"\r\n\r\n"));
481 if(stristr($header,'100') && (strlen($header) < 30)) {
482 // 100 Continue has two headers, get the real one
483 $s = substr($s,strlen($header)+4);
484 $header = substr($s,0,strpos($s,"\r\n\r\n"));
486 if($http_code == 301 || $http_code == 302 || $http_code == 303) {
488 preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
489 $url = trim(array_pop($matches));
490 $url_parsed = parse_url($url);
491 if (isset($url_parsed)) {
493 return post_url($url,$binary,$headers,$redirects);
497 $a->set_curl_code($http_code);
498 $body = substr($s,strlen($header)+4);
499 $a->set_curl_headers($header);
505 // random hash, 64 chars
507 if(! function_exists('random_string')) {
508 function random_string() {
509 return(hash('sha256',uniqid(rand(),true)));
512 // This is our primary input filter. The high bit hack only involved some old
513 // IE browser, forget which.
514 // Use this on any text input where angle chars are not valid or permitted
515 // They will be replaced with safer brackets. This may be filtered further
516 // if these are not allowed either.
518 if(! function_exists('notags')) {
519 function notags($string) {
520 // protect against :<> with high-bit set
521 return(str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string));
524 // use this on "body" or "content" input where angle chars shouldn't be removed,
525 // and allow them to be safely displayed.
527 if(! function_exists('escape_tags')) {
528 function escape_tags($string) {
530 return(htmlspecialchars($string));
533 // wrapper for adding a login box. If $register == true provide a registration
534 // link. This will most always depend on the value of $a->config['register_policy'].
535 // returns the complete html for inserting into the page
537 if(! function_exists('login')) {
538 function login($register = false) {
540 $register_html = (($register) ? load_view_file("view/register-link.tpl") : "");
543 if(x($_SESSION,'authenticated')) {
544 $o = load_view_file("view/logout.tpl");
547 $o = load_view_file("view/login.tpl");
549 $o = replace_macros($o,array('$register_html' => $register_html ));
554 // generate a string that's random, but usually pronounceable.
555 // used to generate initial passwords
557 if(! function_exists('autoname')) {
558 function autoname($len) {
560 $vowels = array('a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u');
561 if(mt_rand(0,5) == 4)
579 's','sc','sh','sm','sp','st',
587 $midcons = array('ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
588 'nd','ng','nk','nt','rn','rp','rt');
590 $noend = array('bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
591 'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh');
593 $start = mt_rand(0,2);
601 for ($x = 0; $x < $len; $x ++) {
602 $r = mt_rand(0,count($table) - 1);
605 if($table == $vowels)
606 $table = array_merge($cons,$midcons);
612 $word = substr($word,0,$len);
614 foreach($noend as $noe) {
615 if((strlen($word) > 2) && (substr($word,-2) == $noe)) {
616 $word = substr($word,0,-1);
620 if(substr($word,-1) == 'q')
621 $word = substr($word,0,-1);
625 // Used to end the current process, after saving session state.
627 if(! function_exists('killme')) {
629 session_write_close();
633 // redirect to another URL and terminate this process.
635 if(! function_exists('goaway')) {
636 function goaway($s) {
637 header("Location: $s");
641 // Generic XML return
642 // Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
643 // of $st and an optional text <message> of $message and terminates the current process.
645 if(! function_exists('xml_status')) {
646 function xml_status($st, $message = '') {
648 $xml_message = ((strlen($message)) ? "\t<message>" . xmlify($message) . "</message>\r\n" : '');
651 logger('xml_status returning non_zero: ' . $st . " message=" . $message);
653 header( "Content-type: text/xml" );
654 echo '<?xml version="1.0" encoding="UTF-8"?>'."\r\n";
655 echo "<result>\r\n\t<status>$st</status>\r\n$xml_message</result>\r\n";
659 // Returns the uid of locally logged in user or false.
661 if(! function_exists('local_user')) {
662 function local_user() {
663 if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
664 return intval($_SESSION['uid']);
668 // Returns contact id of authenticated site visitor or false
670 if(! function_exists('remote_user')) {
671 function remote_user() {
672 if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
673 return intval($_SESSION['visitor_id']);
677 // contents of $s are displayed prominently on the page the next time
678 // a page is loaded. Usually used for errors or alerts.
680 if(! function_exists('notice')) {
681 function notice($s) {
684 $_SESSION['sysmsg'] .= $s;
687 // wrapper around config to limit the text length of an incoming message
689 if(! function_exists('get_max_import_size')) {
690 function get_max_import_size() {
692 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
696 // escape text ($str) for XML transport
697 // returns escaped text.
699 if(! function_exists('xmlify')) {
700 function xmlify($str) {
703 for($x = 0; $x < strlen($str); $x ++) {
734 $buffer = trim($buffer);
739 // pass xml escaped text ($s), returns unescaped text
741 if(! function_exists('unxmlify')) {
742 function unxmlify($s) {
743 $ret = str_replace('&','&', $s);
744 $ret = str_replace(array('<','>','"','''),array('<','>','"',"'"),$ret);
748 // convenience wrapper, reverse the operation "bin2hex"
750 if(! function_exists('hex2bin')) {
751 function hex2bin($s) {
752 return(pack("H*",$s));
755 // Automatic pagination.
756 // To use, get the count of total items.
757 // Then call $a->set_pager_total($number_items);
758 // Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
759 // Then call paginate($a) after the end of the display loop to insert the pager block on the page
760 // (assuming there are enough items to paginate).
761 // When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
762 // will limit the results to the correct items for the current page.
763 // The actual page handling is then accomplished at the application layer.
765 if(! function_exists('paginate')) {
766 function paginate(&$a) {
768 $stripped = preg_replace('/(&page=[0-9]*)/','',$_SERVER['QUERY_STRING']);
769 $stripped = str_replace('q=','',$stripped);
770 $stripped = trim($stripped,'/');
771 $url = $a->get_baseurl() . '/' . $stripped;
774 if($a->pager['total'] > $a->pager['itemspage']) {
775 $o .= '<div class="pager">';
776 if($a->pager['page'] != 1)
777 $o .= '<span class="pager_prev">'."<a href=\"$url".'&page='.($a->pager['page'] - 1).'">' . t('prev') . '</a></span> ';
779 $o .= "<span class=\"pager_first\"><a href=\"$url"."&page=1\">" . t('first') . "</a></span> ";
781 $numpages = $a->pager['total'] / $a->pager['itemspage'];
784 $numstop = $numpages;
787 $numstart = (($pagenum > 7) ? ($pagenum - 7) : 1);
788 $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 14));
791 for($i = $numstart; $i <= $numstop; $i++){
792 if($i == $a->pager['page'])
793 $o .= '<span class="pager_current">'.(($i < 10) ? ' '.$i : $i);
795 $o .= "<span class=\"pager_n\"><a href=\"$url"."&page=$i\">".(($i < 10) ? ' '.$i : $i)."</a>";
799 if(($a->pager['total'] % $a->pager['itemspage']) != 0) {
800 if($i == $a->pager['page'])
801 $o .= '<span class="pager_current">'.(($i < 10) ? ' '.$i : $i);
803 $o .= "<span class=\"pager_n\"><a href=\"$url"."&page=$i\">".(($i < 10) ? ' '.$i : $i)."</a>";
807 $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
808 $o .= "<span class=\"pager_last\"><a href=\"$url"."&page=$lastpage\">" . t('last') . "</a></span> ";
810 if(($a->pager['total'] - ($a->pager['itemspage'] * $a->pager['page'])) > 0)
811 $o .= '<span class="pager_next">'."<a href=\"$url"."&page=".($a->pager['page'] + 1).'">' . t('next') . '</a></span>';
812 $o .= '</div>'."\r\n";
817 // Turn user/group ACLs stored as angle bracketed text into arrays
819 if(! function_exists('expand_acl')) {
820 function expand_acl($s) {
821 // turn string array of angle-bracketed elements into numeric array
822 // e.g. "<1><2><3>" => array(1,2,3);
826 $t = str_replace('<','',$s);
827 $a = explode('>',$t);
830 $ret[] = intval($aa);
836 // Used to wrap ACL elements in angle brackets for storage
838 if(! function_exists('sanitise_acl')) {
839 function sanitise_acl(&$item) {
841 $item = '<' . intval(notags(trim($item))) . '>';
846 // retrieve a "family" of config variables from database to cached storage
848 if(! function_exists('load_config')) {
849 function load_config($family) {
851 $r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
857 $a->config[$family][$k] = $rr['v'];
862 // get a particular config variable given the family name
863 // and key. Returns false if not set.
864 // $instore is only used by the set_config function
865 // to determine if the key already exists in the DB
866 // If a key is found in the DB but doesn't exist in
867 // local config cache, pull it into the cache so we don't have
868 // to hit the DB again for this item.
870 if(! function_exists('get_config')) {
871 function get_config($family, $key, $instore = false) {
876 if(isset($a->config[$family][$key])) {
877 if($a->config[$family][$key] === '!<unset>!') {
880 return $a->config[$family][$key];
883 $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
888 $a->config[$family][$key] = $ret[0]['v'];
892 $a->config[$family][$key] = '!<unset>!';
897 // Store a config value ($value) in the category ($family)
898 // under the key ($key)
899 // Return the value, or false if the database update failed
901 if(! function_exists('set_config')) {
902 function set_config($family,$key,$value) {
905 $a->config[$family][$key] = $value;
907 if(get_config($family,$key,true) === false) {
908 $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
917 $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
927 // convert an XML document to a normalised, case-corrected array
930 if(! function_exists('convert_xml_element_to_array')) {
931 function convert_xml_element_to_array($xml_element, &$recursion_depth=0) {
933 // If we're getting too deep, bail out
934 if ($recursion_depth > 512) {
938 if (!is_string($xml_element) &&
939 !is_array($xml_element) &&
940 (get_class($xml_element) == 'SimpleXMLElement')) {
941 $xml_element_copy = $xml_element;
942 $xml_element = get_object_vars($xml_element);
945 if (is_array($xml_element)) {
946 $result_array = array();
947 if (count($xml_element) <= 0) {
948 return (trim(strval($xml_element_copy)));
951 foreach($xml_element as $key=>$value) {
954 $result_array[strtolower($key)] =
955 convert_xml_element_to_array($value, $recursion_depth);
958 if ($recursion_depth == 0) {
959 $temp_array = $result_array;
960 $result_array = array(
961 strtolower($xml_element_copy->getName()) => $temp_array,
965 return ($result_array);
968 return (trim(strval($xml_element)));
972 // Given an email style address, perform webfinger lookup and
973 // return the resulting DFRN profile URL, or if no DFRN profile URL
974 // is located, returns an OStatus subscription template (prefixed
975 // with the string 'stat:' to identify it as on OStatus template).
976 // If this isn't an email style address just return $s.
977 // Return an empty string if email-style addresses but webfinger fails,
978 // or if the resultant personal XRD doesn't contain a supported
979 // subscription/friend-request attribute.
981 if(! function_exists('webfinger_dfrn')) {
982 function webfinger_dfrn($s) {
983 if(! strstr($s,'@')) {
986 $links = webfinger($s);
987 logger('webfinger_dfrn: ' . $s . ':' . print_r($links,true), LOGGER_DATA);
989 foreach($links as $link)
990 if($link['@attributes']['rel'] === NAMESPACE_DFRN)
991 return $link['@attributes']['href'];
992 foreach($links as $link)
993 if($link['@attributes']['rel'] === NAMESPACE_OSTATUSSUB)
994 return 'stat:' . $link['@attributes']['template'];
999 // Given an email style address, perform webfinger lookup and
1000 // return the array of link attributes from the personal XRD file.
1001 // On error/failure return an empty array.
1004 if(! function_exists('webfinger')) {
1005 function webfinger($s) {
1007 if(strstr($s,'@')) {
1008 $host = substr($s,strpos($s,'@') + 1);
1011 $tpl = fetch_lrdd_template($host);
1012 logger('webfinger: lrdd template: ' . $tpl);
1014 $pxrd = str_replace('{uri}', urlencode('acct:'.$s), $tpl);
1015 $links = fetch_xrd_links($pxrd);
1016 if(! count($links)) {
1017 // try with double slashes
1018 $pxrd = str_replace('{uri}', urlencode('acct://'.$s), $tpl);
1019 $links = fetch_xrd_links($pxrd);
1027 if(! function_exists('lrdd')) {
1028 function lrdd($uri) {
1032 if(strstr($uri,'@')) {
1033 return(webfinger($uri));
1036 $html = fetch_url($uri);
1037 $headers = $a->get_curl_headers();
1038 $lines = explode("\n",$headers);
1040 foreach($lines as $line) {
1041 // TODO alter the following regex to support multiple relations (space separated)
1042 if((stristr($line,'link:')) && preg_match('/<([^>].*)>.*rel\=[\'\"]lrdd[\'\"]/',$line,$matches)) {
1043 $link = $matches[1];
1048 if(! isset($link)) {
1049 // parse the page of the supplied URL looking for rel links
1051 require_once('library/HTML5/Parser.php');
1052 $dom = HTML5_Parser::parse($html);
1055 $items = $dom->getElementsByTagName('link');
1057 foreach($items as $item) {
1058 $x = $item->getAttribute('rel');
1060 $link = $item->getAttribute('href');
1068 return(fetch_xrd_links($link));
1075 // Given a host name, locate the LRDD template from that
1076 // host. Returns the LRDD template or an empty string on
1079 if(! function_exists('fetch_lrdd_template')) {
1080 function fetch_lrdd_template($host) {
1082 $url = 'http://' . $host . '/.well-known/host-meta' ;
1083 $links = fetch_xrd_links($url);
1085 foreach($links as $link)
1086 if($link['@attributes']['rel'] && $link['@attributes']['rel'] === 'lrdd')
1087 $tpl = $link['@attributes']['template'];
1089 if(! strpos($tpl,'{uri}'))
1094 // Given a URL, retrieve the page as an XRD document.
1095 // Return an array of links.
1096 // on error/failure return empty array.
1098 if(! function_exists('fetch_xrd_links')) {
1099 function fetch_xrd_links($url) {
1102 $xml = fetch_url($url);
1106 logger('fetch_xrd_links: ' . $xml, LOGGER_DATA);
1107 $h = simplexml_load_string($xml);
1108 $arr = convert_xml_element_to_array($h);
1110 if(isset($arr['xrd']['link'])) {
1111 $link = $arr['xrd']['link'];
1112 if(! isset($link[0]))
1113 $links = array($link);
1121 // Convert an ACL array to a storable string
1123 if(! function_exists('perms2str')) {
1124 function perms2str($p) {
1127 if(is_array($tmp)) {
1128 array_walk($tmp,'sanitise_acl');
1129 $ret = implode('',$tmp);
1134 // generate a guaranteed unique (for this domain) item ID for ATOM
1135 // safe from birthday paradox
1137 if(! function_exists('item_new_uri')) {
1138 function item_new_uri($hostname,$uid) {
1142 $hash = random_string();
1144 $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
1146 $r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1",
1150 } while($dups == true);
1154 // Generate a guaranteed unique photo ID.
1155 // safe from birthday paradox
1157 if(! function_exists('photo_new_resource')) {
1158 function photo_new_resource() {
1162 $resource = hash('md5',uniqid(mt_rand(),true));
1163 $r = q("SELECT `id` FROM `photo` WHERE `resource-id` = '%s' LIMIT 1",
1168 } while($found == true);
1173 // Take a URL from the wild, prepend http:// if necessary
1174 // and check DNS to see if it's real
1175 // return true if it's OK, false if something is wrong with it
1177 if(! function_exists('validate_url')) {
1178 function validate_url(&$url) {
1179 if(substr($url,0,4) != 'http')
1180 $url = 'http://' . $url;
1181 $h = parse_url($url);
1183 if(($h) && (checkdnsrr($h['host'], 'ANY'))) {
1189 // checks that email is an actual resolvable internet address
1191 if(! function_exists('validate_email')) {
1192 function validate_email($addr) {
1194 if(! strpos($addr,'@'))
1196 $h = substr($addr,strpos($addr,'@') + 1);
1198 if(($h) && (checkdnsrr($h, 'ANY'))) {
1204 // Check $url against our list of allowed sites,
1205 // wildcards allowed. If allowed_sites is unset return true;
1206 // If url is allowed, return true.
1207 // otherwise, return false
1209 if(! function_exists('allowed_url')) {
1210 function allowed_url($url) {
1212 $h = parse_url($url);
1218 $str_allowed = get_config('system','allowed_sites');
1224 $host = strtolower($h['host']);
1226 // always allow our own site
1228 if($host == strtolower($_SERVER['SERVER_NAME']))
1231 $fnmatch = function_exists('fnmatch');
1232 $allowed = explode(',',$str_allowed);
1234 if(count($allowed)) {
1235 foreach($allowed as $a) {
1236 $pat = strtolower(trim($a));
1237 if(($fnmatch && fnmatch($pat,$host)) || ($pat == $host)) {
1246 // check if email address is allowed to register here.
1247 // Compare against our list (wildcards allowed).
1248 // Returns false if not allowed, true if allowed or if
1249 // allowed list is not configured.
1251 if(! function_exists('allowed_email')) {
1252 function allowed_email($email) {
1255 $domain = strtolower(substr($email,strpos($email,'@') + 1));
1259 $str_allowed = get_config('system','allowed_email');
1265 $fnmatch = function_exists('fnmatch');
1266 $allowed = explode(',',$str_allowed);
1268 if(count($allowed)) {
1269 foreach($allowed as $a) {
1270 $pat = strtolower(trim($a));
1271 if(($fnmatch && fnmatch($pat,$host)) || ($pat == $host)) {
1280 // Format the like/dislike text for a profile item
1281 // $cnt = number of people who like/dislike the item
1282 // $arr = array of pre-linked names of likers/dislikers
1283 // $type = one of 'like, 'dislike'
1285 // returns formatted text
1287 if(! function_exists('format_like')) {
1288 function format_like($cnt,$arr,$type,$id) {
1291 $o .= $arr[0] . (($type === 'like') ? t(' likes this.') : t(' doesn\'t like this.')) . EOL ;
1293 $o .= '<span class="fakelink" onclick="openClose(\'' . $type . 'list-' . $id . '\');" >'
1294 . $cnt . ' ' . t('people') . '</span> ' . (($type === 'like') ? t('like this.') : t('don\'t like this.')) . EOL ;
1295 $total = count($arr);
1296 if($total >= MAX_LIKERS)
1297 $arr = array_slice($arr, 0, MAX_LIKERS - 1);
1298 if($total < MAX_LIKERS)
1299 $arr[count($arr)-1] = t('and') . ' ' . $arr[count($arr)-1];
1300 $str = implode(', ', $arr);
1301 if($total >= MAX_LIKERS)
1302 $str .= t(', and ') . $total - MAX_LIKERS . t(' other people');
1303 $str .= (($type === 'like') ? t(' like this.') : t(' don\'t like this.'));
1304 $o .= "\t" . '<div id="' . $type . 'list-' . $id . '" style="display: none;" >' . $str . '</div>';
1310 // wrapper to load a view template, checking for alternate
1311 // languages before falling back to the default
1313 if(! function_exists('load_view_file')) {
1314 function load_view_file($s) {
1317 $lang = get_config('system','language');
1320 if(file_exists("$d/$lang/$b"))
1321 return file_get_contents("$d/$lang/$b");
1322 return file_get_contents($s);
1325 // for html,xml parsing - let's say you've got
1326 // an attribute foobar="class1 class2 class3"
1327 // and you want to find out if it contains 'class3'.
1328 // you can't use a normal sub string search because you
1329 // might match 'notclass3' and a regex to do the job is
1330 // possible but a bit complicated.
1331 // pass the attribute string as $attr and the attribute you
1332 // are looking for as $s - returns true if found, otherwise false
1334 if(! function_exists('attribute_contains')) {
1335 function attribute_contains($attr,$s) {
1336 $a = explode(' ', $attr);
1337 if(count($a) && in_array($s,$a))
1342 if(! function_exists('logger')) {
1343 function logger($msg,$level = 0) {
1345 $debugging = get_config('system','debugging');
1346 $loglevel = intval(get_config('system','loglevel'));
1347 $logfile = get_config('system','logfile');
1349 if((! $debugging) || (! $logfile) || ($level > $loglevel))
1352 @file_put_contents($logfile, datetime_convert() . ':' . session_id() . ' ' . $msg . "\n", FILE_APPEND);
1357 if(! function_exists('activity_match')) {
1358 function activity_match($haystack,$needle) {
1359 if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
1365 // Pull out all #hashtags and @person tags from $s;
1366 // We also get @person@domain.com - which would make
1367 // the regex quite complicated as tags can also
1368 // end a sentence. So we'll run through our results
1369 // and strip the period from any tags which end with one.
1370 // Returns array of tags found, or empty array.
1373 if(! function_exists('get_tags')) {
1374 function get_tags($s) {
1376 if(preg_match_all('/([@#][^ ,:?]*)([ ,:?]|$)/',$s,$match)) {
1377 foreach($match[1] as $match) {
1378 if(strstr($match,"]"))
1380 if(substr($match,-1,1) === '.')
1381 $ret[] = substr($match,0,-1);
1391 // quick and dirty quoted_printable encoding
1393 if(! function_exists('qp')) {
1395 return str_replace ("%","=",rawurlencode($s));
1399 if(! function_exists('like_puller')) {
1400 function like_puller($a,$item,&$arr,$mode) {
1404 $verb = (($mode === 'like') ? ACTIVITY_LIKE : ACTIVITY_DISLIKE);
1406 if((activity_match($item['verb'],$verb)) && ($item['id'] != $item['parent'])) {
1407 $url = $item['author-link'];
1408 if(($item['network'] === 'dfrn') && (! $item['self']) && ($item['author-link'] == $item['url'])) {
1409 $url = $a->get_baseurl() . '/redir/' . $item['contact-id'];
1410 $sparkle = ' class="sparkle" ';
1412 if(! ((isset($arr[$item['parent'] . '-l'])) && (is_array($arr[$item['parent'] . '-l']))))
1413 $arr[$item['parent'] . '-l'] = array();
1414 if(! isset($arr[$item['parent']]))
1415 $arr[$item['parent']] = 1;
1417 $arr[$item['parent']] ++;
1418 $arr[$item['parent'] . '-l'][] = '<a href="'. $url . '"'. $sparkle .'>' . $item['author-name'] . '</a>';
1423 if(! function_exists('get_mentions')) {
1424 function get_mentions($item) {
1426 if(! strlen($item['tag']))
1429 $arr = explode(',',$item['tag']);
1430 foreach($arr as $x) {
1432 if(preg_match('/@\[url=([^\]]*)\]/',$x,$matches))
1433 $o .= "\t\t" . '<link rel="mentioned" href="' . $matches[1] . '" />' . "\r\n";
1438 if(! function_exists('contact_block')) {
1439 function contact_block() {
1442 if((! is_array($a->profile)) || ($a->profile['hide-friends']))
1444 $r = q("SELECT COUNT(*) AS `total` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0",
1445 intval($a->profile['uid'])
1448 $total = intval($r[0]['total']);
1451 $o .= '<h4 class="contact-h4">' . t('No contacts') . '</h4>';
1454 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0 ORDER BY RAND() LIMIT 24",
1455 intval($a->profile['uid'])
1458 $o .= '<h4 class="contact-h4">' . $total . ' ' . t('Contacts') . '</h4><div id="contact-block">';
1459 foreach($r as $rr) {
1460 $redirect_url = $a->get_baseurl() . '/redir/' . $rr['id'];
1461 if(local_user() && ($rr['uid'] == local_user())
1462 && ($rr['network'] === 'dfrn')) {
1463 $url = $redirect_url;
1464 $sparkle = ' sparkle';
1471 $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";
1473 $o .= '</div><div id="contact-block-end"></div>';
1474 $o .= '<div id="viewcontacts"><a id="viewcontacts-link" href="viewcontacts/' . $a->profile['nickname'] . '">' . t('View Contacts') . '</a></div>';
1481 if(! function_exists('search')) {
1482 function search($s) {
1484 $o = '<div id="search-box">';
1485 $o .= '<form action="' . $a->get_baseurl() . '/search' . '" method="get" >';
1486 $o .= '<input type="text" name="search" id="search-text" value="' . $s .'" />';
1487 $o .= '<input type="submit" name="submit" id="search-submit" value="' . t('Search') . '" />';
1488 $o .= '</form></div>';
1492 if(! function_exists('valid_email')) {
1493 function valid_email($x){
1494 if(preg_match('/^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/',$x))
1500 if(! function_exists('gravatar_img')) {
1501 function gravatar_img($email) {
1503 $opt = 'identicon'; // psuedo-random geometric pattern if not found
1505 $hash = md5(trim(strtolower($email)));
1507 $url = 'http://www.gravatar.com/avatar/' . $hash . '.jpg'
1508 . '?s=' . $size . '&d=' . $opt . '&r=' . $rating;
1510 logger('gravatar: ' . $email . ' ' . $url);