]> git.mxchange.org Git - friendica.git/blobdiff - include/text.php
update to v4.0.0; point to local host of SWF
[friendica.git] / include / text.php
index 628da1c1b2795ebd75b3eaff4c0b289271f8138e..7b27d8b86e7a819020871c9f312fdb5f236b07e5 100644 (file)
@@ -6,40 +6,31 @@
 // 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.   
+// depending on the order in which they were declared in the array.
 
 require_once("include/template_processor.php");
 require_once("include/friendica_smarty.php");
 
-if(! function_exists('replace_macros')) {  
+if(! function_exists('replace_macros')) {
+/**
+ * This is our template processor
+ * 
+ * @param string|FriendicaSmarty $s the string requiring macro substitution, 
+ *                                                                     or an instance of FriendicaSmarty
+ * @param array $r key value pairs (search => replace)
+ * @return string substituted string
+ */
 function replace_macros($s,$r) {
-       global $t;
+       
+       $stamp1 = microtime(true);
 
-//     $ts = microtime();
        $a = get_app();
 
-       if($a->theme['template_engine'] === 'smarty3') {
-               $template = '';
-               if(gettype($s) === 'string') {
-                       $template = $s;
-                       $s = new FriendicaSmarty();
-               }
-               foreach($r as $key=>$value) {
-                       if($key[0] === '$') {
-                               $key = substr($key, 1);
-                       }
-                       $s->assign($key, $value);
-               }
-               $output = $s->parsed($template);
-       }
-       else {
-               $r =  $t->replace($s,$r);
-       
-               $output = template_unescape($r);
-       }
-//     $tt = microtime() - $ts;
-//     $a = get_app();
-//     $a->page['debug'] .= "$tt <br>\n";
+       $t = $a->template_engine();
+       $output = $t->replace_macros($s,$r);
+
+       $a->save_timestamp($stamp1, "rendering");
+
        return $output;
 }}
 
@@ -58,6 +49,7 @@ function random_string($size = 64,$type = RANDOM_STRING_HEX) {
        return(substr($s,0,$size));
 }}
 
+if(! function_exists('notags')) {
 /**
  * This is our primary input filter. 
  *
@@ -72,9 +64,9 @@ function random_string($size = 64,$type = RANDOM_STRING_HEX) {
  * They will be replaced with safer brackets. This may be filtered further
  * if these are not allowed either.   
  *
+ * @param string $string Input string
+ * @return string Filtered string
  */
-
-if(! function_exists('notags')) {
 function notags($string) {
 
        return(str_replace(array("<",">"), array('[',']'), $string));
@@ -83,10 +75,15 @@ function notags($string) {
 //     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')) {
+/**
+ * use this on "body" or "content" input where angle chars shouldn't be removed,
+ * and allow them to be safely displayed.
+ * @param string $string
+ * @return string
+ */
 function escape_tags($string) {
 
        return(htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false));
@@ -97,6 +94,12 @@ function escape_tags($string) {
 // used to generate initial passwords
 
 if(! function_exists('autoname')) {
+/**
+ * generate a string that's random, but usually pronounceable. 
+ * used to generate initial passwords
+ * @param int $len
+ * @return string
+ */
 function autoname($len) {
 
        if($len <= 0)
@@ -172,11 +175,17 @@ function autoname($len) {
 // returns escaped text.
 
 if(! function_exists('xmlify')) {
+/**
+ * escape text ($str) for XML transport
+ * @param string $str
+ * @return string Escaped text.
+ */
 function xmlify($str) {
-       $buffer = '';
+/*     $buffer = '';
        
-       for($x = 0; $x < mb_strlen($str); $x ++) {
-               $char = $str[$x];
+       $len = mb_strlen($str);
+       for($x = 0; $x < $len; $x ++) {
+               $char = mb_substr($str,$x,1);
         
                switch( $char ) {
 
@@ -204,24 +213,41 @@ function xmlify($str) {
                                $buffer .= $char;
                                break;
                }       
-       }
+       }*/
+
+       $buffer = mb_ereg_replace("&", "&amp;", $str);
+       $buffer = mb_ereg_replace("'", "&apos;", $buffer);
+       $buffer = mb_ereg_replace("\"", "&quot;", $buffer);
+       $buffer = mb_ereg_replace("<", "&lt;", $buffer);
+       $buffer = mb_ereg_replace(">", "&gt;", $buffer);
+
        $buffer = trim($buffer);
        return($buffer);
 }}
 
-// undo an xmlify
-// pass xml escaped text ($s), returns unescaped text
-
 if(! function_exists('unxmlify')) {
+/**
+ * undo an xmlify
+ * @param string $s xml escaped text
+ * @return string unescaped text
+ */
 function unxmlify($s) {
-       $ret = str_replace('&amp;','&', $s);
-       $ret = str_replace(array('&lt;','&gt;','&quot;','&apos;'),array('<','>','"',"'"),$ret);
+//     $ret = str_replace('&amp;','&', $s);
+//     $ret = str_replace(array('&lt;','&gt;','&quot;','&apos;'),array('<','>','"',"'"),$ret);
+       $ret = mb_ereg_replace('&amp;', '&', $s);
+       $ret = mb_ereg_replace('&apos;', "'", $ret);
+       $ret = mb_ereg_replace('&quot;', '"', $ret);
+       $ret = mb_ereg_replace('&lt;', "<", $ret);
+       $ret = mb_ereg_replace('&gt;', ">", $ret);
        return $ret;    
 }}
 
-// convenience wrapper, reverse the operation "bin2hex"
-
 if(! function_exists('hex2bin')) {
+/**
+ * convenience wrapper, reverse the operation "bin2hex"
+ * @param string $s
+ * @return number
+ */
 function hex2bin($s) {
        if(! (is_string($s) && strlen($s)))
                return '';
@@ -233,17 +259,23 @@ 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')) {
+/**
+ * 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. 
+ * 
+ * @param App $a App instance
+ * @return string html for pagination #FIXME remove html
+ */
 function paginate(&$a) {
        $o = '';
        $stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
@@ -300,6 +332,12 @@ function paginate(&$a) {
 }}
 
 if(! function_exists('alt_pager')) {
+/**
+ * Alternative pager
+ * @param App $a App instance
+ * @param int $i
+ * @return string html for pagination #FIXME remove html
+ */
 function alt_pager(&$a, $i) {
         $o = '';
        $stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
@@ -324,9 +362,14 @@ function alt_pager(&$a, $i) {
        return $o;
 }}
 
-// Turn user/group ACLs stored as angle bracketed text into arrays
 
 if(! function_exists('expand_acl')) {
+/**
+ * Turn user/group ACLs stored as angle bracketed text into arrays
+ * 
+ * @param string $s
+ * @return array
+ */
 function expand_acl($s) {
        // turn string array of angle-bracketed elements into numeric array
        // e.g. "<1><2><3>" => array(1,2,3);
@@ -343,9 +386,11 @@ function expand_acl($s) {
        return $ret;
 }}             
 
-// Used to wrap ACL elements in angle brackets for storage 
-
 if(! function_exists('sanitise_acl')) {
+/**
+ * Wrap ACL elements in angle brackets for storage 
+ * @param string $item
+ */
 function sanitise_acl(&$item) {
        if(intval($item))
                $item = '<' . intval(notags(trim($item))) . '>';
@@ -354,14 +399,18 @@ function sanitise_acl(&$item) {
 }}
 
 
-// Convert an ACL array to a storable string
-// Normally ACL permissions will be an array.
-// We'll also allow a comma-separated string.
-
 if(! function_exists('perms2str')) {
+/**
+ * Convert an ACL array to a storable string
+ * 
+ * Normally ACL permissions will be an array.
+ * We'll also allow a comma-separated string.
+ * 
+ * @param string|array $p
+ * @return string
+ */
 function perms2str($p) {
        $ret = '';
-
        if(is_array($p))
                $tmp = $p;
        else
@@ -374,10 +423,16 @@ 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')) {
+/**
+ * generate a guaranteed unique (for this domain) item ID for ATOM
+ * safe from birthday paradox
+ * 
+ * @param string $hostname
+ * @param int $uid
+ * @return string
+ */
 function item_new_uri($hostname,$uid) {
 
        do {
@@ -398,6 +453,12 @@ function item_new_uri($hostname,$uid) {
 // safe from birthday paradox
 
 if(! function_exists('photo_new_resource')) {
+/**
+ * Generate a guaranteed unique photo ID.
+ * safe from birthday paradox
+ * 
+ * @return string
+ */    
 function photo_new_resource() {
 
        do {
@@ -413,30 +474,54 @@ function photo_new_resource() {
 }}
 
 
-// wrapper to load a view template, checking for alternate
-// languages before falling back to the default
-
-// obsolete, deprecated.
-
 if(! function_exists('load_view_file')) {
+/**
+ * @deprecated
+ * wrapper to load a view template, checking for alternate
+ * languages before falling back to the default
+ * 
+ * @global string $lang
+ * @global App $a
+ * @param string $s view name
+ * @return string
+ */    
 function load_view_file($s) {
        global $lang, $a;
        if(! isset($lang))
                $lang = 'en';
        $b = basename($s);
        $d = dirname($s);
-       if(file_exists("$d/$lang/$b"))
-               return file_get_contents("$d/$lang/$b");
-       
+       if(file_exists("$d/$lang/$b")) {
+               $stamp1 = microtime(true);
+               $content = file_get_contents("$d/$lang/$b");
+               $a->save_timestamp($stamp1, "file");
+               return $content;
+       }
+
        $theme = current_theme();
 
-       if(file_exists("$d/theme/$theme/$b"))
-               return file_get_contents("$d/theme/$theme/$b");
-                       
-       return file_get_contents($s);
+       if(file_exists("$d/theme/$theme/$b")) {
+               $stamp1 = microtime(true);
+               $content = file_get_contents("$d/theme/$theme/$b");
+               $a->save_timestamp($stamp1, "file");
+               return $content;
+       }
+
+       $stamp1 = microtime(true);
+       $content = file_get_contents($s);
+       $a->save_timestamp($stamp1, "file");
+       return $content;
 }}
 
 if(! function_exists('get_intltext_template')) {
+/**
+ * load a view template, checking for alternate
+ * languages before falling back to the default
+ * 
+ * @global string $lang
+ * @param string $s view path
+ * @return string
+ */
 function get_intltext_template($s) {
        global $lang;
 
@@ -448,40 +533,53 @@ function get_intltext_template($s) {
        if(! isset($lang))
                $lang = 'en';
 
-       if(file_exists("view/$lang$engine/$s"))
-               return file_get_contents("view/$lang$engine/$s");
-       elseif(file_exists("view/en$engine/$s"))
-               return file_get_contents("view/en$engine/$s");
-       else
-               return file_get_contents("view$engine/$s");
+       if(file_exists("view/$lang$engine/$s")) {
+               $stamp1 = microtime(true);
+               $content = file_get_contents("view/$lang$engine/$s");
+               $a->save_timestamp($stamp1, "file");
+               return $content;
+       } elseif(file_exists("view/en$engine/$s")) {
+               $stamp1 = microtime(true);
+               $content = file_get_contents("view/en$engine/$s");
+               $a->save_timestamp($stamp1, "file");
+               return $content;
+       } else {
+               $stamp1 = microtime(true);
+               $content = file_get_contents("view$engine/$s");
+               $a->save_timestamp($stamp1, "file");
+               return $content;
+       }
 }}
 
 if(! function_exists('get_markup_template')) {
+/**
+ * load template $s
+ * 
+ * @param string $s
+ * @param string $root
+ * @return string
+ */
 function get_markup_template($s, $root = '') {
-//     $ts = microtime();
-       $a = get_app();
+       $stamp1 = microtime(true);
 
-       if($a->theme['template_engine'] === 'smarty3') {
-               $template_file = get_template_file($a, 'smarty3/' . $s, $root);
-
-               $template = new FriendicaSmarty();
-               $template->filename = $template_file;
-
-//             $tt = microtime() - $ts;
-//             $a->page['debug'] .= "$tt <br>\n";
-               return $template;
-       }
-       else {
-               $template_file = get_template_file($a, $s, $root);
-//             $file_contents = file_get_contents($template_file);
-//             $tt = microtime() - $ts;
-//             $a->page['debug'] .= "$tt <br>\n";
-//             return $file_contents;
-               return file_get_contents($template_file);
-       }       
+       $a = get_app();
+       $t = $a->template_engine();
+       
+       $template = $t->get_template_file($s, $root);
+       
+       $a->save_timestamp($stamp1, "file");
+       
+       return $template;
 }}
 
 if(! function_exists("get_template_file")) {
+/**
+ * 
+ * @param App $a
+ * @param string $filename
+ * @param string $root
+ * @return string
+ */
 function get_template_file($a, $filename, $root = '') {
        $theme = current_theme();
 
@@ -489,12 +587,14 @@ function get_template_file($a, $filename, $root = '') {
        if($root !== '' && $root[strlen($root)-1] !== '/')
                $root = $root . '/';
 
-       if(file_exists($root . "view/theme/$theme/$filename"))
-               $template_file = $root . "view/theme/$theme/$filename";
-       elseif (x($a->theme_info,"extends") && file_exists($root . "view/theme/".$a->theme_info["extends"]."/$filename"))
-               $template_file = $root . "view/theme/".$a->theme_info["extends"]."/$filename";
+       if(file_exists("{$root}view/theme/$theme/$filename"))
+               $template_file = "{$root}view/theme/$theme/$filename";
+       elseif (x($a->theme_info,"extends") && file_exists("{$root}view/theme/{$a->theme_info["extends"]}/$filename"))
+               $template_file = "{$root}view/theme/{$a->theme_info["extends"]}/$filename";
+       elseif (file_exists("{$root}/$filename"))
+               $template_file = "{$root}/$filename";
        else
-               $template_file = $root . "view/$filename";
+               $template_file = "{$root}view/$filename";
 
        return $template_file;
 }}
@@ -503,16 +603,23 @@ function get_template_file($a, $filename, $root = '') {
 
 
 
-// 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')) {
+/**
+ *  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
+ * 
+ * @param string $attr attribute value
+ * @param string $s string to search
+ * @return boolean True if found, False otherwise
+ */
 function attribute_contains($attr,$s) {
        $a = explode(' ', $attr);
        if(count($a) && in_array($s,$a))
@@ -521,6 +628,19 @@ function attribute_contains($attr,$s) {
 }}
 
 if(! function_exists('logger')) {
+/**
+ * log levels:
+ * LOGGER_NORMAL (default)
+ * LOGGER_TRACE
+ * LOGGER_DEBUG
+ * LOGGER_DATA
+ * LOGGER_ALL
+ * 
+ * @global App $a
+ * @global dba $db
+ * @param string $msg
+ * @param int $level
+ */
 function logger($msg,$level = 0) {
        // turn off logger in install mode
        global $a;
@@ -534,13 +654,22 @@ function logger($msg,$level = 0) {
 
        if((! $debugging) || (! $logfile) || ($level > $loglevel))
                return;
-       
+
+       $stamp1 = microtime(true);
        @file_put_contents($logfile, datetime_convert() . ':' . session_id() . ' ' . $msg . "\n", FILE_APPEND);
+       $a->save_timestamp($stamp1, "file");
        return;
 }}
 
 
 if(! function_exists('activity_match')) {
+/**
+ * Compare activity uri. Knows about activity namespace.
+ * 
+ * @param string $haystack
+ * @param string $needle
+ * @return boolean
+ */
 function activity_match($haystack,$needle) {
        if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
                return true;
@@ -548,24 +677,28 @@ function activity_match($haystack,$needle) {
 }}
 
 
-// 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')) {
+/**
+ * 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.
+ * 
+ * @param string $s
+ * @return array
+ */
 function get_tags($s) {
        $ret = array();
 
        // ignore anything in a code block
-
        $s = preg_replace('/\[code\](.*?)\[\/code\]/sm','',$s);
 
-       // ignore anything in a bbtag
+       // Force line feeds at bbtags
+       $s = str_replace(array("[", "]"), array("\n[", "]\n"), $s);
 
+       // ignore anything in a bbtag
        $s = preg_replace('/\[(.*?)\]/sm','',$s);
 
        // Match full names against @tags including the space between first and last
@@ -608,9 +741,15 @@ function get_tags($s) {
 }}
 
 
-// quick and dirty quoted_printable encoding
+// 
 
 if(! function_exists('qp')) {
+/**
+ * quick and dirty quoted_printable encoding
+ * 
+ * @param string $s
+ * @return string
+ */    
 function qp($s) {
 return str_replace ("%","=",rawurlencode($s));
 }} 
@@ -618,6 +757,10 @@ return str_replace ("%","=",rawurlencode($s));
 
 
 if(! function_exists('get_mentions')) {
+/**
+ * @param array $item
+ * @return string html for mentions #FIXME: remove html
+ */
 function get_mentions($item) {
        $o = '';
        if(! strlen($item['tag']))
@@ -635,6 +778,13 @@ function get_mentions($item) {
 }}
 
 if(! function_exists('contact_block')) {
+/**
+ * Get html for contact block.
+ * 
+ * @template contact_block.tpl
+ * @hook contact_block_end (contacts=>array, output=>string)
+ * @return string
+ */
 function contact_block() {
        $o = '';
        $a = get_app();
@@ -687,6 +837,14 @@ function contact_block() {
 }}
 
 if(! function_exists('micropro')) {
+/**
+ * 
+ * @param array $contact
+ * @param boolean $redirect
+ * @param string $class
+ * @param boolean $textmode
+ * @return string #FIXME: remove html
+ */
 function micropro($contact, $redirect = false, $class = '', $textmode = false) {
 
        if($class)
@@ -731,6 +889,15 @@ function micropro($contact, $redirect = false, $class = '', $textmode = false) {
 
 
 if(! function_exists('search')) {
+/**
+ * search box
+ * 
+ * @param string $s search query
+ * @param string $id html id
+ * @param string $url search url
+ * @param boolean $save show save search button
+ * @return string html for search box #FIXME: remove html
+ */
 function search($s,$id='search-box',$url='/search',$save = false) {
        $a = get_app();
        $o  = '<div id="' . $id . '">';
@@ -744,6 +911,12 @@ function search($s,$id='search-box',$url='/search',$save = false) {
 }}
 
 if(! function_exists('valid_email')) {
+/**
+ * Check if $x is a valid email string
+ * 
+ * @param string $x
+ * @return boolean
+ */
 function valid_email($x){
 
        if(get_config('system','disable_email_validation'))
@@ -755,21 +928,26 @@ function valid_email($x){
 }}
 
 
+if(! function_exists('linkify')) {
 /**
- *
- * Function: linkify
- *
  * Replace naked text hyperlink with HTML formatted hyperlink
  *
+ * @param string $s
  */
-
-if(! function_exists('linkify')) {
 function linkify($s) {
        $s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="external-link">$1</a>', $s);
        $s = preg_replace("/\<(.*?)(src|href)=(.*?)\&amp\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
        return($s);
 }}
 
+
+/**
+ * Load poke verbs
+ *
+ * @return array index is present tense verb
+                                value is array containing past tense verb, translation of present, translation of past
+ * @hook poke_verbs pokes array
+ */
 function get_poke_verbs() {
        
        // index is present tense verb
@@ -787,11 +965,13 @@ function get_poke_verbs() {
        return $arr;
 }
 
+/**
+ * Load moods
+ * @return array index is mood, value is translated mood
+ * @hook mood_verbs moods array
+ */
 function get_mood_verbs() {
        
-       // index is present tense verb
-       // value is array containing past tense verb, translation of present, translation of past
-
        $arr = array(
                'happy'      => t('happy'),
                'sad'        => t('sad'),
@@ -820,17 +1000,11 @@ function get_mood_verbs() {
 }
 
 
+
+if(! function_exists('smilies')) {
 /**
- * 
- * Function: smilies
- *
- * Description:
  * Replaces text emoticons with graphical images
  *
- * @Parameter: string $s
- *
- * Returns string
- *
  * It is expected that this function will be called using HTML text.
  * We will escape text between HTML pre and code blocks from being 
  * processed. 
@@ -839,11 +1013,12 @@ function get_mood_verbs() {
  * function from being executed by the prepare_text() routine when preparing
  * bbcode source for HTML display
  *
+ * @param string $s
+ * @param boolean $sample
+ * @return string
+ * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array, 'string' => $s)
  */
-
-if(! function_exists('smilies')) {
 function smilies($s, $sample = false) {
-
        $a = get_app();
 
        if(intval(get_config('system','no_smilies')) 
@@ -955,8 +1130,13 @@ function smile_decode($m) {
        return(str_replace($m[1],base64url_decode($m[1]),$m[0]));
 }
 
-// expand <3333 to the correct number of hearts
 
+/**
+ * expand <3333 to the correct number of hearts
+ * 
+ * @param string $x
+ * @return string
+ */
 function preg_heart($x) {
        $a = get_app();
        if(strlen($x[1]) == 1)
@@ -970,6 +1150,12 @@ function preg_heart($x) {
 
 
 if(! function_exists('day_translate')) {
+/**
+ * Translate days and months names
+ * 
+ * @param string $s
+ * @return string
+ */
 function day_translate($s) {
        $ret = str_replace(array('Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'),
                array( t('Monday'), t('Tuesday'), t('Wednesday'), t('Thursday'), t('Friday'), t('Saturday'), t('Sunday')),
@@ -984,50 +1170,108 @@ function day_translate($s) {
 
 
 if(! function_exists('normalise_link')) {
+/**
+ * Normalize url
+ * 
+ * @param string $url
+ * @return string
+ */
 function normalise_link($url) {
        $ret = str_replace(array('https:','//www.'), array('http:','//'), $url);
        return(rtrim($ret,'/'));
 }}
 
+
+
+if(! function_exists('link_compare')) {
 /**
- *
  * Compare two URLs to see if they are the same, but ignore
  * slight but hopefully insignificant differences such as if one 
  * is https and the other isn't, or if one is www.something and 
  * the other isn't - and also ignore case differences.
  *
- * Return true if the URLs match, otherwise false.
+ * @param string $a first url
+ * @param string $b second url
+ * @return boolean True if the URLs match, otherwise False
  *
- */
-
-if(! function_exists('link_compare')) {
+ */    
 function link_compare($a,$b) {
        if(strcasecmp(normalise_link($a),normalise_link($b)) === 0)
                return true;
        return false;
 }}
 
+
+if(! function_exists('redir_private_images')) {
+/**
+ * Find any non-embedded images in private items and add redir links to them
+ * 
+ * @param App $a
+ * @param array $item
+ */
+function redir_private_images($a, &$item) {
+
+       $matches = false;
+       $cnt = preg_match_all('|\[img\](http[^\[]*?/photo/[a-fA-F0-9]+?(-[0-9]\.[\w]+?)?)\[\/img\]|', $item['body'], $matches, PREG_SET_ORDER);
+       if($cnt) {
+               //logger("redir_private_images: matches = " . print_r($matches, true));
+               foreach($matches as $mtch) {
+                       if(strpos($mtch[1], '/redir') !== false)
+                               continue;
+
+                       if((local_user() == $item['uid']) && ($item['private'] != 0) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN)) {
+                               //logger("redir_private_images: redir");
+                               $img_url = $a->get_baseurl() . '/redir?f=1&quiet=1&url=' . $mtch[1] . '&conurl=' . $item['author-link'];
+                               $item['body'] = str_replace($mtch[0], "[img]".$img_url."[/img]", $item['body']);
+                       }
+               }
+       }
+
+}}
+
+
 // Given an item array, convert the body element from bbcode to html and add smilie icons.
 // If attach is true, also add icons for item attachments
 
-
 if(! function_exists('prepare_body')) {
+/**
+ * Given an item array, convert the body element from bbcode to html and add smilie icons.
+ * If attach is true, also add icons for item attachments
+ * 
+ * @param array $item
+ * @param boolean $attach
+ * @return string item body html
+ * @hook prepare_body_init item array before any work
+ * @hook prepare_body ('item'=>item array, 'html'=>body string) after first bbcode to html
+ * @hook prepare_body_final ('item'=>item array, 'html'=>body string) after attach icons and blockquote special case handling (spoiler, author)
+ */
 function prepare_body($item,$attach = false) {
 
        $a = get_app();
        call_hooks('prepare_body_init', $item);
 
-       $cachefile = get_cachefile($item["guid"]."-".strtotime($item["edited"])."-".hash("crc32", $item['body']));
+       //$cachefile = get_cachefile($item["guid"]."-".strtotime($item["edited"])."-".hash("crc32", $item['body']));
+       $cachefile = get_cachefile($item["guid"]."-".hash("md5", $item['body']));
 
        if (($cachefile != '')) {
-               if (file_exists($cachefile))
+               if (file_exists($cachefile)) {
+                       $stamp1 = microtime(true);
                        $s = file_get_contents($cachefile);
-               else {
+                       $a->save_timestamp($stamp1, "file");
+               } else {
+                       redir_private_images($a, $item);
                        $s = prepare_text($item['body']);
+
+                       $stamp1 = microtime(true);
                        file_put_contents($cachefile, $s);
+                       $a->save_timestamp($stamp1, "file");
+
+                       logger('prepare_body: put item '.$item["id"].' into cachefile '.$cachefile);
                }
-       } else
+       } else {
+               redir_private_images($a, $item);
                $s = prepare_text($item['body']);
+       }
 
 
        $prep_arr = array('item' => $item, 'html' => $s);
@@ -1041,16 +1285,58 @@ function prepare_body($item,$attach = false) {
                return $s;
        }
 
-       $arr = explode(',',$item['attach']);
+       $as = '';
+       $vhead = false;
+       $arr = explode('[/attach],',$item['attach']);
        if(count($arr)) {
-               $s .= '<div class="body-attach">';
+               $as .= '<div class="body-attach">';
                foreach($arr as $r) {
                        $matches = false;
                        $icon = '';
-                       $cnt = preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"\[\/attach\]|',$r,$matches, PREG_SET_ORDER);
+                       $cnt = preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|',$r,$matches, PREG_SET_ORDER);
                        if($cnt) {
                                foreach($matches as $mtch) {
-                                       $icontype = strtolower(substr($mtch[3],0,strpos($mtch[3],'/')));
+                                       $mime = $mtch[3];
+
+                                       if((local_user() == $item['uid']) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN))
+                                               $the_url = $a->get_baseurl() . '/redir/' . $item['contact-id'] . '?f=1&url=' . $mtch[1];
+                                       else
+                                               $the_url = $mtch[1];
+
+                                       if(strpos($mime, 'video') !== false) {
+                                               if(!$vhead) {
+                                                       $vhead = true;
+                                                       $a->page['htmlhead'] .= replace_macros(get_markup_template('videos_head.tpl'), array(
+                                                               '$baseurl' => $a->get_baseurl(),
+                                                       ));
+                                                       $a->page['end'] .= replace_macros(get_markup_template('videos_end.tpl'), array(
+                                                               '$baseurl' => $a->get_baseurl(),
+                                                       ));
+                                               }
+
+                                               $id = end(explode('/', $the_url));
+                                               $as .= replace_macros(get_markup_template('video_top.tpl'), array(
+                                                       '$video'        => array(
+                                                               'id'       => $id,
+                                                               'title'         => t('View Video'),
+                                                               'src'           => $the_url,
+                                                               'mime'          => $mime,
+                                                       ),
+                                               ));
+                                       }
+
+                                       $filetype = strtolower(substr( $mime, 0, strpos($mime,'/') ));
+                                       if($filetype) {
+                                               $filesubtype = strtolower(substr( $mime, strpos($mime,'/') + 1 ));
+                                               $filesubtype = str_replace('.', '-', $filesubtype);
+                                       }
+                                       else {
+                                               $filetype = 'unkn';
+                                               $filesubtype = 'unkn';
+                                       }
+
+                                       $icon = '<div class="attachtype icon s22 type-' . $filetype . ' subtype-' . $filesubtype . '"></div>';
+                                       /*$icontype = strtolower(substr($mtch[3],0,strpos($mtch[3],'/')));
                                        switch($icontype) {
                                                case 'video':
                                                case 'audio':
@@ -1061,20 +1347,18 @@ function prepare_body($item,$attach = false) {
                                                default:
                                                        $icon = '<div class="attachtype icon s22 type-unkn"></div>';
                                                        break;
-                                       }
+                                       }*/
+
                                        $title = ((strlen(trim($mtch[4]))) ? escape_tags(trim($mtch[4])) : escape_tags($mtch[1]));
                                        $title .= ' ' . $mtch[2] . ' ' . t('bytes');
-                                       if((local_user() == $item['uid']) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN))
-                                               $the_url = $a->get_baseurl() . '/redir/' . $item['contact-id'] . '?f=1&url=' . $mtch[1];
-                                       else
-                                               $the_url = $mtch[1];
 
-                                       $s .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="external-link" >' . $icon . '</a>';
+                                       $as .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="external-link" >' . $icon . '</a>';
                                }
                        }
                }
-               $s .= '<div class="clear"></div></div>';
+               $as .= '<div class="clear"></div></div>';
        }
+       $s = $s . $as;
 
 
        // Look for spoiler
@@ -1114,9 +1398,13 @@ function prepare_body($item,$attach = false) {
 }}
 
 
-// Given a text string, convert from bbcode to html and add smilie icons.
-
 if(! function_exists('prepare_text')) {
+/**
+ * Given a text string, convert from bbcode to html and add smilie icons.
+ * 
+ * @param string $text
+ * @return string
+ */
 function prepare_text($text) {
 
        require_once('include/bbcode.php');
@@ -1130,19 +1418,25 @@ function prepare_text($text) {
 }}
 
 
+
 /**
- * returns 
- * [
- *    //categories [
+ * return array with details for categories and folders for an item
+ * 
+ * @param array $item
+ * @return array
+ * 
+  * [
+ *      [ // categories array
  *          {
  *               'name': 'category name',
- *              'removeurl': 'url to remove this category',
- *             'first': 'is the first in this array? true/false',
+ *               'removeurl': 'url to remove this category',
+ *               'first': 'is the first in this array? true/false',
  *               'last': 'is the last in this array? true/false',
  *           } ,
  *           ....
  *       ],
- *       // folders [
+ *       [ //folders array
+ *                     {
  *               'name': 'folder name',
  *               'removeurl': 'url to remove this folder',
  *               'first': 'is the first in this array? true/false',
@@ -1150,9 +1444,10 @@ function prepare_text($text) {
  *           } ,
  *           ....       
  *       ]
- *   ]
+ *  ]
  */
 function get_cats_and_terms($item) {
+
     $a = get_app();
     $categories = array();
     $folders = array();
@@ -1197,11 +1492,12 @@ function get_cats_and_terms($item) {
 }
 
 
+
+if(! function_exists('feed_hublinks')) {
 /**
  * return atom link elements for all of our hubs
+ * @return string hub link xml elements
  */
-
-if(! function_exists('feed_hublinks')) {
 function feed_hublinks() {
 
        $hub = get_config('system','huburl');
@@ -1221,9 +1517,13 @@ function feed_hublinks() {
        return $hubxml;
 }}
 
-/* return atom link elements for salmon endpoints */
 
 if(! function_exists('feed_salmonlinks')) {
+/**
+ * return atom link elements for salmon endpoints
+ * @param string $nick user nickname
+ * @return string salmon link xml elements
+ */
 function feed_salmonlinks($nick) {
 
        $a = get_app();
@@ -1238,6 +1538,11 @@ function feed_salmonlinks($nick) {
 }}
 
 if(! function_exists('get_plink')) {
+/**
+ * get private link for item
+ * @param array $item
+ * @return boolean|array False if item has not plink, otherwise array('href'=>plink url, 'title'=>translated title)
+ */
 function get_plink($item) {
        $a = get_app(); 
        if (x($item,'plink') && ($item['private'] != 1)) {
@@ -1252,6 +1557,11 @@ function get_plink($item) {
 }}
 
 if(! function_exists('unamp')) {
+/**
+ * replace html amp entity with amp char
+ * @param string $s
+ * @return string
+ */
 function unamp($s) {
        return str_replace('&amp;', '&', $s);
 }}
@@ -1260,6 +1570,12 @@ function unamp($s) {
 
 
 if(! function_exists('lang_selector')) {
+/**
+ * get html for language selector
+ * @global string $lang
+ * @return string 
+ * @template lang_selector.tpl
+ */
 function lang_selector() {
        global $lang;
        
@@ -1296,6 +1612,11 @@ function lang_selector() {
 
 
 if(! function_exists('return_bytes')) {
+/**
+ * return number of bytes in size (K, M, G)
+ * @param string $size_str
+ * @return number
+ */
 function return_bytes ($size_str) {
     switch (substr ($size_str, -1))
     {
@@ -1306,6 +1627,9 @@ function return_bytes ($size_str) {
     }
 }}
 
+/**
+ * @return string
+ */
 function generate_user_guid() {
        $found = true;
        do {
@@ -1320,7 +1644,11 @@ function generate_user_guid() {
 }
 
 
-
+/**
+ * @param string $s
+ * @param boolean $strip_padding
+ * @return string
+ */
 function base64url_encode($s, $strip_padding = false) {
 
        $s = strtr(base64_encode($s),'+/','-_');
@@ -1331,6 +1659,10 @@ function base64url_encode($s, $strip_padding = false) {
        return $s;
 }
 
+/**
+ * @param string $s
+ * @return string
+ */
 function base64url_decode($s) {
 
        if(is_array($s)) {
@@ -1359,6 +1691,16 @@ function base64url_decode($s) {
 
 
 if (!function_exists('str_getcsv')) {
+       /**
+        * Parse csv string
+        * 
+        * @param string $input
+        * @param string $delimiter
+        * @param string $enclosure
+        * @param string $escape
+        * @param string $eol
+        * @return boolean|array False on error, otherwise array[row][column]
+        */
     function str_getcsv($input, $delimiter = ',', $enclosure = '"', $escape = '\\', $eol = '\n') {
         if (is_string($input) && !empty($input)) {
             $output = array();
@@ -1415,6 +1757,11 @@ if (!function_exists('str_getcsv')) {
     }
 } 
 
+/**
+ * return div element with class 'clear'
+ * @return string
+ * @deprecated
+ */
 function cleardiv() {
        return '<div class="clear"></div>';
 }
@@ -1451,6 +1798,8 @@ function html2bb_video($s) {
 
 /**
  * apply xmlify() to all values of array $val, recursively
+ * @param array $val
+ * @return array
  */
 function array_xmlify($val){
        if (is_bool($val)) return $val?"true":"false";
@@ -1459,6 +1808,13 @@ function array_xmlify($val){
 }
 
 
+/**
+ * transorm link href and img src from relative to absolute
+ * 
+ * @param string $text
+ * @param string $base base url
+ * @return string
+ */
 function reltoabs($text, $base)
 {
   if (empty($base))
@@ -1491,6 +1847,12 @@ function reltoabs($text, $base)
   return $text;
 }
 
+/**
+ * get translated item type
+ * 
+ * @param array $itme
+ * @return string
+ */
 function item_post_type($item) {
        if(intval($item['event-id']))
                return t('event');