Files
Component-Builder/admin/src/Controller/Dynamic_getsController.php
Robot 70718936b4 Release of v5.1.1-beta1
Add JCB new package engine.
2025-06-18 19:49:35 +00:00

324 lines
11 KiB
PHP

<?php
/**
* @package Joomla.Component.Builder
*
* @created 30th April, 2015
* @author Llewellyn van der Merwe <https://dev.vdm.io>
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace VDM\Component\Componentbuilder\Administrator\Controller;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\Controller\AdminController;
use Joomla\Utilities\ArrayHelper;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
use VDM\Joomla\Componentbuilder\Package\Factory as PackageFactory;
// No direct access to this file
\defined('_JEXEC') or die;
/**
* Dynamic_gets Admin Controller
*
* @since 1.6
*/
class Dynamic_getsController extends AdminController
{
/**
* The prefix to use with controller messages.
*
* @var string
* @since 1.6
*/
protected $text_prefix = 'COM_COMPONENTBUILDER_DYNAMIC_GETS';
/**
* Proxy for getModel.
*
* @param string $name The model name. Optional.
* @param string $prefix The class prefix. Optional.
* @param array $config Configuration array for model. Optional.
*
* @return \Joomla\CMS\MVC\Model\BaseDatabaseModel
*
* @since 1.6
*/
public function getModel($name = 'Dynamic_get', $prefix = 'Administrator', $config = ['ignore_request' => true])
{
return parent::getModel($name, $prefix, $config);
}
/**
* Redirect the request to the Initialization selection page.
*
* @return bool True on successful initialization, false on failure.
* @since 5.1.1
*/
public function initPowers()
{
// Check for request forgeries
Session::checkToken() or die(Text::_('JINVALID_TOKEN'));
// check if user has the right
$user = $this->app->getIdentity();
// set default error message
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_PERMISSION_DENIED') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_YOU_DO_NOT_HAVE_PERMISSION_TO_INITIALIZE_DYNAMIC_GETS') . '</p>';
$status = 'error';
$success = false;
if($user->authorise('dynamic_get.init', 'com_componentbuilder'))
{
// set success message
$message = null;
$status = null;
$success = true;
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=initialization_selection&power=DynamicGet&target=Dynamic Gets', false);
}
else
{
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
}
$this->setRedirect($redirect_url, $message, $status);
return $success;
}
/**
* Resets the selected Dynamic Gets.
*
* This function performs several checks and operations:
* 1. It verifies the authenticity of the request to prevent request forgery.
* 2. It retrieves the IDs of the selected powers from the user input.
* 3. It sanitizes the input by converting the IDs to integers.
* 4. It checks whether any powers have been selected.
* 5. It checks whether the current user has the necessary permissions to reset the selected Dynamic Gets.
* 6. If the user is authorized and powers are selected, it attempts to reset the selected Dynamic Gets.
* 7. Depending on the result of the reset operation, it sets the appropriate success or error message.
* 8. It redirects the user to a specified URL with the result message and status.
*
* @return bool True on successful reset, false on failure.
* @since 5.1.1
*/
public function resetPowers()
{
// Check for request forgeries
Session::checkToken() or die(Text::_('JINVALID_TOKEN'));
// get IDS of the selected powers
$pks = $this->input->post->get('cid', [], 'array');
// Sanitize the input
ArrayHelper::toInteger($pks);
// check if there is any selections
if ($pks === [])
{
// set error message
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_NO_SELECTION_DETECTED') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_PLEASE_FIRST_MAKE_A_SELECTION_FROM_THE_LIST') . '</p>';
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url, $message, 'error');
return false;
}
$status = 'error';
$success = false;
$has_error = false;
$message_bus = ['success', 'warning', 'error'];
// check if user has the right
$user = $this->app->getIdentity();
if($user->authorise('dynamic_get.reset', 'com_componentbuilder'))
{
// get the guid field of this entity
$key_field = PackageFactory::_('DynamicGet.Remote.Get')->getGuidField();
$guids = PackageFactory::_('Load')->values([$key_field], ['dynamic_get'], ['id' => ['value' => $pks, 'operator' => 'IN']]);
try {
PackageFactory::_('Package.Builder.Get')->reset('dynamic_get', $guids);
foreach ($message_bus as $message_key)
{
if (($messages = PackageFactory::_('Power.Message')->get($message_key, null)) !== null)
{
$messages = '<p>' . implode('<br>', $messages) . '</p>';
$this->app->enqueueMessage($messages, $message_key);
if (!$success && $message_key === 'success')
{
$success = true;
}
if (!$has_error && $message_key === 'error')
{
$has_error = true;
}
}
}
if ($success)
{
// set success message
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_SUCCESS') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THESE_DYNAMIC_GETS_HAVE_SUCCESSFULLY_BEEN_RESET') . '</p>';
$status = 'success';
}
elseif ($has_error)
{
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_RESET_FAILED') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THE_RESET_OF_THESE_DYNAMIC_GETS_HAS_FAILED') . '</p>';
$status = 'error';
}
else
{
// Initialize base values
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_RESET_UNSUCCESSFUL') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THE_RESET_OF_THIS_DYNAMIC_GETS_HAS_NOT_BEEN_SUCCESSFUL') . '</p>';
$status = 'warning';
}
} catch (\Exception $e) {
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_RESET_FAILED') . '</h1>';
$message .= '<p>' . \htmlspecialchars($e->getMessage()) . '</p>';
}
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url, $message, $status);
return $success;
}
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url);
return $success;
}
/**
* Pushes the selected Dynamic Gets.
*
* This function performs several checks and operations:
* 1. It verifies the authenticity of the request to prevent request forgery.
* 2. It retrieves the IDs of the selected powers from the user input.
* 3. It sanitizes the input by converting the IDs to integers.
* 4. It checks whether any powers have been selected.
* 5. It checks whether the current user has the necessary permissions to push the selected Dynamic Gets.
* 6. If the user is authorized and powers are selected, it attempts to push the selected Dynamic Gets.
* 7. Depending on the result of the push operation, it sets the appropriate success or error message.
* 8. It redirects the user to a specified URL with the result message and status.
*
* @return bool True on successful push, false on failure.
* @since 5.1.1
*/
public function pushPowers()
{
// Check for request forgeries
Session::checkToken() or die(Text::_('JINVALID_TOKEN'));
// get IDS of the selected powers
$pks = $this->input->post->get('cid', [], 'array');
// Sanitize the input
ArrayHelper::toInteger($pks);
// check if there is any selections
if ($pks === [])
{
// set error message
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_NO_SELECTION_DETECTED') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_PLEASE_FIRST_MAKE_A_SELECTION_FROM_THE_LIST') . '</p>';
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url, $message, 'error');
return false;
}
$status = 'error';
$success = false;
$has_error = false;
$message_bus = ['success', 'warning', 'error'];
// check if user has the right
$user = $this->app->getIdentity();
if($user->authorise('dynamic_get.push', 'com_componentbuilder'))
{
// get the guid field of this entity
$key_field = PackageFactory::_('DynamicGet.Remote.Set')->getGuidField();
$guids = PackageFactory::_('Load')->values([$key_field], ['dynamic_get'], ['id' => ['value' => $pks, 'operator' => 'IN']]);
try {
PackageFactory::_('Package.Builder.Set')->items('dynamic_get', $guids);
foreach ($message_bus as $message_key)
{
if (($messages = PackageFactory::_('Power.Message')->get($message_key, null)) !== null)
{
$messages = '<p>' . implode('<br>', $messages) . '</p>';
$this->app->enqueueMessage($messages, $message_key);
if (!$success && $message_key === 'success')
{
$success = true;
}
if (!$has_error && $message_key === 'error')
{
$has_error = true;
}
}
}
if ($success)
{
// set success message
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_SUCCESS') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THESE_DYNAMIC_GETS_HAVE_SUCCESSFULLY_BEEN_PUSHED') . '</p>';
$status = 'success';
}
elseif ($has_error)
{
// Initialize base values
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_PUSH_FAILED') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THE_PUSH_OF_THIS_DYNAMIC_GETS_HAS_FAILED') . '</p>';
$status = 'error';
}
else
{
// Initialize base values
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_PUSH_UNSUCCESSFUL') . '</h1>';
$message .= '<p>' . Text::_('COM_COMPONENTBUILDER_THE_PUSH_OF_THIS_DYNAMIC_GETS_HAS_NOT_BEEN_SUCCESSFUL') . '</p>';
$status = 'warning';
}
} catch (\Exception $e) {
$message = '<h1>' . Text::_('COM_COMPONENTBUILDER_PUSH_FAILED') . '</h1>';
$message .= '<p>' . \htmlspecialchars($e->getMessage()) . '</p>';
}
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url, $message, $status);
return $success;
}
// set redirect
$redirect_url = Route::_('index.php?option=com_componentbuilder&view=dynamic_gets', false);
$this->setRedirect($redirect_url);
return $success;
}
}