<?php if ( ! defined( 'ABSPATH' ) ) exit; /** * Responsive Lightbox Remote Library Flickr class. * * Library: https://www.flickr.com * API: https://www.flickr.com/services/developer/api/ * * @class Responsive_Lightbox_Remote_Library_Flickr */ class Responsive_Lightbox_Remote_Library_Flickr extends Responsive_Lightbox_Remote_Library_API { protected $allowed_hosts = [ 'staticflickr.com' ]; protected $allowed_formats = [ 'bmp' => 'image/bmp', 'gif' => 'image/gif', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'png' => 'image/png', 'tif' => 'image/tiff', 'tiff' => 'image/tiff' ]; /** * Class constructor. * * @return void */ public function __construct() { // provider slug $this->slug = 'flickr'; // provider name $this->name = __( 'Flickr', 'responsive-lightbox' ); // default values $this->defaults = [ 'active' => false, 'api_key' => '' ]; // setting fields $this->fields = [ 'title' => $this->name, 'section' => 'responsive_lightbox_remote_library_providers', 'type' => 'custom', 'callback' => [ $this, 'render_field' ] ]; // add provider parent::add_provider( $this ); } /** * Render field. * * @return string */ public function render_field() { return ' <p><label><input id="rl_flickr_active" class="rl-media-provider-expandable" type="checkbox" name="responsive_lightbox_remote_library[flickr][active]" value="1" ' . checked( $this->rl->options['remote_library']['flickr']['active'], true, false ) . ' />' . esc_html__( 'Enable Flickr.', 'responsive-lightbox' ) . '</label></p> <div class="rl-media-provider-options"' . ( $this->rl->options['remote_library']['flickr']['active'] ? '' : ' style="display: none;"' ) . '> <p><input id="rl_flickr_api_key" class="large-text" placeholder="' . esc_attr__( 'API key', 'responsive-lightbox' ) . '" type="text" value="' . esc_attr( $this->rl->options['remote_library']['flickr']['api_key'] ) . '" name="responsive_lightbox_remote_library[flickr][api_key]"></p> <p class="description">' . sprintf( esc_html__( 'Provide your %s key.', 'responsive-lightbox' ), '<a href="https://www.flickr.com/services/apps/create/">Flickr API</a>' ) . '</p> </div>'; } /** * Validate settings. * * @param array $input POST data * @return array */ public function validate_settings( $input ) { if ( ! isset( $_POST['responsive_lightbox_remote_library'] ) ) $input['flickr'] = $this->rl->defaults['remote_library']['flickr']; else { // active $input['flickr']['active'] = isset( $_POST['responsive_lightbox_remote_library']['flickr']['active'] ); // api key if ( ! empty( $_POST['responsive_lightbox_remote_library']['flickr']['api_key'] ) && is_string( $_POST['responsive_lightbox_remote_library']['flickr']['api_key'] ) ) $input['flickr']['api_key'] = preg_replace( '/[^0-9a-zA-Z\-.]/', '', $_POST['responsive_lightbox_remote_library']['flickr']['api_key'] ); else $input['flickr']['api_key'] = ''; } return $input; } /** * Prepare data to run remote query. * * @param string $search_phrase Search phrase * @param array $args Provider arguments * @return void */ public function prepare_query( $search_phrase, $args = [] ) { // check page parameter if ( isset( $args['preview_page'] ) ) $args['preview_page'] = (int) $args['preview_page']; else $args['preview_page'] = 1; if ( $args['preview_page'] < 1 ) $args['preview_page'] = 1; // check limit if ( isset( $args['limit'] ) && ( $limit = (int) $args['limit'] ) > 0 ) $args['preview_per_page'] = $limit; else { // check per page parameter if ( isset( $args['preview_per_page'] ) ) $args['preview_per_page'] = (int) $args['preview_per_page']; else $args['preview_per_page'] = 20; if ( $args['preview_per_page'] < 5 || $args['preview_per_page'] > 500 ) $args['preview_per_page'] = 20; } // set query arguments $this->query_args = $args; $query_args = [ 'api_key' => $this->rl->options['remote_library']['flickr']['api_key'], 'extras' => 'owner_name,url_sq,url_t,url_s,url_q,url_m,url_n,url_z,url_c,url_l,url_o,description,tags', 'per_page' => $args['preview_per_page'], 'page' => $args['preview_page'], 'method' => 'flickr.photos.getRecent', 'format' => 'json' ]; if ( $search_phrase !== '' ) { $query_args['content_type'] = 1; $query_args['method'] = 'flickr.photos.search'; $query_args['text'] = urlencode( $search_phrase ); $query_args['sort'] = 'date-posted-desc'; } // set query string $this->query = add_query_arg( $query_args, 'https://api.flickr.com/services/rest/' ); // set query remote arguments $this->query_remote_args = [ 'timeout' => 30, 'headers' => [ 'User-Agent' => __( 'Responsive Lightbox', 'responsive-lightbox' ) . ' ' . $this->rl->defaults['version'] ] ]; } /** * Get images from media provider. * * @param mixed $response Remote response * @param array $args Query arguments * @return array|WP_Error */ public function get_query_results( $response, $args = [] ) { $results = []; $error = new WP_Error( 'rl_remote_library_flickr_get_query_results', __( 'Parsing request error', 'responsive-lightbox' ) ); // retrieve body $response_body = wp_remote_retrieve_body( $response ); // check for flickr string if ( strpos( $response_body, 'jsonFlickrApi(' ) === 0 ) $response_body = substr( $response_body, 14, -1 ); // any data? if ( $response_body !== '' ) { $response_json = json_decode( $response_body, true ); // invalid data? if ( $response_json === null || ( isset( $response_json['stat'] ) && $response_json['stat'] === 'fail' ) ) $results = $error; else { // set response data $this->response_data = $response_json; // get results $results = isset( $response_json['photos'] ) && is_array( $response_json['photos'] ) && isset( $response_json['photos']['photo'] ) && is_array( $response_json['photos']['photo'] ) ? $response_json['photos']['photo'] : []; // sanitize images $results = $this->sanitize_results( $results ); } } else $results = $error; return $results; } /** * Sanitize single result. * * @param array $result Single result * @return array|false */ public function sanitize_result( $result ) { // original size exists? if ( isset( $result['url_o'] ) ) $large = [ $result['url_o'], $result['width_o'], $result['height_o'] ]; // large 2048 size exists? elseif ( isset( $result['url_k'] ) ) $large = [ $result['url_k'], $result['width_k'], $result['height_k'] ]; // large 1600 size exists? elseif ( isset( $result['url_h'] ) ) $large = [ $result['url_h'], $result['width_h'], $result['height_h'] ]; // large 1024 size exists? elseif ( isset( $result['url_l'] ) ) $large = [ $result['url_l'], $result['width_l'], $result['height_l'] ]; // medium 800 size exists? elseif ( isset( $result['url_c'] ) ) $large = [ $result['url_c'], $result['width_c'], $result['height_c'] ]; // medium 640 size exists? elseif ( isset( $result['url_z'] ) ) $large = [ $result['url_z'], $result['width_z'], $result['height_z'] ]; // medium 500 size exists? elseif ( isset( $result['url_m'] ) ) $large = [ $result['url_m'], $result['width_m'], $result['height_m'] ]; // small 320 size exists? elseif ( isset( $result['url_n'] ) ) $large = [ $result['url_n'], $result['width_n'], $result['height_n'] ]; // small 240 size exists? elseif ( isset( $result['url_s'] ) ) $large = [ $result['url_s'], $result['width_s'], $result['height_s'] ]; // thumbnail size exists? elseif ( isset( $result['url_t'] ) ) $large = [ $result['url_t'], $result['width_t'], $result['height_t'] ]; // skip this photo else return false; // large square size exists? if ( isset( $result['url_q'] ) ) $small = [ $result['url_q'], $result['width_q'], $result['height_q'] ]; // medium 500 size exists? elseif ( isset( $result['url_m'] ) ) $small = [ $result['url_m'], $result['width_m'], $result['height_m'] ]; // small 320 size exists? elseif ( isset( $result['url_n'] ) ) $small = [ $result['url_n'], $result['width_n'], $result['height_n'] ]; // small 240 size exists? elseif ( isset( $result['url_s'] ) ) $small = [ $result['url_s'], $result['width_s'], $result['height_s'] ]; // skip this photo else return false; $source = 'https://www.flickr.com/photos/' . $result['owner'] . '/' . $result['id']; $imagedata = [ 'id' => 0, 'link' => '', 'source' => esc_url_raw( $source ), 'title' => sanitize_text_field( $result['title'] ), 'caption' => $this->get_attribution( 'Flickr', $source, $result['ownername'], 'https://www.flickr.com/photos/' . $result['owner'] ), 'description' => ! empty( $result['description']['_content'] ) ? sanitize_text_field( $result['description']['_content'] ) : '', 'alt' => sanitize_text_field( $result['tags'] ), 'url' => esc_url_raw( $large[0] ), 'width' => (int) $large[1], 'height' => (int) $large[2], 'orientation' => (int) $large[2] > (int) $large[1] ? 'portrait' : 'landscape', 'thumbnail_url' => esc_url_raw( $small[0] ), 'thumbnail_width' => (int) $small[1], 'thumbnail_height' => (int) $small[2], 'thumbnail_orientation' => (int) $small[2] > (int) $small[1] ? 'portrait' : 'landscape', 'media_provider' => 'flickr', 'filename' => sanitize_file_name( basename( $large[0] ) ), 'dimensions' => (int) $large[1] . ' x ' . (int) $large[2], 'type' => 'image' ]; // create thumbnail link $imagedata['thumbnail_link'] = $this->rl->galleries->get_gallery_image_link( $imagedata, 'thumbnail' ); return $imagedata; } } new Responsive_Lightbox_Remote_Library_Flickr();