WordPress 3.9
[autoinstalls/wordpress.git] / wp-includes / revision.php
1 <?php
2 /**
3  * Post revision functions.
4  *
5  * @package WordPress
6  * @subpackage Post_Revisions
7  */
8
9 /**
10  * Determines which fields of posts are to be saved in revisions.
11  *
12  * Does two things. If passed a post *array*, it will return a post array ready
13  * to be inserted into the posts table as a post revision. Otherwise, returns
14  * an array whose keys are the post fields to be saved for post revisions.
15  *
16  * @since 2.6.0
17  * @access private
18  *
19  * @param array $post Optional a post array to be processed for insertion as a post revision.
20  * @param bool $autosave optional Is the revision an autosave?
21  * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
22  */
23 function _wp_post_revision_fields( $post = null, $autosave = false ) {
24         static $fields = false;
25
26         if ( !$fields ) {
27                 // Allow these to be versioned
28                 $fields = array(
29                         'post_title' => __( 'Title' ),
30                         'post_content' => __( 'Content' ),
31                         'post_excerpt' => __( 'Excerpt' ),
32                 );
33
34                 /**
35                  * Filter the list of fields saved in post revisions.
36                  *
37                  * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
38                  *
39                  * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
40                  * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
41                  * and 'post_author'.
42                  *
43                  * @since 2.6.0
44                  *
45                  * @param array $fields List of fields to revision. Contains 'post_title',
46                  *                      'post_content', and 'post_excerpt' by default.
47                  */
48                 $fields = apply_filters( '_wp_post_revision_fields', $fields );
49
50                 // WP uses these internally either in versioning or elsewhere - they cannot be versioned
51                 foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
52                         unset( $fields[$protect] );
53         }
54
55         if ( !is_array($post) )
56                 return $fields;
57
58         $return = array();
59         foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field )
60                 $return[$field] = $post[$field];
61
62         $return['post_parent']   = $post['ID'];
63         $return['post_status']   = 'inherit';
64         $return['post_type']     = 'revision';
65         $return['post_name']     = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version
66         $return['post_date']     = isset($post['post_modified']) ? $post['post_modified'] : '';
67         $return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : '';
68
69         return $return;
70 }
71
72 /**
73  * Saves an already existing post as a post revision.
74  *
75  * Typically used immediately after post updates.
76  * Adds a copy of the current post as a revision, so latest revision always matches current post
77  *
78  * @since 2.6.0
79  *
80  * @uses _wp_put_post_revision()
81  *
82  * @param int $post_id The ID of the post to save as a revision.
83  * @return mixed Null or 0 if error, new revision ID, if success.
84  */
85 function wp_save_post_revision( $post_id ) {
86         if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
87                 return;
88
89         if ( ! $post = get_post( $post_id ) )
90                 return;
91
92         if ( ! post_type_supports( $post->post_type, 'revisions' ) )
93                 return;
94
95         if ( 'auto-draft' == $post->post_status )
96                 return;
97
98         if ( ! wp_revisions_enabled( $post ) )
99                 return;
100
101         // Compare the proposed update with the last stored revision verifying that
102         // they are different, unless a plugin tells us to always save regardless.
103         // If no previous revisions, save one
104         if ( $revisions = wp_get_post_revisions( $post_id ) ) {
105                 // grab the last revision, but not an autosave
106                 foreach ( $revisions as $revision ) {
107                         if ( false !== strpos( $revision->post_name, "{$revision->post_parent}-revision" ) ) {
108                                 $last_revision = $revision;
109                                 break;
110                         }
111                 }
112
113                 /**
114                  * Filter whether the post has changed since the last revision.
115                  *
116                  * By default a revision is saved only if one of the revisioned fields has changed.
117                  * This filter can override that so a revision is saved even if nothing has changed.
118                  *
119                  * @since 3.6.0
120                  *
121                  * @param bool $check_for_changes Whether to check for changes before saving a new revision.
122                  *                                Default true.
123                  * @param int  $last_revision     ID of the last revision.
124                  * @param int  $post              Post ID.
125                  *
126                  */
127                 if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
128                         $post_has_changed = false;
129
130                         foreach ( array_keys( _wp_post_revision_fields() ) as $field ) {
131                                 if ( normalize_whitespace( $post->$field ) != normalize_whitespace( $last_revision->$field ) ) {
132                                         $post_has_changed = true;
133                                         break;
134                                 }
135                         }
136                         //don't save revision if post unchanged
137                         if( ! $post_has_changed )
138                                 return;
139                 }
140         }
141
142         $return = _wp_put_post_revision( $post );
143
144         $revisions_to_keep = wp_revisions_to_keep( $post );
145
146         if ( $revisions_to_keep < 0 )
147                 return $return;
148
149         // all revisions and autosaves
150         $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
151
152         $delete = count($revisions) - $revisions_to_keep;
153
154         if ( $delete < 1 )
155                 return $return;
156
157         $revisions = array_slice( $revisions, 0, $delete );
158
159         for ( $i = 0; isset( $revisions[$i] ); $i++ ) {
160                 if ( false !== strpos( $revisions[ $i ]->post_name, 'autosave' ) )
161                         continue;
162
163                 wp_delete_post_revision( $revisions[ $i ]->ID );
164         }
165
166         return $return;
167 }
168
169 /**
170  * Retrieve the autosaved data of the specified post.
171  *
172  * Returns a post object containing the information that was autosaved for the
173  * specified post. If the optional $user_id is passed, returns the autosave for that user
174  * otherwise returns the latest autosave.
175  *
176  * @since 2.6.0
177  *
178  * @uses wp_get_post_revisions()
179  *
180  * @param int $post_id The post ID.
181  * @param int $user_id optional The post author ID.
182  * @return object|bool The autosaved data or false on failure or when no autosave exists.
183  */
184 function wp_get_post_autosave( $post_id, $user_id = 0 ) {
185         $revisions = wp_get_post_revisions( $post_id, array( 'check_enabled' => false ) );
186
187         foreach ( $revisions as $revision ) {
188                 if ( false !== strpos( $revision->post_name, "{$post_id}-autosave" ) ) {
189                         if ( $user_id && $user_id != $revision->post_author )
190                                 continue;
191
192                         return $revision;
193                         break;
194                 }
195         }
196
197         return false;
198 }
199
200 /**
201  * Determines if the specified post is a revision.
202  *
203  * @since 2.6.0
204  *
205  * @param int|object $post Post ID or post object.
206  * @return bool|int False if not a revision, ID of revision's parent otherwise.
207  */
208 function wp_is_post_revision( $post ) {
209         if ( !$post = wp_get_post_revision( $post ) )
210                 return false;
211
212         return (int) $post->post_parent;
213 }
214
215 /**
216  * Determines if the specified post is an autosave.
217  *
218  * @since 2.6.0
219  *
220  * @param int|object $post Post ID or post object.
221  * @return bool|int False if not a revision, ID of autosave's parent otherwise
222  */
223 function wp_is_post_autosave( $post ) {
224         if ( !$post = wp_get_post_revision( $post ) )
225                 return false;
226
227         if ( false !== strpos( $post->post_name, "{$post->post_parent}-autosave" ) )
228                 return (int) $post->post_parent;
229
230         return false;
231 }
232
233 /**
234  * Inserts post data into the posts table as a post revision.
235  *
236  * @since 2.6.0
237  * @access private
238  *
239  * @uses wp_insert_post()
240  *
241  * @param int|object|array $post Post ID, post object OR post array.
242  * @param bool $autosave Optional. Is the revision an autosave?
243  * @return mixed WP_Error or 0 if error, new revision ID if success.
244  */
245 function _wp_put_post_revision( $post = null, $autosave = false ) {
246         if ( is_object($post) )
247                 $post = get_object_vars( $post );
248         elseif ( !is_array($post) )
249                 $post = get_post($post, ARRAY_A);
250
251         if ( ! $post || empty($post['ID']) )
252                 return new WP_Error( 'invalid_post', __( 'Invalid post ID' ) );
253
254         if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
255                 return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
256
257         $post_id = $post['ID'];
258         $post = _wp_post_revision_fields( $post, $autosave );
259         $post = wp_slash($post); //since data is from db
260
261         $revision_id = wp_insert_post( $post );
262         if ( is_wp_error($revision_id) )
263                 return $revision_id;
264
265         if ( $revision_id ) {
266                 /**
267                  * Fires once a revision has been saved.
268                  *
269                  * @since 2.6.0
270                  *
271                  * @param int $revision_id Post revision ID.
272                  */
273                 do_action( '_wp_put_post_revision', $revision_id );
274         }
275
276         return $revision_id;
277 }
278
279 /**
280  * Gets a post revision.
281  *
282  * @since 2.6.0
283  *
284  * @uses get_post()
285  *
286  * @param int|object $post The post ID or object.
287  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
288  * @param string $filter Optional sanitation filter. @see sanitize_post().
289  * @return mixed Null if error or post object if success.
290  */
291 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
292         if ( !$revision = get_post( $post, OBJECT, $filter ) )
293                 return $revision;
294         if ( 'revision' !== $revision->post_type )
295                 return null;
296
297         if ( $output == OBJECT ) {
298                 return $revision;
299         } elseif ( $output == ARRAY_A ) {
300                 $_revision = get_object_vars($revision);
301                 return $_revision;
302         } elseif ( $output == ARRAY_N ) {
303                 $_revision = array_values(get_object_vars($revision));
304                 return $_revision;
305         }
306
307         return $revision;
308 }
309
310 /**
311  * Restores a post to the specified revision.
312  *
313  * Can restore a past revision using all fields of the post revision, or only selected fields.
314  *
315  * @since 2.6.0
316  *
317  * @uses wp_get_post_revision()
318  * @uses wp_update_post()
319  *
320  * @param int|object $revision_id Revision ID or revision object.
321  * @param array $fields Optional. What fields to restore from. Defaults to all.
322  * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
323  */
324 function wp_restore_post_revision( $revision_id, $fields = null ) {
325         if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) )
326                 return $revision;
327
328         if ( !is_array( $fields ) )
329                 $fields = array_keys( _wp_post_revision_fields() );
330
331         $update = array();
332         foreach( array_intersect( array_keys( $revision ), $fields ) as $field ) {
333                 $update[$field] = $revision[$field];
334         }
335
336         if ( !$update )
337                 return false;
338
339         $update['ID'] = $revision['post_parent'];
340
341         $update = wp_slash( $update ); //since data is from db
342
343         $post_id = wp_update_post( $update );
344         if ( ! $post_id || is_wp_error( $post_id ) )
345                 return $post_id;
346
347         // Add restore from details
348         $restore_details = array(
349                 'restored_revision_id' => $revision_id,
350                 'restored_by_user'     => get_current_user_id(),
351                 'restored_time'        => time()
352         );
353         update_post_meta( $post_id, '_post_restored_from', $restore_details );
354
355         // Update last edit user
356         update_post_meta( $post_id, '_edit_last', get_current_user_id() );
357
358         /**
359          * Fires after a post revision has been restored.
360          *
361          * @since 2.6.0
362          *
363          * @param int $post_id     Post ID.
364          * @param int $revision_id Post revision ID.
365          */
366         do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
367
368         return $post_id;
369 }
370
371 /**
372  * Deletes a revision.
373  *
374  * Deletes the row from the posts table corresponding to the specified revision.
375  *
376  * @since 2.6.0
377  *
378  * @uses wp_get_post_revision()
379  * @uses wp_delete_post()
380  *
381  * @param int|object $revision_id Revision ID or revision object.
382  * @return mixed Null or WP_Error if error, deleted post if success.
383  */
384 function wp_delete_post_revision( $revision_id ) {
385         if ( !$revision = wp_get_post_revision( $revision_id ) )
386                 return $revision;
387
388         $delete = wp_delete_post( $revision->ID );
389         if ( is_wp_error( $delete ) )
390                 return $delete;
391
392         if ( $delete ) {
393                 /**
394                  * Fires once a post revision has been deleted.
395                  *
396                  * @since 2.6.0
397                  *
398                  * @param int          $revision_id Post revision ID.
399                  * @param object|array $revision    Post revision object or array.
400                  */
401                 do_action( 'wp_delete_post_revision', $revision->ID, $revision );
402         }
403
404         return $delete;
405 }
406
407 /**
408  * Returns all revisions of specified post.
409  *
410  * @since 2.6.0
411  *
412  * @uses get_children()
413  *
414  * @param int|object $post_id Post ID or post object
415  * @return array An array of revisions, or an empty array if none.
416  */
417 function wp_get_post_revisions( $post_id = 0, $args = null ) {
418         $post = get_post( $post_id );
419         if ( ! $post || empty( $post->ID ) )
420                 return array();
421
422         $defaults = array( 'order' => 'DESC', 'orderby' => 'date', 'check_enabled' => true );
423         $args = wp_parse_args( $args, $defaults );
424
425         if ( $args['check_enabled'] && ! wp_revisions_enabled( $post ) )
426                 return array();
427
428         $args = array_merge( $args, array( 'post_parent' => $post->ID, 'post_type' => 'revision', 'post_status' => 'inherit' ) );
429
430         if ( ! $revisions = get_children( $args ) )
431                 return array();
432
433         return $revisions;
434 }
435
436 /**
437  * Determine if revisions are enabled for a given post.
438  *
439  * @since 3.6.0
440  *
441  * @uses wp_revisions_to_keep()
442  *
443  * @param object $post The post object.
444  * @return bool True if number of revisions to keep isn't zero, false otherwise.
445  */
446 function wp_revisions_enabled( $post ) {
447         return wp_revisions_to_keep( $post ) != 0;
448 }
449
450 /**
451  * Determine how many revisions to retain for a given post.
452  * By default, an infinite number of revisions are stored if a post type supports revisions.
453  *
454  * @since 3.6.0
455  *
456  * @uses post_type_supports()
457  *
458  * @param object $post The post object.
459  * @return int The number of revisions to keep.
460  */
461 function wp_revisions_to_keep( $post ) {
462         $num = WP_POST_REVISIONS;
463
464         if ( true === $num )
465                 $num = -1;
466         else
467                 $num = intval( $num );
468
469         if ( ! post_type_supports( $post->post_type, 'revisions' ) )
470                 $num = 0;
471
472         /**
473          * Filter the number of revisions to save for the given post.
474          *
475          * Overrides the value of WP_POST_REVISIONS.
476          *
477          * @since 3.6.0
478          *
479          * @param int     $num  Number of revisions to store.
480          * @param WP_Post $post Post object.
481          */
482         return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
483 }
484
485 /**
486  * Sets up the post object for preview based on the post autosave.
487  *
488  * @since 2.7.0
489  * @access private
490  */
491 function _set_preview($post) {
492
493         if ( ! is_object($post) )
494                 return $post;
495
496         $preview = wp_get_post_autosave($post->ID);
497
498         if ( ! is_object($preview) )
499                 return $post;
500
501         $preview = sanitize_post($preview);
502
503         $post->post_content = $preview->post_content;
504         $post->post_title = $preview->post_title;
505         $post->post_excerpt = $preview->post_excerpt;
506
507         add_filter( 'get_the_terms', '_wp_preview_terms_filter', 10, 3 );
508
509         return $post;
510 }
511
512 /**
513  * Filters the latest content for preview from the post autosave.
514  *
515  * @since 2.7.0
516  * @access private
517  */
518 function _show_post_preview() {
519
520         if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
521                 $id = (int) $_GET['preview_id'];
522
523                 if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
524                         wp_die( __('You do not have permission to preview drafts.') );
525
526                 add_filter('the_preview', '_set_preview');
527         }
528 }
529
530 /**
531  * Filters terms lookup to set the post format.
532  *
533  * @since 3.6.0
534  * @access private
535  */
536 function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
537         if ( ! $post = get_post() )
538                 return $terms;
539
540         if ( empty( $_REQUEST['post_format'] ) || $post->ID != $post_id || 'post_format' != $taxonomy || 'revision' == $post->post_type )
541                 return $terms;
542
543         if ( 'standard' == $_REQUEST['post_format'] )
544                 $terms = array();
545         elseif ( $term = get_term_by( 'slug', 'post-format-' . sanitize_key( $_REQUEST['post_format'] ), 'post_format' ) )
546                 $terms = array( $term ); // Can only have one post format
547
548         return $terms;
549 }
550
551 /**
552  * Gets the post revision version.
553  *
554  * @since 3.6.0
555  * @access private
556 */
557 function _wp_get_post_revision_version( $revision ) {
558         if ( is_object( $revision ) )
559                 $revision = get_object_vars( $revision );
560         elseif ( !is_array( $revision ) )
561                 return false;
562
563         if ( preg_match( '/^\d+-(?:autosave|revision)-v(\d+)$/', $revision['post_name'], $matches ) )
564                 return (int) $matches[1];
565
566         return 0;
567 }
568
569 /**
570  * Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
571  *
572  * @since 3.6.0
573  * @access private
574  *
575  * @uses wp_get_post_revisions()
576  *
577  * @param object $post Post object
578  * @param array $revisions Current revisions of the post
579  * @return bool true if the revisions were upgraded, false if problems
580  */
581 function _wp_upgrade_revisions_of_post( $post, $revisions ) {
582         global $wpdb;
583
584         // Add post option exclusively
585         $lock = "revision-upgrade-{$post->ID}";
586         $now = time();
587         $result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, 'no') /* LOCK */", $lock, $now ) );
588         if ( ! $result ) {
589                 // If we couldn't get a lock, see how old the previous lock is
590                 $locked = get_option( $lock );
591                 if ( ! $locked ) {
592                         // Can't write to the lock, and can't read the lock.
593                         // Something broken has happened
594                         return false;
595                 }
596
597                 if ( $locked > $now - 3600 ) {
598                         // Lock is not too old: some other process may be upgrading this post.  Bail.
599                         return false;
600                 }
601
602                 // Lock is too old - update it (below) and continue
603         }
604
605         // If we could get a lock, re-"add" the option to fire all the correct filters.
606         update_option( $lock, $now );
607
608         reset( $revisions );
609         $add_last = true;
610
611         do {
612                 $this_revision = current( $revisions );
613                 $prev_revision = next( $revisions );
614
615                 $this_revision_version = _wp_get_post_revision_version( $this_revision );
616
617                 // Something terrible happened
618                 if ( false === $this_revision_version )
619                         continue;
620
621                 // 1 is the latest revision version, so we're already up to date.
622                 // No need to add a copy of the post as latest revision.
623                 if ( 0 < $this_revision_version ) {
624                         $add_last = false;
625                         continue;
626                 }
627
628                 // Always update the revision version
629                 $update = array(
630                         'post_name' => preg_replace( '/^(\d+-(?:autosave|revision))[\d-]*$/', '$1-v1', $this_revision->post_name ),
631                 );
632
633                 // If this revision is the oldest revision of the post, i.e. no $prev_revision,
634                 // the correct post_author is probably $post->post_author, but that's only a good guess.
635                 // Update the revision version only and Leave the author as-is.
636                 if ( $prev_revision ) {
637                         $prev_revision_version = _wp_get_post_revision_version( $prev_revision );
638
639                         // If the previous revision is already up to date, it no longer has the information we need :(
640                         if ( $prev_revision_version < 1 )
641                                 $update['post_author'] = $prev_revision->post_author;
642                 }
643
644                 // Upgrade this revision
645                 $result = $wpdb->update( $wpdb->posts, $update, array( 'ID' => $this_revision->ID ) );
646
647                 if ( $result )
648                         wp_cache_delete( $this_revision->ID, 'posts' );
649
650         } while ( $prev_revision );
651
652         delete_option( $lock );
653
654         // Add a copy of the post as latest revision.
655         if ( $add_last )
656                 wp_save_post_revision( $post->ID );
657
658         return true;
659 }