<?php

/**

 * Customize API: WP_Customize_Nav_Menu_Setting class

 *

 * @package WordPress

 * @subpackage Customize

 * @since 4.4.0

 */

/**

 * Customize Setting to represent a nav_menu.

 *

 * Subclass of WP_Customize_Setting to represent a nav_menu taxonomy term, and

 * the IDs for the nav_menu_items associated with the nav menu.

 *

 * @since 4.3.0

 *

 * @see wp_get_nav_menu_object()

 * @see WP_Customize_Setting

 */

class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {

	const ID_PATTERN = '/^nav_menu\[(?P<id>-?\d+)\]$/';

	const TAXONOMY = 'nav_menu';

	const TYPE = 'nav_menu';

	/**

	 * Setting type.

	 *

	 * @since 4.3.0

	 * @var string

	 */

	public $type = self::TYPE;

	/**

	 * Default setting value.

	 *

	 * @since 4.3.0

	 * @var array

	 *

	 * @see wp_get_nav_menu_object()

	 */

	public $default = array(

		'name'        => '',

		'description' => '',

		'parent'      => 0,

		'auto_add'    => false,

	);

	/**

	 * Default transport.

	 *

	 * @since 4.3.0

	 * @var string

	 */

	public $transport = 'postMessage';

	/**

	 * The term ID represented by this setting instance.

	 *

	 * A negative value represents a placeholder ID for a new menu not yet saved.

	 *

	 * @since 4.3.0

	 * @var int

	 */

	public $term_id;

	/**

	 * Previous (placeholder) term ID used before creating a new menu.

	 *

	 * This value will be exported to JS via the {@see 'customize_save_response'} filter

	 * so that JavaScript can update the settings to refer to the newly-assigned

	 * term ID. This value is always negative to indicate it does not refer to

	 * a real term.

	 *

	 * @since 4.3.0

	 * @var int

	 *

	 * @see WP_Customize_Nav_Menu_Setting::update()

	 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()

	 */

	public $previous_term_id;

	/**

	 * Whether or not update() was called.

	 *

	 * @since 4.3.0

	 * @var bool

	 */

	protected $is_updated = false;

	/**

	 * Status for calling the update method, used in customize_save_response filter.

	 *

	 * See {@see 'customize_save_response'}.

	 *

	 * When status is inserted, the placeholder term ID is stored in `$previous_term_id`.

	 * When status is error, the error is stored in `$update_error`.

	 *

	 * @since 4.3.0

	 * @var string updated|inserted|deleted|error

	 *

	 * @see WP_Customize_Nav_Menu_Setting::update()

	 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()

	 */

	public $update_status;

	/**

	 * Any error object returned by wp_update_nav_menu_object() when setting is updated.

	 *

	 * @since 4.3.0

	 * @var WP_Error

	 *

	 * @see WP_Customize_Nav_Menu_Setting::update()

	 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()

	 */

	public $update_error;

	/**

	 * Constructor.

	 *

	 * Any supplied $args override class property defaults.

	 *

	 * @since 4.3.0

	 *

	 * @param array                $args    Optional. Setting arguments.

	 */

	public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {

		if ( empty( $manager->nav_menus ) ) {

			throw new Exception( 'Expected WP_Customize_Manager::$nav_menus to be set.' );

		}

		if ( ! preg_match( self::ID_PATTERN, $id, $matches ) ) {

			throw new Exception( "Illegal widget setting ID: $id" );

		}

		$this->term_id = intval( $matches['id'] );

		parent::__construct( $manager, $id, $args );

	}

	/**

	 * Get the instance data for a given widget setting.

	 *

	 * @since 4.3.0

	 *

	 * @see wp_get_nav_menu_object()

	 *

	 * @return array Instance data.

	 */

	public function value() {

			$undefined  = new stdClass(); // Symbol.

			$post_value = $this->post_value( $undefined );

			if ( $undefined === $post_value ) {

				$value = $this->_original_value;

			} else {

				$value = $post_value;

			}

		} else {

			$value = false;

			// Note that a term_id of less than one indicates a nav_menu not yet inserted.

			if ( $this->term_id > 0 ) {

				$term = wp_get_nav_menu_object( $this->term_id );

				if ( $term ) {

					$value = wp_array_slice_assoc( (array) $term, array_keys( $this->default ) );

					$nav_menu_options  = (array) get_option( 'nav_menu_options', array() );

					$value['auto_add'] = false;

					if ( isset( $nav_menu_options['auto_add'] ) && is_array( $nav_menu_options['auto_add'] ) ) {

					}

				}

			}

			if ( ! is_array( $value ) ) {

				$value = $this->default;

			}

		}

		return $value;

	}

	/**

	 * Handle previewing the setting.

	 *

	 * @since 4.3.0

	 * @since 4.4.0 Added boolean return value

	 *

	 * @see WP_Customize_Manager::post_value()

	 *

	 * @return bool False if method short-circuited due to no-op.

	 */

	public function preview() {

		if ( $this->is_previewed ) {

			return false;

		}

		$undefined      = new stdClass();

		$is_placeholder = ( $this->term_id < 0 );

		$is_dirty       = ( $undefined !== $this->post_value( $undefined ) );

		if ( ! $is_placeholder && ! $is_dirty ) {

			return false;

		}

		$this->is_previewed       = true;

		$this->_original_value    = $this->value();

		$this->_previewed_blog_id = get_current_blog_id();

		add_filter( 'wp_get_nav_menus', array( $this, 'filter_wp_get_nav_menus' ), 10, 2 );

		add_filter( 'wp_get_nav_menu_object', array( $this, 'filter_wp_get_nav_menu_object' ), 10, 2 );

		add_filter( 'default_option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );

		add_filter( 'option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );

		return true;

	}

	/**

	 * Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.

	 *

	 * @since 4.3.0

	 *

	 * @see wp_get_nav_menus()

	 *

	 * @param WP_Term[] $menus An array of menu objects.

	 * @param array     $args  An array of arguments used to retrieve menu objects.

	 * @return WP_Term[] Array of menu objects.

	 */

	public function filter_wp_get_nav_menus( $menus, $args ) {

		if ( get_current_blog_id() !== $this->_previewed_blog_id ) {

			return $menus;

		}

		$setting_value = $this->value();

		$is_delete     = ( false === $setting_value );

		$index         = -1;

		// Find the existing menu item's position in the list.

		foreach ( $menus as $i => $menu ) {

			if ( (int) $this->term_id === (int) $menu->term_id || (int) $this->previous_term_id === (int) $menu->term_id ) {

				$index = $i;

				break;

			}

		}

		if ( $is_delete ) {

			// Handle deleted menu by removing it from the list.

			if ( -1 !== $index ) {

				array_splice( $menus, $index, 1 );

			}

		} else {

			// Handle menus being updated or inserted.

			$menu_obj = (object) array_merge(

				array(

					'term_id'          => $this->term_id,

					'term_taxonomy_id' => $this->term_id,

					'slug'             => sanitize_title( $setting_value['name'] ),

					'count'            => 0,

					'term_group'       => 0,

					'taxonomy'         => self::TAXONOMY,

					'filter'           => 'raw',

				),

				$setting_value

			);

			array_splice( $menus, $index, ( -1 === $index ? 0 : 1 ), array( $menu_obj ) );

		}

		// Make sure the menu objects get re-sorted after an update/insert.

		if ( ! $is_delete && ! empty( $args['orderby'] ) ) {

			$menus = wp_list_sort(

				$menus,

				array(

					$args['orderby'] => 'ASC',

				)

			);

		}

		return $menus;

	}

	/**

	 * Temporary non-closure passing of orderby value to function.

	 *

	 * @since 4.3.0

	 * @var string

	 *

	 * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()

	 * @see WP_Customize_Nav_Menu_Setting::_sort_menus_by_orderby()

	 */

	protected $_current_menus_sort_orderby;

	/**

	 * Sort menu objects by the class-supplied orderby property.

	 *

	 * This is a workaround for a lack of closures.

	 *

	 * @since 4.3.0

	 * @deprecated 4.7.0 Use wp_list_sort()

	 *

	 * @param object $menu1

	 * @param object $menu2

	 * @return int

	 *

	 * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()

	 */

	protected function _sort_menus_by_orderby( $menu1, $menu2 ) {

		_deprecated_function( __METHOD__, '4.7.0', 'wp_list_sort' );

		$key = $this->_current_menus_sort_orderby;

		return strcmp( $menu1->$key, $menu2->$key );

	}

	/**

	 * Filters the wp_get_nav_menu_object() result to supply the previewed menu object.

	 *

	 * Requesting a nav_menu object by anything but ID is not supported.

	 *

	 * @since 4.3.0

	 *

	 * @see wp_get_nav_menu_object()

	 *

	 * @param object|null $menu_obj Object returned by wp_get_nav_menu_object().

	 * @param string      $menu_id  ID of the nav_menu term. Requests by slug or name will be ignored.

	 * @return object|null

	 */

	public function filter_wp_get_nav_menu_object( $menu_obj, $menu_id ) {

		$ok = (

			get_current_blog_id() === $this->_previewed_blog_id

			&&

			is_int( $menu_id )

			&&

			$menu_id === $this->term_id

		);

		if ( ! $ok ) {

			return $menu_obj;

		}

		$setting_value = $this->value();

		// Handle deleted menus.

		if ( false === $setting_value ) {

			return false;

		}

		// Handle sanitization failure by preventing short-circuiting.

		if ( null === $setting_value ) {

			return $menu_obj;

		}

		$menu_obj = (object) array_merge(

			array(

				'term_id'          => $this->term_id,

				'term_taxonomy_id' => $this->term_id,

				'slug'             => sanitize_title( $setting_value['name'] ),

				'count'            => 0,

				'term_group'       => 0,

				'taxonomy'         => self::TAXONOMY,

				'filter'           => 'raw',

			),

			$setting_value

		);

		return $menu_obj;

	}

	/**

	 * Filters the nav_menu_options option to include this menu's auto_add preference.

	 *

	 * @since 4.3.0

	 *

	 * @param array $nav_menu_options Nav menu options including auto_add.

	 */

	public function filter_nav_menu_options( $nav_menu_options ) {

			return $nav_menu_options;

		}

		$menu             = $this->value();

		$nav_menu_options = $this->filter_nav_menu_options_value(

			$nav_menu_options,

			$this->term_id,

			false === $menu ? false : $menu['auto_add']

		);

		return $nav_menu_options;

	}

	/**

	 * Sanitize an input.

	 *

	 * Note that parent::sanitize() erroneously does wp_unslash() on $value, but

	 * we remove that in this override.

	 *

	 * @since 4.3.0

	 *

	 * @param array $value The value to sanitize.

	 * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.

	 *                          Otherwise the sanitized value.

	 */

	public function sanitize( $value ) {

		// Menu is marked for deletion.

		if ( false === $value ) {

			return $value;

		}

		// Invalid.

		if ( ! is_array( $value ) ) {

			return null;

		}

		$default = array(

			'name'        => '',

			'description' => '',

			'parent'      => 0,

			'auto_add'    => false,

		);

		$value   = array_merge( $default, $value );

		$value   = wp_array_slice_assoc( $value, array_keys( $default ) );

		$value['name']        = trim( esc_html( $value['name'] ) ); // This sanitization code is used in wp-admin/nav-menus.php.

		$value['description'] = sanitize_text_field( $value['description'] );

		$value['parent']      = max( 0, intval( $value['parent'] ) );

		$value['auto_add']    = ! empty( $value['auto_add'] );

		if ( '' === $value['name'] ) {

			$value['name'] = _x( '(unnamed)', 'Missing menu name.' );