Import) and its form handlers.
*
* @package BeariusCalendar
*/
defined( 'ABSPATH' ) || exit;
/**
* Address of the Import screen.
*
* @param array $args Query arguments.
* @return string
*/
function bcal_import_url( $args = array() ) {
return add_query_arg( $args, admin_url( 'edit.php?post_type=' . BCAL_PT . '&page=bcal-settings&tab=import' ) );
}
/**
* Select with terms of a taxonomy.
*
* @param string $name Field name.
* @param string $taxonomy Taxonomy.
* @param int $selected Selected term ID.
* @param string $none Label of the empty option.
* @param string $id Element ID.
*/
function bcal_import_term_select( $name, $taxonomy, $selected, $none, $id = '' ) {
$terms = get_terms(
array(
'taxonomy' => $taxonomy,
'hide_empty' => false,
'number' => 500,
'orderby' => 'name',
)
);
echo '' . esc_html( $none ) . ' ';
if ( ! is_wp_error( $terms ) ) {
foreach ( $terms as $term ) {
echo 'term_id, false ) . '>' . esc_html( $term->name ) . ' ';
}
}
echo '' . esc_html( $label ) . ' ';
if ( $help ) {
echo '
' . esc_html( $help ) . '
';
}
echo wp_kses( '
' . esc_html( $label ) . ' ';
if ( $help ) {
echo '
' . esc_html( $help ) . '
';
}
echo '
';
foreach ( $options as $key => $text ) {
echo '' . esc_html( $text ) . '
';
bcal_import_seg(
'bcal_opt[status_new]',
$o['status_new'],
array(
'publish' => __( 'Publish', 'bearius-calendar' ),
'pending' => __( 'Pending review', 'bearius-calendar' ),
'draft' => __( 'Draft', 'bearius-calendar' ),
),
__( 'New events', 'bearius-calendar' )
);
if ( 'feed' === $context ) {
bcal_import_seg(
'bcal_opt[on_removed]',
$o['on_removed'],
array(
'keep' => __( 'Keep', 'bearius-calendar' ),
'draft' => __( 'Move to drafts', 'bearius-calendar' ),
'cancelled' => __( 'Mark as cancelled', 'bearius-calendar' ),
),
__( 'Event disappears from the source', 'bearius-calendar' ),
__( 'Only future events within the dates the source still covers are affected.', 'bearius-calendar' )
);
}
echo '
' . esc_html__( 'Default category', 'bearius-calendar' ) . ' ' . esc_html__( 'For events without a category in the source.', 'bearius-calendar' ) . '
';
bcal_import_term_select( 'bcal_opt[default_category]', 'bcal_category', (int) $o['default_category'], __( '(none)', 'bearius-calendar' ), 'bcal-imp-cat' );
echo '
';
echo '
' . esc_html__( 'Default city', 'bearius-calendar' ) . ' ' . esc_html__( 'When the city cannot be recognised from the location.', 'bearius-calendar' ) . '
';
bcal_import_term_select( 'bcal_opt[default_city]', 'bcal_city', (int) $o['default_city'], __( '(none)', 'bearius-calendar' ), 'bcal-imp-city' );
echo '
';
bcal_import_seg(
'bcal_opt[cat_new]',
$o['cat_new'],
array(
'create' => __( 'Add them', 'bearius-calendar' ),
'skip' => __( 'Skip them', 'bearius-calendar' ),
),
__( 'Categories that do not exist yet', 'bearius-calendar' ),
__( 'Existing categories are matched by name and aliases first.', 'bearius-calendar' )
);
echo '
';
bcal_import_switch( 'bcal_opt[images]', ! empty( $o['images'] ) && $granted, __( 'Download images', 'bearius-calendar' ), __( 'Images already in your media library are always reused, without downloading.', 'bearius-calendar' ), 'data-bcal-images-toggle' );
echo '
';
echo wp_kses( bcal_admin_icon( 'shield' ), bcal_kses_svg() );
echo '
';
if ( $granted ) {
$user = get_userdata( (int) $rights['user'] );
echo '
' . esc_html(
sprintf(
/* translators: 1: user name, 2: date, 3: website address */
__( 'Rights confirmed by %1$s on %2$s for %3$s.', 'bearius-calendar' ),
$user ? $user->display_name : '#' . (int) $rights['user'],
wp_date( (string) get_option( 'date_format' ), (int) $rights['time'] ),
isset( $rights['host'] ) ? $rights['host'] : ''
)
) . '
';
} else {
echo '
' . esc_html__( 'I confirm that I have the right to publish images from this source (my own material, a licence or the permission of the owner).', 'bearius-calendar' ) . ' ';
echo '
' . esc_html__( 'Your name, the date and the source address are saved with the confirmation. The plugin cannot check the rights itself.', 'bearius-calendar' ) . '
';
}
echo '
';
bcal_import_switch( 'bcal_opt[credit]', ! empty( $o['credit'] ), __( 'Caption with the source', 'bearius-calendar' ), __( 'Adds "Source: domain" to each downloaded image.', 'bearius-calendar' ) );
bcal_import_switch( 'bcal_opt[enrich]', ! empty( $o['enrich'] ), __( 'Fill in details from event pages', 'bearius-calendar' ), __( 'Reads the event page linked in the calendar: image, price, ticket link, address, organizer and status. Only empty fields are filled.', 'bearius-calendar' ) );
bcal_import_switch( 'bcal_opt[keep_images]', ! empty( $o['keep_images'] ), __( 'Keep images inside descriptions', 'bearius-calendar' ), __( 'Off: images loaded from other servers are removed from descriptions. They can track your visitors.', 'bearius-calendar' ) );
echo '
';
bcal_import_seg(
'bcal_opt[seo]',
$o['seo'],
array(
'none' => __( 'Index normally', 'bearius-calendar' ),
'canonical' => __( 'Canonical to the original', 'bearius-calendar' ),
'noindex' => __( 'Do not index', 'bearius-calendar' ),
),
__( 'Search engines', 'bearius-calendar' ),
__( 'For events copied from other websites, pointing to the original avoids duplicate content.', 'bearius-calendar' )
);
bcal_import_switch( 'bcal_opt[show_source]', ! empty( $o['show_source'] ), __( 'Show the source on the event page', 'bearius-calendar' ), __( 'A "Source: domain" link under the dates.', 'bearius-calendar' ) );
bcal_import_switch( 'bcal_opt[past]', ! empty( $o['past'] ), __( 'Import past events too', 'bearius-calendar' ) );
echo '
' . esc_html__( 'Only events with these words', 'bearius-calendar' ) . ' ' . esc_html__( 'Comma or new line separated. Empty imports everything.', 'bearius-calendar' ) . '
';
echo '
' . esc_html__( 'Skip events with these words', 'bearius-calendar' ) . '
';
echo '
' . esc_html( $messages[ $code ][1] ) . '
';
$feed_id = isset( $_GET['feed'] ) ? sanitize_key( wp_unslash( $_GET['feed'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( '' !== $feed_id ) {
bcal_render_feed_editor( $feed_id );
bcal_render_import_history();
echo '
';
return;
}
bcal_render_import_history();
bcal_render_import_tec();
bcal_render_import_ics();
bcal_render_import_feeds();
echo '';
}
/**
* Section header.
*
* @param string $title Title.
* @param string $desc Description.
* @param string $icon Icon.
*/
function bcal_import_section_head( $title, $desc, $icon ) {
echo wp_kses( '' . bcal_admin_icon( $icon ) . ' ' . esc_html( $title ) . '', bcal_kses_html() );
if ( $desc ) {
echo '
' . esc_html( $desc ) . '
';
}
echo '
';
bcal_import_section_head( __( 'From The Events Calendar', 'bearius-calendar' ), __( 'Events are converted in place: addresses, images, comments and SEO data stay. The original data is not changed, so the conversion can be undone.', 'bearius-calendar' ), 'import' );
echo '';
if ( ! $info['events'] && ! $info['venues'] && ! $info['organizers'] ) {
echo '
';
echo $info['converted'] ? esc_html( sprintf( /* translators: %d: number of events */ _n( '%d event was converted from The Events Calendar.', '%d events were converted from The Events Calendar.', $info['converted'], 'bearius-calendar' ), $info['converted'] ) ) : esc_html__( 'No data from The Events Calendar was found on this site.', 'bearius-calendar' );
echo '
';
return;
}
$stats = array(
array( $info['events'], __( 'Events', 'bearius-calendar' ) ),
array( $info['recurring'] + $info['occurrence'], __( 'Recurring or series dates', 'bearius-calendar' ) ),
array( $info['images'], __( 'With an image', 'bearius-calendar' ) ),
array( $info['venues'], __( 'Venues', 'bearius-calendar' ) ),
array( $info['organizers'], __( 'Organizers', 'bearius-calendar' ) ),
array( $info['categories'], __( 'Categories', 'bearius-calendar' ) ),
);
echo '';
foreach ( $stats as $stat ) {
echo '
' . esc_html( number_format_i18n( $stat[0] ) ) . ' ' . esc_html( $stat[1] ) . '
';
}
echo '
';
$notes = array();
if ( $info['active'] ) {
$notes[] = array( 'warn', __( 'The Events Calendar is active. Deactivate it after the conversion so both plugins do not use the same addresses.', 'bearius-calendar' ) );
}
if ( $info['listed'] ) {
/* translators: %d: number of events */
$notes[] = array( 'info', sprintf( _n( '%d repeat rule is not supported: its dates will be saved as a list of dates.', '%d repeat rules are not supported: their dates will be saved as lists of dates.', $info['listed'], 'bearius-calendar' ), $info['listed'] ) );
}
if ( $info['occurrence'] ) {
$notes[] = array( 'info', __( 'Older recurring series store every date as a separate post. Their dates are added to the main event; the separate posts are left untouched.', 'bearius-calendar' ) );
}
if ( $info['tagged'] ) {
$notes[] = array( 'info', __( 'Tags stay in the database but are not shown for events.', 'bearius-calendar' ) );
}
if ( $info['converted'] ) {
/* translators: %d: number of events */
$notes[] = array( 'info', sprintf( _n( '%d event was already converted earlier.', '%d events were already converted earlier.', $info['converted'], 'bearius-calendar' ), $info['converted'] ) );
}
foreach ( $notes as $note ) {
echo wp_kses( '
' . bcal_admin_icon( 'warn' === $note[0] ? 'alert' : 'check' ) . '
' . esc_html( $note[1] ) . '
', bcal_kses_html() );
}
echo '
';
bcal_import_section_head( __( 'Import an .ics calendar', 'bearius-calendar' ), __( 'A calendar file or address, imported once. Running the same calendar again updates events instead of adding them twice.', 'bearius-calendar' ), 'when' );
echo ' ';
}
/**
* Subscriptions list.
*/
function bcal_render_import_feeds() {
$feeds = BCal_Import_Feeds::all();
$intervals = BCal_Import_Feeds::intervals();
echo '';
bcal_import_section_head( __( 'Subscriptions', 'bearius-calendar' ), __( 'Calendars checked on a schedule: new events are added and changed ones updated. Fields you edit by hand are never overwritten.', 'bearius-calendar' ), 'feed' );
echo '';
if ( ! $feeds ) {
echo '
' . esc_html__( 'No subscriptions yet.', 'bearius-calendar' ) . '
';
} else {
echo '
';
foreach ( $feeds as $feed ) {
$state = (array) $feed['state'];
$host = (string) wp_parse_url( $feed['url'], PHP_URL_HOST );
$name = '' !== $feed['name'] ? $feed['name'] : $host;
echo '';
echo wp_kses( '' . bcal_admin_icon( 'feed' ) . ' ', bcal_kses_html() );
echo '' . esc_html( $name ) . ' ';
echo '' . esc_html( $host ) . ' · ' . esc_html( isset( $intervals[ $feed['interval'] ] ) ? $intervals[ $feed['interval'] ][1] : '' ) . ' ';
if ( ! $feed['enabled'] ) {
echo '' . esc_html__( 'Paused', 'bearius-calendar' ) . ' ';
} elseif ( ! empty( $state['error'] ) ) {
echo '' . esc_html__( 'Last check failed', 'bearius-calendar' ) . ' ';
} elseif ( ! empty( $state['last_ok'] ) ) {
/* translators: %s: time ago such as "5 minutes" */
echo wp_kses( '' . bcal_admin_icon( 'check' ) . esc_html( sprintf( __( 'Checked %s ago', 'bearius-calendar' ), human_time_diff( (int) $state['last_ok'] ) ) ) . ' ', bcal_kses_html() );
} else {
echo '' . esc_html__( 'Not checked yet', 'bearius-calendar' ) . ' ';
}
echo ' ';
echo '';
echo '', bcal_kses_html() );
echo '' . esc_html__( 'Settings', 'bearius-calendar' ) . ' ';
echo ' ';
}
echo ' ';
}
echo wp_kses( '
', bcal_kses_html() );
echo '
';
}
/**
* Subscription editor.
*
* @param string $feed_id Subscription ID or "new".
*/
function bcal_render_feed_editor( $feed_id ) {
$feed = 'new' === $feed_id ? BCal_Import_Feeds::defaults() : BCal_Import_Feeds::get( $feed_id );
$intervals = BCal_Import_Feeds::intervals();
if ( ! $feed ) {
echo '' . esc_html__( 'This subscription does not exist.', 'bearius-calendar' ) . '
';
return;
}
echo '← ' . esc_html__( 'All import options', 'bearius-calendar' ) . '
';
echo '';
bcal_import_section_head( 'new' === $feed_id ? __( 'New subscription', 'bearius-calendar' ) : __( 'Subscription settings', 'bearius-calendar' ), __( 'Paste the calendar address (.ics or webcal). The first import starts when you save.', 'bearius-calendar' ), 'feed' );
echo '';
echo '
';
if ( 'new' !== $feed_id ) {
echo '
', bcal_kses_html() );
}
echo '
';
}
/**
* Import history with progress, summaries and actions.
*/
function bcal_render_import_history() {
// Quiet subscription checks: only the latest one per subscription is shown.
$sessions = array();
$quiet = array();
foreach ( BCal_Import::sessions( true ) as $session ) {
if ( 'approved' === $session['status'] && in_array( $session['message'], array( 'no_changes', 'not_modified' ), true ) ) {
if ( isset( $quiet[ $session['feed'] ] ) ) {
continue;
}
$quiet[ $session['feed'] ] = true;
}
$sessions[] = $session;
}
$sessions = array_slice( $sessions, 0, 15 );
if ( ! $sessions ) {
return;
}
$counts = BCal_Import::count_labels();
$warnings = BCal_Import::warning_labels();
$active = false;
echo '';
bcal_import_section_head( __( 'Imports', 'bearius-calendar' ), __( 'Imports run in the background in small batches. Until you approve an import, everything it added or changed can be undone.', 'bearius-calendar' ), 'repeat' );
echo '';
foreach ( $sessions as $session ) {
$state = BCal_Import::public_state( $session );
$running = in_array( $session['status'], array( 'queued', 'running', 'undoing', 'paused' ), true );
$active = $active || in_array( $session['status'], array( 'queued', 'running', 'undoing' ), true );
$icon = 'tec' === $session['source'] ? 'import' : ( '' !== $session['feed'] ? 'feed' : 'when' );
echo '';
echo wp_kses( '' . bcal_admin_icon( $icon ) . ' ', bcal_kses_html() );
echo '' . esc_html( $session['label'] ) . ' ' . esc_html( wp_date( (string) get_option( 'date_format' ) . ' ' . (string) get_option( 'time_format' ), (int) $session['created'] ) ) . ' ' . esc_html( $state['label'] ) . '
';
if ( $running ) {
echo '
';
echo '
' . esc_html( $state['phase'] ) . ' ' . ( $state['total'] ? esc_html( number_format_i18n( $state['done'] ) . ' / ' . number_format_i18n( $state['total'] ) ) : '' ) . ' ' . esc_html__( 'The calendar has not changed since the last check.', 'bearius-calendar' ) . '
';
} elseif ( 'no_changes' === $session['message'] ) {
echo '' . esc_html__( 'Checked: no new or changed events.', 'bearius-calendar' ) . '
';
} elseif ( 'failed' === $session['status'] && $session['message'] ) {
echo '' . esc_html( $session['message'] ) . '
';
}
if ( 'undone' === $session['status'] ) {
/* translators: 1: number of removed items, 2: number of kept items */
echo '' . esc_html( sprintf( __( 'Undone: %1$d events restored or removed, %2$d kept because they were edited.', 'bearius-calendar' ), (int) ( isset( $session['undo']['removed'] ) ? $session['undo']['removed'] : 0 ), (int) ( isset( $session['undo']['kept'] ) ? $session['undo']['kept'] : 0 ) ) ) . '
';
}
$shown = array();
foreach ( $counts as $key => $label ) {
if ( ! empty( $session['counts'][ $key ] ) ) {
$shown[] = ' ' . esc_html( $label ) . ' ' . esc_html( number_format_i18n( (int) $session['counts'][ $key ] ) ) . ' ' . implode( '', $shown ) . ' ', bcal_kses_html() );
}
if ( $session['warnings'] ) {
$total = 0;
foreach ( $session['warnings'] as $warning ) {
$total += (int) $warning['count'];
}
/* translators: %d: number of notes */
echo wp_kses( '' . bcal_admin_icon( 'alert' ) . esc_html( sprintf( _n( '%d note', '%d notes', $total, 'bearius-calendar' ), $total ) ) . ' ', bcal_kses_html() );
foreach ( $session['warnings'] as $code => $warning ) {
echo '' . esc_html( isset( $warnings[ $code ] ) ? $warnings[ $code ] : $code ) . ' ' . esc_html( number_format_i18n( (int) $warning['count'] ) ) . ' ';
if ( ! empty( $warning['samples'] ) ) {
echo '' . esc_html( implode( ' · ', $warning['samples'] ) ) . ' ';
}
echo ' ';
foreach ( $actions as $action ) {
echo '', bcal_kses_html() );
}
echo '
';
}
echo '';
}
echo ' ';
if ( $active ) {
echo '