Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

use WPML\Upgrade\CommandsStatus;

[2] Fix | Delete

[3] Fix | Delete

class WPML_Upgrade {

[4] Fix | Delete

const SCOPE_ADMIN = 'admin';

[5] Fix | Delete

const SCOPE_AJAX = 'ajax';

[6] Fix | Delete

const SCOPE_FRONT_END = 'front-end';

[7] Fix | Delete

[8] Fix | Delete

/** @var array */

[9] Fix | Delete

private $commands;

[10] Fix | Delete

const UPDATE_STATUSES_KEY = 'wpml_update_statuses';

[11] Fix | Delete

[12] Fix | Delete

/** @var SitePress */

[13] Fix | Delete

private $sitepress;

[14] Fix | Delete

[15] Fix | Delete

/** @var WPML_Upgrade_Command_Factory */

[16] Fix | Delete

private $command_factory;

[17] Fix | Delete

[18] Fix | Delete

/** @var CommandsStatus */

[19] Fix | Delete

private $command_status;

[20] Fix | Delete

[21] Fix | Delete

/** @var bool $upgrade_in_progress */

[22] Fix | Delete

private $upgrade_in_progress;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* WPML_Upgrade constructor.

[26] Fix | Delete

[27] Fix | Delete

* @param array $commands

[28] Fix | Delete

* @param SitePress $sitepress

[29] Fix | Delete

* @param WPML_Upgrade_Command_Factory $command_factory

[30] Fix | Delete

* @param CommandsStatus $command_status

[31] Fix | Delete

[32] Fix | Delete

public function __construct(

[33] Fix | Delete

array $commands,

[34] Fix | Delete

SitePress $sitepress,

[35] Fix | Delete

WPML_Upgrade_Command_Factory $command_factory,

[36] Fix | Delete

CommandsStatus $command_status = null

[37] Fix | Delete

) {

[38] Fix | Delete

$this->add_commands( $commands );

[39] Fix | Delete

$this->sitepress = $sitepress;

[40] Fix | Delete

$this->command_factory = $command_factory;

[41] Fix | Delete

$this->command_status = $command_status ?: new CommandsStatus();

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* @param array $commands

[46] Fix | Delete

[47] Fix | Delete

public function add_commands( array $commands ) {

[48] Fix | Delete

foreach ( $commands as $command ) {

[49] Fix | Delete

if ( $command instanceof WPML_Upgrade_Command_Definition ) {

[50] Fix | Delete

$this->commands[] = $command;

[51] Fix | Delete

}

[52] Fix | Delete

}

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

public function run() {

[56] Fix | Delete

$result = false;

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Add commands to the upgrade logic.

[60] Fix | Delete

[61] Fix | Delete

* The filter must be added before the `wpml_loaded` action is fired (the action is fired on `plugins_loaded`).

[62] Fix | Delete

[63] Fix | Delete

* @param array $commands An empty array.

[64] Fix | Delete

* @param array $new_commands Array of classes created with \wpml_create_upgrade_command_definition.

[65] Fix | Delete

[66] Fix | Delete

* @since 4.1.0

[67] Fix | Delete

* @see \wpml_create_upgrade_command_definition

[68] Fix | Delete

[69] Fix | Delete

[70] Fix | Delete

$new_commands = apply_filters( 'wpml_upgrade_commands', array() );

[71] Fix | Delete

if ( $new_commands && is_array( $new_commands ) ) {

[72] Fix | Delete

$this->add_commands( $new_commands );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

if ( $this->sitepress->get_wp_api()->is_admin() ) {

[76] Fix | Delete

if ( $this->sitepress->get_wp_api()->is_ajax() ) {

[77] Fix | Delete

$result = $this->run_ajax();

[78] Fix | Delete

} else {

[79] Fix | Delete

$result = $this->run_admin();

[80] Fix | Delete

}

[81] Fix | Delete

} elseif ( $this->sitepress->get_wp_api()->is_front_end() ) {

[82] Fix | Delete

$result = $this->run_front_end();

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

$this->set_upgrade_completed();

[86] Fix | Delete

[87] Fix | Delete

return $result;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

private function get_commands_by_scope( $scope ) {

[91] Fix | Delete

$results = array();

[92] Fix | Delete

/** @var WPML_Upgrade_Command_Definition $command */

[93] Fix | Delete

foreach ( $this->commands as $command ) {

[94] Fix | Delete

if ( in_array( $scope, $command->get_scopes(), true ) ) {

[95] Fix | Delete

$results[] = $command;

[96] Fix | Delete

}

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return $results;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

private function get_admin_commands() {

[103] Fix | Delete

return $this->get_commands_by_scope( self::SCOPE_ADMIN );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

private function get_ajax_commands() {

[107] Fix | Delete

return $this->get_commands_by_scope( self::SCOPE_AJAX );

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

private function get_front_end_commands() {

[111] Fix | Delete

return $this->get_commands_by_scope( self::SCOPE_FRONT_END );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

private function run_admin() {

[115] Fix | Delete

return $this->run_commands( $this->get_admin_commands(), 'maybe_run_admin' );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

private function run_ajax() {

[119] Fix | Delete

return $this->run_commands( $this->get_ajax_commands(), 'maybe_run_ajax' );

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

private function run_front_end() {

[123] Fix | Delete

return $this->run_commands( $this->get_front_end_commands(), 'maybe_run_front_end' );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

private function run_commands( $commands, $default ) {

[127] Fix | Delete

$results = array();

[128] Fix | Delete

/** @var WPML_Upgrade_Command_Definition $command */

[129] Fix | Delete

foreach ( $commands as $command ) {

[130] Fix | Delete

$results[] = $this->run_command( $command, $default );

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

return $results;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

private function run_command( WPML_Upgrade_Command_Definition $command_definition, $default ) {

[137] Fix | Delete

$method = $default;

[138] Fix | Delete

if ( $command_definition->get_method() ) {

[139] Fix | Delete

$method = $command_definition->get_method();

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

if ( ! $this->command_status->hasBeenExecuted( $command_definition->get_class_name() ) ) {

[143] Fix | Delete

$this->set_upgrade_in_progress();

[144] Fix | Delete

$upgrade = $command_definition->create();

[145] Fix | Delete

[146] Fix | Delete

return $this->$method( $upgrade );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return null;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/** @noinspection PhpUnusedPrivateMethodInspection

[153] Fix | Delete

* @param IWPML_Upgrade_Command $upgrade

[154] Fix | Delete

[155] Fix | Delete

* @return null

[156] Fix | Delete

[157] Fix | Delete

private function maybe_run_admin( IWPML_Upgrade_Command $upgrade ) {

[158] Fix | Delete

if ( $upgrade->run_admin() ) {

[159] Fix | Delete

$this->mark_command_as_executed( $upgrade );

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

return $upgrade->get_results();

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/** @noinspection PhpUnusedPrivateMethodInspection

[166] Fix | Delete

* @param IWPML_Upgrade_Command $upgrade

[167] Fix | Delete

[168] Fix | Delete

* @return null

[169] Fix | Delete

[170] Fix | Delete

private function maybe_run_front_end( IWPML_Upgrade_Command $upgrade ) {

[171] Fix | Delete

if ( $upgrade->run_frontend() ) {

[172] Fix | Delete

$this->mark_command_as_executed( $upgrade );

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

return $upgrade->get_results();

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/** @noinspection PhpUnusedPrivateMethodInspection

[179] Fix | Delete

* @param IWPML_Upgrade_Command $upgrade

[180] Fix | Delete

[181] Fix | Delete

* @return null

[182] Fix | Delete

[183] Fix | Delete

private function maybe_run_ajax( IWPML_Upgrade_Command $upgrade ) {

[184] Fix | Delete

if ( $this->nonce_ok( $upgrade ) && $upgrade->run_ajax() ) {

[185] Fix | Delete

$this->mark_command_as_executed( $upgrade );

[186] Fix | Delete

$this->sitepress->get_wp_api()->wp_send_json_success( '' );

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

return $upgrade->get_results();

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

private function nonce_ok( $class ) {

[193] Fix | Delete

$ok = false;

[194] Fix | Delete

[195] Fix | Delete

$class_name = $this->get_command_id( get_class( $class ) );

[196] Fix | Delete

if ( isset( $_POST['action'] ) && $_POST['action'] === $class_name ) {

[197] Fix | Delete

$nonce = filter_input( INPUT_POST, 'nonce', FILTER_SANITIZE_FULL_SPECIAL_CHARS );

[198] Fix | Delete

if ( $this->sitepress->get_wp_api()->wp_verify_nonce( $nonce, $class_name . '-nonce' ) ) {

[199] Fix | Delete

$ok = true;

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

return $ok;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* @param IWPML_Upgrade_Command $class

[208] Fix | Delete

[209] Fix | Delete

public function mark_command_as_executed( IWPML_Upgrade_Command $class ) {

[210] Fix | Delete

$this->command_status->markAsExecuted( get_class( $class ) );

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* @param string $class_name

[215] Fix | Delete

[216] Fix | Delete

* @return string

[217] Fix | Delete

[218] Fix | Delete

private function get_command_id( $class_name ) {

[219] Fix | Delete

return str_replace( '_', '-', strtolower( $class_name ) );

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

private function set_upgrade_in_progress() {

[223] Fix | Delete

if ( ! $this->upgrade_in_progress ) {

[224] Fix | Delete

$this->upgrade_in_progress = true;

[225] Fix | Delete

set_transient( WPML_Upgrade_Loader::TRANSIENT_UPGRADE_IN_PROGRESS, true, MINUTE_IN_SECONDS );

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

private function set_upgrade_completed() {

[230] Fix | Delete

if ( $this->upgrade_in_progress ) {

[231] Fix | Delete

$this->upgrade_in_progress = false;

[232] Fix | Delete

delete_transient( WPML_Upgrade_Loader::TRANSIENT_UPGRADE_IN_PROGRESS );

[233] Fix | Delete

}

[234] Fix | Delete

}

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

[238] Fix | Delete