Changeset 13304

Timestamp:

07/26/2022 01:31:07 PM (2 years ago)

Author:

imath

Message:

Start using a new strategy about deprecated functions management

The main goal of this commit is to change the way we load the files containing deprecated functions. This files are located into the src/bp-core/deprecated/ directory and there's one file for each version of BuddyPress we created to store the deprecate functions.

We noticed that these files were not necessarily loaded although they should have. This case happens to all users who firstly installed BuddyPress when its version was upper than 2.7.

From now on, here's how deprecated code will eventually load into your BuddyPress installation:

• First installs won't load deprecated code.
• Updated installs will load the 2 latest BuddyPress versions deprecated code.
• Defining the BP_IGNORE_DEPRECATED constant to true will change the 2 above points behavior ignoring any BuddyPress versions deprecated code.
• Defining the BP_IGNORE_DEPRECATED constant to false will change the 2 first points behavior loading all BuddyPress versions deprecated code.

Props djpaul, dcavins.

Fixes #8687

Location:

trunk

Files:

• src/bp-core/bp-core-functions.php (modified) (2 diffs)
• src/bp-core/bp-core-update.php (modified) (2 diffs)
• src/class-buddypress.php (modified) (4 diffs)
• tests/phpunit/testcases/core/functions.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-functions.php

@@ -69 +69 @@
         $bp = buddypress();
         return !empty( $bp->db_version_raw ) ? $bp->db_version_raw : 0;
+    }
+
+/**
+ * Output a BuddyPress major version.
+ *
+ * @since 11.0.0
+ *
+ * @param string $version BuddyPress version.
+ */
+function bp_major_version( $version = '' ) {
+    echo bp_get_major_version( $version );
+}
+
+    /**
+     * Return a BuddyPress major version.
+     *
+     * @since 11.0.0
+     *
+     * @param string $version BuddyPress version.
+     * @return string The corresponding BuddyPress major version.
+     */
+    function bp_get_major_version( $version = '' ) {
+        if ( ! $version ) {
+            $version = bp_get_version();
+        }
+
+        $last_wp_like_major_versions = '2.9';
+        $float_version               = (float) $version;
+
+        if ( 1 !== version_compare( $version, $last_wp_like_major_versions ) ) {
+            $major_version = (string) $float_version;
+        } else {
+            $major_version = (int) $float_version . '.0';
+        }
+
+        return $major_version;
+    }
+
+/**
+ * Output the BuddyPress version used for its first install.
+ *
+ * @since 11.0.0
+ */
+function bp_initial_version() {
+    echo bp_get_initial_version();
+}
+
+    /**
+     * Return the BuddyPress version used for its first install.
+     *
+     * @since 11.0.0
+     *
+     * @return string The BuddyPress version used for its first install.
+     */
+    function bp_get_initial_version() {
+        return bp_get_option( '_bp_initial_major_version', '0' );
     }
 
@@ -4675 +4731 @@
     return $optout_class::delete_by_id( $id );
 }
+
+/**
+ * Get the list of versions needing their deprecated functions to be loaded.
+ *
+ * @since 11.0.0
+ *
+ * @return array The list of versions needing their deprecated functions to be loaded.
+ */
+function bp_get_deprecated_functions_versions() {
+    $ignore_deprecated = null;
+    if ( defined( 'BP_IGNORE_DEPRECATED' ) ) {
+        $ignore_deprecated = (bool) BP_IGNORE_DEPRECATED;
+    }
+
+    /*
+     * Respect the site owner's choice to ignore deprecated functions.
+     * Return an empty array to inform no deprecated version files should be loaded.
+     */
+    if ( true === $ignore_deprecated ) {
+        return array();
+    }
+
+    // List of versions containing deprecated functions.
+    $deprecated_functions_versions = array(
+        '1.2',
+        '1.5',
+        '1.6',
+        '1.7',
+        '1.9',
+        '2.0',
+        '2.1',
+        '2.2',
+        '2.3',
+        '2.4',
+        '2.5',
+        '2.6',
+        '2.7',
+        '2.8',
+        '2.9',
+        '3.0',
+        '4.0',
+        '6.0',
+        '7.0',
+        '8.0',
+        '9.0',
+        '10.0',
+        '11.0',
+    );
+
+    /*
+     * Respect the site owner's choice to load all deprecated functions.
+     * Return an empty array to inform no deprecated version files should be loaded.
+     */
+    if ( false === $ignore_deprecated ) {
+        return $deprecated_functions_versions;
+    }
+
+    /*
+     * Unless the `BP_IGNORE_DEPRECATED` constant is used & set to false, the development
+     * version of BuddyPress do not load deprecated functions.
+     */
+    if ( defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src' ) {
+        return array();
+    }
+
+    /*
+     * If the constant is not defined, put our logic in place so that only the
+     * 2 last versions deprecated functions will be loaded for upgraded installs.
+     */
+    $initial_version        = (float) bp_get_initial_version();
+    $current_version        = (float) bp_get_version();
+    $load_latest_deprecated = $initial_version < $current_version;
+
+    // We don't load deprecated functions for new installs.
+    if ( ! $load_latest_deprecated ) {
+        // Run some additional checks if PHPUnit is running.
+        if ( defined( 'BP_TESTS_DIR' ) ) {
+            $deprecated_files = array_filter(
+                array_map(
+                    function( $file ) {
+                        if ( false !== strpos( $file, '.php' ) ) {
+                            return str_replace( '.php', '', $file );
+                        };
+                    },
+                    scandir( buddypress()->plugin_dir . 'bp-core/deprecated' )
+                )
+            );
+
+            if ( array_diff( $deprecated_files, $deprecated_functions_versions ) ) {
+                return false;
+            }
+        }
+        return array();
+    }
+
+    // Try to get the first major version that was in used when BuddyPress was fist installed.
+    $first_major = '';
+    if ( $initial_version ) {
+        $first_major = bp_get_major_version( $initial_version );
+    }
+
+    $index_first_major = array_search( $first_major, $deprecated_functions_versions, true );
+    if ( false === $index_first_major ) {
+        return array_splice( $deprecated_functions_versions, -2 );
+    }
+
+    $latest_deprecated_functions_versions = array_splice( $deprecated_functions_versions, $index_first_major );
+
+    if ( 2 <= count( $latest_deprecated_functions_versions ) ) {
+        $latest_deprecated_functions_versions = array_splice( $latest_deprecated_functions_versions, -2 );
+    }
+
+    $index_initial_version = array_search( $first_major, $latest_deprecated_functions_versions, true );
+    if ( false !== $index_initial_version ) {
+        unset( $latest_deprecated_functions_versions[ $index_initial_version ] );
+    }
+
+    return $latest_deprecated_functions_versions;
+}

trunk/src/bp-core/bp-core-update.php

@@ -206 +206 @@
     // Install BP schema and activate only Activity and XProfile.
     if ( bp_is_install() ) {
+        // Set the first BP major version the plugin was installed.
+        bp_update_option( '_bp_initial_major_version', bp_get_major_version() );
 
         // Apply schema and set Activity and XProfile components as active.
@@ -762 +764 @@
  */
 function bp_update_to_11_0() {
+    bp_delete_option( '_bp_ignore_deprecated_code' );
 
     add_filter( 'bp_email_get_schema', 'bp_core_get_11_0_upgrade_email_schema' );

trunk/src/class-buddypress.php

@@ -464 +464 @@
          */
         $this->email_taxonomy_type = apply_filters( 'bp_email_tax_type', 'bp-email-type' );
+
+        /**
+         * Are PHPUnit tests running?
+         *
+         * @since 11.0.0
+         *
+         * @param bool $value True if PHPUnit tests are running, false otherwise.
+         */
+        $this->is_phpunit_running = function_exists( 'tests_add_filter' );
     }
 
@@ -484 +493 @@
         if ( ! defined( 'BP_DB_VERSION' ) ) {
             define( 'BP_DB_VERSION', $this->db_version );
-        }
-
-        // Define if deprecated functions should be ignored.
-        if ( ! defined( 'BP_IGNORE_DEPRECATED' ) ) {
-            define( 'BP_IGNORE_DEPRECATED', true );
         }
     }
@@ -536 +540 @@
         require $this->plugin_dir . 'bp-core/bp-core-blocks.php';
 
-        // Maybe load deprecated functionality (this double negative is proof positive!).
-        if ( ! bp_get_option( '_bp_ignore_deprecated_code', ! $this->load_deprecated ) ) {
-            require $this->plugin_dir . 'bp-core/deprecated/1.2.php';
-            require $this->plugin_dir . 'bp-core/deprecated/1.5.php';
-            require $this->plugin_dir . 'bp-core/deprecated/1.6.php';
-            require $this->plugin_dir . 'bp-core/deprecated/1.7.php';
-            require $this->plugin_dir . 'bp-core/deprecated/1.9.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.1.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.2.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.3.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.4.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.5.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.6.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.7.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.8.php';
-            require $this->plugin_dir . 'bp-core/deprecated/2.9.php';
-            require $this->plugin_dir . 'bp-core/deprecated/3.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/4.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/6.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/7.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/8.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/9.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/10.0.php';
-            require $this->plugin_dir . 'bp-core/deprecated/11.0.php';
-        }
+        // Get the list of versions needing their deprecated functions to be loaded.
+        $deprecated_functions_versions = bp_get_deprecated_functions_versions();
+
+        // Maybe load deprecated functionality.
+        if ( $deprecated_functions_versions && ! $this->is_phpunit_running ) {
+            $this->load_deprecated = true;
+
+            foreach ( $deprecated_functions_versions as $deprecated_functions_version ) {
+                // Load all or last 2 deprecated versions.
+                require $this->plugin_dir . sprintf( 'bp-core/deprecated/%s.php', $deprecated_functions_version );
+            }
+        }
 
         // Load wp-cli module if PHP 5.6+.
@@ -721 +711 @@
             ! in_array( $component, array( 'core', 'members' ), true ) &&
             ! bp_is_active( $component ) &&
-            ! function_exists( 'tests_add_filter' )
+            ! $this->is_phpunit_running
         ) {
             return;

trunk/tests/phpunit/testcases/core/functions.php

@@ -6 +6 @@
 
 class BP_Tests_Core_Functions extends BP_UnitTestCase {
+    protected $bp_initial_version;
+
     /**
      * @group bp_esc_sql_order
@@ -876 +878 @@
         return array_merge( $page_default_titles, array( 'newcomponent' => 'NewComponent' ) );
     }
+
+    public function override_initial_version() {
+        return $this->bp_initial_version;
+    }
+
+    /**
+     * @ticket BP8687
+     */
+    public function test_bp_get_deprecated_functions_versions() {
+        $current_version = (float) bp_get_version();
+        $versions        = bp_get_deprecated_functions_versions();
+
+        // When current version is the initial version, we shouldn't load deprecated functions files.
+        $this->assertTrue( is_array( $versions ) && ! $versions, 'Please check the list of `$deprecated_functions_versions` in `bp_get_deprecated_functions_versions()`. There should be one for each file of the `/src/bp-core/deprecated` directory.' );
+
+        // We should load the 2 lasts deprecated functions files.
+        $this->bp_initial_version = '8.0';
+
+        add_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
+
+        $versions = bp_get_deprecated_functions_versions();
+
+        remove_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
+
+        $this->assertTrue( 2 === count( $versions ) );
+
+        // Even if this version does not exist in deprecated functions files, we should load the 2 lasts.
+        $this->bp_initial_version = '1.0';
+
+        add_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
+
+        $versions = bp_get_deprecated_functions_versions();
+
+        remove_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
+
+        $this->assertTrue( 2 === count( $versions ) );
+    }
 }