]> git.mxchange.org Git - friendica.git/blob - include/text.php
Merge remote-tracking branch 'remotes/upstream/master'
[friendica.git] / include / text.php
1 <?php
2
3 // This is our template processor.
4 // $s is the string requiring macro substitution.
5 // $r is an array of key value pairs (search => replace)
6 // returns substituted string.
7 // WARNING: this is pretty basic, and doesn't properly handle search strings that are substrings of each other.
8 // For instance if 'test' => "foo" and 'testing' => "bar", testing could become either bar or fooing, 
9 // depending on the order in which they were declared in the array.   
10
11 require_once("include/template_processor.php");
12
13 if(! function_exists('replace_macros')) {  
14 function replace_macros($s,$r) {
15         global $t;
16         
17         //$ts = microtime();
18         $r =  $t->replace($s,$r);
19         //$tt = microtime() - $ts;
20         
21         //$a = get_app();
22         //$a->page['debug'] .= "$tt <br>\n";
23         return template_unescape($r);
24
25 }}
26
27
28 // random string, there are 86 characters max in text mode, 128 for hex
29 // output is urlsafe
30
31 define('RANDOM_STRING_HEX',  0x00 );
32 define('RANDOM_STRING_TEXT', 0x01 );
33
34 if(! function_exists('random_string')) {
35 function random_string($size = 64,$type = RANDOM_STRING_HEX) {
36         // generate a bit of entropy and run it through the whirlpool
37         $s = hash('whirlpool', (string) rand() . uniqid(rand(),true) . (string) rand(),(($type == RANDOM_STRING_TEXT) ? true : false));
38         $s = (($type == RANDOM_STRING_TEXT) ? str_replace("\n","",base64url_encode($s,true)) : $s);
39         return(substr($s,0,$size));
40 }}
41
42 /**
43  * This is our primary input filter. 
44  *
45  * The high bit hack only involved some old IE browser, forget which (IE5/Mac?)
46  * that had an XSS attack vector due to stripping the high-bit on an 8-bit character
47  * after cleansing, and angle chars with the high bit set could get through as markup.
48  * 
49  * This is now disabled because it was interfering with some legitimate unicode sequences 
50  * and hopefully there aren't a lot of those browsers left. 
51  *
52  * Use this on any text input where angle chars are not valid or permitted
53  * They will be replaced with safer brackets. This may be filtered further
54  * if these are not allowed either.   
55  *
56  */
57
58 if(! function_exists('notags')) {
59 function notags($string) {
60
61         return(str_replace(array("<",">"), array('[',']'), $string));
62
63 //  High-bit filter no longer used
64 //      return(str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string));
65 }}
66
67 // use this on "body" or "content" input where angle chars shouldn't be removed,
68 // and allow them to be safely displayed.
69
70 if(! function_exists('escape_tags')) {
71 function escape_tags($string) {
72
73         return(htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false));
74 }}
75
76
77 // generate a string that's random, but usually pronounceable. 
78 // used to generate initial passwords
79
80 if(! function_exists('autoname')) {
81 function autoname($len) {
82
83         if($len <= 0)
84                 return '';
85
86         $vowels = array('a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u'); 
87         if(mt_rand(0,5) == 4)
88                 $vowels[] = 'y';
89
90         $cons = array(
91                         'b','bl','br',
92                         'c','ch','cl','cr',
93                         'd','dr',
94                         'f','fl','fr',
95                         'g','gh','gl','gr',
96                         'h',
97                         'j',
98                         'k','kh','kl','kr',
99                         'l',
100                         'm',
101                         'n',
102                         'p','ph','pl','pr',
103                         'qu',
104                         'r','rh',
105                         's','sc','sh','sm','sp','st',
106                         't','th','tr',
107                         'v',
108                         'w','wh',
109                         'x',
110                         'z','zh'
111                         );
112
113         $midcons = array('ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
114                                 'nd','ng','nk','nt','rn','rp','rt');
115
116         $noend = array('bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
117                                 'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh');
118
119         $start = mt_rand(0,2);
120         if($start == 0)
121                 $table = $vowels;
122         else
123                 $table = $cons;
124
125         $word = '';
126
127         for ($x = 0; $x < $len; $x ++) {
128                 $r = mt_rand(0,count($table) - 1);
129                 $word .= $table[$r];
130   
131                 if($table == $vowels)
132                         $table = array_merge($cons,$midcons);
133                 else
134                         $table = $vowels;
135
136         }
137
138         $word = substr($word,0,$len);
139
140         foreach($noend as $noe) {
141                 if((strlen($word) > 2) && (substr($word,-2) == $noe)) {
142                         $word = substr($word,0,-1);
143                         break;
144                 }
145         }
146         if(substr($word,-1) == 'q')
147                 $word = substr($word,0,-1);    
148         return $word;
149 }}
150
151
152 // escape text ($str) for XML transport
153 // returns escaped text.
154
155 if(! function_exists('xmlify')) {
156 function xmlify($str) {
157         $buffer = '';
158         
159         for($x = 0; $x < mb_strlen($str); $x ++) {
160                 $char = $str[$x];
161         
162                 switch( $char ) {
163
164                         case "\r" :
165                                 break;
166                         case "&" :
167                                 $buffer .= '&amp;';
168                                 break;
169                         case "'" :
170                                 $buffer .= '&apos;';
171                                 break;
172                         case "\"" :
173                                 $buffer .= '&quot;';
174                                 break;
175                         case '<' :
176                                 $buffer .= '&lt;';
177                                 break;
178                         case '>' :
179                                 $buffer .= '&gt;';
180                                 break;
181                         case "\n" :
182                                 $buffer .= "\n";
183                                 break;
184                         default :
185                                 $buffer .= $char;
186                                 break;
187                 }       
188         }
189         $buffer = trim($buffer);
190         return($buffer);
191 }}
192
193 // undo an xmlify
194 // pass xml escaped text ($s), returns unescaped text
195
196 if(! function_exists('unxmlify')) {
197 function unxmlify($s) {
198         $ret = str_replace('&amp;','&', $s);
199         $ret = str_replace(array('&lt;','&gt;','&quot;','&apos;'),array('<','>','"',"'"),$ret);
200         return $ret;    
201 }}
202
203 // convenience wrapper, reverse the operation "bin2hex"
204
205 if(! function_exists('hex2bin')) {
206 function hex2bin($s) {
207         if(! (is_string($s) && strlen($s)))
208                 return '';
209
210         if(! ctype_xdigit($s)) {
211                 return($s);
212         }
213
214         return(pack("H*",$s));
215 }}
216
217 // Automatic pagination.
218 // To use, get the count of total items.
219 // Then call $a->set_pager_total($number_items);
220 // Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
221 // Then call paginate($a) after the end of the display loop to insert the pager block on the page
222 // (assuming there are enough items to paginate).
223 // When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
224 // will limit the results to the correct items for the current page. 
225 // The actual page handling is then accomplished at the application layer. 
226
227 if(! function_exists('paginate')) {
228 function paginate(&$a) {
229         $o = '';
230         $stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
231
232 //      $stripped = preg_replace('/&zrl=(.*?)([\?&]|$)/ism','',$stripped);
233
234         $stripped = str_replace('q=','',$stripped);
235         $stripped = trim($stripped,'/');
236         $pagenum = $a->pager['page'];
237         $url = $a->get_baseurl() . '/' . $stripped;
238
239
240           if($a->pager['total'] > $a->pager['itemspage']) {
241                 $o .= '<div class="pager">';
242                 if($a->pager['page'] != 1)
243                         $o .= '<span class="pager_prev">'."<a href=\"$url".'&page='.($a->pager['page'] - 1).'">' . t('prev') . '</a></span> ';
244
245                 $o .=  "<span class=\"pager_first\"><a href=\"$url"."&page=1\">" . t('first') . "</a></span> ";
246
247                 $numpages = $a->pager['total'] / $a->pager['itemspage'];
248
249                         $numstart = 1;
250                 $numstop = $numpages;
251
252                 if($numpages > 14) {
253                         $numstart = (($pagenum > 7) ? ($pagenum - 7) : 1);
254                         $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 14));
255                 }
256    
257                 for($i = $numstart; $i <= $numstop; $i++){
258                         if($i == $a->pager['page'])
259                                 $o .= '<span class="pager_current">'.(($i < 10) ? '&nbsp;'.$i : $i);
260                         else
261                                 $o .= "<span class=\"pager_n\"><a href=\"$url"."&page=$i\">".(($i < 10) ? '&nbsp;'.$i : $i)."</a>";
262                         $o .= '</span> ';
263                 }
264
265                 if(($a->pager['total'] % $a->pager['itemspage']) != 0) {
266                         if($i == $a->pager['page'])
267                                 $o .= '<span class="pager_current">'.(($i < 10) ? '&nbsp;'.$i : $i);
268                         else
269                                 $o .= "<span class=\"pager_n\"><a href=\"$url"."&page=$i\">".(($i < 10) ? '&nbsp;'.$i : $i)."</a>";
270                         $o .= '</span> ';
271                 }
272
273                 $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
274                 $o .= "<span class=\"pager_last\"><a href=\"$url"."&page=$lastpage\">" . t('last') . "</a></span> ";
275
276                 if(($a->pager['total'] - ($a->pager['itemspage'] * $a->pager['page'])) > 0)
277                         $o .= '<span class="pager_next">'."<a href=\"$url"."&page=".($a->pager['page'] + 1).'">' . t('next') . '</a></span>';
278                 $o .= '</div>'."\r\n";
279         }
280         return $o;
281 }}
282
283 if(! function_exists('alt_pager')) {
284 function alt_pager(&$a, $i) {
285         $o = '';
286         $stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
287         $stripped = str_replace('q=','',$stripped);
288         $stripped = trim($stripped,'/');
289         $pagenum = $a->pager['page'];
290         $url = $a->get_baseurl() . '/' . $stripped;
291
292         $o .= '<div class="pager">';
293
294         if($a->pager['page']>1)
295           $o .= "<a href=\"$url"."&page=".($a->pager['page'] - 1).'">' . t('newer') . '</a>';
296         if($i>0) {
297           if($a->pager['page']>1)
298                   $o .= "&nbsp;-&nbsp;";
299           $o .= "<a href=\"$url"."&page=".($a->pager['page'] + 1).'">' . t('older') . '</a>';
300         }
301
302
303         $o .= '</div>'."\r\n";
304
305         return $o;
306 }}
307
308 // Turn user/group ACLs stored as angle bracketed text into arrays
309
310 if(! function_exists('expand_acl')) {
311 function expand_acl($s) {
312         // turn string array of angle-bracketed elements into numeric array
313         // e.g. "<1><2><3>" => array(1,2,3);
314         $ret = array();
315
316         if(strlen($s)) {
317                 $t = str_replace('<','',$s);
318                 $a = explode('>',$t);
319                 foreach($a as $aa) {
320                         if(intval($aa))
321                                 $ret[] = intval($aa);
322                 }
323         }
324         return $ret;
325 }}              
326
327 // Used to wrap ACL elements in angle brackets for storage 
328
329 if(! function_exists('sanitise_acl')) {
330 function sanitise_acl(&$item) {
331         if(intval($item))
332                 $item = '<' . intval(notags(trim($item))) . '>';
333         else
334                 unset($item);
335 }}
336
337
338 // Convert an ACL array to a storable string
339
340 if(! function_exists('perms2str')) {
341 function perms2str($p) {
342         $ret = '';
343         $tmp = $p;
344         if(is_array($tmp)) {
345                 array_walk($tmp,'sanitise_acl');
346                 $ret = implode('',$tmp);
347         }
348         return $ret;
349 }}
350
351 // generate a guaranteed unique (for this domain) item ID for ATOM
352 // safe from birthday paradox
353
354 if(! function_exists('item_new_uri')) {
355 function item_new_uri($hostname,$uid) {
356
357         do {
358                 $dups = false;
359                 $hash = random_string();
360
361                 $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
362
363                 $r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1",
364                         dbesc($uri));
365                 if(count($r))
366                         $dups = true;
367         } while($dups == true);
368         return $uri;
369 }}
370
371 // Generate a guaranteed unique photo ID.
372 // safe from birthday paradox
373
374 if(! function_exists('photo_new_resource')) {
375 function photo_new_resource() {
376
377         do {
378                 $found = false;
379                 $resource = hash('md5',uniqid(mt_rand(),true));
380                 $r = q("SELECT `id` FROM `photo` WHERE `resource-id` = '%s' LIMIT 1",
381                         dbesc($resource)
382                 );
383                 if(count($r))
384                         $found = true;
385         } while($found == true);
386         return $resource;
387 }}
388
389
390 // wrapper to load a view template, checking for alternate
391 // languages before falling back to the default
392
393 // obsolete, deprecated.
394
395 if(! function_exists('load_view_file')) {
396 function load_view_file($s) {
397         global $lang, $a;
398         if(! isset($lang))
399                 $lang = 'en';
400         $b = basename($s);
401         $d = dirname($s);
402         if(file_exists("$d/$lang/$b"))
403                 return file_get_contents("$d/$lang/$b");
404         
405         $theme = current_theme();
406
407         if(file_exists("$d/theme/$theme/$b"))
408                 return file_get_contents("$d/theme/$theme/$b");
409                         
410         return file_get_contents($s);
411 }}
412
413 if(! function_exists('get_intltext_template')) {
414 function get_intltext_template($s) {
415         global $lang;
416
417         if(! isset($lang))
418                 $lang = 'en';
419
420         if(file_exists("view/$lang/$s"))
421                 return file_get_contents("view/$lang/$s");
422         elseif(file_exists("view/en/$s"))
423                 return file_get_contents("view/en/$s");
424         else
425                 return file_get_contents("view/$s");
426 }}
427
428 if(! function_exists('get_markup_template')) {
429 function get_markup_template($s) {
430         $a=get_app();
431         $theme = current_theme();
432         
433         if(file_exists("view/theme/$theme/$s"))
434                 return file_get_contents("view/theme/$theme/$s");
435         elseif (x($a->theme_info,"extends") && file_exists("view/theme/".$a->theme_info["extends"]."/$s"))
436                 return file_get_contents("view/theme/".$a->theme_info["extends"]."/$s");
437         else
438                 return file_get_contents("view/$s");
439
440 }}
441
442
443
444
445
446 // for html,xml parsing - let's say you've got
447 // an attribute foobar="class1 class2 class3"
448 // and you want to find out if it contains 'class3'.
449 // you can't use a normal sub string search because you
450 // might match 'notclass3' and a regex to do the job is 
451 // possible but a bit complicated. 
452 // pass the attribute string as $attr and the attribute you 
453 // are looking for as $s - returns true if found, otherwise false
454
455 if(! function_exists('attribute_contains')) {
456 function attribute_contains($attr,$s) {
457         $a = explode(' ', $attr);
458         if(count($a) && in_array($s,$a))
459                 return true;
460         return false;
461 }}
462
463 if(! function_exists('logger')) {
464 function logger($msg,$level = 0) {
465         // turn off logger in install mode
466         global $a;
467         global $db;
468
469         if(($a->module == 'install') || (! ($db && $db->connected))) return;
470
471         $debugging = get_config('system','debugging');
472         $loglevel  = intval(get_config('system','loglevel'));
473         $logfile   = get_config('system','logfile');
474
475         if((! $debugging) || (! $logfile) || ($level > $loglevel))
476                 return;
477         
478         @file_put_contents($logfile, datetime_convert() . ':' . session_id() . ' ' . $msg . "\n", FILE_APPEND);
479         return;
480 }}
481
482
483 if(! function_exists('activity_match')) {
484 function activity_match($haystack,$needle) {
485         if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
486                 return true;
487         return false;
488 }}
489
490
491 // Pull out all #hashtags and @person tags from $s;
492 // We also get @person@domain.com - which would make 
493 // the regex quite complicated as tags can also
494 // end a sentence. So we'll run through our results
495 // and strip the period from any tags which end with one.
496 // Returns array of tags found, or empty array.
497
498
499 if(! function_exists('get_tags')) {
500 function get_tags($s) {
501         $ret = array();
502
503         // ignore anything in a code block
504
505         $s = preg_replace('/\[code\](.*?)\[\/code\]/sm','',$s);
506
507         // ignore anything in a bbtag
508
509         $s = preg_replace('/\[(.*?)\]/sm','',$s);
510
511         // Match full names against @tags including the space between first and last
512         // We will look these up afterward to see if they are full names or not recognisable.
513
514         if(preg_match_all('/(@[^ \x0D\x0A,:?]+ [^ \x0D\x0A@,:?]+)([ \x0D\x0A@,:?]|$)/',$s,$match)) {
515                 foreach($match[1] as $mtch) {
516                         if(strstr($mtch,"]")) {
517                                 // we might be inside a bbcode color tag - leave it alone
518                                 continue;
519                         }
520                         if(substr($mtch,-1,1) === '.')
521                                 $ret[] = substr($mtch,0,-1);
522                         else
523                                 $ret[] = $mtch;
524                 }
525         }
526
527         // Otherwise pull out single word tags. These can be @nickname, @first_last
528         // and #hash tags.
529
530         if(preg_match_all('/([@#][^ \x0D\x0A,;:?]+)([ \x0D\x0A,;:?]|$)/',$s,$match)) {
531                 foreach($match[1] as $mtch) {
532                         if(strstr($mtch,"]")) {
533                                 // we might be inside a bbcode color tag - leave it alone
534                                 continue;
535                         }
536                         if(substr($mtch,-1,1) === '.')
537                                 $mtch = substr($mtch,0,-1);
538                         // ignore strictly numeric tags like #1
539                         if((strpos($mtch,'#') === 0) && ctype_digit(substr($mtch,1)))
540                                 continue;
541                         // try not to catch url fragments
542                         if(strpos($s,$mtch) && preg_match('/[a-zA-z0-9\/]/',substr($s,strpos($s,$mtch)-1,1)))
543                                 continue;
544                         $ret[] = $mtch;
545                 }
546         }
547         return $ret;
548 }}
549
550
551 // quick and dirty quoted_printable encoding
552
553 if(! function_exists('qp')) {
554 function qp($s) {
555 return str_replace ("%","=",rawurlencode($s));
556 }} 
557
558
559
560 if(! function_exists('get_mentions')) {
561 function get_mentions($item) {
562         $o = '';
563         if(! strlen($item['tag']))
564                 return $o;
565
566         $arr = explode(',',$item['tag']);
567         foreach($arr as $x) {
568                 $matches = null;
569                 if(preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
570                         $o .= "\t\t" . '<link rel="mentioned" href="' . $matches[1] . '" />' . "\r\n";
571                         $o .= "\t\t" . '<link rel="ostatus:attention" href="' . $matches[1] . '" />' . "\r\n";
572                 }
573         }
574         return $o;
575 }}
576
577 if(! function_exists('contact_block')) {
578 function contact_block() {
579         $o = '';
580         $a = get_app();
581
582         $shown = get_pconfig($a->profile['uid'],'system','display_friend_count');
583         if($shown === false)
584                 $shown = 24;
585         if($shown == 0)
586                 return;
587
588         if((! is_array($a->profile)) || ($a->profile['hide-friends']))
589                 return $o;
590         $r = q("SELECT COUNT(*) AS `total` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0 AND `hidden` = 0 AND `archive` = 0",
591                         intval($a->profile['uid'])
592         );
593         if(count($r)) {
594                 $total = intval($r[0]['total']);
595         }
596         if(! $total) {
597                 $contacts = t('No contacts');
598                 $micropro = Null;
599                 
600         } else {
601                 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 and `pending` = 0 AND `hidden` = 0 AND `archive` = 0 ORDER BY RAND() LIMIT %d",
602                                 intval($a->profile['uid']),
603                                 intval($shown)
604                 );
605                 if(count($r)) {
606                         $contacts = sprintf( tt('%d Contact','%d Contacts', $total),$total);
607                         $micropro = Array();
608                         foreach($r as $rr) {
609                                 $micropro[] = micropro($rr,true,'mpfriend');
610                         }
611                 }
612         }
613         
614         $tpl = get_markup_template('contact_block.tpl');
615         $o = replace_macros($tpl, array(
616                 '$contacts' => $contacts,
617                 '$nickname' => $a->profile['nickname'],
618                 '$viewcontacts' => t('View Contacts'),
619                 '$micropro' => $micropro,
620         ));
621
622         $arr = array('contacts' => $r, 'output' => $o);
623
624         call_hooks('contact_block_end', $arr);
625         return $o;
626
627 }}
628
629 if(! function_exists('micropro')) {
630 function micropro($contact, $redirect = false, $class = '', $textmode = false) {
631
632         if($class)
633                 $class = ' ' . $class;
634
635         $url = $contact['url'];
636         $sparkle = '';
637         $redir = false;
638
639         if($redirect) {
640                 $a = get_app();
641                 $redirect_url = $a->get_baseurl() . '/redir/' . $contact['id'];
642                 if(local_user() && ($contact['uid'] == local_user()) && ($contact['network'] === 'dfrn')) {
643                         $redir = true;
644                         $url = $redirect_url;
645                         $sparkle = ' sparkle';
646                 }
647                 else
648                         $url = zrl($url);
649         }
650         $click = ((x($contact,'click')) ? ' onclick="' . $contact['click'] . '" ' : '');
651         if($click)
652                 $url = '';
653         if($textmode) {
654                 return '<div class="contact-block-textdiv' . $class . '"><a class="contact-block-link' . $class . $sparkle 
655                         . (($click) ? ' fakelink' : '') . '" '
656                         . (($redir) ? ' target="redir" ' : '')
657                         . (($url) ? ' href="' . $url . '"' : '') . $click
658                         . '" title="' . $contact['name'] . ' [' . $contact['url'] . ']" alt="' . $contact['name'] 
659                         . '" >'. $contact['name'] . '</a></div>' . "\r\n";
660         }
661         else {
662                 return '<div class="contact-block-div' . $class . '"><a class="contact-block-link' . $class . $sparkle 
663                         . (($click) ? ' fakelink' : '') . '" '
664                         . (($redir) ? ' target="redir" ' : '')
665                         . (($url) ? ' href="' . $url . '"' : '') . $click . ' ><img class="contact-block-img' . $class . $sparkle . '" src="' 
666                         . $contact['micro'] . '" title="' . $contact['name'] . ' [' . $contact['url'] . ']" alt="' . $contact['name'] 
667                         . '" /></a></div>' . "\r\n";
668         }
669 }}
670
671
672
673 if(! function_exists('search')) {
674 function search($s,$id='search-box',$url='/search',$save = false) {
675         $a = get_app();
676         $o  = '<div id="' . $id . '">';
677         $o .= '<form action="' . $a->get_baseurl((stristr($url,'network')) ? true : false) . $url . '" method="get" >';
678         $o .= '<input type="text" name="search" id="search-text" placeholder="' . t('Search') . '" value="' . $s .'" />';
679         $o .= '<input type="submit" name="submit" id="search-submit" value="' . t('Search') . '" />'; 
680         if($save)
681                 $o .= '<input type="submit" name="save" id="search-save" value="' . t('Save') . '" />'; 
682         $o .= '</form></div>';
683         return $o;
684 }}
685
686 if(! function_exists('valid_email')) {
687 function valid_email($x){
688
689         if(get_config('system','disable_email_validation'))
690                 return true;
691
692         if(preg_match('/^[_a-zA-Z0-9\-\+]+(\.[_a-zA-Z0-9\-\+]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/',$x))
693                 return true;
694         return false;
695 }}
696
697
698 /**
699  *
700  * Function: linkify
701  *
702  * Replace naked text hyperlink with HTML formatted hyperlink
703  *
704  */
705
706 if(! function_exists('linkify')) {
707 function linkify($s) {
708         $s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="external-link">$1</a>', $s);
709         $s = preg_replace("/\<(.*?)(src|href)=(.*?)\&amp\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
710         return($s);
711 }}
712
713 function get_poke_verbs() {
714         
715         // index is present tense verb
716         // value is array containing past tense verb, translation of present, translation of past
717
718         $arr = array(
719                 'poke' => array( 'poked', t('poke'), t('poked')),
720                 'ping' => array( 'pinged', t('ping'), t('pinged')),
721                 'prod' => array( 'prodded', t('prod'), t('prodded')),
722                 'slap' => array( 'slapped', t('slap'), t('slapped')),
723                 'finger' => array( 'fingered', t('finger'), t('fingered')),
724                 'rebuff' => array( 'rebuffed', t('rebuff'), t('rebuffed')),
725         );
726         call_hooks('poke_verbs', $arr);
727         return $arr;
728 }
729
730 function get_mood_verbs() {
731         
732         // index is present tense verb
733         // value is array containing past tense verb, translation of present, translation of past
734
735         $arr = array(
736                 'happy'      => t('happy'),
737                 'sad'        => t('sad'),
738                 'mellow'     => t('mellow'),
739                 'tired'      => t('tired'),
740                 'perky'      => t('perky'),
741                 'angry'      => t('angry'),
742                 'stupefied'  => t('stupified'),
743                 'puzzled'    => t('puzzled'),
744                 'interested' => t('interested'),
745                 'bitter'     => t('bitter'),
746                 'cheerful'   => t('cheerful'),
747                 'alive'      => t('alive'),
748                 'annoyed'    => t('annoyed'),
749                 'anxious'    => t('anxious'),
750                 'cranky'     => t('cranky'),
751                 'disturbed'  => t('disturbed'),
752                 'frustrated' => t('frustrated'),
753                 'motivated'  => t('motivated'),
754                 'relaxed'    => t('relaxed'),
755                 'surprised'  => t('surprised'),
756         );
757
758         call_hooks('mood_verbs', $arr);
759         return $arr;
760 }
761
762
763 /**
764  * 
765  * Function: smilies
766  *
767  * Description:
768  * Replaces text emoticons with graphical images
769  *
770  * @Parameter: string $s
771  *
772  * Returns string
773  *
774  * It is expected that this function will be called using HTML text.
775  * We will escape text between HTML pre and code blocks from being 
776  * processed. 
777  * 
778  * At a higher level, the bbcode [nosmile] tag can be used to prevent this 
779  * function from being executed by the prepare_text() routine when preparing
780  * bbcode source for HTML display
781  *
782  */
783
784 if(! function_exists('smilies')) {
785 function smilies($s, $sample = false) {
786
787         $a = get_app();
788
789         if(intval(get_config('system','no_smilies')) 
790                 || (local_user() && intval(get_pconfig(local_user(),'system','no_smilies'))))
791                 return $s;
792
793         $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','smile_encode',$s);
794         $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','smile_encode',$s);
795
796         $texts =  array( 
797                 '&lt;3', 
798                 '&lt;/3', 
799                 '&lt;\\3', 
800                 ':-)', 
801                 ';-)', 
802                 ':-(', 
803                 ':-P', 
804                 ':-p', 
805                 ':-"', 
806                 ':-&quot;', 
807                 ':-x', 
808                 ':-X', 
809                 ':-D', 
810                 '8-|', 
811                 '8-O', 
812                 ':-O', 
813                 '\\o/', 
814                 'o.O', 
815                 'O.o', 
816                 'o_O', 
817                 'O_o', 
818                 ":'(", 
819                 ":-!", 
820                 ":-/", 
821                 ":-[", 
822                 "8-)",
823                 ':beer', 
824                 ':homebrew', 
825                 ':coffee', 
826                 ':facepalm',
827                 ':like',
828                 ':dislike',
829                 '~friendica'
830
831         );
832
833         $icons = array(
834                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-heart.gif" alt="<3" />',
835                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-brokenheart.gif" alt="</3" />',
836                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-brokenheart.gif" alt="<\\3" />',
837                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-smile.gif" alt=":-)" />',
838                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-wink.gif" alt=";-)" />',
839                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-frown.gif" alt=":-(" />',
840                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-P" />',
841                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-p" />',
842                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-\"" />',
843                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-\"" />',
844                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-x" />',
845                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-kiss.gif" alt=":-X" />',
846                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-laughing.gif" alt=":-D" />',
847                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt="8-|" />',
848                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt="8-O" />',
849                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-surprised.gif" alt=":-O" />',                
850                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-thumbsup.gif" alt="\\o/" />',
851                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="o.O" />',
852                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="O.o" />',
853                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="o_O" />',
854                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-Oo.gif" alt="O_o" />',
855                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-cry.gif" alt=":\'(" />',
856                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-foot-in-mouth.gif" alt=":-!" />',
857                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-undecided.gif" alt=":-/" />',
858                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-embarassed.gif" alt=":-[" />',
859                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-cool.gif" alt="8-)" />',
860                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/beer_mug.gif" alt=":beer" />',
861                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/beer_mug.gif" alt=":homebrew" />',
862                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/coffee.gif" alt=":coffee" />',
863                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-facepalm.gif" alt=":facepalm" />',
864                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/like.gif" alt=":like" />',
865                 '<img class="smiley" src="' . $a->get_baseurl() . '/images/dislike.gif" alt=":dislike" />',
866                 '<a href="http://friendica.com">~friendica <img class="smiley" src="' . $a->get_baseurl() . '/images/friendica-16.png" alt="~friendica" /></a>'
867         );
868
869         $params = array('texts' => $texts, 'icons' => $icons, 'string' => $s);
870         call_hooks('smilie', $params);
871
872         if($sample) {
873                 $s = '<div class="smiley-sample">';
874                 for($x = 0; $x < count($params['texts']); $x ++) {
875                         $s .= '<dl><dt>' . $params['texts'][$x] . '</dt><dd>' . $params['icons'][$x] . '</dd></dl>';
876                 }
877         }
878         else {
879                 $params['string'] = preg_replace_callback('/&lt;(3+)/','preg_heart',$params['string']);
880                 $s = str_replace($params['texts'],$params['icons'],$params['string']);
881         }
882
883         $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','smile_decode',$s);
884         $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','smile_decode',$s);
885
886         return $s;
887
888 }}
889
890 function smile_encode($m) {
891         return(str_replace($m[1],base64url_encode($m[1]),$m[0]));
892 }
893
894 function smile_decode($m) {
895         return(str_replace($m[1],base64url_decode($m[1]),$m[0]));
896 }
897
898 // expand <3333 to the correct number of hearts
899
900 function preg_heart($x) {
901         $a = get_app();
902         if(strlen($x[1]) == 1)
903                 return $x[0];
904         $t = '';
905         for($cnt = 0; $cnt < strlen($x[1]); $cnt ++)
906                 $t .= '<img class="smiley" src="' . $a->get_baseurl() . '/images/smiley-heart.gif" alt="<3" />';
907         $r =  str_replace($x[0],$t,$x[0]);
908         return $r;
909 }
910
911
912 if(! function_exists('day_translate')) {
913 function day_translate($s) {
914         $ret = str_replace(array('Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'),
915                 array( t('Monday'), t('Tuesday'), t('Wednesday'), t('Thursday'), t('Friday'), t('Saturday'), t('Sunday')),
916                 $s);
917
918         $ret = str_replace(array('January','February','March','April','May','June','July','August','September','October','November','December'),
919                 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')),
920                 $ret);
921
922         return $ret;
923 }}
924
925
926 if(! function_exists('normalise_link')) {
927 function normalise_link($url) {
928         $ret = str_replace(array('https:','//www.'), array('http:','//'), $url);
929         return(rtrim($ret,'/'));
930 }}
931
932 /**
933  *
934  * Compare two URLs to see if they are the same, but ignore
935  * slight but hopefully insignificant differences such as if one 
936  * is https and the other isn't, or if one is www.something and 
937  * the other isn't - and also ignore case differences.
938  *
939  * Return true if the URLs match, otherwise false.
940  *
941  */
942
943 if(! function_exists('link_compare')) {
944 function link_compare($a,$b) {
945         if(strcasecmp(normalise_link($a),normalise_link($b)) === 0)
946                 return true;
947         return false;
948 }}
949
950 // Given an item array, convert the body element from bbcode to html and add smilie icons.
951 // If attach is true, also add icons for item attachments
952
953
954 if(! function_exists('prepare_body')) {
955 function prepare_body($item,$attach = false) {
956
957         $a = get_app();
958         call_hooks('prepare_body_init', $item); 
959
960         $cache = get_config('system','itemcache');
961
962         if (($cache != '')) {
963                 $cachefile = $cache."/".$item["guid"]."-".strtotime($item["edited"])."-".hash("crc32", $item['body']);
964
965                 if (file_exists($cachefile))
966                         $s = file_get_contents($cachefile);
967                 else {
968                         $s = prepare_text($item['body']);
969                         file_put_contents($cachefile, $s);
970                 }
971         } else
972                 $s = prepare_text($item['body']);
973
974
975         $prep_arr = array('item' => $item, 'html' => $s);
976         call_hooks('prepare_body', $prep_arr);
977         $s = $prep_arr['html'];
978
979         if(! $attach) {
980                 return $s;
981         }
982
983         $arr = explode(',',$item['attach']);
984         if(count($arr)) {
985                 $s .= '<div class="body-attach">';
986                 foreach($arr as $r) {
987                         $matches = false;
988                         $icon = '';
989                         $cnt = preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"\[\/attach\]|',$r,$matches, PREG_SET_ORDER);
990                         if($cnt) {
991                                 foreach($matches as $mtch) {
992                                         $icontype = strtolower(substr($mtch[3],0,strpos($mtch[3],'/')));
993                                         switch($icontype) {
994                                                 case 'video':
995                                                 case 'audio':
996                                                 case 'image':
997                                                 case 'text':
998                                                         $icon = '<div class="attachtype icon s22 type-' . $icontype . '"></div>';
999                                                         break;
1000                                                 default:
1001                                                         $icon = '<div class="attachtype icon s22 type-unkn"></div>';
1002                                                         break;
1003                                         }
1004                                         $title = ((strlen(trim($mtch[4]))) ? escape_tags(trim($mtch[4])) : escape_tags($mtch[1]));
1005                                         $title .= ' ' . $mtch[2] . ' ' . t('bytes');
1006                                         if((local_user() == $item['uid']) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN))
1007                                                 $the_url = $a->get_baseurl() . '/redir/' . $item['contact-id'] . '?f=1&url=' . $mtch[1];
1008                                         else
1009                                                 $the_url = $mtch[1];
1010
1011                                         $s .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="external-link" >' . $icon . '</a>';
1012                                 }
1013                         }
1014                 }
1015                 $s .= '<div class="clear"></div></div>';
1016         }
1017
1018
1019         // Look for spoiler
1020         $spoilersearch = '<blockquote class="spoiler">';
1021
1022         // Remove line breaks before the spoiler
1023         while ((strpos($s, "\n".$spoilersearch) !== false))
1024                 $s = str_replace("\n".$spoilersearch, $spoilersearch, $s);
1025         while ((strpos($s, "<br />".$spoilersearch) !== false))
1026                 $s = str_replace("<br />".$spoilersearch, $spoilersearch, $s);
1027
1028         while ((strpos($s, $spoilersearch) !== false)) {
1029
1030                 $pos = strpos($s, $spoilersearch);
1031                 $rnd = random_string(8);
1032                 $spoilerreplace = '<br /> <span id="spoiler-wrap-'.$rnd.'" style="white-space:nowrap;" class="fakelink" onclick="openClose(\'spoiler-'.$rnd.'\');">'.sprintf(t('Click to open/close')).'</span>'.
1033                                         '<blockquote class="spoiler" id="spoiler-'.$rnd.'" style="display: none;">';
1034                 $s = substr($s, 0, $pos).$spoilerreplace.substr($s, $pos+strlen($spoilersearch));
1035         }
1036
1037         // Look for quote with author
1038         $authorsearch = '<blockquote class="author">';
1039
1040         while ((strpos($s, $authorsearch) !== false)) {
1041
1042                 $pos = strpos($s, $authorsearch);
1043                 $rnd = random_string(8);
1044                 $authorreplace = '<br /> <span id="author-wrap-'.$rnd.'" style="white-space:nowrap;" class="fakelink" onclick="openClose(\'author-'.$rnd.'\');">'.sprintf(t('Click to open/close')).'</span>'.
1045                                         '<blockquote class="author" id="author-'.$rnd.'" style="display: block;">';
1046                 $s = substr($s, 0, $pos).$authorreplace.substr($s, $pos+strlen($authorsearch));
1047         }
1048
1049         $prep_arr = array('item' => $item, 'html' => $s);
1050         call_hooks('prepare_body_final', $prep_arr);
1051
1052         return $prep_arr['html'];
1053 }}
1054
1055
1056 // Given a text string, convert from bbcode to html and add smilie icons.
1057
1058 if(! function_exists('prepare_text')) {
1059 function prepare_text($text) {
1060
1061         require_once('include/bbcode.php');
1062
1063         if(stristr($text,'[nosmile]'))
1064                 $s = bbcode($text);
1065         else
1066                 $s = smilies(bbcode($text));
1067
1068         return $s;
1069 }}
1070
1071
1072 /**
1073  * returns 
1074  * [
1075  *    //categories [
1076  *          {
1077  *               'name': 'category name',
1078  *              'removeurl': 'url to remove this category',
1079  *             'first': 'is the first in this array? true/false',
1080  *               'last': 'is the last in this array? true/false',
1081  *           } ,
1082  *           ....
1083  *       ],
1084  *       // folders [
1085  *               'name': 'folder name',
1086  *               'removeurl': 'url to remove this folder',
1087  *               'first': 'is the first in this array? true/false',
1088  *               'last': 'is the last in this array? true/false',
1089  *           } ,
1090  *           ....       
1091  *       ]
1092  *   ]
1093  */
1094 function get_cats_and_terms($item) {
1095     $a = get_app();
1096     $categories = array();
1097     $folders = array();
1098
1099     $matches = false; $first = true;
1100     $cnt = preg_match_all('/<(.*?)>/',$item['file'],$matches,PREG_SET_ORDER);
1101     if($cnt) {
1102         foreach($matches as $mtch) {
1103             $categories[] = array(
1104                 'name' => xmlify(file_tag_decode($mtch[1])),
1105                 'url' =>  "#",
1106                 'removeurl' => ((local_user() == $item['uid'])?$a->get_baseurl() . '/filerm/' . $item['id'] . '?f=&cat=' . xmlify(file_tag_decode($mtch[1])):""),
1107                 'first' => $first,
1108                 'last' => false
1109             );
1110             $first = false;
1111         }
1112     }
1113     if (count($categories)) $categories[count($categories)-1]['last'] = true;
1114     
1115
1116         if(local_user() == $item['uid']) {
1117             $matches = false; $first = true;
1118         $cnt = preg_match_all('/\[(.*?)\]/',$item['file'],$matches,PREG_SET_ORDER);
1119             if($cnt) {
1120             foreach($matches as $mtch) {
1121                     $folders[] = array(
1122                     'name' => xmlify(file_tag_decode($mtch[1])),
1123                          'url' =>  "#",
1124                         'removeurl' => ((local_user() == $item['uid'])?$a->get_baseurl() . '/filerm/' . $item['id'] . '?f=&term=' . xmlify(file_tag_decode($mtch[1])):""),
1125                     'first' => $first,
1126                         'last' => false
1127                 );
1128                     $first = false;
1129                         }
1130         }
1131     }
1132
1133     if (count($folders)) $folders[count($folders)-1]['last'] = true;
1134
1135     return array($categories, $folders);
1136 }
1137
1138
1139 /**
1140  * return atom link elements for all of our hubs
1141  */
1142
1143 if(! function_exists('feed_hublinks')) {
1144 function feed_hublinks() {
1145
1146         $hub = get_config('system','huburl');
1147
1148         $hubxml = '';
1149         if(strlen($hub)) {
1150                 $hubs = explode(',', $hub);
1151                 if(count($hubs)) {
1152                         foreach($hubs as $h) {
1153                                 $h = trim($h);
1154                                 if(! strlen($h))
1155                                         continue;
1156                                 $hubxml .= '<link rel="hub" href="' . xmlify($h) . '" />' . "\n" ;
1157                         }
1158                 }
1159         }
1160         return $hubxml;
1161 }}
1162
1163 /* return atom link elements for salmon endpoints */
1164
1165 if(! function_exists('feed_salmonlinks')) {
1166 function feed_salmonlinks($nick) {
1167
1168         $a = get_app();
1169
1170         $salmon  = '<link rel="salmon" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ;
1171
1172         // old style links that status.net still needed as of 12/2010 
1173
1174         $salmon .= '  <link rel="http://salmon-protocol.org/ns/salmon-replies" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ; 
1175         $salmon .= '  <link rel="http://salmon-protocol.org/ns/salmon-mention" href="' . xmlify($a->get_baseurl() . '/salmon/' . $nick) . '" />' . "\n" ; 
1176         return $salmon;
1177 }}
1178
1179 if(! function_exists('get_plink')) {
1180 function get_plink($item) {
1181         $a = get_app(); 
1182         if (x($item,'plink') && ($item['private'] != 1)) {
1183                 return array(
1184                         'href' => $item['plink'],
1185                         'title' => t('link to source'),
1186                 );
1187         } 
1188         else {
1189                 return false;
1190         }
1191 }}
1192
1193 if(! function_exists('unamp')) {
1194 function unamp($s) {
1195         return str_replace('&amp;', '&', $s);
1196 }}
1197
1198
1199
1200
1201 if(! function_exists('lang_selector')) {
1202 function lang_selector() {
1203         global $lang;
1204         
1205         $langs = glob('view/*/strings.php');
1206         
1207         $lang_options = array();
1208         $selected = "";
1209         
1210         if(is_array($langs) && count($langs)) {
1211                 $langs[] = '';
1212                 if(! in_array('view/en/strings.php',$langs))
1213                         $langs[] = 'view/en/';
1214                 asort($langs);
1215                 foreach($langs as $l) {
1216                         if($l == '') {
1217                                 $lang_options[""] = t('default');
1218                                 continue;
1219                         }
1220                         $ll = substr($l,5);
1221                         $ll = substr($ll,0,strrpos($ll,'/'));
1222                         $selected = (($ll === $lang && (x($_SESSION, 'language'))) ? $ll : $selected);
1223                         $lang_options[$ll]=$ll;
1224                 }
1225         }
1226
1227         $tpl = get_markup_template("lang_selector.tpl");        
1228         $o = replace_macros($tpl, array(
1229                 '$title' => t('Select an alternate language'),
1230                 '$langs' => array($lang_options, $selected),
1231                 
1232         ));
1233         return $o;
1234 }}
1235
1236
1237 if(! function_exists('return_bytes')) {
1238 function return_bytes ($size_str) {
1239     switch (substr ($size_str, -1))
1240     {
1241         case 'M': case 'm': return (int)$size_str * 1048576;
1242         case 'K': case 'k': return (int)$size_str * 1024;
1243         case 'G': case 'g': return (int)$size_str * 1073741824;
1244         default: return $size_str;
1245     }
1246 }}
1247
1248 function generate_user_guid() {
1249         $found = true;
1250         do {
1251                 $guid = random_string(16);
1252                 $x = q("SELECT `uid` FROM `user` WHERE `guid` = '%s' LIMIT 1",
1253                         dbesc($guid)
1254                 );
1255                 if(! count($x))
1256                         $found = false;
1257         } while ($found == true );
1258         return $guid;
1259 }
1260
1261
1262
1263 function base64url_encode($s, $strip_padding = false) {
1264
1265         $s = strtr(base64_encode($s),'+/','-_');
1266
1267         if($strip_padding)
1268                 $s = str_replace('=','',$s);
1269
1270         return $s;
1271 }
1272
1273 function base64url_decode($s) {
1274
1275         if(is_array($s)) {
1276                 logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
1277                 return $s;
1278         }
1279
1280 /*
1281  *  // Placeholder for new rev of salmon which strips base64 padding.
1282  *  // PHP base64_decode handles the un-padded input without requiring this step
1283  *  // Uncomment if you find you need it.
1284  *
1285  *      $l = strlen($s);
1286  *      if(! strpos($s,'=')) {
1287  *              $m = $l % 4;
1288  *              if($m == 2)
1289  *                      $s .= '==';
1290  *              if($m == 3)
1291  *                      $s .= '=';
1292  *      }
1293  *
1294  */
1295
1296         return base64_decode(strtr($s,'-_','+/'));
1297 }
1298
1299
1300 if (!function_exists('str_getcsv')) {
1301     function str_getcsv($input, $delimiter = ',', $enclosure = '"', $escape = '\\', $eol = '\n') {
1302         if (is_string($input) && !empty($input)) {
1303             $output = array();
1304             $tmp    = preg_split("/".$eol."/",$input);
1305             if (is_array($tmp) && !empty($tmp)) {
1306                 while (list($line_num, $line) = each($tmp)) {
1307                     if (preg_match("/".$escape.$enclosure."/",$line)) {
1308                         while ($strlen = strlen($line)) {
1309                             $pos_delimiter       = strpos($line,$delimiter);
1310                             $pos_enclosure_start = strpos($line,$enclosure);
1311                             if (
1312                                 is_int($pos_delimiter) && is_int($pos_enclosure_start)
1313                                 && ($pos_enclosure_start < $pos_delimiter)
1314                                 ) {
1315                                 $enclosed_str = substr($line,1);
1316                                 $pos_enclosure_end = strpos($enclosed_str,$enclosure);
1317                                 $enclosed_str = substr($enclosed_str,0,$pos_enclosure_end);
1318                                 $output[$line_num][] = $enclosed_str;
1319                                 $offset = $pos_enclosure_end+3;
1320                             } else {
1321                                 if (empty($pos_delimiter) && empty($pos_enclosure_start)) {
1322                                     $output[$line_num][] = substr($line,0);
1323                                     $offset = strlen($line);
1324                                 } else {
1325                                     $output[$line_num][] = substr($line,0,$pos_delimiter);
1326                                     $offset = (
1327                                                 !empty($pos_enclosure_start)
1328                                                 && ($pos_enclosure_start < $pos_delimiter)
1329                                                 )
1330                                                 ?$pos_enclosure_start
1331                                                 :$pos_delimiter+1;
1332                                 }
1333                             }
1334                             $line = substr($line,$offset);
1335                         }
1336                     } else {
1337                         $line = preg_split("/".$delimiter."/",$line);
1338    
1339                         /*
1340                          * Validating against pesky extra line breaks creating false rows.
1341                          */
1342                         if (is_array($line) && !empty($line[0])) {
1343                             $output[$line_num] = $line;
1344                         } 
1345                     }
1346                 }
1347                 return $output;
1348             } else {
1349                 return false;
1350             }
1351         } else {
1352             return false;
1353         }
1354     }
1355
1356
1357 function cleardiv() {
1358         return '<div class="clear"></div>';
1359 }
1360
1361
1362 function bb_translate_video($s) {
1363
1364         $matches = null;
1365         $r = preg_match_all("/\[video\](.*?)\[\/video\]/ism",$s,$matches,PREG_SET_ORDER);
1366         if($r) {
1367                 foreach($matches as $mtch) {
1368                         if((stristr($mtch[1],'youtube')) || (stristr($mtch[1],'youtu.be')))
1369                                 $s = str_replace($mtch[0],'[youtube]' . $mtch[1] . '[/youtube]',$s);
1370                         elseif(stristr($mtch[1],'vimeo'))
1371                                 $s = str_replace($mtch[0],'[vimeo]' . $mtch[1] . '[/vimeo]',$s);
1372                 }
1373         }
1374         return $s;      
1375 }
1376
1377 function html2bb_video($s) {
1378
1379         $s = preg_replace('#<object[^>]+>(.*?)https?://www.youtube.com/((?:v|cp)/[A-Za-z0-9\-_=]+)(.*?)</object>#ism',
1380                         '[youtube]$2[/youtube]', $s);
1381
1382         $s = preg_replace('#<iframe[^>](.*?)https?://www.youtube.com/embed/([A-Za-z0-9\-_=]+)(.*?)</iframe>#ism',
1383                         '[youtube]$2[/youtube]', $s);
1384
1385         $s = preg_replace('#<iframe[^>](.*?)https?://player.vimeo.com/video/([0-9]+)(.*?)</iframe>#ism',
1386                         '[vimeo]$2[/vimeo]', $s);
1387
1388         return $s;
1389 }
1390
1391 /**
1392  * apply xmlify() to all values of array $val, recursively
1393  */
1394 function array_xmlify($val){
1395         if (is_bool($val)) return $val?"true":"false";
1396         if (is_array($val)) return array_map('array_xmlify', $val);
1397         return xmlify((string) $val);
1398 }
1399
1400
1401 function reltoabs($text, $base)
1402 {
1403   if (empty($base))
1404     return $text;
1405
1406   $base = rtrim($base,'/');
1407
1408   $base2 = $base . "/";
1409         
1410   // Replace links
1411   $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
1412   $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
1413   $text = preg_replace($pattern, $replace, $text);
1414
1415   $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
1416   $replace = "<a\${1} href=\"" . $base . "\${2}\"";
1417   $text = preg_replace($pattern, $replace, $text);
1418
1419   // Replace images
1420   $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
1421   $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
1422   $text = preg_replace($pattern, $replace, $text); 
1423
1424   $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
1425   $replace = "<img\${1} src=\"" . $base . "\${2}\"";
1426   $text = preg_replace($pattern, $replace, $text); 
1427
1428
1429   // Done
1430   return $text;
1431 }
1432
1433 function item_post_type($item) {
1434         if(intval($item['event-id']))
1435                 return t('event');
1436         if(strlen($item['resource-id']))
1437                 return t('photo');
1438         if(strlen($item['verb']) && $item['verb'] !== ACTIVITY_POST)
1439                 return t('activity');
1440         if($item['id'] != $item['parent'])
1441                 return t('comment');
1442         return t('post');
1443 }
1444
1445 // post categories and "save to file" use the same item.file table for storage.
1446 // We will differentiate the different uses by wrapping categories in angle brackets
1447 // and save to file categories in square brackets.
1448 // To do this we need to escape these characters if they appear in our tag. 
1449
1450 function file_tag_encode($s) {
1451         return str_replace(array('<','>','[',']'),array('%3c','%3e','%5b','%5d'),$s);
1452 }
1453
1454 function file_tag_decode($s) {
1455         return str_replace(array('%3c','%3e','%5b','%5d'),array('<','>','[',']'),$s);
1456 }
1457
1458 function file_tag_file_query($table,$s,$type = 'file') {
1459
1460         if($type == 'file')
1461                 $str = preg_quote( '[' . str_replace('%','%%',file_tag_encode($s)) . ']' );
1462         else
1463                 $str = preg_quote( '<' . str_replace('%','%%',file_tag_encode($s)) . '>' );
1464         return " AND " . (($table) ? dbesc($table) . '.' : '') . "file regexp '" . dbesc($str) . "' ";
1465 }
1466
1467 // ex. given music,video return <music><video> or [music][video]
1468 function file_tag_list_to_file($list,$type = 'file') {
1469         $tag_list = '';
1470         if(strlen($list)) {
1471                 $list_array = explode(",",$list);
1472                 if($type == 'file') {
1473                         $lbracket = '[';
1474                         $rbracket = ']';
1475                 }
1476                 else {
1477                         $lbracket = '<';
1478                         $rbracket = '>';
1479                 }
1480
1481                 foreach($list_array as $item) {
1482                   if(strlen($item)) {
1483                                 $tag_list .= $lbracket . file_tag_encode(trim($item))  . $rbracket;
1484                         }
1485                 }
1486         }
1487         return $tag_list;
1488 }
1489
1490 // ex. given <music><video>[friends], return music,video or friends
1491 function file_tag_file_to_list($file,$type = 'file') {
1492         $matches = false;
1493         $list = '';
1494         if($type == 'file') {
1495                 $cnt = preg_match_all('/\[(.*?)\]/',$file,$matches,PREG_SET_ORDER);
1496         }
1497         else {
1498                 $cnt = preg_match_all('/<(.*?)>/',$file,$matches,PREG_SET_ORDER);
1499         }
1500         if($cnt) {
1501                 foreach($matches as $mtch) {
1502                         if(strlen($list))
1503                                 $list .= ',';
1504                         $list .= file_tag_decode($mtch[1]);
1505                 }
1506         }
1507
1508         return $list;
1509 }
1510
1511 function file_tag_update_pconfig($uid,$file_old,$file_new,$type = 'file') {
1512         // $file_old - categories previously associated with an item
1513         // $file_new - new list of categories for an item
1514
1515         if(! intval($uid))
1516                 return false;
1517
1518         if($file_old == $file_new)
1519                 return true;
1520
1521         $saved = get_pconfig($uid,'system','filetags');
1522         if(strlen($saved)) {
1523                 if($type == 'file') {
1524                         $lbracket = '[';
1525                         $rbracket = ']';
1526                 }
1527                 else {
1528                         $lbracket = '<';
1529                         $rbracket = '>';
1530                 }
1531
1532                 $filetags_updated = $saved;
1533
1534                 // check for new tags to be added as filetags in pconfig
1535                 $new_tags = array();
1536                 $check_new_tags = explode(",",file_tag_file_to_list($file_new,$type));
1537
1538                 foreach($check_new_tags as $tag) {
1539                         if(! stristr($saved,$lbracket . file_tag_encode($tag) . $rbracket))
1540                                 $new_tags[] = $tag;
1541                 }
1542
1543                 $filetags_updated .= file_tag_list_to_file(implode(",",$new_tags),$type);
1544
1545                 // check for deleted tags to be removed from filetags in pconfig
1546                 $deleted_tags = array();
1547                 $check_deleted_tags = explode(",",file_tag_file_to_list($file_old,$type));
1548
1549                 foreach($check_deleted_tags as $tag) {
1550                         if(! stristr($file_new,$lbracket . file_tag_encode($tag) . $rbracket))
1551                                 $deleted_tags[] = $tag;
1552                 }
1553
1554                 foreach($deleted_tags as $key => $tag) {
1555                         $r = q("select file from item where uid = %d " . file_tag_file_query('item',$tag,$type),
1556                                 intval($uid)
1557                         );
1558
1559                         if(count($r)) {
1560                                 unset($deleted_tags[$key]);
1561                         }
1562                         else {
1563                                 $filetags_updated = str_replace($lbracket . file_tag_encode($tag) . $rbracket,'',$filetags_updated);
1564                         }
1565                 }
1566
1567                 if($saved != $filetags_updated) {
1568                         set_pconfig($uid,'system','filetags', $filetags_updated);
1569                 }
1570                 return true;
1571         }
1572         else
1573                 if(strlen($file_new)) {
1574                         set_pconfig($uid,'system','filetags', $file_new);
1575                 }
1576                 return true;
1577 }
1578
1579 function file_tag_save_file($uid,$item,$file) {
1580         $result = false;
1581         if(! intval($uid))
1582                 return false;
1583         $r = q("select file from item where id = %d and uid = %d limit 1",
1584                 intval($item),
1585                 intval($uid)
1586         );
1587         if(count($r)) {
1588                 if(! stristr($r[0]['file'],'[' . file_tag_encode($file) . ']'))
1589                         q("update item set file = '%s' where id = %d and uid = %d limit 1",
1590                                 dbesc($r[0]['file'] . '[' . file_tag_encode($file) . ']'),
1591                                 intval($item),
1592                                 intval($uid)
1593                         );
1594                 $saved = get_pconfig($uid,'system','filetags');
1595                 if((! strlen($saved)) || (! stristr($saved,'[' . file_tag_encode($file) . ']')))
1596                         set_pconfig($uid,'system','filetags',$saved . '[' . file_tag_encode($file) . ']');
1597                 info( t('Item filed') );
1598         }
1599         return true;
1600 }
1601
1602 function file_tag_unsave_file($uid,$item,$file,$cat = false) {
1603         $result = false;
1604         if(! intval($uid))
1605                 return false;
1606
1607         if($cat == true)
1608                 $pattern = '<' . file_tag_encode($file) . '>' ;
1609         else
1610                 $pattern = '[' . file_tag_encode($file) . ']' ;
1611
1612
1613         $r = q("select file from item where id = %d and uid = %d limit 1",
1614                 intval($item),
1615                 intval($uid)
1616         );
1617         if(! count($r))
1618                 return false;
1619
1620         q("update item set file = '%s' where id = %d and uid = %d limit 1",
1621                 dbesc(str_replace($pattern,'',$r[0]['file'])),
1622                 intval($item),
1623                 intval($uid)
1624         );
1625
1626         $r = q("select file from item where uid = %d and deleted = 0 " . file_tag_file_query('item',$file,(($cat) ? 'category' : 'file')),
1627                 intval($uid)
1628         );
1629
1630         if(! count($r)) {
1631                 $saved = get_pconfig($uid,'system','filetags');
1632                 set_pconfig($uid,'system','filetags',str_replace($pattern,'',$saved));
1633
1634         }
1635         return true;
1636 }
1637
1638 function normalise_openid($s) {
1639         return trim(str_replace(array('http://','https://'),array('',''),$s),'/');
1640 }
1641
1642
1643 function undo_post_tagging($s) {
1644         $matches = null;
1645         $cnt = preg_match_all('/([@#])\[url=(.*?)\](.*?)\[\/url\]/ism',$s,$matches,PREG_SET_ORDER);
1646         if($cnt) {
1647                 foreach($matches as $mtch) {
1648                         $s = str_replace($mtch[0], $mtch[1] . $mtch[3],$s);
1649                 }
1650         }
1651         return $s;
1652 }
1653
1654 function fix_mce_lf($s) {
1655         $s = str_replace("\r\n","\n",$s);
1656 //      $s = str_replace("\n\n","\n",$s);
1657         return $s;
1658 }
1659
1660
1661 function protect_sprintf($s) {
1662         return(str_replace('%','%%',$s));
1663 }
1664
1665
1666 function is_a_date_arg($s) {
1667         $i = intval($s);
1668         if($i > 1900) {
1669                 $y = date('Y');
1670                 if($i <= $y+1 && strpos($s,'-') == 4) {
1671                         $m = intval(substr($s,5));
1672                         if($m > 0 && $m <= 12)
1673                                 return true;
1674                 }
1675         }
1676         return false;
1677 }