Changeset 12252

Timestamp:

11/18/2022 01:48:31 AM (4 years ago)

Author:

dd32

Message:

Openverse: Prepare for a migration to a standalone Openverse domain.

Props dhruvkb, zackkrida, sarayourfriend, olgabulat.
Closes ​https://github.com/WordPress/wordpress.org/pull/98.
Fixes #6578.

Location:

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse

Files:

• .wp-env.json (modified) (1 diff)
• README.md (modified) (5 diffs)
• functions.php (modified) (6 diffs)
• index.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/.wp-env.json

@@ -1 +1 @@
 {
-  "core": "WordPress/WordPress#master",
   "themes": [
     ".",

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/README.md

@@ -9 +9 @@
 0.  Install all the prerequisites.
 
-    1.  **Required:** Node.js 14.
-    2.  **Required:** Composer.
-    3.  **Recommended:** Docker (to use the automatic setup)
+    1.  **Required:** Node.js 14
+    2.  **Required:** Composer
+    3.  **Required:** Subversion
+    4.  **Recommended:** Docker (to use the automatic setup)
 
 1.  Build the parent theme WordPress.org theme.
@@ -19 +20 @@
     2.  Install all the required `npm` packages.
         ```bash
+        $ npm install
+        ```
+        If you face issues installing Sass, try the following command, and
+        `npm install` again.
+        ```bash
+        $ npm install node-sass@npm:sass
         $ npm install
         ```
@@ -77 +84 @@
         `wporg-openverse` (child) themes installed. For detailed instructions,
         please read [the wp-env docs](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/).
+    4.  Edit the `.htaccess` file to prevent Apache 404 errors.
+        ```bash
+        $ wp-env run cli bash
+        bash-5.1$ printf "RewriteEngine on\nFallbackResource /index.php\n" > .htaccess
+        bash-5.1$ exit
+        ```
 
     **Manual:**  
@@ -97 +110 @@
 6.  Activate and customize the theme.
 
-    1.  Log into `/wp-admin`.
+    1.  Log into `/wp-admin`. If you used `@wordpress/env`, your username will
+        be 'admin' and password will be 'password'.
     2.  Under Appearance > Themes, activate the theme 'WordPress.org Openverse'.
     3.  To change the embed URL, open the customizer at Appearance > Customize
@@ -108 +122 @@
     2.  Visit the site and interactively test the messages.
 
+8. Test redirects.
+
+    1.  Visit some test URLs.
+        1.  https://ru.wordpress.org/openverse → ...
+        2.  https://wordpress.org/openverse/search/?q=dog → ...
+    2.  See the target redirect URL as a comment inside the dev tools.
+        1.  ... → https://openverse.wordpress.net/ru/
+        2.  ... → https://openverse.wordpress.net/search/?q=dog
+    3.  Change the language in Settings > General to see how the locale factors
+        into the redirect path.
+
 ## Related links
 

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/functions.php

@@ -18 +18 @@
  * This is subdirectory on WordPress.org which loads the Openverse site. This is
  * prefixed in front of all path changes sent by the embedded `iframe`.
+ *
+ * When used with the standalone redirect, it is removed from the path forwarded
+ * to the standalone site.
  */
 if ( !defined( 'OPENVERSE_SUBPATH' ) ) {
@@ -83 +86 @@
 
 /**
+ * Get the slug of the given WP locale. This function returns a blank string if
+ * the locale is `en_US` because that is considered the default and is not
+ * prefixed in the URL paths. It also returns a blank string if `$wp_locale` is
+ * not found in the locales list.
+ */
+function get_locale_slug( $curr_locale ) {
+        if ( $curr_locale === 'en_US' ) {
+                return '';
+        }
+
+        return get_locales()[ $curr_locale ]->slug ?? '';
+}
+
+/**
  * Enqueue styles & scripts.
  *
@@ -106 +123 @@
 
         $use_path_based_locale_forwarding = get_theme_mod( 'ov_path_based_i18n', false );
-        $wp_locale = get_locale();
-        $locale = get_locales()[ $wp_locale ];
-        $locale_slug = $use_path_based_locale_forwarding && $wp_locale !== 'en_US' ? $locale->slug : '';
+        $curr_locale = get_locale();
+        $locale_slug = '';
+        if ( $use_path_based_locale_forwarding ) {
+                $locale_slug = get_locale_slug( $curr_locale );
+        }
 
         wp_add_inline_script(
@@ -114 +133 @@
                 /* JS       */ 'const openverseUrl = ' . wp_json_encode( get_theme_mod( 'ov_src_url', OPENVERSE_URL ) ) . ";\n" .
                 /* JS       */ 'const openverseSubpath = ' . wp_json_encode( OPENVERSE_SUBPATH ) . ";\n" .
-                /* JS       */ 'const currentLocale = ' . wp_json_encode( $wp_locale ) . ";\n" . /* Used for legacy cookie based locale forwarding */
+                /* JS       */ 'const currentLocale = ' . wp_json_encode( $curr_locale ) . ";\n" . /* Used for legacy cookie based locale forwarding */
                 /* JS       */ 'const localeSlug = ' . wp_json_encode( $locale_slug ) . ";\n",
                 /* position */ 'before'
@@ -151 +170 @@
 }
 add_filter( 'document_title_parts', __NAMESPACE__ . '\title_no_title' );
+
+/*
+        TODO: Delete this and everything related to it
+        ======================
+        Openverse iframe embed
+        ======================
+ */
 
 /**
@@ -204 +230 @@
 }
 add_action( 'customize_register', __NAMESPACE__ . '\wporg_ov_customizer' );
+
+/*
+        =====================================
+        Openverse standalone site redirection
+        =====================================
+ */
+
+/**
+ * This is the URL at which the standalone Openverse site is hosted. When
+ * redirect is enabled (see setting `ov_is_redirect_enabled`), the theme
+ * redirects all incoming requests to the right URL on this domain.
+ *
+ * Note: Do not put a trailing slash '/' in this URL. Paths start with a leading
+ * slash so a trailing slash here will lead to two slashes in the final URL.
+ */
+if ( !defined( 'OPENVERSE_STANDALONE_URL' ) ) {
+        define( 'OPENVERSE_STANDALONE_URL', 'https://openverse.wordpress.net' );
+}
+
+/**
+ * Determine the target URL of the redirect based on the Openverse standalone
+ * URL, the requested path and the current locale.
+ *
+ * Examples:
+ * - https://ru.wordpress.org/openverse → {ov_redirect_url}/ru/
+ * - https://wordpress.org/openverse/search/?q=dog → {ov_redirect_url}/search/?q=dog
+ */
+function get_target_url() {
+        $target_url = get_theme_mod( 'ov_redirect_url', OPENVERSE_STANDALONE_URL );
+
+        $curr_locale = get_locale();
+        $locale = get_locale_slug( $curr_locale );
+        if ( $locale !== '' ) {
+                $target_url .= '/' . $locale;
+        }
+
+        $path = $_SERVER['REQUEST_URI'];
+        if ( $path ) {
+                $count = 1; // Only replace the leading Openverse subpath.
+                $target_url .= str_replace( OPENVERSE_SUBPATH, '', $path, $count );
+        }
+
+        return $target_url;
+}
+
+/**
+* Provide configuration for the theme to redirect to the given standalone
+* Openverse site. The destination URL can be configured and the behaviour can
+* be dormant unless enabled.
+*
+* @param \WP_Customize_Manager $wp_customize Theme Customizer object.
+*/
+function wporg_ov_redir_customizer( $wp_customize ) {
+        $wp_customize->add_section( 'ov_redir', array(
+                'priority' => 10,
+                'capability' => 'edit_theme_options',
+                'title' => 'Openverse Redirect',
+                'description' => 'Configure the redirection to the standalone Openverse site.'
+        ) );
+
+        $wp_customize->add_setting( 'ov_redirect_url', array(
+                'type' => 'theme_mod',
+                'capability' => 'edit_theme_options',
+                'default' => OPENVERSE_STANDALONE_URL,
+                'sanitize_callback' => function( $val, $setting ) {
+                        if ( substr( $val, -1 ) == '/' ) { // If the last character is a slash '/',...
+                                $val = substr( $val, 0, -1 );    // ...remove it.
+                        }
+                        if ( empty( $val ) ) {
+                                return $setting->default;
+                        }
+                        return $val;
+                }
+        ) );
+
+        $wp_customize->add_control( 'ov_redirect_url', array(
+                'section' => 'ov_redir',
+                'type' => 'url',
+                'id' => 'ov_redirect_url',
+                'label' => 'Redirect URL',
+                'description' => '<b>Note</b>: '
+                                                                        . 'Do not put a trailing slash \'/\' in this URL.<br/>'
+                                                                        . '<b>Default</b>: '
+                                                                        . esc_html( OPENVERSE_STANDALONE_URL ),
+                'priority' => 10,
+                'input_attrs' => array(
+                        'placeholder' => 'URL'
+                )
+        ) );
+
+        $wp_customize->add_setting( 'ov_is_redirect_enabled', array(
+                'type' => 'theme_mod',
+                'capability' => 'edit_theme_options',
+                'default' => false
+        ) );
+
+        $wp_customize->add_control( 'ov_is_redirect_enabled', array(
+                'section' => 'ov_redir',
+                'type' => 'checkbox',
+                'id' => 'ov_is_redirect_enabled',
+                'label' => 'Redirect to the standalone Openverse site.',
+                'priority' => 10
+        ) );
+}
+add_action( 'customize_register', __NAMESPACE__ . '\wporg_ov_redir_customizer' );

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-openverse/index.php

@@ -15 +15 @@
 namespace WordPressdotorg\Openverse\Theme;
 
+/*
+        If the theme mod `ov_is_redirect_enabled` is set to `true`, redirect to the
+        standalone site and exit immediately. If not, print what would have been the
+        redirect URL to the HTML as a comment.
+ */
+
+$is_redirect_enabled = get_theme_mod( 'ov_is_redirect_enabled' );
+$target_url = get_target_url();
+
+if ( $is_redirect_enabled ) {
+        wp_redirect( $target_url );
+        exit;
+} else {
+        echo "<!-- " . $target_url . " -->";
+}
+
 get_header();
 ?>