webadmin.php

/var/www/html_de/wp-content/plugins/woocommerce/src/Admin/Features/Blueprint/Init.php

<?php

declare( strict_types = 1 );

namespace Automattic\WooCommerce\Admin\Features\Blueprint;

use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCPaymentGateways;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsAccount;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsAdvanced;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsEmails;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsGeneral;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsTax;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsIntegrations;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsProducts;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsSiteVisibility;
use Automattic\WooCommerce\Admin\Features\Blueprint\Exporters\ExportWCSettingsShipping;
use Automattic\WooCommerce\Admin\PageController;
use Automattic\WooCommerce\Blueprint\Exporters\HasAlias;
use Automattic\WooCommerce\Blueprint\Exporters\StepExporter;
use Automattic\WooCommerce\Blueprint\UseWPFunctions;

/**
 * Class Init
 *
 * This class initializes the Blueprint feature for WooCommerce.
 */
class Init {
    use UseWPFunctions;

    const INSTALLED_WP_ORG_PLUGINS_TRANSIENT = 'woocommerce_blueprint_installed_wp_org_plugins';
    const INSTALLED_WP_ORG_THEMES_TRANSIENT  = 'woocommerce_blueprint_installed_wp_org_themes';
    /**
     * Array of initialized exporters.
     *
     * @var StepExporter[]
     */
    private array $initialized_exporters = array();

    /**
     * Init constructor.
     */
    public function __construct() {
        add_action( 'rest_api_init', array( $this, 'init_rest_api' ) );
        add_filter( 'woocommerce_admin_shared_settings', array( $this, 'add_js_vars' ) );

        add_filter(
            'wooblueprint_export_landingpage',
            function () {
                return '/wp-admin/admin.php?page=wc-admin';
            }
        );

        add_filter( 'wooblueprint_exporters', array( $this, 'add_woo_exporters' ) );

        add_action( 'upgrader_process_complete', array( $this, 'clear_installed_wp_org_plugins_transient' ), 10, 2 );
        add_action( 'deleted_plugin', array( $this, 'clear_installed_wp_org_plugins_transient' ), 10, 2 );

        add_action( 'upgrader_process_complete', array( $this, 'clear_installed_wp_org_themes_transient' ), 10, 2 );
        add_action( 'switch_theme', array( $this, 'clear_installed_wp_org_themes_transient' ) );
        add_action( 'deleted_theme', array( $this, 'clear_installed_wp_org_themes_transient' ) );
    }

    /**
     * Register REST API routes.
     *
     * @return void
     */
    public function init_rest_api() {
        ( new RestApi() )->register_routes();
    }

    /**
     * Return Woo Exporter classnames.
     *
     * @return StepExporter[]
     */
    public function get_woo_exporters() {
        $classnames = array(
            ExportWCSettingsGeneral::class,
            ExportWCSettingsProducts::class,
            ExportWCSettingsTax::class,
            ExportWCSettingsShipping::class,
            ExportWCPaymentGateways::class,
            ExportWCSettingsAccount::class,
            ExportWCSettingsEmails::class,
            ExportWCSettingsIntegrations::class,
            ExportWCSettingsSiteVisibility::class,
            ExportWCSettingsAdvanced::class,
        );

        $exporters = array();
        foreach ( $classnames as $classname ) {
            $exporters[ $classname ]                   = $this->initialized_exporters[ $classname ] ?? new $classname();
            $this->initialized_exporters[ $classname ] = $exporters[ $classname ];
        }

        return array_values( $exporters );
    }

    /**
     * Add Woo Specific Exporters.
     *
     * @param StepExporter[] $exporters Array of step exporters.
     *
     * @return StepExporter[]
     */
    public function add_woo_exporters( array $exporters ) {
        return array_merge(
            $exporters,
            $this->get_woo_exporters()
        );
    }

    /**
     * Get plugins for export group.
     *
     * @return array|array[] $plugins
     */
    public function get_plugins_for_export_group() {
        $plugins = $this->get_installed_wp_org_plugins();

        // Get active plugins from WordPress options and transform plugins array into export format.
        $active_plugins = $this->wp_get_option( 'active_plugins', array() );
        $plugins        = array_map(
            function ( $key, $plugin ) use ( $active_plugins ) {
                return array(
                    'id'      => $key,
                    'label'   => $plugin['Name'],
                    'checked' => in_array( $key, $active_plugins, true ),
                );
            },
            array_keys( $plugins ),
            $plugins
        );

        usort(
            $plugins,
            function ( $a, $b ) {
                return $b['checked'] <=> $a['checked'];
            }
        );
        return $plugins;
    }

    /**
     * Clear the installed WordPress.org plugins transient.
     */
    public function clear_installed_wp_org_plugins_transient() {
        delete_transient( self::INSTALLED_WP_ORG_PLUGINS_TRANSIENT );
    }

    /**
     * Clear the installed WordPress.org themes transient.
     */
    public function clear_installed_wp_org_themes_transient() {
        delete_transient( self::INSTALLED_WP_ORG_THEMES_TRANSIENT );
    }

    /**
     * Get themes for export group.
     *
     * @return array $themes
     */
    public function get_themes_for_export_group() {
        $themes       = $this->get_installed_wp_org_themes();
        $active_theme = $this->wp_get_theme();

        $themes = array_map(
            function ( $theme ) use ( $active_theme ) {
                return array(
                    'id'      => $theme->get_stylesheet(),
                    'label'   => $theme->get( 'Name' ),
                    'checked' => $theme->get_stylesheet() === $active_theme->get_stylesheet(),
                );
            },
            $themes
        );

        usort(
            $themes,
            function ( $a, $b ) {
                return $b['checked'] <=> $a['checked'];
            }
        );

        return array_values( $themes );
    }

    /**
     * Return step groups for JS.
     *
     * This is used to populate exportable items on the blueprint settings page.
     *
     * @return array
     */
    public function get_step_groups_for_js() {
        return array(
            array(
                'id'          => 'settings',
                'description' => __( 'Includes all the items featured in WooCommerce | Settings.', 'woocommerce' ),
                'label'       => __( 'WooCommerce Settings', 'woocommerce' ),
                'icon'        => 'settings',
                'items'       => array_map(
                    function ( $exporter ) {
                        return array(
                            'id'          => $exporter instanceof HasAlias ? $exporter->get_alias() : $exporter->get_step_name(),
                            'label'       => $exporter->get_label(),
                            'description' => $exporter->get_description(),
                            'checked'     => true,
                        );
                    },
                    $this->get_woo_exporters()
                ),
            ),
            array(
                'id'          => 'plugins',
                'description' => __( 'Includes all the installed plugins.', 'woocommerce' ),
                'label'       => __( 'Plugins', 'woocommerce' ),
                'icon'        => 'plugins',
                'items'       => $this->get_plugins_for_export_group(),
            ),
            array(
                'id'          => 'themes',
                'description' => __( 'Includes all the installed themes.', 'woocommerce' ),
                'label'       => __( 'Themes', 'woocommerce' ),
                'icon'        => 'layout',
                'items'       => $this->get_themes_for_export_group(),
            ),
        );
    }

    /**
     * Add shared JS vars.
     *
     * @param array $settings shared settings.
     *
     * @return mixed
     */
    public function add_js_vars( $settings ) {
        if ( ! is_admin() ) {
            return $settings;
        }

        if ( 'woocommerce_page_wc-settings-advanced-blueprint' === PageController::get_instance()->get_current_screen_id() ) {
            // Used on the settings page.
            // wcSettings.admin.blueprint_step_groups.
            $settings['blueprint_step_groups']         = $this->get_step_groups_for_js();
            $settings['blueprint_max_step_size_bytes'] = RestApi::MAX_FILE_SIZE;
        }

        return $settings;
    }

    /**
     * Get all installed WordPress.org plugins.
     *
     * @return array
     */
    private function get_installed_wp_org_plugins() {
        // Try to get cached plugin list.
        $wp_org_plugins = get_transient( self::INSTALLED_WP_ORG_PLUGINS_TRANSIENT );
        if ( is_array( $wp_org_plugins ) ) {
            return $wp_org_plugins;
        }

        // Get all installed plugins.
        $all_plugins  = $this->wp_get_plugins();
        $plugin_slugs = array();

        // Build a map of plugin file => slug.
        foreach ( $all_plugins as $key => $plugin ) {
            $slug = dirname( $key );
            /**
             * Apply the WP Core "wp_plugin_dependencies_slug" filter to get the correct plugin slug.
             */
            $slug = apply_filters( 'wp_plugin_dependencies_slug', $slug ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment

            $plugin_slugs[]              = $slug;
            $all_plugins[ $key ]['slug'] = $slug;
        }

        $api_response = $this->wp_plugins_api(
            'plugin_information',
            array(
                'fields' => array(
                    'short_description' => false,
                    'sections'          => false,
                    'description'       => false,
                    'tested'            => false,
                    'requires'          => false,
                    'rating'            => false,
                    'ratings'           => false,
                    'downloaded'        => false,
                    'downloadlink'      => false,
                    'last_updated'      => false,
                    'added'             => false,
                    'tags'              => false,
                    'compatibility'     => false,
                    'homepage'          => false,
                    'versions'          => false,
                    'donate_link'       => false,
                    'reviews'           => false,
                    'banners'           => false,
                    'icons'             => false,
                    'active_installs'   => false,
                ),
                'slugs'  => $plugin_slugs,
            )
        );

        // If API fails, return all plugins.
        if ( is_wp_error( $api_response ) ) {
            return $all_plugins;
        }

        // Filter plugins: only keep those with a valid API response (no 'error' for their slug).
        $wp_org_plugins = array_filter(
            $all_plugins,
            function ( $plugin ) use ( $api_response ) {
                $slug = $plugin['slug'];
                return isset( $api_response->{$slug} ) && ! isset( $api_response->{$slug}['error'] );
            }
        );

        set_transient( self::INSTALLED_WP_ORG_PLUGINS_TRANSIENT, $wp_org_plugins );
        return $wp_org_plugins;
    }

    /**
     * Get all installed WordPress.org themes.
     *
     * @return array
     */
    private function get_installed_wp_org_themes() {
        // Try to get cached theme list.
        $wp_org_themes = get_transient( self::INSTALLED_WP_ORG_THEMES_TRANSIENT );
        if ( is_array( $wp_org_themes ) ) {
            return $wp_org_themes;
        }

        // Get all installed themes.
        $all_themes  = $this->wp_get_themes();
        $theme_slugs = array();

        // Build an array of installed theme slugs.
        foreach ( $all_themes as $key => $theme ) {
            if ( is_string( $key ) ) {
                $theme_slugs[] = strtolower( $key );
            }
        }

        $api_response = $this->wp_themes_api(
            'theme_information',
            array(
                'fields' => array(
                    'downloadlink'    => true,
                    'sections'        => false,
                    'description'     => false,
                    'rating'          => false,
                    'ratings'         => false,
                    'downloaded'      => false,
                    'last_updated'    => false,
                    'tags'            => false,
                    'homepage'        => false,
                    'screenshots'     => false,
                    'screenshot_url'  => false,
                    'parent'          => false,
                    'versions'        => false,
                    'extended_author' => false,
                ),
                'slugs'  => $theme_slugs,
            )
        );

        // If the API fails, return all installed themes.
        if ( is_wp_error( $api_response ) ) {
            return $all_themes;
        }

        $wp_org_themes = array_filter(
            $all_themes,
            function ( $theme ) use ( $api_response ) {
                $slug = $theme->get_stylesheet();
                return isset( $api_response->{$slug}['download_link'] );
            }
        );

        set_transient( self::INSTALLED_WP_ORG_THEMES_TRANSIENT, $wp_org_themes );
        return $wp_org_themes;
    }
}