sitemap-buffer-xmlwriter.php — Jetpack – WP Security, Backup, Speed, & Growth 14.6.1

jetpack / modules / sitemaps / sitemap-buffer-xmlwriter.php

jetpack / modules / sitemaps Last commit date

sitemap-buffer-xmlwriter.php

237 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* XMLWriter implementation of the sitemap buffer.
4	*
5	* @since 14.6
6	* @package automattic/jetpack
7	*/
8
9	/**
10	* A buffer for constructing sitemap xml files using XMLWriter.
11	*
12	* @since 14.6
13	*/
14	abstract class Jetpack_Sitemap_Buffer_XMLWriter {
15
16	/**
17	* Largest number of items the buffer can hold.
18	*
19	* @access protected
20	* @since 14.6
21	* @var int $item_capacity The item capacity.
22	*/
23	protected $item_capacity;
24
25	/**
26	* Largest number of bytes the buffer can hold.
27	*
28	* @access protected
29	* @since 14.6
30	* @var int $byte_capacity The byte capacity.
31	*/
32	protected $byte_capacity;
33
34	/**
35	* Flag which detects when the buffer is full.
36	*
37	* @access protected
38	* @since 14.6
39	* @var bool $is_full_flag The flag value.
40	*/
41	protected $is_full_flag;
42
43	/**
44	* The most recent timestamp seen by the buffer.
45	*
46	* @access protected
47	* @since 14.6
48	* @var string $timestamp Must be in 'YYYY-MM-DD hh:mm:ss' format.
49	*/
50	protected $timestamp;
51
52	/**
53	* The XMLWriter instance used to construct the XML.
54	*
55	* @access protected
56	* @since 14.6
57	* @var XMLWriter $writer
58	*/
59	protected $writer;
60
61	/**
62	* Helper class to construct sitemap paths.
63	*
64	* @since 14.6
65	* @protected
66	* @var Jetpack_Sitemap_Finder
67	*/
68	protected $finder;
69
70	/**
71	* The XML content as a string.
72	*
73	* @access protected
74	* @since 14.6
75	* @var string $content
76	*/
77	protected $content = '';
78
79	/**
80	* Construct a new Jetpack_Sitemap_Buffer_XMLWriter.
81	*
82	* @since 14.6
83	*
84	* @param int $item_limit The maximum size of the buffer in items.
85	* @param int $byte_limit The maximum size of the buffer in bytes.
86	* @param string $time The initial datetime of the buffer. Must be in 'YYYY-MM-DD hh:mm:ss' format.
87	*/
88	public function __construct( $item_limit, $byte_limit, $time ) {
89	$this->is_full_flag = false;
90	$this->timestamp = $time;
91	$this->finder = new Jetpack_Sitemap_Finder();
92
93	$this->writer = new XMLWriter();
94	$this->writer->openMemory();
95	$this->writer->setIndent( true );
96	$this->writer->startDocument( '1.0', 'UTF-8' );
97
98	$this->item_capacity = max( 1, (int) $item_limit );
99	$this->byte_capacity = max( 1, (int) $byte_limit );
100
101	$this->initialize_buffer();
102	}
103
104	/**
105	* Initialize the buffer with any required headers or setup.
106	* This should be implemented by child classes.
107	*
108	* @access protected
109	* @since 14.6
110	*/
111	abstract protected function initialize_buffer();
112
113	/**
114	* Append an item to the buffer.
115	*
116	* @since 14.6
117	*
118	* @param array $array The item to be added.
119	* @return bool True if the append succeeded, False if not.
120	*/
121	public function append( $array ) {
122	if ( $array === null ) {
123	return true;
124	}
125
126	if ( $this->is_full_flag ) {
127	return false;
128	}
129
130	if ( 0 >= $this->item_capacity \|\| 0 >= $this->byte_capacity ) {
131	$this->is_full_flag = true;
132	return false;
133	}
134
135	$current_content = $this->writer->outputMemory( true );
136	$this->content .= $current_content;
137
138	$this->append_item( $array );
139
140	$new_content = $this->writer->outputMemory( true );
141	$this->content .= $new_content;
142
143	// Update capacities after successful append
144	$this->item_capacity -= 1;
145	$this->byte_capacity -= strlen( $new_content );
146
147	// Check both capacity limits
148	if ( 0 >= $this->item_capacity \|\| $this->byte_capacity <= 0 ) {
149	$this->is_full_flag = true;
150	}
151
152	return true;
153	}
154
155	/**
156	* Append a specific item to the buffer.
157	* This should be implemented by child classes.
158	*
159	* @access protected
160	* @since 14.6
161	* @param array $array The item to be added.
162	*/
163	abstract protected function append_item( $array );
164
165	/**
166	* Retrieve the contents of the buffer.
167	*
168	* @since 14.6
169	* @return string The contents of the buffer.
170	*/
171	public function contents() {
172	$this->writer->endElement(); // End root element (urlset/sitemapindex)
173	$this->writer->endDocument();
174	$final_content = $this->writer->outputMemory( true );
175	$this->content .= $final_content;
176
177	if ( empty( $this->content ) ) {
178	// If buffer is empty, return a minimal valid XML structure
179	return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"></urlset>";
180	}
181	return $this->content;
182	}
183
184	/**
185	* Detect whether the buffer is full.
186	*
187	* @since 14.6
188	* @return bool True if the buffer is full, false otherwise.
189	*/
190	public function is_full() {
191	return $this->is_full_flag;
192	}
193
194	/**
195	* Detect whether the buffer is empty.
196	*
197	* @since 14.6
198	* @return bool True if the buffer is empty, false otherwise.
199	*/
200	public function is_empty() {
201	$current = $this->writer->outputMemory( true );
202	$this->content .= $current;
203	return empty( $this->content );
204	}
205
206	/**
207	* Update the timestamp of the buffer.
208	*
209	* @since 14.6
210	* @param string $new_time A datetime string in 'YYYY-MM-DD hh:mm:ss' format.
211	*/
212	public function view_time( $new_time ) {
213	$this->timestamp = max( $this->timestamp, $new_time );
214	}
215
216	/**
217	* Retrieve the timestamp of the buffer.
218	*
219	* @since 14.6
220	* @return string A datetime string in 'YYYY-MM-DD hh:mm:ss' format.
221	*/
222	public function last_modified() {
223	return $this->timestamp;
224	}
225
226	/**
227	* Compatibility method for the old DOMDocument implementation.
228	* This is only here to satisfy the jetpack_print_sitemap filter.
229	*
230	* @since 14.6
231	* @return null
232	*/
233	public function get_document() {
234	return null;
235	}
236	}
237