anavaro\activenotifications\controller\main_controller

Complexity

Total Complexity

20

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Test Coverage

Coverage

93.44%

Importance

Changes	9
Bugs	2	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	get_unread()	0	24	2
A	render_template()	0	6	1
B	base()	0	52	10
A	relative_to_absolute_url()	0	26	6

<?php

/**
 *
 * @package phpBB Extension - Active Notifications
 * @copyright (c) 2015 Lucifer <https://www.anavaro.com>
 * @copyright (c) 2016 kasimi <https://kasimi.net>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace anavaro\activenotifications\controller;

use phpbb\config\config;

The type phpbb\config\config was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\db\driver\driver_interface as db_interface;

The type phpbb\db\driver\driver_interface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\exception\http_exception;

The type phpbb\exception\http_exception was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\notification\manager;

The type phpbb\notification\manager was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\notification\type\type_interface;

The type phpbb\notification\type\type_interface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\path_helper;

The type phpbb\path_helper was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\request\request_interface;

The type phpbb\request\request_interface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\template\template;

The type phpbb\template\template was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\user;

The type phpbb\user was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\HttpFoundation\JsonResponse;

The type Symfony\Component\HttpFoundation\JsonResponse was not found. Maybe you did not declare it correctly or list all dependencies?

class main_controller
{
	/** @var user */
	protected $user;

	/** @var config */
	protected $config;

	/** @var request_interface */
	protected $request;

	/** @var manager */
	protected $notification_manager;

	/** @var string */
	protected $notifications_table;

	/** @var db_interface */
	protected $db;

	/** @var template */
	protected $template;

	/** @var path_helper */
	protected $path_helper;

	/**
	 * Constructor
	 *
	 * @param user				$user
	 * @param config			$config
	 * @param request_interface	$request
	 * @param manager			$notification_manager
	 * @param string			$notifications_table
	 * @param db_interface		$db
	 * @param template			$template
	 * @param path_helper		$path_helper
	 */
	public function __construct(
		user $user,
		config $config,
		request_interface $request,
		manager $notification_manager,
		$notifications_table,
		db_interface $db,
		template $template,
		path_helper $path_helper
	)
	{
		$this->user					= $user;
		$this->config				= $config;
		$this->request				= $request;
		$this->notification_manager	= $notification_manager;
		$this->notifications_table	= $notifications_table;
		$this->db					= $db;
		$this->template				= $template;
		$this->path_helper			= $path_helper;
	}

	/**
	 * @return JsonResponse
	 */
	public function base()
	{
		if ($this->user->data['user_id'] == ANONYMOUS || !$this->user->data['is_registered'] || $this->user->data['is_bot'] || !$this->request->is_ajax() || !$this->config['allow_board_notifications'])

The constant anavaro\activenotifications\controller\ANONYMOUS was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			throw new http_exception(403, 'NO_AUTH_OPERATION');
		}

		$last = $this->request->variable('last', 0);

		$notifications_content = '';
		$notifications = $this->get_unread($last);

		if (!empty($notifications['notifications']))
		{
			$this->template->assign_var('T_THEME_PATH', generate_board_url() . '/styles/' . rawurlencode($this->user->style['style_path']) . '/theme');

The function generate_board_url was not found. Maybe you did not declare it correctly or list all dependencies?

			foreach ($notifications['notifications'] as $notification)
			{
				$last = max($last, $notification->notification_id);

				/*
				 * Let's cheat a bit for tests sake
				 * We know that PHP 7.4.x has issue with bellow line and reports:
				 * "Creating default object from empty value"
				 * So we will depricate errors ONLY for the line that triggers it
				 */
				if (PHP_VERSION_ID > 70399)
				{
					$errorlevel=error_reporting();
					error_reporting(0);
				}

				/** @var type_interface $notification */
				$notification_for_display = $notification->prepare_for_display();

				if (PHP_VERSION_ID > 70399)
				{
					error_reporting($errorlevel);

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

				}
				$notification_for_display['URL'] = $this->relative_to_absolute_url($notification_for_display['URL']);
				$notification_for_display['U_MARK_READ'] = $this->relative_to_absolute_url($notification_for_display['U_MARK_READ']);

				$this->template->assign_block_vars('notifications', $notification_for_display);
			}

			$notifications_content = $this->render_template('notification_dropdown.html');
		}

		return new JsonResponse([
			'last'			=> $last,
			'unread'		=> $notifications['unread_count'],
			'notifications'	=> $notifications_content,
		]);
	}

	/**
	 * @param int $last
	 * @return array
	 */
	protected function get_unread($last)
	{
		$sql_array = [
			'SELECT'	=> 'n.notification_id',
			'FROM'		=> [$this->notifications_table => 'n'],
			'WHERE'		=> 'notification_id > ' . (int) $last . ' AND user_id = ' . (int) $this->user->data['user_id'],
		];

		$sql = $this->db->sql_build_query('SELECT', $sql_array);
		$result = $this->db->sql_query($sql);
		$rows = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		$notifications_new = array_column($rows, 'notification_id');

		// Add non-existent notification so that no new notifications are returned
		if (!$notifications_new)

The expression $notifications_new of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

		{
			$notifications_new[] = 0;
		}

		return $this->notification_manager->load_notifications('notification.method.board', [
			'notification_id'	=> $notifications_new,
			'count_unread'		=> true,
		]);
	}

	/**
	 * Renders a template file and returns it
	 *
	 * @param string $template_file
	 * @return string
	 */
	protected function render_template($template_file)
	{
		$this->template->set_filenames(['body' => $template_file]);
		$content = $this->template->assign_display('body', '', true);

		return trim(str_replace(["\r", "\n"], '', $content));
	}

	/**
	 * Removes all ../ from the beginning of the $url and prepends the board url.
	 *
	 * Example
	 *  in: "./../index.php"
	 *  out: "http://example-board.net/index.php"
	 *
	 * @param string $url
	 * @return string
	 */
	protected function relative_to_absolute_url($url)
	{
		if (!$url)
		{
			return '';
		}

		// Remove leading ../
		$url = $this->path_helper->remove_web_root_path($url);

		// Remove leading . if present
		if (strlen($url) && $url[0] === '.')
		{
			$url = substr($url, 1);
		}

		// Prepend / if not present
		if (strlen($url) && $url[0] !== '/')
		{
			$url = '/' . $url;
		}

		// Prepend board url
		$url = generate_board_url() . $url;

The function generate_board_url was not found. Maybe you did not declare it correctly or list all dependencies?

		return $url;
	}
}