Deprecate is_public instead of immediately replacing it

is_public is replaced by a different approach in querying data and
by is_publicly_viewable. If we would immediately replace is_public
with is_publicly_viewable, that would be a BC break.

lib/model.php

@@ -95,7 +95,7 @@ class Model implements JsonSerializable {
  protected $float_columns = [];
 
  /**
- * Which columns are deprecated and optionally: what are their replacements.
+ * Which columns are deprecated.
  *
  * @var array
  */
@@ -599,6 +599,7 @@ public function __isset( $property ) {
  */
  public function get( $property ) {
  $property = $this->handleDeprecation( $property );
+
  return $this->orm->get( $property );
  }
 
@@ -743,13 +744,17 @@ protected function handleDeprecation( $property ) {
  if ( ! array_key_exists( $property, $this->deprecated_columns ) ) {
  return $property;
  }
- $replacement = $this->deprecated_columns[ $property ];
+ $deprecation = $this->deprecated_columns[ $property ];
 
- if ( ! empty( $replacement ) ) {
+ if ( ! empty( $deprecation['replacement'] ) ) {
  // There is no _deprecated_property. This matches our usecase best.
- _deprecated_argument( __FUNCTION__, '17.7', 'Use the \"' . $replacement . '\" property instead of \"' . $property . '\" ' );
+ _deprecated_argument( __FUNCTION__, '17.7', 'Use the \"' . $deprecation['replacement'] . '\" property instead of \"' . $property . '\" ' );
+
+ if ( $deprecation['automatically_use_replacement'] === true ) {
+ return $deprecation['replacement'];
+ }
 
- return $replacement;
+ return $property;
  }
  // There is no _deprecated_property. This matches our usecase best.
  _deprecated_argument( __FUNCTION__, '17.7', 'The \"' . $property . '\" property will be removed in a future version' );

src/builders/indexable-author-builder.php

@@ -87,6 +87,7 @@ public function build( $user_id, Indexable $indexable ) {
  $indexable->is_robots_noarchive = null;
  $indexable->is_robots_noimageindex = null;
  $indexable->is_robots_nosnippet = null;
+ $indexable->is_public = ( $indexable->is_robots_noindex ) ? false : null;
  $indexable->blog_id = \get_current_blog_id();
 
  $this->reset_social_images( $indexable );

src/builders/indexable-date-archive-builder.php

@@ -51,13 +51,15 @@ public function __construct(
  * @return Indexable The extended indexable.
  */
  public function build( $indexable ) {
- $indexable->object_type = 'date-archive';
- $indexable->title = $this->options->get( 'title-archive-wpseo' );
- $indexable->description = $this->options->get( 'metadesc-archive-wpseo' );
- $indexable->is_robots_noindex = $this->options->get( 'noindex-archive-wpseo' );
- $indexable->blog_id = \get_current_blog_id();
- $indexable->permalink = null;
- $indexable->version = $this->version;
+ $indexable->object_type = 'date-archive';
+ $indexable->title = $this->options->get( 'title-archive-wpseo' );
+ $indexable->description = $this->options->get( 'metadesc-archive-wpseo' );
+ $indexable->is_robots_noindex = $this->options->get( 'noindex-archive-wpseo' );
+ $indexable->is_public = ( (int) $indexable->is_robots_noindex !== 1 );
+ $indexable->is_publicly_viewable = (bool) $this->options->get( 'disable-date' );
+ $indexable->blog_id = \get_current_blog_id();
+ $indexable->permalink = null;
+ $indexable->version = $this->version;
 
  return $indexable;
  }

src/builders/indexable-post-builder.php

@@ -142,20 +142,20 @@ public function build( $post_id, $indexable ) {
  $indexable->author_id = $post->post_author;
  $indexable->post_parent = $post->post_parent;
 
- $indexable->number_of_pages = $this->get_number_of_pages_for_post( $post );
- $indexable->post_status = $post->post_status;
- $indexable->is_protected = $post->post_password !== '';
-
- $indexable->blog_id = \get_current_blog_id();
+ $indexable->number_of_pages = $this->get_number_of_pages_for_post( $post );
+ $indexable->post_status = $post->post_status;
+ $indexable->is_protected = $post->post_password !== '';
+ $indexable->is_public = $this->is_public( $indexable );
+ $indexable->is_publicly_viewable = \is_post_publicly_viewable( $post );
+ $indexable->number_of_publicly_viewable_posts = 0;
+ $indexable->blog_id = \get_current_blog_id();
 
  $indexable->schema_page_type = $this->get_meta_value( $post_id, 'schema_page_type' );
  $indexable->schema_article_type = $this->get_meta_value( $post_id, 'schema_article_type' );
 
  $indexable->object_last_modified = $post->post_modified_gmt;
  $indexable->object_published_at = $post->post_date_gmt;
 
- $indexable->number_of_publicly_viewable_posts = 0;
- $indexable->is_publicly_viewable = \is_post_publicly_viewable( $post );
 
  $indexable->version = $this->version;
 
@@ -178,6 +178,59 @@ protected function get_permalink( $post_type, $post_id ) {
  return \wp_get_attachment_url( $post_id );
  }
 
+ /**
+ * Determines the value of is_public.
+ *
+ * @param Indexable $indexable The indexable.
+ *
+ * @return bool|null Whether the post type is public. Null if no override is set.
+ *
+ * @deprecated 17.7
+ */
+ protected function is_public( $indexable ) {
+ if ( $indexable->is_protected === true ) {
+ return false;
+ }
+
+ if ( $indexable->is_robots_noindex === true ) {
+ return false;
+ }
+
+ // Attachments behave differently than the other post types, since they inherit from their parent.
+ if ( $indexable->object_sub_type === 'attachment' ) {
+ return $this->is_public_attachment( $indexable );
+ }
+
+ if ( ! \in_array( $indexable->post_status, $this->post_helper->get_public_post_statuses(), true ) ) {
+ return false;
+ }
+
+ if ( $indexable->is_robots_noindex === false ) {
+ return true;
+ }
+
+ return null;
+ }
+
+ /**
+ * Determines the value of is_public for attachments.
+ *
+ * @param Indexable $indexable The indexable.
+ *
+ * @return bool|null False when it has no parent. Null when it has a parent.
+ *
+ * @deprecated 17.7
+ */
+ protected function is_public_attachment( $indexable ) {
+ // If the attachment has no parent, it should not be public.
+ if ( empty( $indexable->post_parent ) ) {
+ return false;
+ }
+
+ // If the attachment has a parent, the is_public should be NULL.
+ return null;
+ }
+
  /**
  * Converts the meta robots noindex value to the indexable value.
  *

src/builders/indexable-post-type-archive-builder.php

@@ -81,6 +81,7 @@ public function build( $post_type, Indexable $indexable ) {
  $indexable->breadcrumb_title = $this->get_breadcrumb_title( $post_type );
  $indexable->permalink = \get_post_type_archive_link( $post_type );
  $indexable->is_robots_noindex = (bool) $this->options->get( 'noindex-ptarchive-' . $post_type );
+ $indexable->is_public = ( (int) $indexable->is_robots_noindex !== 1 );
  $indexable->blog_id = \get_current_blog_id();
 
  $post_type_object = get_post_type_object( $post_type );

src/builders/indexable-term-builder.php

@@ -110,6 +110,7 @@ public function build( $term_id, $indexable ) {
  );
 
  $indexable->is_robots_noindex = $this->get_noindex_value( $this->get_meta_value( 'wpseo_noindex', $term_meta ) );
+ $indexable->is_public = ( $indexable->is_robots_noindex === null ) ? null : ! $indexable->is_robots_noindex;
 
  $this->reset_social_images( $indexable );
 

src/config/migrations/20211108133106_ReplaceIsPublicOnIndexables.php

@@ -30,13 +30,14 @@ class ReplaceIsPublicOnIndexables extends Migration {
  */
  public function up() {
  $table_name = $this->get_table_name();
-
- $this->rename_column(
+ $this->add_column(
  $table_name,
- 'is_public',
- 'is_publicly_viewable'
- );
-
+ 'is_publicly_viewable',
+ 'boolean',
+ [
+ 'null' => true,
+ 'default' => null,
+ ] );
  }
 
  /**
@@ -48,10 +49,9 @@ public function up() {
  public function down() {
  $table_name = $this->get_table_name();
 
- $this->rename_column(
+ $this->remove_column(
  $table_name,
- 'calculated_no_index',
- 'is_public'
+ 'is_publicly_viewable',
  );
  }
 

src/integrations/watchers/indexable-post-watcher.php

@@ -119,7 +119,7 @@ public function __construct(
  */
  public function register_hooks() {
  \add_action( 'wp_insert_post', [ $this, 'build_indexable' ], \PHP_INT_MAX );
- \add_action( 'delete_post', [ $this, 'delete_indexable' ] );
+ \add_action( 'delete_post', [ $this, 'delete_indexable' ], 10, 2 );
  \add_action( 'wpseo_save_indexable', [ $this, 'updated_indexable' ], \PHP_INT_MAX, 2 );
 
  \add_action( 'edit_attachment', [ $this, 'build_indexable' ], \PHP_INT_MAX );
@@ -130,11 +130,12 @@ public function register_hooks() {
  /**
  * Deletes the meta when a post is deleted.
  *
- * @param int $post_id Post ID.
+ * @param int $post_id Post ID.
+ * @param \WP_Post $post The to be deleted post.
  *
  * @return void
  */
- public function delete_indexable( $post_id ) {
+ public function delete_indexable( $post_id, $post ) {
  $indexable = $this->repository->find_by_id_and_type( $post_id, 'post', false );
 
  // Only interested in post indexables.
@@ -145,7 +146,7 @@ public function delete_indexable( $post_id ) {
  $this->hierarchy_repository->clear_ancestors( $indexable->id );
  $this->link_builder->delete( $indexable );
  $indexable->delete();
- $this->update_relations( $this->post->get_post( $post_id ) );
+ $this->update_relations( $post );
  }
 
  /**
@@ -203,7 +204,7 @@ public function build_indexable( $post_id ) {
  */
  protected function update_relations( $post ) {
  $related_indexables = $this->get_related_indexables( $post );
- $now = current_time( 'mysql' );
+ $now  = current_time( 'mysql' );
  foreach ( $related_indexables as $related_indexable ) {
  $related_indexable->object_last_modified = $now;
  $this->builder->recalculate_aggregates( $related_indexable );

src/models/indexable.php

@@ -110,9 +110,9 @@ class Indexable extends Model {
  'is_robots_noimageindex',
  'is_robots_nosnippet',
  'is_cornerstone',
+ 'is_public',
  'is_publicly_viewable',
  'is_protected',
- 'calculated_no_index',
  ];
 
  /**
@@ -138,8 +138,16 @@ class Indexable extends Model {
  ];
 
  protected $deprecated_columns = [
- 'has_public_posts' => 'number_of_publicly_viewable_posts',
- 'is_public' => 'is_publicly_viewable',
+ 'has_public_posts' => [
+ 'since' => '17.7',
+ 'replacement' => 'number_of_publicly_viewable_posts',
+ 'automatically_use_replacement' => true,
+ ],
+ 'is_public' => [
+ 'since' => '17.7',
+ 'replacement' => 'is_publicly_viewable',
+ 'automatically_use_replacement' => false,
+ ],
  ];
 
  /**