<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* This file holds the abstract class for dealing with imports from other plugins.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WPSEO\Admin\Import\Plugins

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class WPSEO_Plugin_Importer.

[8] Fix | Delete

*

[9] Fix | Delete

* Class with functionality to import meta data from other plugins.

[10] Fix | Delete

*/

[11] Fix | Delete

abstract class WPSEO_Plugin_Importer {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Holds the import status object.

[15] Fix | Delete

*

[16] Fix | Delete

* @var WPSEO_Import_Status

[17] Fix | Delete

*/

[18] Fix | Delete

protected $status;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* The plugin name.

[22] Fix | Delete

*

[23] Fix | Delete

* @var string

[24] Fix | Delete

*/

[25] Fix | Delete

protected $plugin_name;

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Meta key, used in SQL LIKE clause for delete query.

[29] Fix | Delete

*

[30] Fix | Delete

* @var string

[31] Fix | Delete

*/

[32] Fix | Delete

protected $meta_key;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Array of meta keys to detect and import.

[36] Fix | Delete

*

[37] Fix | Delete

* @var array

[38] Fix | Delete

*/

[39] Fix | Delete

protected $clone_keys;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Class constructor.

[43] Fix | Delete

*/

[44] Fix | Delete

public function __construct() {}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Returns the string for the plugin we're importing from.

[48] Fix | Delete

*

[49] Fix | Delete

* @return string Plugin name.

[50] Fix | Delete

*/

[51] Fix | Delete

public function get_plugin_name() {

[52] Fix | Delete

return $this->plugin_name;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Imports the settings and post meta data from another SEO plugin.

[57] Fix | Delete

*

[58] Fix | Delete

* @return WPSEO_Import_Status Import status object.

[59] Fix | Delete

*/

[60] Fix | Delete

public function run_import() {

[61] Fix | Delete

$this->status = new WPSEO_Import_Status( 'import', false );

[62] Fix | Delete

[63] Fix | Delete

if ( ! $this->detect() ) {

[64] Fix | Delete

return $this->status;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

$this->status->set_status( $this->import() );

[68] Fix | Delete

[69] Fix | Delete

// Flush the entire cache, as we no longer know what's valid and what's not.

[70] Fix | Delete

wp_cache_flush();

[71] Fix | Delete

[72] Fix | Delete

return $this->status;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Handles post meta data to import.

[77] Fix | Delete

*

[78] Fix | Delete

* @return bool Import success status.

[79] Fix | Delete

*/

[80] Fix | Delete

protected function import() {

[81] Fix | Delete

return $this->meta_keys_clone( $this->clone_keys );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Removes the plugin data from the database.

[86] Fix | Delete

*

[87] Fix | Delete

* @return WPSEO_Import_Status Import status object.

[88] Fix | Delete

*/

[89] Fix | Delete

public function run_cleanup() {

[90] Fix | Delete

$this->status = new WPSEO_Import_Status( 'cleanup', false );

[91] Fix | Delete

[92] Fix | Delete

if ( ! $this->detect() ) {

[93] Fix | Delete

return $this->status;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

return $this->status->set_status( $this->cleanup() );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Removes the plugin data from the database.

[101] Fix | Delete

*

[102] Fix | Delete

* @return bool Cleanup status.

[103] Fix | Delete

*/

[104] Fix | Delete

protected function cleanup() {

[105] Fix | Delete

global $wpdb;

[106] Fix | Delete

if ( empty( $this->meta_key ) ) {

[107] Fix | Delete

return true;

[108] Fix | Delete

}

[109] Fix | Delete

$wpdb->query(

[110] Fix | Delete

$wpdb->prepare(

[111] Fix | Delete

"DELETE FROM {$wpdb->postmeta} WHERE meta_key LIKE %s",

[112] Fix | Delete

$this->meta_key

[113] Fix | Delete

)

[114] Fix | Delete

);

[115] Fix | Delete

$result = $wpdb->__get( 'result' );

[116] Fix | Delete

if ( ! $result ) {

[117] Fix | Delete

$this->cleanup_error_msg();

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

return $result;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Sets the status message for when a cleanup has gone bad.

[125] Fix | Delete

*

[126] Fix | Delete

* @return void

[127] Fix | Delete

*/

[128] Fix | Delete

protected function cleanup_error_msg() {

[129] Fix | Delete

/* translators: %s is replaced with the plugin's name. */

[130] Fix | Delete

$this->status->set_msg( sprintf( __( 'Cleanup of %s data failed.', 'wordpress-seo' ), $this->plugin_name ) );

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Detects whether an import for this plugin is needed.

[135] Fix | Delete

*

[136] Fix | Delete

* @return WPSEO_Import_Status Import status object.

[137] Fix | Delete

*/

[138] Fix | Delete

public function run_detect() {

[139] Fix | Delete

$this->status = new WPSEO_Import_Status( 'detect', false );

[140] Fix | Delete

[141] Fix | Delete

if ( ! $this->detect() ) {

[142] Fix | Delete

return $this->status;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return $this->status->set_status( true );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Detects whether there is post meta data to import.

[150] Fix | Delete

*

[151] Fix | Delete

* @return bool Boolean indicating whether there is something to import.

[152] Fix | Delete

*/

[153] Fix | Delete

protected function detect() {

[154] Fix | Delete

global $wpdb;

[155] Fix | Delete

[156] Fix | Delete

$meta_keys = wp_list_pluck( $this->clone_keys, 'old_key' );

[157] Fix | Delete

$result = $wpdb->get_var(

[158] Fix | Delete

$wpdb->prepare(

[159] Fix | Delete

"SELECT COUNT(*) AS `count`

[160] Fix | Delete

FROM {$wpdb->postmeta}

[161] Fix | Delete

WHERE meta_key IN ( " . implode( ', ', array_fill( 0, count( $meta_keys ), '%s' ) ) . ' )',

[162] Fix | Delete

$meta_keys

[163] Fix | Delete

)

[164] Fix | Delete

);

[165] Fix | Delete

[166] Fix | Delete

if ( $result === '0' ) {

[167] Fix | Delete

return false;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return true;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Helper function to clone meta keys and (optionally) change their values in bulk.

[175] Fix | Delete

*

[176] Fix | Delete

* @param string $old_key The existing meta key.

[177] Fix | Delete

* @param string $new_key The new meta key.

[178] Fix | Delete

* @param array $replace_values An array, keys old value, values new values.

[179] Fix | Delete

*

[180] Fix | Delete

* @return bool Clone status.

[181] Fix | Delete

*/

[182] Fix | Delete

protected function meta_key_clone( $old_key, $new_key, $replace_values = [] ) {

[183] Fix | Delete

global $wpdb;

[184] Fix | Delete

[185] Fix | Delete

// First we create a temp table with all the values for meta_key.

[186] Fix | Delete

$result = $wpdb->query(

[187] Fix | Delete

$wpdb->prepare(

[188] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.SchemaChange -- This is intentional + temporary.

[189] Fix | Delete

"CREATE TEMPORARY TABLE tmp_meta_table SELECT * FROM {$wpdb->postmeta} WHERE meta_key = %s",

[190] Fix | Delete

$old_key

[191] Fix | Delete

)

[192] Fix | Delete

);

[193] Fix | Delete

if ( $result === false ) {

[194] Fix | Delete

$this->set_missing_db_rights_status();

[195] Fix | Delete

return false;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

// Delete all the values in our temp table for posts that already have data for $new_key.

[199] Fix | Delete

$wpdb->query(

[200] Fix | Delete

$wpdb->prepare(

[201] Fix | Delete

"DELETE FROM tmp_meta_table WHERE post_id IN ( SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key = %s )",

[202] Fix | Delete

WPSEO_Meta::$meta_prefix . $new_key

[203] Fix | Delete

)

[204] Fix | Delete

);

[205] Fix | Delete

[206] Fix | Delete

/*

[207] Fix | Delete

* We set meta_id to NULL so on re-insert into the postmeta table, MYSQL can set

[208] Fix | Delete

* new meta_id's and we don't get duplicates.

[209] Fix | Delete

*/

[210] Fix | Delete

$wpdb->query( 'UPDATE tmp_meta_table SET meta_id = NULL' );

[211] Fix | Delete

[212] Fix | Delete

// Now we rename the meta_key.

[213] Fix | Delete

$wpdb->query(

[214] Fix | Delete

$wpdb->prepare(

[215] Fix | Delete

'UPDATE tmp_meta_table SET meta_key = %s',

[216] Fix | Delete

WPSEO_Meta::$meta_prefix . $new_key

[217] Fix | Delete

)

[218] Fix | Delete

);

[219] Fix | Delete

[220] Fix | Delete

$this->meta_key_clone_replace( $replace_values );

[221] Fix | Delete

[222] Fix | Delete

// With everything done, we insert all our newly cloned lines into the postmeta table.

[223] Fix | Delete

$wpdb->query( "INSERT INTO {$wpdb->postmeta} SELECT * FROM tmp_meta_table" );

[224] Fix | Delete

[225] Fix | Delete

// Now we drop our temporary table.

[226] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.SchemaChange -- This is intentional + a temporary table.

[227] Fix | Delete

$wpdb->query( 'DROP TEMPORARY TABLE IF EXISTS tmp_meta_table' );

[228] Fix | Delete

[229] Fix | Delete

return true;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Clones multiple meta keys.

[234] Fix | Delete

*

[235] Fix | Delete

* @param array $clone_keys The keys to clone.

[236] Fix | Delete

*

[237] Fix | Delete

* @return bool Success status.

[238] Fix | Delete

*/

[239] Fix | Delete

protected function meta_keys_clone( $clone_keys ) {

[240] Fix | Delete

foreach ( $clone_keys as $clone_key ) {

[241] Fix | Delete

$result = $this->meta_key_clone( $clone_key['old_key'], $clone_key['new_key'], ( $clone_key['convert'] ?? [] ) );

[242] Fix | Delete

if ( ! $result ) {

[243] Fix | Delete

return false;

[244] Fix | Delete

}

[245] Fix | Delete

}

[246] Fix | Delete

return true;

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Sets the import status to false and returns a message about why it failed.

[251] Fix | Delete

*

[252] Fix | Delete

* @return void

[253] Fix | Delete

*/

[254] Fix | Delete

protected function set_missing_db_rights_status() {

[255] Fix | Delete

$this->status->set_status( false );

[256] Fix | Delete

/* translators: %s is replaced with Yoast SEO. */

[257] Fix | Delete

$this->status->set_msg( sprintf( __( 'The %s importer functionality uses temporary database tables. It seems your WordPress install does not have the capability to do this, please consult your hosting provider.', 'wordpress-seo' ), 'Yoast SEO' ) );

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Helper function to search for a key in an array and maybe save it as a meta field.

[262] Fix | Delete

*

[263] Fix | Delete

* @param string $plugin_key The key in the $data array to check.

[264] Fix | Delete

* @param string $yoast_key The identifier we use in our meta settings.

[265] Fix | Delete

* @param array $data The array of data for this post to sift through.

[266] Fix | Delete

* @param int $post_id The post ID.

[267] Fix | Delete

*

[268] Fix | Delete

* @return void

[269] Fix | Delete

*/

[270] Fix | Delete

protected function import_meta_helper( $plugin_key, $yoast_key, $data, $post_id ) {

[271] Fix | Delete

if ( ! empty( $data[ $plugin_key ] ) ) {

[272] Fix | Delete

$this->maybe_save_post_meta( $yoast_key, $data[ $plugin_key ], $post_id );

[273] Fix | Delete

}

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Saves a post meta value if it doesn't already exist.

[278] Fix | Delete

*

[279] Fix | Delete

* @param string $new_key The key to save.

[280] Fix | Delete

* @param mixed $value The value to set the key to.

[281] Fix | Delete

* @param int $post_id The Post to save the meta for.

[282] Fix | Delete

*

[283] Fix | Delete

* @return void

[284] Fix | Delete

*/

[285] Fix | Delete

protected function maybe_save_post_meta( $new_key, $value, $post_id ) {

[286] Fix | Delete

// Big. Fat. Sigh. Mostly used for _yst_is_cornerstone, but might be useful for other hidden meta's.

[287] Fix | Delete

$key = WPSEO_Meta::$meta_prefix . $new_key;

[288] Fix | Delete

$wpseo_meta = true;

[289] Fix | Delete

if ( substr( $new_key, 0, 1 ) === '_' ) {

[290] Fix | Delete

$key = $new_key;

[291] Fix | Delete

$wpseo_meta = false;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

$existing_value = get_post_meta( $post_id, $key, true );

[295] Fix | Delete

if ( empty( $existing_value ) ) {

[296] Fix | Delete

if ( $wpseo_meta ) {

[297] Fix | Delete

WPSEO_Meta::set_value( $new_key, $value, $post_id );

[298] Fix | Delete

return;

[299] Fix | Delete

}

[300] Fix | Delete

update_post_meta( $post_id, $new_key, $value );

[301] Fix | Delete

}

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Replaces values in our temporary table according to our settings.

[306] Fix | Delete

*

[307] Fix | Delete

* @param array $replace_values Key value pair of values to replace with other values.

[308] Fix | Delete

*

[309] Fix | Delete

* @return void

[310] Fix | Delete

*/

[311] Fix | Delete

protected function meta_key_clone_replace( $replace_values ) {

[312] Fix | Delete

global $wpdb;

[313] Fix | Delete

[314] Fix | Delete

// Now we replace values if needed.

[315] Fix | Delete

if ( is_array( $replace_values ) && $replace_values !== [] ) {

[316] Fix | Delete

foreach ( $replace_values as $old_value => $new_value ) {

[317] Fix | Delete

$wpdb->query(

[318] Fix | Delete

$wpdb->prepare(

[319] Fix | Delete

'UPDATE tmp_meta_table SET meta_value = %s WHERE meta_value = %s',

[320] Fix | Delete

$new_value,

[321] Fix | Delete

$old_value

[322] Fix | Delete

)

[323] Fix | Delete

);

[324] Fix | Delete

}

[325] Fix | Delete

}

[326] Fix | Delete

}

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete