Oembed - Code Metrics - Inspection of "DOC: Add docs for template namespacing." - sminnee/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — namespace-template ( 7967f2...367a36 )

by Sam

created 2016-05-21 06:06 UTC

Oembed B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	202
Duplicated Lines	2.97 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	6
loc	202
rs	8.2769
c	1
b	0
f	0
wmc	41
lcom	1
cbo	6

10 Methods

Rating	Name	Duplication	Size	Complexity
A	is_enabled()	0	3	1
A	get_autodiscover()	0	3	1
A	get_providers()	0	3	1
B	find_endpoint()	0	15	6
C	matches_scheme()	0	23	7
B	autodiscover_from_url()	0	26	3
A	autodiscover_from_body()	0	17	4
C	get_oembed_from_url()	0	42	13
A	get_shortcodes()	0	3	1
A	handle_shortcode()	6	14	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Oembed often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Oembed, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Format of the Oembed config. Autodiscover allows discovery of all URLs.
 *
 * Endpoint set to true means autodiscovery for this specific provider is
 * allowed (even if autodiscovery in general has been disabled).
 *
 * <code>
 *
 * name: Oembed
 * ---
 * Oembed:
 *   providers:
 *     'http://*.youtube.com/watch*':
 *     'http://www.youtube.com/oembed/'
 *   autodiscover:
 *     true
 * </code>
 *
 * @package framework
 * @subpackage oembed
 */

class Oembed implements ShortcodeHandler {

	public static function is_enabled() {
		return Config::inst()->get('Oembed', 'enabled');
	}

	/**
	 * Gets the autodiscover setting from the config.
	 */
	public static function get_autodiscover() {
		return Config::inst()->get('Oembed', 'autodiscover');
	}

	/**
	 * Gets providers from config.
	 */
	public static function get_providers() {
		return Config::inst()->get('Oembed', 'providers');
	}

	/**
	 * Returns an endpoint (a base Oembed URL) from first matching provider.
	 *
	 * @param $url Human-readable URL.
	 * @returns string/bool URL of an endpoint, or false if no matching provider exists.
	 */
	protected static function find_endpoint($url) {
		foreach(self::get_providers() as $scheme=>$endpoint) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			if(self::matches_scheme($url, $scheme)) {
				$protocol = Director::is_https() ? 'https' : 'http';

				if (is_array($endpoint)) {
					if (array_key_exists($protocol, $endpoint)) $endpoint = $endpoint[$protocol];
					else $endpoint = reset($endpoint);
				}

				return $endpoint;
			}
		}
		return false;
	}

	/**
	 * Checks the URL if it matches against the scheme (pattern).
	 *
	 * @param $url Human-readable URL to be checked.
	 * @param $scheme Pattern to be matched against.
	 * @returns bool Whether the pattern matches or not.
	 */
	protected static function matches_scheme($url, $scheme) {
		$urlInfo = parse_url($url);
		$schemeInfo = parse_url($scheme);

		foreach($schemeInfo as $k=>$v) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			if(!array_key_exists($k, $urlInfo)) {
				return false;
			}
			if(strpos($v, '*') !== false) {
				$v = preg_quote($v, '/');
				$v = str_replace('\*', '.*', $v);
				if($k == 'host') {
					$v = str_replace('*\.', '*', $v);
				}
				if(!preg_match('/' . $v . '/', $urlInfo[$k])) {
					return false;
				}
			} elseif(strcasecmp($urlInfo[$k], $v)) {
				return false;
			}
		}
		return true;
	}

	/**
	 * Performs a HTTP request to the URL and scans the response for resource links
	 * that mention oembed in their type.
	 *
	 * @param $url Human readable URL.
	 * @returns string/bool Oembed URL, or false.
	 */
	protected static function autodiscover_from_url($url)
	{
		$timeout   = 5;
		$sapphireInfo = new SapphireInfo();
		$useragent = 'SilverStripe/' . $sapphireInfo->Version();
		$curlRequest = curl_init();
		curl_setopt_array(
			$curlRequest,
			array(
				CURLOPT_URL            => $url,
				CURLOPT_RETURNTRANSFER => 1,
				CURLOPT_USERAGENT      => $useragent,
				CURLOPT_CONNECTTIMEOUT => $timeout,
				CURLOPT_FOLLOWLOCATION => 1,

			)
		);

		$response = curl_exec($curlRequest);
		$headers = curl_getinfo($curlRequest);
		if(!$response || $headers['http_code'] !== 200) {
			return false;
		}
		$body = $response;		
		return static::autodiscover_from_body($body);
	}

	/**
	 * Given a response body, determine if there is an autodiscover url
	 *
	 * @param string $body
	 * @return bool|string
	 */
	public static function autodiscover_from_body($body) {
		// Look within the body for an oembed link.
		$pcreOmbed = '#<link[^>]+?(?:href=[\'"](?<first>[^\'"]+?)[\'"][^>]+?)'
			. '?type=["\']application/json\+oembed["\']'
			. '(?:[^>]+?href=[\'"](?<second>[^\'"]+?)[\'"])?#';

		if(preg_match_all($pcreOmbed, $body, $matches, PREG_SET_ORDER)) {
			$match = $matches[0];
			if(!empty($match['second'])) {
				return html_entity_decode($match['second']);
			}
			if(!empty($match['first'])) {
				return html_entity_decode($match['first']);
			}
		}
		return false;
	}

	/**
	 * Takes the human-readable URL of an embeddable resource and converts it into an
	 * Oembed_Result descriptor (which contains a full Oembed resource URL).
	 *
	 * @param $url Human-readable URL
	 * @param $type ?
	 * @param $options array Options to be used for constructing the resulting descriptor.
	 * @returns Oembed_Result/bool An Oembed descriptor, or false
	 */
	public static function get_oembed_from_url($url, $type = false, array $options = array()) {
		if(!self::is_enabled()) return false;

		// Find or build the Oembed URL.
		$endpoint = self::find_endpoint($url);
		$oembedUrl = false;
		if(!$endpoint) {
			if(self::get_autodiscover()) {
				$oembedUrl = self::autodiscover_from_url($url);
			}
		} elseif($endpoint === true) {
			$oembedUrl = self::autodiscover_from_url($url);
		} else {
			// Build the url manually - we gave all needed information.
			$oembedUrl = Controller::join_links($endpoint, '?format=json&url=' . rawurlencode($url));
		}

		// If autodescovery failed the resource might be a direct link to a file
		if(!$oembedUrl) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			if(File::get_app_category(File::get_file_extension($url)) == "image") {
				return new Oembed_Result($url, $url, $type, $options);
			}
		}

		if($oembedUrl) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			// Inject the options into the Oembed URL.
			if($options) {

				if(isset($options['width']) && !isset($options['maxwidth'])) {
					$options['maxwidth'] = $options['width'];
				}
				if(isset($options['height']) && !isset($options['maxheight'])) {
					$options['maxheight'] = $options['height'];
				}
				$oembedUrl = Controller::join_links($oembedUrl, '?' . http_build_query($options, '', '&'));
			}

			return new Oembed_Result($oembedUrl, $url, $type, $options);
		}

		// No matching Oembed resource found.
		return false;
	}

	public static function get_shortcodes() {
		return 'embed';
	}

	public static function handle_shortcode($arguments, $content, $parser, $shortcode, $extra = array()) {
		if(isset($arguments['type'])) {

			$type = $arguments['type'];
			unset($arguments['type']);
		} else {
			$type = false;
		}
		$oembed = self::get_oembed_from_url($content, $type, $arguments);
		if($oembed && $oembed->exists()) {
			return $oembed->forTemplate();
		} else {
			return '<a href="' . $content . '">' . $content . '</a>';
		}
	}
}

/**
 * @property string $Type Oembed type
 * @property string $Title Title
 * @property string $URL URL to asset
 * @property string $Provider_URL Url for provider
 * @property int $Width
 * @property int $Height
 * @property string $Info Descriptive text for this oembed
 *
 * @package framework
 * @subpackage oembed
 */
class Oembed_Result extends ViewableData {
	/**
	 * JSON data fetched from the Oembed URL.
	 * This data is accessed dynamically by getField and hasField.
	 */
	protected $data = false;

	/**
	 * Human readable URL
	 */
	protected $origin = false;

	/**
	 * ?
	 */
	protected $type = false;

	/**
	 * Oembed URL
	 */
	protected $url;

	/**
	 * Class to be injected into the resulting HTML element.
	 */
	protected $extraClass;

	private static $casting = array(

		'html' => 'HTMLText',
	);

	public function __construct($url, $origin = false, $type = false, array $options = array()) {
		$this->url = $url;
		$this->origin = $origin;
		$this->type = $type;

		if(isset($options['class'])) {
			$this->extraClass = $options['class'];
		}
		if($options) {

			if(isset($options['width'])) {
				$this->Width = $options['width'];
			}
			if(isset($options['height'])) {
				$this->Height = $options['height'];
			}
		}
		parent::__construct();
	}

	public function getOembedURL() {
		return $this->url;
	}

	/**
	 * Fetches the JSON data from the Oembed URL (cached).
	 * Only sets the internal variable.
	 */
	protected function loadData() {
		if($this->data !== false) {
			return;
		}
		$timeout   = 5;
		$sapphireInfo = new SapphireInfo();
		$useragent = 'SilverStripe/' . $sapphireInfo->Version();
		$curlRequest = curl_init();
		curl_setopt_array(
			$curlRequest,
			array(
				CURLOPT_URL            => $this->url,
				CURLOPT_RETURNTRANSFER => 1,
				CURLOPT_USERAGENT      => $useragent,
				CURLOPT_CONNECTTIMEOUT => $timeout,
				CURLOPT_FOLLOWLOCATION => 1,

			)
		);

		$response = curl_exec($curlRequest);
		$headers = curl_getinfo($curlRequest);
		if(!$response || $headers['http_code'] !== 200) {
			$this->data = array();

			return;
		}
		$body = $response;
		$data = json_decode($body, true);
		if(!$data) {
			// if the response is no valid JSON we might have received a binary stream to an image
			$data = array();
			if (!function_exists('imagecreatefromstring')) {
				throw new LogicException('imagecreatefromstring function does not exist - Please make sure GD is installed');
			}
			$image = imagecreatefromstring($body);
			if($image !== FALSE) {
				preg_match("/^(http:\/\/)?([^\/]+)/i", $this->url, $matches);
				$protocoll = $matches[1];
				$host = $matches[2];
				$data['type'] = "photo";
				$data['title'] = basename($this->url) . " ($host)";
				$data['url'] = $this->url;
				$data['provider_url'] = $protocoll.$host;
				$data['width'] = imagesx($image);
				$data['height'] = imagesy($image);
				$data['info'] = _t('UploadField.HOTLINKINFO',
					'Info: This image will be hotlinked. Please ensure you have permissions from the'
					. ' original site creator to do so.');
			}
		}

		// Convert all keys to lowercase
		$data = array_change_key_case($data, CASE_LOWER);

		// Check if we can guess thumbnail
		if(empty($data['thumbnail_url']) && $thumbnail = $this->findThumbnail($data)) {
			$data['thumbnail_url'] = $thumbnail;
		}

		// Purge everything if the type does not match.
		if($this->type && $this->type != $data['type']) {
			$data = array();
		}

		$this->data = $data;

	}

	/**
	 * Find thumbnail if omitted from data
	 *
	 * @param array $data
	 * @return string
	 */
	public function findThumbnail($data) {
		if(!empty($data['thumbnail_url'])) {
			return $data['thumbnail_url'];
		}

		// Hack in facebook graph thumbnail
		if(!empty($data['provider_name']) && $data['provider_name'] === 'Facebook') {
			$id = preg_replace("/.*\\/(\\d+?)\\/?($|\\?.*)/", "$1", $data["url"]);
			return "https://graph.facebook.com/{$id}/picture";
		}

		// no thumbnail found
		return null;
	}

	/**
	 * Wrap the check for looking into Oembed JSON within $this->data.
	 */
	public function hasField($field) {
		$this->loadData();
		return array_key_exists(strtolower($field), $this->data);
	}

	/**
	 * Wrap the field calls to fetch data from Oembed JSON (within $this->data)
	 */
	public function getField($field) {
		$field = strtolower($field);
		if($this->hasField($field)) {
			return $this->data[$field];
		}
	}

	public function forTemplate() {
		$this->loadData();
		switch($this->Type) {
		case 'video':
		case 'rich':
			if($this->extraClass) {
				return "<div class='media $this->extraClass'>$this->HTML</div>";
			} else {
				return "<div class='media'>$this->HTML</div>";
			}
			break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
		case 'link':
			return '<a class="' . $this->extraClass . '" href="' . $this->origin . '">' . $this->Title . '</a>';
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
		case 'photo':
			return "<img src='$this->URL' width='$this->Width' height='$this->Height' class='$this->extraClass' />";
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
		}
	}

	public function exists() {
		$this->loadData();
		return count($this->data) > 0;
	}
}



1		<?php
2		/**
3		* Format of the Oembed config. Autodiscover allows discovery of all URLs.
4		*
5		* Endpoint set to true means autodiscovery for this specific provider is
6		* allowed (even if autodiscovery in general has been disabled).
7		*
8		* <code>
9		*
10		* name: Oembed
11		* ---
12		* Oembed:
13		* providers:
14		* 'http://.youtube.com/watch':
15		* 'http://www.youtube.com/oembed/'
16		* autodiscover:
17		* true
18		* </code>
19		*
20		* @package framework
21		* @subpackage oembed
22		*/
23
24		class Oembed implements ShortcodeHandler {
25
26		public static function is_enabled() {
27		return Config::inst()->get('Oembed', 'enabled');
28		}
29
30		/**
31		* Gets the autodiscover setting from the config.
32		*/
33		public static function get_autodiscover() {
34		return Config::inst()->get('Oembed', 'autodiscover');
35		}
36
37		/**
38		* Gets providers from config.
39		*/
40		public static function get_providers() {
41		return Config::inst()->get('Oembed', 'providers');
42		}
43
44		/**
45		* Returns an endpoint (a base Oembed URL) from first matching provider.
46		*
47		* @param $url Human-readable URL.
48		* @returns string/bool URL of an endpoint, or false if no matching provider exists.
49		*/
50		protected static function find_endpoint($url) {
51		foreach(self::get_providers() as $scheme=>$endpoint) {
		0 ignored issues – show Bug introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report The expression `self::get_providers()` of type `array\|integer\|double\|string\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
52		if(self::matches_scheme($url, $scheme)) {
53		$protocol = Director::is_https() ? 'https' : 'http';
54
55		if (is_array($endpoint)) {
56		if (array_key_exists($protocol, $endpoint)) $endpoint = $endpoint[$protocol];
57		else $endpoint = reset($endpoint);
58		}
59
60		return $endpoint;
61		}
62		}
63		return false;
64		}
65
66		/**
67		* Checks the URL if it matches against the scheme (pattern).
68		*
69		* @param $url Human-readable URL to be checked.
70		* @param $scheme Pattern to be matched against.
71		* @returns bool Whether the pattern matches or not.
72		*/
73		protected static function matches_scheme($url, $scheme) {
74		$urlInfo = parse_url($url);
75		$schemeInfo = parse_url($scheme);
76
77		foreach($schemeInfo as $k=>$v) {
		0 ignored issues – show Bug introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report The expression `$schemeInfo` of type `array<string,string>\|false` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
78		if(!array_key_exists($k, $urlInfo)) {
79		return false;
80		}
81		if(strpos($v, '*') !== false) {
82		$v = preg_quote($v, '/');
83		$v = str_replace('\', '.', $v);
84		if($k == 'host') {
85		$v = str_replace('\.', '', $v);
86		}
87		if(!preg_match('/' . $v . '/', $urlInfo[$k])) {
88		return false;
89		}
90		} elseif(strcasecmp($urlInfo[$k], $v)) {
91		return false;
92		}
93		}
94		return true;
95		}
96
97		/**
98		* Performs a HTTP request to the URL and scans the response for resource links
99		* that mention oembed in their type.
100		*
101		* @param $url Human readable URL.
102		* @returns string/bool Oembed URL, or false.
103		*/
104		protected static function autodiscover_from_url($url)
105		{
106		$timeout = 5;
107		$sapphireInfo = new SapphireInfo();
108		$useragent = 'SilverStripe/' . $sapphireInfo->Version();
109		$curlRequest = curl_init();
110		curl_setopt_array(
111		$curlRequest,
112		array(
113		CURLOPT_URL => $url,
114		CURLOPT_RETURNTRANSFER => 1,
115		CURLOPT_USERAGENT => $useragent,
116		CURLOPT_CONNECTTIMEOUT => $timeout,
117		CURLOPT_FOLLOWLOCATION => 1,
118
119		)
120		);
121
122		$response = curl_exec($curlRequest);
123		$headers = curl_getinfo($curlRequest);
124		if(!$response \|\| $headers['http_code'] !== 200) {
125		return false;
126		}
127		$body = $response;
128		return static::autodiscover_from_body($body);
129		}
130
131		/**
132		* Given a response body, determine if there is an autodiscover url
133		*
134		* @param string $body
135		* @return bool\|string
136		*/
137		public static function autodiscover_from_body($body) {
138		// Look within the body for an oembed link.
139		$pcreOmbed = '#<link[^>]+?(?:href=[\'"](?<first>[^\'"]+?)[\'"][^>]+?)'
140		. '?type=["\']application/json\+oembed["\']'
141		. '(?:[^>]+?href=[\'"](?<second>[^\'"]+?)[\'"])?#';
142
143		if(preg_match_all($pcreOmbed, $body, $matches, PREG_SET_ORDER)) {
144		$match = $matches[0];
145		if(!empty($match['second'])) {
146		return html_entity_decode($match['second']);
147		}
148		if(!empty($match['first'])) {
149		return html_entity_decode($match['first']);
150		}
151		}
152		return false;
153		}
154
155		/**
156		* Takes the human-readable URL of an embeddable resource and converts it into an
157		* Oembed_Result descriptor (which contains a full Oembed resource URL).
158		*
159		* @param $url Human-readable URL
160		* @param $type ?
161		* @param $options array Options to be used for constructing the resulting descriptor.
162		* @returns Oembed_Result/bool An Oembed descriptor, or false
163		*/
164		public static function get_oembed_from_url($url, $type = false, array $options = array()) {
165		if(!self::is_enabled()) return false;
166
167		// Find or build the Oembed URL.
168		$endpoint = self::find_endpoint($url);
169		$oembedUrl = false;
170		if(!$endpoint) {
171		if(self::get_autodiscover()) {
172		$oembedUrl = self::autodiscover_from_url($url);
173		}
174		} elseif($endpoint === true) {
175		$oembedUrl = self::autodiscover_from_url($url);
176		} else {
177		// Build the url manually - we gave all needed information.
178		$oembedUrl = Controller::join_links($endpoint, '?format=json&url=' . rawurlencode($url));
179		}
180
181		// If autodescovery failed the resource might be a direct link to a file
182		if(!$oembedUrl) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report The expression `$oembedUrl` of type `false\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
183		if(File::get_app_category(File::get_file_extension($url)) == "image") {
184		return new Oembed_Result($url, $url, $type, $options);
185		}
186		}
187
188		if($oembedUrl) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report The expression `$oembedUrl` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
189		// Inject the options into the Oembed URL.
190		if($options) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-21 06:12 UTC by Report Bug Copy Issue Report The expression `$options` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
191		if(isset($options['width']) && !isset($options['maxwidth'])) {
192		$options['maxwidth'] = $options['width'];
193		}
194		if(isset($options['height']) && !isset($options['maxheight'])) {
195		$options['maxheight'] = $options['height'];
196		}
197		$oembedUrl = Controller::join_links($oembedUrl, '?' . http_build_query($options, '', '&'));
198		}
199
200		return new Oembed_Result($oembedUrl, $url, $type, $options);
201		}
202
203		// No matching Oembed resource found.
204		return false;
205		}
206
207		public static function get_shortcodes() {
208		return 'embed';
209		}
210
211		public static function handle_shortcode($arguments, $content, $parser, $shortcode, $extra = array()) {
212	View Code Duplication	if(isset($arguments['type'])) {
		0 ignored issues – show Duplication introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
213		$type = $arguments['type'];
214		unset($arguments['type']);
215		} else {
216		$type = false;
217		}
218		$oembed = self::get_oembed_from_url($content, $type, $arguments);
219		if($oembed && $oembed->exists()) {
220		return $oembed->forTemplate();
221		} else {
222		return '<a href="' . $content . '">' . $content . '</a>';
223		}
224		}
225		}
226
227		/**
228		* @property string $Type Oembed type
229		* @property string $Title Title
230		* @property string $URL URL to asset
231		* @property string $Provider_URL Url for provider
232		* @property int $Width
233		* @property int $Height
234		* @property string $Info Descriptive text for this oembed
235		*
236		* @package framework
237		* @subpackage oembed
238		*/
239		class Oembed_Result extends ViewableData {
240		/**
241		* JSON data fetched from the Oembed URL.
242		* This data is accessed dynamically by getField and hasField.
243		*/
244		protected $data = false;
245
246		/**
247		* Human readable URL
248		*/
249		protected $origin = false;
250
251		/**
252		* ?
253		*/
254		protected $type = false;
255
256		/**
257		* Oembed URL
258		*/
259		protected $url;
260
261		/**
262		* Class to be injected into the resulting HTML element.
263		*/
264		protected $extraClass;
265
266		private static $casting = array(
		0 ignored issues – show Comprehensibility introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
267		'html' => 'HTMLText',
268		);
269
270		public function __construct($url, $origin = false, $type = false, array $options = array()) {
271		$this->url = $url;
272		$this->origin = $origin;
273		$this->type = $type;
274
275		if(isset($options['class'])) {
276		$this->extraClass = $options['class'];
277		}
278		if($options) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-21 06:12 UTC by Report Bug Copy Issue Report The expression `$options` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
279		if(isset($options['width'])) {
280		$this->Width = $options['width'];
281		}
282		if(isset($options['height'])) {
283		$this->Height = $options['height'];
284		}
285		}
286		parent::__construct();
287		}
288
289		public function getOembedURL() {
290		return $this->url;
291		}
292
293		/**
294		* Fetches the JSON data from the Oembed URL (cached).
295		* Only sets the internal variable.
296		*/
297		protected function loadData() {
298		if($this->data !== false) {
299		return;
300		}
301		$timeout = 5;
302		$sapphireInfo = new SapphireInfo();
303		$useragent = 'SilverStripe/' . $sapphireInfo->Version();
304		$curlRequest = curl_init();
305		curl_setopt_array(
306		$curlRequest,
307		array(
308		CURLOPT_URL => $this->url,
309		CURLOPT_RETURNTRANSFER => 1,
310		CURLOPT_USERAGENT => $useragent,
311		CURLOPT_CONNECTTIMEOUT => $timeout,
312		CURLOPT_FOLLOWLOCATION => 1,
313
314		)
315		);
316
317		$response = curl_exec($curlRequest);
318		$headers = curl_getinfo($curlRequest);
319		if(!$response \|\| $headers['http_code'] !== 200) {
320		$this->data = array();
		0 ignored issues – show Documentation Bug introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `boolean` of property `$data`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
321		return;
322		}
323		$body = $response;
324		$data = json_decode($body, true);
325		if(!$data) {
326		// if the response is no valid JSON we might have received a binary stream to an image
327		$data = array();
328		if (!function_exists('imagecreatefromstring')) {
329		throw new LogicException('imagecreatefromstring function does not exist - Please make sure GD is installed');
330		}
331		$image = imagecreatefromstring($body);
332		if($image !== FALSE) {
333		preg_match("/^(http:\/\/)?([^\/]+)/i", $this->url, $matches);
334		$protocoll = $matches[1];
335		$host = $matches[2];
336		$data['type'] = "photo";
337		$data['title'] = basename($this->url) . " ($host)";
338		$data['url'] = $this->url;
339		$data['provider_url'] = $protocoll.$host;
340		$data['width'] = imagesx($image);
341		$data['height'] = imagesy($image);
342		$data['info'] = _t('UploadField.HOTLINKINFO',
343		'Info: This image will be hotlinked. Please ensure you have permissions from the'
344		. ' original site creator to do so.');
345		}
346		}
347
348		// Convert all keys to lowercase
349		$data = array_change_key_case($data, CASE_LOWER);
350
351		// Check if we can guess thumbnail
352		if(empty($data['thumbnail_url']) && $thumbnail = $this->findThumbnail($data)) {
353		$data['thumbnail_url'] = $thumbnail;
354		}
355
356		// Purge everything if the type does not match.
357		if($this->type && $this->type != $data['type']) {
358		$data = array();
359		}
360
361		$this->data = $data;
		0 ignored issues – show Documentation Bug introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report It seems like `$data` of type `array` is incompatible with the declared type `boolean` of property `$data`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
362		}
363
364		/**
365		* Find thumbnail if omitted from data
366		*
367		* @param array $data
368		* @return string
369		*/
370		public function findThumbnail($data) {
371		if(!empty($data['thumbnail_url'])) {
372		return $data['thumbnail_url'];
373		}
374
375		// Hack in facebook graph thumbnail
376		if(!empty($data['provider_name']) && $data['provider_name'] === 'Facebook') {
377		$id = preg_replace("/.\\/(\\d+?)\\/?($\|\\?.)/", "$1", $data["url"]);
378		return "https://graph.facebook.com/{$id}/picture";
379		}
380
381		// no thumbnail found
382		return null;
383		}
384
385		/**
386		* Wrap the check for looking into Oembed JSON within $this->data.
387		*/
388		public function hasField($field) {
389		$this->loadData();
390		return array_key_exists(strtolower($field), $this->data);
391		}
392
393		/**
394		* Wrap the field calls to fetch data from Oembed JSON (within $this->data)
395		*/
396		public function getField($field) {
397		$field = strtolower($field);
398		if($this->hasField($field)) {
399		return $this->data[$field];
400		}
401		}
402
403		public function forTemplate() {
404		$this->loadData();
405		switch($this->Type) {
406		case 'video':
407		case 'rich':
408		if($this->extraClass) {
409		return "<div class='media $this->extraClass'>$this->HTML</div>";
410		} else {
411		return "<div class='media'>$this->HTML</div>";
412		}
413		break;
		0 ignored issues – show Unused Code introduced 2015-12-18 04:35 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
414		case 'link':
415		return '<a class="' . $this->extraClass . '" href="' . $this->origin . '">' . $this->Title . '</a>';
416		break;
		0 ignored issues – show Unused Code introduced 2016-05-21 06:12 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
417		case 'photo':
418		return "<img src='$this->URL' width='$this->Width' height='$this->Height' class='$this->extraClass' />";
419		break;
		0 ignored issues – show Unused Code introduced 2016-05-21 06:12 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
420		}
421		}
422
423		public function exists() {
424		$this->loadData();
425		return count($this->data) > 0;
426		}
427		}
428
429

sminnee / silverstripe-framework