sitemap-buffer-fallback.php — Jetpack – WP Security, Backup, Speed, & Growth 13.3.3

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

jetpack / modules / sitemaps Last commit date

sitemap-buffer-fallback.php

155 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* The fallback buffer for users with no XML support.
4	*
5	* @since 5.3.0
6	* @package automattic/jetpack
7	*/
8
9	/**
10	* A buffer for constructing master sitemap xml files.
11	*
12	* @since 5.1.0
13	*/
14	abstract class Jetpack_Sitemap_Buffer_Fallback extends Jetpack_Sitemap_Buffer {
15
16	/**
17	* The buffer contents.
18	*
19	* @access protected
20	* @since 5.3.0
21	* @var string The buffer contents.
22	*/
23	protected $buffer;
24
25	/**
26	* Jetpack_Sitemap_Buffer_Fallback constructor.
27	*
28	* @param int $item_limit The maximum size of the buffer in items.
29	* @param int $byte_limit The maximum size of the buffer in bytes.
30	* @param string $time The initial datetime of the buffer. Must be in 'YYYY-MM-DD hh:mm:ss' format.
31	*/
32	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
33	$this->is_full_flag = false;
34	$this->is_empty_flag = true;
35	$this->timestamp = $time;
36
37	$this->finder = new Jetpack_Sitemap_Finder();
38
39	$this->item_capacity = max( 1, (int) $item_limit );
40	$this->byte_capacity = max( 1, (int) $byte_limit ) - strlen( $this->contents() );
41	}
42
43	/**
44	* Append an item to the buffer, if there is room for it,
45	* and set is_empty_flag to false. If there is no room,
46	* we set is_full_flag to true. If $item is null,
47	* don't do anything and report success.
48	*
49	* @since 5.3.0
50	*
51	* @param array $array The item to be added.
52	*
53	* @return bool True if the append succeeded, False if not.
54	*/
55	public function append( $array ) {
56	if ( $array === null ) {
57	return true;
58	}
59
60	if ( $this->is_full_flag ) {
61	return false;
62	}
63
64	if ( 0 >= $this->item_capacity \|\| 0 >= $this->byte_capacity ) {
65	$this->is_full_flag = true;
66	return false;
67	} else {
68	$this->item_capacity -= 1;
69	$added_string = $this->array_to_xml_string( $array );
70	$this->buffer .= $added_string;
71	$this->is_empty_flag = false;
72
73	mbstring_binary_safe_encoding(); // So we can safely use strlen().
74	$this->byte_capacity -= strlen( $added_string );
75	reset_mbstring_encoding();
76
77	return true;
78	}
79	}
80
81	/**
82	* Detect whether the buffer is empty.
83	*
84	* @since 5.3.0
85	*
86	* @return bool True if the buffer is empty, false otherwise.
87	*/
88	public function is_empty() {
89	return $this->is_empty_flag;
90	}
91
92	/**
93	* Retrieve the contents of the buffer.
94	*
95	* @since 5.3.0
96	*
97	* @return string The contents of the buffer (with the footer included).
98	*/
99	public function contents() {
100	$root = $this->get_root_element();
101
102	return '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL . $root[0] . $this->buffer . $root[1] . PHP_EOL;
103	}
104
105	/**
106	* Legacy implementation of array to XML conversion without using DOMDocument.
107	*
108	* @param array $array Item to append to buffer.
109	* @param DOMElement $parent (optional) an element to which new children should be added.
110	* @param DOMDocument $root (optional) the parent document.
111	* @return String $result
112	*/
113	public function array_to_xml_string( $array, $parent = null, $root = null ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
114	$string = '';
115
116	foreach ( $array as $key => $value ) {
117	// Only allow a-z, A-Z, colon, underscore, and hyphen.
118	$tag = preg_replace( '/[^a-zA-Z:_-]/', '_', $key );
119
120	if ( is_array( $value ) ) {
121	$string .= "<$tag>";
122	$string .= $this->array_to_xml_string( $value );
123	$string .= "</$tag>";
124	} elseif ( $value === null ) {
125	$string .= "<$tag />";
126	} else {
127	$string .= "<$tag>" . htmlspecialchars( $value, ENT_COMPAT ) . "</$tag>";
128	}
129	}
130
131	return $string;
132	}
133
134	/**
135	* Render an associative array of XML attribute key/value pairs.
136	*
137	* @access public
138	* @since 5.3.0
139	*
140	* @param array $array Key/value array of attributes.
141	*
142	* @return string The rendered attribute string.
143	*/
144	public static function array_to_xml_attr_string( $array ) {
145	$string = '';
146
147	foreach ( $array as $key => $value ) {
148	$key = preg_replace( '/[^a-zA-Z:_-]/', '_', $key );
149	$string .= ' ' . $key . '="' . esc_attr( $value ) . '"';
150	}
151
152	return $string;
153	}
154	}
155