ElkArte\Controller\Jslocale

Complexity

Total Complexity

13

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	action_index()	0	13	1
A	trackStats()	0	3	1
A	_prepareLocale()	0	14	1
A	action_sceditor()	0	29	4
A	_sendFile()	0	11	1
A	action_agreement_api()	0	36	5

<?php

/**
 * This file loads javascript localizations (i.e. language strings)
 *
 * @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 ElkArte\AbstractController;
use ElkArte\Action;
use ElkArte\Agreement;
use ElkArte\Http\Headers;
use ElkArte\PrivacyPolicy;
use ElkArte\User;
use ElkArte\Languages\Loader as LangLoader;

/**
 * This file is called via ?action=jslocale to load in a list of
 * language strings for a given area.
 */
class Jslocale extends AbstractController
{
	/** @var string The content of the file to be returned  */
	private $_file_data;

	/**
	 * {@inheritDoc}
	 */
	public function trackStats($action = '')
	{
		return false;
	}

	/**
	 * The default action for the class
	 */
	public function action_index()
	{
		$subActions = [
			'agreement' => [$this, 'action_agreement_api'],
			'sceditor' => [$this, 'action_sceditor']
		];

		// Set up for some action
		$action = new Action();

		// Get the sub action or set a default, call integrate_sa_avatar_settings
		$subAction = $action->initialize($subActions);
		$action->dispatch($subAction);
	}

	/**
	 * Creates the javascript code for localization of the editor (SCEditor)
	 */
	public function action_sceditor()
	{
		global $txt;

		$editortxt = $this->_prepareLocale('Editor');

		// If we don't have any locale better avoid broken js
		if (empty($txt['lang_locale']) || empty($editortxt))
		{
			die();

Using exit here is not recommended.

		}

		$this->_file_data = '(function (sceditor) {
		\'use strict\';

		sceditor.locale[' . JavaScriptEscape($txt['lang_locale']) . '] = {';

		foreach ($editortxt as $key => $val)
		{
			$this->_file_data .= '
			' . JavaScriptEscape($key) . ': ' . JavaScriptEscape($val) . ',';
		}

		$this->_file_data .= '
			dateFormat: "day.month.year"
		}
	})(sceditor);';

		$this->_sendFile();
	}

	/**
	 * Handy shortcut to prepare the "system"
	 *
	 * @param string $language_file
	 */
	private function _prepareLocale($language_file)
	{
		global $modSettings, $language;

		$txteditor = [];
		$lang = new LangLoader(User::$info->language ?? $language, $txteditor, database(), 'editortxt');

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

		$lang->load($language_file);

		theme()->getLayers()->removeAll();

		// Lets make sure we aren't going to output anything nasty.
		obStart(!empty($modSettings['enableCompressedOutput']));

		return $txteditor;
	}

	/**
	 * Takes care of echo'ing the javascript file stored in $this->_file_data
	 */
	private function _sendFile()
	{
		// Make sure they know what type of file we are.
		Headers::instance()
			->contentType('text/javascript', 'UTF-8')
			->sendHeaders();

		echo $this->_file_data;

		// And terminate
		obExit(false);
	}

	/**
	 * Method to handle the API request for agreement and privacy policy by returning it in a
	 * selected language.  Used when checkbox accept agreement is enabled.
	 */
	public function action_agreement_api()
	{
		global $context, $modSettings;

		$languages = getLanguages();
		$lang = $this->_req->getPost('lang', 'trim', 'English');

		setJsonTemplate();
		$context['require_agreement'] = !empty($modSettings['requireAgreement']);

		if (isset($languages[$lang]))
		{
			// If you have to agree to the agreement, it needs to be fetched from the file.
			$agreement = new Agreement($lang);
			if (!empty($modSettings['requirePrivacypolicy']))
			{
				$privacypol = new PrivacyPolicy($lang);
			}

			$context['json_data'] = ['agreement' => '', 'privacypol' => ''];
			try
			{
				$context['json_data']['agreement'] = $agreement->getParsedText();
				if (!empty($modSettings['requirePrivacypolicy']))
				{
					$context['json_data']['privacypol'] = $privacypol->getParsedText();

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

				}
			}
			catch (\Exception $e)
			{
				$context['json_data'] = $e->getMessage();
			}
		}
		else
		{
			$context['json_data'] = '';
		}
	}
}