]> git.mxchange.org Git - friendica.git/blob - include/text.php
Merge pull request #2044 from fabrixxm/issue_1249
[friendica.git] / include / text.php
1 <?php
2
3 require_once("include/template_processor.php");
4 require_once("include/friendica_smarty.php");
5 require_once("include/map.php");
6 require_once("mod/proxy.php");
7
8
9 if(! function_exists('replace_macros')) {
10 /**
11  * This is our template processor
12  *
13  * @param string|FriendicaSmarty $s the string requiring macro substitution,
14  *                                                                      or an instance of FriendicaSmarty
15  * @param array $r key value pairs (search => replace)
16  * @return string substituted string
17  */
18 function replace_macros($s,$r) {
19
20         $stamp1 = microtime(true);
21
22         $a = get_app();
23
24         $t = $a->template_engine();
25         try {
26                 $output = $t->replace_macros($s,$r);
27         } catch (Exception $e) {
28                 echo "<pre><b>".__function__."</b>: ".$e->getMessage()."</pre>"; killme();
29         }
30
31         $a->save_timestamp($stamp1, "rendering");
32
33         return $output;
34 }}
35
36
37 // random string, there are 86 characters max in text mode, 128 for hex
38 // output is urlsafe
39
40 define('RANDOM_STRING_HEX',  0x00 );
41 define('RANDOM_STRING_TEXT', 0x01 );
42
43 if(! function_exists('random_string')) {
44 function random_string($size = 64,$type = RANDOM_STRING_HEX) {
45         // generate a bit of entropy and run it through the whirlpool
46         $s = hash('whirlpool', (string) rand() . uniqid(rand(),true) . (string) rand(),(($type == RANDOM_STRING_TEXT) ? true : false));
47         $s = (($type == RANDOM_STRING_TEXT) ? str_replace("\n","",base64url_encode($s,true)) : $s);
48         return(substr($s,0,$size));
49 }}
50
51 if(! function_exists('notags')) {
52 /**
53  * This is our primary input filter.
54  *
55  * The high bit hack only involved some old IE browser, forget which (IE5/Mac?)
56  * that had an XSS attack vector due to stripping the high-bit on an 8-bit character
57  * after cleansing, and angle chars with the high bit set could get through as markup.
58  *
59  * This is now disabled because it was interfering with some legitimate unicode sequences
60  * and hopefully there aren't a lot of those browsers left.
61  *
62  * Use this on any text input where angle chars are not valid or permitted
63  * They will be replaced with safer brackets. This may be filtered further
64  * if these are not allowed either.
65  *
66  * @param string $string Input string
67  * @return string Filtered string
68  */
69 function notags($string) {
70
71         return(str_replace(array("<",">"), array('[',']'), $string));
72
73 //  High-bit filter no longer used
74 //      return(str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string));
75 }}
76
77
78
79 if(! function_exists('escape_tags')) {
80 /**
81  * use this on "body" or "content" input where angle chars shouldn't be removed,
82  * and allow them to be safely displayed.
83  * @param string $string
84  * @return string
85  */
86 function escape_tags($string) {
87
88         return(htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false));
89 }}
90
91
92 // generate a string that's random, but usually pronounceable.
93 // used to generate initial passwords
94
95 if(! function_exists('autoname')) {
96 /**
97  * generate a string that's random, but usually pronounceable.
98  * used to generate initial passwords
99  * @param int $len
100  * @return string
101  */
102 function autoname($len) {
103
104         if($len <= 0)
105                 return '';
106
107         $vowels = array('a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u');
108         if(mt_rand(0,5) == 4)
109                 $vowels[] = 'y';
110
111         $cons = array(
112                         'b','bl','br',
113                         'c','ch','cl','cr',
114                         'd','dr',
115                         'f','fl','fr',
116                         'g','gh','gl','gr',
117                         'h',
118                         'j',
119                         'k','kh','kl','kr',
120                         'l',
121                         'm',
122                         'n',
123                         'p','ph','pl','pr',
124                         'qu',
125                         'r','rh',
126                         's','sc','sh','sm','sp','st',
127                         't','th','tr',
128                         'v',
129                         'w','wh',
130                         'x',
131                         'z','zh'
132                         );
133
134         $midcons = array('ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
135                                 'nd','ng','nk','nt','rn','rp','rt');
136
137         $noend = array('bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
138                                 'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh');
139
140         $start = mt_rand(0,2);
141         if($start == 0)
142                 $table = $vowels;
143         else
144                 $table = $cons;
145
146         $word = '';
147
148         for ($x = 0; $x < $len; $x ++) {
149                 $r = mt_rand(0,count($table) - 1);
150                 $word .= $table[$r];
151
152                 if($table == $vowels)
153                         $table = array_merge($cons,$midcons);
154                 else
155                         $table = $vowels;
156
157         }
158
159         $word = substr($word,0,$len);
160
161         foreach($noend as $noe) {
162                 if((strlen($word) > 2) && (substr($word,-2) == $noe)) {
163                         $word = substr($word,0,-1);
164                         break;
165                 }
166         }
167         if(substr($word,-1) == 'q')
168                 $word = substr($word,0,-1);
169         return $word;
170 }}
171
172
173 // escape text ($str) for XML transport
174 // returns escaped text.
175
176 if(! function_exists('xmlify')) {
177 /**
178  * escape text ($str) for XML transport
179  * @param string $str
180  * @return string Escaped text.
181  */
182 function xmlify($str) {
183 /*      $buffer = '';
184
185         $len = mb_strlen($str);
186         for($x = 0; $x < $len; $x ++) {
187                 $char = mb_substr($str,$x,1);
188
189                 switch( $char ) {
190
191                         case "\r" :
192                                 break;
193                         case "&" :
194                                 $buffer .= '&amp;';
195                                 break;
196                         case "'" :
197                                 $buffer .= '&apos;';
198                                 break;
199                         case "\"" :
200                                 $buffer .= '&quot;';
201                                 break;
202                         case '<' :
203                                 $buffer .= '&lt;';
204                                 break;
205                         case '>' :
206                                 $buffer .= '&gt;';
207                                 break;
208                         case "\n" :
209                                 $buffer .= "\n";
210                                 break;
211                         default :
212                                 $buffer .= $char;
213                                 break;
214                 }
215         }*/
216         /*
217         $buffer = mb_ereg_replace("&", "&amp;", $str);
218         $buffer = mb_ereg_replace("'", "&apos;", $buffer);
219         $buffer = mb_ereg_replace('"', "&quot;", $buffer);
220         $buffer = mb_ereg_replace("<", "&lt;", $buffer);
221         $buffer = mb_ereg_replace(">", "&gt;", $buffer);
222         */
223         $buffer = htmlspecialchars($str, ENT_QUOTES, "UTF-8");
224         $buffer = trim($buffer);
225
226         return($buffer);
227 }}
228
229 if(! function_exists('unxmlify')) {
230 /**
231  * undo an xmlify
232  * @param string $s xml escaped text
233  * @return string unescaped text
234  */
235 function unxmlify($s) {
236 //      $ret = str_replace('&amp;','&', $s);
237 //      $ret = str_replace(array('&lt;','&gt;','&quot;','&apos;'),array('<','>','"',"'"),$ret);
238         /*$ret = mb_ereg_replace('&amp;', '&', $s);
239         $ret = mb_ereg_replace('&apos;', "'", $ret);
240         $ret = mb_ereg_replace('&quot;', '"', $ret);
241         $ret = mb_ereg_replace('&lt;', "<", $ret);
242         $ret = mb_ereg_replace('&gt;', ">", $ret);
243         */
244         $ret = htmlspecialchars_decode($s, ENT_QUOTES);
245         return $ret;
246 }}
247
248 if(! function_exists('hex2bin')) {
249 /**
250  * convenience wrapper, reverse the operation "bin2hex"
251  * @param string $s
252  * @return number
253  */
254 function hex2bin($s) {
255         if(! (is_string($s) && strlen($s)))
256                 return '';
257
258         if(! ctype_xdigit($s)) {
259                 return($s);
260         }
261
262         return(pack("H*",$s));
263 }}
264
265
266 if(! function_exists('paginate_data')) {
267 /**
268  * Automatica pagination data.
269  *
270  * @param App $a App instance
271  * @param int $count [optional] item count (used with alt pager)
272  * @return Array data for pagination template
273  */
274 function paginate_data(&$a, $count=null) {
275         $stripped = preg_replace('/([&?]page=[0-9]*)/','',$a->query_string);
276
277         $stripped = str_replace('q=','',$stripped);
278         $stripped = trim($stripped,'/');
279         $pagenum = $a->pager['page'];
280
281         if (($a->page_offset != "") AND !preg_match('/[?&].offset=/', $stripped))
282                 $stripped .= "&offset=".urlencode($a->page_offset);
283
284         $url = $a->get_baseurl() . '/' . $stripped;
285
286         $data = array();
287         function _l(&$d, $name, $url, $text, $class="") {
288                 if (!strpos($url, "?")) {
289                         if ($pos = strpos($url, "&"))
290                                 $url = substr($url, 0, $pos)."?".substr($url, $pos + 1);
291                 }
292
293                 $d[$name] = array('url'=>$url, 'text'=>$text, 'class'=>$class);
294         }
295
296         if (!is_null($count)){
297                 // alt pager
298                 if($a->pager['page']>1)
299                         _l($data,  "prev", $url.'&page='.($a->pager['page'] - 1), t('newer'));
300                 if($count>0)
301                         _l($data,  "next", $url.'&page='.($a->pager['page'] + 1), t('older'));
302         } else {
303                 // full pager
304                 if($a->pager['total'] > $a->pager['itemspage']) {
305                         if($a->pager['page'] != 1)
306                                 _l($data,  "prev", $url.'&page='.($a->pager['page'] - 1), t('prev'));
307
308                         _l($data, "first", $url."&page=1",  t('first'));
309
310
311                         $numpages = $a->pager['total'] / $a->pager['itemspage'];
312
313                         $numstart = 1;
314                         $numstop = $numpages;
315
316                         if($numpages > 14) {
317                                 $numstart = (($pagenum > 7) ? ($pagenum - 7) : 1);
318                                 $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 14));
319                         }
320
321                         $pages = array();
322
323                         for($i = $numstart; $i <= $numstop; $i++){
324                                 if($i == $a->pager['page'])
325                                         _l($pages, $i, "#",  $i, "current");
326                                 else
327                                         _l($pages, $i, $url."&page=$i", $i, "n");
328                         }
329
330                         if(($a->pager['total'] % $a->pager['itemspage']) != 0) {
331                                 if($i == $a->pager['page'])
332                                         _l($pages, $i, "#",  $i, "current");
333                                 else
334                                         _l($pages, $i, $url."&page=$i", $i, "n");
335                         }
336
337                         $data['pages'] = $pages;
338
339                         $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
340                         _l($data, "last", $url."&page=$lastpage", t('last'));
341
342                         if(($a->pager['total'] - ($a->pager['itemspage'] * $a->pager['page'])) > 0)
343                                 _l($data, "next", $url."&page=".($a->pager['page'] + 1), t('next'));
344
345                 }
346         }
347         return $data;
348
349 }}
350
351 if(! function_exists('paginate')) {
352 /**
353  * Automatic pagination.
354  *
355  *  To use, get the count of total items.
356  * Then call $a->set_pager_total($number_items);
357  * Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
358  * Then call paginate($a) after the end of the display loop to insert the pager block on the page
359  * (assuming there are enough items to paginate).
360  * When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
361  * will limit the results to the correct items for the current page.
362  * The actual page handling is then accomplished at the application layer.
363  *
364  * @param App $a App instance
365  * @return string html for pagination #FIXME remove html
366  */
367 function paginate(&$a) {
368
369         $data = paginate_data($a);
370         $tpl = get_markup_template("paginate.tpl");
371         return replace_macros($tpl, array("pager" => $data));
372
373 }}
374
375 if(! function_exists('alt_pager')) {
376 /**
377  * Alternative pager
378  * @param App $a App instance
379  * @param int $i
380  * @return string html for pagination #FIXME remove html
381  */
382 function alt_pager(&$a, $i) {
383
384         $data = paginate_data($a, $i);
385         $tpl = get_markup_template("paginate.tpl");
386         return replace_macros($tpl, array('pager' => $data));
387
388 }}
389
390 if(! function_exists('scroll_loader')) {
391 /**
392  * Loader for infinite scrolling
393  * @return string html for loader
394  */
395 function scroll_loader() {
396         $tpl = get_markup_template("scroll_loader.tpl");
397         return replace_macros($tpl, array(
398                 'wait' => t('Loading more entries...'),
399                 'end' => t('The end')
400         ));
401 }}
402
403 if(! function_exists('expand_acl')) {
404 /**
405  * Turn user/group ACLs stored as angle bracketed text into arrays
406  *
407  * @param string $s
408  * @return array
409  */
410 function expand_acl($s) {
411         // turn string array of angle-bracketed elements into numeric array
412         // e.g. "<1><2><3>" => array(1,2,3);
413         $ret = array();
414
415         if(strlen($s)) {
416                 $t = str_replace('<','',$s);
417                 $a = explode('>',$t);
418                 foreach($a as $aa) {
419                         if(intval($aa))
420                                 $ret[] = intval($aa);
421                 }
422         }
423         return $ret;
424 }}
425
426 if(! function_exists('sanitise_acl')) {
427 /**
428  * Wrap ACL elements in angle brackets for storage
429  * @param string $item
430  */
431 function sanitise_acl(&$item) {
432         if(intval($item))
433                 $item = '<' . intval(notags(trim($item))) . '>';
434         else
435                 unset($item);
436 }}
437
438
439 if(! function_exists('perms2str')) {
440 /**
441  * Convert an ACL array to a storable string
442  *
443  * Normally ACL permissions will be an array.
444  * We'll also allow a comma-separated string.
445  *
446  * @param string|array $p
447  * @return string
448  */
449 function perms2str($p) {
450         $ret = '';
451         if(is_array($p))
452                 $tmp = $p;
453         else
454                 $tmp = explode(',',$p);
455
456         if(is_array($tmp)) {
457                 array_walk($tmp,'sanitise_acl');
458                 $ret = implode('',$tmp);
459         }
460         return $ret;
461 }}
462
463
464 if(! function_exists('item_new_uri')) {
465 /**
466  * generate a guaranteed unique (for this domain) item ID for ATOM
467  * safe from birthday paradox
468  *
469  * @param string $hostname
470  * @param int $uid
471  * @return string
472  */
473 function item_new_uri($hostname,$uid, $guid = "") {
474
475         do {
476                 $dups = false;
477
478                 if ($guid == "")
479                         $hash = get_guid(32);
480                 else {
481                         $hash = $guid;
482                         $guid = "";
483                 }
484
485                 $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
486
487                 $r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1",
488                         dbesc($uri));
489                 if(count($r))
490                         $dups = true;
491         } while($dups == true);
492         return $uri;
493 }}
494
495 // Generate a guaranteed unique photo ID.
496 // safe from birthday paradox
497
498 if(! function_exists('photo_new_resource')) {
499 /**
500  * Generate a guaranteed unique photo ID.
501  * safe from birthday paradox
502  *
503  * @return string
504  */
505 function photo_new_resource() {
506
507         do {
508                 $found = false;
509                 $resource = hash('md5',uniqid(mt_rand(),true));
510                 $r = q("SELECT `id` FROM `photo` WHERE `resource-id` = '%s' LIMIT 1",
511                         dbesc($resource)
512                 );
513                 if(count($r))
514                         $found = true;
515         } while($found == true);
516         return $resource;
517 }}
518
519
520 if(! function_exists('load_view_file')) {
521 /**
522  * @deprecated
523  * wrapper to load a view template, checking for alternate
524  * languages before falling back to the default
525  *
526  * @global string $lang
527  * @global App $a
528  * @param string $s view name
529  * @return string
530  */
531 function load_view_file($s) {
532         global $lang, $a;
533         if(! isset($lang))
534                 $lang = 'en';
535         $b = basename($s);
536         $d = dirname($s);
537         if(file_exists("$d/$lang/$b")) {
538                 $stamp1 = microtime(true);
539                 $content = file_get_contents("$d/$lang/$b");
540                 $a->save_timestamp($stamp1, "file");
541                 return $content;
542         }
543
544         $theme = current_theme();
545
546         if(file_exists("$d/theme/$theme/$b")) {
547                 $stamp1 = microtime(true);
548                 $content = file_get_contents("$d/theme/$theme/$b");
549                 $a->save_timestamp($stamp1, "file");
550                 return $content;
551         }
552
553         $stamp1 = microtime(true);
554         $content = file_get_contents($s);
555         $a->save_timestamp($stamp1, "file");
556         return $content;
557 }}
558
559 if(! function_exists('get_intltext_template')) {
560 /**
561  * load a view template, checking for alternate
562  * languages before falling back to the default
563  *
564  * @global string $lang
565  * @param string $s view path
566  * @return string
567  */
568 function get_intltext_template($s) {
569         global $lang;
570
571         $a = get_app();
572         $engine = '';
573         if($a->theme['template_engine'] === 'smarty3')
574                 $engine = "/smarty3";
575
576         if(! isset($lang))
577                 $lang = 'en';
578
579         if(file_exists("view/$lang$engine/$s")) {
580                 $stamp1 = microtime(true);
581                 $content = file_get_contents("view/$lang$engine/$s");
582                 $a->save_timestamp($stamp1, "file");
583                 return $content;
584         } elseif(file_exists("view/en$engine/$s")) {
585                 $stamp1 = microtime(true);
586                 $content = file_get_contents("view/en$engine/$s");
587                 $a->save_timestamp($stamp1, "file");
588                 return $content;
589         } else {
590                 $stamp1 = microtime(true);
591                 $content = file_get_contents("view$engine/$s");
592                 $a->save_timestamp($stamp1, "file");
593                 return $content;
594         }
595 }}
596
597 if(! function_exists('get_markup_template')) {
598 /**
599  * load template $s
600  *
601  * @param string $s
602  * @param string $root
603  * @return string
604  */
605 function get_markup_template($s, $root = '') {
606         $stamp1 = microtime(true);
607
608         $a = get_app();
609         $t = $a->template_engine();
610         try {
611                 $template = $t->get_template_file($s, $root);
612         } catch (Exception $e) {
613                 echo "<pre><b>".__function__."</b>: ".$e->getMessage()."</pre>"; killme();
614         }
615
616         $a->save_timestamp($stamp1, "file");
617
618         return $template;
619 }}
620
621 if(! function_exists("get_template_file")) {
622 /**
623  *
624  * @param App $a
625  * @param string $filename
626  * @param string $root
627  * @return string
628  */
629 function get_template_file($a, $filename, $root = '') {
630         $theme = current_theme();
631
632         // Make sure $root ends with a slash /
633         if($root !== '' && $root[strlen($root)-1] !== '/')
634                 $root = $root . '/';
635
636         if(file_exists("{$root}view/theme/$theme/$filename"))
637                 $template_file = "{$root}view/theme/$theme/$filename";
638         elseif (x($a->theme_info,"extends") && file_exists("{$root}view/theme/{$a->theme_info["extends"]}/$filename"))
639                 $template_file = "{$root}view/theme/{$a->theme_info["extends"]}/$filename";
640         elseif (file_exists("{$root}/$filename"))
641                 $template_file = "{$root}/$filename";
642         else
643                 $template_file = "{$root}view/$filename";
644
645         return $template_file;
646 }}
647
648
649
650
651
652
653
654 if(! function_exists('attribute_contains')) {
655 /**
656  *  for html,xml parsing - let's say you've got
657  *  an attribute foobar="class1 class2 class3"
658  *  and you want to find out if it contains 'class3'.
659  *  you can't use a normal sub string search because you
660  *  might match 'notclass3' and a regex to do the job is
661  *  possible but a bit complicated.
662  *  pass the attribute string as $attr and the attribute you
663  *  are looking for as $s - returns true if found, otherwise false
664  *
665  * @param string $attr attribute value
666  * @param string $s string to search
667  * @return boolean True if found, False otherwise
668  */
669 function attribute_contains($attr,$s) {
670         $a = explode(' ', $attr);
671         if(count($a) && in_array($s,$a))
672                 return true;
673         return false;
674 }}
675
676 if(! function_exists('logger')) {
677 /* setup int->string log level map */
678 $LOGGER_LEVELS = array();
679
680 /**
681  * log levels:
682  * LOGGER_NORMAL (default)
683  * LOGGER_TRACE
684  * LOGGER_DEBUG
685  * LOGGER_DATA
686  * LOGGER_ALL
687  *
688  * @global App $a
689  * @global dba $db
690  * @param string $msg
691  * @param int $level
692  */
693 function logger($msg,$level = 0) {
694         // turn off logger in install mode
695         global $a;
696         global $db;
697         global $LOGGER_LEVELS;
698
699         if(($a->module == 'install') || (! ($db && $db->connected))) return;
700
701         if (count($LOGGER_LEVELS)==0){
702                 foreach (get_defined_constants() as $k=>$v){
703                         if (substr($k,0,7)=="LOGGER_")
704                                 $LOGGER_LEVELS[$v] = substr($k,7,7);
705                 }
706         }
707
708         $debugging = get_config('system','debugging');
709         $loglevel  = intval(get_config('system','loglevel'));
710         $logfile   = get_config('system','logfile');
711
712         if((! $debugging) || (! $logfile) || ($level > $loglevel))
713                 return;
714
715         $callers = debug_backtrace();
716         $logline =  sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
717                                  datetime_convert(),
718                                  session_id(),
719                                  $LOGGER_LEVELS[$level],
720                                  basename($callers[0]['file']),
721                                  $callers[0]['line'],
722                                  $callers[1]['function'],
723                                  $msg
724                                 );
725
726         $stamp1 = microtime(true);
727         @file_put_contents($logfile, $logline, FILE_APPEND);
728         $a->save_timestamp($stamp1, "file");
729         return;
730 }}
731
732
733 if(! function_exists('activity_match')) {
734 /**
735  * Compare activity uri. Knows about activity namespace.
736  *
737  * @param string $haystack
738  * @param string $needle
739  * @return boolean
740  */
741 function activity_match($haystack,$needle) {
742         if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
743                 return true;
744         return false;
745 }}
746
747
748 if(! function_exists('get_tags')) {
749 /**
750  * Pull out all #hashtags and @person tags from $s;
751  * We also get @person@domain.com - which would make
752  * the regex quite complicated as tags can also
753  * end a sentence. So we'll run through our results
754  * and strip the period from any tags which end with one.
755  * Returns array of tags found, or empty array.
756  *
757  * @param string $s
758  * @return array
759  */
760 function get_tags($s) {
761         $ret = array();
762
763         // Convert hashtag links to hashtags
764         $s = preg_replace("/#\[url\=([^\[\]]*)\](.*?)\[\/url\]/ism", "#$2", $s);
765
766         // ignore anything in a code block
767         $s = preg_replace('/\[code\](.*?)\[\/code\]/sm','',$s);
768
769         // Force line feeds at bbtags
770         $s = str_replace(array("[", "]"), array("\n[", "]\n"), $s);
771
772         // ignore anything in a bbtag
773         $s = preg_replace('/\[(.*?)\]/sm','',$s);
774
775         // Match full names against @tags including the space between first and last
776         // We will look these up afterward to see if they are full names or not recognisable.
777
778         if(preg_match_all('/(@[^ \x0D\x0A,:?]+ [^ \x0D\x0A@,:?]+)([ \x0D\x0A@,:?]|$)/',$s,$match)) {
779                 foreach($match[1] as $mtch) {
780                         if(strstr($mtch,"]")) {
781                                 // we might be inside a bbcode color tag - leave it alone
782                                 continue;
783                         }
784                         if(substr($mtch,-1,1) === '.')
785                                 $ret[] = substr($mtch,0,-1);
786                         else
787                                 $ret[] = $mtch;
788                 }
789         }
790
791         // Otherwise pull out single word tags. These can be @nickname, @first_last
792         // and #hash tags.
793
794         if(preg_match_all('/([!#@][^ \x0D\x0A,;:?]+)([ \x0D\x0A,;:?]|$)/',$s,$match)) {
795                 foreach($match[1] as $mtch) {
796                         if(strstr($mtch,"]")) {
797                                 // we might be inside a bbcode color tag - leave it alone
798                                 continue;
799                         }
800                         if(substr($mtch,-1,1) === '.')
801                                 $mtch = substr($mtch,0,-1);
802                         // ignore strictly numeric tags like #1
803                         if((strpos($mtch,'#') === 0) && ctype_digit(substr($mtch,1)))
804                                 continue;
805                         // try not to catch url fragments
806                         if(strpos($s,$mtch) && preg_match('/[a-zA-z0-9\/]/',substr($s,strpos($s,$mtch)-1,1)))
807                                 continue;
808                         $ret[] = $mtch;
809                 }
810         }
811         return $ret;
812 }}
813
814
815 //
816
817 if(! function_exists('qp')) {
818 /**
819  * quick and dirty quoted_printable encoding
820  *
821  * @param string $s
822  * @return string
823  */
824 function qp($s) {
825 return str_replace ("%","=",rawurlencode($s));
826 }}
827
828
829
830 if(! function_exists('get_mentions')) {
831 /**
832  * @param array $item
833  * @return string html for mentions #FIXME: remove html
834  */
835 function get_mentions($item) {
836         $o = '';
837         if(! strlen($item['tag']))
838                 return $o;
839
840         $arr = explode(',',$item['tag']);
841         foreach($arr as $x) {
842                 $matches = null;
843                 if(preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
844                         $o .= "\t\t" . '<link rel="ostatus:attention" href="' . $matches[1] . '" />' . "\r\n";
845                         $o .= "\t\t" . '<link rel="mentioned" href="' . $matches[1] . '" />' . "\r\n";
846                 }
847         }
848
849         if (!$item['private']) {
850                         $o .= "\t\t".'<link rel="ostatus:attention" href="http://activityschema.org/collection/public"/>'."\r\n";
851                         $o .= "\t\t".'<link rel="mentioned" href="http://activityschema.org/collection/public"/>'."\r\n";
852         }
853
854         return $o;
855 }}
856
857 if(! function_exists('contact_block')) {
858 /**
859  * Get html for contact block.
860  *
861  * @template contact_block.tpl
862  * @hook contact_block_end (contacts=>array, output=>string)
863  * @return string
864  */
865 function contact_block() {
866         $o = '';
867         $a = get_app();
868
869         $shown = get_pconfig($a->profile['uid'],'system','display_friend_count');
870         if($shown === false)
871                 $shown = 24;
872         if($shown == 0)
873                 return;
874
875         if((! is_array($a->profile)) || ($a->profile['hide-friends']))
876                 return $o;
877         $r = q("SELECT COUNT(*) AS `total` FROM `contact`
878                         WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0
879                                 AND `hidden` = 0 AND `archive` = 0
880                                 AND `network` IN ('%s', '%s', '%s')",
881                         intval($a->profile['uid']),
882                         dbesc(NETWORK_DFRN),
883                         dbesc(NETWORK_OSTATUS),
884                         dbesc(NETWORK_DIASPORA)
885         );
886         if(count($r)) {
887                 $total = intval($r[0]['total']);
888         }
889         if(! $total) {
890                 $contacts = t('No contacts');
891                 $micropro = Null;
892
893         } else {
894                 $r = q("SELECT * FROM `contact`
895                                 WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0
896                                         AND `hidden` = 0 AND `archive` = 0
897                                 AND `network` IN ('%s', '%s', '%s') ORDER BY RAND() LIMIT %d",
898                                 intval($a->profile['uid']),
899                                 dbesc(NETWORK_DFRN),
900                                 dbesc(NETWORK_OSTATUS),
901                                 dbesc(NETWORK_DIASPORA),
902                                 intval($shown)
903                 );
904                 if(count($r)) {
905                         $contacts = sprintf( tt('%d Contact','%d Contacts', $total),$total);
906                         $micropro = Array();
907                         foreach($r as $rr) {
908                                 $micropro[] = micropro($rr,true,'mpfriend');
909                         }
910                 }
911         }
912
913         $tpl = get_markup_template('contact_block.tpl');
914         $o = replace_macros($tpl, array(
915                 '$contacts' => $contacts,
916                 '$nickname' => $a->profile['nickname'],
917                 '$viewcontacts' => t('View Contacts'),
918                 '$micropro' => $micropro,
919         ));
920
921         $arr = array('contacts' => $r, 'output' => $o);
922
923         call_hooks('contact_block_end', $arr);
924         return $o;
925
926 }}
927
928 if(! function_exists('micropro')) {
929 /**
930  *
931  * @param array $contact
932  * @param boolean $redirect
933  * @param string $class
934  * @param boolean $textmode
935  * @return string #FIXME: remove html
936  */
937 function micropro($contact, $redirect = false, $class = '', $textmode = false) {
938
939         if($class)
940                 $class = ' ' . $class;
941
942         $url = $contact['url'];
943         $sparkle = '';
944         $redir = false;
945
946         if($redirect) {
947                 $a = get_app();
948                 $redirect_url = $a->get_baseurl() . '/redir/' . $contact['id'];
949                 if(local_user() && ($contact['uid'] == local_user()) && ($contact['network'] === NETWORK_DFRN)) {
950                         $redir = true;
951                         $url = $redirect_url;
952                         $sparkle = ' sparkle';
953                 }
954                 else
955                         $url = zrl($url);
956         }
957         $click = ((x($contact,'click')) ? ' onclick="' . $contact['click'] . '" ' : '');
958         if($click)
959                 $url = '';
960         if($textmode) {
961                 return '<div class="contact-block-textdiv' . $class . '"><a class="contact-block-link' . $class . $sparkle
962                         . (($click) ? ' fakelink' : '') . '" '
963                         . (($redir) ? ' target="redir" ' : '')
964                         . (($url) ? ' href="' . $url . '"' : '') . $click
965                         . '" title="' . $contact['name'] . ' [' . $contact['url'] . ']" alt="' . $contact['name']
966                         . '" >'. $contact['name'] . '</a></div>' . "\r\n";
967         }
968         else {
969                 return '<div class="contact-block-div' . $class . '"><a class="contact-block-link' . $class . $sparkle
970                         . (($click) ? ' fakelink' : '') . '" '
971                         . (($redir) ? ' target="redir" ' : '')
972                         . (($url) ? ' href="' . $url . '"' : '') . $click . ' ><img class="contact-block-img' . $class . $sparkle . '" src="'
973                         . proxy_url($contact['micro'], false, PROXY_SIZE_THUMB) . '" title="' . $contact['name'] . ' [' . $contact['url'] . ']" alt="' . $contact['name']
974                         . '" /></a></div>' . "\r\n";
975         }
976 }}
977
978
979
980 if(! function_exists('search')) {
981 /**
982  * search box
983  *
984  * @param string $s search query
985  * @param string $id html id
986  * @param string $url search url
987  * @param boolean $savedsearch show save search button
988  */
989 function search($s,$id='search-box',$url='/search',$save = false, $aside = true) {
990         $a = get_app();
991
992         $values = array(
993                         '$s' => $s,
994                         '$id' => $id,
995                         '$action_url' => $a->get_baseurl((stristr($url,'network')) ? true : false) . $url,
996                         '$search_label' => t('Search'),
997                         '$save_label' => t('Save'),
998                         '$savedsearch' => feature_enabled(local_user(),'savedsearch'),
999                 );
1000
1001         if (!$aside) {
1002                 $values['$searchoption'] = array(
1003                                         t("Full Text"),
1004                                         t("Tags"),
1005                                         t("Contacts"));
1006
1007                 if (get_config('system','poco_local_search'))
1008                         $values['$searchoption'][] = t("Forums");
1009         }
1010
1011         return replace_macros(get_markup_template('searchbox.tpl'), $values);
1012 }}
1013
1014 if(! function_exists('valid_email')) {
1015 /**
1016  * Check if $x is a valid email string
1017  *
1018  * @param string $x
1019  * @return boolean
1020  */
1021 function valid_email($x){
1022
1023         if(get_config('system','disable_email_validation'))
1024                 return true;
1025
1026         if(preg_match('/^[_a-zA-Z0-9\-\+]+(\.[_a-zA-Z0-9\-\+]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/',$x))
1027                 return true;
1028         return false;
1029 }}
1030
1031
1032 if(! function_exists('linkify')) {
1033 /**
1034  * Replace naked text hyperlink with HTML formatted hyperlink
1035  *
1036  * @param string $s
1037  */
1038 function linkify($s) {
1039         $s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="_blank">$1</a>', $s);
1040         $s = preg_replace("/\<(.*?)(src|href)=(.*?)\&amp\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
1041         return($s);
1042 }}
1043
1044
1045 /**
1046  * Load poke verbs
1047  *
1048  * @return array index is present tense verb
1049                                  value is array containing past tense verb, translation of present, translation of past
1050  * @hook poke_verbs pokes array
1051  */
1052 function get_poke_verbs() {
1053
1054         // index is present tense verb
1055         // value is array containing past tense verb, translation of present, translation of past
1056
1057         $arr = array(
1058                 'poke' => array( 'poked', t('poke'), t('poked')),
1059                 'ping' => array( 'pinged', t('ping'), t('pinged')),
1060                 'prod' => array( 'prodded', t('prod'), t('prodded')),
1061                 'slap' => array( 'slapped', t('slap'), t('slapped')),
1062                 'finger' => array( 'fingered', t('finger'), t('fingered')),
1063                 'rebuff' => array( 'rebuffed', t('rebuff'), t('rebuffed')),
1064         );
1065         call_hooks('poke_verbs', $arr);
1066         return $arr;
1067 }
1068
1069 /**
1070  * Load moods
1071  * @return array index is mood, value is translated mood
1072  * @hook mood_verbs moods array
1073  */
1074 function get_mood_verbs() {
1075
1076         $arr = array(
1077                 'happy'      => t('happy'),
1078                 'sad'        => t('sad'),
1079                 'mellow'     => t('mellow'),
1080                 'tired'      => t('tired'),
1081                 'perky'      => t('perky'),
1082                 'angry'      => t('angry'),
1083                 'stupefied'  => t('stupified'),
1084                 'puzzled'    => t('puzzled'),
1085                 'interested' => t('interested'),
1086                 'bitter'     => t('bitter'),
1087                 'cheerful'   => t('cheerful'),
1088                 'alive'      => t('alive'),
1089                 'annoyed'    => t('annoyed'),
1090                 'anxious'    => t('anxious'),
1091                 'cranky'     => t('cranky'),
1092                 'disturbed'  => t('disturbed'),
1093                 'frustrated' => t('frustrated'),
1094                 'motivated'  => t('motivated'),
1095                 'relaxed'    => t('relaxed'),
1096                 'surprised'  => t('surprised'),
1097         );
1098
1099         call_hooks('mood_verbs', $arr);
1100         return $arr;
1101 }
1102
1103
1104
1105 if(! function_exists('smilies')) {
1106 /**
1107  * Replaces text emoticons with graphical images
1108  *
1109  * It is expected that this function will be called using HTML text.
1110  * We will escape text between HTML pre and code blocks from being
1111  * processed.
1112  *
1113  * At a higher level, the bbcode [nosmile] tag can be used to prevent this
1114  * function from being executed by the prepare_text() routine when preparing
1115  * bbcode source for HTML display
1116  *
1117  * @param string $s
1118  * @param boolean $sample
1119  * @return string
1120  * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array, 'string' => $s)
1121  */
1122 function smilies($s, $sample = false) {
1123         $a = get_app();
1124
1125         if(intval(get_config('system','no_smilies'))
1126                 || (local_user() && intval(get_pconfig(local_user(),'system','no_smilies'))))
1127                 return $s;
1128
1129         $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','smile_encode',$s);
1130         $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','smile_encode',$s);
1131
1132         $texts =  array(
1133                 '&lt;3',
1134                 '&lt;/3',
1135                 '&lt;\\3',
1136                 ':-)',
1137                 ';-)',
1138                 ':-(',
1139                 ':-P',
1140                 ':-p',
1141                 ':-"',
1142                 ':-&quot;',
1143                 ':-x',
1144                 ':-X',
1145                 ':-D',
1146                 '8-|',
1147                 '8-O',
1148                 ':-O',
1149                 '\\o/',
1150                 'o.O',
1151                 'O.o',
1152                 'o_O',
1153                 'O_o',
1154                 ":'(",
1155                 ":-!",
1156                 ":-/",
1157                 ":-[",
1158                 "8-)",
1159                 ':beer',
1160                 ':homebrew',
1161                 ':coffee',
1162                 ':facepalm',
1163                 ':like',
1164                 ':dislike',
1165                 '~friendica',
1166                 'red#',
1167                 'red#matrix'
1168
1169         );
1170
1171         $icons = array(
1172                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-heart.gif" alt="&lt;3" />',
1173                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-brokenheart.gif" alt="&lt;/3" />',
1174                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-brokenheart.gif" alt="&lt;\\3" />',
1175                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-smile.gif" alt=":-)" />',
1176                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-wink.gif" alt=";-)" />',
1177                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-frown.gif" alt=":-(" />',
1178                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-P" />',
1179                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-p" />',
1180                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-\"" />',
1181                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-\"" />',
1182                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-x" />',
1183                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-X" />',
1184                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-laughing.gif" alt=":-D" />',
1185                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt="8-|" />',
1186                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt="8-O" />',
1187                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt=":-O" />',
1188                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-thumbsup.gif" alt="\\o/" />',
1189                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="o.O" />',
1190                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="O.o" />',
1191                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="o_O" />',
1192                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="O_o" />',
1193                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-cry.gif" alt=":\'(" />',
1194                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-foot-in-mouth.gif" alt=":-!" />',
1195                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-undecided.gif" alt=":-/" />',
1196                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-embarassed.gif" alt=":-[" />',
1197                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-cool.gif" alt="8-)" />',
1198                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/beer_mug.gif" alt=":beer" />',
1199                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/beer_mug.gif" alt=":homebrew" />',
1200                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/coffee.gif" alt=":coffee" />',
1201                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-facepalm.gif" alt=":facepalm" />',
1202                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/like.gif" alt=":like" />',
1203                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/dislike.gif" alt=":dislike" />',
1204                 '<a href="http://friendica.com">~friendica <img class="smiley" src="' . $a->get_baseurl() . '/images/friendica-16.png" alt="~friendica" /></a>',
1205                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $a->get_baseurl() . '/images/rm-16.png" alt="red" />matrix</a>',
1206                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $a->get_baseurl() . '/images/rm-16.png" alt="red" />matrix</a>'
1207         );
1208
1209         $params = array('texts' => $texts, 'icons' => $icons, 'string' => $s);
1210         call_hooks('smilie', $params);
1211
1212         if($sample) {
1213                 $s = '<div class="smiley-sample">';
1214                 for($x = 0; $x < count($params['texts']); $x ++) {
1215                         $s .= '<dl><dt>' . $params['texts'][$x] . '</dt><dd>' . $params['icons'][$x] . '</dd></dl>';
1216                 }
1217         }
1218         else {
1219                 $params['string'] = preg_replace_callback('/&lt;(3+)/','preg_heart',$params['string']);
1220                 $s = str_replace($params['texts'],$params['icons'],$params['string']);
1221         }
1222
1223         $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','smile_decode',$s);
1224         $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','smile_decode',$s);
1225
1226         return $s;
1227
1228 }}
1229
1230 function smile_encode($m) {
1231         return(str_replace($m[1],base64url_encode($m[1]),$m[0]));
1232 }
1233
1234 function smile_decode($m) {
1235         return(str_replace($m[1],base64url_decode($m[1]),$m[0]));
1236 }
1237
1238
1239 /**
1240  * expand <3333 to the correct number of hearts
1241  *
1242  * @param string $x
1243  * @return string
1244  */
1245 function preg_heart($x) {
1246         $a = get_app();
1247         if(strlen($x[1]) == 1)
1248                 return $x[0];
1249         $t = '';
1250         for($cnt = 0; $cnt < strlen($x[1]); $cnt ++)
1251                 $t .= '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-heart.gif" alt="&lt;3" />';
1252         $r =  str_replace($x[0],$t,$x[0]);
1253         return $r;
1254 }
1255
1256
1257 if(! function_exists('day_translate')) {
1258 /**
1259  * Translate days and months names
1260  *
1261  * @param string $s
1262  * @return string
1263  */
1264 function day_translate($s) {
1265         $ret = str_replace(array('Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'),
1266                 array( t('Monday'), t('Tuesday'), t('Wednesday'), t('Thursday'), t('Friday'), t('Saturday'), t('Sunday')),
1267                 $s);
1268
1269         $ret = str_replace(array('January','February','March','April','May','June','July','August','September','October','November','December'),
1270                 array( t('January'), t('February'), t('March'), t('April'), t('May'), t('June'), t('July'), t('August'), t('September'), t('October'), t('November'), t('December')),
1271                 $ret);
1272
1273         return $ret;
1274 }}
1275
1276
1277 if(! function_exists('normalise_link')) {
1278 /**
1279  * Normalize url
1280  *
1281  * @param string $url
1282  * @return string
1283  */
1284 function normalise_link($url) {
1285         $ret = str_replace(array('https:','//www.'), array('http:','//'), $url);
1286         return(rtrim($ret,'/'));
1287 }}
1288
1289
1290
1291 if(! function_exists('link_compare')) {
1292 /**
1293  * Compare two URLs to see if they are the same, but ignore
1294  * slight but hopefully insignificant differences such as if one
1295  * is https and the other isn't, or if one is www.something and
1296  * the other isn't - and also ignore case differences.
1297  *
1298  * @param string $a first url
1299  * @param string $b second url
1300  * @return boolean True if the URLs match, otherwise False
1301  *
1302  */
1303 function link_compare($a,$b) {
1304         if(strcasecmp(normalise_link($a),normalise_link($b)) === 0)
1305                 return true;
1306         return false;
1307 }}
1308
1309
1310 if(! function_exists('redir_private_images')) {
1311 /**
1312  * Find any non-embedded images in private items and add redir links to them
1313  *
1314  * @param App $a
1315  * @param array $item
1316  */
1317 function redir_private_images($a, &$item) {
1318
1319         $matches = false;
1320         $cnt = preg_match_all('|\[img\](http[^\[]*?/photo/[a-fA-F0-9]+?(-[0-9]\.[\w]+?)?)\[\/img\]|', $item['body'], $matches, PREG_SET_ORDER);
1321         if($cnt) {
1322                 //logger("redir_private_images: matches = " . print_r($matches, true));
1323                 foreach($matches as $mtch) {
1324                         if(strpos($mtch[1], '/redir') !== false)
1325                                 continue;
1326
1327                         if((local_user() == $item['uid']) && ($item['private'] != 0) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN)) {
1328                                 //logger("redir_private_images: redir");
1329                                 $img_url = $a->get_baseurl() . '/redir?f=1&quiet=1&url=' . $mtch[1] . '&conurl=' . $item['author-link'];
1330                                 $item['body'] = str_replace($mtch[0], "[img]".$img_url."[/img]", $item['body']);
1331                         }
1332                 }
1333         }
1334
1335 }}
1336
1337 function put_item_in_cache(&$item, $update = false) {
1338
1339         if (($item["rendered-hash"] != hash("md5", $item["body"])) OR ($item["rendered-hash"] == "") OR
1340                 ($item["rendered-html"] == "") OR get_config("system", "ignore_cache")) {
1341
1342                 // The function "redir_private_images" changes the body.
1343                 // I'm not sure if we should store it permanently, so we save the old value.
1344                 $body = $item["body"];
1345
1346                 $a = get_app();
1347                 redir_private_images($a, $item);
1348
1349                 $item["rendered-html"] = prepare_text($item["body"]);
1350                 $item["rendered-hash"] = hash("md5", $item["body"]);
1351                 $item["body"] = $body;
1352
1353                 if ($update AND ($item["id"] != 0)) {
1354                         q("UPDATE `item` SET `rendered-html` = '%s', `rendered-hash` = '%s' WHERE `id` = %d",
1355                                 dbesc($item["rendered-html"]), dbesc($item["rendered-hash"]), intval($item["id"]));
1356                 }
1357         }
1358 }
1359
1360 // Given an item array, convert the body element from bbcode to html and add smilie icons.
1361 // If attach is true, also add icons for item attachments
1362
1363 if(! function_exists('prepare_body')) {
1364 /**
1365  * Given an item array, convert the body element from bbcode to html and add smilie icons.
1366  * If attach is true, also add icons for item attachments
1367  *
1368  * @param array $item
1369  * @param boolean $attach
1370  * @return string item body html
1371  * @hook prepare_body_init item array before any work
1372  * @hook prepare_body ('item'=>item array, 'html'=>body string) after first bbcode to html
1373  * @hook prepare_body_final ('item'=>item array, 'html'=>body string) after attach icons and blockquote special case handling (spoiler, author)
1374  */
1375 function prepare_body(&$item,$attach = false, $preview = false) {
1376
1377         $a = get_app();
1378         call_hooks('prepare_body_init', $item);
1379
1380         $searchpath = $a->get_baseurl()."/search?tag=";
1381
1382         $tags=array();
1383         $hashtags = array();
1384         $mentions = array();
1385
1386         if (!get_config('system','suppress_tags')) {
1387                 $taglist = q("SELECT `type`, `term`, `url` FROM `term` WHERE `otype` = %d AND `oid` = %d AND `type` IN (%d, %d) ORDER BY `tid`",
1388                                 intval(TERM_OBJ_POST), intval($item['id']), intval(TERM_HASHTAG), intval(TERM_MENTION));
1389
1390                 foreach($taglist as $tag) {
1391
1392                         if ($tag["url"] == "")
1393                                 $tag["url"] = $searchpath.strtolower($tag["term"]);
1394
1395                         if ($tag["type"] == TERM_HASHTAG) {
1396                                 $hashtags[] = "#<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1397                                 $prefix = "#";
1398                         } elseif ($tag["type"] == TERM_MENTION) {
1399                                 $mentions[] = "@<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1400                                 $prefix = "@";
1401                         }
1402                         $tags[] = $prefix."<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1403                 }
1404         }
1405
1406         $item['tags'] = $tags;
1407         $item['hashtags'] = $hashtags;
1408         $item['mentions'] = $mentions;
1409
1410         put_item_in_cache($item, true);
1411         $s = $item["rendered-html"];
1412
1413         $prep_arr = array('item' => $item, 'html' => $s, 'preview' => $preview);
1414         call_hooks('prepare_body', $prep_arr);
1415         $s = $prep_arr['html'];
1416
1417         if(! $attach) {
1418                 // Replace the blockquotes with quotes that are used in mails
1419                 $mailquote = '<blockquote type="cite" class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">';
1420                 $s = str_replace(array('<blockquote>', '<blockquote class="spoiler">', '<blockquote class="author">'), array($mailquote, $mailquote, $mailquote), $s);
1421                 return $s;
1422         }
1423
1424         $as = '';
1425         $vhead = false;
1426         $arr = explode('[/attach],',$item['attach']);
1427         if(count($arr)) {
1428                 $as .= '<div class="body-attach">';
1429                 foreach($arr as $r) {
1430                         $matches = false;
1431                         $icon = '';
1432                         $cnt = preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|',$r,$matches, PREG_SET_ORDER);
1433                         if($cnt) {
1434                                 foreach($matches as $mtch) {
1435                                         $mime = $mtch[3];
1436
1437                                         if((local_user() == $item['uid']) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN))
1438                                                 $the_url = $a->get_baseurl() . '/redir/' . $item['contact-id'] . '?f=1&url=' . $mtch[1];
1439                                         else
1440                                                 $the_url = $mtch[1];
1441
1442                                         if(strpos($mime, 'video') !== false) {
1443                                                 if(!$vhead) {
1444                                                         $vhead = true;
1445                                                         $a->page['htmlhead'] .= replace_macros(get_markup_template('videos_head.tpl'), array(
1446                                                                 '$baseurl' => $a->get_baseurl(),
1447                                                         ));
1448                                                         $a->page['end'] .= replace_macros(get_markup_template('videos_end.tpl'), array(
1449                                                                 '$baseurl' => $a->get_baseurl(),
1450                                                         ));
1451                                                 }
1452
1453                                                 $id = end(explode('/', $the_url));
1454                                                 $as .= replace_macros(get_markup_template('video_top.tpl'), array(
1455                                                         '$video'        => array(
1456                                                                 'id'       => $id,
1457                                                                 'title'         => t('View Video'),
1458                                                                 'src'           => $the_url,
1459                                                                 'mime'          => $mime,
1460                                                         ),
1461                                                 ));
1462                                         }
1463
1464                                         $filetype = strtolower(substr( $mime, 0, strpos($mime,'/') ));
1465                                         if($filetype) {
1466                                                 $filesubtype = strtolower(substr( $mime, strpos($mime,'/') + 1 ));
1467                                                 $filesubtype = str_replace('.', '-', $filesubtype);
1468                                         }
1469                                         else {
1470                                                 $filetype = 'unkn';
1471                                                 $filesubtype = 'unkn';
1472                                         }
1473
1474                                         $icon = '<div class="attachtype icon s22 type-' . $filetype . ' subtype-' . $filesubtype . '"></div>';
1475                                         /*$icontype = strtolower(substr($mtch[3],0,strpos($mtch[3],'/')));
1476                                         switch($icontype) {
1477                                                 case 'video':
1478                                                 case 'audio':
1479                                                 case 'image':
1480                                                 case 'text':
1481                                                         $icon = '<div class="attachtype icon s22 type-' . $icontype . '"></div>';
1482                                                         break;
1483                                                 default:
1484                                                         $icon = '<div class="attachtype icon s22 type-unkn"></div>';
1485                                                         break;
1486                                         }*/
1487
1488                                         $title = ((strlen(trim($mtch[4]))) ? escape_tags(trim($mtch[4])) : escape_tags($mtch[1]));
1489                                         $title .= ' ' . $mtch[2] . ' ' . t('bytes');
1490
1491                                         $as .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="_blank" >' . $icon . '</a>';
1492                                 }
1493                         }
1494                 }
1495                 $as .= '<div class="clear"></div></div>';
1496         }
1497         $s = $s . $as;
1498
1499         // map
1500         if(strpos($s,'<div class="map">') !== false && $item['coord']) {
1501                 $x = generate_map(trim($item['coord']));
1502                 if($x) {
1503                         $s = preg_replace('/\<div class\=\"map\"\>/','$0' . $x,$s);
1504                 }
1505         }
1506
1507
1508         // Look for spoiler
1509         $spoilersearch = '<blockquote class="spoiler">';
1510
1511         // Remove line breaks before the spoiler
1512         while ((strpos($s, "\n".$spoilersearch) !== false))
1513                 $s = str_replace("\n".$spoilersearch, $spoilersearch, $s);
1514         while ((strpos($s, "<br />".$spoilersearch) !== false))
1515                 $s = str_replace("<br />".$spoilersearch, $spoilersearch, $s);
1516
1517         while ((strpos($s, $spoilersearch) !== false)) {
1518
1519                 $pos = strpos($s, $spoilersearch);
1520                 $rnd = random_string(8);
1521                 $spoilerreplace = '<br /> <span id="spoiler-wrap-'.$rnd.'" style="white-space:nowrap;" class="fakelink" onclick="openClose(\'spoiler-'.$rnd.'\');">'.sprintf(t('Click to open/close')).'</span>'.
1522                                         '<blockquote class="spoiler" id="spoiler-'.$rnd.'" style="display: none;">';
1523                 $s = substr($s, 0, $pos).$spoilerreplace.substr($s, $pos+strlen($spoilersearch));
1524         }
1525
1526         // Look for quote with author
1527         $authorsearch = '<blockquote class="author">';
1528
1529         while ((strpos($s, $authorsearch) !== false)) {
1530
1531                 $pos = strpos($s, $authorsearch);
1532                 $rnd = random_string(8);
1533                 $authorreplace = '<br /> <span id="author-wrap-'.$rnd.'" style="white-space:nowrap;" class="fakelink" onclick="openClose(\'author-'.$rnd.'\');">'.sprintf(t('Click to open/close')).'</span>'.
1534                                         '<blockquote class="author" id="author-'.$rnd.'" style="display: block;">';
1535                 $s = substr($s, 0, $pos).$authorreplace.substr($s, $pos+strlen($authorsearch));
1536         }
1537
1538     // replace friendica image url size with theme preference
1539     if (x($a->theme_info,'item_image_size')){
1540         $ps = $a->theme_info['item_image_size'];
1541
1542         $s = preg_replace('|(<img[^>]+src="[^"]+/photo/[0-9a-f]+)-[0-9]|',"$1-".$ps, $s);
1543     }
1544
1545         $prep_arr = array('item' => $item, 'html' => $s);
1546         call_hooks('prepare_body_final', $prep_arr);
1547
1548         return $prep_arr['html'];
1549 }}
1550
1551
1552 if(! function_exists('prepare_text')) {
1553 /**
1554  * Given a text string, convert from bbcode to html and add smilie icons.
1555  *
1556  * @param string $text
1557  * @return string
1558  */
1559 function prepare_text($text) {
1560
1561         require_once('include/bbcode.php');
1562
1563         if(stristr($text,'[nosmile]'))
1564                 $s = bbcode($text);
1565         else
1566                 $s = smilies(bbcode($text));
1567
1568         return trim($s);
1569 }}
1570
1571
1572
1573 /**
1574  * return array with details for categories and folders for an item
1575  *
1576  * @param array $item
1577  * @return array
1578  *
1579   * [
1580  *      [ // categories array
1581  *          {
1582  *               'name': 'category name',
1583  *               'removeurl': 'url to remove this category',
1584  *               'first': 'is the first in this array? true/false',
1585  *               'last': 'is the last in this array? true/false',
1586  *           } ,
1587  *           ....
1588  *       ],
1589  *       [ //folders array
1590  *                      {
1591  *               'name': 'folder name',
1592  *               'removeurl': 'url to remove this folder',
1593  *               'first': 'is the first in this array? true/false',
1594  *               'last': 'is the last in this array? true/false',
1595  *           } ,
1596  *           ....
1597  *       ]
1598  *  ]
1599  */
1600 function get_cats_and_terms($item) {
1601
1602     $a = get_app();
1603     $categories = array();
1604     $folders = array();
1605
1606     $matches = false; $first = true;
1607     $cnt = preg_match_all('/<(.*?)>/',$item['file'],$matches,PREG_SET_ORDER);
1608     if($cnt) {
1609         foreach($matches as $mtch) {
1610             $categories[] = array(
1611                 'name' => xmlify(file_tag_decode($mtch[1])),
1612                 'url' =>  "#",
1613                 'removeurl' => ((local_user() == $item['uid'])?$a->get_baseurl() . '/filerm/' . $item['id'] . '?f=&cat=' . xmlify(file_tag_decode($mtch[1])):""),
1614                 'first' => $first,
1615                 'last' => false
1616             );
1617             $first = false;
1618         }
1619     }
1620     if (count($categories)) $categories[count($categories)-1]['last'] = true;
1621
1622
1623         if(local_user() == $item['uid']) {
1624             $matches = false; $first = true;
1625         $cnt = preg_match_all('/\[(.*?)\]/',$item['file'],$matches,PREG_SET_ORDER);
1626             if($cnt) {
1627             foreach($matches as $mtch) {
1628                     $folders[] = array(
1629                     'name' => xmlify(file_tag_decode($mtch[1])),
1630                          'url' =>  "#",
1631                         'removeurl' => ((local_user() == $item['uid'])?$a->get_baseurl() . '/filerm/' . $item['id'] . '?f=&term=' . xmlify(file_tag_decode($mtch[1])):""),
1632                     'first' => $first,
1633                         'last' => false
1634                 );
1635                     $first = false;
1636                         }
1637         }
1638     }
1639
1640     if (count($folders)) $folders[count($folders)-1]['last'] = true;
1641
1642     return array($categories, $folders);
1643 }
1644
1645
1646
1647 if(! function_exists('feed_hublinks')) {
1648 /**
1649  * return atom link elements for all of our hubs
1650  * @return string hub link xml elements
1651  */
1652 function feed_hublinks() {
1653         $a = get_app();
1654         $hub = get_config('system','huburl');
1655
1656         $hubxml = '';
1657         if(strlen($hub)) {
1658                 $hubs = explode(',', $hub);
1659                 if(count($hubs)) {
1660                         foreach($hubs as $h) {
1661                                 $h = trim($h);
1662                                 if(! strlen($h))
1663                                         continue;
1664                                 if ($h === '[internal]')
1665                                         $h = $a->get_baseurl() . '/pubsubhubbub';
1666                                 $hubxml .= '<link rel="hub" href="' . xmlify($h) . '" />' . "\n" ;
1667                         }
1668                 }
1669         }
1670         return $hubxml;
1671 }}
1672
1673
1674 if(! function_exists('feed_salmonlinks')) {
1675 /**
1676  * return atom link elements for salmon endpoints
1677  * @param string $nick user nickname
1678  * @return string salmon link xml elements
1679  */
1680 function feed_salmonlinks($nick) {
1681
1682         $a = get_app();
1683
1684         $salmon  = '<link rel="salmon" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ;
1685
1686         // old style links that status.net still needed as of 12/2010
1687
1688         $salmon .= '  <link rel="http://salmon-protocol.org/ns/salmon-replies" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ;
1689         $salmon .= '  <link rel="http://salmon-protocol.org/ns/salmon-mention" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ;
1690         return $salmon;
1691 }}
1692
1693 if(! function_exists('get_plink')) {
1694 /**
1695  * get private link for item
1696  * @param array $item
1697  * @return boolean|array False if item has not plink, otherwise array('href'=>plink url, 'title'=>translated title)
1698  */
1699 function get_plink($item) {
1700         $a = get_app();
1701
1702         if ($a->user['nickname'] != "") {
1703                 $ret = array(
1704                                 //'href' => $a->get_baseurl()."/display/".$a->user['nickname']."/".$item['id'],
1705                                 'href' => $a->get_baseurl()."/display/".$item['guid'],
1706                                 'orig' => $a->get_baseurl()."/display/".$item['guid'],
1707                                 'title' => t('View on separate page'),
1708                                 'orig_title' => t('view on separate page'),
1709                         );
1710
1711                 if (x($item,'plink')) {
1712                         $ret["href"] = $item['plink'];
1713                         $ret["title"] = t('link to source');
1714                 }
1715
1716         } elseif (x($item,'plink') && ($item['private'] != 1))
1717                 $ret = array(
1718                                 'href' => $item['plink'],
1719                                 'orig' => $item['plink'],
1720                                 'title' => t('link to source'),
1721                         );
1722         else
1723                 $ret = array();
1724
1725         //if (x($item,'plink') && ($item['private'] != 1))
1726
1727         return($ret);
1728 }}
1729
1730 if(! function_exists('unamp')) {
1731 /**
1732  * replace html amp entity with amp char
1733  * @param string $s
1734  * @return string
1735  */
1736 function unamp($s) {
1737         return str_replace('&amp;', '&', $s);
1738 }}
1739
1740
1741 if(! function_exists('return_bytes')) {
1742 /**
1743  * return number of bytes in size (K, M, G)
1744  * @param string $size_str
1745  * @return number
1746  */
1747 function return_bytes ($size_str) {
1748     switch (substr ($size_str, -1))
1749     {
1750         case 'M': case 'm': return (int)$size_str * 1048576;
1751         case 'K': case 'k': return (int)$size_str * 1024;
1752         case 'G': case 'g': return (int)$size_str * 1073741824;
1753         default: return $size_str;
1754     }
1755 }}
1756
1757 /**
1758  * @return string
1759  */
1760 function generate_user_guid() {
1761         $found = true;
1762         do {
1763                 $guid = get_guid(32);
1764                 $x = q("SELECT `uid` FROM `user` WHERE `guid` = '%s' LIMIT 1",
1765                         dbesc($guid)
1766                 );
1767                 if(! count($x))
1768                         $found = false;
1769         } while ($found == true );
1770         return $guid;
1771 }
1772
1773
1774 /**
1775  * @param string $s
1776  * @param boolean $strip_padding
1777  * @return string
1778  */
1779 function base64url_encode($s, $strip_padding = false) {
1780
1781         $s = strtr(base64_encode($s),'+/','-_');
1782
1783         if($strip_padding)
1784                 $s = str_replace('=','',$s);
1785
1786         return $s;
1787 }
1788
1789 /**
1790  * @param string $s
1791  * @return string
1792  */
1793 function base64url_decode($s) {
1794
1795         if(is_array($s)) {
1796                 logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
1797                 return $s;
1798         }
1799
1800 /*
1801  *  // Placeholder for new rev of salmon which strips base64 padding.
1802  *  // PHP base64_decode handles the un-padded input without requiring this step
1803  *  // Uncomment if you find you need it.
1804  *
1805  *      $l = strlen($s);
1806  *      if(! strpos($s,'=')) {
1807  *              $m = $l % 4;
1808  *              if($m == 2)
1809  *                      $s .= '==';
1810  *              if($m == 3)
1811  *                      $s .= '=';
1812  *      }
1813  *
1814  */
1815
1816         return base64_decode(strtr($s,'-_','+/'));
1817 }
1818
1819
1820 if (!function_exists('str_getcsv')) {
1821         /**
1822          * Parse csv string
1823          *
1824          * @param string $input
1825          * @param string $delimiter
1826          * @param string $enclosure
1827          * @param string $escape
1828          * @param string $eol
1829          * @return boolean|array False on error, otherwise array[row][column]
1830          */
1831     function str_getcsv($input, $delimiter = ',', $enclosure = '"', $escape = '\\', $eol = '\n') {
1832         if (is_string($input) && !empty($input)) {
1833             $output = array();
1834             $tmp    = preg_split("/".$eol."/",$input);
1835             if (is_array($tmp) && !empty($tmp)) {
1836                 while (list($line_num, $line) = each($tmp)) {
1837                     if (preg_match("/".$escape.$enclosure."/",$line)) {
1838                         while ($strlen = strlen($line)) {
1839                             $pos_delimiter       = strpos($line,$delimiter);
1840                             $pos_enclosure_start = strpos($line,$enclosure);
1841                             if (
1842                                 is_int($pos_delimiter) && is_int($pos_enclosure_start)
1843                                 && ($pos_enclosure_start < $pos_delimiter)
1844                                 ) {
1845                                 $enclosed_str = substr($line,1);
1846                                 $pos_enclosure_end = strpos($enclosed_str,$enclosure);
1847                                 $enclosed_str = substr($enclosed_str,0,$pos_enclosure_end);
1848                                 $output[$line_num][] = $enclosed_str;
1849                                 $offset = $pos_enclosure_end+3;
1850                             } else {
1851                                 if (empty($pos_delimiter) && empty($pos_enclosure_start)) {
1852                                     $output[$line_num][] = substr($line,0);
1853                                     $offset = strlen($line);
1854                                 } else {
1855                                     $output[$line_num][] = substr($line,0,$pos_delimiter);
1856                                     $offset = (
1857                                                 !empty($pos_enclosure_start)
1858                                                 && ($pos_enclosure_start < $pos_delimiter)
1859                                                 )
1860                                                 ?$pos_enclosure_start
1861                                                 :$pos_delimiter+1;
1862                                 }
1863                             }
1864                             $line = substr($line,$offset);
1865                         }
1866                     } else {
1867                         $line = preg_split("/".$delimiter."/",$line);
1868
1869                         /*
1870                          * Validating against pesky extra line breaks creating false rows.
1871                          */
1872                         if (is_array($line) && !empty($line[0])) {
1873                             $output[$line_num] = $line;
1874                         }
1875                     }
1876                 }
1877                 return $output;
1878             } else {
1879                 return false;
1880             }
1881         } else {
1882             return false;
1883         }
1884     }
1885 }
1886
1887 /**
1888  * return div element with class 'clear'
1889  * @return string
1890  * @deprecated
1891  */
1892 function cleardiv() {
1893         return '<div class="clear"></div>';
1894 }
1895
1896
1897 function bb_translate_video($s) {
1898
1899         $matches = null;
1900         $r = preg_match_all("/\[video\](.*?)\[\/video\]/ism",$s,$matches,PREG_SET_ORDER);
1901         if($r) {
1902                 foreach($matches as $mtch) {
1903                         if((stristr($mtch[1],'youtube')) || (stristr($mtch[1],'youtu.be')))
1904                                 $s = str_replace($mtch[0],'[youtube]' . $mtch[1] . '[/youtube]',$s);
1905                         elseif(stristr($mtch[1],'vimeo'))
1906                                 $s = str_replace($mtch[0],'[vimeo]' . $mtch[1] . '[/vimeo]',$s);
1907                 }
1908         }
1909         return $s;
1910 }
1911
1912 function html2bb_video($s) {
1913
1914         $s = preg_replace('#<object[^>]+>(.*?)https?://www.youtube.com/((?:v|cp)/[A-Za-z0-9\-_=]+)(.*?)</object>#ism',
1915                         '[youtube]$2[/youtube]', $s);
1916
1917         $s = preg_replace('#<iframe[^>](.*?)https?://www.youtube.com/embed/([A-Za-z0-9\-_=]+)(.*?)</iframe>#ism',
1918                         '[youtube]$2[/youtube]', $s);
1919
1920         $s = preg_replace('#<iframe[^>](.*?)https?://player.vimeo.com/video/([0-9]+)(.*?)</iframe>#ism',
1921                         '[vimeo]$2[/vimeo]', $s);
1922
1923         return $s;
1924 }
1925
1926 /**
1927  * apply xmlify() to all values of array $val, recursively
1928  * @param array $val
1929  * @return array
1930  */
1931 function array_xmlify($val){
1932         if (is_bool($val)) return $val?"true":"false";
1933         if (is_array($val)) return array_map('array_xmlify', $val);
1934         return xmlify((string) $val);
1935 }
1936
1937
1938 /**
1939  * transorm link href and img src from relative to absolute
1940  *
1941  * @param string $text
1942  * @param string $base base url
1943  * @return string
1944  */
1945 function reltoabs($text, $base)
1946 {
1947   if (empty($base))
1948     return $text;
1949
1950   $base = rtrim($base,'/');
1951
1952   $base2 = $base . "/";
1953
1954   // Replace links
1955   $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
1956   $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
1957   $text = preg_replace($pattern, $replace, $text);
1958
1959   $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
1960   $replace = "<a\${1} href=\"" . $base . "\${2}\"";
1961   $text = preg_replace($pattern, $replace, $text);
1962
1963   // Replace images
1964   $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
1965   $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
1966   $text = preg_replace($pattern, $replace, $text);
1967
1968   $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
1969   $replace = "<img\${1} src=\"" . $base . "\${2}\"";
1970   $text = preg_replace($pattern, $replace, $text);
1971
1972
1973   // Done
1974   return $text;
1975 }
1976
1977 /**
1978  * get translated item type
1979  *
1980  * @param array $itme
1981  * @return string
1982  */
1983 function item_post_type($item) {
1984         if(intval($item['event-id']))
1985                 return t('event');
1986         if(strlen($item['resource-id']))
1987                 return t('photo');
1988         if(strlen($item['verb']) && $item['verb'] !== ACTIVITY_POST)
1989                 return t('activity');
1990         if($item['id'] != $item['parent'])
1991                 return t('comment');
1992         return t('post');
1993 }
1994
1995 // post categories and "save to file" use the same item.file table for storage.
1996 // We will differentiate the different uses by wrapping categories in angle brackets
1997 // and save to file categories in square brackets.
1998 // To do this we need to escape these characters if they appear in our tag.
1999
2000 function file_tag_encode($s) {
2001         return str_replace(array('<','>','[',']'),array('%3c','%3e','%5b','%5d'),$s);
2002 }
2003
2004 function file_tag_decode($s) {
2005         return str_replace(array('%3c','%3e','%5b','%5d'),array('<','>','[',']'),$s);
2006 }
2007
2008 function file_tag_file_query($table,$s,$type = 'file') {
2009
2010         if($type == 'file')
2011                 $str = preg_quote( '[' . str_replace('%','%%',file_tag_encode($s)) . ']' );
2012         else
2013                 $str = preg_quote( '<' . str_replace('%','%%',file_tag_encode($s)) . '>' );
2014         return " AND " . (($table) ? dbesc($table) . '.' : '') . "file regexp '" . dbesc($str) . "' ";
2015 }
2016
2017 // ex. given music,video return <music><video> or [music][video]
2018 function file_tag_list_to_file($list,$type = 'file') {
2019         $tag_list = '';
2020         if(strlen($list)) {
2021                 $list_array = explode(",",$list);
2022                 if($type == 'file') {
2023                         $lbracket = '[';
2024                         $rbracket = ']';
2025                 }
2026                 else {
2027                         $lbracket = '<';
2028                         $rbracket = '>';
2029                 }
2030
2031                 foreach($list_array as $item) {
2032                   if(strlen($item)) {
2033                                 $tag_list .= $lbracket . file_tag_encode(trim($item))  . $rbracket;
2034                         }
2035                 }
2036         }
2037         return $tag_list;
2038 }
2039
2040 // ex. given <music><video>[friends], return music,video or friends
2041 function file_tag_file_to_list($file,$type = 'file') {
2042         $matches = false;
2043         $list = '';
2044         if($type == 'file') {
2045                 $cnt = preg_match_all('/\[(.*?)\]/',$file,$matches,PREG_SET_ORDER);
2046         }
2047         else {
2048                 $cnt = preg_match_all('/<(.*?)>/',$file,$matches,PREG_SET_ORDER);
2049         }
2050         if($cnt) {
2051                 foreach($matches as $mtch) {
2052                         if(strlen($list))
2053                                 $list .= ',';
2054                         $list .= file_tag_decode($mtch[1]);
2055                 }
2056         }
2057
2058         return $list;
2059 }
2060
2061 function file_tag_update_pconfig($uid,$file_old,$file_new,$type = 'file') {
2062         // $file_old - categories previously associated with an item
2063         // $file_new - new list of categories for an item
2064
2065         if(! intval($uid))
2066                 return false;
2067
2068         if($file_old == $file_new)
2069                 return true;
2070
2071         $saved = get_pconfig($uid,'system','filetags');
2072         if(strlen($saved)) {
2073                 if($type == 'file') {
2074                         $lbracket = '[';
2075                         $rbracket = ']';
2076                         $termtype = TERM_FILE;
2077                 }
2078                 else {
2079                         $lbracket = '<';
2080                         $rbracket = '>';
2081                         $termtype = TERM_CATEGORY;
2082                 }
2083
2084                 $filetags_updated = $saved;
2085
2086                 // check for new tags to be added as filetags in pconfig
2087                 $new_tags = array();
2088                 $check_new_tags = explode(",",file_tag_file_to_list($file_new,$type));
2089
2090                 foreach($check_new_tags as $tag) {
2091                         if(! stristr($saved,$lbracket . file_tag_encode($tag) . $rbracket))
2092                                 $new_tags[] = $tag;
2093                 }
2094
2095                 $filetags_updated .= file_tag_list_to_file(implode(",",$new_tags),$type);
2096
2097                 // check for deleted tags to be removed from filetags in pconfig
2098                 $deleted_tags = array();
2099                 $check_deleted_tags = explode(",",file_tag_file_to_list($file_old,$type));
2100
2101                 foreach($check_deleted_tags as $tag) {
2102                         if(! stristr($file_new,$lbracket . file_tag_encode($tag) . $rbracket))
2103                                 $deleted_tags[] = $tag;
2104                 }
2105
2106                 foreach($deleted_tags as $key => $tag) {
2107                         $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
2108                                 dbesc($tag),
2109                                 intval(TERM_OBJ_POST),
2110                                 intval($termtype),
2111                                 intval($uid));
2112
2113                         //$r = q("select file from item where uid = %d " . file_tag_file_query('item',$tag,$type),
2114                         //      intval($uid)
2115                         //);
2116
2117                         if(count($r)) {
2118                                 unset($deleted_tags[$key]);
2119                         }
2120                         else {
2121                                 $filetags_updated = str_replace($lbracket . file_tag_encode($tag) . $rbracket,'',$filetags_updated);
2122                         }
2123                 }
2124
2125                 if($saved != $filetags_updated) {
2126                         set_pconfig($uid,'system','filetags', $filetags_updated);
2127                 }
2128                 return true;
2129         }
2130         else
2131                 if(strlen($file_new)) {
2132                         set_pconfig($uid,'system','filetags', $file_new);
2133                 }
2134                 return true;
2135 }
2136
2137 function file_tag_save_file($uid,$item,$file) {
2138         require_once("include/files.php");
2139
2140         $result = false;
2141         if(! intval($uid))
2142                 return false;
2143         $r = q("select file from item where id = %d and uid = %d limit 1",
2144                 intval($item),
2145                 intval($uid)
2146         );
2147         if(count($r)) {
2148                 if(! stristr($r[0]['file'],'[' . file_tag_encode($file) . ']'))
2149                         q("update item set file = '%s' where id = %d and uid = %d",
2150                                 dbesc($r[0]['file'] . '[' . file_tag_encode($file) . ']'),
2151                                 intval($item),
2152                                 intval($uid)
2153                         );
2154
2155                 create_files_from_item($item);
2156
2157                 $saved = get_pconfig($uid,'system','filetags');
2158                 if((! strlen($saved)) || (! stristr($saved,'[' . file_tag_encode($file) . ']')))
2159                         set_pconfig($uid,'system','filetags',$saved . '[' . file_tag_encode($file) . ']');
2160                 info( t('Item filed') );
2161         }
2162         return true;
2163 }
2164
2165 function file_tag_unsave_file($uid,$item,$file,$cat = false) {
2166         require_once("include/files.php");
2167
2168         $result = false;
2169         if(! intval($uid))
2170                 return false;
2171
2172         if($cat == true) {
2173                 $pattern = '<' . file_tag_encode($file) . '>' ;
2174                 $termtype = TERM_CATEGORY;
2175         } else {
2176                 $pattern = '[' . file_tag_encode($file) . ']' ;
2177                 $termtype = TERM_FILE;
2178         }
2179
2180
2181         $r = q("select file from item where id = %d and uid = %d limit 1",
2182                 intval($item),
2183                 intval($uid)
2184         );
2185         if(! count($r))
2186                 return false;
2187
2188         q("update item set file = '%s' where id = %d and uid = %d",
2189                 dbesc(str_replace($pattern,'',$r[0]['file'])),
2190                 intval($item),
2191                 intval($uid)
2192         );
2193
2194         create_files_from_item($item);
2195
2196         $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
2197                 dbesc($file),
2198                 intval(TERM_OBJ_POST),
2199                 intval($termtype),
2200                 intval($uid));
2201
2202         //$r = q("select file from item where uid = %d and deleted = 0 " . file_tag_file_query('item',$file,(($cat) ? 'category' : 'file')),
2203         //);
2204
2205         if(! count($r)) {
2206                 $saved = get_pconfig($uid,'system','filetags');
2207                 set_pconfig($uid,'system','filetags',str_replace($pattern,'',$saved));
2208
2209         }
2210         return true;
2211 }
2212
2213 function normalise_openid($s) {
2214         return trim(str_replace(array('http://','https://'),array('',''),$s),'/');
2215 }
2216
2217
2218 function undo_post_tagging($s) {
2219         $matches = null;
2220         $cnt = preg_match_all('/([!#@])\[url=(.*?)\](.*?)\[\/url\]/ism',$s,$matches,PREG_SET_ORDER);
2221         if($cnt) {
2222                 foreach($matches as $mtch) {
2223                         $s = str_replace($mtch[0], $mtch[1] . $mtch[3],$s);
2224                 }
2225         }
2226         return $s;
2227 }
2228
2229 function fix_mce_lf($s) {
2230         $s = str_replace("\r\n","\n",$s);
2231 //      $s = str_replace("\n\n","\n",$s);
2232         return $s;
2233 }
2234
2235
2236 function protect_sprintf($s) {
2237         return(str_replace('%','%%',$s));
2238 }
2239
2240
2241 function is_a_date_arg($s) {
2242         $i = intval($s);
2243         if($i > 1900) {
2244                 $y = date('Y');
2245                 if($i <= $y+1 && strpos($s,'-') == 4) {
2246                         $m = intval(substr($s,5));
2247                         if($m > 0 && $m <= 12)
2248                                 return true;
2249                 }
2250         }
2251         return false;
2252 }
2253
2254 /**
2255  * remove intentation from a text
2256  */
2257 function deindent($text, $chr="[\t ]", $count=NULL) {
2258         $text = fix_mce_lf($text);
2259         $lines = explode("\n", $text);
2260         if (is_null($count)) {
2261                 $m = array();
2262                 $k=0; while($k<count($lines) && strlen($lines[$k])==0) $k++;
2263                 preg_match("|^".$chr."*|", $lines[$k], $m);
2264                 $count = strlen($m[0]);
2265         }
2266         for ($k=0; $k<count($lines); $k++){
2267                 $lines[$k] = preg_replace("|^".$chr."{".$count."}|", "", $lines[$k]);
2268         }
2269
2270         return implode("\n", $lines);
2271 }
2272
2273 function formatBytes($bytes, $precision = 2) {
2274          $units = array('B', 'KB', 'MB', 'GB', 'TB');
2275
2276         $bytes = max($bytes, 0);
2277         $pow = floor(($bytes ? log($bytes) : 0) / log(1024));
2278         $pow = min($pow, count($units) - 1);
2279
2280         $bytes /= pow(1024, $pow);
2281
2282         return round($bytes, $precision) . ' ' . $units[$pow];
2283 }