ElkArte\Controller\Draft

Complexity

Total Complexity

45

Size/Duplication

Total Lines	372
Duplicated Lines	0 %

Test Coverage

Coverage

44.08%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	pre_dispatch()	0	8	1
A	action_post()	0	3	1
A	action_index()	0	4	1
A	_prepare_body_subject()	0	21	3
C	action_showProfileDrafts()	0	101	12
B	_query_limits()	0	18	7
A	action_post2()	0	3	1
A	action_save()	0	3	1
A	_action_delete()	0	21	4
C	action_showPMDrafts()	0	104	14

<?php

/**
 * Allow for the saving, retrieving, deleting and settings for the drafts
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * @version 2.0 dev
 *
 */

namespace ElkArte\Controller;

use BBC\ParserWrapper;
use ElkArte\Exceptions\Exception;
use ElkArte\Helper\Util;
use ElkArte\Languages\Txt;

/**
 * Draft controller.
 * This class handles requests that allow for the saving,
 * retrieving, deleting and settings for the drafts functionality.
 */
class Draft extends Post
{
	/**
	 * The id of the member
	 */
	private $_memID = 0;

	/**
	 * This method is executed before any action handler.
	 * Loads language, common needed stuffs.
	 */
	public function pre_dispatch()
	{
		// Language and helper functions
		Txt::load('Drafts');
		require_once(SUBSDIR . '/Drafts.subs.php');
		require_once(SUBSDIR . '/Profile.subs.php');

		$this->_memID = currentMemberID();
	}

	/**
	 * @override
	 */
	public function action_post()
	{
		$this->action_index();
	}

	/**
	 * Default method, just forwards, if we ever get here.
	 *
	 * @see \ElkArte\AbstractController::action_index()
	 */
	public function action_index()
	{
		// Where do you want to go today? :P
		$this->action_showProfileDrafts();
	}

	/**
	 * Show all drafts of a given type by the current user
	 *
	 * What it does:
	 *
	 * - Allows for the deleting and loading/editing of drafts
	 *
	 * @uses the showdrafts template
	 *
	 */
	public function action_showProfileDrafts(): void
	{
		global $txt, $modSettings, $context;

		// Safe is safe.
		if ($this->_memID !== $this->user->id)

The property id does not exist on ElkArte\Helper\ValuesContainer. Since you implemented __get, consider adding a @property annotation.

		{
			throw new Exception('no_access', false);
		}

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

		// Some initial context.
		$context['start'] = $this->_req->getQuery('start', 'intval', 0);
		$context['current_member'] = $this->_memID;

		// If just deleting a draft, do it and then redirect back.
		if (!empty($this->_req->query->delete) || !empty($this->_req->post->delete))
		{
			$this->_action_delete('action=profile;u=' . $this->_memID . ';area=showdrafts;start=' . $context['start']);
		}

		// Get things started
		$msgCount = draftsCount($this->_memID, 0);
		$maxIndex = (int) $modSettings['defaultMaxMessages'];

		// Make sure the starting place makes sense and construct our friend the page index.
		$context['page_index'] = constructPageIndex('{scripturl}?action=pm;sa=showpmdrafts', $context['start'], $msgCount, $maxIndex);
		$context['current_page'] = $context['start'] / $maxIndex;

		[$maxIndex, $reverse, $limit, $order] = $this->_query_limits($msgCount, $maxIndex);
		$user_drafts = load_user_drafts($this->_memID, 0, false, $order, $limit);

		// Start counting at the number of the first message displayed.
		$counter = $reverse ? $context['start'] + $maxIndex + 1 : $context['start'];
		$context['posts'] = [];
		foreach ($user_drafts as $row)
		{
			$this->_prepare_body_subject($row['body'], $row['subject'], $txt['drafts_none'], (bool) $row['smileys_enabled']);

			// And the data used by the template
			$context['drafts'][$counter += $reverse ? -1 : 1] = [
				'body' => $row['body'],
				'counter' => $counter,
				'board' => [
					'name' => $row['bname'],
					'id' => $row['id_board'],
					'link' => '<a href="' . getUrl('board', ['board' => $row['id_board'], 'start' => '0', 'name' => $row['bname']]) . '">' . $row['bname'] . '</a>',
				],
				'topic' => [
					'id' => $row['id_topic'],
					'link' => empty($row['id_topic']) ? $row['subject'] : '<a href="' . getUrl('topic', ['topic' => $row['id_topic'], 'start' => '0', 'subject' => $row['subject']]) . '">' . $row['subject'] . '</a>',
				],
				'subject' => $row['subject'],
				'time' => standardTime($row['poster_time']),
				'html_time' => htmlTime($row['poster_time']),
				'timestamp' => forum_time(true, $row['poster_time']),
				'icon' => $row['icon'],
				'id_draft' => $row['id_draft'],
				'locked' => $row['locked'],
				'sticky' => $row['is_sticky'],
				'age' => floor((time() - $row['poster_time']) / 86400),
				'remaining' => (empty($modSettings['drafts_keep_days']) ? 0 : round($modSettings['drafts_keep_days'] - ((time() - $row['poster_time']) / 86400))),
				'buttons' => [
					'inline_mod_check' => [
						'class' => 'inline_mod_check',
						'checkbox' => 'always',
						'value' => $row['id_draft'],
						'name' => 'delete',
						'enabled' => true,
					],
					'remove' => [
						'url' => getUrl('profile', ['action' => 'profile', 'area' => 'showdrafts', 'u' => $context['member']['id'], 'name' => $context['member']['name'], 'delete' => $row['id_draft'], 'start' => $context['start'], '{session_data}']),
						'text' => 'draft_delete',
						'icon' => 'delete',
						'enabled' => true,
						'custom' => 'onclick="return confirm(' . JavaScriptEscape($txt['draft_remove'] . '?') . ');"',
					],
					'edit' => [
						'url' => getUrl('action', ['action' => 'post', empty($row['id_topic']) ? 'board' : 'topic' => empty($row['id_topic']) ? $row['id_board'] . '.0' : $row['id_topic'] . '.0', 'id_draft' => $row['id_draft']]),
						'text' => 'draft_edit',
						'icon' => 'modify',
						'enabled' => true,
					],
				]
			];
		}

		// If the drafts were retrieved in reverse order, get them right again.
		if ($reverse)
		{
			$context['drafts'] = array_reverse($context['drafts'], true);
		}

		// Menu tab
		$context[$context['profile_menu_name']]['object']->prepareTabData([
			'title' => 'drafts_show',
			'class' => 'i-comments',
			'description' => 'drafts_show_desc',
		]);
		$context['sub_template'] = 'showDrafts';
	}

	/**
	 * Deletes drafts stored in the $_REQUEST['delete'] index.
	 * The function redirects to a selected location.
	 *
	 * @param string $redirect - The url to redirect to after the drafts have
	 * been deleted
	 */
	private function _action_delete($redirect = ''): void
	{
		checkSession(empty($this->_req->post) ? 'get' : '');

		// Lets see what we have been sent, one or many to delete
		$toDelete = [];
		if (!empty($this->_req->query->delete))
		{
			$toDelete[] = (int) $this->_req->query->delete;
		}
		else
		{
			$toDelete = array_map('intval', $this->_req->post->delete);
		}

		if (!empty($toDelete))
		{
			deleteDrafts($toDelete, $this->_memID);
		}

		redirectexit($redirect);
	}

	/**
	 * Calculates start and limit for the query, maxIndex for the counter and
	 * if the query is reversed or not
	 *
	 * @param int $msgCount - Total number of drafts
	 * @param int $maxIndex - The maximum number of messages
	 *
	 * @return array - an array consisting of: $maxIndex, $reverse, $limit, $order
	 */
	private function _query_limits($msgCount, $maxIndex): array
	{
		global $context, $modSettings;

		// Reverse the query if we're past 50% of the total for better performance.
		$start = $context['start'];
		$reverse = $start > $msgCount / 2;
		if ($reverse)
		{
			$maxIndex = $msgCount < $context['start'] + $modSettings['defaultMaxMessages'] + 1 && $msgCount > $context['start'] ? $msgCount - $context['start'] : (int) $modSettings['defaultMaxMessages'];
			$start = $msgCount < $context['start'] + $modSettings['defaultMaxMessages'] + 1 || $msgCount < $context['start'] + $modSettings['defaultMaxMessages'] ? 0 : $msgCount - $context['start'] - $modSettings['defaultMaxMessages'];
		}

		// Find this user's drafts
		$limit = $start . ', ' . $maxIndex;
		$order = 'ud.poster_time ' . ($reverse ? 'ASC' : 'DESC');

		return [$maxIndex, $reverse, $limit, $order];
	}

	/**
	 * Prepares the body and the subject of the draft
	 *
	 * @param string $body - The body of the message, passed by-ref
	 * @param string $subject - The subject, passed by-ref
	 * @param string $default_subject - The default subject if $subject is empty
	 * @param bool $smiley_enabled - Is the smiley are enabled or not
	 */
	private function _prepare_body_subject(&$body, &$subject, $default_subject, $smiley_enabled = true): void
	{
		// Cleanup...
		if (empty($body))
		{
			$body = '';
		}

		$subject = Util::htmltrim($subject);
		if (empty($subject))
		{
			$subject = $default_subject;
		}

		// Censor...
		$body = censor($body);
		$subject = censor($subject);

		// BBC-ilize the message.
		$parser = ParserWrapper::instance();
		$body = $parser->parseMessage($body, $smiley_enabled);
	}

	/**
	 * @override
	 */
	public function action_post2()
	{
		$this->action_index();
	}

	/**
	 * @override
	 */
	public function action_save(): void
	{
		$this->action_index();
	}

	/**
	 * Show all PM drafts of the current user
	 *
	 * What it does:
	 *
	 * - Allows for the deleting and loading/editing of PM drafts
	 *
	 * @uses the showPMDrafts template
	 */
	public function action_showPMDrafts(): void
	{
		global $txt, $modSettings, $context;

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

		// Quick check how we got here.
		if ($this->_memID !== $this->user->id)

The property id does not exist on ElkArte\Helper\ValuesContainer. Since you implemented __get, consider adding a @property annotation.

		{
			throw new Exception('no_access', false);
		}

		// Set up what we will need
		$context['start'] = $this->_req->getQuery('start', 'intval', 0);

		// If just deleting a draft, do it and then redirect back.
		if (!empty($this->_req->query->delete) || !empty($this->_req->post->delete))
		{
			$this->_action_delete('action=pm;sa=showpmdrafts;start=' . $context['start']);
			return;
		}

		// Perhaps a draft was selected for editing? if so pass this off
		if (!empty($this->_req->query->id_draft) && !empty($context['drafts_pm_save']))
		{
			checkSession('get');
			redirectexit('action=pm;sa=send;id_draft=' . $this->_req->getQuery('id_draft', 'intval'));
		}

		// Get the count of applicable drafts
		$msgCount = draftsCount($this->_memID, 1);
		$maxIndex = (int) $modSettings['defaultMaxMessages'];

		// Make sure the starting place makes sense and construct our friend the page index.
		$context['page_index'] = constructPageIndex('{scripturl}?action=pm;sa=showpmdrafts', $context['start'], $msgCount, $maxIndex);
		$context['current_page'] = $context['start'] / $maxIndex;

		[$maxIndex, $reverse, $limit, $order] = $this->_query_limits($msgCount, $maxIndex);
		$user_drafts = load_user_drafts($this->_memID, 1, false, $order, $limit);

		// Start counting at the number of the first message displayed.
		$counter = $reverse ? $context['start'] + $maxIndex + 1 : $context['start'];
		$context['posts'] = [];
		foreach ($user_drafts as $row)
		{
			$this->_prepare_body_subject($row['body'], $row['subject'], $txt['no_subject'], true);

			// Have they provided who this will go to?
			$recipients = [
				'to' => [],
				'bcc' => [],
			];
			$recipient_ids = (empty($row['to_list'])) ? [] : Util::unserialize($row['to_list']);

			// Get nice names to show the user, the id's are not that great to see!
			if (!empty($recipient_ids['to']) || !empty($recipient_ids['bcc']))
			{
				$recipient_ids['to'] = array_map('intval', $recipient_ids['to']);
				$recipient_ids['bcc'] = array_map('intval', $recipient_ids['bcc']);
				$allRecipients = array_merge($recipient_ids['to'], $recipient_ids['bcc']);
				$recipients = draftsRecipients($allRecipients, $recipient_ids);
			}

			// Add the items to the array for template use
			$context['drafts'][$counter += $reverse ? -1 : 1] = [
				'body' => $row['body'],
				'counter' => $counter,
				'subject' => $row['subject'],
				'time' => standardTime($row['poster_time']),
				'html_time' => htmlTime($row['poster_time']),
				'timestamp' => forum_time(true, $row['poster_time']),
				'id_draft' => $row['id_draft'],
				'recipients' => $recipients,
				'age' => floor((time() - $row['poster_time']) / 86400),
				'remaining' => (empty($modSettings['drafts_keep_days']) ? 0 : floor($modSettings['drafts_keep_days'] - ((time() - $row['poster_time']) / 86400))),
				'buttons' => [
					'reply_button' => [
						'url' => getUrl('action', ['action' => 'pm', 'sa' => 'showpmdrafts', 'id_draft' => $row['id_draft'], '{session_data}']),
						'text' => 'draft_edit',
						'icon' => 'modify',
						'enabled' => true,
					],
					'remove_button' => [
						'url' => getUrl('action', ['action' => 'pm', 'sa' => 'showpmdrafts', 'delete' => $row['id_draft'], '{session_data}']),
						'text' => 'draft_delete',
						'icon' => 'delete',
						'enabled' => true,
					],
				]
			];
		}

		// If the drafts were retrieved in reverse order, then put them in the right order again.
		if ($reverse)
		{
			$context['drafts'] = array_reverse($context['drafts'], true);
		}

		// Off to the template we go
		$context['page_title'] = $txt['drafts'];
		$context['sub_template'] = 'showPMDrafts';
		$context['breadcrumbs'][] = [
			'url' => getUrl('action', ['action' => 'pm', 'sa' => 'showpmdrafts']),
			'name' => $txt['drafts'],
		];
	}
}