class-staticpostfileswriter.php — Jetpack – WP Security, Backup, Speed, & Growth 16.1-beta.3

jetpack / vendor / wp-php-toolkit / data-liberation / EntityWriter / class-staticpostfileswriter.php

jetpack / vendor / wp-php-toolkit / data-liberation / EntityWriter Last commit date

class-mysqldumpwriter.php 6 days ago class-staticpostfileswriter.php 6 days ago class-wxrwriter.php 6 days ago interface-entity-writer.php 6 days ago

class-staticpostfileswriter.php

150 lines

1	<?php
2
3	namespace WordPress\DataLiberation\EntityWriter;
4
5	use WordPress\DataLiberation\DataFormatConsumer\BlocksWithMetadata;
6	use WordPress\DataLiberation\DataLiberationException;
7	use WordPress\DataLiberation\ImportEntity;
8	use WordPress\Filesystem\Filesystem;
9
10	use function WordPress\Filesystem\wp_join_unix_paths;
11
12	class StaticPostFilesWriter implements EntityWriter {
13
14	private $filesystem;
15	private $state = self::STATE_WRITING;
16	private $directory_scheme;
17	private $parent_stack = array();
18	private $pending_parent_path = '/';
19	private $pending_post;
20	private $pending_metadata;
21	private $static_content_producer_factory;
22	private $file_extension;
23
24	const STATE_WRITING = 'writing';
25	const STATE_FINALIZING = 'finalizing';
26	const STATE_CLOSED = 'closed';
27
28	const SCHEME_DATE = 'date';
29	const SCHEME_PARENT_TRAIL = 'parent_trail';
30
31	public function __construct( Filesystem $filesystem, $options = array() ) {
32	$this->filesystem = $filesystem;
33	$this->directory_scheme = $options['directory_scheme'] ?? self::SCHEME_DATE;
34	if ( self::SCHEME_DATE !== $this->directory_scheme && self::SCHEME_PARENT_TRAIL !== $this->directory_scheme ) {
35	throw new DataLiberationException( sprintf( 'Invalid directory scheme: %s', esc_html( $this->directory_scheme ) ) );
36	}
37	if ( ! isset( $options['static_content_producer_factory'] ) ) {
38	throw new DataLiberationException( 'static_content_producer_factory is required' );
39	}
40	$this->static_content_producer_factory = $options['static_content_producer_factory'];
41	if ( ! isset( $options['file_extension'] ) ) {
42	throw new DataLiberationException( 'file_extension is required' );
43	}
44	$this->file_extension = $options['file_extension'];
45	if ( isset( $options['cursor'] ) ) {
46	$this->restore_from_cursor( $options['cursor'] );
47	}
48	}
49
50	public function append_entity( ImportEntity $entity ) {
51	if ( self::STATE_CLOSED === $this->state ) {
52	throw new DataLiberationException( 'Cannot write to a closed writer' );
53	}
54
55	$data = $entity->get_data();
56
57	switch ( $entity->get_type() ) {
58	case 'post':
59	$post_data = $entity->get_data();
60	$post_data['post_parent'] = $post_data['post_parent'] ?? 0;
61	$parent_id = $post_data['post_parent'];
62
63	// Update the parent stack.
64	$pending_post_was_a_parent = true;
65	while ( ! empty( $this->parent_stack ) && end( $this->parent_stack )['post_id'] !== $parent_id ) {
66	array_pop( $this->parent_stack );
67	$pending_post_was_a_parent = false;
68	}
69
70	if ( $this->pending_post ) {
71	$this->finalize_pending_post( $pending_post_was_a_parent );
72	}
73	if ( self::SCHEME_PARENT_TRAIL === $this->directory_scheme ) {
74	$this->pending_parent_path = $this->create_parent_trail_directory();
75	} elseif ( self::SCHEME_DATE === $this->directory_scheme ) {
76	$this->pending_parent_path = $this->create_date_based_directory( $post_data );
77	}
78	$this->pending_post = $post_data;
79	$this->pending_metadata = array();
80
81	array_push( $this->parent_stack, $post_data );
82	break;
83
84	case 'post_meta':
85	// Attach meta to the current pending post.
86	$this->pending_metadata[ $data['meta_key'] ] = array( $data['meta_value'] );
87	break;
88	}
89	}
90
91	private function finalize_pending_post( $pending_post_was_a_parent ) {
92	if ( ! $this->pending_post ) {
93	return;
94	}
95
96	$path = $this->pending_parent_path;
97	$slug = $this->slugify( $this->pending_post['post_title'] );
98	if ( self::SCHEME_PARENT_TRAIL === $this->directory_scheme ) {
99	if ( $pending_post_was_a_parent ) {
100	$path = wp_join_unix_paths( $path, $slug, 'index.' . $this->file_extension );
101	} else {
102	$path = wp_join_unix_paths( $path, $slug . '.' . $this->file_extension );
103	}
104	} else {
105	$path = wp_join_unix_paths( $path, $slug . '.' . $this->file_extension );
106	}
107
108	$this->filesystem->mkdir( dirname( $path ), array( 'recursive' => true ) );
109
110	$content = new BlocksWithMetadata( $this->pending_post['content'], $this->pending_metadata );
111	$markdown_producer = call_user_func( $this->static_content_producer_factory, $content );
112	$contents = $markdown_producer->produce();
113
114	$this->filesystem->put_contents( $path, $contents );
115	}
116
117	private function create_parent_trail_directory() {
118	$base_path_segments = array( '/' );
119	foreach ( $this->parent_stack as $parent_post ) {
120	$base_path_segments[] = $this->slugify( $parent_post['post_title'] );
121	}
122
123	return wp_join_unix_paths( ...$base_path_segments );
124	}
125
126	private function create_date_based_directory( $post_data ) {
127	$base_path_segments = explode( '-', substr( $post_data['post_date'], 0, 10 ) );
128
129	return wp_join_unix_paths( ...$base_path_segments );
130	}
131
132	private function slugify( $title ) {
133	return preg_replace( '/[^a-z0-9]+/i', '-', trim( strtolower( $title ) ) );
134	}
135
136	public function close_writing() {
137	$this->state = self::STATE_FINALIZING;
138	$this->finalize_pending_post( false );
139	$this->state = self::STATE_CLOSED;
140	}
141
142	public function get_reentrancy_cursor(): string {
143	throw new DataLiberationException( 'Not implemented' );
144	}
145
146	private function restore_from_cursor( $cursor ) {
147	throw new DataLiberationException( 'Not implemented' );
148	}
149	}
150