<?php

/**
 * SWP_Link_Manager
 *
 * A class engineered to manage the links that are shared out to the various social
 * networks. This class will shorten them via Bitly or add Google Analytics tracking
 * parameters if the user has either of these options enabled and configured.
 *
 * Organization - This class has one primary function: It provides a publicly
 * accessable method that applies the link-modifying filters.
 *
 *    This will provides the plugin with an easy to access, static method which
 *    can be called from anywhere with minimal properties to quickly fetch a
 *    fully processed sharable link for the buttons.
 *
 * @since 3.0.0 | 14 FEB 2018 | Added check for is_attachment() to swp_google_analytics
 * @since 3.0.0 | 04 APR 2018 | Converted to class-based, object-oriented system.
 * @since 4.0.0 | 17 JUL 2019 | Refactored into a more expandable system so that
 *                              we can easily add multiple link shortening services.
 */
class SWP_Link_Manager {


	/**
	 * The Magic __construct method.
	 *
	 * This will enqueue our link shortening options to be added to the options
	 * page for the user to configure. We're keeping this here in core, but it
	 * will be dependent on addons registering link shortening services via the
	 * swp_link_shorteners hook that we'll access in the methods below.
	 *
	 * @since  4.0.0 | 18 JUL 2019 | Created
	 * @param  void
	 * @return void
	 */
	public function __construct() {

		/**
		 * This will enqueue our options to be added on the wp_loaded hook. We
		 * defer the call to this method as such to ensure that the $SWP_Options_Page
		 * global object has already been created and is available for us to
		 * manipulate.
		 */
		add_action( 'wp_loaded', array( $this, 'add_settings_page_options' ), 20 );
	}


	/**
	 * The function that processes a URL
	 *
	 * This method is used throughout the plugin to fetch URL's that have been
	 * processed with the link shorteners and UTM parameters. It processes an
	 * array of information through the swp_analytics filter and the
	 * swp_link_shortening filter.
	 *
	 * @since  3.0.0 | 04 APR 2018 | Created
	 * @param  string $url     The URL to be modified.
	 * @param  string $network The network on which the URL is being shared.
	 * @param  int    $post_id The post ID.
	 * @return string          The modified URL.
	 */
	public static function process_url( $url, $network, $post_id, $is_cache_fresh = true ) {

		/**
		 * Bail out if this is an attachment page. We had reports of short links
		 * being created on these.
		 */
		if ( is_attachment() ) {
			return $url;
		}

		/**
		 * Compile all of the parameters passed in into an array so that we can
		 * pass it through our custom filters (which only accept one paramter).
		 */
		$array['url']         = $url;
		$array['network']     = $network;
		$array['post_id']     = $post_id;
		$array['fresh_cache'] = $is_cache_fresh;
		$array                = apply_filters( 'swp_analytics', $array );
		$array                = apply_filters( 'swp_link_shortening', $array );

		return $array['url'];
	}


	/**
	 * add_settings_page_options()
	 *
	 * This method will add the options to the settings page that will allow the
	 * WordPress admin to configure the link shortening options as they see fit.
	 *
	 * We'll add the following options for the user:
	 * 1. A link shortening on/off toggle.
	 * 2. A link shortening service select dropdown (Bitly, Rebrandly, Etc.)
	 * 3. A minimum post publication date input box.
	 * 4. Options to turn shortening on/off for each post type.
	 *
	 * @since  4.0.0 | 18 JUL 2019 | Created
	 * @param  void
	 * @return void
	 */
	public function add_settings_page_options() {

		/**
		 * If there are no link shortening services regsitered via this hook,
		 * then just bail out and don't create of the link shortening section or
		 * options for the advanced tab. Just don't output anything.
		 */
		$services = array();
		$services = apply_filters( 'swp_available_link_shorteners', $services );
		if ( true === empty( $services ) ) {
			return;
		}

		/**
		 * The Link Shortening Section
		 *
		 * This creates a new options page section. This section will house all
		 * of the link shortening options that are available to the user.
		 */
		$link_shortening = new SWP_Options_Page_Section( esc_html__( 'Link Shortening', 'social-warfare' ), 'link_shortening' );
		$link_shortening
			->set_description( esc_html__( 'If you\'d like to have all of your links automatically shortened, turn this on.', 'social-warfare' ) )
			->set_information_link( 'https://warfareplugins.com/support/options-page-advanced-tab-bitly-link-shortening/' )
			->set_priority( 20 );

		/**
		 * The Link Shortening On/Off Toggle
		 *
		 * This creates the on/off toggle. All other options in this section
		 * will be dependant on this one and will on be visible when this
		 * is turned on.
		 */
		$link_shortening_toggle = new SWP_Option_Toggle( esc_html__( 'Link Shortening', 'social-warfare' ), 'link_shortening_toggle' );
		$link_shortening_toggle
			->set_size( 'sw-col-300' )
			->set_priority( 10 )
			->set_default( false )
			->set_premium( 'pro' );

		/**
		 * Minimum Publish Date
		 *
		 * This will add the option for a minimum publish date. Any post
		 * published prior to the date in this field will not get shortened
		 * links for the share buttons.
		 */
		$link_shortening_start_date = new SWP_Option_Text( esc_html__( 'Minimum Publish Date (YYYY-MM-DD)', 'social-warfare' ), 'link_shortening_start_date' );

		$link_shortening_start_date
			->set_default( gmdate( 'Y-m-d', strtotime( '90 days ago' ) ) )
			->set_priority( 20 )
			->set_size( 'sw-col-300' )
			->set_dependency( 'link_shortening_toggle', true )
			->set_premium( 'pro' );

		/**
		 * Loop Through Available Shorteners
		 *
		 * This section will access our swp_link_shorteners filter
		 * to see which link shortening services have been registered for
		 * use with the plugin. We will then loop through them and add them
		 * to our dropdown select and an authentication button.
		 */
		foreach ( $services as $service ) {
			$available_services[ $service->key ] = $service->name;
		}

		/**
		 * Link Shortener Service Selection
		 *
		 * This will add the select dropdown box wherein the user can select
		 * which of the available link shortening services they want to use.
		 */
		$link_shortening_service = new SWP_Option_Select( esc_html__( 'Link Shortening Service', 'social-warfare' ), 'link_shortening_service' );
		$link_shortening_service
			->set_choices( $available_services )
			->set_default( 'bitly' )
			->set_size( 'sw-col-300' )
			->set_dependency( 'link_shortening_toggle', true )
			->set_premium( 'pro' )
			->set_priority( 25 );

		/**
		 * Post Type Description
		 *
		 * This will add a brief text description to let the user know what the
		 * toggles do on the per-post-type section of the options.
		 */
		$post_type_description = new SWP_Section_HTML( 'Link Shortening Per Post Type', 'post_types' );
		$post_type_description->add_html( '<p class="sw-subtitle">Turn link shortening on or off for each post type across your site.</p>' )
			->set_priority( 100 )
			->set_dependency( 'link_shortening_toggle', true );

		/**
		 * Here we are going to fetch all of the post types that are registered
		 * on the site and then loop through them to create an on/off toggle
		 * for each one. They will then be stored using the key short_link_toggle_$post
		 */
		$post_types = SWP_Utility::get_post_types();
		$i          = 50;
		foreach ( $post_types as $index => $post ) {
			++$i;
			$priority = 100 + $i * 10;

			$default = false;
			if ( 'post' === $post ) {
				$default = true;
			}

			if ( 'archive_categories' === $post ) {
				continue;
			}

			$post_type_toggles[ $i ] = new SWP_Option_Toggle( str_replace( '_', ' & ', ucfirst( $post ) ), 'short_link_toggle_' . $post );
			$post_type_toggles[ $i ]
				->set_size( 'sw-col-300' )
				->set_priority( $priority )
				->set_default( $default )
				->set_dependency( 'link_shortening_toggle', true )
				->set_premium( 'pro' );
		}

		/**
		 * After all of the option objects have been created, this will add them
		 * to the link shortening section of the page.
		 */
		$link_shortening->add_options(
			array(
				$link_shortening_toggle,
				$link_shortening_service,
				$link_shortening_start_date,
				$post_type_description,
			)
		);
		$link_shortening->add_options( $post_type_toggles );

		/**
		 * This will access the global $SWP_Options_Page object, find the
		 * advanced tab, and add our link shortening section to it.
		 */
		global $SWP_Options_Page;
		$advanced_tab = $SWP_Options_Page->tabs->advanced;
		$advanced_tab->add_sections( array( $link_shortening ) );
	}
}