elkarte / Elkarte

sources/subs/News.subs.php

<?php

/**
 * Functions to help with managing the site news and newsletters
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * This file contains code covered by:
 * copyright: 2011 Simple Machines (http://www.simplemachines.org)
 *
 * @version 2.0 dev
 *
 */

use BBC\ParserWrapper;
use ElkArte\Helper\Util;

/**
 * Prepares an array of the forum news items
 *
 * @return array
 * @package News
 */
function getNews()
{
	global $modSettings;

	$admin_current_news = [];

	$bbc_parser = ParserWrapper::instance();

	// Ready the current news.
	foreach (explode("\n", $modSettings['news']) as $id => $line)
	{
		$admin_current_news[$id] = [
			'id' => $id,
			'unparsed' => un_preparsecode($line),
			'parsed' => preg_replace('~<([/]?)form[^>]*?[>]*>~i', '<em class="smalltext">&lt;$1form&gt;</em>', $bbc_parser->parseNews($line)),
		];
	}

	$admin_current_news['last'] = [
		'id' => 'last',
		'unparsed' => '',
		'parsed' => '<div id="moreNewsItems_preview"></div>',
	];

	return $admin_current_news;
}

/**
 * Get a list of all full banned users.
 *
 * - Use their Username and email to find them.
 * - Only get the ones that can't login to turn off notification.
 *
 * @return array
 * @package News
 */
function excludeBannedMembers()
{
	$db = database();

	$excludes = [];
	$db->fetchQuery('
		SELECT 
			DISTINCT mem.id_member
		FROM {db_prefix}ban_groups AS bg
			INNER JOIN {db_prefix}ban_items AS bi ON (bg.id_ban_group = bi.id_ban_group)
			INNER JOIN {db_prefix}members AS mem ON (bi.id_member = mem.id_member)
		WHERE (bg.cannot_access = {int:cannot_access} OR bg.cannot_login = {int:cannot_login})
			AND (bg.expire_time IS NULL OR bg.expire_time > {int:current_time})',
		[
			'cannot_access' => 1,
			'cannot_login' => 1,
			'current_time' => time(),
		]
	)->fetch_callback(
		function ($row) use (&$excludes) {
			$excludes[] = $row['id_member'];
		}
	);

	$condition_array = [];
	$condition_array_params = [];
	$count = 0;
	$db->fetchQuery('
		SELECT DISTINCT bi.email_address
		FROM {db_prefix}ban_items AS bi
			INNER JOIN {db_prefix}ban_groups AS bg ON (bg.id_ban_group = bi.id_ban_group)
		WHERE (bg.cannot_access = {int:cannot_access} OR bg.cannot_login = {int:cannot_login})
			AND (bg.expire_time IS NULL OR bg.expire_time > {int:current_time})
			AND bi.email_address != {string:blank_string}',
		[
			'cannot_access' => 1,
			'cannot_login' => 1,
			'current_time' => time(),
			'blank_string' => '',
		]
	)->fetch_callback(
		function ($row) use (&$condition_array, &$condition_array_params, &$count) {
			$condition_array[] = '{string:email_' . $count . '}';
			$condition_array_params['email_' . ($count++)] = $row['email_address'];
		}
	);

	if (!empty($condition_array))
	{
		$db->fetchQuery('
			SELECT 
				id_member
			FROM {db_prefix}members
			WHERE email_address IN(' . implode(', ', $condition_array) . ')',
			$condition_array_params
		)->fetch_callback(
			function ($row) use (&$excludes) {
				$excludes[] = $row['id_member'];
			}
		);
	}

	return $excludes;
}

/**
 * Get a list of our local board moderators.
 *
 * @return array
 * @package News
 */
function getModerators()
{
	$db = database();

	$mods = [];

	$db->fetchQuery('
		SELECT 
			DISTINCT mem.id_member AS identifier
		FROM {db_prefix}members AS mem
			INNER JOIN {db_prefix}moderators AS mods ON (mods.id_member = mem.id_member)
		WHERE mem.is_activated = {int:is_activated}',
		[
			'is_activated' => 1,
		]
	)->fetch_callback(
		function ($row) use (&$mods) {
			$mods[] = $row['identifier'];
		}
	);

	return $mods;
}

/**
 * Lists our newsletter recipients, step by step.
 *
 * @param string $sendQuery
 * @param array $sendParams
 * @param int $start
 * @param int $increment
 * @param int $counter
 * @return array
 * @package News
 */
function getNewsletterRecipients($sendQuery, $sendParams, $start, $increment, $counter)
{
	$db = database();

	$recipients = [];

	$db->fetchQuery('
		SELECT 
			mem.id_member, mem.email_address, mem.real_name, mem.id_group, mem.additional_groups, mem.id_post_group
		FROM {db_prefix}members AS mem
		WHERE mem.id_member > {int:min_id_member}
			AND mem.id_member < {int:max_id_member}
			AND ' . $sendQuery . '
			AND mem.is_activated = {int:is_activated}
		ORDER BY mem.id_member ASC
		LIMIT {int:atonce}',
		array_merge($sendParams, [
			'min_id_member' => $start,
			'max_id_member' => $start + $increment - $counter,
			'atonce' => $increment - $counter,
			'regular_group' => 0,
			'notify_announcements' => 1,
			'is_activated' => 1,
		])
	)->fetch_callback(
		function ($row) use (&$recipients) {
			$recipients[] = $row;
		}
	);

	return $recipients;
}

/**
 * Find the latest posts that:
 * - are the first post in their topic.
 * - are on an any board OR in a specified board.
 * - can be seen by this user.
 * - are actually the latest posts.
 *
 * @param string $query_this_board passed to query, assumed raw and inserted as such
 * @param int $board
 * @param int $limit
 *
 * @return array
 * @package News
 *
 */
function getXMLNews($query_this_board, $board, $limit)

The parameter $board is not used and could be removed.

{
	global $modSettings, $board, $context;

	$db = database();

	$done = false;
	$loops = 0;
	while (!$done)
	{
		$optimize_msg = implode(' AND ', $context['optimize_msg']);
		$request = $db->query('', '
			SELECT
				m.smileys_enabled, m.poster_time, m.id_msg, m.subject, m.body, m.modified_time,
				m.icon, t.id_topic, t.id_board, t.num_replies,
				b.name AS bname,
				COALESCE(mem.id_member, 0) AS id_member,
				COALESCE(mem.email_address, m.poster_email) AS poster_email,
				COALESCE(mem.real_name, m.poster_name) AS poster_name
			FROM {db_prefix}topics AS t
				INNER JOIN {db_prefix}messages AS m ON (m.id_msg = t.id_first_msg)
				INNER JOIN {db_prefix}boards AS b ON (b.id_board = t.id_board)
				LEFT JOIN {db_prefix}members AS mem ON (mem.id_member = m.id_member)
			WHERE ' . $query_this_board . (empty($optimize_msg) ? '' : '
				AND {raw:optimize_msg}') . (empty($board) ? '' : '
				AND t.id_board = {int:current_board}') . ($modSettings['postmod_active'] ? '
				AND t.approved = {int:is_approved}' : '') . '
			ORDER BY t.id_first_msg DESC
			LIMIT {int:limit}',
			[
				'current_board' => $board,
				'is_approved' => 1,
				'limit' => $limit,
				'optimize_msg' => $optimize_msg,
			]
		);
		// If we don't have $limit results, we try again with an unoptimized version covering all rows.
		if ($loops < 2 && $request->num_rows() < $limit)
		{
			$request->free_result();

			if (empty($_REQUEST['boards']) && empty($board))
			{
				unset($context['optimize_msg']['lowest']);
			}
			else
			{
				$context['optimize_msg']['lowest'] = 'm.id_msg >= t.id_first_msg';
			}

			$context['optimize_msg']['highest'] = 'm.id_msg <= t.id_last_msg';
			$loops++;
		}
		else
		{
			$done = true;
		}
	}
	$data = [];
	while (($row = $request->fetch_assoc()))

The variable $request does not seem to be defined for all execution paths leading up to this point.

	{
		$data[] = $row;
	}

	$request->free_result();

	return $data;
}

/**
 * Get the recent topics to display.
 *
 * @param string $query_this_board passed to query, assumed raw and inserted as such
 * @param int $board
 * @param int $limit
 *
 * @return array
 * @package News
 *
 */
function getXMLRecent($query_this_board, $board, $limit)

The parameter $board is not used and could be removed.

{
	global $modSettings, $board, $context;

	$db = database();

	$done = false;
	$loops = 0;
	while (!$done)
	{
		$optimize_msg = implode(' AND ', $context['optimize_msg']);
		$request = $db->query('', '
			SELECT
			 	m.id_msg
			FROM {db_prefix}messages AS m
				INNER JOIN {db_prefix}boards AS b ON (b.id_board = m.id_board)
				INNER JOIN {db_prefix}topics AS t ON (t.id_topic = m.id_topic)
			WHERE ' . $query_this_board . (empty($optimize_msg) ? '' : '
				AND {raw:optimize_msg}') . (empty($board) ? '' : '
				AND m.id_board = {int:current_board}') . ($modSettings['postmod_active'] ? '
				AND m.approved = {int:is_approved}' : '') . '
			ORDER BY m.id_msg DESC
			LIMIT {int:limit}',
			[
				'limit' => $limit,
				'current_board' => $board,
				'is_approved' => 1,
				'optimize_msg' => $optimize_msg,
			]
		);
		// If we don't have $limit results, try again with an unoptimized version covering all rows.
		if ($loops < 2 && $request->num_rows() < $limit)
		{
			$request->free_result();

			if (empty($_REQUEST['boards']) && empty($board))
			{
				unset($context['optimize_msg']['lowest']);
			}
			else
			{
				$context['optimize_msg']['lowest'] = $loops !== 0 ? 'm.id_msg >= t.id_first_msg' : 'm.id_msg >= (t.id_last_msg - t.id_first_msg) / 2';
			}

			$loops++;
		}
		else
		{
			$done = true;
		}
	}
	$messages = [];
	while (($row = $request->fetch_assoc()))

The variable $request does not seem to be defined for all execution paths leading up to this point.

	{
		$messages[] = $row['id_msg'];
	}
	$request->free_result();

	// No messages found, then return nothing
	if (empty($messages))
	{
		return [];
	}

	// Find the most recent posts from our message list that this user can see.
	$data = [];
	$db->fetchQuery('
		SELECT
			m.smileys_enabled, m.poster_time, m.id_msg, m.subject, m.body, m.id_topic, t.id_board,
			b.name AS bname, t.num_replies, m.id_member, m.icon, mf.id_member AS id_first_member,
			COALESCE(mem.real_name, m.poster_name) AS poster_name, mf.subject AS first_subject,
			COALESCE(memf.real_name, mf.poster_name) AS first_poster_name,
			COALESCE(mem.email_address, m.poster_email) AS poster_email, m.modified_time
		FROM {db_prefix}messages AS m
			INNER JOIN {db_prefix}topics AS t ON (t.id_topic = m.id_topic)
			INNER JOIN {db_prefix}messages AS mf ON (mf.id_msg = t.id_first_msg)
			INNER JOIN {db_prefix}boards AS b ON (b.id_board = t.id_board)
			LEFT JOIN {db_prefix}members AS mem ON (mem.id_member = m.id_member)
			LEFT JOIN {db_prefix}members AS memf ON (memf.id_member = mf.id_member)
		WHERE m.id_msg IN ({array_int:message_list})
			' . (empty($board) ? '' : 'AND t.id_board = {int:current_board}') . '
		ORDER BY m.id_msg DESC
		LIMIT {int:limit}',
		[
			'limit' => $limit,
			'current_board' => $board,
			'message_list' => $messages,
		]
	)->fetch_callback(
		function ($row) use (&$data) {
			$data[] = $row;
		}
	);

	return $data;
}

/**
 * Called to convert data to xml
 * Finds urls for local site and sanitizes them
 *
 * @param string $val
 *
 * @return string
 */
function fix_possible_url($val)
{
	global $scripturl;

	if (!str_starts_with($val, $scripturl))
	{
		return $val;
	}

	call_integration_hook('integrate_fix_url', [&$val]);

	return $val;
}

/**
 * For highest feed compatibility, some special characters should be provided
 * as character entities and not html entities
 *
 * @param string $data
 *
 * @return string
 */
function encode_special($data)
{
	return strtr($data, ['>' => '&#x3E;', '&' => '&#x26;', '<' => '&#x3C;']);
}

/**
 * Ensures supplied data is properly encapsulated in cdata xml tags
 * Called from action_xmlprofile in News.controller.php
 *
 * @param string $data
 * @param string $ns
 * @param string $override
 *
 * @return string
 */
function cdata_parse($data, $ns = '', $override = null)
{
	static $cdata_override = false;

	if ($override !== null)
	{
		$cdata_override = (bool) $override;
	}

	// Are we not doing it?
	if (!empty($cdata_override))
	{
		return $data;
	}

	$cdata = '<![CDATA[';

	for ($pos = 0, $n = Util::strlen($data); $pos < $n; null)
	{
		$positions = [
			Util::strpos($data, '&', $pos),
			Util::strpos($data, ']]>', $pos),
		];

		if ($ns !== '')
		{
			$positions[] = Util::strpos($data, '<', $pos);
		}

		foreach ($positions as $k => $dummy)
		{
			if ($dummy === false)
			{
				unset($positions[$k]);
			}
		}

		$old = $pos;
		$pos = empty($positions) ? $n : min($positions);

		if ($pos - $old > 0)
		{
			$cdata .= Util::substr($data, $old, $pos - $old);
		}

		if ($pos >= $n)
		{
			break;
		}

		if (Util::substr($data, $pos, 1) === '<')
		{
			$pos2 = Util::strpos($data, '>', $pos);
			if ($pos2 === false)
			{
				$pos2 = $n;
			}

			if (Util::substr($data, $pos + 1, 1) === '/')
			{
				$cdata .= ']]></' . $ns . ':' . Util::substr($data, $pos + 2, $pos2 - $pos - 1) . '<![CDATA[';
			}
			else
			{
				$cdata .= ']]><' . $ns . ':' . Util::substr($data, $pos + 1, $pos2 - $pos) . '<![CDATA[';
			}

			$pos = $pos2 + 1;
		}
		elseif (Util::substr($data, $pos, 3) == ']]>')
		{
			$cdata .= ']]]]><![CDATA[>';
			$pos = $pos + 3;
		}
		elseif (Util::substr($data, $pos, 1) === '&')
		{
			$pos2 = Util::strpos($data, ';', $pos);

			if ($pos2 === false)
			{
				$pos2 = $n;
			}

			$ent = Util::substr($data, $pos + 1, $pos2 - $pos - 1);

			if (Util::substr($data, $pos + 1, 1) === '#')
			{
				$cdata .= ']]>' . Util::substr($data, $pos, $pos2 - $pos + 1) . '<![CDATA[';
			}
			elseif (in_array($ent, ['amp', 'lt', 'gt', 'quot']))
			{
				$cdata .= ']]>' . Util::substr($data, $pos, $pos2 - $pos + 1) . '<![CDATA[';
			}

			$pos = $pos2 + 1;
		}
	}

	$cdata .= ']]>';

	return strtr($cdata, ['<![CDATA[]]>' => '']);
}