Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

[2] Fix | Delete

abstract class ET_Builder_Module_Settings_Migration {

[3] Fix | Delete

[4] Fix | Delete

protected static $_bb_excluded_name_changes = array();

[5] Fix | Delete

[6] Fix | Delete

public static $field_name_migrations = array();

[7] Fix | Delete

[8] Fix | Delete

public static $hooks = array(

[9] Fix | Delete

'the_content',

[10] Fix | Delete

'admin_enqueue_scripts',

[11] Fix | Delete

'et_pb_get_backbone_templates',

[12] Fix | Delete

'wp_ajax_et_pb_execute_content_shortcodes',

[13] Fix | Delete

'wp_ajax_et_fb_get_saved_layouts',

[14] Fix | Delete

'wp_ajax_et_fb_retrieve_builder_data',

[15] Fix | Delete

);

[16] Fix | Delete

[17] Fix | Delete

public static $last_hook_checked;

[18] Fix | Delete

public static $last_hook_check_decision;

[19] Fix | Delete

public static $max_version = '3.27.4';

[20] Fix | Delete

[21] Fix | Delete

public static $migrated = array();

[22] Fix | Delete

public static $migrations = array(

[23] Fix | Delete

'3.0.48' => 'BackgroundUI',

[24] Fix | Delete

'3.0.72' => 'Animation',

[25] Fix | Delete

'3.0.74' => 'OptionsHarmony',

[26] Fix | Delete

'3.0.84' => 'FullwidthHeader',

[27] Fix | Delete

'3.0.87' => 'BorderOptions',

[28] Fix | Delete

'3.0.91' => 'FilterOptions',

[29] Fix | Delete

'3.0.92' => 'ShopModuleSlugs',

[30] Fix | Delete

'3.0.94' => 'DropShadowToBoxShadow',

[31] Fix | Delete

'3.0.99' => 'InnerShadowToBoxShadow',

[32] Fix | Delete

'3.0.102' => 'FullwidthHeader2',

[33] Fix | Delete

'3.2' => 'UIImprovements',

[34] Fix | Delete

'3.4' => 'EmailOptinContent',

[35] Fix | Delete

'3.6' => 'ContactFormItemOptionsSerialization',

[36] Fix | Delete

'3.12.3' => 'TeamMemberIconHover',

[37] Fix | Delete

'3.16' => 'HoverOptions',

[38] Fix | Delete

'3.17.3' => 'DiscontinueHtmlEncoding',

[39] Fix | Delete

'3.22' => 'RowCustomWidthToSizing',

[40] Fix | Delete

'3.22.3' => 'RowZeroGutter',

[41] Fix | Delete

'3.23' => 'OptionsHarmony2',

[42] Fix | Delete

'3.23.4' => 'DividerHeight',

[43] Fix | Delete

'3.25' => 'ColumnOptions',

[44] Fix | Delete

'3.25.3' => 'ShopOrderByDefault',

[45] Fix | Delete

'3.27.4' => 'TextAlignment',

[46] Fix | Delete

);

[47] Fix | Delete

[48] Fix | Delete

public static $migrations_by_version = array();

[49] Fix | Delete

[50] Fix | Delete

public $fields;

[51] Fix | Delete

public $modules;

[52] Fix | Delete

public $version;

[53] Fix | Delete

public $add_missing_fields = false;

[54] Fix | Delete

[55] Fix | Delete

public function __construct() {

[56] Fix | Delete

$this->fields = $this->get_fields();

[57] Fix | Delete

$this->modules = $this->get_modules();

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

protected static function _migrate_field_names( $fields, $module_slug, $version ) {

[61] Fix | Delete

foreach ( self::$field_name_migrations[ $module_slug ] as $new_name => $old_names ) {

[62] Fix | Delete

foreach ( $old_names as $old_name ) {

[63] Fix | Delete

if ( ! isset( $fields[ $old_name ] ) ) {

[64] Fix | Delete

// Add old to-be-migrated attribute as skipped field if it doesn't exist so its value can be used.

[65] Fix | Delete

$fields[ $old_name ] = array( 'type' => 'skip' );

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

// For the BB...

[69] Fix | Delete

if ( ! in_array( $old_name, self::$_bb_excluded_name_changes ) ) {

[70] Fix | Delete

self::$migrated['field_name_changes'][ $module_slug ][ $old_name ] = array(

[71] Fix | Delete

'new_name' => $new_name,

[72] Fix | Delete

'version' => $version,

[73] Fix | Delete

);

[74] Fix | Delete

}

[75] Fix | Delete

}

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return $fields;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

abstract public function get_fields();

[82] Fix | Delete

[83] Fix | Delete

public static function get_migrations( $module_version ) {

[84] Fix | Delete

if ( isset( self::$migrations_by_version[ $module_version ] ) ) {

[85] Fix | Delete

return self::$migrations_by_version[ $module_version ];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

self::$migrations_by_version[ $module_version ] = array();

[89] Fix | Delete

[90] Fix | Delete

if ( 'all' !== $module_version && version_compare( $module_version, self::$max_version, '>=' ) ) {

[91] Fix | Delete

return array();

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

foreach ( self::$migrations as $version => $migration ) {

[95] Fix | Delete

if ( 'all' !== $module_version && version_compare( $module_version, $version, '>=' ) ) {

[96] Fix | Delete

continue;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

if ( is_string( $migration ) ) {

[100] Fix | Delete

self::$migrations[ $version ] = $migration = require_once "migration/{$migration}.php";

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

self::$migrations_by_version[ $module_version ][] = $migration;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

return self::$migrations_by_version[ $module_version ];

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

abstract public function get_modules();

[110] Fix | Delete

[111] Fix | Delete

public function get_content_migration_modules() {

[112] Fix | Delete

return array();

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

public function handle_field_name_migrations( $fields, $module_slug ) {

[116] Fix | Delete

if ( ! in_array( $module_slug, $this->modules ) ) {

[117] Fix | Delete

return $fields;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

foreach ( $this->fields as $field_name => $field_info ) {

[121] Fix | Delete

foreach ( $field_info['affected_fields'] as $affected_field => $affected_modules ) {

[122] Fix | Delete

[123] Fix | Delete

if ( $affected_field === $field_name || ! in_array( $module_slug, $affected_modules ) ) {

[124] Fix | Delete

continue;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

foreach ( $affected_modules as $affected_module ) {

[128] Fix | Delete

if ( ! isset( self::$field_name_migrations[ $affected_module ][ $field_name ] ) ) {

[129] Fix | Delete

self::$field_name_migrations[ $affected_module ][ $field_name ] = array();

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

self::$field_name_migrations[ $affected_module ][ $field_name ][] = $affected_field;

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return isset( self::$field_name_migrations[ $module_slug ] )

[138] Fix | Delete

? self::_migrate_field_names( $fields, $module_slug, $this->version )

[139] Fix | Delete

: $fields;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

public static function init() {

[143] Fix | Delete

$class = 'ET_Builder_Module_Settings_Migration';

[144] Fix | Delete

[145] Fix | Delete

add_filter( 'et_pb_module_processed_fields', array( $class, 'maybe_override_processed_fields' ), 10, 2 );

[146] Fix | Delete

add_filter( 'et_pb_module_shortcode_attributes', array( $class, 'maybe_override_shortcode_attributes' ), 10, 5 );

[147] Fix | Delete

add_filter( 'et_pb_module_content', array( $class, 'maybe_override_content' ), 10, 6 );

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

public static function maybe_override_processed_fields( $fields, $module_slug ) {

[151] Fix | Delete

if ( ! $fields ) {

[152] Fix | Delete

return $fields;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

$migrations = self::get_migrations( 'all' );

[156] Fix | Delete

[157] Fix | Delete

foreach ( $migrations as $migration ) {

[158] Fix | Delete

if ( in_array( $module_slug, $migration->modules ) ) {

[159] Fix | Delete

$fields = $migration->handle_field_name_migrations( $fields, $module_slug );

[160] Fix | Delete

}

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

return $fields;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

public static function maybe_override_shortcode_attributes( $attrs, $unprocessed_attrs, $module_slug, $module_address, $content = '' ) {

[167] Fix | Delete

if ( empty( $attrs['_builder_version'] ) ) {

[168] Fix | Delete

$attrs['_builder_version'] = '3.0.47';

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

if ( ! self::_should_handle_render( $module_slug ) ) {

[172] Fix | Delete

return $attrs;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

if ( ! is_array( $unprocessed_attrs ) ) {

[176] Fix | Delete

$unprocessed_attrs = array();

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

$migrations = self::get_migrations( $attrs['_builder_version'] );

[180] Fix | Delete

[181] Fix | Delete

// Register address-based name module's field name change

[182] Fix | Delete

if ( isset( self::$migrated['field_name_changes'] ) && isset( self::$migrated['field_name_changes'][ $module_slug ] ) ) {

[183] Fix | Delete

foreach ( self::$migrated['field_name_changes'][ $module_slug ] as $old_name => $name_change ) {

[184] Fix | Delete

if ( version_compare( $attrs['_builder_version'], $name_change['version'], '<' ) ) {

[185] Fix | Delete

self::$migrated['name_changes'][ $module_address ][ $old_name ] = $name_change['new_name'];

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

foreach ( $migrations as $migration ) {

[191] Fix | Delete

$migrated_attrs_count = 0;

[192] Fix | Delete

[193] Fix | Delete

if ( ! in_array( $module_slug, $migration->modules ) ) {

[194] Fix | Delete

continue;

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

foreach ( $migration->fields as $field_name => $field_info ) {

[198] Fix | Delete

foreach ( $field_info['affected_fields'] as $affected_field => $affected_modules ) {

[199] Fix | Delete

[200] Fix | Delete

if ( ( ! $migration->add_missing_fields && ! isset( $attrs[ $affected_field ] ) ) || ! in_array( $module_slug, $affected_modules ) ) {

[201] Fix | Delete

continue;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

if ( $affected_field !== $field_name ) {

[205] Fix | Delete

// Field name changed

[206] Fix | Delete

$unprocessed_attrs[ $field_name ] = $attrs[ $affected_field ];

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

$current_value = isset( $unprocessed_attrs[ $field_name ] ) ? $unprocessed_attrs[ $field_name ] : '';

[210] Fix | Delete

[211] Fix | Delete

$saved_value = isset( $attrs[ $field_name ] ) ? $attrs[ $field_name ] : '';

[212] Fix | Delete

[213] Fix | Delete

$new_value = $migration->migrate( $field_name, $current_value, $module_slug, $saved_value, $affected_field, $attrs, $content, $module_address );

[214] Fix | Delete

[215] Fix | Delete

if ( $new_value !== $saved_value || ( $affected_field !== $field_name && $new_value !== $current_value ) ) {

[216] Fix | Delete

$attrs[ $field_name ] = self::$migrated['value_changes'][ $module_address ][ $field_name ] = $new_value;

[217] Fix | Delete

$migrated_attrs_count++;

[218] Fix | Delete

}

[219] Fix | Delete

}

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

if ( $migrated_attrs_count > 0 ) {

[223] Fix | Delete

$attrs['_builder_version'] = $migration->version;

[224] Fix | Delete

}

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

return $attrs;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

public static function maybe_override_content( $content, $attrs, $unprocessed_attrs, $module_slug, $module_address, $global_content ) {

[231] Fix | Delete

if ( empty( $attrs['_builder_version'] ) ) {

[232] Fix | Delete

$attrs['_builder_version'] = '3.0.47';

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

if ( ! self::_should_handle_render( $module_slug ) ) {

[236] Fix | Delete

return $content;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

$migrations = self::get_migrations( $attrs['_builder_version'] );

[240] Fix | Delete

[241] Fix | Delete

foreach ( $migrations as $migration ) {

[242] Fix | Delete

$migrated_content = false;

[243] Fix | Delete

[244] Fix | Delete

if ( ! in_array( $module_slug, $migration->get_content_migration_modules() ) ) {

[245] Fix | Delete

continue;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

foreach ( $migration->get_content_migration_modules() as $module ) {

[249] Fix | Delete

$new_content = $migration->migrate_content( $module_slug, $attrs, $content );

[250] Fix | Delete

[251] Fix | Delete

if ( $new_content !== $content ) {

[252] Fix | Delete

$migrated_content = true;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

$content = $new_content;

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

if ( $migrated_content ) {

[259] Fix | Delete

$attrs['_builder_version'] = $migration->version;

[260] Fix | Delete

}

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

return $content;

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

abstract public function migrate( $field_name, $current_value, $module_slug, $saved_value, $saved_field_name, $attrs, $content, $module_address );

[267] Fix | Delete

[268] Fix | Delete

// this could have been written as abstract, but its not as common so as to be expected to be implemented by every migration

[269] Fix | Delete

public function migrate_content( $module_slug, $attrs, $content ) {

[270] Fix | Delete

return $content;

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

public static function _should_handle_render( $slug ) {

[274] Fix | Delete

if ( false === strpos( $slug, 'et_pb' ) ) {

[275] Fix | Delete

return false;

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

global $wp_current_filter;

[279] Fix | Delete

$current_hook = $wp_current_filter[0];

[280] Fix | Delete

[281] Fix | Delete

if ( $current_hook === self::$last_hook_checked ) {

[282] Fix | Delete

return self::$last_hook_check_decision;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

self::$last_hook_checked = $current_hook;

[286] Fix | Delete

[287] Fix | Delete

foreach ( self::$hooks as $hook ) {

[288] Fix | Delete

if ( $hook === $current_hook && did_action( $hook ) > 1 ) {

[289] Fix | Delete

return self::$last_hook_check_decision = false;

[290] Fix | Delete

}

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

return self::$last_hook_check_decision = true;

[294] Fix | Delete

}

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete