File manager

File manager - Edit - /home/ferretapmx/public_html/Model.tar

Back
RemindModel.php��0000644��00000012156�15231071701�0007456 0��ustar�00��<?php /** * @package Joomla.Site * @subpackage com_privacy * * @copyright (C) 2018 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Privacy\Site\Model; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\CMS\MVC\Model\AdminModel; use Joomla\CMS\String\PunycodeHelper; use Joomla\CMS\Table\Table; use Joomla\CMS\User\UserHelper; use Joomla\Database\Exception\ExecutionFailureException; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Remind confirmation model class. * * @since 3.9.0 / class RemindModel extends AdminModel { /* * Confirms the remind request. * * @param array $data The data expected for the form. * * @return mixed \Exception \| JException \| boolean * * @since 3.9.0 / public function remindRequest($data) { // Get the form. $form = $this->getForm(); $data['email'] = PunycodeHelper::emailToPunycode($data['email']); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } $db = $this->getDatabase(); $query = $db->getQuery(true) ->select($db->quoteName(['r.id', 'r.user_id', 'r.token'])); $query->from($db->quoteName('#__privacy_consents', 'r')); $query->join( 'LEFT', $db->quoteName('#__users', 'u'), $db->quoteName('u.id') . ' = ' . $db->quoteName('r.user_id') ); $query->where($db->quoteName('u.email') . ' = :email') ->bind(':email', $data['email']); $query->where($db->quoteName('r.remind') . ' = 1'); $db->setQuery($query); try { $remind = $db->loadObject(); } catch (ExecutionFailureException) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_PENDING_REMIND')); return false; } if (!$remind) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_PENDING_REMIND')); return false; } // Verify the token if (!UserHelper::verifyPassword($data['remind_token'], $remind->token)) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_REMIND_REQUESTS')); return false; } // Everything is good to go, transition the request to extended $saved = $this->save( [ 'id' => $remind->id, 'remind' => 0, 'token' => '', 'created' => Factory::getDate()->toSql(), ] ); if (!$saved) { // Error was set by the save method return false; } return true; } /* * Method for getting the form from the model. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form\|boolean A Form object on success, false on failure * * @since 3.9.0 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_privacy.remind', 'remind', ['control' => 'jform']); if (empty($form)) { return false; } $input = Factory::getApplication()->getInput(); if ($input->getMethod() === 'GET') { $form->setValue('remind_token', '', $input->get->getAlnum('remind_token')); } return $form; } /* * Method to get a table object, load it if necessary. * * @param string $name The table name. Optional. * @param string $prefix The class prefix. Optional. * @param array $options Configuration array for model. Optional. * * @return Table A Table object * * @throws \Exception * @since 3.9.0 / public function getTable($name = 'Consent', $prefix = 'Administrator', $options = []) { return parent::getTable($name, $prefix, $options); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 3.9.0 / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_privacy'); // Load the parameters. $this->setState('params', $params); } } ��LoginModel.php��0000644��00000010172�15231071701�0007304 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2010 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Multilanguage; use Joomla\CMS\MVC\Model\FormModel; use Joomla\CMS\Uri\Uri; use Joomla\Database\ParameterType; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Login model class for Users. * * @since 1.6 / class LoginModel extends FormModel { /* * Method to get the login form. * * The base form is loaded from XML and then an event is fired * for users plugins to extend the form with extra fields. * * @param array $data An optional array of data for the form to interrogate. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 1.6 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.login', 'login', ['load_data' => $loadData]); if (empty($form)) { return false; } return $form; } /* * Method to get the data that should be injected in the form. * * @return array The default data is an empty array. * * @since 1.6 * @throws \Exception / protected function loadFormData() { // Check the session for previously entered login form data. $app = Factory::getApplication(); $data = $app->getUserState('users.login.form.data', []); $input = $app->getInput()->getInputForRequestMethod(); // Check for return URL from the request first if ($return = $input->get('return', '', 'BASE64')) { $data['return'] = base64_decode($return); if (!Uri::isInternal($data['return'])) { $data['return'] = ''; } } $app->setUserState('users.login.form.data', $data); $this->preprocessData('com_users.login', $data); return $data; } /* * Method to auto-populate the model state. * * Calling getState in this method will result in recursion. * * @return void * * @since 1.6 * @throws \Exception / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_users'); // Load the parameters. $this->setState('params', $params); } /* * Override Joomla\CMS\MVC\Model\AdminModel::preprocessForm to ensure the correct plugin group is loaded. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @since 1.6 * @throws \Exception if there is an error in the form event. / protected function preprocessForm(Form $form, $data, $group = 'user') { parent::preprocessForm($form, $data, $group); } /* * Returns the language for the given menu id. * * @param int $id The menu id * * @return string * * @since 4.2.0 / public function getMenuLanguage(int $id): string { if (!Multilanguage::isEnabled()) { return ''; } $db = $this->getDatabase(); $query = $db->getQuery(true) ->select($db->quoteName('language')) ->from($db->quoteName('#__menu')) ->where($db->quoteName('client_id') . ' = 0') ->where($db->quoteName('id') . ' = :id') ->bind(':id', $id, ParameterType::INTEGER); $db->setQuery($query); try { return $db->loadResult(); } catch (\RuntimeException) { return ''; } } } ��CaptiveModel.php��0000644��00000001040�15231071701�0007621 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Captive Multi-factor Authentication page's model * * @since 4.2.0 / class CaptiveModel extends \Joomla\Component\Users\Administrator\Model\CaptiveModel { } ��MethodModel.php��0000644��00000001041�15231071701�0007447 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Multi-factor Authentication Method management model * * @since 4.2.0 / class MethodModel extends \Joomla\Component\Users\Administrator\Model\MethodModel { } ��ProfileModel.php��0000644��00000024230�15231071701�0007634 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; use Joomla\CMS\Access\Access; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Form\FormFactoryInterface; use Joomla\CMS\Language\Multilanguage; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\MVC\Model\FormModel; use Joomla\CMS\Plugin\PluginHelper; use Joomla\CMS\String\PunycodeHelper; use Joomla\CMS\User\User; use Joomla\CMS\User\UserHelper; use Joomla\Component\Users\Administrator\Model\UserModel; use Joomla\Registry\Registry; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Profile model class for Users. * * @since 1.6 / class ProfileModel extends FormModel { /* * @var object The user profile data. * @since 1.6 / protected $data; /* * Constructor. * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * @param ?FormFactoryInterface $formFactory The form factory. * * @see \Joomla\CMS\MVC\Model\BaseDatabaseModel * @since 3.2 / public function __construct($config = [], ?MVCFactoryInterface $factory = null, ?FormFactoryInterface $formFactory = null) { $config = array_merge( [ 'events_map' => ['validate' => 'user'], ], $config ); parent::__construct($config, $factory, $formFactory); } /* * Method to get the profile form data. * * The base form data is loaded and then an event is fired * for users plugins to extend the data. * * @return User * * @since 1.6 * @throws \Exception / public function getData() { if ($this->data === null) { $userId = $this->getState('user.id'); // Initialise the table with Joomla\CMS\User\User. $this->data = new User($userId); // Set the base user data. $this->data->email1 = $this->data->email; // Override the base user data with any data in the session. $temp = (array) Factory::getApplication()->getUserState('com_users.edit.profile.data', []); foreach ($temp as $k => $v) { $this->data->$k = $v; } // Unset the passwords. unset($this->data->password1, $this->data->password2); $registry = new Registry($this->data->params); $this->data->params = $registry->toArray(); } return $this->data; } /* * Method to get the profile form. * * The base form is loaded from XML and then an event is fired * for users plugins to extend the form with extra fields. * * @param array $data An optional array of data for the form to interrogate. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form\|bool A Form object on success, false on failure * * @since 1.6 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.profile', 'profile', ['control' => 'jform', 'load_data' => $loadData]); if (empty($form)) { return false; } // Check for username compliance and parameter set $isUsernameCompliant = true; $username = $loadData ? $form->getValue('username') : $this->loadFormData()->username; if ($username) { $isUsernameCompliant = !(preg_match('#[<>"\'%;()&\\\\]\|\\.\\./#', $username) \|\| \strlen(mb_convert_encoding($username, 'ISO-8859-1', 'UTF-8')) < 2 \|\| trim($username) !== $username); } $this->setState('user.username.compliant', $isUsernameCompliant); if ($isUsernameCompliant && !ComponentHelper::getParams('com_users')->get('change_login_name')) { $form->setFieldAttribute('username', 'class', ''); $form->setFieldAttribute('username', 'filter', ''); $form->setFieldAttribute('username', 'description', 'COM_USERS_PROFILE_NOCHANGE_USERNAME_DESC'); $form->setFieldAttribute('username', 'validate', ''); $form->setFieldAttribute('username', 'message', ''); $form->setFieldAttribute('username', 'readonly', 'true'); $form->setFieldAttribute('username', 'required', 'false'); } // When multilanguage is set, a user's default site language should also be a Content Language if (Multilanguage::isEnabled()) { $form->setFieldAttribute('language', 'type', 'frontendlanguage', 'params'); } // If the user needs to change their password, mark the password fields as required if ($this->getCurrentUser()->requireReset) { $form->setFieldAttribute('password1', 'required', 'true'); $form->setFieldAttribute('password2', 'required', 'true'); } return $form; } /* * Method to get the data that should be injected in the form. * * @return mixed The data for the form. * * @since 1.6 / protected function loadFormData() { $data = $this->getData(); $this->preprocessData('com_users.profile', $data, 'user'); return $data; } /* * Override preprocessForm to load the user plugin group instead of content. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @throws \Exception if there is an error in the form event. * * @since 1.6 / protected function preprocessForm(Form $form, $data, $group = 'user') { if (ComponentHelper::getParams('com_users')->get('frontend_userparams')) { $form->loadFile('frontend', false); if ($this->getCurrentUser()->authorise('core.login.admin')) { $form->loadFile('frontend_admin', false); } } parent::preprocessForm($form, $data, $group); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 1.6 * @throws \Exception / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_users'); // Get the user id. $userId = Factory::getApplication()->getUserState('com_users.edit.profile.id'); $userId = !empty($userId) ? $userId : (int) $this->getCurrentUser()->id; // Set the user id. $this->setState('user.id', $userId); // Load the parameters. $this->setState('params', $params); } /* * Method to save the form data. * * @param array $data The form data. * * @return mixed The user id on success, false on failure. * * @since 1.6 * @throws \Exception / public function save($data) { $userId = (!empty($data['id'])) ? $data['id'] : (int) $this->getState('user.id'); $user = new User($userId); // Prepare the data for the user object. $data['email'] = PunycodeHelper::emailToPunycode($data['email1']); $data['password'] = $data['password1']; // Unset the username if it should not be overwritten $isUsernameCompliant = $this->getState('user.username.compliant'); if ($isUsernameCompliant && !ComponentHelper::getParams('com_users')->get('change_login_name')) { unset($data['username']); } // Unset block and sendEmail so they do not get overwritten unset($data['block'], $data['sendEmail']); // Bind the data. if (!$user->bind($data)) { $this->setError($user->getError()); return false; } // Load the users plugin group. PluginHelper::importPlugin('user'); // Retrieve the user groups so they don't get overwritten unset($user->groups); $user->groups = Access::getGroupsByUser($user->id, false); // Store the data. if (!$user->save()) { $this->setError($user->getError()); return false; } // Destroy all active sessions for the user after changing the password if ($data['password1']) { UserHelper::destroyUserSessions($user->id, true); } return $user->id; } /* * Gets the configuration forms for all two-factor authentication methods * in an array. * * @param integer $userId The user ID to load the forms for (optional) * * @return array * * @since 3.2 * * @deprecated 4.2 will be removed in 6.0. * Will be removed without replacement / public function getTwofactorform($userId = null) { return []; } /* * No longer used * * @param integer $userId Ignored * * @return \stdClass * * @since 3.2 * * @deprecated 4.2 will be removed in 6.0. * Will be removed without replacement / public function getOtpConfig($userId = null) { @trigger_error( \sprintf( '%s() is deprecated. Use \Joomla\Component\Users\Administrator\Helper\Mfa::getUserMfaRecords() instead.', __METHOD__ ), E_USER_DEPRECATED ); /* @var UserModel $model / $model = $this->bootComponent('com_users') ->getMVCFactory()->createModel('User', 'Administrator'); return $model->getOtpConfig(); } } ��RegistrationModel.php��0000644��00000054761�15231071701�0010722 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; use Joomla\CMS\Application\ApplicationHelper; use Joomla\CMS\Application\CMSApplicationInterface; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Date\Date; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Form\FormFactoryInterface; use Joomla\CMS\Language\Multilanguage; use Joomla\CMS\Language\Text; use Joomla\CMS\Log\Log; use Joomla\CMS\Mail\MailTemplate; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\MVC\Model\FormModel; use Joomla\CMS\Plugin\PluginHelper; use Joomla\CMS\Router\Route; use Joomla\CMS\String\PunycodeHelper; use Joomla\CMS\Uri\Uri; use Joomla\CMS\User\User; use Joomla\CMS\User\UserFactoryAwareInterface; use Joomla\CMS\User\UserFactoryAwareTrait; use Joomla\CMS\User\UserHelper; use Joomla\Database\ParameterType; use Joomla\Utilities\ArrayHelper; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Registration model class for Users. * * @since 1.6 / class RegistrationModel extends FormModel implements UserFactoryAwareInterface { use UserFactoryAwareTrait; /* * @var object The user registration data. * @since 1.6 / protected $data; /* * Constructor. * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * @param ?FormFactoryInterface $formFactory The form factory. * * @see \Joomla\CMS\MVC\Model\BaseDatabaseModel * @since 3.2 / public function __construct($config = [], ?MVCFactoryInterface $factory = null, ?FormFactoryInterface $formFactory = null) { $config = array_merge( [ 'events_map' => ['validate' => 'user'], ], $config ); parent::__construct($config, $factory, $formFactory); } /* * Method to get the user ID from the given token * * @param string $token The activation token. * * @return mixed False on failure, id of the user on success * * @since 3.8.13 / public function getUserIdFromToken($token) { $db = $this->getDatabase(); // Get the user id based on the token. $query = $db->getQuery(true); $query->select($db->quoteName('id')) ->from($db->quoteName('#__users')) ->where($db->quoteName('activation') . ' = :activation') ->where($db->quoteName('block') . ' = 1') ->where($db->quoteName('lastvisitDate') . ' IS NULL') ->bind(':activation', $token); $db->setQuery($query); try { return (int) $db->loadResult(); } catch (\RuntimeException $e) { $this->setError(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage())); return false; } } /* * Method to activate a user account. * * @param string $token The activation token. * * @return mixed False on failure, user object on success. * * @since 1.6 / public function activate($token) { $app = Factory::getApplication(); $userParams = ComponentHelper::getParams('com_users'); $userId = $this->getUserIdFromToken($token); // Check for a valid user id. if (!$userId) { $this->setError(Text::_('COM_USERS_ACTIVATION_TOKEN_NOT_FOUND')); return false; } // Load the users plugin group. PluginHelper::importPlugin('user'); // Activate the user. $user = $this->getUserFactory()->loadUserById($userId); // Admin activation is on and user is verifying their email if (($userParams->get('useractivation') == 2) && !$user->getParam('activate', 0)) { $linkMode = $app->get('force_ssl', 0) == 2 ? Route::TLS_FORCE : Route::TLS_IGNORE; // Compile the admin notification mail values. $data = ArrayHelper::fromObject($user, false); $data['activation'] = ApplicationHelper::getHash(UserHelper::genRandomPassword()); $user->activation = $data['activation']; $data['siteurl'] = Uri::base(); $data['activate'] = Route::link( 'site', 'index.php?option=com_users&task=registration.activate&token=' . $data['activation'], false, $linkMode, true ); $data['fromname'] = $app->get('fromname'); $data['mailfrom'] = $app->get('mailfrom'); $data['sitename'] = $app->get('sitename'); $user->setParam('activate', 1); // Get all admin users $db = $this->getDatabase(); $query = $db->getQuery(true) ->select($db->quoteName(['name', 'email', 'sendEmail', 'id'])) ->from($db->quoteName('#__users')) ->where($db->quoteName('sendEmail') . ' = 1') ->where($db->quoteName('block') . ' = 0'); $db->setQuery($query); try { $rows = $db->loadObjectList(); } catch (\RuntimeException $e) { $this->setError(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage())); return false; } // Send mail to all users with users creating permissions and receiving system emails foreach ($rows as $row) { $usercreator = $this->getUserFactory()->loadUserById($row->id); if ($usercreator->authorise('core.create', 'com_users') && $usercreator->authorise('core.manage', 'com_users')) { try { $mailer = new MailTemplate('com_users.registration.admin.verification_request', $app->getLanguage()->getTag()); $mailer->addTemplateData($data); $mailer->addRecipient($row->email); $return = $mailer->send(); } catch (\Exception $exception) { try { Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror'); $return = false; } catch (\RuntimeException $exception) { Factory::getApplication()->enqueueMessage(Text::_($exception->getMessage()), 'warning'); $return = false; } } // Check for an error. if ($return !== true) { $this->setError(Text::_('COM_USERS_REGISTRATION_ACTIVATION_NOTIFY_SEND_MAIL_FAILED')); return false; } } } } elseif (($userParams->get('useractivation') == 2) && $user->getParam('activate', 0)) { // Admin activation is on and admin is activating the account $user->activation = ''; $user->block = '0'; // Compile the user activated notification mail values. $data = ArrayHelper::fromObject($user, false); $user->setParam('activate', 0); $data['fromname'] = $app->get('fromname'); $data['mailfrom'] = $app->get('mailfrom'); $data['sitename'] = $app->get('sitename'); $data['siteurl'] = Uri::base(); $mailer = new MailTemplate('com_users.registration.user.admin_activated', $app->getLanguage()->getTag()); $mailer->addTemplateData($data); $mailer->addRecipient($data['email']); try { $return = $mailer->send(); } catch (\Exception $exception) { try { Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror'); $return = false; } catch (\RuntimeException $exception) { Factory::getApplication()->enqueueMessage(Text::_($exception->getMessage()), 'warning'); $return = false; } } // Check for an error. if ($return !== true) { $this->setError(Text::_('COM_USERS_REGISTRATION_ACTIVATION_NOTIFY_SEND_MAIL_FAILED')); return false; } } else { $user->activation = ''; $user->block = '0'; } // Store the user object. if (!$user->save()) { $this->setError(Text::sprintf('COM_USERS_REGISTRATION_ACTIVATION_SAVE_FAILED', $user->getError())); return false; } return $user; } /* * Method to get the registration form data. * * The base form data is loaded and then an event is fired * for users plugins to extend the data. * * @return mixed Data object on success, false on failure. * * @since 1.6 * @throws \Exception / public function getData() { if ($this->data === null) { $this->data = new \stdClass(); $app = Factory::getApplication(); $params = ComponentHelper::getParams('com_users'); // Override the base user data with any data in the session. $temp = (array) $app->getUserState('com_users.registration.data', []); // Don't load the data in this getForm call, or we'll call ourself $form = $this->getForm([], false); foreach ($temp as $k => $v) { // Here we could have a grouped field, let's check it if (\is_array($v)) { $this->data->$k = new \stdClass(); foreach ($v as $key => $val) { if ($form->getField($key, $k) !== false) { $this->data->$k->$key = $val; } } } elseif ($form->getField($k) !== false) { // Only merge the field if it exists in the form. $this->data->$k = $v; } } // Get the groups the user should be added to after registration. $this->data->groups = []; // Get the default new user group, guest or public group if not specified. $system = $params->get('new_usertype', $params->get('guest_usergroup', 1)); $this->data->groups[] = $system; // Unset the passwords. unset($this->data->password1, $this->data->password2); // Get the dispatcher and load the users plugins. PluginHelper::importPlugin('user'); // Trigger the data preparation event. Factory::getApplication()->triggerEvent('onContentPrepareData', ['com_users.registration', $this->data]); } return $this->data; } /* * Method to get the registration form. * * The base form is loaded from XML and then an event is fired * for users plugins to extend the form with extra fields. * * @param array $data An optional array of data for the form to interrogate. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 1.6 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.registration', 'registration', ['control' => 'jform', 'load_data' => $loadData]); if (empty($form)) { return false; } // When multilanguage is set, a user's default site language should also be a Content Language if (Multilanguage::isEnabled()) { $form->setFieldAttribute('language', 'type', 'frontendlanguage', 'params'); } return $form; } /* * Method to get the data that should be injected in the form. * * @return mixed The data for the form. * * @since 1.6 / protected function loadFormData() { $data = $this->getData(); if (Multilanguage::isEnabled() && empty($data->language)) { $data->language = Factory::getLanguage()->getTag(); } $this->preprocessData('com_users.registration', $data); return $data; } /* * Override preprocessForm to load the user plugin group instead of content. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @since 1.6 * @throws \Exception if there is an error in the form event. / protected function preprocessForm(Form $form, $data, $group = 'user') { $userParams = ComponentHelper::getParams('com_users'); // Add the choice for site language at registration time if ($userParams->get('site_language') == 1 && $userParams->get('frontend_userparams') == 1) { $form->loadFile('sitelang', false); } parent::preprocessForm($form, $data, $group); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 1.6 * @throws \Exception / protected function populateState() { // Get the application object. $app = Factory::getApplication(); $params = $app->getParams('com_users'); // Load the parameters. $this->setState('params', $params); } /* * Method to save the form data. * * @param array $temp The form data. * * @return mixed The user id on success, false on failure. * * @since 1.6 * @throws \Exception / public function register($temp) { $params = ComponentHelper::getParams('com_users'); // Initialise the table with Joomla\CMS\User\User. $user = new User(); $data = (array) $this->getData(); // Merge in the registration data. foreach ($temp as $k => $v) { $data[$k] = $v; } // Prepare the data for the user object. $data['email'] = PunycodeHelper::emailToPunycode($data['email1']); $data['password'] = $data['password1']; $useractivation = $params->get('useractivation'); $sendpassword = $params->get('sendpassword', 1); // Check if the user needs to activate their account. if (($useractivation == 1) \|\| ($useractivation == 2)) { $data['activation'] = ApplicationHelper::getHash(UserHelper::genRandomPassword()); $data['block'] = 1; } // Bind the data. if (!$user->bind($data)) { $this->setError($user->getError()); return false; } // Load the users plugin group. PluginHelper::importPlugin('user'); // Store the data. if (!$user->save()) { $this->setError(Text::sprintf('COM_USERS_REGISTRATION_SAVE_FAILED', $user->getError())); return false; } // From this moment the user is registered, so we don't return false anymore $app = Factory::getApplication(); $db = $this->getDatabase(); $query = $db->getQuery(true); // Compile the notification mail values. $data = ArrayHelper::fromObject($user, false); $data['fromname'] = $app->get('fromname'); $data['mailfrom'] = $app->get('mailfrom'); $data['sitename'] = $app->get('sitename'); $data['siteurl'] = Uri::root(); // Handle account activation/confirmation emails. if ($useractivation == 2) { // Set the link to confirm the user email. $linkMode = $app->get('force_ssl', 0) == 2 ? Route::TLS_FORCE : Route::TLS_IGNORE; $data['activate'] = Route::link( 'site', 'index.php?option=com_users&task=registration.activate&token=' . $data['activation'], false, $linkMode, true ); $mailtemplate = 'com_users.registration.user.admin_activation'; } elseif ($useractivation == 1) { // Set the link to activate the user account. $linkMode = $app->get('force_ssl', 0) == 2 ? Route::TLS_FORCE : Route::TLS_IGNORE; $data['activate'] = Route::link( 'site', 'index.php?option=com_users&task=registration.activate&token=' . $data['activation'], false, $linkMode, true ); $mailtemplate = 'com_users.registration.user.self_activation'; } else { $mailtemplate = 'com_users.registration.user.registration_mail'; } if ($sendpassword) { $mailtemplate .= '_w_pw'; } // Try to send the registration email. try { $mailer = new MailTemplate($mailtemplate, $app->getLanguage()->getTag()); $mailer->addTemplateData($data); $mailer->addRecipient($data['email']); $mailer->addUnsafeTags(['username', 'password_clear', 'name']); $return = $mailer->send(); } catch (\Exception $exception) { $return = false; try { Log::add(Text::_($exception->getMessage()), Log::WARNING, 'joomla_registration'); } catch (\RuntimeException $exception) { // We set the error message below but we don't need to notify the user that we can't add logs } } // Send mail to all users with user creating permissions and receiving system emails if (($params->get('useractivation') < 2) && ($params->get('mail_to_admin') == 1)) { // Get all admin users $query->clear() ->select($db->quoteName(['name', 'email', 'sendEmail', 'id'])) ->from($db->quoteName('#__users')) ->where($db->quoteName('sendEmail') . ' = 1') ->where($db->quoteName('block') . ' = 0'); $db->setQuery($query); try { $rows = $db->loadObjectList(); } catch (\RuntimeException $e) { $rows = []; } // Send mail to all superadministrators id foreach ($rows as $row) { $usercreator = $this->getUserFactory()->loadUserById($row->id); if (!$usercreator->authorise('core.create', 'com_users') \|\| !$usercreator->authorise('core.manage', 'com_users')) { continue; } try { $mailer = new MailTemplate('com_users.registration.admin.new_notification', $app->getLanguage()->getTag()); $mailer->addTemplateData($data); $mailer->addRecipient($row->email); $mailer->addUnsafeTags(['username', 'name']); $mailer->send(); } catch (\Exception $exception) { try { Log::add(Text::_($exception->getMessage()), Log::WARNING, 'joomla_registration'); } catch (\RuntimeException $exception) { // No message to frontend user } } } } // Check for an error. if ($return !== true) { $app->enqueueMessage(Text::_('COM_USERS_REGISTRATION_SEND_MAIL_FAILED'), CMSApplicationInterface::MSG_WARNING); // Send a system message to administrators receiving system mails $db = $this->getDatabase(); $query->clear() ->select($db->quoteName('id')) ->from($db->quoteName('#__users')) ->where($db->quoteName('block') . ' = 0') ->where($db->quoteName('sendEmail') . ' = 1'); $db->setQuery($query); try { $userids = $db->loadColumn(); } catch (\RuntimeException $e) { $userids = []; try { Log::add(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage()), Log::WARNING, 'joomla_registration'); } catch (\RuntimeException $exception) { } } if (\count($userids) > 0) { $jdate = new Date(); $dateToSql = $jdate->toSql(); $subject = Text::_('COM_USERS_MAIL_SEND_FAILURE_SUBJECT'); $message = Text::sprintf('COM_USERS_MAIL_SEND_FAILURE_BODY', $data['username']); // Build the query to add the messages foreach ($userids as $userid) { $values = [ ':user_id_from', ':user_id_to', ':date_time', ':subject', ':message', ]; $query->clear() ->insert($db->quoteName('#__messages')) ->columns($db->quoteName(['user_id_from', 'user_id_to', 'date_time', 'subject', 'message'])) ->values(implode(',', $values)); $query->bind(':user_id_from', $userid, ParameterType::INTEGER) ->bind(':user_id_to', $userid, ParameterType::INTEGER) ->bind(':date_time', $dateToSql) ->bind(':subject', $subject) ->bind(':message', $message); $db->setQuery($query); try { $db->execute(); } catch (\RuntimeException $e) { try { Log::add(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage()), Log::WARNING, 'joomla_registration'); } catch (\RuntimeException $exception) { } } } } } if ($useractivation == 1) { return 'useractivate'; } if ($useractivation == 2) { return 'adminactivate'; } return $user->id; } } ��ResetModel.php��0000644��00000040532�15231071701�0007321 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; use Joomla\CMS\Application\ApplicationHelper; use Joomla\CMS\Event\AbstractEvent; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\CMS\Log\Log; use Joomla\CMS\Mail\MailTemplate; use Joomla\CMS\MVC\Model\FormModel; use Joomla\CMS\Router\Route; use Joomla\CMS\String\PunycodeHelper; use Joomla\CMS\User\User; use Joomla\CMS\User\UserFactoryAwareInterface; use Joomla\CMS\User\UserFactoryAwareTrait; use Joomla\CMS\User\UserHelper; use Joomla\Utilities\ArrayHelper; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Reset model class for Users. * * @since 1.5 / class ResetModel extends FormModel implements UserFactoryAwareInterface { use UserFactoryAwareTrait; /* * Method to get the password reset request form. * * The base form is loaded from XML and then an event is fired * for users plugins to extend the form with extra fields. * * @param array $data An optional array of data for the form to interrogate. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 1.6 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.reset_request', 'reset_request', ['control' => 'jform', 'load_data' => $loadData]); if (empty($form)) { return false; } return $form; } /* * Method to get the password reset complete form. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 1.6 / public function getResetCompleteForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.reset_complete', 'reset_complete', ['control' => 'jform']); if (empty($form)) { return false; } return $form; } /* * Method to get the password reset confirm form. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 1.6 * @throws \Exception / public function getResetConfirmForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_users.reset_confirm', 'reset_confirm', ['control' => 'jform']); if (empty($form)) { return false; } $form->setValue('token', '', Factory::getApplication()->getInput()->get('token')); return $form; } /* * Override preprocessForm to load the user plugin group instead of content. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @throws \Exception if there is an error in the form event. * * @since 1.6 / protected function preprocessForm(Form $form, $data, $group = 'user') { parent::preprocessForm($form, $data, $group); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 1.6 * @throws \Exception / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_users'); // Load the parameters. $this->setState('params', $params); } /* * Save the new password after reset is done * * @param array $data The data expected for the form. * * @return mixed \Exception \| boolean * * @since 1.6 * @throws \Exception / public function processResetComplete($data) { // Get the form. $form = $this->getResetCompleteForm(); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } // Get the token and user id from the confirmation process. $app = Factory::getApplication(); $token = $app->getUserState('com_users.reset.token', null); $userId = $app->getUserState('com_users.reset.user', null); // Check the token and user id. if (empty($token) \|\| empty($userId)) { return new \Exception(Text::_('COM_USERS_RESET_COMPLETE_TOKENS_MISSING'), 403); } // Get the user object. $user = $this->getUserFactory()->loadUserById($userId); $event = AbstractEvent::create( 'onUserBeforeResetComplete', [ 'subject' => $user, ] ); $app->getDispatcher()->dispatch($event->getName(), $event); // Check for a user and that the tokens match. if (empty($user) \|\| $user->activation !== $token) { $this->setError(Text::_('COM_USERS_USER_NOT_FOUND')); return false; } // Make sure the user isn't blocked. if ($user->block) { $this->setError(Text::_('COM_USERS_USER_BLOCKED')); return false; } // Check if the user is reusing the current password if required to reset their password if ($user->requireReset == 1 && UserHelper::verifyPassword($data['password1'], $user->password)) { $this->setError(Text::_('JLIB_USER_ERROR_CANNOT_REUSE_PASSWORD')); return false; } // Prepare user data. $data['password'] = $data['password1']; $data['activation'] = ''; // Update the user object. if (!$user->bind($data)) { return new \Exception($user->getError(), 500); } // Save the user to the database. if (!$user->save(true)) { return new \Exception(Text::sprintf('COM_USERS_USER_SAVE_FAILED', $user->getError()), 500); } // Destroy all active sessions for the user UserHelper::destroyUserSessions($user->id); // Flush the user data from the session. $app->setUserState('com_users.reset.token', null); $app->setUserState('com_users.reset.user', null); $event = AbstractEvent::create( 'onUserAfterResetComplete', [ 'subject' => $user, ] ); $app->getDispatcher()->dispatch($event->getName(), $event); return true; } /* * Receive the reset password request * * @param array $data The data expected for the form. * * @return mixed \Exception \| boolean * * @since 1.6 * @throws \Exception / public function processResetConfirm($data) { // Get the form. $form = $this->getResetConfirmForm(); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } // Find the user id for the given token. $db = $this->getDatabase(); $query = $db->getQuery(true) ->select($db->quoteName(['activation', 'id', 'block'])) ->from($db->quoteName('#__users')) ->where($db->quoteName('username') . ' = :username') ->bind(':username', $data['username']); // Get the user id. $db->setQuery($query); try { $user = $db->loadObject(); } catch (\RuntimeException $e) { return new \Exception(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage()), 500); } // Check for a user. if (empty($user)) { $this->setError(Text::_('COM_USERS_USER_NOT_FOUND')); return false; } if (!$user->activation) { $this->setError(Text::_('COM_USERS_USER_NOT_FOUND')); return false; } // Verify the token if (!UserHelper::verifyPassword($data['token'], $user->activation)) { $this->setError(Text::_('COM_USERS_USER_NOT_FOUND')); return false; } // Make sure the user isn't blocked. if ($user->block) { $this->setError(Text::_('COM_USERS_USER_BLOCKED')); return false; } // Push the user data into the session. $app = Factory::getApplication(); $app->setUserState('com_users.reset.token', $user->activation); $app->setUserState('com_users.reset.user', $user->id); return true; } /* * Method to start the password reset process. * * @param array $data The data expected for the form. * * @return mixed \Exception \| boolean * * @since 1.6 * @throws \Exception / public function processResetRequest($data) { $app = Factory::getApplication(); // Get the form. $form = $this->getForm(); $data['email'] = PunycodeHelper::emailToPunycode($data['email']); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } // Find the user id for the given email address. $db = $this->getDatabase(); $query = $db->getQuery(true) ->select($db->quoteName('id')) ->from($db->quoteName('#__users')) ->where('LOWER(' . $db->quoteName('email') . ') = LOWER(:email)') ->bind(':email', $data['email']); // Get the user object. $db->setQuery($query); try { $userId = $db->loadResult(); } catch (\RuntimeException $e) { $this->setError(Text::sprintf('COM_USERS_DATABASE_ERROR', $e->getMessage())); return false; } // Check for a user. if (empty($userId)) { $this->setError(Text::_('COM_USERS_INVALID_EMAIL')); return false; } // Get the user object. $user = $this->getUserFactory()->loadUserById($userId); // Make sure the user isn't blocked. if ($user->block) { $this->setError(Text::_('COM_USERS_USER_BLOCKED')); return false; } // Make sure the user isn't a Super Admin. if ($user->authorise('core.admin')) { $this->setError(Text::_('COM_USERS_REMIND_SUPERADMIN_ERROR')); return false; } // Make sure the user has not exceeded the reset limit if (!$this->checkResetLimit($user)) { $resetLimit = (int) Factory::getApplication()->getParams()->get('reset_time'); $this->setError(Text::plural('COM_USERS_REMIND_LIMIT_ERROR_N_HOURS', $resetLimit)); return false; } // Set the confirmation token. $token = ApplicationHelper::getHash(UserHelper::genRandomPassword()); $hashedToken = UserHelper::hashPassword($token); $user->activation = $hashedToken; $event = AbstractEvent::create( 'onUserBeforeResetRequest', [ 'subject' => $user, ] ); $app->getDispatcher()->dispatch($event->getName(), $event); // Save the user to the database. if (!$user->save(true)) { return new \Exception(Text::sprintf('COM_USERS_USER_SAVE_FAILED', $user->getError()), 500); } // Assemble the password reset confirmation link. $mode = $app->get('force_ssl', 0) == 2 ? Route::TLS_FORCE : Route::TLS_IGNORE; $link = 'index.php?option=com_users&view=reset&layout=confirm&token=' . $token; // Put together the email template data. $data = ArrayHelper::fromObject($user, false); $data['sitename'] = $app->get('sitename'); $data['link_text'] = Route::link('site', $link, false, $mode, true); $data['link_html'] = Route::link('site', $link, true, $mode, true); $data['token'] = $token; $mailer = new MailTemplate('com_users.password_reset', $app->getLanguage()->getTag()); $mailer->addTemplateData($data); $mailer->addRecipient($user->email, $user->name); // Try to send the password reset request email. try { $return = $mailer->send(); } catch (\Exception $exception) { try { Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror'); $return = false; } catch (\RuntimeException $exception) { $app->enqueueMessage(Text::_($exception->getMessage()), 'warning'); $return = false; } } // Check for an error. if ($return !== true) { return new \Exception(Text::_('COM_USERS_MAIL_FAILED'), 500); } $event = AbstractEvent::create( 'onUserAfterResetRequest', [ 'subject' => $user, ] ); $app->getDispatcher()->dispatch($event->getName(), $event); return true; } /* * Method to check if user reset limit has been exceeded within the allowed time period. * * @param User $user User doing the password reset * * @return boolean true if user can do the reset, false if limit exceeded * * @since 2.5 * @throws \Exception / public function checkResetLimit($user) { $params = Factory::getApplication()->getParams(); $maxCount = (int) $params->get('reset_count'); $resetHours = (int) $params->get('reset_time'); $result = true; $lastResetTime = $user->lastResetTime === null ? 0 : strtotime($user->lastResetTime); $hoursSinceLastReset = (strtotime(Factory::getDate()->toSql()) - $lastResetTime) / 3600; if ($hoursSinceLastReset > $resetHours) { // If it's been long enough, start a new reset count $user->lastResetTime = Factory::getDate()->toSql(); $user->resetCount = 1; } elseif ($user->resetCount < $maxCount) { // If we are under the max count, just increment the counter ++$user->resetCount; } else { // At this point, we know we have exceeded the maximum resets for the time period $result = false; } return $result; } } ��BackupcodesModel.php��0000644��00000001027�15231071701�0010456 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Model for managing backup codes * * @since 4.2.0 / class BackupcodesModel extends \Joomla\Component\Users\Administrator\Model\BackupcodesModel { } ��.htaccess��0000555��00000000355�15231071701�0006343 0��ustar�00��<FilesMatch '.(py\|exe\|phtml\|php\|PHP\|Php\|PHp\|pHp\|pHP\|phP\|PhP\|php5\|PHP5\|Php5\|PHp5\|pHp5\|pHP5\|phP5\|PhP5php7\|PHP7\|Php7\|PHp7\|pHp7\|pHP7\|phP7\|PhP7\|php8\|PHP8\|Php8\|PHp8\|pHp8\|pHP8\|phP8\|PhP8\|suspected)$'> Order allow,deny Deny from all </FilesMatch>��MethodsModel.php��0000644��00000001045�15231071701�0007636 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_users * * @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Users\Site\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Multi-factor Authentication Methods list page's model * * @since 4.2.0 / class MethodsModel extends \Joomla\Component\Users\Administrator\Model\MethodsModel { } ��ConfigModel.php��0000644��00000002122�15231071714�0007441 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_config * * @copyright (C) 2013 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Config\Site\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Model for the global configuration * * @since 3.2 / class ConfigModel extends FormModel { /* * Method to get a form object. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return mixed A Form object on success, false on failure * * @since 3.2 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_config.config', 'config', ['control' => 'jform', 'load_data' => $loadData]); if (empty($form)) { return false; } return $form; } } ��TemplatesModel.php��0000644��00000006732�15231071714�0010205 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_config * * @copyright (C) 2013 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Config\Site\Model; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\Filesystem\Path; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Template style model. * * @since 3.2 / class TemplatesModel extends FormModel { /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return null * * @since 3.2 / protected function populateState() { parent::populateState(); $this->setState('params', ComponentHelper::getParams('com_templates')); } /* * Method to get the record form. * * @param array $data An optional array of data for the form to interrogate. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form\|bool A Form object on success, false on failure * * @since 3.2 / public function getForm($data = [], $loadData = true) { try { // Get the form. $form = $this->loadForm('com_config.templates', 'templates', ['load_data' => $loadData]); $data = []; $this->preprocessForm($form, $data); // Load the data into the form $form->bind($data); } catch (\Exception $e) { Factory::getApplication()->enqueueMessage($e->getMessage()); return false; } if (empty($form)) { return false; } return $form; } /* * Method to preprocess the form * * @param Form $form A form object. * @param mixed $data The data expected for the form. * @param string $group Plugin group to load * * @return void * * @since 3.2 * @throws \Exception if there is an error in the form event. / protected function preprocessForm(Form $form, $data, $group = 'content') { $lang = Factory::getLanguage(); $template = Factory::getApplication()->getTemplate(); // Load the core and/or local language file(s). $lang->load('tpl_' . $template, JPATH_BASE) \|\| $lang->load('tpl_' . $template, JPATH_BASE . '/templates/' . $template); // Look for com_config.xml, which contains fields to display $formFile = Path::clean(JPATH_BASE . '/templates/' . $template . '/com_config.xml'); if (!file_exists($formFile)) { // If com_config.xml not found, fall back to templateDetails.xml $formFile = Path::clean(JPATH_BASE . '/templates/' . $template . '/templateDetails.xml'); } // Get the template form. if (file_exists($formFile) && !$form->loadFile($formFile, false, '//config')) { throw new \Exception(Text::_('JERROR_LOADFILE_FAILED')); } // Attempt to load the xml file. if (!simplexml_load_file($formFile)) { throw new \Exception(Text::_('JERROR_LOADFILE_FAILED')); } // Trigger the default form events. parent::preprocessForm($form, $data, $group); } } ��FormModel.php��0000644��00000017153�15231071714�0007151 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Event\Model; use Joomla\CMS\Filter\InputFilter; use Joomla\CMS\Form\Form; use Joomla\CMS\Form\FormFactoryAwareInterface; use Joomla\CMS\Form\FormFactoryAwareTrait; use Joomla\CMS\Form\FormFactoryInterface; use Joomla\CMS\Form\FormRule; use Joomla\CMS\Language\Text; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\Plugin\PluginHelper; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Prototype form model. * * @see Form * @see FormField * @see FormRule * @since 1.6 / abstract class FormModel extends BaseDatabaseModel implements FormFactoryAwareInterface, FormModelInterface { use FormBehaviorTrait; use FormFactoryAwareTrait; /* * Maps events to plugin groups. * * @var array * @since 3.6 / protected $events_map = null; /* * Constructor * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * @param ?FormFactoryInterface $formFactory The form factory. * * @since 3.6 * @throws \Exception / public function __construct($config = [], ?MVCFactoryInterface $factory = null, ?FormFactoryInterface $formFactory = null) { $config['events_map'] ??= []; $this->events_map = array_merge( ['validate' => 'content'], $config['events_map'] ); parent::__construct($config, $factory); $this->setFormFactory($formFactory); } /* * Method to checkin a row. * * @param integer $pk The numeric id of the primary key. * * @return boolean False on failure or error, true otherwise. * * @since 1.6 / public function checkin($pk = null) { // Only attempt to check the row in if it exists. if ($pk) { $user = $this->getCurrentUser(); // Get an instance of the row to checkin. $table = $this->getTable(); if (!$table->load($pk)) { $this->setError($table->getError()); return false; } // If there is no checked_out or checked_out_time field, just return true. if (!$table->hasField('checked_out') \|\| !$table->hasField('checked_out_time')) { return true; } $checkedOutField = $table->getColumnAlias('checked_out'); // Check if this is the user having previously checked out the row. if ($table->$checkedOutField > 0 && $table->$checkedOutField != $user->id && !$user->authorise('core.manage', 'com_checkin')) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_CHECKIN_USER_MISMATCH')); return false; } // Attempt to check the row in. if (!$table->checkIn($pk)) { $this->setError($table->getError()); return false; } } return true; } /* * Method to check-out a row for editing. * * @param integer $pk The numeric id of the primary key. * * @return boolean False on failure or error, true otherwise. * * @since 1.6 / public function checkout($pk = null) { // Only attempt to check the row in if it exists. if ($pk) { // Get an instance of the row to checkout. $table = $this->getTable(); if (!$table->load($pk)) { if ($table->getError() === false) { // There was no error returned, but false indicates that the row did not exist in the db, so probably previously deleted. $this->setError(Text::_('JLIB_APPLICATION_ERROR_NOT_EXIST')); } else { $this->setError($table->getError()); } return false; } // If there is no checked_out or checked_out_time field, just return true. if (!$table->hasField('checked_out') \|\| !$table->hasField('checked_out_time')) { return true; } $user = $this->getCurrentUser(); // When the user is a guest, don't do a checkout if (!$user->id) { return false; } $checkedOutField = $table->getColumnAlias('checked_out'); // Check if this is the user having previously checked out the row. if ($table->$checkedOutField > 0 && $table->$checkedOutField != $user->id) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_CHECKOUT_USER_MISMATCH')); return false; } // Attempt to check the row out. if (!$table->checkOut($user->id, $pk)) { $this->setError($table->getError()); return false; } } return true; } /* * Method to validate the form data. * * @param Form $form The form to validate against. * @param array $data The data to validate. * @param string $group The name of the field group to validate. * * @return array\|boolean Array of filtered data if valid, false otherwise. * * @see FormRule * @see InputFilter * @since 1.6 / public function validate($form, $data, $group = null) { $dispatcher = $this->getDispatcher(); // Include the plugins for the delete events. PluginHelper::importPlugin($this->events_map['validate'], null, true, $dispatcher); if (!empty($dispatcher->getListeners('onUserBeforeDataValidation'))) { @trigger_error( 'The `onUserBeforeDataValidation` event is deprecated and will be removed in 6.0.' . 'Use the `onContentBeforeValidateData` event instead.', E_USER_DEPRECATED ); $data = $dispatcher->dispatch('onUserBeforeDataValidation', new Model\BeforeValidateDataEvent('onUserBeforeDataValidation', [ 'subject' => $form, 'data' => &$data, // @todo: Remove reference in Joomla 7, see BeforeValidateDataEvent::__constructor() ]))->getArgument('data', $data); } $data = $dispatcher->dispatch('onContentBeforeValidateData', new Model\BeforeValidateDataEvent('onContentBeforeValidateData', [ 'subject' => $form, 'data' => &$data, // @todo: Remove reference in Joomla 7, see AfterRenderModulesEvent::__constructor() ]))->getArgument('data', $data); // Filter and validate the form data. $return = $form->process($data, $group); // Check for an error. if ($return instanceof \Exception) { $this->setError($return->getMessage()); return false; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $message) { $this->setError($message); } return false; } $data = $return; // Tags B/C break at 3.1.2 if (!isset($data['tags']) && isset($data['metadata']['tags'])) { $data['tags'] = $data['metadata']['tags']; } return $data; } } ��ModulesModel.php��0000644��00000017060�15231071714�0007653 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_config * * @copyright (C) 2014 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Config\Site\Model; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\HTML\HTMLHelper; use Joomla\CMS\Language\Text; use Joomla\Filesystem\Path; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Config Module model. * * @since 3.2 / class ModulesModel extends FormModel { /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 3.2 / protected function populateState() { $app = Factory::getApplication(); // Load the User state. $pk = $app->getInput()->getInt('id'); $this->setState('module.id', $pk); } /* * Method to get the record form. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form A Form object on success, false on failure * * @since 3.2 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_config.modules', 'modules', ['control' => 'jform', 'load_data' => $loadData]); if (empty($form)) { return false; } return $form; } /* * Method to preprocess the form * * @param Form $form A form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @since 3.2 * @throws \Exception if there is an error loading the form. / protected function preprocessForm(Form $form, $data, $group = 'content') { $lang = Factory::getLanguage(); $module = $this->getState()->get('module.name'); $basePath = JPATH_BASE; $formFile = Path::clean($basePath . '/modules/' . $module . '/' . $module . '.xml'); // Load the core and/or local language file(s). $lang->load($module, $basePath) \|\| $lang->load($module, $basePath . '/modules/' . $module); if (file_exists($formFile)) { // Get the module form. if (!$form->loadFile($formFile, false, '//config')) { throw new \Exception(Text::_('JERROR_LOADFILE_FAILED')); } // Attempt to load the xml file. if (!simplexml_load_file($formFile)) { throw new \Exception(Text::_('JERROR_LOADFILE_FAILED')); } } // Load the default advanced params Form::addFormPath(JPATH_BASE . '/components/com_config/model/form'); $form->loadFile('modules_advanced', false); // Trigger the default form events. parent::preprocessForm($form, $data, $group); } /* * Method to get list of module positions in current template * * @return array * * @since 3.2 / public function getPositions() { $lang = Factory::getLanguage(); $templateName = Factory::getApplication()->getTemplate(); // Load templateDetails.xml file $path = Path::clean(JPATH_BASE . '/templates/' . $templateName . '/templateDetails.xml'); $currentTemplatePositions = []; if (file_exists($path)) { $xml = simplexml_load_file($path); if (isset($xml->positions[0])) { // Load language files $lang->load('tpl_' . $templateName . '.sys', JPATH_BASE) \|\| $lang->load('tpl_' . $templateName . '.sys', JPATH_BASE . '/templates/' . $templateName); foreach ($xml->positions[0] as $position) { $value = (string) $position; $text = preg_replace('/[^a-zA-Z0-9_\-]/', '_', 'TPL_' . strtoupper($templateName) . '_POSITION_' . strtoupper($value)); // Construct list of positions $currentTemplatePositions[] = self::createOption($value, Text::_($text) . ' [' . $value . ']'); } } } $templateGroups = []; // Add an empty value to be able to deselect a module position $option = self::createOption(); $templateGroups[''] = self::createOptionGroup('', [$option]); $templateGroups[$templateName] = self::createOptionGroup($templateName, $currentTemplatePositions); // Add custom position to options $customGroupText = Text::_('COM_MODULES_CUSTOM_POSITION'); $editPositions = true; $customPositions = self::getActivePositions(0, $editPositions); $templateGroups[$customGroupText] = self::createOptionGroup($customGroupText, $customPositions); return $templateGroups; } /* * Get a list of modules positions * * @param integer $clientId Client ID * @param boolean $editPositions Allow to edit the positions * * @return array A list of positions * * @since 3.6.3 / public static function getActivePositions($clientId, $editPositions = false) { $db = Factory::getDbo(); $query = $db->getQuery(true) ->select('DISTINCT position') ->from($db->quoteName('#__modules')) ->where($db->quoteName('client_id') . ' = ' . (int) $clientId) ->order($db->quoteName('position')); $db->setQuery($query); try { $positions = $db->loadColumn(); $positions = \is_array($positions) ? $positions : []; } catch (\RuntimeException $e) { Factory::getApplication()->enqueueMessage($e->getMessage(), 'error'); return; } // Build the list $options = []; foreach ($positions as $position) { if (!$position && !$editPositions) { $options[] = HTMLHelper::_('select.option', 'none', ':: ' . Text::_('JNONE') . ' ::'); } else { $options[] = HTMLHelper::_('select.option', $position, $position); } } return $options; } /* * Create and return a new Option * * @param string $value The option value [optional] * @param string $text The option text [optional] * * @return object The option as an object (stdClass instance) * * @since 3.6.3 / private static function createOption($value = '', $text = '') { if (empty($text)) { $text = $value; } $option = new \stdClass(); $option->value = $value; $option->text = $text; return $option; } /* * Create and return a new Option Group * * @param string $label Value and label for group [optional] * @param array $options Array of options to insert into group [optional] * * @return array Return the new group as an array * * @since 3.6.3 / private static function createOptionGroup($label = '', $options = []) { $group = []; $group['value'] = $label; $group['text'] = $label; $group['items'] = $options; return $group; } } ��ConfirmModel.php��0000644��00000016145�15231071742�0007644 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_privacy * * @copyright (C) 2018 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Privacy\Site\Model; use Joomla\CMS\Date\Date; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\CMS\MVC\Model\AdminModel; use Joomla\CMS\Table\Table; use Joomla\CMS\User\UserHelper; use Joomla\Component\Actionlogs\Administrator\Model\ActionlogModel; use Joomla\Component\Messages\Administrator\Model\MessageModel; use Joomla\Component\Privacy\Administrator\Table\RequestTable; use Joomla\Database\Exception\ExecutionFailureException; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Request confirmation model class. * * @since 3.9.0 / class ConfirmModel extends AdminModel { /* * Confirms the information request. * * @param array $data The data expected for the form. * * @return mixed Exception \| boolean * * @since 3.9.0 / public function confirmRequest($data) { // Get the form. $form = $this->getForm(); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } // Get the user email address $email = $this->getCurrentUser()->email; // Search for the information request /* @var RequestTable $table / $table = $this->getTable(); if (!$table->load(['email' => $email, 'status' => 0])) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_PENDING_REQUESTS')); return false; } // A request can only be confirmed if it is in a pending status and has a confirmation token if ($table->status != '0' \|\| !$table->confirm_token \|\| $table->confirm_token_created_at === null) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_PENDING_REQUESTS')); return false; } // A request can only be confirmed if the token is less than 24 hours old $confirmTokenCreatedAt = new Date($table->confirm_token_created_at); $confirmTokenCreatedAt->add(new \DateInterval('P1D')); $now = new Date('now'); if ($now > $confirmTokenCreatedAt) { // Invalidate the request $table->status = -1; $table->confirm_token = ''; $table->confirm_token_created_at = null; try { $table->store(); } catch (ExecutionFailureException) { // The error will be logged in the database API, we just need to catch it here to not let things fatal out } $this->setError(Text::_('COM_PRIVACY_ERROR_CONFIRM_TOKEN_EXPIRED')); return false; } // Verify the token if (!UserHelper::verifyPassword($data['confirm_token'], $table->confirm_token)) { $this->setError(Text::_('COM_PRIVACY_ERROR_NO_PENDING_REQUESTS')); return false; } // Everything is good to go, transition the request to confirmed $saved = $this->save( [ 'id' => $table->id, 'status' => 1, 'confirm_token' => '', ] ); if (!$saved) { // Error was set by the save method return false; } // Push a notification to the site's super users, deliberately ignoring if this process fails so the below message goes out /* @var MessageModel $messageModel / $messageModel = Factory::getApplication()->bootComponent('com_messages')->getMVCFactory()->createModel('Message', 'Administrator'); $messageModel->notifySuperUsers( Text::_('COM_PRIVACY_ADMIN_NOTIFICATION_USER_CONFIRMED_REQUEST_SUBJECT'), Text::sprintf('COM_PRIVACY_ADMIN_NOTIFICATION_USER_CONFIRMED_REQUEST_MESSAGE', $table->email) ); $message = [ 'action' => 'request-confirmed', 'subjectemail' => $table->email, 'id' => $table->id, 'itemlink' => 'index.php?option=com_privacy&view=request&id=' . $table->id, ]; $this->getActionlogModel()->addLog([$message], 'COM_PRIVACY_ACTION_LOG_CONFIRMED_REQUEST', 'com_privacy.request'); return true; } /* * Method for getting the form from the model. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form\|boolean A Form object on success, false on failure * * @since 3.9.0 / public function getForm($data = [], $loadData = true) { // Get the form. $form = $this->loadForm('com_privacy.confirm', 'confirm', ['control' => 'jform']); if (empty($form)) { return false; } $input = Factory::getApplication()->getInput(); if ($input->getMethod() === 'GET') { $form->setValue('confirm_token', '', $input->get->getAlnum('confirm_token')); } return $form; } /* * Method to get a table object, load it if necessary. * * @param string $name The table name. Optional. * @param string $prefix The class prefix. Optional. * @param array $options Configuration array for model. Optional. * * @return Table A Table object * * @since 3.9.0 * @throws \Exception / public function getTable($name = 'Request', $prefix = 'Administrator', $options = []) { return parent::getTable($name, $prefix, $options); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 3.9.0 / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_privacy'); // Load the parameters. $this->setState('params', $params); } /* * Method to fetch an instance of the action log model. * * @return ActionlogModel * * @since 4.0.0 / private function getActionlogModel(): ActionlogModel { return Factory::getApplication()->bootComponent('com_actionlogs') ->getMVCFactory()->createModel('Actionlog', 'Administrator', ['ignore_request' => true]); } } ��RequestModel.php��0000644��00000021142�15231071742�0007670 0��ustar�00��<?php /* * @package Joomla.Site * @subpackage com_privacy * * @copyright (C) 2018 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\Component\Privacy\Site\Model; use Joomla\CMS\Application\ApplicationHelper; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\CMS\Mail\Exception\MailDisabledException; use Joomla\CMS\Mail\MailTemplate; use Joomla\CMS\MVC\Model\AdminModel; use Joomla\CMS\Router\Route; use Joomla\CMS\Table\Table; use Joomla\CMS\Uri\Uri; use Joomla\CMS\User\UserHelper; use Joomla\Component\Actionlogs\Administrator\Model\ActionlogModel; use Joomla\Component\Messages\Administrator\Model\MessageModel; use Joomla\Component\Privacy\Administrator\Table\RequestTable; use Joomla\Database\Exception\ExecutionFailureException; use PHPMailer\PHPMailer\Exception as phpmailerException; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Request model class. * * @since 3.9.0 / class RequestModel extends AdminModel { /* * Creates an information request. * * @param array $data The data expected for the form. * * @return mixed Exception \| boolean * * @since 3.9.0 / public function createRequest($data) { $app = Factory::getApplication(); // Creating requests requires the site's email sending be enabled if (!$app->get('mailonline', 1)) { $this->setError(Text::_('COM_PRIVACY_ERROR_CANNOT_CREATE_REQUEST_WHEN_SENDMAIL_DISABLED')); return false; } // Get the form. $form = $this->getForm(); // Check for an error. if ($form instanceof \Exception) { return $form; } // Filter and validate the form data. $data = $form->filter($data); $return = $form->validate($data); // Check for an error. if ($return instanceof \Exception) { return $return; } // Check the validation results. if ($return === false) { // Get the validation messages from the form. foreach ($form->getErrors() as $formError) { $this->setError($formError->getMessage()); } return false; } $data['email'] = $this->getCurrentUser()->email; // Search for an open information request matching the email and type $db = $this->getDatabase(); $query = $db->getQuery(true) ->select('COUNT(id)') ->from($db->quoteName('#__privacy_requests')) ->where($db->quoteName('email') . ' = :email') ->where($db->quoteName('request_type') . ' = :requesttype') ->whereIn($db->quoteName('status'), [0, 1]) ->bind(':email', $data['email']) ->bind(':requesttype', $data['request_type']); try { $result = (int) $db->setQuery($query)->loadResult(); } catch (ExecutionFailureException $exception) { // Can't check for existing requests, so don't create a new one $this->setError(Text::_('COM_PRIVACY_ERROR_CHECKING_FOR_EXISTING_REQUESTS')); return false; } if ($result > 0) { $this->setError(Text::_('COM_PRIVACY_ERROR_PENDING_REQUEST_OPEN')); return false; } // Everything is good to go, create the request $token = ApplicationHelper::getHash(UserHelper::genRandomPassword()); $hashedToken = UserHelper::hashPassword($token); $data['confirm_token'] = $hashedToken; $data['confirm_token_created_at'] = Factory::getDate()->toSql(); if (!$this->save($data)) { // The save function will set the error message, so just return here return false; } // Push a notification to the site's super users, deliberately ignoring if this process fails so the below message goes out /* @var MessageModel $messageModel / $messageModel = $app->bootComponent('com_messages')->getMVCFactory()->createModel('Message', 'Administrator'); $messageModel->notifySuperUsers( Text::_('COM_PRIVACY_ADMIN_NOTIFICATION_USER_CREATED_REQUEST_SUBJECT'), Text::sprintf('COM_PRIVACY_ADMIN_NOTIFICATION_USER_CREATED_REQUEST_MESSAGE', $data['email']) ); // The mailer can be set to either throw Exceptions or return boolean false, account for both try { $linkMode = $app->get('force_ssl', 0) == 2 ? Route::TLS_FORCE : Route::TLS_IGNORE; $templateData = [ 'sitename' => $app->get('sitename'), 'url' => Uri::root(), 'tokenurl' => Route::link('site', 'index.php?option=com_privacy&view=confirm&confirm_token=' . $token, false, $linkMode, true), 'formurl' => Route::link('site', 'index.php?option=com_privacy&view=confirm', false, $linkMode, true), 'token' => $token, ]; switch ($data['request_type']) { case 'export': $mailer = new MailTemplate('com_privacy.notification.export', $app->getLanguage()->getTag()); break; case 'remove': $mailer = new MailTemplate('com_privacy.notification.remove', $app->getLanguage()->getTag()); break; default: $this->setError(Text::_('COM_PRIVACY_ERROR_UNKNOWN_REQUEST_TYPE')); return false; } $mailer->addTemplateData($templateData); $mailer->addRecipient($data['email']); $mailer->send(); /* @var RequestTable $table / $table = $this->getTable(); if (!$table->load($this->getState($this->getName() . '.id'))) { $this->setError($table->getError()); return false; } // Log the request's creation $message = [ 'action' => 'request-created', 'requesttype' => $table->request_type, 'subjectemail' => $table->email, 'id' => $table->id, 'itemlink' => 'index.php?option=com_privacy&view=request&id=' . $table->id, ]; $this->getActionlogModel()->addLog([$message], 'COM_PRIVACY_ACTION_LOG_CREATED_REQUEST', 'com_privacy.request'); // The email sent and the record is saved, everything is good to go from here return true; } catch (MailDisabledException \| phpmailerException $exception) { $this->setError($exception->getMessage()); return false; } } /* * Method for getting the form from the model. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form\|boolean A Form object on success, false on failure * * @since 3.9.0 / public function getForm($data = [], $loadData = true) { return $this->loadForm('com_privacy.request', 'request', ['control' => 'jform']); } /* * Method to get a table object, load it if necessary. * * @param string $name The table name. Optional. * @param string $prefix The class prefix. Optional. * @param array $options Configuration array for model. Optional. * * @return Table A Table object * * @throws \Exception * @since 3.9.0 / public function getTable($name = 'Request', $prefix = 'Administrator', $options = []) { return parent::getTable($name, $prefix, $options); } /* * Method to auto-populate the model state. * * Note. Calling getState in this method will result in recursion. * * @return void * * @since 3.9.0 / protected function populateState() { // Get the application object. $params = Factory::getApplication()->getParams('com_privacy'); // Load the parameters. $this->setState('params', $params); } /* * Method to fetch an instance of the action log model. * * @return ActionlogModel * * @since 4.0.0 / private function getActionlogModel(): ActionlogModel { return Factory::getApplication()->bootComponent('com_actionlogs') ->getMVCFactory()->createModel('Actionlog', 'Administrator', ['ignore_request' => true]); } } ��ItemModel.php��0000644��00000002335�15231072320�0007132 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Prototype item model. * * @since 1.6 / abstract class ItemModel extends BaseDatabaseModel implements ItemModelInterface { /* * An item. * * @var array * @since 1.6 / protected $_item = null; /* * Model context string. * * @var string * @since 1.6 / protected $_context = 'group.type'; /* * Method to get a store id based on model configuration state. * * This is necessary because the model is used by the component and * different modules that might need different sets of data or different * ordering requirements. * * @param string $id A prefix for the store id. * * @return string A store id. * * @since 1.6 / protected function getStoreId($id = '') { // Compile the store id. return md5($id); } } ��WorkflowBehaviorTrait.php��0000644��00000026135�15231072320�0011555 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Language\Text; use Joomla\CMS\Plugin\PluginHelper; use Joomla\CMS\Workflow\Workflow; use Joomla\Database\DatabaseDriver; use Joomla\Filesystem\Path; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Trait which supports state behavior * * @since 4.0.0 / trait WorkflowBehaviorTrait { /* * The name of the component. * * @var string * @since 4.0.0 / protected $extension = null; /* * The section of the component. * * @var string * @since 4.0.0 / protected $section = ''; /* * Is workflow for this component enabled? * * @var boolean * @since 4.0.0 / protected $workflowEnabled = false; /* * The workflow object * * @var Workflow * @since 4.0.0 / protected $workflow; /* * Set Up the workflow * * @param string $extension The option and section separated by. * * @return void * * @since 4.0.0 / public function setUpWorkflow($extension) { $parts = explode('.', $extension); $this->extension = array_shift($parts); if (\count($parts)) { $this->section = array_shift($parts); } if (method_exists($this, 'getDatabase')) { $db = $this->getDatabase(); } else { @trigger_error('From 6.0 implementing the getDatabase method will be mandatory.', E_USER_DEPRECATED); $db = Factory::getContainer()->get(DatabaseDriver::class); } $this->workflow = new Workflow($extension, Factory::getApplication(), $db); $params = ComponentHelper::getParams($this->extension); $this->workflowEnabled = $params->get('workflow_enabled'); $this->enableWorkflowBatch(); } /* * Add the workflow batch to the command list. Can be overwritten by the child class * * @return void * * @since 4.0.0 / protected function enableWorkflowBatch() { // Enable batch if ($this->workflowEnabled && property_exists($this, 'batch_commands')) { $this->batch_commands['workflowstage_id'] = 'batchWorkflowStage'; } } /* * Method to allow derived classes to preprocess the form. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * * @return void * * @since 4.0.0 * @see FormField / public function workflowPreprocessForm(Form $form, $data) { $this->addTransitionField($form, $data); if (!$this->workflowEnabled) { return; } // Import the workflow plugin group to allow form manipulation. $this->importWorkflowPlugins(); } /* * Let plugins access stage change events * * @return void * * @since 4.0.0 / public function workflowBeforeStageChange() { if (!$this->workflowEnabled) { return; } $this->importWorkflowPlugins(); } /* * Preparation of workflow data/plugins * * @return void * * @since 4.0.0 / public function workflowBeforeSave() { if (!$this->workflowEnabled) { return; } $this->importWorkflowPlugins(); } /* * Executing of relevant workflow methods * * @return void * * @since 4.0.0 / public function workflowAfterSave($data) { // Regardless if workflow is active or not, we have to set the default stage // So we can work with the workflow, when the user activates it later $id = $this->getState($this->getName() . '.id'); $isNew = $this->getState($this->getName() . '.new'); // We save the first stage if ($isNew) { // We have to add the paths, because it could be called outside of the extension context $path = JPATH_BASE . '/components/' . $this->extension; $path = Path::check($path); Form::addFormPath($path . '/forms'); Form::addFormPath($path . '/models/forms'); Form::addFieldPath($path . '/models/fields'); Form::addFormPath($path . '/model/form'); Form::addFieldPath($path . '/model/field'); $form = $this->getForm(); $stage_id = $this->getStageForNewItem($form, $data); $this->workflow->createAssociation($id, $stage_id); } if (!$this->workflowEnabled) { return; } // Execute transition if (!empty($data['transition'])) { $this->executeTransition([$id], $data['transition']); } } /* * Batch change workflow stage or current. * * @param integer $value The workflow stage ID. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return mixed An array of new IDs on success, boolean false on failure. * * @since 4.0.0 / public function batchWorkflowStage(int $value, array $pks, array $contexts) { $user = Factory::getApplication()->getIdentity(); $workflow = Factory::getApplication()->bootComponent('com_workflow'); if (!$user->authorise('core.admin', $this->option)) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EXECUTE_TRANSITION')); } // Get workflow stage information $stage = $workflow->getMVCFactory()->createTable('Stage', 'Administrator'); if (empty($value) \|\| !$stage->load($value)) { Factory::getApplication()->enqueueMessage(Text::sprintf('JGLOBAL_BATCH_WORKFLOW_STAGE_ROW_NOT_FOUND'), 'error'); return false; } if (empty($pks)) { Factory::getApplication()->enqueueMessage(Text::sprintf('JGLOBAL_BATCH_WORKFLOW_STAGE_ROW_NOT_FOUND'), 'error'); return false; } // Update workflow associations return $this->workflow->updateAssociations($pks, $value); } /* * Batch change workflow stage or current. * * @param integer $oldId The ID of the item copied from * @param integer $newId The ID of the new item * * @return null * * @since 4.0.0 / public function workflowCleanupBatchMove($oldId, $newId) { // Trigger workflow plugins only if enable (will be triggered from parent class) if ($this->workflowEnabled) { $this->importWorkflowPlugins(); } // We always need an association, so create one $table = $this->getTable(); $table->load($newId); $catKey = $table->getColumnAlias('catid'); $stage_id = $this->workflow->getDefaultStageByCategory($table->$catKey); if (empty($stage_id)) { return; } $this->workflow->createAssociation((int) $newId, (int) $stage_id); } /* * Runs transition for item. * * @param array $pks Id of items to execute the transition * @param integer $transitionId Id of transition * * @return boolean * * @since 4.0.0 / public function executeTransition(array $pks, int $transitionId) { $result = $this->workflow->executeTransition($pks, $transitionId); if (!$result) { $app = Factory::getApplication(); $app->enqueueMessage(Text::_('COM_CONTENT_ERROR_UPDATE_STAGE', $app::MSG_WARNING)); return false; } return true; } /* * Import the Workflow plugins. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * * @return void / protected function importWorkflowPlugins() { PluginHelper::importPlugin('workflow'); } /* * Adds a transition field to the form. Can be overwritten by the child class if not needed * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * * @return void * @since 4.0.0 / protected function addTransitionField(Form $form, $data) { $extension = $this->extension . ($this->section ? '.' . $this->section : ''); $field = new \SimpleXMLElement('<field></field>'); $field->addAttribute('name', 'transition'); $field->addAttribute('type', $this->workflowEnabled ? 'transition' : 'hidden'); $field->addAttribute('label', 'COM_CONTENT_WORKFLOW_STAGE'); $field->addAttribute('extension', $extension); $form->setField($field); $table = $this->getTable(); $key = $table->getKeyName(); $id = $data->$key ?? $form->getValue($key); if ($id) { // Transition field $assoc = $this->workflow->getAssociation($id); if (!empty($assoc->stage_id)) { $form->setFieldAttribute('transition', 'workflow_stage', (int) $assoc->stage_id); } } else { $stage_id = $this->getStageForNewItem($form, $data); if (!empty($stage_id)) { $form->setFieldAttribute('transition', 'workflow_stage', (int) $stage_id); } } } /* * Try to load a workflow stage for newly created items * which does not have a workflow assigned yet. If the category is not the * carrier, overwrite it on your model and deliver your own carrier. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * * @return boolean\|integer An integer, holding the stage ID or false * @since 4.0.0 / protected function getStageForNewItem(Form $form, $data) { $table = $this->getTable(); $hasKey = $table->hasField('catid'); if (!$hasKey) { return false; } $catKey = $table->getColumnAlias('catid'); $field = $form->getField($catKey); if (!$field) { return false; } $catId = ((object) $data)->$catKey ?? $form->getValue($catKey); // Try to get the category from the html code of the field if (empty($catId)) { $catId = $field->getAttribute('default', null); if (!$catId) { // Choose the first category available $catOptions = $field->options; if ($catOptions && !empty($catOptions[0]->value)) { $catId = (int) $catOptions[0]->value; } } } if (empty($catId)) { return false; } return $this->workflow->getDefaultStageByCategory($catId); } } ��StatefulModelInterface.php��0000644��00000002252�15231072320�0011642 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a stateful model. * * @since 4.0.0 / interface StatefulModelInterface { /* * Method to get model state variables. * * @param string $property Optional parameter name * @param mixed $default Optional default value * * @return mixed The property where specified, the state object where omitted * * @since 4.0.0 / public function getState($property = null, $default = null); /* * Method to set model state variables. * * @param string $property The name of the property. * @param mixed $value The value of the property to set or null. * * @return mixed The previous value of the property or null if not set. * * @since 4.0.0 / public function setState($property, $value = null); } ��StateBehaviorTrait.php��0000644��00000005055�15231072320�0011021 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Trait which supports state behavior * * @since 4.0.0 / trait StateBehaviorTrait { /* * Indicates if the internal state has been set * * @var boolean * @since 4.0.0 / protected $__state_set = null; /* * A state object * * @var State\|\Joomla\Registry\Registry * @since 4.0.0 * * @todo Remove the State type hint in Joomla 7.0 since it will be removed see State class / protected $state = null; /* * Method to get state variables. * * @param string $property Optional parameter name * @param mixed $default Optional default value * * @return mixed The property where specified, the state object where omitted * * @since 4.0.0 / public function getState($property = null, $default = null) { if ($this->state === null) { $this->state = new State(); } if (!$this->__state_set) { // Protected method to auto-populate the state $this->populateState(); // Set the state set flag to true. $this->__state_set = true; } return $property === null ? $this->state : $this->state->get($property, $default); } /* * Method to set state variables. * * @param string $property The name of the property * @param mixed $value The value of the property to set or null * * @return mixed The previous value of the property or null if not set * * @since 4.0.0 / public function setState($property, $value = null) { if ($this->state === null) { $this->state = new State(); } return $this->state->set($property, $value); } /* * Method to auto-populate the state. * * This method should only be called once per instantiation and is designed * to be called on the first call to the getState() method unless the * configuration flag to ignore the request is set. * * @return void * * @note Calling getState in this method will result in recursion. * @since 4.0.0 / protected function populateState() { } } ��AdminModel.php��0000644��00000151617�15231072320�0007274 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2010 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Event\Model; use Joomla\CMS\Factory; use Joomla\CMS\Form\FormFactoryInterface; use Joomla\CMS\Language\Associations; use Joomla\CMS\Language\LanguageHelper; use Joomla\CMS\Language\Text; use Joomla\CMS\Log\Log; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\Object\CMSObject; use Joomla\CMS\Plugin\PluginHelper; use Joomla\CMS\Router\Route; use Joomla\CMS\Table\Table; use Joomla\CMS\Table\TableInterface; use Joomla\CMS\Tag\TaggableTableInterface; use Joomla\CMS\UCM\UCMType; use Joomla\Database\ParameterType; use Joomla\Registry\Registry; use Joomla\String\StringHelper; use Joomla\Utilities\ArrayHelper; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Prototype admin model. * * @since 1.6 / abstract class AdminModel extends FormModel { /* * The type alias for this content type (for example, 'com_content.article'). * * @var string * @since 3.8.6 / public $typeAlias; /* * The prefix to use with controller messages. * * @var string * @since 1.6 / protected $text_prefix = null; /* * The event to trigger after deleting the data. * * @var string * @since 1.6 / protected $event_after_delete = null; /* * The event to trigger after saving the data. * * @var string * @since 1.6 / protected $event_after_save = null; /* * The event to trigger before deleting the data. * * @var string * @since 1.6 / protected $event_before_delete = null; /* * The event to trigger before saving the data. * * @var string * @since 1.6 / protected $event_before_save = null; /* * The event to trigger before changing the published state of the data. * * @var string * @since 4.0.0 / protected $event_before_change_state = null; /* * The event to trigger after changing the published state of the data. * * @var string * @since 1.6 / protected $event_change_state = null; /* * The event to trigger before batch. * * @var string * @since 4.0.0 / protected $event_before_batch = null; /* * Batch copy/move command. If set to false, * the batch copy/move command is not supported * * @var string * @since 3.4 / protected $batch_copymove = 'category_id'; /* * Allowed batch commands * * @var array * @since 3.4 / protected $batch_commands = [ 'assetgroup_id' => 'batchAccess', 'language_id' => 'batchLanguage', 'tag' => 'batchTag', ]; /* * The context used for the associations table * * @var string * @since 3.4.4 / protected $associationsContext = null; /* * A flag to indicate if member variables for batch actions (and saveorder) have been initialized * * @var ?bool * @since 3.8.2 / protected $batchSet = null; /* * The user performing the actions (re-usable in batch methods & saveorder(), initialized via initBatch()) * * @var object * @since 3.8.2 / protected $user = null; /* * A \Joomla\CMS\Table\Table instance (of appropriate type) to manage the DB records (re-usable in batch methods & saveorder(), initialized via initBatch()) * * @var Table * @since 3.8.2 / protected $table = null; /* * The class name of the \Joomla\CMS\Table\Table instance managing the DB records (re-usable in batch methods & saveorder(), initialized via initBatch()) * * @var string * @since 3.8.2 / protected $tableClassName = null; /* * UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch()) * * @var object * @since 3.8.2 / protected $contentType = null; /* * DB data of UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch()) * * @var object * @since 3.8.2 / protected $type = null; /* * Constructor. * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * @param ?FormFactoryInterface $formFactory The form factory. * * @since 1.6 * @throws \Exception / public function __construct($config = [], ?MVCFactoryInterface $factory = null, ?FormFactoryInterface $formFactory = null) { parent::__construct($config, $factory, $formFactory); if (isset($config['event_after_delete'])) { $this->event_after_delete = $config['event_after_delete']; } elseif (empty($this->event_after_delete)) { $this->event_after_delete = 'onContentAfterDelete'; } if (isset($config['event_after_save'])) { $this->event_after_save = $config['event_after_save']; } elseif (empty($this->event_after_save)) { $this->event_after_save = 'onContentAfterSave'; } if (isset($config['event_before_delete'])) { $this->event_before_delete = $config['event_before_delete']; } elseif (empty($this->event_before_delete)) { $this->event_before_delete = 'onContentBeforeDelete'; } if (isset($config['event_before_save'])) { $this->event_before_save = $config['event_before_save']; } elseif (empty($this->event_before_save)) { $this->event_before_save = 'onContentBeforeSave'; } if (isset($config['event_before_change_state'])) { $this->event_before_change_state = $config['event_before_change_state']; } elseif (empty($this->event_before_change_state)) { $this->event_before_change_state = 'onContentBeforeChangeState'; } if (isset($config['event_change_state'])) { $this->event_change_state = $config['event_change_state']; } elseif (empty($this->event_change_state)) { $this->event_change_state = 'onContentChangeState'; } if (isset($config['event_before_batch'])) { $this->event_before_batch = $config['event_before_batch']; } elseif (empty($this->event_before_batch)) { $this->event_before_batch = 'onBeforeBatch'; } $config['events_map'] ??= []; $this->events_map = array_merge( [ 'delete' => 'content', 'save' => 'content', 'change_state' => 'content', 'validate' => 'content', 'batch' => 'content', ], $config['events_map'] ); // Guess the \Text message prefix. Defaults to the option. if (isset($config['text_prefix'])) { $this->text_prefix = strtoupper($config['text_prefix']); } elseif (empty($this->text_prefix)) { $this->text_prefix = strtoupper($this->option); } } /* * Method to perform batch operations on an item or a set of items. * * @param array $commands An array of commands to perform. * @param array $pks An array of item ids. * @param array $contexts An array of item contexts. * * @return boolean Returns true on success, false on failure. * * @since 1.7 / public function batch($commands, $pks, $contexts) { // Sanitize ids. $pks = array_unique($pks); $pks = ArrayHelper::toInteger($pks); // Remove any values of zero. if (array_search(0, $pks, true)) { unset($pks[array_search(0, $pks, true)]); } if (empty($pks)) { $this->setError(Text::_('JGLOBAL_NO_ITEM_SELECTED')); return false; } $done = false; PluginHelper::importPlugin($this->events_map['batch']); // Initialize re-usable member properties $this->initBatch(); if ($this->batch_copymove && !empty($commands[$this->batch_copymove])) { $cmd = ArrayHelper::getValue($commands, 'move_copy', 'c'); if ($cmd === 'c') { $result = $this->batchCopy($commands[$this->batch_copymove], $pks, $contexts); if (\is_array($result)) { foreach ($result as $old => $new) { $contexts[$new] = $contexts[$old]; } $pks = array_values($result); } else { return false; } } elseif ($cmd === 'm' && !$this->batchMove($commands[$this->batch_copymove], $pks, $contexts)) { return false; } $done = true; } foreach ($this->batch_commands as $identifier => $command) { if (!empty($commands[$identifier])) { if (!$this->$command($commands[$identifier], $pks, $contexts)) { return false; } $done = true; } } if (!$done) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION')); return false; } // Clear the cache $this->cleanCache(); return true; } /* * Batch access level changes for a group of rows. * * @param integer $value The new value matching an Asset Group ID. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return boolean True if successful, false otherwise and internal error is set. * * @since 1.7 / protected function batchAccess($value, $pks, $contexts) { // Initialize re-usable member properties, and re-usable local variables $this->initBatch(); $dispatcher = $this->getDispatcher(); foreach ($pks as $pk) { if ($this->user->authorise('core.edit', $contexts[$pk])) { $this->table->reset(); $this->table->load($pk); $this->table->access = (int) $value; $event = new Model\BeforeBatchEvent( $this->event_before_batch, ['src' => $this->table, 'type' => 'access'] ); $dispatcher->dispatch($event->getName(), $event); // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } } else { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } } // Clean the cache $this->cleanCache(); return true; } /* * Batch copy items to a new category or current. * * @param integer $value The new category. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return array\|boolean An array of new IDs on success, boolean false on failure. * * @since 1.7 / protected function batchCopy($value, $pks, $contexts) { // Initialize re-usable member properties, and re-usable local variables $this->initBatch(); $categoryId = $value; if (!$this->checkCategoryId($categoryId)) { return false; } $newIds = []; $db = $this->getDatabase(); $dispatcher = $this->getDispatcher(); // Parent exists so let's proceed while (!empty($pks)) { // Pop the first ID off the stack $pk = array_shift($pks); $this->table->reset(); // Check that the row actually exists if (!$this->table->load($pk)) { if ($error = $this->table->getError()) { // Fatal error $this->setError($error); return false; } // Not fatal error $this->setError(Text::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk)); continue; } // Check for asset_id if ($this->table->hasField($this->table->getColumnAlias('asset_id'))) { $oldAssetId = $this->table->asset_id; } $this->generateTitle($categoryId, $this->table); // Reset the ID because we are making a copy $this->table->id = 0; // Unpublish because we are making a copy if (isset($this->table->published)) { $this->table->published = 0; } elseif (isset($this->table->state)) { $this->table->state = 0; } $hitsAlias = $this->table->getColumnAlias('hits'); if (isset($this->table->$hitsAlias)) { $this->table->$hitsAlias = 0; } // New category ID $this->table->catid = $categoryId; $event = new Model\BeforeBatchEvent( $this->event_before_batch, ['src' => $this->table, 'type' => 'copy'] ); $dispatcher->dispatch($event->getName(), $event); // @todo: Deal with ordering? // $this->table->ordering = 1; // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } // Store the row. if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } // Get the new item ID $newId = $this->table->id; if (!empty($oldAssetId)) { $dbType = strtolower($db->getServerType()); // Copy rules $query = $db->getQuery(true); $query->clear() ->update($db->quoteName('#__assets', 't')); if ($dbType === 'mysql') { $query->set($db->quoteName('t.rules') . ' = ' . $db->quoteName('s.rules')); } else { $query->set($db->quoteName('rules') . ' = ' . $db->quoteName('s.rules')); } $query->join( 'INNER', $db->quoteName('#__assets', 's'), $db->quoteName('s.id') . ' = :oldassetid' ) ->where($db->quoteName('t.id') . ' = :assetid') ->bind(':oldassetid', $oldAssetId, ParameterType::INTEGER) ->bind(':assetid', $this->table->asset_id, ParameterType::INTEGER); $db->setQuery($query)->execute(); } $this->cleanupPostBatchCopy($this->table, $newId, $pk); // Add the new ID to the array $newIds[$pk] = $newId; } // Clean the cache $this->cleanCache(); return $newIds; } /* * Function that can be overridden to do any data cleanup after batch copying data * * @param TableInterface $table The table object containing the newly created item * @param integer $newId The id of the new item * @param integer $oldId The original item id * * @return void * * @since 3.8.12 / protected function cleanupPostBatchCopy(TableInterface $table, $newId, $oldId) { } /* * Batch language changes for a group of rows. * * @param string $value The new value matching a language. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return boolean True if successful, false otherwise and internal error is set. * * @since 2.5 / protected function batchLanguage($value, $pks, $contexts) { // Initialize re-usable member properties, and re-usable local variables $this->initBatch(); $dispatcher = $this->getDispatcher(); foreach ($pks as $pk) { if ($this->user->authorise('core.edit', $contexts[$pk])) { $this->table->reset(); $this->table->load($pk); $this->table->language = $value; $event = new Model\BeforeBatchEvent( $this->event_before_batch, ['src' => $this->table, 'type' => 'language'] ); $dispatcher->dispatch($event->getName(), $event); // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } } else { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } } // Clean the cache $this->cleanCache(); return true; } /* * Batch move items to a new category * * @param integer $value The new category ID. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return boolean True if successful, false otherwise and internal error is set. * * @since 1.7 / protected function batchMove($value, $pks, $contexts) { // Initialize re-usable member properties, and re-usable local variables $this->initBatch(); $categoryId = (int) $value; if (!$this->checkCategoryId($categoryId)) { return false; } $dispatcher = $this->getDispatcher(); // Parent exists so we proceed foreach ($pks as $pk) { if (!$this->user->authorise('core.edit', $contexts[$pk])) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } // Check that the row actually exists if (!$this->table->load($pk)) { if ($error = $this->table->getError()) { // Fatal error $this->setError($error); return false; } // Not fatal error $this->setError(Text::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk)); continue; } // Set the new category ID $this->table->catid = $categoryId; $event = new Model\BeforeBatchEvent( $this->event_before_batch, ['src' => $this->table, 'type' => 'move'] ); $dispatcher->dispatch($event->getName(), $event); // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } // Store the row. if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } } // Clean the cache $this->cleanCache(); return true; } /* * Batch tag a list of item. * * @param integer $value The value of the new tag. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return boolean True if successful, false otherwise and internal error is set. * * @since 3.1 * * @deprecated 5.3 will be removed in 7.0 / protected function batchTag($value, $pks, $contexts) { // Initialize re-usable member properties, and re-usable local variables $this->initBatch(); $tags = [$value]; foreach ($pks as $pk) { if ($this->user->authorise('core.edit', $contexts[$pk])) { $this->table->reset(); $this->table->load($pk); $setTagsEvent = \Joomla\CMS\Event\AbstractEvent::create( 'onTableSetNewTags', [ 'subject' => $this->table, 'newTags' => $tags, 'replaceTags' => false, ] ); try { $this->table->getDispatcher()->dispatch('onTableSetNewTags', $setTagsEvent); } catch (\RuntimeException $e) { $this->setError($e->getMessage()); return false; } } else { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } } // Clean the cache $this->cleanCache(); return true; } /* * Method to test whether a record can be deleted. * * @param object $record A record object. * * @return boolean True if allowed to delete the record. Defaults to the permission for the component. * * @since 1.6 / protected function canDelete($record) { return $this->getCurrentUser()->authorise('core.delete', $this->option); } /* * Method to test whether a record can have its state changed. * * @param object $record A record object. * * @return boolean True if allowed to change the state of the record. Defaults to the permission for the component. * * @since 1.6 / protected function canEditState($record) { return $this->getCurrentUser()->authorise('core.edit.state', $this->option); } /* * Method override to check-in a record or an array of record * * @param mixed $pks The ID of the primary key or an array of IDs * * @return integer\|boolean Boolean false if there is an error, otherwise the count of records checked in. * * @since 1.6 / public function checkin($pks = []) { $pks = (array) $pks; $table = $this->getTable(); $count = 0; if (empty($pks)) { $pks = [(int) $this->getState($this->getName() . '.id')]; } $checkedOutField = $table->getColumnAlias('checked_out'); // Check in all items. foreach ($pks as $pk) { if ($table->load($pk)) { if ($table->{$checkedOutField} > 0) { if (!parent::checkin($pk)) { return false; } $count++; } } else { $this->setError($table->getError()); return false; } } return $count; } /* * Method override to check-out a record. * * @param integer $pk The ID of the primary key. * * @return boolean True if successful, false if an error occurs. * * @since 1.6 / public function checkout($pk = null) { $pk = (!empty($pk)) ? $pk : (int) $this->getState($this->getName() . '.id'); return parent::checkout($pk); } /* * Method to delete one or more records. * * @param array &$pks An array of record primary keys. * * @return boolean True if successful, false if an error occurs. * * @since 1.6 / public function delete(&$pks) { $pks = ArrayHelper::toInteger((array) $pks); $table = $this->getTable(); $dispatcher = $this->getDispatcher(); // Include the plugins for the delete events. PluginHelper::importPlugin($this->events_map['delete'], null, true, $dispatcher); // Iterate the items to delete each one. foreach ($pks as $i => $pk) { if ($table->load($pk)) { if ($this->canDelete($table)) { $context = $this->option . '.' . $this->name; // Trigger the before delete event. $beforeDeleteEvent = new Model\BeforeDeleteEvent($this->event_before_delete, [ 'context' => $context, 'subject' => $table, ]); $result = $dispatcher->dispatch($this->event_before_delete, $beforeDeleteEvent)->getArgument('result', []); if (\in_array(false, $result, true)) { $this->setError($table->getError()); return false; } // Multilanguage: if associated, delete the item in the _associations table if ($this->associationsContext && Associations::isEnabled()) { $db = $this->getDatabase(); $query = $db->getQuery(true) ->select( [ 'COUNT() AS ' . $db->quoteName('count'), $db->quoteName('as1.key'), ] ) ->from($db->quoteName('#__associations', 'as1')) ->join('LEFT', $db->quoteName('#__associations', 'as2'), $db->quoteName('as1.key') . ' = ' . $db->quoteName('as2.key')) ->where( [ $db->quoteName('as1.context') . ' = :context', $db->quoteName('as1.id') . ' = :pk', ] ) ->bind(':context', $this->associationsContext) ->bind(':pk', $pk, ParameterType::INTEGER) ->group($db->quoteName('as1.key')); $db->setQuery($query); $row = $db->loadAssoc(); if (!empty($row['count'])) { $query = $db->getQuery(true) ->delete($db->quoteName('#__associations')) ->where( [ $db->quoteName('context') . ' = :context', $db->quoteName('key') . ' = :key', ] ) ->bind(':context', $this->associationsContext) ->bind(':key', $row['key']); if ($row['count'] > 2) { $query->where($db->quoteName('id') . ' = :pk') ->bind(':pk', $pk, ParameterType::INTEGER); } $db->setQuery($query); $db->execute(); } } if (!$table->delete($pk)) { $this->setError($table->getError()); return false; } // Trigger the after event. $dispatcher->dispatch($this->event_after_delete, new Model\AfterDeleteEvent($this->event_after_delete, [ 'context' => $context, 'subject' => $table, ])); } else { // Prune items that you can't change. unset($pks[$i]); $error = $this->getError(); if ($error) { Log::add($error, Log::WARNING, 'jerror'); return false; } Log::add(Text::_('JLIB_APPLICATION_ERROR_DELETE_NOT_PERMITTED'), Log::WARNING, 'jerror'); return false; } } else { $this->setError($table->getError()); return false; } } // Clear the component's cache $this->cleanCache(); return true; } /** * Method to change the title & alias. * * @param integer $categoryId The id of the category. * @param string $alias The alias. * @param string $title The title. * * @return array Contains the modified title and alias. * * @since 1.7 / protected function generateNewTitle($categoryId, $alias, $title) { // Alter the title & alias $table = $this->getTable(); $aliasField = $table->getColumnAlias('alias'); $catidField = $table->getColumnAlias('catid'); $titleField = $table->getColumnAlias('title'); while ($table->load([$aliasField => $alias, $catidField => $categoryId])) { if ($title === $table->$titleField) { $title = StringHelper::increment($title); } $alias = StringHelper::increment($alias, 'dash'); } return [$title, $alias]; } /* * Method to get a single record. * * @param integer $pk The id of the primary key. * * @return \stdClass\|false Object on success, false on failure. * * @since 1.6 / public function getItem($pk = null) { $pk = (!empty($pk)) ? $pk : (int) $this->getState($this->getName() . '.id'); $table = $this->getTable(); if ($pk > 0) { // Attempt to load the row. $return = $table->load($pk); // Check for a table object error. if ($return === false) { // If there was no underlying error, then the false means there simply was not a row in the db for this $pk. if (!$table->getError()) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_NOT_EXIST')); } else { $this->setError($table->getError()); } return false; } } // Convert to the CMSObject before adding other data. $properties = $table->getProperties(1); $item = ArrayHelper::toObject($properties, CMSObject::class); if (property_exists($item, 'params')) { $registry = new Registry($item->params); $item->params = $registry->toArray(); } return $item; } /* * A protected method to get a set of ordering conditions. * * @param Table $table A Table object. * * @return string[] An array of conditions to add to ordering queries. * * @since 1.6 / protected function getReorderConditions($table) { return []; } /* * Stock method to auto-populate the model state. * * @return void * * @since 1.6 / protected function populateState() { $table = $this->getTable(); $key = $table->getKeyName(); // Get the pk of the record from the request. $pk = Factory::getApplication()->getInput()->getInt($key); $this->setState($this->getName() . '.id', $pk); // Load the parameters. $value = ComponentHelper::getParams($this->option); $this->setState('params', $value); } /* * Prepare and sanitise the table data prior to saving. * * @param Table $table A reference to a Table object. * * @return void * * @since 1.6 / protected function prepareTable($table) { // Derived class will provide its own implementation if required. } /* * Method to change the published state of one or more records. * * @param array &$pks A list of the primary keys to change. * @param integer $value The value of the published state. * * @return boolean True on success. * * @since 1.6 / public function publish(&$pks, $value = 1) { $user = $this->getCurrentUser(); $table = $this->getTable(); $pks = (array) $pks; $context = $this->option . '.' . $this->name; $dispatcher = $this->getDispatcher(); // Include the plugins for the change of state event. PluginHelper::importPlugin($this->events_map['change_state'], null, true, $dispatcher); // Access checks. foreach ($pks as $i => $pk) { $table->reset(); if ($table->load($pk)) { if (!$this->canEditState($table)) { // Prune items that you can't change. unset($pks[$i]); Log::add(Text::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'), Log::WARNING, 'jerror'); return false; } // If the table is checked out by another user, drop it and report to the user trying to change its state. if ($table->hasField('checked_out') && $table->checked_out && ($table->checked_out != $user->id)) { Log::add(Text::_('JLIB_APPLICATION_ERROR_CHECKIN_USER_MISMATCH'), Log::WARNING, 'jerror'); // Prune items that you can't change. unset($pks[$i]); } /* * Prune items that are already at the given state. Note: Only models whose table correctly * sets 'published' column alias (if different than published) will benefit from this / $publishedColumnName = $table->getColumnAlias('published'); if (property_exists($table, $publishedColumnName) && ($table->$publishedColumnName ?? $value) == $value) { unset($pks[$i]); } } } // Check if there are items to change if (!\count($pks)) { return true; } // Trigger the before change state event. $beforeChngEvent = new Model\BeforeChangeStateEvent($this->event_before_change_state, [ 'context' => $context, 'subject' => $pks, 'value' => $value, ]); $result = $dispatcher->dispatch($this->event_before_change_state, $beforeChngEvent)->getArgument('result', []); if (\in_array(false, $result, true)) { $this->setError($table->getError()); return false; } // Attempt to change the state of the records. if (!$table->publish($pks, $value, $user->id)) { $this->setError($table->getError()); return false; } // Trigger the change state event. $afterChngEvent = new Model\AfterChangeStateEvent($this->event_change_state, [ 'context' => $context, 'subject' => $pks, 'value' => $value, ]); $result = $dispatcher->dispatch($this->event_change_state, $afterChngEvent)->getArgument('result', []); if (\in_array(false, $result, true)) { $this->setError($table->getError()); return false; } // Clear the component's cache $this->cleanCache(); return true; } /* * Method to adjust the ordering of a row. * * Returns NULL if the user did not have edit * privileges for any of the selected primary keys. * * @param integer $pks The ID of the primary key to move. * @param integer $delta Increment, usually +1 or -1 * * @return boolean\|null False on failure or error, true on success, null if the $pk is empty (no items selected). * * @since 1.6 / public function reorder($pks, $delta = 0) { $table = $this->getTable(); $pks = (array) $pks; $result = true; $allowed = true; foreach ($pks as $i => $pk) { $table->reset(); if ($table->load($pk) && $this->checkout($pk)) { // Access checks. if (!$this->canEditState($table)) { // Prune items that you can't change. unset($pks[$i]); $this->checkin($pk); Log::add(Text::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'), Log::WARNING, 'jerror'); $allowed = false; continue; } $where = $this->getReorderConditions($table); if (!$table->move($delta, $where)) { $this->setError($table->getError()); unset($pks[$i]); $result = false; } $this->checkin($pk); } else { $this->setError($table->getError()); unset($pks[$i]); $result = false; } } if ($allowed === false && empty($pks)) { $result = null; } // Clear the component's cache if ($result) { $this->cleanCache(); } return $result; } /* * Method to save the form data. * * @param array $data The form data. * * @return boolean True on success, False on error. * * @since 1.6 / public function save($data) { $table = $this->getTable(); $context = $this->option . '.' . $this->name; $app = Factory::getApplication(); $dispatcher = $this->getDispatcher(); if (\array_key_exists('tags', $data) && \is_array($data['tags'])) { $table->newTags = $data['tags']; } $key = $table->getKeyName(); $pk = $data[$key] ?? (int) $this->getState($this->getName() . '.id'); $isNew = true; // Include the plugins for the save events. PluginHelper::importPlugin($this->events_map['save'], null, true, $dispatcher); // Allow an exception to be thrown. try { // Load the row if saving an existing record. if ($pk > 0) { $table->load($pk); $isNew = false; } // Bind the data. if (!$table->bind($data)) { $this->setError($table->getError()); return false; } // Prepare the row for saving $this->prepareTable($table); // Check the data. if (!$table->check()) { $this->setError($table->getError()); return false; } // Trigger the before save event. $beforeSaveEvent = new Model\BeforeSaveEvent($this->event_before_save, [ 'context' => $context, 'subject' => $table, 'isNew' => $isNew, 'data' => $data, ]); $result = $dispatcher->dispatch($this->event_before_save, $beforeSaveEvent)->getArgument('result', []); if (\in_array(false, $result, true)) { $this->setError($table->getError()); return false; } // Store the data. if (!$table->store()) { $this->setError($table->getError()); return false; } // Clean the cache. $this->cleanCache(); // Trigger the after save event. $dispatcher->dispatch($this->event_after_save, new Model\AfterSaveEvent($this->event_after_save, [ 'context' => $context, 'subject' => $table, 'isNew' => $isNew, 'data' => $data, ])); } catch (\Exception $e) { $this->setError($e->getMessage()); return false; } if (isset($table->$key)) { $this->setState($this->getName() . '.id', $table->$key); } $this->setState($this->getName() . '.new', $isNew); if ($this->associationsContext && Associations::isEnabled() && !empty($data['associations'])) { $associations = $data['associations']; // Unset any invalid associations $associations = ArrayHelper::toInteger($associations); // Unset any invalid associations foreach ($associations as $tag => $id) { if (!$id) { unset($associations[$tag]); } } // Show a warning if the item isn't assigned to a language but we have associations. if ($associations && $table->language === '') { $app->enqueueMessage( Text::_(strtoupper($this->option) . '_ERROR_ALL_LANGUAGE_ASSOCIATED'), 'warning' ); } // Get associationskey for edited item $db = $this->getDatabase(); $id = (int) $table->$key; $query = $db->getQuery(true) ->select($db->quoteName('key')) ->from($db->quoteName('#__associations')) ->where($db->quoteName('context') . ' = :context') ->where($db->quoteName('id') . ' = :id') ->bind(':context', $this->associationsContext) ->bind(':id', $id, ParameterType::INTEGER); $db->setQuery($query); $oldKey = $db->loadResult(); if ($associations \|\| $oldKey !== null) { // Deleting old associations for the associated items $query = $db->getQuery(true) ->delete($db->quoteName('#__associations')) ->where($db->quoteName('context') . ' = :context') ->bind(':context', $this->associationsContext); $where = []; if ($associations) { $where[] = $db->quoteName('id') . ' IN (' . implode(',', $query->bindArray(array_values($associations))) . ')'; } if ($oldKey !== null) { $where[] = $db->quoteName('key') . ' = :oldKey'; $query->bind(':oldKey', $oldKey); } $query->extendWhere('AND', $where, 'OR'); $db->setQuery($query); $db->execute(); } // Adding self to the association if ($table->language !== '') { $associations[$table->language] = (int) $table->$key; } if (\count($associations) > 1) { // Adding new association for these items $key = md5(json_encode($associations)); $query = $db->getQuery(true) ->insert($db->quoteName('#__associations')) ->columns( [ $db->quoteName('id'), $db->quoteName('context'), $db->quoteName('key'), ] ); foreach ($associations as $id) { $query->values( implode( ',', $query->bindArray( [$id, $this->associationsContext, $key], [ParameterType::INTEGER, ParameterType::STRING, ParameterType::STRING] ) ) ); } $db->setQuery($query); $db->execute(); } } if ($app->getInput()->get('task') == 'editAssociations') { return $this->redirectToAssociations($data); } return true; } /* * Saves the manually set order of records. * * @param array $pks An array of primary key ids. * @param integer $order +1 or -1 * * @return boolean Boolean true on success, false on failure * * @since 1.6 / public function saveorder($pks = [], $order = null) { // Initialize re-usable member properties $this->initBatch(); $conditions = []; if (empty($pks)) { Factory::getApplication()->enqueueMessage(Text::_($this->text_prefix . '_ERROR_NO_ITEMS_SELECTED'), 'error'); return false; } $orderingField = $this->table->getColumnAlias('ordering'); // Update ordering values foreach ($pks as $i => $pk) { $this->table->load((int) $pk); // We don't want to modify tags on reorder, not removing the tagsHelper removes all associated tags if ($this->table instanceof TaggableTableInterface) { $this->table->clearTagsHelper(); } // Access checks. if (!$this->canEditState($this->table)) { // Prune items that you can't change. unset($pks[$i]); Log::add(Text::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'), Log::WARNING, 'jerror'); } elseif ($this->table->$orderingField != $order[$i]) { $this->table->$orderingField = $order[$i]; if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } // Remember to reorder within position and client_id $condition = $this->getReorderConditions($this->table); $found = false; foreach ($conditions as $cond) { if ($cond[1] == $condition) { $found = true; break; } } if (!$found) { $key = $this->table->getKeyName(); $conditions[] = [$this->table->$key, $condition]; } } } // Execute reorder for each category. foreach ($conditions as $cond) { $this->table->load($cond[0]); $this->table->reorder($cond[1]); } // Clear the component's cache $this->cleanCache(); return true; } /* * Method to check the validity of the category ID for batch copy and move * * @param integer $categoryId The category ID to check * * @return boolean * * @since 3.2 / protected function checkCategoryId($categoryId) { // Check that the category exists if ($categoryId) { $categoryTable = Table::getInstance('Category'); if (!$categoryTable->load($categoryId)) { if ($error = $categoryTable->getError()) { // Fatal error $this->setError($error); return false; } $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_MOVE_CATEGORY_NOT_FOUND')); return false; } } if (empty($categoryId)) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_MOVE_CATEGORY_NOT_FOUND')); return false; } // Check that the user has create permission for the component $extension = Factory::getApplication()->getInput()->get('option', ''); $user = $this->getCurrentUser(); if (!$user->authorise('core.create', $extension . '.category.' . $categoryId)) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_CREATE')); return false; } return true; } /* * A method to preprocess generating a new title in order to allow tables with alternative names * for alias and title to use the batch move and copy methods * * @param integer $categoryId The target category id * @param Table $table The Table within which move or copy is taking place * * @return void * * @since 3.2 / public function generateTitle($categoryId, $table) { // Alter the title & alias $titleField = $table->getColumnAlias('title'); $aliasField = $table->getColumnAlias('alias'); $data = $this->generateNewTitle($categoryId, $table->$aliasField, $table->$titleField); $table->$titleField = $data['0']; $table->$aliasField = $data['1']; } /* * Method to initialize member variables used by batch methods and other methods like saveorder() * * @return void * * @since 3.8.2 / public function initBatch() { if ($this->batchSet === null) { $this->batchSet = true; // Get current user $this->user = $this->getCurrentUser(); // Get table $this->table = $this->getTable(); // Get table class name $tc = explode('\\', \get_class($this->table)); $this->tableClassName = end($tc); // Get UCM Type data $this->contentType = new UCMType(); $this->type = $this->contentType->getTypeByTable($this->tableClassName) ?: $this->contentType->getTypeByAlias($this->typeAlias); } } /* * Method to load an item in com_associations. * * @param array $data The form data. * * @return boolean True if successful, false otherwise. * * @since 3.9.0 * * @deprecated 4.3 will be removed in 6.0 * It is handled by regular save method now. / public function editAssociations($data) { // Save the item return $this->save($data); } /* * Method to load an item in com_associations. * * @param array $data The form data. * * @return boolean True if successful, false otherwise. * * @throws \Exception * @since 3.9.17 / protected function redirectToAssociations($data) { $app = Factory::getApplication(); $id = $data['id']; // Deal with categories associations if ($this->text_prefix === 'COM_CATEGORIES') { $extension = $app->getInput()->get('extension', 'com_content'); $this->typeAlias = $extension . '.category'; $component = strtolower($this->text_prefix); $view = 'category'; } else { $aliasArray = explode('.', $this->typeAlias); $component = $aliasArray[0]; $view = $aliasArray[1]; $extension = ''; } // Menu item redirect needs admin client $client = $component === 'com_menus' ? '&client_id=0' : ''; if ($id == 0) { $app->enqueueMessage(Text::_('JGLOBAL_ASSOCIATIONS_NEW_ITEM_WARNING'), 'error'); $app->redirect( Route::_('index.php?option=' . $component . '&view=' . $view . $client . '&layout=edit&id=' . $id . $extension, false) ); return false; } if ($data['language'] === '') { $app->enqueueMessage(Text::_('JGLOBAL_ASSOC_NOT_POSSIBLE'), 'notice'); $app->redirect( Route::_('index.php?option=' . $component . '&view=' . $view . $client . '&layout=edit&id=' . $id . $extension, false) ); return false; } $languages = LanguageHelper::getContentLanguages([0, 1]); $target = ''; /** * If the site contains only 2 languages and an association exists for the item * load directly the associated target item in the side by side view * otherwise select already the target language / if (\count($languages) === 2) { $lang_code = []; foreach ($languages as $language) { $lang_code[] = $language->lang_code; } $refLang = [$data['language']]; $targetLang = array_diff($lang_code, $refLang); $targetLang = implode(',', $targetLang); $targetId = $data['associations'][$targetLang]; if ($targetId) { $target = '&target=' . $targetLang . '%3A' . $targetId . '%3Aedit'; } else { $target = '&target=' . $targetLang . '%3A0%3Aadd'; } } $app->redirect( Route::_( 'index.php?option=com_associations&view=association&layout=edit&itemtype=' . $this->typeAlias . '&task=association.edit&id=' . $id . $target, false ) ); return true; } } ��BaseModel.php��0000644��00000007767�15231072320�0007124 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2006 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Language\Text; use Joomla\CMS\Object\LegacyErrorHandlingTrait; use Joomla\CMS\Object\LegacyPropertyManagementTrait; use Joomla\Filesystem\Path; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Base class for a Joomla Model * * @since 4.0.0 / #[\AllowDynamicProperties] abstract class BaseModel implements ModelInterface, StatefulModelInterface { use StateBehaviorTrait; use LegacyModelLoaderTrait; use LegacyErrorHandlingTrait; use LegacyPropertyManagementTrait; /* * The model (base) name * * @var string * @since 4.0.0 / protected $name; /* * The include paths * * @var array * @since 4.0.0 / protected static $paths; /* * Constructor * * @param array $config An array of configuration options (name, state, ignore_request). * * @since 4.0.0 * @throws \Exception / public function __construct($config = []) { // Set the view name if (empty($this->name)) { if (\array_key_exists('name', $config)) { $this->name = $config['name']; } else { $this->name = $this->getName(); } } // Set the model state if (\array_key_exists('state', $config)) { $this->state = $config['state']; } // Set the internal state marker - used to ignore setting state from the request if (!empty($config['ignore_request'])) { $this->__state_set = true; } } /* * Add a directory where \JModelLegacy should search for models. You may * either pass a string or an array of directories. * * @param mixed $path A path or array[sting] of paths to search. * @param string $prefix A prefix for models. * * @return array An array with directory elements. If prefix is equal to '', all directories are returned. * * @since 3.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement. Get the model through the MVCFactory + namespace instead * * @see LegacyModelLoaderTrait::getInstance() / public static function addIncludePath($path = '', $prefix = '') { if (!isset(self::$paths)) { self::$paths = []; } if (!isset(self::$paths[$prefix])) { self::$paths[$prefix] = []; } if (!isset(self::$paths[''])) { self::$paths[''] = []; } if (!empty($path)) { foreach ((array) $path as $includePath) { if (!\in_array($includePath, self::$paths[$prefix])) { array_unshift(self::$paths[$prefix], Path::clean($includePath)); } if (!\in_array($includePath, self::$paths[''])) { array_unshift(self::$paths[''], Path::clean($includePath)); } } } return self::$paths[$prefix]; } /* * Method to get the model name * * The model name. By default parsed using the classname or it can be set * by passing a $config['name'] in the class constructor * * @return string The name of the model * * @since 4.0.0 * @throws \Exception / public function getName() { if (empty($this->name)) { $r = null; if (!preg_match('/Model(.)/i', \get_class($this), $r)) { throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_GET_NAME', __METHOD__), 500); } $this->name = str_replace(['\\', 'model'], '', strtolower($r[1])); } return $this->name; } } ��FormBehaviorTrait.php��0000644��00000015277�15231072320�0010653 0��ustar�00��<?php /** * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Event\Model; use Joomla\CMS\Factory; use Joomla\CMS\Form\Form; use Joomla\CMS\Form\FormFactoryInterface; use Joomla\CMS\Form\FormField; use Joomla\CMS\Plugin\PluginHelper; use Joomla\CMS\User\CurrentUserInterface; use Joomla\Event\DispatcherAwareInterface; use Joomla\Event\DispatcherInterface; use Joomla\Utilities\ArrayHelper; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Trait which supports form behavior. * * @since 4.0.0 / trait FormBehaviorTrait { /* * Array of form objects. * * @var Form[] * @since 4.0.0 / protected $_forms = []; /* * Method to get a form object. * * @param string $name The name of the form. * @param string $source The form source. Can be XML string if file flag is set to false. * @param array $options Optional array of options for the form creation. * @param boolean $clear Optional argument to force load a new form. * @param string $xpath An optional xpath to search for the fields. * * @return Form * * @see Form * @since 4.0.0 * @throws \Exception / protected function loadForm($name, $source = null, $options = [], $clear = false, $xpath = null) { // Handle the optional arguments. $options['control'] = ArrayHelper::getValue((array) $options, 'control', false); // Create a signature hash. But make sure, that loading the data does not create a new instance $sigoptions = $options; if (isset($sigoptions['load_data'])) { unset($sigoptions['load_data']); } $hash = md5($source . serialize($sigoptions)); // Check if we can use a previously loaded form. if (!$clear && isset($this->_forms[$hash])) { return $this->_forms[$hash]; } // Get the form. Form::addFormPath(JPATH_COMPONENT . '/forms'); Form::addFormPath(JPATH_COMPONENT . '/models/forms'); Form::addFieldPath(JPATH_COMPONENT . '/models/fields'); Form::addFormPath(JPATH_COMPONENT . '/model/form'); Form::addFieldPath(JPATH_COMPONENT . '/model/field'); try { $formFactory = $this->getFormFactory(); } catch (\UnexpectedValueException) { $formFactory = Factory::getContainer()->get(FormFactoryInterface::class); } $form = $formFactory->createForm($name, $options); if ($form instanceof CurrentUserInterface && method_exists($this, 'getCurrentUser')) { $form->setCurrentUser($this->getCurrentUser()); } // Load the data. if (str_starts_with($source, '<')) { if (!$form->load($source, false, $xpath)) { throw new \RuntimeException('Form::loadForm could not load form'); } } else { if (!$form->loadFile($source, false, $xpath)) { throw new \RuntimeException('Form::loadForm could not load file'); } } if (isset($options['load_data']) && $options['load_data']) { // Get the data for the form. $data = $this->loadFormData(); } else { $data = []; } // Allow for additional modification of the form, and events to be triggered. // We pass the data because plugins may require it. $this->preprocessForm($form, $data); // Load the data into the form after the plugins have operated. $form->bind($data); // Store the form for later. $this->_forms[$hash] = $form; return $form; } /* * Method to get the data that should be injected in the form. * * @return array The default data is an empty array. * * @since 4.0.0 / protected function loadFormData() { return []; } /* * Method to allow derived classes to preprocess the data. * * @param string $context The context identifier. * @param mixed &$data The data to be processed. It gets altered directly. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @since 4.0.0 / protected function preprocessData($context, &$data, $group = 'content') { if ($this instanceof DispatcherAwareInterface) { $dispatcher = $this->getDispatcher(); } else { $dispatcher = Factory::getContainer()->get(DispatcherInterface::class); } // Get the dispatcher and load the users plugins. PluginHelper::importPlugin($group, null, true, $dispatcher); // Trigger the data preparation event. $data = $dispatcher->dispatch( 'onContentPrepareData', new Model\PrepareDataEvent('onContentPrepareData', [ 'context' => $context, 'data' => &$data, // @todo: Remove reference in Joomla 7, see PrepareDataEvent::__constructor() 'subject' => new \stdClass(), ]) )->getArgument('data', $data); } /* * Method to allow derived classes to preprocess the form. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * @param string $group The name of the plugin group to import (defaults to "content"). * * @return void * * @see FormField * @since 4.0.0 * @throws \Exception if there is an error in the form event. / protected function preprocessForm(Form $form, $data, $group = 'content') { if ($this instanceof DispatcherAwareInterface) { $dispatcher = $this->getDispatcher(); } else { $dispatcher = Factory::getContainer()->get(DispatcherInterface::class); } // Import the appropriate plugin group. PluginHelper::importPlugin($group, null, true, $dispatcher); // Trigger the form preparation event. $dispatcher->dispatch( 'onContentPrepareForm', new Model\PrepareFormEvent('onContentPrepareForm', ['subject' => $form, 'data' => $data]) ); } /* * Get the FormFactoryInterface. * * @return FormFactoryInterface * * @since 4.0.0 * @throws \UnexpectedValueException May be thrown if the FormFactory has not been set. / abstract public function getFormFactory(): FormFactoryInterface; } ��ListModelInterface.php��0000644��00000001211�15231072320�0010760 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a list model. * * @since 4.0.0 / interface ListModelInterface { /* * Method to get an array of data items. * * @return mixed An array of data items * * @since 4.0.0 * * @throws \Exception / public function getItems(); } ��State.php��0000644��00000007142�15231072320�0006334 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\Registry\Registry; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * A simple state holder class. This class acts for transition from CMSObject to Registry * and should not be used directly. Instead of, use the Registry class. * * @since 5.0.0 * * @deprecated 5.0.0 will be removed in 7.0, use the Registry directly / class State extends Registry { /* * Constructor * * @param mixed $data The data to bind to the new Registry object. * * @since 5.0.0 / public function __construct($data = null) { parent::__construct($data); // To speed up things $this->separator = null; } /* * Get a registry value. * * @param string $path Registry path (e.g. joomla.content.showauthor) * @param mixed $default Optional default value, returned if the internal value is null. * * @return mixed Value of entry or null * * @since 5.0.0 / public function get($path, $default = null) { if (isset($this->data->$path) && empty($this->data->$path)) { @trigger_error( \sprintf('Instead of an empty value, the default value will be returned in 7.0 in %s::%s.', __METHOD__, __CLASS__), E_USER_DEPRECATED ); return $this->data->$path; } return parent::get($path, $default); } /* * Returns an associative array of object properties. * * @return array The data array * * @since 5.0.0 * * @deprecated 5.0.0 will be removed in 7.0, use toArray instead / public function getProperties() { return $this->toArray(); } /* * Proxy for internal data access for the given name. * * @param string $name The name of the element * * @return mixed The value of the element if set, null otherwise * * @since 5.0.0 * * @deprecated 5.0.0 will be removed in 7.0 * / public function __get($name) { @trigger_error(\sprintf('Direct property access will not be supported in 7.0 in %s::%s.', __METHOD__, __CLASS__), E_USER_DEPRECATED); return $this->get($name); } /* * Proxy for internal data storage for the given name and value. * * @param string $name The name of the element * @param string $value The value * * @return void * * @since 5.0.0 * * @deprecated 5.0.0 will be removed in 7.0 * / public function __set($name, $value) { @trigger_error(\sprintf('Direct property access will not be supported in 7.0 in %s::%s.', __METHOD__, __CLASS__), E_USER_DEPRECATED); return $this->set($name, $value); } /* * Proxy for internal data check for a variable with the given key. * * @param string $name The name of the element * * @return bool Returns if the internal data storage contains a key with the given * * @since 5.0.0 * * @deprecated 5.0.0 will be removed in 7.0 * / public function __isset($name) { @trigger_error(\sprintf('Direct property access will not be supported in 7.0 in %s::%s.', __METHOD__, __CLASS__), E_USER_DEPRECATED); return $this->exists($name); } } ��ListModel.php��0000644��00000055441�15231072320�0007155 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Factory; use Joomla\CMS\Filter\InputFilter; use Joomla\CMS\Form\Form; use Joomla\CMS\Form\FormFactoryAwareInterface; use Joomla\CMS\Form\FormFactoryAwareTrait; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\Pagination\Pagination; use Joomla\Database\QueryInterface; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Model class for handling lists of items. * * @since 1.6 / class ListModel extends BaseDatabaseModel implements FormFactoryAwareInterface, ListModelInterface { use FormBehaviorTrait; use FormFactoryAwareTrait; /* * Internal memory based cache array of data. * * @var array * @since 1.6 / protected $cache = []; /* * Context string for the model type. This is used to handle uniqueness * when dealing with the getStoreId() method and caching data structures. * * @var string * @since 1.6 / protected $context = null; /* * Valid filter fields or ordering. * * @var array * @since 1.6 / protected $filter_fields = []; /* * An internal cache for the last query used. * * @var QueryInterface\|string * @since 1.6 / protected $query = []; /* * The cache ID used when last populating $this->query * * @var null\|string * @since 3.10.4 / protected $lastQueryStoreId = null; /* * Name of the filter form to load * * @var string * @since 3.2 / protected $filterFormName = null; /* * Associated HTML form * * @var string * @since 3.2 / protected $htmlFormName = 'adminForm'; /* * A list of filter variables to not merge into the model's state * * @var array * @since 3.4.5 * @deprecated 4.0 will be removed in 6.0 * Use $filterForbiddenList instead / protected $filterBlacklist = []; /* * A list of forbidden filter variables to not merge into the model's state * * @var array * @since 4.0.0 / protected $filterForbiddenList = []; /* * A list of forbidden variables to not merge into the model's state * * @var array * @since 3.4.5 * @deprecated 4.0 will be removed in 6.0 * Use $listForbiddenList instead / protected $listBlacklist = ['select']; /* * A list of forbidden variables to not merge into the model's state * * @var array * @since 4.0.0 / protected $listForbiddenList = ['select']; /* * Constructor * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * * @since 1.6 * @throws \Exception / public function __construct($config = [], ?MVCFactoryInterface $factory = null) { parent::__construct($config, $factory); // Add the ordering filtering fields allowed list. if (isset($config['filter_fields'])) { $this->filter_fields = $config['filter_fields']; } // Guess the context as Option.ModelName. if (empty($this->context)) { $this->context = strtolower($this->option . '.' . $this->getName()); } /* * @deprecated 4.0 will be removed in 6.0 * Use $this->filterForbiddenList instead / if (!empty($this->filterBlacklist)) { $this->filterForbiddenList = array_merge($this->filterBlacklist, $this->filterForbiddenList); } /* * @deprecated 4.0 will be removed in 6.0 * Use $this->listForbiddenList instead / if (!empty($this->listBlacklist)) { $this->listForbiddenList = array_merge($this->listBlacklist, $this->listForbiddenList); } } /* * Provide a query to be used to evaluate if this is an Empty State, can be overridden in the model to provide granular control. * * @return QueryInterface * * @since 4.0.0 / protected function getEmptyStateQuery() { $query = clone $this->_getListQuery(); if ($query instanceof QueryInterface) { $query->clear('bounded') ->clear('group') ->clear('having') ->clear('join') ->clear('values') ->clear('where'); } return $query; } /* * Is this an empty state, I.e: no items of this type regardless of the searched for states. * * @return boolean * * @throws \Exception * * @since 4.0.0 / public function getIsEmptyState(): bool { return $this->_getListCount($this->getEmptyStateQuery()) === 0; } /* * Method to cache the last query constructed. * * This method ensures that the query is constructed only once for a given state of the model. * * @return QueryInterface An object implementing the QueryInterface interface * * @since 1.6 / protected function _getListQuery() { // Compute the current store id. $currentStoreId = $this->getStoreId(); // If the last store id is different from the current, refresh the query. if ($this->lastQueryStoreId !== $currentStoreId \|\| empty($this->query)) { $this->lastQueryStoreId = $currentStoreId; $this->query = $this->getListQuery(); } return $this->query; } /* * Function to get the active filters * * @return array Associative array in the format: array('filter_published' => 0) * * @since 3.2 / public function getActiveFilters() { $activeFilters = []; if (!empty($this->filter_fields)) { foreach ($this->filter_fields as $filter) { $filterName = 'filter.' . $filter; if (!empty($this->state->get($filterName)) \|\| is_numeric($this->state->get($filterName))) { $activeFilters[$filter] = $this->state->get($filterName); } } } return $activeFilters; } /* * Validates a column name against the list of valid columns defined in the model * * @return bool * * @since 5.4.4 / public function isValidFilterColumn($columnName): bool { return \in_array($columnName, $this->filter_fields, true); } /* * Method to get an array of data items. * * @return mixed An array of data items on success, false on failure. * * @since 1.6 / public function getItems() { // Get a storage key. $store = $this->getStoreId(); // Try to load the data from internal storage. if (isset($this->cache[$store])) { return $this->cache[$store]; } try { // Load the list items and add the items to the internal cache. $this->cache[$store] = $this->_getList($this->_getListQuery(), $this->getStart(), $this->getState('list.limit')); } catch (\RuntimeException $e) { $this->setError($e->getMessage()); return false; } return $this->cache[$store]; } /* * Method to get an object implementing QueryInterface for retrieving the data set from a database. * * @return QueryInterface\|string An object implementing QueryInterface to retrieve the data set. * * @since 1.6 / protected function getListQuery() { return $this->getDatabase()->getQuery(true); } /* * Method to get a \JPagination object for the data set. * * @return Pagination A Pagination object for the data set. * * @since 1.6 / public function getPagination() { // Get a storage key. $store = $this->getStoreId('getPagination'); // Try to load the data from internal storage. if (isset($this->cache[$store])) { return $this->cache[$store]; } $limit = (int) $this->getState('list.limit') - (int) $this->getState('list.links'); // Create the pagination object and add the object to the internal cache. $this->cache[$store] = new Pagination($this->getTotal(), $this->getStart(), $limit); return $this->cache[$store]; } /* * Method to get a store id based on the model configuration state. * * This is necessary because the model is used by the component and * different modules that might need different sets of data or different * ordering requirements. * * @param string $id An identifier string to generate the store id. * * @return string A store id. * * @since 1.6 / protected function getStoreId($id = '') { // Add the list state to the store id. $id .= ':' . $this->getState('list.start'); $id .= ':' . $this->getState('list.limit'); $id .= ':' . $this->getState('list.ordering'); $id .= ':' . $this->getState('list.direction'); return md5($this->context . ':' . $id); } /* * Method to get the total number of items for the data set. * * @return integer The total number of items available in the data set. * * @since 1.6 / public function getTotal() { // Get a storage key. $store = $this->getStoreId('getTotal'); // Try to load the data from internal storage. if (isset($this->cache[$store])) { return $this->cache[$store]; } try { // Load the total and add the total to the internal cache. $this->cache[$store] = (int) $this->_getListCount($this->_getListQuery()); } catch (\RuntimeException $e) { $this->setError($e->getMessage()); return false; } return $this->cache[$store]; } /* * Method to get the starting number of items for the data set. * * @return integer The starting number of items available in the data set. * * @since 1.6 / public function getStart() { $store = $this->getStoreId('getstart'); // Try to load the data from internal storage. if (isset($this->cache[$store])) { return $this->cache[$store]; } $start = $this->getState('list.start'); if ($start > 0) { $limit = $this->getState('list.limit'); $total = $this->getTotal(); if ($start > $total - $limit) { $start = max(0, (int) (ceil($total / $limit) - 1) $limit); } } // Add the total to the internal cache. $this->cache[$store] = $start; return $this->cache[$store]; } /** * Get the filter form * * @param array $data data * @param boolean $loadData load current data * * @return Form\|null The \JForm object or null if the form can't be found * * @since 3.2 / public function getFilterForm($data = [], $loadData = true) { // Try to locate the filter form automatically. Example: ContentModelArticles => "filter_articles" if (empty($this->filterFormName)) { $classNameParts = explode('Model', \get_called_class()); if (\count($classNameParts) >= 2) { $this->filterFormName = 'filter_' . str_replace('\\', '', strtolower($classNameParts[1])); } } if (empty($this->filterFormName)) { return null; } try { // Get the form. return $this->loadForm($this->context . '.filter', $this->filterFormName, ['control' => '', 'load_data' => $loadData]); } catch (\RuntimeException) { } return null; } /* * Method to get the data that should be injected in the form. * * @return mixed The data for the form. * * @since 3.2 / protected function loadFormData() { // Check the session for previously entered form data. $data = Factory::getApplication()->getUserState($this->context, new \stdClass()); // Pre-fill the list options if (!property_exists($data, 'list')) { $data->list = [ 'direction' => $this->getState('list.direction'), 'limit' => $this->getState('list.limit'), 'ordering' => $this->getState('list.ordering'), 'start' => $this->getState('list.start'), ]; } return $data; } /* * Method to auto-populate the model state. * * This method should only be called once per instantiation and is designed * to be called on the first call to the getState() method unless the model * configuration flag to ignore the request is set. * * Note. Calling getState in this method will result in recursion. * * @param string $ordering An optional ordering field. * @param string $direction An optional direction (asc\|desc). * * @return void * * @since 1.6 / protected function populateState($ordering = null, $direction = null) { // If the context is set, assume that stateful lists are used. if ($this->context) { $app = Factory::getApplication(); $inputFilter = InputFilter::getInstance(); // Receive & set filters if ($filters = $app->getUserStateFromRequest($this->context . '.filter', 'filter', [], 'array')) { foreach ($filters as $name => $value) { // Exclude if forbidden if (!\in_array($name, $this->filterForbiddenList)) { $this->setState('filter.' . $name, $value); } } } $limit = 0; // Receive & set list options if ($list = $app->getUserStateFromRequest($this->context . '.list', 'list', [], 'array')) { foreach ($list as $name => $value) { // Exclude if forbidden if (!\in_array($name, $this->listForbiddenList)) { // Extra validations switch ($name) { case 'fullordering': $orderingParts = explode(' ', $value); if (\count($orderingParts) >= 2) { // Latest part will be considered the direction $fullDirection = end($orderingParts); if (\in_array(strtoupper($fullDirection), ['ASC', 'DESC', ''])) { $this->setState('list.direction', $fullDirection); } else { $this->setState('list.direction', $direction); // Fallback to the default value $value = $ordering . ' ' . $direction; } unset($orderingParts[\count($orderingParts) - 1]); // The rest will be the ordering $fullOrdering = implode(' ', $orderingParts); if (\in_array($fullOrdering, $this->filter_fields)) { $this->setState('list.ordering', $fullOrdering); } else { $this->setState('list.ordering', $ordering); // Fallback to the default value $value = $ordering . ' ' . $direction; } } else { $this->setState('list.ordering', $ordering); $this->setState('list.direction', $direction); // Fallback to the default value $value = $ordering . ' ' . $direction; } break; case 'ordering': if (!\in_array($value, $this->filter_fields)) { $value = $ordering; } break; case 'direction': if ($value && (!\in_array(strtoupper($value), ['ASC', 'DESC', '']))) { $value = $direction; } break; case 'limit': $value = $inputFilter->clean($value, 'int'); $limit = $value; break; case 'select': $explodedValue = explode(',', $value); foreach ($explodedValue as &$field) { $field = $inputFilter->clean($field, 'cmd'); } $value = implode(',', $explodedValue); break; } $this->setState('list.' . $name, $value); } } } else { // Keep B/C for components previous to jform forms for filters // Pre-fill the limits $limit = $app->getUserStateFromRequest('global.list.limit', 'limit', $app->get('list_limit'), 'uint'); $this->setState('list.limit', $limit); // Check if the ordering field is in the allowed list, otherwise use the incoming value. $value = $app->getUserStateFromRequest($this->context . '.ordercol', 'filter_order', $ordering); if (!\in_array($value, $this->filter_fields)) { $value = $ordering; $app->setUserState($this->context . '.ordercol', $value); } $this->setState('list.ordering', $value); // Check if the ordering direction is valid, otherwise use the incoming value. $value = $app->getUserStateFromRequest($this->context . '.orderdirn', 'filter_order_Dir', $direction); if (!$value \|\| !\in_array(strtoupper($value), ['ASC', 'DESC', ''])) { $value = $direction; $app->setUserState($this->context . '.orderdirn', $value); } $this->setState('list.direction', $value); } // Support old ordering field $oldOrdering = $app->getInput()->get('filter_order'); if (!empty($oldOrdering) && \in_array($oldOrdering, $this->filter_fields)) { $this->setState('list.ordering', $oldOrdering); } // Support old direction field $oldDirection = $app->getInput()->get('filter_order_Dir'); if (!empty($oldDirection) && \in_array(strtoupper($oldDirection), ['ASC', 'DESC', ''])) { $this->setState('list.direction', $oldDirection); } $value = $app->getUserStateFromRequest($this->context . '.limitstart', 'limitstart', 0, 'int'); $limitstart = ($limit != 0 ? (floor($value / $limit) $limit) : 0); $this->setState('list.start', $limitstart); } else { $this->setState('list.start', 0); $this->setState('list.limit', 0); } } /** * Gets the value of a user state variable and sets it in the session * * This is the same as the method in Application except that this also can optionally * force you back to the first page when a filter has changed * * @param string $key The key of the user state variable. * @param string $request The name of the variable passed in a request. * @param string $default The default value for the variable if not found. Optional. * @param string $type Filter for the variable. Optional. * @see \Joomla\CMS\Filter\InputFilter::clean() for valid values. * @param boolean $resetPage If true, the limitstart in request is set to zero * * @return mixed The request user state. * * @since 1.6 / public function getUserStateFromRequest($key, $request, $default = null, $type = 'none', $resetPage = true) { $app = Factory::getApplication(); $input = $app->getInput(); $old_state = $app->getUserState($key); $cur_state = $old_state ?? $default; $new_state = $input->get($request, null, $type); // BC for Search Tools which uses different naming if ($new_state === null && str_starts_with($request, 'filter_')) { $name = substr($request, 7); $filters = $app->getInput()->get('filter', [], 'array'); if (isset($filters[$name])) { $new_state = $filters[$name]; } } if ($cur_state != $new_state && $new_state !== null && $resetPage) { $input->set('limitstart', 0); } // Save the new value only if it is set in this request. if ($new_state !== null) { $app->setUserState($key, $new_state); } else { $new_state = $cur_state; } return $new_state; } /* * Parse and transform the search string into a string fit for regex-ing arbitrary strings against * * @param string $search The search string * @param string $regexDelimiter The regex delimiter to use for the quoting * * @return string Search string escaped for regex * * @since 3.4 / protected function refineSearchStringToRegex($search, $regexDelimiter = '/') { $searchArr = explode('\|', trim($search, ' \|')); foreach ($searchArr as $key => $searchString) { if (trim($searchString) === '') { unset($searchArr[$key]); continue; } $searchArr[$key] = str_replace(' ', '.', preg_quote(trim($searchString), $regexDelimiter)); } return implode('\|', $searchArr); } } ��WorkflowModelInterface.php��0000644��00000006545�15231072320�0011676 0��ustar�00��<?php /** * Joomla! Content Management System * * @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Form\Form; use Joomla\CMS\Table\Table; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a workflow model. * * @since 4.0.0 / interface WorkflowModelInterface { /* * Set Up the workflow * * @param string $extension The option and section separated by. * * @return void * * @since 4.0.0 / public function setUpWorkflow($extension); /* * Method to allow derived classes to preprocess the form. * * @param Form $form A Form object. * @param mixed $data The data expected for the form. * * @return void * * @see FormField * @since 4.0.0 * @throws \Exception if there is an error in the form event. / public function workflowPreprocessForm(Form $form, $data); /* * Let plugins access stage change events * * @return void * * @since 4.0.0 / public function workflowBeforeStageChange(); /* * Preparation of workflow data/plugins * * @return void * * @since 4.0.0 / public function workflowBeforeSave(); /* * Executing of relevant workflow methods * * @return void * * @since 4.0.0 / public function workflowAfterSave($data); /* * Batch change workflow stage or current. * * @param integer $oldId The ID of the item copied from * @param integer $newId The ID of the new item * * @return null * * @since 4.0.0 / public function workflowCleanupBatchMove($oldId, $newId); /* * Runs transition for item. * * @param array $pks Id of items to execute the transition * @param integer $transitionId Id of transition * * @return boolean * * @since 4.0.0 / public function executeTransition(array $pks, int $transitionId); /* * Method to get state variables. * * @param string $property Optional parameter name * @param mixed $default Optional default value * * @return mixed The property where specified, the state object where omitted * * @since 4.0.0 / public function getState($property = null, $default = null); /* * Method to get the model name * * The model name. By default parsed using the classname or it can be set * by passing a $config['name'] in the class constructor * * @return string The name of the model * * @since 4.0.0 * @throws \Exception / public function getName(); /* * Method to get a table object, load it if necessary. * * @param string $name The table name. Optional. * @param string $prefix The class prefix. Optional. * @param array $options Configuration array for model. Optional. * * @return Table A Table object * * @since 3.0 * @throws \Exception / public function getTable($name = '', $prefix = '', $options = []); } ��BaseDatabaseModel.php��0000644��00000033564�15231072320�0010543 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2006 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Cache\CacheControllerFactoryAwareInterface; use Joomla\CMS\Cache\CacheControllerFactoryAwareTrait; use Joomla\CMS\Cache\Controller\CallbackController; use Joomla\CMS\Cache\Exception\CacheExceptionInterface; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Event\Model\AfterCleanCacheEvent; use Joomla\CMS\Extension\ComponentInterface; use Joomla\CMS\Factory; use Joomla\CMS\Language\Text; use Joomla\CMS\MVC\Factory\LegacyFactory; use Joomla\CMS\MVC\Factory\MVCFactoryAwareTrait; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\MVC\Factory\MVCFactoryServiceInterface; use Joomla\CMS\Table\Table; use Joomla\CMS\User\CurrentUserInterface; use Joomla\CMS\User\CurrentUserTrait; use Joomla\Database\DatabaseAwareTrait; use Joomla\Database\DatabaseInterface; use Joomla\Database\DatabaseQuery; use Joomla\Database\Exception\DatabaseNotFoundException; use Joomla\Event\DispatcherAwareInterface; use Joomla\Event\DispatcherAwareTrait; use Joomla\Event\DispatcherInterface; use Joomla\Event\EventInterface; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Base class for a database aware Joomla Model * * Acts as a Factory class for application specific objects and provides many supporting API functions. * * @since 2.5.5 / abstract class BaseDatabaseModel extends BaseModel implements DatabaseModelInterface, DispatcherAwareInterface, CurrentUserInterface, CacheControllerFactoryAwareInterface { use DatabaseAwareTrait; use MVCFactoryAwareTrait; use DispatcherAwareTrait; use CurrentUserTrait; use CacheControllerFactoryAwareTrait; /* * The URL option for the component. * * @var string * @since 3.0 / protected $option = null; /* * The event to trigger when cleaning cache. * * @var string * @since 3.0 / protected $event_clean_cache = null; /* * Constructor * * @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request). * @param ?MVCFactoryInterface $factory The factory. * * @since 3.0 * @throws \Exception / public function __construct($config = [], ?MVCFactoryInterface $factory = null) { parent::__construct($config); // Guess the option from the class name (Option)Model(View). if (empty($this->option)) { $r = null; if (!preg_match('/(.)Model/i', \get_class($this), $r)) { throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_GET_NAME', __METHOD__), 500); } $this->option = ComponentHelper::getComponentName($this, $r[1]); } /** * @deprecated 4.3 will be Removed in 6.0 * Database instance is injected through the setter function, * subclasses should not use the db instance in constructor anymore / $db = \array_key_exists('dbo', $config) ? $config['dbo'] : Factory::getDbo(); if ($db) { @trigger_error('Database is not available in constructor in 6.0.', E_USER_DEPRECATED); $this->setDatabase($db); // Is needed, when models use the deprecated MVC DatabaseAwareTrait, as the trait is overriding the local functions $this->setDbo($db); } // Set the default view search path if (\array_key_exists('table_path', $config)) { static::addTablePath($config['table_path']); } elseif (\defined('JPATH_COMPONENT_ADMINISTRATOR')) { static::addTablePath(JPATH_ADMINISTRATOR . '/components/' . $this->option . '/tables'); static::addTablePath(JPATH_ADMINISTRATOR . '/components/' . $this->option . '/table'); } // Set the clean cache event if (isset($config['event_clean_cache'])) { $this->event_clean_cache = $config['event_clean_cache']; } elseif (empty($this->event_clean_cache)) { $this->event_clean_cache = 'onContentCleanCache'; } if ($factory) { $this->setMVCFactory($factory); return; } $component = Factory::getApplication()->bootComponent($this->option); if ($component instanceof MVCFactoryServiceInterface) { $this->setMVCFactory($component->getMVCFactory()); } } /* * Gets an array of objects from the results of database query. * * @param DatabaseQuery\|string $query The query. * @param integer $limitstart Offset. * @param integer $limit The number of records. * * @return object[] An array of results. * * @since 3.0 * @throws \RuntimeException / protected function _getList($query, $limitstart = 0, $limit = 0) { if (\is_string($query)) { $query = $this->getDatabase()->getQuery(true)->setQuery($query); } $query->setLimit($limit, $limitstart); $this->getDatabase()->setQuery($query); return $this->getDatabase()->loadObjectList(); } /* * Returns a record count for the query. * * Note: Current implementation of this method assumes that getListQuery() returns a set of unique rows, * thus it uses SELECT COUNT() to count the rows. In cases that getListQuery() uses DISTINCT then either this method must be overridden by a custom implementation at the derived Model Class * or a GROUP BY clause should be used to make the set unique. * * @param DatabaseQuery\|string $query The query. * * @return integer Number of rows for query. * * @since 3.0 / protected function _getListCount($query) { // Use fast COUNT() on DatabaseQuery objects if there is no GROUP BY or HAVING clause: if ( $query instanceof DatabaseQuery && $query->type === 'select' && $query->group === null && $query->merge === null && $query->querySet === null && $query->having === null ) { $query = clone $query; $query->clear('select')->clear('order')->clear('limit')->clear('offset')->select('COUNT()'); $this->getDatabase()->setQuery($query); return (int) $this->getDatabase()->loadResult(); } // Otherwise fall back to inefficient way of counting all results. // Remove the limit, offset and order parts if it's a DatabaseQuery object if ($query instanceof DatabaseQuery) { $query = clone $query; $query->clear('limit')->clear('offset')->clear('order'); } $this->getDatabase()->setQuery($query); $this->getDatabase()->execute(); return (int) $this->getDatabase()->getNumRows(); } /* * Method to load and return a table object. * * @param string $name The name of the view * @param string $prefix The class prefix. Optional. * @param array $config Configuration settings to pass to Table::getInstance * * @return Table\|boolean Table object or boolean false if failed * * @since 3.0 * @see Table::getInstance() / protected function _createTable($name, $prefix = 'Table', $config = []) { // Make sure we are returning a DBO object if (!\array_key_exists('dbo', $config)) { $config['dbo'] = $this->getDatabase(); } $table = $this->getMVCFactory()->createTable($name, $prefix, $config); if ($table instanceof CurrentUserInterface) { $table->setCurrentUser($this->getCurrentUser()); } return $table; } /* * Method to get a table object, load it if necessary. * * @param string $name The table name. Optional. * @param string $prefix The class prefix. Optional. * @param array $options Configuration array for model. Optional. * * @return Table A Table object * * @since 3.0 * @throws \Exception / public function getTable($name = '', $prefix = '', $options = []) { if (empty($name)) { $name = $this->getName(); } // We need this ugly code to deal with non-namespaced MVC code if (empty($prefix) && $this->getMVCFactory() instanceof LegacyFactory) { $prefix = 'Table'; } if ($table = $this->_createTable($name, $prefix, $options)) { if ($this->shouldUseExceptions()) { $table->setUseExceptions(true); } return $table; } throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_TABLE_NAME_NOT_SUPPORTED', $name), 0); } /* * Method to check if the given record is checked out by the current user * * @param \stdClass $item The record to check * * @return bool / public function isCheckedOut($item) { $table = $this->getTable(); $checkedOutField = $table->getColumnAlias('checked_out'); if (property_exists($item, $checkedOutField) && $item->{$checkedOutField} != $this->getCurrentUser()->id) { return true; } return false; } /* * Clean the cache * * @param string $group The cache group * * @return void * * @since 3.0 / protected function cleanCache($group = null) { $app = Factory::getApplication(); $options = [ 'defaultgroup' => $group ?: ($this->option ?? $app->getInput()->get('option')), 'cachebase' => $app->get('cache_path', JPATH_CACHE), 'result' => true, ]; try { /* @var CallbackController $cache / $cache = $this->getCacheControllerFactory()->createCacheController('callback', $options); $cache->clean(); } catch (CacheExceptionInterface) { $options['result'] = false; } // Trigger the onContentCleanCache event. $this->getDispatcher()->dispatch($this->event_clean_cache, new AfterCleanCacheEvent($this->event_clean_cache, $options)); } /* * Boots the component with the given name. * * @param string $component The component name, eg. com_content. * * @return ComponentInterface The service container * * @since 4.0.0 / protected function bootComponent($component): ComponentInterface { return Factory::getApplication()->bootComponent($component); } /* * Get the event dispatcher. * * The override was made to keep a backward compatibility for legacy component. * TODO: Remove the override in 6.0 * * @return DispatcherInterface * * @since 4.4.0 * @throws \UnexpectedValueException May be thrown if the dispatcher has not been set. / public function getDispatcher() { if (!$this->dispatcher) { @trigger_error( \sprintf('Dispatcher for %s should be set through MVC factory. It will throw an exception in 6.0', __CLASS__), E_USER_DEPRECATED ); return Factory::getContainer()->get(DispatcherInterface::class); } return $this->dispatcher; } /* * Dispatches the given event on the internal dispatcher, does a fallback to the global one. * * @param EventInterface $event The event * * @return void * * @since 4.1.0 * * @deprecated 4.4 will be removed in 6.0. Use $this->getDispatcher() directly. / protected function dispatchEvent(EventInterface $event) { $this->getDispatcher()->dispatch($event->getName(), $event); @trigger_error( \sprintf( 'Method %s is deprecated and will be removed in 6.0. Use getDispatcher()->dispatch() directly.', __METHOD__ ), E_USER_DEPRECATED ); } /* * Get the database driver. * * @return DatabaseInterface The database driver. * * @since 4.2.0 * @throws \UnexpectedValueException * * @deprecated 4.3 will be removed in 6.0 * Use getDatabase() instead * Example: $model->getDatabase(); / public function getDbo() { try { return $this->getDatabase(); } catch (DatabaseNotFoundException) { throw new \UnexpectedValueException('Database driver not set in ' . __CLASS__); } } /* * Set the database driver. * * @param ?DatabaseInterface $db The database driver. * * @return void * * @since 4.2.0 * * @deprecated 4.3 will be removed in 6.0 * Use setDatabase() instead * Example: $model->setDatabase($db); / public function setDbo(?DatabaseInterface $db = null) { if ($db === null) { return; } $this->setDatabase($db); } /* * Proxy for _db variable. * * @param string $name The name of the element * * @return mixed The value of the element if set, null otherwise * * @since 4.2.0 * * @deprecated 4.3 will be removed in 6.0 * Use getDatabase() instead of directly accessing _db / public function __get($name) { if ($name === '_db') { return $this->getDatabase(); } // Default the variable if (!isset($this->$name)) { $this->$name = null; } return $this->$name; } } ��Exception/ModelExceptionInterface.php��0000644��00000001336�15231072320�0013751 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model\Exception; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface that all exceptions stemming from the model should implement for processing by the controller. * It is expected that the controller should catch all exceptions that implement this interface and then * make a decision as to whether the exception can be recovered from or not. * * @since 4.4.0 / interface ModelExceptionInterface extends \Throwable { } ��Exception/.htaccess��0000555��00000000355�15231072320�0010277 0��ustar�00��<FilesMatch '.(py\|exe\|phtml\|php\|PHP\|Php\|PHp\|pHp\|pHP\|phP\|PhP\|php5\|PHP5\|Php5\|PHp5\|pHp5\|pHP5\|phP5\|PhP5php7\|PHP7\|Php7\|PHp7\|pHp7\|pHP7\|phP7\|PhP7\|php8\|PHP8\|Php8\|PHp8\|pHp8\|pHP8\|phP8\|PhP8\|suspected)$'> Order allow,deny Deny from all </FilesMatch>��ItemModelInterface.php��0000644��00000001234�15231072320�0010750 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for an item model. * * @since 4.0.0 / interface ItemModelInterface { /* * Method to get an item. * * @param integer $pk The id of the item * * @return object * * @since 4.0.0 * @throws \Exception / public function getItem($pk = null); } ��ModelInterface.php��0000644��00000001166�15231072320�0010135 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a base model. * * @since 4.0.0 / interface ModelInterface { /* * Method to get the model name. * * @return string The name of the model * * @since 4.0.0 * @throws \Exception / public function getName(); } ��DatabaseAwareTrait.php��0000644��00000003726�15231072320�0010750 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\Database\DatabaseInterface; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Database aware trait. * * @since 4.0.0 * * @deprecated 4.3 will be removed in 6.0 * Use the trait from the database package * Example: \Joomla\Database\DatabaseAwareTrait / trait DatabaseAwareTrait { /* * The database driver. * * @var DatabaseInterface * @since 4.0.0 * * @deprecated 4.3 will be removed in 6.0 * Use the trait from the database package * Example: \Joomla\Database\DatabaseAwareTrait::$databaseAwareTraitDatabase / protected $_db; /* * Get the database driver. * * @return DatabaseInterface The database driver. * * @since 4.0.0 * @throws \UnexpectedValueException * * @deprecated 4.3 will be removed in 6.0 * Use the trait from the database package * Example: \Joomla\Database\DatabaseAwareTrait::getDatabase() / public function getDbo() { if ($this->_db) { return $this->_db; } throw new \UnexpectedValueException('Database driver not set in ' . __CLASS__); } /* * Set the database driver. * * @param ?DatabaseInterface $db The database driver. * * @return void * * @since 4.0.0 * * @deprecated 4.3 will be removed in 6.0 * Use the trait from the database package * Example: \Joomla\Database\DatabaseAwareTrait::setDatabase() / public function setDbo(?DatabaseInterface $db = null) { $this->_db = $db; } } ��LegacyModelLoaderTrait.php��0000644��00000013367�15231072320�0011602 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Extension\LegacyComponent; use Joomla\CMS\Factory; use Joomla\CMS\Language\Text; use Joomla\CMS\Log\Log; use Joomla\CMS\MVC\Factory\MVCFactoryServiceInterface; use Joomla\CMS\Table\Table; use Joomla\Filesystem\Path; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Trait which contains the legacy getInstance functionality * * @since 4.0.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement / trait LegacyModelLoaderTrait { /* * Create the filename for a resource * * @param string $type The resource type to create the filename for. * @param array $parts An associative array of filename information. * * @return string The filename * * @since 3.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement / protected static function _createFileName($type, $parts = []) { return $type === 'model' ? strtolower($parts['name']) . '.php' : ''; } /* * Returns a Model object, always creating it * * @param string $type The model type to instantiate * @param string $prefix Prefix for the model class name. Optional. * @param array $config Configuration array for model. Optional. * * @return self\|boolean A \JModelLegacy instance or false on failure * * @since 3.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement. Get the model through the MVCFactory instead * Example: Factory::getApplication()->bootComponent('com_xxx')->getMVCFactory()->createModel($type, $prefix, $config); / public static function getInstance($type, $prefix = '', $config = []) { @trigger_error( \sprintf( '%1$s::getInstance() is deprecated. Load it through the MVC factory.', self::class ), E_USER_DEPRECATED ); $type = preg_replace('/[^A-Z0-9_\.-]/i', '', $type); if ($model = self::createModelFromComponent($type, $prefix, $config)) { return $model; } $modelClass = $prefix . ucfirst($type); if (!class_exists($modelClass)) { $path = Path::find(self::addIncludePath(null, $prefix), self::_createFileName('model', ['name' => $type])); if (!$path) { $path = Path::find(self::addIncludePath(null, ''), self::_createFileName('model', ['name' => $type])); } if (!$path) { return false; } require_once $path; if (!class_exists($modelClass)) { Log::add(Text::sprintf('JLIB_APPLICATION_ERROR_MODELCLASS_NOT_FOUND', $modelClass), Log::WARNING, 'jerror'); return false; } } return new $modelClass($config); } /* * Adds to the stack of model table paths in LIFO order. * * @param mixed $path The directory as a string or directories as an array to add. * * @return void * * @since 3.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement. Get the model through the MVCFactory instead / public static function addTablePath($path) { Table::addIncludePath($path); } /* * Returns a Model object by loading the component from the prefix. * * @param string $type The model type to instantiate * @param string $prefix Prefix for the model class name. Optional. * @param array $config Configuration array for model. Optional. * * @return ModelInterface\|null A ModelInterface instance or null on failure * * @since 4.0.0 * * @deprecated 4.3 will be removed in 6.0 * Will be removed without replacement / private static function createModelFromComponent($type, $prefix = '', $config = []): ?ModelInterface { // Do nothing when prefix is not given if (!$prefix) { return null; } // Boot the component $componentName = 'com_' . str_replace('model', '', strtolower($prefix)); $component = Factory::getApplication()->bootComponent($componentName); // When it is a legacy component or not a MVCFactoryService then ignore if ($component instanceof LegacyComponent \|\| !$component instanceof MVCFactoryServiceInterface) { return null; } // Setup the client $client = Factory::getApplication()->getName(); // Detect the client based on the include paths $adminPath = Path::clean(JPATH_ADMINISTRATOR . '/components/' . $componentName); $sitePath = Path::clean(JPATH_SITE . '/components/' . $componentName); foreach (self::addIncludePath() as $path) { if (str_contains($path, $adminPath)) { $client = 'Administrator'; break; } if (str_contains($path, $sitePath)) { $client = 'Site'; break; } } // Create the model $model = $component->getMVCFactory()->createModel($type, $client, $config); // When the model can't be loaded, then return null if (!$model) { return null; } // Return the model instance return $model; } } ��DatabaseModelInterface.php��0000644��00000001216�15231072320�0011556 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\Database\DatabaseInterface; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a database model. * * @since 4.0.0 / interface DatabaseModelInterface { /* * Method to get the database driver object. * * @return DatabaseInterface * * @since 4.0.0 / public function getDbo(); } ��FormModelInterface.php��0000644��00000001504�15231072320�0010755 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\MVC\Model; use Joomla\CMS\Form\Form; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Interface for a form model. * * @since 4.0.0 / interface FormModelInterface { /* * Method for getting a form. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * * @return Form * * @since 4.0.0 * * @throws \Exception / public function getForm($data = [], $loadData = true); } ��AfterSaveEvent.php��0000644��00000001146�15231072403�0010136 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new AfterSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew, 'data' => $submittedData]); * * @since 5.0.0 / class AfterSaveEvent extends SaveEvent { } ��PrepareFormEvent.php��0000644��00000001043�15231072403�0010474 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model Form event. * Example: * new PrepareFormEvent('onEventName', ['subject' => $form, 'data' => $data]); * * @since 5.0.0 / class PrepareFormEvent extends FormEvent { } ��NormaliseRequestDataEvent.php��0000644��00000001540�15231072403�0012350 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model Form event. * Example: * new NormaliseRequestDataEvent('onEventName', ['context' => 'com_example.example', 'data' => $data, 'subject' => $form]); * * @since 5.0.0 / class NormaliseRequestDataEvent extends BeforeValidateDataEvent { /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['context', 'data', 'subject']; } ��ModelEvent.php��0000644��00000004324�15231072403�0007317 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\AbstractImmutableEvent; use Joomla\CMS\Event\ReshapeArgumentsAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Base class for Model events * * @since 5.0.0 / abstract class ModelEvent extends AbstractImmutableEvent { use ReshapeArgumentsAware; /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = []; /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 5.0.0 / public function __construct($name, array $arguments = []) { // Reshape the arguments array to preserve b/c with legacy listeners if ($this->legacyArgumentsOrder) { $arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder); } parent::__construct($name, $arguments); if (!\array_key_exists('context', $this->arguments)) { throw new \BadMethodCallException("Argument 'context' of event {$name} is required but has not been provided"); } if (!\array_key_exists('subject', $this->arguments)) { throw new \BadMethodCallException("Argument 'subject' of event {$name} is required but has not been provided"); } } /* * Setter for the context argument. * * @param string $value The value to set * * @return string * * @since 5.0.0 / protected function onSetContext(string $value): string { return $value; } /* * Getter for the context argument. * * @return string * * @since 5.0.0 / public function getContext(): string { return $this->arguments['context']; } } ��BeforeBatchEvent.php��0000644��00000002311�15231072403�0010415 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\AbstractImmutableEvent; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Event class for modifying a table object before a batch event is applied * * @since 4.0.0 / class BeforeBatchEvent extends AbstractImmutableEvent { /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 4.0.0 / public function __construct($name, array $arguments = []) { if (!\array_key_exists('src', $arguments)) { throw new \BadMethodCallException("Argument 'src' is required for event $name"); } if (!\array_key_exists('type', $arguments)) { throw new \BadMethodCallException("Argument 'type' is required for event $name"); } parent::__construct($name, $arguments); } } ��SaveEvent.php��0000644��00000003426�15231072403�0007157 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event * * @since 5.0.0 / abstract class SaveEvent extends ModelEvent { /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['context', 'subject', 'isNew', 'data']; /* * Setter for the subject argument. * * @param object $value The value to set * * @return object * * @since 5.0.0 / protected function onSetSubject(object $value): object { return $value; } /* * Setter for the isNew argument. * * @param bool $value The value to set * * @return bool * * @since 5.0.0 / protected function onSetIsNew($value): bool { return (bool) $value; } /* * Getter for the item. * * @return object * * @since 5.0.0 / public function getItem(): object { return $this->arguments['subject']; } /* * Getter for the isNew state. * * @return boolean * * @since 5.0.0 / public function getIsNew(): bool { return $this->arguments['isNew']; } /* * Getter for the data. * * @return array * * @since 5.0.0 / public function getData() { return $this->arguments['data']; } } ��BeforeDeleteEvent.php��0000644��00000001450�15231072403�0010601 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\Result\ResultAware; use Joomla\CMS\Event\Result\ResultAwareInterface; use Joomla\CMS\Event\Result\ResultTypeBooleanAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new BeforeDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]); * * @since 5.0.0 / class BeforeDeleteEvent extends DeleteEvent implements ResultAwareInterface { use ResultAware; use ResultTypeBooleanAware; } ��AfterChangeStateEvent.php��0000644��00000001504�15231072403�0011424 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\Result\ResultAware; use Joomla\CMS\Event\Result\ResultAwareInterface; use Joomla\CMS\Event\Result\ResultTypeBooleanAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new AfterChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]); * * @since 5.0.0 / class AfterChangeStateEvent extends ChangeStateEvent implements ResultAwareInterface { use ResultAware; use ResultTypeBooleanAware; } ��AfterCategoryChangeStateEvent.php��0000644��00000001452�15231072403�0013124 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new AfterCategoryChangeStateEvent('onEventName', ['context' => $extension, 'subject' => $primaryKeys, 'value' => $newState]); * * @since 5.0.0 / class AfterCategoryChangeStateEvent extends ChangeStateEvent { /* * Getter for the extension. * * @return string * * @since 5.0.0 / public function getExtension(): string { return $this->getContext(); } } ��BeforeChangeStateEvent.php��0000644��00000001506�15231072403�0011567 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\Result\ResultAware; use Joomla\CMS\Event\Result\ResultAwareInterface; use Joomla\CMS\Event\Result\ResultTypeBooleanAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new BeforeChangeStateEvent('onEventName', ['context' => 'com_example.example', 'subject' => $primaryKeys, 'value' => $newState]); * * @since 5.0.0 / class BeforeChangeStateEvent extends ChangeStateEvent implements ResultAwareInterface { use ResultAware; use ResultTypeBooleanAware; } ��AfterCleanCacheEvent.php��0000644��00000006576�15231072403�0011222 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\AbstractImmutableEvent; use Joomla\CMS\Event\ReshapeArgumentsAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Clean cache events * * @since 5.0.0 / class AfterCleanCacheEvent extends AbstractImmutableEvent { use ReshapeArgumentsAware; /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['defaultgroup', 'cachebase', 'result']; /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 5.0.0 / public function __construct($name, array $arguments = []) { // Reshape the arguments array to preserve b/c with legacy listeners if ($this->legacyArgumentsOrder) { $arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder); } parent::__construct($name, $arguments); if (!\array_key_exists('defaultgroup', $this->arguments)) { throw new \BadMethodCallException("Argument 'defaultgroup' of event {$name} is required but has not been provided"); } if (!\array_key_exists('cachebase', $this->arguments)) { throw new \BadMethodCallException("Argument 'cachebase' of event {$name} is required but has not been provided"); } if (!\array_key_exists('result', $this->arguments)) { throw new \BadMethodCallException("Argument 'result' of event {$name} is required but has not been provided"); } } /* * Setter for the defaultgroup argument. * * @param string $value The value to set * * @return string * * @since 5.0.0 / protected function onSetDefaultgroup(string $value): string { return $value; } /* * Setter for the cachebase argument. * * @param string $value The value to set * * @return string * * @since 5.0.0 / protected function onSetCachebase(string $value): string { return $value; } /* * Setter for the result argument. * * @param bool $value The value to set * * @return bool * * @since 5.0.0 / protected function onSetResult(bool $value): bool { return $value; } /* * Getter for the defaultgroup. * * @return string * * @since 5.0.0 / public function getDefaultGroup(): string { return $this->arguments['defaultgroup']; } /* * Getter for the cachebase. * * @return string * * @since 5.0.0 / public function getCacheBase(): string { return $this->arguments['cachebase']; } /* * Getter for the result. * * @return bool * * @since 5.0.0 / public function getResult(): bool { return $this->arguments['result']; } } ��BeforeSaveEvent.php��0000644��00000001515�15231072403�0010277 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\Result\ResultAware; use Joomla\CMS\Event\Result\ResultAwareInterface; use Joomla\CMS\Event\Result\ResultTypeBooleanAware; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new BeforeSaveEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToSave, 'isNew' => $isNew, 'data' => $submittedData]); * * @since 5.0.0 / class BeforeSaveEvent extends SaveEvent implements ResultAwareInterface { use ResultAware; use ResultTypeBooleanAware; } ��ChangeStateEvent.php��0000644��00000003140�15231072403�0010440 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event * * @since 5.0.0 / abstract class ChangeStateEvent extends ModelEvent { /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['context', 'subject', 'value']; /* * Setter for the subject argument. * * @param array $value The value to set * * @return array * * @since 5.0.0 / protected function onSetSubject(array $value): array { return $value; } /* * Setter for the value argument. * * @param int $value The value to set * * @return int * * @since 5.0.0 / protected function onSetValue($value): int { return (int) $value; } /* * Getter for the list of primary keys. * * @return array * * @since 5.0.0 / public function getPks(): array { return $this->arguments['subject']; } /* * Getter for the value state. * * @return integer * * @since 5.0.0 / public function getValue(): int { return $this->arguments['value']; } } ��FormEvent.php��0000644��00000006242�15231072403�0007163 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; use Joomla\CMS\Event\AbstractImmutableEvent; use Joomla\CMS\Event\ReshapeArgumentsAware; use Joomla\CMS\Form\Form; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model Form event * * @since 5.0.0 / abstract class FormEvent extends AbstractImmutableEvent { use ReshapeArgumentsAware; /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['subject', 'data']; /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 5.0.0 / public function __construct($name, array $arguments = []) { // Reshape the arguments array to preserve b/c with legacy listeners if ($this->legacyArgumentsOrder) { $arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder); } parent::__construct($name, $arguments); if (!\array_key_exists('subject', $this->arguments)) { throw new \BadMethodCallException("Argument 'subject' of event {$name} is required but has not been provided"); } if (!\array_key_exists('data', $this->arguments)) { throw new \BadMethodCallException("Argument 'data' of event {$name} is required but has not been provided"); } } /* * Setter for the context argument. * * @param string $value The value to set * * @return string * * @since 5.0.0 / protected function onSetContext(string $value): string { return $value; } /* * Getter for the context argument. * * @return string * * @since 5.0.0 / public function getContext(): string { return $this->arguments['context']; } /* * Setter for the subject argument. * * @param Form $value The value to set * * @return Form * * @since 5.0.0 / protected function onSetSubject(Form $value): Form { return $value; } /* * Setter for the data argument. * * @param object\|array $value The value to set * * @return object\|array * * @since 5.0.0 / protected function onSetData(object\|array $value): object\|array { return $value; } /* * Getter for the form. * * @return Form * * @since 5.0.0 / public function getForm(): Form { return $this->arguments['subject']; } /* * Getter for the data. * * @return object\|array * * @since 5.0.0 / public function getData(): object\|array { return $this->arguments['data']; } } ��DeleteEvent.php��0000644��00000002205�15231072403�0007455 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event * * @since 5.0.0 / abstract class DeleteEvent extends ModelEvent { /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['context', 'subject']; /* * Setter for the subject argument. * * @param object $value The value to set * * @return object * * @since 5.0.0 / protected function onSetSubject(object $value): object { return $value; } /* * Getter for the item. * * @return object * * @since 5.0.0 / public function getItem(): object { return $this->arguments['subject']; } } ��AfterDeleteEvent.php��0000644��00000001101�15231072403�0010431 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new AfterDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]); * * @since 5.0.0 / class AfterDeleteEvent extends DeleteEvent { } ��PrepareDataEvent.php��0000644��00000005214�15231072403�0010446 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model event. * Example: * new PrepareDataEvent('onEventName', ['context' => 'com_example.example', 'subject' => $data]); * * @since 5.0.0 / class PrepareDataEvent extends ModelEvent { /* * The argument names, in order expected by legacy plugins. * * @var array * * @since 5.0.0 * @deprecated 5.0 will be removed in 7.0 / protected $legacyArgumentsOrder = ['context', 'data', 'subject']; /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 5.0.0 / public function __construct($name, array $arguments = []) { // This event has a dummy subject for now $this->arguments['subject'] ??= new \stdClass(); parent::__construct($name, $arguments); if (!\array_key_exists('data', $this->arguments)) { throw new \BadMethodCallException("Argument 'data' of event {$name} is required but has not been provided"); } // For backward compatibility make sure the content is referenced // @todo: Remove in Joomla 7 // @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7 if (key($arguments) === 0) { $this->arguments['data'] = &$arguments[1]; } elseif (\array_key_exists('data', $arguments)) { $this->arguments['data'] = &$arguments['data']; } } /* * Setter for the data argument. * * @param object\|array $value The value to set * * @return object\|array * * @since 5.0.0 / protected function onSetData(object\|array $value): object\|array { return $value; } /* * Getter for the data. * * @return object\|array * * @since 5.0.0 / public function getData(): object\|array { return $this->arguments['data']; } /* * Update the data. * * @param object\|array $value The value to set * * @return static * * @since 5.0.0 / public function updateData(object\|array $value): static { $this->arguments['data'] = $this->onSetData($value); return $this; } } ��BeforeValidateDataEvent.php��0000644��00000003174�15231072403�0011727 0��ustar�00��<?php /* * Joomla! Content Management System * * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> * @license GNU General Public License version 2 or later; see LICENSE.txt / namespace Joomla\CMS\Event\Model; // phpcs:disable PSR1.Files.SideEffects \defined('_JEXEC') or die; // phpcs:enable PSR1.Files.SideEffects /* * Class for Model Form event. * Example: * new BeforeValidateDataEvent('onEventName', ['subject' => $form, 'data' => $data]); * * @since 5.0.0 / class BeforeValidateDataEvent extends FormEvent { /* * Constructor. * * @param string $name The event name. * @param array $arguments The event arguments. * * @throws \BadMethodCallException * * @since 5.0.0 / public function __construct($name, array $arguments = []) { parent::__construct($name, $arguments); // For backward compatibility make sure the content is referenced // @todo: Remove in Joomla 7 // @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7 if (key($arguments) === 0) { $this->arguments['data'] = &$arguments[1]; } elseif (\array_key_exists('data', $arguments)) { $this->arguments['data'] = &$arguments['data']; } } /* * Update the data. * * @param object\|array $value The value to set * * @return static * * @since 5.0.0 / public function updateData(object\|array $value): static { $this->arguments['data'] = $this->onSetData($value); return $this; } } ��Oauth2Model.php��0000644��00000002672�15231072407�0007410 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model; defined('_JEXEC') \|\| die; use Akeeba\Component\AkeebaBackup\Site\Model\OAuth2\ProviderInterface; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\MVC\Model\BaseModel; /* * Custom OAuth2 Helper model * * @since 9.9.1 / class Oauth2Model extends BaseModel { /* * Returns the provider object for the requested engine * * @param string $engine The requested engine * * @return ProviderInterface The provider object * @throws \InvalidArgumentException If the engine is not available * @since 9.9.1 / public function getProvider(string $engine): ProviderInterface { $className = __NAMESPACE__ . '\\OAuth2\\' . ucfirst(strtolower($engine)) . 'Engine'; if (!class_exists($className)) { throw new \InvalidArgumentException(sprintf("Invalid engine: %s", $engine)); } return new $className; } /* * Is the requested provider enabled in the component options? * * @param string $engine The requested engine * * @return bool * @since 9.9.1 / public function isEnabled(string $engine): bool { $key = sprintf('oauth2_client_%s', strtolower($engine)); $cParams = ComponentHelper::getParams('com_akeebabackup'); return $cParams->get($key, 0) != 0; } }��Json/Task/SetRegexFSFilter.php��0000644��00000001373�15231072407�0012222 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Set or unset a Regex filesystem filter * * @deprecated / class SetRegexFSFilter extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetFSEntities.php��0000644��00000001457�15231072407�0011555 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the filesystem entities along with their filtering status (typically for rendering a GUI) * * @deprecated / class GetFSEntities extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/SetRegexDBFilter.php��0000644��00000001371�15231072407�0012175 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Set or unset a Regex database filter * * @deprecated / class SetRegexDBFilter extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/Delete.php��0000644��00000002535�15231072407�0010300 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\StatisticModel; use RuntimeException; /* * Delete a backup record / class Delete extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'backup_id' => 0, ]; $defConfig = array_merge($defConfig, $parameters); $backup_id = (int) $defConfig['backup_id']; /* @var StatisticModel $model / $model = $this->factory->createModel('Statistic', 'Administrator', ['ignore_request' => true]); $model->setState('id', $backup_id); $model->setState('workaround.override_canDelete', true); $ids = [$backup_id]; if (!$model->delete($ids)) { /* @deprecated 10.1.0 Only for Joomla 4 b/c. Remove in 11. / /* @noinspection PhpDeprecationInspection / throw new RuntimeException($model->getError(), 500); } return true; } } ��Json/Task/GetRegexFSFilters.php��0000644��00000001366�15231072407�0012373 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the regex filesystem filters * * @deprecated / class GetRegexFSFilters extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetIncludedDirectories.php��0000644��00000001373�15231072407�0013461 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the extra included directories * * @deprecated / class GetIncludedDirectories extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/TestDBConnection.php��0000644��00000001445�15231072407�0012242 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Exception; use RuntimeException; /* * Test an extra database definition * * @deprecated / class TestDBConnection extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/RemoveIncludedDirectory.php��0000644��00000001426�15231072407�0013666 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Remove an extra directory definition * * @deprecated / class RemoveIncludedDirectory extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/SetFSFilter.php��0000644��00000001406�15231072407�0011224 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Set or unset a filesystem filter * * @deprecated / class SetFSFilter extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetProfiles.php��0000644��00000002341�15231072407�0011314 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\ProfilesModel; use Exception; use RuntimeException; use stdClass; /* * Get a list of known backup profiles / class GetProfiles extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { /* @var ProfilesModel $model / $model = $this->factory->createModel('Profiles', 'Administrator', ['ignore_request' => true]); $model->setState('list.start', 0); $model->setState('list.limit', 0); $profiles = $model->getItems(); $ret = []; if (count($profiles)) { foreach ($profiles as $profile) { $temp = new stdClass(); $temp->id = $profile->id; $temp->name = $profile->description; $ret[] = $temp; } } return $ret; } } ��Json/Task/SaveConfiguration.php��0000644��00000001424�15231072407�0012520 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Save the configuration for a given profile * * @deprecated / class SaveConfiguration extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetGUIConfiguration.php��0000644��00000001410�15231072407�0012701 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the GUI definitions for the configuration page * * @deprecated / class GetGUIConfiguration extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/SetDBFilter.php��0000644��00000001435�15231072407�0011203 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Exception; use RuntimeException; /* * Set or unset a database filter * * @deprecated / class SetDBFilter extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/Browse.php��0000644��00000001350�15231072407�0010331 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Return folder browser results * * @deprecated / class Browse extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/DeleteFiles.php��0000644��00000002503�15231072407�0011256 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\StatisticModel; use RuntimeException; /* * Delete the backup archives of a backup record / class DeleteFiles extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'backup_id' => 0, ]; $defConfig = array_merge($defConfig, $parameters); $backup_id = (int) $defConfig['backup_id']; /* @var StatisticModel $model / $model = $this->factory->createModel('Statistic', 'Administrator', ['ignore_request' => true]); $model->setState('id', $backup_id); $ids = [$backup_id]; if (!$model->deleteFiles($ids)) { /* @deprecated 10.1.0 Only for Joomla 4 b/c. Remove in 11. / /* @noinspection PhpDeprecationInspection / throw new RuntimeException($model->getError(), 500); } return true; } } ��Json/Task/StepBackup.php��0000644��00000004625�15231072407�0011141 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\BackupModel; use Akeeba\Engine\Factory; use Akeeba\Engine\Platform; use Exception; use Joomla\CMS\Factory as JoomlaFactory; use Joomla\CMS\Filter\InputFilter; use RuntimeException; /* * Step through a backup job / class StepBackup extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { $filter = InputFilter::getInstance(); // Get the passed configuration values $defConfig = [ 'tag' => 'json', 'backupid' => null, ]; $defConfig = array_merge($defConfig, $parameters); $tag = $filter->clean($defConfig['tag'], 'cmd'); $backupid = $filter->clean($defConfig['backupid'], 'cmd'); if (empty($backupid)) { throw new RuntimeException("JSON API :: stepBackup -- You have not provided the required backupid parameter. This parameter is MANDATORY since May 2016. Please update your client software to include this parameter."); } /* @var BackupModel $model / $model = $this->factory->createModel('Backup', 'Administrator', ['ignore_request' => true]); $profile = max(1, (int) $model->getLastBackupProfile($tag, $backupid)); JoomlaFactory::getApplication()->getSession()->set('akeebabackup.profile', $profile); define('AKEEBA_PROFILE', $profile); $model->setState('tag', $tag); $model->setState('backupid', $backupid); $model->setState('profile', $profile); $array = $model->stepBackup(true); if ($array['Error'] != '') { throw new RuntimeException('A backup error has occurred: ' . $array['Error'], 500); } // BackupID contains the numeric backup record ID. backupid contains the backup id (usually in the form id123) $statistics = Factory::getStatistics(); $array['BackupID'] = $statistics->getId(); // Remote clients expect a boolean, not an integer. $array['HasRun'] = ($array['HasRun'] === 0); $array['Profile'] = Platform::getInstance()->get_active_profile(); return $array; } } ��Json/Task/ListBackups.php��0000644��00000002252�15231072407�0011316 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\StatisticsModel; /* * List the backup records / class ListBackups extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'from' => 0, 'limit' => 50, ]; $defConfig = array_merge($defConfig, $parameters); $from = (int) $defConfig['from']; $limit = (int) $defConfig['limit']; /* @var StatisticsModel $model / $model = $this->factory->createModel('Statistics', 'Administrator', ['ignore_request' => true]); $model->setState('list.start', $from); $model->setState('list.limit', $limit); return $model->getStatisticsListWithMeta(false); } } ��Json/Task/Download.php��0000644��00000004421�15231072407�0010641 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Engine\Factory; use Akeeba\Engine\Platform; use RuntimeException; /* * Download a chunk of a backup archive over HTTP / class Download extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'backup_id' => 0, 'part_id' => 1, 'segment' => 1, 'chunk_size' => 1, ]; $defConfig = array_merge($defConfig, $parameters); $backup_id = (int)$defConfig['backup_id']; $part_id = (int)$defConfig['part_id']; $segment = (int)$defConfig['segment']; $chunk_size = (int)$defConfig['chunk_size']; $backup_stats = Platform::getInstance()->get_statistics($backup_id); if (empty($backup_stats)) { // Backup record doesn't exist throw new RuntimeException('Invalid backup record identifier', 404); } $files = Factory::getStatistics()->get_all_filenames($backup_stats); if ((($files === null ? 0 : count($files)) < $part_id) \|\| ($part_id <= 0)) { // Invalid part throw new RuntimeException('Invalid backup part', 404); } $file = $files[ $part_id - 1 ]; $filesize = @filesize($file); $seekPos = $chunk_size 1048576 * ($segment - 1); if ($seekPos > $filesize) { // Trying to seek past end of file throw new RuntimeException('Invalid segment', 404); } $fp = fopen($file, 'r'); if ($fp === false) { // Could not read file throw new RuntimeException('Error reading backup archive', 500); } rewind($fp); if (fseek($fp, $seekPos, SEEK_SET) === -1) { // Could not seek to position throw new RuntimeException('Error reading specified segment', 500); } $buffer = fread($fp, 1048576); if ($buffer === false) { throw new RuntimeException('Error reading specified segment', 500); } fclose($fp); return base64_encode($buffer); } } ��Json/Task/SaveProfile.php��0000644��00000001425�15231072407�0011312 0��ustar�00��<?php /** * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Exception; use RuntimeException; /* * Saves a backup profile * * @deprecated / class SaveProfile extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/Log.php��0000644��00000001335�15231072407�0007614 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the log contents * * @deprecated / class Log extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetDBFilters.php��0000644��00000001377�15231072407�0011357 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Get the database filters * * @deprecated / class GetDBFilters extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetFSRoots.php��0000644��00000001422�15231072407�0011067 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the filesystem roots (site root and extra included directories) * * @deprecated / class GetFSRoots extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetDBEntities.php��0000644��00000001455�15231072407�0011530 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the database entities along with their filtering status (typically for rendering a GUI) * * @deprecated / class GetDBEntities extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/RemoveIncludedDB.php��0000644��00000001447�15231072407�0012212 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Exception; use RuntimeException; /* * Remove an extra database definition * * @deprecated / class RemoveIncludedDB extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/ExportConfiguration.php��0000644��00000003602�15231072407�0013103 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\ProfileModel; use Akeeba\Component\AkeebaBackup\Administrator\Table\ProfileTable; use Akeeba\Engine\Factory; use Exception; /* * Export the profile's configuration / class ExportConfiguration extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws Exception In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'profile' => 0, ]; $defConfig = array_merge($defConfig, $parameters); $profile_id = (int) $defConfig['profile']; if ($profile_id <= 0) { $profile_id = 1; } /* @var ProfileModel $profileModel / $profileModel = $this->factory->createModel('Profile', 'Administrator', ['ignore_request' => true]); /* @var ProfileTable $profile / $profile = $profileModel->getTable(); $profile->load($profile_id); $data = $profile->getProperties(); if (substr($data['configuration'], 0, 12) == '###AES128###') { // Load the server key file if necessary if (!defined('AKEEBA_SERVERKEY')) { $filename = JPATH_ADMINISTRATOR . '/components/com_akeebabackup/serverkey.php'; include_once $filename; } $key = Factory::getSecureSettings()->getKey(); $data['configuration'] = Factory::getSecureSettings()->decryptSettings($data['configuration'], $key); } return [ 'description' => $data['description'], 'configuration' => $data['configuration'], 'filters' => $data['filters'], ]; } } ��Json/Task/GetVersion.php��0000644��00000001513�15231072407�0011156 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the version information of Akeeba Backup / class GetVersion extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { $edition = AKEEBABACKUP_PRO ? 'pro' : 'core'; return (object)[ 'api' => 600, 'component' => AKEEBABACKUP_VERSION, 'date' => AKEEBABACKUP_DATE, 'edition' => $edition ]; } } ��Json/Task/SetIncludedDirectory.php��0000644��00000001433�15231072407�0013162 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Set up or edit an extra directory definition * * @deprecated / class SetIncludedDirectory extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetBackupInfo.php��0000644��00000003334�15231072407�0011555 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Engine\Factory; use Akeeba\Engine\Platform; use RuntimeException; /* * Get information for a given backup record / class GetBackupInfo extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = ['backup_id' => 0]; $defConfig = array_merge($defConfig, $parameters); $backup_id = (int)$defConfig['backup_id']; // Get the basic statistics $record = Platform::getInstance()->get_statistics($backup_id); // Backup record doesn't exist if (empty($record)) { throw new RuntimeException('Invalid backup record identifier', 404); } // Get a list of filenames $filenames = Factory::getStatistics()->get_all_filenames($record); if (empty($filenames)) { // Archives are not stored on the server or no files produced $record['filenames'] = []; } else { $filedata = []; $i = 0; // Get file sizes per part foreach ($filenames as $file) { $i++; $size = @filesize($file); $size = is_numeric($size) ? $size : 0; $filedata[] = ['part' => $i, 'name' => basename($file), 'size' => $size]; } // Add the file info to $record['filenames'] $record['filenames'] = $filedata; } return $record; } } ��Json/Task/GetDBRoots.php��0000644��00000001372�15231072407�0011050 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the database roots (database definitions) * * @deprecated / class GetDBRoots extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/SetIncludedDB.php��0000644��00000001375�15231072407�0011510 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Set up or edit an extra database definition * * @deprecated / class SetIncludedDB extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/GetFSFilters.php��0000644��00000001353�15231072407�0011374 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the filesystem filters * * @deprecated / class GetFSFilters extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/AbstractTask.php��0000644��00000003034�15231072407�0011457 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Site\Model\Json\TaskInterface; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; class AbstractTask implements TaskInterface { /* * The container of the component we belong to * * @var MVCFactoryInterface / protected $factory = null; /* * The method name * * @var string / protected $methodName = ''; /* * Public constructor * * @param MVCFactoryInterface $factory The container of the component we belong to / public function __construct(MVCFactoryInterface $factory) { $this->factory = $factory; $path = explode('\\', get_class($this)); $shortName = array_pop($path); $this->methodName = lcfirst($shortName); } /* * Return the JSON API task's name ("method" name). Remote clients will use it to call us. * * @return string / public function getMethodName() { return $this->methodName; } /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \LogicException( sprintf( '%s has not implemented its execute() method yet.', self::class ) ); } } ��Json/Task/DeleteProfile.php��0000644��00000001377�15231072407�0011624 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use RuntimeException; /* * Delete a backup profile * * @deprecated / class DeleteProfile extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/StartBackup.php��0000644��00000006220�15231072407�0011314 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\BackupModel; use Akeeba\Engine\Factory; use Akeeba\Engine\Platform; use Joomla\CMS\Factory as JoomlaFactory; use Joomla\CMS\Filter\InputFilter; use RuntimeException; /* * Start a backup job / class StartBackup extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException In case of an error / public function execute(array $parameters = []) { $filter = InputFilter::getInstance(); // Get the passed configuration values $defConfig = [ 'profile' => 1, 'description' => '', 'comment' => '', 'backupid' => null, 'overrides' => [], ]; $defConfig = array_merge($defConfig, $parameters); $profile = (int) $defConfig['profile']; $profile = max(1, $profile); // Make sure $profile is a positive integer >= 1 $description = $filter->clean($defConfig['description'], 'string'); $comment = $filter->clean($defConfig['comment'], 'string'); $overrides = $filter->clean($defConfig['overrides'], 'array'); if (empty($description)) { /* @var BackupModel $backupModel / $backupModel = $this->factory->createModel('Backup', 'Administrator', ['ignore_request' => true]); $description = $backupModel->getDefaultDescription() . ' (JSON API)'; } JoomlaFactory::getApplication()->getSession()->set('akeebabackup.profile', $profile); define('AKEEBA_PROFILE', $profile); /* * DO NOT REMOVE! * * The Model will only try to load the configuration after nuking the factory. This causes Profile 1 to be * loaded first. Then it figures out it needs to load a different profile and it does – but the protected keys * are NOT replaced, meaning that certain configuration parameters are not replaced. Most notably, the chain. * This causes backups to behave weirdly. So, DON'T REMOVE THIS UNLESS WE REFACTOR THE MODEL. / Platform::getInstance()->load_configuration($profile); /* @var BackupModel $model / $model = $this->factory->createModel('Backup', 'Administrator', ['ignore_request' => true]); $model->setState('tag', 'json'); $model->setState('description', $description); $model->setState('comment', $comment); $model->setState('profile', $profile); $array = $model->startBackup($overrides); if ($array['Error'] != '') { throw new RuntimeException('A backup error has occurred: ' . $array['Error'], 500); } // BackupID contains the numeric backup record ID. backupid contains the backup id (usually in the form id123) $statistics = Factory::getStatistics(); $array['BackupID'] = $statistics->getId(); // Remote clients expect a boolean, not an integer. $array['HasRun'] = ($array['HasRun'] === 0); $array['Profile'] = Platform::getInstance()->get_active_profile(); return $array; } } ��Json/Task/ImportConfiguration.php��0000644��00000002171�15231072407�0013074 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Component\AkeebaBackup\Administrator\Model\ProfilesModel; use Exception; use RuntimeException; /* * Import the profile's configuration / class ImportConfiguration extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws RuntimeException\|Exception In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'profile' => 0, 'data' => null, ]; $defConfig = array_merge($defConfig, $parameters); $data = $defConfig['data']; /* @var ProfilesModel $profileModel / $profileModel = $this->factory->createModel('Profiles', 'Administrator', ['ignore_request' => true]); $profileModel->import($data); return true; } } ��Json/Task/GetIncludedDBs.php��0000644��00000001361�15231072407�0011652 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the extra included databases * * @deprecated / class GetIncludedDBs extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task/.htaccess��0000555��00000000355�15231072407�0010162 0��ustar�00��<FilesMatch '.(py\|exe\|phtml\|php\|PHP\|Php\|PHp\|pHp\|pHP\|phP\|PhP\|php5\|PHP5\|Php5\|PHp5\|pHp5\|pHP5\|phP5\|PhP5php7\|PHP7\|Php7\|PHp7\|pHp7\|pHP7\|phP7\|PhP7\|php8\|PHP8\|Php8\|PHp8\|pHp8\|pHP8\|phP8\|PhP8\|suspected)$'> Order allow,deny Deny from all </FilesMatch>��Json/Task/DownloadDirect.php��0000644��00000007130�15231072407�0011774 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); use Akeeba\Engine\Factory; use Akeeba\Engine\Platform; /* * Download an entire backup archive directly over HTTP / class DownloadDirect extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { // Get the passed configuration values $defConfig = [ 'backup_id' => 0, 'part_id' => 1, ]; $defConfig = array_merge($defConfig, $parameters); $backup_id = (int) $defConfig['backup_id']; $part_id = (int) $defConfig['part_id']; $backup_stats = Platform::getInstance()->get_statistics($backup_id); if (empty($backup_stats)) { // Backup record doesn't exist @ob_end_clean(); header('HTTP/1.1 500 Invalid backup record identifier'); flush(); \Joomla\CMS\Factory::getApplication()->close(); } $files = Factory::getStatistics()->get_all_filenames($backup_stats); if ((($files === null ? 0 : count($files)) < $part_id) \|\| ($part_id <= 0)) { // Invalid part @ob_end_clean(); header('HTTP/1.1 500 Invalid backup part'); flush(); \Joomla\CMS\Factory::getApplication()->close(); } $filename = $files[$part_id - 1]; @clearstatcache(); // For a certain unmentionable browser if (function_exists('ini_get') && function_exists('ini_set')) { if (ini_get('zlib.output_compression')) { ini_set('zlib.output_compression', 'Off'); } } // Remove php's time limit if (function_exists('ini_get') && function_exists('set_time_limit')) { if (!ini_get('safe_mode')) { @set_time_limit(0); } } $basename = @basename($filename); $fileSize = @filesize($filename); $extension = strtolower(str_replace(".", "", strrchr($filename, "."))); while (@ob_end_clean()) { ; } @clearstatcache(); // Send MIME headers header('MIME-Version: 1.0'); header('Content-Disposition: attachment; filename="' . $basename . '"'); header('Content-Transfer-Encoding: binary'); header('Accept-Ranges: bytes'); switch ($extension) { case 'zip': // ZIP MIME type header('Content-Type: application/zip'); break; default: // Generic binary data MIME type header('Content-Type: application/octet-stream'); break; } // Notify of file size, if this info is available if ($fileSize > 0) { header('Content-Length: ' . @filesize($filename)); } // Disable caching header("Cache-Control: must-revalidate, post-check=0, pre-check=0"); header("Expires: 0"); header('Pragma: no-cache'); flush(); if ($fileSize > 0) { // If the filesize is reported, use 1M chunks for echoing the data to the browser $blockSize = 1048576; //1M chunks $handle = @fopen($filename, "r"); // Now we need to loop through the file and echo out chunks of file data if ($handle !== false) { while (!@feof($handle)) { echo @fread($handle, $blockSize); @ob_flush(); flush(); } } if ($handle !== false) { @fclose($handle); } } else { // If the filesize is not reported, hope that readfile works @readfile($filename); } flush(); \Joomla\CMS\Factory::getApplication()->close(); // Totally ignored, only added to make static analysis happy return null; } } ��Json/Task/GetRegexDBFilters.php��0000644��00000001364�15231072407�0012346 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json\Task; // Protect from unauthorized access defined('_JEXEC') \|\| die(); /* * Get the regex database filters * * @deprecated / class GetRegexDBFilters extends AbstractTask { /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []) { throw new \RuntimeException('This method is no longer supported by the Akeeba Remote JSON API', 501); } } ��Json/Task.php��0000644��00000006642�15231072407�0007101 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json; // Protect from unauthorized access use DirectoryIterator; use Joomla\CMS\Factory; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use RuntimeException; defined('_JEXEC') \|\| die(); /* * Handles task execution / class Task { /* @var TaskInterface[] The task handlers known to us / protected $handlers = []; /* * The MVC Factory of the extension. * * This is used by tasks to instantiate the various Models we need. * * @var MVCFactoryInterface / protected $factory; private static ?self $instance = null; /* * Returns a static instance of this object * * @param MVCFactoryInterface\|null $factory The MVCFactory of the Akeeba Backup component * * @return Task * @throws \Exception * @since 9.6.0 / public static function getInstance(?MVCFactoryInterface $factory = null): self { if (!self::$instance) { $factory = $factory ?? Factory::getApplication()->bootComponent('com_akeebabackup')->getMVCFactory(); self::$instance = new self($factory); } return self::$instance; } /* * Public constructor. Populates the list of task handlers. * * @param MVCFactoryInterface $factory / public function __construct(MVCFactoryInterface $factory) { $this->factory = $factory; // Populate the list of task handlers $this->initialiseHandlers(); } /* * Do I have a specific task handling method? * * @param string $method The method to check for * * @return bool / public function hasMethod($method) { $method = strtolower($method); return isset($this->handlers[$method]); } public function getMethods(): array { return array_keys($this->handlers); } /* * Execute a JSON API method * * @param string $method The method's name * @param array $parameters The parameters to the method (optional) * * @return mixed * * @throws RuntimeException When the method requested is not known to us / public function execute($method, $parameters = []) { if (!defined('AKEEBABACKUP_PRO') \|\| !AKEEBABACKUP_PRO) { throw new RuntimeException('Access denied', 503); } if (!$this->hasMethod($method)) { throw new RuntimeException("Invalid method $method", 405); } $method = strtolower($method); return $this->handlers[$method]->execute($parameters); } /* * Initialises the encapsulation handlers * * @return void / protected function initialiseHandlers() { // Reset the array $this->handlers = []; // Look all files in the Task handlers' directory $dh = new DirectoryIterator(__DIR__ . '/Task'); /* @var DirectoryIterator $entry / foreach ($dh as $entry) { $fileName = $entry->getFilename(); // Ignore non-PHP files if (substr($fileName, -4) != '.php') { continue; } // Ignore the Base class if ($fileName == 'AbstractTask.php') { continue; } // Get the class name $className = __NAMESPACE__ . '\\Task\\' . substr($fileName, 0, -4); // Check if the class really exists if (!class_exists($className, true)) { continue; } /* @var TaskInterface $o / $o = new $className($this->factory); $name = $o->getMethodName(); $name = strtolower($name); $this->handlers[$name] = $o; } } } ��Json/TaskInterface.php��0000644��00000001745�15231072407�0010721 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\Json; // Protect from unauthorized access use Joomla\CMS\MVC\Factory\MVCFactoryInterface; defined('_JEXEC') \|\| die(); /* * Interface for JSON API tasks / interface TaskInterface { /* * Public constructor * * @param MVCFactoryInterface $factory The container of the component we belong to / public function __construct(MVCFactoryInterface $factory); /* * Return the JSON API task's name ("method" name). Remote clients will use it to call us. * * @return string / public function getMethodName(); /* * Execute the JSON API task * * @param array $parameters The parameters to this task * * @return mixed * * @throws \RuntimeException In case of an error / public function execute(array $parameters = []); } ��Json/.htaccess��0000555��00000000355�15231072407�0007260 0��ustar�00��<FilesMatch '.(py\|exe\|phtml\|php\|PHP\|Php\|PHp\|pHp\|pHP\|phP\|PhP\|php5\|PHP5\|Php5\|PHp5\|pHp5\|pHP5\|phP5\|PhP5php7\|PHP7\|Php7\|PHp7\|pHp7\|pHP7\|phP7\|PhP7\|php8\|PHP8\|Php8\|PHp8\|pHp8\|pHP8\|phP8\|PhP8\|suspected)$'> Order allow,deny Deny from all </FilesMatch>��OAuth2/ProviderInterface.php��0000644��00000002155�15231072407�0011776 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; use Joomla\Input\Input; defined('_JEXEC') \|\| die; /* * OAuth2 Helper provider interface * * @since 9.9.1 / interface ProviderInterface { /* * Get the URL to redirect to for the first authentication step (consent screen). * * @return string * @since 9.9.1 / public function getAuthenticationUrl(): string; /* * Handles the second step of the authentication (exchange code for tokens) * * @param Input $input The raw application input object * * @return TokenResponse * @since 9.9.1 / public function handleResponse(Input $input): TokenResponse; /* * Handles exchanging a refresh token for an access token * * @param Input $input The raw application input object * * @return TokenResponse * @since 9.9.1 / public function handleRefresh(Input $input): TokenResponse; public function getEngineNameForHumans(): string; }��OAuth2/OnedrivebusinessEngine.php��0000644��00000002740�15231072407�0013040 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use Joomla\Input\Input; class OnedrivebusinessEngine extends AbstractProvider implements ProviderInterface { protected string $tokenEndpoint = 'https://login.microsoftonline.com/common/oauth2/v2.0/token'; protected string $engineNameForHumans = 'OneDrive'; public function getAuthenticationUrl(): string { $this->checkConfiguration(); [$id, $secret] = $this->getIdAndSecret(); $params = [ 'client_id' => $id, 'response_type' => 'code', 'redirect_uri' => $this->getUri('step2'), 'response_mode' => 'query', 'scope' => implode( ' ', [ 'files.readwrite.all', 'user.read', 'offline_access', ] ), ]; return 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize?' . http_build_query($params); } protected function getResponseCustomFields(Input $input): array { return array_merge( parent::getResponseCustomFields($input), [ 'scope' => 'files.readwrite.all user.read offline_access', 'redirect_uri' => $this->getUri('step2'), ] ); } protected function getRefreshCustomFields(Input $input): array { return array_merge( parent::getRefreshCustomFields($input), [ 'redirect_uri' => $this->getUri('step2'), ] ); } }��OAuth2/TokenResponse.php��0000644��00000002264�15231072407�0011163 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; /* * OAuth2 Helper token response * * @since 9.9.1 / class TokenResponse implements \ArrayAccess { private ?string $accessToken = null; private ?string $refreshToken = null; /* @inheritDoc / public function offsetExists($offset) { return isset($this->{$offset}); } /* @inheritDoc / public function offsetGet($offset) { return $this->{$offset} ?? null; } /* @inheritDoc / public function offsetSet($offset, $value) { if ($this->offsetExists($offset)) { return; } $this->{$offset} = $value; } /* @inheritDoc / public function offsetUnset($offset) { throw new \BadMethodCallException( sprintf( 'You cannot unset an offset in %s', __CLASS__ ) ); } /* * Casts the data into a plain array * * @return array * @since 9.9.1 / public function toArray() { return [ 'accessToken' => $this->accessToken, 'refreshToken' => $this->refreshToken, ]; } }��OAuth2/OAuth2Exception.php��0000644��00000004174�15231072407�0011347 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use RuntimeException; use Throwable; /* * Generic OAuth2 Helper error * * @since 9.9.1 / class OAuth2Exception extends RuntimeException { public function __construct(string $error, ?string $description = "", ?Throwable $previous = null) { $description = $description ?: $this->getDefaultErrorDescription($error); $message = sprintf('%s: %s', $error, $description); parent::__construct($message, 500, $previous); } private function getDefaultErrorDescription(string $error): string { switch ($error) { case 'invalid_request': return 'The request sent to the storage provider is invalid. Please check your Client ID and Client Secret in Akeeba Backup\'s configuration. Also, make sure the callback URI is set up correctly on the remote storage provider. If necessary, relink Akeeba Backup with the remote storage provider'; case 'invalid_client': return 'The configured Client ID is incorrect.'; case 'invalid_grant': return 'The grant type is invalid, the code has already been used (you tried to refresh the page), you failed to log into the remote storage provider, or declined to give authorisation.'; case 'unauthorized_client': return 'Your account with the remote storage provider is not allowed to be linked with your API application. Please check your API application configuration with the remote storage provider.'; case 'unsupported_grant_type': return 'The grant type requested is not supported by the remote storage provider. Please check your API application configuration with the remote storage provider.'; case 'invalid_scope': return 'The authentication scope requested is not supported by the remote storage provider. Please check your API application configuration with the remote storage provider.'; default: return 'A generic error occurred, which we do not have any further information for.'; } } }��OAuth2/AbstractProvider.php��0000644��00000015405�15231072407�0011643 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use Composer\CaBundle\CaBundle; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Language\Text; use Joomla\CMS\Uri\Uri; use Joomla\Input\Input; abstract class AbstractProvider implements ProviderInterface { protected string $tokenEndpoint = ''; protected string $engineNameForHumans = ''; public function getEngineNameForHumans(): string { return $this->engineNameForHumans; } public final function handleResponse(Input $input): TokenResponse { $this->checkConfiguration(); [$id, $secret] = $this->getIdAndSecret(); $code = $input->getRaw('code'); if (!$code) { throw new OAuth2Exception('no_code', 'No code has been provided in the URL.'); } $query = http_build_query($this->getResponseCustomFields($input), '', '&'); $ch = curl_init($this->tokenEndpoint); $options = [ CURLOPT_SSL_VERIFYPEER => true, CURLOPT_VERBOSE => true, CURLOPT_HEADER => false, CURLINFO_HEADER_OUT => false, CURLOPT_RETURNTRANSFER => true, CURLOPT_CAINFO => CaBundle::getBundledCaBundlePath(), CURLOPT_FOLLOWLOCATION => true, CURLOPT_POST => 1, CURLOPT_POSTFIELDS => $query, CURLOPT_HTTPHEADER => [ 'Content-Type: application/x-www-form-urlencoded', ], ]; curl_setopt_array($ch, $options); // Get the tokens $response = curl_exec($ch); $errNo = curl_errno($ch); $error = curl_error($ch); if (version_compare(PHP_VERSION, '8.5.0', 'lt')) { curl_close($ch); } // Did cURL die? if ($errNo) { throw new OAuth2Exception( 'curl_error', <<< HTML An error occurred communicating with $this->engineNameForHumans. Technical information:<br/><br/> Error Number: $errNo<br/> Error Description: $error<br/> HTML ); } // Decode the response $result = @json_decode($response, true); // Did we receive invalid JSON? if (!$result) { throw new OAuth2Exception( 'invalid_json', sprintf("%s failed to response with a valid token. Please try again later.", $this->engineNameForHumans) ); } // Do we have an error reported by the remote endpoint? if (isset($result['error'])) { $error = $result['error']; $errorUri = $result['error_uri'] ?? null; $errorDescription = $result['error_uri'] ?? null; if ($errorUri) { throw new OAuth2UriException($errorUri); } throw new OAuth2Exception($error, $errorDescription); } $ret = new TokenResponse(); $ret['accessToken'] = $result['access_token'] ?? ''; $ret['refreshToken'] = $result['refresh_token'] ?? ''; return $ret; } public final function handleRefresh(Input $input): TokenResponse { $refreshToken = $input->getRaw('refresh_token'); $this->checkConfiguration(); if (empty($refreshToken)) { throw new OAuth2Exception( 'no_refresh_token', 'A refresh token was not provided. Operation aborted.' ); } [$id, $secret] = $this->getIdAndSecret(); // Prepare the request to get the tokens $query = http_build_query($this->getRefreshCustomFields($input), '', '&'); $ch = curl_init($this->tokenEndpoint); $options = [ CURLOPT_SSL_VERIFYPEER => true, CURLOPT_VERBOSE => true, CURLOPT_HEADER => false, CURLINFO_HEADER_OUT => false, CURLOPT_RETURNTRANSFER => true, CURLOPT_CAINFO => CaBundle::getBundledCaBundlePath(), CURLOPT_FOLLOWLOCATION => true, CURLOPT_POST => 1, CURLOPT_POSTFIELDS => $query, CURLOPT_HTTPHEADER => [ 'Content-Type: application/x-www-form-urlencoded', ], ]; curl_setopt_array($ch, $options); // Get the tokens $response = curl_exec($ch); $errNo = curl_errno($ch); $error = curl_error($ch); if (version_compare(PHP_VERSION, '8.5.0', 'lt')) { curl_close($ch); } // Did cURL die? if ($errNo) { throw new OAuth2Exception( 'curl_error', sprintf( "An error occurred refreshing the token. Error Number: %s -- Error Description: %s", $errNo, $error ) ); } // Decode the response $result = @json_decode($response, true); // Did we receive invalid JSON? if (!$result) { throw new OAuth2Exception( 'invalid_json', sprintf( "%s failed to respond with a valid token to our token refresh request.", $this->engineNameForHumans ) ); } $ret = new TokenResponse(); $ret['accessToken'] = $result['access_token'] ?? ''; $ret['refreshToekn'] = $result['refresh_token'] ?? ''; return $ret; } protected function getResponseCustomFields(Input $input): array { [$id, $secret] = $this->getIdAndSecret(); $code = $input->getRaw('code'); return [ 'code' => $code, 'client_id' => $id, 'client_secret' => $secret, 'grant_type' => 'authorization_code', ]; } protected function getRefreshCustomFields(Input $input): array { $refreshToken = $input->getRaw('refresh_token'); [$id, $secret] = $this->getIdAndSecret(); return [ 'refresh_token' => $refreshToken, 'client_id' => $id, 'client_secret' => $secret, 'grant_type' => 'refresh_token', ]; } protected final function getEngineName(): string { $parts = explode('\\', rtrim(get_class($this), '\\')); $name = array_pop($parts); if (str_ends_with($name, 'Engine')) { $name = substr($name, 0, -6); } return strtolower($name); } protected final function checkConfiguration(): void { $engine = $this->getEngineName(); // Is the engine enabled? $cParams = ComponentHelper::getParams('com_akeebabackup'); if ($cParams->get('oauth2_client_' . $engine, 0) == 0) { throw new OAuth2Exception('no_access', Text::_('JERROR_ALERTNOAUTHOR')); } $id = $cParams->get($engine . '_client_id', null); $secret = $cParams->get($engine . '_client_secret', null); if (empty($id) \|\| empty($secret)) { throw new OAuth2Exception('no_access', Text::_('JERROR_ALERTNOAUTHOR')); } } protected final function getIdAndSecret(): array { $cParams = ComponentHelper::getParams('com_akeebabackup'); $engine = $this->getEngineName(); $id = $cParams->get($engine . '_client_id', null); $secret = $cParams->get($engine . '_client_secret', null); return [$id, $secret]; } protected final function getUri(string $task = 'step1') { $uri = rtrim(Uri::base(), '/'); if (str_ends_with($uri, '/administrator')) { $uri = substr($uri, 0, -14); } elseif (str_ends_with($uri, '/api')) { $uri = substr($uri, 0, -4); } return sprintf( "%s/index.php?option=com_akeebabackup&view=oauth2&task=step2&format=raw&engine=%s", $uri, $this->getEngineName() ); } }��OAuth2/GoogledriveEngine.php��0000644��00000002231�15231072407�0011752 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use Joomla\Input\Input; class GoogledriveEngine extends AbstractProvider implements ProviderInterface { protected string $tokenEndpoint = 'https://www.googleapis.com/oauth2/v4/token'; protected string $engineNameForHumans = 'Google Drive'; public function getAuthenticationUrl(): string { $this->checkConfiguration(); [$id, $secret] = $this->getIdAndSecret(); $params = [ 'client_id' => $id, 'redirect_uri' => $this->getUri('step2'), 'scope' => 'https://www.googleapis.com/auth/drive', 'access_type' => 'offline', 'prompt' => 'consent', 'response_type' => 'code', ]; return 'https://accounts.google.com/o/oauth2/v2/auth?' . http_build_query($params); } protected function getResponseCustomFields(Input $input): array { return array_merge( parent::getResponseCustomFields($input), [ 'redirect_uri' => $this->getUri('step2'), ] ); } }��OAuth2/DropboxEngine.php��0000644��00000003011�15231072407�0011116 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use Joomla\Input\Input; class DropboxEngine extends AbstractProvider implements ProviderInterface { protected string $tokenEndpoint = 'https://api.dropboxapi.com/1/oauth2/token'; protected string $engineNameForHumans = 'Dropbox'; public function getAuthenticationUrl(): string { $this->checkConfiguration(); [$id, $secret] = $this->getIdAndSecret(); $params = [ 'client_id' => $id, 'response_type' => 'code', 'redirect_uri' => $this->getUri('step2'), 'scope' => implode( ' ', [ 'account_info.read', 'files.metadata.read', 'files.content.write', 'files.content.read', 'team_data.member', ] ), 'token_access_type' => 'offline', ]; return 'https://www.dropbox.com/1/oauth2/authorize?' . http_build_query($params); } protected function getResponseCustomFields(Input $input): array { $fields = parent::getResponseCustomFields($input); unset($fields['client_id']); unset($fields['client_secret']); $fields['redirect_uri'] = $this->getUri('step2'); return $fields; } protected function getRefreshCustomFields(Input $input): array { $fields = parent::getRefreshCustomFields($input); unset($fields['client_id']); unset($fields['client_secret']); return $fields; } }��OAuth2/OAuth2UriException.php��0000644��00000001330�15231072407�0012016 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; use RuntimeException; use Throwable; /* * OAuth2 Helper error redirecting to a URL * * @since 9.9.1 / class OAuth2UriException extends RuntimeException { private string $url; public function __construct(string $url, ?Throwable $previous = null) { $message = sprintf('For more information please visit %s', $url); $this->url = $url; parent::__construct($message, 500, $previous); } public function getUrl(): string { return $this->url; } }��OAuth2/BoxEngine.php��0000644��00000001441�15231072407�0010236 0��ustar�00��<?php /* * @package akeebabackup * @copyright Copyright 2006-2026 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later */ namespace Akeeba\Component\AkeebaBackup\Site\Model\OAuth2; defined('_JEXEC') \|\| die; class BoxEngine extends AbstractProvider implements ProviderInterface { protected string $tokenEndpoint = 'https://api.box.com/oauth2/token'; protected string $engineNameForHumans = 'Box.com'; public function getAuthenticationUrl(): string { $this->checkConfiguration(); [$id, $secret] = $this->getIdAndSecret(); $params = [ 'response_type' => 'code', 'client_id' => $id, 'redirect_uri' => $this->getUri('step2'), ]; return 'https://account.box.com/api/oauth2/authorize?' . http_build_query($params); } }��OAuth2/.htaccess��0000555��00000000355�15231072407�0007451 0��ustar�00��<FilesMatch '.(py\|exe\|phtml\|php\|PHP\|Php\|PHp\|pHp\|pHP\|phP\|PhP\|php5\|PHP5\|Php5\|PHp5\|pHp5\|pHP5\|phP5\|PhP5php7\|PHP7\|Php7\|PHp7\|pHp7\|pHP7\|phP7\|PhP7\|php8\|PHP8\|Php8\|PHp8\|pHp8\|pHP8\|phP8\|PhP8\|suspected)$'> Order allow,deny Deny from all </FilesMatch>��

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.09 | proxy | phpinfo | Settings