Skip to content

Commit

Permalink
Support for the HTML format and changing file extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamziel
adamziel committed Jan 4, 2025
1 parent b13b833 commit 65c73bb
Show file tree
Hide file tree
Showing 11 changed files with 254 additions and 73 deletions.
7 changes: 5 additions & 2 deletions packages/playground/data-liberation-markdown/src/WP_Blocks_To_Markdown.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ class WP_Blocks_To_Markdown {
private $state;
private $parents = [];
private $metadata;
private $markdown;

public function __construct($block_markup, $metadata = []) {
$this->block_markup = $block_markup;
Expand All @@ -18,12 +19,14 @@ public function __construct($block_markup, $metadata = []) {
$this->metadata = $metadata;
}

private $markdown;

public function convert() {
if(null !== $this->markdown) {
return false;
}
$this->markdown = '';
$this->markdown .= $this->frontmatter();
$this->markdown .= $this->blocks_to_markdown(parse_blocks($this->block_markup));
return true;
}

public function get_result() {
Expand Down
10 changes: 8 additions & 2 deletions packages/playground/data-liberation-markdown/src/WP_Markdown_To_Blocks.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,14 @@ public function convert() {
return true;
}

public function get_all_metadata() {
return $this->frontmatter;
public function get_all_metadata($options=[]) {
$metadata = $this->frontmatter;
if(isset($options['first_value_only']) && $options['first_value_only']) {
$metadata = array_map(function($value) {
return $value[0];
}, $metadata);
}
return $metadata;
}

public function get_meta_value( $key ) {
Expand Down
154 changes: 106 additions & 48 deletions packages/playground/data-liberation-static-files-editor/plugin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,10 +429,10 @@ function() {
return;
}

$path = get_post_meta($post_id, 'local_file_path', true);
$content = self::convert_post_to_string($path, $post);
$content = self::convert_post_to_string($post);

$fs = self::get_fs();
$path = get_post_meta($post_id, 'local_file_path', true);
$fs->put_contents($path, $content, [
'message' => 'User saved ' . $post->post_title,
]);
Expand Down Expand Up @@ -460,12 +460,13 @@ function() {
return;
}

$content = self::convert_post_to_string($autosave);

$path = wp_join_paths(
'/' . WP_AUTOSAVES_DIRECTORY . '/',
get_post_meta($parent_post->ID, 'local_file_path', true)
);
$fs = self::get_fs();
$content = self::convert_post_to_string($path, $autosave);
$fs->put_contents($path, $content, [
'amend' => true,
]);
Expand Down Expand Up @@ -524,7 +525,7 @@ static public function resize_to_max_dimensions_if_files_is_an_image($image_path
}

static public function download_file_endpoint($request) {
$path = $request->get_param('path');
$path = wp_canonicalize_path($request->get_param('path'));
$fs = self::get_fs();

if($fs->is_dir($path)) {
Expand Down Expand Up @@ -613,27 +614,15 @@ static private function refresh_post_from_local_file($post) {
return false;
}
$extension = pathinfo($path, PATHINFO_EXTENSION);
switch($extension) {
case 'xhtml':
$converter = new WP_HTML_To_Blocks( WP_XML_Processor::create_from_string( $content ) );
break;
case 'html':
$converter = new WP_HTML_To_Blocks( WP_HTML_Processor::create_fragment( $content ) );
break;
case 'md':
$converter = new WP_Markdown_To_Blocks( $content );
break;
default:
return false;
$converter = self::parse_local_file($content, $extension);
if(!$converter) {
return false;
}
$converter->convert();

$metadata = [];
foreach($converter->get_all_metadata() as $key => $value) {
$metadata[$key] = $value[0];
}
$new_content = $converter->get_block_markup();
$new_content = self::wordpressify_static_assets_urls($new_content);
$new_content = self::wordpressify_static_assets_urls(
$converter->get_block_markup()
);
$metadata = $converter->get_all_metadata(['first_value_only' => true]);

$updated = wp_update_post(array(
'ID' => $post_id,
Expand All @@ -653,31 +642,73 @@ static private function refresh_post_from_local_file($post) {
}
}

static private function convert_post_to_string($path, $post) {
$post_id = $post->ID;
static private function parse_local_file($content, $format) {
switch($format) {
case 'xhtml':
$converter = new WP_HTML_To_Blocks( WP_XML_Processor::create_from_string( $content ) );
break;
case 'html':
$converter = new WP_HTML_With_Blocks_to_Blocks( $content );
break;
case 'md':
$converter = new WP_Markdown_To_Blocks( $content );
break;
default:
return false;
}
if(!$converter->convert()) {
throw new Exception('Failed to convert post to string');
return false;
}
return $converter;
}

static private function convert_post_to_string($post, $format=null) {
if($format === null) {
$path = get_post_meta($post->ID, 'local_file_path', true);
if($path) {
$format = pathinfo($path, PATHINFO_EXTENSION);
}
}
if($format === null) {
$format = 'html';
}

$extension = pathinfo($path, PATHINFO_EXTENSION);
$metadata = [];
foreach(['post_date_gmt', 'post_title', 'menu_order'] as $key) {
$metadata[$key] = get_post_field($key, $post->ID);
}
// @TODO: Also include actual post_meta. Which ones? All? The
// ones explicitly set by the user in the editor?
$content = get_post_field('post_content', $post_id);
$content = self::unwordpressify_static_assets_urls($content);
return self::convert_post_data_to_string(
$post->post_content,
$metadata,
$format
);
}

switch($extension) {
// @TODO: Add support for HTML and XHTML
case 'html':
case 'xhtml':
static private function convert_post_data_to_string($block_markup, $metadata, $format) {
$content = self::unwordpressify_static_assets_urls(
$block_markup
);

switch($format) {
case 'md':
$converter = new WP_Blocks_To_Markdown( $content, $metadata );
break;
case 'xhtml':
// @TODO: Add proper support for XHTML – perhaps via the serialize() method?
throw new Exception('Serializing to XHTML is not supported yet');
case 'html':
default:
return '';
$converter = new WP_Block_HTML_Serializer( $content, $metadata );
break;
}
if(!$converter->convert()) {
throw new Exception('Failed to convert post to string');
return false;
}
$converter->convert();
return $converter->get_result();
}

Expand Down Expand Up @@ -953,8 +984,7 @@ static public function get_or_create_post_for_file($request) {
return new WP_Error('synchronization_lock_failed', 'Failed to acquire synchronization lock');
}

$file_path = $request->get_param('path');
$file_path = '/' . ltrim($file_path, '/');
$file_path = wp_canonicalize_path($request->get_param('path'));
$create_file = $request->get_param('create_file');

if (!$file_path) {
Expand Down Expand Up @@ -1025,32 +1055,60 @@ static public function move_file_endpoint($request) {
if(!self::acquire_synchronization_lock()) {
return;
}
$from_path = $request->get_param('fromPath');
$to_path = $request->get_param('toPath');
$from_path = wp_canonicalize_path($request->get_param('fromPath'));
$to_path = wp_canonicalize_path($request->get_param('toPath'));

if (!$from_path || !$to_path) {
return new WP_Error('missing_path', 'Both source and target paths are required');
}

$fs = self::get_fs();
if(!$fs->is_file($from_path)) {
return new WP_Error('move_failed', sprintf('Failed to move file – source path is not a file (%s)', $from_path));
}

// Find and update associated post
$previous_content = $fs->get_contents($from_path);
$existing_posts = get_posts(array(
'post_type' => WP_LOCAL_FILE_POST_TYPE,
'meta_key' => 'local_file_path',
'meta_value' => $from_path,
'posts_per_page' => 1
));
$existing_post = count($existing_posts) > 0 ? $existing_posts[0] : null;

$moved = false;

if ($existing_post) {
// Regenerate the content from scratch if we're changing the file format.
$previous_extension = pathinfo($from_path, PATHINFO_EXTENSION);
$new_extension = pathinfo($to_path, PATHINFO_EXTENSION);
if($existing_post->post_type === WP_LOCAL_FILE_POST_TYPE && $previous_extension !== $new_extension) {
$converter = self::parse_local_file(
$previous_content,
$previous_extension
);
$new_content = self::convert_post_data_to_string(
$converter->get_block_markup(),
$converter->get_all_metadata(['first_value_only' => true]),
$new_extension
);
$fs->put_contents(
$to_path,
$new_content
);
$fs->rm($from_path);
$moved = true;
}

$fs = self::get_fs();
if (!$fs->rename($from_path, $to_path)) {
return new WP_Error('move_failed', 'Failed to move file');
// Update the local file path
if(false === update_post_meta($existing_post->ID, 'local_file_path', $to_path)) {
throw new Exception('Failed to update local file path');
}
}

if (!empty($existing_posts)) {
update_post_meta($existing_posts[0]->ID, 'local_file_path', $to_path);
wp_update_post(array(
'ID' => $existing_posts[0]->ID,
'post_title' => basename($to_path)
));
if(!$moved) {
$fs->rename($from_path, $to_path);
}

return array('success' => true);
Expand Down Expand Up @@ -1148,7 +1206,7 @@ static public function create_files_endpoint($request) {
}

static public function delete_path_endpoint($request) {
$path = $request->get_param('path');
$path = wp_canonicalize_path($request->get_param('path'));
if (!$path) {
return new WP_Error('missing_path', 'File path is required');
}
Expand Down
4 changes: 0 additions & 4 deletions ...playground/data-liberation-static-files-editor/ui/src/components/FilePickerTree/index.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -721,10 +721,6 @@ const NodeRow: React.FC<{
node.name.endsWith('.ico') ||
node.name.endsWith('.webp');

console.log({
node,
isImage,
});
return (
<>
{!isRoot && (
Expand Down
8 changes: 7 additions & 1 deletion packages/playground/data-liberation-static-files-editor/ui/src/index.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,13 @@ function ConnectedFilePickerTree() {
});
}
}
}, [hasLoadedPost, post, setPostLoading, selectedNode.postId]);
}, [
hasLoadedPost,
post,
setPostLoading,
selectedNode.postId,
selectedNode.path,
]);

const refreshFileTree = useCallback(async () => {
fileTreePromise = apiFetch({
Expand Down
2 changes: 2 additions & 0 deletions packages/playground/data-liberation/bootstrap.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@
require_once __DIR__ . '/src/block-markup/WP_URL_In_Text_Processor.php';
require_once __DIR__ . '/src/block-markup/WP_URL.php';
require_once __DIR__ . '/src/block-markup/WP_HTML_To_Blocks.php';
require_once __DIR__ . '/src/block-markup/WP_HTML_With_Blocks_to_Blocks.php';
require_once __DIR__ . '/src/block-markup/WP_Block_HTML_Serializer.php';

require_once __DIR__ . '/src/entity-readers/WP_Entity_Reader.php';
require_once __DIR__ . '/src/entity-readers/WP_HTML_Entity_Reader.php';
Expand Down
34 changes: 34 additions & 0 deletions packages/playground/data-liberation/src/block-markup/WP_Block_HTML_Serializer.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

/**
* Serializes WordPress blocks and metadata to Block HTML.
*/
class WP_Block_HTML_Serializer {
private $block_markup;
private $metadata;
private $result = '';

public function __construct($block_markup, $metadata = []) {
$this->block_markup = $block_markup;
$this->metadata = $metadata;
}

public function convert() {
foreach($this->metadata as $key => $value) {
$p = new WP_HTML_Tag_Processor('<meta>');
$p->next_tag();
$p->set_attribute('name', $key);
if(is_array($value) || is_object($value)) {
$value = json_encode($value);
}
$p->set_attribute('content', $value);
$this->result .= $p->get_updated_html() . "\n";
}
$this->result .= $this->block_markup;
return true;
}

public function get_result() {
return $this->result;
}
}
Loading

0 comments on commit 65c73bb

Please sign in to comment.