Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/block filters #432

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

Feature/block filters #432

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4e021c5
Parse gutenberg blocks and then iterate to allow filtering block attr…
cmmarslender Jul 17, 2019
4d197ad
Pass source and destination blog ID to the block filter
cmmarslender Jul 17, 2019
dfaca68
Don't set blockattributes if there are none. Fix spacing error that w…
cmmarslender Jul 18, 2019
32bc04a
Fixing some phpcs errors
cmmarslender Jul 18, 2019
1a5a9b2
Convert to UTF-8 encoding for DOMDocument
cmmarslender Jul 18, 2019
474f648
Merge branch 'develop' for 1.5.0
helen Jul 18, 2019
f7b6074
Merge branch 'develop' for 1.5.0, take 2
helen Jul 18, 2019
678b522
Merge branch 'develop' into feature/block-filters
cmmarslender Jul 18, 2019
c40f8ce
Fallback if mbstring is not present
cmmarslender Jul 18, 2019
62c2ae5
fixing whitespace error
Jan 16, 2020
d9c2c39
Merge branch 'master' of github.com:10up/distributor into feature/blo…
Mar 4, 2020
96a6b14
check if DOMDocument exists
Mar 4, 2020
2aa455a
whitespace
Mar 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 129 additions & 1 deletion includes/classes/InternalConnections/NetworkSiteConnection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ public function push( $post_id, $args = array() ) {
// Distribute raw HTML when going from Gutenberg enabled to Gutenberg enabled.
$remote_using_gutenberg = \Distributor\Utils\is_using_gutenberg( $post );
if ( $using_gutenberg && $remote_using_gutenberg ) {
$new_post_args['post_content'] = $post->post_content;

// If DOMDocument is not installed, skip parsing the content.
if ( class_exists( 'DOMDocument' ) ) {
$new_post_args['post_content'] = $this->filter_gutenberg_blocks( $post->post_content, $post_id, $original_blog_id, $this->site->blog_id );
} else {
$new_post_args['post_content'] = $post->post_content;
}
}

// Handle existing posts.
Expand Down Expand Up @@ -159,6 +165,128 @@ public function push( $post_id, $args = array() ) {
return $new_post_id;
}

/**
* Parses and allows filtering on the gutenberg blocks and their attributes
*
* @param string $content post content of the source post
* @param int $source_post_id Post ID on the source site
* @param int $source_blog_id ID of the source blog for the post
* @param int $destination_blog_id ID of the destination site for the post
*
* @return mixed|string
*/
public function filter_gutenberg_blocks( $content, $source_post_id, $source_blog_id, $destination_blog_id ) {
$content = $this->gutenbergCommentsToElements( $content );

$dom = new \DOMDocument();

$converted_content = function_exists( 'mb_convert_encoding' ) ? mb_convert_encoding( $content, 'HTML-ENTITIES', 'UTF-8' ) : htmlspecialchars_decode( utf8_decode( htmlentities( $content, ENT_COMPAT, 'utf-8', false ) ) );

$dom->loadHTML( $converted_content );

$body = $dom->getElementsByTagName( 'body' )->item( 0 );
foreach ( $body->childNodes as $node ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName
if ( 'gutenberg' !== $node->tagName ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName
continue;
}

$block_name = $node->getAttribute( 'blockname' );
$block_attributes = json_decode( $node->getAttribute( 'blockattributes' ), true );

/**
* Action fired when a sync is being logged.
*
* @since 1.6.0
*
* @param array $block_attributes Array of block attributes from the comment json
* @param string $block_name The name of the block
* @param int $source_post_id The post ID on the originating site
* @param int $source_blog_id The blog_id of the source site
*/
$block_attributes = apply_filters( 'dt_filter_block_attributes', $block_attributes, $block_name, $source_post_id, $source_blog_id, $destination_blog_id );

if ( ! empty( $block_attributes ) ) {
$node->setAttribute( 'blockattributes', wp_json_encode( $block_attributes ) );
} else {
$node->removeAttribute( 'blockattributes' );
}
}

$string = $dom->saveHTML( $dom->getElementsByTagName( 'body' )->item( 0 ) );

$string = str_replace( '<body>', '', $string );
$string = str_replace( '</body>', '', $string );

$string = $this->gutenbergElementsToComments( $string );

return $string;
}

/**
* Converts post content with gutenberg html comments to <gutenberg> elements
*
* @param string $content Post content with gutenberg comments
*
* @return string Modified content
*/
public function gutenbergCommentsToElements( $content ) {
// Replace opening gutenberg comments with custom html elements
$content = preg_replace( '/<!-- wp:([^>]*)-->/i', '<gutenberg wp:$1>', $content );

// Add a closing </gutenberg> html element after the closing gutenberg comment
// Retaining the actual gutenberg closing comment so we can reliably close blocks when converting back to comments later
$content = preg_replace( '/(<!-- \/wp:[^>]*>)/i', '$1</gutenberg>', $content );

// Put block name into an html attribute
$content = preg_replace( '/<gutenberg wp:([^\s]*)/i', '<gutenberg blockname="$1"', $content );

// put block attributes into an html attribute
$content = preg_replace_callback(
'/<gutenberg[^{^>]+(\{.*})[\s\/]{0,2}>/i',
function( $matches ) {
if ( ! isset( $matches[1] ) || empty( $matches[1] ) ) {
return $matches[0];
}

$original_json = $matches[1];

return str_replace( $original_json, 'blockattributes=\'' . $original_json . '\'', $matches[0] );
},
$content
);

return $content;
}

/**
* Converts post content with <gutenberg> elements back to standard gutenberg html comments
*
* @param string $content Content with gutenberg elements to replace
*
* @return string Final content with gutenberg elements back to gutenberg comments
*/
public function gutenbergElementsToComments( $content ) {
// blockAttributes back to just plain inline json
$content = preg_replace( '/blockattributes=\'([^\']*)\'/i', '$1 ', $content ); // Extra space following } is intentional

// Put block name back to the inline wp:<name> format
$content = preg_replace( '/blockname="([^"]*)"/i', 'wp:$1', $content );

// Find any that should be self closing, and convert them to self closing gutenberg comments
$content = preg_replace( '/<gutenberg (wp:[^>]*)><\/gutenberg>/i', '<!-- $1 /-->', $content );

// Convert any opening tags to opening gutenberg comments
$content = preg_replace( '/<gutenberg (wp:[^>]*)>/i', '<!-- $1 -->', $content );

// Since we left the closing comments inline, we can just get rid of the </gutenberg> elements that are left
$content = str_replace( '</gutenberg>', '', $content );

// In some cases, we introduce double spaces before closing comment, so get rid of any of those
$content = str_replace( ' -->', ' -->', $content );

return $content;
}

/**
* Pull items. Pass array of posts, each post should look like:
* [ 'remote_post_id' => POST ID TO GET, 'post_id' (optional) => POST ID TO MAP TO ]
Expand Down