2017-11-17 16:22:31 +01:00
< ? php
/**
* Manages Polylang upgrades
*
* @ since 1.2
*/
class PLL_Upgrade {
public $options ;
/**
* Constructor
*
* @ since 1.2
*
* @ param array $options Polylang options
*/
public function __construct ( & $options ) {
$this -> options = & $options ;
}
/**
* Check if upgrade is possible otherwise die to avoid activation
*
* @ since 1.2
*/
public function can_activate () {
if ( ! $this -> can_upgrade () ) {
ob_start ();
$this -> admin_notices (); // FIXME the error message is displayed two times
die ( ob_get_contents () );
}
}
/**
* Upgrades if possible otherwise returns false to stop Polylang loading
*
* @ since 1.2
*
* @ return bool true if upgrade is possible , false otherwise
*/
public function upgrade () {
if ( ! $this -> can_upgrade () ) {
add_action ( 'all_admin_notices' , array ( $this , 'admin_notices' ) );
return false ;
}
add_action ( 'admin_init' , array ( $this , '_upgrade' ) );
return true ;
}
/**
* Check if we the previous version is not too old
* Upgrades if OK
* /! \ never start any upgrade before admin_init as it is likely to conflict with some other plugins
*
* @ since 1.2
*
* @ return bool true if upgrade is possible , false otherwise
*/
public function can_upgrade () {
// Don't manage upgrade from version < 0.8
return version_compare ( $this -> options [ 'version' ], '0.8' , '>=' );
}
/**
* Displays a notice when ugrading from a too old version
*
* @ since 1.0
*/
public function admin_notices () {
load_plugin_textdomain ( 'polylang' , false , basename ( POLYLANG_DIR ) . '/languages' );
printf (
'<div class="error"><p>%s</p><p>%s</p></div>' ,
esc_html__ ( 'Polylang has been deactivated because you upgraded from a too old version.' , 'polylang' ),
sprintf (
2018-04-16 15:29:38 +02:00
/* translators: %1$s and %2$s are Polylang version numbers */
esc_html__ ( 'Please upgrade first to %1$s before ugrading to %2$s.' , 'polylang' ),
2017-11-17 16:22:31 +01:00
'<strong>0.9.8</strong>' ,
POLYLANG_VERSION
)
);
}
/**
* Upgrades the plugin depending on the previous version
*
* @ since 1.2
*/
public function _upgrade () {
2018-04-16 15:29:38 +02:00
foreach ( array ( '0.9' , '1.0' , '1.1' , '1.2' , '1.2.1' , '1.2.3' , '1.3' , '1.4' , '1.4.1' , '1.4.4' , '1.5' , '1.6' , '1.7.4' , '1.8' , '2.0.8' , '2.1' , '2.3' ) as $version ) {
2017-11-17 16:22:31 +01:00
if ( version_compare ( $this -> options [ 'version' ], $version , '<' ) ) {
call_user_func ( array ( $this , 'upgrade_' . str_replace ( '.' , '_' , $version ) ) );
}
}
$delete_pre_1_2_data = get_transient ( 'pll_upgrade_1_4' );
if ( false !== $delete_pre_1_2_data && absint ( $delete_pre_1_2_data ) < time () ) {
$this -> delete_pre_1_2_data ();
}
$this -> options [ 'previous_version' ] = $this -> options [ 'version' ]; // Remember the previous version of Polylang since v1.7.7
$this -> options [ 'version' ] = POLYLANG_VERSION ;
update_option ( 'polylang' , $this -> options );
}
/**
* Upgrades if the previous version is < 0.9
*
* @ since 1.2
*/
protected function upgrade_0_9 () {
$this -> options [ 'sync' ] = defined ( 'PLL_SYNC' ) && ! PLL_SYNC ? 0 : 1 ; // The option replaces PLL_SYNC in 0.9
}
/**
* Upgrades if the previous version is < 1.0
*
* @ since 1.2
*/
protected function upgrade_1_0 () {
// The option replaces PLL_MEDIA_SUPPORT in 1.0
$this -> options [ 'media_support' ] = defined ( 'PLL_MEDIA_SUPPORT' ) && ! PLL_MEDIA_SUPPORT ? 0 : 1 ;
// Split the synchronization options in 1.0
$this -> options [ 'sync' ] = empty ( $this -> options [ 'sync' ] ) ? array () : array_keys ( PLL_Settings_Sync :: list_metas_to_sync () );
// Set default values for post types and taxonomies to translate
$this -> options [ 'post_types' ] = array_values ( get_post_types ( array ( '_builtin' => false , 'show_ui' => true ) ) );
$this -> options [ 'taxonomies' ] = array_values ( get_taxonomies ( array ( '_builtin' => false , 'show_ui' => true ) ) );
update_option ( 'polylang' , $this -> options );
flush_rewrite_rules (); // Rewrite rules have been modified in 1.0
}
/**
* Upgrades if the previous version is < 1.1
*
* @ since 1.2
*/
protected function upgrade_1_1 () {
// Update strings register with icl_register_string
$strings = get_option ( 'polylang_wpml_strings' );
if ( $strings ) {
foreach ( $strings as $key => $string ) {
$strings [ $key ][ 'icl' ] = 1 ;
}
update_option ( 'polylang_wpml_strings' , $strings );
}
// Move polylang_widgets options
if ( $widgets = get_option ( 'polylang_widgets' ) ) {
$this -> options [ 'widgets' ] = $widgets ;
delete_option ( 'polylang_widgets' );
}
}
/**
* Upgrades if the previous version is < 1.2
*
* @ since 1.2
*/
protected function upgrade_1_2 () {
$this -> options [ 'domains' ] = array (); // Option added in 1.2
// Need to register the taxonomies
foreach ( array ( 'language' , 'term_language' , 'post_translations' , 'term_translations' ) as $taxonomy ) {
2017-12-11 16:34:19 +01:00
register_taxonomy ( $taxonomy , null , array ( 'label' => false , 'public' => false , 'query_var' => false , 'rewrite' => false ) );
2017-11-17 16:22:31 +01:00
}
// Abort if the db upgrade has already been done previously
if ( get_terms ( 'term_language' , array ( 'hide_empty' => 0 ) ) ) {
return ;
}
set_time_limit ( 0 ); // In case we upgrade a huge site
// Upgrade old model based on metas to new model based on taxonomies
global $wpdb ;
$wpdb -> termmeta = $wpdb -> prefix . 'termmeta' ; // Registers the termmeta table in wpdb
$languages = get_terms ( 'language' , array ( 'hide_empty' => 0 ) ); // Don't use get_languages_list which can't work with the old model
foreach ( $languages as $lang ) {
// First update language with new storage for locale and text direction
$text_direction = get_metadata ( 'term' , $lang -> term_id , '_rtl' , true );
$desc = serialize ( array ( 'locale' => $lang -> description , 'rtl' => $text_direction ) );
wp_update_term ( ( int ) $lang -> term_id , 'language' , array ( 'description' => $desc ) );
// Add language to new 'term_language' taxonomy
$term_lang = wp_insert_term ( $lang -> name , 'term_language' , array ( 'slug' => 'pll_' . $lang -> slug ) );
$lang_tt_ids [ $lang -> term_id ] = $term_lang [ 'term_taxonomy_id' ]; // Keep the term taxonomy id for future
}
// Get all terms with a language defined
$terms = $wpdb -> get_results ( " SELECT term_id, meta_value FROM $wpdb->termmeta WHERE meta_key = '_language' " );
foreach ( $terms as $key => $term ) {
$terms [ $key ] = $wpdb -> prepare ( '( %d, %d )' , $term -> term_id , $lang_tt_ids [ $term -> meta_value ] );
}
$terms = array_unique ( $terms );
// Assign language to each term
if ( ! empty ( $terms ) ) {
$wpdb -> query ( " INSERT INTO $wpdb->term_relationships ( object_id, term_taxonomy_id ) VALUES " . implode ( ',' , $terms ) );
}
// Translations
foreach ( array ( 'post' , 'term' ) as $type ) {
$table = $type . 'meta' ;
$terms = $slugs = $tts = $trs = array ();
// Get all translated objects
$objects = $wpdb -> get_col ( " SELECT DISTINCT meta_value FROM { $wpdb -> $table } WHERE meta_key = '_translations' " );
if ( empty ( $objects ) ) {
continue ;
}
foreach ( $objects as $obj ) {
$term = uniqid ( 'pll_' ); // The term name
2017-12-11 16:34:19 +01:00
$terms [] = $wpdb -> prepare ( '( %s, %s )' , $term , $term );
$slugs [] = $wpdb -> prepare ( '%s' , $term );
2017-11-17 16:22:31 +01:00
$translations = maybe_unserialize ( maybe_unserialize ( $obj ) ); // 2 unserialize due to an old storage bug
$description [ $term ] = serialize ( $translations );
}
$terms = array_unique ( $terms );
// Insert terms
if ( ! empty ( $terms ) ) {
$wpdb -> query ( " INSERT INTO $wpdb->terms ( slug, name ) VALUES " . implode ( ',' , $terms ) );
}
// Get all terms with their term_id
$terms = $wpdb -> get_results ( " SELECT term_id, slug FROM $wpdb->terms WHERE slug IN ( " . implode ( ',' , $slugs ) . ' )' );
// Prepare terms taxonomy relationship
foreach ( $terms as $term ) {
2017-12-11 16:34:19 +01:00
$tts [] = $wpdb -> prepare ( '( %d, %s, %s )' , $term -> term_id , $type . '_translations' , $description [ $term -> slug ] );
2017-11-17 16:22:31 +01:00
}
$tts = array_unique ( $tts );
// Insert term_taxonomy
if ( ! empty ( $tts ) ) {
$wpdb -> query ( " INSERT INTO $wpdb->term_taxonomy ( term_id, taxonomy, description ) VALUES " . implode ( ',' , $tts ) );
}
// Get all terms with term_taxonomy_id
$terms = get_terms ( $type . '_translations' , array ( 'hide_empty' => false ) );
// Prepare objects relationships
foreach ( $terms as $term ) {
$translations = unserialize ( $term -> description );
foreach ( $translations as $object_id ) {
if ( ! empty ( $object_id ) ) {
$trs [] = $wpdb -> prepare ( '( %d, %d )' , $object_id , $term -> term_taxonomy_id );
}
}
}
$trs = array_unique ( $trs );
// Insert term_relationships
if ( ! empty ( $trs ) ) {
$wpdb -> query ( " INSERT INTO $wpdb->term_relationships ( object_id, term_taxonomy_id ) VALUES " . implode ( ',' , $trs ) );
}
}
// Upgrade of string translations is now in upgrade_1_2_1
// Upgrade of nav menus is now in upgrade_1_2_3
}
/**
* Upgrades if the previous version is < 1.2 . 1
*
* @ since 1.2 . 1
*/
protected function upgrade_1_2_1 () {
// Strings translations
foreach ( get_terms ( 'language' , array ( 'hide_empty' => 0 ) ) as $lang ) {
if ( $strings = get_option ( 'polylang_mo' . $lang -> term_id ) ) {
$mo = new PLL_MO ();
foreach ( $strings as $msg ) {
$mo -> add_entry ( $mo -> make_entry ( $msg [ 0 ], $msg [ 1 ] ) );
}
$mo -> export_to_db ( $lang );
}
}
}
/**
* Upgrades if the previous version is < 1.2 . 3
* Uprades multilingual menus depending on the old version due to multiple changes in menus management
*
* @ since 1.2 . 3
*/
public function upgrade_1_2_3 () {
// Old version < 1.1
// Multilingal locations and switcher item were stored in a dedicated option
if ( version_compare ( $this -> options [ 'version' ], '1.1' , '<' ) ) {
if ( $menu_lang = get_option ( 'polylang_nav_menus' ) ) {
foreach ( $menu_lang as $location => $arr ) {
if ( ! in_array ( $location , array_keys ( get_registered_nav_menus () ) ) ) {
continue ;
}
$switch_options = array_slice ( $arr , - 5 , 5 );
$translations = array_diff_key ( $arr , $switch_options );
$has_switcher = array_shift ( $switch_options );
foreach ( get_terms ( 'language' , array ( 'hide_empty' => 0 ) ) as $lang ) {
// Move nav menus locations
if ( ! empty ( $translations [ $lang -> slug ] ) ) {
$locations [ $location ][ $lang -> slug ] = $translations [ $lang -> slug ];
}
// Create the menu items for the language switcher
if ( ! empty ( $has_switcher ) ) {
$menu_item_db_id = wp_update_nav_menu_item ( $translations [ $lang -> slug ], 0 , array (
'menu-item-title' => __ ( 'Language switcher' , 'polylang' ),
'menu-item-url' => '#pll_switcher' ,
'menu-item-status' => 'publish' ,
) );
update_post_meta ( $menu_item_db_id , '_pll_menu_item' , $switch_options );
}
}
}
if ( ! empty ( $locations ) ) {
$this -> options [ 'nav_menus' ][ get_option ( 'stylesheet' ) ] = $locations ;
}
delete_option ( 'polylang_nav_menus' );
}
}
elseif ( empty ( $this -> options [ 'nav_menus' ] ) ) {
$menus = get_theme_mod ( 'nav_menu_locations' );
if ( is_array ( $menus ) ) {
// If old version < 1.2
// Clean the WP option as it was a bad idea to pollute it
if ( version_compare ( $this -> options [ 'version' ], '1.2' , '<' ) ) {
foreach ( $menus as $loc => $menu ) {
if ( $pos = strpos ( $loc , '#' ) ) {
unset ( $menus [ $loc ] );
}
}
set_theme_mod ( 'nav_menu_locations' , $menus );
}
// Get the multilingual locations
foreach ( $menus as $loc => $menu ) {
foreach ( get_terms ( 'language' , array ( 'hide_empty' => 0 ) ) as $lang ) {
$arr [ $loc ][ $lang -> slug ] = pll_get_term ( $menu , $lang );
}
}
if ( ! empty ( $arr ) ) {
$this -> options [ 'nav_menus' ][ get_option ( 'stylesheet' ) ] = $arr ;
}
}
}
}
/**
* Upgrades if the previous version is < 1.3
* Moves the user biographies in default language to the 'description' user meta
*
* @ since 1.3
*/
protected function upgrade_1_3 () {
$usermeta = 'description_' . $this -> options [ 'default_lang' ];
$query = new WP_User_Query ( array ( 'blog_id' => $GLOBALS [ 'blog_id' ], 'meta_key' => $usermeta ) );
foreach ( $query -> get_results () as $user ) {
$desc = get_user_meta ( $user -> ID , $usermeta , true );
if ( ! empty ( $desc ) ) {
update_user_meta ( $user -> ID , 'description' , $desc );
delete_user_meta ( $user -> ID , $usermeta );
}
}
}
/**
* Upgrades if the previous version is < 1.4
* Sets a transient to delete old model data
* Deletes language cache ( due to bug correction in home urls in 1.3 . 1 and added mo_id in 1.4 )
*
* @ since 1.4
*/
protected function upgrade_1_4 () {
set_transient ( 'pll_upgrade_1_4' , time () + 60 * 24 * 60 * 60 ); // 60 days
delete_transient ( 'pll_languages_list' );
}
/**
* Old data were not deleted in 1.2 , just in case ...
* Delete them at first upgrade at least 60 days after upgrade to 1.4
*
* @ since 1.4
*/
protected function delete_pre_1_2_data () {
// Suppress data of the old model < 1.2
global $wpdb ;
$wpdb -> termmeta = $wpdb -> prefix . 'termmeta' ; // registers the termmeta table in wpdb in case WP < 4.4
// Do nothing if the termmeta table does not exists
if ( count ( $wpdb -> get_results ( " SHOW TABLES LIKE ' $wpdb->termmeta ' " ) ) ) {
$wpdb -> query ( " DELETE FROM $wpdb->postmeta WHERE meta_key = '_translations' " );
$wpdb -> query ( " DELETE FROM $wpdb->termmeta WHERE meta_key = '_language' " );
$wpdb -> query ( " DELETE FROM $wpdb->termmeta WHERE meta_key = '_rtl' " );
$wpdb -> query ( " DELETE FROM $wpdb->termmeta WHERE meta_key = '_translations' " );
}
// Delete the strings translations
$languages = get_terms ( 'language' , array ( 'hide_empty' => false ) );
foreach ( $languages as $lang ) {
delete_option ( 'polylang_mo' . $lang -> term_id );
}
delete_transient ( 'pll_upgrade_1_4' );
}
/**
* Upgrades if the previous version is < 1.4 . 1
* Disables the browser detection when using multiple domains
*
* @ since 1.4 . 1
*/
protected function upgrade_1_4_1 () {
if ( 3 == $this -> options [ 'force_lang' ] ) {
$this -> options [ 'browser' ] = $this -> options [ 'hide_default' ] = 0 ;
}
}
/**
* Upgrades if the previous version is < 1.4 . 4
* Uprades widgets options for language filter
*
* @ since 1.4 . 4
*/
protected function upgrade_1_4_4 () {
foreach ( $GLOBALS [ 'wp_registered_widgets' ] as $widget ) {
if ( ! empty ( $this -> options [ 'widgets' ][ $widget [ 'id' ] ] ) && ! empty ( $widget [ 'callback' ][ 0 ] ) && ! empty ( $widget [ 'params' ][ 0 ][ 'number' ] ) ) {
$obj = $widget [ 'callback' ][ 0 ];
if ( is_object ( $obj ) && method_exists ( $obj , 'get_settings' ) && method_exists ( $obj , 'save_settings' ) ) {
$settings = $obj -> get_settings ();
$settings [ $widget [ 'params' ][ 0 ][ 'number' ] ][ 'pll_lang' ] = $this -> options [ 'widgets' ][ $widget [ 'id' ] ];
$obj -> save_settings ( $settings );
}
}
}
unset ( $this -> options [ 'widgets' ] );
}
/**
* Upgrades if the previous version is < 1.5
* Deletes language cache ( due to host property added and bug on search url )
*
* @ since 1.5
*/
protected function upgrade_1_5 () {
delete_transient ( 'pll_languages_list' );
}
/**
* Upgrades if the previous version is < 1.6
* Upgrades core language files to get the . po file ( only for WP 4.0 + )
*
* @ since 1.6
*/
protected function upgrade_1_6 () {
if ( version_compare ( $GLOBALS [ 'wp_version' ], '4.0' , '>=' ) ) {
self :: download_language_packs ();
}
}
/**
* Downloads language packs
* Intended to be used only one time ( at upgrade to Polylang 1.6 or first upgrade of WP 4.0 or later )
* Adapted from wp_download_language_pack
* Rewritten because wp_download_language_pack checks the existence of . mo and I need to download . po
*
* @ since 1.6
*/
static function download_language_packs () {
$languages = pll_languages_list ( array ( 'fields' => 'locale' ) );
// Prevents upgrade if the .po file is already here. Let WP manage the upgrades :)
foreach ( $languages as $key => $locale ) {
if ( file_exists ( WP_LANG_DIR . " / $locale .po " ) ) {
unset ( $languages [ $key ] );
}
}
if ( empty ( $languages ) ) {
return ;
}
require_once ABSPATH . 'wp-admin/includes/translation-install.php' ;
$translations = wp_get_available_translations ();
if ( ! $translations ) {
return ;
}
foreach ( $translations as $translation ) {
if ( in_array ( $translation [ 'language' ], $languages ) ) {
$translation [ 'type' ] = 'core' ;
$translations_to_load [] = ( object ) $translation ;
}
}
if ( ! empty ( $translations_to_load ) ) {
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' ;
$upgrader = new Language_Pack_Upgrader ( new Automatic_Upgrader_Skin );
$upgrader -> bulk_upgrade ( $translations_to_load , array ( 'clear_update_cache' => false ) );
}
}
/**
* Upgrades if the previous version is < 1.7 . 4
*
* @ since 1.7 . 4
*/
protected function upgrade_1_7_4 () {
delete_transient ( 'pll_languages_list' ); // Deletes language cache (due to flag properties added in 1.7, page on front removed in 1.7.2, home url fixes in 1.7.4)
flush_rewrite_rules (); // Flush rewrite rules due to custom taxonomy rewrite rule bug fix
}
/**
* Upgrades if the previous version is < 1.8
*
* @ since 1.8
*/
protected function upgrade_1_8 () {
// Adds the flag code in languages stored in DB
include PLL_SETTINGS_INC . '/languages.php' ;
$terms = get_terms ( 'language' , array ( 'hide_empty' => 0 ) );
foreach ( $terms as $lang ) {
$description = maybe_unserialize ( $lang -> description );
if ( isset ( $languages [ $description [ 'locale' ] ] ) ) {
2018-04-16 15:29:38 +02:00
$description [ 'flag_code' ] = $languages [ $description [ 'locale' ] ][ 'flag' ];
2017-11-17 16:22:31 +01:00
$description = serialize ( $description );
wp_update_term ( ( int ) $lang -> term_id , 'language' , array ( 'description' => $description ) );
}
}
delete_transient ( 'pll_languages_list' );
}
/**
* Upgrades if the previous version is < 2.0 . 8
* Changes the user meta 'user_lang' to 'locale' to match WP 4.7 choice
*
* @ since 2.0 . 8
*/
protected function upgrade_2_0_8 () {
global $wpdb ;
$wpdb -> update ( $wpdb -> usermeta , array ( 'meta_key' => 'locale' ), array ( 'meta_key' => 'user_lang' ) );
}
/**
* Upgrades if the previous version is < 2.1
* Moves strings translations from polylang_mo post_content to post meta _pll_strings_translations
*
* @ since 2.1
*/
protected function upgrade_2_1 () {
foreach ( get_terms ( 'language' , array ( 'hide_empty' => 0 ) ) as $lang ) {
$mo_id = PLL_MO :: get_id ( $lang );
$meta = get_post_meta ( $mo_id , '_pll_strings_translations' , true );
if ( empty ( $meta ) ) {
$post = get_post ( $mo_id , OBJECT );
$strings = unserialize ( $post -> post_content );
if ( is_array ( $strings ) ) {
update_post_meta ( $mo_id , '_pll_strings_translations' , $strings );
}
}
}
}
/**
2018-04-16 15:29:38 +02:00
* Upgrades if the previous version is < 2.3
2017-11-17 16:22:31 +01:00
*
2018-04-16 15:29:38 +02:00
* Deletes language cache due to 'redirect_lang' option removed for subdomains and multiple domains in 2.2
* and W3C and Facebook locales added to PLL_Language objects in 2.3
*
* @ since 2.3
2017-11-17 16:22:31 +01:00
*/
2018-04-16 15:29:38 +02:00
protected function upgrade_2_3 () {
delete_transient ( 'pll_languages_list' );
2017-11-17 16:22:31 +01:00
}
}