<?php

/**
 * ======================================================================
 * LICENSE: This file is subject to the terms and conditions defined in *
 * file 'license.txt', which is part of this source code package.       *
 * ======================================================================
 */

/**
 * AAM service Access Denied Redirect manager
 *
 * @package AAM
 * @version 7.0.0
 */
class AAM_Framework_Service_AccessDeniedRedirect
implements
    AAM_Framework_Service_Interface
{

    use AAM_Framework_Service_BaseTrait;

    /**
     * List of allowed rule types
     *
     * @version 7.0.0
     */
    const ALLOWED_REDIRECT_TYPES = [
        'default',
        'custom_message',
        'page_redirect',
        'url_redirect',
        'trigger_callback',
        'login_redirect'
    ];

    /**
     * Frontend, backend, and API access areas
     *
     * @version 7.0.0
     */
    const ALLOWED_AREAS = [
        'frontend',
        'backend',
        'api'
    ];

    /**
     * Get the access denied redirect
     *
     * @param string $area [Optional]
     *
     * @return array
     * @access public
     *
     * @version 7.0.0
     */
    public function get_redirect($area = null)
    {
        try {
            $preferences = array_intersect_key(
                $this->_get_container()->get_preferences(),
                array_flip(self::ALLOWED_AREAS)
            );

            if (empty($area)) {
                $result = array_replace(
                    [
                        'frontend' => [ 'type' => 'default' ],
                        'backend'  => [ 'type' => 'default' ],
                        'api'      => [ 'type' => 'default' ]
                    ],
                    $preferences
                );
            } elseif (!empty($preferences[$area])) {
                $result = $preferences[$area];
            } else {
                $result = [ 'type' => 'default' ];
            }
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

        return $result;
    }

    /**
     * Set the access denied redirect
     *
     * Note! This method does not validate incoming redirect model. Valid incoming
     * data:
     *
     * {
     *    "type": "string",
     *    "page_slug": "string",
     *    "page_id": "numeric",
     *    "url": "string",
     *    "callback": "string",
     *    "message": "string",
     *    "http_status_code": "numeric"
     * }
     *
     * @param string $area     Frontend, backend, or API
     * @param array  $redirect Redirect settings
     *
     * @return array
     * @access public
     *
     * @version 7.0.0
     */
    public function set_redirect($area, array $redirect)
    {
        try {
            if (!in_array($area, self::ALLOWED_AREAS, true)) {
                throw new InvalidArgumentException('Choose a supported access area');
            }

            if ($area === 'api'
                && !in_array($redirect['type'] ?? null, [
                    'default', 'custom_message', 'trigger_callback'
                ], true)) {
                throw new InvalidArgumentException(
                    'API denial responses support default, custom message, or PHP callback behavior'
                );
            }

            // Sanitize the incoming redirect data
            $sanitized = $this->redirect->sanitize_redirect(
                $redirect,
                self::ALLOWED_REDIRECT_TYPES
            );

            $result = $this->_get_container()->set_preferences($sanitized, $area);
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

        return $result;
    }

    /**
     * Reset the redirect rule
     *
     * @param string $area
     *
     * @return bool
     * @access public
     *
     * @version 7.0.5
     */
    public function reset($area = null)
    {
        try {
            $result    = true;
            $container = $this->_get_container();

            if (empty($area)) {
                $result = $container->reset();
            } else {
                $preferences = $container->get_preferences();

                if (isset($preferences[$area])) {
                    unset($preferences[$area]);

                    $container->set_preferences($preferences);
                }
            }
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

        return $result;
    }

    /**
     * Check if access denied redirect preferences are customized
     *
     * @return bool
     * @access public
     *
     * @version 7.0.0
     */
    public function is_customized()
    {
        try {
            $result = $this->_get_container()->is_customized();
        } catch (Exception $e) {
            $result = $this->_handle_error($e);
        }

        return $result;
    }

    /**
     * Get access denied preference container
     *
     * @return AAM_Framework_Preference_AccessDeniedRedirect
     * @access private
     *
     * @version 7.0.0
     */
    private function _get_container()
    {
        return $this->_get_access_level()->get_preference(
            AAM_Framework_Type_Preference::ACCESS_DENIED_REDIRECT
        );
    }

}