| Dir : /home/trave494/tiktechtok.org/wp-content/plugins/pinterest-for-woocommerce/src/API/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //home/trave494/tiktechtok.org/wp-content/plugins/pinterest-for-woocommerce/src/API/FeedState.php |
<?php
/**
* Handle & return Pinterest Feed State
*
* @package Pinterest_For_Woocommerce/API
* @version 1.0.0
*/
namespace Automattic\WooCommerce\Pinterest\API;
use Automattic\WooCommerce\Pinterest as Pinterest;
use Automattic\WooCommerce\Pinterest\FeedRegistration;
use Automattic\WooCommerce\Pinterest\Feeds;
use Automattic\WooCommerce\Pinterest\LocalFeedConfigs;
use Automattic\WooCommerce\Pinterest\ProductSync;
use Automattic\WooCommerce\Pinterest\RichPins;
use Automattic\WooCommerce\Pinterest\Tracking;
use WP_Error;
use \WP_REST_Server;
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Endpoint returning the current state of the XML feed.
*/
class FeedState extends VendorAPI {
/**
* Initialize class
*/
public function __construct() {
$this->base = 'feed_state';
$this->endpoint_callback = 'get_feed_state';
$this->methods = WP_REST_Server::READABLE;
$this->register_routes();
$this->hooks();
}
/**
* Add feed state hooks.
*/
private function hooks() {
add_filter( 'pinterest_for_woocommerce_feed_state', array( $this, 'add_local_feed_state' ) );
add_filter( 'pinterest_for_woocommerce_feed_state', array( $this, 'add_feed_registration_state' ) );
add_filter( 'pinterest_for_woocommerce_feed_state', array( $this, 'add_third_party_tags_warning' ) );
add_filter( 'pinterest_for_woocommerce_feed_state', array( $this, 'add_rich_pins_conflict_warning' ) );
}
/**
* Get the status of the current feed, for:
* - the local feed configuration.
* - the remote feed registration.
* - the feed ingestion process.
*
* The form of the returned data is as follows:
*
* [
* workflow => [
* [
* 'label' => 'The label of this workflow',
* 'status' => 'success|warning|error|etc',
* 'status_label' => 'The result for this workflow'
* 'extra_info' => 'Extra info for this workflow'
* ],
* ...
* ],
* 'overview' => [
* 'total' => 0, // Total number of products in the feed.
* 'not_synced' => 0, // Number of products not synced because of errors.
* 'warnings' => 0, // Number of warnings.
* 'errors' => 0, // Number of errors.
* ]
* ]
*
* @return array|WP_Error
*
* @throws \Exception PHP Exception.
*/
public function get_feed_state() {
try {
if ( ! ProductSync::is_product_sync_enabled() ) {
return array(
'workflow' => array(
array(
'label' => esc_html__( 'XML feed', 'pinterest-for-woocommerce' ),
'status' => 'error',
'status_label' => esc_html__( 'Product sync is disabled.', 'pinterest-for-woocommerce' ),
'extra_info' => wp_kses_post( ProductSync::get_feed_status_extra_info() ),
),
),
'overview' => array(
'total' => 0,
'not_synced' => 0,
'warnings' => 0,
'errors' => 0,
),
);
}
/**
* Returns feed state.
* phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
*/
return apply_filters( 'pinterest_for_woocommerce_feed_state', array() );
} catch ( \Throwable $th ) {
/* Translators: The error description as returned from the API */
$error_message = sprintf( esc_html__( 'Error getting feed\'s state. [%s]', 'pinterest-for-woocommerce' ), $th->getMessage() );
return new WP_Error( \PINTEREST_FOR_WOOCOMMERCE_PREFIX . '_feed_state_error', $error_message, array( 'status' => $th->getCode() ) );
}
}
/**
* Adds to the result variable an array with info about the status of the local
* feed generation process.
*
* @param array $result The result array to add values to.
*
* @return array
*/
public function add_local_feed_state( $result ) {
$state = Pinterest\ProductFeedStatus::get();
$extra_info = '';
switch ( $state['status'] ) {
case 'in_progress':
$status = 'pending';
$status_label = esc_html__( 'Feed generation in progress.', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
esc_html(
/* translators: 1: Time string, 2: number of products, 3: opening anchor tag, 4: closing anchor tag */
_n(
'Last activity: %1$s ago - Wrote %2$s product to %3$sfeed file%4$s.',
'Last activity: %1$s ago - Wrote %2$s products to %3$sfeed file%4$s.',
$state['product_count'],
'pinterest-for-woocommerce'
)
),
human_time_diff( $state['last_activity'] ),
$state['product_count'],
sprintf( '<a href="%s" target="_blank">', esc_url( $this->get_feed_url() ) ),
'</a>',
);
break;
case 'generated':
$status = 'success';
$status_label = esc_html__( 'Up to date', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
esc_html(
/* translators: 1: Time string, 2: total number of products, 3: opening anchor tag, 4: closing anchor tag */
_n(
'Successfully generated %1$s ago - Wrote %2$s product to %3$sfeed file%4$s',
'Successfully generated %1$s ago - Wrote %2$s products to %3$sfeed file%4$s',
$state['product_count'],
'pinterest-for-woocommerce'
)
),
human_time_diff( $state['last_activity'] ),
$state['product_count'],
sprintf( '<a href="%s" target="_blank">', esc_url( $this->get_feed_url() ) ),
'</a>',
);
break;
case 'scheduled_for_generation':
$status = 'pending';
$status_label = esc_html__( 'Feed generation will start shortly.', 'pinterest-for-woocommerce' );
break;
case 'pending_config':
$status = 'pending';
$status_label = esc_html__( 'Feed configuration will start shortly.', 'pinterest-for-woocommerce' );
break;
default:
$status = 'error';
$status_label = esc_html__( 'Could not get feed info.', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
/* Translators: %1$s Time string, %2$s error message */
esc_html__( 'Last activity: %1$s ago - %2$s', 'pinterest-for-woocommerce' ),
human_time_diff( $state['last_activity'] ),
$state['error_message']
);
break;
}
$result['workflow'][] = array(
'label' => esc_html__( 'XML feed', 'pinterest-for-woocommerce' ),
'status' => $status,
'status_label' => $status_label,
'extra_info' => $extra_info,
);
return $result;
}
/**
* Adds to the result variable an array with info about the
* registration and configuration process of the XML feed to the Pinterest API.
*
* @param array $result The result array to add values to.
*
* @return array
*
* @throws \Exception PHP Exception.
*/
public function add_feed_registration_state( $result ) {
$extra_info = '';
switch ( Pinterest\FeedStatusService::get_feed_registration_status() ) {
case 'not_registered':
$status = 'pending';
$status_label = esc_html__( 'Product feed not yet configured on Pinterest.', 'pinterest-for-woocommerce' );
break;
case 'error_fetching_merchant':
$status = 'error';
$status_label = esc_html__( 'Could not get merchant info.', 'pinterest-for-woocommerce' );
break;
case 'error_fetching_feed':
$status = 'error';
$status_label = esc_html__( 'Could not get feed info.', 'pinterest-for-woocommerce' );
break;
case 'inactive_feed':
$status = 'error';
$status_label = esc_html__( 'Product feed not active.', 'pinterest-for-woocommerce' );
break;
case 'approved':
$status = 'success';
$status_label = esc_html__( 'Product feed configured for ingestion on Pinterest', 'pinterest-for-woocommerce' );
$merchant_id = Pinterest_For_Woocommerce()::get_data( 'merchant_id' );
$feed_id = FeedRegistration::get_locally_stored_registered_feed_id();
$feed = Pinterest\Feeds::get_merchant_feed( $merchant_id, $feed_id );
if ( ! empty( $feed->location_config->full_feed_fetch_freq ) ) {
$extra_info = wp_kses_post(
sprintf(
/* Translators: %1$s The URL of the product feed, %2$s Time string */
__( 'Pinterest will fetch your <a href="%1$s" target="_blank">product feed</a> every %2$s', 'pinterest-for-woocommerce' ),
$feed->location_config->full_feed_fetch_location,
human_time_diff( 0, ( $feed->location_config->full_feed_fetch_freq / 1000 ) )
)
);
}
break;
case 'pending':
case 'appeal_pending':
$status = 'pending';
$status_label = esc_html__( 'Product feed pending approval on Pinterest.', 'pinterest-for-woocommerce' );
break;
case 'declined':
$status = 'error';
$status_label = esc_html__( 'Product feed declined by Pinterest', 'pinterest-for-woocommerce' );
break;
default:
$status = 'error';
$status_label = esc_html__( 'Product feed not yet configured on Pinterest.', 'pinterest-for-woocommerce' );
break;
}
$result['workflow'][] = array(
'label' => esc_html__( 'Remote feed setup', 'pinterest-for-woocommerce' ),
'status' => $status,
'status_label' => $status_label,
'extra_info' => $extra_info,
);
if ( 'success' === $status ) {
$result = $this->add_feed_sync_status( $result );
} else {
$result['overview'] = array(
'total' => 0,
'not_synced' => 0,
'warnings' => 0,
'errors' => 0,
);
}
return $result;
}
/**
* Adds to the result variable an array with info about the
* third party plugins that may conflict with the tracking feature.
*
* @since 1.2.3
*
* @param array $result The result array to add values to.
*
* @return array
*
* @throws \Exception PHP Exception.
*/
public function add_third_party_tags_warning( $result ) {
$warning_message = Tracking::get_third_party_tags_warning_message();
if ( empty( $warning_message ) ) {
return $result;
}
$result['workflow'][] = array(
'label' => esc_html__( 'Pinterest tag', 'pinterest-for-woocommerce' ),
'status' => 'warning',
'status_label' => esc_html__( 'Potential conflicting plugins', 'pinterest-for-woocommerce' ),
'extra_info' => $warning_message,
);
return $result;
}
/**
* Adds to the result variable an array with info about the
* third party plugins that may conflict with the Rich Pins feature.
*
* @since 1.2.7
*
* @param array $result The result array to add values to.
*
* @return array
*
* @throws \Exception PHP Exception.
*/
public function add_rich_pins_conflict_warning( $result ) {
$warning_message = RichPins::get_third_party_conflict_warning_message();
if ( empty( $warning_message ) ) {
return $result;
}
$result['workflow'][] = array(
'label' => esc_html__( 'Pinterest Rich Pins', 'pinterest-for-woocommerce' ),
'status' => 'warning',
'status_label' => esc_html__( 'Potential conflicting plugins', 'pinterest-for-woocommerce' ),
'extra_info' => $warning_message,
);
return $result;
}
/**
* Adds to the result variable an array with info about the sync process / feed ingestion
* status as returned by Pinterest API.
*
* @param array $result The result array to add values to.
*
* @return array
*
* @throws \Exception PHP Exception.
*/
private function add_feed_sync_status( $result ) {
$feed_id = FeedRegistration::get_locally_stored_registered_feed_id();
$merchant_id = Pinterest_For_Woocommerce()::get_data( 'merchant_id' );
if ( ! $feed_id || ! $merchant_id ) {
throw new \Exception( esc_html__( 'Feed is not registered with Pinterest.', 'pinterest-for-woocommerce' ) );
}
$extra_info = '';
try {
$workflow = Feeds::get_feed_latest_workflow( (string) $merchant_id, (string) $feed_id );
if ( ! $workflow ) {
// No workflow to check.
throw new \Exception( esc_html__( 'Response error. Feed report contains no feed workflow.', 'pinterest-for-woocommerce' ) );
}
switch ( Pinterest\FeedStatusService::get_feed_sync_status() ) {
case 'completed':
case 'completed_early':
$status = 'success';
$status_label = esc_html__( 'Automatically pulled by Pinterest', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
/* Translators: %1$s Time string, %2$s number of products */
esc_html__( 'Last pulled: %1$s ago, containing %2$d products', 'pinterest-for-woocommerce' ),
human_time_diff( ( $workflow->created_at / 1000 ) ),
(int) $workflow->product_count
);
break;
case 'processing':
$status = 'pending';
$status_label = esc_html__( 'Processing', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
/* Translators: %1$s Time string, %2$s number of products */
esc_html__( 'Last pulled: %1$s ago, containing %2$d products', 'pinterest-for-woocommerce' ),
human_time_diff( ( $workflow->created_at / 1000 ) ),
(int) $workflow->product_count
);
break;
case 'under_review':
$status = 'pending';
$status_label = esc_html__( 'Feed is under review.', 'pinterest-for-woocommerce' );
break;
case 'queued_for_processing':
$status = 'pending';
$status_label = esc_html__( 'The feed is queued for processing.', 'pinterest-for-woocommerce' );
break;
case 'failed':
$status = 'error';
$status_label = esc_html__( 'Feed ingestion failed.', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
/* Translators: %1$s Time difference string */
esc_html__( 'Last attempt: %1$s ago', 'pinterest-for-woocommerce' ),
human_time_diff( ( $workflow->created_at / 1000 ) ),
(int) $workflow->product_count
);
$global_error = Pinterest\FeedStatusService::get_global_error_from_workflow( $workflow );
$extra_info .= $global_error ? ' - ' . $global_error : '';
break;
case 'unknown':
default:
$status = 'error';
$status_label = esc_html__( 'Unknown status in workflow.', 'pinterest-for-woocommerce' );
$extra_info = sprintf(
/* Translators: The status text returned by the API. */
esc_html__( 'API returned an unknown status: %1$s', 'pinterest-for-woocommerce' ),
$workflow->workflow_status
);
$global_error = Pinterest\FeedStatusService::get_global_error_from_workflow( $workflow );
$extra_info .= $global_error ? ' - ' . $global_error : '';
break;
}
$result['overview'] = Pinterest\FeedStatusService::get_workflow_overview_stats( $workflow );
} catch ( \Throwable $th ) {
$status = 'error';
$status_label = $th->getMessage();
$result['overview'] = array(
'total' => 0,
'not_synced' => 0,
'warnings' => 0,
'errors' => 0,
);
}
$result['workflow'][] = array(
'label' => esc_html__( 'Remote sync status', 'pinterest-for-woocommerce' ),
'status' => $status,
'status_label' => $status_label,
'extra_info' => $extra_info,
);
return $result;
}
/**
* Helper function used for fetching local feed config file.
*
* This is temporary as we will need to operate on multiple feed files in the future.
*
* @return string
*/
private function get_feed_url() {
$configs = LocalFeedConfigs::get_instance()->get_configurations();
$config = reset( $configs );
return $config['feed_url'];
}
}