<?php
if (!defined('ABSPATH')) {
die('No direct access.');
}
/**
* Slide class represting a single slide. This is extended by type specific
* slides (eg, MetaImageSlide, MetaYoutubeSlide (pro only), etc)
*/
class MetaSlide
{
public $slide = 0;
public $slider = 0;
public $settings = array(); // slideshow settings
/**
* Constructor
*/
public function __construct()
{
add_action('wp_ajax_update_slide_image', array( $this, 'ajax_update_slide_image' ));
}
/**
* Set the slide
*
* @param int $id ID
*/
public function set_slide($id)
{
$this->slide = get_post($id);
}
/**
* Set the slide (that this slide belongs to)
*
* @param int $id ID
*/
public function set_slider($id)
{
$this->slider = get_post($id);
$this->settings = get_post_meta($id, 'ml-slider_settings', true);
}
/**
* Return the HTML for the slide
*
* @param int $slide_id Slide ID
* @param int $slider_id Slider ID
* @return array complete array of slides
*/
public function get_slide($slide_id, $slider_id)
{
$this->set_slider($slider_id);
$this->set_slide($slide_id);
return $this->get_slide_html();
}
/**
* Save the slide
*
* @param int $slide_id Slide ID
* @param int $slider_id Slider ID
* @param string $fields SLider fields
*/
public function save_slide($slide_id, $slider_id, $fields)
{
$this->set_slider($slider_id);
$this->set_slide($slide_id);
$this->save($fields);
do_action('metaslider_save_slide', $slide_id, $slider_id, $fields);
}
/**
* Updates the slide meta value to a new image.
*
* @param int $slide_id The id of the slide being updated
* @param int $image_id The id of the new image to use
* @param int $slideshow_id The id of the slideshow
*
* @return array|WP_error The status message and if success, the thumbnail link
*/
protected function update_slide_image($slide_id, $image_id, $slideshow_id = null)
{
/*
* Verifies that the $image_id is an actual image
*/
if ( ! ( $thumbnail_url_small = $this->get_intermediate_image_src( 240, $image_id ) ) ) {
return new WP_Error('update_failed', __('The requested image does not exist. Please try again.', 'ml-slider'), array('status' => 409));
}
/*
* Updates database record and thumbnail if selection changed, assigns it to the slideshow, crops the image
*/
update_post_meta( $slide_id, '_thumbnail_id', $image_id );
if ( $slideshow_id ) {
$this->set_slider( $slideshow_id );
// Get cropped images for srcset attribute
$thumbnail_url_large = $this->get_intermediate_image_src( 1024, $image_id );
$thumbnail_url_medium = $this->get_intermediate_image_src( 768, $image_id );
// get resized image
$imageHelper = new MetaSliderImageHelper(
$slide_id,
$this->settings['width'],
$this->settings['height'],
isset($this->settings['smartCrop']) ? $this->settings['smartCrop'] : 'false'
);
return array(
'message' => __( 'The image was successfully updated.', 'ml-slider' ),
'thumbnail_url_small' => $thumbnail_url_small,
'thumbnail_url_medium' => $thumbnail_url_medium,
'thumbnail_url_large' => $thumbnail_url_large,
'img_url' => $imageHelper ? $imageHelper->get_image_url() : wp_get_attachment_image_url( $image_id, 'full' )
);
}
return new WP_Error(
'update_failed',
__( 'There was an error updating the image. Please try again', 'ml-slider' ),
array( 'status' => 409 )
);
}
/**
* Ajax wrapper to update the slide image.
*
* @return String The status message and if success, the thumbnail link (JSON)
*/
public function ajax_update_slide_image()
{
if (! isset($_REQUEST['_wpnonce']) || ! wp_verify_nonce(sanitize_key($_REQUEST['_wpnonce']), 'metaslider_update_slide_image')) {
wp_send_json_error(array(
'message' => __('The security check failed. Please refresh the page and try again.', 'ml-slider')
), 401);
}
$capability = apply_filters('metaslider_capability', MetaSliderPlugin::DEFAULT_CAPABILITY_EDIT_SLIDES);
if (! current_user_can($capability)) {
wp_send_json_error(
[
'message' => __('Access denied', 'ml-slider')
],
403
);
}
if (! isset($_POST['slide_id']) || ! isset($_POST['image_id']) || ! isset($_POST['slider_id'])) {
wp_send_json_error(
[
'message' => __('Bad request', 'ml-slider'),
],
400
);
}
$result = $this->update_slide_image(
absint($_POST['slide_id']),
absint($_POST['image_id']),
absint($_POST['slider_id'])
);
if (is_wp_error($result)) {
wp_send_json_error(array(
'message' => $result->get_error_message()
), 409);
}
wp_send_json_success($result, 200);
}
/**
* Return the correct slide HTML based on whether we're viewing the slides in the
* admin panel or on the front end.
*
* @return string slide html
*/
public function get_slide_html()
{
// If we are on the MetaSlider settings page, and the user has permission
// return the admin style slides
$on_settings_page = isset($_GET['page']) && ('metaslider' === $_GET['page']);
$has_permission = current_user_can(apply_filters('metaslider_capability', MetaSliderPlugin::DEFAULT_CAPABILITY_EDIT_SLIDES));
$ajax_call = apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX);
$rest_call = defined('REST_REQUEST') && REST_REQUEST;
if (is_admin() && $on_settings_page && $has_permission && !$ajax_call && !$rest_call) {
return $this->get_admin_slide();
}
// Otherwise deliver the public slide markup
return $this->get_public_slide();
}
/**
* Check if a slide already exists in a slideshow
*
* @param string $slider_id Slider ID
* @param string $slide_id SLide ID
* @return string
*/
public function slide_exists_in_slideshow($slider_id, $slide_id)
{
return has_term($slider_id, 'ml-slider', $slide_id);
}
/**
* Check if a slide has already been assigned to a slideshow
*
* @param string $slider_id Slider ID
* @param string $slide_id SLide ID
* @return string
*/
public function slide_is_unassigned_or_image_slide($slider_id, $slide_id)
{
$type = get_post_meta($slide_id, 'ml-slider_type', true);
return ! strlen($type) || $type == 'image';
}
/**
* Build image HTML
*
* @param array $attributes Anchor attributes
* @return string image HTML
*/
public function build_image_tag($attributes)
{
$attachment_id = $this->get_attachment_id();
if (('disabled' == $this->settings['smartCrop'] || 'disabled_pad' == $this->settings['smartCrop']) && ('image' == $this->identifier || 'html_overlay' == $this->identifier)) {
// This will use WP built in image building so we can remove some of these attributes
unset($attributes['src']);
unset($attributes['height']);
unset($attributes['width']);
return wp_get_attachment_image($attachment_id, apply_filters('metaslider_default_size', 'full', $this->slider), false, $attributes);
}
$html = "<img";
foreach ($attributes as $att => $val) {
if (strlen($val)) {
$html .= " " . $att . '="' . esc_attr($val) . '"';
} else if ($att == 'alt') {
$html .= " " . $att . '=""'; // always include alt tag for HTML5 validation
}
}
$html .= " />";
return $html;
}
/**
* Build image HTML
*
* @param array $attributes Anchor attributes
* @param string $content Anchor contents
* @return string image HTML
*/
public function build_anchor_tag($attributes, $content)
{
$html = "<a";
foreach ($attributes as $att => $val) {
if (strlen($val)) {
$html .= " " . $att . '="' . esc_attr($val) . '"';
}
}
$html .= ">" . $content . "</a>";
return $html;
}
/**
* Create a new post for a slide. Tag a featured image to it.
*
* @since 3.4
* @param string $media_id - Media File ID to use for the slide
* @param string $type - the slide type identifier
* @param int $slider_id - the parent slideshow ID
* @return int $slide_id - the ID of the newly created slide
*/
public function insert_slide($media_id, $type, $slider_id)
{
// Store the post in the database (without translation)
$slide_id = wp_insert_post(
array(
'post_title' => "Slider {$slider_id} - {$type}",
'post_status' => 'publish',
'post_type' => 'ml-slide'
)
);
// Send back a friendlier error message
if (is_wp_error($slide_id)) {
return new WP_Error('create_failed', __('There was an error while updating the database. Please try again.', 'ml-slider'), array('status' => 409));
}
// Set the image to the slide
set_post_thumbnail($slide_id, $media_id);
$this->add_or_update_or_delete_meta($slide_id, 'type', $type);
return $slide_id;
}
/**
* Tag the slide attachment to the slider tax category
*/
public function tag_slide_to_slider()
{
$termExists = function_exists('wpcom_vip_term_exists') ?
wpcom_vip_term_exists($this->slider->ID, 'ml-slider')
: term_exists($this->slider->ID, 'ml-slider'); // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.term_exists_term_exists
if (! $termExists) {
// create the taxonomy term, the term is the ID of the slider itself
wp_insert_term($this->slider->ID, 'ml-slider');
}
// get the term thats name is the same as the ID of the slider
$term = get_term_by('name', $this->slider->ID, 'ml-slider');
// tag this slide to the taxonomy term
wp_set_post_terms($this->slide->ID, $term->term_id, 'ml-slider', true);
$this->update_menu_order();
}
/**
* Ouput the slide tabs
*/
public function get_admin_slide_tabs_html()
{
return $this->get_admin_slide_tab_titles_html() . $this->get_admin_slide_tab_contents_html();
}
/**
* Generate the HTML for the tabs
*/
public function get_admin_slide_tab_titles_html()
{
$tabs = apply_filters('metaslider_slide_tabs', $this->get_admin_tabs(), $this->slide, $this->slider, $this->settings);
$return = "<ul class='tabs'>";
foreach ($tabs as $id => $tab) {
$pos = array_search($id, array_keys($tabs));
if ($tab['title'] == 'Mobile') {
$add_class = 'flex-setting';
if($this->settings['type'] != 'flex') {
$hide = 'display: none';
} else {
$hide = '';
}
} else {
$add_class = '';
$hide = '';
}
$selected = $pos == 0 ? "class='selected " . esc_attr($add_class) . "' style='" . esc_attr($hide) . "'" : "class='" . esc_attr($add_class) . "' style='" . esc_attr($hide) . "'";
$return .= "<li {$selected} ><a tabindex='0' href='#' data-tab_id='tab-" . esc_attr($pos) . "'>" . esc_html($tab['title']) . "</a></li>";
}
$return .= "</ul>";
return $return;
}
/**
* Generate the HTML for the delete button
*
* @return string
*/
public function get_delete_button_html()
{
return "<button class='toolbar-button delete-slide alignright tipsy-tooltip-top' title='" . esc_attr__("Trash slide", "ml-slider") . "' data-slide-id='" . esc_attr($this->slide->ID) . "'><i><svg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-x'><line x1='18' y1='6' x2='6' y2='18'/><line x1='6' y1='6' x2='18' y2='18'/></svg></i></button>";
}
/**
* Generate the HTML for the undelete button
*
* @return string
*/
public function get_undelete_button_html()
{
return "<a href='#' onclick='return false;' class='trash-view-restore' data-slide-id='" . esc_attr($this->slide->ID) . "'>" . esc_html__('Restore', 'ml-slider') . "</a>";
}
/**
* Generate the HTML for the perminant button
*
* @return string
*/
public function get_permanent_delete_button_html()
{
return "<a href='#' onclick='return false;' class='trash-view-permanent' data-slide-id='" . esc_attr($this->slide->ID) . "'>" . esc_html__('Delete Permanently', 'ml-slider') . "</a>";
}
/**
* Generates the HTML for the update slide image button
*
* @return string The html for the edit button on a slide image
*/
public function get_update_image_button_html()
{
$attachment_id = $this->get_attachment_id();
$slide_type = get_post_meta($this->slide->ID, 'ml-slider_type', true);
return "<button class='toolbar-button update-image alignright tipsy-tooltip-top' data-slide-type='" . esc_attr($slide_type) . "' data-button-text='" . esc_attr__("Update slide image", "ml-slider") . "' title='" . esc_attr__("Update slide image", "ml-slider") . "' data-slide-id='" . esc_attr($this->slide->ID) . "' data-attachment-id='" . esc_attr($attachment_id) . "'><i><svg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-edit-2'><polygon points='16 3 21 8 8 21 3 21 3 16 16 3'/></svg></i></button>";
}
/**
* Generate the HTML for the tab content
*/
public function get_admin_slide_tab_contents_html()
{
$tabs = apply_filters('metaslider_slide_tabs', $this->get_admin_tabs(), $this->slide, $this->slider, $this->settings);
$return = "<div class='tabs-content flex-grow'>";
foreach ($tabs as $id => $tab) {
$pos = array_search($id, array_keys($tabs));
$hidden = $pos != 0 ? "style='display: none;'" : "";
$return .= "<div class='h-full tab tab-{$pos}' {$hidden}>{$tab['content']}</div>";
}
$return .= "</div>";
return $return;
}
/**
* Ensure slides are added to the slideshow in the correct order.
*
* Find the highest slide menu_order in the slideshow, increment, then
* update the new slides menu_order.
*/
public function update_menu_order()
{
$menu_order = 0;
// get the slide with the highest menu_order so far
$args = array(
'force_no_custom_order' => true,
'orderby' => 'menu_order',
'order' => 'DESC',
'post_type' => array('attachment', 'ml-slide'),
'post_status' => array('inherit', 'publish'),
'lang' => '', // polylang, ingore language filter
'suppress_filters' => 1, // wpml, ignore language filter
'posts_per_page' => 1,
'tax_query' => array(
array(
'taxonomy' => 'ml-slider',
'field' => 'slug',
'terms' => $this->slider->ID
)
)
);
$query = new WP_Query($args);
while ($query->have_posts()) {
$query->next_post();
$menu_order = $query->post->menu_order;
}
wp_reset_query();
// increment
$menu_order = $menu_order + 1;
// update the slide
wp_update_post(array(
'ID' => $this->slide->ID,
'menu_order' => $menu_order
));
}
/**
* If the meta doesn't exist, add it
* If the meta exists, but the value is empty, delete it
* If the meta exists, update it
*
* @param int $post_id Post ID
* @param string $name SLider Name
* @param int $value Slaider Value
*/
public function add_or_update_or_delete_meta($post_id, $name, $value)
{
$key = "ml-slider_" . $name;
if (is_string($value)) {
$value = trim($value);
}
if (false === $value || $value === 'false' || $value === "off" || $value === '') {
delete_post_meta($post_id, $key);
} else {
update_post_meta($post_id, $key, $value);
}
}
/**
* Detect a [metaslider] or [ml-slider] shortcode in the slide caption, which has an ID that matches the current slideshow ID
*
* @param string $content Content for shortcode
* @return boolean
*/
protected function detect_self_metaslider_shortcode($content)
{
$pattern = get_shortcode_regex();
if (preg_match_all('/' . $pattern . '/s', $content, $matches) && array_key_exists(2, $matches) && ( in_array('metaslider', $matches[2]) || in_array('ml-slider', $matches[2]) )) {
// caption contains [metaslider] shortcode
if (array_key_exists(3, $matches) && array_key_exists(0, $matches[3])) {
// [metaslider] shortcode has attributes
$attributes = shortcode_parse_atts($matches[3][0]);
if (isset($attributes['id']) && $attributes['id'] == $this->slider->ID) {
// shortcode has ID attribute that matches the current slideshow ID
return true;
}
}
}
return false;
}
/**
* Get the attachment ID
*
* @return Integer - the attachment ID
*/
public function get_attachment_id()
{
if ('attachment' == $this->slide->post_type) {
return $this->slide->ID;
} else {
return get_post_thumbnail_id($this->slide->ID);
}
}
/**
* Get the thumbnail for the slide
* Use get_intermediate_image_src() instead when possible - since @3.60
*
* @return string
*/
public function get_thumb()
{
if (get_post_type($this->slide->ID) == 'attachment') {
$image = wp_get_attachment_image_src($this->slide->ID, 'thumbnail');
} else {
$image = wp_get_attachment_image_src(get_post_thumbnail_id($this->slide->ID), 'thumbnail');
}
if (isset($image[0])) {
return $image[0];
}
return "";
}
/**
* Get the closest image based on a width size
*
* @since 3.60
*
* @param int $width Image width we want to target
* @param int $attachment_id Optional image ID. We use in ajax_update_slide_image()
*
* @return string
*/
public function get_intermediate_image_src( $width, $attachment_id = false )
{
/* If the post type is 'attachment', we return get_thumb()
* for possible backward compatibility */
if ( get_post_type( $this->slide->ID ) == 'attachment' ) {
return $this->get_thumb();
}
if ( ! $attachment_id ) {
$attachment_id = get_post_thumbnail_id( $this->slide->ID );
}
$image_sizes = wp_get_attachment_image_src( $attachment_id, 'full' );
if ( is_array( $image_sizes ) && count( $image_sizes ) ) {
$original_width = $image_sizes[1]; // Image width value from array
// Find the closest image size to $width in width
$sizes = get_intermediate_image_sizes(); // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.get_intermediate_image_sizes_get_intermediate_image_sizes
// Default if no smaller size is found
$closest_size = 'full';
foreach ( $sizes as $size ) {
$size_info = image_get_intermediate_size( $attachment_id, $size );
if ( isset( $size_info['width'] )
&& $size_info['width'] >= $width
&& $size_info['width'] < $original_width
) {
$closest_size = $size;
break;
}
}
// Get the URL of the closest image size.
$closest_image = wp_get_attachment_image_src( $attachment_id, $closest_size );
// $closest_image[0] URL
// $closest_image[1] width
// $closest_image[2] height
// $closest_image[3] boolean for: is the image cropped?
if ( is_array( $closest_image ) ) {
$image_ = is_ssl() ? set_url_scheme( $closest_image[0], 'https' ) : set_url_scheme( $closest_image[0], 'http' );
return $image_;
}
}
return '';
}
/**
* Slide thumb image HTML in admin
*
* @since 3.60
*
* @return html
*/
public function get_admin_slide_thumb()
{
$thumb_small = $this->get_intermediate_image_src( 240 );
$thumb_medium = $this->get_intermediate_image_src( 768 );
$thumb_large = $this->get_intermediate_image_src( 1024 );
$slide_type = get_post_meta( $this->slide->ID, 'ml-slider_type', true );
$attachment_id = $this->get_attachment_id();
$html = '<div class="metaslider-ui-inner metaslider-slide-thumb">
<button class="update-image image-button" data-slide-type="' .
esc_attr( $slide_type ) . '" data-button-text="' .
esc_attr__( 'Update slide image', 'ml-slider' ) . '" title="' .
esc_attr__( 'Update slide image', 'ml-slider' ) . '" data-slide-id="' .
esc_attr( $this->slide->ID ) . '" data-attachment-id="' .
esc_attr( $attachment_id ) . '">
<div class="thumb">
<img style="display:none" src="' .
esc_url( $thumb_small ) . '" srcset="' .
esc_url( $thumb_large ) . ' 1024w, ' .
esc_url( $thumb_medium ) . ' 768w, ' .
esc_url( $thumb_small ) . ' 240w" sizes="(min-width: 990px) and (max-width: 1024px) 1024px, (max-width: 768px) 768px, 240px" />
</div>
</button>
</div>';
return $html;
}
/**
* HTML output for switch toggle
*
* @since 3.60
*
* @param string $name Valid input name
* @param bool $isChecked true or false
* @param array $attrs Optional array of attributes. e.g. array( 'lorem' => 'value' )
* @param string $class Optional CSS classes for the wrapper
*
* @return html
*/
public function switch_button( $name, $isChecked, $attrs = array(), $class = '' )
{
$html = '<div class="ms-switch-button' .
esc_attr( ! empty( $class ) ? ' ' . $class : '' ) . '">
<label><input type="checkbox" name="' .
esc_attr( $name ) . '"' .
( $isChecked ? ' checked="checked"' : '' );
// Append $attrs as valid HTML attributes
foreach( $attrs as $item => $value ) {
$html .= ' ' . esc_attr( $item ) . '="' . esc_attr( $value ) . '"';
}
$html .= ' /><span></span>
</label>
</div>';
return $html;
}
/**
* Info icon with tooltip
*
* @since 3.60
*
* @return html
*/
public function info_tooltip( $label )
{
$html = '<span class="dashicons dashicons-info tipsy-tooltip-top" title="' .
esc_attr( $label ) . '"></span>';
return $html;
}
/**
* Include slider assets, JS and CSS paths are specified by child classes.
*/
public function enqueue_scripts()
{
if (filter_var($this->get_setting('printJs'), FILTER_VALIDATE_BOOLEAN)) {
$handle = 'metaslider-' . $this->get_setting('type') . '-slider';
wp_enqueue_script($handle, METASLIDER_ASSETS_URL . $this->js_path, array('jquery'), METASLIDER_ASSETS_VERSION);
$this->wp_add_inline_script($handle, $this->get_inline_javascript());
}
if (filter_var($this->get_setting('printCss'), FILTER_VALIDATE_BOOLEAN)) {
wp_enqueue_style('metaslider-' . $this->get_setting('type') . '-slider', METASLIDER_ASSETS_URL . $this->css_path, false, METASLIDER_ASSETS_VERSION);
wp_enqueue_style('metaslider-public', METASLIDER_ASSETS_URL . 'metaslider/public.css', false, METASLIDER_ASSETS_VERSION);
$extra_css = apply_filters("metaslider_css", "", $this->settings, $this->id);
wp_add_inline_style('metaslider-public', $extra_css);
}
wp_enqueue_script('metaslider-script', METASLIDER_ASSETS_URL . 'metaslider/script.min.js', array('jquery'), METASLIDER_ASSETS_VERSION);
do_action('metaslider_register_public_styles');
}
public function get_global_settings() {
if (is_multisite() && $settings = get_site_option('metaslider_global_settings')) {
return $settings;
}
if ($settings = get_option('metaslider_global_settings')) {
return $settings;
}
}
}