| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617 |
- <?php
- /**
- * WordPress.com Block Editor
- * Allow new block editor posts to be composed on WordPress.com.
- * This is auto-loaded as of Jetpack v7.4 for sites connected to WordPress.com only.
- *
- * @package automattic/jetpack
- */
- use Automattic\Jetpack\Connection\Tokens;
- /**
- * WordPress.com Block editor for Jetpack
- */
- class Jetpack_WPCOM_Block_Editor {
- /**
- * ID of the user who signed the nonce.
- *
- * @var int
- */
- private $nonce_user_id;
- /**
- * An array to store auth cookies until we can determine if they should be sent
- *
- * @var array
- */
- private $set_cookie_args;
- /**
- * Singleton
- */
- public static function init() {
- static $instance = false;
- if ( ! $instance ) {
- $instance = new Jetpack_WPCOM_Block_Editor();
- }
- return $instance;
- }
- /**
- * Jetpack_WPCOM_Block_Editor constructor.
- */
- private function __construct() {
- $this->set_cookie_args = array();
- add_action( 'init', array( $this, 'init_actions' ) );
- }
- /**
- * Add in all hooks.
- */
- public function init_actions() {
- global $wp_version;
- // Bail early if Jetpack's block editor extensions are disabled on the site.
- /* This filter is documented in class.jetpack-gutenberg.php */
- if ( ! apply_filters( 'jetpack_gutenberg', true ) ) {
- return;
- }
- if ( $this->is_iframed_block_editor() ) {
- add_action( 'admin_init', array( $this, 'disable_send_frame_options_header' ), 9 );
- add_filter( 'admin_body_class', array( $this, 'add_iframed_body_class' ) );
- }
- require_once __DIR__ . '/functions.editor-type.php';
- add_action( 'edit_form_top', 'Jetpack\EditorType\remember_classic_editor' );
- add_action( 'login_init', array( $this, 'allow_block_editor_login' ), 1 );
- add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_block_editor_assets' ), 9 );
- add_action( 'enqueue_block_assets', array( $this, 'enqueue_block_assets' ) );
- add_filter( 'mce_external_plugins', array( $this, 'add_tinymce_plugins' ) );
- // @todo simplify once 5.8 is the minimum supported version.
- if ( version_compare( $wp_version, '5.8', '>=' ) ) {
- add_filter( 'block_editor_settings_all', 'Jetpack\EditorType\remember_block_editor', 10, 2 );
- } else {
- add_filter( 'block_editor_settings', 'Jetpack\EditorType\remember_block_editor', 10, 2 );
- }
- $this->enable_cross_site_auth_cookies();
- }
- /**
- * Checks if we are embedding the block editor in an iframe in WordPress.com.
- *
- * @return bool Whether the current request is from the iframed block editor.
- */
- public function is_iframed_block_editor() {
- global $pagenow;
- // phpcs:ignore WordPress.Security.NonceVerification
- return ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) && ! empty( $_GET['frame-nonce'] );
- }
- /**
- * Prevents frame options header from firing if this is a allowed iframe request.
- */
- public function disable_send_frame_options_header() {
- // phpcs:ignore WordPress.Security.NonceVerification
- if ( $this->framing_allowed( $_GET['frame-nonce'] ) ) {
- remove_action( 'admin_init', 'send_frame_options_header' );
- }
- }
- /**
- * Adds custom admin body class if this is a allowed iframe request.
- *
- * @param string $classes Admin body classes.
- * @return string
- */
- public function add_iframed_body_class( $classes ) {
- // phpcs:ignore WordPress.Security.NonceVerification
- if ( $this->framing_allowed( $_GET['frame-nonce'] ) ) {
- $classes .= ' is-iframed ';
- }
- return $classes;
- }
- /**
- * Checks to see if cookie can be set in current context. If 3rd party cookie blocking
- * is enabled the editor can't load in iFrame, so emiting X-Frame-Options: DENY will
- * force the editor to break out of the iFrame.
- */
- private function check_iframe_cookie_setting() {
- if ( ! isset( $_SERVER['QUERY_STRING'] ) || ! strpos( $_SERVER['QUERY_STRING'], 'calypsoify%3D1%26block-editor' ) || isset( $_COOKIE['wordpress_test_cookie'] ) ) {
- return;
- }
- if ( empty( $_GET['calypsoify_cookie_check'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
- header( 'Location: ' . esc_url_raw( $_SERVER['REQUEST_URI'] . '&calypsoify_cookie_check=true' ) );
- exit;
- }
- header( 'X-Frame-Options: DENY' );
- exit;
- }
- /**
- * Allows to iframe the login page if a user is logged out
- * while trying to access the block editor from wordpress.com.
- */
- public function allow_block_editor_login() {
- // phpcs:ignore WordPress.Security.NonceVerification
- if ( empty( $_REQUEST['redirect_to'] ) ) {
- return;
- }
- $this->check_iframe_cookie_setting();
- // phpcs:ignore WordPress.Security.NonceVerification
- $query = wp_parse_url( urldecode( $_REQUEST['redirect_to'] ), PHP_URL_QUERY );
- $args = wp_parse_args( $query );
- // Check nonce and make sure this is a Gutenframe request.
- if ( ! empty( $args['frame-nonce'] ) && $this->framing_allowed( $args['frame-nonce'] ) ) {
- // If SSO is active, we'll let WordPress.com handle authentication...
- if ( Jetpack::is_module_active( 'sso' ) ) {
- // ...but only if it's not an Atomic site. They already do that.
- if ( ! jetpack_is_atomic_site() ) {
- add_filter( 'jetpack_sso_bypass_login_forward_wpcom', '__return_true' );
- }
- } else {
- $_REQUEST['interim-login'] = true;
- add_action( 'wp_login', array( $this, 'do_redirect' ) );
- add_action( 'login_form', array( $this, 'add_login_html' ) );
- add_filter( 'wp_login_errors', array( $this, 'add_login_message' ) );
- remove_action( 'login_init', 'send_frame_options_header' );
- wp_add_inline_style( 'login', '.interim-login #login{padding-top:8%}' );
- }
- }
- }
- /**
- * Adds a login message.
- *
- * Intended to soften the expectation mismatch of ending up with a login screen rather than the editor.
- *
- * @param WP_Error $errors WP Error object.
- * @return \WP_Error
- */
- public function add_login_message( $errors ) {
- $errors->remove( 'expired' );
- $errors->add( 'info', __( 'Before we continue, please log in to your Jetpack site.', 'jetpack' ), 'message' );
- return $errors;
- }
- /**
- * Maintains the `redirect_to` parameter in login form links.
- * Adds visual feedback of login in progress.
- */
- public function add_login_html() {
- ?>
- <input type="hidden" name="redirect_to" value="<?php echo esc_url( $_REQUEST['redirect_to'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended ?>" />
- <script type="application/javascript">
- document.getElementById( 'loginform' ).addEventListener( 'submit' , function() {
- document.getElementById( 'wp-submit' ).setAttribute( 'disabled', 'disabled' );
- document.getElementById( 'wp-submit' ).value = '<?php echo esc_js( __( 'Logging In...', 'jetpack' ) ); ?>';
- } );
- </script>
- <?php
- }
- /**
- * Does the redirect to the block editor.
- */
- public function do_redirect() {
- wp_safe_redirect( $GLOBALS['redirect_to'] );
- exit;
- }
- /**
- * Checks whether this is an allowed iframe request.
- *
- * @param string $nonce Nonce to verify.
- * @return bool
- */
- public function framing_allowed( $nonce ) {
- $verified = $this->verify_frame_nonce( $nonce, 'frame-' . Jetpack_Options::get_option( 'id' ) );
- if ( is_wp_error( $verified ) ) {
- wp_die( $verified ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
- }
- if ( $verified && ! defined( 'IFRAME_REQUEST' ) ) {
- define( 'IFRAME_REQUEST', true );
- }
- return (bool) $verified;
- }
- /**
- * Verify that correct nonce was used with time limit.
- *
- * The user is given an amount of time to use the token, so therefore, since the
- * UID and $action remain the same, the independent variable is the time.
- *
- * @param string $nonce Nonce that was used in the form to verify.
- * @param string $action Should give context to what is taking place and be the same when nonce was created.
- * @return boolean|WP_Error Whether the nonce is valid.
- */
- public function verify_frame_nonce( $nonce, $action ) {
- if ( empty( $nonce ) ) {
- return false;
- }
- list( $expiration, $user_id, $hash ) = explode( ':', $nonce, 3 );
- $this->nonce_user_id = (int) $user_id;
- if ( ! $this->nonce_user_id ) {
- return false;
- }
- $token = ( new Tokens() )->get_access_token( $this->nonce_user_id );
- if ( ! $token ) {
- return false;
- }
- /*
- * Failures must return `false` (blocking the iframe) prior to the
- * signature verification.
- */
- add_filter( 'salt', array( $this, 'filter_salt' ), 10, 2 );
- $expected_hash = wp_hash( "$expiration|$action|{$this->nonce_user_id}", 'jetpack_frame_nonce' );
- remove_filter( 'salt', array( $this, 'filter_salt' ) );
- if ( ! hash_equals( $hash, $expected_hash ) ) {
- return false;
- }
- /*
- * Failures may return `WP_Error` (showing an error in the iframe) after the
- * signature verification passes.
- */
- if ( time() > $expiration ) {
- return new WP_Error( 'nonce_invalid_expired', 'Expired nonce.', array( 'status' => 401 ) );
- }
- // Check if it matches the current user, unless they're trying to log in.
- if ( get_current_user_id() !== $this->nonce_user_id && ! doing_action( 'login_init' ) ) {
- return new WP_Error( 'nonce_invalid_user_mismatch', 'User ID mismatch.', array( 'status' => 401 ) );
- }
- return true;
- }
- /**
- * Filters the WordPress salt.
- *
- * @param string $salt Salt for the given scheme.
- * @param string $scheme Authentication scheme.
- * @return string
- */
- public function filter_salt( $salt, $scheme ) {
- if ( 'jetpack_frame_nonce' === $scheme ) {
- $token = ( new Tokens() )->get_access_token( $this->nonce_user_id );
- if ( $token ) {
- $salt = $token->secret;
- }
- }
- return $salt;
- }
- /**
- * Enqueues the WordPress.com block editor integration assets for the editor.
- */
- public function enqueue_block_editor_assets() {
- global $pagenow;
- // Bail if we're not in the post editor, but on the widget settings screen.
- if ( is_customize_preview() || 'widgets.php' === $pagenow ) {
- return;
- }
- $debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
- $version = gmdate( 'Ymd' );
- wp_enqueue_script(
- 'wpcom-block-editor-default-editor-script',
- $debug
- ? '//widgets.wp.com/wpcom-block-editor/default.editor.js?minify=false'
- : '//widgets.wp.com/wpcom-block-editor/default.editor.min.js',
- array(
- 'jquery',
- 'lodash',
- 'wp-annotations',
- 'wp-compose',
- 'wp-data',
- 'wp-editor',
- 'wp-element',
- 'wp-rich-text',
- ),
- $version,
- true
- );
- wp_localize_script(
- 'wpcom-block-editor-default-editor-script',
- 'wpcomGutenberg',
- array(
- 'richTextToolbar' => array(
- 'justify' => __( 'Justify', 'jetpack' ),
- 'underline' => __( 'Underline', 'jetpack' ),
- ),
- )
- );
- if ( jetpack_is_atomic_site() ) {
- wp_enqueue_script(
- 'wpcom-block-editor-wpcom-editor-script',
- $debug
- ? '//widgets.wp.com/wpcom-block-editor/wpcom.editor.js?minify=false'
- : '//widgets.wp.com/wpcom-block-editor/wpcom.editor.min.js',
- array(
- 'lodash',
- 'wp-blocks',
- 'wp-data',
- 'wp-dom-ready',
- 'wp-plugins',
- ),
- $version,
- true
- );
- }
- if ( $this->is_iframed_block_editor() ) {
- wp_enqueue_script(
- 'wpcom-block-editor-calypso-editor-script',
- $debug
- ? '//widgets.wp.com/wpcom-block-editor/calypso.editor.js?minify=false'
- : '//widgets.wp.com/wpcom-block-editor/calypso.editor.min.js',
- array(
- 'calypsoify_wpadminmods_js',
- 'jquery',
- 'lodash',
- 'react',
- 'wp-blocks',
- 'wp-data',
- 'wp-hooks',
- 'wp-tinymce',
- 'wp-url',
- ),
- $version,
- true
- );
- wp_enqueue_style(
- 'wpcom-block-editor-calypso-editor-styles',
- $debug
- ? '//widgets.wp.com/wpcom-block-editor/calypso.editor.css?minify=false'
- : '//widgets.wp.com/wpcom-block-editor/calypso.editor.min.css',
- array(),
- $version
- );
- }
- }
- /**
- * Enqueues the WordPress.com block editor integration assets for both editor and front-end.
- */
- public function enqueue_block_assets() {
- // These styles are manually copied from //widgets.wp.com/wpcom-block-editor/default.view.css in order to
- // improve the performance by avoiding an extra network request to download the CSS file on every page.
- wp_add_inline_style( 'wp-block-library', '.has-text-align-justify{text-align:justify;}' );
- }
- /**
- * Determines if the current $post contains a justified paragraph block.
- *
- * @return boolean true if justified paragraph is found, false otherwise.
- */
- public function has_justified_block() {
- global $post;
- if ( ! $post instanceof WP_Post ) {
- return false;
- };
- if ( ! has_blocks( $post ) ) {
- return false;
- }
- return false !== strpos( $post->post_content, '<!-- wp:paragraph {"align":"justify"' );
- }
- /**
- * Register the Tiny MCE plugins for the WordPress.com block editor integration.
- *
- * @param array $plugin_array An array of external Tiny MCE plugins.
- * @return array External TinyMCE plugins.
- */
- public function add_tinymce_plugins( $plugin_array ) {
- if ( $this->is_iframed_block_editor() ) {
- $debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
- $plugin_array['gutenberg-wpcom-iframe-media-modal'] = add_query_arg(
- 'v',
- gmdate( 'YW' ),
- $debug
- ? '//widgets.wp.com/wpcom-block-editor/calypso.tinymce.js?minify=false'
- : '//widgets.wp.com/wpcom-block-editor/calypso.tinymce.min.js'
- );
- }
- return $plugin_array;
- }
- /**
- * Ensures the authentication cookies are designated for cross-site access.
- */
- private function enable_cross_site_auth_cookies() {
- /**
- * Allow plugins to disable the cross-site auth cookies.
- *
- * @since 8.1.1
- *
- * @param false bool Whether auth cookies should be disabled for cross-site access. False by default.
- */
- if ( apply_filters( 'jetpack_disable_cross_site_auth_cookies', false ) ) {
- return;
- }
- add_action( 'set_auth_cookie', array( $this, 'set_samesite_auth_cookies' ), 10, 5 );
- add_action( 'set_logged_in_cookie', array( $this, 'set_samesite_logged_in_cookies' ), 10, 4 );
- add_filter( 'send_auth_cookies', array( $this, 'maybe_send_cookies' ), 9999 );
- }
- /**
- * Checks if we've stored any cookies to send and then sends them
- * if the send_auth_cookies value is true.
- *
- * @param bool $send_cookies The filtered value that determines whether to send auth cookies.
- */
- public function maybe_send_cookies( $send_cookies ) {
- if ( ! empty( $this->set_cookie_args ) && $send_cookies ) {
- array_map(
- function ( $cookie ) {
- call_user_func_array( 'jetpack_shim_setcookie', $cookie );
- },
- $this->set_cookie_args
- );
- $this->set_cookie_args = array();
- return false;
- }
- return $send_cookies;
- }
- /**
- * Gets the SameSite attribute to use in auth cookies.
- *
- * @param bool $secure Whether the connection is secure.
- * @return string SameSite attribute to use on auth cookies.
- */
- public function get_samesite_attr_for_auth_cookies( $secure ) {
- $samesite = $secure ? 'None' : 'Lax';
- /**
- * Filters the SameSite attribute to use in auth cookies.
- *
- * @param string $samesite SameSite attribute to use in auth cookies.
- *
- * @since 8.1.1
- */
- $samesite = apply_filters( 'jetpack_auth_cookie_samesite', $samesite );
- return $samesite;
- }
- /**
- * Generates cross-site auth cookies so they can be accessed by WordPress.com.
- *
- * @param string $auth_cookie Authentication cookie value.
- * @param int $expire The time the login grace period expires as a UNIX timestamp.
- * Default is 12 hours past the cookie's expiration time.
- * @param int $expiration The time when the authentication cookie expires as a UNIX timestamp.
- * Default is 14 days from now.
- * @param int $user_id User ID.
- * @param string $scheme Authentication scheme. Values include 'auth' or 'secure_auth'.
- */
- public function set_samesite_auth_cookies( $auth_cookie, $expire, $expiration, $user_id, $scheme ) {
- if ( wp_startswith( $scheme, 'secure_' ) ) {
- $secure = true;
- $auth_cookie_name = SECURE_AUTH_COOKIE;
- } else {
- $secure = false;
- $auth_cookie_name = AUTH_COOKIE;
- }
- $samesite = $this->get_samesite_attr_for_auth_cookies( $secure );
- $this->set_cookie_args[] = array(
- $auth_cookie_name,
- $auth_cookie,
- array(
- 'expires' => $expire,
- 'path' => PLUGINS_COOKIE_PATH,
- 'domain' => COOKIE_DOMAIN,
- 'secure' => $secure,
- 'httponly' => true,
- 'samesite' => $samesite,
- ),
- );
- $this->set_cookie_args[] = array(
- $auth_cookie_name,
- $auth_cookie,
- array(
- 'expires' => $expire,
- 'path' => ADMIN_COOKIE_PATH,
- 'domain' => COOKIE_DOMAIN,
- 'secure' => $secure,
- 'httponly' => true,
- 'samesite' => $samesite,
- ),
- );
- }
- /**
- * Generates cross-site logged in cookies so they can be accessed by WordPress.com.
- *
- * @param string $logged_in_cookie The logged-in cookie value.
- * @param int $expire The time the login grace period expires as a UNIX timestamp.
- * Default is 12 hours past the cookie's expiration time.
- * @param int $expiration The time when the logged-in cookie expires as a UNIX timestamp.
- * Default is 14 days from now.
- * @param int $user_id User ID.
- */
- public function set_samesite_logged_in_cookies( $logged_in_cookie, $expire, $expiration, $user_id ) {
- $secure = is_ssl();
- // Front-end cookie is secure when the auth cookie is secure and the site's home URL is forced HTTPS.
- $secure_logged_in_cookie = $secure && 'https' === wp_parse_url( get_option( 'home' ), PHP_URL_SCHEME );
- /** This filter is documented in core/src/wp-includes/pluggable.php */
- $secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
- /** This filter is documented in core/src/wp-includes/pluggable.php */
- $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', $secure_logged_in_cookie, $user_id, $secure );
- $samesite = $this->get_samesite_attr_for_auth_cookies( $secure_logged_in_cookie );
- $this->set_cookie_args[] = array(
- LOGGED_IN_COOKIE,
- $logged_in_cookie,
- array(
- 'expires' => $expire,
- 'path' => COOKIEPATH,
- 'domain' => COOKIE_DOMAIN,
- 'secure' => $secure_logged_in_cookie,
- 'httponly' => true,
- 'samesite' => $samesite,
- ),
- );
- if ( COOKIEPATH !== SITECOOKIEPATH ) {
- $this->set_cookie_args[] = array(
- LOGGED_IN_COOKIE,
- $logged_in_cookie,
- array(
- 'expires' => $expire,
- 'path' => SITECOOKIEPATH,
- 'domain' => COOKIE_DOMAIN,
- 'secure' => $secure_logged_in_cookie,
- 'httponly' => true,
- 'samesite' => $samesite,
- ),
- );
- }
- }
- }
- Jetpack_WPCOM_Block_Editor::init();
|