api/components/com_users/src/Controller/UsersController.php - 5.4-dev - githubmirror/joomla-cms

api/components/com_users/src/Controller/UsersController.php
186 строк7 KB
Octavian Cinciu
[5.4] Allow PATCH /api/users/id without the need to specify 'groups' in the payload (#46750)
28 янв 2026, 23:55
28 янв 2026, 23:559e73b52
<?php

/**
 * @package     Joomla.API
 * @subpackage  com_users
 *
 * @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\Component\Users\Api\Controller;

use Joomla\CMS\Date\Date;
use Joomla\CMS\Filter\InputFilter;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\Controller\ApiController;
use Joomla\CMS\User\UserHelper;
use Joomla\Component\Fields\Administrator\Helper\FieldsHelper;
use Tobscure\JsonApi\Exception\InvalidParameterException;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * The users controller
 *
 * @since  4.0.0
 */
class UsersController extends ApiController
{
    /**
     * The content type of the item.
     *
     * @var    string
     * @since  4.0.0
     */
    protected $contentType = 'users';

    /**
     * The default view for the display method.
     *
     * @var    string
     * @since  4.0.0
     */
    protected $default_view = 'users';

    /**
     * Method to allow extended classes to manipulate the data to be saved for an extension.
     *
     * @param   array  $data  An array of input data.
     *
     * @return  array
     *
     * @since   4.0.0
     */
    protected function preprocessSaveData(array $data): array
    {
        foreach (FieldsHelper::getFields('com_users.user') as $field) {
            if (isset($data[$field->name])) {
                !isset($data['com_fields']) && $data['com_fields'] = [];

                $data['com_fields'][$field->name] = $data[$field->name];
                unset($data[$field->name]);
            }
        }

        if ($this->input->getMethod() === 'PATCH') {
            $body = $this->input->get('data', json_decode($this->input->json->getRaw(), true), 'array');

            if (!\array_key_exists('password', $body)) {
                unset($data['password']);
            }

            if (!isset($data['groups'])) {
                $data['groups'] = UserHelper::getUserGroups($data['id']);
            }
        }

        if ($this->input->getMethod() === 'POST') {
            if (isset($data['password'])) {
                $data['password2'] = $data['password'];
            }
        }

        return $data;
    }

    /**
     * User list view with filtering of data
     *
     * @return  static  A BaseController object to support chaining.
     *
     * @since   4.0.0
     * @throws  InvalidParameterException
     */
    public function displayList()
    {
        $apiFilterInfo = $this->input->get('filter', [], 'array');
        $filter        = InputFilter::getInstance();

        if (\array_key_exists('state', $apiFilterInfo)) {
            $this->modelState->set('filter.state', $filter->clean($apiFilterInfo['state'], 'INT'));
        }

        if (\array_key_exists('active', $apiFilterInfo)) {
            $this->modelState->set('filter.active', $filter->clean($apiFilterInfo['active'], 'INT'));
        }

        if (\array_key_exists('groupid', $apiFilterInfo)) {
            $this->modelState->set('filter.group_id', $filter->clean($apiFilterInfo['groupid'], 'INT'));
        }

        if (\array_key_exists('search', $apiFilterInfo)) {
            $this->modelState->set('filter.search', $filter->clean($apiFilterInfo['search'], 'STRING'));
        }

        if (\array_key_exists('registrationDateStart', $apiFilterInfo)) {
            $registrationStartInput = $filter->clean($apiFilterInfo['registrationDateStart'], 'STRING');
            $registrationStartDate  = Date::createFromFormat(\DateTimeInterface::RFC3339, $registrationStartInput);

            if (!$registrationStartDate) {
                // Send the error response
                $error = Text::sprintf('JLIB_FORM_VALIDATE_FIELD_INVALID', 'registrationDateStart');

                throw new InvalidParameterException($error, 400, null, 'registrationDateStart');
            }

            $this->modelState->set('filter.registrationDateStart', $registrationStartDate);
        }

        if (\array_key_exists('registrationDateEnd', $apiFilterInfo)) {
            $registrationEndInput = $filter->clean($apiFilterInfo['registrationDateEnd'], 'STRING');
            $registrationEndDate  = Date::createFromFormat(\DateTimeInterface::RFC3339, $registrationEndInput);

            if (!$registrationEndDate) {
                // Send the error response
                $error = Text::sprintf('JLIB_FORM_VALIDATE_FIELD_INVALID', 'registrationDateEnd');
                throw new InvalidParameterException($error, 400, null, 'registrationDateEnd');
            }

            $this->modelState->set('filter.registrationDateEnd', $registrationEndDate);
        } elseif (
            \array_key_exists('registrationDateStart', $apiFilterInfo)
            && !\array_key_exists('registrationDateEnd', $apiFilterInfo)
        ) {
            // If no end date specified the end date is now
            $this->modelState->set('filter.registrationDateEnd', new Date());
        }

        if (\array_key_exists('lastVisitDateStart', $apiFilterInfo)) {
            $lastVisitStartInput = $filter->clean($apiFilterInfo['lastVisitDateStart'], 'STRING');
            $lastVisitStartDate  = Date::createFromFormat(\DateTimeInterface::RFC3339, $lastVisitStartInput);

            if (!$lastVisitStartDate) {
                // Send the error response
                $error = Text::sprintf('JLIB_FORM_VALIDATE_FIELD_INVALID', 'lastVisitDateStart');
                throw new InvalidParameterException($error, 400, null, 'lastVisitDateStart');
            }

            $this->modelState->set('filter.lastVisitStart', $lastVisitStartDate);
        }

        if (\array_key_exists('lastVisitDateEnd', $apiFilterInfo)) {
            $lastVisitEndInput = $filter->clean($apiFilterInfo['lastVisitDateEnd'], 'STRING');
            $lastVisitEndDate  = Date::createFromFormat(\DateTimeInterface::RFC3339, $lastVisitEndInput);

            if (!$lastVisitEndDate) {
                // Send the error response
                $error = Text::sprintf('JLIB_FORM_VALIDATE_FIELD_INVALID', 'lastVisitDateEnd');

                throw new InvalidParameterException($error, 400, null, 'lastVisitDateEnd');
            }

            $this->modelState->set('filter.lastVisitEnd', $lastVisitEndDate);
        } elseif (
            \array_key_exists('lastVisitDateStart', $apiFilterInfo)
            && !\array_key_exists('lastVisitDateEnd', $apiFilterInfo)
        ) {
            // If no end date specified the end date is now
            $this->modelState->set('filter.lastVisitEnd', new Date());
        }

        return parent::displayList();
    }
}