robertheim\topictags\acp\manage_tags_controller

Complexity

Total Complexity

35

Size/Duplication

Total Lines	300
Duplicated Lines	5 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	15	15	1
B	manage_tags()	0	60	9
A	handle_delete()	0	35	5
C	handle_edit()	0	77	10
A	simple_response()	0	24	5
A	get_tag_link()	0	4	2
A	create_sort_selects()	0	19	3

<?php
/**
*
* @package phpBB Extension - RH Topic Tags
* @copyright (c) 2014 Robet Heim
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

namespace robertheim\topictags\acp;

/**
 * @ignore
 */
use \phpbb\json_response;

/**
* Handles the "manage-tags" page of the ACP.
*/
class manage_tags_controller
{

	/** @var \phpbb\config\config */
	private $config;

	/** @var \phpbb\request\request */
	private $request;

	/** @var \phpbb\user */
	private $user;

	/** @var \phpbb\template\template */
	private $template;

	/** @var \phpbb\pagination */
	private $pagination;

	/** @var \robertheim\topictags\service\tags_manager */
	private $tags_manager;

	const SORT_ASC        = 0;
	const SORT_NAME_ASC   = 0;
	const SORT_NAME_DESC  = 1;
	const SORT_COUNT_ASC  = 2;
	const SORT_COUNT_DESC = 3;

	public function __construct(
		\phpbb\config\config $config,
		\phpbb\request\request $request,
		\phpbb\user $user,
		\phpbb\template\template $template,
		\phpbb\pagination $pagination,
		\robertheim\topictags\service\tags_manager $tags_manager)
	{
		$this->config = $config;
		$this->request = $request;
		$this->user = $user;
		$this->template = $template;
		$this->pagination = $pagination;
		$this->tags_manager = $tags_manager;
	}

	/**
	 * @param string $mode phpbb acp-mode
	 * @param string $u_action phpbb acp-u_action
	 * @param string $id the modules-id (url-param "i")
	 */
	public function manage_tags($mode, $u_action, $id)
	{
		$action = $this->request->variable('action', '');
		switch ($action)
		{
			case 'delete':
				$this->handle_delete($mode, $u_action, $id);
			break;
			case 'edit':
				$this->handle_edit($u_action);
			break;
			case 'edit_non_ajax':
				$this->handle_edit($u_action, false);
			break;
			default:
				// show all tags
				$sort_key = $this->request->variable('sort_key', self::SORT_NAME_ASC);
				$sort_field = 'tag';
				switch ($sort_key)
				{
					case self::SORT_COUNT_ASC:
					// no break
					case self::SORT_COUNT_DESC:
						$sort_field = 'count';
					break;
					case self::SORT_NAME_ASC:
					// no break
					case self::SORT_NAME_DESC:
					// no break
					default:
						$sort_field = 'tag';
					break;
				}

				$ordering = (($sort_key % 2) == self::SORT_ASC);
				$start = $this->request->variable('start', 0);
				$limit = $this->config['topics_per_page'];
				$tags_count = $this->tags_manager->count_tags();
				$start = $this->pagination->validate_start($start, $limit, $tags_count);
				$base_url = $u_action . "&amp;sort_key=$sort_key";

				$tags = $this->tags_manager->get_all_tags($start, $limit, $sort_field, $ordering);

				$this->pagination->generate_template_pagination($base_url, 'pagination', 'start', $tags_count, $limit, $start);
				foreach ($tags as $tag)
				{
					$this->template->assign_block_vars('tags', array(
						'NAME'				=> $tag['tag'],
						'ASSIGNMENTS'		=> $tag['count'],
						'U_DELETE_TAG'		=> $this->get_tag_link($u_action, $tag['id']) . '&amp;action=delete',
						'U_EDIT_TAG'		=> $this->get_tag_link($u_action, $tag['id']) . '&amp;action=edit_non_ajax',
					));
				}
				$this->template->assign_vars(array(
					'SELECT_SORT_KEY' => $this->create_sort_selects($sort_key),
					'U_ACTION'        => $u_action . "&amp;sort_key=$sort_key&amp;start=$start",
				));
			break;
		}
	}

	/**
	 * @param string $mode phpbb acp-mode
	 * @param string $u_action phpbb acp-u_action
	 * @param string $id
	 */
	private function handle_delete($mode, $u_action, $id)
	{
		$tag_id = $this->request->variable('tag_id', -1);
		if ($tag_id < 1)
		{
			if ($this->request->is_ajax())
			{
				trigger_error('TOPICTAGS_MISSING_TAG_ID', E_USER_WARNING);
			}
			trigger_error($this->user->lang('TOPICTAGS_MISSING_TAG_ID') . adm_back_link($u_action), E_USER_WARNING);
		}

		$tag = $this->tags_manager->get_tag_by_id($tag_id);

		if (confirm_box(true))
		{
			$this->tags_manager->delete_tag($tag_id);

			if ($this->request->is_ajax())
			{
				trigger_error('TOPICTAGS_TAG_DELETED');
			}
			trigger_error($this->user->lang('TOPICTAGS_TAG_DELETED') . adm_back_link($u_action));
		}
		else
		{
			$confirm_text = $this->user->lang('TOPICTAGS_TAG_DELETE_CONFIRM', $tag);
			confirm_box(false, $confirm_text, build_hidden_fields(array(
				'i'      => $id,
				'mode'   => $mode,
				'action' => 'delete',
				'tag_id' => $tag_id,
			)));
		}
	}

	/**
	 * @param $is_ajax whether the edit is called by ajax or not
	 * @param string $u_action phpbb acp-u_action
	 */
	private function handle_edit($u_action, $is_ajax = true)
	{
		if (!$is_ajax)
		{
			$new_tag_name = $this->request->variable('new_tag_name', '');
			if (empty($new_tag_name))
			{
				$tag_id = $this->request->variable('tag_id', 0);
				$old_tag_name = $this->tags_manager->get_tag_by_id($tag_id);
				$this->template->assign_vars(array(
					'U_ACTION'				=> $this->get_tag_link($u_action, $tag_id) . '&amp;action=edit_non_ajax',
					'S_EDIT_TAG_NON_AJAX'	=> true,
					'OLD_TAG_NAME'			=> $old_tag_name,
				));
				return;
			}
			// now new_tag_name and old_tag_name are set and the normal procedure can take place.
		}
		$old_tag_name = $this->request->variable('old_tag_name', '');
		$new_tag_name = $this->request->variable('new_tag_name', '');

		if (empty($old_tag_name) || empty($new_tag_name))
		{
			$error_msg = $this->user->lang('TOPICTAGS_MISSING_TAG_NAMES');
			$this->simple_response($u_action, $error_msg, false);
		}
		else
		{
			if ($is_ajax)
			{
				$old_tag_name = rawurldecode(base64_decode($old_tag_name));
				$new_tag_name = rawurldecode(base64_decode($new_tag_name));
			}
			if ($old_tag_name == $new_tag_name)
			{
				$error_msg = $this->user->lang('TOPICTAGS_NO_MODIFICATION', $old_tag_name);
				$this->simple_response($u_action, $error_msg, false);
			}
			$old_ids = $this->tags_manager->get_existing_tags(array($old_tag_name), true);
			if (empty($old_ids))
			{
				$error_msg = $this->user->lang('TOPICTAGS_TAG_DOES_NOT_EXIST', $old_tag_name);
				$this->simple_response($u_action, $error_msg, false);
			}
			// if we reach here, we know that we got a single valid old tag
			$old_id = $old_ids[0];

			$new_tag_name_clean = $this->tags_manager->clean_tag($new_tag_name);
			$is_valid = $this->tags_manager->is_valid_tag($new_tag_name_clean, true);
			if (!$is_valid)
			{
				$error_msg = $this->user->lang('TOPICTAGS_TAG_INVALID', $new_tag_name);
				$this->simple_response($u_action, $error_msg, false);
			}

			// old tag exist and new tag is valid
			$new_ids = $this->tags_manager->get_existing_tags(array($new_tag_name), true);
			if (!empty($new_ids))
			{
				// new tag exist -> merge
				$new_id = $new_ids[0];
				$new_tag_count = $this->tags_manager->merge($old_id, $new_tag_name, $new_id);
				$msg = $this->user->lang('TOPICTAGS_TAG_MERGED', $new_tag_name_clean);
				$this->simple_response($u_action, $msg, true, array(
						'success'       => true,
						'merged'        => true,
						'new_tag_count' => $new_tag_count,
						'msg'           => base64_encode(rawurlencode($msg)),
				));
			}

			// old tag exist and new tag is valid and does not exist -> rename it
			$this->tags_manager->rename($old_id, $new_tag_name_clean);
			$msg = $this->user->lang('TOPICTAGS_TAG_CHANGED');
			$this->simple_response($u_action, $msg);
		}
	}

	/**
	 * Creates an ajax response or a normal response depending on the request.
	 *
	 * @param string $u_action phpbb acp-u_action
	 * @param string $msg the message for the normal response
	 * @param boolean $success whether the response is marked successful (default) or not
	 * @param array $ajax_response optional values to response in ajax_response. If no values are
	 *                             given the response will be for success==true:
	 *                                <pre>array(
	 *                                  'success' => true,
	 *                                  'msg' => base64_encode(rawurlencode($msg))
	 *                                )</pre>
	 *                             and for success==false:
	 *                                <pre>array(
	 *                                  'success' => false,
	 *                                  'error_msg' => base64_encode(rawurlencode($msg))
	 *                                )</pre>
	 */
	private function simple_response($u_action, $msg, $success = true, array $ajax_response = array())
	{
		if ($this->request->is_ajax())
		{
			if (empty($ajax_response))
			{
				$msg_key = $success ? 'msg' : 'error_msg';
				$ajax_response = array(
					'success' => $success,
					$msg_key => base64_encode(rawurlencode($msg)),
				);
			}
			$response = new json_response();
			$response->send($ajax_response);
		}
		if ($success)
		{
			trigger_error($msg . adm_back_link($u_action));
		}
		else
		{
			trigger_error($msg . adm_back_link($u_action), E_USER_WARNING);
		}
	}

	private function get_tag_link($u_action, $tag_id)
	{
		return $u_action . (($tag_id) ? '&amp;tag_id=' . $tag_id : '');
	}

	private function create_sort_selects($selected_sort_key)
	{
		$sort_selects = '<select name="sort_key" id="sort_key">';

		$sort_keys = array(
			self::SORT_NAME_ASC   => $this->user->lang('TOPICTAGS_SORT_NAME_ASC'),
			self::SORT_NAME_DESC  => $this->user->lang('TOPICTAGS_SORT_NAME_DESC'),
			self::SORT_COUNT_ASC  => $this->user->lang('TOPICTAGS_SORT_COUNT_ASC'),
			self::SORT_COUNT_DESC => $this->user->lang('TOPICTAGS_SORT_COUNT_DESC'),
		);

		foreach ($sort_keys as $key => $text)
		{
			$sort_selects .= '<option value="' . $key . '"' . (($selected_sort_key == $key) ? ' selected="selected"' : '') . '>' . $text . '</option>';
		}
		$sort_selects .= '</select>';

		return $sort_selects;
	}
}