streams/include/misc.php

<?php

/**
 * @file include/misc.php
 * This file started as some additional text handling functions but has grown to include
 * a number of miscellaneous functions that didn't really fit anywhere else.  Perhaps it should be named "misc.php" instead.
 */

use Code\Lib\MarkdownSoap;
use Code\Lib\AccessList;
use Code\Lib\Libzot;
use Code\Lib\SvgSanitizer;
use Code\Lib\Img_cache;
use Code\Lib\PConfig;
use Code\Lib\Config;
use Code\Lib\Channel;
use Code\Lib\Features;
use Code\Extend\Hook;
use Code\Render\Theme;

use Michelf\MarkdownExtra;
use Symfony\Component\Uid\Uuid;

require_once('include/bbcode.php');

/**
 * @brief This is our template processor.
 *
 * @param string $s the string requiring macro substitution,
 *   or an instance of SmartyEngine
 * @param array $r key value pairs (search => replace)
 *
 * @return string substituted string
 */
function replace_macros($template, $map)
{
    $arr = [
        'template' => $template,
        'params' => $map,
    ];

    /**
     * @hooks replace_macros
     *   * \e string \b template
     *   * \e array \b params
     */

    Hook::call('replace_macros', $arr);

    $t = App::template_engine();

    try {
        $output = $t->replace_macros($arr['template'], $arr['params']);
    } catch (Exception $e) {
        btlogger("Unable to render template: " . $e->getMessage());
        $output = "<h3>ERROR: there was an error creating the output.</h3>";
    }

    return $output;
}

/**
 * @brief Generates a random string.
 *
 * @param number $size
 * @param int $type
 *
 * @return string
 *
 * There are 86 characters max in text mode, 128 for hex. output is urlsafe.
 */


const RANDOM_STRING_HEX = 0x00;
const RANDOM_STRING_TEXT = 0x01;

function random_string($size = 64, $type = RANDOM_STRING_HEX)
{
    // generate a bit of entropy and run it through the whirlpool
    $s = hash('whirlpool', rand() . uniqid(rand(), true) . rand(), $type == RANDOM_STRING_TEXT);
    $s = (($type == RANDOM_STRING_TEXT) ? str_replace("\n", "", base64url_encode($s, true)) : $s);

    return(substr($s, 0, $size));
}

/**
 * @brief Input filter to replace HTML tag characters with something safe - without changing the string length.
 *
 * @param string $string Input string
 *
 * @return string Filtered string
 *
 */
function notags($string)
{
    return(str_replace(["<",">"], ['[',']'], $string));
}

// Basically explode(), but entries are trimmed and empty entries discarded.

function strtoarr($separator, $string) {
    $array = [];
    if ($string) {
        $tmp = explode($separator, $string);
        foreach ($tmp as $t) {
            $t = trim($t);
            if ($t) {
                $array[] = $t;
            }
        }
    }
    return $array;
}

/**
 * use this on input where angle chars shouldn't be removed,
 * and allow them to be safely used in HTML.
 *
 * @param string $string
 *
 * @return string
 */
function escape_tags($string)
{
    return(htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false));
}


function z_input_filter($s, $type = 'text/x-multicode')
{

    if ($type === 'text/x-multicode') {
        return (multicode_purify($s));
    }
    if (in_array($type, ['text/plain', 'text/bbcode', 'application/x-pdl'])) {
        return escape_tags($s);
    }
    if (App::$is_sys) {
        return $s;
    }

    if ($type === 'text/markdown') {
        $x = new MarkdownSoap($s);
        return $x->clean();
    }

    if ($type === 'text/html') {
        return purify_html($s);
    }

    return escape_tags($s);
}


/**
 * @brief Use HTMLPurifier to get standards compliant HTML.
 *
 * Use the <a href="http://htmlpurifier.org/" target="_blank">HTMLPurifier</a>
 * library to get filtered and standards compliant HTML.
 *
 * @see HTMLPurifier
 *
 * @param string $s raw HTML
 * @param array $opts
 * @return string standards compliant filtered HTML
 */
function purify_html($s, $opts = [])
{

    $config = HTMLPurifier_Config::createDefault();
    $config->set('Cache.DefinitionImpl', null);
    $config->set('Attr.EnableID', true);


    // disable Unicode version of RTL over-ride
    $s = str_replace([ '&#x202e;', '&#x202E;', html_entity_decode('&#x202e;', ENT_QUOTES, 'UTF-8') ], [ '','','' ], $s);


    // This will escape invalid tags in the output instead of removing.
    // This is necessary for mixed format (text+bbcode+html+markdown) messages or
    // some angle brackets in plaintext may get stripped if they look like an HTML tag

    if (in_array('escape', $opts)) {
        $config->set('Core.EscapeInvalidChildren', true);
        $config->set('Core.EscapeInvalidTags', true);
    }

    // If enabled, target=blank attributes are added to all links.
    //$config->set('HTML.TargetBlank', true);
    //$config->set('Attr.AllowedFrameTargets', ['_blank', '_self', '_parent', '_top']);
    // restore old behavior of HTMLPurifier < 4.8, only used when targets allowed at all
    // do not add rel="noreferrer" to all links with target attributes
    //$config->set('HTML.TargetNoreferrer', false);
    // do not add noopener rel attributes to links which have a target attribute associated with them
    //$config->set('HTML.TargetNoopener', false);

    //Allow some custom data- attributes used by built-in libs.
    //In this way members which do not have allowcode set can still use the built-in js libs in webpages to some extent.

    $def = $config->getHTMLDefinition(true);

    //data- attributes used by the foundation library

    // f6 navigation

    //dropdown menu
    $def->info_global_attr['data-dropdown-menu'] = new HTMLPurifier_AttrDef_Text();
    //drilldown menu
    $def->info_global_attr['data-drilldown'] = new HTMLPurifier_AttrDef_Text();
    //accordion menu
    $def->info_global_attr['data-accordion-menu'] = new HTMLPurifier_AttrDef_Text();
    //responsive navigation
    $def->info_global_attr['data-responsive-menu'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-responsive-toggle'] = new HTMLPurifier_AttrDef_Text();
    //magellan
    $def->info_global_attr['data-magellan'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-magellan-target'] = new HTMLPurifier_AttrDef_Text();

    // f6 containers

    //accordion
    $def->info_global_attr['data-accordion'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-accordion-item'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-tab-content'] = new HTMLPurifier_AttrDef_Text();
    //dropdown
    $def->info_global_attr['data-dropdown'] = new HTMLPurifier_AttrDef_Text();
    //off-canvas
    $def->info_global_attr['data-off-canvas-wrapper'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-off-canvas'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-off-canvas-content'] = new HTMLPurifier_AttrDef_Text();
    //reveal
    $def->info_global_attr['data-reveal'] = new HTMLPurifier_AttrDef_Text();
    //tabs
    $def->info_global_attr['data-tabs'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-tabs-content'] = new HTMLPurifier_AttrDef_Text();

    // f6 media

    //orbit
    $def->info_global_attr['data-orbit'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-slide'] = new HTMLPurifier_AttrDef_Text();
    //tooltip
    $def->info_global_attr['data-tooltip'] = new HTMLPurifier_AttrDef_Text();

    // f6 plugins

    //abide - the use is pointless since we can't do anything with forms

    //equalizer
    $def->info_global_attr['data-equalizer'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-equalizer-watch'] = new HTMLPurifier_AttrDef_Text();

    //interchange - potentially dangerous since it can load content

    //toggler
    $def->info_global_attr['data-bs-toggler'] = new HTMLPurifier_AttrDef_Text();

    //sticky
    $def->info_global_attr['data-sticky'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-sticky-container'] = new HTMLPurifier_AttrDef_Text();

    // f6 common

    $def->info_global_attr['data-options'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-bs-toggle'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-close'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-open'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-position'] = new HTMLPurifier_AttrDef_Text();


    //data- attributes used by the bootstrap library
    $def->info_global_attr['data-dismiss'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-bs-target'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-bs-toggle'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-backdrop'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-keyboard'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-show'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-spy'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-offset'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-animation'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-container'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-delay'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-placement'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-title'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-trigger'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-content'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-trigger'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-parent'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-ride'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-slide-to'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-slide'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-interval'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-pause'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-wrap'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-offset-top'] = new HTMLPurifier_AttrDef_Text();
    $def->info_global_attr['data-offset-bottom'] = new HTMLPurifier_AttrDef_Text();

    //some html5 elements
    //Block
    $def->addElement('section', 'Block', 'Flow', 'Common');
    $def->addElement('nav', 'Block', 'Flow', 'Common');
    $def->addElement('article', 'Block', 'Flow', 'Common');
    $def->addElement('aside', 'Block', 'Flow', 'Common');
    $def->addElement('header', 'Block', 'Flow', 'Common');
    $def->addElement('footer', 'Block', 'Flow', 'Common');
    //Inline
    $def->addElement('button', 'Inline', 'Inline', 'Common');
    $def->addElement('mark', 'Inline', 'Inline', 'Common');

    if (in_array('allow_position', $opts)) {
        $cssDefinition = $config->getCSSDefinition();

        $cssDefinition->info['position'] = new HTMLPurifier_AttrDef_Enum(['absolute', 'fixed', 'relative', 'static', 'inherit'], false);

        $cssDefinition->info['left'] = new HTMLPurifier_AttrDef_CSS_Composite([
            new HTMLPurifier_AttrDef_CSS_Length(),
            new HTMLPurifier_AttrDef_CSS_Percentage()
        ]);

        $cssDefinition->info['right'] = new HTMLPurifier_AttrDef_CSS_Composite([
            new HTMLPurifier_AttrDef_CSS_Length(),
            new HTMLPurifier_AttrDef_CSS_Percentage()
        ]);

        $cssDefinition->info['top'] = new HTMLPurifier_AttrDef_CSS_Composite([
            new HTMLPurifier_AttrDef_CSS_Length(),
            new HTMLPurifier_AttrDef_CSS_Percentage()
        ]);

        $cssDefinition->info['bottom'] = new HTMLPurifier_AttrDef_CSS_Composite([
            new HTMLPurifier_AttrDef_CSS_Length(),
            new HTMLPurifier_AttrDef_CSS_Percentage()
        ]);
    }

    $purifier = new HTMLPurifier($config);

    return $purifier->purify($s);
}


/**
 * @brief Generate a string that's random, but usually pronounceable.
 *
 * Used to generate initial passwords.
 *
 * @note In order to create "pronounceable" strings some consonant pairs or
 * letters that does not make a very good word ending are chopped off, so that
 * the returned string length can be lower than $len.
 *
 * @param int $len max length of generated string
 * @return string Genereated random, but usually pronounceable string
 */
function autoname($len)
{

    if ($len <= 0) {
        return '';
    }

    $vowels = ['a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u'];
    if (mt_rand(0, 5) == 4) {
        $vowels[] = 'y';
    }

    $cons = [
            'b','bl','br',
            'c','ch','cl','cr',
            'd','dr',
            'f','fl','fr',
            'g','gh','gl','gr',
            'h',
            'j',
            'k','kh','kl','kr',
            'l',
            'm',
            'n',
            'p','ph','pl','pr',
            'qu',
            'r','rh',
            's','sc','sh','sm','sp','st',
            't','th','tr',
            'v',
            'w','wh',
            'x',
            'z','zh'
    ];

    $midcons = ['ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
                'nd','ng','nk','nt','rn','rp','rt'];

    // avoid these consonant pairs at the end of the string
    $noend = ['bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
                'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh'];

    $start = mt_rand(0, 2);
    if ($start == 0) {
        $table = $vowels;
    } else {
        $table = $cons;
    }

    $word = '';

    for ($x = 0; $x < $len; $x++) {
        $r = mt_rand(0, count($table) - 1);
        $word .= $table[$r];

        if ($table == $vowels) {
            $table = array_merge($cons, $midcons);
        } else {
            $table = $vowels;
        }
    }

    $word = substr($word, 0, $len);

    foreach ($noend as $noe) {
        if ((strlen($word) > 2) && (substr($word, -2) == $noe)) {
            $word = substr($word, 0, -1);
            break;
        }
    }
    // avoid the letter 'q' as it does not make a very good word ending
    if (str_ends_with($word, 'q')) {
        $word = substr($word, 0, -1);
    }

    return $word;
}


/**
 * @brief escape text ($str) for XML transport
 *
 * @param string $str
 * @return string Escaped text.
 */
function xmlify($str)
{
    $buffer = '';

    if (is_array($str)) {
        // allow to fall through so we ge a PHP error, as the log statement will
        // probably get lost in the noise unless we're specifically looking for it.

        btlogger('xmlify called with array: ' . print_r($str, true), LOGGER_NORMAL, LOG_WARNING);
    }

    $len = mb_strlen($str);
    for ($x = 0; $x < $len; $x++) {
        $char = mb_substr($str, $x, 1);

        switch ($char) {
            case "\r":
                break;
            case "&":
                $buffer .= '&amp;';
                break;
            case "'":
                $buffer .= '&apos;';
                break;
            case "\"":
                $buffer .= '&quot;';
                break;
            case '<':
                $buffer .= '&lt;';
                break;
            case '>':
                $buffer .= '&gt;';
                break;
            case "\n":
                $buffer .= "\n";
                break;
            default:
                $buffer .= $char;
                break;
        }
    }
    $buffer = trim($buffer);

    return($buffer);
}

/**
 * @brief Undo an xmlify.
 *
 * Pass xml escaped text ($s), returns unescaped text.
 *
 * @param string $s
 *
 * @return string
 */
function unxmlify($s)
{
    $ret = str_replace('&amp;', '&', $s);
    $ret = str_replace(['&lt;', '&gt;', '&quot;', '&apos;'], ['<', '>', '"', "'"], $ret);

    return $ret;
}

/**
 * @brief Automatic pagination.
 *
 * To use, get the count of total items.
 * Then call App::set_pager_total($number_items);
 * Optionally call App::set_pager_itemspage($n) to the number of items to display on each page
 * Then call paginate($a) after the end of the display loop to insert the pager block on the page
 * (assuming there are enough items to paginate).
 * When using with SQL, the setting LIMIT %d, %d => App::$pager['start'],App::$pager['itemspage']
 * will limit the results to the correct items for the current page.
 * The actual page handling is then accomplished at the application layer.
 *
 * @param App &$a
 */
function paginate(&$a)
{
    $o = '';
    $stripped = preg_replace('/(&page=[0-9]*)/', '', App::$query_string);

    //  $stripped = preg_replace('/&zid=(.*?)([\?&]|$)/ism','',$stripped);

    $stripped = str_replace('q=', '', $stripped);
    $stripped = trim($stripped, '/');
    $pagenum = App::$pager['page'];
    $url = z_root() . '/' . $stripped;

    if (App::$pager['total'] > App::$pager['itemspage']) {
        $o .= '<div class="pager">';
        if (App::$pager['page'] != 1) {
            $o .= '<span class="pager_prev">' . "<a href=\"$url" . '&page=' . (App::$pager['page'] - 1) . '">' . t('prev') . '</a></span> ';
        }

        $o .=  "<span class=\"pager_first\"><a href=\"$url" . "&page=1\">" . t('first') . "</a></span> ";

        $numpages = App::$pager['total'] / App::$pager['itemspage'];

        $numstart = 1;
        $numstop = $numpages;

        if ($numpages > 14) {
            $numstart = (($pagenum > 7) ? ($pagenum - 7) : 1);
            $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 14));
        }

        for ($i = $numstart; $i <= $numstop; $i++) {
            if ($i == App::$pager['page']) {
                $o .= '<span class="pager_current">' . (($i < 10) ? '&nbsp;' . $i : $i);
            } else {
                $o .= "<span class=\"pager_n\"><a href=\"$url" . "&page=$i\">" . (($i < 10) ? '&nbsp;' . $i : $i) . "</a>";
            }
            $o .= '</span> ';
        }

        if ((App::$pager['total'] % App::$pager['itemspage']) != 0) {
            if ($i == App::$pager['page']) {
                $o .= '<span class="pager_current">' . (($i < 10) ? '&nbsp;' . $i : $i);
            } else {
                $o .= "<span class=\"pager_n\"><a href=\"$url" . "&page=$i\">" . (($i < 10) ? '&nbsp;' . $i : $i) . "</a>";
            }
            $o .= '</span> ';
        }

        $lastpage = (($numpages > intval($numpages)) ? intval($numpages) + 1 : $numpages);
        $o .= "<span class=\"pager_last\"><a href=\"$url" . "&page=$lastpage\">" . t('last') . "</a></span> ";

        if ((App::$pager['total'] - (App::$pager['itemspage'] * App::$pager['page'])) > 0) {
            $o .= '<span class="pager_next">' . "<a href=\"$url" . "&page=" . (App::$pager['page'] + 1) . '">' . t('next') . '</a></span>';
        }
        $o .= '</div>' . "\r\n";
    }

    return $o;
}


function alt_pager($i, $more = '', $less = '')
{

    if (! $more) {
        $more = t('older');
    }
    if (! $less) {
        $less = t('newer');
    }

    $stripped = preg_replace('/(&page=[0-9]*)/', '', App::$query_string);
    $stripped = str_replace('q=', '', $stripped);
    $stripped = trim($stripped, '/');
    //$pagenum = App::$pager['page'];
    $url = z_root() . '/' . $stripped;
    // the template adds params with '&' so we need to supply a query param
    // with '?'. Use a dummy argument f= if there are no other query params.

    if (! strpos($url,'?')) {
       $url = $url . '?f=';
    }

    return replace_macros(Theme::get_template('alt_pager.tpl'), [
        '$has_less' => App::$pager['page'] > 1,
        '$has_more' => $i > 0 && $i >= App::$pager['itemspage'],
        '$less' => $less,
        '$more' => $more,
        '$url' => $url,
        '$prevpage' => App::$pager['page'] - 1,
        '$nextpage' => App::$pager['page'] + 1,
    ]);
}


/**
 * @brief Generate a guaranteed unique (for this domain) item ID for ATOM.
 *
 * Safe from birthday paradox.
 *
 * @return string a unique id
 */
function item_message_id()
{

    $hash = (string) Uuid::v4();
    $mid = z_root() . '/item/' . $hash;

    return $mid;
}

/**
 * @brief Generate a guaranteed unique photo ID.
 *
 * Safe from birthday paradox.
 *
 * @return string a unique hash
 */
function photo_new_resource()
{
    $hash = (string) Uuid::v4();
    return $hash;
}


// provide psuedo random token (string) consisting entirely of US-ASCII letters/numbers
// and with possibly variable length

function new_token($minlen = 36, $maxlen = 48)
{

    $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890';
    $str   = EMPTY_STR;

    $len   = (($minlen === $maxlen) ? $minlen : mt_rand($minlen, $maxlen));

    for ($a = 0; $a < $len; $a++) {
        $str .= $chars[mt_rand(0, 62)];
    }
    return $str;
}

/**
 * @brief Generate a unique ID.
 *
 * @return string
 */
function new_uuid()
{
    $hash = (string) Uuid::v4();
    return $hash;
}

/**
 * @brief
 *
 * for html,xml parsing - let's say you've got
 * an attribute foobar="class1 class2 class3"
 * and you want to find out if it contains 'class3'.
 * you can't use a normal sub string search because you
 * might match 'notclass3' and a regex to do the job is
 * possible but a bit complicated.
 *
 * pass the attribute string as $attr and the attribute you
 * are looking for as $s - returns true if found, otherwise false
 *
 * @param string $attr attribute string
 * @param string $s attribute you are looking for
 * @return bool true if found
 */
function attribute_contains($attr, $s)
{
    // remove quotes
    $attr = str_replace([ '"',"'" ], ['',''], $attr);
    $a = explode(' ', $attr);
    if ($a && in_array($s, $a)) {
        return true;
    }

    return false;
}

/**
 * @brief Create a log message.
 *
 * Logging is configured through the site config. The log file
 * is set in system.logfile, log level in system.loglevel and to enable logging
 * set system.debugging.
 *
 * Available constants for log level are LOGGER_NORMAL, LOGGER_TRACE, LOGGER_DEBUG,
 * LOGGER_DATA and LOGGER_ALL.
 *
 *
 * @param string $msg Message to log
 * @param int $level A log level
 * @param int $priority - compatible with syslog
 */


function logger($msg, $level = LOGGER_NORMAL, $priority = LOG_INFO)
{

    if (App::$module == 'setup' && is_writable('install.log')) {
        $debugging = true;
        $logfile = 'install.log';
        $loglevel = LOGGER_ALL;
    } else {
        $debugging = get_config('system', 'debugging');
        $loglevel  = intval(get_config('system', 'loglevel'));
        $logfile   = get_config('system', 'logfile');
    }

    if ((! $debugging) || (! $logfile) || ($level > $loglevel)) {
        return;
    }

    // Get a backtrace to report the calling function.
    $stack = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
    $where = basename($stack[0]['file']) . ':' . $stack[0]['line'] . ':' . $stack[1]['function'] . ': ';

    $s = datetime_convert('UTC', 'UTC', 'now', ATOM_TIME) . ':' . log_priority_str($priority) . ':' . logid() . ':' . $where . $msg . PHP_EOL;
    $pluginfo = ['filename' => $logfile, 'loglevel' => $level, 'message' => $s,'priority' => $priority, 'logged' => false];

    if (! (App::$module == 'setup')) {
        Hook::call('logger', $pluginfo);
    }

    if (! $pluginfo['logged']) {
        @file_put_contents($pluginfo['filename'], $pluginfo['message'], FILE_APPEND);
    }
}

function logid()
{
    $x = session_id();
    if (! $x) {
        $x = getmypid();
    }
    return substr(hash('whirlpool', $x), 0, 10);
}

/**
 * @brief like logger() but with a function backtrace to pinpoint certain classes
 * of problems which show up deep in the calling stack.
 *
 * @param string $msg Message to log
 * @param int $level A log level
 * @param int $priority - compatible with syslog
 */
function btlogger($msg, $level = LOGGER_NORMAL, $priority = LOG_INFO)
{

    if (! defined('BTLOGGER_DEBUG_FILE')) {
        define('BTLOGGER_DEBUG_FILE', 'btlogger.out');
    }

    logger($msg, $level, $priority);

    if (file_exists(BTLOGGER_DEBUG_FILE) && is_writable(BTLOGGER_DEBUG_FILE)) {
        $stack = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
        $where = basename($stack[0]['file']) . ':' . $stack[0]['line'] . ':' . $stack[1]['function'] . ': ';
        $s = datetime_convert('UTC', 'UTC', 'now', ATOM_TIME) . ':' . log_priority_str($priority) . ':' . logid() . ':' . $where . $msg . PHP_EOL;
        @file_put_contents(BTLOGGER_DEBUG_FILE, $s, FILE_APPEND);
    }

    $stack = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
    if ($stack) {
        for ($x = 1; $x < count($stack); $x++) {
            $s = 'stack: ' . basename($stack[$x]['file']) . ':' . $stack[$x]['line'] . ':' . $stack[$x]['function'] . '()';
            logger($s, $level, $priority);

            if (file_exists(BTLOGGER_DEBUG_FILE) && is_writable(BTLOGGER_DEBUG_FILE)) {
                @file_put_contents(BTLOGGER_DEBUG_FILE, $s . PHP_EOL, FILE_APPEND);
            }
        }
    }
}

function log_priority_str($priority)
{
    $parr = [
        LOG_EMERG   => 'LOG_EMERG',
        LOG_ALERT   => 'LOG_ALERT',
        LOG_CRIT    => 'LOG_CRIT',
        LOG_ERR     => 'LOG_ERR',
        LOG_WARNING => 'LOG_WARNING',
        LOG_NOTICE  => 'LOG_NOTICE',
        LOG_INFO    => 'LOG_INFO',
        LOG_DEBUG   => 'LOG_DEBUG'
    ];

    if ($parr[$priority]) {
        return $parr[$priority];
    }
    return 'LOG_UNDEFINED';
}

/**
 * @brief This is a special logging facility for developers.
 *
 * It allows one to target specific things to trace/debug and is identical to
 * logger() with the exception of the log filename. This allows one to isolate
 * specific calls while allowing logger() to paint a bigger picture of overall
 * activity and capture more detail.
 *
 * If you find dlogger() calls in checked in code, you are free to remove them -
 * so as to provide a noise-free development environment which responds to events
 * you are targetting personally.
 *
 * @param string $msg Message to log
 * @param int $level A log level.
 */
function dlogger($msg, $level = 0)
{

    // turn off logger in install mode

    if (App::$module == 'setup') {
        return;
    }

    $debugging = get_config('system', 'debugging');
    $loglevel  = intval(get_config('system', 'loglevel'));
    $logfile   = get_config('system', 'dlogfile');

    if ((! $debugging) || (! $logfile) || ($level > $loglevel)) {
        return;
    }

    $stack = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
    $where = basename($stack[0]['file']) . ':' . $stack[0]['line'] . ':' . $stack[1]['function'] . ': ';

    @file_put_contents($logfile, datetime_convert('UTC', 'UTC', 'now', ATOM_TIME) . ':' . logid() . ' ' . $where . $msg . PHP_EOL, FILE_APPEND);
}


function profiler($t1, $t2, $label)
{
    if (file_exists('profiler.out') && $t1 && $t2) {
        @file_put_contents('profiler.out', sprintf('%01.4f %s', $t2 - $t1, $label) . PHP_EOL, FILE_APPEND);
    }
}


function activity_match($haystack, $needle)
{

    if (! is_array($needle)) {
        $needle = [ $needle ];
    }

    if ($needle) {
        foreach ($needle as $n) {
            if (($haystack === $n) || (strtolower(basename($n)) === strtolower(basename($haystack)))) {
                return true;
            }
        }
    }
    return false;
}

/**
 * @brief Pull out all \#hashtags and \@person tags from $s.
 *
 * We also get \@person\@domain.com - which would make
 * the regex quite complicated as tags can also
 * end a sentence. So we'll run through our results
 * and strip the period from any tags which end with one.
 *
 * @param string $s
 * @return array
 */
function get_tags($s = '')
{
    $ret = [];
    $match = [];

    // ignore anything in a code or svg block or HTML tag

    $s = preg_replace('/\[code(.*?)](.*?)\[\/code]/sm', '', $s);
    $s = preg_replace('/<(.*?)>/sm', '', $s);
    $s = preg_replace('/\[svg(.*?)](.*?)\[\/svg]/sm', '', $s);

    // ignore anything in [style= ]
    $s = preg_replace('/\[style=(.*?)]/sm', '', $s);

    // ignore anything in [color= ], because it may contain color codes which are mistaken for tags
    $s = preg_replace('/\[color=(.*?)]/sm', '', $s);

    // skip anchors in URL
    $s = preg_replace('/\[url=(.*?)]/sm', '', $s);

    // match any double quoted tags

    if (preg_match_all('/([@#!]&quot;.*?&quot;)/', $s, $match)) {
        foreach ($match[1] as $mtch) {
            $ret[] = $mtch;
        }
    }

    // match any unescaped double quoted tags (rare)

    if (preg_match_all('/([@#!]\".*?\")/', $s, $match)) {
        foreach ($match[1] as $mtch) {
            $ret[] = $mtch;
        }
    }

    // match bracket mentions

    if (preg_match_all('/([@!]!?\{.*?})/', $s, $match)) {
        foreach ($match[1] as $mtch) {
            $ret[] = $mtch;
        }
    }

    // Pull out single word tags. These can be @nickname, @first_last
    // and #hash tags.

    if (preg_match_all('/(?<![a-zA-Z0-9=\pL\/?;#])([@#!]!?[^ \x0D\x0A,;:?\[{&]+)/u', $s, $match)) {
        foreach ($match[1] as $mtch) {
            // Cleanup/ignore false positives

            // Just ignore these rather than try and adjust the regex to deal with them
            if (in_array($mtch, [ '@!', '!!' ])) {
                continue;
            }
            // likewise for trailing period. Strip it off rather than complicate the regex further.
            if (str_ends_with($mtch, '.')) {
                $mtch = substr($mtch, 0, -1);
            }
            // ignore strictly numeric tags like #1 or #^ bookmarks or ## double hash
            if ((str_starts_with($mtch, '#')) && ( ctype_digit(substr($mtch, 1)) || in_array(substr($mtch, 1, 1), [ '^', '#' ]))) {
                continue;
            }
            // or quote remnants from the quoted strings we already picked out earlier
            if ((strpos($mtch, '&quot')) || strpos($mtch, "\"")) {
                continue;
            }

            $ret[] = $mtch;
        }
    }

    // make sure the longer tags are returned first so that if two or more have common substrings
    // we'll replace the longest ones first. Otherwise the common substring would be found in
    // both strings and the string replacement would link both to the shorter strings and
    // fail to link the longer string. Hubzilla github issue #378

    usort($ret, 'tag_sort_length');

    //  logger('get_tags: ' . print_r($ret,true));

    return $ret;
}

function tag_sort_length($a, $b)
{
    if (mb_strlen($a) == mb_strlen($b)) {
        return 0;
    }

    return((mb_strlen($b) < mb_strlen($a)) ? (-1) : 1);
}

function total_sort($a, $b)
{
    if ($a['total'] == $b['total']) {
        return 0;
    }
    return(($b['total'] > $a['total']) ? 1 : (-1));
}


/**
 * @brief Quick and dirty quoted_printable encoding.
 *
 * @param string $s
 * @return string
 */
function qp($s)
{
    return str_replace("%", "=", rawurlencode($s));
}

function chanlink_hash($s)
{
    return z_root() . '/chanview?f=&hash=' . urlencode($s);
}

function chanlink_url($s)
{
    return z_root() . '/chanview?f=&url=' . urlencode($s);
}


function chanlink_cid($d)
{
    return z_root() . '/chanview?f=&cid=' . intval($d);
}

function search($s, $id = 'search-box', $url = '/search', $save = false)
{
    return replace_macros(Theme::get_template('searchbox.tpl'), [
        '$s' => $s,
        '$id' => $id,
        '$action_url' => z_root() . $url,
        '$search_label' => t('Search'),
        '$save_label' => t('Save'),
        '$savedsearch' => Features::enabled(local_channel(), 'savedsearch')
    ]);
}

function searchbox($s, $id = 'search-box', $url = '/search', $save = false)
{
    return replace_macros(Theme::get_template('searchbox.tpl'), [
        '$s' => $s,
        '$id' => $id,
        '$action_url' => z_root() . '/' . $url,
        '$search_label' => t('Search'),
        '$save_label' => t('Save'),
        '$savedsearch' => ($save && Features::enabled(local_channel(), 'savedsearch'))
    ]);
}

/**
 * @brief Replace naked text hyperlink with HTML formatted hyperlink.
 *
 * @param string $s
 * @param bool $me (optional) default false
 * @return string
 */
function linkify($s, $me = false)
{
    $rel = 'nofollow noopener';
    if ($me) {
        $rel .= ' me';
    }
    $s = preg_replace("/(https?:\/\/[a-zA-Z0-9\pL:\/\-?&;.=_@~#'%\$!+,]*)/u", '<a href="$1" rel="' . $rel . '" >$1</a>', $s);
    $s = preg_replace("/<(.*?)(src|href)=(.*?)&amp;(.*?)>/ism", '<$1$2=$3&$4>', $s);

    return($s);
}

/**
 * @brief implement image caching
 *
 * Note: This is named sslify because the original behaviour was only to proxy image fetches to
 * non-SSL resources. Now all images can be cached. If this is disabled, we'll fall back to only caching
 * the http: images
 *
 * @param string $s
 * @returns string
 */
function sslify($s, $cache_enable = true)
{

    if (! $cache_enable) {
        // we're fetching an old item and we are no longer
        // caching photos for it. Remove any existing cached photos.
        // Cron_weekly tasks will also remove these, but if the cache
        // entry was updated recently they might not get removed for
        // another couple of months.

        uncache($s);
    }

    if ((! $cache_enable) || (! intval(get_config('system', 'cache_images', 1)))) {
        // if caching is prevented for whatever reason, proxy any non-SSL photos

        if (!str_contains(z_root(), 'https:')) {
            return $s;
        }

        // we'll only sslify img tags because media files will probably choke.

        $pattern = "/<img(.*?)src=\"(http:.*?)\"(.*?)>/";

        $matches = null;
        $cnt = preg_match_all($pattern, $s, $matches, PREG_SET_ORDER);
        if ($cnt) {
            foreach ($matches as $match) {
                $filename = basename(parse_url($match[2], PHP_URL_PATH));
                $s = str_replace($match[2], z_root() . '/sslify/' . $filename . '?f=&url=' . urlencode($match[2]), $s);
            }
        }
        return $s;
    }

    $pattern = "/<img(.*?)src=\"(https?:.*?)\"(.*?)>/ism";

    $matches = null;
    $cnt = preg_match_all($pattern, $s, $matches, PREG_SET_ORDER);
    if ($cnt) {
        foreach ($matches as $match) {
            // For access controlled photos using OpenWebAuth, remove any zid attributes.
            // This will cache a publicly available image but will not cache a protected one.
            $clean = strip_zids(strip_query_param($match[2], 'f'));
            $cached = Img_cache::check($clean, 'cache/img');
            if ($cached) {
            //    $file = Img_cache::get_filename($clean,'cache/img');
            //    $imageSize = getimagesize($cached);
            //    $height = preg_match('/height=\"(.*?)\"/ism', $match[1],$h);
            //    $width = preg_match('/width=\"(.*?)\"/ism', $match[1], $w);
            //    $alt = preg_match('/alt=\"(.*?)\"/ism', $match[1], $a);

                // @fixme getimagesize and replace height/width/alt in image tag
                $s = str_replace($match[2], z_root() . '/ca/' . basename(Img_cache::get_filename($clean, 'cache/img')) . '?url=' . urlencode($clean), $s);
            }
        }
    }

    return $s;
}

// clean out the image cache

function uncache($s)
{

    $pattern = "/<img(.*?)src=\"(https?:.*?)\"(.*?)>/ism";

    $matches = null;
    $cnt = preg_match_all($pattern, $s, $matches, PREG_SET_ORDER);
    if ($cnt) {
        foreach ($matches as $match) {
            // repeat the filename generation procedure we used when creating the cache entry
            $clean = strip_zids(strip_query_param($match[2], 'f'));
            $file = Img_cache::get_filename($clean, 'cache/img');
            if (file_exists($file)) {
                unlink($file);
            }
        }
    }

    return $s;
}



/**
 * @brief Get an array of poke verbs.
 *
 * @return array
 *  * \e index is present tense verb
 *  * \e value is array containing past tense verb, translation of present, translation of past
 */
function get_poke_verbs()
{
    if (get_config('system', 'poke_basic')) {
        $arr = [
            'poke' => ['poked', t('poke'), t('poked')],
        ];
    } else {
        $arr = [
            'poke' => ['poked', t('poke'), t('poked')],
            'ping' => ['pinged', t('ping'), t('pinged')],
            'prod' => ['prodded', t('prod'), t('prodded')],
            'slap' => ['slapped', t('slap'), t('slapped')],
            'finger' => ['fingered', t('finger'), t('fingered')],
            'rebuff' => ['rebuffed', t('rebuff'), t('rebuffed')],
        ];

        /**
         * @hooks poke_verbs
         *   * \e array associative array with another array as value
         */
        Hook::call('poke_verbs', $arr);
    }

    return $arr;
}

/**
 * @brief Get an array of mood verbs.
 *
 * @return array
 *   * \e index is the verb
 *   * \e value is the translated verb
 */
function get_mood_verbs()
{

    $arr = [
        'happy'      => t('happy'),
        'sad'        => t('sad'),
        'mellow'     => t('mellow'),
        'tired'      => t('tired'),
        'perky'      => t('perky'),
        'angry'      => t('angry'),
        'stupefied'  => t('stupefied'),
        'puzzled'    => t('puzzled'),
        'interested' => t('interested'),
        'bitter'     => t('bitter'),
        'cheerful'   => t('cheerful'),
        'alive'      => t('alive'),
        'annoyed'    => t('annoyed'),
        'anxious'    => t('anxious'),
        'cranky'     => t('cranky'),
        'disturbed'  => t('disturbed'),
        'frustrated' => t('frustrated'),
        'depressed'  => t('depressed'),
        'motivated'  => t('motivated'),
        'relaxed'    => t('relaxed'),
        'surprised'  => t('surprised'),
    ];

    /**
     * @hooks mood_verbs
     *   * \e array associative array with mood verbs
     */
    Hook::call('mood_verbs', $arr);

    return $arr;
}

/**
 * @brief Function to list all smilies, both internal and from addons.
 *
 * @return array
 */
function list_smilies($default_only = false)
{

    $texts =  [
        '&lt;3',
        '&lt;/3',
        ':-)',
        ';-)',
        ':-(',
        ':-P',
        ':-p',
        ':-"',
        ':-&quot;',
        ':-x',
        ':-X',
        ':-D',
        '8-|',
        '8-O',
        ':-O',
        '\\o/',
        'o.O',
        'O.o',
        'o_O',
        'O_o',
        ":'(",
        ":-!",
        ":-/",
        ":-[",
        "8-)",
        ':beer',
        ':homebrew',
        ':coffee',
        ':facepalm',
        ':like',
        ':dislike'
    ];

    $icons = [
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-heart.gif" alt="&lt;3" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-brokenheart.gif" alt="&lt;/3" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-smile.gif" alt=":-)" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-wink.gif" alt=";-)" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-frown.gif" alt=":-(" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-tongue-out.gif" alt=":-P" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-tongue-out.gif" alt=":-p" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-kiss.gif" alt=":-\"" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-kiss.gif" alt=":-\"" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-kiss.gif" alt=":-x" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-kiss.gif" alt=":-X" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-laughing.gif" alt=":-D" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-surprised.gif" alt="8-|" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-surprised.gif" alt="8-O" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-surprised.gif" alt=":-O" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-thumbsup.gif" alt="\\o/" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-Oo.gif" alt="o.O" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-Oo.gif" alt="O.o" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-Oo.gif" alt="o_O" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-Oo.gif" alt="O_o" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-cry.gif" alt=":\'(" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-foot-in-mouth.gif" alt=":-!" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-undecided.gif" alt=":-/" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-embarassed.gif" alt=":-[" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-cool.gif" alt="8-)" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/beer_mug.gif" alt=":beer" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/beer_mug.gif" alt=":homebrew" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/coffee.gif" alt=":coffee" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-facepalm.gif" alt=":facepalm" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/like.gif" alt=":like" />',
        '<img class="smiley" src="' . z_root() . '/images/emoticons/dislike.gif" alt=":dislike" />'

    ];

    $params = ['texts' => $texts, 'icons' => $icons];

    if ($default_only) {
        return $params;
    }

    Hook::call('smilie', $params);

    return $params;
}

/**
 * @brief Replaces text emoticons with graphical images.
 *
 * It is expected that this function will be called using HTML text.
 * We will escape text between HTML pre and code blocks, and HTML attributes
 * (such as urls) from being processed.
 *
 * At a higher level, the bbcode [nosmile] tag can be used to prevent this
 * function from being executed by the prepare_text() routine when preparing
 * bbcode source for HTML display.
 *
 * @param string $s
 * @param bool $sample (optional) default false
 * @return string
 */
function smilies($s, $sample = false)
{

    if (
        intval(get_config('system', 'no_smilies'))
        || (local_channel() && intval(get_pconfig(local_channel(), 'system', 'no_smilies')))
    ) {
        return $s;
    }

    $s = preg_replace_callback('{<(pre|code)>.*?</\1>}ism', 'smile_shield', $s);
    $s = preg_replace_callback('/<[a-z]+ .*?>/ism', 'smile_shield', $s);


    $params = list_smilies();
    $params['string'] = $s;

    if ($sample) {
        $s = '<div class="smiley-sample">';
        for ($x = 0; $x < count($params['texts']); $x++) {
            $s .= '<dl><dt>' . $params['texts'][$x] . '</dt><dd>' . $params['icons'][$x] . '</dd></dl>';
        }
    } else {
        $params['string'] = preg_replace_callback('/&lt;(3+)/', 'preg_heart', $params['string']);
        $s = str_replace($params['texts'], $params['icons'], $params['string']);
    }


    $s = preg_replace_callback('/<!--base64:(.*?)-->/ism', 'smile_unshield', $s);

    return $s;
}

/**
 * @brief
 *
 * @param array $m
 * @return string
 */
function smile_shield($m)
{
    return '<!--base64:' . base64special_encode($m[0]) . '-->';
}

function smile_unshield($m)
{
    return base64special_decode($m[1]);
}

/**
 * @brief Expand <3333 to the correct number of hearts.
 *
 * @param array $x
 */
function preg_heart($x)
{

    if (strlen($x[1]) == 1) {
        return $x[0];
    }

    $t = '';
    for ($cnt = 0; $cnt < strlen($x[1]); $cnt++) {
        $t .= '<img class="smiley" src="' . z_root() . '/images/emoticons/smiley-heart.gif" alt="&lt;&#8203;3" />';
    }

    $r =  str_replace($x[0], $t, $x[0]);

    return $r;
}



function day_translate($s)
{
    $ret = str_replace(
        ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
        [t('Monday'), t('Tuesday'), t('Wednesday'), t('Thursday'), t('Friday'), t('Saturday'), t('Sunday')],
        $s
    );

    $ret = str_replace(
        ['January','February','March','April','May','June','July','August','September','October','November','December'],
        [t('January'), t('February'), t('March'), t('April'), t('May'), t('June'), t('July'), t('August'), t('September'), t('October'), t('November'), t('December')],
        $ret
    );

    return $ret;
}

/**
 * @brief normalises a string.
 *
 * @param string $url
 * @return string
 */
function normalise_link($url)
{
    $ret = str_replace(['https:', '//www.'], ['http:', '//'], $url);

    return(rtrim($ret, '/'));
}

/**
 * @brief Compare two URLs to see if they are the same.
 *
 * But ignore slight but hopefully insignificant differences such as if one
 * is https and the other isn't, or if one is www.something and the other
 * isn't - and also ignore case differences.
 *
 * @see normalise_link()
 *
 * @param string $a
 * @param string $b
 * @return bool
 */
function link_compare($a, $b)
{
    if (strcasecmp(normalise_link($a), normalise_link($b)) === 0) {
        return true;
    }

    return false;
}

function unobscure($item)
{
    return;
}

function unobscure_mail(&$item)
{
    if (array_key_exists('mail_obscured', $item) && intval($item['mail_obscured'])) {
        if ($item['title']) {
            $item['title'] = base64url_decode(str_rot47($item['title']));
        }
        if ($item['body']) {
            $item['body'] = base64url_decode(str_rot47($item['body']));
        }
    }
}


function theme_attachments($item)
{

    $s = EMPTY_STR;

    $arr = json_decode($item['attach'], true);

    if (is_array($arr) && count($arr)) {
        $attaches = [];
        foreach ($arr as $r) {
            $label = EMPTY_STR;
            $icon = getIconFromType($r['type'] ?? 'application/octet-stream');

            if (isset($r['title']) && $r['title']) {
                $label = urldecode(htmlspecialchars($r['title'], ENT_COMPAT, 'UTF-8'));
            }

            if (isset($r['name']) && $r['name']) {
                $label = urldecode(htmlspecialchars($r['name'], ENT_COMPAT, 'UTF-8'));
            }

            if (isset($r['href']) && $r['href']) {
                $m = parse_url($r['href']);
            }
            if (! $label) {
                if (isset($r['href']) && $r['href']) {
                    if (isset($m) && $m && $m['path']) {
                        $label = basename($m['path']);
                    }
                }
            }

            // some feeds provide an attachment where title is an empty space
            if (! trim($label)) {
                $label = t('Unknown Attachment');
            }

            $title = t('Size') . ' ' . ((isset($r['length']) && $r['length']) ? userReadableSize($r['length']) : t('unknown'));

            if (! (isset($r['href']))) {
                continue;
            }

            if (isset($m) && $m && $m['scheme'] === 'data') {
                continue;
            }

            if (Channel::is_foreigner($item['author_xchan'])) {
                $url = $r['href'];
            } else {
                $url = z_root() . '/magic?f=&owa=1&hash=' . $item['author_xchan'] . '&bdest=' . bin2hex($r['href'] . (($r['revision']) ? '/' . $r['revision'] : ''));
            }
            $attaches[] = [
                'label' => $label,
                'url'   => $url,
                'icon'  => $icon,
                'title' => $title
            ];
        }

        $s = replace_macros(Theme::get_template('item_attach.tpl'), [
            '$attaches' => $attaches
        ]);
    }

    return $s;
}


function format_categories($item, $writeable)
{

    $s = EMPTY_STR;

    if (! (isset($item['term']) && $item['term'])) {
        return $s;
    }

    $terms = get_terms_oftype($item['term'], TERM_CATEGORY);
    if ($terms) {
        $categories = [];
        foreach ($terms as $t) {
            $term = htmlspecialchars($t['term'], ENT_COMPAT, 'UTF-8', false) ;
            if (! trim($term)) {
                continue;
            }
            $removelink = (($writeable) ?  z_root() . '/filerm/' . $item['id'] . '?f=&cat=' . urlencode($t['term']) : '');
            $categories[] = ['term' => $term, 'writeable' => $writeable, 'removelink' => $removelink, 'url' => zid($t['url'])];
        }

        $s = replace_macros(Theme::get_template('item_categories.tpl'), [
            '$remove' => t('remove category'),
            '$categories' => $categories
        ]);
    }

    return $s;
}

/**
 * @brief Add any hashtags which weren't mentioned in the message body, e.g. community tags
 *
 * @param[in] array &$item
 * @return string HTML link of hashtag
 */

function format_hashtags($item)
{
    $s = '';

    if (! isset($item['term'])) {
        return $s;
    }

    $terms = get_terms_oftype($item['term'], [TERM_HASHTAG,TERM_COMMUNITYTAG]);
    if ($terms) {
        foreach ($terms as $t) {
            $term = htmlspecialchars($t['term'], ENT_COMPAT, 'UTF-8', false) ;
            if (! trim($term)) {
                continue;
            }

            // Pleroma uses example.com/tags/xxx in the taglist but example.com/tag/xxx in the body. Possibly a bug because one of these leads to
            // an error page, but it messes up our detection of whether the tag was already present in the body.

            if ($t['url'] && ((stripos($item['body'], $t['url']) !== false) || (stripos($item['body'], str_replace('/tags/', '/tag/', $t['url']))))) {
                continue;
            }
            if ($s) {
                $s .= ' ';
            }

            $s .= '<span class="badge badge-pill badge-info"><i class="fa fa-hashtag"></i>&nbsp;<a href="' . zid($t['url']) . '" >' . $term . '</a></span>';
        }
    }

    return $s;
}



function format_mentions($item)
{
    $s = EMPTY_STR;

    $pref = intval(PConfig::Get($item['uid'], 'system', 'tag_username', Config::Get('system', 'tag_username', false)));

    // hide "auto mentions" by default - this hidden pref let's you display them.

    $show = intval(PConfig::Get($item['uid'], 'system', 'show_auto_mentions', false));
    if ((! $show) && (! $item['resource_type'])) {
        return $s;
    }

    if ($pref === 127) {
        return $s;
    }

    if (! (isset($item['term']) && is_array($item['term']) && $item['term'])) {
        return $s;
    }
    $terms = get_terms_oftype($item['term'], TERM_MENTION);
    if ($terms) {
        foreach ($terms as $t) {
            $term = htmlspecialchars($t['term'], ENT_COMPAT, 'UTF-8', false) ;
            if (! trim($term)) {
                continue;
            }

            if ($t['url'] && stripos($item['body'], $t['url']) !== false) {
                continue;
            }

            // some platforms put the identity url into href rather than the profile url. Accept either form.
            $x = q(
                "select * from xchan where xchan_url = '%s' or xchan_hash = '%s' limit 1",
                dbesc($t['url']),
                dbesc($t['url'])
            );
            if ($x) {
                switch ($pref) {
                    case 0:
                        $txt = $x[0]['xchan_name'];
                        break;
                    case 1:
                        $txt = (($x[0]['xchan_addr']) ?: $x[0]['xchan_name']);
                        break;
                    case 2:
                    default;
                        if ($x[0]['xchan_addr']) {
                            $txt = sprintf(t('%1$s (%2$s)'), $x[0]['xchan_name'], $x[0]['xchan_addr']);
                        } else {
                            $txt = $x[0]['xchan_name'];
                        }
                        break;
                }
            }

            if ($s) {
                $s .= ' ';
            }
            $s .= '<span class="badge badge-pill badge-success"><i class="fa fa-at"></i>&nbsp;<a href="' . zid(chanlink_url($t['url'])) . '" >' . $txt . '</a></span>';
        }
    }

    return $s;
}


function format_filer(&$item)
{
    $s = EMPTY_STR;

    if (! (isset($item['term']) && $item['term'])) {
        return $s;
    }

    $terms = get_terms_oftype($item['term'], TERM_FILE);
    if ($terms) {
        $categories = [];
        foreach ($terms as $t) {
            $term = htmlspecialchars($t['term'], ENT_COMPAT, 'UTF-8', false) ;
            if (! trim($term)) {
                continue;
            }
            $removelink = z_root() . '/filerm/' . $item['id'] . '?f=&term=' . urlencode($t['term']);
            $categories[] = ['term' => $term, 'removelink' => $removelink];
        }

        $s = replace_macros(Theme::get_template('item_filer.tpl'), [
            '$remove' => t('remove from file'),
            '$categories' => $categories
        ]);
    }

    return $s;
}


function generate_map($lat, $lon, $zoom = 16)
{

    $arr = [
        'lat' => $lat,
        'lon' => $lon,
        'zoom' => $zoom,
        'html' => ''
    ];

    /**
     * @hooks generate_map
     *   * \e string \b lat
     *   * \e string \b lon
     *   * \e string \b html the parsed HTML to return
     */
    Hook::call('generate_map', $arr);
    return (strlen($arr['html'])) ? $arr['html'] : 'geo:' . $lat . ',' . $lon . '&z=' . $zoom;
}

function generate_named_map($location)
{
    $arr = [
        'location' => $location,
        'html' => ''
    ];

    /**
     * @hooks generate_named_map
     *   * \e string \b location
     *   * \e string \b html the parsed HTML to return
     */
    Hook::call('generate_named_map', $arr);

    return (($arr['html']) ?: $location);
}

function item_is_censored($item, $observer) {

    // Don't censor your own posts.
    if ($observer && $item['author_xchan'] === $observer) {
        return false;
    }

    $censored = ($item['author']['abook_censor']
        || $item['owner']['abook_censor']
        || $item['author']['xchan_selfcensored']
        || $item['owner']['xchan_selfcensored']
        || $item['author']['xchan_censored']
        || $item['owner']['xchan_censored']
        || intval($item['item_nsfw'])) && (get_safemode());

    return $censored;
}

function prepare_body(&$item, $attach = false, $opts = false)
{
    Hook::call('prepare_body_init', $item);

    if (item_is_censored($item, get_observer_hash())) {
        if (! $opts) {
            $opts = [];
        }
        $opts['censored'] = true;
    }

    $s = '';
    $photo = '';

    $is_photo = ($item['verb'] === ACTIVITY_POST) && ($item['obj_type'] === ACTIVITY_OBJ_PHOTO);

    if ($is_photo) {
        $object = is_array($item['obj']) ? $item['obj'] : json_decode($item['obj'], true);
        $ptr = null;

        if (is_array($object) && array_key_exists('url', $object) && is_array($object['url'])) {
            if (array_key_exists(0, $object['url'])) {
                foreach ($object['url'] as $link) {
                    if (array_key_exists('width', $link) && $link['width'] >= 640 && $link['width'] <= 1024) {
                        $ptr = $link;
                    }
                }
                if (! $ptr) {
                    $ptr = $object['url'][0];
                }
            } else {
                $ptr = $object['url'];
            }

            if ($ptr) {
                $alt_text = ' alt="' . ((isset($ptr['summary']) && $ptr['summary']) ? htmlspecialchars($ptr['summary'], ENT_QUOTES, 'UTF-8') : t('Image/photo')) . '"';
                $item['body'] = '[zmg' . $alt_text . ']' . $ptr['href'] . '[/zmg]' . "\n\n" . $item['body'];
            }
        }
    }

    if ($item['item_obscured']) {
        $s .= prepare_binary($item);
    } else {
        if ($item['summary']) {
            // 8203 is a zero-width space so as not to trigger a markdown link if the summary starts with parentheses
            $s .= prepare_text('[summary]&#8203;' . $item['summary'] . '[/summary]&#8203;' . $item['body'], $item['mimetype'], $opts);
        } else {
            if ($item['html']) {
                $s .= smilies($item['html']);
            } else {
                $s .= prepare_text($item['body'], $item['mimetype'], $opts);
            }
        }
    }

    $poll = (($item['obj_type'] === 'Question' && in_array($item['verb'], [ 'Create','Update' ])) ? format_poll($item, $s, $opts) : false);
    if ($poll) {
        $s = $poll;
    }

    $e = trim($item['body']);
    $em = Emoji\is_single_emoji($e) || mb_strlen($e) === 1;
    if ($em) {
        $s = '<span style="font-size: 2rem;">' . trim($item['body']) . '</span>';
    }

    $event = (($item['obj_type'] === ACTIVITY_OBJ_EVENT) ? format_event_obj($item['obj']) : false);

    // This is not the most pleasant UI element possible, but this is difficult to add to one of the templates.
    // Eventually we may wish to add/remove to/from calendar in the message title area but it will take a chunk
    // of code re-factoring to make that happen.

    if (is_array($event) && $event['header'] && $item['resource_id']) {
        $event['header'] .= '<i class="fa fa-asterisk" title="' . t('Added to your calendar') . '"></i>' . '&nbsp;' . t('Added to your calendar');
    }

    $prep_arr = [
        'item' => $item,
        'html' => $event ? $event['content'] : $s,
        'event' => ((is_array($event)) ? $event['header'] : EMPTY_STR),
        'photo' => $photo
    ];

    Hook::call('prepare_body', $prep_arr);

    $s = $prep_arr['html'];
    $photo = $prep_arr['photo'];
    $event = $prep_arr['event'];

    if (! $attach) {
        return $s;
    }

    if (str_contains($s, '<div class="map">')) {
        if ($item['lat'] || $item['lon']) {
            $lat = $item['lat'];
            $lon = $item['lon'];
        }
        elseif ($item['coord']) {
            $tmp = explode(' ', $item['coord']);
            if (count($tmp) > 1) {
                $lat = $tmp[0];
                $lon = $tmp[1];
            }
        }
        $x = generate_map($lat, $lon);
        if ($x) {
            $s = preg_replace('/\<div class\=\"map\"\>/', '$0' . $x, $s);
        }
    }

    $attachments = theme_attachments($item);

    $writeable = get_observer_hash() == $item['owner_xchan'];

    $tags = format_hashtags($item);

    $mentions = format_mentions($item);

    $categories = format_categories($item, $writeable);

    if (local_channel() == $item['uid']) {
        $filer = format_filer($item);
    }

    // Caching photos can use absurd amounts of space.
    // Don't cache photos if somebody is just browsing the stream to the
    // beginning of time. This optimises performance for viewing things created
    // recently. Also catch an explicit expiration of 0 or "no cache".

    $cache_expire = intval(get_config('system', 'default_expire_days'));
    if ($cache_expire <= 0) {
        $cache_expire = 60;
    }
    $cache_enable = !((($cache_expire) && ($item['created'] < datetime_convert('UTC', 'UTC', 'now - ' . $cache_expire . ' days'))));

    // disable Unicode RTL over-ride since it can destroy presentation in some cases, use HTML or CSS instead
    $s = str_replace([ '&#x202e;', '&#x202E;', html_entity_decode('&#x202e;', ENT_QUOTES, 'UTF-8') ], [ '','','' ], $s);

    if ($s) {
        $s = sslify($s, $cache_enable);
    }
    if ($photo) {
        $photo = sslify($photo, $cache_enable);
    }
    if ($event) {
        $event = sslify($event, $cache_enable);
    }

    $prep_arr = [
        'item' => $item,
        'photo' => $photo,
        'html' => $s,
        'event' => $event,
        'categories' => $categories,
        'folders' => $filer,
        'tags' => $tags,
        'mentions' => $mentions,
        'attachments' => $attachments
    ];

    Hook::call('prepare_body_final', $prep_arr);

    unset($prep_arr['item']);

    return $prep_arr;
}

function separate_img_links($s)
{
    /** @noinspection HtmlRequiredAltAttribute */
    /** @noinspection HtmlUnknownAttribute */
    $x = preg_replace(
        '/\<a (.*?)\>\<img(.*?)\>\<\/a\>/ism',
        '<img$2><br><a $1>' . t('Link') . '</a><br>',
        $s
    );

    return $x;
}

function format_poll($item, $s, $opts)
{

    if (! is_array($item['obj'])) {
        $act = json_decode($item['obj'], true);
    } else {
        $act = $item['obj'];
    }

    if (! is_array($act)) {
        return EMPTY_STR;
    }

    $commentable = can_comment_on_post(((local_channel()) ? get_observer_hash() : EMPTY_STR), $item);
    if (!$commentable) {
        $commentable = local_channel() && local_channel() == $item['uid'];
    }
    
    //logger('format_poll: ' . print_r($item,true));
    $activated = local_channel() && local_channel() == $item['uid'];
    $output = $s . EOL . EOL;

    $closed = false;
    $closing = false;

    if ($item['comments_closed'] > NULL_DATE) {
        $closing = true;
        $t = datetime_convert('UTC', date_default_timezone_get(), $item['comments_closed'], 'Y-m-d H:i');
        $closed = datetime_convert() > $item['comments_closed'];
        if ($closed) {
            $commentable = false;
        }
    }

    if ($act['type'] === 'Question') {
        if ($activated and $commentable) {
            $output .= '<form id="question-form-' . $item['id'] . '" >';
        }
        if (array_key_exists('anyOf', $act) && is_array($act['anyOf'])) {
            $totalResponses = 0;
            foreach ($act['anyOf'] as $poll) {
                if (array_path_exists('replies/totalItems', $poll) && $poll['replies']['totalItems'] > $totalResponses) {
                    $totalResponses = $poll['replies']['totalItems'];
                }
            }

            foreach ($act['anyOf'] as $poll) {
                if (array_key_exists('name', $poll) && $poll['name']) {
                    $text = html2plain(purify_html($poll['name']), 256);
                    if (array_path_exists('replies/totalItems', $poll)) {
                        $total = $poll['replies']['totalItems'];
                    } else {
                        $total = 0;
                    }
                    $disabled = !($activated && $commentable);

                    $output .= '<input type="checkbox" name="answer[]" value="' . htmlspecialchars($text) . '" ' .
                        (($disabled) ? ' disabled="disabled" ' : '') . '>&nbsp;&nbsp;<strong>' . $text . '</strong>'
                        . EOL;
                    $output .= '<div class="progress bg-opacity-25" style="height: 3px; max-width: 75%;">';
                    $output .= '<div class="progress-bar bg-default" role="progressbar" style="width: ' .
                        (($totalResponses) ?  round($total / $totalResponses * 100) : 0)  .
                        '%;" aria-valuenow="" aria-valuemin="0" aria-valuemax="100"></div>';
                    $output .= '</div>';
                    $output .= '<div class="text-muted"><small>'
                        . sprintf(tt('%d Vote', '%d Votes', $total, 'noun'), $total)
                        . '</small></div>' . EOL;
                }
            }
        }
        if (array_key_exists('oneOf', $act) && is_array($act['oneOf'])) {
            $totalResponses = 0;
            foreach ($act['oneOf'] as $poll) {
                if (array_path_exists('replies/totalItems', $poll)) {
                    $totalResponses += intval($poll['replies']['totalItems']);
                }
            }
            foreach ($act['oneOf'] as $poll) {
                if (is_array($poll) && array_key_exists('name', $poll) && $poll['name']) {
                    $text = html2plain(purify_html($poll['name']), 256);
                    if (array_path_exists('replies/totalItems', $poll)) {
                        $total = $poll['replies']['totalItems'];
                    } else {
                        $total = 0;
                    }
                    $disabled = !($activated && $commentable);
                    $output .= '<input type="radio" name="answer" value="' . htmlspecialchars($text) . '" ' .
                        (($disabled) ? ' disabled="disabled" ' : '') . '>&nbsp;&nbsp;<strong>' . $text . '</strong>' . EOL;
                    $output .= '<div class="progress bg-opacity-25" style="height: 3px; max-width: 75%;">';
                    $output .= '<div class="progress-bar bg-default" role="progressbar" style="width: ' . (($totalResponses) ?  round($total / $totalResponses * 100) : 0). '%;" aria-valuenow="" aria-valuemin="0" aria-valuemax="100"></div>';
                    $output .= '</div>';
                    $output .= '<div class="text-muted"><small>' . sprintf(tt('%d Vote', '%d Votes', $total, 'noun'), $total) . '&nbsp;|&nbsp;' . (($totalResponses) ? round($total / $totalResponses * 100) . '%' : '0%') . '</small></div>';
                    $output .= EOL;

                }
            }
        }

        $message = (($totalResponses) ? sprintf(tt('%d Vote in total', '%d Votes in total', $totalResponses, 'noun'), $totalResponses) . EOL : '');


        if ($closed) {
            $message = t('Poll has ended.');
        } elseif ($closing) {
            $message = sprintf(t('Poll ends: %1$s (%2$s)'), relative_date($t), $t);
        }
        $output .= EOL . '<div class="mb-3">' . $message . '</div>';

        if ($activated and $commentable && !$closed) {
            $output .= EOL . '<input type="button" class="btn btn-std btn-success" name="vote" value="' . t('Vote') . '" onclick="submitPoll(' . $item['id'] . '); return false;">' . '</form>';
        }
    }
    return $output;
}



function prepare_binary($item)
{
    return replace_macros(Theme::get_template('item_binary.tpl'), [
        '$download'  => t('Download binary/encrypted content'),
        '$url'       => z_root() . '/viewsrc/' . $item['id'] . '/download'
    ]);
}


/**
 * @brief Given a text string, convert from bbcode to html and add smilie icons.
 *
 * @param string $text
 * @param string $content_type (optional) default text/bbcode
 * @param bool $cache (optional) default false
 *
 * @return string
 */
function prepare_text($text, $content_type = 'text/x-multicode', $opts = [])
{
    switch ($content_type) {
        case 'text/plain':
        case 'application/x-pdl';
            $s = escape_tags($text);
            break;

        case 'text/html':
            $s = $text;
            break;

        case 'text/markdown':
            $text = MarkdownSoap::unescape($text);
            $s = MarkdownExtra::defaultTransform($text);
            break;

        case 'text/bbcode':
            $opts['bbonly'] = true;
        case 'text/x-multicode':
        case '':
        default:
            if (stristr($text, '[nosmile]')) {
                $s = bbcode($text, $opts);
            } else {
                $s = smilies(bbcode($text, $opts));
            }

            $s = zidify_links($s);
            break;
    }

    return $s;
}


function create_export_photo_body(&$item)
{
    if (($item['verb'] === ACTIVITY_POST) && ($item['obj_type'] === ACTIVITY_OBJ_PHOTO)) {
        $j = json_decode($item['obj'], true);
        if ($j) {
            $item['body'] .= "\n\n" . (($j['source']['content']) ?: $item['content']);
            $item['sig'] = '';
        }
    }
}


function get_plink($item, $conversation_mode = true)
{
    if ($conversation_mode) {
        $key = 'plink';
    } else {
        $key = 'llink';
    }

    $zidify = true;


	if (array_key_exists('author', $item) && ! in_array($item['author']['xchan_network'], [ 'nomad', 'zot6' ])) {
		$zidify = false;
	}

    if (x($item, $key)) {
        return [
            'href' => (($zidify) ? zid($item[$key]) : $item[$key]),
            'title' => t('Link to source'),
        ];
    } else {
        return false;
    }
}


function layout_select($channel_id, $current = '')
{
    $options = '';
    $r = q(
        "select mid, v from item left join iconfig on iconfig.iid = item.id
		where iconfig.cat = 'system' and iconfig.k = 'PDL' and item.uid = %d and item_type = %d ",
        intval($channel_id),
        intval(ITEM_TYPE_PDL)
    );

    if ($r) {
        $empty_selected = (($current === false) ? ' selected="selected" ' : '');
        $options .= '<option value="" ' . $empty_selected . '>' . t('default') . '</option>';
        foreach ($r as $rr) {
            $selected = (($rr['mid'] == $current) ? ' selected="selected" ' : '');
            $options .= '<option value="' . $rr['mid'] . '"' . $selected . '>' . $rr['v'] . '</option>';
        }
    }

    $o = replace_macros(Theme::get_template('field_select_raw.tpl'), [
        '$field'    => ['layout_mid', t('Page layout'), $selected, t('You can create your own with the layouts tool'), $options]
    ]);

    return $o;
}


function mimetype_select($channel_id, $current = 'text/x-multicode', $choices = null, $element = 'mimetype')
{

    $x = (($choices) ? $choices : [
        'text/bbcode'       => t('BBcode'),
		'text/x-multicode'  => t('Multicode'),
        'text/html'         => t('HTML'),
        'text/markdown'     => t('Markdown'),
        'text/plain'        => t('Text'),
        'application/x-pdl' => t('Comanche Layout')
    ]);

    if ((App::$is_sys) || (Channel::codeallowed($channel_id) && $channel_id == local_channel())) {
        $x['application/x-php'] = t('PHP');
    }

    foreach ($x as $y => $z) {
        $selected = (($y == $current) ? ' selected="selected" ' : '');
        $options .= '<option value="' . $y . '"' . $selected . '>' . $z . '</option>';
    }

    $o = replace_macros(Theme::get_template('field_select_raw.tpl'), [
        '$field'    => [$element, t('Page content type'), $selected, '', $options]
    ]);

    return $o;
}

function engr_units_to_bytes($size_str)
{
    if (! $size_str) {
        return $size_str;
    }
    return match (substr(trim($size_str), -1)) {
        'M', 'm' => (int)$size_str * 1048576,
        'K', 'k' => (int)$size_str * 1024,
        'G', 'g' => (int)$size_str * 1073741824,
        default => $size_str,
    };
}


function base64url_encode($s, $strip_padding = true)
{

    $s = strtr(base64_encode($s), '+/', '-_');

    if ($strip_padding) {
        $s = str_replace('=', '', $s);
    }

    return $s;
}

function base64url_decode($s)
{
    if (is_array($s)) {
        logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
        return $s;
    }
    return base64_decode(strtr($s, '-_', '+/'));
}


function base64special_encode($s, $strip_padding = true)
{

    $s = strtr(base64_encode($s), '+/', ',.');

    if ($strip_padding) {
        $s = str_replace('=', '', $s);
    }

    return $s;
}

function base64special_decode($s)
{
    if (is_array($s)) {
        logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
        return $s;
    }
    return base64_decode(strtr($s, ',.', '+/'));
}

/**
 * @brief Return a div to clear floats.
 *
 * @return string
 */
function cleardiv()
{
    return '<div class="clear"></div>';
}


function bb_translate_video($s)
{
    $arr = ['string' => $s];
    Hook::call('bb_translate_video', $arr);
    return $arr['string'];
}

function html2bb_video($s)
{
    $arr = ['string' => $s];
    Hook::call('html2bb_video', $arr);
    return $arr['string'];
}

/**
 * apply xmlify() to all values of array $val, recursively
 */
function array_xmlify($val)
{
    if (is_bool($val)) {
        return $val ? "true" : "false";
    }
    if (is_array($val)) {
        return array_map('array_xmlify', $val);
    }
    return xmlify((string) $val);
}


function reltoabs($text, $base)
{
    if (empty($base)) {
        return $text;
    }

    $base = rtrim($base, '/');

    $base2 = $base . "/";

    // Replace links
    $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
    $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
    $text = preg_replace($pattern, $replace, $text);

    $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
    $replace = "<a\${1} href=\"" . $base . "\${2}\"";
    $text = preg_replace($pattern, $replace, $text);

    // Replace images
    $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
    $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
    $text = preg_replace($pattern, $replace, $text);

    $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
    $replace = "<img\${1} src=\"" . $base . "\${2}\"";
    $text = preg_replace($pattern, $replace, $text);

    // Done
    return $text;
}

function item_post_type($item)
{
    switch ($item['resource_type']) {
        case 'photo':
            $post_type = t('photo');
            break;
        case 'event':
            $post_type = t('event');
            break;
        default:
            $post_type = t('post');
            if ($item['mid'] !== $item['parent_mid']) {
                $post_type = t('comment');
            }
            break;
    }

    if (strlen($item['verb']) && (! activity_match($item['verb'], ACTIVITY_POST))) {
        $post_type = t('activity');
    }

    return $post_type;
}

// This needs to be fixed to use quoted tag strings

function undo_post_tagging($s)
{

    $matches = null;
    // undo tags and mentions
    $cnt = preg_match_all('/([@#])(\!*)\[zrl=(.*?)\](.*?)\[\/zrl\]/ism', $s, $matches, PREG_SET_ORDER);
    if ($cnt) {
        foreach ($matches as $mtch) {
            $x = false;
            if ($mtch[1] === '@') {
                $x = q(
                    "select xchan_addr, xchan_url from xchan where xchan_url = '%s' limit 1",
                    dbesc($mtch[3])
                );
            }
            if ($x) {
                $s = str_replace($mtch[0], $mtch[1] . $mtch[2] . '{' . (($x[0]['xchan_addr']) ?: $x[0]['xchan_url']) . '}', $s);
            } else {
                $s = str_replace($mtch[0], $mtch[1] . $mtch[2] . quote_tag($mtch[4]), $s);
            }
        }
    }
    $matches = null;
    $x = null;
    $cnt = preg_match_all('/([@#])(\!*)\[url=(.*?)\](.*?)\[\/url\]/ism', $s, $matches, PREG_SET_ORDER);
    if ($cnt) {
        foreach ($matches as $mtch) {
            $x = false;
            if ($mtch[1] === '@') {
                $x = q(
                    "select xchan_addr, xchan_url from xchan where xchan_url = '%s' limit 1",
                    dbesc($mtch[3])
                );
            }
            if ($x) {
                $s = str_replace($mtch[0], $mtch[1] . $mtch[2] . '{' . (($x[0]['xchan_addr']) ?: $x[0]['xchan_url']) . '}', $s);
            } else {
                $s = str_replace($mtch[0], $mtch[1] . $mtch[2] . quote_tag($mtch[4]), $s);
            }
        }
    }
    return $s;
}

function quote_tag($s)
{
    if (str_contains($s, ' ')) {
        return '&quot;' . $s . '&quot;';
    }
    return $s;
}


function fix_mce_lf($s)
{
    $s = str_replace("\r\n", "\n", $s);
//  $s = str_replace("\n\n","\n",$s);
    return $s;
}


function protect_sprintf($s)
{
    return(str_replace('%', '%%', $s));
}


function is_a_date_arg($s)
{
    $i = intval($s);
    if ($i > 1900) {
        $y = intval(date('Y'));
        if ($i <= $y + 1 && strpos($s, '-') == 4) {
            $m = intval(substr($s, 5));
            if ($m > 0 && $m <= 12) {
                return true;
            }
        }
    }

    return false;
}

function legal_webbie($s)
{
    if (! $s) {
        return '';
    }

    // WARNING: This regex may not work in a federated environment.
    // You will probably want something like
    // preg_replace('/([^a-z0-9\_])/','',strtolower($s));

    $r = preg_replace('/([^a-z0-9\-\_])/', '', strtolower($s));

    $x = [ 'input' => $s, 'output' => $r ];
    Hook::call('legal_webbie', $x);
    return $x['output'];
}

function legal_webbie_text()
{

    // WARNING: This will not work in a federated environment.

    $s = t('a-z, 0-9, -, and _ only');

    $x = [ 'text' => $s ];
    Hook::call('legal_webbie_text', $x);
    return $x['text'];
}





function check_webbie($arr)
{


    // These names conflict with the CalDAV server
    $taken = [ 'principals', 'addressbooks', 'calendars' ];

    $reservechan = get_config('system', 'reserved_channels');
    if (strlen($reservechan)) {
        $taken = array_merge($taken, explode(',', $reservechan));
    }

    $str = '';
    if (count($arr)) {
        foreach ($arr as $x) {
            $y = legal_webbie($x);
            if (strlen($y)) {
                if ($str) {
                    $str .= ',';
                }
                $str .= "'" . dbesc($y) . "'";
            }
        }

        if (strlen($str)) {
            $r = q("select channel_address from channel where channel_address in ( $str ) ");
            if (count($r)) {
                foreach ($r as $rr) {
                    $taken[] = $rr['channel_address'];
                }
            }
            foreach ($arr as $x) {
                $y = legal_webbie($x);
                $found = false;
                foreach ($taken as $took) {
                    if (fnmatch($took,$y)) {
                        $found = true;
                    }
                }
                if (! $found) {
                    return $y;
                }
            }
        }
    }

    return '';
}

function ids_to_array($arr, $idx = 'id')
{
    $t = [];
    if ($arr) {
        foreach ($arr as $x) {
            if (array_key_exists($idx, $x) && strlen($x[$idx]) && (! in_array($x[$idx], $t))) {
                $t[] = $x[$idx];
            }
        }
    }
    return($t);
}




function ids_to_querystr($arr, $idx = 'id', $quote = false)
{
    $t = [];
    if ($arr) {
        foreach ($arr as $x) {
            if (! in_array($x[$idx], $t)) {
                if ($quote) {
                    $t[] = "'" . dbesc($x[$idx]) . "'";
                } else {
                    $t[] = $x[$idx];
                }
            }
        }
    }
    return(implode(',', $t));
}

/**
 * @brief array_elm_to_str($arr,$elm,$delim = ',') extract unique individual elements from an array of arrays and return them as a string separated by a delimiter
 * similar to ids_to_querystr, but allows a different delimiter instead of a db-quote option
 * empty elements (evaluated after trim()) are ignored.
 * @param $arr array
 * @param $elm string //  to extract from sub-array
 * @param $delim string // default ','
 * @param $each // filter function to apply to each element before evaluation, default is 'trim'.
 * @returns string
 */

function array_elm_to_str($arr, $elm, $delim = ',', $each = 'trim')
{

    $tmp = [];
    if ($arr && is_array($arr)) {
        foreach ($arr as $x) {
            if (is_array($x) && array_key_exists($elm, $x)) {
                $z = $each($x[$elm]);
                if (($z) && (! in_array($z, $tmp))) {
                    $tmp[] = $z;
                }
            }
        }
    }
    return implode($delim, $tmp);
}

function trim_and_unpunify($s)
{
    return unpunify(trim($s));
}



/**
 * @brief Fetches xchan and hubloc data for an array of items with only an
 * author_xchan and owner_xchan.
 *
 * If $abook is true also include the abook info. This is needed in the API to
 * save extra per item lookups there.
 *
 * @param[in,out] array &$items
 * @param bool $abook If true also include the abook info
 * @param number $effective_uid
 */
function xchan_query(&$items, $abook = true, $effective_uid = 0)
{
    $arr = [];

    if ($items && count($items)) {
        if ($effective_uid) {
            for ($x = 0; $x < count($items); $x++) {
                $items[$x]['real_uid'] = $items[$x]['uid'];
                $items[$x]['uid'] = $effective_uid;
            }
        }

        foreach ($items as $item) {
            if ($item['owner_xchan'] && (! in_array("'" . dbesc($item['owner_xchan']) . "'", $arr))) {
                $arr[] = "'" . dbesc($item['owner_xchan']) . "'";
            }
            if ($item['author_xchan'] && (! in_array("'" . dbesc($item['author_xchan']) . "'", $arr))) {
                $arr[] = "'" . dbesc($item['author_xchan']) . "'";
            }
        }
    }
    if (count($arr)) {
        if ($abook) {
            $chans = q(
                "select * from xchan left join hubloc on hubloc_hash = xchan_hash left join abook on abook_xchan = xchan_hash and abook_channel = %d
				where xchan_hash in (" . protect_sprintf(implode(',', $arr)) . ") and hubloc_deleted = 0 order by hubloc_primary desc",
                intval($item['uid'])
            );
        } else {
            $chans = q("select xchan.*,hubloc.* from xchan left join hubloc on hubloc_hash = xchan_hash
				where xchan_hash in (" . protect_sprintf(implode(',', $arr)) . ") and hubloc_deleted = 0 order by hubloc_primary desc");
        }
        $xchans = q("select * from xchan where xchan_hash in (" . protect_sprintf(implode(',', $arr)) . ") and xchan_network in ('rss','unknown', 'anon')");
        if (! $chans) {
            $chans = $xchans;
        } else {
            $chans = array_merge($xchans, $chans);
        }
    }

    if ($items && count($items) && $chans && count($chans)) {
        for ($x = 0; $x < count($items); $x++) {
            $items[$x]['owner'] = find_xchan_in_array($items[$x]['owner_xchan'], $chans);
            $items[$x]['author'] = find_xchan_in_array($items[$x]['author_xchan'], $chans);
        }
    }
}

function xchan_mail_query(&$item)
{
    $arr = [];
    $chans = null;
    if ($item) {
        if ($item['from_xchan'] && (! in_array("'" . dbesc($item['from_xchan']) . "'", $arr))) {
            $arr[] = "'" . dbesc($item['from_xchan']) . "'";
        }
        if ($item['to_xchan'] && (! in_array("'" . dbesc($item['to_xchan']) . "'", $arr))) {
            $arr[] = "'" . dbesc($item['to_xchan']) . "'";
        }
    }

    if (count($arr)) {
        $chans = q("select xchan.*,hubloc.* from xchan left join hubloc on hubloc_hash = xchan_hash
			where xchan_hash in (" . protect_sprintf(implode(',', $arr)) . ") and hubloc_primary = 1 and hubloc_deleted = 0");
    }
    if ($chans) {
        $item['from'] = find_xchan_in_array($item['from_xchan'], $chans);
        $item['to']  = find_xchan_in_array($item['to_xchan'], $chans);
    }
}


function find_xchan_in_array($xchan, $arr)
{
    if (count($arr)) {
        foreach ($arr as $x) {
            if ($x['xchan_hash'] === $xchan) {
                return $x;
            }
        }
    }
    return [];
}

function get_rel_link($j, $rel)
{
    if (is_array($j) && ($j)) {
        foreach ($j as $l) {
            if (is_array($l) && array_key_exists('rel', $l) && $l['rel'] === $rel && array_key_exists('href', $l)) {
                return $l['href'];
            }
        }
    }

    return '';
}


// Lots of code to write here

function magic_link($s)
{
    return $s;
}

/**
 * @brief If $escape is true, dbesc() each element before adding quotes.
 *
 * @param[in,out] array &$arr
 * @param bool $escape (optional) default false
 */
function stringify_array_elms(&$arr, $escape = false)
{
    for ($x = 0; $x < count($arr); $x++) {
        $arr[$x] = "'" . (($escape) ? dbesc($arr[$x]) : $arr[$x]) . "'";
    }
}


/**
 * @brief Similar to stringify_array_elms but returns a string. If $escape is true, dbesc() each element before adding quotes.
 *
 * @param array $arr
 * @param bool $escape (optional) default false
 * @return string
 */
function stringify_array($arr, $escape = false)
{
    if ($arr) {
        stringify_array_elms($arr, $escape);
        return(implode(',', $arr));
    }
    return EMPTY_STR;
}


/**
 * @brief Indents a flat JSON string to make it more human-readable.
 *
 * @param string $json The original JSON string to process.
 * @return string Indented version of the original JSON string.
 */
function jindent($json)
{

    $result    = '';
    $pos       = 0;
    $strLen    = strlen($json);
    $indentStr = '  ';
    $newLine   = "\n";
    $prevChar  = '';
    $outOfQuotes = true;

    if (is_array($json)) {
        btlogger('is an array', LOGGER_DATA);
        $json = json_encode($json, JSON_UNESCAPED_SLASHES);
    }

    for ($i = 0; $i <= $strLen; $i++) {
        // Grab the next character in the string.
        $char = substr($json, $i, 1);

        // Are we inside a quoted string?
        if ($char == '"' && $prevChar != '\\') {
            $outOfQuotes = !$outOfQuotes;
        }
        // If this character is the end of an element,
        // output a new line and indent the next line.
        elseif (($char == '}' || $char == ']') && $outOfQuotes) {
            $result .= $newLine;
            $pos--;
            for ($j = 0; $j < $pos; $j++) {
                $result .= $indentStr;
            }
        }

        // Add the character to the result string.
        $result .= $char;

        // If the last character was the beginning of an element,
        // output a new line and indent the next line.
        if (($char == ',' || $char == '{' || $char == '[') && $outOfQuotes) {
            $result .= $newLine;
            if ($char == '{' || $char == '[') {
                $pos++;
            }

            for ($j = 0; $j < $pos; $j++) {
                $result .= $indentStr;
            }
        }
        $prevChar = $char;
    }

    return $result;
}

/**
 * @brief Creates navigation menu for webpage, layout, blocks, menu sites.
 *
 * @return string with parsed HTML
 */
function design_tools()
{

    $channel  = Channel::from_id(App::$profile['profile_uid']);
    $sys = false;

    if (App::$is_sys && is_site_admin()) {
        require_once('include/channel.php');
        $channel = Channel::get_system();
        $sys = true;
    }

    $who = $channel['channel_address'];

    return replace_macros(Theme::get_template('design_tools.tpl'), [
        '$title'  => t('Design Tools'),
        '$who'    => $who,
        '$sys'    => $sys,
        '$blocks' => t('Blocks'),
        '$menus'  => t('Menus'),
        '$layout' => t('Layouts'),
        '$pages'  => t('Pages')
    ]);
}

/**
 * @brief Creates website portation tools menu
 *
 * @return string
 */
function website_portation_tools()
{

    $channel  = App::get_channel();
    $sys = false;

    if (App::$is_sys && is_site_admin()) {
        require_once('include/channel.php');
        $channel = Channel::get_system();
        $sys = true;
    }

    return replace_macros(Theme::get_template('website_portation_tools.tpl'), [
        '$title'               => t('Import'),
        '$import_label'        => t('Import website...'),
        '$import_placeholder'  => t('Select folder to import'),
        '$file_upload_text'    => t('Import from a zipped folder:'),
        '$file_import_text'    => t('Import from cloud files:'),
        '$desc'                => t('/cloud/channel/path/to/folder'),
        '$hint'                => t('Enter path to website files'),
        '$select'              => t('Select folder'),
        '$export_label'        => t('Export website...'),
        '$file_download_text'  => t('Export to a zip file'),
        '$filename_desc'       => t('website.zip'),
        '$filename_hint'       => t('Enter a name for the zip file.'),
        '$cloud_export_text'   => t('Export to cloud files'),
        '$cloud_export_desc'   => t('/path/to/export/folder'),
        '$cloud_export_hint'   => t('Enter a path to a cloud files destination.'),
        '$cloud_export_select' => t('Specify folder'),
    ]);
}

/**
 * @brief case insensitive in_array()
 *
 * @param string $needle
 * @param array $haystack
 * @return bool
 */
function in_arrayi($needle, $haystack)
{
    return in_array(strtolower($needle), array_map('strtolower', $haystack));
}

function normalise_openid($s)
{
    return trim(str_replace(['http://','https://'], ['',''], $s), '/');
}

/**
 * Used in ajax endless scroll request to find out all the args that the master page was viewing.
 * This was using $_REQUEST, but $_REQUEST also contains all your cookies. So we're restricting it
 * to $_GET and $_POST.
 *
 * @return string with additional URL parameters
 */
function extra_query_args()
{
    $s = '';
    if (count($_GET)) {
        foreach ($_GET as $k => $v) {
            // these are request vars we don't want to duplicate
            if (! in_array($k, ['req','f','zid','page','PHPSESSID'])) {
                $s .= '&' . $k . '=' . urlencode($v);
            }
        }
    }
    if (count($_POST)) {
        foreach ($_POST as $k => $v) {
            // these are request vars we don't want to duplicate
            if (! in_array($k, ['req','f','zid','page','PHPSESSID'])) {
                $s .= '&' . $k . '=' . urlencode($v);
            }
        }
    }

    return $s;
}

/**
 * @brief This function removes the tag $tag from the text $body and replaces it
 * with the appropiate link.
 *
 * @param App $a
 * @param[in,out] string &$body the text to replace the tag in
 * @param[in,out] string &$access_tag used to return tag ACL exclusions e.g. @!foo
 * @param[in,out] string &$str_tags string to add the tag to
 * @param int $profile_uid
 * @param string $tag the tag to replace
 * @param bool $in_network default true
 * @return bool|array
 */
function handle_tag(&$body, &$str_tags, $profile_uid, $tag, $in_network = true)
{

    $channel = App::get_channel();
    $replaced = false;
    $r = null;
    $match = [];

    $termtype = ((str_starts_with($tag, '#'))   ? TERM_HASHTAG  : TERM_UNKNOWN);
    $termtype = ((str_starts_with($tag, '@'))   ? TERM_MENTION  : $termtype);
    $termtype = ((str_starts_with($tag, '!'))   ? TERM_FORUM    : $termtype);

    // Is it a hashtag of some kind?

    if ($termtype == TERM_HASHTAG) {
        // if the tag is already replaced...
        if ((strpos($tag, '[zrl=')) || (strpos($tag, '[url='))) {
            // ...do nothing
            return $replaced;
        }

        if (! $replaced) {
            // double-quoted hashtags: base tag has the htmlentity name only

            if ((str_starts_with($tag, '#&quot;')) && (str_ends_with($tag, '&quot;'))) {
                $basetag = substr($tag, 7);
                $basetag = substr($basetag, 0, -6);
            } elseif ((str_starts_with($tag, '#"')) && (str_ends_with($tag, '"'))) {
                $basetag = substr($tag, 2);
                $basetag = substr($basetag, 0, -1);
            } else {
                $basetag = substr($tag, 1);
            }

            // create text for link

            $url = z_root() . '/search?tag=' . rawurlencode($basetag);
            $newtag = '#[zrl=' . z_root() . '/search?tag=' . rawurlencode($basetag) . ']' . $basetag . '[/zrl]';

            // replace tag by the link. Make sure to not replace something in the middle of a word

            $body = preg_replace('/(?<![a-zA-Z0-9=])' . preg_quote($tag, '/') . '/', $newtag, $body);
            $replaced = true;
        }

        // is the link already in str_tags?
        if (is_string($newtag) && ! stristr($str_tags, $newtag)) {
            // append or set str_tags
            if (strlen($str_tags)) {
                $str_tags .= ',';
            }

            $str_tags .= $newtag;
        }
        return [ [
            'replaced'   => $replaced,
            'termtype'   => $termtype,
            'term'       => $basetag,
            'url'        => $url,
            'contact'    => [],
            'access_tag' => '',
        ]];
    }

    // END hashtags

    // BEGIN mentions

    if (in_array($termtype, [TERM_MENTION, TERM_FORUM])) {
        // The @! tag will alter permissions

        // $in_network is set to false to avoid false positives on posts originating
        // on a network which does not implement privacy tags or implements them differently.

        $exclusive = (((str_starts_with(substr($tag, 1), '!')) && $in_network) ? true : false);

        // is it already replaced?
        if (strpos($tag, "[zrl=") || strpos($tag, "[url=")) {
            return $replaced;
        }

        // get the channel name
        // First extract the name or name fragment we are going to replace

        $name = substr($tag, (($exclusive) ? 2 : 1));
        $newname = $name; // make a copy that we can mess with
        $tagcid = 0;

        $r = null;

        // is it some generated (autocompleted) name?

        if (str_starts_with($name, '{') && str_ends_with($name, '}')) {
            $newname = substr($name, 1);
            $newname = substr($newname, 0, -1);

            $r = q(
                "select * from xchan where xchan_addr = '%s' or xchan_hash = '%s' or xchan_url = '%s'",
                dbesc($newname),
                dbesc($newname),
                dbesc($newname)
            );
        }

        if (! $r) {
            // look for matching names in the address book

            // Double quote the entire mentioned term to include special characters
            // such as spaces and some punctuation.

            // We see this after input filtering so quotes have been html entity encoded

            if ((str_starts_with($name, '&quot;')) && (str_ends_with($name, '&quot;'))) {
                $newname = substr($name, 6);
                $newname = substr($newname, 0, -6);
            } elseif ((str_starts_with($name, '"')) && (str_ends_with($name, '"'))) {
                $newname = substr($name, 1);
                $newname = substr($newname, 0, -1);
            }

            // select someone from this user's contacts by name

            $r = q(
                "SELECT * FROM abook left join xchan on abook_xchan = xchan_hash
				WHERE xchan_name = '%s' AND abook_channel = %d ",
                dbesc($newname),
                intval($profile_uid)
            );

            // select anybody by full hubloc_addr

            if ((! $r) && strpos($newname, '@')) {
                $r = q(
                    "SELECT * FROM xchan left join hubloc on xchan_hash = hubloc_hash
					WHERE hubloc_addr = '%s' and hubloc_deleted = 0 order by hubloc_id desc",
                    dbesc($newname)
                );
            }

            // select someone by attag or nick and the name passed in

            if (! $r) {
                // strip user-supplied wildcards before running a wildcard search
                $newname = str_replace('%', '', $newname);
                $r = q(
                    "SELECT * FROM abook left join xchan on abook_xchan = xchan_hash
					WHERE xchan_addr like ('%s') AND abook_channel = %d ",
                    dbesc(((strpos($newname, '@')) ? $newname : $newname . '@%')),
                    intval($profile_uid)
                );
            }
        }


        $fn_results = [];
        $access_tag = EMPTY_STR;

        // some platforms prefer to mention people by username rather than display name.
        // make this a personal choice by the publisher

        $tagpref = intval(PConfig::Get($profile_uid, 'system', 'tag_username', Config::Get('system', 'tag_username', false)));

        // $r is set if we found something

        if ($r) {
            if (array_key_exists('hubloc_network', $r)) {
                $r = [ Libzot::zot_record_preferred($r) ];
            } else {
                $r = [ Libzot::zot_record_preferred($r, 'xchan_network') ];
            }
        }

        if ($r) {
            foreach ($r as $xc) {
                $profile = $xc['xchan_url'];

                // $tagpref
                // 0 use display name
                // 1 use username@host
                // 2 use 'display name (username@host)'
                // 127 use display name outbound and don't change inbound

                $newname = $xc['xchan_name'];

                if ($tagpref === 1 && $xc['xchan_addr']) {
                    $newname = $xc['xchan_addr'];
                }
                if ($tagpref === 2 && $xc['xchan_addr']) {
                    $newname = sprintf(t('%1$s (%2$s)'), $xc['xchan_name'], $xc['xchan_addr']);
                }

                // add the channel's xchan_hash to $access_tag if exclusive
                if ($exclusive) {
                    $access_tag = 'cid:' . $xc['xchan_hash'];
                }

                // if there is a url for this channel

                if (isset($profile)) {
                    $replaced = true;
                    //create profile link
                    $profile = str_replace(',', '%2c', $profile);
                    $url = $profile;

					$zrl = (in_array($xc['xchan_network'], [ 'nomad', 'zot6' ]) ? 'zrl' : 'url');

                    if ($termtype === TERM_FORUM) {
    					$newtag = '!' . (($exclusive) ? '!' : '') . '[' . $zrl . '=' . $profile . ']' . $newname . '[/' . $zrl . ']';
	    				$body = str_replace('!' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
                    }


                    if ($termtype === TERM_MENTION) {
    					$newtag = '@' . (($exclusive) ? '!' : '') . '[' . $zrl . '=' . $profile . ']' . $newname . '[/' . $zrl . ']';
	    				$body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
                    }
    
                    // append tag to str_tags
                    if (! stristr($str_tags, $newtag)) {
                        if (strlen($str_tags)) {
                            $str_tags .= ',';
                        }
                        $str_tags .= $newtag;
                    }
                }


                $fn_results[] =  [
                    'replaced'   => $replaced,
                    'termtype'   => $termtype,
                    'term'       => $newname,
                    'url'        => $url,
                    'access_tag' => $access_tag,
                    'contact'    => (($r) ? $xc : []),
                ];
            }
        } else {
            // check for a group/collection exclusion tag

            // note that we aren't setting $replaced even though we're replacing text.
            // This tag isn't going to get a term attached to it. It's only used for
            // access control.

            if (local_channel() && local_channel() == $profile_uid) {
                $grp = AccessList::byname($profile_uid, $name);
                if ($grp) {
                    $g = q(
                        "select * from pgrp where id = %d and visible = 1 limit 1",
                        intval($grp)
                    );
                    if ($g && $exclusive) {
                        $access_tag .= 'gid:' . $g[0]['hash'];
                    }
                    $channel = App::get_channel();
                    if ($channel) {
                        $replaced = true;
                        $newname = $channel['channel_name'] . ' (' . $g[0]['gname'] . ')';
                        $newtag = '@' . (($exclusive) ? '!' : '') . '[zrl=' . z_root() . '/lists/view/' . $g[0]['hash'] . ']' . $newname . '[/zrl]';
                        $body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
                    }
                }
            }

            // if there is a url for this channel

            if (isset($profile)) {
                $replaced = true;
                //create profile link
                $profile = str_replace(',', '%2c', $profile);
                $url = $profile;

                $newtag = '@' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname . '[/zrl]';
                $body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);

                // append tag to str_tags
                if (! stristr($str_tags, $newtag)) {
                    if (strlen($str_tags)) {
                        $str_tags .= ',';
                    }
                    $str_tags .= $newtag;
                }
            }

            $fn_results[] = [
                'replaced'   => $replaced,
                'termtype'   => $termtype,
                'term'       => $newname,
                'url'        => $url,
                'access_tag' => $access_tag,
                'contact'    => [],
            ];
        }
    }

    return $fn_results;
}

function linkify_tags(&$body, $uid, $in_network = true)
{
    $str_tags = EMPTY_STR;
    $results = [];

    $tags = get_tags($body);

    if (is_array($tags) && count($tags)) {
        foreach ($tags as $tag) {
            $success = handle_tag($body, $str_tags, ($uid) ? $uid : App::$profile_uid, $tag, $in_network);

            foreach ($success as $handled_tag) {
                $results[] = [ 'success' => $handled_tag ];
            }
        }
    }

    return $results;
}

/**
 * @brief returns icon name for use with e.g. font-awesome based on mime-type.
 *
 * These are the the font-awesome names of version 3.2.1. The newer font-awesome
 * 4 has different names.
 *
 * @param string $type mime type
 * @return string
 * @todo rename to get_icon_from_type()
 */
function getIconFromType($type)
{
    $iconMap = [
        //Folder
        t('Collection') => 'fa-folder-o',
        'multipart/mixed' => 'fa-folder-o', //dirs in attach use this mime type
        //Common file
        'application/octet-stream' => 'fa-file-o',
        //Text
        'text/plain' => 'fa-file-text-o',
        'text/markdown' => 'fa-file-text-o',
        'text/bbcode' => 'fa-file-text-o',
        'text/x-multicode' => 'fa-file-text-o',
        'text/html' => 'fa-file-text-o',
        'application/msword' => 'fa-file-word-o',
        'application/pdf' => 'fa-file-pdf-o',
        'application/vnd.oasis.opendocument.text' => 'fa-file-word-o',
        'application/epub+zip' => 'fa-book',
        //Spreadsheet
        'application/vnd.oasis.opendocument.spreadsheet' => 'fa-file-excel-o',
        'application/vnd.ms-excel' => 'fa-file-excel-o',
        //Image
        'image/jpeg' => 'fa-picture-o',
        'image/png' => 'fa-picture-o',
        'image/gif' => 'fa-picture-o',
        'image/svg+xml' => 'fa-picture-o',
        //Archive
        'application/zip' => 'fa-file-archive-o',
        'application/x-rar-compressed' => 'fa-file-archive-o',
        //Audio
        'audio/mpeg' => 'fa-file-audio-o',
        'audio/wav' => 'fa-file-audio-o',
        'application/ogg' => 'fa-file-audio-o',
        'audio/ogg' => 'fa-file-audio-o',
        'audio/webm' => 'fa-file-audio-o',
        'audio/mp4' => 'fa-file-audio-o',
        //Video
        'video/quicktime' => 'fa-file-video-o',
        'video/webm' => 'fa-file-video-o',
        'video/mp4' => 'fa-file-video-o',
        'video/x-matroska' => 'fa-file-video-o'
    ];

    $catMap = [
        'application' => 'fa-file-code-o',
        'multipart'   => 'fa-folder',
        'audio'       => 'fa-file-audio-o',
        'video'       => 'fa-file-video-o',
        'text'        => 'fa-file-text-o',
        'image'       => 'fa=file-picture-o',
        'message'     => 'fa-file-text-o'
    ];


    $iconFromType = '';

    if (array_key_exists($type, $iconMap)) {
        $iconFromType = $iconMap[$type];
    } else {
        $parts = explode('/', $type);
        if ($parts[0] && $catMap[$parts[0]]) {
            $iconFromType = $catMap[$parts[0]];
        }
    }

    if (! $iconFromType) {
        $iconFromType = 'fa-file-o';
    }


    return $iconFromType;
}

/**
 * @brief Returns a human readable formatted string for filesizes.
 *
 * @param int $size filesize in bytes
 * @return string human readable formatted filesize
 */
function userReadableSize($size)
{
    $ret = '';
    if (is_numeric($size)) {
        $incr = 0;
        $k = 1024;
        $unit = ['bytes', 'KB', 'MB', 'GB', 'TB', 'PB'];
        while (($size / $k) >= 1) {
            $incr++;
            $size = round($size / $k, 2);
        }
        $ret = $size . ' ' . $unit[$incr];
    }

    return $ret;
}

function str_rot47($str)
{
    return strtr(
        $str,
        '!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~',
        'PQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNO'
    );
}


function string_replace($old, $new, &$s)
{

    $x = str_replace($old, $new, $s);
    $replaced = false;
    if ($x !== $s) {
        $replaced = true;
    }
    $s = $x;
    return $replaced;
}


function json_url_replace($old, $new, &$s)
{

    $old = str_replace('/', '\\/', $old);
    $new = str_replace('/', '\\/', $new);

    $x = str_replace($old, $new, $s);
    $replaced = false;
    if ($x !== $s) {
        $replaced = true;
    }
    $s = $x;
    return $replaced;
}


function item_url_replace($channel, &$item, $old, $new, $oldnick = '')
{

    if (isset($item['attach']) && $item['attach']) {
        $converted = false;
        if (is_array($item['attach'])) {
            $item['attach'] = item_json_encapsulate($item,'attach');
            $converted = true;
        }
        json_url_replace($old, $new, $item['attach']);
        if ($oldnick && ($oldnick !== $channel['channel_address'])) {
            json_url_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['attach']);
        }
        if ($converted) {
            $item['attach'] = json_decode($item['attach'],true);
        }
    }
    if ($item['obj']) {
        $converted = false;
        if (is_array($item['obj'])) {
            $item['obj'] = item_json_encapsulate($item,'obj');
            $converted = true;
        }
        json_url_replace($old, $new, $item['obj']);
        if ($oldnick && ($oldnick !== $channel['channel_address'])) {
            json_url_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['obj']);
        }
        if ($converted) {
            $item['obj'] = json_decode($item['obj'],true);
        }
    }
    if ($item['target']) {
        $converted = false;
        if (is_array($item['target'])) {
            $item['target'] = item_json_encapsulate($item,'target');
            $converted = true;
        }
        json_url_replace($old, $new, $item['target']);
        if ($oldnick && ($oldnick !== $channel['channel_address'])) {
            json_url_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['target']);
        }
        if ($converted) {
            $item['target'] = json_decode($item['target'],true);
        }
    }

    $item['body'] = str_replace($old, $new, $item['body']);

    if ($oldnick && ($oldnick !== $channel['channel_address'])) {
        $item['body'] = str_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['body']);
    }

    $item['sig'] = Libzot::sign($item['body'], $channel['channel_prvkey']);
    $item['item_verified'] = 1;

    if (isset($item['plink'])) {
        $item['plink'] = str_replace($old, $new, $item['plink']);
        if ($oldnick && ($oldnick !== $channel['channel_address'])) {
            $item['plink'] = str_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['plink']);
        }
    }

    if (isset($item['llink'])) {
        $item['llink'] = str_replace($old, $new, $item['llink']);
        if ($oldnick && ($oldnick !== $channel['channel_address'])) {
            $item['llink'] = str_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['llink']);
        }
    }

    if (isset($item['term']) && is_array($item['term'])) {
        for ($x = 0; $x < count($item['term']); $x++) {
            $item['term'][$x]['url'] =  str_replace($old, $new, $item['term'][$x]['url']);
            if ($oldnick && ($oldnick !== $channel['channel_address'])) {
                $item['term'][$x]['url'] = str_replace('/' . $oldnick . '/', '/' . $channel['channel_address'] . '/', $item['term'][$x]['url']);
            }
        }
    }
}


/**
 * @brief Used to wrap ACL elements in angle brackets for storage.
 *
 * @param[in,out] array &$item
 */
function sanitise_acl(&$item)
{
    if (strlen($item)) {
        $item = '<' . notags(trim(urldecode($item))) . '>';
    } else {
        unset($item);
    }
}

/**
 * @brief Convert an ACL array to a storable string.
 *
 * @param array $p
 * @return string
 */
function perms2str($p)
{
    if ($p) {
        $tmp = is_array($p) ? $p : explode(',', (string)$p);
        array_walk($tmp, 'sanitise_acl');
        return implode('', $tmp);
    }
    return '';
}

/**
 * @brief Turn user/group ACLs stored as angle bracketed text into arrays.
 *
 * turn string array of angle-bracketed elements into string array
 * e.g. "<123xyz><246qyo><sxo33e>" => [ '123xyz','246qyo','sxo33e' ];
 *
 * @param string $s
 * @return array
 */
function expand_acl($s)
{
    $ret = [];

    if (strlen($s)) {
        $t = str_replace('<', '', $s);
        $a = explode('>', $t);
        foreach ($a as $aa) {
            if ($aa) {
                $ret[] = $aa;
            }
        }
    }

    return $ret;
}

function acl2json($s)
{
    $s = expand_acl($s);
    $s = json_encode($s);

    return $s;
}

/**
 * @brief When editing a webpage - a dropdown is needed to select a page layout
 *
 * On submit, the pdl_select value (which is the mid of an item with item_type = ITEM_TYPE_PDL)
 * is stored in the webpage's resource_id, with resource_type 'pdl'.
 *
 * Then when displaying a webpage, we can see if it has a pdl attached. If not we'll
 * use the default site/page layout.
 *
 * If it has a pdl we'll load it as we know the mid and pass the body through comanche_parser() which will generate the
 * page layout from the given description
 *
 * @FIXME - there is apparently a very similar function called layout_select; this one should probably take precedence
 * and the other should be checked for compatibility and removed
 *
 * @param int $uid
 * @param string $current
 * @return string HTML code for dropdown
 */
function pdl_selector($uid, $current = '')
{
    $o = '';

    $sql_extra = item_permissions_sql($uid);

    $r = q(
        "select iconfig.*, mid from iconfig left join item on iconfig.iid = item.id
		where item.uid = %d and iconfig.cat = 'system' and iconfig.k = 'PDL' $sql_extra order by v asc",
        intval($uid)
    );

    $arr = ['channel_id' => $uid, 'current' => $current, 'entries' => $r];
    Hook::call('pdl_selector', $arr);

    $entries = $arr['entries'];
    $current = $arr['current'];

    $o .= '<select name="pdl_select" id="pdl_select" size="1">';
    $entries[] = ['title' => t('Default'), 'mid' => ''];
    foreach ($entries as $selection) {
        $selected = (($selection == $current) ? ' selected="selected" ' : '');
        $o .= "<option value=\"{$selection['mid']}\" $selected >{$selection['v']}</option>";
    }

    $o .= '</select>';
    return $o;
}

/**
 * @brief returns a one-dimensional array from a multi-dimensional array
 * empty values are discarded
 *
 * example: print_r(flatten_array_recursive(array('foo','bar',array('baz','blip',array('zob','glob')),'','grip')));
 *
 * Array ( [0] => foo [1] => bar [2] => baz [3] => blip [4] => zob [5] => glob [6] => grip )
 *
 * @param array $arr multi-dimensional array
 * @return array
 */
function flatten_array_recursive($arr)
{

    $ret = [];

    if (! ($arr && is_array($arr))) {
        return $ret;
    }

    foreach ($arr as $a) {
        if (is_array($a)) {
            $tmp = flatten_array_recursive($a);
            if ($tmp) {
                $ret = array_merge($ret, $tmp);
            }
        } elseif (isset($a)) {
            $ret[] = $a;
        }
    }

    return($ret);
}

/**
 * @brief Highlight Text.
 *
 * @param string $s Text to highlight
 * @param string $lang Which language should be highlighted
 * @return string
 *     Important: The returned text has the text pattern 'http' translated to '%eY9-!' which should be converted back
 * after further processing. This was done to prevent oembed links from occurring inside code blocks.
 * See include/bbcode.php
 */
function text_highlight($s, $lang, $options)
{

    if ($lang === 'js') {
        $lang = 'javascript';
    }

    if ($lang === 'json') {
        $lang = 'javascript';
        if (! strpos(trim($s), "\n")) {
            $s = jindent($s);
        }
    }

    $arr = [
            'text' => $s,
            'language' => $lang,
            'options'  => $options,
            'success'  => false
    ];

    /**
     * @hooks text_highlight
     *   * \e string \b text
     *   * \e string \b language
     *   * \e boolean \b success default false
     */
    Hook::call('text_highlight', $arr);

    if ($arr['success']) {
        $o = $arr['text'];
    } else {
        $o = $s;
    }

    $o = str_replace('http', '%eY9-!', $o);

    return('<code>' . $o . '</code>');
}

// function to convert multi-dimensional array to xml
// create new instance of simplexml

// $xml = new SimpleXMLElement('<root/>');

// function callback
// array2XML($xml, $my_array);

// save as xml file
// echo (($xml->asXML('data.xml')) ? 'Your XML file has been generated successfully!' : 'Error generating XML file!');

function arrtoxml($root_elem, $arr)
{
    $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><' . $root_elem . '></' . $root_elem . '>', null, false);
    array2XML($xml, $arr);

    return $xml->asXML();
}

function array2XML($obj, $array)
{
    foreach ($array as $key => $value) {
        if (is_numeric($key)) {
            $key = 'item' . $key;
        }

        if (is_array($value)) {
            $node = $obj->addChild($key);
            array2XML($node, $value);
        } else {
            $obj->addChild($key, htmlspecialchars($value));
        }
    }
}

/**
 * @brief Inserts an array into $table.
 *
 *
 * @param string $table
 * @param array $arr
 * @param array $binary_fields - fields which will be cleansed with dbescbin rather than dbesc; this is critical for postgres
 * @return bool|PDOStatement
 */
function create_table_from_array($table, $arr, $binary_fields = [])
{

    if (! ($arr && $table)) {
        return false;
    }

    $columns = db_columns($table);

    $clean = [];
    foreach ($arr as $k => $v) {
        if (! in_array($k, $columns)) {
            continue;
        }

        $matches = false;
        if (preg_match('/([^a-zA-Z0-9\-\_\.])/', $k, $matches)) {
            return false;
        }
        if (in_array($k, $binary_fields)) {
            $clean[$k] = dbescbin($v);
        } else {
            $clean[$k] = dbesc($v);
        }
    }
    q("START TRANSACTION");
    $r = dbq("INSERT INTO " . TQUOT . $table . TQUOT . " (" . TQUOT
        . implode(TQUOT . ', ' . TQUOT, array_keys($clean))
        . TQUOT . ") VALUES ('"
        . implode("', '", array_values($clean))
        . "')");
    if ($r) {
        q("COMMIT");
    } else {
        q("ROLLBACK");
    }

    return $r;
}



function update_table_from_array($table, $arr, $where, $binary_fields = [])
{

    if (! ($arr && $table)) {
        return false;
    }

    $columns = db_columns($table);

    $clean = [];
    foreach ($arr as $k => $v) {
        if (! in_array($k, $columns)) {
            continue;
        }

        $matches = false;
        if (preg_match('/([^a-zA-Z0-9\-\_\.])/', $k, $matches)) {
            return false;
        }
        if (in_array($k, $binary_fields)) {
            $clean[$k] = dbescbin($v);
        } else {
            $clean[$k] = dbesc($v);
        }
    }
    $sql = "UPDATE " . TQUOT . $table . TQUOT . " SET ";
    foreach ($clean as $k => $v) {
        $sql .= TQUOT . $k . TQUOT . ' = "' . $v . '",';
    }
    $sql = rtrim($sql,',');
    $r = dbq($sql . " WHERE " . $where);

    return $r;
}


function share_shield($m)
{
    return str_replace($m[1], '!=+=+=!' . base64url_encode($m[1]) . '=+!=+!=', $m[0]);
}

function share_unshield($m)
{
    $x = str_replace(['!=+=+=!','=+!=+!='], ['',''], $m[1]);
    return str_replace($m[1], base64url_decode($x), $m[0]);
}

function wrap_code($body)
{
    // purify angle chars and brackets in alt text
    $matches = null;
    $c = preg_match('/alt\=\"(.*?)\"/ism',$body,$matches);
    if ($c) {
        $alt_tag = str_replace([ '[', ']', '<', '>' ], ['%5B', '%5D', '&lt;', '&gt;'], $matches[1]);
        $body = str_replace($matches[1],$alt_tag,$body);
    }

    // markdown code blocks are slightly more complicated to escape from linkifiers

    $body = preg_replace_callback('#(^|\n| )(?<!\\\)`([^\n`]+?)`#', function ($match) {
        return $match[1] . '`' . bb_code_protect($match[2]) . '`';
    }, $body);

    $body = preg_replace_callback('#(^|\n)([`~]{3,})(?: *\.?([a-zA-Z0-9\-.]+))?\n+([\s\S]+?)\n+\2(\n|$)#', function ($match) {
        return $match[1] . $match[2] . "\n" . bb_code_protect($match[4]) . "\n" . $match[2] . (($match[5]) ?: "\n");
    }, $body);

    // and of course HTML code blocks
    $body = preg_replace_callback('#<code>(.*?)</code>#', function ($match) {
        return '<code>' . bb_code_protect($match[1]) . '</code>';
    }, $body);


    $body = preg_replace_callback('/\[code(.*?)\[\/(code)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[url(.*?)\[\/(url)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[zrl(.*?)\[\/(zrl)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[svg(.*?)\[\/(svg)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[img(.*?)\[\/(img)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[zmg(.*?)\[\/(zmg)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[audio(.*?)\[\/(audio)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[video(.*?)\[\/(video)\]/ism', '\red_escape_codeblock', $body);
    $body = preg_replace_callback('/\[oembed(.*?)\[\/(oembed)\]/ism', '\red_escape_codeblock', $body);

    return $body;
}

function unwrap_code($body)
{

    $body = preg_replace_callback('/\[\$b64code(.*?)\[\/(code)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64url(.*?)\[\/(url)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64zrl(.*?)\[\/(zrl)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64svg(.*?)\[\/(svg)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64img(.*?)\[\/(img)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64zmg(.*?)\[\/(zmg)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64audio(.*?)\[\/(audio)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64video(.*?)\[\/(video)\]/ism', '\red_unescape_codeblock', $body);
    $body = preg_replace_callback('/\[\$b64oembed(.*?)\[\/(oembed)\]/ism', '\red_unescape_codeblock', $body);

    $body = bb_code_unprotect($body);

    // fix any img tags that should be zmg

    $body = preg_replace_callback('/\[img(.*?)\](.*?)\[\/img\]/ism', '\red_zrlify_img_callback', $body);

    $body = bb_translate_video($body);

    /**
     * Fold multi-line [code] sequences
     */

    $body = preg_replace('/\[\/code\]\s*\[code\]/ism', "\n", $body);

    return $body;

}

function cleanup_bbcode($body)
{

    $body = preg_replace_callback("/([^\]\[\='" . '"' . "\;\/\{\(]|^|\#\^)(https?\:\/\/[a-zA-Z0-9\pL\:\/\-\?\&\;\.\=\@\_\~\#\%\$\!\\+\,\(\)]+)/ismu", '\nakedoembed', $body);

    $body = preg_replace_callback("/([^\]\[\='" . '"' . "\;\/\{\(]|^|\#\^)(https?\:\/\/[a-zA-Z0-9\pL\:\/\-\?\&\;\.\=\@\_\~\#\%\$\!\\+\,\(\)]+)/ismu", '\red_zrl_callback', $body);

    return $body;
}

function gen_link_id($mid)
{
    $mid = safe_param($mid);
//    if (strpbrk($mid, ':/&?<>"\'') !== false) {
//        return 'b64.' . base64url_encode($mid);
//    }
    return $mid;
}

function unpack_link_id($mid)
{
    $mid = decode_safe_param($mid);
    if (str_starts_with($mid, 'b64.')) {
        $mid = base64url_decode(preg_replace('/[^A-Za-z0-9\-_].*/', '', substr($mid, 4)));
    }
    return $mid;
}

function safe_param($s) {
    return str_replace( ['?', '&', '<', '>', '=', '"', '\'', '#', '%20' ], [ '{3F}', '{26}', '{3C}', '{3E}', '{3D}', '{22}', '{27}' , '{23}', '{20}'], $s);
}

function decode_safe_param($s) {
    return str_replace( [ '{3F}', '{26}', '{3C}', '{3E}', '{3D}', '{22}', '{27}', '{23}', '{20}' ], ['?', '&', '<', '>', '=', '"', '\'', '#', '%20' ], $s);
}

// callback for array_walk

function array_trim(&$v, $k)
{
    $v = trim($v);
}

function array_escape_tags(&$v, $k)
{
    $v = escape_tags($v);
}

function ellipsify($s, $maxlen)
{
    if ($maxlen & 1) {
        $maxlen--;
    }
    if ($maxlen < 4) {
        $maxlen = 4;
    }

    if (mb_strlen($s) < $maxlen) {
        return $s;
    }

    return mb_substr($s, 0, $maxlen / 2) . '...' . mb_substr($s, mb_strlen($s) - ($maxlen / 2));
}

function purify_filename($s)
{
    if (($s[0] === '.') || str_contains($s, '/')) {
        return '';
    }
    return $s;
}

// callback for sorting the settings/featured entries.

function featured_sort($a, $b)
{
    $s1 = substr($a, strpos($a, 'id='), 20);
    $s2 = substr($b, strpos($b, 'id='), 20);
    return(strcmp($s1, $s2));
}


function unpunify($s)
{
    if (function_exists('idn_to_utf8') && isset($s)) {
        return idn_to_utf8($s);
    }
    return $s;
}


function punify($s)
{
    if (function_exists('idn_to_ascii') && isset($s)) {
        return idn_to_ascii($s);
    }
    return $s;
}



function unique_multidim_array($array, $key)
{
    $temp_array = [];
    $i = 0;
    $key_array = [];

    foreach ($array as $val) {
        if (!in_array($val[$key], $key_array)) {
            $key_array[$i] = $val[$key];
            $temp_array[$i] = $val;
        }
        $i++;
    }
    return $temp_array;
}

// Much prettier formatting than print_r()
// This assumes the output will be a web page and escapes angle-chars appropriately by default.


function print_array($arr, $escape = true, $level = 0)
{

    $o = EMPTY_STR;
    $tabs = EMPTY_STR;

    if (is_array($arr)) {
        for ($x = 0; $x <= $level; $x++) {
            $tabs .= "\t";
        }
        $o .= '[' . "\n";
        if (count($arr)) {
            foreach ($arr as $k => $v) {
                if (is_array($v)) {
                    $o .= $tabs . '[' . (($escape) ? escape_tags($k) : $k) . '] => ' . print_array($v, $escape, $level + 1) . "\n";
                } else {
                    $o .= $tabs . '[' . (($escape) ? escape_tags($k) : $k)  . '] => ' . print_val($v, $escape) . ",\n";
                }
            }
        }
        $o .= substr($tabs, 0, -1) . ']' . (($level) ? ',' : ';' ) . "\n";
        return $o;
    }
}

function print_val($v, $escape = true)
{
    if (is_bool($v)) {
        if ($v) {
            return 'true';
        }
        return 'false';
    }
    if (is_string($v)) {
        return "'" . (($escape) ? escape_tags($v) : $v) . "'";
    }
    return $v;
}


function array_path_exists($str, $arr)
{

    if (! (isset($arr) && is_array($arr))) {
        return false;
    }

    $ptr = $arr;
    $search = explode('/', $str);

    if ($search) {
        foreach ($search as $s) {
            if ($ptr && is_array($ptr) && array_key_exists($s, $ptr)) {
                $ptr = $ptr[$s];
            } else {
                return false;
            }
        }
        return true;
    }
    return false;
}

function get_forum_channels($uid, $collections = 0)
{

    if (! $uid) {
        return false;
    }

    if ($collections) {
        $pagetype = $collections;
    } else {
        $pagetype = 1;
    }

    $r = q(
        "select abook_id, xchan_hash, xchan_network, xchan_name, xchan_url, xchan_photo_s from abook left join xchan on abook_xchan = xchan_hash where xchan_deleted = 0 and abook_channel = %d and abook_pending = 0 and abook_ignored = 0 and abook_blocked = 0 and abook_archived = 0 and abook_self = 0 and xchan_type = %d order by xchan_name",
        intval($uid),
        intval($pagetype)
    );

    return $r;
}


function serialise($x)
{
    return ((is_array($x)) ? 'json:' . json_encode($x) : $x);
}

function unserialise($x)
{
    if (is_array($x)) {
        return $x;
    }
    $y = ((str_starts_with($x, 'json:')) ? json_decode(substr($x, 5), true) : '');
    return ((is_array($y)) ? $y : $x);
}


function obscurify($s)
{
    return str_rot47(base64url_encode($s));
}


function unobscurify($s)
{
    return base64url_decode(str_rot47($s));
}

/** @noinspection HtmlUnknownAttribute */
function svg2bb($s)
{

    $s = preg_replace("/\<text (.*?)\>(.*?)\<(.*?)\<\/text\>/", '<text $1>$2&lt;$3</text>', $s);
    $s = preg_replace("/\<text (.*?)\>(.*?)\>(.*?)\<\/text\>/", '<text $1>$2&gt;$3</text>', $s);
    $s = preg_replace("/\<text (.*?)\>(.*?)\[(.*?)\<\/text\>/", '<text $1>$2&#91;$3</text>', $s);
    $s = preg_replace("/\<text (.*?)\>(.*?)\](.*?)\<\/text\>/", '<text $1>$2&#93;$3</text>', $s);
    // Deprecated in php 8.2, but we may not need it at all.
    // $s = utf8_encode($s);
    $purify = new SvgSanitizer();
    if ($purify->loadXML($s)) {
        $purify->sanitize();
        $output = $purify->saveSVG();
        $output = preg_replace("/\<\?xml(.*?)\>/", '', $output);
        $output = preg_replace("/\<\!\-\-(.*?)\-\-\>/", '', $output);
        $output = str_replace(['<','>'], ['[',']'], $output);
        return $output;
    }
    return EMPTY_STR;
}

// Takes something that looks like a phone number and returns a string suitable for tel: protocol or false.

function is_phone_number($s)
{
    $ext = substr($s, strpos($s, 'x') + 1);
    if (! $ext) {
        $ext = substr($s, strpos($s, 'X') + 1);
    }
    if ($ext && ctype_digit($ext)) {
        $rext = ';ext=' . $ext;
        $s = str_replace(['x' . $ext, 'X' . $ext], ['',''], $s);
    } else {
        $ext = EMPTY_STR;
    }
    $s = str_replace(['(',')',' ','-','+'], ['','','','',''], $s);
    return ((ctype_digit($s)) ? $s . $rext : false);
}

/**
 * fnmatch seems a bit unpredictable, so use this instead.
 */

function wildmat($pattern, $string)
{
    return preg_match("#^" . strtr(preg_quote($pattern, '#'), [ '\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']' ]) . "$#i", $string);
}

function unicode_trim($s) {
    return preg_replace('/^[\pZ\pC]+|[\pZ\pC]+$/u', '', $s);
}

// Using a regex to remove share content fails if it is a recursive share.
// Few people can read and uderstand a recursive regex, and they also suck up
// resources; so we'll accomplish this with generic string processing instead.
function strip_share_content($str)
{
    $output = $str;
    $begin = strpos($str, '[share');
    $end = strrpos($str, '[/share]');
    if ($begin && $end) {
        $output = substr($str, 0, $begin)
            . substr($str, $end + strlen('[/share]'));
    }
    return $output;
}