22

✏️ Editing: parser-context.php

<?php

namespace Jet_Form_Builder\Request;

use Jet_Form_Builder\Blocks\Block_Helper;
use Jet_Form_Builder\Classes\Arrayable\Array_Tools;
use Jet_Form_Builder\Exceptions\Parse_Exception;
use Jet_Form_Builder\Exceptions\Repository_Exception;
use Jet_Form_Builder\Exceptions\Silence_Exception;
use Jet_Form_Builder\Request\Exceptions\Exclude_Field_Exception;
use Jet_Form_Builder\Request\Exceptions\Plain_Value_Exception;
use JFB_Modules\Block_Parsers\Field_Data_Parser;
use JFB_Modules\Block_Parsers\Interfaces\Exclude_Self_Parser;
use JFB_Modules\Block_Parsers\Interfaces\Multiple_Parsers;
use JFB_Modules\Block_Parsers\Module;

// If this file is called directly, abort.
if ( ! defined( 'WPINC' ) ) {
	die;
}

/**
 * Class Parser_Context
 *
 * @package Jet_Form_Builder\Request
 */
class Parser_Context {

protected $name = '';

/** @var Field_Data_Parser|null */
	protected $parent_field;

/** @var string|numeric */
	protected $index_in_parent = '';
	private $hide_index        = false;

protected $raw_request = array();
	protected $raw_files   = array();

private $inside_conditional = false;

/**
	 * @var bool
	 *
	 * @since 3.0.4
	 */
	private $guest_allow = false;

/**
	 * Don't use it outside
	 *
	 * @var Field_Data_Parser[]
	 */
	public $parsers = array();

public function apply( $fields = null ) {
		if ( is_array( $fields ) ) {
			$this->set_parsers( $fields );
		}

/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $parser ) {
			$this->name = $parser->get_name();
			$parser->update_request();
		}
		$this->name = '';

$this->clear_all();
	}

public function set_parsers( $fields ) {
		foreach ( $this->generate_blocks( $fields ) as $block ) {
			/** @var Field_Data_Parser $parser */
			foreach ( $this->generate_parsers( $block ) as $parser ) {
				if ( ! $parser->get_name() ) {
					continue;
				}
				/**
				 * We have to set this position directly in each object,
				 * because the generation of parsers occurs
				 *
				 * @see https://github.com/Crocoblock/jetformbuilder/issues/339
				 */
				$parser->set_inside_conditional( $this->is_inside_conditional() );

$this->parsers[ $parser->get_name() ] = $parser;
			}
		}
	}

/**
	 * Should used in cases, when no need to check value. Just set
	 */
	public function apply_request() {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $parser ) {
			/**
			 * We need to iterate over the value before setting the context
			 * for the case when a large number of records are passed through
			 * a single Field_Data_Parser object. As in the case of exporting
			 *
			 * @see https://github.com/Crocoblock/issues-tracker/issues/3356
			 */
			$parser->reset();

try {
				$parser->set_request();

} catch ( Exclude_Field_Exception $exception ) {
				unset( $this->parsers[ $parser->get_name() ] );
			} catch ( Parse_Exception $exception ) {
				unset( $this->parsers[ $parser->get_name() ] );

foreach ( $exception->get_inner() as $key => $value ) {
					$this->update_request( $value, $key );
				}
			}
		}
	}

protected function generate_blocks( $fields ): \Generator {
		foreach ( $fields as $field ) {
			try {
				$this->validate_field( $field );

yield $field;

} catch ( Parse_Exception $exception ) {
				switch ( $exception->getMessage() ) {

case Module::IS_CONDITIONAL:
						$prev = $this->is_inside_conditional();
						$this->set_inside_conditional( true );

yield from $this->generate_blocks( $exception->get_inner() );
						$this->set_inside_conditional( $prev );
						break;

case Module::NOT_FIELD_HAS_INNER:
						yield from $this->generate_blocks( $exception->get_inner() );
						break;
				}
			}
		}
	}

/**
	 * @param array $field
	 *
	 * @throws Parse_Exception
	 */
	public function validate_field( array $field ) {
		// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
		if ( empty( $field['blockName'] ) ) {
			throw new Parse_Exception( Module::EMPTY_BLOCK_ERROR );
		}

if ( empty( $field['innerBlocks'] ) ) {
			return;
		}

if ( strpos( $field['blockName'], 'conditional-block' ) ) {
			throw new Parse_Exception( Module::IS_CONDITIONAL, $field['innerBlocks'] );
		}
		if ( ! Module::instance()->isset_parser( $field['blockName'] ) ) {
			throw new Parse_Exception( Module::NOT_FIELD_HAS_INNER, $field['innerBlocks'] );
		}
		// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
	}

/**
	 * @param array $field
	 *
	 * @return false|Field_Data_Parser
	 */
	protected function generate_parsers( array $field ): \Generator {
		// reset
		$this->name        = $field['attrs']['name'] ?? '';
		$this->guest_allow = false;

$parser = $this->get_parser( $field );

$parser->set_inner_contexts( $field['innerBlocks'] ?? array() );
		$parser->set_context( $this );

if ( ! ( $parser instanceof Exclude_Self_Parser ) ) {
			yield $parser;
		}

if ( ! ( $parser instanceof Multiple_Parsers ) ) {
			return;
		}

yield from $parser->generate_parsers();
	}

public function get_file( $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

if ( is_array( $name ) && ! count( $name ) ) {
			return $this->resolve_files();
		}

$path = Array_Tools::path( $name );

try {
			$parser = $this->resolve( $path );
		} catch ( Silence_Exception $exception ) {
			return $this->raw_files[ $path[0] ] ?? false;
		}

return ( $path instanceof Field_Data_Parser ) ? $parser->get_file() : $parser->get_file( array() );
	}

public function get_value( $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

if ( is_array( $name ) && ! count( $name ) ) {
			return $this->resolve_request();
		}

$path = Array_Tools::path( $name );

try {
			$parser = $this->resolve( $path );
		} catch ( Plain_Value_Exception $exception ) {
			return $this->parsers[ $path[0] ];
		} catch ( Repository_Exception $exception ) {
			return $this->raw_request[ $path[0] ] ?? '';
		}

return ( $path instanceof Field_Data_Parser ) ? $parser->get_value() : $parser->get_value( array() );
	}

/**
	 * @param $value
	 * @param string|array $name 'field_name'|'repeater_name'|'repeater_name.0.field_name'|['repeater_name', 0, 'field_name']
	 */
	public function update_request( $value, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

if ( is_array( $value ) && is_array( $name ) && ! count( $name ) ) {
			foreach ( $value as $key => $item ) {
				$this->update_request( $item, $key );
			}

return;
		}

$path = Array_Tools::path( $name );

try {
			$parser = $this->resolve_parser( $path );
		} catch ( Silence_Exception $exception ) {
			$this->parsers[ $path[0] ] = $value;

return;
		}

$parser->set_value( $value );
	}

public function update_file( $value, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

$parser->set_file( $value );
	}

public function set_request( array $request ): Parser_Context {
		$this->raw_request = $request;

return $this;
	}

public function set_files( $files ): Parser_Context {
		$this->raw_files = $files;

return $this;
	}

/**
	 * @param string $name
	 *
	 * @return array|mixed|string
	 */
	public function get_request( string $name = '' ) {
		if ( $name && array_key_exists( $name, $this->raw_request ) ) {
			return $this->raw_request[ $name ];
		}
		$real_request = $this->resolve_request();

return $name ? ( $real_request[ $name ] ?? '' ) : array_merge(
			$real_request,
			$this->raw_request
		);
	}

/**
	 * Allow to replace value of raw_request,
	 * because looks like it can't be replaces in any other way from Parser_Context
	 *
	 * @param  string $name  Field name to update.
	 * @param  mixed  $value A new value.
	 * @return void
	 */
	public function update_request_value( $name, $value ) {
		$this->raw_request[ $name ] = $value;
	}

/**
	 * @param string $name
	 *
	 * @return array|bool
	 */
	public function get_files( string $name = '' ) {
		return $name ? ( $this->raw_files[ $name ] ?? false ) : $this->raw_files;
	}

/**
	 * @return string
	 */
	public function get_name(): string {
		return $this->name;
	}

public function is_inside_conditional(): bool {
		return $this->inside_conditional;
	}

public function set_inside_conditional( bool $inside_conditional ): Parser_Context {
		$this->inside_conditional = $inside_conditional;

return $this;
	}

public function is_secure( $name ): bool {
		try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return false;
		}

return $parser->is_secure();
	}

/**
	 * @param string|array $name
	 *
	 * @see \JFB_Modules\Form_Record\Controller::generate_request
	 */
	public function make_secure( $name ) {
		try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

$parser->make_secure();
	}

/**
	 * @param string $attr_name
	 * @param $value
	 * @param string|array $name
	 *
	 * @since 3.0.4
	 */
	public function update_setting( string $attr_name, $value, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

$parser->set_setting( $attr_name, $value );
	}

/**
	 * @since 3.0.4
	 */
	public function allow_for_guest() {
		$this->guest_allow = true;
	}

/**
	 * @since 3.0.4
	 */
	public function is_allowed_for_guest(): bool {
		return $this->guest_allow;
	}

/**
	 * @param array $fields_settings
	 * @param string|array $name
	 *
	 * @since 3.1.0
	 */
	public function set_field_settings( array $fields_settings, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

$parser->set_settings( $fields_settings );
	}

/**
	 * @param string $field_type
	 * @param string|array $name
	 *
	 * @since 3.1.0
	 */
	public function set_field_type( string $field_type, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

$path = Array_Tools::path( $name );

try {
			$parser = $this->resolve_parser( $path );
		} catch ( Silence_Exception $exception ) {
			if ( 1 === count( $path ) ) {
				$this->insert_parser( $path[0], $field_type );
			}

return;
		}

$parser->set_type( $field_type );
	}

/**
	 * @param string|array $name
	 *
	 * @return string
	 * @since 3.1.0
	 */
	public function get_field_type( $name = '' ): string {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return '';
		}

return $parser->get_type();
	}

/**
	 * @param string|array $name
	 *
	 * @return string
	 * @since 3.0.4
	 */
	public function get_class_name( $name = '' ): string {
		return (string) $this->get_setting( 'class_name', $name );
	}

/**
	 * @param string $setting
	 * @param string|array $name
	 *
	 * @return false|mixed
	 */
	public function get_setting( string $setting, $name = '' ) {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return false;
		}

return $parser->get_setting( $setting );
	}

/**
	 * @param string|array $name
	 *
	 * @return array
	 */
	public function get_settings( $name = '' ): array {
		if ( '' === $name ) {
			$name = $this->name;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return array();
		}

return $parser->get_settings();
	}

public function iterate_fields_types(): \Generator {
		/**
		 * @var string $name
		 * @var Field_Data_Parser $parser
		 */
		foreach ( $this->iterate_parsers() as $name => $parser ) {
			yield $name => $parser->get_type();
		}
	}

public function iterate_fields_settings(): \Generator {
		/**
		 * @var string $name
		 * @var Field_Data_Parser $parser
		 */
		foreach ( $this->iterate_parsers() as $name => $parser ) {
			yield $name => $parser->get_settings();
		}
	}

/**
	 * @return \Generator<Field_Data_Parser>
	 */
	public function iterate_parsers(): \Generator {
		foreach ( $this->parsers as $name => $parser ) {
			if ( $parser instanceof Field_Data_Parser ) {
				yield $name => $parser;
			}
		}
	}

public function iterate_settings_list(): \Generator {
		/**
		 * @var string $name
		 * @var Field_Data_Parser $parser
		 */
		foreach ( $this->iterate_parsers_list() as $name => $parser ) {
			yield $name => $parser->get_settings();
		}
	}

public function iterate_types_list(): \Generator {
		/**
		 * @var string $name
		 * @var Field_Data_Parser $parser
		 */
		foreach ( $this->iterate_parsers_list() as $name => $parser ) {
			yield $name => $parser->get_type();
		}
	}

public function iterate_values_table(): \Generator {
		do {
			yield $this->iterate_values_row();

/** @var Field_Data_Parser $parser */
			foreach ( $this->iterate_parsers_list( false ) as $parser ) {
				$parser->next_inner();
			}
		} while ( ! $this->is_inner_over_parsers() );
	}

public function iterate_values_row(): \Generator {
		/**
		 * @var string $name
		 * @var Field_Data_Parser $parser
		 */
		foreach ( $this->iterate_parsers() as $parser ) {
			yield from $parser->iterate_row_value();
		}
	}

public function is_inner_over_parsers(): bool {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers_list( false ) as $parser ) {
			if ( ! $parser->is_inner_over() ) {
				return false;
			}
		}

return true;
	}

/**
	 * @param bool $break_on_first
	 *
	 * @return \Generator<Field_Data_Parser>
	 */
	public function iterate_parsers_list( bool $break_on_first = true ): \Generator {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $parser ) {
			yield from $parser->iterate_self( $break_on_first );
		}
	}

/**
	 * @param string|array $name
	 *
	 * @return \Generator
	 */
	public function iterate_inner( $name ): \Generator {
		if ( ! $name ) {
			return;
		}

try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

yield from $parser->iterate_inner();
	}

public function clear_all() {
		foreach ( $this->parsers as $name => $parser ) {
			unset( $this->raw_request[ $name ] );
			unset( $this->raw_files[ $name ] );
		}
	}

/**
	 * @param string|array $name
	 *
	 * @return bool
	 */
	public function has_field( $name ): bool {
		try {
			$this->resolve_parser( $name );

return true;
		} catch ( Repository_Exception $exception ) {
			return false;
		} catch ( Plain_Value_Exception $exception ) {
			return true;
		}
	}

public function is_collected_error( $name, string $error_name ): bool {
		try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return false;
		}

return $parser->is_collected_error( $error_name );
	}

public function get_errors( $name ): array {
		try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return array();
		}

return $parser->get_errors();
	}

public function collect_error( $name, $error_name ) {
		try {
			$parser = $this->resolve_parser( $name );
		} catch ( Silence_Exception $exception ) {
			return;
		}

$parser->collect_error( $error_name );
	}

public function iterate_errors(): \Generator {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $parser ) {
			$errors = $parser->get_errors();

if ( ! $errors ) {
				continue;
			}

yield $parser->get_name() => $errors;
		}
	}

public function iterate_errors_list(): \Generator {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers_list( false ) as $name => $parser ) {
			$errors = $parser->get_errors();

if ( ! $errors ) {
				continue;
			}

yield $name => $errors;
		}
	}

public function remove( $name ) {
		$real_path = Array_Tools::path( $name );

try {
			$parser = $this->resolve( $name );
		} catch ( Repository_Exception $exception ) {
			return;
		} catch ( Plain_Value_Exception $exception ) {
			unset( $this->parsers[ $real_path[0] ] );

return;
		}

if ( 1 === count( $real_path ) && ( $parser instanceof Field_Data_Parser ) ) {
			unset( $this->parsers[ $parser->get_name() ] );

return;
		}

if ( $parser instanceof Field_Data_Parser ) {
			$parser->get_context()->remove( $parser->get_name() );
		}

if ( $parser instanceof Parser_Context ) {
			$parser->get_parent_field()->remove_context( $parser->get_index_in_parent() );
		}
	}

public function resolve_request( bool $with_inner = true ): array {
		return iterator_to_array( $this->generate_request( $with_inner ) );
	}

public function generate_request( bool $with_inner = true ): \Generator {
		foreach ( $this->parsers as $name => $parser ) {
			if ( ! ( $parser instanceof Field_Data_Parser ) ) {
				yield $name => $parser;

continue;
			}
			$parser->set_with_inner( $with_inner );
			yield from $parser->iterate_value();
			$parser->set_with_inner( true );
		}
	}

public function resolve_files(): array {
		return iterator_to_array( $this->generate_files() );
	}

public function generate_files(): \Generator {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $parser ) {
			yield from $parser->iterate_file();
		}
	}

/**
	 * @param $path
	 *
	 * @return Field_Data_Parser
	 * @throws Plain_Value_Exception|Repository_Exception
	 */
	public function resolve_parser( $path ): Field_Data_Parser {
		$item = $this->resolve( $path );

if ( ! ( $item instanceof Field_Data_Parser ) ) {
			throw new Repository_Exception();
		}

return $item;
	}

/**
	 * @param $path
	 *
	 * @return Parser_Context
	 * @throws Plain_Value_Exception|Repository_Exception
	 */
	public function resolve_context( $path ): Parser_Context {
		$item = $this->resolve( $path );

if ( ! ( $item instanceof Parser_Context ) ) {
			throw new Repository_Exception();
		}

return $item;
	}

/**
	 * @param $path
	 *
	 * @return Field_Data_Parser|Parser_Context
	 * @throws Plain_Value_Exception
	 * @throws Repository_Exception
	 */
	public function resolve( $path ) {
		if ( ! is_array( $path ) ) {
			$path = Array_Tools::path( $path );
		}

if ( ! array_key_exists( $path[0], $this->parsers ) ) {
			// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
			throw new Repository_Exception( 'undefined_parser', $path );
		}
		if ( ! ( $this->parsers[ $path[0] ] instanceof Field_Data_Parser ) ) {
			throw new Plain_Value_Exception();
		}

$name = array_shift( $path );

return empty( $path ) ? $this->parsers[ $name ] : $this->parsers[ $name ]->resolve( $path );
	}

/**
	 * @param $path string[]|string
	 *
	 * @return Parser_Context|Field_Data_Parser
	 * @throws Plain_Value_Exception
	 * @throws Repository_Exception
	 */
	public function resolve_to_up( $path ) {
		try {
			return $this->resolve( $path );
		} catch ( Silence_Exception $exception ) {
			return $this->get_parent_field()->get_context()->resolve_to_up( $path );
		}
	}

protected function insert_parser( string $name, string $field_type ): Field_Data_Parser {
		if ( array_key_exists( $name, $this->parsers ) &&
			$this->parsers[ $name ] instanceof Field_Data_Parser
		) {
			return $this->parsers[ $name ];
		}

$parser = $this->get_parser( array( 'blockName' => $field_type ) );
		$parser->set_name( $name );

$value = '';
		if ( array_key_exists( $name, $this->parsers ) ) {
			$value = $this->parsers[ $name ];
		}
		$this->parsers[ $name ] = $parser;
		$parser->set_value( $value );
		$parser->set_context( $this );

return $parser;
	}

/**
	 * @param array $block
	 *
	 * @return Field_Data_Parser
	 */
	protected function get_parser( array $block ): Field_Data_Parser {
		$type   = Block_Helper::delete_namespace( $block['blockName'] );
		$parser = Module::instance()->get_parser( $type );
		$name   = $this->name ?: $block['attrs']['name'] ?? '';

$parser->set_type( $type );
		$parser->set_name( $name );
		$parser->set_settings( $block['attrs'] ?? array() );

return $parser;
	}

public function has_request(): bool {
		return ! empty( $this->parsers );
	}

public function get_unique_name( string $computed_field ): string {
		if (
			! $this->has_field( $computed_field ) ||
			! jet_fb_action_handler()->in_loop()
		) {
			return $computed_field;
		}

$computed_field .= '_' . jet_fb_action_handler()->get_current_action()->_id;

return $computed_field;
	}

public function set_parent( Field_Data_Parser $data_parser ) {
		$this->parent_field = $data_parser;
	}

/**
	 * @return float|int|string
	 */
	public function get_index_in_parent() {
		return $this->index_in_parent;
	}

/**
	 * @param float|int|string $index_in_parent
	 */
	public function set_index_in_parent( $index_in_parent ) {
		$this->index_in_parent = $index_in_parent;
	}

/**
	 * @param bool $hide_index
	 */
	public function set_hide_index( bool $hide_index ) {
		$this->hide_index = $hide_index;
	}

public function get_parent_name(): string {
		if ( ! $this->get_parent_field() ) {
			return '';
		}

if ( $this->hide_index ) {
			return $this->get_parent_field()->get_scoped_name();
		}

return trim(
			$this->get_parent_field()->get_scoped_name() . '.' . $this->index_in_parent,
			'.'
		);
	}

public function get_parent_label(): string {
		return $this->get_parent_field() ? $this->get_parent_field()->get_scoped_label() : '';
	}

/**
	 * @return Field_Data_Parser|null
	 */
	public function get_parent_field() {
		return $this->parent_field;
	}

public function __clone() {
		/** @var Field_Data_Parser $parser */
		foreach ( $this->iterate_parsers() as $name => $parser ) {
			$this->parsers[ $name ] = clone $parser;
			$this->parsers[ $name ]->set_context( $this );
		}
	}

public function __debugInfo(): array {
		$current = clone $this;

unset( $current->parent_field );

return get_object_vars( $current );
	}

}

MR SKB