elkarte / Elkarte

sources/ElkArte/Controller/SplitTopics.php

<?php

/**
 * Handle splitting of topics
 *
 * @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
 *
 * Original module by Mach8 - We'll never forget you.
 */

namespace ElkArte\Controller;

use ElkArte\AbstractController;
use ElkArte\Action;
use ElkArte\Exceptions\Exception;
use ElkArte\Helper\Util;

/**
 * Allows to take a topic and split at a point or select individual messages to
 * split to a new topic.
 *
 * - Requires the split_any permission
 */
class SplitTopics extends AbstractController
{
	/** @var string Holds the new subject for the split topic */
	private $_new_topic_subject;

	/**
	 * Intended entry point for this class.
	 *
	 * @see AbstractController::action_index
	 */
	public function action_index()
	{
		// Call the right method.
	}

	/**
	 * Splits a topic into two topics.
	 *
	 * What it does:
	 *
	 * - Delegates to the other functions (based on the URL parameter 'sa').
	 * - Loads the SplitTopics template.
	 * - Requires the split_any permission.
	 * - Accessed with ?action=splittopics.
	 */
	public function action_splittopics(): void
	{
		global $topic;

		// And... which topic were you splitting, again?
		if (empty($topic))
		{
			throw new Exception('numbers_one_to_nine', false);
		}

		// Load up the "dependencies" - the template, getMsgMemberID().
		if (!$this->getApi())
		{
			theme()->getTemplates()->load('SplitTopics');
		}

		// Need some utilities to deal with topics
		require_once(SUBSDIR . '/Boards.subs.php');
		require_once(SUBSDIR . '/Post.subs.php');

		// The things we know to do
		$subActions = [
			'selectTopics' => [$this, 'action_splitSelectTopics', 'permission' => 'split_any'],
			'execute' => [$this, 'action_splitExecute', 'permission' => 'split_any'],
			'index' => [$this, 'action_splitIndex', 'permission' => 'split_any'],
			'splitSelection' => [$this, 'action_splitSelection', 'permission' => 'split_any'],
		];

		// To the right sub action or index if an invalid choice was submitted
		$action = new Action('split_topics');
		$subAction = $action->initialize($subActions, 'index');
		$action->dispatch($subAction);
	}

	/**
	 * Screen shown before the actual split.
	 *
	 * What it does:
	 *
	 * - Is accessed with ?action=splittopics or ?action=splittopics;sa=index
	 * - Default sub action for ?action=splittopics.
	 * - Redirects to action_splitSelectTopics if the message given turns out to be
	 * the first message of a topic.
	 * - Shows the user three ways to split the current topic.
	 *
	 * @uses template_ask() in SplitTopics.template
	 */
	public function action_splitIndex(): void
	{
		global $txt, $context, $modSettings;

		// Split at a specific topic
		$splitAt = $this->_req->getQuery('at', 'intval', 0);

		// Validate "at".
		if (empty($this->_req->query->at))
		{
			throw new Exception('numbers_one_to_nine', false);
		}

		// We deal with topics here.
		require_once(SUBSDIR . '/Boards.subs.php');
		require_once(SUBSDIR . '/Messages.subs.php');

		// Let's load up the boards in case they are useful.
		$context += getBoardList(['not_redirection' => true]);

		// Retrieve message info for the message at the split point.
		$messageInfo = basicMessageInfo($splitAt, false, true);
		if ($messageInfo === false)
		{
			throw new Exception('cant_find_messages');
		}

		// If not approved validate they can approve it.
		if ($modSettings['postmod_active'] && !$messageInfo['topic_approved'])
		{
			isAllowedTo('approve_posts');
		}

		// If this topic has unapproved posts, we need to count them too...
		if ($modSettings['postmod_active'] && allowedTo('approve_posts'))
		{
			$messageInfo['num_replies'] += $messageInfo['unapproved_posts'] - ($messageInfo['topic_approved'] ? 0 : 1);
		}

		// If they can more it as well, allow the template to give them a move to board list
		$context['can_move'] = allowedTo('move_any') || allowedTo('move_own');

		// Check if there is more than one message in the topic.  (there should be.)
		if ($messageInfo['num_replies'] < 1)
		{
			throw new Exception('topic_one_post', false);
		}

		// Check if this is the first message in the topic (if so, the first and second option won't be available)
		if ($messageInfo['id_first_msg'] == $splitAt)
		{
			$this->_new_topic_subject = $messageInfo['subject'];
			$this->_set_session_values();
			$this->action_splitSelectTopics();
		}
		else
		{
			// Basic template information....
			$context['message'] = [
				'id' => $splitAt,
				'subject' => $messageInfo['subject']
			];
			$context['sub_template'] = 'ask';
			$context['page_title'] = $txt['split_topic'];
		}
	}

	/**
	 * Set the values for this split session
	 */
	private function _set_session_values(): void
	{
		global $txt;

		// Clean up the subject.
		$subname = $this->_req->getPost('subname', 'trim', $this->_req->getQuery('subname', 'trim', null));
		if (isset($subname) && empty($this->_new_topic_subject))
		{
			$this->_new_topic_subject = Util::htmlspecialchars($subname);
		}

		if (empty($this->_new_topic_subject))
		{
			$this->_new_topic_subject = $txt['new_topic'];
		}

		// Save in session so its available across all the form pages
		if (empty($_SESSION['move_to_board']))
		{
			$_SESSION['move_to_board'] = (!empty($this->_req->post->move_new_topic) && !empty($this->_req->post->move_to_board)) ? (int) $this->_req->post->move_to_board : 0;
			$_SESSION['reason'] = empty($this->_req->post->reason) ? '' : trim(Util::htmlspecialchars($this->_req->post->reason, ENT_QUOTES));
			$_SESSION['messageRedirect'] = !empty($this->_req->post->messageRedirect);
			$_SESSION['new_topic_subject'] = $this->_new_topic_subject;
		}
	}

	/**
	 * Allows the user to select the messages to be split.
	 *
	 * What it does:
	 *
	 * - Is accessed with ?action=splittopics;sa=selectTopics.
	 * - Uses 'select' sub template of the SplitTopics template or (for
	 * XMLhttp) the 'split' sub template of the Xml template.
	 * - Supports XMLhttp for adding/removing a message to the selection.
	 * - Uses a session variable to store the selected topics.
	 * - Shows two independent page indexes for both the selected and
	 * not-selected messages (;topic=1.x;start2=y).
	 *
	 * @uses template_select() of SplitTopics.template
	 * @uses template_split() of SplitTopics.template
	 */
	public function action_splitSelectTopics(): void
	{
		global $txt, $topic, $context, $modSettings, $options;

		$context['page_title'] = $txt['split_topic'] . ' - ' . $txt['select_split_posts'];
		$context['destination_board'] = empty($this->_req->post->move_to_board) ? 0 : (int) $this->_req->post->move_to_board;

		// Haven't selected anything have we?
		$_SESSION['split_selection'][$topic] = empty($_SESSION['split_selection'][$topic]) ? [] : $_SESSION['split_selection'][$topic];

		// This is a special case for split topics from quick-moderation checkboxes
		if (isset($this->_req->query->subname_enc))
		{
			$this->_new_topic_subject = trim(Util::htmlspecialchars(urldecode($this->_req->query->subname_enc)));
			$this->_set_session_values();
		}

		require_once(SUBSDIR . '/Topic.subs.php');
		require_once(SUBSDIR . '/Messages.subs.php');

		$context['not_selected'] = [
			'num_messages' => 0,
			'start' => $this->_req->getPost('start', 'intval', 0),
			'messages' => [],
		];

		$context['selected'] = [
			'num_messages' => 0,
			'start' => $this->_req->getQuery('start2', 'intval', 0),
			'messages' => [],
		];

		$context['topic'] = [
			'id' => $topic,
			'subject' => urlencode($_SESSION['new_topic_subject']),
		];

		// Some stuff for our favorite template.
		$context['new_subject'] = $_SESSION['new_topic_subject'];

		// Using the "select" sub template.
		$context['sub_template'] = $this->getApi() ? 'split' : 'select';

		// All of the js for topic split selection is needed
		if (!$this->getApi())
		{
			loadJavascriptFile('topic.js');
		}

		// Are we using a custom messages per page?
		$context['messages_per_page'] = empty($modSettings['disableCustomPerPage']) && !empty($options['messages_per_page']) ? $options['messages_per_page'] : $modSettings['defaultMaxMessages'];

		// Get the message ID's from before the move.
		if ($this->getApi())
		{
			$original_msgs = [
				'not_selected' => messageAt($context['not_selected']['start'], $topic, [
					'not_in' => empty($_SESSION['split_selection'][$topic]) ? [] : $_SESSION['split_selection'][$topic],
					'only_approved' => !$modSettings['postmod_active'] || !allowedTo('approve_posts'),
					'limit' => $context['messages_per_page'],
				]),
				'selected' => [],
			];

			// You can't split the last message off.
			if (empty($context['not_selected']['start']) && count($original_msgs['not_selected']) <= 1 && $this->_req->query->move === 'down')
			{
				$this->_req->query->move = '';
			}

			if (!empty($_SESSION['split_selection'][$topic]))
			{
				$original_msgs['selected'] = messageAt($context['selected']['start'], $topic, [
					'include' => empty($_SESSION['split_selection'][$topic]) ? [] : $_SESSION['split_selection'][$topic],
					'only_approved' => !$modSettings['postmod_active'] || !allowedTo('approve_posts'),
					'limit' => $context['messages_per_page'],
				]);
			}
		}

		// (De)select a message..
		if (!empty($this->_req->query->move))
		{
			$_id_msg = $this->_req->getQuery('msg', 'intval');

			if ($this->_req->query->move === 'reset')
			{
				$_SESSION['split_selection'][$topic] = [];
			}
			elseif ($this->_req->query->move === 'up')
			{
				$_SESSION['split_selection'][$topic] = array_diff($_SESSION['split_selection'][$topic], [$_id_msg]);
			}
			else
			{
				$_SESSION['split_selection'][$topic][] = $_id_msg;
			}
		}

		// Make sure the selection is still accurate.
		if (!empty($_SESSION['split_selection'][$topic]))
		{
			$_SESSION['split_selection'][$topic] = messageAt(0, $topic, [
				'include' => empty($_SESSION['split_selection'][$topic]) ? [] : $_SESSION['split_selection'][$topic],
				'only_approved' => !$modSettings['postmod_active'] || !allowedTo('approve_posts'),
				'limit' => false,
			]);
			$selection = $_SESSION['split_selection'][$topic];
		}
		else
		{
			$selection = [];
		}

		// Get the number of messages (not) selected to be split.
		$split_counts = countSplitMessages($topic, !$modSettings['postmod_active'] || allowedTo('approve_posts'), $selection);
		foreach ($split_counts as $key => $num_messages)
		{
			$context[$key]['num_messages'] = $num_messages;
		}

		// Fix an oversize starting page (to make sure both pageindexes are properly set).
		if ($context['selected']['start'] >= $context['selected']['num_messages'])
		{
			$context['selected']['start'] = $context['selected']['num_messages'] <= $context['messages_per_page'] ? 0 : ($context['selected']['num_messages'] - (($context['selected']['num_messages'] % $context['messages_per_page']) == 0 ? $context['messages_per_page'] : ($context['selected']['num_messages'] % $context['messages_per_page'])));
		}

		$page_index_url = '{scripturl}?action=splittopics;sa=selectTopics;subname=' . strtr(urlencode($_SESSION['new_topic_subject']), ['%' => '%%']) . ';topic=' . $topic;

		// Build a page list of the not-selected topics...
		$context['not_selected']['page_index'] = constructPageIndex($page_index_url . '.%1$d;start2=' . $context['selected']['start'], $context['not_selected']['start'], $context['not_selected']['num_messages'], $context['messages_per_page'], true);

		// ...and one of the selected topics.
		$context['selected']['page_index'] = constructPageIndex($page_index_url . '.' . $context['not_selected']['start'] . ';start2=%1$d', $context['selected']['start'], $context['selected']['num_messages'], $context['messages_per_page'], true);

		// Retrieve the unselected messages.
		$context['not_selected']['messages'] = selectMessages($topic, $context['not_selected']['start'], $context['messages_per_page'], empty($_SESSION['split_selection'][$topic]) ? [] : ['excluded' => $_SESSION['split_selection'][$topic]], $modSettings['postmod_active'] && !allowedTo('approve_posts'));

		// Now retrieve the selected messages.
		if (!empty($_SESSION['split_selection'][$topic]))
		{
			$context['selected']['messages'] = selectMessages($topic, $context['selected']['start'], $context['messages_per_page'], ['included' => $_SESSION['split_selection'][$topic]], $modSettings['postmod_active'] && !allowedTo('approve_posts'));
		}

		// The XMLhttp method only needs the stuff that changed, so let's compare.
		if ($this->getApi())
		{
			$changes = [
				'remove' => [
					'not_selected' => array_diff($original_msgs['not_selected'], array_keys($context['not_selected']['messages'])),

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

					'selected' => array_diff($original_msgs['selected'], array_keys($context['selected']['messages'])),
				],
				'insert' => [
					'not_selected' => array_diff(array_keys($context['not_selected']['messages']), $original_msgs['not_selected']),
					'selected' => array_diff(array_keys($context['selected']['messages']), $original_msgs['selected']),
				],
			];

			$context['changes'] = [];
			foreach ($changes as $change_type => $change_array)
			{
				foreach ($change_array as $section => $msg_array)
				{
					if (empty($msg_array))
					{
						continue;
					}

					foreach ($msg_array as $id_msg)
					{
						$context['changes'][$change_type . $id_msg] = [
							'id' => $id_msg,
							'type' => $change_type,
							'section' => $section,
						];

						if ($change_type === 'insert')
						{
							$context['changes']['insert' . $id_msg]['insert_value'] = $context[$section]['messages'][$id_msg];
						}
					}
				}
			}
		}
	}

	/**
	 * Do the actual split.
	 *
	 * What it does:
	 *
	 * - Is accessed with ?action=splittopics;sa=execute.
	 * - Supports three ways of splitting:
	 *   (1) only one message is split off.
	 *   (2) all messages after and including a given message are split off.
	 *   (3) select topics to split (redirects to action_splitSelectTopics()).
	 * - Uses splitTopic function to do the actual splitting.
	 *
	 * @uses template_split_successful() in SplitTopics.template
	 */
	public function action_splitExecute(): bool
	{
		global $txt, $context, $topic;

		// Check the session to make sure they meant to do this.
		checkSession();

		// Set the form options in to session
		$this->_set_session_values();

		// Cant post an empty redirect topic
		if (!empty($_SESSION['messageRedirect']) && empty($_SESSION['reason']))
		{
			$this->_unset_session_values();
			throw new Exception('splittopic_no_reason', false);
		}

		// Redirect to the selector if they chose selective.
		if ($this->_req->post->step2 === 'selective')
		{
			if (!empty($this->_req->post->at))
			{
				$_SESSION['split_selection'][$topic][] = (int) $this->_req->post->at;
			}

			$this->action_splitSelectTopics();

			return true;
		}

		// We work with them topics.
		require_once(SUBSDIR . '/Topic.subs.php');
		require_once(SUBSDIR . '/Boards.subs.php');

		// Make sure they can see the board they are trying to move to
		// (and get whether posts count in the target board).
		// Before the actual split because of the fatal_lang_errors
		$boards = splitDestinationBoard($_SESSION['move_to_board']);

		$splitAt = $this->_req->getPost('at', 'intval', 0);
		$messagesToBeSplit = [];

		// Fetch the message IDs of the topic that are at or after the message.
		if ($this->_req->post->step2 === 'afterthis')
		{
			$messagesToBeSplit = messagesSince($topic, $splitAt, true);
		}
		// Only the selected message has to be split. That should be easy.
		elseif ($this->_req->post->step2 === 'onlythis')
		{
			$messagesToBeSplit[] = $splitAt;
		}
		// There's another action?!
		else
		{
			$this->_unset_session_values();
			throw new Exception('no_access', false);
		}

		$context['old_topic'] = $topic;
		$context['new_topic'] = splitTopic($topic, $messagesToBeSplit, $_SESSION['new_topic_subject']);
		$context['page_title'] = $txt['split_topic'];
		$context['sub_template'] = 'split_successful';

		splitAttemptMove($boards, $context['new_topic']);

		// Create a link to this in the old topic.
		// @todo Does this make sense if the topic was unapproved before? We are not yet sure if the resulting topic is unapproved.
		if ($_SESSION['messageRedirect'])
		{
			postSplitRedirect($_SESSION['reason'], $_SESSION['new_topic_subject'], $boards['destination'], $context['new_topic']);
		}

		$this->_unset_session_values();

		return true;
	}

	/**
	 * Clear out this split session
	 */
	private function _unset_session_values(): void
	{
		unset(
			$_SESSION['move_to_board'],
			$_SESSION['reason'],
			$_SESSION['messageRedirect'],
			$_SESSION['split_selection'],
			$_SESSION['new_topic_subject']
		);
	}

	/**
	 * Do the actual split of a selection of topics.
	 *
	 * What it does:
	 *
	 * - Is accessed with ?action=splittopics;sa=splitSelection.
	 * - Uses the main SplitTopics template.
	 *
	 * @uses splitTopic() function to do the actual splitting.
	 * @uses template_split_successful() of SplitTopics.template
	 */
	public function action_splitSelection(): void
	{
		global $txt, $topic, $context;

		// Make sure the session id was passed with post.
		checkSession();

		require_once(SUBSDIR . '/Topic.subs.php');

		// You must've selected some messages!  Can't split out none!
		if (empty($_SESSION['split_selection'][$topic]))
		{
			$this->_unset_session_values();
			throw new Exception('no_posts_selected', false);
		}

		// This is here because there are two fatal_lang_errors in there
		$boards = splitDestinationBoard($_SESSION['move_to_board']);

		$context['old_topic'] = $topic;
		$context['new_topic'] = splitTopic($topic, $_SESSION['split_selection'][$topic], $_SESSION['new_topic_subject']);
		$context['page_title'] = $txt['split_topic'];
		$context['sub_template'] = 'split_successful';

		splitAttemptMove($boards, $context['new_topic']);

		// Create a link to this in the old topic.
		// @todo Does this make sense if the topic was unapproved before? We are not yet sure if the resulting topic is unapproved.
		if ($_SESSION['messageRedirect'])
		{
			postSplitRedirect($_SESSION['reason'], $_SESSION['new_topic_subject'], $boards['destination'], $context['new_topic']);
		}

		$this->_unset_session_values();
	}
}