webadmin.php

/var/www/html/wp-content/plugins/woocommerce/vendor/automattic/jetpack-config/src/class-config.php

<?php
/**
 * The base Jetpack configuration class file.
 *
 * @package automattic/jetpack-config
 */

namespace Automattic\Jetpack;

/*
 * The Config package does not require the composer packages that
 * contain the package classes shown below. The consumer plugin
 * must require the corresponding packages to use these features.
 */
use Automattic\Jetpack\Connection\Manager;
use Automattic\Jetpack\Connection\Plugin;
use Automattic\Jetpack\Import\Main as Import_Main;
use Automattic\Jetpack\JITMS\JITM as JITMS_JITM;
use Automattic\Jetpack\Post_List\Post_List;
use Automattic\Jetpack\Publicize\Publicize_Setup;
use Automattic\Jetpack\Search\Initializer as Jetpack_Search_Main;
use Automattic\Jetpack\Stats\Main as Stats_Main;
use Automattic\Jetpack\Stats_Admin\Main as Stats_Admin_Main;
use Automattic\Jetpack\Sync\Main as Sync_Main;
use Automattic\Jetpack\VideoPress\Initializer as VideoPress_Pkg_Initializer;
use Automattic\Jetpack\Waf\Waf_Initializer as Jetpack_Waf_Main;
use Automattic\Jetpack\WordAds\Initializer as Jetpack_WordAds_Main;

/**
 * The configuration class.
 */
class Config {

    const FEATURE_ENSURED         = 1;
    const FEATURE_NOT_AVAILABLE   = 0;
    const FEATURE_ALREADY_ENSURED = -1;

    /**
     * The initial setting values.
     *
     * @var Array
     */
    protected $config = array(
        'jitm'            => false,
        'connection'      => false,
        'sync'            => false,
        'post_list'       => false,
        'identity_crisis' => false,
        'search'          => false,
        'publicize'       => false,
        'wordads'         => false,
        'waf'             => false,
        'videopress'      => false,
        'stats'           => false,
        'stats_admin'     => false,
        'yoast_promo'     => false,
        'import'          => false,
    );

    /**
     * Initialization options stored here.
     *
     * @var array
     */
    protected $feature_options = array();

    /**
     * Creates the configuration class instance.
     */
    public function __construct() {
        /**
         * Adding the config handler to run on priority 2 because the class itself is
         * being constructed on priority 1.
         */
        add_action( 'plugins_loaded', array( $this, 'on_plugins_loaded' ), 2 );
    }

    /**
     * Require a feature to be initialized. It's up to the package consumer to actually add
     * the package to their composer project. Declaring a requirement using this method
     * instructs the class to initialize it.
     *
     * Run the options method (if exists) every time the method is called.
     *
     * @param String $feature the feature slug.
     * @param array  $options Additional options, optional.
     */
    public function ensure( $feature, array $options = array() ) {
        $this->config[ $feature ] = true;

        $this->set_feature_options( $feature, $options );

        $method_options = 'ensure_options_' . $feature;
        if ( method_exists( $this, $method_options ) ) {
            $this->{ $method_options }();
        }
    }

    /**
     * Runs on plugins_loaded hook priority with priority 2.
     *
     * @action plugins_loaded
     */
    public function on_plugins_loaded() {
        if ( $this->config['connection'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Connection\Manager' )
                && $this->ensure_feature( 'connection' );
        }

        if ( $this->config['sync'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Sync\Main' )
                && $this->ensure_feature( 'sync' );
        }

        if ( $this->config['jitm'] ) {
            // Check for the JITM class in both namespaces. The namespace was changed in jetpack-jitm v1.6.
            ( $this->ensure_class( 'Automattic\Jetpack\JITMS\JITM', false )
                || $this->ensure_class( 'Automattic\Jetpack\JITM' ) )
            && $this->ensure_feature( 'jitm' );
        }

        if ( $this->config['post_list'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Post_List\Post_List' )
                && $this->ensure_feature( 'post_list' );
        }

        if ( $this->config['identity_crisis'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Identity_Crisis' )
                && $this->ensure_feature( 'identity_crisis' );
        }

        if ( $this->config['search'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Search\Initializer' )
                && $this->ensure_feature( 'search' );
        }

        if ( $this->config['publicize'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Publicize\Publicize_UI' ) && $this->ensure_class( 'Automattic\Jetpack\Publicize\Publicize' )
                && $this->ensure_feature( 'publicize' );
        }

        if ( $this->config['wordads'] ) {
            $this->ensure_class( 'Automattic\Jetpack\WordAds\Initializer' )
                && $this->ensure_feature( 'wordads' );
        }

        if ( $this->config['waf'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Waf\Waf_Initializer' )
                && $this->ensure_feature( 'waf' );
        }

        if ( $this->config['videopress'] ) {
            $this->ensure_class( 'Automattic\Jetpack\VideoPress\Initializer' ) && $this->ensure_feature( 'videopress' );
        }
        if ( $this->config['stats'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Stats\Main' ) && $this->ensure_feature( 'stats' );
        }
        if ( $this->config['stats_admin'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Stats_Admin\Main' ) && $this->ensure_feature( 'stats_admin' );
        }

        if ( $this->config['yoast_promo'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Yoast_Promo' ) && $this->ensure_feature( 'yoast_promo' );
        }

        if ( $this->config['import'] ) {
            $this->ensure_class( 'Automattic\Jetpack\Import\Main' )
                && $this->ensure_feature( 'import' );
        }
    }

    /**
     * Returns true if the required class is available and alerts the user if it's not available
     * in case the site is in debug mode.
     *
     * @param String  $classname a fully qualified class name.
     * @param Boolean $log_notice whether the E_USER_NOTICE should be generated if the class is not found.
     *
     * @return Boolean whether the class is available.
     */
    protected function ensure_class( $classname, $log_notice = true ) {
        $available = class_exists( $classname );

        if ( $log_notice && ! $available && defined( 'WP_DEBUG' ) && WP_DEBUG ) {
            trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
                sprintf(
                    /* translators: %1$s is a PHP class name. */
                    esc_html__(
                        'Unable to load class %1$s. Please add the package that contains it using composer and make sure you are requiring the Jetpack autoloader',
                        'jetpack-config'
                    ),
                    esc_html( $classname )
                ),
                E_USER_NOTICE
            );
        }

        return $available;
    }

    /**
     * Ensures a feature is enabled, sets it up if it hasn't already been set up.
     *
     * @param String $feature slug of the feature.
     * @return Integer either FEATURE_ENSURED, FEATURE_ALREADY_ENSURED or FEATURE_NOT_AVAILABLE constants.
     */
    protected function ensure_feature( $feature ) {
        $method = 'enable_' . $feature;
        if ( ! method_exists( $this, $method ) ) {
            return self::FEATURE_NOT_AVAILABLE;
        }

        if ( did_action( 'jetpack_feature_' . $feature . '_enabled' ) ) {
            return self::FEATURE_ALREADY_ENSURED;
        }

        $this->{ $method }();

        /**
         * Fires when a specific Jetpack package feature is initalized using the Config package.
         *
         * @since 1.1.0
         */
        do_action( 'jetpack_feature_' . $feature . '_enabled' );

        return self::FEATURE_ENSURED;
    }

    /**
     * Enables the JITM feature.
     */
    protected function enable_jitm() {
        if ( class_exists( 'Automattic\Jetpack\JITMS\JITM' ) ) {
            JITMS_JITM::configure();
        } else {
            // Provides compatibility with jetpack-jitm <v1.6.
            // @phan-suppress-next-line PhanUndeclaredClassMethod
            JITM::configure();
        }

        return true;
    }

    /**
     * Enables the Post_List feature.
     */
    protected function enable_post_list() {
        Post_List::configure();

        return true;
    }

    /**
     * Enables the Sync feature.
     */
    protected function enable_sync() {
        Sync_Main::configure();

        return true;
    }

    /**
     * Enables the Connection feature.
     */
    protected function enable_connection() {
        Manager::configure();

        return true;
    }

    /**
     * Enables the identity-crisis feature.
     */
    protected function enable_identity_crisis() {
        Identity_Crisis::init();
    }

    /**
     * Enables the search feature.
     */
    protected function enable_search() {
        Jetpack_Search_Main::init();
    }

    /**
     * Enables the Publicize feature.
     */
    protected function enable_publicize() {
        Publicize_Setup::configure();

        return true;
    }

    /**
     * Handles Publicize options.
     */
    protected function ensure_options_publicize() {
        $options = $this->get_feature_options( 'publicize' );

        if ( ! empty( $options['force_refresh'] ) ) {
            Publicize_Setup::$refresh_plan_info = true;
        }
    }

    /**
     * Enables WordAds.
     */
    protected function enable_wordads() {
        Jetpack_WordAds_Main::init();
    }

    /**
     * Enables Waf.
     */
    protected function enable_waf() {
        Jetpack_Waf_Main::init();

        return true;
    }

    /**
     * Enables VideoPress.
     */
    protected function enable_videopress() {
        VideoPress_Pkg_Initializer::init();
        return true;
    }

    /**
     * Enables Stats.
     */
    protected function enable_stats() {
        Stats_Main::init();
        return true;
    }

    /**
     * Enables Stats Admin.
     */
    protected function enable_stats_admin() {
        Stats_Admin_Main::init();
        return true;
    }

    /**
     * Handles VideoPress options
     */
    protected function ensure_options_videopress() {
        $options = $this->get_feature_options( 'videopress' );
        if ( ! empty( $options ) ) {
            VideoPress_Pkg_Initializer::update_init_options( $options );
        }
        return true;
    }

    /**
     * Enables Yoast Promo.
     */
    protected function enable_yoast_promo() {
        Yoast_Promo::init();
        return true;
    }

    /**
     * Enables the Import feature.
     */
    protected function enable_import() {
        Import_Main::configure();

        return true;
    }

    /**
     * Setup the Connection options.
     */
    protected function ensure_options_connection() {
        $options = $this->get_feature_options( 'connection' );

        if ( ! empty( $options['slug'] ) ) {
            // The `slug` and `name` are removed from the options because they need to be passed as arguments.
            $slug = $options['slug'];
            unset( $options['slug'] );

            $name = $slug;
            if ( ! empty( $options['name'] ) ) {
                $name = $options['name'];
                unset( $options['name'] );
            }

            ( new Plugin( $slug ) )->add( $name, $options );
        }

        return true;
    }

    /**
     * Setup the Identity Crisis options.
     *
     * @return bool
     */
    protected function ensure_options_identity_crisis() {
        $options = $this->get_feature_options( 'identity_crisis' );

        if ( is_array( $options ) && count( $options ) ) {
            add_filter(
                'jetpack_idc_consumers',
                function ( $consumers ) use ( $options ) {
                    $consumers[] = $options;
                    return $consumers;
                }
            );
        }

        return true;
    }

    /**
     * Setup the Sync options.
     */
    protected function ensure_options_sync() {
        $options = $this->get_feature_options( 'sync' );
        if ( method_exists( 'Automattic\Jetpack\Sync\Main', 'set_sync_data_options' ) ) {
            Sync_Main::set_sync_data_options( $options );
        }

        return true;
    }

    /**
     * Temporary save initialization options for a feature.
     *
     * @param string $feature The feature slug.
     * @param array  $options The options.
     *
     * @return bool
     */
    protected function set_feature_options( $feature, array $options ) {
        if ( $options ) {
            $this->feature_options[ $feature ] = $options;
        }

        return true;
    }

    /**
     * Get initialization options for a feature from the temporary storage.
     *
     * @param string $feature The feature slug.
     *
     * @return array
     */
    protected function get_feature_options( $feature ) {
        return empty( $this->feature_options[ $feature ] ) ? array() : $this->feature_options[ $feature ];
    }
}