Ends
9 years ago
Plugins
9 years ago
Providers
9 years ago
AutoLoader.php
9 years ago
Core.php
9 years ago
Disabler.php
9 years ago
Loader.php
9 years ago
Shortcode.php
9 years ago
Updater.php
9 years ago
index.html
9 years ago
Shortcode.php
495 lines
| 1 | <?php |
| 2 | namespace EmbedPress; |
| 3 | |
| 4 | use \EmbedPress\Core; |
| 5 | use \Embera\Embera; |
| 6 | use \Embera\Formatter; |
| 7 | |
| 8 | (defined('ABSPATH') && defined('EMBEDPRESS_IS_LOADED')) or die("No direct script access allowed."); |
| 9 | |
| 10 | /** |
| 11 | * Entity responsible to handle the plugin's shortcode events and behaviors. |
| 12 | * |
| 13 | * @package EmbedPress |
| 14 | * @author PressShack <help@pressshack.com> |
| 15 | * @copyright Copyright (C) 2016 Open Source Training, LLC. All rights reserved. |
| 16 | * @license GPLv2 or later |
| 17 | * @since 1.0.0 |
| 18 | */ |
| 19 | class Shortcode |
| 20 | { |
| 21 | /** |
| 22 | * The WP_oEmbed class instance. |
| 23 | * |
| 24 | * @since 1.0.0 |
| 25 | * @access private |
| 26 | * @static |
| 27 | * |
| 28 | * @var string $oEmbedInstance |
| 29 | */ |
| 30 | private static $oEmbedInstance = null; |
| 31 | |
| 32 | /** |
| 33 | * Register the plugin's shortcode into WordPress. |
| 34 | * |
| 35 | * @since 1.0.0 |
| 36 | * @static |
| 37 | * |
| 38 | * @return void |
| 39 | */ |
| 40 | public static function register() |
| 41 | { |
| 42 | // Register the new shortcode for embeds. |
| 43 | add_shortcode(EMBEDPRESS_SHORTCODE, array('\\EmbedPress\\Shortcode', 'do_shortcode'), 1); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Method that converts the plugin shortcoded-string into its complex content. |
| 48 | * |
| 49 | * @since 1.0.0 |
| 50 | * @static |
| 51 | * |
| 52 | * @param array $attributes Array of attributes |
| 53 | * @param string $subject The given string |
| 54 | * @return string |
| 55 | */ |
| 56 | public static function do_shortcode($attributes = array(), $subject = null) |
| 57 | { |
| 58 | $embed = self::parseContent($subject, true, $attributes); |
| 59 | |
| 60 | return is_object($embed) ? $embed->embed : $embed; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Replace a given content with its embeded HTML code. |
| 65 | * |
| 66 | * @since 1.0.0 |
| 67 | * @static |
| 68 | * |
| 69 | * @param string The raw content that will be replaced. |
| 70 | * @param boolean Optional. If true, new lines at the end of the embeded code are stripped. |
| 71 | * @return string |
| 72 | */ |
| 73 | public static function parseContent($subject, $stripNewLine = false, $customAttributes = array()) |
| 74 | { |
| 75 | if (!empty($subject)) { |
| 76 | if (empty($customAttributes)) { |
| 77 | $customAttributes = self::parseContentAttributesFromString($subject); |
| 78 | } |
| 79 | |
| 80 | $content = preg_replace('/(\['. EMBEDPRESS_SHORTCODE .'(?:\]|.+?\])|\[\/'. EMBEDPRESS_SHORTCODE .'\])/i', "", $subject); |
| 81 | |
| 82 | // Check if the WP_oEmbed class is loaded |
| 83 | if (!self::$oEmbedInstance) { |
| 84 | require_once ABSPATH .'wp-includes/class-oembed.php'; |
| 85 | |
| 86 | self::$oEmbedInstance = _wp_oembed_get_object(); |
| 87 | } |
| 88 | |
| 89 | $emberaInstanceSettings = array( |
| 90 | 'params' => array() |
| 91 | ); |
| 92 | |
| 93 | $attributes = self::parseContentAttributes($customAttributes); |
| 94 | if (isset($attributes['width']) || isset($attributes['height'])) { |
| 95 | if (isset($attributes['width'])) { |
| 96 | $emberaInstanceSettings['params']['width'] = $attributes['width']; |
| 97 | unset($attributes['width']); |
| 98 | } |
| 99 | |
| 100 | if (isset($attributes['height'])) { |
| 101 | $emberaInstanceSettings['params']['height'] = $attributes['height']; |
| 102 | unset($attributes['height']); |
| 103 | } |
| 104 | } |
| 105 | |
| 106 | // Identify what service provider the shortcode's link belongs to |
| 107 | $serviceProvider = self::$oEmbedInstance->get_provider($content); |
| 108 | // Check if OEmbed was unable to detect the url service provider. |
| 109 | if (empty($serviceProvider)) { |
| 110 | // Attempt to do the same using Embera. |
| 111 | $emberaInstance = new Embera($emberaInstanceSettings); |
| 112 | // Add support to the user's custom service providers |
| 113 | $additionalServiceProviders = Core::getAdditionalServiceProviders(); |
| 114 | if (!empty($additionalServiceProviders)) { |
| 115 | foreach ($additionalServiceProviders as $serviceProviderClassName => $serviceProviderUrls) { |
| 116 | self::addServiceProvider($serviceProviderClassName, $serviceProviderUrls, $emberaInstance); |
| 117 | } |
| 118 | |
| 119 | unset($serviceProviderUrls, $serviceProviderClassName); |
| 120 | } |
| 121 | |
| 122 | // Attempt to fetch more info about the url-embed. |
| 123 | $urlData = $emberaInstance->getUrlInfo($content); |
| 124 | } else { |
| 125 | // Attempt to fetch more info about the url-embed. |
| 126 | $urlData = self::$oEmbedInstance->fetch($serviceProvider, $content, $attributes); |
| 127 | } |
| 128 | |
| 129 | $eventResults = apply_filters('embedpress:onBeforeEmbed', $urlData); |
| 130 | if (empty($eventResults)) { |
| 131 | // EmbedPress seems unable to embed the url. |
| 132 | return $subject; |
| 133 | } |
| 134 | |
| 135 | // Transform all shortcode attributes into html form. I.e.: {foo: "joe"} -> foo="joe" |
| 136 | $attributesHtml = array(); |
| 137 | foreach ($attributes as $attrName => $attrValue) { |
| 138 | $attributesHtml[] = $attrName .'="'. $attrValue .'"'; |
| 139 | } |
| 140 | |
| 141 | // Define the EmbedPress html template where the generated embed will be injected in |
| 142 | $embedTemplate = '<div '. implode(' ', $attributesHtml) .'>{html}</div>'; |
| 143 | |
| 144 | // Check if $content is a google shortened url and tries to extract from it which Google service it refers to. |
| 145 | if (preg_match('/http[s]?:\/\/goo\.gl\/(?:([a-z]+)\/)?[a-z0-9]+\/?$/i', $content, $matches)) { |
| 146 | // Fetch all headers from the short-url so we can know how to handle its original content depending on the service. |
| 147 | $headers = get_headers($content); |
| 148 | |
| 149 | $supportedServicesHeadersPatterns = array( |
| 150 | 'maps' => '/^Location:\s+(http[s]?:\/\/.+)$/i' |
| 151 | ); |
| 152 | |
| 153 | $service = isset($matches[1]) ? strtolower($matches[1]) : null; |
| 154 | // No specific service was found in the url. |
| 155 | if (empty($service)) { |
| 156 | // Let's try to guess which service the original url belongs to. |
| 157 | foreach ($headers as $header) { |
| 158 | // Check if the short-url reffers to a Google Maps url. |
| 159 | if (preg_match($supportedServicesHeadersPatterns['maps'], $header, $matches)) { |
| 160 | // Replace the shortened url with its original url. |
| 161 | $content = $matches[1]; |
| 162 | break; |
| 163 | } |
| 164 | } |
| 165 | unset($header); |
| 166 | } else { |
| 167 | // Check if the Google service is supported atm. |
| 168 | if (isset($supportedServicesHeadersPatterns[$service])) { |
| 169 | // Tries to extract the url based on its headers. |
| 170 | $originalUrl = self::extractContentFromHeaderAsArray($supportedServicesHeadersPatterns[$service], $headers); |
| 171 | // Replace the shortened url with its original url if the specific header was found. |
| 172 | if (!empty($originalUrl)) { |
| 173 | $content = $originalUrl; |
| 174 | } |
| 175 | unset($originalUrl); |
| 176 | } |
| 177 | } |
| 178 | unset($service, $supportedServicesHeadersPatterns, $headers, $matches); |
| 179 | } |
| 180 | |
| 181 | // Facebook is a special case. WordPress will try to embed them using OEmbed, but they always end up embedding the profile page, regardless |
| 182 | // if the url was pointing to a photo, a post, etc. So, since Embera can embed only facebook-media/posts, we'll use it only for that. |
| 183 | if (in_array($urlData->provider_name, array('Facebook'))) { |
| 184 | // Check if this is a Facebook profile url. |
| 185 | if (preg_match('/facebook\.com\/(?:[^\/]+?)\/?$/', $content, $match)) { |
| 186 | // Try to embed the url using WP's OSEmbed. |
| 187 | $parsedContent = self::$oEmbedInstance->get_html($content, $attributes); |
| 188 | } else { |
| 189 | // Try to embed the url using EmbedPress' Embera. |
| 190 | $parsedContent = false; |
| 191 | } |
| 192 | } else { |
| 193 | // Try to embed the url using WP's OSEmbed. |
| 194 | $parsedContent = self::$oEmbedInstance->get_html($content, $attributes); |
| 195 | } |
| 196 | |
| 197 | if (!$parsedContent) { |
| 198 | if (!isset($emberaInstance)) { |
| 199 | // If the embed couldn't be generated, we'll try to use Embera's API |
| 200 | $emberaInstance = new Embera($emberaInstanceSettings); |
| 201 | // Add support to the user's custom service providers |
| 202 | $additionalServiceProviders = Core::getAdditionalServiceProviders(); |
| 203 | if (!empty($additionalServiceProviders)) { |
| 204 | foreach ($additionalServiceProviders as $serviceProviderClassName => $serviceProviderUrls) { |
| 205 | self::addServiceProvider($serviceProviderClassName, $serviceProviderUrls, $emberaInstance); |
| 206 | } |
| 207 | |
| 208 | unset($serviceProviderUrls, $serviceProviderClassName); |
| 209 | } |
| 210 | } |
| 211 | |
| 212 | // Register the html template |
| 213 | $emberaFormaterInstance = new Formatter($emberaInstance, true); |
| 214 | $emberaFormaterInstance->setTemplate($embedTemplate); |
| 215 | |
| 216 | // Try to generate the embed using Embera API |
| 217 | $parsedContent = $emberaFormaterInstance->transform($content); |
| 218 | |
| 219 | unset($emberaFormaterInstance, $additionalServiceProviders, $emberaInstance); |
| 220 | } else { |
| 221 | // Inject the generated code inside the html template |
| 222 | $parsedContent = str_replace('{html}', $parsedContent, $embedTemplate); |
| 223 | |
| 224 | // Replace all single quotes to double quotes. I.e: foo='joe' -> foo="joe" |
| 225 | $parsedContent = str_replace("'", '"', $parsedContent); |
| 226 | |
| 227 | // Replace the flag `{provider_alias}` which is used by Embera with the "ose-<serviceProviderAlias>". I.e: YouTube -> "ose-youtube" |
| 228 | $parsedContent = preg_replace('/((?:ose-)?\{provider_alias\})/i', "ose-". strtolower($urlData->provider_name), $parsedContent); |
| 229 | } |
| 230 | |
| 231 | // NFB seems to always return their embed code with all HTML entities into their applicable characters string. |
| 232 | if (strtoupper($urlData->provider_name) === "NATIONAL FILM BOARD OF CANADA") { |
| 233 | $parsedContent = html_entity_decode($parsedContent); |
| 234 | } else if (strtoupper($urlData->provider_name) === "FACEBOOK") { |
| 235 | $plgSettings = Core::getSettings(); |
| 236 | |
| 237 | // Check if the user wants to force a certain language into Facebook embeds. |
| 238 | $locale = isset($plgSettings->fbLanguage) && !empty($plgSettings->fbLanguage) ? $plgSettings->fbLanguage : false; |
| 239 | if (!!$locale) { |
| 240 | // Replace the automatically detected language by Facebook's API with the language chosen by the user. |
| 241 | $parsedContent = preg_replace('/\/[a-z]{2}\_[a-z]{2}\/sdk\.js/i', "/{$locale}/sdk.js", $parsedContent); |
| 242 | } |
| 243 | |
| 244 | unset($locale, $plgSettings); |
| 245 | } |
| 246 | |
| 247 | unset($embedTemplate, $serviceProvider); |
| 248 | |
| 249 | // This assure that the iframe has the same dimensions the user wants to |
| 250 | if (isset($emberaInstanceSettings['params']['width']) || isset($emberaInstanceSettings['params']['height'])) { |
| 251 | if (isset($emberaInstanceSettings['params']['width']) && isset($emberaInstanceSettings['params']['height'])) { |
| 252 | $customWidth = (int)$emberaInstanceSettings['params']['width']; |
| 253 | $customHeight = (int)$emberaInstanceSettings['params']['height']; |
| 254 | } else { |
| 255 | preg_match_all('/\<iframe\s+width="(\d+)"\s+height="(\d+)"/i', $parsedContent, $matches); |
| 256 | $iframeWidth = (int)$matches[1][0]; |
| 257 | $iframeHeight = (int)$matches[2][0]; |
| 258 | $iframeRatio = ceil($iframeWidth / $iframeHeight); |
| 259 | |
| 260 | if (isset($emberaInstanceSettings['params']['width'])) { |
| 261 | $customWidth = (int)$emberaInstanceSettings['params']['width']; |
| 262 | $customHeight = ceil($customWidth / $iframeRatio); |
| 263 | } else { |
| 264 | $customHeight = (int)$emberaInstanceSettings['params']['height']; |
| 265 | $customWidth = $iframeRatio * $customHeight; |
| 266 | } |
| 267 | |
| 268 | unset($iframeRatio, $iframeHeight, $iframeWidth, $matches); |
| 269 | } |
| 270 | |
| 271 | $parsedContent = preg_replace('/\s+width\=\"(\d+)\"/i', ' width="'. $customWidth .'"', $parsedContent); |
| 272 | $parsedContent = preg_replace('/\s+height\=\"(\d+)\"/i', ' height="'. $customHeight .'"', $parsedContent); |
| 273 | } |
| 274 | |
| 275 | if ($stripNewLine) { |
| 276 | $parsedContent = preg_replace('/\n/', '', $parsedContent); |
| 277 | } |
| 278 | |
| 279 | if (!empty($parsedContent)) { |
| 280 | $embed = (object)array_merge((array)$urlData, array( |
| 281 | 'attributes' => (object)$attributes, |
| 282 | 'embed' => $parsedContent, |
| 283 | 'url' => $content |
| 284 | )); |
| 285 | |
| 286 | $embed = apply_filters('embedpress:onAfterEmbed', $embed); |
| 287 | |
| 288 | return $embed; |
| 289 | } |
| 290 | } |
| 291 | |
| 292 | return $subject; |
| 293 | } |
| 294 | |
| 295 | /** |
| 296 | * Method that adds support to a given new service provider (SP). |
| 297 | * |
| 298 | * @since 1.0.0 |
| 299 | * @static |
| 300 | * |
| 301 | * @param string $className The new SP class name. |
| 302 | * @param string $reference The new SP reference name. |
| 303 | * @param \Embera\Embera $emberaInstance The embera's instance where the SP will be registered in. |
| 304 | * @return boolean |
| 305 | */ |
| 306 | public static function addServiceProvider($className, $reference, &$emberaInstance) |
| 307 | { |
| 308 | if (empty($className) || empty($reference)) { |
| 309 | return false; |
| 310 | } |
| 311 | |
| 312 | if (is_string($reference)) { |
| 313 | $emberaInstance->addProvider($reference, EMBEDPRESS_NAMESPACE ."\\Providers\\{$className}"); |
| 314 | } else if (is_array($reference)) { |
| 315 | foreach ($reference as $serviceProviderUrl) { |
| 316 | self::addServiceProvider($className, $serviceProviderUrl, $emberaInstance); |
| 317 | } |
| 318 | } else { |
| 319 | return false; |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | /** |
| 324 | * Method that retrieves all custom parameters from a shortcoded string. |
| 325 | * |
| 326 | * @since 1.0.0 |
| 327 | * @static |
| 328 | * |
| 329 | * @param string $subject The given shortcoded string. |
| 330 | * @return array |
| 331 | */ |
| 332 | public static function parseContentAttributesFromString($subject) |
| 333 | { |
| 334 | $customAttributes = array(); |
| 335 | if (preg_match('/\[embed\s*(.*?)\]/i', stripslashes($subject), $m)) { |
| 336 | if (preg_match_all('/(\!?\w+-?\w*)(?:="(.+?)")?/i', stripslashes($m[1]), $matches)) { |
| 337 | $attributes = $matches[1]; |
| 338 | $attrValues = $matches[2]; |
| 339 | |
| 340 | foreach ($attributes as $attrIndex => $attrName) { |
| 341 | $customAttributes[$attrName] = $attrValues[$attrIndex]; |
| 342 | } |
| 343 | } |
| 344 | } |
| 345 | |
| 346 | return $customAttributes; |
| 347 | } |
| 348 | |
| 349 | /** |
| 350 | * Method that parses and adds the "data-" prefix to the given custom shortcode attributes. |
| 351 | * |
| 352 | * @since 1.0.0 |
| 353 | * @access private |
| 354 | * @static |
| 355 | * |
| 356 | * @param array $attributes The array containing the embed attributes. |
| 357 | * @return array |
| 358 | */ |
| 359 | private static function parseContentAttributes(array $customAttributes) |
| 360 | { |
| 361 | $attributes = array( |
| 362 | 'class' => array("embedpress-wrapper") |
| 363 | ); |
| 364 | |
| 365 | $embedShouldBeResponsive = true; |
| 366 | $embedShouldHaveCustomDimensions = false; |
| 367 | if (!empty($customAttributes)) { |
| 368 | if (isset($customAttributes['class'])) { |
| 369 | if (!empty($customAttributes['class'])) { |
| 370 | $customAttributes['class'] = explode(' ', $customAttributes['class']); |
| 371 | |
| 372 | $attributes['class'] = array_merge($attributes['class'], $customAttributes['class']); |
| 373 | } |
| 374 | |
| 375 | unset($customAttributes['class']); |
| 376 | } |
| 377 | |
| 378 | if (isset($customAttributes['width'])) { |
| 379 | if (!empty($customAttributes['width'])) { |
| 380 | $attributes['width'] = (int)$customAttributes['width']; |
| 381 | $embedShouldHaveCustomDimensions = true; |
| 382 | } |
| 383 | } |
| 384 | |
| 385 | if (isset($customAttributes['height'])) { |
| 386 | if (!empty($customAttributes['height'])) { |
| 387 | $attributes['height'] = (int)$customAttributes['height']; |
| 388 | $embedShouldHaveCustomDimensions = true; |
| 389 | } |
| 390 | } |
| 391 | |
| 392 | if (!empty($customAttributes)) { |
| 393 | $attrNameDefaultPrefix = "data-"; |
| 394 | foreach ($customAttributes as $attrName => $attrValue) { |
| 395 | if (is_numeric($attrName)) { |
| 396 | $attrName = $attrValue; |
| 397 | $attrValue = ""; |
| 398 | } |
| 399 | |
| 400 | $attrName = str_replace($attrNameDefaultPrefix, "", $attrName); |
| 401 | |
| 402 | if (!strlen($attrValue)) { |
| 403 | if ($attrName[0] === "!") { |
| 404 | $attrValue = "false"; |
| 405 | $attrName = substr($attrName, 1); |
| 406 | } else { |
| 407 | $attrValue = "true"; |
| 408 | } |
| 409 | } |
| 410 | |
| 411 | $attributes[$attrNameDefaultPrefix . $attrName] = $attrValue; |
| 412 | } |
| 413 | } |
| 414 | |
| 415 | // Check if there's any "responsive" parameter |
| 416 | $responsiveAttributes = array("responsive", "data-responsive"); |
| 417 | foreach ($responsiveAttributes as $responsiveAttr) { |
| 418 | if (isset($attributes[$responsiveAttr])) { |
| 419 | if (!strlen($attributes[$responsiveAttr])) { // If the parameter is passed but have no value, it will be true by default |
| 420 | $embedShouldBeResponsive = true; |
| 421 | } else { |
| 422 | $embedShouldBeResponsive = !self::valueIsFalse($attributes[$responsiveAttr]); |
| 423 | } |
| 424 | |
| 425 | break; |
| 426 | } |
| 427 | } |
| 428 | unset($responsiveAttr, $responsiveAttributes); |
| 429 | } |
| 430 | |
| 431 | if ($embedShouldBeResponsive && !$embedShouldHaveCustomDimensions) { |
| 432 | $attributes['class'][] = 'ose-{provider_alias} responsive'; |
| 433 | } else { |
| 434 | $attributes['data-responsive'] = "false"; |
| 435 | } |
| 436 | |
| 437 | $attributes['class'] = implode(' ', array_unique(array_filter($attributes['class']))); |
| 438 | |
| 439 | return $attributes; |
| 440 | } |
| 441 | |
| 442 | /** |
| 443 | * Method that checks if a given value is/can be identified as (bool)false. |
| 444 | * |
| 445 | * @since 1.0.0 |
| 446 | * @static |
| 447 | * |
| 448 | * @param mixed $subject The value to be checked. |
| 449 | * @return boolean |
| 450 | */ |
| 451 | public static function valueIsFalse($subject) |
| 452 | { |
| 453 | $subject = strtolower(trim((string)$subject)); |
| 454 | switch ($subject) { |
| 455 | case "0": |
| 456 | case "false": |
| 457 | case "off": |
| 458 | case "no": |
| 459 | case "n": |
| 460 | case "nil": |
| 461 | case "null": |
| 462 | return true; |
| 463 | default: |
| 464 | return false; |
| 465 | } |
| 466 | } |
| 467 | |
| 468 | /** |
| 469 | * Return the value from a header which is in an array resulted from a get_headers() call. |
| 470 | * If the header cannot be found, this method will return null instead. |
| 471 | * |
| 472 | * @since 1.1.0 |
| 473 | * @access private |
| 474 | * @static |
| 475 | * |
| 476 | * @param string $headerPattern Regex pattern the header and its value must match. |
| 477 | * @param array $headersList A list of headers resulted from a get_headers() call. |
| 478 | * |
| 479 | * @return mixed |
| 480 | */ |
| 481 | private static function extractContentFromHeaderAsArray($headerPattern, $headersList) |
| 482 | { |
| 483 | $headerValue = null; |
| 484 | |
| 485 | foreach ($headersList as $header) { |
| 486 | if (preg_match($headerPattern, $header, $matches)) { |
| 487 | $headerValue = $matches[1]; |
| 488 | break; |
| 489 | } |
| 490 | } |
| 491 | |
| 492 | return $headerValue; |
| 493 | } |
| 494 | } |
| 495 |