1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 

<?php
/**
 * This file contains core of the code for Mentions
 *
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines http://www.simplemachines.org
 * @copyright 2019 Simple Machines and individual contributors
 * @license http://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 RC1
 */

/**
 * This really is a pseudo class, I couldn't justify having instance of it
 * while mentioning so I just made every method static
 */
class Mentions
{
    protected static $char = '@';

    /**
     * Returns mentions for a specific content
     *
     * @static
     * @access public
     * @param string $content_type The content type
     * @param int $content_id The ID of the desired content
     * @param array $members Whether to limit to a specific sect of members
     * @return array An array of arrays containing info about each member mentioned
     */
    public static function getMentionsByContent($content_type, $content_id, array $members = array())
    {
        global $smcFunc;

        $request = $smcFunc['db_query']('', '
            SELECT mem.id_member, mem.real_name, mem.email_address, mem.id_group, mem.id_post_group, mem.additional_groups,
                mem.lngfile, ment.id_member AS id_mentioned_by, ment.real_name AS mentioned_by_name
            FROM {db_prefix}mentions AS m
                INNER JOIN {db_prefix}members AS mem ON (mem.id_member = m.id_mentioned)
                INNER JOIN {db_prefix}members AS ment ON (ment.id_member = m.id_member)
            WHERE content_type = {string:type}
                AND content_id = {int:id}' . (!empty($members) ? '
                AND mem.id_member IN ({array_int:members})' : ''),
            array(
                'type' => $content_type,
                'id' => $content_id,
                'members' => (array) $members,
            )
        );
        $members = array();
        while ($row = $smcFunc['db_fetch_assoc']($request))
            $members[$row['id_member']] = array(
                'id' => $row['id_member'],
                'real_name' => $row['real_name'],
                'email_address' => $row['email_address'],
                'groups' => array_unique(array_merge(array($row['id_group'], $row['id_post_group']), explode(',', $row['additional_groups']))),
                'mentioned_by' => array(
                    'id' => $row['id_mentioned_by'],
                    'name' => $row['mentioned_by_name'],
                ),
                'lngfile' => $row['lngfile'],
            );
        $smcFunc['db_free_result']($request);

        return $members;
    }

    /**
     * Inserts mentioned members
     *
     * @static
     * @access public
     * @param string $content_type The content type
     * @param int $content_id The ID of the specified content
     * @param array $members An array of members who have been mentioned
     * @param int $id_member The ID of the member who mentioned them
     */
    public static function insertMentions($content_type, $content_id, array $members, $id_member)
    {
        global $smcFunc;

        call_integration_hook('mention_insert_' . $content_type, array($content_id, &$members));

        foreach ($members as $member)
            $smcFunc['db_insert']('ignore',
                '{db_prefix}mentions',
                array('content_id' => 'int', 'content_type' => 'string', 'id_member' => 'int', 'id_mentioned' => 'int', 'time' => 'int'),
                array((int) $content_id, $content_type, $id_member, $member['id'], time()),
                array('content_id', 'content_type', 'id_mentioned')
            );
    }

    /**
     * Gets appropriate mentions replaced in the body
     *
     * @static
     * @access public
     * @param string $body The text to look for mentions in
     * @param array $members An array of arrays containing info about members (each should have 'id' and 'member')
     * @return string The body with mentions replaced
     */
    public static function getBody($body, array $members)
    {
        foreach ($members as $member)
            $body = str_ireplace(static::$char . $member['real_name'], '[member=' . $member['id'] . ']' . $member['real_name'] . '[/member]', $body);

        return $body;
    }

    /**
     * Takes a piece of text and finds all the mentioned members in it
     *
     * @static
     * @access public
     * @param string $body The body to get mentions from
     * @return array An array of arrays containing members who were mentioned (each has 'id_member' and 'real_name')
     */
    public static function getMentionedMembers($body)
    {
        global $smcFunc;

        $possible_names = self::getPossibleMentions($body);

        if (empty($possible_names) || !allowedTo('mention'))
            return array();

        $request = $smcFunc['db_query']('', '
            SELECT id_member, real_name
            FROM {db_prefix}members
            WHERE real_name IN ({array_string:names})
            ORDER BY LENGTH(real_name) DESC
            LIMIT {int:count}',
            array(
                'names' => $possible_names,
                'count' => count($possible_names),
            )
        );
        $members = array();
        while ($row = $smcFunc['db_fetch_assoc']($request))
        {
            if (stripos($body, static::$char . $row['real_name']) === false)
                continue;

            $members[$row['id_member']] = array(
                'id' => $row['id_member'],
                'real_name' => $row['real_name'],
            );
        }
        $smcFunc['db_free_result']($request);

        return $members;
    }

    /**
     * Parses a body in order to see if there are any mentions, returns possible mention names
     *
     * Names are tagged by "@<username>" format in post, but they can contain
     * any type of character up to 60 characters length. So we extract, starting from @
     * up to 60 characters in length (or if we encounter a line break) and make
     * several combination of strings after splitting it by anything that's not a word and join
     * by having the first word, first and second word, first, second and third word and so on and
     * search every name.
     *
     * One potential problem with this is something like "@Admin Space" can match
     * "Admin Space" as well as "Admin", so we sort by length in descending order.
     * One disadvantage of this is that we can only match by one column, hence I've chosen
     * real_name since it's the most obvious.
     *
     * If there's an @ symbol within the name, it is counted in the ongoing string and a new
     * combination string is started from it as well in order to account for all the possibilities.
     * This makes the @ symbol to not be required to be escaped
     *
     * @static
     * @access protected
     * @param string $body The text to look for mentions in
     * @return array An array of names of members who have been mentioned
     */
    protected static function getPossibleMentions($body)
    {
        global $smcFunc;

        // preparse code does a few things which might mess with our parsing
        $body = htmlspecialchars_decode(preg_replace('~<br\s*/?\>~', "\n", str_replace('&nbsp;', ' ', $body)), ENT_QUOTES);

        // Remove quotes, we don't want to get double mentions.
        while (preg_match('~\[quote[^\]]*\](.+?)\[\/quote\]~s', $body))
            $body = preg_replace('~\[quote[^\]]*\](.+?)\[\/quote\]~s', '', $body);

        $matches = array();
        $string = str_split($body);
        $depth = 0;
        foreach ($string as $k => $char)
        {
            if ($char == static::$char && ($k == 0 || trim($string[$k - 1]) == ''))
            {
                $depth++;
                $matches[] = array();
            }
            elseif ($char == "\n")
                $depth = 0;

            for ($i = $depth; $i > 0; $i--)
            {
                if (count($matches[count($matches) - $i]) > 60)
                {
                    $depth--;
                    continue;
                }
                $matches[count($matches) - $i][] = $char;
            }
        }

        foreach ($matches as $k => $match)
            $matches[$k] = substr(implode('', $match), 1);

        // Names can have spaces, other breaks, or they can't...we try to match every possible
        // combination.
        $names = array();
        foreach ($matches as $match)
        {
            $match = preg_split('/([^\w])/', $match, -1, PREG_SPLIT_DELIM_CAPTURE);
            $count = count($match);

            for ($i = 1; $i <= $count; $i++)
                $names[] = $smcFunc['htmlspecialchars']($smcFunc['htmltrim'](implode('', array_slice($match, 0, $i))));
        }

        $names = array_unique($names);

        return $names;
    }
}

?>