3 * @file include/text.php
7 use Friendica\Content\ContactSelector;
8 use Friendica\Content\Feature;
9 use Friendica\Content\Smilies;
10 use Friendica\Content\Text\BBCode;
11 use Friendica\Core\Addon;
12 use Friendica\Core\Config;
13 use Friendica\Core\L10n;
14 use Friendica\Core\PConfig;
15 use Friendica\Core\System;
16 use Friendica\Database\DBM;
17 use Friendica\Model\Item;
18 use Friendica\Model\Profile;
19 use Friendica\Render\FriendicaSmarty;
20 use Friendica\Util\DateTimeFormat;
21 use Friendica\Util\Map;
23 require_once "mod/proxy.php";
24 require_once "include/event.php";
25 require_once "include/conversation.php";
28 * This is our template processor
30 * @param string|FriendicaSmarty $s the string requiring macro substitution,
31 * or an instance of FriendicaSmarty
32 * @param array $r key value pairs (search => replace)
33 * @return string substituted string
35 function replace_macros($s, $r) {
37 $stamp1 = microtime(true);
41 // pass $baseurl to all templates
42 $r['$baseurl'] = System::baseUrl();
44 $t = $a->template_engine();
46 $output = $t->replaceMacros($s, $r);
47 } catch (Exception $e) {
48 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
52 $a->save_timestamp($stamp1, "rendering");
58 * @brief Generates a pseudo-random string of hexadecimal characters
63 function random_string($size = 64)
65 $byte_size = ceil($size / 2);
67 $bytes = random_bytes($byte_size);
69 $return = substr(bin2hex($bytes), 0, $size);
75 * This is our primary input filter.
77 * The high bit hack only involved some old IE browser, forget which (IE5/Mac?)
78 * that had an XSS attack vector due to stripping the high-bit on an 8-bit character
79 * after cleansing, and angle chars with the high bit set could get through as markup.
81 * This is now disabled because it was interfering with some legitimate unicode sequences
82 * and hopefully there aren't a lot of those browsers left.
84 * Use this on any text input where angle chars are not valid or permitted
85 * They will be replaced with safer brackets. This may be filtered further
86 * if these are not allowed either.
88 * @param string $string Input string
89 * @return string Filtered string
91 function notags($string) {
92 return str_replace(["<", ">"], ['[', ']'], $string);
94 // High-bit filter no longer used
95 // return str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string);
100 * use this on "body" or "content" input where angle chars shouldn't be removed,
101 * and allow them to be safely displayed.
102 * @param string $string
105 function escape_tags($string) {
106 return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false);
111 * generate a string that's random, but usually pronounceable.
112 * used to generate initial passwords
116 function autoname($len) {
122 $vowels = ['a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u'];
123 if (mt_rand(0, 5) == 4) {
142 's','sc','sh','sm','sp','st',
150 $midcons = ['ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
151 'nd','ng','nk','nt','rn','rp','rt'];
153 $noend = ['bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
154 'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh'];
156 $start = mt_rand(0,2);
165 for ($x = 0; $x < $len; $x ++) {
166 $r = mt_rand(0,count($table) - 1);
169 if ($table == $vowels) {
170 $table = array_merge($cons,$midcons);
177 $word = substr($word,0,$len);
179 foreach ($noend as $noe) {
180 if ((strlen($word) > 2) && (substr($word, -2) == $noe)) {
181 $word = substr($word, 0, -1);
185 if (substr($word, -1) == 'q') {
186 $word = substr($word, 0, -1);
193 * escape text ($str) for XML transport
195 * @return string Escaped text.
197 function xmlify($str) {
198 /// @TODO deprecated code found?
201 $len = mb_strlen($str);
202 for ($x = 0; $x < $len; $x ++) {
203 $char = mb_substr($str,$x,1);
233 $buffer = mb_ereg_replace("&", "&", $str);
234 $buffer = mb_ereg_replace("'", "'", $buffer);
235 $buffer = mb_ereg_replace('"', """, $buffer);
236 $buffer = mb_ereg_replace("<", "<", $buffer);
237 $buffer = mb_ereg_replace(">", ">", $buffer);
239 $buffer = htmlspecialchars($str, ENT_QUOTES, "UTF-8");
240 $buffer = trim($buffer);
248 * @param string $s xml escaped text
249 * @return string unescaped text
251 function unxmlify($s) {
252 /// @TODO deprecated code found?
253 // $ret = str_replace('&','&', $s);
254 // $ret = str_replace(array('<','>','"','''),array('<','>','"',"'"),$ret);
255 /*$ret = mb_ereg_replace('&', '&', $s);
256 $ret = mb_ereg_replace(''', "'", $ret);
257 $ret = mb_ereg_replace('"', '"', $ret);
258 $ret = mb_ereg_replace('<', "<", $ret);
259 $ret = mb_ereg_replace('>', ">", $ret);
261 $ret = htmlspecialchars_decode($s, ENT_QUOTES);
267 * @brief Paginator function. Pushes relevant links in a pager array structure.
269 * Links are generated depending on the current page and the total number of items.
270 * Inactive links (like "first" and "prev" on page 1) are given the "disabled" class.
271 * Current page link is given the "active" CSS class
273 * @param App $a App instance
274 * @param int $count [optional] item count (used with minimal pager)
275 * @return Array data for pagination template
277 function paginate_data(App $a, $count = null) {
278 $stripped = preg_replace('/([&?]page=[0-9]*)/', '', $a->query_string);
280 $stripped = str_replace('q=', '', $stripped);
281 $stripped = trim($stripped, '/');
282 $pagenum = $a->pager['page'];
284 if (($a->page_offset != '') && !preg_match('/[?&].offset=/', $stripped)) {
285 $stripped .= '&offset=' . urlencode($a->page_offset);
291 function _l(&$d, $name, $url, $text, $class = '') {
292 if (strpos($url, '?') === false && ($pos = strpos($url, '&')) !== false) {
293 $url = substr($url, 0, $pos) . '?' . substr($url, $pos + 1);
296 $d[$name] = ['url' => $url, 'text' => $text, 'class' => $class];
299 if (!is_null($count)) {
300 // minimal pager (newer / older)
301 $data['class'] = 'pager';
302 _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('newer'), 'previous' . ($a->pager['page'] == 1 ? ' disabled' : ''));
303 _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('older'), 'next' . ($count <= 0 ? ' disabled' : ''));
305 // full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
306 $data['class'] = 'pagination';
307 if ($a->pager['total'] > $a->pager['itemspage']) {
308 _l($data, 'first', $url . '&page=1', L10n::t('first'), $a->pager['page'] == 1 ? 'disabled' : '');
309 _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('prev'), $a->pager['page'] == 1 ? 'disabled' : '');
311 $numpages = $a->pager['total'] / $a->pager['itemspage'];
314 $numstop = $numpages;
316 // Limit the number of displayed page number buttons.
318 $numstart = (($pagenum > 4) ? ($pagenum - 4) : 1);
319 $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 8));
324 for ($i = $numstart; $i <= $numstop; $i++) {
325 if ($i == $a->pager['page']) {
326 _l($pages, $i, '#', $i, 'current active');
328 _l($pages, $i, $url . '&page='. $i, $i, 'n');
332 if (($a->pager['total'] % $a->pager['itemspage']) != 0) {
333 if ($i == $a->pager['page']) {
334 _l($pages, $i, '#', $i, 'current active');
336 _l($pages, $i, $url . '&page=' . $i, $i, 'n');
340 $data['pages'] = $pages;
342 $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
343 _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('next'), $a->pager['page'] == $lastpage ? 'disabled' : '');
344 _l($data, 'last', $url . '&page=' . $lastpage, L10n::t('last'), $a->pager['page'] == $lastpage ? 'disabled' : '');
353 * Automatic pagination.
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.
364 * @param App $a App instance
365 * @return string html for pagination #FIXME remove html
367 function paginate(App $a) {
369 $data = paginate_data($a);
370 $tpl = get_markup_template("paginate.tpl");
371 return replace_macros($tpl, ["pager" => $data]);
378 * @param App $a App instance
380 * @return string html for pagination #FIXME remove html
382 function alt_pager(App $a, $i) {
384 $data = paginate_data($a, $i);
385 $tpl = get_markup_template("paginate.tpl");
386 return replace_macros($tpl, ['pager' => $data]);
392 * Loader for infinite scrolling
393 * @return string html for loader
395 function scroll_loader() {
396 $tpl = get_markup_template("scroll_loader.tpl");
397 return replace_macros($tpl, [
398 'wait' => L10n::t('Loading more entries...'),
399 'end' => L10n::t('The end')
405 * Turn user/group ACLs stored as angle bracketed text into arrays
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);
416 $t = str_replace('<', '', $s);
417 $a = explode('>', $t);
418 foreach ($a as $aa) {
420 $ret[] = intval($aa);
429 * Wrap ACL elements in angle brackets for storage
430 * @param string $item
432 function sanitise_acl(&$item) {
434 $item = '<' . intval(notags(trim($item))) . '>';
442 * Convert an ACL array to a storable string
444 * Normally ACL permissions will be an array.
445 * We'll also allow a comma-separated string.
447 * @param string|array $p
450 function perms2str($p) {
455 $tmp = explode(',',$p);
458 if (is_array($tmp)) {
459 array_walk($tmp, 'sanitise_acl');
460 $ret = implode('', $tmp);
467 * generate a guaranteed unique (for this domain) item ID for ATOM
468 * safe from birthday paradox
470 * @param string $hostname
474 function item_new_uri($hostname, $uid, $guid = "") {
478 $hash = get_guid(32);
484 $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
486 $dups = dba::exists('item', ['uri' => $uri]);
487 } while ($dups == true);
494 * Generate a guaranteed unique photo ID.
495 * safe from birthday paradox
499 function photo_new_resource() {
503 $resource = hash('md5',uniqid(mt_rand(),true));
504 $r = q("SELECT `id` FROM `photo` WHERE `resource-id` = '%s' LIMIT 1",
508 if (DBM::is_result($r)) {
511 } while ($found == true);
519 * wrapper to load a view template, checking for alternate
520 * languages before falling back to the default
522 * @global string $lang
524 * @param string $s view name
527 function load_view_file($s) {
529 if (! isset($lang)) {
534 if (file_exists("$d/$lang/$b")) {
535 $stamp1 = microtime(true);
536 $content = file_get_contents("$d/$lang/$b");
537 $a->save_timestamp($stamp1, "file");
541 $theme = current_theme();
543 if (file_exists("$d/theme/$theme/$b")) {
544 $stamp1 = microtime(true);
545 $content = file_get_contents("$d/theme/$theme/$b");
546 $a->save_timestamp($stamp1, "file");
550 $stamp1 = microtime(true);
551 $content = file_get_contents($s);
552 $a->save_timestamp($stamp1, "file");
558 * load a view template, checking for alternate
559 * languages before falling back to the default
561 * @global string $lang
562 * @param string $s view path
565 function get_intltext_template($s) {
570 if ($a->theme['template_engine'] === 'smarty3') {
571 $engine = "/smarty3";
574 if (! isset($lang)) {
578 if (file_exists("view/lang/$lang$engine/$s")) {
579 $stamp1 = microtime(true);
580 $content = file_get_contents("view/lang/$lang$engine/$s");
581 $a->save_timestamp($stamp1, "file");
583 } elseif (file_exists("view/lang/en$engine/$s")) {
584 $stamp1 = microtime(true);
585 $content = file_get_contents("view/lang/en$engine/$s");
586 $a->save_timestamp($stamp1, "file");
589 $stamp1 = microtime(true);
590 $content = file_get_contents("view$engine/$s");
591 $a->save_timestamp($stamp1, "file");
601 * @param string $root
604 function get_markup_template($s, $root = '') {
605 $stamp1 = microtime(true);
608 $t = $a->template_engine();
610 $template = $t->getTemplateFile($s, $root);
611 } catch (Exception $e) {
612 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
616 $a->save_timestamp($stamp1, "file");
622 * for html,xml parsing - let's say you've got
623 * an attribute foobar="class1 class2 class3"
624 * and you want to find out if it contains 'class3'.
625 * you can't use a normal sub string search because you
626 * might match 'notclass3' and a regex to do the job is
627 * possible but a bit complicated.
628 * pass the attribute string as $attr and the attribute you
629 * are looking for as $s - returns true if found, otherwise false
631 * @param string $attr attribute value
632 * @param string $s string to search
633 * @return boolean True if found, False otherwise
635 function attribute_contains($attr, $s) {
636 $a = explode(' ', $attr);
637 return (count($a) && in_array($s,$a));
641 /* setup int->string log level map */
645 * @brief Logs the given message at the given log level
648 * LOGGER_NORMAL (default)
655 * @global array $LOGGER_LEVELS
659 function logger($msg, $level = 0) {
661 global $LOGGER_LEVELS;
663 // turn off logger in install mode
665 $a->module == 'install'
671 $debugging = Config::get('system','debugging');
672 $logfile = Config::get('system','logfile');
673 $loglevel = intval(Config::get('system','loglevel'));
678 || $level > $loglevel
683 if (count($LOGGER_LEVELS) == 0) {
684 foreach (get_defined_constants() as $k => $v) {
685 if (substr($k, 0, 7) == "LOGGER_") {
686 $LOGGER_LEVELS[$v] = substr($k, 7, 7);
691 $process_id = session_id();
693 if ($process_id == '') {
694 $process_id = get_app()->process_id;
697 $callers = debug_backtrace();
698 $logline = sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
699 DateTimeFormat::utcNow(DateTimeFormat::ATOM),
701 $LOGGER_LEVELS[$level],
702 basename($callers[0]['file']),
704 $callers[1]['function'],
708 $stamp1 = microtime(true);
709 @file_put_contents($logfile, $logline, FILE_APPEND);
710 $a->save_timestamp($stamp1, "file");
714 * @brief An alternative logger for development.
715 * Works largely as logger() but allows developers
716 * to isolate particular elements they are targetting
717 * personally without background noise
720 * LOGGER_NORMAL (default)
727 * @global array $LOGGER_LEVELS
732 function dlogger($msg, $level = 0) {
735 // turn off logger in install mode
737 $a->module == 'install'
743 $logfile = Config::get('system', 'dlogfile');
748 $dlogip = Config::get('system', 'dlogip');
749 if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip) {
753 if (count($LOGGER_LEVELS) == 0) {
754 foreach (get_defined_constants() as $k => $v) {
755 if (substr($k, 0, 7) == "LOGGER_") {
756 $LOGGER_LEVELS[$v] = substr($k, 7, 7);
761 $process_id = session_id();
763 if ($process_id == '') {
764 $process_id = get_app()->process_id;
767 $callers = debug_backtrace();
768 $logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n",
769 DateTimeFormat::utcNow(),
771 basename($callers[0]['file']),
773 $callers[1]['function'],
777 $stamp1 = microtime(true);
778 @file_put_contents($logfile, $logline, FILE_APPEND);
779 $a->save_timestamp($stamp1, "file");
784 * Compare activity uri. Knows about activity namespace.
786 * @param string $haystack
787 * @param string $needle
790 function activity_match($haystack,$needle) {
791 return (($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle, NAMESPACE_ACTIVITY_SCHEMA)));
796 * @brief Pull out all #hashtags and @person tags from $string.
798 * We also get @person@domain.com - which would make
799 * the regex quite complicated as tags can also
800 * end a sentence. So we'll run through our results
801 * and strip the period from any tags which end with one.
802 * Returns array of tags found, or empty array.
804 * @param string $string Post content
805 * @return array List of tag and person names
807 function get_tags($string) {
810 // Convert hashtag links to hashtags
811 $string = preg_replace('/#\[url\=([^\[\]]*)\](.*?)\[\/url\]/ism', '#$2', $string);
813 // ignore anything in a code block
814 $string = preg_replace('/\[code\](.*?)\[\/code\]/sm', '', $string);
816 // Force line feeds at bbtags
817 $string = str_replace(['[', ']'], ["\n[", "]\n"], $string);
819 // ignore anything in a bbtag
820 $string = preg_replace('/\[(.*?)\]/sm', '', $string);
822 // Match full names against @tags including the space between first and last
823 // We will look these up afterward to see if they are full names or not recognisable.
825 if (preg_match_all('/(@[^ \x0D\x0A,:?]+ [^ \x0D\x0A@,:?]+)([ \x0D\x0A@,:?]|$)/', $string, $matches)) {
826 foreach ($matches[1] as $match) {
827 if (strstr($match, ']')) {
828 // we might be inside a bbcode color tag - leave it alone
831 if (substr($match, -1, 1) === '.') {
832 $ret[] = substr($match, 0, -1);
839 // Otherwise pull out single word tags. These can be @nickname, @first_last
842 if (preg_match_all('/([!#@][^\^ \x0D\x0A,;:?]+)([ \x0D\x0A,;:?]|$)/', $string, $matches)) {
843 foreach ($matches[1] as $match) {
844 if (strstr($match, ']')) {
845 // we might be inside a bbcode color tag - leave it alone
848 if (substr($match, -1, 1) === '.') {
849 $match = substr($match,0,-1);
851 // ignore strictly numeric tags like #1
852 if ((strpos($match, '#') === 0) && ctype_digit(substr($match, 1))) {
855 // try not to catch url fragments
856 if (strpos($string, $match) && preg_match('/[a-zA-z0-9\/]/', substr($string, strpos($string, $match) - 1, 1))) {
867 * quick and dirty quoted_printable encoding
873 return str_replace("%", "=", rawurlencode($s));
878 * Get html for contact block.
880 * @template contact_block.tpl
881 * @hook contact_block_end (contacts=>array, output=>string)
884 function contact_block() {
888 $shown = PConfig::get($a->profile['uid'], 'system', 'display_friend_count', 24);
893 if (!is_array($a->profile) || $a->profile['hide-friends']) {
896 $r = q("SELECT COUNT(*) AS `total` FROM `contact`
897 WHERE `uid` = %d AND NOT `self` AND NOT `blocked`
898 AND NOT `pending` AND NOT `hidden` AND NOT `archive`
899 AND `network` IN ('%s', '%s', '%s')",
900 intval($a->profile['uid']),
902 dbesc(NETWORK_OSTATUS),
903 dbesc(NETWORK_DIASPORA)
905 if (DBM::is_result($r)) {
906 $total = intval($r[0]['total']);
909 $contacts = L10n::t('No contacts');
912 // Splitting the query in two parts makes it much faster
913 $r = q("SELECT `id` FROM `contact`
914 WHERE `uid` = %d AND NOT `self` AND NOT `blocked`
915 AND NOT `pending` AND NOT `hidden` AND NOT `archive`
916 AND `network` IN ('%s', '%s', '%s')
917 ORDER BY RAND() LIMIT %d",
918 intval($a->profile['uid']),
920 dbesc(NETWORK_OSTATUS),
921 dbesc(NETWORK_DIASPORA),
924 if (DBM::is_result($r)) {
926 foreach ($r AS $contact) {
927 $contacts[] = $contact["id"];
929 $r = q("SELECT `id`, `uid`, `addr`, `url`, `name`, `thumb`, `network` FROM `contact` WHERE `id` IN (%s)",
930 dbesc(implode(",", $contacts)));
932 if (DBM::is_result($r)) {
933 $contacts = L10n::tt('%d Contact', '%d Contacts', $total);
935 foreach ($r as $rr) {
936 $micropro[] = micropro($rr, true, 'mpfriend');
942 $tpl = get_markup_template('contact_block.tpl');
943 $o = replace_macros($tpl, [
944 '$contacts' => $contacts,
945 '$nickname' => $a->profile['nickname'],
946 '$viewcontacts' => L10n::t('View Contacts'),
947 '$micropro' => $micropro,
950 $arr = ['contacts' => $r, 'output' => $o];
952 Addon::callHooks('contact_block_end', $arr);
959 * @brief Format contacts as picture links or as texxt links
961 * @param array $contact Array with contacts which contains an array with
962 * int 'id' => The ID of the contact
963 * int 'uid' => The user ID of the user who owns this data
964 * string 'name' => The name of the contact
965 * string 'url' => The url to the profile page of the contact
966 * string 'addr' => The webbie of the contact (e.g.) username@friendica.com
967 * string 'network' => The network to which the contact belongs to
968 * string 'thumb' => The contact picture
969 * string 'click' => js code which is performed when clicking on the contact
970 * @param boolean $redirect If true try to use the redir url if it's possible
971 * @param string $class CSS class for the
972 * @param boolean $textmode If true display the contacts as text links
973 * if false display the contacts as picture links
975 * @return string Formatted html
977 function micropro($contact, $redirect = false, $class = '', $textmode = false) {
979 // Use the contact URL if no address is available
980 if (!x($contact, "addr")) {
981 $contact["addr"] = $contact["url"];
984 $url = $contact['url'];
989 $redirect_url = 'redir/' . $contact['id'];
990 if (local_user() && ($contact['uid'] == local_user()) && ($contact['network'] === NETWORK_DFRN)) {
992 $url = $redirect_url;
993 $sparkle = ' sparkle';
995 $url = Profile::zrl($url);
999 // If there is some js available we don't need the url
1000 if (x($contact, 'click')) {
1004 return replace_macros(get_markup_template(($textmode)?'micropro_txt.tpl':'micropro_img.tpl'),[
1005 '$click' => defaults($contact, 'click', ''),
1008 '$photo' => proxy_url($contact['thumb'], false, PROXY_SIZE_THUMB),
1009 '$name' => $contact['name'],
1010 'title' => $contact['name'] . ' [' . $contact['addr'] . ']',
1011 '$parkle' => $sparkle,
1020 * @param string $s Search query.
1021 * @param string $id HTML id
1022 * @param string $url Search url.
1023 * @param bool $save Show save search button.
1024 * @param bool $aside Display the search widgit aside.
1026 * @return string Formatted HTML.
1028 function search($s, $id = 'search-box', $url = 'search', $save = false, $aside = true)
1032 if (strpos($s, '#') === 0) {
1035 $save_label = $mode === 'text' ? L10n::t('Save') : L10n::t('Follow');
1038 '$s' => htmlspecialchars($s),
1040 '$action_url' => $url,
1041 '$search_label' => L10n::t('Search'),
1042 '$save_label' => $save_label,
1043 '$savedsearch' => Feature::isEnabled(local_user(),'savedsearch'),
1044 '$search_hint' => L10n::t('@name, !forum, #tags, content'),
1049 $values['$searchoption'] = [
1050 L10n::t("Full Text"),
1052 L10n::t("Contacts")];
1054 if (Config::get('system','poco_local_search')) {
1055 $values['$searchoption'][] = L10n::t("Forums");
1059 return replace_macros(get_markup_template('searchbox.tpl'), $values);
1063 * @brief Check for a valid email string
1065 * @param string $email_address
1068 function valid_email($email_address)
1070 return preg_match('/^[_a-zA-Z0-9\-\+]+(\.[_a-zA-Z0-9\-\+]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/', $email_address);
1075 * Replace naked text hyperlink with HTML formatted hyperlink
1079 function linkify($s) {
1080 $s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="_blank">$1</a>', $s);
1081 $s = preg_replace("/\<(.*?)(src|href)=(.*?)\&\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
1089 * @return array index is present tense verb
1090 value is array containing past tense verb, translation of present, translation of past
1091 * @hook poke_verbs pokes array
1093 function get_poke_verbs() {
1095 // index is present tense verb
1096 // value is array containing past tense verb, translation of present, translation of past
1099 'poke' => ['poked', L10n::t('poke'), L10n::t('poked')],
1100 'ping' => ['pinged', L10n::t('ping'), L10n::t('pinged')],
1101 'prod' => ['prodded', L10n::t('prod'), L10n::t('prodded')],
1102 'slap' => ['slapped', L10n::t('slap'), L10n::t('slapped')],
1103 'finger' => ['fingered', L10n::t('finger'), L10n::t('fingered')],
1104 'rebuff' => ['rebuffed', L10n::t('rebuff'), L10n::t('rebuffed')],
1106 Addon::callHooks('poke_verbs', $arr);
1111 * @brief Translate days and months names.
1113 * @param string $s String with day or month name.
1114 * @return string Translated string.
1116 function day_translate($s) {
1117 $ret = str_replace(['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
1118 [L10n::t('Monday'), L10n::t('Tuesday'), L10n::t('Wednesday'), L10n::t('Thursday'), L10n::t('Friday'), L10n::t('Saturday'), L10n::t('Sunday')],
1121 $ret = str_replace(['January','February','March','April','May','June','July','August','September','October','November','December'],
1122 [L10n::t('January'), L10n::t('February'), L10n::t('March'), L10n::t('April'), L10n::t('May'), L10n::t('June'), L10n::t('July'), L10n::t('August'), L10n::t('September'), L10n::t('October'), L10n::t('November'), L10n::t('December')],
1129 * @brief Translate short days and months names.
1131 * @param string $s String with short day or month name.
1132 * @return string Translated string.
1134 function day_short_translate($s) {
1135 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
1136 [L10n::t('Mon'), L10n::t('Tue'), L10n::t('Wed'), L10n::t('Thu'), L10n::t('Fri'), L10n::t('Sat'), L10n::t('Sun')],
1138 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov','Dec'],
1139 [L10n::t('Jan'), L10n::t('Feb'), L10n::t('Mar'), L10n::t('Apr'), L10n::t('May'), ('Jun'), L10n::t('Jul'), L10n::t('Aug'), L10n::t('Sep'), L10n::t('Oct'), L10n::t('Nov'), L10n::t('Dec')],
1148 * @param string $url
1151 function normalise_link($url) {
1152 $ret = str_replace(['https:', '//www.'], ['http:', '//'], $url);
1153 return rtrim($ret,'/');
1158 * Compare two URLs to see if they are the same, but ignore
1159 * slight but hopefully insignificant differences such as if one
1160 * is https and the other isn't, or if one is www.something and
1161 * the other isn't - and also ignore case differences.
1163 * @param string $a first url
1164 * @param string $b second url
1165 * @return boolean True if the URLs match, otherwise False
1168 function link_compare($a, $b) {
1169 return (strcasecmp(normalise_link($a), normalise_link($b)) === 0);
1174 * @brief Find any non-embedded images in private items and add redir links to them
1177 * @param array &$item The field array of an item row
1179 function redir_private_images($a, &$item)
1182 $cnt = preg_match_all('|\[img\](http[^\[]*?/photo/[a-fA-F0-9]+?(-[0-9]\.[\w]+?)?)\[\/img\]|', $item['body'], $matches, PREG_SET_ORDER);
1184 foreach ($matches as $mtch) {
1185 if (strpos($mtch[1], '/redir') !== false) {
1189 if ((local_user() == $item['uid']) && ($item['private'] != 0) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN)) {
1190 $img_url = 'redir?f=1&quiet=1&url=' . urlencode($mtch[1]) . '&conurl=' . urlencode($item['author-link']);
1191 $item['body'] = str_replace($mtch[0], '[img]' . $img_url . '[/img]', $item['body']);
1197 function put_item_in_cache(&$item, $update = false)
1199 $rendered_hash = defaults($item, 'rendered-hash', '');
1201 if ($rendered_hash == ''
1202 || $item["rendered-html"] == ""
1203 || $rendered_hash != hash("md5", $item["body"])
1204 || Config::get("system", "ignore_cache")
1206 // The function "redir_private_images" changes the body.
1207 // I'm not sure if we should store it permanently, so we save the old value.
1208 $body = $item["body"];
1211 redir_private_images($a, $item);
1213 $item["rendered-html"] = prepare_text($item["body"]);
1214 $item["rendered-hash"] = hash("md5", $item["body"]);
1215 $item["body"] = $body;
1217 if ($update && ($item["id"] > 0)) {
1218 dba::update('item', ['rendered-html' => $item["rendered-html"], 'rendered-hash' => $item["rendered-hash"]],
1219 ['id' => $item["id"]], false);
1225 * @brief Given an item array, convert the body element from bbcode to html and add smilie icons.
1226 * If attach is true, also add icons for item attachments.
1228 * @param array $item
1229 * @param boolean $attach
1230 * @return string item body html
1231 * @hook prepare_body_init item array before any work
1232 * @hook prepare_body ('item'=>item array, 'html'=>body string) after first bbcode to html
1233 * @hook prepare_body_final ('item'=>item array, 'html'=>body string) after attach icons and blockquote special case handling (spoiler, author)
1235 function prepare_body(&$item, $attach = false, $preview = false) {
1238 Addon::callHooks('prepare_body_init', $item);
1240 $searchpath = System::baseUrl() . "/search?tag=";
1246 // In order to provide theme developers more possibilities, event items
1247 // are treated differently.
1248 if ($item['object-type'] === ACTIVITY_OBJ_EVENT && isset($item['event-id'])) {
1249 $ev = format_event_item($item);
1253 if (!Config::get('system','suppress_tags')) {
1254 $taglist = dba::p("SELECT `type`, `term`, `url` FROM `term` WHERE `otype` = ? AND `oid` = ? AND `type` IN (?, ?) ORDER BY `tid`",
1255 intval(TERM_OBJ_POST), intval($item['id']), intval(TERM_HASHTAG), intval(TERM_MENTION));
1257 while ($tag = dba::fetch($taglist)) {
1258 if ($tag["url"] == "") {
1259 $tag["url"] = $searchpath.strtolower($tag["term"]);
1262 $orig_tag = $tag["url"];
1264 $tag["url"] = best_link_url($item, $sp, $tag["url"]);
1266 if ($tag["type"] == TERM_HASHTAG) {
1267 if ($orig_tag != $tag["url"]) {
1268 $item['body'] = str_replace($orig_tag, $tag["url"], $item['body']);
1270 $hashtags[] = "#<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1272 } elseif ($tag["type"] == TERM_MENTION) {
1273 $mentions[] = "@<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1276 $tags[] = $prefix."<a href=\"".$tag["url"]."\" target=\"_blank\">".$tag["term"]."</a>";
1278 dba::close($taglist);
1281 $item['tags'] = $tags;
1282 $item['hashtags'] = $hashtags;
1283 $item['mentions'] = $mentions;
1285 // Update the cached values if there is no "zrl=..." on the links.
1286 $update = (!local_user() && !remote_user() && ($item["uid"] == 0));
1288 // Or update it if the current viewer is the intented viewer.
1289 if (($item["uid"] == local_user()) && ($item["uid"] != 0)) {
1293 put_item_in_cache($item, $update);
1294 $s = $item["rendered-html"];
1296 $prep_arr = ['item' => $item, 'html' => $s, 'preview' => $preview];
1297 Addon::callHooks('prepare_body', $prep_arr);
1298 $s = $prep_arr['html'];
1301 // Replace the blockquotes with quotes that are used in mails.
1302 $mailquote = '<blockquote type="cite" class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">';
1303 $s = str_replace(['<blockquote>', '<blockquote class="spoiler">', '<blockquote class="author">'], [$mailquote, $mailquote, $mailquote], $s);
1309 $arr = explode('[/attach],', $item['attach']);
1311 foreach ($arr as $r) {
1314 $cnt = preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|',$r ,$matches, PREG_SET_ORDER);
1316 foreach ($matches as $mtch) {
1319 if ((local_user() == $item['uid']) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN)) {
1320 $the_url = 'redir/' . $item['contact-id'] . '?f=1&url=' . $mtch[1];
1322 $the_url = $mtch[1];
1325 if (strpos($mime, 'video') !== false) {
1328 $a->page['htmlhead'] .= replace_macros(get_markup_template('videos_head.tpl'), [
1329 '$baseurl' => System::baseUrl(),
1331 $a->page['end'] .= replace_macros(get_markup_template('videos_end.tpl'), [
1332 '$baseurl' => System::baseUrl(),
1336 $id = end(explode('/', $the_url));
1337 $as .= replace_macros(get_markup_template('video_top.tpl'), [
1340 'title' => L10n::t('View Video'),
1347 $filetype = strtolower(substr($mime, 0, strpos($mime, '/')));
1349 $filesubtype = strtolower(substr($mime, strpos($mime, '/') + 1));
1350 $filesubtype = str_replace('.', '-', $filesubtype);
1353 $filesubtype = 'unkn';
1356 $title = ((strlen(trim($mtch[4]))) ? escape_tags(trim($mtch[4])) : escape_tags($mtch[1]));
1357 $title .= ' ' . $mtch[2] . ' ' . L10n::t('bytes');
1359 $icon = '<div class="attachtype icon s22 type-' . $filetype . ' subtype-' . $filesubtype . '"></div>';
1360 $as .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="_blank" >' . $icon . '</a>';
1366 $s .= '<div class="body-attach">'.$as.'<div class="clear"></div></div>';
1370 if (strpos($s, '<div class="map">') !== false && x($item, 'coord')) {
1371 $x = Map::byCoordinates(trim($item['coord']));
1373 $s = preg_replace('/\<div class\=\"map\"\>/', '$0' . $x, $s);
1378 // Look for spoiler.
1379 $spoilersearch = '<blockquote class="spoiler">';
1381 // Remove line breaks before the spoiler.
1382 while ((strpos($s, "\n" . $spoilersearch) !== false)) {
1383 $s = str_replace("\n" . $spoilersearch, $spoilersearch, $s);
1385 while ((strpos($s, "<br />" . $spoilersearch) !== false)) {
1386 $s = str_replace("<br />" . $spoilersearch, $spoilersearch, $s);
1389 while ((strpos($s, $spoilersearch) !== false)) {
1390 $pos = strpos($s, $spoilersearch);
1391 $rnd = random_string(8);
1392 $spoilerreplace = '<br /> <span id="spoiler-wrap-' . $rnd . '" class="spoiler-wrap fakelink" onclick="openClose(\'spoiler-' . $rnd . '\');">' . L10n::t('Click to open/close') . '</span>'.
1393 '<blockquote class="spoiler" id="spoiler-' . $rnd . '" style="display: none;">';
1394 $s = substr($s, 0, $pos) . $spoilerreplace . substr($s, $pos + strlen($spoilersearch));
1397 // Look for quote with author.
1398 $authorsearch = '<blockquote class="author">';
1400 while ((strpos($s, $authorsearch) !== false)) {
1401 $pos = strpos($s, $authorsearch);
1402 $rnd = random_string(8);
1403 $authorreplace = '<br /> <span id="author-wrap-' . $rnd . '" class="author-wrap fakelink" onclick="openClose(\'author-' . $rnd . '\');">' . L10n::t('Click to open/close') . '</span>'.
1404 '<blockquote class="author" id="author-' . $rnd . '" style="display: block;">';
1405 $s = substr($s, 0, $pos) . $authorreplace . substr($s, $pos + strlen($authorsearch));
1408 // Replace friendica image url size with theme preference.
1409 if (x($a->theme_info, 'item_image_size')){
1410 $ps = $a->theme_info['item_image_size'];
1411 $s = preg_replace('|(<img[^>]+src="[^"]+/photo/[0-9a-f]+)-[0-9]|', "$1-" . $ps, $s);
1414 $prep_arr = ['item' => $item, 'html' => $s];
1415 Addon::callHooks('prepare_body_final', $prep_arr);
1417 return $prep_arr['html'];
1421 * @brief Given a text string, convert from bbcode to html and add smilie icons.
1423 * @param string $text String with bbcode.
1424 * @return string Formattet HTML.
1426 function prepare_text($text) {
1427 if (stristr($text, '[nosmile]')) {
1428 $s = BBCode::convert($text);
1430 $s = Smilies::replace(BBCode::convert($text));
1437 * return array with details for categories and folders for an item
1439 * @param array $item
1443 * [ // categories array
1445 * 'name': 'category name',
1446 * 'removeurl': 'url to remove this category',
1447 * 'first': 'is the first in this array? true/false',
1448 * 'last': 'is the last in this array? true/false',
1454 * 'name': 'folder name',
1455 * 'removeurl': 'url to remove this folder',
1456 * 'first': 'is the first in this array? true/false',
1457 * 'last': 'is the last in this array? true/false',
1463 function get_cats_and_terms($item)
1470 $cnt = preg_match_all('/<(.*?)>/', $item['file'], $matches, PREG_SET_ORDER);
1472 foreach ($matches as $mtch) {
1474 'name' => xmlify(file_tag_decode($mtch[1])),
1476 'removeurl' => ((local_user() == $item['uid'])?'filerm/' . $item['id'] . '?f=&cat=' . xmlify(file_tag_decode($mtch[1])):""),
1484 if (count($categories)) {
1485 $categories[count($categories) - 1]['last'] = true;
1488 if (local_user() == $item['uid']) {
1491 $cnt = preg_match_all('/\[(.*?)\]/', $item['file'], $matches, PREG_SET_ORDER);
1493 foreach ($matches as $mtch) {
1495 'name' => xmlify(file_tag_decode($mtch[1])),
1497 'removeurl' => ((local_user() == $item['uid']) ? 'filerm/' . $item['id'] . '?f=&term=' . xmlify(file_tag_decode($mtch[1])) : ""),
1506 if (count($folders)) {
1507 $folders[count($folders) - 1]['last'] = true;
1510 return [$categories, $folders];
1515 * get private link for item
1516 * @param array $item
1517 * @return boolean|array False if item has not plink, otherwise array('href'=>plink url, 'title'=>translated title)
1519 function get_plink($item) {
1522 if ($a->user['nickname'] != "") {
1524 //'href' => "display/" . $a->user['nickname'] . "/" . $item['id'],
1525 'href' => "display/" . $item['guid'],
1526 'orig' => "display/" . $item['guid'],
1527 'title' => L10n::t('View on separate page'),
1528 'orig_title' => L10n::t('view on separate page'),
1531 if (x($item, 'plink')) {
1532 $ret["href"] = $a->remove_baseurl($item['plink']);
1533 $ret["title"] = L10n::t('link to source');
1536 } elseif (x($item, 'plink') && ($item['private'] != 1)) {
1538 'href' => $item['plink'],
1539 'orig' => $item['plink'],
1540 'title' => L10n::t('link to source'),
1551 * replace html amp entity with amp char
1555 function unamp($s) {
1556 return str_replace('&', '&', $s);
1561 * return number of bytes in size (K, M, G)
1562 * @param string $size_str
1565 function return_bytes($size_str) {
1566 switch (substr ($size_str, -1)) {
1567 case 'M': case 'm': return (int)$size_str * 1048576;
1568 case 'K': case 'k': return (int)$size_str * 1024;
1569 case 'G': case 'g': return (int)$size_str * 1073741824;
1570 default: return $size_str;
1578 function generate_user_guid() {
1581 $guid = get_guid(32);
1582 $x = q("SELECT `uid` FROM `user` WHERE `guid` = '%s' LIMIT 1",
1585 if (! DBM::is_result($x)) {
1588 } while ($found == true);
1596 * @param boolean $strip_padding
1599 function base64url_encode($s, $strip_padding = false) {
1601 $s = strtr(base64_encode($s), '+/', '-_');
1603 if ($strip_padding) {
1604 $s = str_replace('=','',$s);
1614 function base64url_decode($s) {
1617 logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
1622 * // Placeholder for new rev of salmon which strips base64 padding.
1623 * // PHP base64_decode handles the un-padded input without requiring this step
1624 * // Uncomment if you find you need it.
1627 * if (! strpos($s,'=')) {
1637 return base64_decode(strtr($s,'-_','+/'));
1642 * return div element with class 'clear'
1646 function cleardiv() {
1647 return '<div class="clear"></div>';
1651 function bb_translate_video($s) {
1654 $r = preg_match_all("/\[video\](.*?)\[\/video\]/ism",$s,$matches,PREG_SET_ORDER);
1656 foreach ($matches as $mtch) {
1657 if ((stristr($mtch[1],'youtube')) || (stristr($mtch[1],'youtu.be')))
1658 $s = str_replace($mtch[0],'[youtube]' . $mtch[1] . '[/youtube]',$s);
1659 elseif (stristr($mtch[1],'vimeo'))
1660 $s = str_replace($mtch[0],'[vimeo]' . $mtch[1] . '[/vimeo]',$s);
1666 function html2bb_video($s) {
1668 $s = preg_replace('#<object[^>]+>(.*?)https?://www.youtube.com/((?:v|cp)/[A-Za-z0-9\-_=]+)(.*?)</object>#ism',
1669 '[youtube]$2[/youtube]', $s);
1671 $s = preg_replace('#<iframe[^>](.*?)https?://www.youtube.com/embed/([A-Za-z0-9\-_=]+)(.*?)</iframe>#ism',
1672 '[youtube]$2[/youtube]', $s);
1674 $s = preg_replace('#<iframe[^>](.*?)https?://player.vimeo.com/video/([0-9]+)(.*?)</iframe>#ism',
1675 '[vimeo]$2[/vimeo]', $s);
1681 * apply xmlify() to all values of array $val, recursively
1685 function array_xmlify($val){
1686 if (is_bool($val)) {
1687 return $val?"true":"false";
1688 } elseif (is_array($val)) {
1689 return array_map('array_xmlify', $val);
1691 return xmlify((string) $val);
1696 * transform link href and img src from relative to absolute
1698 * @param string $text
1699 * @param string $base base url
1702 function reltoabs($text, $base) {
1707 $base = rtrim($base,'/');
1709 $base2 = $base . "/";
1712 $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
1713 $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
1714 $text = preg_replace($pattern, $replace, $text);
1716 $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
1717 $replace = "<a\${1} href=\"" . $base . "\${2}\"";
1718 $text = preg_replace($pattern, $replace, $text);
1721 $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
1722 $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
1723 $text = preg_replace($pattern, $replace, $text);
1725 $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
1726 $replace = "<img\${1} src=\"" . $base . "\${2}\"";
1727 $text = preg_replace($pattern, $replace, $text);
1735 * get translated item type
1737 * @param array $itme
1740 function item_post_type($item) {
1741 if (intval($item['event-id'])) {
1742 return L10n::t('event');
1743 } elseif (strlen($item['resource-id'])) {
1744 return L10n::t('photo');
1745 } elseif (strlen($item['verb']) && $item['verb'] !== ACTIVITY_POST) {
1746 return L10n::t('activity');
1747 } elseif ($item['id'] != $item['parent']) {
1748 return L10n::t('comment');
1751 return L10n::t('post');
1754 // post categories and "save to file" use the same item.file table for storage.
1755 // We will differentiate the different uses by wrapping categories in angle brackets
1756 // and save to file categories in square brackets.
1757 // To do this we need to escape these characters if they appear in our tag.
1759 function file_tag_encode($s) {
1760 return str_replace(['<','>','[',']'],['%3c','%3e','%5b','%5d'],$s);
1763 function file_tag_decode($s) {
1764 return str_replace(['%3c', '%3e', '%5b', '%5d'], ['<', '>', '[', ']'], $s);
1767 function file_tag_file_query($table,$s,$type = 'file') {
1769 if ($type == 'file') {
1770 $str = preg_quote('[' . str_replace('%', '%%', file_tag_encode($s)) . ']');
1772 $str = preg_quote('<' . str_replace('%', '%%', file_tag_encode($s)) . '>');
1774 return " AND " . (($table) ? dbesc($table) . '.' : '') . "file regexp '" . dbesc($str) . "' ";
1777 // ex. given music,video return <music><video> or [music][video]
1778 function file_tag_list_to_file($list,$type = 'file') {
1780 if (strlen($list)) {
1781 $list_array = explode(",",$list);
1782 if ($type == 'file') {
1790 foreach ($list_array as $item) {
1791 if (strlen($item)) {
1792 $tag_list .= $lbracket . file_tag_encode(trim($item)) . $rbracket;
1799 // ex. given <music><video>[friends], return music,video or friends
1800 function file_tag_file_to_list($file,$type = 'file') {
1803 if ($type == 'file') {
1804 $cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
1806 $cnt = preg_match_all('/<(.*?)>/', $file, $matches, PREG_SET_ORDER);
1809 foreach ($matches as $mtch) {
1810 if (strlen($list)) {
1813 $list .= file_tag_decode($mtch[1]);
1820 function file_tag_update_pconfig($uid, $file_old, $file_new, $type = 'file') {
1821 // $file_old - categories previously associated with an item
1822 // $file_new - new list of categories for an item
1824 if (!intval($uid)) {
1827 if ($file_old == $file_new) {
1831 $saved = PConfig::get($uid, 'system', 'filetags');
1832 if (strlen($saved)) {
1833 if ($type == 'file') {
1836 $termtype = TERM_FILE;
1840 $termtype = TERM_CATEGORY;
1843 $filetags_updated = $saved;
1845 // check for new tags to be added as filetags in pconfig
1847 $check_new_tags = explode(",",file_tag_file_to_list($file_new,$type));
1849 foreach ($check_new_tags as $tag) {
1850 if (! stristr($saved,$lbracket . file_tag_encode($tag) . $rbracket))
1854 $filetags_updated .= file_tag_list_to_file(implode(",",$new_tags),$type);
1856 // check for deleted tags to be removed from filetags in pconfig
1858 $check_deleted_tags = explode(",",file_tag_file_to_list($file_old,$type));
1860 foreach ($check_deleted_tags as $tag) {
1861 if (! stristr($file_new,$lbracket . file_tag_encode($tag) . $rbracket))
1862 $deleted_tags[] = $tag;
1865 foreach ($deleted_tags as $key => $tag) {
1866 $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
1868 intval(TERM_OBJ_POST),
1872 if (DBM::is_result($r)) {
1873 unset($deleted_tags[$key]);
1875 $filetags_updated = str_replace($lbracket . file_tag_encode($tag) . $rbracket,'',$filetags_updated);
1879 if ($saved != $filetags_updated) {
1880 PConfig::set($uid, 'system', 'filetags', $filetags_updated);
1883 } elseif (strlen($file_new)) {
1884 PConfig::set($uid, 'system', 'filetags', $file_new);
1889 function file_tag_save_file($uid, $item, $file)
1891 if (! intval($uid)) {
1895 $r = q("SELECT `file` FROM `item` WHERE `id` = %d AND `uid` = %d LIMIT 1",
1899 if (DBM::is_result($r)) {
1900 if (!stristr($r[0]['file'],'[' . file_tag_encode($file) . ']')) {
1901 $fields = ['file' => $r[0]['file'] . '[' . file_tag_encode($file) . ']'];
1902 Item::update($fields, ['id' => $item]);
1904 $saved = PConfig::get($uid, 'system', 'filetags');
1905 if (!strlen($saved) || !stristr($saved, '[' . file_tag_encode($file) . ']')) {
1906 PConfig::set($uid, 'system', 'filetags', $saved . '[' . file_tag_encode($file) . ']');
1908 info(L10n::t('Item filed'));
1913 function file_tag_unsave_file($uid, $item, $file, $cat = false)
1915 if (! intval($uid)) {
1920 $pattern = '<' . file_tag_encode($file) . '>' ;
1921 $termtype = TERM_CATEGORY;
1923 $pattern = '[' . file_tag_encode($file) . ']' ;
1924 $termtype = TERM_FILE;
1927 $r = q("SELECT `file` FROM `item` WHERE `id` = %d AND `uid` = %d LIMIT 1",
1931 if (! DBM::is_result($r)) {
1935 $fields = ['file' => str_replace($pattern,'',$r[0]['file'])];
1936 Item::update($fields, ['id' => $item]);
1938 $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
1940 intval(TERM_OBJ_POST),
1944 if (!DBM::is_result($r)) {
1945 $saved = PConfig::get($uid, 'system', 'filetags');
1946 PConfig::set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
1952 function normalise_openid($s) {
1953 return trim(str_replace(['http://', 'https://'], ['', ''], $s), '/');
1957 function undo_post_tagging($s) {
1959 $cnt = preg_match_all('/([!#@])\[url=(.*?)\](.*?)\[\/url\]/ism', $s, $matches, PREG_SET_ORDER);
1961 foreach ($matches as $mtch) {
1962 $s = str_replace($mtch[0], $mtch[1] . $mtch[3],$s);
1968 function protect_sprintf($s) {
1969 return str_replace('%', '%%', $s);
1973 function is_a_date_arg($s) {
1977 if ($i <= $y + 1 && strpos($s, '-') == 4) {
1978 $m = intval(substr($s,5));
1979 if ($m > 0 && $m <= 12)
1987 * remove intentation from a text
1989 function deindent($text, $chr = "[\t ]", $count = NULL) {
1990 $lines = explode("\n", $text);
1991 if (is_null($count)) {
1994 while ($k < count($lines) && strlen($lines[$k]) == 0) {
1997 preg_match("|^" . $chr . "*|", $lines[$k], $m);
1998 $count = strlen($m[0]);
2000 for ($k = 0; $k < count($lines); $k++) {
2001 $lines[$k] = preg_replace("|^" . $chr . "{" . $count . "}|", "", $lines[$k]);
2004 return implode("\n", $lines);
2007 function formatBytes($bytes, $precision = 2) {
2008 $units = ['B', 'KB', 'MB', 'GB', 'TB'];
2010 $bytes = max($bytes, 0);
2011 $pow = floor(($bytes ? log($bytes) : 0) / log(1024));
2012 $pow = min($pow, count($units) - 1);
2014 $bytes /= pow(1024, $pow);
2016 return round($bytes, $precision) . ' ' . $units[$pow];
2020 * @brief translate and format the networkname of a contact
2022 * @param string $network
2023 * Networkname of the contact (e.g. dfrn, rss and so on)
2028 function format_network_name($network, $url = 0) {
2029 if ($network != "") {
2031 $network_name = '<a href="'.$url.'">'.ContactSelector::networkToName($network, $url)."</a>";
2033 $network_name = ContactSelector::networkToName($network);
2036 return $network_name;
2041 * @brief Syntax based code highlighting for popular languages.
2042 * @param string $s Code block
2043 * @param string $lang Programming language
2044 * @return string Formated html
2046 function text_highlight($s, $lang) {
2047 if ($lang === 'js') {
2048 $lang = 'javascript';
2051 // @TODO: Replace Text_Highlighter_Renderer_Html by scrivo/highlight.php
2053 // Autoload the library to make constants available
2054 class_exists('Text_Highlighter_Renderer_Html');
2057 'numbers' => HL_NUMBERS_LI,
2062 $s = trim(html_entity_decode($s, ENT_COMPAT));
2063 $s = str_replace(' ', "\t", $s);
2066 * The highlighter library insists on an opening php tag for php code blocks. If
2067 * it isn't present, nothing is highlighted. So we're going to see if it's present.
2068 * If not, we'll add it, and then quietly remove it after we get the processed output back.
2070 if ($lang === 'php' && strpos($s, '<?php') !== 0) {
2071 $s = '<?php' . "\n" . $s;
2075 $renderer = new Text_Highlighter_Renderer_Html($options);
2076 $factory = new Text_Highlighter();
2077 $hl = $factory->factory($lang);
2078 $hl->setRenderer($renderer);
2079 $o = $hl->highlight($s);
2080 $o = str_replace("\n", '', $o);
2083 $b = substr($o, 0, strpos($o, '<li>'));
2084 $e = substr($o, strpos($o, '</li>'));
2088 return '<code>' . $o . '</code>';