<?php
/**
 * ConvertKit Restrict Content Settings class.
 *
 * @package ConvertKit
 * @author ConvertKit
 */

/**
 * Class to read ConvertKit Restrict Content Settings.
 *
 * @since   2.1.0
 */
class ConvertKit_Settings_Restrict_Content {

	/**
	 * Holds the Settings Key that stores site wide ConvertKit settings
	 *
	 * @var     string
	 *
	 * @since   2.1.0
	 */
	const SETTINGS_NAME = '_wp_convertkit_settings_restrict_content';

	/**
	 * Holds the Settings
	 *
	 * @var     array
	 *
	 * @since   2.1.0
	 */
	private $settings = array();

	/**
	 * Constructor. Reads settings from options table, falling back to defaults
	 * if no settings exist.
	 *
	 * @since   2.1.0
	 */
	public function __construct() {

		// Get Settings.
		$settings = get_option( self::SETTINGS_NAME );

		// If no Settings exist, falback to default settings.
		if ( ! $settings ) {
			$this->settings = $this->get_defaults();
		} else {
			$this->settings = array_merge( $this->get_defaults(), $settings );
		}

	}

	/**
	 * Returns Plugin settings.
	 *
	 * @since   2.1.0
	 *
	 * @return  array
	 */
	public function get() {

		return $this->settings;

	}

	/**
	 * Returns whether crawlers are permitted to index Member Content in the Plugin settings.
	 *
	 * @since   2.4.1
	 *
	 * @return  bool
	 */
	public function permit_crawlers() {

		return ( $this->settings['permit_crawlers'] === 'on' ? true : false );

	}

	/**
	 * Returns Restrict Content settings value for the given key.
	 *
	 * @since   2.1.0
	 *
	 * @param   string $key    Setting Key.
	 * @return  string          Value
	 */
	public function get_by_key( $key ) {

		// If the setting doesn't exist, bail.
		if ( ! array_key_exists( $key, $this->settings ) ) {
			return '';
		}

		// If the setting is empty, fallback to the default.
		if ( empty( $this->settings[ $key ] ) ) {
			$defaults = $this->get_defaults();
			return $defaults[ $key ];
		}

		return $this->settings[ $key ];

	}

	/**
	 * Returns this settings group's programmatic name.
	 *
	 * @since   3.4.0
	 *
	 * @return  string
	 */
	public function get_name() {

		return 'restrict-content';

	}

	/**
	 * Returns the title of this settings group.
	 *
	 * @since   3.4.0
	 *
	 * @return  string
	 */
	public function get_title() {

		return __( 'Member Content Settings', 'convertkit' );

	}

	/**
	 * Returns the keys in this settings group that hold credentials or other
	 * sensitive values.
	 *
	 * Member Content settings hold no secrets; returned for interface
	 * consistency.
	 *
	 * @since   3.4.0
	 *
	 * @return  string[]
	 */
	public function get_secret_keys() {

		return array();

	}

	/**
	 * Returns the JSON Schema describing this settings group, in the shape
	 * stored by save() / returned by get(), excluding secret keys.
	 *
	 * @since   3.4.0
	 *
	 * @return  array
	 */
	public function get_schema() {

		return array(
			'type'                 => 'object',
			'additionalProperties' => false,
			'properties'           => array(
				'permit_crawlers'        => array(
					'type'        => 'string',
					'enum'        => array( '', 'on' ),
					'description' => __( 'Whether search engine crawlers are permitted to index Member Content.', 'convertkit' ),
				),
				'no_access_text_form'    => array(
					'type'        => 'string',
					'description' => __( 'Message shown to a visitor without access when content is restricted by Form.', 'convertkit' ),
				),
				'subscribe_heading'      => array(
					'type'        => 'string',
					'description' => __( 'Heading shown above the subscribe call-to-action when content is restricted by Product.', 'convertkit' ),
				),
				'subscribe_text'         => array(
					'type'        => 'string',
					'description' => __( 'Body text shown alongside the subscribe call-to-action when content is restricted by Product.', 'convertkit' ),
				),
				'no_access_text'         => array(
					'type'        => 'string',
					'description' => __( 'Message shown to a visitor without access when content is restricted by Product.', 'convertkit' ),
				),
				'subscribe_heading_tag'  => array(
					'type'        => 'string',
					'description' => __( 'Heading shown above the subscribe call-to-action when content is restricted by Tag.', 'convertkit' ),
				),
				'subscribe_text_tag'     => array(
					'type'        => 'string',
					'description' => __( 'Body text shown alongside the subscribe call-to-action when content is restricted by Tag.', 'convertkit' ),
				),
				'require_tag_login'      => array(
					'type'        => 'string',
					'enum'        => array( '', 'on' ),
					'description' => __( 'Whether visitors must log in by email to access Member Content restricted by Tag.', 'convertkit' ),
				),
				'no_access_text_tag'     => array(
					'type'        => 'string',
					'description' => __( 'Message shown to a visitor without access when content is restricted by Tag.', 'convertkit' ),
				),
				'subscribe_button_label' => array(
					'type'        => 'string',
					'description' => __( 'Label for the Subscribe button.', 'convertkit' ),
				),
				'email_text'             => array(
					'type'        => 'string',
					'description' => __( 'Body text shown above the email log-in form.', 'convertkit' ),
				),
				'email_button_label'     => array(
					'type'        => 'string',
					'description' => __( 'Label for the email log-in button.', 'convertkit' ),
				),
				'email_heading'          => array(
					'type'        => 'string',
					'description' => __( 'Heading shown above the email log-in form.', 'convertkit' ),
				),
				'email_description_text' => array(
					'type'        => 'string',
					'description' => __( 'Description shown beneath the email log-in heading.', 'convertkit' ),
				),
				'email_check_heading'    => array(
					'type'        => 'string',
					'description' => __( 'Heading shown after the visitor requests a magic log-in code.', 'convertkit' ),
				),
				'email_check_text'       => array(
					'type'        => 'string',
					'description' => __( 'Body text shown after the visitor requests a magic log-in code.', 'convertkit' ),
				),
				'container_css_classes'  => array(
					'type'        => 'string',
					'description' => __( 'Additional CSS classes appended to the Restrict Content container element.', 'convertkit' ),
				),
			),
		);

	}

	/**
	 * The default settings, used when the ConvertKit Restrict Content Settings haven't been saved
	 * e.g. on a new installation.
	 *
	 * @since   2.1.0
	 *
	 * @return  array
	 */
	public function get_defaults() {

		$defaults = array(
			// Permit Crawlers.
			'permit_crawlers'        => '',

			// Restrict by Form.
			'no_access_text_form'    => __( 'Your account does not have access to this content. Please use the form above to subscribe.', 'convertkit' ),

			// Restrict by Product.
			'subscribe_heading'      => __( 'Read this post with a premium subscription', 'convertkit' ),
			'subscribe_text'         => __( 'This post is only available to premium subscribers. Join today to get access to all posts.', 'convertkit' ),
			'no_access_text'         => __( 'Your account does not have access to this content. Please use the button above to purchase, or enter the email address you used to purchase the product.', 'convertkit' ),

			// Restrict by Tag.
			'subscribe_heading_tag'  => __( 'Subscribe to keep reading', 'convertkit' ),
			'subscribe_text_tag'     => __( 'This post is free to read but only available to subscribers. Join today to get access to all posts.', 'convertkit' ),
			'no_access_text_tag'     => __( 'Your account does not have access to this content. Please use the form above to subscribe.', 'convertkit' ),

			// All.
			'subscribe_button_label' => __( 'Subscribe', 'convertkit' ),
			'email_text'             => __( 'Already subscribed?', 'convertkit' ),
			'email_button_label'     => __( 'Log in', 'convertkit' ),
			'email_heading'          => __( 'Log in to read this post', 'convertkit' ),
			'email_description_text' => __( 'We\'ll email you a magic code to log you in without a password.', 'convertkit' ),
			'email_check_heading'    => __( 'We just emailed you a log in code', 'convertkit' ),
			'email_check_text'       => __( 'Enter the code below to finish logging in', 'convertkit' ),
			'container_css_classes'  => '',
		);

		/**
		 * The default settings, used when the ConvertKit Restrict Content Settings haven't been saved
		 * e.g. on a new installation.
		 *
		 * @since   2.1.0
		 *
		 * @param   array   $defaults   Default settings.
		 */
		$defaults = apply_filters( 'convertkit_settings_restrict_content_get_defaults', $defaults );

		return $defaults;

	}

	/**
	 * Saves the given array of settings to the WordPress options table.
	 *
	 * @since   2.1.0
	 *
	 * @param   array $settings   Settings.
	 */
	public function save( $settings ) {

		update_option( self::SETTINGS_NAME, array_merge( $this->get(), $settings ) );

		// Reload settings in class, to reflect changes.
		$this->refresh_settings();

	}

	/**
	 * Reloads settings from the options table so this instance has the latest values.
	 *
	 * @since  3.3.5
	 */
	private function refresh_settings() {

		$settings = get_option( self::SETTINGS_NAME );

		if ( ! $settings ) {
			$this->settings = $this->get_defaults();
			return;
		}

		$this->settings = array_merge( $this->get_defaults(), $settings );

	}

}