PullListTable.php

<?php
/**
 * Admin list table for pulled posted
 *
 * @package  distributor
 */

namespace Distributor;

/**
 * List table class for pull screen
 */
class PullListTable extends \WP_List_Table {

	/**
	 * Stores all our connections
	 *
	 * @var array
	 */
	public $connection_objects = [];

	/**
	 * Store record of synced posts
	 *
	 * @var array
	 */
	public $sync_log = [];

	/**
	 * Save error to determine if we can show the pull table
	 *
	 * @var bool
	 */
	public $pull_error;

	/**
	 * Initialize pull table
	 *
	 * @since  0.8
	 */
	public function __construct() {
		parent::__construct(
			array(
				'ajax' => false,
			)
		);
	}

	/**
	 * Get pull tables columns
	 *
	 * @since  0.8
	 * @return array
	 */
	public function get_columns() {
		$columns = [
			'cb'        => '<input type="checkbox" />',
			'name'      => esc_html__( 'Name', 'distributor' ),
			'post_type' => esc_html__( 'Post Type', 'distributor' ),
			'date'      => esc_html__( 'Date', 'distributor' ),
		];

		/**
		 * Filters the columns displayed in the pull list table.
		 *
		 * @hook dt_pull_list_table_columns
		 *
		 * @param {array} $columns An associative array of column headings.
		 *
		 * @return {array} An associative array of column headings.
		 */
		return apply_filters( 'dt_pull_list_table_columns', $columns );
	}

	/**
	 * Get table views
	 *
	 * @since  0.8
	 * @return array
	 */
	protected function get_views() {

		$current_status = ( empty( $_GET['status'] ) ) ? 'new' : sanitize_key( $_GET['status'] ); // @codingStandardsIgnoreLine No nonce needed.

		//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- see `wp_fix_server_vars()`.
		$request_uri = esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) );

		$url         = add_query_arg(
			array(
				'paged' => false,
				's'     => false,
			),
			$request_uri
		);
		$new_url     = add_query_arg(
			array(
				'status' => 'new',
			),
			$url
		);
		$pulled_url  = add_query_arg(
			array(
				'status' => 'pulled',
			),
			$url
		);
		$skipped_url = add_query_arg(
			array(
				'status' => 'skipped',
			),
			$url
		);

		$status_links = [
			'new'     => '<a href="' . esc_url( $new_url ) . '" class="' . ( ( 'new' === $current_status ) ? 'current' : '' ) . '">' . esc_html__( 'New', 'distributor' ) . '</a>',
			'pulled'  => '<a href="' . esc_url( $pulled_url ) . '" class="' . ( ( 'pulled' === $current_status ) ? 'current' : '' ) . '">' . esc_html__( 'Pulled', 'distributor' ) . '</a>',
			'skipped' => '<a href="' . esc_url( $skipped_url ) . '" class="' . ( ( 'skipped' === $current_status ) ? 'current' : '' ) . '">' . esc_html__( 'Skipped', 'distributor' ) . '</a>',
		];

		return $status_links;
	}

	/**
	 * Display the bulk actions dropdown.
	 *
	 * @since 3.1.0
	 * @access protected
	 *
	 * @param string $which The location of the bulk actions: 'top' or 'bottom'.
	 *                      This is designated as optional for backward compatibility.
	 */
	protected function bulk_actions( $which = '' ) {
		if ( is_null( $this->_actions ) ) {
			$no_new_actions = $this->get_bulk_actions();
			$this->_actions = $this->get_bulk_actions();
			// Filter documented in WordPress core.
			$this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions ); // @codingStandardsIgnoreLine valid filter name
			$this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions );
			$two            = '';
		} else {
			$two = '2';
		}

		if ( empty( $this->_actions ) ) {
			return;
		}

		echo '<label for="bulk-action-selector-' . esc_attr( $which ) . '" class="screen-reader-text">' . esc_html__( 'Select bulk action', 'distributor' ) . '</label>';
		echo '<select name="' . esc_attr( 'action' . $two ) . '" id="bulk-action-selector-' . esc_attr( $which ) . "\">\n";

		foreach ( $this->_actions as $name => $title ) {
			echo "\t" . '<option value="' . esc_attr( $name ) . '"' . ( 'edit' === $name ? ' class="hide-if-no-js"' : '' ) . '>' . esc_html( $title ) . "</option>\n";
		}

		echo "</select>\n";

		submit_button( esc_html__( 'Apply', 'distributor' ), 'action', '', false, array( 'id' => "doaction$two" ) );
		echo "\n";
	}

	/**
	 * Handles the post date column output.
	 *
	 * @since 4.3.0
	 * @access public
	 *
	 * @global string $mode
	 *
	 * @param \WP_Post $post The current WP_Post object.
	 */
	public function column_date( $post ) {
		global $mode;

		if ( ! empty( $this->sync_log ) && ( empty( $_GET['status'] ) || 'new' === $_GET['status'] ) ) { // @codingStandardsIgnoreLine Nonce not needed.
			if ( isset( $this->sync_log[ $post->ID ] ) ) {
				if ( false === $this->sync_log[ $post->ID ] ) {
					echo '<span class="disabled">' . esc_html__( 'Skipped', 'distributor' ) . '</span>';
					return;
				} else {
					echo '<span class="disabled">' . esc_html__( 'Pulled', 'distributor' ) . '</span>';
					return;
				}
			}
		}

		if ( ! empty( $_GET['status'] ) && 'pulled' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce isn't required.
			if ( ! empty( $this->sync_log[ $post->ID ] ) ) {
				$syndicated_at = get_post_meta( $this->sync_log[ $post->ID ], 'dt_syndicate_time', true );

				if ( empty( $syndicated_at ) ) {
					esc_html_e( 'Post deleted.', 'distributor' );
				} else {
					$t_time = get_the_time( esc_html__( 'Y/m/d g:i:s a', 'distributor' ) );

					$time_diff = time() - $syndicated_at;

					if ( $time_diff > 0 && $time_diff < DAY_IN_SECONDS ) {
						/* translators: %s: a human readable time */
						$h_time = sprintf( esc_html__( '%s ago', 'distributor' ), human_time_diff( $syndicated_at ) );
					} else {
						$h_time = gmdate( 'F j, Y', $syndicated_at );
					}

					/* translators: %s: time of pull */
					echo sprintf( esc_html__( 'Pulled %s', 'distributor' ), esc_html( $h_time ) );
				}
			}
		} else {
			if ( '0000-00-00 00:00:00' === $post->post_date ) {
				$t_time    = esc_html__( 'Unpublished', 'distributor' );
				$h_time    = esc_html__( 'Unpublished', 'distributor' );
				$time_diff = 0;
			} else {
				$t_time = get_the_time( esc_html__( 'Y/m/d g:i:s a', 'distributor' ) );
				$m_time = $post->post_date;
				$time   = get_post_time( 'G', true, $post );

				$time_diff = time() - $time;

				if ( $time_diff > 0 && $time_diff < DAY_IN_SECONDS ) {
					/* translators: %s: a human readable time */
					$h_time = sprintf( esc_html__( '%s ago', 'distributor' ), human_time_diff( $time ) );
				} else {
					$h_time = mysql2date( esc_html__( 'Y/m/d', 'distributor' ), $m_time );
				}
			}

			if ( 'publish' === $post->post_status ) {
				esc_html_e( 'Published', 'distributor' );
			} elseif ( 'future' === $post->post_status ) {
				if ( $time_diff > 0 ) {
					echo '<strong class="error-message">' . esc_html__( 'Missed schedule', 'distributor' ) . '</strong>';
				} else {
					esc_html_e( 'Scheduled', 'distributor' );
				}
			} else {
				esc_html_e( 'Last Modified', 'distributor' );
			}
			echo '<br />';
			if ( 'excerpt' === $mode ) {
				// Core filter, documented in wp-admin/includes/class-wp-posts-list-table.php.
				echo esc_html( apply_filters( 'post_date_column_time', $t_time, $post, 'date', $mode ) );
			} else {
				// Core filter, documented in wp-admin/includes/class-wp-posts-list-table.php.
				echo '<abbr title="' . esc_attr( $t_time ) . '">' . esc_html( apply_filters( 'post_date_column_time', $h_time, $post, 'date', $mode ) ) . '</abbr>';
			}
		}
	}

	/**
	 * Output standard table columns.
	 *
	 * @param  array|\WP_Post $item Item to output.
	 * @param  string         $column_name Column name.
	 *
	 * @return string.
	 * @since  0.8
	 */
	public function column_default( $item, $column_name ) {
		if ( 'post_type' === $column_name ) {
			$post_type = get_post_type_object( $item->post_type );

			if ( $post_type && isset( $post_type->labels->singular_name ) ) {
				return $post_type->labels->singular_name;
			}
		}

		/**
		 * Fires for each column in the pull list table.
		 *
		 * @hook dt_pull_list_table_custom_column
		 *
		 * @param {string}  $column_name The name of the column to display.
		 * @param {WP_Post} $item        The post/item to output in the column.
		 */
		do_action( 'dt_pull_list_table_custom_column', $column_name, $item );

		return '';
	}

	/**
	 * Output name column wrapper
	 *
	 * @since 4.3.0
	 * @param \WP_Post $item Post object.
	 * @param string   $classes CSS classes.
	 * @param string   $data Column data.
	 * @param string   $primary Whether primary or not.
	 */
	protected function _column_name( $item, $classes, $data, $primary ) { // @codingStandardsIgnoreLine valid function name
		echo '<td class="' . esc_attr( $classes ) . ' page-title">';
		$this->column_name( $item );
		echo wp_kses_post( $this->handle_row_actions( $item, 'title', $primary ) );
		echo '</td>';
	}

	/**
	 * Output inner name column with actions
	 *
	 * @param  \WP_Post $item Post object.
	 * @since  0.8
	 */
	public function column_name( $item ) {

		global $connection_now;

		if ( is_a( $connection_now, '\Distributor\ExternalConnection' ) ) {
			$connection_type = 'external';
			$connection_id   = $connection_now->id;
		} else {
			$connection_type = 'internal';
			$connection_id   = $connection_now->site->blog_id;
		}

		$actions = [];
		$disable = false;

		if ( empty( $_GET['status'] ) || 'new' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not needed.
			if ( isset( $this->sync_log[ $item->ID ] ) ) {
				$actions = [];
				$disable = true;
			} else {
				/**
				 * Filter the default value of the 'Pull as draft' option in the pull ui
				 *
				 * @hook dt_pull_as_draft
				 *
				 * @param {bool}   $as_draft   Whether the 'Pull as draft' option should be checked.
				 * @param {object} $connection The connection being used to pull from.
				 *
				 * @return {bool} Whether the 'Pull as draft' option should be checked.
				 */
				$as_draft = apply_filters( 'dt_pull_as_draft', true, $connection_now );

				$draft = 'draft';
				if ( ! $as_draft ) {
					$draft = '';
				}

				$actions = [
					//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- see `wp_fix_server_vars()`.
					'pull' => sprintf( '<a href="#">%s</a>', $draft ? esc_html__( 'Pull as draft', 'distributor' ) : esc_html__( 'Pull', 'distributor' ) ),
					'view' => '<a href="' . esc_url( $item->link ) . '">' . esc_html__( 'View', 'distributor' ) . '</a>',
					//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- see `wp_fix_server_vars()`.
					'skip' => sprintf( '<a href="%s">%s</a>', esc_url( wp_nonce_url( admin_url( 'admin.php?page=pull&action=skip&_wp_http_referer=' . rawurlencode( esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) . '&post=' . $item->ID . '&connection_type=' . $connection_type . '&connection_id=' . $connection_id ), 'dt_skip' ) ), esc_html__( 'Skip', 'distributor' ) ),
				];
			}
		} elseif ( 'skipped' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not needed.
			// Filter documented above.
			$as_draft = apply_filters( 'dt_pull_as_draft', true, $connection_now );
			$draft    = 'draft';
			if ( ! $as_draft ) {
				$draft = '';
			}

			$actions = [
				//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- see `wp_fix_server_vars()`.
				'pull'   => sprintf( '<a href="#">%s</a>', $draft ? esc_html__( 'Pull as draft', 'distributor' ) : esc_html__( 'Pull', 'distributor' ) ),
				//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- see `wp_fix_server_vars()`.
				'unskip' => sprintf( '<a href="%s">%s</a>', esc_url( wp_nonce_url( admin_url( 'admin.php?page=pull&action=unskip&_wp_http_referer=' . rawurlencode( esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) . '&post=' . $item->ID . '&connection_type=' . $connection_type . '&connection_id=' . $connection_id ), 'dt_unskip' ) ), esc_html__( 'Unskip', 'distributor' ) ),
				'view'   => '<a href="' . esc_url( $item->link ) . '">' . esc_html__( 'View', 'distributor' ) . '</a>',
			];
		} elseif ( 'pulled' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not needed

			$new_post_id = ( ! empty( $this->sync_log[ (int) $item->ID ] ) ) ? $this->sync_log[ (int) $item->ID ] : 0;
			$new_post    = get_post( $new_post_id );

			if ( ! empty( $new_post ) ) {
				$actions = [
					'view' => '<a href="' . esc_url( get_permalink( $new_post_id ) ) . '">' . esc_html__( 'View', 'distributor' ) . '</a>',
				];

				if ( current_user_can( 'edit_post', $new_post_id ) ) {
					$actions['edit'] = '<a href="' . esc_url( get_edit_post_link( $new_post_id ) ) . '">' . esc_html__( 'Edit', 'distributor' ) . '</a>';
				}
			}
		}

		$title = $item->post_title;

		if ( empty( $title ) ) {
			$title = esc_html__( '(no title)', 'distributor' );
		}

		if ( $disable ) {
			echo '<div class="disabled">';
		}

		echo '<strong>' . esc_html( $title ) . '</strong>';
		echo wp_kses_post( $this->row_actions( $actions ) );

		if ( $disable ) {
			echo '</div>';
		}
	}

	/**
	 * Generates content for a single row of the table.
	 *
	 * @param \WP_Post $item The current post object.
	 */
	public function single_row( $item ) {
		/**
		 * Filters the class used on the table row on the pull list table.
		 *
		 * @hook dt_pull_list_table_tr_class
		 *
		 * @param {string}  $class The class name.
		 * @param {WP_Post} $item  The current post object.
		 *
		 * @return {string} The class name.
		 */
		$class = sanitize_html_class( apply_filters( 'dt_pull_list_table_tr_class', 'dt-table-row', $item ) );

		echo sprintf( '<tr class="%s">', esc_attr( $class ) );
		$this->single_row_columns( $item );
		echo '</tr>';
	}

	/**
	 * Remotely get items for display in table
	 *
	 * @since  0.8
	 */
	public function prepare_items() {
		global $connection_now;

		if ( empty( $connection_now ) || empty( $connection_now->pull_post_type ) ) {
			return;
		}

		$columns  = $this->get_columns();
		$hidden   = get_hidden_columns( $this->screen );
		$sortable = [];

		$data = $this->table_data();

		$this->_column_headers = array( $columns, $hidden, $sortable );

		/** Process bulk action */
		$this->process_bulk_action();

		$per_page     = $this->get_items_per_page( 'pull_posts_per_page', get_option( 'posts_per_page' ) );
		$current_page = $this->get_pagenum();

		// Support 'View all' filtering for internal connections.
		if ( empty( $connection_now->pull_post_type ) || 'all' === $connection_now->pull_post_type ) {
			$post_type = wp_list_pluck( $connection_now->pull_post_types, 'slug' );
		} else {
			$post_type = $connection_now->pull_post_type;
		}

		$remote_get_args = [
			'posts_per_page' => $per_page,
			'paged'          => $current_page,
			'post_type'      => $post_type,
			'dt_pull_list'   => true, // custom argument used to only run code on this screen
		];

		if ( ! empty( $_GET['s'] ) ) { // @codingStandardsIgnoreLine Nonce isn't required.
			$remote_get_args['s'] = rawurlencode( $_GET['s'] ); // @codingStandardsIgnoreLine Nonce isn't required.
		}

		if ( is_a( $connection_now, '\Distributor\ExternalConnection' ) ) {
			$this->sync_log = get_post_meta( $connection_now->id, 'dt_sync_log', true );
		} else {
			$this->sync_log = [];

			$sync_log = get_option( 'dt_sync_log', [] );

			if ( ! empty( $sync_log[ $connection_now->site->blog_id ] ) ) {
				$this->sync_log = $sync_log[ $connection_now->site->blog_id ];
			}
		}

		if ( empty( $this->sync_log ) ) {
			$this->sync_log = [];
		}

		$skipped     = array();
		$syndicated  = array();
		$total_items = false;

		foreach ( $this->sync_log as $old_post_id => $new_post_id ) {
			if ( false === $new_post_id ) {
				$skipped[] = (int) $old_post_id;
			} else {
				$syndicated[] = (int) $old_post_id;
			}
		}

		if ( empty( $_GET['status'] ) || 'new' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not required.
			$post_ids = array_merge( $skipped, $syndicated );

			if ( ! empty( $post_ids ) ) {
				$remote_get_args['post__not_in'] = $post_ids;
			}

			// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query -- meta_key is indexed.
			$remote_get_args['meta_query'] = [
				[
					'key'     => 'dt_syndicate_time',
					'compare' => 'NOT EXISTS',
				],
			];
		} elseif ( 'skipped' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not required.
			// Put most recently skipped items first.
			$skipped     = array_reverse( $skipped );
			$total_items = count( $skipped );
			$offset      = $per_page * ( $current_page - 1 );
			$post_ids    = array_slice( $skipped, $offset, $per_page, true );

			$remote_get_args['post__in'] = $post_ids;
			$remote_get_args['orderby']  = 'post__in';
			$remote_get_args['paged']    = 1;
		} else {
			// Put most recently pulled items first.
			$syndicated  = array_reverse( $syndicated );
			$total_items = count( $syndicated );
			$offset      = $per_page * ( $current_page - 1 );
			$post_ids    = array_slice( $syndicated, $offset, $per_page, true );

			$remote_get_args['post__in'] = $post_ids;
			$remote_get_args['orderby']  = 'post__in';
			$remote_get_args['paged']    = 1;
		}

		if ( ! is_array( $remote_get_args['post_type'] ) ) {
			$remote_get_args['post_type'] = [ $remote_get_args['post_type'] ];
		}

		$total_items   = 0;
		$response_data = array();

		// Setup remote connection from the connection object.
		$remote_get = $connection_now->remote_get( $remote_get_args );

		// Check and throw error if there is one.
		if ( is_wp_error( $remote_get ) ) {
			$this->pull_error = $remote_get->get_error_messages();
		}

		$total_items   = $remote_get['total_items'];
		$response_data = array_merge( $response_data, array_values( $remote_get['items'] ) );

		$this->set_pagination_args(
			[
				'total_items' => $total_items,
				'per_page'    => $per_page,
			]
		);

		foreach ( $response_data as $item ) {
			$this->items[] = $item;
		}
	}

	/**
	 * Handles the checkbox column output.
	 *
	 * @since 4.3.0
	 * @param \WP_Post $post The current WP_Post object.
	 */
	public function column_cb( $post ) {
		if ( isset( $this->sync_log[ $post->ID ] ) && false !== $this->sync_log[ $post->ID ] ) {
			return;
		}
		?>
		<label class="screen-reader-text" for="cb-select-<?php echo (int) $post->ID; ?>">
		<?php /* translators: %s: the post title or draft */ ?>
		<?php echo esc_html( sprintf( esc_html__( 'Select %s', 'distributor' ), _draft_or_post_title() ) ); ?>
		</label>
		<input id="cb-select-<?php echo (int) $post->ID; ?>" type="checkbox" name="post[]" value="<?php echo (int) $post->ID; ?>" />
		<div class="locked-indicator"></div>
		<?php
	}

	/**
	 * Get available bulk actions
	 *
	 * @since  0.8
	 * @return array
	 */
	public function get_bulk_actions() {
		if ( empty( $_GET['status'] ) || 'new' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not required.
			$actions = [
				'-1'             => esc_html__( 'Bulk Actions', 'distributor' ),
				'bulk-syndicate' => esc_html__( 'Pull', 'distributor' ),
				'bulk-skip'      => esc_html__( 'Skip', 'distributor' ),
			];
		} elseif ( 'skipped' === $_GET['status'] ) { // @codingStandardsIgnoreLine Nonce not required.
			$actions = [
				'-1'             => esc_html__( 'Bulk Actions', 'distributor' ),
				'bulk-syndicate' => esc_html__( 'Pull', 'distributor' ),
				'bulk-unskip'    => esc_html__( 'Unskip', 'distributor' ),
			];
		} else {
			$actions = [];
		}

		return $actions;
	}

	/**
	 * Adds a hook after the bulk actions dropdown above and below the list table
	 *
	 * @param string $which Whether above or below the table.
	 */
	public function extra_tablenav( $which ) {
		global $connection_now;

		if ( is_a( $connection_now, '\Distributor\InternalConnections\NetworkSiteConnection' ) ) {
			$connection_type = 'internal';
		} else {
			$connection_type = 'external';
		}

		if ( $connection_now && $connection_now->pull_post_types ) :
			?>

			<div class="alignleft actions dt-pull-post-type">
				<label for="pull_post_type" class="screen-reader-text">Content to Pull</label>
				<select id="pull_post_type" name="pull_post_type">
					<option <?php selected( $connection_now->pull_post_type, 'all' ); ?> value="all">
						<?php esc_html_e( 'View all', 'distributor' ); ?>
					</option>
					<?php foreach ( $connection_now->pull_post_types as $post_type ) : ?>
						<option <?php selected( $connection_now->pull_post_type, $post_type['slug'] ); ?> value="<?php echo esc_attr( $post_type['slug'] ); ?>">
							<?php echo esc_html( $post_type['name'] ); ?>
						</option>
					<?php endforeach; ?>
				</select>
				<input type="submit" name="filter_action" id="pull_post_type_submit" class="button" value="<?php esc_attr_e( 'Filter', 'distributor' ); ?>">

				<?php
				// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- nonce is not required.
				if ( empty( $_GET['status'] ) || 'pulled' !== $_GET['status'] ) :
					// Filter documented above.
					$as_draft = apply_filters( 'dt_pull_as_draft', true, $connection_now );
					?>

					<label class="dt-as-draft" for="dt-as-draft-<?php echo esc_attr( $which ); ?>">
						<input type="checkbox" id="dt-as-draft-<?php echo esc_attr( $which ); ?>" name="dt_as_draft" value="draft" <?php checked( $as_draft ); ?>> <?php esc_html_e( 'Pull as draft', 'distributor' ); ?>
					</label>
				<?php endif; ?>
			</div>

			<?php
		endif;

		/**
		 * Action fired when extra table nav is generated.
		 *
		 * @since 1.0
		 * @hook dt_pull_filters
		 */
		do_action( 'dt_pull_filters' );
	}
}