%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
// Don't load directly
defined( 'WPINC' ) or die;
class Tribe__Events__Aggregator__API__Origins extends Tribe__Events__Aggregator__API__Abstract {
/**
* @since 4.9.6
*/
const VERSION = '1.1.0';
/**
* @var array
*/
public $origins;
/**
* @var bool Whether EA is enabled or not.
* While EA might be ready to work on a license and functional level
* the user might disable it; this flag tracks that choice.
*/
protected $is_ea_disabled = true;
/**
* @var array An array of origins that will still be available when EA has
* been disabled by the user.
*/
protected $available_when_disabled = [ 'csv' ];
public function __construct() {
parent::__construct();
$this->origins = [
'csv' => (object) [
'id' => 'csv',
'name' => __( 'CSV File', 'the-events-calendar' ),
'disabled' => false,
],
'eventbrite' => (object) [
'id' => 'eventbrite',
'name' => __( 'Eventbrite', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
'gcal' => (object) [
'id' => 'gcal',
'name' => __( 'Google Calendar', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
'ical' => (object) [
'id' => 'ical',
'name' => __( 'iCalendar', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
'ics' => (object) [
'id' => 'ics',
'name' => __( 'ICS File', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
'meetup' => (object) [
'id' => 'meetup',
'name' => __( 'Meetup', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
'url' => (object) [
'id' => 'url',
'name' => __( 'Other URL', 'the-events-calendar' ),
'disabled' => true,
'upsell' => true,
],
];
$this->is_ea_disabled = tribe_get_option( 'tribe_aggregator_disable', false );
}
/**
* Get event-aggregator origins
*
* @return array
*/
public function get() {
if ( tribe( 'events-aggregator.main' )->is_service_active() ) {
$this->enable_service_origins();
}
$origins = $this->origins;
$origins = array_filter( $origins, [ $this, 'is_origin_available' ] );
/**
* The origins (sources) that EA can import from
*
* @param array $origins The origins
*/
$origins = apply_filters( 'tribe_aggregator_origins', $origins );
return $origins;
}
/**
* Get event-aggregator origins from the service or cache
*
* @return array
*/
private function enable_service_origins() {
$cached_origins = get_transient( "{$this->cache_group}_origins" );
$cached_version = ! empty( $cached_origins->version )
? $cached_origins->version
: '1.0.0';
if ( $cached_origins && version_compare( $cached_version, static::VERSION, '=' ) ) {
$this->origins = $cached_origins;
return $this->origins;
}
$service_origins = $this->fetch_origin_data();
if ( is_wp_error( $service_origins ) ) {
return $this->origins;
}
if ( empty( $service_origins->origin ) ) {
return $this->origins;
}
// enable the options for any that come back from the Service
foreach ( $service_origins->origin as $origin ) {
if ( ! empty( $this->origins[ $origin->id ] ) ) {
$this->origins[ $origin->id ]->disabled = false;
}
}
// use the specified expiration if available
if ( isset( $this->origins->expiration ) ) {
$expiration = $this->origins->expiration;
unset( $this->origins->expiration );
} else {
$expiration = 6 * HOUR_IN_SECONDS;
}
set_transient( "{$this->cache_group}_origins", $this->origins, $expiration );
return $this->origins;
}
/**
* Fetches origin data from the service and sets necessary transients
*/
private function fetch_origin_data() {
$request_cached = tribe_get_var( 'events-aggregator.origins-data' );
if ( empty( $request_cached ) ) {
// Try to see if we have a lock in place.
$lock = get_transient( "{$this->cache_group}_fetch_lock" );
}
if ( ! empty( $lock ) ) {
return $request_cached;
}
list( $origin_data, $error ) = $this->service->get_origins( true );
$origin_data = (object) $origin_data;
$version = ! empty( $origin_data->version ) ? $origin_data->version : '1.0.0';
if ( empty( $error ) ) {
// Refresh some accessory transients and embed the version in them.
$oauth_data = $origin_data->oauth;
$limit_data = $origin_data->limit;
$oauth_data->version = $limit_data->version = $version;
set_transient( "{$this->cache_group}_origin_oauth", $oauth_data, 6 * HOUR_IN_SECONDS );
set_transient( "{$this->cache_group}_origin_limit", $limit_data, 6 * HOUR_IN_SECONDS );
} elseif ( 403 == wp_remote_retrieve_response_code( $error ) ) {
// Store the origins data for 5' only.
$origin_data->expiration = 300;
// And avoid bugging the service for 5'.
set_transient( "{$this->cache_group}_fetch_lock", $origin_data, 300 );
}
tribe_set_var( 'events-aggregator.origins-data', $origin_data );
return $origin_data;
}
/**
* Returns whether oauth for a given origin is enabled.
*
* The OAuth status for the origin is enabled on EA Service side.
*
* @param string $origin The origin to check the OAuth status for.
*
* @return boolean Whether OAuth is enabled for the origin or not.
*/
public function is_oauth_enabled( $origin ) {
if ( 'eventbrite' !== $origin && ! tribe( 'events-aggregator.main' )->is_service_active() ) {
return false;
}
if ( 'eventbrite' === $origin && class_exists( 'Tribe__Events__Tickets__Eventbrite__Main' ) ) {
return true;
}
$oauth = $this->get_data( 'oauth' );
return ! empty( $oauth->{$origin} ) && (bool) $oauth->{$origin};
}
/**
* Get origin limit values for an operation.
*
* @param string $type Type of operation limit to retrieve; defaults to `import`.
*
* @return int The numeric limit (how many times) applied to the operation.
*/
public function get_limit( $type = 'import' ) {
$limits = $this->get_data( 'limit' );
return ! empty( $limits->{$type} ) ? (int) $limits->{$type} : false;
}
public function get_name( $id ) {
$this->get();
if ( empty( $this->origins[ $id ] ) ) {
return __( 'Event Aggregator', 'the-events-calendar' );
}
return $this->origins[ $id ]->name;
}
/**
* Whether an origin is available or not in respect to the user possibility
* to disable EA functions.
*
* @param stdClass|string $origin The origin to check for availability as an object
* or a slug.
*
* @return bool
*/
public function is_origin_available( $origin ) {
if ( is_object( $origin ) ) {
$origin = $origin->id;
}
return $this->is_ea_disabled ? in_array( $origin, $this->available_when_disabled ) : true;
}
/**
* Gets the data for an internal Origins data key.
*
* The result might be cached from a previous request.
*
* @since 4.9.6
*
* @param string|null $key The key to fetch the data for.
*
* @return mixed|object|bool The data associated with the key if any and available, `false` otherwise.
*/
public function get_data( $key ) {
if ( null === $key ) {
return $this->fetch_origin_data();
}
$data = get_transient( "{$this->cache_group}_origin_{$key}" );
$cached_version = isset( $data->version ) ? $data->version : '1.0.0';
if ( ! version_compare( $cached_version, static::VERSION, '=' ) ) {
$origin_data = $this->fetch_origin_data();
$data = ! empty( $origin_data->{$key} ) ? $origin_data->{$key} : false;
}
return $data;
}
}
Zerion Mini Shell 1.0