sitemap-buffer-fallback.php
2 years ago
sitemap-buffer-image-fallback.php
2 years ago
sitemap-buffer-image.php
4 years ago
sitemap-buffer-master-fallback.php
2 years ago
sitemap-buffer-master.php
4 years ago
sitemap-buffer-news-fallback.php
2 years ago
sitemap-buffer-news.php
4 years ago
sitemap-buffer-page-fallback.php
2 years ago
sitemap-buffer-page.php
4 years ago
sitemap-buffer-video-fallback.php
2 years ago
sitemap-buffer-video.php
4 years ago
sitemap-buffer.php
3 years ago
sitemap-builder.php
2 years ago
sitemap-constants.php
4 years ago
sitemap-finder.php
2 years ago
sitemap-librarian.php
2 years ago
sitemap-logger.php
4 years ago
sitemap-state.php
2 years ago
sitemap-stylist.php
2 years ago
sitemaps.php
2 years ago
sitemap-librarian.php
435 lines
| 1 | <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | /** |
| 3 | * Sitemaps are stored in the database using a custom table. This class |
| 4 | * provides a small API for storing and retrieving sitemap data so we can |
| 5 | * avoid lots of explicit SQL juggling while building sitemaps. This file |
| 6 | * also includes the SQL used to retrieve posts and images to be included |
| 7 | * in the sitemaps. |
| 8 | * |
| 9 | * @since 4.8.0 |
| 10 | * @package automattic/jetpack |
| 11 | */ |
| 12 | |
| 13 | /* Ensure sitemap constants are available. */ |
| 14 | require_once __DIR__ . '/sitemap-constants.php'; |
| 15 | |
| 16 | /** |
| 17 | * This object handles any database interaction required |
| 18 | * for sitemap generation. |
| 19 | * |
| 20 | * @since 4.8.0 |
| 21 | */ |
| 22 | class Jetpack_Sitemap_Librarian { |
| 23 | |
| 24 | /** |
| 25 | * Retrieve a single sitemap with given name and type. |
| 26 | * Returns null if no such sitemap exists. |
| 27 | * |
| 28 | * @access public |
| 29 | * @since 4.8.0 |
| 30 | * |
| 31 | * @param string $name Name of the sitemap to be retrieved. |
| 32 | * @param string $type Type of the sitemap to be retrieved. |
| 33 | * |
| 34 | * @return array $args { |
| 35 | * @type int $id ID number of the sitemap in the database. |
| 36 | * @type string $timestamp Most recent timestamp of the resources pointed to. |
| 37 | * @type string $name Name of the sitemap in the database. |
| 38 | * @type string $type Type of the sitemap in the database. |
| 39 | * @type string $text The content of the sitemap. |
| 40 | * } |
| 41 | */ |
| 42 | public function read_sitemap_data( $name, $type ) { |
| 43 | $post_array = get_posts( |
| 44 | array( |
| 45 | 'numberposts' => 1, |
| 46 | 'title' => $name, |
| 47 | 'post_type' => $type, |
| 48 | 'post_status' => 'draft', |
| 49 | ) |
| 50 | ); |
| 51 | |
| 52 | $the_post = array_shift( $post_array ); |
| 53 | |
| 54 | if ( null === $the_post ) { |
| 55 | return null; |
| 56 | } else { |
| 57 | return array( |
| 58 | 'id' => $the_post->ID, |
| 59 | 'timestamp' => $the_post->post_date, |
| 60 | 'name' => $the_post->post_title, |
| 61 | 'type' => $the_post->post_type, |
| 62 | 'text' => base64_decode( $the_post->post_content ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode |
| 63 | ); |
| 64 | } |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Store a sitemap of given type and index in the database. |
| 69 | * Note that the timestamp is reencoded as 'Y-m-d H:i:s'. |
| 70 | * |
| 71 | * If a sitemap with that type and name does not exist, create it. |
| 72 | * If a sitemap with that type and name does exist, update it. |
| 73 | * |
| 74 | * @access public |
| 75 | * @since 4.8.0 |
| 76 | * |
| 77 | * @param string $index Index of the sitemap to be stored. |
| 78 | * @param string $type Type of the sitemap to be stored. |
| 79 | * @param string $contents Contents of the sitemap to be stored. |
| 80 | * @param string $timestamp Timestamp of the sitemap to be stored, in 'YYYY-MM-DD hh:mm:ss' format. |
| 81 | */ |
| 82 | public function store_sitemap_data( $index, $type, $contents, $timestamp ) { |
| 83 | $name = jp_sitemap_filename( $type, $index ); |
| 84 | |
| 85 | $the_post = $this->read_sitemap_data( $name, $type ); |
| 86 | |
| 87 | if ( null === $the_post ) { |
| 88 | // Post does not exist. |
| 89 | wp_insert_post( |
| 90 | array( |
| 91 | 'post_title' => $name, |
| 92 | 'post_content' => base64_encode( $contents ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode |
| 93 | 'post_type' => $type, |
| 94 | 'post_date' => gmdate( 'Y-m-d H:i:s', strtotime( $timestamp ) ), |
| 95 | ) |
| 96 | ); |
| 97 | } else { |
| 98 | // Post does exist. |
| 99 | wp_insert_post( |
| 100 | array( |
| 101 | 'ID' => $the_post['id'], |
| 102 | 'post_title' => $name, |
| 103 | 'post_content' => base64_encode( $contents ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode |
| 104 | 'post_type' => $type, |
| 105 | 'post_date' => gmdate( 'Y-m-d H:i:s', strtotime( $timestamp ) ), |
| 106 | ) |
| 107 | ); |
| 108 | } |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Delete a sitemap by name and type. |
| 113 | * |
| 114 | * @access public |
| 115 | * @since 4.8.0 |
| 116 | * |
| 117 | * @param string $name Row name. |
| 118 | * @param string $type Row type. |
| 119 | * |
| 120 | * @return bool 'true' if a row was deleted, 'false' otherwise. |
| 121 | */ |
| 122 | public function delete_sitemap_data( $name, $type ) { |
| 123 | $the_post = $this->read_sitemap_data( $name, $type ); |
| 124 | |
| 125 | if ( null === $the_post ) { |
| 126 | return false; |
| 127 | } else { |
| 128 | wp_delete_post( $the_post['id'] ); |
| 129 | return true; |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Retrieve the contents of a sitemap with given name and type. |
| 135 | * If no such sitemap exists, return the empty string. Note that the |
| 136 | * returned string is run through wp_specialchars_decode. |
| 137 | * |
| 138 | * @access public |
| 139 | * @since 4.8.0 |
| 140 | * |
| 141 | * @param string $name Row name. |
| 142 | * @param string $type Row type. |
| 143 | * |
| 144 | * @return string Text of the specified sitemap, or the empty string. |
| 145 | */ |
| 146 | public function get_sitemap_text( $name, $type ) { |
| 147 | $row = $this->read_sitemap_data( $name, $type ); |
| 148 | |
| 149 | if ( null === $row ) { |
| 150 | return ''; |
| 151 | } else { |
| 152 | return $row['text']; |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Delete numbered sitemaps named prefix-(p+1), prefix-(p+2), ... |
| 158 | * until the first nonexistent sitemap is found. |
| 159 | * |
| 160 | * @access public |
| 161 | * @since 4.8.0 |
| 162 | * |
| 163 | * @param int $position Number before the first sitemap to be deleted. |
| 164 | * @param string $type Sitemap type. |
| 165 | */ |
| 166 | public function delete_numbered_sitemap_rows_after( $position, $type ) { |
| 167 | $any_left = true; |
| 168 | |
| 169 | while ( true === $any_left ) { |
| 170 | ++$position; |
| 171 | $name = jp_sitemap_filename( $type, $position ); |
| 172 | $any_left = $this->delete_sitemap_data( $name, $type ); |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Deletes all stored sitemap data. |
| 178 | * |
| 179 | * @access public |
| 180 | * @since 4.8.0 |
| 181 | */ |
| 182 | public function delete_all_stored_sitemap_data() { |
| 183 | $this->delete_sitemap_type_data( JP_MASTER_SITEMAP_TYPE ); |
| 184 | $this->delete_sitemap_type_data( JP_PAGE_SITEMAP_TYPE ); |
| 185 | $this->delete_sitemap_type_data( JP_PAGE_SITEMAP_INDEX_TYPE ); |
| 186 | $this->delete_sitemap_type_data( JP_IMAGE_SITEMAP_TYPE ); |
| 187 | $this->delete_sitemap_type_data( JP_IMAGE_SITEMAP_INDEX_TYPE ); |
| 188 | $this->delete_sitemap_type_data( JP_VIDEO_SITEMAP_TYPE ); |
| 189 | $this->delete_sitemap_type_data( JP_VIDEO_SITEMAP_INDEX_TYPE ); |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Deletes all sitemap data of specific type |
| 194 | * |
| 195 | * @access protected |
| 196 | * @since 5.3.0 |
| 197 | * |
| 198 | * @param String $type Type of sitemap. |
| 199 | */ |
| 200 | protected function delete_sitemap_type_data( $type ) { |
| 201 | $ids = get_posts( |
| 202 | array( |
| 203 | 'post_type' => $type, |
| 204 | 'post_status' => 'draft', |
| 205 | 'fields' => 'ids', |
| 206 | ) |
| 207 | ); |
| 208 | |
| 209 | foreach ( $ids as $id ) { |
| 210 | wp_trash_post( $id ); |
| 211 | } |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * Retrieve an array of sitemap rows (of a given type) sorted by ID. |
| 216 | * |
| 217 | * Returns the smallest $num_posts sitemap rows (measured by ID) |
| 218 | * of the given type which are larger than $from_id. |
| 219 | * |
| 220 | * @access public |
| 221 | * @since 4.8.0 |
| 222 | * |
| 223 | * @param string $type Type of the sitemap rows to retrieve. |
| 224 | * @param int $from_id Greatest lower bound of retrieved sitemap post IDs. |
| 225 | * @param int $num_posts Largest number of sitemap posts to retrieve. |
| 226 | * |
| 227 | * @return array The sitemaps, as an array of associative arrays. |
| 228 | */ |
| 229 | public function query_sitemaps_after_id( $type, $from_id, $num_posts ) { |
| 230 | global $wpdb; |
| 231 | |
| 232 | return $wpdb->get_results( |
| 233 | $wpdb->prepare( |
| 234 | "SELECT * |
| 235 | FROM $wpdb->posts |
| 236 | WHERE post_type=%s |
| 237 | AND post_status=%s |
| 238 | AND ID>%d |
| 239 | ORDER BY ID ASC |
| 240 | LIMIT %d;", |
| 241 | $type, |
| 242 | 'draft', |
| 243 | $from_id, |
| 244 | $num_posts |
| 245 | ), |
| 246 | ARRAY_A |
| 247 | ); // WPCS: db call ok; no-cache ok. |
| 248 | } |
| 249 | |
| 250 | /** |
| 251 | * Retrieve an array of posts sorted by ID. |
| 252 | * |
| 253 | * More precisely, returns the smallest $num_posts posts |
| 254 | * (measured by ID) which are larger than $from_id. |
| 255 | * |
| 256 | * @access public |
| 257 | * @since 4.8.0 |
| 258 | * |
| 259 | * @param int $from_id Greatest lower bound of retrieved post IDs. |
| 260 | * @param int $num_posts Largest number of posts to retrieve. |
| 261 | * |
| 262 | * @return array The posts. |
| 263 | */ |
| 264 | public function query_posts_after_id( $from_id, $num_posts ) { |
| 265 | global $wpdb; |
| 266 | |
| 267 | // Get the list of post types to include and prepare for query. |
| 268 | $post_types = Jetpack_Options::get_option_and_ensure_autoload( |
| 269 | 'jetpack_sitemap_post_types', |
| 270 | array( 'page', 'post' ) |
| 271 | ); |
| 272 | foreach ( (array) $post_types as $i => $post_type ) { |
| 273 | $post_types[ $i ] = $wpdb->prepare( '%s', $post_type ); |
| 274 | } |
| 275 | $post_types_list = implode( ',', $post_types ); |
| 276 | |
| 277 | // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- WPCS: db call ok; no-cache ok. |
| 278 | return $wpdb->get_results( |
| 279 | $wpdb->prepare( |
| 280 | "SELECT * |
| 281 | FROM $wpdb->posts |
| 282 | WHERE post_status='publish' |
| 283 | AND post_type IN ($post_types_list) |
| 284 | AND ID>%d |
| 285 | ORDER BY ID ASC |
| 286 | LIMIT %d;", |
| 287 | $from_id, |
| 288 | $num_posts |
| 289 | ) |
| 290 | ); |
| 291 | // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 292 | } |
| 293 | |
| 294 | /** |
| 295 | * Get the most recent timestamp among approved comments for the given post_id. |
| 296 | * |
| 297 | * @access public |
| 298 | * @since 4.8.0 |
| 299 | * |
| 300 | * @param int $post_id Post identifier. |
| 301 | * |
| 302 | * @return string Timestamp in 'Y-m-d h:i:s' format (UTC) of the most recent comment on the given post, or null if no such comments exist. |
| 303 | */ |
| 304 | public function query_latest_approved_comment_time_on_post( $post_id ) { |
| 305 | global $wpdb; |
| 306 | |
| 307 | return $wpdb->get_var( |
| 308 | $wpdb->prepare( |
| 309 | "SELECT MAX(comment_date_gmt) |
| 310 | FROM $wpdb->comments |
| 311 | WHERE comment_post_ID = %d AND comment_approved = '1' AND comment_type in ( '', 'comment' )", |
| 312 | $post_id |
| 313 | ) |
| 314 | ); |
| 315 | } |
| 316 | |
| 317 | /** |
| 318 | * Retrieve an array of image posts sorted by ID. |
| 319 | * |
| 320 | * More precisely, returns the smallest $num_posts image posts |
| 321 | * (measured by ID) which are larger than $from_id. |
| 322 | * |
| 323 | * @access public |
| 324 | * @since 4.8.0 |
| 325 | * |
| 326 | * @param int $from_id Greatest lower bound of retrieved image post IDs. |
| 327 | * @param int $num_posts Largest number of image posts to retrieve. |
| 328 | * |
| 329 | * @return array The posts. |
| 330 | */ |
| 331 | public function query_images_after_id( $from_id, $num_posts ) { |
| 332 | global $wpdb; |
| 333 | |
| 334 | return $wpdb->get_results( |
| 335 | $wpdb->prepare( |
| 336 | "SELECT * |
| 337 | FROM $wpdb->posts |
| 338 | WHERE post_type='attachment' |
| 339 | AND post_mime_type LIKE %s |
| 340 | AND ID>%d |
| 341 | ORDER BY ID ASC |
| 342 | LIMIT %d;", |
| 343 | 'image/%', |
| 344 | $from_id, |
| 345 | $num_posts |
| 346 | ) |
| 347 | ); // WPCS: db call ok; no-cache ok. |
| 348 | } |
| 349 | |
| 350 | /** |
| 351 | * Retrieve an array of video posts sorted by ID. |
| 352 | * |
| 353 | * More precisely, returns the smallest $num_posts video posts |
| 354 | * (measured by ID) which are larger than $from_id. |
| 355 | * |
| 356 | * @access public |
| 357 | * @since 4.8.0 |
| 358 | * |
| 359 | * @param int $from_id Greatest lower bound of retrieved video post IDs. |
| 360 | * @param int $num_posts Largest number of video posts to retrieve. |
| 361 | * |
| 362 | * @return array The posts. |
| 363 | */ |
| 364 | public function query_videos_after_id( $from_id, $num_posts ) { |
| 365 | global $wpdb; |
| 366 | |
| 367 | return $wpdb->get_results( |
| 368 | $wpdb->prepare( |
| 369 | "SELECT * |
| 370 | FROM $wpdb->posts |
| 371 | WHERE post_type='attachment' |
| 372 | AND post_mime_type LIKE %s |
| 373 | AND ID>%d |
| 374 | ORDER BY ID ASC |
| 375 | LIMIT %d;", |
| 376 | 'video/%', |
| 377 | $from_id, |
| 378 | $num_posts |
| 379 | ) |
| 380 | ); // WPCS: db call ok; no-cache ok. |
| 381 | } |
| 382 | |
| 383 | /** |
| 384 | * Retrieve an array of published posts from the last 2 days. |
| 385 | * |
| 386 | * @access public |
| 387 | * @since 4.8.0 |
| 388 | * |
| 389 | * @param int $num_posts Largest number of posts to retrieve. |
| 390 | * |
| 391 | * @return array The posts. |
| 392 | */ |
| 393 | public function query_most_recent_posts( $num_posts ) { |
| 394 | global $wpdb; |
| 395 | |
| 396 | $two_days_ago = gmdate( 'Y-m-d', strtotime( '-2 days' ) ); |
| 397 | |
| 398 | /** |
| 399 | * Filter post types to be included in news sitemap. |
| 400 | * |
| 401 | * @module sitemaps |
| 402 | * |
| 403 | * @since 3.9.0 |
| 404 | * |
| 405 | * @param array $post_types Array with post types to include in news sitemap. |
| 406 | */ |
| 407 | $post_types = apply_filters( |
| 408 | 'jetpack_sitemap_news_sitemap_post_types', |
| 409 | array( 'page', 'post' ) |
| 410 | ); |
| 411 | |
| 412 | foreach ( (array) $post_types as $i => $post_type ) { |
| 413 | $post_types[ $i ] = $wpdb->prepare( '%s', $post_type ); |
| 414 | } |
| 415 | |
| 416 | $post_types_list = implode( ',', $post_types ); |
| 417 | |
| 418 | // phpcs:disable WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder,WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- WPCS: db call ok; no-cache ok. |
| 419 | return $wpdb->get_results( |
| 420 | $wpdb->prepare( |
| 421 | "SELECT * |
| 422 | FROM $wpdb->posts |
| 423 | WHERE post_status='publish' |
| 424 | AND post_date >= '%s' |
| 425 | AND post_type IN ($post_types_list) |
| 426 | ORDER BY post_date DESC |
| 427 | LIMIT %d;", |
| 428 | $two_days_ago, |
| 429 | $num_posts |
| 430 | ) |
| 431 | ); |
| 432 | // phpcs:enable WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder,WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 433 | } |
| 434 | } |
| 435 |