<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Integrations\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WPSEO_Admin_Asset_Manager;

[4] Fix | Delete

use Yoast\WP\SEO\Conditionals\Import_Tool_Selected_Conditional;

[5] Fix | Delete

use Yoast\WP\SEO\Conditionals\Yoast_Tools_Page_Conditional;

[6] Fix | Delete

use Yoast\WP\SEO\Integrations\Integration_Interface;

[7] Fix | Delete

use Yoast\WP\SEO\Presenters\Admin\Alert_Presenter;

[8] Fix | Delete

use Yoast\WP\SEO\Routes\Importing_Route;

[9] Fix | Delete

use Yoast\WP\SEO\Services\Importing\Importable_Detector_Service;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Loads import script when on the Tool's page.

[13] Fix | Delete

*/

[14] Fix | Delete

class Import_Integration implements Integration_Interface {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Contains the asset manager.

[18] Fix | Delete

*

[19] Fix | Delete

* @var WPSEO_Admin_Asset_Manager

[20] Fix | Delete

*/

[21] Fix | Delete

protected $asset_manager;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* The Importable Detector service.

[25] Fix | Delete

*

[26] Fix | Delete

* @var Importable_Detector_Service

[27] Fix | Delete

*/

[28] Fix | Delete

protected $importable_detector;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* The Importing Route class.

[32] Fix | Delete

*

[33] Fix | Delete

* @var Importing_Route

[34] Fix | Delete

*/

[35] Fix | Delete

protected $importing_route;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Returns the conditionals based on which this loadable should be active.

[39] Fix | Delete

*

[40] Fix | Delete

* @return array

[41] Fix | Delete

*/

[42] Fix | Delete

public static function get_conditionals() {

[43] Fix | Delete

return [

[44] Fix | Delete

Import_Tool_Selected_Conditional::class,

[45] Fix | Delete

Yoast_Tools_Page_Conditional::class,

[46] Fix | Delete

];

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Import Integration constructor.

[51] Fix | Delete

*

[52] Fix | Delete

* @param WPSEO_Admin_Asset_Manager $asset_manager The asset manager.

[53] Fix | Delete

* @param Importable_Detector_Service $importable_detector The importable detector.

[54] Fix | Delete

* @param Importing_Route $importing_route The importing route.

[55] Fix | Delete

*/

[56] Fix | Delete

public function __construct(

[57] Fix | Delete

WPSEO_Admin_Asset_Manager $asset_manager,

[58] Fix | Delete

Importable_Detector_Service $importable_detector,

[59] Fix | Delete

Importing_Route $importing_route

[60] Fix | Delete

) {

[61] Fix | Delete

$this->asset_manager = $asset_manager;

[62] Fix | Delete

$this->importable_detector = $importable_detector;

[63] Fix | Delete

$this->importing_route = $importing_route;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Initializes the integration.

[68] Fix | Delete

*

[69] Fix | Delete

* This is the place to register hooks and filters.

[70] Fix | Delete

*

[71] Fix | Delete

* @return void

[72] Fix | Delete

*/

[73] Fix | Delete

public function register_hooks() {

[74] Fix | Delete

\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_import_script' ] );

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Enqueues the Import script.

[79] Fix | Delete

*

[80] Fix | Delete

* @return void

[81] Fix | Delete

*/

[82] Fix | Delete

public function enqueue_import_script() {

[83] Fix | Delete

\wp_enqueue_style( 'dashicons' );

[84] Fix | Delete

$this->asset_manager->enqueue_script( 'import' );

[85] Fix | Delete

[86] Fix | Delete

$data = [

[87] Fix | Delete

'restApi' => [

[88] Fix | Delete

'root' => \esc_url_raw( \rest_url() ),

[89] Fix | Delete

'cleanup_endpoints' => $this->get_cleanup_endpoints(),

[90] Fix | Delete

'importing_endpoints' => $this->get_importing_endpoints(),

[91] Fix | Delete

'nonce' => \wp_create_nonce( 'wp_rest' ),

[92] Fix | Delete

],

[93] Fix | Delete

'assets' => [

[94] Fix | Delete

'loading_msg_import' => \esc_html__( 'The import can take a long time depending on your site\'s size.', 'wordpress-seo' ),

[95] Fix | Delete

'loading_msg_cleanup' => \esc_html__( 'The cleanup can take a long time depending on your site\'s size.', 'wordpress-seo' ),

[96] Fix | Delete

'note' => \esc_html__( 'Note: ', 'wordpress-seo' ),

[97] Fix | Delete

'cleanup_after_import_msg' => \esc_html__( 'After you\'ve imported data from another SEO plugin, please make sure to clean up all the original data from that plugin. (step 5)', 'wordpress-seo' ),

[98] Fix | Delete

'select_placeholder' => \esc_html__( 'Select SEO plugin', 'wordpress-seo' ),

[99] Fix | Delete

'no_data_msg' => \esc_html__( 'No data found from other SEO plugins.', 'wordpress-seo' ),

[100] Fix | Delete

'validation_failure' => $this->get_validation_failure_alert(),

[101] Fix | Delete

'import_failure' => $this->get_import_failure_alert( true ),

[102] Fix | Delete

'cleanup_failure' => $this->get_import_failure_alert( false ),

[103] Fix | Delete

'spinner' => \admin_url( 'images/loading.gif' ),

[104] Fix | Delete

'replacing_texts' => [

[105] Fix | Delete

'cleanup_button' => \esc_html__( 'Clean up', 'wordpress-seo' ),

[106] Fix | Delete

'import_explanation' => \esc_html__( 'Please select an SEO plugin below to see what data can be imported.', 'wordpress-seo' ),

[107] Fix | Delete

'cleanup_explanation' => \esc_html__( 'Once you\'re certain that your site is working properly with the imported data from another SEO plugin, you can clean up all the original data from that plugin.', 'wordpress-seo' ),

[108] Fix | Delete

/* translators: %s: expands to the name of the plugin that is selected to be imported */

[109] Fix | Delete

'select_header' => \esc_html__( 'The import from %s includes:', 'wordpress-seo' ),

[110] Fix | Delete

'plugins' => [

[111] Fix | Delete

'aioseo' => [

[112] Fix | Delete

[

[113] Fix | Delete

'data_name' => \esc_html__( 'Post metadata (SEO titles, descriptions, etc.)', 'wordpress-seo' ),

[114] Fix | Delete

'data_note' => \esc_html__( 'Note: This metadata will only be imported if there is no existing Yoast SEO metadata yet.', 'wordpress-seo' ),

[115] Fix | Delete

],

[116] Fix | Delete

[

[117] Fix | Delete

'data_name' => \esc_html__( 'Default settings', 'wordpress-seo' ),

[118] Fix | Delete

'data_note' => \esc_html__( 'Note: These settings will overwrite the default settings of Yoast SEO.', 'wordpress-seo' ),

[119] Fix | Delete

],

[120] Fix | Delete

],

[121] Fix | Delete

'other' => [

[122] Fix | Delete

[

[123] Fix | Delete

'data_name' => \esc_html__( 'Post metadata (SEO titles, descriptions, etc.)', 'wordpress-seo' ),

[124] Fix | Delete

'data_note' => \esc_html__( 'Note: This metadata will only be imported if there is no existing Yoast SEO metadata yet.', 'wordpress-seo' ),

[125] Fix | Delete

],

[126] Fix | Delete

],

[127] Fix | Delete

],

[128] Fix | Delete

],

[129] Fix | Delete

],

[130] Fix | Delete

];

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Filter: 'wpseo_importing_data' Filter to adapt the data used in the import process.

[134] Fix | Delete

*

[135] Fix | Delete

* @param array $data The import data to adapt.

[136] Fix | Delete

*/

[137] Fix | Delete

$data = \apply_filters( 'wpseo_importing_data', $data );

[138] Fix | Delete

[139] Fix | Delete

$this->asset_manager->localize_script( 'import', 'yoastImportData', $data );

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* Retrieves a list of the importing endpoints to use.

[144] Fix | Delete

*

[145] Fix | Delete

* @return array The endpoints.

[146] Fix | Delete

*/

[147] Fix | Delete

protected function get_importing_endpoints() {

[148] Fix | Delete

$available_actions = $this->importable_detector->detect_importers();

[149] Fix | Delete

$importing_endpoints = [];

[150] Fix | Delete

[151] Fix | Delete

$available_sorted_actions = $this->sort_actions( $available_actions );

[152] Fix | Delete

[153] Fix | Delete

foreach ( $available_sorted_actions as $plugin => $types ) {

[154] Fix | Delete

foreach ( $types as $type ) {

[155] Fix | Delete

$importing_endpoints[ $plugin ][] = $this->importing_route->get_endpoint( $plugin, $type );

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

return $importing_endpoints;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Sorts the array of importing actions, by moving any validating actions to the start for every plugin.

[164] Fix | Delete

*

[165] Fix | Delete

* @param array $available_actions The array of actions that we want to sort.

[166] Fix | Delete

*

[167] Fix | Delete

* @return array The sorted array of actions.

[168] Fix | Delete

*/

[169] Fix | Delete

protected function sort_actions( $available_actions ) {

[170] Fix | Delete

$first_action = 'validate_data';

[171] Fix | Delete

$available_sorted_actions = [];

[172] Fix | Delete

[173] Fix | Delete

foreach ( $available_actions as $plugin => $plugin_available_actions ) {

[174] Fix | Delete

[175] Fix | Delete

$validate_action_position = \array_search( $first_action, $plugin_available_actions, true );

[176] Fix | Delete

[177] Fix | Delete

if ( ! empty( $validate_action_position ) ) {

[178] Fix | Delete

unset( $plugin_available_actions[ $validate_action_position ] );

[179] Fix | Delete

\array_unshift( $plugin_available_actions, $first_action );

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

$available_sorted_actions[ $plugin ] = $plugin_available_actions;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

return $available_sorted_actions;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Retrieves a list of the importing endpoints to use.

[190] Fix | Delete

*

[191] Fix | Delete

* @return array The endpoints.

[192] Fix | Delete

*/

[193] Fix | Delete

protected function get_cleanup_endpoints() {

[194] Fix | Delete

$available_actions = $this->importable_detector->detect_cleanups();

[195] Fix | Delete

$importing_endpoints = [];

[196] Fix | Delete

[197] Fix | Delete

foreach ( $available_actions as $plugin => $types ) {

[198] Fix | Delete

foreach ( $types as $type ) {

[199] Fix | Delete

$importing_endpoints[ $plugin ][] = $this->importing_route->get_endpoint( $plugin, $type );

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

return $importing_endpoints;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* Gets the validation failure alert using the Alert_Presenter.

[208] Fix | Delete

*

[209] Fix | Delete

* @return string The validation failure alert.

[210] Fix | Delete

*/

[211] Fix | Delete

protected function get_validation_failure_alert() {

[212] Fix | Delete

$content = \esc_html__( 'The AIOSEO import was cancelled because some AIOSEO data is missing. Please try and take the following steps to fix this:', 'wordpress-seo' );

[213] Fix | Delete

$content .= '<br/>';

[214] Fix | Delete

$content .= '<ol><li>';

[215] Fix | Delete

$content .= \esc_html__( 'If you have never saved any AIOSEO \'Search Appearance\' settings, please do that first and run the import again.', 'wordpress-seo' );

[216] Fix | Delete

$content .= '</li>';

[217] Fix | Delete

$content .= '<li>';

[218] Fix | Delete

$content .= \esc_html__( 'If you already have saved AIOSEO \'Search Appearance\' settings and the issue persists, please contact our support team so we can take a closer look.', 'wordpress-seo' );

[219] Fix | Delete

$content .= '</li></ol>';

[220] Fix | Delete

[221] Fix | Delete

$validation_failure_alert = new Alert_Presenter( $content, 'error' );

[222] Fix | Delete

[223] Fix | Delete

return $validation_failure_alert->present();

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Gets the import failure alert using the Alert_Presenter.

[228] Fix | Delete

*

[229] Fix | Delete

* @param bool $is_import Wether it's an import or not.

[230] Fix | Delete

*

[231] Fix | Delete

* @return string The import failure alert.

[232] Fix | Delete

*/

[233] Fix | Delete

protected function get_import_failure_alert( $is_import ) {

[234] Fix | Delete

$content = \esc_html__( 'Cleanup failed with the following error:', 'wordpress-seo' );

[235] Fix | Delete

if ( $is_import ) {

[236] Fix | Delete

$content = \esc_html__( 'Import failed with the following error:', 'wordpress-seo' );

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

$content .= '<br/><br/>';

[240] Fix | Delete

$content .= \esc_html( '%s' );

[241] Fix | Delete

[242] Fix | Delete

$import_failure_alert = new Alert_Presenter( $content, 'error' );

[243] Fix | Delete

[244] Fix | Delete

return $import_failure_alert->present();

[245] Fix | Delete

}

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete