CoreFiles by mySites.guru
JSONController.php75 lines, 2,141 bytes, from Joomla_4.0.0-alpha10-Alpha-Full_Package.zip
Raw History Compare with 4.0.0-alpha9
md5
3acf4638a68ff120edca3b8c6ac19f97
sha1
1f749a272b70abb8fda1cde991e34c4d7b451d1b
sha256
91aa867f44184e86bd806cacda408061c0c672b0fa3f5b0edc52d1a9f2c841b4
<?php
/**
 * @package     Joomla.Installation
 * @subpackage  Controller
 *
 * @copyright   Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Installation\Controller;

defined('_JEXEC') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Installation\Response\JsonResponse;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Session\Session;

/**
 * Default JSON controller class for the Joomla Installer controllers.
 *
 * @since  4.0.0
 */
abstract class JSONController extends BaseController
{
	/**
	 * Method to send a JSON response. The data parameter
	 * can be an Exception object for when an error has occurred or
	 * a JsonResponse for a good response.
	 *
	 * @param   mixed  $response  JsonResponse on success, Exception on failure.
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 */
	protected function sendJsonResponse($response)
	{
		$this->app->mimeType = 'application/json';

		// Very crude workaround to give an error message when JSON is disabled
		if (!function_exists('json_encode') || !function_exists('json_decode'))
		{
			$this->app->setHeader('status', 500);
			echo '{"token":"' . Session::getFormToken(true) . '","lang":"' . Factory::getLanguage()->getTag()
				. '","error":true,"header":"' . Text::_('INSTL_HEADER_ERROR') . '","message":"' . Text::_('INSTL_WARNJSON') . '"}';
			return;
		}

		// Check if we need to send an error code.
		if ($response instanceof \Exception)
		{
			// Send the appropriate error code response.
			$this->app->setHeader('status', $response->getCode(), true);
		}

		// Send the JSON response.
		echo json_encode(new JsonResponse($response));
	}

	/**
	 * Checks for a form token, if it is invalid a JSOn response with the error code 403 is sent.
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 * @see     Session::checkToken()
	 */
	public function checkValidToken()
	{
		// Check for request forgeries.
		Session::checkToken() or $this->sendJsonResponse(new \Exception(Text::_('JINVALID_TOKEN_NOTICE'), 403));
	}
}

The same content is in 3 releases, Joomla 4.0.0-alpha8 to 4.0.0-alpha10. See them all, or every version of this file.